@fonoster/sdk 0.6.5 → 0.7.0

package/dist/node/Acls.d.ts

@@ -1,4 +1,4 @@
-import { Acl, BaseApiObject, CreateAclRequest, ListAclsRequest, ListAclsResponse, UpdateAclRequest } from "@fonoster/types";
+import { BaseApiObject, CreateAclRequest, ListAclsRequest, ListAclsResponse, UpdateAclRequest } from "@fonoster/types";
 import { FonosterClient } from "./client/types";
 /**
  * @classdesc Fonoster Acls, part of the Fonoster SIP Proxy subsystem,
@@ -6,16 +6,15 @@ import { FonosterClient } from "./client/types";
  * 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";
+ *   const API_KEY = "your-api-key";
+ *   const ACCESS_KEY_ID = "00000000-0000-0000-0000-000000000000";
  *
- *  try {
- *     const client = SDK.Client({ accessKeyId });
- *     await client.loginWithApiKey(apiKey);
+ *   try {
+ *     const client = SDK.Client({ accessKeyId: ACCESS_KEY_ID });
+ *     await client.loginWithApiKey(API_KEY);
  *
  *     const acls = new SDK.Acls(client);
  *     const response = await acls.createAcl(request);
@@ -53,18 +52,18 @@ declare class Acls {
      * @param {string[]} request.deny - The list of IPs to deny
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Acl
      * @example
+     * const acls = new SDK.Acls(client); // Existing client object
      *
      * const request = {
-     *  name: "My ACL",
-     *  allow: ["47.132.130.31"], // Allow only this IP
-     *  deny: ["0.0.0.0/0"] // Deny all other IPs
+     *   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
-     *
-     * acls.createAcl(request)
-     * .then(console.log) // successful response
-     * .catch(console.error); // an error occurred
+     * acls
+     *   .createAcl(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     createAcl(request: CreateAclRequest): Promise<BaseApiObject>;
     /**
@@ -73,16 +72,16 @@ declare class Acls {
      * @param {string} ref - The reference of the Acl to retrieve
      * @return {Promise<Acl>} - The response object that contains the Acl information
      * @example
-     *
-     * 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
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * acls
+     *   .getAcl(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
-    getAcl(ref: string): Promise<Acl>;
+    getAcl(ref: string): Promise<unknown>;
     /**
      * Updates an existing Acl in the Workspace.
      *
@@ -93,19 +92,19 @@ declare class Acls {
      * @param {string[]} request.deny - The list of IPs to deny
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Acl
      * @example
+     * const acls = new SDK.Acls(client); // Existing client object
      *
      * 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
+     *   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
+     * acls
+     *   .updateAcl(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     updateAcl(request: UpdateAclRequest): Promise<BaseApiObject>;
     /**
@@ -116,17 +115,17 @@ declare class Acls {
      * @param {string} request.pageToken - The token to retrieve the next page of Acls
      * @return {Promise<ListAclsResponse>} - The response object that contains the list of Acls
      * @example
+     * const acls = new SDK.Acls(client); // Existing client object
      *
      * const request = {
-     *  pageSize: 10,
-     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     *   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
+     * acls
+     *   .listAcls(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     listAcls(request: ListAclsRequest): Promise<ListAclsResponse>;
     /**
@@ -136,14 +135,14 @@ declare class Acls {
      * @param {string} ref - The reference of the Acl to delete
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted Acl
      * @example
-     *
-     * 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
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * acls
+     *   .deleteAcl(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     deleteAcl(ref: string): Promise<BaseApiObject>;
 }

package/dist/node/Acls.js

@@ -9,16 +9,15 @@ const acls_pb_1 = require("./generated/node/acls_pb");
  * 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";
+ *   const API_KEY = "your-api-key";
+ *   const ACCESS_KEY_ID = "00000000-0000-0000-0000-000000000000";
  *
- *  try {
- *     const client = SDK.Client({ accessKeyId });
- *     await client.loginWithApiKey(apiKey);
+ *   try {
+ *     const client = SDK.Client({ accessKeyId: ACCESS_KEY_ID });
+ *     await client.loginWithApiKey(API_KEY);
  *
  *     const acls = new SDK.Acls(client);
  *     const response = await acls.createAcl(request);
@@ -58,18 +57,18 @@ class Acls {
      * @param {string[]} request.deny - The list of IPs to deny
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Acl
      * @example
+     * const acls = new SDK.Acls(client); // Existing client object
      *
      * const request = {
-     *  name: "My ACL",
-     *  allow: ["47.132.130.31"], // Allow only this IP
-     *  deny: ["0.0.0.0/0"] // Deny all other IPs
+     *   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
-     *
-     * acls.createAcl(request)
-     * .then(console.log) // successful response
-     * .catch(console.error); // an error occurred
+     * acls
+     *   .createAcl(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async createAcl(request) {
         const client = this.client.getAclsClient();
@@ -93,22 +92,34 @@ class Acls {
      * @param {string} ref - The reference of the Acl to retrieve
      * @return {Promise<Acl>} - The response object that contains the Acl information
      * @example
-     *
-     * 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
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * acls
+     *   .getAcl(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async getAcl(ref) {
+        const updateAclRequest = new acls_pb_1.GetAclRequest();
+        updateAclRequest.setRef(ref);
         const client = this.client.getAclsClient();
-        return await (0, makeRpcRequest_1.makeRpcRequest)({
-            method: client.getAcl.bind(client),
-            requestPBObjectConstructor: acls_pb_1.GetAclRequest,
-            metadata: this.client.getMetadata(),
-            request: { ref }
+        return new Promise((resolve, reject) => {
+            client.getAcl(updateAclRequest, this.client.getMetadata(), (err, response) => {
+                if (err) {
+                    reject(err);
+                    return;
+                }
+                const obj = response.toObject();
+                resolve({
+                    ...obj,
+                    allow: obj.allowList,
+                    deny: obj.denyList,
+                    createdAt: new Date(obj.createdAt * 1000),
+                    updatedAt: new Date(obj.updatedAt * 1000)
+                });
+            });
         });
     }
     /**
@@ -121,19 +132,19 @@ class Acls {
      * @param {string[]} request.deny - The list of IPs to deny
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Acl
      * @example
+     * const acls = new SDK.Acls(client); // Existing client object
      *
      * 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
+     *   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
+     * acls
+     *   .updateAcl(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async updateAcl(request) {
         const client = this.client.getAclsClient();
@@ -160,17 +171,17 @@ class Acls {
      * @param {string} request.pageToken - The token to retrieve the next page of Acls
      * @return {Promise<ListAclsResponse>} - The response object that contains the list of Acls
      * @example
+     * const acls = new SDK.Acls(client); // Existing client object
      *
      * const request = {
-     *  pageSize: 10,
-     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     *   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
+     * acls
+     *   .listAcls(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async listAcls(request) {
         const client = this.client.getAclsClient();
@@ -188,11 +199,13 @@ class Acls {
                     return {
                         ...obj,
                         allow: obj.allowList,
-                        deny: obj.denyList
+                        deny: obj.denyList,
+                        createdAt: new Date(obj.createdAt * 1000),
+                        updatedAt: new Date(obj.updatedAt * 1000)
                     };
                 });
                 resolve({
-                    items,
+                    items: items,
                     nextPageToken: response.getNextPageToken()
                 });
             });
@@ -205,14 +218,14 @@ class Acls {
      * @param {string} ref - The reference of the Acl to delete
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted Acl
      * @example
-     *
-     * 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
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * acls
+     *   .deleteAcl(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async deleteAcl(ref) {
         const client = this.client.getAclsClient();

package/dist/node/Agents.d.ts

@@ -6,16 +6,15 @@ import { FonosterClient } from "./client/types";
  * 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";
+ *   const API_KEY = "your-api-key";
+ *   const ACCESS_KEY_ID = "00000000-0000-0000-0000-000000000000";
  *
- *  try {
- *     const client = SDK.Client({ accessKeyId });
- *     await client.loginWithApiKey(apiKey);
+ *   try {
+ *     const client = SDK.Client({ accessKeyId: ACCESS_KEY_ID });
+ *     await client.loginWithApiKey(API_KEY);
  *
  *     const agents = new SDK.Agents(client);
  *     const response = await agents.createAgent(request);
@@ -59,21 +58,21 @@ declare class Agents {
      * @param {string} request.domainRef - The reference of the Domain to associate the Agent
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Agent
      * @example
+     * const agents = new SDK.Agents(client); // Existing client object
      *
      * const request = {
-     *  name: "John Doe",
-     *  username: "1001",
-     *  privacy: "PRIVATE",
-     *  enabled: true,
-     *  maxContacts: 3
-     *  domainRef: "00000000-0000-0000-0000-000000000000"
+     *   name: "John Doe",
+     *   username: "1001",
+     *   privacy: "PRIVATE",
+     *   enabled: true,
+     *   maxContacts: 3
+     *   domainRef: "00000000-0000-0000-0000-000000000000"
      * };
      *
-     * const agents = new SDK.Agents(client); // Existing client object
-     *
-     * agents.createAgent(request)
-     *  .then(console.log) // successful response
-     *  .catch(console.error); // an error occurred
+     * agents
+     *   .createAgent(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     createAgent(request: CreateAgentRequest): Promise<BaseApiObject>;
     /**
@@ -82,14 +81,14 @@ declare class Agents {
      * @param {string} ref - The reference of the Agent to retrieve
      * @return {Promise<Acl>} - The response object that contains the Agent information
      * @example
-     *
-     * const ref = "00000000-0000-0000-0000-000000000000"
-     *
      * const agents = new SDK.Agents(client); // Existing client object
      *
-     * agents.getAgent(ref)
-     *  .then(console.log) // successful response
-     *  .catch(console.error); // an error occurred
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * agents
+     *   .getAgent(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     getAgent(ref: string): Promise<Agent>;
     /**
@@ -104,21 +103,21 @@ declare class Agents {
      * @param {string} request.domainRef - The reference of the Domain to associate the Agent
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Agent
      * @example
+     * const agents = new SDK.Agents(client); // Existing client object
      *
      * const request = {
-     *  ref: "00000000-0000-0000-0000-000000000000",
-     *  name: "John Doe",
-     *  privacy: "PRIVATE",
-     *  enabled: true,
-     *  maxContacts: 3
-     *  domainRef: "00000000-0000-0000-0000-000000000000"
+     *   ref: "00000000-0000-0000-0000-000000000000",
+     *   name: "John Doe",
+     *   privacy: "PRIVATE",
+     *   enabled: true,
+     *   maxContacts: 3
+     *   domainRef: "00000000-0000-0000-0000-000000000000"
      * };
      *
-     * const agents = new SDK.Agents(client); // Existing client object
-     *
-     * agents.updateAgent(request)
-     *  .then(console.log) // successful response
-     *  .catch(console.error); // an error occurred
+     * agents
+     *   .updateAgent(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     updateAgent(request: UpdateAgentRequest): Promise<BaseApiObject>;
     /**
@@ -129,17 +128,17 @@ declare class Agents {
      * @param {string} request.pageToken - The token to retrieve the next page of Agents
      * @return {Promise<ListAgentsResponse>} - The response object that contains the list of Agents
      * @example
+     * const agents = new SDK.Agents(client); // Existing client object
      *
      * const request = {
      *  pageSize: 10,
      *  pageToken: "00000000-0000-0000-0000-000000000000"
      * };
      *
-     * const agents = new SDK.Agents(client); // Existing client object
-     *
-     * agents.listAgents(request)
-     *  .then(console.log) // successful response
-     *  .catch(console.error); // an error occurred
+     * agents
+     *   .listAgents(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     listAgents(request: ListAgentsRequest): Promise<ListAgentsResponse>;
     /**
@@ -149,14 +148,14 @@ declare class Agents {
      * @param {string} ref - The reference of the Agent to delete
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted Agent
      * @example
-     *
-     * const ref =  "00000000-0000-0000-0000-000000000000"
-     *
      * const agents = new SDK.Agents(client); // Existing client object
      *
-     * agents.deleteAgent(ref)
-     *  .then(console.log) // successful response
-     *  .catch(console.error); // an error occurred
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * agents
+     *   .deleteAgent(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     deleteAgent(ref: string): Promise<BaseApiObject>;
 }

package/dist/node/Agents.js

@@ -9,16 +9,15 @@ const agents_pb_1 = require("./generated/node/agents_pb");
  * 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";
+ *   const API_KEY = "your-api-key";
+ *   const ACCESS_KEY_ID = "00000000-0000-0000-0000-000000000000";
  *
- *  try {
- *     const client = SDK.Client({ accessKeyId });
- *     await client.loginWithApiKey(apiKey);
+ *   try {
+ *     const client = SDK.Client({ accessKeyId: ACCESS_KEY_ID });
+ *     await client.loginWithApiKey(API_KEY);
  *
  *     const agents = new SDK.Agents(client);
  *     const response = await agents.createAgent(request);
@@ -64,21 +63,21 @@ class Agents {
      * @param {string} request.domainRef - The reference of the Domain to associate the Agent
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Agent
      * @example
+     * const agents = new SDK.Agents(client); // Existing client object
      *
      * const request = {
-     *  name: "John Doe",
-     *  username: "1001",
-     *  privacy: "PRIVATE",
-     *  enabled: true,
-     *  maxContacts: 3
-     *  domainRef: "00000000-0000-0000-0000-000000000000"
+     *   name: "John Doe",
+     *   username: "1001",
+     *   privacy: "PRIVATE",
+     *   enabled: true,
+     *   maxContacts: 3
+     *   domainRef: "00000000-0000-0000-0000-000000000000"
      * };
      *
-     * const agents = new SDK.Agents(client); // Existing client object
-     *
-     * agents.createAgent(request)
-     *  .then(console.log) // successful response
-     *  .catch(console.error); // an error occurred
+     * agents
+     *   .createAgent(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async createAgent(request) {
         const client = this.client.getAgentsClient();
@@ -96,14 +95,14 @@ class Agents {
      * @param {string} ref - The reference of the Agent to retrieve
      * @return {Promise<Acl>} - The response object that contains the Agent information
      * @example
-     *
-     * const ref = "00000000-0000-0000-0000-000000000000"
-     *
      * const agents = new SDK.Agents(client); // Existing client object
      *
-     * agents.getAgent(ref)
-     *  .then(console.log) // successful response
-     *  .catch(console.error); // an error occurred
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * agents
+     *   .getAgent(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async getAgent(ref) {
         const client = this.client.getAgentsClient();
@@ -111,7 +110,8 @@ class Agents {
             method: client.getAgent.bind(client),
             requestPBObjectConstructor: agents_pb_1.GetAgentRequest,
             metadata: this.client.getMetadata(),
-            request: { ref }
+            request: { ref },
+            enumMapping: [["privacy", agents_pb_1.Privacy]]
         });
     }
     /**
@@ -126,21 +126,21 @@ class Agents {
      * @param {string} request.domainRef - The reference of the Domain to associate the Agent
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Agent
      * @example
+     * const agents = new SDK.Agents(client); // Existing client object
      *
      * const request = {
-     *  ref: "00000000-0000-0000-0000-000000000000",
-     *  name: "John Doe",
-     *  privacy: "PRIVATE",
-     *  enabled: true,
-     *  maxContacts: 3
-     *  domainRef: "00000000-0000-0000-0000-000000000000"
+     *   ref: "00000000-0000-0000-0000-000000000000",
+     *   name: "John Doe",
+     *   privacy: "PRIVATE",
+     *   enabled: true,
+     *   maxContacts: 3
+     *   domainRef: "00000000-0000-0000-0000-000000000000"
      * };
      *
-     * const agents = new SDK.Agents(client); // Existing client object
-     *
-     * agents.updateAgent(request)
-     *  .then(console.log) // successful response
-     *  .catch(console.error); // an error occurred
+     * agents
+     *   .updateAgent(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async updateAgent(request) {
         const client = this.client.getAgentsClient();
@@ -160,17 +160,17 @@ class Agents {
      * @param {string} request.pageToken - The token to retrieve the next page of Agents
      * @return {Promise<ListAgentsResponse>} - The response object that contains the list of Agents
      * @example
+     * const agents = new SDK.Agents(client); // Existing client object
      *
      * const request = {
      *  pageSize: 10,
      *  pageToken: "00000000-0000-0000-0000-000000000000"
      * };
      *
-     * const agents = new SDK.Agents(client); // Existing client object
-     *
-     * agents.listAgents(request)
-     *  .then(console.log) // successful response
-     *  .catch(console.error); // an error occurred
+     * agents
+     *   .listAgents(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async listAgents(request) {
         const client = this.client.getAgentsClient();
@@ -179,6 +179,7 @@ class Agents {
             requestPBObjectConstructor: agents_pb_1.ListAgentsRequest,
             metadata: this.client.getMetadata(),
             request,
+            enumMapping: [["privacy", agents_pb_1.Privacy]],
             repeatableObjectMapping: [["itemsList", agents_pb_1.Agent]]
         });
     }
@@ -189,14 +190,14 @@ class Agents {
      * @param {string} ref - The reference of the Agent to delete
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted Agent
      * @example
-     *
-     * const ref =  "00000000-0000-0000-0000-000000000000"
-     *
      * const agents = new SDK.Agents(client); // Existing client object
      *
-     * agents.deleteAgent(ref)
-     *  .then(console.log) // successful response
-     *  .catch(console.error); // an error occurred
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * agents
+     *   .deleteAgent(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async deleteAgent(ref) {
         const applicationsClient = this.client.getAgentsClient();