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