apimatic/core-interfaces

Definition of the behavior of apimatic/core, apimatic/unirest-php and Apimatic's PHP SDK

0.1.0 2022-09-30 10:15 UTC

This package is auto-updated.

Last update: 2023-01-04 13:23:11 UTC


README

version Maintainability Licence

Introduction

Definition of the behavior of apimatic/core, apimatic/unirest-php and APIMatic's PHP SDK

Requirements

  • PHP v7.2.x => v8.1.x

Install the Package

Run the following command to install the package and automatically add the dependency to your composer.json file:

composer require "apimatic/core-interfaces"

Interfaces

Name Description
ContextInterface To save both Request and Response after the completion of response
AuthInterface To Provide abstraction for all AuthManagers
RequestInterface To get the properties from the instance of Request
RequestSetterInterface To update the instance of Request
ParamInterface To Provide abstraction for common functionality of Parameters
TypeValidatorInterface To Provide abstraction for type validation in Parameters
ResponseInterface To get the properties from the instance of Response
HttpConfigurations To hold the default configurations for HttpClient
HttpClientInterface To provide abstraction to execute API call in HttpClient
ConverterInterface Holds required converter methods to create SDK classes
ExceptionInterface Default interface for all the exception models in SDK

Enumerations

Name Description
AuthGroup Enumeration for multiple Auth groups
RequestArraySerialization Enumeration for all ArraySerialization formats
RequestMethod Enumeration for all possible types of requests
Format Enumeration for different formats of request body and responses
RetryOption Enumeration for RetryingOption of each API call