@cosmotech/api-ts 4.0.0-dev9 → 5.0.0-beta3

package/docs/DatasetCreateRequest.md

@@ -0,0 +1,31 @@
+# DatasetCreateRequest
+
+Dataset creation request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**tags** | **Array<string>** |  | [optional] [default to undefined]
+**parts** | [**Array<DatasetPartCreateRequest>**](DatasetPartCreateRequest.md) |  | [optional] [default to undefined]
+**security** | [**DatasetSecurity**](DatasetSecurity.md) |  | [optional] [default to undefined]
+**runnerId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DatasetCreateRequest } from '@cosmotech/api-ts';
+
+const instance: DatasetCreateRequest = {
+    name,
+    description,
+    tags,
+    parts,
+    security,
+    runnerId,
+};
+```
+
+[[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/DatasetPart.md

@@ -0,0 +1,41 @@
+# DatasetPart
+
+Dataset part object
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**sourceName** | **string** | the source data name (e.g. filename associated to the dataset part) | [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**tags** | **Array<string>** |  | [default to undefined]
+**type** | [**DatasetPartTypeEnum**](DatasetPartTypeEnum.md) |  | [default to undefined]
+**organizationId** | **string** | the associated Organization Id | [readonly] [default to undefined]
+**workspaceId** | **string** | the associated Workspace Id | [readonly] [default to undefined]
+**datasetId** | **string** | the associated Dataset Id | [readonly] [default to undefined]
+**createInfo** | [**EditInfo**](EditInfo.md) | The details of the Dataset creation | [default to undefined]
+**updateInfo** | [**EditInfo**](EditInfo.md) | The details of the Dataset last update | [default to undefined]
+
+## Example
+
+```typescript
+import { DatasetPart } from '@cosmotech/api-ts';
+
+const instance: DatasetPart = {
+    id,
+    name,
+    sourceName,
+    description,
+    tags,
+    type,
+    organizationId,
+    workspaceId,
+    datasetId,
+    createInfo,
+    updateInfo,
+};
+```
+
+[[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/DatasetPartCreateRequest.md

@@ -0,0 +1,29 @@
+# DatasetPartCreateRequest
+
+Dataset part create request object
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**sourceName** | **string** | the source data name (e.g. filename associated to the dataset part) | [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**tags** | **Array<string>** |  | [optional] [default to undefined]
+**type** | [**DatasetPartTypeEnum**](DatasetPartTypeEnum.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DatasetPartCreateRequest } from '@cosmotech/api-ts';
+
+const instance: DatasetPartCreateRequest = {
+    name,
+    sourceName,
+    description,
+    tags,
+    type,
+};
+```
+
+[[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/DatasetPartTypeEnum.md

@@ -0,0 +1,11 @@
+# DatasetPartTypeEnum
+
+The dataset part Type
+
+## Enum
+
+* `File` (value: `'File'`)
+
+* `Relational` (value: `'Relational'`)
+
+[[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/DatasetPartUpdateRequest.md

@@ -0,0 +1,23 @@
+# DatasetPartUpdateRequest
+
+Dataset part update request object
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **string** |  | [optional] [default to undefined]
+**tags** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DatasetPartUpdateRequest } from '@cosmotech/api-ts';
+
+const instance: DatasetPartUpdateRequest = {
+    description,
+    tags,
+};
+```
+
+[[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/DatasetRole.md

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

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

@@ -0,0 +1,29 @@
+# DatasetUpdateRequest
+
+Dataset creation request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**tags** | **Array<string>** |  | [optional] [default to undefined]
+**parts** | [**Array<DatasetPartCreateRequest>**](DatasetPartCreateRequest.md) |  | [optional] [default to undefined]
+**security** | [**DatasetSecurity**](DatasetSecurity.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DatasetUpdateRequest } from '@cosmotech/api-ts';
+
+const instance: DatasetUpdateRequest = {
+    name,
+    description,
+    tags,
+    parts,
+    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/EditInfo.md

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

@@ -0,0 +1,23 @@
+# LastRunInfo
+
+last run info from current runner
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**lastRunId** | **string** | last run id from current runner | [optional] [default to undefined]
+**lastRunStatus** | **string** | last run status from current runner | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { LastRunInfo } from '@cosmotech/api-ts';
+
+const instance: LastRunInfo = {
+    lastRunId,
+    lastRunStatus,
+};
+```
+
+[[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/MetaApi.md

@@ -0,0 +1,51 @@
+# MetaApi
+
+All URIs are relative to *http://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**about**](#about) | **GET** /about | Get various information about the API|
+
+# **about**
+> AboutInfo about()
+
+
+### Example
+
+```typescript
+import {
+    MetaApi,
+    Configuration
+} from '@cosmotech/api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new MetaApi(configuration);
+
+const { status, data } = await apiInstance.about();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**AboutInfo**
+
+### 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** | API information 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)
+

package/docs/Organization.md

@@ -0,0 +1,29 @@
+# Organization
+
+An Organization
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | The Organization unique identifier | [readonly] [default to undefined]
+**name** | **string** | The Organization name | [default to undefined]
+**createInfo** | [**OrganizationEditInfo**](OrganizationEditInfo.md) | The details of the Organization creation | [default to undefined]
+**updateInfo** | [**OrganizationEditInfo**](OrganizationEditInfo.md) | The details of the Organization last update | [default to undefined]
+**security** | [**OrganizationSecurity**](OrganizationSecurity.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Organization } from '@cosmotech/api-ts';
+
+const instance: Organization = {
+    id,
+    name,
+    createInfo,
+    updateInfo,
+    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/OrganizationAccessControl.md

@@ -0,0 +1,23 @@
+# OrganizationAccessControl
+
+Response object for organization access control
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | The identity id | [default to undefined]
+**role** | **string** | A role | [default to undefined]
+
+## Example
+
+```typescript
+import { OrganizationAccessControl } from '@cosmotech/api-ts';
+
+const instance: OrganizationAccessControl = {
+    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)