@cirrobio/api-client 0.12.23 → 0.12.25

package/dist/esm/models/ColumnDef.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 { ColumnDataType } from './ColumnDataType';
+import type { ForeignKeyRef } from './ForeignKeyRef';
+/**
+ *
+ * @export
+ * @interface ColumnDef
+ */
+export interface ColumnDef {
+    /**
+     *
+     * @type {string}
+     * @memberof ColumnDef
+     */
+    name: string;
+    /**
+     *
+     * @type {ColumnDataType}
+     * @memberof ColumnDef
+     */
+    dataType: ColumnDataType;
+    /**
+     *
+     * @type {string}
+     * @memberof ColumnDef
+     */
+    description: string;
+    /**
+     *
+     * @type {ForeignKeyRef}
+     * @memberof ColumnDef
+     */
+    foreignKey?: ForeignKeyRef | null;
+}
+/**
+ * Check if a given object implements the ColumnDef interface.
+ */
+export declare function instanceOfColumnDef(value: object): boolean;
+export declare function ColumnDefFromJSON(json: any): ColumnDef;
+export declare function ColumnDefFromJSONTyped(json: any, ignoreDiscriminator: boolean): ColumnDef;
+export declare function ColumnDefToJSON(value?: ColumnDef | null): any;

package/dist/esm/models/ColumnDef.js

@@ -0,0 +1,54 @@
+/* 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 } from '../runtime';
+import { ColumnDataTypeFromJSON, ColumnDataTypeToJSON, } from './ColumnDataType';
+import { ForeignKeyRefFromJSON, ForeignKeyRefToJSON, } from './ForeignKeyRef';
+/**
+ * Check if a given object implements the ColumnDef interface.
+ */
+export function instanceOfColumnDef(value) {
+    let isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "dataType" in value;
+    isInstance = isInstance && "description" in value;
+    return isInstance;
+}
+export function ColumnDefFromJSON(json) {
+    return ColumnDefFromJSONTyped(json, false);
+}
+export function ColumnDefFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'dataType': ColumnDataTypeFromJSON(json['dataType']),
+        'description': json['description'],
+        'foreignKey': !exists(json, 'foreignKey') ? undefined : ForeignKeyRefFromJSON(json['foreignKey']),
+    };
+}
+export function ColumnDefToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'dataType': ColumnDataTypeToJSON(value.dataType),
+        'description': value.description,
+        'foreignKey': ForeignKeyRefToJSON(value.foreignKey),
+    };
+}

package/dist/esm/models/CreateSheetRequest.d.ts

@@ -0,0 +1,70 @@
+/**
+ * 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 { ColumnDef } from './ColumnDef';
+import type { CreateSheetRequestFileDef } from './CreateSheetRequestFileDef';
+import type { SheetTableType } from './SheetTableType';
+/**
+ *
+ * @export
+ * @interface CreateSheetRequest
+ */
+export interface CreateSheetRequest {
+    /**
+     * Display name for the sheet
+     * @type {string}
+     * @memberof CreateSheetRequest
+     */
+    name: string;
+    /**
+     * Optional description of the sheet's purpose or contents
+     * @type {string}
+     * @memberof CreateSheetRequest
+     */
+    description?: string;
+    /**
+     * S3 Tables namespace for the Iceberg table
+     * @type {string}
+     * @memberof CreateSheetRequest
+     */
+    namespaceName: string;
+    /**
+     * Name of the Iceberg table within the namespace
+     * @type {string}
+     * @memberof CreateSheetRequest
+     */
+    tableName: string;
+    /**
+     *
+     * @type {SheetTableType}
+     * @memberof CreateSheetRequest
+     */
+    tableType: SheetTableType;
+    /**
+     * Column definitions for the table schema
+     * @type {Array<ColumnDef>}
+     * @memberof CreateSheetRequest
+     */
+    columns: Array<ColumnDef>;
+    /**
+     *
+     * @type {CreateSheetRequestFileDef}
+     * @memberof CreateSheetRequest
+     */
+    fileDef?: CreateSheetRequestFileDef | null;
+}
+/**
+ * Check if a given object implements the CreateSheetRequest interface.
+ */
+export declare function instanceOfCreateSheetRequest(value: object): boolean;
+export declare function CreateSheetRequestFromJSON(json: any): CreateSheetRequest;
+export declare function CreateSheetRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSheetRequest;
+export declare function CreateSheetRequestToJSON(value?: CreateSheetRequest | null): any;

package/dist/esm/models/CreateSheetRequest.js

@@ -0,0 +1,63 @@
+/* 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 } from '../runtime';
+import { ColumnDefFromJSON, ColumnDefToJSON, } from './ColumnDef';
+import { CreateSheetRequestFileDefFromJSON, CreateSheetRequestFileDefToJSON, } from './CreateSheetRequestFileDef';
+import { SheetTableTypeFromJSON, SheetTableTypeToJSON, } from './SheetTableType';
+/**
+ * Check if a given object implements the CreateSheetRequest interface.
+ */
+export function instanceOfCreateSheetRequest(value) {
+    let isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "namespaceName" in value;
+    isInstance = isInstance && "tableName" in value;
+    isInstance = isInstance && "tableType" in value;
+    isInstance = isInstance && "columns" in value;
+    return isInstance;
+}
+export function CreateSheetRequestFromJSON(json) {
+    return CreateSheetRequestFromJSONTyped(json, false);
+}
+export function CreateSheetRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'description': !exists(json, 'description') ? undefined : json['description'],
+        'namespaceName': json['namespaceName'],
+        'tableName': json['tableName'],
+        'tableType': SheetTableTypeFromJSON(json['tableType']),
+        'columns': (json['columns'].map(ColumnDefFromJSON)),
+        'fileDef': !exists(json, 'fileDef') ? undefined : CreateSheetRequestFileDefFromJSON(json['fileDef']),
+    };
+}
+export function CreateSheetRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'description': value.description,
+        'namespaceName': value.namespaceName,
+        'tableName': value.tableName,
+        'tableType': SheetTableTypeToJSON(value.tableType),
+        'columns': (value.columns.map(ColumnDefToJSON)),
+        'fileDef': CreateSheetRequestFileDefToJSON(value.fileDef),
+    };
+}

package/dist/esm/models/CreateSheetRequestFileDef.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 { FileType } from './FileType';
+/**
+ * If provided, an ingest job is triggered immediately after table creation
+ * @export
+ * @interface CreateSheetRequestFileDef
+ */
+export interface CreateSheetRequestFileDef {
+    /**
+     *
+     * @type {FileType}
+     * @memberof CreateSheetRequestFileDef
+     */
+    fileType: FileType;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateSheetRequestFileDef
+     */
+    storageUri: string;
+}
+/**
+ * Check if a given object implements the CreateSheetRequestFileDef interface.
+ */
+export declare function instanceOfCreateSheetRequestFileDef(value: object): boolean;
+export declare function CreateSheetRequestFileDefFromJSON(json: any): CreateSheetRequestFileDef;
+export declare function CreateSheetRequestFileDefFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSheetRequestFileDef;
+export declare function CreateSheetRequestFileDefToJSON(value?: CreateSheetRequestFileDef | null): any;

package/dist/esm/models/CreateSheetRequestFileDef.js

@@ -0,0 +1,47 @@
+/* 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 { FileTypeFromJSON, FileTypeToJSON, } from './FileType';
+/**
+ * Check if a given object implements the CreateSheetRequestFileDef interface.
+ */
+export function instanceOfCreateSheetRequestFileDef(value) {
+    let isInstance = true;
+    isInstance = isInstance && "fileType" in value;
+    isInstance = isInstance && "storageUri" in value;
+    return isInstance;
+}
+export function CreateSheetRequestFileDefFromJSON(json) {
+    return CreateSheetRequestFileDefFromJSONTyped(json, false);
+}
+export function CreateSheetRequestFileDefFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'fileType': FileTypeFromJSON(json['fileType']),
+        'storageUri': json['storageUri'],
+    };
+}
+export function CreateSheetRequestFileDefToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'fileType': FileTypeToJSON(value.fileType),
+        'storageUri': value.storageUri,
+    };
+}

package/dist/esm/models/FeatureFlags.d.ts

@@ -51,6 +51,12 @@ export interface FeatureFlags {
      * @memberof FeatureFlags
      */
     appRegistrationsEnabled: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof FeatureFlags
+     */
+    sheetsEnabled: boolean;
 }
 /**
  * Check if a given object implements the FeatureFlags interface.

package/dist/esm/models/FeatureFlags.js

@@ -22,6 +22,7 @@ export function instanceOfFeatureFlags(value) {
     isInstance = isInstance && "workspacesEnabled" in value;
     isInstance = isInstance && "driveEnabled" in value;
     isInstance = isInstance && "appRegistrationsEnabled" in value;
+    isInstance = isInstance && "sheetsEnabled" in value;
     return isInstance;
 }
 export function FeatureFlagsFromJSON(json) {
@@ -38,6 +39,7 @@ export function FeatureFlagsFromJSONTyped(json, ignoreDiscriminator) {
         'workspacesEnabled': json['workspacesEnabled'],
         'driveEnabled': json['driveEnabled'],
         'appRegistrationsEnabled': json['appRegistrationsEnabled'],
+        'sheetsEnabled': json['sheetsEnabled'],
     };
 }
 export function FeatureFlagsToJSON(value) {
@@ -54,5 +56,6 @@ export function FeatureFlagsToJSON(value) {
         'workspacesEnabled': value.workspacesEnabled,
         'driveEnabled': value.driveEnabled,
         'appRegistrationsEnabled': value.appRegistrationsEnabled,
+        'sheetsEnabled': value.sheetsEnabled,
     };
 }

package/dist/esm/models/FileDef.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 { FileType } from './FileType';
+/**
+ * If provided, an ingest job is triggered immediately after table creation
+ * @export
+ * @interface FileDef
+ */
+export interface FileDef {
+    /**
+     *
+     * @type {FileType}
+     * @memberof FileDef
+     */
+    fileType: FileType;
+    /**
+     *
+     * @type {string}
+     * @memberof FileDef
+     */
+    storageUri: string;
+}
+/**
+ * Check if a given object implements the FileDef interface.
+ */
+export declare function instanceOfFileDef(value: object): boolean;
+export declare function FileDefFromJSON(json: any): FileDef;
+export declare function FileDefFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileDef;
+export declare function FileDefToJSON(value?: FileDef | null): any;

package/dist/esm/models/FileDef.js

@@ -0,0 +1,47 @@
+/* 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 { FileTypeFromJSON, FileTypeToJSON, } from './FileType';
+/**
+ * Check if a given object implements the FileDef interface.
+ */
+export function instanceOfFileDef(value) {
+    let isInstance = true;
+    isInstance = isInstance && "fileType" in value;
+    isInstance = isInstance && "storageUri" in value;
+    return isInstance;
+}
+export function FileDefFromJSON(json) {
+    return FileDefFromJSONTyped(json, false);
+}
+export function FileDefFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'fileType': FileTypeFromJSON(json['fileType']),
+        'storageUri': json['storageUri'],
+    };
+}
+export function FileDefToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'fileType': FileTypeToJSON(value.fileType),
+        'storageUri': value.storageUri,
+    };
+}

package/dist/esm/models/FileType.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum FileType {
+    Parquet = "PARQUET",
+    Csv = "CSV",
+    Json = "JSON"
+}
+export declare function FileTypeFromJSON(json: any): FileType;
+export declare function FileTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileType;
+export declare function FileTypeToJSON(value?: FileType | null): any;

package/dist/esm/models/FileType.js

@@ -0,0 +1,33 @@
+/* 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.
+ */
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+export var FileType;
+(function (FileType) {
+    FileType["Parquet"] = "PARQUET";
+    FileType["Csv"] = "CSV";
+    FileType["Json"] = "JSON";
+})(FileType || (FileType = {}));
+export function FileTypeFromJSON(json) {
+    return FileTypeFromJSONTyped(json, false);
+}
+export function FileTypeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function FileTypeToJSON(value) {
+    return value;
+}

package/dist/esm/models/ForeignKeyRef.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface ForeignKeyRef
+ */
+export interface ForeignKeyRef {
+    /**
+     *
+     * @type {string}
+     * @memberof ForeignKeyRef
+     */
+    sheetId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ForeignKeyRef
+     */
+    columnName: string;
+}
+/**
+ * Check if a given object implements the ForeignKeyRef interface.
+ */
+export declare function instanceOfForeignKeyRef(value: object): boolean;
+export declare function ForeignKeyRefFromJSON(json: any): ForeignKeyRef;
+export declare function ForeignKeyRefFromJSONTyped(json: any, ignoreDiscriminator: boolean): ForeignKeyRef;
+export declare function ForeignKeyRefToJSON(value?: ForeignKeyRef | null): any;

package/dist/esm/models/ForeignKeyRef.js

@@ -0,0 +1,46 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the ForeignKeyRef interface.
+ */
+export function instanceOfForeignKeyRef(value) {
+    let isInstance = true;
+    isInstance = isInstance && "sheetId" in value;
+    isInstance = isInstance && "columnName" in value;
+    return isInstance;
+}
+export function ForeignKeyRefFromJSON(json) {
+    return ForeignKeyRefFromJSONTyped(json, false);
+}
+export function ForeignKeyRefFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'sheetId': json['sheetId'],
+        'columnName': json['columnName'],
+    };
+}
+export function ForeignKeyRefToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'sheetId': value.sheetId,
+        'columnName': value.columnName,
+    };
+}

package/dist/esm/models/Permission.d.ts

@@ -47,6 +47,10 @@ export declare enum Permission {
     ViewDashboard = "VIEW_DASHBOARD",
     CreateDashboard = "CREATE_DASHBOARD",
     EditDashboard = "EDIT_DASHBOARD",
+    ViewSheet = "VIEW_SHEET",
+    CreateSheet = "CREATE_SHEET",
+    EditSheet = "EDIT_SHEET",
+    DeleteSheet = "DELETE_SHEET",
     CreateNotebookInstance = "CREATE_NOTEBOOK_INSTANCE",
     DeleteNotebookInstance = "DELETE_NOTEBOOK_INSTANCE",
     ControlNotebookInstance = "CONTROL_NOTEBOOK_INSTANCE",

package/dist/esm/models/Permission.js

@@ -50,6 +50,10 @@ export var Permission;
     Permission["ViewDashboard"] = "VIEW_DASHBOARD";
     Permission["CreateDashboard"] = "CREATE_DASHBOARD";
     Permission["EditDashboard"] = "EDIT_DASHBOARD";
+    Permission["ViewSheet"] = "VIEW_SHEET";
+    Permission["CreateSheet"] = "CREATE_SHEET";
+    Permission["EditSheet"] = "EDIT_SHEET";
+    Permission["DeleteSheet"] = "DELETE_SHEET";
     Permission["CreateNotebookInstance"] = "CREATE_NOTEBOOK_INSTANCE";
     Permission["DeleteNotebookInstance"] = "DELETE_NOTEBOOK_INSTANCE";
     Permission["ControlNotebookInstance"] = "CONTROL_NOTEBOOK_INSTANCE";

package/dist/esm/models/RequestQuotaIncreaseCommand.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface RequestQuotaIncreaseCommand
+ */
+export interface RequestQuotaIncreaseCommand {
+    /**
+     *
+     * @type {string}
+     * @memberof RequestQuotaIncreaseCommand
+     */
+    serviceCode: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RequestQuotaIncreaseCommand
+     */
+    quotaCode: string;
+    /**
+     *
+     * @type {number}
+     * @memberof RequestQuotaIncreaseCommand
+     */
+    value: number;
+}
+/**
+ * Check if a given object implements the RequestQuotaIncreaseCommand interface.
+ */
+export declare function instanceOfRequestQuotaIncreaseCommand(value: object): boolean;
+export declare function RequestQuotaIncreaseCommandFromJSON(json: any): RequestQuotaIncreaseCommand;
+export declare function RequestQuotaIncreaseCommandFromJSONTyped(json: any, ignoreDiscriminator: boolean): RequestQuotaIncreaseCommand;
+export declare function RequestQuotaIncreaseCommandToJSON(value?: RequestQuotaIncreaseCommand | null): any;