@cirrobio/api-client 0.2.0 → 0.2.2

package/.openapi-generator/FILES

@@ -45,6 +45,7 @@ src/models/ColumnDefinition.ts
 src/models/ComputeEnvironmentConfiguration.ts
 src/models/ComputeEnvironmentConfigurationInput.ts
 src/models/Contact.ts
+src/models/ContactInput.ts
 src/models/CreateNotebookInstanceRequest.ts
 src/models/CreateProjectAccessRequest.ts
 src/models/CreateReferenceRequest.ts
@@ -72,6 +73,15 @@ src/models/FormSchema.ts
 src/models/GenerateSftpCredentialsRequest.ts
 src/models/GetExecutionLogsResponse.ts
 src/models/GovernanceClassification.ts
+src/models/GovernanceContact.ts
+src/models/GovernanceExpiry.ts
+src/models/GovernanceExpiryType.ts
+src/models/GovernanceFile.ts
+src/models/GovernanceFileType.ts
+src/models/GovernanceRequirement.ts
+src/models/GovernanceScope.ts
+src/models/GovernanceTrainingVerification.ts
+src/models/GovernanceType.ts
 src/models/ImportDataRequest.ts
 src/models/InviteUserRequest.ts
 src/models/InviteUserResponse.ts
@@ -106,6 +116,7 @@ src/models/Reference.ts
 src/models/ReferenceType.ts
 src/models/RepositoryType.ts
 src/models/RequestStatus.ts
+src/models/RequirementInput.ts
 src/models/ResourcesInfo.ts
 src/models/RunAnalysisRequest.ts
 src/models/Sample.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.2.0 --save
