melio-platform-api-client 3.0.1

data/docs/GetFundingSourcesFundingSourceIdResponse.md

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

data/docs/GetFundingSourcesResponse.md

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

data/docs/GetPaymentIntentsPaymentIntentIdResponse.md

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

data/docs/GetPaymentIntentsResponse.md

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

data/docs/GetPaymentsPaymentIdResponse.md

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

data/docs/GetPaymentsResponse.md

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

data/docs/GetVendorDirectoryResponse.md

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

data/docs/GetVendorsResponse.md

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

data/docs/GetVendorsVendorIdDeliveryMethodsResponse.md

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

data/docs/GetVendorsVendorIdResponse.md

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

data/docs/GetWebhooksCheckoutsResponse.md

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

data/docs/GetWebhooksPaymentsResponse.md

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

data/docs/GetWebhooksResponse.md

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

data/docs/Invoice.md

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

data/docs/LineItem.md

@@ -0,0 +1,30 @@
+# MelioPlatformApiClient::LineItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the item |  |
+| **description** | **String** | Description of the item | [optional] |
+| **sku** | **String** | Stock keeping unit code | [optional] |
+| **unit_price** | **Integer** |  | [optional] |
+| **quantity** | **Integer** | Item quantity | [optional] |
+| **total_price** | **Integer** |  |  |
+| **image_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::LineItem.new(
+  name: Yavor office chair,
+  description: Ergonomic chair with neck support,
+  sku: U10001,
+  unit_price: null,
+  quantity: 2,
+  total_price: null,
+  image_url: null
+)
+```
+

data/docs/Merchant.md

@@ -0,0 +1,38 @@
+# MelioPlatformApiClient::Merchant
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the entity. |  |
+| **history** | [**ShortHistory**](ShortHistory.md) |  |  |
+| **address** | [**PartialAddress**](PartialAddress.md) |  | [optional] |
+| **logo_file_id** | **String** | Identifier of the entity. | [optional] |
+| **display_name** | **String** |  | [optional] |
+| **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] |
+| **net_terms** | **Integer** |  |  |
+| **website_url** | **String** |  | [optional] |
+| **tos_url** | **String** |  | [optional] |
+| **mcc_code** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::Merchant.new(
+  id: null,
+  history: null,
+  address: null,
+  logo_file_id: null,
+  display_name: null,
+  phone_number: null,
+  email: null,
+  net_terms: null,
+  website_url: null,
+  tos_url: null,
+  mcc_code: null
+)
+```
+

data/docs/MerchantAllOf.md

@@ -0,0 +1,34 @@
+# MelioPlatformApiClient::MerchantAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | [**PartialAddress**](PartialAddress.md) |  | [optional] |
+| **logo_file_id** | **String** | Identifier of the entity. | [optional] |
+| **display_name** | **String** |  | [optional] |
+| **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] |
+| **net_terms** | **Integer** |  |  |
+| **website_url** | **String** |  | [optional] |
+| **tos_url** | **String** |  | [optional] |
+| **mcc_code** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::MerchantAllOf.new(
+  address: null,
+  logo_file_id: null,
+  display_name: null,
+  phone_number: null,
+  email: null,
+  net_terms: null,
+  website_url: null,
+  tos_url: null,
+  mcc_code: null
+)
+```
+

data/docs/MerchantsApi.md

@@ -0,0 +1,85 @@
+# MelioPlatformApiClient::MerchantsApi
+
+All URIs are relative to *https://api.melio.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**post_merchants**](MerchantsApi.md#post_merchants) | **POST** /merchants | Create a Merchant |
+
+
+## post_merchants
+
+> <PostMerchantsResponse> post_merchants(idempotency_key, opts)
+
+Create a Merchant
+
+Create a new Merchant for 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::MerchantsApi.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_merchants_request: MelioPlatformApiClient::PostMerchantsRequest.new # PostMerchantsRequest | 
+}
+
+begin
+  # Create a Merchant
+  result = api_instance.post_merchants(idempotency_key, opts)
+  p result
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling MerchantsApi->post_merchants: #{e}"
+end
+```
+
+#### Using the post_merchants_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PostMerchantsResponse>, Integer, Hash)> post_merchants_with_http_info(idempotency_key, opts)
+
+```ruby
+begin
+  # Create a Merchant
+  data, status_code, headers = api_instance.post_merchants_with_http_info(idempotency_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PostMerchantsResponse>
+rescue MelioPlatformApiClient::ApiError => e
+  puts "Error when calling MerchantsApi->post_merchants_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_merchants_request** | [**PostMerchantsRequest**](PostMerchantsRequest.md) |  | [optional] |
+
+### Return type
+
+[**PostMerchantsResponse**](PostMerchantsResponse.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ModelError.md

@@ -0,0 +1,22 @@
+# MelioPlatformApiClient::ModelError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  |  |
+| **message** | **String** |  |  |
+| **data** | [**OneOfobjectarray**](OneOfobjectarray.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::ModelError.new(
+  code: null,
+  message: null,
+  data: null
+)
+```
+

