Package com.mypurecloud.sdk.v2.api

Class EmployeeEngagementApi

java.lang.Object

com.mypurecloud.sdk.v2.api.EmployeeEngagementApi

public class EmployeeEngagementApi
extends Object

Constructor Summary

Constructors

Constructor	Description
EmployeeEngagementApi()
EmployeeEngagementApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteEmployeeengagementCelebration(DeleteEmployeeengagementCelebrationRequest request)	Deletes a celebration
ApiResponse<Void>	deleteEmployeeengagementCelebration(ApiRequest<Void> request)	Deletes a celebration
void	deleteEmployeeengagementCelebration(String celebrationId)	Deletes a celebration
ApiResponse<Void>	deleteEmployeeengagementCelebrationWithHttpInfo(String celebrationId)	Deletes a celebration
GetCelebrationListing	getEmployeeengagementCelebrations(GetEmployeeengagementCelebrationsRequest request)	Get all celebrations
ApiResponse<GetCelebrationListing>	getEmployeeengagementCelebrations(ApiRequest<Void> request)	Get all celebrations
GetCelebrationListing	getEmployeeengagementCelebrations(Integer pageNumber, Integer pageSize)	Get all celebrations
ApiResponse<GetCelebrationListing>	getEmployeeengagementCelebrationsWithHttpInfo(Integer pageNumber, Integer pageSize)	Get all celebrations
Recognition	getEmployeeengagementRecognition(GetEmployeeengagementRecognitionRequest request)	Gets a single recognition
ApiResponse<Recognition>	getEmployeeengagementRecognition(ApiRequest<Void> request)	Gets a single recognition
Recognition	getEmployeeengagementRecognition(String recognitionId)	Gets a single recognition
Recognitions	getEmployeeengagementRecognitions(GetEmployeeengagementRecognitionsRequest request)	Gets sent recognitions
ApiResponse<Recognitions>	getEmployeeengagementRecognitions(ApiRequest<Void> request)	Gets sent recognitions
Recognitions	getEmployeeengagementRecognitions(String direction, String recipient, Date dateStart, Date dateEnd, Integer pageSize, Integer pageNumber)	Gets sent recognitions
ApiResponse<Recognitions>	getEmployeeengagementRecognitionsWithHttpInfo(String direction, String recipient, Date dateStart, Date dateEnd, Integer pageSize, Integer pageNumber)	Gets sent recognitions
ApiResponse<Recognition>	getEmployeeengagementRecognitionWithHttpInfo(String recognitionId)	Gets a single recognition
void	patchEmployeeengagementCelebration(PatchEmployeeengagementCelebrationRequest request)	Set a state for a celebration
ApiResponse<Void>	patchEmployeeengagementCelebration(ApiRequest<CelebrationStateParam> request)	Set a state for a celebration
void	patchEmployeeengagementCelebration(String celebrationId, CelebrationStateParam body)	Set a state for a celebration
ApiResponse<Void>	patchEmployeeengagementCelebrationWithHttpInfo(String celebrationId, CelebrationStateParam body)	Set a state for a celebration
RecognitionBase	postEmployeeengagementRecognitions(PostEmployeeengagementRecognitionsRequest request)	Creates a recognition
ApiResponse<RecognitionBase>	postEmployeeengagementRecognitions(ApiRequest<CreateRecognition> request)	Creates a recognition
RecognitionBase	postEmployeeengagementRecognitions(CreateRecognition body)	Creates a recognition
ApiResponse<RecognitionBase>	postEmployeeengagementRecognitionsWithHttpInfo(CreateRecognition body)	Creates a recognition

Methods inherited from class java.lang.Object

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

Constructor Details

EmployeeEngagementApi

public EmployeeEngagementApi()

EmployeeEngagementApi

public EmployeeEngagementApi(ApiClient apiClient)

Method Details

deleteEmployeeengagementCelebration

public void deleteEmployeeengagementCelebration(String celebrationId)
                                         throws IOException,
ApiException

Deletes a celebration

Parameters:

