conekta 6.0.5 conekta: ^6.0.5 copied to clipboard
A simple Conekta API wrapper, that is meant to be used on the server.
conekta #
Conekta sdk
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: 2.1.0
- Build package: org.openapitools.codegen.languages.DartDioClientCodegen For more information, please visit https://github.com/conekta/openapi/issues
Requirements #
- Dart 2.18.0+ or Flutter 2.8.0+
- Dio 5.0.0+ (https://pub.dev/packages/dio)
Installation & Usage #
pub.dev #
To use the package from pub.dev, please include the following in pubspec.yaml
dependencies:
conekta: 6.0.5
Github #
If this Dart package is published to Github, please include the following in pubspec.yaml
dependencies:
conekta:
git:
url: https://github.com/conekta/conekta-dart.git
#ref: main
Local development #
To use the package from your local drive, please include the following in pubspec.yaml
dependencies:
conekta:
path: /path/to/conekta
Getting Started #
Please follow the installation procedure and then run the following:
import 'package:conekta/conekta.dart';
Future<void> main() async {
var instance = Conekta();
instance.setBearerAuth("bearerAuth", "key_xxxx");
final api = instance.getCustomersApi();
var customer = Customer((b) => b
..name = 'John Constantine'
..email = 'email@gmail.com'
..phone = '5555555555'
);
var response = await api.createCustomer(customer: customer);
print(response.data);
}
Documentation for API Endpoints #
All URIs are relative to https://api.conekta.io
Class | Method | HTTP request | Description |
---|---|---|---|
AntifraudApi | createRuleBlacklist | POST /antifraud/blacklists | Create blacklisted rule |
AntifraudApi | createRuleWhitelist | POST /antifraud/whitelists | Create whitelisted rule |
AntifraudApi | deleteRuleBlacklist | DELETE /antifraud/blacklists/{id} | Delete blacklisted rule |
AntifraudApi | deleteRuleWhitelist | DELETE /antifraud/whitelists/{id} | Delete whitelisted rule |
AntifraudApi | getRuleBlacklist | GET /antifraud/blacklists | Get list of blacklisted rules |
AntifraudApi | getRuleWhitelist | GET /antifraud/whitelists | Get a list of whitelisted rules |
ApiKeysApi | createApiKey | POST /api_keys | Create Api Key |
ApiKeysApi | deleteApiKey | DELETE /api_keys/{id} | Delete Api Key |
ApiKeysApi | getApiKey | GET /api_keys/{id} | Get Api Key |
ApiKeysApi | getApiKeys | GET /api_keys | Get list of Api Keys |
ApiKeysApi | updateApiKey | PUT /api_keys/{id} | Update Api Key |
BalancesApi | getBalance | GET /balance | Get a company's balance |
ChargesApi | getCharges | GET /charges | Get A List of Charges |
ChargesApi | ordersCreateCharge | POST /orders/{id}/charges | Create charge |
ChargesApi | updateCharge | PUT /charges/{id} | Update a charge |
CompaniesApi | getCompanies | GET /companies | Get List of Companies |
CompaniesApi | getCompany | GET /companies/{id} | Get Company |
CustomersApi | createCustomer | POST /customers | Create customer |
CustomersApi | createCustomerFiscalEntities | POST /customers/{id}/fiscal_entities | Create Fiscal Entity |
CustomersApi | deleteCustomerById | DELETE /customers/{id} | Delete Customer |
CustomersApi | getCustomerById | GET /customers/{id} | Get Customer |
CustomersApi | getCustomers | GET /customers | Get a list of customers |
CustomersApi | updateCustomer | PUT /customers/{id} | Update customer |
CustomersApi | updateCustomerFiscalEntities | PUT /customers/{id}/fiscal_entities/{fiscal_entities_id} | Update Fiscal Entity |
DiscountsApi | ordersCreateDiscountLine | POST /orders/{id}/discount_lines | Create Discount |
DiscountsApi | ordersDeleteDiscountLines | DELETE /orders/{id}/discount_lines/{discount_lines_id} | Delete Discount |
DiscountsApi | ordersGetDiscountLine | GET /orders/{id}/discount_lines/{discount_lines_id} | Get Discount |
DiscountsApi | ordersGetDiscountLines | GET /orders/{id}/discount_lines | Get a List of Discount |
DiscountsApi | ordersUpdateDiscountLines | PUT /orders/{id}/discount_lines/{discount_lines_id} | Update Discount |
EventsApi | getEvent | GET /events/{id} | Get Event |
EventsApi | getEvents | GET /events | Get list of Events |
EventsApi | resendEvent | POST /events/{event_id}/webhook_logs/{webhook_log_id}/resend | Resend Event |
LogsApi | getLogById | GET /logs/{id} | Get Log |
LogsApi | getLogs | GET /logs | Get List Of Logs |
OrdersApi | cancelOrder | POST /orders/{id}/cancel | Cancel Order |
OrdersApi | createOrder | POST /orders | Create order |
OrdersApi | getOrderById | GET /orders/{id} | Get Order |
OrdersApi | getOrders | GET /orders | Get a list of Orders |
OrdersApi | orderCancelRefund | DELETE /orders/{id}/refunds/{refund_id} | Cancel Refund |
OrdersApi | orderRefund | POST /orders/{id}/refunds | Refund Order |
OrdersApi | ordersCreateCapture | POST /orders/{id}/capture | Capture Order |
OrdersApi | updateOrder | PUT /orders/{id} | Update Order |
PaymentLinkApi | cancelCheckout | PUT /checkouts/{id}/cancel | Cancel Payment Link |
PaymentLinkApi | createCheckout | POST /checkouts | Create Unique Payment Link |
PaymentLinkApi | emailCheckout | POST /checkouts/{id}/email | Send an email |
PaymentLinkApi | getCheckout | GET /checkouts/{id} | Get a payment link by ID |
PaymentLinkApi | getCheckouts | GET /checkouts | Get a list of payment links |
PaymentLinkApi | smsCheckout | POST /checkouts/{id}/sms | Send an sms |
PaymentMethodsApi | createCustomerPaymentMethods | POST /customers/{id}/payment_sources | Create Payment Method |
PaymentMethodsApi | deleteCustomerPaymentMethods | DELETE /customers/{id}/payment_sources/{payment_method_id} | Delete Payment Method |
PaymentMethodsApi | getCustomerPaymentMethods | GET /customers/{id}/payment_sources | Get Payment Methods |
PaymentMethodsApi | updateCustomerPaymentMethods | PUT /customers/{id}/payment_sources/{payment_method_id} | Update Payment Method |
PayoutOrdersApi | createPayoutOrder | POST /payout_orders | Create payout order |
PayoutOrdersApi | getPayoutOrderById | GET /payout_orders/{id} | Get Payout Order |
PayoutOrdersApi | getPayoutOrders | GET /payout_orders | Get a list of Payout Orders |
PlansApi | createPlan | POST /plans | Create Plan |
PlansApi | deletePlan | DELETE /plans/{id} | Delete Plan |
PlansApi | getPlan | GET /plans/{id} | Get Plan |
PlansApi | getPlans | GET /plans | Get A List of Plans |
PlansApi | updatePlan | PUT /plans/{id} | Update Plan |
ProductsApi | ordersCreateProduct | POST /orders/{id}/line_items | Create Product |
ProductsApi | ordersDeleteProduct | DELETE /orders/{id}/line_items/{line_item_id} | Delete Product |
ProductsApi | ordersUpdateProduct | PUT /orders/{id}/line_items/{line_item_id} | Update Product |
ShippingContactsApi | createCustomerShippingContacts | POST /customers/{id}/shipping_contacts | Create a shipping contacts |
ShippingContactsApi | deleteCustomerShippingContacts | DELETE /customers/{id}/shipping_contacts/{shipping_contacts_id} | Delete shipping contacts |
ShippingContactsApi | updateCustomerShippingContacts | PUT /customers/{id}/shipping_contacts/{shipping_contacts_id} | Update shipping contacts |
ShippingsApi | ordersCreateShipping | POST /orders/{id}/shipping_lines | Create Shipping |
ShippingsApi | ordersDeleteShipping | DELETE /orders/{id}/shipping_lines/{shipping_id} | Delete Shipping |
ShippingsApi | ordersUpdateShipping | PUT /orders/{id}/shipping_lines/{shipping_id} | Update Shipping |
SubscriptionsApi | cancelSubscription | POST /customers/{id}/subscription/cancel | Cancel Subscription |
SubscriptionsApi | createSubscription | POST /customers/{id}/subscription | Create Subscription |
SubscriptionsApi | getAllEventsFromSubscription | GET /customers/{id}/subscription/events | Get Events By Subscription |
SubscriptionsApi | getSubscription | GET /customers/{id}/subscription | Get Subscription |
SubscriptionsApi | pauseSubscription | POST /customers/{id}/subscription/pause | Pause Subscription |
SubscriptionsApi | resumeSubscription | POST /customers/{id}/subscription/resume | Resume Subscription |
SubscriptionsApi | updateSubscription | PUT /customers/{id}/subscription | Update Subscription |
TaxesApi | ordersCreateTaxes | POST /orders/{id}/tax_lines | Create Tax |
TaxesApi | ordersDeleteTaxes | DELETE /orders/{id}/tax_lines/{tax_id} | Delete Tax |
TaxesApi | ordersUpdateTaxes | PUT /orders/{id}/tax_lines/{tax_id} | Update Tax |
TokensApi | createToken | POST /tokens | Create Token |
TransactionsApi | getTransaction | GET /transactions/{id} | Get transaction |
TransactionsApi | getTransactions | GET /transactions | Get List transactions |
TransfersApi | getTransfer | GET /transfers/{id} | Get Transfer |
TransfersApi | getTransfers | GET /transfers | Get a list of transfers |
WebhookKeysApi | createWebhookKey | POST /webhook_keys | Create Webhook Key |
WebhookKeysApi | deleteWebhookKey | DELETE /webhook_keys/{id} | Delete Webhook key |
WebhookKeysApi | getWebhookKey | GET /webhook_keys/{id} | Get Webhook Key |
WebhookKeysApi | getWebhookKeys | GET /webhook_keys | Get List of Webhook Keys |
WebhookKeysApi | updateWebhookKey | PUT /webhook_keys/{id} | Update Webhook Key |
WebhooksApi | createWebhook | POST /webhooks | Create Webhook |
WebhooksApi | deleteWebhook | DELETE /webhooks/{id} | Delete Webhook |
WebhooksApi | getWebhook | GET /webhooks/{id} | Get Webhook |
WebhooksApi | getWebhooks | GET /webhooks | Get List of Webhooks |
WebhooksApi | testWebhook | POST /webhooks/{id}/test | Test Webhook |
WebhooksApi | updateWebhook | PUT /webhooks/{id} | Update Webhook |
Documentation For Models #
- ApiKeyCreateResponse
- ApiKeyRequest
- ApiKeyResponse
- ApiKeyResponseOnDelete
- ApiKeyUpdateRequest
- BalanceCommonField
- BalanceResponse
- BlacklistRuleResponse
- ChargeOrderResponse
- ChargeOrderResponsePaymentMethod
- ChargeRequest
- ChargeRequestPaymentMethod
- ChargeResponse
- ChargeResponseChannel
- ChargeResponsePaymentMethod
- ChargeResponseRefunds
- ChargeResponseRefundsData
- ChargeUpdateRequest
- ChargesDataResponse
- Checkout
- CheckoutOrderTemplate
- CheckoutOrderTemplateCustomerInfo
- CheckoutRequest
- CheckoutResponse
- CheckoutsResponse
- CompanyFiscalInfoAddressResponse
- CompanyFiscalInfoResponse
- CompanyPayoutDestinationResponse
- CompanyResponse
- CreateCustomerFiscalEntitiesResponse
- CreateCustomerPaymentMethodsRequest
- CreateCustomerPaymentMethodsResponse
- CreateRiskRulesData
- Customer
- CustomerAddress
- CustomerAntifraudInfo
- CustomerAntifraudInfoResponse
- CustomerFiscalEntitiesDataResponse
- CustomerFiscalEntitiesRequest
- CustomerFiscalEntitiesResponse
- CustomerInfo
- CustomerInfoJustCustomerId
- CustomerInfoJustCustomerIdResponse
- CustomerPaymentMethodRequest
- CustomerPaymentMethodsData
- CustomerPaymentMethodsRequest
- CustomerPaymentMethodsResponse
- CustomerResponse
- CustomerResponseShippingContacts
- CustomerShippingContacts
- CustomerShippingContactsAddress
- CustomerShippingContactsDataResponse
- CustomerShippingContactsResponse
- CustomerShippingContactsResponseAddress
- CustomerUpdateFiscalEntitiesRequest
- CustomerUpdateShippingContacts
- CustomersResponse
- DeleteApiKeysResponse
- DeletedBlacklistRuleResponse
- DeletedWhitelistRuleResponse
- Details
- DetailsError
- DiscountLinesDataResponse
- DiscountLinesResponse
- EmailCheckoutRequest
- Error
- EventResponse
- EventTypes
- EventsResendResponse
- FiscalEntityAddress
- GetApiKeysResponse
- GetChargesResponse
- GetCompaniesResponse
- GetCustomerPaymentMethodDataResponse
- GetEventsResponse
- GetOrderDiscountLinesResponse
- GetOrdersResponse
- GetPaymentMethodResponse
- GetPlansResponse
- GetTransactionsResponse
- GetTransfersResponse
- GetWebhookKeysResponse
- GetWebhooksResponse
- LogResponse
- LogsResponse
- LogsResponseData
- OrderCaptureRequest
- OrderCustomerInfoResponse
- OrderDiscountLinesRequest
- OrderFiscalEntityAddressResponse
- OrderFiscalEntityRequest
- OrderFiscalEntityResponse
- OrderNextActionResponse
- OrderNextActionResponseRedirectToUrl
- OrderRefundRequest
- OrderRequest
- OrderRequestCustomerInfo
- OrderResponse
- OrderResponseCharges
- OrderResponseCheckout
- OrderResponseCustomerInfo
- OrderResponseDiscountLines
- OrderResponseProducts
- OrderResponseShippingContact
- OrderTaxRequest
- OrderUpdateFiscalEntityRequest
- OrderUpdateRequest
- OrderUpdateRequestCustomerInfo
- OrdersResponse
- Page
- Pagination
- PaymentMethod
- PaymentMethodBankTransfer
- PaymentMethodCard
- PaymentMethodCardRequest
- PaymentMethodCardResponse
- PaymentMethodCash
- PaymentMethodCashRequest
- PaymentMethodCashResponse
- PaymentMethodResponse
- PaymentMethodSpeiRecurrent
- PaymentMethodSpeiRequest
- Payout
- PayoutMethod
- PayoutOrder
- PayoutOrderPayoutsItem
- PayoutOrderResponse
- PayoutOrderResponseCustomerInfo
- PayoutOrdersResponse
- PlanRequest
- PlanResponse
- PlanUpdateRequest
- Product
- ProductDataResponse
- ProductOrderResponse
- RiskRulesData
- RiskRulesList
- ShippingOrderResponse
- ShippingRequest
- SmsCheckoutRequest
- SubscriptionEventsResponse
- SubscriptionRequest
- SubscriptionResponse
- SubscriptionUpdateRequest
- Token
- TokenCard
- TokenCheckout
- TokenResponse
- TokenResponseCheckout
- TransactionResponse
- TransferDestinationResponse
- TransferMethodResponse
- TransferResponse
- TransfersResponse
- UpdateCustomer
- UpdateCustomerAntifraudInfo
- UpdateCustomerFiscalEntitiesResponse
- UpdateCustomerPaymentMethodsResponse
- UpdateOrderDiscountLinesRequest
- UpdateOrderTaxRequest
- UpdateOrderTaxResponse
- UpdatePaymentMethods
- UpdateProduct
- WebhookKeyCreateResponse
- WebhookKeyDeleteResponse
- WebhookKeyRequest
- WebhookKeyResponse
- WebhookKeyUpdateRequest
- WebhookLog
- WebhookRequest
- WebhookResponse
- WebhookUpdateRequest
- WhitelistlistRuleResponse
Documentation For Authorization #
Authentication schemes defined for the API:
bearerAuth #
- Type: HTTP Bearer Token authentication