Class EmployeesClient
- java.lang.Object
-
- com.merge.api.resources.hris.employees.EmployeesClient
-
public class EmployeesClient extends java.lang.Object
-
-
Field Summary
Fields Modifier and Type Field Description protected ClientOptionsclientOptions
-
Constructor Summary
Constructors Constructor Description EmployeesClient(ClientOptions clientOptions)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EmployeeResponsecreate(EmployeeEndpointRequest request)Creates anEmployeeobject with the given values.EmployeeResponsecreate(EmployeeEndpointRequest request, RequestOptions requestOptions)Creates anEmployeeobject with the given values.voidignoreCreate(java.lang.String modelId, IgnoreCommonModelRequest request)Ignores a specific row based on themodel_idin the url.voidignoreCreate(java.lang.String modelId, IgnoreCommonModelRequest request, RequestOptions requestOptions)Ignores a specific row based on themodel_idin the url.PaginatedEmployeeListlist()Returns a list ofEmployeeobjects.PaginatedEmployeeListlist(EmployeesListRequest request)Returns a list ofEmployeeobjects.PaginatedEmployeeListlist(EmployeesListRequest request, RequestOptions requestOptions)Returns a list ofEmployeeobjects.MetaResponsemetaPostRetrieve()Returns metadata forEmployeePOSTs.MetaResponsemetaPostRetrieve(RequestOptions requestOptions)Returns metadata forEmployeePOSTs.Employeeretrieve(java.lang.String id)Returns anEmployeeobject with the givenid.Employeeretrieve(java.lang.String id, EmployeesRetrieveRequest request)Returns anEmployeeobject with the givenid.Employeeretrieve(java.lang.String id, EmployeesRetrieveRequest request, RequestOptions requestOptions)Returns anEmployeeobject with the givenid.
-
-
-
Field Detail
-
clientOptions
protected final ClientOptions clientOptions
-
-
Constructor Detail
-
EmployeesClient
public EmployeesClient(ClientOptions clientOptions)
-
-
Method Detail
-
list
public PaginatedEmployeeList list()
Returns a list ofEmployeeobjects.
-
list
public PaginatedEmployeeList list(EmployeesListRequest request)
Returns a list ofEmployeeobjects.
-
list
public PaginatedEmployeeList list(EmployeesListRequest request, RequestOptions requestOptions)
Returns a list ofEmployeeobjects.
-
create
public EmployeeResponse create(EmployeeEndpointRequest request)
Creates anEmployeeobject with the given values.
-
create
public EmployeeResponse create(EmployeeEndpointRequest request, RequestOptions requestOptions)
Creates anEmployeeobject with the given values.
-
retrieve
public Employee retrieve(java.lang.String id)
Returns anEmployeeobject with the givenid.
-
retrieve
public Employee retrieve(java.lang.String id, EmployeesRetrieveRequest request)
Returns anEmployeeobject with the givenid.
-
retrieve
public Employee retrieve(java.lang.String id, EmployeesRetrieveRequest request, RequestOptions requestOptions)
Returns anEmployeeobject with the givenid.
-
ignoreCreate
public void ignoreCreate(java.lang.String modelId, IgnoreCommonModelRequest request)Ignores a specific row based on themodel_idin the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
-
ignoreCreate
public void ignoreCreate(java.lang.String modelId, IgnoreCommonModelRequest request, RequestOptions requestOptions)Ignores a specific row based on themodel_idin the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
-
metaPostRetrieve
public MetaResponse metaPostRetrieve()
Returns metadata forEmployeePOSTs.
-
metaPostRetrieve
public MetaResponse metaPostRetrieve(RequestOptions requestOptions)
Returns metadata forEmployeePOSTs.
-
-