@cosmotech/api-ts 5.0.0-rc5 → 5.0.0

package/dist/base.d.ts

@@ -2,7 +2,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 5.0.0-rc5
+ * The version of the OpenAPI document: 5.0.0
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/base.js

@@ -5,7 +5,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 5.0.0-rc5
+ * The version of the OpenAPI document: 5.0.0
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/common.d.ts

@@ -2,7 +2,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 5.0.0-rc5
+ * The version of the OpenAPI document: 5.0.0
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/common.js

@@ -5,7 +5,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 5.0.0-rc5
+ * The version of the OpenAPI document: 5.0.0
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/configuration.d.ts

@@ -2,7 +2,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 5.0.0-rc5
+ * The version of the OpenAPI document: 5.0.0
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/configuration.js

@@ -4,7 +4,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 5.0.0-rc5
+ * The version of the OpenAPI document: 5.0.0
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.d.ts

@@ -2,7 +2,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 5.0.0-rc5
+ * The version of the OpenAPI document: 5.0.0
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.js

@@ -5,7 +5,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 5.0.0-rc5
+ * The version of the OpenAPI document: 5.0.0
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/DatasetApi.md

@@ -29,6 +29,7 @@ All URIs are relative to *http://localhost:8080*
 # **createDataset**
 > Dataset createDataset()
 
+Create a new dataset in the workspace. The dataset is initialized with specified parts (can be empty). The dataset can also be populated through dataset parts.
 
 ### Example
 
