@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,96 @@
1
+ .gitignore
2
+ .npmignore
3
+ .openapi-generator-ignore
4
+ README.md
5
+ api.ts
6
+ base.ts
7
+ common.ts
8
+ configuration.ts
9
+ docs/AboutInfo.md
10
+ docs/AboutInfoVersion.md
11
+ docs/ComponentRolePermissions.md
12
+ docs/ContainerResourceSizeInfo.md
13
+ docs/ContainerResourceSizing.md
14
+ docs/CreateInfo.md
15
+ docs/CreatedRun.md
16
+ docs/Dataset.md
17
+ docs/DatasetAccessControl.md
18
+ docs/DatasetApi.md
19
+ docs/DatasetCreateRequest.md
20
+ docs/DatasetPart.md
21
+ docs/DatasetPartCreateRequest.md
22
+ docs/DatasetPartTypeEnum.md
23
+ docs/DatasetPartUpdateRequest.md
24
+ docs/DatasetRole.md
25
+ docs/DatasetSecurity.md
26
+ docs/DatasetUpdateRequest.md
27
+ docs/EditInfo.md
28
+ docs/LastRunInfo.md
29
+ docs/MetaApi.md
30
+ docs/Organization.md
31
+ docs/OrganizationAccessControl.md
32
+ docs/OrganizationApi.md
33
+ docs/OrganizationCreateRequest.md
34
+ docs/OrganizationEditInfo.md
35
+ docs/OrganizationRole.md
36
+ docs/OrganizationSecurity.md
37
+ docs/OrganizationUpdateRequest.md
38
+ docs/QueryResult.md
39
+ docs/ResourceSizeInfo.md
40
+ docs/Run.md
41
+ docs/RunApi.md
42
+ docs/RunContainer.md
43
+ docs/RunData.md
44
+ docs/RunDataQuery.md
45
+ docs/RunEditInfo.md
46
+ docs/RunResourceRequested.md
47
+ docs/RunState.md
48
+ docs/RunStatus.md
49
+ docs/RunStatusNode.md
50
+ docs/RunTemplate.md
51
+ docs/RunTemplateCreateRequest.md
52
+ docs/RunTemplateParameter.md
53
+ docs/RunTemplateParameterCreateRequest.md
54
+ docs/RunTemplateParameterGroup.md
55
+ docs/RunTemplateParameterGroupCreateRequest.md
56
+ docs/RunTemplateParameterGroupUpdateRequest.md
57
+ docs/RunTemplateParameterUpdateRequest.md
58
+ docs/RunTemplateParameterValue.md
59
+ docs/RunTemplateResourceSizing.md
60
+ docs/RunTemplateUpdateRequest.md
61
+ docs/Runner.md
62
+ docs/RunnerAccessControl.md
63
+ docs/RunnerApi.md
64
+ docs/RunnerCreateRequest.md
65
+ docs/RunnerEditInfo.md
66
+ docs/RunnerResourceSizing.md
67
+ docs/RunnerRole.md
68
+ docs/RunnerRunTemplateParameterValue.md
69
+ docs/RunnerSecurity.md
70
+ docs/RunnerUpdateRequest.md
71
+ docs/RunnerValidationStatus.md
72
+ docs/SendRunDataRequest.md
73
+ docs/Solution.md
74
+ docs/SolutionAccessControl.md
75
+ docs/SolutionApi.md
76
+ docs/SolutionCreateRequest.md
77
+ docs/SolutionEditInfo.md
78
+ docs/SolutionFile.md
79
+ docs/SolutionRole.md
80
+ docs/SolutionSecurity.md
81
+ docs/SolutionUpdateRequest.md
82
+ docs/Workspace.md
83
+ docs/WorkspaceAccessControl.md
84
+ docs/WorkspaceApi.md
85
+ docs/WorkspaceCreateRequest.md
86
+ docs/WorkspaceEditInfo.md
87
+ docs/WorkspaceFile.md
88
+ docs/WorkspaceRole.md
89
+ docs/WorkspaceSecurity.md
90
+ docs/WorkspaceSolution.md
91
+ docs/WorkspaceUpdateRequest.md
92
+ docs/WorkspaceWebApp.md
93
+ git_push.sh
94
+ index.ts
95
+ package.json
96
+ tsconfig.json
@@ -0,0 +1 @@
1
+ 7.13.0
@@ -0,0 +1,23 @@
1
+ # OpenAPI Generator Ignore
2
+ # Generated by openapi-generator https://github.com/openapitools/openapi-generator
3
+
4
+ # Use this file to prevent files from being overwritten by the generator.
5
+ # The patterns follow closely to .gitignore or .dockerignore.
6
+
7
+ # As an example, the C# client generator defines ApiClient.cs.
8
+ # You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
9
+ #ApiClient.cs
10
+
11
+ # You can match any string of characters against a directory, file or extension with a single asterisk (*):
12
+ #foo/*/qux
13
+ # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
14
+
15
+ # You can recursively match patterns against a directory, file or extension with a double asterisk (**):
16
+ #foo/**/qux
17
+ # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
18
+
19
+ # You can also negate patterns with an exclamation (!).
20
+ # For example, you can ignore all files in a docs folder with the file extension .md:
21
+ #docs/*.md
22
+ # Then explicitly reverse the ignore rule for a single file:
23
+ #!docs/README.md
package/LICENSE CHANGED
@@ -1,7 +1,7 @@
1
1
  LICENSE
