@cosmotech/api-ts 3.3.4 → 4.2.5-onprem

package/docs/RunApi.md

@@ -0,0 +1,442 @@
+# RunApi
+
+All URIs are relative to *http://localhost*
+
+|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
+
+
+### 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**
+> RunLogs 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
+
+**RunLogs**
+
+### Authorization
+
+[oAuth2AuthCode](../README.md#oAuth2AuthCode)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### 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
+
+
+### 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
+
+
+### 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
+ - **Accept**: application/json
+
+
+### 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
+ - **Accept**: application/json
+
+
+### 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)

package/docs/RunData.md

@@ -0,0 +1,25 @@
+# RunData
+
+Run Data to send
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**database_name** | **string** | Database name | [optional] [default to undefined]
+**table_name** | **string** | Table name | [optional] [default to undefined]
+**data** | **Array<{ [key: string]: any; }>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RunData } from '@cosmotech/api-ts';
+
+const instance: RunData = {
+    database_name,
+    table_name,
+    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/RunDataQuery.md

@@ -0,0 +1,21 @@
+# RunDataQuery
+
+a data result query in SQL
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**query** | **string** | the query in SQL | [default to undefined]
+
+## Example
+
+```typescript
+import { RunDataQuery } from '@cosmotech/api-ts';
+
+const instance: RunDataQuery = {
+    query,
+};
+```
+
+[[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/RunEditInfo.md

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

@@ -0,0 +1,23 @@
+# RunLogs
+
+the output logs of a run
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**runId** | **string** | the Run Id | [readonly] [default to undefined]
+**logs** | [**Array<RunLogsEntry>**](RunLogsEntry.md) | run log entries in chronological order | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { RunLogs } from '@cosmotech/api-ts';
+
+const instance: RunLogs = {
+    runId,
+    logs,
+};
+```
+
+[[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/RunLogsEntry.md

@@ -0,0 +1,21 @@
+# RunLogsEntry
+
+single run log entry
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**line** | **string** | log line data | [default to undefined]
+
+## Example
+
+```typescript
+import { RunLogsEntry } from '@cosmotech/api-ts';
+
+const instance: RunLogsEntry = {
+    line,
+};
+```
+
+[[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/RunResourceRequested.md

@@ -0,0 +1,23 @@
+# RunResourceRequested
+
+the memory and CPU requested by the pod
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cpu** | **number** | the cpu requested | [optional] [default to undefined]
+**memory** | **number** | the memory requested | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RunResourceRequested } from '@cosmotech/api-ts';
+
+const instance: RunResourceRequested = {
+    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/RunState.md

@@ -0,0 +1,15 @@
+# RunState
+
+the Run end-to-end state
+
+## Enum
+
+* `Running` (value: `'Running'`)
+
+* `Successful` (value: `'Successful'`)
+
+* `Failed` (value: `'Failed'`)
+
+* `Unknown` (value: `'Unknown'`)
+
+[[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/RunStatus.md

@@ -0,0 +1,47 @@
+# RunStatus
+
+a Run status
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | the Run id | [optional] [default to undefined]
+**organizationId** | **string** | the Organization id | [optional] [default to undefined]
+**workspaceId** | **string** | the Workspace id | [optional] [default to undefined]
+**runnerId** | **string** | the Runner id | [optional] [default to undefined]
+**workflowId** | **string** | the Cosmo Tech compute cluster Argo Workflow Id to search | [optional] [default to undefined]
+**workflowName** | **string** | the Cosmo Tech compute cluster Argo Workflow Name | [optional] [default to undefined]
+**startTime** | **string** | the Run start Date Time | [optional] [default to undefined]
+**endTime** | **string** | the Run end Date Time | [optional] [default to undefined]
+**phase** | **string** | high-level summary of where the workflow is in its lifecycle | [optional] [default to undefined]
+**progress** | **string** | progress to completion | [optional] [default to undefined]
+**message** | **string** | a  human readable message indicating details about why the workflow is in this condition | [optional] [default to undefined]
+**estimatedDuration** | **number** | estimatedDuration in seconds | [optional] [default to undefined]
+**nodes** | [**Array<RunStatusNode>**](RunStatusNode.md) | status of Run nodes | [optional] [default to undefined]
+**state** | [**RunState**](RunState.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RunStatus } from '@cosmotech/api-ts';
+
+const instance: RunStatus = {
+    id,
+    organizationId,
+    workspaceId,
+    runnerId,
+    workflowId,
+    workflowName,
+    startTime,
+    endTime,
+    phase,
+    progress,
+    message,
+    estimatedDuration,
+    nodes,
+    state,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)