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

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)

package/docs/RunLogs.md

@@ -0,0 +1,23 @@
+# RunLogs
+
+the output logs of a run
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**runId** | **string** | the Run Id | [readonly] [default to undefined]
+**logs** | [**Array<RunLogsEntry>**](RunLogsEntry.md) | run log entries in chronological order | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { RunLogs } from '@cosmotech/api-ts';
+
+const instance: RunLogs = {
+    runId,
+    logs,
+};
+```
+
+[[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/RunLogsEntry.md

@@ -0,0 +1,21 @@
+# RunLogsEntry
+
+single run log entry
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**line** | **string** | log line data | [default to undefined]
+
+## Example
+
+```typescript
+import { RunLogsEntry } from '@cosmotech/api-ts';
+
+const instance: RunLogsEntry = {
+    line,
+};
+```
+
+[[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/RunTemplateOrchestrator.md

@@ -0,0 +1,11 @@
+# RunTemplateOrchestrator
+
+the Orchestrator to use for the Run Template
+
+## Enum
+
+* `ArgoWorkflow` (value: `'argoWorkflow'`)
+
+* `CsmOrc` (value: `'csmOrc'`)
+
+[[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/RunTemplateStepSource.md

@@ -0,0 +1,15 @@
+# RunTemplateStepSource
+
+the source local, cloud or git repository
+
+## Enum
+
+* `Cloud` (value: `'cloud'`)
+
+* `Git` (value: `'git'`)
+
+* `Local` (value: `'local'`)
+
+* `Platform` (value: `'platform'`)
+
+[[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/Runner.md

@@ -21,7 +21,7 @@ Name | Type | Description | Notes
 **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]
-**datasetList** | **Array<string>** | the list of Dataset Id associated to this Runner Run Template | [default to undefined]
+**datasets** | [**RunnerDatasets**](RunnerDatasets.md) |  | [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]
@@ -49,7 +49,7 @@ const instance: Runner = {
     ownerName,
     solutionName,
     runTemplateName,
-    datasetList,
+    datasets,
     runSizing,
     parametersValues,
     lastRunInfo,

package/docs/RunnerApi.md

@@ -563,8 +563,8 @@ const apiInstance = new RunnerApi(configuration);
 
 let organizationId: string; //the Organization identifier (default to undefined)
 let workspaceId: string; //the Workspace identifier (default to undefined)
-let page: number; //page number to query (first page is at index 0) (optional) (default to undefined)
-let size: number; //amount of result by page (optional) (default to undefined)
+let page: number; //Page number to query (first page is at index 0) (optional) (default to undefined)
+let size: number; //Amount of result by page (optional) (default to undefined)
 
 const { status, data } = await apiInstance.listRunners(
     organizationId,
@@ -580,8 +580,8 @@ const { status, data } = await apiInstance.listRunners(
 |------------- | ------------- | ------------- | -------------|
 | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
 | **workspaceId** | [**string**] | the Workspace identifier | defaults to undefined|
-| **page** | [**number**] | page number to query (first page is at index 0) | (optional) defaults to undefined|
-| **size** | [**number**] | amount of result by page | (optional) defaults to undefined|
+| **page** | [**number**] | Page number to query (first page is at index 0) | (optional) defaults to undefined|
+| **size** | [**number**] | Amount of result by page | (optional) defaults to undefined|
 
 
 ### Return type

package/docs/RunnerCreateRequest.md

@@ -9,15 +9,15 @@ Name | Type | Description | Notes
 **name** | **string** | the Runner name | [default to undefined]
 **description** | **string** | the Runner description | [optional] [default to undefined]
 **tags** | **Array<string>** | the list of tags | [optional] [default to undefined]
-**solutionId** | **string** | the Solution Id associated with this Runner | [readonly] [default to undefined]
+**solutionId** | **string** | the Solution Id associated with this Runner | [default to undefined]
 **parentId** | **string** | the Runner parent id | [optional] [default to undefined]
 **runTemplateId** | **string** | the Solution Run Template Id associated with this Runner | [default to undefined]
 **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 | [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]
+**ownerName** | **string** | the name of the owner | [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]
 
 ## Example

package/docs/RunnerDatasets.md

@@ -0,0 +1,24 @@
+# RunnerDatasets
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bases** | **Array<string>** | a list of Dataset Id used to build the Runner | [default to undefined]
+**parameter** | **string** | The dataset id used for dataset parameters on current Runner | [default to undefined]
+**parameters** | **Array<object>** | The dataset parts retrieved from the parameter property (programmatically fulfilled) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RunnerDatasets } from '@cosmotech/api-ts';
+
+const instance: RunnerDatasets = {
+    bases,
+    parameter,
+    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/RunnerRunTemplateParameterValue.md

@@ -7,7 +7,7 @@ the value of a Solution Run Template parameter for a Runner
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **parameterId** | **string** | the parameter Id | [default to undefined]
-**varType** | **string** | the parameter value type | [optional] [readonly] [default to undefined]
+**varType** | **string** | the parameter value type | [optional] [default to undefined]
 **value** | **string** | the parameter value | [default to undefined]
 **isInherited** | **boolean** | whether or not the value is inherited from parent or has been changed | [optional] [default to undefined]
 

package/docs/RunnerUpdateRequest.md

@@ -14,8 +14,8 @@ Name | Type | Description | Notes
 **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]
-**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]
+**solutionName** | **string** | the Solution name | [optional] [default to undefined]
+**runTemplateName** | **string** | the Solution Run Template name associated with this Runner | [optional] [default to undefined]
 
 ## Example