@bigcommerce/checkout-sdk 1.271.2 → 1.271.3

package/docs/interfaces/BaseElementOptions.md

@@ -0,0 +1,17 @@
+[@bigcommerce/checkout-sdk](../README.md) / BaseElementOptions
+
+# Interface: BaseElementOptions
+
+## Table of contents
+
+### Properties
+
+- [classes](BaseElementOptions.md#classes)
+
+## 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.

package/docs/interfaces/BaseElementOptions_2.md

@@ -0,0 +1,48 @@
+[@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

@@ -0,0 +1,67 @@
+[@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

@@ -0,0 +1,58 @@
+[@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`

package/docs/interfaces/BillingAddress.md

@@ -0,0 +1,182 @@
+[@bigcommerce/checkout-sdk](../README.md) / BillingAddress
+
+# Interface: BillingAddress
+
+## Hierarchy
+
+- [`Address`](Address.md)
+
+  ↳ **`BillingAddress`**
+
+## Table of contents
+
+### Properties
+
+- [address1](BillingAddress.md#address1)
+- [address2](BillingAddress.md#address2)
+- [city](BillingAddress.md#city)
+- [company](BillingAddress.md#company)
+- [country](BillingAddress.md#country)
+- [countryCode](BillingAddress.md#countrycode)
+- [customFields](BillingAddress.md#customfields)
+- [email](BillingAddress.md#email)
+- [firstName](BillingAddress.md#firstname)
+- [id](BillingAddress.md#id)
+- [lastName](BillingAddress.md#lastname)
+- [phone](BillingAddress.md#phone)
+- [postalCode](BillingAddress.md#postalcode)
+- [shouldSaveAddress](BillingAddress.md#shouldsaveaddress)
+- [stateOrProvince](BillingAddress.md#stateorprovince)
+- [stateOrProvinceCode](BillingAddress.md#stateorprovincecode)
+
+## Properties
+
+### address1
+
+• **address1**: `string`
+
+#### Inherited from
+
+[Address](Address.md).[address1](Address.md#address1)
+
+___
+
+### address2
+
+• **address2**: `string`
+
+#### Inherited from
+
+[Address](Address.md).[address2](Address.md#address2)
+
+___
+
+### city
+
+• **city**: `string`
+
+#### Inherited from
+
+[Address](Address.md).[city](Address.md#city)
+
+___
+
+### company
+
+• **company**: `string`
+
+#### Inherited from
+
+[Address](Address.md).[company](Address.md#company)
+
+___
+
+### country
+
+• **country**: `string`
+
+#### Inherited from
+
+[Address](Address.md).[country](Address.md#country)
+
+___
+
+### countryCode
+
+• **countryCode**: `string`
+
+#### Inherited from
+
+[Address](Address.md).[countryCode](Address.md#countrycode)
+
+___
+
+### customFields
+
+• **customFields**: { `fieldId`: `string` ; `fieldValue`: `string` \| `number` \| `string`[]  }[]
+
+#### Inherited from
+
+[Address](Address.md).[customFields](Address.md#customfields)
+
+___
+
+### email
+
+• `Optional` **email**: `string`
+
+___
+
+### firstName
+
+• **firstName**: `string`
+
+#### Inherited from
+
+[Address](Address.md).[firstName](Address.md#firstname)
+
+___
+
+### id
+
+• **id**: `string`
+
+___
+
+### lastName
+
+• **lastName**: `string`
+
+#### Inherited from
+
+[Address](Address.md).[lastName](Address.md#lastname)
+
+___
+
+### phone
+
+• **phone**: `string`
+
+#### Inherited from
+
+[Address](Address.md).[phone](Address.md#phone)
+
+___
+
+### postalCode
+
+• **postalCode**: `string`
+
+#### Inherited from
+
+[Address](Address.md).[postalCode](Address.md#postalcode)
+
+___
+
+### shouldSaveAddress
+
+• `Optional` **shouldSaveAddress**: `boolean`
+
+#### Inherited from
+
+[Address](Address.md).[shouldSaveAddress](Address.md#shouldsaveaddress)
+
+___
+
+### stateOrProvince
+
+• **stateOrProvince**: `string`
+
+#### Inherited from
+
+[Address](Address.md).[stateOrProvince](Address.md#stateorprovince)
+
+___
+
+### stateOrProvinceCode
+
+• **stateOrProvinceCode**: `string`
+
+#### Inherited from
+
+[Address](Address.md).[stateOrProvinceCode](Address.md#stateorprovincecode)

package/docs/interfaces/BillingAddressRequestBody.md

@@ -0,0 +1,153 @@
+[@bigcommerce/checkout-sdk](../README.md) / BillingAddressRequestBody
+
+# Interface: BillingAddressRequestBody
+
+## Hierarchy
+
+- [`AddressRequestBody`](AddressRequestBody.md)
+
+  ↳ **`BillingAddressRequestBody`**
+
+## Table of contents
+
+### Properties
+
+- [address1](BillingAddressRequestBody.md#address1)
+- [address2](BillingAddressRequestBody.md#address2)
+- [city](BillingAddressRequestBody.md#city)
+- [company](BillingAddressRequestBody.md#company)
+- [countryCode](BillingAddressRequestBody.md#countrycode)
+- [customFields](BillingAddressRequestBody.md#customfields)
+- [email](BillingAddressRequestBody.md#email)
+- [firstName](BillingAddressRequestBody.md#firstname)
+- [lastName](BillingAddressRequestBody.md#lastname)
+- [phone](BillingAddressRequestBody.md#phone)
+- [postalCode](BillingAddressRequestBody.md#postalcode)
+- [stateOrProvince](BillingAddressRequestBody.md#stateorprovince)
+- [stateOrProvinceCode](BillingAddressRequestBody.md#stateorprovincecode)
+
+## Properties
+
+### address1
+
+• **address1**: `string`
+
+#### Inherited from
+
+[AddressRequestBody](AddressRequestBody.md).[address1](AddressRequestBody.md#address1)
+
+___
+
+### address2
+
+• **address2**: `string`
+
+#### Inherited from
+
+[AddressRequestBody](AddressRequestBody.md).[address2](AddressRequestBody.md#address2)
+
+___
+
+### city
+
+• **city**: `string`
+
+#### Inherited from
+
+[AddressRequestBody](AddressRequestBody.md).[city](AddressRequestBody.md#city)
+
+___
+
+### company
+
+• **company**: `string`
+
+#### Inherited from
+
+[AddressRequestBody](AddressRequestBody.md).[company](AddressRequestBody.md#company)
+
+___
+
+### countryCode
+
+• **countryCode**: `string`
+
+#### Inherited from
+
+[AddressRequestBody](AddressRequestBody.md).[countryCode](AddressRequestBody.md#countrycode)
+
+___
+
+### customFields
+
+• **customFields**: { `fieldId`: `string` ; `fieldValue`: `string` \| `number` \| `string`[]  }[]
+
+#### Inherited from
+
+[AddressRequestBody](AddressRequestBody.md).[customFields](AddressRequestBody.md#customfields)
+
+___
+
+### email
+
+• `Optional` **email**: `string`
+
+___
+
+### firstName
+
+• **firstName**: `string`
+
+#### Inherited from
+
+[AddressRequestBody](AddressRequestBody.md).[firstName](AddressRequestBody.md#firstname)
+
+___
+
+### lastName
+
+• **lastName**: `string`
+
+#### Inherited from
+
+[AddressRequestBody](AddressRequestBody.md).[lastName](AddressRequestBody.md#lastname)
+
+___
+
+### phone
+
+• **phone**: `string`
+
+#### Inherited from
+
+[AddressRequestBody](AddressRequestBody.md).[phone](AddressRequestBody.md#phone)
+
+___
+
+### postalCode
+
+• **postalCode**: `string`
+
+#### Inherited from
+
+[AddressRequestBody](AddressRequestBody.md).[postalCode](AddressRequestBody.md#postalcode)
+
+___
+
+### stateOrProvince
+
+• **stateOrProvince**: `string`
+
+#### Inherited from
+
+[AddressRequestBody](AddressRequestBody.md).[stateOrProvince](AddressRequestBody.md#stateorprovince)
+
+___
+
+### stateOrProvinceCode
+
+• **stateOrProvinceCode**: `string`
+
+#### Inherited from
+
+[AddressRequestBody](AddressRequestBody.md).[stateOrProvinceCode](AddressRequestBody.md#stateorprovincecode)

package/docs/interfaces/BlockElementStyles.md

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

package/docs/interfaces/BlueSnapV2PaymentInitializeOptions.md

@@ -0,0 +1,72 @@
+[@bigcommerce/checkout-sdk](../README.md) / BlueSnapV2PaymentInitializeOptions
+
+# Interface: BlueSnapV2PaymentInitializeOptions
+
+A set of options that are required to initialize the BlueSnap V2 payment
+method.
+
+The payment step is done through a web page via an iframe provided by the
+strategy.
+
+```html
+<!-- This is where the BlueSnap iframe will be inserted. It can be an in-page container or a modal -->
+<div id="container"></div>
+
+<!-- This is a cancellation button -->
+<button type="button" id="cancel-button"></button>
+```
+
+```js
+service.initializePayment({
+    methodId: 'bluesnapv2',
+    bluesnapv2: {
+        onLoad: (iframe) => {
+            document.getElementById('container')
+                .appendChild(iframe);
+
+            document.getElementById('cancel-button')
+                .addEventListener('click', () => {
+                    document.getElementById('container').innerHTML = '';
+                });
+        },
+    },
+});
+
+## Table of contents
+
+### Properties
+
+- [style](BlueSnapV2PaymentInitializeOptions.md#style)
+
+### Methods
+
+- [onLoad](BlueSnapV2PaymentInitializeOptions.md#onload)
+
+## Properties
+
+### style
+
+• `Optional` **style**: [`BlueSnapV2StyleProps`](BlueSnapV2StyleProps.md)
+
+A set of CSS properties to apply to the iframe.
+
+## Methods
+
+### onLoad
+
+▸ **onLoad**(`iframe`, `cancel`): `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
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `iframe` | `HTMLIFrameElement` | The iframe element containing the payment web page provided by the strategy. |
+| `cancel` | () => `void` | A function, when called, will cancel the payment process and remove the iframe. |
+
+#### Returns
+
+`void`