melio-platform-api-client 3.0.1

data/docs/BillerAccount.md

@@ -0,0 +1,18 @@
+# MelioPlatformApiClient::BillerAccount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_identifier** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::BillerAccount.new(
+  account_identifier: null
+)
+```
+

data/docs/Card.md

@@ -0,0 +1,24 @@
+# MelioPlatformApiClient::Card
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **expiration_month** | **String** | Two-digits month (e.g. `01` or `11`) |  |
+| **expiration_year** | **String** | Four-digits year (e.g. `2024`). |  |
+| **last_four_digits** | **String** | LAst four digits of a payment card. |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::Card.new(
+  type: null,
+  expiration_month: null,
+  expiration_year: null,
+  last_four_digits: null
+)
+```
+

data/docs/Charge.md

@@ -0,0 +1,32 @@
+# MelioPlatformApiClient::Charge
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the entity. |  |
+| **history** | [**ShortHistory**](ShortHistory.md) |  |  |
+| **status** | **String** |  |  |
+| **due_date** | **Date** |  |  |
+| **amount** | **Integer** |  |  |
+| **currency** | [**Currency**](Currency.md) |  | [default to 'USD'] |
+| **merchant_order_reference** | **String** | Merchant's reference for the order in their systems as provided when the Charge object was created |  |
+| **invoice** | [**Invoice**](Invoice.md) |  |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::Charge.new(
+  id: null,
+  history: null,
+  status: null,
+  due_date: null,
+  amount: null,
+  currency: null,
+  merchant_order_reference: null,
+  invoice: null
+)
+```
+

data/docs/ChargeAllOf.md

@@ -0,0 +1,28 @@
+# MelioPlatformApiClient::ChargeAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  |  |
+| **due_date** | **Date** |  |  |
+| **amount** | **Integer** |  |  |
+| **currency** | [**Currency**](Currency.md) |  | [default to 'USD'] |
+| **merchant_order_reference** | **String** | Merchant's reference for the order in their systems as provided when the Charge object was created |  |
+| **invoice** | [**Invoice**](Invoice.md) |  |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::ChargeAllOf.new(
+  status: null,
+  due_date: null,
+  amount: null,
+  currency: null,
+  merchant_order_reference: null,
+  invoice: null
+)
+```
+

data/docs/ChargesApi.md

