@fonoster/sdk 0.6.1 → 0.6.2

package/README.md

@@ -61,6 +61,8 @@ const accessKeyId = "WO00000000000000000000000000000000";
 const client = new SDK.Client({ accessKeyId });
 ```
 
+By default, the Client object will point to Fonoster's cloud services. If you are running your own instance of Fonoster, you can specify the `endpoint` parameter to point to it.
+
 In the browser:
 
 ```typescript
@@ -69,45 +71,246 @@ const accessKeyId = "WO00000000000000000000000000000000";
 const client = new SDK.WebClient({ accessKeyId });
 ```
 
-### Initializing the client
+By default, the WebClient object points to Fonoster's cloud services. If you are running your own instance of Fonoster, you can specify the `url` parameter to point to it.
+
+### Login in and making requests
 
 ```typescript
 const username = "admin@fonoster.local";
 const password = "changeme";
 
-client.login(username, password)
- .then(console.log)
- .catch(console.error);
+async function main() {
+  await client.login(username, password);
+  const applications = new SDK.Applications(client);
+  await applications.createApplication({
+    name: "MyApp",
+    type: "PROGRAMMABLE_VOICE",
+    appEndpoint: "localhost:3000" // Your app's endpoint
+ });
+}
+
+main().catch(console.error);
 ```
 
-### Making a request
+In addition to the `login` method, the SDK provides a `loginWithApiKey` and `loginWithRefreshToken` methods. The `loginWithRefreshToken` is helpful in browser environments where you want to keep the user logged in between sessions.
 
-```typescript
-// Requires an initialized client object
-const applications = new SDK.Applications(client);
+The SDK will automatically refresh the token when it expires.
+
+## APIs
+
+* [`Applications`](#Applications)
+* [`Acls`](#Acls)
+* [`Agents`](#Agents)
+* [`ApiKeys`](#ApiKeys)
+* [`Calls`](#Calls)
+* [`Credentials`](#Credentials)
+* [`Domains`](#Domains)
+* [`Numbers`](#Numbers)
+* [`Secrets`](#Secrets)
+* [`Trunks`](#Trunks)
+* [`Users`](#Users)
+* [`Workspaces`](#Workspaces)
+
+
+<a name="Acls"></a>
+
+## Acls
+Fonoster Acls, part of the Fonoster SIP Proxy subsystem,
+allows you to create, update, retrieve, and delete Access Control Lists (ACLs) rules for your deployment.
+Note that an active Fonoster deployment is required.
+
+**Kind**: global class  
+**See**
+
+- AbstractClient
+- FonosterClient
+
+
+* [Acls](#Acls)
+    * [new Acls(client)](#new_Acls_new)
+    * [.createAcl(request)](#Acls+createAcl) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+    * [.getAcl(ref)](#Acls+getAcl) ⇒ <code>Promise.&lt;Acl&gt;</code>
+    * [.updateAcl(request)](#Acls+updateAcl) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+    * [.listAcls(request)](#Acls+listAcls) ⇒ <code>Promise.&lt;ListAclsResponse&gt;</code>
+    * [.deleteAcl(ref)](#Acls+deleteAcl) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+
+<a name="new_Acls_new"></a>
+
+### new Acls(client)
+Constructs a new Acls object.
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| client | <code>FonosterClient</code> | Client object with underlying implementations to make requests to Fonoster's API |
+
+**Example**  
+```js
+const SDK = require("@fonoster/sdk");
+
+async function main(request) {
+ const apiKey = "your-api-key";
+ const accessKeyId = "00000000-0000-0000-0000-000000000000";
+
+ try {
+    const client = SDK.Client({ accessKeyId });
+    await client.loginWithApiKey(apiKey);
+
+    const acls = new SDK.Acls(client);
+    const response = await acls.createAcl(request);
+
+    console.log(response); // successful response
+  } catch (e) {
+    console.error(e); // an error occurred
+  }
+}
 
 const request = {
-  name: "MyApp",
-  type: "PROGRAMMABLE_VOICE",
-  appEndpoint: "localhost:3000" // Your app endpoint
+  name: "My ACL",
+  allow: ["47.132.130.31"], // Allow only this IP
+  deny: ["0.0.0.0/0"] // Deny all other IPs
 };
 
-applications.createApplication(request)
- .then(console.log)
- .catch(console.error);
+main(request).catch(console.error);
 ```
+<a name="Acls+createAcl"></a>
 
-## APIs
+### acls.createAcl(request) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Creates a new Acl in the Workspace.
 
-* [`Applications`](#Applications)
+**Kind**: instance method of [<code>Acls</code>](#Acls)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the created Acl  
 
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>CreateAclRequest</code> | The request object that contains the necessary information to create a new Acl |
+| request.name | <code>string</code> | The name of the Acl |
+| request.allow | <code>Array.&lt;string&gt;</code> | The list of IPs to allow |
+| request.deny | <code>Array.&lt;string&gt;</code> | The list of IPs to deny |
 
+**Example**  
+```js
+const request = {
+ name: "My ACL",
+ allow: ["47.132.130.31"], // Allow only this IP
+ deny: ["0.0.0.0/0"] // Deny all other IPs
+};
 
-<a name="Applications"></a>
+const acls = new SDK.Acls(client); // Existing client object
 
-## Applications
-Fonoster Applications, part of the Fonoster Voice Subsystem,
-allow you to create, update, retrieve, and delete Voice Applications.
+acls.createAcl(request)
+.then(console.log) // successful response
+.catch(console.error); // an error occurred
+```
+<a name="Acls+getAcl"></a>
+
+### acls.getAcl(ref) ⇒ <code>Promise.&lt;Acl&gt;</code>
+Retrieves an existing Acl in the Workspace.
+
+**Kind**: instance method of [<code>Acls</code>](#Acls)  
+**Returns**: <code>Promise.&lt;Acl&gt;</code> - - The response object that contains the Acl information  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ref | <code>string</code> | The reference of the Acl to retrieve |
+
+**Example**  
+```js
+const ref = "00000000-0000-0000-0000-000000000000"
+
+const acls = new SDK.Acls(client); // Existing client object
+
+acls.getAcl(ref)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Acls+updateAcl"></a>
+
+### acls.updateAcl(request) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Updates an existing Acl in the Workspace.
+
+**Kind**: instance method of [<code>Acls</code>](#Acls)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the updated Acl  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>UpdateAclRequest</code> | The request object that contains the necessary information to update an existing Acl |
+| request.ref | <code>string</code> | The reference of the Acl to update |
+| request.name | <code>string</code> | The name of the Acl |
+| request.allow | <code>Array.&lt;string&gt;</code> | The list of IPs to allow |
+| request.deny | <code>Array.&lt;string&gt;</code> | The list of IPs to deny |
+
+**Example**  
+```js
+const request = {
+ ref: "00000000-0000-0000-0000-000000000000",
+ name: "My ACL",
+ allow: ["47.132.130.31"] // Allow only this IP
+ deny: ["0.0.0.0/0"] // Deny all other IPs
+};
+
+const acls = new SDK.Acls(client); // Existing client object
+
+acl.updateAcl(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Acls+listAcls"></a>
+
+### acls.listAcls(request) ⇒ <code>Promise.&lt;ListAclsResponse&gt;</code>
+Retrieves a list of Acls from a Workspace.
+
+**Kind**: instance method of [<code>Acls</code>](#Acls)  
+**Returns**: <code>Promise.&lt;ListAclsResponse&gt;</code> - - The response object that contains the list of Acls  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>ListAclsRequest</code> | The request object that contains the necessary information to retrieve a list of Acls |
+| request.pageSize | <code>number</code> | The number of Acls to retrieve |
+| request.pageToken | <code>string</code> | The token to retrieve the next page of Acls |
+
+**Example**  
+```js
+const request = {
+ pageSize: 10,
+ pageToken: "00000000-0000-0000-0000-000000000000"
+};
+
+const acls = new SDK.Acls(client); // Existing client object
+
+acls.listAcls(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Acls+deleteAcl"></a>
+
+### acls.deleteAcl(ref) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Deletes an existing Acl from Fonoster.
+Note that this operation is irreversible.
+
+**Kind**: instance method of [<code>Acls</code>](#Acls)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the deleted Acl  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ref | <code>string</code> | The reference of the Acl to delete |
+
+**Example**  
+```js
+const ref =  "00000000-0000-0000-0000-000000000000"
+
+const acls = new SDK.Acls(client); // Existing client object
+
+acls.deleteAcl(ref)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+
+<a name="Agents"></a>
+
+## Agents
+Fonoster Agents, part of the Fonoster SIP Proxy subsystem,
+allows you to create, update, retrieve, and delete SIP Agents for your deployment.
 Note that an active Fonoster deployment is required.
 
 **Kind**: global class  
@@ -117,18 +320,18 @@ Note that an active Fonoster deployment is required.
 - FonosterClient
 
 
-* [Applications](#Applications)
-    * [new Applications(client)](#new_Applications_new)
-    * [.createApplication(request)](#Applications+createApplication) ⇒ <code>Promise.&lt;CreateAppResponse&gt;</code>
-    * [.getApplication(request)](#Applications+getApplication) ⇒ <code>Promise.&lt;Application&gt;</code>
-    * [.updateApplication(request)](#Applications+updateApplication) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
-    * [.listApplications(request)](#Applications+listApplications) ⇒ <code>Promise.&lt;ListApplicationsResponse&gt;</code>
-    * [.deleteApplication(request)](#Applications+deleteApplication) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+* [Agents](#Agents)
+    * [new Agents(client)](#new_Agents_new)
+    * [.createAgent(request)](#Agents+createAgent) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+    * [.getAgent(ref)](#Agents+getAgent) ⇒ <code>Promise.&lt;Acl&gt;</code>
+    * [.updateAgent(request)](#Agents+updateAgent) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+    * [.listAgents(request)](#Agents+listAgents) ⇒ <code>Promise.&lt;ListAgentsResponse&gt;</code>
+    * [.deleteAgent(ref)](#Agents+deleteAgent) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
 
-<a name="new_Applications_new"></a>
+<a name="new_Agents_new"></a>
 
-### new Applications(client)
-Constructs a new Applications object.
+### new Agents(client)
+Constructs a new Agents object.
 
 
 | Param | Type | Description |
@@ -139,183 +342,139 @@ Constructs a new Applications object.
 ```js
 const SDK = require("@fonoster/sdk");
 
-const request = {
-  name: "My application",
-  type: "PROGRAMMABLE_VOICE",
-  appEndpoint: "myapp.mydomain.com",
-  textToSpeech: {
-    productRef: "tts.google",
-    config: {
-      voice: "en-US-Casual-K"
-    }
-  },
-  speechToText: {
-    productRef: "stt.google",
-    config: {
-     languageCode: "en-US"
-    }
-  },
-  intelligence: {
-    productRef: "nlu.dialogflowcx",
-    credentials: {
-       apiKey: "your-api-key"
-    },
-    config: {
-      agentId: "your-agent-id"
-    }
-  }
-};
+async function main(request) {
+ const apiKey = "your-api-key";
+ const accessKeyId = "00000000-0000-0000-0000-000000000000";
 
-const username = "admin@fonoster.local";
-const password = "changeme";
-const accessKeyId = "WO00000000000000000000000000000000";
+ try {
+    const client = SDK.Client({ accessKeyId });
+    await client.loginWithApiKey(apiKey);
 
-const client = new SDK.Client({ accessKeyId });
+    const agents = new SDK.Agents(client);
+    const response = await agents.createAgent(request);
+
+    console.log(response); // successful response
+  } catch (e) {
+    console.error(e); // an error occurred
+  }
+}
 
-client.login(username, password)
- .then(async () => {
-   const apps = new SDK.Applications(client);
-   const result = await apps.createApplication(request);
-   console.log(result);  // successful response
- }).catch(console.error); // an error occurred
+const request = {
+  name: "John Doe",
+  username: "1001",
+  privacy: "PRIVATE",
+  enabled: true,
+  maxContacts: 3
+  domainRef: "00000000-0000-0000-0000-000000000000"
+};
+
+main(request).catch(console.error);
 ```
-<a name="Applications+createApplication"></a>
+<a name="Agents+createAgent"></a>
 
-### applications.createApplication(request) ⇒ <code>Promise.&lt;CreateAppResponse&gt;</code>
-Creates a new Application in Fonoster. The only required fields are the name and type of the application.
+### agents.createAgent(request) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Creates a new Agent in the Workspace.
 
-**Kind**: instance method of [<code>Applications</code>](#Applications)  
-**Returns**: <code>Promise.&lt;CreateAppResponse&gt;</code> - - The response object that contains the reference to the newly created application  
+**Kind**: instance method of [<code>Agents</code>](#Agents)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the created Agent  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| request | <code>CreateApplicationRequest</code> | The request object that contains the necessary information to create a new application |
-| request.name | <code>string</code> | The name of the application |
-| request.type | <code>ApplicationType</code> | The type of application (e.g., PROGRAMMABLE_VOICE) |
-| request.appEndpoint | <code>string</code> | The endpoint where the application is hosted |
-| request.textToSpeech | <code>TextToSpeech</code> | The text-to-speech configuration |
-| request.textToSpeech.productRef | <code>string</code> | The product reference of the text-to-speech engine (e.g., tts.google) |
-| request.textToSpeech.config | <code>object</code> | The configuration object for the text-to-speech engine (e.g., { voice: "en-US-Casual-K" }) |
-| request.speechToText | <code>SpeechToText</code> | The speech-to-text configuration |
-| request.speechToText.productRef | <code>string</code> | The product reference of the speech-to-text engine (e.g., stt.google) |
-| request.speechToText.config | <code>object</code> | The configuration object for the speech-to-text engine (e.g., { languageCode: "en-US" }) |
-| request.intelligence | <code>Intelligence</code> | The intelligence configuration |
-| request.intelligence.productRef | <code>string</code> | The product reference of the intelligence engine (e.g., nlu.dialogflowcx) |
-| request.intelligence.credentials | <code>object</code> | The credentials object for the intelligence engine (e.g., { apiKey: "your-api-key" }) |
-| request.intelligence.config | <code>object</code> | The configuration object for the intelligence engine (e.g., { agentId: "your-agent-id" }) |
+| request | <code>CreateAgentRequest</code> | The request object that contains the necessary information to create a new Agent |
+| request.name | <code>string</code> | The name of the Agent |
+| request.username | <code>string</code> | The username of the Agent |
+| request.privacy | <code>Privacy</code> | The privacy of the Agent |
+| request.enabled | <code>boolean</code> | The status of the Agent |
+| request.maxContacts | <code>number</code> | The maximum number of contacts the Agent can have |
+| request.domainRef | <code>string</code> | The reference of the Domain to associate the Agent |
 
 **Example**  
 ```js
 const request = {
-  name: "My application",
-  type: "PROGRAMMABLE_VOICE",
-  appEndpoint: "myapp.mydomain.com",
-  textToSpeech: {
-    productRef: "tts.google",
-    config: {
-      voice: "en-US-Casual-K"
-    }
-  },
-  speechToText: {
-    productRef: "stt.google",
-    config: {
-     languageCode: "en-US"
-    }
-  },
-  intelligence: {
-    productRef: "nlu.dialogflowcx",
-    credentials: {
-       apiKey: "your-api-key"
-    },
-    config: {
-      agentId: "your-agent-id"
-    }
-  }
+ name: "John Doe",
+ username: "1001",
+ privacy: "PRIVATE",
+ enabled: true,
+ maxContacts: 3
+ domainRef: "00000000-0000-0000-0000-000000000000"
 };
 
-const apps = new SDK.Applications(client); // Existing client object
+const agents = new SDK.Agents(client); // Existing client object
 
-apps.createApplication(request)
+agents.createAgent(request)
  .then(console.log) // successful response
  .catch(console.error); // an error occurred
 ```
-<a name="Applications+getApplication"></a>
+<a name="Agents+getAgent"></a>
 
-### applications.getApplication(request) ⇒ <code>Promise.&lt;Application&gt;</code>
-Retrieves an existing application from Fonoster.
+### agents.getAgent(ref) ⇒ <code>Promise.&lt;Acl&gt;</code>
+Retrieves an existing Agent in the Workspace.
 
-**Kind**: instance method of [<code>Applications</code>](#Applications)  
-**Returns**: <code>Promise.&lt;Application&gt;</code> - - The response object that contains the application information  
+**Kind**: instance method of [<code>Agents</code>](#Agents)  
+**Returns**: <code>Promise.&lt;Acl&gt;</code> - - The response object that contains the Agent information  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| request | <code>GetApplicationRequest</code> | The request object that contains the necessary information to retrieve an application |
-| request.ref | <code>string</code> | The reference of the application to retrieve |
+| ref | <code>string</code> | The reference of the Agent to retrieve |
 
 **Example**  
 ```js
-const request = {
- ref: "00000000-0000-0000-0000-000000000000"
-};
+const ref = "00000000-0000-0000-0000-000000000000"
 
-const apps = new SDK.Applications(client); // Existing client object
+const agents = new SDK.Agents(client); // Existing client object
 
-apps.getApplication(request)
+agents.getAgent(ref)
  .then(console.log) // successful response
  .catch(console.error); // an error occurred
 ```
-<a name="Applications+updateApplication"></a>
+<a name="Agents+updateAgent"></a>
 
-### applications.updateApplication(request) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
-Updates an existing application in Fonoster.
+### agents.updateAgent(request) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Updates an existing Agent in the Workspace.
 
-**Kind**: instance method of [<code>Applications</code>](#Applications)  
-**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the updated application  
+**Kind**: instance method of [<code>Agents</code>](#Agents)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the updated Agent  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| request | <code>UpdateApplicationRequest</code> | The request object that contains the necessary information to update an application |
-| request.ref | <code>string</code> | The reference of the application to update |
-| request.name | <code>string</code> | The name of the application |
-| request.appEndpoint | <code>string</code> | The endpoint where the application is hosted |
-| request.textToSpeech | <code>TextToSpeech</code> | The text-to-speech configuration |
-| request.textToSpeech.productRef | <code>string</code> | The product reference of the text-to-speech engine (e.g., tts.google) |
-| request.textToSpeech.config | <code>object</code> | The configuration object for the text-to-speech engine (e.g., { voice: "en-US-Casual-K" }) |
-| request.speechToText | <code>SpeechToText</code> | The speech-to-text configuration |
-| request.speechToText.productRef | <code>string</code> | The product reference of the speech-to-text engine (e.g., stt.google) |
-| request.speechToText.config | <code>object</code> | The configuration object for the speech-to-text engine (e.g., { languageCode: "en-US" }) |
-| request.intelligence | <code>Intelligence</code> | The intelligence configuration |
-| request.intelligence.productRef | <code>string</code> | The product reference of the intelligence engine (e.g., nlu.dialogflowcx) |
-| request.intelligence.credentials | <code>object</code> | The credentials object for the intelligence engine (e.g., { apiKey: "your-api-key" }) |
-| request.intelligence.config | <code>object</code> | The configuration object for the intelligence engine (e.g., { agentId: "your-agent-id" }) |
+| request | <code>UpdateAgentRequest</code> | The request object that contains the necessary information to update an existing Agent |
+| request.ref | <code>string</code> | The reference of the Agent to update |
+| request.name | <code>string</code> | The name of the Agent |
+| request.privacy | <code>Privacy</code> | The privacy of the Agent |
+| request.enabled | <code>boolean</code> | The status of the Agent |
+| request.maxContacts | <code>number</code> | The maximum number of contacts the Agent can have |
+| request.domainRef | <code>string</code> | The reference of the Domain to associate the Agent |
 
 **Example**  
 ```js
 const request = {
  ref: "00000000-0000-0000-0000-000000000000",
- name: "My application",
- appEndpoint: "myapp.mydomain.com"
-}
+ name: "John Doe",
+ privacy: "PRIVATE",
+ enabled: true,
+ maxContacts: 3
+ domainRef: "00000000-0000-0000-0000-000000000000"
+};
 
-const apps = new SDK.Applications(client); // Existing client object
+const agents = new SDK.Agents(client); // Existing client object
 
-apps.updateApplication(request)
+agents.updateAgent(request)
  .then(console.log) // successful response
  .catch(console.error); // an error occurred
 ```
-<a name="Applications+listApplications"></a>
+<a name="Agents+listAgents"></a>
 
-### applications.listApplications(request) ⇒ <code>Promise.&lt;ListApplicationsResponse&gt;</code>
-Retrieves a list of applications from Fonoster.
+### agents.listAgents(request) ⇒ <code>Promise.&lt;ListAgentsResponse&gt;</code>
+Retrieves a list of Agents from a Workspace.
 
-**Kind**: instance method of [<code>Applications</code>](#Applications)  
-**Returns**: <code>Promise.&lt;ListApplicationsResponse&gt;</code> - - The response object that contains the list of applications  
+**Kind**: instance method of [<code>Agents</code>](#Agents)  
+**Returns**: <code>Promise.&lt;ListAgentsResponse&gt;</code> - - The response object that contains the list of Agents  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| request | <code>ListApplicationsRequest</code> | The request object that contains the necessary information to retrieve a list of applications |
-| request.pageSize | <code>number</code> | The number of applications to retrieve |
-| request.pageToken | <code>string</code> | The token to retrieve the next page of applications |
+| request | <code>ListAgentsRequest</code> | The request object that contains the necessary information to retrieve a list of Agents |
+| request.pageSize | <code>number</code> | The number of Agents to retrieve |
+| request.pageToken | <code>string</code> | The token to retrieve the next page of Agents |
 
 **Example**  
 ```js
@@ -324,35 +483,2008 @@ const request = {
  pageToken: "00000000-0000-0000-0000-000000000000"
 };
 
-const apps = new SDK.Applications(client); // Existing client object
+const agents = new SDK.Agents(client); // Existing client object
 
-apps.listApplications(request)
+agents.listAgents(request)
  .then(console.log) // successful response
  .catch(console.error); // an error occurred
 ```
-<a name="Applications+deleteApplication"></a>
+<a name="Agents+deleteAgent"></a>
 
-### applications.deleteApplication(request) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
-Deletes an existing application from Fonoster.
+### agents.deleteAgent(ref) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Deletes an existing Agent from Fonoster.
 Note that this operation is irreversible.
 
-**Kind**: instance method of [<code>Applications</code>](#Applications)  
-**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the deleted application  
+**Kind**: instance method of [<code>Agents</code>](#Agents)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the deleted Agent  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| request | <code>DeleteApplicationRequest</code> | The request object that contains the necessary information to delete an application |
-| request.ref | <code>string</code> | The reference of the application to delete |
+| ref | <code>string</code> | The reference of the Agent to delete |
 
 **Example**  
 ```js
-const request = {
- ref: "00000000-0000-0000-0000-000000000000"
-};
+const ref =  "00000000-0000-0000-0000-000000000000"
 
-const apps = new SDK.Applications(client); // Existing client object
+const agents = new SDK.Agents(client); // Existing client object
+
+agents.deleteAgent(ref)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+
+<a name="ApiKeys"></a>
+
+## ApiKeys
+Fonoster ApiKeys, part of the Fonoster Identity subsystem,
+allows you to create, update, retrieve, and delete ApiKeys for your deployment.
+Note that an active Fonoster deployment is required.
+
+**Kind**: global class  
+**See**
+
+- AbstractClient
+- FonosterClient
+
+
+* [ApiKeys](#ApiKeys)
+    * [new ApiKeys(client)](#new_ApiKeys_new)
+    * [.createApiKey(request)](#ApiKeys+createApiKey) ⇒ <code>Promise.&lt;CreateApiKeyResponse&gt;</code>
+    * [.regenerateApiKey(ref)](#ApiKeys+regenerateApiKey) ⇒ <code>Promise.&lt;CreateApiKeyResponse&gt;</code>
+    * [.listApiKeys(request)](#ApiKeys+listApiKeys) ⇒ <code>Promise.&lt;ListApiKeysResponse&gt;</code>
+    * [.deleteApiKey(ref)](#ApiKeys+deleteApiKey) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+
+<a name="new_ApiKeys_new"></a>
+
+### new ApiKeys(client)
+Constructs a new ApiKeys object.
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| client | <code>FonosterClient</code> | Client object with underlying implementations to make requests to Fonoster's API |
+
+**Example**  
+```js
+const SDK = require("@fonoster/sdk");
+
+async function main(request) {
+ const apiKey = "your-api-key";
+ const accessKeyId = "00000000-0000-0000-0000-000000000000";
+
+ try {
+    const client = SDK.Client({ accessKeyId });
+    await client.loginWithApiKey(apiKey);
+
+    const apiKeys = new SDK.ApiKeys(client);
+    const response = await apiKeys.createApiKey(request);
+
+    console.log(response); // successful response
+  } catch (e) {
+    console.error(e); // an error occurred
+  }
+}
+
+const request = {
+  role: "WORKSPACE_ADMIN"
+};
+
+main(request).catch(console.error);
+```
+<a name="ApiKeys+createApiKey"></a>
+
+### apiKeys.createApiKey(request) ⇒ <code>Promise.&lt;CreateApiKeyResponse&gt;</code>
+Creates a new ApiKey for a Workspace.
+
+**Kind**: instance method of [<code>ApiKeys</code>](#ApiKeys)  
+**Returns**: <code>Promise.&lt;CreateApiKeyResponse&gt;</code> - - The response object that contains the reference to the created ApiKey  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>CreateApiKeyRequest</code> | The request object that contains the necessary information to create a new ApiKey |
+| request.role | <code>ApiRoleEnum</code> | The role of the ApiKey |
+
+**Example**  
+```js
+const request = {
+ role: "WORKSPACE_ADMIN"
+};
+
+const apiKeys = new SDK.ApiKeys(client); // Existing client object
+
+apiKeys.createApiKey(request)
+.then(console.log) // successful response
+.catch(console.error); // an error occurred
+```
+<a name="ApiKeys+regenerateApiKey"></a>
+
+### apiKeys.regenerateApiKey(ref) ⇒ <code>Promise.&lt;CreateApiKeyResponse&gt;</code>
+Regenerates an existing ApiKey for a Workspace.
+Note that this operation is irreversible.
+
+**Kind**: instance method of [<code>ApiKeys</code>](#ApiKeys)  
+**Returns**: <code>Promise.&lt;CreateApiKeyResponse&gt;</code> - - The response object that contains the reference to the regenerated ApiKey  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ref | <code>string</code> | The reference of the ApiKey to regenerate |
+
+**Example**  
+```js
+const ref =  "00000000-0000-0000-0000-000000000000"
+
+const apiKeys = new SDK.ApiKeys(client); // Existing client object
+
+apiKeys.regenerateApiKey(ref)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="ApiKeys+listApiKeys"></a>
+
+### apiKeys.listApiKeys(request) ⇒ <code>Promise.&lt;ListApiKeysResponse&gt;</code>
+Retrieves a list of ApiKeys from a Workspace.
+
+**Kind**: instance method of [<code>ApiKeys</code>](#ApiKeys)  
+**Returns**: <code>Promise.&lt;ListApiKeysResponse&gt;</code> - - The response object that contains the list of ApiKeys  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>ListApiKeysRequest</code> | The request object that contains the necessary information to retrieve a list of ApiKeys |
+| request.pageSize | <code>number</code> | The number of ApiKeys to retrieve |
+| request.pageToken | <code>string</code> | The token to retrieve the next page of ApiKeys |
+
+**Example**  
+```js
+const request = {
+ pageSize: 10,
+ pageToken: "00000000-0000-0000-0000-000000000000"
+};
+
+const apiKeys = new SDK.ApiKeys(client); // Existing client object
+
+apiKeys.listApiKeys(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="ApiKeys+deleteApiKey"></a>
+
+### apiKeys.deleteApiKey(ref) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Deletes an existing ApiKey from Fonoster.
+Note that this operation is irreversible.
+
+**Kind**: instance method of [<code>ApiKeys</code>](#ApiKeys)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the deleted ApiKey  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ref | <code>string</code> | The reference of the ApiKey to delete |
+
+**Example**  
+```js
+const ref =  "00000000-0000-0000-0000-000000000000"
+
+const apiKeys = new SDK.ApiKeys(client); // Existing client object
+
+apiKeys.deleteApiKey(ref)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+
+<a name="Applications"></a>
+
+## Applications
+Fonoster Applications, part of the Fonoster Voice Subsystem,
+allow you to create, update, retrieve, and delete Voice Applications.
+Note that an active Fonoster deployment is required.
+
+**Kind**: global class  
+**See**
+
+- AbstractClient
+- FonosterClient
+
+
+* [Applications](#Applications)
+    * [new Applications(client)](#new_Applications_new)
+    * [.createApplication(request)](#Applications+createApplication) ⇒ <code>Promise.&lt;CreateAppResponse&gt;</code>
+    * [.getApplication(ref)](#Applications+getApplication) ⇒ <code>Promise.&lt;Application&gt;</code>
+    * [.updateApplication(request)](#Applications+updateApplication) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+    * [.listApplications(request)](#Applications+listApplications) ⇒ <code>Promise.&lt;ListApplicationsResponse&gt;</code>
+    * [.deleteApplication(ref)](#Applications+deleteApplication) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+
+<a name="new_Applications_new"></a>
+
+### new Applications(client)
+Constructs a new Applications object.
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| client | <code>FonosterClient</code> | Client object with underlying implementations to make requests to Fonoster's API |
+
+**Example**  
+```js
+const SDK = require("@fonoster/sdk");
+
+async function main(request) {
+ const apiKey = "your-api-key";
+ const accessKeyId = "00000000-0000-0000-0000-000000000000";
+
+ try {
+    const client = SDK.Client({ accessKeyId });
+    await client.loginWithApiKey(apiKey);
+
+    const apps = new SDK.Applications(client);
+    const response = await apps.createApplication(request);
+
+    console.log(response); // successful response
+  } catch (e) {
+    console.error(e); // an error occurred
+  }
+}
+
+const request = {
+  name: "My application",
+  type: "PROGRAMMABLE_VOICE",
+  appEndpoint: "myapp.mydomain.com",
+  textToSpeech: {
+    productRef: "tts.google",
+    config: {
+      voice: "en-US-Casual-K"
+    }
+  },
+  speechToText: {
+    productRef: "stt.google",
+    config: {
+     languageCode: "en-US"
+    }
+  },
+  intelligence: {
+    productRef: "nlu.dialogflowcx",
+    credentials: {
+       apiKey: "your-api-key"
+    },
+    config: {
+      agentId: "your-agent-id"
+    }
+  }
+};
+
+main(request).catch(console.error);
+```
+<a name="Applications+createApplication"></a>
+
+### applications.createApplication(request) ⇒ <code>Promise.&lt;CreateAppResponse&gt;</code>
+Creates a new Application in Fonoster. The only required fields are the name and type of the application.
+
+**Kind**: instance method of [<code>Applications</code>](#Applications)  
+**Returns**: <code>Promise.&lt;CreateAppResponse&gt;</code> - - The response object that contains the reference to the newly created application  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>CreateApplicationRequest</code> | The request object that contains the necessary information to create a new application |
+| request.name | <code>string</code> | The name of the application |
+| request.type | <code>ApplicationType</code> | The type of application (e.g., PROGRAMMABLE_VOICE) |
+| request.appEndpoint | <code>string</code> | The endpoint where the application is hosted |
+| request.textToSpeech | <code>TextToSpeech</code> | The text-to-speech configuration |
+| request.textToSpeech.productRef | <code>string</code> | The product reference of the text-to-speech engine (e.g., tts.google) |
+| request.textToSpeech.config | <code>object</code> | The configuration object for the text-to-speech engine (e.g., { voice: "en-US-Casual-K" }) |
+| request.speechToText | <code>SpeechToText</code> | The speech-to-text configuration |
+| request.speechToText.productRef | <code>string</code> | The product reference of the speech-to-text engine (e.g., stt.google) |
+| request.speechToText.config | <code>object</code> | The configuration object for the speech-to-text engine (e.g., { languageCode: "en-US" }) |
+| request.intelligence | <code>Intelligence</code> | The intelligence configuration |
+| request.intelligence.productRef | <code>string</code> | The product reference of the intelligence engine (e.g., nlu.dialogflowcx) |
+| request.intelligence.credentials | <code>object</code> | The credentials object for the intelligence engine (e.g., { apiKey: "your-api-key" }) |
+| request.intelligence.config | <code>object</code> | The configuration object for the intelligence engine (e.g., { agentId: "your-agent-id" }) |
+
+**Example**  
+```js
+const request = {
+  name: "My application",
+  type: "PROGRAMMABLE_VOICE",
+  appEndpoint: "myapp.mydomain.com",
+  textToSpeech: {
+    productRef: "tts.google",
+    config: {
+      voice: "en-US-Casual-K"
+    }
+  },
+  speechToText: {
+    productRef: "stt.google",
+    config: {
+     languageCode: "en-US"
+    }
+  },
+  intelligence: {
+    productRef: "nlu.dialogflowcx",
+    credentials: {
+       apiKey: "your-api-key"
+    },
+    config: {
+      agentId: "your-agent-id"
+    }
+  }
+};
+
+const apps = new SDK.Applications(client); // Existing client object
+
+apps.createApplication(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Applications+getApplication"></a>
+
+### applications.getApplication(ref) ⇒ <code>Promise.&lt;Application&gt;</code>
+Retrieves an existing Application in the Workspace.
+
+**Kind**: instance method of [<code>Applications</code>](#Applications)  
+**Returns**: <code>Promise.&lt;Application&gt;</code> - - The response object that contains the Application information  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ref | <code>string</code> | The reference of the Application to retrieve |
+
+**Example**  
+```js
+const ref = "00000000-0000-0000-0000-000000000000"
+
+const apps = new SDK.Applications(client); // Existing client object
+
+apps.getApplication(ref)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Applications+updateApplication"></a>
+
+### applications.updateApplication(request) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Updates an existing application in Fonoster.
+
+**Kind**: instance method of [<code>Applications</code>](#Applications)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the updated application  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>UpdateApplicationRequest</code> | The request object that contains the necessary information to update an application |
+| request.ref | <code>string</code> | The reference of the application to update |
+| request.name | <code>string</code> | The name of the application |
+| request.appEndpoint | <code>string</code> | The endpoint where the application is hosted |
+| request.textToSpeech | <code>TextToSpeech</code> | The text-to-speech configuration |
+| request.textToSpeech.productRef | <code>string</code> | The product reference of the text-to-speech engine (e.g., tts.google) |
+| request.textToSpeech.config | <code>object</code> | The configuration object for the text-to-speech engine (e.g., { voice: "en-US-Casual-K" }) |
+| request.speechToText | <code>SpeechToText</code> | The speech-to-text configuration |
+| request.speechToText.productRef | <code>string</code> | The product reference of the speech-to-text engine (e.g., stt.google) |
+| request.speechToText.config | <code>object</code> | The configuration object for the speech-to-text engine (e.g., { languageCode: "en-US" }) |
+| request.intelligence | <code>Intelligence</code> | The intelligence configuration |
+| request.intelligence.productRef | <code>string</code> | The product reference of the intelligence engine (e.g., nlu.dialogflowcx) |
+| request.intelligence.credentials | <code>object</code> | The credentials object for the intelligence engine (e.g., { apiKey: "your-api-key" }) |
+| request.intelligence.config | <code>object</code> | The configuration object for the intelligence engine (e.g., { agentId: "your-agent-id" }) |
+
+**Example**  
+```js
+const request = {
+ ref: "00000000-0000-0000-0000-000000000000",
+ name: "My application",
+ appEndpoint: "myapp.mydomain.com"
+}
+
+const apps = new SDK.Applications(client); // Existing client object
+
+apps.updateApplication(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Applications+listApplications"></a>
+
+### applications.listApplications(request) ⇒ <code>Promise.&lt;ListApplicationsResponse&gt;</code>
+Retrieves a list of Applications from Fonoster.
+
+**Kind**: instance method of [<code>Applications</code>](#Applications)  
+**Returns**: <code>Promise.&lt;ListApplicationsResponse&gt;</code> - - The response object that contains the list of Applications  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>ListApplicationsRequest</code> | The request object that contains the necessary information to retrieve a list of Applications |
+| request.pageSize | <code>number</code> | The number of Applications to retrieve |
+| request.pageToken | <code>string</code> | The token to retrieve the next page of Applications |
+
+**Example**  
+```js
+const request = {
+ pageSize: 10,
+ pageToken: "00000000-0000-0000-0000-000000000000"
+};
+
+const apps = new SDK.Applications(client); // Existing client object
+
+apps.listApplications(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Applications+deleteApplication"></a>
+
+### applications.deleteApplication(ref) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Deletes an existing Application from Fonoster.
+Note that this operation is irreversible.
+
+**Kind**: instance method of [<code>Applications</code>](#Applications)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the deleted application  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ref | <code>string</code> | The reference of the Application to delete |
+
+**Example**  
+```js
+const ref =  "00000000-0000-0000-0000-000000000000"
+
+const apps = new SDK.Applications(client); // Existing client object
+
+apps.deleteApplication(ref)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+
+<a name="Calls"></a>
+
+## Calls
+Fonoster Calls, part of the Fonoster Media subsystem,
+allows you to create, list, and track calls in your deployment.
+Note that an active Fonoster deployment is required.
+
+**Kind**: global class  
+**See**
+
+- AbstractClient
+- FonosterClient
+
+
+* [Calls](#Calls)
+    * [new Calls(client)](#new_Calls_new)
+    * [.createCall(request)](#Calls+createCall) ⇒ <code>Promise.&lt;CreateCallResponse&gt;</code>
+    * [.getCall(ref)](#Calls+getCall) ⇒ <code>Promise.&lt;Acl&gt;</code>
+    * [.listCalls(request)](#Calls+listCalls) ⇒ <code>Promise.&lt;ListCallsResponse&gt;</code>
+
+<a name="new_Calls_new"></a>
+
+### new Calls(client)
+Constructs a new Calls object.
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| client | <code>FonosterClient</code> | Client object with underlying implementations to make requests to Fonoster's API |
+
+**Example**  
+```js
+const SDK = require("@fonoster/sdk");
+
+async function main(request) {
+ const username = "admin";
+ const password = "yourpassword";
+ const accessKeyId = "00000000-0000-0000-0000-000000000000";
+
+ try {
+    const client = SDK.Client({ accessKeyId });
+    await client.login({ username, password });
+
+    const calls = new SDK.Calls(client);
+    const response = await apiKeys.createCall(request);
+
+    console.log(response); // successful response
+  } catch (e) {
+    console.error(e); // an error occurred
+  }
+}
+
+const request = {
+  from: "8287854037",
+  to: "+17853178070",
+  appRef: "00000000-0000-0000-0000-000000000000"
+};
+
+main(request).catch(console.error);
+```
+<a name="Calls+createCall"></a>
+
+### calls.createCall(request) ⇒ <code>Promise.&lt;CreateCallResponse&gt;</code>
+Creates a new Call in the Workspace.
+
+**Kind**: instance method of [<code>Calls</code>](#Calls)  
+**Returns**: <code>Promise.&lt;CreateCallResponse&gt;</code> - - The response object that contains the reference to the created Call  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>CreateCallRequest</code> | The request object that contains the necessary information to create a new Call |
+| request.from | <code>string</code> | The number that originated the call |
+| request.to | <code>string</code> | The number that received the call |
+| request.appRef | <code>string</code> | The reference of the App that will handle the call |
+
+**Example**  
+```js
+const request = {
+ from: "8287854037",
+ to: "+17853178070",
+ appRef: "00000000-0000-0000-0000-000000000000"
+};
+
+const calls = new SDK.Calls(client); // Existing client object
+
+calls.createCall(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Calls+getCall"></a>
+
+### calls.getCall(ref) ⇒ <code>Promise.&lt;Acl&gt;</code>
+Retrieves an existing Call in the Workspace.
+
+**Kind**: instance method of [<code>Calls</code>](#Calls)  
+**Returns**: <code>Promise.&lt;Acl&gt;</code> - - The response object that contains the Call detail  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ref | <code>string</code> | The reference of the Call to retrieve |
+
+**Example**  
+```js
+const ref = "00000000-0000-0000-0000-000000000000"
+
+const calls = new SDK.Calls(client); // Existing client object
+
+calls.getCall(ref)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Calls+listCalls"></a>
+
+### calls.listCalls(request) ⇒ <code>Promise.&lt;ListCallsResponse&gt;</code>
+Retrieves a list of Calls from a Workspace.
+
+**Kind**: instance method of [<code>Calls</code>](#Calls)  
+**Returns**: <code>Promise.&lt;ListCallsResponse&gt;</code> - - The response object that contains the list of Calls  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>ListCallsRequest</code> | The request object that contains the necessary information to retrieve a list of Calls |
+| request.pageSize | <code>number</code> | The number of Calls to retrieve |
+| request.pageToken | <code>string</code> | The token to retrieve the next page of Calls |
+
+**Example**  
+```js
+const request = {
+ pageSize: 10,
+ pageToken: "00000000-0000-0000-0000-000000000000"
+};
+
+const calls = new SDK.Calls(client); // Existing client object
+
+calls.listCalls(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+
+<a name="Credentials"></a>
+
+## Credentials
+Fonoster Credentials, part of the Fonoster SIP Proxy subsystem,
+allows you to create, update, retrieve, and delete SIP Credentials for your deployment.
+Note that an active Fonoster deployment is required.
+
+**Kind**: global class  
+**See**
+
+- AbstractClient
+- FonosterClient
+
+
+* [Credentials](#Credentials)
+    * [new Credentials(client)](#new_Credentials_new)
+    * [.createCredentials(request)](#Credentials+createCredentials) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+    * [.getCredentials(ref)](#Credentials+getCredentials) ⇒ <code>Promise.&lt;Acl&gt;</code>
+    * [.updateCredentials(request)](#Credentials+updateCredentials) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+    * [.listCredentials(request)](#Credentials+listCredentials) ⇒ <code>Promise.&lt;ListCredentialsResponse&gt;</code>
+    * [.deleteCredentials(ref)](#Credentials+deleteCredentials) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+
+<a name="new_Credentials_new"></a>
+
+### new Credentials(client)
+Constructs a new Credentials object.
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| client | <code>FonosterClient</code> | Client object with underlying implementations to make requests to Fonoster's API |
+
+**Example**  
+```js
+const SDK = require("@fonoster/sdk");
+
+async function main(request) {
+ const apiKey = "your-api-key";
+ const accessKeyId = "00000000-0000-0000-0000-000000000000";
+
+ try {
+    const client = SDK.Client({ accessKeyId });
+    await client.loginWithApiKey(apiKey);
+
+    const credentials = new SDK.Credentials(client);
+    const response = await apiKeys.createCredentials(request);
+
+    console.log(response); // successful response
+  } catch (e) {
+    console.error(e); // an error occurred
+  }
+}
+
+const request = {
+  name: "My Credentials",
+  username: "myusername",
+  password: "mysecret"
+};
+
+main(request).catch(console.error);
+```
+<a name="Credentials+createCredentials"></a>
+
+### credentials.createCredentials(request) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Creates a new set of Credentials in the Workspace.
+
+**Kind**: instance method of [<code>Credentials</code>](#Credentials)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the created Credentials  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>CreateCredentialsRequest</code> | The request object that contains the necessary information to create a new set of Credentials |
+| request.name | <code>string</code> | The name of the Credentials |
+| request.username | <code>string</code> | The username of the Credentials |
+| request.password | <code>string</code> | The password of the Credentials |
+
+**Example**  
+```js
+const request = {
+ name: "My Credentials",
+ username: "myusername",
+ password: "mysecret"
+};
+
+const credentials = new SDK.Credentials(client); // Existing client object
+
+credentials.createCredentials(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Credentials+getCredentials"></a>
+
+### credentials.getCredentials(ref) ⇒ <code>Promise.&lt;Acl&gt;</code>
+Retrieves an existing set of Credentials in the Workspace.
+
+**Kind**: instance method of [<code>Credentials</code>](#Credentials)  
+**Returns**: <code>Promise.&lt;Acl&gt;</code> - - The response object that contains the Credentials  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ref | <code>string</code> | The reference of the Credentials to retrieve |
+
+**Example**  
+```js
+const ref = "00000000-0000-0000-0000-000000000000"
+
+const credentials = new SDK.Credentials(client); // Existing client object
+
+credentials.getCredentials(ref)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Credentials+updateCredentials"></a>
+
+### credentials.updateCredentials(request) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Updates an existing set of Credentials in the Workspace.
+
+**Kind**: instance method of [<code>Credentials</code>](#Credentials)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the updated Credentials  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>UpdateCredentialsRequest</code> | The request object that contains the necessary information to update an existing set of Credentials |
+| request.ref | <code>string</code> | The reference of the Credentials to update |
+| request.name | <code>string</code> | The name of the Credentials |
+| request.password | <code>string</code> | The password of the Credentials |
+
+**Example**  
+```js
+const request = {
+ ref: "00000000-0000-0000-0000-000000000000",
+ name: "My Credentials",
+ password: "mysecret"
+};
+
+const credentials = new SDK.Credentials(client); // Existing client object
+
+credentials.updateCredentials(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Credentials+listCredentials"></a>
+
+### credentials.listCredentials(request) ⇒ <code>Promise.&lt;ListCredentialsResponse&gt;</code>
+Retrieves a list of Credentials from a Workspace.
+
+**Kind**: instance method of [<code>Credentials</code>](#Credentials)  
+**Returns**: <code>Promise.&lt;ListCredentialsResponse&gt;</code> - - The response object that contains the list of Credentials  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>ListCredentialsRequest</code> | The request object that contains the necessary information to retrieve a list of Credentials |
+| request.pageSize | <code>number</code> | The number of Credentials to retrieve |
+| request.pageToken | <code>string</code> | The token to retrieve the next page of Credentials |
+
+**Example**  
+```js
+const request = {
+ pageSize: 10,
+ pageToken: "00000000-0000-0000-0000-000000000000"
+};
+
+const credentials = new SDK.Credentials(client); // Existing client object
+
+credentials.listCredentials(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Credentials+deleteCredentials"></a>
+
+### credentials.deleteCredentials(ref) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Deletes an existing set of Credentials from Fonoster.
+Note that this operation is irreversible.
+
+**Kind**: instance method of [<code>Credentials</code>](#Credentials)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the deleted Credentials  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ref | <code>string</code> | The reference of the Credentials to delete |
+
+**Example**  
+```js
+const ref =  "00000000-0000-0000-0000-000000000000"
+
+const credentials = new SDK.Credentials(client); // Existing client object
+
+credentials.deleteCredentials(ref)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+
+<a name="Domains"></a>
+
+## Domains
+Fonoster Domains, part of the Fonoster SIP Proxy subsystem,
+allows you to create, update, retrieve, and delete SIP Domain for your deployment.
+Note that an active Fonoster deployment is required.
+
+**Kind**: global class  
+**See**
+
+- AbstractClient
+- FonosterClient
+
+
+* [Domains](#Domains)
+    * [new Domains(client)](#new_Domains_new)
+    * [.createDomain(request)](#Domains+createDomain) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+    * [.getDomain(ref)](#Domains+getDomain) ⇒ <code>Promise.&lt;Acl&gt;</code>
+    * [.updateDomain(request)](#Domains+updateDomain) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+    * [.listDomains(request)](#Domains+listDomains) ⇒ <code>Promise.&lt;ListDomainsResponse&gt;</code>
+    * [.deleteDomain(ref)](#Domains+deleteDomain) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+
+<a name="new_Domains_new"></a>
+
+### new Domains(client)
+Constructs a new Domains object.
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| client | <code>FonosterClient</code> | Client object with underlying implementations to make requests to Fonoster's API |
+
+**Example**  
+```js
+const SDK = require("@fonoster/sdk");
+
+async function main(request) {
+ const apiKey = "your-api-key";
+ const accessKeyId = "00000000-0000-0000-0000-000000000000";
+
+ try {
+    const client = SDK.Client({ accessKeyId });
+    await client.loginWithApiKey(apiKey);
+
+    const domains = new SDK.Domains(client);
+    const response = await domains.createDomain(request);
+
+    console.log(response); // successful response
+  } catch (e) {
+    console.error(e); // an error occurred
+  }
+}
+
+const request = {
+  name: "My Domain",
+  domainUri: "sip.project.fonoster.io"
+};
+
+main(request).catch(console.error);
+```
+<a name="Domains+createDomain"></a>
+
+### domains.createDomain(request) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Creates a new Domain in the Workspace.
+
+**Kind**: instance method of [<code>Domains</code>](#Domains)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the created Domain  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>CreateDomainRequest</code> | The request object that contains the necessary information to create a new Domain |
+| request.name | <code>string</code> | The name of the Domain |
+| request.domainUri | <code>string</code> | The URI of the Domain |
+| request.accessControlListRef | <code>AccessControlListRef</code> | The reference to the Access Control List (ACL) to associate with the Domain |
+| request.egressPolicy | <code>Array.&lt;EgressPolicy&gt;</code> | The egress policy of the Domain |
+| request.egressPolicy[].rule | <code>string</code> | A regular expression that defines which calls to send to the PSTN |
+| request.egressPolicy[].numberRef | <code>string</code> | The Number that will be used to send the call to the PSTN |
+
+**Example**  
+```js
+const request = {
+ name: "My Domain",
+ domainUri: "sip.project.fonoster.io"
+};
+
+const domains = new SDK.Domains(client); // Existing client object
+
+domains.createDomain(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Domains+getDomain"></a>
+
+### domains.getDomain(ref) ⇒ <code>Promise.&lt;Acl&gt;</code>
+Retrieves an existing Domain in the Workspace.
+
+**Kind**: instance method of [<code>Domains</code>](#Domains)  
+**Returns**: <code>Promise.&lt;Acl&gt;</code> - - The response object that contains the Domain  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ref | <code>string</code> | The reference of the Domain to retrieve |
+
+**Example**  
+```js
+const ref = "00000000-0000-0000-0000-000000000000"
+
+const domains = new SDK.Domains(client); // Existing client object
+
+domains.getDomain(ref)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Domains+updateDomain"></a>
+
+### domains.updateDomain(request) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Updates an existing Domain in the Workspace.
+
+**Kind**: instance method of [<code>Domains</code>](#Domains)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the updated Domain  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>UpdateDomainRequest</code> | The request object that contains the necessary information to update an existing Domain |
+| request.ref | <code>string</code> | The reference of the Domain to update |
+| request.name | <code>string</code> | The name of the Domain |
+| request.domainUri | <code>string</code> | The URI of the Domain |
+| request.accessControlListRef | <code>AccessControlListRef</code> | The reference to the Access Control List (ACL) to associate with the Domain |
+| request.egressPolicy | <code>Array.&lt;EgressPolicy&gt;</code> | The egress policy of the Domain |
+| request.egressPolicy[].rule | <code>string</code> | A regular expression that defines which calls to send to the PSTN |
+| request.egressPolicy[].numberRef | <code>string</code> | The Number that will be used to send the call to the PSTN |
+
+**Example**  
+```js
+const request = {
+ ref: "00000000-0000-0000-0000-000000000000",
+ accessControlListRef: "00000000-0000-0000-0000-000000000001"
+};
+
+const domains = new SDK.Domains(client); // Existing client object
+
+domains.updateDomain(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Domains+listDomains"></a>
+
+### domains.listDomains(request) ⇒ <code>Promise.&lt;ListDomainsResponse&gt;</code>
+Retrieves a list of Domains from a Workspace.
+
+**Kind**: instance method of [<code>Domains</code>](#Domains)  
+**Returns**: <code>Promise.&lt;ListDomainsResponse&gt;</code> - - The response object that contains the list of Domains  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>ListDomainsRequest</code> | The request object that contains the necessary information to retrieve a list of Domains |
+| request.pageSize | <code>number</code> | The number of Domains to retrieve |
+| request.pageToken | <code>string</code> | The token to retrieve the next page of Domains |
+
+**Example**  
+```js
+const request = {
+ pageSize: 10,
+ pageToken: "00000000-0000-0000-0000-000000000000"
+};
+
+const domains = new SDK.Domains(client); // Existing client object
+
+domains.listDomains(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Domains+deleteDomain"></a>
+
+### domains.deleteDomain(ref) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Deletes an existing Domain from Fonoster.
+Note that this operation is irreversible.
+
+**Kind**: instance method of [<code>Domains</code>](#Domains)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the deleted Domain  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ref | <code>string</code> | The reference of the Domain to delete |
+
+**Example**  
+```js
+const ref =  "00000000-0000-0000-0000-000000000000"
+
+const domains = new SDK.Domains(client); // Existing client object
+
+domains.deleteDomain(ref)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+
+<a name="Numbers"></a>
+
+## Numbers
+Fonoster Numbers, part of the Fonoster SIP Proxy subsystem,
+allows you to create, update, retrieve, and delete SIP Number for your deployment.
+Note that an active Fonoster deployment is required.
+
+**Kind**: global class  
+**See**
+
+- AbstractClient
+- FonosterClient
+
+
+* [Numbers](#Numbers)
+    * [new Numbers(client)](#new_Numbers_new)
+    * [.createNumber(request)](#Numbers+createNumber) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+    * [.getNumber(ref)](#Numbers+getNumber) ⇒ <code>Promise.&lt;Acl&gt;</code>
+    * [.updateNumber(request)](#Numbers+updateNumber) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+    * [.listNumbers(request)](#Numbers+listNumbers) ⇒ <code>Promise.&lt;ListNumbersResponse&gt;</code>
+    * [.deleteNumber(ref)](#Numbers+deleteNumber) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+
+<a name="new_Numbers_new"></a>
+
+### new Numbers(client)
+Constructs a new Numbers object.
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| client | <code>FonosterClient</code> | Client object with underlying implementations to make requests to Fonoster's API |
+
+**Example**  
+```js
+const SDK = require("@fonoster/sdk");
+
+async function main(request) {
+ const apiKey = "your-api-key";
+ const accessKeyId = "00000000-0000-0000-0000-000000000000";
+
+ try {
+    const client = SDK.Client({ accessKeyId });
+    await client.loginWithApiKey(apiKey);
+
+    const numbers = new SDK.Numbers(client);
+    const response = await numbers.createNumber(request);
+
+    console.log(response); // successful response
+  } catch (e) {
+    console.error(e); // an error occurred
+  }
+}
+
+const request = {
+  name: "My Number",
+  telUrl: "tel:+17853178070",
+  city: "Asheville",
+  country: "United States",
+  countryIsoCode: "US"
+};
+
+main(request).catch(console.error);
+```
+<a name="Numbers+createNumber"></a>
+
+### numbers.createNumber(request) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Creates a new Number in the Workspace.
+
+**Kind**: instance method of [<code>Numbers</code>](#Numbers)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the created Number  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>CreateNumberRequest</code> | The request object that contains the necessary information to create a new Number |
+| request.name | <code>string</code> | The name of the Number |
+| request.telUrl | <code>string</code> | The telUrl of the Number |
+| request.city | <code>string</code> | The city of the Number |
+| request.country | <code>string</code> | The country of the Number |
+| request.countryIsoCode | <code>string</code> | The countryIsoCode of the Number |
+
+**Example**  
+```js
+const request = {
+ name: "My Number",
+ telUrl: "tel:+17853178070",
+ city: "Asheville",
+ country: "United States",
+ countryIsoCode: "US"
+};
+
+const numbers = new SDK.Numbers(client); // Existing client object
+
+numbers.createNumber(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Numbers+getNumber"></a>
+
+### numbers.getNumber(ref) ⇒ <code>Promise.&lt;Acl&gt;</code>
+Retrieves an existing Number in the Workspace.
+
+**Kind**: instance method of [<code>Numbers</code>](#Numbers)  
+**Returns**: <code>Promise.&lt;Acl&gt;</code> - - The response object that contains the Number  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ref | <code>string</code> | The reference of the Number to retrieve |
+
+**Example**  
+```js
+const ref = "00000000-0000-0000-0000-000000000000"
+
+const numbers = new SDK.Numbers(client); // Existing client object
+
+numbers.getNumber(ref)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Numbers+updateNumber"></a>
+
+### numbers.updateNumber(request) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Updates an existing Number in the Workspace.
+
+**Kind**: instance method of [<code>Numbers</code>](#Numbers)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the updated Number  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>UpdateNumberRequest</code> | The request object that contains the necessary information to update an existing Number |
+| request.ref | <code>string</code> | The reference of the Number to update |
+| request.name | <code>string</code> | The name of the Number |
+
+**Example**  
+```js
+const request = {
+ ref: "00000000-0000-0000-0000-000000000000",
+ name: "My Number"
+};
+
+const numbers = new SDK.Numbers(client); // Existing client object
+
+numbers.updateNumber(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Numbers+listNumbers"></a>
+
+### numbers.listNumbers(request) ⇒ <code>Promise.&lt;ListNumbersResponse&gt;</code>
+Retrieves a list of Numbers from a Workspace.
+
+**Kind**: instance method of [<code>Numbers</code>](#Numbers)  
+**Returns**: <code>Promise.&lt;ListNumbersResponse&gt;</code> - - The response object that contains the list of Numbers  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>ListNumbersRequest</code> | The request object that contains the necessary information to retrieve a list of Numbers |
+| request.pageSize | <code>number</code> | The number of Numbers to retrieve |
+| request.pageToken | <code>string</code> | The token to retrieve the next page of Numbers |
+
+**Example**  
+```js
+const request = {
+ pageSize: 10,
+ pageToken: "00000000-0000-0000-0000-000000000000"
+};
+
+const numbers = new SDK.Numbers(client); // Existing client object
+
+numbers.listNumbers(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Numbers+deleteNumber"></a>
+
+### numbers.deleteNumber(ref) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Deletes an existing Number from Fonoster.
+Note that this operation is irreversible.
+
+**Kind**: instance method of [<code>Numbers</code>](#Numbers)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the deleted Number  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ref | <code>string</code> | The reference of the Number to delete |
+
+**Example**  
+```js
+const ref =  "00000000-0000-0000-0000-000000000000"
+
+const numbers = new SDK.Numbers(client); // Existing client object
+
+numbers.deleteDomain(ref)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+
+<a name="Secrets"></a>
+
+## Secrets
+Fonoster Secrets, part of the Fonoster Core,
+allows you to create, update, retrieve, and delete Secrets for your deployment.
+Note that an active Fonoster deployment is required.
+
+**Kind**: global class  
+**See**
+
+- AbstractClient
+- FonosterClient
+
+
+* [Secrets](#Secrets)
+    * [new Secrets(client)](#new_Secrets_new)
+    * [.createSecret(request)](#Secrets+createSecret) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+    * [.getSecret(ref)](#Secrets+getSecret) ⇒ <code>Promise.&lt;Acl&gt;</code>
+    * [.updateSecret(request)](#Secrets+updateSecret) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+    * [.listSecrets(request)](#Secrets+listSecrets) ⇒ <code>Promise.&lt;ListSecretsResponse&gt;</code>
+    * [.deleteSecret(ref)](#Secrets+deleteSecret) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+
+<a name="new_Secrets_new"></a>
+
+### new Secrets(client)
+Constructs a new Secrets object.
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| client | <code>FonosterClient</code> | Client object with underlying implementations to make requests to Fonoster's API |
+
+**Example**  
+```js
+const SDK = require("@fonoster/sdk");
+
+async function main(request) {
+ const apiKey = "your-api-key";
+ const accessKeyId = "00000000-0000-0000-0000-000000000000";
+
+ try {
+    const client = SDK.Client({ accessKeyId });
+    await client.loginWithApiKey(apiKey);
+
+    const secrets = new SDK.Secrets(client);
+    const response = await secrets.creteSecret(request);
+
+    console.log(response); // successful response
+  } catch (e) {
+    console.error(e); // an error occurred
+  }
+}
+
+const request = {
+  name: "FRIENDLY_NAME",
+  secret: "mysecret"
+};
+
+main(request).catch(console.error);
+```
+<a name="Secrets+createSecret"></a>
+
+### secrets.createSecret(request) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Creates a new Secret in the Workspace.
+
+**Kind**: instance method of [<code>Secrets</code>](#Secrets)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the created Secret  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>CreateSecretRequest</code> | The request object that contains the necessary information to create a new Secret |
+| request.name | <code>string</code> | The name of the Secret |
+| request.secret | <code>string</code> | The secret of the Secret |
+
+**Example**  
+```js
+const request = {
+ name: "FRIENDLY_NAME",
+ secret: "mysecret"
+};
+
+const secrets = new SDK.Secrets(client); // Existing client object
+
+secrets.createSecret(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Secrets+getSecret"></a>
+
+### secrets.getSecret(ref) ⇒ <code>Promise.&lt;Acl&gt;</code>
+Retrieves an existing Secret in the Workspace.
+
+**Kind**: instance method of [<code>Secrets</code>](#Secrets)  
+**Returns**: <code>Promise.&lt;Acl&gt;</code> - - The response object that contains the Secret  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ref | <code>string</code> | The reference of the Secret to retrieve |
+
+**Example**  
+```js
+const ref = "00000000-0000-0000-0000-000000000000"
+
+const secrets = new SDK.Secrets(client); // Existing client object
+
+secrets.getSecret(ref)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Secrets+updateSecret"></a>
+
+### secrets.updateSecret(request) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Updates an existing Secret in the Workspace.
+
+**Kind**: instance method of [<code>Secrets</code>](#Secrets)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the updated Secret  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>UpdateSecretRequest</code> | The request object that contains the necessary information to update an existing Secret |
+| request.ref | <code>string</code> | The reference of the Secret to update |
+| request.name | <code>string</code> | The name of the Secret |
+| request.secret | <code>string</code> | The secret of the Secret |
+
+**Example**  
+```js
+const request = {
+ ref: "00000000-0000-0000-0000-000000000000",
+ secret: "mysecret"
+};
+
+const secrets = new SDK.Secrets(client); // Existing client object
+
+secrets.updateSecret(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Secrets+listSecrets"></a>
+
+### secrets.listSecrets(request) ⇒ <code>Promise.&lt;ListSecretsResponse&gt;</code>
+Retrieves a list of Secrets from a Workspace.
+
+**Kind**: instance method of [<code>Secrets</code>](#Secrets)  
+**Returns**: <code>Promise.&lt;ListSecretsResponse&gt;</code> - - The response object that contains the list of Secrets  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>ListSecretsRequest</code> | The request object that contains the necessary information to retrieve a list of Secrets |
+| request.pageSize | <code>number</code> | The secret of Secrets to retrieve |
+| request.pageToken | <code>string</code> | The token to retrieve the next page of Secrets |
+
+**Example**  
+```js
+const request = {
+ pageSize: 10,
+ pageToken: "00000000-0000-0000-0000-000000000000"
+};
+
+const secrets = new SDK.Secrets(client); // Existing client object
+
+secrets.listSecrets(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Secrets+deleteSecret"></a>
+
+### secrets.deleteSecret(ref) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Deletes an existing Secret from Fonoster.
+Note that this operation is irreversible.
+
+**Kind**: instance method of [<code>Secrets</code>](#Secrets)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the deleted Secret  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ref | <code>string</code> | The reference of the Secret to delete |
+
+**Example**  
+```js
+const ref =  "00000000-0000-0000-0000-000000000000"
+
+const secrets = new SDK.Secrets(client); // Existing client object
+
+secrets.deleteSecret(ref)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+
+<a name="Trunks"></a>
+
+## Trunks
+Fonoster Trunks, part of the Fonoster SIP Proxy subsystem,
+allows you to create, update, retrieve, and delete SIP Trunks for your deployment.
+Note that an active Fonoster deployment is required.
+
+**Kind**: global class  
+**See**
+
+- AbstractClient
+- FonosterClient
+
+
+* [Trunks](#Trunks)
+    * [new Trunks(client)](#new_Trunks_new)
+    * [.createTrunk(request)](#Trunks+createTrunk) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+    * [.getTrunk(ref)](#Trunks+getTrunk) ⇒ <code>Promise.&lt;Acl&gt;</code>
+    * [.updateTrunk(request)](#Trunks+updateTrunk) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+    * [.listTrunks(request)](#Trunks+listTrunks) ⇒ <code>Promise.&lt;ListTrunksResponse&gt;</code>
+    * [.deleteTrunk(ref)](#Trunks+deleteTrunk) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+
+<a name="new_Trunks_new"></a>
+
+### new Trunks(client)
+Constructs a new Trunks object.
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| client | <code>FonosterClient</code> | Client object with underlying implementations to make requests to Fonoster's API |
+
+**Example**  
+```js
+const SDK = require("@fonoster/sdk");
+
+async function main(request) {
+ const apiKey = "your-api-key";
+ const accessKeyId = "00000000-0000-0000-0000-000000000000";
+
+ try {
+    const client = SDK.Client({ accessKeyId });
+    await client.loginWithApiKey(apiKey);
+
+    const trunks = new SDK.Trunks(client);
+    const response = await trunks.createTrunk(request);
+
+    console.log(response); // successful response
+  } catch (e) {
+    console.error(e); // an error occurred
+  }
+}
+
+const request = {
+  name: "My Trunk",
+  inboundUri: "sip.company.fonoster.io"
+};
+
+main(request).catch(console.error);
+```
+<a name="Trunks+createTrunk"></a>
+
+### trunks.createTrunk(request) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Creates a new Trunk in the Workspace.
+
+**Kind**: instance method of [<code>Trunks</code>](#Trunks)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the created Trunk  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>CreateTrunkRequest</code> | The request object that contains the necessary information to create a new Trunk |
+| request.name | <code>string</code> | The name of the Trunk |
+| request.inboundUri | <code>string</code> | The inboundUri of the Trunk |
+| request.sendRegister | <code>boolean</code> | The sendRegister of the Trunk |
+| request.accessControlListRef | <code>string</code> | The accessControlListRef of the Trunk |
+| request.inboundCredentialsRef | <code>string</code> | The inboundCredentialsRef of the Trunk |
+| request.outboundCredentialsRef | <code>string</code> | The outboundCredentialsRef of the Trunk |
+| request.uris | <code>Array.&lt;TrunkUri&gt;</code> | The uris of the Trunk |
+| request.uris[].host | <code>string</code> | The host of the Trunk |
+| request.uris[].port | <code>number</code> | The port of the Trunk |
+| request.uris[].transport | <code>Transport</code> | The transport of the Trunk |
+| request.uris[].user | <code>string</code> | Optional user of the Trunk |
+| request.uris[].weight | <code>number</code> | Optional weight of the Trunk |
+| request.uris[].priority | <code>number</code> | Optional priority of the Trunk |
+| request.uris[].enabled | <code>boolean</code> | Optional enabled of the Trunk |
+
+**Example**  
+```js
+const request = {
+ name: "My Trunk",
+ inboundUri: "sip.company.fonoster.io"
+ sendRegister: true
+ uris: [{
+   host: "sip.company.fonoster.io",
+   port: 5060,
+   transport: "UDP",
+   user: "user",
+   weight: 0,
+   priority: 0,
+   enabled: true
+ }]
+};
+
+const trunks = new SDK.Trunks(client); // Existing client object
+
+trunks.createTrunk(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Trunks+getTrunk"></a>
+
+### trunks.getTrunk(ref) ⇒ <code>Promise.&lt;Acl&gt;</code>
+Retrieves an existing Trunk in the Workspace.
+
+**Kind**: instance method of [<code>Trunks</code>](#Trunks)  
+**Returns**: <code>Promise.&lt;Acl&gt;</code> - - The response object that contains the Trunk  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ref | <code>string</code> | The reference of the Trunk to retrieve |
+
+**Example**  
+```js
+const ref = "00000000-0000-0000-0000-000000000000"
+
+const trunks = new SDK.Trunks(client); // Existing client object
+
+trunks.getTrunk(ref)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Trunks+updateTrunk"></a>
+
+### trunks.updateTrunk(request) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Updates an existing Trunk in the Workspace.
+
+**Kind**: instance method of [<code>Trunks</code>](#Trunks)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the updated Trunk  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>UpdateTrunkRequest</code> | The request object that contains the necessary information to update an existing Trunk |
+| request.ref | <code>string</code> | The reference of the Trunk to update |
+| request.name | <code>string</code> | The name of the Trunk |
+| request.sendRegister | <code>boolean</code> | The sendRegister of the Trunk |
+| request.accessControlListRef | <code>string</code> | The accessControlListRef of the Trunk |
+| request.inboundCredentialsRef | <code>string</code> | The inboundCredentialsRef of the Trunk |
+| request.outboundCredentialsRef | <code>string</code> | The outboundCredentialsRef of the Trunk |
+| request.uris | <code>Array.&lt;TrunkUri&gt;</code> | The uris of the Trunk |
+| request.uris[].host | <code>string</code> | The host of the Trunk |
+| request.uris[].port | <code>number</code> | The port of the Trunk |
+| request.uris[].transport | <code>Transport</code> | The transport of the Trunk |
+| request.uris[].user | <code>string</code> | Optional user of the Trunk |
+| request.uris[].weight | <code>number</code> | Optional weight of the Trunk |
+| request.uris[].priority | <code>number</code> | Optional priority of the Trunk |
+| request.uris[].enabled | <code>boolean</code> | Optional enabled of the Trunk |
+
+**Example**  
+```js
+const request = {
+ ref: "00000000-0000-0000-0000-000000000000",
+ name: "My Trunk",
+ sendRegister: true
+ uris: [{
+   host: "sip.company.fonoster.io",
+   port: 5060,
+   transport: "UDP",
+   user: "user",
+   weight: 0,
+   priority: 0,
+   enabled: true
+ }]
+};
+```
+<a name="Trunks+listTrunks"></a>
+
+### trunks.listTrunks(request) ⇒ <code>Promise.&lt;ListTrunksResponse&gt;</code>
+Retrieves a list of Trunks from a Workspace.
+
+**Kind**: instance method of [<code>Trunks</code>](#Trunks)  
+**Returns**: <code>Promise.&lt;ListTrunksResponse&gt;</code> - - The response object that contains the list of Trunks  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>ListTrunksRequest</code> | The request object that contains the necessary information to retrieve a list of Trunks |
+| request.pageSize | <code>number</code> | The trunk of Trunks to retrieve |
+| request.pageToken | <code>string</code> | The token to retrieve the next page of Trunks |
+
+**Example**  
+```js
+const request = {
+ pageSize: 10,
+ pageToken: "00000000-0000-0000-0000-000000000000"
+};
+
+const trunks = new SDK.Trunks(client); // Existing client object
+
+trunks.listTrunks(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Trunks+deleteTrunk"></a>
+
+### trunks.deleteTrunk(ref) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Deletes an existing Trunk from Fonoster.
+Note that this operation is irreversible.
+
+**Kind**: instance method of [<code>Trunks</code>](#Trunks)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the deleted Trunk  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ref | <code>string</code> | The reference of the Trunk to delete |
+
+**Example**  
+```js
+const ref =  "00000000-0000-0000-0000-000000000000"
+
+const trunks = new SDK.Trunks(client); // Existing client object
+
+trunks.deleteTrunk(ref)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+
+<a name="Users"></a>
+
+## Users
+Fonoster Users, part of the Fonoster Identity subsystem,
+allows you to create, update, retrieve, and delete a Users in the system.
+Note that an active Fonoster deployment is required.
+
+**Kind**: global class  
+**See**
+
+- AbstractClient
+- FonosterClient
+
+
+* [Users](#Users)
+    * [new Users(client)](#new_Users_new)
+    * [.createUser(request)](#Users+createUser) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+    * [.getUser(ref)](#Users+getUser) ⇒ <code>Promise.&lt;Acl&gt;</code>
+    * [.updateUser(request)](#Users+updateUser) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+    * [.deleteUser(ref)](#Users+deleteUser) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+
+<a name="new_Users_new"></a>
+
+### new Users(client)
+Constructs a new Users object.
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| client | <code>FonosterClient</code> | Client object with underlying implementations to make requests to Fonoster's API |
+
+**Example**  
+```js
+const SDK = require("@fonoster/sdk");
+
+async function main(request) {
+ const apiKey = "your-api-key";
+ const accessKeyId = "00000000-0000-0000-0000-000000000000";
+
+ try {
+    const client = SDK.Client({ accessKeyId });
+    await client.loginWithApiKey(apiKey);
+
+    const users = new SDK.Users(client);
+    const response = await users.createUser(request);
+
+    console.log(response); // successful response
+  } catch (e) {
+    console.error(e); // an error occurred
+  }
+}
+
+const request = {
+  name: "John Doe",
+  email: "john.doe@example.com",
+  password: "password",
+  avatar: "https://example.com/avatar.jpg"
+};
+
+main(request).catch(console.error);
+```
+<a name="Users+createUser"></a>
+
+### users.createUser(request) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Creates a new User in the Workspace.
+
+**Kind**: instance method of [<code>Users</code>](#Users)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the created User  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>CreateUserRequest</code> | The request object that contains the necessary information to create a new User |
+| request.name | <code>string</code> | The name of the User |
+| request.email | <code>string</code> | The email of the User |
+| request.password | <code>string</code> | The password of the User |
+| request.avatar | <code>string</code> | The avatar of the User |
+
+**Example**  
+```js
+const request = {
+ name: "John Doe",
+ email: "john.doe@example.com",
+ password: "password",
+ avatar: "https://example.com/avatar.jpg"
+};
+
+const users = new SDK.Users(client); // Existing client object
+
+users.createUser(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Users+getUser"></a>
+
+### users.getUser(ref) ⇒ <code>Promise.&lt;Acl&gt;</code>
+Retrieves an existing User in the Workspace.
+
+**Kind**: instance method of [<code>Users</code>](#Users)  
+**Returns**: <code>Promise.&lt;Acl&gt;</code> - - The response object that contains the User  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ref | <code>string</code> | The reference of the User to retrieve |
+
+**Example**  
+```js
+const ref = "00000000-0000-0000-0000-000000000000"
+
+const users = new SDK.Users(client); // Existing client object
+
+users.getUser(ref)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Users+updateUser"></a>
+
+### users.updateUser(request) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Updates an existing User in the Workspace.
+
+**Kind**: instance method of [<code>Users</code>](#Users)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the updated User  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>UpdateUserRequest</code> | The request object that contains the necessary information to update a User |
+| request.ref | <code>string</code> | The reference of the User to update |
+| request.name | <code>string</code> | The name of the User |
+| request.password | <code>string</code> | The password of the User |
+| request.avatar | <code>string</code> | The avatar of the User |
+
+**Example**  
+```js
+const request = {
+ ref: "00000000-0000-0000-0000-000000000000",
+ name: "John Doe",
+ password: "password",
+ avatar: "https://example.com/avatar.jpg"
+};
+
+const users = new SDK.Users(client); // Existing client object
+
+users.updateUser(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Users+deleteUser"></a>
+
+### users.deleteUser(ref) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Deletes an existing User from Fonoster.
+Note that this operation is irreversible.
+
+**Kind**: instance method of [<code>Users</code>](#Users)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the deleted User  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ref | <code>string</code> | The reference of the User to delete |
+
+**Example**  
+```js
+const ref =  "00000000-0000-0000-0000-000000000000"
+
+const users = new SDK.Users(client); // Existing client object
+
+users.deleteUser(ref)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+
+<a name="Workspaces"></a>
+
+## Workspaces
+Fonoster Workspaces, part of the Fonoster Identity subsystem,
+allows you to create, update, retrieve, and delete Workspaces in the system.
+Note that an active Fonoster deployment is required.
+
+**Kind**: global class  
+**See**
+
+- AbstractClient
+- FonosterClient
+
+
+* [Workspaces](#Workspaces)
+    * [new Workspaces(client)](#new_Workspaces_new)
+    * [.createWorkspace(request)](#Workspaces+createWorkspace) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+    * [.getWorkspace(ref)](#Workspaces+getWorkspace) ⇒ <code>Promise.&lt;Acl&gt;</code>
+    * [.updateWorkspace(request)](#Workspaces+updateWorkspace) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+    * [.deleteWorkspace(ref)](#Workspaces+deleteWorkspace) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+    * [.listWorkspaces(request)](#Workspaces+listWorkspaces) ⇒ <code>Promise.&lt;ListWorkspacesResponse&gt;</code>
+    * [.inviteUserToWorkspace(request)](#Workspaces+inviteUserToWorkspace) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+    * [.resendWorkspaceMembershipInvitation(userRef)](#Workspaces+resendWorkspaceMembershipInvitation) ⇒ <code>Promise.&lt;ResendWorkspaceMembershipInvitationResponse&gt;</code>
+    * [.removeUserFromWorkspace(userRef)](#Workspaces+removeUserFromWorkspace) ⇒ <code>Promise.&lt;RemoveUserFromWorkspaceResponse&gt;</code>
+
+<a name="new_Workspaces_new"></a>
+
+### new Workspaces(client)
+Constructs a new Workspaces object.
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| client | <code>FonosterClient</code> | Client object with underlying implementations to make requests to Fonoster's API |
+
+**Example**  
+```js
+const SDK = require("@fonoster/sdk");
+
+async function main(request) {
+ const apiKey = "your-api-key";
+ const accessKeyId = "00000000-0000-0000-0000-000000000000";
+
+ try {
+    const client = SDK.Client({ accessKeyId });
+    await client.loginWithApiKey(apiKey);
+
+    const workspaces = new SDK.Workspaces(client);
+    const response = await workspaces.createWorkspace(request);
+
+    console.log(response); // successful response
+  } catch (e) {
+    console.error(e); // an error occurred
+  }
+}
+
+const request = {
+  name: "My Workspace"
+};
+
+main(request).catch(console.error);
+```
+<a name="Workspaces+createWorkspace"></a>
+
+### workspaces.createWorkspace(request) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Creates a new Workspace in the system.
+
+**Kind**: instance method of [<code>Workspaces</code>](#Workspaces)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the created Workspace  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>CreateWorkspaceRequest</code> | The request object that contains the necessary information to create a new Workspace |
+| request.name | <code>string</code> | The name of the Workspace |
+
+**Example**  
+```js
+const request = {
+ name: "My Workspace"
+};
+
+const workspaces = new SDK.Workspaces(client); // Existing client object
+
+workspaces.createWorkspace(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Workspaces+getWorkspace"></a>
+
+### workspaces.getWorkspace(ref) ⇒ <code>Promise.&lt;Acl&gt;</code>
+Retrieves an existing Workspace in the system.
+
+**Kind**: instance method of [<code>Workspaces</code>](#Workspaces)  
+**Returns**: <code>Promise.&lt;Acl&gt;</code> - - The response object that contains the Workspace  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ref | <code>string</code> | The reference of the Workspace to retrieve |
+
+**Example**  
+```js
+const ref = "00000000-0000-0000-0000-000000000000"
+
+const workspaces = new SDK.Workspaces(client); // Existing client object
+
+workspaces.getWorkspace(ref)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Workspaces+updateWorkspace"></a>
+
+### workspaces.updateWorkspace(request) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Updates an existing Workspace in the system.
+
+**Kind**: instance method of [<code>Workspaces</code>](#Workspaces)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the updated Workspace  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>UpdateWorkspaceRequest</code> | The request object that contains the necessary information to update a Workspace |
+| request.ref | <code>string</code> | The reference of the Workspace to update |
+| request.name | <code>string</code> | The name of the Workspace |
+
+**Example**  
+```js
+const request = {
+ ref: "00000000-0000-0000-0000-000000000000",
+ name: "My Workspace"
+};
+
+const workspaces = new SDK.Workspaces(client); // Existing client object
+
+workspaces.updateWorkspace(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Workspaces+deleteWorkspace"></a>
+
+### workspaces.deleteWorkspace(ref) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Deletes an existing Workspace from Fonoster.
+Note that this operation is irreversible.
+
+**Kind**: instance method of [<code>Workspaces</code>](#Workspaces)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the deleted Workspace  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ref | <code>string</code> | The reference of the Workspace to delete |
+
+**Example**  
+```js
+const ref =  "00000000-0000-0000-0000-000000000000"
+
+const workspaces = new SDK.Workspaces(client); // Existing client object
+
+workspaces.deleteWorkspace(ref)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Workspaces+listWorkspaces"></a>
+
+### workspaces.listWorkspaces(request) ⇒ <code>Promise.&lt;ListWorkspacesResponse&gt;</code>
+Retrieves a list of Workspaces from a Workspace.
+
+**Kind**: instance method of [<code>Workspaces</code>](#Workspaces)  
+**Returns**: <code>Promise.&lt;ListWorkspacesResponse&gt;</code> - - The response object that contains the list of Workspaces  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>ListWorkspacesRequest</code> | The request object that contains the necessary information to retrieve a list of Workspaces |
+| request.pageSize | <code>number</code> | The workspace of Workspaces to retrieve |
+| request.pageToken | <code>string</code> | The token to retrieve the next page of Workspaces |
+
+**Example**  
+```js
+const request = {
+ pageSize: 10,
+ pageToken: "00000000-0000-0000-0000-000000000000"
+};
+
+const workspaces = new SDK.Workspaces(client); // Existing client object
+
+workspaces.listWorkspaces(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Workspaces+inviteUserToWorkspace"></a>
+
+### workspaces.inviteUserToWorkspace(request) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+Invites a User to a Workspace.
+
+**Kind**: instance method of [<code>Workspaces</code>](#Workspaces)  
+**Returns**: <code>Promise.&lt;BaseApiObject&gt;</code> - - The response object that contains the reference to the invitation  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>InviteUserToWorkspaceRequest</code> | The request object that contains the necessary information to invite a User to a Workspace |
+| request.workspaceRef | <code>string</code> | The reference of the Workspace to invite the User to |
+| request.email | <code>string</code> | The email of the User to invite |
+| request.password | <code>string</code> | Temporary password for the User. Leave empty to generate a random password |
+
+**Example**  
+```js
+const request = {
+ workspaceRef: "00000000-0000-0000-0000-000000000000",
+ email: "jane.doe@example.com",
+ role: "WORKSPACE_MEMBER",
+};
+
+const workspaces = new SDK.Workspaces(client); // Existing client object
+
+workspaces.inviteUserToWorkspace(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Workspaces+resendWorkspaceMembershipInvitation"></a>
+
+### workspaces.resendWorkspaceMembershipInvitation(userRef) ⇒ <code>Promise.&lt;ResendWorkspaceMembershipInvitationResponse&gt;</code>
+Resend a Workspace membership invitation.
+
+**Kind**: instance method of [<code>Workspaces</code>](#Workspaces)  
+**Returns**: <code>Promise.&lt;ResendWorkspaceMembershipInvitationResponse&gt;</code> - - The response object that contains the reference to the invitation  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| userRef | <code>string</code> | The reference to the user to resend the invitation |
+
+**Example**  
+```js
+const userRef: "00000000-0000-0000-0000-000000000000";
+
+const workspaces = new SDK.Workspaces(client); // Existing client object
+
+workspaces.resendWorkspaceMembershipInvitation(request)
+ .then(console.log) // successful response
+ .catch(console.error); // an error occurred
+```
+<a name="Workspaces+removeUserFromWorkspace"></a>
+
+### workspaces.removeUserFromWorkspace(userRef) ⇒ <code>Promise.&lt;RemoveUserFromWorkspaceResponse&gt;</code>
+Removes a User from a Workspace.
+
+**Kind**: instance method of [<code>Workspaces</code>](#Workspaces)  
+**Returns**: <code>Promise.&lt;RemoveUserFromWorkspaceResponse&gt;</code> - - The response object that contains the reference to the removed User  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| userRef | <code>string</code> | The reference of the User to remove from the Workspace |
+
+**Example**  
+```js
+const userRef = "00000000-0000-0000-0000-000000000000";
+
+const workspaces = new SDK.Workspaces(client); // Existing client object
 
-apps.deleteApplication(request)
+workspaces.removeUserFromWorkspace(userRef)
  .then(console.log) // successful response
  .catch(console.error); // an error occurred
 ```