@cosmotech/api-ts 3.3.4 → 4.2.5-onprem

package/docs/WorkspaceCreateRequest.md

@@ -0,0 +1,35 @@
+# WorkspaceCreateRequest
+
+Request object for creating a new workspace
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** | Technical key for resource name convention and version grouping. Must be unique | [default to undefined]
+**name** | **string** | Workspace name. This name is displayed 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]
+**solution** | [**WorkspaceSolution**](WorkspaceSolution.md) |  | [default to undefined]
+**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
+**security** | [**WorkspaceSecurity**](WorkspaceSecurity.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WorkspaceCreateRequest } from '@cosmotech/api-ts';
+
+const instance: WorkspaceCreateRequest = {
+    key,
+    name,
+    description,
+    version,
+    tags,
+    solution,
+    additionalData,
+    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/WorkspaceEditInfo.md

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

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

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

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

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

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

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

@@ -0,0 +1,25 @@
+# WorkspaceSolution
+
+the Workspace Solution configuration
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**solutionId** | **string** | the Solution Id attached to this workspace | [optional] [default to undefined]
+**runTemplateFilter** | **Array<string>** | the list of Solution Run Template Id to filter | [optional] [default to undefined]
+**defaultRunTemplateDataset** | **{ [key: string]: any; }** | a map of RunTemplateId/DatasetId to set a default dataset for a Run Template | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WorkspaceSolution } from '@cosmotech/api-ts';
+
+const instance: WorkspaceSolution = {
+    solutionId,
+    runTemplateFilter,
+    defaultRunTemplateDataset,
+};
+```
+
+[[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/WorkspaceUpdateRequest.md

@@ -0,0 +1,31 @@
+# WorkspaceUpdateRequest
+
+Request object for updating a workspace
+
+## 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** | Workspace name | [optional] [default to undefined]
+**description** | **string** | The Workspace description | [optional] [default to undefined]
+**tags** | **Array<string>** | The list of tags | [optional] [default to undefined]
+**solution** | [**WorkspaceSolution**](WorkspaceSolution.md) |  | [optional] [default to undefined]
+**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WorkspaceUpdateRequest } from '@cosmotech/api-ts';
+
+const instance: WorkspaceUpdateRequest = {
+    key,
+    name,
+    description,
+    tags,
+    solution,
+    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/WorkspaceWebApp.md

@@ -0,0 +1,25 @@
+# WorkspaceWebApp
+
+a Workspace Web Application
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **string** | the Workspace Web Application URL | [default to undefined]
+**iframes** | **{ [key: string]: any; }** | a map of iframeKey/iframeURL | [optional] [default to undefined]
+**_options** | **{ [key: string]: any; }** | free form options for Web Application | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WorkspaceWebApp } from '@cosmotech/api-ts';
+
+const instance: WorkspaceWebApp = {
+    url,
+    iframes,
+    _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/index.ts

@@ -4,7 +4,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 3.3.4
+ * The version of the OpenAPI document: 4.2.5-onprem
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@cosmotech/api-ts",
-  "version": "3.3.4",
+  "version": "4.2.5-onprem",
   "description": "OpenAPI client for @cosmotech/api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {
     "type": "git",
-    "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
+    "url": "https://github.com/Cosmo-Tech/cosmotech-api-typescript-client"
   },
   "keywords": [
     "axios",