@cirrobio/api-client 0.9.0 → 0.9.1

package/src/apis/ExecutionApi.ts

@@ -1,359 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * 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,
-  GetExecutionLogsResponse,
-  RunAnalysisRequest,
-  StopExecutionResponse,
-  Task,
-} from '../models/index';
-import {
-    CreateResponseFromJSON,
-    CreateResponseToJSON,
-    GetExecutionLogsResponseFromJSON,
-    GetExecutionLogsResponseToJSON,
-    RunAnalysisRequestFromJSON,
-    RunAnalysisRequestToJSON,
-    StopExecutionResponseFromJSON,
-    StopExecutionResponseToJSON,
-    TaskFromJSON,
-    TaskToJSON,
-} from '../models/index';
-
-export interface GetExecutionLogsRequest {
-    datasetId: string;
-    projectId: string;
-    forceLive?: boolean;
-}
-
-export interface GetProjectSummaryRequest {
-    projectId: string;
-    numberOfDays?: number;
-}
-
-export interface GetTaskLogsRequest {
-    datasetId: string;
-    projectId: string;
-    taskId: string;
-    forceLive?: boolean;
-}
-
-export interface GetTasksForExecutionRequest {
-    datasetId: string;
-    projectId: string;
-    forceLive?: boolean;
-}
-
-export interface RunAnalysisOperationRequest {
-    projectId: string;
-    runAnalysisRequest: RunAnalysisRequest;
-}
-
-export interface StopAnalysisRequest {
-    datasetId: string;
-    projectId: string;
-}
-
-/**
- * 
- */
-export class ExecutionApi extends runtime.BaseAPI {
-
-    /**
-     * Gets live logs from main execution task
-     * Get execution logs
-     */
-    async getExecutionLogsRaw(requestParameters: GetExecutionLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetExecutionLogsResponse>> {
-        if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
-            throw new runtime.RequiredError('datasetId','Required parameter requestParameters.datasetId was null or undefined when calling getExecutionLogs.');
-        }
-
-        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
-            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling getExecutionLogs.');
-        }
-
-        const queryParameters: any = {};
-
-        if (requestParameters.forceLive !== undefined) {
-            queryParameters['forceLive'] = requestParameters.forceLive;
-        }
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("accessToken", []);
-
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/projects/{projectId}/execution/{datasetId}/logs`.replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters.datasetId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => GetExecutionLogsResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Gets live logs from main execution task
-     * Get execution logs
-     */
-    async getExecutionLogs(requestParameters: GetExecutionLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetExecutionLogsResponse> {
-        const response = await this.getExecutionLogsRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Gets an overview of the executions currently running in the project
-     * Get execution summary
-     */
-    async getProjectSummaryRaw(requestParameters: GetProjectSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{ [key: string]: Array<Task>; }>> {
-        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
-            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling getProjectSummary.');
-        }
-
-        const queryParameters: any = {};
-
-        if (requestParameters.numberOfDays !== undefined) {
-            queryParameters['numberOfDays'] = requestParameters.numberOfDays;
-        }
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("accessToken", []);
-
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/projects/{projectId}/execution`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse<any>(response);
-    }
-
-    /**
-     * Gets an overview of the executions currently running in the project
-     * Get execution summary
-     */
-    async getProjectSummary(requestParameters: GetProjectSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{ [key: string]: Array<Task>; }> {
-        const response = await this.getProjectSummaryRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Gets the log output from an individual task
-     * Get task logs
-     */
-    async getTaskLogsRaw(requestParameters: GetTaskLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetExecutionLogsResponse>> {
-        if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
-            throw new runtime.RequiredError('datasetId','Required parameter requestParameters.datasetId was null or undefined when calling getTaskLogs.');
-        }
-
-        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
-            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling getTaskLogs.');
-        }
-
-        if (requestParameters.taskId === null || requestParameters.taskId === undefined) {
-            throw new runtime.RequiredError('taskId','Required parameter requestParameters.taskId was null or undefined when calling getTaskLogs.');
-        }
-
-        const queryParameters: any = {};
-
-        if (requestParameters.forceLive !== undefined) {
-            queryParameters['forceLive'] = requestParameters.forceLive;
-        }
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("accessToken", []);
-
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/projects/{projectId}/execution/{datasetId}/tasks/{taskId}/logs`.replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters.datasetId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"taskId"}}`, encodeURIComponent(String(requestParameters.taskId))),
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => GetExecutionLogsResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Gets the log output from an individual task
-     * Get task logs
-     */
-    async getTaskLogs(requestParameters: GetTaskLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetExecutionLogsResponse> {
-        const response = await this.getTaskLogsRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Gets the tasks submitted by the workflow execution
-     * Get execution tasks
-     */
-    async getTasksForExecutionRaw(requestParameters: GetTasksForExecutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Task>>> {
-        if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
-            throw new runtime.RequiredError('datasetId','Required parameter requestParameters.datasetId was null or undefined when calling getTasksForExecution.');
-        }
-
-        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
-            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling getTasksForExecution.');
-        }
-
-        const queryParameters: any = {};
-
-        if (requestParameters.forceLive !== undefined) {
-            queryParameters['forceLive'] = requestParameters.forceLive;
-        }
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("accessToken", []);
-
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/projects/{projectId}/execution/{datasetId}/tasks`.replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters.datasetId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(TaskFromJSON));
-    }
-
-    /**
-     * Gets the tasks submitted by the workflow execution
-     * Get execution tasks
-     */
-    async getTasksForExecution(requestParameters: GetTasksForExecutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Task>> {
-        const response = await this.getTasksForExecutionRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Run analysis
-     * Run analysis
-     */
-    async runAnalysisRaw(requestParameters: RunAnalysisOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>> {
-        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
-            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling runAnalysis.');
-        }
-
-        if (requestParameters.runAnalysisRequest === null || requestParameters.runAnalysisRequest === undefined) {
-            throw new runtime.RequiredError('runAnalysisRequest','Required parameter requestParameters.runAnalysisRequest was null or undefined when calling runAnalysis.');
-        }
-
-        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("accessToken", []);
-
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/projects/{projectId}/execution`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: RunAnalysisRequestToJSON(requestParameters.runAnalysisRequest),
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => CreateResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Run analysis
-     * Run analysis
-     */
-    async runAnalysis(requestParameters: RunAnalysisOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse> {
-        const response = await this.runAnalysisRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Terminates all analysis jobs related to this execution
-     * Stop execution
-     */
-    async stopAnalysisRaw(requestParameters: StopAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StopExecutionResponse>> {
-        if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
-            throw new runtime.RequiredError('datasetId','Required parameter requestParameters.datasetId was null or undefined when calling stopAnalysis.');
-        }
-
-        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
-            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling stopAnalysis.');
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("accessToken", []);
-
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/projects/{projectId}/execution/{datasetId}/stop`.replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters.datasetId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
-            method: 'PUT',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => StopExecutionResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Terminates all analysis jobs related to this execution
-     * Stop execution
-     */
-    async stopAnalysis(requestParameters: StopAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StopExecutionResponse> {
-        const response = await this.stopAnalysisRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-}

package/src/apis/FileApi.ts

@@ -1,198 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * 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 {
-  AWSCredentials,
-  GenerateSftpCredentialsRequest,
-  GovernanceFileAccessRequest,
-  ProjectFileAccessRequest,
-  SftpCredentials,
-} from '../models/index';
-import {
-    AWSCredentialsFromJSON,
-    AWSCredentialsToJSON,
-    GenerateSftpCredentialsRequestFromJSON,
-    GenerateSftpCredentialsRequestToJSON,
-    GovernanceFileAccessRequestFromJSON,
-    GovernanceFileAccessRequestToJSON,
-    ProjectFileAccessRequestFromJSON,
-    ProjectFileAccessRequestToJSON,
-    SftpCredentialsFromJSON,
-    SftpCredentialsToJSON,
-} from '../models/index';
-
-export interface GenerateGovernanceFileAccessTokenRequest {
-    requirementId: string;
-    governanceFileAccessRequest: GovernanceFileAccessRequest;
-}
-
-export interface GenerateProjectFileAccessTokenRequest {
-    projectId: string;
-    projectFileAccessRequest: ProjectFileAccessRequest;
-}
-
-export interface GenerateProjectSftpTokenRequest {
-    projectId: string;
-    generateSftpCredentialsRequest: GenerateSftpCredentialsRequest;
-}
-
-/**
- * 
- */
-export class FileApi extends runtime.BaseAPI {
-
-    /**
-     * Generates credentials used for connecting via S3
-     * Create governance file access token
-     */
-    async generateGovernanceFileAccessTokenRaw(requestParameters: GenerateGovernanceFileAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AWSCredentials>> {
-        if (requestParameters.requirementId === null || requestParameters.requirementId === undefined) {
-            throw new runtime.RequiredError('requirementId','Required parameter requestParameters.requirementId was null or undefined when calling generateGovernanceFileAccessToken.');
-        }
-
-        if (requestParameters.governanceFileAccessRequest === null || requestParameters.governanceFileAccessRequest === undefined) {
-            throw new runtime.RequiredError('governanceFileAccessRequest','Required parameter requestParameters.governanceFileAccessRequest was null or undefined when calling generateGovernanceFileAccessToken.');
-        }
-
-        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("accessToken", []);
-
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/governance/requirements/{requirementId}/s3-token`.replace(`{${"requirementId"}}`, encodeURIComponent(String(requestParameters.requirementId))),
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: GovernanceFileAccessRequestToJSON(requestParameters.governanceFileAccessRequest),
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => AWSCredentialsFromJSON(jsonValue));
-    }
-
-    /**
-     * Generates credentials used for connecting via S3
-     * Create governance file access token
-     */
-    async generateGovernanceFileAccessToken(requestParameters: GenerateGovernanceFileAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AWSCredentials> {
-        const response = await this.generateGovernanceFileAccessTokenRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Generates credentials used for connecting via S3
-     * Create project file access token
-     */
-    async generateProjectFileAccessTokenRaw(requestParameters: GenerateProjectFileAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AWSCredentials>> {
-        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
-            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling generateProjectFileAccessToken.');
-        }
-
-        if (requestParameters.projectFileAccessRequest === null || requestParameters.projectFileAccessRequest === undefined) {
-            throw new runtime.RequiredError('projectFileAccessRequest','Required parameter requestParameters.projectFileAccessRequest was null or undefined when calling generateProjectFileAccessToken.');
-        }
-
-        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("accessToken", []);
-
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/projects/{projectId}/s3-token`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: ProjectFileAccessRequestToJSON(requestParameters.projectFileAccessRequest),
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => AWSCredentialsFromJSON(jsonValue));
-    }
-
-    /**
-     * Generates credentials used for connecting via S3
-     * Create project file access token
-     */
-    async generateProjectFileAccessToken(requestParameters: GenerateProjectFileAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AWSCredentials> {
-        const response = await this.generateProjectFileAccessTokenRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Generates credentials used for connecting via SFTP
-     * Create project SFTP Token
-     */
-    async generateProjectSftpTokenRaw(requestParameters: GenerateProjectSftpTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SftpCredentials>> {
-        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
-            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling generateProjectSftpToken.');
-        }
-
-        if (requestParameters.generateSftpCredentialsRequest === null || requestParameters.generateSftpCredentialsRequest === undefined) {
-            throw new runtime.RequiredError('generateSftpCredentialsRequest','Required parameter requestParameters.generateSftpCredentialsRequest was null or undefined when calling generateProjectSftpToken.');
-        }
-
-        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("accessToken", []);
-
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/projects/{projectId}/sftp-token`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: GenerateSftpCredentialsRequestToJSON(requestParameters.generateSftpCredentialsRequest),
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => SftpCredentialsFromJSON(jsonValue));
-    }
-
-    /**
-     * Generates credentials used for connecting via SFTP
-     * Create project SFTP Token
-     */
-    async generateProjectSftpToken(requestParameters: GenerateProjectSftpTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SftpCredentials> {
-        const response = await this.generateProjectSftpTokenRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-}