digital_femsa 1.0.0

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 (359) hide show
  1. checksums.yaml +7 -0
  2. data/CODE_OF_CONDUCT.md +77 -0
  3. data/CONTRIBUTING.md +19 -0
  4. data/Gemfile +9 -0
  5. data/LICENSE +22 -0
  6. data/Makefile +11 -0
  7. data/README.md +320 -0
  8. data/Rakefile +10 -0
  9. data/VERSION +1 -0
  10. data/config-ruby.json +30 -0
  11. data/digital_femsa.gemspec +41 -0
  12. data/docs/ApiKeyCreateResponse.md +40 -0
  13. data/docs/ApiKeyRequest.md +20 -0
  14. data/docs/ApiKeyResponse.md +38 -0
  15. data/docs/ApiKeyResponseOnDelete.md +34 -0
  16. data/docs/ApiKeyUpdateRequest.md +20 -0
  17. data/docs/ApiKeysApi.md +391 -0
  18. data/docs/BalanceCommonField.md +20 -0
  19. data/docs/BalanceResponse.md +36 -0
  20. data/docs/BalancesApi.md +79 -0
  21. data/docs/ChargeOrderResponse.md +52 -0
  22. data/docs/ChargeOrderResponsePaymentMethod.md +76 -0
  23. data/docs/ChargeRequest.md +22 -0
  24. data/docs/ChargeRequestPaymentMethod.md +22 -0
  25. data/docs/ChargeResponse.md +52 -0
  26. data/docs/ChargeResponseChannel.md +24 -0
  27. data/docs/ChargeResponsePaymentMethod.md +76 -0
  28. data/docs/ChargeResponseRefunds.md +26 -0
  29. data/docs/ChargeResponseRefundsData.md +30 -0
  30. data/docs/ChargeUpdateRequest.md +18 -0
  31. data/docs/ChargesApi.md +241 -0
  32. data/docs/ChargesDataResponse.md +52 -0
  33. data/docs/Checkout.md +34 -0
  34. data/docs/CheckoutOrderTemplate.md +24 -0
  35. data/docs/CheckoutOrderTemplateCustomerInfo.md +49 -0
  36. data/docs/CheckoutRequest.md +30 -0
  37. data/docs/CheckoutResponse.md +58 -0
  38. data/docs/CheckoutsResponse.md +26 -0
  39. data/docs/CompaniesApi.md +159 -0
  40. data/docs/CompanyFiscalInfoAddressResponse.md +34 -0
  41. data/docs/CompanyFiscalInfoResponse.md +30 -0
  42. data/docs/CompanyPayoutDestinationResponse.md +28 -0
  43. data/docs/CompanyResponse.md +32 -0
  44. data/docs/CreateCustomerFiscalEntitiesResponse.md +38 -0
  45. data/docs/CreateCustomerPaymentMethodsRequest.md +47 -0
  46. data/docs/CreateCustomerPaymentMethodsResponse.md +77 -0
  47. data/docs/Customer.md +40 -0
  48. data/docs/CustomerAddress.md +32 -0
  49. data/docs/CustomerAntifraudInfo.md +20 -0
  50. data/docs/CustomerAntifraudInfoResponse.md +20 -0
  51. data/docs/CustomerFiscalEntitiesDataResponse.md +38 -0
  52. data/docs/CustomerFiscalEntitiesRequest.md +28 -0
  53. data/docs/CustomerFiscalEntitiesResponse.md +22 -0
  54. data/docs/CustomerInfo.md +26 -0
  55. data/docs/CustomerInfoJustCustomerId.md +18 -0
  56. data/docs/CustomerInfoJustCustomerIdResponse.md +18 -0
  57. data/docs/CustomerPaymentMethodRequest.md +18 -0
  58. data/docs/CustomerPaymentMethodsData.md +77 -0
  59. data/docs/CustomerPaymentMethodsRequest.md +47 -0
  60. data/docs/CustomerPaymentMethodsResponse.md +26 -0
  61. data/docs/CustomerResponse.md +50 -0
  62. data/docs/CustomerResponseShippingContacts.md +22 -0
  63. data/docs/CustomerShippingContacts.md +32 -0
  64. data/docs/CustomerShippingContactsAddress.md +30 -0
  65. data/docs/CustomerShippingContactsDataResponse.md +38 -0
  66. data/docs/CustomerShippingContactsResponse.md +38 -0
  67. data/docs/CustomerShippingContactsResponseAddress.md +32 -0
  68. data/docs/CustomerUpdateFiscalEntitiesRequest.md +28 -0
  69. data/docs/CustomerUpdateShippingContacts.md +30 -0
  70. data/docs/CustomersApi.md +553 -0
  71. data/docs/CustomersResponse.md +26 -0
  72. data/docs/DeleteApiKeysResponse.md +34 -0
  73. data/docs/Details.md +18 -0
  74. data/docs/DetailsError.md +24 -0
  75. data/docs/DiscountLinesDataResponse.md +28 -0
  76. data/docs/DiscountLinesResponse.md +28 -0
  77. data/docs/DiscountsApi.md +405 -0
  78. data/docs/EmailCheckoutRequest.md +18 -0
  79. data/docs/Error.md +24 -0
  80. data/docs/EventResponse.md +32 -0
  81. data/docs/EventsApi.md +239 -0
  82. data/docs/EventsResendResponse.md +28 -0
  83. data/docs/FiscalEntityAddress.md +30 -0
  84. data/docs/GetApiKeysResponse.md +26 -0
  85. data/docs/GetChargesResponse.md +26 -0
  86. data/docs/GetCompaniesResponse.md +26 -0
  87. data/docs/GetCustomerPaymentMethodDataResponse.md +77 -0
  88. data/docs/GetEventsResponse.md +26 -0
  89. data/docs/GetOrderDiscountLinesResponse.md +26 -0
  90. data/docs/GetOrdersResponse.md +26 -0
  91. data/docs/GetPaymentMethodResponse.md +26 -0
  92. data/docs/GetTransactionsResponse.md +26 -0
  93. data/docs/GetTransfersResponse.md +26 -0
  94. data/docs/GetWebhookKeysResponse.md +26 -0
  95. data/docs/GetWebhooksResponse.md +26 -0
  96. data/docs/LogResponse.md +56 -0
  97. data/docs/LogsApi.md +165 -0
  98. data/docs/LogsResponse.md +26 -0
  99. data/docs/LogsResponseData.md +56 -0
  100. data/docs/OrderCaptureRequest.md +18 -0
  101. data/docs/OrderCustomerInfoResponse.md +28 -0
  102. data/docs/OrderDiscountLinesRequest.md +22 -0
  103. data/docs/OrderFiscalEntityAddressResponse.md +32 -0
  104. data/docs/OrderFiscalEntityRequest.md +28 -0
  105. data/docs/OrderFiscalEntityResponse.md +34 -0
  106. data/docs/OrderNextActionResponse.md +20 -0
  107. data/docs/OrderNextActionResponseRedirectToUrl.md +20 -0
  108. data/docs/OrderRefundRequest.md +22 -0
  109. data/docs/OrderRequest.md +44 -0
  110. data/docs/OrderRequestCustomerInfo.md +49 -0
  111. data/docs/OrderResponse.md +58 -0
  112. data/docs/OrderResponseCharges.md +22 -0
  113. data/docs/OrderResponseCheckout.md +58 -0
  114. data/docs/OrderResponseCustomerInfo.md +30 -0
  115. data/docs/OrderResponseDiscountLines.md +22 -0
  116. data/docs/OrderResponseProducts.md +26 -0
  117. data/docs/OrderResponseShippingContact.md +38 -0
  118. data/docs/OrderTaxRequest.md +22 -0
  119. data/docs/OrderUpdateFiscalEntityRequest.md +28 -0
  120. data/docs/OrderUpdateRequest.md +40 -0
  121. data/docs/OrderUpdateRequestCustomerInfo.md +49 -0
  122. data/docs/OrdersApi.md +627 -0
  123. data/docs/OrdersResponse.md +18 -0
  124. data/docs/Page.md +20 -0
  125. data/docs/Pagination.md +20 -0
  126. data/docs/PaymentLinkApi.md +463 -0
  127. data/docs/PaymentMethod.md +20 -0
  128. data/docs/PaymentMethodCash.md +36 -0
  129. data/docs/PaymentMethodCashRequest.md +20 -0
  130. data/docs/PaymentMethodCashResponse.md +36 -0
  131. data/docs/PaymentMethodResponse.md +26 -0
  132. data/docs/PaymentMethodsApi.md +327 -0
  133. data/docs/Product.md +34 -0
  134. data/docs/ProductDataResponse.md +40 -0
  135. data/docs/ProductOrderResponse.md +40 -0
  136. data/docs/ProductsApi.md +243 -0
  137. data/docs/ShippingContactsApi.md +243 -0
  138. data/docs/ShippingOrderResponse.md +32 -0
  139. data/docs/ShippingRequest.md +26 -0
  140. data/docs/ShippingsApi.md +243 -0
  141. data/docs/SmsCheckoutRequest.md +18 -0
  142. data/docs/TaxesApi.md +243 -0
  143. data/docs/TransactionResponse.md +38 -0
  144. data/docs/TransactionsApi.md +171 -0
  145. data/docs/TransferDestinationResponse.md +32 -0
  146. data/docs/TransferMethodResponse.md +32 -0
  147. data/docs/TransferResponse.md +36 -0
  148. data/docs/TransfersApi.md +165 -0
  149. data/docs/TransfersResponse.md +36 -0
  150. data/docs/UpdateCustomer.md +40 -0
  151. data/docs/UpdateCustomerAntifraudInfo.md +20 -0
  152. data/docs/UpdateCustomerFiscalEntitiesResponse.md +38 -0
  153. data/docs/UpdateCustomerPaymentMethodsResponse.md +77 -0
  154. data/docs/UpdateOrderDiscountLinesRequest.md +22 -0
  155. data/docs/UpdateOrderTaxRequest.md +22 -0
  156. data/docs/UpdateOrderTaxResponse.md +28 -0
  157. data/docs/UpdatePaymentMethods.md +18 -0
  158. data/docs/UpdateProduct.md +34 -0
  159. data/docs/WebhookKeyCreateResponse.md +28 -0
  160. data/docs/WebhookKeyDeleteResponse.md +28 -0
  161. data/docs/WebhookKeyRequest.md +18 -0
  162. data/docs/WebhookKeyResponse.md +30 -0
  163. data/docs/WebhookKeyUpdateRequest.md +18 -0
  164. data/docs/WebhookKeysApi.md +385 -0
  165. data/docs/WebhookLog.md +30 -0
  166. data/docs/WebhookRequest.md +20 -0
  167. data/docs/WebhookResponse.md +36 -0
  168. data/docs/WebhookUpdateRequest.md +22 -0
  169. data/docs/WebhooksApi.md +461 -0
  170. data/gitleaks.toml +0 -0
  171. data/lib/digital_femsa/api/api_keys_api.rb +407 -0
  172. data/lib/digital_femsa/api/balances_api.rb +86 -0
  173. data/lib/digital_femsa/api/charges_api.rb +273 -0
  174. data/lib/digital_femsa/api/companies_api.rb +174 -0
  175. data/lib/digital_femsa/api/customers_api.rb +591 -0
  176. data/lib/digital_femsa/api/discounts_api.rb +447 -0
  177. data/lib/digital_femsa/api/events_api.rb +256 -0
  178. data/lib/digital_femsa/api/logs_api.rb +182 -0
  179. data/lib/digital_femsa/api/orders_api.rb +657 -0
  180. data/lib/digital_femsa/api/payment_link_api.rb +491 -0
  181. data/lib/digital_femsa/api/payment_methods_api.rb +368 -0
  182. data/lib/digital_femsa/api/products_api.rb +275 -0
  183. data/lib/digital_femsa/api/shipping_contacts_api.rb +275 -0
  184. data/lib/digital_femsa/api/shippings_api.rb +275 -0
  185. data/lib/digital_femsa/api/taxes_api.rb +275 -0
  186. data/lib/digital_femsa/api/transactions_api.rb +191 -0
  187. data/lib/digital_femsa/api/transfers_api.rb +182 -0
  188. data/lib/digital_femsa/api/webhook_keys_api.rb +396 -0
  189. data/lib/digital_femsa/api/webhooks_api.rb +477 -0
  190. data/lib/digital_femsa/api_client.rb +442 -0
  191. data/lib/digital_femsa/api_error.rb +58 -0
  192. data/lib/digital_femsa/configuration.rb +382 -0
  193. data/lib/digital_femsa/models/api_key_create_response.rb +333 -0
  194. data/lib/digital_femsa/models/api_key_request.rb +231 -0
  195. data/lib/digital_femsa/models/api_key_response.rb +317 -0
  196. data/lib/digital_femsa/models/api_key_response_on_delete.rb +296 -0
  197. data/lib/digital_femsa/models/api_key_update_request.rb +225 -0
  198. data/lib/digital_femsa/models/balance_common_field.rb +226 -0
  199. data/lib/digital_femsa/models/balance_response.rb +324 -0
  200. data/lib/digital_femsa/models/charge_order_response.rb +373 -0
  201. data/lib/digital_femsa/models/charge_order_response_payment_method.rb +53 -0
  202. data/lib/digital_femsa/models/charge_request.rb +241 -0
  203. data/lib/digital_femsa/models/charge_request_payment_method.rb +241 -0
  204. data/lib/digital_femsa/models/charge_response.rb +371 -0
  205. data/lib/digital_femsa/models/charge_response_channel.rb +241 -0
  206. data/lib/digital_femsa/models/charge_response_payment_method.rb +53 -0
  207. data/lib/digital_femsa/models/charge_response_refunds.rb +281 -0
  208. data/lib/digital_femsa/models/charge_response_refunds_data.rb +298 -0
  209. data/lib/digital_femsa/models/charge_update_request.rb +216 -0
  210. data/lib/digital_femsa/models/charges_data_response.rb +378 -0
  211. data/lib/digital_femsa/models/checkout.rb +340 -0
  212. data/lib/digital_femsa/models/checkout_order_template.rb +301 -0
  213. data/lib/digital_femsa/models/checkout_order_template_customer_info.rb +106 -0
  214. data/lib/digital_femsa/models/checkout_request.rb +284 -0
  215. data/lib/digital_femsa/models/checkout_response.rb +429 -0
  216. data/lib/digital_femsa/models/checkouts_response.rb +280 -0
  217. data/lib/digital_femsa/models/company_fiscal_info_address_response.rb +330 -0
  218. data/lib/digital_femsa/models/company_fiscal_info_response.rb +309 -0
  219. data/lib/digital_femsa/models/company_payout_destination_response.rb +312 -0
  220. data/lib/digital_femsa/models/company_response.rb +318 -0
  221. data/lib/digital_femsa/models/create_customer_fiscal_entities_response.rb +341 -0
  222. data/lib/digital_femsa/models/create_customer_payment_methods_request.rb +105 -0
  223. data/lib/digital_femsa/models/create_customer_payment_methods_response.rb +54 -0
  224. data/lib/digital_femsa/models/customer.rb +374 -0
  225. data/lib/digital_femsa/models/customer_address.rb +301 -0
  226. data/lib/digital_femsa/models/customer_antifraud_info.rb +223 -0
  227. data/lib/digital_femsa/models/customer_antifraud_info_response.rb +223 -0
  228. data/lib/digital_femsa/models/customer_fiscal_entities_data_response.rb +341 -0
  229. data/lib/digital_femsa/models/customer_fiscal_entities_request.rb +268 -0
  230. data/lib/digital_femsa/models/customer_fiscal_entities_response.rb +257 -0
  231. data/lib/digital_femsa/models/customer_info.rb +271 -0
  232. data/lib/digital_femsa/models/customer_info_just_customer_id.rb +221 -0
  233. data/lib/digital_femsa/models/customer_info_just_customer_id_response.rb +214 -0
  234. data/lib/digital_femsa/models/customer_payment_method_request.rb +223 -0
  235. data/lib/digital_femsa/models/customer_payment_methods_data.rb +54 -0
  236. data/lib/digital_femsa/models/customer_payment_methods_request.rb +104 -0
  237. data/lib/digital_femsa/models/customer_payment_methods_response.rb +280 -0
  238. data/lib/digital_femsa/models/customer_response.rb +425 -0
  239. data/lib/digital_femsa/models/customer_response_shipping_contacts.rb +257 -0
  240. data/lib/digital_femsa/models/customer_shipping_contacts.rb +312 -0
  241. data/lib/digital_femsa/models/customer_shipping_contacts_address.rb +271 -0
  242. data/lib/digital_femsa/models/customer_shipping_contacts_data_response.rb +366 -0
  243. data/lib/digital_femsa/models/customer_shipping_contacts_response.rb +328 -0
  244. data/lib/digital_femsa/models/customer_shipping_contacts_response_address.rb +278 -0
  245. data/lib/digital_femsa/models/customer_update_fiscal_entities_request.rb +261 -0
  246. data/lib/digital_femsa/models/customer_update_shipping_contacts.rb +274 -0
  247. data/lib/digital_femsa/models/customers_response.rb +280 -0
  248. data/lib/digital_femsa/models/delete_api_keys_response.rb +301 -0
  249. data/lib/digital_femsa/models/details.rb +216 -0
  250. data/lib/digital_femsa/models/details_error.rb +242 -0
  251. data/lib/digital_femsa/models/discount_lines_data_response.rb +333 -0
  252. data/lib/digital_femsa/models/discount_lines_response.rb +333 -0
  253. data/lib/digital_femsa/models/email_checkout_request.rb +221 -0
  254. data/lib/digital_femsa/models/error.rb +253 -0
  255. data/lib/digital_femsa/models/event_response.rb +301 -0
  256. data/lib/digital_femsa/models/events_resend_response.rb +281 -0
  257. data/lib/digital_femsa/models/fiscal_entity_address.rb +312 -0
  258. data/lib/digital_femsa/models/get_api_keys_response.rb +280 -0
  259. data/lib/digital_femsa/models/get_charges_response.rb +280 -0
  260. data/lib/digital_femsa/models/get_companies_response.rb +280 -0
  261. data/lib/digital_femsa/models/get_customer_payment_method_data_response.rb +54 -0
  262. data/lib/digital_femsa/models/get_events_response.rb +280 -0
  263. data/lib/digital_femsa/models/get_order_discount_lines_response.rb +280 -0
  264. data/lib/digital_femsa/models/get_orders_response.rb +288 -0
  265. data/lib/digital_femsa/models/get_payment_method_response.rb +280 -0
  266. data/lib/digital_femsa/models/get_transactions_response.rb +281 -0
  267. data/lib/digital_femsa/models/get_transfers_response.rb +281 -0
  268. data/lib/digital_femsa/models/get_webhook_keys_response.rb +280 -0
  269. data/lib/digital_femsa/models/get_webhooks_response.rb +280 -0
  270. data/lib/digital_femsa/models/log_response.rb +418 -0
  271. data/lib/digital_femsa/models/logs_response.rb +261 -0
  272. data/lib/digital_femsa/models/logs_response_data.rb +396 -0
  273. data/lib/digital_femsa/models/order_capture_request.rb +241 -0
  274. data/lib/digital_femsa/models/order_customer_info_response.rb +263 -0
  275. data/lib/digital_femsa/models/order_discount_lines_request.rb +276 -0
  276. data/lib/digital_femsa/models/order_fiscal_entity_address_response.rb +328 -0
  277. data/lib/digital_femsa/models/order_fiscal_entity_request.rb +295 -0
  278. data/lib/digital_femsa/models/order_fiscal_entity_response.rb +347 -0
  279. data/lib/digital_femsa/models/order_next_action_response.rb +225 -0
  280. data/lib/digital_femsa/models/order_next_action_response_redirect_to_url.rb +226 -0
  281. data/lib/digital_femsa/models/order_refund_request.rb +247 -0
  282. data/lib/digital_femsa/models/order_request.rb +413 -0
  283. data/lib/digital_femsa/models/order_request_customer_info.rb +106 -0
  284. data/lib/digital_femsa/models/order_response.rb +427 -0
  285. data/lib/digital_femsa/models/order_response_charges.rb +258 -0
  286. data/lib/digital_femsa/models/order_response_checkout.rb +418 -0
  287. data/lib/digital_femsa/models/order_response_customer_info.rb +280 -0
  288. data/lib/digital_femsa/models/order_response_discount_lines.rb +257 -0
  289. data/lib/digital_femsa/models/order_response_products.rb +280 -0
  290. data/lib/digital_femsa/models/order_response_shipping_contact.rb +334 -0
  291. data/lib/digital_femsa/models/order_tax_request.rb +308 -0
  292. data/lib/digital_femsa/models/order_update_fiscal_entity_request.rb +295 -0
  293. data/lib/digital_femsa/models/order_update_request.rb +352 -0
  294. data/lib/digital_femsa/models/order_update_request_customer_info.rb +105 -0
  295. data/lib/digital_femsa/models/orders_response.rb +223 -0
  296. data/lib/digital_femsa/models/page.rb +228 -0
  297. data/lib/digital_femsa/models/pagination.rb +240 -0
  298. data/lib/digital_femsa/models/payment_method.rb +230 -0
  299. data/lib/digital_femsa/models/payment_method_cash.rb +312 -0
  300. data/lib/digital_femsa/models/payment_method_cash_request.rb +238 -0
  301. data/lib/digital_femsa/models/payment_method_cash_response.rb +330 -0
  302. data/lib/digital_femsa/models/payment_method_response.rb +278 -0
  303. data/lib/digital_femsa/models/product.rb +397 -0
  304. data/lib/digital_femsa/models/product_data_response.rb +431 -0
  305. data/lib/digital_femsa/models/product_order_response.rb +431 -0
  306. data/lib/digital_femsa/models/shipping_order_response.rb +336 -0
  307. data/lib/digital_femsa/models/shipping_request.rb +302 -0
  308. data/lib/digital_femsa/models/sms_checkout_request.rb +221 -0
  309. data/lib/digital_femsa/models/transaction_response.rb +412 -0
  310. data/lib/digital_femsa/models/transfer_destination_response.rb +286 -0
  311. data/lib/digital_femsa/models/transfer_method_response.rb +286 -0
  312. data/lib/digital_femsa/models/transfer_response.rb +324 -0
  313. data/lib/digital_femsa/models/transfers_response.rb +324 -0
  314. data/lib/digital_femsa/models/update_customer.rb +353 -0
  315. data/lib/digital_femsa/models/update_customer_antifraud_info.rb +223 -0
  316. data/lib/digital_femsa/models/update_customer_fiscal_entities_response.rb +341 -0
  317. data/lib/digital_femsa/models/update_customer_payment_methods_response.rb +54 -0
  318. data/lib/digital_femsa/models/update_order_discount_lines_request.rb +253 -0
  319. data/lib/digital_femsa/models/update_order_tax_request.rb +294 -0
  320. data/lib/digital_femsa/models/update_order_tax_response.rb +349 -0
  321. data/lib/digital_femsa/models/update_payment_methods.rb +214 -0
  322. data/lib/digital_femsa/models/update_product.rb +349 -0
  323. data/lib/digital_femsa/models/webhook_key_create_response.rb +266 -0
  324. data/lib/digital_femsa/models/webhook_key_delete_response.rb +266 -0
  325. data/lib/digital_femsa/models/webhook_key_request.rb +217 -0
  326. data/lib/digital_femsa/models/webhook_key_response.rb +277 -0
  327. data/lib/digital_femsa/models/webhook_key_update_request.rb +217 -0
  328. data/lib/digital_femsa/models/webhook_log.rb +289 -0
  329. data/lib/digital_femsa/models/webhook_request.rb +261 -0
  330. data/lib/digital_femsa/models/webhook_response.rb +299 -0
  331. data/lib/digital_femsa/models/webhook_update_request.rb +267 -0
  332. data/lib/digital_femsa/version.rb +15 -0
  333. data/lib/digital_femsa.rb +197 -0
  334. data/lib/ssl_data/ca_bundle.crt +4039 -0
  335. data/spec/api/api_keys_api_spec.rb +107 -0
  336. data/spec/api/balances_api_spec.rb +47 -0
  337. data/spec/api/charges_api_spec.rb +80 -0
  338. data/spec/api/companies_api_spec.rb +63 -0
  339. data/spec/api/customers_api_spec.rb +140 -0
  340. data/spec/api/discounts_api_spec.rb +114 -0
  341. data/spec/api/events_api_spec.rb +79 -0
  342. data/spec/api/logs_api_spec.rb +66 -0
  343. data/spec/api/orders_api_spec.rb +153 -0
  344. data/spec/api/payment_link_api_spec.rb +119 -0
  345. data/spec/api/payment_methods_api_spec.rb +99 -0
  346. data/spec/api/products_api_spec.rb +81 -0
  347. data/spec/api/shipping_contacts_api_spec.rb +81 -0
  348. data/spec/api/shippings_api_spec.rb +81 -0
  349. data/spec/api/taxes_api_spec.rb +81 -0
  350. data/spec/api/transactions_api_spec.rb +69 -0
  351. data/spec/api/transfers_api_spec.rb +66 -0
  352. data/spec/api/webhook_keys_api_spec.rb +104 -0
  353. data/spec/api/webhooks_api_spec.rb +118 -0
  354. data/spec/spec_helper.rb +111 -0
  355. data/ssl_data/ca_bundle.crt +4039 -0
  356. data/templates/ruby/CUSTOM_VERSION.mustache +1 -0
  357. data/templates/ruby/api_client.mustache +257 -0
  358. data/templates/ruby/configuration.mustache +481 -0
  359. metadata +488 -0
