@bigcommerce/checkout-sdk 1.215.0 → 1.218.0

package/dist/checkout-sdk.d.ts

@@ -4078,6 +4078,10 @@ declare interface GatewayOrderPayment extends OrderPayment {
         step: string;
         instructions: string;
     };
+    mandate?: {
+        id: string;
+        url?: string;
+    };
 }
 
 declare interface GiftCertificate {
@@ -4944,11 +4948,43 @@ declare interface OptionsResponse {
     paymentMethodConfiguration?: BaseElementOptions;
 }
 
+/**
+ * A set of options that are required to initialize the payment step of
+ * checkout in order to support Opy.
+ *
+ * When Opy is initialized, a widget will be inserted into the DOM. The
+ * widget will open a modal that will show more information about Opy when
+ * clicking it.
+ *
+ * @example
+ *
+ * ```html
+ * <!-- This is where the Opy widget will be inserted -->
+ * <div id="opy-widget"></div>
+ * ```
+ *
+ * ```js
+ * service.initializePayment({
+ *     methodId: 'opy',
+ *     opy: {
+ *         containerId: 'opy-widget',
+ *     },
+ * });
+ * ```
+ */
+declare interface OpyPaymentInitializeOptions {
+    /**
+     * The ID of a container which the payment widget should insert into.
+     */
+    containerId: string;
+}
+
 declare interface Order {
     baseAmount: number;
     billingAddress: BillingAddress;
     cartId: string;
     coupons: Coupon[];
+    consignments: OrderConsignment[];
     currency: Currency;
     customerCanBeCreated: boolean;
     customerId: number;
@@ -4970,12 +5006,16 @@ declare interface Order {
     status: string;
     taxes: Tax[];
     taxTotal: number;
-    mandateUrl?: string;
+}
+
+declare interface OrderConsignment {
+    shipping: OrderShippingConsignment[];
 }
 
 declare interface OrderPayment {
     providerId: string;
     gatewayId?: string;
+    methodId?: string;
     paymentId?: string;
     description: string;
     amount: number;
@@ -5022,6 +5062,44 @@ declare interface OrderRequestBody {
     useStoreCredit?: boolean;
 }
 
+declare interface OrderShippingConsignment {
+    lineItems: Array<{
+        id: number;
+    }>;
+    shippingAddressId: number;
+    firstName: string;
+    lastName: string;
+    company: string;
+    address1: string;
+    address2: string;
+    city: string;
+    stateOrProvince: string;
+    postalCode: string;
+    country: string;
+    countryCode: string;
+    email: string;
+    phone: string;
+    itemsTotal: number;
+    itemsShipped: number;
+    shippingMethod: string;
+    baseCost: number;
+    costExTax: number;
+    costIncTax: number;
+    costTax: number;
+    costTaxClassId: number;
+    baseHandlingCost: number;
+    handlingCostExTax: number;
+    handlingCostIncTax: number;
+    handlingCostTax: number;
+    handlingCostTaxClassId: number;
+    shippingZoneId: number;
+    shippingZoneName: string;
+    customFields: Array<{
+        name: string;
+        value: string | null;
+    }>;
+}
+
 declare interface PasswordRequirements {
     alpha: string;
     numeric: string;
@@ -5111,6 +5189,11 @@ declare interface PaymentInitializeOptions extends PaymentRequestOptions {
      * They can be omitted unless you need to support Moneris.
      */
     moneris?: MonerisPaymentInitializeOptions;
+    /**
+     * The options that are required to initialize the Opy payment
+     * method. They can be omitted unless you need to support Opy.
+     */
+    opy?: OpyPaymentInitializeOptions;
     /**
      * The options that are required to initialize the PayPal Express payment method.
      * They can be omitted unless you need to support PayPal Express.
@@ -5868,45 +5951,6 @@ declare interface SquareFormElement {
  *     },
  * });
  * ```
- *
- * Additional options can be passed in to enable Masterpass (if configured for
- * the account) and customize the fields.
- *
- * ```html
- * <!-- This container is where Masterpass button will be inserted -->
- * <div id="masterpass"></div>
- * ```
- *
- * ```js
- * service.initializePayment({
- *     methodId: 'squarev2',
- *     square: {
- *         cardNumber: {
- *             elementId: 'card-number',
- *         },
- *         cvv: {
- *             elementId: 'card-code',
- *         },
- *         expirationDate: {
- *             elementId: 'card-expiry',
- *         },
- *         postalCode: {
- *             elementId: 'card-code',
- *         },
- *         inputClass: 'form-input',
- *         inputStyles: [
- *             {
- *                 color: '#333',
- *                 fontSize: '13px',
- *                 lineHeight: '20px',
- *             },
- *         ],
- *         masterpass: {
- *             elementId: 'masterpass',
- *         },
- *     },
- * });
- * ```
  */
 declare interface SquarePaymentInitializeOptions {
     /**
@@ -5935,10 +5979,6 @@ declare interface SquarePaymentInitializeOptions {
     inputStyles?: Array<{
         [key: string]: string;
     }>;
-    /**
-     * Initialize Masterpass placeholder ID
-     */
-    masterpass?: SquareFormElement;
     /**
      * A callback that gets called when the customer selects a payment option.
      */