lago_ruby 0.46.0.pre.beta

data/docs/AppliedCouponInput.md

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

data/docs/AppliedCouponInputAppliedCoupon.md

@@ -0,0 +1,30 @@
+# LagoAPI::AppliedCouponInputAppliedCoupon
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **external_customer_id** | **String** | The customer external unique identifier (provided by your own application) |  |
+| **coupon_code** | **String** | Unique code used to identify the coupon. |  |
+| **frequency** | **String** | The type of frequency for the coupon. It can have three possible values: `once`, `recurring` or `forever`.  - If set to `once`, the coupon is applicable only for a single use. - If set to `recurring`, the coupon can be used multiple times for recurring billing periods. - If set to `forever`, the coupon has unlimited usage and can be applied indefinitely. | [optional] |
+| **frequency_duration** | **Integer** | Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a `recurring` frequency type | [optional] |
+| **amount_cents** | **Integer** | The amount of the coupon in cents. This field is required only for coupon with `fixed_amount` type. | [optional] |
+| **amount_currency** | [**Currency**](Currency.md) |  | [optional] |
+| **percentage_rate** | **String** | The percentage rate of the coupon. This field is required only for coupons with a `percentage` coupon type. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::AppliedCouponInputAppliedCoupon.new(
+  external_customer_id: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba,
+  coupon_code: startup_deal,
+  frequency: recurring,
+  frequency_duration: 3,
+  amount_cents: 2000,
+  amount_currency: null,
+  percentage_rate: null
+)
+```
+

data/docs/AppliedCouponObject.md

@@ -0,0 +1,50 @@
+# LagoAPI::AppliedCouponObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | Unique identifier of the applied coupon, created by Lago. |  |
+| **lago_coupon_id** | **String** | Unique identifier of the coupon, created by Lago. |  |
+| **coupon_code** | **String** | Unique code used to identify the coupon. |  |
+| **coupon_name** | **String** | The name of the coupon. |  |
+| **lago_customer_id** | **String** | Unique identifier of the customer, created by Lago. |  |
+| **external_customer_id** | **String** | The customer external unique identifier (provided by your own application) |  |
+| **status** | **String** | The status of the coupon. Can be either `active` or `terminated`. |  |
+| **amount_cents** | **Integer** | The amount of the coupon in cents. This field is required only for coupon with `fixed_amount` type. | [optional] |
+| **amount_cents_remaining** | **Integer** | The remaining amount in cents for a `fixed_amount` coupon with a frequency set to `once`. This field indicates the remaining balance or value that can still be utilized from the coupon. | [optional] |
+| **amount_currency** | [**Currency**](Currency.md) |  | [optional] |
+| **percentage_rate** | **String** | The percentage rate of the coupon. This field is required only for coupons with a `percentage` coupon type. | [optional] |
+| **frequency** | **String** | The type of frequency for the coupon. It can have three possible values: `once`, `recurring` or `forever`.  - If set to `once`, the coupon is applicable only for a single use. - If set to `recurring`, the coupon can be used multiple times for recurring billing periods. - If set to `forever`, the coupon has unlimited usage and can be applied indefinitely. |  |
+| **frequency_duration** | **Integer** | Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a `recurring` frequency type | [optional] |
+| **frequency_duration_remaining** | **Integer** | The remaining number of billing periods to which the coupon is applicable. This field determines the remaining usage or availability of the coupon based on the remaining billing periods. | [optional] |
+| **expiration_at** | **Time** | The date and time after which the coupon will stop applying to customer's invoices. Once the expiration date is reached, the coupon will no longer be applicable, and any further invoices generated for the customer will not include the coupon discount. | [optional] |
+| **created_at** | **Time** | The date and time when the coupon was assigned to a customer. It is expressed in UTC format according to the ISO 8601 datetime standard. |  |
+| **terminated_at** | **Time** | This field indicates the specific moment when the coupon amount is fully utilized or when the coupon is removed from the customer's coupon list. It is expressed in UTC format according to the ISO 8601 datetime standard. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::AppliedCouponObject.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  lago_coupon_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  coupon_code: startup_deal,
+  coupon_name: Startup Deal,
+  lago_customer_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  external_customer_id: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba,
+  status: active,
+  amount_cents: 2000,
+  amount_cents_remaining: 50,
+  amount_currency: null,
+  percentage_rate: null,
+  frequency: recurring,
+  frequency_duration: 3,
+  frequency_duration_remaining: 1,
+  expiration_at: 2022-04-29T08:59:51Z,
+  created_at: 2022-04-29T08:59:51Z,
+  terminated_at: 2022-04-29T08:59:51Z
+)
+```
+

data/docs/AppliedCouponObjectExtended.md

