Signup API Client

CX Signup Journey Service API Client

This project contains the NPM library for the client which consumes the Signup API service.

Usage

To use the SignupClient class you need to have configuration available which points to the AWS stage (e.g. "dev") that the service api is deployed into. This is supplied to the client constructor:

    const signupClient = new SignupClient({
        stage: 'dev'
    });

Development

# Install Dependencies
$ yarn

# Run unit tests
$ yarn test

# Run integration tests against live API (defaults to 'test' stage)
$ yarn validate

Versioning

We use SemVer for versioning.

Authors

• CX BA Signup Scrum Team