@bigcommerce/checkout-sdk 1.274.0 → 1.276.0

package/dist/internal-mappers.d.ts

@@ -571,7 +571,7 @@ declare interface Order {
     billingAddress: BillingAddress;
     cartId: string;
     coupons: Coupon[];
-    consignments: OrderConsignment[];
+    consignments: OrderConsignment;
     currency: Currency;
     customerCanBeCreated: boolean;
     customerId: number;

package/docs/README.md

@@ -8,6 +8,7 @@
 
 - [AdyenV2CardFields](enums/AdyenV2CardFields.md)
 - [AdyenV3CardFields](enums/AdyenV3CardFields.md)
+- [AmazonPayV2ButtonColor](enums/AmazonPayV2ButtonColor.md)
 - [AmazonPayV2CheckoutLanguage](enums/AmazonPayV2CheckoutLanguage.md)
 - [AmazonPayV2LedgerCurrency](enums/AmazonPayV2LedgerCurrency.md)
 - [AmazonPayV2PayOptions](enums/AmazonPayV2PayOptions.md)
@@ -76,9 +77,12 @@
 - [AmazonPayOrderReference](interfaces/AmazonPayOrderReference.md)
 - [AmazonPayPaymentInitializeOptions](interfaces/AmazonPayPaymentInitializeOptions.md)
 - [AmazonPayShippingInitializeOptions](interfaces/AmazonPayShippingInitializeOptions.md)
+- [AmazonPayV2ButtonConfig](interfaces/AmazonPayV2ButtonConfig.md)
 - [AmazonPayV2ButtonParams](interfaces/AmazonPayV2ButtonParams.md)
 - [AmazonPayV2CheckoutSession](interfaces/AmazonPayV2CheckoutSession.md)
+- [AmazonPayV2CheckoutSessionConfig](interfaces/AmazonPayV2CheckoutSessionConfig.md)
 - [AmazonPayV2CustomerInitializeOptions](interfaces/AmazonPayV2CustomerInitializeOptions.md)
+- [AmazonPayV2NewButtonParams](interfaces/AmazonPayV2NewButtonParams.md)
 - [AmazonPayV2PaymentInitializeOptions](interfaces/AmazonPayV2PaymentInitializeOptions.md)
 - [AmazonPayV2ShippingInitializeOptions](interfaces/AmazonPayV2ShippingInitializeOptions.md)
 - [AmazonPayWidgetError](interfaces/AmazonPayWidgetError.md)
@@ -187,6 +191,7 @@
 - [DigitalRiverElementClasses](interfaces/DigitalRiverElementClasses.md)
 - [DigitalRiverPaymentInitializeOptions](interfaces/DigitalRiverPaymentInitializeOptions.md)
 - [Discount](interfaces/Discount.md)
+- [DisplaySettings](interfaces/DisplaySettings.md)
 - [EmbeddedCheckoutCompleteEvent](interfaces/EmbeddedCheckoutCompleteEvent.md)
 - [EmbeddedCheckoutError](interfaces/EmbeddedCheckoutError.md)
 - [EmbeddedCheckoutErrorEvent](interfaces/EmbeddedCheckoutErrorEvent.md)
@@ -364,6 +369,7 @@
 - [AdyenComponentState](README.md#adyencomponentstate)
 - [AdyenV3ComponentState](README.md#adyenv3componentstate)
 - [AmazonPayV2ButtonInitializeOptions](README.md#amazonpayv2buttoninitializeoptions)
+- [AmazonPayV2ButtonParameters](README.md#amazonpayv2buttonparameters)
 - [AnalyticStepType](README.md#analyticsteptype)
 - [BraintreeFormFieldBlurEventData](README.md#braintreeformfieldblureventdata)
 - [BraintreeFormFieldEnterEventData](README.md#braintreeformfieldentereventdata)
@@ -441,12 +447,18 @@ ___
 
 ### AmazonPayV2ButtonInitializeOptions
 
-Ƭ **AmazonPayV2ButtonInitializeOptions**: [`AmazonPayV2ButtonParams`](interfaces/AmazonPayV2ButtonParams.md)
+Ƭ **AmazonPayV2ButtonInitializeOptions**: [`AmazonPayV2ButtonParameters`](README.md#amazonpayv2buttonparameters)
 
 The required config to render the AmazonPayV2 buttton.
 
 ___
 
+### AmazonPayV2ButtonParameters
+
+Ƭ **AmazonPayV2ButtonParameters**: [`AmazonPayV2ButtonParams`](interfaces/AmazonPayV2ButtonParams.md) \| [`AmazonPayV2NewButtonParams`](interfaces/AmazonPayV2NewButtonParams.md)
+
+___
+
 ### AnalyticStepType
 
 Ƭ **AnalyticStepType**: ``"customer"`` \| ``"shipping"`` \| ``"billing"`` \| ``"payment"``

package/docs/enums/AmazonPayV2ButtonColor.md

@@ -0,0 +1,29 @@
+[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2ButtonColor
+
+# Enumeration: AmazonPayV2ButtonColor
+
+## Table of contents
+
+### Enumeration members
+
+- [DarkGray](AmazonPayV2ButtonColor.md#darkgray)
+- [Gold](AmazonPayV2ButtonColor.md#gold)
+- [LightGray](AmazonPayV2ButtonColor.md#lightgray)
+
+## Enumeration members
+
+### DarkGray
+
+• **DarkGray** = `"DarkGray"`
+
+___
+
+### Gold
+
+• **Gold** = `"Gold"`
+
+___
+
+### LightGray
+
+• **LightGray** = `"LightGray"`

package/docs/interfaces/AmazonPayV2ButtonConfig.md

@@ -0,0 +1,80 @@
+[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2ButtonConfig
+
+# Interface: AmazonPayV2ButtonConfig
+
+## Hierarchy
+
+- **`AmazonPayV2ButtonConfig`**
+
+  ↳ [`AmazonPayV2ButtonParams`](AmazonPayV2ButtonParams.md)
+
+  ↳ [`AmazonPayV2NewButtonParams`](AmazonPayV2NewButtonParams.md)
+
+## Table of contents
+
+### Properties
+
+- [buttonColor](AmazonPayV2ButtonConfig.md#buttoncolor)
+- [checkoutLanguage](AmazonPayV2ButtonConfig.md#checkoutlanguage)
+- [ledgerCurrency](AmazonPayV2ButtonConfig.md#ledgercurrency)
+- [merchantId](AmazonPayV2ButtonConfig.md#merchantid)
+- [placement](AmazonPayV2ButtonConfig.md#placement)
+- [productType](AmazonPayV2ButtonConfig.md#producttype)
+- [sandbox](AmazonPayV2ButtonConfig.md#sandbox)
+
+## Properties
+
+### buttonColor
+
+• `Optional` **buttonColor**: [`Gold`](../enums/AmazonPayV2ButtonColor.md#gold) \| [`LightGray`](../enums/AmazonPayV2ButtonColor.md#lightgray) \| [`DarkGray`](../enums/AmazonPayV2ButtonColor.md#darkgray)
+
+Color of the Amazon Pay button.
+
+___
+
+### checkoutLanguage
+
+• `Optional` **checkoutLanguage**: [`en_US`](../enums/AmazonPayV2CheckoutLanguage.md#en_us) \| [`en_GB`](../enums/AmazonPayV2CheckoutLanguage.md#en_gb) \| [`de_DE`](../enums/AmazonPayV2CheckoutLanguage.md#de_de) \| [`fr_FR`](../enums/AmazonPayV2CheckoutLanguage.md#fr_fr) \| [`it_IT`](../enums/AmazonPayV2CheckoutLanguage.md#it_it) \| [`es_ES`](../enums/AmazonPayV2CheckoutLanguage.md#es_es) \| [`ja_JP`](../enums/AmazonPayV2CheckoutLanguage.md#ja_jp)
+
+Language used to render the button and text on Amazon Pay hosted pages.
+
+___
+
+### ledgerCurrency
+
+• **ledgerCurrency**: [`AmazonPayV2LedgerCurrency`](../enums/AmazonPayV2LedgerCurrency.md)
+
+Ledger currency provided during registration for the given merchant identifier.
+
+___
+
+### merchantId
+
+• **merchantId**: `string`
+
+Amazon Pay merchant account identifier.
+
+___
+
+### placement
+
+• **placement**: [`AmazonPayV2Placement`](../enums/AmazonPayV2Placement.md)
+
+Placement of the Amazon Pay button on your website.
+
+___
+
+### productType
+
+• `Optional` **productType**: [`PayAndShip`](../enums/AmazonPayV2PayOptions.md#payandship) \| [`PayOnly`](../enums/AmazonPayV2PayOptions.md#payonly)
+
+Product type selected for checkout. Default is 'PayAndShip'.
+
+___
+
+### sandbox
+
+• `Optional` **sandbox**: `boolean`
+
+Sets button to Sandbox environment. You do not have to set this parameter
+if your `publicKeyId` has an environment prefix. Default is false.

package/docs/interfaces/AmazonPayV2ButtonParams.md

@@ -2,10 +2,17 @@
 
 # Interface: AmazonPayV2ButtonParams
 
+## Hierarchy
+
+- [`AmazonPayV2ButtonConfig`](AmazonPayV2ButtonConfig.md)
+
+  ↳ **`AmazonPayV2ButtonParams`**
+
 ## Table of contents
 
 ### Properties
 
+- [buttonColor](AmazonPayV2ButtonParams.md#buttoncolor)
 - [checkoutLanguage](AmazonPayV2ButtonParams.md#checkoutlanguage)
 - [createCheckoutSession](AmazonPayV2ButtonParams.md#createcheckoutsession)
 - [ledgerCurrency](AmazonPayV2ButtonParams.md#ledgercurrency)
@@ -16,12 +23,28 @@
 
 ## Properties
 
+### buttonColor
+
+• `Optional` **buttonColor**: [`Gold`](../enums/AmazonPayV2ButtonColor.md#gold) \| [`LightGray`](../enums/AmazonPayV2ButtonColor.md#lightgray) \| [`DarkGray`](../enums/AmazonPayV2ButtonColor.md#darkgray)
+
+Color of the Amazon Pay button.
+
+#### Inherited from
+
+[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[buttonColor](AmazonPayV2ButtonConfig.md#buttoncolor)
+
+___
+
 ### checkoutLanguage
 
 • `Optional` **checkoutLanguage**: [`en_US`](../enums/AmazonPayV2CheckoutLanguage.md#en_us) \| [`en_GB`](../enums/AmazonPayV2CheckoutLanguage.md#en_gb) \| [`de_DE`](../enums/AmazonPayV2CheckoutLanguage.md#de_de) \| [`fr_FR`](../enums/AmazonPayV2CheckoutLanguage.md#fr_fr) \| [`it_IT`](../enums/AmazonPayV2CheckoutLanguage.md#it_it) \| [`es_ES`](../enums/AmazonPayV2CheckoutLanguage.md#es_es) \| [`ja_JP`](../enums/AmazonPayV2CheckoutLanguage.md#ja_jp)
 
 Language used to render the button and text on Amazon Pay hosted pages.
 
+#### Inherited from
+
+[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[checkoutLanguage](AmazonPayV2ButtonConfig.md#checkoutlanguage)
+
 ___
 
 ### createCheckoutSession
@@ -38,6 +61,10 @@ ___
 
 Ledger currency provided during registration for the given merchant identifier.
 
+#### Inherited from
+
+[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[ledgerCurrency](AmazonPayV2ButtonConfig.md#ledgercurrency)
+
 ___
 
 ### merchantId
@@ -46,6 +73,10 @@ ___
 
 Amazon Pay merchant account identifier.
 
+#### Inherited from
+
+[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[merchantId](AmazonPayV2ButtonConfig.md#merchantid)
+
 ___
 
 ### placement
@@ -54,6 +85,10 @@ ___
 
 Placement of the Amazon Pay button on your website.
 
+#### Inherited from
+
+[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[placement](AmazonPayV2ButtonConfig.md#placement)
+
 ___
 
 ### productType
@@ -62,10 +97,19 @@ ___
 
 Product type selected for checkout. Default is 'PayAndShip'.
 
+#### Inherited from
+
+[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[productType](AmazonPayV2ButtonConfig.md#producttype)
+
 ___
 
 ### sandbox
 
 • `Optional` **sandbox**: `boolean`
 
-Sets button to Sandbox environment. Default is false.
+Sets button to Sandbox environment. You do not have to set this parameter
+if your `publicKeyId` has an environment prefix. Default is false.
+
+#### Inherited from
+
+[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[sandbox](AmazonPayV2ButtonConfig.md#sandbox)

package/docs/interfaces/AmazonPayV2CheckoutSessionConfig.md

@@ -0,0 +1,36 @@
+[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2CheckoutSessionConfig
+
+# Interface: AmazonPayV2CheckoutSessionConfig
+
+## Table of contents
+
+### Properties
+
+- [payloadJSON](AmazonPayV2CheckoutSessionConfig.md#payloadjson)
+- [publicKeyId](AmazonPayV2CheckoutSessionConfig.md#publickeyid)
+- [signature](AmazonPayV2CheckoutSessionConfig.md#signature)
+
+## Properties
+
+### payloadJSON
+
+• **payloadJSON**: `string`
+
+A payload that Amazon Pay will use to create a Checkout Session object.
+
+___
+
+### publicKeyId
+
+• `Optional` **publicKeyId**: `string`
+
+Credential provided by Amazon Pay. You do not have to set this parameter
+if your `publicKeyId` has an environment prefix.
+
+___
+
+### signature
+
+• **signature**: `string`
+
+Payload's signature.

package/docs/interfaces/AmazonPayV2NewButtonParams.md

@@ -0,0 +1,125 @@
+[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2NewButtonParams
+
+# Interface: AmazonPayV2NewButtonParams
+
+## Hierarchy
+
+- [`AmazonPayV2ButtonConfig`](AmazonPayV2ButtonConfig.md)
+
+  ↳ **`AmazonPayV2NewButtonParams`**
+
+## Table of contents
+
+### Properties
+
+- [buttonColor](AmazonPayV2NewButtonParams.md#buttoncolor)
+- [checkoutLanguage](AmazonPayV2NewButtonParams.md#checkoutlanguage)
+- [createCheckoutSessionConfig](AmazonPayV2NewButtonParams.md#createcheckoutsessionconfig)
+- [ledgerCurrency](AmazonPayV2NewButtonParams.md#ledgercurrency)
+- [merchantId](AmazonPayV2NewButtonParams.md#merchantid)
+- [placement](AmazonPayV2NewButtonParams.md#placement)
+- [productType](AmazonPayV2NewButtonParams.md#producttype)
+- [publicKeyId](AmazonPayV2NewButtonParams.md#publickeyid)
+- [sandbox](AmazonPayV2NewButtonParams.md#sandbox)
+
+## Properties
+
+### buttonColor
+
+• `Optional` **buttonColor**: [`Gold`](../enums/AmazonPayV2ButtonColor.md#gold) \| [`LightGray`](../enums/AmazonPayV2ButtonColor.md#lightgray) \| [`DarkGray`](../enums/AmazonPayV2ButtonColor.md#darkgray)
+
+Color of the Amazon Pay button.
+
+#### Inherited from
+
+[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[buttonColor](AmazonPayV2ButtonConfig.md#buttoncolor)
+
+___
+
+### checkoutLanguage
+
+• `Optional` **checkoutLanguage**: [`en_US`](../enums/AmazonPayV2CheckoutLanguage.md#en_us) \| [`en_GB`](../enums/AmazonPayV2CheckoutLanguage.md#en_gb) \| [`de_DE`](../enums/AmazonPayV2CheckoutLanguage.md#de_de) \| [`fr_FR`](../enums/AmazonPayV2CheckoutLanguage.md#fr_fr) \| [`it_IT`](../enums/AmazonPayV2CheckoutLanguage.md#it_it) \| [`es_ES`](../enums/AmazonPayV2CheckoutLanguage.md#es_es) \| [`ja_JP`](../enums/AmazonPayV2CheckoutLanguage.md#ja_jp)
+
+Language used to render the button and text on Amazon Pay hosted pages.
+
+#### Inherited from
+
+[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[checkoutLanguage](AmazonPayV2ButtonConfig.md#checkoutlanguage)
+
+___
+
+### createCheckoutSessionConfig
+
+• **createCheckoutSessionConfig**: [`AmazonPayV2CheckoutSessionConfig`](AmazonPayV2CheckoutSessionConfig.md)
+
+Create Checkout Session configuration.
+
+___
+
+### ledgerCurrency
+
+• **ledgerCurrency**: [`AmazonPayV2LedgerCurrency`](../enums/AmazonPayV2LedgerCurrency.md)
+
+Ledger currency provided during registration for the given merchant identifier.
+
+#### Inherited from
+
+[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[ledgerCurrency](AmazonPayV2ButtonConfig.md#ledgercurrency)
+
+___
+
+### merchantId
+
+• **merchantId**: `string`
+
+Amazon Pay merchant account identifier.
+
+#### Inherited from
+
+[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[merchantId](AmazonPayV2ButtonConfig.md#merchantid)
+
+___
+
+### placement
+
+• **placement**: [`AmazonPayV2Placement`](../enums/AmazonPayV2Placement.md)
+
+Placement of the Amazon Pay button on your website.
+
+#### Inherited from
+
+[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[placement](AmazonPayV2ButtonConfig.md#placement)
+
+___
+
+### productType
+
+• `Optional` **productType**: [`PayAndShip`](../enums/AmazonPayV2PayOptions.md#payandship) \| [`PayOnly`](../enums/AmazonPayV2PayOptions.md#payonly)
+
+Product type selected for checkout. Default is 'PayAndShip'.
+
+#### Inherited from
+
+[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[productType](AmazonPayV2ButtonConfig.md#producttype)
+
+___
+
+### publicKeyId
+
+• `Optional` **publicKeyId**: `string`
+
+Credential provided by Amazon Pay. You must also set the `sandbox`
+parameter if your `publicKeyId` does not have an environment prefix.
+
+___
+
+### sandbox
+
+• `Optional` **sandbox**: `boolean`
+
+Sets button to Sandbox environment. You do not have to set this parameter
+if your `publicKeyId` has an environment prefix. Default is false.
+
+#### Inherited from
+
+[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[sandbox](AmazonPayV2ButtonConfig.md#sandbox)

package/docs/interfaces/BaseCheckoutButtonInitializeOptions.md

@@ -39,7 +39,7 @@
 
 ### amazonpay
 
-• `Optional` **amazonpay**: [`AmazonPayV2ButtonParams`](AmazonPayV2ButtonParams.md)
+• `Optional` **amazonpay**: [`AmazonPayV2ButtonParams`](AmazonPayV2ButtonParams.md) \| [`AmazonPayV2NewButtonParams`](AmazonPayV2NewButtonParams.md)
 
 The options that are required to facilitate AmazonPayV2. They can be
 omitted unless you need to support AmazonPayV2.

package/docs/interfaces/BaseCustomerInitializeOptions.md

@@ -16,6 +16,10 @@ information in order to initialize the customer step of checkout.
 
   ↳ **`BaseCustomerInitializeOptions`**
 
+## Indexable
+
+▪ [key: `string`]: `unknown`
+
 ## Table of contents
 
 ### Properties

package/docs/interfaces/DisplaySettings.md

@@ -0,0 +1,15 @@
+[@bigcommerce/checkout-sdk](../README.md) / DisplaySettings
+
+# Interface: DisplaySettings
+
+## Table of contents
+
+### Properties
+
+- [hidePriceFromGuests](DisplaySettings.md#hidepricefromguests)
+
+## Properties
+
+### hidePriceFromGuests
+
+• **hidePriceFromGuests**: `boolean`

package/docs/interfaces/Order.md

@@ -55,7 +55,7 @@ ___
 
 ### consignments
 
-• **consignments**: [`OrderConsignment`](OrderConsignment.md)[]
+• **consignments**: [`OrderConsignment`](OrderConsignment.md)
 
 ___
 

package/docs/interfaces/StoreConfig.md

@@ -10,6 +10,7 @@
 - [checkoutSettings](StoreConfig.md#checkoutsettings)
 - [currency](StoreConfig.md#currency)
 - [displayDateFormat](StoreConfig.md#displaydateformat)
+- [displaySettings](StoreConfig.md#displaysettings)
 - [formFields](StoreConfig.md#formfields)
 - [imageDirectory](StoreConfig.md#imagedirectory)
 - [inputDateFormat](StoreConfig.md#inputdateformat)
@@ -46,6 +47,12 @@ ___
 
 ___
 
+### displaySettings
+
+• **displaySettings**: [`DisplaySettings`](DisplaySettings.md)
+
+___
+
 ### formFields
 
 • **formFields**: [`FormFields`](FormFields.md)

package/package.json

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