@vonage/verify2 - npm Package Compare versions

Comparing version 1.8.0 to 1.9.0

dist/enums/channels.d.ts

@@ -0,11 +1,38 @@
+/**
+ * Enum representing different communication channels for verification.
+ */
 export declare enum Channels {
+    /**
+     * SMS channel for verification.
+     */
     SMS = "sms",
+    /**
+     * WhatsApp channel for verification.
+     */
     WHATSAPP = "whatsapp",
+    /**
+     * Interactive WhatsApp channel for verification.
+     */
     WHATSAPP_INTERACTIVE = "whatsapp_interactive",
+    /**
+     * Voice channel for verification.
+     */
     VOICE = "voice",
+    /**
+     * Email channel for verification.
+     */
     EMAIL = "email"
 }
+/**
+ * Enum representing the Silent Authentication channel.
+ */
 export declare enum SilentAuthChannel {
+    /**
+     * Silent Authentication channel for verification.
+     */
     SILENT_AUTH = "silent_auth"
 }
+/**
+ * Type alias for the Silent Authentication channel.
+ */
 export type SilenAuthChannel = SilentAuthChannel;

dist/enums/channels.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SilentAuthChannel = exports.Channels = void 0;
+/**
+ * Enum representing different communication channels for verification.
+ */
 var Channels;
 (function (Channels) {
+    /**
+     * SMS channel for verification.
+     */
     Channels["SMS"] = "sms";
+    /**
+     * WhatsApp channel for verification.
+     */
     Channels["WHATSAPP"] = "whatsapp";
+    /**
+     * Interactive WhatsApp channel for verification.
+     */
     Channels["WHATSAPP_INTERACTIVE"] = "whatsapp_interactive";
+    /**
+     * Voice channel for verification.
+     */
     Channels["VOICE"] = "voice";
+    /**
+     * Email channel for verification.
+     */
     Channels["EMAIL"] = "email";
 })(Channels || (exports.Channels = Channels = {}));
+/**
+ * Enum representing the Silent Authentication channel.
+ */
 var SilentAuthChannel;
 (function (SilentAuthChannel) {
+    /**
+     * Silent Authentication channel for verification.
+     */
     SilentAuthChannel["SILENT_AUTH"] = "silent_auth";
 })(SilentAuthChannel || (exports.SilentAuthChannel = SilentAuthChannel = {}));
-//# sourceMappingURL=channels.js.map

dist/enums/eventStatus.d.ts

@@ -0,6 +1,21 @@
+/**
+ * Enum representing the status of an event in the verification process.
+ */
 export declare enum EventStatus {
+    /**
+     * The event has been completed successfully.
+     */
     COMPLETED = "completed",
+    /**
+     * The event has failed.
+     */
     FAILED = "failed",
+    /**
+     * The user has rejected the event.
+     */
     USER_REJECTED = "user_rejected",
+    /**
+     * The event has been rejected.
+     */
     REJECTED = "rejected"
 }

dist/enums/eventStatus.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EventStatus = void 0;
+/**
+ * Enum representing the status of an event in the verification process.
+ */
 var EventStatus;
 (function (EventStatus) {
+    /**
+     * The event has been completed successfully.
+     */
     EventStatus["COMPLETED"] = "completed";
+    /**
+     * The event has failed.
+     */
     EventStatus["FAILED"] = "failed";
+    /**
+     * The user has rejected the event.
+     */
     EventStatus["USER_REJECTED"] = "user_rejected";
+    /**
+     * The event has been rejected.
+     */
     EventStatus["REJECTED"] = "rejected";
 })(EventStatus || (exports.EventStatus = EventStatus = {}));
-//# sourceMappingURL=eventStatus.js.map

dist/enums/index.js

@@ -24,2 +24,1 @@ "use strict";
 __exportStar(require("./verifyLocale"), exports);
-//# sourceMappingURL=index.js.map

dist/enums/requestStatus.d.ts

@@ -0,5 +1,17 @@
+/**
+ * Enum representing the status of a verification request.
+ */
 export declare enum RequestStatus {
+    /**
+     * The verification request has been completed successfully.
+     */
     COMPLETED = "completed",
+    /**
+     * The verification request has failed.
+     */
     FAILED = "failed",
+    /**
+     * The verification request has expired.
+     */
     EXPIRED = "expired"
 }