data/docs/ModelErrorAllOf.md

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

data/docs/Object.md

@@ -0,0 +1,20 @@
+# MelioPlatformApiClient::Object
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the entity. |  |
+| **history** | [**ShortHistory**](ShortHistory.md) |  |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::Object.new(
+  id: null,
+  history: null
+)
+```
+

data/docs/PaperCheck.md

@@ -0,0 +1,20 @@
+# MelioPlatformApiClient::PaperCheck
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **print_name** | **String** | The receiver's full name to be printed. |  |
+| **address** | [**Address**](Address.md) |  |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::PaperCheck.new(
+  print_name: null,
+  address: null
+)
+```
+

data/docs/PartialAddress.md

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

data/docs/PatchChargesChargeIdRequest.md

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

data/docs/PatchChargesChargeIdResponse.md

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

data/docs/PatchPaymentIntentsPaymentIntentIdRequest.md

@@ -0,0 +1,30 @@
+# MelioPlatformApiClient::PatchPaymentIntentsPaymentIntentIdRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount_to_pay** | **Integer** |  | [optional] |
+| **scheduled_date** | **Date** |  | [optional] |
+| **funding_source_id** | **String** |  | [optional] |
+| **delivery_method_id** | **String** |  | [optional] |
+| **selected_delivery_preference_type** | [**DeliveryPreferenceType**](DeliveryPreferenceType.md) |  | [optional] |
+| **note_to_vendor** | **String** |  | [optional] |
+| **bill_info** | [**PatchPaymentIntentsPaymentIntentIdRequestBillInfo**](PatchPaymentIntentsPaymentIntentIdRequestBillInfo.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::PatchPaymentIntentsPaymentIntentIdRequest.new(
+  amount_to_pay: null,
+  scheduled_date: null,
+  funding_source_id: null,
+  delivery_method_id: null,
+  selected_delivery_preference_type: null,
+  note_to_vendor: null,
+  bill_info: null
+)
+```
+

data/docs/PatchPaymentIntentsPaymentIntentIdRequestBillInfo.md

@@ -0,0 +1,26 @@
+# MelioPlatformApiClient::PatchPaymentIntentsPaymentIntentIdRequestBillInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invoice** | [**Invoice**](Invoice.md) |  | [optional] |
+| **vendor_id** | **String** | Identifier of the entity. | [optional] |
+| **due_date** | **Date** |  | [optional] |
+| **currency** | [**Currency**](Currency.md) |  | [optional][default to 'USD'] |
+| **amount** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::PatchPaymentIntentsPaymentIntentIdRequestBillInfo.new(
+  invoice: null,
+  vendor_id: null,
+  due_date: null,
+  currency: null,
+  amount: null
+)
+```
+