benlumley/peoplehr-client

PHP Client for People HR (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Maintainers

Details

github.com/benlumley/peoplehr-client

Homepage

Source

Issues

Installs: 8

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

dev-master 2025-01-22 16:36 UTC

Requires

Requires (Dev)

MIT 10d505e05b0738b8f252ac8f9f560b34c4b51ad5

phprestapiclientsdkopenapiopenapitoolsopenapi-generatorpeoplehr

This package is auto-updated.

Last update: 2025-06-22 17:34:22 UTC

README

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

For more information, please visit https://www.peoplehr.com/.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/PeopleHR/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');




$apiInstance = new PeopleHR\Api\ApplicantApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \PeopleHR\Model\CheckDuplicateApplicantParameter(); // \PeopleHR\Model\CheckDuplicateApplicantParameter

try {
    $result = $apiInstance->applicantCheckDuplicateApplicantPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicantApi->applicantCheckDuplicateApplicantPost: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.peoplehr.net/v3.1

Class Method HTTP request Description
ApplicantApi applicantCheckDuplicateApplicantPost POST /Applicant - CheckDuplicateApplicant Check duplicate applicant
ApplicantApi applicantCreateNewApplicantPost POST /Applicant - CreateNewApplicant Create New Applicant
ApplicantApi applicantUploadapplicantdocumentPost POST /Applicant - uploadapplicantdocument upload applicant document
BackgroundCheckApi backgroundCheckAddBackgroundCheckDetailPost POST /Background Check - AddBackgroundCheckDetail Add Background Check Detail
BackgroundCheckApi backgroundCheckDeleteBackgroundCheckDetailPost POST /Background Check - DeleteBackgroundCheckDetail Delete Background Check Detail
BackgroundCheckApi backgroundCheckGetBackgroundCheckDetailByEmployeeIdPost POST /Background Check - GetBackgroundCheckDetailByEmployeeId Get Background Check Detail By EmployeeId
BackgroundCheckApi backgroundCheckUpdateBackgroundCheckDetailPost POST /Background Check - UpdateBackgroundCheckDetail Update Background Check Detail
EmailTransactionApi emailTransactionEmailInboxPost POST /Email Transaction - EmailInbox Email Inbox
EmployeeApi employeeAddEmployeeImagePost POST /Employee - AddEmployeeImage Add Employee Image By Id
EmployeeApi employeeCheckAuthenticationPost POST /Employee - CheckAuthentication Check Authentication
EmployeeApi employeeCreateNewEmployeePost POST /Employee - CreateNewEmployee Create New Employee
EmployeeApi employeeGetAllEmployeeDetailPost POST /Employee - GetAllEmployeeDetail Get All Employee Detail
EmployeeApi employeeGetEmployeeDetailByIdPost POST /Employee - GetEmployeeDetailById Get Employee Detail By Id
EmployeeApi employeeMarkAsLeaverByIdPost POST /Employee - MarkAsLeaverById Mark As Leaver By Id
EmployeeApi employeeUpdateEmployeeDetailPost POST /Employee - UpdateEmployeeDetail Update Employee Details
EmployeeApi employeeUpdateEmployeeIdPost POST /Employee - UpdateEmployeeId Update Employee Id
EmployeeAbsenceApi employeeAbsenceAddAbsencePost POST /EmployeeAbsence - AddAbsence Add Absence
EmployeeAbsenceApi employeeAbsenceDeleteAbsencePost POST /EmployeeAbsence - DeleteAbsence Delete Absence
EmployeeAbsenceApi employeeAbsenceGetAbsenceDetailPost POST /EmployeeAbsence - GetAbsenceDetail Get Absence Detail
EmployeeAbsenceApi employeeAbsenceUpdateAbsencePost POST /EmployeeAbsence - UpdateAbsence Update Absence
EmployeeAppraisalApi employeeAppraisalAddNewAppraisalPost POST /EmployeeAppraisal - AddNewAppraisal Add New Appraisal
EmployeeAppraisalApi employeeAppraisalDeleteAppraisalPost POST /EmployeeAppraisal - DeleteAppraisal Delete Appraisal
EmployeeAppraisalApi employeeAppraisalGetByAppraisalIdPost POST /EmployeeAppraisal - GetByAppraisalId Get By Appraisal Id
EmployeeAppraisalApi employeeAppraisalGetByEmployeeIdPost POST /EmployeeAppraisal - GetByEmployeeId Get By Employee Id
EmployeeAppraisalApi employeeAppraisalUpdateAppraisalPost POST /EmployeeAppraisal - UpdateAppraisal Update Appraisal
EmployeeBenefitApi employeeBenefitAddNewBenefitPost POST /EmployeeBenefit - AddNewBenefit Add New Benefit
EmployeeBenefitApi employeeBenefitDeleteBenefitPost POST /EmployeeBenefit - DeleteBenefit Delete Benefit
EmployeeBenefitApi employeeBenefitGetBenefitByBenefitIdPost POST /EmployeeBenefit - GetBenefitByBenefitId Get By Benefit Id
EmployeeBenefitApi employeeBenefitGetBenefitByEmployeeIdPost POST /EmployeeBenefit - GetBenefitByEmployeeId Get Benefit By EmployeeId Id
EmployeeBenefitApi employeeBenefitUpdateBenefitPost POST /EmployeeBenefit - UpdateBenefit Update Benefit
EmployeeCPDApi employeeCPDAddNewCPDPost POST /Employee CPD - AddNewCPD Add new CPD
EmployeeCPDApi employeeCPDDeleteCPDPost POST /Employee CPD - DeleteCPD Delete CPD
EmployeeCPDApi employeeCPDGetByCPDIdPost POST /Employee CPD - GetByCPDId Get By CPDId
EmployeeCPDApi employeeCPDGetCPDByEmployeeIdPost POST /Employee CPD - GetCPDByEmployeeId Get CPD By EmployeeId
EmployeeCPDApi employeeCPDUpdateCPDPost POST /Employee CPD - UpdateCPD Update CPD
EmployeeCustomScreenApi employeeCustomScreenAddNewCustomScreenTransactionPost POST /Employee Custom Screen - AddNewCustomScreenTransaction Add New Custom Screen Transaction
EmployeeCustomScreenApi employeeCustomScreenDeleteCustomScreenTransactionPost POST /Employee Custom Screen - DeleteCustomScreenTransaction Delete Custom Screen Transaction
EmployeeCustomScreenApi employeeCustomScreenGetByCustomScreenTransactionIdPost POST /Employee Custom Screen - GetByCustomScreenTransactionId Get By Custom Screen Transaction Id
EmployeeCustomScreenApi employeeCustomScreenGetCustomScreenByEmployeeIdPost POST /Employee Custom Screen - GetCustomScreenByEmployeeId Get Custom Screen By Employee Id
EmployeeCustomScreenApi employeeCustomScreenGetCustomScreenDetailPost POST /Employee Custom Screen - GetCustomScreenDetail Get Custom Screen Detail
EmployeeCustomScreenApi employeeCustomScreenUpdateCustomScreenTransactionPost POST /Employee Custom Screen - UpdateCustomScreenTransaction Update Custom Screen Transaction
EmployeeDocumentApi employeeDocumentGetAllDocumentPost POST /EmployeeDocument - GetAllDocument Get All Document
EmployeeDocumentApi employeeDocumentGetDocumentByIdPost POST /EmployeeDocument - GetDocumentById Get Document By Id
EmployeeDocumentApi employeeDocumentUploadEmployeeDocumentPost POST /EmployeeDocument - UploadEmployeeDocument Upload Employee Document
EmployeeDrivingApi employeeDrivingAddNewDrivingLicensePost POST /Employee Driving - AddNewDrivingLicense Add New Driving License
EmployeeDrivingApi employeeDrivingDeleteDrivingLicensePost POST /Employee Driving - DeleteDrivingLicense Delete Driving License
EmployeeDrivingApi employeeDrivingGetDrivingLicenseByDrivingIdPost POST /Employee Driving - GetDrivingLicenseByDrivingId Get Driving License By Driving Id
EmployeeDrivingApi employeeDrivingGetDrivingLicenseByEmployeeIdPost POST /Employee Driving - GetDrivingLicenseByEmployeeId Get Driving License By Employee Id
EmployeeDrivingApi employeeDrivingUpdateDrivingLicensePost POST /Employee Driving - UpdateDrivingLicense Update Driving License
EmployeeHolidayApi employeeHolidayAddNewHolidayPost POST /Employee Holiday - AddNewHoliday Add New Holiday
EmployeeHolidayApi employeeHolidayDeleteHolidayPost POST /Employee Holiday - DeleteHoliday Delete holiday
EmployeeHolidayApi employeeHolidayGetHolidayDetailPost POST /Employee Holiday - GetHolidayDetail Get Holiday Detail
EmployeeHolidayApi employeeHolidayUpdateHolidayPost POST /Employee Holiday - UpdateHoliday Update Holiday
EmployeeProjectTimesheetApi employeeProjectTimesheetAddNewProjectPost POST /Employee Project Timesheet - AddNewProject Add New Project
EmployeeProjectTimesheetApi employeeProjectTimesheetAddNewProjectTaskDetailPost POST /Employee Project Timesheet - AddNewProjectTaskDetail Add New Project Task Detail
EmployeeProjectTimesheetApi employeeProjectTimesheetAddNewProjectTaskPost POST /Employee Project Timesheet - AddNewProjectTask Add New Project Task
EmployeeProjectTimesheetApi employeeProjectTimesheetCreateProjectTimesheetPost POST /Employee Project Timesheet - CreateProjectTimesheet Create project timesheet
EmployeeProjectTimesheetApi employeeProjectTimesheetDeleteProjectTimesheetPost POST /Employee Project Timesheet - DeleteProjectTimesheet Delete project timesheet
EmployeeProjectTimesheetApi employeeProjectTimesheetEditProjectPost POST /Employee Project Timesheet - EditProject Edit Project
EmployeeProjectTimesheetApi employeeProjectTimesheetEditProjectTaskDetailPost POST /Employee Project Timesheet - EditProjectTaskDetail Edit Project Task Detail
EmployeeProjectTimesheetApi employeeProjectTimesheetEditProjectTaskPost POST /Employee Project Timesheet - EditProjectTask Edit Project Task
EmployeeProjectTimesheetApi employeeProjectTimesheetGetAllProjectTaskDetailPost POST /Employee Project Timesheet - GetAllProjectTaskDetail Get All Project Task Detail
EmployeeProjectTimesheetApi employeeProjectTimesheetGetAllProjectTaskPost POST /Employee Project Timesheet - GetAllProjectTask Get All Project Task
EmployeeProjectTimesheetApi employeeProjectTimesheetGetAllTimesheetProjectPost POST /Employee Project Timesheet - GetAllTimesheetProject Get All Timesheet Project
EmployeeProjectTimesheetApi employeeProjectTimesheetGetProjectTimesheetByTransactionIdPost POST /Employee Project Timesheet - GetProjectTimesheetByTransactionId Get Project Timesheet By TransactionId
EmployeeProjectTimesheetApi employeeProjectTimesheetGetProjectTimesheetDetailPost POST /Employee Project Timesheet - GetProjectTimesheetDetail Get Project Time sheet Detail
EmployeeProjectTimesheetApi employeeProjectTimesheetUpdateProjectTimesheetPost POST /Employee Project Timesheet - UpdateProjectTimesheet Update project timesheet
EmployeeQualificationApi employeeQualificationAddNewQualificationPost POST /Employee Qualification - AddNewQualification Add New Qualification
EmployeeQualificationApi employeeQualificationDeleteQualificationPost POST /Employee Qualification - DeleteQualification Delete Qualification
EmployeeQualificationApi employeeQualificationGetQualificationByEmployeeIdPost POST /Employee Qualification - GetQualificationByEmployeeId Get Qualification By EmployeeId
EmployeeQualificationApi employeeQualificationGetQualificationByQualificationIdPost POST /Employee Qualification - GetQualificationByQualificationId Get Qualification By QualificationId
EmployeeQualificationApi employeeQualificationUpdateQualificationPost POST /Employee Qualification - UpdateQualification Update Qualification
EmployeeSalaryApi employeeSalaryCreateNewSalaryPost POST /EmployeeSalary - CreateNewSalary Create New Salary
EmployeeSalaryApi employeeSalaryDeleteSalaryPost POST /EmployeeSalary - DeleteSalary Delete Salary
EmployeeSalaryApi employeeSalaryGetSalaryDetailPost POST /EmployeeSalary - GetSalaryDetail Get Salary Detail
EmployeeTimesheetApi employeeTimesheetCreateNewTimesheetPost POST /Employee Timesheet - CreateNewTimesheet Create New Timesheet
EmployeeTimesheetApi employeeTimesheetDeleteTimesheetPost POST /Employee Timesheet - DeleteTimesheet Delete Timesheet
EmployeeTimesheetApi employeeTimesheetGetTimesheetDetailPost POST /Employee Timesheet - GetTimesheetDetail Get Employee Timesheet Detail List
EmployeeTimesheetApi employeeTimesheetUpdateTimesheetPost POST /Employee Timesheet - UpdateTimesheet Update Employee Timesheet
EmployeeTrainingApi employeeTrainingAddtrainingdetailPost POST /Employee Training - addtrainingdetail Add Training Detail
EmployeeTrainingApi employeeTrainingDeletetrainingdetailPost POST /Employee Training - deletetrainingdetail Delete Training Detail
EmployeeTrainingApi employeeTrainingGetTrainingDetailPost POST /Employee Training - GetTrainingDetail Get Training Detail
EmployeeTrainingApi employeeTrainingUpdatetrainingdetailPost POST /Employee Training - updatetrainingdetail Update Training Detail
EmployeeVehicleApi employeeVehicleAddNewVehicleDetailPost POST /Employee Vehicle - AddNewVehicleDetail Add New Vehicle Detail
EmployeeVehicleApi employeeVehicleDeleteVehicleDetailPost POST /Employee Vehicle - DeleteVehicleDetail Delete Vehicle Detail
EmployeeVehicleApi employeeVehicleGetByVehicleDetailIdPost POST /Employee Vehicle - GetByVehicleDetailId Get By Vehicle Detail Id
EmployeeVehicleApi employeeVehicleGetVehicleByEmployeeIdPost POST /Employee Vehicle - GetVehicleByEmployeeId Get Vehicle By Employee Id
EmployeeVehicleApi employeeVehicleUpdateVehicleDetailPost POST /Employee Vehicle - UpdateVehicleDetail Update Vehicle Detail
EmployeeeLateApi employeeeLateAddNewLatePost POST /Employeee Late - AddNewLate Add new late
EmployeeeLateApi employeeeLateDeleteLatePost POST /Employeee Late - DeleteLate Delete Late
EmployeeeLateApi employeeeLateGetLateByEmployeeIdPost POST /Employeee Late - GetLateByEmployeeId Get late by employeeId
EmployeeeLateApi employeeeLateUpdateLatePost POST /Employeee Late - UpdateLate Update Late
HistoryApi historyGetHistoryByEmployeeIdAndFieldNamePost POST /History - GetHistoryByEmployeeIdAndFieldName Get History By EmployeeId And FieldName
HolidayEntitlementApi holidayEntitlementGetHolidayEntitlementPost POST /Holiday Entitlement - GetHolidayEntitlement Get Holiday Entitlement
HolidayEntitlementApi holidayEntitlementGetNextYearHolidayEntitlementPost POST /Holiday Entitlement - GetNextYearHolidayEntitlement Get Next Year Holiday Entitlement
HolidayEntitlementApi holidayEntitlementUpdateHolidayEntitlementPost POST /Holiday Entitlement - UpdateHolidayEntitlement Update Holiday Entitlement
HolidayEntitlementApi holidayEntitlementUpdateNextYearHolidayEntitlementPost POST /Holiday Entitlement - UpdateNextYearHolidayEntitlement Update Next Year Holiday Entitlement
MaternityPaternityApi maternityPaternityAddNewMaternityPaternityPost POST /Maternity Paternity - AddNewMaternityPaternity Add New Maternity Paternity
MaternityPaternityApi maternityPaternityDeleteMaternityPaternityPost POST /Maternity Paternity - DeleteMaternityPaternity Delete Maternity Paternity
MaternityPaternityApi maternityPaternityGetByMaternityPaternityIdPost POST /Maternity Paternity - GetByMaternityPaternityId Get by maternity paternity id
MaternityPaternityApi maternityPaternityGetMaternityPaternityByEmployeeIdPost POST /Maternity Paternity - GetMaternityPaternityByEmployeeId Get maternity paternity by employeeid
MaternityPaternityApi maternityPaternityUpdateMaternityPaternityPost POST /Maternity Paternity - UpdateMaternityPaternity Update Maternity Paternity
OtherEventApi otherEventAddotherevententitlementPost POST /Other Event - addotherevententitlement Insert Update Other Event Entitlement
OtherEventApi otherEventAddothereventleavePost POST /Other Event - addothereventleave Add Other Event
OtherEventApi otherEventDeleteOtherEventPost POST /Other Event - DeleteOtherEvent Delete Other Event
OtherEventApi otherEventGetothereventdetailPost POST /Other Event - getothereventdetail Get Other Event Detail
OtherEventApi otherEventGetotherevententitlementPost POST /Other Event - getotherevententitlement Get Other Event Entitlement
OtherEventApi otherEventUpdateothereventleavePost POST /Other Event - updateothereventleave Update Other Event
QueryApi queryGetQueryResultByQueryNamePost POST /Query - GetQueryResultByQueryName Get Query Result By QueryName
QueryApi queryGetQueryResultPost POST /Query - GetQueryResult Get Query Result by Query Id
RightToWorkApi rightToWorkAddrighttoworkdetailPost POST /Right To Work - addrighttoworkdetail Add Right To Work Detail
RightToWorkApi rightToWorkDeleterighttoworkdetailPost POST /Right To Work - deleterighttoworkdetail Delete Right To Work Detail
RightToWorkApi rightToWorkGetrighttoworkdetailPost POST /Right To Work - getrighttoworkdetail Get Right To Work Detail
RightToWorkApi rightToWorkUpdaterighttoworkdetailPost POST /Right To Work - updaterighttoworkdetail Update Right To Work Detail
VacancyApi vacancyCreateNewVacancyPost POST /Vacancy - CreateNewVacancy Create New Vacancy
VacancyApi vacancyGetAllVacanciesPost POST /Vacancy - GetAllVacancies Get all vacancies
VacancyApi vacancyGetVacancyPost POST /Vacancy - GetVacancy Get vacancy
WorkPatternApi workPatternGetWorkPatternDetailPost POST /WorkPattern - GetWorkPatternDetail Get work pattern detail

Models

Authorization

Endpoints do not require authorization.

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

customerservices@peoplehr.com

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 3.1
    • Generator version: 7.10.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen