@cirrobio/api-client 0.0.6-alpha → 0.0.8-alpha

package/dist/models/ProjectUser.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 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 type { ProjectRole } from './ProjectRole';
+/**
+ *
+ * @export
+ * @interface ProjectUser
+ */
+export interface ProjectUser {
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectUser
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectUser
+     */
+    username: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectUser
+     */
+    organization: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectUser
+     */
+    department: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectUser
+     */
+    email: string;
+    /**
+     *
+     * @type {ProjectRole}
+     * @memberof ProjectUser
+     */
+    role: ProjectRole;
+}
+/**
+ * Check if a given object implements the ProjectUser interface.
+ */
+export declare function instanceOfProjectUser(value: object): boolean;
+export declare function ProjectUserFromJSON(json: any): ProjectUser;
+export declare function ProjectUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectUser;
+export declare function ProjectUserToJSON(value?: ProjectUser | null): any;

package/dist/models/ProjectUser.js

@@ -0,0 +1,66 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProjectUserToJSON = exports.ProjectUserFromJSONTyped = exports.ProjectUserFromJSON = exports.instanceOfProjectUser = void 0;
+var ProjectRole_1 = require("./ProjectRole");
+/**
+ * Check if a given object implements the ProjectUser interface.
+ */
+function instanceOfProjectUser(value) {
+    var isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "username" in value;
+    isInstance = isInstance && "organization" in value;
+    isInstance = isInstance && "department" in value;
+    isInstance = isInstance && "email" in value;
+    isInstance = isInstance && "role" in value;
+    return isInstance;
+}
+exports.instanceOfProjectUser = instanceOfProjectUser;
+function ProjectUserFromJSON(json) {
+    return ProjectUserFromJSONTyped(json, false);
+}
+exports.ProjectUserFromJSON = ProjectUserFromJSON;
+function ProjectUserFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'username': json['username'],
+        'organization': json['organization'],
+        'department': json['department'],
+        'email': json['email'],
+        'role': (0, ProjectRole_1.ProjectRoleFromJSON)(json['role']),
+    };
+}
+exports.ProjectUserFromJSONTyped = ProjectUserFromJSONTyped;
+function ProjectUserToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'username': value.username,
+        'organization': value.organization,
+        'department': value.department,
+        'email': value.email,
+        'role': (0, ProjectRole_1.ProjectRoleToJSON)(value.role),
+    };
+}
+exports.ProjectUserToJSON = ProjectUserToJSON;

package/dist/models/Tag.d.ts

