@zlayer/api-client 0.10.86

package/src/apis/WorkflowsApi.ts

@@ -0,0 +1,379 @@
+/* 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 {
+  CreateWorkflowRequest,
+  StoredWorkflow,
+  WorkflowRun,
+} from '../models/index';
+import {
+    CreateWorkflowRequestFromJSON,
+    CreateWorkflowRequestToJSON,
+    StoredWorkflowFromJSON,
+    StoredWorkflowToJSON,
+    WorkflowRunFromJSON,
+    WorkflowRunToJSON,
+} from '../models/index';
+
+export interface CreateWorkflowOperationRequest {
+    createWorkflowRequest: CreateWorkflowRequest;
+}
+
+export interface DeleteWorkflowRequest {
+    id: string;
+}
+
+export interface GetWorkflowRequest {
+    id: string;
+}
+
+export interface ListWorkflowRunsRequest {
+    id: string;
+}
+
+export interface RunWorkflowRequest {
+    id: string;
+}
+
+/**
+ * 
+ */
+export class WorkflowsApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for createWorkflow without sending the request
+     */
+    async createWorkflowRequestOpts(requestParameters: CreateWorkflowOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['createWorkflowRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createWorkflowRequest',
+                'Required parameter "createWorkflowRequest" was null or undefined when calling createWorkflow().'
+            );
+        }
+
+        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/workflows`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateWorkflowRequestToJSON(requestParameters['createWorkflowRequest']),
+        };
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::BadRequest`] for an empty name or empty steps list, or [`ApiError::Internal`] when the workflow store fails.
+     * Create a new workflow. Admin only.
+     */
+    async createWorkflowRaw(requestParameters: CreateWorkflowOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StoredWorkflow>> {
+        const requestOptions = await this.createWorkflowRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => StoredWorkflowFromJSON(jsonValue));
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::BadRequest`] for an empty name or empty steps list, or [`ApiError::Internal`] when the workflow store fails.
+     * Create a new workflow. Admin only.
+     */
+    async createWorkflow(requestParameters: CreateWorkflowOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StoredWorkflow> {
+        const response = await this.createWorkflowRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for deleteWorkflow without sending the request
+     */
+    async deleteWorkflowRequestOpts(requestParameters: DeleteWorkflowRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling deleteWorkflow().'
+            );
+        }
+
+        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/workflows/{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 workflow does not exist, or [`ApiError::Internal`] when the store fails.
+     * Delete a workflow. Admin only.
+     */
+    async deleteWorkflowRaw(requestParameters: DeleteWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteWorkflowRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the workflow does not exist, or [`ApiError::Internal`] when the store fails.
+     * Delete a workflow. Admin only.
+     */
+    async deleteWorkflow(requestParameters: DeleteWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteWorkflowRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getWorkflow without sending the request
+     */
+    async getWorkflowRequestOpts(requestParameters: GetWorkflowRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getWorkflow().'
+            );
+        }
+
+        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/workflows/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::NotFound`] if no workflow with the given id exists, or [`ApiError::Internal`] when the store fails.
+     * Fetch a single workflow by id.
+     */
+    async getWorkflowRaw(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StoredWorkflow>> {
+        const requestOptions = await this.getWorkflowRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => StoredWorkflowFromJSON(jsonValue));
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::NotFound`] if no workflow with the given id exists, or [`ApiError::Internal`] when the store fails.
+     * Fetch a single workflow by id.
+     */
+    async getWorkflow(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StoredWorkflow> {
+        const response = await this.getWorkflowRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listWorkflowRuns without sending the request
+     */
+    async listWorkflowRunsRequestOpts(requestParameters: ListWorkflowRunsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling listWorkflowRuns().'
+            );
+        }
+
+        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/workflows/{id}/runs`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::NotFound`] if the workflow does not exist, or [`ApiError::Internal`] when the store fails.
+     * List past runs for a workflow, most recent first.
+     */
+    async listWorkflowRunsRaw(requestParameters: ListWorkflowRunsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<WorkflowRun>>> {
+        const requestOptions = await this.listWorkflowRunsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(WorkflowRunFromJSON));
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::NotFound`] if the workflow does not exist, or [`ApiError::Internal`] when the store fails.
+     * List past runs for a workflow, most recent first.
+     */
+    async listWorkflowRuns(requestParameters: ListWorkflowRunsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<WorkflowRun>> {
+        const response = await this.listWorkflowRunsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listWorkflows without sending the request
+     */
+    async listWorkflowsRequestOpts(): 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/workflows`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Internal`] if the workflow store fails.
+     * List workflows.
+     */
+    async listWorkflowsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<StoredWorkflow>>> {
+        const requestOptions = await this.listWorkflowsRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(StoredWorkflowFromJSON));
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Internal`] if the workflow store fails.
+     * List workflows.
+     */
+    async listWorkflows(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<StoredWorkflow>> {
+        const response = await this.listWorkflowsRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for runWorkflow without sending the request
+     */
+    async runWorkflowRequestOpts(requestParameters: RunWorkflowRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling runWorkflow().'
+            );
+        }
+
+        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/workflows/{id}/run`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Iterates steps sequentially: - `RunTask` — looks up the task and executes its `body` via `sh -c`. - `BuildProject` — clones / fast-forwards the project\'s git repo, then   registers and awaits a real buildah build. - `DeployProject` — reads the project\'s `deploy_spec_path` from its   checked-out working copy, parses it as a `DeploymentSpec`, and upserts   it into the deployment store. - `ApplySync` — delegates to [`apply_sync_inner`] for the real reconcile.  If a step fails and has an `on_failure` handler, that handler runs before the workflow aborts. Subsequent steps are marked `\"skipped\"`.  # Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the workflow does not exist, or [`ApiError::Internal`] when execution or recording fails.
+     * Execute a workflow synchronously. Admin only.
+     */
+    async runWorkflowRaw(requestParameters: RunWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRun>> {
+        const requestOptions = await this.runWorkflowRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowRunFromJSON(jsonValue));
+    }
+
+    /**
+     * Iterates steps sequentially: - `RunTask` — looks up the task and executes its `body` via `sh -c`. - `BuildProject` — clones / fast-forwards the project\'s git repo, then   registers and awaits a real buildah build. - `DeployProject` — reads the project\'s `deploy_spec_path` from its   checked-out working copy, parses it as a `DeploymentSpec`, and upserts   it into the deployment store. - `ApplySync` — delegates to [`apply_sync_inner`] for the real reconcile.  If a step fails and has an `on_failure` handler, that handler runs before the workflow aborts. Subsequent steps are marked `\"skipped\"`.  # Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the workflow does not exist, or [`ApiError::Internal`] when execution or recording fails.
+     * Execute a workflow synchronously. Admin only.
+     */
+    async runWorkflow(requestParameters: RunWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRun> {
+        const response = await this.runWorkflowRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -0,0 +1,34 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './AuditApi';
+export * from './AuthenticationApi';
+export * from './BuildApi';
+export * from './ClusterApi';
+export * from './ContainersApi';
+export * from './CredentialsApi';
+export * from './CronApi';
+export * from './DeploymentsApi';
+export * from './EnvironmentsApi';
+export * from './GroupsApi';
+export * from './HealthApi';
+export * from './ImagesApi';
+export * from './InternalApi';
+export * from './JobsApi';
+export * from './NetworksApi';
+export * from './NodesApi';
+export * from './NotifiersApi';
+export * from './OverlayApi';
+export * from './PermissionsApi';
+export * from './ProjectsApi';
+export * from './ProxyApi';
+export * from './SecretsApi';
+export * from './ServicesApi';
+export * from './StorageApi';
+export * from './SyncsApi';
+export * from './TasksApi';
+export * from './TunnelsApi';
+export * from './UsersApi';
+export * from './VariablesApi';
+export * from './VolumesApi';
+export * from './WebhooksApi';
+export * from './WorkflowsApi';

package/src/index.ts

@@ -0,0 +1,5 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './runtime';
+export * from './apis/index';
+export * from './models/index';

package/src/models/AddMemberRequest.ts

@@ -0,0 +1,66 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * Body for `POST /api/v1/groups/{id}/members`.
+ * @export
+ * @interface AddMemberRequest
+ */
+export interface AddMemberRequest {
+    /**
+     * The user id to add.
+     * @type {string}
+     * @memberof AddMemberRequest
+     */
+    userId: string;
+}
+
+/**
+ * Check if a given object implements the AddMemberRequest interface.
+ */
+export function instanceOfAddMemberRequest(value: object): value is AddMemberRequest {
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    return true;
+}
+
+export function AddMemberRequestFromJSON(json: any): AddMemberRequest {
+    return AddMemberRequestFromJSONTyped(json, false);
+}
+
+export function AddMemberRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddMemberRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'userId': json['user_id'],
+    };
+}
+
+export function AddMemberRequestToJSON(json: any): AddMemberRequest {
+    return AddMemberRequestToJSONTyped(json, false);
+}
+
+export function AddMemberRequestToJSONTyped(value?: AddMemberRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'user_id': value['userId'],
+    };
+}
+

