npm - @salesforce/b2c-cli - Versions diffs - 0.0.7 → 0.1.0 - Mend

@salesforce/b2c-cli 0.0.7 → 0.1.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.

Files changed (1115) hide show

package/node_modules/@salesforce/b2c-tooling-sdk/data/script-api/dw.crypto.X509Certificate.md DELETED Viewed

@@ -1,180 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class X509Certificate
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.crypto.CertificateRef](dw.crypto.CertificateRef.md)
-    - [dw.crypto.X509Certificate](dw.crypto.X509Certificate.md)
-Represents an X.509 public key certificate as defined in RFC 5280.
-It provides access to the standard fields of an X.509 certificate including version, serial number, validity period,
-distinguished names, and signature algorithm.
-## Property Summary
-| Property | Description |
-| --- | --- |
-| [issuerDN](#issuerdn): [String](TopLevel.String.md) `(read-only)` | Returns the X.500 distinguished name of the entity that signed this certificate. |
-| [notAfter](#notafter): [Date](TopLevel.Date.md) `(read-only)` | Returns the end date of the certificate validity period. |
-| [notBefore](#notbefore): [Date](TopLevel.Date.md) `(read-only)` | Returns the start date of the certificate validity period. |
-| [serialNumber](#serialnumber): [String](TopLevel.String.md) `(read-only)` | Returns the certificate serial number in string format. |
-| [sigAlgName](#sigalgname): [String](TopLevel.String.md) `(read-only)` | Returns the algorithm used to sign this certificate. |
-| [subjectDN](#subjectdn): [String](TopLevel.String.md) `(read-only)` | Returns the X.500 distinguished name of the entity this certificate belongs to. |
-| [version](#version): [Number](TopLevel.Number.md) `(read-only)` | Returns the X.509 certificate version number. |
-## Constructor Summary
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-| Method | Description |
-| --- | --- |
-| [getIssuerDN](dw.crypto.X509Certificate.md#getissuerdn)() | Returns the X.500 distinguished name of the entity that signed this certificate. |
-| [getNotAfter](dw.crypto.X509Certificate.md#getnotafter)() | Returns the end date of the certificate validity period. |
-| [getNotBefore](dw.crypto.X509Certificate.md#getnotbefore)() | Returns the start date of the certificate validity period. |
-| [getSerialNumber](dw.crypto.X509Certificate.md#getserialnumber)() | Returns the certificate serial number in string format. |
-| [getSigAlgName](dw.crypto.X509Certificate.md#getsigalgname)() | Returns the algorithm used to sign this certificate. |
-| [getSubjectDN](dw.crypto.X509Certificate.md#getsubjectdn)() | Returns the X.500 distinguished name of the entity this certificate belongs to. |
-| [getVersion](dw.crypto.X509Certificate.md#getversion)() | Returns the X.509 certificate version number. |
-### Methods inherited from class CertificateRef
-[toString](dw.crypto.CertificateRef.md#tostring)
-### Methods inherited from class Object
-[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)
-## Property Details
-### issuerDN
-- issuerDN: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the X.500 distinguished name of the entity that signed this certificate.
----
-### notAfter
-- notAfter: [Date](TopLevel.Date.md) `(read-only)`
-  - : Returns the end date of the certificate validity period.
----
-### notBefore
-- notBefore: [Date](TopLevel.Date.md) `(read-only)`
-  - : Returns the start date of the certificate validity period.
----
-### serialNumber
-- serialNumber: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the certificate serial number in string format. The serial number is a unique positive integer assigned
-      by the CA to each certificate.
----
-### sigAlgName
-- sigAlgName: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the algorithm used to sign this certificate. The name follows the format defined in RFC 5280 (e.g.,
-      "SHA256withRSA", "SHA384withECDSA").
----
-### subjectDN
-- subjectDN: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the X.500 distinguished name of the entity this certificate belongs to.
----
-### version
-- version: [Number](TopLevel.Number.md) `(read-only)`
-  - : Returns the X.509 certificate version number.
----
-## Method Details
-### getIssuerDN()
-- getIssuerDN(): [String](TopLevel.String.md)
-  - : Returns the X.500 distinguished name of the entity that signed this certificate.
-    **Returns:**
-    - the issuer's X.500 distinguished name
----
-### getNotAfter()
-- getNotAfter(): [Date](TopLevel.Date.md)
-  - : Returns the end date of the certificate validity period.
-    **Returns:**
-    - the date after which this certificate is not valid
----
-### getNotBefore()
-- getNotBefore(): [Date](TopLevel.Date.md)
-  - : Returns the start date of the certificate validity period.
-    **Returns:**
-    - the date before which this certificate is not valid
----
-### getSerialNumber()
-- getSerialNumber(): [String](TopLevel.String.md)
-  - : Returns the certificate serial number in string format. The serial number is a unique positive integer assigned
-      by the CA to each certificate.
-    **Returns:**
-    - the certificate serial number as a string
----
-### getSigAlgName()
-- getSigAlgName(): [String](TopLevel.String.md)
-  - : Returns the algorithm used to sign this certificate. The name follows the format defined in RFC 5280 (e.g.,
-      "SHA256withRSA", "SHA384withECDSA").
-    **Returns:**
-    - the signature algorithm name
----
-### getSubjectDN()
-- getSubjectDN(): [String](TopLevel.String.md)
-  - : Returns the X.500 distinguished name of the entity this certificate belongs to.
-    **Returns:**
-    - the subject's X.500 distinguished name
----
-### getVersion()
-- getVersion(): [Number](TopLevel.Number.md)
-  - : Returns the X.509 certificate version number.
-    **Returns:**
-    - certificate version (typically 1, 2, or 3)
----
-<!-- prettier-ignore-end -->

package/node_modules/@salesforce/b2c-tooling-sdk/data/script-api/dw.crypto.md DELETED Viewed

@@ -1,23 +0,0 @@
-# Package dw.crypto
-## Classes
-| Class | Description |
-| --- | --- |
-| [CertificateRef](dw.crypto.CertificateRef.md) | This class is used as a reference to a certificate or public key. |
-| [CertificateUtils](dw.crypto.CertificateUtils.md) | Utilities for managing certificates and keys. |
-| [Cipher](dw.crypto.Cipher.md) | This class allows access to encryption services offered through the Java  Cryptography Architecture (JCA). |
-| [Encoding](dw.crypto.Encoding.md) | Utility class which handles several common character encodings. |
-| [JWE](dw.crypto.JWE.md) | This class represents a JSON Web Encryption (JWE) object. |
-| [JWEHeader](dw.crypto.JWEHeader.md) | This class represents an immutable header of a JWE (JSON Web Encryption) object. |
-| [JWS](dw.crypto.JWS.md) | This class represents a JSON Web Signature (JWS) object. |
-| [JWSHeader](dw.crypto.JWSHeader.md) | This class represents an immutable header of a JWS (JSON Web Signature) object. |
-| [KeyRef](dw.crypto.KeyRef.md) | This class is used as a reference to a private key in the keystore  which can be managed in the Business Manager. |
-| [Mac](dw.crypto.Mac.md) | This class provides the functionality of a "Message Authentication Code" (MAC) algorithm. |
-| [MessageDigest](dw.crypto.MessageDigest.md) | This class provides the functionality of a message digest algorithm, such as  MD5 or SHA. |
-| [SecureRandom](dw.crypto.SecureRandom.md) | The SecureRandom class provides a cryptographically strong random number generator (RNG). |
-| [Signature](dw.crypto.Signature.md) | <p>This class allows access to signature services offered through the Java  Cryptography Architecture (JCA). |
-| [WeakCipher](dw.crypto.WeakCipher.md) | This API provides access to Deprecated algorithms. |
-| [WeakMac](dw.crypto.WeakMac.md) | This API provides access to Deprecated algorithms. |
-| [WeakMessageDigest](dw.crypto.WeakMessageDigest.md) | This API provides access to Deprecated algorithms. |
-| [WeakSignature](dw.crypto.WeakSignature.md) | This API provides access to Deprecated algorithms. |
-| [X509Certificate](dw.crypto.X509Certificate.md) | Represents an X.509 public key certificate as defined in RFC 5280. |

package/node_modules/@salesforce/b2c-tooling-sdk/data/script-api/dw.customer.AddressBook.md DELETED Viewed

@@ -1,158 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class AddressBook
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.customer.AddressBook](dw.customer.AddressBook.md)
-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.
-## Property Summary
-| Property | Description |
-| --- | --- |
-| [addresses](#addresses): [List](dw.util.List.md) `(read-only)` | Returns a sorted list of addresses in the address book. |
-| [preferredAddress](#preferredaddress): [CustomerAddress](dw.customer.CustomerAddress.md) | Returns the address that has been defined as the customer's preferred  address. |
-## Constructor Summary
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-| Method | Description |
-| --- | --- |
-| [createAddress](dw.customer.AddressBook.md#createaddressstring)([String](TopLevel.String.md)) | Creates a new, empty address object with the specified name. |
-| [getAddress](dw.customer.AddressBook.md#getaddressstring)([String](TopLevel.String.md)) | Returns the address with the given name from the address book. |
-| [getAddresses](dw.customer.AddressBook.md#getaddresses)() | Returns a sorted list of addresses in the address book. |
-| [getPreferredAddress](dw.customer.AddressBook.md#getpreferredaddress)() | Returns the address that has been defined as the customer's preferred  address. |
-| [removeAddress](dw.customer.AddressBook.md#removeaddresscustomeraddress)([CustomerAddress](dw.customer.CustomerAddress.md)) | Removes the specified address from the address book. |
-| [setPreferredAddress](dw.customer.AddressBook.md#setpreferredaddresscustomeraddress)([CustomerAddress](dw.customer.CustomerAddress.md)) | Sets the specified address as the customer's preferred address. |
-### Methods inherited from class Object
-[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)
-## Property Details
-### addresses
-- addresses: [List](dw.util.List.md) `(read-only)`
-  - : 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.
----
-### preferredAddress
-- preferredAddress: [CustomerAddress](dw.customer.CustomerAddress.md)
-  - : Returns the address that has been defined as the customer's preferred
-      address.
----
-## Method Details
-### createAddress(String)
-- createAddress(name: [String](TopLevel.String.md)): [CustomerAddress](dw.customer.CustomerAddress.md)
-  - : 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(String)
-- getAddress(id: [String](TopLevel.String.md)): [CustomerAddress](dw.customer.CustomerAddress.md)
-  - : 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()
-- getAddresses(): [List](dw.util.List.md)
-  - : 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()
-- getPreferredAddress(): [CustomerAddress](dw.customer.CustomerAddress.md)
-  - : 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(CustomerAddress)
-- removeAddress(address: [CustomerAddress](dw.customer.CustomerAddress.md)): void
-  - : 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(CustomerAddress)
-- setPreferredAddress(anAddress: [CustomerAddress](dw.customer.CustomerAddress.md)): void
-  - : 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.
----
-<!-- prettier-ignore-end -->

package/node_modules/@salesforce/b2c-tooling-sdk/data/script-api/dw.customer.AgentUserMgr.md DELETED Viewed

@@ -1,94 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class AgentUserMgr
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.customer.AgentUserMgr](dw.customer.AgentUserMgr.md)
-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
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-| Method | Description |
-| --- | --- |
-| static [loginAgentUser](dw.customer.AgentUserMgr.md#loginagentuserstring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Logs in an agent user (which for example is authorized to login on-behalf of a customer for  instance to place an order). |
-| static [loginOnBehalfOfCustomer](dw.customer.AgentUserMgr.md#loginonbehalfofcustomercustomer)([Customer](dw.customer.Customer.md)) | 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. |
-| static [logoutAgentUser](dw.customer.AgentUserMgr.md#logoutagentuser)() | Performs a logout of the agent user and the current customer which are attached to the current session. |
-### Methods inherited from class Object
-[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)
-## Method Details
-### loginAgentUser(String, String)
-- static loginAgentUser(login: [String](TopLevel.String.md), password: [String](TopLevel.String.md)): [Status](dw.system.Status.md)
-  - : 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](dw.customer.AgentUserStatusCodes.md) 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(Customer)
-- static loginOnBehalfOfCustomer(customer: [Customer](dw.customer.Customer.md)): [Status](dw.system.Status.md)
-  - : 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](dw.customer.AgentUserStatusCodes.md) 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()
-- static logoutAgentUser(): [Status](dw.system.Status.md)
-  - : 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).
----
-<!-- prettier-ignore-end -->

package/node_modules/@salesforce/b2c-tooling-sdk/data/script-api/dw.customer.AgentUserStatusCodes.md DELETED Viewed

@@ -1,164 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class AgentUserStatusCodes
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.customer.AgentUserStatusCodes](dw.customer.AgentUserStatusCodes.md)
-AgentUserStatusCodes contains constants representing status codes that can be
-used with a [Status](dw.system.Status.md) object to indicate the success or failure of the agent
-user login process.
-**See Also:**
-- [Status](dw.system.Status.md)
-## All Known Subclasses
-[AgentUserStatusCodes](dw.system.AgentUserStatusCodes.md)
-## Constant Summary
-| Constant | Description |
-| --- | --- |
-| [AGENT_USER_NOT_AVAILABLE](#agent_user_not_available): [String](TopLevel.String.md) = "AGENT_USER_NOT_AVAILABLE" | Indicates that the agent user is not available. |
-| [AGENT_USER_NOT_LOGGED_IN](#agent_user_not_logged_in): [String](TopLevel.String.md) = "AGENT_USER_NOT_LOGGED_IN" | Indicates that the agent user is not logged in. |
-| [CREDENTIALS_INVALID](#credentials_invalid): [String](TopLevel.String.md) = "CREDENTIALS_INVALID" | Indicates that the given agent user login or password was wrong. |
-| [CUSTOMER_DISABLED](#customer_disabled): [String](TopLevel.String.md) = "CUSTOMER_DISABLED" | Indicates that the customer is disabled. |
-| [CUSTOMER_UNREGISTERED](#customer_unregistered): [String](TopLevel.String.md) = "CUSTOMER_UNREGISTERED" | Indicates that the customer is either not registered or not registered with the current site. |
-| [INSECURE_CONNECTION](#insecure_connection): [String](TopLevel.String.md) = "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](#insufficient_permission): [String](TopLevel.String.md) = "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](#login_successful): [String](TopLevel.String.md) = "LOGIN_SUCCESSFUL" | Indicates that the agent user login was successful. |
-| [NO_STOREFRONT](#no_storefront): [String](TopLevel.String.md) = "NO_STOREFRONT" | Indicates that the current context is not a storefront request. |
-| [PASSWORD_EXPIRED](#password_expired): [String](TopLevel.String.md) = "PASSWORD_EXPIRED" | Indicates that the given agent user password has expired and needs to be  changed in the Business Manager. |
-| [USER_DISABLED](#user_disabled): [String](TopLevel.String.md) = "USER_DISABLED" | Indicates that the agent user account has been disabled in the Business  Manager. |
-| [USER_LOCKED](#user_locked): [String](TopLevel.String.md) = "USER_LOCKED" | Indicates that the agent user account is locked, because the maximum  number of failed login attempts was exceeded. |
-## Constructor Summary
-| Constructor | Description |
-| --- | --- |
-| [AgentUserStatusCodes](#agentuserstatuscodes)() |  |
-## Method Summary
-### Methods inherited from class Object
-[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)
-## Constant Details
-### AGENT_USER_NOT_AVAILABLE
-- AGENT_USER_NOT_AVAILABLE: [String](TopLevel.String.md) = "AGENT_USER_NOT_AVAILABLE"
-  - : Indicates that the agent user is not available.
----
-### AGENT_USER_NOT_LOGGED_IN
-- AGENT_USER_NOT_LOGGED_IN: [String](TopLevel.String.md) = "AGENT_USER_NOT_LOGGED_IN"
-  - : Indicates that the agent user is not logged in.
----
-### CREDENTIALS_INVALID
-- CREDENTIALS_INVALID: [String](TopLevel.String.md) = "CREDENTIALS_INVALID"
-  - : Indicates that the given agent user login or password was wrong.
----
-### CUSTOMER_DISABLED
-- CUSTOMER_DISABLED: [String](TopLevel.String.md) = "CUSTOMER_DISABLED"
-  - : Indicates that the customer is disabled.
----
-### CUSTOMER_UNREGISTERED
-- CUSTOMER_UNREGISTERED: [String](TopLevel.String.md) = "CUSTOMER_UNREGISTERED"
-  - : Indicates that the customer is either not registered or not registered with the current site.
----
-### INSECURE_CONNECTION
-- INSECURE_CONNECTION: [String](TopLevel.String.md) = "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
-- INSUFFICIENT_PERMISSION: [String](TopLevel.String.md) = "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
-- LOGIN_SUCCESSFUL: [String](TopLevel.String.md) = "LOGIN_SUCCESSFUL"
-  - : Indicates that the agent user login was successful.
----
-### NO_STOREFRONT
-- NO_STOREFRONT: [String](TopLevel.String.md) = "NO_STOREFRONT"
-  - : Indicates that the current context is not a storefront request.
----
-### PASSWORD_EXPIRED
-- PASSWORD_EXPIRED: [String](TopLevel.String.md) = "PASSWORD_EXPIRED"
-  - : Indicates that the given agent user password has expired and needs to be
-      changed in the Business Manager.
----
-### USER_DISABLED
-- USER_DISABLED: [String](TopLevel.String.md) = "USER_DISABLED"
-  - : Indicates that the agent user account has been disabled in the Business
-      Manager.
----
-### USER_LOCKED
-- USER_LOCKED: [String](TopLevel.String.md) = "USER_LOCKED"
-  - : Indicates that the agent user account is locked, because the maximum
-      number of failed login attempts was exceeded.
----
-## Constructor Details
-### AgentUserStatusCodes()
-- AgentUserStatusCodes()
-  - :
----
-<!-- prettier-ignore-end -->