sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_customer/CustomerPasswordConstraints.md

@@ -1,142 +0,0 @@
-## Package: dw.customer
-
-# Class CustomerPasswordConstraints
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.customer.CustomerPasswordConstraints
-
-## Description
-
-Provides access to the constraints of customer passwords. An instance of this class can be obtained via CustomerMgr.getPasswordConstraints().
-
-## Properties
-
-### forceLetters
-
-**Type:** boolean (Read Only)
-
-Returns true if letters are enforced.
-
-### forceMixedCase
-
-**Type:** boolean (Read Only)
-
-Returns true if mixed case is enforced.
-
-### forceNumbers
-
-**Type:** boolean (Read Only)
-
-Returns true if numbers are enforced.
-
-### minLength
-
-**Type:** Number (Read Only)
-
-The minimum length.
-
-### minSpecialChars
-
-**Type:** Number (Read Only)
-
-The minimum number of special characters.
-
-## Constructor Summary
-
-## Method Summary
-
-### getMinLength
-
-**Signature:** `static getMinLength() : Number`
-
-Returns the minimum length.
-
-### getMinSpecialChars
-
-**Signature:** `static getMinSpecialChars() : Number`
-
-Returns the minimum number of special characters.
-
-### isForceLetters
-
-**Signature:** `static isForceLetters() : boolean`
-
-Returns true if letters are enforced.
-
-### isForceMixedCase
-
-**Signature:** `static isForceMixedCase() : boolean`
-
-Returns true if mixed case is enforced.
-
-### isForceNumbers
-
-**Signature:** `static isForceNumbers() : boolean`
-
-Returns true if numbers are enforced.
-
-## Method Detail
-
-## Method Details
-
-### getMinLength
-
-**Signature:** `static getMinLength() : Number`
-
-**Description:** Returns the minimum length.
-
-**Returns:**
-
-the minimum length
-
----
-
-### getMinSpecialChars
-
-**Signature:** `static getMinSpecialChars() : Number`
-
-**Description:** Returns the minimum number of special characters.
-
-**Returns:**
-
-the minimum number of special characters
-
----
-
-### isForceLetters
-
-**Signature:** `static isForceLetters() : boolean`
-
-**Description:** Returns true if letters are enforced.
-
-**Returns:**
-
-if letters are enforced
-
----
-
-### isForceMixedCase
-
-**Signature:** `static isForceMixedCase() : boolean`
-
-**Description:** Returns true if mixed case is enforced.
-
-**Returns:**
-
-if mixed case is enforced
-
----
-
-### isForceNumbers
-
-**Signature:** `static isForceNumbers() : boolean`
-
-**Description:** Returns true if numbers are enforced.
-
-**Returns:**
-
-if numbers are enforced
-
----

package/docs/dw_customer/CustomerPaymentInstrument.md

