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

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|
@@ -823,7 +823,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 +841,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 +878,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 \&#39;*\&#39; 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 \&#39;*\&#39; 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 \&#39;*\&#39; 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 \&#39;*\&#39; 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 \&#39;*\&#39; 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 \&#39;*\&#39; 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 +901,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

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/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
 

package/git_push.sh

@@ -14,12 +14,12 @@ if [ "$git_host" = "" ]; then
 fi
 
 if [ "$git_user_id" = "" ]; then
-    git_user_id="GIT_USER_ID"
+    git_user_id="Cosmo-Tech"
     echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
 fi
 
 if [ "$git_repo_id" = "" ]; then
-    git_repo_id="GIT_REPO_ID"
+    git_repo_id="cosmotech-api-typescript-client"
     echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
 fi
 

package/index.ts

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

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@cosmotech/api-ts",
-  "version": "5.0.0-beta5",
+  "version": "5.0.0-beta6",
   "description": "OpenAPI client for @cosmotech/api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {
     "type": "git",
-    "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
+    "url": "https://github.com/Cosmo-Tech/cosmotech-api-typescript-client.git"
   },
   "keywords": [
     "axios",