@fonoster/sdk 0.6.2-alpha.0 → 0.6.3

package/dist/node/ApiKeys.d.ts

@@ -1,11 +1,120 @@
 import { BaseApiObject, CreateApiKeyRequest, CreateApiKeyResponse, ListApiKeysRequest, ListApiKeysResponse } from "@fonoster/types";
 import { FonosterClient } from "./client/types";
+/**
+ * @classdesc 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.
+ *
+ * @example
+ *
+ * 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);
+ */
 declare class ApiKeys {
     private client;
+    /**
+     * Constructs a new ApiKeys object.
+     *
+     * @param {FonosterClient} client - Client object with underlying implementations to make requests to Fonoster's API
+     * @see AbstractClient
+     * @see FonosterClient
+     */
     constructor(client: FonosterClient);
+    /**
+     * Creates a new ApiKey for a Workspace.
+     *
+     * @param {CreateApiKeyRequest} request - The request object that contains the necessary information to create a new ApiKey
+     * @param {ApiRoleEnum} request.role - The role of the ApiKey
+     * @return {Promise<CreateApiKeyResponse>} - The response object that contains the reference to the created ApiKey
+     * @example
+     *
+     * 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
+     */
     createApiKey(request: CreateApiKeyRequest): Promise<CreateApiKeyResponse>;
+    /**
+     * Regenerates an existing ApiKey for a Workspace.
+     * Note that this operation is irreversible.
+     *
+     * @param {string} ref - The reference of the ApiKey to regenerate
+     * @return {Promise<CreateApiKeyResponse>} - The response object that contains the reference to the regenerated ApiKey
+     * @example
+     *
+     * 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
+     */
     regenerateApiKey(ref: string): Promise<CreateApiKeyResponse>;
+    /**
+     * Retrieves a list of ApiKeys from a Workspace.
+     *
+     * @param {ListApiKeysRequest} request - The request object that contains the necessary information to retrieve a list of ApiKeys
+     * @param {number} request.pageSize - The number of ApiKeys to retrieve
+     * @param {string} request.pageToken - The token to retrieve the next page of ApiKeys
+     * @return {Promise<ListApiKeysResponse>} - The response object that contains the list of ApiKeys
+     * @example
+     *
+     * 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
+     */
     listApiKeys(request: ListApiKeysRequest): Promise<ListApiKeysResponse>;
+    /**
+     * Deletes an existing ApiKey from Fonoster.
+     * Note that this operation is irreversible.
+     *
+     * @param {string} ref - The reference of the ApiKey to delete
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted ApiKey
+     * @example
+     *
+     * 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
+     */
     deleteApiKey(ref: string): Promise<BaseApiObject>;
 }
 export { ApiKeys };

package/dist/node/ApiKeys.js

@@ -22,11 +22,68 @@ exports.ApiKeys = void 0;
 const types_1 = require("@fonoster/types");
 const makeRpcRequest_1 = require("./client/makeRpcRequest");
 const identity_pb_1 = require("./generated/node/identity_pb");