@@ -1,125 +0,0 @@
-## Package: dw.customer
-
-# Class CustomerPaymentInstrument
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.PersistentObject
-  - dw.object.ExtensibleObject
-    - dw.customer.EncryptedObject
-      - dw.order.PaymentInstrument
-      - dw.customer.CustomerPaymentInstrument
-
-## Description
-
-Represents any payment instrument stored in the customers profile, such as credit card or bank transfer. The object defines standard methods for credit card payment, and can be extended by attributes appropriate for other payment methods.
-
-## Properties
-
-### bankAccountDriversLicense
-
-**Type:** String (Read Only)
-
-The driver's license number of the bank account number
- if the calling context meets the following criteria: 
- 
- 
- If the method call happens in the context of a storefront request and
- the current customer is registered and authenticated, and the payment
- instrument is associated to the profile of the current customer, and
- the current protocol is HTTPS
- 
- 
- Otherwise, the method returns the masked driver's license number of the bank account.
- 
- Note: this method handles sensitive financial and card holder data.
- Pay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.
-
-### bankAccountNumber
-
-**Type:** String (Read Only)
-
-The bank account number if the calling context meets
- the following criteria: 
- 
- 
- If the method call happens in the context of a storefront request,
- the current customer is registered and authenticated, the payment
- instrument is associated to the profile of the current customer, and
- the current protocol is HTTPS
- 
- 
- Otherwise, the method returns the masked bank account number.
- 
- Note: this method handles sensitive financial and card holder data.
- Pay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.
-
-### creditCardNumber
-
-**Type:** String (Read Only)
-
-The decrypted credit card number if the calling context meets
- the following criteria: 
- 
- 
- If the method call happens in the context of a storefront request,
- the current customer is registered and authenticated, the payment
- instrument is associated to the profile of the current customer, and
- the current protocol is HTTPS.
- 
- 
- Otherwise, the method returns the masked credit card number.
- 
- Note: this method handles sensitive financial and card holder data.
- Pay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.
-
-## Constructor Summary
-
-## Method Summary
-
-### getBankAccountDriversLicense
-
-**Signature:** `getBankAccountDriversLicense() : String`
-
-Returns the driver's license number of the bank account number if the calling context meets the following criteria: If the method call happens in the context of a storefront request and the current customer is registered and authenticated, and the payment instrument is associated to the profile of the current customer, and the current protocol is HTTPS Otherwise, the method returns the masked driver's license number of the bank account.
-
-### getBankAccountNumber
-
-**Signature:** `getBankAccountNumber() : String`
-
-Returns the bank account number if the calling context meets the following criteria: If the method call happens in the context of a storefront request, the current customer is registered and authenticated, the payment instrument is associated to the profile of the current customer, and the current protocol is HTTPS Otherwise, the method returns the masked bank account number.
-
-### getCreditCardNumber
-
-**Signature:** `getCreditCardNumber() : String`
-
-Returns the decrypted credit card number if the calling context meets the following criteria: If the method call happens in the context of a storefront request, the current customer is registered and authenticated, the payment instrument is associated to the profile of the current customer, and the current protocol is HTTPS.
-
-## Method Detail
-
-## Method Details
-
-### getBankAccountDriversLicense
-
-**Signature:** `getBankAccountDriversLicense() : String`
-
-**Description:** Returns the driver's license number of the bank account number if the calling context meets the following criteria: If the method call happens in the context of a storefront request and the current customer is registered and authenticated, and the payment instrument is associated to the profile of the current customer, and the current protocol is HTTPS Otherwise, the method returns the masked driver's license number of the bank account. Note: this method handles sensitive financial and card holder data. Pay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.
-
----
-
-### getBankAccountNumber
-
-**Signature:** `getBankAccountNumber() : String`
-
-**Description:** Returns the bank account number if the calling context meets the following criteria: If the method call happens in the context of a storefront request, the current customer is registered and authenticated, the payment instrument is associated to the profile of the current customer, and the current protocol is HTTPS Otherwise, the method returns the masked bank account number. Note: this method handles sensitive financial and card holder data. Pay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.
-
----
-
-### getCreditCardNumber
-
-**Signature:** `getCreditCardNumber() : String`
-
-**Description:** Returns the decrypted credit card number if the calling context meets the following criteria: If the method call happens in the context of a storefront request, the current customer is registered and authenticated, the payment instrument is associated to the profile of the current customer, and the current protocol is HTTPS. Otherwise, the method returns the masked credit card number. Note: this method handles sensitive financial and card holder data. Pay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.
-
----

package/docs/dw_customer/CustomerStatusCodes.md

@@ -1,30 +0,0 @@
-## Package: dw.customer
-
-# Class CustomerStatusCodes
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.customer.CustomerStatusCodes
-
-## Description
-
-CustomerStatusCodes contains constants representing status codes that can be used with a Status object to indicate the success or failure of an operation.
-
-## Constants
-
-### CUSTOMER_ADDRESS_REFERENCED_BY_PRODUCT_LIST
-
-**Type:** String = "CUSTOMER_ADDRESS_REFERENCED_BY_PRODUCT_LIST"
-
-Indicates that an error occurred when trying to perform an operation on an address that is currently associated with a product list.
-
-## Properties
-
-## Constructor Summary
-
-CustomerStatusCodes()
-
-## Method Summary
-
-## Constructor Detail

