@cirrobio/api-client 0.1.10 → 0.1.12

package/src/apis/ProcessesApi.ts

@@ -20,6 +20,7 @@ import type {
   ErrorMessage,
   FileRequirements,
   FormSchema,
+  PipelineCost,
   PortalErrorResponse,
   Process,
   ProcessDetail,
@@ -36,6 +37,8 @@ import {
     FileRequirementsToJSON,
     FormSchemaFromJSON,
     FormSchemaToJSON,
+    PipelineCostFromJSON,
+    PipelineCostToJSON,
     PortalErrorResponseFromJSON,
     PortalErrorResponseToJSON,
     ProcessFromJSON,
@@ -50,6 +53,11 @@ export interface ArchiveCustomProcessRequest {
     processId: string;
 }
 
+export interface CalculatePipelineCostRequest {
+    processId: string;
+    body: object;
+}
+
 export interface CreateCustomProcessRequest {
     processDetail: ProcessDetail;
 }
@@ -124,6 +132,53 @@ export class ProcessesApi extends runtime.BaseAPI {
         await this.archiveCustomProcessRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Retrieves the cost of running the pipeline
+     * Calculate pipeline cost
+     */
+    async calculatePipelineCostRaw(requestParameters: CalculatePipelineCostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PipelineCost>> {
+        if (requestParameters.processId === null || requestParameters.processId === undefined) {
+            throw new runtime.RequiredError('processId','Required parameter requestParameters.processId was null or undefined when calling calculatePipelineCost.');
+        }
+
+        if (requestParameters.body === null || requestParameters.body === undefined) {
+            throw new runtime.RequiredError('body','Required parameter requestParameters.body was null or undefined when calling calculatePipelineCost.');
+        }
+
+        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: `/processes/{processId}/cost`.replace(`{${"processId"}}`, encodeURIComponent(String(requestParameters.processId))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: requestParameters.body as any,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PipelineCostFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves the cost of running the pipeline
+     * Calculate pipeline cost
+     */
+    async calculatePipelineCost(requestParameters: CalculatePipelineCostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PipelineCost> {
+        const response = await this.calculatePipelineCostRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates a custom data type or pipeline which you can use in the listed projects.
      * Create custom process

package/src/apis/ProjectsApi.ts

@@ -15,8 +15,11 @@
 
 import * as runtime from '../runtime';
 import type {
+  ApproveProjectAccessRequest,
+  CreateProjectAccessRequest,
   CreateResponse,
   Project,
+  ProjectAccessRequest,
   ProjectDetail,
   ProjectRequest,
   ProjectUser,
@@ -24,10 +27,16 @@ import type {
   Tag,
 } from '../models/index';
 import {
+    ApproveProjectAccessRequestFromJSON,
+    ApproveProjectAccessRequestToJSON,
+    CreateProjectAccessRequestFromJSON,
+    CreateProjectAccessRequestToJSON,
     CreateResponseFromJSON,
     CreateResponseToJSON,
     ProjectFromJSON,
     ProjectToJSON,
+    ProjectAccessRequestFromJSON,
+    ProjectAccessRequestToJSON,
     ProjectDetailFromJSON,
     ProjectDetailToJSON,
     ProjectRequestFromJSON,
@@ -40,10 +49,31 @@ import {
     TagToJSON,
 } from '../models/index';
 
+export interface ApproveAccessRequestRequest {
+    projectId: string;
+    accessRequestId: string;
+    approveProjectAccessRequest: ApproveProjectAccessRequest;
+}
+
+export interface CreateAccessRequestRequest {
+    projectId: string;
+    createProjectAccessRequest: CreateProjectAccessRequest;
+}
+
 export interface CreateProjectRequest {
     projectRequest: ProjectRequest;
 }
 
+export interface DenyAccessRequestRequest {
+    projectId: string;
+    accessRequestId: string;
+}
+
+export interface GetAccessRequestsRequest {
+    projectId: string;
+    includeClosed?: boolean;
+}
+
 export interface GetProjectRequest {
     projectId: string;
 }
@@ -76,6 +106,103 @@ export interface UpdateProjectTagsRequest {
  */
 export class ProjectsApi extends runtime.BaseAPI {
 
+    /**
+     * Approves an access request for the project
+     * Approve access request
+     */
+    async approveAccessRequestRaw(requestParameters: ApproveAccessRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling approveAccessRequest.');
+        }
+
+        if (requestParameters.accessRequestId === null || requestParameters.accessRequestId === undefined) {
+            throw new runtime.RequiredError('accessRequestId','Required parameter requestParameters.accessRequestId was null or undefined when calling approveAccessRequest.');
+        }
+
+        if (requestParameters.approveProjectAccessRequest === null || requestParameters.approveProjectAccessRequest === undefined) {
+            throw new runtime.RequiredError('approveProjectAccessRequest','Required parameter requestParameters.approveProjectAccessRequest was null or undefined when calling approveAccessRequest.');
+        }
+
+        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}/access-requests/{accessRequestId}:approve`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"accessRequestId"}}`, encodeURIComponent(String(requestParameters.accessRequestId))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ApproveProjectAccessRequestToJSON(requestParameters.approveProjectAccessRequest),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Approves an access request for the project
+     * Approve access request
+     */
+    async approveAccessRequest(requestParameters: ApproveAccessRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.approveAccessRequestRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates an access request for the project
+     * Create access request
+     */
+    async createAccessRequestRaw(requestParameters: CreateAccessRequestRequest, 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 createAccessRequest.');
+        }
+
+        if (requestParameters.createProjectAccessRequest === null || requestParameters.createProjectAccessRequest === undefined) {
+            throw new runtime.RequiredError('createProjectAccessRequest','Required parameter requestParameters.createProjectAccessRequest was null or undefined when calling createAccessRequest.');
+        }
+
+        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}/access-requests`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateProjectAccessRequestToJSON(requestParameters.createProjectAccessRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Creates an access request for the project
+     * Create access request
+     */
+    async createAccessRequest(requestParameters: CreateAccessRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse> {
+        const response = await this.createAccessRequestRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates a project
      * Create project
@@ -119,6 +246,129 @@ export class ProjectsApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Denies an access request for the project
+     * Deny access request
+     */
+    async denyAccessRequestRaw(requestParameters: DenyAccessRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling denyAccessRequest.');
+        }
+
+        if (requestParameters.accessRequestId === null || requestParameters.accessRequestId === undefined) {
+            throw new runtime.RequiredError('accessRequestId','Required parameter requestParameters.accessRequestId was null or undefined when calling denyAccessRequest.');
+        }
+
+        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}/access-requests/{accessRequestId}:deny`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"accessRequestId"}}`, encodeURIComponent(String(requestParameters.accessRequestId))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Denies an access request for the project
+     * Deny access request
+     */
+    async denyAccessRequest(requestParameters: DenyAccessRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.denyAccessRequestRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Gets users who have requested access to the project
+     * Get access requests
+     */
+    async getAccessRequestsRaw(requestParameters: GetAccessRequestsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProjectAccessRequest>>> {
+        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling getAccessRequests.');
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters.includeClosed !== undefined) {
+            queryParameters['includeClosed'] = requestParameters.includeClosed;
+        }
+
+        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}/access-requests`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ProjectAccessRequestFromJSON));
+    }
+
+    /**
+     * Gets users who have requested access to the project
+     * Get access requests
+     */
+    async getAccessRequests(requestParameters: GetAccessRequestsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectAccessRequest>> {
+        const response = await this.getAccessRequestsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Retrieve a list of projects that a user can request access to
+     * Get discoverable projects
+     */
+    async getDiscoverableProjectsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Project>>> {
+        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/discover`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ProjectFromJSON));
+    }
+
+    /**
+     * Retrieve a list of projects that a user can request access to
+     * Get discoverable projects
+     */
+    async getDiscoverableProjects(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Project>> {
+        const response = await this.getDiscoverableProjectsRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Get detailed project information
      * Get project

package/src/models/ApproveAccessRequest.ts

@@ -0,0 +1,73 @@
+/* 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 { exists, mapValues } from '../runtime';
+import type { ProjectRole } from './ProjectRole';
+import {
+    ProjectRoleFromJSON,
+    ProjectRoleFromJSONTyped,
+    ProjectRoleToJSON,
+} from './ProjectRole';
+
+/**
+ * 
+ * @export
+ * @interface ApproveAccessRequest
+ */
+export interface ApproveAccessRequest {
+    /**
+     * 
+     * @type {ProjectRole}
+     * @memberof ApproveAccessRequest
+     */
+    role: ProjectRole;
+}
+
+/**
+ * Check if a given object implements the ApproveAccessRequest interface.
+ */
+export function instanceOfApproveAccessRequest(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "role" in value;
+
+    return isInstance;
+}
+
+export function ApproveAccessRequestFromJSON(json: any): ApproveAccessRequest {
+    return ApproveAccessRequestFromJSONTyped(json, false);
+}
+
+export function ApproveAccessRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApproveAccessRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'role': ProjectRoleFromJSON(json['role']),
+    };
+}
+
+export function ApproveAccessRequestToJSON(value?: ApproveAccessRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'role': ProjectRoleToJSON(value.role),
+    };
+}
+

package/src/models/ApproveProjectAccessRequest.ts

@@ -0,0 +1,73 @@
+/* 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 { exists, mapValues } from '../runtime';
+import type { ProjectRole } from './ProjectRole';
+import {
+    ProjectRoleFromJSON,
+    ProjectRoleFromJSONTyped,
+    ProjectRoleToJSON,
+} from './ProjectRole';
+
+/**
+ * 
+ * @export
+ * @interface ApproveProjectAccessRequest
+ */
+export interface ApproveProjectAccessRequest {
+    /**
+     * 
+     * @type {ProjectRole}
+     * @memberof ApproveProjectAccessRequest
+     */
+    role: ProjectRole;
+}
+
+/**
+ * Check if a given object implements the ApproveProjectAccessRequest interface.
+ */
+export function instanceOfApproveProjectAccessRequest(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "role" in value;
+
+    return isInstance;
+}
+
+export function ApproveProjectAccessRequestFromJSON(json: any): ApproveProjectAccessRequest {
+    return ApproveProjectAccessRequestFromJSONTyped(json, false);
+}
+
+export function ApproveProjectAccessRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApproveProjectAccessRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'role': ProjectRoleFromJSON(json['role']),
+    };
+}
+
+export function ApproveProjectAccessRequestToJSON(value?: ApproveProjectAccessRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'role': ProjectRoleToJSON(value.role),
+    };
+}
+

package/src/models/CreateProjectAccessRequest.ts

@@ -0,0 +1,82 @@
+/* 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 { exists, mapValues } from '../runtime';
+import type { ProjectRole } from './ProjectRole';
+import {
+    ProjectRoleFromJSON,
+    ProjectRoleFromJSONTyped,
+    ProjectRoleToJSON,
+} from './ProjectRole';
+
+/**
+ * 
+ * @export
+ * @interface CreateProjectAccessRequest
+ */
+export interface CreateProjectAccessRequest {
+    /**
+     * 
+     * @type {ProjectRole}
+     * @memberof CreateProjectAccessRequest
+     */
+    role: ProjectRole;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateProjectAccessRequest
+     */
+    message: string;
+}
+
+/**
+ * Check if a given object implements the CreateProjectAccessRequest interface.
+ */
+export function instanceOfCreateProjectAccessRequest(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "role" in value;
+    isInstance = isInstance && "message" in value;
+
+    return isInstance;
+}
+
+export function CreateProjectAccessRequestFromJSON(json: any): CreateProjectAccessRequest {
+    return CreateProjectAccessRequestFromJSONTyped(json, false);
+}
+
+export function CreateProjectAccessRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateProjectAccessRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'role': ProjectRoleFromJSON(json['role']),
+        'message': json['message'],
+    };
+}
+
+export function CreateProjectAccessRequestToJSON(value?: CreateProjectAccessRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'role': ProjectRoleToJSON(value.role),
+        'message': value.message,
+    };
+}
+

package/src/models/PipelineCost.ts

@@ -0,0 +1,81 @@
+/* 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 { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface PipelineCost
+ */
+export interface PipelineCost {
+    /**
+     * The total cost of running the pipeline
+     * @type {number}
+     * @memberof PipelineCost
+     */
+    totalCost?: number | null;
+    /**
+     * Is this an estimate of the cost?
+     * @type {boolean}
+     * @memberof PipelineCost
+     */
+    isEstimate?: boolean;
+    /**
+     * Description of the cost calculation
+     * @type {string}
+     * @memberof PipelineCost
+     */
+    description?: string;
+}
+
+/**
+ * Check if a given object implements the PipelineCost interface.
+ */
+export function instanceOfPipelineCost(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function PipelineCostFromJSON(json: any): PipelineCost {
+    return PipelineCostFromJSONTyped(json, false);
+}
+
+export function PipelineCostFromJSONTyped(json: any, ignoreDiscriminator: boolean): PipelineCost {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'totalCost': !exists(json, 'totalCost') ? undefined : json['totalCost'],
+        'isEstimate': !exists(json, 'isEstimate') ? undefined : json['isEstimate'],
+        'description': !exists(json, 'description') ? undefined : json['description'],
+    };
+}
+
+export function PipelineCostToJSON(value?: PipelineCost | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'totalCost': value.totalCost,
+        'isEstimate': value.isEstimate,
+        'description': value.description,
+    };
+}
+