Package com.mypurecloud.sdk.v2.api
Class ChatApi
java.lang.Object
com.mypurecloud.sdk.v2.api.ChatApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidDelete a message in a roomdeleteChatsRoomMessage(ApiRequest<Void> request) Delete a message in a roomvoiddeleteChatsRoomMessage(String roomJid, String messageId) Delete a message in a roomvoidRemove a pinned message from a roomdeleteChatsRoomMessagesPin(ApiRequest<Void> request) Remove a pinned message from a roomvoiddeleteChatsRoomMessagesPin(String roomJid, String pinnedMessageId) Remove a pinned message from a roomdeleteChatsRoomMessagesPinWithHttpInfo(String roomJid, String pinnedMessageId) Remove a pinned message from a roomdeleteChatsRoomMessageWithHttpInfo(String roomJid, String messageId) Delete a message in a roomvoidRemove a user from a room.deleteChatsRoomParticipant(ApiRequest<Void> request) Remove a user from a room.voiddeleteChatsRoomParticipant(String roomJid, String userId) Remove a user from a room.deleteChatsRoomParticipantWithHttpInfo(String roomJid, String userId) Remove a user from a room.voidDelete a message to a userdeleteChatsUserMessage(ApiRequest<Void> request) Delete a message to a uservoiddeleteChatsUserMessage(String userId, String messageId) Delete a message to a uservoidRemove a pinned message from a 1on1deleteChatsUserMessagesPin(ApiRequest<Void> request) Remove a pinned message from a 1on1voiddeleteChatsUserMessagesPin(String userId, String pinnedMessageId) Remove a pinned message from a 1on1deleteChatsUserMessagesPinWithHttpInfo(String userId, String pinnedMessageId) Remove a pinned message from a 1on1deleteChatsUserMessageWithHttpInfo(String userId, String messageId) Delete a message to a uservoidDelete a user's chat settingsvoidDelete a user's chat settingsdeleteChatsUsersMeSettings(ApiRequest<Void> request) Delete a user's chat settingsDelete a user's chat settingsgetChatsMessage(GetChatsMessageRequest request) Get a messagegetChatsMessage(ApiRequest<Void> request) Get a messagegetChatsMessage(String messageId) Get a messagegetChatsMessageWithHttpInfo(String messageId) Get a messagegetChatsRoom(GetChatsRoomRequest request) Get a roomgetChatsRoom(ApiRequest<Void> request) Get a roomgetChatsRoom(String roomJid) Get a roomGet messages by id(s) from a roomgetChatsRoomMessage(ApiRequest<Void> request) Get messages by id(s) from a roomgetChatsRoomMessage(String roomJid, String messageIds) Get messages by id(s) from a roomGet a room's message historygetChatsRoomMessages(ApiRequest<Void> request) Get a room's message historygetChatsRoomMessages(String roomJid, String limit, String before, String after, Boolean excludeMetadata) Get a room's message historygetChatsRoomMessagesWithHttpInfo(String roomJid, String limit, String before, String after, Boolean excludeMetadata) Get a room's message historygetChatsRoomMessageWithHttpInfo(String roomJid, String messageIds) Get messages by id(s) from a roomGet a room participantgetChatsRoomParticipant(ApiRequest<Void> request) Get a room participantgetChatsRoomParticipant(String roomJid, String participantJid) Get a room participantGet room participants in a roomgetChatsRoomParticipants(ApiRequest<Void> request) Get room participants in a roomgetChatsRoomParticipants(String roomJid, Boolean notify) Get room participants in a roomgetChatsRoomParticipantsWithHttpInfo(String roomJid, Boolean notify) Get room participants in a roomgetChatsRoomParticipantWithHttpInfo(String roomJid, String participantJid) Get a room participantgetChatsRoomWithHttpInfo(String roomJid) Get a roomGet Chat Settings.getChatsSettings(GetChatsSettingsRequest request) Get Chat Settings.getChatsSettings(ApiRequest<Void> request) Get Chat Settings.Get Chat Settings.Get history by threadgetChatsThreadMessages(ApiRequest<Void> request) Get history by threadgetChatsThreadMessages(String threadId, String limit, String before, String after, Boolean excludeMetadata) Get history by threadgetChatsThreadMessagesWithHttpInfo(String threadId, String limit, String before, String after, Boolean excludeMetadata) Get history by threadgetChatsUser(GetChatsUserRequest request) Get information for a 1on1getChatsUser(ApiRequest<Void> request) Get information for a 1on1getChatsUser(String userId) Get information for a 1on1Get messages by id(s) from a 1on1getChatsUserMessage(ApiRequest<Void> request) Get messages by id(s) from a 1on1getChatsUserMessage(String userId, String messageIds) Get messages by id(s) from a 1on1Get 1on1 History between a usergetChatsUserMessages(ApiRequest<Void> request) Get 1on1 History between a usergetChatsUserMessages(String userId, String limit, String before, String after, Boolean excludeMetadata) Get 1on1 History between a usergetChatsUserMessagesWithHttpInfo(String userId, String limit, String before, String after, Boolean excludeMetadata) Get 1on1 History between a usergetChatsUserMessageWithHttpInfo(String userId, String messageIds) Get messages by id(s) from a 1on1Get a user's chat settingsgetChatsUserSettings(ApiRequest<Void> request) Get a user's chat settingsgetChatsUserSettings(String userId) Get a user's chat settingsGet a user's chat settingsGet a user's chat settingsGet a user's chat settingsgetChatsUsersMeSettings(ApiRequest<Void> request) Get a user's chat settingsGet a user's chat settingsgetChatsUserWithHttpInfo(String userId) Get information for a 1on1voidpatchChatsRoom(PatchChatsRoomRequest request) Set properties for a roompatchChatsRoom(ApiRequest<RoomUpdateRequest> request) Set properties for a roomvoidpatchChatsRoom(String roomJid, RoomUpdateRequest body) Set properties for a roomEdit a message in a roompatchChatsRoomMessage(ApiRequest<SendMessageBody> request) Edit a message in a roompatchChatsRoomMessage(String roomJid, String messageId, SendMessageBody body) Edit a message in a roompatchChatsRoomMessageWithHttpInfo(String roomJid, String messageId, SendMessageBody body) Edit a message in a roompatchChatsRoomWithHttpInfo(String roomJid, RoomUpdateRequest body) Set properties for a roomPatch Chat Settings.patchChatsSettings(ApiRequest<ChatSettings> request) Patch Chat Settings.Patch Chat Settings.Patch Chat Settings.Edit a message to a userpatchChatsUserMessage(ApiRequest<SendMessageBody> request) Edit a message to a userpatchChatsUserMessage(String userId, String messageId, SendMessageBody body) Edit a message to a userpatchChatsUserMessageWithHttpInfo(String userId, String messageId, SendMessageBody body) Edit a message to a userUpdate a user's chat settingspatchChatsUserSettings(ApiRequest<ChatUserSettings> request) Update a user's chat settingspatchChatsUserSettings(String userId, ChatUserSettings body) Update a user's chat settingspatchChatsUserSettingsWithHttpInfo(String userId, ChatUserSettings body) Update a user's chat settingsUpdate a user's chat settingsUpdate a user's chat settingsUpdate a user's chat settingsUpdate a user's chat settingsSend a message to a roompostChatsRoomMessages(ApiRequest<SendMessageBody> request) Send a message to a roompostChatsRoomMessages(String roomJid, SendMessageBody body) Send a message to a roomvoidAdd pinned messages for a room, up to a maximum of 5 pinned messagesAdd pinned messages for a room, up to a maximum of 5 pinned messagesvoidpostChatsRoomMessagesPins(String roomJid, PinnedMessageRequest body) Add pinned messages for a room, up to a maximum of 5 pinned messagespostChatsRoomMessagesPinsWithHttpInfo(String roomJid, PinnedMessageRequest body) Add pinned messages for a room, up to a maximum of 5 pinned messagespostChatsRoomMessagesWithHttpInfo(String roomJid, SendMessageBody body) Send a message to a roomvoidJoin a roompostChatsRoomParticipant(ApiRequest<Void> request) Join a roomvoidpostChatsRoomParticipant(String roomJid, String userId) Join a roompostChatsRoomParticipantWithHttpInfo(String roomJid, String userId) Join a roompostChatsRooms(PostChatsRoomsRequest request) Create an adhoc roompostChatsRooms(ApiRequest<CreateRoomRequest> request) Create an adhoc roomCreate an adhoc roomCreate an adhoc roomSend a message to a userpostChatsUserMessages(ApiRequest<SendMessageBody> request) Send a message to a userpostChatsUserMessages(String userId, SendMessageBody body) Send a message to a uservoidAdd pinned messages for a 1on1, up to a maximum of 5 pinned messagesAdd pinned messages for a 1on1, up to a maximum of 5 pinned messagesvoidpostChatsUserMessagesPins(String userId, PinnedMessageRequest body) Add pinned messages for a 1on1, up to a maximum of 5 pinned messagespostChatsUserMessagesPinsWithHttpInfo(String userId, PinnedMessageRequest body) Add pinned messages for a 1on1, up to a maximum of 5 pinned messagespostChatsUserMessagesWithHttpInfo(String userId, SendMessageBody body) Send a message to a uservoidCreate a user's chat settingsCreate a user's chat settingsvoidCreate a user's chat settingsCreate a user's chat settingsvoidUpdate reactions to a messageUpdate reactions to a messagevoidputChatsMessageReactions(String messageId, ChatReactionUpdate body) Update reactions to a messageputChatsMessageReactionsWithHttpInfo(String messageId, ChatReactionUpdate body) Update reactions to a messageputChatsSettings(PutChatsSettingsRequest request) Update Chat Settings.putChatsSettings(ApiRequest<ChatSettings> request) Update Chat Settings.putChatsSettings(ChatSettings body) Update Chat Settings.Update Chat Settings.
-
Constructor Details
-
ChatApi
public ChatApi() -
ChatApi
-
-
Method Details
-
deleteChatsRoomMessage
public void deleteChatsRoomMessage(String roomJid, String messageId) throws IOException, ApiException Delete a message in a room- Parameters:
roomJid- roomId (required)messageId- messageId (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteChatsRoomMessageWithHttpInfo
public ApiResponse<Void> deleteChatsRoomMessageWithHttpInfo(String roomJid, String messageId) throws IOException Delete a message in a room- Parameters:
roomJid- roomId (required)messageId- messageId (required)- Throws:
IOException- if the request fails to be processed
-
deleteChatsRoomMessage
public void deleteChatsRoomMessage(DeleteChatsRoomMessageRequest request) throws IOException, ApiException Delete a message in a room- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteChatsRoomMessage
Delete a message in a room- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteChatsRoomMessagesPin
public void deleteChatsRoomMessagesPin(String roomJid, String pinnedMessageId) throws IOException, ApiException Remove a pinned message from a room- Parameters:
roomJid- roomJid (required)pinnedMessageId- pinnedMessageId (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteChatsRoomMessagesPinWithHttpInfo
public ApiResponse<Void> deleteChatsRoomMessagesPinWithHttpInfo(String roomJid, String pinnedMessageId) throws IOException Remove a pinned message from a room- Parameters:
roomJid- roomJid (required)pinnedMessageId- pinnedMessageId (required)- Throws:
IOException- if the request fails to be processed
-
deleteChatsRoomMessagesPin
public void deleteChatsRoomMessagesPin(DeleteChatsRoomMessagesPinRequest request) throws IOException, ApiException Remove a pinned message from a room- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteChatsRoomMessagesPin
Remove a pinned message from a room- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteChatsRoomParticipant
public void deleteChatsRoomParticipant(String roomJid, String userId) throws IOException, ApiException Remove a user from a room.- Parameters:
roomJid- roomJid (required)userId- userId (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteChatsRoomParticipantWithHttpInfo
public ApiResponse<Void> deleteChatsRoomParticipantWithHttpInfo(String roomJid, String userId) throws IOException Remove a user from a room.- Parameters:
roomJid- roomJid (required)userId- userId (required)- Throws:
IOException- if the request fails to be processed
-
deleteChatsRoomParticipant
public void deleteChatsRoomParticipant(DeleteChatsRoomParticipantRequest request) throws IOException, ApiException Remove a user from a room.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteChatsRoomParticipant
Remove a user from a room.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteChatsUserMessage
public void deleteChatsUserMessage(String userId, String messageId) throws IOException, ApiException Delete a message to a user- Parameters:
userId- userId (required)messageId- messageId (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteChatsUserMessageWithHttpInfo
public ApiResponse<Void> deleteChatsUserMessageWithHttpInfo(String userId, String messageId) throws IOException Delete a message to a user- Parameters:
userId- userId (required)messageId- messageId (required)- Throws:
IOException- if the request fails to be processed
-
deleteChatsUserMessage
public void deleteChatsUserMessage(DeleteChatsUserMessageRequest request) throws IOException, ApiException Delete a message to a user- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteChatsUserMessage
Delete a message to a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteChatsUserMessagesPin
public void deleteChatsUserMessagesPin(String userId, String pinnedMessageId) throws IOException, ApiException Remove a pinned message from a 1on1- Parameters:
userId- userId (required)pinnedMessageId- pinnedMessageId (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteChatsUserMessagesPinWithHttpInfo
public ApiResponse<Void> deleteChatsUserMessagesPinWithHttpInfo(String userId, String pinnedMessageId) throws IOException Remove a pinned message from a 1on1- Parameters:
userId- userId (required)pinnedMessageId- pinnedMessageId (required)- Throws:
IOException- if the request fails to be processed
-
deleteChatsUserMessagesPin
public void deleteChatsUserMessagesPin(DeleteChatsUserMessagesPinRequest request) throws IOException, ApiException Remove a pinned message from a 1on1- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteChatsUserMessagesPin
Remove a pinned message from a 1on1- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteChatsUsersMeSettings
Delete a user's chat settings- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteChatsUsersMeSettingsWithHttpInfo
Delete a user's chat settings- Throws:
IOException- if the request fails to be processed
-
deleteChatsUsersMeSettings
public void deleteChatsUsersMeSettings(DeleteChatsUsersMeSettingsRequest request) throws IOException, ApiException Delete a user's chat settings- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteChatsUsersMeSettings
Delete a user's chat settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getChatsMessage
Get a message- Parameters:
messageId- messageId (required)- Returns:
- ChatMessageResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsMessageWithHttpInfo
public ApiResponse<ChatMessageResponse> getChatsMessageWithHttpInfo(String messageId) throws IOException Get a message- Parameters:
messageId- messageId (required)- Returns:
- ChatMessageResponse
- Throws:
IOException- if the request fails to be processed
-
getChatsMessage
public ChatMessageResponse getChatsMessage(GetChatsMessageRequest request) throws IOException, ApiException Get a message- Parameters:
request- The request object- Returns:
- ChatMessageResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsMessage
public ApiResponse<ChatMessageResponse> getChatsMessage(ApiRequest<Void> request) throws IOException Get a message- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getChatsRoom
Get a room- Parameters:
roomJid- roomJid (required)- Returns:
- Room
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsRoomWithHttpInfo
Get a room- Parameters:
roomJid- roomJid (required)- Returns:
- Room
- Throws:
IOException- if the request fails to be processed
-
getChatsRoom
Get a room- Parameters:
request- The request object- Returns:
- Room
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsRoom
Get a room- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getChatsRoomMessage
public ChatMessageEntityListing getChatsRoomMessage(String roomJid, String messageIds) throws IOException, ApiException Get messages by id(s) from a room- Parameters:
roomJid- roomJid (required)messageIds- messageIds, comma separated (required)- Returns:
- ChatMessageEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsRoomMessageWithHttpInfo
public ApiResponse<ChatMessageEntityListing> getChatsRoomMessageWithHttpInfo(String roomJid, String messageIds) throws IOException Get messages by id(s) from a room- Parameters:
roomJid- roomJid (required)messageIds- messageIds, comma separated (required)- Returns:
- ChatMessageEntityListing
- Throws:
IOException- if the request fails to be processed
-
getChatsRoomMessage
public ChatMessageEntityListing getChatsRoomMessage(GetChatsRoomMessageRequest request) throws IOException, ApiException Get messages by id(s) from a room- Parameters:
request- The request object- Returns:
- ChatMessageEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsRoomMessage
public ApiResponse<ChatMessageEntityListing> getChatsRoomMessage(ApiRequest<Void> request) throws IOException Get messages by id(s) from a room- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getChatsRoomMessages
public ChatMessageEntityListing getChatsRoomMessages(String roomJid, String limit, String before, String after, Boolean excludeMetadata) throws IOException, ApiException Get a room's message history- Parameters:
roomJid- roomJid (required)limit- The maximum number of messages to retrieve (optional)before- The cutoff date for messages to retrieve (optional)after- The beginning date for messages to retrieve (optional)excludeMetadata- Whether to exclude metadata for messages (optional)- Returns:
- ChatMessageEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsRoomMessagesWithHttpInfo
public ApiResponse<ChatMessageEntityListing> getChatsRoomMessagesWithHttpInfo(String roomJid, String limit, String before, String after, Boolean excludeMetadata) throws IOException Get a room's message history- Parameters:
roomJid- roomJid (required)limit- The maximum number of messages to retrieve (optional)before- The cutoff date for messages to retrieve (optional)after- The beginning date for messages to retrieve (optional)excludeMetadata- Whether to exclude metadata for messages (optional)- Returns:
- ChatMessageEntityListing
- Throws:
IOException- if the request fails to be processed
-
getChatsRoomMessages
public ChatMessageEntityListing getChatsRoomMessages(GetChatsRoomMessagesRequest request) throws IOException, ApiException Get a room's message history- Parameters:
request- The request object- Returns:
- ChatMessageEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsRoomMessages
public ApiResponse<ChatMessageEntityListing> getChatsRoomMessages(ApiRequest<Void> request) throws IOException Get a room's message history- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getChatsRoomParticipant
public RoomParticipant getChatsRoomParticipant(String roomJid, String participantJid) throws IOException, ApiException Get a room participant- Parameters:
roomJid- roomJid (required)participantJid- participantJid (required)- Returns:
- RoomParticipant
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsRoomParticipantWithHttpInfo
public ApiResponse<RoomParticipant> getChatsRoomParticipantWithHttpInfo(String roomJid, String participantJid) throws IOException Get a room participant- Parameters:
roomJid- roomJid (required)participantJid- participantJid (required)- Returns:
- RoomParticipant
- Throws:
IOException- if the request fails to be processed
-
getChatsRoomParticipant
public RoomParticipant getChatsRoomParticipant(GetChatsRoomParticipantRequest request) throws IOException, ApiException Get a room participant- Parameters:
request- The request object- Returns:
- RoomParticipant
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsRoomParticipant
public ApiResponse<RoomParticipant> getChatsRoomParticipant(ApiRequest<Void> request) throws IOException Get a room participant- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getChatsRoomParticipants
public RoomParticipantsResponse getChatsRoomParticipants(String roomJid, Boolean notify) throws IOException, ApiException Get room participants in a room- Parameters:
roomJid- roomJid (required)notify- Whether to get users to notify (optional)- Returns:
- RoomParticipantsResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsRoomParticipantsWithHttpInfo
public ApiResponse<RoomParticipantsResponse> getChatsRoomParticipantsWithHttpInfo(String roomJid, Boolean notify) throws IOException Get room participants in a room- Parameters:
roomJid- roomJid (required)notify- Whether to get users to notify (optional)- Returns:
- RoomParticipantsResponse
- Throws:
IOException- if the request fails to be processed
-
getChatsRoomParticipants
public RoomParticipantsResponse getChatsRoomParticipants(GetChatsRoomParticipantsRequest request) throws IOException, ApiException Get room participants in a room- Parameters:
request- The request object- Returns:
- RoomParticipantsResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsRoomParticipants
public ApiResponse<RoomParticipantsResponse> getChatsRoomParticipants(ApiRequest<Void> request) throws IOException Get room participants in a room- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getChatsSettings
Get Chat Settings.- Returns:
- ChatSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsSettingsWithHttpInfo
Get Chat Settings.- Returns:
- ChatSettings
- Throws:
IOException- if the request fails to be processed
-
getChatsSettings
public ChatSettings getChatsSettings(GetChatsSettingsRequest request) throws IOException, ApiException Get Chat Settings.- Parameters:
request- The request object- Returns:
- ChatSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsSettings
Get Chat Settings.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getChatsThreadMessages
public ChatMessageEntityListing getChatsThreadMessages(String threadId, String limit, String before, String after, Boolean excludeMetadata) throws IOException, ApiException Get history by thread- Parameters:
threadId- threadId (required)limit- The maximum number of messages to retrieve (optional)before- The cutoff date for messages to retrieve (optional)after- The beginning date for messages to retrieve (optional)excludeMetadata- Whether to exclude metadata for messages (optional)- Returns:
- ChatMessageEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsThreadMessagesWithHttpInfo
public ApiResponse<ChatMessageEntityListing> getChatsThreadMessagesWithHttpInfo(String threadId, String limit, String before, String after, Boolean excludeMetadata) throws IOException Get history by thread- Parameters:
threadId- threadId (required)limit- The maximum number of messages to retrieve (optional)before- The cutoff date for messages to retrieve (optional)after- The beginning date for messages to retrieve (optional)excludeMetadata- Whether to exclude metadata for messages (optional)- Returns:
- ChatMessageEntityListing
- Throws:
IOException- if the request fails to be processed
-
getChatsThreadMessages
public ChatMessageEntityListing getChatsThreadMessages(GetChatsThreadMessagesRequest request) throws IOException, ApiException Get history by thread- Parameters:
request- The request object- Returns:
- ChatMessageEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsThreadMessages
public ApiResponse<ChatMessageEntityListing> getChatsThreadMessages(ApiRequest<Void> request) throws IOException Get history by thread- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getChatsUser
Get information for a 1on1- Parameters:
userId- userId (required)- Returns:
- OneOnOne
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsUserWithHttpInfo
Get information for a 1on1- Parameters:
userId- userId (required)- Returns:
- OneOnOne
- Throws:
IOException- if the request fails to be processed
-
getChatsUser
Get information for a 1on1- Parameters:
request- The request object- Returns:
- OneOnOne
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsUser
Get information for a 1on1- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getChatsUserMessage
public ChatMessageEntityListing getChatsUserMessage(String userId, String messageIds) throws IOException, ApiException Get messages by id(s) from a 1on1- Parameters:
userId- userId (required)messageIds- messageIds, comma separated (required)- Returns:
- ChatMessageEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsUserMessageWithHttpInfo
public ApiResponse<ChatMessageEntityListing> getChatsUserMessageWithHttpInfo(String userId, String messageIds) throws IOException Get messages by id(s) from a 1on1- Parameters:
userId- userId (required)messageIds- messageIds, comma separated (required)- Returns:
- ChatMessageEntityListing
- Throws:
IOException- if the request fails to be processed
-
getChatsUserMessage
public ChatMessageEntityListing getChatsUserMessage(GetChatsUserMessageRequest request) throws IOException, ApiException Get messages by id(s) from a 1on1- Parameters:
request- The request object- Returns:
- ChatMessageEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsUserMessage
public ApiResponse<ChatMessageEntityListing> getChatsUserMessage(ApiRequest<Void> request) throws IOException Get messages by id(s) from a 1on1- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getChatsUserMessages
public ChatMessageResponse getChatsUserMessages(String userId, String limit, String before, String after, Boolean excludeMetadata) throws IOException, ApiException Get 1on1 History between a user- Parameters:
userId- userId (required)limit- The maximum number of messages to retrieve (optional)before- The cutoff date for messages to retrieve (optional)after- The beginning date for messages to retrieve (optional)excludeMetadata- Whether to exclude metadata for messages (optional)- Returns:
- ChatMessageResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsUserMessagesWithHttpInfo
public ApiResponse<ChatMessageResponse> getChatsUserMessagesWithHttpInfo(String userId, String limit, String before, String after, Boolean excludeMetadata) throws IOException Get 1on1 History between a user- Parameters:
userId- userId (required)limit- The maximum number of messages to retrieve (optional)before- The cutoff date for messages to retrieve (optional)after- The beginning date for messages to retrieve (optional)excludeMetadata- Whether to exclude metadata for messages (optional)- Returns:
- ChatMessageResponse
- Throws:
IOException- if the request fails to be processed
-
getChatsUserMessages
public ChatMessageResponse getChatsUserMessages(GetChatsUserMessagesRequest request) throws IOException, ApiException Get 1on1 History between a user- Parameters:
request- The request object- Returns:
- ChatMessageResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsUserMessages
public ApiResponse<ChatMessageResponse> getChatsUserMessages(ApiRequest<Void> request) throws IOException Get 1on1 History between a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getChatsUserSettings
Get a user's chat settings- Parameters:
userId- User ID (required)- Returns:
- ChatUserSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsUserSettingsWithHttpInfo
public ApiResponse<ChatUserSettings> getChatsUserSettingsWithHttpInfo(String userId) throws IOException Get a user's chat settings- Parameters:
userId- User ID (required)- Returns:
- ChatUserSettings
- Throws:
IOException- if the request fails to be processed
-
getChatsUserSettings
public ChatUserSettings getChatsUserSettings(GetChatsUserSettingsRequest request) throws IOException, ApiException Get a user's chat settings- Parameters:
request- The request object- Returns:
- ChatUserSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsUserSettings
public ApiResponse<ChatUserSettings> getChatsUserSettings(ApiRequest<Void> request) throws IOException Get a user's chat settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getChatsUsersMeSettings
Get a user's chat settings- Returns:
- UserSettingsForChat
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsUsersMeSettingsWithHttpInfo
Get a user's chat settings- Returns:
- UserSettingsForChat
- Throws:
IOException- if the request fails to be processed
-
getChatsUsersMeSettings
public UserSettingsForChat getChatsUsersMeSettings(GetChatsUsersMeSettingsRequest request) throws IOException, ApiException Get a user's chat settings- Parameters:
request- The request object- Returns:
- UserSettingsForChat
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getChatsUsersMeSettings
public ApiResponse<UserSettingsForChat> getChatsUsersMeSettings(ApiRequest<Void> request) throws IOException Get a user's chat settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchChatsRoom
Set properties for a room- Parameters:
roomJid- roomJid (required)body- Room properties (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchChatsRoomWithHttpInfo
public ApiResponse<Void> patchChatsRoomWithHttpInfo(String roomJid, RoomUpdateRequest body) throws IOException Set properties for a room- Parameters:
roomJid- roomJid (required)body- Room properties (required)- Throws:
IOException- if the request fails to be processed
-
patchChatsRoom
Set properties for a room- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchChatsRoom
Set properties for a room- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchChatsRoomMessage
public ChatSendMessageResponse patchChatsRoomMessage(String roomJid, String messageId, SendMessageBody body) throws IOException, ApiException Edit a message in a room- Parameters:
roomJid- roomId (required)messageId- messageId (required)body- messageBody (required)- Returns:
- ChatSendMessageResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchChatsRoomMessageWithHttpInfo
public ApiResponse<ChatSendMessageResponse> patchChatsRoomMessageWithHttpInfo(String roomJid, String messageId, SendMessageBody body) throws IOException Edit a message in a room- Parameters:
roomJid- roomId (required)messageId- messageId (required)body- messageBody (required)- Returns:
- ChatSendMessageResponse
- Throws:
IOException- if the request fails to be processed
-
patchChatsRoomMessage
public ChatSendMessageResponse patchChatsRoomMessage(PatchChatsRoomMessageRequest request) throws IOException, ApiException Edit a message in a room- Parameters:
request- The request object- Returns:
- ChatSendMessageResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchChatsRoomMessage
public ApiResponse<ChatSendMessageResponse> patchChatsRoomMessage(ApiRequest<SendMessageBody> request) throws IOException Edit a message in a room- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchChatsSettings
Patch Chat Settings.- Parameters:
body- Chat (required)- Returns:
- ChatSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchChatsSettingsWithHttpInfo
public ApiResponse<ChatSettings> patchChatsSettingsWithHttpInfo(ChatSettings body) throws IOException Patch Chat Settings.- Parameters:
body- Chat (required)- Returns:
- ChatSettings
- Throws:
IOException- if the request fails to be processed
-
patchChatsSettings
public ChatSettings patchChatsSettings(PatchChatsSettingsRequest request) throws IOException, ApiException Patch Chat Settings.- Parameters:
request- The request object- Returns:
- ChatSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchChatsSettings
public ApiResponse<ChatSettings> patchChatsSettings(ApiRequest<ChatSettings> request) throws IOException Patch Chat Settings.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchChatsUserMessage
public ChatSendMessageResponse patchChatsUserMessage(String userId, String messageId, SendMessageBody body) throws IOException, ApiException Edit a message to a user- Parameters:
userId- userId (required)messageId- messageId (required)body- message body (required)- Returns:
- ChatSendMessageResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchChatsUserMessageWithHttpInfo
public ApiResponse<ChatSendMessageResponse> patchChatsUserMessageWithHttpInfo(String userId, String messageId, SendMessageBody body) throws IOException Edit a message to a user- Parameters:
userId- userId (required)messageId- messageId (required)body- message body (required)- Returns:
- ChatSendMessageResponse
- Throws:
IOException- if the request fails to be processed
-
patchChatsUserMessage
public ChatSendMessageResponse patchChatsUserMessage(PatchChatsUserMessageRequest request) throws IOException, ApiException Edit a message to a user- Parameters:
request- The request object- Returns:
- ChatSendMessageResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchChatsUserMessage
public ApiResponse<ChatSendMessageResponse> patchChatsUserMessage(ApiRequest<SendMessageBody> request) throws IOException Edit a message to a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchChatsUserSettings
public ChatUserSettings patchChatsUserSettings(String userId, ChatUserSettings body) throws IOException, ApiException Update a user's chat settings- Parameters:
userId- User ID (required)body- (required)- Returns:
- ChatUserSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchChatsUserSettingsWithHttpInfo
public ApiResponse<ChatUserSettings> patchChatsUserSettingsWithHttpInfo(String userId, ChatUserSettings body) throws IOException Update a user's chat settings- Parameters:
userId- User ID (required)body- (required)- Returns:
- ChatUserSettings
- Throws:
IOException- if the request fails to be processed
-
patchChatsUserSettings
public ChatUserSettings patchChatsUserSettings(PatchChatsUserSettingsRequest request) throws IOException, ApiException Update a user's chat settings- Parameters:
request- The request object- Returns:
- ChatUserSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchChatsUserSettings
public ApiResponse<ChatUserSettings> patchChatsUserSettings(ApiRequest<ChatUserSettings> request) throws IOException Update a user's chat settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchChatsUsersMeSettings
public UserSettingsForChat patchChatsUsersMeSettings(UserSettingsForChat body) throws IOException, ApiException Update a user's chat settings- Parameters:
body- (required)- Returns:
- UserSettingsForChat
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchChatsUsersMeSettingsWithHttpInfo
public ApiResponse<UserSettingsForChat> patchChatsUsersMeSettingsWithHttpInfo(UserSettingsForChat body) throws IOException Update a user's chat settings- Parameters:
body- (required)- Returns:
- UserSettingsForChat
- Throws:
IOException- if the request fails to be processed
-
patchChatsUsersMeSettings
public UserSettingsForChat patchChatsUsersMeSettings(PatchChatsUsersMeSettingsRequest request) throws IOException, ApiException Update a user's chat settings- Parameters:
request- The request object- Returns:
- UserSettingsForChat
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchChatsUsersMeSettings
public ApiResponse<UserSettingsForChat> patchChatsUsersMeSettings(ApiRequest<UserSettingsForChat> request) throws IOException Update a user's chat settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postChatsRoomMessages
public ChatSendMessageResponse postChatsRoomMessages(String roomJid, SendMessageBody body) throws IOException, ApiException Send a message to a room- Parameters:
roomJid- roomId (required)body- messageBody (required)- Returns:
- ChatSendMessageResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postChatsRoomMessagesWithHttpInfo
public ApiResponse<ChatSendMessageResponse> postChatsRoomMessagesWithHttpInfo(String roomJid, SendMessageBody body) throws IOException Send a message to a room- Parameters:
roomJid- roomId (required)body- messageBody (required)- Returns:
- ChatSendMessageResponse
- Throws:
IOException- if the request fails to be processed
-
postChatsRoomMessages
public ChatSendMessageResponse postChatsRoomMessages(PostChatsRoomMessagesRequest request) throws IOException, ApiException Send a message to a room- Parameters:
request- The request object- Returns:
- ChatSendMessageResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postChatsRoomMessages
public ApiResponse<ChatSendMessageResponse> postChatsRoomMessages(ApiRequest<SendMessageBody> request) throws IOException Send a message to a room- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postChatsRoomMessagesPins
public void postChatsRoomMessagesPins(String roomJid, PinnedMessageRequest body) throws IOException, ApiException Add pinned messages for a room, up to a maximum of 5 pinned messages- Parameters:
roomJid- roomJid (required)body- Pinned Message Ids (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postChatsRoomMessagesPinsWithHttpInfo
public ApiResponse<Void> postChatsRoomMessagesPinsWithHttpInfo(String roomJid, PinnedMessageRequest body) throws IOException Add pinned messages for a room, up to a maximum of 5 pinned messages- Parameters:
roomJid- roomJid (required)body- Pinned Message Ids (required)- Throws:
IOException- if the request fails to be processed
-
postChatsRoomMessagesPins
public void postChatsRoomMessagesPins(PostChatsRoomMessagesPinsRequest request) throws IOException, ApiException Add pinned messages for a room, up to a maximum of 5 pinned messages- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postChatsRoomMessagesPins
public ApiResponse<Void> postChatsRoomMessagesPins(ApiRequest<PinnedMessageRequest> request) throws IOException Add pinned messages for a room, up to a maximum of 5 pinned messages- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postChatsRoomParticipant
public void postChatsRoomParticipant(String roomJid, String userId) throws IOException, ApiException Join a room- Parameters:
roomJid- roomJid (required)userId- userId (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postChatsRoomParticipantWithHttpInfo
public ApiResponse<Void> postChatsRoomParticipantWithHttpInfo(String roomJid, String userId) throws IOException Join a room- Parameters:
roomJid- roomJid (required)userId- userId (required)- Throws:
IOException- if the request fails to be processed
-
postChatsRoomParticipant
public void postChatsRoomParticipant(PostChatsRoomParticipantRequest request) throws IOException, ApiException Join a room- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postChatsRoomParticipant
Join a room- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postChatsRooms
Create an adhoc room- Parameters:
body- Room properties (required)- Returns:
- CreateRoomResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postChatsRoomsWithHttpInfo
public ApiResponse<CreateRoomResponse> postChatsRoomsWithHttpInfo(CreateRoomRequest body) throws IOException Create an adhoc room- Parameters:
body- Room properties (required)- Returns:
- CreateRoomResponse
- Throws:
IOException- if the request fails to be processed
-
postChatsRooms
public CreateRoomResponse postChatsRooms(PostChatsRoomsRequest request) throws IOException, ApiException Create an adhoc room- Parameters:
request- The request object- Returns:
- CreateRoomResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postChatsRooms
public ApiResponse<CreateRoomResponse> postChatsRooms(ApiRequest<CreateRoomRequest> request) throws IOException Create an adhoc room- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postChatsUserMessages
public ChatSendMessageResponse postChatsUserMessages(String userId, SendMessageBody body) throws IOException, ApiException Send a message to a user- Parameters:
userId- userId (required)body- message body (required)- Returns:
- ChatSendMessageResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postChatsUserMessagesWithHttpInfo
public ApiResponse<ChatSendMessageResponse> postChatsUserMessagesWithHttpInfo(String userId, SendMessageBody body) throws IOException Send a message to a user- Parameters:
userId- userId (required)body- message body (required)- Returns:
- ChatSendMessageResponse
- Throws:
IOException- if the request fails to be processed
-
postChatsUserMessages
public ChatSendMessageResponse postChatsUserMessages(PostChatsUserMessagesRequest request) throws IOException, ApiException Send a message to a user- Parameters:
request- The request object- Returns:
- ChatSendMessageResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postChatsUserMessages
public ApiResponse<ChatSendMessageResponse> postChatsUserMessages(ApiRequest<SendMessageBody> request) throws IOException Send a message to a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postChatsUserMessagesPins
public void postChatsUserMessagesPins(String userId, PinnedMessageRequest body) throws IOException, ApiException Add pinned messages for a 1on1, up to a maximum of 5 pinned messages- Parameters:
userId- userId (required)body- Pinned Message Ids (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postChatsUserMessagesPinsWithHttpInfo
public ApiResponse<Void> postChatsUserMessagesPinsWithHttpInfo(String userId, PinnedMessageRequest body) throws IOException Add pinned messages for a 1on1, up to a maximum of 5 pinned messages- Parameters:
userId- userId (required)body- Pinned Message Ids (required)- Throws:
IOException- if the request fails to be processed
-
postChatsUserMessagesPins
public void postChatsUserMessagesPins(PostChatsUserMessagesPinsRequest request) throws IOException, ApiException Add pinned messages for a 1on1, up to a maximum of 5 pinned messages- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postChatsUserMessagesPins
public ApiResponse<Void> postChatsUserMessagesPins(ApiRequest<PinnedMessageRequest> request) throws IOException Add pinned messages for a 1on1, up to a maximum of 5 pinned messages- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postChatsUsersMeSettings
Create a user's chat settings- Parameters:
body- (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postChatsUsersMeSettingsWithHttpInfo
public ApiResponse<Void> postChatsUsersMeSettingsWithHttpInfo(UserChatSettingsPost body) throws IOException Create a user's chat settings- Parameters:
body- (required)- Throws:
IOException- if the request fails to be processed
-
postChatsUsersMeSettings
public void postChatsUsersMeSettings(PostChatsUsersMeSettingsRequest request) throws IOException, ApiException Create a user's chat settings- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postChatsUsersMeSettings
public ApiResponse<Void> postChatsUsersMeSettings(ApiRequest<UserChatSettingsPost> request) throws IOException Create a user's chat settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putChatsMessageReactions
public void putChatsMessageReactions(String messageId, ChatReactionUpdate body) throws IOException, ApiException Update reactions to a message- Parameters:
messageId- messageId (required)body- reactionUpdate (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putChatsMessageReactionsWithHttpInfo
public ApiResponse<Void> putChatsMessageReactionsWithHttpInfo(String messageId, ChatReactionUpdate body) throws IOException Update reactions to a message- Parameters:
messageId- messageId (required)body- reactionUpdate (required)- Throws:
IOException- if the request fails to be processed
-
putChatsMessageReactions
public void putChatsMessageReactions(PutChatsMessageReactionsRequest request) throws IOException, ApiException Update reactions to a message- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putChatsMessageReactions
public ApiResponse<Void> putChatsMessageReactions(ApiRequest<ChatReactionUpdate> request) throws IOException Update reactions to a message- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putChatsSettings
Update Chat Settings.- Parameters:
body- Chat (required)- Returns:
- ChatSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putChatsSettingsWithHttpInfo
Update Chat Settings.- Parameters:
body- Chat (required)- Returns:
- ChatSettings
- Throws:
IOException- if the request fails to be processed
-
putChatsSettings
public ChatSettings putChatsSettings(PutChatsSettingsRequest request) throws IOException, ApiException Update Chat Settings.- Parameters:
request- The request object- Returns:
- ChatSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putChatsSettings
public ApiResponse<ChatSettings> putChatsSettings(ApiRequest<ChatSettings> request) throws IOException Update Chat Settings.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-