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.

Files changed (515) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +132 -0
  4. data/Rakefile +10 -0
  5. data/docs/Account.md +26 -0
  6. data/docs/AccountAllOf.md +22 -0
  7. data/docs/AccountsApi.md +224 -0
  8. data/docs/AddToMyVendorParameters.md +18 -0
  9. data/docs/AddToMyVendorParametersDeliveryMethod.md +20 -0
  10. data/docs/AddToMyVendorParametersDeliveryMethodBillerAccount.md +18 -0
  11. data/docs/Address.md +26 -0
  12. data/docs/Adjustment.md +20 -0
  13. data/docs/AuthApi.md +83 -0
  14. data/docs/BankAccount.md +22 -0
  15. data/docs/BankAccountType.md +15 -0
  16. data/docs/BillerAccount.md +18 -0
  17. data/docs/Card.md +24 -0
  18. data/docs/Charge.md +32 -0
  19. data/docs/ChargeAllOf.md +28 -0
  20. data/docs/ChargesApi.md +317 -0
  21. data/docs/Checkout.md +66 -0
  22. data/docs/CheckoutAllOf.md +62 -0
  23. data/docs/CheckoutAllOfBuyer.md +26 -0
  24. data/docs/CheckoutsApi.md +327 -0
  25. data/docs/Company.md +28 -0
  26. data/docs/ConfirmPaymentIntentsResponse.md +18 -0
  27. data/docs/Currency.md +15 -0
  28. data/docs/DeletedResponse.md +18 -0
  29. data/docs/DeliveryMethod.md +24 -0
  30. data/docs/DeliveryMethodAllOf.md +20 -0
  31. data/docs/DeliveryMethodDetails.md +55 -0
  32. data/docs/DeliveryMethodType.md +15 -0
  33. data/docs/DeliveryMethodsApi.md +485 -0
  34. data/docs/DeliveryPreference.md +28 -0
  35. data/docs/DeliveryPreferenceType.md +15 -0
  36. data/docs/DomesticWireAccount.md +22 -0
  37. data/docs/DomesticWireAccountAddress.md +22 -0
  38. data/docs/ErrorResponse.md +18 -0
  39. data/docs/FileInfo.md +22 -0
  40. data/docs/FileInfoAllOf.md +18 -0
  41. data/docs/FilesApi.md +317 -0
  42. data/docs/Financing.md +24 -0
  43. data/docs/FinancingApi.md +246 -0
  44. data/docs/FinancingDropdownOptions.md +20 -0
  45. data/docs/FinancingFields.md +28 -0
  46. data/docs/FundingSource.md +26 -0
  47. data/docs/FundingSourceAllOf.md +22 -0
  48. data/docs/FundingSourceDetails.md +49 -0
  49. data/docs/FundingSourceType.md +15 -0
  50. data/docs/FundingSourcesApi.md +325 -0
  51. data/docs/GetAccountsAccountIdResponse.md +18 -0
  52. data/docs/GetAccountsResponse.md +18 -0
  53. data/docs/GetChargesChargeIdResponse.md +18 -0
  54. data/docs/GetChargesResponse.md +18 -0
  55. data/docs/GetCheckoutsCheckoutIdResponse.md +18 -0
  56. data/docs/GetDeliveryMethodsDeliveryMethodIdResponse.md +18 -0
  57. data/docs/GetDeliveryMethodsResponse.md +18 -0
  58. data/docs/GetFilesFileIdDataResponse.md +18 -0
  59. data/docs/GetFilesFileIdDataResponseData.md +26 -0
  60. data/docs/GetFilesFileIdDataResponseDataCustomerInfo.md +18 -0
  61. data/docs/GetFilesFileIdDataResponseDataInvoiceInfo.md +20 -0
  62. data/docs/GetFilesFileIdDataResponseDataVendorInfo.md +20 -0
  63. data/docs/GetFilesFileIdResponse.md +18 -0
  64. data/docs/GetFilesResponse.md +18 -0
  65. data/docs/GetFinancingResponse.md +18 -0
  66. data/docs/GetFundingSourcesFundingSourceIdResponse.md +18 -0
  67. data/docs/GetFundingSourcesResponse.md +18 -0
  68. data/docs/GetPaymentIntentsPaymentIntentIdResponse.md +18 -0
  69. data/docs/GetPaymentIntentsResponse.md +18 -0
  70. data/docs/GetPaymentsPaymentIdResponse.md +18 -0
  71. data/docs/GetPaymentsResponse.md +18 -0
  72. data/docs/GetVendorDirectoryResponse.md +18 -0
  73. data/docs/GetVendorsResponse.md +18 -0
  74. data/docs/GetVendorsVendorIdDeliveryMethodsResponse.md +18 -0
  75. data/docs/GetVendorsVendorIdResponse.md +18 -0
  76. data/docs/GetWebhooksCheckoutsResponse.md +18 -0
  77. data/docs/GetWebhooksPaymentsResponse.md +18 -0
  78. data/docs/GetWebhooksResponse.md +18 -0
  79. data/docs/Invoice.md +20 -0
  80. data/docs/LineItem.md +30 -0
  81. data/docs/Merchant.md +38 -0
  82. data/docs/MerchantAllOf.md +34 -0
  83. data/docs/MerchantsApi.md +85 -0
  84. data/docs/ModelError.md +22 -0
  85. data/docs/ModelErrorAllOf.md +20 -0
  86. data/docs/Object.md +20 -0
  87. data/docs/PaperCheck.md +20 -0
  88. data/docs/PartialAddress.md +26 -0
  89. data/docs/PatchChargesChargeIdRequest.md +18 -0
  90. data/docs/PatchChargesChargeIdResponse.md +18 -0
  91. data/docs/PatchPaymentIntentsPaymentIntentIdRequest.md +30 -0
  92. data/docs/PatchPaymentIntentsPaymentIntentIdRequestBillInfo.md +26 -0
  93. data/docs/PatchPaymentIntentsPaymentIntentIdResponse.md +18 -0
  94. data/docs/PatchVendorsVendorIdRequest.md +20 -0
  95. data/docs/PatchVendorsVendorIdRequestContact.md +22 -0
  96. data/docs/PatchVendorsVendorIdResponse.md +18 -0
  97. data/docs/Payment.md +48 -0
  98. data/docs/PaymentAllOf.md +44 -0
  99. data/docs/PaymentFee.md +20 -0
  100. data/docs/PaymentIntent.md +46 -0
  101. data/docs/PaymentIntentAllOf.md +42 -0
  102. data/docs/PaymentIntentAllOfBillInfo.md +30 -0
  103. data/docs/PaymentIntentsApi.md +483 -0
  104. data/docs/PaymentsApi.md +325 -0
  105. data/docs/Person.md +22 -0
  106. data/docs/PlaidDetails.md +20 -0
  107. data/docs/PostAccountsRequest.md +22 -0
  108. data/docs/PostAccountsResponse.md +18 -0
  109. data/docs/PostAuthResponse.md +18 -0
  110. data/docs/PostAuthResponseData.md +22 -0
  111. data/docs/PostCheckoutsCheckoutIdCaptureRequest.md +22 -0
  112. data/docs/PostCheckoutsCheckoutIdCaptureRequestInvoice.md +20 -0
  113. data/docs/PostCheckoutsCheckoutIdCompleteRequest.md +24 -0
  114. data/docs/PostCheckoutsRequest.md +48 -0
  115. data/docs/PostCheckoutsResponse.md +18 -0
  116. data/docs/PostDeliveryMethodsRequest.md +20 -0
  117. data/docs/PostDeliveryMethodsRequestDetails.md +53 -0
  118. data/docs/PostDeliveryMethodsResponse.md +18 -0
  119. data/docs/PostFilesResponse.md +18 -0
  120. data/docs/PostFinancingRequest.md +18 -0
  121. data/docs/PostFinancingRequestFields.md +20 -0
  122. data/docs/PostFinancingResponse.md +18 -0
  123. data/docs/PostFinancingTransactionalRequest.md +20 -0
  124. data/docs/PostFinancingTransactionalResponse.md +18 -0
  125. data/docs/PostFinancingTransactionalResponseData.md +20 -0
  126. data/docs/PostFundingSourcesRequest.md +22 -0
  127. data/docs/PostFundingSourcesRequestDetails.md +51 -0
  128. data/docs/PostFundingSourcesResponse.md +18 -0
  129. data/docs/PostMerchantsRequest.md +32 -0
  130. data/docs/PostMerchantsResponse.md +18 -0
  131. data/docs/PostPaymentIntentsBulkRequest.md +18 -0
  132. data/docs/PostPaymentIntentsBulkResponse.md +18 -0
  133. data/docs/PostPaymentIntentsPaymentIntentIdPaymentResponse.md +18 -0
  134. data/docs/PostPaymentIntentsRequest.md +30 -0
  135. data/docs/PostPaymentIntentsRequestBillInfo.md +26 -0
  136. data/docs/PostPaymentIntentsResponse.md +18 -0
  137. data/docs/PostPaymentsPaymentIdRecoverRequest.md +26 -0
  138. data/docs/PostPaymentsPaymentIdRecoverResponse.md +18 -0
  139. data/docs/PostVendorsBulkRequest.md +18 -0
  140. data/docs/PostVendorsBulkResponse.md +18 -0
  141. data/docs/PostVendorsFromVendorDirectoryRequest.md +20 -0
  142. data/docs/PostVendorsFromVendorDirectoryRequestDeliveryMethod.md +20 -0
  143. data/docs/PostVendorsFromVendorDirectoryResponse.md +18 -0
  144. data/docs/PostVendorsRequest.md +20 -0
  145. data/docs/PostVendorsResponse.md +18 -0
  146. data/docs/PostVendorsVendorIdDeliveryMethodsResponse.md +18 -0
  147. data/docs/PostWebhooksCheckoutsRequest.md +18 -0
  148. data/docs/PostWebhooksCheckoutsResponse.md +18 -0
  149. data/docs/PostWebhooksPaymentsRequest.md +18 -0
  150. data/docs/PostWebhooksPaymentsResponse.md +18 -0
  151. data/docs/PutPaymentIntentsRequest.md +36 -0
  152. data/docs/PutPaymentIntentsResponse.md +18 -0
  153. data/docs/RecoverPaymentRequest.md +36 -0
  154. data/docs/RecoverPaymentResponse.md +18 -0
  155. data/docs/ShortHistory.md +22 -0
  156. data/docs/TabaPayDetails.md +30 -0
  157. data/docs/TabaPayDetailsCardOwner.md +20 -0
  158. data/docs/TaxInfo.md +20 -0
  159. data/docs/Vendor.md +26 -0
  160. data/docs/VendorAllOf.md +22 -0
  161. data/docs/VendorAllOfContact.md +22 -0
  162. data/docs/VendorDirectory.md +26 -0
  163. data/docs/VendorDirectoryApi.md +169 -0
  164. data/docs/VendorDirectoryContact.md +24 -0
  165. data/docs/VendorDirectoryDeliveryMethod.md +18 -0
  166. data/docs/VendorDirectoryNotFoundResponse.md +18 -0
  167. data/docs/VendorsApi.md +806 -0
  168. data/docs/VirtualAccount.md +22 -0
  169. data/docs/Webhook.md +20 -0
  170. data/docs/WebhooksApi.md +510 -0
  171. data/docs/WithUnknownData.md +18 -0
  172. data/lib/melio-platform-api-client/api/accounts_api.rb +213 -0
  173. data/lib/melio-platform-api-client/api/auth_api.rb +89 -0
  174. data/lib/melio-platform-api-client/api/charges_api.rb +307 -0
  175. data/lib/melio-platform-api-client/api/checkouts_api.rb +328 -0
  176. data/lib/melio-platform-api-client/api/delivery_methods_api.rb +439 -0
  177. data/lib/melio-platform-api-client/api/files_api.rb +284 -0
  178. data/lib/melio-platform-api-client/api/financing_api.rb +230 -0
  179. data/lib/melio-platform-api-client/api/funding_sources_api.rb +295 -0
  180. data/lib/melio-platform-api-client/api/merchants_api.rb +96 -0
  181. data/lib/melio-platform-api-client/api/payment_intents_api.rb +443 -0
  182. data/lib/melio-platform-api-client/api/payments_api.rb +294 -0
  183. data/lib/melio-platform-api-client/api/vendor_directory_api.rb +170 -0
  184. data/lib/melio-platform-api-client/api/vendors_api.rb +738 -0
  185. data/lib/melio-platform-api-client/api/webhooks_api.rb +463 -0
  186. data/lib/melio-platform-api-client/api_client.rb +419 -0
  187. data/lib/melio-platform-api-client/api_error.rb +57 -0
  188. data/lib/melio-platform-api-client/configuration.rb +289 -0
  189. data/lib/melio-platform-api-client/models/account.rb +324 -0
  190. data/lib/melio-platform-api-client/models/account_all_of.rb +286 -0
  191. data/lib/melio-platform-api-client/models/add_to_my_vendor_parameters.rb +218 -0
  192. data/lib/melio-platform-api-client/models/add_to_my_vendor_parameters_delivery_method.rb +232 -0
  193. data/lib/melio-platform-api-client/models/add_to_my_vendor_parameters_delivery_method_biller_account.rb +224 -0
  194. data/lib/melio-platform-api-client/models/address.rb +277 -0
  195. data/lib/melio-platform-api-client/models/adjustment.rb +239 -0
  196. data/lib/melio-platform-api-client/models/bank_account.rb +254 -0
  197. data/lib/melio-platform-api-client/models/bank_account_type.rb +37 -0
  198. data/lib/melio-platform-api-client/models/biller_account.rb +223 -0
  199. data/lib/melio-platform-api-client/models/card.rb +339 -0
  200. data/lib/melio-platform-api-client/models/charge.rb +368 -0
  201. data/lib/melio-platform-api-client/models/charge_all_of.rb +330 -0
  202. data/lib/melio-platform-api-client/models/checkout.rb +588 -0
  203. data/lib/melio-platform-api-client/models/checkout_all_of.rb +550 -0
  204. data/lib/melio-platform-api-client/models/checkout_all_of_buyer.rb +265 -0
  205. data/lib/melio-platform-api-client/models/company.rb +295 -0
  206. data/lib/melio-platform-api-client/models/confirm_payment_intents_response.rb +223 -0
  207. data/lib/melio-platform-api-client/models/currency.rb +36 -0
  208. data/lib/melio-platform-api-client/models/deleted_response.rb +224 -0
  209. data/lib/melio-platform-api-client/models/delivery_method.rb +275 -0
  210. data/lib/melio-platform-api-client/models/delivery_method_all_of.rb +237 -0
  211. data/lib/melio-platform-api-client/models/delivery_method_details.rb +108 -0
  212. data/lib/melio-platform-api-client/models/delivery_method_type.rb +40 -0
  213. data/lib/melio-platform-api-client/models/delivery_preference.rb +283 -0
  214. data/lib/melio-platform-api-client/models/delivery_preference_type.rb +42 -0
  215. data/lib/melio-platform-api-client/models/domestic_wire_account.rb +252 -0
  216. data/lib/melio-platform-api-client/models/domestic_wire_account_address.rb +253 -0
  217. data/lib/melio-platform-api-client/models/error_response.rb +224 -0
  218. data/lib/melio-platform-api-client/models/file_info.rb +261 -0
  219. data/lib/melio-platform-api-client/models/file_info_all_of.rb +223 -0
  220. data/lib/melio-platform-api-client/models/financing.rb +293 -0
  221. data/lib/melio-platform-api-client/models/financing_dropdown_options.rb +227 -0
  222. data/lib/melio-platform-api-client/models/financing_fields.rb +265 -0
  223. data/lib/melio-platform-api-client/models/funding_source.rb +280 -0
  224. data/lib/melio-platform-api-client/models/funding_source_all_of.rb +242 -0
  225. data/lib/melio-platform-api-client/models/funding_source_details.rb +105 -0
  226. data/lib/melio-platform-api-client/models/funding_source_type.rb +37 -0
  227. data/lib/melio-platform-api-client/models/get_accounts_account_id_response.rb +223 -0
  228. data/lib/melio-platform-api-client/models/get_accounts_response.rb +225 -0
  229. data/lib/melio-platform-api-client/models/get_charges_charge_id_response.rb +223 -0
  230. data/lib/melio-platform-api-client/models/get_charges_response.rb +225 -0
  231. data/lib/melio-platform-api-client/models/get_checkouts_checkout_id_response.rb +223 -0
  232. data/lib/melio-platform-api-client/models/get_delivery_methods_delivery_method_id_response.rb +223 -0
  233. data/lib/melio-platform-api-client/models/get_delivery_methods_response.rb +225 -0
  234. data/lib/melio-platform-api-client/models/get_files_file_id_data_response.rb +218 -0
  235. data/lib/melio-platform-api-client/models/get_files_file_id_data_response_data.rb +254 -0
  236. data/lib/melio-platform-api-client/models/get_files_file_id_data_response_data_customer_info.rb +218 -0
  237. data/lib/melio-platform-api-client/models/get_files_file_id_data_response_data_invoice_info.rb +227 -0
  238. data/lib/melio-platform-api-client/models/get_files_file_id_data_response_data_vendor_info.rb +227 -0
  239. data/lib/melio-platform-api-client/models/get_files_file_id_response.rb +223 -0
  240. data/lib/melio-platform-api-client/models/get_files_response.rb +225 -0
  241. data/lib/melio-platform-api-client/models/get_financing_response.rb +223 -0
  242. data/lib/melio-platform-api-client/models/get_funding_sources_funding_source_id_response.rb +223 -0
  243. data/lib/melio-platform-api-client/models/get_funding_sources_response.rb +225 -0
  244. data/lib/melio-platform-api-client/models/get_payment_intents_payment_intent_id_response.rb +223 -0
  245. data/lib/melio-platform-api-client/models/get_payment_intents_response.rb +225 -0
  246. data/lib/melio-platform-api-client/models/get_payments_payment_id_response.rb +223 -0
  247. data/lib/melio-platform-api-client/models/get_payments_response.rb +225 -0
  248. data/lib/melio-platform-api-client/models/get_vendor_directory_response.rb +225 -0
  249. data/lib/melio-platform-api-client/models/get_vendors_response.rb +225 -0
  250. data/lib/melio-platform-api-client/models/get_vendors_vendor_id_delivery_methods_response.rb +225 -0
  251. data/lib/melio-platform-api-client/models/get_vendors_vendor_id_response.rb +223 -0
  252. data/lib/melio-platform-api-client/models/get_webhooks_checkouts_response.rb +223 -0
  253. data/lib/melio-platform-api-client/models/get_webhooks_payments_response.rb +223 -0
  254. data/lib/melio-platform-api-client/models/get_webhooks_response.rb +225 -0
  255. data/lib/melio-platform-api-client/models/invoice.rb +234 -0
  256. data/lib/melio-platform-api-client/models/line_item.rb +316 -0
  257. data/lib/melio-platform-api-client/models/merchant.rb +335 -0
  258. data/lib/melio-platform-api-client/models/merchant_all_of.rb +297 -0
  259. data/lib/melio-platform-api-client/models/model_error.rb +256 -0
  260. data/lib/melio-platform-api-client/models/model_error_all_of.rb +237 -0
  261. data/lib/melio-platform-api-client/models/object.rb +238 -0
  262. data/lib/melio-platform-api-client/models/paper_check.rb +239 -0
  263. data/lib/melio-platform-api-client/models/partial_address.rb +258 -0
  264. data/lib/melio-platform-api-client/models/patch_charges_charge_id_request.rb +218 -0
  265. data/lib/melio-platform-api-client/models/patch_charges_charge_id_response.rb +223 -0
  266. data/lib/melio-platform-api-client/models/patch_payment_intents_payment_intent_id_request.rb +275 -0
  267. data/lib/melio-platform-api-client/models/patch_payment_intents_payment_intent_id_request_bill_info.rb +257 -0
  268. data/lib/melio-platform-api-client/models/patch_payment_intents_payment_intent_id_response.rb +223 -0
  269. data/lib/melio-platform-api-client/models/patch_vendors_vendor_id_request.rb +227 -0
  270. data/lib/melio-platform-api-client/models/patch_vendors_vendor_id_request_contact.rb +237 -0
  271. data/lib/melio-platform-api-client/models/patch_vendors_vendor_id_response.rb +223 -0
  272. data/lib/melio-platform-api-client/models/payment.rb +469 -0
  273. data/lib/melio-platform-api-client/models/payment_all_of.rb +431 -0
  274. data/lib/melio-platform-api-client/models/payment_fee.rb +237 -0
  275. data/lib/melio-platform-api-client/models/payment_intent.rb +450 -0
  276. data/lib/melio-platform-api-client/models/payment_intent_all_of.rb +412 -0
  277. data/lib/melio-platform-api-client/models/payment_intent_all_of_bill_info.rb +301 -0
  278. data/lib/melio-platform-api-client/models/person.rb +252 -0
  279. data/lib/melio-platform-api-client/models/plaid_details.rb +239 -0
  280. data/lib/melio-platform-api-client/models/post_accounts_request.rb +248 -0
  281. data/lib/melio-platform-api-client/models/post_accounts_response.rb +223 -0
  282. data/lib/melio-platform-api-client/models/post_auth_response.rb +223 -0
  283. data/lib/melio-platform-api-client/models/post_auth_response_data.rb +251 -0
  284. data/lib/melio-platform-api-client/models/post_checkouts_checkout_id_capture_request.rb +271 -0
  285. data/lib/melio-platform-api-client/models/post_checkouts_checkout_id_capture_request_invoice.rb +234 -0
  286. data/lib/melio-platform-api-client/models/post_checkouts_checkout_id_complete_request.rb +253 -0
  287. data/lib/melio-platform-api-client/models/post_checkouts_request.rb +438 -0
  288. data/lib/melio-platform-api-client/models/post_checkouts_response.rb +223 -0
  289. data/lib/melio-platform-api-client/models/post_delivery_methods_request.rb +237 -0
  290. data/lib/melio-platform-api-client/models/post_delivery_methods_request_details.rb +107 -0
  291. data/lib/melio-platform-api-client/models/post_delivery_methods_response.rb +223 -0
  292. data/lib/melio-platform-api-client/models/post_files_response.rb +223 -0
  293. data/lib/melio-platform-api-client/models/post_financing_request.rb +220 -0
  294. data/lib/melio-platform-api-client/models/post_financing_request_fields.rb +237 -0
  295. data/lib/melio-platform-api-client/models/post_financing_response.rb +223 -0
  296. data/lib/melio-platform-api-client/models/post_financing_transactional_request.rb +239 -0
  297. data/lib/melio-platform-api-client/models/post_financing_transactional_response.rb +224 -0
  298. data/lib/melio-platform-api-client/models/post_financing_transactional_response_data.rb +271 -0
  299. data/lib/melio-platform-api-client/models/post_funding_sources_request.rb +280 -0
  300. data/lib/melio-platform-api-client/models/post_funding_sources_request_details.rb +106 -0
  301. data/lib/melio-platform-api-client/models/post_funding_sources_response.rb +223 -0
  302. data/lib/melio-platform-api-client/models/post_merchants_request.rb +283 -0
  303. data/lib/melio-platform-api-client/models/post_merchants_response.rb +223 -0
  304. data/lib/melio-platform-api-client/models/post_payment_intents_bulk_request.rb +225 -0
  305. data/lib/melio-platform-api-client/models/post_payment_intents_bulk_response.rb +225 -0
  306. data/lib/melio-platform-api-client/models/post_payment_intents_payment_intent_id_payment_response.rb +223 -0
  307. data/lib/melio-platform-api-client/models/post_payment_intents_request.rb +285 -0
  308. data/lib/melio-platform-api-client/models/post_payment_intents_request_bill_info.rb +277 -0
  309. data/lib/melio-platform-api-client/models/post_payment_intents_response.rb +223 -0
  310. data/lib/melio-platform-api-client/models/post_payments_payment_id_recover_request.rb +276 -0
  311. data/lib/melio-platform-api-client/models/post_payments_payment_id_recover_response.rb +223 -0
  312. data/lib/melio-platform-api-client/models/post_vendors_bulk_request.rb +225 -0
  313. data/lib/melio-platform-api-client/models/post_vendors_bulk_response.rb +225 -0
  314. data/lib/melio-platform-api-client/models/post_vendors_from_vendor_directory_request.rb +232 -0
  315. data/lib/melio-platform-api-client/models/post_vendors_from_vendor_directory_request_delivery_method.rb +233 -0
  316. data/lib/melio-platform-api-client/models/post_vendors_from_vendor_directory_response.rb +223 -0
  317. data/lib/melio-platform-api-client/models/post_vendors_request.rb +238 -0
  318. data/lib/melio-platform-api-client/models/post_vendors_response.rb +223 -0
  319. data/lib/melio-platform-api-client/models/post_vendors_vendor_id_delivery_methods_response.rb +223 -0
  320. data/lib/melio-platform-api-client/models/post_webhooks_checkouts_request.rb +223 -0
  321. data/lib/melio-platform-api-client/models/post_webhooks_checkouts_response.rb +223 -0
  322. data/lib/melio-platform-api-client/models/post_webhooks_payments_request.rb +223 -0
  323. data/lib/melio-platform-api-client/models/post_webhooks_payments_response.rb +223 -0
  324. data/lib/melio-platform-api-client/models/put_payment_intents_request.rb +305 -0
  325. data/lib/melio-platform-api-client/models/put_payment_intents_response.rb +223 -0
  326. data/lib/melio-platform-api-client/models/recover_payment_request.rb +304 -0
  327. data/lib/melio-platform-api-client/models/recover_payment_response.rb +223 -0
  328. data/lib/melio-platform-api-client/models/short_history.rb +247 -0
  329. data/lib/melio-platform-api-client/models/taba_pay_details.rb +380 -0
  330. data/lib/melio-platform-api-client/models/taba_pay_details_card_owner.rb +237 -0
  331. data/lib/melio-platform-api-client/models/tax_info.rb +273 -0
  332. data/lib/melio-platform-api-client/models/vendor.rb +292 -0
  333. data/lib/melio-platform-api-client/models/vendor_all_of.rb +254 -0
  334. data/lib/melio-platform-api-client/models/vendor_all_of_contact.rb +254 -0
  335. data/lib/melio-platform-api-client/models/vendor_directory.rb +283 -0
  336. data/lib/melio-platform-api-client/models/vendor_directory_contact.rb +261 -0
  337. data/lib/melio-platform-api-client/models/vendor_directory_delivery_method.rb +223 -0
  338. data/lib/melio-platform-api-client/models/vendor_directory_not_found_response.rb +219 -0
  339. data/lib/melio-platform-api-client/models/virtual_account.rb +243 -0
  340. data/lib/melio-platform-api-client/models/webhook.rb +227 -0
  341. data/lib/melio-platform-api-client/models/with_unknown_data.rb +219 -0
  342. data/lib/melio-platform-api-client/version.rb +15 -0
  343. data/lib/melio-platform-api-client.rb +206 -0
  344. data/melio-platform-api-client.gemspec +38 -0
  345. data/spec/api/accounts_api_spec.rb +71 -0
  346. data/spec/api/auth_api_spec.rb +48 -0
  347. data/spec/api/charges_api_spec.rb +90 -0
  348. data/spec/api/checkouts_api_spec.rb +93 -0
  349. data/spec/api/delivery_methods_api_spec.rb +115 -0
  350. data/spec/api/files_api_spec.rb +85 -0
  351. data/spec/api/financing_api_spec.rb +75 -0
  352. data/spec/api/funding_sources_api_spec.rb +88 -0
  353. data/spec/api/merchants_api_spec.rb +49 -0
  354. data/spec/api/payment_intents_api_spec.rb +114 -0
  355. data/spec/api/payments_api_spec.rb +88 -0
  356. data/spec/api/vendor_directory_api_spec.rb +62 -0
  357. data/spec/api/vendors_api_spec.rb +170 -0
  358. data/spec/api/webhooks_api_spec.rb +118 -0
  359. data/spec/api_client_spec.rb +226 -0
  360. data/spec/configuration_spec.rb +42 -0
  361. data/spec/models/account_all_of_spec.rb +50 -0
  362. data/spec/models/account_spec.rb +62 -0
  363. data/spec/models/add_to_my_vendor_parameters_delivery_method_biller_account_spec.rb +34 -0
  364. data/spec/models/add_to_my_vendor_parameters_delivery_method_spec.rb +40 -0
  365. data/spec/models/add_to_my_vendor_parameters_spec.rb +34 -0
  366. data/spec/models/address_spec.rb +58 -0
  367. data/spec/models/adjustment_spec.rb +40 -0
  368. data/spec/models/bank_account_spec.rb +46 -0
  369. data/spec/models/bank_account_type_spec.rb +28 -0
  370. data/spec/models/biller_account_spec.rb +34 -0
  371. data/spec/models/card_spec.rb +52 -0
  372. data/spec/models/charge_all_of_spec.rb +68 -0
  373. data/spec/models/charge_spec.rb +80 -0
  374. data/spec/models/checkout_all_of_buyer_spec.rb +58 -0
  375. data/spec/models/checkout_all_of_spec.rb +170 -0
  376. data/spec/models/checkout_spec.rb +182 -0
  377. data/spec/models/company_spec.rb +64 -0
  378. data/spec/models/confirm_payment_intents_response_spec.rb +34 -0
  379. data/spec/models/currency_spec.rb +28 -0
  380. data/spec/models/deleted_response_spec.rb +34 -0
  381. data/spec/models/delivery_method_all_of_spec.rb +40 -0
  382. data/spec/models/delivery_method_details_spec.rb +31 -0
  383. data/spec/models/delivery_method_spec.rb +52 -0
  384. data/spec/models/delivery_method_type_spec.rb +28 -0
  385. data/spec/models/delivery_preference_spec.rb +64 -0
  386. data/spec/models/delivery_preference_type_spec.rb +28 -0
  387. data/spec/models/domestic_wire_account_address_spec.rb +46 -0
  388. data/spec/models/domestic_wire_account_spec.rb +46 -0
  389. data/spec/models/error_response_spec.rb +34 -0
  390. data/spec/models/file_info_all_of_spec.rb +34 -0
  391. data/spec/models/file_info_spec.rb +46 -0
  392. data/spec/models/financing_dropdown_options_spec.rb +40 -0
  393. data/spec/models/financing_fields_spec.rb +64 -0
  394. data/spec/models/financing_spec.rb +56 -0
  395. data/spec/models/funding_source_all_of_spec.rb +46 -0
  396. data/spec/models/funding_source_details_spec.rb +31 -0
  397. data/spec/models/funding_source_spec.rb +58 -0
  398. data/spec/models/funding_source_type_spec.rb +28 -0
  399. data/spec/models/get_accounts_account_id_response_spec.rb +34 -0
  400. data/spec/models/get_accounts_response_spec.rb +34 -0
  401. data/spec/models/get_charges_charge_id_response_spec.rb +34 -0
  402. data/spec/models/get_charges_response_spec.rb +34 -0
  403. data/spec/models/get_checkouts_checkout_id_response_spec.rb +34 -0
  404. data/spec/models/get_delivery_methods_delivery_method_id_response_spec.rb +34 -0
  405. data/spec/models/get_delivery_methods_response_spec.rb +34 -0
  406. data/spec/models/get_files_file_id_data_response_data_customer_info_spec.rb +34 -0
  407. data/spec/models/get_files_file_id_data_response_data_invoice_info_spec.rb +40 -0
  408. data/spec/models/get_files_file_id_data_response_data_spec.rb +58 -0
  409. data/spec/models/get_files_file_id_data_response_data_vendor_info_spec.rb +40 -0
  410. data/spec/models/get_files_file_id_data_response_spec.rb +34 -0
  411. data/spec/models/get_files_file_id_response_spec.rb +34 -0
  412. data/spec/models/get_files_response_spec.rb +34 -0
  413. data/spec/models/get_financing_response_spec.rb +34 -0
  414. data/spec/models/get_funding_sources_funding_source_id_response_spec.rb +34 -0
  415. data/spec/models/get_funding_sources_response_spec.rb +34 -0
  416. data/spec/models/get_payment_intents_payment_intent_id_response_spec.rb +34 -0
  417. data/spec/models/get_payment_intents_response_spec.rb +34 -0
  418. data/spec/models/get_payments_payment_id_response_spec.rb +34 -0
  419. data/spec/models/get_payments_response_spec.rb +34 -0
  420. data/spec/models/get_vendor_directory_response_spec.rb +34 -0
  421. data/spec/models/get_vendors_response_spec.rb +34 -0
  422. data/spec/models/get_vendors_vendor_id_delivery_methods_response_spec.rb +34 -0
  423. data/spec/models/get_vendors_vendor_id_response_spec.rb +34 -0
  424. data/spec/models/get_webhooks_checkouts_response_spec.rb +34 -0
  425. data/spec/models/get_webhooks_payments_response_spec.rb +34 -0
  426. data/spec/models/get_webhooks_response_spec.rb +34 -0
  427. data/spec/models/invoice_spec.rb +40 -0
  428. data/spec/models/line_item_spec.rb +70 -0
  429. data/spec/models/merchant_all_of_spec.rb +82 -0
  430. data/spec/models/merchant_spec.rb +94 -0
  431. data/spec/models/model_error_all_of_spec.rb +40 -0
  432. data/spec/models/model_error_spec.rb +46 -0
  433. data/spec/models/object_spec.rb +40 -0
  434. data/spec/models/paper_check_spec.rb +40 -0
  435. data/spec/models/partial_address_spec.rb +58 -0
  436. data/spec/models/patch_charges_charge_id_request_spec.rb +34 -0
  437. data/spec/models/patch_charges_charge_id_response_spec.rb +34 -0
  438. data/spec/models/patch_payment_intents_payment_intent_id_request_bill_info_spec.rb +58 -0
  439. data/spec/models/patch_payment_intents_payment_intent_id_request_spec.rb +70 -0
  440. data/spec/models/patch_payment_intents_payment_intent_id_response_spec.rb +34 -0
  441. data/spec/models/patch_vendors_vendor_id_request_contact_spec.rb +46 -0
  442. data/spec/models/patch_vendors_vendor_id_request_spec.rb +40 -0
  443. data/spec/models/patch_vendors_vendor_id_response_spec.rb +34 -0
  444. data/spec/models/payment_all_of_spec.rb +116 -0
  445. data/spec/models/payment_fee_spec.rb +40 -0
  446. data/spec/models/payment_intent_all_of_bill_info_spec.rb +70 -0
  447. data/spec/models/payment_intent_all_of_spec.rb +110 -0
  448. data/spec/models/payment_intent_spec.rb +122 -0
  449. data/spec/models/payment_spec.rb +128 -0
  450. data/spec/models/person_spec.rb +46 -0
  451. data/spec/models/plaid_details_spec.rb +40 -0
  452. data/spec/models/post_accounts_request_spec.rb +46 -0
  453. data/spec/models/post_accounts_response_spec.rb +34 -0
  454. data/spec/models/post_auth_response_data_spec.rb +46 -0
  455. data/spec/models/post_auth_response_spec.rb +34 -0
  456. data/spec/models/post_checkouts_checkout_id_capture_request_invoice_spec.rb +40 -0
  457. data/spec/models/post_checkouts_checkout_id_capture_request_spec.rb +46 -0
  458. data/spec/models/post_checkouts_checkout_id_complete_request_spec.rb +52 -0
  459. data/spec/models/post_checkouts_request_spec.rb +124 -0
  460. data/spec/models/post_checkouts_response_spec.rb +34 -0
  461. data/spec/models/post_delivery_methods_request_details_spec.rb +31 -0
  462. data/spec/models/post_delivery_methods_request_spec.rb +40 -0
  463. data/spec/models/post_delivery_methods_response_spec.rb +34 -0
  464. data/spec/models/post_files_response_spec.rb +34 -0
  465. data/spec/models/post_financing_request_fields_spec.rb +40 -0
  466. data/spec/models/post_financing_request_spec.rb +34 -0
  467. data/spec/models/post_financing_response_spec.rb +34 -0
  468. data/spec/models/post_financing_transactional_request_spec.rb +40 -0
  469. data/spec/models/post_financing_transactional_response_data_spec.rb +44 -0
  470. data/spec/models/post_financing_transactional_response_spec.rb +34 -0
  471. data/spec/models/post_funding_sources_request_details_spec.rb +31 -0
  472. data/spec/models/post_funding_sources_request_spec.rb +50 -0
  473. data/spec/models/post_funding_sources_response_spec.rb +34 -0
  474. data/spec/models/post_merchants_request_spec.rb +76 -0
  475. data/spec/models/post_merchants_response_spec.rb +34 -0
  476. data/spec/models/post_payment_intents_bulk_request_spec.rb +34 -0
  477. data/spec/models/post_payment_intents_bulk_response_spec.rb +34 -0
  478. data/spec/models/post_payment_intents_payment_intent_id_payment_response_spec.rb +34 -0
  479. data/spec/models/post_payment_intents_request_bill_info_spec.rb +58 -0
  480. data/spec/models/post_payment_intents_request_spec.rb +70 -0
  481. data/spec/models/post_payment_intents_response_spec.rb +34 -0
  482. data/spec/models/post_payments_payment_id_recover_request_spec.rb +58 -0
  483. data/spec/models/post_payments_payment_id_recover_response_spec.rb +34 -0
  484. data/spec/models/post_vendors_bulk_request_spec.rb +34 -0
  485. data/spec/models/post_vendors_bulk_response_spec.rb +34 -0
  486. data/spec/models/post_vendors_from_vendor_directory_request_delivery_method_spec.rb +40 -0
  487. data/spec/models/post_vendors_from_vendor_directory_request_spec.rb +40 -0
  488. data/spec/models/post_vendors_from_vendor_directory_response_spec.rb +34 -0
  489. data/spec/models/post_vendors_request_spec.rb +40 -0
  490. data/spec/models/post_vendors_response_spec.rb +34 -0
  491. data/spec/models/post_vendors_vendor_id_delivery_methods_response_spec.rb +34 -0
  492. data/spec/models/post_webhooks_checkouts_request_spec.rb +34 -0
  493. data/spec/models/post_webhooks_checkouts_response_spec.rb +34 -0
  494. data/spec/models/post_webhooks_payments_request_spec.rb +34 -0
  495. data/spec/models/post_webhooks_payments_response_spec.rb +34 -0
  496. data/spec/models/put_payment_intents_request_spec.rb +88 -0
  497. data/spec/models/put_payment_intents_response_spec.rb +34 -0
  498. data/spec/models/recover_payment_request_spec.rb +88 -0
  499. data/spec/models/recover_payment_response_spec.rb +34 -0
  500. data/spec/models/short_history_spec.rb +46 -0
  501. data/spec/models/taba_pay_details_card_owner_spec.rb +40 -0
  502. data/spec/models/taba_pay_details_spec.rb +70 -0
  503. data/spec/models/tax_info_spec.rb +44 -0
  504. data/spec/models/vendor_all_of_contact_spec.rb +46 -0
  505. data/spec/models/vendor_all_of_spec.rb +46 -0
  506. data/spec/models/vendor_directory_contact_spec.rb +52 -0
  507. data/spec/models/vendor_directory_delivery_method_spec.rb +34 -0
  508. data/spec/models/vendor_directory_not_found_response_spec.rb +34 -0
  509. data/spec/models/vendor_directory_spec.rb +58 -0
  510. data/spec/models/vendor_spec.rb +58 -0
  511. data/spec/models/virtual_account_spec.rb +46 -0
  512. data/spec/models/webhook_spec.rb +40 -0
  513. data/spec/models/with_unknown_data_spec.rb +34 -0
  514. data/spec/spec_helper.rb +111 -0
  515. metadata +766 -0
