sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_customer/AddressBook.md

@@ -1,163 +0,0 @@
-## Package: dw.customer
-
-# Class AddressBook
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.customer.AddressBook
-
-## Description
-
-Represents a set of addresses associated with a specific customer. The AddressBook object gets its data from the Profile object for the customer. When scripting, this class allows AddressBook to be treated as a separate object from the Profile. However, data is only stored in the platform in the Profile object and there is no separate AddressBook object. For this reason, the AddressBook ID is always the customer profile ID. Note: this class allows access to sensitive personal and private information. Pay attention to appropriate legal and regulatory requirements when developing.
-
-## Properties
-
-### addresses
-
-**Type:** List (Read Only)
-
-A sorted list of addresses in the address book.  The addresses
- are sorted so that the preferred address is always sorted first.  The
- remaining addresses are sorted alphabetically by ID.
-
-### preferredAddress
-
-**Type:** CustomerAddress
-
-The address that has been defined as the customer's preferred
- address.
-
-## Constructor Summary
-
-## Method Summary
-
-### createAddress
-
-**Signature:** `createAddress(name : String) : CustomerAddress`
-
-Creates a new, empty address object with the specified name.
-
-### getAddress
-
-**Signature:** `getAddress(id : String) : CustomerAddress`
-
-Returns the address with the given name from the address book.
-
-### getAddresses
-
-**Signature:** `getAddresses() : List`
-
-Returns a sorted list of addresses in the address book.
-
-### getPreferredAddress
-
-**Signature:** `getPreferredAddress() : CustomerAddress`
-
-Returns the address that has been defined as the customer's preferred address.
-
-### removeAddress
-
-**Signature:** `removeAddress(address : CustomerAddress) : void`
-
-Removes the specified address from the address book.
-
-### setPreferredAddress
-
-**Signature:** `setPreferredAddress(anAddress : CustomerAddress) : void`
-
-Sets the specified address as the customer's preferred address.
-
-## Method Detail
-
-## Method Details
-
-### createAddress
-
-**Signature:** `createAddress(name : String) : CustomerAddress`
-
-**Description:** Creates a new, empty address object with the specified name.
-
-**Parameters:**
-
-- `name`: the ID of the address to create, must not be null.
-
-**Returns:**
-
-the new address object or null if an address with the given name already exists in the address book.
-
-**Throws:**
-
-NullArgumentException - If passed 'name' is null.
-IllegalArgumentException - If passed 'name' is not null, but an empty string.
-
----
-
-### getAddress
-
-**Signature:** `getAddress(id : String) : CustomerAddress`
-
-**Description:** Returns the address with the given name from the address book. The name is a unique identifier of the address within the address book.
-
-**Parameters:**
-
-- `id`: An address ID, must not be null.
-
-**Returns:**
-
-The Address object or null if the address does not exist.
-
-**Throws:**
-
-NullArgumentException - If passed 'id' is null.
-IllegalArgumentException - If passed 'id' is not null, but an empty string.
-
----
-
-### getAddresses
-
-**Signature:** `getAddresses() : List`
-
-**Description:** Returns a sorted list of addresses in the address book. The addresses are sorted so that the preferred address is always sorted first. The remaining addresses are sorted alphabetically by ID.
-
-**Returns:**
-
-Sorted List of customer addresses in the address book.
-
----
-
-### getPreferredAddress
-
-**Signature:** `getPreferredAddress() : CustomerAddress`
-
-**Description:** Returns the address that has been defined as the customer's preferred address.
-
-**Returns:**
-
-the default CustomerAddress object, or null if there is no preferred address.
-
----
-
-### removeAddress
-
-**Signature:** `removeAddress(address : CustomerAddress) : void`
-
-**Description:** Removes the specified address from the address book. Because an address can be associated with a product list, you may want to verify if the address is being used by a product list. See ProductListMgr.findAddress().
-
-**Parameters:**
-
-- `address`: the address to remove, must not be null.
-
----
-
-### setPreferredAddress
-
-**Signature:** `setPreferredAddress(anAddress : CustomerAddress) : void`
-
-**Description:** Sets the specified address as the customer's preferred address. If null is passed, and there is an existing preferred address, then the address book will have no preferred address.
-
-**Parameters:**
-
-- `anAddress`: the address to be set as preferred, or null if the goal is to unset the existing preferred address.
-
----