@@ -153,6 +154,7 @@ const { status, data } = await apiInstance.createDatasetAccessControl(
 # **createDatasetPart**
 > DatasetPart createDatasetPart()
 
+Create a new data part within a dataset. Specify type as \'File\' for file storage or \'DB\' for database storage. Returns the created part.
 
 ### Example
 
@@ -219,7 +221,7 @@ const { status, data } = await apiInstance.createDatasetPart(
 # **deleteDataset**
 > deleteDataset()
 
-Delete a dataset
+Permanently delete a dataset and all its data parts. This operation cannot be undone.
 
 ### Example
 
@@ -278,6 +280,7 @@ void (empty response body)
 # **deleteDatasetAccessControl**
 > deleteDatasetAccessControl()
 
+Remove a user or group\'s access to a dataset. Cannot remove the last administrator - at least one admin must remain.
 
 ### Example
 
@@ -400,6 +403,7 @@ void (empty response body)
 # **downloadDatasetPart**
 > File downloadDatasetPart()
 
+Download the file content from a dataset part. Returns the file as an application/octet-stream.
 
 ### Example
 
@@ -461,7 +465,7 @@ const { status, data } = await apiInstance.downloadDatasetPart(
 # **getDataset**
 > Dataset getDataset()
 
-Retrieve a dataset
+Retrieve complete information about a specific dataset including dataset parts.
 
 ### Example
 
@@ -641,6 +645,7 @@ const { status, data } = await apiInstance.getDatasetPart(
 # **listDatasetParts**
 > Array<DatasetPart> listDatasetParts()
 
+Retrieve all data parts associated with a dataset.
 
 ### Example
 
@@ -762,7 +767,7 @@ const { status, data } = await apiInstance.listDatasetSecurityUsers(
 # **listDatasets**
 > Array<Dataset> listDatasets()
 
-List all datasets
+Retrieve a paginated list of all datasets in the specified workspace. Supports pagination via \'page\' and \'size\' query parameters. Returns datasets based on user permissions.
 
 ### Example
 
@@ -824,6 +829,7 @@ const { status, data } = await apiInstance.listDatasets(
 # **queryData**
 > File queryData()
 
+Execute a query against a dataset part. Results are returned as plain-text CSV. Only available for parts with type=DB.
 
 ### Example
 
@@ -1118,7 +1124,7 @@ const { status, data } = await apiInstance.searchDatasets(
 # **updateDataset**
 > Dataset updateDataset()
 
-Update a dataset
+Update dataset information and return the updated dataset.
 
 ### Example
 

package/docs/MetaApi.md

@@ -9,6 +9,7 @@ All URIs are relative to *http://localhost:8080*
 # **about**
 > AboutInfo about()
 
+Retrieve API version information and build details.
 
 ### Example
 

package/docs/OrganizationApi.md

@@ -22,6 +22,7 @@ All URIs are relative to *http://localhost:8080*
 # **createOrganization**
 > Organization createOrganization(organizationCreateRequest)
 
+Create a new organization.
 
 ### Example
 
@@ -35,7 +36,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new OrganizationApi(configuration);
 
-let organizationCreateRequest: OrganizationCreateRequest; //The Organization to create
+let organizationCreateRequest: OrganizationCreateRequest; //
 
 const { status, data } = await apiInstance.createOrganization(
     organizationCreateRequest
@@ -46,7 +47,7 @@ const { status, data } = await apiInstance.createOrganization(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **organizationCreateRequest** | **OrganizationCreateRequest**| The Organization to create | |
+| **organizationCreateRequest** | **OrganizationCreateRequest**|  | |
 
 
 ### Return type
@@ -74,6 +75,7 @@ const { status, data } = await apiInstance.createOrganization(
 # **createOrganizationAccessControl**
 > OrganizationAccessControl createOrganizationAccessControl(organizationAccessControl)
 
+Grant access to an organization for a user or group.
 
 ### Example
 
@@ -129,6 +131,7 @@ const { status, data } = await apiInstance.createOrganizationAccessControl(
 # **deleteOrganization**
 > deleteOrganization()
 
+Permanently delete an organization. This operation cannot be undone.
 
 ### Example
 
@@ -234,6 +237,7 @@ void (empty response body)
 # **getOrganization**
 > Organization getOrganization()
 
+Retrieve detailed information about an organization.
 
 ### Example
 
@@ -494,6 +498,7 @@ const { status, data } = await apiInstance.listOrganizationSecurityUsers(
 # **listOrganizations**
 > Array<Organization> listOrganizations()
 
+Retrieve a paginated list of all organizations the authenticated user has permission to view. Use \'page\' and \'size\' query parameters for pagination.
 
 ### Example
 

package/docs/RunApi.md

@@ -74,6 +74,7 @@ void (empty response body)
 # **getRun**
 > Run getRun()
 
+Retrieve detailed information about a specific run.
 
 ### Example
 
@@ -134,6 +135,7 @@ const { status, data } = await apiInstance.getRun(
 # **getRunLogs**
 > string getRunLogs()
 
+Retrieve execution logs for a run as plain text. Logs are aggregated from all containers. May be truncated for long-running simulations.
 
 ### Example
 
@@ -193,6 +195,7 @@ const { status, data } = await apiInstance.getRunLogs(
 # **getRunStatus**
 > RunStatus getRunStatus()
 
+Retrieve detailed execution status of a run.
 
 ### Example
 
@@ -252,6 +255,7 @@ const { status, data } = await apiInstance.getRunStatus(
 # **listRuns**
 > Array<Run> listRuns()
 
+Retrieve a paginated list of all runs for a specific runner.
 
 ### Example
 

package/docs/RunnerApi.md

@@ -23,6 +23,7 @@ All URIs are relative to *http://localhost:8080*
 # **createRunner**
 > Runner createRunner(runnerCreateRequest)
 
+Create a new runner for executing simulations. Use parentId to create a child runner that inherits configuration from a parent.
 
 ### Example
 
@@ -81,6 +82,7 @@ const { status, data } = await apiInstance.createRunner(
 # **createRunnerAccessControl**
 > RunnerAccessControl createRunnerAccessControl(runnerAccessControl)
 
+Grant access to a runner for a user or group. Valid roles: viewer, editor, validator (can validate runs), admin.
 
 ### Example
 
@@ -142,6 +144,7 @@ const { status, data } = await apiInstance.createRunnerAccessControl(
 # **deleteRunner**
 > deleteRunner()
 
+Delete a runner. Cannot delete while runs are in progress. Note: Child runners that reference this runner are not deleted automatically.
 
 ### Example
 
@@ -259,6 +262,7 @@ void (empty response body)
 # **getRunner**
 > Runner getRunner()
 
+Retrieve detailed information about a runner.
 
 ### Example
 
@@ -549,6 +553,7 @@ const { status, data } = await apiInstance.listRunnerSecurityUsers(
 # **listRunners**
 > Array<Runner> listRunners()
 
+Retrieve a paginated list of all runners in a workspace.
 
 ### Example
 
@@ -608,6 +613,7 @@ const { status, data } = await apiInstance.listRunners(
 # **startRun**
 > CreatedRun startRun()
 
+Start a new simulation run using the runner\'s current configuration. Returns the run Id. The run executes asynchronously - use the run status endpoint to monitor progress
 
 ### Example
 
@@ -665,6 +671,7 @@ const { status, data } = await apiInstance.startRun(
 # **stopRun**
 > stopRun()
 
+Stop the currently executing run for this runner. The stop operation is asynchronous - the run may continue briefly before stopping.
 
 ### Example
 

package/docs/SolutionApi.md

@@ -35,6 +35,7 @@ All URIs are relative to *http://localhost:8080*
 # **createSolution**
 > Solution createSolution(solutionCreateRequest)
 
+Create a new solution with optional run templates and parameter definitions.
 
 ### Example
 
@@ -90,6 +91,7 @@ const { status, data } = await apiInstance.createSolution(
 # **createSolutionAccessControl**
 > SolutionAccessControl createSolutionAccessControl(solutionAccessControl)
 
+Grant access to a solution for a user or group.
 
 ### Example
 
@@ -664,6 +666,7 @@ const { status, data } = await apiInstance.getRunTemplate(
 # **getSolution**
 > Solution getSolution()
 
+Retrieve detailed information about a solution.
 
 ### Example
 
@@ -1161,6 +1164,7 @@ const { status, data } = await apiInstance.listSolutionSecurityUsers(
 # **listSolutions**
 > Array<Solution> listSolutions()
 
+Retrieve a paginated list of all solutions in an organization that the user has permission to view.
 
 ### Example
 

package/docs/WorkspaceApi.md

@@ -26,6 +26,7 @@ All URIs are relative to *http://localhost:8080*
 # **createWorkspace**
 > Workspace createWorkspace(workspaceCreateRequest)
 
+Create a new workspace.
 
 ### Example
 
@@ -81,6 +82,7 @@ const { status, data } = await apiInstance.createWorkspace(
 # **createWorkspaceAccessControl**
 > WorkspaceAccessControl createWorkspaceAccessControl(workspaceAccessControl)
 
+Grant access to a workspace for a user or group.
 
 ### Example
 
@@ -139,6 +141,7 @@ const { status, data } = await apiInstance.createWorkspaceAccessControl(
 # **createWorkspaceFile**
 > WorkspaceFile createWorkspaceFile()
 
+Upload a file to workspace storage. Use \'destination\' to specify path, \'overwrite\' to replace existing files.
 
 ### Example
 
@@ -202,6 +205,7 @@ const { status, data } = await apiInstance.createWorkspaceFile(
 # **deleteWorkspace**
 > deleteWorkspace()
 
+Permanently delete a workspace.
 
 ### Example
 
@@ -257,6 +261,7 @@ void (empty response body)
 # **deleteWorkspaceAccessControl**
 > deleteWorkspaceAccessControl()
 
+Remove a user\'s access to a workspace. Cannot remove the last administrator.
 
 ### Example
 
@@ -425,6 +430,7 @@ void (empty response body)
 # **getWorkspace**
 > Workspace getWorkspace()
 
+Retrieve detailed information about a workspace.
 
 ### Example
 
@@ -536,6 +542,7 @@ const { status, data } = await apiInstance.getWorkspaceAccessControl(
 # **getWorkspaceFile**
 > File getWorkspaceFile()
 
+Download a specific file from workspace storage. Returns file as binary stream.
 
 ### Example
 
@@ -811,6 +818,7 @@ const { status, data } = await apiInstance.listWorkspaceSecurityUsers(
 # **listWorkspaces**
 > Array<Workspace> listWorkspaces()
 
+Retrieve a paginated list of all workspaces in an organization that the user has permission to view.
 
 ### Example
 

package/index.ts

@@ -4,7 +4,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 5.0.0-rc5
+ * The version of the OpenAPI document: 5.0.0
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cosmotech/api-ts",
-  "version": "5.0.0-rc5",
+  "version": "5.0.0",
   "description": "OpenAPI client for @cosmotech/api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {