@bigcommerce/checkout-sdk 1.264.1 → 1.264.2

package/docs/interfaces/embeddedcheckoutstyles.md

@@ -1,145 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [EmbeddedCheckoutStyles](embeddedcheckoutstyles.md)
-
-# Interface: EmbeddedCheckoutStyles
-
-## Hierarchy
-
-* **EmbeddedCheckoutStyles**
-
-## Index
-
-### Properties
-
-* [body](embeddedcheckoutstyles.md#optional-body)
-* [button](embeddedcheckoutstyles.md#optional-button)
-* [checkbox](embeddedcheckoutstyles.md#optional-checkbox)
-* [checklist](embeddedcheckoutstyles.md#optional-checklist)
-* [discountBanner](embeddedcheckoutstyles.md#optional-discountbanner)
-* [heading](embeddedcheckoutstyles.md#optional-heading)
-* [input](embeddedcheckoutstyles.md#optional-input)
-* [label](embeddedcheckoutstyles.md#optional-label)
-* [link](embeddedcheckoutstyles.md#optional-link)
-* [loadingBanner](embeddedcheckoutstyles.md#optional-loadingbanner)
-* [loadingIndicator](embeddedcheckoutstyles.md#optional-loadingindicator)
-* [orderSummary](embeddedcheckoutstyles.md#optional-ordersummary)
-* [radio](embeddedcheckoutstyles.md#optional-radio)
-* [secondaryButton](embeddedcheckoutstyles.md#optional-secondarybutton)
-* [secondaryHeading](embeddedcheckoutstyles.md#optional-secondaryheading)
-* [secondaryText](embeddedcheckoutstyles.md#optional-secondarytext)
-* [select](embeddedcheckoutstyles.md#optional-select)
-* [step](embeddedcheckoutstyles.md#optional-step)
-* [text](embeddedcheckoutstyles.md#optional-text)
-
-## Properties
-
-### `Optional` body
-
-• **body**? : *[BodyStyles](bodystyles.md)*
-
-___
-
-### `Optional` button
-
-• **button**? : *[ButtonStyles](buttonstyles.md)*
-
-___
-
-### `Optional` checkbox
-
-• **checkbox**? : *[CheckableInputStyles](checkableinputstyles.md)*
-
-___
-
-### `Optional` checklist
-
-• **checklist**? : *[ChecklistStyles](checkliststyles.md)*
-
-___
-
-### `Optional` discountBanner
-
-• **discountBanner**? : *[BlockElementStyles](blockelementstyles.md)*
-
-___
-
-### `Optional` heading
-
-• **heading**? : *[BlockElementStyles](blockelementstyles.md)*
-
-___
-
-### `Optional` input
-
-• **input**? : *[TextInputStyles](textinputstyles.md)*
-
-___
-
-### `Optional` label
-
-• **label**? : *[LabelStyles](labelstyles.md)*
-
-___
-
-### `Optional` link
-
-• **link**? : *[LinkStyles](linkstyles.md)*
-
-___
-
-### `Optional` loadingBanner
-
-• **loadingBanner**? : *[BlockElementStyles](blockelementstyles.md)*
-
-___
-
-### `Optional` loadingIndicator
-
-• **loadingIndicator**? : *[LoadingIndicatorStyles](loadingindicatorstyles.md)*
-
-___
-
-### `Optional` orderSummary
-
-• **orderSummary**? : *[BlockElementStyles](blockelementstyles.md)*
-
-___
-
-### `Optional` radio
-
-• **radio**? : *[CheckableInputStyles](checkableinputstyles.md)*
-
-___
-
-### `Optional` secondaryButton
-
-• **secondaryButton**? : *[ButtonStyles](buttonstyles.md)*
-
-___
-
-### `Optional` secondaryHeading
-
-• **secondaryHeading**? : *[BlockElementStyles](blockelementstyles.md)*
-
-___
-
-### `Optional` secondaryText
-
-• **secondaryText**? : *[InlineElementStyles](inlineelementstyles.md)*
-
-___
-
-### `Optional` select
-
-• **select**? : *[InputStyles](inputstyles.md)*
-
-___
-
-### `Optional` step
-
-• **step**? : *[StepStyles](stepstyles.md)*
-
-___
-
-### `Optional` text
-
-• **text**? : *[InlineElementStyles](inlineelementstyles.md)*

package/docs/interfaces/embeddedcontentoptions.md

@@ -1,19 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [EmbeddedContentOptions](embeddedcontentoptions.md)
-
-# Interface: EmbeddedContentOptions
-
-## Hierarchy
-
-* **EmbeddedContentOptions**
-
-## Index
-
-### Properties
-
-* [contentId](embeddedcontentoptions.md#optional-contentid)
-
-## Properties
-
-### `Optional` contentId
-
-• **contentId**? : *undefined | string*

package/docs/interfaces/executepaymentmethodcheckoutoptions.md

@@ -1,72 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [ExecutePaymentMethodCheckoutOptions](executepaymentmethodcheckoutoptions.md)
-
-# Interface: ExecutePaymentMethodCheckoutOptions ‹**TParams**›
-
-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.
-
-## Type parameters
-
-▪ **TParams**
-
-## Hierarchy
-
-  ↳ [CustomerRequestOptions](customerrequestoptions.md)
-
-  ↳ **ExecutePaymentMethodCheckoutOptions**
-
-## Index
-
-### Properties
-
-* [methodId](executepaymentmethodcheckoutoptions.md#optional-methodid)
-* [params](executepaymentmethodcheckoutoptions.md#optional-params)
-* [timeout](executepaymentmethodcheckoutoptions.md#optional-timeout)
-
-### Methods
-
-* [continueWithCheckoutCallback](executepaymentmethodcheckoutoptions.md#optional-continuewithcheckoutcallback)
-
-## Properties
-
-### `Optional` methodId
-
-• **methodId**? : *undefined | string*
-
-*Inherited from [CustomerInitializeOptions](customerinitializeoptions.md).[methodId](customerinitializeoptions.md#optional-methodid)*
-
-___
-
-### `Optional` params
-
-• **params**? : *TParams*
-
-*Inherited from [CheckoutButtonInitializeOptions](checkoutbuttoninitializeoptions.md).[params](checkoutbuttoninitializeoptions.md#optional-params)*
-
-The parameters of the request, if required.
-
-___
-
-### `Optional` timeout
-
-• **timeout**? : *Timeout*
-
-*Inherited from [CheckoutButtonInitializeOptions](checkoutbuttoninitializeoptions.md).[timeout](checkoutbuttoninitializeoptions.md#optional-timeout)*
-
-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.
-
-## Methods
-
-### `Optional` continueWithCheckoutCallback
-
-▸ **continueWithCheckoutCallback**(): *void*
-
-**Returns:** *void*

package/docs/interfaces/flashmessage.md

@@ -1,33 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [FlashMessage](flashmessage.md)
-
-# Interface: FlashMessage
-
-## Hierarchy
-
-* **FlashMessage**
-
-## Index
-
-### Properties
-
-* [message](flashmessage.md#message)
-* [title](flashmessage.md#optional-title)
-* [type](flashmessage.md#type)
-
-## Properties
-
-###  message
-
-• **message**: *string*
-
-___
-
-### `Optional` title
-
-• **title**? : *undefined | string*
-
-___
-
-###  type
-
-• **type**: *[FlashMessageType](../README.md#flashmessagetype)*

package/docs/interfaces/formfield.md

@@ -1,117 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [FormField](formfield.md)
-
-# Interface: FormField
-
-## Hierarchy
-
-* **FormField**
-
-## Index
-
-### Properties
-
-* [custom](formfield.md#custom)
-* [default](formfield.md#optional-default)
-* [fieldType](formfield.md#optional-fieldtype)
-* [id](formfield.md#id)
-* [itemtype](formfield.md#optional-itemtype)
-* [label](formfield.md#label)
-* [max](formfield.md#optional-max)
-* [maxLength](formfield.md#optional-maxlength)
-* [min](formfield.md#optional-min)
-* [name](formfield.md#name)
-* [options](formfield.md#optional-options)
-* [required](formfield.md#required)
-* [requirements](formfield.md#optional-requirements)
-* [secret](formfield.md#optional-secret)
-* [type](formfield.md#optional-type)
-
-## Properties
-
-###  custom
-
-• **custom**: *boolean*
-
-___
-
-### `Optional` default
-
-• **default**? : *undefined | string*
-
-___
-
-### `Optional` fieldType
-
-• **fieldType**? : *[FormFieldFieldType](../README.md#formfieldfieldtype)*
-
-___
-
-###  id
-
-• **id**: *string*
-
-___
-
-### `Optional` itemtype
-
-• **itemtype**? : *undefined | string*
-
-___
-
-###  label
-
-• **label**: *string*
-
-___
-
-### `Optional` max
-
-• **max**? : *string | number*
-
-___
-
-### `Optional` maxLength
-
-• **maxLength**? : *undefined | number*
-
-___
-
-### `Optional` min
-
-• **min**? : *string | number*
-
-___
-
-###  name
-
-• **name**: *string | [AddressKey](../README.md#addresskey)*
-
-___
-
-### `Optional` options
-
-• **options**? : *[FormFieldOptions](formfieldoptions.md)*
-
-___
-
-###  required
-
-• **required**: *boolean*
-
-___
-
-### `Optional` requirements
-
-• **requirements**? : *[CustomerPasswordRequirements](customerpasswordrequirements.md)*
-
-___
-
-### `Optional` secret
-
-• **secret**? : *undefined | false | true*
-
-___
-
-### `Optional` type
-
-• **type**? : *[FormFieldType](../README.md#formfieldtype)*

package/docs/interfaces/formfielditem.md

@@ -1,26 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [FormFieldItem](formfielditem.md)
-
-# Interface: FormFieldItem
-
-## Hierarchy
-
-* **FormFieldItem**
-
-## Index
-
-### Properties
-
-* [label](formfielditem.md#label)
-* [value](formfielditem.md#value)
-
-## Properties
-
-###  label
-
-• **label**: *string*
-
-___
-
-###  value
-
-• **value**: *string*

package/docs/interfaces/formfieldoptions.md

@@ -1,33 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [FormFieldOptions](formfieldoptions.md)
-
-# Interface: FormFieldOptions
-
-## Hierarchy
-
-* **FormFieldOptions**
-
-## Index
-
-### Properties
-
-* [helperLabel](formfieldoptions.md#optional-helperlabel)
-* [items](formfieldoptions.md#optional-items)
-* [rows](formfieldoptions.md#optional-rows)
-
-## Properties
-
-### `Optional` helperLabel
-
-• **helperLabel**? : *undefined | string*
-
-___
-
-### `Optional` items
-
-• **items**? : *[FormFieldItem](formfielditem.md)[]*
-
-___
-
-### `Optional` rows
-
-• **rows**? : *undefined | number*

package/docs/interfaces/formfields.md

@@ -1,33 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [FormFields](formfields.md)
-
-# Interface: FormFields
-
-## Hierarchy
-
-* **FormFields**
-
-## Index
-
-### Properties
-
-* [billingAddress](formfields.md#billingaddress)
-* [customerAccount](formfields.md#customeraccount)
-* [shippingAddress](formfields.md#shippingaddress)
-
-## Properties
-
-###  billingAddress
-
-• **billingAddress**: *[FormField](formfield.md)[]*
-
-___
-
-###  customerAccount
-
-• **customerAccount**: *[FormField](formfield.md)[]*
-
-___
-
-###  shippingAddress
-
-• **shippingAddress**: *[FormField](formfield.md)[]*

package/docs/interfaces/gatewayorderpayment.md

@@ -1,88 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [GatewayOrderPayment](gatewayorderpayment.md)
-
-# Interface: GatewayOrderPayment
-
-## Hierarchy
-
-* [OrderPayment](orderpayment.md)
-
-  ↳ **GatewayOrderPayment**
-
-## Index
-
-### Properties
-
-* [amount](gatewayorderpayment.md#amount)
-* [description](gatewayorderpayment.md#description)
-* [detail](gatewayorderpayment.md#detail)
-* [gatewayId](gatewayorderpayment.md#optional-gatewayid)
-* [mandate](gatewayorderpayment.md#optional-mandate)
-* [methodId](gatewayorderpayment.md#optional-methodid)
-* [paymentId](gatewayorderpayment.md#optional-paymentid)
-* [providerId](gatewayorderpayment.md#providerid)
-
-## Properties
-
-###  amount
-
-• **amount**: *number*
-
-*Inherited from [GatewayOrderPayment](gatewayorderpayment.md).[amount](gatewayorderpayment.md#amount)*
-
-___
-
-###  description
-
-• **description**: *string*
-
-*Inherited from [GatewayOrderPayment](gatewayorderpayment.md).[description](gatewayorderpayment.md#description)*
-
-___
-
-###  detail
-
-• **detail**: *object*
-
-#### Type declaration:
-
-* **instructions**: *string*
-
-* **step**: *string*
-
-___
-
-### `Optional` gatewayId
-
-• **gatewayId**? : *undefined | string*
-
-*Inherited from [GatewayOrderPayment](gatewayorderpayment.md).[gatewayId](gatewayorderpayment.md#optional-gatewayid)*
-
-___
-
-### `Optional` mandate
-
-• **mandate**? : *undefined | object*
-
-___
-
-### `Optional` methodId
-
-• **methodId**? : *undefined | string*
-
-*Inherited from [GatewayOrderPayment](gatewayorderpayment.md).[methodId](gatewayorderpayment.md#optional-methodid)*
-
-___
-
-### `Optional` paymentId
-
-• **paymentId**? : *undefined | string*
-
-*Inherited from [GatewayOrderPayment](gatewayorderpayment.md).[paymentId](gatewayorderpayment.md#optional-paymentid)*
-
-___
-
-###  providerId
-
-• **providerId**: *string*
-
-*Inherited from [GatewayOrderPayment](gatewayorderpayment.md).[providerId](gatewayorderpayment.md#providerid)*

package/docs/interfaces/giftcertificate.md

@@ -1,47 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [GiftCertificate](giftcertificate.md)
-
-# Interface: GiftCertificate
-
-## Hierarchy
-
-* **GiftCertificate**
-
-## Index
-
-### Properties
-
-* [balance](giftcertificate.md#balance)
-* [code](giftcertificate.md#code)
-* [purchaseDate](giftcertificate.md#purchasedate)
-* [remaining](giftcertificate.md#remaining)
-* [used](giftcertificate.md#used)
-
-## Properties
-
-###  balance
-
-• **balance**: *number*
-
-___
-
-###  code
-
-• **code**: *string*
-
-___
-
-###  purchaseDate
-
-• **purchaseDate**: *string*
-
-___
-
-###  remaining
-
-• **remaining**: *number*
-
-___
-
-###  used
-
-• **used**: *number*

package/docs/interfaces/giftcertificateitem.md

@@ -1,80 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [GiftCertificateItem](giftcertificateitem.md)
-
-# Interface: GiftCertificateItem
-
-## Hierarchy
-
-* **GiftCertificateItem**
-
-## Index
-
-### Properties
-
-* [amount](giftcertificateitem.md#amount)
-* [id](giftcertificateitem.md#id)
-* [message](giftcertificateitem.md#message)
-* [name](giftcertificateitem.md#name)
-* [recipient](giftcertificateitem.md#recipient)
-* [sender](giftcertificateitem.md#sender)
-* [taxable](giftcertificateitem.md#taxable)
-* [theme](giftcertificateitem.md#theme)
-
-## Properties
-
-###  amount
-
-• **amount**: *number*
-
-___
-
-###  id
-
-• **id**: *string | number*
-
-___
-
-###  message
-
-• **message**: *string*
-
-___
-
-###  name
-
-• **name**: *string*
-
-___
-
-###  recipient
-
-• **recipient**: *object*
-
-#### Type declaration:
-
-* **email**: *string*
-
-* **name**: *string*
-
-___
-
-###  sender
-
-• **sender**: *object*
-
-#### Type declaration:
-
-* **email**: *string*
-
-* **name**: *string*
-
-___
-
-###  taxable
-
-• **taxable**: *boolean*
-
-___
-
-###  theme
-
-• **theme**: *string*