@cosmotech/api-ts 3.3.4 → 4.2.5-onprem

package/docs/OrganizationCreateRequest.md

@@ -0,0 +1,23 @@
+# OrganizationCreateRequest
+
+Request object for creating a new organization
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | The Organization name | [default to undefined]
+**security** | [**OrganizationSecurity**](OrganizationSecurity.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrganizationCreateRequest } from '@cosmotech/api-ts';
+
+const instance: OrganizationCreateRequest = {
+    name,
+    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/OrganizationEditInfo.md

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

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

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

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

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

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

@@ -0,0 +1,21 @@
+# OrganizationUpdateRequest
+
+Request object for updating an organization
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | The Organization name | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrganizationUpdateRequest } from '@cosmotech/api-ts';
+
+const instance: OrganizationUpdateRequest = {
+    name,
+};
+```
+
+[[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/QueryResult.md

@@ -0,0 +1,21 @@
+# QueryResult
+
+the result of a SQL Query
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**result** | **Array<{ [key: string]: any; }>** | the list of results | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { QueryResult } from '@cosmotech/api-ts';
+
+const instance: QueryResult = {
+    result,
+};
+```
+
+[[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/ResourceSizeInfo.md

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

@@ -0,0 +1,57 @@
+# Run
+
+a Run with only base properties
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | the Run | [optional] [readonly] [default to undefined]
+**state** | [**RunState**](RunState.md) |  | [optional] [default to undefined]
+**organizationId** | **string** | the Organization id | [optional] [default to undefined]
+**workflowId** | **string** | the Cosmo Tech compute cluster Argo Workflow Id to search | [optional] [default to undefined]
+**csmSimulationRun** | **string** | the Cosmo Tech Simulation Run Id | [optional] [readonly] [default to undefined]
+**generateName** | **string** | the base name for workflow name generation | [optional] [default to undefined]
+**workflowName** | **string** | the Cosmo Tech compute cluster Argo Workflow Name | [optional] [default to undefined]
+**ownerId** | **string** | the user id which own this run | [optional] [readonly] [default to undefined]
+**workspaceId** | **string** | the Workspace Id | [optional] [readonly] [default to undefined]
+**workspaceKey** | **string** | technical key for resource name convention and version grouping. Must be unique | [optional] [readonly] [default to undefined]
+**runnerId** | **string** | the Runner Id | [optional] [readonly] [default to undefined]
+**solutionId** | **string** | the Solution Id | [optional] [readonly] [default to undefined]
+**runTemplateId** | **string** | the Solution Run Template id | [optional] [readonly] [default to undefined]
+**computeSize** | **string** | the compute size needed for this Analysis. Standard sizes are basic and highcpu. Default is basic | [optional] [readonly] [default to undefined]
+**createdAt** | **string** | the Run creation date | [optional] [readonly] [default to undefined]
+**datasetList** | **Array<string>** | the list of Dataset Id associated to this Run | [optional] [readonly] [default to undefined]
+**parametersValues** | [**Array<RunTemplateParameterValue>**](RunTemplateParameterValue.md) | the list of Run Template parameters values | [optional] [readonly] [default to undefined]
+**nodeLabel** | **string** | the node label request | [optional] [readonly] [default to undefined]
+**containers** | [**Array<RunContainer>**](RunContainer.md) | the containers list. This information is not returned by the API. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Run } from '@cosmotech/api-ts';
+
+const instance: Run = {
+    id,
+    state,
+    organizationId,
+    workflowId,
+    csmSimulationRun,
+    generateName,
+    workflowName,
+    ownerId,
+    workspaceId,
+    workspaceKey,
+    runnerId,
+    solutionId,
+    runTemplateId,
+    computeSize,
+    createdAt,
+    datasetList,
+    parametersValues,
+    nodeLabel,
+    containers,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)