@zlayer/api-client 0.10.86

package/src/apis/ProjectsApi.ts

@@ -0,0 +1,591 @@
+/* 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 {
+  CreateProjectRequest,
+  LinkDeploymentRequest,
+  ProjectPullResponse,
+  StoredProject,
+  UpdateProjectRequest,
+} from '../models/index';
+import {
+    CreateProjectRequestFromJSON,
+    CreateProjectRequestToJSON,
+    LinkDeploymentRequestFromJSON,
+    LinkDeploymentRequestToJSON,
+    ProjectPullResponseFromJSON,
+    ProjectPullResponseToJSON,
+    StoredProjectFromJSON,
+    StoredProjectToJSON,
+    UpdateProjectRequestFromJSON,
+    UpdateProjectRequestToJSON,
+} from '../models/index';
+
+export interface CreateProjectOperationRequest {
+    createProjectRequest: CreateProjectRequest;
+}
+
+export interface DeleteProjectRequest {
+    id: string;
+}
+
+export interface GetProjectRequest {
+    id: string;
+}
+
+export interface LinkProjectDeploymentRequest {
+    id: string;
+    linkDeploymentRequest: LinkDeploymentRequest;
+}
+
+export interface ListProjectDeploymentsRequest {
+    id: string;
+}
+
+export interface PullProjectRequest {
+    id: string;
+}
+
+export interface UnlinkProjectDeploymentRequest {
+    id: string;
+    name: string;
+}
+
+export interface UpdateProjectOperationRequest {
+    id: string;
+    updateProjectRequest: UpdateProjectRequest;
+}
+
+/**
+ * 
+ */
+export class ProjectsApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for createProject without sending the request
+     */
+    async createProjectRequestOpts(requestParameters: CreateProjectOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['createProjectRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createProjectRequest',
+                'Required parameter "createProjectRequest" was null or undefined when calling createProject().'
+            );
+        }
+
+        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/projects`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateProjectRequestToJSON(requestParameters['createProjectRequest']),
+        };
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::BadRequest`] for an empty name, [`ApiError::Conflict`] when the name is already used, or [`ApiError::Internal`] when the project store fails.
+     * Create a new project. Admin only.
+     */
+    async createProjectRaw(requestParameters: CreateProjectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StoredProject>> {
+        const requestOptions = await this.createProjectRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => StoredProjectFromJSON(jsonValue));
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::BadRequest`] for an empty name, [`ApiError::Conflict`] when the name is already used, or [`ApiError::Internal`] when the project store fails.
+     * Create a new project. Admin only.
+     */
+    async createProject(requestParameters: CreateProjectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StoredProject> {
+        const response = await this.createProjectRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for deleteProject without sending the request
+     */
+    async deleteProjectRequestOpts(requestParameters: DeleteProjectRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling deleteProject().'
+            );
+        }
+
+        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/projects/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the project does not exist, or [`ApiError::Internal`] when the store fails.
+     * Delete a project. Admin only. Cascade-removes deployment links.
+     */
+    async deleteProjectRaw(requestParameters: DeleteProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteProjectRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the project does not exist, or [`ApiError::Internal`] when the store fails.
+     * Delete a project. Admin only. Cascade-removes deployment links.
+     */
+    async deleteProject(requestParameters: DeleteProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteProjectRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getProject without sending the request
+     */
+    async getProjectRequestOpts(requestParameters: GetProjectRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getProject().'
+            );
+        }
+
+        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/projects/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::NotFound`] if no project with the given id exists, or [`ApiError::Internal`] when the store fails.
+     * Fetch a single project by id.
+     */
+    async getProjectRaw(requestParameters: GetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StoredProject>> {
+        const requestOptions = await this.getProjectRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => StoredProjectFromJSON(jsonValue));
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::NotFound`] if no project with the given id exists, or [`ApiError::Internal`] when the store fails.
+     * Fetch a single project by id.
+     */
+    async getProject(requestParameters: GetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StoredProject> {
+        const response = await this.getProjectRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for linkProjectDeployment without sending the request
+     */
+    async linkProjectDeploymentRequestOpts(requestParameters: LinkProjectDeploymentRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling linkProjectDeployment().'
+            );
+        }
+
+        if (requestParameters['linkDeploymentRequest'] == null) {
+            throw new runtime.RequiredError(
+                'linkDeploymentRequest',
+                'Required parameter "linkDeploymentRequest" was null or undefined when calling linkProjectDeployment().'
+            );
+        }
+
+        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/projects/{id}/deployments`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: LinkDeploymentRequestToJSON(requestParameters['linkDeploymentRequest']),
+        };
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::NotFound`] when the project does not exist, [`ApiError::BadRequest`] for an empty deployment name, or [`ApiError::Internal`] when the store fails.
+     * Link a deployment to a project.
+     */
+    async linkProjectDeploymentRaw(requestParameters: LinkProjectDeploymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.linkProjectDeploymentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::NotFound`] when the project does not exist, [`ApiError::BadRequest`] for an empty deployment name, or [`ApiError::Internal`] when the store fails.
+     * Link a deployment to a project.
+     */
+    async linkProjectDeployment(requestParameters: LinkProjectDeploymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.linkProjectDeploymentRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for listProjectDeployments without sending the request
+     */
+    async listProjectDeploymentsRequestOpts(requestParameters: ListProjectDeploymentsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling listProjectDeployments().'
+            );
+        }
+
+        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/projects/{id}/deployments`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::NotFound`] when the project does not exist, or [`ApiError::Internal`] when the store fails.
+     * List deployment names linked to a project.
+     */
+    async listProjectDeploymentsRaw(requestParameters: ListProjectDeploymentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>> {
+        const requestOptions = await this.listProjectDeploymentsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse<any>(response);
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::NotFound`] when the project does not exist, or [`ApiError::Internal`] when the store fails.
+     * List deployment names linked to a project.
+     */
+    async listProjectDeployments(requestParameters: ListProjectDeploymentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>> {
+        const response = await this.listProjectDeploymentsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listProjects without sending the request
+     */
+    async listProjectsRequestOpts(): 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/projects`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Any authenticated user can list projects.  # Errors  Returns [`ApiError::Internal`] if the project store fails.
+     * List all projects.
+     */
+    async listProjectsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<StoredProject>>> {
+        const requestOptions = await this.listProjectsRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(StoredProjectFromJSON));
+    }
+
+    /**
+     * Any authenticated user can list projects.  # Errors  Returns [`ApiError::Internal`] if the project store fails.
+     * List all projects.
+     */
+    async listProjects(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<StoredProject>> {
+        const response = await this.listProjectsRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for pullProject without sending the request
+     */
+    async pullProjectRequestOpts(requestParameters: PullProjectRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling pullProject().'
+            );
+        }
+
+        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/projects/{id}/pull`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Authentication is resolved from `git_credential_id`: when set, the matching [`GitCredential`](zlayer_secrets::GitCredential) is looked up in the [`GitCredentialStore`](zlayer_secrets::GitCredentialStore) and its kind determines whether we build a PAT or SSH auth config. When the project has no credential id, or the state has no git credential store attached, we fall back to anonymous auth.  Admin only.  # Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the project does not exist, [`ApiError::BadRequest`] when the project has no `git_url` or its `git_credential_id` cannot be resolved, or [`ApiError::Internal`] on any underlying git / credential store failure.
+     * Clone the project\'s git repository (or fast-forward pull if the working copy already exists) into `{clone_root}/{project_id}` and return the resulting HEAD SHA.
+     */
+    async pullProjectRaw(requestParameters: PullProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectPullResponse>> {
+        const requestOptions = await this.pullProjectRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ProjectPullResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Authentication is resolved from `git_credential_id`: when set, the matching [`GitCredential`](zlayer_secrets::GitCredential) is looked up in the [`GitCredentialStore`](zlayer_secrets::GitCredentialStore) and its kind determines whether we build a PAT or SSH auth config. When the project has no credential id, or the state has no git credential store attached, we fall back to anonymous auth.  Admin only.  # Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the project does not exist, [`ApiError::BadRequest`] when the project has no `git_url` or its `git_credential_id` cannot be resolved, or [`ApiError::Internal`] on any underlying git / credential store failure.
+     * Clone the project\'s git repository (or fast-forward pull if the working copy already exists) into `{clone_root}/{project_id}` and return the resulting HEAD SHA.
+     */
+    async pullProject(requestParameters: PullProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectPullResponse> {
+        const response = await this.pullProjectRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for unlinkProjectDeployment without sending the request
+     */
+    async unlinkProjectDeploymentRequestOpts(requestParameters: UnlinkProjectDeploymentRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling unlinkProjectDeployment().'
+            );
+        }
+
+        if (requestParameters['name'] == null) {
+            throw new runtime.RequiredError(
+                'name',
+                'Required parameter "name" was null or undefined when calling unlinkProjectDeployment().'
+            );
+        }
+
+        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/projects/{id}/deployments/{name}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        urlPath = urlPath.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters['name'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::NotFound`] when the project or link does not exist, or [`ApiError::Internal`] when the store fails.
+     * Unlink a deployment from a project.
+     */
+    async unlinkProjectDeploymentRaw(requestParameters: UnlinkProjectDeploymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.unlinkProjectDeploymentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::NotFound`] when the project or link does not exist, or [`ApiError::Internal`] when the store fails.
+     * Unlink a deployment from a project.
+     */
+    async unlinkProjectDeployment(requestParameters: UnlinkProjectDeploymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.unlinkProjectDeploymentRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for updateProject without sending the request
+     */
+    async updateProjectRequestOpts(requestParameters: UpdateProjectOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling updateProject().'
+            );
+        }
+
+        if (requestParameters['updateProjectRequest'] == null) {
+            throw new runtime.RequiredError(
+                'updateProjectRequest',
+                'Required parameter "updateProjectRequest" was null or undefined when calling updateProject().'
+            );
+        }
+
+        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/projects/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateProjectRequestToJSON(requestParameters['updateProjectRequest']),
+        };
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the project does not exist, [`ApiError::BadRequest`] for an empty replacement name, [`ApiError::Conflict`] when the new name collides, or [`ApiError::Internal`] when the store fails.
+     * Update a project. Admin only.
+     */
+    async updateProjectRaw(requestParameters: UpdateProjectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StoredProject>> {
+        const requestOptions = await this.updateProjectRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => StoredProjectFromJSON(jsonValue));
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the project does not exist, [`ApiError::BadRequest`] for an empty replacement name, [`ApiError::Conflict`] when the new name collides, or [`ApiError::Internal`] when the store fails.
+     * Update a project. Admin only.
+     */
+    async updateProject(requestParameters: UpdateProjectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StoredProject> {
+        const response = await this.updateProjectRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}