Package com.stackone.stackone_client_java

Class Messaging

java.lang.Object

com.stackone.stackone_client_java.Messaging

public class Messaging
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
AsyncMessaging	async()	Switches to the async SDK.
MessagingCreateConversationRequestBuilder	createConversation()	Create Conversation
MessagingCreateConversationResponse	createConversation(java.lang.String xAccountId, MessagingCreateConversationRequestDto messagingCreateConversationRequestDto)	Create Conversation
MessagingCreateConversationResponse	createConversation(java.lang.String xAccountId, MessagingCreateConversationRequestDto messagingCreateConversationRequestDto, java.util.Optional<Options> options)	Create Conversation
MessagingDownloadMessagingAttachmentRequestBuilder	downloadMessagingAttachment()	Download Attachment
MessagingDownloadMessagingAttachmentResponse	downloadMessagingAttachment(MessagingDownloadMessagingAttachmentRequest request)	Download Attachment
MessagingDownloadMessagingAttachmentResponse	downloadMessagingAttachment(MessagingDownloadMessagingAttachmentRequest request, java.util.Optional<Options> options)	Download Attachment
MessagingGetAttachmentRequestBuilder	getAttachment()	Get Attachment
MessagingGetAttachmentResponse	getAttachment(MessagingGetAttachmentRequest request)	Get Attachment
MessagingGetAttachmentResponse	getAttachment(MessagingGetAttachmentRequest request, java.util.Optional<Options> options)	Get Attachment
MessagingGetConversationRequestBuilder	getConversation()	Get Conversation
MessagingGetConversationResponse	getConversation(MessagingGetConversationRequest request)	Get Conversation
MessagingGetConversationResponse	getConversation(MessagingGetConversationRequest request, java.util.Optional<Options> options)	Get Conversation
MessagingGetMessageRequestBuilder	getMessage()	Get Message
MessagingGetMessageResponse	getMessage(MessagingGetMessageRequest request)	Get Message
MessagingGetMessageResponse	getMessage(MessagingGetMessageRequest request, java.util.Optional<Options> options)	Get Message
MessagingGetUserRequestBuilder	getUser()	Get User
MessagingGetUserResponse	getUser(MessagingGetUserRequest request)	Get User
MessagingGetUserResponse	getUser(MessagingGetUserRequest request, java.util.Optional<Options> options)	Get User
MessagingListAttachmentsRequestBuilder	listAttachments()	List Attachments
MessagingListAttachmentsResponse	listAttachments(MessagingListAttachmentsRequest request)	List Attachments
MessagingListAttachmentsResponse	listAttachments(MessagingListAttachmentsRequest request, java.util.Optional<Options> options)	List Attachments
MessagingListConversationMessagesRequestBuilder	listConversationMessages()	List Conversation Messages
MessagingListConversationMessagesResponse	listConversationMessages(MessagingListConversationMessagesRequest request)	List Conversation Messages
MessagingListConversationMessagesResponse	listConversationMessages(MessagingListConversationMessagesRequest request, java.util.Optional<Options> options)	List Conversation Messages
MessagingListConversationsRequestBuilder	listConversations()	List Conversations
MessagingListConversationsResponse	listConversations(MessagingListConversationsRequest request)	List Conversations
MessagingListConversationsResponse	listConversations(MessagingListConversationsRequest request, java.util.Optional<Options> options)	List Conversations
MessagingListUsersRequestBuilder	listUsers()	List Users
MessagingListUsersResponse	listUsers(MessagingListUsersRequest request)	List Users
MessagingListUsersResponse	listUsers(MessagingListUsersRequest request, java.util.Optional<Options> options)	List Users
MessagingSendMessageRequestBuilder	sendMessage()	Send Message
MessagingSendMessageResponse	sendMessage(java.lang.String xAccountId, MessagingMessageSendRequestDto messagingMessageSendRequestDto)	Send Message
MessagingSendMessageResponse	sendMessage(java.lang.String xAccountId, MessagingMessageSendRequestDto messagingMessageSendRequestDto, java.util.Optional<Options> options)	Send Message

Methods inherited from class java.lang.Object

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

Method Detail

async

public AsyncMessaging async()

Switches to the async SDK.

Returns:

The async SDK

listConversations

public MessagingListConversationsRequestBuilder listConversations()

List Conversations

Returns:

The call builder

listConversations

public MessagingListConversationsResponse listConversations(MessagingListConversationsRequest request)
                                                     throws java.lang.Exception

List Conversations

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listConversations

public MessagingListConversationsResponse listConversations(MessagingListConversationsRequest request,
                                                            java.util.Optional<Options> options)
                                                     throws java.lang.Exception

List Conversations

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

createConversation

public MessagingCreateConversationRequestBuilder createConversation()

Create Conversation

Returns:

The call builder

createConversation

public MessagingCreateConversationResponse createConversation(java.lang.String xAccountId,
                                                              MessagingCreateConversationRequestDto messagingCreateConversationRequestDto)
                                                       throws java.lang.Exception

Create Conversation

Parameters:

xAccountId - The account identifier

messagingCreateConversationRequestDto -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

createConversation

