@paydock/client-sdk 1.120.1 → 1.122.2-beta

package/bundles/index.cjs.d.ts

@@ -1,4 +1,4 @@
-import { Observable, Subscriber } from 'rxjs';
+import { Observable } from 'rxjs';
 import { MicroAgent } from '@newrelic/browser-agent/loaders/micro-agent';
 
 declare class ApiCharge {
@@ -117,7 +117,6 @@ declare class ApiBase {
     protected env: Env;
     auth: string;
     authType: API_AUTH_TYPE;
-    private stoppedPooling;
     constructor(auth: string, authType?: API_AUTH_TYPE);
     /**
      * Current method can change environment. By default environment = sandbox.
@@ -129,9 +128,10 @@ declare class ApiBase {
      * @param {string} [alias] - Own domain alias
      */
     setEnv(env: string, alias?: string): ApiBase;
-    longPollingObservable<Req extends object, Res>(method: 'GET' | 'POST', url: string, requestBody: Req, sessionId: string, reconnectInterval?: number): Observable<Res>;
-    longPull(subscriber: Subscriber<any>, method: any, link: any, auth: any, requestBody: any, sessionId: any, reconnectInterval: any): void;
-    destroyLongPolling(): void;
+    requestObservable<Req extends object, Res>(method: 'GET' | 'POST', url: string, requestBody: Req): Observable<Res>;
+    private makeRequest;
+    private onRequestLoad;
+    private onRequestError;
     setAuthType(): API_AUTH_TYPE;
     getClient(method: Extract<HttpRequestMethod, 'GET' | 'POST'>, link: string): {
         config: XMLHttpRequest;
@@ -145,7 +145,7 @@ declare class ApiBase {
         text: string;
         status: number;
     }, cb: any, errorCb: any): any;
-    parserPromise<Res>({ text, status }: {
+    parserPromise<Res>({ text, status, }: {
         text: string;
         status: number;
     }): Promise<Res>;
@@ -159,15 +159,6 @@ declare class ApiBase {
     };
 }
 
-interface BrowserDetails {
-    name: string;
-    java_enabled: string;
-    language: string;
-    screen_height: string;
-    screen_width: string;
-    time_zone: string;
-    color_depth: string;
-}
 /**
  * Interface for browser details response.
  * @interface BrowserDetails
@@ -180,6 +171,15 @@ interface BrowserDetails {
  * @param {string} [time_zone]
  * @param {string} [color_depth]
  * */
+interface BrowserDetails {
+    name: string;
+    java_enabled: string;
+    language: string;
+    screen_height: string;
+    screen_width: string;
+    time_zone: string;
+    color_depth: string;
+}
 /**
  * Class Api include method for working with paydock api
  * @constructor
@@ -453,6 +453,7 @@ interface IParams extends IStyles$1, ITexts, ICommonParams {
     language?: string;
     vault_display_token?: string;
     sdk_origin?: boolean;
+    hide_ui_errors?: boolean;
 }
 interface ICountryPhoneMask {
     preferred_countries?: string[];
@@ -591,6 +592,7 @@ declare enum WALLET_TYPE {
 }
 interface ApplePayStyles {
     button_type?: 'add-money' | 'book' | 'buy' | 'check-out' | 'continue' | 'contribute' | 'donate' | 'order' | 'pay' | 'plain' | 'reload' | 'rent' | 'set-up' | 'subscribe' | 'support' | 'tip' | 'top-up';
+    button_style?: 'black' | 'white' | 'white-outline';
 }
 interface GooglePayStyles {
     button_type?: 'book' | 'buy' | 'checkout' | 'donate' | 'order' | 'pay' | 'plain' | 'subscribe';
@@ -631,6 +633,7 @@ interface IWalletMeta {
     style?: WalletStyles;
     wallets?: WALLET_TYPE[];
     client_id?: string;
+    apple_pay_capabilities?: Array<'credentials_available' | 'credentials_status_unknown' | 'credentials_unavailable'>;
 }
 
 declare class Link {
@@ -940,6 +943,45 @@ interface IElementStyleTitleDescription {
     margin?: string;
 }
 
+declare const ERROR_CATEGORY: {
+    readonly CONFIGURATION: "configuration";
+    readonly IDENTITY: "identity_access_management";
+    readonly INTERNAL: "internal";
+    readonly PROCESS: "process";
+    readonly RESOURCE: "resource";
+    readonly VALIDATION: "validation";
+};
+type ErrorCategory = (typeof ERROR_CATEGORY)[keyof typeof ERROR_CATEGORY];
+declare const ERROR_CAUSE: {
+    readonly ABORTED: "aborted";
+    readonly ACCESS_FORBIDDEN: "access_forbidden";
+    readonly ALREADY_EXISTS: "already_exists";
+    readonly CANCELED: "canceled";
+    readonly INVALID_CONFIGURATION: "invalid_configuration";
+    readonly INVALID_INPUT: "invalid_input";
+    readonly NOT_FOUND: "not_found";
+    readonly NOT_IMPLEMENTED: "not_implemented";
+    readonly RATE_LIMITED: "rate_limited";
+    readonly SERVER_BUSY: "server_busy";
+    readonly SERVICE_UNREACHABLE: "service_unreachable";
+    readonly UNAUTHORIZED: "unauthorized";
+    readonly UNKNOWN: "unknown_error";
+    readonly UNPROCESSABLE_ENTITY: "unprocessable_entity";
+};
+type ErrorCause = (typeof ERROR_CAUSE)[keyof typeof ERROR_CAUSE];
+interface ErrorDetails {
+    cause: ErrorCause;
+    contextId: string;
+    message: string;
+    timestamp: string;
+}
+interface IEventError {
+    cause: ErrorCause;
+    category: ErrorCategory;
+    retryable: boolean;
+    details: ErrorDetails;
+}
+
 /**
  *
  * Class MultiWidget include method for for creating iframe url
@@ -1133,6 +1175,13 @@ declare class MultiWidget {
      * @param {boolean} validateCardNumberInput - [validateCardNumberInput=false] - using this param you allow validation for card number input on supported card types
      */
     setSupportedCardIcons(elements: string[], validateCardNumberInput?: boolean): void;
+    /**
+     * Current method can hide prevent the widget from showing the error messages
+     *
+     * @example
+     * widget.hideUiErrors('id');
+     */
+    hideUiErrors(): 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
@@ -1164,7 +1213,7 @@ declare class MultiWidget {
      */
     setLanguage(code: any): void;
     getLink(): Link;
-    protected handleErrorEvent(err: IErrorEvent): void;
+    protected handleErrorEvent(event: EventTypes, error: IEventError, purpose: PURPOSE): void;
 }
 
 interface ITriggerData {
@@ -1660,6 +1709,7 @@ interface IEventData$1 {
     widget_id: string;
     data?: any;
     ref_id?: string;
+    error?: IEventError;
 }
 declare const EVENT$1: {
     readonly AFTER_LOAD: "afterLoad";
@@ -1694,13 +1744,6 @@ declare const EVENT$1: {
     readonly DISPATCH_ERROR: "dispatchError";
 };
 type EventTypes = typeof EVENT$1[keyof typeof EVENT$1];
-interface IErrorEvent {
-    event: EventTypes;
-    status?: number;
-    data: {
-        _message: string;
-    } & Record<string, any>;
-}
 interface Listener {
     event: string;
     listener: (event: any) => void;
@@ -2732,7 +2775,7 @@ interface GetConfigResponse {
 declare class ApiCheckoutInternal {
     protected api: ApiInternal;
     constructor(api: ApiInternal);
-    instructions(session_id: string): Observable<object>;
+    instructions(): Observable<object>;
     private getInstructionLink;
     callback(payload: Object): Promise<Object>;
     status(id: string): Promise<Object>;
@@ -3347,7 +3390,7 @@ declare class WalletButtons {
     private setupAuthTokensChangedCallback;
 }
 
-type Instruction = new (selector: string, formSelector: string, api: ApiInternal) => InstructionHandler & InstructionDestroyable & InstructionDecorated;
+type Instruction = new (selector: string, formSelector: string, api: ApiInternal, checkoutWidget: Checkout) => InstructionHandler & InstructionDestroyable & InstructionDecorated;
 interface InstructionHandleable {
     handle(payload: object, eventEmitter: EventEmitter): void;
 }
@@ -3361,7 +3404,8 @@ declare abstract class InstructionHandler implements InstructionHandleable, Inst
     selector: string;
     formSelector: string;
     api: ApiInternal;
-    constructor(selector: string, formSelector: string, api: ApiInternal);
+    protected checkoutWidget?: Checkout;
+    constructor(selector: string, formSelector: string, api: ApiInternal, checkoutWidget?: Checkout);
     instruction: string;
     abstract handle(context: object, eventEmitter?: any): void;
     abstract destroy(): void;
@@ -3378,9 +3422,7 @@ interface IntentTokenPayload {
     intent_id: string;
     version: number;
     env_alias: string;
-}
-declare class InstructionDebugger {
-    constructor(selector: string, formSelector: string, version: number, instructionName: string, context: object, token?: string);
+    whitelist_domains: string[];
 }
 /**
  * Class CheckoutButton transform usual button into checkout
@@ -3401,15 +3443,27 @@ declare class Checkout {
     protected container: Container;
     protected intentTokenPayload: IntentTokenPayload;
     protected api: ApiInternal;
+    protected checkoutApi: ApiCheckoutInternal;
     protected instructions: InstructionModule;
     protected currentInstruction: InstructionDestroyable & InstructionHandleable;
+    private timeoutTimer;
+    private requestInFlight;
+    private inTimeoutRange;
+    private checkoutFinished;
     constructor(formSelector: string, intentToken: string, debug?: boolean);
+    fetchInstruction(): void;
+    finaliseCheckout(): void;
+    private setupTimeoutTimer;
     private extractIntentTokenPayload;
+    validateJWTWhitelistedDomains(whitelist_domains: string[]): boolean;
     private ready;
     private initContractVersion;
-    private listenInstructions;
+    private isTimeoutInstruction;
+    private handleInstruction;
+    private handleTimeoutInstructions;
+    private getInstructionFromResponse;
+    private extractInstructionPayloadFromResponse;
     private setEnv;
-    private createWidgetStructure;
     /**
      * 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.
@@ -3440,8 +3494,12 @@ declare class Checkout {
      * });
      */
     onPaymentExpired(handler: (data: IEventData$1) => void): () => void;
+    createWidgetStructure(): void;
     private setStyles;
 }
+declare class InstructionDebugger {
+    constructor(selector: string, formSelector: string, version: number, instructionName: string, context: object, token?: string);
+}
 
 declare enum EVENT {
     UNAVAILABLE = "unavailable",
@@ -3450,7 +3508,9 @@ declare enum EVENT {
     PAYMENT_ERROR = "paymentError",
     PAYMENT_IN_REVIEW = "paymentInReview",
     ON_CLICK = "onClick",
-    ON_CHECKOUT_CLOSE = "onCheckoutClose"
+    ON_CHECKOUT_CLOSE = "onCheckoutClose",
+    ON_SHIPPING_ADDRESS_CHANGE = "onShippingAddressChange",
+    ON_SHIPPING_OPTIONS_CHANGE = "onShippingOptionsChange"
 }
 
 interface BaseEventData<T> {
@@ -3519,6 +3579,50 @@ interface BaseGatewayConfig<T> {
     credentials?: T;
 }
 
+interface ChargeWalletTokenMeta {
+    charge: {
+        id: string;
+        amount: number;
+        currency: string;
+        capture?: boolean;
+        reference?: string;
+        shipping?: {
+            amount?: number;
+            currency?: string;
+            address_line1?: string;
+            address_line2?: string;
+            address_line3?: string;
+            address_city?: string;
+            address_postcode?: string;
+            address_state?: string;
+            address_country?: string;
+            address_company?: string;
+            address_origin_postcode?: string;
+            method?: string;
+            type?: string;
+            options?: Array<{
+                id?: string;
+                label?: string;
+                detail?: string;
+                amount?: string;
+                currency?: string;
+                type?: string;
+            }>;
+            contact?: {
+                first_name?: string;
+                last_name?: string;
+                email?: string;
+                phone?: string;
+                phone2?: string;
+            };
+        };
+    };
+    gateway: {
+        mode: string;
+        type: string;
+    };
+}
+
 interface BaseWalletMeta {
     amount: number;
     currency: string;
@@ -3528,14 +3632,63 @@ interface OnErrorEventData extends BaseEventData<Error> {
     event: EVENT.ERROR;
 }
 
+interface OnShippingAddressChangeEventData extends BaseEventData<AddressChangeEventData> {
+    event: EVENT.ON_SHIPPING_ADDRESS_CHANGE;
+}
+interface AddressChangeEventData {
+    address_postcode?: string;
+    address_city?: string;
+    address_state?: string;
+    address_country?: string;
+    address_line1?: string;
+    address_line2?: string;
+    contact?: {
+        phone?: string;
+        email?: string;
+        first_name?: string;
+        last_name?: string;
+    };
+}
+
+interface OnShippingOptionChangeEventData extends BaseEventData<ShippingOptionChangeEventData> {
+    event: EVENT.ON_SHIPPING_OPTIONS_CHANGE;
+}
+interface ShippingOptionChangeEventData {
+    shipping_option_id?: string;
+    amount?: string;
+    label?: string;
+    detail?: string;
+}
+
+interface OnShippingAddressChangeEventResponse {
+    token?: string;
+    error?: {
+        code: 'address_error' | 'country_error' | 'state_error' | 'zip_error' | 'shipping_contact_invalid' | 'billing_contact_invalid' | string;
+        field?: 'phone' | 'email' | 'name' | 'phonetic_name' | 'address_lines' | 'locality' | 'postal_code' | 'administrative_area' | 'country' | 'country_code';
+        message?: string;
+    };
+}
+
+interface OnShippingOptionChangeEventResponse {
+    token?: string;
+    label?: string;
+    amount?: string;
+    error?: {
+        code: 'method_unavailable' | 'store_unavailable' | string;
+    };
+}
+
+type ShippingEventToResponse<T> = T extends OnShippingAddressChangeEventData ? OnShippingAddressChangeEventResponse : T extends OnShippingOptionChangeEventData ? OnShippingOptionChangeEventResponse : never;
+
 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?;
+    protected eventEmitter: EventEmitter;
+    protected chargeWalletTokenMeta?: ChargeWalletTokenMeta;
+    private onShippingOptionsChangeHandlerRegistered;
     constructor(selector: string, publicKeyOrAccessToken: string, gatewayId: string, meta: T, requiredMetaFields: string[]);
     private getApiAuthType;
     /**
@@ -3653,6 +3806,52 @@ declare abstract class BaseWalletButton<T extends BaseWalletMeta> {
      * @param {OnCheckoutCloseCallback} handler - Function to be called when the wallet checkout closes.
      */
     onCheckoutClose(handler?: (err: OnCloseEventData) => void): Promise<unknown> | (() => void);
+    /**
+     * Callback for onShippingAddressChange method.
+     *
+     * @callback OnShippingAddressChangeCallback
+     * @param {OnShippingAddressChangeEventData} data
+     * @return {Promise<OnShippingAddressChangeEventResponse>} Address update result
+     */
+    /**
+     * If shipping address data is updated, the function passed as parameter will be called.
+     * Use this method to listen for shipping address selection or input from customer when shipping is enabled.
+     * The event handler needs to return a new token in case a backend to backend wallet update call was executed.
+     * In addition, if any error occured, an error string must be supplied.
+     * By default, the event handler will be processed successfuly if neither token nor error is returned.
+     *
+     * @example
+     * button.onShippingAddressChange((data) => {
+     *     const responseData = await fetch('https://your-server.com/update-shipping-info');
+     *     return { error: null, token: responseData.walletToken };
+     * });
+     *
+     * @param {OnShippingAddressChangeCallback} [handler] - Function to be called when the shipping address data is updated.
+     */
+    onShippingAddressChange(handler?: (data: OnShippingAddressChangeEventData) => Promise<OnShippingAddressChangeEventResponse>): () => void;
+    /**
+     * Callback for onShippingOptionsChange method.
+     *
+     * @callback OnShippingOptionsChangeCallback
+     * @param {OnShippingOptionChangeEventData} data
+     * @return {Promise<OnShippingOptionChangeEventResponse>} Address update result
+     */
+    /**
+     * If shipping options data is updated, the function passed as parameter will be called.
+     * Use this method to listen for shipping option selection from customer when shipping is enabled.
+     * The event handler needs to return a new token in case a backend to backend wallet update call was executed.
+     * In addition, if any error occured, an error string must be supplied.
+     * By default, the event handler will be processed successfuly if neither token nor error is returned.
+     *
+     * @example
+     * button.onShippingOptionsChange((data) => {
+     *     const responseData = await fetch('https://your-server.com/update-shipping-info');
+     *     return { error: null, token: responseData.walletToken };
+     * });
+     *
+     * @param {OnShippingOptionsChangeCallback} [handler] - Function to be called when the shipping options data is updated.
+     */
+    onShippingOptionsChange(handler?: (data: OnShippingOptionChangeEventData) => Promise<OnShippingOptionChangeEventResponse>): () => void;
     /**
      * Callback for onUnavailable method.
      *
@@ -3702,7 +3901,10 @@ declare abstract class BaseWalletButton<T extends BaseWalletMeta> {
     }>(data: U): Promise<T>;
     protected executeWalletCapture<T>(data: WalletCaptureRequest): Promise<T>;
     protected handleMerchantOnExpressButtonClickEvent(): Promise<void>;
-    private setWalletToken;
+    protected handleMerchantOnShippingChangedEvent<T extends OnShippingAddressChangeEventData | OnShippingOptionChangeEventData>(eventData: T): Promise<ShippingEventToResponse<T>>;
+    protected setWalletToken(token: string, opts?: {
+        skipApiAuth: boolean;
+    }): void;
     protected handleCheckoutClose(): void;
     protected handleOnUnavailable(): void;
     protected handleOnError(error?: Error): void;
@@ -3714,6 +3916,26 @@ 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';
 
+declare enum ContactShippingEditingMode {
+    AVAILABLE = "available",
+    STORE_PICKUP = "store_pickup"
+}
+
+interface AppleShippingType {
+    contact: {
+        email: string;
+        phone: string;
+        first_name: string;
+        last_name: string;
+    };
+    address_line1: string;
+    address_line2: string;
+    address_city: string;
+    address_postcode: string;
+    address_state: string;
+    address_country: string;
+}
+
 interface ApplePayWalletMeta extends BaseWalletMeta {
     amount_label: string;
     country: string;
@@ -3721,11 +3943,14 @@ interface ApplePayWalletMeta extends BaseWalletMeta {
     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'>;
+    apple_pay_capabilities?: Array<'credentials_available' | 'credentials_status_unknown' | 'credentials_unavailable'>;
     supported_countries?: string[];
     style?: {
         button_type?: ApplePayButtonType;
         button_style?: ApplePayButtonStyle;
     };
+    shipping?: AppleShippingType;
+    shipping_editing_mode?: ContactShippingEditingMode;
 }
 
 /**
@@ -3772,7 +3997,15 @@ declare class ApplePayWalletButtonExpress extends BaseWalletButton<ApplePayWalle
     private onValidateMerchant;
     private getMerchantSession;
     private onPaymentAuthorized;
+    private formatCapabilities;
     private onCancelPayment;
+    private parseShippingContact;
+    private parseShippingMethod;
+    private onApplePayShippingContactUpdate;
+    private onApplePayShippingMethodUpdate;
+    private parseShippingMethodUpdateEvent;
+    private parseShippingContactUpdateEvent;
+    private formatErrorFields;
 }
 
 interface PaypalWalletMeta extends BaseWalletMeta {
@@ -3806,6 +4039,169 @@ interface PaypalWalletMeta extends BaseWalletMeta {
     };
 }
 
+interface PayPalSDK {
+    Buttons?: (options?: PayPalButtonsComponentOptions) => PayPalButtonsComponent;
+    Messages?: (options?: PayPalMessagesComponentOptions) => PayPalMessagesComponent;
+    FUNDING?: Record<string, FUNDING_SOURCE>;
+}
+interface PayPalButtonsComponentOptions {
+    /**
+     * Called on button click to set up a one-time payment. [createOrder docs](https://developer.paypal.com/docs/business/javascript-sdk/javascript-sdk-reference/#createorder).
+     */
+    createOrder?: PayPalButtonCreateOrder;
+    /**
+     * Used for defining a standalone button.
+     * Learn more about [configuring the funding source for standalone buttons](https://developer.paypal.com/docs/business/checkout/configure-payments/standalone-buttons/#4-funding-sources).
+     */
+    fundingSource?: PayPalButtonFundingSource;
+    /**
+     * Called when finalizing the transaction. Often used to inform the buyer that the transaction is complete. [onApprove docs](https://developer.paypal.com/docs/business/javascript-sdk/javascript-sdk-reference/#onapprove).
+     */
+    onApprove?: PayPalButtonOnApprove;
+    /**
+     * Called when the buyer cancels the transaction.
+     * Often used to show the buyer a [cancellation page](https://developer.paypal.com/docs/business/checkout/add-capabilities/buyer-experience/#3-show-cancellation-page).
+     */
+    onCancel?: PayPalButtonOnCancel;
+    /**
+     * Called when the button is clicked. Often used for [validation](https://developer.paypal.com/docs/checkout/integration-features/validation/).
+     */
+    onClick?: PayPalButtonOnClick;
+    /**
+     * Catch all for errors preventing buyer checkout.
+     * Often used to show the buyer an [error page](https://developer.paypal.com/docs/checkout/integration-features/handle-errors/).
+     */
+    onError?: PayPalButtonOnError;
+    /**
+     * Called when the buyer selects a new shipping option on PayPal.
+     */
+    onShippingOptionsChange?: PayPalButtonOnShippingOptionsChange;
+    /**
+     * Called when the buyer updates their shipping address on PayPal.
+     */
+    onShippingAddressChange?: PayPalButtonOnShippingAddressChange;
+    /**
+     * [Styling options](https://developer.paypal.com/docs/business/checkout/reference/style-guide/#customize-the-payment-buttons) for customizing the button appearance.
+     */
+    style?: PayPalButtonStyle;
+}
+interface PayPalButtonsComponent {
+    close: () => Promise<void>;
+    isEligible: () => boolean;
+    render: (container: HTMLElement | string) => Promise<void>;
+    updateProps: (props: PayPalButtonsComponentOptions) => Promise<void>;
+}
+type PayPalButtonCreateOrder = (data: CreateOrderData) => Promise<string>;
+interface CreateOrderData {
+    paymentSource: FUNDING_SOURCE;
+}
+type PayPalButtonFundingSource = FUNDING_SOURCE;
+type FUNDING_SOURCE = 'paypal' | 'venmo' | 'applepay' | 'itau' | 'credit' | 'paylater' | 'card' | 'ideal' | 'sepa' | 'bancontact' | 'giropay' | 'sofort' | 'eps' | 'mybank' | 'p24' | 'verkkopankki' | 'payu' | 'blik' | 'trustly' | 'zimpler' | 'maxima' | 'oxxo' | 'boletobancario' | 'wechatpay' | 'mercadopago' | 'multibanco';
+type PayPalButtonOnApprove = (data: OnApproveData) => Promise<void>;
+interface OnApproveData {
+    billingToken?: string | null;
+    facilitatorAccessToken?: string;
+    orderID: string;
+    payerID?: string | null;
+    paymentID?: string | null;
+    subscriptionID?: string | null;
+    authCode?: string | null;
+}
+type PayPalButtonOnCancel = (data: Record<string, unknown>) => void;
+type PayPalButtonOnClick = (data: Record<string, unknown>, actions: OnClickActions) => Promise<void> | void;
+interface OnClickActions {
+    reject: () => Promise<void>;
+    resolve: () => Promise<void>;
+}
+type PayPalButtonOnError = (err: Record<string, unknown>) => void;
+type PayPalButtonOnShippingOptionsChange = (data: OnShippingOptionsChangeData, actions: OnShippingOptionsChangeActions) => Promise<void>;
+interface OnShippingOptionsChangeData {
+    orderID?: string;
+    paymentID?: string;
+    paymentToken?: string;
+    errors: {
+        METHOD_UNAVAILABLE: string;
+        STORE_UNAVAILABLE: string;
+    };
+    selectedShippingOption?: CheckoutShippingOption;
+}
+interface CheckoutShippingOption {
+    amount: CurrencyCodeAndValue;
+    id?: string;
+    label: string;
+    selected: boolean;
+    type: 'SHIPPING' | 'PICKUP';
+}
+interface CurrencyCodeAndValue {
+    currencyCode: string;
+    value: string;
+}
+interface OnShippingOptionsChangeActions {
+    reject: (reason?: string) => Promise<void>;
+}
+type PayPalButtonOnShippingAddressChange = (data: OnShippingAddressChangeData, actions: OnShippingAddressChangeActions) => Promise<void>;
+interface OnShippingAddressChangeData {
+    amount: CurrencyCodeAndValue;
+    orderID?: string;
+    paymentID?: string;
+    paymentToken?: string;
+    errors: {
+        ADDRESS_ERROR: string;
+        COUNTRY_ERROR: string;
+        STATE_ERROR: string;
+        ZIP_ERROR: string;
+    };
+    shippingAddress: {
+        city: string;
+        state: string;
+        /** The [two-character ISO 3166-1 code](/docs/integration/direct/rest/country-codes/) that identifies the country or region. */
+        countryCode: string;
+        /**
+         * The postal code, which is the zip code or equivalent.
+         * Typically required for countries with a postal code or an equivalent.
+         */
+        postalCode: string;
+    };
+}
+interface OnShippingAddressChangeActions {
+    reject: (reason?: string) => Promise<void>;
+}
+interface PayPalButtonStyle {
+    borderRadius?: number;
+    color?: 'gold' | 'blue' | 'silver' | 'white' | 'black';
+    disableMaxWidth?: boolean;
+    height?: number;
+    label?: 'paypal' | 'checkout' | 'buynow' | 'pay' | 'installment' | 'subscribe' | 'donate';
+    layout?: 'vertical' | 'horizontal';
+    shape?: 'rect' | 'pill' | 'sharp';
+    tagline?: boolean;
+}
+interface PayPalMessagesComponentOptions {
+    amount?: number | string;
+    currency?: 'USD' | 'GBP' | 'EUR';
+    style?: {
+        layout?: 'text' | 'flex' | 'custom';
+        color?: string;
+        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';
+        };
+        ratio?: '1x1' | '1x4' | '8x1' | '20x1';
+    };
+    placement?: 'home' | 'category' | 'product' | 'cart' | 'payment';
+    onApply?: (data: Record<string, unknown>) => void;
+    onClick?: (data: Record<string, unknown>) => void;
+    onRender?: (data: Record<string, unknown>) => void;
+}
+interface PayPalMessagesComponent {
+    render: (container: HTMLElement | string) => Promise<void>;
+}
+
 /**
  * Class PaypalWalletButtonExpress to work with Paypal Wallet.
  *
@@ -3823,8 +4219,11 @@ interface PaypalWalletMeta extends BaseWalletMeta {
  */
 declare class PaypalWalletButtonExpress extends BaseWalletButton<PaypalWalletMeta> {
     private config;
-    protected paypal: any;
-    protected pendingApprovalPromise?: Promise<any>;
+    protected paypal: PayPalSDK;
+    protected pendingApprovalPromise?: Promise<{
+        status: string;
+    }>;
+    private shippingRequested;
     /** @constructs */ constructor(selector: string, publicKeyOrAccessToken: string, gatewayId: string, meta: PaypalWalletMeta);
     /**
      * Initializes the availability checks and inserts the button if possible.
@@ -3848,6 +4247,8 @@ declare class PaypalWalletButtonExpress extends BaseWalletButton<PaypalWalletMet
     private renderPaypalCommonComponent;
     private renderPaypalStandaloneComponent;
     private paypalSharedProps;
+    private handleShippingAddressUpdate;
+    private handleShippingOptionsUpdate;
 }
 
 declare enum ErrorCodes$1 {