@paydock/client-sdk 1.115.0 → 1.116.2

package/bundles/index.cjs.d.ts

@@ -1824,6 +1824,7 @@ interface WalletCaptureBody {
             address_country?: string;
             external_payer_id?: string;
             ref_token?: string;
+            wallet_express?: boolean;
         };
     };
 }
@@ -3459,6 +3460,7 @@ interface WalletCaptureRequest {
             address_state?: string;
             ref_token?: string;
             external_payer_id?: string;
+            wallet_express?: boolean;
         };
     };
 }
@@ -3803,4 +3805,215 @@ declare class PaypalWalletButtonExpress extends BaseWalletButton<PaypalWalletMet
     private paypalSharedProps;
 }
 
-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, 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 };
+declare enum ErrorCodes$1 {
+    PROMISE_NOT_ENABLED = "promise_not_enabled",
+    SCRIPT_ERROR = "script_error"
+}
+interface PayPalDataCollectorConfig {
+    mouse_movement?: boolean;
+}
+interface IPayPalDataCollector {
+    collectDeviceData(): Promise<CollectedDeviceData>;
+    setEnv(env: string): void;
+}
+interface CollectedDeviceData {
+    correlation_id: string;
+}
+interface IOnErrorEventData$1 {
+    error_code: ErrorCodes$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.
+ *
+ * @example
+ * var payPalDataCollector = new PayPalDataCollector('FLOW_ID', {});
+ */
+declare class PayPalDataCollector {
+    protected service: IPayPalDataCollector;
+    protected eventEmitter: EventEmitter;
+    /** @constructs */ constructor(flowId?: string, config?: PayPalDataCollectorConfig);
+    /**
+     * After configuring the PayPalDataCollector Widget, starts the process and returns
+     * the correlation id used among the requests.
+     *
+     * @returns {Promise<CollectedDeviceData>} Promise when resolved, returnsa an object
+     * that contains the `correlation_id` key.
+     *
+     * @example
+     * const collectedDeviceData = await payPalDataCollectorWidget.collectDeviceData();
+     * console.log(collectedDeviceData.correlation_id)
+     */
+    collectDeviceData(): Promise<CollectedDeviceData>;
+    /**
+     * Callback for onError method.
+     *
+     * @callback OnErrorCallback
+     * @param {IOnErrorEventData|null} data
+     */
+    /**
+     * If the process fails, the function passed as parameter will be called.
+     * Important: Do not perform thread blocking operations in callback such as window.alert() calls.
+     *
+     * @example
+     * PayPalDataCollector.onError((eventData) => console.log('Some error occur'));
+     *
+     * @param {OnErrorCallback} [callback] - Function to be called when there is an error in the flow.
+     */
+    onError(callback?: (data?: IOnErrorEventData$1) => void): () => void;
+    /**
+     * Current method can change environment. By default environment = test.
+     * This method does not affect Paydock's API calls or environments, is only for PayPal Data Collector
+     * script, in order to know if the script is injected on a live server or is a testing
+     * environment. The available values are `test` and `live`. This should match with the used
+     * `gateway.mode` in Paydock to process the transaction.
+     *
+     * @example
+     * PayPalDataCollector.setEnv('live');
+     * @param {string} env - test, live
+     */
+    setEnv(env: string): void;
+}
+
+interface PayPalStyleConfig {
+    layout?: 'vertical' | 'horizontal';
+    color?: 'blue' | 'gold' | 'silver' | 'black' | 'white';
+    shape?: 'rect' | 'sharp' | 'pill';
+    label?: 'paypal' | 'checkout' | 'buynow' | 'pay';
+    disableMaxWidth?: boolean;
+    disableMaxHeight?: boolean;
+    height?: number;
+    borderRadius?: number;
+    tagline?: boolean;
+}
+interface PayPalMessageConfig {
+    amount?: number;
+    align?: 'center' | 'left' | 'right';
+    color?: 'black' | 'white';
+    position?: 'top' | 'bottom';
+}
+interface PayPalSavePaymentSourceWidgetConfig {
+    style?: PayPalStyleConfig;
+    message?: PayPalMessageConfig;
+}
+interface IPayPalSavePaymentSourceWidget {
+    load(container: Container): void;
+    setEnv(env: string, alias?: string): void;
+}
+declare enum ErrorCodes {
+    UNAVAILABLE = "unavailable",
+    ON_PAYPAL_VAULT_SETUP_TOKEN_ERROR = "onPaypalVaultSetupTokenError",
+    ON_GET_ID_TOKEN_ERROR = "onGetIdTokenError",
+    ON_GET_WALLET_CONFIG_ERROR = "onGetWalletConfigError",
+    ON_GET_SETUP_TOKEN_ERROR = "onGetSetupTokenError",
+    ON_ONE_TIME_TOKEN_ERROR = "onOneTimeTokenError"
+}
+declare enum EVENTS {
+    ON_SUCCESS = "ON_SUCCESS",
+    ON_ERROR = "ON_ERROR",
+    ON_CANCEL = "ON_CANCEL"
+}
+interface IOnSuccessEventData {
+    event: EVENTS.ON_SUCCESS;
+    data: {
+        token: string;
+        email: string;
+    };
+}
+interface IOnErrorEventData {
+    event: EVENTS.ON_ERROR;
+    data: {
+        error_code: ErrorCodes;
+        details?: string;
+        message?: string;
+    };
+}
+interface IOnCancelEventData {
+    event: EVENTS.ON_CANCEL;
+}
+
+/**
+ * PayPal Save Payment Source Widget constructor
+ *
+ * @param {string} selector - Selector of html element. Container for PayPal Save Payment Source Widget.
+ * @param {string} publicKey - PayDock users public key.
+ * @param {string} gatewayId - PayDock's PayPal gatewayId.
+ * @param {PayPalSavePaymentSourceWidgetConfig} config - Extra configuration for the widget, like styles.
+ *
+ * @example
+ * var payPalSavePaymentSourceWidget = new PayPalSavePaymentSourceWidget('#paypalButton', 'public_key', 'gateway_id');
+ */
+declare class PayPalSavePaymentSourceWidget {
+    protected container: Container;
+    protected service: IPayPalSavePaymentSourceWidget;
+    protected eventEmitter: EventEmitter;
+    /** @constructs */ constructor(selector: string, publicKey: string, gatewayId: string, config?: PayPalSavePaymentSourceWidgetConfig);
+    /**
+     * The final method after configuring the PayPalSavePaymentSource Widget to
+     * start the load process.
+     */
+    load(): void;
+    /**
+     * Current method can change environment. By default environment = sandbox.
+     * Also we can change domain alias for this environment. By default domain_alias = paydock.com
+     *
+     * @example
+     * payPalSavePaymentSourceWidget.setEnv('production');
+     * @param {string} env - sandbox, production
+     * @param {string} [alias] - Own domain alias
+     */
+    setEnv(env: string, alias?: string): void;
+    /**
+     * Callback for onSuccess method.
+     *
+     * @callback OnSuccessCallback
+     * @param {IOnSuccessEventData} data
+     */
+    /**
+     * If the setup token was successfully approved and a OTT was generated, the function passed as parameter will be called.
+     * Important: Do not perform thread blocking operations in callback such as window.alert() calls.
+     *
+     * @example
+     * payPalSavePaymentSourceWidget.onSuccess((eventData) => console.log('One time token and email obtained successfully'));
+     *
+     * @param {OnSuccessCallback} [callback] - Function to be called when the result is successful.
+     */
+    onSuccess(callback?: (data: IOnSuccessEventData) => void): () => void;
+    /**
+     * Callback for onError method.
+     *
+     * @callback OnErrorCallback
+     * @param {IOnErrorEventData} data
+     */
+    /**
+     * If in the process for obtaining the setup token fails, the function passed as parameter will be called.
+     * Important: Do not perform thread blocking operations in callback such as window.alert() calls.
+     *
+     * @example
+     * payPalSavePaymentSourceWidget.onError((eventData) => console.log('Some error occurred'));
+     *
+     * @param {OnErrorCallback} [callback] - Function to be called when there is an error in the flow.
+     */
+    onError(callback?: (data: IOnErrorEventData) => void): () => void;
+    /**
+     * Callback for onCancel method.
+     *
+     * @callback OnCancelCallback
+     * @param {IOnCancelEventData} data
+     */
+    /**
+     * If in the process for obtaining the setup token was cancelled, the function passed as parameter will be called.
+     * Important: Do not perform thread blocking operations in callback such as window.alert() calls.
+     *
+     * @example
+     * payPalSavePaymentSourceWidget.onCancel(() => console.log('Operation cancelled'));
+     *
+     * @param {OnCancelCallback} [callback] - Function to be called when the operation is cancelled.
+     */
+    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 };