0.0.1 • Published 12 months ago

tester-stripped-sdk-sdk v0.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
12 months ago

Getting Started with TesterS

Introduction

Testing various api features

Install the Package

Run the following command from your project directory to install the package from npm:

npm install tester-stripped-sdk-sdk@0.0.1

For additional package details, see the Npm page for the tester-stripped-sdk-sdk@0.0.1 npm.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

ParameterTypeDescription
portstringDefault: '80'
suitesSuiteCodeDefault: SuiteCode.Hearts
environmentEnvironmentThe API environment. Default: Environment.Testing
timeoutnumberTimeout for API calls.Default: 0
httpClientOptionsPartial<HttpClientOptions>Stable configurable http client options.
unstableHttpClientOptionsanyUnstable configurable http client options.

HttpClientOptions

ParameterTypeDescription
timeoutnumberTimeout in milliseconds.
httpAgentanyCustom http agent to be used when performing http requests.
httpsAgentanyCustom https agent to be used when performing http requests.
retryConfigPartial<RetryConfiguration>Configurations to retry requests.

RetryConfiguration

ParameterTypeDescription
maxNumberOfRetriesnumberMaximum number of retries. Default: 0
retryOnTimeoutbooleanWhether to retry on request timeout. Default: true
retryIntervalnumberInterval before next retry. Used in calculation of wait time for next request in case of failure. Default: 1
maximumRetryWaitTimenumberOverall wait time for the requests getting retried. Default: 0
backoffFactornumberUsed in calculation of wait time for next request in case of failure. Default: 2
httpStatusCodesToRetrynumber[]Http status codes to retry against. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
httpMethodsToRetryHttpMethod[]Http methods to retry against. Default: ['GET', 'PUT']

The API client can be initialized as follows:

const client = new Client({
  timeout: 0,
  environment: Environment.Testing,
});

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

NameDescription
production-
testingDefault

API Errors

Here is the list of errors that the API might throw.

HTTP Status CodeError DescriptionException Class
400400 GlobalApiError
402402 GlobalApiError
403403 GlobalApiError
404404 GlobalApiError
412Precondition FailedNestedModelExceptionError
500500 GlobalGlobalTestExceptionError
DefaultInvalid response.GlobalTestExceptionError

List of APIs

Classes Documentation