fulcrum-cem-client 0.0.1

package/src/apis/JobsApi.ts

@@ -0,0 +1,587 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Fulcrum CEM API
+ * A comprehensive cloud infrastructure management system designed to orchestrate and monitor distributed cloud resources across multiple providers, with CEM-specific extensions.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * 
+ *
+ * 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 {
+  CompleteJobRequest,
+  ErrorRes,
+  FailJobRequest,
+  JobRes,
+  MarkJobUnsupportedRequest,
+  UpdateJobRequest,
+} from '../models/index';
+import {
+    CompleteJobRequestFromJSON,
+    CompleteJobRequestToJSON,
+    ErrorResFromJSON,
+    ErrorResToJSON,
+    FailJobRequestFromJSON,
+    FailJobRequestToJSON,
+    JobResFromJSON,
+    JobResToJSON,
+    MarkJobUnsupportedRequestFromJSON,
+    MarkJobUnsupportedRequestToJSON,
+    UpdateJobRequestFromJSON,
+    UpdateJobRequestToJSON,
+} from '../models/index';
+
+export interface ClaimJobRequest {
+    id: string;
+}
+
+export interface CompleteJobOperationRequest {
+    id: string;
+    completeJobRequest: CompleteJobRequest;
+}
+
+export interface FailJobOperationRequest {
+    id: string;
+    failJobRequest: FailJobRequest;
+}
+
+export interface GetJobByIdRequest {
+    id: string;
+}
+
+export interface GetPendingJobsForAgentRequest {
+    limit?: number;
+}
+
+export interface ListJobsRequest {
+    page?: number;
+    pageSize?: number;
+}
+
+export interface MarkJobUnsupportedOperationRequest {
+    id: string;
+    markJobUnsupportedRequest: MarkJobUnsupportedRequest;
+}
+
+export interface UpdateJobOperationRequest {
+    id: string;
+    updateJobRequest: UpdateJobRequest;
+}
+
+/**
+ * JobsApi - interface
+ * 
+ * @export
+ * @interface JobsApiInterface
+ */
+export interface JobsApiInterface {
+    /**
+     * 
+     * @summary Claim a job (for agents only)
+     * @param {string} id The ID of the resource
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof JobsApiInterface
+     */
+    claimJobRaw(requestParameters: ClaimJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Claim a job (for agents only)
+     */
+    claimJob(requestParameters: ClaimJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * 
+     * @summary Complete a job (for agents only)
+     * @param {string} id The ID of the resource
+     * @param {CompleteJobRequest} completeJobRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof JobsApiInterface
+     */
+    completeJobRaw(requestParameters: CompleteJobOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Complete a job (for agents only)
+     */
+    completeJob(requestParameters: CompleteJobOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * 
+     * @summary Fail a job (for agents only)
+     * @param {string} id The ID of the resource
+     * @param {FailJobRequest} failJobRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof JobsApiInterface
+     */
+    failJobRaw(requestParameters: FailJobOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Fail a job (for agents only)
+     */
+    failJob(requestParameters: FailJobOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * 
+     * @summary Get a job by ID
+     * @param {string} id The ID of the resource
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof JobsApiInterface
+     */
+    getJobByIdRaw(requestParameters: GetJobByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobRes>>;
+
+    /**
+     * Get a job by ID
+     */
+    getJobById(requestParameters: GetJobByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobRes>;
+
+    /**
+     * 
+     * @summary Get pending jobs for the current agent
+     * @param {number} [limit] Maximum number of pending jobs to return
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof JobsApiInterface
+     */
+    getPendingJobsForAgentRaw(requestParameters: GetPendingJobsForAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<JobRes>>>;
+
+    /**
+     * Get pending jobs for the current agent
+     */
+    getPendingJobsForAgent(requestParameters: GetPendingJobsForAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<JobRes>>;
+
+    /**
+     * 
+     * @summary List all jobs
+     * @param {number} [page] The page number (1-based)
+     * @param {number} [pageSize] The number of items per page
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof JobsApiInterface
+     */
+    listJobsRaw(requestParameters: ListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<JobRes>>>;
+
+    /**
+     * List all jobs
+     */
+    listJobs(requestParameters: ListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<JobRes>>;
+
+    /**
+     * Marks a job as failed due to an unsupported operation and rolls back the service state. Unlike regular failures, this clears the service\'s target status and properties, rolling back to the previous stable state. Unsupported operations are not retried. 
+     * @summary Mark a job as unsupported
+     * @param {string} id The ID of the resource
+     * @param {MarkJobUnsupportedRequest} markJobUnsupportedRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof JobsApiInterface
+     */
+    markJobUnsupportedRaw(requestParameters: MarkJobUnsupportedOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Marks a job as failed due to an unsupported operation and rolls back the service state. Unlike regular failures, this clears the service\'s target status and properties, rolling back to the previous stable state. Unsupported operations are not retried. 
+     * Mark a job as unsupported
+     */
+    markJobUnsupported(requestParameters: MarkJobUnsupportedOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * 
+     * @summary Update a job (for agents only)
+     * @param {string} id The ID of the resource
+     * @param {UpdateJobRequest} updateJobRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof JobsApiInterface
+     */
+    updateJobRaw(requestParameters: UpdateJobOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobRes>>;
+
+    /**
+     * Update a job (for agents only)
+     */
+    updateJob(requestParameters: UpdateJobOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobRes>;
+
+}
+
+/**
+ * 
+ */
+export class JobsApi extends runtime.BaseAPI implements JobsApiInterface {
+
+    /**
+     * Claim a job (for agents only)
+     */
+    async claimJobRaw(requestParameters: ClaimJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling claimJob().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("BearerAuth", ["agent"]);
+        }
+
+
+        let urlPath = `/jobs/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Claim a job (for agents only)
+     */
+    async claimJob(requestParameters: ClaimJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.claimJobRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Complete a job (for agents only)
+     */
+    async completeJobRaw(requestParameters: CompleteJobOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling completeJob().'
+            );
+        }
+
+        if (requestParameters['completeJobRequest'] == null) {
+            throw new runtime.RequiredError(
+                'completeJobRequest',
+                'Required parameter "completeJobRequest" was null or undefined when calling completeJob().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("BearerAuth", ["agent"]);
+        }
+
+
+        let urlPath = `/jobs/{id}/complete`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CompleteJobRequestToJSON(requestParameters['completeJobRequest']),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Complete a job (for agents only)
+     */
+    async completeJob(requestParameters: CompleteJobOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.completeJobRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Fail a job (for agents only)
+     */
+    async failJobRaw(requestParameters: FailJobOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling failJob().'
+            );
+        }
+
+        if (requestParameters['failJobRequest'] == null) {
+            throw new runtime.RequiredError(
+                'failJobRequest',
+                'Required parameter "failJobRequest" was null or undefined when calling failJob().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("BearerAuth", ["agent"]);
+        }
+
+
+        let urlPath = `/jobs/{id}/fail`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: FailJobRequestToJSON(requestParameters['failJobRequest']),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Fail a job (for agents only)
+     */
+    async failJob(requestParameters: FailJobOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.failJobRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Get a job by ID
+     */
+    async getJobByIdRaw(requestParameters: GetJobByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobRes>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getJobById().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("BearerAuth", []);
+        }
+
+
+        let urlPath = `/jobs/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => JobResFromJSON(jsonValue));
+    }
+
+    /**
+     * Get a job by ID
+     */
+    async getJobById(requestParameters: GetJobByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobRes> {
+        const response = await this.getJobByIdRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get pending jobs for the current agent
+     */
+    async getPendingJobsForAgentRaw(requestParameters: GetPendingJobsForAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<JobRes>>> {
+        const queryParameters: any = {};
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("BearerAuth", ["agent"]);
+        }
+
+
+        let urlPath = `/jobs/pending`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(JobResFromJSON));
+    }
+
+    /**
+     * Get pending jobs for the current agent
+     */
+    async getPendingJobsForAgent(requestParameters: GetPendingJobsForAgentRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<JobRes>> {
+        const response = await this.getPendingJobsForAgentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List all jobs
+     */
+    async listJobsRaw(requestParameters: ListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<JobRes>>> {
+        const queryParameters: any = {};
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['pageSize'] = requestParameters['pageSize'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("BearerAuth", []);
+        }
+
+
+        let urlPath = `/jobs`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(JobResFromJSON));
+    }
+
+    /**
+     * List all jobs
+     */
+    async listJobs(requestParameters: ListJobsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<JobRes>> {
+        const response = await this.listJobsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Marks a job as failed due to an unsupported operation and rolls back the service state. Unlike regular failures, this clears the service\'s target status and properties, rolling back to the previous stable state. Unsupported operations are not retried. 
+     * Mark a job as unsupported
+     */
+    async markJobUnsupportedRaw(requestParameters: MarkJobUnsupportedOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling markJobUnsupported().'
+            );
+        }
+
+        if (requestParameters['markJobUnsupportedRequest'] == null) {
+            throw new runtime.RequiredError(
+                'markJobUnsupportedRequest',
+                'Required parameter "markJobUnsupportedRequest" was null or undefined when calling markJobUnsupported().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("BearerAuth", ["agent"]);
+        }
+
+
+        let urlPath = `/jobs/{id}/unsupported`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: MarkJobUnsupportedRequestToJSON(requestParameters['markJobUnsupportedRequest']),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Marks a job as failed due to an unsupported operation and rolls back the service state. Unlike regular failures, this clears the service\'s target status and properties, rolling back to the previous stable state. Unsupported operations are not retried. 
+     * Mark a job as unsupported
+     */
+    async markJobUnsupported(requestParameters: MarkJobUnsupportedOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.markJobUnsupportedRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Update a job (for agents only)
+     */
+    async updateJobRaw(requestParameters: UpdateJobOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobRes>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling updateJob().'
+            );
+        }
+
+        if (requestParameters['updateJobRequest'] == null) {
+            throw new runtime.RequiredError(
+                'updateJobRequest',
+                'Required parameter "updateJobRequest" was null or undefined when calling updateJob().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("BearerAuth", ["agent"]);
+        }
+
+
+        let urlPath = `/jobs/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateJobRequestToJSON(requestParameters['updateJobRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => JobResFromJSON(jsonValue));
+    }
+
+    /**
+     * Update a job (for agents only)
+     */
+    async updateJob(requestParameters: UpdateJobOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobRes> {
+        const response = await this.updateJobRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}