@bigcommerce/checkout-sdk 1.308.2 → 1.308.3

package/docs/interfaces/internal_.ExecutePaymentMethodCheckoutOptions.md

@@ -1,95 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / ExecutePaymentMethodCheckoutOptions
-
-# Interface: ExecutePaymentMethodCheckoutOptions
-
-[<internal>](../modules/internal_.md).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`](internal_.CustomerRequestOptions.md)
-
-  ↳ **`ExecutePaymentMethodCheckoutOptions`**
-
-## Table of contents
-
-### Properties
-
-- [methodId](internal_.ExecutePaymentMethodCheckoutOptions.md#methodid)
-- [params](internal_.ExecutePaymentMethodCheckoutOptions.md#params)
-- [timeout](internal_.ExecutePaymentMethodCheckoutOptions.md#timeout)
-
-### Methods
-
-- [checkoutPaymentMethodExecuted](internal_.ExecutePaymentMethodCheckoutOptions.md#checkoutpaymentmethodexecuted)
-- [continueWithCheckoutCallback](internal_.ExecutePaymentMethodCheckoutOptions.md#continuewithcheckoutcallback)
-
-## Properties
-
-### methodId
-
-• `Optional` **methodId**: `string`
-
-#### Inherited from
-
-[CustomerRequestOptions](internal_.CustomerRequestOptions.md).[methodId](internal_.CustomerRequestOptions.md#methodid)
-
-___
-
-### params
-
-• `Optional` **params**: `Object`
-
-The parameters of the request, if required.
-
-#### Inherited from
-
-[CustomerRequestOptions](internal_.CustomerRequestOptions.md).[params](internal_.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](internal_.CustomerRequestOptions.md).[timeout](internal_.CustomerRequestOptions.md#timeout)
-
-## Methods
-
-### checkoutPaymentMethodExecuted
-
-▸ `Optional` **checkoutPaymentMethodExecuted**(`data?`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `data?` | [`CheckoutPaymentMethodExecutedOptions`](internal_.CheckoutPaymentMethodExecutedOptions.md) |
-
-#### Returns
-
-`void`
-
-___
-
-### continueWithCheckoutCallback
-
-▸ `Optional` **continueWithCheckoutCallback**(): `void`
-
-#### Returns
-
-`void`

package/docs/interfaces/internal_.FlashMessage.md

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

package/docs/interfaces/internal_.FormField.md

@@ -1,115 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / FormField
-
-# Interface: FormField
-
-[<internal>](../modules/internal_.md).FormField
-
-## Table of contents
-
-### Properties
-
-- [custom](internal_.FormField.md#custom)
-- [default](internal_.FormField.md#default)
-- [fieldType](internal_.FormField.md#fieldtype)
-- [id](internal_.FormField.md#id)
-- [itemtype](internal_.FormField.md#itemtype)
-- [label](internal_.FormField.md#label)
-- [max](internal_.FormField.md#max)
-- [maxLength](internal_.FormField.md#maxlength)
-- [min](internal_.FormField.md#min)
-- [name](internal_.FormField.md#name)
-- [options](internal_.FormField.md#options)
-- [required](internal_.FormField.md#required)
-- [requirements](internal_.FormField.md#requirements)
-- [secret](internal_.FormField.md#secret)
-- [type](internal_.FormField.md#type)
-
-## Properties
-
-### custom
-
-• **custom**: `boolean`
-
-___
-
-### default
-
-• `Optional` **default**: `string`
-
-___
-
-### fieldType
-
-• `Optional` **fieldType**: [`FormFieldFieldType`](../modules/internal_.md#formfieldfieldtype)
-
-___
-
-### 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`](internal_.FormFieldOptions.md)
-
-___
-
-### required
-
-• **required**: `boolean`
-
-___
-
-### requirements
-
-• `Optional` **requirements**: [`CustomerPasswordRequirements`](internal_.CustomerPasswordRequirements.md)
-
-___
-
-### secret
-
-• `Optional` **secret**: `boolean`
-
-___
-
-### type
-
-• `Optional` **type**: [`FormFieldType`](../modules/internal_.md#formfieldtype)

package/docs/interfaces/internal_.FormFieldItem.md

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

package/docs/interfaces/internal_.FormFieldOptions.md

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

package/docs/interfaces/internal_.FormFields.md

@@ -1,31 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / FormFields
-
-# Interface: FormFields
-
-[<internal>](../modules/internal_.md).FormFields
-
-## Table of contents
-
-### Properties
-
-- [billingAddress](internal_.FormFields.md#billingaddress)
-- [customerAccount](internal_.FormFields.md#customeraccount)
-- [shippingAddress](internal_.FormFields.md#shippingaddress)
-
-## Properties
-
-### billingAddress
-
-• **billingAddress**: [`FormField`](internal_.FormField.md)[]
-
-___
-
-### customerAccount
-
-• **customerAccount**: [`FormField`](internal_.FormField.md)[]
-
-___
-
-### shippingAddress
-
-• **shippingAddress**: [`FormField`](internal_.FormField.md)[]

package/docs/interfaces/internal_.GatewayOrderPayment.md

@@ -1,110 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / GatewayOrderPayment
-
-# Interface: GatewayOrderPayment
-
-[<internal>](../modules/internal_.md).GatewayOrderPayment
-
-## Hierarchy
-
-- [`OrderPayment`](internal_.OrderPayment.md)
-
-  ↳ **`GatewayOrderPayment`**
-
-## Table of contents
-
-### Properties
-
-- [amount](internal_.GatewayOrderPayment.md#amount)
-- [description](internal_.GatewayOrderPayment.md#description)
-- [detail](internal_.GatewayOrderPayment.md#detail)
-- [gatewayId](internal_.GatewayOrderPayment.md#gatewayid)
-- [mandate](internal_.GatewayOrderPayment.md#mandate)
-- [methodId](internal_.GatewayOrderPayment.md#methodid)
-- [paymentId](internal_.GatewayOrderPayment.md#paymentid)
-- [providerId](internal_.GatewayOrderPayment.md#providerid)
-
-## Properties
-
-### amount
-
-• **amount**: `number`
-
-#### Inherited from
-
-[OrderPayment](internal_.OrderPayment.md).[amount](internal_.OrderPayment.md#amount)
-
-___
-
-### description
-
-• **description**: `string`
-
-#### Inherited from
-
-[OrderPayment](internal_.OrderPayment.md).[description](internal_.OrderPayment.md#description)
-
-___
-
-### detail
-
-• **detail**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `instructions` | `string` |
-| `step` | `string` |
-
-___
-
-### gatewayId
-
-• `Optional` **gatewayId**: `string`
-
-#### Inherited from
-
-[OrderPayment](internal_.OrderPayment.md).[gatewayId](internal_.OrderPayment.md#gatewayid)
-
-___
-
-### mandate
-
-• `Optional` **mandate**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `id` | `string` |
-| `url?` | `string` |
-
-___
-
-### methodId
-
-• `Optional` **methodId**: `string`
-
-#### Inherited from
-
-[OrderPayment](internal_.OrderPayment.md).[methodId](internal_.OrderPayment.md#methodid)
-
-___
-
-### paymentId
-
-• `Optional` **paymentId**: `string`
-
-#### Inherited from
-
-[OrderPayment](internal_.OrderPayment.md).[paymentId](internal_.OrderPayment.md#paymentid)
-
-___
-
-### providerId
-
-• **providerId**: `string`
-
-#### Inherited from
-
-[OrderPayment](internal_.OrderPayment.md).[providerId](internal_.OrderPayment.md#providerid)

package/docs/interfaces/internal_.GiftCertificate.md

@@ -1,45 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / GiftCertificate
-
-# Interface: GiftCertificate
-
-[<internal>](../modules/internal_.md).GiftCertificate
-
-## Table of contents
-
-### Properties
-
-- [balance](internal_.GiftCertificate.md#balance)
-- [code](internal_.GiftCertificate.md#code)
-- [purchaseDate](internal_.GiftCertificate.md#purchasedate)
-- [remaining](internal_.GiftCertificate.md#remaining)
-- [used](internal_.GiftCertificate.md#used)
-
-## Properties
-
-### balance
-
-• **balance**: `number`
-
-___
-
-### code
-
-• **code**: `string`
-
-___
-
-### purchaseDate
-
-• **purchaseDate**: `string`
-
-___
-
-### remaining
-
-• **remaining**: `number`
-
-___
-
-### used
-
-• **used**: `number`

package/docs/interfaces/internal_.GiftCertificateItem.md

@@ -1,80 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / GiftCertificateItem
-
-# Interface: GiftCertificateItem
-
-[<internal>](../modules/internal_.md).GiftCertificateItem
-
-## Table of contents
-
-### Properties
-
-- [amount](internal_.GiftCertificateItem.md#amount)
-- [id](internal_.GiftCertificateItem.md#id)
-- [message](internal_.GiftCertificateItem.md#message)
-- [name](internal_.GiftCertificateItem.md#name)
-- [recipient](internal_.GiftCertificateItem.md#recipient)
-- [sender](internal_.GiftCertificateItem.md#sender)
-- [taxable](internal_.GiftCertificateItem.md#taxable)
-- [theme](internal_.GiftCertificateItem.md#theme)
-
-## Properties
-
-### amount
-
-• **amount**: `number`
-
-___
-
-### id
-
-• **id**: `string` \| `number`
-
-___
-
-### message
-
-• **message**: `string`
-
-___
-
-### name
-
-• **name**: `string`
-
-___
-
-### recipient
-
-• **recipient**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `email` | `string` |
-| `name` | `string` |
-
-___
-
-### sender
-
-• **sender**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `email` | `string` |
-| `name` | `string` |
-
-___
-
-### taxable
-
-• **taxable**: `boolean`
-
-___
-
-### theme
-
-• **theme**: `string`

package/docs/interfaces/internal_.GiftCertificateOrderPayment.md

@@ -1,96 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / GiftCertificateOrderPayment
-
-# Interface: GiftCertificateOrderPayment
-
-[<internal>](../modules/internal_.md).GiftCertificateOrderPayment
-
-## Hierarchy
-
-- [`OrderPayment`](internal_.OrderPayment.md)
-
-  ↳ **`GiftCertificateOrderPayment`**
-
-## Table of contents
-
-### Properties
-
-- [amount](internal_.GiftCertificateOrderPayment.md#amount)
-- [description](internal_.GiftCertificateOrderPayment.md#description)
-- [detail](internal_.GiftCertificateOrderPayment.md#detail)
-- [gatewayId](internal_.GiftCertificateOrderPayment.md#gatewayid)
-- [methodId](internal_.GiftCertificateOrderPayment.md#methodid)
-- [paymentId](internal_.GiftCertificateOrderPayment.md#paymentid)
-- [providerId](internal_.GiftCertificateOrderPayment.md#providerid)
-
-## Properties
-
-### amount
-
-• **amount**: `number`
-
-#### Inherited from
-
-[OrderPayment](internal_.OrderPayment.md).[amount](internal_.OrderPayment.md#amount)
-
-___
-
-### description
-
-• **description**: `string`
-
-#### Inherited from
-
-[OrderPayment](internal_.OrderPayment.md).[description](internal_.OrderPayment.md#description)
-
-___
-
-### detail
-
-• **detail**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `code` | `string` |
-| `remaining` | `number` |
-
-___
-
-### gatewayId
-
-• `Optional` **gatewayId**: `string`
-
-#### Inherited from
-
-[OrderPayment](internal_.OrderPayment.md).[gatewayId](internal_.OrderPayment.md#gatewayid)
-
-___
-
-### methodId
-
-• `Optional` **methodId**: `string`
-
-#### Inherited from
-
-[OrderPayment](internal_.OrderPayment.md).[methodId](internal_.OrderPayment.md#methodid)
-
-___
-
-### paymentId
-
-• `Optional` **paymentId**: `string`
-
-#### Inherited from
-
-[OrderPayment](internal_.OrderPayment.md).[paymentId](internal_.OrderPayment.md#paymentid)
-
-___
-
-### providerId
-
-• **providerId**: `string`
-
-#### Inherited from
-
-[OrderPayment](internal_.OrderPayment.md).[providerId](internal_.OrderPayment.md#providerid)