digitalfemsa / femsa-php
DigitalFemsa PHP Library
Installs: 5 642
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 1
Requires
- php: ^7.4 || ^8.0
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3
- guzzlehttp/psr7: ^1.7 || ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- phpstan/phpstan: 1.10.47
- phpunit/phpunit: ^8.0 || ^9.0
This package is auto-updated.
Last update: 2024-10-21 01:17:24 UTC
README
Femsa sdk
For more information, please visit https://github.com/digitalfemsa/openapi/issues.
Installation & Usage
Requirements
PHP 7.4 and later. Should also work with PHP 8.0.
Composer
To install the bindings via Composer, add the following to composer.json
:
{ "repositories": [ { "type": "vcs", "url": "https://github.com/digitalfemsa/femsa-php.git" } ], "require": { "digitalfemsa/femsa-php": "*@dev" } }
Then run composer install
Manual Installation
Download the files and include autoload.php
:
<?php require_once('/path/to/digitalfemsa/vendor/autoload.php');
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure Bearer authorization: bearerAuth $config = DigitalFemsa\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); $apiInstance = new DigitalFemsa\Api\ApiKeysApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $api_key_request = new \DigitalFemsa\Model\ApiKeyRequest(); // \DigitalFemsa\Model\ApiKeyRequest | requested field for a api keys $accept_language = es; // string | Use for knowing which language to use $x_child_company_id = 6441b6376b60c3a638da80af; // string | In the case of a holding company, the company id of the child company to which will process the request. try { $result = $apiInstance->createApiKey($api_key_request, $accept_language, $x_child_company_id); print_r($result); } catch (Exception $e) { echo 'Exception when calling ApiKeysApi->createApiKey: ', $e->getMessage(), PHP_EOL; }
API Endpoints
All URIs are relative to https://api.digitalfemsa.io
Models
- ApiKeyCreateResponse
- ApiKeyRequest
- ApiKeyResponse
- ApiKeyResponseOnDelete
- ApiKeyUpdateRequest
- BalanceCommonField
- BalanceResponse
- ChargeOrderResponse
- ChargeOrderResponsePaymentMethod
- ChargeRequest
- ChargeRequestPaymentMethod
- ChargeResponse
- ChargeResponseChannel
- ChargeResponsePaymentMethod
- ChargeResponseRefunds
- ChargeResponseRefundsData
- ChargeUpdateRequest
- ChargesDataResponse
- Checkout
- CheckoutOrderTemplate
- CheckoutOrderTemplateCustomerInfo
- CheckoutRequest
- CheckoutResponse
- CheckoutsResponse
- CompanyFiscalInfoAddressResponse
- CompanyFiscalInfoResponse
- CompanyPayoutDestinationResponse
- CompanyResponse
- CreateCustomerFiscalEntitiesResponse
- CreateCustomerPaymentMethodsRequest
- CreateCustomerPaymentMethodsResponse
- 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
- Details
- DetailsError
- DiscountLinesDataResponse
- DiscountLinesResponse
- EmailCheckoutRequest
- Error
- EventResponse
- EventsResendResponse
- FiscalEntityAddress
- GetApiKeysResponse
- GetChargesResponse
- GetCompaniesResponse
- GetCustomerPaymentMethodDataResponse
- GetEventsResponse
- GetOrderDiscountLinesResponse
- GetOrdersResponse
- GetPaymentMethodResponse
- 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
- PaymentMethodCash
- PaymentMethodCashRequest
- PaymentMethodCashResponse
- PaymentMethodResponse
- Product
- ProductDataResponse
- ProductOrderResponse
- ShippingOrderResponse
- ShippingRequest
- SmsCheckoutRequest
- TransactionResponse
- TransferDestinationResponse
- TransferMethodResponse
- TransferResponse
- TransfersResponse
- UpdateCustomer
- UpdateCustomerAntifraudInfo
- UpdateCustomerFiscalEntitiesResponse
- UpdateCustomerPaymentMethodsResponse
- UpdateOrderDiscountLinesRequest
- UpdateOrderTaxRequest
- UpdateOrderTaxResponse
- UpdatePaymentMethods
- UpdateProduct
- WebhookKeyCreateResponse
- WebhookKeyDeleteResponse
- WebhookKeyRequest
- WebhookKeyResponse
- WebhookKeyUpdateRequest
- WebhookLog
- WebhookRequest
- WebhookResponse
- WebhookUpdateRequest
Authorization
Authentication schemes defined for the API:
bearerAuth
- Type: Bearer authentication
Tests
To run the tests, use:
composer install vendor/bin/phpunit
Author
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
2.1.0
- Package version:
1.0.1
- Generator version:
7.5.0
- Package version:
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen