@cirrobio/api-client 0.2.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/.openapi-generator/FILES +11 -0
  2. package/README.md +1 -1
  3. package/dist/apis/FileApi.d.ts +14 -0
  4. package/dist/apis/FileApi.js +60 -0
  5. package/dist/apis/GovernanceApi.d.ts +127 -1
  6. package/dist/apis/GovernanceApi.js +555 -1
  7. package/dist/apis/SharingApi.d.ts +5 -3
  8. package/dist/apis/SharingApi.js +7 -1
  9. package/dist/models/AccessType.d.ts +3 -1
  10. package/dist/models/AccessType.js +2 -0
  11. package/dist/models/ClassificationInput.d.ts +6 -0
  12. package/dist/models/ClassificationInput.js +3 -0
  13. package/dist/models/ContactInput.d.ts +55 -0
  14. package/dist/models/ContactInput.js +62 -0
  15. package/dist/models/GovernanceClassification.d.ts +6 -0
  16. package/dist/models/GovernanceClassification.js +3 -0
  17. package/dist/models/GovernanceContact.d.ts +61 -0
  18. package/dist/models/GovernanceContact.js +65 -0
  19. package/dist/models/GovernanceExpiry.d.ts +44 -0
  20. package/dist/models/GovernanceExpiry.js +55 -0
  21. package/dist/models/GovernanceExpiryType.d.ts +25 -0
  22. package/dist/models/GovernanceExpiryType.js +40 -0
  23. package/dist/models/GovernanceFile.d.ts +50 -0
  24. package/dist/models/GovernanceFile.js +57 -0
  25. package/dist/models/GovernanceFileType.d.ts +23 -0
  26. package/dist/models/GovernanceFileType.js +38 -0
  27. package/dist/models/GovernanceRequirement.d.ts +108 -0
  28. package/dist/models/GovernanceRequirement.js +81 -0
  29. package/dist/models/GovernanceRequirementFile.d.ts +50 -0
  30. package/dist/models/GovernanceRequirementFile.js +57 -0
  31. package/dist/models/GovernanceScope.d.ts +23 -0
  32. package/dist/models/GovernanceScope.js +38 -0
  33. package/dist/models/GovernanceTrainingVerification.d.ts +23 -0
  34. package/dist/models/GovernanceTrainingVerification.js +38 -0
  35. package/dist/models/GovernanceType.d.ts +26 -0
  36. package/dist/models/GovernanceType.js +41 -0
  37. package/dist/models/RequirementInput.d.ts +96 -0
  38. package/dist/models/RequirementInput.js +81 -0
  39. package/dist/models/ShareDetail.d.ts +1 -1
  40. package/dist/models/ShareDetail.js +3 -3
  41. package/dist/models/index.d.ts +11 -0
  42. package/dist/models/index.js +11 -0
  43. package/dist/runtime.js +1 -1
  44. package/package.json +1 -1
  45. package/src/apis/FileApi.ts +52 -0
  46. package/src/apis/GovernanceApi.ts +457 -1
  47. package/src/apis/SharingApi.ts +16 -6
  48. package/src/models/AccessType.ts +3 -1
  49. package/src/models/ClassificationInput.ts +9 -0
  50. package/src/models/ContactInput.ts +102 -0
  51. package/src/models/GovernanceClassification.ts +9 -0
  52. package/src/models/GovernanceContact.ts +111 -0
  53. package/src/models/GovernanceExpiry.ts +88 -0
  54. package/src/models/GovernanceExpiryType.ts +39 -0
  55. package/src/models/GovernanceFile.ts +96 -0
  56. package/src/models/GovernanceFileType.ts +37 -0
  57. package/src/models/GovernanceRequirement.ts +194 -0
  58. package/src/models/GovernanceRequirementFile.ts +96 -0
  59. package/src/models/GovernanceScope.ts +37 -0
  60. package/src/models/GovernanceTrainingVerification.ts +37 -0
  61. package/src/models/GovernanceType.ts +40 -0
  62. package/src/models/RequirementInput.ts +182 -0
  63. package/src/models/ShareDetail.ts +4 -3
  64. package/src/models/index.ts +11 -0
  65. package/src/runtime.ts +1 -1
@@ -45,6 +45,7 @@ src/models/ColumnDefinition.ts
45
45
  src/models/ComputeEnvironmentConfiguration.ts