dist/enums/requestStatus.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RequestStatus = void 0;
+/**
+ * Enum representing the status of a verification request.
+ */
 var RequestStatus;
 (function (RequestStatus) {
+    /**
+     * The verification request has been completed successfully.
+     */
     RequestStatus["COMPLETED"] = "completed";
+    /**
+     * The verification request has failed.
+     */
     RequestStatus["FAILED"] = "failed";
+    /**
+     * The verification request has expired.
+     */
     RequestStatus["EXPIRED"] = "expired";
 })(RequestStatus || (exports.RequestStatus = RequestStatus = {}));
-//# sourceMappingURL=requestStatus.js.map

dist/enums/requestWorkflowsStatus.d.ts

@@ -0,7 +1,25 @@
+/**
+ * Enum representing the status of a verification request workflow step.
+ */
 export declare enum RequestWorkflowStatus {
+    /**
+     * The workflow step is unused.
+     */
     UNUSED = "unused",
+    /**
+     * The workflow step has been completed successfully.
+     */
     COMPLETED = "completed",
+    /**
+     * The workflow step has failed.
+     */
     FAILED = "failed",
+    /**
+     * The workflow step has expired.
+     */
     EXPIRED = "expired",
+    /**
+     * The user has rejected the workflow step.
+     */
     USER_REJECTED = "user_rejected"
 }

dist/enums/requestWorkflowsStatus.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RequestWorkflowStatus = void 0;
+/**
+ * Enum representing the status of a verification request workflow step.
+ */
 var RequestWorkflowStatus;
 (function (RequestWorkflowStatus) {
+    /**
+     * The workflow step is unused.
+     */
     RequestWorkflowStatus["UNUSED"] = "unused";
+    /**
+     * The workflow step has been completed successfully.
+     */
     RequestWorkflowStatus["COMPLETED"] = "completed";
+    /**
+     * The workflow step has failed.
+     */
     RequestWorkflowStatus["FAILED"] = "failed";
+    /**
+     * The workflow step has expired.
+     */
     RequestWorkflowStatus["EXPIRED"] = "expired";
+    /**
+     * The user has rejected the workflow step.
+     */
     RequestWorkflowStatus["USER_REJECTED"] = "user_rejected";
 })(RequestWorkflowStatus || (exports.RequestWorkflowStatus = RequestWorkflowStatus = {}));
-//# sourceMappingURL=requestWorkflowsStatus.js.map

dist/enums/silentAuthStatus.d.ts

@@ -0,7 +1,25 @@
+/**
+ * Enum representing the status of Silent Authentication.
+ */
 export declare enum SilenAuthStatus {
+    /**
+     * Silent Authentication has been completed successfully.
+     */
     COMPLETED = "completed",
+    /**
+     * Silent Authentication has failed.
+     */
     FAILED = "failed",
+    /**
+     * The user has rejected Silent Authentication.
+     */
     USER_REJECTED = "user_rejected",
+    /**
+     * Silent Authentication has expired.
+     */
     EXPIRED = "expired",
+    /**
+     * An action is pending for Silent Authentication.
+     */
     ACTION_PENDING = "action_pending"
 }

dist/enums/silentAuthStatus.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SilenAuthStatus = void 0;
+/**
+ * Enum representing the status of Silent Authentication.
+ */
 var SilenAuthStatus;
 (function (SilenAuthStatus) {
+    /**
+     * Silent Authentication has been completed successfully.
+     */
     SilenAuthStatus["COMPLETED"] = "completed";
+    /**
+     * Silent Authentication has failed.
+     */
     SilenAuthStatus["FAILED"] = "failed";
+    /**
+     * The user has rejected Silent Authentication.
+     */
     SilenAuthStatus["USER_REJECTED"] = "user_rejected";
+    /**
+     * Silent Authentication has expired.
+     */
     SilenAuthStatus["EXPIRED"] = "expired";
+    /**
+     * An action is pending for Silent Authentication.
+     */
     SilenAuthStatus["ACTION_PENDING"] = "action_pending";
 })(SilenAuthStatus || (exports.SilenAuthStatus = SilenAuthStatus = {}));
