lago_ruby 0.46.0.pre.beta

data/docs/CustomerCreateInputCustomer.md

@@ -0,0 +1,58 @@
+# LagoAPI::CustomerCreateInputCustomer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **external_id** | **String** | The customer external unique identifier (provided by your own application) |  |
+| **address_line1** | **String** | The first line of the billing address | [optional] |
+| **address_line2** | **String** | The second line of the billing address | [optional] |
+| **city** | **String** | The city of the customer's billing address | [optional] |
+| **country** | [**Country**](Country.md) |  | [optional] |
+| **currency** | [**Currency**](Currency.md) |  | [optional] |
+| **email** | **String** | The email of the customer | [optional] |
+| **legal_name** | **String** | The legal company name of the customer | [optional] |
+| **legal_number** | **String** | The legal company number of the customer | [optional] |
+| **logo_url** | **String** | The logo URL of the customer | [optional] |
+| **name** | **String** | The full name of the customer | [optional] |
+| **phone** | **String** | The phone number of the customer | [optional] |
+| **state** | **String** | The state of the customer's billing address | [optional] |
+| **tax_codes** | **Array<String>** | List of unique code used to identify the taxes. | [optional] |
+| **tax_identification_number** | **String** | The tax identification number of the customer | [optional] |
+| **timezone** | [**Timezone**](Timezone.md) |  | [optional] |
+| **url** | **String** | The custom website URL of the customer | [optional] |
+| **zipcode** | **String** | The zipcode of the customer's billing address | [optional] |
+| **net_payment_term** | **Integer** | The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized. | [optional] |
+| **billing_configuration** | [**CustomerBillingConfiguration**](CustomerBillingConfiguration.md) |  | [optional] |
+| **metadata** | [**Array<CustomerCreateInputCustomerMetadataInner>**](CustomerCreateInputCustomerMetadataInner.md) | Set of key-value pairs that you can attach to a customer. This can be useful for storing additional information about the customer in a structured format | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CustomerCreateInputCustomer.new(
+  external_id: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba,
+  address_line1: 5230 Penfield Ave,
+  address_line2: ,
+  city: Woodland Hills,
+  country: null,
+  currency: null,
+  email: dinesh@piedpiper.test,
+  legal_name: Coleman-Blair,
+  legal_number: 49-008-2965,
+  logo_url: http://hooli.com/logo.png,
+  name: Gavin Belson,
+  phone: 1-171-883-3711 x245,
+  state: CA,
+  tax_codes: ["french_standard_vat"],
+  tax_identification_number: EU123456789,
+  timezone: null,
+  url: http://hooli.com,
+  zipcode: 91364,
+  net_payment_term: 30,
+  billing_configuration: null,
+  metadata: null
+)
+```
+

data/docs/CustomerCreateInputCustomerMetadataInner.md

@@ -0,0 +1,24 @@
+# LagoAPI::CustomerCreateInputCustomerMetadataInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier for the metadata object, only required when updating a key-value pair | [optional] |
+| **key** | **String** | The metadata object key |  |
+| **value** | **String** | The metadata object value |  |
+| **display_in_invoice** | **Boolean** | Determines whether the item or information should be displayed in the invoice. If set to true, the item or information will be included and visible in the generated invoice. If set to false, the item or information will be excluded and not displayed in the invoice. |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CustomerCreateInputCustomerMetadataInner.new(
+  id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  key: Purchase Order,
+  value: 123456789,
+  display_in_invoice: true
+)
+```
+

data/docs/CustomerMetadata.md

