@bigcommerce/checkout-sdk 1.271.2 → 1.272.1

package/docs/interfaces/Consignment.md

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

package/docs/interfaces/ConsignmentAssignmentBaseRequestBodyWithAddress.md

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

package/docs/interfaces/ConsignmentAssignmentBaseRequestBodyWithShippingAddress.md

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

package/docs/interfaces/ConsignmentCreateRequestBody.md

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

package/docs/interfaces/ConsignmentLineItem.md

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

package/docs/interfaces/ConsignmentPickupOption.md

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

package/docs/interfaces/ConsignmentUpdateRequestBody.md

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

package/docs/interfaces/Coordinates.md

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

package/docs/interfaces/Country.md

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

package/docs/interfaces/Coupon.md

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

package/docs/interfaces/CreditCardInstrument.md

@@ -0,0 +1,85 @@
+[@bigcommerce/checkout-sdk](../README.md) / CreditCardInstrument
+
+# Interface: CreditCardInstrument
+
+## Table of contents
+
+### Properties
+
+- [browser_info](CreditCardInstrument.md#browser_info)
+- [ccCustomerCode](CreditCardInstrument.md#cccustomercode)
+- [ccCvv](CreditCardInstrument.md#cccvv)
+- [ccExpiry](CreditCardInstrument.md#ccexpiry)
+- [ccName](CreditCardInstrument.md#ccname)
+- [ccNumber](CreditCardInstrument.md#ccnumber)
+- [extraData](CreditCardInstrument.md#extradata)
+- [shouldSaveInstrument](CreditCardInstrument.md#shouldsaveinstrument)
+- [shouldSetAsDefaultInstrument](CreditCardInstrument.md#shouldsetasdefaultinstrument)
+- [threeDSecure](CreditCardInstrument.md#threedsecure)
+
+## Properties
+
+### browser\_info
+
+• `Optional` **browser\_info**: [`BrowserInfo`](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`](ThreeDSecure.md) \| [`ThreeDSecureToken`](ThreeDSecureToken.md)

package/docs/interfaces/CreditCardPaymentInitializeOptions.md

@@ -0,0 +1,91 @@
+[@bigcommerce/checkout-sdk](../README.md) / CreditCardPaymentInitializeOptions
+
+# Interface: CreditCardPaymentInitializeOptions
+
+A set of options to initialize credit card payment methods, unless those
+methods require provider-specific configuration. If the initialization is
+successful, hosted (iframed) credit card fields will be inserted into the the
+containers specified in the options.
+
+```html
+<!-- These containers are where the hosted (iframed) credit card fields will be inserted -->
+<div id="card-number"></div>
+<div id="card-name"></div>
+<div id="card-expiry"></div>
+<div id="card-code"></div>
+```
+
+```js
+service.initializePayment({
+    methodId: 'authorizenet',
+    creditCard: {
+        form: {
+            fields: {
+                cardNumber: { containerId: 'card-number' },
+                cardName: { containerId: 'card-name' },
+                cardExpiry: { containerId: 'card-expiry' },
+                cardCode: { containerId: 'card-code' },
+            },
+        },
+    },
+});
+```
+
+Additional options can be passed in to customize the fields and register
+event callbacks.
+
+```js
+service.initializePayment({
+    methodId: 'authorizenet',
+    creditCard: {
+        form: {
+            fields: {
+                cardNumber: { containerId: 'card-number' },
+                cardName: { containerId: 'card-name' },
+                cardExpiry: { containerId: 'card-expiry' },
+                cardCode: { containerId: 'card-code' },
+            },
+            styles: {
+                default: {
+                    color: '#000',
+                    fontFamily: 'Arial',
+                },
+                error: {
+                    color: '#f00',
+                },
+                focus: {
+                    color: '#0f0',
+                },
+            },
+            onBlur({ fieldType }) {
+                console.log(fieldType);
+            },
+            onFocus({ fieldType }) {
+                console.log(fieldType);
+            },
+            onEnter({ fieldType }) {
+                console.log(fieldType);
+            },
+            onCardTypeChange({ cardType }) {
+                console.log(cardType);
+            },
+            onValidate({ errors, isValid }) {
+                console.log(errors);
+                console.log(isValid);
+            },
+        },
+    },
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [form](CreditCardPaymentInitializeOptions.md#form)
+
+## Properties
+
+### form
+
+• **form**: [`HostedFormOptions`](HostedFormOptions.md)

package/docs/interfaces/CreditCardPlaceHolder.md

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

package/docs/interfaces/CreditCardPlaceHolder_2.md

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