@bigcommerce/checkout-sdk 1.264.1 → 1.266.0

package/docs/interfaces/CheckoutButtonInitializeOptions.md

@@ -0,0 +1,234 @@
+[@bigcommerce/checkout-sdk](../README.md) / CheckoutButtonInitializeOptions
+
+# Interface: CheckoutButtonInitializeOptions
+
+## Hierarchy
+
+- [`CheckoutButtonOptions`](CheckoutButtonOptions.md)
+
+  ↳ **`CheckoutButtonInitializeOptions`**
+
+## Table of contents
+
+### Properties
+
+- [amazonpay](CheckoutButtonInitializeOptions.md#amazonpay)
+- [applepay](CheckoutButtonInitializeOptions.md#applepay)
+- [braintreepaypal](CheckoutButtonInitializeOptions.md#braintreepaypal)
+- [braintreepaypalcredit](CheckoutButtonInitializeOptions.md#braintreepaypalcredit)
+- [braintreevenmo](CheckoutButtonInitializeOptions.md#braintreevenmo)
+- [containerId](CheckoutButtonInitializeOptions.md#containerid)
+- [googlepayadyenv2](CheckoutButtonInitializeOptions.md#googlepayadyenv2)
+- [googlepayadyenv3](CheckoutButtonInitializeOptions.md#googlepayadyenv3)
+- [googlepayauthorizenet](CheckoutButtonInitializeOptions.md#googlepayauthorizenet)
+- [googlepaybraintree](CheckoutButtonInitializeOptions.md#googlepaybraintree)
+- [googlepaycheckoutcom](CheckoutButtonInitializeOptions.md#googlepaycheckoutcom)
+- [googlepaycybersourcev2](CheckoutButtonInitializeOptions.md#googlepaycybersourcev2)
+- [googlepayorbital](CheckoutButtonInitializeOptions.md#googlepayorbital)
+- [googlepaystripe](CheckoutButtonInitializeOptions.md#googlepaystripe)
+- [googlepaystripeupe](CheckoutButtonInitializeOptions.md#googlepaystripeupe)
+- [methodId](CheckoutButtonInitializeOptions.md#methodid)
+- [params](CheckoutButtonInitializeOptions.md#params)
+- [paypal](CheckoutButtonInitializeOptions.md#paypal)
+- [paypalCommerce](CheckoutButtonInitializeOptions.md#paypalcommerce)
+- [paypalcommercevenmo](CheckoutButtonInitializeOptions.md#paypalcommercevenmo)
+- [timeout](CheckoutButtonInitializeOptions.md#timeout)
+
+## Properties
+
+### amazonpay
+
+• `Optional` **amazonpay**: [`AmazonPayV2ButtonParams`](AmazonPayV2ButtonParams.md)
+
+The options that are required to facilitate AmazonPayV2. They can be
+omitted unless you need to support AmazonPayV2.
+
+___
+
+### applepay
+
+• `Optional` **applepay**: [`ApplePayButtonInitializeOptions`](ApplePayButtonInitializeOptions.md)
+
+The options that are required to initialize the ApplePay payment method.
+They can be omitted unless you need to support ApplePay in cart.
+
+___
+
+### braintreepaypal
+
+• `Optional` **braintreepaypal**: [`BraintreePaypalButtonInitializeOptions`](BraintreePaypalButtonInitializeOptions.md)
+
+The options that are required to facilitate Braintree PayPal. They can be
+omitted unless you need to support Braintree PayPal.
+
+___
+
+### braintreepaypalcredit
+
+• `Optional` **braintreepaypalcredit**: [`BraintreePaypalCreditButtonInitializeOptions`](BraintreePaypalCreditButtonInitializeOptions.md)
+
+The options that are required to facilitate Braintree Credit. They can be
+omitted unless you need to support Braintree Credit.
+
+___
+
+### braintreevenmo
+
+• `Optional` **braintreevenmo**: [`BraintreeVenmoButtonInitializeOptions`](BraintreeVenmoButtonInitializeOptions.md)
+
+The options that are required to facilitate Braintree Venmo. They can be
+omitted unless you need to support Braintree Venmo.
+
+___
+
+### containerId
+
+• **containerId**: `string`
+
+The ID of a container which the checkout button should be inserted.
+
+___
+
+### googlepayadyenv2
+
+• `Optional` **googlepayadyenv2**: [`GooglePayButtonInitializeOptions`](GooglePayButtonInitializeOptions.md)
+
+The options that are required to initialize the GooglePay payment method.
+They can be omitted unless you need to support adyenv2 GooglePay.
+
+___
+
+### googlepayadyenv3
+
+• `Optional` **googlepayadyenv3**: [`GooglePayButtonInitializeOptions`](GooglePayButtonInitializeOptions.md)
+
+The options that are required to initialize the GooglePay payment method.
+They can be omitted unless you need to support adyenv2 GooglePay.
+
+___
+
+### googlepayauthorizenet
+
+• `Optional` **googlepayauthorizenet**: [`GooglePayButtonInitializeOptions`](GooglePayButtonInitializeOptions.md)
+
+The options that are required to facilitate Authorize.Net GooglePay.
+They can be omitted unless you need to support Authorize.Net GooglePay.
+
+___
+
+### googlepaybraintree
+
+• `Optional` **googlepaybraintree**: [`GooglePayButtonInitializeOptions`](GooglePayButtonInitializeOptions.md)
+
+The options that are required to facilitate Braintree GooglePay. They can be
+omitted unless you need to support Braintree GooglePay.
+
+___
+
+### googlepaycheckoutcom
+
+• `Optional` **googlepaycheckoutcom**: [`GooglePayButtonInitializeOptions`](GooglePayButtonInitializeOptions.md)
+
+The options that are required to facilitate Checkout.com GooglePay. They can be
+omitted unless you need to support Checkout.com GooglePay.
+
+___
+
+### googlepaycybersourcev2
+
+• `Optional` **googlepaycybersourcev2**: [`GooglePayButtonInitializeOptions`](GooglePayButtonInitializeOptions.md)
+
+The options that are required to facilitate CybersourceV2 GooglePay. They can be
+omitted unless you need to support CybersourceV2 GooglePay.
+
+___
+
+### googlepayorbital
+
+• `Optional` **googlepayorbital**: [`GooglePayButtonInitializeOptions`](GooglePayButtonInitializeOptions.md)
+
+The options that are required to facilitate Orbital GooglePay. They can be
+omitted unless you need to support Orbital GooglePay.
+
+___
+
+### googlepaystripe
+
+• `Optional` **googlepaystripe**: [`GooglePayButtonInitializeOptions`](GooglePayButtonInitializeOptions.md)
+
+The options that are required to facilitate Stripe GooglePay. They can be
+omitted unless you need to support Stripe GooglePay.
+
+___
+
+### googlepaystripeupe
+
+• `Optional` **googlepaystripeupe**: [`GooglePayButtonInitializeOptions`](GooglePayButtonInitializeOptions.md)
+
+The options that are required to facilitate Stripe GooglePay. They can be
+omitted unless you need to support Stripe GooglePay.
+
+___
+
+### methodId
+
+• **methodId**: [`CheckoutButtonMethodType`](../enums/CheckoutButtonMethodType.md)
+
+The identifier of the payment method.
+
+#### Inherited from
+
+[CheckoutButtonOptions](CheckoutButtonOptions.md).[methodId](CheckoutButtonOptions.md#methodid)
+
+___
+
+### params
+
+• `Optional` **params**: `Object`
+
+The parameters of the request, if required.
+
+#### Inherited from
+
+[CheckoutButtonOptions](CheckoutButtonOptions.md).[params](CheckoutButtonOptions.md#params)
+
+___
+
+### paypal
+
+• `Optional` **paypal**: [`PaypalButtonInitializeOptions`](PaypalButtonInitializeOptions.md)
+
+The options that are required to facilitate PayPal. They can be omitted
+unless you need to support Paypal.
+
+___
+
+### paypalCommerce
+
+• `Optional` **paypalCommerce**: [`PaypalCommerceButtonInitializeOptions`](PaypalCommerceButtonInitializeOptions.md)
+
+The options that are required to facilitate PayPal Commerce. They can be omitted
+unless you need to support Paypal.
+
+___
+
+### paypalcommercevenmo
+
+• `Optional` **paypalcommercevenmo**: [`PaypalCommerceVenmoButtonInitializeOptions`](PaypalCommerceVenmoButtonInitializeOptions.md)
+
+The options that are required to facilitate PayPal Commerce Venmo. They can be omitted
+unless you need to support PayPal Commerce Venmo.
+
+___
+
+### 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
+
+[CheckoutButtonOptions](CheckoutButtonOptions.md).[timeout](CheckoutButtonOptions.md#timeout)

package/docs/interfaces/CheckoutButtonInitializerOptions.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / CheckoutButtonInitializerOptions
+
+# Interface: CheckoutButtonInitializerOptions
+
+## Table of contents
+
+### Properties
+
+- [host](CheckoutButtonInitializerOptions.md#host)
+- [locale](CheckoutButtonInitializerOptions.md#locale)
+
+## Properties
+
+### host
+
+• `Optional` **host**: `string`
+
+___
+
+### locale
+
+• `Optional` **locale**: `string`

package/docs/interfaces/CheckoutButtonOptions.md

@@ -0,0 +1,55 @@
+[@bigcommerce/checkout-sdk](../README.md) / CheckoutButtonOptions
+
+# Interface: CheckoutButtonOptions
+
+The set of options for configuring the checkout button.
+
+## Hierarchy
+
+- [`RequestOptions`](RequestOptions.md)
+
+  ↳ **`CheckoutButtonOptions`**
+
+  ↳↳ [`CheckoutButtonInitializeOptions`](CheckoutButtonInitializeOptions.md)
+
+## Table of contents
+
+### Properties
+
+- [methodId](CheckoutButtonOptions.md#methodid)
+- [params](CheckoutButtonOptions.md#params)
+- [timeout](CheckoutButtonOptions.md#timeout)
+
+## Properties
+
+### methodId
+
+• **methodId**: [`CheckoutButtonMethodType`](../enums/CheckoutButtonMethodType.md)
+
+The identifier of the payment method.
+
+___
+
+### params
+
+• `Optional` **params**: `Object`
+
+The parameters of the request, if required.
+
+#### Inherited from
+
+[RequestOptions](RequestOptions.md).[params](RequestOptions.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
+
+[RequestOptions](RequestOptions.md).[timeout](RequestOptions.md#timeout)

package/docs/interfaces/CheckoutButtonSelectors.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / CheckoutButtonSelectors
+
+# Interface: CheckoutButtonSelectors
+
+## Table of contents
+
+### Properties
+
+- [errors](CheckoutButtonSelectors.md#errors)
+- [statuses](CheckoutButtonSelectors.md#statuses)
+
+## Properties
+
+### errors
+
+• **errors**: [`CheckoutButtonErrorSelector`](../classes/CheckoutButtonErrorSelector.md)
+
+___
+
+### statuses
+
+• **statuses**: [`CheckoutButtonStatusSelector`](../classes/CheckoutButtonStatusSelector.md)

package/docs/interfaces/CheckoutParams.md

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

package/docs/interfaces/CheckoutPayment.md

@@ -0,0 +1,42 @@
+[@bigcommerce/checkout-sdk](../README.md) / CheckoutPayment
+
+# Interface: CheckoutPayment
+
+## Table of contents
+
+### Properties
+
+- [detail](CheckoutPayment.md#detail)
+- [gatewayId](CheckoutPayment.md#gatewayid)
+- [providerId](CheckoutPayment.md#providerid)
+- [providerType](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/CheckoutRequestBody.md

@@ -0,0 +1,15 @@
+[@bigcommerce/checkout-sdk](../README.md) / CheckoutRequestBody
+
+# Interface: CheckoutRequestBody
+
+## Table of contents
+
+### Properties
+
+- [customerMessage](CheckoutRequestBody.md#customermessage)
+
+## Properties
+
+### customerMessage
+
+• **customerMessage**: `string`

package/docs/interfaces/CheckoutSelectors.md

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

package/docs/interfaces/CheckoutServiceOptions.md

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

package/docs/interfaces/CheckoutSettings.md

@@ -0,0 +1,201 @@
+[@bigcommerce/checkout-sdk](../README.md) / CheckoutSettings
+
+# Interface: CheckoutSettings
+
+## Table of contents
+
+### Properties
+
+- [checkoutBillingSameAsShippingEnabled](CheckoutSettings.md#checkoutbillingsameasshippingenabled)
+- [enableOrderComments](CheckoutSettings.md#enableordercomments)
+- [enableTermsAndConditions](CheckoutSettings.md#enabletermsandconditions)
+- [features](CheckoutSettings.md#features)
+- [googleMapsApiKey](CheckoutSettings.md#googlemapsapikey)
+- [googleRecaptchaSitekey](CheckoutSettings.md#googlerecaptchasitekey)
+- [guestCheckoutEnabled](CheckoutSettings.md#guestcheckoutenabled)
+- [hasMultiShippingEnabled](CheckoutSettings.md#hasmultishippingenabled)
+- [isAccountCreationEnabled](CheckoutSettings.md#isaccountcreationenabled)
+- [isAnalyticsEnabled](CheckoutSettings.md#isanalyticsenabled)
+- [isCardVaultingEnabled](CheckoutSettings.md#iscardvaultingenabled)
+- [isCouponCodeCollapsed](CheckoutSettings.md#iscouponcodecollapsed)
+- [isPaymentRequestCanMakePaymentEnabled](CheckoutSettings.md#ispaymentrequestcanmakepaymentenabled)
+- [isPaymentRequestEnabled](CheckoutSettings.md#ispaymentrequestenabled)
+- [isSignInEmailEnabled](CheckoutSettings.md#issigninemailenabled)
+- [isSpamProtectionEnabled](CheckoutSettings.md#isspamprotectionenabled)
+- [isStorefrontSpamProtectionEnabled](CheckoutSettings.md#isstorefrontspamprotectionenabled)
+- [isTrustedShippingAddressEnabled](CheckoutSettings.md#istrustedshippingaddressenabled)
+- [orderTermsAndConditions](CheckoutSettings.md#ordertermsandconditions)
+- [orderTermsAndConditionsLink](CheckoutSettings.md#ordertermsandconditionslink)
+- [orderTermsAndConditionsType](CheckoutSettings.md#ordertermsandconditionstype)
+- [privacyPolicyUrl](CheckoutSettings.md#privacypolicyurl)
+- [providerWithCustomCheckout](CheckoutSettings.md#providerwithcustomcheckout)
+- [realtimeShippingProviders](CheckoutSettings.md#realtimeshippingproviders)
+- [remoteCheckoutProviders](CheckoutSettings.md#remotecheckoutproviders)
+- [requiresMarketingConsent](CheckoutSettings.md#requiresmarketingconsent)
+- [shippingQuoteFailedMessage](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`