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

package/docs/DatasetApi.md

@@ -17,13 +17,14 @@ 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|
 |[**updateDataset**](#updatedataset) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Update a Dataset|
 |[**updateDatasetAccessControl**](#updatedatasetaccesscontrol) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access/{identity_id} | Update the specified access to User for a Dataset|
 |[**updateDatasetDefaultSecurity**](#updatedatasetdefaultsecurity) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/default | Set the Dataset default security|
+|[**updateDatasetPart**](#updatedatasetpart) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id} | Update existing dataset parts information of a Dataset|
 
 # **createDataset**
 > Dataset createDataset()
@@ -83,8 +84,8 @@ const { status, data } = await apiInstance.createDataset(
 |-------------|-------------|------------------|
 |**201** | Dataset successfully created |  -  |
 |**400** | Bad request |  -  |
-|**403** | Insufficient permissions on organization or workspace or dataset |  -  |
-|**404** | Organization or workspace specified is not found |  -  |
+|**403** | Insufficient permissions on organization, workspace or dataset |  -  |
+|**404** | Organization, workspace 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)
 
@@ -210,7 +211,7 @@ const { status, data } = await apiInstance.createDatasetPart(
 |-------------|-------------|------------------|
 |**201** | Dataset part successfully created |  -  |
 |**400** | Bad request - Dataset part cannot be created |  -  |
-|**403** | Insufficient permissions on organization or workspace or dataset |  -  |
+|**403** | Insufficient permissions on organization, workspace or dataset |  -  |
 |**404** | 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)
@@ -269,7 +270,7 @@ void (empty response body)
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**204** | Dataset successfully deleted |  -  |
-|**403** | Insufficient permissions on organization or workspace or dataset |  -  |
+|**403** | Insufficient permissions on organization, workspace or dataset |  -  |
 |**404** | Organization or 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)
@@ -391,7 +392,7 @@ void (empty response body)
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**204** | Dataset part successfully deleted |  -  |
-|**403** | Insufficient permissions on organization or workspace or dataset |  -  |
+|**403** | Insufficient permissions on organization, workspace or dataset |  -  |
 |**404** | Dataset part 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)
@@ -452,7 +453,7 @@ const { status, data } = await apiInstance.downloadDatasetPart(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | Dataset part successfully downloaded |  -  |
-|**403** | Insufficient permissions on organization or workspace or dataset |  -  |
+|**403** | Insufficient permissions on organization, workspace or dataset |  -  |
 |**404** | Dataset part 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)
@@ -511,8 +512,8 @@ const { status, data } = await apiInstance.getDataset(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | Dataset successfully retrieved |  -  |
-|**403** | Insufficient permissions on organization or workspace or dataset |  -  |
-|**404** | Organization or workspace or dataset specified is not found |  -  |
+|**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)
 
@@ -632,7 +633,7 @@ const { status, data } = await apiInstance.getDatasetPart(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | Dataset part successfully retrieved |  -  |
-|**403** | Insufficient permissions on organization or workspace or dataset |  -  |
+|**403** | Insufficient permissions on organization, workspace or dataset |  -  |
 |**404** | Dataset part 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)
@@ -696,7 +697,7 @@ const { status, data } = await apiInstance.listDatasetParts(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | List of dataset parts |  -  |
-|**403** | Insufficient permissions on organization or workspace or dataset |  -  |
+|**403** | Insufficient permissions on organization, workspace or dataset |  -  |
 |**404** | Dataset specified is not found |  -  |
 |**422** | Targeted dataset do not support requests |  -  |
 
@@ -816,13 +817,13 @@ const { status, data } = await apiInstance.listDatasets(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | Datasets successfully retrieved |  -  |
-|**403** | Insufficient permissions on organization or workspace or dataset |  -  |
-|**404** | Organization or workspace or dataset specified is not found |  -  |
+|**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)
 
 # **queryData**
-> Array<object> queryData()
+> File queryData()
 
 
 ### Example
@@ -840,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
 );
 ```
 
@@ -867,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
 
@@ -885,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
@@ -893,7 +909,7 @@ const { status, data } = await apiInstance.queryData(
 |-------------|-------------|------------------|
 |**200** | Data related to provided information |  -  |
 |**400** | Bad request - Data cannot be retrieved from provided information |  -  |
-|**403** | Insufficient permissions on organization or workspace or dataset |  -  |
+|**403** | Insufficient permissions on organization, workspace or dataset |  -  |
 |**404** | Dataset specified is not found or you don\&#39;t have access to it |  -  |
 |**422** | Targeted dataset do not support requests |  -  |
 
@@ -962,7 +978,7 @@ const { status, data } = await apiInstance.replaceDatasetPart(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | Dataset part successfully replaced |  -  |
-|**403** | Insufficient permissions on organization or workspace or dataset |  -  |
+|**403** | Insufficient permissions on organization, workspace or dataset |  -  |
 |**404** | Dataset part specified is not found |  -  |
 |**422** | Targeted dataset do not support requests |  -  |
 
@@ -1157,8 +1173,8 @@ const { status, data } = await apiInstance.updateDataset(
 |-------------|-------------|------------------|
 |**200** | Dataset successfully updated |  -  |
 |**400** | Bad request |  -  |
-|**403** | Insufficient permissions on organization or workspace or dataset |  -  |
-|**404** | Organization or workspace or dataset specified is not found |  -  |
+|**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)
 
@@ -1287,3 +1303,69 @@ const { status, data } = await apiInstance.updateDatasetDefaultSecurity(
 
 [[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)
 
+# **updateDatasetPart**
+> DatasetPart updateDatasetPart(datasetPartUpdateRequest)
+
+
+### Example
+
+```typescript
+import {
+    DatasetApi,
+    Configuration,
+    DatasetPartUpdateRequest
+} from '@cosmotech/api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new DatasetApi(configuration);
+
+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 datasetPartUpdateRequest: DatasetPartUpdateRequest; //Dataset part information to update
+
+const { status, data } = await apiInstance.updateDatasetPart(
+    organizationId,
+    workspaceId,
+    datasetId,
+    datasetPartId,
+    datasetPartUpdateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **datasetPartUpdateRequest** | **DatasetPartUpdateRequest**| Dataset part information to update | |
+| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
+| **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|
+
+
+### Return type
+
+**DatasetPart**
+
+### 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** | Dataset part information successfully updated |  -  |
+|**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/DatasetCompatibility.md

@@ -0,0 +1,25 @@
+# DatasetCompatibility
+
+a Dataset compatibility constraint to a Solution version open range
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**solutionKey** | **string** | the Solution key which group Solution versions | [default to undefined]
+**minimumVersion** | **string** | the Solution minimum version compatibility (version included) | [optional] [default to undefined]
+**maximumVersion** | **string** | the Solution maximum version compatibility (version included) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DatasetCompatibility } from '@cosmotech/api-ts';
+
+const instance: DatasetCompatibility = {
+    solutionKey,
+    minimumVersion,
+    maximumVersion,
+};
+```
+
+[[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/DatasetConnector.md

@@ -0,0 +1,27 @@
+# DatasetConnector
+
+the Connector setup bound to a Dataset
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | the Connector id | [optional] [default to undefined]
+**name** | **string** | the Connector name | [optional] [default to undefined]
+**version** | **string** | the Connector version | [optional] [default to undefined]
+**parametersValues** | **{ [key: string]: string; }** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DatasetConnector } from '@cosmotech/api-ts';
+
+const instance: DatasetConnector = {
+    id,
+    name,
+    version,
+    parametersValues,
+};
+```
+
+[[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/DatasetCopyParameters.md

@@ -0,0 +1,25 @@
+# DatasetCopyParameters
+
+the Dataset Copy Parameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sourceId** | **string** | the source Dataset id | [optional] [default to undefined]
+**targetId** | **string** | the target Dataset id | [optional] [default to undefined]
+**_options** | **{ [key: string]: any; }** | freeform options to path to connectors | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DatasetCopyParameters } from '@cosmotech/api-ts';
+
+const instance: DatasetCopyParameters = {
+    sourceId,
+    targetId,
+    _options,
+};
+```
+
+[[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/DatasetPartTypeEnum.md

@@ -6,6 +6,6 @@ The dataset part Type
 
 * `File` (value: `'File'`)
 
-* `Relational` (value: `'Relational'`)
+* `Db` (value: `'DB'`)
 
 [[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/DatasetSearch.md

@@ -0,0 +1,21 @@
+# DatasetSearch
+
+the search options
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**datasetTags** | **Array<string>** | the dataset tag list to search | [default to undefined]
+
+## Example
+
+```typescript
+import { DatasetSearch } from '@cosmotech/api-ts';
+
+const instance: DatasetSearch = {
+    datasetTags,
+};
+```
+
+[[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/DatasetSourceType.md

@@ -0,0 +1,19 @@
+# DatasetSourceType
+
+the Dataset Source Type
+
+## Enum
+
+* `Adt` (value: `'ADT'`)
+
+* `AzureStorage` (value: `'AzureStorage'`)
+
+* `File` (value: `'File'`)
+
+* `None` (value: `'None'`)
+
+* `Twincache` (value: `'Twincache'`)
+
+* `Etl` (value: `'ETL'`)
+
+[[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/DatasetTwinGraphHash.md

@@ -0,0 +1,21 @@
+# DatasetTwinGraphHash
+
+a twin graph hash
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**hash** | **string** | the hash of the graph | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DatasetTwinGraphHash } from '@cosmotech/api-ts';
+
+const instance: DatasetTwinGraphHash = {
+    hash,
+};
+```
+
+[[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/DatasetTwinGraphInfo.md

@@ -0,0 +1,25 @@
+# DatasetTwinGraphInfo
+
+a twin graph query in cypher language
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**jobId** | **string** | the import job id | [optional] [default to undefined]
+**datasetId** | **string** | the Dataset id | [optional] [default to undefined]
+**status** | **string** | Twingraph status | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DatasetTwinGraphInfo } from '@cosmotech/api-ts';
+
+const instance: DatasetTwinGraphInfo = {
+    jobId,
+    datasetId,
+    status,
+};
+```
+
+[[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/DatasetTwinGraphQuery.md

@@ -0,0 +1,21 @@
+# DatasetTwinGraphQuery
+
+a twin graph query in cypher language
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**query** | **string** | the query in cypher language | [default to undefined]
+
+## Example
+
+```typescript
+import { DatasetTwinGraphQuery } from '@cosmotech/api-ts';
+
+const instance: DatasetTwinGraphQuery = {
+    query,
+};
+```
+
+[[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/DeleteHistoricalData.md

@@ -0,0 +1,25 @@
+# DeleteHistoricalData
+
+Configuration of scenario runs deletion automatic mecanism
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enable** | **boolean** | Activate or Deactivate historical data deletion | [default to true]
+**pollFrequency** | **number** | define the polling frequency of scenario run status (in millis) | [optional] [default to 10000]
+**timeOut** | **number** | define the polling timeout | [optional] [default to 28800]
+
+## Example
+
+```typescript
+import { DeleteHistoricalData } from '@cosmotech/api-ts';
+
+const instance: DeleteHistoricalData = {
+    enable,
+    pollFrequency,
+    timeOut,
+};
+```
+
+[[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/FileUploadMetadata.md

@@ -0,0 +1,22 @@
+# FileUploadMetadata
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**size** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FileUploadMetadata } from '@cosmotech/api-ts';
+
+const instance: FileUploadMetadata = {
+    name,
+    size,
+};
+```
+
+[[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/FileUploadValidation.md

@@ -0,0 +1,23 @@
+# FileUploadValidation
+
+files read on upload
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nodes** | [**Array<FileUploadMetadata>**](FileUploadMetadata.md) | list of filename found on nodes folder | [optional] [default to undefined]
+**edges** | [**Array<FileUploadMetadata>**](FileUploadMetadata.md) | list of filename found on edges folder | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FileUploadValidation } from '@cosmotech/api-ts';
+
+const instance: FileUploadValidation = {
+    nodes,
+    edges,
+};
+```
+
+[[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/GraphProperties.md

@@ -0,0 +1,28 @@
+# GraphProperties
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** | the type of the relationship | [optional] [default to undefined]
+**source** | **string** | the source node of the relationship | [optional] [default to undefined]
+**target** | **string** | the target node of the relationship | [optional] [default to undefined]
+**name** | **string** | the name of the graph data object | [optional] [default to undefined]
+**params** | **string** | the parameters of the graph data object | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GraphProperties } from '@cosmotech/api-ts';
+
+const instance: GraphProperties = {
+    type,
+    source,
+    target,
+    name,
+    params,
+};
+```
+
+[[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/IngestionStatusEnum.md

@@ -0,0 +1,15 @@
+# IngestionStatusEnum
+
+the Dataset ingestion status
+
+## Enum
+
+* `None` (value: `'NONE'`)
+
+* `Pending` (value: `'PENDING'`)
+
+* `Error` (value: `'ERROR'`)
+
+* `Success` (value: `'SUCCESS'`)
+
+[[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/IoTypesEnum.md

@@ -0,0 +1,11 @@
+# IoTypesEnum
+
+The read and write capabilities of connector
+
+## Enum
+
+* `Read` (value: `'read'`)
+
+* `Write` (value: `'write'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)