@cosmotech/api-ts 4.0.0-dev9 → 5.0.0-beta4

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/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/Workspace.md

@@ -0,0 +1,45 @@
+# Workspace
+
+A Workspace
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Workspace unique identifier generated by the API | [readonly] [default to undefined]
+**organizationId** | **string** | Organization unique identifier under which the workspace resides | [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]
+**version** | **string** | The Workspace version MAJOR.MINOR.PATCH. | [optional] [default to undefined]
+**tags** | **Array<string>** | The list of tags | [optional] [default to undefined]
+**createInfo** | [**WorkspaceEditInfo**](WorkspaceEditInfo.md) | The details of the Workspace creation | [default to undefined]
+**updateInfo** | [**WorkspaceEditInfo**](WorkspaceEditInfo.md) | The details of the Workspace last update | [default to undefined]
+**solution** | [**WorkspaceSolution**](WorkspaceSolution.md) |  | [default to undefined]
+**webApp** | [**WorkspaceWebApp**](WorkspaceWebApp.md) |  | [optional] [default to undefined]
+**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) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Workspace } from '@cosmotech/api-ts';
+
+const instance: Workspace = {
+    id,
+    organizationId,
+    key,
+    name,
+    description,
+    version,
+    tags,
+    createInfo,
+    updateInfo,
+    solution,
+    webApp,
+    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)