@bigcommerce/checkout-sdk 1.308.1 → 1.308.2

package/docs/interfaces/internal_.AmazonPayV2PaymentInitializeOptions.md

@@ -0,0 +1,42 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayV2PaymentInitializeOptions
+
+# Interface: AmazonPayV2PaymentInitializeOptions
+
+[<internal>](../modules/internal_.md).AmazonPayV2PaymentInitializeOptions
+
+A set of options that are required to initialize the payment step of
+checkout in order to support AmazonPayV2.
+
+When AmazonPayV2 is initialized, a change payment button will be bound.
+When the customer clicks on it, they will be redirected to Amazon to
+select a different payment method.
+
+```html
+<!-- This is where the Amazon button will be inserted -->
+<div id="edit-button"></div>
+```
+
+```js
+service.initializePayment({
+    methodId: 'amazonpay',
+    amazonpay: {
+        editButtonId: 'edit-button',
+    },
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [editButtonId](internal_.AmazonPayV2PaymentInitializeOptions.md#editbuttonid)
+
+## Properties
+
+### editButtonId
+
+• `Optional` **editButtonId**: `string`
+
+This editButtonId is used to set an event listener, provide an element ID
+if you want users to be able to select a different payment method by
+clicking on a button. It should be an HTML element.

package/docs/interfaces/internal_.AmazonPayV2ShippingInitializeOptions.md

@@ -0,0 +1,28 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayV2ShippingInitializeOptions
+
+# Interface: AmazonPayV2ShippingInitializeOptions
+
+[<internal>](../modules/internal_.md).AmazonPayV2ShippingInitializeOptions
+
+A set of options that are required to initialize the shipping step of
+checkout in order to support AmazonPayV2.
+
+When AmazonPayV2 is initialized, a change shipping button will be bound.
+When the customer clicks on it, they will be redirected to Amazon to
+select a different shipping address.
+
+## Table of contents
+
+### Properties
+
+- [editAddressButtonId](internal_.AmazonPayV2ShippingInitializeOptions.md#editaddressbuttonid)
+
+## Properties
+
+### editAddressButtonId
+
+• `Optional` **editAddressButtonId**: `string`
+
+This editAddressButtonId is used to set an event listener, provide an
+element ID if you want users to be able to select a different shipping
+address by clicking on a button. It should be an HTML element.

package/docs/interfaces/internal_.AmazonPayWidgetError.md

@@ -0,0 +1,27 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayWidgetError
+
+# Interface: AmazonPayWidgetError
+
+[<internal>](../modules/internal_.md).AmazonPayWidgetError
+
+## Hierarchy
+
+- `Error`
+
+  ↳ **`AmazonPayWidgetError`**
+
+## Table of contents
+
+### Methods
+
+- [getErrorCode](internal_.AmazonPayWidgetError.md#geterrorcode)
+
+## Methods
+
+### getErrorCode
+
+▸ **getErrorCode**(): `string`
+
+#### Returns
+
+`string`

package/docs/interfaces/internal_.ApplePayCustomerInitializeOptions.md

@@ -0,0 +1,79 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / ApplePayCustomerInitializeOptions
+
+# Interface: ApplePayCustomerInitializeOptions
+
+[<internal>](../modules/internal_.md).ApplePayCustomerInitializeOptions
+
+A set of options that are required to initialize the customer step of
+checkout in order to support ApplePay.
+
+When ApplePay is initialized, a sign-in button will be inserted into the
+DOM. When the customer clicks on it, it will trigger apple sheet
+
+## Table of contents
+
+### Properties
+
+- [container](internal_.ApplePayCustomerInitializeOptions.md#container)
+- [shippingLabel](internal_.ApplePayCustomerInitializeOptions.md#shippinglabel)
+- [subtotalLabel](internal_.ApplePayCustomerInitializeOptions.md#subtotallabel)
+
+### Methods
+
+- [onError](internal_.ApplePayCustomerInitializeOptions.md#onerror)
+- [onPaymentAuthorize](internal_.ApplePayCustomerInitializeOptions.md#onpaymentauthorize)
+
+## Properties
+
+### container
+
+• **container**: `string`
+
+The ID of a container which the sign-in button should insert into.
+
+___
+
+### shippingLabel
+
+• `Optional` **shippingLabel**: `string`
+
+Shipping label to be passed to apple sheet.
+
+___
+
+### subtotalLabel
+
+• `Optional` **subtotalLabel**: `string`
+
+Sub total label to be passed to apple sheet.
+
+## Methods
+
+### onError
+
+▸ `Optional` **onError**(`error?`): `void`
+
+A callback that gets called if unable to initialize the widget or select
+one of the address options provided by the widget.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `error?` | `Error` | The error object describing the failure. |
+
+#### Returns
+
+`void`
+
+___
+
+### onPaymentAuthorize
+
+▸ **onPaymentAuthorize**(): `void`
+
+A callback that gets called when a payment is successfully completed.
+
+#### Returns
+
+`void`

package/docs/interfaces/internal_.ApplePayPaymentInitializeOptions.md

@@ -0,0 +1,42 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / ApplePayPaymentInitializeOptions
+
+# Interface: ApplePayPaymentInitializeOptions
+
+[<internal>](../modules/internal_.md).ApplePayPaymentInitializeOptions
+
+A set of options that are required to initialize the Applepay payment method with:
+
+1) ApplePay:
+
+```js
+service.initializePayment({
+    methodId: 'applepay',
+    applepay: {
+        shippingLabel: 'Shipping',
+        subtotalLabel: 'Sub total',
+    }
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [shippingLabel](internal_.ApplePayPaymentInitializeOptions.md#shippinglabel)
+- [subtotalLabel](internal_.ApplePayPaymentInitializeOptions.md#subtotallabel)
+
+## Properties
+
+### shippingLabel
+
+• `Optional` **shippingLabel**: `string`
+
+Shipping label to be passed to apple sheet.
+
+___
+
+### subtotalLabel
+
+• `Optional` **subtotalLabel**: `string`
+
+Sub total label to be passed to apple sheet.

package/docs/interfaces/internal_.BankInstrument.md

@@ -0,0 +1,114 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BankInstrument
+
+# Interface: BankInstrument
+
+[<internal>](../modules/internal_.md).BankInstrument
+
+## Hierarchy
+
+- [`BaseAccountInstrument`](internal_.BaseAccountInstrument.md)
+
+  ↳ **`BankInstrument`**
+
+## Table of contents
+
+### Properties
+
+- [accountNumber](internal_.BankInstrument.md#accountnumber)
+- [bigpayToken](internal_.BankInstrument.md#bigpaytoken)
+- [defaultInstrument](internal_.BankInstrument.md#defaultinstrument)
+- [externalId](internal_.BankInstrument.md#externalid)
+- [iban](internal_.BankInstrument.md#iban)
+- [issuer](internal_.BankInstrument.md#issuer)
+- [method](internal_.BankInstrument.md#method)
+- [provider](internal_.BankInstrument.md#provider)
+- [trustedShippingAddress](internal_.BankInstrument.md#trustedshippingaddress)
+- [type](internal_.BankInstrument.md#type)
+
+## Properties
+
+### accountNumber
+
+• **accountNumber**: `string`
+
+___
+
+### bigpayToken
+
+• **bigpayToken**: `string`
+
+#### Inherited from
+
+[BaseAccountInstrument](internal_.BaseAccountInstrument.md).[bigpayToken](internal_.BaseAccountInstrument.md#bigpaytoken)
+
+___
+
+### defaultInstrument
+
+• **defaultInstrument**: `boolean`
+
+#### Inherited from
+
+[BaseAccountInstrument](internal_.BaseAccountInstrument.md).[defaultInstrument](internal_.BaseAccountInstrument.md#defaultinstrument)
+
+___
+
+### externalId
+
+• **externalId**: `string`
+
+#### Inherited from
+
+[BaseAccountInstrument](internal_.BaseAccountInstrument.md).[externalId](internal_.BaseAccountInstrument.md#externalid)
+
+___
+
+### iban
+
+• **iban**: `string`
+
+___
+
+### issuer
+
+• **issuer**: `string`
+
+___
+
+### method
+
+• **method**: `string`
+
+#### Overrides
+
+[BaseAccountInstrument](internal_.BaseAccountInstrument.md).[method](internal_.BaseAccountInstrument.md#method)
+
+___
+
+### provider
+
+• **provider**: `string`
+
+#### Inherited from
+
+[BaseAccountInstrument](internal_.BaseAccountInstrument.md).[provider](internal_.BaseAccountInstrument.md#provider)
+
+___
+
+### trustedShippingAddress
+
+• **trustedShippingAddress**: `boolean`
+
+#### Inherited from
+
+[BaseAccountInstrument](internal_.BaseAccountInstrument.md).[trustedShippingAddress](internal_.BaseAccountInstrument.md#trustedshippingaddress)
+
+___
+
+### type
+
+• **type**: ``"bank"``
+
+#### Overrides
+
+[BaseAccountInstrument](internal_.BaseAccountInstrument.md).[type](internal_.BaseAccountInstrument.md#type)

package/docs/interfaces/internal_.Banner.md

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

package/docs/interfaces/internal_.BaseAccountInstrument.md

@@ -0,0 +1,93 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BaseAccountInstrument
+
+# Interface: BaseAccountInstrument
+
+[<internal>](../modules/internal_.md).BaseAccountInstrument
+
+## Hierarchy
+
+- [`BaseInstrument`](internal_.BaseInstrument.md)
+
+  ↳ **`BaseAccountInstrument`**
+
+  ↳↳ [`PayPalInstrument`](internal_.PayPalInstrument.md)
+
+  ↳↳ [`BankInstrument`](internal_.BankInstrument.md)
+
+## Table of contents
+
+### Properties
+
+- [bigpayToken](internal_.BaseAccountInstrument.md#bigpaytoken)
+- [defaultInstrument](internal_.BaseAccountInstrument.md#defaultinstrument)
+- [externalId](internal_.BaseAccountInstrument.md#externalid)
+- [method](internal_.BaseAccountInstrument.md#method)
+- [provider](internal_.BaseAccountInstrument.md#provider)
+- [trustedShippingAddress](internal_.BaseAccountInstrument.md#trustedshippingaddress)
+- [type](internal_.BaseAccountInstrument.md#type)
+
+## Properties
+
+### bigpayToken
+
+• **bigpayToken**: `string`
+
+#### Inherited from
+
+[BaseInstrument](internal_.BaseInstrument.md).[bigpayToken](internal_.BaseInstrument.md#bigpaytoken)
+
+___
+
+### defaultInstrument
+
+• **defaultInstrument**: `boolean`
+
+#### Inherited from
+
+[BaseInstrument](internal_.BaseInstrument.md).[defaultInstrument](internal_.BaseInstrument.md#defaultinstrument)
+
+___
+
+### externalId
+
+• **externalId**: `string`
+
+___
+
+### method
+
+• **method**: `string`
+
+#### Overrides
+
+[BaseInstrument](internal_.BaseInstrument.md).[method](internal_.BaseInstrument.md#method)
+
+___
+
+### provider
+
+• **provider**: `string`
+
+#### Inherited from
+
+[BaseInstrument](internal_.BaseInstrument.md).[provider](internal_.BaseInstrument.md#provider)
+
+___
+
+### trustedShippingAddress
+
+• **trustedShippingAddress**: `boolean`
+
+#### Inherited from
+
+[BaseInstrument](internal_.BaseInstrument.md).[trustedShippingAddress](internal_.BaseInstrument.md#trustedshippingaddress)
+
+___
+
+### type
+
+• **type**: ``"account"`` \| ``"bank"``
+
+#### Overrides
+
+[BaseInstrument](internal_.BaseInstrument.md).[type](internal_.BaseInstrument.md#type)

package/docs/interfaces/internal_.BaseCustomerInitializeOptions.md

@@ -0,0 +1,237 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BaseCustomerInitializeOptions
+
+# Interface: BaseCustomerInitializeOptions
+
+[<internal>](../modules/internal_.md).BaseCustomerInitializeOptions
+
+A set of options that are required to initialize the customer step of the
+current checkout flow.
+
+Some payment methods have specific requirements for setting the customer
+details for checkout. For example, Amazon Pay requires the customer to sign in
+using their sign-in button. As a result, you may need to provide additional
+information in order to initialize the customer step of checkout.
+
+## Hierarchy
+
+- [`CustomerRequestOptions`](internal_.CustomerRequestOptions.md)
+
+  ↳ **`BaseCustomerInitializeOptions`**
+
+## Indexable
+
+▪ [key: `string`]: `unknown`
+
+## Table of contents
+
+### Properties
+
+- [amazon](internal_.BaseCustomerInitializeOptions.md#amazon)
+- [amazonpay](internal_.BaseCustomerInitializeOptions.md#amazonpay)
+- [bolt](internal_.BaseCustomerInitializeOptions.md#bolt)
+- [braintreevisacheckout](internal_.BaseCustomerInitializeOptions.md#braintreevisacheckout)
+- [chasepay](internal_.BaseCustomerInitializeOptions.md#chasepay)
+- [googlepayadyenv2](internal_.BaseCustomerInitializeOptions.md#googlepayadyenv2)
+- [googlepayadyenv3](internal_.BaseCustomerInitializeOptions.md#googlepayadyenv3)
+- [googlepayauthorizenet](internal_.BaseCustomerInitializeOptions.md#googlepayauthorizenet)
+- [googlepaybnz](internal_.BaseCustomerInitializeOptions.md#googlepaybnz)
+- [googlepaybraintree](internal_.BaseCustomerInitializeOptions.md#googlepaybraintree)
+- [googlepaycheckoutcom](internal_.BaseCustomerInitializeOptions.md#googlepaycheckoutcom)
+- [googlepaycybersourcev2](internal_.BaseCustomerInitializeOptions.md#googlepaycybersourcev2)
+- [googlepayorbital](internal_.BaseCustomerInitializeOptions.md#googlepayorbital)
+- [googlepaystripe](internal_.BaseCustomerInitializeOptions.md#googlepaystripe)
+- [googlepaystripeupe](internal_.BaseCustomerInitializeOptions.md#googlepaystripeupe)
+- [masterpass](internal_.BaseCustomerInitializeOptions.md#masterpass)
+- [methodId](internal_.BaseCustomerInitializeOptions.md#methodid)
+- [params](internal_.BaseCustomerInitializeOptions.md#params)
+- [stripeupe](internal_.BaseCustomerInitializeOptions.md#stripeupe)
+- [timeout](internal_.BaseCustomerInitializeOptions.md#timeout)
+
+## Properties
+
+### amazon
+
+• `Optional` **amazon**: [`AmazonPayCustomerInitializeOptions`](internal_.AmazonPayCustomerInitializeOptions.md)
+
+The options that are required to initialize the customer step of checkout
+when using Amazon Pay.
+
+___
+
+### amazonpay
+
+• `Optional` **amazonpay**: [`AmazonPayV2CustomerInitializeOptions`](internal_.AmazonPayV2CustomerInitializeOptions.md)
+
+The options that are required to initialize the customer step of checkout
+when using AmazonPayV2.
+
+___
+
+### bolt
+
+• `Optional` **bolt**: [`BoltCustomerInitializeOptions`](internal_.BoltCustomerInitializeOptions.md)
+
+The options that are required to initialize the customer step of checkout
+when using Bolt.
+
+___
+
+### braintreevisacheckout
+
+• `Optional` **braintreevisacheckout**: [`BraintreeVisaCheckoutCustomerInitializeOptions`](internal_.BraintreeVisaCheckoutCustomerInitializeOptions.md)
+
+The options that are required to initialize the customer step of checkout
+when using Visa Checkout provided by Braintree.
+
+___
+
+### chasepay
+
+• `Optional` **chasepay**: [`ChasePayCustomerInitializeOptions`](internal_.ChasePayCustomerInitializeOptions.md)
+
+The options that are required to initialize the Chasepay payment method.
+They can be omitted unless you need to support Chasepay.
+
+___
+
+### googlepayadyenv2
+
+• `Optional` **googlepayadyenv2**: [`GooglePayCustomerInitializeOptions`](internal_.GooglePayCustomerInitializeOptions.md)
+
+The options that are required to initialize the GooglePay payment method.
+They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepayadyenv3
+
+• `Optional` **googlepayadyenv3**: [`GooglePayCustomerInitializeOptions`](internal_.GooglePayCustomerInitializeOptions.md)
+
+The options that are required to initialize the GooglePay payment method.
+They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepayauthorizenet
+
+• `Optional` **googlepayauthorizenet**: [`GooglePayCustomerInitializeOptions`](internal_.GooglePayCustomerInitializeOptions.md)
+
+The options that are required to initialize the GooglePay payment method.
+They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepaybnz
+
+• `Optional` **googlepaybnz**: [`GooglePayCustomerInitializeOptions`](internal_.GooglePayCustomerInitializeOptions.md)
+
+The options that are required to initialize the GooglePay payment method.
+They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepaybraintree
+
+• `Optional` **googlepaybraintree**: [`GooglePayCustomerInitializeOptions`](internal_.GooglePayCustomerInitializeOptions.md)
+
+The options that are required to initialize the GooglePay payment method.
+They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepaycheckoutcom
+
+• `Optional` **googlepaycheckoutcom**: [`GooglePayCustomerInitializeOptions`](internal_.GooglePayCustomerInitializeOptions.md)
+
+The options that are required to initialize the GooglePay payment method.
+They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepaycybersourcev2
+
+• `Optional` **googlepaycybersourcev2**: [`GooglePayCustomerInitializeOptions`](internal_.GooglePayCustomerInitializeOptions.md)
+
+The options that are required to initialize the GooglePay payment method.
+They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepayorbital
+
+• `Optional` **googlepayorbital**: [`GooglePayCustomerInitializeOptions`](internal_.GooglePayCustomerInitializeOptions.md)
+
+The options that are required to initialize the GooglePay payment method.
+They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepaystripe
+
+• `Optional` **googlepaystripe**: [`GooglePayCustomerInitializeOptions`](internal_.GooglePayCustomerInitializeOptions.md)
+
+The options that are required to initialize the GooglePay payment method.
+They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepaystripeupe
+
+• `Optional` **googlepaystripeupe**: [`GooglePayCustomerInitializeOptions`](internal_.GooglePayCustomerInitializeOptions.md)
+
+The options that are required to initialize the GooglePay payment method.
+They can be omitted unless you need to support GooglePay.
+
+___
+
+### masterpass
+
+• `Optional` **masterpass**: [`MasterpassCustomerInitializeOptions`](internal_.MasterpassCustomerInitializeOptions.md)
+
+The options that are required to initialize the Masterpass payment method.
+They can be omitted unless you need to support Masterpass.
+
+___
+
+### methodId
+
+• `Optional` **methodId**: `string`
+
+#### Inherited from
+
+[CustomerRequestOptions](internal_.CustomerRequestOptions.md).[methodId](internal_.CustomerRequestOptions.md#methodid)
+
+___
+
+### params
+
+• `Optional` **params**: `Object`
+
+The parameters of the request, if required.
+
+#### Inherited from
+
+[CustomerRequestOptions](internal_.CustomerRequestOptions.md).[params](internal_.CustomerRequestOptions.md#params)
+
+___
+
+### stripeupe
+
+• `Optional` **stripeupe**: [`StripeUPECustomerInitializeOptions`](internal_.StripeUPECustomerInitializeOptions.md)
+
+The options that are required to initialize the Customer Stripe Upe payment method.
+They can be omitted unless you need to support Customer Stripe Upe.
+
+___
+
+### 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
+
+[CustomerRequestOptions](internal_.CustomerRequestOptions.md).[timeout](internal_.CustomerRequestOptions.md#timeout)