@bigcommerce/checkout-sdk 1.308.1 → 1.308.2

package/docs/interfaces/internal_.ShippingRequestOptions.md

@@ -0,0 +1,67 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / ShippingRequestOptions
+
+# Interface: ShippingRequestOptions<T\>
+
+[<internal>](../modules/internal_.md).ShippingRequestOptions
+
+A set of options for configuring any requests related to the shipping step of
+the current checkout flow.
+
+Some payment methods have their own shipping configuration flow. Therefore,
+you need to specify the method you intend to use if you want to trigger a
+specific flow for setting the shipping address or option. Otherwise, these
+options are not required.
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | {} |
+
+## Hierarchy
+
+- [`RequestOptions`](internal_.RequestOptions.md)<`T`\>
+
+  ↳ **`ShippingRequestOptions`**
+
+  ↳↳ [`ShippingInitializeOptions`](internal_.ShippingInitializeOptions.md)
+
+## Table of contents
+
+### Properties
+
+- [methodId](internal_.ShippingRequestOptions.md#methodid)
+- [params](internal_.ShippingRequestOptions.md#params)
+- [timeout](internal_.ShippingRequestOptions.md#timeout)
+
+## Properties
+
+### methodId
+
+• `Optional` **methodId**: `string`
+
+___
+
+### params
+
+• `Optional` **params**: `T`
+
+The parameters of the request, if required.
+
+#### Inherited from
+
+[RequestOptions](internal_.RequestOptions.md).[params](internal_.RequestOptions.md#params)
+
+___
+
+### 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
+
+[RequestOptions](internal_.RequestOptions.md).[timeout](internal_.RequestOptions.md#timeout)

package/docs/interfaces/internal_.ShopperConfig.md

@@ -0,0 +1,31 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / ShopperConfig
+
+# Interface: ShopperConfig
+
+[<internal>](../modules/internal_.md).ShopperConfig
+
+## Table of contents
+
+### Properties
+
+- [defaultNewsletterSignup](internal_.ShopperConfig.md#defaultnewslettersignup)
+- [passwordRequirements](internal_.ShopperConfig.md#passwordrequirements)
+- [showNewsletterSignup](internal_.ShopperConfig.md#shownewslettersignup)
+
+## Properties
+
+### defaultNewsletterSignup
+
+• **defaultNewsletterSignup**: `boolean`
+
+___
+
+### passwordRequirements
+
+• **passwordRequirements**: [`PasswordRequirements`](internal_.PasswordRequirements.md)
+
+___
+
+### showNewsletterSignup
+
+• **showNewsletterSignup**: `boolean`

package/docs/interfaces/internal_.ShopperCurrency.md

@@ -0,0 +1,96 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / ShopperCurrency
+
+# Interface: ShopperCurrency
+
+[<internal>](../modules/internal_.md).ShopperCurrency
+
+## Hierarchy
+
+- [`StoreCurrency`](internal_.StoreCurrency.md)
+
+  ↳ **`ShopperCurrency`**
+
+## Table of contents
+
+### Properties
+
+- [code](internal_.ShopperCurrency.md#code)
+- [decimalPlaces](internal_.ShopperCurrency.md#decimalplaces)
+- [decimalSeparator](internal_.ShopperCurrency.md#decimalseparator)
+- [exchangeRate](internal_.ShopperCurrency.md#exchangerate)
+- [isTransactional](internal_.ShopperCurrency.md#istransactional)
+- [symbol](internal_.ShopperCurrency.md#symbol)
+- [symbolLocation](internal_.ShopperCurrency.md#symbollocation)
+- [thousandsSeparator](internal_.ShopperCurrency.md#thousandsseparator)
+
+## Properties
+
+### code
+
+• **code**: `string`
+
+#### Inherited from
+
+[StoreCurrency](internal_.StoreCurrency.md).[code](internal_.StoreCurrency.md#code)
+
+___
+
+### decimalPlaces
+
+• **decimalPlaces**: `string`
+
+#### Inherited from
+
+[StoreCurrency](internal_.StoreCurrency.md).[decimalPlaces](internal_.StoreCurrency.md#decimalplaces)
+
+___
+
+### decimalSeparator
+
+• **decimalSeparator**: `string`
+
+#### Inherited from
+
+[StoreCurrency](internal_.StoreCurrency.md).[decimalSeparator](internal_.StoreCurrency.md#decimalseparator)
+
+___
+
+### exchangeRate
+
+• **exchangeRate**: `number`
+
+___
+
+### isTransactional
+
+• **isTransactional**: `boolean`
+
+___
+
+### symbol
+
+• **symbol**: `string`
+
+#### Inherited from
+
+[StoreCurrency](internal_.StoreCurrency.md).[symbol](internal_.StoreCurrency.md#symbol)
+
+___
+
+### symbolLocation
+
+• **symbolLocation**: `string`
+
+#### Inherited from
+
+[StoreCurrency](internal_.StoreCurrency.md).[symbolLocation](internal_.StoreCurrency.md#symbollocation)
+
+___
+
+### thousandsSeparator
+
+• **thousandsSeparator**: `string`
+
+#### Inherited from
+
+[StoreCurrency](internal_.StoreCurrency.md).[thousandsSeparator](internal_.StoreCurrency.md#thousandsseparator)

package/docs/interfaces/internal_.SignInEmail.md

@@ -0,0 +1,24 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / SignInEmail
+
+# Interface: SignInEmail
+
+[<internal>](../modules/internal_.md).SignInEmail
+
+## Table of contents
+
+### Properties
+
+- [expiry](internal_.SignInEmail.md#expiry)
+- [sent\_email](internal_.SignInEmail.md#sent_email)
+
+## Properties
+
+### expiry
+
+• **expiry**: `number`
+
+___
+
+### sent\_email
+
+• **sent\_email**: `string`

package/docs/interfaces/internal_.SignInEmailRequestBody.md

@@ -0,0 +1,24 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / SignInEmailRequestBody
+
+# Interface: SignInEmailRequestBody
+
+[<internal>](../modules/internal_.md).SignInEmailRequestBody
+
+## Table of contents
+
+### Properties
+
+- [email](internal_.SignInEmailRequestBody.md#email)
+- [redirectUrl](internal_.SignInEmailRequestBody.md#redirecturl)
+
+## Properties
+
+### email
+
+• **email**: `string`
+
+___
+
+### redirectUrl
+
+• `Optional` **redirectUrl**: `string`

package/docs/interfaces/internal_.SpamProtectionOptions.md

@@ -0,0 +1,27 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / SpamProtectionOptions
+
+# Interface: SpamProtectionOptions
+
+[<internal>](../modules/internal_.md).SpamProtectionOptions
+
+The set of options for configuring any requests related to spam protection.
+
+## Hierarchy
+
+- `default`
+
+  ↳ **`SpamProtectionOptions`**
+
+## Table of contents
+
+### Properties
+
+- [containerId](internal_.SpamProtectionOptions.md#containerid)
+
+## Properties
+
+### containerId
+
+• **containerId**: `string`
+
+The container ID where the spam protection should be rendered.

package/docs/interfaces/internal_.SquareFormElement.md

@@ -0,0 +1,30 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / SquareFormElement
+
+# Interface: SquareFormElement
+
+[<internal>](../modules/internal_.md).SquareFormElement
+
+Configures any form element provided by Square payment.
+
+## Table of contents
+
+### Properties
+
+- [elementId](internal_.SquareFormElement.md#elementid)
+- [placeholder](internal_.SquareFormElement.md#placeholder)
+
+## Properties
+
+### elementId
+
+• **elementId**: `string`
+
+The ID of the container which the form element should insert into.
+
+___
+
+### placeholder
+
+• `Optional` **placeholder**: `string`
+
+The placeholder text to use for the form element, if provided.

package/docs/interfaces/internal_.SquarePaymentInitializeOptions.md

@@ -0,0 +1,133 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / SquarePaymentInitializeOptions
+
+# Interface: SquarePaymentInitializeOptions
+
+[<internal>](../modules/internal_.md).SquarePaymentInitializeOptions
+
+A set of options that are required to initialize the Square payment method.
+
+Once Square 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
+<!-- These containers are where the hosted (iframed) credit card fields will be inserted -->
+<div id="card-number"></div>
+<div id="card-name"></div>
+<div id="card-expiry"></div>
+<div id="card-code"></div>
+```
+
+```js
+service.initializePayment({
+    methodId: 'squarev2',
+    square: {
+        cardNumber: {
+            elementId: 'card-number',
+        },
+        cvv: {
+            elementId: 'card-code',
+        },
+        expirationDate: {
+            elementId: 'card-expiry',
+        },
+        postalCode: {
+            elementId: 'card-code',
+        },
+    },
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [cardNumber](internal_.SquarePaymentInitializeOptions.md#cardnumber)
+- [cvv](internal_.SquarePaymentInitializeOptions.md#cvv)
+- [expirationDate](internal_.SquarePaymentInitializeOptions.md#expirationdate)
+- [inputClass](internal_.SquarePaymentInitializeOptions.md#inputclass)
+- [inputStyles](internal_.SquarePaymentInitializeOptions.md#inputstyles)
+- [postalCode](internal_.SquarePaymentInitializeOptions.md#postalcode)
+
+### Methods
+
+- [onError](internal_.SquarePaymentInitializeOptions.md#onerror)
+- [onPaymentSelect](internal_.SquarePaymentInitializeOptions.md#onpaymentselect)
+
+## Properties
+
+### cardNumber
+
+• **cardNumber**: [`SquareFormElement`](internal_.SquareFormElement.md)
+
+The location to insert the credit card number form field.
+
+___
+
+### cvv
+
+• **cvv**: [`SquareFormElement`](internal_.SquareFormElement.md)
+
+The location to insert the CVV form field.
+
+___
+
+### expirationDate
+
+• **expirationDate**: [`SquareFormElement`](internal_.SquareFormElement.md)
+
+The location to insert the expiration date form field.
+
+___
+
+### inputClass
+
+• `Optional` **inputClass**: `string`
+
+The CSS class to apply to all form fields.
+
+___
+
+### inputStyles
+
+• `Optional` **inputStyles**: { `[key: string]`: `string`;  }[]
+
+The set of CSS styles to apply to all form fields.
+
+___
+
+### postalCode
+
+• **postalCode**: [`SquareFormElement`](internal_.SquareFormElement.md)
+
+The location to insert the postal code form field.
+
+## Methods
+
+### onError
+
+▸ `Optional` **onError**(`errors?`): `void`
+
+A callback that gets called when an error occurs in the card nonce generation
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `errors?` | [`NonceGenerationError`](internal_.NonceGenerationError.md)[] |
+
+#### Returns
+
+`void`
+
+___
+
+### onPaymentSelect
+
+▸ `Optional` **onPaymentSelect**(): `void`
+
+A callback that gets called when the customer selects a payment option.
+
+#### Returns
+
+`void`

package/docs/interfaces/internal_.StepStyles.md

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

package/docs/interfaces/internal_.StepTracker.md

@@ -0,0 +1,66 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StepTracker
+
+# Interface: StepTracker
+
+[<internal>](../modules/internal_.md).StepTracker
+
+## Table of contents
+
+### Methods
+
+- [trackCheckoutStarted](internal_.StepTracker.md#trackcheckoutstarted)
+- [trackOrderComplete](internal_.StepTracker.md#trackordercomplete)
+- [trackStepCompleted](internal_.StepTracker.md#trackstepcompleted)
+- [trackStepViewed](internal_.StepTracker.md#trackstepviewed)
+
+## Methods
+
+### trackCheckoutStarted
+
+▸ **trackCheckoutStarted**(): `void`
+
+#### Returns
+
+`void`
+
+___
+
+### trackOrderComplete
+
+▸ **trackOrderComplete**(): `void`
+
+#### Returns
+
+`void`
+
+___
+
+### trackStepCompleted
+
+▸ **trackStepCompleted**(`step`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `step` | `string` |
+
+#### Returns
+
+`void`
+
+___
+
+### trackStepViewed
+
+▸ **trackStepViewed**(`step`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `step` | `string` |
+
+#### Returns
+
+`void`

package/docs/interfaces/internal_.StepTrackerConfig.md

@@ -0,0 +1,17 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StepTrackerConfig
+
+# Interface: StepTrackerConfig
+
+[<internal>](../modules/internal_.md).StepTrackerConfig
+
+## Table of contents
+
+### Properties
+
+- [checkoutSteps](internal_.StepTrackerConfig.md#checkoutsteps)
+
+## Properties
+
+### checkoutSteps
+
+• `Optional` **checkoutSteps**: [`AnalyticStepType`](../modules/internal_.md#analyticsteptype)[]