@cosmotech/api-ts 3.3.4 → 4.2.5-onprem

package/docs/SolutionCreateRequest.md

@@ -0,0 +1,43 @@
+# SolutionCreateRequest
+
+Request object for creating a new solution
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** | Technical key for resource name convention and version grouping. Must be unique | [default to undefined]
+**name** | **string** | Solution name. This name is displayed in the sample webApp | [default to undefined]
+**description** | **string** | The Solution description | [optional] [default to undefined]
+**repository** | **string** | The registry repository containing the image | [default to undefined]
+**version** | **string** | The Solution version MAJOR.MINOR.PATCH | [default to undefined]
+**alwaysPull** | **boolean** | Set to true if the runtemplate wants to always pull the image | [optional] [default to false]
+**tags** | **Array<string>** | The list of tags | [optional] [default to undefined]
+**parameters** | [**Array<RunTemplateParameterCreateRequest>**](RunTemplateParameterCreateRequest.md) | The list of Run Template Parameters | [optional] [default to undefined]
+**parameterGroups** | [**Array<RunTemplateParameterGroupCreateRequest>**](RunTemplateParameterGroupCreateRequest.md) | The list of parameters groups for the Run Templates | [optional] [default to undefined]
+**runTemplates** | [**Array<RunTemplateCreateRequest>**](RunTemplateCreateRequest.md) | List of Run Templates | [optional] [default to undefined]
+**url** | **string** | An optional URL link to solution page | [optional] [default to undefined]
+**security** | [**SolutionSecurity**](SolutionSecurity.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SolutionCreateRequest } from '@cosmotech/api-ts';
+
+const instance: SolutionCreateRequest = {
+    key,
+    name,
+    description,
+    repository,
+    version,
+    alwaysPull,
+    tags,
+    parameters,
+    parameterGroups,
+    runTemplates,
+    url,
+    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/SolutionEditInfo.md

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

@@ -0,0 +1,21 @@
+# SolutionFile
+
+A Solution File resource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fileName** | **string** | The Solution File name | [default to undefined]
+
+## Example
+
+```typescript
+import { SolutionFile } from '@cosmotech/api-ts';
+
+const instance: SolutionFile = {
+    fileName,
+};
+```
+
+[[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/SolutionMemberGroup.md

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

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

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

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

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

@@ -0,0 +1,41 @@
+# SolutionUpdateRequest
+
+Request object for updating a solution
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** | Technical key for resource name convention and version grouping. Must be unique | [optional] [default to undefined]
+**name** | **string** | The Solution name | [optional] [default to undefined]
+**description** | **string** | The Solution description | [optional] [default to undefined]
+**repository** | **string** | The registry repository containing the image | [optional] [default to undefined]
+**alwaysPull** | **boolean** | Set to true if the runtemplate wants to always pull the image | [optional] [default to undefined]
+**version** | **string** | The Solution version MAJOR.MINOR.PATCH. Must be aligned with an existing repository tag | [optional] [default to undefined]
+**url** | **string** | An optional URL link to solution page | [optional] [default to undefined]
+**tags** | **Array<string>** | The list of tags | [optional] [default to undefined]
+**parameters** | [**Array<RunTemplateParameterCreateRequest>**](RunTemplateParameterCreateRequest.md) | The list of Run Template Parameters | [optional] [default to undefined]
+**parameterGroups** | [**Array<RunTemplateParameterGroupCreateRequest>**](RunTemplateParameterGroupCreateRequest.md) | The list of parameters groups for the Run Templates | [optional] [default to undefined]
+**runTemplates** | [**Array<RunTemplateCreateRequest>**](RunTemplateCreateRequest.md) | List of Run Templates | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SolutionUpdateRequest } from '@cosmotech/api-ts';
+
+const instance: SolutionUpdateRequest = {
+    key,
+    name,
+    description,
+    repository,
+    alwaysPull,
+    version,
+    url,
+    tags,
+    parameters,
+    parameterGroups,
+    runTemplates,
+};
+```
+
+[[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/SourceInfo.md

@@ -0,0 +1,27 @@
+# SourceInfo
+
+Source job import information
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | the source name containing the files to import | [optional] [default to undefined]
+**location** | **string** | the source location containing the files to import | [default to undefined]
+**path** | **string** | the source location containing the files to import | [optional] [default to undefined]
+**jobId** | **string** | indicate the last import jobId | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SourceInfo } from '@cosmotech/api-ts';
+
+const instance: SourceInfo = {
+    name,
+    location,
+    path,
+    jobId,
+};
+```
+
+[[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/SubDatasetGraphQuery.md

@@ -0,0 +1,27 @@
+# SubDatasetGraphQuery
+
+a twin graph query in cypher language
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | the name of the subdataset | [optional] [default to undefined]
+**description** | **string** | the description of the subdataset | [optional] [default to undefined]
+**queries** | **Array<string>** | the query in cypher language | [optional] [default to undefined]
+**main** | **boolean** | is this the main dataset | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SubDatasetGraphQuery } from '@cosmotech/api-ts';
+
+const instance: SubDatasetGraphQuery = {
+    name,
+    description,
+    queries,
+    main,
+};
+```
+
+[[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/TwinGraphBatchResult.md

@@ -0,0 +1,25 @@
+# TwinGraphBatchResult
+
+Processing result
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**totalLines** | **number** |  | [default to undefined]
+**processedLines** | **number** |  | [default to undefined]
+**errors** | **Array<string>** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { TwinGraphBatchResult } from '@cosmotech/api-ts';
+
+const instance: TwinGraphBatchResult = {
+    totalLines,
+    processedLines,
+    errors,
+};
+```
+
+[[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/TwincacheStatusEnum.md

@@ -0,0 +1,11 @@
+# TwincacheStatusEnum
+
+the twincache data status
+
+## Enum
+
+* `Empty` (value: `'EMPTY'`)
+
+* `Full` (value: `'FULL'`)
+
+[[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/Workspace.md

@@ -0,0 +1,57 @@
+# Workspace
+
+a Workspace
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Workspace unique identifier generated by the API | [optional] [readonly] [default to undefined]
+**organizationId** | **string** | Organization unique identifier under which the workspace resides | [optional] [readonly] [default to undefined]
+**key** | **string** | technical key for resource name convention and version grouping. Must be unique | [default to undefined]
+**name** | **string** | Workspace name. This name is display in the sample webApp | [default to undefined]
+**description** | **string** | the Workspace description | [optional] [default to undefined]
+**linkedDatasetIdList** | **Array<string>** | list of dataset linked to this dataset | [optional] [default to undefined]
+**version** | **string** | the Workspace version MAJOR.MINOR.PATCH. | [optional] [default to undefined]
+**tags** | **Array<string>** | the list of tags | [optional] [default to undefined]
+**ownerId** | **string** | the user id which own this workspace. set by the API from Authentification service receved id | [optional] [readonly] [default to undefined]
+**solution** | [**WorkspaceSolution**](WorkspaceSolution.md) |  | [default to undefined]
+**webApp** | [**WorkspaceWebApp**](WorkspaceWebApp.md) |  | [optional] [default to undefined]
+**sendInputToDataWarehouse** | **boolean** | default setting for all Scenarios and Run Templates to set whether or not the Dataset values and the input parameters values are send to the DataWarehouse prior to the ScenarioRun | [optional] [default to undefined]
+**useDedicatedEventHubNamespace** | **boolean** | Set this property to true to use a dedicated Azure Event Hub Namespace for this Workspace. The Event Hub Namespace must be named \\\'<organization_id\\>-<workspace_id\\>\\\' (in lower case). This Namespace must also contain two Event Hubs named \\\'probesmeasures\\\' and \\\'scenariorun\\\'. | [optional] [default to false]
+**dedicatedEventHubSasKeyName** | **string** | the Dedicated Event Hub SAS key name, default to RootManageSharedAccessKey. Ask you DevOps Team to add the associated value to your Workspace Secret | [optional] [default to undefined]
+**dedicatedEventHubAuthenticationStrategy** | **string** | the Event Hub authentication strategy, SHARED_ACCESS_POLICY or TENANT_CLIENT_CREDENTIALS. Default to the one defined for the tenant. | [optional] [default to undefined]
+**sendScenarioRunToEventHub** | **boolean** | default setting for all Scenarios and Run Templates to set whether or not the ScenarioRun is send to the Event Hub | [optional] [default to true]
+**sendScenarioMetadataToEventHub** | **boolean** | Set this property to false to not send scenario metada to Azure Event Hub Namespace for this Workspace. The Event Hub Namespace must be named \\\'<organization_id\\>-<workspace_id\\>\\\' (in lower case). This Namespace must also contain two Event Hubs named \\\'scenariometadata\\\' and \\\'scenariorunmetadata\\\'. | [optional] [default to false]
+**datasetCopy** | **boolean** | Activate the copy of dataset on scenario creation, meaning that each scenario created in this workspace will make this copy. when false, scenario use directly the dataset specified. | [optional] [default to true]
+**security** | [**WorkspaceSecurity**](WorkspaceSecurity.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Workspace } from '@cosmotech/api-ts';
+
+const instance: Workspace = {
+    id,
+    organizationId,
+    key,
+    name,
+    description,
+    linkedDatasetIdList,
+    version,
+    tags,
+    ownerId,
+    solution,
+    webApp,
+    sendInputToDataWarehouse,
+    useDedicatedEventHubNamespace,
+    dedicatedEventHubSasKeyName,
+    dedicatedEventHubAuthenticationStrategy,
+    sendScenarioRunToEventHub,
+    sendScenarioMetadataToEventHub,
+    datasetCopy,
+    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/WorkspaceAccessControl.md

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