@bigcommerce/checkout-sdk 1.308.1 → 1.308.2

package/docs/interfaces/internal_.PhysicalItem.md

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

package/docs/interfaces/internal_.PickupMethod.md

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

package/docs/interfaces/internal_.PickupOptionResult.md

@@ -0,0 +1,17 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PickupOptionResult
+
+# Interface: PickupOptionResult
+
+[<internal>](../modules/internal_.md).PickupOptionResult
+
+## Table of contents
+
+### Properties
+
+- [options](internal_.PickupOptionResult.md#options)
+
+## Properties
+
+### options
+
+• **options**: [`Option_2`](internal_.Option_2.md)[]

package/docs/interfaces/internal_.Promotion.md

@@ -0,0 +1,17 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / Promotion
+
+# Interface: Promotion
+
+[<internal>](../modules/internal_.md).Promotion
+
+## Table of contents
+
+### Properties
+
+- [banners](internal_.Promotion.md#banners)
+
+## Properties
+
+### banners
+
+• **banners**: [`Banner`](internal_.Banner.md)[]

package/docs/interfaces/internal_.Radius.md

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

package/docs/interfaces/internal_.Region.md

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

package/docs/interfaces/internal_.RequestOptions.md

@@ -16,7 +16,11 @@ A set of options for configuring an asynchronous request.
 
 - **`RequestOptions`**
 
-  ↳ [`CheckoutButtonOptions`](internal_.CheckoutButtonOptions.md)
+  ↳ [`PaymentRequestOptions`](internal_.PaymentRequestOptions.md)
+
+  ↳ [`CustomerRequestOptions`](internal_.CustomerRequestOptions.md)
+
+  ↳ [`ShippingRequestOptions`](internal_.ShippingRequestOptions.md)
 
 ## Table of contents
 

package/docs/interfaces/internal_.SearchArea.md

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

package/docs/interfaces/internal_.SepaPlaceHolder.md

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

package/docs/interfaces/internal_.SepaPlaceHolder_2.md

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

package/docs/interfaces/internal_.ShippingInitializeOptions.md

@@ -0,0 +1,100 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / ShippingInitializeOptions
+
+# Interface: ShippingInitializeOptions<T\>
+
+[<internal>](../modules/internal_.md).ShippingInitializeOptions
+
+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`](internal_.ShippingRequestOptions.md)<`T`\>
+
+  ↳ **`ShippingInitializeOptions`**
+
+## Table of contents
+
+### Properties
+
+- [amazon](internal_.ShippingInitializeOptions.md#amazon)
+- [amazonpay](internal_.ShippingInitializeOptions.md#amazonpay)
+- [methodId](internal_.ShippingInitializeOptions.md#methodid)
+- [params](internal_.ShippingInitializeOptions.md#params)
+- [stripeupe](internal_.ShippingInitializeOptions.md#stripeupe)
+- [timeout](internal_.ShippingInitializeOptions.md#timeout)
+
+## Properties
+
+### amazon
+
+• `Optional` **amazon**: [`AmazonPayShippingInitializeOptions`](internal_.AmazonPayShippingInitializeOptions.md)
+
+The options that are required to initialize the shipping step of checkout
+when using Amazon Pay.
+
+___
+
+### amazonpay
+
+• `Optional` **amazonpay**: [`AmazonPayV2ShippingInitializeOptions`](internal_.AmazonPayV2ShippingInitializeOptions.md)
+
+The options that are required to initialize the shipping step of checkout
+when using AmazonPayV2.
+
+___
+
+### methodId
+
+• `Optional` **methodId**: `string`
+
+#### Inherited from
+
+[ShippingRequestOptions](internal_.ShippingRequestOptions.md).[methodId](internal_.ShippingRequestOptions.md#methodid)
+
+___
+
+### params
+
+• `Optional` **params**: `T`
+
+The parameters of the request, if required.
+
+#### Inherited from
+
+[ShippingRequestOptions](internal_.ShippingRequestOptions.md).[params](internal_.ShippingRequestOptions.md#params)
+
+___
+
+### stripeupe
+
+• `Optional` **stripeupe**: [`StripeUPEShippingInitializeOptions`](internal_.StripeUPEShippingInitializeOptions.md)
+
+The options that are required to initialize the shipping step of checkout
+when using Stripe Upe Link.
+
+___
+
+### 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](internal_.ShippingRequestOptions.md).[timeout](internal_.ShippingRequestOptions.md#timeout)

package/docs/interfaces/internal_.ShippingOption.md

@@ -0,0 +1,66 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / ShippingOption
+
+# Interface: ShippingOption
+
+[<internal>](../modules/internal_.md).ShippingOption
+
+## Table of contents
+
+### Properties
+
+- [additionalDescription](internal_.ShippingOption.md#additionaldescription)
+- [cost](internal_.ShippingOption.md#cost)
+- [description](internal_.ShippingOption.md#description)
+- [id](internal_.ShippingOption.md#id)
+- [imageUrl](internal_.ShippingOption.md#imageurl)
+- [isRecommended](internal_.ShippingOption.md#isrecommended)
+- [transitTime](internal_.ShippingOption.md#transittime)
+- [type](internal_.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`