Installation

1. Open you favorite IDE. We'll assume you use VS Code
2. Open VS Code terminal and type npm login
3. It'll generate you a link to use to login to NPM
4. Login to the user, that has access to @fully-ai scope.
5. If you don't have the account, ask proper people to send you the invite
6. After successful login, return to VS Code terminal
7. Type npm install @fully-ai/circus-sdk
8. Check that the package appeared in package.json in dev-dependencies

Usage

1. import { CircusAPI } from '@fully-ai/circus-sdk'; to import the package
2. Before you run any API request it's essential to login and init the usage:

const circusApi = new CircusAPI({
  baseUrl: '<link>',
  authUrl: '<link>',
  username: '<username_provided_by_circus_team>',
  password: '<password_provided_by_circus_team>',
  clientId: '<special_param_provided_by_circus_team>',
  grantType: '<special_param_provided_by_circus_team>',
});

const data = await circusApi.initAndGetOffer();

3. After successful init your data variable will have a proper list of products available for order. From that point, you're ready to go with usage

Types

If you actively use TS in your project, you may want to import models from the package.

Available models are:

• Basket
• Offer
• StartedOrder