@paydock/client-sdk 1.117.0 → 1.118.0

package/bundles/index.cjs.d.ts

@@ -58,6 +58,7 @@ declare class Env implements IEnvironment {
 }
 
 type HttpRequestMethod = 'DELETE' | 'GET' | 'OPTIONS' | 'POST' | 'PUT';
+type HttpRequestUrl = string | URL;
 
 type AgentPrototype = Pick<(typeof MicroAgent)['prototype'], 'addPageAction' | 'noticeError'>;
 type AgentMethodNames = keyof AgentPrototype;
@@ -449,6 +450,7 @@ interface IParams extends IStyles$1, ITexts, ICommonParams {
     phone_mask_only_countries?: string;
     language?: string;
     vault_display_token?: string;
+    sdk_origin?: boolean;
 }
 interface ICountryPhoneMask {
     preferred_countries?: string[];
@@ -612,6 +614,7 @@ interface IWalletMeta {
     amount_label?: string;
     country?: string;
     pay_later?: boolean;
+    hide_message?: boolean;
     standalone?: boolean;
     show_billing_address?: boolean;
     request_payer_name?: boolean;
@@ -755,6 +758,7 @@ declare const PAYMENT_TYPE: {
     GIFT_CARD: string;
     BANK_ACCOUNT: string;
     CHECKOUT: string;
+    BSB: string;
 };
 /**
  * Purposes
@@ -803,8 +807,8 @@ interface IPredefinedFields {
 declare class Configuration {
     private configs;
     private env;
-    static createEachToken(accessToken: string, configs: Configuration[], cb: (tokens: string[]) => void, errorCb?: (errors: string[]) => void): void;
-    private static finishCreatingEachToken;
+    static createEachToken(accessToken: string, configs: Configuration[]): Promise<string[]>;
+    private static addTokenInBase64;
     /** @constructs */ constructor(gatewayID?: string, paymentType?: string, purpose?: string);
     /**
      * Destination, where customer will receive all successful responses.
@@ -895,9 +899,11 @@ declare class Configuration {
      * @param {createToken~requestCallback} errorCb - The callback that handles the failed response.
      */
     createToken(accessToken: string, cb: (token: string) => void, errorCb?: (error: any) => void): void;
+    getDefaultGateway<T>(accessToken: string, method: HttpRequestMethod, url: HttpRequestUrl): Promise<T>;
     private send;
     getConfigs(): IGeneral;
     private getUrl;
+    private getDefaultGatewayUrl;
     setGiftCardSchemeData(giftCardScheme: any, processingNetwork: any): void;
 }
 
@@ -1918,6 +1924,7 @@ declare class ApiCheckoutInternal {
     protected api: ApiInternal;
     constructor(api: ApiInternal);
     instructions(session_id: string): Observable<object>;
+    private getInstructionLink;
     callback(payload: Object): Promise<Object>;
     status(id: string): Promise<Object>;
 }
@@ -2270,9 +2277,33 @@ interface IWalletUpdate {
     selected_shipping_option?: IShippingOption;
 }
 
-interface IEventData {
+declare enum EventEnum {
+    UNAVAILABLE = "unavailable",
+    UPDATE = "update",
+    PAYMENT_SUCCESSFUL = "paymentSuccessful",
+    PAYMENT_ERROR = "paymentError",
+    PAYMENT_IN_REVIEW = "paymentInReview",
+    AUTH_TOKENS_CHANGED = "authTokensChanged",
+    ON_CLICK = "onClick",
+    ON_CHECKOUT_OPEN = "onCheckoutOpen",
+    ON_CHECKOUT_CLOSE = "onCheckoutClose"
+}
+
+interface IEventData<T = any> {
     event: string;
-    data: void | IWalletPaymentSuccessful | IWalletUpdate | IWalletUnavailable | IWalletOnClick | any;
+    data: T;
+}
+interface IWalletPaymentSuccessfulEvent extends IEventData<IWalletPaymentSuccessful> {
+    event: EventEnum.PAYMENT_SUCCESSFUL;
+}
+interface IWalletUpdateEvent extends IEventData<IWalletUpdate> {
+    event: EventEnum.UPDATE;
+}
+interface IWalletUnavailableEvent extends IEventData<IWalletUnavailable> {
+    event: EventEnum.UNAVAILABLE;
+}
+interface IWalletOnClickEvent extends IEventData<IWalletOnClick> {
+    event: EventEnum.ON_CLICK;
 }
 interface IWalletUpdateData {
     success: boolean;
@@ -2417,7 +2448,7 @@ declare class WalletButtons {
      *
      * @param {listener} [handler] - Function to be called when no button is available.
      */
-    onUnavailable(handler?: (data: IEventData) => void): Promise<void> | (() => void);
+    onUnavailable(handler?: (data: IWalletUnavailableEvent) => void): Promise<void> | (() => void);
     /**
      * If the wallet performs some update in the checkout process, the function passed as parameter will be called.
      *
@@ -2433,7 +2464,7 @@ declare class WalletButtons {
      *
      * @param {listener} [handler] - Function to be called when the payment was successful.
      */
-    onUpdate(handler?: (data: IEventData) => void): Promise<unknown> | (() => void);
+    onUpdate(handler?: (data: IWalletUpdateEvent) => void): Promise<unknown> | (() => void);
     /**
      * 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.
@@ -2448,7 +2479,7 @@ declare class WalletButtons {
      *
      * @param {listener} [handler] - Function to be called when the payment was successful.
      */
-    onPaymentSuccessful(handler?: (data: IEventData) => void): Promise<unknown> | (() => void);
+    onPaymentSuccessful(handler?: (data: IWalletPaymentSuccessfulEvent) => void): Promise<unknown> | (() => void);
     /**
      * 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.
@@ -2510,7 +2541,7 @@ declare class WalletButtons {
      *
      * @param {listener} handler - Function to be called when the wallet button is clicked.
      */
-    onClick(handler: (data: IEventData) => void): () => void;
+    onClick(handler: (data: IWalletOnClickEvent) => 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.
@@ -2869,6 +2900,7 @@ declare class MultiWidget {
      * @param {string} code - ISO 639-1
      */
     setLanguage(code: any): void;
+    getLink(): Link;
 }
 
 interface IEventMetaData extends IEventData$1 {
@@ -3733,6 +3765,7 @@ declare class ApplePayWalletButtonExpress extends BaseWalletButton<ApplePayWalle
 
 interface PaypalWalletMeta extends BaseWalletMeta {
     pay_later?: boolean;
+    hide_message?: boolean;
     standalone?: boolean;
     capture?: boolean;
     style?: {
@@ -3826,8 +3859,8 @@ interface IOnErrorEventData$1 {
 /**
  * PayPal Data Collector Widget constructor
  *
- * @param {string} flowId - This string identifies the source website of the FraudNet request.
- * @param {PayPalDataCollectorConfig} config - Extra configuration for the widget.
+ * @param {string} [flowId] - This string identifies the source website of the FraudNet request.
+ * @param {PayPalDataCollectorConfig} [config] - Extra configuration for the widget.
  *
  * @example
  * var payPalDataCollector = new PayPalDataCollector('FLOW_ID', {});
@@ -3838,9 +3871,9 @@ declare class PayPalDataCollector {
     /** @constructs */ constructor(flowId?: string, config?: PayPalDataCollectorConfig);
     /**
      * After configuring the PayPalDataCollector Widget, starts the process and returns
-     * the correlation id used among the requests.
+     * the correlation id used among the requests asynchronously.
      *
-     * @returns {Promise<CollectedDeviceData>} Promise when resolved, returnsa an object
+     * @returns {Promise<CollectedDeviceData>} Promise when resolved, returns an object
      * that contains the `correlation_id` key.
      *
      * @example
@@ -4016,4 +4049,4 @@ declare class PayPalSavePaymentSourceWidget {
     onCancel(callback?: (data?: IOnCancelEventData) => void): () => void;
 }
 
-export { AfterpayCheckoutButton, Api, ApplePayWalletButtonExpress, CHECKOUT_BUTTON_EVENT, Canvas3ds, Checkout, 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, InstructionDebugger, MultiWidget, PAYMENT_TYPE, PURPOSE, PayPalDataCollector, PayPalSavePaymentSourceWidget, 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 };
+export { AfterpayCheckoutButton, Api, ApplePayWalletButtonExpress, CHECKOUT_BUTTON_EVENT, Canvas3ds, Checkout, ClickToPay, Configuration, ELEMENT, EVENT$1 as EVENT, Builder$1 as ExternalCheckoutBuilder, Checker as ExternalCheckoutChecker, FORM_FIELD, HtmlMultiWidget, HtmlPaymentSourceWidget, HtmlWidget, type ICheckout, type IClickToPayMeta, type IDetails, type IElementStyleInput, type IEventCheckoutFinishData, type IEventData, type IPayPalMeta, type IStyles$1 as IStyles, type ITexts, type IWalletMeta, type IWalletOnClickEvent, type IWalletPaymentSuccessfulEvent, type IWalletUnavailableEvent, type IWalletUpdateData, type IWalletUpdateEvent, InstructionDebugger, MultiWidget, PAYMENT_TYPE, PURPOSE, PayPalDataCollector, PayPalSavePaymentSourceWidget, 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 };