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

npm install splitit-payments-sdk@1.0.7

For additional package details, see the Npm page for the splitit-payments-sdk@1.0.7 npm.

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:

npm run test

Or you can also run tests with coverage report:

npm run test:coverage

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

import {
  Client,
  Environment,
  OAuthScopeOAuth2ProductionEnum,
  OAuthScopeOAuth2SandboxEnum,
} from 'splitit-payments-sdk';

const client = new Client({
  oAuth2SandboxCredentials: {
    oAuthClientId: 'OAuthClientId',
    oAuthClientSecret: 'OAuthClientSecret',
    oAuthScopes: [
      OAuthScopeOAuth2SandboxEnum.ApiV3
    ]
  },
  oAuth2ProductionCredentials: {
    oAuthClientId: 'OAuthClientId',
    oAuthClientSecret: 'OAuthClientSecret',
    oAuthScopes: [
      OAuthScopeOAuth2ProductionEnum.ApiV3
    ]
  },
  timeout: 0,
  environment: Environment.Production,
});

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

This API uses the following authentication schemes.

• OAuth2-sandbox (OAuth 2 Client Credentials Grant)
• OAuth2-production (OAuth 2 Client Credentials Grant)

• Installment Plan

• HttpClientOptions
• RetryConfiguration
• ProxySettings

• HttpRequest

• ApiResponse
• ApiError