Class AccountApi

Hierarchy (View Summary)

BaseAPI
- AccountApi

Constructors

constructor

new AccountApi(configuration?: Configuration): AccountApi
Parameters
- configuration: Configuration = DefaultConfig
Returns AccountApi
Inherited from BaseAPI.constructor
- Defined in sdk/runtime.ts:104

Properties

`Protected`configuration

configuration: Configuration = DefaultConfig

Methods

activateAccount

activateAccount(
requestParameters: ActivateAccountRequest,
initOverrides?: any,
): Promise<void>
Activate a new account with the activation code that was sent to the user's email. Activate account
Parameters
- requestParameters: ActivateAccountRequest
- OptionalinitOverrides: any
Returns Promise<void>
- Defined in sdk/apis/AccountApi.ts:154

activateAccountRaw

activateAccountRaw(
requestParameters: ActivateAccountRequest,
initOverrides?: any,
): Promise<ApiResponse<void>>
Activate a new account with the activation code that was sent to the user's email. Activate account
Parameters
- requestParameters: ActivateAccountRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<void>>
- Defined in sdk/apis/AccountApi.ts:122

createApiKey

createApiKey(
requestParameters: CreateApiKeyRequest,
initOverrides?: any,
): Promise<ApiKey>
Generate a new API key associated with a specific device for authentication Create API key
Parameters
- requestParameters: CreateApiKeyRequest
- OptionalinitOverrides: any
Returns Promise<ApiKey>
- Defined in sdk/apis/AccountApi.ts:198

createApiKeyRaw

createApiKeyRaw(
requestParameters: CreateApiKeyRequest,
initOverrides?: any,
): Promise<ApiResponse<ApiKey>>
Generate a new API key associated with a specific device for authentication Create API key
Parameters
- requestParameters: CreateApiKeyRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<ApiKey>>
- Defined in sdk/apis/AccountApi.ts:162

deleteUser

deleteUser(initOverrides?: any): Promise<Success>
Delete user (requires sudo mode) Delete user
Parameters
- OptionalinitOverrides: any
Returns Promise<Success>
- Defined in sdk/apis/AccountApi.ts:233

deleteUserRaw

deleteUserRaw(initOverrides?: any): Promise<ApiResponse<Success>>
Delete user (requires sudo mode) Delete user
Parameters
- OptionalinitOverrides: any
Returns Promise<ApiResponse<Success>>
- Defined in sdk/apis/AccountApi.ts:207

enableSudoMode

enableSudoMode(
requestParameters: EnableSudoModeRequest,
initOverrides?: any,
): Promise<Success>
Enable sudo mode Enable sudo mode
Parameters
- requestParameters: EnableSudoModeRequest
- OptionalinitOverrides: any
Returns Promise<Success>
- Defined in sdk/apis/AccountApi.ts:278

enableSudoModeRaw

enableSudoModeRaw(
requestParameters: EnableSudoModeRequest,
initOverrides?: any,
): Promise<ApiResponse<Success>>
Enable sudo mode Enable sudo mode
Parameters
- requestParameters: EnableSudoModeRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<Success>>
- Defined in sdk/apis/AccountApi.ts:242

forgotPassword

forgotPassword(
requestParameters: ForgotPasswordRequest,
initOverrides?: any,
): Promise<void>
Request a link to reset the password for a registered account. Forgot password
Parameters
- requestParameters: ForgotPasswordRequest
- OptionalinitOverrides: any
Returns Promise<void>
- Defined in sdk/apis/AccountApi.ts:319

forgotPasswordRaw

forgotPasswordRaw(
requestParameters: ForgotPasswordRequest,
initOverrides?: any,
): Promise<ApiResponse<void>>
Request a link to reset the password for a registered account. Forgot password
Parameters
- requestParameters: ForgotPasswordRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<void>>
- Defined in sdk/apis/AccountApi.ts:287

getCookieToken

getCookieToken(initOverrides?: any): Promise<UserCookieToken>
Get a one time use cookie to exchange it for a valid cookie in the web app Get cookie token
Parameters
- OptionalinitOverrides: any
Returns Promise<UserCookieToken>
- Defined in sdk/apis/AccountApi.ts:353

getCookieTokenRaw

getCookieTokenRaw(initOverrides?: any): Promise<ApiResponse<UserCookieToken>>
Get a one time use cookie to exchange it for a valid cookie in the web app Get cookie token
Parameters
- OptionalinitOverrides: any
Returns Promise<ApiResponse<UserCookieToken>>
- Defined in sdk/apis/AccountApi.ts:327

getStats

getStats(initOverrides?: any): Promise<UserStats>
Returns stats about the number of aliases, number of emails forwarded/replied/blocked Get stats
Parameters
- OptionalinitOverrides: any
Returns Promise<UserStats>
- Defined in sdk/apis/AccountApi.ts:388

getStatsRaw

getStatsRaw(initOverrides?: any): Promise<ApiResponse<UserStats>>
Returns stats about the number of aliases, number of emails forwarded/replied/blocked Get stats
Parameters
- OptionalinitOverrides: any
Returns Promise<ApiResponse<UserStats>>
- Defined in sdk/apis/AccountApi.ts:362

getUserInfo

getUserInfo(initOverrides?: any): Promise<UserInfo>
Get user info Get user info
Parameters
- OptionalinitOverrides: any
Returns Promise<UserInfo>
- Defined in sdk/apis/AccountApi.ts:423

getUserInfoRaw

