DEVEXP-269 (Part 1/2): Refactor Voice models

examples/simple-examples/package.json

@@ -46,7 +46,7 @@
     "conversation:templatev1:delete": "ts-node src/conversation/templates-v1/delete.ts",
     "conversation:templatev2:create": "ts-node src/conversation/templates-v2/create.ts",
     "conversation:templatev2:get": "ts-node src/conversation/templates-v2/get.ts",
-    "conversation:templatev2:list": "ts-node src/conversation/templates-v2/list.ts pretty",
+    "conversation:templatev2:list": "ts-node src/conversation/templates-v2/list.ts",
     "conversation:templatev2:listTranslations": "ts-node src/conversation/templates-v2/list-translations.ts pretty",
     "conversation:templatev2:update": "ts-node src/conversation/templates-v2/update.ts",
     "conversation:templatev2:delete": "ts-node src/conversation/templates-v2/delete.ts",

examples/simple-examples/src/voice/applications/getNumbers.ts

@@ -11,7 +11,7 @@ import { GetNumbersRequestData } from '@sinch/sdk-core';
   const sinchClient = initApplicationClient();
   let response;
   try {
-    response = await sinchClient.voice.applications.getNumbers(requestData);
+    response = await sinchClient.voice.applications.listNumbers(requestData);
   } catch (error) {
     console.log(`Impossible to get information about your numbers`);
     throw error;

examples/simple-examples/src/voice/callouts/custom.ts

@@ -1,11 +1,18 @@
 import {
   getPhoneNumberFromConfig,
   getPrintFormat,
-  getRecipientPhoneNumberFromConfig, getVoiceCallBackUrl,
+  getRecipientPhoneNumberFromConfig,
+  getVoiceCallBackUrl,
   initApplicationClient,
   printFullResponse,
 } from '../../config';
-import { AceResponse, CustomCalloutRequestData, IceResponse } from '@sinch/sdk-core';
+import {
+  aceActionHelper,
+  customCalloutHelper,
+  CustomCalloutRequestData,
+  iceActionHelper,
+  iceInstructionHelper,
+} from '@sinch/sdk-core';
 
 (async () => {
   console.log('*********************');
@@ -26,31 +33,35 @@ import { AceResponse, CustomCalloutRequestData, IceResponse } from '@sinch/sdk-c
           endpoint: recipientPhoneNumber,
         },
         custom: 'Custom text',
-        ice: JSON.stringify({
-          action: {
-            name: 'connectPstn',
+        ice: customCalloutHelper.formatIceResponse(
+          iceActionHelper.connectPstn({
             number: recipientPhoneNumber,
             cli: callingNumber,
-          },
-        } as IceResponse),
-        ace: JSON.stringify({
-          action: {
-            name: 'runMenu',
+          }),
+          iceInstructionHelper.say('Welcome to Sinch.', 'en-US/male'),
+          iceInstructionHelper.startRecording({
+            destinationUrl: 'To specify',
+            credentials: 'To specify',
+          }),
+        ),
+        ace: customCalloutHelper.formatAceResponse(
+          aceActionHelper.runMenu({
             locale: 'Kimberly',
             enableVoice: true,
+            barge: true,
             menus: [
               {
                 id: 'main',
-                mainPrompt: '#tts[Welcome to the main menu. Press 1 to confirm order or 4 to cancel]',
-                repeatPrompt: '#tts[Incorrect value, please try again]',
+                mainPrompt: '#tts[Welcome to the main menu. Press 1 to confirm order or 2 to cancel]',
+                repeatPrompt: '#tts[We didn\'t get your input, please try again]',
                 timeoutMills: 5000,
                 options: [
                   {
                     dtmf: '1',
                     action: 'menu(confirm)',
                   },
                   {
-                    dtmf: '4',
+                    dtmf: '2',
                     action: 'return(cancel)',
                   },
                 ],
@@ -61,8 +72,8 @@ import { AceResponse, CustomCalloutRequestData, IceResponse } from '@sinch/sdk-c
                 maxDigits: 4,
               },
             ],
-          },
-        } as AceResponse),
+          }),
+        ),
         pie: callbackUrl,
       },
     },

examples/simple-examples/src/voice/callouts/tts.ts

@@ -24,7 +24,7 @@ import { TtsCalloutRequestData, VoiceRegion } from '@sinch/sdk-core';
           type: 'number',
           endpoint: recipientPhoneNumber,
         },
-        locale: 'en-US',
+        locale: 'en-US/male',
         text: 'Hello, this is a call from Sinch',
       },
     },

examples/simple-examples/src/voice/calls/manageWithCallLeg.ts

