@cosmotech/api-ts 5.0.0-beta5 → 5.0.0-rc1

package/docs/DatasetApi.md

@@ -17,7 +17,7 @@ All URIs are relative to *http://localhost:8080*
 |[**listDatasetParts**](#listdatasetparts) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts | Retrieve all dataset parts of a Dataset|
 |[**listDatasetSecurityUsers**](#listdatasetsecurityusers) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/users | Get the Dataset security users list|
 |[**listDatasets**](#listdatasets) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets | Retrieve a list of defined Dataset|
-|[**queryData**](#querydata) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id}/query | Get data of a Dataset|
+|[**queryData**](#querydata) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id}/query | Query data of a Dataset part. This endpoint is only available for dataset parts that support queries (type == DB). |
 |[**replaceDatasetPart**](#replacedatasetpart) | **PUT** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id} | Replace existing dataset parts of a Dataset|
 |[**searchDatasetParts**](#searchdatasetparts) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/search | Search Dataset parts by tags|
 |[**searchDatasets**](#searchdatasets) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/search | Search Datasets by tags|
@@ -699,7 +699,6 @@ const { status, data } = await apiInstance.listDatasetParts(
 |**200** | List of dataset parts |  -  |
 |**403** | Insufficient permissions on organization, workspace or dataset |  -  |
 |**404** | Dataset specified is not found |  -  |
-|**422** | Targeted dataset do not support requests |  -  |
 
 [[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)
 
@@ -823,7 +822,7 @@ const { status, data } = await apiInstance.listDatasets(
 [[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)
 
 # **queryData**
-> Array<object> queryData()
+> File queryData()
 
 
 ### Example
@@ -841,22 +840,32 @@ let organizationId: string; //the Organization identifier (default to undefined)
 let workspaceId: string; //the Workspace identifier (default to undefined)
 let datasetId: string; //the Dataset identifier (default to undefined)
 let datasetPartId: string; //the Dataset part identifier (default to undefined)
-let filters: Array<string>; //Property names that should be part of the response data. You can specify a property name like:  - id  - stock  - quantity  - ...  (optional) (default to undefined)
-let sums: Array<string>; //Property names to sum by (optional) (default to undefined)
-let counts: Array<string>; //Property names to count by (optional) (default to undefined)
+let selects: Array<string>; //Column names that should be part of the response data. You can specify a column name like:  - id  - stock  - quantity  - ... If you want to select only distinct columns, add a * at the end of the column name (e.g. stock*).  (optional) (default to undefined)
+let sums: Array<string>; //Column names to sum by. If you want to sum only distinct columns, add a * at the end of the column name (e.g. stock*).  (optional) (default to undefined)
+let avgs: Array<string>; //Column names to average by. If you want to apply \'average\' only on distinct columns, add a * at the end of the column name (e.g. stock*).  (optional) (default to undefined)
+let counts: Array<string>; //Column names to count by. If you want to count only distinct columns, add a * at the end of the column name (e.g. stock*).  (optional) (default to undefined)
+let mins: Array<string>; //Column names to min by. If you want to apply \'min\' only on distinct columns, add a * at the end of the column name (e.g. stock*).  (optional) (default to undefined)
+let maxs: Array<string>; //Column names to max by. If you want to apply \'max\' only on distinct columns, add a * at the end of the column name (e.g. stock*).  (optional) (default to undefined)
 let offset: number; //The query offset (optional) (default to undefined)
 let limit: number; //The query limit (optional) (default to undefined)
+let groupBys: Array<string>; //Column names to group by (optional) (default to undefined)
+let orderBys: Array<string>; //Column names to order by. Default order is ascending. If you want to specify \'descending\' order, add a \'!\' at the beginning of the column name (e.g. !stock).  (optional) (default to undefined)
 
 const { status, data } = await apiInstance.queryData(
     organizationId,
     workspaceId,
     datasetId,
     datasetPartId,
-    filters,
+    selects,
     sums,
+    avgs,
     counts,
+    mins,
+    maxs,
     offset,
-    limit
+    limit,
+    groupBys,
+    orderBys
 );
 ```
 
@@ -868,16 +877,21 @@ const { status, data } = await apiInstance.queryData(
 | **workspaceId** | [**string**] | the Workspace identifier | defaults to undefined|
 | **datasetId** | [**string**] | the Dataset identifier | defaults to undefined|
 | **datasetPartId** | [**string**] | the Dataset part identifier | defaults to undefined|
-| **filters** | **Array&lt;string&gt;** | Property names that should be part of the response data. You can specify a property name like:  - id  - stock  - quantity  - ...  | (optional) defaults to undefined|
-| **sums** | **Array&lt;string&gt;** | Property names to sum by | (optional) defaults to undefined|
-| **counts** | **Array&lt;string&gt;** | Property names to count by | (optional) defaults to undefined|
+| **selects** | **Array&lt;string&gt;** | Column names that should be part of the response data. You can specify a column name like:  - id  - stock  - quantity  - ... If you want to select only distinct columns, add a * at the end of the column name (e.g. stock*).  | (optional) defaults to undefined|
+| **sums** | **Array&lt;string&gt;** | Column names to sum by. If you want to sum only distinct columns, add a * at the end of the column name (e.g. stock*).  | (optional) defaults to undefined|
+| **avgs** | **Array&lt;string&gt;** | Column names to average by. If you want to apply \&#39;average\&#39; only on distinct columns, add a * at the end of the column name (e.g. stock*).  | (optional) defaults to undefined|
+| **counts** | **Array&lt;string&gt;** | Column names to count by. If you want to count only distinct columns, add a * at the end of the column name (e.g. stock*).  | (optional) defaults to undefined|
+| **mins** | **Array&lt;string&gt;** | Column names to min by. If you want to apply \&#39;min\&#39; only on distinct columns, add a * at the end of the column name (e.g. stock*).  | (optional) defaults to undefined|
+| **maxs** | **Array&lt;string&gt;** | Column names to max by. If you want to apply \&#39;max\&#39; only on distinct columns, add a * at the end of the column name (e.g. stock*).  | (optional) defaults to undefined|
 | **offset** | [**number**] | The query offset | (optional) defaults to undefined|
 | **limit** | [**number**] | The query limit | (optional) defaults to undefined|
+| **groupBys** | **Array&lt;string&gt;** | Column names to group by | (optional) defaults to undefined|
+| **orderBys** | **Array&lt;string&gt;** | Column names to order by. Default order is ascending. If you want to specify \&#39;descending\&#39; order, add a \&#39;!\&#39; at the beginning of the column name (e.g. !stock).  | (optional) defaults to undefined|
 
 
 ### Return type
 
-**Array<object>**
+**File**
 
 ### Authorization
 
@@ -886,7 +900,7 @@ const { status, data } = await apiInstance.queryData(
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: application/json, application/yaml
+ - **Accept**: application/octet-stream
 
 
 ### HTTP response details
@@ -963,9 +977,9 @@ const { status, data } = await apiInstance.replaceDatasetPart(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | Dataset part successfully replaced |  -  |
+|**400** | Bad request |  -  |
 |**403** | Insufficient permissions on organization, workspace or dataset |  -  |
 |**404** | Dataset part specified is not found |  -  |
-|**422** | Targeted dataset do not support requests |  -  |
 
 [[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)
 
@@ -1031,6 +1045,9 @@ const { status, data } = await apiInstance.searchDatasetParts(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | Dataset part list containing tags |  -  |
+|**400** | Bad request |  -  |
+|**403** | Insufficient permissions on organization, workspace or dataset |  -  |
+|**404** | Dataset specified is not found or you don\&#39;t have access to it |  -  |
 
 [[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)
 
@@ -1093,6 +1110,8 @@ const { status, data } = await apiInstance.searchDatasets(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | Dataset list containing tags |  -  |
+|**403** | Insufficient permissions on organization, workspace or dataset |  -  |
+|**404** | Organization, workspace or dataset specified is not found |  -  |
 
 [[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)
 
@@ -1348,9 +1367,9 @@ const { status, data } = await apiInstance.updateDatasetPart(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | Dataset part information successfully updated |  -  |
+|**400** | Bad request |  -  |
 |**403** | Insufficient permissions on organization, workspace or dataset |  -  |
 |**404** | Dataset part specified is not found |  -  |
-|**422** | Targeted dataset do not support requests |  -  |
 
 [[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)
 

package/docs/DatasetCreateInfo.md

@@ -0,0 +1,24 @@
+# DatasetCreateInfo
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**timestamp** | **number** | The timestamp of the creation in millisecond | [default to undefined]
+**userId** | **string** | The id of the user who did the creation | [default to undefined]
+**runnerId** | **string** | The runner id which has created the dataset (nullable) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DatasetCreateInfo } from '@cosmotech/api-ts';
+
+const instance: DatasetCreateInfo = {
+    timestamp,
+    userId,
+    runnerId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/DatasetCreateRequest.md

@@ -9,9 +9,9 @@ Name | Type | Description | Notes
 **name** | **string** |  | [default to undefined]
 **description** | **string** |  | [optional] [default to undefined]
 **tags** | **Array<string>** |  | [optional] [default to undefined]
+**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
 **parts** | [**Array<DatasetPartCreateRequest>**](DatasetPartCreateRequest.md) |  | [optional] [default to undefined]
 **security** | [**DatasetSecurity**](DatasetSecurity.md) |  | [optional] [default to undefined]
-**runnerId** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -22,9 +22,9 @@ const instance: DatasetCreateRequest = {
     name,
     description,
     tags,
+    additionalData,
     parts,
     security,
-    runnerId,
 };
 ```
 

package/docs/DatasetEditInfo.md

@@ -0,0 +1,22 @@
+# DatasetEditInfo
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**timestamp** | **number** | The timestamp of the modification in millisecond | [default to undefined]
+**userId** | **string** | The id of the user who did the modification | [default to undefined]
+
+## Example
+
+```typescript
+import { DatasetEditInfo } from '@cosmotech/api-ts';
+
+const instance: DatasetEditInfo = {
+    timestamp,
+    userId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/DatasetPart.md

@@ -11,12 +11,13 @@ Name | Type | Description | Notes
 **sourceName** | **string** | the source data name (e.g. filename associated to the dataset part) | [default to undefined]
 **description** | **string** |  | [optional] [default to undefined]
 **tags** | **Array<string>** |  | [default to undefined]
+**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
 **type** | [**DatasetPartTypeEnum**](DatasetPartTypeEnum.md) |  | [default to undefined]
 **organizationId** | **string** | the associated Organization Id | [readonly] [default to undefined]
 **workspaceId** | **string** | the associated Workspace Id | [readonly] [default to undefined]
 **datasetId** | **string** | the associated Dataset Id | [readonly] [default to undefined]
-**createInfo** | [**EditInfo**](EditInfo.md) | The details of the Dataset creation | [default to undefined]
-**updateInfo** | [**EditInfo**](EditInfo.md) | The details of the Dataset last update | [default to undefined]
+**createInfo** | [**DatasetEditInfo**](DatasetEditInfo.md) | The details of the Dataset creation | [default to undefined]
+**updateInfo** | [**DatasetEditInfo**](DatasetEditInfo.md) | The details of the Dataset last update | [default to undefined]
 
 ## Example
 
@@ -29,6 +30,7 @@ const instance: DatasetPart = {
     sourceName,
     description,
     tags,
+    additionalData,
     type,
     organizationId,
     workspaceId,

package/docs/DatasetPartCreateRequest.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **sourceName** | **string** | the source data name (e.g. filename associated to the dataset part) | [default to undefined]
 **description** | **string** |  | [optional] [default to undefined]
 **tags** | **Array<string>** |  | [optional] [default to undefined]
+**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
 **type** | [**DatasetPartTypeEnum**](DatasetPartTypeEnum.md) |  | [optional] [default to undefined]
 
 ## Example
@@ -22,6 +23,7 @@ const instance: DatasetPartCreateRequest = {
     sourceName,
     description,
     tags,
+    additionalData,
     type,
 };
 ```

package/docs/DatasetPartUpdateRequest.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **sourceName** | **string** | the source data name (e.g. filename associated to the dataset part) | [optional] [default to undefined]
 **description** | **string** |  | [optional] [default to undefined]
 **tags** | **Array<string>** |  | [optional] [default to undefined]
+**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
 
 ## Example
 
@@ -19,6 +20,7 @@ const instance: DatasetPartUpdateRequest = {
     sourceName,
     description,
     tags,
+    additionalData,
 };
 ```
 

package/docs/DatasetUpdateRequest.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **name** | **string** |  | [optional] [default to undefined]
 **description** | **string** |  | [optional] [default to undefined]
 **tags** | **Array<string>** |  | [optional] [default to undefined]
+**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
 **parts** | [**Array<DatasetPartCreateRequest>**](DatasetPartCreateRequest.md) |  | [optional] [default to undefined]
 **security** | [**DatasetSecurity**](DatasetSecurity.md) |  | [optional] [default to undefined]
 
@@ -21,6 +22,7 @@ const instance: DatasetUpdateRequest = {
     name,
     description,
     tags,
+    additionalData,
     parts,
     security,
 };

package/docs/RunApi.md

@@ -9,8 +9,6 @@ All URIs are relative to *http://localhost:8080*
 |[**getRunLogs**](#getrunlogs) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/logs | get the logs for the Run|
 |[**getRunStatus**](#getrunstatus) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/status | get the status for the Run|
 |[**listRuns**](#listruns) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs | get the list of Runs for the Runner|
-|[**queryRunData**](#queryrundata) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/query | query the run data|
-|[**sendRunData**](#sendrundata) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/send | Send data associated to a run|
 
 # **deleteRun**
 > deleteRun()
@@ -313,130 +311,3 @@ const { status, data } = await apiInstance.listRuns(
 
 [[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)
 
-# **queryRunData**
-> QueryResult queryRunData(runDataQuery)
-
-
-### Example
-
-```typescript
-import {
-    RunApi,
-    Configuration,
-    RunDataQuery
-} from '@cosmotech/api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new RunApi(configuration);
-
-let organizationId: string; //the Organization identifier (default to undefined)
-let workspaceId: string; //the Workspace identifier (default to undefined)
-let runnerId: string; //the Runner identifier (default to undefined)
-let runId: string; //the Run identifier (default to undefined)
-let runDataQuery: RunDataQuery; //the query to run
-
-const { status, data } = await apiInstance.queryRunData(
-    organizationId,
-    workspaceId,
-    runnerId,
-    runId,
-    runDataQuery
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **runDataQuery** | **RunDataQuery**| the query to run | |
-| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
-| **workspaceId** | [**string**] | the Workspace identifier | defaults to undefined|
-| **runnerId** | [**string**] | the Runner identifier | defaults to undefined|
-| **runId** | [**string**] | the Run identifier | defaults to undefined|
-
-
-### Return type
-
-**QueryResult**
-
-### Authorization
-
-[oAuth2AuthCode](../README.md#oAuth2AuthCode)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, application/yaml
- - **Accept**: application/json, application/yaml
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | the query response |  -  |
-
-[[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)
-
-# **sendRunData**
-> RunData sendRunData(sendRunDataRequest)
-
-
-### Example
-
-```typescript
-import {
-    RunApi,
-    Configuration,
-    SendRunDataRequest
-} from '@cosmotech/api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new RunApi(configuration);
-
-let organizationId: string; //the Organization identifier (default to undefined)
-let workspaceId: string; //the Workspace identifier (default to undefined)
-let runnerId: string; //the Runner identifier (default to undefined)
-let runId: string; //the Run identifier (default to undefined)
-let sendRunDataRequest: SendRunDataRequest; //Custom data to register
-
-const { status, data } = await apiInstance.sendRunData(
-    organizationId,
-    workspaceId,
-    runnerId,
-    runId,
-    sendRunDataRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **sendRunDataRequest** | **SendRunDataRequest**| Custom data to register | |
-| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
-| **workspaceId** | [**string**] | the Workspace identifier | defaults to undefined|
-| **runnerId** | [**string**] | the Runner identifier | defaults to undefined|
-| **runId** | [**string**] | the Run identifier | defaults to undefined|
-
-
-### Return type
-
-**RunData**
-
-### Authorization
-
-[oAuth2AuthCode](../README.md#oAuth2AuthCode)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, application/yaml
- - **Accept**: application/json, application/yaml
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**201** | Data stored |  -  |
-|**400** | Data sent format is malformed |  -  |
-
-[[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)
-

package/docs/RunData.md

@@ -1,6 +1,6 @@
 # RunData
 
-Run Data stored
+Run Data to send
 
 ## Properties
 

package/docs/RunTemplateParameter.md

@@ -13,8 +13,7 @@ Name | Type | Description | Notes
 **defaultValue** | **string** | The default value for this parameter | [optional] [default to undefined]
 **minValue** | **string** | The minimum value for this parameter | [optional] [default to undefined]
 **maxValue** | **string** | The maximum value for this parameter | [optional] [default to undefined]
-**regexValidation** | **string** | A regex to validate the value | [optional] [default to undefined]
-**_options** | **{ [key: string]: any; }** | Freeform options | [optional] [default to undefined]
+**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
 
 ## Example
 
@@ -29,8 +28,7 @@ const instance: RunTemplateParameter = {
     defaultValue,
     minValue,
     maxValue,
-    regexValidation,
-    _options,
+    additionalData,
 };
 ```
 

package/docs/RunTemplateParameterCreateRequest.md

@@ -13,8 +13,7 @@ Name | Type | Description | Notes
 **defaultValue** | **string** | The default value for this parameter | [optional] [default to undefined]
 **minValue** | **string** | The minimum value for this parameter | [optional] [default to undefined]
 **maxValue** | **string** | The maximum value for this parameter | [optional] [default to undefined]
-**regexValidation** | **string** | A regex to validate the value | [optional] [default to undefined]
-**_options** | **{ [key: string]: any; }** | Freeform options | [optional] [default to undefined]
+**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
 
 ## Example
 
@@ -29,8 +28,7 @@ const instance: RunTemplateParameterCreateRequest = {
     defaultValue,
     minValue,
     maxValue,
-    regexValidation,
-    _options,
+    additionalData,
 };
 ```
 

package/docs/RunTemplateParameterGroup.md

@@ -9,9 +9,7 @@ Name | Type | Description | Notes
 **id** | **string** | The Parameter Group id | [default to undefined]
 **description** | **string** | A description of the parameter group | [optional] [default to undefined]
 **labels** | **{ [key: string]: string; }** | A translated label with key as ISO 639-1 code | [optional] [default to undefined]
-**isTable** | **boolean** | Does the group define a table | [default to undefined]
-**_options** | **{ [key: string]: any; }** | Freeform options | [optional] [default to undefined]
-**parentId** | **string** | The Run Template Group parent Id | [optional] [default to undefined]
+**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
 **parameters** | **Array<string>** | An ordered list of Run Template Parameters | [default to undefined]
 
 ## Example
@@ -23,9 +21,7 @@ const instance: RunTemplateParameterGroup = {
     id,
     description,
     labels,
-    isTable,
-    _options,
-    parentId,
+    additionalData,
     parameters,
 };
 ```

package/docs/RunTemplateParameterGroupCreateRequest.md

@@ -9,9 +9,7 @@ Name | Type | Description | Notes
 **id** | **string** | The Parameter Group id | [default to undefined]
 **description** | **string** | A description of the parameter group | [optional] [default to undefined]
 **labels** | **{ [key: string]: string; }** | A translated label with key as ISO 639-1 code | [optional] [default to undefined]
-**isTable** | **boolean** | Does the group define a table | [optional] [default to false]
-**_options** | **{ [key: string]: any; }** | Freeform options | [optional] [default to undefined]
-**parentId** | **string** | The Run Template Group parent Id | [optional] [default to undefined]
+**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
 **parameters** | **Array<string>** | An ordered list of Run Template Parameters | [optional] [default to undefined]
 
 ## Example
@@ -23,9 +21,7 @@ const instance: RunTemplateParameterGroupCreateRequest = {
     id,
     description,
     labels,
-    isTable,
-    _options,
-    parentId,
+    additionalData,
     parameters,
 };
 ```

package/docs/RunTemplateParameterGroupUpdateRequest.md

@@ -8,9 +8,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **description** | **string** | A description of the parameter group | [optional] [default to undefined]
 **labels** | **{ [key: string]: string; }** | A translated label with key as ISO 639-1 code | [optional] [default to undefined]
-**isTable** | **boolean** | Does the group define a table | [optional] [default to undefined]
-**_options** | **{ [key: string]: any; }** | Freeform options | [optional] [default to undefined]
-**parentId** | **string** | The Run Template Group parent Id | [optional] [default to undefined]
+**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
 **parameters** | **Array<string>** | An ordered list of Run Template Parameters | [optional] [default to undefined]
 
 ## Example
@@ -21,9 +19,7 @@ import { RunTemplateParameterGroupUpdateRequest } from '@cosmotech/api-ts';
 const instance: RunTemplateParameterGroupUpdateRequest = {
     description,
     labels,
-    isTable,
-    _options,
-    parentId,
+    additionalData,
     parameters,
 };
 ```

package/docs/RunTemplateParameterUpdateRequest.md

@@ -12,8 +12,7 @@ Name | Type | Description | Notes
 **defaultValue** | **string** | The default value for this parameter | [optional] [default to undefined]
 **minValue** | **string** | The minimum value for this parameter | [optional] [default to undefined]
 **maxValue** | **string** | The maximum value for this parameter | [optional] [default to undefined]
-**regexValidation** | **string** | A regex to validate the value | [optional] [default to undefined]
-**_options** | **{ [key: string]: any; }** | Freeform options | [optional] [default to undefined]
+**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
 
 ## Example
 
@@ -27,8 +26,7 @@ const instance: RunTemplateParameterUpdateRequest = {
     defaultValue,
     minValue,
     maxValue,
-    regexValidation,
-    _options,
+    additionalData,
 };
 ```
 

package/docs/Runner.md

@@ -18,10 +18,10 @@ Name | Type | Description | Notes
 **runTemplateId** | **string** | the Solution Run Template Id associated with this Runner | [default to undefined]
 **organizationId** | **string** | the associated Organization Id | [readonly] [default to undefined]
 **workspaceId** | **string** | the associated Workspace Id | [readonly] [default to undefined]
-**ownerName** | **string** | the name of the owner | [readonly] [default to undefined]
 **solutionName** | **string** | the Solution name | [optional] [readonly] [default to undefined]
 **runTemplateName** | **string** | the Solution Run Template name associated with this Runner | [optional] [readonly] [default to undefined]
-**datasets** | [**RunnerDatasets**](RunnerDatasets.md) |  | [default to undefined]
+**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
+**datasets** | [**RunnerDatasets**](RunnerDatasets.md) | definition of datasets used by the runner | [default to undefined]
 **runSizing** | [**RunnerResourceSizing**](RunnerResourceSizing.md) |  | [optional] [default to undefined]
 **parametersValues** | [**Array<RunnerRunTemplateParameterValue>**](RunnerRunTemplateParameterValue.md) | the list of Solution Run Template parameters values | [default to undefined]
 **lastRunInfo** | [**LastRunInfo**](LastRunInfo.md) |  | [default to undefined]
@@ -46,9 +46,9 @@ const instance: Runner = {
     runTemplateId,
     organizationId,
     workspaceId,
-    ownerName,
     solutionName,
     runTemplateName,
+    additionalData,
     datasets,
     runSizing,
     parametersValues,

package/docs/RunnerCreateRequest.md

@@ -15,7 +15,7 @@ Name | Type | Description | Notes
 **datasetList** | **Array<string>** | the list of Dataset Id associated to this Runner Run Template | [optional] [default to undefined]
 **runSizing** | [**RunnerResourceSizing**](RunnerResourceSizing.md) |  | [optional] [default to undefined]
 **parametersValues** | [**Array<RunnerRunTemplateParameterValue>**](RunnerRunTemplateParameterValue.md) | the list of Solution Run Template parameters values | [optional] [default to undefined]
-**ownerName** | **string** | the name of the owner | [default to undefined]
+**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
 **solutionName** | **string** | the Solution name | [optional] [default to undefined]
 **runTemplateName** | **string** | the Solution Run Template name associated with this Runner | [optional] [default to undefined]
 **security** | [**RunnerSecurity**](RunnerSecurity.md) |  | [optional] [default to undefined]
@@ -35,7 +35,7 @@ const instance: RunnerCreateRequest = {
     datasetList,
     runSizing,
     parametersValues,
-    ownerName,
+    additionalData,
     solutionName,
     runTemplateName,
     security,

package/docs/RunnerUpdateRequest.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **datasetList** | **Array<string>** | the list of Dataset Id associated to this Runner Run Template | [optional] [default to undefined]
 **runSizing** | [**RunnerResourceSizing**](RunnerResourceSizing.md) |  | [optional] [default to undefined]
 **parametersValues** | [**Array<RunnerRunTemplateParameterValue>**](RunnerRunTemplateParameterValue.md) | the list of Solution Run Template parameters values | [optional] [default to undefined]
-**ownerName** | **string** | the name of the owner | [optional] [default to undefined]
+**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
 **solutionName** | **string** | the Solution name | [optional] [default to undefined]
 **runTemplateName** | **string** | the Solution Run Template name associated with this Runner | [optional] [default to undefined]
 
@@ -30,7 +30,7 @@ const instance: RunnerUpdateRequest = {
     datasetList,
     runSizing,
     parametersValues,
-    ownerName,
+    additionalData,
     solutionName,
     runTemplateName,
 };

package/docs/SendRunDataRequest.md

@@ -1,13 +1,12 @@
 # SendRunDataRequest
 
-Run Data to send
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** |  | [default to undefined]
-**data** | **Array<{ [key: string]: any; }>** |  | [default to undefined]
+**id** | **string** |  | [optional] [default to undefined]
+**data** | **Array<{ [key: string]: any; }>** |  | [optional] [default to undefined]
 
 ## Example