@zlayer/api-client 0.10.86

package/src/apis/SyncsApi.ts

@@ -0,0 +1,323 @@
+/* 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 {
+  CreateSyncRequest,
+  StoredSync,
+  SyncApplyResponse,
+  SyncDiffResponse,
+} from '../models/index';
+import {
+    CreateSyncRequestFromJSON,
+    CreateSyncRequestToJSON,
+    StoredSyncFromJSON,
+    StoredSyncToJSON,
+    SyncApplyResponseFromJSON,
+    SyncApplyResponseToJSON,
+    SyncDiffResponseFromJSON,
+    SyncDiffResponseToJSON,
+} from '../models/index';
+
+export interface ApplySyncRequest {
+    id: string;
+}
+
+export interface CreateSyncOperationRequest {
+    createSyncRequest: CreateSyncRequest;
+}
+
+export interface DeleteSyncRequest {
+    id: string;
+}
+
+export interface DiffSyncRequest {
+    id: string;
+}
+
+/**
+ * 
+ */
+export class SyncsApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for applySync without sending the request
+     */
+    async applySyncRequestOpts(requestParameters: ApplySyncRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling applySync().'
+            );
+        }
+
+        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/syncs/{id}/apply`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * For each resource in the manifest directory: - `deployment` YAMLs are parsed, validated, and upserted into the   deployment store. - `job` / `cron` kinds are recorded as skipped with an explanatory message   (standalone job/cron storage does not yet exist; schedule services via   `DeploymentSpec` instead). - Unknown kinds are skipped with `\"unknown kind: {kind}\"`.  If `sync.delete_missing` is `true`, deployments present in the store but absent from the manifest directory are deleted. Otherwise deletions are recorded as skipped with reason `\"delete_missing=false\"`.  On success the sync\'s `last_applied_sha` is refreshed from the current checkout and persisted.  # Errors  Returns [`ApiError::NotFound`] if the sync id does not exist, or [`ApiError::Internal`] if scanning fails.
+     * Apply a sync — real reconcile against the API.
+     */
+    async applySyncRaw(requestParameters: ApplySyncRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SyncApplyResponse>> {
+        const requestOptions = await this.applySyncRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SyncApplyResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * For each resource in the manifest directory: - `deployment` YAMLs are parsed, validated, and upserted into the   deployment store. - `job` / `cron` kinds are recorded as skipped with an explanatory message   (standalone job/cron storage does not yet exist; schedule services via   `DeploymentSpec` instead). - Unknown kinds are skipped with `\"unknown kind: {kind}\"`.  If `sync.delete_missing` is `true`, deployments present in the store but absent from the manifest directory are deleted. Otherwise deletions are recorded as skipped with reason `\"delete_missing=false\"`.  On success the sync\'s `last_applied_sha` is refreshed from the current checkout and persisted.  # Errors  Returns [`ApiError::NotFound`] if the sync id does not exist, or [`ApiError::Internal`] if scanning fails.
+     * Apply a sync — real reconcile against the API.
+     */
+    async applySync(requestParameters: ApplySyncRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SyncApplyResponse> {
+        const response = await this.applySyncRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for createSync without sending the request
+     */
+    async createSyncRequestOpts(requestParameters: CreateSyncOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['createSyncRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createSyncRequest',
+                'Required parameter "createSyncRequest" was null or undefined when calling createSync().'
+            );
+        }
+
+        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/syncs`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateSyncRequestToJSON(requestParameters['createSyncRequest']),
+        };
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Validation`] if required fields are missing, or [`ApiError::Conflict`] if a sync with the same name already exists.
+     * Create a new sync.
+     */
+    async createSyncRaw(requestParameters: CreateSyncOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StoredSync>> {
+        const requestOptions = await this.createSyncRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => StoredSyncFromJSON(jsonValue));
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Validation`] if required fields are missing, or [`ApiError::Conflict`] if a sync with the same name already exists.
+     * Create a new sync.
+     */
+    async createSync(requestParameters: CreateSyncOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StoredSync> {
+        const response = await this.createSyncRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for deleteSync without sending the request
+     */
+    async deleteSyncRequestOpts(requestParameters: DeleteSyncRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling deleteSync().'
+            );
+        }
+
+        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/syncs/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::NotFound`] if the sync id does not exist, or [`ApiError::Internal`] if the store operation fails.
+     * Delete a sync.
+     */
+    async deleteSyncRaw(requestParameters: DeleteSyncRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteSyncRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::NotFound`] if the sync id does not exist, or [`ApiError::Internal`] if the store operation fails.
+     * Delete a sync.
+     */
+    async deleteSync(requestParameters: DeleteSyncRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteSyncRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for diffSync without sending the request
+     */
+    async diffSyncRequestOpts(requestParameters: DiffSyncRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling diffSync().'
+            );
+        }
+
+        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/syncs/{id}/diff`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::NotFound`] if the sync id does not exist, or [`ApiError::Internal`] if scanning fails.
+     * Compute a diff for a sync (scan git path vs. remote resources).
+     */
+    async diffSyncRaw(requestParameters: DiffSyncRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SyncDiffResponse>> {
+        const requestOptions = await this.diffSyncRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SyncDiffResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::NotFound`] if the sync id does not exist, or [`ApiError::Internal`] if scanning fails.
+     * Compute a diff for a sync (scan git path vs. remote resources).
+     */
+    async diffSync(requestParameters: DiffSyncRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SyncDiffResponse> {
+        const response = await this.diffSyncRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listSyncs without sending the request
+     */
+    async listSyncsRequestOpts(): 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/syncs`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Internal`] if the sync store fails.
+     * List all syncs.
+     */
+    async listSyncsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<StoredSync>>> {
+        const requestOptions = await this.listSyncsRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(StoredSyncFromJSON));
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Internal`] if the sync store fails.
+     * List all syncs.
+     */
+    async listSyncs(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<StoredSync>> {
+        const response = await this.listSyncsRaw(initOverrides);
+        return await response.value();
+    }
+
+}