chowly-api-client's Introduction

Chowly Api Client

Chowly Api Client is a Typescript library which implements chowly api. The library does not modify request and response payload.

Installation
Usage
Versioning
Contributing
Unit Tests
License

Installation

npm i @goparrot/chowly-api-client

Usage

Simple example

import { ChowlyApiClient, ICreateOrder } from '@goparrot/chowly-api-client';

const client = new ChowlyApiClient({
    apiKey: 'test',
    baseUrl: 'baseurl',
    maxRetries: 5
});

// Get menu
client.getMenu()
    .then(data => console.log(data))
    .catch(error => console.log(error));

// Create order
const chowlyOrder: ICreateOrder = { /* Create order payload */ };

client.createOrder(chowlyOrder)
    .then(data => console.log(data))
    .catch(error => console.log(error));

// Get order
const orderId: string = 'chowly-order-id';

client.getOrder(orderId)
    .then(data => console.log(data))
    .catch(error => console.log(error));

Available Options

`ChowlyApiClient` Options

apyKey: string;
baseUrl: string;
maxRetries?: number;

Name	Type	Default	Description
maxRetries	`Number`	`3`	The number of times to retry before failing. Also for control the delay between retried request is used the built-in `exponentialDelay` function is used (Exponential Backoff).
baseUrl	`String`	'https://api.chowlyinc.com'	The base URL against which to resolve every API call's (relative) path.
apiKey	`string`		The string which represents token for getting data from chowly client