@cirrobio/api-client 0.0.39-alpha → 0.1.1

package/dist/models/Table.js

@@ -0,0 +1,63 @@
+"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.TableToJSON = exports.TableFromJSONTyped = exports.TableFromJSON = exports.instanceOfTable = void 0;
+var runtime_1 = require("../runtime");
+var ColumnDefinition_1 = require("./ColumnDefinition");
+/**
+ * Check if a given object implements the Table interface.
+ */
+function instanceOfTable(value) {
+    var isInstance = true;
+    isInstance = isInstance && "desc" in value;
+    isInstance = isInstance && "cols" in value;
+    return isInstance;
+}
+exports.instanceOfTable = instanceOfTable;
+function TableFromJSON(json) {
+    return TableFromJSONTyped(json, false);
+}
+exports.TableFromJSON = TableFromJSON;
+function TableFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
+        'desc': json['desc'],
+        'type': !(0, runtime_1.exists)(json, 'type') ? undefined : json['type'],
+        'rows': !(0, runtime_1.exists)(json, 'rows') ? undefined : json['rows'],
+        'path': !(0, runtime_1.exists)(json, 'path') ? undefined : json['path'],
+        'cols': (json['cols'].map(ColumnDefinition_1.ColumnDefinitionFromJSON)),
+    };
+}
+exports.TableFromJSONTyped = TableFromJSONTyped;
+function TableToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'desc': value.desc,
+        'type': value.type,
+        'rows': value.rows,
+        'path': value.path,
+        'cols': (value.cols.map(ColumnDefinition_1.ColumnDefinitionToJSON)),
+    };
+}
+exports.TableToJSON = TableToJSON;

package/dist/models/TenantInfo.d.ts

@@ -0,0 +1,80 @@
+/**
+ * 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 { LoginProvider } from './LoginProvider';
+/**
+ *
+ * @export
+ * @interface TenantInfo
+ */
+export interface TenantInfo {
+    /**
+     *
+     * @type {string}
+     * @memberof TenantInfo
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TenantInfo
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TenantInfo
+     */
+    description: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TenantInfo
+     */
+    location: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TenantInfo
+     */
+    contactEmail: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TenantInfo
+     */
+    tenantLogoUrl: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TenantInfo
+     */
+    termsOfServiceUrl: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TenantInfo
+     */
+    privacyPolicyUrl: string;
+    /**
+     *
+     * @type {Array<LoginProvider>}
+     * @memberof TenantInfo
+     */
+    loginProviders: Array<LoginProvider>;
+}
+/**
+ * Check if a given object implements the TenantInfo interface.
+ */
+export declare function instanceOfTenantInfo(value: object): boolean;
+export declare function TenantInfoFromJSON(json: any): TenantInfo;
+export declare function TenantInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): TenantInfo;
+export declare function TenantInfoToJSON(value?: TenantInfo | null): any;

package/dist/models/TenantInfo.js

@@ -0,0 +1,75 @@
+"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.TenantInfoToJSON = exports.TenantInfoFromJSONTyped = exports.TenantInfoFromJSON = exports.instanceOfTenantInfo = void 0;
+var LoginProvider_1 = require("./LoginProvider");
+/**
+ * Check if a given object implements the TenantInfo interface.
+ */
+function instanceOfTenantInfo(value) {
+    var isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "location" in value;
+    isInstance = isInstance && "contactEmail" in value;
+    isInstance = isInstance && "tenantLogoUrl" in value;
+    isInstance = isInstance && "termsOfServiceUrl" in value;
+    isInstance = isInstance && "privacyPolicyUrl" in value;
+    isInstance = isInstance && "loginProviders" in value;
+    return isInstance;
+}
+exports.instanceOfTenantInfo = instanceOfTenantInfo;
+function TenantInfoFromJSON(json) {
+    return TenantInfoFromJSONTyped(json, false);
+}
+exports.TenantInfoFromJSON = TenantInfoFromJSON;
+function TenantInfoFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'location': json['location'],
+        'contactEmail': json['contactEmail'],
+        'tenantLogoUrl': json['tenantLogoUrl'],
+        'termsOfServiceUrl': json['termsOfServiceUrl'],
+        'privacyPolicyUrl': json['privacyPolicyUrl'],
+        'loginProviders': (json['loginProviders'].map(LoginProvider_1.LoginProviderFromJSON)),
+    };
+}
+exports.TenantInfoFromJSONTyped = TenantInfoFromJSONTyped;
+function TenantInfoToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'name': value.name,
+        'description': value.description,
+        'location': value.location,
+        'contactEmail': value.contactEmail,
+        'tenantLogoUrl': value.tenantLogoUrl,
+        'termsOfServiceUrl': value.termsOfServiceUrl,
+        'privacyPolicyUrl': value.privacyPolicyUrl,
+        'loginProviders': (value.loginProviders.map(LoginProvider_1.LoginProviderToJSON)),
+    };
+}
+exports.TenantInfoToJSON = TenantInfoToJSON;

package/dist/models/UploadDatasetRequest.d.ts

@@ -16,19 +16,19 @@
  */
 export interface UploadDatasetRequest {
     /**
-     *
+     * Name of the dataset
      * @type {string}
      * @memberof UploadDatasetRequest
      */
     name: string;
     /**
-     *
+     * Description of the dataset
      * @type {string}
      * @memberof UploadDatasetRequest
      */
-    description: string;
+    description?: string;
     /**
-     *
+     * ID of the ingest process
      * @type {string}
      * @memberof UploadDatasetRequest
      */

package/dist/models/UploadDatasetRequest.js

@@ -14,13 +14,13 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UploadDatasetRequestToJSON = exports.UploadDatasetRequestFromJSONTyped = exports.UploadDatasetRequestFromJSON = exports.instanceOfUploadDatasetRequest = void 0;
+var runtime_1 = require("../runtime");
 /**
  * Check if a given object implements the UploadDatasetRequest interface.
  */
 function instanceOfUploadDatasetRequest(value) {
     var isInstance = true;
     isInstance = isInstance && "name" in value;
-    isInstance = isInstance && "description" in value;
     isInstance = isInstance && "processId" in value;
     isInstance = isInstance && "expectedFiles" in value;
     return isInstance;
@@ -36,7 +36,7 @@ function UploadDatasetRequestFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'name': json['name'],
-        'description': json['description'],
+        'description': !(0, runtime_1.exists)(json, 'description') ? undefined : json['description'],
         'processId': json['processId'],
         'expectedFiles': json['expectedFiles'],
     };

package/dist/models/index.d.ts

@@ -1,11 +1,13 @@
 export * from './AWSCredentials';
 export * from './AccessType';
 export * from './AllowedDataType';
+export * from './AuditEvent';
 export * from './BillingAccount';
 export * from './BillingAccountRequest';
 export * from './BillingMethod';
 export * from './BudgetPeriod';
 export * from './CloudAccount';
+export * from './ColumnDefinition';
 export * from './Contact';
 export * from './CreateNotebookInstanceRequest';
 export * from './CreateReferenceRequest';
@@ -31,6 +33,7 @@ export * from './ImportDataRequest';
 export * from './InviteUserRequest';
 export * from './InviteUserResponse';
 export * from './LogEntry';
+export * from './LoginProvider';
 export * from './MetricRecord';
 export * from './NotebookInstance';
 export * from './NotebookInstanceStatusResponse';
@@ -62,8 +65,10 @@ export * from './Status';
 export * from './StopExecutionResponse';
 export * from './SyncStatus';
 export * from './SystemInfoResponse';
+export * from './Table';
 export * from './Tag';
 export * from './Task';
+export * from './TenantInfo';
 export * from './UpdateDatasetRequest';
 export * from './UpdateUserRequest';
 export * from './UploadDatasetCreateResponse';

package/dist/models/index.js

@@ -19,11 +19,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./AWSCredentials"), exports);
 __exportStar(require("./AccessType"), exports);
 __exportStar(require("./AllowedDataType"), exports);
+__exportStar(require("./AuditEvent"), exports);
 __exportStar(require("./BillingAccount"), exports);
 __exportStar(require("./BillingAccountRequest"), exports);
 __exportStar(require("./BillingMethod"), exports);
 __exportStar(require("./BudgetPeriod"), exports);
 __exportStar(require("./CloudAccount"), exports);
+__exportStar(require("./ColumnDefinition"), exports);
 __exportStar(require("./Contact"), exports);
 __exportStar(require("./CreateNotebookInstanceRequest"), exports);
 __exportStar(require("./CreateReferenceRequest"), exports);
@@ -49,6 +51,7 @@ __exportStar(require("./ImportDataRequest"), exports);
 __exportStar(require("./InviteUserRequest"), exports);
 __exportStar(require("./InviteUserResponse"), exports);
 __exportStar(require("./LogEntry"), exports);
+__exportStar(require("./LoginProvider"), exports);
 __exportStar(require("./MetricRecord"), exports);
 __exportStar(require("./NotebookInstance"), exports);
 __exportStar(require("./NotebookInstanceStatusResponse"), exports);
@@ -80,8 +83,10 @@ __exportStar(require("./Status"), exports);
 __exportStar(require("./StopExecutionResponse"), exports);
 __exportStar(require("./SyncStatus"), exports);
 __exportStar(require("./SystemInfoResponse"), exports);
+__exportStar(require("./Table"), exports);
 __exportStar(require("./Tag"), exports);
 __exportStar(require("./Task"), exports);
+__exportStar(require("./TenantInfo"), exports);
 __exportStar(require("./UpdateDatasetRequest"), exports);
 __exportStar(require("./UpdateUserRequest"), exports);
 __exportStar(require("./UploadDatasetCreateResponse"), exports);

package/package.json

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

package/src/apis/AuditApi.ts

@@ -0,0 +1,106 @@
+/* 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 {
+  AuditEvent,
+} from '../models/index';
+import {
+    AuditEventFromJSON,
+    AuditEventToJSON,
+} from '../models/index';
+
+export interface GetEventRequest {
+    auditEventId: string;
+}
+
+export interface ListEventsRequest {
+    username: string;
+}
+
+/**
+ * 
+ */
+export class AuditApi extends runtime.BaseAPI {
+
+    /**
+     * Get audit event detailed information
+     * Get audit event
+     */
+    async getEventRaw(requestParameters: GetEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuditEvent>> {
+        if (requestParameters.auditEventId === null || requestParameters.auditEventId === undefined) {
+            throw new runtime.RequiredError('auditEventId','Required parameter requestParameters.auditEventId was null or undefined when calling getEvent.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/audit-events/{auditEventId}`.replace(`{${"auditEventId"}}`, encodeURIComponent(String(requestParameters.auditEventId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AuditEventFromJSON(jsonValue));
+    }
+
+    /**
+     * Get audit event detailed information
+     * Get audit event
+     */
+    async getEvent(requestParameters: GetEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuditEvent> {
+        const response = await this.getEventRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Gets a list of audit events
+     * List audit events
+     */
+    async listEventsRaw(requestParameters: ListEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AuditEvent>>> {
+        if (requestParameters.username === null || requestParameters.username === undefined) {
+            throw new runtime.RequiredError('username','Required parameter requestParameters.username was null or undefined when calling listEvents.');
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters.username !== undefined) {
+            queryParameters['username'] = requestParameters.username;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/audit-events`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(AuditEventFromJSON));
+    }
+
+    /**
+     * Gets a list of audit events
+     * List audit events
+     */
+    async listEvents(requestParameters: ListEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AuditEvent>> {
+        const response = await this.listEventsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -1,5 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
+export * from './AuditApi';
 export * from './BillingApi';
 export * from './DashboardsApi';
 export * from './DatasetsApi';

package/src/models/AuditEvent.ts

@@ -0,0 +1,137 @@
+/* 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 AuditEvent
+ */
+export interface AuditEvent {
+    /**
+     * The unique identifier for the audit event
+     * @type {string}
+     * @memberof AuditEvent
+     */
+    id?: string;
+    /**
+     * The type of event
+     * @type {string}
+     * @memberof AuditEvent
+     */
+    eventType?: string;
+    /**
+     * The project ID associated with the event (if applicable)
+     * @type {string}
+     * @memberof AuditEvent
+     */
+    projectId?: string;
+    /**
+     * The entity ID associated with the event
+     * @type {string}
+     * @memberof AuditEvent
+     */
+    entityId?: string;
+    /**
+     * The entity type associated with the event
+     * @type {string}
+     * @memberof AuditEvent
+     */
+    entityType?: string;
+    /**
+     * The details of the event, such as the request details sent from the client
+     * @type {{ [key: string]: any; }}
+     * @memberof AuditEvent
+     */
+    eventDetail?: { [key: string]: any; };
+    /**
+     * The changes made to the entity (if applicable)
+     * @type {{ [key: string]: string; }}
+     * @memberof AuditEvent
+     */
+    changes?: { [key: string]: string; };
+    /**
+     * The username of the user who performed the action
+     * @type {string}
+     * @memberof AuditEvent
+     */
+    username?: string;
+    /**
+     * The IP address of the user who performed the action
+     * @type {string}
+     * @memberof AuditEvent
+     */
+    ipAddress?: string;
+    /**
+     * The date and time the event was created
+     * @type {Date}
+     * @memberof AuditEvent
+     */
+    createdAt?: Date;
+}
+
+/**
+ * Check if a given object implements the AuditEvent interface.
+ */
+export function instanceOfAuditEvent(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function AuditEventFromJSON(json: any): AuditEvent {
+    return AuditEventFromJSONTyped(json, false);
+}
+
+export function AuditEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuditEvent {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'id': !exists(json, 'id') ? undefined : json['id'],
+        'eventType': !exists(json, 'eventType') ? undefined : json['eventType'],
+        'projectId': !exists(json, 'projectId') ? undefined : json['projectId'],
+        'entityId': !exists(json, 'entityId') ? undefined : json['entityId'],
+        'entityType': !exists(json, 'entityType') ? undefined : json['entityType'],
+        'eventDetail': !exists(json, 'eventDetail') ? undefined : json['eventDetail'],
+        'changes': !exists(json, 'changes') ? undefined : json['changes'],
+        'username': !exists(json, 'username') ? undefined : json['username'],
+        'ipAddress': !exists(json, 'ipAddress') ? undefined : json['ipAddress'],
+        'createdAt': !exists(json, 'createdAt') ? undefined : (new Date(json['createdAt'])),
+    };
+}
+
+export function AuditEventToJSON(value?: AuditEvent | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'id': value.id,
+        'eventType': value.eventType,
+        'projectId': value.projectId,
+        'entityId': value.entityId,
+        'entityType': value.entityType,
+        'eventDetail': value.eventDetail,
+        'changes': value.changes,
+        'username': value.username,
+        'ipAddress': value.ipAddress,
+        'createdAt': value.createdAt === undefined ? undefined : (value.createdAt.toISOString()),
+    };
+}
+

package/src/models/CloudAccount.ts

@@ -26,7 +26,7 @@ export interface CloudAccount {
      */
     accountId?: string;
     /**
-     * Name used to describe the account
+     * Name used to describe the account, useful when the account hosts multiple projects
      * @type {string}
      * @memberof CloudAccount
      */

package/src/models/ColumnDefinition.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 ColumnDefinition
+ */
+export interface ColumnDefinition {
+    /**
+     * Column name in asset file
+     * @type {string}
+     * @memberof ColumnDefinition
+     */
+    col?: string;
+    /**
+     * User-friendly column name
+     * @type {string}
+     * @memberof ColumnDefinition
+     */
+    name?: string;
+    /**
+     * Description of the column
+     * @type {string}
+     * @memberof ColumnDefinition
+     */
+    desc?: string;
+}
+
+/**
+ * Check if a given object implements the ColumnDefinition interface.
+ */
+export function instanceOfColumnDefinition(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function ColumnDefinitionFromJSON(json: any): ColumnDefinition {
+    return ColumnDefinitionFromJSONTyped(json, false);
+}
+
+export function ColumnDefinitionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ColumnDefinition {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'col': !exists(json, 'col') ? undefined : json['col'],
+        'name': !exists(json, 'name') ? undefined : json['name'],
+        'desc': !exists(json, 'desc') ? undefined : json['desc'],
+    };
+}
+
+export function ColumnDefinitionToJSON(value?: ColumnDefinition | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'col': value.col,
+        'name': value.name,
+        'desc': value.desc,
+    };
+}
+