Package ai.shipeasy.admin.api

Class CommentsApi

java.lang.Object
ai.shipeasy.admin.api.CommentsApi
public class CommentsApi extends Object

  • Constructor Details

    • CommentsApi

      public CommentsApi()

    • CommentsApi

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

    • createOpsCommentCall

      public okhttp3.Call createOpsCommentCall(@Nonnull String handle, @Nonnull CreateOpsCommentRequest createOpsCommentRequest, @Nullable String xProjectId, ApiCallback _callback) throws ApiException
      Build call for createOpsComment
      Parameters:
      handle - Per-project item number (e.g. `7`) or the full ops item id. (required)
      createOpsCommentRequest - (required)
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • createOpsComment

      public CreateOpsCommentResponse createOpsComment(@Nonnull String handle, @Nonnull CreateOpsCommentRequest createOpsCommentRequest, @Nullable String xProjectId) throws ApiException
      Comment on an item Append a comment to a queue item's thread. The body is markdown (mentions like `@teammate` notify that person; `@shipeasy` asks Jarvis, the AI agent, to reply). Pass `parentId` to reply under an existing top-level comment (one level of threading — a reply to a reply attaches to the same parent). Create-only and append-only, so it is safe for restricted ops keys — the same channel the ops loop and Jarvis use to leave a note on an item.
      Parameters:
      handle - Per-project item number (e.g. `7`) or the full ops item id. (required)
      createOpsCommentRequest - (required)
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (optional)
      Returns:
      CreateOpsCommentResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • createOpsCommentWithHttpInfo

      public ApiResponse<CreateOpsCommentResponse> createOpsCommentWithHttpInfo(@Nonnull String handle, @Nonnull CreateOpsCommentRequest createOpsCommentRequest, @Nullable String xProjectId) throws ApiException
      Comment on an item Append a comment to a queue item's thread. The body is markdown (mentions like `@teammate` notify that person; `@shipeasy` asks Jarvis, the AI agent, to reply). Pass `parentId` to reply under an existing top-level comment (one level of threading — a reply to a reply attaches to the same parent). Create-only and append-only, so it is safe for restricted ops keys — the same channel the ops loop and Jarvis use to leave a note on an item.
      Parameters:
      handle - Per-project item number (e.g. `7`) or the full ops item id. (required)
      createOpsCommentRequest - (required)
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (optional)
      Returns:
      ApiResponse<CreateOpsCommentResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • createOpsCommentAsync

      public okhttp3.Call createOpsCommentAsync(@Nonnull String handle, @Nonnull CreateOpsCommentRequest createOpsCommentRequest, @Nullable String xProjectId, ApiCallback<CreateOpsCommentResponse> _callback) throws ApiException
      Comment on an item (asynchronously) Append a comment to a queue item's thread. The body is markdown (mentions like `@teammate` notify that person; `@shipeasy` asks Jarvis, the AI agent, to reply). Pass `parentId` to reply under an existing top-level comment (one level of threading — a reply to a reply attaches to the same parent). Create-only and append-only, so it is safe for restricted ops keys — the same channel the ops loop and Jarvis use to leave a note on an item.
      Parameters:
      handle - Per-project item number (e.g. `7`) or the full ops item id. (required)
      createOpsCommentRequest - (required)
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (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

    • listOpsCommentsCall

      public okhttp3.Call listOpsCommentsCall(@Nonnull String handle, @Nullable String xProjectId, ApiCallback _callback) throws ApiException
      Build call for listOpsComments
      Parameters:
      handle - Per-project item number (e.g. `7`) or the full ops item id. (required)
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • listOpsComments

      public ListOpsCommentsResponse listOpsComments(@Nonnull String handle, @Nullable String xProjectId) throws ApiException
      List an item's comments List the comment thread on a queue item, oldest first. Each comment carries its author (a teammate email, or `system` for a comment authored by Jarvis — the AI agent), its markdown body, and `parentId` for the single level of threaded replies. Removed comments are omitted. **Use case:** Read the discussion on an item before replying or acting on it.
      Parameters:
      handle - Per-project item number (e.g. `7`) or the full ops item id. (required)
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (optional)
      Returns:
      ListOpsCommentsResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listOpsCommentsWithHttpInfo

      public ApiResponse<ListOpsCommentsResponse> listOpsCommentsWithHttpInfo(@Nonnull String handle, @Nullable String xProjectId) throws ApiException
      List an item's comments List the comment thread on a queue item, oldest first. Each comment carries its author (a teammate email, or `system` for a comment authored by Jarvis — the AI agent), its markdown body, and `parentId` for the single level of threaded replies. Removed comments are omitted. **Use case:** Read the discussion on an item before replying or acting on it.
      Parameters:
      handle - Per-project item number (e.g. `7`) or the full ops item id. (required)
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (optional)
      Returns:
      ApiResponse<ListOpsCommentsResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listOpsCommentsAsync

      public okhttp3.Call listOpsCommentsAsync(@Nonnull String handle, @Nullable String xProjectId, ApiCallback<ListOpsCommentsResponse> _callback) throws ApiException
      List an item's comments (asynchronously) List the comment thread on a queue item, oldest first. Each comment carries its author (a teammate email, or `system` for a comment authored by Jarvis — the AI agent), its markdown body, and `parentId` for the single level of threaded replies. Removed comments are omitted. **Use case:** Read the discussion on an item before replying or acting on it.
      Parameters:
      handle - Per-project item number (e.g. `7`) or the full ops item id. (required)
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (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