@bigcommerce/checkout-sdk 1.264.1 → 1.266.0

package/docs/interfaces/braintreepaypalbuttoninitializeoptions.md

@@ -1,94 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [BraintreePaypalButtonInitializeOptions](braintreepaypalbuttoninitializeoptions.md)
-
-# Interface: BraintreePaypalButtonInitializeOptions
-
-## Hierarchy
-
-* **BraintreePaypalButtonInitializeOptions**
-
-## Index
-
-### Properties
-
-* [messagingContainerId](braintreepaypalbuttoninitializeoptions.md#optional-messagingcontainerid)
-* [shippingAddress](braintreepaypalbuttoninitializeoptions.md#optional-shippingaddress)
-* [style](braintreepaypalbuttoninitializeoptions.md#optional-style)
-
-### Methods
-
-* [onAuthorizeError](braintreepaypalbuttoninitializeoptions.md#optional-onauthorizeerror)
-* [onError](braintreepaypalbuttoninitializeoptions.md#optional-onerror)
-* [onPaymentError](braintreepaypalbuttoninitializeoptions.md#optional-onpaymenterror)
-
-## Properties
-
-### `Optional` messagingContainerId
-
-• **messagingContainerId**? : *undefined | string*
-
-The ID of a container which the messaging should be inserted.
-
-___
-
-### `Optional` shippingAddress
-
-• **shippingAddress**? : *[Address](address.md) | null*
-
-Address to be used for shipping.
-If not provided, it will use the first saved address from the active customer.
-
-___
-
-### `Optional` style
-
-• **style**? : *Pick‹[PaypalButtonStyleOptions](paypalbuttonstyleoptions.md), "layout" | "size" | "color" | "label" | "shape" | "tagline" | "fundingicons" | "height"›*
-
-A set of styling options for the checkout button.
-
-## Methods
-
-### `Optional` onAuthorizeError
-
-▸ **onAuthorizeError**(`error`: [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md)): *void*
-
-A callback that gets called if unable to authorize and tokenize payment.
-
-**Parameters:**
-
-Name | Type | Description |
------- | ------ | ------ |
-`error` | [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md) | The error object describing the failure.  |
-
-**Returns:** *void*
-
-___
-
-### `Optional` onError
-
-▸ **onError**(`error`: [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md)): *void*
-
-A callback that gets called on any error instead of submit payment or authorization errors.
-
-**Parameters:**
-
-Name | Type | Description |
------- | ------ | ------ |
-`error` | [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md) | The error object describing the failure.  |
-
-**Returns:** *void*
-
-___
-
-### `Optional` onPaymentError
-
-▸ **onPaymentError**(`error`: [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md)): *void*
-
-A callback that gets called if unable to submit payment.
-
-**Parameters:**
-
-Name | Type | Description |
------- | ------ | ------ |
-`error` | [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md) | The error object describing the failure.  |
-
-**Returns:** *void*

package/docs/interfaces/braintreepaypalcreditbuttoninitializeoptions.md

@@ -1,85 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [BraintreePaypalCreditButtonInitializeOptions](braintreepaypalcreditbuttoninitializeoptions.md)
-
-# Interface: BraintreePaypalCreditButtonInitializeOptions
-
-## Hierarchy
-
-* **BraintreePaypalCreditButtonInitializeOptions**
-
-## Index
-
-### Properties
-
-* [shippingAddress](braintreepaypalcreditbuttoninitializeoptions.md#optional-shippingaddress)
-* [style](braintreepaypalcreditbuttoninitializeoptions.md#optional-style)
-
-### Methods
-
-* [onAuthorizeError](braintreepaypalcreditbuttoninitializeoptions.md#optional-onauthorizeerror)
-* [onError](braintreepaypalcreditbuttoninitializeoptions.md#optional-onerror)
-* [onPaymentError](braintreepaypalcreditbuttoninitializeoptions.md#optional-onpaymenterror)
-
-## Properties
-
-### `Optional` shippingAddress
-
-• **shippingAddress**? : *[Address](address.md) | null*
-
-Address to be used for shipping.
-If not provided, it will use the first saved address from the active customer.
-
-___
-
-### `Optional` style
-
-• **style**? : *Pick‹[PaypalButtonStyleOptions](paypalbuttonstyleoptions.md), "layout" | "size" | "color" | "label" | "shape" | "tagline" | "fundingicons" | "height"›*
-
-A set of styling options for the checkout button.
-
-## Methods
-
-### `Optional` onAuthorizeError
-
-▸ **onAuthorizeError**(`error`: [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md)): *void*
-
-A callback that gets called if unable to authorize and tokenize payment.
-
-**Parameters:**
-
-Name | Type | Description |
------- | ------ | ------ |
-`error` | [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md) | The error object describing the failure.  |
-
-**Returns:** *void*
-
-___
-
-### `Optional` onError
-
-▸ **onError**(`error`: [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md)): *void*
-
-A callback that gets called on any error instead of submit payment or authorization errors.
-
-**Parameters:**
-
-Name | Type | Description |
------- | ------ | ------ |
-`error` | [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md) | The error object describing the failure.  |
-
-**Returns:** *void*
-
-___
-
-### `Optional` onPaymentError
-
-▸ **onPaymentError**(`error`: [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md)): *void*
-
-A callback that gets called if unable to submit payment.
-
-**Parameters:**
-
-Name | Type | Description |
------- | ------ | ------ |
-`error` | [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md) | The error object describing the failure.  |
-
-**Returns:** *void*

package/docs/interfaces/braintreestoredcardfieldoptions.md

@@ -1,48 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [BraintreeStoredCardFieldOptions](braintreestoredcardfieldoptions.md)
-
-# Interface: BraintreeStoredCardFieldOptions
-
-## Hierarchy
-
-* [BraintreeFormFieldOptions](braintreeformfieldoptions.md)
-
-  ↳ **BraintreeStoredCardFieldOptions**
-
-## Index
-
-### Properties
-
-* [accessibilityLabel](braintreestoredcardfieldoptions.md#optional-accessibilitylabel)
-* [containerId](braintreestoredcardfieldoptions.md#containerid)
-* [instrumentId](braintreestoredcardfieldoptions.md#instrumentid)
-* [placeholder](braintreestoredcardfieldoptions.md#optional-placeholder)
-
-## Properties
-
-### `Optional` accessibilityLabel
-
-• **accessibilityLabel**? : *undefined | string*
-
-*Inherited from [BraintreeFormFieldOptions](braintreeformfieldoptions.md).[accessibilityLabel](braintreeformfieldoptions.md#optional-accessibilitylabel)*
-
-___
-
-###  containerId
-
-• **containerId**: *string*
-
-*Inherited from [BraintreeFormFieldOptions](braintreeformfieldoptions.md).[containerId](braintreeformfieldoptions.md#containerid)*
-
-___
-
-###  instrumentId
-
-• **instrumentId**: *string*
-
-___
-
-### `Optional` placeholder
-
-• **placeholder**? : *undefined | string*
-
-*Inherited from [BraintreeFormFieldOptions](braintreeformfieldoptions.md).[placeholder](braintreeformfieldoptions.md#optional-placeholder)*

package/docs/interfaces/braintreestoredcardfieldsmap.md

@@ -1,26 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [BraintreeStoredCardFieldsMap](braintreestoredcardfieldsmap.md)
-
-# Interface: BraintreeStoredCardFieldsMap
-
-## Hierarchy
-
-* **BraintreeStoredCardFieldsMap**
-
-## Index
-
-### Properties
-
-* [[BraintreeFormFieldType.CardCodeVerification]](braintreestoredcardfieldsmap.md#optional-[braintreeformfieldtype.cardcodeverification])
-* [[BraintreeFormFieldType.CardNumberVerification]](braintreestoredcardfieldsmap.md#optional-[braintreeformfieldtype.cardnumberverification])
-
-## Properties
-
-### `Optional` [BraintreeFormFieldType.CardCodeVerification]
-
-• **[BraintreeFormFieldType.CardCodeVerification]**? : *[BraintreeStoredCardFieldOptions](braintreestoredcardfieldoptions.md)*
-
-___
-
-### `Optional` [BraintreeFormFieldType.CardNumberVerification]
-
-• **[BraintreeFormFieldType.CardNumberVerification]**? : *[BraintreeStoredCardFieldOptions](braintreestoredcardfieldoptions.md)*

package/docs/interfaces/braintreethreedsecureoptions.md

@@ -1,62 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [BraintreeThreeDSecureOptions](braintreethreedsecureoptions.md)
-
-# Interface: BraintreeThreeDSecureOptions
-
-A set of options that are required to support 3D Secure authentication flow.
-
-If the customer uses a credit card that has 3D Secure enabled, they will be
-asked to verify their identity when they pay. The verification is done
-through a web page via an iframe provided by the card issuer.
-
-## Hierarchy
-
-* **BraintreeThreeDSecureOptions**
-
-## Index
-
-### Methods
-
-* [addFrame](braintreethreedsecureoptions.md#addframe)
-* [removeFrame](braintreethreedsecureoptions.md#removeframe)
-
-## Methods
-
-###  addFrame
-
-▸ **addFrame**(`error`: [Error](amazonpaywidgeterror.md#error) | undefined, `iframe`: HTMLIFrameElement, `cancel`: function): *void*
-
-A callback that gets called when the iframe is ready to be added to the
-current page. It is responsible for determining where the iframe should
-be inserted in the DOM.
-
-**Parameters:**
-
-▪ **error**: *[Error](amazonpaywidgeterror.md#error) | undefined*
-
-Any error raised during the verification process;
-undefined if there is none.
-
-▪ **iframe**: *HTMLIFrameElement*
-
-The iframe element containing the verification web page
-provided by the card issuer.
-
-▪ **cancel**: *function*
-
-A function, when called, will cancel the verification
-process and remove the iframe.
-
-▸ (): *Promise‹[BraintreeVerifyPayload](braintreeverifypayload.md)› | undefined*
-
-**Returns:** *void*
-
-___
-
-###  removeFrame
-
-▸ **removeFrame**(): *void*
-
-A callback that gets called when the iframe is about to be removed from
-the current page.
-
-**Returns:** *void*

package/docs/interfaces/braintreevenmobuttoninitializeoptions.md

@@ -1,29 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [BraintreeVenmoButtonInitializeOptions](braintreevenmobuttoninitializeoptions.md)
-
-# Interface: BraintreeVenmoButtonInitializeOptions
-
-## Hierarchy
-
-* **BraintreeVenmoButtonInitializeOptions**
-
-## Index
-
-### Methods
-
-* [onError](braintreevenmobuttoninitializeoptions.md#optional-onerror)
-
-## Methods
-
-### `Optional` onError
-
-▸ **onError**(`error`: [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md)): *void*
-
-A callback that gets called on any error.
-
-**Parameters:**
-
-Name | Type | Description |
------- | ------ | ------ |
-`error` | [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md) | The error object describing the failure.  |
-
-**Returns:** *void*

package/docs/interfaces/braintreeverifypayload.md

@@ -1,55 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [BraintreeVerifyPayload](braintreeverifypayload.md)
-
-# Interface: BraintreeVerifyPayload
-
-## Hierarchy
-
-* **BraintreeVerifyPayload**
-
-## Index
-
-### Properties
-
-* [description](braintreeverifypayload.md#description)
-* [details](braintreeverifypayload.md#details)
-* [liabilityShiftPossible](braintreeverifypayload.md#liabilityshiftpossible)
-* [liabilityShifted](braintreeverifypayload.md#liabilityshifted)
-* [nonce](braintreeverifypayload.md#nonce)
-
-## Properties
-
-###  description
-
-• **description**: *string*
-
-___
-
-###  details
-
-• **details**: *object*
-
-#### Type declaration:
-
-* **cardType**: *string*
-
-* **lastFour**: *string*
-
-* **lastTwo**: *string*
-
-___
-
-###  liabilityShiftPossible
-
-• **liabilityShiftPossible**: *boolean*
-
-___
-
-###  liabilityShifted
-
-• **liabilityShifted**: *boolean*
-
-___
-
-###  nonce
-
-• **nonce**: *string*

package/docs/interfaces/braintreevisacheckoutcustomerinitializeoptions.md

@@ -1,37 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [BraintreeVisaCheckoutCustomerInitializeOptions](braintreevisacheckoutcustomerinitializeoptions.md)
-
-# Interface: BraintreeVisaCheckoutCustomerInitializeOptions
-
-## Hierarchy
-
-* **BraintreeVisaCheckoutCustomerInitializeOptions**
-
-## Index
-
-### Properties
-
-* [container](braintreevisacheckoutcustomerinitializeoptions.md#container)
-
-### Methods
-
-* [onError](braintreevisacheckoutcustomerinitializeoptions.md#optional-onerror)
-
-## Properties
-
-###  container
-
-• **container**: *string*
-
-## Methods
-
-### `Optional` onError
-
-▸ **onError**(`error`: [Error](amazonpaywidgeterror.md#error)): *void*
-
-**Parameters:**
-
-Name | Type |
------- | ------ |
-`error` | [Error](amazonpaywidgeterror.md#error) |
-
-**Returns:** *void*

package/docs/interfaces/browserinfo.md

@@ -1,54 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [BrowserInfo](browserinfo.md)
-
-# Interface: BrowserInfo
-
-## Hierarchy
-
-* **BrowserInfo**
-
-## Index
-
-### 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/buttonstyles.md

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

package/docs/interfaces/cardcvcelementoptions.md

@@ -1,64 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [CardCvcElementOptions](cardcvcelementoptions.md)
-
-# Interface: CardCvcElementOptions
-
-## Hierarchy
-
-  ↳ [BaseIndividualElementOptions](baseindividualelementoptions.md)
-
-  ↳ **CardCvcElementOptions**
-
-## Index
-
-### Properties
-
-* [classes](cardcvcelementoptions.md#optional-classes)
-* [containerId](cardcvcelementoptions.md#containerid)
-* [disabled](cardcvcelementoptions.md#optional-disabled)
-* [placeholder](cardcvcelementoptions.md#optional-placeholder)
-* [style](cardcvcelementoptions.md#optional-style)
-
-## Properties
-
-### `Optional` classes
-
-• **classes**? : *[StripeElementClasses](stripeelementclasses.md)*
-
-*Inherited from [BaseElementOptions_2](baseelementoptions_2.md).[classes](baseelementoptions_2.md#optional-classes)*
-
-Set custom class names on the container DOM element when the Stripe element is in a particular state.
-
-___
-
-###  containerId
-
-• **containerId**: *string*
-
-*Inherited from [BaseIndividualElementOptions](baseindividualelementoptions.md).[containerId](baseindividualelementoptions.md#containerid)*
-
-___
-
-### `Optional` disabled
-
-• **disabled**? : *undefined | false | true*
-
-*Inherited from [BaseElementOptions_2](baseelementoptions_2.md).[disabled](baseelementoptions_2.md#optional-disabled)*
-
-Applies a disabled state to the Element such that user input is not accepted. Default is false.
-
-___
-
-### `Optional` placeholder
-
-• **placeholder**? : *undefined | string*
-
-___
-
-### `Optional` style
-
-• **style**? : *[StripeElementStyle](stripeelementstyle.md)*
-
-*Inherited from [BaseElementOptions_2](baseelementoptions_2.md).[style](baseelementoptions_2.md#optional-style)*
-
-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/carddatapaymentmethodstate.md

@@ -1,19 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [CardDataPaymentMethodState](carddatapaymentmethodstate.md)
-
-# Interface: CardDataPaymentMethodState
-
-## Hierarchy
-
-* **CardDataPaymentMethodState**
-
-## Index
-
-### Properties
-
-* [paymentMethod](carddatapaymentmethodstate.md#paymentmethod)
-
-## Properties
-
-###  paymentMethod
-
-• **paymentMethod**: *[CardPaymentMethodState](cardpaymentmethodstate.md)*