@cosmotech/api-ts 3.3.4 → 5.0.0-beta3

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/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
+
+Response object for 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,55 @@
+# 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]
+**createInfo** | [**RunEditInfo**](RunEditInfo.md) | The details of the Run creation | [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]
+**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]
+**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,
+    createInfo,
+    workflowId,
+    csmSimulationRun,
+    generateName,
+    workflowName,
+    workspaceId,
+    workspaceKey,
+    runnerId,
+    solutionId,
+    runTemplateId,
+    computeSize,
+    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)

package/docs/RunApi.md

@@ -0,0 +1,442 @@
+# RunApi
+
+All URIs are relative to *http://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteRun**](#deleterun) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id} | Delete a run|
+|[**getRun**](#getrun) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id} | Get the details of a run|
+|[**getRunLogs**](#getrunlogs) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/logs | get the logs for the Run|
+|[**getRunStatus**](#getrunstatus) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/status | get the status for the Run|
+|[**listRuns**](#listruns) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs | get the list of Runs for the Runner|
+|[**queryRunData**](#queryrundata) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/query | query the run data|
+|[**sendRunData**](#sendrundata) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/send | Send data associated to a run|
+
+# **deleteRun**
+> deleteRun()
+
+
+### Example
+
+```typescript
+import {
+    RunApi,
+    Configuration
+} from '@cosmotech/api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RunApi(configuration);
+
+let organizationId: string; //the Organization identifier (default to undefined)
+let workspaceId: string; //the Workspace identifier (default to undefined)
+let runnerId: string; //the Runner identifier (default to undefined)
+let runId: string; //the Run identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteRun(
+    organizationId,
+    workspaceId,
+    runnerId,
+    runId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
+| **workspaceId** | [**string**] | the Workspace identifier | defaults to undefined|
+| **runnerId** | [**string**] | the Runner identifier | defaults to undefined|
+| **runId** | [**string**] | the Run identifier | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[oAuth2AuthCode](../README.md#oAuth2AuthCode)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Request succeeded |  -  |
+|**400** | Bad request |  -  |
+|**404** | the Run specified is unknown or you don\'t have access to it |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getRun**
+> Run getRun()
+
+
+### Example
+
+```typescript
+import {
+    RunApi,
+    Configuration
+} from '@cosmotech/api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RunApi(configuration);
+
+let organizationId: string; //the Organization identifier (default to undefined)
+let workspaceId: string; //the Workspace identifier (default to undefined)
+let runnerId: string; //the Runner identifier (default to undefined)
+let runId: string; //the Run identifier (default to undefined)
+
+const { status, data } = await apiInstance.getRun(
+    organizationId,
+    workspaceId,
+    runnerId,
+    runId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
+| **workspaceId** | [**string**] | the Workspace identifier | defaults to undefined|
+| **runnerId** | [**string**] | the Runner identifier | defaults to undefined|
+| **runId** | [**string**] | the Run identifier | defaults to undefined|
+
+
+### Return type
+
+**Run**
+
+### Authorization
+
+[oAuth2AuthCode](../README.md#oAuth2AuthCode)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, application/yaml
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | the Run details |  -  |
+|**404** | the Run specified is unknown or you don\'t have access to it |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getRunLogs**
+> string getRunLogs()
+
+
+### Example
+
+```typescript
+import {
+    RunApi,
+    Configuration
+} from '@cosmotech/api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RunApi(configuration);
+
+let organizationId: string; //the Organization identifier (default to undefined)
+let workspaceId: string; //the Workspace identifier (default to undefined)
+let runnerId: string; //the Runner identifier (default to undefined)
+let runId: string; //the Run identifier (default to undefined)
+
+const { status, data } = await apiInstance.getRunLogs(
+    organizationId,
+    workspaceId,
+    runnerId,
+    runId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
+| **workspaceId** | [**string**] | the Workspace identifier | defaults to undefined|
+| **runnerId** | [**string**] | the Runner identifier | defaults to undefined|
+| **runId** | [**string**] | the Run identifier | defaults to undefined|
+
+
+### Return type
+
+**string**
+
+### Authorization
+
+[oAuth2AuthCode](../README.md#oAuth2AuthCode)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/plain
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | the run logs details |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getRunStatus**
+> RunStatus getRunStatus()
+
+
+### Example
+
+```typescript
+import {
+    RunApi,
+    Configuration
+} from '@cosmotech/api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RunApi(configuration);
+
+let organizationId: string; //the Organization identifier (default to undefined)
+let workspaceId: string; //the Workspace identifier (default to undefined)
+let runnerId: string; //the Runner identifier (default to undefined)
+let runId: string; //the Run identifier (default to undefined)
+
+const { status, data } = await apiInstance.getRunStatus(
+    organizationId,
+    workspaceId,
+    runnerId,
+    runId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
+| **workspaceId** | [**string**] | the Workspace identifier | defaults to undefined|
+| **runnerId** | [**string**] | the Runner identifier | defaults to undefined|
+| **runId** | [**string**] | the Run identifier | defaults to undefined|
+
+
+### Return type
+
+**RunStatus**
+
+### Authorization
+
+[oAuth2AuthCode](../README.md#oAuth2AuthCode)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, application/yaml
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | the run status details |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listRuns**
+> Array<Run> listRuns()
+
+
+### Example
+
+```typescript
+import {
+    RunApi,
+    Configuration
+} from '@cosmotech/api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RunApi(configuration);
+
+let organizationId: string; //the Organization identifier (default to undefined)
+let workspaceId: string; //the Workspace identifier (default to undefined)
+let runnerId: string; //the Runner identifier (default to undefined)
+let page: number; //page number to query (first page is at index 0) (optional) (default to undefined)
+let size: number; //amount of result by page (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listRuns(
+    organizationId,
+    workspaceId,
+    runnerId,
+    page,
+    size
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
+| **workspaceId** | [**string**] | the Workspace identifier | defaults to undefined|
+| **runnerId** | [**string**] | the Runner identifier | defaults to undefined|
+| **page** | [**number**] | page number to query (first page is at index 0) | (optional) defaults to undefined|
+| **size** | [**number**] | amount of result by page | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<Run>**
+
+### Authorization
+
+[oAuth2AuthCode](../README.md#oAuth2AuthCode)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, application/yaml
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | the run details list |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **queryRunData**
+> QueryResult queryRunData(runDataQuery)
+
+
+### Example
+
+```typescript
+import {
+    RunApi,
+    Configuration,
+    RunDataQuery
+} from '@cosmotech/api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RunApi(configuration);
+
+let organizationId: string; //the Organization identifier (default to undefined)
+let workspaceId: string; //the Workspace identifier (default to undefined)
+let runnerId: string; //the Runner identifier (default to undefined)
+let runId: string; //the Run identifier (default to undefined)
+let runDataQuery: RunDataQuery; //the query to run
+
+const { status, data } = await apiInstance.queryRunData(
+    organizationId,
+    workspaceId,
+    runnerId,
+    runId,
+    runDataQuery
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **runDataQuery** | **RunDataQuery**| the query to run | |
+| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
+| **workspaceId** | [**string**] | the Workspace identifier | defaults to undefined|
+| **runnerId** | [**string**] | the Runner identifier | defaults to undefined|
+| **runId** | [**string**] | the Run identifier | defaults to undefined|
+
+
+### Return type
+
+**QueryResult**
+
+### Authorization
+
+[oAuth2AuthCode](../README.md#oAuth2AuthCode)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/yaml
+ - **Accept**: application/json, application/yaml
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | the query response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **sendRunData**
+> RunData sendRunData(sendRunDataRequest)
+
+
+### Example
+
+```typescript
+import {
+    RunApi,
+    Configuration,
+    SendRunDataRequest
+} from '@cosmotech/api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RunApi(configuration);
+
+let organizationId: string; //the Organization identifier (default to undefined)
+let workspaceId: string; //the Workspace identifier (default to undefined)
+let runnerId: string; //the Runner identifier (default to undefined)
+let runId: string; //the Run identifier (default to undefined)
+let sendRunDataRequest: SendRunDataRequest; //Custom data to register
+
+const { status, data } = await apiInstance.sendRunData(
+    organizationId,
+    workspaceId,
+    runnerId,
+    runId,
+    sendRunDataRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sendRunDataRequest** | **SendRunDataRequest**| Custom data to register | |
+| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
+| **workspaceId** | [**string**] | the Workspace identifier | defaults to undefined|
+| **runnerId** | [**string**] | the Runner identifier | defaults to undefined|
+| **runId** | [**string**] | the Run identifier | defaults to undefined|
+
+
+### Return type
+
+**RunData**
+
+### Authorization
+
+[oAuth2AuthCode](../README.md#oAuth2AuthCode)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/yaml
+ - **Accept**: application/json, application/yaml
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Data stored |  -  |
+|**400** | Data sent format is malformed |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/RunContainer.md

@@ -0,0 +1,41 @@
+# RunContainer
+
+a Run container description
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | the container Id | [optional] [readonly] [default to undefined]
+**name** | **string** | the container name | [default to undefined]
+**labels** | **{ [key: string]: string; }** | the metadata labels | [optional] [default to undefined]
+**envVars** | **{ [key: string]: string; }** | environment variable map | [optional] [default to undefined]
+**image** | **string** | the container image URI | [default to undefined]
+**entrypoint** | **string** | the container entry point | [optional] [default to undefined]
+**runArgs** | **Array<string>** | the list of run arguments for the container | [optional] [default to undefined]
+**dependencies** | **Array<string>** | the list of dependencies container name to run this container | [optional] [default to undefined]
+**solutionContainer** | **boolean** | whether or not this container is a Cosmo Tech solution container | [optional] [readonly] [default to undefined]
+**nodeLabel** | **string** | the node label request | [optional] [default to undefined]
+**runSizing** | [**ContainerResourceSizing**](ContainerResourceSizing.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RunContainer } from '@cosmotech/api-ts';
+
+const instance: RunContainer = {
+    id,
+    name,
+    labels,
+    envVars,
+    image,
+    entrypoint,
+    runArgs,
+    dependencies,
+    solutionContainer,
+    nodeLabel,
+    runSizing,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)