Class GACandidates

Hierarchy

GlobalApi
- GACandidates

Index

Constructors

constructor

Properties

config

Methods

Constructors

constructor

new GACandidates(instanceConfig?: IGlobalApiSdkConfig): GACandidates

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

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 createBulkCandidates

createBulkCandidates(body: ICandidateCreateBody, instanceConfig?: IGlobalApiSdkConfig): Promise<IApiResponseObj<{ candidates: ICandidate[]; message: string }>>

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

Static getCandidate

getCandidate(id: string, instanceConfig?: IGlobalApiSdkConfig): Promise<IApiResponseObj<ICandidate>>

- Defined in src/GACandidates.ts:16
Parameters
- id: string
- Optional instanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<ICandidate>>

Static getJobCandidates

getJobCandidates(body: IQueryJobCandidates, instanceConfig?: IGlobalApiSdkConfig): Promise<IApiResponseObj<ICandidate[]>>

- Defined in src/GACandidates.ts:21
Parameters
- body: IQueryJobCandidates
- Optional instanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<ICandidate[]>>

Static moveCandidatesToPhase

moveCandidatesToPhase(body: ICandidateMovePhaseBody, instanceConfig?: IGlobalApiSdkConfig): Promise<IApiResponseObj<unknown>>

- Defined in src/GACandidates.ts:45
Parameters
- body: ICandidateMovePhaseBody
- Optional instanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<unknown>>

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 updateCandidate

updateCandidate(body: indexedObject, instanceConfig?: IGlobalApiSdkConfig): Promise<IApiResponseObj<{ candidate: ICandidate; message: string }>>

- Defined in src/GACandidates.ts:37
Parameters
- body: indexedObject
- Optional instanceConfig: IGlobalApiSdkConfig
Returns Promise<IApiResponseObj<{ candidate: ICandidate; message: string }>>

Generated using TypeDoc