lago_ruby 0.49.0.pre.beta → 0.52.0.pre.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23e57e890bfe8c0b19773bcb8eb4923fc46a1aa0abb5787074fda52d7fdd344b
-  data.tar.gz: 3ff0bd599f9260095aa49eacc114b4f2570532142033ab1273213de4fb21aabb
+  metadata.gz: 22517ab6a07d771fc3b6e2c4e5826e883c85a1ddc1363dba6c51c55d847fc417
+  data.tar.gz: 1f31e891ed5521efec29d449e11602fd6cf54d6830f24a755df5cc38c0ca2a57
 SHA512:
-  metadata.gz: c542123cabbf5f5f652526fadeaae108f92c08eca199a1fed15749fcd4d83f75b28bc13ed30b4919dfe84f1376ff74e50221ef2435adef570484c42eb339657b
-  data.tar.gz: e9c14cebd5062a44286c1b8fc94377d729392cd8d9bac89ee18461d5e1477a96603fb380d1f765b45081b6ca406ce755180d980de4e9be53e0c559fea82807fd
+  metadata.gz: 9e75d3ba2b0d5e02e7b2aeebd2f6c2926c0f12b03e9574f92baf700d256b684dcd79f4a0529bbf98d0969342bddba172a436a40774d528dafc7e0a7b6d566797
+  data.tar.gz: 9b7b2edc73da3aa2069a99204fb7d83180ad283713c8f12c59e0530d02bfda0ce8471f84cec7887b5b1cb377e535892f5c93ef280f3462acfaf42a09ec1c3741

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.52.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.52.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.52.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.52.0-beta'
 
 ### Install from Git
 
