@fonoster/sdk 0.6.5 → 0.7.0

package/dist/node/Calls.d.ts

@@ -1,4 +1,5 @@
-import { CallDetailRecord, CreateCallRequest, CreateCallResponse, ListCallsRequest, ListCallsResponse } from "@fonoster/types";
+import { DialStatus } from "@fonoster/common";
+import { CallDetailRecord, CreateCallRequest, ListCallsRequest, ListCallsResponse } from "@fonoster/types";
 import { FonosterClient } from "./client/types";
 /**
  * @classdesc Fonoster Calls, part of the Fonoster Media subsystem,
@@ -10,13 +11,12 @@ import { FonosterClient } from "./client/types";
  * const SDK = require("@fonoster/sdk");
  *
  * async function main(request) {
- *  const username = "admin";
- *  const password = "yourpassword";
- *  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.login({ username, password });
+ *   try {
+ *     const client = SDK.Client({ accessKeyId: ACCESS_KEY_ID });
+ *     await client.loginWithApiKey(apiKey);
  *
  *     const calls = new SDK.Calls(client);
  *     const response = await apiKeys.createCall(request);
@@ -52,36 +52,48 @@ declare class Calls {
      * @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
+     * @param {number} request.timeout - The time in seconds to wait for the call to be answered. Default is 60 seconds
+     * @return {{ref: string, statusStream: AsyncGenerator<{ status: DialStatus }>}} - The response object that contains the Call reference and a stream of status updates
+     * @see DialStatus
      * @example
+     * const calls = new SDK.Calls(client); // Existing client object
      *
      * const request = {
-     *  from: "8287854037",
-     *  to: "+17853178070",
-     *  appRef: "00000000-0000-0000-0000-000000000000"
+     *   from: "8287854037",
+     *   to: "+17853178070",
+     *   appRef: "00000000-0000-0000-0000-000000000000",
+     *   timeout: 30
      * };
      *
-     * const calls = new SDK.Calls(client); // Existing client object
+     * const response = await calls.createCall(request);
+     * const { ref, statusStream } = response;
+     *
+     * console.log(ref); // Call reference
      *
-     * calls.createCall(request)
-     *  .then(console.log) // successful response
-     *  .catch(console.error); // an error occurred
+     * for await (const status of statusStream) {
+     *  console.log(status); // Streamed status
+     * }
      */
