conekta 2.6.0 → 6.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHORS.md +28 -0
- data/CHANGELOG.md +8 -0
- data/CODE_OF_CONDUCT.md +77 -0
- data/CONTRIBUTING.md +19 -0
- data/Gemfile +5 -9
- data/{LICENSE.txt → LICENSE} +1 -1
- data/Makefile +2 -0
- data/README.md +367 -123
- data/Rakefile +9 -0
- data/VERSION +1 -0
- data/conekta.gemspec +38 -29
- data/conekta.png +0 -0
- data/docs/AntifraudApi.md +443 -0
- data/docs/ApiKeyCreateResponse.md +40 -0
- data/docs/ApiKeyCreateResponseAllOf.md +18 -0
- data/docs/ApiKeyRequest.md +20 -0
- data/docs/ApiKeyResponse.md +38 -0
- data/docs/ApiKeyResponseOnDelete.md +34 -0
- data/docs/ApiKeyUpdateRequest.md +20 -0
- data/docs/ApiKeysApi.md +391 -0
- data/docs/BalanceCommonField.md +20 -0
- data/docs/BalanceResponse.md +36 -0
- data/docs/BalancesApi.md +79 -0
- data/docs/BlacklistRuleResponse.md +24 -0
- data/docs/ChargeDataPaymentMethodBankTransferResponse.md +48 -0
- data/docs/ChargeDataPaymentMethodCardResponse.md +38 -0
- data/docs/ChargeDataPaymentMethodCashResponse.md +32 -0
- data/docs/ChargeOrderResponse.md +56 -0
- data/docs/ChargeOrderResponsePaymentMethod.md +82 -0
- data/docs/ChargeRequest.md +24 -0
- data/docs/ChargeRequestPaymentMethod.md +26 -0
- data/docs/ChargeResponse.md +54 -0
- data/docs/ChargeResponseChannel.md +24 -0
- data/docs/ChargeResponsePaymentMethod.md +82 -0
- data/docs/ChargeResponseRefunds.md +26 -0
- data/docs/ChargeResponseRefundsAllOf.md +18 -0
- data/docs/ChargeResponseRefundsData.md +30 -0
- data/docs/ChargesApi.md +165 -0
- data/docs/ChargesDataResponse.md +54 -0
- data/docs/Checkout.md +38 -0
- data/docs/CheckoutOrderTemplate.md +24 -0
- data/docs/CheckoutOrderTemplateCustomerInfo.md +49 -0
- data/docs/CheckoutRequest.md +34 -0
- data/docs/CheckoutResponse.md +66 -0
- data/docs/CheckoutsResponse.md +26 -0
- data/docs/CheckoutsResponseAllOf.md +18 -0
- data/docs/CompaniesApi.md +159 -0
- data/docs/CompanyFiscalInfoAddressResponse.md +34 -0
- data/docs/CompanyFiscalInfoResponse.md +30 -0
- data/docs/CompanyPayoutDestinationResponse.md +28 -0
- data/docs/CompanyResponse.md +32 -0
- data/docs/CreateCustomerFiscalEntitiesResponse.md +38 -0
- data/docs/CreateCustomerFiscalEntitiesResponseAllOf.md +26 -0
- data/docs/CreateCustomerPaymentMethodsRequest.md +51 -0
- data/docs/CreateCustomerPaymentMethodsResponse.md +83 -0
- data/docs/CreateRiskRulesData.md +22 -0
- data/docs/Customer.md +44 -0
- data/docs/CustomerAddress.md +32 -0
- data/docs/CustomerAntifraudInfo.md +20 -0
- data/docs/CustomerAntifraudInfoResponse.md +20 -0
- data/docs/CustomerFiscalEntitiesDataResponse.md +38 -0
- data/docs/CustomerFiscalEntitiesRequest.md +28 -0
- data/docs/CustomerFiscalEntitiesRequestAddress.md +32 -0
- data/docs/CustomerFiscalEntitiesResponse.md +22 -0
- data/docs/CustomerFiscalEntitiesResponseAllOf.md +18 -0
- data/docs/CustomerInfo.md +26 -0
- data/docs/CustomerInfoJustCustomerId.md +18 -0
- data/docs/CustomerInfoJustCustomerIdResponse.md +18 -0
- data/docs/CustomerInfoResponse.md +26 -0
- data/docs/CustomerPaymentMethodRequest.md +18 -0
- data/docs/CustomerPaymentMethods.md +18 -0
- data/docs/CustomerPaymentMethodsData.md +83 -0
- data/docs/CustomerPaymentMethodsRequest.md +51 -0
- data/docs/CustomerPaymentMethodsResponse.md +26 -0
- data/docs/CustomerResponse.md +50 -0
- data/docs/CustomerResponseShippingContacts.md +22 -0
- data/docs/CustomerResponseShippingContactsAllOf.md +18 -0
- data/docs/CustomerShippingContacts.md +30 -0
- data/docs/CustomerShippingContactsAddress.md +30 -0
- data/docs/CustomerShippingContactsDataResponse.md +36 -0
- data/docs/CustomerShippingContactsDataResponseAllOf.md +22 -0
- data/docs/CustomerShippingContactsResponse.md +36 -0
- data/docs/CustomerShippingContactsResponseAddress.md +32 -0
- data/docs/CustomerUpdateFiscalEntitiesRequest.md +28 -0
- data/docs/CustomerUpdateShippingContacts.md +30 -0
- data/docs/CustomersApi.md +553 -0
- data/docs/CustomersResponse.md +26 -0
- data/docs/CustomersResponseAllOf.md +18 -0
- data/docs/DeleteApiKeysResponse.md +34 -0
- data/docs/DeleteApiKeysResponseAllOf.md +18 -0
- data/docs/DeletedBlacklistRuleResponse.md +24 -0
- data/docs/DeletedWhitelistRuleResponse.md +24 -0
- data/docs/Details.md +18 -0
- data/docs/DetailsError.md +24 -0
- data/docs/DiscountLinesDataResponse.md +28 -0
- data/docs/DiscountLinesResponse.md +28 -0
- data/docs/DiscountLinesResponseAllOf.md +22 -0
- data/docs/DiscountsApi.md +405 -0
- data/docs/EmailCheckoutRequest.md +18 -0
- data/docs/Error.md +24 -0
- data/docs/ErrorAllOf.md +22 -0
- data/docs/EventResponse.md +32 -0
- data/docs/EventsApi.md +239 -0
- data/docs/EventsResendResponse.md +28 -0
- data/docs/GetApiKeysResponse.md +26 -0
- data/docs/GetApiKeysResponseAllOf.md +18 -0
- data/docs/GetChargesResponse.md +26 -0
- data/docs/GetChargesResponseAllOf.md +18 -0
- data/docs/GetCompaniesResponse.md +26 -0
- data/docs/GetCompaniesResponseAllOf.md +18 -0
- data/docs/GetCustomerPaymentMethodDataResponse.md +83 -0
- data/docs/GetEventsResponse.md +26 -0
- data/docs/GetEventsResponseAllOf.md +18 -0
- data/docs/GetOrderDiscountLinesResponse.md +26 -0
- data/docs/GetOrderDiscountLinesResponseAllOf.md +18 -0
- data/docs/GetOrdersResponse.md +26 -0
- data/docs/GetPaymentMethodResponse.md +26 -0
- data/docs/GetPaymentMethodResponseAllOf.md +18 -0
- data/docs/GetPlansResponse.md +26 -0
- data/docs/GetPlansResponseAllOf.md +18 -0
- data/docs/GetTransactionsResponse.md +26 -0
- data/docs/GetTransactionsResponseAllOf.md +18 -0
- data/docs/GetTransfersResponse.md +26 -0
- data/docs/GetTransfersResponseAllOf.md +18 -0
- data/docs/GetWebhookKeysResponse.md +26 -0
- data/docs/GetWebhookKeysResponseAllOf.md +18 -0
- data/docs/GetWebhooksResponse.md +26 -0
- data/docs/GetWebhooksResponseAllOf.md +18 -0
- data/docs/LogResponse.md +56 -0
- data/docs/LogsApi.md +165 -0
- data/docs/LogsResponse.md +26 -0
- data/docs/LogsResponseData.md +56 -0
- data/docs/OrderCaptureRequest.md +18 -0
- data/docs/OrderDiscountLinesRequest.md +22 -0
- data/docs/OrderRefundRequest.md +22 -0
- data/docs/OrderRequest.md +42 -0
- data/docs/OrderRequestCustomerInfo.md +49 -0
- data/docs/OrderResponse.md +56 -0
- data/docs/OrderResponseCharges.md +22 -0
- data/docs/OrderResponseChargesAllOf.md +18 -0
- data/docs/OrderResponseCheckout.md +68 -0
- data/docs/OrderResponseCustomerInfo.md +28 -0
- data/docs/OrderResponseCustomerInfoAllOf.md +18 -0
- data/docs/OrderResponseDiscountLines.md +22 -0
- data/docs/OrderResponseDiscountLinesAllOf.md +18 -0
- data/docs/OrderResponseFiscalEntity.md +24 -0
- data/docs/OrderResponseFiscalEntityAddress.md +34 -0
- data/docs/OrderResponseFiscalEntityAddressAllOf.md +18 -0
- data/docs/OrderResponseProducts.md +26 -0
- data/docs/OrderResponseProductsAllOf.md +18 -0
- data/docs/OrderResponseShippingContact.md +36 -0
- data/docs/OrderResponseShippingContactAllOf.md +22 -0
- data/docs/OrderTaxRequest.md +22 -0
- data/docs/OrderUpdateRequest.md +38 -0
- data/docs/OrderUpdateRequestCustomerInfo.md +49 -0
- data/docs/OrdersApi.md +627 -0
- data/docs/OrdersResponse.md +18 -0
- data/docs/Page.md +20 -0
- data/docs/Pagination.md +20 -0
- data/docs/PaymentLinkApi.md +463 -0
- data/docs/PaymentMethod.md +20 -0
- data/docs/PaymentMethodBankTransfer.md +52 -0
- data/docs/PaymentMethodCard.md +42 -0
- data/docs/PaymentMethodCardRequest.md +20 -0
- data/docs/PaymentMethodCardRequestAllOf.md +18 -0
- data/docs/PaymentMethodCardResponse.md +46 -0
- data/docs/PaymentMethodCardResponseAllOf.md +36 -0
- data/docs/PaymentMethodCash.md +36 -0
- data/docs/PaymentMethodCashRequest.md +20 -0
- data/docs/PaymentMethodCashRequestAllOf.md +18 -0
- data/docs/PaymentMethodCashResponse.md +36 -0
- data/docs/PaymentMethodCashResponseAllOf.md +26 -0
- data/docs/PaymentMethodResponse.md +26 -0
- data/docs/PaymentMethodSpeiRecurrent.md +30 -0
- data/docs/PaymentMethodSpeiRecurrentAllOf.md +20 -0
- data/docs/PaymentMethodSpeiRequest.md +20 -0
- data/docs/PaymentMethodsApi.md +327 -0
- data/docs/PlanRequest.md +32 -0
- data/docs/PlanResponse.md +38 -0
- data/docs/PlanUpdateRequest.md +24 -0
- data/docs/PlansApi.md +385 -0
- data/docs/Product.md +34 -0
- data/docs/ProductDataResponse.md +40 -0
- data/docs/ProductDataResponseAllOf.md +22 -0
- data/docs/ProductOrderResponse.md +40 -0
- data/docs/ProductOrderResponseAllOf.md +22 -0
- data/docs/ProductsApi.md +243 -0
- data/docs/RiskRules.md +18 -0
- data/docs/RiskRulesData.md +30 -0
- data/docs/RiskRulesList.md +26 -0
- data/docs/ShippingContactsApi.md +243 -0
- data/docs/ShippingOrderResponse.md +32 -0
- data/docs/ShippingRequest.md +26 -0
- data/docs/ShippingsApi.md +243 -0
- data/docs/SmsCheckoutRequest.md +18 -0
- data/docs/SubscriptionEventsResponse.md +26 -0
- data/docs/SubscriptionRequest.md +22 -0
- data/docs/SubscriptionResponse.md +50 -0
- data/docs/SubscriptionUpdateRequest.md +22 -0
- data/docs/SubscriptionsApi.md +539 -0
- data/docs/TaxesApi.md +243 -0
- data/docs/Token.md +20 -0
- data/docs/TokenCard.md +28 -0
- data/docs/TokenCheckout.md +18 -0
- data/docs/TokenResponse.md +26 -0
- data/docs/TokenResponseCheckout.md +62 -0
- data/docs/TokensApi.md +81 -0
- data/docs/TransactionResponse.md +38 -0
- data/docs/TransactionsApi.md +165 -0
- data/docs/TransferDestinationResponse.md +32 -0
- data/docs/TransferMethodResponse.md +32 -0
- data/docs/TransferResponse.md +36 -0
- data/docs/TransfersApi.md +165 -0
- data/docs/TransfersResponse.md +36 -0
- data/docs/UpdateCustomer.md +44 -0
- data/docs/UpdateCustomerAntifraudInfo.md +20 -0
- data/docs/UpdateCustomerFiscalEntitiesResponse.md +38 -0
- data/docs/UpdateCustomerFiscalEntitiesResponseAllOf.md +26 -0
- data/docs/UpdateCustomerPaymentMethodsResponse.md +83 -0
- data/docs/UpdateOrderDiscountLinesRequest.md +22 -0
- data/docs/UpdateOrderTaxRequest.md +22 -0
- data/docs/UpdateOrderTaxResponse.md +28 -0
- data/docs/UpdateOrderTaxResponseAllOf.md +22 -0
- data/docs/UpdatePaymentMethods.md +18 -0
- data/docs/UpdateProduct.md +34 -0
- data/docs/WebhookKeyCreateResponse.md +28 -0
- data/docs/WebhookKeyDeleteResponse.md +28 -0
- data/docs/WebhookKeyRequest.md +18 -0
- data/docs/WebhookKeyResponse.md +30 -0
- data/docs/WebhookKeyUpdateRequest.md +18 -0
- data/docs/WebhookKeysApi.md +385 -0
- data/docs/WebhookLog.md +30 -0
- data/docs/WebhookRequest.md +20 -0
- data/docs/WebhookResponse.md +36 -0
- data/docs/WebhookUpdateRequest.md +22 -0
- data/docs/WebhooksApi.md +461 -0
- data/docs/WhitelistlistRuleResponse.md +24 -0
- data/lib/conekta/api/antifraud_api.rb +434 -0
- data/lib/conekta/api/api_keys_api.rb +407 -0
- data/lib/conekta/api/balances_api.rb +86 -0
- data/lib/conekta/api/charges_api.rb +191 -0
- data/lib/conekta/api/companies_api.rb +174 -0
- data/lib/conekta/api/customers_api.rb +591 -0
- data/lib/conekta/api/discounts_api.rb +447 -0
- data/lib/conekta/api/events_api.rb +256 -0
- data/lib/conekta/api/logs_api.rb +182 -0
- data/lib/conekta/api/orders_api.rb +657 -0
- data/lib/conekta/api/payment_link_api.rb +491 -0
- data/lib/conekta/api/payment_methods_api.rb +368 -0
- data/lib/conekta/api/plans_api.rb +406 -0
- data/lib/conekta/api/products_api.rb +275 -0
- data/lib/conekta/api/shipping_contacts_api.rb +275 -0
- data/lib/conekta/api/shippings_api.rb +275 -0
- data/lib/conekta/api/subscriptions_api.rb +550 -0
- data/lib/conekta/api/taxes_api.rb +275 -0
- data/lib/conekta/api/tokens_api.rb +97 -0
- data/lib/conekta/api/transactions_api.rb +182 -0
- data/lib/conekta/api/transfers_api.rb +182 -0
- data/lib/conekta/api/webhook_keys_api.rb +396 -0
- data/lib/conekta/api/webhooks_api.rb +477 -0
- data/lib/conekta/api_client.rb +439 -0
- data/lib/conekta/api_error.rb +58 -0
- data/lib/conekta/configuration.rb +379 -0
- data/lib/conekta/models/api_key_create_response.rb +339 -0
- data/lib/conekta/models/api_key_create_response_all_of.rb +220 -0
- data/lib/conekta/models/api_key_request.rb +234 -0
- data/lib/conekta/models/api_key_response.rb +322 -0
- data/lib/conekta/models/api_key_response_on_delete.rb +301 -0
- data/lib/conekta/models/api_key_update_request.rb +230 -0
- data/lib/conekta/models/balance_common_field.rb +231 -0
- data/lib/conekta/models/balance_response.rb +329 -0
- data/lib/conekta/models/blacklist_rule_response.rb +250 -0
- data/lib/conekta/models/charge_data_payment_method_bank_transfer_response.rb +367 -0
- data/lib/conekta/models/charge_data_payment_method_card_response.rb +337 -0
- data/lib/conekta/models/charge_data_payment_method_cash_response.rb +286 -0
- data/lib/conekta/models/charge_order_response.rb +397 -0
- data/lib/conekta/models/charge_order_response_payment_method.rb +57 -0
- data/lib/conekta/models/charge_request.rb +254 -0
- data/lib/conekta/models/charge_request_payment_method.rb +287 -0
- data/lib/conekta/models/charge_response.rb +385 -0
- data/lib/conekta/models/charge_response_channel.rb +246 -0
- data/lib/conekta/models/charge_response_payment_method.rb +57 -0
- data/lib/conekta/models/charge_response_refunds.rb +283 -0
- data/lib/conekta/models/charge_response_refunds_all_of.rb +222 -0
- data/lib/conekta/models/charge_response_refunds_data.rb +295 -0
- data/lib/conekta/models/charges_data_response.rb +392 -0
- data/lib/conekta/models/checkout.rb +355 -0
- data/lib/conekta/models/checkout_order_template.rb +298 -0
- data/lib/conekta/models/checkout_order_template_customer_info.rb +106 -0
- data/lib/conekta/models/checkout_request.rb +307 -0
- data/lib/conekta/models/checkout_response.rb +466 -0
- data/lib/conekta/models/checkouts_response.rb +282 -0
- data/lib/conekta/models/checkouts_response_all_of.rb +221 -0
- data/lib/conekta/models/company_fiscal_info_address_response.rb +335 -0
- data/lib/conekta/models/company_fiscal_info_response.rb +314 -0
- data/lib/conekta/models/company_payout_destination_response.rb +317 -0
- data/lib/conekta/models/company_response.rb +323 -0
- data/lib/conekta/models/create_customer_fiscal_entities_response.rb +339 -0
- data/lib/conekta/models/create_customer_fiscal_entities_response_all_of.rb +270 -0
- data/lib/conekta/models/create_customer_payment_methods_request.rb +107 -0
- data/lib/conekta/models/create_customer_payment_methods_response.rb +58 -0
- data/lib/conekta/models/create_risk_rules_data.rb +255 -0
- data/lib/conekta/models/customer.rb +388 -0
- data/lib/conekta/models/customer_address.rb +298 -0
- data/lib/conekta/models/customer_antifraud_info.rb +228 -0
- data/lib/conekta/models/customer_antifraud_info_response.rb +228 -0
- data/lib/conekta/models/customer_fiscal_entities_data_response.rb +339 -0
- data/lib/conekta/models/customer_fiscal_entities_request.rb +271 -0
- data/lib/conekta/models/customer_fiscal_entities_request_address.rb +305 -0
- data/lib/conekta/models/customer_fiscal_entities_response.rb +259 -0
- data/lib/conekta/models/customer_fiscal_entities_response_all_of.rb +221 -0
- data/lib/conekta/models/customer_info.rb +270 -0
- data/lib/conekta/models/customer_info_just_customer_id.rb +224 -0
- data/lib/conekta/models/customer_info_just_customer_id_response.rb +219 -0
- data/lib/conekta/models/customer_info_response.rb +257 -0
- data/lib/conekta/models/customer_payment_method_request.rb +226 -0
- data/lib/conekta/models/customer_payment_methods.rb +221 -0
- data/lib/conekta/models/customer_payment_methods_data.rb +58 -0
- data/lib/conekta/models/customer_payment_methods_request.rb +106 -0
- data/lib/conekta/models/customer_payment_methods_response.rb +282 -0
- data/lib/conekta/models/customer_response.rb +387 -0
- data/lib/conekta/models/customer_response_shipping_contacts.rb +259 -0
- data/lib/conekta/models/customer_response_shipping_contacts_all_of.rb +221 -0
- data/lib/conekta/models/customer_shipping_contacts.rb +284 -0
- data/lib/conekta/models/customer_shipping_contacts_address.rb +276 -0
- data/lib/conekta/models/customer_shipping_contacts_data_response.rb +333 -0
- data/lib/conekta/models/customer_shipping_contacts_data_response_all_of.rb +252 -0
- data/lib/conekta/models/customer_shipping_contacts_response.rb +302 -0
- data/lib/conekta/models/customer_shipping_contacts_response_address.rb +282 -0
- data/lib/conekta/models/customer_update_fiscal_entities_request.rb +266 -0
- data/lib/conekta/models/customer_update_shipping_contacts.rb +279 -0
- data/lib/conekta/models/customers_response.rb +282 -0
- data/lib/conekta/models/customers_response_all_of.rb +221 -0
- data/lib/conekta/models/delete_api_keys_response.rb +307 -0
- data/lib/conekta/models/delete_api_keys_response_all_of.rb +219 -0
- data/lib/conekta/models/deleted_blacklist_rule_response.rb +250 -0
- data/lib/conekta/models/deleted_whitelist_rule_response.rb +250 -0
- data/lib/conekta/models/details.rb +221 -0
- data/lib/conekta/models/details_error.rb +247 -0
- data/lib/conekta/models/discount_lines_data_response.rb +326 -0
- data/lib/conekta/models/discount_lines_response.rb +327 -0
- data/lib/conekta/models/discount_lines_response_all_of.rb +255 -0
- data/lib/conekta/models/email_checkout_request.rb +224 -0
- data/lib/conekta/models/error.rb +259 -0
- data/lib/conekta/models/error_all_of.rb +239 -0
- data/lib/conekta/models/event_response.rb +302 -0
- data/lib/conekta/models/events_resend_response.rb +282 -0
- data/lib/conekta/models/get_api_keys_response.rb +282 -0
- data/lib/conekta/models/get_api_keys_response_all_of.rb +221 -0
- data/lib/conekta/models/get_charges_response.rb +282 -0
- data/lib/conekta/models/get_charges_response_all_of.rb +221 -0
- data/lib/conekta/models/get_companies_response.rb +282 -0
- data/lib/conekta/models/get_companies_response_all_of.rb +221 -0
- data/lib/conekta/models/get_customer_payment_method_data_response.rb +58 -0
- data/lib/conekta/models/get_events_response.rb +282 -0
- data/lib/conekta/models/get_events_response_all_of.rb +221 -0
- data/lib/conekta/models/get_order_discount_lines_response.rb +282 -0
- data/lib/conekta/models/get_order_discount_lines_response_all_of.rb +221 -0
- data/lib/conekta/models/get_orders_response.rb +287 -0
- data/lib/conekta/models/get_payment_method_response.rb +282 -0
- data/lib/conekta/models/get_payment_method_response_all_of.rb +221 -0
- data/lib/conekta/models/get_plans_response.rb +282 -0
- data/lib/conekta/models/get_plans_response_all_of.rb +221 -0
- data/lib/conekta/models/get_transactions_response.rb +283 -0
- data/lib/conekta/models/get_transactions_response_all_of.rb +222 -0
- data/lib/conekta/models/get_transfers_response.rb +283 -0
- data/lib/conekta/models/get_transfers_response_all_of.rb +222 -0
- data/lib/conekta/models/get_webhook_keys_response.rb +282 -0
- data/lib/conekta/models/get_webhook_keys_response_all_of.rb +221 -0
- data/lib/conekta/models/get_webhooks_response.rb +282 -0
- data/lib/conekta/models/get_webhooks_response_all_of.rb +221 -0
- data/lib/conekta/models/log_response.rb +417 -0
- data/lib/conekta/models/logs_response.rb +266 -0
- data/lib/conekta/models/logs_response_data.rb +401 -0
- data/lib/conekta/models/order_capture_request.rb +244 -0
- data/lib/conekta/models/order_discount_lines_request.rb +275 -0
- data/lib/conekta/models/order_refund_request.rb +248 -0
- data/lib/conekta/models/order_request.rb +401 -0
- data/lib/conekta/models/order_request_customer_info.rb +106 -0
- data/lib/conekta/models/order_response.rb +418 -0
- data/lib/conekta/models/order_response_charges.rb +260 -0
- data/lib/conekta/models/order_response_charges_all_of.rb +221 -0
- data/lib/conekta/models/order_response_checkout.rb +468 -0
- data/lib/conekta/models/order_response_customer_info.rb +275 -0
- data/lib/conekta/models/order_response_customer_info_all_of.rb +219 -0
- data/lib/conekta/models/order_response_discount_lines.rb +259 -0
- data/lib/conekta/models/order_response_discount_lines_all_of.rb +221 -0
- data/lib/conekta/models/order_response_fiscal_entity.rb +246 -0
- data/lib/conekta/models/order_response_fiscal_entity_address.rb +315 -0
- data/lib/conekta/models/order_response_fiscal_entity_address_all_of.rb +219 -0
- data/lib/conekta/models/order_response_products.rb +282 -0
- data/lib/conekta/models/order_response_products_all_of.rb +221 -0
- data/lib/conekta/models/order_response_shipping_contact.rb +309 -0
- data/lib/conekta/models/order_response_shipping_contact_all_of.rb +237 -0
- data/lib/conekta/models/order_tax_request.rb +305 -0
- data/lib/conekta/models/order_update_request.rb +344 -0
- data/lib/conekta/models/order_update_request_customer_info.rb +105 -0
- data/lib/conekta/models/orders_response.rb +226 -0
- data/lib/conekta/models/page.rb +233 -0
- data/lib/conekta/models/pagination.rb +241 -0
- data/lib/conekta/models/payment_method.rb +233 -0
- data/lib/conekta/models/payment_method_bank_transfer.rb +397 -0
- data/lib/conekta/models/payment_method_card.rb +367 -0
- data/lib/conekta/models/payment_method_card_request.rb +248 -0
- data/lib/conekta/models/payment_method_card_request_all_of.rb +220 -0
- data/lib/conekta/models/payment_method_card_response.rb +373 -0
- data/lib/conekta/models/payment_method_card_response_all_of.rb +301 -0
- data/lib/conekta/models/payment_method_cash.rb +316 -0
- data/lib/conekta/models/payment_method_cash_request.rb +242 -0
- data/lib/conekta/models/payment_method_cash_request_all_of.rb +219 -0
- data/lib/conekta/models/payment_method_cash_response.rb +328 -0
- data/lib/conekta/models/payment_method_cash_response_all_of.rb +256 -0
- data/lib/conekta/models/payment_method_response.rb +275 -0
- data/lib/conekta/models/payment_method_spei_recurrent.rb +301 -0
- data/lib/conekta/models/payment_method_spei_recurrent_all_of.rb +229 -0
- data/lib/conekta/models/payment_method_spei_request.rb +242 -0
- data/lib/conekta/models/plan_request.rb +398 -0
- data/lib/conekta/models/plan_response.rb +327 -0
- data/lib/conekta/models/plan_update_request.rb +281 -0
- data/lib/conekta/models/product.rb +388 -0
- data/lib/conekta/models/product_data_response.rb +423 -0
- data/lib/conekta/models/product_data_response_all_of.rb +237 -0
- data/lib/conekta/models/product_order_response.rb +423 -0
- data/lib/conekta/models/product_order_response_all_of.rb +237 -0
- data/lib/conekta/models/risk_rules.rb +221 -0
- data/lib/conekta/models/risk_rules_data.rb +280 -0
- data/lib/conekta/models/risk_rules_list.rb +282 -0
- data/lib/conekta/models/shipping_order_response.rb +336 -0
- data/lib/conekta/models/shipping_request.rb +301 -0
- data/lib/conekta/models/sms_checkout_request.rb +224 -0
- data/lib/conekta/models/subscription_events_response.rb +282 -0
- data/lib/conekta/models/subscription_request.rb +243 -0
- data/lib/conekta/models/subscription_response.rb +371 -0
- data/lib/conekta/models/subscription_update_request.rb +238 -0
- data/lib/conekta/models/token.rb +231 -0
- data/lib/conekta/models/token_card.rb +352 -0
- data/lib/conekta/models/token_checkout.rb +220 -0
- data/lib/conekta/models/token_response.rb +281 -0
- data/lib/conekta/models/token_response_checkout.rb +439 -0
- data/lib/conekta/models/transaction_response.rb +395 -0
- data/lib/conekta/models/transfer_destination_response.rb +291 -0
- data/lib/conekta/models/transfer_method_response.rb +291 -0
- data/lib/conekta/models/transfer_response.rb +325 -0
- data/lib/conekta/models/transfers_response.rb +325 -0
- data/lib/conekta/models/update_customer.rb +373 -0
- data/lib/conekta/models/update_customer_antifraud_info.rb +228 -0
- data/lib/conekta/models/update_customer_fiscal_entities_response.rb +339 -0
- data/lib/conekta/models/update_customer_fiscal_entities_response_all_of.rb +270 -0
- data/lib/conekta/models/update_customer_payment_methods_response.rb +58 -0
- data/lib/conekta/models/update_order_discount_lines_request.rb +254 -0
- data/lib/conekta/models/update_order_tax_request.rb +287 -0
- data/lib/conekta/models/update_order_tax_response.rb +345 -0
- data/lib/conekta/models/update_order_tax_response_all_of.rb +237 -0
- data/lib/conekta/models/update_payment_methods.rb +219 -0
- data/lib/conekta/models/update_product.rb +342 -0
- data/lib/conekta/models/webhook_key_create_response.rb +271 -0
- data/lib/conekta/models/webhook_key_delete_response.rb +271 -0
- data/lib/conekta/models/webhook_key_request.rb +222 -0
- data/lib/conekta/models/webhook_key_response.rb +282 -0
- data/lib/conekta/models/webhook_key_update_request.rb +222 -0
- data/lib/conekta/models/webhook_log.rb +290 -0
- data/lib/conekta/models/webhook_request.rb +264 -0
- data/lib/conekta/models/webhook_response.rb +304 -0
- data/lib/conekta/models/webhook_update_request.rb +270 -0
- data/lib/conekta/models/whitelistlist_rule_response.rb +250 -0
- data/lib/conekta/version.rb +13 -1
- data/lib/conekta.rb +255 -93
- data/lib/ssl_data/ca_bundle.crt +84 -0
- data/spec/api/antifraud_api_spec.rb +166 -0
- data/spec/api/api_keys_api_spec.rb +151 -0
- data/spec/api/balances_api_spec.rb +56 -0
- data/spec/api/base_test.rb +9 -0
- data/spec/api/charges_api_spec.rb +140 -0
- data/spec/api/companies_api_spec.rb +71 -0
- data/spec/api/customers_api_spec.rb +305 -0
- data/spec/api/discounts_api_spec.rb +153 -0
- data/spec/api/events_api_spec.rb +96 -0
- data/spec/api/logs_api_spec.rb +78 -0
- data/spec/api/orders_api_spec.rb +362 -0
- data/spec/api/payment_link_api_spec.rb +192 -0
- data/spec/api/payment_methods_api_spec.rb +134 -0
- data/spec/api/plans_api_spec.rb +139 -0
- data/spec/api/products_api_spec.rb +106 -0
- data/spec/api/shipping_contacts_api_spec.rb +117 -0
- data/spec/api/shippings_api_spec.rb +108 -0
- data/spec/api/subscriptions_api_spec.rb +177 -0
- data/spec/api/taxes_api_spec.rb +110 -0
- data/spec/api/tokens_api_spec.rb +76 -0
- data/spec/api/transactions_api_spec.rb +82 -0
- data/spec/api/transfers_api_spec.rb +96 -0
- data/spec/api/webhook_keys_api_spec.rb +146 -0
- data/spec/api/webhooks_api_spec.rb +152 -0
- data/spec/api_client_spec.rb +223 -0
- data/spec/configuration_spec.rb +82 -0
- data/spec/spec_helper.rb +114 -9
- metadata +535 -188
- data/.gitignore +0 -23
- data/.rspec +0 -1
- data/Dockerfile +0 -44
- data/lib/conekta/address.rb +0 -5
- data/lib/conekta/card.rb +0 -21
- data/lib/conekta/charge.rb +0 -25
- data/lib/conekta/checkout.rb +0 -35
- data/lib/conekta/conekta_object.rb +0 -109
- data/lib/conekta/customer.rb +0 -82
- data/lib/conekta/customer_info.rb +0 -5
- data/lib/conekta/destination.rb +0 -17
- data/lib/conekta/details.rb +0 -5
- data/lib/conekta/discount_line.rb +0 -19
- data/lib/conekta/error.rb +0 -100
- data/lib/conekta/error_details.rb +0 -14
- data/lib/conekta/event.rb +0 -9
- data/lib/conekta/line_item.rb +0 -21
- data/lib/conekta/list.rb +0 -58
- data/lib/conekta/log.rb +0 -10
- data/lib/conekta/method.rb +0 -4
- data/lib/conekta/operations/create.rb +0 -18
- data/lib/conekta/operations/create_member.rb +0 -40
- data/lib/conekta/operations/custom_action.rb +0 -13
- data/lib/conekta/operations/delete.rb +0 -45
- data/lib/conekta/operations/find.rb +0 -20
- data/lib/conekta/operations/update.rb +0 -11
- data/lib/conekta/operations/where.rb +0 -30
- data/lib/conekta/order.rb +0 -86
- data/lib/conekta/payee.rb +0 -66
- data/lib/conekta/payment_method.rb +0 -4
- data/lib/conekta/payment_source.rb +0 -17
- data/lib/conekta/payout.rb +0 -7
- data/lib/conekta/payout_method.rb +0 -17
- data/lib/conekta/plan.rb +0 -16
- data/lib/conekta/refund.rb +0 -6
- data/lib/conekta/requestor.rb +0 -76
- data/lib/conekta/resource.rb +0 -55
- data/lib/conekta/return.rb +0 -12
- data/lib/conekta/shipping_contact.rb +0 -19
- data/lib/conekta/shipping_line.rb +0 -20
- data/lib/conekta/subscription.rb +0 -25
- data/lib/conekta/tax_line.rb +0 -19
- data/lib/conekta/token.rb +0 -8
- data/lib/conekta/transfer.rb +0 -7
- data/lib/conekta/util.rb +0 -137
- data/lib/conekta/webhook.rb +0 -12
- data/lib/conekta/webhook_log.rb +0 -4
- data/locales/en.yml +0 -9
- data/locales/es.yml +0 -10
- data/readme_files/banner.png +0 -0
- data/readme_files/conekta-badge.png +0 -0
- data/readme_files/ruby-badge.png +0 -0
- data/spec/conekta/1.0.0/.DS_Store +0 -0
- data/spec/conekta/1.0.0/card_spec.rb +0 -40
- data/spec/conekta/1.0.0/charge_spec.rb +0 -152
- data/spec/conekta/1.0.0/customer_spec.rb +0 -147
- data/spec/conekta/1.0.0/error_spec.rb +0 -69
- data/spec/conekta/1.0.0/event_spec.rb +0 -26
- data/spec/conekta/1.0.0/log_spec.rb +0 -20
- data/spec/conekta/1.0.0/payout_spec.rb +0 -60
- data/spec/conekta/1.0.0/plan_spec.rb +0 -53
- data/spec/conekta/1.0.0/token_spec.rb +0 -5
- data/spec/conekta/1.0.0/webhook_spec.rb +0 -36
- data/spec/conekta/2.0.0/checkout_spec.rb +0 -224
- data/spec/conekta/2.0.0/customer_spec.rb +0 -77
- data/spec/conekta/2.0.0/discount_line_spec.rb +0 -49
- data/spec/conekta/2.0.0/error_spec.rb +0 -61
- data/spec/conekta/2.0.0/line_item_spec.rb +0 -53
- data/spec/conekta/2.0.0/list_spec.rb +0 -29
- data/spec/conekta/2.0.0/order_spec.rb +0 -376
- data/spec/conekta/2.0.0/payee_spec.rb +0 -55
- data/spec/conekta/2.0.0/shipping_contact_spec.rb +0 -60
- data/spec/conekta/2.0.0/shipping_line_spec.rb +0 -53
- data/spec/conekta/2.0.0/source_spec.rb +0 -31
- data/spec/conekta/2.0.0/tax_line_spec.rb +0 -44
- data/spec/conekta/2.0.0/transfer_spec.rb +0 -59
- data/spec/conekta_spec.rb +0 -29
- data/spec/support/fixtures/orders.json +0 -1127
- data/spec/support/shared_context.rb +0 -49
data/docs/OrdersApi.md
ADDED
@@ -0,0 +1,627 @@
|
|
1
|
+
# Conekta::OrdersApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.conekta.io*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**cancel_order**](OrdersApi.md#cancel_order) | **POST** /orders/{id}/cancel | Cancel Order |
|
8
|
+
| [**create_order**](OrdersApi.md#create_order) | **POST** /orders | Create order |
|
9
|
+
| [**get_order_by_id**](OrdersApi.md#get_order_by_id) | **GET** /orders/{id} | Get Order |
|
10
|
+
| [**get_orders**](OrdersApi.md#get_orders) | **GET** /orders | Get a list of Orders |
|
11
|
+
| [**order_cancel_refund**](OrdersApi.md#order_cancel_refund) | **DELETE** /orders/{id}/refunds/{refund_id} | Cancel Refund |
|
12
|
+
| [**order_refund**](OrdersApi.md#order_refund) | **POST** /orders/{id}/refunds | Refund Order |
|
13
|
+
| [**orders_create_capture**](OrdersApi.md#orders_create_capture) | **POST** /orders/{id}/capture | Capture Order |
|
14
|
+
| [**update_order**](OrdersApi.md#update_order) | **PUT** /orders/{id} | Update Order |
|
15
|
+
|
16
|
+
|
17
|
+
## cancel_order
|
18
|
+
|
19
|
+
> <OrderResponse> cancel_order(id, opts)
|
20
|
+
|
21
|
+
Cancel Order
|
22
|
+
|
23
|
+
Cancel an order that has been previously created.
|
24
|
+
|
25
|
+
### Examples
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'time'
|
29
|
+
require 'conekta'
|
30
|
+
# setup authorization
|
31
|
+
Conekta.configure do |config|
|
32
|
+
# Configure Bearer authorization: bearerAuth
|
33
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
34
|
+
end
|
35
|
+
|
36
|
+
api_instance = Conekta::OrdersApi.new
|
37
|
+
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
38
|
+
opts = {
|
39
|
+
accept_language: 'es', # String | Use for knowing which language to use
|
40
|
+
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.
|
41
|
+
}
|
42
|
+
|
43
|
+
begin
|
44
|
+
# Cancel Order
|
45
|
+
result = api_instance.cancel_order(id, opts)
|
46
|
+
p result
|
47
|
+
rescue Conekta::ApiError => e
|
48
|
+
puts "Error when calling OrdersApi->cancel_order: #{e}"
|
49
|
+
end
|
50
|
+
```
|
51
|
+
|
52
|
+
#### Using the cancel_order_with_http_info variant
|
53
|
+
|
54
|
+
This returns an Array which contains the response data, status code and headers.
|
55
|
+
|
56
|
+
> <Array(<OrderResponse>, Integer, Hash)> cancel_order_with_http_info(id, opts)
|
57
|
+
|
58
|
+
```ruby
|
59
|
+
begin
|
60
|
+
# Cancel Order
|
61
|
+
data, status_code, headers = api_instance.cancel_order_with_http_info(id, opts)
|
62
|
+
p status_code # => 2xx
|
63
|
+
p headers # => { ... }
|
64
|
+
p data # => <OrderResponse>
|
65
|
+
rescue Conekta::ApiError => e
|
66
|
+
puts "Error when calling OrdersApi->cancel_order_with_http_info: #{e}"
|
67
|
+
end
|
68
|
+
```
|
69
|
+
|
70
|
+
### Parameters
|
71
|
+
|
72
|
+
| Name | Type | Description | Notes |
|
73
|
+
| ---- | ---- | ----------- | ----- |
|
74
|
+
| **id** | **String** | Identifier of the resource | |
|
75
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
76
|
+
| **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] |
|
77
|
+
|
78
|
+
### Return type
|
79
|
+
|
80
|
+
[**OrderResponse**](OrderResponse.md)
|
81
|
+
|
82
|
+
### Authorization
|
83
|
+
|
84
|
+
[bearerAuth](../README.md#bearerAuth)
|
85
|
+
|
86
|
+
### HTTP request headers
|
87
|
+
|
88
|
+
- **Content-Type**: Not defined
|
89
|
+
- **Accept**: application/vnd.conekta-v2.1.0+json
|
90
|
+
|
91
|
+
|
92
|
+
## create_order
|
93
|
+
|
94
|
+
> <OrderResponse> create_order(order_request, opts)
|
95
|
+
|
96
|
+
Create order
|
97
|
+
|
98
|
+
Create a new order.
|
99
|
+
|
100
|
+
### Examples
|
101
|
+
|
102
|
+
```ruby
|
103
|
+
require 'time'
|
104
|
+
require 'conekta'
|
105
|
+
# setup authorization
|
106
|
+
Conekta.configure do |config|
|
107
|
+
# Configure Bearer authorization: bearerAuth
|
108
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
109
|
+
end
|
110
|
+
|
111
|
+
api_instance = Conekta::OrdersApi.new
|
112
|
+
order_request = Conekta::OrderRequest.new({currency: 'MXN', customer_info: Conekta::CustomerInfo.new({name: 'DevTest', email: 'test@conekta.com', phone: '5522997233'}), line_items: [Conekta::Product.new({name: 'Box of Cohiba S1s', quantity: 1, unit_price: 20000})]}) # OrderRequest | requested field for order
|
113
|
+
opts = {
|
114
|
+
accept_language: 'es', # String | Use for knowing which language to use
|
115
|
+
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.
|
116
|
+
}
|
117
|
+
|
118
|
+
begin
|
119
|
+
# Create order
|
120
|
+
result = api_instance.create_order(order_request, opts)
|
121
|
+
p result
|
122
|
+
rescue Conekta::ApiError => e
|
123
|
+
puts "Error when calling OrdersApi->create_order: #{e}"
|
124
|
+
end
|
125
|
+
```
|
126
|
+
|
127
|
+
#### Using the create_order_with_http_info variant
|
128
|
+
|
129
|
+
This returns an Array which contains the response data, status code and headers.
|
130
|
+
|
131
|
+
> <Array(<OrderResponse>, Integer, Hash)> create_order_with_http_info(order_request, opts)
|
132
|
+
|
133
|
+
```ruby
|
134
|
+
begin
|
135
|
+
# Create order
|
136
|
+
data, status_code, headers = api_instance.create_order_with_http_info(order_request, opts)
|
137
|
+
p status_code # => 2xx
|
138
|
+
p headers # => { ... }
|
139
|
+
p data # => <OrderResponse>
|
140
|
+
rescue Conekta::ApiError => e
|
141
|
+
puts "Error when calling OrdersApi->create_order_with_http_info: #{e}"
|
142
|
+
end
|
143
|
+
```
|
144
|
+
|
145
|
+
### Parameters
|
146
|
+
|
147
|
+
| Name | Type | Description | Notes |
|
148
|
+
| ---- | ---- | ----------- | ----- |
|
149
|
+
| **order_request** | [**OrderRequest**](OrderRequest.md) | requested field for order | |
|
150
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
151
|
+
| **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] |
|
152
|
+
|
153
|
+
### Return type
|
154
|
+
|
155
|
+
[**OrderResponse**](OrderResponse.md)
|
156
|
+
|
157
|
+
### Authorization
|
158
|
+
|
159
|
+
[bearerAuth](../README.md#bearerAuth)
|
160
|
+
|
161
|
+
### HTTP request headers
|
162
|
+
|
163
|
+
- **Content-Type**: application/json
|
164
|
+
- **Accept**: application/vnd.conekta-v2.1.0+json
|
165
|
+
|
166
|
+
|
167
|
+
## get_order_by_id
|
168
|
+
|
169
|
+
> <OrderResponse> get_order_by_id(id, opts)
|
170
|
+
|
171
|
+
Get Order
|
172
|
+
|
173
|
+
Info for a specific order
|
174
|
+
|
175
|
+
### Examples
|
176
|
+
|
177
|
+
```ruby
|
178
|
+
require 'time'
|
179
|
+
require 'conekta'
|
180
|
+
# setup authorization
|
181
|
+
Conekta.configure do |config|
|
182
|
+
# Configure Bearer authorization: bearerAuth
|
183
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
184
|
+
end
|
185
|
+
|
186
|
+
api_instance = Conekta::OrdersApi.new
|
187
|
+
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
188
|
+
opts = {
|
189
|
+
accept_language: 'es', # String | Use for knowing which language to use
|
190
|
+
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.
|
191
|
+
}
|
192
|
+
|
193
|
+
begin
|
194
|
+
# Get Order
|
195
|
+
result = api_instance.get_order_by_id(id, opts)
|
196
|
+
p result
|
197
|
+
rescue Conekta::ApiError => e
|
198
|
+
puts "Error when calling OrdersApi->get_order_by_id: #{e}"
|
199
|
+
end
|
200
|
+
```
|
201
|
+
|
202
|
+
#### Using the get_order_by_id_with_http_info variant
|
203
|
+
|
204
|
+
This returns an Array which contains the response data, status code and headers.
|
205
|
+
|
206
|
+
> <Array(<OrderResponse>, Integer, Hash)> get_order_by_id_with_http_info(id, opts)
|
207
|
+
|
208
|
+
```ruby
|
209
|
+
begin
|
210
|
+
# Get Order
|
211
|
+
data, status_code, headers = api_instance.get_order_by_id_with_http_info(id, opts)
|
212
|
+
p status_code # => 2xx
|
213
|
+
p headers # => { ... }
|
214
|
+
p data # => <OrderResponse>
|
215
|
+
rescue Conekta::ApiError => e
|
216
|
+
puts "Error when calling OrdersApi->get_order_by_id_with_http_info: #{e}"
|
217
|
+
end
|
218
|
+
```
|
219
|
+
|
220
|
+
### Parameters
|
221
|
+
|
222
|
+
| Name | Type | Description | Notes |
|
223
|
+
| ---- | ---- | ----------- | ----- |
|
224
|
+
| **id** | **String** | Identifier of the resource | |
|
225
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
226
|
+
| **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] |
|
227
|
+
|
228
|
+
### Return type
|
229
|
+
|
230
|
+
[**OrderResponse**](OrderResponse.md)
|
231
|
+
|
232
|
+
### Authorization
|
233
|
+
|
234
|
+
[bearerAuth](../README.md#bearerAuth)
|
235
|
+
|
236
|
+
### HTTP request headers
|
237
|
+
|
238
|
+
- **Content-Type**: Not defined
|
239
|
+
- **Accept**: application/vnd.conekta-v2.1.0+json
|
240
|
+
|
241
|
+
|
242
|
+
## get_orders
|
243
|
+
|
244
|
+
> <GetOrdersResponse> get_orders(opts)
|
245
|
+
|
246
|
+
Get a list of Orders
|
247
|
+
|
248
|
+
Get order details in the form of a list
|
249
|
+
|
250
|
+
### Examples
|
251
|
+
|
252
|
+
```ruby
|
253
|
+
require 'time'
|
254
|
+
require 'conekta'
|
255
|
+
# setup authorization
|
256
|
+
Conekta.configure do |config|
|
257
|
+
# Configure Bearer authorization: bearerAuth
|
258
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
259
|
+
end
|
260
|
+
|
261
|
+
api_instance = Conekta::OrdersApi.new
|
262
|
+
opts = {
|
263
|
+
accept_language: 'es', # String | Use for knowing which language to use
|
264
|
+
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.
|
265
|
+
limit: 56, # Integer | The numbers of items to return, the maximum value is 250
|
266
|
+
search: 'search_example', # String | General order search, e.g. by mail, reference etc.
|
267
|
+
_next: '_next_example', # String | next page
|
268
|
+
previous: 'previous_example' # String | previous page
|
269
|
+
}
|
270
|
+
|
271
|
+
begin
|
272
|
+
# Get a list of Orders
|
273
|
+
result = api_instance.get_orders(opts)
|
274
|
+
p result
|
275
|
+
rescue Conekta::ApiError => e
|
276
|
+
puts "Error when calling OrdersApi->get_orders: #{e}"
|
277
|
+
end
|
278
|
+
```
|
279
|
+
|
280
|
+
#### Using the get_orders_with_http_info variant
|
281
|
+
|
282
|
+
This returns an Array which contains the response data, status code and headers.
|
283
|
+
|
284
|
+
> <Array(<GetOrdersResponse>, Integer, Hash)> get_orders_with_http_info(opts)
|
285
|
+
|
286
|
+
```ruby
|
287
|
+
begin
|
288
|
+
# Get a list of Orders
|
289
|
+
data, status_code, headers = api_instance.get_orders_with_http_info(opts)
|
290
|
+
p status_code # => 2xx
|
291
|
+
p headers # => { ... }
|
292
|
+
p data # => <GetOrdersResponse>
|
293
|
+
rescue Conekta::ApiError => e
|
294
|
+
puts "Error when calling OrdersApi->get_orders_with_http_info: #{e}"
|
295
|
+
end
|
296
|
+
```
|
297
|
+
|
298
|
+
### Parameters
|
299
|
+
|
300
|
+
| Name | Type | Description | Notes |
|
301
|
+
| ---- | ---- | ----------- | ----- |
|
302
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
303
|
+
| **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] |
|
304
|
+
| **limit** | **Integer** | The numbers of items to return, the maximum value is 250 | [optional][default to 20] |
|
305
|
+
| **search** | **String** | General order search, e.g. by mail, reference etc. | [optional] |
|
306
|
+
| **_next** | **String** | next page | [optional] |
|
307
|
+
| **previous** | **String** | previous page | [optional] |
|
308
|
+
|
309
|
+
### Return type
|
310
|
+
|
311
|
+
[**GetOrdersResponse**](GetOrdersResponse.md)
|
312
|
+
|
313
|
+
### Authorization
|
314
|
+
|
315
|
+
[bearerAuth](../README.md#bearerAuth)
|
316
|
+
|
317
|
+
### HTTP request headers
|
318
|
+
|
319
|
+
- **Content-Type**: Not defined
|
320
|
+
- **Accept**: application/vnd.conekta-v2.1.0+json
|
321
|
+
|
322
|
+
|
323
|
+
## order_cancel_refund
|
324
|
+
|
325
|
+
> <OrderResponse> order_cancel_refund(id, refund_id, opts)
|
326
|
+
|
327
|
+
Cancel Refund
|
328
|
+
|
329
|
+
A refunded order describes the items, amount, and reason an order is being refunded.
|
330
|
+
|
331
|
+
### Examples
|
332
|
+
|
333
|
+
```ruby
|
334
|
+
require 'time'
|
335
|
+
require 'conekta'
|
336
|
+
# setup authorization
|
337
|
+
Conekta.configure do |config|
|
338
|
+
# Configure Bearer authorization: bearerAuth
|
339
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
340
|
+
end
|
341
|
+
|
342
|
+
api_instance = Conekta::OrdersApi.new
|
343
|
+
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
344
|
+
refund_id = '6407b5bee1329a000175ba11' # String | refund identifier
|
345
|
+
opts = {
|
346
|
+
accept_language: 'es', # String | Use for knowing which language to use
|
347
|
+
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.
|
348
|
+
}
|
349
|
+
|
350
|
+
begin
|
351
|
+
# Cancel Refund
|
352
|
+
result = api_instance.order_cancel_refund(id, refund_id, opts)
|
353
|
+
p result
|
354
|
+
rescue Conekta::ApiError => e
|
355
|
+
puts "Error when calling OrdersApi->order_cancel_refund: #{e}"
|
356
|
+
end
|
357
|
+
```
|
358
|
+
|
359
|
+
#### Using the order_cancel_refund_with_http_info variant
|
360
|
+
|
361
|
+
This returns an Array which contains the response data, status code and headers.
|
362
|
+
|
363
|
+
> <Array(<OrderResponse>, Integer, Hash)> order_cancel_refund_with_http_info(id, refund_id, opts)
|
364
|
+
|
365
|
+
```ruby
|
366
|
+
begin
|
367
|
+
# Cancel Refund
|
368
|
+
data, status_code, headers = api_instance.order_cancel_refund_with_http_info(id, refund_id, opts)
|
369
|
+
p status_code # => 2xx
|
370
|
+
p headers # => { ... }
|
371
|
+
p data # => <OrderResponse>
|
372
|
+
rescue Conekta::ApiError => e
|
373
|
+
puts "Error when calling OrdersApi->order_cancel_refund_with_http_info: #{e}"
|
374
|
+
end
|
375
|
+
```
|
376
|
+
|
377
|
+
### Parameters
|
378
|
+
|
379
|
+
| Name | Type | Description | Notes |
|
380
|
+
| ---- | ---- | ----------- | ----- |
|
381
|
+
| **id** | **String** | Identifier of the resource | |
|
382
|
+
| **refund_id** | **String** | refund identifier | |
|
383
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
384
|
+
| **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] |
|
385
|
+
|
386
|
+
### Return type
|
387
|
+
|
388
|
+
[**OrderResponse**](OrderResponse.md)
|
389
|
+
|
390
|
+
### Authorization
|
391
|
+
|
392
|
+
[bearerAuth](../README.md#bearerAuth)
|
393
|
+
|
394
|
+
### HTTP request headers
|
395
|
+
|
396
|
+
- **Content-Type**: Not defined
|
397
|
+
- **Accept**: application/vnd.conekta-v2.1.0+json
|
398
|
+
|
399
|
+
|
400
|
+
## order_refund
|
401
|
+
|
402
|
+
> <OrderResponse> order_refund(id, order_refund_request, opts)
|
403
|
+
|
404
|
+
Refund Order
|
405
|
+
|
406
|
+
A refunded order describes the items, amount, and reason an order is being refunded.
|
407
|
+
|
408
|
+
### Examples
|
409
|
+
|
410
|
+
```ruby
|
411
|
+
require 'time'
|
412
|
+
require 'conekta'
|
413
|
+
# setup authorization
|
414
|
+
Conekta.configure do |config|
|
415
|
+
# Configure Bearer authorization: bearerAuth
|
416
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
417
|
+
end
|
418
|
+
|
419
|
+
api_instance = Conekta::OrdersApi.new
|
420
|
+
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
421
|
+
order_refund_request = Conekta::OrderRefundRequest.new({amount: 500, reason: 'suspected_fraud'}) # OrderRefundRequest | requested field for a refund
|
422
|
+
opts = {
|
423
|
+
accept_language: 'es', # String | Use for knowing which language to use
|
424
|
+
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.
|
425
|
+
}
|
426
|
+
|
427
|
+
begin
|
428
|
+
# Refund Order
|
429
|
+
result = api_instance.order_refund(id, order_refund_request, opts)
|
430
|
+
p result
|
431
|
+
rescue Conekta::ApiError => e
|
432
|
+
puts "Error when calling OrdersApi->order_refund: #{e}"
|
433
|
+
end
|
434
|
+
```
|
435
|
+
|
436
|
+
#### Using the order_refund_with_http_info variant
|
437
|
+
|
438
|
+
This returns an Array which contains the response data, status code and headers.
|
439
|
+
|
440
|
+
> <Array(<OrderResponse>, Integer, Hash)> order_refund_with_http_info(id, order_refund_request, opts)
|
441
|
+
|
442
|
+
```ruby
|
443
|
+
begin
|
444
|
+
# Refund Order
|
445
|
+
data, status_code, headers = api_instance.order_refund_with_http_info(id, order_refund_request, opts)
|
446
|
+
p status_code # => 2xx
|
447
|
+
p headers # => { ... }
|
448
|
+
p data # => <OrderResponse>
|
449
|
+
rescue Conekta::ApiError => e
|
450
|
+
puts "Error when calling OrdersApi->order_refund_with_http_info: #{e}"
|
451
|
+
end
|
452
|
+
```
|
453
|
+
|
454
|
+
### Parameters
|
455
|
+
|
456
|
+
| Name | Type | Description | Notes |
|
457
|
+
| ---- | ---- | ----------- | ----- |
|
458
|
+
| **id** | **String** | Identifier of the resource | |
|
459
|
+
| **order_refund_request** | [**OrderRefundRequest**](OrderRefundRequest.md) | requested field for a refund | |
|
460
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
461
|
+
| **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] |
|
462
|
+
|
463
|
+
### Return type
|
464
|
+
|
465
|
+
[**OrderResponse**](OrderResponse.md)
|
466
|
+
|
467
|
+
### Authorization
|
468
|
+
|
469
|
+
[bearerAuth](../README.md#bearerAuth)
|
470
|
+
|
471
|
+
### HTTP request headers
|
472
|
+
|
473
|
+
- **Content-Type**: application/json
|
474
|
+
- **Accept**: application/vnd.conekta-v2.1.0+json
|
475
|
+
|
476
|
+
|
477
|
+
## orders_create_capture
|
478
|
+
|
479
|
+
> <OrderResponse> orders_create_capture(id, opts)
|
480
|
+
|
481
|
+
Capture Order
|
482
|
+
|
483
|
+
Processes an order that has been previously authorized.
|
484
|
+
|
485
|
+
### Examples
|
486
|
+
|
487
|
+
```ruby
|
488
|
+
require 'time'
|
489
|
+
require 'conekta'
|
490
|
+
# setup authorization
|
491
|
+
Conekta.configure do |config|
|
492
|
+
# Configure Bearer authorization: bearerAuth
|
493
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
494
|
+
end
|
495
|
+
|
496
|
+
api_instance = Conekta::OrdersApi.new
|
497
|
+
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
498
|
+
opts = {
|
499
|
+
accept_language: 'es', # String | Use for knowing which language to use
|
500
|
+
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.
|
501
|
+
order_capture_request: Conekta::OrderCaptureRequest.new({amount: 500}) # OrderCaptureRequest | requested fields for capture order
|
502
|
+
}
|
503
|
+
|
504
|
+
begin
|
505
|
+
# Capture Order
|
506
|
+
result = api_instance.orders_create_capture(id, opts)
|
507
|
+
p result
|
508
|
+
rescue Conekta::ApiError => e
|
509
|
+
puts "Error when calling OrdersApi->orders_create_capture: #{e}"
|
510
|
+
end
|
511
|
+
```
|
512
|
+
|
513
|
+
#### Using the orders_create_capture_with_http_info variant
|
514
|
+
|
515
|
+
This returns an Array which contains the response data, status code and headers.
|
516
|
+
|
517
|
+
> <Array(<OrderResponse>, Integer, Hash)> orders_create_capture_with_http_info(id, opts)
|
518
|
+
|
519
|
+
```ruby
|
520
|
+
begin
|
521
|
+
# Capture Order
|
522
|
+
data, status_code, headers = api_instance.orders_create_capture_with_http_info(id, opts)
|
523
|
+
p status_code # => 2xx
|
524
|
+
p headers # => { ... }
|
525
|
+
p data # => <OrderResponse>
|
526
|
+
rescue Conekta::ApiError => e
|
527
|
+
puts "Error when calling OrdersApi->orders_create_capture_with_http_info: #{e}"
|
528
|
+
end
|
529
|
+
```
|
530
|
+
|
531
|
+
### Parameters
|
532
|
+
|
533
|
+
| Name | Type | Description | Notes |
|
534
|
+
| ---- | ---- | ----------- | ----- |
|
535
|
+
| **id** | **String** | Identifier of the resource | |
|
536
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
537
|
+
| **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] |
|
538
|
+
| **order_capture_request** | [**OrderCaptureRequest**](OrderCaptureRequest.md) | requested fields for capture order | [optional] |
|
539
|
+
|
540
|
+
### Return type
|
541
|
+
|
542
|
+
[**OrderResponse**](OrderResponse.md)
|
543
|
+
|
544
|
+
### Authorization
|
545
|
+
|
546
|
+
[bearerAuth](../README.md#bearerAuth)
|
547
|
+
|
548
|
+
### HTTP request headers
|
549
|
+
|
550
|
+
- **Content-Type**: application/json
|
551
|
+
- **Accept**: application/vnd.conekta-v2.1.0+json
|
552
|
+
|
553
|
+
|
554
|
+
## update_order
|
555
|
+
|
556
|
+
> <OrderResponse> update_order(id, order_update_request, opts)
|
557
|
+
|
558
|
+
Update Order
|
559
|
+
|
560
|
+
Update an existing Order.
|
561
|
+
|
562
|
+
### Examples
|
563
|
+
|
564
|
+
```ruby
|
565
|
+
require 'time'
|
566
|
+
require 'conekta'
|
567
|
+
# setup authorization
|
568
|
+
Conekta.configure do |config|
|
569
|
+
# Configure Bearer authorization: bearerAuth
|
570
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
571
|
+
end
|
572
|
+
|
573
|
+
api_instance = Conekta::OrdersApi.new
|
574
|
+
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
575
|
+
order_update_request = Conekta::OrderUpdateRequest.new # OrderUpdateRequest | requested field for an order
|
576
|
+
opts = {
|
577
|
+
accept_language: 'es' # String | Use for knowing which language to use
|
578
|
+
}
|
579
|
+
|
580
|
+
begin
|
581
|
+
# Update Order
|
582
|
+
result = api_instance.update_order(id, order_update_request, opts)
|
583
|
+
p result
|
584
|
+
rescue Conekta::ApiError => e
|
585
|
+
puts "Error when calling OrdersApi->update_order: #{e}"
|
586
|
+
end
|
587
|
+
```
|
588
|
+
|
589
|
+
#### Using the update_order_with_http_info variant
|
590
|
+
|
591
|
+
This returns an Array which contains the response data, status code and headers.
|
592
|
+
|
593
|
+
> <Array(<OrderResponse>, Integer, Hash)> update_order_with_http_info(id, order_update_request, opts)
|
594
|
+
|
595
|
+
```ruby
|
596
|
+
begin
|
597
|
+
# Update Order
|
598
|
+
data, status_code, headers = api_instance.update_order_with_http_info(id, order_update_request, opts)
|
599
|
+
p status_code # => 2xx
|
600
|
+
p headers # => { ... }
|
601
|
+
p data # => <OrderResponse>
|
602
|
+
rescue Conekta::ApiError => e
|
603
|
+
puts "Error when calling OrdersApi->update_order_with_http_info: #{e}"
|
604
|
+
end
|
605
|
+
```
|
606
|
+
|
607
|
+
### Parameters
|
608
|
+
|
609
|
+
| Name | Type | Description | Notes |
|
610
|
+
| ---- | ---- | ----------- | ----- |
|
611
|
+
| **id** | **String** | Identifier of the resource | |
|
612
|
+
| **order_update_request** | [**OrderUpdateRequest**](OrderUpdateRequest.md) | requested field for an order | |
|
613
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
614
|
+
|
615
|
+
### Return type
|
616
|
+
|
617
|
+
[**OrderResponse**](OrderResponse.md)
|
618
|
+
|
619
|
+
### Authorization
|
620
|
+
|
621
|
+
[bearerAuth](../README.md#bearerAuth)
|
622
|
+
|
623
|
+
### HTTP request headers
|
624
|
+
|
625
|
+
- **Content-Type**: application/json
|
626
|
+
- **Accept**: application/vnd.conekta-v2.1.0+json
|
627
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# Conekta::OrdersResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<OrderResponse>**](OrderResponse.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'conekta'
|
13
|
+
|
14
|
+
instance = Conekta::OrdersResponse.new(
|
15
|
+
data: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/Page.md
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
# Conekta::Page
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **next_page_url** | **String** | URL of the next page. | [optional] |
|
8
|
+
| **previous_page_url** | **String** | Url of the previous page. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'conekta'
|
14
|
+
|
15
|
+
instance = Conekta::Page.new(
|
16
|
+
next_page_url: https://api.conekta.io/resources?limit=10&next=chrg_1,
|
17
|
+
previous_page_url: https://api.conekta.io/resources?limit=10&previous=chrg_1
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/Pagination.md
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
# Conekta::Pagination
|
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
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'conekta'
|
14
|
+
|
15
|
+
instance = Conekta::Pagination.new(
|
16
|
+
has_more: false,
|
17
|
+
object: list
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|