@waoadb/contracts-client v0.0.16

Client Contracts

Overview

Shared typescript contracts for the client side of Different Breed's Services.

Warning

You likely don't want to use this package directly unless you wish to create an integration in a framework we don't offer an SDK for.

Please check here first and use a framework or language SDK when available: Supported Frameworks & Languages.

Usage Reference

(Public) For Use With the following services

• Client API
• Cart Management

Quick Start

To start using the contracts provided within this package run the following command in the root of your project:

npm i @waoadb/shared-client-contracts

This will install the package and enable you to extract the required models using the following syntax:

import {
  ClientCartModels,
  ClientCustomerModels,
} from '@waoadb/shared-client-contracts';

Once the grouped model has been imported the desired types can be used like so:

async function request(
  body: ClientCartModels.AddTicketToCartRequest
): Promise<ClientCartModels.AddTicketToCartResponse> {}