apimatic/core

Core logic and the utilities for the Apimatic's PHP SDK

0.2.1 2023-02-02 08:13 UTC

README

Version Tests Test Coverage Maintainability Licence

Introduction

Core logic and the utilities for the 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"

Request

Name Description
AdditionalFormParams Used to add additional form params to a request
AdditionalFormParams Used to add additional header params to a request
AdditionalQueryParams Used to add additional query params to a request
BodyParam Body parameter class
FormParam Form parameter class
HeaderParam Header parameter class
QueryParam Query parameter class
TemplateParam Template parameter class
RequestBuilder Used to instantiate a new Request object with the properties provided
Request Request class for an API call

Response

Name Description
DeserializableType Type handler used to deserialize Enums and DateTime
ErrorType Type handler used to throw exceptions from responses
ResponseMultiType Maps a group of types to response body
ResponseType Maps a model to response body
ResponseError Group of error types for response
ResponseHandler Response handler for an API call that holds all the above response handling features
Context Holds the current context i.e. the current request, response and other needed details

TestCase

Name Description
KeysAndValuesBodyMatcher Matches actual and expected body, considering both the keys and values
KeysBodyMatcher Matches actual and expected body, considering just the keys
NativeBodyMatcher A body matcher for native values like string, int etc
RawBodyMatcher Exactly matches the body received to expected body
HeadersMatcher Matches the headers received and the headers expected
StatusCodeMatcher Matches the HTTP status codes received to the expected ones
CoreTestCase Main class for a test case that performs assertions w/ all the above matchers