melio-platform-api-client 3.0.1

data/docs/PostWebhooksPaymentsRequest.md

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

data/docs/PostWebhooksPaymentsResponse.md

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

data/docs/PutPaymentIntentsRequest.md

@@ -0,0 +1,36 @@
+# MelioPlatformApiClient::PutPaymentIntentsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | This is your bill's amount | [optional] |
+| **payment_amount** | **Float** | This is the desired payment amount | [optional] |
+| **schedule_date** | **Time** |  | [optional] |
+| **funding_source_id** | **String** |  | [optional] |
+| **delivery_method_id** | **String** |  | [optional] |
+| **delivery_preference** | [**DeliveryPreference**](DeliveryPreference.md) |  | [optional] |
+| **invoice_number** | **String** |  | [optional] |
+| **vendor_id** | **String** | Identifier of the entity. | [optional] |
+| **due_date** | **Time** |  | [optional] |
+| **note** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::PutPaymentIntentsRequest.new(
+  amount: 200,
+  payment_amount: 50,
+  schedule_date: null,
+  funding_source_id: null,
+  delivery_method_id: null,
+  delivery_preference: null,
+  invoice_number: 2000,
+  vendor_id: null,
+  due_date: null,
+  note: null
+)
+```
+

data/docs/PutPaymentIntentsResponse.md

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

data/docs/RecoverPaymentRequest.md

@@ -0,0 +1,36 @@
+# MelioPlatformApiClient::RecoverPaymentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | This is your bill's amount | [optional] |
+| **payment_amount** | **Float** | This is the desired payment amount | [optional] |
+| **schedule_date** | **Time** |  | [optional] |
+| **funding_source_id** | **String** |  | [optional] |
+| **delivery_method_id** | **String** |  | [optional] |
+| **delivery_preference** | [**DeliveryPreference**](DeliveryPreference.md) |  | [optional] |
+| **invoice_number** | **String** |  | [optional] |
+| **vendor_id** | **String** | Identifier of the entity. | [optional] |
+| **due_date** | **Time** |  | [optional] |
+| **note** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::RecoverPaymentRequest.new(
+  amount: 200,
+  payment_amount: 50,
+  schedule_date: null,
+  funding_source_id: null,
+  delivery_method_id: null,
+  delivery_preference: null,
+  invoice_number: 2000,
+  vendor_id: null,
+  due_date: null,
+  note: null
+)
+```
+

data/docs/RecoverPaymentResponse.md

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

data/docs/ShortHistory.md

@@ -0,0 +1,22 @@
+# MelioPlatformApiClient::ShortHistory
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+| **deleted_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::ShortHistory.new(
+  created_at: null,
+  updated_at: null,
+  deleted_at: null
+)
+```
+

data/docs/TabaPayDetails.md

@@ -0,0 +1,30 @@
+# MelioPlatformApiClient::TabaPayDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tabapay_token** | **String** |  |  |
+| **card_bin** | **String** |  |  |
+| **expiration_month** | **String** | Two-digits month (e.g. `01` or `11`) |  |
+| **expiration_year** | **String** | Four-digits year (e.g. `2024`). |  |
+| **card_owner** | [**TabaPayDetailsCardOwner**](TabaPayDetailsCardOwner.md) |  |  |
+| **last_four_digits** | **String** | LAst four digits of a payment card. |  |
+| **address** | [**Address**](Address.md) |  |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::TabaPayDetails.new(
+  tabapay_token: null,
+  card_bin: null,
+  expiration_month: null,
+  expiration_year: null,
+  card_owner: null,
+  last_four_digits: null,
+  address: null
+)
+```
+

data/docs/TabaPayDetailsCardOwner.md

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

data/docs/TaxInfo.md

@@ -0,0 +1,20 @@
+# MelioPlatformApiClient::TaxInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identifier** | **String** | A string with 9 digits. Can be in one of three formats: * NNNNNNNNN * NNN-NN-NNNN * NN-NNNNNNN |  |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::TaxInfo.new(
+  identifier: null,
+  type: null
+)
+```
+

data/docs/Vendor.md

@@ -0,0 +1,26 @@
+# MelioPlatformApiClient::Vendor
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the entity. |  |
+| **history** | [**ShortHistory**](ShortHistory.md) |  |  |
+| **name** | **String** | The (company) name of the Vendor as a business entity. |  |
+| **contact** | [**VendorAllOfContact**](VendorAllOfContact.md) |  |  |
+| **delivery_methods** | [**Array<DeliveryMethod>**](DeliveryMethod.md) |  |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::Vendor.new(
+  id: null,
+  history: null,
+  name: null,
+  contact: null,
+  delivery_methods: null
+)
+```
+

data/docs/VendorAllOf.md

@@ -0,0 +1,22 @@
+# MelioPlatformApiClient::VendorAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The (company) name of the Vendor as a business entity. |  |
+| **contact** | [**VendorAllOfContact**](VendorAllOfContact.md) |  |  |
+| **delivery_methods** | [**Array<DeliveryMethod>**](DeliveryMethod.md) |  |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::VendorAllOf.new(
+  name: null,
+  contact: null,
+  delivery_methods: null
+)
+```
+

data/docs/VendorAllOfContact.md

@@ -0,0 +1,22 @@
+# MelioPlatformApiClient::VendorAllOfContact
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Full name of the Vendor's main contact. |  |
+| **email** | **String** |  |  |
+| **phone_number** | **String** | Holds a phone number - the format is flexible as is determined according to usage. For testing you can use `123123122`. |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::VendorAllOfContact.new(
+  name: null,
+  email: null,
+  phone_number: null
+)
+```
+