package/docs/dw_customer/AgentUserMgr.md

@@ -1,83 +0,0 @@
-## Package: dw.customer
-
-# Class AgentUserMgr
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.customer.AgentUserMgr
-
-## Description
-
-Provides helper methods for handling agent user functionality (login and logout) Pay attention to appropriate legal and regulatory requirements related to this functionality.
-
-## Constructor Summary
-
-## Method Summary
-
-### loginAgentUser
-
-**Signature:** `static loginAgentUser(login : String, password : String) : Status`
-
-Logs in an agent user (which for example is authorized to login on-behalf of a customer for instance to place an order).
-
-### loginOnBehalfOfCustomer
-
-**Signature:** `static loginOnBehalfOfCustomer(customer : Customer) : Status`
-
-This method logs the specified customer into the current session if the current agent user has the functional permission 'Login_On_Behalf' in the current site.
-
-### logoutAgentUser
-
-**Signature:** `static logoutAgentUser() : Status`
-
-Performs a logout of the agent user and the current customer which are attached to the current session.
-
-## Method Detail
-
-## Method Details
-
-### loginAgentUser
-
-**Signature:** `static loginAgentUser(login : String, password : String) : Status`
-
-**Description:** Logs in an agent user (which for example is authorized to login on-behalf of a customer for instance to place an order). The login is only allowed during a secure protocol request (https) and only in the storefront context. The user must have the permission 'Login_Agent'. When the login is successful, a new session will be created. Any objects that need to be preserved in the session need to bet set on the session afterwards. A Status object is returned which signals whether the login was successful or not. In case of a login failure the status object contains the reason for this. See AgentUserStatusCodes for more information.
-
-**Parameters:**
-
-- `login`: the login name for the agent user.
-- `password`: the password for the agent user.
-
-**Returns:**
-
-the login status (OK if successful, error code otherwise).
-
----
-
-### loginOnBehalfOfCustomer
-
-**Signature:** `static loginOnBehalfOfCustomer(customer : Customer) : Status`
-
-**Description:** This method logs the specified customer into the current session if the current agent user has the functional permission 'Login_On_Behalf' in the current site. The dwcustomer cookie will not be set. The login is only allowed during a secure protocol request (https). A Status object is returned indicating whether the login was successful or not (and indicating the failure reason). See AgentUserStatusCodes for more information. Error conditions include: if the method is not called in the storefront context if the given customer is not a registered customer (anonymous) if the given customer is not registered for the current site if the given customer is disabled if there is no agent user at the current session if the agent user is not logged in if the agent user has not the functional permission 'Login_On_Behalf'
-
-**Parameters:**
-
-- `customer`: The customer, which should be logged instead of the agent user
-
-**Returns:**
-
-the login status (OK if successful, error code otherwise).
-
----
-
-### logoutAgentUser
-
-**Signature:** `static logoutAgentUser() : Status`
-
-**Description:** Performs a logout of the agent user and the current customer which are attached to the current session. The logout is only allowed during a secure protocol request (https) and only in the storefront context.
-
-**Returns:**
-
-the logout status (OK if successful, error code otherwise).
-
----

package/docs/dw_customer/AgentUserStatusCodes.md

