@bigcommerce/checkout-sdk 1.308.2 → 1.308.3

package/docs/interfaces/internal_.Checkout.md

@@ -1,204 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / Checkout
-
-# Interface: Checkout
-
-[<internal>](../modules/internal_.md).Checkout
-
-## Table of contents
-
-### Properties
-
-- [balanceDue](internal_.Checkout.md#balancedue)
-- [billingAddress](internal_.Checkout.md#billingaddress)
-- [cart](internal_.Checkout.md#cart)
-- [channelId](internal_.Checkout.md#channelid)
-- [consignments](internal_.Checkout.md#consignments)
-- [coupons](internal_.Checkout.md#coupons)
-- [createdTime](internal_.Checkout.md#createdtime)
-- [customer](internal_.Checkout.md#customer)
-- [customerMessage](internal_.Checkout.md#customermessage)
-- [discounts](internal_.Checkout.md#discounts)
-- [giftCertificates](internal_.Checkout.md#giftcertificates)
-- [giftWrappingCostTotal](internal_.Checkout.md#giftwrappingcosttotal)
-- [grandTotal](internal_.Checkout.md#grandtotal)
-- [handlingCostTotal](internal_.Checkout.md#handlingcosttotal)
-- [id](internal_.Checkout.md#id)
-- [isStoreCreditApplied](internal_.Checkout.md#isstorecreditapplied)
-- [orderId](internal_.Checkout.md#orderid)
-- [outstandingBalance](internal_.Checkout.md#outstandingbalance)
-- [payments](internal_.Checkout.md#payments)
-- [promotions](internal_.Checkout.md#promotions)
-- [shippingCostBeforeDiscount](internal_.Checkout.md#shippingcostbeforediscount)
-- [shippingCostTotal](internal_.Checkout.md#shippingcosttotal)
-- [shouldExecuteSpamCheck](internal_.Checkout.md#shouldexecutespamcheck)
-- [subtotal](internal_.Checkout.md#subtotal)
-- [taxTotal](internal_.Checkout.md#taxtotal)
-- [taxes](internal_.Checkout.md#taxes)
-- [updatedTime](internal_.Checkout.md#updatedtime)
-
-## Properties
-
-### balanceDue
-
-• **balanceDue**: `number`
-
-___
-
-### billingAddress
-
-• `Optional` **billingAddress**: [`BillingAddress`](internal_.BillingAddress.md)
-
-___
-
-### cart
-
-• **cart**: [`Cart`](internal_.Cart.md)
-
-___
-
-### channelId
-
-• **channelId**: `number`
-
-___
-
-### consignments
-
-• **consignments**: [`Consignment`](internal_.Consignment.md)[]
-
-___
-
-### coupons
-
-• **coupons**: [`Coupon`](internal_.Coupon.md)[]
-
-___
-
-### createdTime
-
-• **createdTime**: `string`
-
-___
-
-### customer
-
-• **customer**: [`Customer`](internal_.Customer.md)
-
-___
-
-### customerMessage
-
-• **customerMessage**: `string`
-
-___
-
-### discounts
-
-• **discounts**: [`Discount`](internal_.Discount.md)[]
-
-___
-
-### giftCertificates
-
-• **giftCertificates**: [`GiftCertificate`](internal_.GiftCertificate.md)[]
-
-___
-
-### giftWrappingCostTotal
-
-• **giftWrappingCostTotal**: `number`
-
-___
-
-### grandTotal
-
-• **grandTotal**: `number`
-
-___
-
-### handlingCostTotal
-
-• **handlingCostTotal**: `number`
-
-___
-
-### id
-
-• **id**: `string`
-
-___
-
-### isStoreCreditApplied
-
-• **isStoreCreditApplied**: `boolean`
-
-___
-
-### orderId
-
-• `Optional` **orderId**: `number`
-
-___
-
-### outstandingBalance
-
-• **outstandingBalance**: `number`
-
-___
-
-### payments
-
-• `Optional` **payments**: [`CheckoutPayment`](internal_.CheckoutPayment.md)[]
-
-___
-
-### promotions
-
-• `Optional` **promotions**: [`Promotion`](internal_.Promotion.md)[]
-
-___
-
-### shippingCostBeforeDiscount
-
-• **shippingCostBeforeDiscount**: `number`
-
-___
-
-### shippingCostTotal
-
-• **shippingCostTotal**: `number`
-
-___
-
-### shouldExecuteSpamCheck
-
-• **shouldExecuteSpamCheck**: `boolean`
-
-Whether the current checkout must execute spam protection
-before placing the order.
-
-Note: You need to enable Google ReCAPTCHA bot protection in your Checkout Settings.
-
-___
-
-### subtotal
-
-• **subtotal**: `number`
-
-___
-
-### taxTotal
-
-• **taxTotal**: `number`
-
-___
-
-### taxes
-
-• **taxes**: [`Tax`](internal_.Tax.md)[]
-
-___
-
-### updatedTime
-
-• **updatedTime**: `string`

package/docs/interfaces/internal_.CheckoutParams.md

@@ -1,17 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CheckoutParams
-
-# Interface: CheckoutParams
-
-[<internal>](../modules/internal_.md).CheckoutParams
-
-## Table of contents
-
-### Properties
-
-- [include](internal_.CheckoutParams.md#include)
-
-## Properties
-
-### include
-
-• `Optional` **include**: [`CheckoutIncludes`](../enums/internal_.CheckoutIncludes.md)[] \| [`CheckoutIncludeParam`](../modules/internal_.md#checkoutincludeparam)

package/docs/interfaces/internal_.CheckoutPayment.md

@@ -1,44 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CheckoutPayment
-
-# Interface: CheckoutPayment
-
-[<internal>](../modules/internal_.md).CheckoutPayment
-
-## Table of contents
-
-### Properties
-
-- [detail](internal_.CheckoutPayment.md#detail)
-- [gatewayId](internal_.CheckoutPayment.md#gatewayid)
-- [providerId](internal_.CheckoutPayment.md#providerid)
-- [providerType](internal_.CheckoutPayment.md#providertype)
-
-## Properties
-
-### detail
-
-• **detail**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `step` | `string` |
-
-___
-
-### gatewayId
-
-• `Optional` **gatewayId**: `string`
-
-___
-
-### providerId
-
-• **providerId**: `string`
-
-___
-
-### providerType
-
-• **providerType**: `string`

package/docs/interfaces/internal_.CheckoutPaymentMethodExecutedOptions.md

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

package/docs/interfaces/internal_.CheckoutRequestBody.md

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

package/docs/interfaces/internal_.CheckoutSelectors.md

@@ -1,31 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CheckoutSelectors
-
-# Interface: CheckoutSelectors
-
-[<internal>](../modules/internal_.md).CheckoutSelectors
-
-## Table of contents
-
-### Properties
-
-- [data](internal_.CheckoutSelectors.md#data)
-- [errors](internal_.CheckoutSelectors.md#errors)
-- [statuses](internal_.CheckoutSelectors.md#statuses)
-
-## Properties
-
-### data
-
-• **data**: [`CheckoutStoreSelector`](internal_.CheckoutStoreSelector.md)
-
-___
-
-### errors
-
-• **errors**: [`CheckoutStoreErrorSelector`](internal_.CheckoutStoreErrorSelector.md)
-
-___
-
-### statuses
-
-• **statuses**: [`CheckoutStoreStatusSelector`](internal_.CheckoutStoreStatusSelector.md)

package/docs/interfaces/internal_.CheckoutServiceOptions.md

@@ -1,38 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CheckoutServiceOptions
-
-# Interface: CheckoutServiceOptions
-
-[<internal>](../modules/internal_.md).CheckoutServiceOptions
-
-## Table of contents
-
-### Properties
-
-- [externalSource](internal_.CheckoutServiceOptions.md#externalsource)
-- [host](internal_.CheckoutServiceOptions.md#host)
-- [locale](internal_.CheckoutServiceOptions.md#locale)
-- [shouldWarnMutation](internal_.CheckoutServiceOptions.md#shouldwarnmutation)
-
-## Properties
-
-### externalSource
-
-• `Optional` **externalSource**: `string`
-
-___
-
-### host
-
-• `Optional` **host**: `string`
-
-___
-
-### locale
-
-• `Optional` **locale**: `string`
-
-___
-
-### shouldWarnMutation
-
-• `Optional` **shouldWarnMutation**: `boolean`

package/docs/interfaces/internal_.CheckoutSettings.md

@@ -1,203 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CheckoutSettings
-
-# Interface: CheckoutSettings
-
-[<internal>](../modules/internal_.md).CheckoutSettings
-
-## Table of contents
-
-### Properties
-
-- [checkoutBillingSameAsShippingEnabled](internal_.CheckoutSettings.md#checkoutbillingsameasshippingenabled)
-- [enableOrderComments](internal_.CheckoutSettings.md#enableordercomments)
-- [enableTermsAndConditions](internal_.CheckoutSettings.md#enabletermsandconditions)
-- [features](internal_.CheckoutSettings.md#features)
-- [googleMapsApiKey](internal_.CheckoutSettings.md#googlemapsapikey)
-- [googleRecaptchaSitekey](internal_.CheckoutSettings.md#googlerecaptchasitekey)
-- [guestCheckoutEnabled](internal_.CheckoutSettings.md#guestcheckoutenabled)
-- [hasMultiShippingEnabled](internal_.CheckoutSettings.md#hasmultishippingenabled)
-- [isAccountCreationEnabled](internal_.CheckoutSettings.md#isaccountcreationenabled)
-- [isAnalyticsEnabled](internal_.CheckoutSettings.md#isanalyticsenabled)
-- [isCardVaultingEnabled](internal_.CheckoutSettings.md#iscardvaultingenabled)
-- [isCouponCodeCollapsed](internal_.CheckoutSettings.md#iscouponcodecollapsed)
-- [isPaymentRequestCanMakePaymentEnabled](internal_.CheckoutSettings.md#ispaymentrequestcanmakepaymentenabled)
-- [isPaymentRequestEnabled](internal_.CheckoutSettings.md#ispaymentrequestenabled)
-- [isSignInEmailEnabled](internal_.CheckoutSettings.md#issigninemailenabled)
-- [isSpamProtectionEnabled](internal_.CheckoutSettings.md#isspamprotectionenabled)
-- [isStorefrontSpamProtectionEnabled](internal_.CheckoutSettings.md#isstorefrontspamprotectionenabled)
-- [isTrustedShippingAddressEnabled](internal_.CheckoutSettings.md#istrustedshippingaddressenabled)
-- [orderTermsAndConditions](internal_.CheckoutSettings.md#ordertermsandconditions)
-- [orderTermsAndConditionsLink](internal_.CheckoutSettings.md#ordertermsandconditionslink)
-- [orderTermsAndConditionsType](internal_.CheckoutSettings.md#ordertermsandconditionstype)
-- [privacyPolicyUrl](internal_.CheckoutSettings.md#privacypolicyurl)
-- [providerWithCustomCheckout](internal_.CheckoutSettings.md#providerwithcustomcheckout)
-- [realtimeShippingProviders](internal_.CheckoutSettings.md#realtimeshippingproviders)
-- [remoteCheckoutProviders](internal_.CheckoutSettings.md#remotecheckoutproviders)
-- [requiresMarketingConsent](internal_.CheckoutSettings.md#requiresmarketingconsent)
-- [shippingQuoteFailedMessage](internal_.CheckoutSettings.md#shippingquotefailedmessage)
-
-## Properties
-
-### checkoutBillingSameAsShippingEnabled
-
-• **checkoutBillingSameAsShippingEnabled**: `boolean`
-
-___
-
-### enableOrderComments
-
-• **enableOrderComments**: `boolean`
-
-___
-
-### enableTermsAndConditions
-
-• **enableTermsAndConditions**: `boolean`
-
-___
-
-### features
-
-• **features**: `Object`
-
-#### Index signature
-
-▪ [featureName: `string`]: `boolean`
-
-___
-
-### googleMapsApiKey
-
-• **googleMapsApiKey**: `string`
-
-___
-
-### googleRecaptchaSitekey
-
-• **googleRecaptchaSitekey**: `string`
-
-___
-
-### guestCheckoutEnabled
-
-• **guestCheckoutEnabled**: `boolean`
-
-___
-
-### hasMultiShippingEnabled
-
-• **hasMultiShippingEnabled**: `boolean`
-
-___
-
-### isAccountCreationEnabled
-
-• **isAccountCreationEnabled**: `boolean`
-
-___
-
-### isAnalyticsEnabled
-
-• **isAnalyticsEnabled**: `boolean`
-
-___
-
-### isCardVaultingEnabled
-
-• **isCardVaultingEnabled**: `boolean`
-
-___
-
-### isCouponCodeCollapsed
-
-• **isCouponCodeCollapsed**: `boolean`
-
-___
-
-### isPaymentRequestCanMakePaymentEnabled
-
-• **isPaymentRequestCanMakePaymentEnabled**: `boolean`
-
-___
-
-### isPaymentRequestEnabled
-
-• **isPaymentRequestEnabled**: `boolean`
-
-___
-
-### isSignInEmailEnabled
-
-• **isSignInEmailEnabled**: `boolean`
-
-___
-
-### isSpamProtectionEnabled
-
-• **isSpamProtectionEnabled**: `boolean`
-
-___
-
-### isStorefrontSpamProtectionEnabled
-
-• **isStorefrontSpamProtectionEnabled**: `boolean`
-
-___
-
-### isTrustedShippingAddressEnabled
-
-• **isTrustedShippingAddressEnabled**: `boolean`
-
-___
-
-### orderTermsAndConditions
-
-• **orderTermsAndConditions**: `string`
-
-___
-
-### orderTermsAndConditionsLink
-
-• **orderTermsAndConditionsLink**: `string`
-
-___
-
-### orderTermsAndConditionsType
-
-• **orderTermsAndConditionsType**: `string`
-
-___
-
-### privacyPolicyUrl
-
-• **privacyPolicyUrl**: `string`
-
-___
-
-### providerWithCustomCheckout
-
-• **providerWithCustomCheckout**: ``null`` \| `string`
-
-___
-
-### realtimeShippingProviders
-
-• **realtimeShippingProviders**: `string`[]
-
-___
-
-### remoteCheckoutProviders
-
-• **remoteCheckoutProviders**: `any`[]
-
-___
-
-### requiresMarketingConsent
-
-• **requiresMarketingConsent**: `boolean`
-
-___
-
-### shippingQuoteFailedMessage
-
-• **shippingQuoteFailedMessage**: `string`