@cosmotech/api-ts 4.0.0-dev9 → 5.0.0-beta4

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