@sinch/verification 1.2.1 → 1.3.0

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

@@ -6,3 +6,4 @@ export * from './sms-request-event-response';
 export * from './verification-request-event-response';
 export * from './verification-result-event';
 export * from './verification-result-event-response';
+export * from './verification-sms-delivered-event';

package/dist/models/v1/mod-callbacks/index.js

@@ -25,4 +25,6 @@ __exportStar(require("./verification-request-event-response"), exports);
 // 'Verification Result Event' received from Sinch server (no response data needed)
 __exportStar(require("./verification-result-event"), exports);
 __exportStar(require("./verification-result-event-response"), exports);
+// 'Verification Sms Delivered Event' received from Sinch server
+__exportStar(require("./verification-sms-delivered-event"), exports);
 //# sourceMappingURL=index.js.map

package/dist/models/v1/mod-callbacks/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/mod-callbacks/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gEAA8C;AAC9C,0DAA0D;AAC1D,+DAA6C;AAC7C,sEAAsE;AACtE,qEAAmD;AACnD,qEAAmD;AACnD,+DAA6C;AAC7C,wEAAsD;AACtD,mFAAmF;AACnF,8DAA4C;AAC5C,uEAAqD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/mod-callbacks/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gEAA8C;AAC9C,0DAA0D;AAC1D,+DAA6C;AAC7C,sEAAsE;AACtE,qEAAmD;AACnD,qEAAmD;AACnD,+DAA6C;AAC7C,wEAAsD;AACtD,mFAAmF;AACnF,8DAA4C;AAC5C,uEAAqD;AACrD,gEAAgE;AAChE,qEAAmD"}

package/dist/models/v1/mod-callbacks/sms-request-event-response/sms-request-event-response.d.ts

