@sinch/verification 1.1.0 → 1.2.1

package/README.md

@@ -50,19 +50,22 @@ const sinch = new SinchClient(credentials);
 const verificationService: VerificationService = sinch.verification;
 
 // Build the request data
-const requestData: Verification.StartVerificationRequestData = {
-  initiateVerificationRequestBody: {
+const requestData: Verification.StartSmsVerificationRequestData = {
+  startVerificationWithSmsRequestBody: {
     identity: {
       type: 'number',
       endpoint: '+17813334444',
     },
-    method: 'sms',
+    smsOptions: {
+      codeType: 'Alphanumeric',
+      locale: 'sv-SE',
+    },
   },
 };
 
 // Use the 'verification' service registered on the Sinch client
-const verificationInitResponse: Verification.InitiateVerificationResponse
-  = await verificationService.verifications.start(requestData);
+const startVerificationResponse: Verification.StartSmsVerificationResponse
+  = await verificationService.startVerifications.startSms(requestData);
 ```
 
 ### Standalone
@@ -87,19 +90,22 @@ const credentials: ApplicationCredentials = {
 const verificationService = new VerificationService(credentials);
 
 // Build the request data
-const requestData: Verification.StartVerificationRequestData = {
-  initiateVerificationRequestBody: {
+const requestData: Verification.StartSmsVerificationRequestData = {
+  startVerificationWithSmsRequestBody: {
     identity: {
       type: 'number',
       endpoint: '+17813334444',
     },
-    method: 'sms',
+    smsOptions: {
+      codeType: 'Alphanumeric',
+      locale: 'sv-SE',
+    },
   },
 };
 
 // Use the standalone declaration of the 'verification' service
-const verificationInitResponse: Verification.InitiateVerificationResponse 
-    = await verificationService.verifications.start(requestData);
+const startVerificationResponse: Verification.StartSmsVerificationResponse 
+    = await verificationService.startVerifications.startSms(requestData);
 ```
 
 ## Promises
@@ -108,18 +114,18 @@ All the methods that interact with the Sinch APIs use Promises. You can use `awa
 
 ```typescript
 // Method 1: Wait for the Promise to complete (you need to be in an 'async' method)
-let verificationInitResponse: Verification.InitiateVerificationResponse;
+let startVerificationResponse: Verification.StartSmsVerificationResponse;
 try {
-  verificationInitResponse = await verificationService.verifications.start(requestData);
-  console.log(`Verification ID = ${verificationInitResponse.id}`);
+  startVerificationResponse = await verificationService.startVerifications.startSms(requestData);
+  console.log(`Verification ID = ${startVerificationResponse.id}`);
 } catch (error: any) {
-  console.error(`ERROR ${error.statusCode}: Impossible to start the verification for the number ${requestData.initiateVerificationRequestBody.identity.endpoint}`);
+  console.error(`ERROR ${error.statusCode}: Impossible to start the verification for the number ${requestData.startVerificationWithSmsRequestBody.identity.endpoint}`);
 }
 
 // Method 2: Resolve the promise
-verificationService.verifications.start(requestData)
+verificationService.startVerifications.startSms(requestData)
   .then(response => console.log(`Verification ID = ${response.id}`))
-  .catch(error => console.error(`ERROR ${error.statusCode}: Impossible to start the verification for the number ${requestData.initiateVerificationRequestBody.identity.endpoint}`));
+  .catch(error => console.error(`ERROR ${error.statusCode}: Impossible to start the verification for the number ${requestData.startVerificationWithSmsRequestBody.identity.endpoint}`));
 ```
 
 ## Contact

package/dist/index.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 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);
 };

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yDAAyC;AACzC,yCAAuB;AACvB,oDAAkC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yDAAyC;AACzC,yCAAuB;AACvB,oDAAkC"}

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

@@ -1,6 +1,3 @@
-export type { TypeEnum as IdentityTypeEnum } from './identity/identity';
-export type { MethodEnum as VerificationRequestEventMethodEnum, } from './verification-request-event/verification-request-event';
-export type { MethodEnum as VerificationResultEventMethodEnum, } from './verification-result-event/verification-result-event';
 export type ActionEnum = 'allow' | 'deny';
 export type VerificationStatusEnum = 'PENDING' | 'SUCCESSFUL' | 'FAIL' | 'DENIED' | 'ABORTED' | 'ERROR';
 export type ReasonEnum = 'Fraud' | 'Not enough credit' | 'Blocked' | 'Denied by callback' | 'Invalid callback' | 'Internal error' | 'Destination denied' | 'Network error or number unreachable' | 'Failed pending' | 'SMS delivery failure' | 'Invalid CLI' | 'Invalid code' | 'Expired' | 'Hung up without entering valid code';

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

@@ -1,18 +1,130 @@
-import { ReportCalloutVerificationByIdentityRequestData, ReportCalloutVerificationByIdRequestData, ReportFlashCallVerificationByIdentityRequestData, ReportFlashCallVerificationByIdRequestData, ReportSmsVerificationByIdentityRequestData, ReportSmsVerificationByIdRequestData, StartCalloutVerificationRequestData, StartFlashCallVerificationRequestData, StartSeamlessVerificationRequestData, StartSmsVerificationRequestData } from './requests';
+import { ReportCalloutVerificationByIdentityRequestData, ReportCalloutVerificationByIdRequestData, ReportFlashCallVerificationByIdentityRequestData, ReportFlashCallVerificationByIdRequestData, ReportPhoneCallVerificationByIdentityRequestData, ReportPhoneCallVerificationByIdRequestData, ReportSmsVerificationByIdentityRequestData, ReportSmsVerificationByIdRequestData, StartCalloutVerificationRequestData, StartDataVerificationRequestData, StartFlashCallVerificationRequestData, StartPhoneCallVerificationRequestData, StartSeamlessVerificationRequestData, StartSmsVerificationRequestData } from './requests';
 import { SmsOptions } from './start-verification-request';
 export declare const startVerificationHelper: {
+    /**
+     * Builds a request object for starting an SMS verification process.
+     *
+     * @param {string} phoneNumber - The phone number to which the verification SMS should be sent.
+     * @param {string} [reference] - An optional reference identifier used to pass your own reference in the request for tracking purposes.
+     * @param {SmsOptions} [smsOptions] - Optional parameters for configuring the SMS verification request, with default values assumed for all contained values if not provided.
+     * @return {StartSmsVerificationRequestData} The constructed SMS verification request data.
+     */
     buildSmsRequest: (phoneNumber: string, reference?: string, smsOptions?: SmsOptions) => StartSmsVerificationRequestData;
+    /**
+     * Builds a request object for starting a phone call verification process.
+     *
+     * @param {string} phoneNumber - The phone number to which the verification call should be made.
+     * @param {string} [reference] - An optional reference identifier used to pass your own reference in the request for tracking purposes.
+     * @param {string} [locale] - An optional language-region identifier to use for the verification call.
+     * @return {StartPhoneCallVerificationRequestData} The request data object for initiating the phone call verification.
+     */
+    buildPhoneCallRequest: (phoneNumber: string, reference?: string, locale?: string) => StartPhoneCallVerificationRequestData;
+    /**
+     * Builds a callout request body with the provided phone number, reference, and locale.
+     *
+     * @param {string} phoneNumber - The phone number to which the callout will be made.
+     * @param {string} [reference] - An optional reference identifier for the callout.
+     * @param {string} [locale] - An optional locale string to specify the language or region for the callout.
+     * @return {StartCalloutVerificationRequestData} The constructed callout request object.
+     * @deprecated Use the method buildPhoneCallRequest() instead
+     */
     buildCalloutRequest: (phoneNumber: string, reference?: string, locale?: string) => StartCalloutVerificationRequestData;
+    /**
+     * Builds a request object for starting a flash call verification process.
+     *
+     * @param {string} phoneNumber - The phone number to which the flash call verification should be made.
+     * @param {string} [reference] - An optional reference identifier used to pass your own reference in the request for tracking purposes.
+     * @param {number} [dialTimeout] - An optional timeout value in seconds for how long to wait for the flash call to be answered.
+     * @return {StartFlashCallVerificationRequestData} The request data object for initiating the flash call verification.
+     */
     buildFlashCallRequest: (phoneNumber: string, reference?: string, dialTimeout?: number) => StartFlashCallVerificationRequestData;
+    /**
+     * Builds a request object for initiating a data verification process.
+     *
+     * @param {string} phoneNumber - The phone number to be verified.
+     * @param {string} [reference] - An optional reference identifier used to pass your own reference in the request for tracking purposes.
+     * @return {StartDataVerificationRequestData} The request data object used to start the data verification.
+     */
+    buildDataRequest: (phoneNumber: string, reference?: string) => StartDataVerificationRequestData;
+    /**
+     * Builds a seamless verification request body with the provided phone number and optional reference.
+     *
+     * @param {string} phoneNumber - The phone number to verify.
+     * @param {string} [reference] - An optional reference identifier for the verification request.
+     * @return {StartSeamlessVerificationRequestData} The constructed seamless verification request data.
+     * @deprecated Use the method buildDataRequest() instead
+     */
     buildSeamlessRequest: (phoneNumber: string, reference?: string) => StartSeamlessVerificationRequestData;
 };
 export declare const reportVerificationByIdHelper: {
+    /**
+     * Builds a request object for reporting an SMS verification by its ID.
+     *
+     * @param {string} id - The unique identifier for the SMS verification request.
+     * @param {string} code - The verification code received via SMS.
+     * @param {string} [cli] - An optional CLI (Caller Line Identification) that can be included in the request.
+     * @return {ReportSmsVerificationByIdRequestData} The request data object used to report the SMS verification.
+     */
     buildSmsRequest: (id: string, code: string, cli?: string) => ReportSmsVerificationByIdRequestData;
+    /**
+     * Builds a request object for reporting a phone call verification by its ID.
+     *
+     * @param {string} id - The unique identifier for the phone call verification request.
+     * @param {string} code - The verification code received during the phone call.
+     * @return {ReportPhoneCallVerificationByIdRequestData} The request data object used to report the phone call verification.
+     */
+    buildPhoneCallRequest: (id: string, code: string) => ReportPhoneCallVerificationByIdRequestData;
+    /**
+     * Builds a request object for reporting a callout verification by its ID.
+     *
+     * @param {string} id - The unique identifier for the callout verification request.
+     * @param {string} code - The verification code received during the callout.
+     * @return {ReportCalloutVerificationByIdRequestData} The request data object used to report the callout verification.
+     * @deprecated Use the method buildPhoneCallRequest() instead
+     */
     buildCalloutRequest: (id: string, code: string) => ReportCalloutVerificationByIdRequestData;
+    /**
+     * Builds a request object for reporting a flash call verification by its ID.
+     *
+     * @param {string} id - The unique identifier for the flash call verification request.
+     * @param {string} cli - The CLI (Caller Line Identification) received during the flash call.
+     * @return {ReportFlashCallVerificationByIdRequestData} The request data object used to report the flash call verification.
+     */
     buildFlashCallRequest: (id: string, cli: string) => ReportFlashCallVerificationByIdRequestData;
 };
 export declare const reportVerificationByIdentityHelper: {
+    /**
+     * Builds a request object for reporting an SMS verification by the phone number identity.
+     *
+     * @param {string} identity - The phone number for which the verification process has been initiated.
+     * @param {string} code - The verification code received via SMS.
+     * @param {string} [cli] - The CLI (Caller Line Identification) that may be used during the verification.
+     * @return {ReportSmsVerificationByIdentityRequestData} The request data object used to report the SMS verification.
+     */
     buildSmsRequest: (identity: string, code: string, cli?: string) => ReportSmsVerificationByIdentityRequestData;
+    /**
+     * Builds a request object for reporting a phone call verification by the phone number identity.
+     *
+     * @param {string} identity - The phone number for which the verification process has been initiated.
+     * @param {string} code - The verification code received via the phone call.
+     * @return {ReportPhoneCallVerificationByIdentityRequestData} The request data object used to report the phone call verification.
+     */
+    buildPhoneCallRequest: (identity: string, code: string) => ReportPhoneCallVerificationByIdentityRequestData;
+    /**
+     * Builds a request object for reporting a callout verification by the phone number identity.
+     *
+     * @param {string} identity - The phone number for which the callout verification process has been initiated.
+     * @param {string} code - The verification code received during the callout.
+     * @return {ReportCalloutVerificationByIdentityRequestData} The request data object used to report the callout verification.
+     * @deprecated Use the method buildPhoneCallRequest() instead
+     */
     buildCalloutRequest: (identity: string, code: string) => ReportCalloutVerificationByIdentityRequestData;
+    /**
+     * Builds a request object for reporting a flash call verification by the phone number identity.
+     *
+     * @param {string} identity - The phone number for which the flash call verification process has been initiated.
+     * @param {string} cli - The CLI (Caller Line Identification) received during the flash call.
+     * @return {ReportFlashCallVerificationByIdentityRequestData} The request data object used to report the flash call verification.
+     */
     buildFlashCallRequest: (identity: string, cli: string) => ReportFlashCallVerificationByIdentityRequestData;
 };

package/dist/models/v1/helper.js

@@ -2,6 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.reportVerificationByIdentityHelper = exports.reportVerificationByIdHelper = exports.startVerificationHelper = void 0;
 exports.startVerificationHelper = {
+    /**
+     * Builds a request object for starting an SMS verification process.
+     *
+     * @param {string} phoneNumber - The phone number to which the verification SMS should be sent.
+     * @param {string} [reference] - An optional reference identifier used to pass your own reference in the request for tracking purposes.
+     * @param {SmsOptions} [smsOptions] - Optional parameters for configuring the SMS verification request, with default values assumed for all contained values if not provided.
+     * @return {StartSmsVerificationRequestData} The constructed SMS verification request data.
+     */
     buildSmsRequest: (phoneNumber, reference, smsOptions) => {
         return {
             startVerificationWithSmsRequestBody: {
@@ -18,6 +26,41 @@ exports.startVerificationHelper = {
             },
         };
     },
+    /**
+     * Builds a request object for starting a phone call verification process.
+     *
+     * @param {string} phoneNumber - The phone number to which the verification call should be made.
+     * @param {string} [reference] - An optional reference identifier used to pass your own reference in the request for tracking purposes.
+     * @param {string} [locale] - An optional language-region identifier to use for the verification call.
+     * @return {StartPhoneCallVerificationRequestData} The request data object for initiating the phone call verification.
+     */
+    buildPhoneCallRequest: (phoneNumber, reference, locale) => {
+        return {
+            startVerificationWithPhoneCallRequestBody: {
+                identity: {
+                    type: 'number',
+                    endpoint: phoneNumber,
+                },
+                reference,
+                ...(locale !== undefined) ? {
+                    phoneCallOptions: {
+                        speech: {
+                            locale,
+                        },
+                    },
+                } : {},
+            },
+        };
+    },
+    /**
+     * Builds a callout request body with the provided phone number, reference, and locale.
+     *
+     * @param {string} phoneNumber - The phone number to which the callout will be made.
+     * @param {string} [reference] - An optional reference identifier for the callout.
+     * @param {string} [locale] - An optional locale string to specify the language or region for the callout.
+     * @return {StartCalloutVerificationRequestData} The constructed callout request object.
+     * @deprecated Use the method buildPhoneCallRequest() instead
+     */
     buildCalloutRequest: (phoneNumber, reference, locale) => {
         return {
             startVerificationWithCalloutRequestBody: {
@@ -36,6 +79,14 @@ exports.startVerificationHelper = {
             },
         };
     },
+    /**
+     * Builds a request object for starting a flash call verification process.
+     *
+     * @param {string} phoneNumber - The phone number to which the flash call verification should be made.
+     * @param {string} [reference] - An optional reference identifier used to pass your own reference in the request for tracking purposes.
+     * @param {number} [dialTimeout] - An optional timeout value in seconds for how long to wait for the flash call to be answered.
+     * @return {StartFlashCallVerificationRequestData} The request data object for initiating the flash call verification.
+     */
     buildFlashCallRequest: (phoneNumber, reference, dialTimeout) => {
         return {
             startVerificationWithFlashCallRequestBody: {
@@ -52,6 +103,32 @@ exports.startVerificationHelper = {
             },
         };
     },
+    /**
+     * Builds a request object for initiating a data verification process.
+     *
+     * @param {string} phoneNumber - The phone number to be verified.
+     * @param {string} [reference] - An optional reference identifier used to pass your own reference in the request for tracking purposes.
+     * @return {StartDataVerificationRequestData} The request data object used to start the data verification.
+     */
+    buildDataRequest: (phoneNumber, reference) => {
+        return {
+            startDataVerificationRequestBody: {
+                identity: {
+                    type: 'number',
+                    endpoint: phoneNumber,
+                },
+                reference,
+            },
+        };
+    },
+    /**
+     * Builds a seamless verification request body with the provided phone number and optional reference.
+     *
+     * @param {string} phoneNumber - The phone number to verify.
+     * @param {string} [reference] - An optional reference identifier for the verification request.
+     * @return {StartSeamlessVerificationRequestData} The constructed seamless verification request data.
+     * @deprecated Use the method buildDataRequest() instead
+     */
     buildSeamlessRequest: (phoneNumber, reference) => {
         return {
             startSeamlessVerificationRequestBody: {
@@ -65,6 +142,14 @@ exports.startVerificationHelper = {
     },
 };
 exports.reportVerificationByIdHelper = {
+    /**
+     * Builds a request object for reporting an SMS verification by its ID.
+     *
+     * @param {string} id - The unique identifier for the SMS verification request.
+     * @param {string} code - The verification code received via SMS.
+     * @param {string} [cli] - An optional CLI (Caller Line Identification) that can be included in the request.
+     * @return {ReportSmsVerificationByIdRequestData} The request data object used to report the SMS verification.
+     */
     buildSmsRequest: (id, code, cli) => {
         return {
             id,
@@ -76,6 +161,31 @@ exports.reportVerificationByIdHelper = {
             },
         };
     },
+    /**
+     * Builds a request object for reporting a phone call verification by its ID.
+     *
+     * @param {string} id - The unique identifier for the phone call verification request.
+     * @param {string} code - The verification code received during the phone call.
+     * @return {ReportPhoneCallVerificationByIdRequestData} The request data object used to report the phone call verification.
+     */
+    buildPhoneCallRequest: (id, code) => {
+        return {
+            id,
+            reportPhoneCallVerificationByIdRequestBody: {
+                phoneCall: {
+                    code,
+                },
+            },
+        };
+    },
+    /**
+     * Builds a request object for reporting a callout verification by its ID.
+     *
+     * @param {string} id - The unique identifier for the callout verification request.
+     * @param {string} code - The verification code received during the callout.
+     * @return {ReportCalloutVerificationByIdRequestData} The request data object used to report the callout verification.
+     * @deprecated Use the method buildPhoneCallRequest() instead
+     */
     buildCalloutRequest: (id, code) => {
         return {
             id,
@@ -86,6 +196,13 @@ exports.reportVerificationByIdHelper = {
             },
         };
     },
+    /**
+     * Builds a request object for reporting a flash call verification by its ID.
+     *
+     * @param {string} id - The unique identifier for the flash call verification request.
+     * @param {string} cli - The CLI (Caller Line Identification) received during the flash call.
+     * @return {ReportFlashCallVerificationByIdRequestData} The request data object used to report the flash call verification.
+     */
     buildFlashCallRequest: (id, cli) => {
         return {
             id,
@@ -98,6 +215,14 @@ exports.reportVerificationByIdHelper = {
     },
 };
 exports.reportVerificationByIdentityHelper = {
+    /**
+     * Builds a request object for reporting an SMS verification by the phone number identity.
+     *
+     * @param {string} identity - The phone number for which the verification process has been initiated.
+     * @param {string} code - The verification code received via SMS.
+     * @param {string} [cli] - The CLI (Caller Line Identification) that may be used during the verification.
+     * @return {ReportSmsVerificationByIdentityRequestData} The request data object used to report the SMS verification.
+     */
     buildSmsRequest: (identity, code, cli) => {
         return {
             endpoint: identity,
@@ -109,6 +234,31 @@ exports.reportVerificationByIdentityHelper = {
             },
         };
     },
+    /**
+     * Builds a request object for reporting a phone call verification by the phone number identity.
+     *
+     * @param {string} identity - The phone number for which the verification process has been initiated.
+     * @param {string} code - The verification code received via the phone call.
+     * @return {ReportPhoneCallVerificationByIdentityRequestData} The request data object used to report the phone call verification.
+     */
+    buildPhoneCallRequest: (identity, code) => {
+        return {
+            endpoint: identity,
+            reportPhoneCallVerificationByIdentityRequestBody: {
+                phoneCall: {
+                    code,
+                },
+            },
+        };
+    },
+    /**
+     * Builds a request object for reporting a callout verification by the phone number identity.
+     *
+     * @param {string} identity - The phone number for which the callout verification process has been initiated.
+     * @param {string} code - The verification code received during the callout.
+     * @return {ReportCalloutVerificationByIdentityRequestData} The request data object used to report the callout verification.
+     * @deprecated Use the method buildPhoneCallRequest() instead
+     */
     buildCalloutRequest: (identity, code) => {
         return {
             endpoint: identity,
@@ -119,6 +269,13 @@ exports.reportVerificationByIdentityHelper = {
             },
         };
     },
+    /**
+     * Builds a request object for reporting a flash call verification by the phone number identity.
+     *
+     * @param {string} identity - The phone number for which the flash call verification process has been initiated.
+     * @param {string} cli - The CLI (Caller Line Identification) received during the flash call.
+     * @return {ReportFlashCallVerificationByIdentityRequestData} The request data object used to report the flash call verification.
+     */
     buildFlashCallRequest: (identity, cli) => {
         return {
             endpoint: identity,

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

@@ -1 +1 @@
-{"version":3,"file":"helper.js","sourceRoot":"","sources":["../../../src/models/v1/helper.ts"],"names":[],"mappings":";;;AAca,QAAA,uBAAuB,GAAG;IACrC,eAAe,EAAE,CACf,WAAmB,EACnB,SAAkB,EAClB,UAAuB,EACU,EAAE;QACnC,OAAO;YACL,mCAAmC,EAAE;gBACnC,QAAQ,EAAE;oBACR,IAAI,EAAE,QAAQ;oBACd,QAAQ,EAAE,WAAW;iBACtB;gBACD,SAAS;gBACT,GAAG,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;oBAC9B,UAAU,EAAE;wBACV,GAAG,UAAU;qBACd;iBACF,CAAC,CAAC,CAAC,EAAE;aACP;SACF,CAAC;IACJ,CAAC;IACD,mBAAmB,EAAE,CACnB,WAAmB,EACnB,SAAkB,EAClB,MAAe,EACsB,EAAE;QACvC,OAAO;YACL,uCAAuC,EAAE;gBACvC,QAAQ,EAAE;oBACR,IAAI,EAAE,QAAQ;oBACd,QAAQ,EAAE,WAAW;iBACtB;gBACD,SAAS;gBACT,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;oBAC1B,cAAc,EAAE;wBACd,MAAM,EAAE;4BACN,MAAM;yBACP;qBACF;iBACF,CAAC,CAAC,CAAC,EAAE;aACP;SACF,CAAC;IACJ,CAAC;IACD,qBAAqB,EAAE,CACrB,WAAmB,EACnB,SAAkB,EAClB,WAAoB,EACmB,EAAE;QACzC,OAAO;YACL,yCAAyC,EAAE;gBACzC,QAAQ,EAAE;oBACR,IAAI,EAAE,QAAQ;oBACd,QAAQ,EAAE,WAAW;iBACtB;gBACD,SAAS;gBACT,GAAG,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;oBAC/B,gBAAgB,EAAE;wBAChB,WAAW;qBACZ;iBACF,CAAC,CAAC,CAAC,EAAE;aACP;SACF,CAAC;IACJ,CAAC;IACD,oBAAoB,EAAE,CACpB,WAAmB,EACnB,SAAkB,EACoB,EAAE;QACxC,OAAO;YACL,oCAAoC,EAAE;gBACpC,QAAQ,EAAE;oBACR,IAAI,EAAE,QAAQ;oBACd,QAAQ,EAAE,WAAW;iBACtB;gBACD,SAAS;aACV;SACF,CAAC;IACJ,CAAC;CACF,CAAC;AACW,QAAA,4BAA4B,GAAG;IAC1C,eAAe,EAAE,CACf,EAAU,EACV,IAAY,EACZ,GAAY,EAC0B,EAAE;QACxC,OAAO;YACL,EAAE;YACF,oCAAoC,EAAE;gBACpC,GAAG,EAAE;oBACH,IAAI;oBACJ,GAAG;iBACJ;aACF;SACF,CAAC;IACJ,CAAC;IACD,mBAAmB,EAAE,CACnB,EAAU,EACV,IAAY,EAC8B,EAAE;QAC5C,OAAO;YACL,EAAE;YACF,wCAAwC,EAAE;gBACxC,OAAO,EAAE;oBACP,IAAI;iBACL;aACF;SACF,CAAC;IACJ,CAAC;IACD,qBAAqB,EAAE,CACrB,EAAU,EACV,GAAW,EACiC,EAAE;QAC9C,OAAO;YACL,EAAE;YACF,0CAA0C,EAAE;gBAC1C,SAAS,EAAE;oBACT,GAAG;iBACJ;aACF;SACF,CAAC;IACJ,CAAC;CACF,CAAC;AACW,QAAA,kCAAkC,GAAG;IAChD,eAAe,EAAE,CACf,QAAgB,EAChB,IAAY,EACZ,GAAY,EACgC,EAAE;QAC9C,OAAO;YACL,QAAQ,EAAE,QAAQ;YAClB,0CAA0C,EAAE;gBAC1C,GAAG,EAAE;oBACH,IAAI;oBACJ,GAAG;iBACJ;aACF;SACF,CAAC;IACJ,CAAC;IACD,mBAAmB,EAAE,CACnB,QAAgB,EAChB,IAAY,EACoC,EAAE;QAClD,OAAO;YACL,QAAQ,EAAE,QAAQ;YAClB,8CAA8C,EAAE;gBAC9C,OAAO,EAAE;oBACP,IAAI;iBACL;aACF;SACF,CAAC;IACJ,CAAC;IACD,qBAAqB,EAAE,CACrB,QAAgB,EAChB,GAAW,EACuC,EAAE;QACpD,OAAO;YACL,QAAQ,EAAE,QAAQ;YAClB,gDAAgD,EAAE;gBAChD,SAAS,EAAE;oBACT,GAAG;iBACJ;aACF;SACF,CAAC;IACJ,CAAC;CACF,CAAC"}
+{"version":3,"file":"helper.js","sourceRoot":"","sources":["../../../src/models/v1/helper.ts"],"names":[],"mappings":";;;AAkBa,QAAA,uBAAuB,GAAG;IACrC;;;;;;;OAOG;IACH,eAAe,EAAE,CACf,WAAmB,EACnB,SAAkB,EAClB,UAAuB,EACU,EAAE;QACnC,OAAO;YACL,mCAAmC,EAAE;gBACnC,QAAQ,EAAE;oBACR,IAAI,EAAE,QAAQ;oBACd,QAAQ,EAAE,WAAW;iBACtB;gBACD,SAAS;gBACT,GAAG,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;oBAC9B,UAAU,EAAE;wBACV,GAAG,UAAU;qBACd;iBACF,CAAC,CAAC,CAAC,EAAE;aACP;SACF,CAAC;IACJ,CAAC;IACD;;;;;;;OAOG;IACH,qBAAqB,EAAE,CACrB,WAAmB,EACnB,SAAkB,EAClB,MAAe,EACwB,EAAE;QACzC,OAAO;YACL,yCAAyC,EAAE;gBACzC,QAAQ,EAAE;oBACR,IAAI,EAAE,QAAQ;oBACd,QAAQ,EAAE,WAAW;iBACtB;gBACD,SAAS;gBACT,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;oBAC1B,gBAAgB,EAAE;wBAChB,MAAM,EAAE;4BACN,MAAM;yBACP;qBACF;iBACF,CAAC,CAAC,CAAC,EAAE;aACP;SACF,CAAC;IACJ,CAAC;IACD;;;;;;;;OAQG;IACH,mBAAmB,EAAE,CACnB,WAAmB,EACnB,SAAkB,EAClB,MAAe,EACsB,EAAE;QACvC,OAAO;YACL,uCAAuC,EAAE;gBACvC,QAAQ,EAAE;oBACR,IAAI,EAAE,QAAQ;oBACd,QAAQ,EAAE,WAAW;iBACtB;gBACD,SAAS;gBACT,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;oBAC1B,cAAc,EAAE;wBACd,MAAM,EAAE;4BACN,MAAM;yBACP;qBACF;iBACF,CAAC,CAAC,CAAC,EAAE;aACP;SACF,CAAC;IACJ,CAAC;IACD;;;;;;;OAOG;IACH,qBAAqB,EAAE,CACrB,WAAmB,EACnB,SAAkB,EAClB,WAAoB,EACmB,EAAE;QACzC,OAAO;YACL,yCAAyC,EAAE;gBACzC,QAAQ,EAAE;oBACR,IAAI,EAAE,QAAQ;oBACd,QAAQ,EAAE,WAAW;iBACtB;gBACD,SAAS;gBACT,GAAG,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;oBAC/B,gBAAgB,EAAE;wBAChB,WAAW;qBACZ;iBACF,CAAC,CAAC,CAAC,EAAE;aACP;SACF,CAAC;IACJ,CAAC;IACD;;;;;;OAMG;IACH,gBAAgB,EAAE,CAChB,WAAmB,EACnB,SAAkB,EACgB,EAAE;QACpC,OAAO;YACL,gCAAgC,EAAE;gBAChC,QAAQ,EAAE;oBACR,IAAI,EAAE,QAAQ;oBACd,QAAQ,EAAE,WAAW;iBACtB;gBACD,SAAS;aACV;SACF,CAAC;IACJ,CAAC;IACD;;;;;;;OAOG;IACH,oBAAoB,EAAE,CACpB,WAAmB,EACnB,SAAkB,EACoB,EAAE;QACxC,OAAO;YACL,oCAAoC,EAAE;gBACpC,QAAQ,EAAE;oBACR,IAAI,EAAE,QAAQ;oBACd,QAAQ,EAAE,WAAW;iBACtB;gBACD,SAAS;aACV;SACF,CAAC;IACJ,CAAC;CACF,CAAC;AACW,QAAA,4BAA4B,GAAG;IAC1C;;;;;;;OAOG;IACH,eAAe,EAAE,CACf,EAAU,EACV,IAAY,EACZ,GAAY,EAC0B,EAAE;QACxC,OAAO;YACL,EAAE;YACF,oCAAoC,EAAE;gBACpC,GAAG,EAAE;oBACH,IAAI;oBACJ,GAAG;iBACJ;aACF;SACF,CAAC;IACJ,CAAC;IACD;;;;;;OAMG;IACH,qBAAqB,EAAE,CACrB,EAAU,EACV,IAAY,EACgC,EAAE;QAC9C,OAAO;YACL,EAAE;YACF,0CAA0C,EAAE;gBAC1C,SAAS,EAAE;oBACT,IAAI;iBACL;aACF;SACF,CAAC;IACJ,CAAC;IACD;;;;;;;OAOG;IACH,mBAAmB,EAAE,CACnB,EAAU,EACV,IAAY,EAC8B,EAAE;QAC5C,OAAO;YACL,EAAE;YACF,wCAAwC,EAAE;gBACxC,OAAO,EAAE;oBACP,IAAI;iBACL;aACF;SACF,CAAC;IACJ,CAAC;IACD;;;;;;OAMG;IACH,qBAAqB,EAAE,CACrB,EAAU,EACV,GAAW,EACiC,EAAE;QAC9C,OAAO;YACL,EAAE;YACF,0CAA0C,EAAE;gBAC1C,SAAS,EAAE;oBACT,GAAG;iBACJ;aACF;SACF,CAAC;IACJ,CAAC;CACF,CAAC;AACW,QAAA,kCAAkC,GAAG;IAChD;;;;;;;OAOG;IACH,eAAe,EAAE,CACf,QAAgB,EAChB,IAAY,EACZ,GAAY,EACgC,EAAE;QAC9C,OAAO;YACL,QAAQ,EAAE,QAAQ;YAClB,0CAA0C,EAAE;gBAC1C,GAAG,EAAE;oBACH,IAAI;oBACJ,GAAG;iBACJ;aACF;SACF,CAAC;IACJ,CAAC;IACD;;;;;;OAMG;IACH,qBAAqB,EAAE,CACrB,QAAgB,EAChB,IAAY,EACsC,EAAE;QACpD,OAAO;YACL,QAAQ,EAAE,QAAQ;YAClB,gDAAgD,EAAE;gBAChD,SAAS,EAAE;oBACT,IAAI;iBACL;aACF;SACF,CAAC;IACJ,CAAC;IACD;;;;;;;OAOG;IACH,mBAAmB,EAAE,CACnB,QAAgB,EAChB,IAAY,EACoC,EAAE;QAClD,OAAO;YACL,QAAQ,EAAE,QAAQ;YAClB,8CAA8C,EAAE;gBAC9C,OAAO,EAAE;oBACP,IAAI;iBACL;aACF;SACF,CAAC;IACJ,CAAC;IACD;;;;;;OAMG;IACH,qBAAqB,EAAE,CACrB,QAAgB,EAChB,GAAW,EACuC,EAAE;QACpD,OAAO;YACL,QAAQ,EAAE,QAAQ;YAClB,gDAAgD,EAAE;gBAChD,SAAS,EAAE;oBACT,GAAG;iBACJ;aACF;SACF,CAAC;IACJ,CAAC;CACF,CAAC"}

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

@@ -3,10 +3,10 @@
  */
 export interface Identity {
     /** Currently only `number` type is supported. */
-    type: TypeEnum;
+    type: IdentityType;
     /** For type `number` use an [E.164](https://community.sinch.com/t5/Glossary/E-164/ta-p/7537)-compatible phone number. */
     endpoint: string;
-    /** */
-    verified?: boolean;
 }
-export type TypeEnum = 'number';
+export type IdentityType = 'number';
+/** @deprecated Use IdentityType instead */
+export type TypeEnum = IdentityType;

package/dist/models/v1/identity/index.d.ts

@@ -1 +1 @@
-export type { Identity } from './identity';
+export type { Identity, IdentityType, TypeEnum } from './identity';

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

@@ -1,32 +1,23 @@
-export * from './callout-request-event-response';
-export * from './callout-request-event-response-callout';
-export * from './callout-request-event-response-callout-speech';
-export * from './callout-verification-report-response';
-export * from './callout-verification-status-response';
-export * from './flashcall-request-event-response';
+export * from './requests';
+export * from './start-verification-request';
+export * from './verification-report-request';
+export * from './start-sms-verification-response';
+export * from './sms-verification-report-response';
+export * from './sms-verification-status-response';
+export * from './start-phonecall-verification-response';
+export * from './phonecall-verification-report-response';
+export * from './phonecall-verification-status-response';
+export * from './start-flashcall-verification-response';
 export * from './flashcall-verification-report-response';
 export * from './flashcall-verification-status-response';
-export * from './verification-report-response-price';
+export * from './start-data-verification-response';
+export * from './verification-status-response';
+export * from './mod-callbacks';
 export * from './identity';
-export * from './start-verification-request';
 export * from './links-object';
 export * from './price';
-export * from './start-flashcall-verification-response';
-export * from './start-callout-verification-response';
-export * from './start-seamless-verification-response';
-export * from './start-sms-verification-response';
-export * from './sms-request-event-response';
-export * from './sms-verification-report-response';
-export * from './sms-verification-status-response';
 export * from './verification-price-call';
 export * from './verification-price-sms';
-export * from './verification-report-request';
-export * from './verification-status-response';
-export * from './verification-request-event';
-export * from './verification-request-event-response';
-export * from './verification-result-event';
-export * from './verification-result-event-response';
 export * from './verification-error';
 export * from './enums';
 export * from './helper';
-export * from './requests';

package/dist/models/v1/index.js

@@ -14,36 +14,38 @@ 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("./callout-request-event-response"), exports);
-__exportStar(require("./callout-request-event-response-callout"), exports);
-__exportStar(require("./callout-request-event-response-callout-speech"), exports);
-__exportStar(require("./callout-verification-report-response"), exports);
-__exportStar(require("./callout-verification-status-response"), exports);
-__exportStar(require("./flashcall-request-event-response"), exports);
+// Models associated to API requests
+__exportStar(require("./requests"), exports);
+__exportStar(require("./start-verification-request"), exports);
+__exportStar(require("./verification-report-request"), exports);
+// Models associated to SMS verification workflow
+__exportStar(require("./start-sms-verification-response"), exports);
+__exportStar(require("./sms-verification-report-response"), exports);
+__exportStar(require("./sms-verification-status-response"), exports);
+// Models associated to PhoneCall verification workflow
+__exportStar(require("./start-phonecall-verification-response"), exports);
+__exportStar(require("./phonecall-verification-report-response"), exports);
+__exportStar(require("./phonecall-verification-status-response"), exports);
+// Models associated to Flashcall verification workflow
+__exportStar(require("./start-flashcall-verification-response"), exports);
 __exportStar(require("./flashcall-verification-report-response"), exports);
 __exportStar(require("./flashcall-verification-status-response"), exports);
-__exportStar(require("./verification-report-response-price"), exports);
+// Models associated to Data verification workflow
+__exportStar(require("./start-data-verification-response"), exports);
+// Wrapper for the various types of Verification Status Response
+__exportStar(require("./verification-status-response"), exports);
+// Models associated to callback events
+__exportStar(require("./mod-callbacks"), exports);
+// Common models
 __exportStar(require("./identity"), exports);
-__exportStar(require("./start-verification-request"), exports);
 __exportStar(require("./links-object"), exports);
 __exportStar(require("./price"), exports);
-__exportStar(require("./start-flashcall-verification-response"), exports);
-__exportStar(require("./start-callout-verification-response"), exports);
-__exportStar(require("./start-seamless-verification-response"), exports);
-__exportStar(require("./start-sms-verification-response"), exports);
-__exportStar(require("./sms-request-event-response"), exports);
-__exportStar(require("./sms-verification-report-response"), exports);
-__exportStar(require("./sms-verification-status-response"), exports);
 __exportStar(require("./verification-price-call"), exports);
 __exportStar(require("./verification-price-sms"), exports);
-__exportStar(require("./verification-report-request"), exports);
-__exportStar(require("./verification-status-response"), exports);
-__exportStar(require("./verification-request-event"), exports);
-__exportStar(require("./verification-request-event-response"), exports);
-__exportStar(require("./verification-result-event"), exports);
-__exportStar(require("./verification-result-event-response"), exports);
+// Error model
 __exportStar(require("./verification-error"), exports);
+// Enums
 __exportStar(require("./enums"), exports);
+// Helper methods
 __exportStar(require("./helper"), exports);
-__exportStar(require("./requests"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/v1/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mEAAiD;AACjD,2EAAyD;AACzD,kFAAgE;AAChE,yEAAuD;AACvD,yEAAuD;AACvD,qEAAmD;AACnD,2EAAyD;AACzD,2EAAyD;AACzD,uEAAqD;AACrD,6CAA2B;AAC3B,+DAA6C;AAC7C,iDAA+B;AAC/B,0CAAwB;AACxB,0EAAwD;AACxD,wEAAsD;AACtD,yEAAuD;AACvD,oEAAkD;AAClD,+DAA6C;AAC7C,qEAAmD;AACnD,qEAAmD;AACnD,4DAA0C;AAC1C,2DAAyC;AACzC,gEAA8C;AAC9C,iEAA+C;AAC/C,+DAA6C;AAC7C,wEAAsD;AACtD,8DAA4C;AAC5C,uEAAqD;AACrD,uDAAqC;AACrC,0CAAwB;AACxB,2CAAyB;AACzB,6CAA2B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/v1/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oCAAoC;AACpC,6CAA2B;AAC3B,+DAA6C;AAC7C,gEAA8C;AAC9C,iDAAiD;AACjD,oEAAkD;AAClD,qEAAmD;AACnD,qEAAmD;AACnD,uDAAuD;AACvD,0EAAwD;AACxD,2EAAyD;AACzD,2EAAyD;AACzD,uDAAuD;AACvD,0EAAwD;AACxD,2EAAyD;AACzD,2EAAyD;AACzD,kDAAkD;AAClD,qEAAmD;AACnD,gEAAgE;AAChE,iEAA+C;AAC/C,uCAAuC;AACvC,kDAAgC;AAChC,gBAAgB;AAChB,6CAA2B;AAC3B,iDAA+B;AAC/B,0CAAwB;AACxB,4DAA0C;AAC1C,2DAAyC;AACzC,cAAc;AACd,uDAAqC;AACrC,QAAQ;AACR,0CAAwB;AACxB,iBAAiB;AACjB,2CAAyB"}