Package build.cursed.genapi.forgejo.api

Class NotificationApi

java.lang.Object
build.cursed.genapi.forgejo.api.NotificationApi
public class NotificationApi extends Object

  • Constructor Details

    • NotificationApi

      public NotificationApi()

    • NotificationApi

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

    • notifyGetListCall

      public okhttp3.Call notifyGetListCall(@Nullable Boolean all, @Nullable List<String> statusTypes, @Nullable List<String> subjectType, @Nullable OffsetDateTime since, @Nullable OffsetDateTime before, @Nullable Integer page, @Nullable Integer limit, ApiCallback _callback) throws ApiException
      Build call for notifyGetList
      Parameters:
      all - If true, show notifications marked as read. Default value is false (optional)
      statusTypes - Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned. (optional)
      subjectType - filter notifications by subject type (optional)
      since - Only show notifications updated after the given time. This is a timestamp in RFC 3339 format (optional)
      before - Only show notifications updated before the given time. This is a timestamp in RFC 3339 format (optional)
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      _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 NotificationThreadList * X-Total-Count - The total number of access tokens

    • notifyGetList

      public List<NotificationThread> notifyGetList(@Nullable Boolean all, @Nullable List<String> statusTypes, @Nullable List<String> subjectType, @Nullable OffsetDateTime since, @Nullable OffsetDateTime before, @Nullable Integer page, @Nullable Integer limit) throws ApiException
      List users's notification threads
      Parameters:
      all - If true, show notifications marked as read. Default value is false (optional)
      statusTypes - Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned. (optional)
      subjectType - filter notifications by subject type (optional)
      since - Only show notifications updated after the given time. This is a timestamp in RFC 3339 format (optional)
      before - Only show notifications updated before the given time. This is a timestamp in RFC 3339 format (optional)
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      Returns:
      List<NotificationThread>
      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 NotificationThreadList * X-Total-Count - The total number of access tokens

    • notifyGetListWithHttpInfo

      public ApiResponse<List<NotificationThread>> notifyGetListWithHttpInfo(@Nullable Boolean all, @Nullable List<String> statusTypes, @Nullable List<String> subjectType, @Nullable OffsetDateTime since, @Nullable OffsetDateTime before, @Nullable Integer page, @Nullable Integer limit) throws ApiException
      List users's notification threads
      Parameters:
      all - If true, show notifications marked as read. Default value is false (optional)
      statusTypes - Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned. (optional)
      subjectType - filter notifications by subject type (optional)
      since - Only show notifications updated after the given time. This is a timestamp in RFC 3339 format (optional)
      before - Only show notifications updated before the given time. This is a timestamp in RFC 3339 format (optional)
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      Returns:
      ApiResponse<List<NotificationThread>>
      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 NotificationThreadList * X-Total-Count - The total number of access tokens

    • notifyGetListAsync

      public okhttp3.Call notifyGetListAsync(@Nullable Boolean all, @Nullable List<String> statusTypes, @Nullable List<String> subjectType, @Nullable OffsetDateTime since, @Nullable OffsetDateTime before, @Nullable Integer page, @Nullable Integer limit, ApiCallback<List<NotificationThread>> _callback) throws ApiException
      List users's notification threads (asynchronously)
      Parameters:
      all - If true, show notifications marked as read. Default value is false (optional)
      statusTypes - Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned. (optional)
      subjectType - filter notifications by subject type (optional)
      since - Only show notifications updated after the given time. This is a timestamp in RFC 3339 format (optional)
      before - Only show notifications updated before the given time. This is a timestamp in RFC 3339 format (optional)
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      _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 NotificationThreadList * X-Total-Count - The total number of access tokens

    • notifyGetRepoListCall

      public okhttp3.Call notifyGetRepoListCall(@Nonnull String owner, @Nonnull String repo, @Nullable Boolean all, @Nullable List<String> statusTypes, @Nullable List<String> subjectType, @Nullable OffsetDateTime since, @Nullable OffsetDateTime before, @Nullable Integer page, @Nullable Integer limit, ApiCallback _callback) throws ApiException
      Build call for notifyGetRepoList
      Parameters:
      owner - owner of the repo (required)
      repo - name of the repo (required)
      all - If true, show notifications marked as read. Default value is false (optional)
      statusTypes - Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned (optional)
      subjectType - filter notifications by subject type (optional)
      since - Only show notifications updated after the given time. This is a timestamp in RFC 3339 format (optional)
      before - Only show notifications updated before the given time. This is a timestamp in RFC 3339 format (optional)
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      _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 NotificationThreadList * X-Total-Count - The total number of access tokens

    • notifyGetRepoList

      public List<NotificationThread> notifyGetRepoList(@Nonnull String owner, @Nonnull String repo, @Nullable Boolean all, @Nullable List<String> statusTypes, @Nullable List<String> subjectType, @Nullable OffsetDateTime since, @Nullable OffsetDateTime before, @Nullable Integer page, @Nullable Integer limit) throws ApiException
      List users's notification threads on a specific repo
      Parameters:
      owner - owner of the repo (required)
      repo - name of the repo (required)
      all - If true, show notifications marked as read. Default value is false (optional)
      statusTypes - Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned (optional)
      subjectType - filter notifications by subject type (optional)
      since - Only show notifications updated after the given time. This is a timestamp in RFC 3339 format (optional)
      before - Only show notifications updated before the given time. This is a timestamp in RFC 3339 format (optional)
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      Returns:
      List<NotificationThread>
      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 NotificationThreadList * X-Total-Count - The total number of access tokens

    • notifyGetRepoListWithHttpInfo

      public ApiResponse<List<NotificationThread>> notifyGetRepoListWithHttpInfo(@Nonnull String owner, @Nonnull String repo, @Nullable Boolean all, @Nullable List<String> statusTypes, @Nullable List<String> subjectType, @Nullable OffsetDateTime since, @Nullable OffsetDateTime before, @Nullable Integer page, @Nullable Integer limit) throws ApiException
      List users's notification threads on a specific repo
      Parameters:
      owner - owner of the repo (required)
      repo - name of the repo (required)
      all - If true, show notifications marked as read. Default value is false (optional)
      statusTypes - Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned (optional)
      subjectType - filter notifications by subject type (optional)
      since - Only show notifications updated after the given time. This is a timestamp in RFC 3339 format (optional)
      before - Only show notifications updated before the given time. This is a timestamp in RFC 3339 format (optional)
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      Returns:
      ApiResponse<List<NotificationThread>>
      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 NotificationThreadList * X-Total-Count - The total number of access tokens

    • notifyGetRepoListAsync

      public okhttp3.Call notifyGetRepoListAsync(@Nonnull String owner, @Nonnull String repo, @Nullable Boolean all, @Nullable List<String> statusTypes, @Nullable List<String> subjectType, @Nullable OffsetDateTime since, @Nullable OffsetDateTime before, @Nullable Integer page, @Nullable Integer limit, ApiCallback<List<NotificationThread>> _callback) throws ApiException
      List users's notification threads on a specific repo (asynchronously)
      Parameters:
      owner - owner of the repo (required)
      repo - name of the repo (required)
      all - If true, show notifications marked as read. Default value is false (optional)
      statusTypes - Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned (optional)
      subjectType - filter notifications by subject type (optional)
      since - Only show notifications updated after the given time. This is a timestamp in RFC 3339 format (optional)
      before - Only show notifications updated before the given time. This is a timestamp in RFC 3339 format (optional)
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      _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 NotificationThreadList * X-Total-Count - The total number of access tokens

    • notifyGetThreadCall

      public okhttp3.Call notifyGetThreadCall(@Nonnull Long id, ApiCallback _callback) throws ApiException
      Build call for notifyGetThread
      Parameters:
      id - id of notification thread (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 NotificationThread -
      403 APIForbiddenError is a forbidden error response -
      404 APINotFound is a not found error response -

    • notifyGetThread

      public NotificationThread notifyGetThread(@Nonnull Long id) throws ApiException
      Get notification thread by ID
      Parameters:
      id - id of notification thread (required)
      Returns:
      NotificationThread
      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 NotificationThread -
      403 APIForbiddenError is a forbidden error response -
      404 APINotFound is a not found error response -

    • notifyGetThreadWithHttpInfo

      public ApiResponse<NotificationThread> notifyGetThreadWithHttpInfo(@Nonnull Long id) throws ApiException
      Get notification thread by ID
      Parameters:
      id - id of notification thread (required)
      Returns:
      ApiResponse<NotificationThread>
      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 NotificationThread -
      403 APIForbiddenError is a forbidden error response -
      404 APINotFound is a not found error response -

    • notifyGetThreadAsync

      public okhttp3.Call notifyGetThreadAsync(@Nonnull Long id, ApiCallback<NotificationThread> _callback) throws ApiException
      Get notification thread by ID (asynchronously)
      Parameters:
      id - id of notification thread (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 NotificationThread -
      403 APIForbiddenError is a forbidden error response -
      404 APINotFound is a not found error response -

    • notifyNewAvailableCall

      public okhttp3.Call notifyNewAvailableCall(ApiCallback _callback) throws ApiException
      Build call for notifyNewAvailable
      Parameters:
      _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 Number of unread notifications -

    • notifyNewAvailable

      public NotificationCount notifyNewAvailable() throws ApiException
      Check if unread notifications exist
      Returns:
      NotificationCount
      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 Number of unread notifications -

    • notifyNewAvailableWithHttpInfo

      public ApiResponse<NotificationCount> notifyNewAvailableWithHttpInfo() throws ApiException
      Check if unread notifications exist
      Returns:
      ApiResponse<NotificationCount>
      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 Number of unread notifications -

    • notifyNewAvailableAsync

      public okhttp3.Call notifyNewAvailableAsync(ApiCallback<NotificationCount> _callback) throws ApiException
      Check if unread notifications exist (asynchronously)
      Parameters:
      _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 Number of unread notifications -

    • notifyReadListCall

      public okhttp3.Call notifyReadListCall(@Nullable OffsetDateTime lastReadAt, @Nullable Boolean all, @Nullable List<String> statusTypes, @Nullable String toStatus, ApiCallback _callback) throws ApiException
      Build call for notifyReadList
      Parameters:
      lastReadAt - Describes the last point that notifications were checked. Anything updated since this time will not be updated. (optional)
      all - If true, mark all notifications on this repo. Default value is false (optional)
      statusTypes - Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. (optional)
      toStatus - Status to mark notifications as, Defaults to read. (optional)
      _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
      205 NotificationThreadListWithoutPagination - Notification threads without pagination headers -

    • notifyReadList

      public List<NotificationThread> notifyReadList(@Nullable OffsetDateTime lastReadAt, @Nullable Boolean all, @Nullable List<String> statusTypes, @Nullable String toStatus) throws ApiException
      Mark notification threads as read, pinned or unread
      Parameters:
      lastReadAt - Describes the last point that notifications were checked. Anything updated since this time will not be updated. (optional)
      all - If true, mark all notifications on this repo. Default value is false (optional)
      statusTypes - Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. (optional)
      toStatus - Status to mark notifications as, Defaults to read. (optional)
      Returns:
      List<NotificationThread>
      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
      205 NotificationThreadListWithoutPagination - Notification threads without pagination headers -

    • notifyReadListWithHttpInfo

      public ApiResponse<List<NotificationThread>> notifyReadListWithHttpInfo(@Nullable OffsetDateTime lastReadAt, @Nullable Boolean all, @Nullable List<String> statusTypes, @Nullable String toStatus) throws ApiException
      Mark notification threads as read, pinned or unread
      Parameters:
      lastReadAt - Describes the last point that notifications were checked. Anything updated since this time will not be updated. (optional)
      all - If true, mark all notifications on this repo. Default value is false (optional)
      statusTypes - Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. (optional)
      toStatus - Status to mark notifications as, Defaults to read. (optional)
      Returns:
      ApiResponse<List<NotificationThread>>
      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
      205 NotificationThreadListWithoutPagination - Notification threads without pagination headers -

    • notifyReadListAsync

      public okhttp3.Call notifyReadListAsync(@Nullable OffsetDateTime lastReadAt, @Nullable Boolean all, @Nullable List<String> statusTypes, @Nullable String toStatus, ApiCallback<List<NotificationThread>> _callback) throws ApiException
      Mark notification threads as read, pinned or unread (asynchronously)
      Parameters:
      lastReadAt - Describes the last point that notifications were checked. Anything updated since this time will not be updated. (optional)
      all - If true, mark all notifications on this repo. Default value is false (optional)
      statusTypes - Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. (optional)
      toStatus - Status to mark notifications as, Defaults to read. (optional)
      _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
      205 NotificationThreadListWithoutPagination - Notification threads without pagination headers -

    • notifyReadRepoListCall

      public okhttp3.Call notifyReadRepoListCall(@Nonnull String owner, @Nonnull String repo, @Nullable Boolean all, @Nullable List<String> statusTypes, @Nullable String toStatus, @Nullable OffsetDateTime lastReadAt, ApiCallback _callback) throws ApiException
      Build call for notifyReadRepoList
      Parameters:
      owner - owner of the repo (required)
      repo - name of the repo (required)
      all - If true, mark all notifications on this repo. Default value is false (optional)
      statusTypes - Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. (optional)
      toStatus - Status to mark notifications as. Defaults to read. (optional)
      lastReadAt - Describes the last point that notifications were checked. Anything updated since this time will not be updated. (optional)
      _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
      205 NotificationThreadListWithoutPagination - Notification threads without pagination headers -

    • notifyReadRepoList

      public List<NotificationThread> notifyReadRepoList(@Nonnull String owner, @Nonnull String repo, @Nullable Boolean all, @Nullable List<String> statusTypes, @Nullable String toStatus, @Nullable OffsetDateTime lastReadAt) throws ApiException
      Mark notification threads as read, pinned or unread on a specific repo
      Parameters:
      owner - owner of the repo (required)
      repo - name of the repo (required)
      all - If true, mark all notifications on this repo. Default value is false (optional)
      statusTypes - Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. (optional)
      toStatus - Status to mark notifications as. Defaults to read. (optional)
      lastReadAt - Describes the last point that notifications were checked. Anything updated since this time will not be updated. (optional)
      Returns:
      List<NotificationThread>
      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
      205 NotificationThreadListWithoutPagination - Notification threads without pagination headers -

    • notifyReadRepoListWithHttpInfo

      public ApiResponse<List<NotificationThread>> notifyReadRepoListWithHttpInfo(@Nonnull String owner, @Nonnull String repo, @Nullable Boolean all, @Nullable List<String> statusTypes, @Nullable String toStatus, @Nullable OffsetDateTime lastReadAt) throws ApiException
      Mark notification threads as read, pinned or unread on a specific repo
      Parameters:
      owner - owner of the repo (required)
      repo - name of the repo (required)
      all - If true, mark all notifications on this repo. Default value is false (optional)
      statusTypes - Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. (optional)
      toStatus - Status to mark notifications as. Defaults to read. (optional)
      lastReadAt - Describes the last point that notifications were checked. Anything updated since this time will not be updated. (optional)
      Returns:
      ApiResponse<List<NotificationThread>>
      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
      205 NotificationThreadListWithoutPagination - Notification threads without pagination headers -

    • notifyReadRepoListAsync

      public okhttp3.Call notifyReadRepoListAsync(@Nonnull String owner, @Nonnull String repo, @Nullable Boolean all, @Nullable List<String> statusTypes, @Nullable String toStatus, @Nullable OffsetDateTime lastReadAt, ApiCallback<List<NotificationThread>> _callback) throws ApiException
      Mark notification threads as read, pinned or unread on a specific repo (asynchronously)
      Parameters:
      owner - owner of the repo (required)
      repo - name of the repo (required)
      all - If true, mark all notifications on this repo. Default value is false (optional)
      statusTypes - Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. (optional)
      toStatus - Status to mark notifications as. Defaults to read. (optional)
      lastReadAt - Describes the last point that notifications were checked. Anything updated since this time will not be updated. (optional)
      _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
      205 NotificationThreadListWithoutPagination - Notification threads without pagination headers -

    • notifyReadThreadCall

      public okhttp3.Call notifyReadThreadCall(@Nonnull Long id, @Nullable String toStatus, ApiCallback _callback) throws ApiException
      Build call for notifyReadThread
      Parameters:
      id - id of notification thread (required)
      toStatus - Status to mark notifications as (optional, default to read)
      _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
      205 NotificationThread -
      403 APIForbiddenError is a forbidden error response -
      404 APINotFound is a not found error response -

    • notifyReadThread

      public NotificationThread notifyReadThread(@Nonnull Long id, @Nullable String toStatus) throws ApiException
      Mark notification thread as read by ID
      Parameters:
      id - id of notification thread (required)
      toStatus - Status to mark notifications as (optional, default to read)
      Returns:
      NotificationThread
      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
      205 NotificationThread -
      403 APIForbiddenError is a forbidden error response -
      404 APINotFound is a not found error response -

    • notifyReadThreadWithHttpInfo

      public ApiResponse<NotificationThread> notifyReadThreadWithHttpInfo(@Nonnull Long id, @Nullable String toStatus) throws ApiException
      Mark notification thread as read by ID
      Parameters:
      id - id of notification thread (required)
      toStatus - Status to mark notifications as (optional, default to read)
      Returns:
      ApiResponse<NotificationThread>
      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
      205 NotificationThread -
      403 APIForbiddenError is a forbidden error response -
      404 APINotFound is a not found error response -

    • notifyReadThreadAsync

      public okhttp3.Call notifyReadThreadAsync(@Nonnull Long id, @Nullable String toStatus, ApiCallback<NotificationThread> _callback) throws ApiException
      Mark notification thread as read by ID (asynchronously)
      Parameters:
      id - id of notification thread (required)
      toStatus - Status to mark notifications as (optional, default to read)
      _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
      205 NotificationThread -
      403 APIForbiddenError is a forbidden error response -
      404 APINotFound is a not found error response -