Class Jobs

Index

Accessors

usersExports usersImports verificationEmail errors

Constructors

Methods

get _getAuthorizationHeader

Properties

_options _usersExports _usersImports _verificationEmail _errors

Accessors

usersExports

get usersExports(): UsersExports
Returns UsersExports

usersImports

get usersImports(): UsersImports
Returns UsersImports

verificationEmail

get verificationEmail(): VerificationEmail
Returns VerificationEmail

errors

get errors(): Errors
Returns Errors

Constructors

constructor

new Jobs(_options: Jobs.Options): Jobs
Parameters
- _options: Jobs.Options
Returns Jobs

Methods

get

get(
id: string,
requestOptions?: Jobs.RequestOptions,
): HttpResponsePromise<GetJobResponseContent>
Retrieves a job. Useful to check its status.
Parameters
- id: string
  ID of the job.
- OptionalrequestOptions: Jobs.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")
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: Jobs.Options

`Protected`_usersExports

_usersExports: undefined | UsersExports

`Protected`_usersImports

_usersImports: undefined | UsersImports

`Protected`_verificationEmail

_verificationEmail: undefined | VerificationEmail

`Protected`_errors

_errors: undefined | Errors