@bigcommerce/checkout-sdk 1.308.2 → 1.308.3

package/docs/interfaces/internal_.BraintreePaypalButtonInitializeOptions.md

@@ -0,0 +1,122 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BraintreePaypalButtonInitializeOptions
+
+# Interface: BraintreePaypalButtonInitializeOptions
+
+[<internal>](../modules/internal_.md).BraintreePaypalButtonInitializeOptions
+
+## Table of contents
+
+### Properties
+
+- [buyNowInitializeOptions](internal_.BraintreePaypalButtonInitializeOptions.md#buynowinitializeoptions)
+- [currencyCode](internal_.BraintreePaypalButtonInitializeOptions.md#currencycode)
+- [messagingContainerId](internal_.BraintreePaypalButtonInitializeOptions.md#messagingcontainerid)
+- [shippingAddress](internal_.BraintreePaypalButtonInitializeOptions.md#shippingaddress)
+- [style](internal_.BraintreePaypalButtonInitializeOptions.md#style)
+
+### Methods
+
+- [onAuthorizeError](internal_.BraintreePaypalButtonInitializeOptions.md#onauthorizeerror)
+- [onError](internal_.BraintreePaypalButtonInitializeOptions.md#onerror)
+- [onPaymentError](internal_.BraintreePaypalButtonInitializeOptions.md#onpaymenterror)
+
+## Properties
+
+### buyNowInitializeOptions
+
+• `Optional` **buyNowInitializeOptions**: `Object`
+
+The options that are required to initialize Buy Now functionality.
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `getBuyNowCartRequestBody?` | () => `void` \| [`BuyNowCartRequestBody`](internal_.BuyNowCartRequestBody.md) |
+
+___
+
+### currencyCode
+
+• `Optional` **currencyCode**: `string`
+
+The option that used to initialize a PayPal script with provided currency code.
+
+___
+
+### messagingContainerId
+
+• `Optional` **messagingContainerId**: `string`
+
+The ID of a container which the messaging should be inserted.
+
+___
+
+### shippingAddress
+
+• `Optional` **shippingAddress**: ``null`` \| [`Address`](internal_.Address.md)
+
+Address to be used for shipping.
+If not provided, it will use the first saved address from the active customer.
+
+___
+
+### style
+
+• `Optional` **style**: `Pick`<[`PaypalButtonStyleOptions`](internal_.PaypalButtonStyleOptions.md), ``"label"`` \| ``"size"`` \| ``"color"`` \| ``"height"`` \| ``"layout"`` \| ``"shape"`` \| ``"tagline"`` \| ``"fundingicons"``\>
+
+A set of styling options for the checkout button.
+
+## Methods
+
+### onAuthorizeError
+
+▸ `Optional` **onAuthorizeError**(`error`): `void`
+
+A callback that gets called if unable to authorize and tokenize payment.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `error` | [`BraintreeError`](internal_.BraintreeError.md) \| [`StandardError`](../classes/internal_.StandardError.md) | The error object describing the failure. |
+
+#### Returns
+
+`void`
+
+___
+
+### onError
+
+▸ `Optional` **onError**(`error`): `void`
+
+A callback that gets called on any error instead of submit payment or authorization errors.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `error` | [`BraintreeError`](internal_.BraintreeError.md) \| [`StandardError`](../classes/internal_.StandardError.md) | The error object describing the failure. |
+
+#### Returns
+
+`void`
+
+___
+
+### onPaymentError
+
+▸ `Optional` **onPaymentError**(`error`): `void`
+
+A callback that gets called if unable to submit payment.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `error` | [`BraintreeError`](internal_.BraintreeError.md) \| [`StandardError`](../classes/internal_.StandardError.md) | The error object describing the failure. |
+
+#### Returns
+
+`void`

package/docs/interfaces/internal_.BraintreePaypalCreditButtonInitializeOptions.md

@@ -0,0 +1,113 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BraintreePaypalCreditButtonInitializeOptions
+
+# Interface: BraintreePaypalCreditButtonInitializeOptions
+
+[<internal>](../modules/internal_.md).BraintreePaypalCreditButtonInitializeOptions
+
+## Table of contents
+
+### Properties
+
+- [buyNowInitializeOptions](internal_.BraintreePaypalCreditButtonInitializeOptions.md#buynowinitializeoptions)
+- [currencyCode](internal_.BraintreePaypalCreditButtonInitializeOptions.md#currencycode)
+- [shippingAddress](internal_.BraintreePaypalCreditButtonInitializeOptions.md#shippingaddress)
+- [style](internal_.BraintreePaypalCreditButtonInitializeOptions.md#style)
+
+### Methods
+
+- [onAuthorizeError](internal_.BraintreePaypalCreditButtonInitializeOptions.md#onauthorizeerror)
+- [onError](internal_.BraintreePaypalCreditButtonInitializeOptions.md#onerror)
+- [onPaymentError](internal_.BraintreePaypalCreditButtonInitializeOptions.md#onpaymenterror)
+
+## Properties
+
+### buyNowInitializeOptions
+
+• `Optional` **buyNowInitializeOptions**: `Object`
+
+The options that are required to initialize Buy Now functionality.
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `getBuyNowCartRequestBody?` | () => `void` \| [`BuyNowCartRequestBody`](internal_.BuyNowCartRequestBody.md) |
+
+___
+
+### currencyCode
+
+• `Optional` **currencyCode**: `string`
+
+The option that used to initialize a PayPal script with provided currency code.
+
+___
+
+### shippingAddress
+
+• `Optional` **shippingAddress**: ``null`` \| [`Address`](internal_.Address.md)
+
+Address to be used for shipping.
+If not provided, it will use the first saved address from the active customer.
+
+___
+
+### style
+
+• `Optional` **style**: `Pick`<[`PaypalButtonStyleOptions`](internal_.PaypalButtonStyleOptions.md), ``"label"`` \| ``"size"`` \| ``"color"`` \| ``"height"`` \| ``"layout"`` \| ``"shape"`` \| ``"tagline"`` \| ``"fundingicons"``\>
+
+A set of styling options for the checkout button.
+
+## Methods
+
+### onAuthorizeError
+
+▸ `Optional` **onAuthorizeError**(`error`): `void`
+
+A callback that gets called if unable to authorize and tokenize payment.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `error` | [`BraintreeError`](internal_.BraintreeError.md) \| [`StandardError`](../classes/internal_.StandardError.md) | The error object describing the failure. |
+
+#### Returns
+
+`void`
+
+___
+
+### onError
+
+▸ `Optional` **onError**(`error`): `void`
+
+A callback that gets called on any error instead of submit payment or authorization errors.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `error` | [`BraintreeError`](internal_.BraintreeError.md) \| [`StandardError`](../classes/internal_.StandardError.md) | The error object describing the failure. |
+
+#### Returns
+
+`void`
+
+___
+
+### onPaymentError
+
+▸ `Optional` **onPaymentError**(`error`): `void`
+
+A callback that gets called if unable to submit payment.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `error` | [`BraintreeError`](internal_.BraintreeError.md) \| [`StandardError`](../classes/internal_.StandardError.md) | The error object describing the failure. |
+
+#### Returns
+
+`void`

package/docs/interfaces/internal_.BraintreeVenmoButtonInitializeOptions.md

@@ -0,0 +1,56 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BraintreeVenmoButtonInitializeOptions
+
+# Interface: BraintreeVenmoButtonInitializeOptions
+
+[<internal>](../modules/internal_.md).BraintreeVenmoButtonInitializeOptions
+
+## Table of contents
+
+### Properties
+
+- [buyNowInitializeOptions](internal_.BraintreeVenmoButtonInitializeOptions.md#buynowinitializeoptions)
+- [currencyCode](internal_.BraintreeVenmoButtonInitializeOptions.md#currencycode)
+
+### Methods
+
+- [onError](internal_.BraintreeVenmoButtonInitializeOptions.md#onerror)
+
+## Properties
+
+### buyNowInitializeOptions
+
+• `Optional` **buyNowInitializeOptions**: `Object`
+
+The options that are required to initialize Buy Now functionality.
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `getBuyNowCartRequestBody?` | () => `void` \| [`BuyNowCartRequestBody`](internal_.BuyNowCartRequestBody.md) |
+
+___
+
+### currencyCode
+
+• `Optional` **currencyCode**: `string`
+
+The option that used to initialize a PayPal script with provided currency code.
+
+## Methods
+
+### onError
+
+▸ `Optional` **onError**(`error`): `void`
+
+A callback that gets called on any error.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `error` | [`BraintreeError`](internal_.BraintreeError.md) \| [`StandardError`](../classes/internal_.StandardError.md) | The error object describing the failure. |
+
+#### Returns
+
+`void`

package/docs/interfaces/internal_.BuyNowCartRequestBody.md

@@ -0,0 +1,26 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BuyNowCartRequestBody
+
+# Interface: BuyNowCartRequestBody
+
+[<internal>](../modules/internal_.md).BuyNowCartRequestBody
+
+An object that contains the information required for creating 'Buy now' cart.
+
+## Table of contents
+
+### Properties
+
+- [lineItems](internal_.BuyNowCartRequestBody.md#lineitems)
+- [source](internal_.BuyNowCartRequestBody.md#source)
+
+## Properties
+
+### lineItems
+
+• **lineItems**: [`LineItem`](internal_.LineItem.md)[]
+
+___
+
+### source
+
+• **source**: ``"BUY_NOW"``

package/docs/interfaces/internal_.CheckoutButtonInitializerOptions.md

@@ -0,0 +1,24 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CheckoutButtonInitializerOptions
+
+# Interface: CheckoutButtonInitializerOptions
+
+[<internal>](../modules/internal_.md).CheckoutButtonInitializerOptions
+
+## Table of contents
+
+### Properties
+
+- [host](internal_.CheckoutButtonInitializerOptions.md#host)
+- [locale](internal_.CheckoutButtonInitializerOptions.md#locale)
+
+## Properties
+
+### host
+
+• `Optional` **host**: `string`
+
+___
+
+### locale
+
+• `Optional` **locale**: `string`

package/docs/interfaces/internal_.CheckoutButtonOptions.md

@@ -0,0 +1,57 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CheckoutButtonOptions
+
+# Interface: CheckoutButtonOptions
+
+[<internal>](../modules/internal_.md).CheckoutButtonOptions
+
+The set of options for configuring the checkout button.
+
+## Hierarchy
+
+- [`RequestOptions`](internal_.RequestOptions.md)
+
+  ↳ **`CheckoutButtonOptions`**
+
+  ↳↳ [`BaseCheckoutButtonInitializeOptions`](internal_.BaseCheckoutButtonInitializeOptions.md)
+
+## Table of contents
+
+### Properties
+
+- [methodId](internal_.CheckoutButtonOptions.md#methodid)
+- [params](internal_.CheckoutButtonOptions.md#params)
+- [timeout](internal_.CheckoutButtonOptions.md#timeout)
+
+## Properties
+
+### methodId
+
+• **methodId**: [`CheckoutButtonMethodType`](../enums/internal_.CheckoutButtonMethodType.md)
+
+The identifier of the payment method.
+
+___
+
+### params
+
+• `Optional` **params**: `Object`
+
+The parameters of the request, if required.
+
+#### Inherited from
+
+[RequestOptions](internal_.RequestOptions.md).[params](internal_.RequestOptions.md#params)
+
+___
+
+### timeout
+
+• `Optional` **timeout**: `default`
+
+Provide this option if you want to cancel or time out the request. If the
+timeout object completes before the request, the request will be
+cancelled.
+
+#### Inherited from
+
+[RequestOptions](internal_.RequestOptions.md).[timeout](internal_.RequestOptions.md#timeout)

package/docs/interfaces/internal_.CheckoutButtonSelectors.md

@@ -0,0 +1,24 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CheckoutButtonSelectors
+
+# Interface: CheckoutButtonSelectors
+
+[<internal>](../modules/internal_.md).CheckoutButtonSelectors
+
+## Table of contents
+
+### Properties
+
+- [errors](internal_.CheckoutButtonSelectors.md#errors)
+- [statuses](internal_.CheckoutButtonSelectors.md#statuses)
+
+## Properties
+
+### errors
+
+• **errors**: [`CheckoutButtonErrorSelector`](../classes/internal_.CheckoutButtonErrorSelector.md)
+
+___
+
+### statuses
+
+• **statuses**: [`CheckoutButtonStatusSelector`](../classes/internal_.CheckoutButtonStatusSelector.md)

package/docs/interfaces/{internal_.GooglePayCustomerInitializeOptions.md → internal_.GooglePayButtonInitializeOptions.md}

@@ -1,16 +1,15 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / GooglePayCustomerInitializeOptions
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / GooglePayButtonInitializeOptions
 
-# Interface: GooglePayCustomerInitializeOptions
+# Interface: GooglePayButtonInitializeOptions
 
-[<internal>](../modules/internal_.md).GooglePayCustomerInitializeOptions
+[<internal>](../modules/internal_.md).GooglePayButtonInitializeOptions
 
 ## Table of contents
 
 ### Properties
 
-- [buttonColor](internal_.GooglePayCustomerInitializeOptions.md#buttoncolor)
-- [buttonType](internal_.GooglePayCustomerInitializeOptions.md#buttontype)
-- [container](internal_.GooglePayCustomerInitializeOptions.md#container)
+- [buttonColor](internal_.GooglePayButtonInitializeOptions.md#buttoncolor)
+- [buttonType](internal_.GooglePayButtonInitializeOptions.md#buttontype)
 
 ## Properties
 
@@ -32,13 +31,3 @@ The size of the GooglePay button that will be inserted.
  long: "Buy with Google Pay" button (default). A translated button label may appear
         if a language specified in the viewer's browser matches an available language.
  short: Google Pay payment button without the "Buy with" text.
-
-___
-
-### container
-
-• **container**: `string`
-
-This container is used to set an event listener, provide an element ID if you want
-users to be able to launch the GooglePay wallet modal by clicking on a button.
-It should be an HTML element.

package/docs/interfaces/internal_.LineItem.md

@@ -4,151 +4,26 @@
 
 [<internal>](../modules/internal_.md).LineItem
 
-## Hierarchy
-
-- **`LineItem`**
-
-  ↳ [`PhysicalItem`](internal_.PhysicalItem.md)
-
-  ↳ [`DigitalItem`](internal_.DigitalItem.md)
-
 ## Table of contents
 
 ### Properties
 
-- [addedByPromotion](internal_.LineItem.md#addedbypromotion)
-- [brand](internal_.LineItem.md#brand)
-- [categories](internal_.LineItem.md#categories)
-- [categoryNames](internal_.LineItem.md#categorynames)
-- [comparisonPrice](internal_.LineItem.md#comparisonprice)
-- [couponAmount](internal_.LineItem.md#couponamount)
-- [discountAmount](internal_.LineItem.md#discountamount)
-- [discounts](internal_.LineItem.md#discounts)
-- [extendedComparisonPrice](internal_.LineItem.md#extendedcomparisonprice)
-- [extendedListPrice](internal_.LineItem.md#extendedlistprice)
-- [extendedSalePrice](internal_.LineItem.md#extendedsaleprice)
-- [id](internal_.LineItem.md#id)
-- [imageUrl](internal_.LineItem.md#imageurl)
-- [isTaxable](internal_.LineItem.md#istaxable)
-- [listPrice](internal_.LineItem.md#listprice)
-- [name](internal_.LineItem.md#name)
-- [options](internal_.LineItem.md#options)
-- [parentId](internal_.LineItem.md#parentid)
+- [optionSelections](internal_.LineItem.md#optionselections)
 - [productId](internal_.LineItem.md#productid)
 - [quantity](internal_.LineItem.md#quantity)
-- [salePrice](internal_.LineItem.md#saleprice)
-- [sku](internal_.LineItem.md#sku)
-- [socialMedia](internal_.LineItem.md#socialmedia)
-- [url](internal_.LineItem.md#url)
-- [variantId](internal_.LineItem.md#variantid)
 
 ## Properties
 
-### addedByPromotion
-
-• **addedByPromotion**: `boolean`
-
-___
-
-### brand
-
-• **brand**: `string`
-
-___
-
-### categories
-
-• `Optional` **categories**: [`LineItemCategory`](internal_.LineItemCategory.md)[][]
-
-___
-
-### categoryNames
-
-• `Optional` **categoryNames**: `string`[]
-
-___
-
-### comparisonPrice
-
-• **comparisonPrice**: `number`
-
-___
-
-### couponAmount
-
-• **couponAmount**: `number`
-
-___
-
-### discountAmount
-
-• **discountAmount**: `number`
-
-___
-
-### discounts
-
-• **discounts**: { `discountedAmount`: `number` ; `name`: `string`  }[]
-
-___
-
-### extendedComparisonPrice
-
-• **extendedComparisonPrice**: `number`
-
-___
-
-### extendedListPrice
-
-• **extendedListPrice**: `number`
-
-___
-
-### extendedSalePrice
-
-• **extendedSalePrice**: `number`
+### optionSelections
 
-___
-
-### id
-
-• **id**: `string` \| `number`
-
-___
-
-### imageUrl
+• `Optional` **optionSelections**: `Object`
 
-• **imageUrl**: `string`
+#### Type declaration
 
-___
-
-### isTaxable
-
-• **isTaxable**: `boolean`
-
-___
-
-### listPrice
-
-• **listPrice**: `number`
-
-___
-
-### name
-
-• **name**: `string`
-
-___
-
-### options
-
-• `Optional` **options**: [`LineItemOption`](internal_.LineItemOption.md)[]
-
-___
-
-### parentId
-
-• `Optional` **parentId**: ``null`` \| `string`
+| Name | Type |
+| :------ | :------ |
+| `optionId` | `number` |
+| `optionValue` | `string` \| `number` |
 
 ___
 
@@ -161,33 +36,3 @@ ___
 ### quantity
 
 • **quantity**: `number`
-
-___
-
-### salePrice
-
-• **salePrice**: `number`
-
-___
-
-### sku
-
-• **sku**: `string`
-
-___
-
-### socialMedia
-
-• `Optional` **socialMedia**: [`LineItemSocialData`](internal_.LineItemSocialData.md)[]
-
-___
-
-### url
-
-• **url**: `string`
-
-___
-
-### variantId
-
-• **variantId**: `number`