@cosmotech/api-ts 3.3.4 → 5.0.0-beta3

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 (104) hide show
  1. package/.openapi-generator/FILES +83 -0
  2. package/.openapi-generator/VERSION +1 -1
  3. package/LICENSE +1 -1
  4. package/README.md +206 -2
  5. package/api.ts +6034 -13173
  6. package/base.ts +2 -2
  7. package/common.ts +1 -1
  8. package/configuration.ts +7 -2
  9. package/dist/api.d.ts +3440 -7510
  10. package/dist/api.js +3853 -11153
  11. package/dist/base.d.ts +1 -1
  12. package/dist/base.js +2 -2
  13. package/dist/common.d.ts +1 -1
  14. package/dist/common.js +1 -1
  15. package/dist/configuration.d.ts +1 -1
  16. package/dist/configuration.js +14 -2
  17. package/dist/index.d.ts +1 -1
  18. package/dist/index.js +1 -1
  19. package/docs/AboutInfo.md +21 -0
  20. package/docs/AboutInfoVersion.md +33 -0
  21. package/docs/ComponentRolePermissions.md +23 -0
  22. package/docs/ContainerResourceSizeInfo.md +23 -0
  23. package/docs/ContainerResourceSizing.md +23 -0
  24. package/docs/CreateInfo.md +24 -0
  25. package/docs/CreatedRun.md +21 -0
  26. package/docs/Dataset.md +39 -0
  27. package/docs/DatasetAccessControl.md +23 -0
  28. package/docs/DatasetApi.md +1289 -0
  29. package/docs/DatasetCreateRequest.md +31 -0
  30. package/docs/DatasetPart.md +41 -0
  31. package/docs/DatasetPartCreateRequest.md +29 -0
  32. package/docs/DatasetPartTypeEnum.md +11 -0
  33. package/docs/DatasetPartUpdateRequest.md +23 -0
  34. package/docs/DatasetRole.md +21 -0
  35. package/docs/DatasetSecurity.md +23 -0
  36. package/docs/DatasetUpdateRequest.md +29 -0
  37. package/docs/EditInfo.md +22 -0
  38. package/docs/LastRunInfo.md +23 -0
  39. package/docs/MetaApi.md +51 -0
  40. package/docs/Organization.md +29 -0
  41. package/docs/OrganizationAccessControl.md +23 -0
  42. package/docs/OrganizationApi.md +758 -0
  43. package/docs/OrganizationCreateRequest.md +23 -0
  44. package/docs/OrganizationEditInfo.md +22 -0
  45. package/docs/OrganizationRole.md +21 -0
  46. package/docs/OrganizationSecurity.md +23 -0
  47. package/docs/OrganizationUpdateRequest.md +21 -0
  48. package/docs/QueryResult.md +21 -0
  49. package/docs/ResourceSizeInfo.md +23 -0
  50. package/docs/Run.md +55 -0
  51. package/docs/RunApi.md +442 -0
  52. package/docs/RunContainer.md +41 -0
  53. package/docs/RunData.md +25 -0
  54. package/docs/RunDataQuery.md +21 -0
  55. package/docs/RunEditInfo.md +22 -0
  56. package/docs/RunResourceRequested.md +23 -0
  57. package/docs/RunState.md +17 -0
  58. package/docs/RunStatus.md +49 -0
  59. package/docs/RunStatusNode.md +43 -0
  60. package/docs/RunTemplate.md +37 -0
  61. package/docs/RunTemplateCreateRequest.md +37 -0
  62. package/docs/RunTemplateParameter.md +37 -0
  63. package/docs/RunTemplateParameterCreateRequest.md +37 -0
  64. package/docs/RunTemplateParameterGroup.md +33 -0
  65. package/docs/RunTemplateParameterGroupCreateRequest.md +33 -0
  66. package/docs/RunTemplateParameterGroupUpdateRequest.md +31 -0
  67. package/docs/RunTemplateParameterUpdateRequest.md +35 -0
  68. package/docs/RunTemplateParameterValue.md +25 -0
  69. package/docs/RunTemplateResourceSizing.md +23 -0
  70. package/docs/RunTemplateUpdateRequest.md +35 -0
  71. package/docs/Runner.md +61 -0
  72. package/docs/RunnerAccessControl.md +23 -0
  73. package/docs/RunnerApi.md +908 -0
  74. package/docs/RunnerCreateRequest.md +45 -0
  75. package/docs/RunnerEditInfo.md +22 -0
  76. package/docs/RunnerResourceSizing.md +23 -0
  77. package/docs/RunnerRole.md +21 -0
  78. package/docs/RunnerRunTemplateParameterValue.md +27 -0
  79. package/docs/RunnerSecurity.md +23 -0
  80. package/docs/RunnerUpdateRequest.md +39 -0
  81. package/docs/RunnerValidationStatus.md +15 -0
  82. package/docs/SendRunDataRequest.md +23 -0
  83. package/docs/Solution.md +53 -0
  84. package/docs/SolutionAccessControl.md +23 -0
  85. package/docs/SolutionApi.md +1580 -0
  86. package/docs/SolutionCreateRequest.md +43 -0
  87. package/docs/SolutionEditInfo.md +22 -0
  88. package/docs/SolutionRole.md +21 -0
  89. package/docs/SolutionSecurity.md +23 -0
  90. package/docs/SolutionUpdateRequest.md +41 -0
  91. package/docs/Workspace.md +45 -0
  92. package/docs/WorkspaceAccessControl.md +23 -0
  93. package/docs/WorkspaceApi.md +1044 -0
  94. package/docs/WorkspaceCreateRequest.md +37 -0
  95. package/docs/WorkspaceEditInfo.md +22 -0
  96. package/docs/WorkspaceFile.md +21 -0
  97. package/docs/WorkspaceRole.md +21 -0
  98. package/docs/WorkspaceSecurity.md +23 -0
  99. package/docs/WorkspaceSolution.md +25 -0
  100. package/docs/WorkspaceUpdateRequest.md +33 -0
  101. package/docs/WorkspaceWebApp.md +25 -0
  102. package/index.ts +1 -1
  103. package/package.json +1 -1
  104. package/scripts/git_push.sh +1 -1
