Class OtpApi

OtpApi - object-oriented interface export OtpApi

Hierarchy (view full)

BaseAPI
- OtpApi

Index

Constructors

Properties

axios basePath configuration

Methods

Constructors

constructor

new OtpApi(configuration?, basePath?, axios?): OtpApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns OtpApi
Inherited from BaseAPI.constructor
- Defined in src/api/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

apiOtpSendPost

apiOtpSendPost(auth0OtpGenerateDeets?, options?): Promise<AxiosResponse<void, any>>
summary Sends a one-time passcode (OTP) to the provided email address.
Parameters
- Optionalauth0OtpGenerateDeets: Auth0OtpGenerateDeets
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof OtpApi
- Defined in src/api/api.ts:22476