Package com.mypurecloud.sdk.v2.api

Class WebMessagingApi

java.lang.Object

com.mypurecloud.sdk.v2.api.WebMessagingApi

public class WebMessagingApi
extends Object

Constructor Summary

Constructors

Constructor	Description
WebMessagingApi()
WebMessagingApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteWebmessagingDeploymentPushdevice(DeleteWebmessagingDeploymentPushdeviceRequest request)	Delete device information
ApiResponse<Void>	deleteWebmessagingDeploymentPushdevice(ApiRequest<Void> request)	Delete device information
void	deleteWebmessagingDeploymentPushdevice(String deploymentId, String tokenId)	Delete device information
ApiResponse<Void>	deleteWebmessagingDeploymentPushdeviceWithHttpInfo(String deploymentId, String tokenId)	Delete device information
WebMessagingMessageEntityList	getWebmessagingMessages(GetWebmessagingMessagesRequest request)	Get the messages for a web messaging session.
ApiResponse<WebMessagingMessageEntityList>	getWebmessagingMessages(ApiRequest<Void> request)	Get the messages for a web messaging session.
WebMessagingMessageEntityList	getWebmessagingMessages(Integer pageSize, Integer pageNumber)	Get the messages for a web messaging session.
ApiResponse<WebMessagingMessageEntityList>	getWebmessagingMessagesWithHttpInfo(Integer pageSize, Integer pageNumber)	Get the messages for a web messaging session.
void	patchWebmessagingDeploymentPushdevice(PatchWebmessagingDeploymentPushdeviceRequest request)	Edit device information
ApiResponse<Void>	patchWebmessagingDeploymentPushdevice(ApiRequest<PushDeviceUpdateRequest> request)	Edit device information
void	patchWebmessagingDeploymentPushdevice(String deploymentId, String tokenId, PushDeviceUpdateRequest body)	Edit device information
ApiResponse<Void>	patchWebmessagingDeploymentPushdeviceWithHttpInfo(String deploymentId, String tokenId, PushDeviceUpdateRequest body)	Edit device information
void	postWebmessagingDeploymentPushdevice(PostWebmessagingDeploymentPushdeviceRequest request)	Add a new device information
ApiResponse<Void>	postWebmessagingDeploymentPushdevice(ApiRequest<PushDeviceInsertRequest> request)	Add a new device information
void	postWebmessagingDeploymentPushdevice(String deploymentId, String tokenId, PushDeviceInsertRequest body)	Add a new device information
ApiResponse<Void>	postWebmessagingDeploymentPushdeviceWithHttpInfo(String deploymentId, String tokenId, PushDeviceInsertRequest body)	Add a new device information

Methods inherited from class java.lang.Object

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

Constructor Details

WebMessagingApi

public WebMessagingApi()

WebMessagingApi

public WebMessagingApi(ApiClient apiClient)

Method Details

deleteWebmessagingDeploymentPushdevice

public void deleteWebmessagingDeploymentPushdevice(String deploymentId,
 String tokenId)
                                            throws IOException,
ApiException

Delete device information

Parameters:

deploymentId - WebMessaging deployment id (required)

tokenId - Device token id or cookie id (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteWebmessagingDeploymentPushdeviceWithHttpInfo

public ApiResponse<Void> deleteWebmessagingDeploymentPushdeviceWithHttpInfo(String deploymentId,
 String tokenId)
                                                                     throws IOException

Delete device information

Parameters:

deploymentId - WebMessaging deployment id (required)

tokenId - Device token id or cookie id (required)

Throws:

IOException - if the request fails to be processed

deleteWebmessagingDeploymentPushdevice

public void deleteWebmessagingDeploymentPushdevice(DeleteWebmessagingDeploymentPushdeviceRequest request)
                                            throws IOException,
ApiException

Delete device information

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteWebmessagingDeploymentPushdevice

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

Delete device information

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getWebmessagingMessages

public WebMessagingMessageEntityList getWebmessagingMessages(Integer pageSize,
 Integer pageNumber)
                                                      throws IOException,
ApiException

Get the messages for a web messaging session.

Parameters:

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

Returns:

WebMessagingMessageEntityList

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getWebmessagingMessagesWithHttpInfo

public ApiResponse<WebMessagingMessageEntityList> getWebmessagingMessagesWithHttpInfo(Integer pageSize,
 Integer pageNumber)
                                                                               throws IOException

Get the messages for a web messaging session.

Parameters:

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

Returns:

WebMessagingMessageEntityList

Throws:

IOException - if the request fails to be processed

getWebmessagingMessages

public WebMessagingMessageEntityList getWebmessagingMessages(GetWebmessagingMessagesRequest request)
                                                      throws IOException,
ApiException

Get the messages for a web messaging session.

Parameters:

request - The request object

Returns:

WebMessagingMessageEntityList

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getWebmessagingMessages

public ApiResponse<WebMessagingMessageEntityList> getWebmessagingMessages(ApiRequest<Void> request)
                                                                   throws IOException

Get the messages for a web messaging session.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchWebmessagingDeploymentPushdevice

public void patchWebmessagingDeploymentPushdevice(String deploymentId,
 String tokenId,
 PushDeviceUpdateRequest body)
                                           throws IOException,
ApiException

Edit device information

Parameters:

deploymentId - WebMessaging deployment id (required)

tokenId - Device token id or cookie id (required)

body - Request body (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchWebmessagingDeploymentPushdeviceWithHttpInfo

public ApiResponse<Void> patchWebmessagingDeploymentPushdeviceWithHttpInfo(String deploymentId,
 String tokenId,
 PushDeviceUpdateRequest body)
                                                                    throws IOException

Edit device information

Parameters:

deploymentId - WebMessaging deployment id (required)

tokenId - Device token id or cookie id (required)

body - Request body (required)

Throws:

IOException - if the request fails to be processed

patchWebmessagingDeploymentPushdevice

public void patchWebmessagingDeploymentPushdevice(PatchWebmessagingDeploymentPushdeviceRequest request)
                                           throws IOException,
ApiException

Edit device information

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchWebmessagingDeploymentPushdevice

public ApiResponse<Void> patchWebmessagingDeploymentPushdevice(ApiRequest<PushDeviceUpdateRequest> request)
                                                        throws IOException

Edit device information

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postWebmessagingDeploymentPushdevice

public void postWebmessagingDeploymentPushdevice(String deploymentId,
 String tokenId,
 PushDeviceInsertRequest body)
                                          throws IOException,
ApiException

Add a new device information

Parameters:

deploymentId - WebMessaging deployment id (required)

tokenId - Device token id or cookie id (required)

body - Request body (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postWebmessagingDeploymentPushdeviceWithHttpInfo

public ApiResponse<Void> postWebmessagingDeploymentPushdeviceWithHttpInfo(String deploymentId,
 String tokenId,
 PushDeviceInsertRequest body)
                                                                   throws IOException

Add a new device information

Parameters:

deploymentId - WebMessaging deployment id (required)

tokenId - Device token id or cookie id (required)

body - Request body (required)

Throws:

IOException - if the request fails to be processed

postWebmessagingDeploymentPushdevice

public void postWebmessagingDeploymentPushdevice(PostWebmessagingDeploymentPushdeviceRequest request)
                                          throws IOException,
ApiException

Add a new device information

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postWebmessagingDeploymentPushdevice

public ApiResponse<Void> postWebmessagingDeploymentPushdevice(ApiRequest<PushDeviceInsertRequest> request)
                                                       throws IOException

Add a new device information

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed