Getting Started with gumlet-rest-apis

Install the Package

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

``bash npm install gumlet-js-sdk@1.0.0`

For additional package details, see the Npm page for the gumlet-js-sdk@1.0.0 npm.

`Test the SDK`

To validate the functionality of this SDK, you can execute all tests located in the test directory. This SDK utilizes Jest as both the testing framework and test runner.

To run the tests, navigate to the root directory of the SDK and execute the following command:

`bash npm run test`

Or you can also run tests with coverage report:

`bash npm run test:coverage`

`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 | | --- | --- | --- | | timeout |number| Timeout for API calls. Default:0| | httpClientOptions |Partial| Stable configurable http client options. | | unstableHttpClientOptions |any| Unstable configurable http client options. | | customHeaderAuthenticationCredentials |CustomHeaderAuthenticationCredentials | The credential object for customHeaderAuthentication |

The API client can be initialized as follows:

`ts const client = new Client({ customHeaderAuthenticationCredentials: { 'Authorization': 'Authorization' }, timeout: 0, });`

`Authorization`

This API uses the following authentication schemes.

* sec0 (Custom Header Signature)`

List of APIs

* API Endpoints

SDK Infrastructure