@sinch/voice 0.0.1

package/README.md

@@ -0,0 +1,136 @@
+# Sinch Voice SDK for Node.js
+
+This package contains the Sinch Voice SDK for Node.js for use with [Sinch APIs](https://developers.sinch.com/). To use it, you will need a Sinch account. Please [sign up](https://dashboard.sinch.com/signup) or [log in](https://dashboard.sinch.com/login) if you already have one.
+
+<span style="color:red; font-weight:bold">Warning:</span>
+**This SDK is currently available for preview purposes only. It should not be used in production environments.**
+
+
+## Installation
+
+We recommend to use this SDK as part of the `@sinch/sdk-core` package as it will take care about the authentication plugins to use.
+
+However, it's still possible to use this SDK standalone is you need to access the Verification API only.
+
+### With NPM
+
+```bash
+npm install @sinch/voice
+```
+
+### With Yarn
+
+```bash
+yarn add @sinch/voice
+```
+
+## Usage
+
+### Credentials
+
+The `Voice` API uses the Application Signed Request to authenticate against the server. You will need to provide the following credentials:
+- applicationKey: one of the application keys that can be found in [Apps section](https://dashboard.sinch.com/voice/apps) of the Voice dashboard
+- applicationSecret: the corresponding secret that can be found at the same place
+
+### As part of the Sinch SDK
+
+If you are using this SDK as part of the Sinch SDK (`@sinch/sdk-core`) you can access it as the `voice` property of the client that you would have instantiated.
+
+```typescript
+import {
+  TtsCalloutRequestData,
+  GetCalloutResponseObj,
+  SinchClient,
+  SinchClientParameters,
+} from '@sinch/sdk-core';
+
+const credentials: SinchClientParameters = {
+  applicationKey: 'APPLICATION_ID',
+  applicationSecret: 'APPLICATION_SECRET',
+};
+const sinch = new SinchClient(credentials);
+
+const requestData: TtsCalloutRequestData = {
+  ttsCalloutRequestBody: {
+    method: 'ttsCallout',
+    ttsCallout: {
+      destination: {
+        type: 'number',
+        endpoint: '+14045005000',
+      },
+      cli: '+14045001000',
+      locale: 'en-US',
+      text: 'Hello, this is a call from Sinch.',
+    },
+  },
+};
+
+// Access the 'voice' domain registered on the Sinch Client
+const calloutResponse: GetCalloutResponseObj 
+    = await sinch.voice.callouts.tts(requestData);
+```
+
+### Standalone
+
+The SDK can be used standalone if you need to use only the Voice APIs.
+
+```typescript
+import {
+  SinchClientParameters
+ } from '@sinch/sdk-client';
+import {
+  TtsCalloutRequestData,
+  GetCalloutResponseObj,
+  Voice,
+} from '@sinch/voice';
+
+const credentials: SinchClientParameters = {
+  applicationKey: 'APPLICATION_ID',
+  applicationSecret: 'APPLICATION_SECRET',
+};
+
+// Declare the 'verification' in a standalone way
+const voice = new Voice(credentials);
+
+const requestData: TtsCalloutRequestData = {
+  ttsCalloutRequestBody: {
+    method: 'ttsCallout',
+    ttsCallout: {
+      destination: {
+        type: 'number',
+        endpoint: '+14045005000',
+      },
+      cli: '+14045001000',
+      locale: 'en-US',
+      text: 'Hello, this is a call from Sinch.',
+    },
+  },
+};
+
+// Use the standalone declaration of the 'verification' domain
+const calloutResponse: GetCalloutResponseObj
+  = await voice.callouts.tts(requestData);
+```
+
+## Promises
+
+All the methods that interact with the Sinch APIs use Promises. You can use `await` in an `async` method to wait for the response or you can resolve them yourself with `then()` / `catch()`.
+
+```typescript
+// Method 1: Wait for the Promise to complete
+let calloutResponse: GetCalloutResponseObj;
+try {
+  calloutResponse = await sinch.voice.callouts.tts(requestData);
+  console.log(`callId = ${response.callId}`);
+} catch (error: any) {
+  console.error(`ERROR ${error.statusCode}: Impossible to make a TTS callout to the number ${requestData.ttsCalloutRequestBody.ttsCallout.destination.endpoint}`);
+}
+
+// Method 2: Resolve the promise
+sinch.voice.callouts.tts(requestData)
+  .then(response => console.log(`callId = ${response.callId}`))
+  .catch(error => console.error(`ERROR ${error.statusCode}: Impossible to make a TTS call out to the number ${requestData.ttsCalloutRequestBody.ttsCallout.destination.endpoint}`));
+```
+
+## Contact
+Developer Experience team: [devexp@sinch.com](mailto:devexp@sinch.com)

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './models';
+export * from './rest';

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./models"), exports);
+__exportStar(require("./rest"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,yCAAuB"}

package/dist/models/index.d.ts

@@ -0,0 +1 @@
+export * from './v1';

package/dist/models/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./v1"), exports);
+//# sourceMappingURL=index.js.map

package/dist/models/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uCAAqB"}

package/dist/models/v1/ace-request/ace-request.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Model: AceRequest
+ *
+ * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
+ *
+ */
+import { AceRequestAmd } from '../ace-request-amd';
+/**
+ * The request body of an Answered Call Event.
+ */
+export interface AceRequest {
+    /** Must have the value `ace`. */
+    event?: 'ace';
+    /** The unique ID assigned to this call. */
+    callid?: string;
+    /** The timestamp in UTC format. */
+    timestamp?: Date;
+    /** The current API version. */
+    version?: number;
+    /** A string that can be used to pass custom information related to the call. */
+    custom?: string;
+    /** @see AceRequestAmd */
+    amd?: AceRequestAmd;
+    /** The unique application key. You can find it in the Sinch [dashboard](https://dashboard.sinch.com/voice/apps). */
+    applicationKey?: string;
+}

package/dist/models/v1/ace-request/ace-request.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * Model: AceRequest
+ *
+ * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ace-request.js.map

package/dist/models/v1/ace-request/ace-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ace-request.js","sourceRoot":"","sources":["../../../../src/models/v1/ace-request/ace-request.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}

package/dist/models/v1/ace-request/index.d.ts

@@ -0,0 +1 @@
+export type { AceRequest } from './ace-request';

package/dist/models/v1/ace-request/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v1/ace-request/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/ace-request/index.ts"],"names":[],"mappings":""}

package/dist/models/v1/ace-request-amd/ace-request-amd.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Model: AceRequestAmd
+ *
+ * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
+ *
+ */
+/**
+ * If [Answering Machine Detection](/docs/voice/api-reference/amd_v2) (AMD) is enabled, this object contains information about whether the call was answered by a machine.
+ */
+export interface AceRequestAmd {
+    /** The determination by the system of who answered the call. */
+    status?: string;
+    /** The reason that the system used to determine who answered the call. */
+    reason?: string;
+    /** The length of the call. */
+    duration?: number;
+}

package/dist/models/v1/ace-request-amd/ace-request-amd.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * Model: AceRequestAmd
+ *
+ * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ace-request-amd.js.map

package/dist/models/v1/ace-request-amd/ace-request-amd.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ace-request-amd.js","sourceRoot":"","sources":["../../../../src/models/v1/ace-request-amd/ace-request-amd.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}

package/dist/models/v1/ace-request-amd/index.d.ts

@@ -0,0 +1 @@
+export type { AceRequestAmd } from './ace-request-amd';

package/dist/models/v1/ace-request-amd/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v1/ace-request-amd/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/ace-request-amd/index.ts"],"names":[],"mappings":""}

package/dist/models/v1/ace-response/ace-response.d.ts

@@ -0,0 +1,16 @@
+import { SvamlActionHangup } from '../svaml-action-hangup';
+import { SvamlActionConnectConf } from '../svaml-action-connect-conf';
+import { SvamlActionRunMenu } from '../svaml-action-run-menu';
+import { SvamlActionContinue } from '../svaml-action-continue';
+import { SvamlInstructionPlayFiles } from '../svaml-instruction-play-files';
+import { SvamlInstructionSay } from '../svaml-instruction-say';
+import { SvamlInstructionSetCookie } from '../svaml-instruction-set-cookie';
+import { SvamlInstructionStartRecording } from '../svaml-instruction-start-recording';
+export type AceSvamlAction = SvamlActionHangup | SvamlActionContinue | SvamlActionConnectConf | SvamlActionRunMenu;
+export type AceSvamlInstruction = SvamlInstructionPlayFiles | SvamlInstructionSay | SvamlInstructionSetCookie | SvamlInstructionStartRecording;
+export interface AceResponse {
+    /** The collection of instructions that can perform various tasks during the call. You can include as many instructions as necessary. */
+    instructions?: AceSvamlInstruction[];
+    /** @see SvamlAction */
+    action?: AceSvamlAction;
+}

package/dist/models/v1/ace-response/ace-response.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ace-response.js.map

package/dist/models/v1/ace-response/ace-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ace-response.js","sourceRoot":"","sources":["../../../../src/models/v1/ace-response/ace-response.ts"],"names":[],"mappings":""}

package/dist/models/v1/ace-response/index.d.ts

@@ -0,0 +1 @@
+export type { AceResponse, AceSvamlAction } from './ace-response';

package/dist/models/v1/ace-response/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v1/ace-response/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/ace-response/index.ts"],"names":[],"mappings":""}

package/dist/models/v1/assign-numbers/assign-numbers.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Model: AssignNumbers
+ *
+ * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
+ *
+ */
+export interface AssignNumbers {
+    /** The phone number or list of numbers in E.164 format. */
+    numbers?: string[];
+    /** indicates the application where the number(s) will be assigned. If empty, the application key that is used to sign the request will be used. */
+    applicationkey?: string;
+    /** indicates the DID capability that needs to be assigned to the chosen application. Valid values are 'voice' and 'sms'. Please note that the DID needs to support the selected capability. */
+    capability?: CapabilityEnum;
+}
+export type CapabilityEnum = 'voice' | 'sms';

package/dist/models/v1/assign-numbers/assign-numbers.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * Model: AssignNumbers
+ *
+ * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=assign-numbers.js.map

package/dist/models/v1/assign-numbers/assign-numbers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assign-numbers.js","sourceRoot":"","sources":["../../../../src/models/v1/assign-numbers/assign-numbers.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}

package/dist/models/v1/assign-numbers/index.d.ts

@@ -0,0 +1 @@
+export type { AssignNumbers } from './assign-numbers';

package/dist/models/v1/assign-numbers/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v1/assign-numbers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/assign-numbers/index.ts"],"names":[],"mappings":""}

package/dist/models/v1/call-header/call-header.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Model: CallHeader
+ *
+ * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
+ *
+ */
+/**
+ * Call Headers can be used to pass custom data from a Sinch SDK client to another, or specified in an ICE response to be made available to the receiving client. Further, if Call Headers is specified they will be available in ICE and DICE events.
+ */
+export interface CallHeader {
+    /** The call header key of the key value pair. */
+    key?: string;
+    /** The call header value of the key value pair. */
+    value?: string;
+}

package/dist/models/v1/call-header/call-header.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * Model: CallHeader
+ *
+ * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=call-header.js.map

package/dist/models/v1/call-header/call-header.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"call-header.js","sourceRoot":"","sources":["../../../../src/models/v1/call-header/call-header.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}

package/dist/models/v1/call-header/index.d.ts

@@ -0,0 +1 @@
+export type { CallHeader } from './call-header';

package/dist/models/v1/call-header/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v1/call-header/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/call-header/index.ts"],"names":[],"mappings":""}

package/dist/models/v1/callout-request/callout-request.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Model: CalloutRequest
+ *
+ * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
+ *
+ */
+import { ConferenceCalloutRequest } from '../conference-callout-request';
+import { CustomCalloutRequest } from '../custom-callout-request';
+import { TtsCalloutRequest } from '../tts-callout-request';
+/**
+ * Currently three types of callouts are supported: conference callouts, text-to-speech callouts and custom callouts. The custom callout is the most flexible, but text-to-speech and conference callouts are more convenient.
+ */
+export interface CalloutRequest {
+    /** Sets the type of callout. */
+    method: MethodEnum;
+    /** @see ConferenceCalloutRequest */
+    conferenceCallout?: ConferenceCalloutRequest;
+    /** @see TtsCalloutRequest */
+    ttsCallout?: TtsCalloutRequest;
+    /** @see CustomCalloutRequest */
+    customCallout?: CustomCalloutRequest;
+}
+export type MethodEnum = 'conferenceCallout' | 'ttsCallout' | 'customCallout';

package/dist/models/v1/callout-request/callout-request.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * Model: CalloutRequest
+ *
+ * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=callout-request.js.map

package/dist/models/v1/callout-request/callout-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"callout-request.js","sourceRoot":"","sources":["../../../../src/models/v1/callout-request/callout-request.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}

package/dist/models/v1/callout-request/index.d.ts

@@ -0,0 +1 @@
+export type { CalloutRequest } from './callout-request';

package/dist/models/v1/callout-request/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v1/callout-request/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/callout-request/index.ts"],"names":[],"mappings":""}

package/dist/models/v1/conference-callout-request/conference-callout-request.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Model: ConferenceCalloutRequest
+ *
+ * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
+ *
+ */
+import { ConferenceCalloutRequestConferenceDtmfOptions } from '../conference-callout-request-conference-dtmf-options';
+import { Destination } from '../destination';
+/**
+ * The conference callout calls a phone number or a user. When the call is answered, it's connected to a conference room.
+ */
+export interface ConferenceCalloutRequest {
+    /** The number that will be displayed as the incoming caller. To set your own CLI, you may use your verified number or your Dashboard number. The number must be in [E.164](https://community.sinch.com/t5/Glossary/E-164/ta-p/7537) format. */
+    cli?: string;
+    /** @see Destination */
+    destination: Destination;
+    /** The conferenceId of the conference to which you want the callee to join. If the conferenceId doesn't exist a conference room will be created. */
+    conferenceId: string;
+    /** @see ConferenceCalloutRequestConferenceDtmfOptions */
+    conferenceDtmfOptions?: ConferenceCalloutRequestConferenceDtmfOptions;
+    /** When the destination picks up, this DTMF tones will be played to the callee. Valid characters in the string are "0"-"9", "#" and "w". A "w" will render a 500 ms pause. Example: "ww1234#w#" will render a 1s pause, the DTMF tones "1", "2", "3", "4" and "#" followed by a 0.5s pause and finally the DTMF tone for "#". This can be used if the callout destination for instance require a conference PIN code or an extension to be entered. */
+    dtmf?: string;
+    maxDuration?: number;
+    /** If `enableAce` is set to true and the application has a callback URL specified, you will receive an ACE callback when the call is answered. When the callback is received, your platform must respond with a svamlet containing the `connectConf` action in order to add the call to a conference or create the conference if it's the first call. If it's set to false, no ACE event will be sent to your backend.<br><b>Note </b> if the call is towards an InApp destination `type:` `username`, then no ACE will be issued when the call is connected, even if `enableAce` is present in the callout request. */
+    enableAce?: boolean;
+    /** If `enableDice` is set to true and the application has a callback URL specified, you will receive a DiCE callback when the call is disconnected. If it's set to false, no DiCE event will be sent to your backend.<br><b>Note</b> if the call is towards an InApp destination `type:` `username`, then no DICE will be issued at the end of the call, even if `enableDice` is present in the callout request. */
+    enableDice?: boolean;
+    /** If `enablePie` is set to true and the application has a callback URL specified, you will receive a PIE callback after a `runMenu` action, with the information of the action that the user took. If it's set to false, no PIE event will be sent to your backend. */
+    enablePie?: boolean;
+    /** The voice and language you want to use for the prompts. This can either be defined by the ISO 639 locale and language code or by specifying a particular voice. Supported languages and voices are detailed [here](../../../voice-locales/) */
+    locale?: string;
+    /** The text that will be spoken as a greeting. */
+    greeting?: string;
+    /** Means "music-on-hold." It's an optional parameter that specifies what the first participant should listen to while they're alone in the conference, waiting for other participants to join. It can take one of these pre-defined values:<ul><li>`ring` (progress tone)</li><li>`music1` (music file)</li><li>`music2` (music file)</li><li>`music3` (music file)</li></ul></br>If no “music-on-hold” is specified, the user will only hear silence. */
+    mohClass?: string;
+    /** Used to input custom data. */
+    custom?: string;
+    /** can be either “pstn” for PSTN endpoint or “mxp” for data (app or web) clients. */
+    domain?: string;
+}

package/dist/models/v1/conference-callout-request/conference-callout-request.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * Model: ConferenceCalloutRequest
+ *
+ * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=conference-callout-request.js.map

package/dist/models/v1/conference-callout-request/conference-callout-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"conference-callout-request.js","sourceRoot":"","sources":["../../../../src/models/v1/conference-callout-request/conference-callout-request.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}

package/dist/models/v1/conference-callout-request/index.d.ts

@@ -0,0 +1 @@
+export type { ConferenceCalloutRequest } from './conference-callout-request';

package/dist/models/v1/conference-callout-request/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v1/conference-callout-request/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/conference-callout-request/index.ts"],"names":[],"mappings":""}

package/dist/models/v1/conference-callout-request-conference-dtmf-options/conference-callout-request-conference-dtmf-options.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Model: ConferenceCalloutRequestConferenceDtmfOptions
+ *
+ * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
+ *
+ */
+/**
+ * Options to control how DTMF signals are used by the participant in the conference. For information on how to use this feature, read more [here](../../../conference-dtmf).
+ */
+export interface ConferenceCalloutRequestConferenceDtmfOptions {
+    /** Determines what DTMF mode the participant will use in the call. */
+    mode?: string;
+    /** The maximum number of accepted digits before sending the collected input via a PIE callback. The default value is `1`. If the value is greater than `1`, the PIE callback is triggered by one of the three following events:   - No additional digit is entered before the `timeoutMills` timeout period has elapsed.   - The `#` character is entered.   - The maximum number of digits has been entered. */
+    maxDigits?: number;
+    /** The number of milliseconds that the system will wait between entered digits before triggering the PIE callback. The default value is `3000`. */
+    timeoutMills?: number;
+}

package/dist/models/v1/conference-callout-request-conference-dtmf-options/conference-callout-request-conference-dtmf-options.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * Model: ConferenceCalloutRequestConferenceDtmfOptions
+ *
+ * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=conference-callout-request-conference-dtmf-options.js.map

package/dist/models/v1/conference-callout-request-conference-dtmf-options/conference-callout-request-conference-dtmf-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"conference-callout-request-conference-dtmf-options.js","sourceRoot":"","sources":["../../../../src/models/v1/conference-callout-request-conference-dtmf-options/conference-callout-request-conference-dtmf-options.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}

package/dist/models/v1/conference-callout-request-conference-dtmf-options/index.d.ts

@@ -0,0 +1 @@
+export type { ConferenceCalloutRequestConferenceDtmfOptions, } from './conference-callout-request-conference-dtmf-options';

package/dist/models/v1/conference-callout-request-conference-dtmf-options/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v1/conference-callout-request-conference-dtmf-options/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/conference-callout-request-conference-dtmf-options/index.ts"],"names":[],"mappings":""}

package/dist/models/v1/custom-callout-request/custom-callout-request.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Model: CustomCalloutRequest
+ *
+ * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
+ *
+ */
+import { Destination } from '../destination';
+/**
+ * The custom callout, the server initiates a call from the servers that can be controlled by specifying how the call should progress at each call event.
+ */
+export interface CustomCalloutRequest {
+    /** The number that will be displayed as the incoming caller, to set your own CLI, you may use your verified number or your Dashboard virtual number, it must be in [E.164](https://community.sinch.com/t5/Glossary/E-164/ta-p/7537) format. */
+    cli?: string;
+    /** @see Destination */
+    destination?: Destination;
+    /** When the destination picks up, this DTMF tones will be played to the callee. Valid characters in the string are "0"-"9", "#", and "w". A "w" will render a 500 ms pause. For example, "ww1234#w#" will render a 1s pause, the DTMF tones "1", "2", "3", "4" and "#" followed by a 0.5s pause and finally the DTMF tone for "#". This can be used if the callout destination for instance require a conference PIN code or an extension to be entered. */
+    dtmf?: string;
+    /** Can be used to input custom data. */
+    custom?: string;
+    /** The maximum amount of time in seconds that the call will last. */
+    maxDuration?: number;
+    /** You can use inline SVAML to replace a callback URL when using custom callouts. Ensure that the JSON object is escaped correctly. If inline ICE SVAML is passed, exclude *cli* and *destination* properties from the *customCallout* request body.  Example: ```"{"action":{"name":"connectPstn","number":"46000000001","maxDuration":90}}"```  */
+    ice?: string;
+    /** You can use inline SVAML to replace a callback URL when using custom callouts. Ensure that the JSON object is escaped correctly.  Example: ```"{"action": {"name": "RunMenu","locale": "en-US","menus": [{"id": "main","mainPrompt": "#tts[ Welcome to the main menu. Press 1 for a callback or 2 for a cancel</speak>]","timeoutMills": 5000,"options": [ {"dtmf": "1","action": "return(callback)"}, {"dtmf": "2","action": "return(cancel)"}]}]}}"```  */
+    ace?: string;
+    /** <b>Note:</b> PIE callbacks are not available for DATA Calls; only PSTN and SIP calls.  You can use inline SVAML to replace a callback URL when using custom callouts. Ensure that the JSON object is escaped correctly. A PIE event will contain a value chosen from an IVR choice. Usually a PIE event wil contain a URL to a callback sever that will receive the choice and be able to parse it. This could result in further SVAML or some other application logic function.  Example: ```"https://your-application-server-host/application"```  */
+    pie?: string;
+}

package/dist/models/v1/custom-callout-request/custom-callout-request.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * Model: CustomCalloutRequest
+ *
+ * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=custom-callout-request.js.map

package/dist/models/v1/custom-callout-request/custom-callout-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-callout-request.js","sourceRoot":"","sources":["../../../../src/models/v1/custom-callout-request/custom-callout-request.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}