Class JobsClient

Index

Accessors

usersExports usersImports verificationEmail errors

Constructors

Methods

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")
```

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