@@ -6,7 +6,7 @@ export interface SmsRequestEventResponse {
     sms?: SmsProperties;
 }
 export interface SmsProperties {
-    /** The SMS PIN that should be used. By default, the Sinch dashboard will automatically generate PIN codes for SMS verification. If you want to set your own PIN, you can specify it in the response to the Verification Request Event. */
+    /** The SMS OTP that should be used. By default, the Sinch dashboard will automatically generate OTP codes for SMS verification. If you want to set your own OTP, you can specify it in the response to the Verification Request Event. */
     code?: string;
     /** List of strings */
     acceptLanguage?: string[];

package/dist/models/v1/mod-callbacks/verification-callback-event.d.ts

@@ -1,3 +1,4 @@
 import { VerificationRequestEvent } from './verification-request-event';
 import { VerificationResultEvent } from './verification-result-event';
-export type VerificationCallbackEvent = VerificationRequestEvent | VerificationResultEvent;
+import { VerificationSmsDeliveredEvent } from './verification-sms-delivered-event';
+export type VerificationCallbackEvent = VerificationRequestEvent | VerificationResultEvent | VerificationSmsDeliveredEvent;

package/dist/models/v1/mod-callbacks/verification-request-event/index.d.ts

@@ -1 +1 @@
-export type { VerificationRequestEvent, MethodEnum } from './verification-request-event';
+export type { VerificationRequestEvent, VerificationRequestMethod, MethodEnum } from './verification-request-event';

package/dist/models/v1/mod-callbacks/verification-request-event/verification-request-event.d.ts

@@ -6,7 +6,7 @@ export interface VerificationRequestEvent {
     /** The type of the event. */
     event: 'VerificationRequestEvent';
     /** The verification method. */
-    method: MethodEnum;
+    method: VerificationRequestMethod;
     /** @see Identity */
     identity: Identity;
     /** The amount of money and currency of the verification request. */
@@ -20,4 +20,6 @@ export interface VerificationRequestEvent {
     /** List of strings */
     acceptLanguage?: string[];
 }
+/** @deprecated Use VerificationRequestMethod instead */
 export type MethodEnum = 'sms' | 'flashcall' | 'callout';
+export type VerificationRequestMethod = 'sms' | 'flashcall' | 'callout';

package/dist/models/v1/mod-callbacks/verification-result-event/index.d.ts

@@ -1 +1 @@
-export type { VerificationResultEvent } from './verification-result-event';
+export type { VerificationResultEvent, VerificationResultMethod } from './verification-result-event';

package/dist/models/v1/mod-callbacks/verification-result-event/verification-result-event.d.ts

@@ -6,7 +6,7 @@ export interface VerificationResultEvent {
     /** The type of the event. */
     event: 'VerificationResultEvent';
     /** The verification method. */
-    method: MethodEnum;
+    method: VerificationResultMethod;
     /** @see Identity */
     identity: Identity;
     /** The status of the verification request. */
@@ -20,4 +20,4 @@ export interface VerificationResultEvent {
     /** A custom string that can be provided during a verification request. */
     custom?: string;
 }
-export type MethodEnum = 'sms' | 'flashcall' | 'callout' | 'seamless';
+export type VerificationResultMethod = 'sms' | 'flashcall' | 'callout' | 'seamless';

package/dist/models/v1/mod-callbacks/verification-sms-delivered-event/index.d.ts

@@ -0,0 +1 @@
+export type { VerificationSmsDeliveredEvent } from './verification-sms-delivered-event';

package/dist/models/v1/mod-callbacks/verification-sms-delivered-event/index.js

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

package/dist/models/v1/mod-callbacks/verification-sms-delivered-event/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/models/v1/mod-callbacks/verification-sms-delivered-event/index.ts"],"names":[],"mappings":""}

package/dist/models/v1/mod-callbacks/verification-sms-delivered-event/verification-sms-delivered-event.d.ts

@@ -0,0 +1,17 @@
+import { Identity } from '../../identity';
+export interface VerificationSmsDeliveredEvent {
+    /** The ID of the verification request. */
+    id: string;
+    /** The type of the event. */
+    event: 'VerificationSmsDeliveredEvent';
+    /** The verification method. */
+    method: 'sms' | string;
+    /** @see Identity */
+    identity: Identity;
+    /** The result of the SMS delivery. Possible values can be extended in the future. */
+    smsResult: 'Successful' | 'Failed' | string;
+    /** Used to pass your own reference in the request for tracking purposes. */
+    reference?: string;
+    /** Can be used to pass custom data in the request. */
+    custom?: string;
+}

package/dist/models/v1/mod-callbacks/verification-sms-delivered-event/verification-sms-delivered-event.js

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

package/dist/models/v1/mod-callbacks/verification-sms-delivered-event/verification-sms-delivered-event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"verification-sms-delivered-event.js","sourceRoot":"","sources":["../../../../../src/models/v1/mod-callbacks/verification-sms-delivered-event/verification-sms-delivered-event.ts"],"names":[],"mappings":""}

package/dist/models/v1/start-verification-request/start-verification-request.d.ts

@@ -47,7 +47,7 @@ export interface SmsOptions {
 }
 export type CodeType = 'Numeric' | 'Alpha' | 'Alphanumeric';
 /**
- * An optional object for flashCall verifications. It allows you to specify dial time out parameter for flashCall. FlashCallOptions object can be specified optionally, and only if the verification request was triggered from your backend (no SDK client) through an [Application signed request](/docs/voice/api-reference/authentication/signed-request).
+ * An optional object for Flash Call Verification, considered only when the verification request originates from your backend (not an SDK client) via an [Application signed request](https://developers.sinch.com/docs/voice/api-reference/authentication/signed-request).
  */
 export interface FlashCallOptions {
     /** The dial timeout in seconds. */

package/dist/models/v1/verification-report-request/verification-report-request.d.ts

@@ -13,7 +13,7 @@ export interface FlashCallVerificationReportRequest {
     flashCall: FlashCallContent;
 }
 interface FlashCallContent {
-    /** The caller ID of the FlashCall. */
+    /** The caller ID of the flash call. Caller ID in flash call verification refers to the phone number from which the call was made to the user's device. The verification system uses this incoming number as One Time Password (OTP) */
     cli: string;
 }
 export interface PhoneCallVerificationReportRequest {

package/dist/rest/v1/callbacks/callbacks-webhook.d.ts

@@ -1,7 +1,7 @@
 import { VerificationCallbackEvent, VerificationRequestEvent, VerificationResultEvent } from '../../../models';
 import { CallbackProcessor, SinchClientParameters } from '@sinch/sdk-client';
 import { IncomingHttpHeaders } from 'http';
-/** @deprecated Use Verification.VerificationCallback instead */
+/** @deprecated Use Verification.VerificationCallbackEvent instead */
 export type VerificationCallback = VerificationRequestEvent | VerificationResultEvent;
 export declare class VerificationCallbackWebhooks implements CallbackProcessor<VerificationCallbackEvent> {
     private readonly sinchClientParameters;

package/dist/rest/v1/callbacks/callbacks-webhook.js

@@ -27,12 +27,17 @@ class VerificationCallbackWebhooks {
      * @return {VerificationCallbackEvent} - The parsed verification event object.
      */
     parseEvent(eventBody) {
+        if (typeof eventBody === 'string') {
+            eventBody = JSON.parse(eventBody);
+        }
         if (eventBody.event) {
             switch (eventBody.event) {
                 case 'VerificationRequestEvent':
                     return eventBody;
                 case 'VerificationResultEvent':
                     return eventBody;
+                case 'VerificationSmsDeliveredEvent':
+                    return eventBody;
                 default:
                     throw new Error(`Unknown Verification event type: ${eventBody.event}`);
             }

package/dist/rest/v1/callbacks/callbacks-webhook.js.map

@@ -1 +1 @@
-{"version":3,"file":"callbacks-webhook.js","sourceRoot":"","sources":["../../../../src/rest/v1/callbacks/callbacks-webhook.ts"],"names":[],"mappings":";;;AACA,kDAA2G;AAM3G,MAAa,4BAA4B;IAIvC,YAAY,qBAA4C;QACtD,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;IACrD,CAAC;IAED;;;;;;;OAOG;IACI,4BAA4B,CACjC,OAA4B,EAC5B,IAAS,EACT,IAAY,EACZ,MAAc;QAEd,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,iBAAiB,EAAE,CAAC;YAChG,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;QACpE,CAAC;QACD,OAAO,IAAA,yCAA4B,EACjC,IAAI,CAAC,qBAAqB,CAAC,cAAc,EACzC,IAAI,CAAC,qBAAqB,CAAC,iBAAiB,EAC5C,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACI,UAAU,CAAC,SAAc;QAC9B,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;YACpB,QAAQ,SAAS,CAAC,KAAK,EAAE,CAAC;gBAC1B,KAAK,0BAA0B;oBAC7B,OAAO,SAAqC,CAAC;gBAC/C,KAAK,yBAAyB;oBAC5B,OAAO,SAAoC,CAAC;gBAC9C;oBACE,MAAM,IAAI,KAAK,CAAC,oCAAoC,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC;YACzE,CAAC;QACH,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,0CAA0C,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACnF,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAChD,CAAC;CAEF;AApDD,oEAoDC"}
+{"version":3,"file":"callbacks-webhook.js","sourceRoot":"","sources":["../../../../src/rest/v1/callbacks/callbacks-webhook.ts"],"names":[],"mappings":";;;AAMA,kDAA2G;AAM3G,MAAa,4BAA4B;IAIvC,YAAY,qBAA4C;QACtD,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;IACrD,CAAC;IAED;;;;;;;OAOG;IACI,4BAA4B,CACjC,OAA4B,EAC5B,IAAS,EACT,IAAY,EACZ,MAAc;QAEd,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,iBAAiB,EAAE,CAAC;YAChG,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;QACpE,CAAC;QACD,OAAO,IAAA,yCAA4B,EACjC,IAAI,CAAC,qBAAqB,CAAC,cAAc,EACzC,IAAI,CAAC,qBAAqB,CAAC,iBAAiB,EAC5C,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACI,UAAU,CAAC,SAAc;QAC9B,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;YAClC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACpC,CAAC;QACD,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;YACpB,QAAQ,SAAS,CAAC,KAAK,EAAE,CAAC;gBAC1B,KAAK,0BAA0B;oBAC7B,OAAO,SAAqC,CAAC;gBAC/C,KAAK,yBAAyB;oBAC5B,OAAO,SAAoC,CAAC;gBAC9C,KAAK,+BAA+B;oBAClC,OAAO,SAA0C,CAAC;gBACpD;oBACE,MAAM,IAAI,KAAK,CAAC,oCAAoC,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC;YACzE,CAAC;QACH,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,0CAA0C,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACnF,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAChD,CAAC;CAEF;AAzDD,oEAyDC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sinch/verification",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "Sinch Verification API",
   "homepage": "",
   "repository": {
@@ -29,7 +29,7 @@
     "test:e2e": "cucumber-js"
   },
   "dependencies": {
-    "@sinch/sdk-client": "^1.2.1"
+    "@sinch/sdk-client": "^1.3.0"
   },
   "devDependencies": {},
   "publishConfig": {