@bigcommerce/checkout-sdk 1.308.4 → 1.309.0

package/dist/checkout-sdk.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="applepayjs" />
+import { CardClassSelectors } from '@square/web-payments-sdk-types';
 import { Omit as Omit_2 } from '@bigcommerce/checkout-sdk/payment-integration-api';
 import { RequestOptions as RequestOptions_2 } from '@bigcommerce/request-sender';
 import { Response } from '@bigcommerce/request-sender';
@@ -5998,7 +5999,7 @@ declare interface PayPalInstrument extends BaseAccountInstrument {
     method: 'paypal';
 }
 
-declare type PaymentInitializeOptions = BasePaymentInitializeOptions & WithAdyenV2PaymentInitializeOptions & WithAdyenV3PaymentInitializeOptions & WithApplePayPaymentInitializeOptions;
+declare type PaymentInitializeOptions = BasePaymentInitializeOptions & WithAdyenV2PaymentInitializeOptions & WithAdyenV3PaymentInitializeOptions & WithApplePayPaymentInitializeOptions & WithSquareV2PaymentInitializeOptions;
 
 declare type PaymentInstrument = CardInstrument | AccountInstrument;
 
@@ -6907,6 +6908,64 @@ declare interface SquarePaymentInitializeOptions {
     onError?(errors?: NonceGenerationError[]): void;
 }
 
+/**
+ * A set of options that are required to initialize the Square payment method.
+ *
+ * Once Square payment is initialized, an iframed payment element will be
+ * inserted into the current page. These options provide a location, styling,
+ * and a callback function that advises when it's safe to pay.
+ *
+ * @example
+ *
+ * ```html
+ * <!-- These container is where the hosted (iframed) payment method element will be inserted -->
+ * <div id="card-payment"></div>
+ * ```
+ *
+ * ```js
+ * service.initializePayment({
+ *     methodId: 'squarev2',
+ *     squarev2: {
+ *         containerId: 'card-payment',
+ *         style: {
+ *             input: {
+ *                 backgroundColor: '#F7F8F9',
+ *                 color: '#373F4A',
+ *                 fontFamily: 'Helvetica Neue',
+ *                 fontSize: '16px',
+ *                 fontWeight: 'normal'
+ *             }
+ *         },
+ *         onValidationChange: (isReadyToPay: boolean) => {
+ *             if (isReadyToPay) {
+ *                 // Show or hide some component or message...
+ *             }
+ *         }
+ *     },
+ * });
+ * ```
+ */
+declare interface SquareV2PaymentInitializeOptions {
+    /**
+     * The ID of a container which the payment widget should insert into.
+     */
+    containerId: string;
+    /**
+     * A map of .css classes and values that customize the style of the
+     * input fields from the card element.
+     *
+     * For more information about applying custom styles to the card form, see
+     * the available [CardClassSelectors](https://developer.squareup.com/reference/sdks/web/payments/objects/CardClassSelectors)
+     * for styling.
+     */
+    style?: CardClassSelectors;
+    /**
+     * A callback that gets called when the validity of the
+     * payment component changes.
+     */
+    onValidationChange?: (isReadyToPay: boolean) => void;
+}
+
 /**
  * This error type should not be constructed directly. It is a base class for
  * all custom errors thrown in this library.
@@ -7579,6 +7638,14 @@ declare interface WithMollieIssuerInstrument {
     shopper_locale: string;
 }
 
+declare interface WithSquareV2PaymentInitializeOptions {
+    /**
+     * The options that are required to initialize the Square payment method.
+     * They can be omitted unless you need to support Square.
+     */
+    squarev2?: SquareV2PaymentInitializeOptions;
+}
+
 declare interface WorldpayAccessPaymentInitializeOptions {
     /**
      * A callback that gets called when the iframe is ready to be added to the