@sinch/verification 0.0.1 → 0.0.3

package/README.md

@@ -2,13 +2,12 @@
 
 This package contains the Sinch Verification 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.
 
@@ -37,19 +36,24 @@ The `Verification` API uses the Application Signed Request to authenticate again
 If you are using this SDK as part of the Sinch SDK (`@sinch/sdk-core`) you can access it as the `verification` property of the client that you would have instantiated.
 
 ```typescript
-import { 
+import {
   InitiateVerificationResponse,
   StartVerificationRequestData,
   SinchClient,
-  SinchClientParameters,
+  ApplicationCredentials, 
+  VerificationService,
 } from '@sinch/sdk-core';
 
-const credentials: SinchClientParameters = {
+const credentials: ApplicationCredentials = {
   applicationKey: 'APPLICATION_ID',
   applicationSecret: 'APPLICATION_SECRET',
 };
+
+// Access the 'verification' service registered on the Sinch Client
 const sinch = new SinchClient(credentials);
+const verificationService: VerificationService = sinch.verification;
 
+// Build the request data
 const requestData: StartVerificationRequestData = {
   initiateVerificationRequestBody: {
     identity: {
@@ -60,9 +64,9 @@ const requestData: StartVerificationRequestData = {
   },
 };
 
-// Access the 'verification' domain registered on the Sinch Client
-const verificationInitResponse: InitiateVerificationResponse 
-    = await sinch.verification.verifications.start(requestData);
+// Use the 'verification' service registered on the Sinch client
+const verificationInitResponse: InitiateVerificationResponse
+  = await verificationService.verifications.start(requestData);
 ```
 
 ### Standalone
@@ -71,22 +75,23 @@ The SDK can be used standalone if you need to use only the Verification APIs.
 
 ```typescript
 import {
-  SinchClientParameters
+  ApplicationCredentials
  } from '@sinch/sdk-client';
 import { 
   InitiateVerificationResponse,
   StartVerificationRequestData,
-  Verification,
+  VerificationService,
 } from '@sinch/verification';
 
-const credentials: SinchClientParameters = {
+const credentials: ApplicationCredentials = {
   applicationKey: 'APPLICATION_ID',
   applicationSecret: 'APPLICATION_SECRET',
 };
 
-// Declare the 'verification' in a standalone way
-const verification = new Verification(credentials);
+// Declare the 'verification' service in a standalone way
+const verificationService = new VerificationService(credentials);
 
+// Build the request data
 const requestData: StartVerificationRequestData = {
   initiateVerificationRequestBody: {
     identity: {
@@ -97,29 +102,29 @@ const requestData: StartVerificationRequestData = {
   },
 };
 
-// Use the standalone declaration of the 'verification' domain
+// Use the standalone declaration of the 'verification' service
 const verificationInitResponse: InitiateVerificationResponse 
-    = await verification.verifications.start(requestData);
+    = await verificationService.verifications.start(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 verificationInitResponse: InitiateVerificationResponse;
 try {
-  verificationInitResponse = await sinch.verification.verifications.start(requestData);
-  console.log(`Verification ID = ${response.id}`);
+  verificationInitResponse = await verificationService.verifications.start(requestData);
+  console.log(`Verification ID = ${verificationInitResponse.id}`);
 } catch (error: any) {
-  console.error(`ERROR ${error.statusCode}: Impossible to start the verification for the number ${requestData.InitiateVerificationResource.identity.endpoint}`);
+  console.error(`ERROR ${error.statusCode}: Impossible to start the verification for the number ${requestData.initiateVerificationRequestBody.identity.endpoint}`);
 }
 
 // Method 2: Resolve the promise
-sinch.verification.verifications.start(requestData)
+verificationService.verifications.start(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.InitiateVerificationResource.identity.endpoint}`));
+  .catch(error => console.error(`ERROR ${error.statusCode}: Impossible to start the verification for the number ${requestData.initiateVerificationRequestBody.identity.endpoint}`));
 ```
 
 ## Contact

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

@@ -1,9 +1,3 @@
-/**
- * Model: CalloutRequestEventResponse
- *
- * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
- *
- */
 import { CalloutRequestEventResponseCallout } from '../callout-request-event-response-callout';
 export interface CalloutRequestEventResponse {
     /** Determines whether the verification can be executed. */

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

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

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

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

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

@@ -1,9 +1,3 @@
-/**
- * Model: CalloutRequestEventResponseCallout
- *
- * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
- *
- */
 import { CalloutRequestEventResponseCalloutSpeech } from '../callout-request-event-response-callout-speech';
 export interface CalloutRequestEventResponseCallout {
     /** The Phone Call PIN that should be entered by the user. Sinch servers automatically generate PIN codes for Phone Call verification. If you want to set your own code, you can specify it in the response to the Verification Request Event. */

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

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

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

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

package/dist/models/v1/callout-request-event-response-callout-speech/callout-request-event-response-callout-speech.d.ts

@@ -1,9 +1,3 @@
-/**
- * Model: CalloutRequestEventResponseCalloutSpeech
- *
- * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
- *
- */
 /**
  * An object defining various properties for the text-to-speech message.
  */

package/dist/models/v1/callout-request-event-response-callout-speech/callout-request-event-response-callout-speech.js

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

package/dist/models/v1/callout-request-event-response-callout-speech/callout-request-event-response-callout-speech.js.map

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

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

@@ -1,17 +1,11 @@
-/**
- * Model: CalloutVerificationReportResponse
- *
- * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
- *
- */
-import { FlashcallVerificationReportResponsePrice } from '../flashcall-verification-report-response-price';
+import { VerificationReportResponsePrice } from '../verification-report-response-price';
 import { VerificationStatusEnum } from '../enums';
 import { Identity } from '../identity';
 export interface CalloutVerificationReportResponse {
     /** The unique ID of the verification request. */
     id?: string;
     /** The method of the verification request. This will always be `callout`. */
-    method?: MethodEnum;
+    method?: 'callout';
     /** The status of the verification request. */
     status?: VerificationStatusEnum;
     /** Displays the reason why a verification has `FAILED`, was `DENIED`, or was `ABORTED`. */
@@ -20,8 +14,8 @@ export interface CalloutVerificationReportResponse {
     callComplete?: boolean;
     /** The reference ID that was optionally passed together with the verification request. */
     reference?: string;
-    /** @see FlashcallVerificationReportResponsePrice */
-    price?: FlashcallVerificationReportResponsePrice;
+    /** @see VerificationReportResponsePrice */
+    price?: VerificationReportResponsePrice;
     /** */
     identity?: Identity;
     /** */
@@ -31,5 +25,4 @@ export interface CalloutVerificationReportResponse {
     /** */
     callResult?: string;
 }
-export type MethodEnum = 'callout';
 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/callout-verification-report-response/callout-verification-report-response.js

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

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

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

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

@@ -1,18 +1,10 @@
-export type { MethodEnum as CalloutInitiateVerificationResponseMethodEnum, } from './callout-initiate-verification-response/callout-initiate-verification-response';
 export type { ActionEnum as CalloutRequestEventResponseActionEnum, } from './callout-request-event-response/callout-request-event-response';
-export type { MethodEnum as CalloutVerificationReportRequestMethodEnum, } from './callout-verification-report-request/callout-verification-report-request';
-export type { MethodEnum as CalloutVerificationReportResponseMethodEnum, ReasonEnum as CalloutVerificationReportResponseReasonEnum, } from './callout-verification-report-response/callout-verification-report-response';
-export type { MethodEnum as DataInitiateVerificationResponseMethodEnum, } from './data-initiate-verification-response/data-initiate-verification-response';
-export type { MethodEnum as FlashCallInitiateVerificationResponseMethodEnum, } from './flash-call-initiate-verification-response/flash-call-initiate-verification-response';
-export type { ActionEnum as FlashCallRequestEventResponseActionEnum, } from './flash-call-request-event-response/flash-call-request-event-response';
-export type { MethodEnum as FlashcallVerificationReportRequestMethodEnum, } from './flashcall-verification-report-request/flashcall-verification-report-request';
-export type { MethodEnum as FlashcallVerificationReportResponseMethodEnum, ReasonEnum as FlashcallVerificationReportResponseReasonEnum, SourceEnum as FlashcallVerificationReportResponseSourceEnum, } from './flashcall-verification-report-response/flashcall-verification-report-response';
+export type { ReasonEnum as CalloutVerificationReportResponseReasonEnum, } from './callout-verification-report-response/callout-verification-report-response';
+export type { ActionEnum as FlashCallRequestEventResponseActionEnum, } from './flashcall-request-event-response/flashcall-request-event-response';
+export type { ReasonEnum as FlashcallVerificationReportResponseReasonEnum, SourceEnum as FlashcallVerificationReportResponseSourceEnum, } from './flashcall-verification-report-response/flashcall-verification-report-response';
 export type { TypeEnum as IdentityTypeEnum } from './identity/identity';
-export type { MethodEnum as InitiateVerificationResourceMethodEnum, } from './initiate-verification-resource/initiate-verification-resource';
-export type { MethodEnum as SMSInitiateVerificationResponseMethodEnum, } from './sms-initiate-verification-response/sms-initiate-verification-response';
 export type { ActionEnum as SMSRequestEventResponseActionEnum, } from './sms-request-event-response/sms-request-event-response';
-export type { MethodEnum as SMSVerificationReportResponseMethodEnum, ReasonEnum as SMSVerificationReportResponseReasonEnum, SourceEnum as SMSVerificationReportResponseSourceEnum, } from './sms-verification-report-response/sms-verification-report-response';
-export type { MethodEnum as SmsVerificationReportRequestMethodEnum, } from './sms-verification-report-request/sms-verification-report-request';
+export type { ReasonEnum as SMSVerificationReportResponseReasonEnum, SourceEnum as SMSVerificationReportResponseSourceEnum, } from './sms-verification-report-response/sms-verification-report-response';
 export type { MethodEnum as VerificationRequestEventMethodEnum, } from './verification-request-event/verification-request-event';
 export type { MethodEnum as VerificationResultEventMethodEnum, ReasonEnum as VerificationResultEventReasonEnum, SourceEnum as VerificationResultEventSourceEnum, } from './verification-result-event/verification-result-event';
 export type VerificationStatusEnum = 'PENDING' | 'SUCCESSFUL' | 'FAIL' | 'DENIED' | 'ABORTED' | 'ERROR';

package/dist/models/v1/{flash-call-request-event-response-flash-call/flash-call-request-event-response-flash-call.d.ts → flashcall-request-event-response/flashcall-request-event-response.d.ts}

@@ -1,12 +1,14 @@
-/**
- * Model: FlashCallRequestEventResponseFlashCall
- *
- * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
- *
- */
-export interface FlashCallRequestEventResponseFlashCall {
+export interface FlashCallRequestEventResponse {
+    /** Determines whether the verification can be executed. */
+    action?: ActionEnum;
+    /** @see FlashCallContent */
+    flashCall?: FlashCallContent;
+}
+export type ActionEnum = 'allow' | 'deny';
+interface FlashCallContent {
     /** The phone number that will be displayed to the user when the flashcall is received on the user\'s phone. By default, the Sinch dashboard will randomly select the CLI that will be displayed during a flashcall from a pool of numbers. If you want to set your own CLI, you can specify it in the response to the Verification Request Event. */
     cli?: string;
     /** The maximum time that a flashcall verification will be active and can be completed. If the phone number hasn\'t been verified successfully during this time, then the verification request will fail. By default, the Sinch dashboard will automatically optimize dial time out during a flashcall. If you want to set your own dial time out for the flashcall, you can specify it in the response to the Verification Request Event. */
     dialTimeout?: number;
 }
+export {};

package/dist/models/v1/flashcall-request-event-response/flashcall-request-event-response.js

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

package/dist/models/v1/flashcall-request-event-response/flashcall-request-event-response.js.map

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

package/dist/models/v1/flashcall-request-event-response/index.d.ts

@@ -0,0 +1 @@
+export type { FlashCallRequestEventResponse } from './flashcall-request-event-response';

package/dist/models/v1/flashcall-request-event-response/index.js.map

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

package/dist/models/v1/flashcall-verification-report-response/flashcall-verification-report-response.d.ts

@@ -1,25 +1,19 @@
-/**
- * Model: FlashcallVerificationReportResponse
- *
- * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
- *
- */
-import { FlashcallVerificationReportResponsePrice } from '../flashcall-verification-report-response-price';
+import { VerificationReportResponsePrice } from '../verification-report-response-price';
 import { VerificationStatusEnum } from '../enums';
 import { Identity } from '../identity';
-export interface FlashcallVerificationReportResponse {
+export interface FlashCallVerificationReportResponse {
     /** The unique ID of the verification request. */
     id?: string;
-    /** The method of the verification request. This will always be `flashCall`. */
-    method?: MethodEnum;
+    /** The method of the verification request. This will always be `flashcall`. */
+    method?: 'flashcall';
     /** The status of the verification request. */
     status?: VerificationStatusEnum;
     /** Displays the reason why a verification has `FAILED`, was `DENIED`, or was `ABORTED`. */
     reason?: ReasonEnum;
     /** The reference ID that was optionally passed together with the verification request. */
     reference?: string;
-    /** @see FlashcallVerificationReportResponsePrice */
-    price?: FlashcallVerificationReportResponsePrice;
+    /** @see VerificationReportResponsePrice */
+    price?: VerificationReportResponsePrice;
     /** Free text that the client is sending, used to show if the call/SMS was intercepted or not. */
     source?: SourceEnum;
     /** */
@@ -33,6 +27,5 @@ export interface FlashcallVerificationReportResponse {
     /** */
     callResult?: string;
 }
-export type MethodEnum = 'flashcall';
 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';
 export type SourceEnum = 'intercepted' | 'manual';

package/dist/models/v1/flashcall-verification-report-response/flashcall-verification-report-response.js

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

package/dist/models/v1/flashcall-verification-report-response/flashcall-verification-report-response.js.map

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

package/dist/models/v1/flashcall-verification-report-response/index.d.ts

@@ -1 +1 @@
-export type { FlashcallVerificationReportResponse } from './flashcall-verification-report-response';
+export type { FlashCallVerificationReportResponse } from './flashcall-verification-report-response';

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

@@ -0,0 +1,13 @@
+import { ReportCalloutVerificationByIdentityRequestData, ReportCalloutVerificationByIdRequestData, ReportFlashCallVerificationByIdentityRequestData, ReportFlashCallVerificationByIdRequestData, ReportSmsVerificationByIdentityRequestData, ReportSmsVerificationByIdRequestData, StartCalloutVerificationRequestData, StartFlashCallVerificationRequestData, StartSeamlessVerificationRequestData, StartSmsVerificationRequestData } from '../../rest';
+export declare const verificationsHelper: {
+    buildStartSmsVerificationRequest: (phoneNumber: string, reference?: string) => StartSmsVerificationRequestData;
+    buildStartCalloutVerificationRequest: (phoneNumber: string, reference?: string) => StartCalloutVerificationRequestData;
+    buildStartFlashCallVerificationRequest: (phoneNumber: string, reference?: string, dialTimeout?: number) => StartFlashCallVerificationRequestData;
+    buildStartSeamlessVerificationRequest: (phoneNumber: string, reference?: string) => StartSeamlessVerificationRequestData;
+    buildReportSmsVerificationByIdRequest: (id: string, code: string, cli?: string) => ReportSmsVerificationByIdRequestData;
+    buildReportCalloutVerificationByIdRequest: (id: string, code: string) => ReportCalloutVerificationByIdRequestData;
+    buildReportFlashCallVerificationByIdRequest: (id: string, cli: string) => ReportFlashCallVerificationByIdRequestData;
+    buildReportSmsVerificationByIdentityRequest: (identity: string, code: string, cli?: string) => ReportSmsVerificationByIdentityRequestData;
+    buildReportCalloutVerificationByIdentityRequest: (identity: string, code: string) => ReportCalloutVerificationByIdentityRequestData;
+    buildReportFlashCallVerificationByIdentityRequest: (identity: string, cli: string) => ReportFlashCallVerificationByIdentityRequestData;
+};

package/dist/models/v1/helper.js

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.verificationsHelper = void 0;
+exports.verificationsHelper = {
+    buildStartSmsVerificationRequest: (phoneNumber, reference) => {
+        return {
+            startVerificationWithSmsRequestBody: {
+                identity: {
+                    type: 'number',
+                    endpoint: phoneNumber,
+                },
+                reference,
+            },
+        };
+    },
+    buildStartCalloutVerificationRequest: (phoneNumber, reference) => {
+        return {
+            startVerificationWithCalloutRequestBody: {
+                identity: {
+                    type: 'number',
+                    endpoint: phoneNumber,
+                },
+                reference,
+            },
+        };
+    },
+    buildStartFlashCallVerificationRequest: (phoneNumber, reference, dialTimeout) => {
+        return {
+            startVerificationWithFlashCallRequestBody: {
+                identity: {
+                    type: 'number',
+                    endpoint: phoneNumber,
+                },
+                reference,
+                ...(dialTimeout !== undefined) ? {
+                    flashCallOptions: {
+                        dialTimeout,
+                    },
+                } : {},
+            },
+        };
+    },
+    buildStartSeamlessVerificationRequest: (phoneNumber, reference) => {
+        return {
+            startSeamlessVerificationRequestBody: {
+                identity: {
+                    type: 'number',
+                    endpoint: phoneNumber,
+                },
+                reference,
+            },
+        };
+    },
+    buildReportSmsVerificationByIdRequest: (id, code, cli) => {
+        return {
+            id,
+            reportSmsVerificationByIdRequestBody: {
+                sms: {
+                    code,
+                    cli,
+                },
+            },
+        };
+    },
+    buildReportCalloutVerificationByIdRequest: (id, code) => {
+        return {
+            id,
+            reportCalloutVerificationByIdRequestBody: {
+                callout: {
+                    code,
+                },
+            },
+        };
+    },
+    buildReportFlashCallVerificationByIdRequest: (id, cli) => {
+        return {
+            id,
+            reportFlashCallVerificationByIdRequestBody: {
+                flashCall: {
+                    cli,
+                },
+            },
+        };
+    },
+    buildReportSmsVerificationByIdentityRequest: (identity, code, cli) => {
+        return {
+            endpoint: identity,
+            reportSmsVerificationByIdentityRequestBody: {
+                sms: {
+                    code,
+                    cli,
+                },
+            },
+        };
+    },
+    buildReportCalloutVerificationByIdentityRequest: (identity, code) => {
+        return {
+            endpoint: identity,
+            reportCalloutVerificationByIdentityRequestBody: {
+                callout: {
+                    code,
+                },
+            },
+        };
+    },
+    buildReportFlashCallVerificationByIdentityRequest: (identity, cli) => {
+        return {
+            endpoint: identity,
+            reportFlashCallVerificationByIdentityRequestBody: {
+                flashCall: {
+                    cli,
+                },
+            },
+        };
+    },
+};
+//# sourceMappingURL=helper.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"helper.js","sourceRoot":"","sources":["../../../src/models/v1/helper.ts"],"names":[],"mappings":";;;AAYa,QAAA,mBAAmB,GAAG;IACjC,gCAAgC,EAAE,CAChC,WAAmB,EACnB,SAAkB,EACe,EAAE;QACnC,OAAO;YACL,mCAAmC,EAAE;gBACnC,QAAQ,EAAE;oBACR,IAAI,EAAE,QAAQ;oBACd,QAAQ,EAAE,WAAW;iBACtB;gBACD,SAAS;aACV;SACF,CAAC;IACJ,CAAC;IACD,oCAAoC,EAAE,CACpC,WAAmB,EACnB,SAAkB,EACmB,EAAE;QACvC,OAAO;YACL,uCAAuC,EAAE;gBACvC,QAAQ,EAAE;oBACR,IAAI,EAAE,QAAQ;oBACd,QAAQ,EAAE,WAAW;iBACtB;gBACD,SAAS;aACV;SACF,CAAC;IACJ,CAAC;IACD,sCAAsC,EAAE,CACtC,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,qCAAqC,EAAE,CACrC,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;IACD,qCAAqC,EAAE,CACrC,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,yCAAyC,EAAE,CACzC,EAAU,EACV,IAAY,EAC8B,EAAE;QAC5C,OAAO;YACL,EAAE;YACF,wCAAwC,EAAE;gBACxC,OAAO,EAAE;oBACP,IAAI;iBACL;aACF;SACF,CAAC;IACJ,CAAC;IACD,2CAA2C,EAAE,CAC3C,EAAU,EACV,GAAW,EACiC,EAAE;QAC9C,OAAO;YACL,EAAE;YACF,0CAA0C,EAAE;gBAC1C,SAAS,EAAE;oBACT,GAAG;iBACJ;aACF;SACF,CAAC;IACJ,CAAC;IACD,2CAA2C,EAAE,CAC3C,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,+CAA+C,EAAE,CAC/C,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,iDAAiD,EAAE,CACjD,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

@@ -1,9 +1,3 @@
-/**
- * Model: Identity
- *
- * THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
- *
- */
 /**
  * Specifies the type of endpoint that will be verified and the particular endpoint. `number` is currently the only supported endpoint type.
  */

package/dist/models/v1/identity/identity.js

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

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

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

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

@@ -1,41 +1,26 @@
-export * from './callout-initiate-verification-response';
 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-request';
-export * from './callout-verification-report-request-callout';
 export * from './callout-verification-report-response';
-export * from './data-initiate-verification-response';
-export * from './data-initiate-verification-response-seamless';
-export * from './verification-error';
-export * from './flash-call-initiate-verification-response';
-export * from './flash-call-initiate-verification-response-flash-call';
-export * from './flash-call-request-event-response';
-export * from './flash-call-request-event-response-flash-call';
-export * from './flashcall-verification-report-request';
-export * from './flashcall-verification-report-request-flash-call';
+export * from './flashcall-request-event-response';
 export * from './flashcall-verification-report-response';
-export * from './flashcall-verification-report-response-price';
+export * from './verification-report-response-price';
 export * from './identity';
-export * from './initiate-verification-resource';
-export * from './initiate-verification-resource-flash-call-options';
-export * from './initiate-verification-response';
+export * from './start-verification-request';
 export * from './links-object';
 export * from './price';
-export * from './sms-initiate-verification-response';
-export * from './sms-initiate-verification-response-sms';
+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-request-event-response-sms';
 export * from './sms-verification-report-response';
-export * from './sms-verification-report-response-price';
-export * from './sms-verification-report-request';
-export * from './sms-verification-report-request-sms';
 export * from './verification-report-request';
 export * from './verification-report-response';
 export * from './verification-request-event';
-export * from './verification-request-event-price';
 export * from './verification-request-event-response';
-export * from './verification-response';
 export * from './verification-result-event';
 export * from './verification-result-event-response';
+export * from './verification-error';
 export * from './enums';
+export * from './helper';