@cirrobio/api-client 0.0.24-alpha → 0.0.25-alpha

package/dist/models/S3Credentials.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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 S3Credentials
+ */
+export interface S3Credentials {
+    /**
+     *
+     * @type {string}
+     * @memberof S3Credentials
+     */
+    accessKeyId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof S3Credentials
+     */
+    expiration: string;
+    /**
+     *
+     * @type {string}
+     * @memberof S3Credentials
+     */
+    secretAccessKey: string;
+    /**
+     *
+     * @type {string}
+     * @memberof S3Credentials
+     */
+    sessionToken: string;
+    /**
+     *
+     * @type {string}
+     * @memberof S3Credentials
+     */
+    region: string;
+}
+/**
+ * Check if a given object implements the S3Credentials interface.
+ */
+export declare function instanceOfS3Credentials(value: object): boolean;
+export declare function S3CredentialsFromJSON(json: any): S3Credentials;
+export declare function S3CredentialsFromJSONTyped(json: any, ignoreDiscriminator: boolean): S3Credentials;
+export declare function S3CredentialsToJSON(value?: S3Credentials | null): any;

package/dist/models/S3Credentials.js

@@ -0,0 +1,62 @@
+"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.S3CredentialsToJSON = exports.S3CredentialsFromJSONTyped = exports.S3CredentialsFromJSON = exports.instanceOfS3Credentials = void 0;
+/**
+ * Check if a given object implements the S3Credentials interface.
+ */
+function instanceOfS3Credentials(value) {
+    var isInstance = true;
+    isInstance = isInstance && "accessKeyId" in value;
+    isInstance = isInstance && "expiration" in value;
+    isInstance = isInstance && "secretAccessKey" in value;
+    isInstance = isInstance && "sessionToken" in value;
+    isInstance = isInstance && "region" in value;
+    return isInstance;
+}
+exports.instanceOfS3Credentials = instanceOfS3Credentials;
+function S3CredentialsFromJSON(json) {
+    return S3CredentialsFromJSONTyped(json, false);
+}
+exports.S3CredentialsFromJSON = S3CredentialsFromJSON;
+function S3CredentialsFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'accessKeyId': json['accessKeyId'],
+        'expiration': json['expiration'],
+        'secretAccessKey': json['secretAccessKey'],
+        'sessionToken': json['sessionToken'],
+        'region': json['region'],
+    };
+}
+exports.S3CredentialsFromJSONTyped = S3CredentialsFromJSONTyped;
+function S3CredentialsToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'accessKeyId': value.accessKeyId,
+        'expiration': value.expiration,
+        'secretAccessKey': value.secretAccessKey,
+        'sessionToken': value.sessionToken,
+        'region': value.region,
+    };
+}
+exports.S3CredentialsToJSON = S3CredentialsToJSON;

package/dist/models/SftpCredentials.d.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 SftpCredentials
+ */
+export interface SftpCredentials {
+    /**
+     *
+     * @type {string}
+     * @memberof SftpCredentials
+     */
+    username: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SftpCredentials
+     */
+    password: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SftpCredentials
+     */
+    projectId: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof SftpCredentials
+     */
+    expiresAt: Date;
+}
+/**
+ * Check if a given object implements the SftpCredentials interface.
+ */
+export declare function instanceOfSftpCredentials(value: object): boolean;
+export declare function SftpCredentialsFromJSON(json: any): SftpCredentials;
+export declare function SftpCredentialsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SftpCredentials;
+export declare function SftpCredentialsToJSON(value?: SftpCredentials | null): any;

package/dist/models/SftpCredentials.js

@@ -0,0 +1,59 @@
+"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.SftpCredentialsToJSON = exports.SftpCredentialsFromJSONTyped = exports.SftpCredentialsFromJSON = exports.instanceOfSftpCredentials = void 0;
+/**
+ * Check if a given object implements the SftpCredentials interface.
+ */
+function instanceOfSftpCredentials(value) {
+    var isInstance = true;
+    isInstance = isInstance && "username" in value;
+    isInstance = isInstance && "password" in value;
+    isInstance = isInstance && "projectId" in value;
+    isInstance = isInstance && "expiresAt" in value;
+    return isInstance;
+}
+exports.instanceOfSftpCredentials = instanceOfSftpCredentials;
+function SftpCredentialsFromJSON(json) {
+    return SftpCredentialsFromJSONTyped(json, false);
+}
+exports.SftpCredentialsFromJSON = SftpCredentialsFromJSON;
+function SftpCredentialsFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'username': json['username'],
+        'password': json['password'],
+        'projectId': json['projectId'],
+        'expiresAt': (new Date(json['expiresAt'])),
+    };
+}
+exports.SftpCredentialsFromJSONTyped = SftpCredentialsFromJSONTyped;
+function SftpCredentialsToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'username': value.username,
+        'password': value.password,
+        'projectId': value.projectId,
+        'expiresAt': (value.expiresAt.toISOString()),
+    };
+}
+exports.SftpCredentialsToJSON = SftpCredentialsToJSON;

package/dist/models/index.d.ts

@@ -17,8 +17,11 @@ export * from './DatasetFile';
 export * from './DatasetViz';
 export * from './Executor';
 export * from './FormSchema';
+export * from './GenerateSftpCredentialsRequest';
 export * from './GetExecutionLogsResponse';
 export * from './ImportDataRequest';
+export * from './InviteUserRequest';
+export * from './InviteUserResponse';
 export * from './LogEntry';
 export * from './MetricRecord';
 export * from './NotebookInstance';
@@ -38,10 +41,12 @@ export * from './ProjectUser';
 export * from './Reference';
 export * from './ReferenceType';
 export * from './RunAnalysisRequest';
+export * from './S3Credentials';
 export * from './Sample';
 export * from './SampleRequest';
 export * from './ServiceConnection';
 export * from './SetUserProjectRoleRequest';
+export * from './SftpCredentials';
 export * from './Status';
 export * from './StopExecutionResponse';
 export * from './SystemInfoResponse';

package/dist/models/index.js

@@ -35,8 +35,11 @@ __exportStar(require("./DatasetFile"), exports);
 __exportStar(require("./DatasetViz"), exports);
 __exportStar(require("./Executor"), exports);
 __exportStar(require("./FormSchema"), exports);
+__exportStar(require("./GenerateSftpCredentialsRequest"), exports);
 __exportStar(require("./GetExecutionLogsResponse"), exports);
 __exportStar(require("./ImportDataRequest"), exports);
+__exportStar(require("./InviteUserRequest"), exports);
+__exportStar(require("./InviteUserResponse"), exports);
 __exportStar(require("./LogEntry"), exports);
 __exportStar(require("./MetricRecord"), exports);
 __exportStar(require("./NotebookInstance"), exports);
@@ -56,10 +59,12 @@ __exportStar(require("./ProjectUser"), exports);
 __exportStar(require("./Reference"), exports);
 __exportStar(require("./ReferenceType"), exports);
 __exportStar(require("./RunAnalysisRequest"), exports);
+__exportStar(require("./S3Credentials"), exports);
 __exportStar(require("./Sample"), exports);
 __exportStar(require("./SampleRequest"), exports);
 __exportStar(require("./ServiceConnection"), exports);
 __exportStar(require("./SetUserProjectRoleRequest"), exports);
+__exportStar(require("./SftpCredentials"), exports);
 __exportStar(require("./Status"), exports);
 __exportStar(require("./StopExecutionResponse"), exports);
 __exportStar(require("./SystemInfoResponse"), exports);

package/package.json

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

package/src/apis/FileApi.ts

@@ -0,0 +1,132 @@
+/* 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 {
+  GenerateSftpCredentialsRequest,
+  S3Credentials,
+  SftpCredentials,
+} from '../models/index';
+import {
+    GenerateSftpCredentialsRequestFromJSON,
+    GenerateSftpCredentialsRequestToJSON,
+    S3CredentialsFromJSON,
+    S3CredentialsToJSON,
+    SftpCredentialsFromJSON,
+    SftpCredentialsToJSON,
+} from '../models/index';
+
+export interface GenerateFileAccessTokenRequest {
+    projectId: string;
+}
+
+export interface GenerateSftpTokenRequest {
+    projectId: string;
+    generateSftpCredentialsRequest: GenerateSftpCredentialsRequest;
+}
+
+/**
+ * 
+ */
+export class FileApi extends runtime.BaseAPI {
+
+    /**
+     * Generates credentials used for connecting via S3
+     * Create file access token
+     */
+    async generateFileAccessTokenRaw(requestParameters: GenerateFileAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<S3Credentials>> {
+        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling generateFileAccessToken.');
+        }
+
+        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}/s3-token`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => S3CredentialsFromJSON(jsonValue));
+    }
+
+    /**
+     * Generates credentials used for connecting via S3
+     * Create file access token
+     */
+    async generateFileAccessToken(requestParameters: GenerateFileAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<S3Credentials> {
+        const response = await this.generateFileAccessTokenRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Generates credentials used for connecting via SFTP
+     * Create SFTP Token
+     */
+    async generateSftpTokenRaw(requestParameters: GenerateSftpTokenRequest, 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 generateSftpToken.');
+        }
+
+        if (requestParameters.generateSftpCredentialsRequest === null || requestParameters.generateSftpCredentialsRequest === undefined) {
+            throw new runtime.RequiredError('generateSftpCredentialsRequest','Required parameter requestParameters.generateSftpCredentialsRequest was null or undefined when calling generateSftpToken.');
+        }
+
+        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 SFTP Token
+     */
+    async generateSftpToken(requestParameters: GenerateSftpTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SftpCredentials> {
+        const response = await this.generateSftpTokenRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/UsersApi.ts

@@ -15,10 +15,16 @@
 
 import * as runtime from '../runtime';
 import type {
+  InviteUserRequest,
+  InviteUserResponse,
   UpdateUserRequest,
   User,
 } from '../models/index';
 import {
+    InviteUserRequestFromJSON,
+    InviteUserRequestToJSON,
+    InviteUserResponseFromJSON,
+    InviteUserResponseToJSON,
     UpdateUserRequestFromJSON,
     UpdateUserRequestToJSON,
     UserFromJSON,
@@ -33,6 +39,10 @@ export interface GetUsersRequest {
     username: string;
 }
 
+export interface InviteUserOperationRequest {
+    inviteUserRequest: InviteUserRequest;
+}
+
 export interface UpdateUserOperationRequest {
     username: string;
     updateUserRequest: UpdateUserRequest;
@@ -127,6 +137,49 @@ export class UsersApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Invites a user to the system
+     * Invite user
+     */
+    async inviteUserRaw(requestParameters: InviteUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InviteUserResponse>> {
+        if (requestParameters.inviteUserRequest === null || requestParameters.inviteUserRequest === undefined) {
+            throw new runtime.RequiredError('inviteUserRequest','Required parameter requestParameters.inviteUserRequest was null or undefined when calling inviteUser.');
+        }
+
+        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: `/users`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: InviteUserRequestToJSON(requestParameters.inviteUserRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => InviteUserResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Invites a user to the system
+     * Invite user
+     */
+    async inviteUser(requestParameters: InviteUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InviteUserResponse> {
+        const response = await this.inviteUserRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Update user information
      * Update user

package/src/apis/index.ts

@@ -4,6 +4,7 @@ export * from './BillingApi';
 export * from './DashboardsApi';
 export * from './DatasetsApi';
 export * from './ExecutionApi';
+export * from './FileApi';
 export * from './MetadataApi';
 export * from './MetricsApi';
 export * from './NotebooksApi';

package/src/models/GenerateSftpCredentialsRequest.ts

@@ -0,0 +1,66 @@
+/* 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 GenerateSftpCredentialsRequest
+ */
+export interface GenerateSftpCredentialsRequest {
+    /**
+     * 
+     * @type {number}
+     * @memberof GenerateSftpCredentialsRequest
+     */
+    lifetimeDays: number;
+}
+
+/**
+ * Check if a given object implements the GenerateSftpCredentialsRequest interface.
+ */
+export function instanceOfGenerateSftpCredentialsRequest(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "lifetimeDays" in value;
+
+    return isInstance;
+}
+
+export function GenerateSftpCredentialsRequestFromJSON(json: any): GenerateSftpCredentialsRequest {
+    return GenerateSftpCredentialsRequestFromJSONTyped(json, false);
+}
+
+export function GenerateSftpCredentialsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): GenerateSftpCredentialsRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'lifetimeDays': json['lifetimeDays'],
+    };
+}
+
+export function GenerateSftpCredentialsRequestToJSON(value?: GenerateSftpCredentialsRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'lifetimeDays': value.lifetimeDays,
+    };
+}
+

package/src/models/InviteUserRequest.ts

@@ -0,0 +1,84 @@
+/* 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 InviteUserRequest
+ */
+export interface InviteUserRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof InviteUserRequest
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof InviteUserRequest
+     */
+    organization: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof InviteUserRequest
+     */
+    email: string;
+}
+
+/**
+ * Check if a given object implements the InviteUserRequest interface.
+ */
+export function instanceOfInviteUserRequest(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "organization" in value;
+    isInstance = isInstance && "email" in value;
+
+    return isInstance;
+}
+
+export function InviteUserRequestFromJSON(json: any): InviteUserRequest {
+    return InviteUserRequestFromJSONTyped(json, false);
+}
+
+export function InviteUserRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): InviteUserRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'organization': json['organization'],
+        'email': json['email'],
+    };
+}
+
+export function InviteUserRequestToJSON(value?: InviteUserRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+        'organization': value.organization,
+        'email': value.email,
+    };
+}
+