Skip to content

Class: default

client/apis/TwoStepVerificationAPI.default

Hierarchy

↳ default

Table of contents

Constructors

Properties

Methods

Constructors

constructor

+ new default(client: default): default

Parameters:

Name Type
client default

Returns: default

Inherited from: default

Defined in: client/apis/TwoStepVerificationAPI.ts:76

Properties

client

• client: default

Inherited from: default.client

Defined in: client/apis/BaseAPI.ts:25

options

• options: BaseAPIOptions

Inherited from: default.options

Defined in: client/apis/BaseAPI.ts:26

Methods

disableAuthenticator

▸ disableAuthenticator(options: AuthenticatorDisableOptions): Promise<unknown>

Parameters:

Name Type
options AuthenticatorDisableOptions

Returns: Promise<unknown>

Defined in: client/apis/TwoStepVerificationAPI.ts:121

disableEmail

▸ disableEmail(options: EmailDisableOptions): Promise<unknown>

Parameters:

Name Type
options EmailDisableOptions

Returns: Promise<unknown>

Defined in: client/apis/TwoStepVerificationAPI.ts:185

enableAuthenticator

▸ enableAuthenticator(options: AuthenticatorEnableOptions): Promise<AuthenticatorEnable>

Parameters:

Name Type
options AuthenticatorEnableOptions

Returns: Promise<AuthenticatorEnable>

Defined in: client/apis/TwoStepVerificationAPI.ts:134

enableEmail

▸ enableEmail(options: EmailEnableOptions): Promise<unknown>

Parameters:

Name Type
options EmailEnableOptions

Returns: Promise<unknown>

Defined in: client/apis/TwoStepVerificationAPI.ts:198

getConfiguration

▸ getConfiguration(options?: GetTwoStepVerificationMetaDataOptions): Promise<GetTwoStepVerificationMetaData>

Parameters:

Name Type
options? GetTwoStepVerificationMetaDataOptions

Returns: Promise<GetTwoStepVerificationMetaData>

Defined in: client/apis/TwoStepVerificationAPI.ts:96

getMetaData

▸ getMetaData(options: GetTwoStepVerificationMetaDataOptions): Promise<GetTwoStepVerificationMetaData>

Parameters:

Name Type
options GetTwoStepVerificationMetaDataOptions

Returns: Promise<GetTwoStepVerificationMetaData>

Defined in: client/apis/TwoStepVerificationAPI.ts:84

request

▸ request(options: BaseAPIRequestOptions): Promise<RESTResponseDataType>

Parameters:

Name Type
options BaseAPIRequestOptions

Returns: Promise<RESTResponseDataType>

Inherited from: default

Defined in: client/apis/BaseAPI.ts:33

sendEmailCode

▸ sendEmailCode(options: EmailSendCodeOptions): Promise<EmailSendCode>

Parameters:

Name Type
options EmailSendCodeOptions

Returns: Promise<EmailSendCode>

Defined in: client/apis/TwoStepVerificationAPI.ts:160

verifyAuthenticatorSetup

▸ verifyAuthenticatorSetup(options: AuthenticatorVerifySetupOptions): Promise<unknown>

Parameters:

Name Type
options AuthenticatorVerifySetupOptions

Returns: Promise<unknown>

Defined in: client/apis/TwoStepVerificationAPI.ts:147

verifyEmail

▸ verifyEmail(options: EmailVerifyOptions): Promise<EmailVerify>

Parameters:

Name Type
options EmailVerifyOptions

Returns: Promise<EmailVerify>

Defined in: client/apis/TwoStepVerificationAPI.ts:172

verifyWithAuthenticator

▸ verifyWithAuthenticator(options: AuthenticatorVerifyOptions): Promise<AuthenticatorVerify>

Parameters:

Name Type
options AuthenticatorVerifyOptions

Returns: Promise<AuthenticatorVerify>

Defined in: client/apis/TwoStepVerificationAPI.ts:108