public MessagingCreateConversationResponse createConversation(java.lang.String xAccountId,
                                                              MessagingCreateConversationRequestDto messagingCreateConversationRequestDto,
                                                              java.util.Optional<Options> options)
                                                       throws java.lang.Exception

Create Conversation

Parameters:

xAccountId - The account identifier

messagingCreateConversationRequestDto -

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getConversation

public MessagingGetConversationRequestBuilder getConversation()

Get Conversation

Returns:

The call builder

getConversation

public MessagingGetConversationResponse getConversation(MessagingGetConversationRequest request)
                                                 throws java.lang.Exception

Get Conversation

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getConversation

public MessagingGetConversationResponse getConversation(MessagingGetConversationRequest request,
                                                        java.util.Optional<Options> options)
                                                 throws java.lang.Exception

Get Conversation

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

downloadMessagingAttachment

public MessagingDownloadMessagingAttachmentRequestBuilder downloadMessagingAttachment()

Download Attachment

Returns:

The call builder

downloadMessagingAttachment

public MessagingDownloadMessagingAttachmentResponse downloadMessagingAttachment(MessagingDownloadMessagingAttachmentRequest request)
                                                                         throws java.lang.Exception

Download Attachment

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

downloadMessagingAttachment

public MessagingDownloadMessagingAttachmentResponse downloadMessagingAttachment(MessagingDownloadMessagingAttachmentRequest request,
                                                                                java.util.Optional<Options> options)
                                                                         throws java.lang.Exception

Download Attachment

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listAttachments

public MessagingListAttachmentsRequestBuilder listAttachments()

List Attachments

Returns:

The call builder

listAttachments

public MessagingListAttachmentsResponse listAttachments(MessagingListAttachmentsRequest request)
                                                 throws java.lang.Exception

List Attachments

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listAttachments

public MessagingListAttachmentsResponse listAttachments(MessagingListAttachmentsRequest request,
                                                        java.util.Optional<Options> options)
                                                 throws java.lang.Exception

List Attachments

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getAttachment

public MessagingGetAttachmentRequestBuilder getAttachment()

Get Attachment

Returns:

The call builder

getAttachment

public MessagingGetAttachmentResponse getAttachment(MessagingGetAttachmentRequest request)
                                             throws java.lang.Exception

Get Attachment

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getAttachment

public MessagingGetAttachmentResponse getAttachment(MessagingGetAttachmentRequest request,
                                                    java.util.Optional<Options> options)
                                             throws java.lang.Exception

Get Attachment

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listUsers

public MessagingListUsersRequestBuilder listUsers()

List Users

Returns:

The call builder

listUsers

public MessagingListUsersResponse listUsers(MessagingListUsersRequest request)
                                     throws java.lang.Exception

List Users

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listUsers

public MessagingListUsersResponse listUsers(MessagingListUsersRequest request,
                                            java.util.Optional<Options> options)
                                     throws java.lang.Exception

List Users

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getUser

public MessagingGetUserRequestBuilder getUser()

Get User

Returns:

The call builder

getUser

public MessagingGetUserResponse getUser(MessagingGetUserRequest request)
                                 throws java.lang.Exception

Get User

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getUser

public MessagingGetUserResponse getUser(MessagingGetUserRequest request,
                                        java.util.Optional<Options> options)
                                 throws java.lang.Exception

Get User

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listConversationMessages

public MessagingListConversationMessagesRequestBuilder listConversationMessages()

List Conversation Messages

Returns:

The call builder

listConversationMessages

public MessagingListConversationMessagesResponse listConversationMessages(MessagingListConversationMessagesRequest request)
                                                                   throws java.lang.Exception

List Conversation Messages

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listConversationMessages

public MessagingListConversationMessagesResponse listConversationMessages(MessagingListConversationMessagesRequest request,
                                                                          java.util.Optional<Options> options)
                                                                   throws java.lang.Exception

List Conversation Messages

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getMessage

public MessagingGetMessageRequestBuilder getMessage()

Get Message

Returns:

The call builder

getMessage

public MessagingGetMessageResponse getMessage(MessagingGetMessageRequest request)
                                       throws java.lang.Exception

Get Message

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getMessage

public MessagingGetMessageResponse getMessage(MessagingGetMessageRequest request,
                                              java.util.Optional<Options> options)
                                       throws java.lang.Exception

Get Message

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

sendMessage

public MessagingSendMessageRequestBuilder sendMessage()

Send Message

Returns:

The call builder

sendMessage

public MessagingSendMessageResponse sendMessage(java.lang.String xAccountId,
                                                MessagingMessageSendRequestDto messagingMessageSendRequestDto)
                                         throws java.lang.Exception

Send Message

Parameters:

xAccountId - The account identifier

messagingMessageSendRequestDto -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

sendMessage

public MessagingSendMessageResponse sendMessage(java.lang.String xAccountId,
                                                MessagingMessageSendRequestDto messagingMessageSendRequestDto,
                                                java.util.Optional<Options> options)
                                         throws java.lang.Exception

Send Message

Parameters:

xAccountId - The account identifier

messagingMessageSendRequestDto -

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails