@cosmotech/api-ts 3.3.4 → 4.2.5-onprem

package/docs/ConnectorParameterGroup.md

@@ -0,0 +1,25 @@
+# ConnectorParameterGroup
+
+a connector parameters group
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | the connector parameter group id | [default to undefined]
+**label** | **string** | the list of translated parameter group labels | [default to undefined]
+**parameters** | [**Array<ConnectorParameter>**](ConnectorParameter.md) | the list of parameters | [default to undefined]
+
+## Example
+
+```typescript
+import { ConnectorParameterGroup } from '@cosmotech/api-ts';
+
+const instance: ConnectorParameterGroup = {
+    id,
+    label,
+    parameters,
+};
+```
+
+[[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/ContainerResourceSizeInfo.md

@@ -0,0 +1,23 @@
+# ContainerResourceSizeInfo
+
+define cpus and memory needs
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cpu** | **string** | define cpu needs | [default to undefined]
+**memory** | **string** | define memory needs | [default to undefined]
+
+## Example
+
+```typescript
+import { ContainerResourceSizeInfo } from '@cosmotech/api-ts';
+
+const instance: ContainerResourceSizeInfo = {
+    cpu,
+    memory,
+};
+```
+
+[[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/ContainerResourceSizing.md

@@ -0,0 +1,23 @@
+# ContainerResourceSizing
+
+a description object for resource requests and limits (default same configuration as basic sizing)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**requests** | [**ContainerResourceSizeInfo**](ContainerResourceSizeInfo.md) |  | [default to undefined]
+**limits** | [**ContainerResourceSizeInfo**](ContainerResourceSizeInfo.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ContainerResourceSizing } from '@cosmotech/api-ts';
+
+const instance: ContainerResourceSizing = {
+    requests,
+    limits,
+};
+```
+
+[[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/CreateInfo.md

@@ -0,0 +1,24 @@
+# CreateInfo
+
+
+## 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 { CreateInfo } from '@cosmotech/api-ts';
+
+const instance: CreateInfo = {
+    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/CreatedRun.md

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

@@ -0,0 +1,65 @@
+# Dataset
+
+a Dataset
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | the Dataset unique identifier | [optional] [readonly] [default to undefined]
+**name** | **string** | the Dataset name | [optional] [default to undefined]
+**description** | **string** | the Dataset description | [optional] [default to undefined]
+**ownerId** | **string** | the User id which own this Dataset | [optional] [readonly] [default to undefined]
+**ownerName** | **string** | the name of the owner | [optional] [readonly] [default to undefined]
+**organizationId** | **string** | the Organization Id related to this Dataset | [optional] [readonly] [default to undefined]
+**parentId** | **string** | the Dataset id which is the parent of this Dataset | [optional] [default to undefined]
+**linkedWorkspaceIdList** | **Array<string>** | list of workspace linked to this dataset | [optional] [default to undefined]
+**twingraphId** | **string** | the twin graph id | [optional] [default to undefined]
+**main** | **boolean** | is this the main dataset | [optional] [default to undefined]
+**creationDate** | **number** | the Dataset creation date | [optional] [readonly] [default to undefined]
+**refreshDate** | **number** | the last time a refresh was done | [optional] [readonly] [default to undefined]
+**sourceType** | [**DatasetSourceType**](DatasetSourceType.md) |  | [optional] [default to undefined]
+**source** | [**SourceInfo**](SourceInfo.md) |  | [optional] [default to undefined]
+**ingestionStatus** | [**IngestionStatusEnum**](IngestionStatusEnum.md) |  | [optional] [default to undefined]
+**twincacheStatus** | [**TwincacheStatusEnum**](TwincacheStatusEnum.md) |  | [optional] [default to undefined]
+**queries** | **Array<string>** | the list of queries | [optional] [default to undefined]
+**tags** | **Array<string>** | the list of tags | [optional] [default to undefined]
+**connector** | [**DatasetConnector**](DatasetConnector.md) |  | [optional] [default to undefined]
+**fragmentsIds** | **Array<string>** | the list of other Datasets ids to compose as fragments | [optional] [default to undefined]
+**validatorId** | **string** | the validator id | [optional] [default to undefined]
+**compatibility** | [**Array<DatasetCompatibility>**](DatasetCompatibility.md) | the list of compatible Solutions versions | [optional] [default to undefined]
+**security** | [**DatasetSecurity**](DatasetSecurity.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Dataset } from '@cosmotech/api-ts';
+
+const instance: Dataset = {
+    id,
+    name,
+    description,
+    ownerId,
+    ownerName,
+    organizationId,
+    parentId,
+    linkedWorkspaceIdList,
+    twingraphId,
+    main,
+    creationDate,
+    refreshDate,
+    sourceType,
+    source,
+    ingestionStatus,
+    twincacheStatus,
+    queries,
+    tags,
+    connector,
+    fragmentsIds,
+    validatorId,
+    compatibility,
+    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/DatasetAccessControl.md

@@ -0,0 +1,23 @@
+# DatasetAccessControl
+
+a Dataset access control item
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | the identity id | [default to undefined]
+**role** | **string** | a role | [default to undefined]
+
+## Example
+
+```typescript
+import { DatasetAccessControl } from '@cosmotech/api-ts';
+
+const instance: DatasetAccessControl = {
+    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)