data/docs/VendorDirectory.md

@@ -0,0 +1,26 @@
+# MelioPlatformApiClient::VendorDirectory
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **delivery_methods** | [**Array<VendorDirectoryDeliveryMethod>**](VendorDirectoryDeliveryMethod.md) |  |  |
+| **addresses** | [**Array<Address>**](Address.md) |  |  |
+| **contact** | [**VendorDirectoryContact**](VendorDirectoryContact.md) |  |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::VendorDirectory.new(
+  id: null,
+  name: null,
+  delivery_methods: null,
+  addresses: null,
+  contact: null
+)
+```
+

data/docs/VendorDirectoryApi.md

@@ -0,0 +1,169 @@
+# MelioPlatformApiClient::VendorDirectoryApi
+
+All URIs are relative to *https://api.melio.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_vendor_directory**](VendorDirectoryApi.md#get_vendor_directory) | **GET** /vendor-directory | Retrieve all filtered Vendors in the Vendor Directory |
+| [**post_vendors_from_vendor_directory**](VendorDirectoryApi.md#post_vendors_from_vendor_directory) | **POST** /vendors/from-vendor-directory | Create a Vendor from Vendor Directory |
+
+
+## get_vendor_directory
+
+> <GetVendorDirectoryResponse> get_vendor_directory(name, opts)
+
+Retrieve all filtered Vendors in the Vendor Directory
+
+List of all Vendors in the Vendor Directory, filtered by the name parameter and with provided query limit (default 20).
+
+### 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::VendorDirectoryApi.new
+name = 'name_example' # String | The name of the Vendor to query
+opts = {
+  limit: 56, # Integer | The number of items to include in the returned list
+  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 filtered Vendors in the Vendor Directory
+  result = api_instance.get_vendor_directory(name, opts)
+  p result
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling VendorDirectoryApi->get_vendor_directory: #{e}"
+end
+```
+
+#### Using the get_vendor_directory_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetVendorDirectoryResponse>, Integer, Hash)> get_vendor_directory_with_http_info(name, opts)
+
+```ruby
+begin
+  # Retrieve all filtered Vendors in the Vendor Directory
+  data, status_code, headers = api_instance.get_vendor_directory_with_http_info(name, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetVendorDirectoryResponse>
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling VendorDirectoryApi->get_vendor_directory_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the Vendor to query |  |
+| **limit** | **Integer** | The number of items to include in the returned list | [optional][default to 20] |
+| **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
+
+[**GetVendorDirectoryResponse**](GetVendorDirectoryResponse.md)
+
+### Authorization
+
+[AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## post_vendors_from_vendor_directory
+
+> <PostVendorsFromVendorDirectoryResponse> post_vendors_from_vendor_directory(idempotency_key, opts)
+
+Create a Vendor from Vendor Directory
+
+Add a specific Vendor from Vendor Directory by its ID to an Account, and clone its Delivery Method in case of biller account.
+
+### 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::VendorDirectoryApi.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.
+  post_vendors_from_vendor_directory_request: MelioPlatformApiClient::PostVendorsFromVendorDirectoryRequest.new({vendor_directory_id: 'vendor_directory_id_example'}) # PostVendorsFromVendorDirectoryRequest | 
+}
+
+begin
+  # Create a Vendor from Vendor Directory
+  result = api_instance.post_vendors_from_vendor_directory(idempotency_key, opts)
+  p result
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling VendorDirectoryApi->post_vendors_from_vendor_directory: #{e}"
+end
+```
+
+#### Using the post_vendors_from_vendor_directory_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PostVendorsFromVendorDirectoryResponse>, Integer, Hash)> post_vendors_from_vendor_directory_with_http_info(idempotency_key, opts)
+
+```ruby
+begin
+  # Create a Vendor from Vendor Directory
+  data, status_code, headers = api_instance.post_vendors_from_vendor_directory_with_http_info(idempotency_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PostVendorsFromVendorDirectoryResponse>
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling VendorDirectoryApi->post_vendors_from_vendor_directory_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] |
+| **post_vendors_from_vendor_directory_request** | [**PostVendorsFromVendorDirectoryRequest**](PostVendorsFromVendorDirectoryRequest.md) |  | [optional] |
+
+### Return type
+
+[**PostVendorsFromVendorDirectoryResponse**](PostVendorsFromVendorDirectoryResponse.md)
+
+### Authorization
+
+[AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/VendorDirectoryContact.md

@@ -0,0 +1,24 @@
+# MelioPlatformApiClient::VendorDirectoryContact
+
+## 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** |  |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::VendorDirectoryContact.new(
+  first_name: null,
+  last_name: null,
+  phone_number: null,
+  email: null
+)
+```
+

data/docs/VendorDirectoryDeliveryMethod.md

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

data/docs/VendorDirectoryNotFoundResponse.md

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