@payrails/web-sdk 5.29.0-RC.0 → 5.29.0

package/payrails.d.ts

@@ -1,282 +1,144 @@
-import * as _payrails_iframe_event_bus from '@payrails/iframe-event-bus';
 import { LogLevel as LogLevel$1 } from '@payrails/logger';
+import * as _payrails_iframe_event_bus from '@payrails/iframe-event-bus';
 import { FraudProvider } from '@payrails/fraud-sdk';
 
-declare enum PAYMENT_METHOD_CODES {
-    'CARD' = "card",
-    'GOOGLE_PAY' = "googlePay",
-    'PAYPAL' = "payPal",
-    'APPLE_PAY' = "applePay",
-    'GENERIC_REDIRECT' = "genericRedirect",
-    'MERCADO_PAGO' = "mercadoPago",
-    'PIX' = "pix"
+interface Mountable {
+    mount(selector: string | PayrailsElement): void;
+    unmount(): void;
 }
-declare enum PAYMENT_INSTRUMENT_STATUS {
-    'ENABLED' = "enabled",
-    'CREATED' = "created",
-    'DELETED' = "deleted",
-    'DISABLED' = "disabled",
-    'INVALID' = "invalid",
-    'TRANSIENT' = "transient"
+interface ElementOptions {
+    id?: string;
+    dataTestId?: string;
+    className?: string | string[];
+    styles?: Partial<CSSStyleDeclaration>;
 }
-declare class WorkflowExecution {
-    private static _response;
-    static get response(): WorkflowExecutionResponse;
-    static setResponse(response: WorkflowExecutionResponse): typeof WorkflowExecution;
-    static get lookup(): {
-        httpCode: number;
-        body: {
-            data: {
-                paymentCompositionOptions: Array<StorablePaymentCompositionOption>;
-            };
-            links: {
-                authorize: {
-                    href: string;
-                    method: "POST";
-                };
-                execution: string;
-            };
-            name: "lookup";
-        };
-    } | undefined;
-    static get holderReference(): string;
-    static get savedCreditCards(): StoredPaymentInstrument<CardMetadata>[];
-    static get savedPaypalAccounts(): StoredPaymentInstrument<PayPalMetadata>[];
-    static get savedGooglePayAccounts(): StoredPaymentInstrument<CardMetadata>[];
-    static get savedApplePayAccounts(): StoredPaymentInstrument<CardMetadata>[];
-    static get paypalConfig(): PayPalConfig;
-    static get googlePayConfig(): GooglePayConfig[];
-    static isPaymentMethodAvailable(paymentMethod: PAYMENT_METHOD_CODES): boolean;
-    static get applePayConfig(): {
-        merchantIdentifier: string;
-        supportedNetworks: string[];
-        countryCode: string;
-        merchantCapabilities: ApplePayJS.ApplePayMerchantCapability[];
-        requiredBillingContactFields?: ApplePayJS.ApplePayContactField[];
+declare class PayrailsElement implements Mountable {
+    protected element: HTMLElement;
+    protected subElements: Array<Mountable>;
+    readonly id: string | undefined;
+    readonly dataTestId: string | undefined;
+    protected eventBus: _payrails_iframe_event_bus.IframeEventBus;
+    constructor(elementType: string, { id, className, dataTestId }?: ElementOptions);
+    get parentElement(): HTMLElement | null;
+    get selector(): string;
+    mount(location: string): void;
+    protected clean(): void;
+    unmount(): void;
+}
+
+interface IAddress {
+    country?: {
+        code?: string;
+        fullName?: string;
+        iso3?: string;
     };
-    static get url(): string;
-    static get meta(): {
-        customer?: {
-            country?: {
-                code?: string;
-            };
+    postalCode?: string;
+}
+interface IOnChange {
+    isValid: boolean;
+    billingAddress?: IAddress;
+}
+interface AddressSelectorElementOptions extends ElementOptions {
+    translations?: {
+        labels?: {
+            countrySelector?: string;
+            postalCodeInput?: string;
         };
-        order?: {
-            billingAddress?: {
-                country?: {
-                    code?: string;
-                };
-            };
+        placeholders?: {
+            postalCodeInput?: string;
+            countrySelector?: string;
         };
     };
-    static get availablePaymentMethods(): StorablePaymentCompositionOption<CardMetadata | PayPalMetadata, ApplePayConfig | PayPalConfig | GooglePayConfig | undefined>[];
-    static get authorizeLink(): string | undefined;
-    static get createSessionLink(): string | undefined;
-    static get storedPaymentInstruments(): StoredPaymentInstrument<PayPalMetadata & CardMetadata>[];
-    static get storedDropinInstruments(): StoredPaymentInstrument<PayPalMetadata & CardMetadata>[];
-    static getFullPaymentMethodConfig(paymentMethod: PAYMENT_METHOD_CODES): StorablePaymentCompositionOption<CardMetadata | PayPalMetadata, ApplePayConfig | PayPalConfig | GooglePayConfig | undefined> | undefined;
-    static isAddressSelectorEnabled(paymentMethod: PAYMENT_METHOD_CODES): boolean | undefined;
-    static isPaymentInstallmentsEnabled(paymentMethod: PAYMENT_METHOD_CODES): boolean | undefined;
-    static getPaymentInstallmentOptions(paymentMethod: PAYMENT_METHOD_CODES): PaymentInstallmentsConfig;
-    static getStoredInstrumentForPaymentMethod<T = CardMetadata | PayPalMetadata>(paymentMethod: PAYMENT_METHOD_CODES): Array<StoredPaymentInstrument<T>>;
-    static getPaymentMethodForStoredInstrument<T extends CardMetadata | PayPalMetadata>(instrument: StoredPaymentInstrument<T>): {
-        id: string;
-        description?: string;
-        status: PAYMENT_INSTRUMENT_STATUS;
-        integrationType: INTEGRATION_TYPE;
-        config: ApplePayConfig | PayPalConfig | GooglePayConfig | undefined;
-        clientConfig?: {
-            flow?: PAYMENT_CLIENT_FLOW;
-            supportsInstallments?: boolean;
-            installments?: PaymentInstallmentsConfig;
-            supportsBillingInfo?: boolean;
+    styles?: {
+        wrapper?: Partial<CSSStyleDeclaration>;
+        countrySelector?: {
+            wrapper?: Partial<CSSStyleDeclaration>;
+            element?: Partial<CSSStyleDeclaration>;
+            label?: Partial<CSSStyleDeclaration>;
         };
-        paymentMethodCode: PAYMENT_METHOD_CODES;
-    } | undefined;
-    static getPaymentMethodConfig(paymentMethod: StorablePaymentCompositionOption): {
-        id: string;
-        description?: string;
-        status: PAYMENT_INSTRUMENT_STATUS;
-        integrationType: INTEGRATION_TYPE;
-        config: ApplePayConfig | PayPalConfig | GooglePayConfig | undefined;
-        clientConfig?: {
-            flow?: PAYMENT_CLIENT_FLOW;
-            supportsInstallments?: boolean;
-            installments?: PaymentInstallmentsConfig;
-            supportsBillingInfo?: boolean;
+        postalCodeInput?: {
+            wrapper?: Partial<CSSStyleDeclaration>;
+            element?: Partial<CSSStyleDeclaration>;
+            label?: Partial<CSSStyleDeclaration>;
         };
-        paymentMethodCode: PAYMENT_METHOD_CODES;
     };
-}
-interface WorkflowExecutionResponse {
-    id: string;
-    merchantReference: string;
-    holderReference: string;
-    actionRequired?: string;
-    meta: {
-        customer?: {
-            country?: {
-                code?: string;
-            };
-        };
-        order?: {
-            billingAddress?: {
-                country?: {
-                    code?: string;
-                };
-            };
-        };
+    events?: {
+        onBillingAddressChanged?: (e: IOnChange) => void;
     };
-    status: Array<{
-        code: string;
-        time: string;
-    }>;
-    initialResults: Array<{
-        httpCode: number;
-        body: {
-            data: {
-                paymentCompositionOptions: Array<StorablePaymentCompositionOption>;
-            };
-            links: {
-                authorize: {
-                    href: string;
-                    method: 'POST';
-                };
-                execution: string;
-            };
-            name: 'lookup';
-        };
-    }>;
-    links: {
-        startPaymentSession?: {
-            href: string;
-            method: 'POST';
-        };
-        confirm?: {
-            href: string;
-            action?: {
-                parameters?: {
-                    orderId?: string;
-                    tokenId?: string;
-                };
-            };
+}
+
+interface StoreInstrumentElementOptions extends ElementOptions {
+    showStoreInstrumentCheckbox?: boolean;
+    alwaysStoreInstrument?: boolean;
+    defaultStoreInstrumentState?: 'checked' | 'unchecked';
+    translations?: {
+        labels?: {
+            storeInstrument?: string;
+            saveInstrument?: string;
         };
-        redirect?: string;
-        '3ds'?: string;
-        self: string;
     };
-    workflow: {
-        code: string;
-        version: number;
+    styles?: {
+        storeInstrumentCheckbox?: Partial<CSSStyleDeclaration>;
     };
+    events?: PayrailsSDKEvents;
 }
-interface BasePaymentMethodConfig {
-    paymentMethodCode: PAYMENT_METHOD_CODES;
+declare class StoreInstrumentCheckbox extends PayrailsElement {
+    private options;
+    constructor(options: StoreInstrumentElementOptions);
+    get isChecked(): boolean;
+    private createHTML;
+    private applyStyles;
+    private addListeners;
 }
-interface BaseInstallmentOption {
-    count: number;
-    amount: number;
+declare abstract class PayrailsElementWithStoreInstrumentCheckbox extends PayrailsElement {
+    protected options?: StoreInstrumentElementOptions | undefined;
+    protected storeInstrumentCheckbox: StoreInstrumentCheckbox | null;
+    protected constructor(elementType: string, options?: StoreInstrumentElementOptions | undefined);
+    protected get shouldStoreInstrument(): boolean;
 }
-interface PaymentInstallmentsConfig {
-    [key: string]: BaseInstallmentOption[];
+
+interface ApplePayButtonOptions extends StoreInstrumentElementOptions {
+    clientDomain?: string;
+    showPaymentMethodLogo?: boolean;
+    events?: PaymentEvents & {
+        onApplePayAvailable?: () => void;
+    };
+    styles?: {
+        type?: 'plain' | 'buy' | 'addMoney' | 'book' | 'checkout' | 'continue' | 'contribute' | 'donate' | 'inStore' | 'order' | 'reload' | 'rent' | 'setUp' | 'subscribe' | 'support' | 'tip' | 'topUp';
+        style?: 'white' | 'whiteOutline' | 'black' | 'automatic';
+    } & StoreInstrumentElementOptions['styles'];
 }
-interface StorablePaymentCompositionOption<I = CardMetadata | PayPalMetadata, C = undefined | ApplePayConfig | PayPalConfig | GooglePayConfig> extends BasePaymentMethodConfig {
-    id: string;
-    description?: string;
-    status: PAYMENT_INSTRUMENT_STATUS;
-    integrationType: INTEGRATION_TYPE;
-    config: C;
-    clientConfig?: {
-        flow?: PAYMENT_CLIENT_FLOW;
-        supportsInstallments?: boolean;
-        installments?: PaymentInstallmentsConfig;
-        supportsBillingInfo?: boolean;
-    };
-    paymentInstruments?: Array<StoredPaymentInstrument<I>>;
-}
-interface GooglePayConfig {
-    parameters: {
-        allowedAuthMethods: google.payments.api.CardAuthMethod[];
-        allowedCardNetworks: google.payments.api.CardNetwork[];
-    };
-    tokenizationSpecification: google.payments.api.PaymentMethodTokenizationSpecification;
-    type: google.payments.api.PaymentMethodType;
-}
-interface PayPalConfig {
-    clientId: string;
-    merchantId: string;
-    captureMode: 'Delayed' | 'Instant' | 'Manual';
-    integrationMode: 'express' | 'normal';
-}
-interface ApplePayConfig {
-    parameters: {
-        merchantIdentifier: string;
-        supportedNetworks: string[];
-        countryCode: string;
-        merchantCapabilities: ApplePayJS.ApplePayMerchantCapability[];
-        requiredBillingContactFields?: ApplePayJS.ApplePayContactField[];
-    };
-    type: string;
-}
-interface StoredPaymentInstrument<T = CardMetadata | PayPalMetadata> {
-    id: string;
-    status: PAYMENT_INSTRUMENT_STATUS;
-    paymentMethod: PAYMENT_METHOD_CODES;
-    displayName?: string;
-    data?: T;
-}
-interface PayPalMetadata {
-    email?: string;
-}
-interface CardMetadata {
-    bin?: string;
-    suffix?: string;
-    network?: string;
-    binLookup?: {
-        issuerCountry: {
-            code: string;
-            name: string;
-            iso3: string;
-        };
-    };
-}
-declare enum PAYMENT_CLIENT_FLOW {
-    'REDIRECT' = "redirect",
-    'DIRECT' = "direct"
+declare global {
+    interface Window {
+        ApplePaySession?: ApplePaySession;
+    }
 }
-declare enum INTEGRATION_TYPE {
-    API = "api",
-    HPP = "hpp"
+declare class ApplePayButton extends PayrailsElementWithStoreInstrumentCheckbox {
+    protected options: ApplePayButtonOptions;
+    private appleButton;
+    private paymentExecutor;
+    static isApplePayAvailable(): Promise<boolean>;
+    constructor(options: ApplePayButtonOptions);
+    mount(location: string): void;
+    unmount(): void;
+    private mountApplePayButton;
+    private createApplePaySession;
+    private onApplePayAuthorized;
 }
 
-interface SaveInstrumentResponse {
-    id: string;
-    createdAt: string;
-    holderId: string;
-    paymentMethod: PAYMENT_METHOD_CODES.CARD;
-    status: PAYMENT_INSTRUMENT_STATUS;
-    data: {
-        bin: string;
-        binLookup?: {
-            bin: string;
-            network: string;
-            issuer?: string;
-            issuerCountry?: {
-                code?: string;
-                name?: string;
-                iso3?: string;
-            };
-            type?: string;
-        };
-        holderName?: string;
-        network: string;
-        suffix: string;
-        expiryMonth?: string;
-        expiryYear?: string;
-    };
-    fingerprint?: string;
-    futureUsage?: string;
-}
+declare const regexes: {
+    visa: RegExp;
+    mastercard: RegExp;
+    amex: RegExp;
+    diners: RegExp;
+    discover: RegExp;
+    jcb: RegExp;
+    hipercard: RegExp;
+    unionpay: RegExp;
+    maestro: RegExp;
+    elo: RegExp;
+};
+type CardNetwork = keyof typeof regexes;
 
 interface BinLookupResponse {
     bin: string;
@@ -609,30 +471,6 @@ declare class Skyflow {
     static get ValidationRuleType(): typeof ValidationRuleType;
 }
 
-interface Mountable {
-    mount(selector: string | PayrailsElement): void;
-    unmount(): void;
-}
-interface ElementOptions {
-    id?: string;
-    dataTestId?: string;
-    className?: string | string[];
-    styles?: Partial<CSSStyleDeclaration>;
-}
-declare class PayrailsElement implements Mountable {
-    protected element: HTMLElement;
-    protected subElements: Array<Mountable>;
-    readonly id: string | undefined;
-    readonly dataTestId: string | undefined;
-    protected eventBus: _payrails_iframe_event_bus.IframeEventBus;
-    constructor(elementType: string, { id, className, dataTestId }?: ElementOptions);
-    get parentElement(): HTMLElement | null;
-    get selector(): string;
-    mount(location: string): void;
-    protected clean(): void;
-    unmount(): void;
-}
-
 declare enum ElementType {
     CARD_NUMBER = "CARD_NUMBER",
     CARDHOLDER_NAME = "CARDHOLDER_NAME",
@@ -697,7 +535,7 @@ interface PayrailsSecureField {
     resetError?: () => void;
     setValue?: (elementValue: string) => void;
     clearValue?: () => void;
-    update: (data: CollectElementOptions) => void;
+    update?: (data: Partial<CollectElementOptions>) => void;
 }
 declare class PayrailsCollectContainer implements Mountable {
     bin: string;
@@ -733,61 +571,6 @@ interface TokenizeOptions {
     storeInstrument?: boolean;
 }
 
-interface IAddress {
-    country?: {
-        code?: string;
-        fullName?: string;
-        iso3?: string;
-    };
-    postalCode?: string;
-}
-interface IOnChange {
-    isValid: boolean;
-    billingAddress?: IAddress;
-}
-interface AddressSelectorElementOptions extends ElementOptions {
-    translations?: {
-        labels?: {
-            countrySelector?: string;
-            postalCodeInput?: string;
-        };
-        placeholders?: {
-            postalCodeInput?: string;
-            countrySelector?: string;
-        };
-    };
-    styles?: {
-        wrapper?: Partial<CSSStyleDeclaration>;
-        countrySelector?: {
-            wrapper?: Partial<CSSStyleDeclaration>;
-            element?: Partial<CSSStyleDeclaration>;
-            label?: Partial<CSSStyleDeclaration>;
-        };
-        postalCodeInput?: {
-            wrapper?: Partial<CSSStyleDeclaration>;
-            element?: Partial<CSSStyleDeclaration>;
-            label?: Partial<CSSStyleDeclaration>;
-        };
-    };
-    events?: {
-        onBillingAddressChanged?: (e: IOnChange) => void;
-    };
-}
-
-declare const regexes: {
-    visa: RegExp;
-    mastercard: RegExp;
-    amex: RegExp;
-    diners: RegExp;
-    discover: RegExp;
-    jcb: RegExp;
-    hipercard: RegExp;
-    unionpay: RegExp;
-    maestro: RegExp;
-    elo: RegExp;
-};
-type CardNetwork = keyof typeof regexes;
-
 interface PaymentInstallmentsElementOptions extends ElementOptions {
     showPaymentInstallmentsDropdown?: boolean;
     installmentOptions?: BaseInstallmentOption[] | null;
@@ -825,36 +608,6 @@ declare class PayrailsElementWithPaymentInstallmentsDropdown extends PayrailsEle
     setDisabled(state: boolean): void;
 }
 
-interface StoreInstrumentElementOptions extends ElementOptions {
-    showStoreInstrumentCheckbox?: boolean;
-    alwaysStoreInstrument?: boolean;
-    defaultStoreInstrumentState?: 'checked' | 'unchecked';
-    translations?: {
-        labels?: {
-            storeInstrument?: string;
-            saveInstrument?: string;
-        };
-    };
-    styles?: {
-        storeInstrumentCheckbox?: Partial<CSSStyleDeclaration>;
-    };
-    events?: PayrailsSDKEvents;
-}
-declare class StoreInstrumentCheckbox extends PayrailsElement {
-    private options;
-    constructor(options: StoreInstrumentElementOptions);
-    get isChecked(): boolean;
-    private createHTML;
-    private applyStyles;
-    private addListeners;
-}
-declare abstract class PayrailsElementWithStoreInstrumentCheckbox extends PayrailsElement {
-    protected options?: StoreInstrumentElementOptions | undefined;
-    protected storeInstrumentCheckbox: StoreInstrumentCheckbox | null;
-    protected constructor(elementType: string, options?: StoreInstrumentElementOptions | undefined);
-    protected get shouldStoreInstrument(): boolean;
-}
-
 interface OnChange {
     isValid: boolean;
     cardNetwork: CardNetwork | '';
@@ -1327,6 +1080,7 @@ declare class Dropin extends PayrailsElement {
     private loadingScreen;
     constructor(collectContainer: PayrailsCollectContainer, clientConfig: PayrailsClientOptions, dropinConfig: DropinOptions);
     private isHppIntegration;
+    private isGenericDirect;
     private createStoredInstrumentElement;
     private createInstallmentsDropdown;
     private getInstallmentOptionsForInstrument;
@@ -1338,6 +1092,7 @@ declare class Dropin extends PayrailsElement {
     private createCardForm;
     private createApplePayButton;
     private createCardPaymentButton;
+    private createGenericDirectElement;
     private onAuthorizeSuccess;
     private getElementEvents;
     private onAuthorizePending;
@@ -1413,39 +1168,509 @@ interface DropinOptions {
         authFailMsg?: AuthFailedMsgOptions['configuration'];
     };
 }
-interface ContainerStyles {
-    styles?: Partial<CSSStyleDeclaration>;
+interface ContainerStyles {
+    styles?: Partial<CSSStyleDeclaration>;
+}
+
+declare enum RequestMethod {
+    GET = "GET",
+    POST = "POST",
+    DELETE = "DELETE",
+    PATCH = "PATCH"
+}
+
+type Operations = {
+    deleteInstrument: OperationConfig<void, DeleteInstrumentResponse>;
+    updateInstrument: OperationConfig<UpdateInstrumentBody, UpdateInstrumentResponse>;
+};
+interface UpdateInstrumentBody {
+    status?: 'enabled' | 'disabled';
+    networkTransactionReference?: string;
+    merchantReference?: string;
+    paymentMethod?: 'applepay' | 'card' | 'googlepay' | 'paypal';
+    default?: boolean;
+}
+interface UpdateInstrumentResponse {
+    id: string;
+    createdAt: string;
+    holderId: string;
+    paymentMethod: PAYMENT_METHOD_CODES;
+    status: PAYMENT_INSTRUMENT_STATUS;
+    data: {
+        bin?: string;
+        binLookup?: {
+            bin?: string;
+            network?: string;
+            issuer?: string;
+            issuerCountry?: {
+                code?: string;
+                name?: string;
+                iso3?: string;
+            };
+            type?: string;
+        };
+        holderName?: string;
+        network?: string;
+        suffix?: string;
+        expiryMonth?: string;
+        expiryYear?: string;
+    };
+    fingerprint?: string;
+    futureUsage?: string;
+}
+interface DeleteInstrumentResponse {
+    success: boolean;
+}
+type RequestCreator<TReq, TOperation extends keyof Operations> = (config: ApiConfig<TReq> & {
+    operation: TOperation;
+}) => {
+    url: string;
+    body?: TReq;
+};
+interface OperationConfig<TReq, TRes> {
+    linkKey: keyof NonNullable<SdkConfiguration['links']>;
+    method: RequestMethod;
+    createRequest: RequestCreator<TReq, keyof Operations>;
+    requestType: TReq;
+    responseType: TRes;
+}
+interface ApiConfig<TReq> {
+    operation: keyof Operations;
+    resourceId?: string;
+    body?: TReq;
+}
+
+declare class SdkLoader {
+    private static readonly scriptMap;
+    static load<T = void>(sdk: ThirdPartySDK, params?: PayPalScriptConfig): Promise<T>;
+    static reset(): void;
+    static preloadCardForm(): void;
+    private static loadScript;
+    private static loadPayPalScript;
+    private constructor();
+    private static logLoadError;
+}
+interface PayPalScriptConfig {
+    clientId: string;
+    currency: string;
+    vault: boolean;
+    intent: 'tokenize' | 'capture' | 'authorize';
+}
+declare enum ThirdPartySDK {
+    ApplePay = "https://applepay.cdn-apple.com/jsapi/1.latest/apple-pay-sdk.js",
+    GooglePay = "https://pay.google.com/gp/p/js/pay.js",
+    PayPal = "paypal-sdk"
+}
+
+interface QueryDefinition<T> {
+    path: string[];
+    returnType: T;
+}
+
+interface ConfigurationQueryTypes {
+    holderReference: QueryDefinition<string>;
+    amount: QueryDefinition<PayrailsAmount>;
+    binLookup: QueryDefinition<Links | undefined>;
+    instrumentDelete: QueryDefinition<Links | undefined>;
+    instrumentUpdate: QueryDefinition<Links | undefined>;
+    executionId: QueryDefinition<string | undefined>;
+    paymentMethodConfig: QueryDefinition<StorablePaymentCompositionOption | undefined>;
+    paymentMethodInstruments: QueryDefinition<StoredPaymentInstrument<CardMetadata | PayPalMetadata>[] | undefined>;
+}
+
+interface InitOptions {
+    version: string;
+    data: string;
+}
+
+interface PayrailsClientOptions {
+    environment?: PayrailsEnvironment;
+    events?: ClientEvents;
+    redirectFor3DS?: boolean;
+    returnInfo?: ReturnInfo;
+    telemetry?: {
+        enabled?: boolean;
+        logLevel?: LogLevel$1;
+    };
+}
+declare class Payrails {
+    private vaultClient;
+    private options?;
+    private __container;
+    private __cardForm;
+    private __cardList;
+    private __cardPaymentButton;
+    private __paypalButton;
+    private __genericRedirectButton;
+    private __dropin;
+    static preloadCardForm: typeof SdkLoader.preloadCardForm;
+    static init(initResponse: InitOptions, options?: PayrailsClientOptions): Payrails;
+    update(amount: PayrailsAmount): void;
+    collectContainer(containerOptions: CollectContainerOptions): PayrailsCollectContainer;
+    googlePayButton(options: GooglePayButtonOptions): GooglePayButton;
+    isGooglePayAvailable(merchantInfo: google.payments.api.MerchantInfo): Promise<boolean>;
+    applePayButton(options: ApplePayButtonOptions): ApplePayButton;
+    isApplePayAvailable(): Promise<boolean>;
+    cardList(options?: CardListOptions): CardList;
+    cardForm(options?: CardFormOptions): CardForm;
+    dropin(options: DropinOptions): Dropin;
+    getSavedCreditCards(): StoredPaymentInstrument<CardMetadata>[];
+    getSavedGooglePayAccounts(): StoredPaymentInstrument<CardMetadata>[];
+    getSavedApplePayAccounts(): StoredPaymentInstrument<CardMetadata>[];
+    query<K extends keyof ConfigurationQueryTypes>(key: K, params?: Record<string, any>): ConfigurationQueryTypes[K]['returnType'] | null;
+    api<TOperation extends keyof Operations>(config: ApiConfig<Operations[TOperation]['requestType']> & {
+        operation: TOperation;
+    }): Promise<Operations[TOperation]['responseType']>;
+    getStoredInstruments(): StoredPaymentInstrument<PayPalMetadata & CardMetadata>[];
+    getAvailablePaymentMethods(): PAYMENT_METHOD_CODES[];
+    paymentButton(options: CardPaymentButtonOptions): CardPaymentButton;
+    paypalButton(options?: PaypalButtonOptions): PaypalButton;
+    genericRedirectButton(options: GenericRedirectButtonOptions): GenericRedirectButton;
+    getSavedPaypalAccounts(): StoredPaymentInstrument<PayPalMetadata>[];
+    private logIntegrationMode;
+    private constructor();
+    private getContainerLayout;
+    binLookup(): Promise<any>;
+}
+interface ClientEvents {
+    onClientInitialized?: (execution?: typeof WorkflowExecution) => void;
+    onSessionExpired?: () => Promise<InitOptions>;
+}
+interface PaymentEvents {
+    onAuthorizeSuccess?: (e?: any) => void;
+    onAuthorizeFailed?: (e?: any) => void;
+    onAuthorizePending?: (e?: any) => void;
+    onPaymentButtonClicked?: (e?: {
+        bin?: string;
+    }) => Promise<boolean>;
+    onAuthorizeRequestStart?: () => void;
+    onPaymentSessionExpired?: () => void;
+    onThreeDSecureChallenge?: () => void;
+}
+interface UIEvents {
+    onSaveInstrumentCheckboxChanged?: ({ checked }: {
+        checked: boolean;
+    }) => void;
+    onBillingAddressChanged?: (e: {
+        isValid: boolean;
+        billingAddress?: IAddress;
+    }) => void;
+    onDeliveryAddressChanged?: (data?: onDeliveryAddressChangedResponse) => Promise<boolean>;
+}
+type onPaymentMethodSelectedParams = {
+    paymentMethod?: StorablePaymentCompositionOption;
+    instrument?: StoredPaymentInstrument<CardMetadata & PayPalMetadata>;
+};
+interface DropinEvents {
+    onPaymentOptionSelected?: (e: onPaymentMethodSelectedParams) => void;
+}
+type PayrailsSDKEvents = PaymentEvents & UIEvents & DropinEvents;
+type onDeliveryAddressChangedResponse = {
+    deliveryAddress?: {
+        street?: string;
+        doorNumber?: string;
+        complement?: string;
+        area?: string;
+        city?: string;
+        postalCode?: string;
+        state?: string;
+        country?: {
+            code?: string;
+            iso3?: string;
+            name?: string;
+        };
+        latitude?: number;
+        longitude?: number;
+        phone?: {
+            countryCode?: string;
+            number?: string;
+        };
+        name?: string;
+        lastName?: string;
+        email?: string;
+    };
+};
+declare enum PayrailsEnvironment {
+    TEST = "TEST",
+    PRODUCTION = "PRODUCTION"
+}
+
+type JSONSchemaType = JSONSchemaProperty & {
+    required?: string[];
+};
+interface JSONSchemaProperty {
+    type?: 'string' | 'number' | 'boolean' | 'array' | 'object';
+    title?: string;
+    enum?: any[];
+    pattern?: string;
+    minLength?: number;
+    maxLength?: number;
+    errorMessage?: Record<string, string>;
+    properties?: Record<string, JSONSchemaType>;
+}
+
+declare enum PAYMENT_METHOD_CODES {
+    'CARD' = "card",
+    'GOOGLE_PAY' = "googlePay",
+    'PAYPAL' = "payPal",
+    'APPLE_PAY' = "applePay",
+    'GENERIC_REDIRECT' = "genericRedirect",
+    'MERCADO_PAGO' = "mercadoPago",
+    'PIX' = "pix",
+    'BANK_ACCOUNT' = "bankAccount"
+}
+declare enum PAYMENT_INSTRUMENT_STATUS {
+    'ENABLED' = "enabled",
+    'CREATED' = "created",
+    'DELETED' = "deleted",
+    'DISABLED' = "disabled",
+    'INVALID' = "invalid",
+    'TRANSIENT' = "transient"
+}
+declare class WorkflowExecution {
+    private static _response;
+    static get response(): WorkflowExecutionResponse;
+    static setResponse(response: WorkflowExecutionResponse): typeof WorkflowExecution;
+    static get lookup(): {
+        httpCode: number;
+        body: {
+            data: {
+                paymentCompositionOptions: Array<StorablePaymentCompositionOption>;
+            };
+            links: {
+                authorize: {
+                    href: string;
+                    method: "POST";
+                };
+                execution: string;
+            };
+            name: "lookup";
+        };
+    } | undefined;
+    static get holderReference(): string;
+    static get savedCreditCards(): StoredPaymentInstrument<CardMetadata>[];
+    static get savedPaypalAccounts(): StoredPaymentInstrument<PayPalMetadata>[];
+    static get savedGooglePayAccounts(): StoredPaymentInstrument<CardMetadata>[];
+    static get savedApplePayAccounts(): StoredPaymentInstrument<CardMetadata>[];
+    static get paypalConfig(): PayPalConfig;
+    static get googlePayConfig(): GooglePayConfig[];
+    static isPaymentMethodAvailable(paymentMethod: PAYMENT_METHOD_CODES): boolean;
+    static get applePayConfig(): {
+        merchantIdentifier: string;
+        supportedNetworks: string[];
+        countryCode: string;
+        merchantCapabilities: ApplePayJS.ApplePayMerchantCapability[];
+        requiredBillingContactFields?: ApplePayJS.ApplePayContactField[];
+    };
+    static get url(): string;
+    static get meta(): {
+        customer?: {
+            country?: {
+                code?: string;
+            };
+        };
+        order?: {
+            billingAddress?: {
+                country?: {
+                    code?: string;
+                };
+            };
+        };
+    };
+    static get availablePaymentMethods(): StorablePaymentCompositionOption<CardMetadata | PayPalMetadata, ApplePayConfig | PayPalConfig | GooglePayConfig | undefined>[];
+    static get authorizeLink(): string | undefined;
+    static get createSessionLink(): string | undefined;
+    static get storedPaymentInstruments(): StoredPaymentInstrument<PayPalMetadata & CardMetadata>[];
+    static get storedDropinInstruments(): StoredPaymentInstrument<PayPalMetadata & CardMetadata>[];
+    static getFullPaymentMethodConfig(paymentMethod: PAYMENT_METHOD_CODES): StorablePaymentCompositionOption<CardMetadata | PayPalMetadata, ApplePayConfig | PayPalConfig | GooglePayConfig | undefined> | undefined;
+    static isAddressSelectorEnabled(paymentMethod: PAYMENT_METHOD_CODES): boolean | undefined;
+    static isPaymentInstallmentsEnabled(paymentMethod: PAYMENT_METHOD_CODES): boolean | undefined;
+    static getPaymentInstallmentOptions(paymentMethod: PAYMENT_METHOD_CODES): PaymentInstallmentsConfig;
+    static getStoredInstrumentForPaymentMethod<T = CardMetadata | PayPalMetadata>(paymentMethod: PAYMENT_METHOD_CODES): Array<StoredPaymentInstrument<T>>;
+    static getPaymentMethodForStoredInstrument<T extends CardMetadata | PayPalMetadata>(instrument: StoredPaymentInstrument<T>): {
+        id: string;
+        description?: string;
+        status: PAYMENT_INSTRUMENT_STATUS;
+        integrationType: INTEGRATION_TYPE;
+        config: ApplePayConfig | PayPalConfig | GooglePayConfig | undefined;
+        clientConfig?: {
+            flow?: PAYMENT_CLIENT_FLOW;
+            supportsInstallments?: boolean;
+            installments?: PaymentInstallmentsConfig;
+            supportsBillingInfo?: boolean;
+            schema?: JSONSchemaType;
+        };
+        paymentMethodCode: PAYMENT_METHOD_CODES;
+    } | undefined;
+    static getPaymentMethodConfig(paymentMethod: StorablePaymentCompositionOption): {
+        id: string;
+        description?: string;
+        status: PAYMENT_INSTRUMENT_STATUS;
+        integrationType: INTEGRATION_TYPE;
+        config: ApplePayConfig | PayPalConfig | GooglePayConfig | undefined;
+        clientConfig?: {
+            flow?: PAYMENT_CLIENT_FLOW;
+            supportsInstallments?: boolean;
+            installments?: PaymentInstallmentsConfig;
+            supportsBillingInfo?: boolean;
+            schema?: JSONSchemaType;
+        };
+        paymentMethodCode: PAYMENT_METHOD_CODES;
+    };
+}
+interface WorkflowExecutionResponse {
+    id: string;
+    merchantReference: string;
+    holderReference: string;
+    actionRequired?: string;
+    meta: {
+        customer?: {
+            country?: {
+                code?: string;
+            };
+        };
+        order?: {
+            billingAddress?: {
+                country?: {
+                    code?: string;
+                };
+            };
+        };
+    };
+    status: Array<{
+        code: string;
+        time: string;
+    }>;
+    initialResults: Array<{
+        httpCode: number;
+        body: {
+            data: {
+                paymentCompositionOptions: Array<StorablePaymentCompositionOption>;
+            };
+            links: {
+                authorize: {
+                    href: string;
+                    method: 'POST';
+                };
+                execution: string;
+            };
+            name: 'lookup';
+        };
+    }>;
+    links: {
+        startPaymentSession?: {
+            href: string;
+            method: 'POST';
+        };
+        confirm?: {
+            href: string;
+            action?: {
+                parameters?: {
+                    orderId?: string;
+                    tokenId?: string;
+                };
+            };
+        };
+        redirect?: string;
+        '3ds'?: string;
+        self: string;
+    };
+    workflow: {
+        code: string;
+        version: number;
+    };
+}
+interface BasePaymentMethodConfig {
+    paymentMethodCode: PAYMENT_METHOD_CODES;
+}
+interface BaseInstallmentOption {
+    count: number;
+    amount: number;
+}
+interface PaymentInstallmentsConfig {
+    [key: string]: BaseInstallmentOption[];
+}
+interface StorablePaymentCompositionOption<I = CardMetadata | PayPalMetadata, C = undefined | ApplePayConfig | PayPalConfig | GooglePayConfig> extends BasePaymentMethodConfig {
+    id: string;
+    description?: string;
+    status: PAYMENT_INSTRUMENT_STATUS;
+    integrationType: INTEGRATION_TYPE;
+    config: C;
+    clientConfig?: {
+        flow?: PAYMENT_CLIENT_FLOW;
+        supportsInstallments?: boolean;
+        installments?: PaymentInstallmentsConfig;
+        supportsBillingInfo?: boolean;
+        schema?: JSONSchemaType;
+    };
+    paymentInstruments?: Array<StoredPaymentInstrument<I>>;
+}
+interface GooglePayConfig {
+    parameters: {
+        allowedAuthMethods: google.payments.api.CardAuthMethod[];
+        allowedCardNetworks: google.payments.api.CardNetwork[];
+    };
+    tokenizationSpecification: google.payments.api.PaymentMethodTokenizationSpecification;
+    type: google.payments.api.PaymentMethodType;
+}
+interface PayPalConfig {
+    clientId: string;
+    merchantId: string;
+    captureMode: 'Delayed' | 'Instant' | 'Manual';
+    integrationMode: 'express' | 'normal';
+}
+interface ApplePayConfig {
+    parameters: {
+        merchantIdentifier: string;
+        supportedNetworks: string[];
+        countryCode: string;
+        merchantCapabilities: ApplePayJS.ApplePayMerchantCapability[];
+        requiredBillingContactFields?: ApplePayJS.ApplePayContactField[];
+    };
+    type: string;
+}
+interface StoredPaymentInstrument<T = CardMetadata | PayPalMetadata> {
+    id: string;
+    status: PAYMENT_INSTRUMENT_STATUS;
+    paymentMethod: PAYMENT_METHOD_CODES;
+    displayName?: string;
+    data?: T;
+}
+interface PayPalMetadata {
+    email?: string;
+}
+interface CardMetadata {
+    bin?: string;
+    suffix?: string;
+    network?: string;
+    binLookup?: {
+        issuerCountry: {
+            code: string;
+            name: string;
+            iso3: string;
+        };
+    };
+}
+declare enum PAYMENT_CLIENT_FLOW {
+    'REDIRECT' = "redirect",
+    'DIRECT' = "direct"
 }
-
-declare enum RequestMethod {
-    GET = "GET",
-    POST = "POST",
-    DELETE = "DELETE",
-    PATCH = "PATCH"
+declare enum INTEGRATION_TYPE {
+    API = "api",
+    HPP = "hpp"
 }
 
-type Operations = {
-    deleteInstrument: OperationConfig<void, DeleteInstrumentResponse>;
-    updateInstrument: OperationConfig<UpdateInstrumentBody, UpdateInstrumentResponse>;
-};
-interface UpdateInstrumentBody {
-    status?: 'enabled' | 'disabled';
-    networkTransactionReference?: string;
-    merchantReference?: string;
-    paymentMethod?: 'applepay' | 'card' | 'googlepay' | 'paypal';
-    default?: boolean;
-}
-interface UpdateInstrumentResponse {
+interface SaveInstrumentResponse {
     id: string;
     createdAt: string;
     holderId: string;
-    paymentMethod: PAYMENT_METHOD_CODES;
+    paymentMethod: PAYMENT_METHOD_CODES.CARD;
     status: PAYMENT_INSTRUMENT_STATUS;
     data: {
-        bin?: string;
+        bin: string;
         binLookup?: {
-            bin?: string;
-            network?: string;
+            bin: string;
+            network: string;
             issuer?: string;
             issuerCountry?: {
                 code?: string;
@@ -1455,219 +1680,14 @@ interface UpdateInstrumentResponse {
             type?: string;
         };
         holderName?: string;
-        network?: string;
-        suffix?: string;
+        network: string;
+        suffix: string;
         expiryMonth?: string;
         expiryYear?: string;
     };
     fingerprint?: string;
     futureUsage?: string;
 }
-interface DeleteInstrumentResponse {
-    success: boolean;
-}
-type RequestCreator<TReq, TOperation extends keyof Operations> = (config: ApiConfig<TReq> & {
-    operation: TOperation;
-}) => {
-    url: string;
-    body?: TReq;
-};
-interface OperationConfig<TReq, TRes> {
-    linkKey: keyof NonNullable<SdkConfiguration['links']>;
-    method: RequestMethod;
-    createRequest: RequestCreator<TReq, keyof Operations>;
-    requestType: TReq;
-    responseType: TRes;
-}
-interface ApiConfig<TReq> {
-    operation: keyof Operations;
-    resourceId?: string;
-    body?: TReq;
-}
-
-declare class SdkLoader {
-    private static readonly scriptMap;
-    static load<T = void>(sdk: ThirdPartySDK, params?: PayPalScriptConfig): Promise<T>;
-    static reset(): void;
-    static preloadCardForm(): void;
-    private static loadScript;
-    private static loadPayPalScript;
-    private constructor();
-    private static logLoadError;
-}
-interface PayPalScriptConfig {
-    clientId: string;
-    currency: string;
-    vault: boolean;
-    intent: 'tokenize' | 'capture' | 'authorize';
-}
-declare enum ThirdPartySDK {
-    ApplePay = "https://applepay.cdn-apple.com/jsapi/1.latest/apple-pay-sdk.js",
-    GooglePay = "https://pay.google.com/gp/p/js/pay.js",
-    PayPal = "paypal-sdk"
-}
-
-interface QueryDefinition<T> {
-    path: string[];
-    returnType: T;
-}
-
-interface ConfigurationQueryTypes {
-    holderReference: QueryDefinition<string>;
-    amount: QueryDefinition<PayrailsAmount>;
-    binLookup: QueryDefinition<Links | undefined>;
-    instrumentDelete: QueryDefinition<Links | undefined>;
-    instrumentUpdate: QueryDefinition<Links | undefined>;
-    executionId: QueryDefinition<string | undefined>;
-    paymentMethodConfig: QueryDefinition<StorablePaymentCompositionOption | undefined>;
-    paymentMethodInstruments: QueryDefinition<StoredPaymentInstrument<CardMetadata | PayPalMetadata>[] | undefined>;
-}
-
-interface InitOptions {
-    version: string;
-    data: string;
-}
-
-interface PayrailsClientOptions {
-    environment?: PayrailsEnvironment;
-    events?: ClientEvents;
-    redirectFor3DS?: boolean;
-    returnInfo?: ReturnInfo;
-    telemetry?: {
-        enabled?: boolean;
-        logLevel?: LogLevel$1;
-    };
-}
-declare class Payrails {
-    private vaultClient;
-    private options?;
-    private __container;
-    private __cardForm;
-    private __cardList;
-    private __cardPaymentButton;
-    private __paypalButton;
-    private __genericRedirectButton;
-    private __dropin;
-    static preloadCardForm: typeof SdkLoader.preloadCardForm;
-    static init(initResponse: InitOptions, options?: PayrailsClientOptions): Payrails;
-    update(amount: PayrailsAmount): void;
-    collectContainer(containerOptions: CollectContainerOptions): PayrailsCollectContainer;
-    googlePayButton(options: GooglePayButtonOptions): GooglePayButton;
-    isGooglePayAvailable(merchantInfo: google.payments.api.MerchantInfo): Promise<boolean>;
-    applePayButton(options: ApplePayButtonOptions): ApplePayButton;
-    isApplePayAvailable(): Promise<boolean>;
-    cardList(options?: CardListOptions): CardList;
-    cardForm(options?: CardFormOptions): CardForm;
-    dropin(options: DropinOptions): Dropin;
-    getSavedCreditCards(): StoredPaymentInstrument<CardMetadata>[];
-    getSavedGooglePayAccounts(): StoredPaymentInstrument<CardMetadata>[];
-    getSavedApplePayAccounts(): StoredPaymentInstrument<CardMetadata>[];
-    query<K extends keyof ConfigurationQueryTypes>(key: K, params?: Record<string, any>): ConfigurationQueryTypes[K]['returnType'] | null;
-    api<TOperation extends keyof Operations>(config: ApiConfig<Operations[TOperation]['requestType']> & {
-        operation: TOperation;
-    }): Promise<Operations[TOperation]['responseType']>;
-    getStoredInstruments(): StoredPaymentInstrument<PayPalMetadata & CardMetadata>[];
-    getAvailablePaymentMethods(): PAYMENT_METHOD_CODES[];
-    paymentButton(options: CardPaymentButtonOptions): CardPaymentButton;
-    paypalButton(options?: PaypalButtonOptions): PaypalButton;
-    genericRedirectButton(options: GenericRedirectButtonOptions): GenericRedirectButton;
-    getSavedPaypalAccounts(): StoredPaymentInstrument<PayPalMetadata>[];
-    private logIntegrationMode;
-    private constructor();
-    private getContainerLayout;
-    binLookup(): Promise<any>;
-}
-interface ClientEvents {
-    onClientInitialized?: (execution?: typeof WorkflowExecution) => void;
-    onSessionExpired?: () => Promise<InitOptions>;
-}
-interface PaymentEvents {
-    onAuthorizeSuccess?: (e?: any) => void;
-    onAuthorizeFailed?: (e?: any) => void;
-    onAuthorizePending?: (e?: any) => void;
-    onPaymentButtonClicked?: (e?: {
-        bin?: string;
-    }) => Promise<boolean>;
-    onAuthorizeRequestStart?: () => void;
-    onPaymentSessionExpired?: () => void;
-    onThreeDSecureChallenge?: () => void;
-}
-interface UIEvents {
-    onSaveInstrumentCheckboxChanged?: ({ checked }: {
-        checked: boolean;
-    }) => void;
-    onBillingAddressChanged?: (e: {
-        isValid: boolean;
-        billingAddress?: IAddress;
-    }) => void;
-    onDeliveryAddressChanged?: (data?: onDeliveryAddressChangedResponse) => Promise<boolean>;
-}
-type onPaymentMethodSelectedParams = {
-    paymentMethod?: StorablePaymentCompositionOption;
-    instrument?: StoredPaymentInstrument<CardMetadata & PayPalMetadata>;
-};
-interface DropinEvents {
-    onPaymentOptionSelected?: (e: onPaymentMethodSelectedParams) => void;
-}
-type PayrailsSDKEvents = PaymentEvents & UIEvents & DropinEvents;
-type onDeliveryAddressChangedResponse = {
-    deliveryAddress?: {
-        street?: string;
-        doorNumber?: string;
-        complement?: string;
-        area?: string;
-        city?: string;
-        postalCode?: string;
-        state?: string;
-        country?: {
-            code?: string;
-            iso3?: string;
-            name?: string;
-        };
-        latitude?: number;
-        longitude?: number;
-        phone?: {
-            countryCode?: string;
-            number?: string;
-        };
-        name?: string;
-        lastName?: string;
-        email?: string;
-    };
-};
-declare enum PayrailsEnvironment {
-    TEST = "TEST",
-    PRODUCTION = "PRODUCTION"
-}
-
-interface ApplePayButtonOptions extends StoreInstrumentElementOptions {
-    clientDomain?: string;
-    showPaymentMethodLogo?: boolean;
-    events?: PaymentEvents & {
-        onApplePayAvailable?: () => void;
-    };
-    styles?: {
-        type?: 'plain' | 'buy' | 'addMoney' | 'book' | 'checkout' | 'continue' | 'contribute' | 'donate' | 'inStore' | 'order' | 'reload' | 'rent' | 'setUp' | 'subscribe' | 'support' | 'tip' | 'topUp';
-        style?: 'white' | 'whiteOutline' | 'black' | 'automatic';
-    } & StoreInstrumentElementOptions['styles'];
-}
-declare global {
-    interface Window {
-        ApplePaySession?: ApplePaySession;
-    }
-}
-declare class ApplePayButton extends PayrailsElementWithStoreInstrumentCheckbox {
-    protected options: ApplePayButtonOptions;
-    private appleButton;
-    private paymentExecutor;
-    static isApplePayAvailable(): Promise<boolean>;
-    constructor(options: ApplePayButtonOptions);
-    mount(location: string): void;
-    unmount(): void;
-    private mountApplePayButton;
-    private createApplePaySession;
-    private onApplePayAuthorized;
-}
 
 export { AuthorizationFailureReasons, ElementType, INTEGRATION_TYPE, PAYMENT_METHOD_CODES, Payrails, PayrailsEnvironment };
 export type { ApplePayButtonOptions, CardFormOptions, CardListOptions, CardPaymentButtonOptions, DropinOptions, GooglePayButtonOptions, InitOptions, PaymentEvents, PaypalButtonOptions, PayrailsAmount, PayrailsClientOptions, PayrailsContainerType, PayrailsSecureField, PayrailsSecureFieldEvent, SaveInstrumentResponse, WorkflowExecutionResponse };