@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.2

package/data/script-api/dw.customer.CustomerPasswordConstraints.md

@@ -0,0 +1,125 @@
+<!-- prettier-ignore-start -->
+# Class CustomerPasswordConstraints
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.customer.CustomerPasswordConstraints](dw.customer.CustomerPasswordConstraints.md)
+
+Provides access to the constraints of customer passwords. An instance of this class can be obtained via [CustomerMgr.getPasswordConstraints()](dw.customer.CustomerMgr.md#getpasswordconstraints).
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [forceLetters](#forceletters): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns `true` if letters are enforced. |
+| [forceMixedCase](#forcemixedcase): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns `true` if mixed case is enforced. |
+| [forceNumbers](#forcenumbers): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns `true` if numbers are enforced. |
+| [minLength](#minlength): [Number](TopLevel.Number.md) `(read-only)` | Returns the minimum length. |
+| [minSpecialChars](#minspecialchars): [Number](TopLevel.Number.md) `(read-only)` | Returns the minimum number of special characters. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| static [getMinLength](dw.customer.CustomerPasswordConstraints.md#getminlength)() | Returns the minimum length. |
+| static [getMinSpecialChars](dw.customer.CustomerPasswordConstraints.md#getminspecialchars)() | Returns the minimum number of special characters. |
+| static [isForceLetters](dw.customer.CustomerPasswordConstraints.md#isforceletters)() | Returns `true` if letters are enforced. |
+| static [isForceMixedCase](dw.customer.CustomerPasswordConstraints.md#isforcemixedcase)() | Returns `true` if mixed case is enforced. |
+| static [isForceNumbers](dw.customer.CustomerPasswordConstraints.md#isforcenumbers)() | Returns `true` if numbers are enforced. |
+
+### 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
+
+### forceLetters
+- forceLetters: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Returns `true` if letters are enforced.
+
+
+---
+
+### forceMixedCase
+- forceMixedCase: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Returns `true` if mixed case is enforced.
+
+
+---
+
+### forceNumbers
+- forceNumbers: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Returns `true` if numbers are enforced.
+
+
+---
+
+### minLength
+- minLength: [Number](TopLevel.Number.md) `(read-only)`
+  - : Returns the minimum length.
+
+
+---
+
+### minSpecialChars
+- minSpecialChars: [Number](TopLevel.Number.md) `(read-only)`
+  - : Returns the minimum number of special characters.
+
+
+---
+
+## Method Details
+
+### getMinLength()
+- static getMinLength(): [Number](TopLevel.Number.md)
+  - : Returns the minimum length.
+
+    **Returns:**
+    - the minimum length
+
+
+---
+
+### getMinSpecialChars()
+- static getMinSpecialChars(): [Number](TopLevel.Number.md)
+  - : Returns the minimum number of special characters.
+
+    **Returns:**
+    - the minimum number of special characters
+
+
+---
+
+### isForceLetters()
+- static isForceLetters(): [Boolean](TopLevel.Boolean.md)
+  - : Returns `true` if letters are enforced.
+
+    **Returns:**
+    - if letters are enforced
+
+
+---
+
+### isForceMixedCase()
+- static isForceMixedCase(): [Boolean](TopLevel.Boolean.md)
+  - : Returns `true` if mixed case is enforced.
+
+    **Returns:**
+    - if mixed case is enforced
+
+
+---
+
+### isForceNumbers()
+- static isForceNumbers(): [Boolean](TopLevel.Boolean.md)
+  - : Returns `true` if numbers are enforced.
+
+    **Returns:**
+    - if numbers are enforced
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.customer.CustomerPaymentInstrument.md

@@ -0,0 +1,161 @@
+<!-- prettier-ignore-start -->
+# Class CustomerPaymentInstrument
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.object.PersistentObject](dw.object.PersistentObject.md)
+    - [dw.object.ExtensibleObject](dw.object.ExtensibleObject.md)
+      - [dw.customer.EncryptedObject](dw.customer.EncryptedObject.md)
+        - [dw.order.PaymentInstrument](dw.order.PaymentInstrument.md)
+          - [dw.customer.CustomerPaymentInstrument](dw.customer.CustomerPaymentInstrument.md)
+
+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.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [bankAccountDriversLicense](#bankaccountdriverslicense): [String](TopLevel.String.md) `(read-only)` | Returns the driver's license number of the bank account number  if the calling context meets the following criteria: <br/>  <ul>  <li>  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  </li>  </ul>  Otherwise, the method returns the masked driver's license number of the bank account. |
+| [bankAccountNumber](#bankaccountnumber): [String](TopLevel.String.md) `(read-only)` | Returns the bank account number if the calling context meets  the following criteria: <br/>  <ul>  <li>  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  </li>  </ul>  Otherwise, the method returns the masked bank account number. |
+| [creditCardNumber](#creditcardnumber): [String](TopLevel.String.md) `(read-only)` | Returns the decrypted credit card number if the calling context meets  the following criteria: <br/>  <ul>  <li>  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. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getBankAccountDriversLicense](dw.customer.CustomerPaymentInstrument.md#getbankaccountdriverslicense)() | Returns the driver's license number of the bank account number  if the calling context meets the following criteria: <br/>  <ul>  <li>  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  </li>  </ul>  Otherwise, the method returns the masked driver's license number of the bank account. |
+| [getBankAccountNumber](dw.customer.CustomerPaymentInstrument.md#getbankaccountnumber)() | Returns the bank account number if the calling context meets  the following criteria: <br/>  <ul>  <li>  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  </li>  </ul>  Otherwise, the method returns the masked bank account number. |
+| [getCreditCardNumber](dw.customer.CustomerPaymentInstrument.md#getcreditcardnumber)() | Returns the decrypted credit card number if the calling context meets  the following criteria: <br/>  <ul>  <li>  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. |
+
+### Methods inherited from class PaymentInstrument
+
+[getBankAccountDriversLicense](dw.order.PaymentInstrument.md#getbankaccountdriverslicense), [getBankAccountDriversLicenseLastDigits](dw.order.PaymentInstrument.md#getbankaccountdriverslicenselastdigits), [getBankAccountDriversLicenseLastDigits](dw.order.PaymentInstrument.md#getbankaccountdriverslicenselastdigitsnumber), [getBankAccountDriversLicenseStateCode](dw.order.PaymentInstrument.md#getbankaccountdriverslicensestatecode), [getBankAccountHolder](dw.order.PaymentInstrument.md#getbankaccountholder), [getBankAccountNumber](dw.order.PaymentInstrument.md#getbankaccountnumber), [getBankAccountNumberLastDigits](dw.order.PaymentInstrument.md#getbankaccountnumberlastdigits), [getBankAccountNumberLastDigits](dw.order.PaymentInstrument.md#getbankaccountnumberlastdigitsnumber), [getBankRoutingNumber](dw.order.PaymentInstrument.md#getbankroutingnumber), [getCreditCardExpirationMonth](dw.order.PaymentInstrument.md#getcreditcardexpirationmonth), [getCreditCardExpirationYear](dw.order.PaymentInstrument.md#getcreditcardexpirationyear), [getCreditCardHolder](dw.order.PaymentInstrument.md#getcreditcardholder), [getCreditCardIssueNumber](dw.order.PaymentInstrument.md#getcreditcardissuenumber), [getCreditCardNumber](dw.order.PaymentInstrument.md#getcreditcardnumber), [getCreditCardNumberLastDigits](dw.order.PaymentInstrument.md#getcreditcardnumberlastdigits), [getCreditCardNumberLastDigits](dw.order.PaymentInstrument.md#getcreditcardnumberlastdigitsnumber), [getCreditCardToken](dw.order.PaymentInstrument.md#getcreditcardtoken), [getCreditCardType](dw.order.PaymentInstrument.md#getcreditcardtype), [getCreditCardValidFromMonth](dw.order.PaymentInstrument.md#getcreditcardvalidfrommonth), [getCreditCardValidFromYear](dw.order.PaymentInstrument.md#getcreditcardvalidfromyear), [getEncryptedBankAccountDriversLicense](dw.order.PaymentInstrument.md#getencryptedbankaccountdriverslicensestring-string), [getEncryptedBankAccountNumber](dw.order.PaymentInstrument.md#getencryptedbankaccountnumberstring-string), [getEncryptedCreditCardNumber](dw.order.PaymentInstrument.md#getencryptedcreditcardnumberstring-certificateref), [getEncryptedCreditCardNumber](dw.order.PaymentInstrument.md#getencryptedcreditcardnumberstring-string), [getGiftCertificateCode](dw.order.PaymentInstrument.md#getgiftcertificatecode), [getGiftCertificateID](dw.order.PaymentInstrument.md#getgiftcertificateid), [getMaskedBankAccountDriversLicense](dw.order.PaymentInstrument.md#getmaskedbankaccountdriverslicense), [getMaskedBankAccountDriversLicense](dw.order.PaymentInstrument.md#getmaskedbankaccountdriverslicensenumber), [getMaskedBankAccountNumber](dw.order.PaymentInstrument.md#getmaskedbankaccountnumber), [getMaskedBankAccountNumber](dw.order.PaymentInstrument.md#getmaskedbankaccountnumbernumber), [getMaskedCreditCardNumber](dw.order.PaymentInstrument.md#getmaskedcreditcardnumber), [getMaskedCreditCardNumber](dw.order.PaymentInstrument.md#getmaskedcreditcardnumbernumber), [getMaskedGiftCertificateCode](dw.order.PaymentInstrument.md#getmaskedgiftcertificatecode), [getMaskedGiftCertificateCode](dw.order.PaymentInstrument.md#getmaskedgiftcertificatecodenumber), [getPaymentMethod](dw.order.PaymentInstrument.md#getpaymentmethod), [isCreditCardExpired](dw.order.PaymentInstrument.md#iscreditcardexpired), [isPermanentlyMasked](dw.order.PaymentInstrument.md#ispermanentlymasked), [setBankAccountDriversLicense](dw.order.PaymentInstrument.md#setbankaccountdriverslicensestring), [setBankAccountDriversLicenseStateCode](dw.order.PaymentInstrument.md#setbankaccountdriverslicensestatecodestring), [setBankAccountHolder](dw.order.PaymentInstrument.md#setbankaccountholderstring), [setBankAccountNumber](dw.order.PaymentInstrument.md#setbankaccountnumberstring), [setBankRoutingNumber](dw.order.PaymentInstrument.md#setbankroutingnumberstring), [setCreditCardExpirationMonth](dw.order.PaymentInstrument.md#setcreditcardexpirationmonthnumber), [setCreditCardExpirationYear](dw.order.PaymentInstrument.md#setcreditcardexpirationyearnumber), [setCreditCardHolder](dw.order.PaymentInstrument.md#setcreditcardholderstring), [setCreditCardIssueNumber](dw.order.PaymentInstrument.md#setcreditcardissuenumberstring), [setCreditCardNumber](dw.order.PaymentInstrument.md#setcreditcardnumberstring), [setCreditCardToken](dw.order.PaymentInstrument.md#setcreditcardtokenstring), [setCreditCardType](dw.order.PaymentInstrument.md#setcreditcardtypestring), [setCreditCardValidFromMonth](dw.order.PaymentInstrument.md#setcreditcardvalidfrommonthnumber), [setCreditCardValidFromYear](dw.order.PaymentInstrument.md#setcreditcardvalidfromyearnumber), [setGiftCertificateCode](dw.order.PaymentInstrument.md#setgiftcertificatecodestring), [setGiftCertificateID](dw.order.PaymentInstrument.md#setgiftcertificateidstring)
+### Methods inherited from class ExtensibleObject
+
+[describe](dw.object.ExtensibleObject.md#describe), [getCustom](dw.object.ExtensibleObject.md#getcustom)
+### Methods inherited from class PersistentObject
+
+[getCreationDate](dw.object.PersistentObject.md#getcreationdate), [getLastModified](dw.object.PersistentObject.md#getlastmodified), [getUUID](dw.object.PersistentObject.md#getuuid)
+### 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
+
+### bankAccountDriversLicense
+- bankAccountDriversLicense: [String](TopLevel.String.md) `(read-only)`
+  - : 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.
+
+
+
+---
+
+### bankAccountNumber
+- bankAccountNumber: [String](TopLevel.String.md) `(read-only)`
+  - : 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.
+
+
+
+---
+
+### creditCardNumber
+- creditCardNumber: [String](TopLevel.String.md) `(read-only)`
+  - : 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.
+
+
+
+---
+
+## Method Details
+
+### getBankAccountDriversLicense()
+- getBankAccountDriversLicense(): [String](TopLevel.String.md)
+  - : 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()
+- getBankAccountNumber(): [String](TopLevel.String.md)
+  - : 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()
+- getCreditCardNumber(): [String](TopLevel.String.md)
+  - : 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.
+
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.customer.CustomerStatusCodes.md

@@ -0,0 +1,55 @@
+<!-- prettier-ignore-start -->
+# Class CustomerStatusCodes
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.customer.CustomerStatusCodes](dw.customer.CustomerStatusCodes.md)
+
+CustomerStatusCodes contains constants representing 
+status codes that can be used with a Status object to 
+indicate the success or failure of an operation.
+
+
+**See Also:**
+- [Status](dw.system.Status.md)
+
+
+## Constant Summary
+
+| Constant | Description |
+| --- | --- |
+| [CUSTOMER_ADDRESS_REFERENCED_BY_PRODUCT_LIST](#customer_address_referenced_by_product_list): [String](TopLevel.String.md) = "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. |
+
+## Constructor Summary
+
+| Constructor | Description |
+| --- | --- |
+| [CustomerStatusCodes](#customerstatuscodes)() |  |
+
+## 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
+
+### CUSTOMER_ADDRESS_REFERENCED_BY_PRODUCT_LIST
+
+- CUSTOMER_ADDRESS_REFERENCED_BY_PRODUCT_LIST: [String](TopLevel.String.md) = "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.
+
+
+
+---
+
+## Constructor Details
+
+### CustomerStatusCodes()
+- CustomerStatusCodes()
+  - : 
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.customer.EncryptedObject.md

@@ -0,0 +1,34 @@
+<!-- prettier-ignore-start -->
+# Class EncryptedObject
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.object.PersistentObject](dw.object.PersistentObject.md)
+    - [dw.object.ExtensibleObject](dw.object.ExtensibleObject.md)
+      - [dw.customer.EncryptedObject](dw.customer.EncryptedObject.md)
+
+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.
+
+
+
+## All Known Subclasses
+[CustomerPaymentInstrument](dw.customer.CustomerPaymentInstrument.md), [OrderPaymentInstrument](dw.order.OrderPaymentInstrument.md), [PaymentInstrument](dw.order.PaymentInstrument.md), [Profile](dw.customer.Profile.md), [ServiceCredential](dw.svc.ServiceCredential.md)
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+### Methods inherited from class ExtensibleObject
+
+[describe](dw.object.ExtensibleObject.md#describe), [getCustom](dw.object.ExtensibleObject.md#getcustom)
+### Methods inherited from class PersistentObject
+
+[getCreationDate](dw.object.PersistentObject.md#getcreationdate), [getLastModified](dw.object.PersistentObject.md#getlastmodified), [getUUID](dw.object.PersistentObject.md#getuuid)
+### 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)
+<!-- prettier-ignore-end -->

package/data/script-api/dw.customer.ExternalProfile.md

@@ -0,0 +1,154 @@
+<!-- prettier-ignore-start -->
+# Class ExternalProfile
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.customer.ExternalProfile](dw.customer.ExternalProfile.md)
+
+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.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [authenticationProviderID](#authenticationproviderid): [String](TopLevel.String.md) `(read-only)` | Returns the authentication provider ID. |
+| [customer](#customer): [Customer](dw.customer.Customer.md) `(read-only)` | Returns the customer object related to this profile. |
+| [email](#email): [String](TopLevel.String.md) | Returns the customer's email address. |
+| [externalID](#externalid): [String](TopLevel.String.md) `(read-only)` | Returns the external ID. |
+| [lastLoginTime](#lastlogintime): [Date](TopLevel.Date.md) `(read-only)` | Returns the last login time of the customer through the external provider |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getAuthenticationProviderID](dw.customer.ExternalProfile.md#getauthenticationproviderid)() | Returns the authentication provider ID. |
+| [getCustomer](dw.customer.ExternalProfile.md#getcustomer)() | Returns the customer object related to this profile. |
+| [getEmail](dw.customer.ExternalProfile.md#getemail)() | Returns the customer's email address. |
+| [getExternalID](dw.customer.ExternalProfile.md#getexternalid)() | Returns the external ID. |
+| [getLastLoginTime](dw.customer.ExternalProfile.md#getlastlogintime)() | Returns the last login time of the customer through the external provider |
+| [setEmail](dw.customer.ExternalProfile.md#setemailstring)([String](TopLevel.String.md)) | Sets the customer's email 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
+
+### authenticationProviderID
+- authenticationProviderID: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the authentication provider ID.
+
+
+---
+
+### customer
+- customer: [Customer](dw.customer.Customer.md) `(read-only)`
+  - : Returns the customer object related to this profile.
+
+
+---
+
+### email
+- email: [String](TopLevel.String.md)
+  - : Returns the customer's email address.
+
+
+---
+
+### externalID
+- externalID: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the external ID.
+
+
+---
+
+### lastLoginTime
+- lastLoginTime: [Date](TopLevel.Date.md) `(read-only)`
+  - : Returns the last login time of the customer through the external provider
+
+
+---
+
+## Method Details
+
+### getAuthenticationProviderID()
+- getAuthenticationProviderID(): [String](TopLevel.String.md)
+  - : Returns the authentication provider ID.
+
+    **Returns:**
+    - the authentication provider ID.
+
+
+---
+
+### getCustomer()
+- getCustomer(): [Customer](dw.customer.Customer.md)
+  - : Returns the customer object related to this profile.
+
+    **Returns:**
+    - customer object related to profile.
+
+
+---
+
+### getEmail()
+- getEmail(): [String](TopLevel.String.md)
+  - : Returns the customer's email address.
+
+    **Returns:**
+    - the customer's email address.
+
+
+---
+
+### getExternalID()
+- getExternalID(): [String](TopLevel.String.md)
+  - : Returns the external ID.
+
+    **Returns:**
+    - the external ID.
+
+
+---
+
+### getLastLoginTime()
+- getLastLoginTime(): [Date](TopLevel.Date.md)
+  - : 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(String)
+- setEmail(email: [String](TopLevel.String.md)): void
+  - : Sets the customer's email address.
+
+    **Parameters:**
+    - email - the customer's email address.
+
+
+---
+
+<!-- prettier-ignore-end -->