@bigcommerce/checkout-sdk 1.436.0 → 1.436.1

package/docs/interfaces/BaseCheckoutButtonInitializeOptions.md

@@ -1,237 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BaseCheckoutButtonInitializeOptions
-
-# Interface: BaseCheckoutButtonInitializeOptions
-
-## Hierarchy
-
-- [`CheckoutButtonOptions`](CheckoutButtonOptions.md)
-
-  ↳ **`BaseCheckoutButtonInitializeOptions`**
-
-## Indexable
-
-▪ [key: `string`]: `unknown`
-
-## Table of contents
-
-### Properties
-
-- [amazonpay](BaseCheckoutButtonInitializeOptions.md#amazonpay)
-- [braintreepaypal](BaseCheckoutButtonInitializeOptions.md#braintreepaypal)
-- [braintreepaypalcredit](BaseCheckoutButtonInitializeOptions.md#braintreepaypalcredit)
-- [braintreevenmo](BaseCheckoutButtonInitializeOptions.md#braintreevenmo)
-- [containerId](BaseCheckoutButtonInitializeOptions.md#containerid)
-- [currencyCode](BaseCheckoutButtonInitializeOptions.md#currencycode)
-- [googlepayadyenv2](BaseCheckoutButtonInitializeOptions.md#googlepayadyenv2)
-- [googlepayadyenv3](BaseCheckoutButtonInitializeOptions.md#googlepayadyenv3)
-- [googlepayauthorizenet](BaseCheckoutButtonInitializeOptions.md#googlepayauthorizenet)
-- [googlepaybnz](BaseCheckoutButtonInitializeOptions.md#googlepaybnz)
-- [googlepaybraintree](BaseCheckoutButtonInitializeOptions.md#googlepaybraintree)
-- [googlepaycheckoutcom](BaseCheckoutButtonInitializeOptions.md#googlepaycheckoutcom)
-- [googlepaycybersourcev2](BaseCheckoutButtonInitializeOptions.md#googlepaycybersourcev2)
-- [googlepayorbital](BaseCheckoutButtonInitializeOptions.md#googlepayorbital)
-- [googlepaystripe](BaseCheckoutButtonInitializeOptions.md#googlepaystripe)
-- [googlepaystripeupe](BaseCheckoutButtonInitializeOptions.md#googlepaystripeupe)
-- [googlepayworldpayaccess](BaseCheckoutButtonInitializeOptions.md#googlepayworldpayaccess)
-- [methodId](BaseCheckoutButtonInitializeOptions.md#methodid)
-- [params](BaseCheckoutButtonInitializeOptions.md#params)
-- [paypal](BaseCheckoutButtonInitializeOptions.md#paypal)
-- [timeout](BaseCheckoutButtonInitializeOptions.md#timeout)
-
-## Properties
-
-### amazonpay
-
-• `Optional` **amazonpay**: [`AmazonPayV2ButtonParams`](AmazonPayV2ButtonParams.md) \| [`AmazonPayV2NewButtonParams`](AmazonPayV2NewButtonParams.md) \| [`WithBuyNowFeature`](WithBuyNowFeature.md)
-
-The options that are required to facilitate AmazonPayV2. They can be
-omitted unless you need to support AmazonPayV2.
-
-___
-
-### braintreepaypal
-
-• `Optional` **braintreepaypal**: [`BraintreePaypalButtonInitializeOptions`](BraintreePaypalButtonInitializeOptions.md)
-
-The options that are required to facilitate Braintree PayPal. They can be
-omitted unless you need to support Braintree PayPal.
-
-___
-
-### braintreepaypalcredit
-
-• `Optional` **braintreepaypalcredit**: [`BraintreePaypalCreditButtonInitializeOptions`](BraintreePaypalCreditButtonInitializeOptions.md)
-
-The options that are required to facilitate Braintree Credit. They can be
-omitted unless you need to support Braintree Credit.
-
-___
-
-### braintreevenmo
-
-• `Optional` **braintreevenmo**: [`BraintreeVenmoButtonInitializeOptions`](BraintreeVenmoButtonInitializeOptions.md)
-
-The options that are required to facilitate Braintree Venmo. They can be
-omitted unless you need to support Braintree Venmo.
-
-___
-
-### containerId
-
-• **containerId**: `string`
-
-The ID of a container which the checkout button should be inserted.
-
-___
-
-### currencyCode
-
-• `Optional` **currencyCode**: `string`
-
-The option that is required to load payment method configuration for provided currency code in Buy Now flow.
-
-___
-
-### googlepayadyenv2
-
-• `Optional` **googlepayadyenv2**: [`GooglePayButtonInitializeOptions`](GooglePayButtonInitializeOptions.md)
-
-The options that are required to initialize the GooglePay payment method.
-They can be omitted unless you need to support adyenv2 GooglePay.
-
-___
-
-### googlepayadyenv3
-
-• `Optional` **googlepayadyenv3**: [`GooglePayButtonInitializeOptions`](GooglePayButtonInitializeOptions.md)
-
-The options that are required to initialize the GooglePay payment method.
-They can be omitted unless you need to support adyenv2 GooglePay.
-
-___
-
-### googlepayauthorizenet
-
-• `Optional` **googlepayauthorizenet**: [`GooglePayButtonInitializeOptions`](GooglePayButtonInitializeOptions.md)
-
-The options that are required to facilitate Authorize.Net GooglePay.
-They can be omitted unless you need to support Authorize.Net GooglePay.
-
-___
-
-### googlepaybnz
-
-• `Optional` **googlepaybnz**: [`GooglePayButtonInitializeOptions`](GooglePayButtonInitializeOptions.md)
-
-The options that are required to facilitate BNZ GooglePay. They can be
-omitted unless you need to support BNZ GooglePay.
-
-___
-
-### googlepaybraintree
-
-• `Optional` **googlepaybraintree**: [`GooglePayButtonInitializeOptions`](GooglePayButtonInitializeOptions.md)
-
-The options that are required to facilitate Braintree GooglePay. They can be
-omitted unless you need to support Braintree GooglePay.
-
-___
-
-### googlepaycheckoutcom
-
-• `Optional` **googlepaycheckoutcom**: [`GooglePayButtonInitializeOptions`](GooglePayButtonInitializeOptions.md)
-
-The options that are required to facilitate Checkout.com GooglePay. They can be
-omitted unless you need to support Checkout.com GooglePay.
-
-___
-
-### googlepaycybersourcev2
-
-• `Optional` **googlepaycybersourcev2**: [`GooglePayButtonInitializeOptions`](GooglePayButtonInitializeOptions.md)
-
-The options that are required to facilitate CybersourceV2 GooglePay. They can be
-omitted unless you need to support CybersourceV2 GooglePay.
-
-___
-
-### googlepayorbital
-
-• `Optional` **googlepayorbital**: [`GooglePayButtonInitializeOptions`](GooglePayButtonInitializeOptions.md)
-
-The options that are required to facilitate Orbital GooglePay. They can be
-omitted unless you need to support Orbital GooglePay.
-
-___
-
-### googlepaystripe
-
-• `Optional` **googlepaystripe**: [`GooglePayButtonInitializeOptions`](GooglePayButtonInitializeOptions.md)
-
-The options that are required to facilitate Stripe GooglePay. They can be
-omitted unless you need to support Stripe GooglePay.
-
-___
-
-### googlepaystripeupe
-
-• `Optional` **googlepaystripeupe**: [`GooglePayButtonInitializeOptions`](GooglePayButtonInitializeOptions.md)
-
-The options that are required to facilitate Stripe GooglePay. They can be
-omitted unless you need to support Stripe GooglePay.
-
-___
-
-### googlepayworldpayaccess
-
-• `Optional` **googlepayworldpayaccess**: [`GooglePayButtonInitializeOptions`](GooglePayButtonInitializeOptions.md)
-
-The options that are required to facilitate Worldpay GooglePay. They can be
-omitted unless you need to support Worldpay GooglePay.
-
-___
-
-### methodId
-
-• **methodId**: [`CheckoutButtonMethodType`](../enums/CheckoutButtonMethodType.md)
-
-The identifier of the payment method.
-
-#### Inherited from
-
-[CheckoutButtonOptions](CheckoutButtonOptions.md).[methodId](CheckoutButtonOptions.md#methodid)
-
-___
-
-### params
-
-• `Optional` **params**: `Object`
-
-The parameters of the request, if required.
-
-#### Inherited from
-
-[CheckoutButtonOptions](CheckoutButtonOptions.md).[params](CheckoutButtonOptions.md#params)
-
-___
-
-### paypal
-
-• `Optional` **paypal**: [`PaypalButtonInitializeOptions`](PaypalButtonInitializeOptions.md)
-
-The options that are required to facilitate PayPal. They can be omitted
-unless you need to support Paypal.
-
-___
-
-### 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
-
-[CheckoutButtonOptions](CheckoutButtonOptions.md).[timeout](CheckoutButtonOptions.md#timeout)

package/docs/interfaces/BaseCustomerInitializeOptions.md

@@ -1,235 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BaseCustomerInitializeOptions
-
-# Interface: 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`](CustomerRequestOptions.md)
-
-  ↳ **`BaseCustomerInitializeOptions`**
-
-## Indexable
-
-▪ [key: `string`]: `unknown`
-
-## Table of contents
-
-### Properties
-
-- [amazonpay](BaseCustomerInitializeOptions.md#amazonpay)
-- [braintreepaypalcredit](BaseCustomerInitializeOptions.md#braintreepaypalcredit)
-- [braintreevisacheckout](BaseCustomerInitializeOptions.md#braintreevisacheckout)
-- [chasepay](BaseCustomerInitializeOptions.md#chasepay)
-- [googlepayadyenv2](BaseCustomerInitializeOptions.md#googlepayadyenv2)
-- [googlepayadyenv3](BaseCustomerInitializeOptions.md#googlepayadyenv3)
-- [googlepayauthorizenet](BaseCustomerInitializeOptions.md#googlepayauthorizenet)
-- [googlepaybnz](BaseCustomerInitializeOptions.md#googlepaybnz)
-- [googlepaybraintree](BaseCustomerInitializeOptions.md#googlepaybraintree)
-- [googlepaycheckoutcom](BaseCustomerInitializeOptions.md#googlepaycheckoutcom)
-- [googlepaycybersourcev2](BaseCustomerInitializeOptions.md#googlepaycybersourcev2)
-- [googlepayorbital](BaseCustomerInitializeOptions.md#googlepayorbital)
-- [googlepaystripe](BaseCustomerInitializeOptions.md#googlepaystripe)
-- [googlepaystripeupe](BaseCustomerInitializeOptions.md#googlepaystripeupe)
-- [googlepayworldpayaccess](BaseCustomerInitializeOptions.md#googlepayworldpayaccess)
-- [masterpass](BaseCustomerInitializeOptions.md#masterpass)
-- [methodId](BaseCustomerInitializeOptions.md#methodid)
-- [params](BaseCustomerInitializeOptions.md#params)
-- [stripeupe](BaseCustomerInitializeOptions.md#stripeupe)
-- [timeout](BaseCustomerInitializeOptions.md#timeout)
-
-## Properties
-
-### amazonpay
-
-• `Optional` **amazonpay**: [`AmazonPayV2CustomerInitializeOptions`](AmazonPayV2CustomerInitializeOptions.md)
-
-The options that are required to initialize the customer step of checkout
-when using AmazonPayV2.
-
-___
-
-### braintreepaypalcredit
-
-• `Optional` **braintreepaypalcredit**: [`BraintreePaypalCreditCustomerInitializeOptions`](BraintreePaypalCreditCustomerInitializeOptions.md)
-
-The options that are required to facilitate Braintree Credit. They can be
-omitted unless you need to support Braintree Credit.
-
-___
-
-### braintreevisacheckout
-
-• `Optional` **braintreevisacheckout**: [`BraintreeVisaCheckoutCustomerInitializeOptions`](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`](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`](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`](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`](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`](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`](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`](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`](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`](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`](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`](GooglePayCustomerInitializeOptions.md)
-
-The options that are required to initialize the GooglePay payment method.
-They can be omitted unless you need to support GooglePay.
-
-___
-
-### googlepayworldpayaccess
-
-• `Optional` **googlepayworldpayaccess**: [`GooglePayCustomerInitializeOptions`](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`](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](CustomerRequestOptions.md).[methodId](CustomerRequestOptions.md#methodid)
-
-___
-
-### params
-
-• `Optional` **params**: `Object`
-
-The parameters of the request, if required.
-
-#### Inherited from
-
-[CustomerRequestOptions](CustomerRequestOptions.md).[params](CustomerRequestOptions.md#params)
-
-___
-
-### stripeupe
-
-• `Optional` **stripeupe**: [`StripeUPECustomerInitializeOptions`](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](CustomerRequestOptions.md).[timeout](CustomerRequestOptions.md#timeout)

package/docs/interfaces/BaseElementOptions.md

@@ -1,26 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BaseElementOptions
-
-# Interface: BaseElementOptions
-
-## Table of contents
-
-### Properties
-
-- [classes](BaseElementOptions.md#classes)
-- [disabledPaymentMethods](BaseElementOptions.md#disabledpaymentmethods)
-
-## Properties
-
-### classes
-
-• `Optional` **classes**: [`DigitalRiverElementClasses`](DigitalRiverElementClasses.md)
-
-Set custom class names on the container DOM element when the Digital River element is in a particular state.
-
-___
-
-### disabledPaymentMethods
-
-• `Optional` **disabledPaymentMethods**: `string`[]
-
-Use disabledPaymentMethods to disable specific payment methods.

package/docs/interfaces/BaseElementOptions_2.md

@@ -1,48 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BaseElementOptions_2
-
-# Interface: BaseElementOptions\_2
-
-## Hierarchy
-
-- **`BaseElementOptions_2`**
-
-  ↳ [`BaseIndividualElementOptions`](BaseIndividualElementOptions.md)
-
-  ↳ [`CardElementOptions`](CardElementOptions.md)
-
-  ↳ [`IbanElementOptions`](IbanElementOptions.md)
-
-  ↳ [`IdealElementOptions`](IdealElementOptions.md)
-
-## Table of contents
-
-### Properties
-
-- [classes](BaseElementOptions_2.md#classes)
-- [disabled](BaseElementOptions_2.md#disabled)
-- [style](BaseElementOptions_2.md#style)
-
-## Properties
-
-### classes
-
-• `Optional` **classes**: [`StripeElementClasses`](StripeElementClasses.md)
-
-Set custom class names on the container DOM element when the Stripe element is in a particular state.
-
-___
-
-### disabled
-
-• `Optional` **disabled**: `boolean`
-
-Applies a disabled state to the Element such that user input is not accepted. Default is false.
-
-___
-
-### style
-
-• `Optional` **style**: [`StripeElementStyle`](StripeElementStyle.md)
-
-Customize the appearance of an element using CSS properties passed in a [Style](https://stripe.com/docs/js/appendix/style) object,
-which consists of CSS properties nested under objects for each variant.

package/docs/interfaces/BaseIndividualElementOptions.md

@@ -1,67 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BaseIndividualElementOptions
-
-# Interface: BaseIndividualElementOptions
-
-## Hierarchy
-
-- [`BaseElementOptions_2`](BaseElementOptions_2.md)
-
-  ↳ **`BaseIndividualElementOptions`**
-
-  ↳↳ [`CardCvcElementOptions`](CardCvcElementOptions.md)
-
-  ↳↳ [`CardExpiryElementOptions`](CardExpiryElementOptions.md)
-
-  ↳↳ [`CardNumberElementOptions`](CardNumberElementOptions.md)
-
-## Table of contents
-
-### Properties
-
-- [classes](BaseIndividualElementOptions.md#classes)
-- [containerId](BaseIndividualElementOptions.md#containerid)
-- [disabled](BaseIndividualElementOptions.md#disabled)
-- [style](BaseIndividualElementOptions.md#style)
-
-## Properties
-
-### classes
-
-• `Optional` **classes**: [`StripeElementClasses`](StripeElementClasses.md)
-
-Set custom class names on the container DOM element when the Stripe element is in a particular state.
-
-#### Inherited from
-
-[BaseElementOptions_2](BaseElementOptions_2.md).[classes](BaseElementOptions_2.md#classes)
-
-___
-
-### containerId
-
-• **containerId**: `string`
-
-___
-
-### disabled
-
-• `Optional` **disabled**: `boolean`
-
-Applies a disabled state to the Element such that user input is not accepted. Default is false.
-
-#### Inherited from
-
-[BaseElementOptions_2](BaseElementOptions_2.md).[disabled](BaseElementOptions_2.md#disabled)
-
-___
-
-### style
-
-• `Optional` **style**: [`StripeElementStyle`](StripeElementStyle.md)
-
-Customize the appearance of an element using CSS properties passed in a [Style](https://stripe.com/docs/js/appendix/style) object,
-which consists of CSS properties nested under objects for each variant.
-
-#### Inherited from
-
-[BaseElementOptions_2](BaseElementOptions_2.md).[style](BaseElementOptions_2.md#style)

package/docs/interfaces/BaseInstrument.md

@@ -1,58 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BaseInstrument
-
-# Interface: BaseInstrument
-
-## Hierarchy
-
-- **`BaseInstrument`**
-
-  ↳ [`BaseAccountInstrument`](BaseAccountInstrument.md)
-
-  ↳ [`CardInstrument`](CardInstrument.md)
-
-## Table of contents
-
-### Properties
-
-- [bigpayToken](BaseInstrument.md#bigpaytoken)
-- [defaultInstrument](BaseInstrument.md#defaultinstrument)
-- [method](BaseInstrument.md#method)
-- [provider](BaseInstrument.md#provider)
-- [trustedShippingAddress](BaseInstrument.md#trustedshippingaddress)
-- [type](BaseInstrument.md#type)
-
-## Properties
-
-### bigpayToken
-
-• **bigpayToken**: `string`
-
-___
-
-### defaultInstrument
-
-• **defaultInstrument**: `boolean`
-
-___
-
-### method
-
-• **method**: `string`
-
-___
-
-### provider
-
-• **provider**: `string`
-
-___
-
-### trustedShippingAddress
-
-• **trustedShippingAddress**: `boolean`
-
-___
-
-### type
-
-• **type**: `string`