@fonoster/sdk 0.7.4 → 0.7.5

package/README.md

@@ -967,8 +967,8 @@ Note that an active Fonoster deployment is required.
 
 * [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>
+    * [.createCall(request)](#Calls+createCall) ⇒ <code>Object</code>
+    * [.getCall(ref)](#Calls+getCall) ⇒ <code>Promise.&lt;CallDetailRecord&gt;</code>
     * [.listCalls(request)](#Calls+listCalls) ⇒ <code>Promise.&lt;ListCallsResponse&gt;</code>
 
 <a name="new_Calls_new"></a>
@@ -1003,7 +1003,7 @@ async function main(request) {
 }
 
 const request = {
-  from: "8287854037",
+  from: "+18287854037",
   to: "+17853178070",
   appRef: "00000000-0000-0000-0000-000000000000"
 };
@@ -1012,11 +1012,12 @@ main(request).catch(console.error);
 ```
 <a name="Calls+createCall"></a>
 
-### calls.createCall(request) ⇒ <code>Promise.&lt;CreateCallResponse&gt;</code>
+### calls.createCall(request) ⇒ <code>Object</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  
+**Returns**: <code>Object</code> - - The response object that contains the Call reference and a stream of status updates  
+**See**: DialStatus  
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -1024,29 +1025,35 @@ Creates a new Call in the Workspace.
 | 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 |
+| request.timeout | <code>number</code> | The time in seconds to wait for the call to be answered. Default is 60 seconds |
 
 **Example**  
 ```js
 const calls = new SDK.Calls(client); // Existing client object
 
 const request = {
-  from: "8287854037",
+  from: "+18287854037",
   to: "+17853178070",
-  appRef: "00000000-0000-0000-0000-000000000000"
+  appRef: "00000000-0000-0000-0000-000000000000",
+  timeout: 30
 };
 
-calls
-  .createCall(request)
-  .then(console.log) // successful response
-  .catch(console.error); // an error occurred
+const response = await calls.createCall(request);
+const { ref, statusStream } = response;
+
+console.log(ref); // Call reference
+
+for await (const status of statusStream) {
+ console.log(status); // Streamed status
+}
 ```
 <a name="Calls+getCall"></a>
 
-### calls.getCall(ref) ⇒ <code>Promise.&lt;Acl&gt;</code>
+### calls.getCall(ref) ⇒ <code>Promise.&lt;CallDetailRecord&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  
+**Returns**: <code>Promise.&lt;CallDetailRecord&gt;</code> - - The response object that contains the Call detail  
 
 | Param | Type | Description |
 | --- | --- | --- |

package/dist/node/Calls.d.ts

@@ -28,7 +28,7 @@ import { FonosterClient } from "./client/types";
  * }
  *
  * const request = {
- *   from: "8287854037",
+ *   from: "+18287854037",
  *   to: "+17853178070",
  *   appRef: "00000000-0000-0000-0000-000000000000"
  * };
@@ -59,7 +59,7 @@ declare class Calls {
      * const calls = new SDK.Calls(client); // Existing client object
      *
      * const request = {
-     *   from: "8287854037",
+     *   from: "+18287854037",
      *   to: "+17853178070",
      *   appRef: "00000000-0000-0000-0000-000000000000",
      *   timeout: 30

package/dist/node/Calls.js

@@ -31,7 +31,7 @@ const utils_1 = require("./utils");
  * }
  *
  * const request = {
- *   from: "8287854037",
+ *   from: "+18287854037",
  *   to: "+17853178070",
  *   appRef: "00000000-0000-0000-0000-000000000000"
  * };
@@ -64,7 +64,7 @@ class Calls {
      * const calls = new SDK.Calls(client); // Existing client object
      *
      * const request = {
-     *   from: "8287854037",
+     *   from: "+18287854037",
      *   to: "+17853178070",
      *   appRef: "00000000-0000-0000-0000-000000000000",
      *   timeout: 30

package/dist/node/client/types/common.d.ts

@@ -8,4 +8,4 @@ type ServerStream<U> = {
     on: (event: "data" | "error" | "end" | "status", listener: (response: U | Error | DataResponse) => void) => void;
 };
 type ServerStreamFunction<T, U> = (request: T, metadata: Metadata | unknown | null) => ServerStream<U>;
-export { MappingTuple, ServerStreamFunction, DataResponse, ClientFunction };
+export { ClientFunction, DataResponse, MappingTuple, ServerStreamFunction };

package/dist/node/client/types/index.d.ts

@@ -1,6 +1,6 @@
-export * from "./common";
-export * from "./FonosterClient";
 export * from "./ApplicationsClient";
-export * from "./IdentityClient";
 export * from "./CallsClient";
+export * from "./FonosterClient";
+export * from "./IdentityClient";
 export * from "./SecretsClient";
+export * from "./common";

package/dist/node/client/types/index.js

@@ -14,6 +14,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ApplicationsClient"), exports);
+__exportStar(require("./CallsClient"), exports);
+__exportStar(require("./FonosterClient"), exports);
+__exportStar(require("./IdentityClient"), exports);
+__exportStar(require("./SecretsClient"), exports);
 /*
  * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/fonoster
@@ -33,8 +38,3 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * limitations under the License.
  */
 __exportStar(require("./common"), exports);
-__exportStar(require("./FonosterClient"), exports);
-__exportStar(require("./ApplicationsClient"), exports);
-__exportStar(require("./IdentityClient"), exports);
-__exportStar(require("./CallsClient"), exports);
-__exportStar(require("./SecretsClient"), exports);

package/dist/node/client/utils.d.ts

@@ -2,4 +2,4 @@ import { MappingTuple } from "./types";
 declare function isMapping(key: string, objectMapping: MappingTuple<unknown>): boolean;
 declare function getEnumValue(key: string, value: string, enumMapping: MappingTuple<unknown>): number;
 declare function getEnumKey(key: string, value: number, enumMapping: MappingTuple<unknown>): string;
-export { isMapping, getEnumValue, getEnumKey };
+export { getEnumKey, getEnumValue, isMapping };

package/dist/node/client/utils.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isMapping = isMapping;
-exports.getEnumValue = getEnumValue;
 exports.getEnumKey = getEnumKey;
+exports.getEnumValue = getEnumValue;
+exports.isMapping = isMapping;
 function isMapping(key, objectMapping) {
     return objectMapping?.some((tuple) => tuple[0] === key);
 }

package/dist/node/generated/node/applications_pb.js

@@ -2645,7 +2645,7 @@ proto.fonoster.applications.v1beta2.DeleteApplicationResponse.prototype.setRef =
  * @enum {number}
  */
 proto.fonoster.applications.v1beta2.ApplicationType = {
-  PROGRAMMABLE_VOICE: 0
+  EXTERNAL: 0
 };
 
 goog.object.extend(exports, proto.fonoster.applications.v1beta2);

package/dist/node/generated/web/applications_pb.d.ts

@@ -318,5 +318,5 @@ export namespace DeleteApplicationResponse {
 }
 
 export enum ApplicationType { 
-  PROGRAMMABLE_VOICE = 0,
+  EXTERNAL = 0,
 }

package/dist/node/generated/web/applications_pb.js

@@ -2645,7 +2645,7 @@ proto.fonoster.applications.v1beta2.DeleteApplicationResponse.prototype.setRef =
  * @enum {number}
  */
 proto.fonoster.applications.v1beta2.ApplicationType = {
-  PROGRAMMABLE_VOICE: 0
+  EXTERNAL: 0
 };
 
 goog.object.extend(exports, proto.fonoster.applications.v1beta2);

package/dist/node/node.d.ts

@@ -1,13 +1,13 @@
-export * from "./client/Client";
+export * from "./Acls";
+export * from "./Agents";
+export * from "./ApiKeys";
 export * from "./Applications";
 export * from "./Calls";
-export * from "./ApiKeys";
-export * from "./Users";
-export * from "./Secrets";
-export * from "./Agents";
-export * from "./Domains";
-export * from "./Trunks";
 export * from "./Credentials";
-export * from "./Acls";
+export * from "./Domains";
 export * from "./Numbers";
+export * from "./Secrets";
+export * from "./Trunks";
+export * from "./Users";
 export * from "./Workspaces";
+export * from "./client/Client";

package/dist/node/node.js

@@ -14,6 +14,18 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Acls"), exports);
+__exportStar(require("./Agents"), exports);
+__exportStar(require("./ApiKeys"), exports);
+__exportStar(require("./Applications"), exports);
+__exportStar(require("./Calls"), exports);
+__exportStar(require("./Credentials"), exports);
+__exportStar(require("./Domains"), exports);
+__exportStar(require("./Numbers"), exports);
+__exportStar(require("./Secrets"), exports);
+__exportStar(require("./Trunks"), exports);
+__exportStar(require("./Users"), exports);
+__exportStar(require("./Workspaces"), exports);
 /*
  * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/fonoster
@@ -33,15 +45,3 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * limitations under the License.
  */
 __exportStar(require("./client/Client"), exports);
-__exportStar(require("./Applications"), exports);
-__exportStar(require("./Calls"), exports);
-__exportStar(require("./ApiKeys"), exports);
-__exportStar(require("./Users"), exports);
-__exportStar(require("./Secrets"), exports);
-__exportStar(require("./Agents"), exports);
-__exportStar(require("./Domains"), exports);
-__exportStar(require("./Trunks"), exports);
-__exportStar(require("./Credentials"), exports);
-__exportStar(require("./Acls"), exports);
-__exportStar(require("./Numbers"), exports);
-__exportStar(require("./Workspaces"), exports);