@bigcommerce/checkout-sdk 1.271.1 → 1.271.2

package/docs/interfaces/BraintreeVisaCheckoutPaymentInitializeOptions.md

@@ -1,70 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BraintreeVisaCheckoutPaymentInitializeOptions
-
-# Interface: BraintreeVisaCheckoutPaymentInitializeOptions
-
-A set of options that are required to initialize the Visa Checkout payment
-method provided by Braintree.
-
-If the customer chooses to pay with Visa Checkout, they will be asked to
-enter their payment details via a modal. You can hook into events emitted by
-the modal by providing the callbacks listed below.
-
-```js
-service.initializePayment({
-    methodId: 'braintreevisacheckout',
-});
-```
-
-Additional event callbacks can be registered.
-
-```js
-service.initializePayment({
-    methodId: 'braintreevisacheckout',
-    braintreevisacheckout: {
-        onError(error) {
-            console.log(error);
-        },
-        onPaymentSelect() {
-            console.log('Selected');
-        },
-    },
-});
-```
-
-## Table of contents
-
-### Methods
-
-- [onError](BraintreeVisaCheckoutPaymentInitializeOptions.md#onerror)
-- [onPaymentSelect](BraintreeVisaCheckoutPaymentInitializeOptions.md#onpaymentselect)
-
-## Methods
-
-### onError
-
-▸ `Optional` **onError**(`error`): `void`
-
-A callback that gets called when Visa Checkout fails to initialize or
-selects a payment option.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `error` | `Error` | The error object describing the failure. |
-
-#### Returns
-
-`void`
-
-___
-
-### onPaymentSelect
-
-▸ `Optional` **onPaymentSelect**(): `void`
-
-A callback that gets called when the customer selects a payment option.
-
-#### Returns
-
-`void`

package/docs/interfaces/BrowserInfo.md

@@ -1,50 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BrowserInfo
-
-# Interface: BrowserInfo
-
-## Table of contents
-
-### Properties
-
-- [color_depth](BrowserInfo.md#color_depth)
-- [java_enabled](BrowserInfo.md#java_enabled)
-- [language](BrowserInfo.md#language)
-- [screen_height](BrowserInfo.md#screen_height)
-- [screen_width](BrowserInfo.md#screen_width)
-- [time_zone_offset](BrowserInfo.md#time_zone_offset)
-
-## Properties
-
-### color\_depth
-
-• **color\_depth**: `number`
-
-___
-
-### java\_enabled
-
-• **java\_enabled**: `boolean`
-
-___
-
-### language
-
-• **language**: `string`
-
-___
-
-### screen\_height
-
-• **screen\_height**: `number`
-
-___
-
-### screen\_width
-
-• **screen\_width**: `number`
-
-___
-
-### time\_zone\_offset
-
-• **time\_zone\_offset**: `string`

package/docs/interfaces/ButtonResponse.md

@@ -1,19 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / ButtonResponse
-
-# Interface: ButtonResponse
-
-## Table of contents
-
-### Properties
-
-- [type](ButtonResponse.md#type)
-
-## Properties
-
-### type
-
-• **type**: `string`
-
-https://docs.digitalriver.com/digital-river-api/payment-integrations-1/drop-in/drop-in-integration-guide#customizing-the-text-of-the-drop-in-button
-The text of the Drop-in button is customizable. You can either display pre-configured text or you can specify a unique text
-Examples type: "payNow" || type: "buyNow" || type: "completeOrder" || type: "submitOrder"

package/docs/interfaces/ButtonStyles.md

@@ -1,141 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / ButtonStyles
-
-# Interface: ButtonStyles
-
-## Hierarchy
-
-- [`BlockElementStyles`](BlockElementStyles.md)
-
-  ↳ **`ButtonStyles`**
-
-## Table of contents
-
-### Properties
-
-- [active](ButtonStyles.md#active)
-- [backgroundColor](ButtonStyles.md#backgroundcolor)
-- [borderColor](ButtonStyles.md#bordercolor)
-- [borderWidth](ButtonStyles.md#borderwidth)
-- [boxShadow](ButtonStyles.md#boxshadow)
-- [color](ButtonStyles.md#color)
-- [disabled](ButtonStyles.md#disabled)
-- [focus](ButtonStyles.md#focus)
-- [fontFamily](ButtonStyles.md#fontfamily)
-- [fontWeight](ButtonStyles.md#fontweight)
-- [hover](ButtonStyles.md#hover)
-- [letterSpacing](ButtonStyles.md#letterspacing)
-- [lineHeight](ButtonStyles.md#lineheight)
-
-## Properties
-
-### active
-
-• `Optional` **active**: [`BlockElementStyles`](BlockElementStyles.md)
-
-___
-
-### backgroundColor
-
-• `Optional` **backgroundColor**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[backgroundColor](BlockElementStyles.md#backgroundcolor)
-
-___
-
-### borderColor
-
-• `Optional` **borderColor**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[borderColor](BlockElementStyles.md#bordercolor)
-
-___
-
-### borderWidth
-
-• `Optional` **borderWidth**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[borderWidth](BlockElementStyles.md#borderwidth)
-
-___
-
-### boxShadow
-
-• `Optional` **boxShadow**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[boxShadow](BlockElementStyles.md#boxshadow)
-
-___
-
-### color
-
-• `Optional` **color**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[color](BlockElementStyles.md#color)
-
-___
-
-### disabled
-
-• `Optional` **disabled**: [`BlockElementStyles`](BlockElementStyles.md)
-
-___
-
-### focus
-
-• `Optional` **focus**: [`BlockElementStyles`](BlockElementStyles.md)
-
-___
-
-### fontFamily
-
-• `Optional` **fontFamily**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[fontFamily](BlockElementStyles.md#fontfamily)
-
-___
-
-### fontWeight
-
-• `Optional` **fontWeight**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[fontWeight](BlockElementStyles.md#fontweight)
-
-___
-
-### hover
-
-• `Optional` **hover**: [`BlockElementStyles`](BlockElementStyles.md)
-
-___
-
-### letterSpacing
-
-• `Optional` **letterSpacing**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[letterSpacing](BlockElementStyles.md#letterspacing)
-
-___
-
-### lineHeight
-
-• `Optional` **lineHeight**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[lineHeight](BlockElementStyles.md#lineheight)

package/docs/interfaces/CardCvcElementOptions.md

@@ -1,72 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / CardCvcElementOptions
-
-# Interface: CardCvcElementOptions
-
-## Hierarchy
-
-- [`BaseIndividualElementOptions`](BaseIndividualElementOptions.md)
-
-  ↳ **`CardCvcElementOptions`**
-
-## Table of contents
-
-### Properties
-
-- [classes](CardCvcElementOptions.md#classes)
-- [containerId](CardCvcElementOptions.md#containerid)
-- [disabled](CardCvcElementOptions.md#disabled)
-- [placeholder](CardCvcElementOptions.md#placeholder)
-- [style](CardCvcElementOptions.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
-
-[BaseIndividualElementOptions](BaseIndividualElementOptions.md).[classes](BaseIndividualElementOptions.md#classes)
-
-___
-
-### containerId
-
-• **containerId**: `string`
-
-#### Inherited from
-
-[BaseIndividualElementOptions](BaseIndividualElementOptions.md).[containerId](BaseIndividualElementOptions.md#containerid)
-
-___
-
-### disabled
-
-• `Optional` **disabled**: `boolean`
-
-Applies a disabled state to the Element such that user input is not accepted. Default is false.
-
-#### Inherited from
-
-[BaseIndividualElementOptions](BaseIndividualElementOptions.md).[disabled](BaseIndividualElementOptions.md#disabled)
-
-___
-
-### placeholder
-
-• `Optional` **placeholder**: `string`
-
-___
-
-### 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
-
-[BaseIndividualElementOptions](BaseIndividualElementOptions.md).[style](BaseIndividualElementOptions.md#style)

package/docs/interfaces/CardDataPaymentMethodState.md

@@ -1,15 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / CardDataPaymentMethodState
-
-# Interface: CardDataPaymentMethodState
-
-## Table of contents
-
-### Properties
-
-- [paymentMethod](CardDataPaymentMethodState.md#paymentmethod)
-
-## Properties
-
-### paymentMethod
-
-• **paymentMethod**: [`CardPaymentMethodState`](CardPaymentMethodState.md)

package/docs/interfaces/CardDataPaymentMethodState_2.md

@@ -1,15 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / CardDataPaymentMethodState_2
-
-# Interface: CardDataPaymentMethodState\_2
-
-## Table of contents
-
-### Properties
-
-- [paymentMethod](CardDataPaymentMethodState_2.md#paymentmethod)
-
-## Properties
-
-### paymentMethod
-
-• **paymentMethod**: [`CardPaymentMethodState_2`](CardPaymentMethodState_2.md)

package/docs/interfaces/CardElementOptions.md

@@ -1,91 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / CardElementOptions
-
-# Interface: CardElementOptions
-
-## Hierarchy
-
-- [`BaseElementOptions_2`](BaseElementOptions_2.md)
-
-  ↳ **`CardElementOptions`**
-
-## Table of contents
-
-### Properties
-
-- [classes](CardElementOptions.md#classes)
-- [disabled](CardElementOptions.md#disabled)
-- [hideIcon](CardElementOptions.md#hideicon)
-- [hidePostalCode](CardElementOptions.md#hidepostalcode)
-- [iconStyle](CardElementOptions.md#iconstyle)
-- [style](CardElementOptions.md#style)
-- [value](CardElementOptions.md#value)
-
-## 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)
-
-___
-
-### 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)
-
-___
-
-### hideIcon
-
-• `Optional` **hideIcon**: `boolean`
-
-___
-
-### hidePostalCode
-
-• `Optional` **hidePostalCode**: `boolean`
-
-Hide the postal code field. Default is false. If you are already collecting a
-full billing address or postal code elsewhere, set this to true.
-
-___
-
-### iconStyle
-
-• `Optional` **iconStyle**: [`Solid`](../enums/IconStyle.md#solid) \| [`Default`](../enums/IconStyle.md#default)
-
-Appearance of the icon in the Element.
-
-___
-
-### 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)
-
-___
-
-### value
-
-• `Optional` **value**: `string`
-
-A pre-filled set of values to include in the input (e.g., {postalCode: '94110'}).
-Note that sensitive card information (card number, CVC, and expiration date)
-cannot be pre-filled

package/docs/interfaces/CardExpiryElementOptions.md

@@ -1,72 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / CardExpiryElementOptions
-
-# Interface: CardExpiryElementOptions
-
-## Hierarchy
-
-- [`BaseIndividualElementOptions`](BaseIndividualElementOptions.md)
-
-  ↳ **`CardExpiryElementOptions`**
-
-## Table of contents
-
-### Properties
-
-- [classes](CardExpiryElementOptions.md#classes)
-- [containerId](CardExpiryElementOptions.md#containerid)
-- [disabled](CardExpiryElementOptions.md#disabled)
-- [placeholder](CardExpiryElementOptions.md#placeholder)
-- [style](CardExpiryElementOptions.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
-
-[BaseIndividualElementOptions](BaseIndividualElementOptions.md).[classes](BaseIndividualElementOptions.md#classes)
-
-___
-
-### containerId
-
-• **containerId**: `string`
-
-#### Inherited from
-
-[BaseIndividualElementOptions](BaseIndividualElementOptions.md).[containerId](BaseIndividualElementOptions.md#containerid)
-
-___
-
-### disabled
-
-• `Optional` **disabled**: `boolean`
-
-Applies a disabled state to the Element such that user input is not accepted. Default is false.
-
-#### Inherited from
-
-[BaseIndividualElementOptions](BaseIndividualElementOptions.md).[disabled](BaseIndividualElementOptions.md#disabled)
-
-___
-
-### placeholder
-
-• `Optional` **placeholder**: `string`
-
-___
-
-### 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
-
-[BaseIndividualElementOptions](BaseIndividualElementOptions.md).[style](BaseIndividualElementOptions.md#style)

package/docs/interfaces/CardInstrument.md

@@ -1,115 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / CardInstrument
-
-# Interface: CardInstrument
-
-## Hierarchy
-
-- [`BaseInstrument`](BaseInstrument.md)
-
-  ↳ **`CardInstrument`**
-
-## Table of contents
-
-### Properties
-
-- [bigpayToken](CardInstrument.md#bigpaytoken)
-- [brand](CardInstrument.md#brand)
-- [defaultInstrument](CardInstrument.md#defaultinstrument)
-- [expiryMonth](CardInstrument.md#expirymonth)
-- [expiryYear](CardInstrument.md#expiryyear)
-- [iin](CardInstrument.md#iin)
-- [last4](CardInstrument.md#last4)
-- [method](CardInstrument.md#method)
-- [provider](CardInstrument.md#provider)
-- [trustedShippingAddress](CardInstrument.md#trustedshippingaddress)
-- [type](CardInstrument.md#type)
-
-## Properties
-
-### bigpayToken
-
-• **bigpayToken**: `string`
-
-#### Inherited from
-
-[BaseInstrument](BaseInstrument.md).[bigpayToken](BaseInstrument.md#bigpaytoken)
-
-___
-
-### brand
-
-• **brand**: `string`
-
-___
-
-### defaultInstrument
-
-• **defaultInstrument**: `boolean`
-
-#### Inherited from
-
-[BaseInstrument](BaseInstrument.md).[defaultInstrument](BaseInstrument.md#defaultinstrument)
-
-___
-
-### expiryMonth
-
-• **expiryMonth**: `string`
-
-___
-
-### expiryYear
-
-• **expiryYear**: `string`
-
-___
-
-### iin
-
-• **iin**: `string`
-
-___
-
-### last4
-
-• **last4**: `string`
-
-___
-
-### method
-
-• **method**: `string`
-
-#### Inherited from
-
-[BaseInstrument](BaseInstrument.md).[method](BaseInstrument.md#method)
-
-___
-
-### provider
-
-• **provider**: `string`
-
-#### Inherited from
-
-[BaseInstrument](BaseInstrument.md).[provider](BaseInstrument.md#provider)
-
-___
-
-### trustedShippingAddress
-
-• **trustedShippingAddress**: `boolean`
-
-#### Inherited from
-
-[BaseInstrument](BaseInstrument.md).[trustedShippingAddress](BaseInstrument.md#trustedshippingaddress)
-
-___
-
-### type
-
-• **type**: ``"card"``
-
-#### Overrides
-
-[BaseInstrument](BaseInstrument.md).[type](BaseInstrument.md#type)