@bigcommerce/checkout-sdk 1.308.1 → 1.308.2

package/docs/interfaces/internal_.Consignment.md

@@ -0,0 +1,73 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / Consignment
+
+# Interface: Consignment
+
+[<internal>](../modules/internal_.md).Consignment
+
+## Table of contents
+
+### Properties
+
+- [address](internal_.Consignment.md#address)
+- [availableShippingOptions](internal_.Consignment.md#availableshippingoptions)
+- [handlingCost](internal_.Consignment.md#handlingcost)
+- [id](internal_.Consignment.md#id)
+- [lineItemIds](internal_.Consignment.md#lineitemids)
+- [selectedPickupOption](internal_.Consignment.md#selectedpickupoption)
+- [selectedShippingOption](internal_.Consignment.md#selectedshippingoption)
+- [shippingAddress](internal_.Consignment.md#shippingaddress)
+- [shippingCost](internal_.Consignment.md#shippingcost)
+
+## Properties
+
+### address
+
+• **address**: [`Address`](internal_.Address.md)
+
+___
+
+### availableShippingOptions
+
+• `Optional` **availableShippingOptions**: [`ShippingOption`](internal_.ShippingOption.md)[]
+
+___
+
+### handlingCost
+
+• **handlingCost**: `number`
+
+___
+
+### id
+
+• **id**: `string`
+
+___
+
+### lineItemIds
+
+• **lineItemIds**: `string`[]
+
+___
+
+### selectedPickupOption
+
+• `Optional` **selectedPickupOption**: [`ConsignmentPickupOption`](internal_.ConsignmentPickupOption.md)
+
+___
+
+### selectedShippingOption
+
+• `Optional` **selectedShippingOption**: [`ShippingOption`](internal_.ShippingOption.md)
+
+___
+
+### shippingAddress
+
+• **shippingAddress**: [`Address`](internal_.Address.md)
+
+___
+
+### shippingCost
+
+• **shippingCost**: `number`

package/docs/interfaces/internal_.ConsignmentAssignmentBaseRequestBodyWithAddress.md

@@ -0,0 +1,31 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / ConsignmentAssignmentBaseRequestBodyWithAddress
+
+# Interface: ConsignmentAssignmentBaseRequestBodyWithAddress
+
+[<internal>](../modules/internal_.md).ConsignmentAssignmentBaseRequestBodyWithAddress
+
+## Table of contents
+
+### Properties
+
+- [address](internal_.ConsignmentAssignmentBaseRequestBodyWithAddress.md#address)
+- [lineItems](internal_.ConsignmentAssignmentBaseRequestBodyWithAddress.md#lineitems)
+- [pickupOption](internal_.ConsignmentAssignmentBaseRequestBodyWithAddress.md#pickupoption)
+
+## Properties
+
+### address
+
+• **address**: [`AddressRequestBody`](internal_.AddressRequestBody.md)
+
+___
+
+### lineItems
+
+• **lineItems**: [`ConsignmentLineItem`](internal_.ConsignmentLineItem.md)[]
+
+___
+
+### pickupOption
+
+• `Optional` **pickupOption**: [`ConsignmentPickupOption`](internal_.ConsignmentPickupOption.md)

package/docs/interfaces/internal_.ConsignmentAssignmentBaseRequestBodyWithShippingAddress.md

@@ -0,0 +1,31 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / ConsignmentAssignmentBaseRequestBodyWithShippingAddress
+
+# Interface: ConsignmentAssignmentBaseRequestBodyWithShippingAddress
+
+[<internal>](../modules/internal_.md).ConsignmentAssignmentBaseRequestBodyWithShippingAddress
+
+## Table of contents
+
+### Properties
+
+- [lineItems](internal_.ConsignmentAssignmentBaseRequestBodyWithShippingAddress.md#lineitems)
+- [pickupOption](internal_.ConsignmentAssignmentBaseRequestBodyWithShippingAddress.md#pickupoption)
+- [shippingAddress](internal_.ConsignmentAssignmentBaseRequestBodyWithShippingAddress.md#shippingaddress)
+
+## Properties
+
+### lineItems
+
+• **lineItems**: [`ConsignmentLineItem`](internal_.ConsignmentLineItem.md)[]
+
+___
+
+### pickupOption
+
+• `Optional` **pickupOption**: [`ConsignmentPickupOption`](internal_.ConsignmentPickupOption.md)
+
+___
+
+### shippingAddress
+
+• **shippingAddress**: [`AddressRequestBody`](internal_.AddressRequestBody.md)

package/docs/interfaces/internal_.ConsignmentCreateRequestBody.md

@@ -0,0 +1,38 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / ConsignmentCreateRequestBody
+
+# Interface: ConsignmentCreateRequestBody
+
+[<internal>](../modules/internal_.md).ConsignmentCreateRequestBody
+
+## Table of contents
+
+### Properties
+
+- [address](internal_.ConsignmentCreateRequestBody.md#address)
+- [lineItems](internal_.ConsignmentCreateRequestBody.md#lineitems)
+- [pickupOption](internal_.ConsignmentCreateRequestBody.md#pickupoption)
+- [shippingAddress](internal_.ConsignmentCreateRequestBody.md#shippingaddress)
+
+## Properties
+
+### address
+
+• `Optional` **address**: [`AddressRequestBody`](internal_.AddressRequestBody.md)
+
+___
+
+### lineItems
+
+• **lineItems**: [`ConsignmentLineItem`](internal_.ConsignmentLineItem.md)[]
+
+___
+
+### pickupOption
+
+• `Optional` **pickupOption**: [`ConsignmentPickupOption`](internal_.ConsignmentPickupOption.md)
+
+___
+
+### shippingAddress
+
+• `Optional` **shippingAddress**: [`AddressRequestBody`](internal_.AddressRequestBody.md)

package/docs/interfaces/internal_.ConsignmentLineItem.md

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

package/docs/interfaces/internal_.ConsignmentPickupOption.md

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

package/docs/interfaces/internal_.ConsignmentUpdateRequestBody.md

@@ -0,0 +1,45 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / ConsignmentUpdateRequestBody
+
+# Interface: ConsignmentUpdateRequestBody
+
+[<internal>](../modules/internal_.md).ConsignmentUpdateRequestBody
+
+## Table of contents
+
+### Properties
+
+- [address](internal_.ConsignmentUpdateRequestBody.md#address)
+- [id](internal_.ConsignmentUpdateRequestBody.md#id)
+- [lineItems](internal_.ConsignmentUpdateRequestBody.md#lineitems)
+- [pickupOption](internal_.ConsignmentUpdateRequestBody.md#pickupoption)
+- [shippingAddress](internal_.ConsignmentUpdateRequestBody.md#shippingaddress)
+
+## Properties
+
+### address
+
+• `Optional` **address**: [`AddressRequestBody`](internal_.AddressRequestBody.md)
+
+___
+
+### id
+
+• **id**: `string`
+
+___
+
+### lineItems
+
+• `Optional` **lineItems**: [`ConsignmentLineItem`](internal_.ConsignmentLineItem.md)[]
+
+___
+
+### pickupOption
+
+• `Optional` **pickupOption**: [`ConsignmentPickupOption`](internal_.ConsignmentPickupOption.md)
+
+___
+
+### shippingAddress
+
+• `Optional` **shippingAddress**: [`AddressRequestBody`](internal_.AddressRequestBody.md)

package/docs/interfaces/internal_.Coordinates.md

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

package/docs/interfaces/internal_.Country.md

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

package/docs/interfaces/internal_.Coupon.md

@@ -0,0 +1,45 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / Coupon
+
+# Interface: Coupon
+
+[<internal>](../modules/internal_.md).Coupon
+
+## Table of contents
+
+### Properties
+
+- [code](internal_.Coupon.md#code)
+- [couponType](internal_.Coupon.md#coupontype)
+- [discountedAmount](internal_.Coupon.md#discountedamount)
+- [displayName](internal_.Coupon.md#displayname)
+- [id](internal_.Coupon.md#id)
+
+## Properties
+
+### code
+
+• **code**: `string`
+
+___
+
+### couponType
+
+• **couponType**: `string`
+
+___
+
+### discountedAmount
+
+• **discountedAmount**: `number`
+
+___
+
+### displayName
+
+• **displayName**: `string`
+
+___
+
+### id
+
+• **id**: `string`

package/docs/interfaces/internal_.CreditCardInstrument.md

@@ -0,0 +1,87 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CreditCardInstrument
+
+# Interface: CreditCardInstrument
+
+[<internal>](../modules/internal_.md).CreditCardInstrument
+
+## Table of contents
+
+### Properties
+
+- [browser\_info](internal_.CreditCardInstrument.md#browser_info)
+- [ccCustomerCode](internal_.CreditCardInstrument.md#cccustomercode)
+- [ccCvv](internal_.CreditCardInstrument.md#cccvv)
+- [ccExpiry](internal_.CreditCardInstrument.md#ccexpiry)
+- [ccName](internal_.CreditCardInstrument.md#ccname)
+- [ccNumber](internal_.CreditCardInstrument.md#ccnumber)
+- [extraData](internal_.CreditCardInstrument.md#extradata)
+- [shouldSaveInstrument](internal_.CreditCardInstrument.md#shouldsaveinstrument)
+- [shouldSetAsDefaultInstrument](internal_.CreditCardInstrument.md#shouldsetasdefaultinstrument)
+- [threeDSecure](internal_.CreditCardInstrument.md#threedsecure)
+
+## Properties
+
+### browser\_info
+
+• `Optional` **browser\_info**: [`BrowserInfo`](internal_.BrowserInfo.md)
+
+___
+
+### ccCustomerCode
+
+• `Optional` **ccCustomerCode**: `string`
+
+___
+
+### ccCvv
+
+• `Optional` **ccCvv**: `string`
+
+___
+
+### ccExpiry
+
+• **ccExpiry**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `month` | `string` |
+| `year` | `string` |
+
+___
+
+### ccName
+
+• **ccName**: `string`
+
+___
+
+### ccNumber
+
+• **ccNumber**: `string`
+
+___
+
+### extraData
+
+• `Optional` **extraData**: `any`
+
+___
+
+### shouldSaveInstrument
+
+• `Optional` **shouldSaveInstrument**: `boolean`
+
+___
+
+### shouldSetAsDefaultInstrument
+
+• `Optional` **shouldSetAsDefaultInstrument**: `boolean`
+
+___
+
+### threeDSecure
+
+• `Optional` **threeDSecure**: [`ThreeDSecure`](internal_.ThreeDSecure.md) \| [`ThreeDSecureToken`](internal_.ThreeDSecureToken.md)

package/docs/interfaces/internal_.CreditCardPlaceHolder.md

@@ -0,0 +1,31 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CreditCardPlaceHolder
+
+# Interface: CreditCardPlaceHolder
+
+[<internal>](../modules/internal_.md).CreditCardPlaceHolder
+
+## Table of contents
+
+### Properties
+
+- [encryptedCardNumber](internal_.CreditCardPlaceHolder.md#encryptedcardnumber)
+- [encryptedExpiryDate](internal_.CreditCardPlaceHolder.md#encryptedexpirydate)
+- [encryptedSecurityCode](internal_.CreditCardPlaceHolder.md#encryptedsecuritycode)
+
+## Properties
+
+### encryptedCardNumber
+
+• `Optional` **encryptedCardNumber**: `string`
+
+___
+
+### encryptedExpiryDate
+
+• `Optional` **encryptedExpiryDate**: `string`
+
+___
+
+### encryptedSecurityCode
+
+• **encryptedSecurityCode**: `string`

package/docs/interfaces/internal_.CreditCardPlaceHolder_2.md

@@ -0,0 +1,31 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CreditCardPlaceHolder\_2
+
+# Interface: CreditCardPlaceHolder\_2
+
+[<internal>](../modules/internal_.md).CreditCardPlaceHolder_2
+
+## Table of contents
+
+### Properties
+
+- [encryptedCardNumber](internal_.CreditCardPlaceHolder_2.md#encryptedcardnumber)
+- [encryptedExpiryDate](internal_.CreditCardPlaceHolder_2.md#encryptedexpirydate)
+- [encryptedSecurityCode](internal_.CreditCardPlaceHolder_2.md#encryptedsecuritycode)
+
+## Properties
+
+### encryptedCardNumber
+
+• `Optional` **encryptedCardNumber**: `string`
+
+___
+
+### encryptedExpiryDate
+
+• `Optional` **encryptedExpiryDate**: `string`
+
+___
+
+### encryptedSecurityCode
+
+• **encryptedSecurityCode**: `string`