Package ai.shipeasy.admin.api

Class ProjectsApi

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

  • Constructor Details

    • ProjectsApi

      public ProjectsApi()

    • ProjectsApi

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

    • getCurrentProjectCall

      public okhttp3.Call getCurrentProjectCall(@Nullable String xProjectId, ApiCallback _callback) throws ApiException
      Build call for getCurrentProject
      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)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getCurrentProject

      public GetCurrentProjectResponse getCurrentProject(@Nullable String xProjectId) throws ApiException
      Show the current project Returns the project the caller's auth header resolves to — plan, status, billing, and which modules are enabled. The server reads the project from the credential, so there is no id parameter. Powers `whoami`. **Use case:** Resolve who you are — the project, plan, and enabled modules tied to the current credential — without passing an id. Backs a registry-driven `whoami`.
      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)
      Returns:
      GetCurrentProjectResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getCurrentProjectWithHttpInfo

      public ApiResponse<GetCurrentProjectResponse> getCurrentProjectWithHttpInfo(@Nullable String xProjectId) throws ApiException
      Show the current project Returns the project the caller's auth header resolves to — plan, status, billing, and which modules are enabled. The server reads the project from the credential, so there is no id parameter. Powers `whoami`. **Use case:** Resolve who you are — the project, plan, and enabled modules tied to the current credential — without passing an id. Backs a registry-driven `whoami`.
      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)
      Returns:
      ApiResponse<GetCurrentProjectResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getCurrentProjectAsync

      public okhttp3.Call getCurrentProjectAsync(@Nullable String xProjectId, ApiCallback<GetCurrentProjectResponse> _callback) throws ApiException
      Show the current project (asynchronously) Returns the project the caller's auth header resolves to — plan, status, billing, and which modules are enabled. The server reads the project from the credential, so there is no id parameter. Powers `whoami`. **Use case:** Resolve who you are — the project, plan, and enabled modules tied to the current credential — without passing an id. Backs a registry-driven `whoami`.
      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)
      _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

    • searchResourcesCall

      public okhttp3.Call searchResourcesCall(@Nullable String xProjectId, @Nullable String q, ApiCallback _callback) throws ApiException
      Build call for searchResources
      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 - Search query. Matched as a case-insensitive substring against each resource's `name` and title/display name. Trimmed; empty returns no hits. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • searchResources

      public SearchResponse searchResources(@Nullable String xProjectId, @Nullable String q) throws ApiException
      Search project resources Universal substring search across the project's primary resources — feature gates, experiments, dynamic configs, killswitches, metrics, and team members. Matches the trimmed `q` against each resource's immutable `name` and its human title/display name (members match on display name or email), newest-first, capped per resource family so one noisy type can't crowd out the rest. Returns a flat, ranked-by-type list of hits (members first); an empty or whitespace-only `q` returns no hits. Each hit carries a project-relative `href` that deep-links to the row. **Use case:** Back a command-palette / quick-switcher in the dashboard, or look up the id of a resource by a fragment of its name before driving another API call.
      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 - Search query. Matched as a case-insensitive substring against each resource's `name` and title/display name. Trimmed; empty returns no hits. (optional)
      Returns:
      SearchResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • searchResourcesWithHttpInfo

      public ApiResponse<SearchResponse> searchResourcesWithHttpInfo(@Nullable String xProjectId, @Nullable String q) throws ApiException
      Search project resources Universal substring search across the project's primary resources — feature gates, experiments, dynamic configs, killswitches, metrics, and team members. Matches the trimmed `q` against each resource's immutable `name` and its human title/display name (members match on display name or email), newest-first, capped per resource family so one noisy type can't crowd out the rest. Returns a flat, ranked-by-type list of hits (members first); an empty or whitespace-only `q` returns no hits. Each hit carries a project-relative `href` that deep-links to the row. **Use case:** Back a command-palette / quick-switcher in the dashboard, or look up the id of a resource by a fragment of its name before driving another API call.
      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 - Search query. Matched as a case-insensitive substring against each resource's `name` and title/display name. Trimmed; empty returns no hits. (optional)
      Returns:
      ApiResponse<SearchResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • searchResourcesAsync

      public okhttp3.Call searchResourcesAsync(@Nullable String xProjectId, @Nullable String q, ApiCallback<SearchResponse> _callback) throws ApiException
      Search project resources (asynchronously) Universal substring search across the project's primary resources — feature gates, experiments, dynamic configs, killswitches, metrics, and team members. Matches the trimmed `q` against each resource's immutable `name` and its human title/display name (members match on display name or email), newest-first, capped per resource family so one noisy type can't crowd out the rest. Returns a flat, ranked-by-type list of hits (members first); an empty or whitespace-only `q` returns no hits. Each hit carries a project-relative `href` that deep-links to the row. **Use case:** Back a command-palette / quick-switcher in the dashboard, or look up the id of a resource by a fragment of its name before driving another API call.
      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 - Search query. Matched as a case-insensitive substring against each resource's `name` and title/display name. Trimmed; empty returns no hits. (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

    • updateProjectCall

      public okhttp3.Call updateProjectCall(@Nonnull String id, @Nonnull UpdateProjectRequest updateProjectRequest, @Nullable String xProjectId, ApiCallback _callback) throws ApiException
      Build call for updateProject
      Parameters:
      id - Stable opaque project id. Must match the caller's own project. (required)
      updateProjectRequest - (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

    • updateProject

      public GetCurrentProjectResponse updateProject(@Nonnull String id, @Nonnull UpdateProjectRequest updateProjectRequest, @Nullable String xProjectId) throws ApiException
      Update the current project Update the current project's settings — name, domain, slug, default environment, timezone, experiment-analysis knobs (statistical method, significance threshold, auto-rollback, minimum sample days), and the per-module enable flags. Partial: only the fields you send change. The project id in the path must match the project the caller's credential resolves to (a credential can only edit its own project). Changing `domain` re-stamps the allowed origin into every live SDK key. **Use case:** Rename a project, move its domain, toggle a module on/off, or tune the experiment-analysis defaults without leaving the CLI.
      Parameters:
      id - Stable opaque project id. Must match the caller's own project. (required)
      updateProjectRequest - (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:
      GetCurrentProjectResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateProjectWithHttpInfo

      public ApiResponse<GetCurrentProjectResponse> updateProjectWithHttpInfo(@Nonnull String id, @Nonnull UpdateProjectRequest updateProjectRequest, @Nullable String xProjectId) throws ApiException
      Update the current project Update the current project's settings — name, domain, slug, default environment, timezone, experiment-analysis knobs (statistical method, significance threshold, auto-rollback, minimum sample days), and the per-module enable flags. Partial: only the fields you send change. The project id in the path must match the project the caller's credential resolves to (a credential can only edit its own project). Changing `domain` re-stamps the allowed origin into every live SDK key. **Use case:** Rename a project, move its domain, toggle a module on/off, or tune the experiment-analysis defaults without leaving the CLI.
      Parameters:
      id - Stable opaque project id. Must match the caller's own project. (required)
      updateProjectRequest - (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<GetCurrentProjectResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateProjectAsync

      public okhttp3.Call updateProjectAsync(@Nonnull String id, @Nonnull UpdateProjectRequest updateProjectRequest, @Nullable String xProjectId, ApiCallback<GetCurrentProjectResponse> _callback) throws ApiException
      Update the current project (asynchronously) Update the current project's settings — name, domain, slug, default environment, timezone, experiment-analysis knobs (statistical method, significance threshold, auto-rollback, minimum sample days), and the per-module enable flags. Partial: only the fields you send change. The project id in the path must match the project the caller's credential resolves to (a credential can only edit its own project). Changing `domain` re-stamps the allowed origin into every live SDK key. **Use case:** Rename a project, move its domain, toggle a module on/off, or tune the experiment-analysis defaults without leaving the CLI.
      Parameters:
      id - Stable opaque project id. Must match the caller's own project. (required)
      updateProjectRequest - (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

    • upsertProjectCall

      public okhttp3.Call upsertProjectCall(@Nonnull UpsertProjectRequest upsertProjectRequest, @Nullable String xProjectId, ApiCallback _callback) throws ApiException
      Build call for upsertProject
      Parameters:
      upsertProjectRequest - (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

    • upsertProject

      public UpsertProjectResponse upsertProject(@Nonnull UpsertProjectRequest upsertProjectRequest, @Nullable String xProjectId) throws ApiException
      Find-or-create a project by domain Find-or-creates a project keyed by `(owner_email, domain)` under the session's owner, and returns it. Idempotent: a second call with the same domain returns the existing project with `created: false`. Only `domain` is required — `name` defaults to the domain on first create. Recording the result in a local `.shipeasy` binding is a consumer side-effect; this endpoint never performs it. **Use cases** - **Install flow** — provision a per-app project without a trip to the dashboard. Run it on every install; the idempotent key means a re-run returns the existing project rather than duplicating it. - **Name explicitly** — pass `name` to label the project distinctly from its `domain`.
      Parameters:
      upsertProjectRequest - (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:
      UpsertProjectResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • upsertProjectWithHttpInfo

      public ApiResponse<UpsertProjectResponse> upsertProjectWithHttpInfo(@Nonnull UpsertProjectRequest upsertProjectRequest, @Nullable String xProjectId) throws ApiException
      Find-or-create a project by domain Find-or-creates a project keyed by `(owner_email, domain)` under the session's owner, and returns it. Idempotent: a second call with the same domain returns the existing project with `created: false`. Only `domain` is required — `name` defaults to the domain on first create. Recording the result in a local `.shipeasy` binding is a consumer side-effect; this endpoint never performs it. **Use cases** - **Install flow** — provision a per-app project without a trip to the dashboard. Run it on every install; the idempotent key means a re-run returns the existing project rather than duplicating it. - **Name explicitly** — pass `name` to label the project distinctly from its `domain`.
      Parameters:
      upsertProjectRequest - (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<UpsertProjectResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • upsertProjectAsync

      public okhttp3.Call upsertProjectAsync(@Nonnull UpsertProjectRequest upsertProjectRequest, @Nullable String xProjectId, ApiCallback<UpsertProjectResponse> _callback) throws ApiException
      Find-or-create a project by domain (asynchronously) Find-or-creates a project keyed by `(owner_email, domain)` under the session's owner, and returns it. Idempotent: a second call with the same domain returns the existing project with `created: false`. Only `domain` is required — `name` defaults to the domain on first create. Recording the result in a local `.shipeasy` binding is a consumer side-effect; this endpoint never performs it. **Use cases** - **Install flow** — provision a per-app project without a trip to the dashboard. Run it on every install; the idempotent key means a re-run returns the existing project rather than duplicating it. - **Name explicitly** — pass `name` to label the project distinctly from its `domain`.
      Parameters:
      upsertProjectRequest - (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