@cosmotech/api-ts 3.3.4 → 4.2.5-onprem

package/docs/RunnerCreateRequest.md

@@ -0,0 +1,45 @@
+# RunnerCreateRequest
+
+Request object for creating a new runner
+
+## Properties
+
+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 | [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) | definition of resources needed for the runner run | [optional] [default to undefined]
+**parametersValues** | [**Array<RunnerRunTemplateParameterValue>**](RunnerRunTemplateParameterValue.md) | the list of Solution Run Template parameters values | [optional] [default to undefined]
+**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [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
+
+```typescript
+import { RunnerCreateRequest } from '@cosmotech/api-ts';
+
+const instance: RunnerCreateRequest = {
+    name,
+    description,
+    tags,
+    solutionId,
+    parentId,
+    runTemplateId,
+    datasetList,
+    runSizing,
+    parametersValues,
+    additionalData,
+    solutionName,
+    runTemplateName,
+    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/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/RunnerEditInfo.md

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

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

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

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

@@ -0,0 +1,23 @@
+# RunnerResourceSizing
+
+a description object for resource requests and limits (default same configuration as basic sizing)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**requests** | [**ResourceSizeInfo**](ResourceSizeInfo.md) |  | [default to undefined]
+**limits** | [**ResourceSizeInfo**](ResourceSizeInfo.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { RunnerResourceSizing } from '@cosmotech/api-ts';
+
+const instance: RunnerResourceSizing = {
+    requests,
+    limits,
+};
+```
+
+[[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/RunnerRole.md

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

@@ -0,0 +1,27 @@
+# RunnerRunTemplateParameterValue
+
+the value of a Solution Run Template parameter for a Runner
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parameterId** | **string** | the parameter Id | [default to undefined]
+**varType** | **string** | the parameter value type | [optional] [readonly] [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]
+
+## Example
+
+```typescript
+import { RunnerRunTemplateParameterValue } from '@cosmotech/api-ts';
+
+const instance: RunnerRunTemplateParameterValue = {
+    parameterId,
+    varType,
+    value,
+    isInherited,
+};
+```
+
+[[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/RunnerSecurity.md

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

@@ -0,0 +1,11 @@
+# RunnerStatus
+
+the status of the runner
+
+## Enum
+
+* `Ok` (value: `'Ok'`)
+
+* `Archived` (value: `'Archived'`)
+
+[[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/RunnerUpdateRequest.md

@@ -0,0 +1,41 @@
+# RunnerUpdateRequest
+
+Request object for updating a runner
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | the Runner name | [optional] [default to undefined]
+**description** | **string** | the Runner description | [optional] [default to undefined]
+**tags** | **Array<string>** | the list of tags | [optional] [default to undefined]
+**runTemplateId** | **string** | the Solution Run Template Id associated with this Runner | [optional] [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) | definition of resources needed for the runner run | [optional] [default to undefined]
+**parametersValues** | [**Array<RunnerRunTemplateParameterValue>**](RunnerRunTemplateParameterValue.md) | the list of Solution Run Template parameters values | [optional] [default to undefined]
+**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [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]
+**validationStatus** | [**RunnerValidationStatus**](RunnerValidationStatus.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RunnerUpdateRequest } from '@cosmotech/api-ts';
+
+const instance: RunnerUpdateRequest = {
+    name,
+    description,
+    tags,
+    runTemplateId,
+    datasetList,
+    runSizing,
+    parametersValues,
+    additionalData,
+    solutionName,
+    runTemplateName,
+    validationStatus,
+};
+```
+
+[[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/RunnerValidationStatus.md

@@ -0,0 +1,15 @@
+# RunnerValidationStatus
+
+the validation status of the runner
+
+## Enum
+
+* `Draft` (value: `'Draft'`)
+
+* `Rejected` (value: `'Rejected'`)
+
+* `Unknown` (value: `'Unknown'`)
+
+* `Validated` (value: `'Validated'`)
+
+[[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/SendRunDataRequest.md

@@ -0,0 +1,22 @@
+# SendRunDataRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**data** | **Array<{ [key: string]: any; }>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SendRunDataRequest } from '@cosmotech/api-ts';
+
+const instance: SendRunDataRequest = {
+    id,
+    data,
+};
+```
+
+[[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/Solution.md

@@ -0,0 +1,53 @@
+# Solution
+
+a version of a Solution
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | the Solution version unique identifier | [optional] [readonly] [default to undefined]
+**organizationId** | **string** | the Organization unique identifier | [optional] [readonly] [default to undefined]
+**key** | **string** | the Solution key which group Solution versions | [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 false]
+**csmSimulator** | **string** | the main Cosmo Tech simulator name used in standard Run Template | [optional] [default to undefined]
+**version** | **string** | the Solution version MAJOR.MINOR.PATCH. Must be aligned with an existing repository tag | [optional] [default to undefined]
+**ownerId** | **string** | the User id which own this Solution | [optional] [readonly] [default to undefined]
+**sdkVersion** | **string** | the MAJOR.MINOR version used to build this solution | [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<RunTemplateParameter>**](RunTemplateParameter.md) | the list of Run Template Parameters | [optional] [default to undefined]
+**parameterGroups** | [**Array<RunTemplateParameterGroup>**](RunTemplateParameterGroup.md) | the list of parameters groups for the Run Templates | [optional] [default to undefined]
+**runTemplates** | [**Array<RunTemplate>**](RunTemplate.md) | list of Run Template | [default to undefined]
+**security** | [**SolutionSecurity**](SolutionSecurity.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Solution } from '@cosmotech/api-ts';
+
+const instance: Solution = {
+    id,
+    organizationId,
+    key,
+    name,
+    description,
+    repository,
+    alwaysPull,
+    csmSimulator,
+    version,
+    ownerId,
+    sdkVersion,
+    url,
+    tags,
+    parameters,
+    parameterGroups,
+    runTemplates,
+    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/SolutionAccessControl.md

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