@cirrobio/api-client 0.0.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 (155) hide show
  1. package/.openapi-generator/FILES +54 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +45 -0
  5. package/dist/apis/BillingApi.d.ts +68 -0
  6. package/dist/apis/BillingApi.js +264 -0
  7. package/dist/apis/DatasetsApi.d.ts +88 -0
  8. package/dist/apis/DatasetsApi.js +335 -0
  9. package/dist/apis/ExecutionApi.d.ts +96 -0
  10. package/dist/apis/ExecutionApi.js +394 -0
  11. package/dist/apis/MetricsApi.d.ts +31 -0
  12. package/dist/apis/MetricsApi.js +126 -0
  13. package/dist/apis/NotebooksApi.d.ts +77 -0
  14. package/dist/apis/NotebooksApi.js +351 -0
  15. package/dist/apis/ProcessesApi.d.ts +41 -0
  16. package/dist/apis/ProcessesApi.js +169 -0
  17. package/dist/apis/ProjectsApi.d.ts +97 -0
  18. package/dist/apis/ProjectsApi.js +369 -0
  19. package/dist/apis/SystemApi.d.ts +46 -0
  20. package/dist/apis/SystemApi.js +207 -0
  21. package/dist/apis/UsersApi.d.ts +58 -0
  22. package/dist/apis/UsersApi.js +226 -0
  23. package/dist/apis/index.d.ts +9 -0
  24. package/dist/apis/index.js +27 -0
  25. package/dist/index.d.ts +3 -0
  26. package/dist/index.js +21 -0
  27. package/dist/models/BillingAccount.d.ts +82 -0
  28. package/dist/models/BillingAccount.js +77 -0
  29. package/dist/models/BillingMethod.d.ts +24 -0
  30. package/dist/models/BillingMethod.js +37 -0
  31. package/dist/models/BudgetPeriod.d.ts +24 -0
  32. package/dist/models/BudgetPeriod.js +37 -0
  33. package/dist/models/CloudAccount.d.ts +50 -0
  34. package/dist/models/CloudAccount.js +57 -0
  35. package/dist/models/Contact.d.ts +49 -0
  36. package/dist/models/Contact.js +56 -0
  37. package/dist/models/CreateNotebookInstanceRequest.d.ts +49 -0
  38. package/dist/models/CreateNotebookInstanceRequest.js +59 -0
  39. package/dist/models/CreateResponse.d.ts +37 -0
  40. package/dist/models/CreateResponse.js +53 -0
  41. package/dist/models/CustomerType.d.ts +25 -0
  42. package/dist/models/CustomerType.js +38 -0
  43. package/dist/models/Dataset.d.ts +86 -0
  44. package/dist/models/Dataset.js +78 -0
  45. package/dist/models/DatasetDetail.d.ts +114 -0
  46. package/dist/models/DatasetDetail.js +90 -0
  47. package/dist/models/DatasetType.d.ts +23 -0
  48. package/dist/models/DatasetType.js +36 -0
  49. package/dist/models/Executor.d.ts +24 -0
  50. package/dist/models/Executor.js +37 -0
  51. package/dist/models/FormSchema.d.ts +41 -0
  52. package/dist/models/FormSchema.js +52 -0
  53. package/dist/models/GetExecutionLogsResponse.d.ts +32 -0
  54. package/dist/models/GetExecutionLogsResponse.js +51 -0
  55. package/dist/models/LogEntry.d.ts +37 -0
  56. package/dist/models/LogEntry.js +53 -0
  57. package/dist/models/NotebookInstance.d.ts +43 -0
  58. package/dist/models/NotebookInstance.js +56 -0
  59. package/dist/models/OpenNotebookInstanceResponse.d.ts +37 -0
  60. package/dist/models/OpenNotebookInstanceResponse.js +53 -0
  61. package/dist/models/Process.d.ts +68 -0
  62. package/dist/models/Process.js +63 -0
  63. package/dist/models/Project.d.ts +49 -0
  64. package/dist/models/Project.js +59 -0
  65. package/dist/models/ProjectDetail.d.ts +100 -0
  66. package/dist/models/ProjectDetail.js +86 -0
  67. package/dist/models/ProjectMetrics.d.ts +47 -0
  68. package/dist/models/ProjectMetrics.js +56 -0
  69. package/dist/models/ProjectRequest.d.ts +71 -0
  70. package/dist/models/ProjectRequest.js +72 -0
  71. package/dist/models/ProjectRole.d.ts +25 -0
  72. package/dist/models/ProjectRole.js +38 -0
  73. package/dist/models/ProjectSettings.d.ts +92 -0
  74. package/dist/models/ProjectSettings.js +71 -0
  75. package/dist/models/ReferenceType.d.ts +31 -0
  76. package/dist/models/ReferenceType.js +50 -0
  77. package/dist/models/Region.d.ts +31 -0
  78. package/dist/models/Region.js +50 -0
  79. package/dist/models/RegisterDatasetRequest.d.ts +31 -0
  80. package/dist/models/RegisterDatasetRequest.js +50 -0
  81. package/dist/models/ServiceConnection.d.ts +31 -0
  82. package/dist/models/ServiceConnection.js +50 -0
  83. package/dist/models/SetUserProjectRoleRequest.d.ts +31 -0
  84. package/dist/models/SetUserProjectRoleRequest.js +50 -0
  85. package/dist/models/StopExecutionResponse.d.ts +37 -0
  86. package/dist/models/StopExecutionResponse.js +52 -0
  87. package/dist/models/SystemInfoResponse.d.ts +55 -0
  88. package/dist/models/SystemInfoResponse.js +62 -0
  89. package/dist/models/Tag.d.ts +37 -0
  90. package/dist/models/Tag.js +53 -0
  91. package/dist/models/Task.d.ts +73 -0
  92. package/dist/models/Task.js +68 -0
  93. package/dist/models/UpdateDatasetRequest.d.ts +31 -0
  94. package/dist/models/UpdateDatasetRequest.js +50 -0
  95. package/dist/models/UpdateUserRequest.d.ts +57 -0
  96. package/dist/models/UpdateUserRequest.js +62 -0
  97. package/dist/models/User.d.ts +49 -0
  98. package/dist/models/User.js +59 -0
  99. package/dist/models/index.d.ts +36 -0
  100. package/dist/models/index.js +54 -0
  101. package/dist/runtime.d.ts +182 -0
  102. package/dist/runtime.js +562 -0
  103. package/package.json +22 -0
  104. package/src/apis/BillingApi.ts +178 -0
  105. package/src/apis/DatasetsApi.ts +257 -0
  106. package/src/apis/ExecutionApi.ts +317 -0
  107. package/src/apis/MetricsApi.ts +66 -0
  108. package/src/apis/NotebooksApi.ts +261 -0
  109. package/src/apis/ProcessesApi.ts +97 -0
  110. package/src/apis/ProjectsApi.ts +283 -0
  111. package/src/apis/SystemApi.ts +118 -0
  112. package/src/apis/UsersApi.ts +153 -0
  113. package/src/apis/index.ts +11 -0
  114. package/src/index.ts +5 -0
  115. package/src/models/BillingAccount.ts +157 -0
  116. package/src/models/BillingMethod.ts +39 -0
  117. package/src/models/BudgetPeriod.ts +39 -0
  118. package/src/models/CloudAccount.ts +96 -0
  119. package/src/models/Contact.ts +89 -0
  120. package/src/models/CreateNotebookInstanceRequest.ts +93 -0
  121. package/src/models/CreateResponse.ts +75 -0
  122. package/src/models/CustomerType.ts +40 -0
  123. package/src/models/Dataset.ts +154 -0
  124. package/src/models/DatasetDetail.ts +190 -0
  125. package/src/models/DatasetType.ts +38 -0
  126. package/src/models/Executor.ts +39 -0
  127. package/src/models/FormSchema.ts +73 -0
  128. package/src/models/GetExecutionLogsResponse.ts +73 -0
  129. package/src/models/LogEntry.ts +74 -0
  130. package/src/models/NotebookInstance.ts +84 -0
  131. package/src/models/OpenNotebookInstanceResponse.ts +75 -0
  132. package/src/models/Process.ts +120 -0
  133. package/src/models/Project.ts +93 -0
  134. package/src/models/ProjectDetail.ts +184 -0
  135. package/src/models/ProjectMetrics.ts +84 -0
  136. package/src/models/ProjectRequest.ts +145 -0
  137. package/src/models/ProjectRole.ts +40 -0
  138. package/src/models/ProjectSettings.ts +152 -0
  139. package/src/models/ReferenceType.ts +66 -0
  140. package/src/models/Region.ts +65 -0
  141. package/src/models/RegisterDatasetRequest.ts +65 -0
  142. package/src/models/ServiceConnection.ts +66 -0
  143. package/src/models/SetUserProjectRoleRequest.ts +65 -0
  144. package/src/models/StopExecutionResponse.ts +73 -0
  145. package/src/models/SystemInfoResponse.ts +102 -0
  146. package/src/models/Tag.ts +75 -0
  147. package/src/models/Task.ts +125 -0
  148. package/src/models/UpdateDatasetRequest.ts +65 -0
  149. package/src/models/UpdateUserRequest.ts +102 -0
  150. package/src/models/User.ts +93 -0
  151. package/src/models/index.ts +38 -0
  152. package/src/runtime.ts +431 -0
  153. package/templates/README.mustache +45 -0
  154. package/templates/package.mustache +43 -0
  155. package/tsconfig.json +20 -0
