Package ai.shipeasy.admin.api

Class ConnectorsApi

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

  • Constructor Details

    • ConnectorsApi

      public ConnectorsApi()

    • ConnectorsApi

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

    • createConnectorCall

      public okhttp3.Call createConnectorCall(@Nonnull CreateConnectorRequest createConnectorRequest, @Nullable String xProjectId, ApiCallback _callback) throws ApiException
      Build call for createConnector
      Parameters:
      createConnectorRequest - (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

    • createConnector

      public CreateConnectorResponse createConnector(@Nonnull CreateConnectorRequest createConnectorRequest, @Nullable String xProjectId) throws ApiException
      Create a connector Creates a connector. The request body is discriminated on `provider`. - **OAuth/app providers** (`google_sheets`, `github`, `slack`) — supply `{ provider, name, events }`. The connector is created `enabled: false` with empty `config` and no credentials; the provider's OAuth flow then attaches credentials and enables it. - **Trigger providers** (`claude_trigger`, `cursor_trigger`, `copilot_trigger`, `jules_trigger`) — supply `config` plus the provider's credential field(s) and the connector is fireable immediately. Trigger creates are **idempotent** by their natural key (`config.routineId` / `config.repoUrl` / `config.owner`+`config.repo` / `config.source`): re-creating updates the existing row rather than duplicating it. **Use cases** - **File bugs as GitHub Issues** — `{ \"provider\": \"github\", \"name\": \"Bugs → acme/app\", \"events\": [\"bug.created\"] }`, then finish the GitHub App install. - **Nightly ops sweep** — register a `claude_trigger` with its `routineId` and (optionally) a fire `token`; subscribe `events` later to auto-fire on new bugs. - **Cold cloud-agent run** — register a `cursor_trigger`/`jules_trigger` with the repo coordinates plus both keys, or a `copilot_trigger` with the repo + user PAT.
      Parameters:
      createConnectorRequest - (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:
      CreateConnectorResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • createConnectorWithHttpInfo

      public ApiResponse<CreateConnectorResponse> createConnectorWithHttpInfo(@Nonnull CreateConnectorRequest createConnectorRequest, @Nullable String xProjectId) throws ApiException
      Create a connector Creates a connector. The request body is discriminated on `provider`. - **OAuth/app providers** (`google_sheets`, `github`, `slack`) — supply `{ provider, name, events }`. The connector is created `enabled: false` with empty `config` and no credentials; the provider's OAuth flow then attaches credentials and enables it. - **Trigger providers** (`claude_trigger`, `cursor_trigger`, `copilot_trigger`, `jules_trigger`) — supply `config` plus the provider's credential field(s) and the connector is fireable immediately. Trigger creates are **idempotent** by their natural key (`config.routineId` / `config.repoUrl` / `config.owner`+`config.repo` / `config.source`): re-creating updates the existing row rather than duplicating it. **Use cases** - **File bugs as GitHub Issues** — `{ \"provider\": \"github\", \"name\": \"Bugs → acme/app\", \"events\": [\"bug.created\"] }`, then finish the GitHub App install. - **Nightly ops sweep** — register a `claude_trigger` with its `routineId` and (optionally) a fire `token`; subscribe `events` later to auto-fire on new bugs. - **Cold cloud-agent run** — register a `cursor_trigger`/`jules_trigger` with the repo coordinates plus both keys, or a `copilot_trigger` with the repo + user PAT.
      Parameters:
      createConnectorRequest - (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<CreateConnectorResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • createConnectorAsync

      public okhttp3.Call createConnectorAsync(@Nonnull CreateConnectorRequest createConnectorRequest, @Nullable String xProjectId, ApiCallback<CreateConnectorResponse> _callback) throws ApiException
      Create a connector (asynchronously) Creates a connector. The request body is discriminated on `provider`. - **OAuth/app providers** (`google_sheets`, `github`, `slack`) — supply `{ provider, name, events }`. The connector is created `enabled: false` with empty `config` and no credentials; the provider's OAuth flow then attaches credentials and enables it. - **Trigger providers** (`claude_trigger`, `cursor_trigger`, `copilot_trigger`, `jules_trigger`) — supply `config` plus the provider's credential field(s) and the connector is fireable immediately. Trigger creates are **idempotent** by their natural key (`config.routineId` / `config.repoUrl` / `config.owner`+`config.repo` / `config.source`): re-creating updates the existing row rather than duplicating it. **Use cases** - **File bugs as GitHub Issues** — `{ \"provider\": \"github\", \"name\": \"Bugs → acme/app\", \"events\": [\"bug.created\"] }`, then finish the GitHub App install. - **Nightly ops sweep** — register a `claude_trigger` with its `routineId` and (optionally) a fire `token`; subscribe `events` later to auto-fire on new bugs. - **Cold cloud-agent run** — register a `cursor_trigger`/`jules_trigger` with the repo coordinates plus both keys, or a `copilot_trigger` with the repo + user PAT.
      Parameters:
      createConnectorRequest - (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

    • deleteConnectorCall

      public okhttp3.Call deleteConnectorCall(@Nonnull String id, @Nullable String xProjectId, ApiCallback _callback) throws ApiException
      Build call for deleteConnector
      Parameters:
      id - Stable opaque connector 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

    • deleteConnector

      public DeleteConnectorResponse deleteConnector(@Nonnull String id, @Nullable String xProjectId) throws ApiException
      Delete a connector Permanently removes the connector and its stored credentials. **Use case:** Disconnect an integration for good — e.g. tear down a `github` connector after migrating bug routing elsewhere.
      Parameters:
      id - Stable opaque connector 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:
      DeleteConnectorResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • deleteConnectorWithHttpInfo

      public ApiResponse<DeleteConnectorResponse> deleteConnectorWithHttpInfo(@Nonnull String id, @Nullable String xProjectId) throws ApiException
      Delete a connector Permanently removes the connector and its stored credentials. **Use case:** Disconnect an integration for good — e.g. tear down a `github` connector after migrating bug routing elsewhere.
      Parameters:
      id - Stable opaque connector 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<DeleteConnectorResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • deleteConnectorAsync

      public okhttp3.Call deleteConnectorAsync(@Nonnull String id, @Nullable String xProjectId, ApiCallback<DeleteConnectorResponse> _callback) throws ApiException
      Delete a connector (asynchronously) Permanently removes the connector and its stored credentials. **Use case:** Disconnect an integration for good — e.g. tear down a `github` connector after migrating bug routing elsewhere.
      Parameters:
      id - Stable opaque connector 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

    • fireConnectorCall

      public okhttp3.Call fireConnectorCall(@Nonnull String id, @Nullable String xProjectId, @Nullable FireConnectorRequest fireConnectorRequest, ApiCallback _callback) throws ApiException
      Build call for fireConnector
      Parameters:
      id - Stable opaque connector 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)
      fireConnectorRequest - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • fireConnector

      public FireConnectorResponse fireConnector(@Nonnull String id, @Nullable String xProjectId, @Nullable FireConnectorRequest fireConnectorRequest) throws ApiException
      Fire a trigger connector Manually kicks a trigger connector's run — Claude (kicks its preconfigured routine) or Cursor / Copilot / Jules (launches a cold cloud-agent run). Firing is event-less: it kicks the run with an optional caller-supplied prompt override rather than dispatching a single lifecycle payload. Only trigger providers can be fired, and only once authenticated (a tokenless trigger cannot fire). The attempt's outcome is recorded on the connector's `lastAttemptAt` / `lastError` / `lastSuccessAt`. **Use case:** Kick a one-off ops sweep on demand from the dashboard's \"Fire now\" button, optionally overriding the routine's default prompt.
      Parameters:
      id - Stable opaque connector 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)
      fireConnectorRequest - (optional)
      Returns:
      FireConnectorResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • fireConnectorWithHttpInfo

      public ApiResponse<FireConnectorResponse> fireConnectorWithHttpInfo(@Nonnull String id, @Nullable String xProjectId, @Nullable FireConnectorRequest fireConnectorRequest) throws ApiException
      Fire a trigger connector Manually kicks a trigger connector's run — Claude (kicks its preconfigured routine) or Cursor / Copilot / Jules (launches a cold cloud-agent run). Firing is event-less: it kicks the run with an optional caller-supplied prompt override rather than dispatching a single lifecycle payload. Only trigger providers can be fired, and only once authenticated (a tokenless trigger cannot fire). The attempt's outcome is recorded on the connector's `lastAttemptAt` / `lastError` / `lastSuccessAt`. **Use case:** Kick a one-off ops sweep on demand from the dashboard's \"Fire now\" button, optionally overriding the routine's default prompt.
      Parameters:
      id - Stable opaque connector 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)
      fireConnectorRequest - (optional)
      Returns:
      ApiResponse<FireConnectorResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • fireConnectorAsync

      public okhttp3.Call fireConnectorAsync(@Nonnull String id, @Nullable String xProjectId, @Nullable FireConnectorRequest fireConnectorRequest, ApiCallback<FireConnectorResponse> _callback) throws ApiException
      Fire a trigger connector (asynchronously) Manually kicks a trigger connector's run — Claude (kicks its preconfigured routine) or Cursor / Copilot / Jules (launches a cold cloud-agent run). Firing is event-less: it kicks the run with an optional caller-supplied prompt override rather than dispatching a single lifecycle payload. Only trigger providers can be fired, and only once authenticated (a tokenless trigger cannot fire). The attempt's outcome is recorded on the connector's `lastAttemptAt` / `lastError` / `lastSuccessAt`. **Use case:** Kick a one-off ops sweep on demand from the dashboard's \"Fire now\" button, optionally overriding the routine's default prompt.
      Parameters:
      id - Stable opaque connector 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)
      fireConnectorRequest - (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

    • getConnectorCall

      public okhttp3.Call getConnectorCall(@Nonnull String id, @Nullable String xProjectId, ApiCallback _callback) throws ApiException
      Build call for getConnector
      Parameters:
      id - Stable opaque connector 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

    • getConnector

      public ConnectorRecord getConnector(@Nonnull String id, @Nullable String xProjectId) throws ApiException
      Get a connector Returns a single connector by id. The encrypted credentials are never serialised. **Use case:** Inspect one connector's health — its `enabled` state, subscribed `events`, and last-attempt outcome (`lastError`/`lastSuccessAt`).
      Parameters:
      id - Stable opaque connector 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:
      ConnectorRecord
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getConnectorWithHttpInfo

      public ApiResponse<ConnectorRecord> getConnectorWithHttpInfo(@Nonnull String id, @Nullable String xProjectId) throws ApiException
      Get a connector Returns a single connector by id. The encrypted credentials are never serialised. **Use case:** Inspect one connector's health — its `enabled` state, subscribed `events`, and last-attempt outcome (`lastError`/`lastSuccessAt`).
      Parameters:
      id - Stable opaque connector 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<ConnectorRecord>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getConnectorAsync

      public okhttp3.Call getConnectorAsync(@Nonnull String id, @Nullable String xProjectId, ApiCallback<ConnectorRecord> _callback) throws ApiException
      Get a connector (asynchronously) Returns a single connector by id. The encrypted credentials are never serialised. **Use case:** Inspect one connector's health — its `enabled` state, subscribed `events`, and last-attempt outcome (`lastError`/`lastSuccessAt`).
      Parameters:
      id - Stable opaque connector 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

    • listConnectorsCall

      public okhttp3.Call listConnectorsCall(@Nullable String xProjectId, @Nullable String q, ApiCallback _callback) throws ApiException
      Build call for listConnectors
      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)
      q - Case-insensitive substring filter across the resource's human-readable text columns (e.g. `name`, `title`, `description`). OR-matched across those columns; omit to return everything. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • listConnectors

      public List<ConnectorRecord> listConnectors(@Nullable String xProjectId, @Nullable String q) throws ApiException
      List connectors Returns every connector in the project as a bare array (no pagination envelope). The encrypted credentials backing each connector are never serialised — only the connector's non-secret `config`, `accountLabel`, and last-attempt health (`lastError`, `lastAttemptAt`, `lastSuccessAt`) are returned. **Use case:** Render the integrations/triggers settings page, or drive a CI check that asserts every `github` connector is `enabled` and last dispatched without error.
      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)
      q - Case-insensitive substring filter across the resource's human-readable text columns (e.g. `name`, `title`, `description`). OR-matched across those columns; omit to return everything. (optional)
      Returns:
      List<ConnectorRecord>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listConnectorsWithHttpInfo

      public ApiResponse<List<ConnectorRecord>> listConnectorsWithHttpInfo(@Nullable String xProjectId, @Nullable String q) throws ApiException
      List connectors Returns every connector in the project as a bare array (no pagination envelope). The encrypted credentials backing each connector are never serialised — only the connector's non-secret `config`, `accountLabel`, and last-attempt health (`lastError`, `lastAttemptAt`, `lastSuccessAt`) are returned. **Use case:** Render the integrations/triggers settings page, or drive a CI check that asserts every `github` connector is `enabled` and last dispatched without error.
      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)
      q - Case-insensitive substring filter across the resource's human-readable text columns (e.g. `name`, `title`, `description`). OR-matched across those columns; omit to return everything. (optional)
      Returns:
      ApiResponse<List<ConnectorRecord>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listConnectorsAsync

      public okhttp3.Call listConnectorsAsync(@Nullable String xProjectId, @Nullable String q, ApiCallback<List<ConnectorRecord>> _callback) throws ApiException
      List connectors (asynchronously) Returns every connector in the project as a bare array (no pagination envelope). The encrypted credentials backing each connector are never serialised — only the connector's non-secret `config`, `accountLabel`, and last-attempt health (`lastError`, `lastAttemptAt`, `lastSuccessAt`) are returned. **Use case:** Render the integrations/triggers settings page, or drive a CI check that asserts every `github` connector is `enabled` and last dispatched without error.
      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)
      q - Case-insensitive substring filter across the resource's human-readable text columns (e.g. `name`, `title`, `description`). OR-matched across those columns; omit to return everything. (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

    • testConnectorCall

      public okhttp3.Call testConnectorCall(@Nonnull String id, @Nullable String xProjectId, ApiCallback _callback) throws ApiException
      Build call for testConnector
      Parameters:
      id - Stable opaque connector 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

    • testConnector

      public TestConnectorResponse testConnector(@Nonnull String id, @Nullable String xProjectId) throws ApiException
      Test a connector Dispatches a single synthetic `bug.created` payload to the connector's destination so you can verify the integration end-to-end. Unlike `fire`, this runs the real dispatch path (posts a Slack message / appends a Sheets row / files a GitHub Issue) with throwaway test content. The attempt's outcome is recorded on the connector's `lastAttemptAt` / `lastError` / `lastSuccessAt`. When the provider produces a linkable artifact (e.g. a GitHub Issue), its URL is returned as `issueUrl`; otherwise `issueUrl` is `null`. **Use case:** Click \"Send test\" after wiring up a connector to confirm credentials and config are correct before relying on it for real events.
      Parameters:
      id - Stable opaque connector 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:
      TestConnectorResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • testConnectorWithHttpInfo

      public ApiResponse<TestConnectorResponse> testConnectorWithHttpInfo(@Nonnull String id, @Nullable String xProjectId) throws ApiException
      Test a connector Dispatches a single synthetic `bug.created` payload to the connector's destination so you can verify the integration end-to-end. Unlike `fire`, this runs the real dispatch path (posts a Slack message / appends a Sheets row / files a GitHub Issue) with throwaway test content. The attempt's outcome is recorded on the connector's `lastAttemptAt` / `lastError` / `lastSuccessAt`. When the provider produces a linkable artifact (e.g. a GitHub Issue), its URL is returned as `issueUrl`; otherwise `issueUrl` is `null`. **Use case:** Click \"Send test\" after wiring up a connector to confirm credentials and config are correct before relying on it for real events.
      Parameters:
      id - Stable opaque connector 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<TestConnectorResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • testConnectorAsync

      public okhttp3.Call testConnectorAsync(@Nonnull String id, @Nullable String xProjectId, ApiCallback<TestConnectorResponse> _callback) throws ApiException
      Test a connector (asynchronously) Dispatches a single synthetic `bug.created` payload to the connector's destination so you can verify the integration end-to-end. Unlike `fire`, this runs the real dispatch path (posts a Slack message / appends a Sheets row / files a GitHub Issue) with throwaway test content. The attempt's outcome is recorded on the connector's `lastAttemptAt` / `lastError` / `lastSuccessAt`. When the provider produces a linkable artifact (e.g. a GitHub Issue), its URL is returned as `issueUrl`; otherwise `issueUrl` is `null`. **Use case:** Click \"Send test\" after wiring up a connector to confirm credentials and config are correct before relying on it for real events.
      Parameters:
      id - Stable opaque connector 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

    • updateConnectorCall

      public okhttp3.Call updateConnectorCall(@Nonnull String id, @Nonnull UpdateConnectorRequest updateConnectorRequest, @Nullable String xProjectId, ApiCallback _callback) throws ApiException
      Build call for updateConnector
      Parameters:
      id - Stable opaque connector id. (required)
      updateConnectorRequest - (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

    • updateConnector

      public UpdateConnectorResponse updateConnector(@Nonnull String id, @Nonnull UpdateConnectorRequest updateConnectorRequest, @Nullable String xProjectId) throws ApiException
      Update a connector Partial update — only supplied fields change. `events` and `config` **replace** wholesale; there is no merge or append. Secrets cannot be set through this endpoint (credential rotation goes through the provider-specific re-register flow). The response carries only `{ id }` — re-fetch via `GET /api/admin/connectors/{id}` for the new row. **Use cases** - **Pause a connector** — `{ \"enabled\": false }`. Stops all dispatch / auto-fire without deleting it. - **Change subscribed events** — send the full new `events` array. An empty array unsubscribes the connector from every event. - **Rename** — `{ \"name\": \"Bugs → acme/app issues\" }`. - **Retarget** — send a new `config` (e.g. a different Sheets `sheetTitle`); it replaces the stored config wholesale.
      Parameters:
      id - Stable opaque connector id. (required)
      updateConnectorRequest - (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:
      UpdateConnectorResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateConnectorWithHttpInfo

      public ApiResponse<UpdateConnectorResponse> updateConnectorWithHttpInfo(@Nonnull String id, @Nonnull UpdateConnectorRequest updateConnectorRequest, @Nullable String xProjectId) throws ApiException
      Update a connector Partial update — only supplied fields change. `events` and `config` **replace** wholesale; there is no merge or append. Secrets cannot be set through this endpoint (credential rotation goes through the provider-specific re-register flow). The response carries only `{ id }` — re-fetch via `GET /api/admin/connectors/{id}` for the new row. **Use cases** - **Pause a connector** — `{ \"enabled\": false }`. Stops all dispatch / auto-fire without deleting it. - **Change subscribed events** — send the full new `events` array. An empty array unsubscribes the connector from every event. - **Rename** — `{ \"name\": \"Bugs → acme/app issues\" }`. - **Retarget** — send a new `config` (e.g. a different Sheets `sheetTitle`); it replaces the stored config wholesale.
      Parameters:
      id - Stable opaque connector id. (required)
      updateConnectorRequest - (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<UpdateConnectorResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateConnectorAsync

      public okhttp3.Call updateConnectorAsync(@Nonnull String id, @Nonnull UpdateConnectorRequest updateConnectorRequest, @Nullable String xProjectId, ApiCallback<UpdateConnectorResponse> _callback) throws ApiException
      Update a connector (asynchronously) Partial update — only supplied fields change. `events` and `config` **replace** wholesale; there is no merge or append. Secrets cannot be set through this endpoint (credential rotation goes through the provider-specific re-register flow). The response carries only `{ id }` — re-fetch via `GET /api/admin/connectors/{id}` for the new row. **Use cases** - **Pause a connector** — `{ \"enabled\": false }`. Stops all dispatch / auto-fire without deleting it. - **Change subscribed events** — send the full new `events` array. An empty array unsubscribes the connector from every event. - **Rename** — `{ \"name\": \"Bugs → acme/app issues\" }`. - **Retarget** — send a new `config` (e.g. a different Sheets `sheetTitle`); it replaces the stored config wholesale.
      Parameters:
      id - Stable opaque connector id. (required)
      updateConnectorRequest - (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

    • updateTriggerConnectorCall

      public okhttp3.Call updateTriggerConnectorCall(@Nonnull String id, @Nonnull UpdateTriggerConnectorRequest updateTriggerConnectorRequest, @Nullable String xProjectId, ApiCallback _callback) throws ApiException
      Build call for updateTriggerConnector
      Parameters:
      id - Stable opaque connector id. Its stored `provider` must match the body's `provider`. (required)
      updateTriggerConnectorRequest - (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

    • updateTriggerConnector

      public UpdateConnectorResponse updateTriggerConnector(@Nonnull String id, @Nonnull UpdateTriggerConnectorRequest updateTriggerConnectorRequest, @Nullable String xProjectId) throws ApiException
      Update a trigger connector Edit an existing coding-agent **trigger** connector (`claude_trigger` / `cursor_trigger` / `copilot_trigger` / `jules_trigger`) — replace its non-secret `config` and, optionally, rotate its credential secret(s). Discriminated on `provider`; the id in the path selects the connector and its `provider` must match the body. Unlike the generic `PATCH /api/admin/connectors/{id}` (which cannot touch secrets), this endpoint always replaces the non-secret `config` wholesale and merges any supplied secret over the stored credential cipher — so a single half of a two-key pair (e.g. just the ops key) can be rotated on its own. A blank/omitted secret leaves the stored cipher untouched. The response carries only `{ id }` — re-fetch via `GET /api/admin/connectors/{id}` for the new row. **Use case:** Re-point a Cursor trigger at a new repo ref, or rotate a Claude trigger's fire token, without deleting and re-creating the connector.
      Parameters:
      id - Stable opaque connector id. Its stored `provider` must match the body's `provider`. (required)
      updateTriggerConnectorRequest - (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:
      UpdateConnectorResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateTriggerConnectorWithHttpInfo

      public ApiResponse<UpdateConnectorResponse> updateTriggerConnectorWithHttpInfo(@Nonnull String id, @Nonnull UpdateTriggerConnectorRequest updateTriggerConnectorRequest, @Nullable String xProjectId) throws ApiException
      Update a trigger connector Edit an existing coding-agent **trigger** connector (`claude_trigger` / `cursor_trigger` / `copilot_trigger` / `jules_trigger`) — replace its non-secret `config` and, optionally, rotate its credential secret(s). Discriminated on `provider`; the id in the path selects the connector and its `provider` must match the body. Unlike the generic `PATCH /api/admin/connectors/{id}` (which cannot touch secrets), this endpoint always replaces the non-secret `config` wholesale and merges any supplied secret over the stored credential cipher — so a single half of a two-key pair (e.g. just the ops key) can be rotated on its own. A blank/omitted secret leaves the stored cipher untouched. The response carries only `{ id }` — re-fetch via `GET /api/admin/connectors/{id}` for the new row. **Use case:** Re-point a Cursor trigger at a new repo ref, or rotate a Claude trigger's fire token, without deleting and re-creating the connector.
      Parameters:
      id - Stable opaque connector id. Its stored `provider` must match the body's `provider`. (required)
      updateTriggerConnectorRequest - (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<UpdateConnectorResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateTriggerConnectorAsync

      public okhttp3.Call updateTriggerConnectorAsync(@Nonnull String id, @Nonnull UpdateTriggerConnectorRequest updateTriggerConnectorRequest, @Nullable String xProjectId, ApiCallback<UpdateConnectorResponse> _callback) throws ApiException
      Update a trigger connector (asynchronously) Edit an existing coding-agent **trigger** connector (`claude_trigger` / `cursor_trigger` / `copilot_trigger` / `jules_trigger`) — replace its non-secret `config` and, optionally, rotate its credential secret(s). Discriminated on `provider`; the id in the path selects the connector and its `provider` must match the body. Unlike the generic `PATCH /api/admin/connectors/{id}` (which cannot touch secrets), this endpoint always replaces the non-secret `config` wholesale and merges any supplied secret over the stored credential cipher — so a single half of a two-key pair (e.g. just the ops key) can be rotated on its own. A blank/omitted secret leaves the stored cipher untouched. The response carries only `{ id }` — re-fetch via `GET /api/admin/connectors/{id}` for the new row. **Use case:** Re-point a Cursor trigger at a new repo ref, or rotate a Claude trigger's fire token, without deleting and re-creating the connector.
      Parameters:
      id - Stable opaque connector id. Its stored `provider` must match the body's `provider`. (required)
      updateTriggerConnectorRequest - (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