melio-platform-api-client 3.0.1

data/docs/PaymentsApi.md

@@ -0,0 +1,325 @@
+# MelioPlatformApiClient::PaymentsApi
+
+All URIs are relative to *https://api.melio.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_payments_payment_id**](PaymentsApi.md#delete_payments_payment_id) | **DELETE** /payments/{paymentId} | Delete a Payment |
+| [**get_payments**](PaymentsApi.md#get_payments) | **GET** /payments | Retrieve all Payments of a PaymentIntent |
+| [**get_payments_payment_id**](PaymentsApi.md#get_payments_payment_id) | **GET** /payments/{paymentId} | Retrieve a Payment |
+| [**recover_payment_payment_id**](PaymentsApi.md#recover_payment_payment_id) | **POST** /payments/{paymentId}/recover | Recover a Payment |
+
+
+## delete_payments_payment_id
+
+> <DeletedResponse> delete_payments_payment_id(payment_id, opts)
+
+Delete a Payment
+
+Delete / cancel a Payment.
+
+### Examples
+
+```ruby
+require 'time'
+require 'melio-platform-api-client'
+# setup authorization
+MelioPlatformApiClient.configure do |config|
+  # Configure Bearer authorization: AccessToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # 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::PaymentsApi.new
+payment_id = 'payment_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
+  # Delete a Payment
+  result = api_instance.delete_payments_payment_id(payment_id, opts)
+  p result
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling PaymentsApi->delete_payments_payment_id: #{e}"
+end
+```
+
+#### Using the delete_payments_payment_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeletedResponse>, Integer, Hash)> delete_payments_payment_id_with_http_info(payment_id, opts)
+
+```ruby
+begin
+  # Delete a Payment
+  data, status_code, headers = api_instance.delete_payments_payment_id_with_http_info(payment_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeletedResponse>
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling PaymentsApi->delete_payments_payment_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_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
+
+[**DeletedResponse**](DeletedResponse.md)
+
+### Authorization
+
+[AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_payments
+
+> <GetPaymentsResponse> get_payments(opts)
+
+Retrieve all Payments of a PaymentIntent
+
+Retrieve a list of all Payments of a PaymentIntent
+
+### Examples
+
+```ruby
+require 'time'
+require 'melio-platform-api-client'
+# setup authorization
+MelioPlatformApiClient.configure do |config|
+  # Configure Bearer authorization: AccessToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # 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::PaymentsApi.new
+opts = {
+  payment_intent_id: 'payment_intent_id_example' # String | 
+}
+
+begin
+  # Retrieve all Payments of a PaymentIntent
+  result = api_instance.get_payments(opts)
+  p result
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling PaymentsApi->get_payments: #{e}"
+end
+```
+
+#### Using the get_payments_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetPaymentsResponse>, Integer, Hash)> get_payments_with_http_info(opts)
+
+```ruby
+begin
+  # Retrieve all Payments of a PaymentIntent
+  data, status_code, headers = api_instance.get_payments_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetPaymentsResponse>
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling PaymentsApi->get_payments_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_intent_id** | **String** |  | [optional] |
+
+### Return type
+
+[**GetPaymentsResponse**](GetPaymentsResponse.md)
+
+### Authorization
+
+[AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_payments_payment_id
+
+> <GetPaymentsPaymentIdResponse> get_payments_payment_id(payment_id, opts)
+
+Retrieve a Payment
+
+Retrieve a Payment using its ID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'melio-platform-api-client'
+# setup authorization
+MelioPlatformApiClient.configure do |config|
+  # Configure Bearer authorization: AccessToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # 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::PaymentsApi.new
+payment_id = 'payment_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 Payment
+  result = api_instance.get_payments_payment_id(payment_id, opts)
+  p result
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling PaymentsApi->get_payments_payment_id: #{e}"
+end
+```
+
+#### Using the get_payments_payment_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetPaymentsPaymentIdResponse>, Integer, Hash)> get_payments_payment_id_with_http_info(payment_id, opts)
+
+```ruby
+begin
+  # Retrieve a Payment
+  data, status_code, headers = api_instance.get_payments_payment_id_with_http_info(payment_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetPaymentsPaymentIdResponse>
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling PaymentsApi->get_payments_payment_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_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
+
+[**GetPaymentsPaymentIdResponse**](GetPaymentsPaymentIdResponse.md)
+
+### Authorization
+
+[AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## recover_payment_payment_id
+
+> <RecoverPaymentResponse> recover_payment_payment_id(payment_id, idempotency_key, opts)
+
+Recover a Payment
+
+Recover a Payment by providing alternative details, hence restarting the Payment's lifecycle.
+
+### Examples
+
+```ruby
+require 'time'
+require 'melio-platform-api-client'
+# setup authorization
+MelioPlatformApiClient.configure do |config|
+  # Configure Bearer authorization: AccessToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # 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::PaymentsApi.new
+payment_id = 'payment_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.
+  recover_payment_request: MelioPlatformApiClient::RecoverPaymentRequest.new # RecoverPaymentRequest | 
+}
+
+begin
+  # Recover a Payment
+  result = api_instance.recover_payment_payment_id(payment_id, idempotency_key, opts)
+  p result
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling PaymentsApi->recover_payment_payment_id: #{e}"
+end
+```
+
+#### Using the recover_payment_payment_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RecoverPaymentResponse>, Integer, Hash)> recover_payment_payment_id_with_http_info(payment_id, idempotency_key, opts)
+
+```ruby
+begin
+  # Recover a Payment
+  data, status_code, headers = api_instance.recover_payment_payment_id_with_http_info(payment_id, idempotency_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RecoverPaymentResponse>
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling PaymentsApi->recover_payment_payment_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_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] |
+| **recover_payment_request** | [**RecoverPaymentRequest**](RecoverPaymentRequest.md) |  | [optional] |
+
+### Return type
+
+[**RecoverPaymentResponse**](RecoverPaymentResponse.md)
+
+### Authorization
+
+[AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Person.md

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

data/docs/PlaidDetails.md

@@ -0,0 +1,20 @@
+# MelioPlatformApiClient::PlaidDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **plaid_token** | **String** | Token generated by Plaid using its client-side integration. |  |
+| **plaid_account_id** | **String** | Account ID in Plaid's system, returned in client-side. |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::PlaidDetails.new(
+  plaid_token: null,
+  plaid_account_id: null
+)
+```
+

data/docs/PostAccountsRequest.md

@@ -0,0 +1,22 @@
+# MelioPlatformApiClient::PostAccountsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the entity. | [optional] |
+| **company** | [**Company**](Company.md) |  |  |
+| **user** | [**Person**](Person.md) |  |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::PostAccountsRequest.new(
+  id: null,
+  company: null,
+  user: null
+)
+```
+

data/docs/PostAccountsResponse.md

@@ -0,0 +1,18 @@
+# MelioPlatformApiClient::PostAccountsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Account**](Account.md) |  |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::PostAccountsResponse.new(
+  data: null
+)
+```
+

data/docs/PostAuthResponse.md

@@ -0,0 +1,18 @@
+# MelioPlatformApiClient::PostAuthResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**PostAuthResponseData**](PostAuthResponseData.md) |  |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::PostAuthResponse.new(
+  data: null
+)
+```
+

data/docs/PostAuthResponseData.md

@@ -0,0 +1,22 @@
+# MelioPlatformApiClient::PostAuthResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_token** | **String** |  | [readonly] |
+| **expires_at** | **Time** |  |  |
+| **refresh_token** | **String** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::PostAuthResponseData.new(
+  access_token: null,
+  expires_at: null,
+  refresh_token: null
+)
+```
+

data/docs/PostCheckoutsCheckoutIdCaptureRequest.md

@@ -0,0 +1,22 @@
+# MelioPlatformApiClient::PostCheckoutsCheckoutIdCaptureRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **merchant_order_reference** | **String** |  |  |
+| **invoice** | [**PostCheckoutsCheckoutIdCaptureRequestInvoice**](PostCheckoutsCheckoutIdCaptureRequestInvoice.md) |  |  |
+| **amount** | **Integer** | Optional. Final amount in order's currency to actually charge for this order. Cannot be more than the original checkout's outstanding balance. | [optional] |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::PostCheckoutsCheckoutIdCaptureRequest.new(
+  merchant_order_reference: null,
+  invoice: null,
+  amount: null
+)
+```
+

data/docs/PostCheckoutsCheckoutIdCaptureRequestInvoice.md

@@ -0,0 +1,20 @@
+# MelioPlatformApiClient::PostCheckoutsCheckoutIdCaptureRequestInvoice
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_id** | **String** | Identifier of the entity. | [optional] |
+| **number** | **String** | Reference number of the invoice in Merchant's system. |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::PostCheckoutsCheckoutIdCaptureRequestInvoice.new(
+  file_id: null,
+  number: null
+)
+```
+

data/docs/PostCheckoutsCheckoutIdCompleteRequest.md

@@ -0,0 +1,24 @@
+# MelioPlatformApiClient::PostCheckoutsCheckoutIdCompleteRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **funding_source_id** | **String** | Identifier of the entity. |  |
+| **financing_token** | **String** | Optional. Obtain a financing token by request Transactional Financing. | [optional] |
+| **buyer_ip** | **String** |  | [optional] |
+| **buyer_user_agent** | **String** | Required if calling from backend on behalf of buyer | [optional] |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::PostCheckoutsCheckoutIdCompleteRequest.new(
+  funding_source_id: null,
+  financing_token: null,
+  buyer_ip: null,
+  buyer_user_agent: null
+)
+```
+

data/docs/PostCheckoutsRequest.md

@@ -0,0 +1,48 @@
+# MelioPlatformApiClient::PostCheckoutsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **line_items** | [**Array<LineItem>**](LineItem.md) |  |  |
+| **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) | List of applied gift certificates | [optional] |
+| **outstanding_balance** | **Integer** | Actual amount to charge the buyer using Melio, equals `grandTotal` minus store credit used and gift certificates applied |  |
+| **buyer** | [**CheckoutAllOfBuyer**](CheckoutAllOfBuyer.md) |  |  |
+| **return_url** | **String** |  | [optional] |
+| **company_name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::PostCheckoutsRequest.new(
+  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,
+  return_url: null,
+  company_name: null
+)
+```
+

data/docs/PostCheckoutsResponse.md

@@ -0,0 +1,18 @@
+# MelioPlatformApiClient::PostCheckoutsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Checkout**](Checkout.md) |  |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::PostCheckoutsResponse.new(
+  data: null
+)
+```
+

data/docs/PostDeliveryMethodsRequest.md

@@ -0,0 +1,20 @@
+# MelioPlatformApiClient::PostDeliveryMethodsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**DeliveryMethodType**](DeliveryMethodType.md) |  |  |
+| **details** | [**PostDeliveryMethodsRequestDetails**](PostDeliveryMethodsRequestDetails.md) |  |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::PostDeliveryMethodsRequest.new(
+  type: null,
+  details: null
+)
+```
+

data/docs/PostDeliveryMethodsRequestDetails.md

@@ -0,0 +1,53 @@
+# MelioPlatformApiClient::PostDeliveryMethodsRequestDetails
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'melio-platform-api-client'
+
+MelioPlatformApiClient::PostDeliveryMethodsRequestDetails.openapi_one_of
+# =>
+# [
+#   :'BankAccount',
+#   :'DomesticWireAccount',
+#   :'PaperCheck',
+#   :'VirtualAccount'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'melio-platform-api-client'
+
+MelioPlatformApiClient::PostDeliveryMethodsRequestDetails.build(data)
+# => #<BankAccount:0x00007fdd4aab02a0>
+
+MelioPlatformApiClient::PostDeliveryMethodsRequestDetails.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `BankAccount`
+- `DomesticWireAccount`
+- `PaperCheck`
+- `VirtualAccount`
+- `nil` (if no type matches)
+

data/docs/PostDeliveryMethodsResponse.md

@@ -0,0 +1,18 @@
+# MelioPlatformApiClient::PostDeliveryMethodsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**DeliveryMethod**](DeliveryMethod.md) |  |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::PostDeliveryMethodsResponse.new(
+  data: null
+)
+```
+