@great-detail/support-sdk

Great Detail Support System SDK - JS

Getting Started

import Client, { TokenAuthentication } from "@great-detail/support-sdk";

const auth = new TokenAuthentication();
const sdk = new Client(auth);

// List the stored contacts
const result = await sdk.contact.list.send().json();
console.log(result);

Handling Webhook Events

import Client from "@great-detail/support-sdk";

const { event } = await new Client().webhook
  .event({
    request,
  })
  .catch((error) => {
    // ...
  });

console.log(event);

Installation

npm install @great-detail/support-sdk

Authentication

The following authentication methods are supported with this SDK.

Token Authentication

Note: This is the primary authentication method intended to be used with this SDK.

import { TokenAuthentication } from "@great-detail/support-sdk";

// Note: This token should not be hardcoded into your use-case
process.env.SUPPORT_ACCESS_TOKEN = "...";

const auth = new TokenAuthentication();

Key Authentication

Note: Not all of the APIs will work with the key authentication method.

import { KeyAuthentication } from "@great-detail/support-sdk";

// Note: This api key should not be hardcoded into your use-case
process.env.SUPPORT_API_KEY = "...";

// Set api key in environment variable: SUPPORT_API_KEY
const auth = new KeyAuthentication();

Public Authentication

Note: Not all of the APIs will work with the public authentication method.

import { PublicAuthentication } from "@great-detail/support-sdk";

const auth = new PublicAuthentication();

License

Proprietary © 2024 Great Detail Ltd

Contact

Great Detail Ltd: <[e-mail]>

Dom Webber: https://domwebber.dev <[e-mail]>