package/docs/dw_customer/EncryptedObject.md

@@ -1,18 +0,0 @@
-## Package: dw.customer
-
-# Class EncryptedObject
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.PersistentObject
-  - dw.object.ExtensibleObject
-    - dw.customer.EncryptedObject
-
-## Description
-
-Defines a API base class for classes containing encrypted attributes like credit cards. Note: this method handles sensitive financial and card holder data. Pay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.
-
-## Constructor Summary
-
-## Method Summary

package/docs/dw_customer/ExternalProfile.md

@@ -1,160 +0,0 @@
-## Package: dw.customer
-
-# Class ExternalProfile
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.customer.ExternalProfile
-
-## Description
-
-Represents the credentials of a customer. Since 13.6 it is possible to have customers who are not authenticated through a login and password but through an external authentication provider via the OAuth2 protocol. In such cases, the AuthenticationProviderID will point to an OAuth provider configured in the system and the ExternalID will be the unique identifier of the customer on the Authentication Provider's system. For example, if an authentication provider with ID "Google123" is configured pointing to Google and the customer has a logged in into Google in the past and has created a profile there, Google assigns a unique number identifier to that customer. If the storefront is configured to allow authentication through Google and a new customer logs into the storefront using Google, the AuthenticationProviderID property of his Credentials will contain "Google123" and the ExternalID property will contain whatever unique identifier Google has assigned to him. Note: this class handles sensitive security-related data. Pay special attention to PCI DSS v3. requirements 2, 4, and 12.
-
-## Properties
-
-### authenticationProviderID
-
-**Type:** String (Read Only)
-
-The authentication provider ID.
-
-### customer
-
-**Type:** Customer (Read Only)
-
-The customer object related to this profile.
-
-### email
-
-**Type:** String
-
-The customer's email address.
-
-### externalID
-
-**Type:** String (Read Only)
-
-The external ID.
-
-### lastLoginTime
-
-**Type:** Date (Read Only)
-
-The last login time of the customer through the external provider
-
-## Constructor Summary
-
-## Method Summary
-
-### getAuthenticationProviderID
-
-**Signature:** `getAuthenticationProviderID() : String`
-
-Returns the authentication provider ID.
-
-### getCustomer
-
-**Signature:** `getCustomer() : Customer`
-
-Returns the customer object related to this profile.
-
-### getEmail
-
-**Signature:** `getEmail() : String`
-
-Returns the customer's email address.
-
-### getExternalID
-
-**Signature:** `getExternalID() : String`
-
-Returns the external ID.
-
-### getLastLoginTime
-
-**Signature:** `getLastLoginTime() : Date`
-
-Returns the last login time of the customer through the external provider
-
-### setEmail
-
-**Signature:** `setEmail(email : String) : void`
-
-Sets the customer's email address.
-
-## Method Detail
-
-## Method Details
-
-### getAuthenticationProviderID
-
-**Signature:** `getAuthenticationProviderID() : String`
-
-**Description:** Returns the authentication provider ID.
-
-**Returns:**
-
-the authentication provider ID.
-
----
-
-### getCustomer
-
-**Signature:** `getCustomer() : Customer`
-
-**Description:** Returns the customer object related to this profile.
-
-**Returns:**
-
-customer object related to profile.
-
----
-
-### getEmail
-
-**Signature:** `getEmail() : String`
-
-**Description:** Returns the customer's email address.
-
-**Returns:**
-
-the customer's email address.
-
----
-
-### getExternalID
-
-**Signature:** `getExternalID() : String`
-
-**Description:** Returns the external ID.
-
-**Returns:**
-
-the external ID.
-
----
-
-### getLastLoginTime
-
-**Signature:** `getLastLoginTime() : Date`
-
-**Description:** Returns the last login time of the customer through the external provider
-
-**Returns:**
-
-the time, when the customer was last logged in through this external provider
-
----
-
-### setEmail
-
-**Signature:** `setEmail(email : String) : void`
-
-**Description:** Sets the customer's email address.
-
-**Parameters:**
-
-- `email`: the customer's email address.
-
----