46
46
  src/models/ComputeEnvironmentConfigurationInput.ts
47
47
  src/models/Contact.ts
48
+ src/models/ContactInput.ts
48
49
  src/models/CreateNotebookInstanceRequest.ts
49
50
  src/models/CreateProjectAccessRequest.ts
50
51
  src/models/CreateReferenceRequest.ts
@@ -72,6 +73,15 @@ src/models/FormSchema.ts
72
73
  src/models/GenerateSftpCredentialsRequest.ts
73
74
  src/models/GetExecutionLogsResponse.ts
74
75
  src/models/GovernanceClassification.ts
76
+ src/models/GovernanceContact.ts
77
+ src/models/GovernanceExpiry.ts
78
+ src/models/GovernanceExpiryType.ts
79
+ src/models/GovernanceFile.ts
80
+ src/models/GovernanceFileType.ts
81
+ src/models/GovernanceRequirement.ts
82
+ src/models/GovernanceScope.ts
83
+ src/models/GovernanceTrainingVerification.ts
84
+ src/models/GovernanceType.ts
75
85
  src/models/ImportDataRequest.ts
76
86
  src/models/InviteUserRequest.ts
77
87
  src/models/InviteUserResponse.ts
@@ -106,6 +116,7 @@ src/models/Reference.ts
106
116
  src/models/ReferenceType.ts
107
117
  src/models/RepositoryType.ts
108
118
  src/models/RequestStatus.ts
119
+ src/models/RequirementInput.ts
109
120
  src/models/ResourcesInfo.ts
110
121
  src/models/RunAnalysisRequest.ts
111
122
  src/models/Sample.ts
package/README.md CHANGED
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @cirrobio/api-client@0.2.0 --save
39
+ npm install @cirrobio/api-client@0.2.1 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -11,6 +11,10 @@
11
11
  */
12
12
  import * as runtime from '../runtime';
13
13
  import type { AWSCredentials, FileAccessRequest, GenerateSftpCredentialsRequest, SftpCredentials } from '../models/index';
