├── .editorconfig ├── .gitattributes ├── .github ├── CODEOWNERS └── workflows │ ├── CI.yml │ └── PUBLISH.yml ├── .gitignore ├── .openapi-generator-ignore ├── .openapi-generator ├── FILES └── VERSION ├── .rspec ├── .rubocop.yml ├── AUTHORS.md ├── CHANGELOG.md ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── Gemfile ├── LICENSE ├── Makefile ├── README.md ├── Rakefile ├── VERSION ├── conekta.gemspec ├── conekta.png ├── config-ruby.json ├── docs ├── AntifraudApi.md ├── ApiKeyCreateResponse.md ├── ApiKeyRequest.md ├── ApiKeyResponse.md ├── ApiKeyResponseOnDelete.md ├── ApiKeyUpdateRequest.md ├── ApiKeysApi.md ├── BalanceCommonField.md ├── BalanceResponse.md ├── BalancesApi.md ├── BlacklistRuleResponse.md ├── ChargeOrderResponse.md ├── ChargeOrderResponsePaymentMethod.md ├── ChargeRequest.md ├── ChargeRequestPaymentMethod.md ├── ChargeResponse.md ├── ChargeResponseChannel.md ├── ChargeResponsePaymentMethod.md ├── ChargeResponseRefunds.md ├── ChargeResponseRefundsData.md ├── ChargeUpdateRequest.md ├── ChargesApi.md ├── ChargesDataResponse.md ├── ChargesOrderResponse.md ├── ChargesOrderResponseAllOfData.md ├── Checkout.md ├── CheckoutOrderTemplate.md ├── CheckoutOrderTemplateCustomerInfo.md ├── CheckoutRequest.md ├── CheckoutResponse.md ├── CheckoutsResponse.md ├── CompaniesApi.md ├── CompanyFiscalInfoAddressResponse.md ├── CompanyFiscalInfoResponse.md ├── CompanyPayoutDestinationResponse.md ├── CompanyResponse.md ├── CreateCustomerFiscalEntitiesResponse.md ├── CreateCustomerPaymentMethodsRequest.md ├── CreateCustomerPaymentMethodsResponse.md ├── CreateRiskRulesData.md ├── Customer.md ├── CustomerAddress.md ├── CustomerAntifraudInfo.md ├── CustomerAntifraudInfoResponse.md ├── CustomerFiscalEntitiesDataResponse.md ├── CustomerFiscalEntitiesRequest.md ├── CustomerFiscalEntitiesResponse.md ├── CustomerInfo.md ├── CustomerInfoJustCustomerId.md ├── CustomerInfoJustCustomerIdResponse.md ├── CustomerPaymentMethodRequest.md ├── CustomerPaymentMethodsData.md ├── CustomerPaymentMethodsRequest.md ├── CustomerPaymentMethodsResponse.md ├── CustomerResponse.md ├── CustomerResponseShippingContacts.md ├── CustomerShippingContacts.md ├── CustomerShippingContactsAddress.md ├── CustomerShippingContactsDataResponse.md ├── CustomerShippingContactsResponse.md ├── CustomerShippingContactsResponseAddress.md ├── CustomerUpdateFiscalEntitiesRequest.md ├── CustomerUpdateShippingContacts.md ├── CustomersApi.md ├── CustomersResponse.md ├── DeleteApiKeysResponse.md ├── DeletedBlacklistRuleResponse.md ├── DeletedWhitelistRuleResponse.md ├── Details.md ├── DetailsError.md ├── DiscountLinesDataResponse.md ├── DiscountLinesResponse.md ├── DiscountsApi.md ├── EmailCheckoutRequest.md ├── Error.md ├── EventResponse.md ├── EventTypes.md ├── EventsApi.md ├── EventsResendResponse.md ├── FiscalEntityAddress.md ├── GetApiKeysResponse.md ├── GetChargesResponse.md ├── GetCompaniesResponse.md ├── GetCustomerPaymentMethodDataResponse.md ├── GetEventsResponse.md ├── GetOrderDiscountLinesResponse.md ├── GetOrdersResponse.md ├── GetPaymentMethodResponse.md ├── GetPlansResponse.md ├── GetTransactionsResponse.md ├── GetTransfersResponse.md ├── GetWebhookKeysResponse.md ├── GetWebhooksResponse.md ├── LogResponse.md ├── LogsApi.md ├── LogsResponse.md ├── LogsResponseData.md ├── OrderCaptureRequest.md ├── OrderChannelResponse.md ├── OrderChargesResponse.md ├── OrderCustomerInfoResponse.md ├── OrderDiscountLinesRequest.md ├── OrderDiscountLinesResponse.md ├── OrderFiscalEntityAddressResponse.md ├── OrderFiscalEntityRequest.md ├── OrderFiscalEntityResponse.md ├── OrderNextActionResponse.md ├── OrderNextActionResponseRedirectToUrl.md ├── OrderRefundRequest.md ├── OrderRequest.md ├── OrderRequestCustomerInfo.md ├── OrderResponse.md ├── OrderResponseCheckout.md ├── OrderResponseCustomerInfo.md ├── OrderResponseProducts.md ├── OrderResponseShippingContact.md ├── OrderTaxRequest.md ├── OrderUpdateFiscalEntityRequest.md ├── OrderUpdateRequest.md ├── OrderUpdateRequestCustomerInfo.md ├── OrdersApi.md ├── OrdersResponse.md ├── Page.md ├── Pagination.md ├── PaymentLinkApi.md ├── PaymentMethod.md ├── PaymentMethodBankTransfer.md ├── PaymentMethodBnplPayment.md ├── PaymentMethodBnplRequest.md ├── PaymentMethodCard.md ├── PaymentMethodCardRequest.md ├── PaymentMethodCardResponse.md ├── PaymentMethodCash.md ├── PaymentMethodCashRequest.md ├── PaymentMethodCashResponse.md ├── PaymentMethodCashResponseAllOfAgreements.md ├── PaymentMethodGeneralRequest.md ├── PaymentMethodResponse.md ├── PaymentMethodSpeiRecurrent.md ├── PaymentMethodSpeiRequest.md ├── PaymentMethodTokenRequest.md ├── PaymentMethodsApi.md ├── Payout.md ├── PayoutMethod.md ├── PayoutOrder.md ├── PayoutOrderPayoutsItem.md ├── PayoutOrderResponse.md ├── PayoutOrderResponseCustomerInfo.md ├── PayoutOrdersApi.md ├── PayoutOrdersResponse.md ├── PlanRequest.md ├── PlanResponse.md ├── PlanUpdateRequest.md ├── PlansApi.md ├── Product.md ├── ProductDataResponse.md ├── ProductOrderResponse.md ├── ProductsApi.md ├── ResendRequest.md ├── RiskRulesData.md ├── RiskRulesList.md ├── ShippingContactsApi.md ├── ShippingOrderResponse.md ├── ShippingRequest.md ├── ShippingsApi.md ├── SmsCheckoutRequest.md ├── SubscriptionEventsResponse.md ├── SubscriptionRequest.md ├── SubscriptionResponse.md ├── SubscriptionUpdateRequest.md ├── SubscriptionsApi.md ├── TaxesApi.md ├── Token.md ├── TokenCard.md ├── TokenCheckout.md ├── TokenResponse.md ├── TokenResponseCheckout.md ├── TokensApi.md ├── TransactionResponse.md ├── TransactionsApi.md ├── TransferDestinationResponse.md ├── TransferMethodResponse.md ├── TransferResponse.md ├── TransfersApi.md ├── TransfersResponse.md ├── UpdateCustomer.md ├── UpdateCustomerAntifraudInfo.md ├── UpdateCustomerFiscalEntitiesResponse.md ├── UpdateCustomerPaymentMethodsResponse.md ├── UpdateOrderDiscountLinesRequest.md ├── UpdateOrderTaxRequest.md ├── UpdateOrderTaxResponse.md ├── UpdatePaymentMethods.md ├── UpdateProduct.md ├── WebhookKeyCreateResponse.md ├── WebhookKeyDeleteResponse.md ├── WebhookKeyRequest.md ├── WebhookKeyResponse.md ├── WebhookKeyUpdateRequest.md ├── WebhookKeysApi.md ├── WebhookLog.md ├── WebhookRequest.md ├── WebhookResponse.md ├── WebhookUpdateRequest.md ├── WebhooksApi.md └── WhitelistlistRuleResponse.md ├── lib ├── conekta.rb ├── conekta │ ├── api │ │ ├── antifraud_api.rb │ │ ├── api_keys_api.rb │ │ ├── balances_api.rb │ │ ├── charges_api.rb │ │ ├── companies_api.rb │ │ ├── customers_api.rb │ │ ├── discounts_api.rb │ │ ├── events_api.rb │ │ ├── logs_api.rb │ │ ├── orders_api.rb │ │ ├── payment_link_api.rb │ │ ├── payment_methods_api.rb │ │ ├── payout_orders_api.rb │ │ ├── plans_api.rb │ │ ├── products_api.rb │ │ ├── shipping_contacts_api.rb │ │ ├── shippings_api.rb │ │ ├── subscriptions_api.rb │ │ ├── taxes_api.rb │ │ ├── tokens_api.rb │ │ ├── transactions_api.rb │ │ ├── transfers_api.rb │ │ ├── webhook_keys_api.rb │ │ └── webhooks_api.rb │ ├── api_client.rb │ ├── api_error.rb │ ├── configuration.rb │ ├── models │ │ ├── api_key_create_response.rb │ │ ├── api_key_create_response_all_of.rb │ │ ├── api_key_request.rb │ │ ├── api_key_response.rb │ │ ├── api_key_response_on_delete.rb │ │ ├── api_key_update_request.rb │ │ ├── balance_common_field.rb │ │ ├── balance_response.rb │ │ ├── blacklist_rule_response.rb │ │ ├── charge_data_payment_method_bank_transfer_response.rb │ │ ├── charge_data_payment_method_card_response.rb │ │ ├── charge_data_payment_method_cash_response.rb │ │ ├── charge_order_response.rb │ │ ├── charge_order_response_payment_method.rb │ │ ├── charge_request.rb │ │ ├── charge_request_payment_method.rb │ │ ├── charge_response.rb │ │ ├── charge_response_channel.rb │ │ ├── charge_response_payment_method.rb │ │ ├── charge_response_refunds.rb │ │ ├── charge_response_refunds_all_of.rb │ │ ├── charge_response_refunds_data.rb │ │ ├── charge_update_request.rb │ │ ├── charges_data_response.rb │ │ ├── charges_order_response.rb │ │ ├── charges_order_response_all_of_data.rb │ │ ├── checkout.rb │ │ ├── checkout_order_template.rb │ │ ├── checkout_order_template_customer_info.rb │ │ ├── checkout_request.rb │ │ ├── checkout_response.rb │ │ ├── checkouts_response.rb │ │ ├── checkouts_response_all_of.rb │ │ ├── company_fiscal_info_address_response.rb │ │ ├── company_fiscal_info_response.rb │ │ ├── company_payout_destination_response.rb │ │ ├── company_response.rb │ │ ├── create_customer_fiscal_entities_response.rb │ │ ├── create_customer_fiscal_entities_response_all_of.rb │ │ ├── create_customer_payment_methods_request.rb │ │ ├── create_customer_payment_methods_response.rb │ │ ├── create_risk_rules_data.rb │ │ ├── customer.rb │ │ ├── customer_address.rb │ │ ├── customer_antifraud_info.rb │ │ ├── customer_antifraud_info_response.rb │ │ ├── customer_fiscal_entities_data_response.rb │ │ ├── customer_fiscal_entities_request.rb │ │ ├── customer_fiscal_entities_request_address.rb │ │ ├── customer_fiscal_entities_response.rb │ │ ├── customer_fiscal_entities_response_all_of.rb │ │ ├── customer_info.rb │ │ ├── customer_info_just_customer_id.rb │ │ ├── customer_info_just_customer_id_response.rb │ │ ├── customer_payment_method_request.rb │ │ ├── customer_payment_methods.rb │ │ ├── customer_payment_methods_data.rb │ │ ├── customer_payment_methods_request.rb │ │ ├── customer_payment_methods_response.rb │ │ ├── customer_response.rb │ │ ├── customer_response_shipping_contacts.rb │ │ ├── customer_response_shipping_contacts_all_of.rb │ │ ├── customer_shipping_contacts.rb │ │ ├── customer_shipping_contacts_address.rb │ │ ├── customer_shipping_contacts_data_response.rb │ │ ├── customer_shipping_contacts_data_response_all_of.rb │ │ ├── customer_shipping_contacts_response.rb │ │ ├── customer_shipping_contacts_response_address.rb │ │ ├── customer_update_fiscal_entities_request.rb │ │ ├── customer_update_shipping_contacts.rb │ │ ├── customers_response.rb │ │ ├── customers_response_all_of.rb │ │ ├── delete_api_keys_response.rb │ │ ├── delete_api_keys_response_all_of.rb │ │ ├── deleted_blacklist_rule_response.rb │ │ ├── deleted_whitelist_rule_response.rb │ │ ├── details.rb │ │ ├── details_error.rb │ │ ├── discount_lines_data_response.rb │ │ ├── discount_lines_response.rb │ │ ├── discount_lines_response_all_of.rb │ │ ├── email_checkout_request.rb │ │ ├── error.rb │ │ ├── error_all_of.rb │ │ ├── event_response.rb │ │ ├── event_types.rb │ │ ├── events_resend_response.rb │ │ ├── fiscal_entity_address.rb │ │ ├── get_api_keys_response.rb │ │ ├── get_api_keys_response_all_of.rb │ │ ├── get_charges_response.rb │ │ ├── get_charges_response_all_of.rb │ │ ├── get_companies_response.rb │ │ ├── get_companies_response_all_of.rb │ │ ├── get_customer_payment_method_data_response.rb │ │ ├── get_events_response.rb │ │ ├── get_events_response_all_of.rb │ │ ├── get_order_discount_lines_response.rb │ │ ├── get_order_discount_lines_response_all_of.rb │ │ ├── get_orders_response.rb │ │ ├── get_payment_method_response.rb │ │ ├── get_payment_method_response_all_of.rb │ │ ├── get_plans_response.rb │ │ ├── get_plans_response_all_of.rb │ │ ├── get_transactions_response.rb │ │ ├── get_transactions_response_all_of.rb │ │ ├── get_transfers_response.rb │ │ ├── get_transfers_response_all_of.rb │ │ ├── get_webhook_keys_response.rb │ │ ├── get_webhook_keys_response_all_of.rb │ │ ├── get_webhooks_response.rb │ │ ├── get_webhooks_response_all_of.rb │ │ ├── log_response.rb │ │ ├── logs_response.rb │ │ ├── logs_response_data.rb │ │ ├── order_capture_request.rb │ │ ├── order_channel_response.rb │ │ ├── order_charges_response.rb │ │ ├── order_customer_info_response.rb │ │ ├── order_discount_lines_request.rb │ │ ├── order_discount_lines_response.rb │ │ ├── order_fiscal_entity_address_response.rb │ │ ├── order_fiscal_entity_address_response_all_of.rb │ │ ├── order_fiscal_entity_request.rb │ │ ├── order_fiscal_entity_response.rb │ │ ├── order_next_action_response.rb │ │ ├── order_next_action_response_redirect_to_url.rb │ │ ├── order_refund_request.rb │ │ ├── order_request.rb │ │ ├── order_request_customer_info.rb │ │ ├── order_response.rb │ │ ├── order_response_charges.rb │ │ ├── order_response_charges_all_of.rb │ │ ├── order_response_checkout.rb │ │ ├── order_response_customer_info.rb │ │ ├── order_response_customer_info_all_of.rb │ │ ├── order_response_discount_lines.rb │ │ ├── order_response_discount_lines_all_of.rb │ │ ├── order_response_products.rb │ │ ├── order_response_products_all_of.rb │ │ ├── order_response_shipping_contact.rb │ │ ├── order_response_shipping_contact_all_of.rb │ │ ├── order_tax_request.rb │ │ ├── order_update_fiscal_entity_request.rb │ │ ├── order_update_request.rb │ │ ├── order_update_request_customer_info.rb │ │ ├── orders_response.rb │ │ ├── page.rb │ │ ├── pagination.rb │ │ ├── payment_method.rb │ │ ├── payment_method_bank_transfer.rb │ │ ├── payment_method_bnpl_payment.rb │ │ ├── payment_method_bnpl_request.rb │ │ ├── payment_method_card.rb │ │ ├── payment_method_card_request.rb │ │ ├── payment_method_card_request_all_of.rb │ │ ├── payment_method_card_response.rb │ │ ├── payment_method_card_response_all_of.rb │ │ ├── payment_method_cash.rb │ │ ├── payment_method_cash_request.rb │ │ ├── payment_method_cash_request_all_of.rb │ │ ├── payment_method_cash_response.rb │ │ ├── payment_method_cash_response_all_of.rb │ │ ├── payment_method_cash_response_all_of_agreements.rb │ │ ├── payment_method_general_request.rb │ │ ├── payment_method_response.rb │ │ ├── payment_method_spei_recurrent.rb │ │ ├── payment_method_spei_recurrent_all_of.rb │ │ ├── payment_method_spei_request.rb │ │ ├── payment_method_token_request.rb │ │ ├── payout.rb │ │ ├── payout_method.rb │ │ ├── payout_order.rb │ │ ├── payout_order_payouts_item.rb │ │ ├── payout_order_response.rb │ │ ├── payout_order_response_customer_info.rb │ │ ├── payout_orders_response.rb │ │ ├── plan_request.rb │ │ ├── plan_response.rb │ │ ├── plan_update_request.rb │ │ ├── product.rb │ │ ├── product_data_response.rb │ │ ├── product_data_response_all_of.rb │ │ ├── product_order_response.rb │ │ ├── product_order_response_all_of.rb │ │ ├── resend_request.rb │ │ ├── risk_rules.rb │ │ ├── risk_rules_data.rb │ │ ├── risk_rules_list.rb │ │ ├── shipping_order_response.rb │ │ ├── shipping_request.rb │ │ ├── sms_checkout_request.rb │ │ ├── subscription_events_response.rb │ │ ├── subscription_request.rb │ │ ├── subscription_response.rb │ │ ├── subscription_update_request.rb │ │ ├── token.rb │ │ ├── token_card.rb │ │ ├── token_checkout.rb │ │ ├── token_response.rb │ │ ├── token_response_checkout.rb │ │ ├── transaction_response.rb │ │ ├── transfer_destination_response.rb │ │ ├── transfer_method_response.rb │ │ ├── transfer_response.rb │ │ ├── transfers_response.rb │ │ ├── update_customer.rb │ │ ├── update_customer_antifraud_info.rb │ │ ├── update_customer_fiscal_entities_response.rb │ │ ├── update_customer_fiscal_entities_response_all_of.rb │ │ ├── update_customer_payment_methods_response.rb │ │ ├── update_order_discount_lines_request.rb │ │ ├── update_order_tax_request.rb │ │ ├── update_order_tax_response.rb │ │ ├── update_order_tax_response_all_of.rb │ │ ├── update_payment_methods.rb │ │ ├── update_product.rb │ │ ├── webhook_key_create_response.rb │ │ ├── webhook_key_delete_response.rb │ │ ├── webhook_key_request.rb │ │ ├── webhook_key_response.rb │ │ ├── webhook_key_update_request.rb │ │ ├── webhook_log.rb │ │ ├── webhook_request.rb │ │ ├── webhook_response.rb │ │ ├── webhook_update_request.rb │ │ └── whitelistlist_rule_response.rb │ └── version.rb └── ssl_data │ └── ca_bundle.crt ├── spec ├── api │ ├── antifraud_api_spec.rb │ ├── api_keys_api_spec.rb │ ├── balances_api_spec.rb │ ├── charges_api_spec.rb │ ├── companies_api_spec.rb │ ├── customers_api_spec.rb │ ├── discounts_api_spec.rb │ ├── events_api_spec.rb │ ├── logs_api_spec.rb │ ├── orders_api_spec.rb │ ├── payment_link_api_spec.rb │ ├── payment_methods_api_spec.rb │ ├── payout_orders_api_spec.rb │ ├── plans_api_spec.rb │ ├── products_api_spec.rb │ ├── shipping_contacts_api_spec.rb │ ├── shippings_api_spec.rb │ ├── subscriptions_api_spec.rb │ ├── taxes_api_spec.rb │ ├── tokens_api_spec.rb │ ├── transactions_api_spec.rb │ ├── transfers_api_spec.rb │ ├── webhook_keys_api_spec.rb │ └── webhooks_api_spec.rb ├── api_client_spec.rb ├── configuration_spec.rb └── spec_helper.rb ├── ssl_data └── ca_bundle.crt └── templates └── ruby ├── CUSTOM_VERSION.mustache ├── api_client.mustache └── configuration.mustache /.editorconfig: -------------------------------------------------------------------------------- 1 | # see http://editorconfig.org/ 2 | 3 | root = true 4 | 5 | [*] 6 | indent_style = space 7 | indent_size = 2 8 | end_of_line = lf 9 | charset = utf-8 10 | insert_final_newline = true 11 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # may be useful in hiding large schema changes in pull request diffs (but not 2 | # using it for now) 3 | spec/*.json binary 4 | spec/*.yaml binary 5 | -------------------------------------------------------------------------------- /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @fcarrero @macuartin @agatto-conekta @boolean @ezerozen @EricDominguez1 @nicocedron 2 | -------------------------------------------------------------------------------- /.github/workflows/CI.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | workflow_dispatch: {} 4 | pull_request: 5 | branches: 6 | - master 7 | 8 | jobs: 9 | build-and-test: 10 | name: Build and Test (Ruby ${{ matrix.ruby-version }}) 11 | runs-on: ubuntu-latest 12 | strategy: 13 | matrix: 14 | ruby-version: [2.6, 2.7, 3.0, 3.1, 3.2, 3.3] 15 | steps: 16 | - uses: actions/checkout@v3 17 | 18 | - name: Set up Ruby 19 | uses: ruby/setup-ruby@v1 20 | with: 21 | ruby-version: ${{ matrix.ruby-version }} 22 | 23 | - name: Bundle Install 24 | run: bundle install 25 | 26 | - name: Run Mockoon CLI 27 | uses: mockoon/cli-action@v2 28 | with: 29 | version: 'latest' 30 | data-file: 'https://raw.githubusercontent.com/conekta/openapi/main/mocks/conekta_api.json' 31 | port: 3000 32 | 33 | - name: Test 34 | run: make ci-test 35 | env: 36 | BASE_PATH: http://localhost:3000 37 | - name: Build 38 | run: gem build conekta.gemspec 39 | -------------------------------------------------------------------------------- /.github/workflows/PUBLISH.yml: -------------------------------------------------------------------------------- 1 | name: PUBLISH 2 | on: 3 | release: 4 | types: [created] 5 | 6 | jobs: 7 | publish: 8 | name: Publish 9 | runs-on: ubuntu-latest 10 | steps: 11 | - uses: actions/checkout@v3 12 | - name: Check if release creator is a code owner 13 | run: | 14 | if [[ $(jq '.sender.type' $GITHUB_EVENT_PATH) == '"User"' ]]; then 15 | creator_login=${{ github.event.release.author.login }} 16 | if ! grep -q $creator_login .github/CODEOWNERS; then 17 | echo "Release creator is not a code owner, skipping the rest of the workflow." 18 | exit 1 19 | fi 20 | fi 21 | - name: Validate release version 22 | run: | 23 | tag_name=${{ github.event.release.tag_name }} 24 | version=$(cat VERSION) 25 | if [ $tag_name != $version ]; then 26 | echo "Release tag_name is not the same that in file VERSION" 27 | exit 1 28 | fi 29 | - name: Set up Ruby 30 | uses: ruby/setup-ruby@v1 31 | with: 32 | ruby-version: 3.1 33 | - name: Publish to RubyGems 34 | run: | 35 | mkdir -p $HOME/.gem 36 | touch $HOME/.gem/credentials 37 | chmod 0600 $HOME/.gem/credentials 38 | printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials 39 | gem build *.gemspec 40 | gem push *.gem 41 | env: 42 | GEM_HOST_API_KEY: "${{secrets.GEM_HOST_API_KEY}}" 43 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Generated by: https://openapi-generator.tech 2 | # 3 | 4 | *.gem 5 | *.rbc 6 | /.config 7 | /coverage/ 8 | /InstalledFiles 9 | /pkg/ 10 | /spec/reports/ 11 | /spec/examples.txt 12 | /test/tmp/ 13 | /test/version_tmp/ 14 | /tmp/ 15 | 16 | ## Specific to RubyMotion: 17 | .dat* 18 | .repl_history 19 | build/ 20 | 21 | ## Documentation cache and generated files: 22 | /.yardoc/ 23 | /_yardoc/ 24 | /doc/ 25 | /rdoc/ 26 | 27 | ## Environment normalization: 28 | /.bundle/ 29 | /vendor/bundle 30 | /lib/bundler/man/ 31 | 32 | # for a library or gem, you might want to ignore these files since the code is 33 | # intended to run in multiple environments; otherwise, check them in: 34 | Gemfile.lock 35 | # .ruby-version 36 | # .ruby-gemset 37 | 38 | # unless supporting rvm < 1.11.0 or doing something fancy, ignore this: 39 | .rvmrc 40 | 41 | /conekta-*.gem 42 | /Gemfile.lock 43 | tags 44 | coverage/ 45 | .idea/ 46 | -------------------------------------------------------------------------------- /.openapi-generator-ignore: -------------------------------------------------------------------------------- 1 | # OpenAPI Generator Ignore 2 | # Generated by openapi-generator https://github.com/openapitools/openapi-generator 3 | 4 | # Use this file to prevent files from being overwritten by the generator. 5 | # The patterns follow closely to .gitignore or .dockerignore. 6 | 7 | # As an example, the C# client generator defines ApiClient.cs. 8 | # You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: 9 | #ApiClient.cs 10 | 11 | # You can match any string of characters against a directory, file or extension with a single asterisk (*): 12 | #foo/*/qux 13 | # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux 14 | 15 | # You can recursively match patterns against a directory, file or extension with a double asterisk (**): 16 | #foo/**/qux 17 | # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux 18 | 19 | # You can also negate patterns with an exclamation (!). 20 | # For example, you can ignore all files in a docs folder with the file extension .md: 21 | #docs/*.md 22 | # Then explicitly reverse the ignore rule for a single file: 23 | #!docs/README.md 24 | 25 | git_push.sh 26 | .gitignore 27 | .travis.yml 28 | .gitlab-ci.yml 29 | -------------------------------------------------------------------------------- /.openapi-generator/VERSION: -------------------------------------------------------------------------------- 1 | 7.5.0 2 | -------------------------------------------------------------------------------- /.rspec: -------------------------------------------------------------------------------- 1 | --color 2 | --require spec_helper 3 | -------------------------------------------------------------------------------- /AUTHORS.md: -------------------------------------------------------------------------------- 1 | title: Authors 2 | 3 | Primary Authors 4 | =============== 5 | 6 | * __[Franklin Carrero](https://github.com/fcarrero)__ 7 | 8 | @fcarrero is the current maintainer of the code and has written much of the 9 | current code base, including a complete refactor of the core for version 2.0. 10 | He started out by authoring many of the available extensions and later was 11 | asked to join Yuri, where he began fixing numerous bugs, adding 12 | documentation and making general improvements to the existing code base. 13 | 14 | * __[Jorge Alberto Alonso](https://github.com/jalonsoDevConekta)__ 15 | 16 | @jalonsoDevConekta is the current maintainer of the code and has written much of the 17 | current code base, including a complete refactor of the core for version 2.0. 18 | He started out by authoring many of the available extensions and later was 19 | asked to join Yuri, where he began fixing numerous bugs, adding 20 | documentation and making general improvements to the existing code base. 21 | 22 | * __[Ezequiel Rozen](https://github.com/ezerozen)__ 23 | 24 | @ezerozen is the current maintainer of the code and has written much of the 25 | current code base, including a complete refactor of the core for version 2.0. 26 | He started out by authoring many of the available extensions and later was 27 | asked to join Yuri, where he began fixing numerous bugs, adding 28 | documentation and making general improvements to the existing code base. 29 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contribution guidelines 2 | 3 | ## How to contribute step-by-step 4 | 5 | 1. Fork the `conekta/#$repo repository. 6 | 2. Create a new branch from `main` in your fork. This makes it easier for you to keep track of your changes. 7 | 3. Make the desired changes to the code. 8 | * If you are adding new functionality or fixing a bug, we recommend you add unit tests that cover it. 9 | 4. Push the changes to your fork. 10 | 5. Create a pull request to the `conekta/#$repo` repository. 11 | 6. In your pull request, please describe in detail: 12 | * What problem you’re solving 13 | * Your approach to fixing the problem 14 | * Any tests you wrote 15 | 7. Check Allow edits from maintainers. 16 | 8. Create the pull request. 17 | 9. Ensure that all checks have passed. 18 | 19 | After you create your pull request, one of the code owners will review your code. We aim to review your request within 2-3 business days. 20 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | 3 | gemspec 4 | 5 | group :development, :test do 6 | gem 'rake', '~> 13.0.1' 7 | gem 'pry-byebug' 8 | gem 'rubocop', '~> 0.66.0' 9 | end 10 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2014 - Conekta, Inc. (https://www.conekta.io) 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining 6 | a copy of this software and associated documentation files (the 7 | "Software"), to deal in the Software without restriction, including 8 | without limitation the rights to use, copy, modify, merge, publish, 9 | distribute, sublicense, and/or sell copies of the Software, and to 10 | permit persons to whom the Software is furnished to do so, subject to 11 | the following conditions: 12 | 13 | The above copyright notice and this permission notice shall be 14 | included in all copies or substantial portions of the Software. 15 | 16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 17 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 18 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 19 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 20 | LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 21 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 22 | WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | ci-test: 2 | bundle exec rspec 3 | ruby: 4 | rm -rf docs && rm -rf lib/models && rm -rf spec/api && \ 5 | docker run --rm \ 6 | -v ${PWD}:/local openapitools/openapi-generator-cli:v7.5.0 generate \ 7 | -i https://raw.githubusercontent.com/conekta/openapi/main/_build/api.yaml \ 8 | -g ruby \ 9 | -o /local \ 10 | -c /local/config-ruby.json \ 11 | --global-property modelTests=false,apiTests=true 12 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | require "bundler/gem_tasks" 2 | 3 | begin 4 | require 'rspec/core/rake_task' 5 | 6 | RSpec::Core::RakeTask.new(:spec) 7 | task default: :spec 8 | rescue LoadError 9 | # no rspec available 10 | end 11 | -------------------------------------------------------------------------------- /VERSION: -------------------------------------------------------------------------------- 1 | 7.0.1 2 | -------------------------------------------------------------------------------- /conekta.gemspec: -------------------------------------------------------------------------------- 1 | # -*- encoding: utf-8 -*- 2 | 3 | =begin 4 | #Conekta API 5 | 6 | #Conekta sdk 7 | 8 | The version of the OpenAPI document: 2.2.0 9 | Contact: engineering@conekta.com 10 | Generated by: https://openapi-generator.tech 11 | Generator version: 7.5.0 12 | 13 | =end 14 | 15 | $:.push File.expand_path("../lib", __FILE__) 16 | require "conekta/version" 17 | 18 | Gem::Specification.new do |s| 19 | s.name = "conekta" 20 | s.version = Conekta::VERSION 21 | s.platform = Gem::Platform::RUBY 22 | s.authors = ["Conekta"] 23 | s.email = ["core@conekta.com"] 24 | s.homepage = "https://www.conekta.com" 25 | s.summary = "This library provides https://api.conekta.io operations" 26 | s.description = "Ruby library for https://api.conekta.io" 27 | s.license = "MIT" 28 | s.required_ruby_version = ">= 2.6" 29 | s.metadata = {} 30 | 31 | s.add_runtime_dependency 'faraday', '>= 1.0.1', '< 3.0' 32 | s.add_runtime_dependency 'faraday-multipart' 33 | s.add_runtime_dependency 'marcel' 34 | 35 | s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0' 36 | 37 | s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? } 38 | s.test_files = `find spec/*`.split("\n") 39 | s.executables = [] 40 | s.require_paths = ["lib"] 41 | end 42 | -------------------------------------------------------------------------------- /conekta.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/conekta/conekta-ruby/a263e15ec278247e16c19161cf0d863bc1231b32/conekta.png -------------------------------------------------------------------------------- /config-ruby.json: -------------------------------------------------------------------------------- 1 | { 2 | "gemAuthorEmail" : "core@conekta.com", 3 | "gemAuthor": "Conekta", 4 | "gemName" : "conekta", 5 | "gemLicense": "MIT", 6 | "gemVersion": "7.0.1", 7 | "hideGenerationTimestamp": false, 8 | "moduleName": "Conekta", 9 | "gemSummary" : "This library provides https://api.conekta.io operations", 10 | "gemHomepage" : "https://www.conekta.com", 11 | "gemDescription" : "Ruby library for https://api.conekta.io", 12 | "library": "faraday", 13 | "httpUserAgent": "Conekta/v2 RubyBindings/#{Conekta::VERSION}", 14 | "gemRequiredRubyVersion" : ">= 2.6", 15 | "templateDir": "local/templates/ruby", 16 | "gitUserId" : "conekta", 17 | "gitRepoId" : "conekta-ruby", 18 | "files": { 19 | "/local/CODE_OF_CONDUCT.md": {}, 20 | "/local/AUTHORS.md": {}, 21 | "/local/CONTRIBUTING.md": {}, 22 | "/local/LICENSE": {}, 23 | "/local/conekta.png": {}, 24 | "/local/ssl_data/ca_bundle.crt": { 25 | "destinationFilename": "lib/ssl_data/ca_bundle.crt" 26 | }, 27 | "CUSTOM_VERSION.mustache": { 28 | "templateType": "SupportingFiles", 29 | "destinationFilename": "VERSION" 30 | } 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /docs/ApiKeyCreateResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::ApiKeyCreateResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **active** | **Boolean** | Indicates if the api key is active | [optional] | 8 | | **created_at** | **Integer** | Unix timestamp in seconds of when the api key was created | [optional] | 9 | | **updated_at** | **Integer** | Unix timestamp in seconds of when the api key was last updated | [optional] | 10 | | **deactivated_at** | **Integer** | Unix timestamp in seconds of when the api key was deleted | [optional] | 11 | | **last_used_at** | **Integer** | Unix timestamp in seconds with the api key was used | [optional] | 12 | | **description** | **String** | A name or brief explanation of what this api key is used for | [optional] | 13 | | **id** | **String** | Unique identifier of the api key | [optional] | 14 | | **livemode** | **Boolean** | Indicates if the api key is in production | [optional] | 15 | | **object** | **String** | Object name, value is 'api_key' | [optional] | 16 | | **prefix** | **String** | The first few characters of the authentication_token | [optional] | 17 | | **role** | **String** | Indicates if the api key is private or public | [optional] | 18 | | **authentication_token** | **String** | It is occupied as a user when authenticated with basic authentication, with a blank password. This value will only appear once, in the request to create a new key. Copy and save it in a safe place. | [optional] | 19 | 20 | ## Example 21 | 22 | ```ruby 23 | require 'conekta' 24 | 25 | instance = Conekta::ApiKeyCreateResponse.new( 26 | active: true, 27 | created_at: 1684167881, 28 | updated_at: 1684167923, 29 | deactivated_at: null, 30 | last_used_at: null, 31 | description: online store, 32 | id: 64625cc9f3e02c00163f5e4d, 33 | livemode: false, 34 | object: api_key, 35 | prefix: key_rp, 36 | role: private, 37 | authentication_token: key_rpHzxufNgjFCdprEEFZRTKi 38 | ) 39 | ``` 40 | 41 | -------------------------------------------------------------------------------- /docs/ApiKeyRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::ApiKeyRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **description** | **String** | A name or brief explanation of what this api key is used for | [optional] | 8 | | **role** | **String** | | | 9 | 10 | ## Example 11 | 12 | ```ruby 13 | require 'conekta' 14 | 15 | instance = Conekta::ApiKeyRequest.new( 16 | description: online store, 17 | role: private 18 | ) 19 | ``` 20 | 21 | -------------------------------------------------------------------------------- /docs/ApiKeyResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::ApiKeyResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **active** | **Boolean** | Indicates if the api key is active | [optional] | 8 | | **created_at** | **Integer** | Unix timestamp in seconds of when the api key was created | [optional] | 9 | | **updated_at** | **Integer** | Unix timestamp in seconds of when the api key was last updated | [optional] | 10 | | **deactivated_at** | **Integer** | Unix timestamp in seconds of when the api key was deleted | [optional] | 11 | | **last_used_at** | **Integer** | Unix timestamp in seconds with the api key was used | [optional] | 12 | | **description** | **String** | A name or brief explanation of what this api key is used for | [optional] | 13 | | **id** | **String** | Unique identifier of the api key | [optional] | 14 | | **livemode** | **Boolean** | Indicates if the api key is in production | [optional] | 15 | | **object** | **String** | Object name, value is 'api_key' | [optional] | 16 | | **prefix** | **String** | The first few characters of the authentication_token | [optional] | 17 | | **role** | **String** | Indicates if the api key is private or public | [optional] | 18 | 19 | ## Example 20 | 21 | ```ruby 22 | require 'conekta' 23 | 24 | instance = Conekta::ApiKeyResponse.new( 25 | active: true, 26 | created_at: 1684167881, 27 | updated_at: 1684167923, 28 | deactivated_at: null, 29 | last_used_at: null, 30 | description: online store, 31 | id: 64625cc9f3e02c00163f5e4d, 32 | livemode: false, 33 | object: api_key, 34 | prefix: key_rp, 35 | role: private 36 | ) 37 | ``` 38 | 39 | -------------------------------------------------------------------------------- /docs/ApiKeyResponseOnDelete.md: -------------------------------------------------------------------------------- 1 | # Conekta::ApiKeyResponseOnDelete 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **active** | **Boolean** | Indicates if the api key is active | [optional] | 8 | | **created_at** | **Integer** | Unix timestamp in seconds of when the api key was created | [optional] | 9 | | **description** | **String** | A name or brief explanation of what this api key is used for | [optional] | 10 | | **livemode** | **Boolean** | Indicates if the api key is in production | [optional] | 11 | | **prefix** | **String** | The first few characters of the authentication_token | [optional] | 12 | | **id** | **String** | Unique identifier of the api key | [optional] | 13 | | **object** | **String** | Object name, value is 'api_key' | [optional] | 14 | | **last_used_at** | **Integer** | Unix timestamp in seconds with the api key was used | [optional] | 15 | | **role** | **String** | Indicates if the api key is private or public | [optional] | 16 | 17 | ## Example 18 | 19 | ```ruby 20 | require 'conekta' 21 | 22 | instance = Conekta::ApiKeyResponseOnDelete.new( 23 | active: true, 24 | created_at: 1684167881, 25 | description: online store, 26 | livemode: false, 27 | prefix: key_rp, 28 | id: 64625cc9f3e02c00163f5e4d, 29 | object: api_key, 30 | last_used_at: null, 31 | role: private 32 | ) 33 | ``` 34 | 35 | -------------------------------------------------------------------------------- /docs/ApiKeyUpdateRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::ApiKeyUpdateRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **active** | **Boolean** | Indicates if the webhook key is active | [optional] | 8 | | **description** | **String** | A name or brief explanation of what this api key is used for | [optional] | 9 | 10 | ## Example 11 | 12 | ```ruby 13 | require 'conekta' 14 | 15 | instance = Conekta::ApiKeyUpdateRequest.new( 16 | active: true, 17 | description: online store 18 | ) 19 | ``` 20 | 21 | -------------------------------------------------------------------------------- /docs/BalanceCommonField.md: -------------------------------------------------------------------------------- 1 | # Conekta::BalanceCommonField 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **amount** | **Integer** | The balance's amount | [optional] | 8 | | **currency** | **String** | The balance's currency | [optional] | 9 | 10 | ## Example 11 | 12 | ```ruby 13 | require 'conekta' 14 | 15 | instance = Conekta::BalanceCommonField.new( 16 | amount: 100, 17 | currency: MXN 18 | ) 19 | ``` 20 | 21 | -------------------------------------------------------------------------------- /docs/BalanceResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::BalanceResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **available** | [**Array<BalanceCommonField>**](BalanceCommonField.md) | The balance's available | [optional] | 8 | | **cashout_retention_amount** | [**Array<BalanceCommonField>**](BalanceCommonField.md) | The balance's cashout retention amount | [optional] | 9 | | **conekta_retention** | [**Array<BalanceCommonField>**](BalanceCommonField.md) | The balance's conekta retention | [optional] | 10 | | **gateway** | [**Array<BalanceCommonField>**](BalanceCommonField.md) | The balance's gateway | [optional] | 11 | | **pending** | [**Array<BalanceCommonField>**](BalanceCommonField.md) | The balance's pending | [optional] | 12 | | **retained** | [**Array<BalanceCommonField>**](BalanceCommonField.md) | The balance's retained | [optional] | 13 | | **retention_amount** | [**Array<BalanceCommonField>**](BalanceCommonField.md) | The balance's retention amount | [optional] | 14 | | **target_collateral_amount** | **Object** | The balance's target collateral amount | [optional] | 15 | | **target_retention_amount** | [**Array<BalanceCommonField>**](BalanceCommonField.md) | The balance's target retention amount | [optional] | 16 | | **temporarily_retained** | [**Array<BalanceCommonField>**](BalanceCommonField.md) | The balance's temporarily retained | [optional] | 17 | 18 | ## Example 19 | 20 | ```ruby 21 | require 'conekta' 22 | 23 | instance = Conekta::BalanceResponse.new( 24 | available: null, 25 | cashout_retention_amount: null, 26 | conekta_retention: null, 27 | gateway: null, 28 | pending: null, 29 | retained: null, 30 | retention_amount: null, 31 | target_collateral_amount: null, 32 | target_retention_amount: null, 33 | temporarily_retained: null 34 | ) 35 | ``` 36 | 37 | -------------------------------------------------------------------------------- /docs/BalancesApi.md: -------------------------------------------------------------------------------- 1 | # Conekta::BalancesApi 2 | 3 | All URIs are relative to *https://api.conekta.io* 4 | 5 | | Method | HTTP request | Description | 6 | | ------ | ------------ | ----------- | 7 | | [**get_balance**](BalancesApi.md#get_balance) | **GET** /balance | Get a company's balance | 8 | 9 | 10 | ## get_balance 11 | 12 | > get_balance(opts) 13 | 14 | Get a company's balance 15 | 16 | Get a company's balance 17 | 18 | ### Examples 19 | 20 | ```ruby 21 | require 'time' 22 | require 'conekta' 23 | # setup authorization 24 | Conekta.configure do |config| 25 | # Configure Bearer authorization: bearerAuth 26 | config.access_token = 'YOUR_BEARER_TOKEN' 27 | end 28 | 29 | api_instance = Conekta::BalancesApi.new 30 | opts = { 31 | accept_language: 'es' # String | Use for knowing which language to use 32 | } 33 | 34 | begin 35 | # Get a company's balance 36 | result = api_instance.get_balance(opts) 37 | p result 38 | rescue Conekta::ApiError => e 39 | puts "Error when calling BalancesApi->get_balance: #{e}" 40 | end 41 | ``` 42 | 43 | #### Using the get_balance_with_http_info variant 44 | 45 | This returns an Array which contains the response data, status code and headers. 46 | 47 | > , Integer, Hash)> get_balance_with_http_info(opts) 48 | 49 | ```ruby 50 | begin 51 | # Get a company's balance 52 | data, status_code, headers = api_instance.get_balance_with_http_info(opts) 53 | p status_code # => 2xx 54 | p headers # => { ... } 55 | p data # => 56 | rescue Conekta::ApiError => e 57 | puts "Error when calling BalancesApi->get_balance_with_http_info: #{e}" 58 | end 59 | ``` 60 | 61 | ### Parameters 62 | 63 | | Name | Type | Description | Notes | 64 | | ---- | ---- | ----------- | ----- | 65 | | **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] | 66 | 67 | ### Return type 68 | 69 | [**BalanceResponse**](BalanceResponse.md) 70 | 71 | ### Authorization 72 | 73 | [bearerAuth](../README.md#bearerAuth) 74 | 75 | ### HTTP request headers 76 | 77 | - **Content-Type**: Not defined 78 | - **Accept**: application/vnd.conekta-v2.2.0+json 79 | 80 | -------------------------------------------------------------------------------- /docs/BlacklistRuleResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::BlacklistRuleResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **id** | **String** | Blacklist rule id | [optional] | 8 | | **field** | **String** | field used for blacklists rule | [optional] | 9 | | **value** | **String** | value used for blacklists rule | [optional] | 10 | | **description** | **String** | use an description for blacklisted rule | [optional] | 11 | 12 | ## Example 13 | 14 | ```ruby 15 | require 'conekta' 16 | 17 | instance = Conekta::BlacklistRuleResponse.new( 18 | id: 2fw8EWJusiRrxdPzT, 19 | field: email, 20 | value: email@example.com, 21 | description: secure customer example@example.com 22 | ) 23 | ``` 24 | 25 | -------------------------------------------------------------------------------- /docs/ChargeOrderResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::ChargeOrderResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **amount** | **Integer** | | [optional] | 8 | | **channel** | [**ChargeResponseChannel**](ChargeResponseChannel.md) | | [optional] | 9 | | **created_at** | **Integer** | | [optional] | 10 | | **currency** | **String** | | [optional] | 11 | | **customer_id** | **String** | | [optional] | 12 | | **description** | **String** | | [optional] | 13 | | **device_fingerprint** | **String** | | [optional] | 14 | | **failure_code** | **String** | | [optional] | 15 | | **failure_message** | **String** | | [optional] | 16 | | **id** | **String** | | [optional] | 17 | | **livemode** | **Boolean** | | [optional] | 18 | | **monthly_installments** | **Integer** | | [optional] | 19 | | **object** | **String** | | [optional] | 20 | | **order_id** | **String** | | [optional] | 21 | | **paid_at** | **Integer** | | [optional] | 22 | | **payment_method** | [**ChargeOrderResponsePaymentMethod**](ChargeOrderResponsePaymentMethod.md) | | [optional] | 23 | | **reference_id** | **String** | Reference ID of the charge | [optional] | 24 | | **refunds** | **Array<Object>** | | [optional] | 25 | | **status** | **String** | | [optional] | 26 | 27 | ## Example 28 | 29 | ```ruby 30 | require 'conekta' 31 | 32 | instance = Conekta::ChargeOrderResponse.new( 33 | amount: 4321, 34 | channel: null, 35 | created_at: 1676386026, 36 | currency: MXN, 37 | customer_id: null, 38 | description: Payment from order, 39 | device_fingerprint: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba, 40 | failure_code: suspected_fraud, 41 | failure_message: Este cargo ha sido declinado porque el comportamiento del comprador es sospechoso., 42 | id: 63efa757cf65380001aec040, 43 | livemode: true, 44 | monthly_installments: null, 45 | object: null, 46 | order_id: ord_2tN73UdUSNrYRPD9r, 47 | paid_at: 1676390742, 48 | payment_method: null, 49 | reference_id: ref_2tN73UdUSNrYRPD9r, 50 | refunds: null, 51 | status: pending_payment 52 | ) 53 | ``` 54 | 55 | -------------------------------------------------------------------------------- /docs/ChargeOrderResponsePaymentMethod.md: -------------------------------------------------------------------------------- 1 | # Conekta::ChargeOrderResponsePaymentMethod 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 'conekta' 13 | 14 | Conekta::ChargeOrderResponsePaymentMethod.openapi_one_of 15 | # => 16 | # [ 17 | # :'PaymentMethodBankTransfer', 18 | # :'PaymentMethodBnplPayment', 19 | # :'PaymentMethodCard', 20 | # :'PaymentMethodCash' 21 | # ] 22 | ``` 23 | 24 | ### `openapi_discriminator_name` 25 | 26 | Returns the discriminator's property name. 27 | 28 | #### Example 29 | 30 | ```ruby 31 | require 'conekta' 32 | 33 | Conekta::ChargeOrderResponsePaymentMethod.openapi_discriminator_name 34 | # => :'object' 35 | ``` 36 | 37 | ### `openapi_discriminator_name` 38 | 39 | Returns the discriminator's mapping. 40 | 41 | #### Example 42 | 43 | ```ruby 44 | require 'conekta' 45 | 46 | Conekta::ChargeOrderResponsePaymentMethod.openapi_discriminator_mapping 47 | # => 48 | # { 49 | # :'bank_transfer_payment' => :'PaymentMethodBankTransfer', 50 | # :'bnpl_payment' => :'PaymentMethodBnplPayment', 51 | # :'card_payment' => :'PaymentMethodCard', 52 | # :'cash_payment' => :'PaymentMethodCash' 53 | # } 54 | ``` 55 | 56 | ### build 57 | 58 | Find the appropriate object from the `openapi_one_of` list and casts the data into it. 59 | 60 | #### Example 61 | 62 | ```ruby 63 | require 'conekta' 64 | 65 | Conekta::ChargeOrderResponsePaymentMethod.build(data) 66 | # => # 67 | 68 | Conekta::ChargeOrderResponsePaymentMethod.build(data_that_doesnt_match) 69 | # => nil 70 | ``` 71 | 72 | #### Parameters 73 | 74 | | Name | Type | Description | 75 | | ---- | ---- | ----------- | 76 | | **data** | **Mixed** | data to be matched against the list of oneOf items | 77 | 78 | #### Return type 79 | 80 | - `PaymentMethodBankTransfer` 81 | - `PaymentMethodBnplPayment` 82 | - `PaymentMethodCard` 83 | - `PaymentMethodCash` 84 | - `nil` (if no type matches) 85 | 86 | -------------------------------------------------------------------------------- /docs/ChargeRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::ChargeRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **amount** | **Integer** | Amount to be charged in cents | [optional] | 8 | | **payment_method** | [**ChargeRequestPaymentMethod**](ChargeRequestPaymentMethod.md) | | | 9 | | **reference_id** | **String** | Custom reference to add to the charge | [optional] | 10 | 11 | ## Example 12 | 13 | ```ruby 14 | require 'conekta' 15 | 16 | instance = Conekta::ChargeRequest.new( 17 | amount: 40000, 18 | payment_method: null, 19 | reference_id: null 20 | ) 21 | ``` 22 | 23 | -------------------------------------------------------------------------------- /docs/ChargeRequestPaymentMethod.md: -------------------------------------------------------------------------------- 1 | # Conekta::ChargeRequestPaymentMethod 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 'conekta' 13 | 14 | Conekta::ChargeRequestPaymentMethod.openapi_one_of 15 | # => 16 | # [ 17 | # :'PaymentMethodBnplRequest', 18 | # :'PaymentMethodCardRequest', 19 | # :'PaymentMethodGeneralRequest' 20 | # ] 21 | ``` 22 | 23 | ### build 24 | 25 | Find the appropriate object from the `openapi_one_of` list and casts the data into it. 26 | 27 | #### Example 28 | 29 | ```ruby 30 | require 'conekta' 31 | 32 | Conekta::ChargeRequestPaymentMethod.build(data) 33 | # => # 34 | 35 | Conekta::ChargeRequestPaymentMethod.build(data_that_doesnt_match) 36 | # => nil 37 | ``` 38 | 39 | #### Parameters 40 | 41 | | Name | Type | Description | 42 | | ---- | ---- | ----------- | 43 | | **data** | **Mixed** | data to be matched against the list of oneOf items | 44 | 45 | #### Return type 46 | 47 | - `PaymentMethodBnplRequest` 48 | - `PaymentMethodCardRequest` 49 | - `PaymentMethodGeneralRequest` 50 | - `nil` (if no type matches) 51 | 52 | -------------------------------------------------------------------------------- /docs/ChargeResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::ChargeResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **amount** | **Integer** | | | 8 | | **channel** | [**ChargeResponseChannel**](ChargeResponseChannel.md) | | [optional] | 9 | | **created_at** | **Integer** | | | 10 | | **currency** | **String** | | | 11 | | **customer_id** | **String** | | [optional] | 12 | | **description** | **String** | | [optional] | 13 | | **device_fingerprint** | **String** | | [optional] | 14 | | **failure_code** | **String** | | [optional] | 15 | | **failure_message** | **String** | | [optional] | 16 | | **id** | **String** | Charge ID | | 17 | | **livemode** | **Boolean** | Whether the charge was made in live mode or not | | 18 | | **object** | **String** | | | 19 | | **order_id** | **String** | Order ID | | 20 | | **paid_at** | **Integer** | Payment date | [optional] | 21 | | **payment_method** | [**ChargeResponsePaymentMethod**](ChargeResponsePaymentMethod.md) | | [optional] | 22 | | **reference_id** | **String** | Reference ID of the charge | [optional] | 23 | | **refunds** | [**ChargeResponseRefunds**](ChargeResponseRefunds.md) | | [optional] | 24 | | **status** | **String** | Charge status | | 25 | 26 | ## Example 27 | 28 | ```ruby 29 | require 'conekta' 30 | 31 | instance = Conekta::ChargeResponse.new( 32 | amount: 4321, 33 | channel: null, 34 | created_at: 1676386026, 35 | currency: MXN, 36 | customer_id: null, 37 | description: Payment from order, 38 | device_fingerprint: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba, 39 | failure_code: suspected_fraud, 40 | failure_message: Este cargo ha sido declinado porque el comportamiento del comprador es sospechoso., 41 | id: 63efa757cf65380001aec040, 42 | livemode: false, 43 | object: charge, 44 | order_id: ord_2tN73UdUSNrYRPD9r, 45 | paid_at: 1676390742, 46 | payment_method: null, 47 | reference_id: ref_2tN73UdUSNrYRPD9r, 48 | refunds: null, 49 | status: pending_payment 50 | ) 51 | ``` 52 | 53 | -------------------------------------------------------------------------------- /docs/ChargeResponseChannel.md: -------------------------------------------------------------------------------- 1 | # Conekta::ChargeResponseChannel 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **segment** | **String** | | [optional] | 8 | | **checkout_request_id** | **String** | | [optional] | 9 | | **checkout_request_type** | **String** | | [optional] | 10 | | **id** | **String** | | [optional] | 11 | 12 | ## Example 13 | 14 | ```ruby 15 | require 'conekta' 16 | 17 | instance = Conekta::ChargeResponseChannel.new( 18 | segment: Checkout, 19 | checkout_request_id: 6fca054a-8519-4c43-971e-cea35cc519bb, 20 | checkout_request_type: HostedPayment, 21 | id: channel_2tNDzhA4Akmzj11AU 22 | ) 23 | ``` 24 | 25 | -------------------------------------------------------------------------------- /docs/ChargeResponsePaymentMethod.md: -------------------------------------------------------------------------------- 1 | # Conekta::ChargeResponsePaymentMethod 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 'conekta' 13 | 14 | Conekta::ChargeResponsePaymentMethod.openapi_one_of 15 | # => 16 | # [ 17 | # :'PaymentMethodBankTransfer', 18 | # :'PaymentMethodBnplPayment', 19 | # :'PaymentMethodCard', 20 | # :'PaymentMethodCash' 21 | # ] 22 | ``` 23 | 24 | ### `openapi_discriminator_name` 25 | 26 | Returns the discriminator's property name. 27 | 28 | #### Example 29 | 30 | ```ruby 31 | require 'conekta' 32 | 33 | Conekta::ChargeResponsePaymentMethod.openapi_discriminator_name 34 | # => :'object' 35 | ``` 36 | 37 | ### `openapi_discriminator_name` 38 | 39 | Returns the discriminator's mapping. 40 | 41 | #### Example 42 | 43 | ```ruby 44 | require 'conekta' 45 | 46 | Conekta::ChargeResponsePaymentMethod.openapi_discriminator_mapping 47 | # => 48 | # { 49 | # :'bank_transfer_payment' => :'PaymentMethodBankTransfer', 50 | # :'bnpl_payment' => :'PaymentMethodBnplPayment', 51 | # :'card_payment' => :'PaymentMethodCard', 52 | # :'cash_payment' => :'PaymentMethodCash' 53 | # } 54 | ``` 55 | 56 | ### build 57 | 58 | Find the appropriate object from the `openapi_one_of` list and casts the data into it. 59 | 60 | #### Example 61 | 62 | ```ruby 63 | require 'conekta' 64 | 65 | Conekta::ChargeResponsePaymentMethod.build(data) 66 | # => # 67 | 68 | Conekta::ChargeResponsePaymentMethod.build(data_that_doesnt_match) 69 | # => nil 70 | ``` 71 | 72 | #### Parameters 73 | 74 | | Name | Type | Description | 75 | | ---- | ---- | ----------- | 76 | | **data** | **Mixed** | data to be matched against the list of oneOf items | 77 | 78 | #### Return type 79 | 80 | - `PaymentMethodBankTransfer` 81 | - `PaymentMethodBnplPayment` 82 | - `PaymentMethodCard` 83 | - `PaymentMethodCash` 84 | - `nil` (if no type matches) 85 | 86 | -------------------------------------------------------------------------------- /docs/ChargeResponseRefunds.md: -------------------------------------------------------------------------------- 1 | # Conekta::ChargeResponseRefunds 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **has_more** | **Boolean** | Indicates if there are more pages to be requested | | 8 | | **object** | **String** | Object type, in this case is list | | 9 | | **next_page_url** | **String** | URL of the next page. | [optional] | 10 | | **previous_page_url** | **String** | Url of the previous page. | [optional] | 11 | | **data** | [**Array<ChargeResponseRefundsData>**](ChargeResponseRefundsData.md) | refunds | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::ChargeResponseRefunds.new( 19 | has_more: false, 20 | object: list, 21 | next_page_url: https://api.conekta.io/resources?limit=10&next=chrg_1, 22 | previous_page_url: https://api.conekta.io/resources?limit=10&previous=chrg_1, 23 | data: null 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/ChargeResponseRefundsData.md: -------------------------------------------------------------------------------- 1 | # Conekta::ChargeResponseRefundsData 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **amount** | **Integer** | | | 8 | | **auth_code** | **String** | | [optional] | 9 | | **created_at** | **Integer** | | | 10 | | **expires_at** | **Integer** | refund expiration date | [optional] | 11 | | **id** | **String** | | | 12 | | **object** | **String** | | | 13 | | **status** | **String** | refund status | [optional] | 14 | 15 | ## Example 16 | 17 | ```ruby 18 | require 'conekta' 19 | 20 | instance = Conekta::ChargeResponseRefundsData.new( 21 | amount: -15000, 22 | auth_code: 867372, 23 | created_at: 1678226878, 24 | expires_at: 1678226878, 25 | id: 6407b5bee1329a000175ba11, 26 | object: refund, 27 | status: pending 28 | ) 29 | ``` 30 | 31 | -------------------------------------------------------------------------------- /docs/ChargeUpdateRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::ChargeUpdateRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **reference_id** | **String** | custom reference id | [optional] | 8 | 9 | ## Example 10 | 11 | ```ruby 12 | require 'conekta' 13 | 14 | instance = Conekta::ChargeUpdateRequest.new( 15 | reference_id: 278482642 16 | ) 17 | ``` 18 | 19 | -------------------------------------------------------------------------------- /docs/ChargesDataResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::ChargesDataResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **amount** | **Integer** | | | 8 | | **channel** | [**ChargeResponseChannel**](ChargeResponseChannel.md) | | [optional] | 9 | | **created_at** | **Integer** | | | 10 | | **currency** | **String** | | | 11 | | **customer_id** | **String** | | [optional] | 12 | | **description** | **String** | | [optional] | 13 | | **device_fingerprint** | **String** | | [optional] | 14 | | **failure_code** | **String** | | [optional] | 15 | | **failure_message** | **String** | | [optional] | 16 | | **id** | **String** | Charge ID | | 17 | | **livemode** | **Boolean** | Whether the charge was made in live mode or not | | 18 | | **object** | **String** | | | 19 | | **order_id** | **String** | Order ID | | 20 | | **paid_at** | **Integer** | Payment date | [optional] | 21 | | **payment_method** | [**ChargeResponsePaymentMethod**](ChargeResponsePaymentMethod.md) | | [optional] | 22 | | **reference_id** | **String** | Reference ID of the charge | [optional] | 23 | | **refunds** | [**ChargeResponseRefunds**](ChargeResponseRefunds.md) | | [optional] | 24 | | **status** | **String** | Charge status | | 25 | 26 | ## Example 27 | 28 | ```ruby 29 | require 'conekta' 30 | 31 | instance = Conekta::ChargesDataResponse.new( 32 | amount: 4321, 33 | channel: null, 34 | created_at: 1676386026, 35 | currency: MXN, 36 | customer_id: null, 37 | description: Payment from order, 38 | device_fingerprint: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba, 39 | failure_code: suspected_fraud, 40 | failure_message: Este cargo ha sido declinado porque el comportamiento del comprador es sospechoso., 41 | id: 63efa757cf65380001aec040, 42 | livemode: false, 43 | object: charge, 44 | order_id: ord_2tN73UdUSNrYRPD9r, 45 | paid_at: 1676390742, 46 | payment_method: null, 47 | reference_id: ref_2tN73UdUSNrYRPD9r, 48 | refunds: null, 49 | status: pending_payment 50 | ) 51 | ``` 52 | 53 | -------------------------------------------------------------------------------- /docs/ChargesOrderResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::ChargesOrderResponse 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 | | **data** | [**Array<ChargesOrderResponseAllOfData>**](ChargesOrderResponseAllOfData.md) | | [optional] | 10 | 11 | ## Example 12 | 13 | ```ruby 14 | require 'conekta' 15 | 16 | instance = Conekta::ChargesOrderResponse.new( 17 | has_more: false, 18 | object: list, 19 | data: null 20 | ) 21 | ``` 22 | 23 | -------------------------------------------------------------------------------- /docs/ChargesOrderResponseAllOfData.md: -------------------------------------------------------------------------------- 1 | # Conekta::ChargesOrderResponseAllOfData 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **amount** | **Integer** | | | 8 | | **channel** | [**ChargeResponseChannel**](ChargeResponseChannel.md) | | [optional] | 9 | | **created_at** | **Integer** | | | 10 | | **currency** | **String** | | | 11 | | **customer_id** | **String** | | [optional] | 12 | | **description** | **String** | | [optional] | 13 | | **device_fingerprint** | **String** | | [optional] | 14 | | **failure_code** | **String** | | [optional] | 15 | | **failure_message** | **String** | | [optional] | 16 | | **id** | **String** | Charge ID | | 17 | | **livemode** | **Boolean** | Whether the charge was made in live mode or not | | 18 | | **object** | **String** | | | 19 | | **order_id** | **String** | Order ID | | 20 | | **paid_at** | **Integer** | Payment date | [optional] | 21 | | **payment_method** | [**ChargeResponsePaymentMethod**](ChargeResponsePaymentMethod.md) | | [optional] | 22 | | **reference_id** | **String** | Reference ID of the charge | [optional] | 23 | | **refunds** | [**ChargeResponseRefunds**](ChargeResponseRefunds.md) | | [optional] | 24 | | **status** | **String** | Charge status | | 25 | 26 | ## Example 27 | 28 | ```ruby 29 | require 'conekta' 30 | 31 | instance = Conekta::ChargesOrderResponseAllOfData.new( 32 | amount: 4321, 33 | channel: null, 34 | created_at: 1676386026, 35 | currency: MXN, 36 | customer_id: null, 37 | description: Payment from order, 38 | device_fingerprint: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba, 39 | failure_code: suspected_fraud, 40 | failure_message: Este cargo ha sido declinado porque el comportamiento del comprador es sospechoso., 41 | id: 63efa757cf65380001aec040, 42 | livemode: false, 43 | object: charge, 44 | order_id: ord_2tN73UdUSNrYRPD9r, 45 | paid_at: 1676390742, 46 | payment_method: null, 47 | reference_id: ref_2tN73UdUSNrYRPD9r, 48 | refunds: null, 49 | status: pending_payment 50 | ) 51 | ``` 52 | 53 | -------------------------------------------------------------------------------- /docs/CheckoutOrderTemplate.md: -------------------------------------------------------------------------------- 1 | # Conekta::CheckoutOrderTemplate 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **currency** | **String** | It is the currency in which the order will be created. It must be a valid ISO 4217 currency code. | | 8 | | **customer_info** | [**CheckoutOrderTemplateCustomerInfo**](CheckoutOrderTemplateCustomerInfo.md) | | [optional] | 9 | | **line_items** | [**Array<Product>**](Product.md) | They are the products to buy. Each contains the \"unit price\" and \"quantity\" parameters that are used to calculate the total amount of the order. | | 10 | | **plan_ids** | **Array<String>** | It is a list of plan IDs that will be associated with the order. | [optional] | 11 | | **metadata** | **Hash<String, Object>** | It is a set of key-value pairs that you can attach to the order. It can be used to store additional information about the order in a structured format. | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::CheckoutOrderTemplate.new( 19 | currency: MXN, 20 | customer_info: null, 21 | line_items: null, 22 | plan_ids: ["plan_123","plan_456"], 23 | metadata: {"key":"value"} 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/CheckoutOrderTemplateCustomerInfo.md: -------------------------------------------------------------------------------- 1 | # Conekta::CheckoutOrderTemplateCustomerInfo 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 'conekta' 13 | 14 | Conekta::CheckoutOrderTemplateCustomerInfo.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 'conekta' 30 | 31 | Conekta::CheckoutOrderTemplateCustomerInfo.build(data) 32 | # => # 33 | 34 | Conekta::CheckoutOrderTemplateCustomerInfo.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 | 50 | -------------------------------------------------------------------------------- /docs/CheckoutRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::CheckoutRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **allowed_payment_methods** | **Array<String>** | Are the payment methods available for this link. For subscriptions, only 'card' is allowed due to the recurring nature of the payments. | | 8 | | **plan_ids** | **Array<String>** | List of plan IDs that will be available for subscription. This field is required for subscription payments but optional for other types of payments. | 9 | | **expires_at** | **Integer** | Unix timestamp of checkout expiration | [optional] | 10 | | **failure_url** | **String** | Redirection url back to the site in case of failed payment, applies only to HostedPayment. | [optional] | 11 | | **monthly_installments_enabled** | **Boolean** | | [optional] | 12 | | **monthly_installments_options** | **Array<Integer>** | | [optional] | 13 | | **max_failed_retries** | **Integer** | Number of retries allowed before the checkout is marked as failed | [optional] | 14 | | **name** | **String** | Reason for payment | [optional] | 15 | | **on_demand_enabled** | **Boolean** | | [optional] | 16 | | **redirection_time** | **Integer** | number of seconds to wait before redirecting to the success_url | [optional] | 17 | | **success_url** | **String** | Redirection url back to the site in case of successful payment, applies only to HostedPayment | [optional] | 18 | | **type** | **String** | This field represents the type of checkout | [optional] | 19 | 20 | ## Example 21 | 22 | ```ruby 23 | require 'conekta' 24 | 25 | instance = Conekta::CheckoutRequest.new( 26 | allowed_payment_methods: ["cash","card","bank_transfer","bnpl"], 27 | plan_ids: ["plan_123","plan_456"], 28 | expires_at: null, 29 | failure_url: null, 30 | monthly_installments_enabled: false, 31 | monthly_installments_options: [3,6,12], 32 | max_failed_retries: 3, 33 | name: null, 34 | on_demand_enabled: true, 35 | redirection_time: 10, 36 | success_url: null, 37 | type: Integration 38 | ) 39 | ``` 40 | 41 | -------------------------------------------------------------------------------- /docs/CheckoutsResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::CheckoutsResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **has_more** | **Boolean** | Indicates if there are more pages to be requested | | 8 | | **object** | **String** | Object type, in this case is list | | 9 | | **next_page_url** | **String** | URL of the next page. | [optional] | 10 | | **previous_page_url** | **String** | Url of the previous page. | [optional] | 11 | | **data** | [**Array<CheckoutResponse>**](CheckoutResponse.md) | | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::CheckoutsResponse.new( 19 | has_more: false, 20 | object: list, 21 | next_page_url: https://api.conekta.io/resources?limit=10&next=chrg_1, 22 | previous_page_url: https://api.conekta.io/resources?limit=10&previous=chrg_1, 23 | data: null 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/CompanyFiscalInfoAddressResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::CompanyFiscalInfoAddressResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **object** | **String** | The resource's type | [optional] | 8 | | **street1** | **String** | Street Address | [optional] | 9 | | **street2** | **String** | Colonia | [optional] | 10 | | **city** | **String** | City | [optional] | 11 | | **state** | **String** | State | [optional] | 12 | | **country** | **String** | Country | [optional] | 13 | | **postal_code** | **String** | Postal code | [optional] | 14 | | **external_number** | **String** | Street number | [optional] | 15 | | **internal_number** | **String** | Unit / apartment number | [optional] | 16 | 17 | ## Example 18 | 19 | ```ruby 20 | require 'conekta' 21 | 22 | instance = Conekta::CompanyFiscalInfoAddressResponse.new( 23 | object: null, 24 | street1: Calle 13, 25 | street2: Navarte, 26 | city: Cuauhtémoc, 27 | state: Ciudad de México, 28 | country: MX, 29 | postal_code: 3072, 30 | external_number: 123, 31 | internal_number: 123 32 | ) 33 | ``` 34 | 35 | -------------------------------------------------------------------------------- /docs/CompanyFiscalInfoResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::CompanyFiscalInfoResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **object** | **String** | The resource's type | [optional] | 8 | | **tax_id** | **String** | Tax ID of the company | [optional] | 9 | | **legal_entity_name** | **String** | Legal name of the company | [optional] | 10 | | **business_type** | **String** | Business type of the company | [optional] | 11 | | **phone** | **String** | Phone number of the company | [optional] | 12 | | **physical_person_business_type** | **String** | Business type if 'persona_fisica' | [optional] | 13 | | **address** | [**CompanyFiscalInfoAddressResponse**](CompanyFiscalInfoAddressResponse.md) | | [optional] | 14 | 15 | ## Example 16 | 17 | ```ruby 18 | require 'conekta' 19 | 20 | instance = Conekta::CompanyFiscalInfoResponse.new( 21 | object: null, 22 | tax_id: XAXX010101000, 23 | legal_entity_name: Child Company A, 24 | business_type: persona_moral, 25 | phone: 5555555555, 26 | physical_person_business_type: null, 27 | address: null 28 | ) 29 | ``` 30 | 31 | -------------------------------------------------------------------------------- /docs/CompanyPayoutDestinationResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::CompanyPayoutDestinationResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **object** | **String** | The resource's type | [optional] | 8 | | **currency** | **String** | currency of the receiving account | [optional] | 9 | | **account_holder_name** | **String** | Name of the account holder | [optional] | 10 | | **bank** | **String** | Name of the bank | [optional] | 11 | | **type** | **String** | Type of the payout destination | [optional] | 12 | | **account_number** | **String** | Account number of the receiving account | [optional] | 13 | 14 | ## Example 15 | 16 | ```ruby 17 | require 'conekta' 18 | 19 | instance = Conekta::CompanyPayoutDestinationResponse.new( 20 | object: null, 21 | currency: MXN, 22 | account_holder_name: Child Company A, 23 | bank: BBVA, 24 | type: null, 25 | account_number: 123456789012345678 26 | ) 27 | ``` 28 | 29 | -------------------------------------------------------------------------------- /docs/CompanyResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::CompanyResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **id** | **String** | The child company's unique identifier | [optional] | 8 | | **created_at** | **Integer** | The resource's creation date (unix timestamp) | [optional] | 9 | | **name** | **String** | The child company's name | [optional] | 10 | | **object** | **String** | The resource's type | [optional] | 11 | | **parent_company_id** | **String** | Id of the parent company | [optional] | 12 | | **use_parent_fiscal_data** | **Boolean** | Whether the parent company's fiscal data is to be used for liquidation and tax purposes | [optional] | 13 | | **payout_destination** | [**CompanyPayoutDestinationResponse**](CompanyPayoutDestinationResponse.md) | | [optional] | 14 | | **fiscal_info** | [**CompanyFiscalInfoResponse**](CompanyFiscalInfoResponse.md) | | [optional] | 15 | 16 | ## Example 17 | 18 | ```ruby 19 | require 'conekta' 20 | 21 | instance = Conekta::CompanyResponse.new( 22 | id: 6441bb27659a060465da7335, 23 | created_at: 1680397724, 24 | name: Child Company A, 25 | object: null, 26 | parent_company_id: 6441bb3c62db5812e7920c31, 27 | use_parent_fiscal_data: false, 28 | payout_destination: null, 29 | fiscal_info: null 30 | ) 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /docs/CreateCustomerFiscalEntitiesResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::CreateCustomerFiscalEntitiesResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **address** | [**CustomerAddress**](CustomerAddress.md) | | | 8 | | **tax_id** | **String** | | [optional] | 9 | | **email** | **String** | | [optional] | 10 | | **phone** | **String** | | [optional] | 11 | | **metadata** | **Hash<String, Object>** | | [optional] | 12 | | **company_name** | **String** | | [optional] | 13 | | **id** | **String** | | | 14 | | **object** | **String** | | | 15 | | **created_at** | **Integer** | | | 16 | | **parent_id** | **String** | | [optional] | 17 | | **default** | **Boolean** | | [optional] | 18 | 19 | ## Example 20 | 21 | ```ruby 22 | require 'conekta' 23 | 24 | instance = Conekta::CreateCustomerFiscalEntitiesResponse.new( 25 | address: null, 26 | tax_id: null, 27 | email: null, 28 | phone: null, 29 | metadata: null, 30 | company_name: conekta, 31 | id: ship_cont_2tKZsTYcsryyu7Ah8, 32 | object: shipping_contact, 33 | created_at: 1675715413, 34 | parent_id: cus_2tKcHxhTz7xU5SymF, 35 | default: null 36 | ) 37 | ``` 38 | 39 | -------------------------------------------------------------------------------- /docs/CreateCustomerPaymentMethodsRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::CreateCustomerPaymentMethodsRequest 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 'conekta' 13 | 14 | Conekta::CreateCustomerPaymentMethodsRequest.openapi_one_of 15 | # => 16 | # [ 17 | # :'PaymentMethodCashRequest', 18 | # :'PaymentMethodSpeiRequest', 19 | # :'PaymentMethodTokenRequest' 20 | # ] 21 | ``` 22 | 23 | ### build 24 | 25 | Find the appropriate object from the `openapi_one_of` list and casts the data into it. 26 | 27 | #### Example 28 | 29 | ```ruby 30 | require 'conekta' 31 | 32 | Conekta::CreateCustomerPaymentMethodsRequest.build(data) 33 | # => # 34 | 35 | Conekta::CreateCustomerPaymentMethodsRequest.build(data_that_doesnt_match) 36 | # => nil 37 | ``` 38 | 39 | #### Parameters 40 | 41 | | Name | Type | Description | 42 | | ---- | ---- | ----------- | 43 | | **data** | **Mixed** | data to be matched against the list of oneOf items | 44 | 45 | #### Return type 46 | 47 | - `PaymentMethodCashRequest` 48 | - `PaymentMethodSpeiRequest` 49 | - `PaymentMethodTokenRequest` 50 | - `nil` (if no type matches) 51 | 52 | -------------------------------------------------------------------------------- /docs/CreateCustomerPaymentMethodsResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::CreateCustomerPaymentMethodsResponse 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 'conekta' 13 | 14 | Conekta::CreateCustomerPaymentMethodsResponse.openapi_one_of 15 | # => 16 | # [ 17 | # :'PaymentMethodCardResponse', 18 | # :'PaymentMethodCashResponse', 19 | # :'PaymentMethodSpeiRecurrent' 20 | # ] 21 | ``` 22 | 23 | ### `openapi_discriminator_name` 24 | 25 | Returns the discriminator's property name. 26 | 27 | #### Example 28 | 29 | ```ruby 30 | require 'conekta' 31 | 32 | Conekta::CreateCustomerPaymentMethodsResponse.openapi_discriminator_name 33 | # => :'type' 34 | ``` 35 | 36 | ### `openapi_discriminator_name` 37 | 38 | Returns the discriminator's mapping. 39 | 40 | #### Example 41 | 42 | ```ruby 43 | require 'conekta' 44 | 45 | Conekta::CreateCustomerPaymentMethodsResponse.openapi_discriminator_mapping 46 | # => 47 | # { 48 | # :'card' => :'PaymentMethodCardResponse', 49 | # :'cash' => :'PaymentMethodCashResponse', 50 | # :'cash_recurrent' => :'PaymentMethodCashResponse', 51 | # :'oxxo_recurrent' => :'PaymentMethodCashResponse', 52 | # :'spei_recurrent' => :'PaymentMethodSpeiRecurrent' 53 | # } 54 | ``` 55 | 56 | ### build 57 | 58 | Find the appropriate object from the `openapi_one_of` list and casts the data into it. 59 | 60 | #### Example 61 | 62 | ```ruby 63 | require 'conekta' 64 | 65 | Conekta::CreateCustomerPaymentMethodsResponse.build(data) 66 | # => # 67 | 68 | Conekta::CreateCustomerPaymentMethodsResponse.build(data_that_doesnt_match) 69 | # => nil 70 | ``` 71 | 72 | #### Parameters 73 | 74 | | Name | Type | Description | 75 | | ---- | ---- | ----------- | 76 | | **data** | **Mixed** | data to be matched against the list of oneOf items | 77 | 78 | #### Return type 79 | 80 | - `PaymentMethodCardResponse` 81 | - `PaymentMethodCashResponse` 82 | - `PaymentMethodSpeiRecurrent` 83 | - `nil` (if no type matches) 84 | 85 | -------------------------------------------------------------------------------- /docs/CreateRiskRulesData.md: -------------------------------------------------------------------------------- 1 | # Conekta::CreateRiskRulesData 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **description** | **String** | Description of the rule | | 8 | | **field** | **String** | Field to be used for the rule | | 9 | | **value** | **String** | Value to be used for the rule | | 10 | 11 | ## Example 12 | 13 | ```ruby 14 | require 'conekta' 15 | 16 | instance = Conekta::CreateRiskRulesData.new( 17 | description: this client email was verified at 20/09/22 by internal process, 18 | field: email | phone | card_token, 19 | value: email@example.com | 818081808180 | src_2qUCNd5AyQqfPMBuV 20 | ) 21 | ``` 22 | 23 | -------------------------------------------------------------------------------- /docs/CustomerAddress.md: -------------------------------------------------------------------------------- 1 | # Conekta::CustomerAddress 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **street1** | **String** | | | 8 | | **street2** | **String** | | [optional] | 9 | | **postal_code** | **String** | | | 10 | | **city** | **String** | | | 11 | | **state** | **String** | | [optional] | 12 | | **country** | **String** | this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) | [optional] | 13 | | **residential** | **Boolean** | | [optional][default to false] | 14 | | **external_number** | **String** | | [optional] | 15 | 16 | ## Example 17 | 18 | ```ruby 19 | require 'conekta' 20 | 21 | instance = Conekta::CustomerAddress.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 | residential: true, 29 | external_number: null 30 | ) 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /docs/CustomerAntifraudInfo.md: -------------------------------------------------------------------------------- 1 | # Conekta::CustomerAntifraudInfo 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **account_created_at** | **Integer** | | [optional] | 8 | | **first_paid_at** | **Integer** | | [optional] | 9 | 10 | ## Example 11 | 12 | ```ruby 13 | require 'conekta' 14 | 15 | instance = Conekta::CustomerAntifraudInfo.new( 16 | account_created_at: 1484040996, 17 | first_paid_at: 1485151007 18 | ) 19 | ``` 20 | 21 | -------------------------------------------------------------------------------- /docs/CustomerAntifraudInfoResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::CustomerAntifraudInfoResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **first_paid_at** | **Integer** | | [optional] | 8 | | **account_created_at** | **Integer** | | [optional] | 9 | 10 | ## Example 11 | 12 | ```ruby 13 | require 'conekta' 14 | 15 | instance = Conekta::CustomerAntifraudInfoResponse.new( 16 | first_paid_at: 1485151007, 17 | account_created_at: 1484040996 18 | ) 19 | ``` 20 | 21 | -------------------------------------------------------------------------------- /docs/CustomerFiscalEntitiesDataResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::CustomerFiscalEntitiesDataResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **address** | [**CustomerAddress**](CustomerAddress.md) | | | 8 | | **tax_id** | **String** | | [optional] | 9 | | **email** | **String** | | [optional] | 10 | | **phone** | **String** | | [optional] | 11 | | **metadata** | **Hash<String, Object>** | | [optional] | 12 | | **company_name** | **String** | | [optional] | 13 | | **id** | **String** | | | 14 | | **object** | **String** | | | 15 | | **created_at** | **Integer** | | | 16 | | **parent_id** | **String** | | [optional] | 17 | | **default** | **Boolean** | | [optional] | 18 | 19 | ## Example 20 | 21 | ```ruby 22 | require 'conekta' 23 | 24 | instance = Conekta::CustomerFiscalEntitiesDataResponse.new( 25 | address: null, 26 | tax_id: null, 27 | email: null, 28 | phone: null, 29 | metadata: null, 30 | company_name: conekta, 31 | id: ship_cont_2tKZsTYcsryyu7Ah8, 32 | object: shipping_contact, 33 | created_at: 1675715413, 34 | parent_id: cus_2tKcHxhTz7xU5SymF, 35 | default: null 36 | ) 37 | ``` 38 | 39 | -------------------------------------------------------------------------------- /docs/CustomerFiscalEntitiesRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::CustomerFiscalEntitiesRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **address** | [**CustomerAddress**](CustomerAddress.md) | | | 8 | | **tax_id** | **String** | | [optional] | 9 | | **email** | **String** | | [optional] | 10 | | **phone** | **String** | | [optional] | 11 | | **metadata** | **Hash<String, Object>** | | [optional] | 12 | | **company_name** | **String** | | [optional] | 13 | 14 | ## Example 15 | 16 | ```ruby 17 | require 'conekta' 18 | 19 | instance = Conekta::CustomerFiscalEntitiesRequest.new( 20 | address: null, 21 | tax_id: null, 22 | email: null, 23 | phone: null, 24 | metadata: null, 25 | company_name: conekta 26 | ) 27 | ``` 28 | 29 | -------------------------------------------------------------------------------- /docs/CustomerFiscalEntitiesResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::CustomerFiscalEntitiesResponse 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 | | **data** | [**Array<CustomerFiscalEntitiesDataResponse>**](CustomerFiscalEntitiesDataResponse.md) | | [optional] | 10 | 11 | ## Example 12 | 13 | ```ruby 14 | require 'conekta' 15 | 16 | instance = Conekta::CustomerFiscalEntitiesResponse.new( 17 | has_more: false, 18 | object: list, 19 | data: null 20 | ) 21 | ``` 22 | 23 | -------------------------------------------------------------------------------- /docs/CustomerInfo.md: -------------------------------------------------------------------------------- 1 | # Conekta::CustomerInfo 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **name** | **String** | | | 8 | | **email** | **String** | | | 9 | | **phone** | **String** | | | 10 | | **corporate** | **Boolean** | | [optional] | 11 | | **object** | **String** | | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::CustomerInfo.new( 19 | name: DevTest, 20 | email: test@conekta.com, 21 | phone: 5522997233, 22 | corporate: null, 23 | object: customer_info 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/CustomerInfoJustCustomerId.md: -------------------------------------------------------------------------------- 1 | # Conekta::CustomerInfoJustCustomerId 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **customer_id** | **String** | | | 8 | 9 | ## Example 10 | 11 | ```ruby 12 | require 'conekta' 13 | 14 | instance = Conekta::CustomerInfoJustCustomerId.new( 15 | customer_id: cus_23874283647 16 | ) 17 | ``` 18 | 19 | -------------------------------------------------------------------------------- /docs/CustomerInfoJustCustomerIdResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::CustomerInfoJustCustomerIdResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **customer_id** | **String** | | [optional] | 8 | 9 | ## Example 10 | 11 | ```ruby 12 | require 'conekta' 13 | 14 | instance = Conekta::CustomerInfoJustCustomerIdResponse.new( 15 | customer_id: cus_23874283647 16 | ) 17 | ``` 18 | 19 | -------------------------------------------------------------------------------- /docs/CustomerPaymentMethodRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::CustomerPaymentMethodRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **type** | **String** | Type of payment method | | 8 | 9 | ## Example 10 | 11 | ```ruby 12 | require 'conekta' 13 | 14 | instance = Conekta::CustomerPaymentMethodRequest.new( 15 | type: card | cash | spei | bnpl 16 | ) 17 | ``` 18 | 19 | -------------------------------------------------------------------------------- /docs/CustomerPaymentMethodsData.md: -------------------------------------------------------------------------------- 1 | # Conekta::CustomerPaymentMethodsData 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 'conekta' 13 | 14 | Conekta::CustomerPaymentMethodsData.openapi_one_of 15 | # => 16 | # [ 17 | # :'PaymentMethodCardResponse', 18 | # :'PaymentMethodCashResponse', 19 | # :'PaymentMethodSpeiRecurrent' 20 | # ] 21 | ``` 22 | 23 | ### `openapi_discriminator_name` 24 | 25 | Returns the discriminator's property name. 26 | 27 | #### Example 28 | 29 | ```ruby 30 | require 'conekta' 31 | 32 | Conekta::CustomerPaymentMethodsData.openapi_discriminator_name 33 | # => :'type' 34 | ``` 35 | 36 | ### `openapi_discriminator_name` 37 | 38 | Returns the discriminator's mapping. 39 | 40 | #### Example 41 | 42 | ```ruby 43 | require 'conekta' 44 | 45 | Conekta::CustomerPaymentMethodsData.openapi_discriminator_mapping 46 | # => 47 | # { 48 | # :'card' => :'PaymentMethodCardResponse', 49 | # :'cash' => :'PaymentMethodCashResponse', 50 | # :'cash_recurrent' => :'PaymentMethodCashResponse', 51 | # :'oxxo_recurrent' => :'PaymentMethodCashResponse', 52 | # :'spei_recurrent' => :'PaymentMethodSpeiRecurrent' 53 | # } 54 | ``` 55 | 56 | ### build 57 | 58 | Find the appropriate object from the `openapi_one_of` list and casts the data into it. 59 | 60 | #### Example 61 | 62 | ```ruby 63 | require 'conekta' 64 | 65 | Conekta::CustomerPaymentMethodsData.build(data) 66 | # => # 67 | 68 | Conekta::CustomerPaymentMethodsData.build(data_that_doesnt_match) 69 | # => nil 70 | ``` 71 | 72 | #### Parameters 73 | 74 | | Name | Type | Description | 75 | | ---- | ---- | ----------- | 76 | | **data** | **Mixed** | data to be matched against the list of oneOf items | 77 | 78 | #### Return type 79 | 80 | - `PaymentMethodCardResponse` 81 | - `PaymentMethodCashResponse` 82 | - `PaymentMethodSpeiRecurrent` 83 | - `nil` (if no type matches) 84 | 85 | -------------------------------------------------------------------------------- /docs/CustomerPaymentMethodsRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::CustomerPaymentMethodsRequest 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 'conekta' 13 | 14 | Conekta::CustomerPaymentMethodsRequest.openapi_one_of 15 | # => 16 | # [ 17 | # :'PaymentMethodCashRequest', 18 | # :'PaymentMethodSpeiRequest', 19 | # :'PaymentMethodTokenRequest' 20 | # ] 21 | ``` 22 | 23 | ### build 24 | 25 | Find the appropriate object from the `openapi_one_of` list and casts the data into it. 26 | 27 | #### Example 28 | 29 | ```ruby 30 | require 'conekta' 31 | 32 | Conekta::CustomerPaymentMethodsRequest.build(data) 33 | # => # 34 | 35 | Conekta::CustomerPaymentMethodsRequest.build(data_that_doesnt_match) 36 | # => nil 37 | ``` 38 | 39 | #### Parameters 40 | 41 | | Name | Type | Description | 42 | | ---- | ---- | ----------- | 43 | | **data** | **Mixed** | data to be matched against the list of oneOf items | 44 | 45 | #### Return type 46 | 47 | - `PaymentMethodCashRequest` 48 | - `PaymentMethodSpeiRequest` 49 | - `PaymentMethodTokenRequest` 50 | - `nil` (if no type matches) 51 | 52 | -------------------------------------------------------------------------------- /docs/CustomerPaymentMethodsResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::CustomerPaymentMethodsResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **has_more** | **Boolean** | Indicates if there are more pages to be requested | | 8 | | **object** | **String** | Object type, in this case is list | | 9 | | **next_page_url** | **String** | URL of the next page. | [optional] | 10 | | **previous_page_url** | **String** | Url of the previous page. | [optional] | 11 | | **data** | [**Array<CustomerPaymentMethodsData>**](CustomerPaymentMethodsData.md) | | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::CustomerPaymentMethodsResponse.new( 19 | has_more: false, 20 | object: list, 21 | next_page_url: https://api.conekta.io/resources?limit=10&next=chrg_1, 22 | previous_page_url: https://api.conekta.io/resources?limit=10&previous=chrg_1, 23 | data: null 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/CustomerResponseShippingContacts.md: -------------------------------------------------------------------------------- 1 | # Conekta::CustomerResponseShippingContacts 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 | | **data** | [**Array<CustomerShippingContactsDataResponse>**](CustomerShippingContactsDataResponse.md) | | [optional] | 10 | 11 | ## Example 12 | 13 | ```ruby 14 | require 'conekta' 15 | 16 | instance = Conekta::CustomerResponseShippingContacts.new( 17 | has_more: false, 18 | object: list, 19 | data: null 20 | ) 21 | ``` 22 | 23 | -------------------------------------------------------------------------------- /docs/CustomerShippingContacts.md: -------------------------------------------------------------------------------- 1 | # Conekta::CustomerShippingContacts 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **phone** | **String** | Phone contact | [optional] | 8 | | **receiver** | **String** | Name of the person who will receive the order | [optional] | 9 | | **between_streets** | **String** | The street names between which the order will be delivered. | [optional] | 10 | | **address** | [**CustomerShippingContactsAddress**](CustomerShippingContactsAddress.md) | | | 11 | | **parent_id** | **String** | | [optional] | 12 | | **default** | **Boolean** | | [optional] | 13 | | **deleted** | **Boolean** | | [optional] | 14 | | **metadata** | **Hash<String, Object>** | Metadata associated with the shipping contact | [optional] | 15 | 16 | ## Example 17 | 18 | ```ruby 19 | require 'conekta' 20 | 21 | instance = Conekta::CustomerShippingContacts.new( 22 | phone: +525511223344, 23 | receiver: Marvin Fuller, 24 | between_streets: Ackerman Crescent, 25 | address: null, 26 | parent_id: null, 27 | default: null, 28 | deleted: null, 29 | metadata: null 30 | ) 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /docs/CustomerShippingContactsAddress.md: -------------------------------------------------------------------------------- 1 | # Conekta::CustomerShippingContactsAddress 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **street1** | **String** | | [optional] | 8 | | **street2** | **String** | | [optional] | 9 | | **postal_code** | **String** | | [optional] | 10 | | **city** | **String** | | [optional] | 11 | | **state** | **String** | | [optional] | 12 | | **country** | **String** | this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) | [optional] | 13 | | **residential** | **Boolean** | | [optional] | 14 | 15 | ## Example 16 | 17 | ```ruby 18 | require 'conekta' 19 | 20 | instance = Conekta::CustomerShippingContactsAddress.new( 21 | street1: Nuevo Leon 254, 22 | street2: Departamento 404, 23 | postal_code: 06100, 24 | city: Ciudad de Mexico, 25 | state: Ciudad de Mexico, 26 | country: MX, 27 | residential: true 28 | ) 29 | ``` 30 | 31 | -------------------------------------------------------------------------------- /docs/CustomerShippingContactsDataResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::CustomerShippingContactsDataResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **phone** | **String** | Phone contact | [optional] | 8 | | **receiver** | **String** | Name of the person who will receive the order | [optional] | 9 | | **between_streets** | **String** | The street names between which the order will be delivered. | [optional] | 10 | | **address** | [**CustomerShippingContactsAddress**](CustomerShippingContactsAddress.md) | | | 11 | | **parent_id** | **String** | | [optional] | 12 | | **default** | **Boolean** | | [optional] | 13 | | **deleted** | **Boolean** | | [optional] | 14 | | **metadata** | **Hash<String, Object>** | Metadata associated with the shipping contact | [optional] | 15 | | **id** | **String** | | | 16 | | **object** | **String** | | | 17 | | **created_at** | **Integer** | | | 18 | 19 | ## Example 20 | 21 | ```ruby 22 | require 'conekta' 23 | 24 | instance = Conekta::CustomerShippingContactsDataResponse.new( 25 | phone: +525511223344, 26 | receiver: Marvin Fuller, 27 | between_streets: Ackerman Crescent, 28 | address: null, 29 | parent_id: null, 30 | default: null, 31 | deleted: null, 32 | metadata: null, 33 | id: ship_cont_2tKZsTYcsryyu7Ah8, 34 | object: shipping_contact, 35 | created_at: 1675715413 36 | ) 37 | ``` 38 | 39 | -------------------------------------------------------------------------------- /docs/CustomerShippingContactsResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::CustomerShippingContactsResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **phone** | **String** | | [optional] | 8 | | **receiver** | **String** | | [optional] | 9 | | **between_streets** | **String** | | [optional] | 10 | | **address** | [**CustomerShippingContactsResponseAddress**](CustomerShippingContactsResponseAddress.md) | | [optional] | 11 | | **parent_id** | **String** | | [optional] | 12 | | **default** | **Boolean** | | [optional] | 13 | | **id** | **String** | | [optional] | 14 | | **created_at** | **Integer** | | [optional] | 15 | | **metadata** | **Hash<String, Object>** | Metadata associated with the shipping contact | [optional] | 16 | | **object** | **String** | | [optional] | 17 | | **deleted** | **Boolean** | | [optional] | 18 | 19 | ## Example 20 | 21 | ```ruby 22 | require 'conekta' 23 | 24 | instance = Conekta::CustomerShippingContactsResponse.new( 25 | phone: +525511223344, 26 | receiver: Marvin Fuller, 27 | between_streets: Ackerman Crescent, 28 | address: null, 29 | parent_id: null, 30 | default: false, 31 | id: adr_1234567890, 32 | created_at: 1675715413, 33 | metadata: null, 34 | object: shipping_contact, 35 | deleted: false 36 | ) 37 | ``` 38 | 39 | -------------------------------------------------------------------------------- /docs/CustomerShippingContactsResponseAddress.md: -------------------------------------------------------------------------------- 1 | # Conekta::CustomerShippingContactsResponseAddress 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **object** | **String** | | [optional] | 8 | | **street1** | **String** | | [optional] | 9 | | **street2** | **String** | | [optional] | 10 | | **postal_code** | **String** | | [optional] | 11 | | **city** | **String** | | [optional] | 12 | | **state** | **String** | | [optional] | 13 | | **country** | **String** | | [optional] | 14 | | **residential** | **Boolean** | | [optional] | 15 | 16 | ## Example 17 | 18 | ```ruby 19 | require 'conekta' 20 | 21 | instance = Conekta::CustomerShippingContactsResponseAddress.new( 22 | object: shipping_address, 23 | street1: Nuevo Leon 254, 24 | street2: Departamento 404, 25 | postal_code: 06100, 26 | city: Ciudad de Mexico, 27 | state: Ciudad de Mexico, 28 | country: MX, 29 | residential: true 30 | ) 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /docs/CustomerUpdateFiscalEntitiesRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::CustomerUpdateFiscalEntitiesRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **address** | [**CustomerAddress**](CustomerAddress.md) | | [optional] | 8 | | **tax_id** | **String** | | [optional] | 9 | | **email** | **String** | | [optional] | 10 | | **phone** | **String** | | [optional] | 11 | | **metadata** | **Hash<String, Object>** | | [optional] | 12 | | **company_name** | **String** | | [optional] | 13 | 14 | ## Example 15 | 16 | ```ruby 17 | require 'conekta' 18 | 19 | instance = Conekta::CustomerUpdateFiscalEntitiesRequest.new( 20 | address: null, 21 | tax_id: null, 22 | email: null, 23 | phone: null, 24 | metadata: null, 25 | company_name: conekta 26 | ) 27 | ``` 28 | 29 | -------------------------------------------------------------------------------- /docs/CustomerUpdateShippingContacts.md: -------------------------------------------------------------------------------- 1 | # Conekta::CustomerUpdateShippingContacts 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **phone** | **String** | Phone contact | [optional] | 8 | | **receiver** | **String** | Name of the person who will receive the order | [optional] | 9 | | **between_streets** | **String** | The street names between which the order will be delivered. | [optional] | 10 | | **address** | [**CustomerShippingContactsAddress**](CustomerShippingContactsAddress.md) | | [optional] | 11 | | **parent_id** | **String** | | [optional] | 12 | | **default** | **Boolean** | | [optional] | 13 | | **deleted** | **Boolean** | | [optional] | 14 | 15 | ## Example 16 | 17 | ```ruby 18 | require 'conekta' 19 | 20 | instance = Conekta::CustomerUpdateShippingContacts.new( 21 | phone: +525511223344, 22 | receiver: Marvin Fuller, 23 | between_streets: Ackerman Crescent, 24 | address: null, 25 | parent_id: null, 26 | default: null, 27 | deleted: null 28 | ) 29 | ``` 30 | 31 | -------------------------------------------------------------------------------- /docs/CustomersResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::CustomersResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **has_more** | **Boolean** | Indicates if there are more pages to be requested | | 8 | | **object** | **String** | Object type, in this case is list | | 9 | | **next_page_url** | **String** | URL of the next page. | [optional] | 10 | | **previous_page_url** | **String** | Url of the previous page. | [optional] | 11 | | **data** | [**Array<CustomerResponse>**](CustomerResponse.md) | | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::CustomersResponse.new( 19 | has_more: false, 20 | object: list, 21 | next_page_url: https://api.conekta.io/resources?limit=10&next=chrg_1, 22 | previous_page_url: https://api.conekta.io/resources?limit=10&previous=chrg_1, 23 | data: null 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/DeleteApiKeysResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::DeleteApiKeysResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **active** | **Boolean** | Indicates if the api key is active | [optional] | 8 | | **created_at** | **Integer** | Unix timestamp in seconds of when the api key was created | [optional] | 9 | | **description** | **String** | A name or brief explanation of what this api key is used for | [optional] | 10 | | **livemode** | **Boolean** | Indicates if the api key is in production | [optional] | 11 | | **prefix** | **String** | The first few characters of the authentication_token | [optional] | 12 | | **id** | **String** | Unique identifier of the api key | [optional] | 13 | | **object** | **String** | Object name, value is 'api_key' | [optional] | 14 | | **last_used_at** | **Integer** | Unix timestamp in seconds with the api key was used | [optional] | 15 | | **role** | **String** | Indicates if the api key is private or public | [optional] | 16 | | **deleted** | **Boolean** | | [optional] | 17 | 18 | ## Example 19 | 20 | ```ruby 21 | require 'conekta' 22 | 23 | instance = Conekta::DeleteApiKeysResponse.new( 24 | active: true, 25 | created_at: 1684167881, 26 | description: online store, 27 | livemode: false, 28 | prefix: key_rp, 29 | id: 64625cc9f3e02c00163f5e4d, 30 | object: api_key, 31 | last_used_at: null, 32 | role: private, 33 | deleted: true 34 | ) 35 | ``` 36 | 37 | -------------------------------------------------------------------------------- /docs/DeletedBlacklistRuleResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::DeletedBlacklistRuleResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **id** | **String** | Blacklist rule id | [optional] | 8 | | **field** | **String** | field used for blacklists rule deleted | [optional] | 9 | | **value** | **String** | value used for blacklists rule deleted | [optional] | 10 | | **description** | **String** | use an description for blacklisted rule | [optional] | 11 | 12 | ## Example 13 | 14 | ```ruby 15 | require 'conekta' 16 | 17 | instance = Conekta::DeletedBlacklistRuleResponse.new( 18 | id: 2fw8EWJusiRrxdPzT, 19 | field: email, 20 | value: email@example.com, 21 | description: banned customer example@example.com 22 | ) 23 | ``` 24 | 25 | -------------------------------------------------------------------------------- /docs/DeletedWhitelistRuleResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::DeletedWhitelistRuleResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **id** | **String** | Whitelist rule id | [optional] | 8 | | **field** | **String** | field used for whitelists rule deleted | [optional] | 9 | | **value** | **String** | value used for whitelists rule deleted | [optional] | 10 | | **description** | **String** | use an description for whitelisted rule | [optional] | 11 | 12 | ## Example 13 | 14 | ```ruby 15 | require 'conekta' 16 | 17 | instance = Conekta::DeletedWhitelistRuleResponse.new( 18 | id: 2fw8EWJusiRrxdPzT, 19 | field: email, 20 | value: email@example.com, 21 | description: secure customer example@example.com 22 | ) 23 | ``` 24 | 25 | -------------------------------------------------------------------------------- /docs/Details.md: -------------------------------------------------------------------------------- 1 | # Conekta::Details 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **details** | [**Array<DetailsError>**](DetailsError.md) | | [optional] | 8 | 9 | ## Example 10 | 11 | ```ruby 12 | require 'conekta' 13 | 14 | instance = Conekta::Details.new( 15 | details: null 16 | ) 17 | ``` 18 | 19 | -------------------------------------------------------------------------------- /docs/DetailsError.md: -------------------------------------------------------------------------------- 1 | # Conekta::DetailsError 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **code** | **String** | | [optional] | 8 | | **param** | **String** | | [optional] | 9 | | **message** | **String** | | [optional] | 10 | | **debug_message** | **String** | | [optional] | 11 | 12 | ## Example 13 | 14 | ```ruby 15 | require 'conekta' 16 | 17 | instance = Conekta::DetailsError.new( 18 | code: conekta.errors.authentication.missing_key, 19 | param: null, 20 | message: Acceso no autorizado., 21 | debug_message: Please include your access key in your request. 22 | ) 23 | ``` 24 | 25 | -------------------------------------------------------------------------------- /docs/DiscountLinesDataResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::DiscountLinesDataResponse 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 'loyalty', 'campaign', 'coupon' o 'sign' | | 10 | | **id** | **String** | The discount line id | | 11 | | **object** | **String** | The object name | | 12 | | **parent_id** | **String** | The order id | | 13 | 14 | ## Example 15 | 16 | ```ruby 17 | require 'conekta' 18 | 19 | instance = Conekta::DiscountLinesDataResponse.new( 20 | amount: 500, 21 | code: 123, 22 | type: loyalty, 23 | id: dis_lin_2tQQ58HPgPw7StE8z, 24 | object: discount_line, 25 | parent_id: ord_2tPAmKCEJqh8RE6nY 26 | ) 27 | ``` 28 | 29 | -------------------------------------------------------------------------------- /docs/DiscountLinesResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::DiscountLinesResponse 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 'loyalty', 'campaign', 'coupon' o 'sign' | | 10 | | **id** | **String** | The discount line id | | 11 | | **object** | **String** | The object name | | 12 | | **parent_id** | **String** | The order id | | 13 | 14 | ## Example 15 | 16 | ```ruby 17 | require 'conekta' 18 | 19 | instance = Conekta::DiscountLinesResponse.new( 20 | amount: 500, 21 | code: 123, 22 | type: loyalty, 23 | id: dis_lin_2tQQ58HPgPw7StE8z, 24 | object: discount_line, 25 | parent_id: ord_2tPAmKCEJqh8RE6nY 26 | ) 27 | ``` 28 | 29 | -------------------------------------------------------------------------------- /docs/EmailCheckoutRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::EmailCheckoutRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **email** | **String** | | | 8 | 9 | ## Example 10 | 11 | ```ruby 12 | require 'conekta' 13 | 14 | instance = Conekta::EmailCheckoutRequest.new( 15 | email: example@conekta.com 16 | ) 17 | ``` 18 | 19 | -------------------------------------------------------------------------------- /docs/Error.md: -------------------------------------------------------------------------------- 1 | # Conekta::Error 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **details** | [**Array<DetailsError>**](DetailsError.md) | | [optional] | 8 | | **log_id** | **String** | log id | [optional] | 9 | | **type** | **String** | | [optional] | 10 | | **object** | **String** | | [optional] | 11 | 12 | ## Example 13 | 14 | ```ruby 15 | require 'conekta' 16 | 17 | instance = Conekta::Error.new( 18 | details: null, 19 | log_id: 507f1f77bcf86cd799439011, 20 | type: authentication_error, 21 | object: error 22 | ) 23 | ``` 24 | 25 | -------------------------------------------------------------------------------- /docs/EventResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::EventResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **created_at** | **Integer** | | [optional] | 8 | | **data** | **Hash<String, Object>** | | [optional] | 9 | | **id** | **String** | | [optional] | 10 | | **livemode** | **Boolean** | | [optional] | 11 | | **object** | **String** | | [optional] | 12 | | **type** | **String** | | [optional] | 13 | | **webhook_logs** | [**Array<WebhookLog>**](WebhookLog.md) | | [optional] | 14 | | **webhook_status** | **String** | | [optional] | 15 | 16 | ## Example 17 | 18 | ```ruby 19 | require 'conekta' 20 | 21 | instance = Conekta::EventResponse.new( 22 | created_at: 1661445644, 23 | data: {"action":"ping","livemode":true}, 24 | id: 6307a60c41de27127515a575, 25 | livemode: true, 26 | object: event, 27 | type: webhook_ping, 28 | webhook_logs: null, 29 | webhook_status: successful 30 | ) 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /docs/EventTypes.md: -------------------------------------------------------------------------------- 1 | # Conekta::EventTypes 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | 8 | ## Example 9 | 10 | ```ruby 11 | require 'conekta' 12 | 13 | instance = Conekta::EventTypes.new() 14 | ``` 15 | 16 | -------------------------------------------------------------------------------- /docs/EventsResendResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::EventsResendResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **failed_attempts** | **Integer** | | [optional] | 8 | | **id** | **String** | | [optional] | 9 | | **last_attempted_at** | **Integer** | | [optional] | 10 | | **last_http_response_status** | **Integer** | | [optional] | 11 | | **response_data** | **Hash<String, Object>** | | [optional] | 12 | | **url** | **String** | | [optional] | 13 | 14 | ## Example 15 | 16 | ```ruby 17 | require 'conekta' 18 | 19 | instance = Conekta::EventsResendResponse.new( 20 | failed_attempts: 6, 21 | id: webhl_2svd2sh6GbqzyWBNZ, 22 | last_attempted_at: 1684265970, 23 | last_http_response_status: 405, 24 | response_data: {}, 25 | url: https://username:password@mockoon.stg.conekta.io/payments-api/cash/merchant_approval 26 | ) 27 | ``` 28 | 29 | -------------------------------------------------------------------------------- /docs/FiscalEntityAddress.md: -------------------------------------------------------------------------------- 1 | # Conekta::FiscalEntityAddress 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 | 15 | ## Example 16 | 17 | ```ruby 18 | require 'conekta' 19 | 20 | instance = Conekta::FiscalEntityAddress.new( 21 | street1: Nuevo Leon 254, 22 | street2: Departamento 404, 23 | postal_code: 06100, 24 | city: Ciudad de Mexico, 25 | state: Ciudad de Mexico, 26 | country: MX, 27 | external_number: 123 28 | ) 29 | ``` 30 | 31 | -------------------------------------------------------------------------------- /docs/GetApiKeysResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::GetApiKeysResponse 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 | | **has_more** | **Boolean** | Indicates if there are more pages to be requested | | 10 | | **object** | **String** | Object type, in this case is list | | 11 | | **data** | [**Array<ApiKeyResponse>**](ApiKeyResponse.md) | | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::GetApiKeysResponse.new( 19 | next_page_url: https://api.conekta.io/resources?limit=10&next=chrg_1, 20 | previous_page_url: https://api.conekta.io/resources?limit=10&previous=chrg_1, 21 | has_more: false, 22 | object: list, 23 | data: null 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/GetChargesResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::GetChargesResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **has_more** | **Boolean** | Indicates if there are more pages to be requested | | 8 | | **object** | **String** | Object type, in this case is list | | 9 | | **next_page_url** | **String** | URL of the next page. | [optional] | 10 | | **previous_page_url** | **String** | Url of the previous page. | [optional] | 11 | | **data** | [**Array<ChargeResponse>**](ChargeResponse.md) | | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::GetChargesResponse.new( 19 | has_more: false, 20 | object: list, 21 | next_page_url: https://api.conekta.io/resources?limit=10&next=chrg_1, 22 | previous_page_url: https://api.conekta.io/resources?limit=10&previous=chrg_1, 23 | data: null 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/GetCompaniesResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::GetCompaniesResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **has_more** | **Boolean** | Indicates if there are more pages to be requested | | 8 | | **object** | **String** | Object type, in this case is list | | 9 | | **next_page_url** | **String** | URL of the next page. | [optional] | 10 | | **previous_page_url** | **String** | Url of the previous page. | [optional] | 11 | | **data** | [**Array<CompanyResponse>**](CompanyResponse.md) | | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::GetCompaniesResponse.new( 19 | has_more: false, 20 | object: list, 21 | next_page_url: https://api.conekta.io/resources?limit=10&next=chrg_1, 22 | previous_page_url: https://api.conekta.io/resources?limit=10&previous=chrg_1, 23 | data: null 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/GetCustomerPaymentMethodDataResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::GetCustomerPaymentMethodDataResponse 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 'conekta' 13 | 14 | Conekta::GetCustomerPaymentMethodDataResponse.openapi_one_of 15 | # => 16 | # [ 17 | # :'PaymentMethodCardResponse', 18 | # :'PaymentMethodCashResponse', 19 | # :'PaymentMethodSpeiRecurrent' 20 | # ] 21 | ``` 22 | 23 | ### `openapi_discriminator_name` 24 | 25 | Returns the discriminator's property name. 26 | 27 | #### Example 28 | 29 | ```ruby 30 | require 'conekta' 31 | 32 | Conekta::GetCustomerPaymentMethodDataResponse.openapi_discriminator_name 33 | # => :'type' 34 | ``` 35 | 36 | ### `openapi_discriminator_name` 37 | 38 | Returns the discriminator's mapping. 39 | 40 | #### Example 41 | 42 | ```ruby 43 | require 'conekta' 44 | 45 | Conekta::GetCustomerPaymentMethodDataResponse.openapi_discriminator_mapping 46 | # => 47 | # { 48 | # :'card' => :'PaymentMethodCardResponse', 49 | # :'cash' => :'PaymentMethodCashResponse', 50 | # :'cash_recurrent' => :'PaymentMethodCashResponse', 51 | # :'oxxo_recurrent' => :'PaymentMethodCashResponse', 52 | # :'spei_recurrent' => :'PaymentMethodSpeiRecurrent' 53 | # } 54 | ``` 55 | 56 | ### build 57 | 58 | Find the appropriate object from the `openapi_one_of` list and casts the data into it. 59 | 60 | #### Example 61 | 62 | ```ruby 63 | require 'conekta' 64 | 65 | Conekta::GetCustomerPaymentMethodDataResponse.build(data) 66 | # => # 67 | 68 | Conekta::GetCustomerPaymentMethodDataResponse.build(data_that_doesnt_match) 69 | # => nil 70 | ``` 71 | 72 | #### Parameters 73 | 74 | | Name | Type | Description | 75 | | ---- | ---- | ----------- | 76 | | **data** | **Mixed** | data to be matched against the list of oneOf items | 77 | 78 | #### Return type 79 | 80 | - `PaymentMethodCardResponse` 81 | - `PaymentMethodCashResponse` 82 | - `PaymentMethodSpeiRecurrent` 83 | - `nil` (if no type matches) 84 | 85 | -------------------------------------------------------------------------------- /docs/GetEventsResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::GetEventsResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **has_more** | **Boolean** | Indicates if there are more pages to be requested | | 8 | | **object** | **String** | Object type, in this case is list | | 9 | | **next_page_url** | **String** | URL of the next page. | [optional] | 10 | | **previous_page_url** | **String** | Url of the previous page. | [optional] | 11 | | **data** | [**Array<EventResponse>**](EventResponse.md) | | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::GetEventsResponse.new( 19 | has_more: false, 20 | object: list, 21 | next_page_url: https://api.conekta.io/resources?limit=10&next=chrg_1, 22 | previous_page_url: https://api.conekta.io/resources?limit=10&previous=chrg_1, 23 | data: null 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/GetOrderDiscountLinesResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::GetOrderDiscountLinesResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **has_more** | **Boolean** | Indicates if there are more pages to be requested | | 8 | | **object** | **String** | Object type, in this case is list | | 9 | | **next_page_url** | **String** | URL of the next page. | [optional] | 10 | | **previous_page_url** | **String** | Url of the previous page. | [optional] | 11 | | **data** | [**Array<DiscountLinesResponse>**](DiscountLinesResponse.md) | | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::GetOrderDiscountLinesResponse.new( 19 | has_more: false, 20 | object: list, 21 | next_page_url: https://api.conekta.io/resources?limit=10&next=chrg_1, 22 | previous_page_url: https://api.conekta.io/resources?limit=10&previous=chrg_1, 23 | data: null 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/GetOrdersResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::GetOrdersResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **data** | [**Array<OrderResponse>**](OrderResponse.md) | | | 8 | | **has_more** | **Boolean** | Indicates if there are more pages to be requested | | 9 | | **object** | **String** | Object type, in this case is list | | 10 | | **next_page_url** | **String** | URL of the next page. | [optional] | 11 | | **previous_page_url** | **String** | Url of the previous page. | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::GetOrdersResponse.new( 19 | data: null, 20 | has_more: false, 21 | object: list, 22 | next_page_url: https://api.conekta.io/resources?limit=10&next=chrg_1, 23 | previous_page_url: https://api.conekta.io/resources?limit=10&previous=chrg_1 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/GetPaymentMethodResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::GetPaymentMethodResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **has_more** | **Boolean** | Indicates if there are more pages to be requested | | 8 | | **object** | **String** | Object type, in this case is list | | 9 | | **next_page_url** | **String** | URL of the next page. | [optional] | 10 | | **previous_page_url** | **String** | Url of the previous page. | [optional] | 11 | | **data** | [**Array<GetCustomerPaymentMethodDataResponse>**](GetCustomerPaymentMethodDataResponse.md) | | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::GetPaymentMethodResponse.new( 19 | has_more: false, 20 | object: list, 21 | next_page_url: https://api.conekta.io/resources?limit=10&next=chrg_1, 22 | previous_page_url: https://api.conekta.io/resources?limit=10&previous=chrg_1, 23 | data: null 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/GetPlansResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::GetPlansResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **has_more** | **Boolean** | Indicates if there are more pages to be requested | | 8 | | **object** | **String** | Object type, in this case is list | | 9 | | **next_page_url** | **String** | URL of the next page. | [optional] | 10 | | **previous_page_url** | **String** | Url of the previous page. | [optional] | 11 | | **data** | [**Array<PlanResponse>**](PlanResponse.md) | | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::GetPlansResponse.new( 19 | has_more: false, 20 | object: list, 21 | next_page_url: https://api.conekta.io/resources?limit=10&next=chrg_1, 22 | previous_page_url: https://api.conekta.io/resources?limit=10&previous=chrg_1, 23 | data: null 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/GetTransactionsResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::GetTransactionsResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **has_more** | **Boolean** | Indicates if there are more pages to be requested | | 8 | | **object** | **String** | Object type, in this case is list | | 9 | | **next_page_url** | **String** | URL of the next page. | [optional] | 10 | | **previous_page_url** | **String** | Url of the previous page. | [optional] | 11 | | **data** | [**Array<TransactionResponse>**](TransactionResponse.md) | Transactions | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::GetTransactionsResponse.new( 19 | has_more: false, 20 | object: list, 21 | next_page_url: https://api.conekta.io/resources?limit=10&next=chrg_1, 22 | previous_page_url: https://api.conekta.io/resources?limit=10&previous=chrg_1, 23 | data: null 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/GetTransfersResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::GetTransfersResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **has_more** | **Boolean** | Indicates if there are more pages to be requested | | 8 | | **object** | **String** | Object type, in this case is list | | 9 | | **next_page_url** | **String** | URL of the next page. | [optional] | 10 | | **previous_page_url** | **String** | Url of the previous page. | [optional] | 11 | | **data** | [**Array<TransfersResponse>**](TransfersResponse.md) | Transfers | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::GetTransfersResponse.new( 19 | has_more: false, 20 | object: list, 21 | next_page_url: https://api.conekta.io/resources?limit=10&next=chrg_1, 22 | previous_page_url: https://api.conekta.io/resources?limit=10&previous=chrg_1, 23 | data: null 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/GetWebhookKeysResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::GetWebhookKeysResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **has_more** | **Boolean** | Indicates if there are more pages to be requested | | 8 | | **object** | **String** | Object type, in this case is list | | 9 | | **next_page_url** | **String** | URL of the next page. | [optional] | 10 | | **previous_page_url** | **String** | Url of the previous page. | [optional] | 11 | | **data** | [**Array<WebhookKeyResponse>**](WebhookKeyResponse.md) | | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::GetWebhookKeysResponse.new( 19 | has_more: false, 20 | object: list, 21 | next_page_url: https://api.conekta.io/resources?limit=10&next=chrg_1, 22 | previous_page_url: https://api.conekta.io/resources?limit=10&previous=chrg_1, 23 | data: null 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/GetWebhooksResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::GetWebhooksResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **has_more** | **Boolean** | Indicates if there are more pages to be requested | | 8 | | **object** | **String** | Object type, in this case is list | | 9 | | **next_page_url** | **String** | URL of the next page. | [optional] | 10 | | **previous_page_url** | **String** | Url of the previous page. | [optional] | 11 | | **data** | [**Array<WebhookResponse>**](WebhookResponse.md) | | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::GetWebhooksResponse.new( 19 | has_more: false, 20 | object: list, 21 | next_page_url: https://api.conekta.io/resources?limit=10&next=chrg_1, 22 | previous_page_url: https://api.conekta.io/resources?limit=10&previous=chrg_1, 23 | data: null 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/LogsResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::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<LogsResponseData>**](LogsResponseData.md) | set to page results. | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::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 | 27 | -------------------------------------------------------------------------------- /docs/OrderCaptureRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::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 'conekta' 13 | 14 | instance = Conekta::OrderCaptureRequest.new( 15 | amount: 500 16 | ) 17 | ``` 18 | 19 | -------------------------------------------------------------------------------- /docs/OrderChannelResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::OrderChannelResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **segment** | **String** | | [optional] | 8 | | **checkout_request_id** | **String** | | [optional] | 9 | | **checkout_request_type** | **String** | | [optional] | 10 | | **id** | **String** | | [optional] | 11 | 12 | ## Example 13 | 14 | ```ruby 15 | require 'conekta' 16 | 17 | instance = Conekta::OrderChannelResponse.new( 18 | segment: Checkout, 19 | checkout_request_id: 6fca054a-8519-4c43-971e-cea35cc519bb, 20 | checkout_request_type: HostedPayment, 21 | id: channel_2tNDzhA4Akmzj11AU 22 | ) 23 | ``` 24 | 25 | -------------------------------------------------------------------------------- /docs/OrderChargesResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::OrderChargesResponse 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 | | **data** | [**Array<ChargesDataResponse>**](ChargesDataResponse.md) | | [optional] | 10 | 11 | ## Example 12 | 13 | ```ruby 14 | require 'conekta' 15 | 16 | instance = Conekta::OrderChargesResponse.new( 17 | has_more: false, 18 | object: list, 19 | data: null 20 | ) 21 | ``` 22 | 23 | -------------------------------------------------------------------------------- /docs/OrderCustomerInfoResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::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 'conekta' 18 | 19 | instance = Conekta::OrderCustomerInfoResponse.new( 20 | customer_custom_reference: custom_reference, 21 | name: DevTest, 22 | email: test@conekta.com, 23 | phone: 5522997233, 24 | corporate: null, 25 | object: customer_info 26 | ) 27 | ``` 28 | 29 | -------------------------------------------------------------------------------- /docs/OrderDiscountLinesRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::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 'loyalty', 'campaign', 'coupon' o 'sign' | | 10 | 11 | ## Example 12 | 13 | ```ruby 14 | require 'conekta' 15 | 16 | instance = Conekta::OrderDiscountLinesRequest.new( 17 | amount: 500, 18 | code: 123, 19 | type: loyalty 20 | ) 21 | ``` 22 | 23 | -------------------------------------------------------------------------------- /docs/OrderDiscountLinesResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::OrderDiscountLinesResponse 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 | | **data** | [**Array<DiscountLinesDataResponse>**](DiscountLinesDataResponse.md) | | [optional] | 10 | 11 | ## Example 12 | 13 | ```ruby 14 | require 'conekta' 15 | 16 | instance = Conekta::OrderDiscountLinesResponse.new( 17 | has_more: false, 18 | object: list, 19 | data: null 20 | ) 21 | ``` 22 | 23 | -------------------------------------------------------------------------------- /docs/OrderFiscalEntityAddressResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::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 'conekta' 20 | 21 | instance = Conekta::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 | 33 | -------------------------------------------------------------------------------- /docs/OrderFiscalEntityRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::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<String, Object>** | 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 'conekta' 18 | 19 | instance = Conekta::OrderFiscalEntityRequest.new( 20 | address: null, 21 | email: test@gmail.com, 22 | metadata: null, 23 | name: Conekta Inc, 24 | phone: +525511223344, 25 | tax_id: AAA010101AAA 26 | ) 27 | ``` 28 | 29 | -------------------------------------------------------------------------------- /docs/OrderFiscalEntityResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::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<String, Object>** | 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 'conekta' 21 | 22 | instance = Conekta::OrderFiscalEntityResponse.new( 23 | address: null, 24 | email: test@gmail.com, 25 | metadata: null, 26 | name: Conekta Inc, 27 | tax_id: 324234234, 28 | id: fis_ent_2tN85VYaSMyDvjB3M, 29 | created_at: 1676328434, 30 | object: fiscal_entity, 31 | phone: +525511223344 32 | ) 33 | ``` 34 | 35 | -------------------------------------------------------------------------------- /docs/OrderNextActionResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::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 'conekta' 14 | 15 | instance = Conekta::OrderNextActionResponse.new( 16 | redirect_to_url: null, 17 | type: redirect_to_url 18 | ) 19 | ``` 20 | 21 | -------------------------------------------------------------------------------- /docs/OrderNextActionResponseRedirectToUrl.md: -------------------------------------------------------------------------------- 1 | # Conekta::OrderNextActionResponseRedirectToUrl 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **url** | **String** | pay.conekta.com/{id} Indicates the url of the Conekta 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 'conekta' 14 | 15 | instance = Conekta::OrderNextActionResponseRedirectToUrl.new( 16 | url: https://pay.conekta.com/6fca054a85194c43971ecea35cc519bb, 17 | return_url: https://my-website.com" 18 | ) 19 | ``` 20 | 21 | -------------------------------------------------------------------------------- /docs/OrderRefundRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::OrderRefundRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **amount** | **Integer** | Amount to be refunded in cents | | 8 | | **expires_at** | **Integer** | | [optional] | 9 | | **reason** | **String** | Reason for the refund | | 10 | 11 | ## Example 12 | 13 | ```ruby 14 | require 'conekta' 15 | 16 | instance = Conekta::OrderRefundRequest.new( 17 | amount: 500, 18 | expires_at: 1553273553, 19 | reason: suspected_fraud 20 | ) 21 | ``` 22 | 23 | -------------------------------------------------------------------------------- /docs/OrderRequestCustomerInfo.md: -------------------------------------------------------------------------------- 1 | # Conekta::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 'conekta' 13 | 14 | Conekta::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 'conekta' 30 | 31 | Conekta::OrderRequestCustomerInfo.build(data) 32 | # => # 33 | 34 | Conekta::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 | 50 | -------------------------------------------------------------------------------- /docs/OrderResponseCustomerInfo.md: -------------------------------------------------------------------------------- 1 | # Conekta::OrderResponseCustomerInfo 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 | | **customer_id** | **String** | | [optional] | 14 | 15 | ## Example 16 | 17 | ```ruby 18 | require 'conekta' 19 | 20 | instance = Conekta::OrderResponseCustomerInfo.new( 21 | customer_custom_reference: custom_reference, 22 | name: DevTest, 23 | email: test@conekta.com, 24 | phone: 5522997233, 25 | corporate: null, 26 | object: customer_info, 27 | customer_id: cus_23874283647 28 | ) 29 | ``` 30 | 31 | -------------------------------------------------------------------------------- /docs/OrderResponseProducts.md: -------------------------------------------------------------------------------- 1 | # Conekta::OrderResponseProducts 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **has_more** | **Boolean** | Indicates if there are more pages to be requested | | 8 | | **object** | **String** | Object type, in this case is list | | 9 | | **next_page_url** | **String** | URL of the next page. | [optional] | 10 | | **previous_page_url** | **String** | Url of the previous page. | [optional] | 11 | | **data** | [**Array<ProductDataResponse>**](ProductDataResponse.md) | | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::OrderResponseProducts.new( 19 | has_more: false, 20 | object: list, 21 | next_page_url: https://api.conekta.io/resources?limit=10&next=chrg_1, 22 | previous_page_url: https://api.conekta.io/resources?limit=10&previous=chrg_1, 23 | data: null 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/OrderResponseShippingContact.md: -------------------------------------------------------------------------------- 1 | # Conekta::OrderResponseShippingContact 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **phone** | **String** | | [optional] | 8 | | **receiver** | **String** | | [optional] | 9 | | **between_streets** | **String** | | [optional] | 10 | | **address** | [**CustomerShippingContactsResponseAddress**](CustomerShippingContactsResponseAddress.md) | | [optional] | 11 | | **parent_id** | **String** | | [optional] | 12 | | **default** | **Boolean** | | [optional] | 13 | | **id** | **String** | | [optional] | 14 | | **created_at** | **Integer** | | [optional] | 15 | | **metadata** | **Hash<String, Object>** | Metadata associated with the shipping contact | [optional] | 16 | | **object** | **String** | | [optional] | 17 | | **deleted** | **Boolean** | | [optional] | 18 | 19 | ## Example 20 | 21 | ```ruby 22 | require 'conekta' 23 | 24 | instance = Conekta::OrderResponseShippingContact.new( 25 | phone: +525511223344, 26 | receiver: Marvin Fuller, 27 | between_streets: Ackerman Crescent, 28 | address: null, 29 | parent_id: null, 30 | default: false, 31 | id: null, 32 | created_at: null, 33 | metadata: null, 34 | object: null, 35 | deleted: false 36 | ) 37 | ``` 38 | 39 | -------------------------------------------------------------------------------- /docs/OrderTaxRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::OrderTaxRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **amount** | **Integer** | The amount to be collected for tax in cents | | 8 | | **description** | **String** | description or tax's name | | 9 | | **metadata** | **Hash<String, Object>** | | [optional] | 10 | 11 | ## Example 12 | 13 | ```ruby 14 | require 'conekta' 15 | 16 | instance = Conekta::OrderTaxRequest.new( 17 | amount: 100, 18 | description: testing, 19 | metadata: {"key":"value"} 20 | ) 21 | ``` 22 | 23 | -------------------------------------------------------------------------------- /docs/OrderUpdateFiscalEntityRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::OrderUpdateFiscalEntityRequest 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 | | **name** | **String** | Name of the fiscal entity | [optional] | 10 | | **metadata** | **Hash<String, Object>** | Metadata associated with 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 'conekta' 18 | 19 | instance = Conekta::OrderUpdateFiscalEntityRequest.new( 20 | address: null, 21 | email: test@gmail.com, 22 | name: Conekta Inc, 23 | metadata: null, 24 | phone: +525511223344, 25 | tax_id: AAA010101AAA 26 | ) 27 | ``` 28 | 29 | -------------------------------------------------------------------------------- /docs/OrderUpdateRequestCustomerInfo.md: -------------------------------------------------------------------------------- 1 | # Conekta::OrderUpdateRequestCustomerInfo 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 'conekta' 13 | 14 | Conekta::OrderUpdateRequestCustomerInfo.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 'conekta' 30 | 31 | Conekta::OrderUpdateRequestCustomerInfo.build(data) 32 | # => # 33 | 34 | Conekta::OrderUpdateRequestCustomerInfo.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 | 50 | -------------------------------------------------------------------------------- /docs/OrdersResponse.md: -------------------------------------------------------------------------------- 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 | 19 | -------------------------------------------------------------------------------- /docs/Page.md: -------------------------------------------------------------------------------- 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 | 21 | -------------------------------------------------------------------------------- /docs/Pagination.md: -------------------------------------------------------------------------------- 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 | 21 | -------------------------------------------------------------------------------- /docs/PaymentMethod.md: -------------------------------------------------------------------------------- 1 | # Conekta::PaymentMethod 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **type** | **String** | | [optional] | 8 | | **object** | **String** | | | 9 | 10 | ## Example 11 | 12 | ```ruby 13 | require 'conekta' 14 | 15 | instance = Conekta::PaymentMethod.new( 16 | type: null, 17 | object: payment_source 18 | ) 19 | ``` 20 | 21 | -------------------------------------------------------------------------------- /docs/PaymentMethodBankTransfer.md: -------------------------------------------------------------------------------- 1 | # Conekta::PaymentMethodBankTransfer 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **type** | **String** | | [optional] | 8 | | **object** | **String** | | | 9 | | **bank** | **String** | | [optional] | 10 | | **clabe** | **String** | | [optional] | 11 | | **description** | **String** | | [optional] | 12 | | **executed_at** | **String** | | [optional] | 13 | | **expires_at** | **Integer** | | [optional] | 14 | | **issuing_account_bank** | **String** | | [optional] | 15 | | **issuing_account_number** | **String** | | [optional] | 16 | | **issuing_account_holder_name** | **String** | | [optional] | 17 | | **issuing_account_tax_id** | **String** | | [optional] | 18 | | **payment_attempts** | **Array<Object>** | | [optional] | 19 | | **receiving_account_holder_name** | **String** | | [optional] | 20 | | **receiving_account_number** | **String** | | [optional] | 21 | | **receiving_account_bank** | **String** | | [optional] | 22 | | **receiving_account_tax_id** | **String** | | [optional] | 23 | | **reference_number** | **String** | | [optional] | 24 | | **tracking_code** | **String** | | [optional] | 25 | | **customer_ip_address** | **String** | | [optional] | 26 | 27 | ## Example 28 | 29 | ```ruby 30 | require 'conekta' 31 | 32 | instance = Conekta::PaymentMethodBankTransfer.new( 33 | type: null, 34 | object: payment_source, 35 | bank: STP, 36 | clabe: 646180111805034237, 37 | description: null, 38 | executed_at: null, 39 | expires_at: 1683053729, 40 | issuing_account_bank: null, 41 | issuing_account_number: null, 42 | issuing_account_holder_name: null, 43 | issuing_account_tax_id: null, 44 | payment_attempts: null, 45 | receiving_account_holder_name: null, 46 | receiving_account_number: 646180111805034237, 47 | receiving_account_bank: STP, 48 | receiving_account_tax_id: null, 49 | reference_number: null, 50 | tracking_code: null, 51 | customer_ip_address: 0.0.0.0 52 | ) 53 | ``` 54 | 55 | -------------------------------------------------------------------------------- /docs/PaymentMethodBnplPayment.md: -------------------------------------------------------------------------------- 1 | # Conekta::PaymentMethodBnplPayment 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **type** | **String** | | [optional] | 8 | | **object** | **String** | | | 9 | | **cancel_url** | **String** | URL to redirect the customer after a canceled payment | [optional] | 10 | | **expires_at** | **Integer** | Expiration date of the charge | | 11 | | **failure_url** | **String** | URL to redirect the customer after a failed payment | [optional] | 12 | | **product_type** | **String** | Product type of the charge | | 13 | | **redirect_url** | **String** | URL to redirect the customer to complete the payment | [optional] | 14 | | **success_url** | **String** | URL to redirect the customer after a successful payment | [optional] | 15 | 16 | ## Example 17 | 18 | ```ruby 19 | require 'conekta' 20 | 21 | instance = Conekta::PaymentMethodBnplPayment.new( 22 | type: null, 23 | object: payment_source, 24 | cancel_url: https://example.com/cancel, 25 | expires_at: 1683053729, 26 | failure_url: https://example.com/failure, 27 | product_type: null, 28 | redirect_url: https://example.com/redirect, 29 | success_url: https://example.com/success 30 | ) 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /docs/PaymentMethodBnplRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::PaymentMethodBnplRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **type** | **String** | Type of the payment method | | 8 | | **cancel_url** | **String** | URL to redirect the customer after a canceled payment | | 9 | | **can_not_expire** | **Boolean** | Indicates if the payment method can not expire | | 10 | | **failure_url** | **String** | URL to redirect the customer after a failed payment | | 11 | | **product_type** | **String** | Product type of the payment method, use for the payment method to know the product type | | 12 | | **success_url** | **String** | URL to redirect the customer after a successful payment | | 13 | 14 | ## Example 15 | 16 | ```ruby 17 | require 'conekta' 18 | 19 | instance = Conekta::PaymentMethodBnplRequest.new( 20 | type: bnpl, 21 | cancel_url: https://example.com/cancel, 22 | can_not_expire: true, 23 | failure_url: https://example.com/failure, 24 | product_type: klarna_bnpl, 25 | success_url: https://example.com/success 26 | ) 27 | ``` 28 | 29 | -------------------------------------------------------------------------------- /docs/PaymentMethodCard.md: -------------------------------------------------------------------------------- 1 | # Conekta::PaymentMethodCard 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **type** | **String** | | [optional] | 8 | | **object** | **String** | | | 9 | | **account_type** | **String** | Account type of the card | [optional] | 10 | | **auth_code** | **String** | | [optional] | 11 | | **brand** | **String** | Brand of the card | [optional] | 12 | | **contract_id** | **String** | Id sent for recurrent charges. | [optional] | 13 | | **country** | **String** | Country of the card | [optional] | 14 | | **exp_month** | **String** | Expiration month of the card | [optional] | 15 | | **exp_year** | **String** | Expiration year of the card | [optional] | 16 | | **fraud_indicators** | **Array<Object>** | | [optional] | 17 | | **issuer** | **String** | Issuer of the card | [optional] | 18 | | **last4** | **String** | Last 4 digits of the card | [optional] | 19 | | **name** | **String** | Name of the cardholder | [optional] | 20 | | **customer_ip_address** | **String** | Optional field used to capture the customer's IP address for fraud prevention and security monitoring purposes | [optional] | 21 | 22 | ## Example 23 | 24 | ```ruby 25 | require 'conekta' 26 | 27 | instance = Conekta::PaymentMethodCard.new( 28 | type: null, 29 | object: payment_source, 30 | account_type: Credit, 31 | auth_code: 867372, 32 | brand: visa, 33 | contract_id: S781317595, 34 | country: MX, 35 | exp_month: 02, 36 | exp_year: 2026, 37 | fraud_indicators: null, 38 | issuer: BANAMEX, 39 | last4: 4242, 40 | name: Fulanito Perez, 41 | customer_ip_address: 0.0.0.0 42 | ) 43 | ``` 44 | 45 | -------------------------------------------------------------------------------- /docs/PaymentMethodCardRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::PaymentMethodCardRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **type** | **String** | Type of payment method | | 8 | | **cvc** | **String** | Card security code | | 9 | | **exp_month** | **String** | Card expiration month | | 10 | | **exp_year** | **String** | Card expiration year | | 11 | | **name** | **String** | Cardholder name | | 12 | | **number** | **String** | Card number | | 13 | | **customer_ip_address** | **String** | Optional field used to capture the customer's IP address for fraud prevention and security monitoring purposes | [optional] | 14 | 15 | ## Example 16 | 17 | ```ruby 18 | require 'conekta' 19 | 20 | instance = Conekta::PaymentMethodCardRequest.new( 21 | type: card | cash | spei | bnpl, 22 | cvc: 198, 23 | exp_month: 12, 24 | exp_year: 2025, 25 | name: John Doe, 26 | number: 4242424242424242, 27 | customer_ip_address: 0.0.0.0 28 | ) 29 | ``` 30 | 31 | -------------------------------------------------------------------------------- /docs/PaymentMethodCardResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::PaymentMethodCardResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **type** | **String** | | | 8 | | **id** | **String** | | | 9 | | **object** | **String** | | | 10 | | **created_at** | **Integer** | | | 11 | | **parent_id** | **String** | | [optional] | 12 | | **last4** | **String** | | [optional] | 13 | | **bin** | **String** | | [optional] | 14 | | **card_type** | **String** | | [optional] | 15 | | **exp_month** | **String** | | [optional] | 16 | | **exp_year** | **String** | | [optional] | 17 | | **brand** | **String** | | [optional] | 18 | | **name** | **String** | | [optional] | 19 | | **default** | **Boolean** | | [optional] | 20 | | **visible_on_checkout** | **Boolean** | | [optional] | 21 | | **payment_source_status** | **String** | | [optional] | 22 | 23 | ## Example 24 | 25 | ```ruby 26 | require 'conekta' 27 | 28 | instance = Conekta::PaymentMethodCardResponse.new( 29 | type: null, 30 | id: src_2s8K1B3PBKDontpi9, 31 | object: payment_source, 32 | created_at: 1675715413, 33 | parent_id: cus_2s8K1B3PBKDontpi8, 34 | last4: 6410, 35 | bin: 40276657, 36 | card_type: debit, 37 | exp_month: 10, 38 | exp_year: 25, 39 | brand: visa, 40 | name: Fulano Perez", 41 | default: null, 42 | visible_on_checkout: null, 43 | payment_source_status: active 44 | ) 45 | ``` 46 | 47 | -------------------------------------------------------------------------------- /docs/PaymentMethodCash.md: -------------------------------------------------------------------------------- 1 | # Conekta::PaymentMethodCash 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **type** | **String** | | [optional] | 8 | | **object** | **String** | | | 9 | | **agreement** | **String** | Agreement ID | [optional] | 10 | | **auth_code** | **Integer** | | [optional] | 11 | | **cashier_id** | **String** | | [optional] | 12 | | **reference** | **String** | | [optional] | 13 | | **barcode_url** | **String** | | [optional] | 14 | | **expires_at** | **Integer** | | [optional] | 15 | | **product_type** | **String** | Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in, etc. | [optional] | 16 | | **service_name** | **String** | | [optional] | 17 | | **store** | **String** | | [optional] | 18 | | **store_name** | **String** | | [optional] | 19 | | **customer_ip_address** | **String** | | [optional] | 20 | 21 | ## Example 22 | 23 | ```ruby 24 | require 'conekta' 25 | 26 | instance = Conekta::PaymentMethodCash.new( 27 | type: null, 28 | object: payment_source, 29 | agreement: agreement_2tN73UdUSNrYRPD9r, 30 | auth_code: 542563, 31 | cashier_id: OINM01010, 32 | reference: 93000262276908, 33 | barcode_url: https://barcodes.conekta.com/644ebf80f2243197aad6cd8810375b905b613dbe.png, 34 | expires_at: 0, 35 | product_type: bbva_cash_in, 36 | service_name: store, 37 | store: 10MON50EDI, 38 | store_name: wallmart, 39 | customer_ip_address: 0.0.0.0 40 | ) 41 | ``` 42 | 43 | -------------------------------------------------------------------------------- /docs/PaymentMethodCashRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::PaymentMethodCashRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **type** | **String** | Type of payment method | | 8 | | **expires_at** | **Integer** | | [optional] | 9 | 10 | ## Example 11 | 12 | ```ruby 13 | require 'conekta' 14 | 15 | instance = Conekta::PaymentMethodCashRequest.new( 16 | type: card | cash | spei | bnpl, 17 | expires_at: 1553273553 18 | ) 19 | ``` 20 | 21 | -------------------------------------------------------------------------------- /docs/PaymentMethodCashResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::PaymentMethodCashResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **type** | **String** | | | 8 | | **id** | **String** | | | 9 | | **object** | **String** | | | 10 | | **created_at** | **Integer** | | | 11 | | **parent_id** | **String** | | [optional] | 12 | | **agreements** | [**Array<PaymentMethodCashResponseAllOfAgreements>**](PaymentMethodCashResponseAllOfAgreements.md) | | [optional] | 13 | | **reference** | **String** | | [optional] | 14 | | **barcode** | **String** | | [optional] | 15 | | **barcode_url** | **String** | URL to the barcode image, reference is the same as barcode | [optional] | 16 | | **expires_at** | **Integer** | | [optional] | 17 | | **provider** | **String** | | [optional] | 18 | 19 | ## Example 20 | 21 | ```ruby 22 | require 'conekta' 23 | 24 | instance = Conekta::PaymentMethodCashResponse.new( 25 | type: null, 26 | id: src_2s8K1B3PBKDontpi9, 27 | object: payment_source, 28 | created_at: 1675715413, 29 | parent_id: cus_2s8K1B3PBKDontpi8, 30 | agreements: null, 31 | reference: 93000262276908, 32 | barcode: 93000262276908, 33 | barcode_url: https://barcodes.conekta.com/644ebf80f2243197aad6cd8810375b905b613dbe.png, 34 | expires_at: 1742483424, 35 | provider: Cash 36 | ) 37 | ``` 38 | 39 | -------------------------------------------------------------------------------- /docs/PaymentMethodCashResponseAllOfAgreements.md: -------------------------------------------------------------------------------- 1 | # Conekta::PaymentMethodCashResponseAllOfAgreements 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **agreement** | **String** | Agreement number, you can use this number to pay in the store/bbva | [optional] | 8 | | **provider** | **String** | Provider name, you can use this to know where to pay | [optional] | 9 | 10 | ## Example 11 | 12 | ```ruby 13 | require 'conekta' 14 | 15 | instance = Conekta::PaymentMethodCashResponseAllOfAgreements.new( 16 | agreement: 2409526, 17 | provider: bbva_cash_in 18 | ) 19 | ``` 20 | 21 | -------------------------------------------------------------------------------- /docs/PaymentMethodGeneralRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::PaymentMethodGeneralRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **expires_at** | **Integer** | Method expiration date as unix timestamp | [optional] | 8 | | **monthly_installments** | **Integer** | How many months without interest to apply, it can be 3, 6, 9, 12 or 18 | [optional] | 9 | | **type** | **String** | Type of payment method | | 10 | | **token_id** | **String** | | [optional] | 11 | | **payment_source_id** | **String** | | [optional] | 12 | | **cvc** | **String** | Optional, It is a value that allows identifying the security code of the card. Only for PCI merchants | [optional] | 13 | | **contract_id** | **String** | Optional id sent to indicate the bank contract for recurrent card charges. | [optional] | 14 | | **customer_ip_address** | **String** | Optional field used to capture the customer's IP address for fraud prevention and security monitoring purposes | [optional] | 15 | 16 | ## Example 17 | 18 | ```ruby 19 | require 'conekta' 20 | 21 | instance = Conekta::PaymentMethodGeneralRequest.new( 22 | expires_at: 1677196303, 23 | monthly_installments: null, 24 | type: card, 25 | token_id: tok_2897348234, 26 | payment_source_id: src_2tLkkyfMPh6v7pFry, 27 | cvc: 123, 28 | contract_id: S781317595, 29 | customer_ip_address: 0.0.0.0 30 | ) 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /docs/PaymentMethodResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::PaymentMethodResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **type** | **String** | | | 8 | | **id** | **String** | | | 9 | | **object** | **String** | | | 10 | | **created_at** | **Integer** | | | 11 | | **parent_id** | **String** | | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::PaymentMethodResponse.new( 19 | type: null, 20 | id: src_2s8K1B3PBKDontpi9, 21 | object: payment_source, 22 | created_at: 1675715413, 23 | parent_id: cus_2s8K1B3PBKDontpi8 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/PaymentMethodSpeiRecurrent.md: -------------------------------------------------------------------------------- 1 | # Conekta::PaymentMethodSpeiRecurrent 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **type** | **String** | | | 8 | | **id** | **String** | | | 9 | | **object** | **String** | | | 10 | | **created_at** | **Integer** | | | 11 | | **parent_id** | **String** | | [optional] | 12 | | **reference** | **String** | | [optional] | 13 | | **expires_at** | **String** | | [optional] | 14 | 15 | ## Example 16 | 17 | ```ruby 18 | require 'conekta' 19 | 20 | instance = Conekta::PaymentMethodSpeiRecurrent.new( 21 | type: null, 22 | id: src_2s8K1B3PBKDontpi9, 23 | object: payment_source, 24 | created_at: 1675715413, 25 | parent_id: cus_2s8K1B3PBKDontpi8, 26 | reference: 93000262276908, 27 | expires_at: none 28 | ) 29 | ``` 30 | 31 | -------------------------------------------------------------------------------- /docs/PaymentMethodSpeiRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::PaymentMethodSpeiRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **type** | **String** | Type of payment method | | 8 | | **expires_at** | **Integer** | | [optional] | 9 | 10 | ## Example 11 | 12 | ```ruby 13 | require 'conekta' 14 | 15 | instance = Conekta::PaymentMethodSpeiRequest.new( 16 | type: card | cash | spei | bnpl, 17 | expires_at: 1553273553 18 | ) 19 | ``` 20 | 21 | -------------------------------------------------------------------------------- /docs/PaymentMethodTokenRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::PaymentMethodTokenRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **type** | **String** | Type of payment method | | 8 | | **token_id** | **String** | Token id that will be used to create a \"card\" type payment method. See the (subscriptions)[https://developers.conekta.com/v2.2.0/reference/createsubscription] tutorial for more information on how to tokenize cards. | | 9 | 10 | ## Example 11 | 12 | ```ruby 13 | require 'conekta' 14 | 15 | instance = Conekta::PaymentMethodTokenRequest.new( 16 | type: card | cash | spei | bnpl, 17 | token_id: tok_32hj4g234as 18 | ) 19 | ``` 20 | 21 | -------------------------------------------------------------------------------- /docs/Payout.md: -------------------------------------------------------------------------------- 1 | # Conekta::Payout 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **payout_method** | [**PayoutMethod**](PayoutMethod.md) | | | 8 | 9 | ## Example 10 | 11 | ```ruby 12 | require 'conekta' 13 | 14 | instance = Conekta::Payout.new( 15 | payout_method: null 16 | ) 17 | ``` 18 | 19 | -------------------------------------------------------------------------------- /docs/PayoutMethod.md: -------------------------------------------------------------------------------- 1 | # Conekta::PayoutMethod 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **type** | **String** | The type of the payout method. | | 8 | 9 | ## Example 10 | 11 | ```ruby 12 | require 'conekta' 13 | 14 | instance = Conekta::PayoutMethod.new( 15 | type: cashout 16 | ) 17 | ``` 18 | 19 | -------------------------------------------------------------------------------- /docs/PayoutOrder.md: -------------------------------------------------------------------------------- 1 | # Conekta::PayoutOrder 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **allowed_payout_methods** | **Array<String>** | The payout methods that are allowed for the payout order. | | 8 | | **amount** | **Integer** | The amount of the payout order. | | 9 | | **currency** | **String** | The currency in which the payout order is made. | [default to 'MXN'] | 10 | | **customer_info** | [**CustomerInfoJustCustomerId**](CustomerInfoJustCustomerId.md) | | | 11 | | **metadata** | **Hash<String, Object>** | The metadata of the payout order. | [optional] | 12 | | **payout** | [**Payout**](Payout.md) | | | 13 | | **reason** | **String** | The reason for the payout order. | | 14 | 15 | ## Example 16 | 17 | ```ruby 18 | require 'conekta' 19 | 20 | instance = Conekta::PayoutOrder.new( 21 | allowed_payout_methods: ["cashout"], 22 | amount: 100, 23 | currency: MXN, 24 | customer_info: null, 25 | metadata: {"custom_client_id":"12345"}, 26 | payout: null, 27 | reason: Payout order for the customer 28 | ) 29 | ``` 30 | 31 | -------------------------------------------------------------------------------- /docs/PayoutOrderPayoutsItem.md: -------------------------------------------------------------------------------- 1 | # Conekta::PayoutOrderPayoutsItem 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **amount** | **Integer** | The amount of the payout. | | 8 | | **currency** | **String** | The currency in which the payout is made. | | 9 | | **expires_at** | **Integer** | The expiration date of the payout. | [optional] | 10 | | **id** | **String** | The id of the payout. | | 11 | | **livemode** | **Boolean** | The live mode of the payout. | | 12 | | **object** | **String** | The object of the payout. | | 13 | | **payout_order_id** | **String** | The id of the payout order. | [optional] | 14 | | **status** | **String** | The status of the payout. | [optional] | 15 | 16 | ## Example 17 | 18 | ```ruby 19 | require 'conekta' 20 | 21 | instance = Conekta::PayoutOrderPayoutsItem.new( 22 | amount: 3000, 23 | currency: MXN, 24 | expires_at: 1677626837, 25 | id: payout_2vZwsRAhhGp2dFDJx, 26 | livemode: true, 27 | object: payout, 28 | payout_order_id: f2654d66-d740-457a-9a8c-f96b5196f44e, 29 | status: open 30 | ) 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /docs/PayoutOrderResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::PayoutOrderResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **allowed_payout_methods** | **Array<String>** | The payout methods that are allowed for the payout order. | | 8 | | **amount** | **Integer** | The amount of the payout order. | | 9 | | **created_at** | **Integer** | The creation date of the payout order. | | 10 | | **currency** | **String** | The currency in which the payout order is made. | [default to 'MXN'] | 11 | | **customer_info** | [**PayoutOrderResponseCustomerInfo**](PayoutOrderResponseCustomerInfo.md) | | | 12 | | **expires_at** | **Integer** | The expiration date of the payout order. | [optional] | 13 | | **id** | **String** | The id of the payout order. | | 14 | | **livemode** | **Boolean** | The live mode of the payout order. | | 15 | | **object** | **String** | The object of the payout order. | | 16 | | **metadata** | **Hash<String, Object>** | The metadata of the payout order. | [optional] | 17 | | **payouts** | [**Array<PayoutOrderPayoutsItem>**](PayoutOrderPayoutsItem.md) | The payout information of the payout order. | | 18 | | **reason** | **String** | The reason for the payout order. | | 19 | | **status** | **String** | The status of the payout order. | [optional] | 20 | | **updated_at** | **Integer** | The update date of the payout order. | | 21 | 22 | ## Example 23 | 24 | ```ruby 25 | require 'conekta' 26 | 27 | instance = Conekta::PayoutOrderResponse.new( 28 | allowed_payout_methods: ["cashout"], 29 | amount: 100, 30 | created_at: 1677626837, 31 | currency: MXN, 32 | customer_info: null, 33 | expires_at: 1677626837, 34 | id: f2654d66-d740-457a-9a8c-f96b5196f44e, 35 | livemode: true, 36 | object: payout_order, 37 | metadata: {"custom_client_id":"12345"}, 38 | payouts: null, 39 | reason: Payout order for the customer, 40 | status: open, 41 | updated_at: 1677626837 42 | ) 43 | ``` 44 | 45 | -------------------------------------------------------------------------------- /docs/PayoutOrderResponseCustomerInfo.md: -------------------------------------------------------------------------------- 1 | # Conekta::PayoutOrderResponseCustomerInfo 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **customer_custom_reference** | **String** | Custom reference | [optional] | 8 | | **name** | **String** | | [optional] | 9 | | **email** | **String** | | [optional] | 10 | | **phone** | **String** | | [optional] | 11 | | **corporate** | **Boolean** | | [optional][default to false] | 12 | | **object** | **String** | | [optional] | 13 | | **id** | **String** | The id of the customer. | | 14 | 15 | ## Example 16 | 17 | ```ruby 18 | require 'conekta' 19 | 20 | instance = Conekta::PayoutOrderResponseCustomerInfo.new( 21 | customer_custom_reference: custom_reference, 22 | name: DevTest, 23 | email: test@conekta.com, 24 | phone: 5522997233, 25 | corporate: null, 26 | object: customer_info, 27 | id: cus_23874283647 28 | ) 29 | ``` 30 | 31 | -------------------------------------------------------------------------------- /docs/PayoutOrdersResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::PayoutOrdersResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **has_more** | **Boolean** | Indicates if there are more pages to be requested | | 8 | | **object** | **String** | Object type, in this case is list | | 9 | | **next_page_url** | **String** | URL of the next page. | [optional] | 10 | | **previous_page_url** | **String** | Url of the previous page. | [optional] | 11 | | **data** | [**Array<PayoutOrderResponse>**](PayoutOrderResponse.md) | | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::PayoutOrdersResponse.new( 19 | has_more: false, 20 | object: list, 21 | next_page_url: https://api.conekta.io/resources?limit=10&next=chrg_1, 22 | previous_page_url: https://api.conekta.io/resources?limit=10&previous=chrg_1, 23 | data: null 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/PlanRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::PlanRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **amount** | **Integer** | The amount in cents that will be charged on the interval specified. | | 8 | | **currency** | **String** | ISO 4217 for currencies, for the Mexican peso it is MXN/USD | [optional] | 9 | | **expiry_count** | **Integer** | Number of repetitions of the frequency NUMBER OF CHARGES TO BE MADE, considering the interval and frequency, this evolves over time, but is subject to the expiration count. | [optional] | 10 | | **frequency** | **Integer** | Frequency of the charge, which together with the interval, can be every 3 weeks, every 4 months, every 2 years, every 5 fortnights | | 11 | | **id** | **String** | internal reference id | [optional] | 12 | | **interval** | **String** | The interval of time between each charge. | | 13 | | **name** | **String** | The name of the plan. | | 14 | | **trial_period_days** | **Integer** | The number of days the customer will have a free trial. | [optional] | 15 | | **max_retries** | **Integer** | (optional) Specifies the maximum number of retry attempts for a subscription payment before it is canceled. | [optional] | 16 | | **retry_delay_hours** | **Integer** | (optional) Defines the number of hours between subscription payment retry attempts. | [optional] | 17 | 18 | ## Example 19 | 20 | ```ruby 21 | require 'conekta' 22 | 23 | instance = Conekta::PlanRequest.new( 24 | amount: 10000, 25 | currency: MXN, 26 | expiry_count: 12, 27 | frequency: 1, 28 | id: plan_24234, 29 | interval: null, 30 | name: Extra Plan3, 31 | trial_period_days: 0, 32 | max_retries: 3, 33 | retry_delay_hours: 50 34 | ) 35 | ``` 36 | 37 | -------------------------------------------------------------------------------- /docs/PlanResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::PlanResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **amount** | **Integer** | | [optional] | 8 | | **created_at** | **Integer** | | [optional] | 9 | | **currency** | **String** | | [optional] | 10 | | **expiry_count** | **Integer** | | [optional] | 11 | | **frequency** | **Integer** | | [optional] | 12 | | **id** | **String** | | [optional] | 13 | | **interval** | **String** | | [optional] | 14 | | **livemode** | **Boolean** | | [optional] | 15 | | **name** | **String** | | [optional] | 16 | | **object** | **String** | | [optional] | 17 | | **trial_period_days** | **Integer** | | [optional] | 18 | | **max_retries** | **Integer** | | [optional] | 19 | | **retry_delay_hours** | **Integer** | | [optional] | 20 | 21 | ## Example 22 | 23 | ```ruby 24 | require 'conekta' 25 | 26 | instance = Conekta::PlanResponse.new( 27 | amount: 10000, 28 | created_at: 1666900846, 29 | currency: MXN, 30 | expiry_count: 12, 31 | frequency: 1, 32 | id: gold-plan, 33 | interval: month, 34 | livemode: true, 35 | name: Extra Plan3, 36 | object: plan, 37 | trial_period_days: 0, 38 | max_retries: 3, 39 | retry_delay_hours: 48 40 | ) 41 | ``` 42 | 43 | -------------------------------------------------------------------------------- /docs/PlanUpdateRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::PlanUpdateRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **amount** | **Integer** | The amount in cents that will be charged on the interval specified. | [optional] | 8 | | **currency** | **String** | ISO 4217 for currencies, for the Mexican peso it is MXN/USD | [optional] | 9 | | **expiry_count** | **Integer** | Number of repetitions of the frequency NUMBER OF CHARGES TO BE MADE, considering the interval and frequency, this evolves over time, but is subject to the expiration count. | [optional] | 10 | | **name** | **String** | The name of the plan. | [optional] | 11 | 12 | ## Example 13 | 14 | ```ruby 15 | require 'conekta' 16 | 17 | instance = Conekta::PlanUpdateRequest.new( 18 | amount: 10000, 19 | currency: MXN, 20 | expiry_count: 12, 21 | name: Extra Plan3 22 | ) 23 | ``` 24 | 25 | -------------------------------------------------------------------------------- /docs/Product.md: -------------------------------------------------------------------------------- 1 | # Conekta::Product 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **antifraud_info** | **Hash<String, Object>** | | [optional] | 8 | | **brand** | **String** | The brand of the item. | [optional] | 9 | | **description** | **String** | Short description of the item | [optional] | 10 | | **metadata** | **Hash<String, Object>** | It is a key/value hash that can hold custom fields. Maximum 100 elements and allows special characters. | [optional] | 11 | | **name** | **String** | The name of the item. It will be displayed in the order. | | 12 | | **quantity** | **Integer** | The quantity of the item in the order. | | 13 | | **sku** | **String** | The stock keeping unit for the item. It is used to identify the item in the order. | [optional] | 14 | | **tags** | **Array<String>** | List of tags for the item. It is used to identify the item in the order. | [optional] | 15 | | **unit_price** | **Integer** | The price of the item in cents. | | 16 | 17 | ## Example 18 | 19 | ```ruby 20 | require 'conekta' 21 | 22 | instance = Conekta::Product.new( 23 | antifraud_info: {"key":"value"}, 24 | brand: Cohiba, 25 | description: Imported From Mex., 26 | metadata: {"key":"value"}, 27 | name: Box of Cohiba S1s, 28 | quantity: 1, 29 | sku: XYZ12345, 30 | tags: ["food","mexican food"], 31 | unit_price: 20000 32 | ) 33 | ``` 34 | 35 | -------------------------------------------------------------------------------- /docs/ProductDataResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::ProductDataResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **antifraud_info** | **Hash<String, Object>** | | [optional] | 8 | | **brand** | **String** | The brand of the item. | [optional] | 9 | | **description** | **String** | Short description of the item | [optional] | 10 | | **metadata** | **Hash<String, Object>** | It is a key/value hash that can hold custom fields. Maximum 100 elements and allows special characters. | [optional] | 11 | | **name** | **String** | The name of the item. It will be displayed in the order. | | 12 | | **quantity** | **Integer** | The quantity of the item in the order. | | 13 | | **sku** | **String** | The stock keeping unit for the item. It is used to identify the item in the order. | [optional] | 14 | | **tags** | **Array<String>** | List of tags for the item. It is used to identify the item in the order. | [optional] | 15 | | **unit_price** | **Integer** | The price of the item in cents. | | 16 | | **id** | **String** | | [optional] | 17 | | **object** | **String** | | [optional] | 18 | | **parent_id** | **String** | | [optional] | 19 | 20 | ## Example 21 | 22 | ```ruby 23 | require 'conekta' 24 | 25 | instance = Conekta::ProductDataResponse.new( 26 | antifraud_info: {key=value}, 27 | brand: Cohiba, 28 | description: Imported From Mex., 29 | metadata: {key=value}, 30 | name: Box of Cohiba S1s, 31 | quantity: 1, 32 | sku: XYZ12345, 33 | tags: [food, mexican food], 34 | unit_price: 20000, 35 | id: null, 36 | object: null, 37 | parent_id: null 38 | ) 39 | ``` 40 | 41 | -------------------------------------------------------------------------------- /docs/ProductOrderResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::ProductOrderResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **antifraud_info** | **Hash<String, Object>** | | [optional] | 8 | | **brand** | **String** | The brand of the item. | [optional] | 9 | | **description** | **String** | Short description of the item | [optional] | 10 | | **metadata** | **Hash<String, Object>** | It is a key/value hash that can hold custom fields. Maximum 100 elements and allows special characters. | [optional] | 11 | | **name** | **String** | The name of the item. It will be displayed in the order. | | 12 | | **quantity** | **Integer** | The quantity of the item in the order. | | 13 | | **sku** | **String** | The stock keeping unit for the item. It is used to identify the item in the order. | [optional] | 14 | | **tags** | **Array<String>** | List of tags for the item. It is used to identify the item in the order. | [optional] | 15 | | **unit_price** | **Integer** | The price of the item in cents. | | 16 | | **id** | **String** | | [optional] | 17 | | **object** | **String** | | [optional] | 18 | | **parent_id** | **String** | | [optional] | 19 | 20 | ## Example 21 | 22 | ```ruby 23 | require 'conekta' 24 | 25 | instance = Conekta::ProductOrderResponse.new( 26 | antifraud_info: {key=value}, 27 | brand: Cohiba, 28 | description: Imported From Mex., 29 | metadata: {key=value}, 30 | name: Box of Cohiba S1s, 31 | quantity: 1, 32 | sku: XYZ12345, 33 | tags: [food, mexican food], 34 | unit_price: 20000, 35 | id: null, 36 | object: null, 37 | parent_id: null 38 | ) 39 | ``` 40 | 41 | -------------------------------------------------------------------------------- /docs/ResendRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::ResendRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **webhooks_ids** | **Array<String>** | webhooks ids to resend event | | 8 | 9 | ## Example 10 | 11 | ```ruby 12 | require 'conekta' 13 | 14 | instance = Conekta::ResendRequest.new( 15 | webhooks_ids: ["6307a60c41de27127515a575","6307a60c41de27127515a571"] 16 | ) 17 | ``` 18 | 19 | -------------------------------------------------------------------------------- /docs/RiskRulesData.md: -------------------------------------------------------------------------------- 1 | # Conekta::RiskRulesData 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **id** | **String** | rule id | [optional] | 8 | | **field** | **String** | field to be used for the rule | [optional] | 9 | | **created_at** | **String** | rule creation date | [optional] | 10 | | **value** | **String** | value to be used for the rule | [optional] | 11 | | **is_global** | **Boolean** | if the rule is global | [optional] | 12 | | **is_test** | **Boolean** | if the rule is test | [optional] | 13 | | **description** | **String** | description of the rule | [optional] | 14 | 15 | ## Example 16 | 17 | ```ruby 18 | require 'conekta' 19 | 20 | instance = Conekta::RiskRulesData.new( 21 | id: 618c3f2fdb8b8da9be376af9, 22 | field: email, 23 | created_at: 2021-11-10T21:52:47.339Z, 24 | value: email@example.com, 25 | is_global: false, 26 | is_test: false, 27 | description: secure customer example@example.com 28 | ) 29 | ``` 30 | 31 | -------------------------------------------------------------------------------- /docs/RiskRulesList.md: -------------------------------------------------------------------------------- 1 | # Conekta::RiskRulesList 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **has_more** | **Boolean** | Indicates if there are more pages to be requested | | 8 | | **object** | **String** | Object type, in this case is list | | 9 | | **next_page_url** | **String** | URL of the next page. | [optional] | 10 | | **previous_page_url** | **String** | Url of the previous page. | [optional] | 11 | | **data** | [**Array<RiskRulesData>**](RiskRulesData.md) | | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::RiskRulesList.new( 19 | has_more: false, 20 | object: list, 21 | next_page_url: https://api.conekta.io/resources?limit=10&next=chrg_1, 22 | previous_page_url: https://api.conekta.io/resources?limit=10&previous=chrg_1, 23 | data: null 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/ShippingOrderResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::ShippingOrderResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **amount** | **Integer** | Shipping amount in cents | | 8 | | **carrier** | **String** | Carrier name for the shipment | [optional] | 9 | | **tracking_number** | **String** | Tracking number can be used to track the shipment | [optional] | 10 | | **method** | **String** | Method of shipment | [optional] | 11 | | **metadata** | **Hash<String, Object>** | Hash where the user can send additional information for each 'shipping'. | [optional] | 12 | | **id** | **String** | | [optional] | 13 | | **object** | **String** | | [optional] | 14 | | **parent_id** | **String** | | [optional] | 15 | 16 | ## Example 17 | 18 | ```ruby 19 | require 'conekta' 20 | 21 | instance = Conekta::ShippingOrderResponse.new( 22 | amount: 100, 23 | carrier: FEDEX, 24 | tracking_number: TRACK123, 25 | method: Same day, 26 | metadata: {key=value}, 27 | id: null, 28 | object: null, 29 | parent_id: null 30 | ) 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /docs/ShippingRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::ShippingRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **amount** | **Integer** | Shipping amount in cents | | 8 | | **carrier** | **String** | Carrier name for the shipment | [optional] | 9 | | **tracking_number** | **String** | Tracking number can be used to track the shipment | [optional] | 10 | | **method** | **String** | Method of shipment | [optional] | 11 | | **metadata** | **Hash<String, Object>** | Hash where the user can send additional information for each 'shipping'. | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::ShippingRequest.new( 19 | amount: 100, 20 | carrier: FEDEX, 21 | tracking_number: TRACK123, 22 | method: Same day, 23 | metadata: {"key":"value"} 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/SmsCheckoutRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::SmsCheckoutRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **phonenumber** | **String** | | | 8 | 9 | ## Example 10 | 11 | ```ruby 12 | require 'conekta' 13 | 14 | instance = Conekta::SmsCheckoutRequest.new( 15 | phonenumber: 5566982090 16 | ) 17 | ``` 18 | 19 | -------------------------------------------------------------------------------- /docs/SubscriptionEventsResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::SubscriptionEventsResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **has_more** | **Boolean** | Indicates if there are more pages to be requested | | 8 | | **object** | **String** | Object type, in this case is list | | 9 | | **next_page_url** | **String** | URL of the next page. | [optional] | 10 | | **previous_page_url** | **String** | Url of the previous page. | [optional] | 11 | | **data** | [**Array<EventResponse>**](EventResponse.md) | | [optional] | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::SubscriptionEventsResponse.new( 19 | has_more: false, 20 | object: list, 21 | next_page_url: https://api.conekta.io/resources?limit=10&next=chrg_1, 22 | previous_page_url: https://api.conekta.io/resources?limit=10&previous=chrg_1, 23 | data: null 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/SubscriptionRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::SubscriptionRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **plan_id** | **String** | | | 8 | | **card_id** | **String** | | [optional] | 9 | | **trial_end** | **Integer** | | [optional] | 10 | 11 | ## Example 12 | 13 | ```ruby 14 | require 'conekta' 15 | 16 | instance = Conekta::SubscriptionRequest.new( 17 | plan_id: f84gdgf5g48r15fd21g8w424fd1, 18 | card_id: src_2qUCNd5AyQqfPMBuV, 19 | trial_end: 1484040996 20 | ) 21 | ``` 22 | 23 | -------------------------------------------------------------------------------- /docs/SubscriptionResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::SubscriptionResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **billing_cycle_start** | **Integer** | | [optional] | 8 | | **billing_cycle_end** | **Integer** | | [optional] | 9 | | **canceled_at** | **Integer** | | [optional] | 10 | | **canceled_reason** | **String** | Reason for cancellation. This field appears when the subscription status is 'canceled'. | [optional] | 11 | | **card_id** | **String** | | [optional] | 12 | | **charge_id** | **String** | | [optional] | 13 | | **created_at** | **Integer** | | [optional] | 14 | | **customer_custom_reference** | **String** | | [optional] | 15 | | **customer_id** | **String** | | [optional] | 16 | | **id** | **String** | | [optional] | 17 | | **last_billing_cycle_order_id** | **String** | | [optional] | 18 | | **object** | **String** | | [optional] | 19 | | **paused_at** | **Integer** | | [optional] | 20 | | **plan_id** | **String** | | [optional] | 21 | | **status** | **String** | | [optional] | 22 | | **subscription_start** | **Integer** | | [optional] | 23 | | **trial_start** | **Integer** | | [optional] | 24 | | **trial_end** | **Integer** | | [optional] | 25 | 26 | ## Example 27 | 28 | ```ruby 29 | require 'conekta' 30 | 31 | instance = Conekta::SubscriptionResponse.new( 32 | billing_cycle_start: 1677626827, 33 | billing_cycle_end: 1677626827, 34 | canceled_at: 1678258162, 35 | canceled_reason: user_cancelation, 36 | card_id: src_2tKcHxhTz7xU5SymL, 37 | charge_id: 2tKcHxhTz7xU5SymL, 38 | created_at: 1677626837, 39 | customer_custom_reference: dotnet_123456, 40 | customer_id: cus_2tKcHxhTz7xU5SymF, 41 | id: gold-plan, 42 | last_billing_cycle_order_id: ord_2tSoMP7bZJbLiq4z8, 43 | object: subscription, 44 | paused_at: 1678258162, 45 | plan_id: plan_2tXx672QLQ68CkmMn, 46 | status: past_due, 47 | subscription_start: 1677626837, 48 | trial_start: 1677626837, 49 | trial_end: 1677626837 50 | ) 51 | ``` 52 | 53 | -------------------------------------------------------------------------------- /docs/SubscriptionUpdateRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::SubscriptionUpdateRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **plan_id** | **String** | | [optional] | 8 | | **card_id** | **String** | | [optional] | 9 | | **trial_end** | **Integer** | | [optional] | 10 | 11 | ## Example 12 | 13 | ```ruby 14 | require 'conekta' 15 | 16 | instance = Conekta::SubscriptionUpdateRequest.new( 17 | plan_id: f84gdgf5g48r15fd21g8w424fd1, 18 | card_id: src_2qUCNd5AyQqfPMBuV, 19 | trial_end: 1484040996 20 | ) 21 | ``` 22 | 23 | -------------------------------------------------------------------------------- /docs/Token.md: -------------------------------------------------------------------------------- 1 | # Conekta::Token 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **card** | [**TokenCard**](TokenCard.md) | | [optional] | 8 | | **checkout** | [**TokenCheckout**](TokenCheckout.md) | | [optional] | 9 | 10 | ## Example 11 | 12 | ```ruby 13 | require 'conekta' 14 | 15 | instance = Conekta::Token.new( 16 | card: null, 17 | checkout: null 18 | ) 19 | ``` 20 | 21 | -------------------------------------------------------------------------------- /docs/TokenCard.md: -------------------------------------------------------------------------------- 1 | # Conekta::TokenCard 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **cvc** | **String** | It is a value that allows identifying the security code of the card. | | 8 | | **device_fingerprint** | **String** | It is a value that allows identifying the device fingerprint. | [optional] | 9 | | **exp_month** | **String** | It is a value that allows identifying the expiration month of the card. | | 10 | | **exp_year** | **String** | It is a value that allows identifying the expiration year of the card. | | 11 | | **name** | **String** | It is a value that allows identifying the name of the cardholder. | | 12 | | **number** | **String** | It is a value that allows identifying the number of the card. | | 13 | 14 | ## Example 15 | 16 | ```ruby 17 | require 'conekta' 18 | 19 | instance = Conekta::TokenCard.new( 20 | cvc: 123, 21 | device_fingerprint: zptcxk4p6w1ijwz85snf1l3bqe5g09ie, 22 | exp_month: 12, 23 | exp_year: 26, 24 | name: Miguel, 25 | number: 4242424242424242 26 | ) 27 | ``` 28 | 29 | -------------------------------------------------------------------------------- /docs/TokenCheckout.md: -------------------------------------------------------------------------------- 1 | # Conekta::TokenCheckout 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **returns_control_on** | **String** | It is a value that allows identifying the returns control on. | [optional] | 8 | 9 | ## Example 10 | 11 | ```ruby 12 | require 'conekta' 13 | 14 | instance = Conekta::TokenCheckout.new( 15 | returns_control_on: Token 16 | ) 17 | ``` 18 | 19 | -------------------------------------------------------------------------------- /docs/TokenResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::TokenResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **checkout** | [**TokenResponseCheckout**](TokenResponseCheckout.md) | | [optional] | 8 | | **id** | **String** | Unique identifier for the token generated by Conekta. | | 9 | | **livemode** | **Boolean** | Indicates whether the token is in live mode or test mode. | | 10 | | **object** | **String** | Indicates the type of object, in this case token | | 11 | | **used** | **Boolean** | Indicates if the token has been used | | 12 | 13 | ## Example 14 | 15 | ```ruby 16 | require 'conekta' 17 | 18 | instance = Conekta::TokenResponse.new( 19 | checkout: null, 20 | id: cus_2tHJfJ79KyUwpxTik, 21 | livemode: true, 22 | object: token, 23 | used: false 24 | ) 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /docs/TransactionResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::TransactionResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **amount** | **Integer** | The amount of the transaction. | | 8 | | **charge** | **String** | Randomly assigned unique order identifier associated with the charge. | | 9 | | **created_at** | **Integer** | Date and time of creation of the transaction in Unix format. | | 10 | | **currency** | **String** | The currency of the transaction. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217) | | 11 | | **fee** | **Integer** | The amount to be deducted for taxes and commissions. | | 12 | | **id** | **String** | Unique identifier of the transaction. | | 13 | | **livemode** | **Boolean** | Indicates whether the transaction was created in live mode or test mode. | | 14 | | **net** | **Integer** | The net amount after deducting commissions and taxes. | | 15 | | **object** | **String** | Object name, which is transaction. | | 16 | | **status** | **String** | Code indicating transaction status. | | 17 | | **type** | **String** | Transaction Type | | 18 | 19 | ## Example 20 | 21 | ```ruby 22 | require 'conekta' 23 | 24 | instance = Conekta::TransactionResponse.new( 25 | amount: 1000, 26 | charge: 5ee7ec58885a45585e6d9f8m, 27 | created_at: 1553273553, 28 | currency: MXN, 29 | fee: 560, 30 | id: 5ee7ec5b8dea41085erb7f9e, 31 | livemode: true, 32 | net: 440, 33 | object: transaction, 34 | status: pending, 35 | type: capture 36 | ) 37 | ``` 38 | 39 | -------------------------------------------------------------------------------- /docs/TransferDestinationResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::TransferDestinationResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **account_holder** | **String** | Name of the account holder. | [optional] | 8 | | **account_number** | **String** | Account number of the bank account. | [optional] | 9 | | **bank** | **String** | Name of the bank. | [optional] | 10 | | **created_at** | **Integer** | Date and time of creation of the transfer. | [optional] | 11 | | **id** | **String** | Unique identifier of the transfer. | [optional] | 12 | | **object** | **String** | Object name, which is bank_transfer_payout_method. | [optional] | 13 | | **payee_id** | **String** | Unique identifier of the payee. | [optional] | 14 | | **type** | **String** | Type of the payee. | [optional] | 15 | 16 | ## Example 17 | 18 | ```ruby 19 | require 'conekta' 20 | 21 | instance = Conekta::TransferDestinationResponse.new( 22 | account_holder: John Doe, 23 | account_number: 012180023547896764, 24 | bank: BBVA Bancomer, 25 | created_at: 1553273553, 26 | id: pytmtd_2ide3qwTdDvNBosEC, 27 | object: bank_transfer_payout_method, 28 | payee_id: payee_2icdDewRxDENBos85, 29 | type: BankTransferPayoutMethod 30 | ) 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /docs/TransferMethodResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::TransferMethodResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **account_holder** | **String** | Name of the account holder. | [optional] | 8 | | **account_number** | **String** | Account number of the bank account. | [optional] | 9 | | **bank** | **String** | Name of the bank. | [optional] | 10 | | **created_at** | **Integer** | Date and time of creation of the transfer. | [optional] | 11 | | **id** | **String** | Unique identifier of the transfer. | [optional] | 12 | | **object** | **String** | Object name, which is bank_transfer_payout_method. | [optional] | 13 | | **payee_id** | **String** | Unique identifier of the payee. | [optional] | 14 | | **type** | **String** | Type of the payee. | [optional] | 15 | 16 | ## Example 17 | 18 | ```ruby 19 | require 'conekta' 20 | 21 | instance = Conekta::TransferMethodResponse.new( 22 | account_holder: John Doe, 23 | account_number: 012180023547896764, 24 | bank: BBVA Bancomer, 25 | created_at: 1553273553, 26 | id: pytmtd_2ide3qwTdDvNBosEC, 27 | object: bank_transfer_payout_method, 28 | payee_id: payee_2icdDewRxDENBos85, 29 | type: BankTransferPayoutMethod 30 | ) 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /docs/TransferResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::TransferResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **amount** | **Integer** | Amount in cents of the transfer. | [optional] | 8 | | **created_at** | **Integer** | Date and time of creation of the transfer in Unix format. | [optional] | 9 | | **currency** | **String** | The currency of the transfer. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217) | [optional] | 10 | | **id** | **String** | Unique identifier of the transfer. | [optional] | 11 | | **livemode** | **Boolean** | Indicates whether the transfer was created in live mode or test mode. | [optional] | 12 | | **destination** | [**TransferDestinationResponse**](TransferDestinationResponse.md) | | [optional] | 13 | | **object** | **String** | Object name, which is transfer. | [optional] | 14 | | **statement_description** | **String** | Description of the transfer. | [optional] | 15 | | **statement_reference** | **String** | Reference number of the transfer. | [optional] | 16 | | **status** | **String** | Code indicating transfer status. | [optional] | 17 | 18 | ## Example 19 | 20 | ```ruby 21 | require 'conekta' 22 | 23 | instance = Conekta::TransferResponse.new( 24 | amount: 10000, 25 | created_at: 1553273553, 26 | currency: MXN, 27 | id: 5b0337d4dD344ef954fe1X4b6, 28 | livemode: true, 29 | destination: null, 30 | object: transfer, 31 | statement_description: Conekta 4401234, 32 | statement_reference: 4401234, 33 | status: pending 34 | ) 35 | ``` 36 | 37 | -------------------------------------------------------------------------------- /docs/TransfersResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::TransfersResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **amount** | **Integer** | Amount in cents of the transfer. | [optional] | 8 | | **created_at** | **Integer** | Date and time of creation of the transfer. | [optional] | 9 | | **currency** | **String** | The currency of the transfer. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217) | [optional] | 10 | | **id** | **String** | Unique identifier of the transfer. | [optional] | 11 | | **livemode** | **Boolean** | Indicates whether the transfer was created in live mode or test mode. | [optional] | 12 | | **method** | [**TransferMethodResponse**](TransferMethodResponse.md) | | [optional] | 13 | | **object** | **String** | Object name, which is transfer. | [optional] | 14 | | **statement_description** | **String** | Description of the transfer. | [optional] | 15 | | **statement_reference** | **String** | Reference number of the transfer. | [optional] | 16 | | **status** | **String** | Code indicating transfer status. | [optional] | 17 | 18 | ## Example 19 | 20 | ```ruby 21 | require 'conekta' 22 | 23 | instance = Conekta::TransfersResponse.new( 24 | amount: 10000, 25 | created_at: 1553273553, 26 | currency: MXN, 27 | id: 5b0337d4dD344ef954fe1X4b6, 28 | livemode: true, 29 | method: null, 30 | object: transfer, 31 | statement_description: Conekta 4401234, 32 | statement_reference: 4401234, 33 | status: pending 34 | ) 35 | ``` 36 | 37 | -------------------------------------------------------------------------------- /docs/UpdateCustomerAntifraudInfo.md: -------------------------------------------------------------------------------- 1 | # Conekta::UpdateCustomerAntifraudInfo 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **account_created_at** | **Integer** | | [optional] | 8 | | **first_paid_at** | **Integer** | | [optional] | 9 | 10 | ## Example 11 | 12 | ```ruby 13 | require 'conekta' 14 | 15 | instance = Conekta::UpdateCustomerAntifraudInfo.new( 16 | account_created_at: 1484040996, 17 | first_paid_at: 1485151007 18 | ) 19 | ``` 20 | 21 | -------------------------------------------------------------------------------- /docs/UpdateCustomerFiscalEntitiesResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::UpdateCustomerFiscalEntitiesResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **address** | [**CustomerAddress**](CustomerAddress.md) | | | 8 | | **tax_id** | **String** | | [optional] | 9 | | **email** | **String** | | [optional] | 10 | | **phone** | **String** | | [optional] | 11 | | **metadata** | **Hash<String, Object>** | | [optional] | 12 | | **company_name** | **String** | | [optional] | 13 | | **id** | **String** | | | 14 | | **object** | **String** | | | 15 | | **created_at** | **Integer** | | | 16 | | **parent_id** | **String** | | [optional] | 17 | | **default** | **Boolean** | | [optional] | 18 | 19 | ## Example 20 | 21 | ```ruby 22 | require 'conekta' 23 | 24 | instance = Conekta::UpdateCustomerFiscalEntitiesResponse.new( 25 | address: null, 26 | tax_id: null, 27 | email: null, 28 | phone: null, 29 | metadata: null, 30 | company_name: conekta, 31 | id: fis_ent_2tKZsTYcsryyu7Ah8, 32 | object: fiscal_entities, 33 | created_at: 1675715413, 34 | parent_id: cus_2tKcHxhTz7xU5SymF, 35 | default: null 36 | ) 37 | ``` 38 | 39 | -------------------------------------------------------------------------------- /docs/UpdateCustomerPaymentMethodsResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::UpdateCustomerPaymentMethodsResponse 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 'conekta' 13 | 14 | Conekta::UpdateCustomerPaymentMethodsResponse.openapi_one_of 15 | # => 16 | # [ 17 | # :'PaymentMethodCardResponse', 18 | # :'PaymentMethodCashResponse', 19 | # :'PaymentMethodSpeiRecurrent' 20 | # ] 21 | ``` 22 | 23 | ### `openapi_discriminator_name` 24 | 25 | Returns the discriminator's property name. 26 | 27 | #### Example 28 | 29 | ```ruby 30 | require 'conekta' 31 | 32 | Conekta::UpdateCustomerPaymentMethodsResponse.openapi_discriminator_name 33 | # => :'type' 34 | ``` 35 | 36 | ### `openapi_discriminator_name` 37 | 38 | Returns the discriminator's mapping. 39 | 40 | #### Example 41 | 42 | ```ruby 43 | require 'conekta' 44 | 45 | Conekta::UpdateCustomerPaymentMethodsResponse.openapi_discriminator_mapping 46 | # => 47 | # { 48 | # :'card' => :'PaymentMethodCardResponse', 49 | # :'cash' => :'PaymentMethodCashResponse', 50 | # :'cash_recurrent' => :'PaymentMethodCashResponse', 51 | # :'oxxo_recurrent' => :'PaymentMethodCashResponse', 52 | # :'spei_recurrent' => :'PaymentMethodSpeiRecurrent' 53 | # } 54 | ``` 55 | 56 | ### build 57 | 58 | Find the appropriate object from the `openapi_one_of` list and casts the data into it. 59 | 60 | #### Example 61 | 62 | ```ruby 63 | require 'conekta' 64 | 65 | Conekta::UpdateCustomerPaymentMethodsResponse.build(data) 66 | # => # 67 | 68 | Conekta::UpdateCustomerPaymentMethodsResponse.build(data_that_doesnt_match) 69 | # => nil 70 | ``` 71 | 72 | #### Parameters 73 | 74 | | Name | Type | Description | 75 | | ---- | ---- | ----------- | 76 | | **data** | **Mixed** | data to be matched against the list of oneOf items | 77 | 78 | #### Return type 79 | 80 | - `PaymentMethodCardResponse` 81 | - `PaymentMethodCashResponse` 82 | - `PaymentMethodSpeiRecurrent` 83 | - `nil` (if no type matches) 84 | 85 | -------------------------------------------------------------------------------- /docs/UpdateOrderDiscountLinesRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::UpdateOrderDiscountLinesRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **amount** | **Integer** | | [optional] | 8 | | **code** | **String** | Discount code. | [optional] | 9 | | **type** | **String** | | [optional] | 10 | 11 | ## Example 12 | 13 | ```ruby 14 | require 'conekta' 15 | 16 | instance = Conekta::UpdateOrderDiscountLinesRequest.new( 17 | amount: 500, 18 | code: 123, 19 | type: loyalty 20 | ) 21 | ``` 22 | 23 | -------------------------------------------------------------------------------- /docs/UpdateOrderTaxRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::UpdateOrderTaxRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **amount** | **Integer** | The amount to be collected for tax in cents | [optional] | 8 | | **description** | **String** | description or tax's name | [optional] | 9 | | **metadata** | **Hash<String, Object>** | | [optional] | 10 | 11 | ## Example 12 | 13 | ```ruby 14 | require 'conekta' 15 | 16 | instance = Conekta::UpdateOrderTaxRequest.new( 17 | amount: 100, 18 | description: testing, 19 | metadata: null 20 | ) 21 | ``` 22 | 23 | -------------------------------------------------------------------------------- /docs/UpdateOrderTaxResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::UpdateOrderTaxResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **amount** | **Integer** | The amount to be collected for tax in cents | | 8 | | **description** | **String** | description or tax's name | | 9 | | **metadata** | **Hash<String, Object>** | | [optional] | 10 | | **id** | **String** | | | 11 | | **object** | **String** | | [optional] | 12 | | **parent_id** | **String** | | [optional] | 13 | 14 | ## Example 15 | 16 | ```ruby 17 | require 'conekta' 18 | 19 | instance = Conekta::UpdateOrderTaxResponse.new( 20 | amount: 100, 21 | description: testing, 22 | metadata: {key=value}, 23 | id: tax_lin_2tQ8dC5mg1UADmVPo, 24 | object: tax_line, 25 | parent_id: ord_2tPAmKCEJqh8RE6nY 26 | ) 27 | ``` 28 | 29 | -------------------------------------------------------------------------------- /docs/UpdatePaymentMethods.md: -------------------------------------------------------------------------------- 1 | # Conekta::UpdatePaymentMethods 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **name** | **String** | | [optional] | 8 | 9 | ## Example 10 | 11 | ```ruby 12 | require 'conekta' 13 | 14 | instance = Conekta::UpdatePaymentMethods.new( 15 | name: name of person 16 | ) 17 | ``` 18 | 19 | -------------------------------------------------------------------------------- /docs/UpdateProduct.md: -------------------------------------------------------------------------------- 1 | # Conekta::UpdateProduct 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **antifraud_info** | **Hash<String, Object>** | | [optional] | 8 | | **description** | **String** | | [optional] | 9 | | **sku** | **String** | | [optional] | 10 | | **name** | **String** | | [optional] | 11 | | **unit_price** | **Integer** | | [optional] | 12 | | **quantity** | **Integer** | | [optional] | 13 | | **tags** | **Array<String>** | | [optional] | 14 | | **brand** | **String** | | [optional] | 15 | | **metadata** | **Hash<String, String>** | | [optional] | 16 | 17 | ## Example 18 | 19 | ```ruby 20 | require 'conekta' 21 | 22 | instance = Conekta::UpdateProduct.new( 23 | antifraud_info: null, 24 | description: null, 25 | sku: null, 26 | name: Box of Cohiba S1s, 27 | unit_price: 20000, 28 | quantity: 1, 29 | tags: null, 30 | brand: null, 31 | metadata: null 32 | ) 33 | ``` 34 | 35 | -------------------------------------------------------------------------------- /docs/WebhookKeyCreateResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::WebhookKeyCreateResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **active** | **Boolean** | Indicates if the webhook key is active | [optional] | 8 | | **created_at** | **Integer** | Unix timestamp in seconds with the creation date of the webhook key | [optional] | 9 | | **id** | **String** | Unique identifier of the webhook key | [optional] | 10 | | **livemode** | **Boolean** | Indicates if the webhook key is in live mode | [optional] | 11 | | **object** | **String** | Object name, value is webhook_key | [optional] | 12 | | **public_key** | **String** | Public key to be used in the webhook | [optional] | 13 | 14 | ## Example 15 | 16 | ```ruby 17 | require 'conekta' 18 | 19 | instance = Conekta::WebhookKeyCreateResponse.new( 20 | active: true, 21 | created_at: 1577836800, 22 | id: 62730ba6fb7dfd6a712f118e, 23 | livemode: false, 24 | object: webhook_key, 25 | public_key: -----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqULpUc6D6mSAq5a0yLY/\noOjd1mWm6q+QI8y/FI4STr2F+XgKeNnMxSqnyFrHtKQ/ut4Zi45WFnJLfEQL7aW5\n67yE2dWyo6GaL7yZUfLC0Y3sHPGzaGtvDF36ISW7LliYNoMiA3Bx5/1Sr0G23pGW\n0Mp8IO1Nlz0sJWuU/d7zCz/UN6cl9g/BP4eaQ7deS56YuWcj5sTlwqFTlwN12kpA\nIzMZ7gnvYQnZTpPny5lben6QEuxTvZcPApcyOweiESjMnXfkfWOyuYtgMrbsU6oL\nA6sWa6j0pePW7AYeBqB4tyAlenkCSqzHg8bMk5Bm7hiT6I9Pls774lJbnOYmmuNE\n8QIDAQAB\n-----END PUBLIC KEY-----\n 26 | ) 27 | ``` 28 | 29 | -------------------------------------------------------------------------------- /docs/WebhookKeyDeleteResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::WebhookKeyDeleteResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **active** | **Boolean** | Indicates if the webhook key is active | [optional] | 8 | | **created_at** | **Integer** | Unix timestamp in seconds with the creation date of the webhook key | [optional] | 9 | | **deleted** | **Boolean** | Indicates if the webhook key is deleted | [optional] | 10 | | **id** | **String** | Unique identifier of the webhook key | [optional] | 11 | | **livemode** | **Boolean** | Indicates if the webhook key is in live mode | [optional] | 12 | | **object** | **String** | Object name, value is webhook_key | [optional] | 13 | 14 | ## Example 15 | 16 | ```ruby 17 | require 'conekta' 18 | 19 | instance = Conekta::WebhookKeyDeleteResponse.new( 20 | active: true, 21 | created_at: 1577836800, 22 | deleted: true, 23 | id: 62730ba6fb7dfd6a712f118e, 24 | livemode: false, 25 | object: webhook_key 26 | ) 27 | ``` 28 | 29 | -------------------------------------------------------------------------------- /docs/WebhookKeyRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::WebhookKeyRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **active** | **Boolean** | Indicates if the webhook key is active | [optional][default to true] | 8 | 9 | ## Example 10 | 11 | ```ruby 12 | require 'conekta' 13 | 14 | instance = Conekta::WebhookKeyRequest.new( 15 | active: true 16 | ) 17 | ``` 18 | 19 | -------------------------------------------------------------------------------- /docs/WebhookKeyResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::WebhookKeyResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **id** | **String** | Unique identifier of the webhook key | [optional] | 8 | | **active** | **Boolean** | Indicates if the webhook key is active | [optional] | 9 | | **created_at** | **Integer** | Unix timestamp in seconds with the creation date of the webhook key | [optional] | 10 | | **deactivated_at** | **Integer** | Unix timestamp in seconds with the deactivation date of the webhook key | [optional] | 11 | | **public_key** | **String** | Public key to be used in the webhook | [optional] | 12 | | **livemode** | **Boolean** | Indicates if the webhook key is in live mode | [optional] | 13 | | **object** | **String** | Object name, value is webhook_key | [optional] | 14 | 15 | ## Example 16 | 17 | ```ruby 18 | require 'conekta' 19 | 20 | instance = Conekta::WebhookKeyResponse.new( 21 | id: 62730ba6fb7dfd6a712f118e, 22 | active: true, 23 | created_at: 1577836800, 24 | deactivated_at: null, 25 | public_key: -----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqULpUc6D6mSAq5a0yLY/\noOjd1mWm6q+QI8y/FI4STr2F+XgKeNnMxSqnyFrHtKQ/ut4Zi45WFnJLfEQL7aW5\n67yE2dWyo6GaL7yZUfLC0Y3sHPGzaGtvDF36ISW7LliYNoMiA3Bx5/1Sr0G23pGW\n0Mp8IO1Nlz0sJWuU/d7zCz/UN6cl9g/BP4eaQ7deS56YuWcj5sTlwqFTlwN12kpA\nIzMZ7gnvYQnZTpPny5lben6QEuxTvZcPApcyOweiESjMnXfkfWOyuYtgMrbsU6oL\nA6sWa6j0pePW7AYeBqB4tyAlenkCSqzHg8bMk5Bm7hiT6I9Pls774lJbnOYmmuNE\n8QIDAQAB\n-----END PUBLIC KEY-----\n, 26 | livemode: false, 27 | object: webhook_key 28 | ) 29 | ``` 30 | 31 | -------------------------------------------------------------------------------- /docs/WebhookKeyUpdateRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::WebhookKeyUpdateRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **active** | **Boolean** | Indicates if the webhook key is active | [optional][default to false] | 8 | 9 | ## Example 10 | 11 | ```ruby 12 | require 'conekta' 13 | 14 | instance = Conekta::WebhookKeyUpdateRequest.new( 15 | active: false 16 | ) 17 | ``` 18 | 19 | -------------------------------------------------------------------------------- /docs/WebhookLog.md: -------------------------------------------------------------------------------- 1 | # Conekta::WebhookLog 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **failed_attempts** | **Integer** | | [optional] | 8 | | **id** | **String** | | [optional] | 9 | | **last_attempted_at** | **Integer** | | [optional] | 10 | | **last_http_response_status** | **Integer** | | [optional] | 11 | | **object** | **String** | | [optional] | 12 | | **response_data** | **Hash<String, Object>** | | [optional] | 13 | | **url** | **String** | | [optional] | 14 | 15 | ## Example 16 | 17 | ```ruby 18 | require 'conekta' 19 | 20 | instance = Conekta::WebhookLog.new( 21 | failed_attempts: 10, 22 | id: webhl_2svd2sh6GbqzyWBNZ, 23 | last_attempted_at: 1669651274, 24 | last_http_response_status: 200, 25 | object: webhook_log, 26 | response_data: {"amount":3000,"payable":true}, 27 | url: https://username:password@mockoon.stg.conekta.io/payments-api/cash/merchant_approval 28 | ) 29 | ``` 30 | 31 | -------------------------------------------------------------------------------- /docs/WebhookRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::WebhookRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **url** | **String** | Here you must place the URL of your Webhook remember that you must program what you will do with the events received. Also do not forget to handle the HTTPS protocol for greater security. | | 8 | | **subscribed_events** | **Array<String>** | events that will be sent to the webhook | [optional] | 9 | 10 | ## Example 11 | 12 | ```ruby 13 | require 'conekta' 14 | 15 | instance = Conekta::WebhookRequest.new( 16 | url: https://webhook.site/89277eaa-a8e4-4306-8dc5-f55c80703dc8, 17 | subscribed_events: customer.created 18 | ) 19 | ``` 20 | 21 | -------------------------------------------------------------------------------- /docs/WebhookResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::WebhookResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **id** | **String** | id of the webhook | [optional] | 8 | | **description** | **String** | A name or brief explanation of what this webhook is used for | [optional] | 9 | | **livemode** | **Boolean** | Indicates if the webhook is in production | [optional] | 10 | | **active** | **Boolean** | Indicates if the webhook is actived or not | [optional] | 11 | | **object** | **String** | Object name, value is 'webhook' | [optional] | 12 | | **status** | **String** | Indicates if the webhook is ready to receive events or failing | [optional] | 13 | | **subscribed_events** | **Array<String>** | lists the events that will be sent to the webhook | [optional] | 14 | | **url** | **String** | url or endpoint of the webhook | [optional] | 15 | 16 | ## Example 17 | 18 | ```ruby 19 | require 'conekta' 20 | 21 | instance = Conekta::WebhookResponse.new( 22 | id: 6307a60c41de27127515a575, 23 | description: Server payments processor, 24 | livemode: true, 25 | active: true, 26 | object: event, 27 | status: listening, 28 | subscribed_events: ["charge.created","charge.paid","charge.under_fraud_review","charge.fraudulent","charge.refunded","charge.preauthorized","charge.declined","charge.canceled","charge.reversed","charge.pending_confirmation"], 29 | url: https://username:password@mockoon.stg.conekta.io/payments-api/cash/merchant_approval 30 | ) 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /docs/WebhookUpdateRequest.md: -------------------------------------------------------------------------------- 1 | # Conekta::WebhookUpdateRequest 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **url** | **String** | Here you must place the URL of your Webhook remember that you must program what you will do with the events received. Also do not forget to handle the HTTPS protocol for greater security. | [optional] | 8 | | **subscribed_events** | **Array<String>** | events that will be sent to the webhook | [optional] | 9 | | **active** | **Boolean** | whether the webhook is active or not | [optional] | 10 | 11 | ## Example 12 | 13 | ```ruby 14 | require 'conekta' 15 | 16 | instance = Conekta::WebhookUpdateRequest.new( 17 | url: https://webhook.site/89277eaa-a8e4-4306-8dc5-f55c80703dc8, 18 | subscribed_events: customer.created, 19 | active: true 20 | ) 21 | ``` 22 | 23 | -------------------------------------------------------------------------------- /docs/WhitelistlistRuleResponse.md: -------------------------------------------------------------------------------- 1 | # Conekta::WhitelistlistRuleResponse 2 | 3 | ## Properties 4 | 5 | | Name | Type | Description | Notes | 6 | | ---- | ---- | ----------- | ----- | 7 | | **id** | **String** | Whitelist rule id | [optional] | 8 | | **field** | **String** | field used for whitelists rule | [optional] | 9 | | **value** | **String** | value used for whitelists rule | [optional] | 10 | | **description** | **String** | use an description for whitelisted rule | [optional] | 11 | 12 | ## Example 13 | 14 | ```ruby 15 | require 'conekta' 16 | 17 | instance = Conekta::WhitelistlistRuleResponse.new( 18 | id: 2fw8EWJusiRrxdPzT, 19 | field: email, 20 | value: email@example.com, 21 | description: banned customer example@example.com 22 | ) 23 | ``` 24 | 25 | -------------------------------------------------------------------------------- /lib/conekta/api_error.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #Conekta API 3 | 4 | #Conekta sdk 5 | 6 | The version of the OpenAPI document: 2.2.0 7 | Contact: engineering@conekta.com 8 | Generated by: https://openapi-generator.tech 9 | Generator version: 7.5.0 10 | 11 | =end 12 | 13 | module Conekta 14 | class ApiError < StandardError 15 | attr_reader :code, :response_headers, :response_body 16 | 17 | # Usage examples: 18 | # ApiError.new 19 | # ApiError.new("message") 20 | # ApiError.new(:code => 500, :response_headers => {}, :response_body => "") 21 | # ApiError.new(:code => 404, :message => "Not Found") 22 | def initialize(arg = nil) 23 | if arg.is_a? Hash 24 | if arg.key?(:message) || arg.key?('message') 25 | super(arg[:message] || arg['message']) 26 | else 27 | super arg 28 | end 29 | 30 | arg.each do |k, v| 31 | instance_variable_set "@#{k}", v 32 | end 33 | else 34 | super arg 35 | @message = arg 36 | end 37 | end 38 | 39 | # Override to_s to display a friendly error message 40 | def to_s 41 | message 42 | end 43 | 44 | def message 45 | if @message.nil? 46 | msg = "Error message: the server returns an error" 47 | else 48 | msg = @message 49 | end 50 | 51 | msg += "\nHTTP status code: #{code}" if code 52 | msg += "\nResponse headers: #{response_headers}" if response_headers 53 | msg += "\nResponse body: #{response_body}" if response_body 54 | 55 | msg 56 | end 57 | end 58 | end 59 | -------------------------------------------------------------------------------- /lib/conekta/models/charge_order_response_payment_method.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #Conekta API 3 | 4 | #Conekta sdk 5 | 6 | The version of the OpenAPI document: 2.2.0 7 | Contact: engineering@conekta.com 8 | Generated by: https://openapi-generator.tech 9 | Generator version: 7.5.0 10 | 11 | =end 12 | 13 | require 'date' 14 | require 'time' 15 | 16 | module Conekta 17 | module ChargeOrderResponsePaymentMethod 18 | class << self 19 | # List of class defined in oneOf (OpenAPI v3) 20 | def openapi_one_of 21 | [ 22 | :'PaymentMethodBankTransfer', 23 | :'PaymentMethodBnplPayment', 24 | :'PaymentMethodCard', 25 | :'PaymentMethodCash' 26 | ] 27 | end 28 | 29 | # Discriminator's property name (OpenAPI v3) 30 | def openapi_discriminator_name 31 | :'object' 32 | end 33 | 34 | # Discriminator's mapping (OpenAPI v3) 35 | def openapi_discriminator_mapping 36 | { 37 | :'bank_transfer_payment' => :'PaymentMethodBankTransfer', 38 | :'bnpl_payment' => :'PaymentMethodBnplPayment', 39 | :'card_payment' => :'PaymentMethodCard', 40 | :'cash_payment' => :'PaymentMethodCash' 41 | } 42 | end 43 | 44 | # Builds the object 45 | # @param [Mixed] Data to be matched against the list of oneOf items 46 | # @return [Object] Returns the model or the data itself 47 | def build(data) 48 | discriminator_value = data[openapi_discriminator_name] 49 | return nil if discriminator_value.nil? 50 | 51 | klass = openapi_discriminator_mapping[discriminator_value.to_s.to_sym] 52 | return nil unless klass 53 | 54 | Conekta.const_get(klass).build_from_hash(data) 55 | end 56 | end 57 | end 58 | 59 | end 60 | -------------------------------------------------------------------------------- /lib/conekta/models/charge_response_payment_method.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #Conekta API 3 | 4 | #Conekta sdk 5 | 6 | The version of the OpenAPI document: 2.2.0 7 | Contact: engineering@conekta.com 8 | Generated by: https://openapi-generator.tech 9 | Generator version: 7.5.0 10 | 11 | =end 12 | 13 | require 'date' 14 | require 'time' 15 | 16 | module Conekta 17 | module ChargeResponsePaymentMethod 18 | class << self 19 | # List of class defined in oneOf (OpenAPI v3) 20 | def openapi_one_of 21 | [ 22 | :'PaymentMethodBankTransfer', 23 | :'PaymentMethodBnplPayment', 24 | :'PaymentMethodCard', 25 | :'PaymentMethodCash' 26 | ] 27 | end 28 | 29 | # Discriminator's property name (OpenAPI v3) 30 | def openapi_discriminator_name 31 | :'object' 32 | end 33 | 34 | # Discriminator's mapping (OpenAPI v3) 35 | def openapi_discriminator_mapping 36 | { 37 | :'bank_transfer_payment' => :'PaymentMethodBankTransfer', 38 | :'bnpl_payment' => :'PaymentMethodBnplPayment', 39 | :'card_payment' => :'PaymentMethodCard', 40 | :'cash_payment' => :'PaymentMethodCash' 41 | } 42 | end 43 | 44 | # Builds the object 45 | # @param [Mixed] Data to be matched against the list of oneOf items 46 | # @return [Object] Returns the model or the data itself 47 | def build(data) 48 | discriminator_value = data[openapi_discriminator_name] 49 | return nil if discriminator_value.nil? 50 | 51 | klass = openapi_discriminator_mapping[discriminator_value.to_s.to_sym] 52 | return nil unless klass 53 | 54 | Conekta.const_get(klass).build_from_hash(data) 55 | end 56 | end 57 | end 58 | 59 | end 60 | -------------------------------------------------------------------------------- /lib/conekta/models/create_customer_payment_methods_response.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #Conekta API 3 | 4 | #Conekta sdk 5 | 6 | The version of the OpenAPI document: 2.2.0 7 | Contact: engineering@conekta.com 8 | Generated by: https://openapi-generator.tech 9 | Generator version: 7.5.0 10 | 11 | =end 12 | 13 | require 'date' 14 | require 'time' 15 | 16 | module Conekta 17 | module CreateCustomerPaymentMethodsResponse 18 | class << self 19 | # List of class defined in oneOf (OpenAPI v3) 20 | def openapi_one_of 21 | [ 22 | :'PaymentMethodCardResponse', 23 | :'PaymentMethodCashResponse', 24 | :'PaymentMethodSpeiRecurrent' 25 | ] 26 | end 27 | 28 | # Discriminator's property name (OpenAPI v3) 29 | def openapi_discriminator_name 30 | :'type' 31 | end 32 | 33 | # Discriminator's mapping (OpenAPI v3) 34 | def openapi_discriminator_mapping 35 | { 36 | :'card' => :'PaymentMethodCardResponse', 37 | :'cash' => :'PaymentMethodCashResponse', 38 | :'cash_recurrent' => :'PaymentMethodCashResponse', 39 | :'oxxo_recurrent' => :'PaymentMethodCashResponse', 40 | :'spei_recurrent' => :'PaymentMethodSpeiRecurrent' 41 | } 42 | end 43 | 44 | # Builds the object 45 | # @param [Mixed] Data to be matched against the list of oneOf items 46 | # @return [Object] Returns the model or the data itself 47 | def build(data) 48 | discriminator_value = data[openapi_discriminator_name] 49 | return nil if discriminator_value.nil? 50 | 51 | klass = openapi_discriminator_mapping[discriminator_value.to_s.to_sym] 52 | return nil unless klass 53 | 54 | Conekta.const_get(klass).build_from_hash(data) 55 | end 56 | end 57 | end 58 | 59 | end 60 | -------------------------------------------------------------------------------- /lib/conekta/models/customer_payment_methods_data.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #Conekta API 3 | 4 | #Conekta sdk 5 | 6 | The version of the OpenAPI document: 2.2.0 7 | Contact: engineering@conekta.com 8 | Generated by: https://openapi-generator.tech 9 | Generator version: 7.5.0 10 | 11 | =end 12 | 13 | require 'date' 14 | require 'time' 15 | 16 | module Conekta 17 | module CustomerPaymentMethodsData 18 | class << self 19 | # List of class defined in oneOf (OpenAPI v3) 20 | def openapi_one_of 21 | [ 22 | :'PaymentMethodCardResponse', 23 | :'PaymentMethodCashResponse', 24 | :'PaymentMethodSpeiRecurrent' 25 | ] 26 | end 27 | 28 | # Discriminator's property name (OpenAPI v3) 29 | def openapi_discriminator_name 30 | :'type' 31 | end 32 | 33 | # Discriminator's mapping (OpenAPI v3) 34 | def openapi_discriminator_mapping 35 | { 36 | :'card' => :'PaymentMethodCardResponse', 37 | :'cash' => :'PaymentMethodCashResponse', 38 | :'cash_recurrent' => :'PaymentMethodCashResponse', 39 | :'oxxo_recurrent' => :'PaymentMethodCashResponse', 40 | :'spei_recurrent' => :'PaymentMethodSpeiRecurrent' 41 | } 42 | end 43 | 44 | # Builds the object 45 | # @param [Mixed] Data to be matched against the list of oneOf items 46 | # @return [Object] Returns the model or the data itself 47 | def build(data) 48 | discriminator_value = data[openapi_discriminator_name] 49 | return nil if discriminator_value.nil? 50 | 51 | klass = openapi_discriminator_mapping[discriminator_value.to_s.to_sym] 52 | return nil unless klass 53 | 54 | Conekta.const_get(klass).build_from_hash(data) 55 | end 56 | end 57 | end 58 | 59 | end 60 | -------------------------------------------------------------------------------- /lib/conekta/models/event_types.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #Conekta API 3 | 4 | #Conekta sdk 5 | 6 | The version of the OpenAPI document: 2.2.0 7 | Contact: engineering@conekta.com 8 | Generated by: https://openapi-generator.tech 9 | Generator version: 7.5.0 10 | 11 | =end 12 | 13 | require 'date' 14 | require 'time' 15 | 16 | module Conekta 17 | class EventTypes 18 | WEBHOOK_PING = "webhook_ping".freeze 19 | ORDER_PAID = "order.paid".freeze 20 | ORDER_EXPIRED = "order.expired".freeze 21 | ORDER_CANCELED = "order.canceled".freeze 22 | ORDER_PENDING_PAYMENT = "order.pending_payment".freeze 23 | 24 | def self.all_vars 25 | @all_vars ||= [WEBHOOK_PING, ORDER_PAID, ORDER_EXPIRED, ORDER_CANCELED, ORDER_PENDING_PAYMENT].freeze 26 | end 27 | 28 | # Builds the enum from string 29 | # @param [String] The enum value in the form of the string 30 | # @return [String] The enum value 31 | def self.build_from_hash(value) 32 | new.build_from_hash(value) 33 | end 34 | 35 | # Builds the enum from string 36 | # @param [String] The enum value in the form of the string 37 | # @return [String] The enum value 38 | def build_from_hash(value) 39 | return value if EventTypes.all_vars.include?(value) 40 | raise "Invalid ENUM value #{value} for class #EventTypes" 41 | end 42 | end 43 | end 44 | -------------------------------------------------------------------------------- /lib/conekta/models/get_customer_payment_method_data_response.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #Conekta API 3 | 4 | #Conekta sdk 5 | 6 | The version of the OpenAPI document: 2.2.0 7 | Contact: engineering@conekta.com 8 | Generated by: https://openapi-generator.tech 9 | Generator version: 7.5.0 10 | 11 | =end 12 | 13 | require 'date' 14 | require 'time' 15 | 16 | module Conekta 17 | module GetCustomerPaymentMethodDataResponse 18 | class << self 19 | # List of class defined in oneOf (OpenAPI v3) 20 | def openapi_one_of 21 | [ 22 | :'PaymentMethodCardResponse', 23 | :'PaymentMethodCashResponse', 24 | :'PaymentMethodSpeiRecurrent' 25 | ] 26 | end 27 | 28 | # Discriminator's property name (OpenAPI v3) 29 | def openapi_discriminator_name 30 | :'type' 31 | end 32 | 33 | # Discriminator's mapping (OpenAPI v3) 34 | def openapi_discriminator_mapping 35 | { 36 | :'card' => :'PaymentMethodCardResponse', 37 | :'cash' => :'PaymentMethodCashResponse', 38 | :'cash_recurrent' => :'PaymentMethodCashResponse', 39 | :'oxxo_recurrent' => :'PaymentMethodCashResponse', 40 | :'spei_recurrent' => :'PaymentMethodSpeiRecurrent' 41 | } 42 | end 43 | 44 | # Builds the object 45 | # @param [Mixed] Data to be matched against the list of oneOf items 46 | # @return [Object] Returns the model or the data itself 47 | def build(data) 48 | discriminator_value = data[openapi_discriminator_name] 49 | return nil if discriminator_value.nil? 50 | 51 | klass = openapi_discriminator_mapping[discriminator_value.to_s.to_sym] 52 | return nil unless klass 53 | 54 | Conekta.const_get(klass).build_from_hash(data) 55 | end 56 | end 57 | end 58 | 59 | end 60 | -------------------------------------------------------------------------------- /lib/conekta/models/update_customer_payment_methods_response.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #Conekta API 3 | 4 | #Conekta sdk 5 | 6 | The version of the OpenAPI document: 2.2.0 7 | Contact: engineering@conekta.com 8 | Generated by: https://openapi-generator.tech 9 | Generator version: 7.5.0 10 | 11 | =end 12 | 13 | require 'date' 14 | require 'time' 15 | 16 | module Conekta 17 | module UpdateCustomerPaymentMethodsResponse 18 | class << self 19 | # List of class defined in oneOf (OpenAPI v3) 20 | def openapi_one_of 21 | [ 22 | :'PaymentMethodCardResponse', 23 | :'PaymentMethodCashResponse', 24 | :'PaymentMethodSpeiRecurrent' 25 | ] 26 | end 27 | 28 | # Discriminator's property name (OpenAPI v3) 29 | def openapi_discriminator_name 30 | :'type' 31 | end 32 | 33 | # Discriminator's mapping (OpenAPI v3) 34 | def openapi_discriminator_mapping 35 | { 36 | :'card' => :'PaymentMethodCardResponse', 37 | :'cash' => :'PaymentMethodCashResponse', 38 | :'cash_recurrent' => :'PaymentMethodCashResponse', 39 | :'oxxo_recurrent' => :'PaymentMethodCashResponse', 40 | :'spei_recurrent' => :'PaymentMethodSpeiRecurrent' 41 | } 42 | end 43 | 44 | # Builds the object 45 | # @param [Mixed] Data to be matched against the list of oneOf items 46 | # @return [Object] Returns the model or the data itself 47 | def build(data) 48 | discriminator_value = data[openapi_discriminator_name] 49 | return nil if discriminator_value.nil? 50 | 51 | klass = openapi_discriminator_mapping[discriminator_value.to_s.to_sym] 52 | return nil unless klass 53 | 54 | Conekta.const_get(klass).build_from_hash(data) 55 | end 56 | end 57 | end 58 | 59 | end 60 | -------------------------------------------------------------------------------- /lib/conekta/version.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #Conekta API 3 | 4 | #Conekta sdk 5 | 6 | The version of the OpenAPI document: 2.2.0 7 | Contact: engineering@conekta.com 8 | Generated by: https://openapi-generator.tech 9 | Generator version: 7.5.0 10 | 11 | =end 12 | 13 | module Conekta 14 | VERSION = '7.0.1' 15 | end 16 | -------------------------------------------------------------------------------- /spec/api/balances_api_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #Conekta API 3 | 4 | #Conekta sdk 5 | 6 | The version of the OpenAPI document: 2.2.0 7 | Contact: engineering@conekta.com 8 | Generated by: https://openapi-generator.tech 9 | Generator version: 7.5.0 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | 16 | # Unit tests for Conekta::BalancesApi 17 | # Automatically generated by openapi-generator (https://openapi-generator.tech) 18 | # Please update as you see appropriate 19 | describe 'BalancesApi' do 20 | before do 21 | # run before each test 22 | @api_instance = Conekta::BalancesApi.new 23 | end 24 | 25 | after do 26 | # run after each test 27 | end 28 | 29 | describe 'test an instance of BalancesApi' do 30 | it 'should create an instance of BalancesApi' do 31 | expect(@api_instance).to be_instance_of(Conekta::BalancesApi) 32 | end 33 | end 34 | 35 | # unit tests for get_balance 36 | # Get a company's balance 37 | # Get a company's balance 38 | # @param [Hash] opts the optional parameters 39 | # @option opts [String] :accept_language Use for knowing which language to use 40 | # @return [BalanceResponse] 41 | describe 'get_balance test' do 42 | it 'should work' do 43 | # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/ 44 | end 45 | end 46 | 47 | end 48 | -------------------------------------------------------------------------------- /spec/api/companies_api_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #Conekta API 3 | 4 | #Conekta sdk 5 | 6 | The version of the OpenAPI document: 2.2.0 7 | Contact: engineering@conekta.com 8 | Generated by: https://openapi-generator.tech 9 | Generator version: 7.5.0 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | 16 | # Unit tests for Conekta::CompaniesApi 17 | # Automatically generated by openapi-generator (https://openapi-generator.tech) 18 | # Please update as you see appropriate 19 | describe 'CompaniesApi' do 20 | before do 21 | # run before each test 22 | @api_instance = Conekta::CompaniesApi.new 23 | end 24 | 25 | after do 26 | # run after each test 27 | end 28 | 29 | describe 'test an instance of CompaniesApi' do 30 | it 'should create an instance of CompaniesApi' do 31 | expect(@api_instance).to be_instance_of(Conekta::CompaniesApi) 32 | end 33 | end 34 | 35 | # unit tests for get_companies 36 | # Get List of Companies 37 | # Consume the list of child companies. This is used for holding companies with several child entities. 38 | # @param [Hash] opts the optional parameters 39 | # @option opts [String] :accept_language Use for knowing which language to use 40 | # @option opts [Integer] :limit The numbers of items to return, the maximum value is 250 41 | # @option opts [String] :search General order search, e.g. by mail, reference etc. 42 | # @option opts [String] :_next next page 43 | # @option opts [String] :previous previous page 44 | # @return [GetCompaniesResponse] 45 | describe 'get_companies test' do 46 | it 'should work' do 47 | # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/ 48 | end 49 | end 50 | 51 | # unit tests for get_company 52 | # Get Company 53 | # @param id Identifier of the resource 54 | # @param [Hash] opts the optional parameters 55 | # @option opts [String] :accept_language Use for knowing which language to use 56 | # @return [CompanyResponse] 57 | describe 'get_company test' do 58 | it 'should work' do 59 | # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/ 60 | end 61 | end 62 | 63 | end 64 | -------------------------------------------------------------------------------- /spec/api/tokens_api_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | #Conekta API 3 | 4 | #Conekta sdk 5 | 6 | The version of the OpenAPI document: 2.2.0 7 | Contact: engineering@conekta.com 8 | Generated by: https://openapi-generator.tech 9 | Generator version: 7.5.0 10 | 11 | =end 12 | 13 | require 'spec_helper' 14 | require 'json' 15 | 16 | # Unit tests for Conekta::TokensApi 17 | # Automatically generated by openapi-generator (https://openapi-generator.tech) 18 | # Please update as you see appropriate 19 | describe 'TokensApi' do 20 | before do 21 | # run before each test 22 | @api_instance = Conekta::TokensApi.new 23 | end 24 | 25 | after do 26 | # run after each test 27 | end 28 | 29 | describe 'test an instance of TokensApi' do 30 | it 'should create an instance of TokensApi' do 31 | expect(@api_instance).to be_instance_of(Conekta::TokensApi) 32 | end 33 | end 34 | 35 | # unit tests for create_token 36 | # Create Token 37 | # Generate a payment token, to associate it with a card 38 | # @param token requested field for token 39 | # @param [Hash] opts the optional parameters 40 | # @option opts [String] :accept_language Use for knowing which language to use 41 | # @return [TokenResponse] 42 | describe 'create_token test' do 43 | it 'should work' do 44 | # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/ 45 | end 46 | end 47 | 48 | end 49 | -------------------------------------------------------------------------------- /templates/ruby/CUSTOM_VERSION.mustache: -------------------------------------------------------------------------------- 1 | {{gemVersion}} 2 | --------------------------------------------------------------------------------