@bigcommerce/checkout-sdk 1.271.2 → 1.271.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +2 -0
- package/dist/checkout-button.d.ts +671 -651
- package/dist/checkout-button.js +1 -1
- package/dist/checkout-button.umd.js +1 -1
- package/dist/checkout-sdk.d.ts +7275 -763
- package/dist/checkout-sdk.js +1 -1
- package/dist/checkout-sdk.umd.js +1 -1
- package/dist/embedded-checkout.d.ts +242 -218
- package/dist/internal-mappers.d.ts +762 -763
- package/dist/tsdoc-metadata.json +11 -11
- package/docs/README.md +756 -126
- package/docs/classes/CartChangedError.md +76 -0
- package/docs/classes/CheckoutButtonErrorSelector.md +52 -0
- package/docs/classes/CheckoutButtonInitializer.md +177 -0
- package/docs/classes/CheckoutButtonStatusSelector.md +52 -0
- package/docs/classes/CheckoutService.md +1645 -0
- package/docs/classes/CurrencyService.md +54 -0
- package/docs/classes/EmbeddedCheckout.md +40 -0
- package/docs/classes/LanguageService.md +101 -0
- package/docs/classes/RequestError.md +106 -0
- package/docs/classes/StandardError.md +71 -0
- package/docs/enums/AmazonPayV2CheckoutLanguage.md +57 -0
- package/docs/enums/AmazonPayV2LedgerCurrency.md +36 -0
- package/docs/enums/AmazonPayV2PayOptions.md +26 -0
- package/docs/enums/AmazonPayV2Placement.md +53 -0
- package/docs/enums/BraintreeFormFieldType.md +50 -0
- package/docs/enums/ButtonColor.md +29 -0
- package/docs/enums/ButtonType.md +22 -0
- package/docs/enums/CheckoutButtonMethodType.md +141 -0
- package/docs/enums/CheckoutIncludes.md +29 -0
- package/docs/enums/EmbeddedCheckoutEventType.md +50 -0
- package/docs/enums/HostedFieldType.md +50 -0
- package/docs/enums/HostedInputEventType.md +85 -0
- package/docs/enums/IconStyle.md +22 -0
- package/docs/enums/PaypalButtonStyleColorOption.md +36 -0
- package/docs/enums/PaypalButtonStyleLabelOption.md +43 -0
- package/docs/enums/PaypalButtonStyleLayoutOption.md +22 -0
- package/docs/enums/PaypalButtonStyleShapeOption.md +22 -0
- package/docs/enums/PaypalButtonStyleSizeOption.md +36 -0
- package/docs/enums/PaypalCommerceFormFieldType.md +50 -0
- package/docs/enums/RadiusUnit.md +22 -0
- package/docs/enums/StyleButtonColor.md +43 -0
- package/docs/enums/StyleButtonLabel.md +43 -0
- package/docs/enums/StyleButtonLayout.md +22 -0
- package/docs/enums/StyleButtonShape.md +22 -0
- package/docs/interfaces/Address.md +164 -0
- package/docs/interfaces/AddressRequestBody.md +100 -0
- package/docs/interfaces/AdyenAdditionalActionCallbacks.md +68 -0
- package/docs/interfaces/AdyenAdditionalActionCallbacks_2.md +66 -0
- package/docs/interfaces/AdyenAdditionalActionOptions.md +106 -0
- package/docs/interfaces/AdyenAdditionalActionOptions_2.md +106 -0
- package/docs/interfaces/AdyenBaseCardComponentOptions.md +33 -0
- package/docs/interfaces/AdyenBaseCardComponentOptions_2.md +33 -0
- package/docs/interfaces/AdyenComponent.md +72 -0
- package/docs/interfaces/AdyenComponentEvents.md +74 -0
- package/docs/interfaces/AdyenComponentEvents_2.md +74 -0
- package/docs/interfaces/AdyenComponent_2.md +72 -0
- package/docs/interfaces/AdyenCreditCardComponentOptions.md +185 -0
- package/docs/interfaces/AdyenIdealComponentOptions.md +17 -0
- package/docs/interfaces/AdyenPaymentMethodState.md +21 -0
- package/docs/interfaces/AdyenPaymentMethodState_2.md +15 -0
- package/docs/interfaces/AdyenPlaceholderData.md +33 -0
- package/docs/interfaces/AdyenPlaceholderData_2.md +33 -0
- package/docs/interfaces/AdyenThreeDS2Options.md +97 -0
- package/docs/interfaces/AdyenV2PaymentInitializeOptions.md +161 -0
- package/docs/interfaces/AdyenV3CreditCardComponentOptions.md +185 -0
- package/docs/interfaces/AdyenV3PaymentInitializeOptions.md +135 -0
- package/docs/interfaces/AmazonPayCustomerInitializeOptions.md +65 -0
- package/docs/interfaces/AmazonPayOrderReference.md +30 -0
- package/docs/interfaces/AmazonPayPaymentInitializeOptions.md +100 -0
- package/docs/interfaces/AmazonPayShippingInitializeOptions.md +85 -0
- package/docs/interfaces/AmazonPayV2ButtonParams.md +71 -0
- package/docs/interfaces/AmazonPayV2CheckoutSession.md +35 -0
- package/docs/interfaces/AmazonPayV2CustomerInitializeOptions.md +24 -0
- package/docs/interfaces/AmazonPayV2PaymentInitializeOptions.md +39 -0
- package/docs/interfaces/AmazonPayV2ShippingInitializeOptions.md +26 -0
- package/docs/interfaces/AmazonPayWidgetError.md +25 -0
- package/docs/interfaces/ApplePayButtonInitializeOptions.md +38 -0
- package/docs/interfaces/ApplePayCustomerInitializeOptions.md +77 -0
- package/docs/interfaces/ApplePayPaymentInitializeOptions.md +40 -0
- package/docs/interfaces/BankInstrument.md +112 -0
- package/docs/interfaces/Banner.md +22 -0
- package/docs/interfaces/BaseAccountInstrument.md +91 -0
- package/docs/interfaces/BaseElementOptions.md +17 -0
- package/docs/interfaces/BaseElementOptions_2.md +48 -0
- package/docs/interfaces/BaseIndividualElementOptions.md +67 -0
- package/docs/interfaces/BaseInstrument.md +58 -0
- package/docs/interfaces/BillingAddress.md +182 -0
- package/docs/interfaces/BillingAddressRequestBody.md +153 -0
- package/docs/interfaces/BlockElementStyles.md +105 -0
- package/docs/interfaces/BlueSnapV2PaymentInitializeOptions.md +72 -0
- package/docs/interfaces/BlueSnapV2StyleProps.md +29 -0
- package/docs/interfaces/BodyStyles.md +15 -0
- package/docs/interfaces/BoltCustomerInitializeOptions.md +30 -0
- package/docs/interfaces/BoltPaymentInitializeOptions.md +94 -0
- package/docs/interfaces/BraintreeError.md +35 -0
- package/docs/interfaces/BraintreeFormFieldCardTypeChangeEventData.md +15 -0
- package/docs/interfaces/BraintreeFormFieldKeyboardEventData.md +15 -0
- package/docs/interfaces/BraintreeFormFieldOptions.md +35 -0
- package/docs/interfaces/BraintreeFormFieldStylesMap.md +29 -0
- package/docs/interfaces/BraintreeFormFieldValidateErrorData.md +29 -0
- package/docs/interfaces/BraintreeFormFieldValidateEventData.md +33 -0
- package/docs/interfaces/BraintreeFormFieldsMap.md +36 -0
- package/docs/interfaces/BraintreeFormOptions.md +110 -0
- package/docs/interfaces/BraintreePaymentInitializeOptions.md +101 -0
- package/docs/interfaces/BraintreePaypalButtonInitializeOptions.md +96 -0
- package/docs/interfaces/BraintreePaypalCreditButtonInitializeOptions.md +87 -0
- package/docs/interfaces/BraintreeStoredCardFieldOptions.md +54 -0
- package/docs/interfaces/BraintreeStoredCardFieldsMap.md +22 -0
- package/docs/interfaces/BraintreeThreeDSecureOptions.md +51 -0
- package/docs/interfaces/BraintreeVenmoButtonInitializeOptions.md +27 -0
- package/docs/interfaces/BraintreeVerifyPayload.md +51 -0
- package/docs/interfaces/BraintreeVisaCheckoutCustomerInitializeOptions.md +35 -0
- package/docs/interfaces/BraintreeVisaCheckoutPaymentInitializeOptions.md +70 -0
- package/docs/interfaces/BrowserInfo.md +50 -0
- package/docs/interfaces/ButtonResponse.md +19 -0
- package/docs/interfaces/ButtonStyles.md +141 -0
- package/docs/interfaces/CardCvcElementOptions.md +72 -0
- package/docs/interfaces/CardDataPaymentMethodState.md +15 -0
- package/docs/interfaces/CardDataPaymentMethodState_2.md +15 -0
- package/docs/interfaces/CardElementOptions.md +91 -0
- package/docs/interfaces/CardExpiryElementOptions.md +72 -0
- package/docs/interfaces/CardInstrument.md +115 -0
- package/docs/interfaces/CardNumberElementOptions.md +88 -0
- package/docs/interfaces/CardPaymentMethodState.md +60 -0
- package/docs/interfaces/CardPaymentMethodState_2.md +43 -0
- package/docs/interfaces/CardState.md +40 -0
- package/docs/interfaces/CardStateErrors.md +7 -0
- package/docs/interfaces/CardStateErrors_2.md +7 -0
- package/docs/interfaces/CardState_2.md +40 -0
- package/docs/interfaces/Cart.md +99 -0
- package/docs/interfaces/ChasePayCustomerInitializeOptions.md +15 -0
- package/docs/interfaces/ChasePayInitializeOptions.md +98 -0
- package/docs/interfaces/CheckableInputStyles.md +175 -0
- package/docs/interfaces/ChecklistStyles.md +127 -0
- package/docs/interfaces/Checkout.md +195 -0
- package/docs/interfaces/CheckoutButtonInitializeOptions.md +244 -0
- package/docs/interfaces/CheckoutButtonInitializerOptions.md +22 -0
- package/docs/interfaces/CheckoutButtonOptions.md +55 -0
- package/docs/interfaces/CheckoutButtonSelectors.md +22 -0
- package/docs/interfaces/CheckoutParams.md +15 -0
- package/docs/interfaces/CheckoutPayment.md +42 -0
- package/docs/interfaces/CheckoutRequestBody.md +15 -0
- package/docs/interfaces/CheckoutSelectors.md +29 -0
- package/docs/interfaces/CheckoutServiceOptions.md +36 -0
- package/docs/interfaces/CheckoutSettings.md +201 -0
- package/docs/interfaces/CheckoutStoreErrorSelector.md +636 -0
- package/docs/interfaces/CheckoutStoreSelector.md +501 -0
- package/docs/interfaces/CheckoutStoreStatusSelector.md +758 -0
- package/docs/interfaces/Consignment.md +71 -0
- package/docs/interfaces/ConsignmentAssignmentBaseRequestBodyWithAddress.md +29 -0
- package/docs/interfaces/ConsignmentAssignmentBaseRequestBodyWithShippingAddress.md +29 -0
- package/docs/interfaces/ConsignmentCreateRequestBody.md +36 -0
- package/docs/interfaces/ConsignmentLineItem.md +22 -0
- package/docs/interfaces/ConsignmentPickupOption.md +15 -0
- package/docs/interfaces/ConsignmentUpdateRequestBody.md +43 -0
- package/docs/interfaces/Coordinates.md +22 -0
- package/docs/interfaces/Country.md +43 -0
- package/docs/interfaces/Coupon.md +43 -0
- package/docs/interfaces/CreditCardInstrument.md +85 -0
- package/docs/interfaces/CreditCardPaymentInitializeOptions.md +91 -0
- package/docs/interfaces/CreditCardPlaceHolder.md +29 -0
- package/docs/interfaces/CreditCardPlaceHolder_2.md +29 -0
- package/docs/interfaces/CssProperties.md +211 -0
- package/docs/interfaces/CssProperties_2.md +211 -0
- package/docs/interfaces/Currency.md +36 -0
- package/docs/interfaces/CustomError.md +43 -0
- package/docs/interfaces/CustomItem.md +50 -0
- package/docs/interfaces/Customer.md +84 -0
- package/docs/interfaces/CustomerAccountRequestBody.md +50 -0
- package/docs/interfaces/CustomerAddress.md +182 -0
- package/docs/interfaces/CustomerCredentials.md +22 -0
- package/docs/interfaces/CustomerGroup.md +22 -0
- package/docs/interfaces/CustomerInitializeOptions.md +221 -0
- package/docs/interfaces/CustomerPasswordRequirements.md +36 -0
- package/docs/interfaces/CustomerRequestOptions.md +60 -0
- package/docs/interfaces/DigitalItem.md +310 -0
- package/docs/interfaces/DigitalRiverElementClasses.md +67 -0
- package/docs/interfaces/DigitalRiverPaymentInitializeOptions.md +146 -0
- package/docs/interfaces/Discount.md +22 -0
- package/docs/interfaces/EmbeddedCheckoutCompleteEvent.md +15 -0
- package/docs/interfaces/EmbeddedCheckoutError.md +29 -0
- package/docs/interfaces/EmbeddedCheckoutErrorEvent.md +22 -0
- package/docs/interfaces/EmbeddedCheckoutFrameErrorEvent.md +22 -0
- package/docs/interfaces/EmbeddedCheckoutFrameLoadedEvent.md +22 -0
- package/docs/interfaces/EmbeddedCheckoutLoadedEvent.md +15 -0
- package/docs/interfaces/EmbeddedCheckoutMessenger.md +109 -0
- package/docs/interfaces/EmbeddedCheckoutMessengerOptions.md +22 -0
- package/docs/interfaces/EmbeddedCheckoutOptions.md +134 -0
- package/docs/interfaces/EmbeddedCheckoutSignedOutEvent.md +15 -0
- package/docs/interfaces/EmbeddedCheckoutStyles.md +141 -0
- package/docs/interfaces/EmbeddedContentOptions.md +15 -0
- package/docs/interfaces/ExecutePaymentMethodCheckoutOptions.md +76 -0
- package/docs/interfaces/FlashMessage.md +29 -0
- package/docs/interfaces/FormField.md +113 -0
- package/docs/interfaces/FormFieldItem.md +22 -0
- package/docs/interfaces/FormFieldOptions.md +29 -0
- package/docs/interfaces/FormFields.md +29 -0
- package/docs/interfaces/GatewayOrderPayment.md +108 -0
- package/docs/interfaces/GiftCertificate.md +43 -0
- package/docs/interfaces/GiftCertificateItem.md +78 -0
- package/docs/interfaces/GiftCertificateOrderPayment.md +94 -0
- package/docs/interfaces/GooglePayButtonInitializeOptions.md +31 -0
- package/docs/interfaces/GooglePayCustomerInitializeOptions.md +42 -0
- package/docs/interfaces/GooglePayPaymentInitializeOptions.md +93 -0
- package/docs/interfaces/HostedCardFieldOptions.md +35 -0
- package/docs/interfaces/HostedCardFieldOptionsMap.md +36 -0
- package/docs/interfaces/HostedFieldStylesMap.md +29 -0
- package/docs/interfaces/HostedFormOptions.md +114 -0
- package/docs/interfaces/HostedInputBlurEvent.md +28 -0
- package/docs/interfaces/HostedInputCardTypeChangeEvent.md +28 -0
- package/docs/interfaces/HostedInputEnterEvent.md +28 -0
- package/docs/interfaces/HostedInputFocusEvent.md +28 -0
- package/docs/interfaces/HostedInputValidateErrorData.md +29 -0
- package/docs/interfaces/HostedInputValidateErrorDataMap.md +50 -0
- package/docs/interfaces/HostedInputValidateEvent.md +22 -0
- package/docs/interfaces/HostedInputValidateResults.md +22 -0
- package/docs/interfaces/HostedInstrument.md +22 -0
- package/docs/interfaces/HostedStoredCardFieldOptions.md +54 -0
- package/docs/interfaces/HostedStoredCardFieldOptionsMap.md +22 -0
- package/docs/interfaces/IbanElementOptions.md +82 -0
- package/docs/interfaces/IdealElementOptions.md +70 -0
- package/docs/interfaces/IndividualCardElementOptions.md +36 -0
- package/docs/interfaces/InitializationStrategy.md +21 -0
- package/docs/interfaces/InlineElementStyles.md +53 -0
- package/docs/interfaces/InputDetail.md +80 -0
- package/docs/interfaces/InputDetail_2.md +80 -0
- package/docs/interfaces/InputStyles.md +152 -0
- package/docs/interfaces/Item.md +22 -0
- package/docs/interfaces/Item_2.md +26 -0
- package/docs/interfaces/Item_3.md +26 -0
- package/docs/interfaces/KlarnaLoadResponse.md +28 -0
- package/docs/interfaces/KlarnaLoadResponse_2.md +28 -0
- package/docs/interfaces/KlarnaPaymentInitializeOptions.md +73 -0
- package/docs/interfaces/KlarnaV2PaymentInitializeOptions.md +73 -0
- package/docs/interfaces/LabelStyles.md +76 -0
- package/docs/interfaces/LanguageConfig.md +57 -0
- package/docs/interfaces/LineItem.md +191 -0
- package/docs/interfaces/LineItemCategory.md +15 -0
- package/docs/interfaces/LineItemMap.md +36 -0
- package/docs/interfaces/LineItemOption.md +36 -0
- package/docs/interfaces/LineItemSocialData.md +36 -0
- package/docs/interfaces/LinkStyles.md +90 -0
- package/docs/interfaces/LoadingIndicatorStyles.md +29 -0
- package/docs/interfaces/Locales.md +7 -0
- package/docs/interfaces/MasterpassCustomerInitializeOptions.md +17 -0
- package/docs/interfaces/MasterpassPaymentInitializeOptions.md +35 -0
- package/docs/interfaces/MolliePaymentInitializeOptions.md +96 -0
- package/docs/interfaces/MonerisPaymentInitializeOptions.md +57 -0
- package/docs/interfaces/MonerisStylingProps.md +80 -0
- package/docs/interfaces/NonceGenerationError.md +29 -0
- package/docs/interfaces/NonceInstrument.md +36 -0
- package/docs/interfaces/Option.md +22 -0
- package/docs/interfaces/OptionsResponse.md +77 -0
- package/docs/interfaces/OpyPaymentInitializeOptions.md +40 -0
- package/docs/interfaces/Order.md +190 -0
- package/docs/interfaces/OrderConsignment.md +15 -0
- package/docs/interfaces/OrderPayment.md +58 -0
- package/docs/interfaces/OrderPaymentRequestBody.md +39 -0
- package/docs/interfaces/OrderRequestBody.md +33 -0
- package/docs/interfaces/OrderShippingConsignment.md +218 -0
- package/docs/interfaces/PasswordRequirements.md +36 -0
- package/docs/interfaces/PayPalInstrument.md +91 -0
- package/docs/interfaces/PaymentInitializeOptions.md +406 -0
- package/docs/interfaces/PaymentMethod.md +98 -0
- package/docs/interfaces/PaymentMethodConfig.md +120 -0
- package/docs/interfaces/PaymentRequestOptions.md +67 -0
- package/docs/interfaces/PaymentSettings.md +22 -0
- package/docs/interfaces/PaypalButtonInitializeOptions.md +76 -0
- package/docs/interfaces/PaypalButtonStyleOptions.md +64 -0
- package/docs/interfaces/PaypalButtonStyleOptions_2.md +50 -0
- package/docs/interfaces/PaypalCommerceAlternativeMethodsButtonOptions.md +35 -0
- package/docs/interfaces/PaypalCommerceButtonInitializeOptions.md +26 -0
- package/docs/interfaces/PaypalCommerceCreditCardPaymentInitializeOptions.md +90 -0
- package/docs/interfaces/PaypalCommerceFormFieldCardTypeChangeEventData.md +15 -0
- package/docs/interfaces/PaypalCommerceFormFieldKeyboardEventData.md +15 -0
- package/docs/interfaces/PaypalCommerceFormFieldOptions.md +28 -0
- package/docs/interfaces/PaypalCommerceFormFieldStylesMap.md +29 -0
- package/docs/interfaces/PaypalCommerceFormFieldValidateErrorData.md +29 -0
- package/docs/interfaces/PaypalCommerceFormFieldValidateEventData.md +33 -0
- package/docs/interfaces/PaypalCommerceFormFieldsMap.md +36 -0
- package/docs/interfaces/PaypalCommerceFormOptions.md +148 -0
- package/docs/interfaces/PaypalCommercePaymentInitializeOptions.md +186 -0
- package/docs/interfaces/PaypalCommerceStoredCardFieldOptions.md +43 -0
- package/docs/interfaces/PaypalCommerceStoredCardFieldsMap.md +22 -0
- package/docs/interfaces/PaypalCommerceVenmoButtonInitializeOptions.md +26 -0
- package/docs/interfaces/PaypalExpressPaymentInitializeOptions.md +36 -0
- package/docs/interfaces/PaypalFieldsStyleOptions.md +46 -0
- package/docs/interfaces/PhysicalItem.md +311 -0
- package/docs/interfaces/PickupMethod.md +43 -0
- package/docs/interfaces/PickupOptionRequestBody.md +22 -0
- package/docs/interfaces/PickupOptionResult.md +15 -0
- package/docs/interfaces/Promotion.md +15 -0
- package/docs/interfaces/Radius.md +22 -0
- package/docs/interfaces/Region.md +22 -0
- package/docs/interfaces/RequestOptions.md +48 -0
- package/docs/interfaces/SearchArea.md +22 -0
- package/docs/interfaces/SepaPlaceHolder.md +22 -0
- package/docs/interfaces/SepaPlaceHolder_2.md +22 -0
- package/docs/interfaces/ShippingInitializeOptions.md +88 -0
- package/docs/interfaces/ShippingOption.md +64 -0
- package/docs/interfaces/ShippingRequestOptions.md +65 -0
- package/docs/interfaces/ShopperConfig.md +29 -0
- package/docs/interfaces/ShopperCurrency.md +94 -0
- package/docs/interfaces/SignInEmail.md +22 -0
- package/docs/interfaces/SignInEmailRequestBody.md +22 -0
- package/docs/interfaces/SpamProtectionOptions.md +25 -0
- package/docs/interfaces/SquareFormElement.md +28 -0
- package/docs/interfaces/SquarePaymentInitializeOptions.md +131 -0
- package/docs/interfaces/StepStyles.md +120 -0
- package/docs/interfaces/StepTracker.md +64 -0
- package/docs/interfaces/StepTrackerConfig.md +15 -0
- package/docs/interfaces/StoreConfig.md +109 -0
- package/docs/interfaces/StoreCurrency.md +56 -0
- package/docs/interfaces/StoreLinks.md +57 -0
- package/docs/interfaces/StoreProfile.md +71 -0
- package/docs/interfaces/StripeElementCSSProperties.md +170 -0
- package/docs/interfaces/StripeElementClasses.md +63 -0
- package/docs/interfaces/StripeElementStyle.md +44 -0
- package/docs/interfaces/StripeElementStyleVariant.md +285 -0
- package/docs/interfaces/StripeUPEPaymentInitializeOptions.md +70 -0
- package/docs/interfaces/StripeV3PaymentInitializeOptions.md +76 -0
- package/docs/interfaces/StyleOptions.md +44 -0
- package/docs/interfaces/StyleOptions_2.md +44 -0
- package/docs/interfaces/SubInputDetail.md +62 -0
- package/docs/interfaces/SubInputDetail_2.md +62 -0
- package/docs/interfaces/Subscriptions.md +29 -0
- package/docs/interfaces/Tax.md +22 -0
- package/docs/interfaces/TextInputStyles.md +175 -0
- package/docs/interfaces/ThreeDSecure.md +50 -0
- package/docs/interfaces/ThreeDSecureToken.md +15 -0
- package/docs/interfaces/TranslationData.md +7 -0
- package/docs/interfaces/Translations.md +7 -0
- package/docs/interfaces/UnknownObject.md +7 -0
- package/docs/interfaces/VaultedInstrument.md +29 -0
- package/docs/interfaces/WechatDataPaymentMethodState.md +15 -0
- package/docs/interfaces/WechatDataPaymentMethodState_2.md +15 -0
- package/docs/interfaces/WechatState.md +15 -0
- package/docs/interfaces/WechatState_2.md +15 -0
- package/docs/interfaces/WithAccountCreation.md +15 -0
- package/docs/interfaces/WithCheckoutcomFawryInstrument.md +22 -0
- package/docs/interfaces/WithCheckoutcomSEPAInstrument.md +22 -0
- package/docs/interfaces/WithCheckoutcomiDealInstrument.md +15 -0
- package/docs/interfaces/WithDocumentInstrument.md +15 -0
- package/docs/interfaces/WithMollieIssuerInstrument.md +22 -0
- package/docs/interfaces/WorldpayPaymentInitializeOptions.md +30 -0
- package/docs/interfaces/ZipCodeElementOptions.md +15 -0
- package/package.json +2 -2
- package/docs/classes/CacheKeyResolver.md +0 -58
package/docs/README.md
CHANGED
|
@@ -4,250 +4,880 @@
|
|
|
4
4
|
|
|
5
5
|
## Table of contents
|
|
6
6
|
|
|
7
|
+
### Enumerations
|
|
8
|
+
|
|
9
|
+
- [AmazonPayV2CheckoutLanguage](enums/AmazonPayV2CheckoutLanguage.md)
|
|
10
|
+
- [AmazonPayV2LedgerCurrency](enums/AmazonPayV2LedgerCurrency.md)
|
|
11
|
+
- [AmazonPayV2PayOptions](enums/AmazonPayV2PayOptions.md)
|
|
12
|
+
- [AmazonPayV2Placement](enums/AmazonPayV2Placement.md)
|
|
13
|
+
- [BraintreeFormFieldType](enums/BraintreeFormFieldType.md)
|
|
14
|
+
- [ButtonColor](enums/ButtonColor.md)
|
|
15
|
+
- [ButtonType](enums/ButtonType.md)
|
|
16
|
+
- [CheckoutButtonMethodType](enums/CheckoutButtonMethodType.md)
|
|
17
|
+
- [CheckoutIncludes](enums/CheckoutIncludes.md)
|
|
18
|
+
- [EmbeddedCheckoutEventType](enums/EmbeddedCheckoutEventType.md)
|
|
19
|
+
- [HostedFieldType](enums/HostedFieldType.md)
|
|
20
|
+
- [HostedInputEventType](enums/HostedInputEventType.md)
|
|
21
|
+
- [IconStyle](enums/IconStyle.md)
|
|
22
|
+
- [PaypalButtonStyleColorOption](enums/PaypalButtonStyleColorOption.md)
|
|
23
|
+
- [PaypalButtonStyleLabelOption](enums/PaypalButtonStyleLabelOption.md)
|
|
24
|
+
- [PaypalButtonStyleLayoutOption](enums/PaypalButtonStyleLayoutOption.md)
|
|
25
|
+
- [PaypalButtonStyleShapeOption](enums/PaypalButtonStyleShapeOption.md)
|
|
26
|
+
- [PaypalButtonStyleSizeOption](enums/PaypalButtonStyleSizeOption.md)
|
|
27
|
+
- [PaypalCommerceFormFieldType](enums/PaypalCommerceFormFieldType.md)
|
|
28
|
+
- [RadiusUnit](enums/RadiusUnit.md)
|
|
29
|
+
- [StyleButtonColor](enums/StyleButtonColor.md)
|
|
30
|
+
- [StyleButtonLabel](enums/StyleButtonLabel.md)
|
|
31
|
+
- [StyleButtonLayout](enums/StyleButtonLayout.md)
|
|
32
|
+
- [StyleButtonShape](enums/StyleButtonShape.md)
|
|
33
|
+
|
|
7
34
|
### Classes
|
|
8
35
|
|
|
9
|
-
- [
|
|
36
|
+
- [CartChangedError](classes/CartChangedError.md)
|
|
37
|
+
- [CheckoutButtonErrorSelector](classes/CheckoutButtonErrorSelector.md)
|
|
38
|
+
- [CheckoutButtonInitializer](classes/CheckoutButtonInitializer.md)
|
|
39
|
+
- [CheckoutButtonStatusSelector](classes/CheckoutButtonStatusSelector.md)
|
|
40
|
+
- [CheckoutService](classes/CheckoutService.md)
|
|
41
|
+
- [CurrencyService](classes/CurrencyService.md)
|
|
42
|
+
- [EmbeddedCheckout](classes/EmbeddedCheckout.md)
|
|
43
|
+
- [LanguageService](classes/LanguageService.md)
|
|
44
|
+
- [RequestError](classes/RequestError.md)
|
|
45
|
+
- [StandardError](classes/StandardError.md)
|
|
46
|
+
|
|
47
|
+
### Interfaces
|
|
48
|
+
|
|
49
|
+
- [Address](interfaces/Address.md)
|
|
50
|
+
- [AddressRequestBody](interfaces/AddressRequestBody.md)
|
|
51
|
+
- [AdyenAdditionalActionCallbacks](interfaces/AdyenAdditionalActionCallbacks.md)
|
|
52
|
+
- [AdyenAdditionalActionCallbacks_2](interfaces/AdyenAdditionalActionCallbacks_2.md)
|
|
53
|
+
- [AdyenAdditionalActionOptions](interfaces/AdyenAdditionalActionOptions.md)
|
|
54
|
+
- [AdyenAdditionalActionOptions_2](interfaces/AdyenAdditionalActionOptions_2.md)
|
|
55
|
+
- [AdyenBaseCardComponentOptions](interfaces/AdyenBaseCardComponentOptions.md)
|
|
56
|
+
- [AdyenBaseCardComponentOptions_2](interfaces/AdyenBaseCardComponentOptions_2.md)
|
|
57
|
+
- [AdyenComponent](interfaces/AdyenComponent.md)
|
|
58
|
+
- [AdyenComponentEvents](interfaces/AdyenComponentEvents.md)
|
|
59
|
+
- [AdyenComponentEvents_2](interfaces/AdyenComponentEvents_2.md)
|
|
60
|
+
- [AdyenComponent_2](interfaces/AdyenComponent_2.md)
|
|
61
|
+
- [AdyenCreditCardComponentOptions](interfaces/AdyenCreditCardComponentOptions.md)
|
|
62
|
+
- [AdyenIdealComponentOptions](interfaces/AdyenIdealComponentOptions.md)
|
|
63
|
+
- [AdyenPaymentMethodState](interfaces/AdyenPaymentMethodState.md)
|
|
64
|
+
- [AdyenPaymentMethodState_2](interfaces/AdyenPaymentMethodState_2.md)
|
|
65
|
+
- [AdyenPlaceholderData](interfaces/AdyenPlaceholderData.md)
|
|
66
|
+
- [AdyenPlaceholderData_2](interfaces/AdyenPlaceholderData_2.md)
|
|
67
|
+
- [AdyenThreeDS2Options](interfaces/AdyenThreeDS2Options.md)
|
|
68
|
+
- [AdyenV2PaymentInitializeOptions](interfaces/AdyenV2PaymentInitializeOptions.md)
|
|
69
|
+
- [AdyenV3CreditCardComponentOptions](interfaces/AdyenV3CreditCardComponentOptions.md)
|
|
70
|
+
- [AdyenV3PaymentInitializeOptions](interfaces/AdyenV3PaymentInitializeOptions.md)
|
|
71
|
+
- [AmazonPayCustomerInitializeOptions](interfaces/AmazonPayCustomerInitializeOptions.md)
|
|
72
|
+
- [AmazonPayOrderReference](interfaces/AmazonPayOrderReference.md)
|
|
73
|
+
- [AmazonPayPaymentInitializeOptions](interfaces/AmazonPayPaymentInitializeOptions.md)
|
|
74
|
+
- [AmazonPayShippingInitializeOptions](interfaces/AmazonPayShippingInitializeOptions.md)
|
|
75
|
+
- [AmazonPayV2ButtonParams](interfaces/AmazonPayV2ButtonParams.md)
|
|
76
|
+
- [AmazonPayV2CheckoutSession](interfaces/AmazonPayV2CheckoutSession.md)
|
|
77
|
+
- [AmazonPayV2CustomerInitializeOptions](interfaces/AmazonPayV2CustomerInitializeOptions.md)
|
|
78
|
+
- [AmazonPayV2PaymentInitializeOptions](interfaces/AmazonPayV2PaymentInitializeOptions.md)
|
|
79
|
+
- [AmazonPayV2ShippingInitializeOptions](interfaces/AmazonPayV2ShippingInitializeOptions.md)
|
|
80
|
+
- [AmazonPayWidgetError](interfaces/AmazonPayWidgetError.md)
|
|
81
|
+
- [ApplePayButtonInitializeOptions](interfaces/ApplePayButtonInitializeOptions.md)
|
|
82
|
+
- [ApplePayCustomerInitializeOptions](interfaces/ApplePayCustomerInitializeOptions.md)
|
|
83
|
+
- [ApplePayPaymentInitializeOptions](interfaces/ApplePayPaymentInitializeOptions.md)
|
|
84
|
+
- [BankInstrument](interfaces/BankInstrument.md)
|
|
85
|
+
- [Banner](interfaces/Banner.md)
|
|
86
|
+
- [BaseAccountInstrument](interfaces/BaseAccountInstrument.md)
|
|
87
|
+
- [BaseElementOptions](interfaces/BaseElementOptions.md)
|
|
88
|
+
- [BaseElementOptions_2](interfaces/BaseElementOptions_2.md)
|
|
89
|
+
- [BaseIndividualElementOptions](interfaces/BaseIndividualElementOptions.md)
|
|
90
|
+
- [BaseInstrument](interfaces/BaseInstrument.md)
|
|
91
|
+
- [BillingAddress](interfaces/BillingAddress.md)
|
|
92
|
+
- [BillingAddressRequestBody](interfaces/BillingAddressRequestBody.md)
|
|
93
|
+
- [BlockElementStyles](interfaces/BlockElementStyles.md)
|
|
94
|
+
- [BlueSnapV2PaymentInitializeOptions](interfaces/BlueSnapV2PaymentInitializeOptions.md)
|
|
95
|
+
- [BlueSnapV2StyleProps](interfaces/BlueSnapV2StyleProps.md)
|
|
96
|
+
- [BodyStyles](interfaces/BodyStyles.md)
|
|
97
|
+
- [BoltCustomerInitializeOptions](interfaces/BoltCustomerInitializeOptions.md)
|
|
98
|
+
- [BoltPaymentInitializeOptions](interfaces/BoltPaymentInitializeOptions.md)
|
|
99
|
+
- [BraintreeError](interfaces/BraintreeError.md)
|
|
100
|
+
- [BraintreeFormFieldCardTypeChangeEventData](interfaces/BraintreeFormFieldCardTypeChangeEventData.md)
|
|
101
|
+
- [BraintreeFormFieldKeyboardEventData](interfaces/BraintreeFormFieldKeyboardEventData.md)
|
|
102
|
+
- [BraintreeFormFieldOptions](interfaces/BraintreeFormFieldOptions.md)
|
|
103
|
+
- [BraintreeFormFieldStylesMap](interfaces/BraintreeFormFieldStylesMap.md)
|
|
104
|
+
- [BraintreeFormFieldValidateErrorData](interfaces/BraintreeFormFieldValidateErrorData.md)
|
|
105
|
+
- [BraintreeFormFieldValidateEventData](interfaces/BraintreeFormFieldValidateEventData.md)
|
|
106
|
+
- [BraintreeFormFieldsMap](interfaces/BraintreeFormFieldsMap.md)
|
|
107
|
+
- [BraintreeFormOptions](interfaces/BraintreeFormOptions.md)
|
|
108
|
+
- [BraintreePaymentInitializeOptions](interfaces/BraintreePaymentInitializeOptions.md)
|
|
109
|
+
- [BraintreePaypalButtonInitializeOptions](interfaces/BraintreePaypalButtonInitializeOptions.md)
|
|
110
|
+
- [BraintreePaypalCreditButtonInitializeOptions](interfaces/BraintreePaypalCreditButtonInitializeOptions.md)
|
|
111
|
+
- [BraintreeStoredCardFieldOptions](interfaces/BraintreeStoredCardFieldOptions.md)
|
|
112
|
+
- [BraintreeStoredCardFieldsMap](interfaces/BraintreeStoredCardFieldsMap.md)
|
|
113
|
+
- [BraintreeThreeDSecureOptions](interfaces/BraintreeThreeDSecureOptions.md)
|
|
114
|
+
- [BraintreeVenmoButtonInitializeOptions](interfaces/BraintreeVenmoButtonInitializeOptions.md)
|
|
115
|
+
- [BraintreeVerifyPayload](interfaces/BraintreeVerifyPayload.md)
|
|
116
|
+
- [BraintreeVisaCheckoutCustomerInitializeOptions](interfaces/BraintreeVisaCheckoutCustomerInitializeOptions.md)
|
|
117
|
+
- [BraintreeVisaCheckoutPaymentInitializeOptions](interfaces/BraintreeVisaCheckoutPaymentInitializeOptions.md)
|
|
118
|
+
- [BrowserInfo](interfaces/BrowserInfo.md)
|
|
119
|
+
- [ButtonResponse](interfaces/ButtonResponse.md)
|
|
120
|
+
- [ButtonStyles](interfaces/ButtonStyles.md)
|
|
121
|
+
- [CardCvcElementOptions](interfaces/CardCvcElementOptions.md)
|
|
122
|
+
- [CardDataPaymentMethodState](interfaces/CardDataPaymentMethodState.md)
|
|
123
|
+
- [CardDataPaymentMethodState_2](interfaces/CardDataPaymentMethodState_2.md)
|
|
124
|
+
- [CardElementOptions](interfaces/CardElementOptions.md)
|
|
125
|
+
- [CardExpiryElementOptions](interfaces/CardExpiryElementOptions.md)
|
|
126
|
+
- [CardInstrument](interfaces/CardInstrument.md)
|
|
127
|
+
- [CardNumberElementOptions](interfaces/CardNumberElementOptions.md)
|
|
128
|
+
- [CardPaymentMethodState](interfaces/CardPaymentMethodState.md)
|
|
129
|
+
- [CardPaymentMethodState_2](interfaces/CardPaymentMethodState_2.md)
|
|
130
|
+
- [CardState](interfaces/CardState.md)
|
|
131
|
+
- [CardStateErrors](interfaces/CardStateErrors.md)
|
|
132
|
+
- [CardStateErrors_2](interfaces/CardStateErrors_2.md)
|
|
133
|
+
- [CardState_2](interfaces/CardState_2.md)
|
|
134
|
+
- [Cart](interfaces/Cart.md)
|
|
135
|
+
- [ChasePayCustomerInitializeOptions](interfaces/ChasePayCustomerInitializeOptions.md)
|
|
136
|
+
- [ChasePayInitializeOptions](interfaces/ChasePayInitializeOptions.md)
|
|
137
|
+
- [CheckableInputStyles](interfaces/CheckableInputStyles.md)
|
|
138
|
+
- [ChecklistStyles](interfaces/ChecklistStyles.md)
|
|
139
|
+
- [Checkout](interfaces/Checkout.md)
|
|
140
|
+
- [CheckoutButtonInitializeOptions](interfaces/CheckoutButtonInitializeOptions.md)
|
|
141
|
+
- [CheckoutButtonInitializerOptions](interfaces/CheckoutButtonInitializerOptions.md)
|
|
142
|
+
- [CheckoutButtonOptions](interfaces/CheckoutButtonOptions.md)
|
|
143
|
+
- [CheckoutButtonSelectors](interfaces/CheckoutButtonSelectors.md)
|
|
144
|
+
- [CheckoutParams](interfaces/CheckoutParams.md)
|
|
145
|
+
- [CheckoutPayment](interfaces/CheckoutPayment.md)
|
|
146
|
+
- [CheckoutRequestBody](interfaces/CheckoutRequestBody.md)
|
|
147
|
+
- [CheckoutSelectors](interfaces/CheckoutSelectors.md)
|
|
148
|
+
- [CheckoutServiceOptions](interfaces/CheckoutServiceOptions.md)
|
|
149
|
+
- [CheckoutSettings](interfaces/CheckoutSettings.md)
|
|
150
|
+
- [CheckoutStoreErrorSelector](interfaces/CheckoutStoreErrorSelector.md)
|
|
151
|
+
- [CheckoutStoreSelector](interfaces/CheckoutStoreSelector.md)
|
|
152
|
+
- [CheckoutStoreStatusSelector](interfaces/CheckoutStoreStatusSelector.md)
|
|
153
|
+
- [Consignment](interfaces/Consignment.md)
|
|
154
|
+
- [ConsignmentAssignmentBaseRequestBodyWithAddress](interfaces/ConsignmentAssignmentBaseRequestBodyWithAddress.md)
|
|
155
|
+
- [ConsignmentAssignmentBaseRequestBodyWithShippingAddress](interfaces/ConsignmentAssignmentBaseRequestBodyWithShippingAddress.md)
|
|
156
|
+
- [ConsignmentCreateRequestBody](interfaces/ConsignmentCreateRequestBody.md)
|
|
157
|
+
- [ConsignmentLineItem](interfaces/ConsignmentLineItem.md)
|
|
158
|
+
- [ConsignmentPickupOption](interfaces/ConsignmentPickupOption.md)
|
|
159
|
+
- [ConsignmentUpdateRequestBody](interfaces/ConsignmentUpdateRequestBody.md)
|
|
160
|
+
- [Coordinates](interfaces/Coordinates.md)
|
|
161
|
+
- [Country](interfaces/Country.md)
|
|
162
|
+
- [Coupon](interfaces/Coupon.md)
|
|
163
|
+
- [CreditCardInstrument](interfaces/CreditCardInstrument.md)
|
|
164
|
+
- [CreditCardPaymentInitializeOptions](interfaces/CreditCardPaymentInitializeOptions.md)
|
|
165
|
+
- [CreditCardPlaceHolder](interfaces/CreditCardPlaceHolder.md)
|
|
166
|
+
- [CreditCardPlaceHolder_2](interfaces/CreditCardPlaceHolder_2.md)
|
|
167
|
+
- [CssProperties](interfaces/CssProperties.md)
|
|
168
|
+
- [CssProperties_2](interfaces/CssProperties_2.md)
|
|
169
|
+
- [Currency](interfaces/Currency.md)
|
|
170
|
+
- [CustomError](interfaces/CustomError.md)
|
|
171
|
+
- [CustomItem](interfaces/CustomItem.md)
|
|
172
|
+
- [Customer](interfaces/Customer.md)
|
|
173
|
+
- [CustomerAccountRequestBody](interfaces/CustomerAccountRequestBody.md)
|
|
174
|
+
- [CustomerAddress](interfaces/CustomerAddress.md)
|
|
175
|
+
- [CustomerCredentials](interfaces/CustomerCredentials.md)
|
|
176
|
+
- [CustomerGroup](interfaces/CustomerGroup.md)
|
|
177
|
+
- [CustomerInitializeOptions](interfaces/CustomerInitializeOptions.md)
|
|
178
|
+
- [CustomerPasswordRequirements](interfaces/CustomerPasswordRequirements.md)
|
|
179
|
+
- [CustomerRequestOptions](interfaces/CustomerRequestOptions.md)
|
|
180
|
+
- [DigitalItem](interfaces/DigitalItem.md)
|
|
181
|
+
- [DigitalRiverElementClasses](interfaces/DigitalRiverElementClasses.md)
|
|
182
|
+
- [DigitalRiverPaymentInitializeOptions](interfaces/DigitalRiverPaymentInitializeOptions.md)
|
|
183
|
+
- [Discount](interfaces/Discount.md)
|
|
184
|
+
- [EmbeddedCheckoutCompleteEvent](interfaces/EmbeddedCheckoutCompleteEvent.md)
|
|
185
|
+
- [EmbeddedCheckoutError](interfaces/EmbeddedCheckoutError.md)
|
|
186
|
+
- [EmbeddedCheckoutErrorEvent](interfaces/EmbeddedCheckoutErrorEvent.md)
|
|
187
|
+
- [EmbeddedCheckoutFrameErrorEvent](interfaces/EmbeddedCheckoutFrameErrorEvent.md)
|
|
188
|
+
- [EmbeddedCheckoutFrameLoadedEvent](interfaces/EmbeddedCheckoutFrameLoadedEvent.md)
|
|
189
|
+
- [EmbeddedCheckoutLoadedEvent](interfaces/EmbeddedCheckoutLoadedEvent.md)
|
|
190
|
+
- [EmbeddedCheckoutMessenger](interfaces/EmbeddedCheckoutMessenger.md)
|
|
191
|
+
- [EmbeddedCheckoutMessengerOptions](interfaces/EmbeddedCheckoutMessengerOptions.md)
|
|
192
|
+
- [EmbeddedCheckoutOptions](interfaces/EmbeddedCheckoutOptions.md)
|
|
193
|
+
- [EmbeddedCheckoutSignedOutEvent](interfaces/EmbeddedCheckoutSignedOutEvent.md)
|
|
194
|
+
- [EmbeddedCheckoutStyles](interfaces/EmbeddedCheckoutStyles.md)
|
|
195
|
+
- [EmbeddedContentOptions](interfaces/EmbeddedContentOptions.md)
|
|
196
|
+
- [ExecutePaymentMethodCheckoutOptions](interfaces/ExecutePaymentMethodCheckoutOptions.md)
|
|
197
|
+
- [FlashMessage](interfaces/FlashMessage.md)
|
|
198
|
+
- [FormField](interfaces/FormField.md)
|
|
199
|
+
- [FormFieldItem](interfaces/FormFieldItem.md)
|
|
200
|
+
- [FormFieldOptions](interfaces/FormFieldOptions.md)
|
|
201
|
+
- [FormFields](interfaces/FormFields.md)
|
|
202
|
+
- [GatewayOrderPayment](interfaces/GatewayOrderPayment.md)
|
|
203
|
+
- [GiftCertificate](interfaces/GiftCertificate.md)
|
|
204
|
+
- [GiftCertificateItem](interfaces/GiftCertificateItem.md)
|
|
205
|
+
- [GiftCertificateOrderPayment](interfaces/GiftCertificateOrderPayment.md)
|
|
206
|
+
- [GooglePayButtonInitializeOptions](interfaces/GooglePayButtonInitializeOptions.md)
|
|
207
|
+
- [GooglePayCustomerInitializeOptions](interfaces/GooglePayCustomerInitializeOptions.md)
|
|
208
|
+
- [GooglePayPaymentInitializeOptions](interfaces/GooglePayPaymentInitializeOptions.md)
|
|
209
|
+
- [HostedCardFieldOptions](interfaces/HostedCardFieldOptions.md)
|
|
210
|
+
- [HostedCardFieldOptionsMap](interfaces/HostedCardFieldOptionsMap.md)
|
|
211
|
+
- [HostedFieldStylesMap](interfaces/HostedFieldStylesMap.md)
|
|
212
|
+
- [HostedFormOptions](interfaces/HostedFormOptions.md)
|
|
213
|
+
- [HostedInputBlurEvent](interfaces/HostedInputBlurEvent.md)
|
|
214
|
+
- [HostedInputCardTypeChangeEvent](interfaces/HostedInputCardTypeChangeEvent.md)
|
|
215
|
+
- [HostedInputEnterEvent](interfaces/HostedInputEnterEvent.md)
|
|
216
|
+
- [HostedInputFocusEvent](interfaces/HostedInputFocusEvent.md)
|
|
217
|
+
- [HostedInputValidateErrorData](interfaces/HostedInputValidateErrorData.md)
|
|
218
|
+
- [HostedInputValidateErrorDataMap](interfaces/HostedInputValidateErrorDataMap.md)
|
|
219
|
+
- [HostedInputValidateEvent](interfaces/HostedInputValidateEvent.md)
|
|
220
|
+
- [HostedInputValidateResults](interfaces/HostedInputValidateResults.md)
|
|
221
|
+
- [HostedInstrument](interfaces/HostedInstrument.md)
|
|
222
|
+
- [HostedStoredCardFieldOptions](interfaces/HostedStoredCardFieldOptions.md)
|
|
223
|
+
- [HostedStoredCardFieldOptionsMap](interfaces/HostedStoredCardFieldOptionsMap.md)
|
|
224
|
+
- [IbanElementOptions](interfaces/IbanElementOptions.md)
|
|
225
|
+
- [IdealElementOptions](interfaces/IdealElementOptions.md)
|
|
226
|
+
- [IndividualCardElementOptions](interfaces/IndividualCardElementOptions.md)
|
|
227
|
+
- [InitializationStrategy](interfaces/InitializationStrategy.md)
|
|
228
|
+
- [InlineElementStyles](interfaces/InlineElementStyles.md)
|
|
229
|
+
- [InputDetail](interfaces/InputDetail.md)
|
|
230
|
+
- [InputDetail_2](interfaces/InputDetail_2.md)
|
|
231
|
+
- [InputStyles](interfaces/InputStyles.md)
|
|
232
|
+
- [Item](interfaces/Item.md)
|
|
233
|
+
- [Item_2](interfaces/Item_2.md)
|
|
234
|
+
- [Item_3](interfaces/Item_3.md)
|
|
235
|
+
- [KlarnaLoadResponse](interfaces/KlarnaLoadResponse.md)
|
|
236
|
+
- [KlarnaLoadResponse_2](interfaces/KlarnaLoadResponse_2.md)
|
|
237
|
+
- [KlarnaPaymentInitializeOptions](interfaces/KlarnaPaymentInitializeOptions.md)
|
|
238
|
+
- [KlarnaV2PaymentInitializeOptions](interfaces/KlarnaV2PaymentInitializeOptions.md)
|
|
239
|
+
- [LabelStyles](interfaces/LabelStyles.md)
|
|
240
|
+
- [LanguageConfig](interfaces/LanguageConfig.md)
|
|
241
|
+
- [LineItem](interfaces/LineItem.md)
|
|
242
|
+
- [LineItemCategory](interfaces/LineItemCategory.md)
|
|
243
|
+
- [LineItemMap](interfaces/LineItemMap.md)
|
|
244
|
+
- [LineItemOption](interfaces/LineItemOption.md)
|
|
245
|
+
- [LineItemSocialData](interfaces/LineItemSocialData.md)
|
|
246
|
+
- [LinkStyles](interfaces/LinkStyles.md)
|
|
247
|
+
- [LoadingIndicatorStyles](interfaces/LoadingIndicatorStyles.md)
|
|
248
|
+
- [Locales](interfaces/Locales.md)
|
|
249
|
+
- [MasterpassCustomerInitializeOptions](interfaces/MasterpassCustomerInitializeOptions.md)
|
|
250
|
+
- [MasterpassPaymentInitializeOptions](interfaces/MasterpassPaymentInitializeOptions.md)
|
|
251
|
+
- [MolliePaymentInitializeOptions](interfaces/MolliePaymentInitializeOptions.md)
|
|
252
|
+
- [MonerisPaymentInitializeOptions](interfaces/MonerisPaymentInitializeOptions.md)
|
|
253
|
+
- [MonerisStylingProps](interfaces/MonerisStylingProps.md)
|
|
254
|
+
- [NonceGenerationError](interfaces/NonceGenerationError.md)
|
|
255
|
+
- [NonceInstrument](interfaces/NonceInstrument.md)
|
|
256
|
+
- [Option](interfaces/Option.md)
|
|
257
|
+
- [OptionsResponse](interfaces/OptionsResponse.md)
|
|
258
|
+
- [OpyPaymentInitializeOptions](interfaces/OpyPaymentInitializeOptions.md)
|
|
259
|
+
- [Order](interfaces/Order.md)
|
|
260
|
+
- [OrderConsignment](interfaces/OrderConsignment.md)
|
|
261
|
+
- [OrderPayment](interfaces/OrderPayment.md)
|
|
262
|
+
- [OrderPaymentRequestBody](interfaces/OrderPaymentRequestBody.md)
|
|
263
|
+
- [OrderRequestBody](interfaces/OrderRequestBody.md)
|
|
264
|
+
- [OrderShippingConsignment](interfaces/OrderShippingConsignment.md)
|
|
265
|
+
- [PasswordRequirements](interfaces/PasswordRequirements.md)
|
|
266
|
+
- [PayPalInstrument](interfaces/PayPalInstrument.md)
|
|
267
|
+
- [PaymentInitializeOptions](interfaces/PaymentInitializeOptions.md)
|
|
268
|
+
- [PaymentMethod](interfaces/PaymentMethod.md)
|
|
269
|
+
- [PaymentMethodConfig](interfaces/PaymentMethodConfig.md)
|
|
270
|
+
- [PaymentRequestOptions](interfaces/PaymentRequestOptions.md)
|
|
271
|
+
- [PaymentSettings](interfaces/PaymentSettings.md)
|
|
272
|
+
- [PaypalButtonInitializeOptions](interfaces/PaypalButtonInitializeOptions.md)
|
|
273
|
+
- [PaypalButtonStyleOptions](interfaces/PaypalButtonStyleOptions.md)
|
|
274
|
+
- [PaypalButtonStyleOptions_2](interfaces/PaypalButtonStyleOptions_2.md)
|
|
275
|
+
- [PaypalCommerceAlternativeMethodsButtonOptions](interfaces/PaypalCommerceAlternativeMethodsButtonOptions.md)
|
|
276
|
+
- [PaypalCommerceButtonInitializeOptions](interfaces/PaypalCommerceButtonInitializeOptions.md)
|
|
277
|
+
- [PaypalCommerceCreditCardPaymentInitializeOptions](interfaces/PaypalCommerceCreditCardPaymentInitializeOptions.md)
|
|
278
|
+
- [PaypalCommerceFormFieldCardTypeChangeEventData](interfaces/PaypalCommerceFormFieldCardTypeChangeEventData.md)
|
|
279
|
+
- [PaypalCommerceFormFieldKeyboardEventData](interfaces/PaypalCommerceFormFieldKeyboardEventData.md)
|
|
280
|
+
- [PaypalCommerceFormFieldOptions](interfaces/PaypalCommerceFormFieldOptions.md)
|
|
281
|
+
- [PaypalCommerceFormFieldStylesMap](interfaces/PaypalCommerceFormFieldStylesMap.md)
|
|
282
|
+
- [PaypalCommerceFormFieldValidateErrorData](interfaces/PaypalCommerceFormFieldValidateErrorData.md)
|
|
283
|
+
- [PaypalCommerceFormFieldValidateEventData](interfaces/PaypalCommerceFormFieldValidateEventData.md)
|
|
284
|
+
- [PaypalCommerceFormFieldsMap](interfaces/PaypalCommerceFormFieldsMap.md)
|
|
285
|
+
- [PaypalCommerceFormOptions](interfaces/PaypalCommerceFormOptions.md)
|
|
286
|
+
- [PaypalCommercePaymentInitializeOptions](interfaces/PaypalCommercePaymentInitializeOptions.md)
|
|
287
|
+
- [PaypalCommerceStoredCardFieldOptions](interfaces/PaypalCommerceStoredCardFieldOptions.md)
|
|
288
|
+
- [PaypalCommerceStoredCardFieldsMap](interfaces/PaypalCommerceStoredCardFieldsMap.md)
|
|
289
|
+
- [PaypalCommerceVenmoButtonInitializeOptions](interfaces/PaypalCommerceVenmoButtonInitializeOptions.md)
|
|
290
|
+
- [PaypalExpressPaymentInitializeOptions](interfaces/PaypalExpressPaymentInitializeOptions.md)
|
|
291
|
+
- [PaypalFieldsStyleOptions](interfaces/PaypalFieldsStyleOptions.md)
|
|
292
|
+
- [PhysicalItem](interfaces/PhysicalItem.md)
|
|
293
|
+
- [PickupMethod](interfaces/PickupMethod.md)
|
|
294
|
+
- [PickupOptionRequestBody](interfaces/PickupOptionRequestBody.md)
|
|
295
|
+
- [PickupOptionResult](interfaces/PickupOptionResult.md)
|
|
296
|
+
- [Promotion](interfaces/Promotion.md)
|
|
297
|
+
- [Radius](interfaces/Radius.md)
|
|
298
|
+
- [Region](interfaces/Region.md)
|
|
299
|
+
- [RequestOptions](interfaces/RequestOptions.md)
|
|
300
|
+
- [SearchArea](interfaces/SearchArea.md)
|
|
301
|
+
- [SepaPlaceHolder](interfaces/SepaPlaceHolder.md)
|
|
302
|
+
- [SepaPlaceHolder_2](interfaces/SepaPlaceHolder_2.md)
|
|
303
|
+
- [ShippingInitializeOptions](interfaces/ShippingInitializeOptions.md)
|
|
304
|
+
- [ShippingOption](interfaces/ShippingOption.md)
|
|
305
|
+
- [ShippingRequestOptions](interfaces/ShippingRequestOptions.md)
|
|
306
|
+
- [ShopperConfig](interfaces/ShopperConfig.md)
|
|
307
|
+
- [ShopperCurrency](interfaces/ShopperCurrency.md)
|
|
308
|
+
- [SignInEmail](interfaces/SignInEmail.md)
|
|
309
|
+
- [SignInEmailRequestBody](interfaces/SignInEmailRequestBody.md)
|
|
310
|
+
- [SpamProtectionOptions](interfaces/SpamProtectionOptions.md)
|
|
311
|
+
- [SquareFormElement](interfaces/SquareFormElement.md)
|
|
312
|
+
- [SquarePaymentInitializeOptions](interfaces/SquarePaymentInitializeOptions.md)
|
|
313
|
+
- [StepStyles](interfaces/StepStyles.md)
|
|
314
|
+
- [StepTracker](interfaces/StepTracker.md)
|
|
315
|
+
- [StepTrackerConfig](interfaces/StepTrackerConfig.md)
|
|
316
|
+
- [StoreConfig](interfaces/StoreConfig.md)
|
|
317
|
+
- [StoreCurrency](interfaces/StoreCurrency.md)
|
|
318
|
+
- [StoreLinks](interfaces/StoreLinks.md)
|
|
319
|
+
- [StoreProfile](interfaces/StoreProfile.md)
|
|
320
|
+
- [StripeElementCSSProperties](interfaces/StripeElementCSSProperties.md)
|
|
321
|
+
- [StripeElementClasses](interfaces/StripeElementClasses.md)
|
|
322
|
+
- [StripeElementStyle](interfaces/StripeElementStyle.md)
|
|
323
|
+
- [StripeElementStyleVariant](interfaces/StripeElementStyleVariant.md)
|
|
324
|
+
- [StripeUPEPaymentInitializeOptions](interfaces/StripeUPEPaymentInitializeOptions.md)
|
|
325
|
+
- [StripeV3PaymentInitializeOptions](interfaces/StripeV3PaymentInitializeOptions.md)
|
|
326
|
+
- [StyleOptions](interfaces/StyleOptions.md)
|
|
327
|
+
- [StyleOptions_2](interfaces/StyleOptions_2.md)
|
|
328
|
+
- [SubInputDetail](interfaces/SubInputDetail.md)
|
|
329
|
+
- [SubInputDetail_2](interfaces/SubInputDetail_2.md)
|
|
330
|
+
- [Subscriptions](interfaces/Subscriptions.md)
|
|
331
|
+
- [Tax](interfaces/Tax.md)
|
|
332
|
+
- [TextInputStyles](interfaces/TextInputStyles.md)
|
|
333
|
+
- [ThreeDSecure](interfaces/ThreeDSecure.md)
|
|
334
|
+
- [ThreeDSecureToken](interfaces/ThreeDSecureToken.md)
|
|
335
|
+
- [TranslationData](interfaces/TranslationData.md)
|
|
336
|
+
- [Translations](interfaces/Translations.md)
|
|
337
|
+
- [UnknownObject](interfaces/UnknownObject.md)
|
|
338
|
+
- [VaultedInstrument](interfaces/VaultedInstrument.md)
|
|
339
|
+
- [WechatDataPaymentMethodState](interfaces/WechatDataPaymentMethodState.md)
|
|
340
|
+
- [WechatDataPaymentMethodState_2](interfaces/WechatDataPaymentMethodState_2.md)
|
|
341
|
+
- [WechatState](interfaces/WechatState.md)
|
|
342
|
+
- [WechatState_2](interfaces/WechatState_2.md)
|
|
343
|
+
- [WithAccountCreation](interfaces/WithAccountCreation.md)
|
|
344
|
+
- [WithCheckoutcomFawryInstrument](interfaces/WithCheckoutcomFawryInstrument.md)
|
|
345
|
+
- [WithCheckoutcomSEPAInstrument](interfaces/WithCheckoutcomSEPAInstrument.md)
|
|
346
|
+
- [WithCheckoutcomiDealInstrument](interfaces/WithCheckoutcomiDealInstrument.md)
|
|
347
|
+
- [WithDocumentInstrument](interfaces/WithDocumentInstrument.md)
|
|
348
|
+
- [WithMollieIssuerInstrument](interfaces/WithMollieIssuerInstrument.md)
|
|
349
|
+
- [WorldpayPaymentInitializeOptions](interfaces/WorldpayPaymentInitializeOptions.md)
|
|
350
|
+
- [ZipCodeElementOptions](interfaces/ZipCodeElementOptions.md)
|
|
351
|
+
|
|
352
|
+
### Type aliases
|
|
353
|
+
|
|
354
|
+
- [AccountInstrument](README.md#accountinstrument)
|
|
355
|
+
- [AddressKey](README.md#addresskey)
|
|
356
|
+
- [AdyenComponentState](README.md#adyencomponentstate)
|
|
357
|
+
- [AdyenV3ComponentState](README.md#adyenv3componentstate)
|
|
358
|
+
- [AmazonPayV2ButtonInitializeOptions](README.md#amazonpayv2buttoninitializeoptions)
|
|
359
|
+
- [AnalyticStepType](README.md#analyticsteptype)
|
|
360
|
+
- [BraintreeFormFieldBlurEventData](README.md#braintreeformfieldblureventdata)
|
|
361
|
+
- [BraintreeFormFieldEnterEventData](README.md#braintreeformfieldentereventdata)
|
|
362
|
+
- [BraintreeFormFieldFocusEventData](README.md#braintreeformfieldfocuseventdata)
|
|
363
|
+
- [BraintreeFormFieldStyles](README.md#braintreeformfieldstyles)
|
|
364
|
+
- [CheckoutIncludeParam](README.md#checkoutincludeparam)
|
|
365
|
+
- [ComparableCheckout](README.md#comparablecheckout)
|
|
366
|
+
- [ConsignmentAssignmentRequestBody](README.md#consignmentassignmentrequestbody)
|
|
367
|
+
- [ConsignmentsRequestBody](README.md#consignmentsrequestbody)
|
|
368
|
+
- [CustomerAddressRequestBody](README.md#customeraddressrequestbody)
|
|
369
|
+
- [FlashMessageType](README.md#flashmessagetype)
|
|
370
|
+
- [FormFieldFieldType](README.md#formfieldfieldtype)
|
|
371
|
+
- [FormFieldType](README.md#formfieldtype)
|
|
372
|
+
- [GuestCredentials](README.md#guestcredentials)
|
|
373
|
+
- [HostedCreditCardInstrument](README.md#hostedcreditcardinstrument)
|
|
374
|
+
- [HostedFieldBlurEventData](README.md#hostedfieldblureventdata)
|
|
375
|
+
- [HostedFieldCardTypeChangeEventData](README.md#hostedfieldcardtypechangeeventdata)
|
|
376
|
+
- [HostedFieldEnterEventData](README.md#hostedfieldentereventdata)
|
|
377
|
+
- [HostedFieldFocusEventData](README.md#hostedfieldfocuseventdata)
|
|
378
|
+
- [HostedFieldOptionsMap](README.md#hostedfieldoptionsmap)
|
|
379
|
+
- [HostedFieldStyles](README.md#hostedfieldstyles)
|
|
380
|
+
- [HostedFieldValidateEventData](README.md#hostedfieldvalidateeventdata)
|
|
381
|
+
- [HostedInputStyles](README.md#hostedinputstyles)
|
|
382
|
+
- [HostedVaultedInstrument](README.md#hostedvaultedinstrument)
|
|
383
|
+
- [Instrument](README.md#instrument)
|
|
384
|
+
- [Omit](README.md#omit)
|
|
385
|
+
- [OrderPaymentInstrument](README.md#orderpaymentinstrument)
|
|
386
|
+
- [OrderPayments](README.md#orderpayments)
|
|
387
|
+
- [PaymentInstrument](README.md#paymentinstrument)
|
|
388
|
+
- [PaypalCommerceFormFieldBlurEventData](README.md#paypalcommerceformfieldblureventdata)
|
|
389
|
+
- [PaypalCommerceFormFieldEnterEventData](README.md#paypalcommerceformfieldentereventdata)
|
|
390
|
+
- [PaypalCommerceFormFieldFocusEventData](README.md#paypalcommerceformfieldfocuseventdata)
|
|
391
|
+
- [PaypalCommerceFormFieldStyles](README.md#paypalcommerceformfieldstyles)
|
|
392
|
+
- [PaypalCommerceInitializeOptions](README.md#paypalcommerceinitializeoptions)
|
|
393
|
+
- [StripeElementOptions](README.md#stripeelementoptions)
|
|
10
394
|
|
|
11
395
|
### Functions
|
|
12
396
|
|
|
13
|
-
- [
|
|
14
|
-
- [
|
|
15
|
-
- [
|
|
16
|
-
- [
|
|
17
|
-
- [
|
|
18
|
-
- [
|
|
19
|
-
- [
|
|
20
|
-
- [mapToInternalOrder](README.md#maptointernalorder)
|
|
21
|
-
- [mapToInternalQuote](README.md#maptointernalquote)
|
|
22
|
-
- [mapToInternalShippingOption](README.md#maptointernalshippingoption)
|
|
23
|
-
- [mapToInternalShippingOptions](README.md#maptointernalshippingoptions)
|
|
397
|
+
- [createCheckoutButtonInitializer](README.md#createcheckoutbuttoninitializer)
|
|
398
|
+
- [createCheckoutService](README.md#createcheckoutservice)
|
|
399
|
+
- [createCurrencyService](README.md#createcurrencyservice)
|
|
400
|
+
- [createEmbeddedCheckoutMessenger](README.md#createembeddedcheckoutmessenger)
|
|
401
|
+
- [createLanguageService](README.md#createlanguageservice)
|
|
402
|
+
- [createStepTracker](README.md#createsteptracker)
|
|
403
|
+
- [embedCheckout](README.md#embedcheckout)
|
|
24
404
|
|
|
25
|
-
##
|
|
405
|
+
## Type aliases
|
|
26
406
|
|
|
27
|
-
###
|
|
407
|
+
### AccountInstrument
|
|
28
408
|
|
|
29
|
-
|
|
409
|
+
Ƭ **AccountInstrument**: [`PayPalInstrument`](interfaces/PayPalInstrument.md) \| [`BankInstrument`](interfaces/BankInstrument.md)
|
|
30
410
|
|
|
31
|
-
|
|
32
|
-
the transition period as we are moving to adopt the new storefront API object
|
|
33
|
-
schema.
|
|
411
|
+
___
|
|
34
412
|
|
|
35
|
-
|
|
413
|
+
### AddressKey
|
|
36
414
|
|
|
37
|
-
|
|
38
|
-
| :------ | :------ |
|
|
39
|
-
| `address` | `Address` \| `BillingAddress` |
|
|
40
|
-
| `consignments?` | `Consignment`[] |
|
|
415
|
+
Ƭ **AddressKey**: keyof [`Address`](interfaces/Address.md)
|
|
41
416
|
|
|
42
|
-
|
|
417
|
+
___
|
|
418
|
+
|
|
419
|
+
### AdyenComponentState
|
|
43
420
|
|
|
44
|
-
`
|
|
421
|
+
Ƭ **AdyenComponentState**: [`CardState`](interfaces/CardState.md) \| [`WechatState`](interfaces/WechatState.md)
|
|
45
422
|
|
|
46
423
|
___
|
|
47
424
|
|
|
48
|
-
###
|
|
425
|
+
### AdyenV3ComponentState
|
|
49
426
|
|
|
50
|
-
|
|
427
|
+
Ƭ **AdyenV3ComponentState**: [`CardState_2`](interfaces/CardState_2.md) \| [`WechatState_2`](interfaces/WechatState_2.md)
|
|
51
428
|
|
|
52
|
-
|
|
53
|
-
the transition period as we are moving to adopt the new storefront API object
|
|
54
|
-
schema.
|
|
429
|
+
___
|
|
55
430
|
|
|
56
|
-
|
|
431
|
+
### AmazonPayV2ButtonInitializeOptions
|
|
57
432
|
|
|
58
|
-
|
|
59
|
-
| :------ | :------ |
|
|
60
|
-
| `checkout` | `Checkout` |
|
|
433
|
+
Ƭ **AmazonPayV2ButtonInitializeOptions**: [`AmazonPayV2ButtonParams`](interfaces/AmazonPayV2ButtonParams.md)
|
|
61
434
|
|
|
62
|
-
|
|
435
|
+
The required config to render the AmazonPayV2 buttton.
|
|
436
|
+
|
|
437
|
+
___
|
|
438
|
+
|
|
439
|
+
### AnalyticStepType
|
|
63
440
|
|
|
64
|
-
|
|
441
|
+
Ƭ **AnalyticStepType**: ``"customer"`` \| ``"shipping"`` \| ``"billing"`` \| ``"payment"``
|
|
65
442
|
|
|
66
443
|
___
|
|
67
444
|
|
|
68
|
-
###
|
|
445
|
+
### BraintreeFormFieldBlurEventData
|
|
69
446
|
|
|
70
|
-
|
|
447
|
+
Ƭ **BraintreeFormFieldBlurEventData**: [`BraintreeFormFieldKeyboardEventData`](interfaces/BraintreeFormFieldKeyboardEventData.md)
|
|
71
448
|
|
|
72
|
-
|
|
73
|
-
the transition period as we are moving to adopt the new storefront API object
|
|
74
|
-
schema.
|
|
449
|
+
___
|
|
75
450
|
|
|
76
|
-
|
|
451
|
+
### BraintreeFormFieldEnterEventData
|
|
77
452
|
|
|
78
|
-
|
|
79
|
-
| :------ | :------ |
|
|
80
|
-
| `coupon` | `Coupon` |
|
|
453
|
+
Ƭ **BraintreeFormFieldEnterEventData**: [`BraintreeFormFieldKeyboardEventData`](interfaces/BraintreeFormFieldKeyboardEventData.md)
|
|
81
454
|
|
|
82
|
-
|
|
455
|
+
___
|
|
83
456
|
|
|
84
|
-
|
|
457
|
+
### BraintreeFormFieldFocusEventData
|
|
458
|
+
|
|
459
|
+
Ƭ **BraintreeFormFieldFocusEventData**: [`BraintreeFormFieldKeyboardEventData`](interfaces/BraintreeFormFieldKeyboardEventData.md)
|
|
85
460
|
|
|
86
461
|
___
|
|
87
462
|
|
|
88
|
-
###
|
|
463
|
+
### BraintreeFormFieldStyles
|
|
89
464
|
|
|
90
|
-
|
|
465
|
+
Ƭ **BraintreeFormFieldStyles**: `Partial`<`Pick`<`CSSStyleDeclaration`, ``"color"`` \| ``"fontFamily"`` \| ``"fontSize"`` \| ``"fontWeight"``\>\>
|
|
91
466
|
|
|
92
|
-
|
|
93
|
-
the transition period as we are moving to adopt the new storefront API object
|
|
94
|
-
schema.
|
|
467
|
+
___
|
|
95
468
|
|
|
96
|
-
|
|
469
|
+
### CheckoutIncludeParam
|
|
470
|
+
|
|
471
|
+
Ƭ **CheckoutIncludeParam**: { [key in CheckoutIncludes]?: boolean }
|
|
472
|
+
|
|
473
|
+
___
|
|
474
|
+
|
|
475
|
+
### ComparableCheckout
|
|
476
|
+
|
|
477
|
+
Ƭ **ComparableCheckout**: `Pick`<[`Checkout`](interfaces/Checkout.md), ``"outstandingBalance"`` \| ``"coupons"`` \| ``"giftCertificates"``\> & { `cart`: `Partial`<[`Cart`](interfaces/Cart.md)\> }
|
|
478
|
+
|
|
479
|
+
___
|
|
480
|
+
|
|
481
|
+
### ConsignmentAssignmentRequestBody
|
|
482
|
+
|
|
483
|
+
Ƭ **ConsignmentAssignmentRequestBody**: [`ConsignmentAssignmentBaseRequestBodyWithShippingAddress`](interfaces/ConsignmentAssignmentBaseRequestBodyWithShippingAddress.md) \| [`ConsignmentAssignmentBaseRequestBodyWithAddress`](interfaces/ConsignmentAssignmentBaseRequestBodyWithAddress.md)
|
|
484
|
+
|
|
485
|
+
___
|
|
486
|
+
|
|
487
|
+
### ConsignmentsRequestBody
|
|
488
|
+
|
|
489
|
+
Ƭ **ConsignmentsRequestBody**: [`ConsignmentCreateRequestBody`](interfaces/ConsignmentCreateRequestBody.md)[]
|
|
490
|
+
|
|
491
|
+
___
|
|
492
|
+
|
|
493
|
+
### CustomerAddressRequestBody
|
|
494
|
+
|
|
495
|
+
Ƭ **CustomerAddressRequestBody**: [`AddressRequestBody`](interfaces/AddressRequestBody.md)
|
|
496
|
+
|
|
497
|
+
___
|
|
498
|
+
|
|
499
|
+
### FlashMessageType
|
|
500
|
+
|
|
501
|
+
Ƭ **FlashMessageType**: ``"error"`` \| ``"info"`` \| ``"warning"`` \| ``"success"``
|
|
502
|
+
|
|
503
|
+
___
|
|
504
|
+
|
|
505
|
+
### FormFieldFieldType
|
|
506
|
+
|
|
507
|
+
Ƭ **FormFieldFieldType**: ``"checkbox"`` \| ``"date"`` \| ``"text"`` \| ``"dropdown"`` \| ``"password"`` \| ``"radio"`` \| ``"multiline"``
|
|
508
|
+
|
|
509
|
+
___
|
|
510
|
+
|
|
511
|
+
### FormFieldType
|
|
512
|
+
|
|
513
|
+
Ƭ **FormFieldType**: ``"array"`` \| ``"date"`` \| ``"integer"`` \| ``"string"``
|
|
514
|
+
|
|
515
|
+
___
|
|
516
|
+
|
|
517
|
+
### GuestCredentials
|
|
518
|
+
|
|
519
|
+
Ƭ **GuestCredentials**: `Partial`<[`Subscriptions`](interfaces/Subscriptions.md)\> & { `email`: `string` ; `id?`: `string` }
|
|
520
|
+
|
|
521
|
+
___
|
|
522
|
+
|
|
523
|
+
### HostedCreditCardInstrument
|
|
524
|
+
|
|
525
|
+
Ƭ **HostedCreditCardInstrument**: [`Omit`](README.md#omit)<[`CreditCardInstrument`](interfaces/CreditCardInstrument.md), ``"ccExpiry"`` \| ``"ccName"`` \| ``"ccNumber"`` \| ``"ccCvv"``\>
|
|
526
|
+
|
|
527
|
+
___
|
|
528
|
+
|
|
529
|
+
### HostedFieldBlurEventData
|
|
530
|
+
|
|
531
|
+
Ƭ **HostedFieldBlurEventData**: [`HostedInputBlurEvent`](interfaces/HostedInputBlurEvent.md)[``"payload"``]
|
|
532
|
+
|
|
533
|
+
___
|
|
534
|
+
|
|
535
|
+
### HostedFieldCardTypeChangeEventData
|
|
536
|
+
|
|
537
|
+
Ƭ **HostedFieldCardTypeChangeEventData**: [`HostedInputCardTypeChangeEvent`](interfaces/HostedInputCardTypeChangeEvent.md)[``"payload"``]
|
|
538
|
+
|
|
539
|
+
___
|
|
540
|
+
|
|
541
|
+
### HostedFieldEnterEventData
|
|
542
|
+
|
|
543
|
+
Ƭ **HostedFieldEnterEventData**: [`HostedInputEnterEvent`](interfaces/HostedInputEnterEvent.md)[``"payload"``]
|
|
544
|
+
|
|
545
|
+
___
|
|
546
|
+
|
|
547
|
+
### HostedFieldFocusEventData
|
|
548
|
+
|
|
549
|
+
Ƭ **HostedFieldFocusEventData**: [`HostedInputFocusEvent`](interfaces/HostedInputFocusEvent.md)[``"payload"``]
|
|
550
|
+
|
|
551
|
+
___
|
|
552
|
+
|
|
553
|
+
### HostedFieldOptionsMap
|
|
554
|
+
|
|
555
|
+
Ƭ **HostedFieldOptionsMap**: [`HostedCardFieldOptionsMap`](interfaces/HostedCardFieldOptionsMap.md) \| [`HostedStoredCardFieldOptionsMap`](interfaces/HostedStoredCardFieldOptionsMap.md)
|
|
556
|
+
|
|
557
|
+
___
|
|
558
|
+
|
|
559
|
+
### HostedFieldStyles
|
|
560
|
+
|
|
561
|
+
Ƭ **HostedFieldStyles**: [`HostedInputStyles`](README.md#hostedinputstyles)
|
|
562
|
+
|
|
563
|
+
___
|
|
564
|
+
|
|
565
|
+
### HostedFieldValidateEventData
|
|
566
|
+
|
|
567
|
+
Ƭ **HostedFieldValidateEventData**: [`HostedInputValidateEvent`](interfaces/HostedInputValidateEvent.md)[``"payload"``]
|
|
568
|
+
|
|
569
|
+
___
|
|
570
|
+
|
|
571
|
+
### HostedInputStyles
|
|
572
|
+
|
|
573
|
+
Ƭ **HostedInputStyles**: `Partial`<`Pick`<`CSSStyleDeclaration`, ``"color"`` \| ``"fontFamily"`` \| ``"fontSize"`` \| ``"fontWeight"``\>\>
|
|
574
|
+
|
|
575
|
+
___
|
|
576
|
+
|
|
577
|
+
### HostedVaultedInstrument
|
|
578
|
+
|
|
579
|
+
Ƭ **HostedVaultedInstrument**: [`Omit`](README.md#omit)<[`VaultedInstrument`](interfaces/VaultedInstrument.md), ``"ccNumber"`` \| ``"ccCvv"``\>
|
|
580
|
+
|
|
581
|
+
___
|
|
582
|
+
|
|
583
|
+
### Instrument
|
|
584
|
+
|
|
585
|
+
Ƭ **Instrument**: [`CardInstrument`](interfaces/CardInstrument.md)
|
|
586
|
+
|
|
587
|
+
___
|
|
588
|
+
|
|
589
|
+
### Omit
|
|
590
|
+
|
|
591
|
+
Ƭ **Omit**<`T`, `K`\>: `Pick`<`T`, `Exclude`<keyof `T`, `K`\>\>
|
|
592
|
+
|
|
593
|
+
#### Type parameters
|
|
97
594
|
|
|
98
595
|
| Name | Type |
|
|
99
596
|
| :------ | :------ |
|
|
100
|
-
| `
|
|
101
|
-
| `
|
|
597
|
+
| `T` | `T` |
|
|
598
|
+
| `K` | extends keyof `T` |
|
|
102
599
|
|
|
103
|
-
|
|
600
|
+
___
|
|
601
|
+
|
|
602
|
+
### OrderPaymentInstrument
|
|
603
|
+
|
|
604
|
+
Ƭ **OrderPaymentInstrument**: [`CreditCardInstrument`](interfaces/CreditCardInstrument.md) \| [`HostedInstrument`](interfaces/HostedInstrument.md) \| [`HostedCreditCardInstrument`](README.md#hostedcreditcardinstrument) \| [`HostedVaultedInstrument`](README.md#hostedvaultedinstrument) \| [`NonceInstrument`](interfaces/NonceInstrument.md) \| [`VaultedInstrument`](interfaces/VaultedInstrument.md) \| [`CreditCardInstrument`](interfaces/CreditCardInstrument.md) & [`WithDocumentInstrument`](interfaces/WithDocumentInstrument.md) \| [`CreditCardInstrument`](interfaces/CreditCardInstrument.md) & [`WithCheckoutcomFawryInstrument`](interfaces/WithCheckoutcomFawryInstrument.md) \| [`CreditCardInstrument`](interfaces/CreditCardInstrument.md) & [`WithCheckoutcomSEPAInstrument`](interfaces/WithCheckoutcomSEPAInstrument.md) \| [`CreditCardInstrument`](interfaces/CreditCardInstrument.md) & [`WithCheckoutcomiDealInstrument`](interfaces/WithCheckoutcomiDealInstrument.md) \| [`HostedInstrument`](interfaces/HostedInstrument.md) & [`WithMollieIssuerInstrument`](interfaces/WithMollieIssuerInstrument.md) \| [`WithAccountCreation`](interfaces/WithAccountCreation.md)
|
|
605
|
+
|
|
606
|
+
___
|
|
104
607
|
|
|
105
|
-
|
|
608
|
+
### OrderPayments
|
|
609
|
+
|
|
610
|
+
Ƭ **OrderPayments**: ([`GatewayOrderPayment`](interfaces/GatewayOrderPayment.md) \| [`GiftCertificateOrderPayment`](interfaces/GiftCertificateOrderPayment.md))[]
|
|
611
|
+
|
|
612
|
+
___
|
|
613
|
+
|
|
614
|
+
### PaymentInstrument
|
|
615
|
+
|
|
616
|
+
Ƭ **PaymentInstrument**: [`CardInstrument`](interfaces/CardInstrument.md) \| [`AccountInstrument`](README.md#accountinstrument)
|
|
617
|
+
|
|
618
|
+
___
|
|
619
|
+
|
|
620
|
+
### PaypalCommerceFormFieldBlurEventData
|
|
621
|
+
|
|
622
|
+
Ƭ **PaypalCommerceFormFieldBlurEventData**: [`PaypalCommerceFormFieldKeyboardEventData`](interfaces/PaypalCommerceFormFieldKeyboardEventData.md)
|
|
106
623
|
|
|
107
624
|
___
|
|
108
625
|
|
|
109
|
-
###
|
|
626
|
+
### PaypalCommerceFormFieldEnterEventData
|
|
627
|
+
|
|
628
|
+
Ƭ **PaypalCommerceFormFieldEnterEventData**: [`PaypalCommerceFormFieldKeyboardEventData`](interfaces/PaypalCommerceFormFieldKeyboardEventData.md)
|
|
629
|
+
|
|
630
|
+
___
|
|
110
631
|
|
|
111
|
-
|
|
632
|
+
### PaypalCommerceFormFieldFocusEventData
|
|
112
633
|
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
634
|
+
Ƭ **PaypalCommerceFormFieldFocusEventData**: [`PaypalCommerceFormFieldKeyboardEventData`](interfaces/PaypalCommerceFormFieldKeyboardEventData.md)
|
|
635
|
+
|
|
636
|
+
___
|
|
637
|
+
|
|
638
|
+
### PaypalCommerceFormFieldStyles
|
|
639
|
+
|
|
640
|
+
Ƭ **PaypalCommerceFormFieldStyles**: `Partial`<`Pick`<`CSSStyleDeclaration`, ``"color"`` \| ``"fontFamily"`` \| ``"fontSize"`` \| ``"fontWeight"``\>\>
|
|
641
|
+
|
|
642
|
+
___
|
|
643
|
+
|
|
644
|
+
### PaypalCommerceInitializeOptions
|
|
645
|
+
|
|
646
|
+
Ƭ **PaypalCommerceInitializeOptions**: [`PaypalCommercePaymentInitializeOptions`](interfaces/PaypalCommercePaymentInitializeOptions.md) \| [`PaypalCommerceCreditCardPaymentInitializeOptions`](interfaces/PaypalCommerceCreditCardPaymentInitializeOptions.md)
|
|
647
|
+
|
|
648
|
+
A set of options that are required to initialize the PayPal Commerce payment
|
|
649
|
+
method could be used for PayPal Smart Payment Buttons or PayPal Credit Card methods.
|
|
650
|
+
|
|
651
|
+
___
|
|
652
|
+
|
|
653
|
+
### StripeElementOptions
|
|
654
|
+
|
|
655
|
+
Ƭ **StripeElementOptions**: [`CardElementOptions`](interfaces/CardElementOptions.md) \| [`CardExpiryElementOptions`](interfaces/CardExpiryElementOptions.md) \| [`CardNumberElementOptions`](interfaces/CardNumberElementOptions.md) \| [`CardCvcElementOptions`](interfaces/CardCvcElementOptions.md) \| [`IdealElementOptions`](interfaces/IdealElementOptions.md) \| [`IbanElementOptions`](interfaces/IbanElementOptions.md) \| [`ZipCodeElementOptions`](interfaces/ZipCodeElementOptions.md)
|
|
656
|
+
|
|
657
|
+
## Functions
|
|
658
|
+
|
|
659
|
+
### createCheckoutButtonInitializer
|
|
660
|
+
|
|
661
|
+
▸ **createCheckoutButtonInitializer**(`options?`): [`CheckoutButtonInitializer`](classes/CheckoutButtonInitializer.md)
|
|
662
|
+
|
|
663
|
+
Creates an instance of `CheckoutButtonInitializer`.
|
|
664
|
+
|
|
665
|
+
**`remarks`**
|
|
666
|
+
```js
|
|
667
|
+
const initializer = createCheckoutButtonInitializer();
|
|
668
|
+
|
|
669
|
+
initializer.initializeButton({
|
|
670
|
+
methodId: 'braintreepaypal',
|
|
671
|
+
braintreepaypal: {
|
|
672
|
+
container: '#checkoutButton',
|
|
673
|
+
},
|
|
674
|
+
});
|
|
675
|
+
```
|
|
676
|
+
|
|
677
|
+
**`alpha`**
|
|
678
|
+
Please note that `CheckoutButtonInitializer` is currently in an early stage
|
|
679
|
+
of development. Therefore the API is unstable and not ready for public
|
|
680
|
+
consumption.
|
|
116
681
|
|
|
117
682
|
#### Parameters
|
|
118
683
|
|
|
119
|
-
| Name | Type |
|
|
120
|
-
| :------ | :------ |
|
|
121
|
-
| `
|
|
684
|
+
| Name | Type | Description |
|
|
685
|
+
| :------ | :------ | :------ |
|
|
686
|
+
| `options?` | [`CheckoutButtonInitializerOptions`](interfaces/CheckoutButtonInitializerOptions.md) | A set of construction options. |
|
|
122
687
|
|
|
123
688
|
#### Returns
|
|
124
689
|
|
|
125
|
-
`
|
|
690
|
+
[`CheckoutButtonInitializer`](classes/CheckoutButtonInitializer.md)
|
|
691
|
+
|
|
692
|
+
an instance of `CheckoutButtonInitializer`.
|
|
126
693
|
|
|
127
694
|
___
|
|
128
695
|
|
|
129
|
-
###
|
|
696
|
+
### createCheckoutService
|
|
697
|
+
|
|
698
|
+
▸ **createCheckoutService**(`options?`): [`CheckoutService`](classes/CheckoutService.md)
|
|
699
|
+
|
|
700
|
+
Creates an instance of `CheckoutService`.
|
|
130
701
|
|
|
131
|
-
|
|
702
|
+
**`remarks`**
|
|
703
|
+
```js
|
|
704
|
+
const service = createCheckoutService();
|
|
132
705
|
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
706
|
+
service.subscribe(state => {
|
|
707
|
+
console.log(state);
|
|
708
|
+
});
|
|
709
|
+
|
|
710
|
+
service.loadCheckout();
|
|
711
|
+
```
|
|
136
712
|
|
|
137
713
|
#### Parameters
|
|
138
714
|
|
|
139
|
-
| Name | Type |
|
|
140
|
-
| :------ | :------ |
|
|
141
|
-
| `
|
|
142
|
-
| `type` | `string` |
|
|
143
|
-
| `decimalPlaces` | `number` |
|
|
144
|
-
| `idKey?` | ``"id"`` \| ``"variantId"`` \| ``"productId"`` \| ``"sku"`` \| ``"name"`` \| ``"url"`` \| ``"quantity"`` \| ``"brand"`` \| ``"categoryNames"`` \| ``"categories"`` \| ``"isTaxable"`` \| ``"imageUrl"`` \| ``"discounts"`` \| ``"discountAmount"`` \| ``"couponAmount"`` \| ``"listPrice"`` \| ``"salePrice"`` \| ``"comparisonPrice"`` \| ``"extendedListPrice"`` \| ``"extendedSalePrice"`` \| ``"extendedComparisonPrice"`` \| ``"socialMedia"`` \| ``"options"`` \| ``"addedByPromotion"`` \| ``"parentId"`` |
|
|
715
|
+
| Name | Type | Description |
|
|
716
|
+
| :------ | :------ | :------ |
|
|
717
|
+
| `options?` | [`CheckoutServiceOptions`](interfaces/CheckoutServiceOptions.md) | A set of construction options. |
|
|
145
718
|
|
|
146
719
|
#### Returns
|
|
147
720
|
|
|
148
|
-
`
|
|
721
|
+
[`CheckoutService`](classes/CheckoutService.md)
|
|
722
|
+
|
|
723
|
+
an instance of `CheckoutService`.
|
|
149
724
|
|
|
150
725
|
___
|
|
151
726
|
|
|
152
|
-
###
|
|
727
|
+
### createCurrencyService
|
|
728
|
+
|
|
729
|
+
▸ **createCurrencyService**(`config`): [`CurrencyService`](classes/CurrencyService.md)
|
|
730
|
+
|
|
731
|
+
Creates an instance of `CurrencyService`.
|
|
153
732
|
|
|
154
|
-
|
|
733
|
+
**`remarks`**
|
|
734
|
+
```js
|
|
735
|
+
const { data } = checkoutService.getState();
|
|
736
|
+
const config = data.getConfig();
|
|
737
|
+
const checkout = data.getCheckout();
|
|
738
|
+
const currencyService = createCurrencyService(config);
|
|
155
739
|
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
740
|
+
currencyService.toStoreCurrency(checkout.grandTotal);
|
|
741
|
+
currencyService.toCustomerCurrency(checkout.grandTotal);
|
|
742
|
+
```
|
|
159
743
|
|
|
160
744
|
#### Parameters
|
|
161
745
|
|
|
162
|
-
| Name | Type |
|
|
163
|
-
| :------ | :------ |
|
|
164
|
-
| `
|
|
165
|
-
| `decimalPlaces` | `number` |
|
|
166
|
-
| `idKey?` | ``"id"`` \| ``"variantId"`` \| ``"productId"`` \| ``"sku"`` \| ``"name"`` \| ``"url"`` \| ``"quantity"`` \| ``"brand"`` \| ``"categoryNames"`` \| ``"categories"`` \| ``"isTaxable"`` \| ``"imageUrl"`` \| ``"discounts"`` \| ``"discountAmount"`` \| ``"couponAmount"`` \| ``"listPrice"`` \| ``"salePrice"`` \| ``"comparisonPrice"`` \| ``"extendedListPrice"`` \| ``"extendedSalePrice"`` \| ``"extendedComparisonPrice"`` \| ``"socialMedia"`` \| ``"options"`` \| ``"addedByPromotion"`` \| ``"parentId"`` |
|
|
746
|
+
| Name | Type | Description |
|
|
747
|
+
| :------ | :------ | :------ |
|
|
748
|
+
| `config` | [`StoreConfig`](interfaces/StoreConfig.md) | The config object containing the currency configuration |
|
|
167
749
|
|
|
168
750
|
#### Returns
|
|
169
751
|
|
|
170
|
-
`
|
|
752
|
+
[`CurrencyService`](classes/CurrencyService.md)
|
|
753
|
+
|
|
754
|
+
an instance of `CurrencyService`.
|
|
171
755
|
|
|
172
756
|
___
|
|
173
757
|
|
|
174
|
-
###
|
|
758
|
+
### createEmbeddedCheckoutMessenger
|
|
759
|
+
|
|
760
|
+
▸ **createEmbeddedCheckoutMessenger**(`options`): [`EmbeddedCheckoutMessenger`](interfaces/EmbeddedCheckoutMessenger.md)
|
|
761
|
+
|
|
762
|
+
Create an instance of `EmbeddedCheckoutMessenger`.
|
|
763
|
+
|
|
764
|
+
**`remarks`**
|
|
765
|
+
The object is responsible for posting messages to the parent window from the
|
|
766
|
+
iframe when certain events have occurred. For example, when the checkout
|
|
767
|
+
form is first loaded, you should notify the parent window about it.
|
|
768
|
+
|
|
769
|
+
The iframe can only be embedded in domains that are allowed by the store.
|
|
770
|
+
|
|
771
|
+
```ts
|
|
772
|
+
const messenger = createEmbeddedCheckoutMessenger({
|
|
773
|
+
parentOrigin: 'https://some/website',
|
|
774
|
+
});
|
|
175
775
|
|
|
176
|
-
|
|
776
|
+
messenger.postFrameLoaded();
|
|
777
|
+
```
|
|
177
778
|
|
|
178
|
-
**`
|
|
179
|
-
|
|
180
|
-
|
|
779
|
+
**`alpha`**
|
|
780
|
+
Please note that this feature is currently in an early stage of development.
|
|
781
|
+
Therefore the API is unstable and not ready for public consumption.
|
|
181
782
|
|
|
182
783
|
#### Parameters
|
|
183
784
|
|
|
184
|
-
| Name | Type |
|
|
185
|
-
| :------ | :------ |
|
|
186
|
-
| `
|
|
187
|
-
| `orderMeta?` | `OrderMetaState` |
|
|
785
|
+
| Name | Type | Description |
|
|
786
|
+
| :------ | :------ | :------ |
|
|
787
|
+
| `options` | [`EmbeddedCheckoutMessengerOptions`](interfaces/EmbeddedCheckoutMessengerOptions.md) | Options for creating `EmbeddedCheckoutMessenger` |
|
|
188
788
|
|
|
189
789
|
#### Returns
|
|
190
790
|
|
|
191
|
-
`
|
|
791
|
+
[`EmbeddedCheckoutMessenger`](interfaces/EmbeddedCheckoutMessenger.md)
|
|
792
|
+
|
|
793
|
+
- An instance of `EmbeddedCheckoutMessenger`
|
|
192
794
|
|
|
193
795
|
___
|
|
194
796
|
|
|
195
|
-
###
|
|
797
|
+
### createLanguageService
|
|
798
|
+
|
|
799
|
+
▸ **createLanguageService**(`config?`): [`LanguageService`](classes/LanguageService.md)
|
|
800
|
+
|
|
801
|
+
Creates an instance of `LanguageService`.
|
|
196
802
|
|
|
197
|
-
|
|
803
|
+
**`remarks`**
|
|
804
|
+
```js
|
|
805
|
+
const language = {{{langJson 'optimized_checkout'}}}; // `langJson` is a Handlebars helper provided by BigCommerce's Stencil template engine.
|
|
806
|
+
const service = createLanguageService(language);
|
|
198
807
|
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
schema.
|
|
808
|
+
console.log(service.translate('address.city_label'));
|
|
809
|
+
```
|
|
202
810
|
|
|
203
811
|
#### Parameters
|
|
204
812
|
|
|
205
|
-
| Name | Type |
|
|
206
|
-
| :------ | :------ |
|
|
207
|
-
| `
|
|
208
|
-
| `shippingAddress?` | `Address` |
|
|
813
|
+
| Name | Type | Description |
|
|
814
|
+
| :------ | :------ | :------ |
|
|
815
|
+
| `config?` | `Partial`<[`LanguageConfig`](interfaces/LanguageConfig.md)\> | A configuration object. |
|
|
209
816
|
|
|
210
817
|
#### Returns
|
|
211
818
|
|
|
212
|
-
`
|
|
819
|
+
[`LanguageService`](classes/LanguageService.md)
|
|
820
|
+
|
|
821
|
+
An instance of `LanguageService`.
|
|
213
822
|
|
|
214
823
|
___
|
|
215
824
|
|
|
216
|
-
###
|
|
825
|
+
### createStepTracker
|
|
217
826
|
|
|
218
|
-
▸ **
|
|
827
|
+
▸ **createStepTracker**(`checkoutService`, `stepTrackerConfig?`): [`StepTracker`](interfaces/StepTracker.md)
|
|
219
828
|
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
829
|
+
Creates an instance of `StepTracker`.
|
|
830
|
+
|
|
831
|
+
**`remarks`**
|
|
832
|
+
```js
|
|
833
|
+
const checkoutService = createCheckoutService();
|
|
834
|
+
await checkoutService.loadCheckout();
|
|
835
|
+
const stepTracker = createStepTracker(checkoutService);
|
|
836
|
+
|
|
837
|
+
stepTracker.trackCheckoutStarted();
|
|
838
|
+
```
|
|
223
839
|
|
|
224
840
|
#### Parameters
|
|
225
841
|
|
|
226
842
|
| Name | Type |
|
|
227
843
|
| :------ | :------ |
|
|
228
|
-
| `
|
|
229
|
-
| `
|
|
844
|
+
| `checkoutService` | [`CheckoutService`](classes/CheckoutService.md) |
|
|
845
|
+
| `stepTrackerConfig?` | [`StepTrackerConfig`](interfaces/StepTrackerConfig.md) |
|
|
230
846
|
|
|
231
847
|
#### Returns
|
|
232
848
|
|
|
233
|
-
`
|
|
849
|
+
[`StepTracker`](interfaces/StepTracker.md)
|
|
850
|
+
|
|
851
|
+
an instance of `StepTracker`.
|
|
234
852
|
|
|
235
853
|
___
|
|
236
854
|
|
|
237
|
-
###
|
|
855
|
+
### embedCheckout
|
|
238
856
|
|
|
239
|
-
▸ **
|
|
857
|
+
▸ **embedCheckout**(`options`): `Promise`<[`EmbeddedCheckout`](classes/EmbeddedCheckout.md)\>
|
|
240
858
|
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
859
|
+
Embed the checkout form in an iframe.
|
|
860
|
+
|
|
861
|
+
**`remarks`**
|
|
862
|
+
Once the iframe is embedded, it will automatically resize according to the
|
|
863
|
+
size of the checkout form. It will also notify the parent window when certain
|
|
864
|
+
events have occurred. i.e.: when the form is loaded and ready to be used.
|
|
865
|
+
|
|
866
|
+
```js
|
|
867
|
+
embedCheckout({
|
|
868
|
+
url: 'https://checkout/url',
|
|
869
|
+
containerId: 'container-id',
|
|
870
|
+
});
|
|
871
|
+
```
|
|
244
872
|
|
|
245
873
|
#### Parameters
|
|
246
874
|
|
|
247
|
-
| Name | Type |
|
|
248
|
-
| :------ | :------ |
|
|
249
|
-
| `
|
|
875
|
+
| Name | Type | Description |
|
|
876
|
+
| :------ | :------ | :------ |
|
|
877
|
+
| `options` | [`EmbeddedCheckoutOptions`](interfaces/EmbeddedCheckoutOptions.md) | Options for embedding the checkout form. |
|
|
250
878
|
|
|
251
879
|
#### Returns
|
|
252
880
|
|
|
253
|
-
`
|
|
881
|
+
`Promise`<[`EmbeddedCheckout`](classes/EmbeddedCheckout.md)\>
|
|
882
|
+
|
|
883
|
+
A promise that resolves to an instance of `EmbeddedCheckout`.
|