@payrails/web-sdk 5.31.2 → 5.32.0

package/package.json

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

package/payrails.d.ts

@@ -210,6 +210,7 @@ declare class WorkflowExecution {
         paymentMethodCode: PAYMENT_METHOD_CODES;
         payoutMethodCode?: PAYMENT_METHOD_CODES;
     };
+    static updateInstallmentOptions(installmentOptions?: PaymentInstallmentsConfig): void;
 }
 interface WorkflowExecutionResponse {
     id: string;
@@ -290,6 +291,11 @@ interface BaseInstallmentOption {
 interface PaymentInstallmentsConfig {
     [key: string]: BaseInstallmentOption[];
 }
+interface InstallmentUpdateConfig {
+    defaultInstallment?: number | null;
+    installmentCountry?: string | null;
+    installmentOptions?: BaseInstallmentOption[] | null;
+}
 interface StorablePaymentCompositionOption<I = CardMetadata | PayPalMetadata, C = undefined | ApplePayConfig | PayPalConfig | GooglePayConfig> extends BasePaymentMethodConfig {
     id: string;
     description?: string;
@@ -992,8 +998,11 @@ type CardNetwork = keyof typeof regexes;
 
 interface PaymentInstallmentsElementOptions extends ElementOptions {
     showPaymentInstallmentsDropdown?: boolean;
-    installmentOptions?: BaseInstallmentOption[] | null;
-    installmentCurrency?: string;
+    installmentConfig?: {
+        defaultInstallment?: number | null;
+        installmentOptions?: BaseInstallmentOption[] | null;
+        installmentCurrency?: string;
+    };
     translations?: {
         labels?: {
             paymentInstallments?: string;
@@ -1006,11 +1015,13 @@ interface PaymentInstallmentsElementOptions extends ElementOptions {
 }
 declare class PaymentInstallmentsDropdown extends PayrailsElement {
     private options;
+    private INSTALLMENT_STORAGE_KEY;
     private installmentOptions;
     constructor(options: PaymentInstallmentsElementOptions);
     private generateOptionsHTML;
     private renderOptions;
     updateOptions(installmentOptions: BaseInstallmentOption[]): void;
+    updateConfig(installmentConfig?: PaymentInstallmentsElementOptions['installmentConfig']): void;
     private createHTML;
     private applyStyles;
     private addListeners;
@@ -1024,6 +1035,7 @@ declare class PayrailsElementWithPaymentInstallmentsDropdown extends PayrailsEle
     constructor(elementType: string, options?: PaymentInstallmentsElementOptions | undefined);
     get selectedInstallmentValue(): number;
     updateInstallmentOptions(installmentOptions: BaseInstallmentOption[]): void;
+    updateInstallmentConfig(installmentConfig?: PaymentInstallmentsElementOptions['installmentConfig']): void;
     setDisabled(state: boolean): void;
 }
 
@@ -1069,6 +1081,9 @@ interface CardFormOptions extends StoreInstrumentElementOptions {
     showCardHolderName?: boolean;
     showSingleExpiryDateField?: boolean;
     enrollInstrumentToNetworkOffers?: boolean;
+    installmentConfig?: {
+        defaultInstallment?: number | null;
+    };
     layout?: CardFormLayout;
     translations?: {
         placeholders?: {
@@ -1132,6 +1147,7 @@ declare class CardForm extends PayrailsElementWithStoreInstrumentCheckbox {
     private updateTranslations;
     private updateEvents;
     update(options: Partial<Pick<CardFormOptions, 'styles' | 'translations' | 'events'>>): void;
+    updateInstallmentConfig(installmentConfig?: InstallmentUpdateConfig): void;
     private createFormField;
     private initializeCustomLayout;
     private hasFieldBeenUsed;
@@ -1224,6 +1240,11 @@ interface PayrailsAmount {
     value: string;
     currency: string;
 }
+interface LookupUpdateOptions {
+    value: string;
+    currency: string;
+    installmentConfig?: InstallmentUpdateConfig | null;
+}
 interface Links {
     method: 'GET' | 'POST';
     href: string;
@@ -1562,6 +1583,7 @@ declare class Dropin extends PayrailsElement {
     private createStoredInstrumentElement;
     private createInstallmentsDropdown;
     private getInstallmentOptionsForInstrument;
+    updateInstallmentConfig(installmentConfig?: InstallmentUpdateConfig): void;
     private createHppIntegrationElement;
     private get totalPaymentOptions();
     private createCreditCardButton;
@@ -1597,6 +1619,7 @@ interface DropinOptions {
             showSingleExpiryDateField?: boolean;
             layout?: CardFormLayout;
             disablePaymentButton?: boolean;
+            installmentConfig?: CardFormOptions['installmentConfig'];
         } & StorablePaymentMethodConfiguration;
         payPal?: StorablePaymentMethodConfiguration;
         googlePay?: StorablePaymentMethodConfiguration & {
@@ -1828,7 +1851,7 @@ declare class Payrails {
     private __sharedState;
     static preloadCardForm: typeof SdkLoader.preloadCardForm;
     static init(initResponse: InitOptions, options?: PayrailsClientOptions): Payrails;
-    update(amount: PayrailsAmount): void;
+    update(updateOptions: LookupUpdateOptions): void;
     collectContainer(containerOptions: CollectContainerOptions): PayrailsCollectContainer;
     googlePayButton(options: GooglePayButtonOptions): GooglePayButton;
     isGooglePayAvailable(merchantInfo: google.payments.api.MerchantInfo): Promise<boolean>;