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
data/docs/FilesApi.md
ADDED
@@ -0,0 +1,317 @@
|
|
1
|
+
# MelioPlatformApiClient::FilesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.melio.com/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_files**](FilesApi.md#get_files) | **GET** /files | Retrieve files |
|
8
|
+
| [**get_files_file_id**](FilesApi.md#get_files_file_id) | **GET** /files/{fileId} | Retrieve a File |
|
9
|
+
| [**get_files_file_id_data**](FilesApi.md#get_files_file_id_data) | **GET** /files/{fileId}/data | Retrieve data from a File using OCR |
|
10
|
+
| [**post_files**](FilesApi.md#post_files) | **POST** /files | Create / upload a File |
|
11
|
+
|
12
|
+
|
13
|
+
## get_files
|
14
|
+
|
15
|
+
> <GetFilesResponse> get_files(opts)
|
16
|
+
|
17
|
+
Retrieve files
|
18
|
+
|
19
|
+
Retrieve the list of Files the Account uploaded to Melio
|
20
|
+
|
21
|
+
### Examples
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
require 'time'
|
25
|
+
require 'melio-platform-api-client'
|
26
|
+
# setup authorization
|
27
|
+
MelioPlatformApiClient.configure do |config|
|
28
|
+
# Configure Bearer authorization: AccessToken
|
29
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
30
|
+
|
31
|
+
# Configure API key authorization: ApiKey
|
32
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
33
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
34
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
35
|
+
end
|
36
|
+
|
37
|
+
api_instance = MelioPlatformApiClient::FilesApi.new
|
38
|
+
opts = {
|
39
|
+
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.
|
40
|
+
}
|
41
|
+
|
42
|
+
begin
|
43
|
+
# Retrieve files
|
44
|
+
result = api_instance.get_files(opts)
|
45
|
+
p result
|
46
|
+
rescue MelioPlatformApiClient::ApiError => e
|
47
|
+
puts "Error when calling FilesApi->get_files: #{e}"
|
48
|
+
end
|
49
|
+
```
|
50
|
+
|
51
|
+
#### Using the get_files_with_http_info variant
|
52
|
+
|
53
|
+
This returns an Array which contains the response data, status code and headers.
|
54
|
+
|
55
|
+
> <Array(<GetFilesResponse>, Integer, Hash)> get_files_with_http_info(opts)
|
56
|
+
|
57
|
+
```ruby
|
58
|
+
begin
|
59
|
+
# Retrieve files
|
60
|
+
data, status_code, headers = api_instance.get_files_with_http_info(opts)
|
61
|
+
p status_code # => 2xx
|
62
|
+
p headers # => { ... }
|
63
|
+
p data # => <GetFilesResponse>
|
64
|
+
rescue MelioPlatformApiClient::ApiError => e
|
65
|
+
puts "Error when calling FilesApi->get_files_with_http_info: #{e}"
|
66
|
+
end
|
67
|
+
```
|
68
|
+
|
69
|
+
### Parameters
|
70
|
+
|
71
|
+
| Name | Type | Description | Notes |
|
72
|
+
| ---- | ---- | ----------- | ----- |
|
73
|
+
| **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] |
|
74
|
+
|
75
|
+
### Return type
|
76
|
+
|
77
|
+
[**GetFilesResponse**](GetFilesResponse.md)
|
78
|
+
|
79
|
+
### Authorization
|
80
|
+
|
81
|
+
[AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
|
82
|
+
|
83
|
+
### HTTP request headers
|
84
|
+
|
85
|
+
- **Content-Type**: Not defined
|
86
|
+
- **Accept**: application/json
|
87
|
+
|
88
|
+
|
89
|
+
## get_files_file_id
|
90
|
+
|
91
|
+
> <GetFilesFileIdResponse> get_files_file_id(file_id)
|
92
|
+
|
93
|
+
Retrieve a File
|
94
|
+
|
95
|
+
Get a File object with a details and a URL for the actual file to download.
|
96
|
+
|
97
|
+
### Examples
|
98
|
+
|
99
|
+
```ruby
|
100
|
+
require 'time'
|
101
|
+
require 'melio-platform-api-client'
|
102
|
+
# setup authorization
|
103
|
+
MelioPlatformApiClient.configure do |config|
|
104
|
+
# Configure Bearer authorization: AccessToken
|
105
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
106
|
+
|
107
|
+
# Configure API key authorization: ApiKey
|
108
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
109
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
110
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
111
|
+
end
|
112
|
+
|
113
|
+
api_instance = MelioPlatformApiClient::FilesApi.new
|
114
|
+
file_id = 'file_id_example' # String |
|
115
|
+
|
116
|
+
begin
|
117
|
+
# Retrieve a File
|
118
|
+
result = api_instance.get_files_file_id(file_id)
|
119
|
+
p result
|
120
|
+
rescue MelioPlatformApiClient::ApiError => e
|
121
|
+
puts "Error when calling FilesApi->get_files_file_id: #{e}"
|
122
|
+
end
|
123
|
+
```
|
124
|
+
|
125
|
+
#### Using the get_files_file_id_with_http_info variant
|
126
|
+
|
127
|
+
This returns an Array which contains the response data, status code and headers.
|
128
|
+
|
129
|
+
> <Array(<GetFilesFileIdResponse>, Integer, Hash)> get_files_file_id_with_http_info(file_id)
|
130
|
+
|
131
|
+
```ruby
|
132
|
+
begin
|
133
|
+
# Retrieve a File
|
134
|
+
data, status_code, headers = api_instance.get_files_file_id_with_http_info(file_id)
|
135
|
+
p status_code # => 2xx
|
136
|
+
p headers # => { ... }
|
137
|
+
p data # => <GetFilesFileIdResponse>
|
138
|
+
rescue MelioPlatformApiClient::ApiError => e
|
139
|
+
puts "Error when calling FilesApi->get_files_file_id_with_http_info: #{e}"
|
140
|
+
end
|
141
|
+
```
|
142
|
+
|
143
|
+
### Parameters
|
144
|
+
|
145
|
+
| Name | Type | Description | Notes |
|
146
|
+
| ---- | ---- | ----------- | ----- |
|
147
|
+
| **file_id** | **String** | | |
|
148
|
+
|
149
|
+
### Return type
|
150
|
+
|
151
|
+
[**GetFilesFileIdResponse**](GetFilesFileIdResponse.md)
|
152
|
+
|
153
|
+
### Authorization
|
154
|
+
|
155
|
+
[AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
|
156
|
+
|
157
|
+
### HTTP request headers
|
158
|
+
|
159
|
+
- **Content-Type**: Not defined
|
160
|
+
- **Accept**: application/json
|
161
|
+
|
162
|
+
|
163
|
+
## get_files_file_id_data
|
164
|
+
|
165
|
+
> <GetFilesFileIdDataResponse> get_files_file_id_data(file_id, opts)
|
166
|
+
|
167
|
+
Retrieve data from a File using OCR
|
168
|
+
|
169
|
+
### Examples
|
170
|
+
|
171
|
+
```ruby
|
172
|
+
require 'time'
|
173
|
+
require 'melio-platform-api-client'
|
174
|
+
# setup authorization
|
175
|
+
MelioPlatformApiClient.configure do |config|
|
176
|
+
# Configure Bearer authorization: AccessToken
|
177
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
178
|
+
|
179
|
+
# Configure API key authorization: ApiKey
|
180
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
181
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
182
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
183
|
+
end
|
184
|
+
|
185
|
+
api_instance = MelioPlatformApiClient::FilesApi.new
|
186
|
+
file_id = 'file_id_example' # String |
|
187
|
+
opts = {
|
188
|
+
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.
|
189
|
+
}
|
190
|
+
|
191
|
+
begin
|
192
|
+
# Retrieve data from a File using OCR
|
193
|
+
result = api_instance.get_files_file_id_data(file_id, opts)
|
194
|
+
p result
|
195
|
+
rescue MelioPlatformApiClient::ApiError => e
|
196
|
+
puts "Error when calling FilesApi->get_files_file_id_data: #{e}"
|
197
|
+
end
|
198
|
+
```
|
199
|
+
|
200
|
+
#### Using the get_files_file_id_data_with_http_info variant
|
201
|
+
|
202
|
+
This returns an Array which contains the response data, status code and headers.
|
203
|
+
|
204
|
+
> <Array(<GetFilesFileIdDataResponse>, Integer, Hash)> get_files_file_id_data_with_http_info(file_id, opts)
|
205
|
+
|
206
|
+
```ruby
|
207
|
+
begin
|
208
|
+
# Retrieve data from a File using OCR
|
209
|
+
data, status_code, headers = api_instance.get_files_file_id_data_with_http_info(file_id, opts)
|
210
|
+
p status_code # => 2xx
|
211
|
+
p headers # => { ... }
|
212
|
+
p data # => <GetFilesFileIdDataResponse>
|
213
|
+
rescue MelioPlatformApiClient::ApiError => e
|
214
|
+
puts "Error when calling FilesApi->get_files_file_id_data_with_http_info: #{e}"
|
215
|
+
end
|
216
|
+
```
|
217
|
+
|
218
|
+
### Parameters
|
219
|
+
|
220
|
+
| Name | Type | Description | Notes |
|
221
|
+
| ---- | ---- | ----------- | ----- |
|
222
|
+
| **file_id** | **String** | | |
|
223
|
+
| **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] |
|
224
|
+
|
225
|
+
### Return type
|
226
|
+
|
227
|
+
[**GetFilesFileIdDataResponse**](GetFilesFileIdDataResponse.md)
|
228
|
+
|
229
|
+
### Authorization
|
230
|
+
|
231
|
+
[AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
|
232
|
+
|
233
|
+
### HTTP request headers
|
234
|
+
|
235
|
+
- **Content-Type**: Not defined
|
236
|
+
- **Accept**: application/json
|
237
|
+
|
238
|
+
|
239
|
+
## post_files
|
240
|
+
|
241
|
+
> <PostFilesResponse> post_files(idempotency_key, opts)
|
242
|
+
|
243
|
+
Create / upload a File
|
244
|
+
|
245
|
+
Upload a file as a File object, to be used by other operations
|
246
|
+
|
247
|
+
### Examples
|
248
|
+
|
249
|
+
```ruby
|
250
|
+
require 'time'
|
251
|
+
require 'melio-platform-api-client'
|
252
|
+
# setup authorization
|
253
|
+
MelioPlatformApiClient.configure do |config|
|
254
|
+
# Configure Bearer authorization: AccessToken
|
255
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
256
|
+
|
257
|
+
# Configure API key authorization: ApiKey
|
258
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
259
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
260
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
261
|
+
end
|
262
|
+
|
263
|
+
api_instance = MelioPlatformApiClient::FilesApi.new
|
264
|
+
idempotency_key = 'idempotency_key_example' # String | Unique idempotency key
|
265
|
+
opts = {
|
266
|
+
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.
|
267
|
+
file: File.new('/path/to/some/file') # File |
|
268
|
+
}
|
269
|
+
|
270
|
+
begin
|
271
|
+
# Create / upload a File
|
272
|
+
result = api_instance.post_files(idempotency_key, opts)
|
273
|
+
p result
|
274
|
+
rescue MelioPlatformApiClient::ApiError => e
|
275
|
+
puts "Error when calling FilesApi->post_files: #{e}"
|
276
|
+
end
|
277
|
+
```
|
278
|
+
|
279
|
+
#### Using the post_files_with_http_info variant
|
280
|
+
|
281
|
+
This returns an Array which contains the response data, status code and headers.
|
282
|
+
|
283
|
+
> <Array(<PostFilesResponse>, Integer, Hash)> post_files_with_http_info(idempotency_key, opts)
|
284
|
+
|
285
|
+
```ruby
|
286
|
+
begin
|
287
|
+
# Create / upload a File
|
288
|
+
data, status_code, headers = api_instance.post_files_with_http_info(idempotency_key, opts)
|
289
|
+
p status_code # => 2xx
|
290
|
+
p headers # => { ... }
|
291
|
+
p data # => <PostFilesResponse>
|
292
|
+
rescue MelioPlatformApiClient::ApiError => e
|
293
|
+
puts "Error when calling FilesApi->post_files_with_http_info: #{e}"
|
294
|
+
end
|
295
|
+
```
|
296
|
+
|
297
|
+
### Parameters
|
298
|
+
|
299
|
+
| Name | Type | Description | Notes |
|
300
|
+
| ---- | ---- | ----------- | ----- |
|
301
|
+
| **idempotency_key** | **String** | Unique idempotency key | |
|
302
|
+
| **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] |
|
303
|
+
| **file** | **File** | | [optional] |
|
304
|
+
|
305
|
+
### Return type
|
306
|
+
|
307
|
+
[**PostFilesResponse**](PostFilesResponse.md)
|
308
|
+
|
309
|
+
### Authorization
|
310
|
+
|
311
|
+
[AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
|
312
|
+
|
313
|
+
### HTTP request headers
|
314
|
+
|
315
|
+
- **Content-Type**: multipart/form-data
|
316
|
+
- **Accept**: application/json
|
317
|
+
|
data/docs/Financing.md
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# MelioPlatformApiClient::Financing
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **fields** | [**Array<FinancingFields>**](FinancingFields.md) | Qualification requests may require different fields for different types of companies. Use this data in order to render a form according to the required fields. Then, call the matching POST /financing request with the collected data. | |
|
8
|
+
| **terms_of_service** | **String** | | [optional] |
|
9
|
+
| **status** | **String** | | |
|
10
|
+
| **balance** | **Integer** | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'melio-platform-api-client'
|
16
|
+
|
17
|
+
instance = MelioPlatformApiClient::Financing.new(
|
18
|
+
fields: null,
|
19
|
+
terms_of_service: null,
|
20
|
+
status: null,
|
21
|
+
balance: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,246 @@
|
|
1
|
+
# MelioPlatformApiClient::FinancingApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.melio.com/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_financing_status**](FinancingApi.md#get_financing_status) | **GET** /financing | Retrieve an Account's financing status |
|
8
|
+
| [**post_financing**](FinancingApi.md#post_financing) | **POST** /financing | Apply for financing for an Account |
|
9
|
+
| [**post_financing_transaction**](FinancingApi.md#post_financing_transaction) | **POST** /financing/transaction | Request Transactional Financing |
|
10
|
+
|
11
|
+
|
12
|
+
## get_financing_status
|
13
|
+
|
14
|
+
> <GetFinancingResponse> get_financing_status(opts)
|
15
|
+
|
16
|
+
Retrieve an Account's financing status
|
17
|
+
|
18
|
+
Return the current status and balance of an account's financing qualification. The account may be in one of a few steps, defined by the response's `status` enum: - Undetermined (`undetermined` status): The account hasn't qualified yet, or the qualification has expired - Pending (`pending` status): The account has requested qualification, and awaiting for response. - Ineligible (`ineligible` status): The account is currently not eligible for financing. - Eligible (`eligible` status): The account is eligibile for financing. In this case, the additional `balance` field would be populated with the remaining credit balance.
|
19
|
+
|
20
|
+
### Examples
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
require 'time'
|
24
|
+
require 'melio-platform-api-client'
|
25
|
+
# setup authorization
|
26
|
+
MelioPlatformApiClient.configure do |config|
|
27
|
+
# Configure Bearer authorization: AccessToken
|
28
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
29
|
+
|
30
|
+
# Configure API key authorization: ApiKey
|
31
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
32
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
33
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
34
|
+
end
|
35
|
+
|
36
|
+
api_instance = MelioPlatformApiClient::FinancingApi.new
|
37
|
+
opts = {
|
38
|
+
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.
|
39
|
+
}
|
40
|
+
|
41
|
+
begin
|
42
|
+
# Retrieve an Account's financing status
|
43
|
+
result = api_instance.get_financing_status(opts)
|
44
|
+
p result
|
45
|
+
rescue MelioPlatformApiClient::ApiError => e
|
46
|
+
puts "Error when calling FinancingApi->get_financing_status: #{e}"
|
47
|
+
end
|
48
|
+
```
|
49
|
+
|
50
|
+
#### Using the get_financing_status_with_http_info variant
|
51
|
+
|
52
|
+
This returns an Array which contains the response data, status code and headers.
|
53
|
+
|
54
|
+
> <Array(<GetFinancingResponse>, Integer, Hash)> get_financing_status_with_http_info(opts)
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
begin
|
58
|
+
# Retrieve an Account's financing status
|
59
|
+
data, status_code, headers = api_instance.get_financing_status_with_http_info(opts)
|
60
|
+
p status_code # => 2xx
|
61
|
+
p headers # => { ... }
|
62
|
+
p data # => <GetFinancingResponse>
|
63
|
+
rescue MelioPlatformApiClient::ApiError => e
|
64
|
+
puts "Error when calling FinancingApi->get_financing_status_with_http_info: #{e}"
|
65
|
+
end
|
66
|
+
```
|
67
|
+
|
68
|
+
### Parameters
|
69
|
+
|
70
|
+
| Name | Type | Description | Notes |
|
71
|
+
| ---- | ---- | ----------- | ----- |
|
72
|
+
| **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] |
|
73
|
+
|
74
|
+
### Return type
|
75
|
+
|
76
|
+
[**GetFinancingResponse**](GetFinancingResponse.md)
|
77
|
+
|
78
|
+
### Authorization
|
79
|
+
|
80
|
+
[AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
|
81
|
+
|
82
|
+
### HTTP request headers
|
83
|
+
|
84
|
+
- **Content-Type**: Not defined
|
85
|
+
- **Accept**: application/json
|
86
|
+
|
87
|
+
|
88
|
+
## post_financing
|
89
|
+
|
90
|
+
> <PostFinancingResponse> post_financing(idempotency_key, opts)
|
91
|
+
|
92
|
+
Apply for financing for an Account
|
93
|
+
|
94
|
+
Accounts that wish to use financing must qualify for it. Call this method with values collected based on the result of `GET /financing` This operation may take a long time (30 seconds).
|
95
|
+
|
96
|
+
### Examples
|
97
|
+
|
98
|
+
```ruby
|
99
|
+
require 'time'
|
100
|
+
require 'melio-platform-api-client'
|
101
|
+
# setup authorization
|
102
|
+
MelioPlatformApiClient.configure do |config|
|
103
|
+
# Configure Bearer authorization: AccessToken
|
104
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
105
|
+
|
106
|
+
# Configure API key authorization: ApiKey
|
107
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
108
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
109
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
110
|
+
end
|
111
|
+
|
112
|
+
api_instance = MelioPlatformApiClient::FinancingApi.new
|
113
|
+
idempotency_key = 'idempotency_key_example' # String | Unique idempotency key
|
114
|
+
opts = {
|
115
|
+
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.
|
116
|
+
post_financing_request: MelioPlatformApiClient::PostFinancingRequest.new # PostFinancingRequest |
|
117
|
+
}
|
118
|
+
|
119
|
+
begin
|
120
|
+
# Apply for financing for an Account
|
121
|
+
result = api_instance.post_financing(idempotency_key, opts)
|
122
|
+
p result
|
123
|
+
rescue MelioPlatformApiClient::ApiError => e
|
124
|
+
puts "Error when calling FinancingApi->post_financing: #{e}"
|
125
|
+
end
|
126
|
+
```
|
127
|
+
|
128
|
+
#### Using the post_financing_with_http_info variant
|
129
|
+
|
130
|
+
This returns an Array which contains the response data, status code and headers.
|
131
|
+
|
132
|
+
> <Array(<PostFinancingResponse>, Integer, Hash)> post_financing_with_http_info(idempotency_key, opts)
|
133
|
+
|
134
|
+
```ruby
|
135
|
+
begin
|
136
|
+
# Apply for financing for an Account
|
137
|
+
data, status_code, headers = api_instance.post_financing_with_http_info(idempotency_key, opts)
|
138
|
+
p status_code # => 2xx
|
139
|
+
p headers # => { ... }
|
140
|
+
p data # => <PostFinancingResponse>
|
141
|
+
rescue MelioPlatformApiClient::ApiError => e
|
142
|
+
puts "Error when calling FinancingApi->post_financing_with_http_info: #{e}"
|
143
|
+
end
|
144
|
+
```
|
145
|
+
|
146
|
+
### Parameters
|
147
|
+
|
148
|
+
| Name | Type | Description | Notes |
|
149
|
+
| ---- | ---- | ----------- | ----- |
|
150
|
+
| **idempotency_key** | **String** | Unique idempotency key | |
|
151
|
+
| **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] |
|
152
|
+
| **post_financing_request** | [**PostFinancingRequest**](PostFinancingRequest.md) | | [optional] |
|
153
|
+
|
154
|
+
### Return type
|
155
|
+
|
156
|
+
[**PostFinancingResponse**](PostFinancingResponse.md)
|
157
|
+
|
158
|
+
### Authorization
|
159
|
+
|
160
|
+
[AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
|
161
|
+
|
162
|
+
### HTTP request headers
|
163
|
+
|
164
|
+
- **Content-Type**: application/json
|
165
|
+
- **Accept**: application/json
|
166
|
+
|
167
|
+
|
168
|
+
## post_financing_transaction
|
169
|
+
|
170
|
+
> <PostFinancingTransactionalResponse> post_financing_transaction(idempotency_key, opts)
|
171
|
+
|
172
|
+
Request Transactional Financing
|
173
|
+
|
174
|
+
An eligible Account must request transactional approval for each financed transaction they intend to perform. The result of this operation returns a token that should be used when completing other payments through Melio. This operation may take a long time (10 seconds).
|
175
|
+
|
176
|
+
### Examples
|
177
|
+
|
178
|
+
```ruby
|
179
|
+
require 'time'
|
180
|
+
require 'melio-platform-api-client'
|
181
|
+
# setup authorization
|
182
|
+
MelioPlatformApiClient.configure do |config|
|
183
|
+
# Configure Bearer authorization: AccessToken
|
184
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
185
|
+
|
186
|
+
# Configure API key authorization: ApiKey
|
187
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
188
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
189
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
190
|
+
end
|
191
|
+
|
192
|
+
api_instance = MelioPlatformApiClient::FinancingApi.new
|
193
|
+
idempotency_key = 'idempotency_key_example' # String | Unique idempotency key
|
194
|
+
opts = {
|
195
|
+
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.
|
196
|
+
post_financing_transactional_request: MelioPlatformApiClient::PostFinancingTransactionalRequest.new({amount: 150000, payee_account_id: 'payee_account_id_example'}) # PostFinancingTransactionalRequest |
|
197
|
+
}
|
198
|
+
|
199
|
+
begin
|
200
|
+
# Request Transactional Financing
|
201
|
+
result = api_instance.post_financing_transaction(idempotency_key, opts)
|
202
|
+
p result
|
203
|
+
rescue MelioPlatformApiClient::ApiError => e
|
204
|
+
puts "Error when calling FinancingApi->post_financing_transaction: #{e}"
|
205
|
+
end
|
206
|
+
```
|
207
|
+
|
208
|
+
#### Using the post_financing_transaction_with_http_info variant
|
209
|
+
|
210
|
+
This returns an Array which contains the response data, status code and headers.
|
211
|
+
|
212
|
+
> <Array(<PostFinancingTransactionalResponse>, Integer, Hash)> post_financing_transaction_with_http_info(idempotency_key, opts)
|
213
|
+
|
214
|
+
```ruby
|
215
|
+
begin
|
216
|
+
# Request Transactional Financing
|
217
|
+
data, status_code, headers = api_instance.post_financing_transaction_with_http_info(idempotency_key, opts)
|
218
|
+
p status_code # => 2xx
|
219
|
+
p headers # => { ... }
|
220
|
+
p data # => <PostFinancingTransactionalResponse>
|
221
|
+
rescue MelioPlatformApiClient::ApiError => e
|
222
|
+
puts "Error when calling FinancingApi->post_financing_transaction_with_http_info: #{e}"
|
223
|
+
end
|
224
|
+
```
|
225
|
+
|
226
|
+
### Parameters
|
227
|
+
|
228
|
+
| Name | Type | Description | Notes |
|
229
|
+
| ---- | ---- | ----------- | ----- |
|
230
|
+
| **idempotency_key** | **String** | Unique idempotency key | |
|
231
|
+
| **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] |
|
232
|
+
| **post_financing_transactional_request** | [**PostFinancingTransactionalRequest**](PostFinancingTransactionalRequest.md) | | [optional] |
|
233
|
+
|
234
|
+
### Return type
|
235
|
+
|
236
|
+
[**PostFinancingTransactionalResponse**](PostFinancingTransactionalResponse.md)
|
237
|
+
|
238
|
+
### Authorization
|
239
|
+
|
240
|
+
[AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
|
241
|
+
|
242
|
+
### HTTP request headers
|
243
|
+
|
244
|
+
- **Content-Type**: application/json
|
245
|
+
- **Accept**: application/json
|
246
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MelioPlatformApiClient::FinancingDropdownOptions
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **value** | **String** | | [optional] |
|
8
|
+
| **label** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'melio-platform-api-client'
|
14
|
+
|
15
|
+
instance = MelioPlatformApiClient::FinancingDropdownOptions.new(
|
16
|
+
value: null,
|
17
|
+
label: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# MelioPlatformApiClient::FinancingFields
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **field_key** | **String** | | [optional] |
|
8
|
+
| **label** | **String** | | [optional] |
|
9
|
+
| **validation_regex** | **String** | | [optional] |
|
10
|
+
| **type** | **String** | | [optional] |
|
11
|
+
| **placeholder** | **String** | | [optional] |
|
12
|
+
| **dropdown_options** | [**Array<FinancingDropdownOptions>**](FinancingDropdownOptions.md) | | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'melio-platform-api-client'
|
18
|
+
|
19
|
+
instance = MelioPlatformApiClient::FinancingFields.new(
|
20
|
+
field_key: null,
|
21
|
+
label: null,
|
22
|
+
validation_regex: null,
|
23
|
+
type: null,
|
24
|
+
placeholder: null,
|
25
|
+
dropdown_options: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# MelioPlatformApiClient::FundingSource
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | Identifier of the entity. | |
|
8
|
+
| **history** | [**ShortHistory**](ShortHistory.md) | | |
|
9
|
+
| **display_name** | **String** | | [optional] |
|
10
|
+
| **type** | [**FundingSourceType**](FundingSourceType.md) | | |
|
11
|
+
| **details** | [**FundingSourceDetails**](FundingSourceDetails.md) | | |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'melio-platform-api-client'
|
17
|
+
|
18
|
+
instance = MelioPlatformApiClient::FundingSource.new(
|
19
|
+
id: null,
|
20
|
+
history: null,
|
21
|
+
display_name: null,
|
22
|
+
type: null,
|
23
|
+
details: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MelioPlatformApiClient::FundingSourceAllOf
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **display_name** | **String** | | [optional] |
|
8
|
+
| **type** | [**FundingSourceType**](FundingSourceType.md) | | |
|
9
|
+
| **details** | [**FundingSourceDetails**](FundingSourceDetails.md) | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'melio-platform-api-client'
|
15
|
+
|
16
|
+
instance = MelioPlatformApiClient::FundingSourceAllOf.new(
|
17
|
+
display_name: null,
|
18
|
+
type: null,
|
19
|
+
details: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|