@bigcommerce/checkout-sdk 1.369.0 → 1.369.1

package/dist/checkout-sdk.d.ts

@@ -4522,6 +4522,13 @@ declare interface CustomerRequestOptions extends RequestOptions {
     methodId?: string;
 }
 
+declare interface DeprecatedPayPalCommerceCreditCardsPaymentInitializeOptions {
+    /**
+     * The form is data for Credit Card Form
+     */
+    form?: HostedFormOptions_2;
+}
+
 declare interface DigitalItem extends LineItem {
     downloadFileUrls: string[];
     downloadPageUrl: string;
@@ -6043,6 +6050,87 @@ declare interface PayPalCommerceCreditButtonInitializeOptions {
     onComplete?(): void;
 }
 
+/**
+ * A set of options that are required to initialize the PayPal Commerce payment
+ * method for presenting its credit card form.
+ *
+ * ```html
+ * <!-- These containers are where the hosted (iframed) credit card fields will be inserted -->
+ * <div id="card-number"></div>
+ * <div id="card-name"></div>
+ * <div id="card-expiry"></div>
+ * <div id="card-code"></div>
+ * ```
+ *
+ * ```js
+ * service.initializePayment({
+ *     methodId: 'paypalcommercecreditcard',
+ *     paypalcommercecreditcard: {
+ *         form: {
+ *             fields: {
+ *                 cardNumber: { containerId: 'card-number' },
+ *                 cardName: { containerId: 'card-name' },
+ *                 cardExpiry: { containerId: 'card-expiry' },
+ *                 cardCode: { containerId: 'card-code' },
+ *             },
+ *         },
+ *     },
+ * });
+ * ```
+ *
+ * Additional options can be passed in to customize the fields and register
+ * event callbacks.
+ *
+ * ```js
+ * service.initializePayment({
+ *     methodId: 'paypalcommercecreditcard',
+ *     paypalcommercecreditcard: {
+ *         form: {
+ *             fields: {
+ *                 cardNumber: { containerId: 'card-number', placeholder: 'Number of card' },
+ *                 cardName: { containerId: 'card-name', placeholder: 'Name of card' },
+ *                 cardExpiry: { containerId: 'card-expiry', placeholder: 'Expiry of card' },
+ *                 cardCode: { containerId: 'card-code', placeholder: 'Code of card' },
+ *             },
+ *             styles: {
+ *                 default: {
+ *                     color: '#000',
+ *                 },
+ *                 error: {
+ *                     color: '#f00',
+ *                 },
+ *                 focus: {
+ *                     color: '#0f0',
+ *                 },
+ *             },
+ *             onBlur({ fieldType }) {
+ *                 console.log(fieldType);
+ *             },
+ *             onFocus({ fieldType }) {
+ *                 console.log(fieldType);
+ *             },
+ *             onEnter({ fieldType }) {
+ *                 console.log(fieldType);
+ *             },
+ *             onCardTypeChange({ cardType }) {
+ *                 console.log(cardType);
+ *             },
+ *             onValidate({ errors, isValid }) {
+ *                 console.log(errors);
+ *                 console.log(isValid);
+ *             },
+ *         },
+ *     },
+ * });
+ * ```
+ */
+declare interface PayPalCommerceCreditCardsPaymentInitializeOptions {
+    /**
+     * The form is data for Credit Card Form
+     */
+    form: HostedFormOptions_2;
+}
+
 declare interface PayPalCommerceCreditCustomerInitializeOptions {
     /**
      * The ID of a container which the checkout button should be inserted into.
@@ -6142,7 +6230,7 @@ declare interface PayPalInstrument extends BaseAccountInstrument {
     method: 'paypal';
 }
 
-declare type PaymentInitializeOptions = BasePaymentInitializeOptions & WithAdyenV2PaymentInitializeOptions & WithAdyenV3PaymentInitializeOptions & WithApplePayPaymentInitializeOptions & WithBoltPaymentInitializeOptions & WithCreditCardPaymentInitializeOptions & WithSquareV2PaymentInitializeOptions;
+declare type PaymentInitializeOptions = BasePaymentInitializeOptions & WithAdyenV2PaymentInitializeOptions & WithAdyenV3PaymentInitializeOptions & WithApplePayPaymentInitializeOptions & WithBoltPaymentInitializeOptions & WithCreditCardPaymentInitializeOptions & WithPayPalCommerceCreditCardsPaymentInitializeOptions & WithSquareV2PaymentInitializeOptions;
 
 declare type PaymentInstrument = CardInstrument | AccountInstrument;
 
@@ -7691,6 +7779,11 @@ declare interface WithPayPalCommerceCreditButtonInitializeOptions {
     paypalcommercecredit?: PayPalCommerceCreditButtonInitializeOptions;
 }
 
+declare interface WithPayPalCommerceCreditCardsPaymentInitializeOptions {
+    paypalcommercecreditcards?: PayPalCommerceCreditCardsPaymentInitializeOptions;
+    paypalcommerce?: DeprecatedPayPalCommerceCreditCardsPaymentInitializeOptions;
+}
+
 declare interface WithPayPalCommerceCreditCustomerInitializeOptions {
     paypalcommercecredit?: PayPalCommerceCreditCustomerInitializeOptions;
 }