ESPRMUser
Defined in: src/ESPRMUser.ts:27
Represents an authenticated user session. Created by ESPRMAuth.login. Provides static helpers for token management and instance methods (via prototype augmentation) for user profile operations.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMUser(
tokens):ESPRMUser
Defined in: src/ESPRMUser.ts:37
Parameters
Section titled “Parameters”tokens
Section titled “tokens”Access, ID, and refresh tokens from a successful login. Tokens are persisted separately via ESPRMUser.storeTokens.
Returns
Section titled “Returns”ESPRMUser
Properties
Section titled “Properties”userId
Section titled “userId”
staticuserId:string
Defined in: src/ESPRMUser.ts:28
Methods
Section titled “Methods”deleteAccount()
Section titled “deleteAccount()”deleteAccount(
params?):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMUser/DeleteAccount.ts:22
Delete the currently authenticated user’s account.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional parameters for account deletion
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
Success response confirming the deletion
getUserInfo()
Section titled “getUserInfo()”getUserInfo():
Promise<GetUserInfoResponse>
Defined in: src/methods/ESPRMUser/GetUserInfo.ts:20
Fetch the profile information of the currently authenticated user.
Returns
Section titled “Returns”Promise<GetUserInfoResponse>
The user’s profile data
updateUserProfile()
Section titled “updateUserProfile()”updateUserProfile(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMUser/UpdateUserProfile.ts:22
Update the profile of the currently authenticated user.
Parameters
Section titled “Parameters”params
Section titled “params”Profile fields to update
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
Success response confirming the update
clearAllTokens()
Section titled “clearAllTokens()”
staticclearAllTokens():Promise<void>
Defined in: src/ESPRMUser.ts:125
Remove all stored session tokens (access, ID, and refresh). Resolves once storage has been updated.
Returns
Section titled “Returns”Promise<void>
extendSession()
Section titled “extendSession()”
staticextendSession(refreshToken):Promise<string>
Defined in: src/ESPRMUser.ts:98
Extend the current session using a refresh token. Stores the new access and ID tokens on success. Clears all tokens on failure.
Parameters
Section titled “Parameters”refreshToken
Section titled “refreshToken”string
The refresh token from the current session
Returns
Section titled “Returns”Promise<string>
The new access token
getAccessToken()
Section titled “getAccessToken()”
staticgetAccessToken():Promise<string>
Defined in: src/ESPRMUser.ts:60
Retrieve the current access token, refreshing it automatically if expired (or about to expire). Concurrent callers share a single refresh request.
Returns
Section titled “Returns”Promise<string>
The valid access token string
Throws
Section titled “Throws”ESPTokenError if tokens are missing or session cannot be extended
storeTokens()
Section titled “storeTokens()”
staticstoreTokens(tokens):Promise<void>
Defined in: src/ESPRMUser.ts:45
Persist a full token set to the configured storage adapter. Resolves once every token has been written.
Parameters
Section titled “Parameters”tokens
Section titled “tokens”Returns
Section titled “Returns”Promise<void>