-//# sourceMappingURL=silentAuthStatus.js.map

dist/enums/verifyErrors.d.ts

 import { GenericErrors } from '@vonage/server-client';
+/**
+ * Type representing possible errors related to verification requests.
+ */
 export type VerifyErrors = {
+    /**
+     * Indicates that the verification request has expired.
+     */
     EXPIRED: 'expired';
+    /**
+     * Indicates a conflict error in the verification request.
+     */
     CONFLICT: 'conflict';
 } & GenericErrors;

dist/enums/verifyErrors.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=verifyErrors.js.map

dist/enums/verifyLocale.d.ts

@@ -0,15 +1,57 @@
+/**
+ * Enum representing different locales for verification.
+ */
 export declare enum VerifyLocale {
+    /**
+     * English (United States) locale.
+     */
     EN_US = "en-us",
+    /**
+     * English (United Kingdom) locale.
+     */
     EN_GB = "en-gb",
+    /**
+     * Spanish (Spain) locale.
+     */
     ES_ES = "es-es",
+    /**
+     * Spanish (Mexico) locale.
+     */
     ES_MX = "es-mx",
+    /**
+     * Spanish (United States) locale.
+     */
     ES_US = "es-us",
+    /**
+     * Italian (Italy) locale.
+     */
     IT_IT = "it-it",
+    /**
+     * French (France) locale.
+     */
     FR_FR = "fr-fr",
+    /**
+     * German (Germany) locale.
+     */
     DE_DE = "de-de",
+    /**
+     * Russian (Russia) locale.
+     */
     RU_RU = "ru-ru",
+    /**
+     * Hindi (India) locale.
+     */
     HI_IN = "hi-in",
+    /**
+     * Portuguese (Brazil) locale.
+     */
     PT_BR = "pt-br",
+    /**
+     * Portuguese (Portugal) locale.
+     */
     PT_PT = "pt-pt",
+    /**
+     * Indonesian (Indonesia) locale.
+     */
     ID_ID = "id-id"
 }

dist/enums/verifyLocale.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VerifyLocale = void 0;
+/**
+ * Enum representing different locales for verification.
+ */
 var VerifyLocale;
 (function (VerifyLocale) {
+    /**
+     * English (United States) locale.
+     */
     VerifyLocale["EN_US"] = "en-us";
+    /**
+     * English (United Kingdom) locale.
+     */
     VerifyLocale["EN_GB"] = "en-gb";
+    /**
+     * Spanish (Spain) locale.
+     */
     VerifyLocale["ES_ES"] = "es-es";
+    /**
+     * Spanish (Mexico) locale.
+     */
     VerifyLocale["ES_MX"] = "es-mx";
+    /**
+     * Spanish (United States) locale.
+     */
     VerifyLocale["ES_US"] = "es-us";
+    /**
+     * Italian (Italy) locale.
+     */
     VerifyLocale["IT_IT"] = "it-it";
+    /**
+     * French (France) locale.
+     */
     VerifyLocale["FR_FR"] = "fr-fr";
+    /**
+     * German (Germany) locale.
+     */
     VerifyLocale["DE_DE"] = "de-de";
+    /**
+     * Russian (Russia) locale.
+     */
     VerifyLocale["RU_RU"] = "ru-ru";
+    /**
+     * Hindi (India) locale.
+     */
     VerifyLocale["HI_IN"] = "hi-in";
+    /**
+     * Portuguese (Brazil) locale.
+     */
     VerifyLocale["PT_BR"] = "pt-br";
+    /**
+     * Portuguese (Portugal) locale.
+     */
     VerifyLocale["PT_PT"] = "pt-pt";
+    /**
+     * Indonesian (Indonesia) locale.
+     */
     VerifyLocale["ID_ID"] = "id-id";
 })(VerifyLocale || (exports.VerifyLocale = VerifyLocale = {}));
-//# sourceMappingURL=verifyLocale.js.map

dist/index.js

@@ -20,2 +20,1 @@ "use strict";
 __exportStar(require("./verify2"), exports);
