fulcrum-cem-client 0.0.1

package/src/apis/NotaryJobsApi.ts

@@ -0,0 +1,361 @@
+/* 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 {
+  ErrorRes,
+  NotaryJobRes,
+  SubmitNotaryJobReq,
+} from '../models/index';
+import {
+    ErrorResFromJSON,
+    ErrorResToJSON,
+    NotaryJobResFromJSON,
+    NotaryJobResToJSON,
+    SubmitNotaryJobReqFromJSON,
+    SubmitNotaryJobReqToJSON,
+} from '../models/index';
+
+export interface CancelNotaryJobRequest {
+    id: string;
+}
+
+export interface GetNotaryJobByIdRequest {
+    id: string;
+}
+
+export interface ListNotaryJobsRequest {
+    page?: number;
+    pageSize?: number;
+    serviceOfferingId?: string;
+}
+
+export interface PollNotaryJobRequest {
+    id: string;
+}
+
+export interface SubmitNotaryJobRequest {
+    submitNotaryJobReq: SubmitNotaryJobReq;
+}
+
+/**
+ * NotaryJobsApi - interface
+ * 
+ * @export
+ * @interface NotaryJobsApiInterface
+ */
+export interface NotaryJobsApiInterface {
+    /**
+     * 
+     * @summary Cancel a notary job
+     * @param {string} id The ID of the resource
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotaryJobsApiInterface
+     */
+    cancelNotaryJobRaw(requestParameters: CancelNotaryJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Cancel a notary job
+     */
+    cancelNotaryJob(requestParameters: CancelNotaryJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * 
+     * @summary Get a notary job by ID
+     * @param {string} id The ID of the resource
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotaryJobsApiInterface
+     */
+    getNotaryJobByIdRaw(requestParameters: GetNotaryJobByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NotaryJobRes>>;
+
+    /**
+     * Get a notary job by ID
+     */
+    getNotaryJobById(requestParameters: GetNotaryJobByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NotaryJobRes>;
+
+    /**
+     * 
+     * @summary List all notary jobs
+     * @param {number} [page] The page number (1-based)
+     * @param {number} [pageSize] The number of items per page
+     * @param {string} [serviceOfferingId] Filter by service offering ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotaryJobsApiInterface
+     */
+    listNotaryJobsRaw(requestParameters: ListNotaryJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<NotaryJobRes>>>;
+
+    /**
+     * List all notary jobs
+     */
+    listNotaryJobs(requestParameters: ListNotaryJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<NotaryJobRes>>;
+
+    /**
+     * Manually poll the notary service to update job status
+     * @summary Poll notary job status
+     * @param {string} id The ID of the resource
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotaryJobsApiInterface
+     */
+    pollNotaryJobRaw(requestParameters: PollNotaryJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Manually poll the notary service to update job status
+     * Poll notary job status
+     */
+    pollNotaryJob(requestParameters: PollNotaryJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * 
+     * @summary Submit a file for notarization
+     * @param {SubmitNotaryJobReq} submitNotaryJobReq 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotaryJobsApiInterface
+     */
+    submitNotaryJobRaw(requestParameters: SubmitNotaryJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NotaryJobRes>>;
+
+    /**
+     * Submit a file for notarization
+     */
+    submitNotaryJob(requestParameters: SubmitNotaryJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NotaryJobRes>;
+
+}
+
+/**
+ * 
+ */
+export class NotaryJobsApi extends runtime.BaseAPI implements NotaryJobsApiInterface {
+
+    /**
+     * Cancel a notary job
+     */
+    async cancelNotaryJobRaw(requestParameters: CancelNotaryJobRequest, 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 cancelNotaryJob().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("BearerAuth", []);
+        }
+
+
+        let urlPath = `/notary-jobs/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Cancel a notary job
+     */
+    async cancelNotaryJob(requestParameters: CancelNotaryJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.cancelNotaryJobRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Get a notary job by ID
+     */
+    async getNotaryJobByIdRaw(requestParameters: GetNotaryJobByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NotaryJobRes>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getNotaryJobById().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("BearerAuth", []);
+        }
+
+
+        let urlPath = `/notary-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) => NotaryJobResFromJSON(jsonValue));
+    }
+
+    /**
+     * Get a notary job by ID
+     */
+    async getNotaryJobById(requestParameters: GetNotaryJobByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NotaryJobRes> {
+        const response = await this.getNotaryJobByIdRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List all notary jobs
+     */
+    async listNotaryJobsRaw(requestParameters: ListNotaryJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<NotaryJobRes>>> {
+        const queryParameters: any = {};
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['pageSize'] = requestParameters['pageSize'];
+        }
+
+        if (requestParameters['serviceOfferingId'] != null) {
+            queryParameters['service_offering_id'] = requestParameters['serviceOfferingId'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("BearerAuth", []);
+        }
+
+
+        let urlPath = `/notary-jobs`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(NotaryJobResFromJSON));
+    }
+
+    /**
+     * List all notary jobs
+     */
+    async listNotaryJobs(requestParameters: ListNotaryJobsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<NotaryJobRes>> {
+        const response = await this.listNotaryJobsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Manually poll the notary service to update job status
+     * Poll notary job status
+     */
+    async pollNotaryJobRaw(requestParameters: PollNotaryJobRequest, 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 pollNotaryJob().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("BearerAuth", []);
+        }
+
+
+        let urlPath = `/notary-jobs/{id}/poll`;
+        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);
+    }
+
+    /**
+     * Manually poll the notary service to update job status
+     * Poll notary job status
+     */
+    async pollNotaryJob(requestParameters: PollNotaryJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.pollNotaryJobRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Submit a file for notarization
+     */
+    async submitNotaryJobRaw(requestParameters: SubmitNotaryJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NotaryJobRes>> {
+        if (requestParameters['submitNotaryJobReq'] == null) {
+            throw new runtime.RequiredError(
+                'submitNotaryJobReq',
+                'Required parameter "submitNotaryJobReq" was null or undefined when calling submitNotaryJob().'
+            );
+        }
+
+        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", []);
+        }
+
+
+        let urlPath = `/notary-jobs`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SubmitNotaryJobReqToJSON(requestParameters['submitNotaryJobReq']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => NotaryJobResFromJSON(jsonValue));
+    }
+
+    /**
+     * Submit a file for notarization
+     */
+    async submitNotaryJob(requestParameters: SubmitNotaryJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NotaryJobRes> {
+        const response = await this.submitNotaryJobRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}