@@ -14,7 +14,7 @@ import { ManageWithCallLegRequestData, VoiceRegion } from '@sinch/sdk-core';
   const requestData: ManageWithCallLegRequestData = {
     callId,
     callLeg: 'callee',
-    svamlRequestBody: {
+    manageWithCallLegRequestBody: {
       instructions: [
         {
           name: 'say',

examples/simple-examples/src/voice/calls/update.ts

@@ -13,7 +13,7 @@ import { UpdateCallRequestData, VoiceRegion } from '@sinch/sdk-core';
 
   const requestData: UpdateCallRequestData = {
     callId,
-    svamlRequestBody: {
+    updateCallRequestBody: {
       instructions: [
         {
           name: 'sendDtmf',

examples/webhooks/src/services/voice.service.ts

@@ -1,14 +1,20 @@
 import { Injectable } from '@nestjs/common';
 import { Response } from 'express';
 import {
+  aceActionHelper,
+  aceInstructionHelper,
   AceRequest,
-  AceResponse,
+  AceSvamletBuilder,
   DiceRequest,
+  iceActionHelper,
+  iceInstructionHelper,
   IceRequest,
-  IceResponse,
+  IceSvamletBuilder,
   NotifyRequest,
+  pieActionHelper,
+  pieInstructionHelper,
   PieRequest,
-  PieResponse,
+  PieSvamletBuilder,
   VoiceCallback,
 } from '@sinch/sdk-core';
 
@@ -40,25 +46,17 @@ export class VoiceService {
 
   private handleIceRequest(event: IceRequest, res: Response) {
     console.log(`ICE request: CLI = ${event.cli} - To = ${event.to.endpoint} (${event.to.type})`)
-    const iceResponse: IceResponse = {
-      action: {
-        name: 'hangup'
-      },
-      instructions: [
-        {
-          name: 'say',
-          text: 'Thank you for calling Sinch! This call will now end.'
-        }
-      ]
-    };
+    const iceResponse = new IceSvamletBuilder()
+      .setAction(iceActionHelper.hangup())
+      .addInstruction(iceInstructionHelper.say('Thank you for calling Sinch! This call will now end.', 'en-US'))
+      .build();
     res.status(200).json(iceResponse);
   }
 
   private handleAceRequest(event: AceRequest, res: Response) {
-    console.log(`ACE request: Call answered at '${event.timestamp}'`);
-    const aceResponse: AceResponse = {
-      action: {
-        name: 'runMenu',
+    console.log(`ACE request: Call answered at '${event.timestamp.toISOString()}'`);
+    const aceResponse = new AceSvamletBuilder()
+      .setAction(aceActionHelper.runMenu({
         barge: true,
         menus: [
           {
@@ -81,36 +79,30 @@ export class VoiceService {
             repeatPrompt: '#tts[Please enter your 4-digit pin.]',
             repeats: 3,
             maxDigits: 4
-          }
-        ]
-      }
-    };
+          },
+        ],
+      }))
+      .build();
     res.status(200).json(aceResponse);
   }
 
   private handleDiceRequest(event: DiceRequest, res: Response) {
-    console.log(`DICE request: Call disconnected at '${event.timestamp}' with the reason '${event.reason}'.`);
+    console.log(`DICE request: Call disconnected at '${event.timestamp.toISOString()}' with the reason '${event.reason}'.`);
     res.status(200).send();
   }
 
   private handlePieRequest(event: PieRequest, res: Response) {
     console.log(`PIE request: IVR menu choice: '${event.menuResult?.value}'`);
-    const pieResponse: PieResponse = {
-      action: {
-        name: 'hangup'
-      },
-      instructions: [
-        {
-          name: 'say',
-          text: 'Thanks for your input. The call will now end.'
-        }
-      ]
-    }
+    const pieResponse = new PieSvamletBuilder()
+      .setAction(pieActionHelper.hangup())
+      .addInstruction(pieInstructionHelper.say('Thanks for your input. The call will end after some music.'))
+      .addInstruction(pieInstructionHelper.playFiles(['https://samples-files.com/samples/Audio/mp3/sample-file-4.mp3']))
+      .build();
     res.status(200).send(pieResponse);
   }
 
   private handleNotifyRequest(event: NotifyRequest, res: Response) {
-    console.log(`Notification received: "${event.type}"`)
+    console.log(`Notification received: "${event.type}"`);
     res.status(200).send();
   }
 }

packages/voice/src/models/v1/assign-numbers/assign-numbers.ts

@@ -1,20 +1,9 @@
-/**
- * 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';
-

packages/voice/src/models/v1/call-header/call-header.ts

@@ -1,11 +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.
  */
@@ -16,5 +8,3 @@ export interface CallHeader {
   /** The call header value of the key value pair. */
   value?: string;
 }
-
-

packages/voice/src/models/v1/callout-response/callout-response.ts

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

packages/voice/src/models/v1/callout-response/index.ts

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