Class DonationAlertsUsersApi

Donation Alerts Users API.

Allows fetching the authorized user.

Hierarchy

BaseApi
- DonationAlertsUsersApi

Index

Methods

getSocketConnectionToken getUser

Methods

getSocketConnectionToken

getSocketConnectionToken(user, rateLimiterOptions?): Promise<string>
Gets the socket connection token of the specified user.

Requires oauth-user-show scope.
Parameters
- user: UserIdResolvable
  
  The ID of the user to get profile for.
- Optional rateLimiterOptions: RateLimiterRequestOptions
  
  The rate limiter options.
Returns Promise<string>

Throws
HttpError if response status code is out of 200-299 range.

Throws
UnregisteredUserError if the user you are trying to get is not registered in authentication provider.

Throws
MissingScopeError if the access token does not have oauth-user-show scope.
- Defined in api/src/api/users/DonationAlertsUsersApi.ts:54

getUser

getUser(user, rateLimiterOptions?): Promise<DonationAlertsUser>
Gets the user profile.

Requires the oauth-user-show scope.
Parameters
- user: UserIdResolvable
  
  The ID of the user to get profile for.
- Optional rateLimiterOptions: RateLimiterRequestOptions
  
  The rate limiter options.
Returns Promise<DonationAlertsUser>

Throws
HttpError if response status code is out of 200-299 range.

Throws
UnregisteredUserError if the user you are trying to get is not registered in authentication provider.

Throws
MissingScopeError if the access token does not have oauth-user-show scope.
- Defined in api/src/api/users/DonationAlertsUsersApi.ts:26

Generated using TypeDoc