Class MessageApi

java.lang.Object
sendpost_java_sdk.MessageApi
public class MessageApi extends Object

  • Constructor Details

    • MessageApi

      public MessageApi()

    • MessageApi

      public MessageApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getHostIndex

      public int getHostIndex()

    • setHostIndex

      public void setHostIndex(int hostIndex)

    • getCustomBaseUrl

      public String getCustomBaseUrl()

    • setCustomBaseUrl

      public void setCustomBaseUrl(String customBaseUrl)

    • getAllMessagesCall

      public okhttp3.Call getAllMessagesCall(@Nonnull OffsetDateTime from, @Nonnull OffsetDateTime to, @Nullable Integer limit, @Nullable Integer offset, ApiCallback _callback) throws ApiException
      Build call for getAllMessages
      Parameters:
      from - Date from which messages should be retrieved. (required)
      to - Date to which messages should be retrieved. (Should be later than `from` and no more than 60 days apart.) (required)
      limit - Number of records to return per request. (optional, default to 50)
      offset - Number of initial records to skip. (optional, default to 0)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successful retrieval of messages. -
      400 Invalid input parameters. -
      401 Unauthorized. Invalid API key. -

    • getAllMessages

      public List<Message> getAllMessages(@Nonnull OffsetDateTime from, @Nonnull OffsetDateTime to, @Nullable Integer limit, @Nullable Integer offset) throws ApiException
      Get all messages Retrieve messages sent via the SendPost platform within a specific date range.
      Parameters:
      from - Date from which messages should be retrieved. (required)
      to - Date to which messages should be retrieved. (Should be later than `from` and no more than 60 days apart.) (required)
      limit - Number of records to return per request. (optional, default to 50)
      offset - Number of initial records to skip. (optional, default to 0)
      Returns:
      List<Message>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successful retrieval of messages. -
      400 Invalid input parameters. -
      401 Unauthorized. Invalid API key. -

    • getAllMessagesWithHttpInfo

      public ApiResponse<List<Message>> getAllMessagesWithHttpInfo(@Nonnull OffsetDateTime from, @Nonnull OffsetDateTime to, @Nullable Integer limit, @Nullable Integer offset) throws ApiException
      Get all messages Retrieve messages sent via the SendPost platform within a specific date range.
      Parameters:
      from - Date from which messages should be retrieved. (required)
      to - Date to which messages should be retrieved. (Should be later than `from` and no more than 60 days apart.) (required)
      limit - Number of records to return per request. (optional, default to 50)
      offset - Number of initial records to skip. (optional, default to 0)
      Returns:
      ApiResponse<List<Message>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successful retrieval of messages. -
      400 Invalid input parameters. -
      401 Unauthorized. Invalid API key. -

    • getAllMessagesAsync

      public okhttp3.Call getAllMessagesAsync(@Nonnull OffsetDateTime from, @Nonnull OffsetDateTime to, @Nullable Integer limit, @Nullable Integer offset, ApiCallback<List<Message>> _callback) throws ApiException
      Get all messages (asynchronously) Retrieve messages sent via the SendPost platform within a specific date range.
      Parameters:
      from - Date from which messages should be retrieved. (required)
      to - Date to which messages should be retrieved. (Should be later than `from` and no more than 60 days apart.) (required)
      limit - Number of records to return per request. (optional, default to 50)
      offset - Number of initial records to skip. (optional, default to 0)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successful retrieval of messages. -
      400 Invalid input parameters. -
      401 Unauthorized. Invalid API key. -

    • getMessageByIdCall

      public okhttp3.Call getMessageByIdCall(@Nonnull String messageId, ApiCallback _callback) throws ApiException
      Build call for getMessageById
      Parameters:
      messageId - The ID of the message to retrieve. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successful retrieval of the message. -
      404 Message not found. -
      401 Unauthorized. Invalid API key. -

    • getMessageById

      public Message getMessageById(@Nonnull String messageId) throws ApiException
      Retrieve a specific message Retrieve detailed information about a specific message by its ID.
      Parameters:
      messageId - The ID of the message to retrieve. (required)
      Returns:
      Message
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successful retrieval of the message. -
      404 Message not found. -
      401 Unauthorized. Invalid API key. -

    • getMessageByIdWithHttpInfo

      public ApiResponse<Message> getMessageByIdWithHttpInfo(@Nonnull String messageId) throws ApiException
      Retrieve a specific message Retrieve detailed information about a specific message by its ID.
      Parameters:
      messageId - The ID of the message to retrieve. (required)
      Returns:
      ApiResponse<Message>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successful retrieval of the message. -
      404 Message not found. -
      401 Unauthorized. Invalid API key. -

    • getMessageByIdAsync

      public okhttp3.Call getMessageByIdAsync(@Nonnull String messageId, ApiCallback<Message> _callback) throws ApiException
      Retrieve a specific message (asynchronously) Retrieve detailed information about a specific message by its ID.
      Parameters:
      messageId - The ID of the message to retrieve. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successful retrieval of the message. -
      404 Message not found. -
      401 Unauthorized. Invalid API key. -