getUserInfoRaw(initOverrides?: any): Promise<ApiResponse<UserInfo>>
Get user info Get user info
Parameters
- OptionalinitOverrides: any
Returns Promise<ApiResponse<UserInfo>>
- Defined in sdk/apis/AccountApi.ts:397

`Protected`isJsonMime

isJsonMime(mime: string | null | undefined): boolean
Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json
Parameters
- mime: string | null | undefined
  MIME (Multipurpose Internet Mail Extensions)
Returns boolean
True if the given MIME is JSON, false otherwise.
Inherited from BaseAPI.isJsonMime
- Defined in sdk/runtime.ts:134

login(requestParameters: LoginRequest, initOverrides?: any): Promise<AuthLogin>
Login using email and password to get an access token. Login
Parameters
- requestParameters: LoginRequest
- OptionalinitOverrides: any
Returns Promise<AuthLogin>
- Defined in sdk/apis/AccountApi.ts:464

loginRaw

loginRaw(
requestParameters: LoginRequest,
initOverrides?: any,
): Promise<ApiResponse<AuthLogin>>
Login using email and password to get an access token. Login
Parameters
- requestParameters: LoginRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<AuthLogin>>
- Defined in sdk/apis/AccountApi.ts:432

logout

logout(initOverrides?: any): Promise<UserInfo>
Log out user Logout
Parameters
- OptionalinitOverrides: any
Returns Promise<UserInfo>
- Defined in sdk/apis/AccountApi.ts:499

logoutRaw

logoutRaw(initOverrides?: any): Promise<ApiResponse<UserInfo>>
Log out user Logout
Parameters
- OptionalinitOverrides: any
Returns Promise<ApiResponse<UserInfo>>
- Defined in sdk/apis/AccountApi.ts:473

mfa

mfa(requestParameters: MfaRequest, initOverrides?: any): Promise<AuthMfa>
Authenticate using MFA MFA authentication
Parameters
- requestParameters: MfaRequest
- OptionalinitOverrides: any
Returns Promise<AuthMfa>
- Defined in sdk/apis/AccountApi.ts:540

mfaRaw

mfaRaw(
requestParameters: MfaRequest,
initOverrides?: any,
): Promise<ApiResponse<AuthMfa>>
Authenticate using MFA MFA authentication
Parameters
- requestParameters: MfaRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<AuthMfa>>
- Defined in sdk/apis/AccountApi.ts:508

reactivateAccount

reactivateAccount(
requestParameters: ReactivateAccountRequest,
initOverrides?: any,
): Promise<void>
Request a new activation code for an account that was already registered, but not activated yet. Reactivate account
Parameters
- requestParameters: ReactivateAccountRequest
- OptionalinitOverrides: any
Returns Promise<void>
- Defined in sdk/apis/AccountApi.ts:581

reactivateAccountRaw

reactivateAccountRaw(
requestParameters: ReactivateAccountRequest,
initOverrides?: any,
): Promise<ApiResponse<void>>
Request a new activation code for an account that was already registered, but not activated yet. Reactivate account
Parameters
- requestParameters: ReactivateAccountRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<void>>
- Defined in sdk/apis/AccountApi.ts:549

registerAccount

registerAccount(
requestParameters: RegisterAccountRequest,
initOverrides?: any,
): Promise<void>
Register a new account Register account
Parameters
- requestParameters: RegisterAccountRequest
- OptionalinitOverrides: any
Returns Promise<void>
- Defined in sdk/apis/AccountApi.ts:621

registerAccountRaw

registerAccountRaw(
requestParameters: RegisterAccountRequest,
initOverrides?: any,
): Promise<ApiResponse<void>>
Register a new account Register account
Parameters
- requestParameters: RegisterAccountRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<void>>
- Defined in sdk/apis/AccountApi.ts:589

`Protected`request

request(context: RequestOpts, initOverrides?: any): Promise<any>
Parameters
- context: RequestOpts
- OptionalinitOverrides: any
Returns Promise<any>
Inherited from BaseAPI.request
- Defined in sdk/runtime.ts:141

updateUserInfo

updateUserInfo(
requestParameters: UpdateUserInfoRequest,
initOverrides?: any,
): Promise<UserInfo>
Update user info Update user info
Parameters
- requestParameters: UpdateUserInfoRequest
- OptionalinitOverrides: any
Returns Promise<UserInfo>
- Defined in sdk/apis/AccountApi.ts:665

updateUserInfoRaw

updateUserInfoRaw(
requestParameters: UpdateUserInfoRequest,
initOverrides?: any,
): Promise<ApiResponse<UserInfo>>
Update user info Update user info
Parameters
- requestParameters: UpdateUserInfoRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<UserInfo>>
- Defined in sdk/apis/AccountApi.ts:629

withMiddleware

withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in sdk/runtime.ts:108

withPostMiddleware

withPostMiddleware<T extends BaseAPI>(
    this: T,
    ...postMiddlewares: (
        ((context: ResponseContext) => Promise<any>)
        | undefined
    )[],
): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...postMiddlewares: (((context: ResponseContext) => Promise<any>) | undefined)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in sdk/runtime.ts:119

withPreMiddleware

withPreMiddleware<T extends BaseAPI>(
    this: T,
    ...preMiddlewares: (
        ((context: RequestContext) => Promise<void | FetchParams>)
        | undefined
    )[],
): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...preMiddlewares: (((context: RequestContext) => Promise<void | FetchParams>) | undefined)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in sdk/runtime.ts:114