@bigcommerce/checkout-sdk 1.271.1 → 1.271.2

package/docs/interfaces/PhysicalItem.md

@@ -1,311 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / PhysicalItem
-
-# Interface: PhysicalItem
-
-## Hierarchy
-
-- [`LineItem`](LineItem.md)
-
-  ↳ **`PhysicalItem`**
-
-## Table of contents
-
-### Properties
-
-- [addedByPromotion](PhysicalItem.md#addedbypromotion)
-- [brand](PhysicalItem.md#brand)
-- [categories](PhysicalItem.md#categories)
-- [categoryNames](PhysicalItem.md#categorynames)
-- [comparisonPrice](PhysicalItem.md#comparisonprice)
-- [couponAmount](PhysicalItem.md#couponamount)
-- [discountAmount](PhysicalItem.md#discountamount)
-- [discounts](PhysicalItem.md#discounts)
-- [extendedComparisonPrice](PhysicalItem.md#extendedcomparisonprice)
-- [extendedListPrice](PhysicalItem.md#extendedlistprice)
-- [extendedSalePrice](PhysicalItem.md#extendedsaleprice)
-- [giftWrapping](PhysicalItem.md#giftwrapping)
-- [id](PhysicalItem.md#id)
-- [imageUrl](PhysicalItem.md#imageurl)
-- [isShippingRequired](PhysicalItem.md#isshippingrequired)
-- [isTaxable](PhysicalItem.md#istaxable)
-- [listPrice](PhysicalItem.md#listprice)
-- [name](PhysicalItem.md#name)
-- [options](PhysicalItem.md#options)
-- [parentId](PhysicalItem.md#parentid)
-- [productId](PhysicalItem.md#productid)
-- [quantity](PhysicalItem.md#quantity)
-- [salePrice](PhysicalItem.md#saleprice)
-- [sku](PhysicalItem.md#sku)
-- [socialMedia](PhysicalItem.md#socialmedia)
-- [url](PhysicalItem.md#url)
-- [variantId](PhysicalItem.md#variantid)
-
-## Properties
-
-### addedByPromotion
-
-• **addedByPromotion**: `boolean`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[addedByPromotion](LineItem.md#addedbypromotion)
-
-___
-
-### brand
-
-• **brand**: `string`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[brand](LineItem.md#brand)
-
-___
-
-### categories
-
-• `Optional` **categories**: [`LineItemCategory`](LineItemCategory.md)[][]
-
-#### Inherited from
-
-[LineItem](LineItem.md).[categories](LineItem.md#categories)
-
-___
-
-### categoryNames
-
-• `Optional` **categoryNames**: `string`[]
-
-#### Inherited from
-
-[LineItem](LineItem.md).[categoryNames](LineItem.md#categorynames)
-
-___
-
-### comparisonPrice
-
-• **comparisonPrice**: `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[comparisonPrice](LineItem.md#comparisonprice)
-
-___
-
-### couponAmount
-
-• **couponAmount**: `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[couponAmount](LineItem.md#couponamount)
-
-___
-
-### discountAmount
-
-• **discountAmount**: `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[discountAmount](LineItem.md#discountamount)
-
-___
-
-### discounts
-
-• **discounts**: { `discountedAmount`: `number` ; `name`: `string`  }[]
-
-#### Inherited from
-
-[LineItem](LineItem.md).[discounts](LineItem.md#discounts)
-
-___
-
-### extendedComparisonPrice
-
-• **extendedComparisonPrice**: `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[extendedComparisonPrice](LineItem.md#extendedcomparisonprice)
-
-___
-
-### extendedListPrice
-
-• **extendedListPrice**: `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[extendedListPrice](LineItem.md#extendedlistprice)
-
-___
-
-### extendedSalePrice
-
-• **extendedSalePrice**: `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[extendedSalePrice](LineItem.md#extendedsaleprice)
-
-___
-
-### giftWrapping
-
-• `Optional` **giftWrapping**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `amount` | `number` |
-| `message` | `string` |
-| `name` | `string` |
-
-___
-
-### id
-
-• **id**: `string` \| `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[id](LineItem.md#id)
-
-___
-
-### imageUrl
-
-• **imageUrl**: `string`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[imageUrl](LineItem.md#imageurl)
-
-___
-
-### isShippingRequired
-
-• **isShippingRequired**: `boolean`
-
-___
-
-### isTaxable
-
-• **isTaxable**: `boolean`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[isTaxable](LineItem.md#istaxable)
-
-___
-
-### listPrice
-
-• **listPrice**: `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[listPrice](LineItem.md#listprice)
-
-___
-
-### name
-
-• **name**: `string`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[name](LineItem.md#name)
-
-___
-
-### options
-
-• `Optional` **options**: [`LineItemOption`](LineItemOption.md)[]
-
-#### Inherited from
-
-[LineItem](LineItem.md).[options](LineItem.md#options)
-
-___
-
-### parentId
-
-• `Optional` **parentId**: ``null`` \| `string`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[parentId](LineItem.md#parentid)
-
-___
-
-### productId
-
-• **productId**: `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[productId](LineItem.md#productid)
-
-___
-
-### quantity
-
-• **quantity**: `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[quantity](LineItem.md#quantity)
-
-___
-
-### salePrice
-
-• **salePrice**: `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[salePrice](LineItem.md#saleprice)
-
-___
-
-### sku
-
-• **sku**: `string`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[sku](LineItem.md#sku)
-
-___
-
-### socialMedia
-
-• `Optional` **socialMedia**: [`LineItemSocialData`](LineItemSocialData.md)[]
-
-#### Inherited from
-
-[LineItem](LineItem.md).[socialMedia](LineItem.md#socialmedia)
-
-___
-
-### url
-
-• **url**: `string`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[url](LineItem.md#url)
-
-___
-
-### variantId
-
-• **variantId**: `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[variantId](LineItem.md#variantid)

package/docs/interfaces/PickupMethod.md

@@ -1,43 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / PickupMethod
-
-# Interface: PickupMethod
-
-## Table of contents
-
-### Properties
-
-- [collectionInstructions](PickupMethod.md#collectioninstructions)
-- [collectionTimeDescription](PickupMethod.md#collectiontimedescription)
-- [displayName](PickupMethod.md#displayname)
-- [id](PickupMethod.md#id)
-- [locationId](PickupMethod.md#locationid)
-
-## Properties
-
-### collectionInstructions
-
-• **collectionInstructions**: `string`
-
-___
-
-### collectionTimeDescription
-
-• **collectionTimeDescription**: `string`
-
-___
-
-### displayName
-
-• **displayName**: `string`
-
-___
-
-### id
-
-• **id**: `number`
-
-___
-
-### locationId
-
-• **locationId**: `number`

package/docs/interfaces/PickupOptionRequestBody.md

@@ -1,22 +0,0 @@
-[@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

@@ -1,15 +0,0 @@
-[@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

@@ -1,15 +0,0 @@
-[@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

@@ -1,22 +0,0 @@
-[@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

@@ -1,22 +0,0 @@
-[@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

@@ -1,48 +0,0 @@
-[@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_2`](CheckoutButtonOptions_2.md)
-
-  ↳ [`CustomerRequestOptions_2`](CustomerRequestOptions_2.md)
-
-  ↳ [`PaymentRequestOptions_2`](PaymentRequestOptions_2.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/RequestOptions_2.md

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

@@ -1,22 +0,0 @@
-[@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

@@ -1,22 +0,0 @@
-[@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

@@ -1,22 +0,0 @@
-[@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

@@ -1,88 +0,0 @@
-[@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)