everyaction.services.Employers

class everyaction.services.Employers(ea: EAClient)

Represents the Employers service.

Methods

add_bargaining_unit(employer_id, ...)	See POST /employers/{employerId}/bargainingUnits/{bargainingUnitId}.
add_job_class(employer_id, ...)	See POST /employers/{employerId}/bargainingUnits/{bargainingUnitId}/jobClasses/{jobClassId}.
add_shift_type(employer_id, shift_type_id, ...)	See POST /employers/{employerId}/shiftTypes/{shiftTypeId}.
create(**kwargs)	See POST /employers.
create_department(employer_id, /, **kwargs)	See POST /employers/{employerId}/departments.
create_worksite(employer_id, /, **kwargs)	See POST /employers/{employer_id}/worksites.
get(employer_id, /, **kwargs)	See GET /employers/{employerId}.
list(*[, limit])	See GET /employers.
update(employer_id, /, **kwargs)	See PATCH /employers/{employerId}.

add_bargaining_unit(employer_id: int, bargaining_unit_id: int, /) → EmployerBargainingUnit

See POST /employers/{employerId}/bargainingUnits/{bargainingUnitId}.

Parameters

• employer_id – The employerId path parameter.

• bargaining_unit_id – The bargainingUnitId path parameter.

Returns

The resulting :class`.EmployerBargainingUnit` object.

add_job_class(employer_id: int, bargaining_unit_id: int, job_class_id: int, /) → BargainingUnitJobClass

See POST /employers/{employerId}/bargainingUnits/{bargainingUnitId}/jobClasses/{jobClassId}.

Parameters

• employer_id – The employerId path parameter.

• bargaining_unit_id – The bargainingUnitId path parameter.

• job_class_id – The jobClassId path parameter.

Returns

The added BargainingUnitJobClass object.

add_shift_type(employer_id: int, shift_type_id: int, /, **kwargs) → ShiftType

See POST /employers/{employerId}/shiftTypes/{shiftTypeId}.

Parameters

• employer_id – The employerId path parameter.

• shift_type_id – The shiftTypeId path parameter.

• kwargs – The applicable query arguments and JSON data for the request. A ShiftType is appropriate to unpack here.

Returns

The added ShiftType object.

Keyword Arguments

• defaultEndTime (default_end_time, default_end)

• defaultStartTime (default_start_time, default_start)

• name

• shiftTypeId (shift_type_id, id)

create(**kwargs: EAValue) → Employer

See POST /employers.

Parameters

kwargs – The applicable query arguments and JSON data for the request. An Employer is appropriate to unpack here.

Returns

The created Employer object.

Keyword Arguments

• bargainingUnits (bargaining_units, bargaining_unit (singular))

• departments (department (singular))

• employerId (employer_id, id)

• isMyOrganization (is_my_organization, my_organization, my_org)

• jobClasses (job_classes, job_class (singular))

• name

• parentOrganization (parent_organization, parent)

• phones (phone (singular))

• shifts (shift (singular))

• shortName (short_name, short)

• website

• worksites (worksite (singular))

create_department(employer_id: int, /, **kwargs: EAValue) → Department

See POST /employers/{employerId}/departments.

Parameters

• employer_id – The employerId path parameter.

• kwargs – The applicable query arguments and JSON data for the request. A Department is appropriate to unpack here.

Returns

The created Department object.

Keyword Arguments

• departmentId (department_id, id)

• employer

• name

• parentDepartmentId (parent_department_id, parent_department, parent)

create_worksite(employer_id: int, /, **kwargs: EAValue) → Worksite

See POST /employers/{employer_id}/worksites.

Parameters

• employer_id – The employerId path parameter.

• kwargs – The applicable query arguments and JSON data for the request. A Worksite is appropriate to unpack here.

Returns

The created Worksite object.

Keyword Arguments

• address

• employer

• isPreferred (is_preferred, preferred)

• name

• workAreas (work_areas, work_area (singular))

• worksiteId (worksite_id, id)

get(employer_id: int, /, **kwargs: EAValue) → Employer

See GET /employers/{employerId}.

Parameters

• employer_id – The employerId path parameter.

• kwargs – The applicable query arguments and JSON data for the request.

Returns

The resulting Employer object.

Keyword Arguments

• expand

list(*, limit: Optional[int] = None, **kwargs) → List[Employer]

See GET /employers.

Parameters

• limit – Maximum number of records to get for this request.

• kwargs – The applicable query arguments and JSON data for the request.

Returns

List of the resulting Employer objects.

Keyword Arguments

• expand

• isMyOrganization (is_my_organization, my_organization, my_org)

update(employer_id: int, /, **kwargs: EAValue) → Employer

See PATCH /employers/{employerId}.

Parameters

• employer_id – The employerId path parameter.

• kwargs – The applicable query and JSON arguments for the request.

Returns

The updated Employer object.

Keyword Arguments

• isMyOrganization (is_my_organization, my_organization, my_org)