hull-and-james-plc / hammett-washington-sdk
Vel corrupti volupt
1.7.0
2024-11-13 09:06 UTC
Requires
- php: ^7.2 || ^8.0
- ext-json: *
- apimatic/core: ~0.3.11
- apimatic/core-interfaces: ~0.1.5
- apimatic/unirest-php: ^4.0.0
Requires (Dev)
- phan/phan: 5.4.2
- phpunit/phpunit: ^7.5 || ^8.5 || ^9.5
- squizlabs/php_codesniffer: ^3.5
This package is not auto-updated.
Last update: 2025-03-20 07:36:15 UTC
README
Introduction
Simple calculator API hosted on APIMATIC
Install the Package
Run the following command to install the package and automatically add the dependency to your composer.json file:
composer require "hull-and-james-plc/hammett-washington-sdk:1.7.0"
Or add it to the composer.json file manually as given below:
"require": { "hull-and-james-plc/hammett-washington-sdk": "1.7.0" }
You can also view the package at: https://packagist.org/packages/hull-and-james-plc/hammett-washington-sdk#1.7.0
Test the SDK
Unit tests in this SDK can be run using PHPUnit.
- First install the dependencies using composer including the
require-dev
dependencies. - Run
vendor\bin\phpunit --verbose
from commandline to execute tests. If you have installed PHPUnit globally, run tests usingphpunit --verbose
instead.
You can change the PHPUnit test configuration in the phpunit.xml
file.
Initialize the API Client
Note: Documentation for the client can be found here.
The following parameters are configurable for the API Client:
Parameter | Type | Description |
---|---|---|
environment |
Environment |
The API environment. Default: Environment.PRODUCTION |
timeout |
int |
Timeout for API calls in seconds. Default: 0 |
enableRetries |
bool |
Whether to enable retries and backoff feature. Default: false |
numberOfRetries |
int |
The number of retries to make. Default: 0 |
retryInterval |
float |
The retry time interval between the endpoint calls. Default: 1 |
backOffFactor |
float |
Exponential backoff factor to increase interval between retries. Default: 2 |
maximumRetryWaitTime |
int |
The maximum wait time in seconds for overall retrying requests. Default: 0 |
retryOnTimeout |
bool |
Whether to retry on request timeout. Default: true |
httpStatusCodesToRetry |
array |
Http status codes to retry against. Default: 408, 413, 429, 500, 502, 503, 504, 521, 522, 524 |
httpMethodsToRetry |
array |
Http methods to retry against. Default: 'GET', 'PUT' |
The API client can be initialized as follows:
$client = APIMATICCalculatorClientBuilder::init() ->environment(Environment::PRODUCTION) ->build();