@@ -1,96 +0,0 @@
-## Package: dw.customer
-
-# Class AgentUserStatusCodes
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.customer.AgentUserStatusCodes
-
-## Description
-
-AgentUserStatusCodes contains constants representing status codes that can be used with a Status object to indicate the success or failure of the agent user login process.
-
-## Constants
-
-### AGENT_USER_NOT_AVAILABLE
-
-**Type:** String = "AGENT_USER_NOT_AVAILABLE"
-
-Indicates that the agent user is not available.
-
-### AGENT_USER_NOT_LOGGED_IN
-
-**Type:** String = "AGENT_USER_NOT_LOGGED_IN"
-
-Indicates that the agent user is not logged in.
-
-### CREDENTIALS_INVALID
-
-**Type:** String = "CREDENTIALS_INVALID"
-
-Indicates that the given agent user login or password was wrong.
-
-### CUSTOMER_DISABLED
-
-**Type:** String = "CUSTOMER_DISABLED"
-
-Indicates that the customer is disabled.
-
-### CUSTOMER_UNREGISTERED
-
-**Type:** String = "CUSTOMER_UNREGISTERED"
-
-Indicates that the customer is either not registered or not registered with the current site.
-
-### INSECURE_CONNECTION
-
-**Type:** String = "INSECURE_CONNECTION"
-
-Indicates that the current connection is not secure (HTTP instead of HTTPS) and the server is configured to require a secure connection.
-
-### INSUFFICIENT_PERMISSION
-
-**Type:** String = "INSUFFICIENT_PERMISSION"
-
-Indicates that the given agent user does not have the permission 'Login_Agent' which is required to login to the storefront as an agent user.
-
-### LOGIN_SUCCESSFUL
-
-**Type:** String = "LOGIN_SUCCESSFUL"
-
-Indicates that the agent user login was successful.
-
-### NO_STOREFRONT
-
-**Type:** String = "NO_STOREFRONT"
-
-Indicates that the current context is not a storefront request.
-
-### PASSWORD_EXPIRED
-
-**Type:** String = "PASSWORD_EXPIRED"
-
-Indicates that the given agent user password has expired and needs to be changed in the Business Manager.
-
-### USER_DISABLED
-
-**Type:** String = "USER_DISABLED"
-
-Indicates that the agent user account has been disabled in the Business Manager.
-
-### USER_LOCKED
-
-**Type:** String = "USER_LOCKED"
-
-Indicates that the agent user account is locked, because the maximum number of failed login attempts was exceeded.
-
-## Properties
-
-## Constructor Summary
-
-AgentUserStatusCodes()
-
-## Method Summary
-
-## Constructor Detail

package/docs/dw_customer/AuthenticationStatus.md

@@ -1,138 +0,0 @@
-## Package: dw.customer
-
-# Class AuthenticationStatus
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.customer.AuthenticationStatus
-
-## Description
-
-Holds the status of an authentication process.
-
-## Constants
-
-### AUTH_OK
-
-**Type:** String = "AUTH_OK"
-
-Authentication was successful
-
-### ERROR_CUSTOMER_DISABLED
-
-**Type:** String = "ERROR_CUSTOMER_DISABLED"
-
-customer could be found, but is disabled. Password was not verified.
-
-### ERROR_CUSTOMER_LOCKED
-
-**Type:** String = "ERROR_CUSTOMER_LOCKED"
-
-customer could be found, but is locked (too many failed login attempts). Password was verified before.
-
-### ERROR_CUSTOMER_NOT_FOUND
-
-**Type:** String = "ERROR_CUSTOMER_NOT_FOUND"
-
-customer could not be found
-
-### ERROR_PASSWORD_EXPIRED
-
-**Type:** String = "ERROR_PASSWORD_EXPIRED"
-
-Password does match, but is expired.
-
-### ERROR_PASSWORD_MISMATCH
-
-**Type:** String = "ERROR_PASSWORD_MISMATCH"
-
-the used password is not correct
-
-### ERROR_UNKNOWN
-
-**Type:** String = "ERROR_UNKNOWN"
-
-Any other error
-
-## Properties
-
-### authenticated
-
-**Type:** boolean (Read Only)
-
-checks whether the authentication was successful or not
-
-### customer
-
-**Type:** Customer (Read Only)
-
-The customer, corresponding to the login used during authentication. This customer is not logged in after authentication.
-
-### status
-
-**Type:** String (Read Only)
-
-the status code (see the constants above)
-
-## Constructor Summary
-
-## Method Summary
-
-### getCustomer
-
-**Signature:** `getCustomer() : Customer`
-
-The customer, corresponding to the login used during authentication.
-
-### getStatus
-
-**Signature:** `getStatus() : String`
-
-the status code (see the constants above)
-
-### isAuthenticated
-
-**Signature:** `isAuthenticated() : boolean`
-
-checks whether the authentication was successful or not
-
-## Method Detail
-
-## Method Details
-
-### getCustomer
-
-**Signature:** `getCustomer() : Customer`
-
-**Description:** The customer, corresponding to the login used during authentication. This customer is not logged in after authentication.
-
-**Returns:**
-
-the customer described by the login
-
----
-
-### getStatus
-
-**Signature:** `getStatus() : String`
-
-**Description:** the status code (see the constants above)
-
-**Returns:**
-
-the status code
-
----
-
-### isAuthenticated
-
-**Signature:** `isAuthenticated() : boolean`
-
-**Description:** checks whether the authentication was successful or not
-
-**Returns:**
-
-the when the authentication was successful
-
----