Class GACandidates

Hierarchy (View Summary)

GlobalApi
- GACandidates

Index

Constructors

Properties

Methods

makeApiCall createBulkCandidates getCandidate getJobCandidates moveCandidatesToPhase populateHeaders setConfig updateCandidate

Constructors

constructor

new GACandidates(instanceConfig?: IGlobalApiSdkConfig): GACandidates
Parameters
- OptionalinstanceConfig: IGlobalApiSdkConfig
Returns GACandidates
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`createBulkCandidates

createBulkCandidates(
body: ICandidateCreateBody,
instanceConfig?: IGlobalApiSdkConfig,
): Promise<IApiResponseObj<{ candidates: ICandidate[]; message: string }>>
Parameters
- body: ICandidateCreateBody
- OptionalinstanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<{ candidates: ICandidate[]; message: string }>>
- Defined in src/GACandidates.ts:29

`Static`getCandidate

getCandidate(
id: string,
instanceConfig?: IGlobalApiSdkConfig,
): Promise<IApiResponseObj<ICandidate>>
Parameters
- id: string
- OptionalinstanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<ICandidate>>
- Defined in src/GACandidates.ts:16

`Static`getJobCandidates

getJobCandidates(
body: IQueryJobCandidates,
instanceConfig?: IGlobalApiSdkConfig,
): Promise<IApiResponseObj<ICandidate[]>>
Parameters
- body: IQueryJobCandidates
- OptionalinstanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<ICandidate[]>>
- Defined in src/GACandidates.ts:21

`Static`moveCandidatesToPhase

moveCandidatesToPhase(
body: ICandidateMovePhaseBody,
instanceConfig?: IGlobalApiSdkConfig,
): Promise<IApiResponseObj<unknown>>
Parameters
- body: ICandidateMovePhaseBody
- OptionalinstanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<unknown>>
- Defined in src/GACandidates.ts:45

`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`updateCandidate

updateCandidate(
body: indexedObject,
instanceConfig?: IGlobalApiSdkConfig,
): Promise<IApiResponseObj<{ candidate: ICandidate; message: string }>>
Parameters
- body: indexedObject
- OptionalinstanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<{ candidate: ICandidate; message: string }>>
- Defined in src/GACandidates.ts:37