Skip to main content

Class: VacancyClient

API client to make requests to the Vacancy API.

Constructors​

new VacancyClient()​

new VacancyClient(baseUrl, backend): VacancyClient

Parameters​

• baseUrl: string

• backend: HttpBackend= fetchBackend

Returns​

VacancyClient

Properties​

backend​

private readonly backend: HttpBackend = fetchBackend

baseUrl​

private readonly baseUrl: string

Methods​

assignEmptyArraysOnNullOrUndefinedListFieldsForSimpleVacancyDetailsModel()​

private assignEmptyArraysOnNullOrUndefinedListFieldsForSimpleVacancyDetailsModel(model): SimpleVacancyDetails

Parameters​

• model: SimpleVacancyDetails

Returns​

SimpleVacancyDetails

assignEmptyArraysOnNullOrUndefinedListFieldsForVacancyDetailsModel()​

private assignEmptyArraysOnNullOrUndefinedListFieldsForVacancyDetailsModel(model): VacancyDetails

Parameters​

• model: VacancyDetails

Returns​

VacancyDetails

createCandidate()​

createCandidate(customerId, language, candidate, attachments, image?): Promise <CandidateResult>

Creates a new candidate for a vacancy.

Parameters​

• customerId: string

Your customer id.

• language: string

The language to request.

• candidate: CandidateUpload

The candidate to add to the vacancy.

• attachments: File[]

Attachments to upload.

• image?: File

Candidate image.

Returns​

Promise <CandidateResult>

getApplicationFormType()​

getApplicationFormType(customerId, language, applicationFormType): Promise <ApplicationFormType>

Returns the setup for a Vacancy.

Parameters​

• customerId: string

Your customer id.

• language: string

The language to request.

• applicationFormType: string= 'Standard'

The application form type to request.

Returns​

Promise <ApplicationFormType>

getApplicationFormTypePath()​

private getApplicationFormTypePath(customerId): string

Parameters​

• customerId: string

Returns​

string

getBasePath()​

private getBasePath(customerId): string

Parameters​

• customerId: string

Returns​

string

getCandidatePath()​

private getCandidatePath(customerId): string

Parameters​

• customerId: string

Returns​

string

getConfigurationPath()​

private getConfigurationPath(customerId): string

Parameters​

• customerId: string

Returns​

string

getSimpleVacancyList()​

getSimpleVacancyList(customerId, language, filtersAndConfiguration?): Promise <SimpleVacancyDetails[]>

Returns a less detailed list of vacancies.

Parameters​

• customerId: string

Your customer id.

• language: string

The language to request.

• filtersAndConfiguration?: VacancyListFilters & VacancyListConfiguration

Filters and configuration to apply to the request.

Returns​

Promise <SimpleVacancyDetails[]>

getSimpleVacancyListPath()​

private getSimpleVacancyListPath(customerId): string

Parameters​

• customerId: string

Returns​

string

getVacancyDetails()​

getVacancyDetails(customerId, id, language, filters?): Promise <VacancyDetails>

Returns a single vacancy.

Parameters​

• customerId: string

Your customer id.

• id: string

The id of the vacancy.

• language: string

The language to request.

• filters?: VacancyDetailsFilters

The filters to apply to the request.

Returns​

Promise <VacancyDetails>

getVacancyDetailsConfiguration()​

getVacancyDetailsConfiguration(customerId, language): Promise <VacancyDetailsConfiguration>

Returns the site settings for Vacancy.

Parameters​

• customerId: string

Your customer id.

• language: string

The language to request.

Returns​

Promise <VacancyDetailsConfiguration>

getVacancyDetailsConfigurationPath()​

private getVacancyDetailsConfigurationPath(customerId): string

Parameters​

• customerId: string

Returns​

string

getVacancyList()​

getVacancyList(customerId, language, filtersAndConfiguration?): Promise <VacancyDetails[]>

Returns a detailed list of vacancies.

The result of this API should be cached and reused.

Parameters​

• customerId: string

Your customer id.

• language: string

The language to request.

• filtersAndConfiguration?: VacancyListFilters & VacancyListConfiguration

Filters and configuration to apply to the request.

Returns​

Promise <VacancyDetails[]>

getVacancyListConfiguration()​

getVacancyListConfiguration(customerId, language): Promise <VacancyListConfiguration>

Returns the site settings for Vacancy List.

Parameters​

• customerId: string

Your customer id.

• language: string

The language to request.

Returns​

Promise <VacancyListConfiguration>

getVacancyListConfigurationPath()​

private getVacancyListConfigurationPath(customerId): string

Parameters​

• customerId: string

Returns​

string

getVacancyListPath()​

private getVacancyListPath(customerId): string

Parameters​

• customerId: string

Returns​

string

mapDeprecatedVacancyDetailsFields()​

private mapDeprecatedVacancyDetailsFields(model): VacancyDetails

Parameters​

• model: VacancyDetails

Returns​

VacancyDetails

prepareSimpleVacancyDetailsModel()​

private prepareSimpleVacancyDetailsModel(model): SimpleVacancyDetails

Parameters​

• model: SimpleVacancyDetails

Returns​

SimpleVacancyDetails

prepareVacancyDetailsModel()​

private prepareVacancyDetailsModel(model): VacancyDetails

Parameters​

• model: VacancyDetails

Returns​

VacancyDetails

setDefaultFilter()​

private setDefaultFilter<T>(input): T

Type parameters​

• T extends VacancyListFilters

Parameters​

• input: undefined | T

Returns​

T