Skip to main content

Ruby SDK

The Fatture in Cloud Ruby SDK is a Ruby library that offers models and methods to interact with the Fatture in Cloud v2 REST API.

Do you need a generic intro?

If you want to know more generic information about our SDKs, please check the SDK Overview page.

☑️  Requirements and Dependencies​

This SDK supports Ruby 2.4 and later. It is mainly based on typhoeus.

⬇️  Download and Installation​

The SDK code and detailed documentation can be found in the GitHub repository.

Important!

Make sure you always import the newest version of our SDK, you can check which version is the latest on RubyGems

The SDK can be installed using RubyGems:

gem install fattureincloud_ruby_sdk

👷  SDK Structure​

Here you can find our RubyDoc documentation.

Our SDK is mainly split into two different folders:

  • api: Here you can find the classes that implement our API methods, you will need an instance of one of those classes to call our APIs.
  • model: This folder contains all the classes that represent our API requests and responses; when using one of the methods above, you'll have to manage some of those classes.

There are some special classes in the Model package:

  • The classes with a name ending for Request can be used as a request body for one of our methods.
  • The classes with a name ending for Response will be returned after the execution of one of the methods. Instances of all the other classes will be used to compose the requests or responses for our methods.

You can think about Request and Response classes as wrappers: each one of them is dedicated to a single method of the API, and they will most of the time contain a single attribute called data, that contains the real body of the request or the response represented through a composition of the other classes. Each method will accept at most one instance of the Request classes and will return at most one instance of the Response classes.

Let's take for example the Modify Supplier method.

It is included in the SuppliersApi class, it accepts one instance of the ModifySupplierRequest class and it returns an instance of the ModifySupplierResponse class. In both cases, the data parameter will contain an instance of the Supplier class, that represents the modifies to apply to the supplier (for the request) and the final status of the supplier (for the response).

In contrast, the List Suppliers method is still contained in the SuppliersApi class, but it doesn't need any request body and returns a single instance of the ListSuppliersResponse class, where the data parameter will contain an array of instances of the Supplier class.

📢  API calls​

The API methods can be categorized as follows:

Category (prefix)Request BodyResponse BodyNotes
List (list)❌✅🎩  + 🔃  + 📃 + 🏷
Create (create)✅✅
Get (get)❌✅🎩
Modify (modify)✅✅
Delete (delete)❌❌

In addition to the Request, every method could require some additional parameters like the IDs of the company and the resource.

Retrieve your Company ID!

In this example, we'll suppose you have to manage just one Company, so we simply inserted its ID directly in the code. If instead, you need to be able to manage multiple companies, you'll need to retrieve the ID of the current company in some way. Check the Company-scoped Methods page for more info. Additionally, the Ruby Quickstart contains an example of Company ID retrieval using the SDK.

🎩  Response customization​

The List and Post methods include some parameters dedicated to the response customization. These parameters are passed as method arguments.

🔃  Sorting​

The List methods are a particular case because they are related to a set of resources instead of a single one; this means that the API will need to assign an order to the resources that will be returned. If needed, you can explicitly define a sorting rule passing the scope parameter.

📃  Pagination​

Strictly related to the Sorting functionality is the Pagination. The List methods return a potentially huge set of resources, making it necessary to paginate the results to make the responses manageable; each method will then accept an additional set of pagination parameters, and the Response classes will contain some pagination details along with the data parameter.

🏷  Filtering​

By default, the List methods will return the whole set of available resources for a certain method. If you instead want to focus on a particular subset of resources, you can apply specific filters to reduce the size of the result and retrieve only what you need.

🔑  Authentication & Authorization​

This SDK allows you to retrieve and refresh the access token with the integrated OAuth Helper, you can find a complete guide about it here, in case you are using the manual auth you can always set the token manually.

🐤  Getting started​

After you followed the installation procedure and retrieved a valid Access Token (see above), you can start using our APIs.

First, you need to create a new instance of the Configuration class:

FattureInCloud_Ruby_Sdk.configure do |config|
  config.access_token = 'YOUR_ACCESS_TOKEN'
end

The configuration, along with the HTTP client instance, can be used to instantiate one or more of the Api classes, for example:

suppliers_api_instance = FattureInCloud_Ruby_Sdk::SuppliersApi.new

Once you obtained the needed Api instance, you can start using the methods it provides.

Select the correct APIs!

If you want to use a method declared in two different API classes, you'll not be able to use the same instance. Instead, you'll need two different instances, one for each of the needed APIs.

Let's implement the list_suppliers and modify_supplier methods explained above:

company_id = 12345 # Integer | The ID of the company.
opts = {
  fields: 'fields_example', # String | List of comma-separated fields.
  fieldset: 'basic', # String | Name of the fieldset.
  sort: 'sort_example', # String | List of comma-separated fields for result sorting (minus for desc sorting).
  page: 56, # Integer | The page to retrieve.
  per_page: 56 # Integer | The size of the page.
}

begin
  # List Suppliers
  result = suppliers_api_instance.list_suppliers(company_id, opts)
  p result
rescue FattureInCloud_Ruby_Sdk::ApiError => e
  puts "Error when calling SuppliersApi->list_suppliers: #{e}"
end


supplier_id = 56 # Integer | The ID of the supplier.
opts = {
  modify_supplier_request: {"data":{"id":56,"code":"AE86","name":"Mario Rossi S.R.L.","type":"company","first_name":"Mario","last_name":"Rossi","contact_person":"","vat_number":"111222333","tax_code":"111122233","address_street":"Corso Magellano, 46","address_postal_code":"20146","address_city":"Milano","address_province":"MI","address_extra":"","country":"Italia","email":"mario.rossi@example.com","certified_email":"mario.rossi@pec.example.com","phone":"1234567890","fax":"123456789","notes":""}}
}

begin
  # Modify Supplier
  result = api_instance.modify_supplier(company_id, supplier_id, opts)
  p result
rescue FattureInCloud_Ruby_Sdk::ApiError => e
  puts "Error when calling SuppliersApi->modify_supplier: #{e}"
end
We're done!

You can finally start interacting with the Fatture in Cloud API!

🗒  Retrieve the JSON request body​

If you are experiencing some kind of issue and you want to check the raw JSON sent as the body for your request (and maybe send it to our customer support) you can do it as follows:

puts opts.to_json

🥥  Use raw JSON as request body​

If you already have a complete json that you want to use to call our APIs with the SDK without having to build the request object you can do it as follows:

modifySupplierRequest = JSON.parse('{"data":{"name":"nuovo nome", "phone":"03561234312"}}')

❓  What now?​

If you need a more detailed example, you can check our Ruby SDK Quickstart.

Here you can find the full documentation of the available methods and models:

📚  Additional resources​