@bigcommerce/checkout-sdk 1.308.1 → 1.308.2

package/docs/interfaces/internal_.StripeElementStyleVariant.md

@@ -0,0 +1,289 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StripeElementStyleVariant
+
+# Interface: StripeElementStyleVariant
+
+[<internal>](../modules/internal_.md).StripeElementStyleVariant
+
+CSS properties supported by Stripe.js.
+
+## Hierarchy
+
+- [`StripeElementCSSProperties`](internal_.StripeElementCSSProperties.md)
+
+  ↳ **`StripeElementStyleVariant`**
+
+## Table of contents
+
+### Properties
+
+- [:-webkit-autofill](internal_.StripeElementStyleVariant.md#:-webkit-autofill)
+- [::-ms-clear](internal_.StripeElementStyleVariant.md#::-ms-clear)
+- [::placeholder](internal_.StripeElementStyleVariant.md#::placeholder)
+- [::selection](internal_.StripeElementStyleVariant.md#::selection)
+- [:disabled](internal_.StripeElementStyleVariant.md#:disabled)
+- [:focus](internal_.StripeElementStyleVariant.md#:focus)
+- [:hover](internal_.StripeElementStyleVariant.md#:hover)
+- [backgroundColor](internal_.StripeElementStyleVariant.md#backgroundcolor)
+- [color](internal_.StripeElementStyleVariant.md#color)
+- [fontFamily](internal_.StripeElementStyleVariant.md#fontfamily)
+- [fontSize](internal_.StripeElementStyleVariant.md#fontsize)
+- [fontSmoothing](internal_.StripeElementStyleVariant.md#fontsmoothing)
+- [fontStyle](internal_.StripeElementStyleVariant.md#fontstyle)
+- [fontVariant](internal_.StripeElementStyleVariant.md#fontvariant)
+- [fontWeight](internal_.StripeElementStyleVariant.md#fontweight)
+- [iconColor](internal_.StripeElementStyleVariant.md#iconcolor)
+- [letterSpacing](internal_.StripeElementStyleVariant.md#letterspacing)
+- [lineHeight](internal_.StripeElementStyleVariant.md#lineheight)
+- [padding](internal_.StripeElementStyleVariant.md#padding)
+- [textAlign](internal_.StripeElementStyleVariant.md#textalign)
+- [textDecoration](internal_.StripeElementStyleVariant.md#textdecoration)
+- [textShadow](internal_.StripeElementStyleVariant.md#textshadow)
+- [textTransform](internal_.StripeElementStyleVariant.md#texttransform)
+
+## Properties
+
+### :-webkit-autofill
+
+• `Optional` **:-webkit-autofill**: [`StripeElementCSSProperties`](internal_.StripeElementCSSProperties.md)
+
+___
+
+### ::-ms-clear
+
+• `Optional` **::-ms-clear**: [`StripeElementCSSProperties`](internal_.StripeElementCSSProperties.md) & { `display`: `string`  }
+
+Available for the `cardNumber`, `cardExpiry`, and `cardCvc` elements.
+
+___
+
+### ::placeholder
+
+• `Optional` **::placeholder**: [`StripeElementCSSProperties`](internal_.StripeElementCSSProperties.md)
+
+___
+
+### ::selection
+
+• `Optional` **::selection**: [`StripeElementCSSProperties`](internal_.StripeElementCSSProperties.md)
+
+___
+
+### :disabled
+
+• `Optional` **:disabled**: [`StripeElementCSSProperties`](internal_.StripeElementCSSProperties.md)
+
+Available for all elements except the `paymentRequestButton` element
+
+___
+
+### :focus
+
+• `Optional` **:focus**: [`StripeElementCSSProperties`](internal_.StripeElementCSSProperties.md)
+
+___
+
+### :hover
+
+• `Optional` **:hover**: [`StripeElementCSSProperties`](internal_.StripeElementCSSProperties.md)
+
+___
+
+### backgroundColor
+
+• `Optional` **backgroundColor**: `string`
+
+The [background-color](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) CSS property.
+
+This property works best with the `::selection` pseudo-class.
+In other cases, consider setting the background color on the element's container instaed.
+
+#### Inherited from
+
+[StripeElementCSSProperties](internal_.StripeElementCSSProperties.md).[backgroundColor](internal_.StripeElementCSSProperties.md#backgroundcolor)
+
+___
+
+### color
+
+• `Optional` **color**: `string`
+
+The [color](https://developer.mozilla.org/en-US/docs/Web/CSS/color) CSS property.
+
+#### Inherited from
+
+[StripeElementCSSProperties](internal_.StripeElementCSSProperties.md).[color](internal_.StripeElementCSSProperties.md#color)
+
+___
+
+### fontFamily
+
+• `Optional` **fontFamily**: `string`
+
+The [font-family](https://developer.mozilla.org/en-US/docs/Web/CSS/font-family) CSS property.
+
+#### Inherited from
+
+[StripeElementCSSProperties](internal_.StripeElementCSSProperties.md).[fontFamily](internal_.StripeElementCSSProperties.md#fontfamily)
+
+___
+
+### fontSize
+
+• `Optional` **fontSize**: `string`
+
+The [font-size](https://developer.mozilla.org/en-US/docs/Web/CSS/font-size) CSS property.
+
+#### Inherited from
+
+[StripeElementCSSProperties](internal_.StripeElementCSSProperties.md).[fontSize](internal_.StripeElementCSSProperties.md#fontsize)
+
+___
+
+### fontSmoothing
+
+• `Optional` **fontSmoothing**: `string`
+
+The [font-smoothing](https://developer.mozilla.org/en-US/docs/Web/CSS/font-smoothing) CSS property.
+
+#### Inherited from
+
+[StripeElementCSSProperties](internal_.StripeElementCSSProperties.md).[fontSmoothing](internal_.StripeElementCSSProperties.md#fontsmoothing)
+
+___
+
+### fontStyle
+
+• `Optional` **fontStyle**: `string`
+
+The [font-style](https://developer.mozilla.org/en-US/docs/Web/CSS/font-style) CSS property.
+
+#### Inherited from
+
+[StripeElementCSSProperties](internal_.StripeElementCSSProperties.md).[fontStyle](internal_.StripeElementCSSProperties.md#fontstyle)
+
+___
+
+### fontVariant
+
+• `Optional` **fontVariant**: `string`
+
+The [font-variant](https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant) CSS property.
+
+#### Inherited from
+
+[StripeElementCSSProperties](internal_.StripeElementCSSProperties.md).[fontVariant](internal_.StripeElementCSSProperties.md#fontvariant)
+
+___
+
+### fontWeight
+
+• `Optional` **fontWeight**: `string`
+
+The [font-weight](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight) CSS property.
+
+#### Inherited from
+
+[StripeElementCSSProperties](internal_.StripeElementCSSProperties.md).[fontWeight](internal_.StripeElementCSSProperties.md#fontweight)
+
+___
+
+### iconColor
+
+• `Optional` **iconColor**: `string`
+
+A custom property, used to set the color of the icons that are rendered in an element.
+
+#### Inherited from
+
+[StripeElementCSSProperties](internal_.StripeElementCSSProperties.md).[iconColor](internal_.StripeElementCSSProperties.md#iconcolor)
+
+___
+
+### letterSpacing
+
+• `Optional` **letterSpacing**: `string`
+
+The [letter-spacing](https://developer.mozilla.org/en-US/docs/Web/CSS/letter-spacing) CSS property.
+
+#### Inherited from
+
+[StripeElementCSSProperties](internal_.StripeElementCSSProperties.md).[letterSpacing](internal_.StripeElementCSSProperties.md#letterspacing)
+
+___
+
+### lineHeight
+
+• `Optional` **lineHeight**: `string`
+
+The [line-height](https://developer.mozilla.org/en-US/docs/Web/CSS/line-height) CSS property.
+
+To avoid cursors being rendered inconsistently across browsers, consider using a padding on the element's container instead.
+
+#### Inherited from
+
+[StripeElementCSSProperties](internal_.StripeElementCSSProperties.md).[lineHeight](internal_.StripeElementCSSProperties.md#lineheight)
+
+___
+
+### padding
+
+• `Optional` **padding**: `string`
+
+The [padding](https://developer.mozilla.org/en-US/docs/Web/CSS/padding) CSS property.
+
+Available for the `idealBank` element.
+Accepts integer `px` values.
+
+#### Inherited from
+
+[StripeElementCSSProperties](internal_.StripeElementCSSProperties.md).[padding](internal_.StripeElementCSSProperties.md#padding)
+
+___
+
+### textAlign
+
+• `Optional` **textAlign**: `string`
+
+The [text-align](https://developer.mozilla.org/en-US/docs/Web/CSS/text-align) CSS property.
+
+Available for the `cardNumber`, `cardExpiry`, and `cardCvc` elements.
+
+#### Inherited from
+
+[StripeElementCSSProperties](internal_.StripeElementCSSProperties.md).[textAlign](internal_.StripeElementCSSProperties.md#textalign)
+
+___
+
+### textDecoration
+
+• `Optional` **textDecoration**: `string`
+
+The [text-decoration](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration) CSS property.
+
+#### Inherited from
+
+[StripeElementCSSProperties](internal_.StripeElementCSSProperties.md).[textDecoration](internal_.StripeElementCSSProperties.md#textdecoration)
+
+___
+
+### textShadow
+
+• `Optional` **textShadow**: `string`
+
+The [text-shadow](https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow) CSS property.
+
+#### Inherited from
+
+[StripeElementCSSProperties](internal_.StripeElementCSSProperties.md).[textShadow](internal_.StripeElementCSSProperties.md#textshadow)
+
+___
+
+### textTransform
+
+• `Optional` **textTransform**: `string`
+
+The [text-transform](https://developer.mozilla.org/en-US/docs/Web/CSS/text-transform) CSS property.
+
+#### Inherited from
+
+[StripeElementCSSProperties](internal_.StripeElementCSSProperties.md).[textTransform](internal_.StripeElementCSSProperties.md#texttransform)

package/docs/interfaces/internal_.StripeEvent.md

@@ -0,0 +1,39 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StripeEvent
+
+# Interface: StripeEvent
+
+[<internal>](../modules/internal_.md).StripeEvent
+
+## Hierarchy
+
+- **`StripeEvent`**
+
+  ↳ [`StripeShippingEvent`](internal_.StripeShippingEvent.md)
+
+  ↳ [`StripeCustomerEvent`](internal_.StripeCustomerEvent.md)
+
+## Table of contents
+
+### Properties
+
+- [complete](internal_.StripeEvent.md#complete)
+- [elementType](internal_.StripeEvent.md#elementtype)
+- [empty](internal_.StripeEvent.md#empty)
+
+## Properties
+
+### complete
+
+• **complete**: `boolean`
+
+___
+
+### elementType
+
+• **elementType**: `string`
+
+___
+
+### empty
+
+• **empty**: `boolean`

package/docs/interfaces/internal_.StripeShippingEvent.md

@@ -0,0 +1,76 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StripeShippingEvent
+
+# Interface: StripeShippingEvent
+
+[<internal>](../modules/internal_.md).StripeShippingEvent
+
+## Hierarchy
+
+- [`StripeEvent`](internal_.StripeEvent.md)
+
+  ↳ **`StripeShippingEvent`**
+
+## Table of contents
+
+### Properties
+
+- [complete](internal_.StripeShippingEvent.md#complete)
+- [elementType](internal_.StripeShippingEvent.md#elementtype)
+- [empty](internal_.StripeShippingEvent.md#empty)
+- [isNewAddress](internal_.StripeShippingEvent.md#isnewaddress)
+- [value](internal_.StripeShippingEvent.md#value)
+
+## Properties
+
+### complete
+
+• **complete**: `boolean`
+
+#### Inherited from
+
+[StripeEvent](internal_.StripeEvent.md).[complete](internal_.StripeEvent.md#complete)
+
+___
+
+### elementType
+
+• **elementType**: `string`
+
+#### Inherited from
+
+[StripeEvent](internal_.StripeEvent.md).[elementType](internal_.StripeEvent.md#elementtype)
+
+___
+
+### empty
+
+• **empty**: `boolean`
+
+#### Inherited from
+
+[StripeEvent](internal_.StripeEvent.md).[empty](internal_.StripeEvent.md#empty)
+
+___
+
+### isNewAddress
+
+• `Optional` **isNewAddress**: `boolean`
+
+___
+
+### value
+
+• **value**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `address` | { `city`: `string` ; `country`: `string` ; `line1`: `string` ; `line2?`: `string` ; `postal_code`: `string` ; `state`: `string`  } |
+| `address.city` | `string` |
+| `address.country` | `string` |
+| `address.line1` | `string` |
+| `address.line2?` | `string` |
+| `address.postal_code` | `string` |
+| `address.state` | `string` |
+| `name` | `string` |

package/docs/interfaces/internal_.StripeUPECustomerInitializeOptions.md

@@ -0,0 +1,94 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StripeUPECustomerInitializeOptions
+
+# Interface: StripeUPECustomerInitializeOptions
+
+[<internal>](../modules/internal_.md).StripeUPECustomerInitializeOptions
+
+## Table of contents
+
+### Properties
+
+- [container](internal_.StripeUPECustomerInitializeOptions.md#container)
+- [gatewayId](internal_.StripeUPECustomerInitializeOptions.md#gatewayid)
+- [methodId](internal_.StripeUPECustomerInitializeOptions.md#methodid)
+
+### Methods
+
+- [getStyles](internal_.StripeUPECustomerInitializeOptions.md#getstyles)
+- [isLoading](internal_.StripeUPECustomerInitializeOptions.md#isloading)
+- [onEmailChange](internal_.StripeUPECustomerInitializeOptions.md#onemailchange)
+
+## Properties
+
+### container
+
+• **container**: `string`
+
+The ID of a container which the stripe iframe should be inserted.
+
+___
+
+### gatewayId
+
+• **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.: Stripeupe and Klarna.
+
+___
+
+### methodId
+
+• **methodId**: `string`
+
+The identifier of the payment method.
+
+## Methods
+
+### getStyles
+
+▸ `Optional` **getStyles**(): `undefined` \| { `[key: string]`: `string`;  }
+
+get styles from store theme
+
+#### Returns
+
+`undefined` \| { `[key: string]`: `string`;  }
+
+___
+
+### isLoading
+
+▸ **isLoading**(`mounted`): `void`
+
+A callback that gets called when Stripe Link Authentication Element is Loaded.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `mounted` | `boolean` |
+
+#### Returns
+
+`void`
+
+___
+
+### onEmailChange
+
+▸ **onEmailChange**(`authenticated`, `email`): `void`
+
+A callback that gets called whenever the Stripe Link Authentication Element's value changes.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `authenticated` | `boolean` | if the email is authenticated on Stripe. |
+| `email` | `string` | The new value of the email. |
+
+#### Returns
+
+`void`

package/docs/interfaces/internal_.StripeUPEPaymentInitializeOptions.md

@@ -0,0 +1,72 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StripeUPEPaymentInitializeOptions
+
+# Interface: StripeUPEPaymentInitializeOptions
+
+[<internal>](../modules/internal_.md).StripeUPEPaymentInitializeOptions
+
+A set of options that are required to initialize the Stripe payment method.
+
+Once Stripe payment is initialized, credit card form fields, provided by the
+payment provider as iframes, will be inserted into the current page. These
+options provide a location and styling for each of the form fields.
+
+```html
+<!-- This is where the credit card component will be inserted -->
+<div id="container"></div>
+```
+
+```js
+service.initializePayment({
+    methodId: 'stripeupe',
+    stripeupe {
+        containerId: 'container',
+    },
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [containerId](internal_.StripeUPEPaymentInitializeOptions.md#containerid)
+- [style](internal_.StripeUPEPaymentInitializeOptions.md#style)
+
+### Methods
+
+- [onError](internal_.StripeUPEPaymentInitializeOptions.md#onerror)
+
+## Properties
+
+### containerId
+
+• **containerId**: `string`
+
+The location to insert the credit card number form field.
+
+___
+
+### style
+
+• `Optional` **style**: `Object`
+
+Checkout styles from store theme
+
+#### Index signature
+
+▪ [key: `string`]: `string`
+
+## Methods
+
+### onError
+
+▸ `Optional` **onError**(`error?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `error?` | `Error` |
+
+#### Returns
+
+`void`

package/docs/interfaces/internal_.StripeUPEShippingInitializeOptions.md

@@ -0,0 +1,109 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StripeUPEShippingInitializeOptions
+
+# Interface: StripeUPEShippingInitializeOptions
+
+[<internal>](../modules/internal_.md).StripeUPEShippingInitializeOptions
+
+A set of options that are required to initialize the shipping step of
+checkout in order to support StripeUpe.
+
+When StripeUpe is initialized, an iframe will be inserted into the DOM. The
+iframe has a list of shipping addresses for the customer to choose from.
+
+## Table of contents
+
+### Properties
+
+- [availableCountries](internal_.StripeUPEShippingInitializeOptions.md#availablecountries)
+- [container](internal_.StripeUPEShippingInitializeOptions.md#container)
+- [gatewayId](internal_.StripeUPEShippingInitializeOptions.md#gatewayid)
+- [methodId](internal_.StripeUPEShippingInitializeOptions.md#methodid)
+
+### Methods
+
+- [getStripeState](internal_.StripeUPEShippingInitializeOptions.md#getstripestate)
+- [getStyles](internal_.StripeUPEShippingInitializeOptions.md#getstyles)
+- [onChangeShipping](internal_.StripeUPEShippingInitializeOptions.md#onchangeshipping)
+
+## Properties
+
+### availableCountries
+
+• **availableCountries**: `string`
+
+Available countries configured on BC shipping setup.
+
+___
+
+### container
+
+• `Optional` **container**: `string`
+
+The ID of a container which the stripe iframe should be inserted.
+
+___
+
+### gatewayId
+
+• **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.: Stripeupe and Klarna.
+
+___
+
+### methodId
+
+• **methodId**: `string`
+
+The identifier of the payment method.
+
+## Methods
+
+### getStripeState
+
+▸ **getStripeState**(`country`, `state`): `string`
+
+get the state code needed for shipping stripe element
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `country` | `string` |
+| `state` | `string` |
+
+#### Returns
+
+`string`
+
+___
+
+### getStyles
+
+▸ `Optional` **getStyles**(): `Object`
+
+get styles from store theme
+
+#### Returns
+
+`Object`
+
+___
+
+### onChangeShipping
+
+▸ **onChangeShipping**(`shipping`): `void`
+
+A callback that gets called whenever the Stripe Link Shipping Element's object is completed.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `shipping` | [`StripeEventType`](../modules/internal_.md#stripeeventtype) |
+
+#### Returns
+
+`void`