• management
• SDK
• JobsClient

Class JobsClient

Index

Accessors

usersExportsusersImportsverificationEmailerrors

Constructors

constructor

Methods

get

Properties

_options_usersExports_usersImports_verificationEmail_errors

Accessors

usersExports

get usersExports(): UsersExportsClient

Returns UsersExportsClient

usersImports

get usersImports(): UsersImportsClient

Returns UsersImportsClient

verificationEmail

get verificationEmail(): VerificationEmailClient

Returns VerificationEmailClient

errors

get errors(): ErrorsClient

Returns ErrorsClient

Constructors

constructor

new JobsClient(options: BaseClientOptions): JobsClient

Parameters

• options: BaseClientOptions

Returns JobsClient

Methods

get

get(
id: string,
requestOptions?: JobsClient.RequestOptions,
): HttpResponsePromise<GetJobResponseContent>

Retrieves a job. Useful to check its status.

Parameters

• id: string

ID of the job.

• OptionalrequestOptions: JobsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetJobResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.jobs.get("id")Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Protected_usersExports

_usersExports: UsersExportsClient | undefined

Protected_usersImports

_usersImports: UsersImportsClient | undefined

Protected_verificationEmail

_verificationEmail: VerificationEmailClient | undefined

Protected_errors

_errors: ErrorsClient | undefined

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Accessors usersExportsusersImportsverificationEmailerrors Constructors constructor Methods get Properties _options_usersExports_usersImports_verificationEmail_errors