conekta 6.0.1 → 6.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (293) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +6 -0
  3. data/Makefile +3 -2
  4. data/README.md +17 -48
  5. data/VERSION +1 -1
  6. data/conekta.gemspec +2 -1
  7. data/config-ruby.json +1 -1
  8. data/docs/ApiKeyCreateResponse.md +3 -3
  9. data/docs/CheckoutRequest.md +2 -0
  10. data/docs/CreateCustomerFiscalEntitiesResponse.md +1 -1
  11. data/docs/Customer.md +1 -1
  12. data/docs/CustomerFiscalEntitiesDataResponse.md +1 -1
  13. data/docs/CustomerFiscalEntitiesRequest.md +1 -1
  14. data/docs/CustomerResponse.md +1 -1
  15. data/docs/CustomerShippingContacts.md +1 -1
  16. data/docs/CustomerShippingContactsDataResponse.md +1 -1
  17. data/docs/CustomerShippingContactsResponse.md +1 -1
  18. data/docs/CustomerUpdateFiscalEntitiesRequest.md +1 -1
  19. data/docs/CustomerUpdateShippingContacts.md +1 -1
  20. data/docs/CustomersApi.md +2 -2
  21. data/docs/CustomersResponse.md +3 -3
  22. data/docs/EventTypes.md +15 -0
  23. data/docs/OrderFiscalEntityRequest.md +1 -1
  24. data/docs/OrderFiscalEntityResponse.md +1 -1
  25. data/docs/OrderResponseCheckout.md +2 -0
  26. data/docs/OrderResponseCustomerInfo.md +2 -2
  27. data/docs/OrderResponseShippingContact.md +7 -7
  28. data/docs/OrderUpdateFiscalEntityRequest.md +1 -1
  29. data/docs/OrdersApi.md +15 -1
  30. data/docs/Payout.md +18 -0
  31. data/docs/PayoutMethod.md +18 -0
  32. data/docs/PayoutOrder.md +30 -0
  33. data/docs/PayoutOrderPayoutsItem.md +32 -0
  34. data/docs/PayoutOrderResponse.md +44 -0
  35. data/docs/PayoutOrderResponseCustomerInfo.md +30 -0
  36. data/docs/PayoutOrdersApi.md +235 -0
  37. data/docs/PayoutOrdersResponse.md +26 -0
  38. data/docs/Product.md +1 -1
  39. data/docs/ProductDataResponse.md +1 -1
  40. data/docs/ProductOrderResponse.md +1 -1
  41. data/docs/UpdateCustomer.md +1 -1
  42. data/docs/UpdateCustomerFiscalEntitiesResponse.md +1 -1
  43. data/docs/WebhooksApi.md +2 -0
  44. data/lib/conekta/api/antifraud_api.rb +1 -1
  45. data/lib/conekta/api/api_keys_api.rb +1 -1
  46. data/lib/conekta/api/balances_api.rb +1 -1
  47. data/lib/conekta/api/charges_api.rb +1 -1
  48. data/lib/conekta/api/companies_api.rb +1 -1
  49. data/lib/conekta/api/customers_api.rb +1 -1
  50. data/lib/conekta/api/discounts_api.rb +1 -1
  51. data/lib/conekta/api/events_api.rb +1 -1
  52. data/lib/conekta/api/logs_api.rb +1 -1
  53. data/lib/conekta/api/orders_api.rb +22 -1
  54. data/lib/conekta/api/payment_link_api.rb +1 -1
  55. data/lib/conekta/api/payment_methods_api.rb +1 -1
  56. data/lib/conekta/api/payout_orders_api.rb +251 -0
  57. data/lib/conekta/api/plans_api.rb +1 -1
  58. data/lib/conekta/api/products_api.rb +1 -1
  59. data/lib/conekta/api/shipping_contacts_api.rb +1 -1
  60. data/lib/conekta/api/shippings_api.rb +1 -1
  61. data/lib/conekta/api/subscriptions_api.rb +1 -1
  62. data/lib/conekta/api/taxes_api.rb +1 -1
  63. data/lib/conekta/api/tokens_api.rb +1 -1
  64. data/lib/conekta/api/transactions_api.rb +1 -1
  65. data/lib/conekta/api/transfers_api.rb +1 -1
  66. data/lib/conekta/api/webhook_keys_api.rb +1 -1
  67. data/lib/conekta/api/webhooks_api.rb +4 -1
  68. data/lib/conekta/api_client.rb +4 -4
  69. data/lib/conekta/api_error.rb +1 -1
  70. data/lib/conekta/configuration.rb +1 -1
  71. data/lib/conekta/models/api_key_create_response.rb +15 -16
  72. data/lib/conekta/models/api_key_request.rb +1 -1
  73. data/lib/conekta/models/api_key_response.rb +1 -1
  74. data/lib/conekta/models/api_key_response_on_delete.rb +1 -1
  75. data/lib/conekta/models/api_key_update_request.rb +1 -1
  76. data/lib/conekta/models/balance_common_field.rb +1 -1
  77. data/lib/conekta/models/balance_response.rb +1 -1
  78. data/lib/conekta/models/blacklist_rule_response.rb +1 -1
  79. data/lib/conekta/models/charge_order_response.rb +1 -1
  80. data/lib/conekta/models/charge_order_response_payment_method.rb +1 -1
  81. data/lib/conekta/models/charge_request.rb +1 -1
  82. data/lib/conekta/models/charge_request_payment_method.rb +1 -1
  83. data/lib/conekta/models/charge_response.rb +1 -1
  84. data/lib/conekta/models/charge_response_channel.rb +1 -1
  85. data/lib/conekta/models/charge_response_payment_method.rb +1 -1
  86. data/lib/conekta/models/charge_response_refunds.rb +1 -2
  87. data/lib/conekta/models/charge_response_refunds_data.rb +1 -1
  88. data/lib/conekta/models/charge_update_request.rb +1 -1
  89. data/lib/conekta/models/charges_data_response.rb +1 -1
  90. data/lib/conekta/models/checkout.rb +1 -1
  91. data/lib/conekta/models/checkout_order_template.rb +1 -1
  92. data/lib/conekta/models/checkout_order_template_customer_info.rb +2 -2
  93. data/lib/conekta/models/checkout_request.rb +12 -2
  94. data/lib/conekta/models/checkout_response.rb +1 -1
  95. data/lib/conekta/models/checkouts_response.rb +1 -2
  96. data/lib/conekta/models/company_fiscal_info_address_response.rb +1 -1
  97. data/lib/conekta/models/company_fiscal_info_response.rb +1 -1
  98. data/lib/conekta/models/company_payout_destination_response.rb +1 -1
  99. data/lib/conekta/models/company_response.rb +1 -1
  100. data/lib/conekta/models/create_customer_fiscal_entities_response.rb +2 -3
  101. data/lib/conekta/models/create_customer_payment_methods_request.rb +2 -2
  102. data/lib/conekta/models/create_customer_payment_methods_response.rb +1 -1
  103. data/lib/conekta/models/create_risk_rules_data.rb +1 -1
  104. data/lib/conekta/models/customer.rb +1 -1
  105. data/lib/conekta/models/customer_address.rb +1 -1
  106. data/lib/conekta/models/customer_antifraud_info.rb +1 -1
  107. data/lib/conekta/models/customer_antifraud_info_response.rb +1 -1
  108. data/lib/conekta/models/customer_fiscal_entities_data_response.rb +2 -3
  109. data/lib/conekta/models/customer_fiscal_entities_request.rb +2 -2
  110. data/lib/conekta/models/customer_fiscal_entities_response.rb +1 -2
  111. data/lib/conekta/models/customer_info.rb +1 -1
  112. data/lib/conekta/models/customer_info_just_customer_id.rb +1 -1
  113. data/lib/conekta/models/customer_info_just_customer_id_response.rb +1 -1
  114. data/lib/conekta/models/customer_payment_method_request.rb +1 -1
  115. data/lib/conekta/models/customer_payment_methods_data.rb +1 -1
  116. data/lib/conekta/models/customer_payment_methods_request.rb +2 -2
  117. data/lib/conekta/models/customer_payment_methods_response.rb +1 -2
  118. data/lib/conekta/models/customer_response.rb +1 -1
  119. data/lib/conekta/models/customer_response_shipping_contacts.rb +1 -2
  120. data/lib/conekta/models/customer_shipping_contacts.rb +1 -1
  121. data/lib/conekta/models/customer_shipping_contacts_address.rb +1 -1
  122. data/lib/conekta/models/customer_shipping_contacts_data_response.rb +2 -3
  123. data/lib/conekta/models/customer_shipping_contacts_response.rb +1 -1
  124. data/lib/conekta/models/customer_shipping_contacts_response_address.rb +1 -1
  125. data/lib/conekta/models/customer_update_fiscal_entities_request.rb +2 -2
  126. data/lib/conekta/models/customer_update_shipping_contacts.rb +1 -1
  127. data/lib/conekta/models/customers_response.rb +17 -18
  128. data/lib/conekta/models/delete_api_keys_response.rb +2 -3
  129. data/lib/conekta/models/deleted_blacklist_rule_response.rb +1 -1
  130. data/lib/conekta/models/deleted_whitelist_rule_response.rb +1 -1
  131. data/lib/conekta/models/details.rb +1 -1
  132. data/lib/conekta/models/details_error.rb +1 -1
  133. data/lib/conekta/models/discount_lines_data_response.rb +1 -1
  134. data/lib/conekta/models/discount_lines_response.rb +1 -2
  135. data/lib/conekta/models/email_checkout_request.rb +1 -1
  136. data/lib/conekta/models/error.rb +2 -3
  137. data/lib/conekta/models/event_response.rb +1 -1
  138. data/lib/conekta/models/event_types.rb +43 -0
  139. data/lib/conekta/models/events_resend_response.rb +1 -1
  140. data/lib/conekta/models/fiscal_entity_address.rb +1 -1
  141. data/lib/conekta/models/get_api_keys_response.rb +1 -2
  142. data/lib/conekta/models/get_charges_response.rb +1 -2
  143. data/lib/conekta/models/get_companies_response.rb +1 -2
  144. data/lib/conekta/models/get_customer_payment_method_data_response.rb +1 -1
  145. data/lib/conekta/models/get_events_response.rb +1 -2
  146. data/lib/conekta/models/get_order_discount_lines_response.rb +1 -2
  147. data/lib/conekta/models/get_orders_response.rb +1 -1
  148. data/lib/conekta/models/get_payment_method_response.rb +1 -2
  149. data/lib/conekta/models/get_plans_response.rb +1 -2
  150. data/lib/conekta/models/get_transactions_response.rb +1 -2
  151. data/lib/conekta/models/get_transfers_response.rb +1 -2
  152. data/lib/conekta/models/get_webhook_keys_response.rb +1 -2
  153. data/lib/conekta/models/get_webhooks_response.rb +1 -2
  154. data/lib/conekta/models/log_response.rb +1 -1
  155. data/lib/conekta/models/logs_response.rb +1 -1
  156. data/lib/conekta/models/logs_response_data.rb +1 -1
  157. data/lib/conekta/models/order_capture_request.rb +1 -1
  158. data/lib/conekta/models/order_customer_info_response.rb +1 -1
  159. data/lib/conekta/models/order_discount_lines_request.rb +1 -1
  160. data/lib/conekta/models/order_fiscal_entity_address_response.rb +2 -3
  161. data/lib/conekta/models/order_fiscal_entity_request.rb +1 -1
  162. data/lib/conekta/models/order_fiscal_entity_response.rb +1 -1
  163. data/lib/conekta/models/order_next_action_response.rb +1 -1
  164. data/lib/conekta/models/order_next_action_response_redirect_to_url.rb +1 -1
  165. data/lib/conekta/models/order_refund_request.rb +1 -1
  166. data/lib/conekta/models/order_request.rb +1 -1
  167. data/lib/conekta/models/order_request_customer_info.rb +2 -2
  168. data/lib/conekta/models/order_response.rb +1 -1
  169. data/lib/conekta/models/order_response_charges.rb +1 -2
  170. data/lib/conekta/models/order_response_checkout.rb +13 -2
  171. data/lib/conekta/models/order_response_customer_info.rb +12 -13
  172. data/lib/conekta/models/order_response_discount_lines.rb +1 -2
  173. data/lib/conekta/models/order_response_products.rb +1 -2
  174. data/lib/conekta/models/order_response_shipping_contact.rb +30 -31
  175. data/lib/conekta/models/order_tax_request.rb +1 -1
  176. data/lib/conekta/models/order_update_fiscal_entity_request.rb +1 -1
  177. data/lib/conekta/models/order_update_request.rb +1 -1
  178. data/lib/conekta/models/order_update_request_customer_info.rb +2 -2
  179. data/lib/conekta/models/orders_response.rb +1 -1
  180. data/lib/conekta/models/page.rb +1 -1
  181. data/lib/conekta/models/pagination.rb +1 -1
  182. data/lib/conekta/models/payment_method.rb +1 -1
  183. data/lib/conekta/models/payment_method_bank_transfer.rb +1 -2
  184. data/lib/conekta/models/payment_method_card.rb +1 -2
  185. data/lib/conekta/models/payment_method_card_request.rb +2 -3
  186. data/lib/conekta/models/payment_method_card_response.rb +1 -2
  187. data/lib/conekta/models/payment_method_cash.rb +1 -2
  188. data/lib/conekta/models/payment_method_cash_request.rb +2 -3
  189. data/lib/conekta/models/payment_method_cash_response.rb +1 -2
  190. data/lib/conekta/models/payment_method_response.rb +1 -1
  191. data/lib/conekta/models/payment_method_spei_recurrent.rb +2 -3
  192. data/lib/conekta/models/payment_method_spei_request.rb +2 -3
  193. data/lib/conekta/models/payout.rb +222 -0
  194. data/lib/conekta/models/payout_method.rb +223 -0
  195. data/lib/conekta/models/payout_order.rb +339 -0
  196. data/lib/conekta/models/payout_order_payouts_item.rb +320 -0
  197. data/lib/conekta/models/payout_order_response.rb +466 -0
  198. data/lib/conekta/models/payout_order_response_customer_info.rb +288 -0
  199. data/lib/conekta/models/payout_orders_response.rb +280 -0
  200. data/lib/conekta/models/plan_request.rb +1 -1
  201. data/lib/conekta/models/plan_response.rb +1 -1
  202. data/lib/conekta/models/plan_update_request.rb +1 -1
  203. data/lib/conekta/models/product.rb +2 -2
  204. data/lib/conekta/models/product_data_response.rb +3 -4
  205. data/lib/conekta/models/product_order_response.rb +3 -4
  206. data/lib/conekta/models/risk_rules_data.rb +1 -1
  207. data/lib/conekta/models/risk_rules_list.rb +2 -3
  208. data/lib/conekta/models/shipping_order_response.rb +1 -2
  209. data/lib/conekta/models/shipping_request.rb +1 -1
  210. data/lib/conekta/models/sms_checkout_request.rb +1 -1
  211. data/lib/conekta/models/subscription_events_response.rb +1 -2
  212. data/lib/conekta/models/subscription_request.rb +1 -1
  213. data/lib/conekta/models/subscription_response.rb +1 -1
  214. data/lib/conekta/models/subscription_update_request.rb +1 -1
  215. data/lib/conekta/models/token.rb +1 -1
  216. data/lib/conekta/models/token_card.rb +1 -1
  217. data/lib/conekta/models/token_checkout.rb +1 -1
  218. data/lib/conekta/models/token_response.rb +1 -1
  219. data/lib/conekta/models/token_response_checkout.rb +1 -1
  220. data/lib/conekta/models/transaction_response.rb +1 -1
  221. data/lib/conekta/models/transfer_destination_response.rb +1 -1
  222. data/lib/conekta/models/transfer_method_response.rb +1 -1
  223. data/lib/conekta/models/transfer_response.rb +1 -1
  224. data/lib/conekta/models/transfers_response.rb +1 -1
  225. data/lib/conekta/models/update_customer.rb +1 -1
  226. data/lib/conekta/models/update_customer_antifraud_info.rb +1 -1
  227. data/lib/conekta/models/update_customer_fiscal_entities_response.rb +3 -4
  228. data/lib/conekta/models/update_customer_payment_methods_response.rb +1 -1
  229. data/lib/conekta/models/update_order_discount_lines_request.rb +1 -1
  230. data/lib/conekta/models/update_order_tax_request.rb +1 -1
  231. data/lib/conekta/models/update_order_tax_response.rb +2 -3
  232. data/lib/conekta/models/update_payment_methods.rb +1 -1
  233. data/lib/conekta/models/update_product.rb +1 -1
  234. data/lib/conekta/models/webhook_key_create_response.rb +1 -1
  235. data/lib/conekta/models/webhook_key_delete_response.rb +1 -1
  236. data/lib/conekta/models/webhook_key_request.rb +1 -1
  237. data/lib/conekta/models/webhook_key_response.rb +1 -1
  238. data/lib/conekta/models/webhook_key_update_request.rb +1 -1
  239. data/lib/conekta/models/webhook_log.rb +1 -1
  240. data/lib/conekta/models/webhook_request.rb +1 -1
  241. data/lib/conekta/models/webhook_response.rb +1 -1
  242. data/lib/conekta/models/webhook_update_request.rb +1 -1
  243. data/lib/conekta/models/whitelistlist_rule_response.rb +1 -1
  244. data/lib/conekta/version.rb +2 -2
  245. data/lib/conekta.rb +10 -44
  246. data/spec/api/customers_api_spec.rb +2 -2
  247. data/spec/api/payout_orders_api_spec.rb +77 -0
  248. data/spec/spec_helper.rb +1 -1
  249. data/templates/ruby/api_client.mustache +1 -0
  250. metadata +54 -63
  251. data/docs/ApiKeyCreateResponseAllOf.md +0 -18
  252. data/docs/ChargeDataPaymentMethodBankTransferResponse.md +0 -48
  253. data/docs/ChargeDataPaymentMethodCardResponse.md +0 -38
  254. data/docs/ChargeDataPaymentMethodCashResponse.md +0 -32
  255. data/docs/ChargeResponseRefundsAllOf.md +0 -18
  256. data/docs/CheckoutsResponseAllOf.md +0 -18
  257. data/docs/CreateCustomerFiscalEntitiesResponseAllOf.md +0 -26
  258. data/docs/CustomerFiscalEntitiesRequestAddress.md +0 -32
  259. data/docs/CustomerFiscalEntitiesResponseAllOf.md +0 -18
  260. data/docs/CustomerPaymentMethods.md +0 -18
  261. data/docs/CustomerResponseShippingContactsAllOf.md +0 -18
  262. data/docs/CustomerShippingContactsDataResponseAllOf.md +0 -22
  263. data/docs/CustomersResponseAllOf.md +0 -18
  264. data/docs/DeleteApiKeysResponseAllOf.md +0 -18
  265. data/docs/DiscountLinesResponseAllOf.md +0 -22
  266. data/docs/ErrorAllOf.md +0 -22
  267. data/docs/GetApiKeysResponseAllOf.md +0 -18
  268. data/docs/GetChargesResponseAllOf.md +0 -18
  269. data/docs/GetCompaniesResponseAllOf.md +0 -18
  270. data/docs/GetEventsResponseAllOf.md +0 -18
  271. data/docs/GetOrderDiscountLinesResponseAllOf.md +0 -18
  272. data/docs/GetPaymentMethodResponseAllOf.md +0 -18
  273. data/docs/GetPlansResponseAllOf.md +0 -18
  274. data/docs/GetTransactionsResponseAllOf.md +0 -18
  275. data/docs/GetTransfersResponseAllOf.md +0 -18
  276. data/docs/GetWebhookKeysResponseAllOf.md +0 -18
  277. data/docs/GetWebhooksResponseAllOf.md +0 -18
  278. data/docs/OrderFiscalEntityAddressResponseAllOf.md +0 -18
  279. data/docs/OrderResponseChargesAllOf.md +0 -18
  280. data/docs/OrderResponseCustomerInfoAllOf.md +0 -18
  281. data/docs/OrderResponseDiscountLinesAllOf.md +0 -18
  282. data/docs/OrderResponseProductsAllOf.md +0 -18
  283. data/docs/OrderResponseShippingContactAllOf.md +0 -22
  284. data/docs/PaymentMethodCardRequestAllOf.md +0 -18
  285. data/docs/PaymentMethodCardResponseAllOf.md +0 -36
  286. data/docs/PaymentMethodCashRequestAllOf.md +0 -18
  287. data/docs/PaymentMethodCashResponseAllOf.md +0 -26
  288. data/docs/PaymentMethodSpeiRecurrentAllOf.md +0 -20
  289. data/docs/ProductDataResponseAllOf.md +0 -22
  290. data/docs/ProductOrderResponseAllOf.md +0 -22
  291. data/docs/RiskRules.md +0 -18
  292. data/docs/UpdateCustomerFiscalEntitiesResponseAllOf.md +0 -26
  293. data/docs/UpdateOrderTaxResponseAllOf.md +0 -22
