@zlayer/api-client 0.10.86

package/dist/apis/PermissionsApi.js

@@ -0,0 +1,158 @@
+"use strict";
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PermissionsApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class PermissionsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for grantPermission without sending the request
+     */
+    grantPermissionRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['grantPermissionRequest'] == null) {
+                throw new runtime.RequiredError('grantPermissionRequest', 'Required parameter "grantPermissionRequest" was null or undefined when calling grantPermission().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/api/v1/permissions`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.GrantPermissionRequestToJSON)(requestParameters['grantPermissionRequest']),
+            };
+        });
+    }
+    /**
+     * # Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::BadRequest`] when required fields are missing, or [`ApiError::Internal`] if the store fails.
+     * Grant a permission. Admin only.
+     */
+    grantPermissionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.grantPermissionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.StoredPermissionFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * # Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::BadRequest`] when required fields are missing, or [`ApiError::Internal`] if the store fails.
+     * Grant a permission. Admin only.
+     */
+    grantPermission(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.grantPermissionRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for listPermissions without sending the request
+     */
+    listPermissionsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['user'] != null) {
+                queryParameters['user'] = requestParameters['user'];
+            }
+            if (requestParameters['group'] != null) {
+                queryParameters['group'] = requestParameters['group'];
+            }
+            const headerParameters = {};
+            let urlPath = `/api/v1/permissions`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Exactly one of `user` or `group` must be provided.  # Errors  Returns [`ApiError::BadRequest`] when neither or both query parameters are provided, or [`ApiError::Internal`] if the store fails.
+     * List permissions for a subject (user or group).
+     */
+    listPermissionsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listPermissionsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.StoredPermissionFromJSON));
+        });
+    }
+    /**
+     * Exactly one of `user` or `group` must be provided.  # Errors  Returns [`ApiError::BadRequest`] when neither or both query parameters are provided, or [`ApiError::Internal`] if the store fails.
+     * List permissions for a subject (user or group).
+     */
+    listPermissions() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.listPermissionsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for revokePermission without sending the request
+     */
+    revokePermissionRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling revokePermission().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/api/v1/permissions/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * # Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::NotFound`] when the permission does not exist, or [`ApiError::Internal`] if the store fails.
+     * Revoke a permission by id. Admin only.
+     */
+    revokePermissionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.revokePermissionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * # Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::NotFound`] when the permission does not exist, or [`ApiError::Internal`] if the store fails.
+     * Revoke a permission by id. Admin only.
+     */
+    revokePermission(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.revokePermissionRaw(requestParameters, initOverrides);
+        });
+    }
+}
+exports.PermissionsApi = PermissionsApi;

package/dist/apis/ProjectsApi.d.ts

@@ -0,0 +1,171 @@
+/**
+ * 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';
+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 declare class ProjectsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createProject without sending the request
+     */
+    createProjectRequestOpts(requestParameters: CreateProjectOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * # 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.
+     */
+    createProjectRaw(requestParameters: CreateProjectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StoredProject>>;
+    /**
+     * # 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.
+     */
+    createProject(requestParameters: CreateProjectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StoredProject>;
+    /**
+     * Creates request options for deleteProject without sending the request
+     */
+    deleteProjectRequestOpts(requestParameters: DeleteProjectRequest): Promise<runtime.RequestOpts>;
+    /**
+     * # 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.
+     */
+    deleteProjectRaw(requestParameters: DeleteProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * # 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.
+     */
+    deleteProject(requestParameters: DeleteProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getProject without sending the request
+     */
+    getProjectRequestOpts(requestParameters: GetProjectRequest): Promise<runtime.RequestOpts>;
+    /**
+     * # 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.
+     */
+    getProjectRaw(requestParameters: GetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StoredProject>>;
+    /**
+     * # 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.
+     */
+    getProject(requestParameters: GetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StoredProject>;
+    /**
+     * Creates request options for linkProjectDeployment without sending the request
+     */
+    linkProjectDeploymentRequestOpts(requestParameters: LinkProjectDeploymentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * # 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.
+     */
+    linkProjectDeploymentRaw(requestParameters: LinkProjectDeploymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * # 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.
+     */
+    linkProjectDeployment(requestParameters: LinkProjectDeploymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listProjectDeployments without sending the request
+     */
+    listProjectDeploymentsRequestOpts(requestParameters: ListProjectDeploymentsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * # Errors  Returns [`ApiError::NotFound`] when the project does not exist, or [`ApiError::Internal`] when the store fails.
+     * List deployment names linked to a project.
+     */
+    listProjectDeploymentsRaw(requestParameters: ListProjectDeploymentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>>;
+    /**
+     * # Errors  Returns [`ApiError::NotFound`] when the project does not exist, or [`ApiError::Internal`] when the store fails.
+     * List deployment names linked to a project.
+     */
+    listProjectDeployments(requestParameters: ListProjectDeploymentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
+    /**
+     * Creates request options for listProjects without sending the request
+     */
+    listProjectsRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Any authenticated user can list projects.  # Errors  Returns [`ApiError::Internal`] if the project store fails.
+     * List all projects.
+     */
+    listProjectsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<StoredProject>>>;
+    /**
+     * Any authenticated user can list projects.  # Errors  Returns [`ApiError::Internal`] if the project store fails.
+     * List all projects.
+     */
+    listProjects(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<StoredProject>>;
+    /**
+     * Creates request options for pullProject without sending the request
+     */
+    pullProjectRequestOpts(requestParameters: PullProjectRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     */
+    pullProjectRaw(requestParameters: PullProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectPullResponse>>;
+    /**
+     * 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.
+     */
+    pullProject(requestParameters: PullProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectPullResponse>;
+    /**
+     * Creates request options for unlinkProjectDeployment without sending the request
+     */
+    unlinkProjectDeploymentRequestOpts(requestParameters: UnlinkProjectDeploymentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * # 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.
+     */
+    unlinkProjectDeploymentRaw(requestParameters: UnlinkProjectDeploymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * # 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.
+     */
+    unlinkProjectDeployment(requestParameters: UnlinkProjectDeploymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for updateProject without sending the request
+     */
+    updateProjectRequestOpts(requestParameters: UpdateProjectOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * # 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.
+     */
+    updateProjectRaw(requestParameters: UpdateProjectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StoredProject>>;
+    /**
+     * # 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.
+     */
+    updateProject(requestParameters: UpdateProjectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StoredProject>;
+}