# @goodtok/sdk

> SDK for Goodtok

Latest version **0.1.18** (published 2023-12-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install @goodtok/sdk
pnpm add @goodtok/sdk
yarn add @goodtok/sdk
bun add @goodtok/sdk
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.18 |
| Published | 2023-12-23 |
| First published | 2023-10-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 317.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 100 |
| Author | Pedro Sanders |
| Maintainers | fonoster-oss |
| Keywords | Goodtok, VoIP, WebRTC, Fonoster, SIP.js, Web Phone, Phone, PeerJS, Contact Center |

## Links

- npm: https://www.npmjs.com/package/@goodtok/sdk
- Repository: https://github.com/fonoster/goodtok
- Homepage: https://github.com/fonoster/goodtok#readme
- Issues: https://github.com/fonoster/goodtok/issues
- npm.io page: https://npm.io/package/@goodtok/sdk

## Dependencies (8)

- [ws](https://npm.io/package/ws.md) ^8.14.2
- [buffer](https://npm.io/package/buffer.md) ^6.0.3
- [jwt-decode](https://npm.io/package/jwt-decode.md) ^4.0.0
- [@trpc/client](https://npm.io/package/@trpc/client.md) ^10.38.5
- [@trpc/server](https://npm.io/package/@trpc/server.md) ^10.38.5
- [isomorphic-ws](https://npm.io/package/isomorphic-ws.md) ^5.0.0
- [@fonoster/logger](https://npm.io/package/@fonoster/logger.md) 0.4.9
- [@goodtok/apiserver](https://npm.io/package/@goodtok/apiserver.md) ^0.1.18

## Recent versions

- 0.1.18 (latest) — 2023-12-23
- 0.1.17 — 2023-12-23
- 0.1.16 — 2023-12-23
- 0.1.14 — 2023-12-20
- 0.1.13 — 2023-12-12
- 0.1.11 — 2023-12-07
- 0.1.10 — 2023-12-01
- 0.1.8 — 2023-11-25
- 0.1.6 — 2023-11-25
- 0.1.5 — 2023-11-25
- 0.1.4 — 2023-11-24
- 0.1.2 — 2023-11-20
- 0.1.1 — 2023-11-19
- 0.1.0 — 2023-11-15
- 0.0.15 — 2023-11-14
- … 14 more at https://npm.io/package/@goodtok/sdk/versions

## README

sdk
=================

SDK for Goodtok Server

[![goodtok](https://img.shields.io/badge/goodtok-sdk-brightgreen.svg)](https://goodtok.io)
[![Version](https://img.shields.io/npm/v/@goodtok/sdk.svg)](https://npmjs.org/package/@goodtok/sdk)
[![Downloads/week](https://img.shields.io/npm/dw/@goodtok/sdk.svg)](https://npmjs.org/package/@goodtok/sdk)
[![License](https://img.shields.io/npm/l/@goodtok/sdk.svg)](https://github.com/fonoster/goodtok/blob/main/package.json)

* [Installation](#installation)
* [APIs](#apis)

# Installation

```sh-session
$ npm install --save @goodtok/sdk
```

# APIs

* [`Customers`](#Customers)
* [`Users`](#Users)
* [`Workspaces`](#Workspaces)
* [`Tokens`](#Tokens)


<a name="Customers"></a>

## Customers ⇐ <code>AbstractBaseClient</code>
Use the Goodtok Customers capability to retrieve and manage customers.
Ensure the Goodtok API Server is running for the Customers API to function.

**Kind**: global class  
**Extends**: <code>AbstractBaseClient</code>  
**See**: module:sdk:Client  

* [Customers](#Customers) ⇐ <code>AbstractBaseClient</code>
    * [new Customers(client)](#new_Customers_new)
    * [.getCustomerById(request)](#Customers+getCustomerById) ⇒ <code>Promise.&lt;Customer&gt;</code>
    * [.getOrdersByCustomerId(request)](#Customers+getOrdersByCustomerId) ⇒ <code>Promise.&lt;Array.&lt;Order&gt;&gt;</code>
    * [.getCustomerInDefaultWorkspace(id)](#Customers+getCustomerInDefaultWorkspace) ⇒ <code>Promise.&lt;Customer&gt;</code>

<a name="new_Customers_new"></a>

### new Customers(client)
Constructs a new Customers API object.


| Param | Type | Description |
| --- | --- | --- |
| client | <code>Client</code> | Object containing the client configuration |

**Example**  
```js
const SDK = require("@goodtok/sdk");

async function getCustomer() {
  const client = new SDK.Client({ workspace: "myworkspace" });
  await client.login("goodtok", "mysecretpassword");

  const customers = new SDK.Customers(client);
  const id = "5f9d7a3a-2b2b-4b7a-9b9b-8e9d9d9d9d9d";
  const customer = await customers.getCustomerById(id);

  console.log(customer);
}

getCustomer().catch(console.error);
```
<a name="Customers+getCustomerById"></a>

### customers.getCustomerById(request) ⇒ <code>Promise.&lt;Customer&gt;</code>
Retrieves a customer for a workspace by customer ID.

**Kind**: instance method of [<code>Customers</code>](#Customers)  
**Returns**: <code>Promise.&lt;Customer&gt;</code> - A promise resolving to the customer  
**Throws**:

- Will throw an error if the customer is not found


| Param | Type | Description |
| --- | --- | --- |
| request | <code>GetCustomerRequest</code> | Request object containing the customer ID and workspace ID |
| request.workspaceId | <code>string</code> | The workspace ID |
| request.customerId | <code>string</code> | The customer ID |

**Example**  
```js
const request = {
  workspaceId: "452b1b1b-1b1b-1b1b-1b1b-1b1b1b1b1b1b",
  customerId: "5f9d7a3a-2b2b-4b7a-9b9b-8e9d9d9d9d9d"
};

customers.getCustomer(request)
  .then(console.log)
  .catch(console.error); // handle any errors
```
<a name="Customers+getOrdersByCustomerId"></a>

### customers.getOrdersByCustomerId(request) ⇒ <code>Promise.&lt;Array.&lt;Order&gt;&gt;</code>
Retrieves a list of orders for a customer by customer ID.

**Kind**: instance method of [<code>Customers</code>](#Customers)  
**Returns**: <code>Promise.&lt;Array.&lt;Order&gt;&gt;</code> - A promise resolving to the list of orders  

| Param | Type | Description |
| --- | --- | --- |
| request | <code>GetOrdersByCustomerIdRequest</code> | Request object containing the customer ID and workspace ID |
| request.workspaceId | <code>string</code> | The workspace ID |
| request.customerId | <code>string</code> | The customer ID |

**Example**  
```js
const request = {
  workspaceId: "452b1b1b-1b1b-1b1b-1b1b-1b1b1b1b1b1b",
  customerId: "5f9d7a3a-2b2b-4b7a-9b9b-8e9d9d9d9d9d"
};

customers.getOrdersByCustomerId(request)
 .then(console.log)
 .catch(console.error); // handle any errors
```
<a name="Customers+getCustomerInDefaultWorkspace"></a>

### customers.getCustomerInDefaultWorkspace(id) ⇒ <code>Promise.&lt;Customer&gt;</code>
Retrieves a customer by ID in the default workspace.

**Kind**: instance method of [<code>Customers</code>](#Customers)  
**Returns**: <code>Promise.&lt;Customer&gt;</code> - A promise resolving to the customer  
**Throws**:

- Will throw an error if the customer is not found


| Param | Type | Description |
| --- | --- | --- |
| id | <code>string</code> | The customer ID |

**Example**  
```js
const id = "5f9d7a3a-2b2b-4b7a-9b9b-8e9d9d9d9d9d";
customers.getCustomerInDefaultWorkspace(id)
  .then(console.log)
  .catch(console.error); // handle any errors
```

<a name="Queues"></a>

## Queues ⇐ <code>AbstractBaseClient</code>
Use the Goodtok Queues capability to retrieve and manage queues.
Ensure the Goodtok API Server is running for the Queues API to function.

**Kind**: global class  
**Extends**: <code>AbstractBaseClient</code>  
**See**: module:sdk:Client  

* [Queues](#Queues) ⇐ <code>AbstractBaseClient</code>
    * [new Queues(client)](#new_Queues_new)
    * [.getDefaultWorkspaceQueue()](#Queues+getDefaultWorkspaceQueue) ⇒ <code>Promise.&lt;GetQueueResponse&gt;</code>
    * [.getQueueByWorkspaceId(id)](#Queues+getQueueByWorkspaceId) ⇒ <code>Promise.&lt;Workspace&gt;</code>
    * [.watchQueue(id, callback)](#Queues+watchQueue)
    * [.updateQueueEntryStatus(request)](#Queues+updateQueueEntryStatus) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.joinQueue(request)](#Queues+joinQueue) ⇒ <code>Promise.&lt;void&gt;</code>

<a name="new_Queues_new"></a>

### new Queues(client)
Constructs a new Queues API object.


| Param | Type | Description |
| --- | --- | --- |
| client | <code>Client</code> | Object containing the client configuration |

**Example**  
```js
const SDK = require("@goodtok/sdk");

async function getWorkspace() {
  const client = new SDK.Client({ workspace: "myworkspace" });
  await client.login("goodtok", "mysecretpassword");

  const workspaceId = "g-7b7c46fb05";

  const queues = new SDK.Queues(client);
  const queue = await workspaces.getQueueByWorkspaceId(workspaceId);

  console.log(workspace);
}

getWorkspace().catch(console.error);
```
<a name="Queues+getDefaultWorkspaceQueue"></a>

### queues.getDefaultWorkspaceQueue() ⇒ <code>Promise.&lt;GetQueueResponse&gt;</code>
Retrieves the queue for the default workspace.

**Kind**: instance method of [<code>Queues</code>](#Queues)  
**Returns**: <code>Promise.&lt;GetQueueResponse&gt;</code> - A promise resolving to the queue  
**Example**  
```js
workspaces.getDefaultWorkspaceQueue()
  .then(console.log)
  .catch(console.error); // handle any errors
```
<a name="Queues+getQueueByWorkspaceId"></a>

### queues.getQueueByWorkspaceId(id) ⇒ <code>Promise.&lt;Workspace&gt;</code>
Retrieves the queue for a workspace by its ID.

**Kind**: instance method of [<code>Queues</code>](#Queues)  
**Returns**: <code>Promise.&lt;Workspace&gt;</code> - A promise resolving to an object containing an array of queue entries  

| Param | Type | Description |
| --- | --- | --- |
| id | <code>string</code> | The workspace ID |

**Example**  
```js
const id = "g-7b7c46fb05";

queues.getQueueByWorkspaceId(id)
  .then(console.log)
  .catch(console.error); // handle any errors
```
<a name="Queues+watchQueue"></a>

### queues.watchQueue(id, callback)
Registers a callback for real-time updates on queue entries within a workspace.

**Kind**: instance method of [<code>Queues</code>](#Queues)  

| Param | Type | Description |
| --- | --- | --- |
| id | <code>string</code> | The ID of the workspace |
| callback | <code>function</code> | The callback to be invoked when a queue entry updates |

**Example**  
```js
const id = "4f9d5a3a-362b-7b7a-34gb-4e94969d7d2d";

queues.watchQueue(id, (err, data) => {
  if (err) {
   console.error(err);
   return;
  }

  console.log(data);
});
```
<a name="Queues+updateQueueEntryStatus"></a>

### queues.updateQueueEntryStatus(request) ⇒ <code>Promise.&lt;void&gt;</code>
Updates the status of a queue entry.

**Kind**: instance method of [<code>Queues</code>](#Queues)  
**Returns**: <code>Promise.&lt;void&gt;</code> - A promise resolving to void  

| Param | Type | Description |
| --- | --- | --- |
| request | <code>UpdateQueueEntryStatusRequest</code> | The request object |
| request.workspaceId | <code>string</code> | The workspace ID |
| request.customerId | <code>string</code> | The customer ID to update the queue entry for |
| request.status | <code>string</code> | The status to update the queue entry to |

**Example**  
```js
const request = {
 workspaceId: "g-7b7c46fb05",
 customerId: "4f9d5a3a-362b-7b7a-34gb-4e94969d7d2d",
 status: "DEQUEUED"
};

queues.updateQueueEntryStatus(request)
  .then(console.log)
  .catch(console.error); // handle any errors
```
<a name="Queues+joinQueue"></a>

### queues.joinQueue(request) ⇒ <code>Promise.&lt;void&gt;</code>
Adds a customer to a queue.

**Kind**: instance method of [<code>Queues</code>](#Queues)  
**Returns**: <code>Promise.&lt;void&gt;</code> - A promise resolving to void  

| Param | Type | Description |
| --- | --- | --- |
| request | <code>JoinQueueRequest</code> | The request object |
| request.workspaceId | <code>string</code> | The workspace ID |
| request.customerId | <code>string</code> | The customer ID to add to the queue |

**Example**  
```js
const request = {
 workspaceId: "g-7b7c46fb05",
 customerId: "4f9d5a3a-362b-7b7a-34gb-4e94969d7d2d"
};

queues.joinQueue(request)
 .then(console.log)
 .catch(console.error); // handle any errors
```

<a name="Tokens"></a>

## Tokens ⇐ <code>AbstractBaseClient</code>
Use the Goodtok Tokens capability to create and verify JWT tokens.
Ensure the Goodtok API Server is running for the Tokens API to function.

**Kind**: global class  
**Extends**: <code>AbstractBaseClient</code>  
**See**: module:sdk:Client  

* [Tokens](#Tokens) ⇐ <code>AbstractBaseClient</code>
    * [new Tokens(client)](#new_Tokens_new)
    * [.createAnonymousToken(request)](#Tokens+createAnonymousToken) ⇒ <code>Promise.&lt;string&gt;</code>
    * [.createToken(request)](#Tokens+createToken) ⇒ <code>Promise.&lt;string&gt;</code>

<a name="new_Tokens_new"></a>

### new Tokens(client)
Constructs a new Tokens API object.


| Param | Type | Description |
| --- | --- | --- |
| client | <code>Client</code> | Object containing the client configuration |

**Example**  
```js
const SDK = require("@goodtok/sdk");

async function createAnonymousToken() {
  const client = new SDK.Client({ workspace: "myworkspace" });
  await client.login("goodtok", "mysecretpassword");

  const tokens = new SDK.Tokens(client);

  const request = {
    ref: "myref",
    workspaceId: "g-1234567890",
    metadata: {
     customField: "customValue"
    }
  }

  const connectionObject = await tokens.createAnonymousToken(request);
  console.log(connectionObject);
}

createAnonymousToken().catch(console.error);
```
<a name="Tokens+createAnonymousToken"></a>

### tokens.createAnonymousToken(request) ⇒ <code>Promise.&lt;string&gt;</code>
Creates a new anonymous token for the specified workspace, and does not require authentication.

**Kind**: instance method of [<code>Tokens</code>](#Tokens)  
**Returns**: <code>Promise.&lt;string&gt;</code> - A promise resolving to the token  
**Throws**:

- Will throw an error if the workspace does not have the `anonymous` feature enabled


| Param | Type | Description |
| --- | --- | --- |
| request | <code>CreateAnonymousTokenInput</code> | A request with claims required to create a token |
| request.ref | <code>string</code> | A reference for the anonymous user |
| request.workspaceId | <code>string</code> | The workspace ID |
| request.metadata | <code>string</code> | Custom metadata to be included in the token |

**Example**  
```js
const request = {
  ref: "myref",
  workspaceId: "g-1234567890",
  metadata: {
   customField: "customValue"
  }
}

tokens.createAnonymousToken(request)
  .then(console.log)
  .catch(console.error) // handle any errors
```
<a name="Tokens+createToken"></a>

### tokens.createToken(request) ⇒ <code>Promise.&lt;string&gt;</code>
Creates a new token with the specified permissions.

**Kind**: instance method of [<code>Tokens</code>](#Tokens)  
**Returns**: <code>Promise.&lt;string&gt;</code> - A promise resolving to the token  
**Throws**:

- Will throw an error if the user is not logged in


| Param | Type | Description |
| --- | --- | --- |
| request | <code>CreateTokenInput</code> | A request with claims required to create the token |
| request.ref | <code>string</code> | A reference for the user |
| request.peerId | <code>string</code> | The peer ID for the user |

**Example**  
```js
const request = {
  ref: "myref",
  customerId: "121a4579",
  workspaceId: "g-1234567890"
};

tokens.createToken(request)
  .then(console.log)
  .catch(console.error); // handle any errors
```

<a name="Users"></a>

## Users ⇐ <code>AbstractBaseClient</code>
Use the Goodtok Users capability to retrieve and manage users.
Ensure the Goodtok API Server is running for the Users API to function.

**Kind**: global class  
**Extends**: <code>AbstractBaseClient</code>  
**See**: module:sdk:Client  

* [Users](#Users) ⇐ <code>AbstractBaseClient</code>
    * [new Users(client)](#new_Users_new)
    * [.getCurrentUser()](#Users+getCurrentUser) ⇒ <code>Promise.&lt;User&gt;</code>
    * [.getUserById(id)](#Users+getUserById) ⇒ <code>Promise.&lt;User&gt;</code>
    * [.updateUser(request)](#Users+updateUser) ⇒ <code>Promise.&lt;UpdateUserResponse&gt;</code>

<a name="new_Users_new"></a>

### new Users(client)
Constructs a new Users API object.


| Param | Type | Description |
| --- | --- | --- |
| client | <code>Client</code> | Object containing the client configuration |

**Example**  
```js
const SDK = require("@goodtok/sdk");

async function getUser() {
  const client = new SDK.Client({ workspace: "myworkspace" });
  await client.login("goodtok", "mysecretpassword");

  const users = new SDK.Users(client);
  const id = "5f9d7a3a-2b2b-4b7a-9b9b-8e9d9d9d9d9d";
  const user = await users.getUserById(id);

  console.log(user);
}

getUser().catch(console.error);
```
<a name="Users+getCurrentUser"></a>

### users.getCurrentUser() ⇒ <code>Promise.&lt;User&gt;</code>
Retrieves the logged-in user.

**Kind**: instance method of [<code>Users</code>](#Users)  
**Returns**: <code>Promise.&lt;User&gt;</code> - A promise resolving to the user  
**Throws**:

- Will throw an error if user is not logged in or the JWT token has expired

**Example**  
```js
const id = "5f9d7a3a-2b2b-4b7a-9b9b-8e9d9d9d9d9d";

users.getCurrentUser(id)
  .then(console.log)
  .catch(console.error); // handle any errors
```
<a name="Users+getUserById"></a>

### users.getUserById(id) ⇒ <code>Promise.&lt;User&gt;</code>
Retrieves a user by its ID. The calling user must have an admin role to retrieve other users.

**Kind**: instance method of [<code>Users</code>](#Users)  
**Returns**: <code>Promise.&lt;User&gt;</code> - A promise resolving to the user  
**Throws**:

- Will throw an error if the user is not found
- If the user is not an admin and the user ID does not match the logged-in user's ID


| Param | Type | Description |
| --- | --- | --- |
| id | <code>string</code> | The user ID |

**Example**  
```js
const id = "5f9d7a3a-2b2b-4b7a-9b9b-8e9d9d9d9d9d";

users.getUserById(id)
  .then(console.log)
  .catch(console.error); // handle any errors
```
<a name="Users+updateUser"></a>

### users.updateUser(request) ⇒ <code>Promise.&lt;UpdateUserResponse&gt;</code>
Updates a user's details. The calling user must have an admin role to update other users.

**Kind**: instance method of [<code>Users</code>](#Users)  
**Returns**: <code>Promise.&lt;UpdateUserResponse&gt;</code> - A promise resolving to the updated user's details  
**Throws**:

- If the user is not an admin and the user ID does not match the logged-in user's ID


| Param | Type | Description |
| --- | --- | --- |
| request | <code>UpdateUserRequest</code> | A request object containing the user ID and update data |
| request.name | <code>string</code> | Optional parameter to update the user's name |
| request.password | <code>string</code> | Optional parameter to update the user's password |
| request.avatar | <code>string</code> | Optional parameter to update the user's avatar |

**Example**  
```js
const request = {
  name: "John Doe",
  password: "mysecretpassword",
  avatar: "https://example.com/avatar.png"
};

users.updateUser(request)
  .then(console.log)
  .catch(console.error); // handle any errors
```

<a name="Workspaces"></a>

## Workspaces ⇐ <code>AbstractBaseClient</code>
Use the Goodtok Workspaces capability to retrieve and manage workspaces.
Ensure the Goodtok API Server is running for the Workspaces API to function.

**Kind**: global class  
**Extends**: <code>AbstractBaseClient</code>  
**See**: module:sdk:Client  

* [Workspaces](#Workspaces) ⇐ <code>AbstractBaseClient</code>
    * [new Workspaces(client)](#new_Workspaces_new)
    * [.createWorkspace(request)](#Workspaces+createWorkspace) ⇒ <code>Promise.&lt;Workspace&gt;</code>
    * [.getDefaultWorkspaceId()](#Workspaces+getDefaultWorkspaceId) ⇒ <code>string</code>
    * [.getDefaultWorkspace()](#Workspaces+getDefaultWorkspace) ⇒ <code>Promise.&lt;Workspace&gt;</code>
    * [.getDefaultWorkspaceMembers()](#Workspaces+getDefaultWorkspaceMembers) ⇒ <code>Promise.&lt;GetMembersResponse&gt;</code>
    * [.getWorkspaceById(id)](#Workspaces+getWorkspaceById) ⇒ <code>Promise.&lt;Workspace&gt;</code>
    * [.getMembersByWorkspaceId(id)](#Workspaces+getMembersByWorkspaceId) ⇒ <code>Promise.&lt;Workspace&gt;</code>
    * [.updateWorkspace(request)](#Workspaces+updateWorkspace) ⇒ <code>Promise.&lt;Workspace&gt;</code>
    * [.getWorkspaces()](#Workspaces+getWorkspaces) ⇒ <code>Promise.&lt;Array.&lt;Workspace&gt;&gt;</code>
    * [.addWorkspaceMember(request)](#Workspaces+addWorkspaceMember) ⇒ <code>Promise.&lt;Member&gt;</code>
    * [.removeWorkspaceMember(id)](#Workspaces+removeWorkspaceMember) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.removeWorkspace(id)](#Workspaces+removeWorkspace) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.resendWorkspaceMemberInvite(id)](#Workspaces+resendWorkspaceMemberInvite) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.watchWorkspaceStatus(id, callback)](#Workspaces+watchWorkspaceStatus) ⇒ <code>Unsubscribable</code>

<a name="new_Workspaces_new"></a>

### new Workspaces(client)
Constructs a new Workspaces API object.


| Param | Type | Description |
| --- | --- | --- |
| client | <code>Client</code> | Object containing the client configuration |

**Example**  
```js
const SDK = require("@goodtok/sdk");

async function getWorkspace() {
  const client = new SDK.Client({ workspace: "myworkspace" });
  await client.login("goodtok", "mysecretpassword");

  const workspaces = new SDK.Workspaces(client);
  const workspace = await workspaces.getDefaultWorkspace();

  console.log(workspace);
}

getWorkspace().catch(console.error);
```
<a name="Workspaces+createWorkspace"></a>

### workspaces.createWorkspace(request) ⇒ <code>Promise.&lt;Workspace&gt;</code>
Creates a new workspace.

**Kind**: instance method of [<code>Workspaces</code>](#Workspaces)  
**Returns**: <code>Promise.&lt;Workspace&gt;</code> - A promise resolving to the created workspace  

| Param | Type | Description |
| --- | --- | --- |
| request | <code>CreateWorkspaceRequest</code> | The request object containing the workspace name, timezone, and hours of operation |
| request.name | <code>string</code> | The workspace name |
| request.timezone | <code>string</code> | The workspace timezone |
| request.hoursOfOperation | <code>object</code> | The workspace hours of operation |

**Example**  
```js
const request = {
  name: "My Workspace",
  timezone: "America/New_York",
  hoursOfOperation: {
    Monday: { from: "09:00", to: "17:00" },
    Tuesday: { from: "09:00", to: "17:00" },
    // ...
  }
};

workspaces.createWorkspace(request)
 .then(console.log)
 .catch(console.error); // handle any errors
```
<a name="Workspaces+getDefaultWorkspaceId"></a>

### workspaces.getDefaultWorkspaceId() ⇒ <code>string</code>
Retrieves the default workspace ID.

**Kind**: instance method of [<code>Workspaces</code>](#Workspaces)  
**Returns**: <code>string</code> - The default workspace ID  
**Example**  
```js
workspaces.getDefaultWorkspaceId();
```
<a name="Workspaces+getDefaultWorkspace"></a>

### workspaces.getDefaultWorkspace() ⇒ <code>Promise.&lt;Workspace&gt;</code>
Retrieves the default workspace.

**Kind**: instance method of [<code>Workspaces</code>](#Workspaces)  
**Returns**: <code>Promise.&lt;Workspace&gt;</code> - A promise resolving to the workspace  
**Example**  
```js
workspaces.getDefaultWorkspace()
  .then(console.log)
  .catch(console.error); // handle any errors
```
<a name="Workspaces+getDefaultWorkspaceMembers"></a>

### workspaces.getDefaultWorkspaceMembers() ⇒ <code>Promise.&lt;GetMembersResponse&gt;</code>
Retrieves the members for the default workspace.

**Kind**: instance method of [<code>Workspaces</code>](#Workspaces)  
**Returns**: <code>Promise.&lt;GetMembersResponse&gt;</code> - A promise resolving to the members  
**Example**  
```js
workspaces.getDefaultWorkspaceMembers()
  .then(console.log)
  .catch(console.error); // handle any errors
```
<a name="Workspaces+getWorkspaceById"></a>

### workspaces.getWorkspaceById(id) ⇒ <code>Promise.&lt;Workspace&gt;</code>
Retrieves a workspace by its ID.

**Kind**: instance method of [<code>Workspaces</code>](#Workspaces)  
**Returns**: <code>Promise.&lt;Workspace&gt;</code> - A promise resolving to the workspace  

| Param | Type | Description |
| --- | --- | --- |
| id | <code>string</code> | The workspace ID |

**Example**  
```js
const id = "4f9d5a3a-362b-7b7a-34gb-4e94969d7d2d";

workspaces.getWorkspaceById(id)
  .then(console.log)
  .catch(console.error); // handle any errors
```
<a name="Workspaces+getMembersByWorkspaceId"></a>

### workspaces.getMembersByWorkspaceId(id) ⇒ <code>Promise.&lt;Workspace&gt;</code>
Retrieves the members for a workspace by its ID.

**Kind**: instance method of [<code>Workspaces</code>](#Workspaces)  
**Returns**: <code>Promise.&lt;Workspace&gt;</code> - A promise resolving to an object containing an array of members  

| Param | Type | Description |
| --- | --- | --- |
| id | <code>string</code> | The workspace ID |

**Example**  
```js
const id = "4f9d5a3a-362b-7b7a-34gb-4e94969d7d2d";

workspaces.getMembersByWorkspaceId(id)
  .then(console.log)
  .catch(console.error); // handle any errors
```
<a name="Workspaces+updateWorkspace"></a>

### workspaces.updateWorkspace(request) ⇒ <code>Promise.&lt;Workspace&gt;</code>
Updates the details of a workspace.

**Kind**: instance method of [<code>Workspaces</code>](#Workspaces)  
**Returns**: <code>Promise.&lt;Workspace&gt;</code> - A promise resolving to the updated workspace's details  

| Param | Type | Description |
| --- | --- | --- |
| request | <code>UpdateWorkspaceRequest</code> | The request object containing the workspace ID and update data |
| request.id | <code>string</code> | The workspace ID |
| request.name | <code>string</code> | The workspace name |
| request.timezone | <code>string</code> | The workspace timezone |
| request.hoursOfOperation | <code>object</code> | The workspace hours of operation |

**Example**  
```js
const request = {
  id: "4f9d5a3a-362b-7b7a-34gb-4e94969d7d2d",
  name: "My Workspace",
  timezone: "America/New_York",
  hoursOfOperation: {
    Monday: { from: "09:00", to: "17:00" },
    Tuesday: { from: "09:00", to: "17:00" },
    // ...
  }
};

workspaces.updateWorkspace(request)
  .then(console.log)
  .catch(console.error); // handle any errors
```
<a name="Workspaces+getWorkspaces"></a>

### workspaces.getWorkspaces() ⇒ <code>Promise.&lt;Array.&lt;Workspace&gt;&gt;</code>
Retrieves all workspaces for the authenticated user.

**Kind**: instance method of [<code>Workspaces</code>](#Workspaces)  
**Returns**: <code>Promise.&lt;Array.&lt;Workspace&gt;&gt;</code> - A promise resolving to an array of workspaces  
**Example**  
```js
workspaces.getWorkspaces()
 .then(console.log)
 .catch(console.error); // handle any errors
```
<a name="Workspaces+addWorkspaceMember"></a>

### workspaces.addWorkspaceMember(request) ⇒ <code>Promise.&lt;Member&gt;</code>
Adds a member to a workspace.

**Kind**: instance method of [<code>Workspaces</code>](#Workspaces)  
**Returns**: <code>Promise.&lt;Member&gt;</code> - A promise resolving to the added member  

| Param | Type | Description |
| --- | --- | --- |
| request | <code>AddWorkspaceMemberRequest</code> | The request object containing the workspace ID and member details |
| request.workspaceId | <code>string</code> | The workspace ID |
| request.name | <code>string</code> | The member name |
| request.email | <code>string</code> | The member email |
| request.role | <code>string</code> | The member role |

**Example**  
```js
const request = {
  workspaceId: "4f9d5a3a-362b-7b7a-34gb-4e94969d7d2d",
  name: "John Doe",
  email: "jhon@example.com",
  role: "MEMBER"
};

workspaces.addWorkspaceMember(request)
  .then(console.log)
  .catch(console.error); // handle any errors
```
<a name="Workspaces+removeWorkspaceMember"></a>

### workspaces.removeWorkspaceMember(id) ⇒ <code>Promise.&lt;void&gt;</code>
Removes a member from a workspace.

**Kind**: instance method of [<code>Workspaces</code>](#Workspaces)  
**Returns**: <code>Promise.&lt;void&gt;</code> - A promise resolving to void  

| Param | Type | Description |
| --- | --- | --- |
| id | <code>string</code> | The member ID |

**Example**  
```js
const id = "4f9d5a3a-362b-7b7a-34gb-4e94969d7d2d";

workspaces.removeWorkspaceMember(id)
  .then(console.log)
  .catch(console.error); // handle any errors
```
<a name="Workspaces+removeWorkspace"></a>

### workspaces.removeWorkspace(id) ⇒ <code>Promise.&lt;void&gt;</code>
Removes a workspace.

**Kind**: instance method of [<code>Workspaces</code>](#Workspaces)  
**Returns**: <code>Promise.&lt;void&gt;</code> - A promise resolving to void  

| Param | Type | Description |
| --- | --- | --- |
| id | <code>string</code> | The workspace ID |

**Example**  
```js
const id = "4f9d5a3a-362b-7b7a-34gb-4e94969d7d2d";

workspaces.removeWorkspace(id)
  .then(console.log)
  .catch(console.error); // handle any errors
```
<a name="Workspaces+resendWorkspaceMemberInvite"></a>

### workspaces.resendWorkspaceMemberInvite(id) ⇒ <code>Promise.&lt;void&gt;</code>
Resends a workspace member invite.

**Kind**: instance method of [<code>Workspaces</code>](#Workspaces)  
**Returns**: <code>Promise.&lt;void&gt;</code> - A promise resolving to void  

| Param | Type | Description |
| --- | --- | --- |
| id | <code>string</code> | The member ID |

**Example**  
```js
const id = "4f9d5a3a-362b-7b7a-34gb-4e94969d7d2d";

workspaces.resendWorkspaceMemberInvite(id)
  .then(console.log)
  .catch(console.error); // handle any errors
```
<a name="Workspaces+watchWorkspaceStatus"></a>

### workspaces.watchWorkspaceStatus(id, callback) ⇒ <code>Unsubscribable</code>
Registers a callback for real-time updates on workspace status.

**Kind**: instance method of [<code>Workspaces</code>](#Workspaces)  
**Returns**: <code>Unsubscribable</code> - An object containing the unsubscribe method  

| Param | Type | Description |
| --- | --- | --- |
| id | <code>string</code> | The ID of the workspace |
| callback | <code>function</code> | The callback to be invoked when the workspace status updates |

**Example**  
```js
const id = "4f9d5a3a-362b-7b7a-34gb-4e94969d7d2d";

workspaces.watchWorkspaceStatus(id, (err, data) => {
  if (err) {
   console.error(err);
   return;
  }

  console.log(data);
});
```

---
_Source: https://npm.io/package/@goodtok/sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._