@cirrobio/api-client 0.1.10 → 0.1.11

package/dist/apis/ProcessesApi.d.ts

@@ -1,124 +1,138 @@
-/**
- * Cirro Data
- * Cirro Data Platform service API
- *
- * The version of the OpenAPI document: latest
- * Contact: support@cirro.bio
- *
- * 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 { CreateResponse, CustomPipelineSettings, FileRequirements, FormSchema, Process, ProcessDetail, ValidateFileRequirementsRequest } from '../models/index';
-export interface ArchiveCustomProcessRequest {
-    processId: string;
-}
-export interface CreateCustomProcessRequest {
-    processDetail: ProcessDetail;
-}
-export interface GetProcessRequest {
-    processId: string;
-}
-export interface GetProcessParametersRequest {
-    processId: string;
-}
-export interface GetProcessesRequest {
-    includeArchived?: boolean;
-}
-export interface SyncCustomProcessRequest {
-    processId: string;
-}
-export interface UpdateCustomProcessRequest {
-    processId: string;
-    processDetail: ProcessDetail;
-}
-export interface ValidateFileRequirementsOperationRequest {
-    processId: string;
-    validateFileRequirementsRequest: ValidateFileRequirementsRequest;
-}
-/**
- *
- */
-export declare class ProcessesApi extends runtime.BaseAPI {
-    /**
-     * Removes the process from the list of available options
-     * Archive custom process
-     */
-    archiveCustomProcessRaw(requestParameters: ArchiveCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Removes the process from the list of available options
-     * Archive custom process
-     */
-    archiveCustomProcess(requestParameters: ArchiveCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Creates a custom data type or pipeline which you can use in the listed projects.
-     * Create custom process
-     */
-    createCustomProcessRaw(requestParameters: CreateCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
-    /**
-     * Creates a custom data type or pipeline which you can use in the listed projects.
-     * Create custom process
-     */
-    createCustomProcess(requestParameters: CreateCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
-    /**
-     * Retrieves detailed information on a process
-     * Get process
-     */
-    getProcessRaw(requestParameters: GetProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessDetail>>;
-    /**
-     * Retrieves detailed information on a process
-     * Get process
-     */
-    getProcess(requestParameters: GetProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessDetail>;
-    /**
-     * Retrieves the input parameters for a process
-     * Get process parameters
-     */
-    getProcessParametersRaw(requestParameters: GetProcessParametersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FormSchema>>;
-    /**
-     * Retrieves the input parameters for a process
-     * Get process parameters
-     */
-    getProcessParameters(requestParameters: GetProcessParametersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FormSchema>;
-    /**
-     * Retrieves a list of available processes
-     * List processes
-     */
-    getProcessesRaw(requestParameters: GetProcessesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Process>>>;
-    /**
-     * Retrieves a list of available processes
-     * List processes
-     */
-    getProcesses(requestParameters?: GetProcessesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Process>>;
-    /**
-     * Updates the process definition from the repository
-     * Sync custom process
-     */
-    syncCustomProcessRaw(requestParameters: SyncCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomPipelineSettings>>;
-    /**
-     * Updates the process definition from the repository
-     * Sync custom process
-     */
-    syncCustomProcess(requestParameters: SyncCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomPipelineSettings>;
-    /**
-     * Updates the custom process
-     * Update custom process
-     */
-    updateCustomProcessRaw(requestParameters: UpdateCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Updates the custom process
-     * Update custom process
-     */
-    updateCustomProcess(requestParameters: UpdateCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Checks the input file names with the expected files for a data type (ingest processes only)
-     * Validate file requirements
-     */
-    validateFileRequirementsRaw(requestParameters: ValidateFileRequirementsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileRequirements>>;
-    /**
-     * Checks the input file names with the expected files for a data type (ingest processes only)
-     * Validate file requirements
-     */
-    validateFileRequirements(requestParameters: ValidateFileRequirementsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileRequirements>;
-}
+/**
+ * Cirro Data
+ * Cirro Data Platform service API
+ *
+ * The version of the OpenAPI document: latest
+ * Contact: support@cirro.bio
+ *
+ * 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 { CreateResponse, CustomPipelineSettings, FileRequirements, FormSchema, PipelineCost, Process, ProcessDetail, ValidateFileRequirementsRequest } from '../models/index';
+export interface ArchiveCustomProcessRequest {
+    processId: string;
+}
+export interface CalculatePipelineCostRequest {
+    processId: string;
+    body: object;
+}
+export interface CreateCustomProcessRequest {
+    processDetail: ProcessDetail;
+}
+export interface GetProcessRequest {
+    processId: string;
+}
+export interface GetProcessParametersRequest {
+    processId: string;
+}
+export interface GetProcessesRequest {
+    includeArchived?: boolean;
+}
+export interface SyncCustomProcessRequest {
+    processId: string;
+}
+export interface UpdateCustomProcessRequest {
+    processId: string;
+    processDetail: ProcessDetail;
+}
+export interface ValidateFileRequirementsOperationRequest {
+    processId: string;
+    validateFileRequirementsRequest: ValidateFileRequirementsRequest;
+}
+/**
+ *
+ */
+export declare class ProcessesApi extends runtime.BaseAPI {
+    /**
+     * Removes the process from the list of available options
+     * Archive custom process
+     */
+    archiveCustomProcessRaw(requestParameters: ArchiveCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Removes the process from the list of available options
+     * Archive custom process
+     */
+    archiveCustomProcess(requestParameters: ArchiveCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retrieves the cost of running the pipeline
+     * Calculate pipeline cost
+     */
+    calculatePipelineCostRaw(requestParameters: CalculatePipelineCostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PipelineCost>>;
+    /**
+     * Retrieves the cost of running the pipeline
+     * Calculate pipeline cost
+     */
+    calculatePipelineCost(requestParameters: CalculatePipelineCostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PipelineCost>;
+    /**
+     * Creates a custom data type or pipeline which you can use in the listed projects.
+     * Create custom process
+     */
+    createCustomProcessRaw(requestParameters: CreateCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
+    /**
+     * Creates a custom data type or pipeline which you can use in the listed projects.
+     * Create custom process
+     */
+    createCustomProcess(requestParameters: CreateCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
+    /**
+     * Retrieves detailed information on a process
+     * Get process
+     */
+    getProcessRaw(requestParameters: GetProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessDetail>>;
+    /**
+     * Retrieves detailed information on a process
+     * Get process
+     */
+    getProcess(requestParameters: GetProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessDetail>;
+    /**
+     * Retrieves the input parameters for a process
+     * Get process parameters
+     */
+    getProcessParametersRaw(requestParameters: GetProcessParametersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FormSchema>>;
+    /**
+     * Retrieves the input parameters for a process
+     * Get process parameters
+     */
+    getProcessParameters(requestParameters: GetProcessParametersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FormSchema>;
+    /**
+     * Retrieves a list of available processes
+     * List processes
+     */
+    getProcessesRaw(requestParameters: GetProcessesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Process>>>;
+    /**
+     * Retrieves a list of available processes
+     * List processes
+     */
+    getProcesses(requestParameters?: GetProcessesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Process>>;
+    /**
+     * Updates the process definition from the repository
+     * Sync custom process
+     */
+    syncCustomProcessRaw(requestParameters: SyncCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomPipelineSettings>>;
+    /**
+     * Updates the process definition from the repository
+     * Sync custom process
+     */
+    syncCustomProcess(requestParameters: SyncCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomPipelineSettings>;
+    /**
+     * Updates the custom process
+     * Update custom process
+     */
+    updateCustomProcessRaw(requestParameters: UpdateCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Updates the custom process
+     * Update custom process
+     */
+    updateCustomProcess(requestParameters: UpdateCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Checks the input file names with the expected files for a data type (ingest processes only)
+     * Validate file requirements
+     */
+    validateFileRequirementsRaw(requestParameters: ValidateFileRequirementsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileRequirements>>;
+    /**
+     * Checks the input file names with the expected files for a data type (ingest processes only)
+     * Validate file requirements
+     */
+    validateFileRequirements(requestParameters: ValidateFileRequirementsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileRequirements>;
+}