@bigcommerce/checkout-sdk 1.274.0 → 1.276.0

package/dist/checkout-sdk.d.ts

@@ -632,20 +632,17 @@ declare interface AmazonPayShippingInitializeOptions {
     onReady?(reference: AmazonPayOrderReference): void;
 }
 
-/**
- * The required config to render the AmazonPayV2 buttton.
- */
-declare type AmazonPayV2ButtonInitializeOptions = AmazonPayV2ButtonParams;
+declare enum AmazonPayV2ButtonColor {
+    Gold = "Gold",
+    LightGray = "LightGray",
+    DarkGray = "DarkGray"
+}
 
-declare interface AmazonPayV2ButtonParams {
+declare interface AmazonPayV2ButtonConfig {
     /**
      * Amazon Pay merchant account identifier.
      */
     merchantId: string;
-    /**
-     * Configuration for calling the endpoint to Create Checkout Session.
-     */
-    createCheckoutSession: AmazonPayV2CheckoutSession;
     /**
      * Placement of the Amazon Pay button on your website.
      */
@@ -658,16 +655,35 @@ declare interface AmazonPayV2ButtonParams {
      * Product type selected for checkout. Default is 'PayAndShip'.
      */
     productType?: AmazonPayV2PayOptions;
+    /**
+     * Color of the Amazon Pay button.
+     */
+    buttonColor?: AmazonPayV2ButtonColor;
     /**
      * Language used to render the button and text on Amazon Pay hosted pages.
      */
     checkoutLanguage?: AmazonPayV2CheckoutLanguage;
     /**
-     * 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.
      */
     sandbox?: boolean;
 }
 
+/**
+ * The required config to render the AmazonPayV2 buttton.
+ */
+declare type AmazonPayV2ButtonInitializeOptions = AmazonPayV2ButtonParameters;
+
+declare type AmazonPayV2ButtonParameters = AmazonPayV2ButtonParams | AmazonPayV2NewButtonParams;
+
+declare interface AmazonPayV2ButtonParams extends AmazonPayV2ButtonConfig {
+    /**
+     * Configuration for calling the endpoint to Create Checkout Session.
+     */
+    createCheckoutSession: AmazonPayV2CheckoutSession;
+}
+
 declare enum AmazonPayV2CheckoutLanguage {
     en_US = "en_US",
     en_GB = "en_GB",
@@ -693,6 +709,22 @@ declare interface AmazonPayV2CheckoutSession {
     extractAmazonCheckoutSessionId?: string;
 }
 
+declare interface AmazonPayV2CheckoutSessionConfig {
+    /**
+     * A payload that Amazon Pay will use to create a Checkout Session object.
+     */
+    payloadJSON: string;
+    /**
+     * Payload's signature.
+     */
+    signature: string;
+    /**
+     * Credential provided by Amazon Pay. You do not have to set this parameter
+     * if your `publicKeyId` has an environment prefix.
+     */
+    publicKeyId?: string;
+}
+
 /**
  * A set of options that are required to initialize the customer step of
  * checkout in order to support AmazonPayV2.
@@ -715,6 +747,18 @@ declare enum AmazonPayV2LedgerCurrency {
     JPY = "JPY"
 }
 
+declare interface AmazonPayV2NewButtonParams extends AmazonPayV2ButtonConfig {
+    /**
+     * Credential provided by Amazon Pay. You must also set the `sandbox`
+     * parameter if your `publicKeyId` does not have an environment prefix.
+     */
+    publicKeyId?: string;
+    /**
+     * Create Checkout Session configuration.
+     */
+    createCheckoutSessionConfig: AmazonPayV2CheckoutSessionConfig;
+}
+
 declare enum AmazonPayV2PayOptions {
     /** Select this product type if you need the buyer's shipping details. */
     PayAndShip = "PayAndShip",
@@ -1007,6 +1051,7 @@ declare interface BaseCheckoutButtonInitializeOptions extends CheckoutButtonOpti
  * information in order to initialize the customer step of checkout.
  */
 declare interface BaseCustomerInitializeOptions extends CustomerRequestOptions {
+    [key: string]: unknown;
     /**
      * The options that are required to initialize the customer step of checkout
      * when using Amazon Pay.
@@ -4538,6 +4583,10 @@ declare interface Discount {
     discountedAmount: number;
 }
 
+declare interface DisplaySettings {
+    hidePriceFromGuests: boolean;
+}
+
 declare class EmbeddedCheckout {
     private _iframeCreator;
     private _messageListener;
@@ -5688,7 +5737,7 @@ declare interface Order {
     billingAddress: BillingAddress;
     cartId: string;
     coupons: Coupon[];
-    consignments: OrderConsignment[];
+    consignments: OrderConsignment;
     currency: Currency;
     customerCanBeCreated: boolean;
     customerId: number;
@@ -6660,6 +6709,7 @@ declare interface StoreConfig {
     checkoutSettings: CheckoutSettings;
     currency: StoreCurrency;
     displayDateFormat: string;
+    displaySettings: DisplaySettings;
     inputDateFormat: string;
     /**
      * @deprecated Please use instead the data selectors