+/**
+ * @classdesc 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.
+ *
+ * @example
+ *
+ * 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);
+ */
 class ApiKeys {
     client;
+    /**
+     * Constructs a new ApiKeys object.
+     *
+     * @param {FonosterClient} client - Client object with underlying implementations to make requests to Fonoster's API
+     * @see AbstractClient
+     * @see FonosterClient
+     */
     constructor(client) {
         this.client = client;
     }
+    /**
+     * Creates a new ApiKey for a Workspace.
+     *
+     * @param {CreateApiKeyRequest} request - The request object that contains the necessary information to create a new ApiKey
+     * @param {ApiRoleEnum} request.role - The role of the ApiKey
+     * @return {Promise<CreateApiKeyResponse>} - The response object that contains the reference to the created ApiKey
+     * @example
+     *
+     * 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
+     */
     async createApiKey(request) {
         const client = this.client.getIdentityClient();
         return await (0, makeRpcRequest_1.makeRpcRequest)({
@@ -37,6 +94,22 @@ class ApiKeys {
             enumMapping: [["role", types_1.ApiRoleEnum]]
         });
     }
+    /**
+     * Regenerates an existing ApiKey for a Workspace.
+     * Note that this operation is irreversible.
+     *
+     * @param {string} ref - The reference of the ApiKey to regenerate
+     * @return {Promise<CreateApiKeyResponse>} - The response object that contains the reference to the regenerated ApiKey
+     * @example
+     *
+     * 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
+     */
     async regenerateApiKey(ref) {
         const client = this.client.getIdentityClient();
         return await (0, makeRpcRequest_1.makeRpcRequest)({
@@ -46,6 +119,26 @@ class ApiKeys {
             request: { ref }
         });
     }
+    /**
+     * Retrieves a list of ApiKeys from a Workspace.
+     *
+     * @param {ListApiKeysRequest} request - The request object that contains the necessary information to retrieve a list of ApiKeys
+     * @param {number} request.pageSize - The number of ApiKeys to retrieve
+     * @param {string} request.pageToken - The token to retrieve the next page of ApiKeys
+     * @return {Promise<ListApiKeysResponse>} - The response object that contains the list of ApiKeys
+     * @example
+     *
+     * 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
+     */
     async listApiKeys(request) {
         const applicationsClient = this.client.getIdentityClient();
         return await (0, makeRpcRequest_1.makeRpcRequest)({
@@ -56,6 +149,22 @@ class ApiKeys {
             repeatableObjectMapping: [["itemsList", identity_pb_1.ApiKey]]
         });
     }
+    /**
+     * Deletes an existing ApiKey from Fonoster.
+     * Note that this operation is irreversible.
+     *
+     * @param {string} ref - The reference of the ApiKey to delete
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted ApiKey
+     * @example
+     *
+     * 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
+     */
     async deleteApiKey(ref) {
         const client = this.client.getIdentityClient();
         return await (0, makeRpcRequest_1.makeRpcRequest)({

package/dist/node/Applications.d.ts

@@ -9,6 +9,23 @@ import { FonosterClient } from "./client/types";
  *
  * 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",
@@ -36,18 +53,7 @@ import { FonosterClient } from "./client/types";
  *   }
  * };
  *
- * const username = "admin@fonoster.local";
- * const password = "changeme";
- * const accessKeyId = "WO00000000000000000000000000000000";
- *
- * const client = new SDK.Client({ accessKeyId });
- *
- * 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
+ * main(request).catch(console.error);
  */
 declare class Applications {
     private client;
@@ -114,19 +120,17 @@ declare class Applications {
      */
     createApplication(request: CreateApplicationRequest): Promise<CreateApplicationResponse>;
     /**
-     * Retrieves an existing application from Fonoster.
+     * Retrieves an existing Application in the Workspace.
      *
-     * @param {string} ref - The reference of the application to retrieve
-     * @return {Promise<Application>} - The response object that contains the application information
+     * @param {string} ref - The reference of the Application to retrieve
+     * @return {Promise<Application>} - The response object that contains the Application information
      * @example
      *
-     * const request = {
-     *  ref: "00000000-0000-0000-0000-000000000000"
-     * };
+     * const ref = "00000000-0000-0000-0000-000000000000"
      *
      * const apps = new SDK.Applications(client); // Existing client object
      *
-     * apps.getApplication(request)
+     * apps.getApplication(ref)
      *  .then(console.log) // successful response
      *  .catch(console.error); // an error occurred
      */
@@ -165,12 +169,12 @@ declare class Applications {
      */
     updateApplication(request: UpdateApplicationRequest): Promise<BaseApiObject>;
     /**
-     * Retrieves a list of applications from Fonoster.
+     * Retrieves a list of Applications from Fonoster.
      *
-     * @param {ListApplicationsRequest} request - The request object that contains the necessary information to retrieve a list of applications
-     * @param {number} request.pageSize - The number of applications to retrieve
-     * @param {string} request.pageToken - The token to retrieve the next page of applications
-     * @return {Promise<ListApplicationsResponse>} - The response object that contains the list of applications
+     * @param {ListApplicationsRequest} request - The request object that contains the necessary information to retrieve a list of Applications
+     * @param {number} request.pageSize - The number of Applications to retrieve
+     * @param {string} request.pageToken - The token to retrieve the next page of Applications
+     * @return {Promise<ListApplicationsResponse>} - The response object that contains the list of Applications
      * @example
      *
      * const request = {
@@ -186,10 +190,10 @@ declare class Applications {
      */
     listApplications(request: ListApplicationsRequest): Promise<ListApplicationsResponse>;
     /**
-     * Deletes an existing application from Fonoster.
+     * Deletes an existing Application from Fonoster.
      * Note that this operation is irreversible.
      *
-     * @param {string} ref - The reference of the application to delete
+     * @param {string} ref - The reference of the Application to delete
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted application
      * @example
      *

package/dist/node/Applications.js

@@ -13,6 +13,23 @@ const utils_1 = require("./utils");
  *
  * 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",
@@ -40,18 +57,7 @@ const utils_1 = require("./utils");
  *   }
  * };
  *
- * const username = "admin@fonoster.local";
- * const password = "changeme";
- * const accessKeyId = "WO00000000000000000000000000000000";
- *
- * const client = new SDK.Client({ accessKeyId });
- *
- * 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
+ * main(request).catch(console.error);
  */
 class Applications {
     client;
@@ -135,19 +141,17 @@ class Applications {
         });
     }
     /**
-     * Retrieves an existing application from Fonoster.
+     * Retrieves an existing Application in the Workspace.
      *
-     * @param {string} ref - The reference of the application to retrieve
-     * @return {Promise<Application>} - The response object that contains the application information
+     * @param {string} ref - The reference of the Application to retrieve
+     * @return {Promise<Application>} - The response object that contains the Application information
      * @example
      *
-     * const request = {
-     *  ref: "00000000-0000-0000-0000-000000000000"
-     * };
+     * const ref = "00000000-0000-0000-0000-000000000000"
      *
      * const apps = new SDK.Applications(client); // Existing client object
      *
-     * apps.getApplication(request)
+     * apps.getApplication(ref)
      *  .then(console.log) // successful response
      *  .catch(console.error); // an error occurred
      */
@@ -209,12 +213,12 @@ class Applications {
         });
     }
     /**
-     * Retrieves a list of applications from Fonoster.
+     * Retrieves a list of Applications from Fonoster.
      *
-     * @param {ListApplicationsRequest} request - The request object that contains the necessary information to retrieve a list of applications
-     * @param {number} request.pageSize - The number of applications to retrieve
-     * @param {string} request.pageToken - The token to retrieve the next page of applications
-     * @return {Promise<ListApplicationsResponse>} - The response object that contains the list of applications
+     * @param {ListApplicationsRequest} request - The request object that contains the necessary information to retrieve a list of Applications
+     * @param {number} request.pageSize - The number of Applications to retrieve
+     * @param {string} request.pageToken - The token to retrieve the next page of Applications
+     * @return {Promise<ListApplicationsResponse>} - The response object that contains the list of Applications
      * @example
      *
      * const request = {
@@ -239,10 +243,10 @@ class Applications {
         });
     }
     /**
-     * Deletes an existing application from Fonoster.
+     * Deletes an existing Application from Fonoster.
      * Note that this operation is irreversible.
      *
-     * @param {string} ref - The reference of the application to delete
+     * @param {string} ref - The reference of the Application to delete
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted application
      * @example
      *

package/dist/node/Calls.d.ts

@@ -1,10 +1,109 @@
 import { CallDetailRecord, CreateCallRequest, CreateCallResponse, ListCallsRequest, ListCallsResponse } from "@fonoster/types";
 import { FonosterClient } from "./client/types";
+/**
+ * @classdesc 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.
+ *
+ * @example
+ *
+ * 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);
+ */
 declare class Calls {
     private client;
+    /**
+     * Constructs a new Calls object.
+     *
+     * @param {FonosterClient} client - Client object with underlying implementations to make requests to Fonoster's API
+     * @see AbstractClient
+     * @see FonosterClient
+     */
     constructor(client: FonosterClient);
+    /**
+     * Creates a new Call in the Workspace.
+     *
+     * @param {CreateCallRequest} request - The request object that contains the necessary information to create a new Call
+     * @param {string} request.from - The number that originated the call
+     * @param {string} request.to - The number that received the call
+     * @param {string} request.appRef - The reference of the App that will handle the call
+     * @return {Promise<CreateCallResponse>} - The response object that contains the reference to the created Call
+     * @example
+     *
+     * 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
+     */
     createCall(request: CreateCallRequest): Promise<CreateCallResponse>;
+    /**
+     * Retrieves an existing Call in the Workspace.
+     *
+     * @param {string} ref - The reference of the Call to retrieve
+     * @return {Promise<Acl>} - The response object that contains the Call detail
+     * @example
+     *
+     * 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
+     */
     getCall(ref: string): Promise<CallDetailRecord>;
+    /**
+     * Retrieves a list of Calls from a Workspace.
+     *
+     * @param {ListCallsRequest} request - The request object that contains the necessary information to retrieve a list of Calls
+     * @param {number} request.pageSize - The number of Calls to retrieve
+     * @param {string} request.pageToken - The token to retrieve the next page of Calls
+     * @return {Promise<ListCallsResponse>} - The response object that contains the list of Calls
+     * @example
+     *
+     * 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
+     */
     listCalls(request: ListCallsRequest): Promise<ListCallsResponse>;
 }
 export { Calls };

package/dist/node/Calls.js

@@ -22,11 +22,75 @@ exports.Calls = void 0;
 const types_1 = require("@fonoster/types");
 const makeRpcRequest_1 = require("./client/makeRpcRequest");
 const calls_pb_1 = require("./generated/node/calls_pb");
+/**
+ * @classdesc 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.
+ *
+ * @example
+ *
+ * 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);
+ */
 class Calls {
     client;
+    /**
+     * Constructs a new Calls object.
+     *
+     * @param {FonosterClient} client - Client object with underlying implementations to make requests to Fonoster's API
+     * @see AbstractClient
+     * @see FonosterClient
+     */
     constructor(client) {
         this.client = client;
     }
+    /**
+     * Creates a new Call in the Workspace.
+     *
+     * @param {CreateCallRequest} request - The request object that contains the necessary information to create a new Call
+     * @param {string} request.from - The number that originated the call
+     * @param {string} request.to - The number that received the call
+     * @param {string} request.appRef - The reference of the App that will handle the call
+     * @return {Promise<CreateCallResponse>} - The response object that contains the reference to the created Call
+     * @example
+     *
+     * 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
+     */
     async createCall(request) {
         const client = this.client.getCallsClient();
         return await (0, makeRpcRequest_1.makeRpcRequest)({
@@ -37,6 +101,21 @@ class Calls {
             enumMapping: [["type", types_1.CallType]]
         });
     }
+    /**
+     * Retrieves an existing Call in the Workspace.
+     *
+     * @param {string} ref - The reference of the Call to retrieve
+     * @return {Promise<Acl>} - The response object that contains the Call detail
+     * @example
+     *
+     * 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
+     */
     async getCall(ref) {
         const client = this.client.getCallsClient();
         return await (0, makeRpcRequest_1.makeRpcRequest)({
@@ -52,6 +131,26 @@ class Calls {
             ]
         });
     }
+    /**
+     * Retrieves a list of Calls from a Workspace.
+     *
+     * @param {ListCallsRequest} request - The request object that contains the necessary information to retrieve a list of Calls
+     * @param {number} request.pageSize - The number of Calls to retrieve
+     * @param {string} request.pageToken - The token to retrieve the next page of Calls
+     * @return {Promise<ListCallsResponse>} - The response object that contains the list of Calls
+     * @example
+     *
+     * 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
+     */
     async listCalls(request) {
         const client = this.client.getCallsClient();
         return await (0, makeRpcRequest_1.makeRpcRequest)({