@pliancy/api-sdk

SDK wrapper for the Pliancy platform API

Usage no npm install needed!

<script type="module">
  import pliancyApiSdk from 'https://cdn.skypack.dev/@pliancy/api-sdk';
</script>

README

SDK for the Pliancy API

Currently Supported

  • Customers

    • getCustomers
    • getCustomerById

  • Users

    • getUsersByCustomerId

  • Apps

    • getApps

Install

# Yarn
yarn add @pliancy/api-sdk

# npm
npm install @pliancy/api-sdk

Usage

// environment defaults to dev. Pass 'prod' as the second argument for producton
import { Customer } from '@pliancy/api-sdk'

const api = new PliancyApi('myApiKey')
const customers: Customer[] = await api.getCustomers()

Test

yarn test
# or
yarn test.watch

Test Coverage

yarn test.cov
# then
yarn cov.view