@bigcommerce/checkout-sdk 1.248.2 → 1.251.0

package/dist/checkout-sdk.d.ts

@@ -1039,7 +1039,7 @@ declare interface BoltPaymentInitializeOptions {
 declare interface BraintreeError extends Error {
     type: 'CUSTOMER' | 'MERCHANT' | 'NETWORK' | 'INTERNAL' | 'UNKNOWN';
     code: string;
-    message: string;
+    details?: unknown;
 }
 
 declare type BraintreeFormFieldBlurEventData = BraintreeFormFieldKeyboardEventData;
@@ -1200,7 +1200,37 @@ declare interface BraintreePaymentInitializeOptions {
     form?: BraintreeFormOptions;
 }
 
-declare interface BraintreePaypalButtonInitializeOptions {
+declare interface BraintreePaypalCreditButtonInitializeOptions {
+    /**
+     * A set of styling options for the checkout button.
+     */
+    style?: Pick<PaypalButtonStyleOptions, 'layout' | 'size' | 'color' | 'label' | 'shape' | 'tagline' | 'fundingicons' | 'height'>;
+    /**
+     * Address to be used for shipping.
+     * If not provided, it will use the first saved address from the active customer.
+     */
+    shippingAddress?: Address | null;
+    /**
+     * A callback that gets called if unable to authorize and tokenize payment.
+     *
+     * @param error - The error object describing the failure.
+     */
+    onAuthorizeError?(error: BraintreeError | StandardError): void;
+    /**
+     * A callback that gets called if unable to submit payment.
+     *
+     * @param error - The error object describing the failure.
+     */
+    onPaymentError?(error: BraintreeError | StandardError): void;
+    /**
+     * A callback that gets called on any error instead of submit payment or authorization errors.
+     *
+     * @param error - The error object describing the failure.
+     */
+    onError?(error: BraintreeError | StandardError): void;
+}
+
+declare interface BraintreePaypalV1ButtonInitializeOptions {
     /**
      * The ID of a container which the messaging should be inserted.
      */
@@ -1230,6 +1260,12 @@ declare interface BraintreePaypalButtonInitializeOptions {
      * @param error - The error object describing the failure.
      */
     onPaymentError?(error: BraintreeError | StandardError): void;
+    /**
+     * A callback that gets called on any error instead of submit payment or authorization errors.
+     *
+     * @param error - The error object describing the failure.
+     */
+    onError?(error: BraintreeError | StandardError): void;
 }
 
 declare interface BraintreeStoredCardFieldOptions extends BraintreeFormFieldOptions {
@@ -1624,12 +1660,17 @@ declare interface CheckoutButtonInitializeOptions extends CheckoutButtonOptions
      * The options that are required to facilitate Braintree PayPal. They can be
      * omitted unless you need to support Braintree PayPal.
      */
-    braintreepaypal?: BraintreePaypalButtonInitializeOptions;
+    braintreepaypal?: BraintreePaypalV1ButtonInitializeOptions;
+    /**
+     * The options that are required to facilitate Braintree Credit. They can be
+     * omitted unless you need to support Braintree Credit.
+     */
+    braintreepaypalcredit?: BraintreePaypalV1ButtonInitializeOptions;
     /**
      * The options that are required to facilitate Braintree Credit. They can be
      * omitted unless you need to support Braintree Credit.
      */
-    braintreepaypalcredit?: BraintreePaypalButtonInitializeOptions;
+    braintreepaypalcreditv2?: BraintreePaypalCreditButtonInitializeOptions;
     /**
      * The options that are required to facilitate PayPal. They can be omitted
      * unless you need to support Paypal.
@@ -1787,6 +1828,7 @@ declare enum CheckoutButtonMethodType {
     BRAINTREE_PAYPAL = "braintreepaypal",
     BRAINTREE_VENMO = "braintreevenmo",
     BRAINTREE_PAYPAL_CREDIT = "braintreepaypalcredit",
+    BRAINTREE_PAYPAL_CREDITV2 = "braintreepaypalcreditv2",
     GOOGLEPAY_ADYENV2 = "googlepayadyenv2",
     GOOGLEPAY_ADYENV3 = "googlepayadyenv3",
     GOOGLEPAY_AUTHORIZENET = "googlepayauthorizenet",
@@ -5449,6 +5491,8 @@ declare interface OrderPayment {
     amount: number;
 }
 
+declare type OrderPaymentInstrument = (CreditCardInstrument | HostedInstrument | HostedCreditCardInstrument | HostedVaultedInstrument | NonceInstrument | VaultedInstrument | CreditCardInstrument & WithDocumentInstrument | CreditCardInstrument & WithCheckoutcomFawryInstrument | CreditCardInstrument & WithCheckoutcomSEPAInstrument | CreditCardInstrument & WithCheckoutcomiDealInstrument | HostedInstrument & WithMollieIssuerInstrument | WithAccountCreation);
+
 /**
  * An object that contains the payment information required for submitting an
  * order.
@@ -5466,7 +5510,7 @@ declare interface OrderPaymentRequestBody {
      * An object that contains the details of a credit card, vaulted payment
      * instrument or nonce instrument.
      */
-    paymentData?: CreditCardInstrument | HostedInstrument | HostedCreditCardInstrument | HostedVaultedInstrument | NonceInstrument | VaultedInstrument | CreditCardInstrument & WithDocumentInstrument | CreditCardInstrument & WithCheckoutcomFawryInstrument | CreditCardInstrument & WithCheckoutcomSEPAInstrument | CreditCardInstrument & WithCheckoutcomiDealInstrument | HostedInstrument & WithMollieIssuerInstrument | WithAccountCreation;
+    paymentData?: OrderPaymentInstrument;
 }
 
 declare type OrderPayments = Array<GatewayOrderPayment | GiftCertificateOrderPayment>;
@@ -5799,12 +5843,32 @@ declare interface PaypalButtonInitializeOptions {
     onPaymentError?(error: StandardError): void;
 }
 
+declare enum PaypalButtonStyleColorOption {
+    GOLD = "gold",
+    BLUE = "blue",
+    SIlVER = "silver",
+    BLACK = "black"
+}
+
+declare enum PaypalButtonStyleLabelOption {
+    CHECKOUT = "checkout",
+    PAY = "pay",
+    BUYNOW = "buynow",
+    PAYPAL = "paypal",
+    CREDIT = "credit"
+}
+
+declare enum PaypalButtonStyleLayoutOption {
+    HORIZONTAL = "horizontal",
+    VERTICAL = "vertical"
+}
+
 declare interface PaypalButtonStyleOptions {
-    layout?: 'horizontal' | 'vertical';
-    size?: 'small' | 'medium' | 'large' | 'responsive';
-    color?: 'gold' | 'blue' | 'silver' | 'black';
-    label?: 'checkout' | 'pay' | 'buynow' | 'paypal' | 'credit';
-    shape?: 'pill' | 'rect';
+    layout?: PaypalButtonStyleLayoutOption;
+    size?: PaypalButtonStyleSizeOption;
+    color?: PaypalButtonStyleColorOption;
+    label?: PaypalButtonStyleLabelOption;
+    shape?: PaypalButtonStyleShapeOption;
     tagline?: boolean;
     fundingicons?: boolean;
     height?: number;
@@ -5819,6 +5883,18 @@ declare interface PaypalButtonStyleOptions_2 {
     tagline?: boolean;
 }
 
+declare enum PaypalButtonStyleShapeOption {
+    PILL = "pill",
+    RECT = "rect"
+}
+
+declare enum PaypalButtonStyleSizeOption {
+    SMALL = "small",
+    MEDIUM = "medium",
+    LARGE = "large",
+    RESPONSIVE = "responsive"
+}
+
 declare interface PaypalCommerceButtonInitializeOptions {
     /**
      * A set of styling options for the checkout button.