mundi_api 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff33465146e329219c49e3ee45859f02665eaf17
+  data.tar.gz: f83735a0a21d8381797b0a98b2e0ac6429722001
+SHA512:
+  metadata.gz: 30b2d00e330b8b52b8fa1458b20dcbf972c88fdefb49b929968c270dfd8f4d1564a483801d3827446c30595e855ec9f2768b693597011be307a789d3b5a8b7c8
+  data.tar.gz: 8e1c62d68134c7b10ae5e0763475b8e55290227ca9305225edee762235e6efd61929f342d75c0d7dfc7424db1b737698f3b9d643a873254b77d4be8e9306f68e

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2016 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,2186 @@
+# Getting started
+
+Mundipagg API
+
+## How to Build
+
+This client library is a Ruby gem which can be compiled and used in your Ruby and Ruby on Rails project. This library requires a few gems from the RubyGems repository.
+
+1. Open the command line interface or the terminal and navigate to the folder containing the source code.
+2. Run ``` gem build mundi_api.gemspec ``` to build the gem.
+3. Once built, the gem can be installed on the current work environment using ``` gem install mundi_api-0.9.0.gem ```
+
+![Building Gem](https://apidocs.io/illustration/ruby?step=buildSDK&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiAPI-Ruby&projectName=mundi_api&gemName=mundi_api&gemVer=0.9.0)
+
+## How to Use
+
+The following section explains how to use the MundiApi Ruby Gem in a new Rails project using RubyMine™. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.
+
+### 1. Starting a new project
+
+Close any existing projects in RubyMine™ by selecting ``` File -> Close Project ```. Next, click on ``` Create New Project ``` to create a new project from scratch.
+
+![Create a new project in RubyMine](https://apidocs.io/illustration/ruby?step=createNewProject0&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.9.0)
+
+Next, provide ``` TestApp ``` as the project name, choose ``` Rails Application ``` as the project type, and click ``` OK ```.
+
+![Create a new Rails Application in RubyMine - step 1](https://apidocs.io/illustration/ruby?step=createNewProject1&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.9.0)
+
+In the next dialog make sure that correct *Ruby SDK* is being used (minimum 2.0.0) and click ``` OK ```.
+
+![Create a new Rails Application in RubyMine - step 2](https://apidocs.io/illustration/ruby?step=createNewProject2&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.9.0)
+
+This will create a new Rails Application project with an existing set of files and folder.
+
+### 2. Add reference of the gem
+
+In order to use the MundiApi gem in the new project we must add a gem reference. Locate the ```Gemfile``` in the *Project Explorer* window under the ``` TestApp ``` project node. The file contains references to all gems being used in the project. Here, add the reference to the library gem by adding the following line: ``` gem 'mundi_api', '~> 0.9.0' ```
+
+![Add references of the Gemfile](https://apidocs.io/illustration/ruby?step=addReference&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.9.0)
+
+### 3. Adding a new Rails Controller
+
+Once the ``` TestApp ``` project is created, a folder named ``` controllers ``` will be visible in the *Project Explorer* under the following path: ``` TestApp > app > controllers ```. Right click on this folder and select ``` New -> Run Rails Generator... ```.
+
+![Run Rails Generator on Controllers Folder](https://apidocs.io/illustration/ruby?step=addCode0&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.9.0)
+
+Selecting the said option will popup a small window where the generator names are displayed. Here, select the ``` controller ``` template.
+
+![Create a new Controller](https://apidocs.io/illustration/ruby?step=addCode1&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.9.0)
+
+Next, a popup window will ask you for a Controller name and included Actions. For controller name provide ``` Hello ``` and include an action named ``` Index ``` and click ``` OK ```.
+
+![Add a new Controller](https://apidocs.io/illustration/ruby?step=addCode2&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.9.0)
+
+A new controller class anmed ``` HelloController ``` will be created in a file named ``` hello_controller.rb ``` containing a method named ``` Index ```. In this method, add code for initialization and a sample for its usage.
+
+![Initialize the library](https://apidocs.io/illustration/ruby?step=addCode3&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.9.0)
+
+## How to Test
+
+You can test the generated SDK and the server with automatically generated test
+cases as follows:
+
+  1. From terminal/cmd navigate to the root directory of the SDK.
+  2. Invoke: `bundle exec rake`
+
+## Initialization
+
+### Authentication
+In order to setup authentication and initialization of the API client, you need the following information.
+
+| Parameter | Description |
+|-----------|-------------|
+| basic_auth_user_name | The username to use with basic authentication |
+| basic_auth_password | The password to use with basic authentication |
+
+
+
+API client can be initialized as following.
+
+```ruby
+# Configuration parameters and credentials
+basic_auth_user_name = 'basic_auth_user_name' # The username to use with basic authentication
+basic_auth_password = 'basic_auth_password' # The password to use with basic authentication
+
+client = MundiApi::MundiApiClient.new(
+  basic_auth_user_name: basic_auth_user_name,
+  basic_auth_password: basic_auth_password
+)
+```
+
+The added initlization code can be debugged by putting a breakpoint in the ``` Index ``` method and running the project in debug mode by selecting ``` Run -> Debug 'Development: TestApp' ```.
+
+![Debug the TestApp](https://apidocs.io/illustration/ruby?step=addCode4&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.9.0&initLine=client%2520%253D%2520MundiApiClient.new%2528%2527basic_auth_user_name%2527%252C%2520%2527basic_auth_password%2527%2529)
+
+
+
+# Class Reference
+
+## <a name="list_of_controllers"></a>List of Controllers
+
+* [ChargesController](#charges_controller)
+* [CustomersController](#customers_controller)
+* [InvoicesController](#invoices_controller)
+* [PlansController](#plans_controller)
+* [SubscriptionsController](#subscriptions_controller)
+* [OrdersController](#orders_controller)
+* [TokensController](#tokens_controller)
+
+## <a name="charges_controller"></a>![Class: ](https://apidocs.io/img/class.png ".ChargesController") ChargesController
+
+### Get singleton instance
+
+The singleton instance of the ``` ChargesController ``` class can be accessed from the API Client.
+
+```ruby
+charges = client.charges
+```
+
+### <a name="get_charge"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.get_charge") get_charge
+
+> Get a charge from its id
+
+
+```ruby
+def get_charge(charge_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| charge_id |  ``` Required ```  | Charge id |
+
+
+#### Example Usage
+
+```ruby
+charge_id = 'charge_id'
+
+result = charges.get_charge(charge_id)
+
+```
+
+
+### <a name="retry_charge"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.retry_charge") retry_charge
+
+> Retries a charge
+
+
+```ruby
+def retry_charge(charge_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| charge_id |  ``` Required ```  | Charge id |
+
+
+#### Example Usage
+
+```ruby
+charge_id = 'charge_id'
+
+result = charges.retry_charge(charge_id)
+
+```
+
+
+### <a name="create_charge"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.create_charge") create_charge
+
+> Creates a new charge
+
+
+```ruby
+def create_charge(request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| request |  ``` Required ```  | Request for creating a charge |
+
+
+#### Example Usage
+
+```ruby
+request = CreateChargeRequest.new
+
+result = charges.create_charge(request)
+
+```
+
+
+### <a name="update_charge_card"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.update_charge_card") update_charge_card
+
+> Updates the card from a charge
+
+
+```ruby
+def update_charge_card(charge_id,
+                           request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| charge_id |  ``` Required ```  | Charge id |
+| request |  ``` Required ```  | Request for updating a charge's card |
+
+
+#### Example Usage
+
+```ruby
+charge_id = 'charge_id'
+request = UpdateChargeCardRequest.new
+
+result = charges.update_charge_card(charge_id, request)
+
+```
+
+
+### <a name="update_charge_payment_method"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.update_charge_payment_method") update_charge_payment_method
+
+> Updates a charge's payment method
+
+
+```ruby
+def update_charge_payment_method(charge_id,
+                                     request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| charge_id |  ``` Required ```  | Charge id |
+| request |  ``` Required ```  | Request for updating the payment method from a charge |
+
+
+#### Example Usage
+
+```ruby
+charge_id = 'charge_id'
+request = UpdateChargePaymentMethodRequest.new
+
+result = charges.update_charge_payment_method(charge_id, request)
+
+```
+
+
+### <a name="cancel_charge"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.cancel_charge") cancel_charge
+
+> Cancel a charge
+
+
+```ruby
+def cancel_charge(charge_id,
+                      request = nil); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| charge_id |  ``` Required ```  | Charge id |
+| request |  ``` Optional ```  | Request for cancelling a charge |
+
+
+#### Example Usage
+
+```ruby
+charge_id = 'charge_id'
+request = CreateCancelChargeRequest.new
+
+result = charges.cancel_charge(charge_id, request)
+
+```
+
+
+### <a name="capture_charge"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.capture_charge") capture_charge
+
+> Captures a charge
+
+
+```ruby
+def capture_charge(charge_id,
+                       request = nil); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| charge_id |  ``` Required ```  | Charge id |
+| request |  ``` Optional ```  | Request for capturing a charge |
+
+
+#### Example Usage
+
+```ruby
+charge_id = 'charge_id'
+request = CreateCaptureChargeRequest.new
+
+result = charges.capture_charge(charge_id, request)
+
+```
+
+
+### <a name="update_charge_metadata"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.update_charge_metadata") update_charge_metadata
+
+> Updates the metadata from a charge
+
+
+```ruby
+def update_charge_metadata(charge_id,
+                               request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| charge_id |  ``` Required ```  | The charge id |
+| request |  ``` Required ```  | Request for updating the charge metadata |
+
+
+#### Example Usage
+
+```ruby
+charge_id = 'charge_id'
+request = UpdateMetadataRequest.new
+
+result = charges.update_charge_metadata(charge_id, request)
+
+```
+
+
+### <a name="get_charges"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.get_charges") get_charges
+
+> Lists all charges
+
+
+```ruby
+def get_charges(page = nil,
+                    size = nil,
+                    code = nil,
+                    status = nil,
+                    payment_method = nil,
+                    customer_id = nil,
+                    order_id = nil,
+                    created_since = nil,
+                    created_until = nil); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| page |  ``` Optional ```  | Page number |
+| size |  ``` Optional ```  | Page size |
+| code |  ``` Optional ```  | Filter for charge's code |
+| status |  ``` Optional ```  | Filter for charge's status |
+| payment_method |  ``` Optional ```  | Filter for charge's payment method |
+| customer_id |  ``` Optional ```  | Filter for charge's customer id |
+| order_id |  ``` Optional ```  | Filter for charge's order id |
+| created_since |  ``` Optional ```  | Filter for the beginning of the range for charge's creation |
+| created_until |  ``` Optional ```  | Filter for the end of the range for charge's creation |
+
+
+#### Example Usage
+
+```ruby
+page = 224
+size = 224
+code = 'code'
+status = 'status'
+payment_method = 'payment_method'
+customer_id = 'customer_id'
+order_id = 'order_id'
+created_since = DateTime.now
+created_until = DateTime.now
+
+result = charges.get_charges(page, size, code, status, payment_method, customer_id, order_id, created_since, created_until)
+
+```
+
+
+[Back to List of Controllers](#list_of_controllers)
+
+## <a name="customers_controller"></a>![Class: ](https://apidocs.io/img/class.png ".CustomersController") CustomersController
+
+### Get singleton instance
+
+The singleton instance of the ``` CustomersController ``` class can be accessed from the API Client.
+
+```ruby
+customers = client.customers
+```
+
+### <a name="create_customer"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.create_customer") create_customer
+
+> Creates a new customer
+
+
+```ruby
+def create_customer(request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| request |  ``` Required ```  | Request for creating a customer |
+
+
+#### Example Usage
+
+```ruby
+request = CreateCustomerRequest.new
+
+result = customers.create_customer(request)
+
+```
+
+
+### <a name="get_customer"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_customer") get_customer
+
+> Get a customer
+
+
+```ruby
+def get_customer(customer_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| customer_id |  ``` Required ```  | Customer Id |
+
+
+#### Example Usage
+
+```ruby
+customer_id = 'customer_id'
+
+result = customers.get_customer(customer_id)
+
+```
+
+
+### <a name="update_card"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.update_card") update_card
+
+> Updates a card
+
+
+```ruby
+def update_card(customer_id,
+                    card_id,
+                    request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| customer_id |  ``` Required ```  | Customer Id |
+| card_id |  ``` Required ```  | Card id |
+| request |  ``` Required ```  | Request for updating a card |
+
+
+#### Example Usage
+
+```ruby
+customer_id = 'customer_id'
+card_id = 'card_id'
+request = UpdateCardRequest.new
+
+result = customers.update_card(customer_id, card_id, request)
+
+```
+
+
+### <a name="update_address"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.update_address") update_address
+
+> Updates an address
+
+
+```ruby
+def update_address(customer_id,
+                       address_id,
+                       request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| customer_id |  ``` Required ```  | Customer Id |
+| address_id |  ``` Required ```  | Address Id |
+| request |  ``` Required ```  | Request for updating an address |
+
+
+#### Example Usage
+
+```ruby
+customer_id = 'customer_id'
+address_id = 'address_id'
+request = UpdateAddressRequest.new
+
+result = customers.update_address(customer_id, address_id, request)
+
+```
+
+
+### <a name="get_address"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_address") get_address
+
+> Get a customer's address
+
+
+```ruby
+def get_address(customer_id,
+                    address_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| customer_id |  ``` Required ```  | Customer id |
+| address_id |  ``` Required ```  | Address Id |
+
+
+#### Example Usage
+
+```ruby
+customer_id = 'customer_id'
+address_id = 'address_id'
+
+result = customers.get_address(customer_id, address_id)
+
+```
+
+
+### <a name="delete_address"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.delete_address") delete_address
+
+> Delete a Customer's address
+
+
+```ruby
+def delete_address(customer_id,
+                       address_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| customer_id |  ``` Required ```  | Customer Id |
+| address_id |  ``` Required ```  | Address Id |
+
+
+#### Example Usage
+
+```ruby
+customer_id = 'customer_id'
+address_id = 'address_id'
+
+result = customers.delete_address(customer_id, address_id)
+
+```
+
+
+### <a name="delete_card"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.delete_card") delete_card
+
+> Delete a customer's card
+
+
+```ruby
+def delete_card(customer_id,
+                    card_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| customer_id |  ``` Required ```  | Customer Id |
+| card_id |  ``` Required ```  | Card Id |
+
+
+#### Example Usage
+
+```ruby
+customer_id = 'customer_id'
+card_id = 'card_id'
+
+result = customers.delete_card(customer_id, card_id)
+
+```
+
+
+### <a name="create_address"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.create_address") create_address
+
+> Creates a new address for a customer
+
+
+```ruby
+def create_address(customer_id,
+                       request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| customer_id |  ``` Required ```  | Customer Id |
+| request |  ``` Required ```  | Request for creating an address |
+
+
+#### Example Usage
+
+```ruby
+customer_id = 'customer_id'
+request = CreateAddressRequest.new
+
+result = customers.create_address(customer_id, request)
+
+```
+
+
+### <a name="get_card"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_card") get_card
+
+> Get a customer's card
+
+
+```ruby
+def get_card(customer_id,
+                 card_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| customer_id |  ``` Required ```  | Customer id |
+| card_id |  ``` Required ```  | Card id |
+
+
+#### Example Usage
+
+```ruby
+customer_id = 'customer_id'
+card_id = 'card_id'
+
+result = customers.get_card(customer_id, card_id)
+
+```
+
+
+### <a name="create_card"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.create_card") create_card
+
+> Creates a new card for a customer
+
+
+```ruby
+def create_card(customer_id,
+                    request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| customer_id |  ``` Required ```  | Customer id |
+| request |  ``` Required ```  | Request for creating a card |
+
+
+#### Example Usage
+
+```ruby
+customer_id = 'customer_id'
+request = CreateCardRequest.new
+
+result = customers.create_card(customer_id, request)
+
+```
+
+
+### <a name="update_customer"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.update_customer") update_customer
+
+> Updates a customer
+
+
+```ruby
+def update_customer(customer_id,
+                        request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| customer_id |  ``` Required ```  | Customer id |
+| request |  ``` Required ```  | Request for updating a customer |
+
+
+#### Example Usage
+
+```ruby
+customer_id = 'customer_id'
+request = UpdateCustomerRequest.new
+
+result = customers.update_customer(customer_id, request)
+
+```
+
+
+### <a name="delete_access_tokens"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.delete_access_tokens") delete_access_tokens
+
+> Delete a Customer's access tokens
+
+
+```ruby
+def delete_access_tokens(customer_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| customer_id |  ``` Required ```  | Customer Id |
+
+
+#### Example Usage
+
+```ruby
+customer_id = 'customer_id'
+
+result = customers.delete_access_tokens(customer_id)
+
+```
+
+
+### <a name="get_customers"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_customers") get_customers
+
+> Get all Customers
+
+
+```ruby
+def get_customers(name = nil,
+                      document = nil,
+                      page = 1,
+                      size = 10,
+                      email = nil); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| name |  ``` Optional ```  | Name of the Customer |
+| document |  ``` Optional ```  | Document of the Customer |
+| page |  ``` Optional ```  ``` DefaultValue ```  | Current page the the search |
+| size |  ``` Optional ```  ``` DefaultValue ```  | Quantity pages of the search |
+| email |  ``` Optional ```  | Customer's email |
+
+
+#### Example Usage
+
+```ruby
+name = 'name'
+document = 'document'
+page = 1
+size = 10
+email = 'email'
+
+result = customers.get_customers(name, document, page, size, email)
+
+```
+
+
+### <a name="get_access_token"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_access_token") get_access_token
+
+> Get a Customer's access token
+
+
+```ruby
+def get_access_token(customer_id,
+                         token_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| customer_id |  ``` Required ```  | Customer Id |
+| token_id |  ``` Required ```  | Token Id |
+
+
+#### Example Usage
+
+```ruby
+customer_id = 'customer_id'
+token_id = 'token_id'
+
+result = customers.get_access_token(customer_id, token_id)
+
+```
+
+
+### <a name="create_access_token"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.create_access_token") create_access_token
+
+> Creates a access token for a customer
+
+
+```ruby
+def create_access_token(customer_id,
+                            request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| customer_id |  ``` Required ```  | Customer Id |
+| request |  ``` Required ```  | Request for creating a access token |
+
+
+#### Example Usage
+
+```ruby
+customer_id = 'customer_id'
+request = CreateAccessTokenRequest.new
+
+result = customers.create_access_token(customer_id, request)
+
+```
+
+
+### <a name="delete_access_token"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.delete_access_token") delete_access_token
+
+> Delete a customer's access token
+
+
+```ruby
+def delete_access_token(customer_id,
+                            token_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| customer_id |  ``` Required ```  | Customer Id |
+| token_id |  ``` Required ```  | Token Id |
+
+
+#### Example Usage
+
+```ruby
+customer_id = 'customer_id'
+token_id = 'token_id'
+
+result = customers.delete_access_token(customer_id, token_id)
+
+```
+
+
+### <a name="update_customer_metadata"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.update_customer_metadata") update_customer_metadata
+
+> Updates the metadata a customer
+
+
+```ruby
+def update_customer_metadata(customer_id,
+                                 request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| customer_id |  ``` Required ```  | The customer id |
+| request |  ``` Required ```  | Request for updating the customer metadata |
+
+
+#### Example Usage
+
+```ruby
+customer_id = 'customer_id'
+request = UpdateMetadataRequest.new
+
+result = customers.update_customer_metadata(customer_id, request)
+
+```
+
+
+### <a name="get_access_tokens"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_access_tokens") get_access_tokens
+
+> Get all access tokens from a customer
+
+
+```ruby
+def get_access_tokens(customer_id,
+                          page = nil,
+                          size = nil); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| customer_id |  ``` Required ```  | Customer Id |
+| page |  ``` Optional ```  | Page number |
+| size |  ``` Optional ```  | Page size |
+
+
+#### Example Usage
+
+```ruby
+customer_id = 'customer_id'
+page = 60
+size = 60
+
+result = customers.get_access_tokens(customer_id, page, size)
+
+```
+
+
+### <a name="get_addresses"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_addresses") get_addresses
+
+> Gets all adressess from a customer
+
+
+```ruby
+def get_addresses(customer_id,
+                      page = nil,
+                      size = nil); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| customer_id |  ``` Required ```  | Customer id |
+| page |  ``` Optional ```  | Page number |
+| size |  ``` Optional ```  | Page size |
+
+
+#### Example Usage
+
+```ruby
+customer_id = 'customer_id'
+page = 60
+size = 60
+
+result = customers.get_addresses(customer_id, page, size)
+
+```
+
+
+### <a name="get_cards"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_cards") get_cards
+
+> Get all cards from a customer
+
+
+```ruby
+def get_cards(customer_id,
+                  page = nil,
+                  size = nil); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| customer_id |  ``` Required ```  | Customer Id |
+| page |  ``` Optional ```  | Page number |
+| size |  ``` Optional ```  | Page size |
+
+
+#### Example Usage
+
+```ruby
+customer_id = 'customer_id'
+page = 19
+size = 19
+
+result = customers.get_cards(customer_id, page, size)
+
+```
+
+
+[Back to List of Controllers](#list_of_controllers)
+
+## <a name="invoices_controller"></a>![Class: ](https://apidocs.io/img/class.png ".InvoicesController") InvoicesController
+
+### Get singleton instance
+
+The singleton instance of the ``` InvoicesController ``` class can be accessed from the API Client.
+
+```ruby
+invoices = client.invoices
+```
+
+### <a name="get_invoice"></a>![Method: ](https://apidocs.io/img/method.png ".InvoicesController.get_invoice") get_invoice
+
+> Gets an invoice
+
+
+```ruby
+def get_invoice(invoice_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| invoice_id |  ``` Required ```  | Invoice Id |
+
+
+#### Example Usage
+
+```ruby
+invoice_id = 'invoice_id'
+
+result = invoices.get_invoice(invoice_id)
+
+```
+
+
+### <a name="cancel_invoice"></a>![Method: ](https://apidocs.io/img/method.png ".InvoicesController.cancel_invoice") cancel_invoice
+
+> Cancels an invoice
+
+
+```ruby
+def cancel_invoice(invoice_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| invoice_id |  ``` Required ```  | Invoice id |
+
+
+#### Example Usage
+
+```ruby
+invoice_id = 'invoice_id'
+
+result = invoices.cancel_invoice(invoice_id)
+
+```
+
+
+### <a name="update_invoice_metadata"></a>![Method: ](https://apidocs.io/img/method.png ".InvoicesController.update_invoice_metadata") update_invoice_metadata
+
+> Updates the metadata from an invoice
+
+
+```ruby
+def update_invoice_metadata(invoice_id,
+                                request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| invoice_id |  ``` Required ```  | The invoice id |
+| request |  ``` Required ```  | Request for updating the invoice metadata |
+
+
+#### Example Usage
+
+```ruby
+invoice_id = 'invoice_id'
+request = UpdateMetadataRequest.new
+
+result = invoices.update_invoice_metadata(invoice_id, request)
+
+```
+
+
+### <a name="get_invoices"></a>![Method: ](https://apidocs.io/img/method.png ".InvoicesController.get_invoices") get_invoices
+
+> Gets all invoices
+
+
+```ruby
+def get_invoices(page = nil,
+                     size = nil,
+                     code = nil,
+                     customer_id = nil,
+                     subscription_id = nil,
+                     created_since = nil,
+                     created_until = nil,
+                     status = nil,
+                     due_since = nil,
+                     due_until = nil); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| page |  ``` Optional ```  | Page number |
+| size |  ``` Optional ```  | Page size |
+| code |  ``` Optional ```  | Filter for Invoice's code |
+| customer_id |  ``` Optional ```  | Filter for Invoice's customer id |
+| subscription_id |  ``` Optional ```  | Filter for Invoice's subscription id |
+| created_since |  ``` Optional ```  | Filter for Invoice's creation date start range |
+| created_until |  ``` Optional ```  | Filter for Invoices creation date end range |
+| status |  ``` Optional ```  | Filter for Invoice's status |
+| due_since |  ``` Optional ```  | Filter for Invoice's due date start range |
+| due_until |  ``` Optional ```  | Filter for Invoice's due date end range |
+
+
+#### Example Usage
+
+```ruby
+page = 19
+size = 19
+code = 'code'
+customer_id = 'customer_id'
+subscription_id = 'subscription_id'
+created_since = DateTime.now
+created_until = DateTime.now
+status = 'status'
+due_since = DateTime.now
+due_until = DateTime.now
+
+result = invoices.get_invoices(page, size, code, customer_id, subscription_id, created_since, created_until, status, due_since, due_until)
+
+```
+
+
+[Back to List of Controllers](#list_of_controllers)
+
+## <a name="plans_controller"></a>![Class: ](https://apidocs.io/img/class.png ".PlansController") PlansController
+
+### Get singleton instance
+
+The singleton instance of the ``` PlansController ``` class can be accessed from the API Client.
+
+```ruby
+plans = client.plans
+```
+
+### <a name="update_plan_item"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.update_plan_item") update_plan_item
+
+> Updates a plan item
+
+
+```ruby
+def update_plan_item(plan_id,
+                         plan_item_id,
+                         body); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| plan_id |  ``` Required ```  | Plan id |
+| plan_item_id |  ``` Required ```  | Plan item id |
+| body |  ``` Required ```  | Request for updating the plan item |
+
+
+#### Example Usage
+
+```ruby
+plan_id = 'plan_id'
+plan_item_id = 'plan_item_id'
+body = UpdatePlanItemRequest.new
+
+result = plans.update_plan_item(plan_id, plan_item_id, body)
+
+```
+
+
+### <a name="get_plan"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.get_plan") get_plan
+
+> Gets a plan
+
+
+```ruby
+def get_plan(plan_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| plan_id |  ``` Required ```  | Plan id |
+
+
+#### Example Usage
+
+```ruby
+plan_id = 'plan_id'
+
+result = plans.get_plan(plan_id)
+
+```
+
+
+### <a name="create_plan_item"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.create_plan_item") create_plan_item
+
+> Adds a new item to a plan
+
+
+```ruby
+def create_plan_item(plan_id,
+                         request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| plan_id |  ``` Required ```  | Plan id |
+| request |  ``` Required ```  | Request for creating a plan item |
+
+
+#### Example Usage
+
+```ruby
+plan_id = 'plan_id'
+request = CreatePlanItemRequest.new
+
+result = plans.create_plan_item(plan_id, request)
+
+```
+
+
+### <a name="update_plan"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.update_plan") update_plan
+
+> Updates a plan
+
+
+```ruby
+def update_plan(plan_id,
+                    request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| plan_id |  ``` Required ```  | Plan id |
+| request |  ``` Required ```  | Request for updating a plan |
+
+
+#### Example Usage
+
+```ruby
+plan_id = 'plan_id'
+request = UpdatePlanRequest.new
+
+result = plans.update_plan(plan_id, request)
+
+```
+
+
+### <a name="create_plan"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.create_plan") create_plan
+
+> Creates a new plan
+
+
+```ruby
+def create_plan(body); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| body |  ``` Required ```  | Request for creating a plan |
+
+
+#### Example Usage
+
+```ruby
+body = CreatePlanRequest.new
+
+result = plans.create_plan(body)
+
+```
+
+
+### <a name="delete_plan"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.delete_plan") delete_plan
+
+> Deletes a plan
+
+
+```ruby
+def delete_plan(plan_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| plan_id |  ``` Required ```  | Plan id |
+
+
+#### Example Usage
+
+```ruby
+plan_id = 'plan_id'
+
+result = plans.delete_plan(plan_id)
+
+```
+
+
+### <a name="get_plan_item"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.get_plan_item") get_plan_item
+
+> Gets a plan item
+
+
+```ruby
+def get_plan_item(plan_id,
+                      plan_item_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| plan_id |  ``` Required ```  | Plan id |
+| plan_item_id |  ``` Required ```  | Plan item id |
+
+
+#### Example Usage
+
+```ruby
+plan_id = 'plan_id'
+plan_item_id = 'plan_item_id'
+
+result = plans.get_plan_item(plan_id, plan_item_id)
+
+```
+
+
+### <a name="delete_plan_item"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.delete_plan_item") delete_plan_item
+
+> Removes an item from a plan
+
+
+```ruby
+def delete_plan_item(plan_id,
+                         plan_item_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| plan_id |  ``` Required ```  | Plan id |
+| plan_item_id |  ``` Required ```  | Plan item id |
+
+
+#### Example Usage
+
+```ruby
+plan_id = 'plan_id'
+plan_item_id = 'plan_item_id'
+
+result = plans.delete_plan_item(plan_id, plan_item_id)
+
+```
+
+
+### <a name="update_plan_metadata"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.update_plan_metadata") update_plan_metadata
+
+> Updates the metadata from a plan
+
+
+```ruby
+def update_plan_metadata(plan_id,
+                             request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| plan_id |  ``` Required ```  | The plan id |
+| request |  ``` Required ```  | Request for updating the plan metadata |
+
+
+#### Example Usage
+
+```ruby
+plan_id = 'plan_id'
+request = UpdateMetadataRequest.new
+
+result = plans.update_plan_metadata(plan_id, request)
+
+```
+
+
+### <a name="get_plans"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.get_plans") get_plans
+
+> Gets all plans
+
+
+```ruby
+def get_plans(page = nil,
+                  size = nil,
+                  name = nil,
+                  status = nil,
+                  billing_type = nil,
+                  created_since = nil,
+                  created_until = nil); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| page |  ``` Optional ```  | Page number |
+| size |  ``` Optional ```  | Page size |
+| name |  ``` Optional ```  | Filter for Plan's name |
+| status |  ``` Optional ```  | Filter for Plan's status |
+| billing_type |  ``` Optional ```  | Filter for plan's billing type |
+| created_since |  ``` Optional ```  | Filter for plan's creation date start range |
+| created_until |  ``` Optional ```  | Filter for plan's creation date end range |
+
+
+#### Example Usage
+
+```ruby
+page = 19
+size = 19
+name = 'name'
+status = 'status'
+billing_type = 'billing_type'
+created_since = DateTime.now
+created_until = DateTime.now
+
+result = plans.get_plans(page, size, name, status, billing_type, created_since, created_until)
+
+```
+
+
+[Back to List of Controllers](#list_of_controllers)
+
+## <a name="subscriptions_controller"></a>![Class: ](https://apidocs.io/img/class.png ".SubscriptionsController") SubscriptionsController
+
+### Get singleton instance
+
+The singleton instance of the ``` SubscriptionsController ``` class can be accessed from the API Client.
+
+```ruby
+subscriptions = client.subscriptions
+```
+
+### <a name="update_subscription_item"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.update_subscription_item") update_subscription_item
+
+> Updates a subscription item
+
+
+```ruby
+def update_subscription_item(subscription_id,
+                                 item_id,
+                                 body); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| subscription_id |  ``` Required ```  | Subscription Id |
+| item_id |  ``` Required ```  | Item id |
+| body |  ``` Required ```  | Request for updating a subscription item |
+
+
+#### Example Usage
+
+```ruby
+subscription_id = 'subscription_id'
+item_id = 'item_id'
+body = UpdateSubscriptionItemRequest.new
+
+result = subscriptions.update_subscription_item(subscription_id, item_id, body)
+
+```
+
+
+### <a name="create_usage"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.create_usage") create_usage
+
+> Creates a usage
+
+
+```ruby
+def create_usage(subscription_id,
+                     item_id,
+                     body); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| subscription_id |  ``` Required ```  | Subscription Id |
+| item_id |  ``` Required ```  | Item id |
+| body |  ``` Required ```  | Request for creating a usage |
+
+
+#### Example Usage
+
+```ruby
+subscription_id = 'subscription_id'
+item_id = 'item_id'
+body = CreateUsageRequest.new
+
+result = subscriptions.create_usage(subscription_id, item_id, body)
+
+```
+
+
+### <a name="update_subscription_billing_date"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.update_subscription_billing_date") update_subscription_billing_date
+
+> Updates the billing date from a subscription
+
+
+```ruby
+def update_subscription_billing_date(subscription_id,
+                                         request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| subscription_id |  ``` Required ```  | The subscription id |
+| request |  ``` Required ```  | Request for updating the subscription billing date |
+
+
+#### Example Usage
+
+```ruby
+subscription_id = 'subscription_id'
+request = UpdateSubscriptionBillingDateRequest.new
+
+result = subscriptions.update_subscription_billing_date(subscription_id, request)
+
+```
+
+
+### <a name="update_subscription_card"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.update_subscription_card") update_subscription_card
+
+> Updates the credit card from a subscription
+
+
+```ruby
+def update_subscription_card(subscription_id,
+                                 request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| subscription_id |  ``` Required ```  | Subscription id |
+| request |  ``` Required ```  | Request for updating a card |
+
+
+#### Example Usage
+
+```ruby
+subscription_id = 'subscription_id'
+request = UpdateSubscriptionCardRequest.new
+
+result = subscriptions.update_subscription_card(subscription_id, request)
+
+```
+
+
+### <a name="create_subscription"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.create_subscription") create_subscription
+
+> Creates a new subscription
+
+
+```ruby
+def create_subscription(body); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| body |  ``` Required ```  | Request for creating a subscription |
+
+
+#### Example Usage
+
+```ruby
+body = CreateSubscriptionRequest.new
+
+result = subscriptions.create_subscription(body)
+
+```
+
+
+### <a name="create_subscription_item"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.create_subscription_item") create_subscription_item
+
+> Creates a new Subscription item
+
+
+```ruby
+def create_subscription_item(subscription_id,
+                                 request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| subscription_id |  ``` Required ```  | Subscription id |
+| request |  ``` Required ```  | Request for creating a subscription item |
+
+
+#### Example Usage
+
+```ruby
+subscription_id = 'subscription_id'
+request = CreateSubscriptionItemRequest.new
+
+result = subscriptions.create_subscription_item(subscription_id, request)
+
+```
+
+
+### <a name="create_discount"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.create_discount") create_discount
+
+> Creates a discount
+
+
+```ruby
+def create_discount(subscription_id,
+                        request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| subscription_id |  ``` Required ```  | Subscription id |
+| request |  ``` Required ```  | Request for creating a discount |
+
+
+#### Example Usage
+
+```ruby
+subscription_id = 'subscription_id'
+request = CreateDiscountRequest.new
+
+result = subscriptions.create_discount(subscription_id, request)
+
+```
+
+
+### <a name="get_subscription"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.get_subscription") get_subscription
+
+> Gets a subscription
+
+
+```ruby
+def get_subscription(subscription_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| subscription_id |  ``` Required ```  | Subscription id |
+
+
+#### Example Usage
+
+```ruby
+subscription_id = 'subscription_id'
+
+result = subscriptions.get_subscription(subscription_id)
+
+```
+
+
+### <a name="update_subscription_payment_method"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.update_subscription_payment_method") update_subscription_payment_method
+
+> Updates the payment method from a subscription
+
+
+```ruby
+def update_subscription_payment_method(subscription_id,
+                                           request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| subscription_id |  ``` Required ```  | Subscription id |
+| request |  ``` Required ```  | Request for updating the paymentmethod from a subscription |
+
+
+#### Example Usage
+
+```ruby
+subscription_id = 'subscription_id'
+request = UpdateSubscriptionPaymentMethodRequest.new
+
+result = subscriptions.update_subscription_payment_method(subscription_id, request)
+
+```
+
+
+### <a name="delete_discount"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.delete_discount") delete_discount
+
+> Deletes a discount
+
+
+```ruby
+def delete_discount(subscription_id,
+                        discount_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| subscription_id |  ``` Required ```  | Subscription id |
+| discount_id |  ``` Required ```  | Discount Id |
+
+
+#### Example Usage
+
+```ruby
+subscription_id = 'subscription_id'
+discount_id = 'discount_id'
+
+result = subscriptions.delete_discount(subscription_id, discount_id)
+
+```
+
+
+### <a name="cancel_subscription"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.cancel_subscription") cancel_subscription
+
+> Cancels a subscription
+
+
+```ruby
+def cancel_subscription(subscription_id,
+                            request = nil); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| subscription_id |  ``` Required ```  | Subscription id |
+| request |  ``` Optional ```  | Request for cancelling a subscription |
+
+
+#### Example Usage
+
+```ruby
+subscription_id = 'subscription_id'
+request = CreateCancelSubscriptionRequest.new
+
+result = subscriptions.cancel_subscription(subscription_id, request)
+
+```
+
+
+### <a name="delete_subscription_item"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.delete_subscription_item") delete_subscription_item
+
+> Deletes a subscription item
+
+
+```ruby
+def delete_subscription_item(subscription_id,
+                                 subscription_item_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| subscription_id |  ``` Required ```  | Subscription id |
+| subscription_item_id |  ``` Required ```  | Subscription item id |
+
+
+#### Example Usage
+
+```ruby
+subscription_id = 'subscription_id'
+subscription_item_id = 'subscription_item_id'
+
+result = subscriptions.delete_subscription_item(subscription_id, subscription_item_id)
+
+```
+
+
+### <a name="delete_usage"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.delete_usage") delete_usage
+
+> Deletes a usage
+
+
+```ruby
+def delete_usage(subscription_id,
+                     item_id,
+                     usage_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| subscription_id |  ``` Required ```  | The subscription id |
+| item_id |  ``` Required ```  | The subscription item id |
+| usage_id |  ``` Required ```  | The usage id |
+
+
+#### Example Usage
+
+```ruby
+subscription_id = 'subscription_id'
+item_id = 'item_id'
+usage_id = 'usage_id'
+
+result = subscriptions.delete_usage(subscription_id, item_id, usage_id)
+
+```
+
+
+### <a name="get_usages"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.get_usages") get_usages
+
+> Lists all usages from a subscription item
+
+
+```ruby
+def get_usages(subscription_id,
+                   item_id,
+                   page = nil,
+                   size = nil); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| subscription_id |  ``` Required ```  | The subscription id |
+| item_id |  ``` Required ```  | The subscription item id |
+| page |  ``` Optional ```  | Page number |
+| size |  ``` Optional ```  | Page size |
+
+
+#### Example Usage
+
+```ruby
+subscription_id = 'subscription_id'
+item_id = 'item_id'
+page = 110
+size = 110
+
+result = subscriptions.get_usages(subscription_id, item_id, page, size)
+
+```
+
+
+### <a name="update_subscription_metadata"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.update_subscription_metadata") update_subscription_metadata
+
+> Updates the metadata from a subscription
+
+
+```ruby
+def update_subscription_metadata(subscription_id,
+                                     request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| subscription_id |  ``` Required ```  | The subscription id |
+| request |  ``` Required ```  | Request for updating the subscrption metadata |
+
+
+#### Example Usage
+
+```ruby
+subscription_id = 'subscription_id'
+request = UpdateMetadataRequest.new
+
+result = subscriptions.update_subscription_metadata(subscription_id, request)
+
+```
+
+
+### <a name="get_subscriptions"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.get_subscriptions") get_subscriptions
+
+> Gets all subscriptions
+
+
+```ruby
+def get_subscriptions(page = nil,
+                          size = nil,
+                          code = nil,
+                          billing_type = nil,
+                          customer_id = nil,
+                          plan_id = nil,
+                          card_id = nil,
+                          status = nil,
+                          next_billing_since = nil,
+                          next_billing_until = nil,
+                          created_since = nil,
+                          created_until = nil); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| page |  ``` Optional ```  | Page number |
+| size |  ``` Optional ```  | Page size |
+| code |  ``` Optional ```  | Filter for subscription's code |
+| billing_type |  ``` Optional ```  | Filter for subscription's billing type |
+| customer_id |  ``` Optional ```  | Filter for subscription's customer id |
+| plan_id |  ``` Optional ```  | Filter for subscription's plan id |
+| card_id |  ``` Optional ```  | Filter for subscription's card id |
+| status |  ``` Optional ```  | Filter for subscription's status |
+| next_billing_since |  ``` Optional ```  | Filter for subscription's next billing date start range |
+| next_billing_until |  ``` Optional ```  | Filter for subscription's next billing date end range |
+| created_since |  ``` Optional ```  | Filter for subscription's creation date start range |
+| created_until |  ``` Optional ```  | Filter for subscriptions creation date end range |
+
+
+#### Example Usage
+
+```ruby
+page = 110
+size = 110
+code = 'code'
+billing_type = 'billing_type'
+customer_id = 'customer_id'
+plan_id = 'plan_id'
+card_id = 'card_id'
+status = 'status'
+next_billing_since = DateTime.now
+next_billing_until = DateTime.now
+created_since = DateTime.now
+created_until = DateTime.now
+
+result = subscriptions.get_subscriptions(page, size, code, billing_type, customer_id, plan_id, card_id, status, next_billing_since, next_billing_until, created_since, created_until)
+
+```
+
+
+[Back to List of Controllers](#list_of_controllers)
+
+## <a name="orders_controller"></a>![Class: ](https://apidocs.io/img/class.png ".OrdersController") OrdersController
+
+### Get singleton instance
+
+The singleton instance of the ``` OrdersController ``` class can be accessed from the API Client.
+
+```ruby
+orders = client.orders
+```
+
+### <a name="get_order"></a>![Method: ](https://apidocs.io/img/method.png ".OrdersController.get_order") get_order
+
+> Gets an order
+
+
+```ruby
+def get_order(order_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| order_id |  ``` Required ```  | Order id |
+
+
+#### Example Usage
+
+```ruby
+order_id = 'order_id'
+
+result = orders.get_order(order_id)
+
+```
+
+
+### <a name="create_order"></a>![Method: ](https://apidocs.io/img/method.png ".OrdersController.create_order") create_order
+
+> Creates a new Order
+
+
+```ruby
+def create_order(body); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| body |  ``` Required ```  | Request for creating an order |
+
+
+#### Example Usage
+
+```ruby
+body = CreateOrderRequest.new
+
+result = orders.create_order(body)
+
+```
+
+
+### <a name="update_order_metadata"></a>![Method: ](https://apidocs.io/img/method.png ".OrdersController.update_order_metadata") update_order_metadata
+
+> Updates the metadata from an order
+
+
+```ruby
+def update_order_metadata(order_id,
+                              request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| order_id |  ``` Required ```  | The order id |
+| request |  ``` Required ```  | Request for updating the order metadata |
+
+
+#### Example Usage
+
+```ruby
+order_id = 'order_id'
+request = UpdateMetadataRequest.new
+
+result = orders.update_order_metadata(order_id, request)
+
+```
+
+
+### <a name="get_orders"></a>![Method: ](https://apidocs.io/img/method.png ".OrdersController.get_orders") get_orders
+
+> Gets all orders
+
+
+```ruby
+def get_orders(page = nil,
+                   size = nil,
+                   code = nil,
+                   status = nil,
+                   created_since = nil,
+                   created_until = nil,
+                   customer_id = nil); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| page |  ``` Optional ```  | Page number |
+| size |  ``` Optional ```  | Page size |
+| code |  ``` Optional ```  | Filter for order's code |
+| status |  ``` Optional ```  | Filter for order's status |
+| created_since |  ``` Optional ```  | Filter for order's creation date start range |
+| created_until |  ``` Optional ```  | Filter for order's creation date end range |
+| customer_id |  ``` Optional ```  | Filter for order's customer id |
+
+
+#### Example Usage
+
+```ruby
+page = 110
+size = 110
+code = 'code'
+status = 'status'
+created_since = DateTime.now
+created_until = DateTime.now
+customer_id = 'customer_id'
+
+result = orders.get_orders(page, size, code, status, created_since, created_until, customer_id)
+
+```
+
+
+[Back to List of Controllers](#list_of_controllers)
+
+## <a name="tokens_controller"></a>![Class: ](https://apidocs.io/img/class.png ".TokensController") TokensController
+
+### Get singleton instance
+
+The singleton instance of the ``` TokensController ``` class can be accessed from the API Client.
+
+```ruby
+tokens = client.tokens
+```
+
+### <a name="get_token"></a>![Method: ](https://apidocs.io/img/method.png ".TokensController.get_token") get_token
+
+> *Tags:*  ``` Skips Authentication ``` 
+
+> Gets a token from its id
+
+
+```ruby
+def get_token(id,
+                  public_key); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| id |  ``` Required ```  | Token id |
+| public_key |  ``` Required ```  | Public key |
+
+
+#### Example Usage
+
+```ruby
+id = 'id'
+public_key = 'public_key'
+
+result = tokens.get_token(id, public_key)
+
+```
+
+
+### <a name="create_token"></a>![Method: ](https://apidocs.io/img/method.png ".TokensController.create_token") create_token
+
+> *Tags:*  ``` Skips Authentication ``` 
+
+> TODO: Add a method description
+
+
+```ruby
+def create_token(public_key,
+                     request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| public_key |  ``` Required ```  | Public key |
+| request |  ``` Required ```  | Request for creating a token |
+
+
+#### Example Usage
+
+```ruby
+public_key = 'public_key'
+request = CreateTokenRequest.new
+
+result = tokens.create_token(public_key, request)
+
+```
+
+
+[Back to List of Controllers](#list_of_controllers)
+
+
+