lago_ruby 0.46.0.pre.beta

data/docs/CouponsApi.md

@@ -0,0 +1,583 @@
+# LagoAPI::CouponsApi
+
+All URIs are relative to *https://api.getlago.com/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**apply_coupon**](CouponsApi.md#apply_coupon) | **POST** /applied_coupons | Apply a coupon to a customer |
+| [**create_coupon**](CouponsApi.md#create_coupon) | **POST** /coupons | Create a coupon |
+| [**delete_applied_coupon**](CouponsApi.md#delete_applied_coupon) | **DELETE** /customers/{external_customer_id}/applied_coupons/{applied_coupon_id} | Delete an applied coupon |
+| [**destroy_coupon**](CouponsApi.md#destroy_coupon) | **DELETE** /coupons/{code} | Delete a coupon |
+| [**find_all_applied_coupons**](CouponsApi.md#find_all_applied_coupons) | **GET** /applied_coupons | List all applied coupons |
+| [**find_all_coupons**](CouponsApi.md#find_all_coupons) | **GET** /coupons | List all coupons |
+| [**find_coupon**](CouponsApi.md#find_coupon) | **GET** /coupons/{code} | Retrieve a coupon |
+| [**update_coupon**](CouponsApi.md#update_coupon) | **PUT** /coupons/{code} | Update a coupon |
+
+
+## apply_coupon
+
+> <AppliedCoupon> apply_coupon(applied_coupon_input)
+
+Apply a coupon to a customer
+
+This endpoint is used to apply a specific coupon to a customer, before or during a subscription.
+
+### 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::CouponsApi.new
+applied_coupon_input = LagoAPI::AppliedCouponInput.new({applied_coupon: LagoAPI::AppliedCouponInputAppliedCoupon.new({external_customer_id: '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba', coupon_code: 'startup_deal'})}) # AppliedCouponInput | Apply coupon payload
+
+begin
+  # Apply a coupon to a customer
+  result = api_instance.apply_coupon(applied_coupon_input)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CouponsApi->apply_coupon: #{e}"
+end
+```
+
+#### Using the apply_coupon_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AppliedCoupon>, Integer, Hash)> apply_coupon_with_http_info(applied_coupon_input)
+
+```ruby
+begin
+  # Apply a coupon to a customer
+  data, status_code, headers = api_instance.apply_coupon_with_http_info(applied_coupon_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AppliedCoupon>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CouponsApi->apply_coupon_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **applied_coupon_input** | [**AppliedCouponInput**](AppliedCouponInput.md) | Apply coupon payload |  |
+
+### Return type
+
+[**AppliedCoupon**](AppliedCoupon.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_coupon
+
+> <Coupon> create_coupon(coupon_create_input)
+
+Create a coupon
+
+This endpoint is used to create a coupon that can be then attached to a customer to create a discount.
+
+### 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::CouponsApi.new
+coupon_create_input = LagoAPI::CouponCreateInput.new({coupon: LagoAPI::CouponCreateInputCoupon.new({name: 'Startup Deal', code: 'startup_deal', coupon_type: 'fixed_amount', frequency: 'once'})}) # CouponCreateInput | Coupon payload
+
+begin
+  # Create a coupon
+  result = api_instance.create_coupon(coupon_create_input)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CouponsApi->create_coupon: #{e}"
+end
+```
+
+#### Using the create_coupon_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Coupon>, Integer, Hash)> create_coupon_with_http_info(coupon_create_input)
+
+```ruby
+begin
+  # Create a coupon
+  data, status_code, headers = api_instance.create_coupon_with_http_info(coupon_create_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Coupon>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CouponsApi->create_coupon_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **coupon_create_input** | [**CouponCreateInput**](CouponCreateInput.md) | Coupon payload |  |
+
+### Return type
+
+[**Coupon**](Coupon.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_applied_coupon
+
+> <AppliedCoupon> delete_applied_coupon(external_customer_id, applied_coupon_id)
+
+Delete an applied coupon
+
+This endpoint is used to delete a specific coupon that has been applied to a customer.
+
+### 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::CouponsApi.new
+external_customer_id = '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba' # String | The customer external unique identifier (provided by your own application)
+applied_coupon_id = '1a901a90-1a90-1a90-1a90-1a901a901a90' # String | Unique identifier of the applied coupon, created by Lago.
+
+begin
+  # Delete an applied coupon
+  result = api_instance.delete_applied_coupon(external_customer_id, applied_coupon_id)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CouponsApi->delete_applied_coupon: #{e}"
+end
+```
+
+#### Using the delete_applied_coupon_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AppliedCoupon>, Integer, Hash)> delete_applied_coupon_with_http_info(external_customer_id, applied_coupon_id)
+
+```ruby
+begin
+  # Delete an applied coupon
+  data, status_code, headers = api_instance.delete_applied_coupon_with_http_info(external_customer_id, applied_coupon_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AppliedCoupon>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CouponsApi->delete_applied_coupon_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **external_customer_id** | **String** | The customer external unique identifier (provided by your own application) |  |
+| **applied_coupon_id** | **String** | Unique identifier of the applied coupon, created by Lago. |  |
+
+### Return type
+
+[**AppliedCoupon**](AppliedCoupon.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## destroy_coupon
+
+> <Coupon> destroy_coupon(code)
+
+Delete a coupon
+
+This endpoint is used to delete a coupon.
+
+### 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::CouponsApi.new
+code = 'startup_deal' # String | Unique code used to identify the coupon.
+
+begin
+  # Delete a coupon
+  result = api_instance.destroy_coupon(code)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CouponsApi->destroy_coupon: #{e}"
+end
+```
+
+#### Using the destroy_coupon_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Coupon>, Integer, Hash)> destroy_coupon_with_http_info(code)
+
+```ruby
+begin
+  # Delete a coupon
+  data, status_code, headers = api_instance.destroy_coupon_with_http_info(code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Coupon>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CouponsApi->destroy_coupon_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Unique code used to identify the coupon. |  |
+
+### Return type
+
+[**Coupon**](Coupon.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## find_all_applied_coupons
+
+> <AppliedCouponsPaginated> find_all_applied_coupons(opts)
+
+List all applied coupons
+
+This endpoint is used to list all applied coupons. You can filter by coupon status and by customer.
+
+### 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::CouponsApi.new
+opts = {
+  page: 1, # Integer | Page number.
+  per_page: 20, # Integer | Number of records per page.
+  status: 'active', # String | The status of the coupon. Can be either `active` or `terminated`.
+  external_customer_id: '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba' # String | The customer external unique identifier (provided by your own application)
+}
+
+begin
+  # List all applied coupons
+  result = api_instance.find_all_applied_coupons(opts)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CouponsApi->find_all_applied_coupons: #{e}"
+end
+```
+
+#### Using the find_all_applied_coupons_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AppliedCouponsPaginated>, Integer, Hash)> find_all_applied_coupons_with_http_info(opts)
+
+```ruby
+begin
+  # List all applied coupons
+  data, status_code, headers = api_instance.find_all_applied_coupons_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AppliedCouponsPaginated>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CouponsApi->find_all_applied_coupons_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page number. | [optional] |
+| **per_page** | **Integer** | Number of records per page. | [optional] |
+| **status** | **String** | The status of the coupon. Can be either &#x60;active&#x60; or &#x60;terminated&#x60;. | [optional] |
+| **external_customer_id** | **String** | The customer external unique identifier (provided by your own application) | [optional] |
+
+### Return type
+
+[**AppliedCouponsPaginated**](AppliedCouponsPaginated.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## find_all_coupons
+
+> <CouponsPaginated> find_all_coupons(opts)
+
+List all coupons
+
+This endpoint is used to list all existing coupons.
+
+### 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::CouponsApi.new
+opts = {
+  page: 1, # Integer | Page number.
+  per_page: 20 # Integer | Number of records per page.
+}
+
+begin
+  # List all coupons
+  result = api_instance.find_all_coupons(opts)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CouponsApi->find_all_coupons: #{e}"
+end
+```
+
+#### Using the find_all_coupons_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CouponsPaginated>, Integer, Hash)> find_all_coupons_with_http_info(opts)
+
+```ruby
+begin
+  # List all coupons
+  data, status_code, headers = api_instance.find_all_coupons_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CouponsPaginated>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CouponsApi->find_all_coupons_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page number. | [optional] |
+| **per_page** | **Integer** | Number of records per page. | [optional] |
+
+### Return type
+
+[**CouponsPaginated**](CouponsPaginated.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## find_coupon
+
+> <Coupon> find_coupon(code)
+
+Retrieve a coupon
+
+This endpoint is used to retrieve a specific coupon.
+
+### 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::CouponsApi.new
+code = 'startup_deal' # String | Unique code used to identify the coupon.
+
+begin
+  # Retrieve a coupon
+  result = api_instance.find_coupon(code)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CouponsApi->find_coupon: #{e}"
+end
+```
+
+#### Using the find_coupon_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Coupon>, Integer, Hash)> find_coupon_with_http_info(code)
+
+```ruby
+begin
+  # Retrieve a coupon
+  data, status_code, headers = api_instance.find_coupon_with_http_info(code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Coupon>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CouponsApi->find_coupon_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Unique code used to identify the coupon. |  |
+
+### Return type
+
+[**Coupon**](Coupon.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_coupon
+
+> <Coupon> update_coupon(code, coupon_update_input)
+
+Update a coupon
+
+This endpoint is used to update a coupon that can be then attached to a customer to create a discount.
+
+### 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::CouponsApi.new
+code = 'startup_deal' # String | Unique code used to identify the coupon.
+coupon_update_input = LagoAPI::CouponUpdateInput.new({coupon: LagoAPI::CouponBaseInput.new}) # CouponUpdateInput | Coupon payload
+
+begin
+  # Update a coupon
+  result = api_instance.update_coupon(code, coupon_update_input)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CouponsApi->update_coupon: #{e}"
+end
+```
+
+#### Using the update_coupon_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Coupon>, Integer, Hash)> update_coupon_with_http_info(code, coupon_update_input)
+
+```ruby
+begin
+  # Update a coupon
+  data, status_code, headers = api_instance.update_coupon_with_http_info(code, coupon_update_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Coupon>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CouponsApi->update_coupon_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Unique code used to identify the coupon. |  |
+| **coupon_update_input** | [**CouponUpdateInput**](CouponUpdateInput.md) | Coupon payload |  |
+
+### Return type
+
+[**Coupon**](Coupon.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/CouponsPaginated.md

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

data/docs/CreateWebhookEndpoint200Response.md

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

data/docs/CreateWebhookEndpoint200ResponseWebhookEndpoint.md

@@ -0,0 +1,26 @@
+# LagoAPI::CreateWebhookEndpoint200ResponseWebhookEndpoint
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the webhook endpoint's record within the Lago system. |  |
+| **lago_organization_id** | **String** | Unique identifier assigned to the organization attached to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the organization’s record within the Lago system. |  |
+| **webhook_url** | **String** | The name of the wallet. |  |
+| **signature_algo** | **String** | The signature algo for the webhook. | [optional] |
+| **created_at** | **Time** | The date of the webhook endpoint creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreateWebhookEndpoint200ResponseWebhookEndpoint.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  lago_organization_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  webhook_url: Prepaid,
+  signature_algo: hmac,
+  created_at: 2022-04-29T08:59:51Z
+)
+```
+

data/docs/CreateWebhookEndpointRequest.md

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

data/docs/CreateWebhookEndpointRequestWebhookEndpoint.md

@@ -0,0 +1,20 @@
+# LagoAPI::CreateWebhookEndpointRequestWebhookEndpoint
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_url** | **String** | The URL of the webhook endpoint. |  |
+| **signature_algo** | **String** | The signature used for the webhook. If no value is passed, | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreateWebhookEndpointRequestWebhookEndpoint.new(
+  webhook_url: https://foo.bar,
+  signature_algo: hmac
+)
+```
+

data/docs/CreditNote.md

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