Class StatsAApi

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

  • Constructor Details

    • StatsAApi

      public StatsAApi()

    • StatsAApi

      public StatsAApi(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)

    • getAccountAggregateStatsCall

      public okhttp3.Call getAccountAggregateStatsCall(@Nonnull LocalDate from, @Nonnull LocalDate to, ApiCallback _callback) throws ApiException
      Build call for getAccountAggregateStats
      Parameters:
      from - The start date for retrieving aggregated stats (inclusive) (required)
      to - The end date for retrieving aggregated stats (inclusive). The difference between `from` and `to` should not exceed 366 days. (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 Aggregated statistics for the specified date range. -
      400 Bad request, invalid date range -
      401 Unauthorized, invalid API key -
      404 Data not found for the given date range -

    • getAccountAggregateStats

      public AggregateStats getAccountAggregateStats(@Nonnull LocalDate from, @Nonnull LocalDate to) throws ApiException
      Get Account Aggregate Stats Retrieve aggregated email statistics for all sub-accounts of a specific account for a given date range.
      Parameters:
      from - The start date for retrieving aggregated stats (inclusive) (required)
      to - The end date for retrieving aggregated stats (inclusive). The difference between `from` and `to` should not exceed 366 days. (required)
      Returns:
      AggregateStats
      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 Aggregated statistics for the specified date range. -
      400 Bad request, invalid date range -
      401 Unauthorized, invalid API key -
      404 Data not found for the given date range -

    • getAccountAggregateStatsWithHttpInfo

      public ApiResponse<AggregateStats> getAccountAggregateStatsWithHttpInfo(@Nonnull LocalDate from, @Nonnull LocalDate to) throws ApiException
      Get Account Aggregate Stats Retrieve aggregated email statistics for all sub-accounts of a specific account for a given date range.
      Parameters:
      from - The start date for retrieving aggregated stats (inclusive) (required)
      to - The end date for retrieving aggregated stats (inclusive). The difference between `from` and `to` should not exceed 366 days. (required)
      Returns:
      ApiResponse<AggregateStats>
      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 Aggregated statistics for the specified date range. -
      400 Bad request, invalid date range -
      401 Unauthorized, invalid API key -
      404 Data not found for the given date range -

    • getAccountAggregateStatsAsync

      public okhttp3.Call getAccountAggregateStatsAsync(@Nonnull LocalDate from, @Nonnull LocalDate to, ApiCallback<AggregateStats> _callback) throws ApiException
      Get Account Aggregate Stats (asynchronously) Retrieve aggregated email statistics for all sub-accounts of a specific account for a given date range.
      Parameters:
      from - The start date for retrieving aggregated stats (inclusive) (required)
      to - The end date for retrieving aggregated stats (inclusive). The difference between `from` and `to` should not exceed 366 days. (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 Aggregated statistics for the specified date range. -
      400 Bad request, invalid date range -
      401 Unauthorized, invalid API key -
      404 Data not found for the given date range -

    • getAccountAggregateStatsByGroupCall

      public okhttp3.Call getAccountAggregateStatsByGroupCall(@Nonnull String group, @Nonnull LocalDate from, @Nonnull LocalDate to, ApiCallback _callback) throws ApiException
      Build call for getAccountAggregateStatsByGroup
      Parameters:
      group - Group whose aggregate stats need to be retrieved. (required)
      from - Date from which stats should be retrieved (should be in the format `YYYY-MM-DD`). (required)
      to - Date to which stats should be retrieved (should be in the format `YYYY-MM-DD`). Note that the difference between `from` and `to` should not be more than 366 days. (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 Successfully retrieved aggregate stats by group. -
      400 Bad Request, invalid query parameters. -
      401 Unauthorized, invalid API key. -

    • getAccountAggregateStatsByGroup

      public AggregateStat getAccountAggregateStatsByGroup(@Nonnull String group, @Nonnull LocalDate from, @Nonnull LocalDate to) throws ApiException
      Get Account Aggregate Stats by Group Gets aggregated email stats for a specific group in all sub-accounts of a specific account for the given daterange. The maximum daterange for which these stats can be retrieved is 366 days.
      Parameters:
      group - Group whose aggregate stats need to be retrieved. (required)
      from - Date from which stats should be retrieved (should be in the format `YYYY-MM-DD`). (required)
      to - Date to which stats should be retrieved (should be in the format `YYYY-MM-DD`). Note that the difference between `from` and `to` should not be more than 366 days. (required)
      Returns:
      AggregateStat
      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 Successfully retrieved aggregate stats by group. -
      400 Bad Request, invalid query parameters. -
      401 Unauthorized, invalid API key. -

    • getAccountAggregateStatsByGroupWithHttpInfo

      public ApiResponse<AggregateStat> getAccountAggregateStatsByGroupWithHttpInfo(@Nonnull String group, @Nonnull LocalDate from, @Nonnull LocalDate to) throws ApiException
      Get Account Aggregate Stats by Group Gets aggregated email stats for a specific group in all sub-accounts of a specific account for the given daterange. The maximum daterange for which these stats can be retrieved is 366 days.
      Parameters:
      group - Group whose aggregate stats need to be retrieved. (required)
      from - Date from which stats should be retrieved (should be in the format `YYYY-MM-DD`). (required)
      to - Date to which stats should be retrieved (should be in the format `YYYY-MM-DD`). Note that the difference between `from` and `to` should not be more than 366 days. (required)
      Returns:
      ApiResponse<AggregateStat>
      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 Successfully retrieved aggregate stats by group. -
      400 Bad Request, invalid query parameters. -
      401 Unauthorized, invalid API key. -

    • getAccountAggregateStatsByGroupAsync

      public okhttp3.Call getAccountAggregateStatsByGroupAsync(@Nonnull String group, @Nonnull LocalDate from, @Nonnull LocalDate to, ApiCallback<AggregateStat> _callback) throws ApiException
      Get Account Aggregate Stats by Group (asynchronously) Gets aggregated email stats for a specific group in all sub-accounts of a specific account for the given daterange. The maximum daterange for which these stats can be retrieved is 366 days.
      Parameters:
      group - Group whose aggregate stats need to be retrieved. (required)
      from - Date from which stats should be retrieved (should be in the format `YYYY-MM-DD`). (required)
      to - Date to which stats should be retrieved (should be in the format `YYYY-MM-DD`). Note that the difference between `from` and `to` should not be more than 366 days. (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 Successfully retrieved aggregate stats by group. -
      400 Bad Request, invalid query parameters. -
      401 Unauthorized, invalid API key. -

    • getAccountStatsByGroupCall

      public okhttp3.Call getAccountStatsByGroupCall(@Nonnull String group, @Nonnull LocalDate from, @Nonnull LocalDate to, ApiCallback _callback) throws ApiException
      Build call for getAccountStatsByGroup
      Parameters:
      group - Group whose stats need to be retrieved (required)
      from - Date from which stats should be retrieved (should be in the format `YYYY-MM-DD`) (required)
      to - Date to which stats should be retrieved (should be in the format `YYYY-MM-DD`). Note that the difference between `from` and `to` should not be more than 31 days. (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 Successfully retrieved stats by group. -
      400 Bad Request, invalid query parameters. -
      401 Unauthorized, invalid API key. -

    • getAccountStatsByGroup

      public List<Stat> getAccountStatsByGroup(@Nonnull String group, @Nonnull LocalDate from, @Nonnull LocalDate to) throws ApiException
      Get All Account Stats By Group Gets a list of all email stats for all sub-accounts of a specific account by group for a given daterange. The maximum daterange for which these stats can be retrieved is 31 days.
      Parameters:
      group - Group whose stats need to be retrieved (required)
      from - Date from which stats should be retrieved (should be in the format `YYYY-MM-DD`) (required)
      to - Date to which stats should be retrieved (should be in the format `YYYY-MM-DD`). Note that the difference between `from` and `to` should not be more than 31 days. (required)
      Returns:
      List<Stat>
      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 Successfully retrieved stats by group. -
      400 Bad Request, invalid query parameters. -
      401 Unauthorized, invalid API key. -

    • getAccountStatsByGroupWithHttpInfo

      public ApiResponse<List<Stat>> getAccountStatsByGroupWithHttpInfo(@Nonnull String group, @Nonnull LocalDate from, @Nonnull LocalDate to) throws ApiException
      Get All Account Stats By Group Gets a list of all email stats for all sub-accounts of a specific account by group for a given daterange. The maximum daterange for which these stats can be retrieved is 31 days.
      Parameters:
      group - Group whose stats need to be retrieved (required)
      from - Date from which stats should be retrieved (should be in the format `YYYY-MM-DD`) (required)
      to - Date to which stats should be retrieved (should be in the format `YYYY-MM-DD`). Note that the difference between `from` and `to` should not be more than 31 days. (required)
      Returns:
      ApiResponse<List<Stat>>
      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 Successfully retrieved stats by group. -
      400 Bad Request, invalid query parameters. -
      401 Unauthorized, invalid API key. -

    • getAccountStatsByGroupAsync

      public okhttp3.Call getAccountStatsByGroupAsync(@Nonnull String group, @Nonnull LocalDate from, @Nonnull LocalDate to, ApiCallback<List<Stat>> _callback) throws ApiException
      Get All Account Stats By Group (asynchronously) Gets a list of all email stats for all sub-accounts of a specific account by group for a given daterange. The maximum daterange for which these stats can be retrieved is 31 days.
      Parameters:
      group - Group whose stats need to be retrieved (required)
      from - Date from which stats should be retrieved (should be in the format `YYYY-MM-DD`) (required)
      to - Date to which stats should be retrieved (should be in the format `YYYY-MM-DD`). Note that the difference between `from` and `to` should not be more than 31 days. (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 Successfully retrieved stats by group. -
      400 Bad Request, invalid query parameters. -
      401 Unauthorized, invalid API key. -

    • getAllAccountStatsCall

      public okhttp3.Call getAllAccountStatsCall(@Nonnull LocalDate from, @Nonnull LocalDate to, ApiCallback _callback) throws ApiException
      Build call for getAllAccountStats
      Parameters:
      from - The start date for retrieving stats (inclusive) (required)
      to - The end date for retrieving stats (inclusive). The difference between `from` and `to` should not exceed 31 days. (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 A list of statistics for the specified date range. -
      400 Bad request, invalid date range -
      401 Unauthorized, invalid API key -
      404 Data not found for the given date range -

    • getAllAccountStats

      public List<AccountStats> getAllAccountStats(@Nonnull LocalDate from, @Nonnull LocalDate to) throws ApiException
      Get All Account Stats Retrieve email statistics for all sub-accounts of a specific account for a given date range.
      Parameters:
      from - The start date for retrieving stats (inclusive) (required)
      to - The end date for retrieving stats (inclusive). The difference between `from` and `to` should not exceed 31 days. (required)
      Returns:
      List<AccountStats>
      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 A list of statistics for the specified date range. -
      400 Bad request, invalid date range -
      401 Unauthorized, invalid API key -
      404 Data not found for the given date range -

    • getAllAccountStatsWithHttpInfo

      public ApiResponse<List<AccountStats>> getAllAccountStatsWithHttpInfo(@Nonnull LocalDate from, @Nonnull LocalDate to) throws ApiException
      Get All Account Stats Retrieve email statistics for all sub-accounts of a specific account for a given date range.
      Parameters:
      from - The start date for retrieving stats (inclusive) (required)
      to - The end date for retrieving stats (inclusive). The difference between `from` and `to` should not exceed 31 days. (required)
      Returns:
      ApiResponse<List<AccountStats>>
      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 A list of statistics for the specified date range. -
      400 Bad request, invalid date range -
      401 Unauthorized, invalid API key -
      404 Data not found for the given date range -

    • getAllAccountStatsAsync

      public okhttp3.Call getAllAccountStatsAsync(@Nonnull LocalDate from, @Nonnull LocalDate to, ApiCallback<List<AccountStats>> _callback) throws ApiException
      Get All Account Stats (asynchronously) Retrieve email statistics for all sub-accounts of a specific account for a given date range.
      Parameters:
      from - The start date for retrieving stats (inclusive) (required)
      to - The end date for retrieving stats (inclusive). The difference between `from` and `to` should not exceed 31 days. (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 A list of statistics for the specified date range. -
      400 Bad request, invalid date range -
      401 Unauthorized, invalid API key -
      404 Data not found for the given date range -