@sinch/voice 0.0.1 → 0.0.3

package/README.md

@@ -2,15 +2,15 @@
 
 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.**
+> <span style="color:red; font-weight:bold">Warning:</span>
+> **This SDK is currently available to selected developers for preview use only. It is being provided for the purpose of collecting feedback, and 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.
+We recommend to use this SDK as part of the [`@sinch/sdk-core`](../../packages/sdk-core) package in order to make the most out of all the Sinch products.
 
-However, it's still possible to use this SDK standalone is you need to access the Verification API only.
+However, it's still possible to use this SDK standalone is you need to access the Voice API only.
 
 ### With NPM
 
@@ -41,15 +41,20 @@ import {
   TtsCalloutRequestData,
   GetCalloutResponseObj,
   SinchClient,
-  SinchClientParameters,
+  ApplicationCredentials, 
+  VoiceService,
 } from '@sinch/sdk-core';
 
-const credentials: SinchClientParameters = {
+const credentials: ApplicationCredentials = {
   applicationKey: 'APPLICATION_ID',
   applicationSecret: 'APPLICATION_SECRET',
 };
+
+// Access the 'voice' service registered on the Sinch Client
 const sinch = new SinchClient(credentials);
+const voiceService: VoiceService = sinch.voice;
 
+// Build the request data
 const requestData: TtsCalloutRequestData = {
   ttsCalloutRequestBody: {
     method: 'ttsCallout',
@@ -65,9 +70,9 @@ const requestData: TtsCalloutRequestData = {
   },
 };
 
-// Access the 'voice' domain registered on the Sinch Client
-const calloutResponse: GetCalloutResponseObj 
-    = await sinch.voice.callouts.tts(requestData);
+// Use the 'voice' service registered on the Sinch client
+const calloutResponse: GetCalloutResponseObj
+  = await voiceService.callouts.tts(requestData);
 ```
 
 ### Standalone
@@ -76,22 +81,23 @@ The SDK can be used standalone if you need to use only the Voice APIs.
 
 ```typescript
 import {
-  SinchClientParameters
+  ApplicationCredentials
  } from '@sinch/sdk-client';
 import {
   TtsCalloutRequestData,
   GetCalloutResponseObj,
-  Voice,
+  VoiceService,
 } from '@sinch/voice';
 
-const credentials: SinchClientParameters = {
+const credentials: ApplicationCredentials = {
   applicationKey: 'APPLICATION_ID',
   applicationSecret: 'APPLICATION_SECRET',
 };
 
-// Declare the 'verification' in a standalone way
-const voice = new Voice(credentials);
+// Declare the 'voice' service in a standalone way
+const voiceService = new VoiceService(credentials);
 
+// Build the request data
 const requestData: TtsCalloutRequestData = {
   ttsCalloutRequestBody: {
     method: 'ttsCallout',
@@ -107,27 +113,27 @@ const requestData: TtsCalloutRequestData = {
   },
 };
 
-// Use the standalone declaration of the 'verification' domain
+// Use the standalone declaration of the 'voice' service
 const calloutResponse: GetCalloutResponseObj
-  = await voice.callouts.tts(requestData);
+  = await voiceService.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()`.
+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
+// Method 1: Wait for the Promise to complete (you need to be in an 'async' method)
 let calloutResponse: GetCalloutResponseObj;
 try {
-  calloutResponse = await sinch.voice.callouts.tts(requestData);
-  console.log(`callId = ${response.callId}`);
+  calloutResponse = await voiceService.callouts.tts(requestData);
+  console.log(`callId = ${calloutResponse.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)
+voiceService.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}`));
 ```

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

@@ -1,15 +1,8 @@
-/**
- * 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;
+    capability?: 'voice' | 'sms';
 }
-export type CapabilityEnum = 'voice' | 'sms';

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

@@ -1,9 +1,3 @@
 "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

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

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

@@ -1,9 +1,3 @@
-/**
- * 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.
  */

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

@@ -1,9 +1,3 @@
 "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

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

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

@@ -0,0 +1,7 @@
+/**
+ * The returned call ID.
+ */
+export interface CalloutResponse {
+    /** The returned call identifier. */
+    callId?: string;
+}

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

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

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

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

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

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

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

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

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

@@ -1,11 +1,5 @@
-/**
- * Model: ConferenceCalloutRequest
- *
- * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
- *
- */
-import { ConferenceCalloutRequestConferenceDtmfOptions } from '../conference-callout-request-conference-dtmf-options';
 import { Destination } from '../destination';
+import { ConferenceDtmfOptions } from '../conference-dtmf-options';
 /**
  * The conference callout calls a phone number or a user. When the call is answered, it's connected to a conference room.
  */
@@ -16,8 +10,8 @@ export interface ConferenceCalloutRequest {
     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;
+    /** 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). */
+    conferenceDtmfOptions?: ConferenceDtmfOptions;
     /** 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;

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

@@ -1,9 +1,3 @@
 "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

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

package/dist/models/v1/{svaml-action-connect-conf-conference-dtmf-options/svaml-action-connect-conf-conference-dtmf-options.d.ts → conference-dtmf-options/conference-dtmf-options.d.ts}

@@ -1,15 +1,9 @@
-/**
- * Model: SvamlActionConnectConfConferenceDtmfOptions
- *
- * 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 SvamlActionConnectConfConferenceDtmfOptions {
+export interface ConferenceDtmfOptions {
     /** Determines what DTMF mode the participant will use in the call. */
-    mode?: string;
+    mode?: 'ignore' | 'forward' | 'detect';
     /** 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`. */

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

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

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

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

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

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

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

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

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

@@ -1,9 +1,3 @@
-/**
- * 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.

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

@@ -1,9 +1,3 @@
 "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

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

package/dist/models/v1/destination/destination.d.ts

@@ -1,16 +1,9 @@
-/**
- * Model: Destination
- *
- * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
- *
- */
 /**
  * The type of device and number or endpoint to call.
  */
 export interface Destination {
     /** Can be of type `number` for PSTN endpoints or of type `username` for data endpoints. */
-    type: TypeEnum;
+    type: 'number' | 'username';
     /** If the type is `number` the value of the endpoint is a phone number. If the type is `username` the value is the username for a data endpoint. */
     endpoint: string;
 }
-export type TypeEnum = 'number' | 'username';

package/dist/models/v1/destination/destination.js

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

package/dist/models/v1/destination/destination.js.map

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

package/dist/models/v1/enums.d.ts

@@ -1,11 +1,4 @@
-export type { MethodEnum as CalloutRequestMethodEnum, } from './callout-request/callout-request';
-export type { TypeEnum as DestinationTypeEnum, } from './destination/destination';
-export type { DomainEnum as GetCallResponseObjDomainEnum, StatusEnum as GetCallResponseObjStatusEnum, } from './get-call-response-obj/get-call-response-obj';
-export type { CapabilityEnum as GetNumbersResponseObjNumbersInnerCapabilityEnum, } from './get-numbers-response-obj-numbers-inner/get-numbers-response-obj-numbers-inner';
-export type { NumberTypeEnum as GetQueryNumberNumberItemNumberTypeEnum, } from './get-query-number-number-item/get-query-number-number-item';
-export type { DomainEnum as TtsCalloutRequestDomainEnum, } from './tts-callout-request/tts-callout-request';
-export type { CapabilityEnum as UnassignNumbersCapabilityEnum, } from './unassign-numbers/unassign-numbers';
-export type { CapabilityEnum as UpdateNumbersCapabilityEnum, } from './assign-numbers/assign-numbers';
-export type { CommandEnum as ManageConferenceParticipantRequestCommandEnum, MohEnum as ManageConferenceParticipantRequestMohEnum, } from './manage-conference-participant-request/manage-conference-participant-request';
 export type ResultEnum = 'N/A' | 'ANSWERED' | 'BUSY' | 'NOANSWER' | 'FAILED';
-export type ReasonEnum = 'N/A' | 'TIMEOUT' | 'CALLERHANGUP' | 'CALLEEHANGUP' | 'BLOCKED' | 'NOCREDITPARTNER' | 'MANAGERHANGUP' | 'CANCEL' | 'GENERALERROR';
+export type ReasonEnum = 'N/A' | 'TIMEOUT' | 'CALLERHANGUP' | 'CALLEEHANGUP' | 'BLOCKED' | 'NOCREDITPARTNER' | 'MANAGERHANGUP' | 'CANCEL' | 'GENERALERROR' | 'INVALIDSVAMLACTION';
+export type TtsVoice = 'arb' | 'arb/female' | 'Zeina' | 'az-AZ' | 'az-AZ/female' | 'az-AZ/male' | 'Banu' | 'Babek' | 'ca-ES' | 'ca-ES/female' | 'Arlet' | 'zh-HK' | 'zh-HK/female' | 'zh-HK/male' | 'HiuGaai' | 'HiuMaan' | 'WanLung' | 'cmn-CN' | 'cmn-CN/female' | 'Zhiyu' | 'hr-HR' | 'hr-HR/female' | 'hr-HR/male' | 'Gabrijela' | 'Srecko' | 'cs-CZ' | 'cs-CZ/female' | 'cs-CZ/male' | 'Vlasta' | 'Antonin' | 'da-DK' | 'da-DK/female' | 'da-DK/male' | 'Naja' | 'Mads' | 'nl-NL' | 'nl-NL/female' | 'nl-NL/male' | 'Lotte' | 'Ruben' | 'en-AU' | 'en-AU/female' | 'en-AU/male' | 'Nicole' | 'Olivia' | 'Russell' | 'en-GB' | 'en-GB/female' | 'en-GB/male' | 'Amy' | 'Emma' | 'Brian' | 'Arthur' | 'en-IN' | 'en-IN/female' | 'Aditi' | 'Raveena' | 'Kajal' | 'en-NZ' | 'en-NZ/female' | 'Aria' | 'en-ZA' | 'en-ZA/female' | 'Ayanda' | 'en-US' | 'en-US/female' | 'en-US/male' | 'Ivy' | 'Joanna' | 'Kendra' | 'Kimberly' | 'Salli' | 'Joey' | 'Justin' | 'Kevin' | 'Matthew' | 'en-GB-WLS' | 'en-GB-WLS/male' | 'Geraint' | 'et-EE' | 'et-EE/female' | 'et-EE/male' | 'Anu' | 'Kert' | 'fil-PH' | 'fil-PH/female' | 'fil-PH/male' | 'Angelo' | 'Blessica' | 'fi-FI' | 'fi-FI/female' | 'Suvi' | 'fr-FR' | 'fr-FR/female' | 'fr-FR/male' | 'Céline' | 'Celine' | 'Léa' | 'Mathieu' | 'fr-CA' | 'fr-CA/female' | 'fr-CA/male' | 'Chantal' | 'Gabrielle' | 'Liam' | 'ka-GE' | 'ka-GE/female' | 'ka-GE/male' | 'Eka' | 'Giorgi' | 'de-DE' | 'de-DE/female' | 'de-DE/male' | 'Marlene' | 'Vicki' | 'Hans' | 'Daniel' | 'de-AT' | 'de-AT/female' | 'Hannah' | 'el-GR' | 'el-GR/female' | 'el-GR/male' | 'Athina' | 'Nestoras' | 'hi-IN' | 'hi-IN/female' | 'Aditi' | 'Kajal' | 'hu-HU' | 'hu-HU/female' | 'hu-HU/male' | 'Noemi' | 'Tamas' | 'is-IS' | 'is-IS/female' | 'is-IS/male' | 'Dóra' | 'Dora' | 'Karl' | 'id-ID' | 'id-ID/female' | 'id-ID/male' | 'Ardi' | 'Gadis' | 'it-IT' | 'it-IT/female' | 'it-IT/male' | 'Carla' | 'Bianca' | 'Giorgio' | 'ja-JP' | 'ja-JP/female' | 'ja-JP/male' | 'Mizuki' | 'Takumi' | 'ko-KR' | 'ko-KR/female' | 'Seoyeon' | 'mt-MT' | 'mt-MT/female' | 'mt-MT/male' | 'Grace' | 'Joseph' | 'ms-MY' | 'ms-MY/female' | 'ms-MY/male' | 'Osman' | 'Yasmin' | 'nb-NO' | 'nb-NO/female' | 'Liv' | 'lv-LV' | 'lv-LV/female' | 'lv-LV/male' | 'Everita' | 'Nils' | 'lt-LT' | 'lt-LT/female' | 'lt-LT/male' | 'Ona' | 'Leonas' | 'pl-PL' | 'pl-PL/female' | 'pl-PL/male' | 'Ewa' | 'Maja' | 'Jacek' | 'Jan' | 'pt-BR' | 'pt-BR/female' | 'pt-BR/male' | 'Camila' | 'Vitória' | 'Vitoria' | 'Ricardo' | 'pt-PT' | 'pt-PT/female' | 'pt-PT/male' | 'Inês' | 'Ines' | 'Cristiano' | 'ro-RO' | 'ro-RO/female' | 'Carmen' | 'ru-RU' | 'ru-RU/female' | 'ru-RU/male' | 'Tatyana' | 'Maxim' | 'es-ES' | 'es-ES/female' | 'es-ES/male' | 'Conchita' | 'Lucia' | 'Enrique' | 'es-MX' | 'es-MX/female' | 'Mia' | 'es-US' | 'es-US/female' | 'es-US/male' | 'Lupe' | 'Penélope' | 'Penelope' | 'Miguel' | 'Pedro' | 'sk-SK' | 'sk-SK/female' | 'sk-SK/male' | 'Viktoria' | 'Lukas' | 'sl-SI' | 'sl-SI/female' | 'sl-SI/male' | 'Petra' | 'Rok' | 'sv-SE' | 'sv-SE/female' | 'Astrid' | 'th-TH' | 'th-TH/female' | 'th-TH/male' | 'Achara' | 'Niwat' | 'Premwadee' | 'tr-TR' | 'tr-TR/male' | 'Filiz' | 'uk-UA' | 'uk-UA/female' | 'uk-UA/male' | 'Polina' | 'Ostap' | 'uz-UZ' | 'uz-UZ/female' | 'uz-UZ/male' | 'Madina' | 'Sardor' | 'vi-VN' | 'vi-VN/female' | 'vi-VN/male' | 'HoaiMy' | 'NamMinh' | 'cy-GB' | 'cy-GB/female' | 'Gwyneth';
+export type MusicOnHold = 'ring' | 'music1' | 'music2' | 'music3';

package/dist/models/v1/get-call-information/get-call-information.d.ts

@@ -0,0 +1,29 @@
+import { ReasonEnum, ResultEnum } from '../enums';
+import { VoicePrice } from '../voice-price';
+import { Participant } from '../participant';
+export interface GetCallInformation {
+    /** Contains the caller information. */
+    from?: Participant;
+    /** Contains the callee information. */
+    to?: Participant;
+    /** Must be `pstn` for PSTN. */
+    domain?: 'pstn';
+    /** The unique identifier of the call. */
+    callId?: string;
+    /** The duration of the call in seconds. */
+    duration?: number;
+    /** The status of the call. Either `ONGOING` or `FINAL` */
+    status?: 'ONGOING' | 'FINAL';
+    /** Contains the result of a call. */
+    result?: ResultEnum;
+    /** Contains the reason why a call ended. */
+    reason?: ReasonEnum;
+    /** The date and time of the call. */
+    timestamp?: Date;
+    /** An object that can be used to pass custom information related to the call. */
+    custom?: string;
+    /** The rate per minute that was charged for the call. */
+    userRate?: VoicePrice;
+    /** The total amount charged for the call. */
+    debit?: VoicePrice;
+}

package/dist/models/v1/get-call-information/get-call-information.js

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

package/dist/models/v1/get-call-information/get-call-information.js.map

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

package/dist/models/v1/get-call-information/index.d.ts

@@ -0,0 +1 @@
+export type { GetCallInformation } from './get-call-information';

package/dist/models/v1/get-call-information/index.js.map

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

package/dist/models/v1/get-callbacks/get-callbacks.d.ts

@@ -1,11 +1,10 @@
-/**
- * Model: GetCallbacks
- *
- * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
- *
- */
-import { GetCallbacksUrl } from '../get-callbacks-url';
 export interface GetCallbacks {
-    /** @see GetCallbacksUrl */
+    /** Gets primary and if configured fallback callback URLs */
     url?: GetCallbacksUrl;
 }
+export interface GetCallbacksUrl {
+    /** Your primary callback URL */
+    primary?: string;
+    /** Your fallback callback URL (returned if configured). It is used only if Sinch platform gets a timeout or error from your primary callback URL. */
+    fallback?: string;
+}

package/dist/models/v1/get-callbacks/get-callbacks.js

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

package/dist/models/v1/get-callbacks/get-callbacks.js.map

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

package/dist/models/v1/get-callbacks/index.d.ts

@@ -1 +1 @@
-export type { GetCallbacks } from './get-callbacks';
+export type { GetCallbacks, GetCallbacksUrl } from './get-callbacks';

package/dist/models/v1/get-conference-info-response/get-conference-info-response.d.ts

@@ -1,14 +1,17 @@
-/**
- * Model: GetConferenceInfoResponse
- *
- * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
- *
- */
-import { GetConferenceInfoResponseParticipantsInner } from '../get-conference-info-response-participants-inner';
 /**
  * The response returns information about the participants in the conference.
  */
 export interface GetConferenceInfoResponse {
     /** List of GetConferenceInfoResponseParticipantsInners */
-    participants?: GetConferenceInfoResponseParticipantsInner[];
+    participants?: ParticipantDetails[];
+}
+export interface ParticipantDetails {
+    /** The phone number of the PSTN participant that was connected in the conference, or whatever was passed as CLI for data originated/terminated calls. */
+    cli?: string;
+    /** The callId of the call leg that the participant joined the conference. */
+    id?: string;
+    /** The number of seconds that the participant has been connected to the conference. */
+    duration?: number;
+    muted?: boolean;
+    onhold?: boolean;
 }

package/dist/models/v1/get-conference-info-response/get-conference-info-response.js

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

package/dist/models/v1/get-conference-info-response/get-conference-info-response.js.map

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

package/dist/models/v1/get-conference-info-response/index.d.ts

@@ -1 +1 @@
-export type { GetConferenceInfoResponse } from './get-conference-info-response';
+export type { GetConferenceInfoResponse, ParticipantDetails } from './get-conference-info-response';

package/dist/models/v1/helper.d.ts

@@ -0,0 +1,85 @@
+import { ConnectConfProps, ConnectMxpProps, ConnectPstnProps, ConnectSipProps, ParkProps, RunMenuProps, StartRecordingOptions, SvamlActionConnectConf, SvamlActionConnectMxp, SvamlActionConnectPstn, SvamlActionConnectSip, SvamlActionContinue, SvamlActionHangup, SvamlActionPark, SvamlActionRunMenu, SvamlInstructionAnswer, SvamlInstructionPlayFiles, SvamlInstructionSay, SvamlInstructionSendDtmf, SvamlInstructionSetCookie, SvamlInstructionStartRecording, SvamlInstructionStopRecording } from './mod-svaml';
+import { AceResponse, AceSvamlAction, AceSvamlInstruction, CallbackResponse, IceResponse, IceSvamlAction, IceSvamlInstruction, PieResponse, PieSvamlAction, PieSvamlInstruction } from './mod-callbacks';
+import { TtsVoice } from './enums';
+declare class SvamletBuilder<A, I, R extends CallbackResponse<A, I>> {
+    protected action: A | undefined;
+    protected instructions: I[] | undefined;
+    setAction: (action: A) => this;
+    addInstruction: (instruction: I) => this;
+    build: () => R;
+}
+export declare class AceSvamletBuilder extends SvamletBuilder<AceSvamlAction, AceSvamlInstruction, AceResponse> {
+}
+export declare class IceSvamletBuilder extends SvamletBuilder<IceSvamlAction, IceSvamlInstruction, IceResponse> {
+}
+export declare class PieSvamletBuilder extends SvamletBuilder<PieSvamlAction, PieSvamlInstruction, PieResponse> {
+}
+export declare const customCalloutHelper: {
+    formatIceResponse: (action?: IceSvamlAction, ...instructions: IceSvamlInstruction[]) => string;
+    formatAceResponse: (action?: AceSvamlAction, ...instructions: AceSvamlInstruction[]) => string;
+    formatPieResponse: (action?: PieSvamlAction, ...instructions: PieSvamlInstruction[]) => string;
+};
+export declare const svamlActionHelper: {
+    buildConnectConf: (connectConfProps: ConnectConfProps) => SvamlActionConnectConf;
+    buildConnectMxp: (connectMxpProps: ConnectMxpProps) => SvamlActionConnectMxp;
+    buildConnectPstn: (connectPstnProps: ConnectPstnProps) => SvamlActionConnectPstn;
+    buildConnectSip: (connectSipProps: ConnectSipProps) => SvamlActionConnectSip;
+    buildContinue: () => SvamlActionContinue;
+    buildHangup: () => SvamlActionHangup;
+    buildPark: (parkProps: ParkProps) => SvamlActionPark;
+    buildRunMenu: (runMenuProps: RunMenuProps) => SvamlActionRunMenu;
+};
+export declare const svamlInstructionHelper: {
+    buildAnswer: () => SvamlInstructionAnswer;
+    buildPlayFiles: (ids: string[], locale?: TtsVoice) => SvamlInstructionPlayFiles;
+    buildSay: (text: string, locale?: TtsVoice) => SvamlInstructionSay;
+    buildSendDtmf: (dtmfValue: string) => SvamlInstructionSendDtmf;
+    buildSetCookie: (name: string, value: string) => SvamlInstructionSetCookie;
+    buildStartRecording: (startRecordingOptions: StartRecordingOptions) => SvamlInstructionStartRecording;
+    buildStopRecording: () => SvamlInstructionStopRecording;
+};
+export declare const aceActionHelper: {
+    hangup: () => SvamlActionHangup;
+    continue: () => SvamlActionContinue;
+    connectConf: (connectConfProps: ConnectConfProps) => SvamlActionConnectConf;
+    runMenu: (runMenuProps: RunMenuProps) => SvamlActionRunMenu;
+};
+export declare const aceInstructionHelper: {
+    playFiles: (ids: string[], locale?: TtsVoice) => SvamlInstructionPlayFiles;
+    say: (text: string, locale?: TtsVoice) => SvamlInstructionSay;
+    setCookie: (name: string, value: string) => SvamlInstructionSetCookie;
+    startRecording: (startRecordingOptions: StartRecordingOptions) => SvamlInstructionStartRecording;
+};
+export declare const iceActionHelper: {
+    hangup: () => SvamlActionHangup;
+    connectPstn: (connectPstnProps: ConnectPstnProps) => SvamlActionConnectPstn;
+    connectMxp: (connectMxpProps: ConnectMxpProps) => SvamlActionConnectMxp;
+    connectConf: (connectConfProps: ConnectConfProps) => SvamlActionConnectConf;
+    connectSip: (connectSipProps: ConnectSipProps) => SvamlActionConnectSip;
+    runMenu: (runMenuProps: RunMenuProps) => SvamlActionRunMenu;
+    park: (parkProps: ParkProps) => SvamlActionPark;
+};
+export declare const iceInstructionHelper: {
+    playFiles: (ids: string[], locale?: TtsVoice) => SvamlInstructionPlayFiles;
+    say: (text: string, locale?: TtsVoice) => SvamlInstructionSay;
+    sendDtmf: (dtmfValue: string) => SvamlInstructionSendDtmf;
+    setCookie: (name: string, value: string) => SvamlInstructionSetCookie;
+    startRecording: (startRecordingOptions: StartRecordingOptions) => SvamlInstructionStartRecording;
+    answer: () => SvamlInstructionAnswer;
+};
+export declare const pieActionHelper: {
+    hangup: () => SvamlActionHangup;
+    continue: () => SvamlActionContinue;
+    connectConf: (connectConfProps: ConnectConfProps) => SvamlActionConnectConf;
+    connectSip: (connectSipProps: ConnectSipProps) => SvamlActionConnectSip;
+    runMenu: (runMenuProps: RunMenuProps) => SvamlActionRunMenu;
+};
+export declare const pieInstructionHelper: {
+    playFiles: (ids: string[], locale?: TtsVoice) => SvamlInstructionPlayFiles;
+    say: (text: string, locale?: TtsVoice) => SvamlInstructionSay;
+    sendDtmf: (dtmfValue: string) => SvamlInstructionSendDtmf;
+    setCookie: (name: string, value: string) => SvamlInstructionSetCookie;
+    startRecording: (startRecordingOptions: StartRecordingOptions) => SvamlInstructionStartRecording;
+    stopRecording: () => SvamlInstructionStopRecording;
+};
+export {};