@salesforce/b2c-tooling-sdk 1.15.1 → 1.17.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/data/content-schemas/regiondefinition.json +1 -0
- package/data/job-steps/CatalogDeltaExport.md +31 -0
- package/data/job-steps/CreateSitemap.md +22 -0
- package/data/job-steps/CustomerListsDeltaExport.md +30 -0
- package/data/job-steps/DownloadActiveDataFromStorage.md +24 -0
- package/data/job-steps/ExecuteCategorizationRules.md +25 -0
- package/data/job-steps/ExecuteDataReplication.md +24 -0
- package/data/job-steps/ExecutePipeline.md +24 -0
- package/data/job-steps/ExecutePreconfiguredCodeReplicationProcess.md +24 -0
- package/data/job-steps/ExecutePreconfiguredDataReplicationProcess.md +24 -0
- package/data/job-steps/ExecuteScriptModule.md +27 -0
- package/data/job-steps/ExportABTests.md +30 -0
- package/data/job-steps/ExportAssignments.md +30 -0
- package/data/job-steps/ExportCatalog.md +37 -0
- package/data/job-steps/ExportContent.md +31 -0
- package/data/job-steps/ExportContentSlots.md +30 -0
- package/data/job-steps/ExportCouponCodes.md +33 -0
- package/data/job-steps/ExportCoupons.md +30 -0
- package/data/job-steps/ExportCustomObjects.md +31 -0
- package/data/job-steps/ExportCustomerGroups.md +30 -0
- package/data/job-steps/ExportCustomerList.md +31 -0
- package/data/job-steps/ExportCustomers.md +30 -0
- package/data/job-steps/ExportFacebookFeed.md +26 -0
- package/data/job-steps/ExportGiftCertificates.md +30 -0
- package/data/job-steps/ExportInventoryLists.md +31 -0
- package/data/job-steps/ExportMetaData.md +32 -0
- package/data/job-steps/ExportOrders.md +42 -0
- package/data/job-steps/ExportPageLocalization.md +34 -0
- package/data/job-steps/ExportPriceBook.md +31 -0
- package/data/job-steps/ExportProductLists.md +34 -0
- package/data/job-steps/ExportPromotions.md +30 -0
- package/data/job-steps/ExportShippingMethods.md +30 -0
- package/data/job-steps/ExportSourceCodeGroups.md +30 -0
- package/data/job-steps/ExportStores.md +31 -0
- package/data/job-steps/ExportTaxTable.md +30 -0
- package/data/job-steps/ImportABTests.md +34 -0
- package/data/job-steps/ImportActiveData.md +33 -0
- package/data/job-steps/ImportAssignments.md +34 -0
- package/data/job-steps/ImportCatalog.md +34 -0
- package/data/job-steps/ImportContent.md +34 -0
- package/data/job-steps/ImportContentSlots.md +34 -0
- package/data/job-steps/ImportCouponCodeRedemptions.md +34 -0
- package/data/job-steps/ImportCoupons.md +34 -0
- package/data/job-steps/ImportCustomObjects.md +34 -0
- package/data/job-steps/ImportCustomerGroups.md +34 -0
- package/data/job-steps/ImportCustomerList.md +34 -0
- package/data/job-steps/ImportCustomerLists.md +34 -0
- package/data/job-steps/ImportCustomers.md +34 -0
- package/data/job-steps/ImportGiftCertificates.md +34 -0
- package/data/job-steps/ImportInventoryLists.md +35 -0
- package/data/job-steps/ImportKeyValueMapping.md +35 -0
- package/data/job-steps/ImportPageLocalization.md +34 -0
- package/data/job-steps/ImportPriceBook.md +34 -0
- package/data/job-steps/ImportProductLists.md +34 -0
- package/data/job-steps/ImportPromotions.md +34 -0
- package/data/job-steps/ImportShippingMethods.md +34 -0
- package/data/job-steps/ImportSiteArchive.md +30 -0
- package/data/job-steps/ImportSourceCodeGroups.md +34 -0
- package/data/job-steps/ImportStores.md +34 -0
- package/data/job-steps/ImportTaxTable.md +34 -0
- package/data/job-steps/IncludeStepsFromJob.md +24 -0
- package/data/job-steps/InvalidateCache.md +26 -0
- package/data/job-steps/LibraryDeltaExport.md +30 -0
- package/data/job-steps/SearchReindex.md +27 -0
- package/data/job-steps/SiteExport.md +32 -0
- package/data/job-steps/UndoPreconfiguredCodeReplicationProcess.md +24 -0
- package/data/job-steps/UndoPreconfiguredDataReplicationProcess.md +24 -0
- package/data/job-steps/UpdateStorefrontURLs.md +22 -0
- package/data/job-steps/UploadActiveDataBackupToStorage.md +22 -0
- package/data/job-steps/UploadActiveDataToStorage.md +24 -0
- package/data/job-steps/index.json +426 -0
- package/data/job-steps/job-steps.json +2910 -0
- package/data/job-steps/job-steps.md +96 -0
- package/data/script-api/TopLevel.APIException.md +1 -1
- package/data/script-api/dw.catalog.CatalogMgr.md +8 -2
- package/data/script-api/dw.crypto.Cipher.md +5 -1
- package/data/script-api/dw.customer.Profile.md +45 -0
- package/data/script-api/dw.customer.consent.ConsentStatusEntry.md +92 -0
- package/data/script-api/dw.customer.consent.MarketingConsentSubscription.md +247 -0
- package/data/script-api/dw.customer.consent.ShopperConsentErrorCodes.md +74 -0
- package/data/script-api/dw.customer.consent.ShopperConsentException.md +63 -0
- package/data/script-api/dw.customer.consent.ShopperConsentMgr.md +152 -0
- package/data/script-api/dw.customer.consent.md +10 -0
- package/data/script-api/dw.extensions.payments.SalesforcePaymentsHooks.md +24 -0
- package/data/script-api/dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md +76 -0
- package/data/script-api/dw.object.CustomAttributes.md +72 -29
- package/data/script-api/dw.object.md +1 -1
- package/data/script-api/dw.order.Basket.md +3 -2
- package/data/script-api/dw.order.GiftCertificateLineItem.md +1 -1
- package/data/script-api/dw.order.LineItem.md +88 -0
- package/data/script-api/dw.order.LineItemCtnr.md +41 -11
- package/data/script-api/dw.order.LineItemTax.md +142 -0
- package/data/script-api/dw.order.OrderMgr.md +8 -0
- package/data/script-api/dw.order.PriceAdjustment.md +1 -1
- package/data/script-api/dw.order.ProductLineItem.md +1 -1
- package/data/script-api/dw.order.ProductShippingLineItem.md +1 -1
- package/data/script-api/dw.order.Shipment.md +12 -4
- package/data/script-api/dw.order.ShippingLineItem.md +1 -1
- package/data/script-api/dw.order.TaxMgr.md +54 -0
- package/data/script-api/dw.order.hooks.TaxHooks.md +495 -0
- package/data/script-api/dw.order.hooks.md +1 -0
- package/data/script-api/dw.order.md +1 -0
- package/data/script-api/dw.sitemap.SitemapFile.md +1 -1
- package/data/script-api/dw.sitemap.SitemapMgr.md +23 -0
- package/data/script-api/dw.system.Request.md +0 -1
- package/data/script-api/dw.util.Assert.md +29 -0
- package/data/script-api/dw.util.Locale.md +5 -2
- package/data/script-api/dw.web.Cookie.md +0 -6
- package/data/script-api/dw.web.PageMetaTag.md +25 -1
- package/data/script-api/dw.ws.WSUtil.md +2 -2
- package/data/script-api/index.json +49 -2
- package/data/script-api/index.md +2 -1
- package/data/xsd/commercefeaturestate.xsd +1 -0
- package/data/xsd/customer.xsd +11 -0
- package/data/xsd/eventrouting.xsd +257 -0
- package/data/xsd/index.json +6 -2
- package/data/xsd/order.xsd +53 -0
- package/data/xsd/store.xsd +8 -0
- package/data/xsd/storefronts.xsd +57 -1
- package/dist/esm/auth/dispatch-fetch.js +9 -2
- package/dist/esm/auth/dispatch-fetch.js.map +1 -1
- package/dist/esm/auth/oauth-jwt.js +9 -1
- package/dist/esm/auth/oauth-jwt.js.map +1 -1
- package/dist/esm/auth/oauth.js +9 -1
- package/dist/esm/auth/oauth.js.map +1 -1
- package/dist/esm/auth/stateful-oauth-strategy.js +26 -3
- package/dist/esm/auth/stateful-oauth-strategy.js.map +1 -1
- package/dist/esm/clients/am-api.js +9 -1
- package/dist/esm/clients/am-api.js.map +1 -1
- package/dist/esm/clients/middleware.js +9 -1
- package/dist/esm/clients/middleware.js.map +1 -1
- package/dist/esm/clients/webdav.js +14 -6
- package/dist/esm/clients/webdav.js.map +1 -1
- package/dist/esm/docs/search.d.ts +6 -3
- package/dist/esm/docs/search.js +39 -8
- package/dist/esm/docs/search.js.map +1 -1
- package/dist/esm/docs/types.d.ts +1 -0
- package/dist/esm/docs/types.js +1 -0
- package/dist/esm/docs/types.js.map +1 -1
- package/dist/esm/errors/index.d.ts +1 -0
- package/dist/esm/errors/index.js +1 -0
- package/dist/esm/errors/index.js.map +1 -1
- package/dist/esm/errors/network-error.d.ts +104 -0
- package/dist/esm/errors/network-error.js +301 -0
- package/dist/esm/errors/network-error.js.map +1 -0
- package/dist/esm/operations/cap/pull.js +4 -1
- package/dist/esm/operations/cap/pull.js.map +1 -1
- package/dist/esm/operations/code/constants.d.ts +17 -0
- package/dist/esm/operations/code/constants.js +23 -0
- package/dist/esm/operations/code/constants.js.map +1 -0
- package/dist/esm/operations/code/deploy.js +31 -2
- package/dist/esm/operations/code/deploy.js.map +1 -1
- package/dist/esm/operations/code/download.js +1 -2
- package/dist/esm/operations/code/download.js.map +1 -1
- package/dist/esm/operations/debug/dap-adapter.d.ts +9 -0
- package/dist/esm/operations/debug/dap-adapter.js +17 -0
- package/dist/esm/operations/debug/dap-adapter.js.map +1 -1
- package/dist/esm/operations/debug/debug-session.d.ts +8 -0
- package/dist/esm/operations/debug/debug-session.js +18 -0
- package/dist/esm/operations/debug/debug-session.js.map +1 -1
- package/dist/esm/operations/debug/sdapi-client.d.ts +30 -0
- package/dist/esm/operations/debug/sdapi-client.js +80 -6
- package/dist/esm/operations/debug/sdapi-client.js.map +1 -1
- package/dist/esm/skills/github.js +77 -24
- package/dist/esm/skills/github.js.map +1 -1
- package/dist/esm/slas/token.js +9 -1
- package/dist/esm/slas/token.js.map +1 -1
- package/package.json +4 -2
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
<!-- prettier-ignore-start -->
|
|
2
|
+
# Class ShopperConsentException
|
|
3
|
+
|
|
4
|
+
- [TopLevel.Object](TopLevel.Object.md)
|
|
5
|
+
- [dw.customer.consent.ShopperConsentException](dw.customer.consent.ShopperConsentException.md)
|
|
6
|
+
|
|
7
|
+
This exception is thrown by [ShopperConsentMgr](dw.customer.consent.ShopperConsentMgr.md) methods when an error occurs
|
|
8
|
+
during consent subscription operations.
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
The 'errorCode' property is set to one of the following values:
|
|
12
|
+
|
|
13
|
+
- [ShopperConsentErrorCodes.FEATURE_DISABLED](dw.customer.consent.ShopperConsentErrorCodes.md#feature_disabled)- Indicates that the Marketing Consent feature is not enabled.
|
|
14
|
+
- [ShopperConsentErrorCodes.RETRIEVAL_ERROR](dw.customer.consent.ShopperConsentErrorCodes.md#retrieval_error)- Indicates that an error occurred while retrieving consent subscriptions.
|
|
15
|
+
- [ShopperConsentErrorCodes.UPDATE_ERROR](dw.customer.consent.ShopperConsentErrorCodes.md#update_error)- Indicates that an error occurred while updating consent subscriptions.
|
|
16
|
+
- [ShopperConsentErrorCodes.CUSTOMER_NOT_AUTHENTICATED](dw.customer.consent.ShopperConsentErrorCodes.md#customer_not_authenticated)- Indicates that the customer is not authenticated (required for consent status retrieval).
|
|
17
|
+
- [ShopperConsentErrorCodes.INTERNAL_ERROR](dw.customer.consent.ShopperConsentErrorCodes.md#internal_error)- Indicates that an internal error occurred.
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
## Property Summary
|
|
22
|
+
|
|
23
|
+
| Property | Description |
|
|
24
|
+
| --- | --- |
|
|
25
|
+
| [errorCode](#errorcode): [String](TopLevel.String.md) `(read-only)` | Returns the error code indicating the reason for the failure. |
|
|
26
|
+
|
|
27
|
+
## Constructor Summary
|
|
28
|
+
|
|
29
|
+
This class does not have a constructor, so you cannot create it directly.
|
|
30
|
+
## Method Summary
|
|
31
|
+
|
|
32
|
+
| Method | Description |
|
|
33
|
+
| --- | --- |
|
|
34
|
+
| [getErrorCode](dw.customer.consent.ShopperConsentException.md#geterrorcode)() | Returns the error code indicating the reason for the failure. |
|
|
35
|
+
|
|
36
|
+
### Methods inherited from class Error
|
|
37
|
+
|
|
38
|
+
[captureStackTrace](TopLevel.Error.md#capturestacktraceerror-function), [toString](TopLevel.Error.md#tostring)
|
|
39
|
+
### Methods inherited from class Object
|
|
40
|
+
|
|
41
|
+
[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
|
|
42
|
+
## Property Details
|
|
43
|
+
|
|
44
|
+
### errorCode
|
|
45
|
+
- errorCode: [String](TopLevel.String.md) `(read-only)`
|
|
46
|
+
- : Returns the error code indicating the reason for the failure.
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
## Method Details
|
|
52
|
+
|
|
53
|
+
### getErrorCode()
|
|
54
|
+
- getErrorCode(): [String](TopLevel.String.md)
|
|
55
|
+
- : Returns the error code indicating the reason for the failure.
|
|
56
|
+
|
|
57
|
+
**Returns:**
|
|
58
|
+
- The error code.
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
<!-- prettier-ignore-end -->
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
<!-- prettier-ignore-start -->
|
|
2
|
+
# Class ShopperConsentMgr
|
|
3
|
+
|
|
4
|
+
- [TopLevel.Object](TopLevel.Object.md)
|
|
5
|
+
- [dw.customer.consent.ShopperConsentMgr](dw.customer.consent.ShopperConsentMgr.md)
|
|
6
|
+
|
|
7
|
+
Provides static helper methods for managing shopper marketing consent subscriptions.
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
This API enables retrieving and updating marketing consent preferences.
|
|
11
|
+
Consent subscriptions define communication categories (e.g., "Newsletter", "Product Updates")
|
|
12
|
+
and the channels (EMAIL, SMS, WHATSAPP) through which marketing communications can be sent.
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
**Prerequisites:**
|
|
18
|
+
|
|
19
|
+
- The Marketing Consent feature must be enabled and configured
|
|
20
|
+
- For consent status retrieval, the current request must have a customer context
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
**Example usage:**
|
|
27
|
+
|
|
28
|
+
```
|
|
29
|
+
var ShopperConsentMgr = require('dw/customer/consent/ShopperConsentMgr');
|
|
30
|
+
|
|
31
|
+
// Get all subscriptions for the current site
|
|
32
|
+
var subscriptions = ShopperConsentMgr.getSubscriptions();
|
|
33
|
+
|
|
34
|
+
for each (var sub in subscriptions) {
|
|
35
|
+
trace('Subscription: ' + sub.subscriptionId + ' - ' + sub.title);
|
|
36
|
+
trace('Available channels: ' + sub.channels.join(', '));
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
// Get subscriptions with consent status (for authenticated customers)
|
|
40
|
+
var subsWithStatus = ShopperConsentMgr.getSubscriptions(null, true);
|
|
41
|
+
|
|
42
|
+
// Update consent for a specific subscription
|
|
43
|
+
ShopperConsentMgr.updateSubscription(
|
|
44
|
+
'customer@example.com',
|
|
45
|
+
'newsletter-subscription',
|
|
46
|
+
'EMAIL',
|
|
47
|
+
'OPT_IN'
|
|
48
|
+
);
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
**See Also:**
|
|
53
|
+
- [MarketingConsentSubscription](dw.customer.consent.MarketingConsentSubscription.md)
|
|
54
|
+
- [ConsentStatusEntry](dw.customer.consent.ConsentStatusEntry.md)
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
## Property Summary
|
|
58
|
+
|
|
59
|
+
| Property | Description |
|
|
60
|
+
| --- | --- |
|
|
61
|
+
| [subscriptions](#subscriptions): [Collection](dw.util.Collection.md) `(read-only)` | Retrieves marketing consent subscriptions for the current site. |
|
|
62
|
+
|
|
63
|
+
## Constructor Summary
|
|
64
|
+
|
|
65
|
+
This class does not have a constructor, so you cannot create it directly.
|
|
66
|
+
## Method Summary
|
|
67
|
+
|
|
68
|
+
| Method | Description |
|
|
69
|
+
| --- | --- |
|
|
70
|
+
| static [getSubscriptions](dw.customer.consent.ShopperConsentMgr.md#getsubscriptions)() | Retrieves marketing consent subscriptions for the current site. |
|
|
71
|
+
| static [getSubscriptions](dw.customer.consent.ShopperConsentMgr.md#getsubscriptionslist-boolean)([List](dw.util.List.md), [Boolean](TopLevel.Boolean.md)) | Retrieves marketing consent subscriptions for the current site with optional filtering and status. |
|
|
72
|
+
| static [updateSubscription](dw.customer.consent.ShopperConsentMgr.md#updatesubscriptionstring-string-string-string)([String](TopLevel.String.md), [String](TopLevel.String.md), [String](TopLevel.String.md), [String](TopLevel.String.md)) | Updates consent status for a subscription. |
|
|
73
|
+
|
|
74
|
+
### Methods inherited from class Object
|
|
75
|
+
|
|
76
|
+
[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
|
|
77
|
+
## Property Details
|
|
78
|
+
|
|
79
|
+
### subscriptions
|
|
80
|
+
- subscriptions: [Collection](dw.util.Collection.md) `(read-only)`
|
|
81
|
+
- : Retrieves marketing consent subscriptions for the current site.
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
This method returns all available consent subscriptions without consent status information.
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## Method Details
|
|
91
|
+
|
|
92
|
+
### getSubscriptions()
|
|
93
|
+
- static getSubscriptions(): [Collection](dw.util.Collection.md)
|
|
94
|
+
- : Retrieves marketing consent subscriptions for the current site.
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
This method returns all available consent subscriptions without consent status information.
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
**Returns:**
|
|
101
|
+
- A collection of [MarketingConsentSubscription](dw.customer.consent.MarketingConsentSubscription.md) objects.
|
|
102
|
+
|
|
103
|
+
**Throws:**
|
|
104
|
+
- ShopperConsentException - if the consent feature is not enabled or retrieval fails.
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
### getSubscriptions(List, Boolean)
|
|
110
|
+
- static getSubscriptions(tags: [List](dw.util.List.md), includeConsentStatus: [Boolean](TopLevel.Boolean.md)): [Collection](dw.util.Collection.md)
|
|
111
|
+
- : Retrieves marketing consent subscriptions for the current site with optional filtering and status.
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
Use this method to retrieve subscriptions filtered by tags and optionally include
|
|
115
|
+
the current consent status for authenticated customers.
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
**Parameters:**
|
|
119
|
+
- tags - Optional list of tags to filter subscriptions. Pass null for all subscriptions.
|
|
120
|
+
- includeConsentStatus - If true, includes the current consent status for each subscription. Requires a customer context.
|
|
121
|
+
|
|
122
|
+
**Returns:**
|
|
123
|
+
- A collection of [MarketingConsentSubscription](dw.customer.consent.MarketingConsentSubscription.md) objects.
|
|
124
|
+
|
|
125
|
+
**Throws:**
|
|
126
|
+
- ShopperConsentException - if the consent feature is not enabled, retrieval fails, or consent status retrieval fails.
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
---
|
|
130
|
+
|
|
131
|
+
### updateSubscription(String, String, String, String)
|
|
132
|
+
- static updateSubscription(contactPointValue: [String](TopLevel.String.md), subscriptionId: [String](TopLevel.String.md), channel: [String](TopLevel.String.md), status: [String](TopLevel.String.md)): void
|
|
133
|
+
- : Updates consent status for a subscription.
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
This method updates the consent status in Salesforce Core for the specified
|
|
137
|
+
contact point and subscription channel combination.
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
**Parameters:**
|
|
141
|
+
- contactPointValue - The contact point value (email address or phone number).
|
|
142
|
+
- subscriptionId - The subscription ID.
|
|
143
|
+
- channel - The channel type ("EMAIL", "SMS", or "WHATSAPP").
|
|
144
|
+
- status - The consent status ("OPT\_IN" or "OPT\_OUT").
|
|
145
|
+
|
|
146
|
+
**Throws:**
|
|
147
|
+
- ShopperConsentException - if the consent feature is not enabled or update fails.
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
---
|
|
151
|
+
|
|
152
|
+
<!-- prettier-ignore-end -->
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Package dw.customer.consent
|
|
2
|
+
|
|
3
|
+
## Classes
|
|
4
|
+
| Class | Description |
|
|
5
|
+
| --- | --- |
|
|
6
|
+
| [ConsentStatusEntry](dw.customer.consent.ConsentStatusEntry.md) | Represents the consent status for a specific channel and contact point. |
|
|
7
|
+
| [MarketingConsentSubscription](dw.customer.consent.MarketingConsentSubscription.md) | Represents a marketing consent subscription for a shopper. |
|
|
8
|
+
| [ShopperConsentErrorCodes](dw.customer.consent.ShopperConsentErrorCodes.md) | Error codes for [ShopperConsentException](dw.customer.consent.ShopperConsentException.md). |
|
|
9
|
+
| [ShopperConsentException](dw.customer.consent.ShopperConsentException.md) | This exception is thrown by [ShopperConsentMgr](dw.customer.consent.ShopperConsentMgr.md) methods when an error occurs during consent subscription operations. |
|
|
10
|
+
| [ShopperConsentMgr](dw.customer.consent.ShopperConsentMgr.md) | Provides static helper methods for managing shopper marketing consent subscriptions. |
|
|
@@ -35,6 +35,7 @@ inside the hooks property:
|
|
|
35
35
|
"hooks": [
|
|
36
36
|
{"name": "dw.extensions.payments.asyncPaymentSucceeded", "script": "./payments.js"},
|
|
37
37
|
{"name": "dw.extensions.payments.adyenNotification", "script": "./payments.js"},
|
|
38
|
+
{"name": "dw.extensions.payments.adyenFailureNotification", "script": "./payments.js"},
|
|
38
39
|
{"name": "dw.extensions.payments.sendOrderConfirmationEmail", "script": "./emails.js"}
|
|
39
40
|
]
|
|
40
41
|
```
|
|
@@ -54,6 +55,7 @@ A hook entry has a 'name' and a 'script' property.
|
|
|
54
55
|
|
|
55
56
|
| Constant | Description |
|
|
56
57
|
| --- | --- |
|
|
58
|
+
| [extensionPointAdyenFailureNotification](#extensionpointadyenfailurenotification): [String](TopLevel.String.md) = "dw.extensions.payments.adyenFailureNotification" | The extension point name dw.extensions.payments.adyenFailureNotification. |
|
|
57
59
|
| [extensionPointAdyenNotification](#extensionpointadyennotification): [String](TopLevel.String.md) = "dw.extensions.payments.adyenNotification" | The extension point name dw.extensions.payments.adyenNotification. |
|
|
58
60
|
| [extensionPointAsyncPaymentSucceeded](#extensionpointasyncpaymentsucceeded): [String](TopLevel.String.md) = "dw.extensions.payments.asyncPaymentSucceeded" | The extension point name dw.extensions.payments.asyncPaymentSucceeded. |
|
|
59
61
|
| [extensionPointSendOrderConfirmationEmail](#extensionpointsendorderconfirmationemail): [String](TopLevel.String.md) = "dw.extensions.payments.sendOrderConfirmationEmail" | The extension point name dw.extensions.payments.sendOrderConfirmationEmail. |
|
|
@@ -66,6 +68,7 @@ This class does not have a constructor, so you cannot create it directly.
|
|
|
66
68
|
|
|
67
69
|
| Method | Description |
|
|
68
70
|
| --- | --- |
|
|
71
|
+
| [adyenFailureNotification](dw.extensions.payments.SalesforcePaymentsHooks.md#adyenfailurenotificationorder)([Order](dw.order.Order.md)) | Called when an Adyen webhook notification with a failed payment is received for the given order. |
|
|
69
72
|
| [adyenNotification](dw.extensions.payments.SalesforcePaymentsHooks.md#adyennotificationorder)([Order](dw.order.Order.md)) | Called when an Adyen webhook notification is received for the given order. |
|
|
70
73
|
| [asyncPaymentSucceeded](dw.extensions.payments.SalesforcePaymentsHooks.md#asyncpaymentsucceededorder)([Order](dw.order.Order.md)) | Called when asynchronous payment succeeded for the given order. |
|
|
71
74
|
| [sendOrderConfirmationEmail](dw.extensions.payments.SalesforcePaymentsHooks.md#sendorderconfirmationemailorder)([Order](dw.order.Order.md)) | Called to send order confirmation email after successful payment processing. |
|
|
@@ -76,6 +79,14 @@ This class does not have a constructor, so you cannot create it directly.
|
|
|
76
79
|
[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
|
|
77
80
|
## Constant Details
|
|
78
81
|
|
|
82
|
+
### extensionPointAdyenFailureNotification
|
|
83
|
+
|
|
84
|
+
- extensionPointAdyenFailureNotification: [String](TopLevel.String.md) = "dw.extensions.payments.adyenFailureNotification"
|
|
85
|
+
- : The extension point name dw.extensions.payments.adyenFailureNotification.
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
79
90
|
### extensionPointAdyenNotification
|
|
80
91
|
|
|
81
92
|
- extensionPointAdyenNotification: [String](TopLevel.String.md) = "dw.extensions.payments.adyenNotification"
|
|
@@ -110,6 +121,19 @@ This class does not have a constructor, so you cannot create it directly.
|
|
|
110
121
|
|
|
111
122
|
## Method Details
|
|
112
123
|
|
|
124
|
+
### adyenFailureNotification(Order)
|
|
125
|
+
- adyenFailureNotification(order: [Order](dw.order.Order.md)): [Status](dw.system.Status.md)
|
|
126
|
+
- : Called when an Adyen webhook notification with a failed payment is received for the given order.
|
|
127
|
+
|
|
128
|
+
**Parameters:**
|
|
129
|
+
- order - the order for which the failure notification was received
|
|
130
|
+
|
|
131
|
+
**Returns:**
|
|
132
|
+
- a non-null result ends the hook execution, and is ignored
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
---
|
|
136
|
+
|
|
113
137
|
### adyenNotification(Order)
|
|
114
138
|
- adyenNotification(order: [Order](dw.order.Order.md)): [Status](dw.system.Status.md)
|
|
115
139
|
- : Called when an Adyen webhook notification is received for the given order.
|
|
@@ -23,6 +23,10 @@ whether the site is activated with Express Checkout, Multi-Step Checkout or both
|
|
|
23
23
|
| --- | --- |
|
|
24
24
|
| [cardCaptureAutomatic](#cardcaptureautomatic): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if the capture method is set to automatic for credit card Payment Intents created for this site, or false if the capture method is set to manual. |
|
|
25
25
|
| [expressCheckoutEnabled](#expresscheckoutenabled): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if Express Checkout is enabled for the site. |
|
|
26
|
+
| [expressOnCartEnabled](#expressoncartenabled): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if Express Checkout is enabled on the Cart page. |
|
|
27
|
+
| [expressOnCheckoutEnabled](#expressoncheckoutenabled): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if Express Checkout is enabled on the Checkout page. |
|
|
28
|
+
| [expressOnMiniCartEnabled](#expressonminicartenabled): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if Express Checkout is enabled on the Mini-Cart. |
|
|
29
|
+
| [expressOnPdpEnabled](#expressonpdpenabled): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if Express Checkout is enabled on the Product Detail Page. |
|
|
26
30
|
| [futureUsageOffSession](#futureusageoffsession): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if the payment card credential storage is configured to set up all applicable payments for off session reuse, or false if the credential storage is configured to set up for on session reuse only the payments for which the shopper actively confirms use of saved credentials. |
|
|
27
31
|
| [multiStepCheckoutEnabled](#multistepcheckoutenabled): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if Multi-Step Checkout is enabled for the site. |
|
|
28
32
|
|
|
@@ -35,6 +39,10 @@ This class does not have a constructor, so you cannot create it directly.
|
|
|
35
39
|
| --- | --- |
|
|
36
40
|
| [isCardCaptureAutomatic](dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md#iscardcaptureautomatic)() | Returns true if the capture method is set to automatic for credit card Payment Intents created for this site, or false if the capture method is set to manual. |
|
|
37
41
|
| [isExpressCheckoutEnabled](dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md#isexpresscheckoutenabled)() | Returns true if Express Checkout is enabled for the site. |
|
|
42
|
+
| [isExpressOnCartEnabled](dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md#isexpressoncartenabled)() | Returns true if Express Checkout is enabled on the Cart page. |
|
|
43
|
+
| [isExpressOnCheckoutEnabled](dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md#isexpressoncheckoutenabled)() | Returns true if Express Checkout is enabled on the Checkout page. |
|
|
44
|
+
| [isExpressOnMiniCartEnabled](dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md#isexpressonminicartenabled)() | Returns true if Express Checkout is enabled on the Mini-Cart. |
|
|
45
|
+
| [isExpressOnPdpEnabled](dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md#isexpressonpdpenabled)() | Returns true if Express Checkout is enabled on the Product Detail Page. |
|
|
38
46
|
| [isFutureUsageOffSession](dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md#isfutureusageoffsession)() | Returns true if the payment card credential storage is configured to set up all applicable payments for off session reuse, or false if the credential storage is configured to set up for on session reuse only the payments for which the shopper actively confirms use of saved credentials. |
|
|
39
47
|
| [isMultiStepCheckoutEnabled](dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md#ismultistepcheckoutenabled)() | Returns true if Multi-Step Checkout is enabled for the site. |
|
|
40
48
|
|
|
@@ -57,6 +65,34 @@ This class does not have a constructor, so you cannot create it directly.
|
|
|
57
65
|
- : Returns true if Express Checkout is enabled for the site.
|
|
58
66
|
|
|
59
67
|
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
### expressOnCartEnabled
|
|
71
|
+
- expressOnCartEnabled: [Boolean](TopLevel.Boolean.md) `(read-only)`
|
|
72
|
+
- : Returns true if Express Checkout is enabled on the Cart page.
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
### expressOnCheckoutEnabled
|
|
78
|
+
- expressOnCheckoutEnabled: [Boolean](TopLevel.Boolean.md) `(read-only)`
|
|
79
|
+
- : Returns true if Express Checkout is enabled on the Checkout page.
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
### expressOnMiniCartEnabled
|
|
85
|
+
- expressOnMiniCartEnabled: [Boolean](TopLevel.Boolean.md) `(read-only)`
|
|
86
|
+
- : Returns true if Express Checkout is enabled on the Mini-Cart.
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
### expressOnPdpEnabled
|
|
92
|
+
- expressOnPdpEnabled: [Boolean](TopLevel.Boolean.md) `(read-only)`
|
|
93
|
+
- : Returns true if Express Checkout is enabled on the Product Detail Page.
|
|
94
|
+
|
|
95
|
+
|
|
60
96
|
---
|
|
61
97
|
|
|
62
98
|
### futureUsageOffSession
|
|
@@ -98,6 +134,46 @@ This class does not have a constructor, so you cannot create it directly.
|
|
|
98
134
|
- true if Express Checkout is enabled for the site, or false if not
|
|
99
135
|
|
|
100
136
|
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
### isExpressOnCartEnabled()
|
|
140
|
+
- isExpressOnCartEnabled(): [Boolean](TopLevel.Boolean.md)
|
|
141
|
+
- : Returns true if Express Checkout is enabled on the Cart page.
|
|
142
|
+
|
|
143
|
+
**Returns:**
|
|
144
|
+
- true if Express Checkout is enabled on Cart, or false if not
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
---
|
|
148
|
+
|
|
149
|
+
### isExpressOnCheckoutEnabled()
|
|
150
|
+
- isExpressOnCheckoutEnabled(): [Boolean](TopLevel.Boolean.md)
|
|
151
|
+
- : Returns true if Express Checkout is enabled on the Checkout page.
|
|
152
|
+
|
|
153
|
+
**Returns:**
|
|
154
|
+
- true if Express Checkout is enabled on Checkout, or false if not
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
---
|
|
158
|
+
|
|
159
|
+
### isExpressOnMiniCartEnabled()
|
|
160
|
+
- isExpressOnMiniCartEnabled(): [Boolean](TopLevel.Boolean.md)
|
|
161
|
+
- : Returns true if Express Checkout is enabled on the Mini-Cart.
|
|
162
|
+
|
|
163
|
+
**Returns:**
|
|
164
|
+
- true if Express Checkout is enabled on Mini-Cart, or false if not
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
---
|
|
168
|
+
|
|
169
|
+
### isExpressOnPdpEnabled()
|
|
170
|
+
- isExpressOnPdpEnabled(): [Boolean](TopLevel.Boolean.md)
|
|
171
|
+
- : Returns true if Express Checkout is enabled on the Product Detail Page.
|
|
172
|
+
|
|
173
|
+
**Returns:**
|
|
174
|
+
- true if Express Checkout is enabled on PDP, or false if not
|
|
175
|
+
|
|
176
|
+
|
|
101
177
|
---
|
|
102
178
|
|
|
103
179
|
### isFutureUsageOffSession()
|
|
@@ -4,23 +4,16 @@
|
|
|
4
4
|
- [TopLevel.Object](TopLevel.Object.md)
|
|
5
5
|
- [dw.object.CustomAttributes](dw.object.CustomAttributes.md)
|
|
6
6
|
|
|
7
|
-
This class is used together with other classes that contain custom attributes
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
wrong syntax is used to set an individual attribute than an exception will be
|
|
12
|
-
thrown.
|
|
7
|
+
This class is used together with other classes that contain custom attributes and is used to read and write these
|
|
8
|
+
attributes. The actual attributes are accessible as ECMA properties. The syntax for setting and retrieving the value
|
|
9
|
+
of a custom attribute depends upon the type of the attribute. An exception will be thrown, if the wrong syntax is
|
|
10
|
+
used to set an individual attribute.
|
|
13
11
|
|
|
14
12
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
The following script
|
|
18
|
-
|
|
19
|
-
the different types supported by the Commerce Cloud Digital metadata system. The
|
|
20
|
-
following script snippet shows that setting single-valued attributes is
|
|
21
|
-
simply a matter of using the assignment operator and standard ECMA primitives
|
|
22
|
-
and built-in types:
|
|
23
|
-
|
|
13
|
+
The following script examples demonstrate how to work with custom attributes. Suppose we have an ExtensibleObject
|
|
14
|
+
named "eo" possessing attributes of all the different types supported by the Commerce Cloud Digital metadata system.
|
|
15
|
+
The following script snippet shows that setting single-valued attributes is simply a matter of using the assignment
|
|
16
|
+
operator and standard ECMA primitives and built-in types:
|
|
24
17
|
|
|
25
18
|
|
|
26
19
|
|
|
@@ -57,21 +50,73 @@ var date : Date = eo.custom.dtvalue;
|
|
|
57
50
|
|
|
58
51
|
|
|
59
52
|
|
|
53
|
+
**Retrieving multi-value attributes and working with Java-backed arrays**
|
|
60
54
|
|
|
55
|
+
Multi-value attributes return Java-backed arrays, which contain copies of the internal data. In contrast to native
|
|
56
|
+
JavaScript arrays, a Java-backed array behaves differently in the following ways:
|
|
61
57
|
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
attributes and enum-of attributes are handled in a very similar manner. The
|
|
65
|
-
chief difference is that enum-of attributes are limited to a prescribed set
|
|
66
|
-
of value definitions whereas set-of attributes are open-ended. Furthermore,
|
|
67
|
-
each value in an enum-of attribute has a value and a display name which
|
|
68
|
-
affects the retrieval logic.
|
|
58
|
+
- `Array.isArray( javaBackedArray )`will return `false`. If you want to do something based on the value type, use `javaBackedArray instanceof Array`instead.
|
|
59
|
+
- Adding to or removing elements from a Java-backed array is not supported. You need to create a new native JavaScript array based on the Java-backed array, e.g. with `Array.from( javaBackedArray )`and do the modifications there.
|
|
69
60
|
|
|
70
|
-
Multi-value attributes are returned as an array. This array is read-only and
|
|
71
|
-
can't be used to update the multi-value attribute. To update the multi-value
|
|
72
|
-
attribute an array with new values must be assigned to the attribute.
|
|
73
61
|
|
|
74
62
|
|
|
63
|
+
```
|
|
64
|
+
var setofstring : Array = eo.custom.setofstringvalue;
|
|
65
|
+
if( Array.isArray( setofstring ) ) // returns false
|
|
66
|
+
{
|
|
67
|
+
// this will never be reached, since setofstring is a Java-backed array and not a native JavaScript array
|
|
68
|
+
}
|
|
69
|
+
if( setofstring instanceof Array ) // returns true
|
|
70
|
+
{
|
|
71
|
+
// this will be reached, since setofstring is a Java-backed array
|
|
72
|
+
}
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
**Updating multi-value attributes**
|
|
78
|
+
|
|
79
|
+
Retrieved data from a multi-value attribute returns a Java-backed array, which contains a copy of the internal data,
|
|
80
|
+
so changes made to the Java-backed array do not affect the multi-value attribute. To update the multi-value attribute
|
|
81
|
+
(e.g. adding a new element), it needs to be reassigned.
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
```
|
|
85
|
+
// retrieve a Java-backed array and convert it to a native JavaScript array
|
|
86
|
+
var setofstring : Array = eo.custom.setofstringvalue;
|
|
87
|
+
var newValue = Array.from( setofstring );
|
|
88
|
+
|
|
89
|
+
// add new element
|
|
90
|
+
newValue.append( "new element" );
|
|
91
|
+
|
|
92
|
+
// reassign the new array to the multi-value attribute to persist the change
|
|
93
|
+
eo.custom.setofstringvalue = newValue;
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
If you only want to change individual elements without appending or removing elements from the Java-backed array, you
|
|
98
|
+
may even modify it directly.
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
```
|
|
102
|
+
// retrieve a Java-backed array
|
|
103
|
+
var setofstring : Array = eo.custom.setofstringvalue;
|
|
104
|
+
|
|
105
|
+
// change individual element
|
|
106
|
+
setofstring[0] = "updated element";
|
|
107
|
+
|
|
108
|
+
// reassign the array to the multi-value attribute to persist the change
|
|
109
|
+
eo.custom.setofstringvalue = setofstring;
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
**Set-of attributes and enum-of attributes**
|
|
115
|
+
|
|
116
|
+
Set-of attributes and enum-of attributes are handled in a very similar manner. The chief difference is that enum-of
|
|
117
|
+
attributes are limited to a prescribed set of value definitions whereas set-of attributes are open-ended.
|
|
118
|
+
Furthermore, each value in an enum-of attribute has a value and a display name which affects the retrieval logic.
|
|
119
|
+
|
|
75
120
|
|
|
76
121
|
|
|
77
122
|
|
|
@@ -104,10 +149,8 @@ var displayvalue3 : String = enumofintmulti[2].getDisplayValue();
|
|
|
104
149
|
|
|
105
150
|
|
|
106
151
|
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
For further details on the Commerce Cloud Digital attribute system, see the core
|
|
110
|
-
Commerce Cloud Digital documentation.
|
|
152
|
+
For further details on the Commerce Cloud Digital attribute system, see the core Commerce Cloud Digital
|
|
153
|
+
documentation.
|
|
111
154
|
|
|
112
155
|
|
|
113
156
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
| Class | Description |
|
|
5
5
|
| --- | --- |
|
|
6
6
|
| [ActiveData](dw.object.ActiveData.md) | Represents the active data for an object in Commerce Cloud Digital. |
|
|
7
|
-
| [CustomAttributes](dw.object.CustomAttributes.md) | This class is used together with other classes that contain custom attributes
|
|
7
|
+
| [CustomAttributes](dw.object.CustomAttributes.md) | This class is used together with other classes that contain custom attributes and is used to read and write these attributes. |
|
|
8
8
|
| [CustomObject](dw.object.CustomObject.md) | Represents a custom object and its corresponding attributes. |
|
|
9
9
|
| [CustomObjectMgr](dw.object.CustomObjectMgr.md) | Manager class which provides methods for creating, retrieving, deleting, and searching for custom objects. |
|
|
10
10
|
| [Extensible](dw.object.Extensible.md) | Base class alternative to ExtensibleObject for objects customizable through the metadata system. |
|
|
@@ -794,8 +794,9 @@ This class does not have a constructor, so you cannot create it directly.
|
|
|
794
794
|
[LineItemCtnr.CHANNEL_TYPE_INSTAGRAMCOMMERCE](dw.order.LineItemCtnr.md#channel_type_instagramcommerce), [LineItemCtnr.CHANNEL_TYPE_GOOGLE](dw.order.LineItemCtnr.md#channel_type_google),
|
|
795
795
|
[LineItemCtnr.CHANNEL_TYPE_YOUTUBE](dw.order.LineItemCtnr.md#channel_type_youtube), [LineItemCtnr.CHANNEL_TYPE_TIKTOK](dw.order.LineItemCtnr.md#channel_type_tiktok),
|
|
796
796
|
[LineItemCtnr.CHANNEL_TYPE_SNAPCHAT](dw.order.LineItemCtnr.md#channel_type_snapchat), [LineItemCtnr.CHANNEL_TYPE_WHATSAPP](dw.order.LineItemCtnr.md#channel_type_whatsapp) The
|
|
797
|
-
value for [LineItemCtnr.CHANNEL_TYPE_CUSTOMERSERVICECENTER](dw.order.LineItemCtnr.md#channel_type_customerservicecenter)
|
|
798
|
-
|
|
797
|
+
value for [LineItemCtnr.CHANNEL_TYPE_CUSTOMERSERVICECENTER](dw.order.LineItemCtnr.md#channel_type_customerservicecenter) and
|
|
798
|
+
[LineItemCtnr.CHANNEL_TYPE_CHATGPT](dw.order.LineItemCtnr.md#channel_type_chatgpt) and [LineItemCtnr.CHANNEL_TYPE_GEMINI](dw.order.LineItemCtnr.md#channel_type_gemini) are also
|
|
799
|
+
available, but it can not be set by the scripting API, it is set only internally.
|
|
799
800
|
|
|
800
801
|
|
|
801
802
|
**Parameters:**
|
|
@@ -49,7 +49,7 @@ This class does not have a constructor, so you cannot create it directly.
|
|
|
49
49
|
|
|
50
50
|
### Methods inherited from class LineItem
|
|
51
51
|
|
|
52
|
-
[getBasePrice](dw.order.LineItem.md#getbaseprice), [getGrossPrice](dw.order.LineItem.md#getgrossprice), [getLineItemCtnr](dw.order.LineItem.md#getlineitemctnr), [getLineItemText](dw.order.LineItem.md#getlineitemtext), [getNetPrice](dw.order.LineItem.md#getnetprice), [getPrice](dw.order.LineItem.md#getprice), [getPriceValue](dw.order.LineItem.md#getpricevalue), [getTax](dw.order.LineItem.md#gettax), [getTaxBasis](dw.order.LineItem.md#gettaxbasis), [getTaxClassID](dw.order.LineItem.md#gettaxclassid), [getTaxRate](dw.order.LineItem.md#gettaxrate), [setBasePrice](dw.order.LineItem.md#setbasepricemoney), [setGrossPrice](dw.order.LineItem.md#setgrosspricemoney), [setLineItemText](dw.order.LineItem.md#setlineitemtextstring), [setNetPrice](dw.order.LineItem.md#setnetpricemoney), [setPriceValue](dw.order.LineItem.md#setpricevaluenumber), [setTax](dw.order.LineItem.md#settaxmoney), [setTaxClassID](dw.order.LineItem.md#settaxclassidstring), [setTaxRate](dw.order.LineItem.md#settaxratenumber), [updatePrice](dw.order.LineItem.md#updatepricemoney), [updateTax](dw.order.LineItem.md#updatetaxnumber), [updateTax](dw.order.LineItem.md#updatetaxnumber-money), [updateTaxAmount](dw.order.LineItem.md#updatetaxamountmoney)
|
|
52
|
+
[getBasePrice](dw.order.LineItem.md#getbaseprice), [getGrossPrice](dw.order.LineItem.md#getgrossprice), [getLineItemCtnr](dw.order.LineItem.md#getlineitemctnr), [getLineItemText](dw.order.LineItem.md#getlineitemtext), [getNetPrice](dw.order.LineItem.md#getnetprice), [getPrice](dw.order.LineItem.md#getprice), [getPriceValue](dw.order.LineItem.md#getpricevalue), [getTax](dw.order.LineItem.md#gettax), [getTaxBasis](dw.order.LineItem.md#gettaxbasis), [getTaxClassID](dw.order.LineItem.md#gettaxclassid), [getTaxRate](dw.order.LineItem.md#gettaxrate), [getTaxes](dw.order.LineItem.md#gettaxes), [setBasePrice](dw.order.LineItem.md#setbasepricemoney), [setGrossPrice](dw.order.LineItem.md#setgrosspricemoney), [setLineItemText](dw.order.LineItem.md#setlineitemtextstring), [setNetPrice](dw.order.LineItem.md#setnetpricemoney), [setPriceValue](dw.order.LineItem.md#setpricevaluenumber), [setTax](dw.order.LineItem.md#settaxmoney), [setTaxClassID](dw.order.LineItem.md#settaxclassidstring), [setTaxRate](dw.order.LineItem.md#settaxratenumber), [setTaxes](dw.order.LineItem.md#settaxescollection), [updatePrice](dw.order.LineItem.md#updatepricemoney), [updateTax](dw.order.LineItem.md#updatetaxnumber), [updateTax](dw.order.LineItem.md#updatetaxnumber-money), [updateTaxAmount](dw.order.LineItem.md#updatetaxamountmoney)
|
|
53
53
|
### Methods inherited from class ExtensibleObject
|
|
54
54
|
|
|
55
55
|
[describe](dw.object.ExtensibleObject.md#describe), [getCustom](dw.object.ExtensibleObject.md#getcustom)
|