@payrails/web-sdk 5.37.9 → 5.38.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payrails/web-sdk",
-  "version": "5.37.9",
+  "version": "5.38.2",
   "description": "SDK providing tokenization options on the client for merchants",
   "main": "index.js",
   "types": "payrails.d.ts",

package/payrails.d.ts

@@ -97,8 +97,40 @@ declare enum PAYMENT_METHOD_CODES {
     'IDEAL' = "iDeal",
     'YAPE' = "yape",
     'UPI' = "upi",
-    'KLARNA' = "klarna"
-}
+    'KLARNA' = "klarna",
+    'ONE_VOUCHER' = "1voucher",
+    'ALFA' = "alfa",
+    'APLAZO' = "aplazo",
+    'BANK_TRANSFER' = "bankTransfer",
+    'CAPITEC_PAY' = "capitecPay",
+    'EASYPAISA' = "easypaisa",
+    'EFT_PRO' = "eftPro",
+    'FAWRY_PAY' = "fawryPay",
+    'JAZZ_CASH' = "jazzCash",
+    'KONNECT' = "konnect",
+    'KUESKI' = "kueski",
+    'MONO_DIRECT_DEBIT' = "monoDirectDebit",
+    'O_PAY_WALLET' = "oPayWallet",
+    'PAGA_WALLET' = "pagaWallet",
+    'PAYFLEX' = "payflex",
+    'PAY_JUST_NOW' = "payjustnow",
+    'WAFA_CASH_WALLET' = "wafaCashWallet",
+    'MERCADO_PAGO_WALLET' = "mercadoPagoWallet",
+    'MERCADO_PAGO_CONSUMER_CREDIT' = "mercadoPagoConsumerCredit",
+    'NET_BANKING' = "netBanking",
+    'CASH_FREE_WALLET' = "cashFreeWallet",
+    'PAYTM_WALLET' = "paytmWallet",
+    'NIBSS_PAY' = "nibssPay",
+    'NIBSS_INSTANT_PAY' = "nibssInstantPay",
+    'MEEZA_WALLET' = "meezaWallet",
+    'VODAFONE_CASH' = "vodafoneCash",
+    'SEPA_DIRECT_DEBIT' = "sepaDirectDebit",
+    'MODO' = "modo",
+    'PAYZONE_CASH' = "payzoneCash",
+    'REVOLUT_PAY' = "revolutPay"
+}
+declare const PAYMENT_METHOD_CODE_BY_METHOD: { readonly [K in keyof typeof PAYMENT_METHOD_CODES]: (typeof PAYMENT_METHOD_CODES)[K]; };
+type PaymentMethodCode = PAYMENT_METHOD_CODES | (typeof PAYMENT_METHOD_CODE_BY_METHOD)[keyof typeof PAYMENT_METHOD_CODE_BY_METHOD] | (string & {});
 declare enum PAYMENT_INSTRUMENT_STATUS {
     'ENABLED' = "enabled",
     'CREATED' = "created",
@@ -107,7 +139,50 @@ declare enum PAYMENT_INSTRUMENT_STATUS {
     'INVALID' = "invalid",
     'TRANSIENT' = "transient"
 }
+type ExecutionMetaKey = keyof ExecutionMetaByKey;
+interface ExecutionMetaCustomer {
+    phone?: {
+        countryCode?: string;
+        number?: string;
+    };
+    country?: {
+        name?: string;
+        code?: string;
+        iso3?: string;
+    };
+    reference?: string;
+    name?: string;
+    lastName?: string;
+    email?: string;
+    type?: string;
+    birthDate?: string;
+    language?: string;
+    identityCardNumber?: string;
+}
+interface ExecutionMetaOrder {
+    billingAddress?: {
+        country?: {
+            name?: string;
+            code?: string;
+            iso3?: string;
+        };
+    };
+}
+type ExecutionMetaByKey = {
+    customer: ExecutionMetaCustomer;
+};
+type ExecutionMetaUpdate = {
+    [Key in ExecutionMetaKey]: {
+        key: Key;
+        value: ExecutionMetaByKey[Key];
+    };
+}[ExecutionMetaKey];
+interface ExecutionMeta {
+    customer?: ExecutionMetaCustomer;
+    order?: ExecutionMetaOrder;
+}
 declare class WorkflowExecution {
+    private static _updatedMetaKeys;
     private static _response;
     static get response(): WorkflowExecutionResponse;
     static setResponse(response: WorkflowExecutionResponse): typeof WorkflowExecution;
@@ -148,7 +223,7 @@ declare class WorkflowExecution {
     static get savedApplePayAccounts(): StoredPaymentInstrument<CardMetadata>[];
     static get paypalConfig(): PayPalConfig;
     static get googlePayConfig(): any;
-    static isPaymentMethodAvailable(paymentMethod: PAYMENT_METHOD_CODES): boolean;
+    static isPaymentMethodAvailable(paymentMethod: PaymentMethodCode): boolean;
     static get applePayConfig(): {
         merchantIdentifier: string;
         supportedNetworks: string[];
@@ -158,20 +233,7 @@ declare class WorkflowExecution {
         requiredShippingContactFields?: ApplePayJS.ApplePayContactField[];
     };
     static get url(): string;
-    static get meta(): {
-        customer?: {
-            country?: {
-                code?: string;
-            };
-        };
-        order?: {
-            billingAddress?: {
-                country?: {
-                    code?: string;
-                };
-            };
-        };
-    };
+    static get meta(): ExecutionMeta;
     static get availablePaymentMethods(): StorablePaymentCompositionOption<CardMetadata | PayPalMetadata, ApplePayConfig | PayPalConfig | GooglePayConfig | undefined>[];
     static get authorizeLink(): string | undefined;
     static get payoutLink(): string | undefined;
@@ -179,11 +241,11 @@ declare class WorkflowExecution {
     static get createInstrumentLink(): 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 getFullPaymentMethodConfig(paymentMethod: PaymentMethodCode): StorablePaymentCompositionOption<CardMetadata | PayPalMetadata, ApplePayConfig | PayPalConfig | GooglePayConfig | undefined> | undefined;
+    static isAddressSelectorEnabled(paymentMethod: PaymentMethodCode): boolean | undefined;
+    static isPaymentInstallmentsEnabled(paymentMethod: PaymentMethodCode): boolean | undefined;
+    static getPaymentInstallmentOptions(paymentMethod: PaymentMethodCode): PaymentInstallmentsConfig;
+    static getStoredInstrumentForPaymentMethod<T = CardMetadata | PayPalMetadata>(paymentMethod: PaymentMethodCode): Array<StoredPaymentInstrument<T>>;
     static getPaymentMethodForStoredInstrument<T extends CardMetadata | PayPalMetadata>(instrument: StoredPaymentInstrument<T>): {
         id: string;
         description?: string;
@@ -200,8 +262,8 @@ declare class WorkflowExecution {
             instrumentDataSchema?: JSONSchemaType;
         };
         payoutInstruments?: StoredPaymentInstrument<CardMetadata | PayPalMetadata>[] | undefined;
-        paymentMethodCode: PAYMENT_METHOD_CODES;
-        payoutMethodCode?: PAYMENT_METHOD_CODES;
+        paymentMethodCode: PaymentMethodCode;
+        payoutMethodCode?: PaymentMethodCode;
     } | undefined;
     static getPaymentMethodConfig(paymentMethod: StorablePaymentCompositionOption): {
         id: string;
@@ -219,10 +281,14 @@ declare class WorkflowExecution {
             instrumentDataSchema?: JSONSchemaType;
         };
         payoutInstruments?: StoredPaymentInstrument<CardMetadata | PayPalMetadata>[] | undefined;
-        paymentMethodCode: PAYMENT_METHOD_CODES;
-        payoutMethodCode?: PAYMENT_METHOD_CODES;
+        paymentMethodCode: PaymentMethodCode;
+        payoutMethodCode?: PaymentMethodCode;
     };
     static updateInstallmentOptions(installmentOptions?: PaymentInstallmentsConfig): void;
+    static updateMeta<K extends ExecutionMetaKey>(key: K, value: ExecutionMetaByKey[K]): void;
+    static getAllowedMeta(): ExecutionMeta;
+    static getUpdatedMeta(): ExecutionMeta;
+    private static pickMetaByKeys;
 }
 interface WorkflowExecutionResponse {
     id: string;
@@ -230,20 +296,7 @@ interface WorkflowExecutionResponse {
     holderReference: string;
     holderId?: string;
     actionRequired?: string;
-    meta: {
-        customer?: {
-            country?: {
-                code?: string;
-            };
-        };
-        order?: {
-            billingAddress?: {
-                country?: {
-                    code?: string;
-                };
-            };
-        };
-    };
+    meta: ExecutionMeta;
     status: Array<{
         code: string;
         time: string;
@@ -305,8 +358,8 @@ interface WorkflowExecutionResponse {
     };
 }
 interface BasePaymentMethodConfig {
-    paymentMethodCode: PAYMENT_METHOD_CODES;
-    payoutMethodCode?: PAYMENT_METHOD_CODES;
+    paymentMethodCode: PaymentMethodCode;
+    payoutMethodCode?: PaymentMethodCode;
 }
 interface BaseInstallmentOption {
     count: number;
@@ -378,7 +431,7 @@ interface ApplePayConfig {
 interface StoredPaymentInstrument<T = CardMetadata | PayPalMetadata | BankAccountMetadata> {
     id: string;
     status: PAYMENT_INSTRUMENT_STATUS;
-    paymentMethod: PAYMENT_METHOD_CODES;
+    paymentMethod: PaymentMethodCode;
     displayName?: string;
     data?: T;
     default?: boolean;
@@ -518,9 +571,10 @@ interface PayrailsAmount {
     currency: string;
 }
 interface LookupUpdateOptions {
-    value: string;
-    currency: string;
+    value?: string;
+    currency?: string;
     installmentConfig?: InstallmentUpdateConfig | null;
+    meta?: ExecutionMetaUpdate;
 }
 interface Links {
     method: 'GET' | 'POST';
@@ -554,7 +608,7 @@ interface PayoutResponse {
 type PayoutComposition = Array<{
     integrationType: string;
     amount: PayrailsAmount;
-    paymentMethodCode: PAYMENT_METHOD_CODES;
+    paymentMethodCode: PaymentMethodCode;
     paymentInstrumentId?: string;
 }>;
 interface PayoutReqBody {
@@ -1472,13 +1526,16 @@ declare class GooglePayButton extends PayrailsElementWithStoreInstrumentCheckbox
     private sdkLoadedCalled;
     private isProcessing;
     private buttonElement;
+    private action;
     private static getGooglePayConfigAsArray;
     private static getSDKClient;
     static isGooglePayAvailable(allowedPaymentMethods: GooglePayConfigInput, environment?: PayrailsEnvironment, merchantInfo?: google.payments.api.MerchantInfo): Promise<boolean>;
     constructor(options: GooglePayButtonOptions);
     private sdkLoaded;
-    private onLoadPaymentData;
     private authorize;
+    private onLoadPaymentData;
+    private doTokenize;
+    private doAuthorizePayment;
     mount(location: string): void;
     unmount(): void;
 }
@@ -1827,7 +1884,7 @@ interface UpdateInstrumentResponse {
     id: string;
     createdAt: string;
     holderId: string;
-    paymentMethod: PAYMENT_METHOD_CODES;
+    paymentMethod: PaymentMethodCode;
     status: PAYMENT_INSTRUMENT_STATUS;
     data: {
         bin?: string;
@@ -1954,8 +2011,8 @@ declare class Payrails {
         operation: TOperation;
     }): Promise<Operations[TOperation]['responseType']>;
     getStoredInstruments(): StoredPaymentInstrument<PayPalMetadata & CardMetadata>[];
-    getStoredInstrumentsByPaymentMethod(paymentMethod: PAYMENT_METHOD_CODES): StoredPaymentInstrument<PayPalMetadata & CardMetadata>[];
-    getAvailablePaymentMethods(): PAYMENT_METHOD_CODES[];
+    getStoredInstrumentsByPaymentMethod(paymentMethod: PaymentMethodCode): StoredPaymentInstrument<PayPalMetadata & CardMetadata>[];
+    getAvailablePaymentMethods(): PaymentMethodCode[];
     paymentButton(options: CardPaymentButtonOptions): CardPaymentButton;
     paypalButton(options?: PaypalButtonOptions): PaypalButton;
     genericRedirectButton(options: GenericRedirectButtonOptions): GenericRedirectButton;
@@ -2072,4 +2129,4 @@ interface PayrailsClientOptions {
 }
 
 export { AuthorizationFailureReasons, ElementType, INTEGRATION_TYPE, PAYMENT_METHOD_CODES, Payrails, PayrailsEnvironment };
-export type { ApplePayButtonOptions, CardFormOptions, CardListOptions, CardPaymentButtonOptions, DropinOptions, GenericRedirectButtonOptions, GooglePayButtonOptions, InitOptions, PaymentEvents, PaypalButtonOptions, PayrailsAmount, PayrailsClientOptions, PayrailsContainerType, PayrailsSecureField, PayrailsSecureFieldEvent, ReturnInfo, SaveInstrumentResponse, WorkflowExecutionResponse };
+export type { ApplePayButtonOptions, CardFormOptions, CardListOptions, CardPaymentButtonOptions, DropinOptions, ExecutionMeta, ExecutionMetaCustomer, ExecutionMetaKey, GenericRedirectButtonOptions, GooglePayButtonOptions, InitOptions, PaymentEvents, PaypalButtonOptions, PayrailsAmount, PayrailsClientOptions, PayrailsContainerType, PayrailsSecureField, PayrailsSecureFieldEvent, ReturnInfo, SaveInstrumentResponse, WorkflowExecutionResponse };