@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.3

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

@@ -0,0 +1,136 @@
+<!-- prettier-ignore-start -->
+# Class Wallet
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.customer.Wallet](dw.customer.Wallet.md)
+
+Represents a set of payment instruments associated with a registered customer.
+
+
+**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 |
+| --- | --- |
+| [defaultPaymentInstrument](#defaultpaymentinstrument): [CustomerPaymentInstrument](dw.customer.CustomerPaymentInstrument.md) `(read-only)` | Returns the default payment instrument associated with the related customer. |
+| [paymentInstruments](#paymentinstruments): [Collection](dw.util.Collection.md) `(read-only)` | Returns a collection of all payment instruments associated with the  related customer. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [createPaymentInstrument](dw.customer.Wallet.md#createpaymentinstrumentstring)([String](TopLevel.String.md)) | Creates a new, empty payment instrument object associated with the  related customer for the given payment method. |
+| [getDefaultPaymentInstrument](dw.customer.Wallet.md#getdefaultpaymentinstrument)() | Returns the default payment instrument associated with the related customer. |
+| [getPaymentInstruments](dw.customer.Wallet.md#getpaymentinstruments)() | Returns a collection of all payment instruments associated with the  related customer. |
+| [getPaymentInstruments](dw.customer.Wallet.md#getpaymentinstrumentsstring)([String](TopLevel.String.md)) | Returns a collection of all payment instruments associated with the  related customer filtered by the given payment method id. |
+| [removePaymentInstrument](dw.customer.Wallet.md#removepaymentinstrumentcustomerpaymentinstrument)([CustomerPaymentInstrument](dw.customer.CustomerPaymentInstrument.md)) | Removes a payment instrument associated with the customer. |
+
+### 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
+
+### defaultPaymentInstrument
+- defaultPaymentInstrument: [CustomerPaymentInstrument](dw.customer.CustomerPaymentInstrument.md) `(read-only)`
+  - : Returns the default payment instrument associated with the related customer. If not available, returns the first
+      payment instrument or null if no payment instruments are associated with the customer.
+
+
+
+---
+
+### paymentInstruments
+- paymentInstruments: [Collection](dw.util.Collection.md) `(read-only)`
+  - : Returns a collection of all payment instruments associated with the
+      related customer.
+
+
+
+---
+
+## Method Details
+
+### createPaymentInstrument(String)
+- createPaymentInstrument(paymentMethodId: [String](TopLevel.String.md)): [CustomerPaymentInstrument](dw.customer.CustomerPaymentInstrument.md)
+  - : Creates a new, empty payment instrument object associated with the
+      related customer for the given payment method.
+
+
+    **Parameters:**
+    - paymentMethodId - the id of a payment method
+
+    **Returns:**
+    - the new payment instrument object.
+
+    **Throws:**
+    - NullArgumentException - If passed 'paymentMethodId' is null.
+
+
+---
+
+### getDefaultPaymentInstrument()
+- getDefaultPaymentInstrument(): [CustomerPaymentInstrument](dw.customer.CustomerPaymentInstrument.md)
+  - : Returns the default payment instrument associated with the related customer. If not available, returns the first
+      payment instrument or null if no payment instruments are associated with the customer.
+
+
+    **Returns:**
+    - The default payment instrument object.
+
+
+---
+
+### getPaymentInstruments()
+- getPaymentInstruments(): [Collection](dw.util.Collection.md)
+  - : Returns a collection of all payment instruments associated with the
+      related customer.
+
+
+    **Returns:**
+    - Collection of all payment instruments.
+
+
+---
+
+### getPaymentInstruments(String)
+- getPaymentInstruments(paymentMethodID: [String](TopLevel.String.md)): [Collection](dw.util.Collection.md)
+  - : Returns a collection of all payment instruments associated with the
+      related customer filtered by the given payment method id. If
+      `null` is passed as payment method id all payment instruments
+      of the customer will be retrieved. If for the given payment method id no
+      payment instrument is associated with the customer an empty collection
+      will be returned.
+
+
+    **Parameters:**
+    - paymentMethodID - the paymentMethodID the payment method id to filter for
+
+    **Returns:**
+    - Collection of payment instruments for a payment method.
+
+
+---
+
+### removePaymentInstrument(CustomerPaymentInstrument)
+- removePaymentInstrument(instrument: [CustomerPaymentInstrument](dw.customer.CustomerPaymentInstrument.md)): void
+  - : Removes a payment instrument associated with the customer.
+
+    **Parameters:**
+    - instrument - the instrument associated with this customer
+
+    **Throws:**
+    - NullArgumentException - If passed 'instrument' is null.
+    - IllegalArgumentException - If passed 'instrument' belongs to an other customer
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,31 @@
+# Package dw.customer
+
+## Classes
+| Class | Description |
+| --- | --- |
+| [AddressBook](dw.customer.AddressBook.md) | Represents a set of addresses associated with a specific 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. |
+| [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. |
+| [AuthenticationStatus](dw.customer.AuthenticationStatus.md) | Holds the status of an authentication process. |
+| [Credentials](dw.customer.Credentials.md) | Represents the credentials of a customer. |
+| [Customer](dw.customer.Customer.md) | Represents a customer. |
+| [CustomerActiveData](dw.customer.CustomerActiveData.md) | Represents the active data for a [Customer](dw.customer.Customer.md) in Commerce Cloud Digital. |
+| [CustomerAddress](dw.customer.CustomerAddress.md) | The Address class represents a customer's address. |
+| [CustomerCDPData](dw.customer.CustomerCDPData.md) | Represents the read-only Customer's Salesforce CDP (Customer Data Platform) data for a [Customer](dw.customer.Customer.md) in Commerce  Cloud. |
+| [CustomerContextMgr](dw.customer.CustomerContextMgr.md) | Provides helper methods for managing customer context, such as the Effective Time for which the customer is shopping  at |
+| [CustomerGroup](dw.customer.CustomerGroup.md) | CustomerGroups provide a means to segment customers by various criteria. |
+| [CustomerList](dw.customer.CustomerList.md) | Object representing the collection of customers who are registered  for a given site. |
+| [CustomerMgr](dw.customer.CustomerMgr.md) | Provides helper methods for managing customers and customer  profiles. |
+| [CustomerPasswordConstraints](dw.customer.CustomerPasswordConstraints.md) | Provides access to the constraints of customer passwords. |
+| [CustomerPaymentInstrument](dw.customer.CustomerPaymentInstrument.md) | Represents any payment instrument stored in the customers profile, such as  credit card or bank transfer. |
+| [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. |
+| [EncryptedObject](dw.customer.EncryptedObject.md) | Defines a API base class for classes containing  encrypted attributes like credit cards. |
+| [ExternalProfile](dw.customer.ExternalProfile.md) | Represents the credentials of a customer. |
+| [OrderHistory](dw.customer.OrderHistory.md) | The class provides access to past orders of the customer. |
+| [ProductList](dw.customer.ProductList.md) | Represents a list of products (and optionally a gift certificate) that is  typically maintained by a customer. |
+| [ProductListItem](dw.customer.ProductListItem.md) | An item in a product list. |
+| [ProductListItemPurchase](dw.customer.ProductListItemPurchase.md) | A record of the purchase of an item contained in a product list. |
+| [ProductListMgr](dw.customer.ProductListMgr.md) | ProductListMgr provides methods for retrieving, creating, searching for, and  removing product lists. |
+| [ProductListRegistrant](dw.customer.ProductListRegistrant.md) | A ProductListRegistrant is typically associated with an event related product list  such as a gift registry. |
+| [Profile](dw.customer.Profile.md) | The class represents a customer profile. |
+| [Wallet](dw.customer.Wallet.md) | Represents a set of payment instruments associated with a registered customer. |

package/data/script-api/dw.customer.oauth.OAuthAccessTokenResponse.md

@@ -0,0 +1,171 @@
+<!-- prettier-ignore-start -->
+# Class OAuthAccessTokenResponse
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.customer.oauth.OAuthAccessTokenResponse](dw.customer.oauth.OAuthAccessTokenResponse.md)
+
+Contains OAuth-related artifacts from the HTTP response from the third-party
+OAuth server when requesting an access token
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [IDToken](#idtoken): [String](TopLevel.String.md) `(read-only)` | Returns the ID token, if available |
+| [accessToken](#accesstoken): [String](TopLevel.String.md) `(read-only)` | Returns the access token |
+| [accessTokenExpiry](#accesstokenexpiry): [Number](TopLevel.Number.md) `(read-only)` | Returns the access token expiration |
+| [errorStatus](#errorstatus): [String](TopLevel.String.md) `(read-only)` | Returns the error status. |
+| [extraTokens](#extratokens): [Map](dw.util.Map.md) `(read-only)` | Returns a map of additional tokens found in the response. |
+| [oauthProviderId](#oauthproviderid): [String](TopLevel.String.md) `(read-only)` | Returns the OAuth provider id |
+| [refreshToken](#refreshtoken): [String](TopLevel.String.md) `(read-only)` | Returns the refresh token |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getAccessToken](dw.customer.oauth.OAuthAccessTokenResponse.md#getaccesstoken)() | Returns the access token |
+| [getAccessTokenExpiry](dw.customer.oauth.OAuthAccessTokenResponse.md#getaccesstokenexpiry)() | Returns the access token expiration |
+| [getErrorStatus](dw.customer.oauth.OAuthAccessTokenResponse.md#geterrorstatus)() | Returns the error status. |
+| [getExtraTokens](dw.customer.oauth.OAuthAccessTokenResponse.md#getextratokens)() | Returns a map of additional tokens found in the response. |
+| [getIDToken](dw.customer.oauth.OAuthAccessTokenResponse.md#getidtoken)() | Returns the ID token, if available |
+| [getOauthProviderId](dw.customer.oauth.OAuthAccessTokenResponse.md#getoauthproviderid)() | Returns the OAuth provider id |
+| [getRefreshToken](dw.customer.oauth.OAuthAccessTokenResponse.md#getrefreshtoken)() | Returns the refresh token |
+
+### 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
+
+### IDToken
+- IDToken: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the ID token, if available
+
+
+---
+
+### accessToken
+- accessToken: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the access token
+
+
+---
+
+### accessTokenExpiry
+- accessTokenExpiry: [Number](TopLevel.Number.md) `(read-only)`
+  - : Returns the access token expiration
+
+
+---
+
+### errorStatus
+- errorStatus: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the error status.
+      In cases of errors - more detailed error information
+      can be seen in the error log files (specifity of error details vary by OAuth provider).
+
+
+
+---
+
+### extraTokens
+- extraTokens: [Map](dw.util.Map.md) `(read-only)`
+  - : Returns a map of additional tokens found in the response.
+
+
+---
+
+### oauthProviderId
+- oauthProviderId: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the OAuth provider id
+
+
+---
+
+### refreshToken
+- refreshToken: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the refresh token
+
+
+---
+
+## Method Details
+
+### getAccessToken()
+- getAccessToken(): [String](TopLevel.String.md)
+  - : Returns the access token
+
+    **Returns:**
+    - the access token, if available, null otherwise
+
+
+---
+
+### getAccessTokenExpiry()
+- getAccessTokenExpiry(): [Number](TopLevel.Number.md)
+  - : Returns the access token expiration
+
+    **Returns:**
+    - the access token expiration
+
+
+---
+
+### getErrorStatus()
+- getErrorStatus(): [String](TopLevel.String.md)
+  - : Returns the error status.
+      In cases of errors - more detailed error information
+      can be seen in the error log files (specifity of error details vary by OAuth provider).
+
+
+    **Returns:**
+    - the error status, if available, null otherwise
+
+
+---
+
+### getExtraTokens()
+- getExtraTokens(): [Map](dw.util.Map.md)
+  - : Returns a map of additional tokens found in the response.
+
+    **Returns:**
+    - Additional tokens provided by the token end-point.  May be null or empty.
+
+
+---
+
+### getIDToken()
+- getIDToken(): [String](TopLevel.String.md)
+  - : Returns the ID token, if available
+
+    **Returns:**
+    - the ID token, if available, null otherwise
+
+
+---
+
+### getOauthProviderId()
+- getOauthProviderId(): [String](TopLevel.String.md)
+  - : Returns the OAuth provider id
+
+    **Returns:**
+    - the OAuth provider id
+
+
+---
+
+### getRefreshToken()
+- getRefreshToken(): [String](TopLevel.String.md)
+  - : Returns the refresh token
+
+    **Returns:**
+    - the refresh token, if available, null otherwise
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.customer.oauth.OAuthFinalizedResponse.md

@@ -0,0 +1,75 @@
+<!-- prettier-ignore-start -->
+# Class OAuthFinalizedResponse
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.customer.oauth.OAuthFinalizedResponse](dw.customer.oauth.OAuthFinalizedResponse.md)
+
+Contains the combined responses from the third-party OAuth server when
+finalizing the authentication.
+
+
+Contains both the [OAuthAccessTokenResponse](dw.customer.oauth.OAuthAccessTokenResponse.md) 
+
+and the [OAuthUserInfoResponse](dw.customer.oauth.OAuthUserInfoResponse.md)
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [accessTokenResponse](#accesstokenresponse): [OAuthAccessTokenResponse](dw.customer.oauth.OAuthAccessTokenResponse.md) `(read-only)` | Returns the access token response |
+| [userInfoResponse](#userinforesponse): [OAuthUserInfoResponse](dw.customer.oauth.OAuthUserInfoResponse.md) `(read-only)` | Returns the user info response |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getAccessTokenResponse](dw.customer.oauth.OAuthFinalizedResponse.md#getaccesstokenresponse)() | Returns the access token response |
+| [getUserInfoResponse](dw.customer.oauth.OAuthFinalizedResponse.md#getuserinforesponse)() | Returns the user info response |
+
+### 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
+
+### accessTokenResponse
+- accessTokenResponse: [OAuthAccessTokenResponse](dw.customer.oauth.OAuthAccessTokenResponse.md) `(read-only)`
+  - : Returns the access token response
+
+
+---
+
+### userInfoResponse
+- userInfoResponse: [OAuthUserInfoResponse](dw.customer.oauth.OAuthUserInfoResponse.md) `(read-only)`
+  - : Returns the user info response
+
+
+---
+
+## Method Details
+
+### getAccessTokenResponse()
+- getAccessTokenResponse(): [OAuthAccessTokenResponse](dw.customer.oauth.OAuthAccessTokenResponse.md)
+  - : Returns the access token response
+
+    **Returns:**
+    - the access token response
+
+
+---
+
+### getUserInfoResponse()
+- getUserInfoResponse(): [OAuthUserInfoResponse](dw.customer.oauth.OAuthUserInfoResponse.md)
+  - : Returns the user info response
+
+    **Returns:**
+    - the user info response
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.customer.oauth.OAuthLoginFlowMgr.md

@@ -0,0 +1,165 @@
+<!-- prettier-ignore-start -->
+# Class OAuthLoginFlowMgr
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.customer.oauth.OAuthLoginFlowMgr](dw.customer.oauth.OAuthLoginFlowMgr.md)
+
+The OAuthLoginFlowMgr encapsulates interactions with third party
+OAuth providers to support the Authorization Code Flow.
+
+The way to use is:
+
+- call [initiateOAuthLogin(String)](dw.customer.oauth.OAuthLoginFlowMgr.md#initiateoauthloginstring)
+- redirect the user to the returned link
+- when the user authenticates there the server will call back to  a URL configured on the provider's web site
+- when processing the request made from the provider's web site  you have two choices - either call the [obtainAccessToken()](dw.customer.oauth.OAuthLoginFlowMgr.md#obtainaccesstoken)and [obtainUserInfo(String, String)](dw.customer.oauth.OAuthLoginFlowMgr.md#obtainuserinfostring-string)methods one after another separately (gives you more flexibility),  or call the [finalizeOAuthLogin()](dw.customer.oauth.OAuthLoginFlowMgr.md#finalizeoauthlogin)method which internally  calls the other two (simpler to use).
+
+Sample code for using it:
+
+```
+var finalizedResponse : OAuthFinalizedResponse = OAuthLoginFlowMgr.finalizeOAuthLogin();
+var userInfo = finalizedResponse.userInfoResponse.userInfo;
+```
+
+or:
+
+```
+var accessTokenResponse : OAuthAccessTokenResponse = OAuthLoginFlowMgr.obtainAccessToken();
+var userInfoResponse : OAuthUserInfoResponse = OAuthLoginFlowMgr.obtainUserInfo(
+    accessTokenResponse.oauthProviderId, accessTokenResponse.accessToken);
+var userInfo = userInfoResponse.userInfo;
+```
+
+
+
+## Constructor Summary
+
+| Constructor | Description |
+| --- | --- |
+| [OAuthLoginFlowMgr](#oauthloginflowmgr)() |  |
+
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| static [finalizeOAuthLogin](dw.customer.oauth.OAuthLoginFlowMgr.md#finalizeoauthlogin)() | This method works in tandem with the [initiateOAuthLogin(String)](dw.customer.oauth.OAuthLoginFlowMgr.md#initiateoauthloginstring) method. |
+| static [initiateOAuthLogin](dw.customer.oauth.OAuthLoginFlowMgr.md#initiateoauthloginstring)([String](TopLevel.String.md)) | This method works in tandem with another method - [finalizeOAuthLogin()](dw.customer.oauth.OAuthLoginFlowMgr.md#finalizeoauthlogin). |
+| static [obtainAccessToken](dw.customer.oauth.OAuthLoginFlowMgr.md#obtainaccesstoken)() | This method is called internally by [finalizeOAuthLogin()](dw.customer.oauth.OAuthLoginFlowMgr.md#finalizeoauthlogin). |
+| static [obtainUserInfo](dw.customer.oauth.OAuthLoginFlowMgr.md#obtainuserinfostring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | This method is called internally by [finalizeOAuthLogin()](dw.customer.oauth.OAuthLoginFlowMgr.md#finalizeoauthlogin). |
+
+### 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)
+## Constructor Details
+
+### OAuthLoginFlowMgr()
+- OAuthLoginFlowMgr()
+  - : 
+
+
+---
+
+## Method Details
+
+### finalizeOAuthLogin()
+- static finalizeOAuthLogin(): [OAuthFinalizedResponse](dw.customer.oauth.OAuthFinalizedResponse.md)
+  - : This method works in tandem with the [initiateOAuthLogin(String)](dw.customer.oauth.OAuthLoginFlowMgr.md#initiateoauthloginstring) method.
+      After the user has been redirected to the URL returned by that method
+      to the external OAuth2 provider and the user has interacted with the provider's
+      site, the browser is redirected to a URL configured on the provider's web
+      site. This URL should be that of a pipeline that contains
+      a script invoking the finalizeOAuthLogin method.
+      
+      
+      At this point the user has either been authenticated by the external provider
+      or not (forgot password, or simply refused to provide credentials). If the user
+      has been authenticated by the external provider and the provider returns an
+      authentication code, this method exchanges the code for a token and with that
+      token it requests from the provider the user information specified by the
+      configured scope (id, first/last name, email, etc.).
+      
+      
+      
+      The method is aggregation of two other methods - [obtainAccessToken()](dw.customer.oauth.OAuthLoginFlowMgr.md#obtainaccesstoken)
+      and [obtainUserInfo(String, String)](dw.customer.oauth.OAuthLoginFlowMgr.md#obtainuserinfostring-string)
+      and is provided for convenience. You may want to
+      use the two individual methods instead if you need more flexibility.
+      
+      
+      
+      This supports the Authorization Code Flow.
+
+
+    **Returns:**
+    - the user info on success, null otherwise
+
+
+---
+
+### initiateOAuthLogin(String)
+- static initiateOAuthLogin(oauthProviderId: [String](TopLevel.String.md)): [URLRedirect](dw.web.URLRedirect.md)
+  - : This method works in tandem with another method - [finalizeOAuthLogin()](dw.customer.oauth.OAuthLoginFlowMgr.md#finalizeoauthlogin).
+      It starts the process of authentication via an external OAuth2 provider. It
+      takes one parameter - OAuthProviderId (as configured in the system). Outputs
+      an URL pointing to the OAuth2 provider's web page to which the browser should
+      redirect to initiate the actual user authentication or NULL if there is an
+      invalid configuration or an error occurs.
+      The method stores a few key/values in the session
+      ([Session.getPrivacy()](dw.system.Session.md#getprivacy), implementation specific parameters and may change at any time)
+      to be picked up by the [finalizeOAuthLogin()](dw.customer.oauth.OAuthLoginFlowMgr.md#finalizeoauthlogin) method  when the provider redirects back.
+      
+      
+      
+      This supports the Authorization Code Flow.
+
+
+    **Parameters:**
+    - oauthProviderId - the OAuth provider id
+
+    **Returns:**
+    - URL to redirect to
+
+
+---
+
+### obtainAccessToken()
+- static obtainAccessToken(): [OAuthAccessTokenResponse](dw.customer.oauth.OAuthAccessTokenResponse.md)
+  - : This method is called internally by [finalizeOAuthLogin()](dw.customer.oauth.OAuthLoginFlowMgr.md#finalizeoauthlogin).
+      There are customer requests to expose a more granular way of
+      doing the interactions that finalizeOAuthLogin is currently doing
+      with the third party OAuth server to accommodate certain providers.
+      
+      
+      
+      This supports the Authorization Code Flow.
+
+
+    **Returns:**
+    - the access token response
+
+
+---
+
+### obtainUserInfo(String, String)
+- static obtainUserInfo(oauthProviderId: [String](TopLevel.String.md), accessToken: [String](TopLevel.String.md)): [OAuthUserInfoResponse](dw.customer.oauth.OAuthUserInfoResponse.md)
+  - : This method is called internally by [finalizeOAuthLogin()](dw.customer.oauth.OAuthLoginFlowMgr.md#finalizeoauthlogin).
+      There are customer requests to expose a more granular way of
+      doing the interactions that finalizeOAuthLogin is currently doing
+      with the third party OAuth server to accommodate certain providers.
+      
+      
+      
+      This supports the Authorization Code Flow.
+
+
+    **Parameters:**
+    - oauthProviderId - the OAuth provider id
+    - accessToken - the OAuth provider's access token
+
+    **Returns:**
+    - the user info response
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.customer.oauth.OAuthUserInfoResponse.md

@@ -0,0 +1,84 @@
+<!-- prettier-ignore-start -->
+# Class OAuthUserInfoResponse
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.customer.oauth.OAuthUserInfoResponse](dw.customer.oauth.OAuthUserInfoResponse.md)
+
+Contains the response from the third-party OAuth server when
+requesting user info. Refer to the corresponding OAuth provider documentation
+regarding what the format might be (in most cases it would be JSON).
+The data returned would also vary depending on the scope.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [errorStatus](#errorstatus): [String](TopLevel.String.md) `(read-only)` | Returns the error status  In cases of errors - more detailed error information  can be seen in the error log files (specificity of error details vary by OAuth provider). |
+| [userInfo](#userinfo): [String](TopLevel.String.md) `(read-only)` | Returns the user info as a String. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getErrorStatus](dw.customer.oauth.OAuthUserInfoResponse.md#geterrorstatus)() | Returns the error status  In cases of errors - more detailed error information  can be seen in the error log files (specificity of error details vary by OAuth provider). |
+| [getUserInfo](dw.customer.oauth.OAuthUserInfoResponse.md#getuserinfo)() | Returns the user info as a String. |
+
+### 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
+
+### errorStatus
+- errorStatus: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the error status
+      In cases of errors - more detailed error information
+      can be seen in the error log files (specificity of error details vary by OAuth provider).
+
+
+
+---
+
+### userInfo
+- userInfo: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the user info as a String. Refer to the corresponding OAuth provider documentation
+      regarding what the format might be (in most cases it would be JSON).
+      The data returned would also vary depending on the configured 'scope'.
+
+
+
+---
+
+## Method Details
+
+### getErrorStatus()
+- getErrorStatus(): [String](TopLevel.String.md)
+  - : Returns the error status
+      In cases of errors - more detailed error information
+      can be seen in the error log files (specificity of error details vary by OAuth provider).
+
+
+    **Returns:**
+    - the error status
+
+
+---
+
+### getUserInfo()
+- getUserInfo(): [String](TopLevel.String.md)
+  - : Returns the user info as a String. Refer to the corresponding OAuth provider documentation
+      regarding what the format might be (in most cases it would be JSON).
+      The data returned would also vary depending on the configured 'scope'.
+
+
+    **Returns:**
+    - the user info
+
+
+---
+
+<!-- prettier-ignore-end -->