@paydock/client-sdk 1.104.3-beta → 1.104.7-beta

package/bundles/index.mjs.d.ts

@@ -1,3 +1,5 @@
+import { MicroAgent } from '@newrelic/browser-agent/loaders/micro-agent';
+
 declare class ApiCharge {
     protected api: Api;
     constructor(api: Api);
@@ -54,6 +56,57 @@ declare class Env implements IEnvironment {
     private isValidMode;
 }
 
+type HttpRequestMethod = 'DELETE' | 'GET' | 'OPTIONS' | 'POST' | 'PUT';
+
+type AgentPrototype = Pick<(typeof MicroAgent)['prototype'], 'addPageAction' | 'noticeError'>;
+type AgentMethodNames = keyof AgentPrototype;
+type AgentMethodParameters<T extends AgentMethodNames> = Parameters<AgentPrototype[T]>;
+declare class InstrumentationAgent extends MicroAgent {
+    private static agent;
+    private static available;
+    private static initialized;
+    private constructor();
+    static get instance(): InstrumentationAgent;
+    isAvailable(): boolean;
+    call: <T extends "addPageAction" | "noticeError">(method: T, ...args: AgentMethodParameters<T>) => void;
+}
+
+interface CustomEventDTO {
+    environment: string;
+    appId?: never;
+    timestamp?: never;
+    [x: string]: unknown;
+}
+interface ReportBaseContext {
+    environment: string;
+    sdkVersion: string | null;
+    description?: string;
+    [x: string]: SerializableValue | undefined;
+}
+type SerializableValue = string | number | symbol | object | null;
+
+type ReportErrorFn = (repository: ErrorRepository, error: string | Error, ctx: ReportBaseContext & ({
+    className: string;
+    classMethod: string;
+    functionName?: never;
+} | {
+    className?: never;
+    classMethod?: never;
+    functionName: string;
+})) => void;
+declare class ErrorRepository {
+    private readonly agent;
+    constructor();
+    createError(...args: Parameters<InstrumentationAgent['noticeError']>): Promise<void>;
+}
+
+type ReportEventFn = (repository: EventRepository, actionName: string, ctx: ReportBaseContext & CustomEventDTO) => void;
+declare class EventRepository {
+    private readonly agent;
+    constructor();
+    createEvent(...args: Parameters<InstrumentationAgent['addPageAction']>): Promise<void>;
+}
+
 declare enum API_AUTH_TYPE {
     PUBLIC_KEY = 0,
     TOKEN = 1
@@ -74,11 +127,11 @@ declare class ApiBase {
      */
     setEnv(env: string, alias?: string): ApiBase;
     setAuthType(): API_AUTH_TYPE;
-    getClient(method: 'GET' | 'POST', link: string): {
+    getClient(method: Extract<HttpRequestMethod, 'GET' | 'POST'>, link: string): {
         config: XMLHttpRequest;
-        send: (body: any, cb?: (data: any) => void, errorCb?: (data: any) => void) => void;
+        send: (body: any, cb?: (data) => void, errorCb?: (data: any) => any) => void;
     };
-    getClientPromise<Req extends object, Res>(method: 'GET' | 'POST', link: string): {
+    getClientPromise<Req extends object, Res>(method: Extract<HttpRequestMethod, 'GET' | 'POST'>, link: string): {
         config: XMLHttpRequest;
         send: (body: Req) => Promise<Res>;
     };
@@ -90,7 +143,14 @@ declare class ApiBase {
         text: string;
         status: number;
     }): Promise<Res>;
-    setAuthHeader(request: XMLHttpRequest): void;
+    reportEvent: ReportEventFn;
+    reportError: ReportErrorFn;
+    protected newApiRequest(method: Extract<HttpRequestMethod, 'GET' | 'POST'>, link: string): XMLHttpRequest;
+    protected get ctx(): {
+        sdkVersion: string;
+        className: string;
+        environment: string;
+    };
 }
 
 interface BrowserDetails {
@@ -126,7 +186,7 @@ interface BrowserDetails {
  **/
 declare class Api extends ApiBase {
     publicKey: String;
-    constructor(publicKey: string);
+    /** @constructs */ constructor(publicKey: string);
     /**
      * Method for getting browser details
      *
@@ -145,51 +205,48 @@ declare class Api extends ApiBase {
     charge(): ApiCharge;
 }
 
-interface IVisaSRCMeta {
-    srci_transaction_id?: string;
-    dpa_data?: {
-        dpa_presentation_name?: string;
-        dpa_uri?: string;
-    };
-    dpa_transaction_options?: {
-        dpa_locale?: string;
-        dpa_accepted_billing_countries?: string[];
-        dpa_accepted_shipping_countries?: string[];
-        dpa_billing_preference?: DPA_SHIPPING_BILLING_PREFERENCE;
-        dpa_shipping_preference?: DPA_SHIPPING_BILLING_PREFERENCE;
-        consumer_name_requested?: boolean;
-        consumer_email_address_requested?: boolean;
-        consumer_phone_number_requested?: boolean;
-        payment_options?: {
-            dpa_dynamic_data_ttl_minutes?: number;
-            dynamic_data_type?: DPA_DYNAMIC_DATA_TYPE;
-            dpa_pan_requested?: boolean;
-        };
-        review_action?: REVIEW_ACTION;
-        checkout_description?: string;
-        transaction_type?: TRANSACTION_TYPE;
-        order_type?: ORDER_TYPE;
-        transaction_amount?: {
-            transaction_amount?: number;
-            transaction_currency_code?: string;
-        };
-        merchant_order_id?: string;
-        merchant_category_code?: string;
-        merchant_country_code?: string;
-    };
-    customizations: IStyles$1;
-}
-type DPA_SHIPPING_BILLING_PREFERENCE = 'ALL' | 'POSTAL_COUNTRY' | 'NONE';
-type DPA_DYNAMIC_DATA_TYPE = 'TAVV' | 'DTVV';
-type REVIEW_ACTION = 'pay' | 'continue';
-type TRANSACTION_TYPE = 'PURCHASE' | 'BILL_PAYMENT' | 'MONEY_TRANSFER';
-type ORDER_TYPE = 'REAUTHORIZATION' | 'RECURRING' | 'INSTALLMENT';
-interface IStyles$1 {
-    button_text_color?: string;
-    primary_color?: string;
-    font_family?: string;
-    card_schemes?: string[];
-}
+/**
+ * List of available form field validators dedicated to cards and their definition
+ *
+ * @const CARD_VALIDATORS
+ *
+ * @type {Record<string, string>}
+ *
+ * @param {string} CVV=cardCvvValidation
+ *  Asserts that CVV contains zero or more digits and is a number
+ * @param {string} EXPIRY_DATE=expireDateValidation
+ *  Asserts value is a date in the future with format MM/YY
+ * @param {string} HOLDER_NAME=cardHoldernameValidation
+ *  Asserts value is a name that respects the
+ITU-T T.50 standard (@see https://www.itu.int/rec/T-REC-T.50/en)
+ * @param {string} NUMBER=cardNumberValidation
+    Asserts the value matches a known card scheme and as a the correct length.
+    E.g., matches a 13, 16 or 19 digit bank card, **or**, a 13 to 25 digit Vii Gift card
+ * @param {string} PIN=cardPinValidation
+    Asserts the value is a number with exactly 4 digits
+ */
+declare const CARD_VALIDATORS: {
+    readonly CVV: "cardCvvValidator";
+    readonly EXPIRY_DATE: "expireDateValidation";
+    readonly HOLDER_NAME: "cardHoldernameValidator";
+    readonly NUMBER: "cardNumberValidator";
+    readonly PIN: "cardPinValidator";
+};
+type CardValidatorValue = typeof CARD_VALIDATORS[keyof typeof CARD_VALIDATORS];
+/**
+ * List of available generic form field validators and their definition
+ *
+ * @const GENERIC_VALIDATORS
+ *
+ * @type {Record<string, string>}
+ *
+ * @param {string} REQUIRED=required
+ *  Asserts the input or form field has a value defined truthy value
+ */
+declare const GENERIC_VALIDATORS: {
+    readonly REQUIRED: "required";
+};
+type GenericValidatorValue = typeof GENERIC_VALIDATORS[keyof typeof GENERIC_VALIDATORS];
 
 declare const FORM_FIELD: {
     CARD_NAME: string;
@@ -310,18 +367,15 @@ interface IFormElement {
     placeholder?: string;
     value?: string;
 }
+type ValidatorFieldsMapKey = CardValidatorValue | GenericValidatorValue;
+type ValidatorFieldsMap = Partial<Record<ValidatorFieldsMapKey, string[]>>;
 interface IFormValidation {
     form_valid?: boolean;
     invalid_fields?: string[];
     invalid_showed_fields?: string[];
-    validators?: IValidators;
+    validators?: ValidatorFieldsMap;
 }
-interface IValidators {
-    required?: string[];
-    cardNumberValidator?: string[];
-    expireDateValidation?: string[];
-}
-interface IStyles {
+interface IStyles$1 {
     background_color?: string;
     background_active_color?: string;
     text_color?: string;
@@ -350,18 +404,19 @@ interface ICommonParams {
     sdk_version?: string;
     sdk_type?: string;
 }
-interface IVisaSRCParams extends IVisaSRCMeta, ICommonParams {
+interface ISRCParams extends ICommonParams {
     public_key?: string;
     service_id?: string;
+    meta?: string;
 }
-interface IWalletParams extends IStyles, ITexts, ICommonParams {
+interface IWalletParams extends IStyles$1, ITexts, ICommonParams {
     token: string;
     credentials: string;
     currency: string;
     amount: number;
     gateway_mode: string;
 }
-interface IParams extends IStyles, ITexts, ICommonParams {
+interface IParams extends IStyles$1, ITexts, ICommonParams {
     access_token?: string;
     public_key?: string;
     token?: string;
@@ -575,7 +630,7 @@ declare class Link {
     constructor(linkResource: string);
     getNetUrl(): string;
     getUrl(): string;
-    setParams(params: IParams | IWalletParams | IVisaSRCParams): void;
+    setParams(params: IParams | IWalletParams | ISRCParams): void;
     concatParams(params: IParams): void;
     getParams(): IParams;
     setEnv(env: string, alias?: string): void;
@@ -591,6 +646,7 @@ declare class Container {
     on(name: any, cb: (event: MouseEvent) => void): void;
     getAttr<T>(allowValue: string[]): T | {};
     getElement(): Element;
+    getSelector(): string;
     private convertConfigs;
 }
 
@@ -611,23 +667,27 @@ declare class IFrame {
     setStyle(property: string, value: string): void;
 }
 
+/**
+ * Contains basic information associated with the event.
+ *
+ * Including event (name), source of the message, purpose and a unique identifier
+ * for the event.
+ *
+ * @interface IEventData
+ *
+ * @param {string} event The name of the event.
+ * @param {string} message_source A system variable that identifies the event source.
+ * @param {string} purpose A system variable that states the purpose of the event.
+ * @param {string} [ref_id] Custom unique value that identifies result of processed operation.
+ */
 interface IEventData$1 {
     event: string;
-    purpose: string;
     message_source: string;
-    ref_id?: string;
+    purpose: string;
     widget_id: string;
     data?: any;
+    ref_id?: string;
 }
-/**
- * Interface of data from event.
- * @interface IEventData
- *
- * @param {string} event
- * @param {string} purpose
- * @param {string} message_source
- * @param {string} [ref_id]
- * */
 declare const EVENT: {
     AFTER_LOAD: string;
     SUBMIT: string;
@@ -639,6 +699,8 @@ declare const EVENT: {
     CHECKOUT_READY: string;
     CHECKOUT_ERROR: string;
     CHECKOUT_COMPLETED: string;
+    CHECKOUT_POPUP_OPEN: string;
+    CHECKOUT_POPUP_CLOSE: string;
     VALIDATION: string;
     SELECT: string;
     UNSELECT: string;
@@ -733,7 +795,7 @@ declare class Configuration {
     private env;
     static createEachToken(accessToken: string, configs: Configuration[], cb: (tokens: string[]) => void, errorCb?: (errors: string[]) => void): void;
     private static finishCreatingEachToken;
-    constructor(gatewayID?: string, paymentType?: string, purpose?: string);
+    /** @constructs */ constructor(gatewayID?: string, paymentType?: string, purpose?: string);
     /**
      * Destination, where customer will receive all successful responses.
      * Response will contain “data” object with “payment_source” or other parameters, in depending on 'purpose'
@@ -907,7 +969,7 @@ declare class Canvas3ds {
     protected iFrame: IFrame;
     protected event: IFrameEvent;
     protected eventEmitter: EventEmitter;
-    constructor(selector: string, token: string);
+    /** @constructs */ constructor(selector: string, token: string);
     protected static extractToken(token: string): {
         content: string;
         format: TOKEN_FORMAT;
@@ -1153,7 +1215,7 @@ declare class CheckoutButton {
     protected checkoutHandler?: CheckoutContextualHandler;
     protected env: string;
     protected alias?: string;
-    constructor(selector: string, accessToken: string, gatewayId?: string, gatewayType?: GATEWAY_TYPE, mode?: CHECKOUT_MODE);
+    /** @constructs */ constructor(selector: string, accessToken: string, gatewayId?: string, gatewayType?: GATEWAY_TYPE, mode?: CHECKOUT_MODE);
     protected chooseRunner(gatewayType: GATEWAY_TYPE, mode: CHECKOUT_MODE): void;
     protected buildAdditionalParams(): AdditionalParams;
     protected initCheckout(container: Container): void;
@@ -1276,7 +1338,7 @@ declare class ZipmoneyCheckoutButton extends CheckoutButton {
     protected publicKey: string;
     protected gatewayId: string;
     protected mode: CHECKOUT_MODE;
-    constructor(selector: string, publicKey: string, gatewayId?: string, mode?: CHECKOUT_MODE);
+    /** @constructs */ constructor(selector: string, publicKey: string, gatewayId?: string, mode?: CHECKOUT_MODE);
     /**
      * Method for setting suspended redirect uri. Redirect after referred checkout
      *
@@ -1320,7 +1382,7 @@ declare class AfterpayCheckoutButton extends CheckoutButton {
     protected accessToken: string;
     protected gatewayId: string;
     protected showETP: boolean;
-    constructor(selector: string, accessToken: string, gatewayId?: string);
+    /** @constructs */ constructor(selector: string, accessToken: string, gatewayId?: string);
     /**
      * Method which toggles the "Enhanced Tracking Protection" warning popup to 'on' mode.
      *
@@ -1352,7 +1414,7 @@ declare class AfterpayCheckoutButton extends CheckoutButton {
 declare class PaypalCheckoutButton extends CheckoutButton {
     protected publicKey: string;
     protected gatewayId: string;
-    constructor(selector: string, publicKey: string, gatewayId?: string);
+    /** @constructs */ constructor(selector: string, publicKey: string, gatewayId?: string);
 }
 
 /**
@@ -1374,7 +1436,7 @@ declare class PaymentSourceWidget {
     protected configs: Configuration[];
     protected configTokens: string[];
     protected publicKey: string;
-    constructor(accessToken: string, queryToken: string);
+    /** @constructs */ constructor(accessToken: string, queryToken: string);
     /**
      * Object contain styles for widget
      *
@@ -1388,7 +1450,7 @@ declare class PaymentSourceWidget {
      *   });
      * @param {IStyles} fields - name of styles which can be shown in widget [STYLE]{@link STYLE}
      */
-    setStyles(styles: IStyles): void;
+    setStyles(styles: IStyles$1): void;
     setStyle(param: string, value: string): void;
     /**
      * Current method can set custom ID to identify the data in the future
@@ -1473,6 +1535,7 @@ interface IEventSizeData extends IEventData$1 {
 }
 /**
  * Interface of data from event.
+ *
  * @interface IEventSelectData
  *
  * @param {string} event
@@ -1494,6 +1557,7 @@ interface IEventSizeData extends IEventData$1 {
  * */
 /**
  * Interface of data from event.
+ *
  * @interface IEventPaginationData
  *
  * @param {string} event
@@ -1506,12 +1570,13 @@ interface IEventSizeData extends IEventData$1 {
  * */
 /**
  * Interface of data from event.
+ *
  * @interface IEventAfterLoadData
  *
- * @param {string} event Event name
- * @param {string} purpose System variable. Purpose of event
- * @param {string} message_source System variable. Event source
- * @param {string} [ref_id] Custom value for identify result of processed operation
+ * @param {string} event The name of the event.
+ * @param {string} purpose A system variable that states the purpose of the event.
+ * @param {string} message_source A system variable that identifies the event source.
+ * @param {string} [ref_id] Custom unique value that identifies result of processed operation.
  * @param {number} total_item Pagination param. Total item count
  * @param {number} skip Pagination param. Skip items from first item
  * @param {number} limit Pagination param. Query limit
@@ -1520,24 +1585,25 @@ interface IEventSizeData extends IEventData$1 {
  * Interface of data from event.
  * @interface IEventFinishData
  *
- * @param {string} event Event name
- * @param {string} purpose System variable. Purpose of event
- * @param {string} message_source System variable. Event source
- * @param {string} [ref_id] Custom value for identify result of processed operation
+ * @param {string} event The name of the event.
+ * @param {string} purpose A system variable that states the purpose of the event.
+ * @param {string} message_source A system variable that identifies the event source.
+ * @param {string} [ref_id] Custom unique value that identifies result of processed operation.
  * */
 /**
 * Interface of data from event.
 * @interface IEventSizeData
 *
-* @param {number} event Event name
-* @param {number} purpose System variable. Purpose of event
-* @param {string} message_source System variable. Event source
-* @param {string} [ref_id] Custom value for identify result of processed operation
+* @param {number} event The name of the event.
+* @param {number} purpose A system variable that states the purpose of the event.
+* @param {string} message_source A system variable that identifies the event source.
+* @param {string} [ref_id] Custom unique value that identifies result of processed operation.
 * @param {number} height Height of iFrame
 * @param {number} width Width of iFrame
 * */
 /**
  * List of available event's name
+ *
  * @const EVENT
  *
  * @type {object}
@@ -1566,7 +1632,7 @@ declare class HtmlPaymentSourceWidget extends PaymentSourceWidget {
     protected container: Container;
     protected iFrame: IFrame;
     protected event: IFrameEvent;
-    constructor(selector: string, publicKey: string, queryToken: string);
+    /** @constructs */ constructor(selector: string, publicKey: string, queryToken: string);
     /**
      * The final method to beginning, the load process of widget to html
      *
@@ -1636,6 +1702,79 @@ declare class Builder extends HttpCore {
     getConfigs(): IBody;
 }
 
+interface IBaseSRCMeta {
+    customizations?: IStyles;
+    dpa_data?: {
+        dpa_presentation_name?: string;
+        dpa_uri?: string;
+    };
+    dpa_transaction_options?: {
+        dpa_locale?: string;
+        dpa_accepted_billing_countries?: string[];
+        consumer_name_requested?: boolean;
+        consumer_email_address_requested?: boolean;
+        consumer_phone_number_requested?: boolean;
+        transaction_amount?: {
+            transaction_amount?: number;
+            transaction_currency_code?: string;
+        };
+        merchant_order_id?: string;
+        merchant_category_code?: string;
+        merchant_country_code?: string;
+    };
+}
+interface PhoneNumber {
+    country_code: string;
+    phone_number: string;
+}
+interface Customer {
+    email?: string;
+    phone?: {
+        country_code?: string;
+        phone?: string;
+    };
+    first_name?: string;
+    last_name?: string;
+}
+interface IMastercardSRCMeta extends IBaseSRCMeta {
+    dpa_data?: IBaseSRCMeta['dpa_data'] & {
+        dpa_address?: string;
+        dpa_email_address?: string;
+        dpa_phone_number?: PhoneNumber;
+        dpa_logo_uri?: string;
+        dpa_supported_email_address?: string;
+        dpa_supported_phone_number?: PhoneNumber;
+        dpa_uri?: string;
+        dpa_support_uri?: string;
+        application_type?: 'WEB_BROWSER' | 'MOBILE_APP';
+    };
+    disable_summary_screen?: boolean;
+    co_brand_names?: string[];
+    checkout_experience?: 'WITHIN_CHECKOUT' | 'PAYMENT_SETTINGS';
+    services?: 'INLINE_CHECKOUT' | 'INLINE_INSTALLMENTS';
+    dpa_transaction_options?: IBaseSRCMeta['dpa_transaction_options'] & {
+        dpa_billing_preference?: MASTERCARD_DPA_SHIPPING_BILLING_PREFERENCE;
+        payment_options?: Array<{
+            dynamic_data_type?: string;
+        }>;
+        order_type?: MASTERCARD_ORDER_TYPE;
+        three_ds_preference?: string;
+        confirm_payment?: boolean;
+    };
+    customer?: Customer;
+    unaccepted_card_type?: 'CREDIT' | 'DEBIT';
+}
+type MASTERCARD_DPA_SHIPPING_BILLING_PREFERENCE = 'FULL' | 'POSTAL_COUNTRY' | 'NONE';
+type MASTERCARD_ORDER_TYPE = 'SPLIT_SHIPMENT' | 'PREFERRED_CARD';
+interface IStyles {
+    primary_button_color?: string;
+    secondary_button_color?: string;
+    primary_button_text_color?: string;
+    secondary_button_text_color?: string;
+    font_family?: string;
+    enable_src_popup?: boolean;
+}
+
 declare class ApiChargeInternal {
     protected api: ApiInternal;
     constructor(api: ApiInternal);
@@ -1762,98 +1901,35 @@ interface SRCProvider {
     useAutoResize?(): void;
 }
 
-/**
- * Interface of data used for the Visa Checkout.
- * @interface IVisaSRCMeta
- *
- * @type {object}
- * @param {string} [srci_transaction_id] Used to identify the SRC Id.
- * @param {object} [dpa_data] Object where the DPA creation data is stored.
- * @param {string} [dpa_data.dpa_presentation_name] Name in which the DPA is presented in.
- * @param {string} [dpa_data.dpa_uri] Used for indicating the DPA URI.
- * @param {object} [dpa_transaction_options] Object that stores options for creating a trasaction with DPA.
- * @param {string} [dpa_transaction_options.dpa_locale] DPA’s preferred locale, example en_US.
- * @param {Array} [dpa_transaction_options.dpa_accepted_billing_countries] Used to indicate list of accepted billing countries for DPA.
- * @param {Array} [dpa_transaction_options.dpa_accepted_shipping_countries] Used to indicate list of accepted shipping countries for DPA.
- * @param {string} [dpa_transaction_options.dpa_billing_preference] Used for listing the enumeration for billing preferences for DPA. Options are 'ALL', 'POSTAL_COUNTRY' and 'NONE'.
- * @param {string} [dpa_transaction_options.dpa_shipping_preference] Used for listing the enumeration for shipping preferences for DPA. Options are 'ALL', 'POSTAL_COUNTRY' and 'NONE'.
- * @param {boolean} [dpa_transaction_options.consumer_name_requested] Used to check if the name of the consumer is needed.
- * @param {boolean} [dpa_transaction_options.consumer_email_address_requested] Used to check if the email of the consumer is needed.
- * @param {boolean} [dpa_transaction_options.consumer_phone_number_requested] Used to check if the phone number of the consumer is needed.
- * @param {object} [dpa_transaction_options.payment_options] Object used to check the payment options that are included.
- * @param {number} [dpa_transaction_options.payment_options.dpa_dynamic_data_ttl_minutes] The minimum requested validity period for the transaction credentials.
- * @param {string} [dpa_transaction_options.payment_options.dynamic_data_type] Used for listing the enumeration for dynamic data types. Options are 'TAVV' and 'DTVV'.
- * @param {boolean} [dpa_transaction_options.payment_options.dpa_pan_requested] Used to check if PAN number was requested.
- * @param {string} [dpa_transaction_options.review_action] Used for listing the enumeration of review actions. Options are 'pay' and 'continue'.
- * @param {string} [dpa_transaction_options.checkout_description] Used for indicating the description of the checkout.
- * @param {string} [dpa_transaction_options.transaction_type] Used for listing the enumeration of the type of the transaction. 'PURCHASE', 'BILL_PAYMENT' and 'MONEY_TRANSFER'
- * @param {string} [dpa_transaction_options.order_type] Used for listing the enumeration of the type of the order. Options are 'REAUTHORIZATION', 'RECURRING' and 'INSTALLMENT'.
- * @param {object} [dpa_transaction_options.transaction_amount] Object used to describe the details of the transaction.
- * @param {number} [dpa_transaction_options.transaction_amount.transaction_amount] Used to indicate the amount of the transaction.
- * @param {string} [dpa_transaction_options.transaction_amount.transaction_currency_code] Used to indicate the currency code of the transaction. 3 letter ISO code format.
- * @param {string} [dpa_transaction_options.merchant_order_id] Used to indicate the merchants order Id.
- * @param {string} [dpa_transaction_options.merchant_category_code] Used to indicate the merchants category code.
- * @param {string} [dpa_transaction_options.merchant_country_code] Used to indicate the merchants country code. 2 letter ISO code format.
- * @param {object} [customer] Object where the customer data is stored to prefill in the checkout.
- * @param {string} [customer.email] Customer email.
- * @param {string} [customer.first_name] Customer first name.
- * @param {string} [customer.last_name] Customer last name.
- * @param {object} [customer.phone] Object where the customer phone is stored.
- * @param {string} [customer.phone.country_code] Customer phone country code (example "1" for US).
- * @param {string} [customer.phone.phone] Customer phone number.
- * @param {object} [customer.payment_source] Object where the customer billing address data is stored.
- * @param {string} [customer.payment_source.address_line1] Customer billing address line 1.
- * @param {string} [customer.payment_source.address_line2] Customer billing address line 2.
- * @param {string} [customer.payment_source.address_city] Customer billing address city.
- * @param {string} [customer.payment_source.address_postcode] Customer billing address postcode.
- * @param {string} [customer.payment_source.address_state] Customer billing address state code (if applicable for the country, example "FL" for Florida).
- * @param {string} [customer.payment_source.address_country] Customer billing address country code (example "US").
- */
-/**
- * Class SRC include methods for interacting with different secure remote commerce options such as Visa SRC
- * @constructor
- *
- * @param {string} button_selector - Selector of html element. Container for SRC checkout button.
- * @param {string} iframe_selector - Selector of html element. Container for SRC checkout iFrame.
- * @param {string} service_id - Card Scheme Service ID
- * @param {string} public_key_or_access_token - Paydock public key or Access Token
- * @param {IVisaSRCMeta} meta - Data that configures the SRC checkout
- * @example
- * var SRC = new SRC('#checkoutButton', '#checkoutIframe', 'service_id', 'public_key', {});
- *
- */
-declare class SRC {
-    protected button_selector: string;
+declare abstract class SRC {
     protected iframe_selector: string;
     protected service_id: string;
     protected public_key_or_access_token: string;
-    protected meta: IVisaSRCMeta;
+    protected meta: IMastercardSRCMeta;
     protected eventEmitter: EventEmitter;
     protected env: string;
-    protected alias: string;
+    protected alias?: string;
     protected api: ApiInternal;
     protected provider: SRCProvider;
     protected autoResize: boolean;
-    protected style: IStyles$1;
-    constructor(button_selector: string, iframe_selector: string, service_id: string, public_key_or_access_token: string, meta: IVisaSRCMeta);
+    protected style: IStyles;
+    constructor(iframe_selector: string, service_id: string, public_key_or_access_token: string, meta: IMastercardSRCMeta);
     /**
     * Object contain styles for widget - call before `.load()`.
     *
     * @example
     * widget.setStyles({
-    *       button_text_color: '#32a852',
-    *       primary_color: '#32a852',
-    *       font_family: 'sans-serif',
-    *       card_schemes: ['visa']
-    *   });
+    *     enable_src_popup: true
+    *     primary_button_color: 'red',
+    *     secondary_button_color: 'blue',
+    *     primary_button_text_color: 'white',
+    *     secondary_button_text_color: 'white',
+    *     font_family: 'Arial',
+    * });
     * @param {IStyles} fields - name of styles which can be shown in widget [STYLE]{@link STYLE}
     */
-    setStyles(styles: IStyles$1): void;
+    setStyles(styles: IStyles): void;
     private setStyle;
-    /**
-     * The final method after configuring the SRC to start the load process of SRC checkout
-     *
-     */
     load(): void;
     /**
      * Current method can change environment. By default environment = sandbox.
@@ -1874,21 +1950,6 @@ declare class SRC {
     getEnv(): string;
     on(eventName: string): Promise<any>;
     on(eventName: string, cb: (data: any) => void): any;
-    /**
-     * Using this method you can hide button
-     * @param {boolean} [saveSize=false] - using this param you can save iframe's size (if applicable)
-     *
-     * @example
-     * SRC.hideButton();
-     */
-    hideButton(saveSize: boolean): void;
-    /**
-     * Using this method you can show the SRC button after using hideButton method
-     *
-     * @example
-     * SRC.showButton();
-     */
-    showButton(): void;
     /**
      * Using this method you can hide checkout after load and button click
      * @param {boolean} [saveSize=false] - using this param you can save iframe's size (if applicable)
@@ -1921,6 +1982,34 @@ declare class SRC {
     useAutoResize(): void;
 }
 
+/**
+ * Class MastercardSRCClickToPay include methods for interacting with the MastercardSRC checkout and Manual Card option
+ *
+ * @extends SRC
+ *
+ * @constructor
+ *
+ * @param {string} iframe_selector - Selector of html element. Container for SRC checkout iFrame.
+ * @param {string} service_id - Card Scheme Service ID
+ * @param {string} public_key_or_access_token - Paydock public key or Access Token
+ * @param {IMastercardSRCMeta} meta - Data that configures the SRC checkout
+ * @example
+ * var mastercardSRC = new MastercardSRCClickToPay('#checkoutIframe', 'service_id', 'public_key', {});
+ *
+ */
+declare class MastercardSRCClickToPay extends SRC {
+    protected iframe_selector: string;
+    protected service_id: string;
+    protected public_key_or_access_token: string;
+    protected meta: IMastercardSRCMeta;
+    /** @constructs */ constructor(iframe_selector: string, service_id: string, public_key_or_access_token: string, meta: IMastercardSRCMeta);
+    /**
+     * The final method after configuring the SRC to start the load process of SRC checkout
+     *
+     */
+    load(): void;
+}
+
 interface ITriggerData {
     configuration_token?: string;
     tab_number?: number;
@@ -1986,7 +2075,7 @@ declare class VaultDisplayWidget {
     protected vaultDisplayToken: string;
     protected link: Link;
     protected configs: any[];
-    constructor(selector: string, token: string);
+    /** @constructs */ constructor(selector: string, token: string);
     /**
      * Current method can change environment. By default environment = sandbox.
      * Also we can change domain alias for this environment. By default domain_alias = paydock.com
@@ -2019,7 +2108,7 @@ declare class VaultDisplayWidget {
      *   });
      * @param {VaultDisplayStyle} fields - name of styles which can be shown in widget [VAULT_DISPLAY_STYLE]{@link VAULT_DISPLAY_STYLE}
      */
-    setStyles(styles: IStyles): void;
+    setStyles(styles: IStyles$1): void;
     setStyle(param: string, value: string): void;
     /**
      * The final method to beginning, the load process of widget to html
@@ -2040,6 +2129,9 @@ interface IWalletPaymentSuccessful {
 interface IWalletUnavailable {
     wallet?: WALLET_TYPE;
 }
+interface IWalletOnClick {
+    attachResult: (result: Promise<void> | boolean) => void;
+}
 interface IWalletUpdate {
     wallet_response_code?: string;
     wallet_order_id?: string;
@@ -2133,135 +2225,19 @@ interface IWalletService {
     load(container: Container): Promise<void>;
     close?(): void;
     update(data: IWalletServiceUpdate): void;
+    enable(): void;
+    disable(): void;
     setEnv(env: string): any;
     on(eventName: string, cb?: (data: IUnavailableWalletEventBody | IPaymentMethodSelectedWalletEventBody | any) => void): any;
 }
 
-/**
- * Interface of data from events.
- * @interface IEventData
- *
- * @param {string} event
- * @param {void | IWalletPaymentSuccessful | IWalletUpdate | IWalletUnavailable | any} data
- * */
 interface IEventData {
     event: string;
-    data: void | IWalletPaymentSuccessful | IWalletUpdate | IWalletUnavailable | any;
+    data: void | IWalletPaymentSuccessful | IWalletUpdate | IWalletUnavailable | IWalletOnClick | any;
 }
-/**
- * Interface of data from a successful payment result.
- * @interface IWalletPaymentSuccessful
- *
- * @param {string} id
- * @param {number} amount
- * @param {string} currency
- * @param {string} status
- * @param {string} [payer_name]
- * @param {string} [payer_email]
- * @param {string} [payer_phone]
- * */
-/**
- * Interface of data from an update event.
- * @interface IWalletUpdate
- *
- * @param {string} [wallet_response_code]
- * @param {string} [wallet_session_id]
- * @param {object} [payment_source]
- * @param {string} [payment_source.wallet_payment_method_id]
- * @param {string} [payment_source.card_number_last4]
- * @param {string} [payment_source.card_scheme]
- * @param {object} [wallet_loyalty_account]
- * @param {string} [wallet_loyalty_account.id]
- * @param {string} [wallet_loyalty_account.barcode]
- * @param {object} [shipping]
- * @param {string} [shipping.address_line1]
- * @param {string} [shipping.address_line2]
- * @param {string} [shipping.address_postcode]
- * @param {string} [shipping.address_city]
- * @param {string} [shipping.address_state]
- * @param {string} [shipping.address_country]
- * @param {string} [shipping.address_company]
- * @param {string} [shipping.post_office_box_number]
- * @param {string} [shipping.wallet_address_id]
- * @param {string} [shipping.wallet_address_name]
- * @param {string} [shipping.wallet_address_created_timestamp]
- * @param {string} [shipping.wallet_address_updated_timestamp]
- * */
-/**
- * Interface of data from an unavailable event.
- * @interface IWalletUnavailable
- *
- * @param {string} [wallet] For gateways with more than one wallet button available (e.g: MPGS with ApplePay and GooglePay). Possible values for wallet are 'apple' or 'google'.
- * */
-/**
- * Interface of data for wallet button `update` call.
- * @interface IWalletUpdateData
- *
- * @param {boolean} success
- * */
 interface IWalletUpdateData {
     success: boolean;
 }
-/**
- * Interface of data used by the wallet checkout and payment proccess.
- * @interface IWalletMeta
- *
- * @type {object}
- * @param {string} [amount_label] Label shown next to the total amount to be paid. Required for [Stripe, ApplePay, GooglePay]. N/A for [FlyPay, Flypay V2, PayPal, Afterpay].
- * @param {string} [country] Country of the user. 2 letter ISO code format. Required for [Stripe, ApplePay, GooglePay, Afterpay]. N/A for [FlyPay, Flypay V2, PayPal].
- * @param {boolean} [pay_later] Used to enable Pay Later feature in PayPal Smart Checkout WalletButton integration when available. Optional for [PayPal]. N/A for other wallets.
- * @param {boolean} [standalone] Used to enable Standalone Buttons feature in PayPal Smart Checkout WalletButton integration. Used together with `pay_later`. Optional for [PayPal]. N/A for other wallets.
- * @param {boolean} [show_billing_address] Used to hide/show the billing address on ApplePay and GooglePay popups. Default value is false. Optional for [ApplePay, GooglePay]. N/A for other wallets.
- * @param {boolean} [request_payer_name] Used mainly for fraud purposes - recommended set to true. Optional for [Stripe]. N/A for other wallets.
- * @param {boolean} [request_payer_email] Used mainly for fraud purposes - recommended set to true. Optional for [Stripe]. N/A for other wallets.
- * @param {boolean} [request_payer_phone] Used mainly for fraud purposes - recommended set to true. Optional for [Stripe]. N/A for other wallets.
- * @param {string} [access_token] Used for Flypay V2 express flow. Optional for [Flypay V2]. N/A for other wallets.
- * @param {string} [refresh_token] Used for Flypay V2 express flow. Optional for [Flypay V2]. N/A for other wallets.
- * @param {boolean} [request_shipping] Used to request or not shipping address in the Wallet checkout, being able to handle amount changes via the `update` event. Optional for [FlyPay, PayPal, ApplePay, GooglePay]. N/A for [Flypay V2, Stripe, Afterpay].
- * @param {IApplePayShippingOption[] | IPayPalShippingOption[]} [shipping_options] Used to provide available shipping options.(To use shipping_options the request_shipping flag should be true). Optional for [ApplePay]. N/A for the other wallets.
- * @param {string} [merchant_name] Merchant Name used for GooglePay integration via MPGS. Required for [GooglePay]. N/A for other wallets.
- * @param {object} [raw_data_initialization] Used to provide values to initialize wallet with raw data. Optional for [ApplePay]. N/A for the other wallets.
- * @param {object} [style] For **Paypal**: used to style the buttons, check possible values in the [style guide](https://developer.paypal.com/docs/business/checkout/reference/style-guide).
- * When `standalone` and `pay_later`, extra options can be provided in `style.messages` with the [messages style options](https://developer.paypal.com/docs/checkout/pay-later/us/integrate/reference/#stylelayout).
- * Also used at **ApplePay**, **GooglePay** and **Afterpay** to select button type.
- * Optional for [PayPal, ApplePay, GooglePay, Afterpay]. N/A for [Stripe, FlyPay, Flypay V2].
- * @param {object} [style.button_type] Used to select ApplePay button type (e.g: 'buy','donate', etc), check possible values at https://developer.apple.com/documentation/apple_pay_on_the_web/displaying_apple_pay_buttons_using_css.
- * Also select button type for GooglePay (check GooglePayStyles) and Afterpay (check AfterpayStyles). Optional for [ApplePay, GooglePay, Afterpay]. N/A for other wallets.
- * @param {object} [style.height] Used to select Afterpay button height. Optional for [Afterpay]. N/A for other wallets.
- * @param {array} [wallets] By default if this is not sent or empty, we will try to show either Apple Pay or Google Pay buttons. This can be limited sending the following array in this field: ['apple','google]. Optional for [Stripe, ApplePay, GooglePay]. N/A for other wallets.
- */
-/**
- * Interface of Shipping Options for ApplePay
- * @interface IApplePayShippingOption
- *
- * @type {object}
- * @param {string} [id] Identifier of the Shipping Option. Required.
- * @param {string} [label] Identifier of the Shipping Option. Required.
- * @param {string} [amount] Amount of the Shipping Option. Required.
- * @param {string} [detail] Details of the Shipping Option. Required.
- * @param {string} [type] Type of the Shipping Option. Values can be 'ELECTRONIC', 'GROUND', 'NOT_SHIPPED', 'OVERNIGHT', 'PICKUP', 'PRIORITY', 'SAME_DAY'. Optional.
- */
-/**
- * Interface of Shipping Options for GooglePay
- * @interface IGooglePayShippingOption
- *
- * @type {object}
- * @param {string} [id] Identifier of the Shipping Option. Required.
- * @param {string} [label] Identifier of the Shipping Option. Required.
- * @param {string} [detail] Details of the Shipping Option. Optional.
- * @param {string} [type] Type of the Shipping Option. Values can be 'ELECTRONIC', 'GROUND', 'NOT_SHIPPED', 'OVERNIGHT', 'PICKUP', 'PRIORITY', 'SAME_DAY'. Optional.
- */
-/**
- * Interface of Shipping Options for PayPal
- * @interface IPayPalShippingOption
- *
- * @type {object}
- * @param {string} [id] Identifier of the Shipping Option. Required.
- * @param {string} [label] Identifier of the Shipping Option. Required.
- * @param {string} [amount] Amount of the Shipping Option. Required.
- * @param {string} [currency] Currency of the Shipping Option. Required.
- * @param {string} [type] Type of the Shipping Option. Values can be 'SHIPPING' or 'PICKUP'. Required.
- */
 /**
  * Class WalletButtons to work with different E-Wallets within html (currently supports Apple Pay, Google Pay, Google Pay™ and Apple Pay via Stripe, Flypay, Flypay V2, Paypal, Afterpay)
  * @constructor
@@ -2279,7 +2255,7 @@ declare class WalletButtons {
     protected service: IWalletService;
     protected eventEmitter: EventEmitter;
     protected hasUpdateHandler: boolean;
-    constructor(selector: string, chargeToken: string, meta: IWalletMeta);
+    /** @constructs */ constructor(selector: string, chargeToken: string, meta: IWalletMeta);
     /**
      * Initializes the availability checks and inserts the button if possible.
      * Otherwise function onUnavailable(handler: VoidFunction) will be called.
@@ -2361,6 +2337,20 @@ declare class WalletButtons {
      * @param {string} [alias] - Own domain alias
      */
     setEnv(env: string, alias?: string): void;
+    /**
+     * Current method can enable the payment button. This method is only supported for Flypay V2.
+     *
+     * @example
+     * button.enable();
+     */
+    enable(): void;
+    /**
+     * Current method can disable the payment button. This method is only supported for Flypay V2.
+     *
+     * @example
+     * button.disable('production', 'paydock.com');
+     */
+    disable(): void;
     /**
      * Closes the checkout forcibly. Currently supported in Flypay wallet.
      *
@@ -2467,9 +2457,51 @@ declare class WalletButtons {
      * @param {listener} [handler] - Function to be called when authentication tokens are changed.
      */
     onAuthTokensChanged(handler?: (err: IEventData) => void): Promise<unknown> | (() => void);
+    /**
+     * Registers a callback function to be invoked when the wallet button gets clicked.
+     * There are two operational modes supported, Synchronous and Asynchronous.
+     * When asynchronous operations need to occur on the callback handler, attaching the Promise via `attachResult` is required to have the wallet wait for a result.
+     * When synchronous operations occur on the callback handler, attaching a boolean result via `attachResult` is optional to control the execution flow.
+     * Note this is supported for Paypal, GooglePay and ApplePay wallet buttons at the moment.
+     *
+     * @example
+     * button.onClick((data) => {
+     *      performValidationLogic();
+     * });
+     *
+     * @param {listener} handler - Function to be called when the wallet button is clicked.
+     */
+    onClick(handler: (data: IEventData) => void): () => void;
+    /**
+     * Registers a callback function to be invoked when the wallet checkout opens.
+     * Note this is supported for FlypayV2 wallet button at the moment.
+     *
+     * @example
+     * button.onCheckoutOpen((data) => {
+     *      console.log('Checkout opens');
+     * });
+     *
+     * @param {listener} handler - Function to be called when the wallet checkout opens.
+     */
+    onCheckoutOpen(handler?: (err: IEventData) => void): Promise<unknown> | (() => void);
+    /**
+     * Registers a callback function to be invoked when the wallet checkout closes.
+     * Note this is supported for FlypayV2 wallet button at the moment.
+     *
+     * @example
+     * button.onCheckoutClose(() => {
+     *      console.log('Wallet checkout closes');
+     * });
+     *
+     * @param {listener} handler - Function to be called when the wallet checkout closes.
+     */
+    onCheckoutClose(handler?: (err: IEventData) => void): Promise<unknown> | (() => void);
     private setupServiceCallbacks;
     private setupUnavailableCallback;
     private setupUpdateCallback;
+    private setupOnClickCallback;
+    private setupOnCheckoutOpenCallback;
+    private setupOnCheckoutCloseCallback;
     private setupWalletCallback;
     private setupPaymentCallback;
     private setupPaymentSuccessCallback;
@@ -2619,7 +2651,7 @@ declare class MultiWidget {
      *   });
      * @param {IStyles} fields - name of styles which can be shown in widget [STYLE]{@link STYLE}
      */
-    setStyles(styles: IStyles): void;
+    setStyles(styles: IStyles$1): void;
     /**
      * Method to set a country code mask for the phone input.
      *
@@ -2803,42 +2835,46 @@ declare class MultiWidget {
 interface IEventMetaData extends IEventData$1 {
     configuration_token: string;
     type: string;
-    gateway_type?: string;
-    card_number_last4?: string;
-    card_scheme?: string;
-    card_number_length?: number;
     account_name?: string;
     account_number?: string;
+    card_number_last4?: string;
+    card_number_length?: number;
+    card_scheme?: string;
+    gateway_type?: string;
 }
 interface IEventFinishData extends IEventData$1 {
     payment_source: string;
 }
 /**
  * Interface of data from validation event.
+ *
  * @interface IFormValidation
  *
- * @param {string} event Event name
- * @param {string} purpose System variable. Purpose of event
- * @param {string} message_source System variable. Event source
- * @param {string} [ref_id] Custom value for identify result of processed operation
- * @param {boolean} [form_valid] Form is valid
- * @param {array} [invalid_fields] Invalid form fields
- * @param {array} [invalid_showed_fields] List of fields on which the error is already displayed
- * @param {array} [validators] List of validators with fields
- * */
+ * @param {string} event The name of the event.
+ * @param {string} message_source A system variable that identifies the event source.
+ * @param {string} purpose A system variable that states the purpose of the event.
+ * @param {string} [ref_id] Custom unique value that identifies result of processed operation.
+ * @param {boolean} [form_valid] Indicates wether or not the form is valid.
+ * @param {Array<string>} [invalid_fields] Names of form fields with invalid data.
+ * @param {Array<string>} [invalid_showed_fields] Names of invalid form fields which are already displaying the error.
+ * @param {Partial<Record<CardValidatorValue | GenericValidatorValue, Array<string>>>} [validators] Object containing validator identifiers as keys and the fields subject to that validator as an array of form field names.
+ *  See list of available [Generic Vallidators]{@link GENERIC_VALIDATORS} and [Card Validators]{@link CARD_VALIDATORS},
+ */
 /**
- * Interface of data from event.
+ * Contains basic information associated with the event and additional meta data
+ * specific to the event. E.g., card info, gateway info, etc.
+ *
  * @interface IEventMetaData
  *
- * @param {string} event Event name
- * @param {string} purpose System variable. Purpose of event
- * @param {string} message_source System variable. Event source
- * @param {string} [ref_id] Custom value for identify result of processed operation
+ * @param {string} event The name of the event.
+ * @param {string} purpose A system variable that states the purpose of the event.
+ * @param {string} message_source A system variable that identifies the event source.
+ * @param {string} [ref_id] Custom unique value that identifies result of processed operation.
  * @param {string} configuration_token Token received from our API with widget data
  * @param {string} type Payment type 'card', 'bank_account'
  * @param {string} gateway_type Gateway type
  * @param {string} [card_number_last4] Last 4 digit of your card
- * @param {string} [card_scheme] Card scheme
+ * @param {string} [card_scheme] Card scheme, e.g., (Visa, Mastercard and American Express (AmEx))
  * @param {number} [card_number_length] Card number length
  * @param {string} [account_name] Bank account account name
  * @param {string} [account_number] Bank account account number
@@ -2847,19 +2883,19 @@ interface IEventFinishData extends IEventData$1 {
  * Interface of data from event.
  * @interface IEventAfterLoadData
  *
- * @param {string} event Event name
- * @param {string} purpose System variable. Purpose of event
- * @param {string} message_source System variable. Event source
- * @param {string} [ref_id] Custom value for identify result of processed operation
+ * @param {string} event The name of the event.
+ * @param {string} purpose A system variable that states the purpose of the event.
+ * @param {string} message_source A system variable that identifies the event source.
+ * @param {string} [ref_id] Custom unique value that identifies result of processed operation.
  * */
 /**
  * Interface of data from event.
  * @interface IEventFinishData
  *
- * @param {string} event Event name
- * @param {string} purpose System variable. Purpose of event
- * @param {string} message_source System variable. Event source
- * @param {string} [ref_id] Custom value for identify result of processed operation
+ * @param {string} event The name of the event.
+ * @param {string} purpose A system variable that states the purpose of the event.
+ * @param {string} message_source A system variable that identifies the event source.
+ * @param {string} [ref_id] Custom unique value that identifies result of processed operation.
  * @param {string} payment_source One time token. Result from this endpoint [API docs](https://docs.paydock.com/#tokens)
  * */
 /**
@@ -2918,129 +2954,194 @@ declare class HtmlMultiWidget extends MultiWidget {
     protected triggerElement: Trigger;
     protected event: IFrameEvent;
     protected validationData: IFormValidation;
-    constructor(selector: string, publicKey: string, conf: any);
+    /** @constructs */ constructor(selector: string, publicKey: string, conf: any);
     /**
-     * The final method to beginning, the load process of widget to html
+     * Loads the widget.
      *
+     * Calling this method results in an iframe element being inserted and rendered in the DOM.
      */
     load(): void;
+    /**
+     * Registers a form validation callback for validation events.
+     */
     protected afterLoad(): void;
     /**
-     * This callback will be called for each event in widget
+     * Listen to events of widget
      *
-     * @callback listener
-     * @param {IEventData | IEventFinishData | IEventMetaData | IFormValidation} response
+     * @example
+     *
+     * ```javascript
+     * widget.on('form_submit', function (data) {
+     *      console.log(data);
+     * });
+     * ```
+     *
+     * @example
+     *
+     * ```javascript
+     * widget.on('form_submit').then(function (data) {
+     *      console.log(data);
+     * });
+     * ```
+     *
+     * @typedef {(data: IEventData | IEventMetaData | IEventFinishData | IFormValidation) => void} EventListenerCallback
+     *
+     * @param {string} eventName - The name of the event that should be listened. Available event names [EVENT]{@link EVENT}.
+     * @param {EventListenerCallback} [cb] - A function to be invoked whenever the event occurs.
+     *
+     * @return {Promise<IEventData | IEventMetaData | IEventFinishData | IFormValidation> | void}
      */
     on(eventName: string): Promise<IEventData$1 | IEventMetaData | IEventFinishData | IFormValidation>;
     on(eventName: string, cb: (data: IEventData$1 | IEventMetaData | IEventFinishData | IFormValidation) => void): any;
     /**
-     * This callback will be called for every trigger
+     * Registers callback that will be invoked for every trigger.
      *
-     * @param {triggerName} triggers - submit_form, tab
-     * @param {ITriggerData} data which will be sending to widget
+     * @param {'submit_form' | 'tab'} triggers - The Widget element identifier that caused the trigger.
+     * @param {ITriggerData} data - Data that will be sent to the widget when the trigger occurs.
      */
     trigger(triggerName: string, data?: ITriggerData): void;
     /**
-     * Using this method you can get validation state information
+     * Gets a reference to the form current validation state.
+     *
+     * !Warning: do not directly modify the values of the returned object.
+     *
      * @return {IFormValidation} Form validation object
      */
     getValidationState(): IFormValidation;
     /**
-     * Using this method you can check if the form is valid
-     * @return {boolean} Form is valid
+     * Checks if a given form is valid.
+     *
+     * A form is valid if all form fields are valid.
+     *
+     * @return {boolean} Indicates wether or not form is valid.
      */
     isValidForm(): boolean;
     /**
      * Using this method you can check if a specific form field is invalid
+     *
      * @param {string} field - Field name
      * @return {boolean} Field is invalid
      */
     isInvalidField(field?: string): boolean;
     /**
-     * Using this method you can check if an error is displayed on a specific field
-     * @param {string} field - Field name
-     * @return {boolean} Error is showed on field
+     * Checks if a given form field is displaying an error.
+     *
+     * @param {string} field - The form field name
+     *
+     * @return {boolean} Indicates wether or not the Error message is being displayed on the associated field.
      */
     isFieldErrorShowed(field?: string): boolean;
     /**
-     * Using this method you can check if a specific field is invalid
-     * @param {string} field - Field name
-     * @param {string} validator - Validator name. Available validators: `required, cardNumberValidator, expireDateValidation`
-     * @return {boolean} Field is invalid by validator
+     * Checks if a given form field is valid or invalid by name.
+     *
+     * @param {string} field - The form field name
+     * @param validator - The name of the validator.
+     *
+     * @return {boolean} Indicates wether or not the field is invalid based on validator intepretation.
      */
-    isInvalidFieldByValidator(field: string, validator: string): boolean;
+    isInvalidFieldByValidator(field: string, validator: ValidatorFieldsMapKey): boolean;
     /**
-     * Using this method you can hide widget after load
-     * @param {boolean} [saveSize=false] - using this param you can save iframe's size
+     * Hides the widget.
+     *
+     * E.g., use this method to hide the widget after it loads.
+     *
+     * @param {boolean} [saveSize=false] Wether the original iframe element size should be saved before being hidden.
      */
     hide(saveSize: boolean): void;
     /**
-     * Using this method you can show widget after using hide method
+     * Shows the widget.
      *
+     * E.g., use this method to show the widget after it was explicitly hidden.
      */
     show(): void;
     /**
-     * Using this method you can reload widget
-     *
+     * Reloads the widget.
      */
     reload(): void;
     /**
-     * Using this method you can hide any elements inside widget
+     * Hides the specified Widget elements by their identifier.
      *
      * @example
+     *
+     * ```javascript
      * widget.hideElements(['submit_button', 'email']);
+     * ```
      *
-     * @param {string[]} elements -  list of element which can be hidden [ELEMENT]{@link ELEMENT} || [FORM_FIELD]{@link FORM_FIELD}
+     * @param {string[]} elements - List of element which can be hidden [ELEMENT]{@link ELEMENT} || [FORM_FIELD]{@link FORM_FIELD}
      */
     hideElements(elements: string[]): void;
     /**
-     * Using this method you can show any elements inside widget
+     * Shows the specified Widget elements by their identifier.
      *
-     * * @example
-     * widget.showElements(['submit_button', 'email']);
+     * @example
      *
-     * @param {string[]} elements -  list of element which can be showed [ELEMENT]{@link ELEMENT} || [FORM_FIELD]{@link FORM_FIELD}
+     * ```javascript
+     * widget.showElements(['submit_button', 'email']);
+     * ```
      *
+     * @param {string[]} elements - List of elements which can be showed [ELEMENT]{@link ELEMENT} || [FORM_FIELD]{@link FORM_FIELD}
      */
     showElements(elements: string[]): void;
     /**
-     * Method for update values for form fields inside the widget
+     * Updates the form field values inside the widget.
      *
      * @example
+     *
+     * ```javascript
      * widget.updateFormValues({
-     *       email: 'predefined@email.com',
-     *       card_name: 'Houston'
-     *   });
+     *   email: 'predefined@email.com',
+     *   card_name: 'Houston'
+     * });
+     *```
      *
      * @param {IFormValues} fieldValues - Fields with values
      */
     updateFormValues(fieldValues: IFormValues): void;
+    /**
+     * Updates a single form field values inside the widget by the form field name.
+     *
+     * @example
+     *
+     * ```javascript
+     * widget.updateFormValue("card_name", "John Doe");
+     *```
+     *
+     * @param {string} key - The form field name
+     * @param {string} value - The form field value
+     */
     updateFormValue(key: string, value: string): void;
     /**
-     * After finish event of widget, data (dataType) will be insert to input (selector)
+     * Inserts the event data (after finish event) onto the input field associated with the provided CSS selector.
      *
-     * @param {string} selector - css selector . [] #
-     * @param {string} dataType - data type of IEventData object.
+     * @param {string} selector - A CSS selector. E.g., ".my-class", "#my-id", or others
+     * @param {string} dataType - The data type of IEventData object.
      */
     onFinishInsert(selector: string, dataType: string): void;
     /**
-     * Widget will intercept submit of your form for processing widget
+     * Intercepts a form submission and delegates processing to the widget.
      *
-     * Process: click by submit button in your form --> submit widget ---> submit your form
-     * @note  submit button in widget will be hidden.
+     * An simplified example of the process:
+     * - User clicks submit button in your form
+     * - This implicitly triggers a submission to the widget
+     * - The widget submits your form
+     *
+     * @note The widget's submit button will be hidden.
      *
      * @param {string} selector - css selector of your form
      *
      * @example
+     *
+     * ```html
+     * <body>
      *  <form id="myForm">
      *      <input name="amount">
      *      <button type="submit">Submit</button>
      *  </form>
-     * <!--
-     * -->
-     * <script>
+     *  <script>
      *     widget.interceptSubmitForm('#myForm');
-     * </script>
+     *  </script>
+     * </body>
+     * ```
      */
     interceptSubmitForm(selector: string): void;
     /**
@@ -3051,8 +3152,10 @@ declare class HtmlMultiWidget extends MultiWidget {
      * Use this method for resize iFrame according content height
      *
      * @example
-     * widget.useAutoResize();
      *
+     * ```javascript
+     * widget.useAutoResize();
+     *```
      */
     useAutoResize(): void;
 }
@@ -3077,7 +3180,7 @@ declare class HtmlMultiWidget extends MultiWidget {
  * @param {string} [purpose=payment_source] - Purpose of widget form. Available parameters: ‘payment_source’, ‘card_payment_source_with_cvv’, ‘card_payment_source_without_cvv’
  */
 declare class HtmlWidget extends HtmlMultiWidget {
-    constructor(selector: string, publicKey: string, gatewayID?: string, paymentType?: string, purpose?: string);
+    /** @constructs */ constructor(selector: string, publicKey: string, gatewayID?: string, paymentType?: string, purpose?: string);
     /**
      * Destination, where customer will receive all successful responses.
      * Response will contain “data” object with “payment_source” or other parameters, in depending on 'purpose'
@@ -3160,4 +3263,4 @@ declare class HtmlWidget extends HtmlMultiWidget {
     setGiftCardScheme(giftCardScheme: any, processingNetwork: any): void;
 }
 
-export { AfterpayCheckoutButton, Api, CHECKOUT_BUTTON_EVENT, Canvas3ds, Configuration, ELEMENT, EVENT, Builder$1 as ExternalCheckoutBuilder, Checker as ExternalCheckoutChecker, FORM_FIELD, HtmlMultiWidget, HtmlPaymentSourceWidget, HtmlWidget, type ICheckout, type IDetails, type IElementStyleInput, type IEventCheckoutFinishData, type IPayPalMeta, type IStyles, type ITexts, MultiWidget, PAYMENT_TYPE, PURPOSE, Builder as PaymentSourceBuilder, PaymentSourceWidget, PaypalCheckoutButton, SRC, STYLABLE_ELEMENT, STYLABLE_ELEMENT_STATE, STYLE, SUPPORTED_CARD_TYPES, TEXT, TRIGGER, TYPE, VAULT_DISPLAY_STYLE, type VaultDisplayStyle, VaultDisplayWidget, WalletButtons, ZipmoneyCheckoutButton };
+export { AfterpayCheckoutButton, Api, CHECKOUT_BUTTON_EVENT, Canvas3ds, Configuration, ELEMENT, EVENT, Builder$1 as ExternalCheckoutBuilder, Checker as ExternalCheckoutChecker, FORM_FIELD, HtmlMultiWidget, HtmlPaymentSourceWidget, HtmlWidget, type ICheckout, type IDetails, type IElementStyleInput, type IEventCheckoutFinishData, type IPayPalMeta, type IStyles$1 as IStyles, type ITexts, MastercardSRCClickToPay, MultiWidget, PAYMENT_TYPE, PURPOSE, Builder as PaymentSourceBuilder, PaymentSourceWidget, PaypalCheckoutButton, STYLABLE_ELEMENT, STYLABLE_ELEMENT_STATE, STYLE, SUPPORTED_CARD_TYPES, TEXT, TRIGGER, TYPE, VAULT_DISPLAY_STYLE, type VaultDisplayStyle, VaultDisplayWidget, WalletButtons, ZipmoneyCheckoutButton };