lago_ruby 0.46.0.pre.beta

data/docs/TaxesApi.md

@@ -0,0 +1,363 @@
+# LagoAPI::TaxesApi
+
+All URIs are relative to *https://api.getlago.com/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_tax**](TaxesApi.md#create_tax) | **POST** /taxes | Create a tax |
+| [**destroy_tax**](TaxesApi.md#destroy_tax) | **DELETE** /taxes/{code} | Delete a tax |
+| [**find_all_taxes**](TaxesApi.md#find_all_taxes) | **GET** /taxes | List all taxes |
+| [**find_tax**](TaxesApi.md#find_tax) | **GET** /taxes/{code} | Retrieve a Tax |
+| [**update_tax**](TaxesApi.md#update_tax) | **PUT** /taxes/{code} | Update a tax |
+
+
+## create_tax
+
+> <Tax> create_tax(tax_create_input)
+
+Create a tax
+
+This endpoint creates a new tax representing a customizable tax rate applicable to either the organization or a specific customer.
+
+### Examples
+
+```ruby
+require 'time'
+require 'lago_ruby'
+# setup authorization
+LagoAPI.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = LagoAPI::TaxesApi.new
+tax_create_input = LagoAPI::TaxCreateInput.new({tax: LagoAPI::TaxCreateInputTax.new({name: 'TVA', code: 'french_standard_vat', rate: '20.0'})}) # TaxCreateInput | Tax creation payload
+
+begin
+  # Create a tax
+  result = api_instance.create_tax(tax_create_input)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling TaxesApi->create_tax: #{e}"
+end
+```
+
+#### Using the create_tax_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Tax>, Integer, Hash)> create_tax_with_http_info(tax_create_input)
+
+```ruby
+begin
+  # Create a tax
+  data, status_code, headers = api_instance.create_tax_with_http_info(tax_create_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Tax>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling TaxesApi->create_tax_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tax_create_input** | [**TaxCreateInput**](TaxCreateInput.md) | Tax creation payload |  |
+
+### Return type
+
+[**Tax**](Tax.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## destroy_tax
+
+> <Tax> destroy_tax(code)
+
+Delete a tax
+
+This endpoint is used to delete a tax.
+
+### Examples
+
+```ruby
+require 'time'
+require 'lago_ruby'
+# setup authorization
+LagoAPI.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = LagoAPI::TaxesApi.new
+code = 'french_standard_vat' # String | The code of the tax. It serves as a unique identifier associated with a particular tax. The code is typically used for internal or system-level identification purposes.
+
+begin
+  # Delete a tax
+  result = api_instance.destroy_tax(code)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling TaxesApi->destroy_tax: #{e}"
+end
+```
+
+#### Using the destroy_tax_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Tax>, Integer, Hash)> destroy_tax_with_http_info(code)
+
+```ruby
+begin
+  # Delete a tax
+  data, status_code, headers = api_instance.destroy_tax_with_http_info(code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Tax>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling TaxesApi->destroy_tax_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | The code of the tax. It serves as a unique identifier associated with a particular tax. The code is typically used for internal or system-level identification purposes. |  |
+
+### Return type
+
+[**Tax**](Tax.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## find_all_taxes
+
+> <TaxesPaginated> find_all_taxes(opts)
+
+List all taxes
+
+This endpoint retrieves all existing taxes representing a customizable tax rate applicable to either the organization or a specific customer.
+
+### Examples
+
+```ruby
+require 'time'
+require 'lago_ruby'
+# setup authorization
+LagoAPI.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = LagoAPI::TaxesApi.new
+opts = {
+  page: 1, # Integer | Page number.
+  per_page: 20 # Integer | Number of records per page.
+}
+
+begin
+  # List all taxes
+  result = api_instance.find_all_taxes(opts)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling TaxesApi->find_all_taxes: #{e}"
+end
+```
+
+#### Using the find_all_taxes_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TaxesPaginated>, Integer, Hash)> find_all_taxes_with_http_info(opts)
+
+```ruby
+begin
+  # List all taxes
+  data, status_code, headers = api_instance.find_all_taxes_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TaxesPaginated>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling TaxesApi->find_all_taxes_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page number. | [optional] |
+| **per_page** | **Integer** | Number of records per page. | [optional] |
+
+### Return type
+
+[**TaxesPaginated**](TaxesPaginated.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## find_tax
+
+> <Tax> find_tax(code)
+
+Retrieve a Tax
+
+This endpoint retrieves an existing tax representing a customizable tax rate applicable to either the organization or a specific customer. The tax is identified by its unique code.
+
+### Examples
+
+```ruby
+require 'time'
+require 'lago_ruby'
+# setup authorization
+LagoAPI.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = LagoAPI::TaxesApi.new
+code = 'french_standard_vat' # String | The code of the tax. It serves as a unique identifier associated with a particular tax. The code is typically used for internal or system-level identification purposes.
+
+begin
+  # Retrieve a Tax
+  result = api_instance.find_tax(code)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling TaxesApi->find_tax: #{e}"
+end
+```
+
+#### Using the find_tax_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Tax>, Integer, Hash)> find_tax_with_http_info(code)
+
+```ruby
+begin
+  # Retrieve a Tax
+  data, status_code, headers = api_instance.find_tax_with_http_info(code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Tax>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling TaxesApi->find_tax_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | The code of the tax. It serves as a unique identifier associated with a particular tax. The code is typically used for internal or system-level identification purposes. |  |
+
+### Return type
+
+[**Tax**](Tax.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_tax
+
+> <Tax> update_tax(code, tax_update_input)
+
+Update a tax
+
+This endpoint updates an existing tax representing a customizable tax rate applicable to either the organization or a specific customer.
+
+### Examples
+
+```ruby
+require 'time'
+require 'lago_ruby'
+# setup authorization
+LagoAPI.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = LagoAPI::TaxesApi.new
+code = 'french_standard_vat' # String | The code of the tax. It serves as a unique identifier associated with a particular tax. The code is typically used for internal or system-level identification purposes.
+tax_update_input = LagoAPI::TaxUpdateInput.new({tax: LagoAPI::TaxBaseInput.new}) # TaxUpdateInput | Tax update payload
+
+begin
+  # Update a tax
+  result = api_instance.update_tax(code, tax_update_input)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling TaxesApi->update_tax: #{e}"
+end
+```
+
+#### Using the update_tax_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Tax>, Integer, Hash)> update_tax_with_http_info(code, tax_update_input)
+
+```ruby
+begin
+  # Update a tax
+  data, status_code, headers = api_instance.update_tax_with_http_info(code, tax_update_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Tax>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling TaxesApi->update_tax_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | The code of the tax. It serves as a unique identifier associated with a particular tax. The code is typically used for internal or system-level identification purposes. |  |
+| **tax_update_input** | [**TaxUpdateInput**](TaxUpdateInput.md) | Tax update payload |  |
+
+### Return type
+
+[**Tax**](Tax.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/TaxesPaginated.md

@@ -0,0 +1,20 @@
+# LagoAPI::TaxesPaginated
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **taxes** | [**Array<TaxObject>**](TaxObject.md) |  |  |
+| **meta** | [**PaginationMeta**](PaginationMeta.md) |  |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::TaxesPaginated.new(
+  taxes: null,
+  meta: null
+)
+```
+

data/docs/Timezone.md

@@ -0,0 +1,15 @@
+# LagoAPI::Timezone
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::Timezone.new()
+```
+

data/docs/Wallet.md

@@ -0,0 +1,18 @@
+# LagoAPI::Wallet
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **wallet** | [**WalletObject**](WalletObject.md) |  |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::Wallet.new(
+  wallet: null
+)
+```
+

data/docs/WalletCreateInput.md

@@ -0,0 +1,18 @@
+# LagoAPI::WalletCreateInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **wallet** | [**WalletCreateInputWallet**](WalletCreateInputWallet.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::WalletCreateInput.new(
+  wallet: null
+)
+```
+

data/docs/WalletCreateInputWallet.md

@@ -0,0 +1,30 @@
+# LagoAPI::WalletCreateInputWallet
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the wallet. | [optional] |
+| **rate_amount** | **String** | The rate of conversion between credits and the amount in the specified currency. It indicates the ratio or factor used to convert credits into the corresponding monetary value in the currency of the transaction. |  |
+| **currency** | [**Currency**](Currency.md) |  |  |
+| **paid_credits** | **String** | The number of paid credits. Required only if there is no granted credits. | [optional] |
+| **granted_credits** | **String** | The number of free granted credits. Required only if there is no paid credits. | [optional] |
+| **external_customer_id** | **String** | The customer external unique identifier (provided by your own application) |  |
+| **expiration_at** | **Time** | The date and time that determines when the wallet will expire. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC). | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::WalletCreateInputWallet.new(
+  name: Prepaid,
+  rate_amount: 1.5,
+  currency: null,
+  paid_credits: 20.0,
+  granted_credits: 10.0,
+  external_customer_id: hooli_1234,
+  expiration_at: 2022-07-07T23:59:59Z
+)
+```
+

data/docs/WalletObject.md

@@ -0,0 +1,46 @@
+# LagoAPI::WalletObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet’s record within the Lago system. |  |
+| **lago_customer_id** | **String** | Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer’s record within the Lago system. |  |
+| **external_customer_id** | **String** | The customer external unique identifier (provided by your own application) |  |
+| **status** | **String** | The status of the wallet. Possible values are `active` or `terminated`. |  |
+| **currency** | [**Currency**](Currency.md) |  |  |
+| **name** | **String** | The name of the wallet. | [optional] |
+| **rate_amount** | **String** | The rate of conversion between credits and the amount in the specified currency. It indicates the ratio or factor used to convert credits into the corresponding monetary value in the currency of the transaction. |  |
+| **credits_balance** | **String** | The current wallet balance expressed in credits. |  |
+| **balance_cents** | **Integer** | The current wallet balance expressed in cents. |  |
+| **consumed_credits** | **String** | The number of consumed credits. |  |
+| **created_at** | **Time** | The date of the wallet creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). |  |
+| **expiration_at** | **Time** | The date and time that determines when the wallet will expire. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC). | [optional] |
+| **last_balance_sync_at** | **Time** | The date and time of the last balance top-up. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC). | [optional] |
+| **last_consumed_credit_at** | **Time** | The date and time of the last credits consumption. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC). | [optional] |
+| **terminated_at** | **Time** | The date of terminaison of the wallet. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC). | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::WalletObject.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  lago_customer_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  external_customer_id: hooli_1234,
+  status: active,
+  currency: null,
+  name: Prepaid,
+  rate_amount: 1.5,
+  credits_balance: 28.0,
+  balance_cents: 1000,
+  consumed_credits: 2.0,
+  created_at: 2022-04-29T08:59:51Z,
+  expiration_at: null,
+  last_balance_sync_at: 2022-04-29T08:59:51Z,
+  last_consumed_credit_at: 2022-04-29T08:59:51Z,
+  terminated_at: 2022-09-14T16:35:31Z
+)
+```
+

data/docs/WalletTransactionCreateInput.md

@@ -0,0 +1,18 @@
+# LagoAPI::WalletTransactionCreateInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **wallet_transaction** | [**WalletTransactionCreateInputWalletTransaction**](WalletTransactionCreateInputWalletTransaction.md) |  |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::WalletTransactionCreateInput.new(
+  wallet_transaction: null
+)
+```
+

data/docs/WalletTransactionCreateInputWalletTransaction.md

@@ -0,0 +1,22 @@
+# LagoAPI::WalletTransactionCreateInputWalletTransaction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **wallet_id** | **String** | Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet’s record within the Lago system. |  |
+| **paid_credits** | **String** | The number of paid credits. Required only if there is no granted credits. | [optional] |
+| **granted_credits** | **String** | The number of free granted credits. Required only if there is no paid credits. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::WalletTransactionCreateInputWalletTransaction.new(
+  wallet_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  paid_credits: 20.0,
+  granted_credits: 10.0
+)
+```
+

data/docs/WalletTransactionObject.md

@@ -0,0 +1,32 @@
+# LagoAPI::WalletTransactionObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | Unique identifier assigned to the wallet transaction within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet transaction’s record within the Lago system. |  |
+| **lago_wallet_id** | **String** | Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet’s record within the Lago system. |  |
+| **status** | **String** | The status of the wallet transaction. Possible values are `pending` or `settled`. |  |
+| **transaction_type** | **String** | The type of transaction. Possible values are `inbound` (increasing the balance) or `outbound` (decreasing the balance). |  |
+| **amount** | **String** | The amount of credits based on the rate and the currency. |  |
+| **credit_amount** | **String** | The number of credits used in the wallet transaction. |  |
+| **settled_at** | **Time** | The date when wallet transaction is settled, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). | [optional] |
+| **created_at** | **Time** | The date of the wallet transaction creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::WalletTransactionObject.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  lago_wallet_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  status: settled,
+  transaction_type: inbound,
+  amount: 10.0,
+  credit_amount: 100.0,
+  settled_at: 2022-04-29T08:59:51Z,
+  created_at: 2022-04-29T08:59:51Z
+)
+```
+

data/docs/WalletTransactions.md

@@ -0,0 +1,18 @@
+# LagoAPI::WalletTransactions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **wallet_transactions** | [**Array<WalletTransactionObject>**](WalletTransactionObject.md) |  |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::WalletTransactions.new(
+  wallet_transactions: null
+)
+```
+

data/docs/WalletTransactionsPaginated.md

@@ -0,0 +1,20 @@
+# LagoAPI::WalletTransactionsPaginated
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **wallet_transactions** | [**Array<WalletTransactionObject>**](WalletTransactionObject.md) |  |  |
+| **meta** | [**PaginationMeta**](PaginationMeta.md) |  |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::WalletTransactionsPaginated.new(
+  wallet_transactions: null,
+  meta: null
+)
+```
+

data/docs/WalletUpdateInput.md

@@ -0,0 +1,18 @@
+# LagoAPI::WalletUpdateInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **wallet** | [**WalletUpdateInputWallet**](WalletUpdateInputWallet.md) |  |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::WalletUpdateInput.new(
+  wallet: null
+)
+```
+

data/docs/WalletUpdateInputWallet.md

@@ -0,0 +1,20 @@
+# LagoAPI::WalletUpdateInputWallet
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the wallet. | [optional] |
+| **expiration_at** | **Time** | The date and time that determines when the wallet will expire. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC). | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::WalletUpdateInputWallet.new(
+  name: new_name,
+  expiration_at: 2022-07-07T23:59:59Z
+)
+```
+