-//# sourceMappingURL=index.js.map

dist/types/checkCodeRequest.d.ts

@@ -0,3 +1,9 @@
+/**
+ * Represents a request to check a code against a verification request.
+ */
 export type CheckCodeRequest = {
+    /**
+     * The code to be checked against the verification request.
+     */
     code: string;
 };

dist/types/checkCodeRequest.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=checkCodeRequest.js.map

dist/types/checkRequestResponse.d.ts

@@ -0,4 +1,13 @@
+/**
+ * Represents the response for checking a code against a verification request.
+ */
 export type CheckRequestResponse = {
+    /**
+     * The ID of the verification request.
+     */
     request_id: string;
+    /**
+     * The status of the verification request.
+     */
     status: string;
 };

dist/types/checkRequestResponse.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=checkRequestResponse.js.map

dist/types/emailWorkflow.d.ts

 import { Channels } from '../enums';
+/**
+ * Represents a workflow for sending a verification code via email.
+ */
 export type EmailWorkflow = {
+    /**
+     * The communication channel for sending the verification code.
+     */
     channel: Channels.EMAIL;
+    /**
+     * The recipient's email address where the verification code will be sent.
+     */
     to: string;
+    /**
+     * (Optional) The sender's email address for the verification email.
+     */
     from?: string;
 };

dist/types/emailWorkflow.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=emailWorkflow.js.map

dist/types/eventCallback.d.ts

 import { Channels, EventStatus } from '../enums';
+/**
+ * Represents an event callback received for a verification request.
+ */
 export type EventCallback = {
+    /**
+     * The ID of the verification request associated with the event.
+     */
     request_id: string;
+    /**
+     * The date and time when the event was triggered in ISO 8601 format.
+     */
     triggerd_at: string;
+    /**
+     * The type of response for the event.
+     */
     type: string;
+    /**
+     * The communication channel for the verification request.
+     */
     channel: Channels;
+    /**
+     * The status of the event.
+     */
     status: EventStatus;
+    /**
+     * The date and time when the verification request was completed
+     * in ISO 8601 format.
+     */
     finalized_at: string;
+    /**
+     * (Optional) The client reference given in the original Verify request.
+     */
     client_ref?: string;
 };

dist/types/eventCallback.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=eventCallback.js.map

dist/types/index.js

@@ -33,2 +33,1 @@ "use strict";
 __exportStar(require("./whatsAppWorkflow"), exports);
-//# sourceMappingURL=index.js.map

dist/types/request.d.ts

@@ -0,3 +1,9 @@
+/**
+ * Represents a request object with a unique request ID.
+ */
 export type Request = {
+    /**
+     * The unique identifier for the request.
+     */
     requestId: string;
 };

dist/types/request.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=request.js.map

dist/types/requestStatusCallback.d.ts

 import { RequestStatus } from '../enums';
 import { RequestStatusCallbackWorkflow } from './requestStatusCallbackWorkflow';
+/**
+ * Represents a callback received for the status update of a
+ * verification request.
+ */
 export type RequestStatusCallback = {
+    /**
+     * The ID of the verification request associated with the callback.
+     */
     request_id: string;
+    /**
+     * The date and time when the verification request was submitted
+     * in ISO 8601 format.
+     */
     submitted_at: string;
+    /**
+     * The status of the verification request.
+     */
     status: RequestStatus;
+    /**
+     * The type of response for the callback.
+     */
     type: string;
+    /**
+     * The number of seconds before the current step in the verification
+     * request times out.
+     */
     channel_timeout: number;
+    /**
+     * An array of workflow details for the verification request.
+     */
     workflow: Array<RequestStatusCallbackWorkflow>;
 };

dist/types/requestStatusCallback.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=requestStatusCallback.js.map

dist/types/requestStatusCallbackWorkflow.d.ts

 import { Channels, RequestWorkflowStatus } from '../enums';
+/**
+ * Represents a workflow step within a verification request's status callback.
+ */
 export type RequestStatusCallbackWorkflow = {
+    /**
+     * The communication channel associated with this workflow step.
+     */
     channel: Channels;
+    /**
+     * The date and time when this workflow step was initiated in ISO 8601 format.
+     */
     initiated_at: string;
+    /**
+     * The status of this workflow step within the verification request.
+     */
     status: RequestWorkflowStatus;
 };

