Class EmailClient

Index

Constructors

Methods

Properties

Constructors

constructor

new EmailClient(options: BaseClientOptions): EmailClient
Parameters
- options: BaseClientOptions
Returns EmailClient

Methods

get

get(
requestOptions?: EmailClient.RequestOptions,
): HttpResponsePromise<GetEmailFactorSettingsResponseContent>
TODO: Link this endpoint to relevant documentation when available.
Parameters
- OptionalrequestOptions: EmailClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetEmailFactorSettingsResponseContent>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.guardian.factors.email.get()
```

set

set(
request: SetEmailFactorSettingsRequestContent,
requestOptions?: EmailClient.RequestOptions,
): HttpResponsePromise<SetEmailFactorSettingsResponseContent>
TODO: Link this endpoint to relevant documentation when available.
Parameters
- request: SetEmailFactorSettingsRequestContent
- OptionalrequestOptions: EmailClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<SetEmailFactorSettingsResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.guardian.factors.email.set({
        otp_length: 1,
        otp_expiration_time: 1
    })
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>