.github
1 year ago
src
1 year ago
LICENSE
1 year ago
README.md
1 year ago
composer.json
1 year ago
composer.lock
1 year ago
README.md
56 lines
| 1 | # APIMatic Core Library Interfaces |
| 2 | [![version][packagist-version]][packagist-url] |
| 3 | [](https://codeclimate.com/github/apimatic/core-interfaces-php/maintainability](https://codeclimate.com/github/apimatic/core-interfaces-php/maintainability](https://codeclimate.com/github/apimatic/core-interfaces-php/maintainability) |
| 4 | [![Licence][license-badge]][license-url] |
| 5 | |
| 6 | ## Introduction |
| 7 | Definition of the behavior of apimatic/core, apimatic/unirest-php and APIMatic's PHP SDK |
| 8 | |
| 9 | ## Supported PHP Versions |
| 10 | - PHP 7.2 |
| 11 | - PHP 7.4 |
| 12 | - PHP 8.0 |
| 13 | - PHP 8.1 |
| 14 | - PHP 8.2 |
| 15 | |
| 16 | ## Install the Package |
| 17 | |
| 18 | Run the following command to install the package and automatically add the dependency to your composer.json file: |
| 19 | |
| 20 | ```php |
| 21 | composer require "apimatic/core-interfaces" |
| 22 | ``` |
| 23 | |
| 24 | ## Interfaces |
| 25 | | Name | Description | |
| 26 | |-------------------------------------------------------------------------|--------------------------------------------------------------------| |
| 27 | | [](src/Core/ContextInterface.php`ContextInterface`](src/Core/ContextInterface.php](src/Core/ContextInterface.php) | To save both Request and Response after the completion of response | |
| 28 | | [](src/Core/Authentication/AuthInterface.php`AuthInterface`](src/Core/Authentication/AuthInterface.php](src/Core/Authentication/AuthInterface.php) | To Provide abstraction for all AuthManagers | |
| 29 | | [](src/Core/Logger/ApiLoggerInterface.php`ApiLoggerInterface`](src/Core/Logger/ApiLoggerInterface.php](src/Core/Logger/ApiLoggerInterface.php) | To set up an abstract layer for logging requests and responses | |
| 30 | | [](src/Core/Request/RequestInterface.php`RequestInterface`](src/Core/Request/RequestInterface.php](src/Core/Request/RequestInterface.php) | To get the properties from the instance of Request | |
| 31 | | [](src/Core/Request/RequestSetterInterface.php`RequestSetterInterface`](src/Core/Request/RequestSetterInterface.php](src/Core/Request/RequestSetterInterface.php) | To update the instance of Request | |
| 32 | | [](src/Core/Request/ParamInterface.php`ParamInterface`](src/Core/Request/ParamInterface.php](src/Core/Request/ParamInterface.php) | To Provide abstraction for common functionality of Parameters | |
| 33 | | [](src/Core/Request/NonEmptyParamInterface.php`NonEmptyParamInterface`](src/Core/Request/NonEmptyParamInterface.php](src/Core/Request/NonEmptyParamInterface.php) | An extension of ParamInterface, for validation of non-empty values | |
| 34 | | [](src/Core/Request/TypeValidatorInterface.php`TypeValidatorInterface`](src/Core/Request/TypeValidatorInterface.php](src/Core/Request/TypeValidatorInterface.php) | To Provide abstraction for type validation in Parameters | |
| 35 | | [](src/Core/Response/ResponseInterface.php`ResponseInterface`](src/Core/Response/ResponseInterface.php](src/Core/Response/ResponseInterface.php) | To get the properties from the instance of Response | |
| 36 | | [](src/Http/HttpConfigurations.php`HttpConfigurations`](src/Http/HttpConfigurations.php](src/Http/HttpConfigurations.php) | To hold the default configurations for HttpClient | |
| 37 | | [](src/Http/HttpClientInterface.php`HttpClientInterface`](src/Http/HttpClientInterface.php](src/Http/HttpClientInterface.php) | To provide abstraction to execute API call in HttpClient | |
| 38 | | [](src/Sdk/ConverterInterface.php`ConverterInterface`](src/Sdk/ConverterInterface.php](src/Sdk/ConverterInterface.php) | Holds required converter methods to create SDK classes | |
| 39 | | [](src/Sdk/ExceptionInterface.php`ExceptionInterface`](src/Sdk/ExceptionInterface.php](src/Sdk/ExceptionInterface.php) | Default interface for all the exception models in SDK | |
| 40 | |
| 41 | ## Enumerations |
| 42 | | Name | Description | |
| 43 | |-------------------------------------------------------------------------------|-----------------------------------------------------------------| |
| 44 | | [](src/Core/Authentication/AuthGroup.php`AuthGroup`](src/Core/Authentication/AuthGroup.php](src/Core/Authentication/AuthGroup.php) | Enumeration for multiple Auth groups | |
| 45 | | [](src/Core/Request/RequestArraySerialization.php`RequestArraySerialization`](src/Core/Request/RequestArraySerialization.php](src/Core/Request/RequestArraySerialization.php) | Enumeration for all ArraySerialization formats | |
| 46 | | [](src/Core/Request/RequestMethod.php`RequestMethod`](src/Core/Request/RequestMethod.php](src/Core/Request/RequestMethod.php) | Enumeration for all possible types of requests | |
| 47 | | [](src/Core/Format.php`Format`](src/Core/Format.php](src/Core/Format.php) | Enumeration for different formats of request body and responses | |
| 48 | | [](src/Http/RetryOption.php`RetryOption`](src/Http/RetryOption.php](src/Http/RetryOption.php) | Enumeration for RetryingOption of each API call | |
| 49 | |
| 50 | |
| 51 | [packagist-url]: https://packagist.org/packages/apimatic/core-interfaces |
| 52 | [packagist-version]: https://img.shields.io/packagist/v/apimatic/core-interfaces.svg?style=flat |
| 53 | [packagist-downloads]: https://img.shields.io/packagist/dm/apimatic/core-interfaces.svg?style=flat |
| 54 | [license-badge]: https://img.shields.io/badge/license-MIT-blue |
| 55 | [license-url]: LICENSE |
| 56 |