lago_ruby 0.46.0.pre.beta

data/docs/EventObject.md

@@ -0,0 +1,36 @@
+# LagoAPI::EventObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | Unique identifier assigned to the event within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the event's record within the Lago system |  |
+| **transaction_id** | **String** | This field represents a unique identifier for the event. It is crucial for ensuring idempotency, meaning that each event can be uniquely identified and processed without causing any unintended side effects. |  |
+| **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). This field is optional if you send the `external_subscription_id`, targeting a specific subscription. |  |
+| **code** | **String** | The code that identifies a targeted billable metric. It is essential that this code matches the `code` property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process. |  |
+| **timestamp** | **Time** | This field captures the Unix timestamp in seconds indicating the occurrence of the event in Coordinated Universal Time (UTC). If this timestamp is not provided, the API will automatically set it to the time of event reception. |  |
+| **properties** | [**EventBatchInputEventProperties**](EventBatchInputEventProperties.md) |  | [optional] |
+| **lago_subscription_id** | **String** | Unique identifier assigned to the subscription within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the subscription’s record within the Lago system |  |
+| **external_subscription_id** | **String** | The unique identifier of the subscription within your application. It is a mandatory field when the customer possesses multiple subscriptions or when the `external_customer_id` is not provided. |  |
+| **created_at** | **Time** | The creation date of the event's record in the Lago application, presented in the ISO 8601 datetime format, specifically in Coordinated Universal Time (UTC). It provides the precise timestamp of when the event's record was created within the Lago application |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::EventObject.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  transaction_id: transaction_1234567890,
+  lago_customer_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  external_customer_id: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba,
+  code: storage,
+  timestamp: 2022-04-29T08:59:51Z,
+  properties: null,
+  lago_subscription_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  external_subscription_id: sub_1234567890,
+  created_at: 2022-04-29T08:59:51Z
+)
+```
+

data/docs/EventsApi.md

@@ -0,0 +1,285 @@
+# LagoAPI::EventsApi
+
+All URIs are relative to *https://api.getlago.com/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_batch_events**](EventsApi.md#create_batch_events) | **POST** /events/batch | Batch multiple events |
+| [**create_event**](EventsApi.md#create_event) | **POST** /events | Send usage events |
+| [**event_estimate_fees**](EventsApi.md#event_estimate_fees) | **POST** /events/estimate_fees | Estimate fees for a pay in advance charge |
+| [**find_event**](EventsApi.md#find_event) | **GET** /events/{transaction_id} | Retrieve a specific event |
+
+
+## create_batch_events
+
+> create_batch_events(event_batch_input)
+
+Batch multiple events
+
+This endpoint is used for transmitting a batch of usage measurement events to multiple subscriptions for a single 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::EventsApi.new
+event_batch_input = LagoAPI::EventBatchInput.new({event: LagoAPI::EventBatchInputEvent.new({transaction_id: 'transaction_1234567890', external_subscription_ids: ["sub_1234567890", "sub_0987654321"], code: 'storage'})}) # EventBatchInput | Batch events payload
+
+begin
+  # Batch multiple events
+  api_instance.create_batch_events(event_batch_input)
+rescue LagoAPI::ApiError => e
+  puts "Error when calling EventsApi->create_batch_events: #{e}"
+end
+```
+
+#### Using the create_batch_events_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> create_batch_events_with_http_info(event_batch_input)
+
+```ruby
+begin
+  # Batch multiple events
+  data, status_code, headers = api_instance.create_batch_events_with_http_info(event_batch_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue LagoAPI::ApiError => e
+  puts "Error when calling EventsApi->create_batch_events_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_batch_input** | [**EventBatchInput**](EventBatchInput.md) | Batch events payload |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_event
+
+> create_event(event_input)
+
+Send usage events
+
+This endpoint is used for transmitting usage measurement events to either a designated customer or a specific subscription.
+
+### 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::EventsApi.new
+event_input = LagoAPI::EventInput.new({event: LagoAPI::EventInputEvent.new({transaction_id: 'transaction_1234567890', code: 'storage'})}) # EventInput | Event payload
+
+begin
+  # Send usage events
+  api_instance.create_event(event_input)
+rescue LagoAPI::ApiError => e
+  puts "Error when calling EventsApi->create_event: #{e}"
+end
+```
+
+#### Using the create_event_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> create_event_with_http_info(event_input)
+
+```ruby
+begin
+  # Send usage events
+  data, status_code, headers = api_instance.create_event_with_http_info(event_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue LagoAPI::ApiError => e
+  puts "Error when calling EventsApi->create_event_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_input** | [**EventInput**](EventInput.md) | Event payload |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## event_estimate_fees
+
+> <Fees> event_estimate_fees(event_estimate_fees_input)
+
+Estimate fees for a pay in advance charge
+
+Estimate the fees that would be created after reception of an event for a billable metric attached to one or multiple pay in advance charges
+
+### 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::EventsApi.new
+event_estimate_fees_input = LagoAPI::EventEstimateFeesInput.new({event: LagoAPI::EventEstimateFeesInputEvent.new({code: 'storage'})}) # EventEstimateFeesInput | Event estimate payload
+
+begin
+  # Estimate fees for a pay in advance charge
+  result = api_instance.event_estimate_fees(event_estimate_fees_input)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling EventsApi->event_estimate_fees: #{e}"
+end
+```
+
+#### Using the event_estimate_fees_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Fees>, Integer, Hash)> event_estimate_fees_with_http_info(event_estimate_fees_input)
+
+```ruby
+begin
+  # Estimate fees for a pay in advance charge
+  data, status_code, headers = api_instance.event_estimate_fees_with_http_info(event_estimate_fees_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Fees>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling EventsApi->event_estimate_fees_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_estimate_fees_input** | [**EventEstimateFeesInput**](EventEstimateFeesInput.md) | Event estimate payload |  |
+
+### Return type
+
+[**Fees**](Fees.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## find_event
+
+> <Event> find_event(transaction_id)
+
+Retrieve a specific event
+
+This endpoint is used for retrieving a specific usage measurement event that has been sent to a customer or a subscription.
+
+### 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::EventsApi.new
+transaction_id = 'transaction_1234567890' # String | This field represents the unique identifier sent for this specific event.
+
+begin
+  # Retrieve a specific event
+  result = api_instance.find_event(transaction_id)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling EventsApi->find_event: #{e}"
+end
+```
+
+#### Using the find_event_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Event>, Integer, Hash)> find_event_with_http_info(transaction_id)
+
+```ruby
+begin
+  # Retrieve a specific event
+  data, status_code, headers = api_instance.find_event_with_http_info(transaction_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Event>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling EventsApi->find_event_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_id** | **String** | This field represents the unique identifier sent for this specific event. |  |
+
+### Return type
+
+[**Event**](Event.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Fee.md

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

data/docs/FeeAppliedTaxObject.md

@@ -0,0 +1,36 @@
+# LagoAPI::FeeAppliedTaxObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_fee_id** | **String** | Unique identifier of the fee, created by Lago. | [optional] |
+| **lago_id** | **String** | Unique identifier of the applied tax, created by Lago. | [optional] |
+| **lago_tax_id** | **String** | Unique identifier of the tax, created by Lago. | [optional] |
+| **tax_name** | **String** | Name of the tax. | [optional] |
+| **tax_code** | **String** | Unique code used to identify the tax associated with the API request. | [optional] |
+| **tax_rate** | **Float** | The percentage rate of the tax | [optional] |
+| **tax_description** | **String** | Internal description of the taxe | [optional] |
+| **amount_cents** | **Integer** | Amount of the tax | [optional] |
+| **amount_currency** | [**Currency**](Currency.md) |  | [optional] |
+| **created_at** | **Time** | The date and time when the applied tax was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the applied tax was initially created. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::FeeAppliedTaxObject.new(
+  lago_fee_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  lago_tax_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  tax_name: TVA,
+  tax_code: french_standard_vat,
+  tax_rate: 20,
+  tax_description: French standard VAT,
+  amount_cents: 2000,
+  amount_currency: null,
+  created_at: 2022-09-14T16:35:31Z
+)
+```
+