@@ -0,0 +1,317 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Cirro Data
5
+ * Cirro Data Platform service API
6
+ *
7
+ * The version of the OpenAPI document: latest
8
+ * Contact: support@cirro.bio
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import * as runtime from '../runtime';
17
+ import type {
18
+ GetExecutionLogsResponse,
19
+ StopExecutionResponse,
20
+ Task,
21
+ } from '../models/index';
22
+ import {
23
+ GetExecutionLogsResponseFromJSON,
24
+ GetExecutionLogsResponseToJSON,
25
+ StopExecutionResponseFromJSON,
26
+ StopExecutionResponseToJSON,
27
+ TaskFromJSON,
28
+ TaskToJSON,
29
+ } from '../models/index';
30
+
31
+ export interface GetExecutionLogsRequest {
32
+ datasetId: string;
33
+ projectId: string;
34
+ forceLive: boolean;
35
+ }
36
+
37
+ export interface GetProjectSummaryRequest {
38
+ projectId: string;
39
+ numberOfDays: number;
40
+ }
41
+
42
+ export interface GetTaskLogsRequest {
43
+ datasetId: string;
44
+ projectId: string;
45
+ taskId: string;
46
+ forceLive: boolean;
47
+ }
48
+
49
+ export interface GetTasksForExecutionRequest {
50
+ datasetId: string;
51
+ projectId: string;
52
+ forceLive: boolean;
53
+ }
54
+
55
+ export interface StopAnalysisRequest {
56
+ datasetId: string;
57
+ projectId: string;
58
+ }
59
+
60
+ /**
61
+ *
62
+ */
63
+ export class ExecutionApi extends runtime.BaseAPI {
64
+
65
+ /**
66
+ * Gets live logs from main execution task
67
+ * Get execution logs
68
+ */
69
+ async getExecutionLogsRaw(requestParameters: GetExecutionLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetExecutionLogsResponse>> {
70
+ if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
71
+ throw new runtime.RequiredError('datasetId','Required parameter requestParameters.datasetId was null or undefined when calling getExecutionLogs.');
72
+ }
73
+
74
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
75
+ throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling getExecutionLogs.');
76
+ }
77
+
78
+ if (requestParameters.forceLive === null || requestParameters.forceLive === undefined) {
79
+ throw new runtime.RequiredError('forceLive','Required parameter requestParameters.forceLive was null or undefined when calling getExecutionLogs.');
80
+ }
81
+
82
+ const queryParameters: any = {};
83
+
84
+ if (requestParameters.forceLive !== undefined) {
85
+ queryParameters['forceLive'] = requestParameters.forceLive;
86
+ }
87
+
88
+ const headerParameters: runtime.HTTPHeaders = {};
89
+
90
+ if (this.configuration && this.configuration.accessToken) {
91
+ const token = this.configuration.accessToken;
92
+ const tokenString = await token("accessToken", []);
93
+
94
+ if (tokenString) {
95
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
96
+ }
97
+ }
98
+ const response = await this.request({
99
+ path: `/projects/{projectId}/execution/{datasetId}/logs`.replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters.datasetId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
100
+ method: 'GET',
101
+ headers: headerParameters,
102
+ query: queryParameters,
103
+ }, initOverrides);
104
+
105
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetExecutionLogsResponseFromJSON(jsonValue));
106
+ }
107
+
108
+ /**
109
+ * Gets live logs from main execution task
110
+ * Get execution logs
111
+ */
112
+ async getExecutionLogs(requestParameters: GetExecutionLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetExecutionLogsResponse> {
113
+ const response = await this.getExecutionLogsRaw(requestParameters, initOverrides);
114
+ return await response.value();
115
+ }
116
+
117
+ /**
118
+ * Gets an overview of the executions currently running in the project
119
+ * Get execution summary
120
+ */
121
+ async getProjectSummaryRaw(requestParameters: GetProjectSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{ [key: string]: Array<Task>; }>> {
122
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
123
+ throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling getProjectSummary.');
124
+ }
125
+
126
+ if (requestParameters.numberOfDays === null || requestParameters.numberOfDays === undefined) {
127
+ throw new runtime.RequiredError('numberOfDays','Required parameter requestParameters.numberOfDays was null or undefined when calling getProjectSummary.');
128
+ }
129
+
130
+ const queryParameters: any = {};
131
+
132
+ if (requestParameters.numberOfDays !== undefined) {
133
+ queryParameters['numberOfDays'] = requestParameters.numberOfDays;
134
+ }
135
+
136
+ const headerParameters: runtime.HTTPHeaders = {};
137
+
138
+ if (this.configuration && this.configuration.accessToken) {
139
+ const token = this.configuration.accessToken;
140
+ const tokenString = await token("accessToken", []);
141
+
142
+ if (tokenString) {
143
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
144
+ }
145
+ }
146
+ const response = await this.request({
147
+ path: `/projects/{projectId}/execution`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
148
+ method: 'GET',
149
+ headers: headerParameters,
150
+ query: queryParameters,
151
+ }, initOverrides);
152
+
153
+ return new runtime.JSONApiResponse<any>(response);
154
+ }
155
+
156
+ /**
157
+ * Gets an overview of the executions currently running in the project
158
+ * Get execution summary
159
+ */
160
+ async getProjectSummary(requestParameters: GetProjectSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{ [key: string]: Array<Task>; }> {
161
+ const response = await this.getProjectSummaryRaw(requestParameters, initOverrides);
162
+ return await response.value();
163
+ }
164
+
165
+ /**
166
+ * Gets the log output from an individual task
167
+ * Get task logs
168
+ */
169
+ async getTaskLogsRaw(requestParameters: GetTaskLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetExecutionLogsResponse>> {
170
+ if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
171
+ throw new runtime.RequiredError('datasetId','Required parameter requestParameters.datasetId was null or undefined when calling getTaskLogs.');
172
+ }
173
+
174
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
175
+ throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling getTaskLogs.');
176
+ }
177
+
178
+ if (requestParameters.taskId === null || requestParameters.taskId === undefined) {
179
+ throw new runtime.RequiredError('taskId','Required parameter requestParameters.taskId was null or undefined when calling getTaskLogs.');
180
+ }
181
+
182
+ if (requestParameters.forceLive === null || requestParameters.forceLive === undefined) {
183
+ throw new runtime.RequiredError('forceLive','Required parameter requestParameters.forceLive was null or undefined when calling getTaskLogs.');
184
+ }
185
+
186
+ const queryParameters: any = {};
187
+
188
+ if (requestParameters.forceLive !== undefined) {
189
+ queryParameters['forceLive'] = requestParameters.forceLive;
190
+ }
191
+
192
+ const headerParameters: runtime.HTTPHeaders = {};
193
+
194
+ if (this.configuration && this.configuration.accessToken) {
195
+ const token = this.configuration.accessToken;
196
+ const tokenString = await token("accessToken", []);
197
+
198
+ if (tokenString) {
199
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
200
+ }
201
+ }
202
+ const response = await this.request({
203
+ path: `/projects/{projectId}/execution/{datasetId}/tasks/{taskId}/log`.replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters.datasetId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"taskId"}}`, encodeURIComponent(String(requestParameters.taskId))),
204
+ method: 'GET',
205
+ headers: headerParameters,
206
+ query: queryParameters,
207
+ }, initOverrides);
208
+
209
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetExecutionLogsResponseFromJSON(jsonValue));
210
+ }
211
+
212
+ /**
213
+ * Gets the log output from an individual task
214
+ * Get task logs
215
+ */
216
+ async getTaskLogs(requestParameters: GetTaskLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetExecutionLogsResponse> {
217
+ const response = await this.getTaskLogsRaw(requestParameters, initOverrides);
218
+ return await response.value();
219
+ }
220
+
221
+ /**
222
+ * Gets the tasks submitted by the workflow execution
223
+ * Get execution tasks
224
+ */
225
+ async getTasksForExecutionRaw(requestParameters: GetTasksForExecutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Task>>> {
226
+ if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
227
+ throw new runtime.RequiredError('datasetId','Required parameter requestParameters.datasetId was null or undefined when calling getTasksForExecution.');
228
+ }
229
+
230
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
231
+ throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling getTasksForExecution.');
232
+ }
233
+
234
+ if (requestParameters.forceLive === null || requestParameters.forceLive === undefined) {
235
+ throw new runtime.RequiredError('forceLive','Required parameter requestParameters.forceLive was null or undefined when calling getTasksForExecution.');
236
+ }
237
+
238
+ const queryParameters: any = {};
239
+
240
+ if (requestParameters.forceLive !== undefined) {
241
+ queryParameters['forceLive'] = requestParameters.forceLive;
242
+ }
243
+
244
+ const headerParameters: runtime.HTTPHeaders = {};
245
+
246
+ if (this.configuration && this.configuration.accessToken) {
247
+ const token = this.configuration.accessToken;
248
+ const tokenString = await token("accessToken", []);
249
+
250
+ if (tokenString) {
251
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
252
+ }
253
+ }
254
+ const response = await this.request({
255
+ path: `/projects/{projectId}/execution/{datasetId}/tasks`.replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters.datasetId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
256
+ method: 'GET',
257
+ headers: headerParameters,
258
+ query: queryParameters,
259
+ }, initOverrides);
260
+
261
+ return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(TaskFromJSON));
262
+ }
263
+
264
+ /**
265
+ * Gets the tasks submitted by the workflow execution
266
+ * Get execution tasks
267
+ */
268
+ async getTasksForExecution(requestParameters: GetTasksForExecutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Task>> {
269
+ const response = await this.getTasksForExecutionRaw(requestParameters, initOverrides);
270
+ return await response.value();
271
+ }
272
+
273
+ /**
274
+ * Terminates all analysis jobs related to this execution
275
+ * Stop execution
276
+ */
277
+ async stopAnalysisRaw(requestParameters: StopAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StopExecutionResponse>> {
278
+ if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
279
+ throw new runtime.RequiredError('datasetId','Required parameter requestParameters.datasetId was null or undefined when calling stopAnalysis.');
280
+ }
281
+
282
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
283
+ throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling stopAnalysis.');
284
+ }
285
+
286
+ const queryParameters: any = {};
287
+
288
+ const headerParameters: runtime.HTTPHeaders = {};
289
+
290
+ if (this.configuration && this.configuration.accessToken) {
291
+ const token = this.configuration.accessToken;
292
+ const tokenString = await token("accessToken", []);
293
+
294
+ if (tokenString) {
295
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
296
+ }
297
+ }
298
+ const response = await this.request({
299
+ path: `/projects/{projectId}/execution/{datasetId}/stop`.replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters.datasetId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
300
+ method: 'PUT',
301
+ headers: headerParameters,
302
+ query: queryParameters,
303
+ }, initOverrides);
304
+
305
+ return new runtime.JSONApiResponse(response, (jsonValue) => StopExecutionResponseFromJSON(jsonValue));
306
+ }
307
+
308
+ /**
309
+ * Terminates all analysis jobs related to this execution
310
+ * Stop execution
311
+ */
312
+ async stopAnalysis(requestParameters: StopAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StopExecutionResponse> {
313
+ const response = await this.stopAnalysisRaw(requestParameters, initOverrides);
314
+ return await response.value();
315
+ }
316
+
317
+ }
@@ -0,0 +1,66 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Cirro Data
5
+ * Cirro Data Platform service API
6
+ *
7
+ * The version of the OpenAPI document: latest
8
+ * Contact: support@cirro.bio
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import * as runtime from '../runtime';
17
+ import type {
18
+ ProjectMetrics,
19
+ } from '../models/index';
20
+ import {
21
+ ProjectMetricsFromJSON,
22
+ ProjectMetricsToJSON,
23
+ } from '../models/index';
24
+
25
+ export interface GetProjectMetricsRequest {
26
+ projectId: string;
27
+ }
28
+
29
+ /**
30
+ *
31
+ */
32
+ export class MetricsApi extends runtime.BaseAPI {
33
+
34
+ /**
35
+ * Retrieves metrics about a project.
36
+ * Get project metrics
37
+ */
38
+ async getProjectMetricsRaw(requestParameters: GetProjectMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectMetrics>> {
39
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
40
+ throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling getProjectMetrics.');
41
+ }
42
+
43
+ const queryParameters: any = {};
44
+
45
+ const headerParameters: runtime.HTTPHeaders = {};
46
+
47
+ const response = await this.request({
48
+ path: `/projects/{projectId}/metrics`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
49
+ method: 'GET',
50
+ headers: headerParameters,
51
+ query: queryParameters,
52
+ }, initOverrides);
53
+
54
+ return new runtime.JSONApiResponse(response, (jsonValue) => ProjectMetricsFromJSON(jsonValue));
55
+ }
56
+
57
+ /**
58
+ * Retrieves metrics about a project.
59
+ * Get project metrics
60
+ */
61
+ async getProjectMetrics(requestParameters: GetProjectMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectMetrics> {
62
+ const response = await this.getProjectMetricsRaw(requestParameters, initOverrides);
63
+ return await response.value();
64
+ }
65
+
66
+ }
@@ -0,0 +1,261 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Cirro Data
5
+ * Cirro Data Platform service API
6
+ *
7
+ * The version of the OpenAPI document: latest
8
+ * Contact: support@cirro.bio
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import * as runtime from '../runtime';
17
+ import type {
18
+ CreateNotebookInstanceRequest,
19
+ CreateResponse,
20
+ NotebookInstance,
21
+ OpenNotebookInstanceResponse,
22
+ } from '../models/index';
23
+ import {
24
+ CreateNotebookInstanceRequestFromJSON,
25
+ CreateNotebookInstanceRequestToJSON,
26
+ CreateResponseFromJSON,
27
+ CreateResponseToJSON,
28
+ NotebookInstanceFromJSON,
29
+ NotebookInstanceToJSON,
30
+ OpenNotebookInstanceResponseFromJSON,
31
+ OpenNotebookInstanceResponseToJSON,
32
+ } from '../models/index';
33
+
34
+ export interface CreateNotebookInstanceOperationRequest {
35
+ projectId: string;
36
+ createNotebookInstanceRequest: CreateNotebookInstanceRequest;
37
+ }
38
+
39
+ export interface DeleteNotebookInstanceRequest {
40
+ notebookInstanceId: string;
41
+ projectId: string;
42
+ }
43
+
44
+ export interface GenerateNotebookInstanceUrlRequest {
45
+ notebookInstanceId: string;
46
+ projectId: string;
47
+ }
48
+
49
+ export interface GetNotebookInstanceStatusRequest {
50
+ notebookInstanceId: string;
51
+ projectId: string;
52
+ }
53
+
54
+ export interface GetNotebookInstancesRequest {
55
+ projectId: string;
56
+ }
57
+
58
+ export interface StopNotebookInstanceRequest {
59
+ notebookInstanceId: string;
60
+ projectId: string;
61
+ }
62
+
63
+ /**
64
+ *
65
+ */
66
+ export class NotebooksApi extends runtime.BaseAPI {
67
+
68
+ /**
69
+ */
70
+ async createNotebookInstanceRaw(requestParameters: CreateNotebookInstanceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>> {
71
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
72
+ throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling createNotebookInstance.');
73
+ }
74
+
75
+ if (requestParameters.createNotebookInstanceRequest === null || requestParameters.createNotebookInstanceRequest === undefined) {
76
+ throw new runtime.RequiredError('createNotebookInstanceRequest','Required parameter requestParameters.createNotebookInstanceRequest was null or undefined when calling createNotebookInstance.');
77
+ }
78
+
79
+ const queryParameters: any = {};
80
+
81
+ const headerParameters: runtime.HTTPHeaders = {};
82
+
83
+ headerParameters['Content-Type'] = 'application/json';
84
+
85
+ const response = await this.request({
86
+ path: `/projects/{projectId}/notebooks/instance`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
87
+ method: 'POST',
88
+ headers: headerParameters,
89
+ query: queryParameters,
90
+ body: CreateNotebookInstanceRequestToJSON(requestParameters.createNotebookInstanceRequest),
91
+ }, initOverrides);
92
+
93
+ return new runtime.JSONApiResponse(response, (jsonValue) => CreateResponseFromJSON(jsonValue));
94
+ }
95
+
96
+ /**
97
+ */
98
+ async createNotebookInstance(requestParameters: CreateNotebookInstanceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse> {
99
+ const response = await this.createNotebookInstanceRaw(requestParameters, initOverrides);
100
+ return await response.value();
101
+ }
102
+
103
+ /**
104
+ */
105
+ async deleteNotebookInstanceRaw(requestParameters: DeleteNotebookInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
106
+ if (requestParameters.notebookInstanceId === null || requestParameters.notebookInstanceId === undefined) {
107
+ throw new runtime.RequiredError('notebookInstanceId','Required parameter requestParameters.notebookInstanceId was null or undefined when calling deleteNotebookInstance.');
108
+ }
109
+
110
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
111
+ throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling deleteNotebookInstance.');
112
+ }
113
+
114
+ const queryParameters: any = {};
115
+
116
+ const headerParameters: runtime.HTTPHeaders = {};
117
+
118
+ const response = await this.request({
119
+ path: `/projects/{projectId}/notebooks/instance/{notebookInstanceId}`.replace(`{${"notebookInstanceId"}}`, encodeURIComponent(String(requestParameters.notebookInstanceId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
120
+ method: 'DELETE',
121
+ headers: headerParameters,
122
+ query: queryParameters,
123
+ }, initOverrides);
124
+
125
+ return new runtime.VoidApiResponse(response);
126
+ }
127
+
128
+ /**
129
+ */
130
+ async deleteNotebookInstance(requestParameters: DeleteNotebookInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
131
+ await this.deleteNotebookInstanceRaw(requestParameters, initOverrides);
132
+ }
133
+
134
+ /**
135
+ */
136
+ async generateNotebookInstanceUrlRaw(requestParameters: GenerateNotebookInstanceUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OpenNotebookInstanceResponse>> {
137
+ if (requestParameters.notebookInstanceId === null || requestParameters.notebookInstanceId === undefined) {
138
+ throw new runtime.RequiredError('notebookInstanceId','Required parameter requestParameters.notebookInstanceId was null or undefined when calling generateNotebookInstanceUrl.');
139
+ }
140
+
141
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
142
+ throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling generateNotebookInstanceUrl.');
143
+ }
144
+
145
+ const queryParameters: any = {};
146
+
147
+ const headerParameters: runtime.HTTPHeaders = {};
148
+
149
+ const response = await this.request({
150
+ path: `/projects/{projectId}/notebooks/instance/{notebookInstanceId}:generate-url`.replace(`{${"notebookInstanceId"}}`, encodeURIComponent(String(requestParameters.notebookInstanceId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
151
+ method: 'GET',
152
+ headers: headerParameters,
153
+ query: queryParameters,
154
+ }, initOverrides);
155
+
156
+ return new runtime.JSONApiResponse(response, (jsonValue) => OpenNotebookInstanceResponseFromJSON(jsonValue));
157
+ }
158
+
159
+ /**
160
+ */
161
+ async generateNotebookInstanceUrl(requestParameters: GenerateNotebookInstanceUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OpenNotebookInstanceResponse> {
162
+ const response = await this.generateNotebookInstanceUrlRaw(requestParameters, initOverrides);
163
+ return await response.value();
164
+ }
165
+
166
+ /**
167
+ */
168
+ async getNotebookInstanceStatusRaw(requestParameters: GetNotebookInstanceStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
169
+ if (requestParameters.notebookInstanceId === null || requestParameters.notebookInstanceId === undefined) {
170
+ throw new runtime.RequiredError('notebookInstanceId','Required parameter requestParameters.notebookInstanceId was null or undefined when calling getNotebookInstanceStatus.');
171
+ }
172
+
173
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
174
+ throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling getNotebookInstanceStatus.');
175
+ }
176
+
177
+ const queryParameters: any = {};
178
+
179
+ const headerParameters: runtime.HTTPHeaders = {};
180
+
181
+ const response = await this.request({
182
+ path: `/projects/{projectId}/notebooks/instance/{notebookInstanceId}:status`.replace(`{${"notebookInstanceId"}}`, encodeURIComponent(String(requestParameters.notebookInstanceId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
183
+ method: 'GET',
184
+ headers: headerParameters,
185
+ query: queryParameters,
186
+ }, initOverrides);
187
+
188
+ if (this.isJsonMime(response.headers.get('content-type'))) {
189
+ return new runtime.JSONApiResponse<string>(response);
190
+ } else {
191
+ return new runtime.TextApiResponse(response) as any;
192
+ }
193
+ }
194
+
195
+ /**
196
+ */
197
+ async getNotebookInstanceStatus(requestParameters: GetNotebookInstanceStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
198
+ const response = await this.getNotebookInstanceStatusRaw(requestParameters, initOverrides);
199
+ return await response.value();
200
+ }
201
+
202
+ /**
203
+ */
204
+ async getNotebookInstancesRaw(requestParameters: GetNotebookInstancesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<NotebookInstance>>> {
205
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
206
+ throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling getNotebookInstances.');
207
+ }
208
+
209
+ const queryParameters: any = {};
210
+
211
+ const headerParameters: runtime.HTTPHeaders = {};
212
+
213
+ const response = await this.request({
214
+ path: `/projects/{projectId}/notebooks/instance`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
215
+ method: 'GET',
216
+ headers: headerParameters,
217
+ query: queryParameters,
218
+ }, initOverrides);
219
+
220
+ return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(NotebookInstanceFromJSON));
221
+ }
222
+
223
+ /**
224
+ */
225
+ async getNotebookInstances(requestParameters: GetNotebookInstancesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<NotebookInstance>> {
226
+ const response = await this.getNotebookInstancesRaw(requestParameters, initOverrides);
227
+ return await response.value();
228
+ }
229
+
230
+ /**
231
+ */
232
+ async stopNotebookInstanceRaw(requestParameters: StopNotebookInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
233
+ if (requestParameters.notebookInstanceId === null || requestParameters.notebookInstanceId === undefined) {
234
+ throw new runtime.RequiredError('notebookInstanceId','Required parameter requestParameters.notebookInstanceId was null or undefined when calling stopNotebookInstance.');
235
+ }
236
+
237
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
238
+ throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling stopNotebookInstance.');
239
+ }
240
+
241
+ const queryParameters: any = {};
242
+
243
+ const headerParameters: runtime.HTTPHeaders = {};
244
+
245
+ const response = await this.request({
246
+ path: `/projects/{projectId}/notebooks/instance/{notebookInstanceId}:stop`.replace(`{${"notebookInstanceId"}}`, encodeURIComponent(String(requestParameters.notebookInstanceId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
247
+ method: 'POST',
248
+ headers: headerParameters,
249
+ query: queryParameters,
250
+ }, initOverrides);
251
+
252
+ return new runtime.VoidApiResponse(response);
253
+ }
254
+
255
+ /**
256
+ */
257
+ async stopNotebookInstance(requestParameters: StopNotebookInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
258
+ await this.stopNotebookInstanceRaw(requestParameters, initOverrides);
259
+ }
260
+
261
+ }