@salesforce/b2c-cli 1.10.0 → 1.12.0
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/dist/commands/job/import.d.ts +1 -0
- package/dist/commands/job/import.js +15 -0
- package/dist/commands/job/import.js.map +1 -1
- package/dist/commands/setup/ide/tsserver-plugin.d.ts +56 -0
- package/dist/commands/setup/ide/tsserver-plugin.js +88 -0
- package/dist/commands/setup/ide/tsserver-plugin.js.map +1 -0
- package/dist/commands/setup/ide/vscode-types.d.ts +44 -0
- package/dist/commands/setup/ide/vscode-types.js +141 -0
- package/dist/commands/setup/ide/vscode-types.js.map +1 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/package.json +44 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/plugin/index.js +575 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/APIException.d.ts +48 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/ConversionError.d.ts +16 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/EvalError.d.ts +16 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/Fault.d.ts +55 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/IOError.d.ts +37 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/InternalError.d.ts +16 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/Module.d.ts +99 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/Namespace.d.ts +77 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/QName.d.ts +67 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/RangeError.d.ts +16 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/ReferenceError.d.ts +16 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/StopIteration.d.ts +11 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/SyntaxError.d.ts +16 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/SystemError.d.ts +38 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/TypeError.d.ts +16 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/URIError.d.ts +16 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/XML.d.ts +398 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/XMLList.d.ts +155 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/XMLStreamError.d.ts +46 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/arguments.d.ts +17 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/alert/Alert.d.ts +70 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/alert/Alerts.d.ts +123 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/alert/index.d.ts +7 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/ABTest.d.ts +26 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/ABTestMgr.d.ts +28 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/ABTestSegment.d.ts +45 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/AmountDiscount.d.ts +22 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/ApproachingDiscount.d.ts +75 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/BonusChoiceDiscount.d.ts +106 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/BonusDiscount.d.ts +23 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/Campaign.d.ts +167 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/CampaignMgr.d.ts +192 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/CampaignStatusCodes.d.ts +36 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/Coupon.d.ts +146 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/CouponMgr.d.ts +49 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/CouponRedemption.d.ts +32 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/CouponStatusCodes.d.ts +55 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/Discount.d.ts +122 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/DiscountPlan.d.ts +161 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/FixedPriceDiscount.d.ts +24 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/FixedPriceShippingDiscount.d.ts +24 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/FreeDiscount.d.ts +11 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/FreeShippingDiscount.d.ts +11 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/PercentageDiscount.d.ts +24 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/PercentageOptionDiscount.d.ts +21 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/PriceBookPriceDiscount.d.ts +20 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/Promotion.d.ts +455 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/PromotionMgr.d.ts +262 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/PromotionPlan.d.ts +180 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/SlotContent.d.ts +56 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/SourceCodeGroup.d.ts +42 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/SourceCodeInfo.d.ts +76 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/SourceCodeStatusCodes.d.ts +19 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/TotalFixedPriceDiscount.d.ts +20 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/index.d.ts +65 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/Catalog.d.ts +84 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/CatalogMgr.d.ts +61 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/Category.d.ts +592 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/CategoryAssignment.d.ts +78 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/CategoryLink.d.ts +56 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/PriceBook.d.ts +94 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/PriceBookMgr.d.ts +66 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/Product.d.ts +1100 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductActiveData.d.ts +593 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductAttributeModel.d.ts +215 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductAvailabilityLevels.d.ts +50 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductAvailabilityModel.d.ts +359 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductInventoryList.d.ts +65 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductInventoryMgr.d.ts +53 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductInventoryRecord.d.ts +296 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductLink.d.ts +66 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductMgr.d.ts +59 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductOption.d.ts +81 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductOptionModel.d.ts +78 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductOptionValue.d.ts +56 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductPriceInfo.d.ts +76 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductPriceModel.d.ts +586 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductPriceTable.d.ts +48 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductSearchHit.d.ts +398 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductSearchModel.d.ts +816 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductSearchRefinementDefinition.d.ts +43 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductSearchRefinementValue.d.ts +30 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductSearchRefinements.d.ts +142 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductVariationAttribute.d.ts +44 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductVariationAttributeValue.d.ts +90 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductVariationModel.d.ts +508 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/Recommendation.d.ts +139 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/SearchModel.d.ts +277 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/SearchRefinementDefinition.d.ts +61 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/SearchRefinementValue.d.ts +93 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/SearchRefinements.d.ts +114 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/SortingOption.d.ts +45 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/SortingRule.d.ts +18 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/Store.d.ts +214 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/StoreGroup.d.ts +44 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/StoreInventoryFilter.d.ts +49 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/StoreInventoryFilterValue.d.ts +45 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/StoreMgr.d.ts +86 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/Variant.d.ts +555 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/VariationGroup.d.ts +422 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/index.d.ts +93 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/content/Content.d.ts +210 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/content/ContentMgr.d.ts +48 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/content/ContentSearchModel.d.ts +230 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/content/ContentSearchRefinementDefinition.d.ts +27 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/content/ContentSearchRefinementValue.d.ts +10 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/content/ContentSearchRefinements.d.ts +105 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/content/Folder.d.ts +186 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/content/Library.d.ts +56 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/content/MarkupText.d.ts +125 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/content/MediaFile.d.ts +297 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/content/index.d.ts +23 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/crypto/CertificateRef.d.ts +20 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/crypto/CertificateUtils.d.ts +54 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/crypto/Cipher.d.ts +178 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/crypto/Encoding.d.ts +78 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/crypto/JWE.d.ts +114 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/crypto/JWEHeader.d.ts +55 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/crypto/JWS.d.ts +105 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/crypto/JWSHeader.d.ts +47 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/crypto/KeyRef.d.ts +28 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/crypto/Mac.d.ts +76 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/crypto/MessageDigest.d.ts +108 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/crypto/SecureRandom.d.ts +70 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/crypto/Signature.d.ts +88 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/crypto/WeakCipher.d.ts +51 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/crypto/WeakMac.d.ts +68 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/crypto/WeakMessageDigest.d.ts +100 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/crypto/WeakSignature.d.ts +63 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/crypto/X509Certificate.d.ts +73 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/crypto/index.d.ts +39 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/AddressBook.d.ts +66 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/AgentUserMgr.d.ts +50 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/AgentUserStatusCodes.d.ts +64 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/AuthenticationStatus.d.ts +62 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/Credentials.d.ts +266 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/Customer.d.ts +210 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/CustomerActiveData.d.ts +276 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/CustomerAddress.d.ts +280 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/CustomerCDPData.d.ts +25 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/CustomerContextMgr.d.ts +21 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/CustomerGroup.d.ts +76 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/CustomerList.d.ts +29 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/CustomerMgr.d.ts +611 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/CustomerPasswordConstraints.d.ts +48 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/CustomerPaymentInstrument.d.ts +118 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/CustomerStatusCodes.d.ts +17 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/EncryptedObject.d.ts +21 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/ExternalProfile.d.ts +70 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/OrderHistory.d.ts +81 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/ProductList.d.ts +376 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/ProductListItem.d.ts +204 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/ProductListItemPurchase.d.ts +62 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/ProductListMgr.d.ts +190 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/ProductListRegistrant.d.ts +70 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/Profile.d.ts +420 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/Wallet.d.ts +56 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/consent/ConsentStatusEntry.d.ts +35 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/consent/MarketingConsentSubscription.d.ts +110 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/consent/ShopperConsentErrorCodes.d.ts +30 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/consent/ShopperConsentException.d.ts +29 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/consent/ShopperConsentMgr.d.ts +78 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/consent/index.d.ts +13 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/index.d.ts +55 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/oauth/OAuthAccessTokenResponse.d.ts +71 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/oauth/OAuthFinalizedResponse.d.ts +32 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/oauth/OAuthLoginFlowMgr.d.ts +100 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/oauth/OAuthUserInfoResponse.d.ts +35 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/oauth/index.d.ts +11 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/shoppercontext/ShopperContext.d.ts +171 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/shoppercontext/ShopperContextErrorCodes.d.ts +41 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/shoppercontext/ShopperContextException.d.ts +48 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/shoppercontext/ShopperContextMgr.d.ts +130 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/shoppercontext/index.d.ts +11 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/AspectAttributeValidationException.d.ts +11 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/Component.d.ts +83 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/ComponentRenderSettings.d.ts +50 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/ComponentScriptContext.d.ts +96 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/CustomEditor.d.ts +80 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/CustomEditorResources.d.ts +51 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/Page.d.ts +255 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/PageMgr.d.ts +311 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/PageScriptContext.d.ts +127 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/Region.d.ts +56 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/RegionRenderSettings.d.ts +81 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/cms/CMSRecord.d.ts +68 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/cms/index.d.ts +5 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/image/FocalPoint.d.ts +25 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/image/Image.d.ts +45 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/image/ImageMetaData.d.ts +25 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/image/index.d.ts +9 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/index.d.ts +25 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/applepay/ApplePayHookResult.d.ts +104 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/applepay/ApplePayHooks.d.ts +271 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/applepay/index.d.ts +7 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/facebook/FacebookFeedHooks.d.ts +50 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/facebook/FacebookProduct.d.ts +567 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/facebook/index.d.ts +7 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/paymentapi/PaymentApiHooks.d.ts +62 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/paymentapi/index.d.ts +5 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/paymentrequest/PaymentRequestHookResult.d.ts +55 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/paymentrequest/PaymentRequestHooks.d.ts +168 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/paymentrequest/index.d.ts +7 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforceAdyenPaymentIntent.d.ts +53 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforceAdyenSavedPaymentMethod.d.ts +126 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforceBancontactPaymentDetails.d.ts +33 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforceCardPaymentDetails.d.ts +41 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforceEpsPaymentDetails.d.ts +23 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforceIdealPaymentDetails.d.ts +23 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforceKlarnaPaymentDetails.d.ts +23 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforcePayPalOrder.d.ts +109 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforcePayPalOrderAddress.d.ts +69 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforcePayPalOrderPayer.d.ts +43 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforcePayPalPaymentDetails.d.ts +33 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforcePaymentDetails.d.ts +39 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforcePaymentIntent.d.ts +116 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforcePaymentMethod.d.ts +162 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforcePaymentRequest.d.ts +562 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforcePaymentsHooks.d.ts +78 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforcePaymentsMerchantAccount.d.ts +61 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod.d.ts +41 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforcePaymentsMgr.d.ts +420 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforcePaymentsSiteConfiguration.d.ts +84 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforcePaymentsZone.d.ts +166 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforceSepaDebitPaymentDetails.d.ts +23 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforceVenmoPaymentDetails.d.ts +33 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/index.d.ts +49 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/pinterest/PinterestAvailability.d.ts +34 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/pinterest/PinterestFeedHooks.d.ts +54 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/pinterest/PinterestOrder.d.ts +122 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/pinterest/PinterestOrderHooks.d.ts +42 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/pinterest/PinterestProduct.d.ts +302 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/pinterest/index.d.ts +13 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/io/CSVStreamReader.d.ts +51 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/io/CSVStreamWriter.d.ts +34 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/io/File.d.ts +343 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/io/FileReader.d.ts +26 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/io/FileWriter.d.ts +62 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/io/InputStream.d.ts +15 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/io/OutputStream.d.ts +17 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/io/PrintWriter.d.ts +29 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/io/RandomAccessFileReader.d.ts +70 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/io/Reader.d.ts +105 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/io/StringWriter.d.ts +39 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/io/Writer.d.ts +35 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/io/XMLIndentingStreamWriter.d.ts +45 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/io/XMLStreamConstants.d.ts +68 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/io/XMLStreamReader.d.ts +674 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/io/XMLStreamWriter.d.ts +204 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/io/index.d.ts +35 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/job/JobExecution.d.ts +52 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/job/JobStepExecution.d.ts +58 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/job/index.d.ts +7 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/net/FTPClient.d.ts +219 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/net/FTPFileInfo.d.ts +46 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/net/HTTPClient.d.ts +337 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/net/HTTPClientLoggingConfig.d.ts +180 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/net/HTTPRequestPart.d.ts +122 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/net/Mail.d.ts +182 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/net/SFTPClient.d.ts +215 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/net/SFTPFileInfo.d.ts +45 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/net/WebDAVClient.d.ts +324 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/net/WebDAVFileInfo.d.ts +66 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/net/index.d.ts +23 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/object/ActiveData.d.ts +25 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/object/CustomAttributes.d.ts +143 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/object/CustomObject.d.ts +26 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/object/CustomObjectMgr.d.ts +283 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/object/Extensible.d.ts +27 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/object/ExtensibleObject.d.ts +36 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/object/Note.d.ts +47 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/object/ObjectAttributeDefinition.d.ts +239 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/object/ObjectAttributeGroup.d.ts +68 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/object/ObjectAttributeValueDefinition.d.ts +29 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/object/ObjectTypeDefinition.d.ts +113 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/object/PersistentObject.d.ts +33 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/object/SimpleExtensible.d.ts +21 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/object/SystemObjectMgr.d.ts +319 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/object/index.d.ts +31 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/AbstractItem.d.ts +91 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/AbstractItemCtnr.d.ts +100 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/Appeasement.d.ts +163 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/AppeasementItem.d.ts +43 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/Basket.d.ts +476 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/BasketMgr.d.ts +406 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/BonusDiscountLineItem.d.ts +170 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/CouponLineItem.d.ts +139 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/CreateAgentBasketLimitExceededException.d.ts +9 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/CreateBasketFromOrderException.d.ts +17 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/CreateCouponLineItemException.d.ts +29 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/CreateOrderException.d.ts +9 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/CreateTemporaryBasketLimitExceededException.d.ts +9 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/GiftCertificate.d.ts +220 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/GiftCertificateLineItem.d.ts +124 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/GiftCertificateMgr.d.ts +85 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/GiftCertificateStatusCodes.d.ts +42 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/Invoice.d.ts +284 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/InvoiceItem.d.ts +83 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/LineItem.d.ts +265 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/LineItemCtnr.d.ts +1146 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/LineItemTax.d.ts +56 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/Order.d.ts +1360 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/OrderAddress.d.ts +259 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/OrderItem.d.ts +332 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/OrderMgr.d.ts +864 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/OrderPaymentInstrument.d.ts +166 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/OrderProcessStatusCodes.d.ts +58 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/PaymentCard.d.ts +112 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/PaymentInstrument.d.ts +757 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/PaymentMethod.d.ts +141 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/PaymentMgr.d.ts +70 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/PaymentProcessor.d.ts +60 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/PaymentStatusCodes.d.ts +25 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/PaymentTransaction.d.ts +123 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/PriceAdjustment.d.ts +430 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/PriceAdjustmentLimitTypes.d.ts +26 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/ProductLineItem.d.ts +849 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/ProductShippingCost.d.ts +41 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/ProductShippingLineItem.d.ts +154 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/ProductShippingModel.d.ts +73 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/Return.d.ts +161 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/ReturnCase.d.ts +215 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/ReturnCaseItem.d.ts +165 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/ReturnItem.d.ts +159 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/Shipment.d.ts +506 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/ShipmentShippingCost.d.ts +21 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/ShipmentShippingModel.d.ts +114 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/ShippingLineItem.d.ts +151 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/ShippingLocation.d.ts +123 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/ShippingMethod.d.ts +114 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/ShippingMgr.d.ts +95 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/ShippingOrder.d.ts +304 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/ShippingOrderItem.d.ts +210 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/SumItem.d.ts +75 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/TaxGroup.d.ts +49 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/TaxItem.d.ts +29 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/TaxMgr.d.ts +155 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/TrackingInfo.d.ts +107 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/TrackingRef.d.ts +44 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/hooks/BasketMergeHooks.d.ts +46 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/hooks/CalculateHooks.d.ts +69 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/hooks/CheckoutHooks.d.ts +48 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/hooks/OrderHooks.d.ts +50 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/hooks/PaymentHooks.d.ts +189 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/hooks/ReturnHooks.d.ts +274 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/hooks/ShippingOrderHooks.d.ts +220 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/hooks/TaxHooks.d.ts +378 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/hooks/index.d.ts +19 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/index.d.ts +123 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/rpc/SOAPUtil.d.ts +339 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/rpc/Stub.d.ts +148 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/rpc/WebReference.d.ts +55 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/rpc/index.d.ts +9 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/sitemap/SitemapFile.d.ts +57 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/sitemap/SitemapMgr.d.ts +70 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/sitemap/index.d.ts +7 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/BrandSuggestions.d.ts +19 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/CategorySuggestions.d.ts +32 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/ContentSuggestions.d.ts +32 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/CustomSuggestions.d.ts +19 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/ProductSuggestions.d.ts +32 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/SearchPhraseSuggestions.d.ts +53 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/SuggestModel.d.ts +230 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/SuggestedCategory.d.ts +19 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/SuggestedContent.d.ts +19 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/SuggestedPhrase.d.ts +25 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/SuggestedProduct.d.ts +21 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/SuggestedTerm.d.ts +61 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/SuggestedTerms.d.ts +68 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/Suggestions.d.ts +89 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/index.d.ts +31 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/FTPService.d.ts +59 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/FTPServiceDefinition.d.ts +38 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/HTTPFormService.d.ts +14 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/HTTPFormServiceDefinition.d.ts +12 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/HTTPService.d.ts +147 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/HTTPServiceDefinition.d.ts +110 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/LocalServiceRegistry.d.ts +61 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/Result.d.ts +133 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/SOAPService.d.ts +36 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/SOAPServiceDefinition.d.ts +12 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/Service.d.ts +99 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/ServiceCallback.d.ts +172 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/ServiceConfig.d.ts +52 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/ServiceCredential.d.ts +67 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/ServiceDefinition.d.ts +105 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/ServiceProfile.d.ts +66 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/ServiceRegistry.d.ts +75 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/index.d.ts +37 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/AgentUserStatusCodes.d.ts +14 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/Cache.d.ts +60 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/CacheMgr.d.ts +39 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/HookMgr.d.ts +31 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/InternalObject.d.ts +17 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/JobProcessMonitor.d.ts +37 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/Log.d.ts +77 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/LogNDC.d.ts +32 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/Logger.d.ts +83 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/OrganizationPreferences.d.ts +40 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/Pipeline.d.ts +46 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/PipelineDictionary.d.ts +28 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/RESTErrorResponse.d.ts +58 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/RESTResponseMgr.d.ts +99 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/RESTSuccessResponse.d.ts +38 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/RemoteInclude.d.ts +85 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/Request.d.ts +363 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/RequestHooks.d.ts +50 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/Response.d.ts +278 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/SearchStatus.d.ts +74 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/Session.d.ts +263 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/Site.d.ts +247 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/SitePreferences.d.ts +51 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/Status.d.ts +141 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/StatusItem.d.ts +110 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/System.d.ts +96 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/Transaction.d.ts +60 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/index.d.ts +57 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/template/ISML.d.ts +32 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/template/Velocity.d.ts +71 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/template/index.d.ts +7 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/ArrayList.d.ts +40 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/Assert.d.ts +159 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/BigInteger.d.ts +104 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/Bytes.d.ts +99 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/Calendar.d.ts +450 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/Collection.d.ts +91 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/Currency.d.ts +59 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/DateUtils.d.ts +27 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/Decimal.d.ts +148 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/FilteringCollection.d.ts +75 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/Geolocation.d.ts +111 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/HashMap.d.ts +17 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/HashSet.d.ts +24 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/Iterator.d.ts +34 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/LinkedHashMap.d.ts +18 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/LinkedHashSet.d.ts +26 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/List.d.ts +148 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/Locale.d.ts +110 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/Map.d.ts +82 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/MapEntry.d.ts +24 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/MappingKey.d.ts +34 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/MappingMgr.d.ts +46 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/PropertyComparator.d.ts +59 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/SecureEncoder.d.ts +371 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/SecureFilter.d.ts +340 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/SeekableIterator.d.ts +85 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/Set.d.ts +13 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/SortedMap.d.ts +59 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/SortedSet.d.ts +75 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/StringUtils.d.ts +191 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/Template.d.ts +67 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/UUIDUtils.d.ts +12 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/index.d.ts +67 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/value/EnumValue.d.ts +50 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/value/MimeEncodedText.d.ts +47 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/value/Money.d.ts +196 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/value/Quantity.d.ts +103 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/value/index.d.ts +11 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/CSRFProtection.d.ts +48 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/ClickStream.d.ts +87 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/ClickStreamEntry.d.ts +106 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/Cookie.d.ts +166 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/Cookies.d.ts +23 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/Form.d.ts +30 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/FormAction.d.ts +82 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/FormElement.d.ts +92 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/FormElementValidationResult.d.ts +63 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/FormField.d.ts +331 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/FormFieldOption.d.ts +90 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/FormFieldOptions.d.ts +18 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/FormGroup.d.ts +106 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/FormList.d.ts +56 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/FormListItem.d.ts +18 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/Forms.d.ts +13 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/HttpParameter.d.ts +195 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/HttpParameterMap.d.ts +92 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/LoopIterator.d.ts +95 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/PageMetaData.d.ts +87 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/PageMetaTag.d.ts +81 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/PagingModel.d.ts +181 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/Resource.d.ts +69 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/URL.d.ts +68 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/URLAction.d.ts +41 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/URLParameter.d.ts +18 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/URLRedirect.d.ts +26 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/URLRedirectMgr.d.ts +37 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/URLUtils.d.ts +759 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/index.d.ts +61 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/ws/Port.d.ts +54 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/ws/WSUtil.d.ts +311 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/ws/WebReference2.d.ts +120 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/ws/index.d.ts +9 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/global.d.ts +1101 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/sfra/server.d.ts +271 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/upstream-package.json +7 -0
- package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/upstream-tsconfig.json +7 -0
- package/oclif.manifest.json +4160 -3853
- package/package.json +3 -3
|
@@ -0,0 +1,586 @@
|
|
|
1
|
+
import Quantity = require('../value/Quantity');
|
|
2
|
+
import Money = require('../value/Money');
|
|
3
|
+
import ProductPriceInfo = require('./ProductPriceInfo');
|
|
4
|
+
import Collection = require('../util/Collection');
|
|
5
|
+
import ProductPriceTable = require('./ProductPriceTable');
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* ProductPriceModel provides methods to access all the
|
|
9
|
+
* dw.catalog.PriceBook information of a product. A ProductPriceModel
|
|
10
|
+
* instance is retrieved by calling dw.catalog.Product.getPriceModel
|
|
11
|
+
* or dw.catalog.Product.getPriceModel for a
|
|
12
|
+
* specific product. The latter method will return a model which also includes
|
|
13
|
+
* the additional option prices of an option product.
|
|
14
|
+
*
|
|
15
|
+
* When the current price of a product is accessed in the storefront via its
|
|
16
|
+
* price model, a price lookup is performed. The high-level steps of this price
|
|
17
|
+
* lookup are:
|
|
18
|
+
*
|
|
19
|
+
* - Get all price books applicable in the context of the current site, time,
|
|
20
|
+
* session, customer, source code.
|
|
21
|
+
* - Identify all prices in the applicable price books and for a requested
|
|
22
|
+
* quantity.
|
|
23
|
+
* - Calculate the best-price of all identified prices. The best-price is the
|
|
24
|
+
* lowest price.
|
|
25
|
+
*
|
|
26
|
+
* In more detail:
|
|
27
|
+
*
|
|
28
|
+
* Identify applicable price books
|
|
29
|
+
*
|
|
30
|
+
* - If any price books are explicitly registered in the session (see pipelet
|
|
31
|
+
* SetApplicablePriceBooks), use these price books and their direct parents for
|
|
32
|
+
* price lookup. Ignore all inactive price books, price books not valid at the
|
|
33
|
+
* current time, and price books with a currency other than the session currency.
|
|
34
|
+
*
|
|
35
|
+
* Otherwise:
|
|
36
|
+
*
|
|
37
|
+
* - If a valid source code is registered with the current session, get all
|
|
38
|
+
* price books assigned to the source code and their parent price books. Ignore
|
|
39
|
+
* all inactive price books, price books not valid at the current time, and
|
|
40
|
+
* price books with a currency other than the session currency.
|
|
41
|
+
* - Get all price books assigned to site and their parent price books. Ignore
|
|
42
|
+
* all inactive price books, price books not valid at the current time, and
|
|
43
|
+
* price books with a currency other than the session currency.
|
|
44
|
+
*
|
|
45
|
+
* Identify all prices:
|
|
46
|
+
*
|
|
47
|
+
* - Get all price definitions for the product from all applicable price
|
|
48
|
+
* books. Ignore price definitions not valid at the current time.
|
|
49
|
+
* - Convert any percentage price definition into a monetary amount. As the
|
|
50
|
+
* base price for this calculation, the minimum product price for the minimum
|
|
51
|
+
* order quantity of the product, including product options, is used.
|
|
52
|
+
* - Compare all prices and identify the lowest (= best) price.
|
|
53
|
+
* - Calculate best price for each defined price cut in the price table and
|
|
54
|
+
* return price table.
|
|
55
|
+
*
|
|
56
|
+
* Variation Price Fallback:
|
|
57
|
+
*
|
|
58
|
+
* - If no applicable pricebooks for a variant is found, the price lookup gets
|
|
59
|
+
* the price books from the variant's master product
|
|
60
|
+
* - A price books is also not applicable of the price definition for the
|
|
61
|
+
* variant in the price book is not valid at the current time.
|
|
62
|
+
*
|
|
63
|
+
* Typically, in order to do a standard price lookup, it is only necessary to
|
|
64
|
+
* call `Product.getPriceModel().getPrice()`. However, Commerce Cloud
|
|
65
|
+
* Digital also supports tiered prices, meaning that higher quantities receive
|
|
66
|
+
* a lower price. In this case, the merchant typically wants to display a table
|
|
67
|
+
* of price points on product detail pages. Therefore, the ProductPriceModel
|
|
68
|
+
* provides the method getPriceTable to retrieve a table of these prices.
|
|
69
|
+
*
|
|
70
|
+
* If a merchant wants to know not only what the price of a given product is,
|
|
71
|
+
* but what price book the price was derived from, this class provides the
|
|
72
|
+
* method getPriceInfo. This class also provides methods to lookup
|
|
73
|
+
* product prices in specific price books by name and quantity. See
|
|
74
|
+
* getPriceBookPrice.
|
|
75
|
+
*/
|
|
76
|
+
declare class ProductPriceModel {
|
|
77
|
+
/**
|
|
78
|
+
* Returns the quantity for which the base price is defined. This
|
|
79
|
+
* is typically 1.0.
|
|
80
|
+
*/
|
|
81
|
+
readonly basePriceQuantity: Quantity;
|
|
82
|
+
/**
|
|
83
|
+
* Calculates and returns the maximum price-book price of all variants (for
|
|
84
|
+
* master products) or set-products (for product sets) for base quantity
|
|
85
|
+
* 1.00. This value can be used to display a range of prices in storefront.
|
|
86
|
+
* If the product represented by this model is not a master product or
|
|
87
|
+
* product set, then this method behaves the same as getPrice.
|
|
88
|
+
* Only online products are considered. If the "orderable products only"
|
|
89
|
+
* search preference is enabled for the current site, then only orderable
|
|
90
|
+
* products are considered. For master products, only variants with all
|
|
91
|
+
* variation attributes configured are considered.
|
|
92
|
+
*
|
|
93
|
+
* Warning: If the product represented by this model is a master
|
|
94
|
+
* product with numerous variants, this method can be very expensive and
|
|
95
|
+
* should be avoided.
|
|
96
|
+
*/
|
|
97
|
+
readonly maxPrice: Money;
|
|
98
|
+
/**
|
|
99
|
+
* Calculates and returns the maximum price-book price per unit of all variants (for
|
|
100
|
+
* master products) or set-products (for product sets) for base quantity
|
|
101
|
+
* 1.00. This value can be used to display a range of prices in storefront.
|
|
102
|
+
* If the product represented by this model is not a master product or
|
|
103
|
+
* product set, then this method behaves the same as getPricePerUnit.
|
|
104
|
+
* Only online products are considered. If the "orderable products only"
|
|
105
|
+
* search preference is enabled for the current site, then only orderable
|
|
106
|
+
* products are considered. For master products, only variants with all
|
|
107
|
+
* variation attributes configured are considered.
|
|
108
|
+
*
|
|
109
|
+
* e.g.
|
|
110
|
+
* suppose one master product mp (price = $6, unitQuantity = 2), it has 2 variants:
|
|
111
|
+
* v1(price = $5, unitQuantity = 5), v2(price = $10, unitQuantity = 20).
|
|
112
|
+
* The max price per unit of mp will be max($6/2, $5/5, $10/20) = $3
|
|
113
|
+
*/
|
|
114
|
+
readonly maxPricePerUnit: Money;
|
|
115
|
+
/**
|
|
116
|
+
* Calculates and returns the minimum price-book price of all variants (for
|
|
117
|
+
* master products) or set-products (for product sets) for base quantity
|
|
118
|
+
* 1.00. This value can be used to display a range of prices in storefront.
|
|
119
|
+
* If the product represented by this model is not a master product or
|
|
120
|
+
* product set, then this method behaves the same as getPrice.
|
|
121
|
+
* Only online products are considered. If the "orderable products only"
|
|
122
|
+
* search preference is enabled for the current site, then only orderable
|
|
123
|
+
* products are considered. For master products, only variants with all
|
|
124
|
+
* variation attributes configured are considered.
|
|
125
|
+
*
|
|
126
|
+
* Warning: If the product represented by this model is a master
|
|
127
|
+
* product with numerous variants, this method can be very expensive and
|
|
128
|
+
* should be avoided.
|
|
129
|
+
*/
|
|
130
|
+
readonly minPrice: Money;
|
|
131
|
+
/**
|
|
132
|
+
* Calculates and returns the minimum price-book price per unit of all variants (for
|
|
133
|
+
* master products) or set-products (for product sets) for base quantity
|
|
134
|
+
* 1.00. This value can be used to display a range of prices in storefront.
|
|
135
|
+
* If the product represented by this model is not a master product or
|
|
136
|
+
* product set, then this method behaves the same as getPricePerUnit.
|
|
137
|
+
* Only online products are considered. If the "orderable products only"
|
|
138
|
+
* search preference is enabled for the current site, then only orderable
|
|
139
|
+
* products are considered. For master products, only variants with all
|
|
140
|
+
* variation attributes configured are considered.
|
|
141
|
+
*
|
|
142
|
+
* e.g.
|
|
143
|
+
* suppose one master product mp (price = $6, unitQuantity = 2), it has 2 variants:
|
|
144
|
+
* v1(price = $5, unitQuantity = 5), v2(price = $10, unitQuantity = 20).
|
|
145
|
+
* The min price per unit of mp will be min($6/2, $5/5, $10/20) = $0.5
|
|
146
|
+
*/
|
|
147
|
+
readonly minPricePerUnit: Money;
|
|
148
|
+
/**
|
|
149
|
+
* Returns the active price of a product, calculated based on base price quantity
|
|
150
|
+
* 1.00. The price is returned for the currency of the current session.
|
|
151
|
+
*
|
|
152
|
+
* The price lookup is based on the configuration of price books. It depends
|
|
153
|
+
* on various settings, such as which price books are active, or explicitly
|
|
154
|
+
* set as applicable in the current session.
|
|
155
|
+
*
|
|
156
|
+
* If the product represented by this model is an option product, option
|
|
157
|
+
* prices will be added to the price book price if the price model was
|
|
158
|
+
* initialized with an option model.
|
|
159
|
+
*
|
|
160
|
+
* If no price could be found, MONEY.NOT_AVAILABLE is returned.
|
|
161
|
+
*/
|
|
162
|
+
readonly price: Money;
|
|
163
|
+
/**
|
|
164
|
+
* Returns the active price info of a product, calculated based on base price
|
|
165
|
+
* quantity 1.00. The price is returned for the currency of the current
|
|
166
|
+
* session.
|
|
167
|
+
*
|
|
168
|
+
* This method is similar to `getPrice()` but instead of just
|
|
169
|
+
* returning the price value, it returns a `ProductPriceInfo`
|
|
170
|
+
* which contains additional information such as the PriceBook which defined
|
|
171
|
+
* the price and the percentage discount this price point represents.
|
|
172
|
+
*
|
|
173
|
+
* If the product represented by this model is an option product, option
|
|
174
|
+
* prices will be added to the price book price if the price model was
|
|
175
|
+
* initialized with an option model.
|
|
176
|
+
*
|
|
177
|
+
* If no price info could be found, null is returned.
|
|
178
|
+
* @see getPrice
|
|
179
|
+
* @see getPriceInfo
|
|
180
|
+
*/
|
|
181
|
+
readonly priceInfo: ProductPriceInfo | null;
|
|
182
|
+
/**
|
|
183
|
+
* Returns all the eligible `</>ProductPriceInfo`</>(s), calculated based
|
|
184
|
+
* on base price quantity 1.00. This will return an empty list if getPriceInfo() would return null, and if there is
|
|
185
|
+
* only one price info in the collection it will be the same price info as getPriceInfo(). Two or more price infos
|
|
186
|
+
* indicate that there are that many price books that meet the criteria for returning the price shown in the
|
|
187
|
+
* storefront.
|
|
188
|
+
* @see getPriceInfo
|
|
189
|
+
*/
|
|
190
|
+
readonly priceInfos: Collection<ProductPriceInfo>;
|
|
191
|
+
/**
|
|
192
|
+
* Returns the sales price per unit of a product, calculated based on base price
|
|
193
|
+
* quantity 1.00.
|
|
194
|
+
*
|
|
195
|
+
* The product sales price per unit is returned for the current session currency.
|
|
196
|
+
* Hence, the using this method is only useful in storefront processes.
|
|
197
|
+
*
|
|
198
|
+
* The price lookup is based on the configuration of price books. It depends
|
|
199
|
+
* on various settings, such as which price books are active, or explicitly
|
|
200
|
+
* set as applicable in the current session.
|
|
201
|
+
*
|
|
202
|
+
* If no price could be found, MONEY.N_A is returned.
|
|
203
|
+
*/
|
|
204
|
+
readonly pricePerUnit: Money;
|
|
205
|
+
/**
|
|
206
|
+
* Returns true if this product is a master product (or product set) and the
|
|
207
|
+
* collection of online variants (or set products respectively) contains
|
|
208
|
+
* products of different prices.
|
|
209
|
+
*
|
|
210
|
+
* Warning: If the product represented by this model is a master
|
|
211
|
+
* product with numerous variants, this method can be very expensive and
|
|
212
|
+
* should be avoided.
|
|
213
|
+
*/
|
|
214
|
+
readonly priceRange: boolean;
|
|
215
|
+
/**
|
|
216
|
+
* Returns the product price table object. The price table represents a map
|
|
217
|
+
* between order quantities and prices, and also provides % off information
|
|
218
|
+
* to be shown to storefront customers. The price is returned for the
|
|
219
|
+
* currency of the current session.
|
|
220
|
+
*
|
|
221
|
+
* Usually, the product price table is printed on product detail pages in
|
|
222
|
+
* the storefront.
|
|
223
|
+
*
|
|
224
|
+
* If the product represented by this model is an option product, option
|
|
225
|
+
* prices will be added to the price book price if the price model was
|
|
226
|
+
* initialized with an option model.
|
|
227
|
+
*
|
|
228
|
+
* All other methods of this class are based on the information in the
|
|
229
|
+
* product price table.
|
|
230
|
+
*/
|
|
231
|
+
readonly priceTable: ProductPriceTable;
|
|
232
|
+
private constructor();
|
|
233
|
+
/**
|
|
234
|
+
* Returns the quantity for which the base price is defined. This
|
|
235
|
+
* is typically 1.0.
|
|
236
|
+
*/
|
|
237
|
+
getBasePriceQuantity(): Quantity;
|
|
238
|
+
/**
|
|
239
|
+
* Calculates and returns the maximum price-book price of all variants (for
|
|
240
|
+
* master products) or set-products (for product sets) for base quantity
|
|
241
|
+
* 1.00. This value can be used to display a range of prices in storefront.
|
|
242
|
+
* If the product represented by this model is not a master product or
|
|
243
|
+
* product set, then this method behaves the same as getPrice.
|
|
244
|
+
* Only online products are considered. If the "orderable products only"
|
|
245
|
+
* search preference is enabled for the current site, then only orderable
|
|
246
|
+
* products are considered. For master products, only variants with all
|
|
247
|
+
* variation attributes configured are considered.
|
|
248
|
+
*
|
|
249
|
+
* Warning: If the product represented by this model is a master
|
|
250
|
+
* product with numerous variants, this method can be very expensive and
|
|
251
|
+
* should be avoided.
|
|
252
|
+
*/
|
|
253
|
+
getMaxPrice(): Money;
|
|
254
|
+
/**
|
|
255
|
+
* Calculates and returns the maximum price in a given price book of all
|
|
256
|
+
* variants (for master products) or set-products (for product sets) for
|
|
257
|
+
* base quantity 1.00. This value can be used to display a range of prices
|
|
258
|
+
* in storefront.
|
|
259
|
+
*
|
|
260
|
+
* This method follows the same rules as
|
|
261
|
+
* getPriceBookPrice in determining the price book
|
|
262
|
+
* price for each variant or set-product. If the product represented by this
|
|
263
|
+
* model is not a master product or product set, then this method behaves
|
|
264
|
+
* the same as getPriceBookPrice.
|
|
265
|
+
*/
|
|
266
|
+
getMaxPriceBookPrice(priceBookID: string): Money;
|
|
267
|
+
/**
|
|
268
|
+
* Calculates and returns the maximum price per unit in a given price book of all
|
|
269
|
+
* variants (for master products) or set-products (for product sets) for
|
|
270
|
+
* base quantity 1.00. This value can be used to display a range of price per units
|
|
271
|
+
* in storefront.
|
|
272
|
+
*
|
|
273
|
+
* This method follows the same rules as
|
|
274
|
+
* getPriceBookPricePerUnit in determining the price book
|
|
275
|
+
* price for each variant or set-product. If the product represented by this
|
|
276
|
+
* model is not a master product or product set, then this method behaves
|
|
277
|
+
* the same as getPriceBookPricePerUnit.
|
|
278
|
+
*/
|
|
279
|
+
getMaxPriceBookPricePerUnit(priceBookID: string): Money;
|
|
280
|
+
/**
|
|
281
|
+
* Calculates and returns the maximum price-book price per unit of all variants (for
|
|
282
|
+
* master products) or set-products (for product sets) for base quantity
|
|
283
|
+
* 1.00. This value can be used to display a range of prices in storefront.
|
|
284
|
+
* If the product represented by this model is not a master product or
|
|
285
|
+
* product set, then this method behaves the same as getPricePerUnit.
|
|
286
|
+
* Only online products are considered. If the "orderable products only"
|
|
287
|
+
* search preference is enabled for the current site, then only orderable
|
|
288
|
+
* products are considered. For master products, only variants with all
|
|
289
|
+
* variation attributes configured are considered.
|
|
290
|
+
*
|
|
291
|
+
* e.g.
|
|
292
|
+
* suppose one master product mp (price = $6, unitQuantity = 2), it has 2 variants:
|
|
293
|
+
* v1(price = $5, unitQuantity = 5), v2(price = $10, unitQuantity = 20).
|
|
294
|
+
* The max price per unit of mp will be max($6/2, $5/5, $10/20) = $3
|
|
295
|
+
*/
|
|
296
|
+
getMaxPricePerUnit(): Money;
|
|
297
|
+
/**
|
|
298
|
+
* Calculates and returns the minimum price-book price of all variants (for
|
|
299
|
+
* master products) or set-products (for product sets) for base quantity
|
|
300
|
+
* 1.00. This value can be used to display a range of prices in storefront.
|
|
301
|
+
* If the product represented by this model is not a master product or
|
|
302
|
+
* product set, then this method behaves the same as getPrice.
|
|
303
|
+
* Only online products are considered. If the "orderable products only"
|
|
304
|
+
* search preference is enabled for the current site, then only orderable
|
|
305
|
+
* products are considered. For master products, only variants with all
|
|
306
|
+
* variation attributes configured are considered.
|
|
307
|
+
*
|
|
308
|
+
* Warning: If the product represented by this model is a master
|
|
309
|
+
* product with numerous variants, this method can be very expensive and
|
|
310
|
+
* should be avoided.
|
|
311
|
+
*/
|
|
312
|
+
getMinPrice(): Money;
|
|
313
|
+
/**
|
|
314
|
+
* Calculates and returns the minimum price in a given price book of all
|
|
315
|
+
* variants (for master products) or set-products (for product sets) for
|
|
316
|
+
* base quantity 1.00. This value can be used to display a range of prices
|
|
317
|
+
* in storefront.
|
|
318
|
+
*
|
|
319
|
+
* This method follows the same rules as
|
|
320
|
+
* getPriceBookPrice in determining the price book
|
|
321
|
+
* price for each variant or set-product. If the product represented by this
|
|
322
|
+
* model is not a master product or product set, then this method behaves
|
|
323
|
+
* the same as getPriceBookPrice.
|
|
324
|
+
*/
|
|
325
|
+
getMinPriceBookPrice(priceBookID: string): Money;
|
|
326
|
+
/**
|
|
327
|
+
* Calculates and returns the minimum price per unit in a given price book of all
|
|
328
|
+
* variants (for master products) or set-products (for product sets) for
|
|
329
|
+
* base quantity 1.00. This value can be used to display a range of price per units
|
|
330
|
+
* in storefront.
|
|
331
|
+
*
|
|
332
|
+
* This method follows the same rules as
|
|
333
|
+
* getPriceBookPricePerUnit in determining the price book
|
|
334
|
+
* price for each variant or set-product. If the product represented by this
|
|
335
|
+
* model is not a master product or product set, then this method behaves
|
|
336
|
+
* the same as getPriceBookPricePerUnit.
|
|
337
|
+
*/
|
|
338
|
+
getMinPriceBookPricePerUnit(priceBookID: string): Money;
|
|
339
|
+
/**
|
|
340
|
+
* Calculates and returns the minimum price-book price per unit of all variants (for
|
|
341
|
+
* master products) or set-products (for product sets) for base quantity
|
|
342
|
+
* 1.00. This value can be used to display a range of prices in storefront.
|
|
343
|
+
* If the product represented by this model is not a master product or
|
|
344
|
+
* product set, then this method behaves the same as getPricePerUnit.
|
|
345
|
+
* Only online products are considered. If the "orderable products only"
|
|
346
|
+
* search preference is enabled for the current site, then only orderable
|
|
347
|
+
* products are considered. For master products, only variants with all
|
|
348
|
+
* variation attributes configured are considered.
|
|
349
|
+
*
|
|
350
|
+
* e.g.
|
|
351
|
+
* suppose one master product mp (price = $6, unitQuantity = 2), it has 2 variants:
|
|
352
|
+
* v1(price = $5, unitQuantity = 5), v2(price = $10, unitQuantity = 20).
|
|
353
|
+
* The min price per unit of mp will be min($6/2, $5/5, $10/20) = $0.5
|
|
354
|
+
*/
|
|
355
|
+
getMinPricePerUnit(): Money;
|
|
356
|
+
/**
|
|
357
|
+
* Returns the active price of a product, calculated based on base price quantity
|
|
358
|
+
* 1.00. The price is returned for the currency of the current session.
|
|
359
|
+
*
|
|
360
|
+
* The price lookup is based on the configuration of price books. It depends
|
|
361
|
+
* on various settings, such as which price books are active, or explicitly
|
|
362
|
+
* set as applicable in the current session.
|
|
363
|
+
*
|
|
364
|
+
* If the product represented by this model is an option product, option
|
|
365
|
+
* prices will be added to the price book price if the price model was
|
|
366
|
+
* initialized with an option model.
|
|
367
|
+
*
|
|
368
|
+
* If no price could be found, MONEY.NOT_AVAILABLE is returned.
|
|
369
|
+
*/
|
|
370
|
+
getPrice(): Money;
|
|
371
|
+
/**
|
|
372
|
+
* Returns the active price of a product, calculated based on the passed order
|
|
373
|
+
* quantity. The price is returned for the currency of the current session.
|
|
374
|
+
*
|
|
375
|
+
* The price lookup is based on the configuration of price books. It depends
|
|
376
|
+
* on various settings, such as which price books are active, or explicitly
|
|
377
|
+
* set as applicable in the current session.
|
|
378
|
+
*
|
|
379
|
+
* If the product represented by this model is an option product, option
|
|
380
|
+
* prices will be added to the price book price if the price model was
|
|
381
|
+
* initialized with an option model.
|
|
382
|
+
*
|
|
383
|
+
* If passed order quantity < 1 (and greater than zero), price for quantity
|
|
384
|
+
* 1 is returned.
|
|
385
|
+
*
|
|
386
|
+
* If no price could be found, MONEY.NOT_AVAILABLE is returned.
|
|
387
|
+
*/
|
|
388
|
+
getPrice(quantity: Quantity): Money;
|
|
389
|
+
/**
|
|
390
|
+
* Returns the active price of the product in the specified price book for
|
|
391
|
+
* quantity 1.00.
|
|
392
|
+
*
|
|
393
|
+
* If the product represented by this model is an option product, option
|
|
394
|
+
* prices will be added to the price book price if the price model was
|
|
395
|
+
* initialized with an option model.
|
|
396
|
+
*
|
|
397
|
+
* Money.NOT_AVAILABLE will be returned in any of the following cases:
|
|
398
|
+
*
|
|
399
|
+
* - priceBookID is null or does not identify a valid price book.
|
|
400
|
+
* - The price book has no price for the product.
|
|
401
|
+
* - None of the prices for the product in the price book is currently
|
|
402
|
+
* active.
|
|
403
|
+
* - The currently active price entry is a percentage.
|
|
404
|
+
*/
|
|
405
|
+
getPriceBookPrice(priceBookID: string): Money | null;
|
|
406
|
+
/**
|
|
407
|
+
* Returns the active price of the product in the specified price book for
|
|
408
|
+
* the specified quantity.
|
|
409
|
+
*
|
|
410
|
+
* If the product represented by this model is an option product, option
|
|
411
|
+
* prices will be added to the price book price if the price model was
|
|
412
|
+
* initialized with an option model.
|
|
413
|
+
*
|
|
414
|
+
* Money.NOT_AVAILABLE will be returned in any of the following cases:
|
|
415
|
+
*
|
|
416
|
+
* - priceBookID is null or does not identify a valid price book.
|
|
417
|
+
* - quantity is null.
|
|
418
|
+
* - The price book has no price for the product.
|
|
419
|
+
* - None of the prices for the product in the price book is currently
|
|
420
|
+
* active.
|
|
421
|
+
* - The currently active price entry is a percentage.
|
|
422
|
+
*/
|
|
423
|
+
getPriceBookPrice(priceBookID: string, quantity: Quantity): Money | null;
|
|
424
|
+
/**
|
|
425
|
+
* This method acts similarly to getPriceBookPrice but
|
|
426
|
+
* returns a ProductPriceInfo object wrapping the actual price with
|
|
427
|
+
* additional information.
|
|
428
|
+
*/
|
|
429
|
+
getPriceBookPriceInfo(priceBookID: string): ProductPriceInfo | null;
|
|
430
|
+
/**
|
|
431
|
+
* This method acts similarly to
|
|
432
|
+
* getPriceBookPrice but returns a
|
|
433
|
+
* ProductPriceInfo object wrapping the actual price with additional
|
|
434
|
+
* information.
|
|
435
|
+
*/
|
|
436
|
+
getPriceBookPriceInfo(priceBookID: string, quantity: Quantity): ProductPriceInfo | null;
|
|
437
|
+
/**
|
|
438
|
+
* Returns the active price per unit of the product in the specified price book for
|
|
439
|
+
* quantity 1.00.
|
|
440
|
+
*
|
|
441
|
+
* If the product represented by this model is an option product, option
|
|
442
|
+
* prices will be added to the price book price if the price model was
|
|
443
|
+
* initialized with an option model.
|
|
444
|
+
*
|
|
445
|
+
* Money.NOT_AVAILABLE will be returned in any of the following cases:
|
|
446
|
+
*
|
|
447
|
+
* - The priceBookID does not identify a valid price book.
|
|
448
|
+
* - The price book has no price for the product.
|
|
449
|
+
* - None of the prices for the product in the price book is currently
|
|
450
|
+
* active.
|
|
451
|
+
* - The currently active price entry is a percentage.
|
|
452
|
+
*/
|
|
453
|
+
getPriceBookPricePerUnit(priceBookID: string): Money;
|
|
454
|
+
/**
|
|
455
|
+
* Returns the active price per unit of the product in the specified price book for
|
|
456
|
+
* the specified quantity.
|
|
457
|
+
*
|
|
458
|
+
* If the product represented by this model is an option product, option
|
|
459
|
+
* prices will be added to the price book price if the price model was
|
|
460
|
+
* initialized with an option model.
|
|
461
|
+
*
|
|
462
|
+
* Money.NOT_AVAILABLE will be returned in any of the following cases:
|
|
463
|
+
*
|
|
464
|
+
* - The priceBookID does not identify a valid price book.
|
|
465
|
+
* - The price book has no price for the product.
|
|
466
|
+
* - None of the prices for the product in the price book is currently
|
|
467
|
+
* active.
|
|
468
|
+
* - The currently active price entry is a percentage.
|
|
469
|
+
*/
|
|
470
|
+
getPriceBookPricePerUnit(priceBookID: string, quantity: Quantity): Money;
|
|
471
|
+
/**
|
|
472
|
+
* Returns the active price info of a product, calculated based on base price
|
|
473
|
+
* quantity 1.00. The price is returned for the currency of the current
|
|
474
|
+
* session.
|
|
475
|
+
*
|
|
476
|
+
* This method is similar to `getPrice()` but instead of just
|
|
477
|
+
* returning the price value, it returns a `ProductPriceInfo`
|
|
478
|
+
* which contains additional information such as the PriceBook which defined
|
|
479
|
+
* the price and the percentage discount this price point represents.
|
|
480
|
+
*
|
|
481
|
+
* If the product represented by this model is an option product, option
|
|
482
|
+
* prices will be added to the price book price if the price model was
|
|
483
|
+
* initialized with an option model.
|
|
484
|
+
*
|
|
485
|
+
* If no price info could be found, null is returned.
|
|
486
|
+
* @see getPrice
|
|
487
|
+
* @see getPriceInfo
|
|
488
|
+
*/
|
|
489
|
+
getPriceInfo(): ProductPriceInfo | null;
|
|
490
|
+
/**
|
|
491
|
+
* Returns the active price info of a product, calculated based on the passed order
|
|
492
|
+
* quantity. The price is returned for the currency of the current session.
|
|
493
|
+
*
|
|
494
|
+
* This method is similar to `getPrice(Quantity)` but instead of
|
|
495
|
+
* just returning the price value, it returns a
|
|
496
|
+
* `ProductPriceInfo` which contains additional information such
|
|
497
|
+
* as the PriceBook which defined the price and the percentage discount this
|
|
498
|
+
* price point represents.
|
|
499
|
+
*
|
|
500
|
+
* If the product represented by this model is an option product, option
|
|
501
|
+
* prices will be added to the price book price if the price model was
|
|
502
|
+
* initialized with an option model.
|
|
503
|
+
*
|
|
504
|
+
* If no price info could be found, null is returned.
|
|
505
|
+
* @see getPrice
|
|
506
|
+
*/
|
|
507
|
+
getPriceInfo(quantity: Quantity): ProductPriceInfo | null;
|
|
508
|
+
/**
|
|
509
|
+
* Returns all the eligible `</>ProductPriceInfo`</>(s), calculated based
|
|
510
|
+
* on base price quantity 1.00. This will return an empty list if getPriceInfo() would return null, and if there is
|
|
511
|
+
* only one price info in the collection it will be the same price info as getPriceInfo(). Two or more price infos
|
|
512
|
+
* indicate that there are that many price books that meet the criteria for returning the price shown in the
|
|
513
|
+
* storefront.
|
|
514
|
+
* @see getPriceInfo
|
|
515
|
+
*/
|
|
516
|
+
getPriceInfos(): Collection<ProductPriceInfo>;
|
|
517
|
+
/**
|
|
518
|
+
* Returns the sales price per unit of a product, calculated based on base price
|
|
519
|
+
* quantity 1.00.
|
|
520
|
+
*
|
|
521
|
+
* The product sales price per unit is returned for the current session currency.
|
|
522
|
+
* Hence, the using this method is only useful in storefront processes.
|
|
523
|
+
*
|
|
524
|
+
* The price lookup is based on the configuration of price books. It depends
|
|
525
|
+
* on various settings, such as which price books are active, or explicitly
|
|
526
|
+
* set as applicable in the current session.
|
|
527
|
+
*
|
|
528
|
+
* If no price could be found, MONEY.N_A is returned.
|
|
529
|
+
*/
|
|
530
|
+
getPricePerUnit(): Money;
|
|
531
|
+
/**
|
|
532
|
+
* Returns the sales price per unit of a product, calculated based on the passed
|
|
533
|
+
* order quantity.
|
|
534
|
+
*
|
|
535
|
+
* The product sales price per unit is returned for the current session currency.
|
|
536
|
+
* Hence, the using this method is only useful in storefront processes.
|
|
537
|
+
*
|
|
538
|
+
* The price lookup is based on the configuration of price books. It depends
|
|
539
|
+
* on various settings, such as which price books are active, or explicitely
|
|
540
|
+
* set as applicable in the current session.
|
|
541
|
+
*
|
|
542
|
+
* If no price could be found, MONEY.N_A is returned.
|
|
543
|
+
*/
|
|
544
|
+
getPricePerUnit(quantity: Quantity): Money;
|
|
545
|
+
/**
|
|
546
|
+
* Calculates and returns the percentage off amount of the passed
|
|
547
|
+
* comparePrice to the passed basePrice.
|
|
548
|
+
* @deprecated Use dw.value.Money.percentLessThan
|
|
549
|
+
*/
|
|
550
|
+
getPricePercentage(basePrice: Money, comparePrice: Money): number;
|
|
551
|
+
/**
|
|
552
|
+
* Returns the product price table object. The price table represents a map
|
|
553
|
+
* between order quantities and prices, and also provides % off information
|
|
554
|
+
* to be shown to storefront customers. The price is returned for the
|
|
555
|
+
* currency of the current session.
|
|
556
|
+
*
|
|
557
|
+
* Usually, the product price table is printed on product detail pages in
|
|
558
|
+
* the storefront.
|
|
559
|
+
*
|
|
560
|
+
* If the product represented by this model is an option product, option
|
|
561
|
+
* prices will be added to the price book price if the price model was
|
|
562
|
+
* initialized with an option model.
|
|
563
|
+
*
|
|
564
|
+
* All other methods of this class are based on the information in the
|
|
565
|
+
* product price table.
|
|
566
|
+
*/
|
|
567
|
+
getPriceTable(): ProductPriceTable;
|
|
568
|
+
/**
|
|
569
|
+
* Returns true if this product is a master product (or product set) and the
|
|
570
|
+
* collection of online variants (or set products respectively) contains
|
|
571
|
+
* products of different prices.
|
|
572
|
+
*
|
|
573
|
+
* Warning: If the product represented by this model is a master
|
|
574
|
+
* product with numerous variants, this method can be very expensive and
|
|
575
|
+
* should be avoided.
|
|
576
|
+
*/
|
|
577
|
+
isPriceRange(): boolean;
|
|
578
|
+
/**
|
|
579
|
+
* Returns true if this product is a master product (or product set) and the
|
|
580
|
+
* collection of online variants (or set products respectively) contains
|
|
581
|
+
* products of different prices in the specified price book.
|
|
582
|
+
*/
|
|
583
|
+
isPriceRange(priceBookID: string): boolean;
|
|
584
|
+
}
|
|
585
|
+
|
|
586
|
+
export = ProductPriceModel;
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import Money = require('../value/Money');
|
|
2
|
+
import Quantity = require('../value/Quantity');
|
|
3
|
+
import PriceBook = require('./PriceBook');
|
|
4
|
+
import Collection = require('../util/Collection');
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* A ProductPriceTable is a map of quantities to prices representing the
|
|
8
|
+
* potentially tiered prices of a product in Commerce Cloud Digital. The price
|
|
9
|
+
* of a product is the price associated with the largest quantity in
|
|
10
|
+
* the ProductPriceTable which does not exceed the purchase quantity.
|
|
11
|
+
*/
|
|
12
|
+
declare class ProductPriceTable {
|
|
13
|
+
/**
|
|
14
|
+
* Returns all quantities stored in the price table.
|
|
15
|
+
*/
|
|
16
|
+
readonly quantities: Collection<Quantity>;
|
|
17
|
+
private constructor();
|
|
18
|
+
/**
|
|
19
|
+
* Returns the quantity following the passed quantity in the price table.
|
|
20
|
+
* If the passed quantity is the last entry in the price table, null is
|
|
21
|
+
* returned.
|
|
22
|
+
*/
|
|
23
|
+
getNextQuantity(quantity: Quantity): Quantity | null;
|
|
24
|
+
/**
|
|
25
|
+
* Returns the percentage off value of the price related to the passed quantity,
|
|
26
|
+
* calculated based on the price of the products minimum order quantity.
|
|
27
|
+
*/
|
|
28
|
+
getPercentage(quantity: Quantity): number;
|
|
29
|
+
/**
|
|
30
|
+
* Returns the monetary price for the passed order quantity. If
|
|
31
|
+
* no price is defined for the passed quantity, null is returned. This
|
|
32
|
+
* can happen if for example no price is defined for a single item.
|
|
33
|
+
*/
|
|
34
|
+
getPrice(quantity: Quantity): Money | null;
|
|
35
|
+
/**
|
|
36
|
+
* Returns the price book which defined the monetary price for the passed
|
|
37
|
+
* order quantity. If no price is defined for the passed quantity, null is
|
|
38
|
+
* returned. This can happen if for example no price is defined for a single
|
|
39
|
+
* item.
|
|
40
|
+
*/
|
|
41
|
+
getPriceBook(quantity: Quantity): PriceBook | null;
|
|
42
|
+
/**
|
|
43
|
+
* Returns all quantities stored in the price table.
|
|
44
|
+
*/
|
|
45
|
+
getQuantities(): Collection<Quantity>;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
export = ProductPriceTable;
|