Package com.merge.api.resources.hris.employees

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 ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
EmployeesClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
EmployeeResponse	create(EmployeeEndpointRequest request)	Creates an Employee object with the given values.
EmployeeResponse	create(EmployeeEndpointRequest request, RequestOptions requestOptions)	Creates an Employee object with the given values.
void	ignoreCreate(java.lang.String modelId, IgnoreCommonModelRequest request)	Ignores a specific row based on the model_id in the url.
void	ignoreCreate(java.lang.String modelId, IgnoreCommonModelRequest request, RequestOptions requestOptions)	Ignores a specific row based on the model_id in the url.
PaginatedEmployeeList	list()	Returns a list of Employee objects.
PaginatedEmployeeList	list(EmployeesListRequest request)	Returns a list of Employee objects.
PaginatedEmployeeList	list(EmployeesListRequest request, RequestOptions requestOptions)	Returns a list of Employee objects.
MetaResponse	metaPostRetrieve()	Returns metadata for Employee POSTs.
MetaResponse	metaPostRetrieve(RequestOptions requestOptions)	Returns metadata for Employee POSTs.
Employee	retrieve(java.lang.String id)	Returns an Employee object with the given id.
Employee	retrieve(java.lang.String id, EmployeesRetrieveRequest request)	Returns an Employee object with the given id.
Employee	retrieve(java.lang.String id, EmployeesRetrieveRequest request, RequestOptions requestOptions)	Returns an Employee object with the given id.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

EmployeesClient

public EmployeesClient(ClientOptions clientOptions)

Method Detail

list

public PaginatedEmployeeList list()

Returns a list of Employee objects.

list

public PaginatedEmployeeList list(EmployeesListRequest request)

Returns a list of Employee objects.

list

public PaginatedEmployeeList list(EmployeesListRequest request,
                                  RequestOptions requestOptions)

Returns a list of Employee objects.

create

public EmployeeResponse create(EmployeeEndpointRequest request)

Creates an Employee object with the given values.

create

public EmployeeResponse create(EmployeeEndpointRequest request,
                               RequestOptions requestOptions)

Creates an Employee object with the given values.

retrieve

public Employee retrieve(java.lang.String id)

Returns an Employee object with the given id.

retrieve

public Employee retrieve(java.lang.String id,
                         EmployeesRetrieveRequest request)

Returns an Employee object with the given id.

retrieve

public Employee retrieve(java.lang.String id,
                         EmployeesRetrieveRequest request,
                         RequestOptions requestOptions)

Returns an Employee object with the given id.

ignoreCreate

public void ignoreCreate(java.lang.String modelId,
                         IgnoreCommonModelRequest request)

Ignores a specific row based on the model_id in 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 the model_id in 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 for Employee POSTs.

metaPostRetrieve

public MetaResponse metaPostRetrieve(RequestOptions requestOptions)

Returns metadata for Employee POSTs.