@@ -0,0 +1,26 @@
+# LagoAPI::CustomerMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | A unique identifier for the customer metadata object in the Lago application. Can be used to update a key-value pair |  |
+| **key** | **String** | The metadata object key |  |
+| **value** | **String** | The metadata object value |  |
+| **display_in_invoice** | **Boolean** | Determines whether the item or information should be displayed in the invoice. If set to true, the item or information will be included and visible in the generated invoice. If set to false, the item or information will be excluded and not displayed in the invoice. |  |
+| **created_at** | **Time** | The date of the metadata object creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The creation_date provides a standardized and internationally recognized timestamp for when the metadata object was created |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CustomerMetadata.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  key: Purchase Order,
+  value: 123456789,
+  display_in_invoice: true,
+  created_at: 2022-04-29T08:59:51Z
+)
+```
+

data/docs/CustomerObject.md

@@ -0,0 +1,68 @@
+# LagoAPI::CustomerObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_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 |  |
+| **sequential_id** | **Integer** | The unique identifier assigned to the customer within the organization's scope. This identifier is used to track and reference the customer's order of creation within the organization's system. It ensures that each customer has a distinct `sequential_id`` associated with them, allowing for easy identification and sorting based on the order of creation |  |
+| **slug** | **String** | A concise and unique identifier for the customer, formed by combining the Organization's `name`, `id`, and customer's `sequential_id` |  |
+| **external_id** | **String** | The customer external unique identifier (provided by your own application) |  |
+| **address_line1** | **String** | The first line of the billing address | [optional] |
+| **address_line2** | **String** | The second line of the billing address | [optional] |
+| **applicable_timezone** | [**Timezone**](Timezone.md) |  |  |
+| **city** | **String** | The city of the customer's billing address | [optional] |
+| **country** | [**Country**](Country.md) |  | [optional] |
+| **currency** | [**Currency**](Currency.md) |  | [optional] |
+| **email** | **String** | The email of the customer | [optional] |
+| **legal_name** | **String** | The legal company name of the customer | [optional] |
+| **legal_number** | **String** | The legal company number of the customer | [optional] |
+| **logo_url** | **String** | The logo URL of the customer | [optional] |
+| **name** | **String** | The full name of the customer | [optional] |
+| **phone** | **String** | The phone number of the customer | [optional] |
+| **state** | **String** | The state of the customer's billing address | [optional] |
+| **tax_identification_number** | **String** | The tax identification number of the customer | [optional] |
+| **timezone** | [**Timezone**](Timezone.md) |  | [optional] |
+| **url** | **String** | The custom website URL of the customer | [optional] |
+| **zipcode** | **String** | The zipcode of the customer's billing address | [optional] |
+| **net_payment_term** | **Integer** | The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized. | [optional] |
+| **created_at** | **Time** | The date of the customer creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The creation_date provides a standardized and internationally recognized timestamp for when the customer object was created |  |
+| **updated_at** | **Time** | The date of the customer update, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The update_date provides a standardized and internationally recognized timestamp for when the customer object was updated | [optional] |
+| **billing_configuration** | [**CustomerBillingConfiguration**](CustomerBillingConfiguration.md) |  | [optional] |
+| **metadata** | [**Array<CustomerMetadata>**](CustomerMetadata.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CustomerObject.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  sequential_id: 1,
+  slug: LAG-1234-001,
+  external_id: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba,
+  address_line1: 5230 Penfield Ave,
+  address_line2: null,
+  applicable_timezone: null,
+  city: Woodland Hills,
+  country: null,
+  currency: null,
+  email: dinesh@piedpiper.test,
+  legal_name: Coleman-Blair,
+  legal_number: 49-008-2965,
+  logo_url: http://hooli.com/logo.png,
+  name: Gavin Belson,
+  phone: 1-171-883-3711 x245,
+  state: CA,
+  tax_identification_number: EU123456789,
+  timezone: null,
+  url: http://hooli.com,
+  zipcode: 91364,
+  net_payment_term: 30,
+  created_at: 2022-04-29T08:59:51Z,
+  updated_at: 2022-04-29T08:59:51Z,
+  billing_configuration: null,
+  metadata: null
+)
+```
+

data/docs/CustomerObjectExtended.md

@@ -0,0 +1,70 @@
+# LagoAPI::CustomerObjectExtended
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_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 |  |
+| **sequential_id** | **Integer** | The unique identifier assigned to the customer within the organization's scope. This identifier is used to track and reference the customer's order of creation within the organization's system. It ensures that each customer has a distinct `sequential_id`` associated with them, allowing for easy identification and sorting based on the order of creation |  |
+| **slug** | **String** | A concise and unique identifier for the customer, formed by combining the Organization's `name`, `id`, and customer's `sequential_id` |  |
+| **external_id** | **String** | The customer external unique identifier (provided by your own application) |  |
+| **address_line1** | **String** | The first line of the billing address | [optional] |
+| **address_line2** | **String** | The second line of the billing address | [optional] |
+| **applicable_timezone** | [**Timezone**](Timezone.md) |  |  |
+| **city** | **String** | The city of the customer's billing address | [optional] |
+| **country** | [**Country**](Country.md) |  | [optional] |
+| **currency** | [**Currency**](Currency.md) |  | [optional] |
+| **email** | **String** | The email of the customer | [optional] |
+| **legal_name** | **String** | The legal company name of the customer | [optional] |
+| **legal_number** | **String** | The legal company number of the customer | [optional] |
+| **logo_url** | **String** | The logo URL of the customer | [optional] |
+| **name** | **String** | The full name of the customer | [optional] |
+| **phone** | **String** | The phone number of the customer | [optional] |
+| **state** | **String** | The state of the customer's billing address | [optional] |
+| **tax_identification_number** | **String** | The tax identification number of the customer | [optional] |
+| **timezone** | [**Timezone**](Timezone.md) |  | [optional] |
+| **url** | **String** | The custom website URL of the customer | [optional] |
+| **zipcode** | **String** | The zipcode of the customer's billing address | [optional] |
+| **net_payment_term** | **Integer** | The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized. | [optional] |
+| **created_at** | **Time** | The date of the customer creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The creation_date provides a standardized and internationally recognized timestamp for when the customer object was created |  |
+| **updated_at** | **Time** | The date of the customer update, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The update_date provides a standardized and internationally recognized timestamp for when the customer object was updated | [optional] |
+| **billing_configuration** | [**CustomerBillingConfiguration**](CustomerBillingConfiguration.md) |  | [optional] |
+| **metadata** | [**Array<CustomerMetadata>**](CustomerMetadata.md) |  | [optional] |
+| **taxes** | [**Array<TaxObject>**](TaxObject.md) | List of customer taxes | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CustomerObjectExtended.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  sequential_id: 1,
+  slug: LAG-1234-001,
+  external_id: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba,
+  address_line1: 5230 Penfield Ave,
+  address_line2: null,
+  applicable_timezone: null,
+  city: Woodland Hills,
+  country: null,
+  currency: null,
+  email: dinesh@piedpiper.test,
+  legal_name: Coleman-Blair,
+  legal_number: 49-008-2965,
+  logo_url: http://hooli.com/logo.png,
+  name: Gavin Belson,
+  phone: 1-171-883-3711 x245,
+  state: CA,
+  tax_identification_number: EU123456789,
+  timezone: null,
+  url: http://hooli.com,
+  zipcode: 91364,
+  net_payment_term: 30,
+  created_at: 2022-04-29T08:59:51Z,
+  updated_at: 2022-04-29T08:59:51Z,
+  billing_configuration: null,
+  metadata: null,
+  taxes: null
+)
+```
+

data/docs/CustomerUsage.md

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

data/docs/CustomerUsageObject.md

@@ -0,0 +1,32 @@
+# LagoAPI::CustomerUsageObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from_datetime** | **Time** | The lower bound of the billing period, expressed in the ISO 8601 datetime format in Coordinated Universal Time (UTC). |  |
+| **to_datetime** | **Time** | The upper bound of the billing period, expressed in the ISO 8601 datetime format in Coordinated Universal Time (UTC). |  |
+| **issuing_date** | **Time** | The date of creation of the invoice. |  |
+| **currency** | [**Currency**](Currency.md) |  | [optional] |
+| **amount_cents** | **Integer** | The amount in cents, tax excluded. |  |
+| **taxes_amount_cents** | **Integer** | The tax amount in cents. |  |
+| **total_amount_cents** | **Integer** | The total amount in cents, tax included. |  |
+| **charges_usage** | [**Array<CustomerChargeUsageObject>**](CustomerChargeUsageObject.md) | Array of charges that comprise the current usage. It contains detailed information about individual charge items associated with the usage. |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CustomerUsageObject.new(
+  from_datetime: 2022-07-01T00:00Z,
+  to_datetime: 2022-07-31T23:59:59Z,
+  issuing_date: 2022-08-01T23:59:59Z,
+  currency: null,
+  amount_cents: 123,
+  taxes_amount_cents: 200,
+  total_amount_cents: 123,
+  charges_usage: null
+)
+```
+