@@ -0,0 +1,1580 @@
1
+ # SolutionApi
2
+
3
+ All URIs are relative to *http://localhost:8080*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**createSolution**](#createsolution) | **POST** /organizations/{organization_id}/solutions | Create a new solution|
8
+ |[**createSolutionAccessControl**](#createsolutionaccesscontrol) | **POST** /organizations/{organization_id}/solutions/{solution_id}/security/access | Create solution access control|
9
+ |[**createSolutionParameter**](#createsolutionparameter) | **POST** /organizations/{organization_id}/solutions/{solution_id}/parameters | Create solution parameter for a solution|
10
+ |[**createSolutionParameterGroup**](#createsolutionparametergroup) | **POST** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | Create a solution parameter group|
11
+ |[**createSolutionRunTemplate**](#createsolutionruntemplate) | **POST** /organizations/{organization_id}/solutions/{solution_id}/runTemplates | Create a solution run template|
12
+ |[**deleteSolution**](#deletesolution) | **DELETE** /organizations/{organization_id}/solutions/{solution_id} | Delete a solution|
13
+ |[**deleteSolutionAccessControl**](#deletesolutionaccesscontrol) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Delete solution access control|
14
+ |[**deleteSolutionParameter**](#deletesolutionparameter) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/parameters/{parameter_id} | Delete specific parameter from the solution|
15
+ |[**deleteSolutionParameterGroup**](#deletesolutionparametergroup) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups/{parameter_group_id} | Delete a parameter group from the solution|
16
+ |[**deleteSolutionRunTemplate**](#deletesolutionruntemplate) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Delete a specific run template|
17
+ |[**getRunTemplate**](#getruntemplate) | **GET** /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Retrieve a solution run templates|
18
+ |[**getSolution**](#getsolution) | **GET** /organizations/{organization_id}/solutions/{solution_id} | Get the details of a solution|
19
+ |[**getSolutionAccessControl**](#getsolutionaccesscontrol) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Get solution access control|
20
+ |[**getSolutionParameter**](#getsolutionparameter) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameters/{parameter_id} | Get the details of a solution parameter|
21
+ |[**getSolutionParameterGroup**](#getsolutionparametergroup) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups/{parameter_group_id} | Get details of a solution parameter group|
22
+ |[**getSolutionSecurity**](#getsolutionsecurity) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security | Get solution security information|
23
+ |[**listRunTemplates**](#listruntemplates) | **GET** /organizations/{organization_id}/solutions/{solution_id}/runTemplates | List all solution run templates|
24
+ |[**listSolutionParameterGroups**](#listsolutionparametergroups) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | List all solution parameter groups|
25
+ |[**listSolutionParameters**](#listsolutionparameters) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameters | List all solution parameters|
26
+ |[**listSolutionSecurityUsers**](#listsolutionsecurityusers) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security/users | List solution security users|
27
+ |[**listSolutions**](#listsolutions) | **GET** /organizations/{organization_id}/solutions | List all Solutions|
28
+ |[**updateSolution**](#updatesolution) | **PATCH** /organizations/{organization_id}/solutions/{solution_id} | Update a solution|
29
+ |[**updateSolutionAccessControl**](#updatesolutionaccesscontrol) | **PATCH** /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Update solution access control|
30
+ |[**updateSolutionDefaultSecurity**](#updatesolutiondefaultsecurity) | **PATCH** /organizations/{organization_id}/solutions/{solution_id}/security/default | Update solution default security|
31
+ |[**updateSolutionParameter**](#updatesolutionparameter) | **PATCH** /organizations/{organization_id}/solutions/{solution_id}/parameters/{parameter_id} | Update solution parameter|
32
+ |[**updateSolutionParameterGroup**](#updatesolutionparametergroup) | **PATCH** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups/{parameter_group_id} | Update a solution parameter group|
33
+ |[**updateSolutionRunTemplate**](#updatesolutionruntemplate) | **PATCH** /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Update a specific run template|
34
+
35
+ # **createSolution**
36
+ > Solution createSolution(solutionCreateRequest)
37
+
38
+
39
+ ### Example
40
+
41
+ ```typescript
42
+ import {
43
+ SolutionApi,
44
+ Configuration,
45
+ SolutionCreateRequest
46
+ } from '@cosmotech/api-ts';
47
+
48
+ const configuration = new Configuration();
49
+ const apiInstance = new SolutionApi(configuration);
50
+
51
+ let organizationId: string; //The Organization identifier (default to undefined)
52
+ let solutionCreateRequest: SolutionCreateRequest; //The Solution to create
53
+
54
+ const { status, data } = await apiInstance.createSolution(
55
+ organizationId,
56
+ solutionCreateRequest
57
+ );
58
+ ```
59
+
60
+ ### Parameters
61
+
62
+ |Name | Type | Description | Notes|
63
+ |------------- | ------------- | ------------- | -------------|
64
+ | **solutionCreateRequest** | **SolutionCreateRequest**| The Solution to create | |
65
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
66
+
67
+
68
+ ### Return type
69
+
70
+ **Solution**
71
+
72
+ ### Authorization
73
+
74
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
75
+
76
+ ### HTTP request headers
77
+
78
+ - **Content-Type**: application/json, application/yaml
79
+ - **Accept**: application/json, application/yaml
80
+
81
+
82
+ ### HTTP response details
83
+ | Status code | Description | Response headers |
84
+ |-------------|-------------|------------------|
85
+ |**201** | Solution successfully created | - |
86
+ |**400** | Bad request | - |
87
+
88
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
89
+
90
+ # **createSolutionAccessControl**
91
+ > SolutionAccessControl createSolutionAccessControl(solutionAccessControl)
92
+
93
+
94
+ ### Example
95
+
96
+ ```typescript
97
+ import {
98
+ SolutionApi,
99
+ Configuration,
100
+ SolutionAccessControl
101
+ } from '@cosmotech/api-ts';
102
+
103
+ const configuration = new Configuration();
104
+ const apiInstance = new SolutionApi(configuration);
105
+
106
+ let organizationId: string; //The Organization identifier (default to undefined)
107
+ let solutionId: string; //The Solution identifier (default to undefined)
108
+ let solutionAccessControl: SolutionAccessControl; //Access control to create
109
+
110
+ const { status, data } = await apiInstance.createSolutionAccessControl(
111
+ organizationId,
112
+ solutionId,
113
+ solutionAccessControl
114
+ );
115
+ ```
116
+
117
+ ### Parameters
118
+
119
+ |Name | Type | Description | Notes|
120
+ |------------- | ------------- | ------------- | -------------|
121
+ | **solutionAccessControl** | **SolutionAccessControl**| Access control to create | |
122
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
123
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
124
+
125
+
126
+ ### Return type
127
+
128
+ **SolutionAccessControl**
129
+
130
+ ### Authorization
131
+
132
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
133
+
134
+ ### HTTP request headers
135
+
136
+ - **Content-Type**: application/json, application/yaml
137
+ - **Accept**: application/json, application/yaml
138
+
139
+
140
+ ### HTTP response details
141
+ | Status code | Description | Response headers |
142
+ |-------------|-------------|------------------|
143
+ |**201** | Solution access control successfully created | - |
144
+ |**404** | Solution not found or insufficient access rights | - |
145
+
146
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
147
+
148
+ # **createSolutionParameter**
149
+ > RunTemplateParameter createSolutionParameter(runTemplateParameterCreateRequest)
150
+
151
+
152
+ ### Example
153
+
154
+ ```typescript
155
+ import {
156
+ SolutionApi,
157
+ Configuration,
158
+ RunTemplateParameterCreateRequest
159
+ } from '@cosmotech/api-ts';
160
+
161
+ const configuration = new Configuration();
162
+ const apiInstance = new SolutionApi(configuration);
163
+
164
+ let organizationId: string; //The Organization identifier (default to undefined)
165
+ let solutionId: string; //The Solution identifier (default to undefined)
166
+ let runTemplateParameterCreateRequest: RunTemplateParameterCreateRequest; //Parameter to create
167
+
168
+ const { status, data } = await apiInstance.createSolutionParameter(
169
+ organizationId,
170
+ solutionId,
171
+ runTemplateParameterCreateRequest
172
+ );
173
+ ```
174
+
175
+ ### Parameters
176
+
177
+ |Name | Type | Description | Notes|
178
+ |------------- | ------------- | ------------- | -------------|
179
+ | **runTemplateParameterCreateRequest** | **RunTemplateParameterCreateRequest**| Parameter to create | |
180
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
181
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
182
+
183
+
184
+ ### Return type
185
+
186
+ **RunTemplateParameter**
187
+
188
+ ### Authorization
189
+
190
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
191
+
192
+ ### HTTP request headers
193
+
194
+ - **Content-Type**: application/json, application/yaml
195
+ - **Accept**: application/json, application/yaml
196
+
197
+
198
+ ### HTTP response details
199
+ | Status code | Description | Response headers |
200
+ |-------------|-------------|------------------|
201
+ |**200** | Parameters successfully created | - |
202
+ |**400** | Bad request | - |
203
+ |**404** | Solution not found or insufficient access rights | - |
204
+
205
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
206
+
207
+ # **createSolutionParameterGroup**
208
+ > RunTemplateParameterGroup createSolutionParameterGroup(runTemplateParameterGroupCreateRequest)
209
+
210
+
211
+ ### Example
212
+
213
+ ```typescript
214
+ import {
215
+ SolutionApi,
216
+ Configuration,
217
+ RunTemplateParameterGroupCreateRequest
218
+ } from '@cosmotech/api-ts';
219
+
220
+ const configuration = new Configuration();
221
+ const apiInstance = new SolutionApi(configuration);
222
+
223
+ let organizationId: string; //The Organization identifier (default to undefined)
224
+ let solutionId: string; //The Solution identifier (default to undefined)
225
+ let runTemplateParameterGroupCreateRequest: RunTemplateParameterGroupCreateRequest; //Parameter group to create
226
+
227
+ const { status, data } = await apiInstance.createSolutionParameterGroup(
228
+ organizationId,
229
+ solutionId,
230
+ runTemplateParameterGroupCreateRequest
231
+ );
232
+ ```
233
+
234
+ ### Parameters
235
+
236
+ |Name | Type | Description | Notes|
237
+ |------------- | ------------- | ------------- | -------------|
238
+ | **runTemplateParameterGroupCreateRequest** | **RunTemplateParameterGroupCreateRequest**| Parameter group to create | |
239
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
240
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
241
+
242
+
243
+ ### Return type
244
+
245
+ **RunTemplateParameterGroup**
246
+
247
+ ### Authorization
248
+
249
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
250
+
251
+ ### HTTP request headers
252
+
253
+ - **Content-Type**: application/json, application/yaml
254
+ - **Accept**: application/json, application/yaml
255
+
256
+
257
+ ### HTTP response details
258
+ | Status code | Description | Response headers |
259
+ |-------------|-------------|------------------|
260
+ |**201** | Parameter group successfully created | - |
261
+ |**400** | Bad request - Invalid parameter group | - |
262
+ |**404** | Solution not found or insufficient access rights | - |
263
+
264
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
265
+
266
+ # **createSolutionRunTemplate**
267
+ > RunTemplate createSolutionRunTemplate(runTemplateCreateRequest)
268
+
269
+
270
+ ### Example
271
+
272
+ ```typescript
273
+ import {
274
+ SolutionApi,
275
+ Configuration,
276
+ RunTemplateCreateRequest
277
+ } from '@cosmotech/api-ts';
278
+
279
+ const configuration = new Configuration();
280
+ const apiInstance = new SolutionApi(configuration);
281
+
282
+ let organizationId: string; //The Organization identifier (default to undefined)
283
+ let solutionId: string; //The Solution identifier (default to undefined)
284
+ let runTemplateCreateRequest: RunTemplateCreateRequest; //Run template to create
285
+
286
+ const { status, data } = await apiInstance.createSolutionRunTemplate(
287
+ organizationId,
288
+ solutionId,
289
+ runTemplateCreateRequest
290
+ );
291
+ ```
292
+
293
+ ### Parameters
294
+
295
+ |Name | Type | Description | Notes|
296
+ |------------- | ------------- | ------------- | -------------|
297
+ | **runTemplateCreateRequest** | **RunTemplateCreateRequest**| Run template to create | |
298
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
299
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
300
+
301
+
302
+ ### Return type
303
+
304
+ **RunTemplate**
305
+
306
+ ### Authorization
307
+
308
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
309
+
310
+ ### HTTP request headers
311
+
312
+ - **Content-Type**: application/json, application/yaml
313
+ - **Accept**: application/json, application/yaml
314
+
315
+
316
+ ### HTTP response details
317
+ | Status code | Description | Response headers |
318
+ |-------------|-------------|------------------|
319
+ |**201** | Run template successfully created | - |
320
+ |**400** | Bad request - Invalid run template | - |
321
+ |**404** | Solution not found or insufficient access rights | - |
322
+
323
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
324
+
325
+ # **deleteSolution**
326
+ > deleteSolution()
327
+
328
+
329
+ ### Example
330
+
331
+ ```typescript
332
+ import {
333
+ SolutionApi,
334
+ Configuration
335
+ } from '@cosmotech/api-ts';
336
+
337
+ const configuration = new Configuration();
338
+ const apiInstance = new SolutionApi(configuration);
339
+
340
+ let organizationId: string; //The Organization identifier (default to undefined)
341
+ let solutionId: string; //The Solution identifier (default to undefined)
342
+
343
+ const { status, data } = await apiInstance.deleteSolution(
344
+ organizationId,
345
+ solutionId
346
+ );
347
+ ```
348
+
349
+ ### Parameters
350
+
351
+ |Name | Type | Description | Notes|
352
+ |------------- | ------------- | ------------- | -------------|
353
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
354
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
355
+
356
+
357
+ ### Return type
358
+
359
+ void (empty response body)
360
+
361
+ ### Authorization
362
+
363
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
364
+
365
+ ### HTTP request headers
366
+
367
+ - **Content-Type**: Not defined
368
+ - **Accept**: Not defined
369
+
370
+
371
+ ### HTTP response details
372
+ | Status code | Description | Response headers |
373
+ |-------------|-------------|------------------|
374
+ |**204** | Solution successfully deleted | - |
375
+ |**404** | Solution not found or insufficient access rights | - |
376
+
377
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
378
+
379
+ # **deleteSolutionAccessControl**
380
+ > deleteSolutionAccessControl()
381
+
382
+
383
+ ### Example
384
+
385
+ ```typescript
386
+ import {
387
+ SolutionApi,
388
+ Configuration
389
+ } from '@cosmotech/api-ts';
390
+
391
+ const configuration = new Configuration();
392
+ const apiInstance = new SolutionApi(configuration);
393
+
394
+ let organizationId: string; //The Organization identifier (default to undefined)
395
+ let solutionId: string; //The Solution identifier (default to undefined)
396
+ let identityId: string; //The User identifier (default to undefined)
397
+
398
+ const { status, data } = await apiInstance.deleteSolutionAccessControl(
399
+ organizationId,
400
+ solutionId,
401
+ identityId
402
+ );
403
+ ```
404
+
405
+ ### Parameters
406
+
407
+ |Name | Type | Description | Notes|
408
+ |------------- | ------------- | ------------- | -------------|
409
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
410
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
411
+ | **identityId** | [**string**] | The User identifier | defaults to undefined|
412
+
413
+
414
+ ### Return type
415
+
416
+ void (empty response body)
417
+
418
+ ### Authorization
419
+
420
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
421
+
422
+ ### HTTP request headers
423
+
424
+ - **Content-Type**: Not defined
425
+ - **Accept**: Not defined
426
+
427
+
428
+ ### HTTP response details
429
+ | Status code | Description | Response headers |
430
+ |-------------|-------------|------------------|
431
+ |**204** | Solution access control successfully deleted | - |
432
+ |**404** | Solution or user not found or insufficient access rights | - |
433
+
434
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
435
+
436
+ # **deleteSolutionParameter**
437
+ > deleteSolutionParameter()
438
+
439
+
440
+ ### Example
441
+
442
+ ```typescript
443
+ import {
444
+ SolutionApi,
445
+ Configuration
446
+ } from '@cosmotech/api-ts';
447
+
448
+ const configuration = new Configuration();
449
+ const apiInstance = new SolutionApi(configuration);
450
+
451
+ let organizationId: string; //The Organization identifier (default to undefined)
452
+ let solutionId: string; //The Solution identifier (default to undefined)
453
+ let parameterId: string; //The solution parameter identifier (default to undefined)
454
+
455
+ const { status, data } = await apiInstance.deleteSolutionParameter(
456
+ organizationId,
457
+ solutionId,
458
+ parameterId
459
+ );
460
+ ```
461
+
462
+ ### Parameters
463
+
464
+ |Name | Type | Description | Notes|
465
+ |------------- | ------------- | ------------- | -------------|
466
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
467
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
468
+ | **parameterId** | [**string**] | The solution parameter identifier | defaults to undefined|
469
+
470
+
471
+ ### Return type
472
+
473
+ void (empty response body)
474
+
475
+ ### Authorization
476
+
477
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
478
+
479
+ ### HTTP request headers
480
+
481
+ - **Content-Type**: Not defined
482
+ - **Accept**: Not defined
483
+
484
+
485
+ ### HTTP response details
486
+ | Status code | Description | Response headers |
487
+ |-------------|-------------|------------------|
488
+ |**204** | Parameter successfully deleted | - |
489
+ |**404** | Solution or parameter not found or insufficient access rights | - |
490
+
491
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
492
+
493
+ # **deleteSolutionParameterGroup**
494
+ > deleteSolutionParameterGroup()
495
+
496
+
497
+ ### Example
498
+
499
+ ```typescript
500
+ import {
501
+ SolutionApi,
502
+ Configuration
503
+ } from '@cosmotech/api-ts';
504
+
505
+ const configuration = new Configuration();
506
+ const apiInstance = new SolutionApi(configuration);
507
+
508
+ let organizationId: string; //The Organization identifier (default to undefined)
509
+ let solutionId: string; //The Solution identifier (default to undefined)
510
+ let parameterGroupId: string; //The parameter group identifier (default to undefined)
511
+
512
+ const { status, data } = await apiInstance.deleteSolutionParameterGroup(
513
+ organizationId,
514
+ solutionId,
515
+ parameterGroupId
516
+ );
517
+ ```
518
+
519
+ ### Parameters
520
+
521
+ |Name | Type | Description | Notes|
522
+ |------------- | ------------- | ------------- | -------------|
523
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
524
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
525
+ | **parameterGroupId** | [**string**] | The parameter group identifier | defaults to undefined|
526
+
527
+
528
+ ### Return type
529
+
530
+ void (empty response body)
531
+
532
+ ### Authorization
533
+
534
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
535
+
536
+ ### HTTP request headers
537
+
538
+ - **Content-Type**: Not defined
539
+ - **Accept**: Not defined
540
+
541
+
542
+ ### HTTP response details
543
+ | Status code | Description | Response headers |
544
+ |-------------|-------------|------------------|
545
+ |**204** | Parameter group successfully deleted | - |
546
+ |**404** | Solution or parameter group not found or insufficient access rights | - |
547
+
548
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
549
+
550
+ # **deleteSolutionRunTemplate**
551
+ > deleteSolutionRunTemplate()
552
+
553
+
554
+ ### Example
555
+
556
+ ```typescript
557
+ import {
558
+ SolutionApi,
559
+ Configuration
560
+ } from '@cosmotech/api-ts';
561
+
562
+ const configuration = new Configuration();
563
+ const apiInstance = new SolutionApi(configuration);
564
+
565
+ let organizationId: string; //The Organization identifier (default to undefined)
566
+ let solutionId: string; //The Solution identifier (default to undefined)
567
+ let runTemplateId: string; //The Run Template identifier (default to undefined)
568
+
569
+ const { status, data } = await apiInstance.deleteSolutionRunTemplate(
570
+ organizationId,
571
+ solutionId,
572
+ runTemplateId
573
+ );
574
+ ```
575
+
576
+ ### Parameters
577
+
578
+ |Name | Type | Description | Notes|
579
+ |------------- | ------------- | ------------- | -------------|
580
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
581
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
582
+ | **runTemplateId** | [**string**] | The Run Template identifier | defaults to undefined|
583
+
584
+
585
+ ### Return type
586
+
587
+ void (empty response body)
588
+
589
+ ### Authorization
590
+
591
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
592
+
593
+ ### HTTP request headers
594
+
595
+ - **Content-Type**: Not defined
596
+ - **Accept**: Not defined
597
+
598
+
599
+ ### HTTP response details
600
+ | Status code | Description | Response headers |
601
+ |-------------|-------------|------------------|
602
+ |**204** | Run template successfully deleted | - |
603
+ |**404** | Solution or run template not found or insufficient access rights | - |
604
+
605
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
606
+
607
+ # **getRunTemplate**
608
+ > RunTemplate getRunTemplate()
609
+
610
+
611
+ ### Example
612
+
613
+ ```typescript
614
+ import {
615
+ SolutionApi,
616
+ Configuration
617
+ } from '@cosmotech/api-ts';
618
+
619
+ const configuration = new Configuration();
620
+ const apiInstance = new SolutionApi(configuration);
621
+
622
+ let organizationId: string; //The Organization identifier (default to undefined)
623
+ let solutionId: string; //The Solution identifier (default to undefined)
624
+ let runTemplateId: string; //The Run Template identifier (default to undefined)
625
+
626
+ const { status, data } = await apiInstance.getRunTemplate(
627
+ organizationId,
628
+ solutionId,
629
+ runTemplateId
630
+ );
631
+ ```
632
+
633
+ ### Parameters
634
+
635
+ |Name | Type | Description | Notes|
636
+ |------------- | ------------- | ------------- | -------------|
637
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
638
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
639
+ | **runTemplateId** | [**string**] | The Run Template identifier | defaults to undefined|
640
+
641
+
642
+ ### Return type
643
+
644
+ **RunTemplate**
645
+
646
+ ### Authorization
647
+
648
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
649
+
650
+ ### HTTP request headers
651
+
652
+ - **Content-Type**: Not defined
653
+ - **Accept**: application/json, application/yaml
654
+
655
+
656
+ ### HTTP response details
657
+ | Status code | Description | Response headers |
658
+ |-------------|-------------|------------------|
659
+ |**200** | Run template successfully retrieved | - |
660
+ |**404** | Solution not found or insufficient access rights | - |
661
+
662
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
663
+
664
+ # **getSolution**
665
+ > Solution getSolution()
666
+
667
+
668
+ ### Example
669
+
670
+ ```typescript
671
+ import {
672
+ SolutionApi,
673
+ Configuration
674
+ } from '@cosmotech/api-ts';
675
+
676
+ const configuration = new Configuration();
677
+ const apiInstance = new SolutionApi(configuration);
678
+
679
+ let organizationId: string; //The Organization identifier (default to undefined)
680
+ let solutionId: string; //The Solution identifier (default to undefined)
681
+
682
+ const { status, data } = await apiInstance.getSolution(
683
+ organizationId,
684
+ solutionId
685
+ );
686
+ ```
687
+
688
+ ### Parameters
689
+
690
+ |Name | Type | Description | Notes|
691
+ |------------- | ------------- | ------------- | -------------|
692
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
693
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
694
+
695
+
696
+ ### Return type
697
+
698
+ **Solution**
699
+
700
+ ### Authorization
701
+
702
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
703
+
704
+ ### HTTP request headers
705
+
706
+ - **Content-Type**: Not defined
707
+ - **Accept**: application/json, application/yaml
708
+
709
+
710
+ ### HTTP response details
711
+ | Status code | Description | Response headers |
712
+ |-------------|-------------|------------------|
713
+ |**200** | Solution details successfully retrieved | - |
714
+ |**404** | Solution not found or insufficient access rights | - |
715
+
716
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
717
+
718
+ # **getSolutionAccessControl**
719
+ > SolutionAccessControl getSolutionAccessControl()
720
+
721
+
722
+ ### Example
723
+
724
+ ```typescript
725
+ import {
726
+ SolutionApi,
727
+ Configuration
728
+ } from '@cosmotech/api-ts';
729
+
730
+ const configuration = new Configuration();
731
+ const apiInstance = new SolutionApi(configuration);
732
+
733
+ let organizationId: string; //The Organization identifier (default to undefined)
734
+ let solutionId: string; //The Solution identifier (default to undefined)
735
+ let identityId: string; //The User identifier (default to undefined)
736
+
737
+ const { status, data } = await apiInstance.getSolutionAccessControl(
738
+ organizationId,
739
+ solutionId,
740
+ identityId
741
+ );
742
+ ```
743
+
744
+ ### Parameters
745
+
746
+ |Name | Type | Description | Notes|
747
+ |------------- | ------------- | ------------- | -------------|
748
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
749
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
750
+ | **identityId** | [**string**] | The User identifier | defaults to undefined|
751
+
752
+
753
+ ### Return type
754
+
755
+ **SolutionAccessControl**
756
+
757
+ ### Authorization
758
+
759
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
760
+
761
+ ### HTTP request headers
762
+
763
+ - **Content-Type**: Not defined
764
+ - **Accept**: application/json, application/yaml
765
+
766
+
767
+ ### HTTP response details
768
+ | Status code | Description | Response headers |
769
+ |-------------|-------------|------------------|
770
+ |**200** | Solution access control successfully retrieved | - |
771
+ |**404** | Solution or user not found or insufficient access rights | - |
772
+
773
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
774
+
775
+ # **getSolutionParameter**
776
+ > RunTemplateParameter getSolutionParameter()
777
+
778
+
779
+ ### Example
780
+
781
+ ```typescript
782
+ import {
783
+ SolutionApi,
784
+ Configuration
785
+ } from '@cosmotech/api-ts';
786
+
787
+ const configuration = new Configuration();
788
+ const apiInstance = new SolutionApi(configuration);
789
+
790
+ let organizationId: string; //The Organization identifier (default to undefined)
791
+ let solutionId: string; //The Solution identifier (default to undefined)
792
+ let parameterId: string; //The solution parameter identifier (default to undefined)
793
+
794
+ const { status, data } = await apiInstance.getSolutionParameter(
795
+ organizationId,
796
+ solutionId,
797
+ parameterId
798
+ );
799
+ ```
800
+
801
+ ### Parameters
802
+
803
+ |Name | Type | Description | Notes|
804
+ |------------- | ------------- | ------------- | -------------|
805
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
806
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
807
+ | **parameterId** | [**string**] | The solution parameter identifier | defaults to undefined|
808
+
809
+
810
+ ### Return type
811
+
812
+ **RunTemplateParameter**
813
+
814
+ ### Authorization
815
+
816
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
817
+
818
+ ### HTTP request headers
819
+
820
+ - **Content-Type**: Not defined
821
+ - **Accept**: application/json, application/yaml
822
+
823
+
824
+ ### HTTP response details
825
+ | Status code | Description | Response headers |
826
+ |-------------|-------------|------------------|
827
+ |**200** | Parameters successfully retrieved | - |
828
+ |**400** | Bad Request | - |
829
+ |**404** | Solution or parameter not found or insufficient access rights | - |
830
+
831
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
832
+
833
+ # **getSolutionParameterGroup**
834
+ > RunTemplateParameterGroup getSolutionParameterGroup()
835
+
836
+
837
+ ### Example
838
+
839
+ ```typescript
840
+ import {
841
+ SolutionApi,
842
+ Configuration
843
+ } from '@cosmotech/api-ts';
844
+
845
+ const configuration = new Configuration();
846
+ const apiInstance = new SolutionApi(configuration);
847
+
848
+ let organizationId: string; //The Organization identifier (default to undefined)
849
+ let solutionId: string; //The Solution identifier (default to undefined)
850
+ let parameterGroupId: string; //The parameter group identifier (default to undefined)
851
+
852
+ const { status, data } = await apiInstance.getSolutionParameterGroup(
853
+ organizationId,
854
+ solutionId,
855
+ parameterGroupId
856
+ );
857
+ ```
858
+
859
+ ### Parameters
860
+
861
+ |Name | Type | Description | Notes|
862
+ |------------- | ------------- | ------------- | -------------|
863
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
864
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
865
+ | **parameterGroupId** | [**string**] | The parameter group identifier | defaults to undefined|
866
+
867
+
868
+ ### Return type
869
+
870
+ **RunTemplateParameterGroup**
871
+
872
+ ### Authorization
873
+
874
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
875
+
876
+ ### HTTP request headers
877
+
878
+ - **Content-Type**: Not defined
879
+ - **Accept**: application/json, application/yaml
880
+
881
+
882
+ ### HTTP response details
883
+ | Status code | Description | Response headers |
884
+ |-------------|-------------|------------------|
885
+ |**200** | Parameter groups successfully retrieved | - |
886
+ |**404** | Solution or parameter group not found or insufficient access rights | - |
887
+
888
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
889
+
890
+ # **getSolutionSecurity**
891
+ > SolutionSecurity getSolutionSecurity()
892
+
893
+
894
+ ### Example
895
+
896
+ ```typescript
897
+ import {
898
+ SolutionApi,
899
+ Configuration
900
+ } from '@cosmotech/api-ts';
901
+
902
+ const configuration = new Configuration();
903
+ const apiInstance = new SolutionApi(configuration);
904
+
905
+ let organizationId: string; //The Organization identifier (default to undefined)
906
+ let solutionId: string; //The Solution identifier (default to undefined)
907
+
908
+ const { status, data } = await apiInstance.getSolutionSecurity(
909
+ organizationId,
910
+ solutionId
911
+ );
912
+ ```
913
+
914
+ ### Parameters
915
+
916
+ |Name | Type | Description | Notes|
917
+ |------------- | ------------- | ------------- | -------------|
918
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
919
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
920
+
921
+
922
+ ### Return type
923
+
924
+ **SolutionSecurity**
925
+
926
+ ### Authorization
927
+
928
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
929
+
930
+ ### HTTP request headers
931
+
932
+ - **Content-Type**: Not defined
933
+ - **Accept**: application/json, application/yaml
934
+
935
+
936
+ ### HTTP response details
937
+ | Status code | Description | Response headers |
938
+ |-------------|-------------|------------------|
939
+ |**200** | Solution security information successfully retrieved | - |
940
+ |**404** | Solution not found or insufficient access rights | - |
941
+
942
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
943
+
944
+ # **listRunTemplates**
945
+ > Array<RunTemplate> listRunTemplates()
946
+
947
+
948
+ ### Example
949
+
950
+ ```typescript
951
+ import {
952
+ SolutionApi,
953
+ Configuration
954
+ } from '@cosmotech/api-ts';
955
+
956
+ const configuration = new Configuration();
957
+ const apiInstance = new SolutionApi(configuration);
958
+
959
+ let organizationId: string; //The Organization identifier (default to undefined)
960
+ let solutionId: string; //The Solution identifier (default to undefined)
961
+
962
+ const { status, data } = await apiInstance.listRunTemplates(
963
+ organizationId,
964
+ solutionId
965
+ );
966
+ ```
967
+
968
+ ### Parameters
969
+
970
+ |Name | Type | Description | Notes|
971
+ |------------- | ------------- | ------------- | -------------|
972
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
973
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
974
+
975
+
976
+ ### Return type
977
+
978
+ **Array<RunTemplate>**
979
+
980
+ ### Authorization
981
+
982
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
983
+
984
+ ### HTTP request headers
985
+
986
+ - **Content-Type**: Not defined
987
+ - **Accept**: application/json, application/yaml
988
+
989
+
990
+ ### HTTP response details
991
+ | Status code | Description | Response headers |
992
+ |-------------|-------------|------------------|
993
+ |**200** | Run templates successfully listed | - |
994
+ |**404** | Solution not found or insufficient access rights | - |
995
+
996
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
997
+
998
+ # **listSolutionParameterGroups**
999
+ > Array<RunTemplateParameterGroup> listSolutionParameterGroups()
1000
+
1001
+
1002
+ ### Example
1003
+
1004
+ ```typescript
1005
+ import {
1006
+ SolutionApi,
1007
+ Configuration
1008
+ } from '@cosmotech/api-ts';
1009
+
1010
+ const configuration = new Configuration();
1011
+ const apiInstance = new SolutionApi(configuration);
1012
+
1013
+ let organizationId: string; //The Organization identifier (default to undefined)
1014
+ let solutionId: string; //The Solution identifier (default to undefined)
1015
+
1016
+ const { status, data } = await apiInstance.listSolutionParameterGroups(
1017
+ organizationId,
1018
+ solutionId
1019
+ );
1020
+ ```
1021
+
1022
+ ### Parameters
1023
+
1024
+ |Name | Type | Description | Notes|
1025
+ |------------- | ------------- | ------------- | -------------|
1026
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
1027
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
1028
+
1029
+
1030
+ ### Return type
1031
+
1032
+ **Array<RunTemplateParameterGroup>**
1033
+
1034
+ ### Authorization
1035
+
1036
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
1037
+
1038
+ ### HTTP request headers
1039
+
1040
+ - **Content-Type**: Not defined
1041
+ - **Accept**: application/json, application/yaml
1042
+
1043
+
1044
+ ### HTTP response details
1045
+ | Status code | Description | Response headers |
1046
+ |-------------|-------------|------------------|
1047
+ |**200** | Parameter groups successfully listed | - |
1048
+ |**404** | Solution not found or insufficient access rights | - |
1049
+
1050
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1051
+
1052
+ # **listSolutionParameters**
1053
+ > Array<RunTemplateParameter> listSolutionParameters()
1054
+
1055
+
1056
+ ### Example
1057
+
1058
+ ```typescript
1059
+ import {
1060
+ SolutionApi,
1061
+ Configuration
1062
+ } from '@cosmotech/api-ts';
1063
+
1064
+ const configuration = new Configuration();
1065
+ const apiInstance = new SolutionApi(configuration);
1066
+
1067
+ let organizationId: string; //The Organization identifier (default to undefined)
1068
+ let solutionId: string; //The Solution identifier (default to undefined)
1069
+
1070
+ const { status, data } = await apiInstance.listSolutionParameters(
1071
+ organizationId,
1072
+ solutionId
1073
+ );
1074
+ ```
1075
+
1076
+ ### Parameters
1077
+
1078
+ |Name | Type | Description | Notes|
1079
+ |------------- | ------------- | ------------- | -------------|
1080
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
1081
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
1082
+
1083
+
1084
+ ### Return type
1085
+
1086
+ **Array<RunTemplateParameter>**
1087
+
1088
+ ### Authorization
1089
+
1090
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
1091
+
1092
+ ### HTTP request headers
1093
+
1094
+ - **Content-Type**: Not defined
1095
+ - **Accept**: application/json, application/yaml
1096
+
1097
+
1098
+ ### HTTP response details
1099
+ | Status code | Description | Response headers |
1100
+ |-------------|-------------|------------------|
1101
+ |**200** | Parameters successfully retrieved | - |
1102
+ |**400** | Bad Request | - |
1103
+ |**404** | Solution not found or insufficient access rights | - |
1104
+
1105
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1106
+
1107
+ # **listSolutionSecurityUsers**
1108
+ > Array<string> listSolutionSecurityUsers()
1109
+
1110
+
1111
+ ### Example
1112
+
1113
+ ```typescript
1114
+ import {
1115
+ SolutionApi,
1116
+ Configuration
1117
+ } from '@cosmotech/api-ts';
1118
+
1119
+ const configuration = new Configuration();
1120
+ const apiInstance = new SolutionApi(configuration);
1121
+
1122
+ let organizationId: string; //The Organization identifier (default to undefined)
1123
+ let solutionId: string; //The Solution identifier (default to undefined)
1124
+
1125
+ const { status, data } = await apiInstance.listSolutionSecurityUsers(
1126
+ organizationId,
1127
+ solutionId
1128
+ );
1129
+ ```
1130
+
1131
+ ### Parameters
1132
+
1133
+ |Name | Type | Description | Notes|
1134
+ |------------- | ------------- | ------------- | -------------|
1135
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
1136
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
1137
+
1138
+
1139
+ ### Return type
1140
+
1141
+ **Array<string>**
1142
+
1143
+ ### Authorization
1144
+
1145
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
1146
+
1147
+ ### HTTP request headers
1148
+
1149
+ - **Content-Type**: Not defined
1150
+ - **Accept**: application/json, application/yaml
1151
+
1152
+
1153
+ ### HTTP response details
1154
+ | Status code | Description | Response headers |
1155
+ |-------------|-------------|------------------|
1156
+ |**200** | Solution security users list successfully retrieved | - |
1157
+ |**404** | Solution not found or insufficient access rights | - |
1158
+
1159
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1160
+
1161
+ # **listSolutions**
1162
+ > Array<Solution> listSolutions()
1163
+
1164
+
1165
+ ### Example
1166
+
1167
+ ```typescript
1168
+ import {
1169
+ SolutionApi,
1170
+ Configuration
1171
+ } from '@cosmotech/api-ts';
1172
+
1173
+ const configuration = new Configuration();
1174
+ const apiInstance = new SolutionApi(configuration);
1175
+
1176
+ let organizationId: string; //The Organization identifier (default to undefined)
1177
+ let page: number; //Page number to query (zero-based indexing) (optional) (default to undefined)
1178
+ let size: number; //Number of records per page (optional) (default to undefined)
1179
+
1180
+ const { status, data } = await apiInstance.listSolutions(
1181
+ organizationId,
1182
+ page,
1183
+ size
1184
+ );
1185
+ ```
1186
+
1187
+ ### Parameters
1188
+
1189
+ |Name | Type | Description | Notes|
1190
+ |------------- | ------------- | ------------- | -------------|
1191
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
1192
+ | **page** | [**number**] | Page number to query (zero-based indexing) | (optional) defaults to undefined|
1193
+ | **size** | [**number**] | Number of records per page | (optional) defaults to undefined|
1194
+
1195
+
1196
+ ### Return type
1197
+
1198
+ **Array<Solution>**
1199
+
1200
+ ### Authorization
1201
+
1202
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
1203
+
1204
+ ### HTTP request headers
1205
+
1206
+ - **Content-Type**: Not defined
1207
+ - **Accept**: application/json, application/yaml
1208
+
1209
+
1210
+ ### HTTP response details
1211
+ | Status code | Description | Response headers |
1212
+ |-------------|-------------|------------------|
1213
+ |**200** | List of solutions successfully retrieved | - |
1214
+
1215
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1216
+
1217
+ # **updateSolution**
1218
+ > Solution updateSolution(solutionUpdateRequest)
1219
+
1220
+
1221
+ ### Example
1222
+
1223
+ ```typescript
1224
+ import {
1225
+ SolutionApi,
1226
+ Configuration,
1227
+ SolutionUpdateRequest
1228
+ } from '@cosmotech/api-ts';
1229
+
1230
+ const configuration = new Configuration();
1231
+ const apiInstance = new SolutionApi(configuration);
1232
+
1233
+ let organizationId: string; //The Organization identifier (default to undefined)
1234
+ let solutionId: string; //The Solution identifier (default to undefined)
1235
+ let solutionUpdateRequest: SolutionUpdateRequest; //The new Solution details. This endpoint can\'t be used to update security
1236
+
1237
+ const { status, data } = await apiInstance.updateSolution(
1238
+ organizationId,
1239
+ solutionId,
1240
+ solutionUpdateRequest
1241
+ );
1242
+ ```
1243
+
1244
+ ### Parameters
1245
+
1246
+ |Name | Type | Description | Notes|
1247
+ |------------- | ------------- | ------------- | -------------|
1248
+ | **solutionUpdateRequest** | **SolutionUpdateRequest**| The new Solution details. This endpoint can\&#39;t be used to update security | |
1249
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
1250
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
1251
+
1252
+
1253
+ ### Return type
1254
+
1255
+ **Solution**
1256
+
1257
+ ### Authorization
1258
+
1259
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
1260
+
1261
+ ### HTTP request headers
1262
+
1263
+ - **Content-Type**: application/json, application/yaml
1264
+ - **Accept**: application/json, application/yaml
1265
+
1266
+
1267
+ ### HTTP response details
1268
+ | Status code | Description | Response headers |
1269
+ |-------------|-------------|------------------|
1270
+ |**200** | Solution successfully updated | - |
1271
+ |**400** | Bad request - Invalid update parameters | - |
1272
+ |**404** | Solution not found or insufficient access rights | - |
1273
+
1274
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1275
+
1276
+ # **updateSolutionAccessControl**
1277
+ > SolutionAccessControl updateSolutionAccessControl(solutionRole)
1278
+
1279
+
1280
+ ### Example
1281
+
1282
+ ```typescript
1283
+ import {
1284
+ SolutionApi,
1285
+ Configuration,
1286
+ SolutionRole
1287
+ } from '@cosmotech/api-ts';
1288
+
1289
+ const configuration = new Configuration();
1290
+ const apiInstance = new SolutionApi(configuration);
1291
+
1292
+ let organizationId: string; //The Organization identifier (default to undefined)
1293
+ let solutionId: string; //The Solution identifier (default to undefined)
1294
+ let identityId: string; //The User identifier (default to undefined)
1295
+ let solutionRole: SolutionRole; //Access control updates
1296
+
1297
+ const { status, data } = await apiInstance.updateSolutionAccessControl(
1298
+ organizationId,
1299
+ solutionId,
1300
+ identityId,
1301
+ solutionRole
1302
+ );
1303
+ ```
1304
+
1305
+ ### Parameters
1306
+
1307
+ |Name | Type | Description | Notes|
1308
+ |------------- | ------------- | ------------- | -------------|
1309
+ | **solutionRole** | **SolutionRole**| Access control updates | |
1310
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
1311
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
1312
+ | **identityId** | [**string**] | The User identifier | defaults to undefined|
1313
+
1314
+
1315
+ ### Return type
1316
+
1317
+ **SolutionAccessControl**
1318
+
1319
+ ### Authorization
1320
+
1321
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
1322
+
1323
+ ### HTTP request headers
1324
+
1325
+ - **Content-Type**: application/json, application/yaml
1326
+ - **Accept**: application/json, application/yaml
1327
+
1328
+
1329
+ ### HTTP response details
1330
+ | Status code | Description | Response headers |
1331
+ |-------------|-------------|------------------|
1332
+ |**200** | Solution access control successfully updated | - |
1333
+ |**404** | Solution not found or insufficient access rights | - |
1334
+
1335
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1336
+
1337
+ # **updateSolutionDefaultSecurity**
1338
+ > SolutionSecurity updateSolutionDefaultSecurity(solutionRole)
1339
+
1340
+
1341
+ ### Example
1342
+
1343
+ ```typescript
1344
+ import {
1345
+ SolutionApi,
1346
+ Configuration,
1347
+ SolutionRole
1348
+ } from '@cosmotech/api-ts';
1349
+
1350
+ const configuration = new Configuration();
1351
+ const apiInstance = new SolutionApi(configuration);
1352
+
1353
+ let organizationId: string; //the Organization identifier (default to undefined)
1354
+ let solutionId: string; //the Solution identifier (default to undefined)
1355
+ let solutionRole: SolutionRole; //This changes the solution default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the solution.
1356
+
1357
+ const { status, data } = await apiInstance.updateSolutionDefaultSecurity(
1358
+ organizationId,
1359
+ solutionId,
1360
+ solutionRole
1361
+ );
1362
+ ```
1363
+
1364
+ ### Parameters
1365
+
1366
+ |Name | Type | Description | Notes|
1367
+ |------------- | ------------- | ------------- | -------------|
1368
+ | **solutionRole** | **SolutionRole**| This changes the solution default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the solution. | |
1369
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
1370
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
1371
+
1372
+
1373
+ ### Return type
1374
+
1375
+ **SolutionSecurity**
1376
+
1377
+ ### Authorization
1378
+
1379
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
1380
+
1381
+ ### HTTP request headers
1382
+
1383
+ - **Content-Type**: application/json, application/yaml
1384
+ - **Accept**: application/json, application/yaml
1385
+
1386
+
1387
+ ### HTTP response details
1388
+ | Status code | Description | Response headers |
1389
+ |-------------|-------------|------------------|
1390
+ |**200** | Solution default security successfully updated | - |
1391
+ |**404** | Solution not found or insufficient access rights | - |
1392
+
1393
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1394
+
1395
+ # **updateSolutionParameter**
1396
+ > RunTemplateParameter updateSolutionParameter(runTemplateParameterUpdateRequest)
1397
+
1398
+
1399
+ ### Example
1400
+
1401
+ ```typescript
1402
+ import {
1403
+ SolutionApi,
1404
+ Configuration,
1405
+ RunTemplateParameterUpdateRequest
1406
+ } from '@cosmotech/api-ts';
1407
+
1408
+ const configuration = new Configuration();
1409
+ const apiInstance = new SolutionApi(configuration);
1410
+
1411
+ let organizationId: string; //The Organization identifier (default to undefined)
1412
+ let solutionId: string; //The Solution identifier (default to undefined)
1413
+ let parameterId: string; //The solution parameter identifier (default to undefined)
1414
+ let runTemplateParameterUpdateRequest: RunTemplateParameterUpdateRequest; //Parameter to update
1415
+
1416
+ const { status, data } = await apiInstance.updateSolutionParameter(
1417
+ organizationId,
1418
+ solutionId,
1419
+ parameterId,
1420
+ runTemplateParameterUpdateRequest
1421
+ );
1422
+ ```
1423
+
1424
+ ### Parameters
1425
+
1426
+ |Name | Type | Description | Notes|
1427
+ |------------- | ------------- | ------------- | -------------|
1428
+ | **runTemplateParameterUpdateRequest** | **RunTemplateParameterUpdateRequest**| Parameter to update | |
1429
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
1430
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
1431
+ | **parameterId** | [**string**] | The solution parameter identifier | defaults to undefined|
1432
+
1433
+
1434
+ ### Return type
1435
+
1436
+ **RunTemplateParameter**
1437
+
1438
+ ### Authorization
1439
+
1440
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
1441
+
1442
+ ### HTTP request headers
1443
+
1444
+ - **Content-Type**: application/json, application/yaml
1445
+ - **Accept**: application/json, application/yaml
1446
+
1447
+
1448
+ ### HTTP response details
1449
+ | Status code | Description | Response headers |
1450
+ |-------------|-------------|------------------|
1451
+ |**201** | Parameters successfully updated | - |
1452
+ |**400** | Bad request | - |
1453
+ |**404** | Solution or parameter not found or insufficient access rights | - |
1454
+
1455
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1456
+
1457
+ # **updateSolutionParameterGroup**
1458
+ > RunTemplateParameterGroup updateSolutionParameterGroup(runTemplateParameterGroupUpdateRequest)
1459
+
1460
+
1461
+ ### Example
1462
+
1463
+ ```typescript
1464
+ import {
1465
+ SolutionApi,
1466
+ Configuration,
1467
+ RunTemplateParameterGroupUpdateRequest
1468
+ } from '@cosmotech/api-ts';
1469
+
1470
+ const configuration = new Configuration();
1471
+ const apiInstance = new SolutionApi(configuration);
1472
+
1473
+ let organizationId: string; //The Organization identifier (default to undefined)
1474
+ let solutionId: string; //The Solution identifier (default to undefined)
1475
+ let parameterGroupId: string; //The parameter group identifier (default to undefined)
1476
+ let runTemplateParameterGroupUpdateRequest: RunTemplateParameterGroupUpdateRequest; //Parameter groups to update
1477
+
1478
+ const { status, data } = await apiInstance.updateSolutionParameterGroup(
1479
+ organizationId,
1480
+ solutionId,
1481
+ parameterGroupId,
1482
+ runTemplateParameterGroupUpdateRequest
1483
+ );
1484
+ ```
1485
+
1486
+ ### Parameters
1487
+
1488
+ |Name | Type | Description | Notes|
1489
+ |------------- | ------------- | ------------- | -------------|
1490
+ | **runTemplateParameterGroupUpdateRequest** | **RunTemplateParameterGroupUpdateRequest**| Parameter groups to update | |
1491
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
1492
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
1493
+ | **parameterGroupId** | [**string**] | The parameter group identifier | defaults to undefined|
1494
+
1495
+
1496
+ ### Return type
1497
+
1498
+ **RunTemplateParameterGroup**
1499
+
1500
+ ### Authorization
1501
+
1502
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
1503
+
1504
+ ### HTTP request headers
1505
+
1506
+ - **Content-Type**: application/json, application/yaml
1507
+ - **Accept**: application/json, application/yaml
1508
+
1509
+
1510
+ ### HTTP response details
1511
+ | Status code | Description | Response headers |
1512
+ |-------------|-------------|------------------|
1513
+ |**200** | Parameter groups successfully updated | - |
1514
+ |**400** | Bad request - Invalid parameter group | - |
1515
+ |**404** | Solution or parameter group not found or insufficient access rights | - |
1516
+
1517
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1518
+
1519
+ # **updateSolutionRunTemplate**
1520
+ > RunTemplate updateSolutionRunTemplate(runTemplateUpdateRequest)
1521
+
1522
+
1523
+ ### Example
1524
+
1525
+ ```typescript
1526
+ import {
1527
+ SolutionApi,
1528
+ Configuration,
1529
+ RunTemplateUpdateRequest
1530
+ } from '@cosmotech/api-ts';
1531
+
1532
+ const configuration = new Configuration();
1533
+ const apiInstance = new SolutionApi(configuration);
1534
+
1535
+ let organizationId: string; //The Organization identifier (default to undefined)
1536
+ let solutionId: string; //The Solution identifier (default to undefined)
1537
+ let runTemplateId: string; //The Run Template identifier (default to undefined)
1538
+ let runTemplateUpdateRequest: RunTemplateUpdateRequest; //Run template updates
1539
+
1540
+ const { status, data } = await apiInstance.updateSolutionRunTemplate(
1541
+ organizationId,
1542
+ solutionId,
1543
+ runTemplateId,
1544
+ runTemplateUpdateRequest
1545
+ );
1546
+ ```
1547
+
1548
+ ### Parameters
1549
+
1550
+ |Name | Type | Description | Notes|
1551
+ |------------- | ------------- | ------------- | -------------|
1552
+ | **runTemplateUpdateRequest** | **RunTemplateUpdateRequest**| Run template updates | |
1553
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
1554
+ | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
1555
+ | **runTemplateId** | [**string**] | The Run Template identifier | defaults to undefined|
1556
+
1557
+
1558
+ ### Return type
1559
+
1560
+ **RunTemplate**
1561
+
1562
+ ### Authorization
1563
+
1564
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
1565
+
1566
+ ### HTTP request headers
1567
+
1568
+ - **Content-Type**: application/json, application/yaml
1569
+ - **Accept**: application/json, application/yaml
1570
+
1571
+
1572
+ ### HTTP response details
1573
+ | Status code | Description | Response headers |
1574
+ |-------------|-------------|------------------|
1575
+ |**200** | Run template successfully updated | - |
1576
+ |**400** | Bad request - Invalid run template updates | - |
1577
+ |**404** | Solution or run template not found or insufficient access rights | - |
1578
+
1579
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1580
+