package/docs/dw_customer/OrderHistory.md

@@ -1,111 +0,0 @@
-## Package: dw.customer
-
-# Class OrderHistory
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.customer.OrderHistory
-
-## Description
-
-The class provides access to past orders of the customer. Note: This class allows access to sensitive financial and cardholder data. Pay special attention to PCI DSS v3. requirements 1, 3, 7, and 9. It also allows access to sensitive personal and private information. Pay attention to appropriate legal and regulatory requirements related to this data. Note: The following methods do not work with Salesforce Order Management orders.
-
-## Properties
-
-### orderCount
-
-**Type:** Number (Read Only)
-
-The number of orders the customer has placed in the store.
- 
- If the customer is anonymous, this method always returns zero. If an active data record is available for this
- customer, the orders count is retrieved from that record, otherwise a real-time query is used to get the count.
-
-### orders
-
-**Type:** SeekableIterator (Read Only)
-
-Retrieves the order history for the customer in the current storefront site.
- 
- If the result exceeds 1000 orders, only the first 1000 orders are retrieved. Same as
-
-  orderHistory.getOrders( null, "creationDate DESC" )
- 
- 
- 
- It is strongly recommended to call SeekableIterator.close() on the returned
- SeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system
- resources.
-
-## Constructor Summary
-
-## Method Summary
-
-### getOrderCount
-
-**Signature:** `getOrderCount() : Number`
-
-Returns the number of orders the customer has placed in the store.
-
-### getOrders
-
-**Signature:** `getOrders() : SeekableIterator`
-
-Retrieves the order history for the customer in the current storefront site.
-
-### getOrders
-
-**Signature:** `getOrders(query : String, sortString : String, params : Object...) : SeekableIterator`
-
-Retrieves the order history for the customer in the current storefront site.
-
-## Method Detail
-
-## Method Details
-
-### getOrderCount
-
-**Signature:** `getOrderCount() : Number`
-
-**Description:** Returns the number of orders the customer has placed in the store. If the customer is anonymous, this method always returns zero. If an active data record is available for this customer, the orders count is retrieved from that record, otherwise a real-time query is used to get the count.
-
-**Returns:**
-
-the number of orders the customer has placed in the store.
-
----
-
-### getOrders
-
-**Signature:** `getOrders() : SeekableIterator`
-
-**Description:** Retrieves the order history for the customer in the current storefront site. If the result exceeds 1000 orders, only the first 1000 orders are retrieved. Same as orderHistory.getOrders( null, "creationDate DESC" ) It is strongly recommended to call SeekableIterator.close() on the returned SeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.
-
-**Returns:**
-
-the orders
-
-**See Also:**
-
-getOrders(String, String, Object...)
-
----
-
-### getOrders
-
-**Signature:** `getOrders(query : String, sortString : String, params : Object...) : SeekableIterator`
-
-**Description:** Retrieves the order history for the customer in the current storefront site. If the result exceeds 1000 orders, only the first 1000 orders are retrieved. Optionally, you can retrieve a subset of the orders by specifying a query. At maximum 3 expressions are allowed to be specified and no custom attribute expressions are allowed. It is strongly recommended to call SeekableIterator.close() on the returned SeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system resources. Example: var orderHistory : dw.customer.OrderHistory = customer.getOrderHistory(); var orders = orderHistory.getOrders("status = {0}", "creationDate DESC", dw.order.Order.ORDER_STATUS_NEW); for each (var order : dw.order.Order in orders) { // ... process orders } orders.close();
-
-**Parameters:**
-
-- `query`: optional query
-- `sortString`: optional sort string
-- `params`: optional parameters for the query
-
-**Returns:**
-
-the orders
-
----