@@ -0,0 +1,52 @@
+# LagoAPI::AppliedCouponObjectExtended
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | Unique identifier of the applied coupon, created by Lago. |  |
+| **lago_coupon_id** | **String** | Unique identifier of the coupon, created by Lago. |  |
+| **coupon_code** | **String** | Unique code used to identify the coupon. |  |
+| **coupon_name** | **String** | The name of the coupon. |  |
+| **lago_customer_id** | **String** | Unique identifier of the customer, created by Lago. |  |
+| **external_customer_id** | **String** | The customer external unique identifier (provided by your own application) |  |
+| **status** | **String** | The status of the coupon. Can be either `active` or `terminated`. |  |
+| **amount_cents** | **Integer** | The amount of the coupon in cents. This field is required only for coupon with `fixed_amount` type. | [optional] |
+| **amount_cents_remaining** | **Integer** | The remaining amount in cents for a `fixed_amount` coupon with a frequency set to `once`. This field indicates the remaining balance or value that can still be utilized from the coupon. | [optional] |
+| **amount_currency** | [**Currency**](Currency.md) |  | [optional] |
+| **percentage_rate** | **String** | The percentage rate of the coupon. This field is required only for coupons with a `percentage` coupon type. | [optional] |
+| **frequency** | **String** | The type of frequency for the coupon. It can have three possible values: `once`, `recurring` or `forever`.  - If set to `once`, the coupon is applicable only for a single use. - If set to `recurring`, the coupon can be used multiple times for recurring billing periods. - If set to `forever`, the coupon has unlimited usage and can be applied indefinitely. |  |
+| **frequency_duration** | **Integer** | Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a `recurring` frequency type | [optional] |
+| **frequency_duration_remaining** | **Integer** | The remaining number of billing periods to which the coupon is applicable. This field determines the remaining usage or availability of the coupon based on the remaining billing periods. | [optional] |
+| **expiration_at** | **Time** | The date and time after which the coupon will stop applying to customer's invoices. Once the expiration date is reached, the coupon will no longer be applicable, and any further invoices generated for the customer will not include the coupon discount. | [optional] |
+| **created_at** | **Time** | The date and time when the coupon was assigned to a customer. It is expressed in UTC format according to the ISO 8601 datetime standard. |  |
+| **terminated_at** | **Time** | This field indicates the specific moment when the coupon amount is fully utilized or when the coupon is removed from the customer's coupon list. It is expressed in UTC format according to the ISO 8601 datetime standard. | [optional] |
+| **credits** | [**Array<CreditObject>**](CreditObject.md) |  |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::AppliedCouponObjectExtended.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  lago_coupon_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  coupon_code: startup_deal,
+  coupon_name: Startup Deal,
+  lago_customer_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  external_customer_id: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba,
+  status: active,
+  amount_cents: 2000,
+  amount_cents_remaining: 50,
+  amount_currency: null,
+  percentage_rate: null,
+  frequency: recurring,
+  frequency_duration: 3,
+  frequency_duration_remaining: 1,
+  expiration_at: 2022-04-29T08:59:51Z,
+  created_at: 2022-04-29T08:59:51Z,
+  terminated_at: 2022-04-29T08:59:51Z,
+  credits: null
+)
+```
+

data/docs/AppliedCouponsPaginated.md

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

data/docs/BaseAppliedTax.md

@@ -0,0 +1,34 @@
+# LagoAPI::BaseAppliedTax
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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::BaseAppliedTax.new(
+  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/BillableMetric.md

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

data/docs/BillableMetricBaseInput.md

@@ -0,0 +1,30 @@
+# LagoAPI::BillableMetricBaseInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the billable metric. | [optional] |
+| **code** | **String** | Unique code used to identify the billable metric associated with the API request. This code associates each event with the correct metric. | [optional] |
+| **description** | **String** | Internal description of the billable metric. | [optional] |
+| **recurring** | **Boolean** | Defines if the billable metric is persisted billing period over billing period.  - If set to `true`: the accumulated number of units calculated from the previous billing period is persisted to the next billing period. - If set to `false`: the accumulated number of units is reset to 0 at the end of the billing period. - If not defined in the request, default value is `false`. | [optional] |
+| **field_name** | **String** | Property of the billable metric used for aggregating usage data. This field is not required for `count_agg`. | [optional] |
+| **aggregation_type** | **String** | Aggregation method used to compute usage for this billable metric. Possible values are `count_agg`, `sum_agg`, `max_agg` or `unique_count_agg`. | [optional] |
+| **group** | [**BillableMetricGroup**](BillableMetricGroup.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::BillableMetricBaseInput.new(
+  name: Storage,
+  code: storage,
+  description: GB of storage used in my application,
+  recurring: false,
+  field_name: gb,
+  aggregation_type: sum_agg,
+  group: null
+)
+```
+

data/docs/BillableMetricCreateInput.md

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

data/docs/BillableMetricCreateInputBillableMetric.md

@@ -0,0 +1,30 @@
+# LagoAPI::BillableMetricCreateInputBillableMetric
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the billable metric. |  |
+| **code** | **String** | Unique code used to identify the billable metric associated with the API request. This code associates each event with the correct metric. |  |
+| **description** | **String** | Internal description of the billable metric. | [optional] |
+| **recurring** | **Boolean** | Defines if the billable metric is persisted billing period over billing period.  - If set to `true`: the accumulated number of units calculated from the previous billing period is persisted to the next billing period. - If set to `false`: the accumulated number of units is reset to 0 at the end of the billing period. - If not defined in the request, default value is `false`. | [optional] |
+| **field_name** | **String** | Property of the billable metric used for aggregating usage data. This field is not required for `count_agg`. | [optional] |
+| **aggregation_type** | **String** | Aggregation method used to compute usage for this billable metric. Possible values are `count_agg`, `sum_agg`, `max_agg` or `unique_count_agg`. |  |
+| **group** | [**BillableMetricGroup**](BillableMetricGroup.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::BillableMetricCreateInputBillableMetric.new(
+  name: Storage,
+  code: storage,
+  description: GB of storage used in my application,
+  recurring: false,
+  field_name: gb,
+  aggregation_type: sum_agg,
+  group: null
+)
+```
+

data/docs/BillableMetricGroup.md

@@ -0,0 +1,20 @@
+# LagoAPI::BillableMetricGroup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | Name of the event property used to group values. |  |
+| **values** | [**Array<BillableMetricGroupValuesInner>**](BillableMetricGroupValuesInner.md) | Array of strings or objects representing all possible values. |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::BillableMetricGroup.new(
+  key: region,
+  values: ["us-east-1","us-east-2","eu-west-1"]
+)
+```
+

data/docs/BillableMetricGroupValuesInner.md

@@ -0,0 +1,49 @@
+# LagoAPI::BillableMetricGroupValuesInner
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'lago_ruby'
+
+LagoAPI::BillableMetricGroupValuesInner.openapi_one_of
+# =>
+# [
+#   :'BillableMetricGroupValuesInnerOneOf',
+#   :'String'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'lago_ruby'
+
+LagoAPI::BillableMetricGroupValuesInner.build(data)
+# => #<BillableMetricGroupValuesInnerOneOf:0x00007fdd4aab02a0>
+
+LagoAPI::BillableMetricGroupValuesInner.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `BillableMetricGroupValuesInnerOneOf`
+- `String`
+- `nil` (if no type matches)
+

data/docs/BillableMetricGroupValuesInnerOneOf.md

@@ -0,0 +1,20 @@
+# LagoAPI::BillableMetricGroupValuesInnerOneOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | Name of the event property used to group values. |  |
+| **values** | **Array<String>** | Array of strings representing all possible values. |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::BillableMetricGroupValuesInnerOneOf.new(
+  key: region,
+  values: ["us-east-1","us-east-2","eu-west-1"]
+)
+```
+

data/docs/BillableMetricObject.md

@@ -0,0 +1,40 @@
+# LagoAPI::BillableMetricObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | Unique identifier of the billable metric created by Lago. |  |
+| **name** | **String** | Name of the billable metric. |  |
+| **code** | **String** | Unique code used to identify the billable metric associated with the API request. This code associates each event with the correct metric. |  |
+| **description** | **String** | Internal description of the billable metric. | [optional] |
+| **recurring** | **Boolean** | Defines if the billable metric is persisted billing period over billing period.  - If set to `true`: the accumulated number of units calculated from the previous billing period is persisted to the next billing period. - If set to `false`: the accumulated number of units is reset to 0 at the end of the billing period. - If not defined in the request, default value is `false`. |  |
+| **created_at** | **Time** | Creation date of the billable metric. |  |
+| **field_name** | **String** | Property of the billable metric used for aggregating usage data. This field is not required for `count_agg`. | [optional] |
+| **aggregation_type** | **String** | Aggregation method used to compute usage for this billable metric. Possible values are `count_agg`, `sum_agg`, `max_agg` or `unique_count_agg`. |  |
+| **group** | [**BillableMetricGroup**](BillableMetricGroup.md) |  | [optional] |
+| **active_subscriptions_count** | **Integer** | Number of active subscriptions using this billable metric. |  |
+| **draft_invoices_count** | **Integer** | Number of draft invoices for which this billable metric is listed as an invoice item. |  |
+| **plans_count** | **Integer** | Number of plans using this billable metric. |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::BillableMetricObject.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  name: Storage,
+  code: storage,
+  description: GB of storage used in my application,
+  recurring: false,
+  created_at: 2022-09-14T16:35:31Z,
+  field_name: gb,
+  aggregation_type: sum_agg,
+  group: null,
+  active_subscriptions_count: 4,
+  draft_invoices_count: 10,
+  plans_count: 4
+)
+```
+

data/docs/BillableMetricUpdateInput.md

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