@zlayer/api-client 0.10.86

package/dist/apis/ContainersApi.d.ts

@@ -0,0 +1,228 @@
+/**
+ * ZLayer API
+ * Container orchestration API for ZLayer
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { ContainerExecRequest, ContainerExecResponse, ContainerInfo, ContainerStatsResponse, ContainerWaitResponse, CreateContainerRequest, KillContainerRequest, RestartContainerRequest, StopContainerRequest } from '../models/index';
+export interface CreateContainerOperationRequest {
+    createContainerRequest: CreateContainerRequest;
+}
+export interface DeleteContainerRequest {
+    id: string;
+}
+export interface ExecInContainerRequest {
+    id: string;
+    containerExecRequest: ContainerExecRequest;
+}
+export interface GetContainerRequest {
+    id: string;
+}
+export interface GetContainerLogsRequest {
+    id: string;
+    tail?: number;
+    follow?: boolean;
+}
+export interface GetContainerStatsRequest {
+    id: string;
+}
+export interface KillContainerOperationRequest {
+    id: string;
+    killContainerRequest: KillContainerRequest;
+}
+export interface ListContainersRequest {
+    label?: string | null;
+}
+export interface RestartContainerOperationRequest {
+    id: string;
+    restartContainerRequest: RestartContainerRequest;
+}
+export interface StartContainerRequest {
+    id: string;
+}
+export interface StopContainerOperationRequest {
+    id: string;
+    stopContainerRequest: StopContainerRequest;
+}
+export interface WaitContainerRequest {
+    id: string;
+}
+/**
+ *
+ */
+export declare class ContainersApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createContainer without sending the request
+     */
+    createContainerRequestOpts(requestParameters: CreateContainerOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Pulls the image if needed, creates the container, and starts it. Returns the container info including its assigned ID.  # Errors  Returns an error if image pull fails, container creation fails, or the user lacks the operator role.
+     * Create and start a container.
+     */
+    createContainerRaw(requestParameters: CreateContainerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContainerInfo>>;
+    /**
+     * Pulls the image if needed, creates the container, and starts it. Returns the container info including its assigned ID.  # Errors  Returns an error if image pull fails, container creation fails, or the user lacks the operator role.
+     * Create and start a container.
+     */
+    createContainer(requestParameters: CreateContainerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContainerInfo>;
+    /**
+     * Creates request options for deleteContainer without sending the request
+     */
+    deleteContainerRequestOpts(requestParameters: DeleteContainerRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Sends a stop signal (with a 30-second timeout), then removes the container.  # Errors  Returns an error if the container is not found, stop/remove fails, or the user lacks the operator role.
+     * Stop and remove a container.
+     */
+    deleteContainerRaw(requestParameters: DeleteContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Sends a stop signal (with a 30-second timeout), then removes the container.  # Errors  Returns an error if the container is not found, stop/remove fails, or the user lacks the operator role.
+     * Stop and remove a container.
+     */
+    deleteContainer(requestParameters: DeleteContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for execInContainer without sending the request
+     */
+    execInContainerRequestOpts(requestParameters: ExecInContainerRequest): Promise<runtime.RequestOpts>;
+    /**
+     * # Errors  Returns an error if the container is not found, the command is invalid, execution fails, or the user lacks the operator role.
+     * Execute a command in a running container.
+     */
+    execInContainerRaw(requestParameters: ExecInContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContainerExecResponse>>;
+    /**
+     * # Errors  Returns an error if the container is not found, the command is invalid, execution fails, or the user lacks the operator role.
+     * Execute a command in a running container.
+     */
+    execInContainer(requestParameters: ExecInContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContainerExecResponse>;
+    /**
+     * Creates request options for getContainer without sending the request
+     */
+    getContainerRequestOpts(requestParameters: GetContainerRequest): Promise<runtime.RequestOpts>;
+    /**
+     * # Errors  Returns an error if the container is not found or the user is not authenticated.
+     * Get details for a specific container.
+     */
+    getContainerRaw(requestParameters: GetContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContainerInfo>>;
+    /**
+     * # Errors  Returns an error if the container is not found or the user is not authenticated.
+     * Get details for a specific container.
+     */
+    getContainer(requestParameters: GetContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContainerInfo>;
+    /**
+     * Creates request options for getContainerLogs without sending the request
+     */
+    getContainerLogsRequestOpts(requestParameters: GetContainerLogsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Returns the last N lines of container logs as plain text, or streams logs as Server-Sent Events when `follow=true`.  # Errors  Returns an error if the container is not found or log retrieval fails.
+     * Get container logs.
+     */
+    getContainerLogsRaw(requestParameters: GetContainerLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Returns the last N lines of container logs as plain text, or streams logs as Server-Sent Events when `follow=true`.  # Errors  Returns an error if the container is not found or log retrieval fails.
+     * Get container logs.
+     */
+    getContainerLogs(requestParameters: GetContainerLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Creates request options for getContainerStats without sending the request
+     */
+    getContainerStatsRequestOpts(requestParameters: GetContainerStatsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Returns CPU and memory usage statistics for the specified container.  # Errors  Returns an error if the container is not found or stats retrieval fails.
+     * Get container resource statistics.
+     */
+    getContainerStatsRaw(requestParameters: GetContainerStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContainerStatsResponse>>;
+    /**
+     * Returns CPU and memory usage statistics for the specified container.  # Errors  Returns an error if the container is not found or stats retrieval fails.
+     * Get container resource statistics.
+     */
+    getContainerStats(requestParameters: GetContainerStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContainerStatsResponse>;
+    /**
+     * Creates request options for killContainer without sending the request
+     */
+    killContainerRequestOpts(requestParameters: KillContainerOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Mirrors Docker-compat `POST /containers/{id}/kill`. When the request body\'s `signal` field is omitted, the runtime sends `SIGKILL`. Accepted signals are `SIGKILL`, `SIGTERM`, `SIGINT`, `SIGHUP`, `SIGUSR1`, `SIGUSR2` (with or without the `SIG` prefix); any other value is rejected with `400`.  # Errors  Returns `400` for unknown signals, `404` if the container is not found, `403` if the caller lacks the `operator` role, `501` if the runtime does not support `kill_container`, and `500` for other runtime errors.
+     * Send a signal to a running container.
+     */
+    killContainerRaw(requestParameters: KillContainerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Mirrors Docker-compat `POST /containers/{id}/kill`. When the request body\'s `signal` field is omitted, the runtime sends `SIGKILL`. Accepted signals are `SIGKILL`, `SIGTERM`, `SIGINT`, `SIGHUP`, `SIGUSR1`, `SIGUSR2` (with or without the `SIG` prefix); any other value is rejected with `400`.  # Errors  Returns `400` for unknown signals, `404` if the container is not found, `403` if the caller lacks the `operator` role, `501` if the runtime does not support `kill_container`, and `500` for other runtime errors.
+     * Send a signal to a running container.
+     */
+    killContainer(requestParameters: KillContainerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listContainers without sending the request
+     */
+    listContainersRequestOpts(requestParameters: ListContainersRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Returns all containers managed through this API. Optionally filter by label using the `label` query parameter in `key=value` format.  # Errors  Returns an error if the user is not authenticated.
+     * List standalone containers.
+     */
+    listContainersRaw(requestParameters: ListContainersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ContainerInfo>>>;
+    /**
+     * Returns all containers managed through this API. Optionally filter by label using the `label` query parameter in `key=value` format.  # Errors  Returns an error if the user is not authenticated.
+     * List standalone containers.
+     */
+    listContainers(requestParameters?: ListContainersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ContainerInfo>>;
+    /**
+     * Creates request options for restartContainer without sending the request
+     */
+    restartContainerRequestOpts(requestParameters: RestartContainerOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Composes `stop_container(timeout)` followed by `start_container`. Errors during the stop phase are ignored (the container may already be stopped); errors during the start phase are surfaced.  # Errors  Returns an error if the container is not found, the start phase fails, or the user lacks the operator role.
+     * Restart a container: stop then start.
+     */
+    restartContainerRaw(requestParameters: RestartContainerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Composes `stop_container(timeout)` followed by `start_container`. Errors during the stop phase are ignored (the container may already be stopped); errors during the start phase are surfaced.  # Errors  Returns an error if the container is not found, the start phase fails, or the user lacks the operator role.
+     * Restart a container: stop then start.
+     */
+    restartContainer(requestParameters: RestartContainerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for startContainer without sending the request
+     */
+    startContainerRequestOpts(requestParameters: StartContainerRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Useful for re-starting a container that was stopped via `POST /api/v1/containers/{id}/stop` without being removed.  # Errors  Returns an error if the container is not found, start fails, or the user lacks the operator role.
+     * Start a previously-created container.
+     */
+    startContainerRaw(requestParameters: StartContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Useful for re-starting a container that was stopped via `POST /api/v1/containers/{id}/stop` without being removed.  # Errors  Returns an error if the container is not found, start fails, or the user lacks the operator role.
+     * Start a previously-created container.
+     */
+    startContainer(requestParameters: StartContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for stopContainer without sending the request
+     */
+    stopContainerRequestOpts(requestParameters: StopContainerOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Sends the runtime\'s graceful stop signal and waits up to `timeout` seconds before force-killing. The container is **not** removed; use `DELETE /api/v1/containers/{id}` to stop-and-remove. Idempotent: calling stop on an already-stopped container is not an error.  # Errors  Returns an error if the container is not found, stop fails, or the user lacks the operator role.
+     * Stop a running container.
+     */
+    stopContainerRaw(requestParameters: StopContainerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Sends the runtime\'s graceful stop signal and waits up to `timeout` seconds before force-killing. The container is **not** removed; use `DELETE /api/v1/containers/{id}` to stop-and-remove. Idempotent: calling stop on an already-stopped container is not an error.  # Errors  Returns an error if the container is not found, stop fails, or the user lacks the operator role.
+     * Stop a running container.
+     */
+    stopContainer(requestParameters: StopContainerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for waitContainer without sending the request
+     */
+    waitContainerRequestOpts(requestParameters: WaitContainerRequest): Promise<runtime.RequestOpts>;
+    /**
+     * This endpoint blocks until the container exits. Useful for CI runners that need to wait for a build/test container to complete.  # Errors  Returns an error if the container is not found or the wait fails.
+     * Wait for a container to exit and return its exit code.
+     */
+    waitContainerRaw(requestParameters: WaitContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContainerWaitResponse>>;
+    /**
+     * This endpoint blocks until the container exits. Useful for CI runners that need to wait for a build/test container to complete.  # Errors  Returns an error if the container is not found or the wait fails.
+     * Wait for a container to exit and return its exit code.
+     */
+    waitContainer(requestParameters: WaitContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContainerWaitResponse>;
+}