Class GAJobs

Hierarchy (View Summary)

GlobalApi
- GAJobs

Index

Constructors

Properties

Methods

makeApiCall createJob createJobCandidatesWithTemplate createJobWithCandidates getJob getJobs getJobsWithIds populateHeaders setConfig updateJob

Constructors

constructor

new GAJobs(instanceConfig?: IGlobalApiSdkConfig): GAJobs
Parameters
- OptionalinstanceConfig: IGlobalApiSdkConfig
Returns GAJobs
Inherited from GlobalApi.constructor
- Defined in src/GlobalAPI.ts:40

Properties

`Static`config

config: IGlobalApiSdkConfig

Methods

`Protected`makeApiCall

makeApiCall(action: string, data?: indexedObject): IGlobalApiCallConfig
Parameters
- action: string
- Optionaldata: indexedObject
Returns IGlobalApiCallConfig
Inherited from GlobalApi.makeApiCall
- Defined in src/GlobalAPI.ts:52

`Static`createJob

createJob(
body: indexedObject,
instanceConfig?: IGlobalApiSdkConfig,
): Promise<IApiResponseObj<IJob>>
Parameters
- body: indexedObject
- OptionalinstanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<IJob>>
- Defined in src/GAJobs.ts:46

`Static`createJobCandidatesWithTemplate

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

`Static`createJobWithCandidates

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

`Static`getJob

getJob(
id: string,
instanceConfig?: IGlobalApiSdkConfig,
): Promise<IApiResponseObj<IJob>>
Parameters
- id: string
- OptionalinstanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<IJob>>
- Defined in src/GAJobs.ts:25

`Static`getJobs

getJobs(instanceConfig?: IGlobalApiSdkConfig): Promise<IApiResponseObj<IJob[]>>
Parameters
- OptionalinstanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<IJob[]>>
- Defined in src/GAJobs.ts:15

`Static`getJobsWithIds

getJobsWithIds(
ids: string[],
instanceConfig?: IGlobalApiSdkConfig,
): Promise<IApiResponseObj<IJob[]>>
Parameters
- ids: string[]
- OptionalinstanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<IJob[]>>
- Defined in src/GAJobs.ts:20

`Static`populateHeaders

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

`Static`setConfig

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

`Static`updateJob

updateJob(
body: indexedObject,
instanceConfig?: IGlobalApiSdkConfig,
): Promise<IApiResponseObj<IJob>>
Parameters
- body: indexedObject
- OptionalinstanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<IJob>>
- Defined in src/GAJobs.ts:51

Class GAJobs

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GAJobs

Properties

Staticconfig

Methods

ProtectedmakeApiCall

Parameters

Returns IGlobalApiCallConfig

StaticcreateJob

Parameters

Returns Promise<IApiResponseObj<IJob>>

StaticcreateJobCandidatesWithTemplate

Parameters

Returns Promise< IApiResponseObj< { candidates: ICandidate[]; job: IJob; message: string }, >,>

StaticcreateJobWithCandidates

Parameters

Returns Promise< IApiResponseObj< { candidates: ICandidate[]; job: IJob; message: string }, >,>

StaticgetJob

Parameters

Returns Promise<IApiResponseObj<IJob>>

StaticgetJobs

Parameters

Returns Promise<IApiResponseObj<IJob[]>>

StaticgetJobsWithIds

Parameters

Returns Promise<IApiResponseObj<IJob[]>>

StaticpopulateHeaders

Parameters

Returns IGlobalApiHeaders

StaticsetConfig

Parameters

Returns void

StaticupdateJob

Parameters

Returns Promise<IApiResponseObj<IJob>>

Settings

On This Page

`Static`config

`Protected`makeApiCall

`Static`createJob

`Static`createJobCandidatesWithTemplate

Returns Promise<
IApiResponseObj<
{ candidates: ICandidate[]; job: IJob; message: string },
>,
>

`Static`createJobWithCandidates

Returns Promise<
IApiResponseObj<
{ candidates: ICandidate[]; job: IJob; message: string },
>,
>

`Static`getJob

`Static`getJobs

`Static`getJobsWithIds

`Static`populateHeaders

`Static`setConfig

`Static`updateJob