Class GAJobs

Hierarchy

GlobalApi
- GAJobs

Index

Constructors

constructor

Properties

config

Methods

Constructors

constructor

new GAJobs(instanceConfig?: IGlobalApiSdkConfig): GAJobs

Inherited from GlobalApi.constructor
- Defined in src/GlobalAPI.ts:39
Parameters
- Optional instanceConfig: IGlobalApiSdkConfig
Returns GAJobs

Properties

Static config

config: IGlobalApiSdkConfig

Methods

Protected makeApiCall

makeApiCall(action: string, data?: indexedObject): IGlobalApiCallConfig

Inherited from GlobalApi.makeApiCall
- Defined in src/GlobalAPI.ts:51
Parameters
- action: string
- Optional data: indexedObject
Returns IGlobalApiCallConfig

Static createJob

createJob(body: indexedObject, instanceConfig?: IGlobalApiSdkConfig): Promise<IApiResponseObj<IJob>>

- Defined in src/GAJobs.ts:46
Parameters
- body: indexedObject
- Optional instanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<IJob>>

Static createJobCandidatesWithTemplate

createJobCandidatesWithTemplate(body: IJobCreateWithTemplateBody, instanceConfig?: IGlobalApiSdkConfig): Promise<IApiResponseObj<{ candidates: ICandidate[]; job: IJob; message: string }>>

- Defined in src/GAJobs.ts:30
Parameters
- body: IJobCreateWithTemplateBody
- Optional instanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<{ candidates: ICandidate[]; job: IJob; message: string }>>

Static createJobWithCandidates

createJobWithCandidates(body: IJobCreateWithCandidatesBody, instanceConfig?: IGlobalApiSdkConfig): Promise<IApiResponseObj<{ candidates: ICandidate[]; job: IJob; message: string }>>

- Defined in src/GAJobs.ts:38
Parameters
- body: IJobCreateWithCandidatesBody
- Optional instanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<{ candidates: ICandidate[]; job: IJob; message: string }>>

Static getJob

getJob(id: string, instanceConfig?: IGlobalApiSdkConfig): Promise<IApiResponseObj<IJob>>

- Defined in src/GAJobs.ts:25
Parameters
- id: string
- Optional instanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<IJob>>

Static getJobs

getJobs(instanceConfig?: IGlobalApiSdkConfig): Promise<IApiResponseObj<IJob[]>>

- Defined in src/GAJobs.ts:15
Parameters
- Optional instanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<IJob[]>>

Static getJobsWithIds

getJobsWithIds(ids: string[], instanceConfig?: IGlobalApiSdkConfig): Promise<IApiResponseObj<IJob[]>>

- Defined in src/GAJobs.ts:20
Parameters
- ids: string[]
- Optional instanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<IJob[]>>

Static populateHeaders

populateHeaders(config: IGlobalApiSdkConfig): IGlobalApiHeaders

Inherited from GlobalApi.populateHeaders
- Defined in src/GlobalAPI.ts:23
Parameters
- config: IGlobalApiSdkConfig
Returns IGlobalApiHeaders

Static setConfig

setConfig(config: IGlobalApiSdkConfig): void

Inherited from GlobalApi.setConfig
- Defined in src/GlobalAPI.ts:35
Parameters
- config: IGlobalApiSdkConfig
Returns void

Static updateJob

updateJob(body: indexedObject, instanceConfig?: IGlobalApiSdkConfig): Promise<IApiResponseObj<IJob>>

- Defined in src/GAJobs.ts:51
Parameters
- body: indexedObject
- Optional instanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<IJob>>

Generated using TypeDoc