14
+ export interface GenerateGovernanceFileAccessTokenRequest {
15
+ requirementId: string;
16
+ fileAccessRequest: FileAccessRequest;
17
+ }
14
18
  export interface GenerateProjectFileAccessTokenRequest {
15
19
  projectId: string;
16
20
  fileAccessRequest: FileAccessRequest;
@@ -23,6 +27,16 @@ export interface GenerateProjectSftpTokenRequest {
23
27
  *
24
28
  */
25
29
  export declare class FileApi extends runtime.BaseAPI {
30
+ /**
31
+ * Generates credentials used for connecting via S3
32
+ * Create governance file access token
33
+ */
34
+ generateGovernanceFileAccessTokenRaw(requestParameters: GenerateGovernanceFileAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AWSCredentials>>;
35
+ /**
36
+ * Generates credentials used for connecting via S3
37
+ * Create governance file access token
38
+ */
39
+ generateGovernanceFileAccessToken(requestParameters: GenerateGovernanceFileAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AWSCredentials>;
26
40
  /**
27
41
  * Generates credentials used for connecting via S3
28
42
  * Create project file access token
@@ -75,6 +75,66 @@ var FileApi = /** @class */ (function (_super) {
75
75
  function FileApi() {
76
76
  return _super !== null && _super.apply(this, arguments) || this;
77
77
  }
78
+ /**
79
+ * Generates credentials used for connecting via S3
80
+ * Create governance file access token
81
+ */
82
+ FileApi.prototype.generateGovernanceFileAccessTokenRaw = function (requestParameters, initOverrides) {
83
+ return __awaiter(this, void 0, void 0, function () {
84
+ var queryParameters, headerParameters, token, tokenString, response;
85
+ return __generator(this, function (_a) {
86
+ switch (_a.label) {
87
+ case 0:
88
+ if (requestParameters.requirementId === null || requestParameters.requirementId === undefined) {
89
+ throw new runtime.RequiredError('requirementId', 'Required parameter requestParameters.requirementId was null or undefined when calling generateGovernanceFileAccessToken.');
90
+ }
91
+ if (requestParameters.fileAccessRequest === null || requestParameters.fileAccessRequest === undefined) {
92
+ throw new runtime.RequiredError('fileAccessRequest', 'Required parameter requestParameters.fileAccessRequest was null or undefined when calling generateGovernanceFileAccessToken.');
93
+ }
94
+ queryParameters = {};
95
+ headerParameters = {};
96
+ headerParameters['Content-Type'] = 'application/json';
97
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
98
+ token = this.configuration.accessToken;
99
+ return [4 /*yield*/, token("accessToken", [])];
100
+ case 1:
101
+ tokenString = _a.sent();
102
+ if (tokenString) {
103
+ headerParameters["Authorization"] = "Bearer ".concat(tokenString);
104
+ }
105
+ _a.label = 2;
106
+ case 2: return [4 /*yield*/, this.request({
107
+ path: "/governance/requirements/{requirementId}/s3-token".replace("{".concat("requirementId", "}"), encodeURIComponent(String(requestParameters.requirementId))),
108
+ method: 'POST',
109
+ headers: headerParameters,
110
+ query: queryParameters,
111
+ body: (0, index_1.FileAccessRequestToJSON)(requestParameters.fileAccessRequest),
112
+ }, initOverrides)];
113
+ case 3:
114
+ response = _a.sent();
115
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.AWSCredentialsFromJSON)(jsonValue); })];
116
+ }
117
+ });
118
+ });
119
+ };
120
+ /**
121
+ * Generates credentials used for connecting via S3
122
+ * Create governance file access token
123
+ */
124
+ FileApi.prototype.generateGovernanceFileAccessToken = function (requestParameters, initOverrides) {
125
+ return __awaiter(this, void 0, void 0, function () {
126
+ var response;
127
+ return __generator(this, function (_a) {
128
+ switch (_a.label) {
129
+ case 0: return [4 /*yield*/, this.generateGovernanceFileAccessTokenRaw(requestParameters, initOverrides)];
130
+ case 1:
131
+ response = _a.sent();
132
+ return [4 /*yield*/, response.value()];
133
+ case 2: return [2 /*return*/, _a.sent()];
134
+ }
135
+ });
136
+ });
137
+ };
78
138
  /**
79
139
  * Generates credentials used for connecting via S3
80
140
  * Create project file access token
@@ -10,20 +10,46 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { ClassificationInput, GovernanceClassification } from '../models/index';
13
+ import type { ClassificationInput, ContactInput, GovernanceClassification, GovernanceContact, GovernanceRequirement, RequirementInput } from '../models/index';
14
14
  export interface CreateClassificationRequest {
15
15
  classificationInput: ClassificationInput;
16
16
  }
17
+ export interface CreateContactRequest {
18
+ contactInput: ContactInput;
19
+ }
20
+ export interface CreateRequirementRequest {
21
+ requirementInput: RequirementInput;
22
+ }
17
23
  export interface DeleteClassificationRequest {
18
24
  classificationId: string;
19
25
  }
26
+ export interface DeleteContactRequest {
27
+ contactId: string;
28
+ }
29
+ export interface DeleteRequirementRequest {
30
+ requirementId: string;
31
+ }
20
32
  export interface GetClassificationRequest {
21
33
  classificationId: string;
22
34
  }
35
+ export interface GetContactRequest {
36
+ contactId: string;
37
+ }
38
+ export interface GetRequirementRequest {
39
+ requirementId: string;
40
+ }
23
41
  export interface UpdateClassificationRequest {
24
42
  classificationId: string;
25
43
  classificationInput: ClassificationInput;
26
44
  }
45
+ export interface UpdateContactRequest {
46
+ contactId: string;
47
+ contactInput: ContactInput;
48
+ }
49
+ export interface UpdateRequirementRequest {
50
+ requirementId: string;
51
+ requirementInput: RequirementInput;
52
+ }
27
53
  /**
28
54
  *
29
55
  */
@@ -38,6 +64,26 @@ export declare class GovernanceApi extends runtime.BaseAPI {
38
64
  * Create classification
39
65
  */
40
66
  createClassification(requestParameters: CreateClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceClassification>;
67
+ /**
68
+ * Creates a contact
69
+ * Create contact
70
+ */
71
+ createContactRaw(requestParameters: CreateContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceContact>>;
72
+ /**
73
+ * Creates a contact
74
+ * Create contact
75
+ */
76
+ createContact(requestParameters: CreateContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceContact>;
77
+ /**
78
+ * Creates a requirement
79
+ * Create requirement
80
+ */
81
+ createRequirementRaw(requestParameters: CreateRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceRequirement>>;
82
+ /**
83
+ * Creates a requirement
84
+ * Create requirement
85
+ */
86
+ createRequirement(requestParameters: CreateRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceRequirement>;
41
87
  /**
42
88
  * Deletes the classification, and removes it from all projects.
43
89
  * Delete a classification
@@ -48,6 +94,26 @@ export declare class GovernanceApi extends runtime.BaseAPI {
48
94
  * Delete a classification
49
95
  */
50
96
  deleteClassification(requestParameters: DeleteClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
97
+ /**
98
+ * Deletes the contact, and removes it from all governance requirements.
99
+ * Delete a contact
100
+ */
101
+ deleteContactRaw(requestParameters: DeleteContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
102
+ /**
103
+ * Deletes the contact, and removes it from all governance requirements.
104
+ * Delete a contact
105
+ */
106
+ deleteContact(requestParameters: DeleteContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
107
+ /**
108
+ * Deletes the requirement, and removes it from all governance fulfillments and classifications.
109
+ * Delete a requirement
110
+ */
111
+ deleteRequirementRaw(requestParameters: DeleteRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
112
+ /**
113
+ * Deletes the requirement, and removes it from all governance fulfillments and classifications.
114
+ * Delete a requirement
115
+ */
116
+ deleteRequirement(requestParameters: DeleteRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
51
117
  /**
52
118
  * Retrieve a data classification
53
119
  * Get a classification
@@ -68,6 +134,46 @@ export declare class GovernanceApi extends runtime.BaseAPI {
68
134
  * Get classifications
69
135
  */
70
136
  getClassifications(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GovernanceClassification>>;
137
+ /**
138
+ * Retrieve a governance contact
139
+ * Get a contact
140
+ */
141
+ getContactRaw(requestParameters: GetContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceContact>>;
142
+ /**
143
+ * Retrieve a governance contact
144
+ * Get a contact
145
+ */
146
+ getContact(requestParameters: GetContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceContact>;
147
+ /**
148
+ * Retrieve a list of governance contacts
149
+ * Get contacts
150
+ */
151
+ getContactsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GovernanceContact>>>;
152
+ /**
153
+ * Retrieve a list of governance contacts
154
+ * Get contacts
155
+ */
156
+ getContacts(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GovernanceContact>>;
157
+ /**
158
+ * Retrieve a governance requirement
159
+ * Get a requirement
160
+ */
161
+ getRequirementRaw(requestParameters: GetRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceRequirement>>;
162
+ /**
163
+ * Retrieve a governance requirement
164
+ * Get a requirement
165
+ */
166
+ getRequirement(requestParameters: GetRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceRequirement>;
167
+ /**
168
+ * Retrieve a list of governance requirements
169
+ * Get requirements
170
+ */
171
+ getRequirementsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GovernanceRequirement>>>;
172
+ /**
173
+ * Retrieve a list of governance requirements
174
+ * Get requirements
175
+ */
176
+ getRequirements(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GovernanceRequirement>>;
71
177
  /**
72
178
  * Updates a classification
73
179
  * Update classification
@@ -78,4 +184,24 @@ export declare class GovernanceApi extends runtime.BaseAPI {
78
184
  * Update classification
79
185
  */
80
186
  updateClassification(requestParameters: UpdateClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceClassification>;
187
+ /**
188
+ * Updates a contact
189
+ * Update contact
190
+ */
191
+ updateContactRaw(requestParameters: UpdateContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceContact>>;
192
+ /**
193
+ * Updates a contact
194
+ * Update contact
195
+ */
196
+ updateContact(requestParameters: UpdateContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceContact>;
197
+ /**
198
+ * Updates a requirement
199
+ * Update requirement
200
+ */
201
+ updateRequirementRaw(requestParameters: UpdateRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceRequirement>>;
202
+ /**
203
+ * Updates a requirement
204
+ * Update requirement
205
+ */
206
+ updateRequirement(requestParameters: UpdateRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceRequirement>;
81
207
  }