data/docs/OrdersApi.md CHANGED
@@ -265,7 +265,14 @@ opts = {
265
265
  limit: 56, # Integer | The numbers of items to return, the maximum value is 250
266
266
  search: 'search_example', # String | General order search, e.g. by mail, reference etc.
267
267
  _next: '_next_example', # String | next page
268
- previous: 'previous_example' # String | previous page
268
+ previous: 'previous_example', # String | previous page
269
+ payment_status: 'paid', # String | Filters by order status
270
+ last_payment_info_status: 'pending_payment', # String | Filters by last payment info status
271
+ created_at: 1612137600, # Integer | created equal to
272
+ created_at_gte: 1612137600, # Integer | created at greater than or equal to
273
+ created_at_lte: 1612137600, # Integer | created at less than or equal to
274
+ updated_at_gte: 1612137600, # Integer | updated at greater than or equal to
275
+ updated_at_lte: 1612137600 # Integer | updated at less than or equal to
269
276
  }
270
277
 
271
278
  begin
@@ -305,6 +312,13 @@ end
305
312
  | **search** | **String** | General order search, e.g. by mail, reference etc. | [optional] |
306
313
  | **_next** | **String** | next page | [optional] |
307
314
  | **previous** | **String** | previous page | [optional] |
315
+ | **payment_status** | **String** | Filters by order status | [optional] |
316
+ | **last_payment_info_status** | **String** | Filters by last payment info status | [optional] |
317
+ | **created_at** | **Integer** | created equal to | [optional] |
318
+ | **created_at_gte** | **Integer** | created at greater than or equal to | [optional] |
319
+ | **created_at_lte** | **Integer** | created at less than or equal to | [optional] |
320
+ | **updated_at_gte** | **Integer** | updated at greater than or equal to | [optional] |
321
+ | **updated_at_lte** | **Integer** | updated at less than or equal to | [optional] |
308
322
 
