@paydock/client-sdk 1.108.2 → 1.110.3-beta

package/bundles/index.cjs.d.ts

@@ -689,7 +689,7 @@ interface IEventData$1 {
     data?: any;
     ref_id?: string;
 }
-declare const EVENT: {
+declare const EVENT$1: {
     AFTER_LOAD: string;
     SUBMIT: string;
     FINISH: string;
@@ -895,6 +895,7 @@ declare class Configuration {
 declare class EventEmitter {
     private events;
     emit<T>(eventName: string, data?: T): void;
+    emitWithResult<T, R>(eventName: string, data?: T): Promise<R[]>;
     subscribe<T>(eventName: string, handler: (data: T) => void): () => void;
 }
 
@@ -1877,6 +1878,17 @@ interface ProcessAuthenticationResponse {
     };
 }
 
+declare class ApiGatewayInternal {
+    protected api: ApiInternal;
+    constructor(api: ApiInternal);
+    getWalletConfig(gateway_id: string): Promise<GetWalletConfigResponse>;
+}
+interface GetWalletConfigResponse {
+    type: string;
+    mode: string;
+    credentials?: object;
+}
+
 declare class ApiServiceInternal {
     protected api: ApiInternal;
     constructor(api: ApiInternal);
@@ -1894,6 +1906,7 @@ interface GetConfigResponse {
 declare class ApiInternal extends ApiBase {
     charge(): ApiChargeInternal;
     service(): ApiServiceInternal;
+    gateway(): ApiGatewayInternal;
 }
 
 interface SRCProvider {
@@ -2123,51 +2136,6 @@ declare class VaultDisplayWidget {
     load(): void;
 }
 
-interface IWalletPaymentSuccessful {
-    id: string;
-    amount: number;
-    currency: string;
-    status: string;
-    payer_name?: string;
-    payer_email?: string;
-    payer_phone?: string;
-}
-interface IWalletUnavailable {
-    wallet?: WALLET_TYPE;
-}
-interface IWalletOnClick {
-    attachResult: (result: Promise<void> | boolean) => void;
-}
-interface IWalletUpdate {
-    wallet_response_code?: string;
-    wallet_order_id?: string;
-    wallet_session_id?: string;
-    payment_source?: {
-        wallet_payment_method_id?: string;
-        card_number_last4?: string;
-        card_scheme?: string;
-    };
-    wallet_loyalty_account?: {
-        id?: string;
-        barcode?: string;
-    };
-    shipping?: {
-        address_line1?: string;
-        address_line2?: string;
-        address_postcode?: string;
-        address_city?: string;
-        address_state?: string;
-        address_country?: string;
-        address_company?: string;
-        post_office_box_number?: string;
-        wallet_address_id?: string;
-        wallet_address_name?: string;
-        wallet_address_created_timestamp?: string;
-        wallet_address_updated_timestamp?: string;
-    };
-    selected_shipping_option?: IShippingOption;
-}
-
 interface IWalletServiceUpdateData {
     amount: number;
     shipping_options?: IShippingOption[];
@@ -2237,6 +2205,51 @@ interface IWalletService {
     on(eventName: string, cb?: (data: IUnavailableWalletEventBody | IPaymentMethodSelectedWalletEventBody | any) => void): any;
 }
 
+interface IWalletPaymentSuccessful {
+    id: string;
+    amount: number;
+    currency: string;
+    status: string;
+    payer_name?: string;
+    payer_email?: string;
+    payer_phone?: string;
+}
+interface IWalletUnavailable {
+    wallet?: WALLET_TYPE;
+}
+interface IWalletOnClick {
+    attachResult: (result: Promise<void> | boolean) => void;
+}
+interface IWalletUpdate {
+    wallet_response_code?: string;
+    wallet_order_id?: string;
+    wallet_session_id?: string;
+    payment_source?: {
+        wallet_payment_method_id?: string;
+        card_number_last4?: string;
+        card_scheme?: string;
+    };
+    wallet_loyalty_account?: {
+        id?: string;
+        barcode?: string;
+    };
+    shipping?: {
+        address_line1?: string;
+        address_line2?: string;
+        address_postcode?: string;
+        address_city?: string;
+        address_state?: string;
+        address_country?: string;
+        address_company?: string;
+        post_office_box_number?: string;
+        wallet_address_id?: string;
+        wallet_address_name?: string;
+        wallet_address_created_timestamp?: string;
+        wallet_address_updated_timestamp?: string;
+    };
+    selected_shipping_option?: IShippingOption;
+}
+
 interface IEventData {
     event: string;
     data: void | IWalletPaymentSuccessful | IWalletUpdate | IWalletUnavailable | IWalletOnClick | any;
@@ -3269,4 +3282,409 @@ declare class HtmlWidget extends HtmlMultiWidget {
     setGiftCardScheme(giftCardScheme: any, processingNetwork: any): void;
 }
 
-export { AfterpayCheckoutButton, Api, CHECKOUT_BUTTON_EVENT, Canvas3ds, ClickToPay, 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, 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 };
+declare enum EVENT {
+    UNAVAILABLE = "unavailable",
+    ERROR = "error",
+    PAYMENT_SUCCESSFUL = "paymentSuccessful",
+    PAYMENT_ERROR = "paymentError",
+    PAYMENT_IN_REVIEW = "paymentInReview",
+    ON_CLICK = "onClick",
+    ON_CHECKOUT_CLOSE = "onCheckoutClose"
+}
+
+interface BaseEventData<T> {
+    event: string;
+    chargeId?: string;
+    data?: T | undefined;
+}
+
+interface OnClickEventData extends BaseEventData<undefined> {
+    event: EVENT.ON_CLICK;
+}
+
+interface OnPaymentSuccessfulEventData extends BaseEventData<{
+    id: string;
+    amount: number;
+    currency: string;
+    status: string;
+}> {
+    event: EVENT.PAYMENT_SUCCESSFUL;
+}
+
+interface OnCloseEventData extends BaseEventData<undefined> {
+    event: EVENT.ON_CHECKOUT_CLOSE;
+}
+
+interface OnPaymentInReviewEventData extends Omit<OnPaymentSuccessfulEventData, 'event'> {
+    event: EVENT.PAYMENT_IN_REVIEW;
+}
+
+interface OnPaymentErrorEventData extends BaseEventData<{
+    message?: string;
+    code?: string;
+}> {
+    event: EVENT.PAYMENT_ERROR;
+}
+
+interface WalletCaptureRequest {
+    payment_method_id?: string;
+    customer: {
+        email?: string;
+        phone?: string;
+        first_name?: string;
+        last_name?: string;
+        payment_source?: {
+            wallet_type?: string;
+            address_line1?: string;
+            address_line2?: string;
+            address_country?: string;
+            address_city?: string;
+            address_postcode?: string;
+            address_state?: string;
+            ref_token?: string;
+            external_payer_id?: string;
+        };
+    };
+}
+
+interface OnUnavailableEventData extends BaseEventData<undefined> {
+    event: EVENT.UNAVAILABLE;
+}
+
+interface BaseGatewayConfig<T> {
+    type: string;
+    mode: string;
+    credentials?: T;
+}
+
+interface BaseWalletMeta {
+    amount: number;
+    currency: string;
+}
+
+interface OnErrorEventData extends BaseEventData<Error> {
+    event: EVENT.ERROR;
+}
+
+declare abstract class BaseWalletButton<T extends BaseWalletMeta> {
+    protected container: Container;
+    protected api: ApiInternal;
+    protected env: string;
+    protected gatewayId: string;
+    protected meta: T;
+    private eventEmitter;
+    private chargeWalletTokenMeta?;
+    constructor(selector: string, publicKeyOrAccessToken: string, gatewayId: string, meta: T, requiredMetaFields: string[]);
+    private getApiAuthType;
+    /**
+     * Current method can change environment. By default environment = sandbox.
+     * Also we can change domain alias for this environment. By default domain_alias = paydock.com
+     * Bear in mind that you must set an environment before calling `button.load()`.
+     *
+     * @example
+     * button.setEnv('production', 'paydock.com');
+     * @param {string} env - sandbox, production
+     * @param {string} [alias] - Own domain alias
+     */
+    setEnv(env: string, alias?: string): void;
+    /**
+     * Callback for onClick method.
+     *
+     * @callback OnClickCallback
+     * @param {OnClickEventData} data
+     * @return {Promise<string>} walletToken string result
+     */
+    /**
+     * Registers a callback function to be invoked when the wallet button gets clicked.
+     * **Note:** is mandatory to handle this event to perform the wallet initialization (and optionally any validation logic).
+     * The event handler needs to return the wallet token string in order for the Wallet charge processing to proceed, or throw an error in case of failure or validation errors.
+     * **Note:** this callback may be called multiple times as the customer closes the payment checkout and re-clicks the button.
+     * It's the merchant's responsibility to handle this situation and evaluate in each case if generating a new WalletCharge Token is required or the previous one can be used in each case, depending on order data and updates.
+     * In case a new one needs to be generated, remember it will need to be preceded by a `setMeta` call.
+     *
+     * @example
+     * button.onClick(async (data) => {
+     *      const responseData = await fetch('https://your-server.com/init-wallet-charge');
+     *      return responseData.walletToken;
+     * });
+     *
+     * @param {OnClickCallback} handler - Function to be called when the wallet button is clicked.
+     */
+    onClick(handler: (data: OnClickEventData) => Promise<string>): () => void;
+    /**
+     * Callback for onPaymentSuccessful method.
+     *
+     * @callback OnPaymentSuccessfulCallback
+     * @param {OnPaymentSuccessfulEventData} data
+     */
+    /**
+     * If the payment was successful, the function passed as parameter will be called.
+     * Important: Do not perform thread blocking operations in callback such as window.alert() calls.
+     *
+     * @example
+     * button.onPaymentSuccessful((data) => {
+     *      console.log('Payment successful!');
+     * });
+     *
+     * @example
+     * button.onPaymentSuccessful().then((data) => console.log('Payment successful!'));
+     *
+     * @param {OnPaymentSuccessfulCallback} [handler] - Function to be called when the payment was successful.
+     */
+    onPaymentSuccessful(handler?: (data: OnPaymentSuccessfulEventData) => void): Promise<unknown> | (() => void);
+    /**
+     * Callback for onPaymentInReview method.
+     *
+     * @callback OnPaymentInReviewCallback
+     * @param {OnPaymentInReviewEventData} data
+     */
+    /**
+     * If the payment was left in fraud review, the function passed as parameter will be called.
+     * Important: Do not perform thread blocking operations in callback such as window.alert() calls.
+     *
+     * @example
+     * button.onPaymentInReview((data) => {
+     *      console.log('Payment in fraud review');
+     * });
+     *
+     * @example
+     * button.onPaymentInReview().then((data) => console.log('Payment in fraud review'));
+     *
+     * @param {OnPaymentInReviewCallback} [handler] - Function to be called when the payment was left in fraud review status.
+     */
+    onPaymentInReview(handler?: (err: OnPaymentInReviewEventData) => void): Promise<unknown> | (() => void);
+    /**
+     * Callback for onPaymentError method.
+     *
+     * @callback OnPaymentErrorCallback
+     * @param {OnPaymentErrorEventData} data
+     */
+    /**
+     * If the payment was not successful, the function passed as parameter will be called.
+     * Important: Do not perform thread blocking operations in callback such as window.alert() calls.
+     *
+     * @example
+     * button.onPaymentError((err) => {
+     *      console.log('Payment not successful');
+     * });
+     *
+     * @example
+     * button.onPaymentError().then((err) => console.log('Payment not successful'));
+     *
+     * @param {OnPaymentErrorCallback} [handler] - Function to be called when the payment was not successful.
+     */
+    onPaymentError(handler?: (err: OnPaymentErrorEventData) => void): Promise<unknown> | (() => void);
+    /**
+     * Callback for onCheckoutClose method.
+     *
+     * @callback OnCheckoutCloseCallback
+     * @param {OnCloseEventData} data
+     */
+    /**
+     * Registers a callback function to be invoked when the wallet checkout closes.
+     *
+     * @example
+     * button.onCheckoutClose(() => {
+     *      console.log('Wallet checkout closes');
+     * });
+     *
+     * @param {OnCheckoutCloseCallback} handler - Function to be called when the wallet checkout closes.
+     */
+    onCheckoutClose(handler?: (err: OnCloseEventData) => void): Promise<unknown> | (() => void);
+    /**
+     * Callback for onUnavailable method.
+     *
+     * @callback OnUnavailableCallback
+     * @param {OnUnavailableEventData} data
+     */
+    /**
+     * Registers a callback function to be invoked when the wallet is not available in the current context.
+     *
+     * @example
+     * button.onUnavailable(() => {
+     *      console.log('Wallet not available');
+     * });
+     *
+     * @param {OnUnavailableCallback} handler - Function to be called when the wallet is not available in the current context.
+     */
+    onUnavailable(handler?: (err: OnUnavailableEventData) => void): Promise<unknown> | (() => void);
+    /**
+     * Callback for onError method.
+     *
+     * @callback OnErrorCallback
+     * @param {OnErrorEventData} data
+     */
+    /**
+     * Registers a callback function to be invoked when an error that is not related to payment execution occurs.
+     * For example, if the amount of the wallet token injected via the `onClick` event handler does not match the amount provided via the initial `meta` or `setMeta` method.
+     *
+     * @example
+     * button.onError((error) => {
+     *      console.log('WalletButtonExpress error', error);
+     * });
+     *
+     * @param {OnErrorCallback} handler - Function to be called when the WalletButton has an error.
+     */
+    onError(handler?: (err: OnErrorEventData) => void): Promise<unknown> | (() => void);
+    /**
+     * Add docs on each child class
+     */
+    abstract load(): void;
+    /**
+     * Add docs on each child class
+     */
+    abstract setMeta(meta: object): void;
+    protected getGatewayWalletConfig<T>(): Promise<BaseGatewayConfig<T>>;
+    protected executeWalletCallback<T, U extends {
+        request_type: string;
+    }>(data: U): Promise<T>;
+    protected executeWalletCapture<T>(data: WalletCaptureRequest): Promise<T>;
+    protected handleMerchantOnExpressButtonClickEvent(): Promise<void>;
+    private setWalletToken;
+    protected handleCheckoutClose(): void;
+    protected handleOnUnavailable(): void;
+    protected handleOnError(error?: Error): void;
+    protected eventDataFromApiError(err: any): OnPaymentErrorEventData['data'];
+    protected validateRequiredMetaFields(requiredMetaFields: string[]): void;
+}
+
+type ApplePayButtonStyle = 'black' | 'white' | 'white-outline';
+
+type ApplePayButtonType = 'add-money' | 'book' | 'buy' | 'check-out' | 'continue' | 'contribute' | 'donate' | 'order' | 'pay' | 'plain' | 'reload' | 'rent' | 'set-up' | 'subscribe' | 'support' | 'tip' | 'top-up';
+
+interface ApplePayWalletMeta extends BaseWalletMeta {
+    amount_label: string;
+    country: string;
+    merchant_capabilities?: Array<'supports3DS' | 'supportsEMV' | 'supportsCredit' | 'supportsDebit'>;
+    supported_networks?: Array<'visa' | 'masterCard' | 'amex' | 'chinaUnionPay' | 'discover' | 'interac' | 'jcb' | 'privateLabel'>;
+    required_billing_contact_fields?: Array<'email' | 'name' | 'phone' | 'postalAddress'>;
+    required_shipping_contact_fields?: Array<'email' | 'phone'>;
+    supported_countries?: string[];
+    style?: {
+        button_type?: ApplePayButtonType;
+        button_style?: ApplePayButtonStyle;
+    };
+}
+
+/**
+ * Class ApplePayWalletButtonExpress to work with Apple Pay Wallet.
+ *
+ * @extends BaseWalletButton
+ *
+ * @constructor
+ *
+ * @example
+ * var button = new ApplePayWalletButtonExpress('#wallet-buttons', 'publicKeyOrAccessToken', 'gatewayId', meta);
+ *
+ * @param {string} selector - Selector of html element. Container for the ApplePayWalletButtonExpress.
+ * @param {string} publicKeyOrAccessToken - Public key or Access token for the ApplePayWalletButtonExpress.
+ * @param {string} gatewayId - Gateway ID for the ApplePayWalletButtonExpress.
+ * @param {ApplePayWalletMeta} meta - data that configures the Apple Pay Wallet.
+ */
+declare class ApplePayWalletButtonExpress extends BaseWalletButton<ApplePayWalletMeta> {
+    private paymentSession;
+    /** @constructs */ constructor(selector: string, publicKeyOrAccessToken: string, gatewayId: string, meta: ApplePayWalletMeta);
+    /**
+     * Initializes the availability checks and inserts the button if possible.
+     * Otherwise function onUnavailable(handler: VoidFunction) will be called.
+     * **Important**: Is required to invoke this method to render the wallet button.
+     *
+     * @example
+     *  button.load();
+     */
+    load(): void;
+    /**
+     * Call this method if updating the originally-provided meta object after order information changed.
+     * For example, if the order amount has changed from the time where the button was originally rendered.
+     *
+     * @example
+     * button.setMeta(meta);
+     *
+     * @param {ApplePayWalletMeta} meta - // data that configures the Apple Pay Wallet.
+     */
+    setMeta(meta: ApplePayWalletMeta): void;
+    private checkAvailability;
+    private mount;
+    private onApplePayButtonClicked;
+    private createRequest;
+    private onValidateMerchant;
+    private getMerchantSession;
+    private onPaymentAuthorized;
+    private onCancelPayment;
+}
+
+interface PaypalWalletMeta extends BaseWalletMeta {
+    pay_later?: boolean;
+    standalone?: boolean;
+    capture?: boolean;
+    style?: {
+        layout?: 'vertical' | 'horizontal';
+        color?: 'gold' | 'blue' | 'silver' | 'black' | 'white';
+        shape?: 'rect' | 'pill' | 'sharp';
+        borderRadius?: number;
+        height?: number;
+        disableMaxWidth?: boolean;
+        label?: 'paypal' | 'checkout' | 'buynow' | 'pay' | 'installment';
+        tagline?: boolean;
+        messages?: {
+            layout?: 'text' | 'flex';
+            logo?: {
+                type?: 'primary' | 'alternative' | 'inline' | 'none';
+                position?: 'left' | 'right' | 'top';
+            };
+            text?: {
+                color?: 'black' | 'white' | 'monochrome' | 'grayscale';
+                size?: 10 | 11 | 12 | 13 | 14 | 15 | 16;
+                align?: 'left' | 'center' | 'right';
+            };
+            color?: 'blue' | 'black' | 'white' | 'white-no-border' | 'gray' | 'monochrome' | 'grayscale';
+            ratio?: '1x1' | '1x4' | '8x1' | '20x1';
+        };
+    };
+}
+
+/**
+ * Class PaypalWalletButtonExpress to work with Paypal Wallet.
+ *
+ * @extends BaseWalletButton
+ *
+ * @constructor
+ *
+ * @example
+ * var button = new PaypalWalletButtonExpress('#wallet-buttons', 'publicKeyOrAccessToken', 'gatewayId', meta);
+ *
+ * @param {string} selector - Selector of html element. Container for the PaypalWalletButtonExpress.
+ * @param {string} publicKeyOrAccessToken - Public key or Access token for the PaypalWalletButtonExpress.
+ * @param {string} gatewayId - Gateway ID for the PaypalWalletButtonExpress.
+ * @param {PaypalWalletMeta} meta - data that configures the Paypal Wallet.
+ */
+declare class PaypalWalletButtonExpress extends BaseWalletButton<PaypalWalletMeta> {
+    private config;
+    protected paypal: any;
+    protected pendingApprovalPromise?: Promise<any>;
+    /** @constructs */ constructor(selector: string, publicKeyOrAccessToken: string, gatewayId: string, meta: PaypalWalletMeta);
+    /**
+     * Initializes the availability checks and inserts the button if possible.
+     * Otherwise function onUnavailable(handler: VoidFunction) will be called.
+     * **Important**: Is required to invoke this method to render the wallet button.
+     *
+     * @example
+     *  button.load();
+     */
+    load(): void;
+    /**
+     * Call this method if updating the originally-provided meta object after order information changed.
+     * For example, if the order amount has changed from the time where the button was originally rendered.
+     *
+     * @example
+     * button.setMeta(meta);
+     * @param {PaypalWalletMeta} meta - // data that configures the Paypal Wallet.
+     */
+    setMeta(meta: PaypalWalletMeta): void;
+    private renderPaypalButton;
+    private renderPaypalCommonComponent;
+    private renderPaypalStandaloneComponent;
+    private paypalSharedProps;
+}
+
+export { AfterpayCheckoutButton, Api, ApplePayWalletButtonExpress, CHECKOUT_BUTTON_EVENT, Canvas3ds, ClickToPay, Configuration, ELEMENT, EVENT$1 as 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, MultiWidget, PAYMENT_TYPE, PURPOSE, Builder as PaymentSourceBuilder, PaymentSourceWidget, PaypalCheckoutButton, PaypalWalletButtonExpress, STYLABLE_ELEMENT, STYLABLE_ELEMENT_STATE, STYLE, SUPPORTED_CARD_TYPES, TEXT, TRIGGER, TYPE, VAULT_DISPLAY_STYLE, type VaultDisplayStyle, VaultDisplayWidget, WalletButtons, ZipmoneyCheckoutButton };