@bigcommerce/checkout-sdk 1.308.1 → 1.308.2

package/docs/interfaces/internal_.BaseElementOptions.md

@@ -0,0 +1,28 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BaseElementOptions
+
+# Interface: BaseElementOptions
+
+[<internal>](../modules/internal_.md).BaseElementOptions
+
+## Table of contents
+
+### Properties
+
+- [classes](internal_.BaseElementOptions.md#classes)
+- [disabledPaymentMethods](internal_.BaseElementOptions.md#disabledpaymentmethods)
+
+## Properties
+
+### classes
+
+• `Optional` **classes**: [`DigitalRiverElementClasses`](internal_.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/internal_.BaseElementOptions_2.md

@@ -0,0 +1,50 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BaseElementOptions\_2
+
+# Interface: BaseElementOptions\_2
+
+[<internal>](../modules/internal_.md).BaseElementOptions_2
+
+## Hierarchy
+
+- **`BaseElementOptions_2`**
+
+  ↳ [`CardElementOptions`](internal_.CardElementOptions.md)
+
+  ↳ [`IdealElementOptions`](internal_.IdealElementOptions.md)
+
+  ↳ [`IbanElementOptions`](internal_.IbanElementOptions.md)
+
+  ↳ [`BaseIndividualElementOptions`](internal_.BaseIndividualElementOptions.md)
+
+## Table of contents
+
+### Properties
+
+- [classes](internal_.BaseElementOptions_2.md#classes)
+- [disabled](internal_.BaseElementOptions_2.md#disabled)
+- [style](internal_.BaseElementOptions_2.md#style)
+
+## Properties
+
+### classes
+
+• `Optional` **classes**: [`StripeElementClasses`](internal_.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`](internal_.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/internal_.BaseIndividualElementOptions.md

@@ -0,0 +1,69 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BaseIndividualElementOptions
+
+# Interface: BaseIndividualElementOptions
+
+[<internal>](../modules/internal_.md).BaseIndividualElementOptions
+
+## Hierarchy
+
+- [`BaseElementOptions_2`](internal_.BaseElementOptions_2.md)
+
+  ↳ **`BaseIndividualElementOptions`**
+
+  ↳↳ [`CardExpiryElementOptions`](internal_.CardExpiryElementOptions.md)
+
+  ↳↳ [`CardNumberElementOptions`](internal_.CardNumberElementOptions.md)
+
+  ↳↳ [`CardCvcElementOptions`](internal_.CardCvcElementOptions.md)
+
+## Table of contents
+
+### Properties
+
+- [classes](internal_.BaseIndividualElementOptions.md#classes)
+- [containerId](internal_.BaseIndividualElementOptions.md#containerid)
+- [disabled](internal_.BaseIndividualElementOptions.md#disabled)
+- [style](internal_.BaseIndividualElementOptions.md#style)
+
+## Properties
+
+### classes
+
+• `Optional` **classes**: [`StripeElementClasses`](internal_.StripeElementClasses.md)
+
+Set custom class names on the container DOM element when the Stripe element is in a particular state.
+
+#### Inherited from
+
+[BaseElementOptions_2](internal_.BaseElementOptions_2.md).[classes](internal_.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](internal_.BaseElementOptions_2.md).[disabled](internal_.BaseElementOptions_2.md#disabled)
+
+___
+
+### style
+
+• `Optional` **style**: [`StripeElementStyle`](internal_.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](internal_.BaseElementOptions_2.md).[style](internal_.BaseElementOptions_2.md#style)

package/docs/interfaces/internal_.BaseInstrument.md

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

package/docs/interfaces/internal_.BasePaymentInitializeOptions.md

@@ -0,0 +1,376 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BasePaymentInitializeOptions
+
+# Interface: BasePaymentInitializeOptions
+
+[<internal>](../modules/internal_.md).BasePaymentInitializeOptions
+
+A set of options that are required to initialize the payment step of the
+current checkout flow.
+
+## Hierarchy
+
+- [`PaymentRequestOptions`](internal_.PaymentRequestOptions.md)
+
+  ↳ **`BasePaymentInitializeOptions`**
+
+## Table of contents
+
+### Properties
+
+- [amazon](internal_.BasePaymentInitializeOptions.md#amazon)
+- [amazonpay](internal_.BasePaymentInitializeOptions.md#amazonpay)
+- [bluesnapv2](internal_.BasePaymentInitializeOptions.md#bluesnapv2)
+- [bolt](internal_.BasePaymentInitializeOptions.md#bolt)
+- [braintree](internal_.BasePaymentInitializeOptions.md#braintree)
+- [braintreevisacheckout](internal_.BasePaymentInitializeOptions.md#braintreevisacheckout)
+- [chasepay](internal_.BasePaymentInitializeOptions.md#chasepay)
+- [digitalriver](internal_.BasePaymentInitializeOptions.md#digitalriver)
+- [gatewayId](internal_.BasePaymentInitializeOptions.md#gatewayid)
+- [googlepayadyenv2](internal_.BasePaymentInitializeOptions.md#googlepayadyenv2)
+- [googlepayadyenv3](internal_.BasePaymentInitializeOptions.md#googlepayadyenv3)
+- [googlepayauthorizenet](internal_.BasePaymentInitializeOptions.md#googlepayauthorizenet)
+- [googlepaybnz](internal_.BasePaymentInitializeOptions.md#googlepaybnz)
+- [googlepaybraintree](internal_.BasePaymentInitializeOptions.md#googlepaybraintree)
+- [googlepaycheckoutcom](internal_.BasePaymentInitializeOptions.md#googlepaycheckoutcom)
+- [googlepaycybersourcev2](internal_.BasePaymentInitializeOptions.md#googlepaycybersourcev2)
+- [googlepayorbital](internal_.BasePaymentInitializeOptions.md#googlepayorbital)
+- [googlepaystripe](internal_.BasePaymentInitializeOptions.md#googlepaystripe)
+- [googlepaystripeupe](internal_.BasePaymentInitializeOptions.md#googlepaystripeupe)
+- [klarna](internal_.BasePaymentInitializeOptions.md#klarna)
+- [klarnav2](internal_.BasePaymentInitializeOptions.md#klarnav2)
+- [masterpass](internal_.BasePaymentInitializeOptions.md#masterpass)
+- [methodId](internal_.BasePaymentInitializeOptions.md#methodid)
+- [mollie](internal_.BasePaymentInitializeOptions.md#mollie)
+- [moneris](internal_.BasePaymentInitializeOptions.md#moneris)
+- [opy](internal_.BasePaymentInitializeOptions.md#opy)
+- [params](internal_.BasePaymentInitializeOptions.md#params)
+- [paypalcommerce](internal_.BasePaymentInitializeOptions.md#paypalcommerce)
+- [paypalexpress](internal_.BasePaymentInitializeOptions.md#paypalexpress)
+- [square](internal_.BasePaymentInitializeOptions.md#square)
+- [stripeupe](internal_.BasePaymentInitializeOptions.md#stripeupe)
+- [stripev3](internal_.BasePaymentInitializeOptions.md#stripev3)
+- [timeout](internal_.BasePaymentInitializeOptions.md#timeout)
+- [worldpay](internal_.BasePaymentInitializeOptions.md#worldpay)
+
+## Properties
+
+### amazon
+
+• `Optional` **amazon**: [`AmazonPayPaymentInitializeOptions`](internal_.AmazonPayPaymentInitializeOptions.md)
+
+The options that are required to initialize the Amazon Pay payment
+method. They can be omitted unless you need to support AmazonPay.
+
+___
+
+### amazonpay
+
+• `Optional` **amazonpay**: [`AmazonPayV2PaymentInitializeOptions`](internal_.AmazonPayV2PaymentInitializeOptions.md)
+
+The options that are required to initialize the AmazonPayV2 payment
+method. They can be omitted unless you need to support AmazonPayV2.
+
+___
+
+### bluesnapv2
+
+• `Optional` **bluesnapv2**: [`BlueSnapV2PaymentInitializeOptions`](internal_.BlueSnapV2PaymentInitializeOptions.md)
+
+The options that are required to initialize the BlueSnapV2 payment method.
+They can be omitted unless you need to support BlueSnapV2.
+
+___
+
+### bolt
+
+• `Optional` **bolt**: [`BoltPaymentInitializeOptions`](internal_.BoltPaymentInitializeOptions.md)
+
+The options that allow Bolt to load the client script and handle the checkout.
+They can be omitted if Bolt's full checkout take over is intended.
+
+___
+
+### braintree
+
+• `Optional` **braintree**: [`BraintreePaymentInitializeOptions`](internal_.BraintreePaymentInitializeOptions.md)
+
+The options that are required to initialize the Braintree payment method.
+They can be omitted unless you need to support Braintree.
+
+___
+
+### braintreevisacheckout
+
+• `Optional` **braintreevisacheckout**: [`BraintreeVisaCheckoutPaymentInitializeOptions`](internal_.BraintreeVisaCheckoutPaymentInitializeOptions.md)
+
+The options that are required to initialize the Visa Checkout payment
+method provided by Braintree. They can be omitted unless you need to
+support Visa Checkout.
+
+___
+
+### chasepay
+
+• `Optional` **chasepay**: [`ChasePayInitializeOptions`](internal_.ChasePayInitializeOptions.md)
+
+The options that are required to initialize the Chasepay payment method.
+They can be omitted unless you need to support Chasepay.
+
+___
+
+### digitalriver
+
+• `Optional` **digitalriver**: [`DigitalRiverPaymentInitializeOptions`](internal_.DigitalRiverPaymentInitializeOptions.md)
+
+The options that are required to initialize the Digital River payment method.
+They can be omitted unless you need to support Digital River.
+
+___
+
+### gatewayId
+
+• `Optional` **gatewayId**: `string`
+
+The identifier of the payment provider providing the payment method. This
+option is only required if the provider offers multiple payment options.
+i.e.: Adyen and Klarna.
+
+#### Inherited from
+
+[PaymentRequestOptions](internal_.PaymentRequestOptions.md).[gatewayId](internal_.PaymentRequestOptions.md#gatewayid)
+
+___
+
+### googlepayadyenv2
+
+• `Optional` **googlepayadyenv2**: [`GooglePayPaymentInitializeOptions`](internal_.GooglePayPaymentInitializeOptions.md)
+
+The options that are required to initialize the GooglePay Authorize.Net
+payment method. They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepayadyenv3
+
+• `Optional` **googlepayadyenv3**: [`GooglePayPaymentInitializeOptions`](internal_.GooglePayPaymentInitializeOptions.md)
+
+The options that are required to initialize the GooglePay Authorize.Net
+payment method. They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepayauthorizenet
+
+• `Optional` **googlepayauthorizenet**: [`GooglePayPaymentInitializeOptions`](internal_.GooglePayPaymentInitializeOptions.md)
+
+The options that are required to initialize the GooglePay Authorize.Net
+payment method. They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepaybnz
+
+• `Optional` **googlepaybnz**: [`GooglePayPaymentInitializeOptions`](internal_.GooglePayPaymentInitializeOptions.md)
+
+The options that are required to initialize the GooglePay Authorize.Net
+payment method. They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepaybraintree
+
+• `Optional` **googlepaybraintree**: [`GooglePayPaymentInitializeOptions`](internal_.GooglePayPaymentInitializeOptions.md)
+
+The options that are required to initialize the GooglePay Braintree payment method.
+They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepaycheckoutcom
+
+• `Optional` **googlepaycheckoutcom**: [`GooglePayPaymentInitializeOptions`](internal_.GooglePayPaymentInitializeOptions.md)
+
+The options that are required to initialize the GooglePay Checkout.com payment method.
+They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepaycybersourcev2
+
+• `Optional` **googlepaycybersourcev2**: [`GooglePayPaymentInitializeOptions`](internal_.GooglePayPaymentInitializeOptions.md)
+
+The options that are required to initialize the GooglePay CybersourceV2 payment method.
+They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepayorbital
+
+• `Optional` **googlepayorbital**: [`GooglePayPaymentInitializeOptions`](internal_.GooglePayPaymentInitializeOptions.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**: [`GooglePayPaymentInitializeOptions`](internal_.GooglePayPaymentInitializeOptions.md)
+
+The options that are required to initialize the GooglePay Stripe payment method.
+They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepaystripeupe
+
+• `Optional` **googlepaystripeupe**: [`GooglePayPaymentInitializeOptions`](internal_.GooglePayPaymentInitializeOptions.md)
+
+The options that are required to initialize the GooglePay Stripe payment method.
+They can be omitted unless you need to support GooglePay.
+
+___
+
+### klarna
+
+• `Optional` **klarna**: [`KlarnaPaymentInitializeOptions`](internal_.KlarnaPaymentInitializeOptions.md)
+
+The options that are required to initialize the Klarna payment method.
+They can be omitted unless you need to support Klarna.
+
+___
+
+### klarnav2
+
+• `Optional` **klarnav2**: [`KlarnaV2PaymentInitializeOptions`](internal_.KlarnaV2PaymentInitializeOptions.md)
+
+The options that are required to initialize the KlarnaV2 payment method.
+They can be omitted unless you need to support KlarnaV2.
+
+___
+
+### masterpass
+
+• `Optional` **masterpass**: [`MasterpassPaymentInitializeOptions`](internal_.MasterpassPaymentInitializeOptions.md)
+
+The options that are required to initialize the Masterpass payment method.
+They can be omitted unless you need to support Masterpass.
+
+___
+
+### methodId
+
+• **methodId**: `string`
+
+The identifier of the payment method.
+
+#### Inherited from
+
+[PaymentRequestOptions](internal_.PaymentRequestOptions.md).[methodId](internal_.PaymentRequestOptions.md#methodid)
+
+___
+
+### mollie
+
+• `Optional` **mollie**: [`MolliePaymentInitializeOptions`](internal_.MolliePaymentInitializeOptions.md)
+
+The options that are required to initialize the Mollie payment method.
+They can be omitted unless you need to support Mollie.
+
+___
+
+### moneris
+
+• `Optional` **moneris**: [`MonerisPaymentInitializeOptions`](internal_.MonerisPaymentInitializeOptions.md)
+
+The options that are required to initialize the Moneris payment method.
+They can be omitted unless you need to support Moneris.
+
+___
+
+### opy
+
+• `Optional` **opy**: [`OpyPaymentInitializeOptions`](internal_.OpyPaymentInitializeOptions.md)
+
+The options that are required to initialize the Opy payment
+method. They can be omitted unless you need to support Opy.
+
+___
+
+### params
+
+• `Optional` **params**: `Object`
+
+The parameters of the request, if required.
+
+#### Inherited from
+
+[PaymentRequestOptions](internal_.PaymentRequestOptions.md).[params](internal_.PaymentRequestOptions.md#params)
+
+___
+
+### paypalcommerce
+
+• `Optional` **paypalcommerce**: [`PaypalCommerceInitializeOptions`](../modules/internal_.md#paypalcommerceinitializeoptions)
+
+The options that are required to initialize the PayPal Commerce payment method.
+They can be omitted unless you need to support PayPal Commerce.
+
+___
+
+### paypalexpress
+
+• `Optional` **paypalexpress**: [`PaypalExpressPaymentInitializeOptions`](internal_.PaypalExpressPaymentInitializeOptions.md)
+
+The options that are required to initialize the PayPal Express payment method.
+They can be omitted unless you need to support PayPal Express.
+
+___
+
+### square
+
+• `Optional` **square**: [`SquarePaymentInitializeOptions`](internal_.SquarePaymentInitializeOptions.md)
+
+The options that are required to initialize the Square payment method.
+They can be omitted unless you need to support Square.
+
+___
+
+### stripeupe
+
+• `Optional` **stripeupe**: [`StripeUPEPaymentInitializeOptions`](internal_.StripeUPEPaymentInitializeOptions.md)
+
+The options that are required to initialize the StripeUPE payment method.
+They can be omitted unless you need to support StripeUPE.
+
+___
+
+### stripev3
+
+• `Optional` **stripev3**: [`StripeV3PaymentInitializeOptions`](internal_.StripeV3PaymentInitializeOptions.md)
+
+The options that are required to initialize the Stripe payment method.
+They can be omitted unless you need to support StripeV3.
+
+___
+
+### 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
+
+[PaymentRequestOptions](internal_.PaymentRequestOptions.md).[timeout](internal_.PaymentRequestOptions.md#timeout)
+
+___
+
+### worldpay
+
+• `Optional` **worldpay**: [`WorldpayAccessPaymentInitializeOptions`](internal_.WorldpayAccessPaymentInitializeOptions.md)
+
+The options that are required to initialize the Worldpay payment method.
+They can be omitted unless you need to support Worldpay.