@zlayer/api-client 0.10.86

package/src/apis/DeploymentsApi.ts

@@ -0,0 +1,261 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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 {
+  CreateDeploymentRequest,
+  DeploymentDetails,
+  DeploymentSummary,
+} from '../models/index';
+import {
+    CreateDeploymentRequestFromJSON,
+    CreateDeploymentRequestToJSON,
+    DeploymentDetailsFromJSON,
+    DeploymentDetailsToJSON,
+    DeploymentSummaryFromJSON,
+    DeploymentSummaryToJSON,
+} from '../models/index';
+
+export interface CreateDeploymentOperationRequest {
+    createDeploymentRequest: CreateDeploymentRequest;
+}
+
+export interface DeleteDeploymentRequest {
+    name: string;
+}
+
+export interface GetDeploymentRequest {
+    name: string;
+}
+
+/**
+ * 
+ */
+export class DeploymentsApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for createDeployment without sending the request
+     */
+    async createDeploymentRequestOpts(requestParameters: CreateDeploymentOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['createDeploymentRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createDeploymentRequest',
+                'Required parameter "createDeploymentRequest" was null or undefined when calling createDeployment().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer_auth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/deployments`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateDeploymentRequestToJSON(requestParameters['createDeploymentRequest']),
+        };
+    }
+
+    /**
+     * When the daemon has orchestration wired (service manager, proxy, overlay), this handler:  1. Parses and validates the spec YAML  2. Stores the deployment with status `Deploying`  3. Spawns an async task that registers services, sets up overlays,     configures the proxy, and scales services  4. Returns immediately with `Deploying` status  5. The async task updates the stored status to `Running` or `Failed`  Without orchestration wired, it stores the spec with `Pending` status.  # Errors  Returns an error if the spec is invalid or storage fails.
+     * Create a new deployment.
+     */
+    async createDeploymentRaw(requestParameters: CreateDeploymentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeploymentDetails>> {
+        const requestOptions = await this.createDeploymentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DeploymentDetailsFromJSON(jsonValue));
+    }
+
+    /**
+     * When the daemon has orchestration wired (service manager, proxy, overlay), this handler:  1. Parses and validates the spec YAML  2. Stores the deployment with status `Deploying`  3. Spawns an async task that registers services, sets up overlays,     configures the proxy, and scales services  4. Returns immediately with `Deploying` status  5. The async task updates the stored status to `Running` or `Failed`  Without orchestration wired, it stores the spec with `Pending` status.  # Errors  Returns an error if the spec is invalid or storage fails.
+     * Create a new deployment.
+     */
+    async createDeployment(requestParameters: CreateDeploymentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeploymentDetails> {
+        const response = await this.createDeploymentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for deleteDeployment without sending the request
+     */
+    async deleteDeploymentRequestOpts(requestParameters: DeleteDeploymentRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['name'] == null) {
+            throw new runtime.RequiredError(
+                'name',
+                'Required parameter "name" was null or undefined when calling deleteDeployment().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer_auth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/deployments/{name}`;
+        urlPath = urlPath.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters['name'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * # Errors  Returns an error if the deployment is not found, storage access fails, or teardown encounters critical failures.
+     * Delete a deployment.
+     */
+    async deleteDeploymentRaw(requestParameters: DeleteDeploymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteDeploymentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * # Errors  Returns an error if the deployment is not found, storage access fails, or teardown encounters critical failures.
+     * Delete a deployment.
+     */
+    async deleteDeployment(requestParameters: DeleteDeploymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteDeploymentRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getDeployment without sending the request
+     */
+    async getDeploymentRequestOpts(requestParameters: GetDeploymentRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['name'] == null) {
+            throw new runtime.RequiredError(
+                'name',
+                'Required parameter "name" was null or undefined when calling getDeployment().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer_auth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/deployments/{name}`;
+        urlPath = urlPath.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters['name'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * # Errors  Returns an error if the deployment is not found or storage access fails.
+     * Get deployment details (with live per-service health when available).
+     */
+    async getDeploymentRaw(requestParameters: GetDeploymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeploymentDetails>> {
+        const requestOptions = await this.getDeploymentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DeploymentDetailsFromJSON(jsonValue));
+    }
+
+    /**
+     * # Errors  Returns an error if the deployment is not found or storage access fails.
+     * Get deployment details (with live per-service health when available).
+     */
+    async getDeployment(requestParameters: GetDeploymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeploymentDetails> {
+        const response = await this.getDeploymentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listDeployments without sending the request
+     */
+    async listDeploymentsRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer_auth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/deployments`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * # Errors  Returns an error if storage access fails.
+     * List all deployments.
+     */
+    async listDeploymentsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<DeploymentSummary>>> {
+        const requestOptions = await this.listDeploymentsRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(DeploymentSummaryFromJSON));
+    }
+
+    /**
+     * # Errors  Returns an error if storage access fails.
+     * List all deployments.
+     */
+    async listDeployments(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<DeploymentSummary>> {
+        const response = await this.listDeploymentsRaw(initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/EnvironmentsApi.ts

@@ -0,0 +1,339 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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 {
+  CreateEnvironmentRequest,
+  StoredEnvironment,
+  UpdateEnvironmentRequest,
+} from '../models/index';
+import {
+    CreateEnvironmentRequestFromJSON,
+    CreateEnvironmentRequestToJSON,
+    StoredEnvironmentFromJSON,
+    StoredEnvironmentToJSON,
+    UpdateEnvironmentRequestFromJSON,
+    UpdateEnvironmentRequestToJSON,
+} from '../models/index';
+
+export interface CreateEnvironmentOperationRequest {
+    createEnvironmentRequest: CreateEnvironmentRequest;
+}
+
+export interface DeleteEnvironmentRequest {
+    id: string;
+}
+
+export interface GetEnvironmentRequest {
+    id: string;
+}
+
+export interface ListEnvironmentsRequest {
+    project?: string;
+}
+
+export interface UpdateEnvironmentOperationRequest {
+    id: string;
+    updateEnvironmentRequest: UpdateEnvironmentRequest;
+}
+
+/**
+ * 
+ */
+export class EnvironmentsApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for createEnvironment without sending the request
+     */
+    async createEnvironmentRequestOpts(requestParameters: CreateEnvironmentOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['createEnvironmentRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createEnvironmentRequest',
+                'Required parameter "createEnvironmentRequest" was null or undefined when calling createEnvironment().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer_auth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/environments`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateEnvironmentRequestToJSON(requestParameters['createEnvironmentRequest']),
+        };
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::BadRequest`] for an empty name, [`ApiError::Conflict`] when the `(name, project_id)` is already used, or [`ApiError::Internal`] when the environment store fails.
+     * Create a new environment. Admin only.
+     */
+    async createEnvironmentRaw(requestParameters: CreateEnvironmentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StoredEnvironment>> {
+        const requestOptions = await this.createEnvironmentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => StoredEnvironmentFromJSON(jsonValue));
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::BadRequest`] for an empty name, [`ApiError::Conflict`] when the `(name, project_id)` is already used, or [`ApiError::Internal`] when the environment store fails.
+     * Create a new environment. Admin only.
+     */
+    async createEnvironment(requestParameters: CreateEnvironmentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StoredEnvironment> {
+        const response = await this.createEnvironmentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for deleteEnvironment without sending the request
+     */
+    async deleteEnvironmentRequestOpts(requestParameters: DeleteEnvironmentRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling deleteEnvironment().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer_auth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/environments/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Non-cascading: the operator must purge any secrets attached to the environment before deletion (typically via `DELETE /api/v1/secrets?env={id}&all=true`). If the environment still has secrets, this endpoint returns 409.  # Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the environment does not exist, [`ApiError::Conflict`] when secrets remain, or [`ApiError::Internal`] when a backing store fails.
+     * Delete an environment. Admin only.
+     */
+    async deleteEnvironmentRaw(requestParameters: DeleteEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteEnvironmentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Non-cascading: the operator must purge any secrets attached to the environment before deletion (typically via `DELETE /api/v1/secrets?env={id}&all=true`). If the environment still has secrets, this endpoint returns 409.  # Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the environment does not exist, [`ApiError::Conflict`] when secrets remain, or [`ApiError::Internal`] when a backing store fails.
+     * Delete an environment. Admin only.
+     */
+    async deleteEnvironment(requestParameters: DeleteEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteEnvironmentRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getEnvironment without sending the request
+     */
+    async getEnvironmentRequestOpts(requestParameters: GetEnvironmentRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getEnvironment().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer_auth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/environments/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::NotFound`] if no environment with the given id exists, or [`ApiError::Internal`] when the store fails.
+     * Fetch a single environment by id.
+     */
+    async getEnvironmentRaw(requestParameters: GetEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StoredEnvironment>> {
+        const requestOptions = await this.getEnvironmentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => StoredEnvironmentFromJSON(jsonValue));
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::NotFound`] if no environment with the given id exists, or [`ApiError::Internal`] when the store fails.
+     * Fetch a single environment by id.
+     */
+    async getEnvironment(requestParameters: GetEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StoredEnvironment> {
+        const response = await this.getEnvironmentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listEnvironments without sending the request
+     */
+    async listEnvironmentsRequestOpts(requestParameters: ListEnvironmentsRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['project'] != null) {
+            queryParameters['project'] = requestParameters['project'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer_auth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/environments`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Filter rules (see [`ListEnvironmentsQuery`]):  - `?project={id}` → environments belonging to that project. - `?project=*` → every environment across every project + globals,   merged and sorted by name. - no `project` query → only global environments (`project_id IS NULL`).  # Errors  Returns [`ApiError::Internal`] if the environment store fails.
+     * List environments.
+     */
+    async listEnvironmentsRaw(requestParameters: ListEnvironmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<StoredEnvironment>>> {
+        const requestOptions = await this.listEnvironmentsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(StoredEnvironmentFromJSON));
+    }
+
+    /**
+     * Filter rules (see [`ListEnvironmentsQuery`]):  - `?project={id}` → environments belonging to that project. - `?project=*` → every environment across every project + globals,   merged and sorted by name. - no `project` query → only global environments (`project_id IS NULL`).  # Errors  Returns [`ApiError::Internal`] if the environment store fails.
+     * List environments.
+     */
+    async listEnvironments(requestParameters: ListEnvironmentsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<StoredEnvironment>> {
+        const response = await this.listEnvironmentsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for updateEnvironment without sending the request
+     */
+    async updateEnvironmentRequestOpts(requestParameters: UpdateEnvironmentOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling updateEnvironment().'
+            );
+        }
+
+        if (requestParameters['updateEnvironmentRequest'] == null) {
+            throw new runtime.RequiredError(
+                'updateEnvironmentRequest',
+                'Required parameter "updateEnvironmentRequest" was null or undefined when calling updateEnvironment().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer_auth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/environments/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateEnvironmentRequestToJSON(requestParameters['updateEnvironmentRequest']),
+        };
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the environment does not exist, [`ApiError::BadRequest`] for an empty replacement name, [`ApiError::Conflict`] when the new name collides with another environment in the same scope, or [`ApiError::Internal`] when the store fails.
+     * Rename / re-describe an environment. Admin only.
+     */
+    async updateEnvironmentRaw(requestParameters: UpdateEnvironmentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StoredEnvironment>> {
+        const requestOptions = await this.updateEnvironmentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => StoredEnvironmentFromJSON(jsonValue));
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the environment does not exist, [`ApiError::BadRequest`] for an empty replacement name, [`ApiError::Conflict`] when the new name collides with another environment in the same scope, or [`ApiError::Internal`] when the store fails.
+     * Rename / re-describe an environment. Admin only.
+     */
+    async updateEnvironment(requestParameters: UpdateEnvironmentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StoredEnvironment> {
+        const response = await this.updateEnvironmentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}