dist/types/requestStatusCallbackWorkflow.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=requestStatusCallbackWorkflow.js.map

dist/types/silentAuthCallback.d.ts

 import { SilentAuthChannel, SilenAuthStatus } from '../enums';
+/**
+ * Represents a callback received for Silent Authentication.
+ */
 export type SilentAuthCallback = {
+    /**
+     * The ID of the Silent Authentication request associated with the callback.
+     */
     request_id: string;
+    /**
+     * The date and time when the Silent Authentication event was triggered
+     * in ISO 8601 format.
+     */
     triggerd_at: string;
+    /**
+     * The type of response for the Silent Authentication event.
+     */
     type: string;
+    /**
+     * The communication channel for Silent Authentication (always 'silent_auth').
+     */
     channel: SilentAuthChannel.SILENT_AUTH;
+    /**
+     * The status of the Silent Authentication event.
+     */
     status: SilenAuthStatus;
+    /**
+     * Information about the action in the Silent Authentication event.
+     */
     action: {
+        /**
+         * The type of action, which is 'check' for Silent Authentication.
+         */
         type: 'check';
+        /**
+         * The URL for Silent Authentication Verify workflow completion.
+         */
         check_url: string;
     };
 };

dist/types/silentAuthCallback.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=silentAuthCallback.js.map

dist/types/silentAuthWorkflow.d.ts

 import { SilentAuthChannel } from '../enums';
+/**
+ * Represents a workflow for Silent Authentication.
+ */
 export type SilentAuthWorkflow = {
+    /**
+     * The communication channel for Silent Authentication.
+     */
     channel: SilentAuthChannel;
+    /**
+     * The target identifier for Silent Authentication.
+     */
     to: string;
 };

dist/types/silentAuthWorkflow.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=silentAuthWorkflow.js.map

dist/types/smsWorkflow.d.ts

 import { Channels } from '../enums';
+/**
+ * Represents a workflow for sending a verification code via SMS.
+ */
 export type SMSWorkflow = {
+    /**
+     * The communication channel for sending the verification code.
+     */
     channel: Channels.SMS;
+    /**
+     * The recipient's phone number where the verification code will be sent,
+     * in the E.164 format.
+     */
     to: string;
+    /**
+     * (Optional) An application-specific hash value for the SMS workflow.
+     */
     appHash?: string;
 };

dist/types/smsWorkflow.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=smsWorkflow.js.map

dist/types/verifcationRequest.d.ts

@@ -8,13 +8,45 @@ import { VerifyLocale } from '../enums';
 import { WhatsAppWorkflow } from './whatsAppWorkflow';
+/**
+ * Represents a verification request for sending verification codes via
+ * different communication channels.
+ */
 export type VerificationRequest = {
+    /**
+     * The brand associated with the verification request.
+     */
     brand: string;
+    /**
+     * An array of workflow configurations for sending verification codes via
+     * different channels. Each element in the array corresponds to a specific
+     * channel workflow.
+     */
     workflow: Array<EmailWorkflow | (Omit<SMSWorkflow, 'appHash'> & {
         app_hash: string;
     }) | SilentAuthWorkflow | VoiceWorkflow | WhatsAppInteractiveWorkflow | WhatsAppWorkflow>;
+    /**
+     * (Optional) The verification code to be sent.
+     */
     code?: string;
+    /**
+     * (Optional) The locale for the verification request.
+     */
     locale?: VerifyLocale;
+    /**
+     * (Optional) The timeout duration for the verification channel in seconds.
+     */
     channel_timeout?: number;
+    /**
+     * (Optional) The client reference associated with the verification request.
+     */
     client_ref?: string;
+    /**
+     * (Optional) The length of the verification code, if not provided,
+     * defaults to 4 digits.
+     */
     code_length?: 4 | 5 | 6 | 7 | 8 | 9 | 10;
+    /**
+     * (Optional) Indicates whether fraud checking is enabled for the
+     * verification request.
+     */
     fraud_check?: boolean;
 };