celebrationId - The ID of the celebration (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteEmployeeengagementCelebrationWithHttpInfo

public ApiResponse<Void> deleteEmployeeengagementCelebrationWithHttpInfo(String celebrationId)
                                                                  throws IOException

Deletes a celebration

Parameters:

celebrationId - The ID of the celebration (required)

Throws:

IOException - if the request fails to be processed

deleteEmployeeengagementCelebration

public void deleteEmployeeengagementCelebration(DeleteEmployeeengagementCelebrationRequest request)
                                         throws IOException,
ApiException

Deletes a celebration

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteEmployeeengagementCelebration

public ApiResponse<Void> deleteEmployeeengagementCelebration(ApiRequest<Void> request)
                                                      throws IOException

Deletes a celebration

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getEmployeeengagementCelebrations

public GetCelebrationListing getEmployeeengagementCelebrations(Integer pageNumber,
 Integer pageSize)
                                                        throws IOException,
ApiException

Get all celebrations

Parameters:

pageNumber - (optional, default to 1)

pageSize - (optional, default to 25)

Returns:

GetCelebrationListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getEmployeeengagementCelebrationsWithHttpInfo

public ApiResponse<GetCelebrationListing> getEmployeeengagementCelebrationsWithHttpInfo(Integer pageNumber,
 Integer pageSize)
                                                                                 throws IOException

Get all celebrations

Parameters:

pageNumber - (optional, default to 1)

pageSize - (optional, default to 25)

Returns:

GetCelebrationListing

Throws:

IOException - if the request fails to be processed

getEmployeeengagementCelebrations

public GetCelebrationListing getEmployeeengagementCelebrations(GetEmployeeengagementCelebrationsRequest request)
                                                        throws IOException,
ApiException

Get all celebrations

Parameters:

request - The request object

Returns:

GetCelebrationListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getEmployeeengagementCelebrations

public ApiResponse<GetCelebrationListing> getEmployeeengagementCelebrations(ApiRequest<Void> request)
                                                                     throws IOException

Get all celebrations

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getEmployeeengagementRecognition

public Recognition getEmployeeengagementRecognition(String recognitionId)
                                             throws IOException,
ApiException

Gets a single recognition

Parameters:

recognitionId - The Recognition ID (required)

Returns:

Recognition

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getEmployeeengagementRecognitionWithHttpInfo

public ApiResponse<Recognition> getEmployeeengagementRecognitionWithHttpInfo(String recognitionId)
                                                                      throws IOException

Gets a single recognition

Parameters:

recognitionId - The Recognition ID (required)

Returns:

Recognition

Throws:

IOException - if the request fails to be processed

getEmployeeengagementRecognition

public Recognition getEmployeeengagementRecognition(GetEmployeeengagementRecognitionRequest request)
                                             throws IOException,
ApiException

Gets a single recognition

Parameters:

request - The request object

Returns:

Recognition

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getEmployeeengagementRecognition

public ApiResponse<Recognition> getEmployeeengagementRecognition(ApiRequest<Void> request)
                                                          throws IOException

Gets a single recognition

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getEmployeeengagementRecognitions

public Recognitions getEmployeeengagementRecognitions(String direction,
 String recipient,
 Date dateStart,
 Date dateEnd,
 Integer pageSize,
 Integer pageNumber)
                                               throws IOException,
ApiException

Gets sent recognitions

Parameters:

direction - The direction of the recognitions. (optional, default to received)

recipient - The ID of the recipient (when direction is sent). (optional)

dateStart - The start date of the search range. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional)

dateEnd - The end date of the search range. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional)

pageSize - Page size (optional, default to 100)

pageNumber - Page number (optional, default to 1)

Returns:

Recognitions

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getEmployeeengagementRecognitionsWithHttpInfo

public ApiResponse<Recognitions> getEmployeeengagementRecognitionsWithHttpInfo(String direction,
 String recipient,
 Date dateStart,
 Date dateEnd,
 Integer pageSize,
 Integer pageNumber)
                                                                        throws IOException

Gets sent recognitions

Parameters:

direction - The direction of the recognitions. (optional, default to received)

recipient - The ID of the recipient (when direction is sent). (optional)

dateStart - The start date of the search range. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional)

dateEnd - The end date of the search range. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional)

pageSize - Page size (optional, default to 100)

pageNumber - Page number (optional, default to 1)

Returns:

Recognitions

Throws:

IOException - if the request fails to be processed

getEmployeeengagementRecognitions

public Recognitions getEmployeeengagementRecognitions(GetEmployeeengagementRecognitionsRequest request)
                                               throws IOException,
ApiException

Gets sent recognitions

Parameters:

request - The request object

Returns:

Recognitions

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getEmployeeengagementRecognitions

public ApiResponse<Recognitions> getEmployeeengagementRecognitions(ApiRequest<Void> request)
                                                            throws IOException

Gets sent recognitions

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchEmployeeengagementCelebration

public void patchEmployeeengagementCelebration(String celebrationId,
 CelebrationStateParam body)
                                        throws IOException,
ApiException

Set a state for a celebration

Parameters:

celebrationId - The ID of the celebration (required)

body - Patch Celebration state (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchEmployeeengagementCelebrationWithHttpInfo

public ApiResponse<Void> patchEmployeeengagementCelebrationWithHttpInfo(String celebrationId,
 CelebrationStateParam body)
                                                                 throws IOException

Set a state for a celebration

Parameters:

celebrationId - The ID of the celebration (required)

body - Patch Celebration state (required)

Throws:

IOException - if the request fails to be processed

patchEmployeeengagementCelebration

public void patchEmployeeengagementCelebration(PatchEmployeeengagementCelebrationRequest request)
                                        throws IOException,
ApiException

Set a state for a celebration

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchEmployeeengagementCelebration

public ApiResponse<Void> patchEmployeeengagementCelebration(ApiRequest<CelebrationStateParam> request)
                                                     throws IOException

Set a state for a celebration

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postEmployeeengagementRecognitions

public RecognitionBase postEmployeeengagementRecognitions(CreateRecognition body)
                                                   throws IOException,
ApiException

Creates a recognition

Parameters:

body - Create Recognition (required)

Returns:

RecognitionBase

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postEmployeeengagementRecognitionsWithHttpInfo

public ApiResponse<RecognitionBase> postEmployeeengagementRecognitionsWithHttpInfo(CreateRecognition body)
                                                                            throws IOException

Creates a recognition

Parameters:

body - Create Recognition (required)

Returns:

RecognitionBase

Throws:

IOException - if the request fails to be processed

postEmployeeengagementRecognitions

public RecognitionBase postEmployeeengagementRecognitions(PostEmployeeengagementRecognitionsRequest request)
                                                   throws IOException,
ApiException

Creates a recognition

Parameters:

request - The request object

Returns:

RecognitionBase

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postEmployeeengagementRecognitions

public ApiResponse<RecognitionBase> postEmployeeengagementRecognitions(ApiRequest<CreateRecognition> request)
                                                                throws IOException

Creates a recognition

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed