Package Exports

channelape-sdk

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (channelape-sdk) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ChannelApe TypeScript SDK

TypeScript SDK for the ChannelApe REST API

Service	Develop	Master
CI Status
Quality Gate
Coverage

Getting Started

Create the channel api client with your credentials.

const clientConfiguration = new ClientConfigurationBuilder()
  .setUsername('johndoe123@test.com').setPassword('my_pass123#4').build();
const channelApeClient = new ChannelApeClient(clientConfiguration);

or if you have your sessionId:

const clientConfiguration = new ClientConfigurationBuilder()
  .setSessionId('e7fecb82-61f7-498e-a358-aa21eb0cd5e8').build();
const channelApeClient = new ChannelApeClient(clientConfiguration);

The channelape sdk is asynchronous and all functions return promises.

Sessions

A session is created when instantiating the client. It can be retrieved for later use.

channelapeClient.getSession()
  .then((session: Session) => {
    // do what you need to do with session data here
  });