-    createCall(request: CreateCallRequest): Promise<CreateCallResponse>;
+    createCall(request: CreateCallRequest): Promise<{
+        ref: string;
+        statusStream: AsyncGenerator<{
+            status: DialStatus;
+        }>;
+    }>;
     /**
      * 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
+     * @return {Promise<CallDetailRecord>} - 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
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * calls
+     *   .getCall(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     getCall(ref: string): Promise<CallDetailRecord>;
     /**
@@ -92,17 +104,17 @@ declare class Calls {
      * @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 calls = new SDK.Calls(client); // Existing client object
      *
      * const request = {
-     *  pageSize: 10,
-     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     *   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
+     * calls
+     *   .listCalls(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     listCalls(request: ListCallsRequest): Promise<ListCallsResponse>;
 }

package/dist/node/Calls.js

@@ -1,27 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Calls = void 0;
-/*
- * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
- * http://github.com/fonoster/fonoster
- *
- * This file is part of Fonoster
- *
- * Licensed under the MIT License (the "License");
- * you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- *    https://opensource.org/licenses/MIT
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-const types_1 = require("@fonoster/types");
 const makeRpcRequest_1 = require("./client/makeRpcRequest");
 const calls_pb_1 = require("./generated/node/calls_pb");
+const utils_1 = require("./utils");
 /**
  * @classdesc Fonoster Calls, part of the Fonoster Media subsystem,
  * allows you to create, list, and track calls in your deployment.
@@ -32,13 +14,12 @@ const calls_pb_1 = require("./generated/node/calls_pb");
  * const SDK = require("@fonoster/sdk");
  *
  * async function main(request) {
- *  const username = "admin";
- *  const password = "yourpassword";
- *  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.login({ username, password });
+ *   try {
+ *     const client = SDK.Client({ accessKeyId: ACCESS_KEY_ID });
+ *     await client.loginWithApiKey(apiKey);
  *
  *     const calls = new SDK.Calls(client);
  *     const response = await apiKeys.createCall(request);
@@ -76,45 +57,84 @@ class Calls {
      * @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
+     * @param {number} request.timeout - The time in seconds to wait for the call to be answered. Default is 60 seconds
+     * @return {{ref: string, statusStream: AsyncGenerator<{ status: DialStatus }>}} - The response object that contains the Call reference and a stream of status updates
+     * @see DialStatus
      * @example
+     * const calls = new SDK.Calls(client); // Existing client object
      *
      * const request = {
-     *  from: "8287854037",
-     *  to: "+17853178070",
-     *  appRef: "00000000-0000-0000-0000-000000000000"
+     *   from: "8287854037",
+     *   to: "+17853178070",
+     *   appRef: "00000000-0000-0000-0000-000000000000",
+     *   timeout: 30
      * };
      *
-     * const calls = new SDK.Calls(client); // Existing client object
+     * const response = await calls.createCall(request);
+     * const { ref, statusStream } = response;
      *
-     * calls.createCall(request)
-     *  .then(console.log) // successful response
-     *  .catch(console.error); // an error occurred
+     * console.log(ref); // Call reference
+     *
+     * for await (const status of statusStream) {
+     *  console.log(status); // Streamed status
+     * }
      */
     async createCall(request) {
         const client = this.client.getCallsClient();
-        return await (0, makeRpcRequest_1.makeRpcRequest)({
+        const response = await (0, makeRpcRequest_1.makeRpcRequest)({
             method: client.createCall.bind(client),
             requestPBObjectConstructor: calls_pb_1.CreateCallRequest,
             metadata: this.client.getMetadata(),
-            request,
-            enumMapping: [["type", types_1.CallType]]
+            request
         });
+        const trackCallRequest = new calls_pb_1.TrackCallRequest();
+        trackCallRequest.setRef(response.ref);
+        const call = client.trackCall(trackCallRequest, this.client.getMetadata());
+        async function* statusStreamGenerator() {
+            const queue = [];
+            let done = false;
+            call.on("data", (response) => {
+                const data = response.toObject();
+                queue.push(data);
+            });
+            call.on("end", () => {
+                done = true;
+            });
+            call.on("error", () => {
+                done = true;
+                throw new Error("An error occurred while tracking the call");
+            });
+            // eslint-disable-next-line no-loops/no-loops
+            while (!done) {
+                if (queue.length > 0) {
+                    const data = queue.shift();
+                    if (!data) {
+                        return;
+                    }
+                    yield { status: (0, utils_1.dialStatusToString)(data.status) };
+                }
+                else {
+                    await new Promise((resolve) => setTimeout(resolve, 50));
+                }
+            }
+        }
+        const statusStream = statusStreamGenerator();
+        return { ref: response.ref, statusStream };
     }
     /**
      * 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
+     * @return {Promise<CallDetailRecord>} - 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
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * calls
+     *   .getCall(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async getCall(ref) {
         const client = this.client.getCallsClient();
@@ -124,10 +144,9 @@ class Calls {
             metadata: this.client.getMetadata(),
             request: { ref },
             enumMapping: [
-                ["type", types_1.CallType],
-                ["callStatus", types_1.CallStatus],
-                ["hangupCause", types_1.HangupCause],
-                ["callDirection", types_1.CallDirection]
+                ["type", calls_pb_1.CallType],
+                ["status", calls_pb_1.CallStatus],
+                ["direction", calls_pb_1.CallDirection]
             ]
         });
     }
@@ -139,17 +158,17 @@ class Calls {
      * @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 calls = new SDK.Calls(client); // Existing client object
      *
      * const request = {
-     *  pageSize: 10,
-     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     *   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
+     * calls
+     *   .listCalls(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async listCalls(request) {
         const client = this.client.getCallsClient();
@@ -158,6 +177,11 @@ class Calls {
             requestPBObjectConstructor: calls_pb_1.ListCallsRequest,
             metadata: this.client.getMetadata(),
             request,
+            enumMapping: [
+                ["type", calls_pb_1.CallType],
+                ["status", calls_pb_1.CallStatus],
+                ["direction", calls_pb_1.CallDirection]
+            ],
             repeatableObjectMapping: [["itemsList", calls_pb_1.Call]]
         });
     }

package/dist/node/Credentials.d.ts

@@ -10,11 +10,11 @@ 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";
+ *   const API_KEY = "your-api-key";
+ *   const ACCESS_KEY_ID = "00000000-0000-0000-0000-000000000000";
  *
- *  try {
- *     const client = SDK.Client({ accessKeyId });
+ *   try {
+ *     const client = SDK.Client({ accessKeyId: ACCESS_KEY_ID });
  *     await client.loginWithApiKey(apiKey);
  *
  *     const credentials = new SDK.Credentials(client);
@@ -53,18 +53,18 @@ declare class Credentials {
      * @param {string} request.password - The password of the Credentials
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Credentials
      * @example
+     * const credentials = new SDK.Credentials(client); // Existing client object
      *
      * const request = {
-     *  name: "My Credentials",
-     *  username: "myusername",
-     *  password: "mysecret"
+     *   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
+     * credentials
+     *   .createCredentials(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     createCredentials(request: CreateCredentialsRequest): Promise<BaseApiObject>;
     /**
@@ -73,14 +73,14 @@ declare class Credentials {
      * @param {string} ref - The reference of the Credentials to retrieve
      * @return {Promise<Acl>} - The response object that contains the Credentials
      * @example
-     *
-     * 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
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * credentials
+     *   .getCredentials(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     getCredentials(ref: string): Promise<CredentialsType>;
     /**
@@ -92,18 +92,18 @@ declare class Credentials {
      * @param {string} request.password - The password of the Credentials
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Credentials
      * @example
+     * const credentials = new SDK.Credentials(client); // Existing client object
      *
      * const request = {
-     *  ref: "00000000-0000-0000-0000-000000000000",
-     *  name: "My Credentials",
-     *  password: "mysecret"
+     *   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
+     * credentials
+     *    .updateCredentials(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     updateCredentials(request: UpdateCredentialsRequest): Promise<BaseApiObject>;
     /**
@@ -114,17 +114,17 @@ declare class Credentials {
      * @param {string} request.pageToken - The token to retrieve the next page of Credentials
      * @return {Promise<ListCredentialsResponse>} - The response object that contains the list of Credentials
      * @example
+     * const credentials = new SDK.Credentials(client); // Existing client object
      *
      * const request = {
-     *  pageSize: 10,
-     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     *   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
+     * credentials
+     *   .listCredentials(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     listCredentials(request: ListCredentialsRequest): Promise<ListCredentialsResponse>;
     /**
@@ -134,14 +134,14 @@ declare class Credentials {
      * @param {string} ref - The reference of the Credentials to delete
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted Credentials
      * @example
-     *
-     * 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
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * credentials
+     *   .deleteCredentials(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     deleteCredentials(ref: string): Promise<BaseApiObject>;
 }

package/dist/node/Credentials.js

@@ -13,11 +13,11 @@ const credentials_pb_1 = require("./generated/node/credentials_pb");
  * 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 });
+ *   try {
+ *     const client = SDK.Client({ accessKeyId: ACCESS_KEY_ID });
  *     await client.loginWithApiKey(apiKey);
  *
  *     const credentials = new SDK.Credentials(client);
@@ -58,18 +58,18 @@ class Credentials {
      * @param {string} request.password - The password of the Credentials
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Credentials
      * @example
+     * const credentials = new SDK.Credentials(client); // Existing client object
      *
      * const request = {
-     *  name: "My Credentials",
-     *  username: "myusername",
-     *  password: "mysecret"
+     *   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
+     * credentials
+     *   .createCredentials(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async createCredentials(request) {
         const client = this.client.getCredentialsClient();
@@ -86,14 +86,14 @@ class Credentials {
      * @param {string} ref - The reference of the Credentials to retrieve
      * @return {Promise<Acl>} - The response object that contains the Credentials
      * @example
-     *
-     * 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
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * credentials
+     *   .getCredentials(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async getCredentials(ref) {
         const client = this.client.getCredentialsClient();
@@ -113,18 +113,18 @@ class Credentials {
      * @param {string} request.password - The password of the Credentials
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Credentials
      * @example
+     * const credentials = new SDK.Credentials(client); // Existing client object
      *
      * const request = {
-     *  ref: "00000000-0000-0000-0000-000000000000",
-     *  name: "My Credentials",
-     *  password: "mysecret"
+     *   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
+     * credentials
+     *    .updateCredentials(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async updateCredentials(request) {
         const client = this.client.getCredentialsClient();
@@ -143,17 +143,17 @@ class Credentials {
      * @param {string} request.pageToken - The token to retrieve the next page of Credentials
      * @return {Promise<ListCredentialsResponse>} - The response object that contains the list of Credentials
      * @example
+     * const credentials = new SDK.Credentials(client); // Existing client object
      *
      * const request = {
-     *  pageSize: 10,
-     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     *   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
+     * credentials
+     *   .listCredentials(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async listCredentials(request) {
         const client = this.client.getCredentialsClient();
@@ -172,14 +172,14 @@ class Credentials {
      * @param {string} ref - The reference of the Credentials to delete
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted Credentials
      * @example
-     *
-     * 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
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * credentials
+     *   .deleteCredentials(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async deleteCredentials(ref) {
         const applicationsClient = this.client.getCredentialsClient();