melio-platform-api-client 3.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b8d9904973609ad808daf0839b2377f19c450b3c76c91ab742fa6319eed7cfb2
+  data.tar.gz: 16da91c0839cd77702cc4d431ea81f99f51f82a0e0305b7af6daa4d008d2ba22
+SHA512:
+  metadata.gz: b5c2404d0a0519019fe0ac04346af18848ba85d6c5e4c09dd6a4387d47dd98ce9f463d0f69dad42bb7e4715fb4e69e1ce4b5a694aeff2802c0d7784f8f11adcd
+  data.tar.gz: 8e035a1c28620b1601f07fc603a84b62930aa61ad894f7580d594de427245dadc00c51a26d5aa7eb3ea2210282f32e51ef40404abd91a3cf39b9b0f954d8bd37

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,132 @@
+# Melio Platform API Ruby Client Library
+
+Melio Platform API enables partners to perform partner-related operations in Melio's system, for themselves, and on behalf of their system's users.
+
+Developers can use this OpenAPI based client library in order to send API requests to Melio Platform API.
+
+Refer to our [API Reference](https://docs.melio.com/docs/api-ref/YXBpOjM0ODE4MDA4-platform-api) for further information.
+
+## Getting started
+
+### Installation
+
+Add the following in the Gemfile:
+
+```
+gem 'melio-platform-api-client', :git => 'https://github.com/melio/melio-platform-api-client-ruby.git', :tag => 'v1.0.1'
+```
+
+Change `:tag => 'v1.0.1` to the version you need.
+
+### Setup
+
+Before using the library, you need to load and configure it with the relevant parameters:
+
+1. The host and base URL, which represent the environment you want to work with.
+2. Your credentials, which are usually the Partner secret provided during onboarding, set as a `API-Key` header.
+
+```ruby
+# Load the gem
+require 'melio-platform-api-client'
+
+# Setup
+MelioPlatformApiClient.configure do |config|
+  # Configure host
+  config.host = 'api-sandbox.melio.com'
+  
+  # Optionally toggle debugging
+  # config.debugging = true
+  
+  # Configure API key authorization: API-Key
+  config.api_key['ApiKey'] = 'YOUR API KEY'
+end
+```
+
+### Send an API request
+
+Once everything is configured properly, initialize one of the `*Api` modules in you application, and invoke one of the available functions.
+The functions in each module represent the API operations, as they appear in our [API Reference](https://docs.melio.com/docs/api-ref/YXBpOjM0ODE4MDA4-platform-api).
+
+```ruby
+api_instance = MelioPlatformApiClient::AccountsApi.new
+
+begin
+  #Retrieve all Accounts
+  result = api_instance.get_accounts
+  p result
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Exception when calling AccountsApi->get_accounts: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.melio.com/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*MelioPlatformApiClient::AccountsApi* | [**get_accounts**](docs/AccountsApi.md#get_accounts) | **GET** /accounts | Retrieve all Accounts
+*MelioPlatformApiClient::AccountsApi* | [**get_accounts_account_id**](docs/AccountsApi.md#get_accounts_account_id) | **GET** /accounts/{accountId} | Retrieve an Account
+*MelioPlatformApiClient::AccountsApi* | [**post_accounts**](docs/AccountsApi.md#post_accounts) | **POST** /accounts | Create an Account
+*MelioPlatformApiClient::AuthApi* | [**post_auth_token**](docs/AuthApi.md#post_auth_token) | **POST** /auth/token | Create an access token
+*MelioPlatformApiClient::ChargesApi* | [**delete_charges_charge_id**](docs/ChargesApi.md#delete_charges_charge_id) | **DELETE** /charges/{chargeId} | Delete a Charge
+*MelioPlatformApiClient::ChargesApi* | [**get_charges_charge_id**](docs/ChargesApi.md#get_charges_charge_id) | **GET** /charges/{chargeId} | Retrieve a Charge
+*MelioPlatformApiClient::ChargesApi* | [**get_merchants_merchant_id_charges**](docs/ChargesApi.md#get_merchants_merchant_id_charges) | **GET** /merchants/{merchantId}/charges | Retrieve all Charges
+*MelioPlatformApiClient::ChargesApi* | [**patch_charges_charge_id**](docs/ChargesApi.md#patch_charges_charge_id) | **PATCH** /charges/{chargeId} | Update a Charge
+*MelioPlatformApiClient::CheckoutsApi* | [**get_checkouts_checkout_id**](docs/CheckoutsApi.md#get_checkouts_checkout_id) | **GET** /checkouts/{checkoutId} | Retrieve a Checkout
+*MelioPlatformApiClient::CheckoutsApi* | [**post_checkouts**](docs/CheckoutsApi.md#post_checkouts) | **POST** /merchants/{merchantId}/checkouts | Create a Checkout
+*MelioPlatformApiClient::CheckoutsApi* | [**post_checkouts_checkout_id_capture**](docs/CheckoutsApi.md#post_checkouts_checkout_id_capture) | **POST** /checkouts/{checkoutId}/capture | Capture a Checkout
+*MelioPlatformApiClient::CheckoutsApi* | [**post_checkouts_checkout_id_complete**](docs/CheckoutsApi.md#post_checkouts_checkout_id_complete) | **POST** /checkouts/{checkoutId}/complete | Complete a Checkout
+*MelioPlatformApiClient::DeliveryMethodsApi* | [**delete_delivery_methods_delivery_method_id**](docs/DeliveryMethodsApi.md#delete_delivery_methods_delivery_method_id) | **DELETE** /delivery-methods/{deliveryMethodId} | Delete a Delivery Method
+*MelioPlatformApiClient::DeliveryMethodsApi* | [**get_delivery_methods**](docs/DeliveryMethodsApi.md#get_delivery_methods) | **GET** /delivery-methods | Retrieve all Delivery Methods
+*MelioPlatformApiClient::DeliveryMethodsApi* | [**get_delivery_methods_delivery_method_id**](docs/DeliveryMethodsApi.md#get_delivery_methods_delivery_method_id) | **GET** /delivery-methods/{deliveryMethodId} | Retrieve a Delivery Method
+*MelioPlatformApiClient::DeliveryMethodsApi* | [**get_vendors_vendor_id_delivery_methods**](docs/DeliveryMethodsApi.md#get_vendors_vendor_id_delivery_methods) | **GET** /vendors/{vendorId}/delivery-methods | Retrieve a Vendor's Delivery Methods
+*MelioPlatformApiClient::DeliveryMethodsApi* | [**post_delivery_methods**](docs/DeliveryMethodsApi.md#post_delivery_methods) | **POST** /delivery-methods | Create a Delivery Method
+*MelioPlatformApiClient::DeliveryMethodsApi* | [**post_vendors_vendor_id_delivery_methods**](docs/DeliveryMethodsApi.md#post_vendors_vendor_id_delivery_methods) | **POST** /vendors/{vendorId}/delivery-methods | Create a Vendor's Delivery Method
+*MelioPlatformApiClient::FilesApi* | [**get_files**](docs/FilesApi.md#get_files) | **GET** /files | Retrieve files
+*MelioPlatformApiClient::FilesApi* | [**get_files_file_id**](docs/FilesApi.md#get_files_file_id) | **GET** /files/{fileId} | Retrieve a File
+*MelioPlatformApiClient::FilesApi* | [**get_files_file_id_data**](docs/FilesApi.md#get_files_file_id_data) | **GET** /files/{fileId}/data | Retrieve data from a File using OCR
+*MelioPlatformApiClient::FilesApi* | [**post_files**](docs/FilesApi.md#post_files) | **POST** /files | Create / upload a File
+*MelioPlatformApiClient::FinancingApi* | [**get_financing_status**](docs/FinancingApi.md#get_financing_status) | **GET** /financing | Retrieve an Account's financing status
+*MelioPlatformApiClient::FinancingApi* | [**post_financing**](docs/FinancingApi.md#post_financing) | **POST** /financing | Apply for financing for an Account
+*MelioPlatformApiClient::FinancingApi* | [**post_financing_transaction**](docs/FinancingApi.md#post_financing_transaction) | **POST** /financing/transaction | Request Transactional Financing
+*MelioPlatformApiClient::FundingSourcesApi* | [**delete_funding_sources_funding_source_id**](docs/FundingSourcesApi.md#delete_funding_sources_funding_source_id) | **DELETE** /funding-sources/{fundingSourceId} | Delete a Funding Source
+*MelioPlatformApiClient::FundingSourcesApi* | [**get_funding_sources**](docs/FundingSourcesApi.md#get_funding_sources) | **GET** /funding-sources | Get all Funding Sources
+*MelioPlatformApiClient::FundingSourcesApi* | [**get_funding_sources_funding_source_id**](docs/FundingSourcesApi.md#get_funding_sources_funding_source_id) | **GET** /funding-sources/{fundingSourceId} | Retrieve a Funding Source
+*MelioPlatformApiClient::FundingSourcesApi* | [**post_funding_sources**](docs/FundingSourcesApi.md#post_funding_sources) | **POST** /funding-sources | Create a Funding Source
+*MelioPlatformApiClient::MerchantsApi* | [**post_merchants**](docs/MerchantsApi.md#post_merchants) | **POST** /merchants | Create a Merchant
+*MelioPlatformApiClient::PaymentIntentsApi* | [**get_payment_intents**](docs/PaymentIntentsApi.md#get_payment_intents) | **GET** /payment-intents | Retrieve all Payment Intents
+*MelioPlatformApiClient::PaymentIntentsApi* | [**get_payment_intents_payment_intent_id**](docs/PaymentIntentsApi.md#get_payment_intents_payment_intent_id) | **GET** /payment-intents/{paymentIntentId} | Retrieve a Payment Intent
+*MelioPlatformApiClient::PaymentIntentsApi* | [**patch_payment_intents_payment_intent_id**](docs/PaymentIntentsApi.md#patch_payment_intents_payment_intent_id) | **PATCH** /payment-intents/{paymentIntentId} | Update a Payment Intent
+*MelioPlatformApiClient::PaymentIntentsApi* | [**post_payment_intents**](docs/PaymentIntentsApi.md#post_payment_intents) | **POST** /payment-intents | Create a Payment Intent
+*MelioPlatformApiClient::PaymentIntentsApi* | [**post_payment_intents_bulk**](docs/PaymentIntentsApi.md#post_payment_intents_bulk) | **POST** /payment-intents/bulk | Create multiple Payment Intents
+*MelioPlatformApiClient::PaymentIntentsApi* | [**post_payment_intents_payment_intent_id_confirm**](docs/PaymentIntentsApi.md#post_payment_intents_payment_intent_id_confirm) | **POST** /payment-intents/{paymentIntentId}/confirm | Confirm a Payment Intent
+*MelioPlatformApiClient::PaymentsApi* | [**delete_payments_payment_id**](docs/PaymentsApi.md#delete_payments_payment_id) | **DELETE** /payments/{paymentId} | Delete a Payment
+*MelioPlatformApiClient::PaymentsApi* | [**get_payments**](docs/PaymentsApi.md#get_payments) | **GET** /payments | Retrieve all Payments of a PaymentIntent
+*MelioPlatformApiClient::PaymentsApi* | [**get_payments_payment_id**](docs/PaymentsApi.md#get_payments_payment_id) | **GET** /payments/{paymentId} | Retrieve a Payment
+*MelioPlatformApiClient::PaymentsApi* | [**recover_payment_payment_id**](docs/PaymentsApi.md#recover_payment_payment_id) | **POST** /payments/{paymentId}/recover | Recover a Payment
+*MelioPlatformApiClient::VendorDirectoryApi* | [**get_vendor_directory**](docs/VendorDirectoryApi.md#get_vendor_directory) | **GET** /vendor-directory | Retrieve all filtered Vendors in the Vendor Directory
+*MelioPlatformApiClient::VendorDirectoryApi* | [**post_vendors_from_vendor_directory**](docs/VendorDirectoryApi.md#post_vendors_from_vendor_directory) | **POST** /vendors/from-vendor-directory | Create a Vendor from Vendor Directory
+*MelioPlatformApiClient::VendorsApi* | [**delete_vendors_vendor_id**](docs/VendorsApi.md#delete_vendors_vendor_id) | **DELETE** /vendors/{vendorId} | Delete a Vendor
+*MelioPlatformApiClient::VendorsApi* | [**get_vendor_directory**](docs/VendorsApi.md#get_vendor_directory) | **GET** /vendor-directory | Retrieve all filtered Vendors in the Vendor Directory
+*MelioPlatformApiClient::VendorsApi* | [**get_vendors**](docs/VendorsApi.md#get_vendors) | **GET** /vendors | Retrieve all Vendors
+*MelioPlatformApiClient::VendorsApi* | [**get_vendors_vendor_id**](docs/VendorsApi.md#get_vendors_vendor_id) | **GET** /vendors/{vendorId} | Retrieve a Vendor
+*MelioPlatformApiClient::VendorsApi* | [**get_vendors_vendor_id_delivery_methods**](docs/VendorsApi.md#get_vendors_vendor_id_delivery_methods) | **GET** /vendors/{vendorId}/delivery-methods | Retrieve a Vendor's Delivery Methods
+*MelioPlatformApiClient::VendorsApi* | [**patch_vendors_vendor_id**](docs/VendorsApi.md#patch_vendors_vendor_id) | **PATCH** /vendors/{vendorId} | Update a Vendor
+*MelioPlatformApiClient::VendorsApi* | [**post_vendors**](docs/VendorsApi.md#post_vendors) | **POST** /vendors | Create a Vendor
+*MelioPlatformApiClient::VendorsApi* | [**post_vendors_bulk**](docs/VendorsApi.md#post_vendors_bulk) | **POST** /vendors/bulk | Create multiple Vendors
+*MelioPlatformApiClient::VendorsApi* | [**post_vendors_from_vendor_directory**](docs/VendorsApi.md#post_vendors_from_vendor_directory) | **POST** /vendors/from-vendor-directory | Create a Vendor from Vendor Directory
+*MelioPlatformApiClient::VendorsApi* | [**post_vendors_vendor_id_delivery_methods**](docs/VendorsApi.md#post_vendors_vendor_id_delivery_methods) | **POST** /vendors/{vendorId}/delivery-methods | Create a Vendor's Delivery Method
+*MelioPlatformApiClient::WebhooksApi* | [**delete_webhooks_checkouts**](docs/WebhooksApi.md#delete_webhooks_checkouts) | **DELETE** /webhooks/checkouts | Delete the Webhook for Checkouts
+*MelioPlatformApiClient::WebhooksApi* | [**delete_webhooks_payments**](docs/WebhooksApi.md#delete_webhooks_payments) | **DELETE** /webhooks/payments | Delete the Webhook for Payments
+*MelioPlatformApiClient::WebhooksApi* | [**get_webhooks**](docs/WebhooksApi.md#get_webhooks) | **GET** /webhooks | Retrieve all Webhooks
+*MelioPlatformApiClient::WebhooksApi* | [**get_webhooks_checkouts**](docs/WebhooksApi.md#get_webhooks_checkouts) | **GET** /webhooks/checkouts | Retrieve Status of Webhook for Checkouts
+*MelioPlatformApiClient::WebhooksApi* | [**get_webhooks_payments**](docs/WebhooksApi.md#get_webhooks_payments) | **GET** /webhooks/payments | Retrieve Status of Webhook for Payments
+*MelioPlatformApiClient::WebhooksApi* | [**post_webhooks_checkouts**](docs/WebhooksApi.md#post_webhooks_checkouts) | **POST** /webhooks/checkouts | Register a Webhook for Checkouts
+*MelioPlatformApiClient::WebhooksApi* | [**post_webhooks_payments**](docs/WebhooksApi.md#post_webhooks_payments) | **POST** /webhooks/payments | Register a Webhook for Payments
+
+
+## Support
+
+For more information, please contact [api-support@melio.com](mailto:api-support@melio.com).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/Account.md

@@ -0,0 +1,26 @@
+# MelioPlatformApiClient::Account
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the entity. |  |
+| **history** | [**ShortHistory**](ShortHistory.md) |  |  |
+| **company** | [**Company**](Company.md) |  |  |
+| **user** | [**Person**](Person.md) |  |  |
+| **status** | **String** | Holds the eligibility of the account to make payments |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::Account.new(
+  id: null,
+  history: null,
+  company: null,
+  user: null,
+  status: pending
+)
+```
+

data/docs/AccountAllOf.md

@@ -0,0 +1,22 @@
+# MelioPlatformApiClient::AccountAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company** | [**Company**](Company.md) |  |  |
+| **user** | [**Person**](Person.md) |  |  |
+| **status** | **String** | Holds the eligibility of the account to make payments |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::AccountAllOf.new(
+  company: null,
+  user: null,
+  status: pending
+)
+```
+

data/docs/AccountsApi.md

@@ -0,0 +1,224 @@
+# MelioPlatformApiClient::AccountsApi
+
+All URIs are relative to *https://api.melio.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_accounts**](AccountsApi.md#get_accounts) | **GET** /accounts | Retrieve all Accounts |
+| [**get_accounts_account_id**](AccountsApi.md#get_accounts_account_id) | **GET** /accounts/{accountId} | Retrieve an Account |
+| [**post_accounts**](AccountsApi.md#post_accounts) | **POST** /accounts | Create an Account |
+
+
+## get_accounts
+
+> <GetAccountsResponse> get_accounts
+
+Retrieve all Accounts
+
+Retrieve a list of all Accounts the current Partner manages
+
+### 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::AccountsApi.new
+
+begin
+  # Retrieve all Accounts
+  result = api_instance.get_accounts
+  p result
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling AccountsApi->get_accounts: #{e}"
+end
+```
+
+#### Using the get_accounts_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetAccountsResponse>, Integer, Hash)> get_accounts_with_http_info
+
+```ruby
+begin
+  # Retrieve all Accounts
+  data, status_code, headers = api_instance.get_accounts_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetAccountsResponse>
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling AccountsApi->get_accounts_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetAccountsResponse**](GetAccountsResponse.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_accounts_account_id
+
+> <GetAccountsAccountIdResponse> get_accounts_account_id(account_id)
+
+Retrieve an Account
+
+Retrieve an Account using its ID
+
+### 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::AccountsApi.new
+account_id = 'account_id_example' # String | 
+
+begin
+  # Retrieve an Account
+  result = api_instance.get_accounts_account_id(account_id)
+  p result
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling AccountsApi->get_accounts_account_id: #{e}"
+end
+```
+
+#### Using the get_accounts_account_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetAccountsAccountIdResponse>, Integer, Hash)> get_accounts_account_id_with_http_info(account_id)
+
+```ruby
+begin
+  # Retrieve an Account
+  data, status_code, headers = api_instance.get_accounts_account_id_with_http_info(account_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetAccountsAccountIdResponse>
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling AccountsApi->get_accounts_account_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** |  |  |
+
+### Return type
+
+[**GetAccountsAccountIdResponse**](GetAccountsAccountIdResponse.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## post_accounts
+
+> <PostAccountsResponse> post_accounts(idempotency_key, opts)
+
+Create an Account
+
+Create an Account with a company and a user.  Note that you can submit a Partern internal ID in the ID `id` field, in order to set it in Melio system as well. If not supplied, a random ID will be generated.
+
+### 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::AccountsApi.new
+idempotency_key = 'idempotency_key_example' # String | Unique idempotency key
+opts = {
+  post_accounts_request: MelioPlatformApiClient::PostAccountsRequest.new({company: MelioPlatformApiClient::Company.new({name: 'name_example', phone_number: 'phone_number_example', address: MelioPlatformApiClient::Address.new({line1: 'line1_example', city: 'city_example', state: 'state_example', postal_code: 'postal_code_example'}), legal_name: 'legal_name_example', tax_info: MelioPlatformApiClient::TaxInfo.new({identifier: 'identifier_example', type: 'SSN'}), legal_address: MelioPlatformApiClient::Address.new({line1: 'line1_example', city: 'city_example', state: 'state_example', postal_code: 'postal_code_example'})}), user: MelioPlatformApiClient::Person.new({first_name: 'first_name_example', last_name: 'last_name_example', email: 'email_example'})}) # PostAccountsRequest | 
+}
+
+begin
+  # Create an Account
+  result = api_instance.post_accounts(idempotency_key, opts)
+  p result
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling AccountsApi->post_accounts: #{e}"
+end
+```
+
+#### Using the post_accounts_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PostAccountsResponse>, Integer, Hash)> post_accounts_with_http_info(idempotency_key, opts)
+
+```ruby
+begin
+  # Create an Account
+  data, status_code, headers = api_instance.post_accounts_with_http_info(idempotency_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PostAccountsResponse>
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling AccountsApi->post_accounts_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **idempotency_key** | **String** | Unique idempotency key |  |
+| **post_accounts_request** | [**PostAccountsRequest**](PostAccountsRequest.md) |  | [optional] |
+
+### Return type
+
+[**PostAccountsResponse**](PostAccountsResponse.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/AddToMyVendorParameters.md

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

data/docs/AddToMyVendorParametersDeliveryMethod.md

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

data/docs/AddToMyVendorParametersDeliveryMethodBillerAccount.md

@@ -0,0 +1,18 @@
+# MelioPlatformApiClient::AddToMyVendorParametersDeliveryMethodBillerAccount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_identifier** | **String** | This is your biller account identifier that the DM will be created |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::AddToMyVendorParametersDeliveryMethodBillerAccount.new(
+  account_identifier: 0003000666
+)
+```
+

data/docs/Address.md

@@ -0,0 +1,26 @@
+# MelioPlatformApiClient::Address
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **line1** | **String** | Note that this field must be authentic (e.g. `Q Calle 11`). |  |
+| **line2** | **String** |  | [optional] |
+| **city** | **String** |  |  |
+| **state** | **String** | State two-letter symbol. |  |
+| **postal_code** | **String** | 5 digits postal (ZIP) code. |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::Address.new(
+  line1: null,
+  line2: null,
+  city: null,
+  state: null,
+  postal_code: null
+)
+```
+

data/docs/Adjustment.md

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

data/docs/AuthApi.md

@@ -0,0 +1,83 @@
+# MelioPlatformApiClient::AuthApi
+
+All URIs are relative to *https://api.melio.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**post_auth_token**](AuthApi.md#post_auth_token) | **POST** /auth/token | Create an access token |
+
+
+## post_auth_token
+
+> <PostAuthResponse> post_auth_token(idempotency_key, opts)
+
+Create an access token
+
+Create an access token that is scoped to a specific Account, and that can be used for client-side API calls. This is used to perform operations that require the user's involvment, without exposing the Partner's secret API key.
+
+### 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::AuthApi.new
+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
+  # Create an access token
+  result = api_instance.post_auth_token(idempotency_key, opts)
+  p result
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling AuthApi->post_auth_token: #{e}"
+end
+```
+
+#### Using the post_auth_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PostAuthResponse>, Integer, Hash)> post_auth_token_with_http_info(idempotency_key, opts)
+
+```ruby
+begin
+  # Create an access token
+  data, status_code, headers = api_instance.post_auth_token_with_http_info(idempotency_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PostAuthResponse>
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling AuthApi->post_auth_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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
+
+[**PostAuthResponse**](PostAuthResponse.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/BankAccount.md

@@ -0,0 +1,22 @@
+# MelioPlatformApiClient::BankAccount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **routing_number** | **String** | Routing numbers are 9 digits long. |  |
+| **account_type** | [**BankAccountType**](BankAccountType.md) |  |  |
+| **account_number** | **String** | Account numbers are 4-17 digits long |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::BankAccount.new(
+  routing_number: null,
+  account_type: null,
+  account_number: null
+)
+```
+

data/docs/BankAccountType.md

@@ -0,0 +1,15 @@
+# MelioPlatformApiClient::BankAccountType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::BankAccountType.new()
+```
+