swe/softgarden-api

An API to the job portal SoftGarden

v1.2.8 2024-10-02 08:18 UTC

Requires

• php: ^7.4 || ^8.0
• ext-curl: *
• ext-json: *
• guzzlehttp/guzzle: ^6 || ^7

MIT

• Smart Web Elements

• api
• softgarden

README

This is an API to simplify your connection to SoftGarden. The class \SWE\SoftGardenApi\Api\SoftGarden contains some methods to get and post some specific data.

Methods

/**
 * @throws GuzzleException
 */
public function getCatalogByType(string $type, string $typeId): string;

/**
 * @throws GuzzleException
 */
public function getCatalogue(string $type): array;

/**
 * @throws GuzzleException
 */
public function getChannels(): ChannelCollection;

/**
 * @throws GuzzleException
 */
public function getJob(string $channelId, int $jobId): Job;

/**
 * @throws GuzzleException
 */
public function getJobBasket(string $channelId): JobSearchResult;

/**
 * @throws GuzzleException
 */
public function getJobQuestions(int $jobId): JobQuestionCollection;

/**
 * @throws GuzzleException
 */
public function getJobs(string $channelId): JobCollection;

/**
 * @return bool
 */
public function isUseAutomaticCatalogueCompletion(): bool;

/**
 * @param bool $useAutomaticCatalogueCompletion
 */
public function setUseAutomaticCatalogueCompletion(bool $useAutomaticCatalogueCompletion): void;

/**
 * @throws GuzzleException
 */
public function searchForJob(string $channelId, string $search = '', string $geoLocation = ''): JobSearchResult;

/**
 * @throws GuzzleException
 */
public function createApplicant(array $data): ApplicantData;

/**
 * @throws GuzzleException
 */
public function applicantExists(array $data): bool;

/**
 * @throws GuzzleException
 */
public function getUserAccessToken(ApplicantData $applicant): string;

/**
 * @throws GuzzleException
 */
public function hasApplied(string $jobId, string $uat): bool;

/**
 * @throws GuzzleException
 */
public function getAllApplications(string $uat, array $queryParameters = []): ApplicationDataCollection;

/**
 * @throws GuzzleException
 */
public function getApplication(string $applicationId, string $uat): ApplicationData;

/**
 * @throws GuzzleException
 */
public function startApplication(string $jobId, string $uat): string;

/**
 * @throws GuzzleException
 */
public function sendApplicationInformation(string $applicationId, string $uat, array $applicationData): void;

/**
 * @throws GuzzleException
 */
public function finalizeApplication(string $applicationId, string $uat, array $applicationData = []): void;

/**
 * @throws GuzzleException
 */
public function deleteApplication(string $applicationId, string $uat): void;

/**
 * @throws GuzzleException
 */
public function withdrawApplication(string $applicationId, string $uat): void;

Return values

ApplicantData

ApplicationData

Channel

Collection

Job

JobQuestion

JobSearchResult

SearchResult

SearchResultConfig

Misc

This API uses Semantic Versioning