@bigcommerce/checkout-sdk 1.716.0 → 1.718.0

package/dist/internal-mappers.d.ts

@@ -130,6 +130,7 @@ declare interface Consignment {
     id: string;
     address: Address;
     shippingAddress: Address;
+    discounts: ConsignmentDiscount[];
     handlingCost: number;
     shippingCost: number;
     availableShippingOptions?: ShippingOption[];
@@ -138,6 +139,22 @@ declare interface Consignment {
     lineItemIds: string[];
 }
 
+declare interface ConsignmentAutomaticDiscount extends ConsignmentDiscountBase<'AUTOMATIC'> {
+}
+
+declare interface ConsignmentCouponDiscount extends ConsignmentDiscountBase<'COUPON'> {
+    couponId: number;
+    couponCode: string;
+}
+
+declare type ConsignmentDiscount = ConsignmentAutomaticDiscount | ConsignmentCouponDiscount;
+
+declare interface ConsignmentDiscountBase<T> {
+    id: number;
+    amount: number;
+    type: T;
+}
+
 declare interface ConsignmentPickupOption {
     pickupMethodId: number;
 }

package/docs/README.md

@@ -183,7 +183,10 @@
 - [Consignment](interfaces/Consignment.md)
 - [ConsignmentAssignmentBaseRequestBodyWithAddress](interfaces/ConsignmentAssignmentBaseRequestBodyWithAddress.md)
 - [ConsignmentAssignmentBaseRequestBodyWithShippingAddress](interfaces/ConsignmentAssignmentBaseRequestBodyWithShippingAddress.md)
+- [ConsignmentAutomaticDiscount](interfaces/ConsignmentAutomaticDiscount.md)
+- [ConsignmentCouponDiscount](interfaces/ConsignmentCouponDiscount.md)
 - [ConsignmentCreateRequestBody](interfaces/ConsignmentCreateRequestBody.md)
+- [ConsignmentDiscountBase](interfaces/ConsignmentDiscountBase.md)
 - [ConsignmentLineItem](interfaces/ConsignmentLineItem.md)
 - [ConsignmentPickupOption](interfaces/ConsignmentPickupOption.md)
 - [ConsignmentSelector](interfaces/ConsignmentSelector.md)
@@ -320,7 +323,6 @@
 - [NonceInstrument](interfaces/NonceInstrument.md)
 - [Option](interfaces/Option.md)
 - [OptionsResponse](interfaces/OptionsResponse.md)
-- [OpyPaymentInitializeOptions](interfaces/OpyPaymentInitializeOptions.md)
 - [Order](interfaces/Order.md)
 - [OrderBillingAddress](interfaces/OrderBillingAddress.md)
 - [OrderBillingAddressSelector](interfaces/OrderBillingAddressSelector.md)
@@ -508,6 +510,7 @@
 - [CheckoutIncludeParam](README.md#checkoutincludeparam)
 - [ComparableCheckout](README.md#comparablecheckout)
 - [ConsignmentAssignmentRequestBody](README.md#consignmentassignmentrequestbody)
+- [ConsignmentDiscount](README.md#consignmentdiscount)
 - [ConsignmentsRequestBody](README.md#consignmentsrequestbody)
 - [CustomerAddressRequestBody](README.md#customeraddressrequestbody)
 - [CustomerInitializeOptions](README.md#customerinitializeoptions)
@@ -664,6 +667,12 @@ ___
 
 ___
 
+### ConsignmentDiscount
+
+Ƭ **ConsignmentDiscount**: [`ConsignmentAutomaticDiscount`](interfaces/ConsignmentAutomaticDiscount.md) \| [`ConsignmentCouponDiscount`](interfaces/ConsignmentCouponDiscount.md)
+
+___
+
 ### ConsignmentsRequestBody
 
 Ƭ **ConsignmentsRequestBody**: [`ConsignmentCreateRequestBody`](interfaces/ConsignmentCreateRequestBody.md)[]

package/docs/interfaces/BasePaymentInitializeOptions.md

@@ -23,7 +23,6 @@ current checkout flow.
 - [gatewayId](BasePaymentInitializeOptions.md#gatewayid)
 - [masterpass](BasePaymentInitializeOptions.md#masterpass)
 - [methodId](BasePaymentInitializeOptions.md#methodid)
-- [opy](BasePaymentInitializeOptions.md#opy)
 - [params](BasePaymentInitializeOptions.md#params)
 - [paypalexpress](BasePaymentInitializeOptions.md#paypalexpress)
 - [timeout](BasePaymentInitializeOptions.md#timeout)
@@ -113,15 +112,6 @@ The identifier of the payment method.
 
 ___
 
-### opy
-
-• `Optional` **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.
-
-___
-
 ### params
 
 • `Optional` **params**: `Object`

package/docs/interfaces/Consignment.md

@@ -8,6 +8,7 @@
 
 - [address](Consignment.md#address)
 - [availableShippingOptions](Consignment.md#availableshippingoptions)
+- [discounts](Consignment.md#discounts)
 - [handlingCost](Consignment.md#handlingcost)
 - [id](Consignment.md#id)
 - [lineItemIds](Consignment.md#lineitemids)
@@ -30,6 +31,12 @@ ___
 
 ___
 
+### discounts
+
+• **discounts**: [`ConsignmentDiscount`](../README.md#consignmentdiscount)[]
+
+___
+
 ### handlingCost
 
 • **handlingCost**: `number`

package/docs/interfaces/ConsignmentAutomaticDiscount.md

@@ -0,0 +1,47 @@
+[@bigcommerce/checkout-sdk](../README.md) / ConsignmentAutomaticDiscount
+
+# Interface: ConsignmentAutomaticDiscount
+
+## Hierarchy
+
+- [`ConsignmentDiscountBase`](ConsignmentDiscountBase.md)<``"AUTOMATIC"``\>
+
+  ↳ **`ConsignmentAutomaticDiscount`**
+
+## Table of contents
+
+### Properties
+
+- [amount](ConsignmentAutomaticDiscount.md#amount)
+- [id](ConsignmentAutomaticDiscount.md#id)
+- [type](ConsignmentAutomaticDiscount.md#type)
+
+## Properties
+
+### amount
+
+• **amount**: `number`
+
+#### Inherited from
+
+[ConsignmentDiscountBase](ConsignmentDiscountBase.md).[amount](ConsignmentDiscountBase.md#amount)
+
+___
+
+### id
+
+• **id**: `number`
+
+#### Inherited from
+
+[ConsignmentDiscountBase](ConsignmentDiscountBase.md).[id](ConsignmentDiscountBase.md#id)
+
+___
+
+### type
+
+• **type**: ``"AUTOMATIC"``
+
+#### Inherited from
+
+[ConsignmentDiscountBase](ConsignmentDiscountBase.md).[type](ConsignmentDiscountBase.md#type)

package/docs/interfaces/ConsignmentCouponDiscount.md

@@ -0,0 +1,61 @@
+[@bigcommerce/checkout-sdk](../README.md) / ConsignmentCouponDiscount
+
+# Interface: ConsignmentCouponDiscount
+
+## Hierarchy
+
+- [`ConsignmentDiscountBase`](ConsignmentDiscountBase.md)<``"COUPON"``\>
+
+  ↳ **`ConsignmentCouponDiscount`**
+
+## Table of contents
+
+### Properties
+
+- [amount](ConsignmentCouponDiscount.md#amount)
+- [couponCode](ConsignmentCouponDiscount.md#couponcode)
+- [couponId](ConsignmentCouponDiscount.md#couponid)
+- [id](ConsignmentCouponDiscount.md#id)
+- [type](ConsignmentCouponDiscount.md#type)
+
+## Properties
+
+### amount
+
+• **amount**: `number`
+
+#### Inherited from
+
+[ConsignmentDiscountBase](ConsignmentDiscountBase.md).[amount](ConsignmentDiscountBase.md#amount)
+
+___
+
+### couponCode
+
+• **couponCode**: `string`
+
+___
+
+### couponId
+
+• **couponId**: `number`
+
+___
+
+### id
+
+• **id**: `number`
+
+#### Inherited from
+
+[ConsignmentDiscountBase](ConsignmentDiscountBase.md).[id](ConsignmentDiscountBase.md#id)
+
+___
+
+### type
+
+• **type**: ``"COUPON"``
+
+#### Inherited from
+
+[ConsignmentDiscountBase](ConsignmentDiscountBase.md).[type](ConsignmentDiscountBase.md#type)

package/docs/interfaces/ConsignmentDiscountBase.md

@@ -0,0 +1,43 @@
+[@bigcommerce/checkout-sdk](../README.md) / ConsignmentDiscountBase
+
+# Interface: ConsignmentDiscountBase<T\>
+
+## Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+## Hierarchy
+
+- **`ConsignmentDiscountBase`**
+
+  ↳ [`ConsignmentAutomaticDiscount`](ConsignmentAutomaticDiscount.md)
+
+  ↳ [`ConsignmentCouponDiscount`](ConsignmentCouponDiscount.md)
+
+## Table of contents
+
+### Properties
+
+- [amount](ConsignmentDiscountBase.md#amount)
+- [id](ConsignmentDiscountBase.md#id)
+- [type](ConsignmentDiscountBase.md#type)
+
+## Properties
+
+### amount
+
+• **amount**: `number`
+
+___
+
+### id
+
+• **id**: `number`
+
+___
+
+### type
+
+• **type**: `T`

package/package.json

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

package/docs/interfaces/OpyPaymentInitializeOptions.md

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