@@ -0,0 +1,806 @@
1
+ # MelioPlatformApiClient::VendorsApi
2
+
3
+ All URIs are relative to *https://api.melio.com/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**delete_vendors_vendor_id**](VendorsApi.md#delete_vendors_vendor_id) | **DELETE** /vendors/{vendorId} | Delete a Vendor |
8
+ | [**get_vendor_directory**](VendorsApi.md#get_vendor_directory) | **GET** /vendor-directory | Retrieve all filtered Vendors in the Vendor Directory |
9
+ | [**get_vendors**](VendorsApi.md#get_vendors) | **GET** /vendors | Retrieve all Vendors |
10
+ | [**get_vendors_vendor_id**](VendorsApi.md#get_vendors_vendor_id) | **GET** /vendors/{vendorId} | Retrieve a Vendor |
11
+ | [**get_vendors_vendor_id_delivery_methods**](VendorsApi.md#get_vendors_vendor_id_delivery_methods) | **GET** /vendors/{vendorId}/delivery-methods | Retrieve a Vendor's Delivery Methods |
12
+ | [**patch_vendors_vendor_id**](VendorsApi.md#patch_vendors_vendor_id) | **PATCH** /vendors/{vendorId} | Update a Vendor |
13
+ | [**post_vendors**](VendorsApi.md#post_vendors) | **POST** /vendors | Create a Vendor |
14
+ | [**post_vendors_bulk**](VendorsApi.md#post_vendors_bulk) | **POST** /vendors/bulk | Create multiple Vendors |
15
+ | [**post_vendors_from_vendor_directory**](VendorsApi.md#post_vendors_from_vendor_directory) | **POST** /vendors/from-vendor-directory | Create a Vendor from Vendor Directory |
16
+ | [**post_vendors_vendor_id_delivery_methods**](VendorsApi.md#post_vendors_vendor_id_delivery_methods) | **POST** /vendors/{vendorId}/delivery-methods | Create a Vendor's Delivery Method |
17
+
18
+
19
+ ## delete_vendors_vendor_id
20
+
21
+ > <DeletedResponse> delete_vendors_vendor_id(vendor_id, idempotency_key, opts)
22
+
23
+ Delete a Vendor
24
+
25
+ Removing a Vendor from an Account.
26
+
27
+ ### Examples
28
+
29
+ ```ruby
30
+ require 'time'
31
+ require 'melio-platform-api-client'
32
+ # setup authorization
33
+ MelioPlatformApiClient.configure do |config|
34
+ # Configure Bearer authorization: AccessToken
35
+ config.access_token = 'YOUR_BEARER_TOKEN'
36
+
37
+ # Configure API key authorization: ApiKey
38
+ config.api_key['ApiKey'] = 'YOUR API KEY'
39
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
40
+ # config.api_key_prefix['ApiKey'] = 'Bearer'
41
+ end
42
+
43
+ api_instance = MelioPlatformApiClient::VendorsApi.new
44
+ vendor_id = 'vendor_id_example' # String |
45
+ idempotency_key = 'idempotency_key_example' # String | Unique idempotency key
46
+ opts = {
47
+ 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.
48
+ }
49
+
50
+ begin
51
+ # Delete a Vendor
52
+ result = api_instance.delete_vendors_vendor_id(vendor_id, idempotency_key, opts)
53
+ p result
54
+ rescue MelioPlatformApiClient::ApiError => e
55
+ puts "Error when calling VendorsApi->delete_vendors_vendor_id: #{e}"
56
+ end
57
+ ```
58
+
59
+ #### Using the delete_vendors_vendor_id_with_http_info variant
60
+
61
+ This returns an Array which contains the response data, status code and headers.
62
+
63
+ > <Array(<DeletedResponse>, Integer, Hash)> delete_vendors_vendor_id_with_http_info(vendor_id, idempotency_key, opts)
64
+
65
+ ```ruby
66
+ begin
67
+ # Delete a Vendor
68
+ data, status_code, headers = api_instance.delete_vendors_vendor_id_with_http_info(vendor_id, idempotency_key, opts)
69
+ p status_code # => 2xx
70
+ p headers # => { ... }
71
+ p data # => <DeletedResponse>
72
+ rescue MelioPlatformApiClient::ApiError => e
73
+ puts "Error when calling VendorsApi->delete_vendors_vendor_id_with_http_info: #{e}"
74
+ end
75
+ ```
76
+
77
+ ### Parameters
78
+
79
+ | Name | Type | Description | Notes |
80
+ | ---- | ---- | ----------- | ----- |
81
+ | **vendor_id** | **String** | | |
82
+ | **idempotency_key** | **String** | Unique idempotency key | |
83
+ | **melio_account** | **String** | The &#x60;Melio-Account&#x60; header is used when a Partner wants to perform an operation on behalf of one of its Accounts. It contains the Account&#39;s ID which returned when creating the Account, or when retrieving all of the Partner&#39;s Accounts. Note that most operations are not permitted without the presence of this header. | [optional] |
84
+
85
+ ### Return type
86
+
87
+ [**DeletedResponse**](DeletedResponse.md)
88
+
89
+ ### Authorization
90
+
91
+ [AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
92
+
93
+ ### HTTP request headers
94
+
95
+ - **Content-Type**: Not defined
96
+ - **Accept**: application/json
97
+
98
+
99
+ ## get_vendor_directory
100
+
101
+ > <GetVendorDirectoryResponse> get_vendor_directory(name, opts)
102
+
103
+ Retrieve all filtered Vendors in the Vendor Directory
104
+
105
+ List of all Vendors in the Vendor Directory, filtered by the name parameter and with provided query limit (default 20).
106
+
107
+ ### Examples
108
+
109
+ ```ruby
110
+ require 'time'
111
+ require 'melio-platform-api-client'
112
+ # setup authorization
113
+ MelioPlatformApiClient.configure do |config|
114
+ # Configure Bearer authorization: AccessToken
115
+ config.access_token = 'YOUR_BEARER_TOKEN'
116
+
117
+ # Configure API key authorization: ApiKey
118
+ config.api_key['ApiKey'] = 'YOUR API KEY'
119
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
120
+ # config.api_key_prefix['ApiKey'] = 'Bearer'
121
+ end
122
+
123
+ api_instance = MelioPlatformApiClient::VendorsApi.new
124
+ name = 'name_example' # String | The name of the Vendor to query
125
+ opts = {
126
+ limit: 56, # Integer | The number of items to include in the returned list
127
+ 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.
128
+ }
129
+
130
+ begin
131
+ # Retrieve all filtered Vendors in the Vendor Directory
132
+ result = api_instance.get_vendor_directory(name, opts)
133
+ p result
134
+ rescue MelioPlatformApiClient::ApiError => e
135
+ puts "Error when calling VendorsApi->get_vendor_directory: #{e}"
136
+ end
137
+ ```
138
+
139
+ #### Using the get_vendor_directory_with_http_info variant
140
+
141
+ This returns an Array which contains the response data, status code and headers.
142
+
143
+ > <Array(<GetVendorDirectoryResponse>, Integer, Hash)> get_vendor_directory_with_http_info(name, opts)
144
+
145
+ ```ruby
146
+ begin
147
+ # Retrieve all filtered Vendors in the Vendor Directory
148
+ data, status_code, headers = api_instance.get_vendor_directory_with_http_info(name, opts)
149
+ p status_code # => 2xx
150
+ p headers # => { ... }
151
+ p data # => <GetVendorDirectoryResponse>
152
+ rescue MelioPlatformApiClient::ApiError => e
153
+ puts "Error when calling VendorsApi->get_vendor_directory_with_http_info: #{e}"
154
+ end
155
+ ```
156
+
157
+ ### Parameters
158
+
159
+ | Name | Type | Description | Notes |
160
+ | ---- | ---- | ----------- | ----- |
161
+ | **name** | **String** | The name of the Vendor to query | |
162
+ | **limit** | **Integer** | The number of items to include in the returned list | [optional][default to 20] |
163
+ | **melio_account** | **String** | The &#x60;Melio-Account&#x60; header is used when a Partner wants to perform an operation on behalf of one of its Accounts. It contains the Account&#39;s ID which returned when creating the Account, or when retrieving all of the Partner&#39;s Accounts. Note that most operations are not permitted without the presence of this header. | [optional] |
164
+
165
+ ### Return type
166
+
167
+ [**GetVendorDirectoryResponse**](GetVendorDirectoryResponse.md)
168
+
169
+ ### Authorization
170
+
171
+ [AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
172
+
173
+ ### HTTP request headers
174
+
175
+ - **Content-Type**: Not defined
176
+ - **Accept**: application/json
177
+
178
+
179
+ ## get_vendors
180
+
181
+ > <GetVendorsResponse> get_vendors
182
+
183
+ Retrieve all Vendors
184
+
185
+ Retrieve a list of Vendors that are attached to an Account
186
+
187
+ ### Examples
188
+
189
+ ```ruby
190
+ require 'time'
191
+ require 'melio-platform-api-client'
192
+ # setup authorization
193
+ MelioPlatformApiClient.configure do |config|
194
+ # Configure Bearer authorization: AccessToken
195
+ config.access_token = 'YOUR_BEARER_TOKEN'
196
+
197
+ # Configure API key authorization: ApiKey
198
+ config.api_key['ApiKey'] = 'YOUR API KEY'
199
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
200
+ # config.api_key_prefix['ApiKey'] = 'Bearer'
201
+ end
202
+
203
+ api_instance = MelioPlatformApiClient::VendorsApi.new
204
+
205
+ begin
206
+ # Retrieve all Vendors
207
+ result = api_instance.get_vendors
208
+ p result
209
+ rescue MelioPlatformApiClient::ApiError => e
210
+ puts "Error when calling VendorsApi->get_vendors: #{e}"
211
+ end
212
+ ```
213
+
214
+ #### Using the get_vendors_with_http_info variant
215
+
216
+ This returns an Array which contains the response data, status code and headers.
217
+
218
+ > <Array(<GetVendorsResponse>, Integer, Hash)> get_vendors_with_http_info
219
+
220
+ ```ruby
221
+ begin
222
+ # Retrieve all Vendors
223
+ data, status_code, headers = api_instance.get_vendors_with_http_info
224
+ p status_code # => 2xx
225
+ p headers # => { ... }
226
+ p data # => <GetVendorsResponse>
227
+ rescue MelioPlatformApiClient::ApiError => e
228
+ puts "Error when calling VendorsApi->get_vendors_with_http_info: #{e}"
229
+ end
230
+ ```
231
+
232
+ ### Parameters
233
+
234
+ This endpoint does not need any parameter.
235
+
236
+ ### Return type
237
+
238
+ [**GetVendorsResponse**](GetVendorsResponse.md)
239
+
240
+ ### Authorization
241
+
242
+ [AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
243
+
244
+ ### HTTP request headers
245
+
246
+ - **Content-Type**: Not defined
247
+ - **Accept**: application/json
248
+
249
+
250
+ ## get_vendors_vendor_id
251
+
252
+ > <GetVendorsVendorIdResponse> get_vendors_vendor_id(vendor_id, opts)
253
+
254
+ Retrieve a Vendor
255
+
256
+ Retrieve a single Vendor using its ID.
257
+
258
+ ### Examples
259
+
260
+ ```ruby
261
+ require 'time'
262
+ require 'melio-platform-api-client'
263
+ # setup authorization
264
+ MelioPlatformApiClient.configure do |config|
265
+ # Configure Bearer authorization: AccessToken
266
+ config.access_token = 'YOUR_BEARER_TOKEN'
267
+
268
+ # Configure API key authorization: ApiKey
269
+ config.api_key['ApiKey'] = 'YOUR API KEY'
270
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
271
+ # config.api_key_prefix['ApiKey'] = 'Bearer'
272
+ end
273
+
274
+ api_instance = MelioPlatformApiClient::VendorsApi.new
275
+ vendor_id = 'vendor_id_example' # String |
276
+ opts = {
277
+ 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.
278
+ }
279
+
280
+ begin
281
+ # Retrieve a Vendor
282
+ result = api_instance.get_vendors_vendor_id(vendor_id, opts)
283
+ p result
284
+ rescue MelioPlatformApiClient::ApiError => e
285
+ puts "Error when calling VendorsApi->get_vendors_vendor_id: #{e}"
286
+ end
287
+ ```
288
+
289
+ #### Using the get_vendors_vendor_id_with_http_info variant
290
+
291
+ This returns an Array which contains the response data, status code and headers.
292
+
293
+ > <Array(<GetVendorsVendorIdResponse>, Integer, Hash)> get_vendors_vendor_id_with_http_info(vendor_id, opts)
294
+
295
+ ```ruby
296
+ begin
297
+ # Retrieve a Vendor
298
+ data, status_code, headers = api_instance.get_vendors_vendor_id_with_http_info(vendor_id, opts)
299
+ p status_code # => 2xx
300
+ p headers # => { ... }
301
+ p data # => <GetVendorsVendorIdResponse>
302
+ rescue MelioPlatformApiClient::ApiError => e
303
+ puts "Error when calling VendorsApi->get_vendors_vendor_id_with_http_info: #{e}"
304
+ end
305
+ ```
306
+
307
+ ### Parameters
308
+
309
+ | Name | Type | Description | Notes |
310
+ | ---- | ---- | ----------- | ----- |
311
+ | **vendor_id** | **String** | | |
312
+ | **melio_account** | **String** | The &#x60;Melio-Account&#x60; header is used when a Partner wants to perform an operation on behalf of one of its Accounts. It contains the Account&#39;s ID which returned when creating the Account, or when retrieving all of the Partner&#39;s Accounts. Note that most operations are not permitted without the presence of this header. | [optional] |
313
+
314
+ ### Return type
315
+
316
+ [**GetVendorsVendorIdResponse**](GetVendorsVendorIdResponse.md)
317
+
318
+ ### Authorization
319
+
320
+ [AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
321
+
322
+ ### HTTP request headers
323
+
324
+ - **Content-Type**: Not defined
325
+ - **Accept**: application/json
326
+
327
+
328
+ ## get_vendors_vendor_id_delivery_methods
329
+
330
+ > <GetVendorsVendorIdDeliveryMethodsResponse> get_vendors_vendor_id_delivery_methods(vendor_id, opts)
331
+
332
+ Retrieve a Vendor's Delivery Methods
333
+
334
+ Get a list of a Vendor's Delivery Methods, that can be used to sent funds to.
335
+
336
+ ### Examples
337
+
338
+ ```ruby
339
+ require 'time'
340
+ require 'melio-platform-api-client'
341
+ # setup authorization
342
+ MelioPlatformApiClient.configure do |config|
343
+ # Configure Bearer authorization: AccessToken
344
+ config.access_token = 'YOUR_BEARER_TOKEN'
345
+
346
+ # Configure API key authorization: ApiKey
347
+ config.api_key['ApiKey'] = 'YOUR API KEY'
348
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
349
+ # config.api_key_prefix['ApiKey'] = 'Bearer'
350
+ end
351
+
352
+ api_instance = MelioPlatformApiClient::VendorsApi.new
353
+ vendor_id = 'vendor_id_example' # String |
354
+ opts = {
355
+ 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.
356
+ }
357
+
358
+ begin
359
+ # Retrieve a Vendor's Delivery Methods
360
+ result = api_instance.get_vendors_vendor_id_delivery_methods(vendor_id, opts)
361
+ p result
362
+ rescue MelioPlatformApiClient::ApiError => e
363
+ puts "Error when calling VendorsApi->get_vendors_vendor_id_delivery_methods: #{e}"
364
+ end
365
+ ```
366
+
367
+ #### Using the get_vendors_vendor_id_delivery_methods_with_http_info variant
368
+
369
+ This returns an Array which contains the response data, status code and headers.
370
+
371
+ > <Array(<GetVendorsVendorIdDeliveryMethodsResponse>, Integer, Hash)> get_vendors_vendor_id_delivery_methods_with_http_info(vendor_id, opts)
372
+
373
+ ```ruby
374
+ begin
375
+ # Retrieve a Vendor's Delivery Methods
376
+ data, status_code, headers = api_instance.get_vendors_vendor_id_delivery_methods_with_http_info(vendor_id, opts)
377
+ p status_code # => 2xx
378
+ p headers # => { ... }
379
+ p data # => <GetVendorsVendorIdDeliveryMethodsResponse>
380
+ rescue MelioPlatformApiClient::ApiError => e
381
+ puts "Error when calling VendorsApi->get_vendors_vendor_id_delivery_methods_with_http_info: #{e}"
382
+ end
383
+ ```
384
+
385
+ ### Parameters
386
+
387
+ | Name | Type | Description | Notes |
388
+ | ---- | ---- | ----------- | ----- |
389
+ | **vendor_id** | **String** | | |
390
+ | **melio_account** | **String** | The &#x60;Melio-Account&#x60; header is used when a Partner wants to perform an operation on behalf of one of its Accounts. It contains the Account&#39;s ID which returned when creating the Account, or when retrieving all of the Partner&#39;s Accounts. Note that most operations are not permitted without the presence of this header. | [optional] |
391
+
392
+ ### Return type
393
+
394
+ [**GetVendorsVendorIdDeliveryMethodsResponse**](GetVendorsVendorIdDeliveryMethodsResponse.md)
395
+
396
+ ### Authorization
397
+
398
+ [AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
399
+
400
+ ### HTTP request headers
401
+
402
+ - **Content-Type**: Not defined
403
+ - **Accept**: application/json
404
+
405
+
406
+ ## patch_vendors_vendor_id
407
+
408
+ > <PatchVendorsVendorIdResponse> patch_vendors_vendor_id(vendor_id, idempotency_key, opts)
409
+
410
+ Update a Vendor
411
+
412
+ Update an existing Vendor. The request's body can be partial, and only provided fields will be overwritten. Set a field to `null` in order to remove its contents.
413
+
414
+ ### Examples
415
+
416
+ ```ruby
417
+ require 'time'
418
+ require 'melio-platform-api-client'
419
+ # setup authorization
420
+ MelioPlatformApiClient.configure do |config|
421
+ # Configure Bearer authorization: AccessToken
422
+ config.access_token = 'YOUR_BEARER_TOKEN'
423
+
424
+ # Configure API key authorization: ApiKey
425
+ config.api_key['ApiKey'] = 'YOUR API KEY'
426
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
427
+ # config.api_key_prefix['ApiKey'] = 'Bearer'
428
+ end
429
+
430
+ api_instance = MelioPlatformApiClient::VendorsApi.new
431
+ vendor_id = 'vendor_id_example' # String |
432
+ idempotency_key = 'idempotency_key_example' # String | Unique idempotency key
433
+ opts = {
434
+ 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.
435
+ patch_vendors_vendor_id_request: MelioPlatformApiClient::PatchVendorsVendorIdRequest.new # PatchVendorsVendorIdRequest |
436
+ }
437
+
438
+ begin
439
+ # Update a Vendor
440
+ result = api_instance.patch_vendors_vendor_id(vendor_id, idempotency_key, opts)
441
+ p result
442
+ rescue MelioPlatformApiClient::ApiError => e
443
+ puts "Error when calling VendorsApi->patch_vendors_vendor_id: #{e}"
444
+ end
445
+ ```
446
+
447
+ #### Using the patch_vendors_vendor_id_with_http_info variant
448
+
449
+ This returns an Array which contains the response data, status code and headers.
450
+
451
+ > <Array(<PatchVendorsVendorIdResponse>, Integer, Hash)> patch_vendors_vendor_id_with_http_info(vendor_id, idempotency_key, opts)
452
+
453
+ ```ruby
454
+ begin
455
+ # Update a Vendor
456
+ data, status_code, headers = api_instance.patch_vendors_vendor_id_with_http_info(vendor_id, idempotency_key, opts)
457
+ p status_code # => 2xx
458
+ p headers # => { ... }
459
+ p data # => <PatchVendorsVendorIdResponse>
460
+ rescue MelioPlatformApiClient::ApiError => e
461
+ puts "Error when calling VendorsApi->patch_vendors_vendor_id_with_http_info: #{e}"
462
+ end
463
+ ```
464
+
465
+ ### Parameters
466
+
467
+ | Name | Type | Description | Notes |
468
+ | ---- | ---- | ----------- | ----- |
469
+ | **vendor_id** | **String** | | |
470
+ | **idempotency_key** | **String** | Unique idempotency key | |
471
+ | **melio_account** | **String** | The &#x60;Melio-Account&#x60; header is used when a Partner wants to perform an operation on behalf of one of its Accounts. It contains the Account&#39;s ID which returned when creating the Account, or when retrieving all of the Partner&#39;s Accounts. Note that most operations are not permitted without the presence of this header. | [optional] |
472
+ | **patch_vendors_vendor_id_request** | [**PatchVendorsVendorIdRequest**](PatchVendorsVendorIdRequest.md) | | [optional] |
473
+
474
+ ### Return type
475
+
476
+ [**PatchVendorsVendorIdResponse**](PatchVendorsVendorIdResponse.md)
477
+
478
+ ### Authorization
479
+
480
+ [AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
481
+
482
+ ### HTTP request headers
483
+
484
+ - **Content-Type**: application/json
485
+ - **Accept**: application/json
486
+
487
+
488
+ ## post_vendors
489
+
490
+ > <PostVendorsResponse> post_vendors(idempotency_key, opts)
491
+
492
+ Create a Vendor
493
+
494
+ Create (attach) a Vendor to an Account.
495
+
496
+ ### Examples
497
+
498
+ ```ruby
499
+ require 'time'
500
+ require 'melio-platform-api-client'
501
+ # setup authorization
502
+ MelioPlatformApiClient.configure do |config|
503
+ # Configure Bearer authorization: AccessToken
504
+ config.access_token = 'YOUR_BEARER_TOKEN'
505
+
506
+ # Configure API key authorization: ApiKey
507
+ config.api_key['ApiKey'] = 'YOUR API KEY'
508
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
509
+ # config.api_key_prefix['ApiKey'] = 'Bearer'
510
+ end
511
+
512
+ api_instance = MelioPlatformApiClient::VendorsApi.new
513
+ idempotency_key = 'idempotency_key_example' # String | Unique idempotency key
514
+ opts = {
515
+ 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.
516
+ post_vendors_request: MelioPlatformApiClient::PostVendorsRequest.new({name: 'name_example', contact: MelioPlatformApiClient::VendorAllOfContact.new({name: 'name_example', email: 'email_example', phone_number: 'phone_number_example'})}) # PostVendorsRequest |
517
+ }
518
+
519
+ begin
520
+ # Create a Vendor
521
+ result = api_instance.post_vendors(idempotency_key, opts)
522
+ p result
523
+ rescue MelioPlatformApiClient::ApiError => e
524
+ puts "Error when calling VendorsApi->post_vendors: #{e}"
525
+ end
526
+ ```
527
+
528
+ #### Using the post_vendors_with_http_info variant
529
+
530
+ This returns an Array which contains the response data, status code and headers.
531
+
532
+ > <Array(<PostVendorsResponse>, Integer, Hash)> post_vendors_with_http_info(idempotency_key, opts)
533
+
534
+ ```ruby
535
+ begin
536
+ # Create a Vendor
537
+ data, status_code, headers = api_instance.post_vendors_with_http_info(idempotency_key, opts)
538
+ p status_code # => 2xx
539
+ p headers # => { ... }
540
+ p data # => <PostVendorsResponse>
541
+ rescue MelioPlatformApiClient::ApiError => e
542
+ puts "Error when calling VendorsApi->post_vendors_with_http_info: #{e}"
543
+ end
544
+ ```
545
+
546
+ ### Parameters
547
+
548
+ | Name | Type | Description | Notes |
549
+ | ---- | ---- | ----------- | ----- |
550
+ | **idempotency_key** | **String** | Unique idempotency key | |
551
+ | **melio_account** | **String** | The &#x60;Melio-Account&#x60; header is used when a Partner wants to perform an operation on behalf of one of its Accounts. It contains the Account&#39;s ID which returned when creating the Account, or when retrieving all of the Partner&#39;s Accounts. Note that most operations are not permitted without the presence of this header. | [optional] |
552
+ | **post_vendors_request** | [**PostVendorsRequest**](PostVendorsRequest.md) | | [optional] |
553
+
554
+ ### Return type
555
+
556
+ [**PostVendorsResponse**](PostVendorsResponse.md)
557
+
558
+ ### Authorization
559
+
560
+ [AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
561
+
562
+ ### HTTP request headers
563
+
564
+ - **Content-Type**: application/json
565
+ - **Accept**: application/json
566
+
567
+
568
+ ## post_vendors_bulk
569
+
570
+ > <PostVendorsBulkResponse> post_vendors_bulk(idempotency_key, opts)
571
+
572
+ Create multiple Vendors
573
+
574
+ Create (attach) multiple Vendors to an Account, based on a provided list of business entities.
575
+
576
+ ### Examples
577
+
578
+ ```ruby
579
+ require 'time'
580
+ require 'melio-platform-api-client'
581
+ # setup authorization
582
+ MelioPlatformApiClient.configure do |config|
583
+ # Configure Bearer authorization: AccessToken
584
+ config.access_token = 'YOUR_BEARER_TOKEN'
585
+
586
+ # Configure API key authorization: ApiKey
587
+ config.api_key['ApiKey'] = 'YOUR API KEY'
588
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
589
+ # config.api_key_prefix['ApiKey'] = 'Bearer'
590
+ end
591
+
592
+ api_instance = MelioPlatformApiClient::VendorsApi.new
593
+ idempotency_key = 'idempotency_key_example' # String | Unique idempotency key
594
+ opts = {
595
+ 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.
596
+ post_vendors_bulk_request: MelioPlatformApiClient::PostVendorsBulkRequest.new({vendors: [MelioPlatformApiClient::PostVendorsRequest.new({name: 'name_example', contact: MelioPlatformApiClient::VendorAllOfContact.new({name: 'name_example', email: 'email_example', phone_number: 'phone_number_example'})})]}) # PostVendorsBulkRequest |
597
+ }
598
+
599
+ begin
600
+ # Create multiple Vendors
601
+ result = api_instance.post_vendors_bulk(idempotency_key, opts)
602
+ p result
603
+ rescue MelioPlatformApiClient::ApiError => e
604
+ puts "Error when calling VendorsApi->post_vendors_bulk: #{e}"
605
+ end
606
+ ```
607
+
608
+ #### Using the post_vendors_bulk_with_http_info variant
609
+
610
+ This returns an Array which contains the response data, status code and headers.
611
+
612
+ > <Array(<PostVendorsBulkResponse>, Integer, Hash)> post_vendors_bulk_with_http_info(idempotency_key, opts)
613
+
614
+ ```ruby
615
+ begin
616
+ # Create multiple Vendors
617
+ data, status_code, headers = api_instance.post_vendors_bulk_with_http_info(idempotency_key, opts)
618
+ p status_code # => 2xx
619
+ p headers # => { ... }
620
+ p data # => <PostVendorsBulkResponse>
621
+ rescue MelioPlatformApiClient::ApiError => e
622
+ puts "Error when calling VendorsApi->post_vendors_bulk_with_http_info: #{e}"
623
+ end
624
+ ```
625
+
626
+ ### Parameters
627
+
628
+ | Name | Type | Description | Notes |
629
+ | ---- | ---- | ----------- | ----- |
630
+ | **idempotency_key** | **String** | Unique idempotency key | |
631
+ | **melio_account** | **String** | The &#x60;Melio-Account&#x60; header is used when a Partner wants to perform an operation on behalf of one of its Accounts. It contains the Account&#39;s ID which returned when creating the Account, or when retrieving all of the Partner&#39;s Accounts. Note that most operations are not permitted without the presence of this header. | [optional] |
632
+ | **post_vendors_bulk_request** | [**PostVendorsBulkRequest**](PostVendorsBulkRequest.md) | | [optional] |
633
+
634
+ ### Return type
635
+
636
+ [**PostVendorsBulkResponse**](PostVendorsBulkResponse.md)
637
+
638
+ ### Authorization
639
+
640
+ [AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
641
+
642
+ ### HTTP request headers
643
+
644
+ - **Content-Type**: application/json
645
+ - **Accept**: application/json
646
+
647
+
648
+ ## post_vendors_from_vendor_directory
649
+
650
+ > <PostVendorsFromVendorDirectoryResponse> post_vendors_from_vendor_directory(idempotency_key, opts)
651
+
652
+ Create a Vendor from Vendor Directory
653
+
654
+ Add a specific Vendor from Vendor Directory by its ID to an Account, and clone its Delivery Method in case of biller account.
655
+
656
+ ### Examples
657
+
658
+ ```ruby
659
+ require 'time'
660
+ require 'melio-platform-api-client'
661
+ # setup authorization
662
+ MelioPlatformApiClient.configure do |config|
663
+ # Configure Bearer authorization: AccessToken
664
+ config.access_token = 'YOUR_BEARER_TOKEN'
665
+
666
+ # Configure API key authorization: ApiKey
667
+ config.api_key['ApiKey'] = 'YOUR API KEY'
668
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
669
+ # config.api_key_prefix['ApiKey'] = 'Bearer'
670
+ end
671
+
672
+ api_instance = MelioPlatformApiClient::VendorsApi.new
673
+ idempotency_key = 'idempotency_key_example' # String | Unique idempotency key
674
+ opts = {
675
+ 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.
676
+ post_vendors_from_vendor_directory_request: MelioPlatformApiClient::PostVendorsFromVendorDirectoryRequest.new({vendor_directory_id: 'vendor_directory_id_example'}) # PostVendorsFromVendorDirectoryRequest |
677
+ }
678
+
679
+ begin
680
+ # Create a Vendor from Vendor Directory
681
+ result = api_instance.post_vendors_from_vendor_directory(idempotency_key, opts)
682
+ p result
683
+ rescue MelioPlatformApiClient::ApiError => e
684
+ puts "Error when calling VendorsApi->post_vendors_from_vendor_directory: #{e}"
685
+ end
686
+ ```
687
+
688
+ #### Using the post_vendors_from_vendor_directory_with_http_info variant
689
+
690
+ This returns an Array which contains the response data, status code and headers.
691
+
692
+ > <Array(<PostVendorsFromVendorDirectoryResponse>, Integer, Hash)> post_vendors_from_vendor_directory_with_http_info(idempotency_key, opts)
693
+
694
+ ```ruby
695
+ begin
696
+ # Create a Vendor from Vendor Directory
697
+ data, status_code, headers = api_instance.post_vendors_from_vendor_directory_with_http_info(idempotency_key, opts)
698
+ p status_code # => 2xx
699
+ p headers # => { ... }
700
+ p data # => <PostVendorsFromVendorDirectoryResponse>
701
+ rescue MelioPlatformApiClient::ApiError => e
702
+ puts "Error when calling VendorsApi->post_vendors_from_vendor_directory_with_http_info: #{e}"
703
+ end
704
+ ```
705
+
706
+ ### Parameters
707
+
708
+ | Name | Type | Description | Notes |
709
+ | ---- | ---- | ----------- | ----- |
710
+ | **idempotency_key** | **String** | Unique idempotency key | |
711
+ | **melio_account** | **String** | The &#x60;Melio-Account&#x60; header is used when a Partner wants to perform an operation on behalf of one of its Accounts. It contains the Account&#39;s ID which returned when creating the Account, or when retrieving all of the Partner&#39;s Accounts. Note that most operations are not permitted without the presence of this header. | [optional] |
712
+ | **post_vendors_from_vendor_directory_request** | [**PostVendorsFromVendorDirectoryRequest**](PostVendorsFromVendorDirectoryRequest.md) | | [optional] |
713
+
714
+ ### Return type
715
+
716
+ [**PostVendorsFromVendorDirectoryResponse**](PostVendorsFromVendorDirectoryResponse.md)
717
+
718
+ ### Authorization
719
+
720
+ [AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
721
+
722
+ ### HTTP request headers
723
+
724
+ - **Content-Type**: application/json
725
+ - **Accept**: application/json
726
+
727
+
728
+ ## post_vendors_vendor_id_delivery_methods
729
+
730
+ > <PostVendorsVendorIdDeliveryMethodsResponse> post_vendors_vendor_id_delivery_methods(vendor_id, idempotency_key, opts)
731
+
732
+ Create a Vendor's Delivery Method
733
+
734
+ ### Examples
735
+
736
+ ```ruby
737
+ require 'time'
738
+ require 'melio-platform-api-client'
739
+ # setup authorization
740
+ MelioPlatformApiClient.configure do |config|
741
+ # Configure Bearer authorization: AccessToken
742
+ config.access_token = 'YOUR_BEARER_TOKEN'
743
+
744
+ # Configure API key authorization: ApiKey
745
+ config.api_key['ApiKey'] = 'YOUR API KEY'
746
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
747
+ # config.api_key_prefix['ApiKey'] = 'Bearer'
748
+ end
749
+
750
+ api_instance = MelioPlatformApiClient::VendorsApi.new
751
+ vendor_id = 'vendor_id_example' # String |
752
+ idempotency_key = 'idempotency_key_example' # String | Unique idempotency key
753
+ opts = {
754
+ 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.
755
+ body: 3.56 # PostDeliveryMethodsRequest |
756
+ }
757
+
758
+ begin
759
+ # Create a Vendor's Delivery Method
760
+ result = api_instance.post_vendors_vendor_id_delivery_methods(vendor_id, idempotency_key, opts)
761
+ p result
762
+ rescue MelioPlatformApiClient::ApiError => e
763
+ puts "Error when calling VendorsApi->post_vendors_vendor_id_delivery_methods: #{e}"
764
+ end
765
+ ```
766
+
767
+ #### Using the post_vendors_vendor_id_delivery_methods_with_http_info variant
768
+
769
+ This returns an Array which contains the response data, status code and headers.
770
+
771
+ > <Array(<PostVendorsVendorIdDeliveryMethodsResponse>, Integer, Hash)> post_vendors_vendor_id_delivery_methods_with_http_info(vendor_id, idempotency_key, opts)
772
+
773
+ ```ruby
774
+ begin
775
+ # Create a Vendor's Delivery Method
776
+ data, status_code, headers = api_instance.post_vendors_vendor_id_delivery_methods_with_http_info(vendor_id, idempotency_key, opts)
777
+ p status_code # => 2xx
778
+ p headers # => { ... }
779
+ p data # => <PostVendorsVendorIdDeliveryMethodsResponse>
780
+ rescue MelioPlatformApiClient::ApiError => e
781
+ puts "Error when calling VendorsApi->post_vendors_vendor_id_delivery_methods_with_http_info: #{e}"
782
+ end
783
+ ```
784
+
785
+ ### Parameters
786
+
787
+ | Name | Type | Description | Notes |
788
+ | ---- | ---- | ----------- | ----- |
789
+ | **vendor_id** | **String** | | |
790
+ | **idempotency_key** | **String** | Unique idempotency key | |
791
+ | **melio_account** | **String** | The &#x60;Melio-Account&#x60; header is used when a Partner wants to perform an operation on behalf of one of its Accounts. It contains the Account&#39;s ID which returned when creating the Account, or when retrieving all of the Partner&#39;s Accounts. Note that most operations are not permitted without the presence of this header. | [optional] |
792
+ | **body** | **PostDeliveryMethodsRequest** | | [optional] |
793
+
794
+ ### Return type
795
+
796
+ [**PostVendorsVendorIdDeliveryMethodsResponse**](PostVendorsVendorIdDeliveryMethodsResponse.md)
797
+
798
+ ### Authorization
799
+
800
+ [AccessToken](../README.md#AccessToken), [ApiKey](../README.md#ApiKey)
801
+
802
+ ### HTTP request headers
803
+
804
+ - **Content-Type**: application/json
805
+ - **Accept**: application/json
806
+