Package com.zendesk.sunshine_conversations_client.api

Class MessagesApi

  • public class MessagesApi
extends java.lang.Object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object deleteAllMessages​(java.lang.String appId, java.lang.String conversationId)
      Delete All Messages Delete all messages of a particular conversation.
      java.lang.Object deleteAllMessages​(java.lang.String bearerToken, java.lang.String appId, java.lang.String conversationId)
      Delete All Messages Delete all messages of a particular conversation.
      java.lang.Object deleteMessage​(java.lang.String appId, java.lang.String conversationId, java.lang.String messageId)
      Delete Message Delete a single message of a particular conversation.
      java.lang.Object deleteMessage​(java.lang.String bearerToken, java.lang.String appId, java.lang.String conversationId, java.lang.String messageId)
      Delete Message Delete a single message of a particular conversation.
      ApiClient getApiClient()  
      MessageListResponse listMessages​(java.lang.String appId, java.lang.String conversationId, Page page)
      List Messages List all messages for a particular conversation.
      MessageListResponse listMessages​(java.lang.String bearerToken, java.lang.String appId, java.lang.String conversationId, Page page)
      List Messages List all messages for a particular conversation.
      MessagePostResponse postMessage​(MessagePost messagePost, java.lang.String appId, java.lang.String conversationId)
      Post Message Send a message in a particular conversation.
      MessagePostResponse postMessage​(java.lang.String bearerToken, MessagePost messagePost, java.lang.String appId, java.lang.String conversationId)
      Post Message Send a message in a particular conversation.
      void setApiClient​(ApiClient apiClient)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • MessagesApi

        public MessagesApi()

      • MessagesApi

        public MessagesApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • deleteAllMessages

        public java.lang.Object deleteAllMessages​(java.lang.String appId,
                                          java.lang.String conversationId)
                                   throws ApiException
        Delete All Messages Delete all messages of a particular conversation.
        Parameters:
        appId - Identifies the app. (required)
        conversationId - Identifies the conversation. (required)
        Returns:
        a Object
        Throws:
        ApiException - if fails to make API call

      • deleteMessage

        public java.lang.Object deleteMessage​(java.lang.String appId,
                                      java.lang.String conversationId,
                                      java.lang.String messageId)
                               throws ApiException
        Delete Message Delete a single message of a particular conversation.
        Parameters:
        appId - Identifies the app. (required)
        conversationId - Identifies the conversation. (required)
        messageId - The id of the message. (required)
        Returns:
        a Object
        Throws:
        ApiException - if fails to make API call

      • listMessages

        public MessageListResponse listMessages​(java.lang.String appId,
                                        java.lang.String conversationId,
                                        Page page)
                                 throws ApiException
        List Messages List all messages for a particular conversation. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits), in the _backwards_ direction, with the most recent (i.e. last) page of messages being returned by default. The `hasMore` flag indicates whether more messages exist in the direction you are currently paginating through. To page backwards in the history, use the `beforeCursor` or follow the `prev` link. The page size limit is fixed at 100 messages per page. ```shell /v2/apps/:appId/conversations/:conversationId/messages?page[before]=5f32b88acf6bf25073b2be56 ```
        Parameters:
        appId - Identifies the app. (required)
        conversationId - Identifies the conversation. (required)
        page - Contains parameters for applying cursor pagination. (optional)
        Returns:
        a MessageListResponse
        Throws:
        ApiException - if fails to make API call

      • postMessage

        public MessagePostResponse postMessage​(MessagePost messagePost,
                                       java.lang.String appId,
                                       java.lang.String conversationId)
                                throws ApiException
        Post Message Send a message in a particular conversation.
        Parameters:
        messagePost - (required)
        appId - Identifies the app. (required)
        conversationId - Identifies the conversation. (required)
        Returns:
        a MessagePostResponse
        Throws:
        ApiException - if fails to make API call

      • deleteAllMessages

        public java.lang.Object deleteAllMessages​(java.lang.String bearerToken,
                                          java.lang.String appId,
                                          java.lang.String conversationId)
                                   throws ApiException
        Delete All Messages Delete all messages of a particular conversation.
        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

      • deleteMessage

        public java.lang.Object deleteMessage​(java.lang.String bearerToken,
                                      java.lang.String appId,
                                      java.lang.String conversationId,
                                      java.lang.String messageId)
                               throws ApiException
        Delete Message Delete a single message of a particular conversation.
        Parameters:
        bearerToken - a token to be used for this request (required)
        appId - Identifies the app. (required)
        conversationId - Identifies the conversation. (required)
        messageId - The id of the message. (required)
        Returns:
        a Object
        Throws:
        ApiException - if fails to make API call

      • listMessages

        public MessageListResponse listMessages​(java.lang.String bearerToken,
                                        java.lang.String appId,
                                        java.lang.String conversationId,
                                        Page page)
                                 throws ApiException
        List Messages List all messages for a particular conversation. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits), in the _backwards_ direction, with the most recent (i.e. last) page of messages being returned by default. The `hasMore` flag indicates whether more messages exist in the direction you are currently paginating through. To page backwards in the history, use the `beforeCursor` or follow the `prev` link. The page size limit is fixed at 100 messages per page. ```shell /v2/apps/:appId/conversations/:conversationId/messages?page[before]=5f32b88acf6bf25073b2be56 ```
        Parameters:
        bearerToken - a token to be used for this request (required)
        appId - Identifies the app. (required)
        conversationId - Identifies the conversation. (required)
        page - Contains parameters for applying cursor pagination. (optional)
        Returns:
        a MessageListResponse
        Throws:
        ApiException - if fails to make API call

      • postMessage

        public MessagePostResponse postMessage​(java.lang.String bearerToken,
                                       MessagePost messagePost,
                                       java.lang.String appId,
                                       java.lang.String conversationId)
                                throws ApiException
        Post Message Send a message in a particular conversation.
        Parameters:
        bearerToken - a token to be used for this request (required)
        messagePost - (required)
        appId - Identifies the app. (required)
        conversationId - Identifies the conversation. (required)
        Returns:
        a MessagePostResponse
        Throws:
        ApiException - if fails to make API call