lago_ruby 0.46.0.pre.beta

data/docs/CustomersApi.md

@@ -0,0 +1,505 @@
+# LagoAPI::CustomersApi
+
+All URIs are relative to *https://api.getlago.com/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_customer**](CustomersApi.md#create_customer) | **POST** /customers | Create a customer |
+| [**delete_applied_coupon**](CustomersApi.md#delete_applied_coupon) | **DELETE** /customers/{external_customer_id}/applied_coupons/{applied_coupon_id} | Delete an applied coupon |
+| [**destroy_customer**](CustomersApi.md#destroy_customer) | **DELETE** /customers/{external_id} | Delete a customer |
+| [**find_all_customers**](CustomersApi.md#find_all_customers) | **GET** /customers | List all customers |
+| [**find_customer**](CustomersApi.md#find_customer) | **GET** /customers/{external_id} | Retrieve a customer |
+| [**find_customer_current_usage**](CustomersApi.md#find_customer_current_usage) | **GET** /customers/{external_customer_id}/current_usage | Retrieve customer current usage |
+| [**get_customer_portal_url**](CustomersApi.md#get_customer_portal_url) | **GET** /customers/{external_customer_id}/portal_url | Get a customer portal URL |
+
+
+## create_customer
+
+> <Customer> create_customer(customer_create_input)
+
+Create a customer
+
+This endpoint creates a new 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::CustomersApi.new
+customer_create_input = LagoAPI::CustomerCreateInput.new({customer: LagoAPI::CustomerCreateInputCustomer.new({external_id: '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba'})}) # CustomerCreateInput | Customer payload
+
+begin
+  # Create a customer
+  result = api_instance.create_customer(customer_create_input)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CustomersApi->create_customer: #{e}"
+end
+```
+
+#### Using the create_customer_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Customer>, Integer, Hash)> create_customer_with_http_info(customer_create_input)
+
+```ruby
+begin
+  # Create a customer
+  data, status_code, headers = api_instance.create_customer_with_http_info(customer_create_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Customer>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CustomersApi->create_customer_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_create_input** | [**CustomerCreateInput**](CustomerCreateInput.md) | Customer payload |  |
+
+### Return type
+
+[**Customer**](Customer.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_applied_coupon
+
+> <AppliedCoupon> delete_applied_coupon(external_customer_id, applied_coupon_id)
+
+Delete an applied coupon
+
+This endpoint is used to delete a specific coupon that has been applied to a 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::CustomersApi.new
+external_customer_id = '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba' # String | The customer external unique identifier (provided by your own application)
+applied_coupon_id = '1a901a90-1a90-1a90-1a90-1a901a901a90' # String | Unique identifier of the applied coupon, created by Lago.
+
+begin
+  # Delete an applied coupon
+  result = api_instance.delete_applied_coupon(external_customer_id, applied_coupon_id)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CustomersApi->delete_applied_coupon: #{e}"
+end
+```
+
+#### Using the delete_applied_coupon_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AppliedCoupon>, Integer, Hash)> delete_applied_coupon_with_http_info(external_customer_id, applied_coupon_id)
+
+```ruby
+begin
+  # Delete an applied coupon
+  data, status_code, headers = api_instance.delete_applied_coupon_with_http_info(external_customer_id, applied_coupon_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AppliedCoupon>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CustomersApi->delete_applied_coupon_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **external_customer_id** | **String** | The customer external unique identifier (provided by your own application) |  |
+| **applied_coupon_id** | **String** | Unique identifier of the applied coupon, created by Lago. |  |
+
+### Return type
+
+[**AppliedCoupon**](AppliedCoupon.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## destroy_customer
+
+> <Customer> destroy_customer(external_id)
+
+Delete a customer
+
+This endpoint deletes an existing 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::CustomersApi.new
+external_id = '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba' # String | External ID of the existing customer
+
+begin
+  # Delete a customer
+  result = api_instance.destroy_customer(external_id)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CustomersApi->destroy_customer: #{e}"
+end
+```
+
+#### Using the destroy_customer_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Customer>, Integer, Hash)> destroy_customer_with_http_info(external_id)
+
+```ruby
+begin
+  # Delete a customer
+  data, status_code, headers = api_instance.destroy_customer_with_http_info(external_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Customer>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CustomersApi->destroy_customer_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **external_id** | **String** | External ID of the existing customer |  |
+
+### Return type
+
+[**Customer**](Customer.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## find_all_customers
+
+> <CustomersPaginated> find_all_customers(opts)
+
+List all customers
+
+This endpoint retrieves all existing customers.
+
+### 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::CustomersApi.new
+opts = {
+  page: 1, # Integer | Page number.
+  per_page: 20 # Integer | Number of records per page.
+}
+
+begin
+  # List all customers
+  result = api_instance.find_all_customers(opts)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CustomersApi->find_all_customers: #{e}"
+end
+```
+
+#### Using the find_all_customers_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomersPaginated>, Integer, Hash)> find_all_customers_with_http_info(opts)
+
+```ruby
+begin
+  # List all customers
+  data, status_code, headers = api_instance.find_all_customers_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomersPaginated>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CustomersApi->find_all_customers_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
+
+[**CustomersPaginated**](CustomersPaginated.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## find_customer
+
+> <Customer> find_customer(external_id)
+
+Retrieve a customer
+
+This endpoint retrieves an existing 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::CustomersApi.new
+external_id = '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba' # String | External ID of the existing customer
+
+begin
+  # Retrieve a customer
+  result = api_instance.find_customer(external_id)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CustomersApi->find_customer: #{e}"
+end
+```
+
+#### Using the find_customer_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Customer>, Integer, Hash)> find_customer_with_http_info(external_id)
+
+```ruby
+begin
+  # Retrieve a customer
+  data, status_code, headers = api_instance.find_customer_with_http_info(external_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Customer>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CustomersApi->find_customer_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **external_id** | **String** | External ID of the existing customer |  |
+
+### Return type
+
+[**Customer**](Customer.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## find_customer_current_usage
+
+> <CustomerUsage> find_customer_current_usage(external_customer_id, external_subscription_id)
+
+Retrieve customer current usage
+
+This endpoint enables the retrieval of the usage-based billing data for a customer within the current period.
+
+### 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::CustomersApi.new
+external_customer_id = '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba' # String | The customer external unique identifier (provided by your own application).
+external_subscription_id = 'sub_1234567890' # String | The unique identifier of the subscription within your application.
+
+begin
+  # Retrieve customer current usage
+  result = api_instance.find_customer_current_usage(external_customer_id, external_subscription_id)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CustomersApi->find_customer_current_usage: #{e}"
+end
+```
+
+#### Using the find_customer_current_usage_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomerUsage>, Integer, Hash)> find_customer_current_usage_with_http_info(external_customer_id, external_subscription_id)
+
+```ruby
+begin
+  # Retrieve customer current usage
+  data, status_code, headers = api_instance.find_customer_current_usage_with_http_info(external_customer_id, external_subscription_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomerUsage>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CustomersApi->find_customer_current_usage_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **external_customer_id** | **String** | The customer external unique identifier (provided by your own application). |  |
+| **external_subscription_id** | **String** | The unique identifier of the subscription within your application. |  |
+
+### Return type
+
+[**CustomerUsage**](CustomerUsage.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_customer_portal_url
+
+> <GetCustomerPortalUrl200Response> get_customer_portal_url(external_customer_id)
+
+Get a customer portal URL
+
+Retrieves an embeddable link for displaying a customer portal.  This endpoint allows you to fetch the URL that can be embedded to provide customers access to a dedicated portal
+
+### 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::CustomersApi.new
+external_customer_id = '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba' # String | External ID of the existing customer
+
+begin
+  # Get a customer portal URL
+  result = api_instance.get_customer_portal_url(external_customer_id)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CustomersApi->get_customer_portal_url: #{e}"
+end
+```
+
+#### Using the get_customer_portal_url_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCustomerPortalUrl200Response>, Integer, Hash)> get_customer_portal_url_with_http_info(external_customer_id)
+
+```ruby
+begin
+  # Get a customer portal URL
+  data, status_code, headers = api_instance.get_customer_portal_url_with_http_info(external_customer_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCustomerPortalUrl200Response>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CustomersApi->get_customer_portal_url_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **external_customer_id** | **String** | External ID of the existing customer |  |
+
+### Return type
+
+[**GetCustomerPortalUrl200Response**](GetCustomerPortalUrl200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CustomersPaginated.md

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

data/docs/Event.md

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

data/docs/EventBatchInput.md

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

data/docs/EventBatchInputEvent.md

@@ -0,0 +1,28 @@
+# LagoAPI::EventBatchInputEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. |  |
+| **external_customer_id** | **String** | The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_ids`, targeting a specific subscription. | [optional] |
+| **external_subscription_ids** | **Array<String>** | Array of unique identifiers of the targeted subscriptions within your application. |  |
+| **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** | **Integer** | 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. | [optional] |
+| **properties** | [**EventBatchInputEventProperties**](EventBatchInputEventProperties.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::EventBatchInputEvent.new(
+  transaction_id: transaction_1234567890,
+  external_customer_id: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba,
+  external_subscription_ids: ["sub_1234567890","sub_0987654321"],
+  code: storage,
+  timestamp: 1651240791,
+  properties: null
+)
+```
+

data/docs/EventBatchInputEventProperties.md

@@ -0,0 +1,18 @@
+# LagoAPI::EventBatchInputEventProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **operation_type** | **String** | The `operation_type` field is only necessary when adding or removing a specific unit when the targeted billable metric adopts a `unique_count_agg` aggregation method. In other cases, the `operation_type` field is not required. The valid values for the `operation_type` field are `add` or `remove`, which indicate whether the unit is being added or removed from the unique count aggregation, respectively. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::EventBatchInputEventProperties.new(
+  operation_type: null
+)
+```
+

data/docs/EventEstimateFeesInput.md

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

data/docs/EventEstimateFeesInputEvent.md

@@ -0,0 +1,24 @@
+# LagoAPI::EventEstimateFeesInputEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. |  |
+| **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. | [optional] |
+| **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. | [optional] |
+| **properties** | **Object** | This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::EventEstimateFeesInputEvent.new(
+  code: storage,
+  external_customer_id: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba,
+  external_subscription_id: sub_1234567890,
+  properties: null
+)
+```
+

data/docs/EventInput.md

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

data/docs/EventInputEvent.md

@@ -0,0 +1,28 @@
+# LagoAPI::EventInputEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. |  |
+| **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. | [optional] |
+| **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. | [optional] |
+| **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** | **Integer** | 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. | [optional] |
+| **properties** | [**EventBatchInputEventProperties**](EventBatchInputEventProperties.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::EventInputEvent.new(
+  transaction_id: transaction_1234567890,
+  external_customer_id: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba,
+  external_subscription_id: sub_1234567890,
+  code: storage,
+  timestamp: 1651240791,
+  properties: null
+)
+```
+