@bigcommerce/checkout-sdk 1.271.2 → 1.272.1

package/docs/interfaces/PickupOptionRequestBody.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / PickupOptionRequestBody
+
+# Interface: PickupOptionRequestBody
+
+## Table of contents
+
+### Properties
+
+- [consignmentId](PickupOptionRequestBody.md#consignmentid)
+- [searchArea](PickupOptionRequestBody.md#searcharea)
+
+## Properties
+
+### consignmentId
+
+• **consignmentId**: `string`
+
+___
+
+### searchArea
+
+• **searchArea**: [`SearchArea`](SearchArea.md)

package/docs/interfaces/PickupOptionResult.md

@@ -0,0 +1,15 @@
+[@bigcommerce/checkout-sdk](../README.md) / PickupOptionResult
+
+# Interface: PickupOptionResult
+
+## Table of contents
+
+### Properties
+
+- [options](PickupOptionResult.md#options)
+
+## Properties
+
+### options
+
+• **options**: [`Option`](Option.md)[]

package/docs/interfaces/Promotion.md

@@ -0,0 +1,15 @@
+[@bigcommerce/checkout-sdk](../README.md) / Promotion
+
+# Interface: Promotion
+
+## Table of contents
+
+### Properties
+
+- [banners](Promotion.md#banners)
+
+## Properties
+
+### banners
+
+• **banners**: [`Banner`](Banner.md)[]

package/docs/interfaces/Radius.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / Radius
+
+# Interface: Radius
+
+## Table of contents
+
+### Properties
+
+- [unit](Radius.md#unit)
+- [value](Radius.md#value)
+
+## Properties
+
+### unit
+
+• **unit**: [`RadiusUnit`](../enums/RadiusUnit.md)
+
+___
+
+### value
+
+• **value**: `number`

package/docs/interfaces/Region.md

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

package/docs/interfaces/RequestOptions.md

@@ -0,0 +1,48 @@
+[@bigcommerce/checkout-sdk](../README.md) / RequestOptions
+
+# Interface: RequestOptions<TParams\>
+
+A set of options for configuring an asynchronous request.
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `TParams` | {} |
+
+## Hierarchy
+
+- **`RequestOptions`**
+
+  ↳ [`CheckoutButtonOptions`](CheckoutButtonOptions.md)
+
+  ↳ [`CustomerRequestOptions`](CustomerRequestOptions.md)
+
+  ↳ [`PaymentRequestOptions`](PaymentRequestOptions.md)
+
+  ↳ [`ShippingRequestOptions`](ShippingRequestOptions.md)
+
+## Table of contents
+
+### Properties
+
+- [params](RequestOptions.md#params)
+- [timeout](RequestOptions.md#timeout)
+
+## Properties
+
+### params
+
+• `Optional` **params**: `TParams`
+
+The parameters of the request, if required.
+
+___
+
+### 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.

package/docs/interfaces/SearchArea.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / SearchArea
+
+# Interface: SearchArea
+
+## Table of contents
+
+### Properties
+
+- [coordinates](SearchArea.md#coordinates)
+- [radius](SearchArea.md#radius)
+
+## Properties
+
+### coordinates
+
+• **coordinates**: [`Coordinates`](Coordinates.md)
+
+___
+
+### radius
+
+• **radius**: [`Radius`](Radius.md)

package/docs/interfaces/SepaPlaceHolder.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / SepaPlaceHolder
+
+# Interface: SepaPlaceHolder
+
+## Table of contents
+
+### Properties
+
+- [ibanNumber](SepaPlaceHolder.md#ibannumber)
+- [ownerName](SepaPlaceHolder.md#ownername)
+
+## Properties
+
+### ibanNumber
+
+• `Optional` **ibanNumber**: `string`
+
+___
+
+### ownerName
+
+• `Optional` **ownerName**: `string`

package/docs/interfaces/SepaPlaceHolder_2.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / SepaPlaceHolder_2
+
+# Interface: SepaPlaceHolder\_2
+
+## Table of contents
+
+### Properties
+
+- [ibanNumber](SepaPlaceHolder_2.md#ibannumber)
+- [ownerName](SepaPlaceHolder_2.md#ownername)
+
+## Properties
+
+### ibanNumber
+
+• `Optional` **ibanNumber**: `string`
+
+___
+
+### ownerName
+
+• `Optional` **ownerName**: `string`

package/docs/interfaces/ShippingInitializeOptions.md

@@ -0,0 +1,88 @@
+[@bigcommerce/checkout-sdk](../README.md) / ShippingInitializeOptions
+
+# Interface: ShippingInitializeOptions<T\>
+
+A set of options that are required to initialize the shipping step of the
+current checkout flow.
+
+Some payment methods have specific requirements for setting the shipping
+details for checkout. For example, Amazon Pay requires the customer to enter
+their shipping address using their address book widget. As a result, you may
+need to provide additional information in order to initialize the shipping
+step of checkout.
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | {} |
+
+## Hierarchy
+
+- [`ShippingRequestOptions`](ShippingRequestOptions.md)<`T`\>
+
+  ↳ **`ShippingInitializeOptions`**
+
+## Table of contents
+
+### Properties
+
+- [amazon](ShippingInitializeOptions.md#amazon)
+- [amazonpay](ShippingInitializeOptions.md#amazonpay)
+- [methodId](ShippingInitializeOptions.md#methodid)
+- [params](ShippingInitializeOptions.md#params)
+- [timeout](ShippingInitializeOptions.md#timeout)
+
+## Properties
+
+### amazon
+
+• `Optional` **amazon**: [`AmazonPayShippingInitializeOptions`](AmazonPayShippingInitializeOptions.md)
+
+The options that are required to initialize the shipping step of checkout
+when using Amazon Pay.
+
+___
+
+### amazonpay
+
+• `Optional` **amazonpay**: [`AmazonPayV2ShippingInitializeOptions`](AmazonPayV2ShippingInitializeOptions.md)
+
+The options that are required to initialize the shipping step of checkout
+when using AmazonPayV2.
+
+___
+
+### methodId
+
+• `Optional` **methodId**: `string`
+
+#### Inherited from
+
+[ShippingRequestOptions](ShippingRequestOptions.md).[methodId](ShippingRequestOptions.md#methodid)
+
+___
+
+### params
+
+• `Optional` **params**: `T`
+
+The parameters of the request, if required.
+
+#### Inherited from
+
+[ShippingRequestOptions](ShippingRequestOptions.md).[params](ShippingRequestOptions.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
+
+[ShippingRequestOptions](ShippingRequestOptions.md).[timeout](ShippingRequestOptions.md#timeout)

package/docs/interfaces/ShippingOption.md

@@ -0,0 +1,64 @@
+[@bigcommerce/checkout-sdk](../README.md) / ShippingOption
+
+# Interface: ShippingOption
+
+## Table of contents
+
+### Properties
+
+- [additionalDescription](ShippingOption.md#additionaldescription)
+- [cost](ShippingOption.md#cost)
+- [description](ShippingOption.md#description)
+- [id](ShippingOption.md#id)
+- [imageUrl](ShippingOption.md#imageurl)
+- [isRecommended](ShippingOption.md#isrecommended)
+- [transitTime](ShippingOption.md#transittime)
+- [type](ShippingOption.md#type)
+
+## Properties
+
+### additionalDescription
+
+• **additionalDescription**: `string`
+
+___
+
+### cost
+
+• **cost**: `number`
+
+___
+
+### description
+
+• **description**: `string`
+
+___
+
+### id
+
+• **id**: `string`
+
+___
+
+### imageUrl
+
+• **imageUrl**: `string`
+
+___
+
+### isRecommended
+
+• **isRecommended**: `boolean`
+
+___
+
+### transitTime
+
+• **transitTime**: `string`
+
+___
+
+### type
+
+• **type**: `string`

package/docs/interfaces/ShippingRequestOptions.md

@@ -0,0 +1,65 @@
+[@bigcommerce/checkout-sdk](../README.md) / ShippingRequestOptions
+
+# Interface: ShippingRequestOptions<T\>
+
+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`](RequestOptions.md)<`T`\>
+
+  ↳ **`ShippingRequestOptions`**
+
+  ↳↳ [`ShippingInitializeOptions`](ShippingInitializeOptions.md)
+
+## Table of contents
+
+### Properties
+
+- [methodId](ShippingRequestOptions.md#methodid)
+- [params](ShippingRequestOptions.md#params)
+- [timeout](ShippingRequestOptions.md#timeout)
+
+## Properties
+
+### methodId
+
+• `Optional` **methodId**: `string`
+
+___
+
+### params
+
+• `Optional` **params**: `T`
+
+The parameters of the request, if required.
+
+#### Inherited from
+
+[RequestOptions](RequestOptions.md).[params](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](RequestOptions.md).[timeout](RequestOptions.md#timeout)

package/docs/interfaces/ShopperConfig.md

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

package/docs/interfaces/ShopperCurrency.md

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

package/docs/interfaces/SignInEmail.md

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

package/docs/interfaces/SignInEmailRequestBody.md

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

package/docs/interfaces/SpamProtectionOptions.md

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

package/docs/interfaces/SquareFormElement.md

@@ -0,0 +1,28 @@
+[@bigcommerce/checkout-sdk](../README.md) / SquareFormElement
+
+# Interface: SquareFormElement
+
+Configures any form element provided by Square payment.
+
+## Table of contents
+
+### Properties
+
+- [elementId](SquareFormElement.md#elementid)
+- [placeholder](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.