@@ -27,6 +27,12 @@ export interface Tag {
      * @memberof Tag
      */
     value: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Tag
+     */
+    editable: boolean;
 }
 /**
  * Check if a given object implements the Tag interface.

package/dist/models/Tag.js

@@ -21,6 +21,7 @@ function instanceOfTag(value) {
     var isInstance = true;
     isInstance = isInstance && "key" in value;
     isInstance = isInstance && "value" in value;
+    isInstance = isInstance && "editable" in value;
     return isInstance;
 }
 exports.instanceOfTag = instanceOfTag;
@@ -35,6 +36,7 @@ function TagFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'key': json['key'],
         'value': json['value'],
+        'editable': json['editable'],
     };
 }
 exports.TagFromJSONTyped = TagFromJSONTyped;
@@ -48,6 +50,7 @@ function TagToJSON(value) {
     return {
         'key': value.key,
         'value': value.value,
+        'editable': value.editable,
     };
 }
 exports.TagToJSON = TagToJSON;

package/dist/models/index.d.ts

@@ -14,6 +14,7 @@ export * from './Executor';
 export * from './FormSchema';
 export * from './GetExecutionLogsResponse';
 export * from './LogEntry';
+export * from './MetricRecord';
 export * from './NotebookInstance';
 export * from './OpenNotebookInstanceResponse';
 export * from './Process';
@@ -24,6 +25,7 @@ export * from './ProjectMetrics';
 export * from './ProjectRequest';
 export * from './ProjectRole';
 export * from './ProjectSettings';
+export * from './ProjectUser';
 export * from './Reference';
 export * from './ReferenceType';
 export * from './Region';

package/dist/models/index.js

@@ -32,6 +32,7 @@ __exportStar(require("./Executor"), exports);
 __exportStar(require("./FormSchema"), exports);
 __exportStar(require("./GetExecutionLogsResponse"), exports);
 __exportStar(require("./LogEntry"), exports);
+__exportStar(require("./MetricRecord"), exports);
 __exportStar(require("./NotebookInstance"), exports);
 __exportStar(require("./OpenNotebookInstanceResponse"), exports);
 __exportStar(require("./Process"), exports);
@@ -42,6 +43,7 @@ __exportStar(require("./ProjectMetrics"), exports);
 __exportStar(require("./ProjectRequest"), exports);
 __exportStar(require("./ProjectRole"), exports);
 __exportStar(require("./ProjectSettings"), exports);
+__exportStar(require("./ProjectUser"), exports);
 __exportStar(require("./Reference"), exports);
 __exportStar(require("./ReferenceType"), exports);
 __exportStar(require("./Region"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cirrobio/api-client",
-  "version": "0.0.6-alpha",
+  "version": "0.0.8-alpha",
   "description": "API client for Cirro",
   "author": "CirroBio",
   "repository": {

package/src/apis/MetricsApi.ts

@@ -31,6 +31,42 @@ export interface GetProjectMetricsRequest {
  */
 export class MetricsApi extends runtime.BaseAPI {
 
+    /**
+     * Retrieves metrics for all projects.
+     * Get all project metrics
+     */
+    async getAllMetricsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProjectMetrics>>> {
+        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: `/metrics`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ProjectMetricsFromJSON));
+    }
+
+    /**
+     * Retrieves metrics for all projects.
+     * Get all project metrics
+     */
+    async getAllMetrics(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectMetrics>> {
+        const response = await this.getAllMetricsRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Retrieves metrics about a project.
      * Get project metrics

package/src/apis/ProjectsApi.ts

@@ -19,6 +19,7 @@ import type {
   Project,
   ProjectDetail,
   ProjectRequest,
+  ProjectUser,
   SetUserProjectRoleRequest,
   Tag,
 } from '../models/index';
@@ -31,6 +32,8 @@ import {
     ProjectDetailToJSON,
     ProjectRequestFromJSON,
     ProjectRequestToJSON,
+    ProjectUserFromJSON,
+    ProjectUserToJSON,
     SetUserProjectRoleRequestFromJSON,
     SetUserProjectRoleRequestToJSON,
     TagFromJSON,
@@ -45,6 +48,10 @@ export interface GetProjectRequest {
     projectId: string;
 }
 
+export interface GetProjectUsersRequest {
+    projectId: string;
+}
+
 export interface SetUserProjectRoleOperationRequest {
     projectId: string;
     username: string;
@@ -149,6 +156,46 @@ export class ProjectsApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Gets users who have access to the project
+     * Get project permissions
+     */
+    async getProjectUsersRaw(requestParameters: GetProjectUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProjectUser>>> {
+        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling getProjectUsers.');
+        }
+
+        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}/permissions`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ProjectUserFromJSON));
+    }
+
+    /**
+     * Gets users who have access to the project
+     * Get project permissions
+     */
+    async getProjectUsers(requestParameters: GetProjectUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectUser>> {
+        const response = await this.getProjectUsersRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Retrieve a list of projects
      * Get projects

package/src/models/BillingMethod.ts

@@ -12,17 +12,16 @@
  * Do not edit the class manually.
  */
 
-
 /**
  * 
  * @export
+ * @enum {string}
  */
-export const BillingMethod = {
-    BudgetNumber: 'BUDGET_NUMBER',
-    PurchaseOrder: 'PURCHASE_ORDER',
-    Credit: 'CREDIT'
-} as const;
-export type BillingMethod = typeof BillingMethod[keyof typeof BillingMethod];
+export enum BillingMethod {
+    BudgetNumber = 'BUDGET_NUMBER',
+    PurchaseOrder = 'PURCHASE_ORDER',
+    Credit = 'CREDIT'
+}
 
 
 export function BillingMethodFromJSON(json: any): BillingMethod {

package/src/models/BudgetPeriod.ts

@@ -12,17 +12,16 @@
  * Do not edit the class manually.
  */
 
-
 /**
  * 
  * @export
+ * @enum {string}
  */
-export const BudgetPeriod = {
-    Annually: 'ANNUALLY',
-    Quarterly: 'QUARTERLY',
-    Monthly: 'MONTHLY'
-} as const;
-export type BudgetPeriod = typeof BudgetPeriod[keyof typeof BudgetPeriod];
+export enum BudgetPeriod {
+    Annually = 'ANNUALLY',
+    Quarterly = 'QUARTERLY',
+    Monthly = 'MONTHLY'
+}
 
 
 export function BudgetPeriodFromJSON(json: any): BudgetPeriod {

package/src/models/CustomerType.ts

@@ -12,18 +12,17 @@
  * Do not edit the class manually.
  */
 
-
 /**
  * 
  * @export
+ * @enum {string}
  */
-export const CustomerType = {
-    Free: 'FREE',
-    Usage: 'USAGE',
-    Marketplace: 'MARKETPLACE',
-    Contract: 'CONTRACT'
-} as const;
-export type CustomerType = typeof CustomerType[keyof typeof CustomerType];
+export enum CustomerType {
+    Free = 'FREE',
+    Usage = 'USAGE',
+    Marketplace = 'MARKETPLACE',
+    Contract = 'CONTRACT'
+}
 
 
 export function CustomerTypeFromJSON(json: any): CustomerType {

package/src/models/DatasetType.ts

@@ -12,16 +12,15 @@
  * Do not edit the class manually.
  */
 
-
 /**
  * 
  * @export
+ * @enum {string}
  */
-export const DatasetType = {
-    Upload: 'UPLOAD',
-    Public: 'PUBLIC'
-} as const;
-export type DatasetType = typeof DatasetType[keyof typeof DatasetType];
+export enum DatasetType {
+    Upload = 'UPLOAD',
+    Public = 'PUBLIC'
+}
 
 
 export function DatasetTypeFromJSON(json: any): DatasetType {

package/src/models/Executor.ts

@@ -12,17 +12,16 @@
  * Do not edit the class manually.
  */
 
-
 /**
  * Process executor
  * @export
+ * @enum {string}
  */
-export const Executor = {
-    Ingest: 'INGEST',
-    Nextflow: 'NEXTFLOW',
-    Cromwell: 'CROMWELL'
-} as const;
-export type Executor = typeof Executor[keyof typeof Executor];
+export enum Executor {
+    Ingest = 'INGEST',
+    Nextflow = 'NEXTFLOW',
+    Cromwell = 'CROMWELL'
+}
 
 
 export function ExecutorFromJSON(json: any): Executor {

package/src/models/MetricRecord.ts

@@ -0,0 +1,83 @@
+/* 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 MetricRecord
+ */
+export interface MetricRecord {
+    /**
+     * 
+     * @type {Date}
+     * @memberof MetricRecord
+     */
+    date: Date;
+    /**
+     * 
+     * @type {string}
+     * @memberof MetricRecord
+     */
+    unit: string;
+    /**
+     * Map of service names to metric value
+     * @type {{ [key: string]: number; }}
+     * @memberof MetricRecord
+     */
+    services?: { [key: string]: number; };
+}
+
+/**
+ * Check if a given object implements the MetricRecord interface.
+ */
+export function instanceOfMetricRecord(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "date" in value;
+    isInstance = isInstance && "unit" in value;
+
+    return isInstance;
+}
+
+export function MetricRecordFromJSON(json: any): MetricRecord {
+    return MetricRecordFromJSONTyped(json, false);
+}
+
+export function MetricRecordFromJSONTyped(json: any, ignoreDiscriminator: boolean): MetricRecord {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'date': (new Date(json['date'])),
+        'unit': json['unit'],
+        'services': !exists(json, 'services') ? undefined : json['services'],
+    };
+}
+
+export function MetricRecordToJSON(value?: MetricRecord | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'date': (value.date.toISOString().substring(0,10)),
+        'unit': value.unit,
+        'services': value.services,
+    };
+}
+

package/src/models/ProjectMetrics.ts

@@ -13,6 +13,13 @@
  */
 
 import { exists, mapValues } from '../runtime';
+import type { MetricRecord } from './MetricRecord';
+import {
+    MetricRecordFromJSON,
+    MetricRecordFromJSONTyped,
+    MetricRecordToJSON,
+} from './MetricRecord';
+
 /**
  * 
  * @export
@@ -27,16 +34,16 @@ export interface ProjectMetrics {
     projectId: string;
     /**
      * Costs by service by month
-     * @type {{ [key: string]: { [key: string]: number; }; }}
+     * @type {Array<MetricRecord>}
      * @memberof ProjectMetrics
      */
-    costs?: { [key: string]: { [key: string]: number; }; };
+    costs?: Array<MetricRecord>;
     /**
      * Storage usage by tier by day
-     * @type {{ [key: string]: any; }}
+     * @type {Array<MetricRecord>}
      * @memberof ProjectMetrics
      */
-    storageMetrics?: { [key: string]: any; };
+    storageMetrics?: Array<MetricRecord>;
 }
 
 /**
@@ -60,8 +67,8 @@ export function ProjectMetricsFromJSONTyped(json: any, ignoreDiscriminator: bool
     return {
         
         'projectId': json['projectId'],
-        'costs': !exists(json, 'costs') ? undefined : json['costs'],
-        'storageMetrics': !exists(json, 'storageMetrics') ? undefined : json['storageMetrics'],
+        'costs': !exists(json, 'costs') ? undefined : ((json['costs'] as Array<any>).map(MetricRecordFromJSON)),
+        'storageMetrics': !exists(json, 'storageMetrics') ? undefined : ((json['storageMetrics'] as Array<any>).map(MetricRecordFromJSON)),
     };
 }
 
@@ -75,8 +82,8 @@ export function ProjectMetricsToJSON(value?: ProjectMetrics | null): any {
     return {
         
         'projectId': value.projectId,
-        'costs': value.costs,
-        'storageMetrics': value.storageMetrics,
+        'costs': value.costs === undefined ? undefined : ((value.costs as Array<any>).map(MetricRecordToJSON)),
+        'storageMetrics': value.storageMetrics === undefined ? undefined : ((value.storageMetrics as Array<any>).map(MetricRecordToJSON)),
     };
 }
 

package/src/models/ProjectRequest.ts

@@ -79,13 +79,13 @@ export interface ProjectRequest {
      * @type {CloudAccount}
      * @memberof ProjectRequest
      */
-    account: CloudAccount;
+    account: CloudAccount | null;
     /**
      * 
      * @type {Array<Tag>}
      * @memberof ProjectRequest
      */
-    tags: Array<Tag>;
+    tags: Array<Tag> | null;
 }
 
 /**
@@ -120,7 +120,7 @@ export function ProjectRequestFromJSONTyped(json: any, ignoreDiscriminator: bool
         'settings': ProjectSettingsFromJSON(json['settings']),
         'contacts': ((json['contacts'] as Array<any>).map(ContactFromJSON)),
         'account': CloudAccountFromJSON(json['account']),
-        'tags': ((json['tags'] as Array<any>).map(TagFromJSON)),
+        'tags': (json['tags'] === null ? null : (json['tags'] as Array<any>).map(TagFromJSON)),
     };
 }
 
@@ -139,7 +139,7 @@ export function ProjectRequestToJSON(value?: ProjectRequest | null): any {
         'settings': ProjectSettingsToJSON(value.settings),
         'contacts': ((value.contacts as Array<any>).map(ContactToJSON)),
         'account': CloudAccountToJSON(value.account),
-        'tags': ((value.tags as Array<any>).map(TagToJSON)),
+        'tags': (value.tags === null ? null : (value.tags as Array<any>).map(TagToJSON)),
     };
 }
 

package/src/models/ProjectRole.ts

@@ -12,18 +12,17 @@
  * Do not edit the class manually.
  */
 
-
 /**
  * 
  * @export
+ * @enum {string}
  */
-export const ProjectRole = {
-    Admin: 'ADMIN',
-    Contributor: 'CONTRIBUTOR',
-    Collaborator: 'COLLABORATOR',
-    None: 'NONE'
-} as const;
-export type ProjectRole = typeof ProjectRole[keyof typeof ProjectRole];
+export enum ProjectRole {
+    Admin = 'ADMIN',
+    Contributor = 'CONTRIBUTOR',
+    Collaborator = 'COLLABORATOR',
+    None = 'NONE'
+}
 
 
 export function ProjectRoleFromJSON(json: any): ProjectRole {