@bigcommerce/checkout-sdk 1.264.0 → 1.265.0

package/docs/interfaces/EmbeddedCheckoutMessenger.md

@@ -0,0 +1,109 @@
+[@bigcommerce/checkout-sdk](../README.md) / EmbeddedCheckoutMessenger
+
+# Interface: EmbeddedCheckoutMessenger
+
+## Table of contents
+
+### Methods
+
+- [postComplete](EmbeddedCheckoutMessenger.md#postcomplete)
+- [postError](EmbeddedCheckoutMessenger.md#posterror)
+- [postFrameError](EmbeddedCheckoutMessenger.md#postframeerror)
+- [postFrameLoaded](EmbeddedCheckoutMessenger.md#postframeloaded)
+- [postLoaded](EmbeddedCheckoutMessenger.md#postloaded)
+- [postSignedOut](EmbeddedCheckoutMessenger.md#postsignedout)
+- [receiveStyles](EmbeddedCheckoutMessenger.md#receivestyles)
+
+## Methods
+
+### postComplete
+
+▸ **postComplete**(): `void`
+
+#### Returns
+
+`void`
+
+___
+
+### postError
+
+▸ **postError**(`payload`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `payload` | `Error` \| [`CustomError`](CustomError.md) |
+
+#### Returns
+
+`void`
+
+___
+
+### postFrameError
+
+▸ **postFrameError**(`payload`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `payload` | `Error` \| [`CustomError`](CustomError.md) |
+
+#### Returns
+
+`void`
+
+___
+
+### postFrameLoaded
+
+▸ **postFrameLoaded**(`payload?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `payload?` | [`EmbeddedContentOptions`](EmbeddedContentOptions.md) |
+
+#### Returns
+
+`void`
+
+___
+
+### postLoaded
+
+▸ **postLoaded**(): `void`
+
+#### Returns
+
+`void`
+
+___
+
+### postSignedOut
+
+▸ **postSignedOut**(): `void`
+
+#### Returns
+
+`void`
+
+___
+
+### receiveStyles
+
+▸ **receiveStyles**(`handler`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `handler` | (`styles`: [`EmbeddedCheckoutStyles`](EmbeddedCheckoutStyles.md)) => `void` |
+
+#### Returns
+
+`void`

package/docs/interfaces/EmbeddedCheckoutMessengerOptions.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / EmbeddedCheckoutMessengerOptions
+
+# Interface: EmbeddedCheckoutMessengerOptions
+
+## Table of contents
+
+### Properties
+
+- [parentOrigin](EmbeddedCheckoutMessengerOptions.md#parentorigin)
+- [parentWindow](EmbeddedCheckoutMessengerOptions.md#parentwindow)
+
+## Properties
+
+### parentOrigin
+
+• **parentOrigin**: `string`
+
+___
+
+### parentWindow
+
+• `Optional` **parentWindow**: `Window`

package/docs/interfaces/EmbeddedCheckoutOptions.md

@@ -0,0 +1,134 @@
+[@bigcommerce/checkout-sdk](../README.md) / EmbeddedCheckoutOptions
+
+# Interface: EmbeddedCheckoutOptions
+
+## Table of contents
+
+### Properties
+
+- [containerId](EmbeddedCheckoutOptions.md#containerid)
+- [styles](EmbeddedCheckoutOptions.md#styles)
+- [url](EmbeddedCheckoutOptions.md#url)
+
+### Methods
+
+- [onComplete](EmbeddedCheckoutOptions.md#oncomplete)
+- [onError](EmbeddedCheckoutOptions.md#onerror)
+- [onFrameError](EmbeddedCheckoutOptions.md#onframeerror)
+- [onFrameLoad](EmbeddedCheckoutOptions.md#onframeload)
+- [onLoad](EmbeddedCheckoutOptions.md#onload)
+- [onSignOut](EmbeddedCheckoutOptions.md#onsignout)
+
+## Properties
+
+### containerId
+
+• **containerId**: `string`
+
+___
+
+### styles
+
+• `Optional` **styles**: [`EmbeddedCheckoutStyles`](EmbeddedCheckoutStyles.md)
+
+___
+
+### url
+
+• **url**: `string`
+
+## Methods
+
+### onComplete
+
+▸ `Optional` **onComplete**(`event`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `event` | [`EmbeddedCheckoutCompleteEvent`](EmbeddedCheckoutCompleteEvent.md) |
+
+#### Returns
+
+`void`
+
+___
+
+### onError
+
+▸ `Optional` **onError**(`event`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `event` | [`EmbeddedCheckoutErrorEvent`](EmbeddedCheckoutErrorEvent.md) |
+
+#### Returns
+
+`void`
+
+___
+
+### onFrameError
+
+▸ `Optional` **onFrameError**(`event`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `event` | [`EmbeddedCheckoutFrameErrorEvent`](EmbeddedCheckoutFrameErrorEvent.md) |
+
+#### Returns
+
+`void`
+
+___
+
+### onFrameLoad
+
+▸ `Optional` **onFrameLoad**(`event`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `event` | [`EmbeddedCheckoutFrameLoadedEvent`](EmbeddedCheckoutFrameLoadedEvent.md) |
+
+#### Returns
+
+`void`
+
+___
+
+### onLoad
+
+▸ `Optional` **onLoad**(`event`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `event` | [`EmbeddedCheckoutLoadedEvent`](EmbeddedCheckoutLoadedEvent.md) |
+
+#### Returns
+
+`void`
+
+___
+
+### onSignOut
+
+▸ `Optional` **onSignOut**(`event`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `event` | [`EmbeddedCheckoutSignedOutEvent`](EmbeddedCheckoutSignedOutEvent.md) |
+
+#### Returns
+
+`void`

package/docs/interfaces/EmbeddedCheckoutSignedOutEvent.md

@@ -0,0 +1,15 @@
+[@bigcommerce/checkout-sdk](../README.md) / EmbeddedCheckoutSignedOutEvent
+
+# Interface: EmbeddedCheckoutSignedOutEvent
+
+## Table of contents
+
+### Properties
+
+- [type](EmbeddedCheckoutSignedOutEvent.md#type)
+
+## Properties
+
+### type
+
+• **type**: [`SignedOut`](../enums/EmbeddedCheckoutEventType.md#signedout)

package/docs/interfaces/EmbeddedCheckoutStyles.md

@@ -0,0 +1,141 @@
+[@bigcommerce/checkout-sdk](../README.md) / EmbeddedCheckoutStyles
+
+# Interface: EmbeddedCheckoutStyles
+
+## Table of contents
+
+### Properties
+
+- [body](EmbeddedCheckoutStyles.md#body)
+- [button](EmbeddedCheckoutStyles.md#button)
+- [checkbox](EmbeddedCheckoutStyles.md#checkbox)
+- [checklist](EmbeddedCheckoutStyles.md#checklist)
+- [discountBanner](EmbeddedCheckoutStyles.md#discountbanner)
+- [heading](EmbeddedCheckoutStyles.md#heading)
+- [input](EmbeddedCheckoutStyles.md#input)
+- [label](EmbeddedCheckoutStyles.md#label)
+- [link](EmbeddedCheckoutStyles.md#link)
+- [loadingBanner](EmbeddedCheckoutStyles.md#loadingbanner)
+- [loadingIndicator](EmbeddedCheckoutStyles.md#loadingindicator)
+- [orderSummary](EmbeddedCheckoutStyles.md#ordersummary)
+- [radio](EmbeddedCheckoutStyles.md#radio)
+- [secondaryButton](EmbeddedCheckoutStyles.md#secondarybutton)
+- [secondaryHeading](EmbeddedCheckoutStyles.md#secondaryheading)
+- [secondaryText](EmbeddedCheckoutStyles.md#secondarytext)
+- [select](EmbeddedCheckoutStyles.md#select)
+- [step](EmbeddedCheckoutStyles.md#step)
+- [text](EmbeddedCheckoutStyles.md#text)
+
+## Properties
+
+### body
+
+• `Optional` **body**: [`BodyStyles`](BodyStyles.md)
+
+___
+
+### button
+
+• `Optional` **button**: [`ButtonStyles`](ButtonStyles.md)
+
+___
+
+### checkbox
+
+• `Optional` **checkbox**: [`CheckableInputStyles`](CheckableInputStyles.md)
+
+___
+
+### checklist
+
+• `Optional` **checklist**: [`ChecklistStyles`](ChecklistStyles.md)
+
+___
+
+### discountBanner
+
+• `Optional` **discountBanner**: [`BlockElementStyles`](BlockElementStyles.md)
+
+___
+
+### heading
+
+• `Optional` **heading**: [`BlockElementStyles`](BlockElementStyles.md)
+
+___
+
+### input
+
+• `Optional` **input**: [`TextInputStyles`](TextInputStyles.md)
+
+___
+
+### label
+
+• `Optional` **label**: [`LabelStyles`](LabelStyles.md)
+
+___
+
+### link
+
+• `Optional` **link**: [`LinkStyles`](LinkStyles.md)
+
+___
+
+### loadingBanner
+
+• `Optional` **loadingBanner**: [`BlockElementStyles`](BlockElementStyles.md)
+
+___
+
+### loadingIndicator
+
+• `Optional` **loadingIndicator**: [`LoadingIndicatorStyles`](LoadingIndicatorStyles.md)
+
+___
+
+### orderSummary
+
+• `Optional` **orderSummary**: [`BlockElementStyles`](BlockElementStyles.md)
+
+___
+
+### radio
+
+• `Optional` **radio**: [`CheckableInputStyles`](CheckableInputStyles.md)
+
+___
+
+### secondaryButton
+
+• `Optional` **secondaryButton**: [`ButtonStyles`](ButtonStyles.md)
+
+___
+
+### secondaryHeading
+
+• `Optional` **secondaryHeading**: [`BlockElementStyles`](BlockElementStyles.md)
+
+___
+
+### secondaryText
+
+• `Optional` **secondaryText**: [`InlineElementStyles`](InlineElementStyles.md)
+
+___
+
+### select
+
+• `Optional` **select**: [`InputStyles`](InputStyles.md)
+
+___
+
+### step
+
+• `Optional` **step**: [`StepStyles`](StepStyles.md)
+
+___
+
+### text
+
+• `Optional` **text**: [`InlineElementStyles`](InlineElementStyles.md)

package/docs/interfaces/EmbeddedContentOptions.md

@@ -0,0 +1,15 @@
+[@bigcommerce/checkout-sdk](../README.md) / EmbeddedContentOptions
+
+# Interface: EmbeddedContentOptions
+
+## Table of contents
+
+### Properties
+
+- [contentId](EmbeddedContentOptions.md#contentid)
+
+## Properties
+
+### contentId
+
+• `Optional` **contentId**: `string`

package/docs/interfaces/ExecutePaymentMethodCheckoutOptions.md

@@ -0,0 +1,76 @@
+[@bigcommerce/checkout-sdk](../README.md) / ExecutePaymentMethodCheckoutOptions
+
+# Interface: ExecutePaymentMethodCheckoutOptions
+
+A set of options that are required to pass the customer step of the
+current checkout flow.
+
+Some payment methods have specific suggestion for customer to pass
+the customer step. For example, Bolt suggests the customer to use
+their custom checkout with prefilled form values. As a result, you
+may need to provide additional information, error handler or callback
+to execution method.
+
+## Hierarchy
+
+- [`CustomerRequestOptions`](CustomerRequestOptions.md)
+
+  ↳ **`ExecutePaymentMethodCheckoutOptions`**
+
+## Table of contents
+
+### Properties
+
+- [methodId](ExecutePaymentMethodCheckoutOptions.md#methodid)
+- [params](ExecutePaymentMethodCheckoutOptions.md#params)
+- [timeout](ExecutePaymentMethodCheckoutOptions.md#timeout)
+
+### Methods
+
+- [continueWithCheckoutCallback](ExecutePaymentMethodCheckoutOptions.md#continuewithcheckoutcallback)
+
+## Properties
+
+### methodId
+
+• `Optional` **methodId**: `string`
+
+#### Inherited from
+
+[CustomerRequestOptions](CustomerRequestOptions.md).[methodId](CustomerRequestOptions.md#methodid)
+
+___
+
+### params
+
+• `Optional` **params**: `Object`
+
+The parameters of the request, if required.
+
+#### Inherited from
+
+[CustomerRequestOptions](CustomerRequestOptions.md).[params](CustomerRequestOptions.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
+
+[CustomerRequestOptions](CustomerRequestOptions.md).[timeout](CustomerRequestOptions.md#timeout)
+
+## Methods
+
+### continueWithCheckoutCallback
+
+▸ `Optional` **continueWithCheckoutCallback**(): `void`
+
+#### Returns
+
+`void`

package/docs/interfaces/FlashMessage.md

@@ -0,0 +1,29 @@
+[@bigcommerce/checkout-sdk](../README.md) / FlashMessage
+
+# Interface: FlashMessage
+
+## Table of contents
+
+### Properties
+
+- [message](FlashMessage.md#message)
+- [title](FlashMessage.md#title)
+- [type](FlashMessage.md#type)
+
+## Properties
+
+### message
+
+• **message**: `string`
+
+___
+
+### title
+
+• `Optional` **title**: `string`
+
+___
+
+### type
+
+• **type**: [`FlashMessageType`](../README.md#flashmessagetype)

package/docs/interfaces/FormField.md

@@ -0,0 +1,113 @@
+[@bigcommerce/checkout-sdk](../README.md) / FormField
+
+# Interface: FormField
+
+## Table of contents
+
+### Properties
+
+- [custom](FormField.md#custom)
+- [default](FormField.md#default)
+- [fieldType](FormField.md#fieldtype)
+- [id](FormField.md#id)
+- [itemtype](FormField.md#itemtype)
+- [label](FormField.md#label)
+- [max](FormField.md#max)
+- [maxLength](FormField.md#maxlength)
+- [min](FormField.md#min)
+- [name](FormField.md#name)
+- [options](FormField.md#options)
+- [required](FormField.md#required)
+- [requirements](FormField.md#requirements)
+- [secret](FormField.md#secret)
+- [type](FormField.md#type)
+
+## Properties
+
+### custom
+
+• **custom**: `boolean`
+
+___
+
+### default
+
+• `Optional` **default**: `string`
+
+___
+
+### fieldType
+
+• `Optional` **fieldType**: ``"checkbox"`` \| ``"date"`` \| ``"text"`` \| ``"dropdown"`` \| ``"password"`` \| ``"radio"`` \| ``"multiline"``
+
+___
+
+### id
+
+• **id**: `string`
+
+___
+
+### itemtype
+
+• `Optional` **itemtype**: `string`
+
+___
+
+### label
+
+• **label**: `string`
+
+___
+
+### max
+
+• `Optional` **max**: `string` \| `number`
+
+___
+
+### maxLength
+
+• `Optional` **maxLength**: `number`
+
+___
+
+### min
+
+• `Optional` **min**: `string` \| `number`
+
+___
+
+### name
+
+• **name**: `string`
+
+___
+
+### options
+
+• `Optional` **options**: [`FormFieldOptions`](FormFieldOptions.md)
+
+___
+
+### required
+
+• **required**: `boolean`
+
+___
+
+### requirements
+
+• `Optional` **requirements**: [`CustomerPasswordRequirements`](CustomerPasswordRequirements.md)
+
+___
+
+### secret
+
+• `Optional` **secret**: `boolean`
+
+___
+
+### type
+
+• `Optional` **type**: ``"string"`` \| ``"date"`` \| ``"array"`` \| ``"integer"``

package/docs/interfaces/FormFieldItem.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / FormFieldItem
+
+# Interface: FormFieldItem
+
+## Table of contents
+
+### Properties
+
+- [label](FormFieldItem.md#label)
+- [value](FormFieldItem.md#value)
+
+## Properties
+
+### label
+
+• **label**: `string`
+
+___
+
+### value
+
+• **value**: `string`

package/docs/interfaces/FormFieldOptions.md

@@ -0,0 +1,29 @@
+[@bigcommerce/checkout-sdk](../README.md) / FormFieldOptions
+
+# Interface: FormFieldOptions
+
+## Table of contents
+
+### Properties
+
+- [helperLabel](FormFieldOptions.md#helperlabel)
+- [items](FormFieldOptions.md#items)
+- [rows](FormFieldOptions.md#rows)
+
+## Properties
+
+### helperLabel
+
+• `Optional` **helperLabel**: `string`
+
+___
+
+### items
+
+• `Optional` **items**: [`FormFieldItem`](FormFieldItem.md)[]
+
+___
+
+### rows
+
+• `Optional` **rows**: `number`