com.mypurecloud.sdk.v2.guest.api.WebChatApi Maven / Gradle / Ivy
The newest version!
package com.mypurecloud.sdk.v2.guest.api;
import com.fasterxml.jackson.core.type.TypeReference;
import com.mypurecloud.sdk.v2.guest.ApiException;
import com.mypurecloud.sdk.v2.guest.ApiClient;
import com.mypurecloud.sdk.v2.guest.ApiRequest;
import com.mypurecloud.sdk.v2.guest.ApiResponse;
import com.mypurecloud.sdk.v2.guest.Configuration;
import com.mypurecloud.sdk.v2.guest.model.*;
import com.mypurecloud.sdk.v2.guest.Pair;
import com.mypurecloud.sdk.v2.guest.model.CreateWebChatConversationRequest;
import com.mypurecloud.sdk.v2.guest.model.CreateWebChatConversationResponse;
import com.mypurecloud.sdk.v2.guest.model.CreateWebChatMessageRequest;
import com.mypurecloud.sdk.v2.guest.model.ErrorBody;
import com.mypurecloud.sdk.v2.guest.model.WebChatGuestMediaRequest;
import com.mypurecloud.sdk.v2.guest.model.WebChatGuestMediaRequestEntityList;
import com.mypurecloud.sdk.v2.guest.model.WebChatMemberInfo;
import com.mypurecloud.sdk.v2.guest.model.WebChatMemberInfoEntityList;
import com.mypurecloud.sdk.v2.guest.model.WebChatMessage;
import com.mypurecloud.sdk.v2.guest.model.WebChatMessageEntityList;
import com.mypurecloud.sdk.v2.guest.model.WebChatTyping;
import com.mypurecloud.sdk.v2.guest.api.request.DeleteWebchatGuestConversationMemberRequest;
import com.mypurecloud.sdk.v2.guest.api.request.GetWebchatGuestConversationMediarequestRequest;
import com.mypurecloud.sdk.v2.guest.api.request.GetWebchatGuestConversationMediarequestsRequest;
import com.mypurecloud.sdk.v2.guest.api.request.GetWebchatGuestConversationMemberRequest;
import com.mypurecloud.sdk.v2.guest.api.request.GetWebchatGuestConversationMembersRequest;
import com.mypurecloud.sdk.v2.guest.api.request.GetWebchatGuestConversationMessageRequest;
import com.mypurecloud.sdk.v2.guest.api.request.GetWebchatGuestConversationMessagesRequest;
import com.mypurecloud.sdk.v2.guest.api.request.PatchWebchatGuestConversationMediarequestRequest;
import com.mypurecloud.sdk.v2.guest.api.request.PostWebchatGuestConversationMemberMessagesRequest;
import com.mypurecloud.sdk.v2.guest.api.request.PostWebchatGuestConversationMemberTypingRequest;
import com.mypurecloud.sdk.v2.guest.api.request.PostWebchatGuestConversationsRequest;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class WebChatApi {
private final ApiClient pcapiClient;
public WebChatApi() {
this(Configuration.getDefaultApiClient());
}
public WebChatApi(ApiClient apiClient) {
this.pcapiClient = apiClient;
}
/**
* Remove a member from a chat conversation
*
* @param conversationId conversationId (required)
* @param memberId memberId (required)
* @throws ApiException if the request fails on the server
* @throws IOException if the request fails to be processed
*/
public void deleteWebchatGuestConversationMember(String conversationId, String memberId) throws IOException, ApiException {
deleteWebchatGuestConversationMember(createDeleteWebchatGuestConversationMemberRequest(conversationId, memberId));
}
/**
* Remove a member from a chat conversation
*
* @param conversationId conversationId (required)
* @param memberId memberId (required)
* @throws IOException if the request fails to be processed
*/
public ApiResponse deleteWebchatGuestConversationMemberWithHttpInfo(String conversationId, String memberId) throws IOException {
return deleteWebchatGuestConversationMember(createDeleteWebchatGuestConversationMemberRequest(conversationId, memberId).withHttpInfo());
}
private DeleteWebchatGuestConversationMemberRequest createDeleteWebchatGuestConversationMemberRequest(String conversationId, String memberId) {
return DeleteWebchatGuestConversationMemberRequest.builder()
.withConversationId(conversationId)
.withMemberId(memberId)
.build();
}
/**
* Remove a member from a chat conversation
*
* @param request The request object
* @throws ApiException if the request fails on the server
* @throws IOException if the request fails to be processed
*/
public void deleteWebchatGuestConversationMember(DeleteWebchatGuestConversationMemberRequest request) throws IOException, ApiException {
try {
ApiResponse response = pcapiClient.invoke(request.withHttpInfo(), null);
}
catch (ApiException | IOException exception) {
if (pcapiClient.getShouldThrowErrors()) throw exception;
}
}
/**
* Remove a member from a chat conversation
*
* @param request The request object
* @return the response
* @throws IOException if the request fails to be processed
*/
public ApiResponse deleteWebchatGuestConversationMember(ApiRequest request) throws IOException {
try {
return pcapiClient.invoke(request, null);
}
catch (ApiException exception) {
@SuppressWarnings("unchecked")
ApiResponse response = (ApiResponse)(ApiResponse)exception;
return response;
}
catch (Throwable exception) {
if (pcapiClient.getShouldThrowErrors()) {
if (exception instanceof IOException) {
throw (IOException)exception;
}
throw new RuntimeException(exception);
}
@SuppressWarnings("unchecked")
ApiResponse response = (ApiResponse)(ApiResponse)(new ApiException(exception));
return response;
}
}
/**
* Get a media request in the conversation
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
* @param conversationId conversationId (required)
* @param mediaRequestId mediaRequestId (required)
* @return WebChatGuestMediaRequest
* @throws ApiException if the request fails on the server
* @throws IOException if the request fails to be processed
*/
public WebChatGuestMediaRequest getWebchatGuestConversationMediarequest(String conversationId, String mediaRequestId) throws IOException, ApiException {
return getWebchatGuestConversationMediarequest(createGetWebchatGuestConversationMediarequestRequest(conversationId, mediaRequestId));
}
/**
* Get a media request in the conversation
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
* @param conversationId conversationId (required)
* @param mediaRequestId mediaRequestId (required)
* @return WebChatGuestMediaRequest
* @throws IOException if the request fails to be processed
*/
public ApiResponse getWebchatGuestConversationMediarequestWithHttpInfo(String conversationId, String mediaRequestId) throws IOException {
return getWebchatGuestConversationMediarequest(createGetWebchatGuestConversationMediarequestRequest(conversationId, mediaRequestId).withHttpInfo());
}
private GetWebchatGuestConversationMediarequestRequest createGetWebchatGuestConversationMediarequestRequest(String conversationId, String mediaRequestId) {
return GetWebchatGuestConversationMediarequestRequest.builder()
.withConversationId(conversationId)
.withMediaRequestId(mediaRequestId)
.build();
}
/**
* Get a media request in the conversation
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
* @param request The request object
* @return WebChatGuestMediaRequest
* @throws ApiException if the request fails on the server
* @throws IOException if the request fails to be processed
*/
public WebChatGuestMediaRequest getWebchatGuestConversationMediarequest(GetWebchatGuestConversationMediarequestRequest request) throws IOException, ApiException {
try {
ApiResponse response = pcapiClient.invoke(request.withHttpInfo(), new TypeReference() {});
return response.getBody();
}
catch (ApiException | IOException exception) {
if (pcapiClient.getShouldThrowErrors()) throw exception;
return null;
}
}
/**
* Get a media request in the conversation
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
* @param request The request object
* @return the response
* @throws IOException if the request fails to be processed
*/
public ApiResponse getWebchatGuestConversationMediarequest(ApiRequest request) throws IOException {
try {
return pcapiClient.invoke(request, new TypeReference() {});
}
catch (ApiException exception) {
@SuppressWarnings("unchecked")
ApiResponse response = (ApiResponse)(ApiResponse)exception;
return response;
}
catch (Throwable exception) {
if (pcapiClient.getShouldThrowErrors()) {
if (exception instanceof IOException) {
throw (IOException)exception;
}
throw new RuntimeException(exception);
}
@SuppressWarnings("unchecked")
ApiResponse response = (ApiResponse)(ApiResponse)(new ApiException(exception));
return response;
}
}
/**
* Get all media requests to the guest in the conversation
*
* @param conversationId conversationId (required)
* @return WebChatGuestMediaRequestEntityList
* @throws ApiException if the request fails on the server
* @throws IOException if the request fails to be processed
*/
public WebChatGuestMediaRequestEntityList getWebchatGuestConversationMediarequests(String conversationId) throws IOException, ApiException {
return getWebchatGuestConversationMediarequests(createGetWebchatGuestConversationMediarequestsRequest(conversationId));
}
/**
* Get all media requests to the guest in the conversation
*
* @param conversationId conversationId (required)
* @return WebChatGuestMediaRequestEntityList
* @throws IOException if the request fails to be processed
*/
public ApiResponse getWebchatGuestConversationMediarequestsWithHttpInfo(String conversationId) throws IOException {
return getWebchatGuestConversationMediarequests(createGetWebchatGuestConversationMediarequestsRequest(conversationId).withHttpInfo());
}
private GetWebchatGuestConversationMediarequestsRequest createGetWebchatGuestConversationMediarequestsRequest(String conversationId) {
return GetWebchatGuestConversationMediarequestsRequest.builder()
.withConversationId(conversationId)
.build();
}
/**
* Get all media requests to the guest in the conversation
*
* @param request The request object
* @return WebChatGuestMediaRequestEntityList
* @throws ApiException if the request fails on the server
* @throws IOException if the request fails to be processed
*/
public WebChatGuestMediaRequestEntityList getWebchatGuestConversationMediarequests(GetWebchatGuestConversationMediarequestsRequest request) throws IOException, ApiException {
try {
ApiResponse response = pcapiClient.invoke(request.withHttpInfo(), new TypeReference() {});
return response.getBody();
}
catch (ApiException | IOException exception) {
if (pcapiClient.getShouldThrowErrors()) throw exception;
return null;
}
}
/**
* Get all media requests to the guest in the conversation
*
* @param request The request object
* @return the response
* @throws IOException if the request fails to be processed
*/
public ApiResponse getWebchatGuestConversationMediarequests(ApiRequest request) throws IOException {
try {
return pcapiClient.invoke(request, new TypeReference() {});
}
catch (ApiException exception) {
@SuppressWarnings("unchecked")
ApiResponse response = (ApiResponse)(ApiResponse)exception;
return response;
}
catch (Throwable exception) {
if (pcapiClient.getShouldThrowErrors()) {
if (exception instanceof IOException) {
throw (IOException)exception;
}
throw new RuntimeException(exception);
}
@SuppressWarnings("unchecked")
ApiResponse response = (ApiResponse)(ApiResponse)(new ApiException(exception));
return response;
}
}
/**
* Get a web chat conversation member
*
* @param conversationId conversationId (required)
* @param memberId memberId (required)
* @return WebChatMemberInfo
* @throws ApiException if the request fails on the server
* @throws IOException if the request fails to be processed
*/
public WebChatMemberInfo getWebchatGuestConversationMember(String conversationId, String memberId) throws IOException, ApiException {
return getWebchatGuestConversationMember(createGetWebchatGuestConversationMemberRequest(conversationId, memberId));
}
/**
* Get a web chat conversation member
*
* @param conversationId conversationId (required)
* @param memberId memberId (required)
* @return WebChatMemberInfo
* @throws IOException if the request fails to be processed
*/
public ApiResponse getWebchatGuestConversationMemberWithHttpInfo(String conversationId, String memberId) throws IOException {
return getWebchatGuestConversationMember(createGetWebchatGuestConversationMemberRequest(conversationId, memberId).withHttpInfo());
}
private GetWebchatGuestConversationMemberRequest createGetWebchatGuestConversationMemberRequest(String conversationId, String memberId) {
return GetWebchatGuestConversationMemberRequest.builder()
.withConversationId(conversationId)
.withMemberId(memberId)
.build();
}
/**
* Get a web chat conversation member
*
* @param request The request object
* @return WebChatMemberInfo
* @throws ApiException if the request fails on the server
* @throws IOException if the request fails to be processed
*/
public WebChatMemberInfo getWebchatGuestConversationMember(GetWebchatGuestConversationMemberRequest request) throws IOException, ApiException {
try {
ApiResponse response = pcapiClient.invoke(request.withHttpInfo(), new TypeReference() {});
return response.getBody();
}
catch (ApiException | IOException exception) {
if (pcapiClient.getShouldThrowErrors()) throw exception;
return null;
}
}
/**
* Get a web chat conversation member
*
* @param request The request object
* @return the response
* @throws IOException if the request fails to be processed
*/
public ApiResponse getWebchatGuestConversationMember(ApiRequest request) throws IOException {
try {
return pcapiClient.invoke(request, new TypeReference() {});
}
catch (ApiException exception) {
@SuppressWarnings("unchecked")
ApiResponse response = (ApiResponse)(ApiResponse)exception;
return response;
}
catch (Throwable exception) {
if (pcapiClient.getShouldThrowErrors()) {
if (exception instanceof IOException) {
throw (IOException)exception;
}
throw new RuntimeException(exception);
}
@SuppressWarnings("unchecked")
ApiResponse response = (ApiResponse)(ApiResponse)(new ApiException(exception));
return response;
}
}
/**
* Get the members of a chat conversation.
*
* @param conversationId conversationId (required)
* @param pageSize The number of entries to return per page, or omitted for the default. (optional, default to 25)
* @param pageNumber The page number to return, or omitted for the first page. (optional, default to 1)
* @param excludeDisconnectedMembers If true, the results will not contain members who have a DISCONNECTED state. (optional, default to false)
* @return WebChatMemberInfoEntityList
* @throws ApiException if the request fails on the server
* @throws IOException if the request fails to be processed
*/
public WebChatMemberInfoEntityList getWebchatGuestConversationMembers(String conversationId, Integer pageSize, Integer pageNumber, Boolean excludeDisconnectedMembers) throws IOException, ApiException {
return getWebchatGuestConversationMembers(createGetWebchatGuestConversationMembersRequest(conversationId, pageSize, pageNumber, excludeDisconnectedMembers));
}
/**
* Get the members of a chat conversation.
*
* @param conversationId conversationId (required)
* @param pageSize The number of entries to return per page, or omitted for the default. (optional, default to 25)
* @param pageNumber The page number to return, or omitted for the first page. (optional, default to 1)
* @param excludeDisconnectedMembers If true, the results will not contain members who have a DISCONNECTED state. (optional, default to false)
* @return WebChatMemberInfoEntityList
* @throws IOException if the request fails to be processed
*/
public ApiResponse getWebchatGuestConversationMembersWithHttpInfo(String conversationId, Integer pageSize, Integer pageNumber, Boolean excludeDisconnectedMembers) throws IOException {
return getWebchatGuestConversationMembers(createGetWebchatGuestConversationMembersRequest(conversationId, pageSize, pageNumber, excludeDisconnectedMembers).withHttpInfo());
}
private GetWebchatGuestConversationMembersRequest createGetWebchatGuestConversationMembersRequest(String conversationId, Integer pageSize, Integer pageNumber, Boolean excludeDisconnectedMembers) {
return GetWebchatGuestConversationMembersRequest.builder()
.withConversationId(conversationId)
.withPageSize(pageSize)
.withPageNumber(pageNumber)
.withExcludeDisconnectedMembers(excludeDisconnectedMembers)
.build();
}
/**
* Get the members of a chat conversation.
*
* @param request The request object
* @return WebChatMemberInfoEntityList
* @throws ApiException if the request fails on the server
* @throws IOException if the request fails to be processed
*/
public WebChatMemberInfoEntityList getWebchatGuestConversationMembers(GetWebchatGuestConversationMembersRequest request) throws IOException, ApiException {
try {
ApiResponse response = pcapiClient.invoke(request.withHttpInfo(), new TypeReference() {});
return response.getBody();
}
catch (ApiException | IOException exception) {
if (pcapiClient.getShouldThrowErrors()) throw exception;
return null;
}
}
/**
* Get the members of a chat conversation.
*
* @param request The request object
* @return the response
* @throws IOException if the request fails to be processed
*/
public ApiResponse getWebchatGuestConversationMembers(ApiRequest request) throws IOException {
try {
return pcapiClient.invoke(request, new TypeReference() {});
}
catch (ApiException exception) {
@SuppressWarnings("unchecked")
ApiResponse response = (ApiResponse)(ApiResponse)exception;
return response;
}
catch (Throwable exception) {
if (pcapiClient.getShouldThrowErrors()) {
if (exception instanceof IOException) {
throw (IOException)exception;
}
throw new RuntimeException(exception);
}
@SuppressWarnings("unchecked")
ApiResponse response = (ApiResponse)(ApiResponse)(new ApiException(exception));
return response;
}
}
/**
* Get a web chat conversation message
*
* @param conversationId conversationId (required)
* @param messageId messageId (required)
* @return WebChatMessage
* @throws ApiException if the request fails on the server
* @throws IOException if the request fails to be processed
*/
public WebChatMessage getWebchatGuestConversationMessage(String conversationId, String messageId) throws IOException, ApiException {
return getWebchatGuestConversationMessage(createGetWebchatGuestConversationMessageRequest(conversationId, messageId));
}
/**
* Get a web chat conversation message
*
* @param conversationId conversationId (required)
* @param messageId messageId (required)
* @return WebChatMessage
* @throws IOException if the request fails to be processed
*/
public ApiResponse getWebchatGuestConversationMessageWithHttpInfo(String conversationId, String messageId) throws IOException {
return getWebchatGuestConversationMessage(createGetWebchatGuestConversationMessageRequest(conversationId, messageId).withHttpInfo());
}
private GetWebchatGuestConversationMessageRequest createGetWebchatGuestConversationMessageRequest(String conversationId, String messageId) {
return GetWebchatGuestConversationMessageRequest.builder()
.withConversationId(conversationId)
.withMessageId(messageId)
.build();
}
/**
* Get a web chat conversation message
*
* @param request The request object
* @return WebChatMessage
* @throws ApiException if the request fails on the server
* @throws IOException if the request fails to be processed
*/
public WebChatMessage getWebchatGuestConversationMessage(GetWebchatGuestConversationMessageRequest request) throws IOException, ApiException {
try {
ApiResponse response = pcapiClient.invoke(request.withHttpInfo(), new TypeReference() {});
return response.getBody();
}
catch (ApiException | IOException exception) {
if (pcapiClient.getShouldThrowErrors()) throw exception;
return null;
}
}
/**
* Get a web chat conversation message
*
* @param request The request object
* @return the response
* @throws IOException if the request fails to be processed
*/
public ApiResponse getWebchatGuestConversationMessage(ApiRequest request) throws IOException {
try {
return pcapiClient.invoke(request, new TypeReference() {});
}
catch (ApiException exception) {
@SuppressWarnings("unchecked")
ApiResponse response = (ApiResponse)(ApiResponse)exception;
return response;
}
catch (Throwable exception) {
if (pcapiClient.getShouldThrowErrors()) {
if (exception instanceof IOException) {
throw (IOException)exception;
}
throw new RuntimeException(exception);
}
@SuppressWarnings("unchecked")
ApiResponse response = (ApiResponse)(ApiResponse)(new ApiException(exception));
return response;
}
}
/**
* Get the messages of a chat conversation.
*
* @param conversationId conversationId (required)
* @param after If available, get the messages chronologically after the id of this message (optional)
* @param before If available, get the messages chronologically before the id of this message (optional)
* @param sortOrder Sort order (optional, default to ascending)
* @param maxResults Limit the returned number of messages, up to a maximum of 100 (optional, default to 100)
* @return WebChatMessageEntityList
* @throws ApiException if the request fails on the server
* @throws IOException if the request fails to be processed
*/
public WebChatMessageEntityList getWebchatGuestConversationMessages(String conversationId, String after, String before, String sortOrder, Integer maxResults) throws IOException, ApiException {
return getWebchatGuestConversationMessages(createGetWebchatGuestConversationMessagesRequest(conversationId, after, before, sortOrder, maxResults));
}
/**
* Get the messages of a chat conversation.
*
* @param conversationId conversationId (required)
* @param after If available, get the messages chronologically after the id of this message (optional)
* @param before If available, get the messages chronologically before the id of this message (optional)
* @param sortOrder Sort order (optional, default to ascending)
* @param maxResults Limit the returned number of messages, up to a maximum of 100 (optional, default to 100)
* @return WebChatMessageEntityList
* @throws IOException if the request fails to be processed
*/
public ApiResponse getWebchatGuestConversationMessagesWithHttpInfo(String conversationId, String after, String before, String sortOrder, Integer maxResults) throws IOException {
return getWebchatGuestConversationMessages(createGetWebchatGuestConversationMessagesRequest(conversationId, after, before, sortOrder, maxResults).withHttpInfo());
}
private GetWebchatGuestConversationMessagesRequest createGetWebchatGuestConversationMessagesRequest(String conversationId, String after, String before, String sortOrder, Integer maxResults) {
return GetWebchatGuestConversationMessagesRequest.builder()
.withConversationId(conversationId)
.withAfter(after)
.withBefore(before)
.withSortOrder(sortOrder)
.withMaxResults(maxResults)
.build();
}
/**
* Get the messages of a chat conversation.
*
* @param request The request object
* @return WebChatMessageEntityList
* @throws ApiException if the request fails on the server
* @throws IOException if the request fails to be processed
*/
public WebChatMessageEntityList getWebchatGuestConversationMessages(GetWebchatGuestConversationMessagesRequest request) throws IOException, ApiException {
try {
ApiResponse response = pcapiClient.invoke(request.withHttpInfo(), new TypeReference() {});
return response.getBody();
}
catch (ApiException | IOException exception) {
if (pcapiClient.getShouldThrowErrors()) throw exception;
return null;
}
}
/**
* Get the messages of a chat conversation.
*
* @param request The request object
* @return the response
* @throws IOException if the request fails to be processed
*/
public ApiResponse getWebchatGuestConversationMessages(ApiRequest request) throws IOException {
try {
return pcapiClient.invoke(request, new TypeReference() {});
}
catch (ApiException exception) {
@SuppressWarnings("unchecked")
ApiResponse response = (ApiResponse)(ApiResponse)exception;
return response;
}
catch (Throwable exception) {
if (pcapiClient.getShouldThrowErrors()) {
if (exception instanceof IOException) {
throw (IOException)exception;
}
throw new RuntimeException(exception);
}
@SuppressWarnings("unchecked")
ApiResponse response = (ApiResponse)(ApiResponse)(new ApiException(exception));
return response;
}
}
/**
* Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
* @param conversationId conversationId (required)
* @param mediaRequestId mediaRequestId (required)
* @param body Request (required)
* @return WebChatGuestMediaRequest
* @throws ApiException if the request fails on the server
* @throws IOException if the request fails to be processed
*/
public WebChatGuestMediaRequest patchWebchatGuestConversationMediarequest(String conversationId, String mediaRequestId, WebChatGuestMediaRequest body) throws IOException, ApiException {
return patchWebchatGuestConversationMediarequest(createPatchWebchatGuestConversationMediarequestRequest(conversationId, mediaRequestId, body));
}
/**
* Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
* @param conversationId conversationId (required)
* @param mediaRequestId mediaRequestId (required)
* @param body Request (required)
* @return WebChatGuestMediaRequest
* @throws IOException if the request fails to be processed
*/
public ApiResponse patchWebchatGuestConversationMediarequestWithHttpInfo(String conversationId, String mediaRequestId, WebChatGuestMediaRequest body) throws IOException {
return patchWebchatGuestConversationMediarequest(createPatchWebchatGuestConversationMediarequestRequest(conversationId, mediaRequestId, body).withHttpInfo());
}
private PatchWebchatGuestConversationMediarequestRequest createPatchWebchatGuestConversationMediarequestRequest(String conversationId, String mediaRequestId, WebChatGuestMediaRequest body) {
return PatchWebchatGuestConversationMediarequestRequest.builder()
.withConversationId(conversationId)
.withMediaRequestId(mediaRequestId)
.withBody(body)
.build();
}
/**
* Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
* @param request The request object
* @return WebChatGuestMediaRequest
* @throws ApiException if the request fails on the server
* @throws IOException if the request fails to be processed
*/
public WebChatGuestMediaRequest patchWebchatGuestConversationMediarequest(PatchWebchatGuestConversationMediarequestRequest request) throws IOException, ApiException {
try {
ApiResponse response = pcapiClient.invoke(request.withHttpInfo(), new TypeReference() {});
return response.getBody();
}
catch (ApiException | IOException exception) {
if (pcapiClient.getShouldThrowErrors()) throw exception;
return null;
}
}
/**
* Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
* @param request The request object
* @return the response
* @throws IOException if the request fails to be processed
*/
public ApiResponse patchWebchatGuestConversationMediarequest(ApiRequest request) throws IOException {
try {
return pcapiClient.invoke(request, new TypeReference() {});
}
catch (ApiException exception) {
@SuppressWarnings("unchecked")
ApiResponse response = (ApiResponse)(ApiResponse)exception;
return response;
}
catch (Throwable exception) {
if (pcapiClient.getShouldThrowErrors()) {
if (exception instanceof IOException) {
throw (IOException)exception;
}
throw new RuntimeException(exception);
}
@SuppressWarnings("unchecked")
ApiResponse response = (ApiResponse)(ApiResponse)(new ApiException(exception));
return response;
}
}
/**
* Send a message in a chat conversation.
*
* @param conversationId conversationId (required)
* @param memberId memberId (required)
* @param body Message (required)
* @return WebChatMessage
* @throws ApiException if the request fails on the server
* @throws IOException if the request fails to be processed
*/
public WebChatMessage postWebchatGuestConversationMemberMessages(String conversationId, String memberId, CreateWebChatMessageRequest body) throws IOException, ApiException {
return postWebchatGuestConversationMemberMessages(createPostWebchatGuestConversationMemberMessagesRequest(conversationId, memberId, body));
}
/**
* Send a message in a chat conversation.
*
* @param conversationId conversationId (required)
* @param memberId memberId (required)
* @param body Message (required)
* @return WebChatMessage
* @throws IOException if the request fails to be processed
*/
public ApiResponse postWebchatGuestConversationMemberMessagesWithHttpInfo(String conversationId, String memberId, CreateWebChatMessageRequest body) throws IOException {
return postWebchatGuestConversationMemberMessages(createPostWebchatGuestConversationMemberMessagesRequest(conversationId, memberId, body).withHttpInfo());
}
private PostWebchatGuestConversationMemberMessagesRequest createPostWebchatGuestConversationMemberMessagesRequest(String conversationId, String memberId, CreateWebChatMessageRequest body) {
return PostWebchatGuestConversationMemberMessagesRequest.builder()
.withConversationId(conversationId)
.withMemberId(memberId)
.withBody(body)
.build();
}
/**
* Send a message in a chat conversation.
*
* @param request The request object
* @return WebChatMessage
* @throws ApiException if the request fails on the server
* @throws IOException if the request fails to be processed
*/
public WebChatMessage postWebchatGuestConversationMemberMessages(PostWebchatGuestConversationMemberMessagesRequest request) throws IOException, ApiException {
try {
ApiResponse response = pcapiClient.invoke(request.withHttpInfo(), new TypeReference() {});
return response.getBody();
}
catch (ApiException | IOException exception) {
if (pcapiClient.getShouldThrowErrors()) throw exception;
return null;
}
}
/**
* Send a message in a chat conversation.
*
* @param request The request object
* @return the response
* @throws IOException if the request fails to be processed
*/
public ApiResponse postWebchatGuestConversationMemberMessages(ApiRequest request) throws IOException {
try {
return pcapiClient.invoke(request, new TypeReference() {});
}
catch (ApiException exception) {
@SuppressWarnings("unchecked")
ApiResponse response = (ApiResponse)(ApiResponse)exception;
return response;
}
catch (Throwable exception) {
if (pcapiClient.getShouldThrowErrors()) {
if (exception instanceof IOException) {
throw (IOException)exception;
}
throw new RuntimeException(exception);
}
@SuppressWarnings("unchecked")
ApiResponse response = (ApiResponse)(ApiResponse)(new ApiException(exception));
return response;
}
}
/**
* Send a typing-indicator in a chat conversation.
*
* @param conversationId conversationId (required)
* @param memberId memberId (required)
* @return WebChatTyping
* @throws ApiException if the request fails on the server
* @throws IOException if the request fails to be processed
*/
public WebChatTyping postWebchatGuestConversationMemberTyping(String conversationId, String memberId) throws IOException, ApiException {
return postWebchatGuestConversationMemberTyping(createPostWebchatGuestConversationMemberTypingRequest(conversationId, memberId));
}
/**
* Send a typing-indicator in a chat conversation.
*
* @param conversationId conversationId (required)
* @param memberId memberId (required)
* @return WebChatTyping
* @throws IOException if the request fails to be processed
*/
public ApiResponse postWebchatGuestConversationMemberTypingWithHttpInfo(String conversationId, String memberId) throws IOException {
return postWebchatGuestConversationMemberTyping(createPostWebchatGuestConversationMemberTypingRequest(conversationId, memberId).withHttpInfo());
}
private PostWebchatGuestConversationMemberTypingRequest createPostWebchatGuestConversationMemberTypingRequest(String conversationId, String memberId) {
return PostWebchatGuestConversationMemberTypingRequest.builder()
.withConversationId(conversationId)
.withMemberId(memberId)
.build();
}
/**
* Send a typing-indicator in a chat conversation.
*
* @param request The request object
* @return WebChatTyping
* @throws ApiException if the request fails on the server
* @throws IOException if the request fails to be processed
*/
public WebChatTyping postWebchatGuestConversationMemberTyping(PostWebchatGuestConversationMemberTypingRequest request) throws IOException, ApiException {
try {
ApiResponse response = pcapiClient.invoke(request.withHttpInfo(), new TypeReference() {});
return response.getBody();
}
catch (ApiException | IOException exception) {
if (pcapiClient.getShouldThrowErrors()) throw exception;
return null;
}
}
/**
* Send a typing-indicator in a chat conversation.
*
* @param request The request object
* @return the response
* @throws IOException if the request fails to be processed
*/
public ApiResponse postWebchatGuestConversationMemberTyping(ApiRequest request) throws IOException {
try {
return pcapiClient.invoke(request, new TypeReference() {});
}
catch (ApiException exception) {
@SuppressWarnings("unchecked")
ApiResponse response = (ApiResponse)(ApiResponse)exception;
return response;
}
catch (Throwable exception) {
if (pcapiClient.getShouldThrowErrors()) {
if (exception instanceof IOException) {
throw (IOException)exception;
}
throw new RuntimeException(exception);
}
@SuppressWarnings("unchecked")
ApiResponse response = (ApiResponse)(ApiResponse)(new ApiException(exception));
return response;
}
}
/**
* Create an ACD chat conversation from an external customer.
* This endpoint will create a new ACD Chat conversation under the specified Chat Deployment. The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the 'memberAuthToken' field should include his JWT as generated by the 'POST /api/v2/signeddata' resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted. The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the 'eventStreamUri' field of the response; the conversation is not routed until the event stream is attached.
* @param body CreateConversationRequest (required)
* @return CreateWebChatConversationResponse
* @throws ApiException if the request fails on the server
* @throws IOException if the request fails to be processed
*/
public CreateWebChatConversationResponse postWebchatGuestConversations(CreateWebChatConversationRequest body) throws IOException, ApiException {
return postWebchatGuestConversations(createPostWebchatGuestConversationsRequest(body));
}
/**
* Create an ACD chat conversation from an external customer.
* This endpoint will create a new ACD Chat conversation under the specified Chat Deployment. The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the 'memberAuthToken' field should include his JWT as generated by the 'POST /api/v2/signeddata' resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted. The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the 'eventStreamUri' field of the response; the conversation is not routed until the event stream is attached.
* @param body CreateConversationRequest (required)
* @return CreateWebChatConversationResponse
* @throws IOException if the request fails to be processed
*/
public ApiResponse postWebchatGuestConversationsWithHttpInfo(CreateWebChatConversationRequest body) throws IOException {
return postWebchatGuestConversations(createPostWebchatGuestConversationsRequest(body).withHttpInfo());
}
private PostWebchatGuestConversationsRequest createPostWebchatGuestConversationsRequest(CreateWebChatConversationRequest body) {
return PostWebchatGuestConversationsRequest.builder()
.withBody(body)
.build();
}
/**
* Create an ACD chat conversation from an external customer.
* This endpoint will create a new ACD Chat conversation under the specified Chat Deployment. The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the 'memberAuthToken' field should include his JWT as generated by the 'POST /api/v2/signeddata' resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted. The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the 'eventStreamUri' field of the response; the conversation is not routed until the event stream is attached.
* @param request The request object
* @return CreateWebChatConversationResponse
* @throws ApiException if the request fails on the server
* @throws IOException if the request fails to be processed
*/
public CreateWebChatConversationResponse postWebchatGuestConversations(PostWebchatGuestConversationsRequest request) throws IOException, ApiException {
try {
ApiResponse response = pcapiClient.invoke(request.withHttpInfo(), new TypeReference() {});
return response.getBody();
}
catch (ApiException | IOException exception) {
if (pcapiClient.getShouldThrowErrors()) throw exception;
return null;
}
}
/**
* Create an ACD chat conversation from an external customer.
* This endpoint will create a new ACD Chat conversation under the specified Chat Deployment. The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the 'memberAuthToken' field should include his JWT as generated by the 'POST /api/v2/signeddata' resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted. The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the 'eventStreamUri' field of the response; the conversation is not routed until the event stream is attached.
* @param request The request object
* @return the response
* @throws IOException if the request fails to be processed
*/
public ApiResponse postWebchatGuestConversations(ApiRequest request) throws IOException {
try {
return pcapiClient.invoke(request, new TypeReference() {});
}
catch (ApiException exception) {
@SuppressWarnings("unchecked")
ApiResponse response = (ApiResponse)(ApiResponse)exception;
return response;
}
catch (Throwable exception) {
if (pcapiClient.getShouldThrowErrors()) {
if (exception instanceof IOException) {
throw (IOException)exception;
}
throw new RuntimeException(exception);
}
@SuppressWarnings("unchecked")
ApiResponse response = (ApiResponse)(ApiResponse)(new ApiException(exception));
return response;
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy