@cirrobio/api-client 0.0.37-alpha → 0.0.39-alpha

package/.openapi-generator/FILES

@@ -17,6 +17,7 @@ src/apis/SystemApi.ts
 src/apis/UsersApi.ts
 src/apis/index.ts
 src/index.ts
+src/models/AWSCredentials.ts
 src/models/AccessType.ts
 src/models/AllowedDataType.ts
 src/models/BillingAccount.ts
@@ -71,7 +72,6 @@ src/models/ReferenceType.ts
 src/models/RepositoryType.ts
 src/models/ResourcesInfo.ts
 src/models/RunAnalysisRequest.ts
-src/models/S3Credentials.ts
 src/models/Sample.ts
 src/models/SampleRequest.ts
 src/models/ServiceConnection.ts

package/README.md

@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @cirrobio/api-client@0.0.37-alpha --save
+npm install @cirrobio/api-client@0.0.39-alpha --save
 ```
 
 _unPublished (not recommended):_

package/dist/apis/FileApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { FileAccessRequest, GenerateSftpCredentialsRequest, S3Credentials, SftpCredentials } from '../models/index';
+import type { AWSCredentials, FileAccessRequest, GenerateSftpCredentialsRequest, SftpCredentials } from '../models/index';
 export interface GenerateProjectFileAccessTokenRequest {
     projectId: string;
     fileAccessRequest: FileAccessRequest;
@@ -27,12 +27,12 @@ export declare class FileApi extends runtime.BaseAPI {
      * Generates credentials used for connecting via S3
      * Create project file access token
      */
-    generateProjectFileAccessTokenRaw(requestParameters: GenerateProjectFileAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<S3Credentials>>;
+    generateProjectFileAccessTokenRaw(requestParameters: GenerateProjectFileAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AWSCredentials>>;
     /**
      * Generates credentials used for connecting via S3
      * Create project file access token
      */
-    generateProjectFileAccessToken(requestParameters: GenerateProjectFileAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<S3Credentials>;
+    generateProjectFileAccessToken(requestParameters: GenerateProjectFileAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AWSCredentials>;
     /**
      * Generates credentials used for connecting via SFTP
      * Create project SFTP Token

package/dist/apis/FileApi.js

@@ -112,7 +112,7 @@ var FileApi = /** @class */ (function (_super) {
                         }, initOverrides)];
                     case 3:
                         response = _a.sent();
-                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.S3CredentialsFromJSON)(jsonValue); })];
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.AWSCredentialsFromJSON)(jsonValue); })];
                 }
             });
         });

package/dist/models/AWSCredentials.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 AWSCredentials
+ */
+export interface AWSCredentials {
+    /**
+     *
+     * @type {string}
+     * @memberof AWSCredentials
+     */
+    accessKeyId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AWSCredentials
+     */
+    secretAccessKey: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AWSCredentials
+     */
+    sessionToken: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof AWSCredentials
+     */
+    expiration: Date;
+    /**
+     * Region of requested resource (i.e., S3 Bucket)
+     * @type {string}
+     * @memberof AWSCredentials
+     */
+    region?: string;
+}
+/**
+ * Check if a given object implements the AWSCredentials interface.
+ */
+export declare function instanceOfAWSCredentials(value: object): boolean;
+export declare function AWSCredentialsFromJSON(json: any): AWSCredentials;
+export declare function AWSCredentialsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AWSCredentials;
+export declare function AWSCredentialsToJSON(value?: AWSCredentials | null): any;

package/dist/models/AWSCredentials.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.AWSCredentialsToJSON = exports.AWSCredentialsFromJSONTyped = exports.AWSCredentialsFromJSON = exports.instanceOfAWSCredentials = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the AWSCredentials interface.
+ */
+function instanceOfAWSCredentials(value) {
+    var isInstance = true;
+    isInstance = isInstance && "accessKeyId" in value;
+    isInstance = isInstance && "secretAccessKey" in value;
+    isInstance = isInstance && "sessionToken" in value;
+    isInstance = isInstance && "expiration" in value;
+    return isInstance;
+}
+exports.instanceOfAWSCredentials = instanceOfAWSCredentials;
+function AWSCredentialsFromJSON(json) {
+    return AWSCredentialsFromJSONTyped(json, false);
+}
+exports.AWSCredentialsFromJSON = AWSCredentialsFromJSON;
+function AWSCredentialsFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'accessKeyId': json['accessKeyId'],
+        'secretAccessKey': json['secretAccessKey'],
+        'sessionToken': json['sessionToken'],
+        'expiration': (new Date(json['expiration'])),
+        'region': !(0, runtime_1.exists)(json, 'region') ? undefined : json['region'],
+    };
+}
+exports.AWSCredentialsFromJSONTyped = AWSCredentialsFromJSONTyped;
+function AWSCredentialsToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'accessKeyId': value.accessKeyId,
+        'secretAccessKey': value.secretAccessKey,
+        'sessionToken': value.sessionToken,
+        'expiration': (value.expiration.toISOString()),
+        'region': value.region,
+    };
+}
+exports.AWSCredentialsToJSON = AWSCredentialsToJSON;

package/dist/models/FileAccessRequest.d.ts

@@ -27,13 +27,13 @@ export interface FileAccessRequest {
      * @type {string}
      * @memberof FileAccessRequest
      */
-    datasetId: string;
+    datasetId?: string | null;
     /**
      *
      * @type {number}
      * @memberof FileAccessRequest
      */
-    tokenLifetimeHours: number;
+    tokenLifetimeHours?: number | null;
 }
 /**
  * Check if a given object implements the FileAccessRequest interface.

package/dist/models/FileAccessRequest.js

@@ -14,6 +14,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FileAccessRequestToJSON = exports.FileAccessRequestFromJSONTyped = exports.FileAccessRequestFromJSON = exports.instanceOfFileAccessRequest = void 0;
+var runtime_1 = require("../runtime");
 var AccessType_1 = require("./AccessType");
 /**
  * Check if a given object implements the FileAccessRequest interface.
@@ -21,8 +22,6 @@ var AccessType_1 = require("./AccessType");
 function instanceOfFileAccessRequest(value) {
     var isInstance = true;
     isInstance = isInstance && "accessType" in value;
-    isInstance = isInstance && "datasetId" in value;
-    isInstance = isInstance && "tokenLifetimeHours" in value;
     return isInstance;
 }
 exports.instanceOfFileAccessRequest = instanceOfFileAccessRequest;
@@ -36,8 +35,8 @@ function FileAccessRequestFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'accessType': (0, AccessType_1.AccessTypeFromJSON)(json['accessType']),
-        'datasetId': json['datasetId'],
-        'tokenLifetimeHours': json['tokenLifetimeHours'],
+        'datasetId': !(0, runtime_1.exists)(json, 'datasetId') ? undefined : json['datasetId'],
+        'tokenLifetimeHours': !(0, runtime_1.exists)(json, 'tokenLifetimeHours') ? undefined : json['tokenLifetimeHours'],
     };
 }
 exports.FileAccessRequestFromJSONTyped = FileAccessRequestFromJSONTyped;

package/dist/models/index.d.ts

@@ -1,3 +1,4 @@
+export * from './AWSCredentials';
 export * from './AccessType';
 export * from './AllowedDataType';
 export * from './BillingAccount';
@@ -52,7 +53,6 @@ export * from './ReferenceType';
 export * from './RepositoryType';
 export * from './ResourcesInfo';
 export * from './RunAnalysisRequest';
-export * from './S3Credentials';
 export * from './Sample';
 export * from './SampleRequest';
 export * from './ServiceConnection';

package/dist/models/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 /* tslint:disable */
 /* eslint-disable */
+__exportStar(require("./AWSCredentials"), exports);
 __exportStar(require("./AccessType"), exports);
 __exportStar(require("./AllowedDataType"), exports);
 __exportStar(require("./BillingAccount"), exports);
@@ -70,7 +71,6 @@ __exportStar(require("./ReferenceType"), exports);
 __exportStar(require("./RepositoryType"), exports);
 __exportStar(require("./ResourcesInfo"), exports);
 __exportStar(require("./RunAnalysisRequest"), exports);
-__exportStar(require("./S3Credentials"), exports);
 __exportStar(require("./Sample"), exports);
 __exportStar(require("./SampleRequest"), exports);
 __exportStar(require("./ServiceConnection"), exports);

package/package.json

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

package/src/apis/FileApi.ts

@@ -15,18 +15,18 @@
 
 import * as runtime from '../runtime';
 import type {
+  AWSCredentials,
   FileAccessRequest,
   GenerateSftpCredentialsRequest,
-  S3Credentials,
   SftpCredentials,
 } from '../models/index';
 import {
+    AWSCredentialsFromJSON,
+    AWSCredentialsToJSON,
     FileAccessRequestFromJSON,
     FileAccessRequestToJSON,
     GenerateSftpCredentialsRequestFromJSON,
     GenerateSftpCredentialsRequestToJSON,
-    S3CredentialsFromJSON,
-    S3CredentialsToJSON,
     SftpCredentialsFromJSON,
     SftpCredentialsToJSON,
 } from '../models/index';
@@ -50,7 +50,7 @@ export class FileApi extends runtime.BaseAPI {
      * Generates credentials used for connecting via S3
      * Create project file access token
      */
-    async generateProjectFileAccessTokenRaw(requestParameters: GenerateProjectFileAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<S3Credentials>> {
+    async generateProjectFileAccessTokenRaw(requestParameters: GenerateProjectFileAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AWSCredentials>> {
         if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
             throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling generateProjectFileAccessToken.');
         }
@@ -81,14 +81,14 @@ export class FileApi extends runtime.BaseAPI {
             body: FileAccessRequestToJSON(requestParameters.fileAccessRequest),
         }, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => S3CredentialsFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => AWSCredentialsFromJSON(jsonValue));
     }
 
     /**
      * Generates credentials used for connecting via S3
      * Create project file access token
      */
-    async generateProjectFileAccessToken(requestParameters: GenerateProjectFileAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<S3Credentials> {
+    async generateProjectFileAccessToken(requestParameters: GenerateProjectFileAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AWSCredentials> {
         const response = await this.generateProjectFileAccessTokenRaw(requestParameters, initOverrides);
         return await response.value();
     }

package/src/models/{S3Credentials.ts → AWSCredentials.ts}

@@ -16,45 +16,45 @@ import { exists, mapValues } from '../runtime';
 /**
  * 
  * @export
- * @interface S3Credentials
+ * @interface AWSCredentials
  */
-export interface S3Credentials {
+export interface AWSCredentials {
     /**
      * 
      * @type {string}
-     * @memberof S3Credentials
+     * @memberof AWSCredentials
      */
     accessKeyId: string;
     /**
      * 
      * @type {string}
-     * @memberof S3Credentials
+     * @memberof AWSCredentials
      */
     secretAccessKey: string;
     /**
      * 
      * @type {string}
-     * @memberof S3Credentials
+     * @memberof AWSCredentials
      */
     sessionToken: string;
     /**
      * 
      * @type {Date}
-     * @memberof S3Credentials
+     * @memberof AWSCredentials
      */
     expiration: Date;
     /**
-     * Region of S3 Bucket
+     * Region of requested resource (i.e., S3 Bucket)
      * @type {string}
-     * @memberof S3Credentials
+     * @memberof AWSCredentials
      */
     region?: string;
 }
 
 /**
- * Check if a given object implements the S3Credentials interface.
+ * Check if a given object implements the AWSCredentials interface.
  */
-export function instanceOfS3Credentials(value: object): boolean {
+export function instanceOfAWSCredentials(value: object): boolean {
     let isInstance = true;
     isInstance = isInstance && "accessKeyId" in value;
     isInstance = isInstance && "secretAccessKey" in value;
@@ -64,11 +64,11 @@ export function instanceOfS3Credentials(value: object): boolean {
     return isInstance;
 }
 
-export function S3CredentialsFromJSON(json: any): S3Credentials {
-    return S3CredentialsFromJSONTyped(json, false);
+export function AWSCredentialsFromJSON(json: any): AWSCredentials {
+    return AWSCredentialsFromJSONTyped(json, false);
 }
 
-export function S3CredentialsFromJSONTyped(json: any, ignoreDiscriminator: boolean): S3Credentials {
+export function AWSCredentialsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AWSCredentials {
     if ((json === undefined) || (json === null)) {
         return json;
     }
@@ -82,7 +82,7 @@ export function S3CredentialsFromJSONTyped(json: any, ignoreDiscriminator: boole
     };
 }
 
-export function S3CredentialsToJSON(value?: S3Credentials | null): any {
+export function AWSCredentialsToJSON(value?: AWSCredentials | null): any {
     if (value === undefined) {
         return undefined;
     }

package/src/models/FileAccessRequest.ts

@@ -37,13 +37,13 @@ export interface FileAccessRequest {
      * @type {string}
      * @memberof FileAccessRequest
      */
-    datasetId: string;
+    datasetId?: string | null;
     /**
      * 
      * @type {number}
      * @memberof FileAccessRequest
      */
-    tokenLifetimeHours: number;
+    tokenLifetimeHours?: number | null;
 }
 
 /**
@@ -52,8 +52,6 @@ export interface FileAccessRequest {
 export function instanceOfFileAccessRequest(value: object): boolean {
     let isInstance = true;
     isInstance = isInstance && "accessType" in value;
-    isInstance = isInstance && "datasetId" in value;
-    isInstance = isInstance && "tokenLifetimeHours" in value;
 
     return isInstance;
 }
@@ -69,8 +67,8 @@ export function FileAccessRequestFromJSONTyped(json: any, ignoreDiscriminator: b
     return {
         
         'accessType': AccessTypeFromJSON(json['accessType']),
-        'datasetId': json['datasetId'],
-        'tokenLifetimeHours': json['tokenLifetimeHours'],
+        'datasetId': !exists(json, 'datasetId') ? undefined : json['datasetId'],
+        'tokenLifetimeHours': !exists(json, 'tokenLifetimeHours') ? undefined : json['tokenLifetimeHours'],
     };
 }
 

package/src/models/index.ts

@@ -1,5 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
+export * from './AWSCredentials';
 export * from './AccessType';
 export * from './AllowedDataType';
 export * from './BillingAccount';
@@ -54,7 +55,6 @@ export * from './ReferenceType';
 export * from './RepositoryType';
 export * from './ResourcesInfo';
 export * from './RunAnalysisRequest';
-export * from './S3Credentials';
 export * from './Sample';
 export * from './SampleRequest';
 export * from './ServiceConnection';