dist/types/verifcationRequest.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=verifcationRequest.js.map

dist/types/verifcationRequestParams.d.ts

@@ -8,11 +8,43 @@ import { VerifyLocale } from '../enums';
 import { WhatsAppWorkflow } from './whatsAppWorkflow';
+/**
+ * Represents parameters for creating a verification request for sending
+ * verification codes via different communication channels.
+ */
 export type VerificationRequestParams = {
+    /**
+     * The brand associated with the verification request.
+     */
     brand: string;
+    /**
+     * An array of workflow configurations for sending verification codes via
+     * different channels. Each element in the array corresponds to a specific
+     * channel workflow.
+     */
     workflow: Array<EmailWorkflow | SMSWorkflow | SilentAuthWorkflow | VoiceWorkflow | WhatsAppInteractiveWorkflow | WhatsAppWorkflow>;
+    /**
+     * (Optional) The verification code to be sent.
+     */
     code?: string;
+    /**
+     * (Optional) The locale for the verification request.
+     */
     locale?: VerifyLocale;
+    /**
+     * (Optional) The timeout duration for the verification channel in seconds.
+     */
     channelTimeout?: number;
+    /**
+     * (Optional) The client reference associated with the verification request.
+     */
     clientRef?: string;
+    /**
+     * (Optional) The length of the verification code, if not provided,
+     * defaults to 4 digits.
+     */
     codeLength?: 4 | 5 | 6 | 7 | 8 | 9 | 10;
+    /**
+     * (Optional) Indicates whether fraud checking is enabled for the
+     * verification request.
+     */
     fraudCheck?: boolean;
 };

dist/types/verifcationRequestParams.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=verifcationRequestParams.js.map

dist/types/verificationResponse.d.ts

@@ -0,3 +1,9 @@
+/**
+ * Represents a response for a verification request.
+ */
 export type VerificationResponse = {
+    /**
+     * The unique identifier for the verification request.
+     */
     request_id: string;
 };

dist/types/verificationResponse.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=verificationResponse.js.map

dist/types/voiceWorkflow.d.ts

 import { Channels } from '../enums';
+/**
+ * Represents a workflow for sending a verification code via voice call.
+ */
 export type VoiceWorkflow = {
+    /**
+     * The communication channel for sending the verification code.
+     */
     channel: Channels.VOICE;
+    /**
+     * The recipient's phone number where the verification code will be sent,
+     * in the E.164 format.
+     */
     to: string;
 };

dist/types/voiceWorkflow.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=voiceWorkflow.js.map

dist/types/whatsAppInteractiveWorkflow.d.ts

 import { Channels } from '../enums';
+/**
+ * Represents a workflow for sending a verification code via interactive
+ * WhatsApp.
+ */
 export type WhatsAppInteractiveWorkflow = {
+    /**
+     * The communication channel for sending the verification code.
+     */
     channel: Channels.WHATSAPP_INTERACTIVE;
+    /**
+     * The recipient's phone number where the verification code will be sent,
+     * typically in the E.164 format.
+     */
     to: string;
 };

dist/types/whatsAppInteractiveWorkflow.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=whatsAppInteractiveWorkflow.js.map

dist/types/whatsAppWorkflow.d.ts

 import { Channels } from '../enums';
+/**
+ * Represents a workflow for sending a verification code via WhatsApp.
+ */
 export type WhatsAppWorkflow = {
+    /**
+     * The communication channel for sending the verification code.
+     */
     channel: Channels.WHATSAPP;
+    /**
+     * The recipient's phone number where the verification code will be sent,
+     * typically in the E.164 format.
+     */
     to: string;
+    /**
+     * (Optional) The sender's phone number or identifier for the WhatsApp
+     * message.
+     */
     from?: string;
 };

dist/types/whatsAppWorkflow.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=whatsAppWorkflow.js.map

dist/verify2.d.ts

 import { AuthenticationType, Client } from '@vonage/server-client';
 import { Request, VerificationRequestParams } from './types';
+/**
+ * A class for interacting with the Vonage Verify API (Version 2).
+ */
 export declare class Verify2 extends Client {
+    /**
+     * The authentication type used for this client (JWT).
+     */
     protected authType: AuthenticationType;
+    /**
+     * Creates a new verification request.
+     *
+     * @param {VerificationRequestParams} params - The parameters for the
+     *  verification request.
+     * @return {Request} A `Request` object containing the request ID.
+     */
     newRequest(params: VerificationRequestParams): Promise<Request>;
+    /**
+     * Checks a verification code against a verification request.
+     * @param {string} requestId - The ID of the verification request.
+     * @param {string} code - The verification code to check.
+     * @return {string} The status of the verification code check.
+     */
     checkCode(requestId: string, code: string): Promise<string>;
+    /**
+     * Cancels a verification request.
+     * @param {string} requestId - The ID of the verification request to cancel.
+     * @return {boolean} `true` if the cancellation was successful.
+     */
     cancel(requestId: string): Promise<boolean>;
 }

dist/verify2.js

@@ -5,4 +5,20 @@ "use strict";
 const server_client_1 = require("@vonage/server-client");
+/**
+ * A class for interacting with the Vonage Verify API (Version 2).
+ */
 class Verify2 extends server_client_1.Client {
-    authType = server_client_1.AuthenticationType.JWT;
+    constructor() {
+        super(...arguments);
+        /**
+         * The authentication type used for this client (JWT).
+         */
+        this.authType = server_client_1.AuthenticationType.JWT;
+    }
+    /**
+     * Creates a new verification request.
+     *
+     * @param {VerificationRequestParams} params - The parameters for the
+     *  verification request.
+     * @return {Request} A `Request` object containing the request ID.
+     */
     async newRequest(params) {
@@ -14,2 +30,8 @@ const resp = await this.sendPostRequest(`${this.config.apiHost}/v2/verify`, server_client_1.Client.transformers.snakeCaseObjectKeys(params, true));
     }
+    /**
+     * Checks a verification code against a verification request.
+     * @param {string} requestId - The ID of the verification request.
+     * @param {string} code - The verification code to check.
+     * @return {string} The status of the verification code check.
+     */
     async checkCode(requestId, code) {
@@ -21,2 +43,7 @@ const resp = await this.sendPostRequest(`${this.config.apiHost}/v2/verify/${requestId}`, {
     }
+    /**
+     * Cancels a verification request.
+     * @param {string} requestId - The ID of the verification request to cancel.
+     * @return {boolean} `true` if the cancellation was successful.
+     */
     async cancel(requestId) {
@@ -33,2 +60,1 @@ try {
 exports.Verify2 = Verify2;
-//# sourceMappingURL=verify2.js.map

package.json

 {
+  "$schema": "https://json.schemastore.org/package.json",
   "name": "@vonage/verify2",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "Verify API provides a choice of routes for sending a code to a user. You can use this to confirm a user's contact information, as a second factor when authenticating users, or for step-up authentication.",
@@ -14,3 +15,12 @@ "homepage": "https://github.com/vonage/vonage-node-sdk/tree/main/packages/verify2#readme",
   "license": "Apache-2.0",
-  "author": "Chuck MANCHUCK Reeves <[e-mail]>",
+  "contributors": [
+    {
+      "name": "Chuck \"MANCHUCK\" Reeves",
+      "url": "https://github.com/manchuck"
+    },
+    {
+      "name": "Chris Tankersley",
+      "url": "https://github.com/dragonmantank"
+    }
+  ],
   "main": "dist/index.js",
@@ -28,11 +38,12 @@ "types": "dist/index.d.ts",
     "clean": "npx shx rm -rf dist tsconfig.tsbuildinfo",
-    "compile": "npx tsc --build --verbose"
+    "compile": "npx tsc --build --verbose",
+    "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "@vonage/server-client": "^1.9.0"
+    "@vonage/server-client": "^1.10.0"
   },
   "devDependencies": {
-    "@vonage/auth": "^1.7.0",
+    "@vonage/auth": "^1.8.0",
     "nock": "^13.3.4"
   }
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

33531

increased by28.81%

Lines of code

992

increased by135.07%

Worsened metrics

Number of package files

56

decreased by-32.53%

Dependency changes

• Updated@vonage/server-client@^1.10.0