@bigcommerce/checkout-sdk 1.215.0 → 1.218.0

package/dist/internal-mappers.d.ts

@@ -201,6 +201,10 @@ declare interface GatewayOrderPayment extends OrderPayment {
         step: string;
         instructions: string;
     };
+    mandate?: {
+        id: string;
+        url?: string;
+    };
 }
 
 declare interface GiftCertificate {
@@ -562,6 +566,7 @@ declare interface Order {
     billingAddress: BillingAddress;
     cartId: string;
     coupons: Coupon[];
+    consignments: OrderConsignment[];
     currency: Currency;
     customerCanBeCreated: boolean;
     customerId: number;
@@ -583,7 +588,10 @@ declare interface Order {
     status: string;
     taxes: Tax[];
     taxTotal: number;
-    mandateUrl?: string;
+}
+
+declare interface OrderConsignment {
+    shipping: OrderShippingConsignment[];
 }
 
 declare interface OrderMetaState extends InternalOrderMeta {
@@ -596,6 +604,7 @@ declare interface OrderMetaState extends InternalOrderMeta {
 declare interface OrderPayment {
     providerId: string;
     gatewayId?: string;
+    methodId?: string;
     paymentId?: string;
     description: string;
     amount: number;
@@ -603,6 +612,44 @@ declare interface OrderPayment {
 
 declare type OrderPayments = Array<GatewayOrderPayment | GiftCertificateOrderPayment>;
 
+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 PhysicalItem extends LineItem {
     isShippingRequired: boolean;
     giftWrapping?: {

package/docs/README.md

@@ -225,10 +225,13 @@
 * [NonceGenerationError](interfaces/noncegenerationerror.md)
 * [NonceInstrument](interfaces/nonceinstrument.md)
 * [OptionsResponse](interfaces/optionsresponse.md)
+* [OpyPaymentInitializeOptions](interfaces/opypaymentinitializeoptions.md)
 * [Order](interfaces/order.md)
+* [OrderConsignment](interfaces/orderconsignment.md)
 * [OrderPayment](interfaces/orderpayment.md)
 * [OrderPaymentRequestBody](interfaces/orderpaymentrequestbody.md)
 * [OrderRequestBody](interfaces/orderrequestbody.md)
+* [OrderShippingConsignment](interfaces/ordershippingconsignment.md)
 * [PasswordRequirements](interfaces/passwordrequirements.md)
 * [PayPalInstrument](interfaces/paypalinstrument.md)
 * [PaymentInitializeOptions](interfaces/paymentinitializeoptions.md)

package/docs/interfaces/gatewayorderpayment.md

@@ -16,6 +16,8 @@
 * [description](gatewayorderpayment.md#description)
 * [detail](gatewayorderpayment.md#detail)
 * [gatewayId](gatewayorderpayment.md#optional-gatewayid)
+* [mandate](gatewayorderpayment.md#optional-mandate)
+* [methodId](gatewayorderpayment.md#optional-methodid)
 * [paymentId](gatewayorderpayment.md#optional-paymentid)
 * [providerId](gatewayorderpayment.md#providerid)
 
@@ -57,6 +59,20 @@ ___
 
 ___
 
+### `Optional` mandate
+
+• **mandate**? : *undefined | object*
+
+___
+
+### `Optional` methodId
+
+• **methodId**? : *undefined | string*
+
+*Inherited from [GatewayOrderPayment](gatewayorderpayment.md).[methodId](gatewayorderpayment.md#optional-methodid)*
+
+___
+
 ### `Optional` paymentId
 
 • **paymentId**? : *undefined | string*

package/docs/interfaces/giftcertificateorderpayment.md

@@ -16,6 +16,7 @@
 * [description](giftcertificateorderpayment.md#description)
 * [detail](giftcertificateorderpayment.md#detail)
 * [gatewayId](giftcertificateorderpayment.md#optional-gatewayid)
+* [methodId](giftcertificateorderpayment.md#optional-methodid)
 * [paymentId](giftcertificateorderpayment.md#optional-paymentid)
 * [providerId](giftcertificateorderpayment.md#providerid)
 
@@ -57,6 +58,14 @@ ___
 
 ___
 
+### `Optional` methodId
+
+• **methodId**? : *undefined | string*
+
+*Inherited from [GatewayOrderPayment](gatewayorderpayment.md).[methodId](gatewayorderpayment.md#optional-methodid)*
+
+___
+
 ### `Optional` paymentId
 
 • **paymentId**? : *undefined | string*

package/docs/interfaces/opypaymentinitializeoptions.md

@@ -0,0 +1,44 @@
+[@bigcommerce/checkout-sdk](../README.md) › [OpyPaymentInitializeOptions](opypaymentinitializeoptions.md)
+
+# Interface: OpyPaymentInitializeOptions
+
+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',
+    },
+});
+```
+
+## Hierarchy
+
+* **OpyPaymentInitializeOptions**
+
+## Index
+
+### Properties
+
+* [containerId](opypaymentinitializeoptions.md#containerid)
+
+## Properties
+
+###  containerId
+
+• **containerId**: *string*
+
+The ID of a container which the payment widget should insert into.

package/docs/interfaces/order.md

@@ -13,6 +13,7 @@
 * [baseAmount](order.md#baseamount)
 * [billingAddress](order.md#billingaddress)
 * [cartId](order.md#cartid)
+* [consignments](order.md#consignments)
 * [coupons](order.md#coupons)
 * [currency](order.md#currency)
 * [customerCanBeCreated](order.md#customercanbecreated)
@@ -26,7 +27,6 @@
 * [isDownloadable](order.md#isdownloadable)
 * [isTaxIncluded](order.md#istaxincluded)
 * [lineItems](order.md#lineitems)
-* [mandateUrl](order.md#optional-mandateurl)
 * [orderAmount](order.md#orderamount)
 * [orderAmountAsInteger](order.md#orderamountasinteger)
 * [orderId](order.md#orderid)
@@ -57,6 +57,12 @@ ___
 
 ___
 
+###  consignments
+
+• **consignments**: *[OrderConsignment](orderconsignment.md)[]*
+
+___
+
 ###  coupons
 
 • **coupons**: *[Coupon](coupon.md)[]*
@@ -135,12 +141,6 @@ ___
 
 ___
 
-### `Optional` mandateUrl
-
-• **mandateUrl**? : *undefined | string*
-
-___
-
 ###  orderAmount
 
 • **orderAmount**: *number*

package/docs/interfaces/orderconsignment.md

@@ -0,0 +1,19 @@
+[@bigcommerce/checkout-sdk](../README.md) › [OrderConsignment](orderconsignment.md)
+
+# Interface: OrderConsignment
+
+## Hierarchy
+
+* **OrderConsignment**
+
+## Index
+
+### Properties
+
+* [shipping](orderconsignment.md#shipping)
+
+## Properties
+
+###  shipping
+
+• **shipping**: *[OrderShippingConsignment](ordershippingconsignment.md)[]*

package/docs/interfaces/orderpayment.md

@@ -17,6 +17,7 @@
 * [amount](orderpayment.md#amount)
 * [description](orderpayment.md#description)
 * [gatewayId](orderpayment.md#optional-gatewayid)
+* [methodId](orderpayment.md#optional-methodid)
 * [paymentId](orderpayment.md#optional-paymentid)
 * [providerId](orderpayment.md#providerid)
 
@@ -40,6 +41,12 @@ ___
 
 ___
 
+### `Optional` methodId
+
+• **methodId**? : *undefined | string*
+
+___
+
 ### `Optional` paymentId
 
 • **paymentId**? : *undefined | string*

package/docs/interfaces/ordershippingconsignment.md

@@ -0,0 +1,222 @@
+[@bigcommerce/checkout-sdk](../README.md) › [OrderShippingConsignment](ordershippingconsignment.md)
+
+# Interface: OrderShippingConsignment
+
+## Hierarchy
+
+* **OrderShippingConsignment**
+
+## Index
+
+### Properties
+
+* [address1](ordershippingconsignment.md#address1)
+* [address2](ordershippingconsignment.md#address2)
+* [baseCost](ordershippingconsignment.md#basecost)
+* [baseHandlingCost](ordershippingconsignment.md#basehandlingcost)
+* [city](ordershippingconsignment.md#city)
+* [company](ordershippingconsignment.md#company)
+* [costExTax](ordershippingconsignment.md#costextax)
+* [costIncTax](ordershippingconsignment.md#costinctax)
+* [costTax](ordershippingconsignment.md#costtax)
+* [costTaxClassId](ordershippingconsignment.md#costtaxclassid)
+* [country](ordershippingconsignment.md#country)
+* [countryCode](ordershippingconsignment.md#countrycode)
+* [customFields](ordershippingconsignment.md#customfields)
+* [email](ordershippingconsignment.md#email)
+* [firstName](ordershippingconsignment.md#firstname)
+* [handlingCostExTax](ordershippingconsignment.md#handlingcostextax)
+* [handlingCostIncTax](ordershippingconsignment.md#handlingcostinctax)
+* [handlingCostTax](ordershippingconsignment.md#handlingcosttax)
+* [handlingCostTaxClassId](ordershippingconsignment.md#handlingcosttaxclassid)
+* [itemsShipped](ordershippingconsignment.md#itemsshipped)
+* [itemsTotal](ordershippingconsignment.md#itemstotal)
+* [lastName](ordershippingconsignment.md#lastname)
+* [lineItems](ordershippingconsignment.md#lineitems)
+* [phone](ordershippingconsignment.md#phone)
+* [postalCode](ordershippingconsignment.md#postalcode)
+* [shippingAddressId](ordershippingconsignment.md#shippingaddressid)
+* [shippingMethod](ordershippingconsignment.md#shippingmethod)
+* [shippingZoneId](ordershippingconsignment.md#shippingzoneid)
+* [shippingZoneName](ordershippingconsignment.md#shippingzonename)
+* [stateOrProvince](ordershippingconsignment.md#stateorprovince)
+
+## Properties
+
+###  address1
+
+• **address1**: *string*
+
+___
+
+###  address2
+
+• **address2**: *string*
+
+___
+
+###  baseCost
+
+• **baseCost**: *number*
+
+___
+
+###  baseHandlingCost
+
+• **baseHandlingCost**: *number*
+
+___
+
+###  city
+
+• **city**: *string*
+
+___
+
+###  company
+
+• **company**: *string*
+
+___
+
+###  costExTax
+
+• **costExTax**: *number*
+
+___
+
+###  costIncTax
+
+• **costIncTax**: *number*
+
+___
+
+###  costTax
+
+• **costTax**: *number*
+
+___
+
+###  costTaxClassId
+
+• **costTaxClassId**: *number*
+
+___
+
+###  country
+
+• **country**: *string*
+
+___
+
+###  countryCode
+
+• **countryCode**: *string*
+
+___
+
+###  customFields
+
+• **customFields**: *Array‹object›*
+
+___
+
+###  email
+
+• **email**: *string*
+
+___
+
+###  firstName
+
+• **firstName**: *string*
+
+___
+
+###  handlingCostExTax
+
+• **handlingCostExTax**: *number*
+
+___
+
+###  handlingCostIncTax
+
+• **handlingCostIncTax**: *number*
+
+___
+
+###  handlingCostTax
+
+• **handlingCostTax**: *number*
+
+___
+
+###  handlingCostTaxClassId
+
+• **handlingCostTaxClassId**: *number*
+
+___
+
+###  itemsShipped
+
+• **itemsShipped**: *number*
+
+___
+
+###  itemsTotal
+
+• **itemsTotal**: *number*
+
+___
+
+###  lastName
+
+• **lastName**: *string*
+
+___
+
+###  lineItems
+
+• **lineItems**: *Array‹object›*
+
+___
+
+###  phone
+
+• **phone**: *string*
+
+___
+
+###  postalCode
+
+• **postalCode**: *string*
+
+___
+
+###  shippingAddressId
+
+• **shippingAddressId**: *number*
+
+___
+
+###  shippingMethod
+
+• **shippingMethod**: *string*
+
+___
+
+###  shippingZoneId
+
+• **shippingZoneId**: *number*
+
+___
+
+###  shippingZoneName
+
+• **shippingZoneName**: *string*
+
+___
+
+###  stateOrProvince
+
+• **stateOrProvince**: *string*

package/docs/interfaces/paymentinitializeoptions.md

@@ -44,6 +44,7 @@ current checkout flow.
 * [methodId](paymentinitializeoptions.md#methodid)
 * [mollie](paymentinitializeoptions.md#optional-mollie)
 * [moneris](paymentinitializeoptions.md#optional-moneris)
+* [opy](paymentinitializeoptions.md#optional-opy)
 * [params](paymentinitializeoptions.md#optional-params)
 * [paypalcommerce](paymentinitializeoptions.md#optional-paypalcommerce)
 * [paypalexpress](paymentinitializeoptions.md#optional-paypalexpress)
@@ -286,6 +287,15 @@ They can be omitted unless you need to support Moneris.
 
 ___
 
+### `Optional` opy
+
+• **opy**? : *[OpyPaymentInitializeOptions](opypaymentinitializeoptions.md)*
+
+The options that are required to initialize the Opy payment
+method. They can be omitted unless you need to support Opy.
+
+___
+
 ### `Optional` params
 
 • **params**? : *TParams*

package/docs/interfaces/squarepaymentinitializeoptions.md

@@ -36,45 +36,6 @@ service.initializePayment({
 });
 ```
 
-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',
-        },
-    },
-});
-```
-
 ## Hierarchy
 
 * **SquarePaymentInitializeOptions**
@@ -88,7 +49,6 @@ service.initializePayment({
 * [expirationDate](squarepaymentinitializeoptions.md#expirationdate)
 * [inputClass](squarepaymentinitializeoptions.md#optional-inputclass)
 * [inputStyles](squarepaymentinitializeoptions.md#optional-inputstyles)
-* [masterpass](squarepaymentinitializeoptions.md#optional-masterpass)
 * [postalCode](squarepaymentinitializeoptions.md#postalcode)
 
 ### Methods
@@ -138,14 +98,6 @@ The set of CSS styles to apply to all form fields.
 
 ___
 
-### `Optional` masterpass
-
-• **masterpass**? : *[SquareFormElement](squareformelement.md)*
-
-Initialize Masterpass placeholder ID
-
-___
-
 ###  postalCode
 
 • **postalCode**: *[SquareFormElement](squareformelement.md)*

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigcommerce/checkout-sdk",
-  "version": "1.215.0",
+  "version": "1.218.0",
   "description": "BigCommerce Checkout JavaScript SDK",
   "license": "MIT",
   "main": "dist/checkout-sdk.js",