+npm install @cirrobio/api-client@0.2.2 --save
 ```
 
 _unPublished (not recommended):_

package/dist/apis/DatasetsApi.d.ts

@@ -110,32 +110,32 @@ export declare class DatasetsApi extends runtime.BaseAPI {
      */
     importPublicDataset(requestParameters: ImportPublicDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
     /**
-     * Rerun sample ingest (TODO).
+     * Rerun sample ingest.
      * Rerun sample ingest
      */
     ingestSamplesRaw(requestParameters: IngestSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Rerun sample ingest (TODO).
+     * Rerun sample ingest.
      * Rerun sample ingest
      */
     ingestSamples(requestParameters: IngestSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Regenerate dataset manifest (TODO).
+     * Regenerate dataset file listing.
      * Regenerate dataset manifest
      */
     regenerateManifestRaw(requestParameters: RegenerateManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Regenerate dataset manifest (TODO).
+     * Regenerate dataset file listing.
      * Regenerate dataset manifest
      */
     regenerateManifest(requestParameters: RegenerateManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Rerun data transforms (TODO).
+     * Rerun data transforms and web optimization.
      * Rerun data transforms
      */
     rerunTransformRaw(requestParameters: RerunTransformRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Rerun data transforms (TODO).
+     * Rerun data transforms and web optimization.
      * Rerun data transforms
      */
     rerunTransform(requestParameters: RerunTransformRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;

package/dist/apis/DatasetsApi.js

@@ -375,7 +375,7 @@ var DatasetsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Rerun sample ingest (TODO).
+     * Rerun sample ingest.
      * Rerun sample ingest
      */
     DatasetsApi.prototype.ingestSamplesRaw = function (requestParameters, initOverrides) {
@@ -415,7 +415,7 @@ var DatasetsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Rerun sample ingest (TODO).
+     * Rerun sample ingest.
      * Rerun sample ingest
      */
     DatasetsApi.prototype.ingestSamples = function (requestParameters, initOverrides) {
@@ -431,7 +431,7 @@ var DatasetsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Regenerate dataset manifest (TODO).
+     * Regenerate dataset file listing.
      * Regenerate dataset manifest
      */
     DatasetsApi.prototype.regenerateManifestRaw = function (requestParameters, initOverrides) {
@@ -471,7 +471,7 @@ var DatasetsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Regenerate dataset manifest (TODO).
+     * Regenerate dataset file listing.
      * Regenerate dataset manifest
      */
     DatasetsApi.prototype.regenerateManifest = function (requestParameters, initOverrides) {
@@ -487,7 +487,7 @@ var DatasetsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Rerun data transforms (TODO).
+     * Rerun data transforms and web optimization.
      * Rerun data transforms
      */
     DatasetsApi.prototype.rerunTransformRaw = function (requestParameters, initOverrides) {
@@ -527,7 +527,7 @@ var DatasetsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Rerun data transforms (TODO).
+     * Rerun data transforms and web optimization.
      * Rerun data transforms
      */
     DatasetsApi.prototype.rerunTransform = function (requestParameters, initOverrides) {

package/dist/apis/FileApi.d.ts

@@ -11,6 +11,10 @@
  */
 import * as runtime from '../runtime';
 import type { AWSCredentials, FileAccessRequest, GenerateSftpCredentialsRequest, SftpCredentials } from '../models/index';
+export interface GenerateGovernanceFileAccessTokenRequest {
+    requirementId: string;
+    fileAccessRequest: FileAccessRequest;
+}
 export interface GenerateProjectFileAccessTokenRequest {
     projectId: string;
     fileAccessRequest: FileAccessRequest;
@@ -23,6 +27,16 @@ export interface GenerateProjectSftpTokenRequest {
  *
  */
 export declare class FileApi extends runtime.BaseAPI {
+    /**
+     * Generates credentials used for connecting via S3
+     * Create governance file access token
+     */
+    generateGovernanceFileAccessTokenRaw(requestParameters: GenerateGovernanceFileAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AWSCredentials>>;
+    /**
+     * Generates credentials used for connecting via S3
+     * Create governance file access token
+     */
+    generateGovernanceFileAccessToken(requestParameters: GenerateGovernanceFileAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AWSCredentials>;
     /**
      * Generates credentials used for connecting via S3
      * Create project file access token

package/dist/apis/FileApi.js

@@ -75,6 +75,66 @@ var FileApi = /** @class */ (function (_super) {
     function FileApi() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    /**
+     * Generates credentials used for connecting via S3
+     * Create governance file access token
+     */
+    FileApi.prototype.generateGovernanceFileAccessTokenRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (requestParameters.requirementId === null || requestParameters.requirementId === undefined) {
+                            throw new runtime.RequiredError('requirementId', 'Required parameter requestParameters.requirementId was null or undefined when calling generateGovernanceFileAccessToken.');
+                        }
+                        if (requestParameters.fileAccessRequest === null || requestParameters.fileAccessRequest === undefined) {
+                            throw new runtime.RequiredError('fileAccessRequest', 'Required parameter requestParameters.fileAccessRequest was null or undefined when calling generateGovernanceFileAccessToken.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("accessToken", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, this.request({
+                            path: "/governance/requirements/{requirementId}/s3-token".replace("{".concat("requirementId", "}"), encodeURIComponent(String(requestParameters.requirementId))),
+                            method: 'POST',
+                            headers: headerParameters,
+                            query: queryParameters,
+                            body: (0, index_1.FileAccessRequestToJSON)(requestParameters.fileAccessRequest),
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.AWSCredentialsFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Generates credentials used for connecting via S3
+     * Create governance file access token
+     */
+    FileApi.prototype.generateGovernanceFileAccessToken = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.generateGovernanceFileAccessTokenRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Generates credentials used for connecting via S3
      * Create project file access token

package/dist/apis/GovernanceApi.d.ts

@@ -10,20 +10,46 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { ClassificationInput, GovernanceClassification } from '../models/index';
+import type { ClassificationInput, ContactInput, GovernanceClassification, GovernanceContact, GovernanceRequirement, RequirementInput } from '../models/index';
 export interface CreateClassificationRequest {
     classificationInput: ClassificationInput;
 }
+export interface CreateContactRequest {
+    contactInput: ContactInput;
+}
+export interface CreateRequirementRequest {
+    requirementInput: RequirementInput;
+}
 export interface DeleteClassificationRequest {
     classificationId: string;
 }
+export interface DeleteContactRequest {
+    contactId: string;
+}
+export interface DeleteRequirementRequest {
+    requirementId: string;
+}
 export interface GetClassificationRequest {
     classificationId: string;
 }
+export interface GetContactRequest {
+    contactId: string;
+}
+export interface GetRequirementRequest {
+    requirementId: string;
+}
 export interface UpdateClassificationRequest {
     classificationId: string;
     classificationInput: ClassificationInput;
 }
+export interface UpdateContactRequest {
+    contactId: string;
+    contactInput: ContactInput;
+}
+export interface UpdateRequirementRequest {
+    requirementId: string;
+    requirementInput: RequirementInput;
+}
 /**
  *
  */
@@ -38,6 +64,26 @@ export declare class GovernanceApi extends runtime.BaseAPI {
      * Create classification
      */
     createClassification(requestParameters: CreateClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceClassification>;
+    /**
+     * Creates a contact
+     * Create contact
+     */
+    createContactRaw(requestParameters: CreateContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceContact>>;
+    /**
+     * Creates a contact
+     * Create contact
+     */
+    createContact(requestParameters: CreateContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceContact>;
+    /**
+     * Creates a requirement
+     * Create requirement
+     */
+    createRequirementRaw(requestParameters: CreateRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceRequirement>>;
+    /**
+     * Creates a requirement
+     * Create requirement
+     */
+    createRequirement(requestParameters: CreateRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceRequirement>;
     /**
      * Deletes the classification, and removes it from all projects.
      * Delete a classification
@@ -48,6 +94,26 @@ export declare class GovernanceApi extends runtime.BaseAPI {
      * Delete a classification
      */
     deleteClassification(requestParameters: DeleteClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Deletes the contact, and removes it from all governance requirements.
+     * Delete a contact
+     */
+    deleteContactRaw(requestParameters: DeleteContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes the contact, and removes it from all governance requirements.
+     * Delete a contact
+     */
+    deleteContact(requestParameters: DeleteContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Deletes the requirement, and removes it from all governance fulfillments and classifications.
+     * Delete a requirement
+     */
+    deleteRequirementRaw(requestParameters: DeleteRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes the requirement, and removes it from all governance fulfillments and classifications.
+     * Delete a requirement
+     */
+    deleteRequirement(requestParameters: DeleteRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Retrieve a data classification
      * Get a classification
@@ -68,6 +134,46 @@ export declare class GovernanceApi extends runtime.BaseAPI {
      * Get classifications
      */
     getClassifications(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GovernanceClassification>>;
+    /**
+     * Retrieve a governance contact
+     * Get a contact
+     */
+    getContactRaw(requestParameters: GetContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceContact>>;
+    /**
+     * Retrieve a governance contact
+     * Get a contact
+     */
+    getContact(requestParameters: GetContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceContact>;
+    /**
+     * Retrieve a list of governance contacts
+     * Get contacts
+     */
+    getContactsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GovernanceContact>>>;
+    /**
+     * Retrieve a list of governance contacts
+     * Get contacts
+     */
+    getContacts(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GovernanceContact>>;
+    /**
+     * Retrieve a governance requirement
+     * Get a requirement
+     */
+    getRequirementRaw(requestParameters: GetRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceRequirement>>;
+    /**
+     * Retrieve a governance requirement
+     * Get a requirement
+     */
+    getRequirement(requestParameters: GetRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceRequirement>;
+    /**
+     * Retrieve a list of governance requirements
+     * Get requirements
+     */
+    getRequirementsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GovernanceRequirement>>>;
+    /**
+     * Retrieve a list of governance requirements
+     * Get requirements
+     */
+    getRequirements(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GovernanceRequirement>>;
     /**
      * Updates a classification
      * Update classification
@@ -78,4 +184,24 @@ export declare class GovernanceApi extends runtime.BaseAPI {
      * Update classification
      */
     updateClassification(requestParameters: UpdateClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceClassification>;
+    /**
+     * Updates a contact
+     * Update contact
+     */
+    updateContactRaw(requestParameters: UpdateContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceContact>>;
+    /**
+     * Updates a contact
+     * Update contact
+     */
+    updateContact(requestParameters: UpdateContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceContact>;
+    /**
+     * Updates a requirement
+     * Update requirement
+     */
+    updateRequirementRaw(requestParameters: UpdateRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceRequirement>>;
+    /**
+     * Updates a requirement
+     * Update requirement
+     */
+    updateRequirement(requestParameters: UpdateRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceRequirement>;
 }