@tough-solutions/tough.zone-sdk v1.0.0-dev.1

tough.zone SDK

tough.zone SDK aims to make integration with tough.zone easy.

Installation

npm install @tough-solutions/tough.zone-sdk

Usage

Authorization

In order to work with the public API, you will need an API key for the instance you are managing. After you obtained the API key, there are two ways to provide the API key to the SDK.

Using environment variables

When importing the SDK it will automatically initialize using TZ_API_KEY if it is set.

Using ToughZone.Auth.init()

If you prefer not to use environment variables as described above, you can manually initialize the SDK like so:

import { ToughZone } from "@tough-solutions/tough.zone-sdk"

ToughZone.Auth.init(yourApiKeyHere);

ToughZone.Auth.init() overrides the API key that might be set using the environment variable.

Managing tickets

Creating tickets

Creating amount tickets works like this:

import { ToughZone } from "@tough-solutions/tough.zone-sdk"

ToughZone.Tickets.createTickets(amount);

The call will return a promise that resolves with a list of the UUIDs of the created tickets.

Users can then log in with their tickets when they navigate to https://<yourToughZoneInstance>/ticket/<ticketUuid>.

Deleting tickets

Deleting existing tickets works like this:

import { ToughZone } from "@tough-solutions/tough.zone-sdk"

ToughZone.Tickets.deleteTickets(["ticketUuid1", "ticketUuid2"]);

The call will return a promise that resolves with true if at least one of the tickets was deleted successfully and with false if no ticket was deleted or the list was empty.

Contributions

Contributions are very welcome! Please see our contribution guide for more information.