lago_ruby 0.46.0.pre.beta

data/docs/CreditNotesApi.md

@@ -0,0 +1,435 @@
+# LagoAPI::CreditNotesApi
+
+All URIs are relative to *https://api.getlago.com/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_credit_note**](CreditNotesApi.md#create_credit_note) | **POST** /credit_notes | Create a credit note |
+| [**download_credit_note**](CreditNotesApi.md#download_credit_note) | **POST** /credit_notes/{lago_id}/download | Download a credit note PDF |
+| [**find_all_credit_notes**](CreditNotesApi.md#find_all_credit_notes) | **GET** /credit_notes | List all credit notes |
+| [**find_credit_note**](CreditNotesApi.md#find_credit_note) | **GET** /credit_notes/{lago_id} | Retrieve a credit note |
+| [**update_credit_note**](CreditNotesApi.md#update_credit_note) | **PUT** /credit_notes/{lago_id} | Update a credit note |
+| [**void_credit_note**](CreditNotesApi.md#void_credit_note) | **PUT** /credit_notes/{lago_id}/void | Void a credit note |
+
+
+## create_credit_note
+
+> <CreditNote> create_credit_note(credit_note_create_input)
+
+Create a credit note
+
+This endpoint creates a new credit note.
+
+### 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::CreditNotesApi.new
+credit_note_create_input = LagoAPI::CreditNoteCreateInput.new({credit_note: LagoAPI::CreditNoteCreateInputCreditNote.new({invoice_id: '1a901a90-1a90-1a90-1a90-1a901a901a90', items: [{"fee_id": "1a901a90-1a90-1a90-1a90-1a901a901a90", "amount_cents": 10}, {"fee_id": "1a901a90-1a90-1a90-1a90-1a901a901a91", "amount_cents": 5}]})}) # CreditNoteCreateInput | Credit note payload
+
+begin
+  # Create a credit note
+  result = api_instance.create_credit_note(credit_note_create_input)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CreditNotesApi->create_credit_note: #{e}"
+end
+```
+
+#### Using the create_credit_note_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreditNote>, Integer, Hash)> create_credit_note_with_http_info(credit_note_create_input)
+
+```ruby
+begin
+  # Create a credit note
+  data, status_code, headers = api_instance.create_credit_note_with_http_info(credit_note_create_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreditNote>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CreditNotesApi->create_credit_note_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **credit_note_create_input** | [**CreditNoteCreateInput**](CreditNoteCreateInput.md) | Credit note payload |  |
+
+### Return type
+
+[**CreditNote**](CreditNote.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## download_credit_note
+
+> <CreditNote> download_credit_note(lago_id)
+
+Download a credit note PDF
+
+This endpoint downloads the PDF of an existing credit note.
+
+### 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::CreditNotesApi.new
+lago_id = '1a901a90-1a90-1a90-1a90-1a901a901a90' # String | The credit note unique identifier, created by Lago.
+
+begin
+  # Download a credit note PDF
+  result = api_instance.download_credit_note(lago_id)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CreditNotesApi->download_credit_note: #{e}"
+end
+```
+
+#### Using the download_credit_note_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreditNote>, Integer, Hash)> download_credit_note_with_http_info(lago_id)
+
+```ruby
+begin
+  # Download a credit note PDF
+  data, status_code, headers = api_instance.download_credit_note_with_http_info(lago_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreditNote>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CreditNotesApi->download_credit_note_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | The credit note unique identifier, created by Lago. |  |
+
+### Return type
+
+[**CreditNote**](CreditNote.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## find_all_credit_notes
+
+> <CreditNotes> find_all_credit_notes(opts)
+
+List all credit notes
+
+This endpoint list all existing credit notes.
+
+### 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::CreditNotesApi.new
+opts = {
+  page: 1, # Integer | Page number.
+  per_page: 20, # Integer | Number of records per page.
+  external_customer_id: '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba' # String | Unique identifier assigned to the customer in your application.
+}
+
+begin
+  # List all credit notes
+  result = api_instance.find_all_credit_notes(opts)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CreditNotesApi->find_all_credit_notes: #{e}"
+end
+```
+
+#### Using the find_all_credit_notes_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreditNotes>, Integer, Hash)> find_all_credit_notes_with_http_info(opts)
+
+```ruby
+begin
+  # List all credit notes
+  data, status_code, headers = api_instance.find_all_credit_notes_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreditNotes>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CreditNotesApi->find_all_credit_notes_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page number. | [optional] |
+| **per_page** | **Integer** | Number of records per page. | [optional] |
+| **external_customer_id** | **String** | Unique identifier assigned to the customer in your application. | [optional] |
+
+### Return type
+
+[**CreditNotes**](CreditNotes.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## find_credit_note
+
+> <CreditNote> find_credit_note(lago_id)
+
+Retrieve a credit note
+
+This endpoint retrieves an existing credit note.
+
+### 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::CreditNotesApi.new
+lago_id = '12345' # String | The credit note unique identifier, created by Lago.
+
+begin
+  # Retrieve a credit note
+  result = api_instance.find_credit_note(lago_id)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CreditNotesApi->find_credit_note: #{e}"
+end
+```
+
+#### Using the find_credit_note_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreditNote>, Integer, Hash)> find_credit_note_with_http_info(lago_id)
+
+```ruby
+begin
+  # Retrieve a credit note
+  data, status_code, headers = api_instance.find_credit_note_with_http_info(lago_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreditNote>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CreditNotesApi->find_credit_note_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | The credit note unique identifier, created by Lago. |  |
+
+### Return type
+
+[**CreditNote**](CreditNote.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_credit_note
+
+> <CreditNote> update_credit_note(lago_id, credit_note_update_input)
+
+Update a credit note
+
+This endpoint updates an existing credit note.
+
+### 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::CreditNotesApi.new
+lago_id = '12345' # String | The credit note unique identifier, created by Lago.
+credit_note_update_input = LagoAPI::CreditNoteUpdateInput.new({credit_note: LagoAPI::CreditNoteUpdateInputCreditNote.new({refund_status: 'pending'})}) # CreditNoteUpdateInput | Credit note update payload
+
+begin
+  # Update a credit note
+  result = api_instance.update_credit_note(lago_id, credit_note_update_input)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CreditNotesApi->update_credit_note: #{e}"
+end
+```
+
+#### Using the update_credit_note_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreditNote>, Integer, Hash)> update_credit_note_with_http_info(lago_id, credit_note_update_input)
+
+```ruby
+begin
+  # Update a credit note
+  data, status_code, headers = api_instance.update_credit_note_with_http_info(lago_id, credit_note_update_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreditNote>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CreditNotesApi->update_credit_note_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | The credit note unique identifier, created by Lago. |  |
+| **credit_note_update_input** | [**CreditNoteUpdateInput**](CreditNoteUpdateInput.md) | Credit note update payload |  |
+
+### Return type
+
+[**CreditNote**](CreditNote.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## void_credit_note
+
+> <CreditNote> void_credit_note(lago_id)
+
+Void a credit note
+
+This endpoint voids an existing credit note.
+
+### 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::CreditNotesApi.new
+lago_id = '1a901a90-1a90-1a90-1a90-1a901a901a90' # String | The credit note unique identifier, created by Lago.
+
+begin
+  # Void a credit note
+  result = api_instance.void_credit_note(lago_id)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CreditNotesApi->void_credit_note: #{e}"
+end
+```
+
+#### Using the void_credit_note_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreditNote>, Integer, Hash)> void_credit_note_with_http_info(lago_id)
+
+```ruby
+begin
+  # Void a credit note
+  data, status_code, headers = api_instance.void_credit_note_with_http_info(lago_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreditNote>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CreditNotesApi->void_credit_note_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | The credit note unique identifier, created by Lago. |  |
+
+### Return type
+
+[**CreditNote**](CreditNote.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CreditObject.md

@@ -0,0 +1,28 @@
+# LagoAPI::CreditObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | Unique identifier assigned to the credit within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the credit’s item record within the Lago system. |  |
+| **amount_cents** | **Integer** | The amount of credit associated with the invoice, expressed in cents. |  |
+| **amount_currency** | [**Currency**](Currency.md) |  |  |
+| **before_taxes** | **Boolean** | Indicates whether the credit is applied on the amount before taxes (coupons) or after taxes (credit notes). This flag helps determine the order in which credits are applied to the invoice calculation |  |
+| **item** | [**CreditObjectItem**](CreditObjectItem.md) |  |  |
+| **invoice** | [**CreditObjectInvoice**](CreditObjectInvoice.md) |  |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreditObject.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  amount_cents: 1200,
+  amount_currency: null,
+  before_taxes: false,
+  item: null,
+  invoice: null
+)
+```
+

data/docs/CreditObjectInvoice.md

@@ -0,0 +1,20 @@
+# LagoAPI::CreditObjectInvoice
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** |  |  |
+| **payment_status** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreditObjectInvoice.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  payment_status: succeeded
+)
+```
+

data/docs/CreditObjectItem.md

@@ -0,0 +1,24 @@
+# LagoAPI::CreditObjectItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | Unique identifier assigned to the credit item within the Lago application. |  |
+| **type** | **String** | The type of credit applied. Possible values are `coupon` or `credit_note`. |  |
+| **code** | **String** | The code of the credit applied. It can be the code of the coupon attached to the credit or the credit note's number. |  |
+| **name** | **String** | The name of the credit applied. It can be the name of the coupon attached to the credit or the initial invoice's number linked to the credit note. |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreditObjectItem.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  type: coupon,
+  code: startup_deal,
+  name: Startup Deal
+)
+```
+

data/docs/Currency.md

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

data/docs/Customer.md

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

data/docs/CustomerBillingConfiguration.md

@@ -0,0 +1,30 @@
+# LagoAPI::CustomerBillingConfiguration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invoice_grace_period** | **Integer** | The grace period, expressed in days, for the invoice. This period refers to the additional time granted to the customer beyond the invoice due date to adjust usage and line items | [optional] |
+| **payment_provider** | **String** | The payment provider utilized to initiate payments for invoices issued by Lago. Accepted values: `stripe`, `adyen`, `gocardless` or null. This field is required if you intend to assign a `provider_customer_id`. | [optional] |
+| **provider_customer_id** | **String** | The customer ID within the payment provider's system. If this field is not provided, Lago has the option to create a new customer record within the payment provider's system on behalf of the customer | [optional] |
+| **sync** | **Boolean** | Set this field to `true` if you want to create the customer in the payment provider synchronously with the customer creation process in Lago. This option is applicable only when the `provider_customer_id` is `null` and the customer is automatically created in the payment provider through Lago. By default, the value is set to `false` | [optional] |
+| **sync_with_provider** | **Boolean** | Set this field to `true` if you want to create a customer record in the payment provider's system. This option is applicable only when the `provider_customer_id` is null and the `sync_with_provider` field is set to `true`. By default, the value is set to `false` | [optional] |
+| **document_locale** | **String** | The document locale, specified in the ISO 639-1 format. This field represents the language or locale used for the documents issued by Lago | [optional] |
+| **provider_payment_methods** | **Array<String>** | Specifies the available payment methods that can be used for this customer when `payment_provider` is set to `stripe`. The `provider_payment_methods` field is an array that allows multiple payment options to be defined. If this field is not explicitly set, all the payment methods are selected. For now, possible values are `card` and `sepa_debit`. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CustomerBillingConfiguration.new(
+  invoice_grace_period: 3,
+  payment_provider: stripe,
+  provider_customer_id: cus_12345,
+  sync: true,
+  sync_with_provider: true,
+  document_locale: fr,
+  provider_payment_methods: ["card","sepa_debit"]
+)
+```
+

data/docs/CustomerChargeUsageObject.md

@@ -0,0 +1,28 @@
+# LagoAPI::CustomerChargeUsageObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **units** | **String** | The number of units consumed by the customer for a specific charge item. |  |
+| **amount_cents** | **Integer** | The amount in cents, tax excluded, consumed by the customer for a specific charge item. |  |
+| **amount_currency** | [**Currency**](Currency.md) |  |  |
+| **charge** | [**CustomerChargeUsageObjectCharge**](CustomerChargeUsageObjectCharge.md) |  |  |
+| **billable_metric** | [**CustomerChargeUsageObjectBillableMetric**](CustomerChargeUsageObjectBillableMetric.md) |  |  |
+| **groups** | [**Array<CustomerChargeUsageObjectGroupsInner>**](CustomerChargeUsageObjectGroupsInner.md) | Array of group object, representing multiple dimensions for a charge item. |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CustomerChargeUsageObject.new(
+  units: 1.0,
+  amount_cents: 123,
+  amount_currency: null,
+  charge: null,
+  billable_metric: null,
+  groups: null
+)
+```
+

data/docs/CustomerChargeUsageObjectBillableMetric.md

@@ -0,0 +1,24 @@
+# LagoAPI::CustomerChargeUsageObjectBillableMetric
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | Unique identifier assigned to the billable metric within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the billable metric’s record within the Lago system. |  |
+| **name** | **String** | The name of the billable metric used for this charge. |  |
+| **code** | **String** | The code of the billable metric used for this charge. |  |
+| **aggregation_type** | **String** | The aggregation type of the billable metric used for this charge. Possible values are `count_agg`, `sum_agg`, `max_agg` or `unique_count_agg`. |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CustomerChargeUsageObjectBillableMetric.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  name: Storage,
+  code: storage,
+  aggregation_type: sum_agg
+)
+```
+

data/docs/CustomerChargeUsageObjectCharge.md

@@ -0,0 +1,20 @@
+# LagoAPI::CustomerChargeUsageObjectCharge
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | Unique identifier assigned to the charge within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the charge’s record within the Lago system. |  |
+| **charge_model** | **String** | The pricing model applied to this charge. Possible values are standard, `graduated`, `percentage`, `package` or `volume`. |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CustomerChargeUsageObjectCharge.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  charge_model: graduated
+)
+```
+

data/docs/CustomerChargeUsageObjectGroupsInner.md

@@ -0,0 +1,26 @@
+# LagoAPI::CustomerChargeUsageObjectGroupsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | Unique identifier assigned to the group within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the group record within the Lago system. | [optional] |
+| **key** | **String** | The group key, only returned for groups with two dimensions. | [optional] |
+| **value** | **String** | The group value. | [optional] |
+| **units** | **String** | The number of units consumed for a specific group related to a charge item. | [optional] |
+| **amount_cents** | **Integer** | The amount in cents, tax excluded, consumed for a specific group related to a charge item. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CustomerChargeUsageObjectGroupsInner.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  key: null,
+  value: europe,
+  units: 0.9,
+  amount_cents: 1000
+)
+```
+

data/docs/CustomerCreateInput.md

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