Package com.zendesk.sunshine_conversations_client.api

Class ConversationsApi

java.lang.Object

com.zendesk.sunshine_conversations_client.api.ConversationsApi

public class ConversationsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
ConversationsApi()
ConversationsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ConversationResponse	createConversation(ConversationCreateBody conversationCreateBody, java.lang.String appId)	Create Conversation Create a conversation for the specified user(s).
ConversationResponse	createConversation(java.lang.String bearerToken, ConversationCreateBody conversationCreateBody, java.lang.String appId)	Create Conversation Create a conversation for the specified user(s).
java.lang.Object	deleteConversation(java.lang.String appId, java.lang.String conversationId)	Delete Conversation Delete an entire conversation record, along with its messages and attachments.
java.lang.Object	deleteConversation(java.lang.String bearerToken, java.lang.String appId, java.lang.String conversationId)	Delete Conversation Delete an entire conversation record, along with its messages and attachments.
ApiClient	getApiClient()
ConversationResponse	getConversation(java.lang.String appId, java.lang.String conversationId)	Get Conversation Fetches an individual conversation.
ConversationResponse	getConversation(java.lang.String bearerToken, java.lang.String appId, java.lang.String conversationId)	Get Conversation Fetches an individual conversation.
ConversationListResponse	listConversations(java.lang.String appId, ConversationListFilter filter, Page page)	List Conversations Lists all conversations that a user is part of.
ConversationListResponse	listConversations(java.lang.String bearerToken, java.lang.String appId, ConversationListFilter filter, Page page)	List Conversations Lists all conversations that a user is part of.
void	setApiClient(ApiClient apiClient)
ConversationResponse	updateConversation(ConversationUpdateBody conversationUpdateBody, java.lang.String appId, java.lang.String conversationId)	Update Conversation Updates a conversation record.
ConversationResponse	updateConversation(java.lang.String bearerToken, ConversationUpdateBody conversationUpdateBody, java.lang.String appId, java.lang.String conversationId)	Update Conversation Updates a conversation record.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConversationsApi

public ConversationsApi()

ConversationsApi

public ConversationsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createConversation

public ConversationResponse createConversation(ConversationCreateBody conversationCreateBody,
                                               java.lang.String appId)
                                        throws ApiException

Create Conversation Create a conversation for the specified user(s).

Parameters:

conversationCreateBody - (required)

appId - Identifies the app. (required)

Returns:

a ConversationResponse

Throws:

ApiException - if fails to make API call

deleteConversation

public java.lang.Object deleteConversation(java.lang.String appId,
                                           java.lang.String conversationId)
                                    throws ApiException

Delete Conversation Delete an entire conversation record, along with its messages and attachments. Note that the default conversation cannot be deleted, but the messages contained [can be](#deleteAllMessages).

Parameters:

appId - Identifies the app. (required)

conversationId - Identifies the conversation. (required)

Returns:

a Object

Throws:

ApiException - if fails to make API call

getConversation

public ConversationResponse getConversation(java.lang.String appId,
                                            java.lang.String conversationId)
                                     throws ApiException

Get Conversation Fetches an individual conversation.

Parameters:

appId - Identifies the app. (required)

conversationId - Identifies the conversation. (required)

Returns:

a ConversationResponse

Throws:

ApiException - if fails to make API call

listConversations

public ConversationListResponse listConversations(java.lang.String appId,
                                                  ConversationListFilter filter,
                                                  Page page)
                                           throws ApiException

List Conversations Lists all conversations that a user is part of. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits). ```shell /v2/apps/:appId/conversations?filter[userId]=42589ad070d43be9b00ff7e5 ```

Parameters:

appId - Identifies the app. (required)

filter - Contains parameters for filtering the results. (required)

page - Contains parameters for applying cursor pagination. (optional)

Returns:

a ConversationListResponse

Throws:

ApiException - if fails to make API call

updateConversation

public ConversationResponse updateConversation(ConversationUpdateBody conversationUpdateBody,
                                               java.lang.String appId,
                                               java.lang.String conversationId)
                                        throws ApiException

Update Conversation Updates a conversation record.

Parameters:

conversationUpdateBody - (required)

appId - Identifies the app. (required)

conversationId - Identifies the conversation. (required)

Returns:

a ConversationResponse

Throws:

ApiException - if fails to make API call

createConversation

public ConversationResponse createConversation(java.lang.String bearerToken,
                                               ConversationCreateBody conversationCreateBody,
                                               java.lang.String appId)
                                        throws ApiException

Create Conversation Create a conversation for the specified user(s).

Parameters:

bearerToken - a token to be used for this request (required)

conversationCreateBody - (required)

appId - Identifies the app. (required)

Returns:

a ConversationResponse

Throws:

ApiException - if fails to make API call

deleteConversation

public java.lang.Object deleteConversation(java.lang.String bearerToken,
                                           java.lang.String appId,
                                           java.lang.String conversationId)
                                    throws ApiException

Delete Conversation Delete an entire conversation record, along with its messages and attachments. Note that the default conversation cannot be deleted, but the messages contained [can be](#deleteAllMessages).

Parameters:

bearerToken - a token to be used for this request (required)

appId - Identifies the app. (required)

conversationId - Identifies the conversation. (required)

Returns:

a Object

Throws:

ApiException - if fails to make API call

getConversation

public ConversationResponse getConversation(java.lang.String bearerToken,
                                            java.lang.String appId,
                                            java.lang.String conversationId)
                                     throws ApiException

Get Conversation Fetches an individual conversation.

Parameters:

bearerToken - a token to be used for this request (required)

appId - Identifies the app. (required)

conversationId - Identifies the conversation. (required)

Returns:

a ConversationResponse

Throws:

ApiException - if fails to make API call

listConversations

public ConversationListResponse listConversations(java.lang.String bearerToken,
                                                  java.lang.String appId,
                                                  ConversationListFilter filter,
                                                  Page page)
                                           throws ApiException

List Conversations Lists all conversations that a user is part of. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits). ```shell /v2/apps/:appId/conversations?filter[userId]=42589ad070d43be9b00ff7e5 ```

Parameters:

bearerToken - a token to be used for this request (required)

appId - Identifies the app. (required)

filter - Contains parameters for filtering the results. (required)

page - Contains parameters for applying cursor pagination. (optional)

Returns:

a ConversationListResponse

Throws:

ApiException - if fails to make API call

updateConversation

public ConversationResponse updateConversation(java.lang.String bearerToken,
                                               ConversationUpdateBody conversationUpdateBody,
                                               java.lang.String appId,
                                               java.lang.String conversationId)
                                        throws ApiException

Update Conversation Updates a conversation record.

Parameters:

bearerToken - a token to be used for this request (required)

conversationUpdateBody - (required)

appId - Identifies the app. (required)

conversationId - Identifies the conversation. (required)

Returns:

a ConversationResponse

Throws:

ApiException - if fails to make API call