melio-platform-api-client 3.0.1
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of melio-platform-api-client might be problematic. Click here for more details.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +132 -0
- data/Rakefile +10 -0
- data/docs/Account.md +26 -0
- data/docs/AccountAllOf.md +22 -0
- data/docs/AccountsApi.md +224 -0
- data/docs/AddToMyVendorParameters.md +18 -0
- data/docs/AddToMyVendorParametersDeliveryMethod.md +20 -0
- data/docs/AddToMyVendorParametersDeliveryMethodBillerAccount.md +18 -0
- data/docs/Address.md +26 -0
- data/docs/Adjustment.md +20 -0
- data/docs/AuthApi.md +83 -0
- data/docs/BankAccount.md +22 -0
- data/docs/BankAccountType.md +15 -0
- data/docs/BillerAccount.md +18 -0
- data/docs/Card.md +24 -0
- data/docs/Charge.md +32 -0
- data/docs/ChargeAllOf.md +28 -0
- data/docs/ChargesApi.md +317 -0
- data/docs/Checkout.md +66 -0
- data/docs/CheckoutAllOf.md +62 -0
- data/docs/CheckoutAllOfBuyer.md +26 -0
- data/docs/CheckoutsApi.md +327 -0
- data/docs/Company.md +28 -0
- data/docs/ConfirmPaymentIntentsResponse.md +18 -0
- data/docs/Currency.md +15 -0
- data/docs/DeletedResponse.md +18 -0
- data/docs/DeliveryMethod.md +24 -0
- data/docs/DeliveryMethodAllOf.md +20 -0
- data/docs/DeliveryMethodDetails.md +55 -0
- data/docs/DeliveryMethodType.md +15 -0
- data/docs/DeliveryMethodsApi.md +485 -0
- data/docs/DeliveryPreference.md +28 -0
- data/docs/DeliveryPreferenceType.md +15 -0
- data/docs/DomesticWireAccount.md +22 -0
- data/docs/DomesticWireAccountAddress.md +22 -0
- data/docs/ErrorResponse.md +18 -0
- data/docs/FileInfo.md +22 -0
- data/docs/FileInfoAllOf.md +18 -0
- data/docs/FilesApi.md +317 -0
- data/docs/Financing.md +24 -0
- data/docs/FinancingApi.md +246 -0
- data/docs/FinancingDropdownOptions.md +20 -0
- data/docs/FinancingFields.md +28 -0
- data/docs/FundingSource.md +26 -0
- data/docs/FundingSourceAllOf.md +22 -0
- data/docs/FundingSourceDetails.md +49 -0
- data/docs/FundingSourceType.md +15 -0
- data/docs/FundingSourcesApi.md +325 -0
- data/docs/GetAccountsAccountIdResponse.md +18 -0
- data/docs/GetAccountsResponse.md +18 -0
- data/docs/GetChargesChargeIdResponse.md +18 -0
- data/docs/GetChargesResponse.md +18 -0
- data/docs/GetCheckoutsCheckoutIdResponse.md +18 -0
- data/docs/GetDeliveryMethodsDeliveryMethodIdResponse.md +18 -0
- data/docs/GetDeliveryMethodsResponse.md +18 -0
- data/docs/GetFilesFileIdDataResponse.md +18 -0
- data/docs/GetFilesFileIdDataResponseData.md +26 -0
- data/docs/GetFilesFileIdDataResponseDataCustomerInfo.md +18 -0
- data/docs/GetFilesFileIdDataResponseDataInvoiceInfo.md +20 -0
- data/docs/GetFilesFileIdDataResponseDataVendorInfo.md +20 -0
- data/docs/GetFilesFileIdResponse.md +18 -0
- data/docs/GetFilesResponse.md +18 -0
- data/docs/GetFinancingResponse.md +18 -0
- data/docs/GetFundingSourcesFundingSourceIdResponse.md +18 -0
- data/docs/GetFundingSourcesResponse.md +18 -0
- data/docs/GetPaymentIntentsPaymentIntentIdResponse.md +18 -0
- data/docs/GetPaymentIntentsResponse.md +18 -0
- data/docs/GetPaymentsPaymentIdResponse.md +18 -0
- data/docs/GetPaymentsResponse.md +18 -0
- data/docs/GetVendorDirectoryResponse.md +18 -0
- data/docs/GetVendorsResponse.md +18 -0
- data/docs/GetVendorsVendorIdDeliveryMethodsResponse.md +18 -0
- data/docs/GetVendorsVendorIdResponse.md +18 -0
- data/docs/GetWebhooksCheckoutsResponse.md +18 -0
- data/docs/GetWebhooksPaymentsResponse.md +18 -0
- data/docs/GetWebhooksResponse.md +18 -0
- data/docs/Invoice.md +20 -0
- data/docs/LineItem.md +30 -0
- data/docs/Merchant.md +38 -0
- data/docs/MerchantAllOf.md +34 -0
- data/docs/MerchantsApi.md +85 -0
- data/docs/ModelError.md +22 -0
- data/docs/ModelErrorAllOf.md +20 -0
- data/docs/Object.md +20 -0
- data/docs/PaperCheck.md +20 -0
- data/docs/PartialAddress.md +26 -0
- data/docs/PatchChargesChargeIdRequest.md +18 -0
- data/docs/PatchChargesChargeIdResponse.md +18 -0
- data/docs/PatchPaymentIntentsPaymentIntentIdRequest.md +30 -0
- data/docs/PatchPaymentIntentsPaymentIntentIdRequestBillInfo.md +26 -0
- data/docs/PatchPaymentIntentsPaymentIntentIdResponse.md +18 -0
- data/docs/PatchVendorsVendorIdRequest.md +20 -0
- data/docs/PatchVendorsVendorIdRequestContact.md +22 -0
- data/docs/PatchVendorsVendorIdResponse.md +18 -0
- data/docs/Payment.md +48 -0
- data/docs/PaymentAllOf.md +44 -0
- data/docs/PaymentFee.md +20 -0
- data/docs/PaymentIntent.md +46 -0
- data/docs/PaymentIntentAllOf.md +42 -0
- data/docs/PaymentIntentAllOfBillInfo.md +30 -0
- data/docs/PaymentIntentsApi.md +483 -0
- data/docs/PaymentsApi.md +325 -0
- data/docs/Person.md +22 -0
- data/docs/PlaidDetails.md +20 -0
- data/docs/PostAccountsRequest.md +22 -0
- data/docs/PostAccountsResponse.md +18 -0
- data/docs/PostAuthResponse.md +18 -0
- data/docs/PostAuthResponseData.md +22 -0
- data/docs/PostCheckoutsCheckoutIdCaptureRequest.md +22 -0
- data/docs/PostCheckoutsCheckoutIdCaptureRequestInvoice.md +20 -0
- data/docs/PostCheckoutsCheckoutIdCompleteRequest.md +24 -0
- data/docs/PostCheckoutsRequest.md +48 -0
- data/docs/PostCheckoutsResponse.md +18 -0
- data/docs/PostDeliveryMethodsRequest.md +20 -0
- data/docs/PostDeliveryMethodsRequestDetails.md +53 -0
- data/docs/PostDeliveryMethodsResponse.md +18 -0
- data/docs/PostFilesResponse.md +18 -0
- data/docs/PostFinancingRequest.md +18 -0
- data/docs/PostFinancingRequestFields.md +20 -0
- data/docs/PostFinancingResponse.md +18 -0
- data/docs/PostFinancingTransactionalRequest.md +20 -0
- data/docs/PostFinancingTransactionalResponse.md +18 -0
- data/docs/PostFinancingTransactionalResponseData.md +20 -0
- data/docs/PostFundingSourcesRequest.md +22 -0
- data/docs/PostFundingSourcesRequestDetails.md +51 -0
- data/docs/PostFundingSourcesResponse.md +18 -0
- data/docs/PostMerchantsRequest.md +32 -0
- data/docs/PostMerchantsResponse.md +18 -0
- data/docs/PostPaymentIntentsBulkRequest.md +18 -0
- data/docs/PostPaymentIntentsBulkResponse.md +18 -0
- data/docs/PostPaymentIntentsPaymentIntentIdPaymentResponse.md +18 -0
- data/docs/PostPaymentIntentsRequest.md +30 -0
- data/docs/PostPaymentIntentsRequestBillInfo.md +26 -0
- data/docs/PostPaymentIntentsResponse.md +18 -0
- data/docs/PostPaymentsPaymentIdRecoverRequest.md +26 -0
- data/docs/PostPaymentsPaymentIdRecoverResponse.md +18 -0
- data/docs/PostVendorsBulkRequest.md +18 -0
- data/docs/PostVendorsBulkResponse.md +18 -0
- data/docs/PostVendorsFromVendorDirectoryRequest.md +20 -0
- data/docs/PostVendorsFromVendorDirectoryRequestDeliveryMethod.md +20 -0
- data/docs/PostVendorsFromVendorDirectoryResponse.md +18 -0
- data/docs/PostVendorsRequest.md +20 -0
- data/docs/PostVendorsResponse.md +18 -0
- data/docs/PostVendorsVendorIdDeliveryMethodsResponse.md +18 -0
- data/docs/PostWebhooksCheckoutsRequest.md +18 -0
- data/docs/PostWebhooksCheckoutsResponse.md +18 -0
- data/docs/PostWebhooksPaymentsRequest.md +18 -0
- data/docs/PostWebhooksPaymentsResponse.md +18 -0
- data/docs/PutPaymentIntentsRequest.md +36 -0
- data/docs/PutPaymentIntentsResponse.md +18 -0
- data/docs/RecoverPaymentRequest.md +36 -0
- data/docs/RecoverPaymentResponse.md +18 -0
- data/docs/ShortHistory.md +22 -0
- data/docs/TabaPayDetails.md +30 -0
- data/docs/TabaPayDetailsCardOwner.md +20 -0
- data/docs/TaxInfo.md +20 -0
- data/docs/Vendor.md +26 -0
- data/docs/VendorAllOf.md +22 -0
- data/docs/VendorAllOfContact.md +22 -0
- data/docs/VendorDirectory.md +26 -0
- data/docs/VendorDirectoryApi.md +169 -0
- data/docs/VendorDirectoryContact.md +24 -0
- data/docs/VendorDirectoryDeliveryMethod.md +18 -0
- data/docs/VendorDirectoryNotFoundResponse.md +18 -0
- data/docs/VendorsApi.md +806 -0
- data/docs/VirtualAccount.md +22 -0
- data/docs/Webhook.md +20 -0
- data/docs/WebhooksApi.md +510 -0
- data/docs/WithUnknownData.md +18 -0
- data/lib/melio-platform-api-client/api/accounts_api.rb +213 -0
- data/lib/melio-platform-api-client/api/auth_api.rb +89 -0
- data/lib/melio-platform-api-client/api/charges_api.rb +307 -0
- data/lib/melio-platform-api-client/api/checkouts_api.rb +328 -0
- data/lib/melio-platform-api-client/api/delivery_methods_api.rb +439 -0
- data/lib/melio-platform-api-client/api/files_api.rb +284 -0
- data/lib/melio-platform-api-client/api/financing_api.rb +230 -0
- data/lib/melio-platform-api-client/api/funding_sources_api.rb +295 -0
- data/lib/melio-platform-api-client/api/merchants_api.rb +96 -0
- data/lib/melio-platform-api-client/api/payment_intents_api.rb +443 -0
- data/lib/melio-platform-api-client/api/payments_api.rb +294 -0
- data/lib/melio-platform-api-client/api/vendor_directory_api.rb +170 -0
- data/lib/melio-platform-api-client/api/vendors_api.rb +738 -0
- data/lib/melio-platform-api-client/api/webhooks_api.rb +463 -0
- data/lib/melio-platform-api-client/api_client.rb +419 -0
- data/lib/melio-platform-api-client/api_error.rb +57 -0
- data/lib/melio-platform-api-client/configuration.rb +289 -0
- data/lib/melio-platform-api-client/models/account.rb +324 -0
- data/lib/melio-platform-api-client/models/account_all_of.rb +286 -0
- data/lib/melio-platform-api-client/models/add_to_my_vendor_parameters.rb +218 -0
- data/lib/melio-platform-api-client/models/add_to_my_vendor_parameters_delivery_method.rb +232 -0
- data/lib/melio-platform-api-client/models/add_to_my_vendor_parameters_delivery_method_biller_account.rb +224 -0
- data/lib/melio-platform-api-client/models/address.rb +277 -0
- data/lib/melio-platform-api-client/models/adjustment.rb +239 -0
- data/lib/melio-platform-api-client/models/bank_account.rb +254 -0
- data/lib/melio-platform-api-client/models/bank_account_type.rb +37 -0
- data/lib/melio-platform-api-client/models/biller_account.rb +223 -0
- data/lib/melio-platform-api-client/models/card.rb +339 -0
- data/lib/melio-platform-api-client/models/charge.rb +368 -0
- data/lib/melio-platform-api-client/models/charge_all_of.rb +330 -0
- data/lib/melio-platform-api-client/models/checkout.rb +588 -0
- data/lib/melio-platform-api-client/models/checkout_all_of.rb +550 -0
- data/lib/melio-platform-api-client/models/checkout_all_of_buyer.rb +265 -0
- data/lib/melio-platform-api-client/models/company.rb +295 -0
- data/lib/melio-platform-api-client/models/confirm_payment_intents_response.rb +223 -0
- data/lib/melio-platform-api-client/models/currency.rb +36 -0
- data/lib/melio-platform-api-client/models/deleted_response.rb +224 -0
- data/lib/melio-platform-api-client/models/delivery_method.rb +275 -0
- data/lib/melio-platform-api-client/models/delivery_method_all_of.rb +237 -0
- data/lib/melio-platform-api-client/models/delivery_method_details.rb +108 -0
- data/lib/melio-platform-api-client/models/delivery_method_type.rb +40 -0
- data/lib/melio-platform-api-client/models/delivery_preference.rb +283 -0
- data/lib/melio-platform-api-client/models/delivery_preference_type.rb +42 -0
- data/lib/melio-platform-api-client/models/domestic_wire_account.rb +252 -0
- data/lib/melio-platform-api-client/models/domestic_wire_account_address.rb +253 -0
- data/lib/melio-platform-api-client/models/error_response.rb +224 -0
- data/lib/melio-platform-api-client/models/file_info.rb +261 -0
- data/lib/melio-platform-api-client/models/file_info_all_of.rb +223 -0
- data/lib/melio-platform-api-client/models/financing.rb +293 -0
- data/lib/melio-platform-api-client/models/financing_dropdown_options.rb +227 -0
- data/lib/melio-platform-api-client/models/financing_fields.rb +265 -0
- data/lib/melio-platform-api-client/models/funding_source.rb +280 -0
- data/lib/melio-platform-api-client/models/funding_source_all_of.rb +242 -0
- data/lib/melio-platform-api-client/models/funding_source_details.rb +105 -0
- data/lib/melio-platform-api-client/models/funding_source_type.rb +37 -0
- data/lib/melio-platform-api-client/models/get_accounts_account_id_response.rb +223 -0
- data/lib/melio-platform-api-client/models/get_accounts_response.rb +225 -0
- data/lib/melio-platform-api-client/models/get_charges_charge_id_response.rb +223 -0
- data/lib/melio-platform-api-client/models/get_charges_response.rb +225 -0
- data/lib/melio-platform-api-client/models/get_checkouts_checkout_id_response.rb +223 -0
- data/lib/melio-platform-api-client/models/get_delivery_methods_delivery_method_id_response.rb +223 -0
- data/lib/melio-platform-api-client/models/get_delivery_methods_response.rb +225 -0
- data/lib/melio-platform-api-client/models/get_files_file_id_data_response.rb +218 -0
- data/lib/melio-platform-api-client/models/get_files_file_id_data_response_data.rb +254 -0
- data/lib/melio-platform-api-client/models/get_files_file_id_data_response_data_customer_info.rb +218 -0
- data/lib/melio-platform-api-client/models/get_files_file_id_data_response_data_invoice_info.rb +227 -0
- data/lib/melio-platform-api-client/models/get_files_file_id_data_response_data_vendor_info.rb +227 -0
- data/lib/melio-platform-api-client/models/get_files_file_id_response.rb +223 -0
- data/lib/melio-platform-api-client/models/get_files_response.rb +225 -0
- data/lib/melio-platform-api-client/models/get_financing_response.rb +223 -0
- data/lib/melio-platform-api-client/models/get_funding_sources_funding_source_id_response.rb +223 -0
- data/lib/melio-platform-api-client/models/get_funding_sources_response.rb +225 -0
- data/lib/melio-platform-api-client/models/get_payment_intents_payment_intent_id_response.rb +223 -0
- data/lib/melio-platform-api-client/models/get_payment_intents_response.rb +225 -0
- data/lib/melio-platform-api-client/models/get_payments_payment_id_response.rb +223 -0
- data/lib/melio-platform-api-client/models/get_payments_response.rb +225 -0
- data/lib/melio-platform-api-client/models/get_vendor_directory_response.rb +225 -0
- data/lib/melio-platform-api-client/models/get_vendors_response.rb +225 -0
- data/lib/melio-platform-api-client/models/get_vendors_vendor_id_delivery_methods_response.rb +225 -0
- data/lib/melio-platform-api-client/models/get_vendors_vendor_id_response.rb +223 -0
- data/lib/melio-platform-api-client/models/get_webhooks_checkouts_response.rb +223 -0
- data/lib/melio-platform-api-client/models/get_webhooks_payments_response.rb +223 -0
- data/lib/melio-platform-api-client/models/get_webhooks_response.rb +225 -0
- data/lib/melio-platform-api-client/models/invoice.rb +234 -0
- data/lib/melio-platform-api-client/models/line_item.rb +316 -0
- data/lib/melio-platform-api-client/models/merchant.rb +335 -0
- data/lib/melio-platform-api-client/models/merchant_all_of.rb +297 -0
- data/lib/melio-platform-api-client/models/model_error.rb +256 -0
- data/lib/melio-platform-api-client/models/model_error_all_of.rb +237 -0
- data/lib/melio-platform-api-client/models/object.rb +238 -0
- data/lib/melio-platform-api-client/models/paper_check.rb +239 -0
- data/lib/melio-platform-api-client/models/partial_address.rb +258 -0
- data/lib/melio-platform-api-client/models/patch_charges_charge_id_request.rb +218 -0
- data/lib/melio-platform-api-client/models/patch_charges_charge_id_response.rb +223 -0
- data/lib/melio-platform-api-client/models/patch_payment_intents_payment_intent_id_request.rb +275 -0
- data/lib/melio-platform-api-client/models/patch_payment_intents_payment_intent_id_request_bill_info.rb +257 -0
- data/lib/melio-platform-api-client/models/patch_payment_intents_payment_intent_id_response.rb +223 -0
- data/lib/melio-platform-api-client/models/patch_vendors_vendor_id_request.rb +227 -0
- data/lib/melio-platform-api-client/models/patch_vendors_vendor_id_request_contact.rb +237 -0
- data/lib/melio-platform-api-client/models/patch_vendors_vendor_id_response.rb +223 -0
- data/lib/melio-platform-api-client/models/payment.rb +469 -0
- data/lib/melio-platform-api-client/models/payment_all_of.rb +431 -0
- data/lib/melio-platform-api-client/models/payment_fee.rb +237 -0
- data/lib/melio-platform-api-client/models/payment_intent.rb +450 -0
- data/lib/melio-platform-api-client/models/payment_intent_all_of.rb +412 -0
- data/lib/melio-platform-api-client/models/payment_intent_all_of_bill_info.rb +301 -0
- data/lib/melio-platform-api-client/models/person.rb +252 -0
- data/lib/melio-platform-api-client/models/plaid_details.rb +239 -0
- data/lib/melio-platform-api-client/models/post_accounts_request.rb +248 -0
- data/lib/melio-platform-api-client/models/post_accounts_response.rb +223 -0
- data/lib/melio-platform-api-client/models/post_auth_response.rb +223 -0
- data/lib/melio-platform-api-client/models/post_auth_response_data.rb +251 -0
- data/lib/melio-platform-api-client/models/post_checkouts_checkout_id_capture_request.rb +271 -0
- data/lib/melio-platform-api-client/models/post_checkouts_checkout_id_capture_request_invoice.rb +234 -0
- data/lib/melio-platform-api-client/models/post_checkouts_checkout_id_complete_request.rb +253 -0
- data/lib/melio-platform-api-client/models/post_checkouts_request.rb +438 -0
- data/lib/melio-platform-api-client/models/post_checkouts_response.rb +223 -0
- data/lib/melio-platform-api-client/models/post_delivery_methods_request.rb +237 -0
- data/lib/melio-platform-api-client/models/post_delivery_methods_request_details.rb +107 -0
- data/lib/melio-platform-api-client/models/post_delivery_methods_response.rb +223 -0
- data/lib/melio-platform-api-client/models/post_files_response.rb +223 -0
- data/lib/melio-platform-api-client/models/post_financing_request.rb +220 -0
- data/lib/melio-platform-api-client/models/post_financing_request_fields.rb +237 -0
- data/lib/melio-platform-api-client/models/post_financing_response.rb +223 -0
- data/lib/melio-platform-api-client/models/post_financing_transactional_request.rb +239 -0
- data/lib/melio-platform-api-client/models/post_financing_transactional_response.rb +224 -0
- data/lib/melio-platform-api-client/models/post_financing_transactional_response_data.rb +271 -0
- data/lib/melio-platform-api-client/models/post_funding_sources_request.rb +280 -0
- data/lib/melio-platform-api-client/models/post_funding_sources_request_details.rb +106 -0
- data/lib/melio-platform-api-client/models/post_funding_sources_response.rb +223 -0
- data/lib/melio-platform-api-client/models/post_merchants_request.rb +283 -0
- data/lib/melio-platform-api-client/models/post_merchants_response.rb +223 -0
- data/lib/melio-platform-api-client/models/post_payment_intents_bulk_request.rb +225 -0
- data/lib/melio-platform-api-client/models/post_payment_intents_bulk_response.rb +225 -0
- data/lib/melio-platform-api-client/models/post_payment_intents_payment_intent_id_payment_response.rb +223 -0
- data/lib/melio-platform-api-client/models/post_payment_intents_request.rb +285 -0
- data/lib/melio-platform-api-client/models/post_payment_intents_request_bill_info.rb +277 -0
- data/lib/melio-platform-api-client/models/post_payment_intents_response.rb +223 -0
- data/lib/melio-platform-api-client/models/post_payments_payment_id_recover_request.rb +276 -0
- data/lib/melio-platform-api-client/models/post_payments_payment_id_recover_response.rb +223 -0
- data/lib/melio-platform-api-client/models/post_vendors_bulk_request.rb +225 -0
- data/lib/melio-platform-api-client/models/post_vendors_bulk_response.rb +225 -0
- data/lib/melio-platform-api-client/models/post_vendors_from_vendor_directory_request.rb +232 -0
- data/lib/melio-platform-api-client/models/post_vendors_from_vendor_directory_request_delivery_method.rb +233 -0
- data/lib/melio-platform-api-client/models/post_vendors_from_vendor_directory_response.rb +223 -0
- data/lib/melio-platform-api-client/models/post_vendors_request.rb +238 -0
- data/lib/melio-platform-api-client/models/post_vendors_response.rb +223 -0
- data/lib/melio-platform-api-client/models/post_vendors_vendor_id_delivery_methods_response.rb +223 -0
- data/lib/melio-platform-api-client/models/post_webhooks_checkouts_request.rb +223 -0
- data/lib/melio-platform-api-client/models/post_webhooks_checkouts_response.rb +223 -0
- data/lib/melio-platform-api-client/models/post_webhooks_payments_request.rb +223 -0
- data/lib/melio-platform-api-client/models/post_webhooks_payments_response.rb +223 -0
- data/lib/melio-platform-api-client/models/put_payment_intents_request.rb +305 -0
- data/lib/melio-platform-api-client/models/put_payment_intents_response.rb +223 -0
- data/lib/melio-platform-api-client/models/recover_payment_request.rb +304 -0
- data/lib/melio-platform-api-client/models/recover_payment_response.rb +223 -0
- data/lib/melio-platform-api-client/models/short_history.rb +247 -0
- data/lib/melio-platform-api-client/models/taba_pay_details.rb +380 -0
- data/lib/melio-platform-api-client/models/taba_pay_details_card_owner.rb +237 -0
- data/lib/melio-platform-api-client/models/tax_info.rb +273 -0
- data/lib/melio-platform-api-client/models/vendor.rb +292 -0
- data/lib/melio-platform-api-client/models/vendor_all_of.rb +254 -0
- data/lib/melio-platform-api-client/models/vendor_all_of_contact.rb +254 -0
- data/lib/melio-platform-api-client/models/vendor_directory.rb +283 -0
- data/lib/melio-platform-api-client/models/vendor_directory_contact.rb +261 -0
- data/lib/melio-platform-api-client/models/vendor_directory_delivery_method.rb +223 -0
- data/lib/melio-platform-api-client/models/vendor_directory_not_found_response.rb +219 -0
- data/lib/melio-platform-api-client/models/virtual_account.rb +243 -0
- data/lib/melio-platform-api-client/models/webhook.rb +227 -0
- data/lib/melio-platform-api-client/models/with_unknown_data.rb +219 -0
- data/lib/melio-platform-api-client/version.rb +15 -0
- data/lib/melio-platform-api-client.rb +206 -0
- data/melio-platform-api-client.gemspec +38 -0
- data/spec/api/accounts_api_spec.rb +71 -0
- data/spec/api/auth_api_spec.rb +48 -0
- data/spec/api/charges_api_spec.rb +90 -0
- data/spec/api/checkouts_api_spec.rb +93 -0
- data/spec/api/delivery_methods_api_spec.rb +115 -0
- data/spec/api/files_api_spec.rb +85 -0
- data/spec/api/financing_api_spec.rb +75 -0
- data/spec/api/funding_sources_api_spec.rb +88 -0
- data/spec/api/merchants_api_spec.rb +49 -0
- data/spec/api/payment_intents_api_spec.rb +114 -0
- data/spec/api/payments_api_spec.rb +88 -0
- data/spec/api/vendor_directory_api_spec.rb +62 -0
- data/spec/api/vendors_api_spec.rb +170 -0
- data/spec/api/webhooks_api_spec.rb +118 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/account_all_of_spec.rb +50 -0
- data/spec/models/account_spec.rb +62 -0
- data/spec/models/add_to_my_vendor_parameters_delivery_method_biller_account_spec.rb +34 -0
- data/spec/models/add_to_my_vendor_parameters_delivery_method_spec.rb +40 -0
- data/spec/models/add_to_my_vendor_parameters_spec.rb +34 -0
- data/spec/models/address_spec.rb +58 -0
- data/spec/models/adjustment_spec.rb +40 -0
- data/spec/models/bank_account_spec.rb +46 -0
- data/spec/models/bank_account_type_spec.rb +28 -0
- data/spec/models/biller_account_spec.rb +34 -0
- data/spec/models/card_spec.rb +52 -0
- data/spec/models/charge_all_of_spec.rb +68 -0
- data/spec/models/charge_spec.rb +80 -0
- data/spec/models/checkout_all_of_buyer_spec.rb +58 -0
- data/spec/models/checkout_all_of_spec.rb +170 -0
- data/spec/models/checkout_spec.rb +182 -0
- data/spec/models/company_spec.rb +64 -0
- data/spec/models/confirm_payment_intents_response_spec.rb +34 -0
- data/spec/models/currency_spec.rb +28 -0
- data/spec/models/deleted_response_spec.rb +34 -0
- data/spec/models/delivery_method_all_of_spec.rb +40 -0
- data/spec/models/delivery_method_details_spec.rb +31 -0
- data/spec/models/delivery_method_spec.rb +52 -0
- data/spec/models/delivery_method_type_spec.rb +28 -0
- data/spec/models/delivery_preference_spec.rb +64 -0
- data/spec/models/delivery_preference_type_spec.rb +28 -0
- data/spec/models/domestic_wire_account_address_spec.rb +46 -0
- data/spec/models/domestic_wire_account_spec.rb +46 -0
- data/spec/models/error_response_spec.rb +34 -0
- data/spec/models/file_info_all_of_spec.rb +34 -0
- data/spec/models/file_info_spec.rb +46 -0
- data/spec/models/financing_dropdown_options_spec.rb +40 -0
- data/spec/models/financing_fields_spec.rb +64 -0
- data/spec/models/financing_spec.rb +56 -0
- data/spec/models/funding_source_all_of_spec.rb +46 -0
- data/spec/models/funding_source_details_spec.rb +31 -0
- data/spec/models/funding_source_spec.rb +58 -0
- data/spec/models/funding_source_type_spec.rb +28 -0
- data/spec/models/get_accounts_account_id_response_spec.rb +34 -0
- data/spec/models/get_accounts_response_spec.rb +34 -0
- data/spec/models/get_charges_charge_id_response_spec.rb +34 -0
- data/spec/models/get_charges_response_spec.rb +34 -0
- data/spec/models/get_checkouts_checkout_id_response_spec.rb +34 -0
- data/spec/models/get_delivery_methods_delivery_method_id_response_spec.rb +34 -0
- data/spec/models/get_delivery_methods_response_spec.rb +34 -0
- data/spec/models/get_files_file_id_data_response_data_customer_info_spec.rb +34 -0
- data/spec/models/get_files_file_id_data_response_data_invoice_info_spec.rb +40 -0
- data/spec/models/get_files_file_id_data_response_data_spec.rb +58 -0
- data/spec/models/get_files_file_id_data_response_data_vendor_info_spec.rb +40 -0
- data/spec/models/get_files_file_id_data_response_spec.rb +34 -0
- data/spec/models/get_files_file_id_response_spec.rb +34 -0
- data/spec/models/get_files_response_spec.rb +34 -0
- data/spec/models/get_financing_response_spec.rb +34 -0
- data/spec/models/get_funding_sources_funding_source_id_response_spec.rb +34 -0
- data/spec/models/get_funding_sources_response_spec.rb +34 -0
- data/spec/models/get_payment_intents_payment_intent_id_response_spec.rb +34 -0
- data/spec/models/get_payment_intents_response_spec.rb +34 -0
- data/spec/models/get_payments_payment_id_response_spec.rb +34 -0
- data/spec/models/get_payments_response_spec.rb +34 -0
- data/spec/models/get_vendor_directory_response_spec.rb +34 -0
- data/spec/models/get_vendors_response_spec.rb +34 -0
- data/spec/models/get_vendors_vendor_id_delivery_methods_response_spec.rb +34 -0
- data/spec/models/get_vendors_vendor_id_response_spec.rb +34 -0
- data/spec/models/get_webhooks_checkouts_response_spec.rb +34 -0
- data/spec/models/get_webhooks_payments_response_spec.rb +34 -0
- data/spec/models/get_webhooks_response_spec.rb +34 -0
- data/spec/models/invoice_spec.rb +40 -0
- data/spec/models/line_item_spec.rb +70 -0
- data/spec/models/merchant_all_of_spec.rb +82 -0
- data/spec/models/merchant_spec.rb +94 -0
- data/spec/models/model_error_all_of_spec.rb +40 -0
- data/spec/models/model_error_spec.rb +46 -0
- data/spec/models/object_spec.rb +40 -0
- data/spec/models/paper_check_spec.rb +40 -0
- data/spec/models/partial_address_spec.rb +58 -0
- data/spec/models/patch_charges_charge_id_request_spec.rb +34 -0
- data/spec/models/patch_charges_charge_id_response_spec.rb +34 -0
- data/spec/models/patch_payment_intents_payment_intent_id_request_bill_info_spec.rb +58 -0
- data/spec/models/patch_payment_intents_payment_intent_id_request_spec.rb +70 -0
- data/spec/models/patch_payment_intents_payment_intent_id_response_spec.rb +34 -0
- data/spec/models/patch_vendors_vendor_id_request_contact_spec.rb +46 -0
- data/spec/models/patch_vendors_vendor_id_request_spec.rb +40 -0
- data/spec/models/patch_vendors_vendor_id_response_spec.rb +34 -0
- data/spec/models/payment_all_of_spec.rb +116 -0
- data/spec/models/payment_fee_spec.rb +40 -0
- data/spec/models/payment_intent_all_of_bill_info_spec.rb +70 -0
- data/spec/models/payment_intent_all_of_spec.rb +110 -0
- data/spec/models/payment_intent_spec.rb +122 -0
- data/spec/models/payment_spec.rb +128 -0
- data/spec/models/person_spec.rb +46 -0
- data/spec/models/plaid_details_spec.rb +40 -0
- data/spec/models/post_accounts_request_spec.rb +46 -0
- data/spec/models/post_accounts_response_spec.rb +34 -0
- data/spec/models/post_auth_response_data_spec.rb +46 -0
- data/spec/models/post_auth_response_spec.rb +34 -0
- data/spec/models/post_checkouts_checkout_id_capture_request_invoice_spec.rb +40 -0
- data/spec/models/post_checkouts_checkout_id_capture_request_spec.rb +46 -0
- data/spec/models/post_checkouts_checkout_id_complete_request_spec.rb +52 -0
- data/spec/models/post_checkouts_request_spec.rb +124 -0
- data/spec/models/post_checkouts_response_spec.rb +34 -0
- data/spec/models/post_delivery_methods_request_details_spec.rb +31 -0
- data/spec/models/post_delivery_methods_request_spec.rb +40 -0
- data/spec/models/post_delivery_methods_response_spec.rb +34 -0
- data/spec/models/post_files_response_spec.rb +34 -0
- data/spec/models/post_financing_request_fields_spec.rb +40 -0
- data/spec/models/post_financing_request_spec.rb +34 -0
- data/spec/models/post_financing_response_spec.rb +34 -0
- data/spec/models/post_financing_transactional_request_spec.rb +40 -0
- data/spec/models/post_financing_transactional_response_data_spec.rb +44 -0
- data/spec/models/post_financing_transactional_response_spec.rb +34 -0
- data/spec/models/post_funding_sources_request_details_spec.rb +31 -0
- data/spec/models/post_funding_sources_request_spec.rb +50 -0
- data/spec/models/post_funding_sources_response_spec.rb +34 -0
- data/spec/models/post_merchants_request_spec.rb +76 -0
- data/spec/models/post_merchants_response_spec.rb +34 -0
- data/spec/models/post_payment_intents_bulk_request_spec.rb +34 -0
- data/spec/models/post_payment_intents_bulk_response_spec.rb +34 -0
- data/spec/models/post_payment_intents_payment_intent_id_payment_response_spec.rb +34 -0
- data/spec/models/post_payment_intents_request_bill_info_spec.rb +58 -0
- data/spec/models/post_payment_intents_request_spec.rb +70 -0
- data/spec/models/post_payment_intents_response_spec.rb +34 -0
- data/spec/models/post_payments_payment_id_recover_request_spec.rb +58 -0
- data/spec/models/post_payments_payment_id_recover_response_spec.rb +34 -0
- data/spec/models/post_vendors_bulk_request_spec.rb +34 -0
- data/spec/models/post_vendors_bulk_response_spec.rb +34 -0
- data/spec/models/post_vendors_from_vendor_directory_request_delivery_method_spec.rb +40 -0
- data/spec/models/post_vendors_from_vendor_directory_request_spec.rb +40 -0
- data/spec/models/post_vendors_from_vendor_directory_response_spec.rb +34 -0
- data/spec/models/post_vendors_request_spec.rb +40 -0
- data/spec/models/post_vendors_response_spec.rb +34 -0
- data/spec/models/post_vendors_vendor_id_delivery_methods_response_spec.rb +34 -0
- data/spec/models/post_webhooks_checkouts_request_spec.rb +34 -0
- data/spec/models/post_webhooks_checkouts_response_spec.rb +34 -0
- data/spec/models/post_webhooks_payments_request_spec.rb +34 -0
- data/spec/models/post_webhooks_payments_response_spec.rb +34 -0
- data/spec/models/put_payment_intents_request_spec.rb +88 -0
- data/spec/models/put_payment_intents_response_spec.rb +34 -0
- data/spec/models/recover_payment_request_spec.rb +88 -0
- data/spec/models/recover_payment_response_spec.rb +34 -0
- data/spec/models/short_history_spec.rb +46 -0
- data/spec/models/taba_pay_details_card_owner_spec.rb +40 -0
- data/spec/models/taba_pay_details_spec.rb +70 -0
- data/spec/models/tax_info_spec.rb +44 -0
- data/spec/models/vendor_all_of_contact_spec.rb +46 -0
- data/spec/models/vendor_all_of_spec.rb +46 -0
- data/spec/models/vendor_directory_contact_spec.rb +52 -0
- data/spec/models/vendor_directory_delivery_method_spec.rb +34 -0
- data/spec/models/vendor_directory_not_found_response_spec.rb +34 -0
- data/spec/models/vendor_directory_spec.rb +58 -0
- data/spec/models/vendor_spec.rb +58 -0
- data/spec/models/virtual_account_spec.rb +46 -0
- data/spec/models/webhook_spec.rb +40 -0
- data/spec/models/with_unknown_data_spec.rb +34 -0
- data/spec/spec_helper.rb +111 -0
- metadata +766 -0
@@ -0,0 +1,485 @@
|
|
1
|
+
# MelioPlatformApiClient::DeliveryMethodsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.melio.com/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**delete_delivery_methods_delivery_method_id**](DeliveryMethodsApi.md#delete_delivery_methods_delivery_method_id) | **DELETE** /delivery-methods/{deliveryMethodId} | Delete a Delivery Method |
|
8
|
+
| [**get_delivery_methods**](DeliveryMethodsApi.md#get_delivery_methods) | **GET** /delivery-methods | Retrieve all Delivery Methods |
|
9
|
+
| [**get_delivery_methods_delivery_method_id**](DeliveryMethodsApi.md#get_delivery_methods_delivery_method_id) | **GET** /delivery-methods/{deliveryMethodId} | Retrieve a Delivery Method |
|
10
|
+
| [**get_vendors_vendor_id_delivery_methods**](DeliveryMethodsApi.md#get_vendors_vendor_id_delivery_methods) | **GET** /vendors/{vendorId}/delivery-methods | Retrieve a Vendor's Delivery Methods |
|
11
|
+
| [**post_delivery_methods**](DeliveryMethodsApi.md#post_delivery_methods) | **POST** /delivery-methods | Create a Delivery Method |
|
12
|
+
| [**post_vendors_vendor_id_delivery_methods**](DeliveryMethodsApi.md#post_vendors_vendor_id_delivery_methods) | **POST** /vendors/{vendorId}/delivery-methods | Create a Vendor's Delivery Method |
|
13
|
+
|
14
|
+
|
15
|
+
## delete_delivery_methods_delivery_method_id
|
16
|
+
|
17
|
+
> <DeletedResponse> delete_delivery_methods_delivery_method_id(delivery_method_id, idempotency_key, opts)
|
18
|
+
|
19
|
+
Delete a Delivery Method
|
20
|
+
|
21
|
+
Remove a Delivery Method from the Account
|
22
|
+
|
23
|
+
### Examples
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
require 'time'
|
27
|
+
require 'melio-platform-api-client'
|
28
|
+
# setup authorization
|
29
|
+
MelioPlatformApiClient.configure do |config|
|
30
|
+
# Configure Bearer authorization: AccessToken
|
31
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
32
|
+
|
33
|
+
# Configure API key authorization: ApiKey
|
34
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
35
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
36
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
37
|
+
end
|
38
|
+
|
39
|
+
api_instance = MelioPlatformApiClient::DeliveryMethodsApi.new
|
40
|
+
delivery_method_id = 'delivery_method_id_example' # String |
|
41
|
+
idempotency_key = 'idempotency_key_example' # String | Unique idempotency key
|
42
|
+
opts = {
|
43
|
+
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.
|
44
|
+
}
|
45
|
+
|
46
|
+
begin
|
47
|
+
# Delete a Delivery Method
|
48
|
+
result = api_instance.delete_delivery_methods_delivery_method_id(delivery_method_id, idempotency_key, opts)
|
49
|
+
p result
|
50
|
+
rescue MelioPlatformApiClient::ApiError => e
|
51
|
+
puts "Error when calling DeliveryMethodsApi->delete_delivery_methods_delivery_method_id: #{e}"
|
52
|
+
end
|
53
|
+
```
|
54
|
+
|
55
|
+
#### Using the delete_delivery_methods_delivery_method_id_with_http_info variant
|
56
|
+
|
57
|
+
This returns an Array which contains the response data, status code and headers.
|
58
|
+
|
59
|
+
> <Array(<DeletedResponse>, Integer, Hash)> delete_delivery_methods_delivery_method_id_with_http_info(delivery_method_id, idempotency_key, opts)
|
60
|
+
|
61
|
+
```ruby
|
62
|
+
begin
|
63
|
+
# Delete a Delivery Method
|
64
|
+
data, status_code, headers = api_instance.delete_delivery_methods_delivery_method_id_with_http_info(delivery_method_id, idempotency_key, opts)
|
65
|
+
p status_code # => 2xx
|
66
|
+
p headers # => { ... }
|
67
|
+
p data # => <DeletedResponse>
|
68
|
+
rescue MelioPlatformApiClient::ApiError => e
|
69
|
+
puts "Error when calling DeliveryMethodsApi->delete_delivery_methods_delivery_method_id_with_http_info: #{e}"
|
70
|
+
end
|
71
|
+
```
|
72
|
+
|
73
|
+
### Parameters
|
74
|
+
|
75
|
+
| Name | Type | Description | Notes |
|
76
|
+
| ---- | ---- | ----------- | ----- |
|
77
|
+
| **delivery_method_id** | **String** | | |
|
78
|
+
| **idempotency_key** | **String** | Unique idempotency key | |
|
79
|
+
| **melio_account** | **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. | [optional] |
|
80
|
+
|
81
|
+
### Return type
|
82
|
+
|
83
|
+
[**DeletedResponse**](DeletedResponse.md)
|
84
|
+
|
85
|
+
### Authorization
|
86
|
+
|
87
|
+
[AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
|
88
|
+
|
89
|
+
### HTTP request headers
|
90
|
+
|
91
|
+
- **Content-Type**: Not defined
|
92
|
+
- **Accept**: application/json
|
93
|
+
|
94
|
+
|
95
|
+
## get_delivery_methods
|
96
|
+
|
97
|
+
> <GetDeliveryMethodsResponse> get_delivery_methods(opts)
|
98
|
+
|
99
|
+
Retrieve all Delivery Methods
|
100
|
+
|
101
|
+
Retrieve a list of all Delivery Methods the Account has
|
102
|
+
|
103
|
+
### Examples
|
104
|
+
|
105
|
+
```ruby
|
106
|
+
require 'time'
|
107
|
+
require 'melio-platform-api-client'
|
108
|
+
# setup authorization
|
109
|
+
MelioPlatformApiClient.configure do |config|
|
110
|
+
# Configure Bearer authorization: AccessToken
|
111
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
112
|
+
|
113
|
+
# Configure API key authorization: ApiKey
|
114
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
115
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
116
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
117
|
+
end
|
118
|
+
|
119
|
+
api_instance = MelioPlatformApiClient::DeliveryMethodsApi.new
|
120
|
+
opts = {
|
121
|
+
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.
|
122
|
+
}
|
123
|
+
|
124
|
+
begin
|
125
|
+
# Retrieve all Delivery Methods
|
126
|
+
result = api_instance.get_delivery_methods(opts)
|
127
|
+
p result
|
128
|
+
rescue MelioPlatformApiClient::ApiError => e
|
129
|
+
puts "Error when calling DeliveryMethodsApi->get_delivery_methods: #{e}"
|
130
|
+
end
|
131
|
+
```
|
132
|
+
|
133
|
+
#### Using the get_delivery_methods_with_http_info variant
|
134
|
+
|
135
|
+
This returns an Array which contains the response data, status code and headers.
|
136
|
+
|
137
|
+
> <Array(<GetDeliveryMethodsResponse>, Integer, Hash)> get_delivery_methods_with_http_info(opts)
|
138
|
+
|
139
|
+
```ruby
|
140
|
+
begin
|
141
|
+
# Retrieve all Delivery Methods
|
142
|
+
data, status_code, headers = api_instance.get_delivery_methods_with_http_info(opts)
|
143
|
+
p status_code # => 2xx
|
144
|
+
p headers # => { ... }
|
145
|
+
p data # => <GetDeliveryMethodsResponse>
|
146
|
+
rescue MelioPlatformApiClient::ApiError => e
|
147
|
+
puts "Error when calling DeliveryMethodsApi->get_delivery_methods_with_http_info: #{e}"
|
148
|
+
end
|
149
|
+
```
|
150
|
+
|
151
|
+
### Parameters
|
152
|
+
|
153
|
+
| Name | Type | Description | Notes |
|
154
|
+
| ---- | ---- | ----------- | ----- |
|
155
|
+
| **melio_account** | **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. | [optional] |
|
156
|
+
|
157
|
+
### Return type
|
158
|
+
|
159
|
+
[**GetDeliveryMethodsResponse**](GetDeliveryMethodsResponse.md)
|
160
|
+
|
161
|
+
### Authorization
|
162
|
+
|
163
|
+
[AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
|
164
|
+
|
165
|
+
### HTTP request headers
|
166
|
+
|
167
|
+
- **Content-Type**: Not defined
|
168
|
+
- **Accept**: application/json
|
169
|
+
|
170
|
+
|
171
|
+
## get_delivery_methods_delivery_method_id
|
172
|
+
|
173
|
+
> <GetDeliveryMethodsDeliveryMethodIdResponse> get_delivery_methods_delivery_method_id(delivery_method_id, opts)
|
174
|
+
|
175
|
+
Retrieve a Delivery Method
|
176
|
+
|
177
|
+
Retrieve the details about a specific Delivery Method the Account has
|
178
|
+
|
179
|
+
### Examples
|
180
|
+
|
181
|
+
```ruby
|
182
|
+
require 'time'
|
183
|
+
require 'melio-platform-api-client'
|
184
|
+
# setup authorization
|
185
|
+
MelioPlatformApiClient.configure do |config|
|
186
|
+
# Configure Bearer authorization: AccessToken
|
187
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
188
|
+
|
189
|
+
# Configure API key authorization: ApiKey
|
190
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
191
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
192
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
193
|
+
end
|
194
|
+
|
195
|
+
api_instance = MelioPlatformApiClient::DeliveryMethodsApi.new
|
196
|
+
delivery_method_id = 'delivery_method_id_example' # String |
|
197
|
+
opts = {
|
198
|
+
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.
|
199
|
+
}
|
200
|
+
|
201
|
+
begin
|
202
|
+
# Retrieve a Delivery Method
|
203
|
+
result = api_instance.get_delivery_methods_delivery_method_id(delivery_method_id, opts)
|
204
|
+
p result
|
205
|
+
rescue MelioPlatformApiClient::ApiError => e
|
206
|
+
puts "Error when calling DeliveryMethodsApi->get_delivery_methods_delivery_method_id: #{e}"
|
207
|
+
end
|
208
|
+
```
|
209
|
+
|
210
|
+
#### Using the get_delivery_methods_delivery_method_id_with_http_info variant
|
211
|
+
|
212
|
+
This returns an Array which contains the response data, status code and headers.
|
213
|
+
|
214
|
+
> <Array(<GetDeliveryMethodsDeliveryMethodIdResponse>, Integer, Hash)> get_delivery_methods_delivery_method_id_with_http_info(delivery_method_id, opts)
|
215
|
+
|
216
|
+
```ruby
|
217
|
+
begin
|
218
|
+
# Retrieve a Delivery Method
|
219
|
+
data, status_code, headers = api_instance.get_delivery_methods_delivery_method_id_with_http_info(delivery_method_id, opts)
|
220
|
+
p status_code # => 2xx
|
221
|
+
p headers # => { ... }
|
222
|
+
p data # => <GetDeliveryMethodsDeliveryMethodIdResponse>
|
223
|
+
rescue MelioPlatformApiClient::ApiError => e
|
224
|
+
puts "Error when calling DeliveryMethodsApi->get_delivery_methods_delivery_method_id_with_http_info: #{e}"
|
225
|
+
end
|
226
|
+
```
|
227
|
+
|
228
|
+
### Parameters
|
229
|
+
|
230
|
+
| Name | Type | Description | Notes |
|
231
|
+
| ---- | ---- | ----------- | ----- |
|
232
|
+
| **delivery_method_id** | **String** | | |
|
233
|
+
| **melio_account** | **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. | [optional] |
|
234
|
+
|
235
|
+
### Return type
|
236
|
+
|
237
|
+
[**GetDeliveryMethodsDeliveryMethodIdResponse**](GetDeliveryMethodsDeliveryMethodIdResponse.md)
|
238
|
+
|
239
|
+
### Authorization
|
240
|
+
|
241
|
+
[AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
|
242
|
+
|
243
|
+
### HTTP request headers
|
244
|
+
|
245
|
+
- **Content-Type**: Not defined
|
246
|
+
- **Accept**: application/json
|
247
|
+
|
248
|
+
|
249
|
+
## get_vendors_vendor_id_delivery_methods
|
250
|
+
|
251
|
+
> <GetVendorsVendorIdDeliveryMethodsResponse> get_vendors_vendor_id_delivery_methods(vendor_id, opts)
|
252
|
+
|
253
|
+
Retrieve a Vendor's Delivery Methods
|
254
|
+
|
255
|
+
Get a list of a Vendor's Delivery Methods, that can be used to sent funds to.
|
256
|
+
|
257
|
+
### Examples
|
258
|
+
|
259
|
+
```ruby
|
260
|
+
require 'time'
|
261
|
+
require 'melio-platform-api-client'
|
262
|
+
# setup authorization
|
263
|
+
MelioPlatformApiClient.configure do |config|
|
264
|
+
# Configure Bearer authorization: AccessToken
|
265
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
266
|
+
|
267
|
+
# Configure API key authorization: ApiKey
|
268
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
269
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
270
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
271
|
+
end
|
272
|
+
|
273
|
+
api_instance = MelioPlatformApiClient::DeliveryMethodsApi.new
|
274
|
+
vendor_id = 'vendor_id_example' # String |
|
275
|
+
opts = {
|
276
|
+
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.
|
277
|
+
}
|
278
|
+
|
279
|
+
begin
|
280
|
+
# Retrieve a Vendor's Delivery Methods
|
281
|
+
result = api_instance.get_vendors_vendor_id_delivery_methods(vendor_id, opts)
|
282
|
+
p result
|
283
|
+
rescue MelioPlatformApiClient::ApiError => e
|
284
|
+
puts "Error when calling DeliveryMethodsApi->get_vendors_vendor_id_delivery_methods: #{e}"
|
285
|
+
end
|
286
|
+
```
|
287
|
+
|
288
|
+
#### Using the get_vendors_vendor_id_delivery_methods_with_http_info variant
|
289
|
+
|
290
|
+
This returns an Array which contains the response data, status code and headers.
|
291
|
+
|
292
|
+
> <Array(<GetVendorsVendorIdDeliveryMethodsResponse>, Integer, Hash)> get_vendors_vendor_id_delivery_methods_with_http_info(vendor_id, opts)
|
293
|
+
|
294
|
+
```ruby
|
295
|
+
begin
|
296
|
+
# Retrieve a Vendor's Delivery Methods
|
297
|
+
data, status_code, headers = api_instance.get_vendors_vendor_id_delivery_methods_with_http_info(vendor_id, opts)
|
298
|
+
p status_code # => 2xx
|
299
|
+
p headers # => { ... }
|
300
|
+
p data # => <GetVendorsVendorIdDeliveryMethodsResponse>
|
301
|
+
rescue MelioPlatformApiClient::ApiError => e
|
302
|
+
puts "Error when calling DeliveryMethodsApi->get_vendors_vendor_id_delivery_methods_with_http_info: #{e}"
|
303
|
+
end
|
304
|
+
```
|
305
|
+
|
306
|
+
### Parameters
|
307
|
+
|
308
|
+
| Name | Type | Description | Notes |
|
309
|
+
| ---- | ---- | ----------- | ----- |
|
310
|
+
| **vendor_id** | **String** | | |
|
311
|
+
| **melio_account** | **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. | [optional] |
|
312
|
+
|
313
|
+
### Return type
|
314
|
+
|
315
|
+
[**GetVendorsVendorIdDeliveryMethodsResponse**](GetVendorsVendorIdDeliveryMethodsResponse.md)
|
316
|
+
|
317
|
+
### Authorization
|
318
|
+
|
319
|
+
[AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
|
320
|
+
|
321
|
+
### HTTP request headers
|
322
|
+
|
323
|
+
- **Content-Type**: Not defined
|
324
|
+
- **Accept**: application/json
|
325
|
+
|
326
|
+
|
327
|
+
## post_delivery_methods
|
328
|
+
|
329
|
+
> <PostDeliveryMethodsResponse> post_delivery_methods(idempotency_key, opts)
|
330
|
+
|
331
|
+
Create a Delivery Method
|
332
|
+
|
333
|
+
Add a new Delivery Method for the Account. The `type` field determines the contents of the `details` field, according to the following mapping: * `bank-account` => `BankAccount` * `paper-check` => `PaperCheck` * `virtual-account` => `VirtualAccount`
|
334
|
+
|
335
|
+
### Examples
|
336
|
+
|
337
|
+
```ruby
|
338
|
+
require 'time'
|
339
|
+
require 'melio-platform-api-client'
|
340
|
+
# setup authorization
|
341
|
+
MelioPlatformApiClient.configure do |config|
|
342
|
+
# Configure Bearer authorization: AccessToken
|
343
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
344
|
+
|
345
|
+
# Configure API key authorization: ApiKey
|
346
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
347
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
348
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
349
|
+
end
|
350
|
+
|
351
|
+
api_instance = MelioPlatformApiClient::DeliveryMethodsApi.new
|
352
|
+
idempotency_key = 'idempotency_key_example' # String | Unique idempotency key
|
353
|
+
opts = {
|
354
|
+
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.
|
355
|
+
post_delivery_methods_request: MelioPlatformApiClient::PostDeliveryMethodsRequest.new({type: MelioPlatformApiClient::DeliveryMethodType::BANK_ACCOUNT, details: MelioPlatformApiClient::BankAccount.new({routing_number: 'routing_number_example', account_type: MelioPlatformApiClient::BankAccountType::CHECKING, account_number: 'account_number_example'})}) # PostDeliveryMethodsRequest |
|
356
|
+
}
|
357
|
+
|
358
|
+
begin
|
359
|
+
# Create a Delivery Method
|
360
|
+
result = api_instance.post_delivery_methods(idempotency_key, opts)
|
361
|
+
p result
|
362
|
+
rescue MelioPlatformApiClient::ApiError => e
|
363
|
+
puts "Error when calling DeliveryMethodsApi->post_delivery_methods: #{e}"
|
364
|
+
end
|
365
|
+
```
|
366
|
+
|
367
|
+
#### Using the post_delivery_methods_with_http_info variant
|
368
|
+
|
369
|
+
This returns an Array which contains the response data, status code and headers.
|
370
|
+
|
371
|
+
> <Array(<PostDeliveryMethodsResponse>, Integer, Hash)> post_delivery_methods_with_http_info(idempotency_key, opts)
|
372
|
+
|
373
|
+
```ruby
|
374
|
+
begin
|
375
|
+
# Create a Delivery Method
|
376
|
+
data, status_code, headers = api_instance.post_delivery_methods_with_http_info(idempotency_key, opts)
|
377
|
+
p status_code # => 2xx
|
378
|
+
p headers # => { ... }
|
379
|
+
p data # => <PostDeliveryMethodsResponse>
|
380
|
+
rescue MelioPlatformApiClient::ApiError => e
|
381
|
+
puts "Error when calling DeliveryMethodsApi->post_delivery_methods_with_http_info: #{e}"
|
382
|
+
end
|
383
|
+
```
|
384
|
+
|
385
|
+
### Parameters
|
386
|
+
|
387
|
+
| Name | Type | Description | Notes |
|
388
|
+
| ---- | ---- | ----------- | ----- |
|
389
|
+
| **idempotency_key** | **String** | Unique idempotency key | |
|
390
|
+
| **melio_account** | **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. | [optional] |
|
391
|
+
| **post_delivery_methods_request** | [**PostDeliveryMethodsRequest**](PostDeliveryMethodsRequest.md) | | [optional] |
|
392
|
+
|
393
|
+
### Return type
|
394
|
+
|
395
|
+
[**PostDeliveryMethodsResponse**](PostDeliveryMethodsResponse.md)
|
396
|
+
|
397
|
+
### Authorization
|
398
|
+
|
399
|
+
[AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
|
400
|
+
|
401
|
+
### HTTP request headers
|
402
|
+
|
403
|
+
- **Content-Type**: application/json
|
404
|
+
- **Accept**: application/json
|
405
|
+
|
406
|
+
|
407
|
+
## post_vendors_vendor_id_delivery_methods
|
408
|
+
|
409
|
+
> <PostVendorsVendorIdDeliveryMethodsResponse> post_vendors_vendor_id_delivery_methods(vendor_id, idempotency_key, opts)
|
410
|
+
|
411
|
+
Create a Vendor's Delivery Method
|
412
|
+
|
413
|
+
### Examples
|
414
|
+
|
415
|
+
```ruby
|
416
|
+
require 'time'
|
417
|
+
require 'melio-platform-api-client'
|
418
|
+
# setup authorization
|
419
|
+
MelioPlatformApiClient.configure do |config|
|
420
|
+
# Configure Bearer authorization: AccessToken
|
421
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
422
|
+
|
423
|
+
# Configure API key authorization: ApiKey
|
424
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
425
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
426
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
427
|
+
end
|
428
|
+
|
429
|
+
api_instance = MelioPlatformApiClient::DeliveryMethodsApi.new
|
430
|
+
vendor_id = 'vendor_id_example' # String |
|
431
|
+
idempotency_key = 'idempotency_key_example' # String | Unique idempotency key
|
432
|
+
opts = {
|
433
|
+
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.
|
434
|
+
body: 3.56 # PostDeliveryMethodsRequest |
|
435
|
+
}
|
436
|
+
|
437
|
+
begin
|
438
|
+
# Create a Vendor's Delivery Method
|
439
|
+
result = api_instance.post_vendors_vendor_id_delivery_methods(vendor_id, idempotency_key, opts)
|
440
|
+
p result
|
441
|
+
rescue MelioPlatformApiClient::ApiError => e
|
442
|
+
puts "Error when calling DeliveryMethodsApi->post_vendors_vendor_id_delivery_methods: #{e}"
|
443
|
+
end
|
444
|
+
```
|
445
|
+
|
446
|
+
#### Using the post_vendors_vendor_id_delivery_methods_with_http_info variant
|
447
|
+
|
448
|
+
This returns an Array which contains the response data, status code and headers.
|
449
|
+
|
450
|
+
> <Array(<PostVendorsVendorIdDeliveryMethodsResponse>, Integer, Hash)> post_vendors_vendor_id_delivery_methods_with_http_info(vendor_id, idempotency_key, opts)
|
451
|
+
|
452
|
+
```ruby
|
453
|
+
begin
|
454
|
+
# Create a Vendor's Delivery Method
|
455
|
+
data, status_code, headers = api_instance.post_vendors_vendor_id_delivery_methods_with_http_info(vendor_id, idempotency_key, opts)
|
456
|
+
p status_code # => 2xx
|
457
|
+
p headers # => { ... }
|
458
|
+
p data # => <PostVendorsVendorIdDeliveryMethodsResponse>
|
459
|
+
rescue MelioPlatformApiClient::ApiError => e
|
460
|
+
puts "Error when calling DeliveryMethodsApi->post_vendors_vendor_id_delivery_methods_with_http_info: #{e}"
|
461
|
+
end
|
462
|
+
```
|
463
|
+
|
464
|
+
### Parameters
|
465
|
+
|
466
|
+
| Name | Type | Description | Notes |
|
467
|
+
| ---- | ---- | ----------- | ----- |
|
468
|
+
| **vendor_id** | **String** | | |
|
469
|
+
| **idempotency_key** | **String** | Unique idempotency key | |
|
470
|
+
| **melio_account** | **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. | [optional] |
|
471
|
+
| **body** | **PostDeliveryMethodsRequest** | | [optional] |
|
472
|
+
|
473
|
+
### Return type
|
474
|
+
|
475
|
+
[**PostVendorsVendorIdDeliveryMethodsResponse**](PostVendorsVendorIdDeliveryMethodsResponse.md)
|
476
|
+
|
477
|
+
### Authorization
|
478
|
+
|
479
|
+
[AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
|
480
|
+
|
481
|
+
### HTTP request headers
|
482
|
+
|
483
|
+
- **Content-Type**: application/json
|
484
|
+
- **Accept**: application/json
|
485
|
+
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# MelioPlatformApiClient::DeliveryPreference
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **min_estimated_delivery_date** | **Date** | | [optional] |
|
8
|
+
| **max_estimated_delivery_date** | **Date** | | [optional] |
|
9
|
+
| **total_days** | **Integer** | | |
|
10
|
+
| **total_business_days** | **Integer** | | |
|
11
|
+
| **fee** | [**PaymentFee**](PaymentFee.md) | | |
|
12
|
+
| **type** | [**DeliveryPreferenceType**](DeliveryPreferenceType.md) | | |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'melio-platform-api-client'
|
18
|
+
|
19
|
+
instance = MelioPlatformApiClient::DeliveryPreference.new(
|
20
|
+
min_estimated_delivery_date: null,
|
21
|
+
max_estimated_delivery_date: null,
|
22
|
+
total_days: null,
|
23
|
+
total_business_days: null,
|
24
|
+
fee: null,
|
25
|
+
type: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# MelioPlatformApiClient::DeliveryPreferenceType
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
|
8
|
+
## Example
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'melio-platform-api-client'
|
12
|
+
|
13
|
+
instance = MelioPlatformApiClient::DeliveryPreferenceType.new()
|
14
|
+
```
|
15
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MelioPlatformApiClient::DomesticWireAccount
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **routing_number** | **String** | | |
|
8
|
+
| **account_number** | **String** | | |
|
9
|
+
| **address** | [**DomesticWireAccountAddress**](DomesticWireAccountAddress.md) | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'melio-platform-api-client'
|
15
|
+
|
16
|
+
instance = MelioPlatformApiClient::DomesticWireAccount.new(
|
17
|
+
routing_number: null,
|
18
|
+
account_number: null,
|
19
|
+
address: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MelioPlatformApiClient::DomesticWireAccountAddress
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **city** | **String** | | |
|
8
|
+
| **state** | **String** | State two-letter symbol. | |
|
9
|
+
| **postal_code** | **String** | 5 digits postal (ZIP) code. | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'melio-platform-api-client'
|
15
|
+
|
16
|
+
instance = MelioPlatformApiClient::DomesticWireAccountAddress.new(
|
17
|
+
city: null,
|
18
|
+
state: null,
|
19
|
+
postal_code: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MelioPlatformApiClient::ErrorResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error** | [**ModelError**](ModelError.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'melio-platform-api-client'
|
13
|
+
|
14
|
+
instance = MelioPlatformApiClient::ErrorResponse.new(
|
15
|
+
error: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/FileInfo.md
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# MelioPlatformApiClient::FileInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | Identifier of the entity. | |
|
8
|
+
| **history** | [**ShortHistory**](ShortHistory.md) | | |
|
9
|
+
| **url** | **String** | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'melio-platform-api-client'
|
15
|
+
|
16
|
+
instance = MelioPlatformApiClient::FileInfo.new(
|
17
|
+
id: null,
|
18
|
+
history: null,
|
19
|
+
url: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MelioPlatformApiClient::FileInfoAllOf
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **url** | **String** | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'melio-platform-api-client'
|
13
|
+
|
14
|
+
instance = MelioPlatformApiClient::FileInfoAllOf.new(
|
15
|
+
url: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|