309
323
  ### Return type
310
324
 
data/docs/Payout.md ADDED
@@ -0,0 +1,18 @@
1
+ # Conekta::Payout
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **payout_method** | [**PayoutMethod**](PayoutMethod.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'conekta'
13
+
14
+ instance = Conekta::Payout.new(
15
+ payout_method: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # Conekta::PayoutMethod
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | The type of the payout method. | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'conekta'
13
+
14
+ instance = Conekta::PayoutMethod.new(
15
+ type: cashout
16
+ )
17
+ ```
18
+
@@ -0,0 +1,30 @@
1
+ # Conekta::PayoutOrder
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **allowed_payout_methods** | **Array<String>** | The payout methods that are allowed for the payout order. | |
8
+ | **amount** | **Integer** | The amount of the payout order. | |
9
+ | **currency** | **String** | The currency in which the payout order is made. | [default to 'MXN'] |
10
+ | **customer_info** | [**CustomerInfoJustCustomerId**](CustomerInfoJustCustomerId.md) | | |
11
+ | **metadata** | **Hash<String, Object>** | The metadata of the payout order. | [optional] |
12
+ | **payout** | [**Payout**](Payout.md) | | |
13
+ | **reason** | **String** | The reason for the payout order. | |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'conekta'
19
+
20
+ instance = Conekta::PayoutOrder.new(
21
+ allowed_payout_methods: ["cashout"],
22
+ amount: 100,
23
+ currency: MXN,
24
+ customer_info: null,
25
+ metadata: {"custom_client_id":"12345"},
26
+ payout: null,
27
+ reason: Payout order for the customer
28
+ )
29
+ ```
30
+
@@ -0,0 +1,32 @@
1
+ # Conekta::PayoutOrderPayoutsItem
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **amount** | **Integer** | The amount of the payout. | |
8
+ | **currency** | **String** | The currency in which the payout is made. | |
9
+ | **expires_at** | **Integer** | The expiration date of the payout. | [optional] |
10
+ | **id** | **String** | The id of the payout. | |
11
+ | **livemode** | **Boolean** | The live mode of the payout. | |
12
+ | **object** | **String** | The object of the payout. | |
13
+ | **payout_order_id** | **String** | The id of the payout order. | [optional] |
14
+ | **status** | **String** | The status of the payout. | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'conekta'
20
+
21
+ instance = Conekta::PayoutOrderPayoutsItem.new(
22
+ amount: 3000,
23
+ currency: MXN,
24
+ expires_at: 1677626837,
25
+ id: payout_2vZwsRAhhGp2dFDJx,
26
+ livemode: true,
27
+ object: payout,
28
+ payout_order_id: f2654d66-d740-457a-9a8c-f96b5196f44e,
29
+ status: open
30
+ )
31
+ ```
32
+
@@ -0,0 +1,44 @@
1
+ # Conekta::PayoutOrderResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **allowed_payout_methods** | **Array<String>** | The payout methods that are allowed for the payout order. | |
8
+ | **amount** | **Integer** | The amount of the payout order. | |
9
+ | **created_at** | **Integer** | The creation date of the payout order. | |
10
+ | **currency** | **String** | The currency in which the payout order is made. | [default to 'MXN'] |
11
+ | **customer_info** | [**PayoutOrderResponseCustomerInfo**](PayoutOrderResponseCustomerInfo.md) | | |
12
+ | **expires_at** | **Integer** | The expiration date of the payout order. | [optional] |
13
+ | **id** | **String** | The id of the payout order. | |
14
+ | **livemode** | **Boolean** | The live mode of the payout order. | |
15
+ | **object** | **String** | The object of the payout order. | |
16
+ | **metadata** | **Hash<String, Object>** | The metadata of the payout order. | [optional] |
17
+ | **payouts** | [**Array<PayoutOrderPayoutsItem>**](PayoutOrderPayoutsItem.md) | The payout information of the payout order. | |
18
+ | **reason** | **String** | The reason for the payout order. | |
19
+ | **status** | **String** | The status of the payout order. | [optional] |
20
+ | **updated_at** | **Integer** | The update date of the payout order. | |
21
+
22
+ ## Example
23
+
24
+ ```ruby
25
+ require 'conekta'
26
+
27
+ instance = Conekta::PayoutOrderResponse.new(
28
+ allowed_payout_methods: ["cashout"],
29
+ amount: 100,
30
+ created_at: 1677626837,
31
+ currency: MXN,
32
+ customer_info: null,
33
+ expires_at: 1677626837,
34
+ id: f2654d66-d740-457a-9a8c-f96b5196f44e,
35
+ livemode: true,
36
+ object: payout_order,
37
+ metadata: {"custom_client_id":"12345"},
38
+ payouts: null,
39
+ reason: Payout order for the customer,
40
+ status: open,
41
+ updated_at: 1677626837
42
+ )
43
+ ```
44
+
@@ -0,0 +1,30 @@
1
+ # Conekta::PayoutOrderResponseCustomerInfo
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **customer_custom_reference** | **String** | Custom reference | [optional] |
8
+ | **name** | **String** | | [optional] |
9
+ | **email** | **String** | | [optional] |
10
+ | **phone** | **String** | | [optional] |
11
+ | **corporate** | **Boolean** | | [optional][default to false] |
12
+ | **object** | **String** | | [optional] |
13
+ | **id** | **String** | The id of the customer. | |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'conekta'
19
+
20
+ instance = Conekta::PayoutOrderResponseCustomerInfo.new(
21
+ customer_custom_reference: custom_reference,
22
+ name: DevTest,
23
+ email: test@conekta.com,
24
+ phone: 5522997233,
25
+ corporate: null,
26
+ object: customer_info,
27
+ id: cus_23874283647
28
+ )
29
+ ```
30
+
@@ -0,0 +1,235 @@
1
+ # Conekta::PayoutOrdersApi
2
+
3
+ All URIs are relative to *https://api.conekta.io*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_payout_order**](PayoutOrdersApi.md#create_payout_order) | **POST** /payout_orders | Create payout order |
8
+ | [**get_payout_order_by_id**](PayoutOrdersApi.md#get_payout_order_by_id) | **GET** /payout_orders/{id} | Get Payout Order |
9
+ | [**get_payout_orders**](PayoutOrdersApi.md#get_payout_orders) | **GET** /payout_orders | Get a list of Payout Orders |
10
+
11
+
12
+ ## create_payout_order
13
+
14
+ > <PayoutOrderResponse> create_payout_order(payout_order, opts)
15
+
16
+ Create payout order
17
+
18
+ Create a new payout order.
19
+
20
+ ### Examples
21
+
22
+ ```ruby
23
+ require 'time'
24
+ require 'conekta'
25
+ # setup authorization
26
+ Conekta.configure do |config|
27
+ # Configure Bearer authorization: bearerAuth
28
+ config.access_token = 'YOUR_BEARER_TOKEN'
29
+ end
30
+
31
+ api_instance = Conekta::PayoutOrdersApi.new
32
+ payout_order = Conekta::PayoutOrder.new({allowed_payout_methods: ["cashout"], amount: 100, currency: 'MXN', customer_info: Conekta::CustomerInfoJustCustomerId.new({customer_id: 'cus_23874283647'}), payout: Conekta::Payout.new({payout_method: Conekta::PayoutMethod.new({type: 'cashout'})}), reason: 'Payout order for the customer'}) # PayoutOrder | requested field for payout order
33
+ opts = {
34
+ accept_language: 'es' # String | Use for knowing which language to use
35
+ }
36
+
37
+ begin
38
+ # Create payout order
39
+ result = api_instance.create_payout_order(payout_order, opts)
40
+ p result
41
+ rescue Conekta::ApiError => e
42
+ puts "Error when calling PayoutOrdersApi->create_payout_order: #{e}"
43
+ end
44
+ ```
45
+
46
+ #### Using the create_payout_order_with_http_info variant
47
+
48
+ This returns an Array which contains the response data, status code and headers.
49
+
50
+ > <Array(<PayoutOrderResponse>, Integer, Hash)> create_payout_order_with_http_info(payout_order, opts)
51
+
52
+ ```ruby
53
+ begin
54
+ # Create payout order
55
+ data, status_code, headers = api_instance.create_payout_order_with_http_info(payout_order, opts)
56
+ p status_code # => 2xx
57
+ p headers # => { ... }
58
+ p data # => <PayoutOrderResponse>
59
+ rescue Conekta::ApiError => e
60
+ puts "Error when calling PayoutOrdersApi->create_payout_order_with_http_info: #{e}"
61
+ end
62
+ ```
63
+
64
+ ### Parameters
65
+
66
+ | Name | Type | Description | Notes |
67
+ | ---- | ---- | ----------- | ----- |
68
+ | **payout_order** | [**PayoutOrder**](PayoutOrder.md) | requested field for payout order | |
69
+ | **accept_language** | **String** | Use for knowing which language to use | [optional][default to &#39;es&#39;] |
70
+
71
+ ### Return type
72
+
73
+ [**PayoutOrderResponse**](PayoutOrderResponse.md)
74
+
75
+ ### Authorization
76
+
77
+ [bearerAuth](../README.md#bearerAuth)
78
+
79
+ ### HTTP request headers
80
+
81
+ - **Content-Type**: application/json
82
+ - **Accept**: application/vnd.conekta-v2.1.0+json
83
+
84
+
85
+ ## get_payout_order_by_id
86
+
87
+ > <PayoutOrderResponse> get_payout_order_by_id(id, opts)
88
+
89
+ Get Payout Order
90
+
91
+ Gets a payout Order resource that corresponds to a payout order ID.
92
+
93
+ ### Examples
94
+
95
+ ```ruby
96
+ require 'time'
97
+ require 'conekta'
98
+ # setup authorization
99
+ Conekta.configure do |config|
100
+ # Configure Bearer authorization: bearerAuth
101
+ config.access_token = 'YOUR_BEARER_TOKEN'
102
+ end
103
+
104
+ api_instance = Conekta::PayoutOrdersApi.new
105
+ id = '6307a60c41de27127515a575' # String | Identifier of the resource
106
+ opts = {
107
+ accept_language: 'es' # String | Use for knowing which language to use
108
+ }
109
+
110
+ begin
111
+ # Get Payout Order
112
+ result = api_instance.get_payout_order_by_id(id, opts)
113
+ p result
114
+ rescue Conekta::ApiError => e
115
+ puts "Error when calling PayoutOrdersApi->get_payout_order_by_id: #{e}"
116
+ end
117
+ ```
118
+
119
+ #### Using the get_payout_order_by_id_with_http_info variant
120
+
121
+ This returns an Array which contains the response data, status code and headers.
122
+
123
+ > <Array(<PayoutOrderResponse>, Integer, Hash)> get_payout_order_by_id_with_http_info(id, opts)
124
+
125
+ ```ruby
126
+ begin
127
+ # Get Payout Order
128
+ data, status_code, headers = api_instance.get_payout_order_by_id_with_http_info(id, opts)
129
+ p status_code # => 2xx
130
+ p headers # => { ... }
131
+ p data # => <PayoutOrderResponse>
132
+ rescue Conekta::ApiError => e
133
+ puts "Error when calling PayoutOrdersApi->get_payout_order_by_id_with_http_info: #{e}"
134
+ end
135
+ ```
136
+
137
+ ### Parameters
138
+
139
+ | Name | Type | Description | Notes |
140
+ | ---- | ---- | ----------- | ----- |
141
+ | **id** | **String** | Identifier of the resource | |
142
+ | **accept_language** | **String** | Use for knowing which language to use | [optional][default to &#39;es&#39;] |
143
+
144
+ ### Return type
145
+
146
+ [**PayoutOrderResponse**](PayoutOrderResponse.md)
147
+
148
+ ### Authorization
149
+
150
+ [bearerAuth](../README.md#bearerAuth)
151
+
152
+ ### HTTP request headers
153
+
154
+ - **Content-Type**: Not defined
155
+ - **Accept**: application/vnd.conekta-v2.1.0+json
156
+
157
+
158
+ ## get_payout_orders
159
+
160
+ > <PayoutOrdersResponse> get_payout_orders(opts)
161
+
162
+ Get a list of Payout Orders
163
+
164
+ Get Payout order details in the form of a list
165
+
166
+ ### Examples
167
+
168
+ ```ruby
169
+ require 'time'
170
+ require 'conekta'
171
+ # setup authorization
172
+ Conekta.configure do |config|
173
+ # Configure Bearer authorization: bearerAuth
174
+ config.access_token = 'YOUR_BEARER_TOKEN'
175
+ end
176
+
177
+ api_instance = Conekta::PayoutOrdersApi.new
178
+ opts = {
179
+ accept_language: 'es', # String | Use for knowing which language to use
180
+ limit: 56, # Integer | The numbers of items to return, the maximum value is 250
181
+ search: 'search_example', # String | General order search, e.g. by mail, reference etc.
182
+ _next: '_next_example', # String | next page
183
+ previous: 'previous_example' # String | previous page
184
+ }
185
+
186
+ begin
187
+ # Get a list of Payout Orders
188
+ result = api_instance.get_payout_orders(opts)
189
+ p result
190
+ rescue Conekta::ApiError => e
191
+ puts "Error when calling PayoutOrdersApi->get_payout_orders: #{e}"
192
+ end
193
+ ```
194
+
195
+ #### Using the get_payout_orders_with_http_info variant
196
+
197
+ This returns an Array which contains the response data, status code and headers.
198
+
199
+ > <Array(<PayoutOrdersResponse>, Integer, Hash)> get_payout_orders_with_http_info(opts)
200
+
201
+ ```ruby
202
+ begin
203
+ # Get a list of Payout Orders
204
+ data, status_code, headers = api_instance.get_payout_orders_with_http_info(opts)
205
+ p status_code # => 2xx
206
+ p headers # => { ... }
207
+ p data # => <PayoutOrdersResponse>
208
+ rescue Conekta::ApiError => e
209
+ puts "Error when calling PayoutOrdersApi->get_payout_orders_with_http_info: #{e}"
210
+ end
211
+ ```
212
+
213
+ ### Parameters
214
+
215
+ | Name | Type | Description | Notes |
216
+ | ---- | ---- | ----------- | ----- |
217
+ | **accept_language** | **String** | Use for knowing which language to use | [optional][default to &#39;es&#39;] |
218
+ | **limit** | **Integer** | The numbers of items to return, the maximum value is 250 | [optional][default to 20] |
219
+ | **search** | **String** | General order search, e.g. by mail, reference etc. | [optional] |
220
+ | **_next** | **String** | next page | [optional] |
221
+ | **previous** | **String** | previous page | [optional] |
222
+
223
+ ### Return type
224
+
225
+ [**PayoutOrdersResponse**](PayoutOrdersResponse.md)
226
+
227
+ ### Authorization
228
+
229
+ [bearerAuth](../README.md#bearerAuth)
230
+
231
+ ### HTTP request headers
232
+
233
+ - **Content-Type**: Not defined
234
+ - **Accept**: application/vnd.conekta-v2.1.0+json
235
+
@@ -0,0 +1,26 @@
1
+ # Conekta::PayoutOrdersResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **has_more** | **Boolean** | Indicates if there are more pages to be requested | |
8
+ | **object** | **String** | Object type, in this case is list | |
9
+ | **next_page_url** | **String** | URL of the next page. | [optional] |
10
+ | **previous_page_url** | **String** | Url of the previous page. | [optional] |
11
+ | **data** | [**Array&lt;PayoutOrderResponse&gt;**](PayoutOrderResponse.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'conekta'
17
+
18
+ instance = Conekta::PayoutOrdersResponse.new(
19
+ has_more: false,
20
+ object: list,
21
+ next_page_url: https://api.conekta.io/resources?limit&#x3D;10&amp;next&#x3D;chrg_1,
22
+ previous_page_url: https://api.conekta.io/resources?limit&#x3D;10&amp;previous&#x3D;chrg_1,
23
+ data: null
24
+ )
25
+ ```
26
+
data/docs/Product.md CHANGED
@@ -7,7 +7,7 @@
7
7
  | **antifraud_info** | **Hash&lt;String, Object&gt;** | | [optional] |
8
8
  | **brand** | **String** | The brand of the item. | [optional] |
9
9
  | **description** | **String** | Short description of the item | [optional] |
10
- | **metadata** | **Hash&lt;String, String&gt;** | It is a key/value hash that can hold custom fields. Maximum 100 elements and allows special characters. | [optional] |
10
+ | **metadata** | **Hash&lt;String, Object&gt;** | It is a key/value hash that can hold custom fields. Maximum 100 elements and allows special characters. | [optional] |
11
11
  | **name** | **String** | The name of the item. It will be displayed in the order. | |
12
12
  | **quantity** | **Integer** | The quantity of the item in the order. | |
13
13
  | **sku** | **String** | The stock keeping unit for the item. It is used to identify the item in the order. | [optional] |
@@ -7,7 +7,7 @@
7
7
  | **antifraud_info** | **Hash&lt;String, Object&gt;** | | [optional] |
8
8
  | **brand** | **String** | The brand of the item. | [optional] |
9
9
  | **description** | **String** | Short description of the item | [optional] |
10
- | **metadata** | **Hash&lt;String, String&gt;** | It is a key/value hash that can hold custom fields. Maximum 100 elements and allows special characters. | [optional] |
10
+ | **metadata** | **Hash&lt;String, Object&gt;** | It is a key/value hash that can hold custom fields. Maximum 100 elements and allows special characters. | [optional] |
11
11
  | **name** | **String** | The name of the item. It will be displayed in the order. | |
12
12
  | **quantity** | **Integer** | The quantity of the item in the order. | |
13
13
  | **sku** | **String** | The stock keeping unit for the item. It is used to identify the item in the order. | [optional] |
@@ -7,7 +7,7 @@
7
7
  | **antifraud_info** | **Hash&lt;String, Object&gt;** | | [optional] |
8
8
  | **brand** | **String** | The brand of the item. | [optional] |
9
9
  | **description** | **String** | Short description of the item | [optional] |
10
- | **metadata** | **Hash&lt;String, String&gt;** | It is a key/value hash that can hold custom fields. Maximum 100 elements and allows special characters. | [optional] |
10
+ | **metadata** | **Hash&lt;String, Object&gt;** | It is a key/value hash that can hold custom fields. Maximum 100 elements and allows special characters. | [optional] |
11
11
  | **name** | **String** | The name of the item. It will be displayed in the order. | |
12
12
  | **quantity** | **Integer** | The quantity of the item in the order. | |
13
13
  | **sku** | **String** | The stock keeping unit for the item. It is used to identify the item in the order. | [optional] |
@@ -29,7 +29,7 @@ instance = Conekta::UpdateCustomer.new(
29
29
  default_payment_source_id: src_1a2b3c4d5e6f7g8h,
30
30
  email: miguel@gmail.com,
31
31
  name: miguel,
32
- phone: 5215555555555,
32
+ phone: +5215555555555,
33
33
  plan_id: plan_987234823,
34
34
  default_shipping_contact_id: ship_cont_1a2b3c4d5e6f7g8h,
35
35
  corporate: false,
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **address** | [**CustomerFiscalEntitiesRequestAddress**](CustomerFiscalEntitiesRequestAddress.md) | | |
7
+ | **address** | [**CustomerAddress**](CustomerAddress.md) | | |
8
8
  | **tax_id** | **String** | | [optional] |
9
9
  | **email** | **String** | | [optional] |
10
10
  | **phone** | **String** | | [optional] |
data/docs/WebhooksApi.md CHANGED
@@ -254,6 +254,7 @@ opts = {
254
254
  x_child_company_id: '6441b6376b60c3a638da80af', # String | In the case of a holding company, the company id of the child company to which will process the request.
255
255
  limit: 56, # Integer | The numbers of items to return, the maximum value is 250
256
256
  search: 'search_example', # String | General order search, e.g. by mail, reference etc.
257
+ url: 'url_example', # String | url for webhook filter
257
258
  _next: '_next_example', # String | next page
258
259
  previous: 'previous_example' # String | previous page
259
260
  }
@@ -293,6 +294,7 @@ end
293
294
  | **x_child_company_id** | **String** | In the case of a holding company, the company id of the child company to which will process the request. | [optional] |
294
295
  | **limit** | **Integer** | The numbers of items to return, the maximum value is 250 | [optional][default to 20] |
295
296
  | **search** | **String** | General order search, e.g. by mail, reference etc. | [optional] |
297
+ | **url** | **String** | url for webhook filter | [optional] |
296
298
  | **_next** | **String** | next page | [optional] |
297
299
  | **previous** | **String** | previous page | [optional] |
298
300
 
@@ -6,7 +6,7 @@
6
6
  The version of the OpenAPI document: 2.1.0
7
7
  Contact: engineering@conekta.com
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.1.0
9
+ Generator version: 7.5.0
10
10
 
11
11
  =end
12
12
 
@@ -6,7 +6,7 @@
6
6
  The version of the OpenAPI document: 2.1.0
7
7
  Contact: engineering@conekta.com
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.1.0
9
+ Generator version: 7.5.0
10
10
 
11
11
  =end
12
12
 
@@ -6,7 +6,7 @@
6
6
  The version of the OpenAPI document: 2.1.0
7
7
  Contact: engineering@conekta.com
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.1.0
9
+ Generator version: 7.5.0
10
10
 
11
11
  =end
12
12
 
@@ -6,7 +6,7 @@
6
6
  The version of the OpenAPI document: 2.1.0
7
7
  Contact: engineering@conekta.com
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.1.0
9
+ Generator version: 7.5.0
10
10
 
11
11
  =end
12
12
 
@@ -6,7 +6,7 @@
6
6
  The version of the OpenAPI document: 2.1.0
7
7
  Contact: engineering@conekta.com
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.1.0
9
+ Generator version: 7.5.0
10
10
 
11
11
  =end
12
12
 
@@ -6,7 +6,7 @@
6
6
  The version of the OpenAPI document: 2.1.0
7
7
  Contact: engineering@conekta.com
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.1.0
9
+ Generator version: 7.5.0
10
10
 
11
11
  =end
12
12
 
@@ -6,7 +6,7 @@
6
6
  The version of the OpenAPI document: 2.1.0
7
7
  Contact: engineering@conekta.com
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.1.0
9
+ Generator version: 7.5.0
10
10
 
11
11
  =end
12
12
 
@@ -6,7 +6,7 @@
6
6
  The version of the OpenAPI document: 2.1.0
7
7
  Contact: engineering@conekta.com
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.1.0
9
+ Generator version: 7.5.0
10
10
 
11
11
  =end
12
12
 
@@ -6,7 +6,7 @@
6
6
  The version of the OpenAPI document: 2.1.0
7
7
  Contact: engineering@conekta.com
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.1.0
9
+ Generator version: 7.5.0
10
10
 
11
11
  =end
12
12