2
2
  =======
3
3
 
4
- Copyright 2021-2022 Cosmo Tech
4
+ Copyright 2021-2025 Cosmo Tech
5
5
 
6
6
  You are authorized to use this software following the execution of a specific agreement with Cosmo Tech or with an authorized licensee of Cosmo Tech.
7
7
 
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @cosmotech/api-ts@4.0.0-onprem.9
1
+ ## @cosmotech/api-ts@5.0.0-beta4
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @cosmotech/api-ts@4.0.0-onprem.9 --save
39
+ npm install @cosmotech/api-ts@5.0.0-beta4 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -44,3 +44,213 @@ _unPublished (not recommended):_
44
44
  ```
45
45
  npm install PATH_TO_GENERATED_PACKAGE --save
46
46
  ```
47
+
48
+ ### Documentation for API Endpoints
49
+
50
+ All URIs are relative to *http://localhost:8080*
51
+
52
+ Class | Method | HTTP request | Description
53
+ ------------ | ------------- | ------------- | -------------
54
+ *DatasetApi* | [**createDataset**](docs/DatasetApi.md#createdataset) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets | Create a Dataset
55
+ *DatasetApi* | [**createDatasetAccessControl**](docs/DatasetApi.md#createdatasetaccesscontrol) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access | Add a control access to the Dataset
56
+ *DatasetApi* | [**createDatasetPart**](docs/DatasetApi.md#createdatasetpart) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts | Create a data part of a Dataset
57
+ *DatasetApi* | [**deleteDataset**](docs/DatasetApi.md#deletedataset) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Delete a Dataset
58
+ *DatasetApi* | [**deleteDatasetAccessControl**](docs/DatasetApi.md#deletedatasetaccesscontrol) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access/{identity_id} | Remove the specified access from the given Dataset
59
+ *DatasetApi* | [**deleteDatasetPart**](docs/DatasetApi.md#deletedatasetpart) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id} | Delete a Dataset part
60
+ *DatasetApi* | [**downloadDatasetPart**](docs/DatasetApi.md#downloaddatasetpart) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id}/download | Download data from a dataset part
61
+ *DatasetApi* | [**getDataset**](docs/DatasetApi.md#getdataset) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Retrieve a Dataset
62
+ *DatasetApi* | [**getDatasetAccessControl**](docs/DatasetApi.md#getdatasetaccesscontrol) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access/{identity_id} | Get a control access for the Dataset
63
+ *DatasetApi* | [**getDatasetPart**](docs/DatasetApi.md#getdatasetpart) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id} | Retrieve a data part of a Dataset
64
+ *DatasetApi* | [**listDatasetParts**](docs/DatasetApi.md#listdatasetparts) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts | Retrieve all dataset parts of a Dataset
65
+ *DatasetApi* | [**listDatasetSecurityUsers**](docs/DatasetApi.md#listdatasetsecurityusers) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/users | Get the Dataset security users list
66
+ *DatasetApi* | [**listDatasets**](docs/DatasetApi.md#listdatasets) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets | Retrieve a list of defined Dataset
67
+ *DatasetApi* | [**queryData**](docs/DatasetApi.md#querydata) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id}/query | Get data of a Dataset
68
+ *DatasetApi* | [**replaceDatasetPart**](docs/DatasetApi.md#replacedatasetpart) | **PUT** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id} | Replace existing dataset parts of a Dataset
69
+ *DatasetApi* | [**searchDatasetParts**](docs/DatasetApi.md#searchdatasetparts) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/search | Search Dataset parts by tags
70
+ *DatasetApi* | [**searchDatasets**](docs/DatasetApi.md#searchdatasets) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/search | Search Datasets by tags
71
+ *DatasetApi* | [**updateDataset**](docs/DatasetApi.md#updatedataset) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Update a Dataset
72
+ *DatasetApi* | [**updateDatasetAccessControl**](docs/DatasetApi.md#updatedatasetaccesscontrol) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access/{identity_id} | Update the specified access to User for a Dataset
73
+ *DatasetApi* | [**updateDatasetDefaultSecurity**](docs/DatasetApi.md#updatedatasetdefaultsecurity) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/default | Set the Dataset default security
74
+ *MetaApi* | [**about**](docs/MetaApi.md#about) | **GET** /about | Get various information about the API
75
+ *OrganizationApi* | [**createOrganization**](docs/OrganizationApi.md#createorganization) | **POST** /organizations | Create a new organization
76
+ *OrganizationApi* | [**createOrganizationAccessControl**](docs/OrganizationApi.md#createorganizationaccesscontrol) | **POST** /organizations/{organization_id}/security/access | Add a control access to the Organization
77
+ *OrganizationApi* | [**deleteOrganization**](docs/OrganizationApi.md#deleteorganization) | **DELETE** /organizations/{organization_id} | Delete an organization
78
+ *OrganizationApi* | [**deleteOrganizationAccessControl**](docs/OrganizationApi.md#deleteorganizationaccesscontrol) | **DELETE** /organizations/{organization_id}/security/access/{identity_id} | Remove the specified access from the given Organization
79
+ *OrganizationApi* | [**getOrganization**](docs/OrganizationApi.md#getorganization) | **GET** /organizations/{organization_id} | Get the details of an Organization
80
+ *OrganizationApi* | [**getOrganizationAccessControl**](docs/OrganizationApi.md#getorganizationaccesscontrol) | **GET** /organizations/{organization_id}/security/access/{identity_id} | Get a control access for the Organization
81
+ *OrganizationApi* | [**getOrganizationPermissions**](docs/OrganizationApi.md#getorganizationpermissions) | **GET** /organizations/{organization_id}/permissions/{role} | Get the Organization permissions by given role
82
+ *OrganizationApi* | [**getOrganizationSecurity**](docs/OrganizationApi.md#getorganizationsecurity) | **GET** /organizations/{organization_id}/security | Get the Organization security information
83
+ *OrganizationApi* | [**listOrganizationSecurityUsers**](docs/OrganizationApi.md#listorganizationsecurityusers) | **GET** /organizations/{organization_id}/security/users | Get the Organization security users list
84
+ *OrganizationApi* | [**listOrganizations**](docs/OrganizationApi.md#listorganizations) | **GET** /organizations | List all Organizations
85
+ *OrganizationApi* | [**listPermissions**](docs/OrganizationApi.md#listpermissions) | **GET** /organizations/permissions | Get all permissions per components
86
+ *OrganizationApi* | [**updateOrganization**](docs/OrganizationApi.md#updateorganization) | **PATCH** /organizations/{organization_id} | Update an Organization
87
+ *OrganizationApi* | [**updateOrganizationAccessControl**](docs/OrganizationApi.md#updateorganizationaccesscontrol) | **PATCH** /organizations/{organization_id}/security/access/{identity_id} | Update the specified access to User for an Organization
88
+ *OrganizationApi* | [**updateOrganizationDefaultSecurity**](docs/OrganizationApi.md#updateorganizationdefaultsecurity) | **PATCH** /organizations/{organization_id}/security/default | Update the Organization default security
89
+ *RunApi* | [**deleteRun**](docs/RunApi.md#deleterun) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id} | Delete a run
90
+ *RunApi* | [**getRun**](docs/RunApi.md#getrun) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id} | Get the details of a run
91
+ *RunApi* | [**getRunLogs**](docs/RunApi.md#getrunlogs) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/logs | get the logs for the Run
92
+ *RunApi* | [**getRunStatus**](docs/RunApi.md#getrunstatus) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/status | get the status for the Run
93
+ *RunApi* | [**listRuns**](docs/RunApi.md#listruns) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs | get the list of Runs for the Runner
94
+ *RunApi* | [**queryRunData**](docs/RunApi.md#queryrundata) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/query | query the run data
95
+ *RunApi* | [**sendRunData**](docs/RunApi.md#sendrundata) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/send | Send data associated to a run
96
+ *RunnerApi* | [**createRunner**](docs/RunnerApi.md#createrunner) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners | Create a new Runner
97
+ *RunnerApi* | [**createRunnerAccessControl**](docs/RunnerApi.md#createrunneraccesscontrol) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access | Add a control access to the Runner
98
+ *RunnerApi* | [**deleteRunner**](docs/RunnerApi.md#deleterunner) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Delete a runner
99
+ *RunnerApi* | [**deleteRunnerAccessControl**](docs/RunnerApi.md#deleterunneraccesscontrol) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id} | Remove the specified access from the given Runner
100
+ *RunnerApi* | [**getRunner**](docs/RunnerApi.md#getrunner) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Get the details of a runner
101
+ *RunnerApi* | [**getRunnerAccessControl**](docs/RunnerApi.md#getrunneraccesscontrol) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id} | Get a control access for the Runner
102
+ *RunnerApi* | [**getRunnerSecurity**](docs/RunnerApi.md#getrunnersecurity) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security | Get the Runner security information
103
+ *RunnerApi* | [**listRunnerPermissions**](docs/RunnerApi.md#listrunnerpermissions) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/permissions/{role} | Get the Runner permission by given role
104
+ *RunnerApi* | [**listRunnerSecurityUsers**](docs/RunnerApi.md#listrunnersecurityusers) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/users | Get the Runner security users list
105
+ *RunnerApi* | [**listRunners**](docs/RunnerApi.md#listrunners) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners | List all Runners
106
+ *RunnerApi* | [**startRun**](docs/RunnerApi.md#startrun) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/start | Start a run with runner parameters
107
+ *RunnerApi* | [**stopRun**](docs/RunnerApi.md#stoprun) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/stop | Stop the last run
108
+ *RunnerApi* | [**updateRunner**](docs/RunnerApi.md#updaterunner) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Update a runner
109
+ *RunnerApi* | [**updateRunnerAccessControl**](docs/RunnerApi.md#updaterunneraccesscontrol) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id} | Update the specified access to User for a Runner
110
+ *RunnerApi* | [**updateRunnerDefaultSecurity**](docs/RunnerApi.md#updaterunnerdefaultsecurity) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/default | Set the Runner default security
111
+ *SolutionApi* | [**createSolution**](docs/SolutionApi.md#createsolution) | **POST** /organizations/{organization_id}/solutions | Create a new solution
112
+ *SolutionApi* | [**createSolutionAccessControl**](docs/SolutionApi.md#createsolutionaccesscontrol) | **POST** /organizations/{organization_id}/solutions/{solution_id}/security/access | Create solution access control
113
+ *SolutionApi* | [**createSolutionFile**](docs/SolutionApi.md#createsolutionfile) | **POST** /organizations/{organization_id}/solutions/{solution_id}/files | Upload a file for the Solution
114
+ *SolutionApi* | [**createSolutionParameter**](docs/SolutionApi.md#createsolutionparameter) | **POST** /organizations/{organization_id}/solutions/{solution_id}/parameters | Create solution parameter for a solution
115
+ *SolutionApi* | [**createSolutionParameterGroup**](docs/SolutionApi.md#createsolutionparametergroup) | **POST** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | Create a solution parameter group
116
+ *SolutionApi* | [**createSolutionRunTemplate**](docs/SolutionApi.md#createsolutionruntemplate) | **POST** /organizations/{organization_id}/solutions/{solution_id}/runTemplates | Create a solution run template
117
+ *SolutionApi* | [**deleteSolution**](docs/SolutionApi.md#deletesolution) | **DELETE** /organizations/{organization_id}/solutions/{solution_id} | Delete a solution
118
+ *SolutionApi* | [**deleteSolutionAccessControl**](docs/SolutionApi.md#deletesolutionaccesscontrol) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Delete solution access control
119
+ *SolutionApi* | [**deleteSolutionFile**](docs/SolutionApi.md#deletesolutionfile) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/files/delete | Delete a solution file
120
+ *SolutionApi* | [**deleteSolutionFiles**](docs/SolutionApi.md#deletesolutionfiles) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/files | Delete all Solution files
121
+ *SolutionApi* | [**deleteSolutionParameter**](docs/SolutionApi.md#deletesolutionparameter) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/parameters/{parameter_id} | Delete specific parameter from the solution
122
+ *SolutionApi* | [**deleteSolutionParameterGroup**](docs/SolutionApi.md#deletesolutionparametergroup) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups/{parameter_group_id} | Delete a parameter group from the solution
123
+ *SolutionApi* | [**deleteSolutionRunTemplate**](docs/SolutionApi.md#deletesolutionruntemplate) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Delete a specific run template
124
+ *SolutionApi* | [**getRunTemplate**](docs/SolutionApi.md#getruntemplate) | **GET** /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Retrieve a solution run templates
125
+ *SolutionApi* | [**getSolution**](docs/SolutionApi.md#getsolution) | **GET** /organizations/{organization_id}/solutions/{solution_id} | Get the details of a solution
126
+ *SolutionApi* | [**getSolutionAccessControl**](docs/SolutionApi.md#getsolutionaccesscontrol) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Get solution access control
127
+ *SolutionApi* | [**getSolutionFile**](docs/SolutionApi.md#getsolutionfile) | **GET** /organizations/{organization_id}/solutions/{solution_id}/files/download | Download the Solution File specified
128
+ *SolutionApi* | [**getSolutionParameter**](docs/SolutionApi.md#getsolutionparameter) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameters/{parameter_id} | Get the details of a solution parameter
129
+ *SolutionApi* | [**getSolutionParameterGroup**](docs/SolutionApi.md#getsolutionparametergroup) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups/{parameter_group_id} | Get details of a solution parameter group
130
+ *SolutionApi* | [**getSolutionSecurity**](docs/SolutionApi.md#getsolutionsecurity) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security | Get solution security information
131
+ *SolutionApi* | [**listRunTemplates**](docs/SolutionApi.md#listruntemplates) | **GET** /organizations/{organization_id}/solutions/{solution_id}/runTemplates | List all solution run templates
132
+ *SolutionApi* | [**listSolutionFiles**](docs/SolutionApi.md#listsolutionfiles) | **GET** /organizations/{organization_id}/solutions/{solution_id}/files | List all Solution files
133
+ *SolutionApi* | [**listSolutionParameterGroups**](docs/SolutionApi.md#listsolutionparametergroups) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | List all solution parameter groups
134
+ *SolutionApi* | [**listSolutionParameters**](docs/SolutionApi.md#listsolutionparameters) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameters | List all solution parameters
135
+ *SolutionApi* | [**listSolutionSecurityUsers**](docs/SolutionApi.md#listsolutionsecurityusers) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security/users | List solution security users
136
+ *SolutionApi* | [**listSolutions**](docs/SolutionApi.md#listsolutions) | **GET** /organizations/{organization_id}/solutions | List all Solutions
137
+ *SolutionApi* | [**updateSolution**](docs/SolutionApi.md#updatesolution) | **PATCH** /organizations/{organization_id}/solutions/{solution_id} | Update a solution
138
+ *SolutionApi* | [**updateSolutionAccessControl**](docs/SolutionApi.md#updatesolutionaccesscontrol) | **PATCH** /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Update solution access control
139
+ *SolutionApi* | [**updateSolutionDefaultSecurity**](docs/SolutionApi.md#updatesolutiondefaultsecurity) | **PATCH** /organizations/{organization_id}/solutions/{solution_id}/security/default | Update solution default security
140
+ *SolutionApi* | [**updateSolutionParameter**](docs/SolutionApi.md#updatesolutionparameter) | **PATCH** /organizations/{organization_id}/solutions/{solution_id}/parameters/{parameter_id} | Update solution parameter
141
+ *SolutionApi* | [**updateSolutionParameterGroup**](docs/SolutionApi.md#updatesolutionparametergroup) | **PATCH** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups/{parameter_group_id} | Update a solution parameter group
142
+ *SolutionApi* | [**updateSolutionRunTemplate**](docs/SolutionApi.md#updatesolutionruntemplate) | **PATCH** /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Update a specific run template
143
+ *WorkspaceApi* | [**createWorkspace**](docs/WorkspaceApi.md#createworkspace) | **POST** /organizations/{organization_id}/workspaces | Create a new workspace
144
+ *WorkspaceApi* | [**createWorkspaceAccessControl**](docs/WorkspaceApi.md#createworkspaceaccesscontrol) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/security/access | Add a control access to the Workspace
145
+ *WorkspaceApi* | [**createWorkspaceFile**](docs/WorkspaceApi.md#createworkspacefile) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/files | Upload a file for the Workspace
146
+ *WorkspaceApi* | [**deleteWorkspace**](docs/WorkspaceApi.md#deleteworkspace) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id} | Delete a workspace
147
+ *WorkspaceApi* | [**deleteWorkspaceAccessControl**](docs/WorkspaceApi.md#deleteworkspaceaccesscontrol) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/security/access/{identity_id} | Remove the specified access from the given Workspace
148
+ *WorkspaceApi* | [**deleteWorkspaceFile**](docs/WorkspaceApi.md#deleteworkspacefile) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/files/delete | Delete a workspace file
149
+ *WorkspaceApi* | [**deleteWorkspaceFiles**](docs/WorkspaceApi.md#deleteworkspacefiles) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/files | Delete all Workspace files
150
+ *WorkspaceApi* | [**getWorkspace**](docs/WorkspaceApi.md#getworkspace) | **GET** /organizations/{organization_id}/workspaces/{workspace_id} | Get the details of a workspace
151
+ *WorkspaceApi* | [**getWorkspaceAccessControl**](docs/WorkspaceApi.md#getworkspaceaccesscontrol) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/security/access/{identity_id} | Get a control access for the Workspace
152
+ *WorkspaceApi* | [**getWorkspaceFile**](docs/WorkspaceApi.md#getworkspacefile) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/files/download | Download the Workspace File specified
153
+ *WorkspaceApi* | [**getWorkspaceSecurity**](docs/WorkspaceApi.md#getworkspacesecurity) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/security | Get the Workspace security information
154
+ *WorkspaceApi* | [**listWorkspaceFiles**](docs/WorkspaceApi.md#listworkspacefiles) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/files | List all Workspace files
155
+ *WorkspaceApi* | [**listWorkspaceRolePermissions**](docs/WorkspaceApi.md#listworkspacerolepermissions) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/permissions/{role} | Get the Workspace permission by given role
156
+ *WorkspaceApi* | [**listWorkspaceSecurityUsers**](docs/WorkspaceApi.md#listworkspacesecurityusers) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/security/users | Get the Workspace security users list
157
+ *WorkspaceApi* | [**listWorkspaces**](docs/WorkspaceApi.md#listworkspaces) | **GET** /organizations/{organization_id}/workspaces | List all Workspaces
158
+ *WorkspaceApi* | [**updateWorkspace**](docs/WorkspaceApi.md#updateworkspace) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id} | Update a workspace
159
+ *WorkspaceApi* | [**updateWorkspaceAccessControl**](docs/WorkspaceApi.md#updateworkspaceaccesscontrol) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/security/access/{identity_id} | Update the specified access to User for a Workspace
160
+ *WorkspaceApi* | [**updateWorkspaceDefaultSecurity**](docs/WorkspaceApi.md#updateworkspacedefaultsecurity) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/security/default | Update the Workspace default security
161
+
162
+
163
+ ### Documentation For Models
164
+
165
+ - [AboutInfo](docs/AboutInfo.md)
166
+ - [AboutInfoVersion](docs/AboutInfoVersion.md)
167
+ - [ComponentRolePermissions](docs/ComponentRolePermissions.md)
168
+ - [ContainerResourceSizeInfo](docs/ContainerResourceSizeInfo.md)
169
+ - [ContainerResourceSizing](docs/ContainerResourceSizing.md)
170
+ - [CreateInfo](docs/CreateInfo.md)
171
+ - [CreatedRun](docs/CreatedRun.md)
172
+ - [Dataset](docs/Dataset.md)
173
+ - [DatasetAccessControl](docs/DatasetAccessControl.md)
174
+ - [DatasetCreateRequest](docs/DatasetCreateRequest.md)
175
+ - [DatasetPart](docs/DatasetPart.md)
176
+ - [DatasetPartCreateRequest](docs/DatasetPartCreateRequest.md)
177
+ - [DatasetPartTypeEnum](docs/DatasetPartTypeEnum.md)
178
+ - [DatasetPartUpdateRequest](docs/DatasetPartUpdateRequest.md)
179
+ - [DatasetRole](docs/DatasetRole.md)
180
+ - [DatasetSecurity](docs/DatasetSecurity.md)
181
+ - [DatasetUpdateRequest](docs/DatasetUpdateRequest.md)
182
+ - [EditInfo](docs/EditInfo.md)
183
+ - [LastRunInfo](docs/LastRunInfo.md)
184
+ - [Organization](docs/Organization.md)
185
+ - [OrganizationAccessControl](docs/OrganizationAccessControl.md)
186
+ - [OrganizationCreateRequest](docs/OrganizationCreateRequest.md)
187
+ - [OrganizationEditInfo](docs/OrganizationEditInfo.md)
188
+ - [OrganizationRole](docs/OrganizationRole.md)
189
+ - [OrganizationSecurity](docs/OrganizationSecurity.md)
190
+ - [OrganizationUpdateRequest](docs/OrganizationUpdateRequest.md)
191
+ - [QueryResult](docs/QueryResult.md)
192
+ - [ResourceSizeInfo](docs/ResourceSizeInfo.md)
193
+ - [Run](docs/Run.md)
194
+ - [RunContainer](docs/RunContainer.md)
195
+ - [RunData](docs/RunData.md)
196
+ - [RunDataQuery](docs/RunDataQuery.md)
197
+ - [RunEditInfo](docs/RunEditInfo.md)
198
+ - [RunResourceRequested](docs/RunResourceRequested.md)
199
+ - [RunState](docs/RunState.md)
200
+ - [RunStatus](docs/RunStatus.md)
201
+ - [RunStatusNode](docs/RunStatusNode.md)
202
+ - [RunTemplate](docs/RunTemplate.md)
203
+ - [RunTemplateCreateRequest](docs/RunTemplateCreateRequest.md)
204
+ - [RunTemplateParameter](docs/RunTemplateParameter.md)
205
+ - [RunTemplateParameterCreateRequest](docs/RunTemplateParameterCreateRequest.md)
206
+ - [RunTemplateParameterGroup](docs/RunTemplateParameterGroup.md)
207
+ - [RunTemplateParameterGroupCreateRequest](docs/RunTemplateParameterGroupCreateRequest.md)
208
+ - [RunTemplateParameterGroupUpdateRequest](docs/RunTemplateParameterGroupUpdateRequest.md)
209
+ - [RunTemplateParameterUpdateRequest](docs/RunTemplateParameterUpdateRequest.md)
210
+ - [RunTemplateParameterValue](docs/RunTemplateParameterValue.md)
211
+ - [RunTemplateResourceSizing](docs/RunTemplateResourceSizing.md)
212
+ - [RunTemplateUpdateRequest](docs/RunTemplateUpdateRequest.md)
213
+ - [Runner](docs/Runner.md)
214
+ - [RunnerAccessControl](docs/RunnerAccessControl.md)
215
+ - [RunnerCreateRequest](docs/RunnerCreateRequest.md)
216
+ - [RunnerEditInfo](docs/RunnerEditInfo.md)
217
+ - [RunnerResourceSizing](docs/RunnerResourceSizing.md)
218
+ - [RunnerRole](docs/RunnerRole.md)
219
+ - [RunnerRunTemplateParameterValue](docs/RunnerRunTemplateParameterValue.md)
220
+ - [RunnerSecurity](docs/RunnerSecurity.md)
221
+ - [RunnerUpdateRequest](docs/RunnerUpdateRequest.md)
222
+ - [RunnerValidationStatus](docs/RunnerValidationStatus.md)
223
+ - [SendRunDataRequest](docs/SendRunDataRequest.md)
224
+ - [Solution](docs/Solution.md)
225
+ - [SolutionAccessControl](docs/SolutionAccessControl.md)
226
+ - [SolutionCreateRequest](docs/SolutionCreateRequest.md)
227
+ - [SolutionEditInfo](docs/SolutionEditInfo.md)
228
+ - [SolutionFile](docs/SolutionFile.md)
229
+ - [SolutionRole](docs/SolutionRole.md)
230
+ - [SolutionSecurity](docs/SolutionSecurity.md)
231
+ - [SolutionUpdateRequest](docs/SolutionUpdateRequest.md)
232
+ - [Workspace](docs/Workspace.md)
233
+ - [WorkspaceAccessControl](docs/WorkspaceAccessControl.md)
234
+ - [WorkspaceCreateRequest](docs/WorkspaceCreateRequest.md)
235
+ - [WorkspaceEditInfo](docs/WorkspaceEditInfo.md)
236
+ - [WorkspaceFile](docs/WorkspaceFile.md)
237
+ - [WorkspaceRole](docs/WorkspaceRole.md)
238
+ - [WorkspaceSecurity](docs/WorkspaceSecurity.md)
239
+ - [WorkspaceSolution](docs/WorkspaceSolution.md)
240
+ - [WorkspaceUpdateRequest](docs/WorkspaceUpdateRequest.md)
241
+ - [WorkspaceWebApp](docs/WorkspaceWebApp.md)
242
+
243
+
244
+ <a id="documentation-for-authorization"></a>
245
+ ## Documentation For Authorization
246
+
247
+
248
+ Authentication schemes defined for the API:
249
+ <a id="oAuth2AuthCode"></a>
250
+ ### oAuth2AuthCode
251
+
252
+ - **Type**: OAuth
253
+ - **Flow**: accessCode
254
+ - **Authorization URL**: https://example.com/authorize
255
+ - **Scopes**: N/A
256
+