lago_ruby 0.49.0.pre.beta → 0.51.0.pre.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23e57e890bfe8c0b19773bcb8eb4923fc46a1aa0abb5787074fda52d7fdd344b
-  data.tar.gz: 3ff0bd599f9260095aa49eacc114b4f2570532142033ab1273213de4fb21aabb
+  metadata.gz: 8ee5d8ada117e17d202e6d6387b05da9fd389b8af53af0421f884badbcd7b252
+  data.tar.gz: ddd36fe3358d8ebc558e6b63bc59cfe5a7f98dee008fdb2487adcc309e1cf151
 SHA512:
-  metadata.gz: c542123cabbf5f5f652526fadeaae108f92c08eca199a1fed15749fcd4d83f75b28bc13ed30b4919dfe84f1376ff74e50221ef2435adef570484c42eb339657b
-  data.tar.gz: e9c14cebd5062a44286c1b8fc94377d729392cd8d9bac89ee18461d5e1477a96603fb380d1f765b45081b6ca406ce755180d980de4e9be53e0c559fea82807fd
+  metadata.gz: ab5f789b2fde9cc7db29c750862486a78af93fe5e8d1eff22dfb4bec076daa1b29b9e73c7b8679a3c932b81c51fb799cd45641b5a8a356b8f7540aafaf260842
+  data.tar.gz: ad643f65be23fa1f37d4b89561cad644d3443fc9e88e07e7d114f6b339c7b03edb88c7cd78d4b3c82f2cd545a870d43bb618c6eea1afbf0f84af78aa7037fb10

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lago_ruby (0.48.0.pre.beta)
+    lago_ruby (0.51.0.pre.beta)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -13,7 +13,7 @@ GEM
     diff-lcs (1.5.0)
     ethon (0.16.0)
       ffi (>= 1.15.0)
-    ffi (1.15.5)
+    ffi (1.16.3)
     jaro_winkler (1.5.6)
     method_source (1.0.0)
     parallel (1.23.0)

data/README.md

