@cosmotech/api-ts 3.3.4 → 4.2.5-onprem

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

@@ -0,0 +1,31 @@
+# DatasetCreateRequest
+
+Dataset creation request
+
+## Properties
+
+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]
+
+## Example
+
+```typescript
+import { DatasetCreateRequest } from '@cosmotech/api-ts';
+
+const instance: DatasetCreateRequest = {
+    name,
+    description,
+    tags,
+    additionalData,
+    parts,
+    security,
+};
+```
+
+[[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/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/DatasetMemberGroup.md

@@ -0,0 +1,25 @@
+# DatasetMemberGroup
+
+A group member of the dataset
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | The group id | [default to undefined]
+**role** | **string** | The group role in the dataset | [default to undefined]
+**users** | **Array<string>** | The list of users in the group | [default to undefined]
+
+## Example
+
+```typescript
+import { DatasetMemberGroup } from '@cosmotech/api-ts';
+
+const instance: DatasetMemberGroup = {
+    id,
+    role,
+    users,
+};
+```
+
+[[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/DatasetMemberUser.md

@@ -0,0 +1,23 @@
+# DatasetMemberUser
+
+A user member of the dataset
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | The user id | [default to undefined]
+**role** | **string** | The user role in the dataset | [default to undefined]
+
+## Example
+
+```typescript
+import { DatasetMemberUser } from '@cosmotech/api-ts';
+
+const instance: DatasetMemberUser = {
+    id,
+    role,
+};
+```
+
+[[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/DatasetMembers.md

@@ -0,0 +1,23 @@
+# DatasetMembers
+
+The Dataset members, including users and groups
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**users** | [**Array<DatasetMemberUser>**](DatasetMemberUser.md) | The list of users in the dataset | [default to undefined]
+**groups** | [**Array<DatasetMemberGroup>**](DatasetMemberGroup.md) | The list of groups in the dataset | [default to undefined]
+
+## Example
+
+```typescript
+import { DatasetMembers } from '@cosmotech/api-ts';
+
+const instance: DatasetMembers = {
+    users,
+    groups,
+};
+```
+
+[[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

@@ -0,0 +1,43 @@
+# DatasetPart
+
+Dataset part object
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**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** | [**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
+
+```typescript
+import { DatasetPart } from '@cosmotech/api-ts';
+
+const instance: DatasetPart = {
+    id,
+    name,
+    sourceName,
+    description,
+    tags,
+    additionalData,
+    type,
+    organizationId,
+    workspaceId,
+    datasetId,
+    createInfo,
+    updateInfo,
+};
+```
+
+[[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/DatasetPartCreateRequest.md

@@ -0,0 +1,31 @@
+# DatasetPartCreateRequest
+
+Dataset part create request object
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**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
+
+```typescript
+import { DatasetPartCreateRequest } from '@cosmotech/api-ts';
+
+const instance: DatasetPartCreateRequest = {
+    name,
+    sourceName,
+    description,
+    tags,
+    additionalData,
+    type,
+};
+```
+
+[[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

@@ -0,0 +1,11 @@
+# DatasetPartTypeEnum
+
+The dataset part Type
+
+## Enum
+
+* `File` (value: `'File'`)
+
+* `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/DatasetPartUpdateRequest.md

@@ -0,0 +1,27 @@
+# DatasetPartUpdateRequest
+
+Dataset part update request object
+
+## Properties
+
+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
+
+```typescript
+import { DatasetPartUpdateRequest } from '@cosmotech/api-ts';
+
+const instance: DatasetPartUpdateRequest = {
+    sourceName,
+    description,
+    tags,
+    additionalData,
+};
+```
+
+[[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/DatasetRole.md

@@ -0,0 +1,21 @@
+# DatasetRole
+
+the Dataset Role
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**role** | **string** | the Dataset Role | [default to undefined]
+
+## Example
+
+```typescript
+import { DatasetRole } from '@cosmotech/api-ts';
+
+const instance: DatasetRole = {
+    role,
+};
+```
+
+[[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/DatasetSecurity.md

@@ -0,0 +1,23 @@
+# DatasetSecurity
+
+the dataset security information
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_default** | **string** | the role by default | [default to undefined]
+**accessControlList** | [**Array<DatasetAccessControl>**](DatasetAccessControl.md) | the list which can access this Dataset with detailed access control information | [default to undefined]
+
+## Example
+
+```typescript
+import { DatasetSecurity } from '@cosmotech/api-ts';
+
+const instance: DatasetSecurity = {
+    _default,
+    accessControlList,
+};
+```
+
+[[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/DatasetUpdateRequest.md

@@ -0,0 +1,29 @@
+# DatasetUpdateRequest
+
+Dataset creation request
+
+## Properties
+
+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]
+
+## Example
+
+```typescript
+import { DatasetUpdateRequest } from '@cosmotech/api-ts';
+
+const instance: DatasetUpdateRequest = {
+    name,
+    description,
+    tags,
+    additionalData,
+    parts,
+};
+```
+
+[[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/EditInfo.md

@@ -0,0 +1,22 @@
+# EditInfo
+
+
+## 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 { EditInfo } from '@cosmotech/api-ts';
+
+const instance: EditInfo = {
+    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/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)