@@ -93,6 +93,10 @@ Class | Method | HTTP request | Description
 *LagoAPI::AddOnsApi* | [**find_add_on**](docs/AddOnsApi.md#find_add_on) | **GET** /add_ons/{code} | Retrieve an add-on
 *LagoAPI::AddOnsApi* | [**find_all_add_ons**](docs/AddOnsApi.md#find_all_add_ons) | **GET** /add_ons | List all add-ons
 *LagoAPI::AddOnsApi* | [**update_add_on**](docs/AddOnsApi.md#update_add_on) | **PUT** /add_ons/{code} | Update an add-on
+*LagoAPI::AnalyticsApi* | [**find_all_gross_revenues**](docs/AnalyticsApi.md#find_all_gross_revenues) | **GET** /analytics/gross_revenue | List gross revenue
+*LagoAPI::AnalyticsApi* | [**find_all_invoiced_usages**](docs/AnalyticsApi.md#find_all_invoiced_usages) | **GET** /analytics/invoiced_usage | List usage revenue
+*LagoAPI::AnalyticsApi* | [**find_all_mrrs**](docs/AnalyticsApi.md#find_all_mrrs) | **GET** /analytics/mrr | List MRR
+*LagoAPI::AnalyticsApi* | [**find_all_outstanding_invoices**](docs/AnalyticsApi.md#find_all_outstanding_invoices) | **GET** /analytics/outstanding_invoices | List outstanding invoices
 *LagoAPI::BillableMetricsApi* | [**create_billable_metric**](docs/BillableMetricsApi.md#create_billable_metric) | **POST** /billable_metrics | Create a billable metric
 *LagoAPI::BillableMetricsApi* | [**destroy_billable_metric**](docs/BillableMetricsApi.md#destroy_billable_metric) | **DELETE** /billable_metrics/{code} | Delete a billable metric
 *LagoAPI::BillableMetricsApi* | [**find_all_billable_metric_groups**](docs/BillableMetricsApi.md#find_all_billable_metric_groups) | **GET** /billable_metrics/{code}/groups | Find a billable metric's groups
@@ -109,6 +113,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
@@ -120,6 +125,7 @@ Class | Method | HTTP request | Description
 *LagoAPI::CustomersApi* | [**find_all_customers**](docs/CustomersApi.md#find_all_customers) | **GET** /customers | List all customers
 *LagoAPI::CustomersApi* | [**find_customer**](docs/CustomersApi.md#find_customer) | **GET** /customers/{external_id} | Retrieve a customer
 *LagoAPI::CustomersApi* | [**find_customer_current_usage**](docs/CustomersApi.md#find_customer_current_usage) | **GET** /customers/{external_customer_id}/current_usage | Retrieve customer current usage
+*LagoAPI::CustomersApi* | [**generate_customer_checkout_url**](docs/CustomersApi.md#generate_customer_checkout_url) | **POST** /customers/{external_customer_id}/checkout_url | Generate a Customer Payment Provider Checkout URL
 *LagoAPI::CustomersApi* | [**get_customer_portal_url**](docs/CustomersApi.md#get_customer_portal_url) | **GET** /customers/{external_customer_id}/portal_url | Get a customer portal URL
 *LagoAPI::EventsApi* | [**create_batch_events**](docs/EventsApi.md#create_batch_events) | **POST** /events/batch | Batch multiple events
 *LagoAPI::EventsApi* | [**create_event**](docs/EventsApi.md#create_event) | **POST** /events | Send usage events
@@ -218,7 +224,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)
@@ -264,8 +276,11 @@ Class | Method | HTTP request | Description
  - [LagoAPI::FeeUpdateInputFee](docs/FeeUpdateInputFee.md)
  - [LagoAPI::Fees](docs/Fees.md)
  - [LagoAPI::FeesPaginated](docs/FeesPaginated.md)
+ - [LagoAPI::GenerateCustomerCheckoutURL200Response](docs/GenerateCustomerCheckoutURL200Response.md)
  - [LagoAPI::GetCustomerPortalUrl200Response](docs/GetCustomerPortalUrl200Response.md)
  - [LagoAPI::GetCustomerPortalUrl200ResponseCustomer](docs/GetCustomerPortalUrl200ResponseCustomer.md)
+ - [LagoAPI::GrossRevenueObject](docs/GrossRevenueObject.md)
+ - [LagoAPI::GrossRevenues](docs/GrossRevenues.md)
  - [LagoAPI::GroupObject](docs/GroupObject.md)
  - [LagoAPI::GroupPropertiesObject](docs/GroupPropertiesObject.md)
  - [LagoAPI::GroupPropertiesObjectValues](docs/GroupPropertiesObjectValues.md)
@@ -282,12 +297,18 @@ Class | Method | HTTP request | Description
  - [LagoAPI::InvoiceUpdateInput](docs/InvoiceUpdateInput.md)
  - [LagoAPI::InvoiceUpdateInputInvoice](docs/InvoiceUpdateInputInvoice.md)
  - [LagoAPI::InvoiceUpdateInputInvoiceMetadataInner](docs/InvoiceUpdateInputInvoiceMetadataInner.md)
+ - [LagoAPI::InvoicedUsageObject](docs/InvoicedUsageObject.md)
+ - [LagoAPI::InvoicedUsages](docs/InvoicedUsages.md)
  - [LagoAPI::InvoicesPaginated](docs/InvoicesPaginated.md)
+ - [LagoAPI::MrrObject](docs/MrrObject.md)
+ - [LagoAPI::Mrrs](docs/Mrrs.md)
  - [LagoAPI::Organization](docs/Organization.md)
  - [LagoAPI::OrganizationBillingConfiguration](docs/OrganizationBillingConfiguration.md)
  - [LagoAPI::OrganizationObject](docs/OrganizationObject.md)
  - [LagoAPI::OrganizationUpdateInput](docs/OrganizationUpdateInput.md)
  - [LagoAPI::OrganizationUpdateInputOrganization](docs/OrganizationUpdateInputOrganization.md)
+ - [LagoAPI::OutstandingInvoiceObject](docs/OutstandingInvoiceObject.md)
+ - [LagoAPI::OutstandingInvoices](docs/OutstandingInvoices.md)
  - [LagoAPI::PaginationMeta](docs/PaginationMeta.md)
  - [LagoAPI::Plan](docs/Plan.md)
  - [LagoAPI::PlanCreateInput](docs/PlanCreateInput.md)
@@ -295,6 +316,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 +326,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/AddOnCreateInputAddOn.md

@@ -24,7 +24,7 @@ instance = LagoAPI::AddOnCreateInputAddOn.new(
   amount_cents: 50000,
   amount_currency: null,
   description: Implementation fee for new customers.,
-  tax_codes: ["french_standard_vat"]
+  tax_codes: [french_standard_vat]
 )
 ```
 

data/docs/AnalyticsApi.md

@@ -0,0 +1,299 @@
+# LagoAPI::AnalyticsApi
+
+All URIs are relative to *https://api.getlago.com/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**find_all_gross_revenues**](AnalyticsApi.md#find_all_gross_revenues) | **GET** /analytics/gross_revenue | List gross revenue |
+| [**find_all_invoiced_usages**](AnalyticsApi.md#find_all_invoiced_usages) | **GET** /analytics/invoiced_usage | List usage revenue |
+| [**find_all_mrrs**](AnalyticsApi.md#find_all_mrrs) | **GET** /analytics/mrr | List MRR |
+| [**find_all_outstanding_invoices**](AnalyticsApi.md#find_all_outstanding_invoices) | **GET** /analytics/outstanding_invoices | List outstanding invoices |
+
+
+## find_all_gross_revenues
+
+> <GrossRevenues> find_all_gross_revenues(opts)
+
+List gross revenue
+
+Gross revenue is the sum of monthly `finalized` invoice payments and fees paid in advance that are not invoiceable. This total is calculated after deducting taxes and discounts.
+
+### 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::AnalyticsApi.new
+opts = {
+  currency: LagoAPI::Currency::AED, # Currency | Currency of revenue analytics. Format must be ISO 4217.
+  external_customer_id: '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba' # String | The customer external unique identifier (provided by your own application). Use it to filter revenue analytics at the customer level.
+}
+
+begin
+  # List gross revenue
+  result = api_instance.find_all_gross_revenues(opts)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling AnalyticsApi->find_all_gross_revenues: #{e}"
+end
+```
+
+#### Using the find_all_gross_revenues_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GrossRevenues>, Integer, Hash)> find_all_gross_revenues_with_http_info(opts)
+
+```ruby
+begin
+  # List gross revenue
+  data, status_code, headers = api_instance.find_all_gross_revenues_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GrossRevenues>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling AnalyticsApi->find_all_gross_revenues_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency** | [**Currency**](.md) | Currency of revenue analytics. Format must be ISO 4217. | [optional] |
+| **external_customer_id** | **String** | The customer external unique identifier (provided by your own application). Use it to filter revenue analytics at the customer level. | [optional] |
+
+### Return type
+
+[**GrossRevenues**](GrossRevenues.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## find_all_invoiced_usages
+
+> <InvoicedUsages> find_all_invoiced_usages(opts)
+
+List usage revenue
+
+Reports a monthly analysis focused on the revenue generated from all usage-based fees. It exclusively accounts for revenue that has been formally invoiced. Importantly, this report does not include revenue related to the usage in the current billing period, limiting its scope to previously invoiced amounts.
+
+### 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::AnalyticsApi.new
+opts = {
+  currency: LagoAPI::Currency::AED # Currency | The currency of invoiced usage analytics. Format must be ISO 4217.
+}
+
+begin
+  # List usage revenue
+  result = api_instance.find_all_invoiced_usages(opts)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling AnalyticsApi->find_all_invoiced_usages: #{e}"
+end
+```
+
+#### Using the find_all_invoiced_usages_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InvoicedUsages>, Integer, Hash)> find_all_invoiced_usages_with_http_info(opts)
+
+```ruby
+begin
+  # List usage revenue
+  data, status_code, headers = api_instance.find_all_invoiced_usages_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InvoicedUsages>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling AnalyticsApi->find_all_invoiced_usages_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency** | [**Currency**](.md) | The currency of invoiced usage analytics. Format must be ISO 4217. | [optional] |
+
+### Return type
+
+[**InvoicedUsages**](InvoicedUsages.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## find_all_mrrs
+
+> <Mrrs> find_all_mrrs(opts)
+
+List MRR
+
+This endpoint is used to list MRR.
+
+### 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::AnalyticsApi.new
+opts = {
+  currency: LagoAPI::Currency::AED, # Currency | Quantifies the revenue generated from `subscription` fees on a monthly basis. This figure is calculated post-application of applicable taxes and prior to the deduction of any applicable discounts. The method of calculation varies based on the subscription billing cycle:  - Revenue from `monthly` subscription invoices is included in the MRR for the month in which the invoice is issued. - Revenue from `quarterly` subscription invoices is distributed evenly over three months. This distribution applies to fees paid in advance (allocated to the next three months) as well as to fees paid in arrears (allocated to the preceding three months). - Revenue from `yearly` subscription invoices is distributed evenly over twelve months. This allocation is applicable for fees paid in advance (spread over the next twelve months) and for fees paid in arrears (spread over the previous twelve months). - Revenue from `weekly` subscription invoices, the total revenue from all invoices issued within a month is summed up. This total is then divided by the number of invoices issued during that month, and the result is multiplied by 4.33, representing the average number of weeks in a month.
+  months: 12 # Integer | Show data only for given number of months.
+}
+
+begin
+  # List MRR
+  result = api_instance.find_all_mrrs(opts)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling AnalyticsApi->find_all_mrrs: #{e}"
+end
+```
+
+#### Using the find_all_mrrs_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Mrrs>, Integer, Hash)> find_all_mrrs_with_http_info(opts)
+
+```ruby
+begin
+  # List MRR
+  data, status_code, headers = api_instance.find_all_mrrs_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Mrrs>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling AnalyticsApi->find_all_mrrs_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency** | [**Currency**](.md) | Quantifies the revenue generated from &#x60;subscription&#x60; fees on a monthly basis. This figure is calculated post-application of applicable taxes and prior to the deduction of any applicable discounts. The method of calculation varies based on the subscription billing cycle:  - Revenue from &#x60;monthly&#x60; subscription invoices is included in the MRR for the month in which the invoice is issued. - Revenue from &#x60;quarterly&#x60; subscription invoices is distributed evenly over three months. This distribution applies to fees paid in advance (allocated to the next three months) as well as to fees paid in arrears (allocated to the preceding three months). - Revenue from &#x60;yearly&#x60; subscription invoices is distributed evenly over twelve months. This allocation is applicable for fees paid in advance (spread over the next twelve months) and for fees paid in arrears (spread over the previous twelve months). - Revenue from &#x60;weekly&#x60; subscription invoices, the total revenue from all invoices issued within a month is summed up. This total is then divided by the number of invoices issued during that month, and the result is multiplied by 4.33, representing the average number of weeks in a month. | [optional] |
+| **months** | **Integer** | Show data only for given number of months. | [optional] |
+
+### Return type
+
+[**Mrrs**](Mrrs.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## find_all_outstanding_invoices
+
+> <OutstandingInvoices> find_all_outstanding_invoices(opts)
+
+List outstanding invoices
+
+Represents a monthly aggregation, detailing both the total count and the cumulative amount of invoices that have been marked as `finalized`. This report sorts invoices categorically based on their `payment_status`.
+
+### 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::AnalyticsApi.new
+opts = {
+  currency: LagoAPI::Currency::AED # Currency | The currency of revenue analytics. Format must be ISO 4217.
+}
+
+begin
+  # List outstanding invoices
+  result = api_instance.find_all_outstanding_invoices(opts)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling AnalyticsApi->find_all_outstanding_invoices: #{e}"
+end
+```
+
+#### Using the find_all_outstanding_invoices_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OutstandingInvoices>, Integer, Hash)> find_all_outstanding_invoices_with_http_info(opts)
+
+```ruby
+begin
+  # List outstanding invoices
+  data, status_code, headers = api_instance.find_all_outstanding_invoices_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OutstandingInvoices>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling AnalyticsApi->find_all_outstanding_invoices_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency** | [**Currency**](.md) | The currency of revenue analytics. Format must be ISO 4217. | [optional] |
+
+### Return type
+
+[**OutstandingInvoices**](OutstandingInvoices.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

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
+)
+```
+