@@ -0,0 +1,56 @@
1
+ # DigitalFemsa::LogResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **created_at** | **Integer** | | |
8
+ | **id** | **String** | | |
9
+ | **ip_address** | **String** | | [optional] |
10
+ | **livemode** | **Boolean** | | |
11
+ | **loggable_id** | **String** | | [optional] |
12
+ | **loggable_type** | **String** | | [optional] |
13
+ | **method** | **String** | | [optional] |
14
+ | **oauth_token_id** | **String** | | [optional] |
15
+ | **query_string** | **Hash<String, Object>** | | [optional] |
16
+ | **related** | **String** | | [optional] |
17
+ | **request_body** | **Object** | | [optional] |
18
+ | **request_headers** | **Hash<String, String>** | | [optional] |
19
+ | **response_body** | **Object** | | [optional] |
20
+ | **response_headers** | **Hash<String, String>** | | [optional] |
21
+ | **searchable_tags** | **Array<String>** | | [optional] |
22
+ | **status** | **String** | | [optional] |
23
+ | **updated_at** | **String** | | [optional] |
24
+ | **url** | **String** | | [optional] |
25
+ | **user_account_id** | **String** | | [optional] |
26
+ | **version** | **String** | | [optional] |
27
+
28
+ ## Example
29
+
30
+ ```ruby
31
+ require 'digital_femsa'
32
+
33
+ instance = DigitalFemsa::LogResponse.new(
34
+ created_at: 1661445644,
35
+ id: 6307a60c41de27127515a575,
36
+ ip_address: 54.235.131.48,
37
+ livemode: true,
38
+ loggable_id: ord_87632467832,
39
+ loggable_type: order,
40
+ method: POST,
41
+ oauth_token_id: null,
42
+ query_string: {"amount":3000,"payable":true},
43
+ related: FilterResource,
44
+ request_body: {"filters":{"amount":{"amount_from":0,"amount_to":0},"created_at":{"date_from":1653627600,"date_to":1661489999},"filterName":"Payments","search_term":null,"sort_by":"created_at","sort_direction":"desc","status":[],"type":[]},"id":"78e65162-0f37-4942-847c-9bf7081d54c2","page":"0","report_type":"charges","testMode":false},
45
+ request_headers: {"Accept-Encoding":"gzip, deflate, br","Accept-Language":"es-419, es; q=0.9, en; q=0.8","Activitypermission":"orders:read","Apiversion":"2.1.0"},
46
+ response_body: null,
47
+ response_headers: {"Access-Control-Allow-Headers":"Content-Type, Depth, User-Agent, X-File-Size, X-Requested-With, If-Modified-Since, X-File-Name, Cache-Control, X-Prototype-Version, Authorization, Accept, Date, Version, X-Forwarded-For, Host, Connection, X-Forwarded-Proto, X-Forwarded-Port, X-Amzn-Trace-Id, Accept-Encoding, Accept-Language, Referer, Origin, Activitypermission, Apiversion, Entityid, Livemode, Sec-Ch-Ua, Sec-Ch-Ua-Mobile, Sec-Ch-Ua-Platform, Sec-Fetch-Dest, Sec-Fetch-Mode, Sec-Fetch-Site, X-Datadog-Parent-Id, X-Datadog-Sampling-Priority, X-Datadog-Trace-Id, X-Forwarded-Host, X-Forwarded-Server, X-Real-Ip","Access-Control-Allow-Methods":"POST, GET, PUT, OPTIONS","Access-Control-Allow-Origin":"*","Access-Control-Max-Age":"1728000","Content-Type":"application/json; charset=utf-8","Referrer-Policy":"strict-origin-when-cross-origin","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Frame-Options":"SAMEORIGIN","X-Permitted-Cross-Domain-Policies":"none","X-XSS-Protection":"1; mode=block"},
48
+ searchable_tags: ["6307a60c41de27127515a575","6307a60c41de27127515a571"],
49
+ status: 200,
50
+ updated_at: 2022-08-25T16:40:44.887Z,
51
+ url: /filter_resource,
52
+ user_account_id: 5a0b7001edbb6e1725b0b2c6,
53
+ version: 2.1.0
54
+ )
55
+ ```
56
+
data/docs/LogsApi.md ADDED
@@ -0,0 +1,165 @@
1
+ # DigitalFemsa::LogsApi
2
+
3
+ All URIs are relative to *https://api.digitalfemsa.io*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**get_log_by_id**](LogsApi.md#get_log_by_id) | **GET** /logs/{id} | Get Log |
8
+ | [**get_logs**](LogsApi.md#get_logs) | **GET** /logs | Get List Of Logs |
9
+
10
+
11
+ ## get_log_by_id
12
+
13
+ > <LogResponse> get_log_by_id(id, opts)
14
+
15
+ Get Log
16
+
17
+ Get the details of a specific log
18
+
19
+ ### Examples
20
+
21
+ ```ruby
22
+ require 'time'
23
+ require 'digital_femsa'
24
+ # setup authorization
25
+ DigitalFemsa.configure do |config|
26
+ # Configure Bearer authorization: bearerAuth
27
+ config.access_token = 'YOUR_BEARER_TOKEN'
28
+ end
29
+
30
+ api_instance = DigitalFemsa::LogsApi.new
31
+ id = '6307a60c41de27127515a575' # String | Identifier of the resource
32
+ opts = {
33
+ accept_language: 'es', # String | Use for knowing which language to use
34
+ 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.
35
+ }
36
+
37
+ begin
38
+ # Get Log
39
+ result = api_instance.get_log_by_id(id, opts)
40
+ p result
41
+ rescue DigitalFemsa::ApiError => e
42
+ puts "Error when calling LogsApi->get_log_by_id: #{e}"
43
+ end
44
+ ```
45
+
46
+ #### Using the get_log_by_id_with_http_info variant
47
+
48
+ This returns an Array which contains the response data, status code and headers.
49
+
50
+ > <Array(<LogResponse>, Integer, Hash)> get_log_by_id_with_http_info(id, opts)
51
+
52
+ ```ruby
53
+ begin
54
+ # Get Log
55
+ data, status_code, headers = api_instance.get_log_by_id_with_http_info(id, opts)
56
+ p status_code # => 2xx
57
+ p headers # => { ... }
58
+ p data # => <LogResponse>
59
+ rescue DigitalFemsa::ApiError => e
60
+ puts "Error when calling LogsApi->get_log_by_id_with_http_info: #{e}"
61
+ end
62
+ ```
63
+
64
+ ### Parameters
65
+
66
+ | Name | Type | Description | Notes |
67
+ | ---- | ---- | ----------- | ----- |
68
+ | **id** | **String** | Identifier of the resource | |
69
+ | **accept_language** | **String** | Use for knowing which language to use | [optional][default to &#39;es&#39;] |
70
+ | **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] |
71
+
72
+ ### Return type
73
+
74
+ [**LogResponse**](LogResponse.md)
75
+
76
+ ### Authorization
77
+
78
+ [bearerAuth](../README.md#bearerAuth)
79
+
80
+ ### HTTP request headers
81
+
82
+ - **Content-Type**: Not defined
83
+ - **Accept**: application/vnd.app-v2.1.0+json
84
+
85
+
86
+ ## get_logs
87
+
88
+ > <LogsResponse> get_logs(opts)
89
+
90
+ Get List Of Logs
91
+
92
+ Get log details in the form of a list
93
+
94
+ ### Examples
95
+
96
+ ```ruby
97
+ require 'time'
98
+ require 'digital_femsa'
99
+ # setup authorization
100
+ DigitalFemsa.configure do |config|
101
+ # Configure Bearer authorization: bearerAuth
102
+ config.access_token = 'YOUR_BEARER_TOKEN'
103
+ end
104
+
105
+ api_instance = DigitalFemsa::LogsApi.new
106
+ opts = {
107
+ accept_language: 'es', # String | Use for knowing which language to use
108
+ 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.
109
+ limit: 56, # Integer | The numbers of items to return, the maximum value is 250
110
+ search: 'search_example', # String | General order search, e.g. by mail, reference etc.
111
+ _next: '_next_example', # String | next page
112
+ previous: 'previous_example' # String | previous page
113
+ }
114
+
115
+ begin
116
+ # Get List Of Logs
117
+ result = api_instance.get_logs(opts)
118
+ p result
119
+ rescue DigitalFemsa::ApiError => e
120
+ puts "Error when calling LogsApi->get_logs: #{e}"
121
+ end
122
+ ```
123
+
124
+ #### Using the get_logs_with_http_info variant
125
+
126
+ This returns an Array which contains the response data, status code and headers.
127
+
128
+ > <Array(<LogsResponse>, Integer, Hash)> get_logs_with_http_info(opts)
129
+
130
+ ```ruby
131
+ begin
132
+ # Get List Of Logs
133
+ data, status_code, headers = api_instance.get_logs_with_http_info(opts)
134
+ p status_code # => 2xx
135
+ p headers # => { ... }
136
+ p data # => <LogsResponse>
137
+ rescue DigitalFemsa::ApiError => e
138
+ puts "Error when calling LogsApi->get_logs_with_http_info: #{e}"
139
+ end
140
+ ```
141
+
142
+ ### Parameters
143
+
144
+ | Name | Type | Description | Notes |
145
+ | ---- | ---- | ----------- | ----- |
146
+ | **accept_language** | **String** | Use for knowing which language to use | [optional][default to &#39;es&#39;] |
147
+ | **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] |
148
+ | **limit** | **Integer** | The numbers of items to return, the maximum value is 250 | [optional][default to 20] |
149
+ | **search** | **String** | General order search, e.g. by mail, reference etc. | [optional] |
150
+ | **_next** | **String** | next page | [optional] |
151
+ | **previous** | **String** | previous page | [optional] |
152
+
153
+ ### Return type
154
+
155
+ [**LogsResponse**](LogsResponse.md)
156
+
157
+ ### Authorization
158
+
159
+ [bearerAuth](../README.md#bearerAuth)
160
+
161
+ ### HTTP request headers
162
+
163
+ - **Content-Type**: Not defined
164
+ - **Accept**: application/vnd.app-v2.1.0+json
165
+
@@ -0,0 +1,26 @@
1
+ # DigitalFemsa::LogsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **has_more** | **Boolean** | True, if there are more pages. | [optional][readonly] |
8
+ | **object** | **String** | The object type | [optional][readonly] |
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;LogsResponseData&gt;**](LogsResponseData.md) | set to page results. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'digital_femsa'
17
+
18
+ instance = DigitalFemsa::LogsResponse.new(
19
+ has_more: null,
20
+ object: null,
21
+ next_page_url: null,
22
+ previous_page_url: null,
23
+ data: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,56 @@
1
+ # DigitalFemsa::LogsResponseData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **created_at** | **Integer** | | [optional] |
8
+ | **id** | **String** | | [optional] |
9
+ | **ip_address** | **String** | | [optional] |
10
+ | **livemode** | **Boolean** | | [optional] |
11
+ | **loggable_id** | **String** | | [optional] |
12
+ | **loggable_type** | **String** | | [optional] |
13
+ | **method** | **String** | | [optional] |
14
+ | **oauth_token_id** | **String** | | [optional] |
15
+ | **query_string** | **Hash&lt;String, Object&gt;** | | [optional] |
16
+ | **related** | **String** | | [optional] |
17
+ | **request_body** | **Object** | | [optional] |
18
+ | **request_headers** | **Hash&lt;String, String&gt;** | | [optional] |
19
+ | **response_body** | **Object** | | [optional] |
20
+ | **response_headers** | **Hash&lt;String, String&gt;** | | [optional] |
21
+ | **searchable_tags** | **Array&lt;String&gt;** | | [optional] |
22
+ | **status** | **String** | | [optional] |
23
+ | **updated_at** | **String** | | [optional] |
24
+ | **url** | **String** | | [optional] |
25
+ | **user_account_id** | **String** | | [optional] |
26
+ | **version** | **String** | | [optional] |
27
+
28
+ ## Example
29
+
30
+ ```ruby
31
+ require 'digital_femsa'
32
+
33
+ instance = DigitalFemsa::LogsResponseData.new(
34
+ created_at: 1661445644,
35
+ id: 6307a60c41de27127515a575,
36
+ ip_address: 54.235.131.48,
37
+ livemode: true,
38
+ loggable_id: ord_87632467832,
39
+ loggable_type: order,
40
+ method: POST,
41
+ oauth_token_id: null,
42
+ query_string: {&quot;amount&quot;:3000,&quot;payable&quot;:true},
43
+ related: FilterResource,
44
+ request_body: {&quot;filters&quot;:{&quot;amount&quot;:{&quot;amount_from&quot;:0,&quot;amount_to&quot;:0},&quot;created_at&quot;:{&quot;date_from&quot;:1653627600,&quot;date_to&quot;:1661489999},&quot;filterName&quot;:&quot;Payments&quot;,&quot;search_term&quot;:null,&quot;sort_by&quot;:&quot;created_at&quot;,&quot;sort_direction&quot;:&quot;desc&quot;,&quot;status&quot;:[],&quot;type&quot;:[]},&quot;id&quot;:&quot;78e65162-0f37-4942-847c-9bf7081d54c2&quot;,&quot;page&quot;:&quot;0&quot;,&quot;report_type&quot;:&quot;charges&quot;,&quot;testMode&quot;:false},
45
+ request_headers: {&quot;Accept-Encoding&quot;:&quot;gzip, deflate, br&quot;,&quot;Accept-Language&quot;:&quot;es-419, es; q&#x3D;0.9, en; q&#x3D;0.8&quot;,&quot;Activitypermission&quot;:&quot;orders:read&quot;,&quot;Apiversion&quot;:&quot;2.1.0&quot;},
46
+ response_body: null,
47
+ response_headers: {&quot;Access-Control-Allow-Headers&quot;:&quot;Content-Type, Depth, User-Agent, X-File-Size, X-Requested-With, If-Modified-Since, X-File-Name, Cache-Control, X-Prototype-Version, Authorization, Accept, Date, Version, X-Forwarded-For, Host, Connection, X-Forwarded-Proto, X-Forwarded-Port, X-Amzn-Trace-Id, Accept-Encoding, Accept-Language, Referer, Origin, Activitypermission, Apiversion, Entityid, Livemode, Sec-Ch-Ua, Sec-Ch-Ua-Mobile, Sec-Ch-Ua-Platform, Sec-Fetch-Dest, Sec-Fetch-Mode, Sec-Fetch-Site, X-Datadog-Parent-Id, X-Datadog-Sampling-Priority, X-Datadog-Trace-Id, X-Forwarded-Host, X-Forwarded-Server, X-Real-Ip&quot;,&quot;Access-Control-Allow-Methods&quot;:&quot;POST, GET, PUT, OPTIONS&quot;,&quot;Access-Control-Allow-Origin&quot;:&quot;*&quot;,&quot;Access-Control-Max-Age&quot;:&quot;1728000&quot;,&quot;Content-Type&quot;:&quot;application/json; charset&#x3D;utf-8&quot;,&quot;Referrer-Policy&quot;:&quot;strict-origin-when-cross-origin&quot;,&quot;Strict-Transport-Security&quot;:&quot;max-age&#x3D;31536000; includeSubDomains&quot;,&quot;X-Content-Type-Options&quot;:&quot;nosniff&quot;,&quot;X-Download-Options&quot;:&quot;noopen&quot;,&quot;X-Frame-Options&quot;:&quot;SAMEORIGIN&quot;,&quot;X-Permitted-Cross-Domain-Policies&quot;:&quot;none&quot;,&quot;X-XSS-Protection&quot;:&quot;1; mode&#x3D;block&quot;},
48
+ searchable_tags: [&quot;6307a60c41de27127515a575&quot;,&quot;6307a60c41de27127515a571&quot;],
49
+ status: 200,
50
+ updated_at: 2022-08-25T16:40:44.887Z,
51
+ url: /filter_resource,
52
+ user_account_id: 5a0b7001edbb6e1725b0b2c6,
53
+ version: 2.1.0
54
+ )
55
+ ```
56
+
@@ -0,0 +1,18 @@
1
+ # DigitalFemsa::OrderCaptureRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **amount** | **Integer** | Amount to capture | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'digital_femsa'
13
+
14
+ instance = DigitalFemsa::OrderCaptureRequest.new(
15
+ amount: 500
16
+ )
17
+ ```
18
+
@@ -0,0 +1,28 @@
1
+ # DigitalFemsa::OrderCustomerInfoResponse
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
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'digital_femsa'
18
+
19
+ instance = DigitalFemsa::OrderCustomerInfoResponse.new(
20
+ customer_custom_reference: custom_reference,
21
+ name: DevTest,
22
+ email: test@femsa.com,
23
+ phone: 5522997233,
24
+ corporate: null,
25
+ object: customer_info
26
+ )
27
+ ```
28
+
@@ -0,0 +1,22 @@
1
+ # DigitalFemsa::OrderDiscountLinesRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **amount** | **Integer** | The amount to be deducted from the total sum of all payments, in cents. | |
8
+ | **code** | **String** | Discount code. | |
9
+ | **type** | **String** | It can be &#39;loyalty&#39;, &#39;campaign&#39;, &#39;coupon&#39; o &#39;sign&#39; | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'digital_femsa'
15
+
16
+ instance = DigitalFemsa::OrderDiscountLinesRequest.new(
17
+ amount: 500,
18
+ code: 123,
19
+ type: loyalty
20
+ )
21
+ ```
22
+
@@ -0,0 +1,32 @@
1
+ # DigitalFemsa::OrderFiscalEntityAddressResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **street1** | **String** | Street name and number | |
8
+ | **street2** | **String** | Street name and number | [optional] |
9
+ | **postal_code** | **String** | Postal code | |
10
+ | **city** | **String** | City | |
11
+ | **state** | **String** | State | [optional] |
12
+ | **country** | **String** | this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) | |
13
+ | **external_number** | **String** | External number | |
14
+ | **object** | **String** | | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'digital_femsa'
20
+
21
+ instance = DigitalFemsa::OrderFiscalEntityAddressResponse.new(
22
+ street1: Nuevo Leon 254,
23
+ street2: Departamento 404,
24
+ postal_code: 06100,
25
+ city: Ciudad de Mexico,
26
+ state: Ciudad de Mexico,
27
+ country: MX,
28
+ external_number: 123,
29
+ object: fiscal_entity_address
30
+ )
31
+ ```
32
+
@@ -0,0 +1,28 @@
1
+ # DigitalFemsa::OrderFiscalEntityRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **address** | [**FiscalEntityAddress**](FiscalEntityAddress.md) | | |
8
+ | **email** | **String** | Email of the fiscal entity | [optional] |
9
+ | **metadata** | **Hash&lt;String, Object&gt;** | Metadata associated with the fiscal entity | [optional] |
10
+ | **name** | **String** | Name of the fiscal entity | [optional] |
11
+ | **phone** | **String** | Phone of the fiscal entity | [optional] |
12
+ | **tax_id** | **String** | Tax ID of the fiscal entity | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'digital_femsa'
18
+
19
+ instance = DigitalFemsa::OrderFiscalEntityRequest.new(
20
+ address: null,
21
+ email: test@gmail.com,
22
+ metadata: null,
23
+ name: Femsa Inc,
24
+ phone: +525511223344,
25
+ tax_id: AAA010101AAA
26
+ )
27
+ ```
28
+
@@ -0,0 +1,34 @@
1
+ # DigitalFemsa::OrderFiscalEntityResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **address** | [**OrderFiscalEntityAddressResponse**](OrderFiscalEntityAddressResponse.md) | | |
8
+ | **email** | **String** | Email of the fiscal entity | [optional] |
9
+ | **metadata** | **Hash&lt;String, Object&gt;** | Metadata associated with the fiscal entity | [optional] |
10
+ | **name** | **String** | Name of the fiscal entity | [optional] |
11
+ | **tax_id** | **String** | Tax ID of the fiscal entity | [optional] |
12
+ | **id** | **String** | ID of the fiscal entity | |
13
+ | **created_at** | **Integer** | The time at which the object was created in seconds since the Unix epoch | |
14
+ | **object** | **String** | | |
15
+ | **phone** | **String** | Phone of the fiscal entity | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'digital_femsa'
21
+
22
+ instance = DigitalFemsa::OrderFiscalEntityResponse.new(
23
+ address: null,
24
+ email: test@gmail.com,
25
+ metadata: null,
26
+ name: Femsa Inc,
27
+ tax_id: 324234234,
28
+ id: fis_ent_2tN85VYaSMyDvjB3M,
29
+ created_at: 1676328434,
30
+ object: fiscal_entity,
31
+ phone: +525511223344
32
+ )
33
+ ```
34
+
@@ -0,0 +1,20 @@
1
+ # DigitalFemsa::OrderNextActionResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **redirect_to_url** | [**OrderNextActionResponseRedirectToUrl**](OrderNextActionResponseRedirectToUrl.md) | | [optional] |
8
+ | **type** | **String** | Indicates the type of action to be taken | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'digital_femsa'
14
+
15
+ instance = DigitalFemsa::OrderNextActionResponse.new(
16
+ redirect_to_url: null,
17
+ type: redirect_to_url
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # DigitalFemsa::OrderNextActionResponseRedirectToUrl
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **url** | **String** | pay.femsa.com/{id} Indicates the url of the Femsa component to authenticate the flow through 3DS2. | [optional] |
8
+ | **return_url** | **String** | Indicates the url to which the 3DS2 flow returns at the end, when the integration is redirected. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'digital_femsa'
14
+
15
+ instance = DigitalFemsa::OrderNextActionResponseRedirectToUrl.new(
16
+ url: https://pay.femsa.com/6fca054a85194c43971ecea35cc519bb,
17
+ return_url: https://my-website.com&quot;
18
+ )
19
+ ```
20
+
@@ -0,0 +1,22 @@
1
+ # DigitalFemsa::OrderRefundRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **amount** | **Integer** | | |
8
+ | **expires_at** | **Integer** | | [optional] |
9
+ | **reason** | **String** | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'digital_femsa'
15
+
16
+ instance = DigitalFemsa::OrderRefundRequest.new(
17
+ amount: 500,
18
+ expires_at: 1553273553,
19
+ reason: suspected_fraud
20
+ )
21
+ ```
22
+
@@ -0,0 +1,44 @@
1
+ # DigitalFemsa::OrderRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **charges** | [**Array&lt;ChargeRequest&gt;**](ChargeRequest.md) | List of [charges](https://developers.femsa.com/v2.1.0/reference/orderscreatecharge) that are applied to the order | [optional] |
8
+ | **checkout** | [**CheckoutRequest**](CheckoutRequest.md) | | [optional] |
9
+ | **currency** | **String** | Currency with which the payment will be made. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217) | |
10
+ | **customer_info** | [**OrderRequestCustomerInfo**](OrderRequestCustomerInfo.md) | | |
11
+ | **discount_lines** | [**Array&lt;OrderDiscountLinesRequest&gt;**](OrderDiscountLinesRequest.md) | List of [discounts](https://developers.femsa.com/v2.1.0/reference/orderscreatediscountline) that are applied to the order. You must have at least one discount. | [optional] |
12
+ | **fiscal_entity** | [**OrderFiscalEntityRequest**](OrderFiscalEntityRequest.md) | | [optional] |
13
+ | **line_items** | [**Array&lt;Product&gt;**](Product.md) | List of [products](https://developers.femsa.com/v2.1.0/reference/orderscreateproduct) that are sold in the order. You must have at least one product. | |
14
+ | **metadata** | **Hash&lt;String, Object&gt;** | Metadata associated with the order | [optional] |
15
+ | **needs_shipping_contact** | **Boolean** | Allows you to fill out the shipping information at checkout | [optional] |
16
+ | **processing_mode** | **String** | Indicates the processing mode for the order, either ecommerce, recurrent or validation. | [optional] |
17
+ | **return_url** | **String** | Indicates the redirection callback upon completion of the 3DS2 flow. | [optional] |
18
+ | **shipping_contact** | [**CustomerShippingContacts**](CustomerShippingContacts.md) | | [optional] |
19
+ | **shipping_lines** | [**Array&lt;ShippingRequest&gt;**](ShippingRequest.md) | List of [shipping costs](https://developers.femsa.com/v2.1.0/reference/orderscreateshipping). If the online store offers digital products. | [optional] |
20
+ | **tax_lines** | [**Array&lt;OrderTaxRequest&gt;**](OrderTaxRequest.md) | List of [taxes](https://developers.femsa.com/v2.1.0/reference/orderscreatetaxes) that are applied to the order. | [optional] |
21
+
22
+ ## Example
23
+
24
+ ```ruby
25
+ require 'digital_femsa'
26
+
27
+ instance = DigitalFemsa::OrderRequest.new(
28
+ charges: null,
29
+ checkout: null,
30
+ currency: MXN,
31
+ customer_info: null,
32
+ discount_lines: null,
33
+ fiscal_entity: null,
34
+ line_items: null,
35
+ metadata: null,
36
+ needs_shipping_contact: false,
37
+ processing_mode: ecommerce,
38
+ return_url: https://my-website.com,
39
+ shipping_contact: null,
40
+ shipping_lines: null,
41
+ tax_lines: null
42
+ )
43
+ ```
44
+
@@ -0,0 +1,49 @@
1
+ # DigitalFemsa::OrderRequestCustomerInfo
2
+
3
+ ## Class instance methods
4
+
5
+ ### `openapi_one_of`
6
+
7
+ Returns the list of classes defined in oneOf.
8
+
9
+ #### Example
10
+
11
+ ```ruby
12
+ require 'digital_femsa'
13
+
14
+ DigitalFemsa::OrderRequestCustomerInfo.openapi_one_of
15
+ # =>
16
+ # [
17
+ # :'CustomerInfo',
18
+ # :'CustomerInfoJustCustomerId'
19
+ # ]
20
+ ```
21
+
22
+ ### build
23
+
24
+ Find the appropriate object from the `openapi_one_of` list and casts the data into it.
25
+
26
+ #### Example
27
+
28
+ ```ruby
29
+ require 'digital_femsa'
30
+
31
+ DigitalFemsa::OrderRequestCustomerInfo.build(data)
32
+ # => #<CustomerInfo:0x00007fdd4aab02a0>
33
+
34
+ DigitalFemsa::OrderRequestCustomerInfo.build(data_that_doesnt_match)
35
+ # => nil
36
+ ```
37
+
38
+ #### Parameters
39
+
40
+ | Name | Type | Description |
41
+ | ---- | ---- | ----------- |
42
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
43
+
44
+ #### Return type
45
+
46
+ - `CustomerInfo`
47
+ - `CustomerInfoJustCustomerId`
48
+ - `nil` (if no type matches)
49
+