Package ai.shipeasy.admin.api
Class OpsApi
java.lang.Object
ai.shipeasy.admin.api.OpsApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateOpsItem(CreateOpsItemRequest createOpsItemRequest, String xProjectId) File a queue item Files one queue item — a bug report or a feature request — and fires the project's connectors (GitHub issue / Slack).okhttp3.CallcreateOpsItemAsync(CreateOpsItemRequest createOpsItemRequest, String xProjectId, ApiCallback<CreateOpsItemResponse> _callback) File a queue item (asynchronously) Files one queue item — a bug report or a feature request — and fires the project's connectors (GitHub issue / Slack).okhttp3.CallcreateOpsItemCall(CreateOpsItemRequest createOpsItemRequest, String xProjectId, ApiCallback _callback) Build call for createOpsItemcreateOpsItemWithHttpInfo(CreateOpsItemRequest createOpsItemRequest, String xProjectId) File a queue item Files one queue item — a bug report or a feature request — and fires the project's connectors (GitHub issue / Slack).intgetOpsItem(String handle, String xProjectId) Get one queue item Fetch a single queue item by its per-project `number` or full id.okhttp3.CallgetOpsItemAsync(String handle, String xProjectId, ApiCallback<GetOpsItemResponse> _callback) Get one queue item (asynchronously) Fetch a single queue item by its per-project `number` or full id.okhttp3.CallgetOpsItemCall(String handle, String xProjectId, ApiCallback _callback) Build call for getOpsItemgetOpsItemWithHttpInfo(String handle, String xProjectId) Get one queue item Fetch a single queue item by its per-project `number` or full id.linkPrToOpsItem(String handle, LinkPrToOpsItemRequest linkPrToOpsItemRequest, String xProjectId) Link a fixing PR Record the pull request that fixes a queue item (and clears the link with `prNumber: null`).okhttp3.CalllinkPrToOpsItemAsync(String handle, LinkPrToOpsItemRequest linkPrToOpsItemRequest, String xProjectId, ApiCallback<LinkPrToOpsItemResponse> _callback) Link a fixing PR (asynchronously) Record the pull request that fixes a queue item (and clears the link with `prNumber: null`).okhttp3.CalllinkPrToOpsItemCall(String handle, LinkPrToOpsItemRequest linkPrToOpsItemRequest, String xProjectId, ApiCallback _callback) Build call for linkPrToOpsItemlinkPrToOpsItemWithHttpInfo(String handle, LinkPrToOpsItemRequest linkPrToOpsItemRequest, String xProjectId) Link a fixing PR Record the pull request that fixes a queue item (and clears the link with `prNumber: null`).listOpsItems(String xProjectId, String type, String status, Integer limit) List the operational queue Returns the unified ops queue (bugs, feature requests, errors, alerts) in work order — highest priority first, oldest first within a priority — so consumers work it top-down.okhttp3.CalllistOpsItemsAsync(String xProjectId, String type, String status, Integer limit, ApiCallback<List<ListOpsItemsResponseInner>> _callback) List the operational queue (asynchronously) Returns the unified ops queue (bugs, feature requests, errors, alerts) in work order — highest priority first, oldest first within a priority — so consumers work it top-down.okhttp3.CalllistOpsItemsCall(String xProjectId, String type, String status, Integer limit, ApiCallback _callback) Build call for listOpsItemslistOpsItemsWithHttpInfo(String xProjectId, String type, String status, Integer limit) List the operational queue Returns the unified ops queue (bugs, feature requests, errors, alerts) in work order — highest priority first, oldest first within a priority — so consumers work it top-down.notifyOps(NotifyOpsRequest notifyOpsRequest, String xProjectId) Raise an attention notification Raise a 'needs your attention' bell notification.okhttp3.CallnotifyOpsAsync(NotifyOpsRequest notifyOpsRequest, String xProjectId, ApiCallback<NotifyOpsResponse> _callback) Raise an attention notification (asynchronously) Raise a 'needs your attention' bell notification.okhttp3.CallnotifyOpsCall(NotifyOpsRequest notifyOpsRequest, String xProjectId, ApiCallback _callback) Build call for notifyOpsnotifyOpsWithHttpInfo(NotifyOpsRequest notifyOpsRequest, String xProjectId) Raise an attention notification Raise a 'needs your attention' bell notification.voidsetApiClient(ApiClient apiClient) voidsetCustomBaseUrl(String customBaseUrl) voidsetHostIndex(int hostIndex) updateOpsItem(String handle, UpdateOpsItemRequest updateOpsItemRequest, String xProjectId) Update a queue item Update a queue item.okhttp3.CallupdateOpsItemAsync(String handle, UpdateOpsItemRequest updateOpsItemRequest, String xProjectId, ApiCallback<UpdateOpsItemResponse> _callback) Update a queue item (asynchronously) Update a queue item.okhttp3.CallupdateOpsItemCall(String handle, UpdateOpsItemRequest updateOpsItemRequest, String xProjectId, ApiCallback _callback) Build call for updateOpsItemupdateOpsItemWithHttpInfo(String handle, UpdateOpsItemRequest updateOpsItemRequest, String xProjectId) Update a queue item Update a queue item.
-
Constructor Details
-
OpsApi
public OpsApi() -
OpsApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
getHostIndex
public int getHostIndex() -
setHostIndex
public void setHostIndex(int hostIndex) -
getCustomBaseUrl
-
setCustomBaseUrl
-
createOpsItemCall
public okhttp3.Call createOpsItemCall(@Nonnull CreateOpsItemRequest createOpsItemRequest, @Nullable String xProjectId, ApiCallback _callback) throws ApiException Build call for createOpsItem- Parameters:
createOpsItemRequest- (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
-
createOpsItem
public CreateOpsItemResponse createOpsItem(@Nonnull CreateOpsItemRequest createOpsItemRequest, @Nullable String xProjectId) throws ApiException File a queue item Files one queue item — a bug report or a feature request — and fires the project's connectors (GitHub issue / Slack). `type` selects which; only the two user-fileable types are accepted (`error`/`alert` tickets are auto-filed by the platform). Returns the new id and per-project number. **Use cases** - **File a bug** — `{ \"type\": \"bug\", \"title\": \"Checkout 500s on Safari\", \"stepsToReproduce\": \"…\" }`. - **File a feature request** — `{ \"type\": \"feature_request\", \"title\": \"Dark mode\", \"priority\": \"nice_to_have\" }`.- Parameters:
createOpsItemRequest- (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:
- CreateOpsItemResponse
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
createOpsItemWithHttpInfo
public ApiResponse<CreateOpsItemResponse> createOpsItemWithHttpInfo(@Nonnull CreateOpsItemRequest createOpsItemRequest, @Nullable String xProjectId) throws ApiException File a queue item Files one queue item — a bug report or a feature request — and fires the project's connectors (GitHub issue / Slack). `type` selects which; only the two user-fileable types are accepted (`error`/`alert` tickets are auto-filed by the platform). Returns the new id and per-project number. **Use cases** - **File a bug** — `{ \"type\": \"bug\", \"title\": \"Checkout 500s on Safari\", \"stepsToReproduce\": \"…\" }`. - **File a feature request** — `{ \"type\": \"feature_request\", \"title\": \"Dark mode\", \"priority\": \"nice_to_have\" }`.- Parameters:
createOpsItemRequest- (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<CreateOpsItemResponse>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
createOpsItemAsync
public okhttp3.Call createOpsItemAsync(@Nonnull CreateOpsItemRequest createOpsItemRequest, @Nullable String xProjectId, ApiCallback<CreateOpsItemResponse> _callback) throws ApiException File a queue item (asynchronously) Files one queue item — a bug report or a feature request — and fires the project's connectors (GitHub issue / Slack). `type` selects which; only the two user-fileable types are accepted (`error`/`alert` tickets are auto-filed by the platform). Returns the new id and per-project number. **Use cases** - **File a bug** — `{ \"type\": \"bug\", \"title\": \"Checkout 500s on Safari\", \"stepsToReproduce\": \"…\" }`. - **File a feature request** — `{ \"type\": \"feature_request\", \"title\": \"Dark mode\", \"priority\": \"nice_to_have\" }`.- Parameters:
createOpsItemRequest- (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
-
getOpsItemCall
public okhttp3.Call getOpsItemCall(@Nonnull String handle, @Nullable String xProjectId, ApiCallback _callback) throws ApiException Build call for getOpsItem- 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
-
getOpsItem
public GetOpsItemResponse getOpsItem(@Nonnull String handle, @Nullable String xProjectId) throws ApiException Get one queue item Fetch a single queue item by its per-project `number` or full id. **Use case:** Inspect one item's full detail before updating its status or linking a PR.- 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:
- GetOpsItemResponse
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getOpsItemWithHttpInfo
public ApiResponse<GetOpsItemResponse> getOpsItemWithHttpInfo(@Nonnull String handle, @Nullable String xProjectId) throws ApiException Get one queue item Fetch a single queue item by its per-project `number` or full id. **Use case:** Inspect one item's full detail before updating its status or linking a PR.- 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<GetOpsItemResponse>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getOpsItemAsync
public okhttp3.Call getOpsItemAsync(@Nonnull String handle, @Nullable String xProjectId, ApiCallback<GetOpsItemResponse> _callback) throws ApiException Get one queue item (asynchronously) Fetch a single queue item by its per-project `number` or full id. **Use case:** Inspect one item's full detail before updating its status or linking a PR.- 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
-
linkPrToOpsItemCall
public okhttp3.Call linkPrToOpsItemCall(@Nonnull String handle, @Nonnull LinkPrToOpsItemRequest linkPrToOpsItemRequest, @Nullable String xProjectId, ApiCallback _callback) throws ApiException Build call for linkPrToOpsItem- Parameters:
handle- Per-project item number (e.g. `7`) or the full ops item id. (required)linkPrToOpsItemRequest- (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
-
linkPrToOpsItem
public LinkPrToOpsItemResponse linkPrToOpsItem(@Nonnull String handle, @Nonnull LinkPrToOpsItemRequest linkPrToOpsItemRequest, @Nullable String xProjectId) throws ApiException Link a fixing PR Record the pull request that fixes a queue item (and clears the link with `prNumber: null`). **Use case:** Tie the fixing PR to the item so closing the PR can flip it to ready_for_qa.- Parameters:
handle- Per-project item number (e.g. `7`) or the full ops item id. (required)linkPrToOpsItemRequest- (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:
- LinkPrToOpsItemResponse
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
linkPrToOpsItemWithHttpInfo
public ApiResponse<LinkPrToOpsItemResponse> linkPrToOpsItemWithHttpInfo(@Nonnull String handle, @Nonnull LinkPrToOpsItemRequest linkPrToOpsItemRequest, @Nullable String xProjectId) throws ApiException Link a fixing PR Record the pull request that fixes a queue item (and clears the link with `prNumber: null`). **Use case:** Tie the fixing PR to the item so closing the PR can flip it to ready_for_qa.- Parameters:
handle- Per-project item number (e.g. `7`) or the full ops item id. (required)linkPrToOpsItemRequest- (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<LinkPrToOpsItemResponse>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
linkPrToOpsItemAsync
public okhttp3.Call linkPrToOpsItemAsync(@Nonnull String handle, @Nonnull LinkPrToOpsItemRequest linkPrToOpsItemRequest, @Nullable String xProjectId, ApiCallback<LinkPrToOpsItemResponse> _callback) throws ApiException Link a fixing PR (asynchronously) Record the pull request that fixes a queue item (and clears the link with `prNumber: null`). **Use case:** Tie the fixing PR to the item so closing the PR can flip it to ready_for_qa.- Parameters:
handle- Per-project item number (e.g. `7`) or the full ops item id. (required)linkPrToOpsItemRequest- (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
-
listOpsItemsCall
public okhttp3.Call listOpsItemsCall(@Nullable String xProjectId, @Nullable String type, @Nullable String status, @Nullable Integer limit, ApiCallback _callback) throws ApiException Build call for listOpsItems- Parameters:
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)type- Filter by item type (`bug`/`feature_request`/`error`/`alert`), or `all`. (optional)status- Filter by lifecycle status, or `all`. The human-gated holding states (`pending_approval`, `triage`) are excluded from `all`/default and returned only when requested as the exact status. (optional)limit- Max items to return (1–500). (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
listOpsItems
public List<ListOpsItemsResponseInner> listOpsItems(@Nullable String xProjectId, @Nullable String type, @Nullable String status, @Nullable Integer limit) throws ApiException List the operational queue Returns the unified ops queue (bugs, feature requests, errors, alerts) in work order — highest priority first, oldest first within a priority — so consumers work it top-down. Filter by `type` and/or `status`, and cap with `limit`. Human-gated holding states (items awaiting human sign-off in the dashboard) are never returned by `all`/default status. **Use case:** Pull the open queue to triage — e.g. every `bug` still `open` — before working items down one by one.- Parameters:
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)type- Filter by item type (`bug`/`feature_request`/`error`/`alert`), or `all`. (optional)status- Filter by lifecycle status, or `all`. The human-gated holding states (`pending_approval`, `triage`) are excluded from `all`/default and returned only when requested as the exact status. (optional)limit- Max items to return (1–500). (optional)- Returns:
- List<ListOpsItemsResponseInner>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
listOpsItemsWithHttpInfo
public ApiResponse<List<ListOpsItemsResponseInner>> listOpsItemsWithHttpInfo(@Nullable String xProjectId, @Nullable String type, @Nullable String status, @Nullable Integer limit) throws ApiException List the operational queue Returns the unified ops queue (bugs, feature requests, errors, alerts) in work order — highest priority first, oldest first within a priority — so consumers work it top-down. Filter by `type` and/or `status`, and cap with `limit`. Human-gated holding states (items awaiting human sign-off in the dashboard) are never returned by `all`/default status. **Use case:** Pull the open queue to triage — e.g. every `bug` still `open` — before working items down one by one.- Parameters:
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)type- Filter by item type (`bug`/`feature_request`/`error`/`alert`), or `all`. (optional)status- Filter by lifecycle status, or `all`. The human-gated holding states (`pending_approval`, `triage`) are excluded from `all`/default and returned only when requested as the exact status. (optional)limit- Max items to return (1–500). (optional)- Returns:
- ApiResponse<List<ListOpsItemsResponseInner>>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
listOpsItemsAsync
public okhttp3.Call listOpsItemsAsync(@Nullable String xProjectId, @Nullable String type, @Nullable String status, @Nullable Integer limit, ApiCallback<List<ListOpsItemsResponseInner>> _callback) throws ApiException List the operational queue (asynchronously) Returns the unified ops queue (bugs, feature requests, errors, alerts) in work order — highest priority first, oldest first within a priority — so consumers work it top-down. Filter by `type` and/or `status`, and cap with `limit`. Human-gated holding states (items awaiting human sign-off in the dashboard) are never returned by `all`/default status. **Use case:** Pull the open queue to triage — e.g. every `bug` still `open` — before working items down one by one.- Parameters:
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)type- Filter by item type (`bug`/`feature_request`/`error`/`alert`), or `all`. (optional)status- Filter by lifecycle status, or `all`. The human-gated holding states (`pending_approval`, `triage`) are excluded from `all`/default and returned only when requested as the exact status. (optional)limit- Max items to return (1–500). (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
-
notifyOpsCall
public okhttp3.Call notifyOpsCall(@Nonnull NotifyOpsRequest notifyOpsRequest, @Nullable String xProjectId, ApiCallback _callback) throws ApiException Build call for notifyOps- Parameters:
notifyOpsRequest- (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
-
notifyOps
public NotifyOpsResponse notifyOps(@Nonnull NotifyOpsRequest notifyOpsRequest, @Nullable String xProjectId) throws ApiException Raise an attention notification Raise a 'needs your attention' bell notification. Create-only and idempotent on `dedupeKey` — re-raising with the same key updates the one card instead of stacking duplicates. It never reads, marks read, or deletes the feed, so it is safe for restricted ops keys. **Use case:** Escalate work that can't land in code (a product decision, a credential only a human has, a resource only a human may edit), deduped so repeats don't spam the bell.- Parameters:
notifyOpsRequest- (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:
- NotifyOpsResponse
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
notifyOpsWithHttpInfo
public ApiResponse<NotifyOpsResponse> notifyOpsWithHttpInfo(@Nonnull NotifyOpsRequest notifyOpsRequest, @Nullable String xProjectId) throws ApiException Raise an attention notification Raise a 'needs your attention' bell notification. Create-only and idempotent on `dedupeKey` — re-raising with the same key updates the one card instead of stacking duplicates. It never reads, marks read, or deletes the feed, so it is safe for restricted ops keys. **Use case:** Escalate work that can't land in code (a product decision, a credential only a human has, a resource only a human may edit), deduped so repeats don't spam the bell.- Parameters:
notifyOpsRequest- (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<NotifyOpsResponse>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
notifyOpsAsync
public okhttp3.Call notifyOpsAsync(@Nonnull NotifyOpsRequest notifyOpsRequest, @Nullable String xProjectId, ApiCallback<NotifyOpsResponse> _callback) throws ApiException Raise an attention notification (asynchronously) Raise a 'needs your attention' bell notification. Create-only and idempotent on `dedupeKey` — re-raising with the same key updates the one card instead of stacking duplicates. It never reads, marks read, or deletes the feed, so it is safe for restricted ops keys. **Use case:** Escalate work that can't land in code (a product decision, a credential only a human has, a resource only a human may edit), deduped so repeats don't spam the bell.- Parameters:
notifyOpsRequest- (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
-
updateOpsItemCall
public okhttp3.Call updateOpsItemCall(@Nonnull String handle, @Nonnull UpdateOpsItemRequest updateOpsItemRequest, @Nullable String xProjectId, ApiCallback _callback) throws ApiException Build call for updateOpsItem- Parameters:
handle- Per-project item number (e.g. `7`) or the full ops item id. (required)updateOpsItemRequest- (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
-
updateOpsItem
public UpdateOpsItemResponse updateOpsItem(@Nonnull String handle, @Nonnull UpdateOpsItemRequest updateOpsItemRequest, @Nullable String xProjectId) throws ApiException Update a queue item Update a queue item. The body is validated against the item's stored type: a `bug` accepts its content fields (title, steps-to-reproduce, actual/expected result) plus `status`/`priority`/`notify` and a GitHub PR link; a `feature_request` its content (title, description, use-case) plus the same triage fields; `error`/`alert`/`measure_plan` accept `status`/`priority`/`notify` only (their content is platform-owned). Pass at least one field. Completing an `error` ticket (status `resolved` or `ready_for_qa`) also resolves the tracked error it links to; the error reopens automatically if it recurs — so completing is safe pre-deploy. **Use cases** - **Start working an item** — `{ \"status\": \"in_progress\" }`. - **Hand off for review** — `{ \"status\": \"ready_for_qa\" }` once the fix landed (the mode PR-based loops use). - **Triage** — `{ \"priority\": \"high\" }`, content edits on bug/feature items.- Parameters:
handle- Per-project item number (e.g. `7`) or the full ops item id. (required)updateOpsItemRequest- (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:
- UpdateOpsItemResponse
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateOpsItemWithHttpInfo
public ApiResponse<UpdateOpsItemResponse> updateOpsItemWithHttpInfo(@Nonnull String handle, @Nonnull UpdateOpsItemRequest updateOpsItemRequest, @Nullable String xProjectId) throws ApiException Update a queue item Update a queue item. The body is validated against the item's stored type: a `bug` accepts its content fields (title, steps-to-reproduce, actual/expected result) plus `status`/`priority`/`notify` and a GitHub PR link; a `feature_request` its content (title, description, use-case) plus the same triage fields; `error`/`alert`/`measure_plan` accept `status`/`priority`/`notify` only (their content is platform-owned). Pass at least one field. Completing an `error` ticket (status `resolved` or `ready_for_qa`) also resolves the tracked error it links to; the error reopens automatically if it recurs — so completing is safe pre-deploy. **Use cases** - **Start working an item** — `{ \"status\": \"in_progress\" }`. - **Hand off for review** — `{ \"status\": \"ready_for_qa\" }` once the fix landed (the mode PR-based loops use). - **Triage** — `{ \"priority\": \"high\" }`, content edits on bug/feature items.- Parameters:
handle- Per-project item number (e.g. `7`) or the full ops item id. (required)updateOpsItemRequest- (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<UpdateOpsItemResponse>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateOpsItemAsync
public okhttp3.Call updateOpsItemAsync(@Nonnull String handle, @Nonnull UpdateOpsItemRequest updateOpsItemRequest, @Nullable String xProjectId, ApiCallback<UpdateOpsItemResponse> _callback) throws ApiException Update a queue item (asynchronously) Update a queue item. The body is validated against the item's stored type: a `bug` accepts its content fields (title, steps-to-reproduce, actual/expected result) plus `status`/`priority`/`notify` and a GitHub PR link; a `feature_request` its content (title, description, use-case) plus the same triage fields; `error`/`alert`/`measure_plan` accept `status`/`priority`/`notify` only (their content is platform-owned). Pass at least one field. Completing an `error` ticket (status `resolved` or `ready_for_qa`) also resolves the tracked error it links to; the error reopens automatically if it recurs — so completing is safe pre-deploy. **Use cases** - **Start working an item** — `{ \"status\": \"in_progress\" }`. - **Hand off for review** — `{ \"status\": \"ready_for_qa\" }` once the fix landed (the mode PR-based loops use). - **Triage** — `{ \"priority\": \"high\" }`, content edits on bug/feature items.- Parameters:
handle- Per-project item number (e.g. `7`) or the full ops item id. (required)updateOpsItemRequest- (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
-