Package com.merge.api.resources.ats.candidates

Class CandidatesClient

java.lang.Object

com.merge.api.resources.ats.candidates.CandidatesClient

public class CandidatesClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
CandidatesClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
CandidateResponse	create(CandidateEndpointRequest request)	Creates a Candidate object with the given values.
CandidateResponse	create(CandidateEndpointRequest request, RequestOptions requestOptions)	Creates a Candidate 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.
PaginatedCandidateList	list()	Returns a list of Candidate objects.
PaginatedCandidateList	list(CandidatesListRequest request)	Returns a list of Candidate objects.
PaginatedCandidateList	list(CandidatesListRequest request, RequestOptions requestOptions)	Returns a list of Candidate objects.
MetaResponse	metaPatchRetrieve(java.lang.String id)	Returns metadata for Candidate PATCHs.
MetaResponse	metaPatchRetrieve(java.lang.String id, RequestOptions requestOptions)	Returns metadata for Candidate PATCHs.
MetaResponse	metaPostRetrieve()	Returns metadata for Candidate POSTs.
MetaResponse	metaPostRetrieve(RequestOptions requestOptions)	Returns metadata for Candidate POSTs.
CandidateResponse	partialUpdate(java.lang.String id, PatchedCandidateEndpointRequest request)	Updates a Candidate object with the given id.
CandidateResponse	partialUpdate(java.lang.String id, PatchedCandidateEndpointRequest request, RequestOptions requestOptions)	Updates a Candidate object with the given id.
Candidate	retrieve(java.lang.String id)	Returns a Candidate object with the given id.
Candidate	retrieve(java.lang.String id, CandidatesRetrieveRequest request)	Returns a Candidate object with the given id.
Candidate	retrieve(java.lang.String id, CandidatesRetrieveRequest request, RequestOptions requestOptions)	Returns a Candidate 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

CandidatesClient

public CandidatesClient(ClientOptions clientOptions)

Method Detail

list

public PaginatedCandidateList list()

Returns a list of Candidate objects.

list

public PaginatedCandidateList list(CandidatesListRequest request)

Returns a list of Candidate objects.

list

public PaginatedCandidateList list(CandidatesListRequest request,
                                   RequestOptions requestOptions)

Returns a list of Candidate objects.

create

public CandidateResponse create(CandidateEndpointRequest request)

Creates a Candidate object with the given values.

create

public CandidateResponse create(CandidateEndpointRequest request,
                                RequestOptions requestOptions)

Creates a Candidate object with the given values.

retrieve

public Candidate retrieve(java.lang.String id)

Returns a Candidate object with the given id.

retrieve

public Candidate retrieve(java.lang.String id,
                          CandidatesRetrieveRequest request)

Returns a Candidate object with the given id.

retrieve

public Candidate retrieve(java.lang.String id,
                          CandidatesRetrieveRequest request,
                          RequestOptions requestOptions)

Returns a Candidate object with the given id.

partialUpdate

public CandidateResponse partialUpdate(java.lang.String id,
                                       PatchedCandidateEndpointRequest request)

Updates a Candidate object with the given id.

partialUpdate

public CandidateResponse partialUpdate(java.lang.String id,
                                       PatchedCandidateEndpointRequest request,
                                       RequestOptions requestOptions)

Updates a Candidate 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.

metaPatchRetrieve

public MetaResponse metaPatchRetrieve(java.lang.String id)

Returns metadata for Candidate PATCHs.

metaPatchRetrieve

public MetaResponse metaPatchRetrieve(java.lang.String id,
                                      RequestOptions requestOptions)

Returns metadata for Candidate PATCHs.

metaPostRetrieve

public MetaResponse metaPostRetrieve()

Returns metadata for Candidate POSTs.

metaPostRetrieve

public MetaResponse metaPostRetrieve(RequestOptions requestOptions)

Returns metadata for Candidate POSTs.