lago_ruby 0.46.0.pre.beta

data/docs/Coupon.md

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

data/docs/CouponBaseInput.md

@@ -0,0 +1,42 @@
+# LagoAPI::CouponBaseInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the coupon. | [optional] |
+| **code** | **String** | Unique code used to identify the coupon. | [optional] |
+| **description** | **String** | Description of the coupon. | [optional] |
+| **coupon_type** | **String** | The type of the coupon. It can have two possible values: `fixed_amount` or `percentage`.  - If set to `fixed_amount`, the coupon represents a fixed amount discount. - If set to `percentage`, the coupon represents a percentage-based discount. | [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] |
+| **reusable** | **Boolean** | Indicates whether the coupon can be reused or not. If set to `true`, the coupon is reusable, meaning it can be applied multiple times to the same customer. If set to `false`, the coupon can only be used once and is not reusable. If not specified, this field is set to `true` by default. | [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. | [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] |
+| **expiration** | **String** | Specifies the type of expiration for the coupon. It can have two possible values: `time_limit` or `no_expiration`.  - If set to `time_limit`, the coupon has an expiration based on a specified time limit. - If set to `no_expiration`, the coupon does not have an expiration date and remains valid indefinitely. | [optional] |
+| **expiration_at** | **Time** | The expiration date and time of the coupon. This field is required only for coupons with `expiration` set to `time_limit`. The expiration date and time should be specified in UTC format according to the ISO 8601 datetime standard. It indicates the exact moment when the coupon will expire and is no longer valid. | [optional] |
+| **applies_to** | [**CouponBaseInputAppliesTo**](CouponBaseInputAppliesTo.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CouponBaseInput.new(
+  name: Startup Deal,
+  code: startup_deal,
+  description: I am a coupon description,
+  coupon_type: fixed_amount,
+  amount_cents: 5000,
+  amount_currency: null,
+  reusable: false,
+  percentage_rate: null,
+  frequency: recurring,
+  frequency_duration: 6,
+  expiration: time_limit,
+  expiration_at: 2022-08-08T23:59:59Z,
+  applies_to: null
+)
+```
+

data/docs/CouponBaseInputAppliesTo.md

@@ -0,0 +1,20 @@
+# LagoAPI::CouponBaseInputAppliesTo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **plan_codes** | **Array<String>** | An array of plan codes to which the coupon is applicable. By specifying the plan codes in this field, you can restrict the coupon's usage to specific plans only. | [optional] |
+| **billable_metric_codes** | **Array<String>** | An array of billable metric codes to which the coupon is applicable. By specifying the billable metric codes in this field, you can restrict the coupon's usage to specific metrics only. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CouponBaseInputAppliesTo.new(
+  plan_codes: ["startup_plan"],
+  billable_metric_codes: []
+)
+```
+

data/docs/CouponCreateInput.md

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

data/docs/CouponCreateInputCoupon.md

@@ -0,0 +1,42 @@
+# LagoAPI::CouponCreateInputCoupon
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the coupon. |  |
+| **code** | **String** | Unique code used to identify the coupon. |  |
+| **description** | **String** | Description of the coupon. | [optional] |
+| **coupon_type** | **String** | The type of the coupon. It can have two possible values: `fixed_amount` or `percentage`.  - If set to `fixed_amount`, the coupon represents a fixed amount discount. - If set to `percentage`, the coupon represents a percentage-based discount. |  |
+| **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] |
+| **reusable** | **Boolean** | Indicates whether the coupon can be reused or not. If set to `true`, the coupon is reusable, meaning it can be applied multiple times to the same customer. If set to `false`, the coupon can only be used once and is not reusable. If not specified, this field is set to `true` by default. | [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] |
+| **expiration** | **String** | Specifies the type of expiration for the coupon. It can have two possible values: `time_limit` or `no_expiration`.  - If set to `time_limit`, the coupon has an expiration based on a specified time limit. - If set to `no_expiration`, the coupon does not have an expiration date and remains valid indefinitely. | [optional] |
+| **expiration_at** | **Time** | The expiration date and time of the coupon. This field is required only for coupons with `expiration` set to `time_limit`. The expiration date and time should be specified in UTC format according to the ISO 8601 datetime standard. It indicates the exact moment when the coupon will expire and is no longer valid. | [optional] |
+| **applies_to** | [**CouponBaseInputAppliesTo**](CouponBaseInputAppliesTo.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CouponCreateInputCoupon.new(
+  name: Startup Deal,
+  code: startup_deal,
+  description: I am a coupon description,
+  coupon_type: fixed_amount,
+  amount_cents: 5000,
+  amount_currency: null,
+  reusable: false,
+  percentage_rate: null,
+  frequency: recurring,
+  frequency_duration: 6,
+  expiration: time_limit,
+  expiration_at: 2022-08-08T23:59:59Z,
+  applies_to: null
+)
+```
+

data/docs/CouponObject.md

@@ -0,0 +1,52 @@
+# LagoAPI::CouponObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | Unique identifier of the coupon, created by Lago. |  |
+| **name** | **String** | The name of the coupon. |  |
+| **code** | **String** | Unique code used to identify the coupon. |  |
+| **description** | **String** | Description of the coupon. | [optional] |
+| **coupon_type** | **String** | The type of the coupon. It can have two possible values: `fixed_amount` or `percentage`.  - If set to `fixed_amount`, the coupon represents a fixed amount discount. - If set to `percentage`, the coupon represents a percentage-based discount. |  |
+| **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] |
+| **reusable** | **Boolean** | Indicates whether the coupon can be reused or not. If set to `true`, the coupon is reusable, meaning it can be applied multiple times to the same customer. If set to `false`, the coupon can only be used once and is not reusable. If not specified, this field is set to `true` by default. |  |
+| **limited_plans** | **Boolean** | The coupon is limited to specific plans. The possible values can be `true` or `false`. |  |
+| **plan_codes** | **Array<String>** | An array of plan codes to which the coupon is applicable. By specifying the plan codes in this field, you can restrict the coupon's usage to specific plans only. | [optional] |
+| **limited_billable_metrics** | **Boolean** | The coupon is limited to specific billable metrics. The possible values can be `true` or `false`. |  |
+| **billable_metric_codes** | **Array<String>** | An array of billable metric codes to which the coupon is applicable. By specifying the billable metric codes in this field, you can restrict the coupon's usage to specific metrics only. | [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] |
+| **expiration** | **String** | Specifies the type of expiration for the coupon. It can have two possible values: `time_limit` or `no_expiration`.  - If set to `time_limit`, the coupon has an expiration based on a specified time limit. - If set to `no_expiration`, the coupon does not have an expiration date and remains valid indefinitely. |  |
+| **expiration_at** | **Time** | The expiration date and time of the coupon. This field is required only for coupons with `expiration` set to `time_limit`. The expiration date and time should be specified in UTC format according to the ISO 8601 datetime standard. It indicates the exact moment when the coupon will expire and is no longer valid. | [optional] |
+| **created_at** | **Time** | The date and time when the coupon 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 coupon was initially created. |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CouponObject.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  name: Startup Deal,
+  code: startup_deal,
+  description: I am a coupon description,
+  coupon_type: fixed_amount,
+  amount_cents: 5000,
+  amount_currency: null,
+  reusable: true,
+  limited_plans: true,
+  plan_codes: ["startup_plan"],
+  limited_billable_metrics: false,
+  billable_metric_codes: [],
+  percentage_rate: null,
+  frequency: recurring,
+  frequency_duration: 6,
+  expiration: time_limit,
+  expiration_at: 2022-08-08T23:59:59Z,
+  created_at: 2022-04-29T08:59:51Z
+)
+```
+

data/docs/CouponUpdateInput.md

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