data/docs/FeeObject.md

@@ -0,0 +1,74 @@
+# LagoAPI::FeeObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee’s record within the Lago system. | [optional] |
+| **lago_group_id** | **String** | Unique identifier assigned to the group that the fee belongs to | [optional] |
+| **lago_invoice_id** | **String** | Unique identifier assigned to the invoice that the fee belongs to | [optional] |
+| **lago_true_up_fee_id** | **String** | Unique identifier assigned to the true-up fee when a minimum has been set to the charge. This identifier helps to distinguish and manage the true-up fee associated with the charge, which may be applicable when a minimum threshold or limit is set for the charge amount. | [optional] |
+| **lago_true_up_parent_fee_id** | **String** | Unique identifier assigned to the parent fee on which the true-up fee is assigned. This identifier establishes the relationship between the parent fee and the associated true-up fee. | [optional] |
+| **lago_subscription_id** | **String** | Unique identifier assigned to the subscription, created by Lago. This field is specifically displayed when the fee type is charge and the payment for the fee is made in advance (`pay_in_advance` is set to true). | [optional] |
+| **lago_customer_id** | **String** | Unique identifier assigned to the customer, created by Lago. This field is specifically displayed when the fee type is charge and the payment for the fee is made in advance (`pay_in_advance` is set to true). | [optional] |
+| **external_customer_id** | **String** | Unique identifier assigned to the customer in your application. This field is specifically displayed when the fee type is charge and the payment for the fee is made in advance (`pay_in_advance` is set to true). | [optional] |
+| **external_subscription_id** | **String** | Unique identifier assigned to the subscription in your application. This field is specifically displayed when the fee type is charge and the payment for the fee is made in advance (`pay_in_advance` is set to true). | [optional] |
+| **amount_cents** | **Integer** | The cost of this specific fee, excluding any applicable taxes. |  |
+| **amount_currency** | [**Currency**](Currency.md) |  |  |
+| **taxes_amount_cents** | **Integer** | The cost of the tax associated with this specific fee. |  |
+| **taxes_rate** | **Float** | The tax rate associated with this specific fee. |  |
+| **units** | **String** | The number of units used to charge the customer. This field indicates the quantity or count of units consumed or utilized in the context of the charge. It helps in determining the basis for calculating the fee or cost associated with the usage of the service or product provided to the customer. |  |
+| **total_amount_cents** | **Integer** | The cost of this specific fee, including any applicable taxes. |  |
+| **total_amount_currency** | [**Currency**](Currency.md) |  |  |
+| **events_count** | **Integer** | The number of events that have been sent and used to charge the customer. This field indicates the count or quantity of events that have been processed and considered in the charging process. | [optional] |
+| **pay_in_advance** | **Boolean** | Flag that indicates whether the fee was paid in advance. It serves as a boolean value, where `true` represents that the fee was paid in advance (straightaway), and `false` indicates that the fee was not paid in arrears (at the end of the period). |  |
+| **invoiceable** | **Boolean** | Flag that indicates whether the fee was included on the invoice. It serves as a boolean value, where `true` represents that the fee was included on the invoice, and `false` indicates that the fee was not included on the invoice. |  |
+| **from_date** | **Time** | The beginning date of the period that the fee covers. It is applicable only to `subscription` and `charge` fees. This field indicates the start date of the billing period or subscription period associated with the fee. | [optional] |
+| **to_date** | **Time** | The ending date of the period that the fee covers. It is applicable only to `subscription` and `charge` fees. This field indicates the end date of the billing period or subscription period associated with the fee. | [optional] |
+| **payment_status** | **String** | Indicates the payment status of the fee. It represents the current status of the payment associated with the fee. The possible values for this field are `pending`, `succeeded`, `failed` and `refunded`. |  |
+| **created_at** | **Time** | The date and time when the fee was created. It is provided in Coordinated Universal Time (UTC) format. | [optional] |
+| **succeeded_at** | **Time** | The date and time when the payment for the fee was successfully processed. It is provided in Coordinated Universal Time (UTC) format. | [optional] |
+| **failed_at** | **Time** | The date and time when the payment for the fee failed to process. It is provided in Coordinated Universal Time (UTC) format. | [optional] |
+| **refunded_at** | **Time** | The date and time when the payment for the fee was refunded. It is provided in Coordinated Universal Time (UTC) format | [optional] |
+| **event_transaction_id** | **String** | Unique identifier assigned to the transaction. This field is specifically displayed when the fee type is `charge` and the payment for the fee is made in advance (`pay_in_advance` is set to `true`). | [optional] |
+| **item** | [**FeeObjectItem**](FeeObjectItem.md) |  |  |
+| **applied_taxes** | [**Array<FeeAppliedTaxObject>**](FeeAppliedTaxObject.md) | List of fee applied taxes | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::FeeObject.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  lago_group_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  lago_invoice_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  lago_true_up_fee_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  lago_true_up_parent_fee_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  lago_subscription_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  lago_customer_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  external_customer_id: external_id,
+  external_subscription_id: external_id,
+  amount_cents: 100,
+  amount_currency: null,
+  taxes_amount_cents: 20,
+  taxes_rate: 20,
+  units: 0.32,
+  total_amount_cents: 120,
+  total_amount_currency: null,
+  events_count: 23,
+  pay_in_advance: true,
+  invoiceable: true,
+  from_date: 2022-04-29T08:59:51Z,
+  to_date: 2022-05-29T08:59:51Z,
+  payment_status: pending,
+  created_at: 2022-08-24T14:58:59Z,
+  succeeded_at: 2022-08-24T14:58:59Z,
+  failed_at: 2022-08-24T14:58:59Z,
+  refunded_at: 2022-08-24T14:58:59Z,
+  event_transaction_id: transaction_1234567890,
+  item: null,
+  applied_taxes: null
+)
+```
+

data/docs/FeeObjectItem.md

@@ -0,0 +1,26 @@
+# LagoAPI::FeeObjectItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The fee type. Possible values are `add-on`, `charge`, `credit` or `subscription`. |  |
+| **code** | **String** | The code of the fee item. It can be the code of the `add-o`n, the code of the `charge`, the code of the `credit` or the code of the `subscription`. |  |
+| **name** | **String** | The name of the fee item. It can be the name of the `add-on`, the name of the `charge`, the name of the `credit` or the name of the `subscription`. |  |
+| **lago_item_id** | **String** | Unique identifier of the fee item, created by Lago. It can be the identifier of the `add-on`, the identifier of the `charge`, the identifier of the `credit` or the identifier of the `subscription`. |  |
+| **item_type** | **String** | The type of the fee item. Possible values are `AddOn`, `BillableMetric`, `WalletTransaction` or `Subscription`. |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::FeeObjectItem.new(
+  type: subscription,
+  code: startup,
+  name: Startup,
+  lago_item_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  item_type: Subscription
+)
+```
+

data/docs/FeeUpdateInput.md

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

data/docs/FeeUpdateInputFee.md

@@ -0,0 +1,18 @@
+# LagoAPI::FeeUpdateInputFee
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_status** | **String** | The payment status of the fee. Possible values are `pending`, `succeeded`, `failed` or `refunded`. |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::FeeUpdateInputFee.new(
+  payment_status: succeeded
+)
+```
+

data/docs/Fees.md

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