fulcrum-cem-client 0.0.2 → 0.0.3

package/dist/apis/JobsApi.d.ts

@@ -2,7 +2,7 @@
  * 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.2
+ * The version of the OpenAPI document: 0.0.3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,35 +10,27 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CompleteJobRequest, FailJobRequest, JobRes, MarkJobUnsupportedRequest, UpdateJobRequest } from '../models/index';
-export interface ClaimJobRequest {
+import type { CompleteJobReq, FailJobReq, JobRes, JobsList200Response } from '../models/index';
+export interface JobsClaimRequest {
     id: string;
 }
-export interface CompleteJobOperationRequest {
+export interface JobsCompleteRequest {
     id: string;
-    completeJobRequest: CompleteJobRequest;
+    completeJobReq: CompleteJobReq;
 }
-export interface FailJobOperationRequest {
+export interface JobsFailRequest {
     id: string;
-    failJobRequest: FailJobRequest;
+    failJobReq: FailJobReq;
 }
-export interface GetJobByIdRequest {
+export interface JobsGetRequest {
     id: string;
 }
-export interface GetPendingJobsForAgentRequest {
-    limit?: number;
-}
-export interface ListJobsRequest {
+export interface JobsListRequest {
     page?: number;
     pageSize?: number;
 }
-export interface MarkJobUnsupportedOperationRequest {
-    id: string;
-    markJobUnsupportedRequest: MarkJobUnsupportedRequest;
-}
-export interface UpdateJobOperationRequest {
-    id: string;
-    updateJobRequest: UpdateJobRequest;
+export interface JobsPendingRequest {
+    limit?: number;
 }
 /**
  * JobsApi - interface
@@ -48,184 +40,155 @@ export interface UpdateJobOperationRequest {
  */
 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
+     * Claims a job for processing by the authenticated agent
+     * @summary Claim a job
+     * @param {string} id
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof JobsApiInterface
      */
-    failJobRaw(requestParameters: FailJobOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    jobsClaimRaw(requestParameters: JobsClaimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Fail a job (for agents only)
+     * Claims a job for processing by the authenticated agent
+     * Claim a job
      */
-    failJob(requestParameters: FailJobOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    jobsClaim(requestParameters: JobsClaimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
-     * @summary Get a job by ID
-     * @param {string} id The ID of the resource
+     * Marks a job as completed with results
+     * @summary Complete a job
+     * @param {string} id
+     * @param {CompleteJobReq} completeJobReq
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof JobsApiInterface
      */
-    getJobByIdRaw(requestParameters: GetJobByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobRes>>;
+    jobsCompleteRaw(requestParameters: JobsCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Get a job by ID
+     * Marks a job as completed with results
+     * Complete a job
      */
-    getJobById(requestParameters: GetJobByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobRes>;
+    jobsComplete(requestParameters: JobsCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
-     * @summary Get pending jobs for the current agent
-     * @param {number} [limit] Maximum number of pending jobs to return
+     * Marks a job as failed with an error message
+     * @summary Fail a job
+     * @param {string} id
+     * @param {FailJobReq} failJobReq
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof JobsApiInterface
      */
-    getPendingJobsForAgentRaw(requestParameters: GetPendingJobsForAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<JobRes>>>;
+    jobsFailRaw(requestParameters: JobsFailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Get pending jobs for the current agent
+     * Marks a job as failed with an error message
+     * Fail a job
      */
-    getPendingJobsForAgent(requestParameters: GetPendingJobsForAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<JobRes>>;
+    jobsFail(requestParameters: JobsFailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
-     * @summary List all jobs
-     * @param {number} [page] The page number (1-based)
-     * @param {number} [pageSize] The number of items per page
+     * Retrieves a specific job by ID (admin route)
+     * @summary Get a job
+     * @param {string} id
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof JobsApiInterface
      */
-    listJobsRaw(requestParameters: ListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<JobRes>>>;
+    jobsGetRaw(requestParameters: JobsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobRes>>;
     /**
-     * List all jobs
+     * Retrieves a specific job by ID (admin route)
+     * Get a job
      */
-    listJobs(requestParameters: ListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<JobRes>>;
+    jobsGet(requestParameters: JobsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<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
+     * Retrieves a paginated list of jobs (admin route)
+     * @summary List jobs
+     * @param {number} [page]
+     * @param {number} [pageSize]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof JobsApiInterface
      */
-    markJobUnsupportedRaw(requestParameters: MarkJobUnsupportedOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    jobsListRaw(requestParameters: JobsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobsList200Response>>;
     /**
-     * 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
+     * Retrieves a paginated list of jobs (admin route)
+     * List jobs
      */
-    markJobUnsupported(requestParameters: MarkJobUnsupportedOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    jobsList(requestParameters: JobsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobsList200Response>;
     /**
-     *
-     * @summary Update a job (for agents only)
-     * @param {string} id The ID of the resource
-     * @param {UpdateJobRequest} updateJobRequest
+     * Retrieves a list of pending jobs for the authenticated agent
+     * @summary Get pending jobs
+     * @param {number} [limit]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof JobsApiInterface
      */
-    updateJobRaw(requestParameters: UpdateJobOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobRes>>;
+    jobsPendingRaw(requestParameters: JobsPendingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<JobRes>>>;
     /**
-     * Update a job (for agents only)
+     * Retrieves a list of pending jobs for the authenticated agent
+     * Get pending jobs
      */
-    updateJob(requestParameters: UpdateJobOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobRes>;
+    jobsPending(requestParameters: JobsPendingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<JobRes>>;
 }
 /**
  *
  */
 export declare class JobsApi extends runtime.BaseAPI implements JobsApiInterface {
     /**
-     * Claim a job (for agents only)
-     */
-    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>;
-    /**
-     * Complete a job (for agents only)
-     */
-    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>;
-    /**
-     * Fail a job (for agents only)
+     * Claims a job for processing by the authenticated agent
+     * Claim a job
      */
-    failJobRaw(requestParameters: FailJobOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    jobsClaimRaw(requestParameters: JobsClaimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Fail a job (for agents only)
+     * Claims a job for processing by the authenticated agent
+     * Claim a job
      */
-    failJob(requestParameters: FailJobOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    jobsClaim(requestParameters: JobsClaimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Get a job by ID
+     * Marks a job as completed with results
+     * Complete a job
      */
-    getJobByIdRaw(requestParameters: GetJobByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobRes>>;
+    jobsCompleteRaw(requestParameters: JobsCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Get a job by ID
+     * Marks a job as completed with results
+     * Complete a job
      */
-    getJobById(requestParameters: GetJobByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobRes>;
+    jobsComplete(requestParameters: JobsCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Get pending jobs for the current agent
+     * Marks a job as failed with an error message
+     * Fail a job
      */
-    getPendingJobsForAgentRaw(requestParameters: GetPendingJobsForAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<JobRes>>>;
+    jobsFailRaw(requestParameters: JobsFailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Get pending jobs for the current agent
+     * Marks a job as failed with an error message
+     * Fail a job
      */
-    getPendingJobsForAgent(requestParameters?: GetPendingJobsForAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<JobRes>>;
+    jobsFail(requestParameters: JobsFailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * List all jobs
+     * Retrieves a specific job by ID (admin route)
+     * Get a job
      */
-    listJobsRaw(requestParameters: ListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<JobRes>>>;
+    jobsGetRaw(requestParameters: JobsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobRes>>;
     /**
-     * List all jobs
+     * Retrieves a specific job by ID (admin route)
+     * Get a job
      */
-    listJobs(requestParameters?: ListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<JobRes>>;
+    jobsGet(requestParameters: JobsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<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.
-     * Mark a job as unsupported
+     * Retrieves a paginated list of jobs (admin route)
+     * List jobs
      */
-    markJobUnsupportedRaw(requestParameters: MarkJobUnsupportedOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    jobsListRaw(requestParameters: JobsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobsList200Response>>;
     /**
-     * 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
+     * Retrieves a paginated list of jobs (admin route)
+     * List jobs
      */
-    markJobUnsupported(requestParameters: MarkJobUnsupportedOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    jobsList(requestParameters?: JobsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobsList200Response>;
     /**
-     * Update a job (for agents only)
+     * Retrieves a list of pending jobs for the authenticated agent
+     * Get pending jobs
      */
-    updateJobRaw(requestParameters: UpdateJobOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobRes>>;
+    jobsPendingRaw(requestParameters: JobsPendingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<JobRes>>>;
     /**
-     * Update a job (for agents only)
+     * Retrieves a list of pending jobs for the authenticated agent
+     * Get pending jobs
      */
-    updateJob(requestParameters: UpdateJobOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobRes>;
+    jobsPending(requestParameters?: JobsPendingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<JobRes>>;
 }