package/src/models/AuditEntry.ts

@@ -0,0 +1,137 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * A recorded audit log entry capturing who did what, when, and to which
+ * resource.
+ * @export
+ * @interface AuditEntry
+ */
+export interface AuditEntry {
+    /**
+     * The action performed (e.g. `"create"`, `"update"`, `"delete"`,
+     * `"execute"`).
+     * @type {string}
+     * @memberof AuditEntry
+     */
+    action: string;
+    /**
+     * When the action occurred.
+     * @type {string}
+     * @memberof AuditEntry
+     */
+    createdAt: string;
+    /**
+     * Additional context as free-form JSON.
+     * @type {object}
+     * @memberof AuditEntry
+     */
+    details?: object | null;
+    /**
+     * UUID identifier of this audit entry.
+     * @type {string}
+     * @memberof AuditEntry
+     */
+    id: string;
+    /**
+     * Client IP address, if known.
+     * @type {string}
+     * @memberof AuditEntry
+     */
+    ip?: string | null;
+    /**
+     * The specific resource id, if applicable.
+     * @type {string}
+     * @memberof AuditEntry
+     */
+    resourceId?: string | null;
+    /**
+     * The kind of resource acted upon (e.g. `"deployment"`, `"user"`,
+     * `"project"`).
+     * @type {string}
+     * @memberof AuditEntry
+     */
+    resourceKind: string;
+    /**
+     * Client user-agent string, if known.
+     * @type {string}
+     * @memberof AuditEntry
+     */
+    userAgent?: string | null;
+    /**
+     * The user who performed the action.
+     * @type {string}
+     * @memberof AuditEntry
+     */
+    userId: string;
+}
+
+/**
+ * Check if a given object implements the AuditEntry interface.
+ */
+export function instanceOfAuditEntry(value: object): value is AuditEntry {
+    if (!('action' in value) || value['action'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('resourceKind' in value) || value['resourceKind'] === undefined) return false;
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    return true;
+}
+
+export function AuditEntryFromJSON(json: any): AuditEntry {
+    return AuditEntryFromJSONTyped(json, false);
+}
+
+export function AuditEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuditEntry {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'action': json['action'],
+        'createdAt': json['created_at'],
+        'details': json['details'] == null ? undefined : json['details'],
+        'id': json['id'],
+        'ip': json['ip'] == null ? undefined : json['ip'],
+        'resourceId': json['resource_id'] == null ? undefined : json['resource_id'],
+        'resourceKind': json['resource_kind'],
+        'userAgent': json['user_agent'] == null ? undefined : json['user_agent'],
+        'userId': json['user_id'],
+    };
+}
+
+export function AuditEntryToJSON(json: any): AuditEntry {
+    return AuditEntryToJSONTyped(json, false);
+}
+
+export function AuditEntryToJSONTyped(value?: AuditEntry | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'action': value['action'],
+        'created_at': value['createdAt'],
+        'details': value['details'],
+        'id': value['id'],
+        'ip': value['ip'],
+        'resource_id': value['resourceId'],
+        'resource_kind': value['resourceKind'],
+        'user_agent': value['userAgent'],
+        'user_id': value['userId'],
+    };
+}
+