@paydock/client-sdk 1.104.3-beta → 1.105.1

package/{bundles/types/wallet-buttons/wallet-cba-buttons.d.ts → lib/wallet-buttons/wallet-buttons.d.ts}

@@ -1,7 +1,7 @@
 import { Container } from "../components/container";
 import { IWalletMeta } from "../components/param";
 import { EventEmitter } from "../helper/event-emitter";
-import { IWalletPaymentSuccessful, IWalletUnavailable, IWalletUpdate } from "./interfaces";
+import { IWalletOnClick, IWalletPaymentSuccessful, IWalletUnavailable, IWalletUpdate } from "./interfaces";
 import { ApiInternal } from "../api/api-internal";
 import { IWalletService } from "./wallet-service";
 /**
@@ -13,6 +13,7 @@ import { IWalletService } from "./wallet-service";
  * @param {string} UPDATE=update
  * @param {string} PAYMENT_SUCCESSFUL=paymentSuccessful
  * @param {string} PAYMENT_ERROR=paymentError
+ * @param {string} ON_CLICK=onClick
  */
 export declare const EVENT: {
     UNAVAILABLE: string;
@@ -20,124 +21,20 @@ export declare const EVENT: {
     PAYMENT_SUCCESSFUL: string;
     PAYMENT_ERROR: string;
     PAYMENT_IN_REVIEW: string;
+    AUTH_TOKENS_CHANGED: string;
+    ON_CLICK: string;
+    ON_CHECKOUT_OPEN: string;
+    ON_CHECKOUT_CLOSE: string;
 };
-/**
- * Interface of data from events.
- * @interface IEventData
- *
- * @param {string} event
- * @param {void | IWalletPaymentSuccessful | IWalletUpdate | IWalletUnavailable | any} data
- * */
 export 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
- * */
 export 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 [ApplePay, GooglePay]. N/A for [ PayPal].
- * @param {string} [country] Country of the user. 2 letter ISO code format. Required for [ ApplePay, GooglePay]. N/A for [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_shipping] Used to request or not shipping address in the Wallet checkout, being able to handle amount changes via the `update` event. Optional for [PayPal, ApplePay, GooglePay].
- * @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] Used to style PayPal buttons, check possible values at https://developer.paypal.com/docs/business/checkout/reference/style-guide. Also used at ApplePay to select button type. Optional for [PayPal, ApplePay].
- * @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. Optional for [ApplePay]. 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 [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, Paypal)
+ * 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
  *
  * @example
@@ -145,7 +42,7 @@ export interface IWalletUpdateData {
  *
  * @param {string} selector - Selector of html element. Container for the WalletButtons.
  * @param {string} chargeToken - token for the wallet transaction, created with a secure call to `POST charges/wallet`.
- * @param {IWalletMeta} object - data that configures the E-Wallet, which can be shown on checkout page and configures required customer information.
+ * @param {IWalletMeta} meta - data that configures the E-Wallet, which can be shown on checkout page and configures required customer information.
  */
 declare class WalletButtons {
     protected container: Container;
@@ -153,7 +50,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.
@@ -172,7 +69,7 @@ declare class WalletButtons {
     load(): void;
     /**
      * Triggers the update process of the wallet, if available.
-     * Currently supported by Paypal and ApplePay/GooglePay via MPGS Wallets.
+     * Currently supported by Flypay, Paypal and ApplePay/GooglePay via MPGS Wallets.
      *
      * @example
      * var button = new WalletButtons(
@@ -235,6 +132,27 @@ 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.
+     *
+     * @example
+     * button.close();
+     */
+    close(): void;
     on(eventName: string): Promise<IEventData>;
     on(eventName: string, cb: (data: IEventData) => void): any;
     /**
@@ -317,14 +235,73 @@ declare class WalletButtons {
      * @param {listener} [handler] - Function to be called when the payment was not successful.
      */
     onPaymentError(handler?: (err: IEventData) => void): Promise<unknown> | (() => void);
+    /**
+     * Registers a callback function to be invoked when authentication tokens are changed.
+     * This function allows you to respond to changes in authentication tokens, such as when a user logs in.
+     *
+     * @example
+     * button.onAuthTokensChanged((eventData) => {
+     *     console.log('Authentication tokens changed:', eventData);
+     * });
+     *
+     * @example
+     * button.onAuthTokensChanged().then((eventData) => {
+     *     console.log('Authentication tokens changed:', eventData);
+     * });
+     *
+     * @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;
     private setupPaymentInReviewCallback;
     private setupPaymentErrorCallback;
+    private setupAuthTokensChangedCallback;
 }
 export { WalletButtons };
-//# sourceMappingURL=wallet-cba-buttons.d.ts.map