lago_ruby 0.46.0.pre.beta

data/docs/PlansApi.md

@@ -0,0 +1,363 @@
+# LagoAPI::PlansApi
+
+All URIs are relative to *https://api.getlago.com/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_plan**](PlansApi.md#create_plan) | **POST** /plans | Create a plan |
+| [**destroy_plan**](PlansApi.md#destroy_plan) | **DELETE** /plans/{code} | Delete a plan |
+| [**find_all_plans**](PlansApi.md#find_all_plans) | **GET** /plans | List all plans |
+| [**find_plan**](PlansApi.md#find_plan) | **GET** /plans/{code} | Retrieve a plan |
+| [**update_plan**](PlansApi.md#update_plan) | **PUT** /plans/{code} | Update a plan |
+
+
+## create_plan
+
+> <Plan> create_plan(plan_create_input)
+
+Create a plan
+
+This endpoint creates a plan with subscription and usage-based charges. It supports flexible billing cadence (in-advance or in-arrears) and allows for both recurring and metered 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::PlansApi.new
+plan_create_input = LagoAPI::PlanCreateInput.new({plan: LagoAPI::PlanCreateInputPlan.new}) # PlanCreateInput | Plan payload
+
+begin
+  # Create a plan
+  result = api_instance.create_plan(plan_create_input)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling PlansApi->create_plan: #{e}"
+end
+```
+
+#### Using the create_plan_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Plan>, Integer, Hash)> create_plan_with_http_info(plan_create_input)
+
+```ruby
+begin
+  # Create a plan
+  data, status_code, headers = api_instance.create_plan_with_http_info(plan_create_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Plan>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling PlansApi->create_plan_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **plan_create_input** | [**PlanCreateInput**](PlanCreateInput.md) | Plan payload |  |
+
+### Return type
+
+[**Plan**](Plan.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## destroy_plan
+
+> <Plan> destroy_plan(code)
+
+Delete a plan
+
+This endpoint deletes a specific plan. Note that this plan could be associated with active subscriptions.
+
+### 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::PlansApi.new
+code = 'startup' # String | The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance.
+
+begin
+  # Delete a plan
+  result = api_instance.destroy_plan(code)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling PlansApi->destroy_plan: #{e}"
+end
+```
+
+#### Using the destroy_plan_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Plan>, Integer, Hash)> destroy_plan_with_http_info(code)
+
+```ruby
+begin
+  # Delete a plan
+  data, status_code, headers = api_instance.destroy_plan_with_http_info(code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Plan>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling PlansApi->destroy_plan_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance. |  |
+
+### Return type
+
+[**Plan**](Plan.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## find_all_plans
+
+> <PlansPaginated> find_all_plans(opts)
+
+List all plans
+
+This endpoint retrieves all existing plans.
+
+### 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::PlansApi.new
+opts = {
+  page: 1, # Integer | Page number.
+  per_page: 20 # Integer | Number of records per page.
+}
+
+begin
+  # List all plans
+  result = api_instance.find_all_plans(opts)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling PlansApi->find_all_plans: #{e}"
+end
+```
+
+#### Using the find_all_plans_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PlansPaginated>, Integer, Hash)> find_all_plans_with_http_info(opts)
+
+```ruby
+begin
+  # List all plans
+  data, status_code, headers = api_instance.find_all_plans_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PlansPaginated>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling PlansApi->find_all_plans_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
+
+[**PlansPaginated**](PlansPaginated.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## find_plan
+
+> <Plan> find_plan(code)
+
+Retrieve a plan
+
+This endpoint retrieves a specific plan.
+
+### 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::PlansApi.new
+code = 'startup' # String | The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance.
+
+begin
+  # Retrieve a plan
+  result = api_instance.find_plan(code)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling PlansApi->find_plan: #{e}"
+end
+```
+
+#### Using the find_plan_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Plan>, Integer, Hash)> find_plan_with_http_info(code)
+
+```ruby
+begin
+  # Retrieve a plan
+  data, status_code, headers = api_instance.find_plan_with_http_info(code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Plan>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling PlansApi->find_plan_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance. |  |
+
+### Return type
+
+[**Plan**](Plan.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_plan
+
+> <Plan> update_plan(code, plan_update_input)
+
+Update a plan
+
+This endpoint updates a specific plan with subscription and usage-based charges. It supports flexible billing cadence (in-advance or in-arrears) and allows for both recurring and metered 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::PlansApi.new
+code = 'startup' # String | The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance.
+plan_update_input = LagoAPI::PlanUpdateInput.new({plan: LagoAPI::PlanUpdateInputPlan.new}) # PlanUpdateInput | Plan payload
+
+begin
+  # Update a plan
+  result = api_instance.update_plan(code, plan_update_input)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling PlansApi->update_plan: #{e}"
+end
+```
+
+#### Using the update_plan_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Plan>, Integer, Hash)> update_plan_with_http_info(code, plan_update_input)
+
+```ruby
+begin
+  # Update a plan
+  data, status_code, headers = api_instance.update_plan_with_http_info(code, plan_update_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Plan>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling PlansApi->update_plan_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance. |  |
+| **plan_update_input** | [**PlanUpdateInput**](PlanUpdateInput.md) | Plan payload |  |
+
+### Return type
+
+[**Plan**](Plan.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/PlansPaginated.md

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

data/docs/Subscription.md

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

data/docs/SubscriptionCreateInput.md

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

data/docs/SubscriptionCreateInputSubscription.md

@@ -0,0 +1,28 @@
+# LagoAPI::SubscriptionCreateInputSubscription
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **external_customer_id** | **String** | The customer external unique identifier (provided by your own application) |  |
+| **plan_code** | **String** | The unique code representing the plan to be attached to the customer. This code must correspond to the `code` property of one of the active plans. |  |
+| **name** | **String** | The display name of the subscription on an invoice. This field allows for customization of the subscription's name for billing purposes, especially useful when a single customer has multiple subscriptions using the same plan. | [optional] |
+| **external_id** | **String** | The unique external identifier for the subscription. This identifier serves as an idempotency key, ensuring that each subscription is unique. |  |
+| **billing_time** | **String** | The billing time for the subscription, which can be set as either `anniversary` or `calendar`. If not explicitly provided, it will default to `calendar`. The billing time determines the timing of recurring billing cycles for the subscription. By specifying `anniversary`, the billing cycle will be based on the specific date the subscription started (billed fully), while `calendar` sets the billing cycle at the first day of the week/month/year (billed with proration). | [optional] |
+| **subscription_at** | **Time** | The start date for the subscription, allowing for the creation of subscriptions that can begin in the past or future. Please note that it cannot be used to update the start date of a pending subscription or schedule an upgrade/downgrade. The start_date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::SubscriptionCreateInputSubscription.new(
+  external_customer_id: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba,
+  plan_code: premium,
+  name: Repository A,
+  external_id: my_sub_1234567890,
+  billing_time: anniversary,
+  subscription_at: 2022-08-08T00:00Z
+)
+```
+

data/docs/SubscriptionObject.md

@@ -0,0 +1,48 @@
+# LagoAPI::SubscriptionObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_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_id** | **String** | The subscription external unique identifier (provided by your own application). |  |
+| **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). |  |
+| **billing_time** | **String** | The billing time for the subscription, which can be set as either `anniversary` or `calendar`. If not explicitly provided, it will default to `calendar`. The billing time determines the timing of recurring billing cycles for the subscription. By specifying `anniversary`, the billing cycle will be based on the specific date the subscription started (billed fully), while `calendar` sets the billing cycle at the first day of the week/month/year (billed with proration). |  |
+| **name** | **String** | The display name of the subscription on an invoice. This field allows for customization of the subscription's name for billing purposes, especially useful when a single customer has multiple subscriptions using the same plan. | [optional] |
+| **plan_code** | **String** | The unique code representing the plan to be attached to the customer. This code must correspond to the `code` property of one of the active plans. |  |
+| **status** | **String** | The status of the subscription, which can have the following values: - `pending`: a previous subscription has been downgraded, and the current one is awaiting automatic activation at the end of the billing period. - `active`: the subscription is currently active and applied to the customer. - `terminated`: the subscription is no longer active. - `canceled`: the subscription has been stopped before its activation. This can occur when two consecutive downgrades have been applied to a customer or when a subscription with a pending status is terminated. |  |
+| **created_at** | **Time** | The creation date of the subscription, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). This date provides a timestamp indicating when the subscription was initially created. |  |
+| **canceled_at** | **Time** | The cancellation date of the subscription. This field is not null when the subscription is `canceled`. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). | [optional] |
+| **started_at** | **Time** | The effective start date of the subscription. This field can be null if the subscription is `pending` or `canceled`. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). | [optional] |
+| **subscription_at** | **Time** | The anniversary date and time of the initial subscription. This date serves as the basis for billing subscriptions with `anniversary` billing time. The `anniversary_date` should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). |  |
+| **terminated_at** | **Time** | The termination date of the subscription. This field is not null when the subscription is `terminated`. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC) | [optional] |
+| **previous_plan_code** | **String** | The code identifying the previous plan associated with this subscription. | [optional] |
+| **next_plan_code** | **String** | The code identifying the next plan in the case of a downgrade. | [optional] |
+| **downgrade_plan_date** | **Time** | The date when the plan will be downgraded, represented in ISO 8601 date format. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::SubscriptionObject.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  external_id: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba,
+  lago_customer_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  external_customer_id: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba,
+  billing_time: anniversary,
+  name: Repository A,
+  plan_code: premium,
+  status: active,
+  created_at: 2022-08-08T00:00Z,
+  canceled_at: 2022-09-14T16:35:31Z,
+  started_at: 2022-08-08T00:00Z,
+  subscription_at: 2022-08-08T00:00Z,
+  terminated_at: 2022-09-14T16:35:31Z,
+  previous_plan_code: null,
+  next_plan_code: null,
+  downgrade_plan_date: null
+)
+```
+

data/docs/SubscriptionUpdateInput.md

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

data/docs/SubscriptionUpdateInputSubscription.md

@@ -0,0 +1,20 @@
+# LagoAPI::SubscriptionUpdateInputSubscription
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The display name of the subscription on an invoice. This field allows for customization of the subscription's name for billing purposes, especially useful when a single customer has multiple subscriptions using the same plan. | [optional] |
+| **subscription_at** | **Time** | The start date and time of the subscription. This field can only be modified for pending subscriptions that have not yet started. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::SubscriptionUpdateInputSubscription.new(
+  name: Repository B,
+  subscription_at: 2022-08-08T00:00Z
+)
+```
+