@@ -6,8 +6,8 @@ Lago API allows your application to push customer information and metrics (event
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 0.49.0-beta
-- Package version: 0.49.0-beta
+- API version: 0.51.0-beta
+- Package version: 0.51.0-beta
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 [![Gem Version](https://badge.fury.io/rb/lago-ruby.svg)](https://badge.fury.io/rb/lago-ruby)
@@ -26,16 +26,16 @@ gem build lago_ruby.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./lago_ruby-0.49.0-beta.gem
+gem install ./lago_ruby-0.51.0-beta.gem
 ```
 
-(for development, run `gem install --dev ./lago_ruby-0.49.0-beta.gem` to install the development dependencies)
+(for development, run `gem install --dev ./lago_ruby-0.51.0-beta.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'lago_ruby', '~> 0.49.0-beta'
+    gem 'lago_ruby', '~> 0.51.0-beta'
 
 ### Install from Git
 
@@ -109,6 +109,7 @@ Class | Method | HTTP request | Description
 *LagoAPI::CouponsApi* | [**update_coupon**](docs/CouponsApi.md#update_coupon) | **PUT** /coupons/{code} | Update a coupon
 *LagoAPI::CreditNotesApi* | [**create_credit_note**](docs/CreditNotesApi.md#create_credit_note) | **POST** /credit_notes | Create a credit note
 *LagoAPI::CreditNotesApi* | [**download_credit_note**](docs/CreditNotesApi.md#download_credit_note) | **POST** /credit_notes/{lago_id}/download | Download a credit note PDF
+*LagoAPI::CreditNotesApi* | [**estimate_credit_note**](docs/CreditNotesApi.md#estimate_credit_note) | **POST** /credit_notes/estimate | Estimate amounts for a new credit note
 *LagoAPI::CreditNotesApi* | [**find_all_credit_notes**](docs/CreditNotesApi.md#find_all_credit_notes) | **GET** /credit_notes | List all credit notes
 *LagoAPI::CreditNotesApi* | [**find_credit_note**](docs/CreditNotesApi.md#find_credit_note) | **GET** /credit_notes/{lago_id} | Retrieve a credit note
 *LagoAPI::CreditNotesApi* | [**update_credit_note**](docs/CreditNotesApi.md#update_credit_note) | **PUT** /credit_notes/{lago_id} | Update a credit note
@@ -218,7 +219,13 @@ Class | Method | HTTP request | Description
  - [LagoAPI::CreditNoteAppliedTaxObject](docs/CreditNoteAppliedTaxObject.md)
  - [LagoAPI::CreditNoteCreateInput](docs/CreditNoteCreateInput.md)
  - [LagoAPI::CreditNoteCreateInputCreditNote](docs/CreditNoteCreateInputCreditNote.md)
- - [LagoAPI::CreditNoteCreateInputCreditNoteItemsInner](docs/CreditNoteCreateInputCreditNoteItemsInner.md)
+ - [LagoAPI::CreditNoteEstimateInput](docs/CreditNoteEstimateInput.md)
+ - [LagoAPI::CreditNoteEstimateInputCreditNote](docs/CreditNoteEstimateInputCreditNote.md)
+ - [LagoAPI::CreditNoteEstimateInputCreditNoteItemsInner](docs/CreditNoteEstimateInputCreditNoteItemsInner.md)
+ - [LagoAPI::CreditNoteEstimated](docs/CreditNoteEstimated.md)
+ - [LagoAPI::CreditNoteEstimatedEstimatedCreditNote](docs/CreditNoteEstimatedEstimatedCreditNote.md)
+ - [LagoAPI::CreditNoteEstimatedEstimatedCreditNoteAppliedTaxesInner](docs/CreditNoteEstimatedEstimatedCreditNoteAppliedTaxesInner.md)
+ - [LagoAPI::CreditNoteEstimatedEstimatedCreditNoteItemsInner](docs/CreditNoteEstimatedEstimatedCreditNoteItemsInner.md)
  - [LagoAPI::CreditNoteItemObject](docs/CreditNoteItemObject.md)
  - [LagoAPI::CreditNoteItemObjectFee](docs/CreditNoteItemObjectFee.md)
  - [LagoAPI::CreditNoteObject](docs/CreditNoteObject.md)
@@ -295,6 +302,8 @@ Class | Method | HTTP request | Description
  - [LagoAPI::PlanCreateInputPlanChargesInner](docs/PlanCreateInputPlanChargesInner.md)
  - [LagoAPI::PlanCreateInputPlanChargesInnerGroupPropertiesInner](docs/PlanCreateInputPlanChargesInnerGroupPropertiesInner.md)
  - [LagoAPI::PlanObject](docs/PlanObject.md)
+ - [LagoAPI::PlanOverridesObject](docs/PlanOverridesObject.md)
+ - [LagoAPI::PlanOverridesObjectChargesInner](docs/PlanOverridesObjectChargesInner.md)
  - [LagoAPI::PlanUpdateInput](docs/PlanUpdateInput.md)
  - [LagoAPI::PlanUpdateInputPlan](docs/PlanUpdateInputPlan.md)
  - [LagoAPI::PlanUpdateInputPlanChargesInner](docs/PlanUpdateInputPlanChargesInner.md)
@@ -303,6 +312,7 @@ Class | Method | HTTP request | Description
  - [LagoAPI::SubscriptionCreateInput](docs/SubscriptionCreateInput.md)
  - [LagoAPI::SubscriptionCreateInputSubscription](docs/SubscriptionCreateInputSubscription.md)
  - [LagoAPI::SubscriptionObject](docs/SubscriptionObject.md)
+ - [LagoAPI::SubscriptionObjectExtended](docs/SubscriptionObjectExtended.md)
  - [LagoAPI::SubscriptionUpdateInput](docs/SubscriptionUpdateInput.md)
  - [LagoAPI::SubscriptionUpdateInputSubscription](docs/SubscriptionUpdateInputSubscription.md)
  - [LagoAPI::SubscriptionsPaginated](docs/SubscriptionsPaginated.md)

data/docs/CreditNoteCreateInputCreditNote.md

@@ -9,7 +9,7 @@
 | **description** | **String** | The description of the credit note. | [optional] |
 | **credit_amount_cents** | **Integer** | The total amount to be credited on the customer balance. | [optional] |
 | **refund_amount_cents** | **Integer** | The total amount to be refunded to the customer. | [optional] |
-| **items** | [**Array<CreditNoteCreateInputCreditNoteItemsInner>**](CreditNoteCreateInputCreditNoteItemsInner.md) | The list of credit note’s items. |  |
+| **items** | [**Array<CreditNoteEstimateInputCreditNoteItemsInner>**](CreditNoteEstimateInputCreditNoteItemsInner.md) | The list of credit note’s items. |  |
 
 ## Example
 

data/docs/CreditNoteEstimateInput.md

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

data/docs/CreditNoteEstimateInputCreditNote.md

@@ -0,0 +1,20 @@
+# LagoAPI::CreditNoteEstimateInputCreditNote
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invoice_id** | **String** | The invoice unique identifier, created by Lago. |  |
+| **items** | [**Array<CreditNoteEstimateInputCreditNoteItemsInner>**](CreditNoteEstimateInputCreditNoteItemsInner.md) | The list of credit note’s items. |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreditNoteEstimateInputCreditNote.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}]
+)
+```
+

data/docs/CreditNoteEstimateInputCreditNoteItemsInner.md

@@ -0,0 +1,20 @@
+# LagoAPI::CreditNoteEstimateInputCreditNoteItemsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fee_id** | **String** | The fee unique identifier, created by Lago. |  |
+| **amount_cents** | **Integer** | The amount of the credit note item, expressed in cents. |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreditNoteEstimateInputCreditNoteItemsInner.new(
+  fee_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  amount_cents: 10
+)
+```
+

data/docs/CreditNoteEstimated.md

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

data/docs/CreditNoteEstimatedEstimatedCreditNote.md

@@ -0,0 +1,38 @@
+# LagoAPI::CreditNoteEstimatedEstimatedCreditNote
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_invoice_id** | **String** | Unique identifier assigned to the invoice that the credit note belongs to |  |
+| **invoice_number** | **String** | The invoice unique number, related to the credit note. |  |
+| **currency** | [**Currency**](Currency.md) |  |  |
+| **taxes_amount_cents** | **Integer** | The tax amount of the credit note, expressed in cents. |  |
+| **taxes_rate** | **Float** | The tax rate associated with this specific credit note. |  |
+| **sub_total_excluding_taxes_amount_cents** | **Integer** | The subtotal of the credit note excluding any applicable taxes, expressed in cents. |  |
+| **max_creditable_amount_cents** | **Integer** | The credited amount of the credit note, expressed in cents. |  |
+| **max_refundable_amount_cents** | **Integer** | The refunded amount of the credit note, expressed in cents. |  |
+| **coupons_adjustment_amount_cents** | **Integer** | The pro-rated amount of the coupons applied to the source invoice. |  |
+| **items** | [**Array<CreditNoteEstimatedEstimatedCreditNoteItemsInner>**](CreditNoteEstimatedEstimatedCreditNoteItemsInner.md) | Array of credit note’s items. |  |
+| **applied_taxes** | [**Array<CreditNoteEstimatedEstimatedCreditNoteAppliedTaxesInner>**](CreditNoteEstimatedEstimatedCreditNoteAppliedTaxesInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreditNoteEstimatedEstimatedCreditNote.new(
+  lago_invoice_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  invoice_number: LAG-1234,
+  currency: null,
+  taxes_amount_cents: 20,
+  taxes_rate: 20,
+  sub_total_excluding_taxes_amount_cents: 100,
+  max_creditable_amount_cents: 100,
+  max_refundable_amount_cents: 0,
+  coupons_adjustment_amount_cents: 20,
+  items: null,
+  applied_taxes: null
+)
+```
+

data/docs/CreditNoteEstimatedEstimatedCreditNoteAppliedTaxesInner.md

@@ -0,0 +1,32 @@
+# LagoAPI::CreditNoteEstimatedEstimatedCreditNoteAppliedTaxesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **base_amount_cents** | **Integer** |  | [optional] |
+| **amount_cents** | **Integer** | Amount of the tax | [optional] |
+| **amount_currency** | [**Currency**](Currency.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreditNoteEstimatedEstimatedCreditNoteAppliedTaxesInner.new(
+  lago_tax_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  tax_name: TVA,
+  tax_code: french_standard_vat,
+  tax_rate: 20,
+  tax_description: French standard VAT,
+  base_amount_cents: 100,
+  amount_cents: 2000,
+  amount_currency: null
+)
+```
+

data/docs/CreditNoteEstimatedEstimatedCreditNoteItemsInner.md

@@ -0,0 +1,20 @@
+# LagoAPI::CreditNoteEstimatedEstimatedCreditNoteItemsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount_cents** | **Integer** | The credit note’s item amount, expressed in cents. |  |
+| **lago_fee_id** | **String** | Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee’s record within the Lago system. |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreditNoteEstimatedEstimatedCreditNoteItemsInner.new(
+  amount_cents: 100,
+  lago_fee_id: 1a901a90-1a90-1a90-1a90-1a901a901a90
+)
+```
+

data/docs/CreditNoteItemObjectFee.md

@@ -19,6 +19,7 @@
 | **taxes_amount_cents** | **Integer** | The cost of the tax associated with this specific fee. |  |
 | **taxes_rate** | **Float** | The tax rate associated with this specific fee. |  |
 | **units** | **String** | The number of units used to charge the customer. This field indicates the quantity or count of units consumed or utilized in the context of the charge. It helps in determining the basis for calculating the fee or cost associated with the usage of the service or product provided to the customer. |  |
+| **precise_unit_amount** | **String** | The unit amount of the fee per unit, with precision. |  |
 | **total_amount_cents** | **Integer** | The cost of this specific fee, including any applicable taxes. |  |
 | **total_amount_currency** | [**Currency**](Currency.md) |  |  |
 | **events_count** | **Integer** | The number of events that have been sent and used to charge the customer. This field indicates the count or quantity of events that have been processed and considered in the charging process. | [optional] |
@@ -56,6 +57,7 @@ instance = LagoAPI::CreditNoteItemObjectFee.new(
   taxes_amount_cents: 20,
   taxes_rate: 20,
   units: 0.32,
+  precise_unit_amount: 312.5,
   total_amount_cents: 120,
   total_amount_currency: null,
   events_count: 23,

data/docs/CreditNoteObject.md

@@ -22,7 +22,7 @@
 | **balance_amount_cents** | **Integer** | The remaining credit note amount, expressed in cents. |  |
 | **credit_amount_cents** | **Integer** | The credited amount of the credit note, expressed in cents. |  |
 | **refund_amount_cents** | **Integer** | The refunded amount of the credit note, expressed in cents. |  |
-| **coupons_adjustement_amount_cents** | **Integer** | The pro-rated amount of the coupons applied to the source invoice. |  |
+| **coupons_adjustment_amount_cents** | **Integer** | The pro-rated amount of the coupons applied to the source invoice. |  |
 | **created_at** | **Time** | The date when the credit note was created. It is expressed in Coordinated Universal Time (UTC). |  |
 | **updated_at** | **Time** | The date when the credit note was last updated. It is expressed in Coordinated Universal Time (UTC). |  |
 | **file_url** | **String** | The PDF file of the credit note. | [optional] |
@@ -53,7 +53,7 @@ instance = LagoAPI::CreditNoteObject.new(
   balance_amount_cents: 100,
   credit_amount_cents: 100,
   refund_amount_cents: 0,
-  coupons_adjustement_amount_cents: 20,
+  coupons_adjustment_amount_cents: 20,
   created_at: 2022-09-14T16:35:31Z,
   updated_at: 2022-09-14T16:35:31Z,
   file_url: https://getlago.com/credit_note/file,

data/docs/CreditNotesApi.md

@@ -6,6 +6,7 @@ All URIs are relative to *https://api.getlago.com/api/v1*
 | ------ | ------------ | ----------- |
 | [**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 |
+| [**estimate_credit_note**](CreditNotesApi.md#estimate_credit_note) | **POST** /credit_notes/estimate | Estimate amounts for a new credit note |
 | [**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 |
@@ -150,6 +151,77 @@ end
 - **Accept**: application/json
 
 
+## estimate_credit_note
+
+> <CreditNoteEstimated> estimate_credit_note(opts)
+
+Estimate amounts for a new credit note
+
+This endpoint allows you to retrieve amounts for a new credit note creation.
+
+### 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 = {
+  credit_note_estimate_input: LagoAPI::CreditNoteEstimateInput.new({credit_note: LagoAPI::CreditNoteEstimateInputCreditNote.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}]})}) # CreditNoteEstimateInput | Credit note estimate payload
+}
+
+begin
+  # Estimate amounts for a new credit note
+  result = api_instance.estimate_credit_note(opts)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CreditNotesApi->estimate_credit_note: #{e}"
+end
+```
+
+#### Using the estimate_credit_note_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreditNoteEstimated>, Integer, Hash)> estimate_credit_note_with_http_info(opts)
+
+```ruby
+begin
+  # Estimate amounts for a new credit note
+  data, status_code, headers = api_instance.estimate_credit_note_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreditNoteEstimated>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CreditNotesApi->estimate_credit_note_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **credit_note_estimate_input** | [**CreditNoteEstimateInput**](CreditNoteEstimateInput.md) | Credit note estimate payload | [optional] |
+
+### Return type
+
+[**CreditNoteEstimated**](CreditNoteEstimated.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## find_all_credit_notes
 
 > <CreditNotes> find_all_credit_notes(opts)

data/docs/EventsApi.md

@@ -80,7 +80,7 @@ nil (empty response body)
 
 ## create_event
 
-> create_event(event_input)
+> <Event> create_event(event_input)
 
 Send usage events
 
@@ -102,7 +102,8 @@ event_input = LagoAPI::EventInput.new({event: LagoAPI::EventInputEvent.new({tran
 
 begin
   # Send usage events
-  api_instance.create_event(event_input)
+  result = api_instance.create_event(event_input)
+  p result
 rescue LagoAPI::ApiError => e
   puts "Error when calling EventsApi->create_event: #{e}"
 end
@@ -110,9 +111,9 @@ end
 
 #### Using the create_event_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> create_event_with_http_info(event_input)
+> <Array(<Event>, Integer, Hash)> create_event_with_http_info(event_input)
 
 ```ruby
 begin
@@ -120,7 +121,7 @@ begin
   data, status_code, headers = api_instance.create_event_with_http_info(event_input)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <Event>
 rescue LagoAPI::ApiError => e
   puts "Error when calling EventsApi->create_event_with_http_info: #{e}"
 end
@@ -134,7 +135,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**Event**](Event.md)
 
 ### Authorization
 

data/docs/FeeObject.md

@@ -19,6 +19,7 @@
 | **taxes_amount_cents** | **Integer** | The cost of the tax associated with this specific fee. |  |
 | **taxes_rate** | **Float** | The tax rate associated with this specific fee. |  |
 | **units** | **String** | The number of units used to charge the customer. This field indicates the quantity or count of units consumed or utilized in the context of the charge. It helps in determining the basis for calculating the fee or cost associated with the usage of the service or product provided to the customer. |  |
+| **precise_unit_amount** | **String** | The unit amount of the fee per unit, with precision. |  |
 | **total_amount_cents** | **Integer** | The cost of this specific fee, including any applicable taxes. |  |
 | **total_amount_currency** | [**Currency**](Currency.md) |  |  |
 | **events_count** | **Integer** | The number of events that have been sent and used to charge the customer. This field indicates the count or quantity of events that have been processed and considered in the charging process. | [optional] |
@@ -56,6 +57,7 @@ instance = LagoAPI::FeeObject.new(
   taxes_amount_cents: 20,
   taxes_rate: 20,
   units: 0.32,
+  precise_unit_amount: 312.5,
   total_amount_cents: 120,
   total_amount_currency: null,
   events_count: 23,

data/docs/FeeObjectItem.md

@@ -8,6 +8,7 @@
 | **code** | **String** | The code of the fee item. It can be the code of the `add-o`n, the code of the `charge`, the code of the `credit` or the code of the `subscription`. |  |
 | **name** | **String** | The name of the fee item. It can be the name of the `add-on`, the name of the `charge`, the name of the `credit` or the name of the `subscription`. |  |
 | **invoice_display_name** | **String** | Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name. | [optional] |
+| **group_invoice_display_name** | **String** | Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name. | [optional] |
 | **lago_item_id** | **String** | Unique identifier of the fee item, created by Lago. It can be the identifier of the `add-on`, the identifier of the `charge`, the identifier of the `credit` or the identifier of the `subscription`. |  |
 | **item_type** | **String** | The type of the fee item. Possible values are `AddOn`, `BillableMetric`, `WalletTransaction` or `Subscription`. |  |
 
@@ -21,6 +22,7 @@ instance = LagoAPI::FeeObjectItem.new(
   code: startup,
   name: Startup,
   invoice_display_name: Setup Fee (SF1),
+  group_invoice_display_name: Transactions - ACH,
   lago_item_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
   item_type: Subscription
 )

data/docs/PlanOverridesObject.md

@@ -0,0 +1,32 @@
+# LagoAPI::PlanOverridesObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount_cents** | **Integer** | The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan. | [optional] |
+| **amount_currency** | [**Currency**](Currency.md) |  | [optional] |
+| **description** | **String** | The description on the plan. | [optional] |
+| **invoice_display_name** | **String** | Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the plan will be used as the default display name. | [optional] |
+| **name** | **String** | The name of the plan. | [optional] |
+| **tax_codes** | **Array<String>** | List of unique code used to identify the taxes. | [optional] |
+| **trial_period** | **Float** | The duration in days during which the base cost of the plan is offered for free. | [optional] |
+| **charges** | [**Array<PlanOverridesObjectChargesInner>**](PlanOverridesObjectChargesInner.md) | Additional usage-based charges for this plan. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::PlanOverridesObject.new(
+  amount_cents: 10000,
+  amount_currency: null,
+  description: Plan for early stage startups.,
+  invoice_display_name: Startup plan,
+  name: Startup,
+  tax_codes: ["french_standard_vat"],
+  trial_period: 5,
+  charges: null
+)
+```
+

data/docs/PlanOverridesObjectChargesInner.md

@@ -0,0 +1,28 @@
+# LagoAPI::PlanOverridesObjectChargesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier of the charge created by Lago. | [optional] |
+| **invoice_display_name** | **String** | Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name. | [optional] |
+| **min_amount_cents** | **Integer** | The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period. | [optional] |
+| **properties** | [**ChargeObjectProperties**](ChargeObjectProperties.md) |  | [optional] |
+| **group_properties** | [**Array<PlanCreateInputPlanChargesInnerGroupPropertiesInner>**](PlanCreateInputPlanChargesInnerGroupPropertiesInner.md) | All charge information, sorted by groups. | [optional] |
+| **tax_codes** | **Array<String>** | List of unique code used to identify the taxes. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::PlanOverridesObjectChargesInner.new(
+  id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  invoice_display_name: Setup,
+  min_amount_cents: 0,
+  properties: null,
+  group_properties: null,
+  tax_codes: ["french_standard_vat"]
+)
+```
+

data/docs/Subscription.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **subscription** | [**SubscriptionObject**](SubscriptionObject.md) |  |  |
+| **subscription** | [**SubscriptionObjectExtended**](SubscriptionObjectExtended.md) |  |  |
 
 ## Example
 

data/docs/SubscriptionCreateInputSubscription.md

@@ -11,6 +11,7 @@
 | **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] |
 | **ending_at** | **Time** | The effective end date of the subscription. If this field is set to null, the subscription will automatically renew. This date should be provided in ISO 8601 datetime format, and use Coordinated Universal Time (UTC). | [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] |
+| **plan_overrides** | [**PlanOverridesObject**](PlanOverridesObject.md) |  | [optional] |
 
 ## Example
 
@@ -24,7 +25,8 @@ instance = LagoAPI::SubscriptionCreateInputSubscription.new(
   external_id: my_sub_1234567890,
   billing_time: anniversary,
   ending_at: 2022-10-08T00:00Z,
-  subscription_at: 2022-08-08T00:00Z
+  subscription_at: 2022-08-08T00:00Z,
+  plan_overrides: null
 )
 ```
 

data/docs/SubscriptionObjectExtended.md

@@ -0,0 +1,52 @@
+# LagoAPI::SubscriptionObjectExtended
+
+## 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] |
+| **ending_at** | **Time** | The effective end date of the subscription. If this field is set to null, the subscription will automatically renew. This date should be provided in ISO 8601 datetime format, and use 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] |
+| **plan** | [**PlanObject**](PlanObject.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::SubscriptionObjectExtended.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,
+  ending_at: 2022-10-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,
+  plan: null
+)
+```
+