@@ -0,0 +1,317 @@
+# MelioPlatformApiClient::ChargesApi
+
+All URIs are relative to *https://api.melio.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_charges_charge_id**](ChargesApi.md#delete_charges_charge_id) | **DELETE** /charges/{chargeId} | Delete a Charge |
+| [**get_charges_charge_id**](ChargesApi.md#get_charges_charge_id) | **GET** /charges/{chargeId} | Retrieve a Charge |
+| [**get_merchants_merchant_id_charges**](ChargesApi.md#get_merchants_merchant_id_charges) | **GET** /merchants/{merchantId}/charges | Retrieve all Charges |
+| [**patch_charges_charge_id**](ChargesApi.md#patch_charges_charge_id) | **PATCH** /charges/{chargeId} | Update a Charge |
+
+
+## delete_charges_charge_id
+
+> <DeletedResponse> delete_charges_charge_id(charge_id, idempotency_key, opts)
+
+Delete a Charge
+
+Cancel a Charge (Refund)
+
+### Examples
+
+```ruby
+require 'time'
+require 'melio-platform-api-client'
+# setup authorization
+MelioPlatformApiClient.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+api_instance = MelioPlatformApiClient::ChargesApi.new
+charge_id = 'charge_id_example' # String | 
+idempotency_key = 'idempotency_key_example' # String | Unique idempotency key
+opts = {
+  melio_account: 'melio_account_example' # String | The `Melio-Account` header is used when a Partner wants to perform an operation on behalf of one of its Accounts. It contains the Account's ID which returned when creating the Account, or when retrieving all of the Partner's Accounts. Note that most operations are not permitted without the presence of this header.
+}
+
+begin
+  # Delete a Charge
+  result = api_instance.delete_charges_charge_id(charge_id, idempotency_key, opts)
+  p result
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling ChargesApi->delete_charges_charge_id: #{e}"
+end
+```
+
+#### Using the delete_charges_charge_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeletedResponse>, Integer, Hash)> delete_charges_charge_id_with_http_info(charge_id, idempotency_key, opts)
+
+```ruby
+begin
+  # Delete a Charge
+  data, status_code, headers = api_instance.delete_charges_charge_id_with_http_info(charge_id, idempotency_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeletedResponse>
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling ChargesApi->delete_charges_charge_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **charge_id** | **String** |  |  |
+| **idempotency_key** | **String** | Unique idempotency key |  |
+| **melio_account** | **String** | The &#x60;Melio-Account&#x60; header is used when a Partner wants to perform an operation on behalf of one of its Accounts. It contains the Account&#39;s ID which returned when creating the Account, or when retrieving all of the Partner&#39;s Accounts. Note that most operations are not permitted without the presence of this header. | [optional] |
+
+### Return type
+
+[**DeletedResponse**](DeletedResponse.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_charges_charge_id
+
+> <GetChargesChargeIdResponse> get_charges_charge_id(charge_id, opts)
+
+Retrieve a Charge
+
+Retrieve the status of a Charge made by the Account
+
+### Examples
+
+```ruby
+require 'time'
+require 'melio-platform-api-client'
+# setup authorization
+MelioPlatformApiClient.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+api_instance = MelioPlatformApiClient::ChargesApi.new
+charge_id = 'charge_id_example' # String | 
+opts = {
+  melio_account: 'melio_account_example' # String | The `Melio-Account` header is used when a Partner wants to perform an operation on behalf of one of its Accounts. It contains the Account's ID which returned when creating the Account, or when retrieving all of the Partner's Accounts. Note that most operations are not permitted without the presence of this header.
+}
+
+begin
+  # Retrieve a Charge
+  result = api_instance.get_charges_charge_id(charge_id, opts)
+  p result
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling ChargesApi->get_charges_charge_id: #{e}"
+end
+```
+
+#### Using the get_charges_charge_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetChargesChargeIdResponse>, Integer, Hash)> get_charges_charge_id_with_http_info(charge_id, opts)
+
+```ruby
+begin
+  # Retrieve a Charge
+  data, status_code, headers = api_instance.get_charges_charge_id_with_http_info(charge_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetChargesChargeIdResponse>
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling ChargesApi->get_charges_charge_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **charge_id** | **String** |  |  |
+| **melio_account** | **String** | The &#x60;Melio-Account&#x60; header is used when a Partner wants to perform an operation on behalf of one of its Accounts. It contains the Account&#39;s ID which returned when creating the Account, or when retrieving all of the Partner&#39;s Accounts. Note that most operations are not permitted without the presence of this header. | [optional] |
+
+### Return type
+
+[**GetChargesChargeIdResponse**](GetChargesChargeIdResponse.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_merchants_merchant_id_charges
+
+> <GetChargesResponse> get_merchants_merchant_id_charges(merchant_id, opts)
+
+Retrieve all Charges
+
+Retrieve all the Charges for the merchant
+
+### Examples
+
+```ruby
+require 'time'
+require 'melio-platform-api-client'
+# setup authorization
+MelioPlatformApiClient.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+api_instance = MelioPlatformApiClient::ChargesApi.new
+merchant_id = 'merchant_id_example' # String | 
+opts = {
+  melio_account: 'melio_account_example' # String | The `Melio-Account` header is used when a Partner wants to perform an operation on behalf of one of its Accounts. It contains the Account's ID which returned when creating the Account, or when retrieving all of the Partner's Accounts. Note that most operations are not permitted without the presence of this header.
+}
+
+begin
+  # Retrieve all Charges
+  result = api_instance.get_merchants_merchant_id_charges(merchant_id, opts)
+  p result
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling ChargesApi->get_merchants_merchant_id_charges: #{e}"
+end
+```
+
+#### Using the get_merchants_merchant_id_charges_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetChargesResponse>, Integer, Hash)> get_merchants_merchant_id_charges_with_http_info(merchant_id, opts)
+
+```ruby
+begin
+  # Retrieve all Charges
+  data, status_code, headers = api_instance.get_merchants_merchant_id_charges_with_http_info(merchant_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetChargesResponse>
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling ChargesApi->get_merchants_merchant_id_charges_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **merchant_id** | **String** |  |  |
+| **melio_account** | **String** | The &#x60;Melio-Account&#x60; header is used when a Partner wants to perform an operation on behalf of one of its Accounts. It contains the Account&#39;s ID which returned when creating the Account, or when retrieving all of the Partner&#39;s Accounts. Note that most operations are not permitted without the presence of this header. | [optional] |
+
+### Return type
+
+[**GetChargesResponse**](GetChargesResponse.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## patch_charges_charge_id
+
+> <PatchChargesChargeIdResponse> patch_charges_charge_id(charge_id, idempotency_key, opts)
+
+Update a Charge
+
+Update a Charge (effectively a partial refund). Send a new amount to refund the difference between original charge's amount and the new one. The new amount cannot be more than the original.
+
+### Examples
+
+```ruby
+require 'time'
+require 'melio-platform-api-client'
+# setup authorization
+MelioPlatformApiClient.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+api_instance = MelioPlatformApiClient::ChargesApi.new
+charge_id = 'charge_id_example' # String | 
+idempotency_key = 'idempotency_key_example' # String | Unique idempotency key
+opts = {
+  melio_account: 'melio_account_example', # String | The `Melio-Account` header is used when a Partner wants to perform an operation on behalf of one of its Accounts. It contains the Account's ID which returned when creating the Account, or when retrieving all of the Partner's Accounts. Note that most operations are not permitted without the presence of this header.
+  patch_charges_charge_id_request: MelioPlatformApiClient::PatchChargesChargeIdRequest.new # PatchChargesChargeIdRequest | 
+}
+
+begin
+  # Update a Charge
+  result = api_instance.patch_charges_charge_id(charge_id, idempotency_key, opts)
+  p result
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling ChargesApi->patch_charges_charge_id: #{e}"
+end
+```
+
+#### Using the patch_charges_charge_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PatchChargesChargeIdResponse>, Integer, Hash)> patch_charges_charge_id_with_http_info(charge_id, idempotency_key, opts)
+
+```ruby
+begin
+  # Update a Charge
+  data, status_code, headers = api_instance.patch_charges_charge_id_with_http_info(charge_id, idempotency_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PatchChargesChargeIdResponse>
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling ChargesApi->patch_charges_charge_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **charge_id** | **String** |  |  |
+| **idempotency_key** | **String** | Unique idempotency key |  |
+| **melio_account** | **String** | The &#x60;Melio-Account&#x60; header is used when a Partner wants to perform an operation on behalf of one of its Accounts. It contains the Account&#39;s ID which returned when creating the Account, or when retrieving all of the Partner&#39;s Accounts. Note that most operations are not permitted without the presence of this header. | [optional] |
+| **patch_charges_charge_id_request** | [**PatchChargesChargeIdRequest**](PatchChargesChargeIdRequest.md) |  | [optional] |
+
+### Return type
+
+[**PatchChargesChargeIdResponse**](PatchChargesChargeIdResponse.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Checkout.md

@@ -0,0 +1,66 @@
+# MelioPlatformApiClient::Checkout
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the entity. |  |
+| **history** | [**ShortHistory**](ShortHistory.md) |  |  |
+| **merchant_id** | **String** | Identifier of the entity. |  |
+| **net_terms** | **Integer** | Payment terms in integer (net 15/30/60/etc) |  |
+| **line_items** | [**Array<LineItem>**](LineItem.md) | Line items composing the buyer's cart |  |
+| **tax_items** | [**Array<Adjustment>**](Adjustment.md) |  | [optional] |
+| **shipping_address** | [**Address**](Address.md) |  |  |
+| **billing_address** | [**Address**](Address.md) |  |  |
+| **currency** | [**Currency**](Currency.md) |  | [optional][default to 'USD'] |
+| **tax_total** | **Integer** |  |  |
+| **coupon_items** | [**Array<Adjustment>**](Adjustment.md) |  | [optional] |
+| **subtotal** | **Integer** |  |  |
+| **shipping_cost_total** | **Integer** |  | [optional] |
+| **grand_total** | **Integer** |  |  |
+| **store_credit** | **Integer** |  | [optional] |
+| **gift_certificates** | [**Array<Adjustment>**](Adjustment.md) |  | [optional] |
+| **outstanding_balance** | **Integer** |  |  |
+| **buyer** | [**CheckoutAllOfBuyer**](CheckoutAllOfBuyer.md) |  | [optional] |
+| **company_name** | **String** |  |  |
+| **status** | **String** |  |  |
+| **has_contact_details** | **Boolean** | Equals `true` if billing contact's details were collected |  |
+| **has_payment_details** | **Boolean** | Equals `true` if payment details were collected |  |
+| **due_date** | **Date** |  | [optional] |
+| **checkout_url** | **String** |  | [optional] |
+| **charge_id** | **String** | Identifier of the entity. | [optional] |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::Checkout.new(
+  id: null,
+  history: null,
+  merchant_id: null,
+  net_terms: null,
+  line_items: null,
+  tax_items: null,
+  shipping_address: null,
+  billing_address: null,
+  currency: null,
+  tax_total: null,
+  coupon_items: null,
+  subtotal: null,
+  shipping_cost_total: null,
+  grand_total: null,
+  store_credit: null,
+  gift_certificates: null,
+  outstanding_balance: null,
+  buyer: null,
+  company_name: null,
+  status: null,
+  has_contact_details: null,
+  has_payment_details: null,
+  due_date: null,
+  checkout_url: null,
+  charge_id: null
+)
+```
+

data/docs/CheckoutAllOf.md

@@ -0,0 +1,62 @@
+# MelioPlatformApiClient::CheckoutAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **merchant_id** | **String** | Identifier of the entity. |  |
+| **net_terms** | **Integer** | Payment terms in integer (net 15/30/60/etc) |  |
+| **line_items** | [**Array<LineItem>**](LineItem.md) | Line items composing the buyer's cart |  |
+| **tax_items** | [**Array<Adjustment>**](Adjustment.md) |  | [optional] |
+| **shipping_address** | [**Address**](Address.md) |  |  |
+| **billing_address** | [**Address**](Address.md) |  |  |
+| **currency** | [**Currency**](Currency.md) |  | [optional][default to 'USD'] |
+| **tax_total** | **Integer** |  |  |
+| **coupon_items** | [**Array<Adjustment>**](Adjustment.md) |  | [optional] |
+| **subtotal** | **Integer** |  |  |
+| **shipping_cost_total** | **Integer** |  | [optional] |
+| **grand_total** | **Integer** |  |  |
+| **store_credit** | **Integer** |  | [optional] |
+| **gift_certificates** | [**Array<Adjustment>**](Adjustment.md) |  | [optional] |
+| **outstanding_balance** | **Integer** |  |  |
+| **buyer** | [**CheckoutAllOfBuyer**](CheckoutAllOfBuyer.md) |  | [optional] |
+| **company_name** | **String** |  |  |
+| **status** | **String** |  |  |
+| **has_contact_details** | **Boolean** | Equals `true` if billing contact's details were collected |  |
+| **has_payment_details** | **Boolean** | Equals `true` if payment details were collected |  |
+| **due_date** | **Date** |  | [optional] |
+| **checkout_url** | **String** |  | [optional] |
+| **charge_id** | **String** | Identifier of the entity. | [optional] |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::CheckoutAllOf.new(
+  merchant_id: null,
+  net_terms: null,
+  line_items: null,
+  tax_items: null,
+  shipping_address: null,
+  billing_address: null,
+  currency: null,
+  tax_total: null,
+  coupon_items: null,
+  subtotal: null,
+  shipping_cost_total: null,
+  grand_total: null,
+  store_credit: null,
+  gift_certificates: null,
+  outstanding_balance: null,
+  buyer: null,
+  company_name: null,
+  status: null,
+  has_contact_details: null,
+  has_payment_details: null,
+  due_date: null,
+  checkout_url: null,
+  charge_id: null
+)
+```
+

data/docs/CheckoutAllOfBuyer.md

@@ -0,0 +1,26 @@
+# MelioPlatformApiClient::CheckoutAllOfBuyer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_name** | **String** |  |  |
+| **last_name** | **String** |  |  |
+| **phone_number** | **String** | Holds a phone number - the format is flexible as is determined according to usage. For testing you can use `123123122`. | [optional] |
+| **email** | **String** |  | [optional] |
+| **birth_date** | **Date** |  | [optional] |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::CheckoutAllOfBuyer.new(
+  first_name: null,
+  last_name: null,
+  phone_number: null,
+  email: null,
+  birth_date: null
+)
+```
+