melio-platform-api-client 3.0.1

data/docs/PatchPaymentIntentsPaymentIntentIdResponse.md

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

data/docs/PatchVendorsVendorIdRequest.md

@@ -0,0 +1,20 @@
+# MelioPlatformApiClient::PatchVendorsVendorIdRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **contact** | [**PatchVendorsVendorIdRequestContact**](PatchVendorsVendorIdRequestContact.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::PatchVendorsVendorIdRequest.new(
+  name: null,
+  contact: null
+)
+```
+

data/docs/PatchVendorsVendorIdRequestContact.md

@@ -0,0 +1,22 @@
+# MelioPlatformApiClient::PatchVendorsVendorIdRequestContact
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::PatchVendorsVendorIdRequestContact.new(
+  name: null,
+  phone_number: null,
+  email: null
+)
+```
+

data/docs/PatchVendorsVendorIdResponse.md

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

data/docs/Payment.md

@@ -0,0 +1,48 @@
+# MelioPlatformApiClient::Payment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the entity. |  |
+| **history** | [**ShortHistory**](ShortHistory.md) |  |  |
+| **amount** | **Integer** |  |  |
+| **currency** | [**Currency**](Currency.md) |  | [default to 'USD'] |
+| **scheduled_date** | **Date** |  |  |
+| **note** | **String** | A note that is attached to this Payment. | [optional] |
+| **balance** | **Integer** |  | [optional] |
+| **is_recoverable** | **Boolean** | Flags whether this Payment can be recovered by providing alternative details, suing the `POST /payments/{paymentId}/recover` endpoint. |  |
+| **vendor_id** | **String** | Identifier of the entity. | [optional] |
+| **funding_source_id** | **String** | Identifier of the entity. |  |
+| **delivery_method_id** | **String** | Identifier of the entity. |  |
+| **status** | **String** | The current status of this Payment. |  |
+| **estimated_delivery** | **Date** |  |  |
+| **fees** | [**Array<PaymentFee>**](PaymentFee.md) | Fees to be charged, based on this Payments details and preferences. |  |
+| **failed_message** | **String** | The message that can be shown in case of a failure. | [optional] |
+| **max_estimated_delivery** | **Date** |  |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::Payment.new(
+  id: null,
+  history: null,
+  amount: null,
+  currency: null,
+  scheduled_date: null,
+  note: null,
+  balance: null,
+  is_recoverable: null,
+  vendor_id: null,
+  funding_source_id: null,
+  delivery_method_id: null,
+  status: null,
+  estimated_delivery: null,
+  fees: null,
+  failed_message: null,
+  max_estimated_delivery: null
+)
+```
+

data/docs/PaymentAllOf.md

@@ -0,0 +1,44 @@
+# MelioPlatformApiClient::PaymentAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** |  |  |
+| **currency** | [**Currency**](Currency.md) |  | [default to 'USD'] |
+| **scheduled_date** | **Date** |  |  |
+| **note** | **String** | A note that is attached to this Payment. | [optional] |
+| **balance** | **Integer** |  | [optional] |
+| **is_recoverable** | **Boolean** | Flags whether this Payment can be recovered by providing alternative details, suing the `POST /payments/{paymentId}/recover` endpoint. |  |
+| **vendor_id** | **String** | Identifier of the entity. | [optional] |
+| **funding_source_id** | **String** | Identifier of the entity. |  |
+| **delivery_method_id** | **String** | Identifier of the entity. |  |
+| **status** | **String** | The current status of this Payment. |  |
+| **estimated_delivery** | **Date** |  |  |
+| **fees** | [**Array<PaymentFee>**](PaymentFee.md) | Fees to be charged, based on this Payments details and preferences. |  |
+| **failed_message** | **String** | The message that can be shown in case of a failure. | [optional] |
+| **max_estimated_delivery** | **Date** |  |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::PaymentAllOf.new(
+  amount: null,
+  currency: null,
+  scheduled_date: null,
+  note: null,
+  balance: null,
+  is_recoverable: null,
+  vendor_id: null,
+  funding_source_id: null,
+  delivery_method_id: null,
+  status: null,
+  estimated_delivery: null,
+  fees: null,
+  failed_message: null,
+  max_estimated_delivery: null
+)
+```
+

data/docs/PaymentFee.md

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

data/docs/PaymentIntent.md

@@ -0,0 +1,46 @@
+# MelioPlatformApiClient::PaymentIntent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the entity. |  |
+| **history** | [**ShortHistory**](ShortHistory.md) |  |  |
+| **amount_to_pay** | **Integer** |  |  |
+| **funding_source_id** | **String** | The ID of the Funding Source that will be used for the produced Payment. | [optional] |
+| **funding_source** | [**FundingSource**](FundingSource.md) | Info about the Funding Source that will be used for the produced Payment. | [optional] |
+| **delivery_method_id** | **String** | The ID of the Delivery Method that will be used for the produced Payment. | [optional] |
+| **delivery_method** | [**DeliveryMethod**](DeliveryMethod.md) | Info about the Delivery Method that will be used for the produced Payment. | [optional] |
+| **note_to_vendor** | **String** | A note that the Vendor will see when receiving the produced Payment. |  |
+| **estimated_fees** | [**Array<PaymentFee>**](PaymentFee.md) | Automatically calculated fees, based on the `selectedDeliveryPreferenceType` field. |  |
+| **scheduled_date** | **Date** |  | [optional] |
+| **status** | **String** | The current status of the Payment Intent as a bill entry. |  |
+| **selected_delivery_preference_type** | [**DeliveryPreferenceType**](DeliveryPreferenceType.md) | Set this field to control the delivery preferences for the produced Payment. Updating this will trigger fees re-calculation, which reflect in the `estimatedFees` field. | [optional] |
+| **delivery_preference_options** | [**Array<DeliveryPreference>**](DeliveryPreference.md) | The possible delivery preference options, based on the current Payment Intent configuration. |  |
+| **payments** | [**Array<Payment>**](Payment.md) | A list of Payments that were produced out of this Payment Intent. |  |
+| **bill_info** | [**PaymentIntentAllOfBillInfo**](PaymentIntentAllOfBillInfo.md) |  |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::PaymentIntent.new(
+  id: null,
+  history: null,
+  amount_to_pay: null,
+  funding_source_id: null,
+  funding_source: null,
+  delivery_method_id: null,
+  delivery_method: null,
+  note_to_vendor: null,
+  estimated_fees: null,
+  scheduled_date: null,
+  status: null,
+  selected_delivery_preference_type: null,
+  delivery_preference_options: null,
+  payments: null,
+  bill_info: null
+)
+```
+

data/docs/PaymentIntentAllOf.md

@@ -0,0 +1,42 @@
+# MelioPlatformApiClient::PaymentIntentAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount_to_pay** | **Integer** |  |  |
+| **funding_source_id** | **String** | The ID of the Funding Source that will be used for the produced Payment. | [optional] |
+| **funding_source** | [**FundingSource**](FundingSource.md) | Info about the Funding Source that will be used for the produced Payment. | [optional] |
+| **delivery_method_id** | **String** | The ID of the Delivery Method that will be used for the produced Payment. | [optional] |
+| **delivery_method** | [**DeliveryMethod**](DeliveryMethod.md) | Info about the Delivery Method that will be used for the produced Payment. | [optional] |
+| **note_to_vendor** | **String** | A note that the Vendor will see when receiving the produced Payment. |  |
+| **estimated_fees** | [**Array<PaymentFee>**](PaymentFee.md) | Automatically calculated fees, based on the `selectedDeliveryPreferenceType` field. |  |
+| **scheduled_date** | **Date** |  | [optional] |
+| **status** | **String** | The current status of the Payment Intent as a bill entry. |  |
+| **selected_delivery_preference_type** | [**DeliveryPreferenceType**](DeliveryPreferenceType.md) | Set this field to control the delivery preferences for the produced Payment. Updating this will trigger fees re-calculation, which reflect in the `estimatedFees` field. | [optional] |
+| **delivery_preference_options** | [**Array<DeliveryPreference>**](DeliveryPreference.md) | The possible delivery preference options, based on the current Payment Intent configuration. |  |
+| **payments** | [**Array<Payment>**](Payment.md) | A list of Payments that were produced out of this Payment Intent. |  |
+| **bill_info** | [**PaymentIntentAllOfBillInfo**](PaymentIntentAllOfBillInfo.md) |  |  |
+
+## Example
+
+```ruby
+require 'melio-platform-api-client'
+
+instance = MelioPlatformApiClient::PaymentIntentAllOf.new(
+  amount_to_pay: null,
+  funding_source_id: null,
+  funding_source: null,
+  delivery_method_id: null,
+  delivery_method: null,
+  note_to_vendor: null,
+  estimated_fees: null,
+  scheduled_date: null,
+  status: null,
+  selected_delivery_preference_type: null,
+  delivery_preference_options: null,
+  payments: null,
+  bill_info: null
+)
+```
+

data/docs/PaymentIntentAllOfBillInfo.md

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