Package ai.shipeasy.admin.api

Class ErrorsApi

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

  • Constructor Details

    • ErrorsApi

      public ErrorsApi()

    • ErrorsApi

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

    • fileErrorTicketCall

      public okhttp3.Call fileErrorTicketCall(@Nonnull String id, @Nullable String xProjectId, ApiCallback _callback) throws ApiException
      Build call for fileErrorTicket
      Parameters:
      id - Stable opaque error id (`err_…`). (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

    • fileErrorTicket

      public FileErrorTicketResponse fileErrorTicket(@Nonnull String id, @Nullable String xProjectId) throws ApiException
      File a feedback ticket for an error Files a feedback ticket (`type: \"error\"`) for a tracked production error — the \"File an issue\" action on the errors dashboard. The ticket carries the error's fingerprint as its `sourceRef` so it dedupes against, and joins back to, the tracked error. Takes no body. Idempotent: if an open `error` ticket already tracks this fingerprint (hand- or auto-filed), that existing ticket is returned instead of creating a duplicate. Returns `404` if the error does not exist. **Use case:** Promote a noisy tracked error into an actionable ticket in the ops queue (the same item the worker auto-files once an error crosses its occurrence threshold), so it can be triaged, assigned, and burned down via the `shipeasy-ops-work` skill.
      Parameters:
      id - Stable opaque error id (`err_…`). (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:
      FileErrorTicketResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • fileErrorTicketWithHttpInfo

      public ApiResponse<FileErrorTicketResponse> fileErrorTicketWithHttpInfo(@Nonnull String id, @Nullable String xProjectId) throws ApiException
      File a feedback ticket for an error Files a feedback ticket (`type: \"error\"`) for a tracked production error — the \"File an issue\" action on the errors dashboard. The ticket carries the error's fingerprint as its `sourceRef` so it dedupes against, and joins back to, the tracked error. Takes no body. Idempotent: if an open `error` ticket already tracks this fingerprint (hand- or auto-filed), that existing ticket is returned instead of creating a duplicate. Returns `404` if the error does not exist. **Use case:** Promote a noisy tracked error into an actionable ticket in the ops queue (the same item the worker auto-files once an error crosses its occurrence threshold), so it can be triaged, assigned, and burned down via the `shipeasy-ops-work` skill.
      Parameters:
      id - Stable opaque error id (`err_…`). (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<FileErrorTicketResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • fileErrorTicketAsync

      public okhttp3.Call fileErrorTicketAsync(@Nonnull String id, @Nullable String xProjectId, ApiCallback<FileErrorTicketResponse> _callback) throws ApiException
      File a feedback ticket for an error (asynchronously) Files a feedback ticket (`type: \"error\"`) for a tracked production error — the \"File an issue\" action on the errors dashboard. The ticket carries the error's fingerprint as its `sourceRef` so it dedupes against, and joins back to, the tracked error. Takes no body. Idempotent: if an open `error` ticket already tracks this fingerprint (hand- or auto-filed), that existing ticket is returned instead of creating a duplicate. Returns `404` if the error does not exist. **Use case:** Promote a noisy tracked error into an actionable ticket in the ops queue (the same item the worker auto-files once an error crosses its occurrence threshold), so it can be triaged, assigned, and burned down via the `shipeasy-ops-work` skill.
      Parameters:
      id - Stable opaque error id (`err_…`). (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

    • getErrorCall

      public okhttp3.Call getErrorCall(@Nonnull String id, @Nullable String xProjectId, ApiCallback _callback) throws ApiException
      Build call for getError
      Parameters:
      id - Stable opaque error id (`err_…`). (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

    • getError

      public ErrorRecord getError(@Nonnull String id, @Nullable String xProjectId) throws ApiException
      Get a tracked error Returns a single tracked error by its id, including the latest occurrence's stack, extras, and consequence. Returns `404` if no such error exists in the project. **Use case:** Drill into one issue — fetch its full stack and `seenUrls` to investigate, or to render the detail panel behind a row in the errors list.
      Parameters:
      id - Stable opaque error id (`err_…`). (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:
      ErrorRecord
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getErrorWithHttpInfo

      public ApiResponse<ErrorRecord> getErrorWithHttpInfo(@Nonnull String id, @Nullable String xProjectId) throws ApiException
      Get a tracked error Returns a single tracked error by its id, including the latest occurrence's stack, extras, and consequence. Returns `404` if no such error exists in the project. **Use case:** Drill into one issue — fetch its full stack and `seenUrls` to investigate, or to render the detail panel behind a row in the errors list.
      Parameters:
      id - Stable opaque error id (`err_…`). (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<ErrorRecord>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getErrorAsync

      public okhttp3.Call getErrorAsync(@Nonnull String id, @Nullable String xProjectId, ApiCallback<ErrorRecord> _callback) throws ApiException
      Get a tracked error (asynchronously) Returns a single tracked error by its id, including the latest occurrence's stack, extras, and consequence. Returns `404` if no such error exists in the project. **Use case:** Drill into one issue — fetch its full stack and `seenUrls` to investigate, or to render the detail panel behind a row in the errors list.
      Parameters:
      id - Stable opaque error id (`err_…`). (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

    • getErrorSeriesCall

      public okhttp3.Call getErrorSeriesCall(@Nonnull String id, @Nonnull ErrorSeriesRequest errorSeriesRequest, @Nullable String xProjectId, ApiCallback _callback) throws ApiException
      Build call for getErrorSeries
      Parameters:
      id - Stable opaque error id (`err_…`). (required)
      errorSeriesRequest - (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

    • getErrorSeries

      public ErrorSeriesResponse getErrorSeries(@Nonnull String id, @Nonnull ErrorSeriesRequest errorSeriesRequest, @Nullable String xProjectId) throws ApiException
      Get an error's occurrence series Returns a bucketed occurrence timeseries for one tracked error (by its fingerprint), read from the `shipeasy_errors` Analytics Engine dataset (near-real-time; ingest lag is seconds). The window bounds are epoch **seconds**; `to` must be strictly greater than `from`. The response echoes the SQL that produced the rows. **Use case:** Render the trend sparkline / occurrence chart on the error detail panel, or pull the raw bucketed counts to alert when an issue's rate spikes.
      Parameters:
      id - Stable opaque error id (`err_…`). (required)
      errorSeriesRequest - (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:
      ErrorSeriesResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getErrorSeriesWithHttpInfo

      public ApiResponse<ErrorSeriesResponse> getErrorSeriesWithHttpInfo(@Nonnull String id, @Nonnull ErrorSeriesRequest errorSeriesRequest, @Nullable String xProjectId) throws ApiException
      Get an error's occurrence series Returns a bucketed occurrence timeseries for one tracked error (by its fingerprint), read from the `shipeasy_errors` Analytics Engine dataset (near-real-time; ingest lag is seconds). The window bounds are epoch **seconds**; `to` must be strictly greater than `from`. The response echoes the SQL that produced the rows. **Use case:** Render the trend sparkline / occurrence chart on the error detail panel, or pull the raw bucketed counts to alert when an issue's rate spikes.
      Parameters:
      id - Stable opaque error id (`err_…`). (required)
      errorSeriesRequest - (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<ErrorSeriesResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getErrorSeriesAsync

      public okhttp3.Call getErrorSeriesAsync(@Nonnull String id, @Nonnull ErrorSeriesRequest errorSeriesRequest, @Nullable String xProjectId, ApiCallback<ErrorSeriesResponse> _callback) throws ApiException
      Get an error's occurrence series (asynchronously) Returns a bucketed occurrence timeseries for one tracked error (by its fingerprint), read from the `shipeasy_errors` Analytics Engine dataset (near-real-time; ingest lag is seconds). The window bounds are epoch **seconds**; `to` must be strictly greater than `from`. The response echoes the SQL that produced the rows. **Use case:** Render the trend sparkline / occurrence chart on the error detail panel, or pull the raw bucketed counts to alert when an issue's rate spikes.
      Parameters:
      id - Stable opaque error id (`err_…`). (required)
      errorSeriesRequest - (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

    • listErrorsCall

      public okhttp3.Call listErrorsCall(@Nullable String xProjectId, @Nullable String status, @Nullable String q, @Nullable Integer limit, ApiCallback _callback) throws ApiException
      Build call for listErrors
      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)
      status - Filter by triage state. `all` (the default) returns every status. (optional, default to all)
      q - Case-insensitive substring match against `message`, `errorType`, and `subject`. (optional)
      limit - Maximum number of rows to return (1–500). Defaults to 200. (optional, default to 200)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • listErrors

      public List<ErrorRecord> listErrors(@Nullable String xProjectId, @Nullable String status, @Nullable String q, @Nullable Integer limit) throws ApiException
      List tracked errors Returns a single page of tracked production errors as a **bare JSON array** (no pagination envelope), ordered by `lastSeenAt desc`. Filter with `status`, free-text-search with `q`, and cap the page with `limit`. Tracked errors are never filed by hand — an ingestion path (worker log drain / the `see()` SDK reporter) folds each occurrence into a row keyed by `fingerprint`, bumping `count` and `lastSeenAt`. This surface only reads them and (via PATCH) flips their `status`. **Use case:** Snapshot the project's open issues for a triage dashboard, or drive a CI gate that fails the build when any `open` error of `kind: uncaught` exists in `prod`.
      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)
      status - Filter by triage state. `all` (the default) returns every status. (optional, default to all)
      q - Case-insensitive substring match against `message`, `errorType`, and `subject`. (optional)
      limit - Maximum number of rows to return (1–500). Defaults to 200. (optional, default to 200)
      Returns:
      List<ErrorRecord>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listErrorsWithHttpInfo

      public ApiResponse<List<ErrorRecord>> listErrorsWithHttpInfo(@Nullable String xProjectId, @Nullable String status, @Nullable String q, @Nullable Integer limit) throws ApiException
      List tracked errors Returns a single page of tracked production errors as a **bare JSON array** (no pagination envelope), ordered by `lastSeenAt desc`. Filter with `status`, free-text-search with `q`, and cap the page with `limit`. Tracked errors are never filed by hand — an ingestion path (worker log drain / the `see()` SDK reporter) folds each occurrence into a row keyed by `fingerprint`, bumping `count` and `lastSeenAt`. This surface only reads them and (via PATCH) flips their `status`. **Use case:** Snapshot the project's open issues for a triage dashboard, or drive a CI gate that fails the build when any `open` error of `kind: uncaught` exists in `prod`.
      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)
      status - Filter by triage state. `all` (the default) returns every status. (optional, default to all)
      q - Case-insensitive substring match against `message`, `errorType`, and `subject`. (optional)
      limit - Maximum number of rows to return (1–500). Defaults to 200. (optional, default to 200)
      Returns:
      ApiResponse<List<ErrorRecord>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listErrorsAsync

      public okhttp3.Call listErrorsAsync(@Nullable String xProjectId, @Nullable String status, @Nullable String q, @Nullable Integer limit, ApiCallback<List<ErrorRecord>> _callback) throws ApiException
      List tracked errors (asynchronously) Returns a single page of tracked production errors as a **bare JSON array** (no pagination envelope), ordered by `lastSeenAt desc`. Filter with `status`, free-text-search with `q`, and cap the page with `limit`. Tracked errors are never filed by hand — an ingestion path (worker log drain / the `see()` SDK reporter) folds each occurrence into a row keyed by `fingerprint`, bumping `count` and `lastSeenAt`. This surface only reads them and (via PATCH) flips their `status`. **Use case:** Snapshot the project's open issues for a triage dashboard, or drive a CI gate that fails the build when any `open` error of `kind: uncaught` exists in `prod`.
      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)
      status - Filter by triage state. `all` (the default) returns every status. (optional, default to all)
      q - Case-insensitive substring match against `message`, `errorType`, and `subject`. (optional)
      limit - Maximum number of rows to return (1–500). Defaults to 200. (optional, default to 200)
      _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

    • updateErrorStatusCall

      public okhttp3.Call updateErrorStatusCall(@Nonnull String id, @Nonnull UpdateErrorStatusRequest updateErrorStatusRequest, @Nullable String xProjectId, ApiCallback _callback) throws ApiException
      Build call for updateErrorStatus
      Parameters:
      id - Stable opaque error id (`err_…`). (required)
      updateErrorStatusRequest - (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

    • updateErrorStatus

      public ErrorRecord updateErrorStatus(@Nonnull String id, @Nonnull UpdateErrorStatusRequest updateErrorStatusRequest, @Nullable String xProjectId) throws ApiException
      Update a tracked error's status Flips the triage state of one error — the only mutation this surface allows. Valid transitions are between `open`, `resolved`, and `ignored`; the body must carry exactly `{ \"status\": … }`. A `resolved` error reopens automatically (ingestion-side) if it recurs; `ignored` is sticky until flipped back here. Returns the updated row. **Use cases** - **Triage** — `{ \"status\": \"ignored\" }` to suppress a known-benign issue from the open list. - **Close out** — `{ \"status\": \"resolved\" }` once the fix lands; it reopens on its own if the error recurs.
      Parameters:
      id - Stable opaque error id (`err_…`). (required)
      updateErrorStatusRequest - (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:
      ErrorRecord
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateErrorStatusWithHttpInfo

      public ApiResponse<ErrorRecord> updateErrorStatusWithHttpInfo(@Nonnull String id, @Nonnull UpdateErrorStatusRequest updateErrorStatusRequest, @Nullable String xProjectId) throws ApiException
      Update a tracked error's status Flips the triage state of one error — the only mutation this surface allows. Valid transitions are between `open`, `resolved`, and `ignored`; the body must carry exactly `{ \"status\": … }`. A `resolved` error reopens automatically (ingestion-side) if it recurs; `ignored` is sticky until flipped back here. Returns the updated row. **Use cases** - **Triage** — `{ \"status\": \"ignored\" }` to suppress a known-benign issue from the open list. - **Close out** — `{ \"status\": \"resolved\" }` once the fix lands; it reopens on its own if the error recurs.
      Parameters:
      id - Stable opaque error id (`err_…`). (required)
      updateErrorStatusRequest - (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<ErrorRecord>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateErrorStatusAsync

      public okhttp3.Call updateErrorStatusAsync(@Nonnull String id, @Nonnull UpdateErrorStatusRequest updateErrorStatusRequest, @Nullable String xProjectId, ApiCallback<ErrorRecord> _callback) throws ApiException
      Update a tracked error's status (asynchronously) Flips the triage state of one error — the only mutation this surface allows. Valid transitions are between `open`, `resolved`, and `ignored`; the body must carry exactly `{ \"status\": … }`. A `resolved` error reopens automatically (ingestion-side) if it recurs; `ignored` is sticky until flipped back here. Returns the updated row. **Use cases** - **Triage** — `{ \"status\": \"ignored\" }` to suppress a known-benign issue from the open list. - **Close out** — `{ \"status\": \"resolved\" }` once the fix lands; it reopens on its own if the error recurs.
      Parameters:
      id - Stable opaque error id (`err_…`). (required)
      updateErrorStatusRequest - (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