@cosmotech/api-ts 3.3.4 → 4.2.5-onprem

package/docs/IAMInfoApi.md

@@ -0,0 +1,95 @@
+# IAMInfoApi
+
+All URIs are relative to *http://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**listIAMGroups**](#listiamgroups) | **GET** /iaminfo/groups | Get the list of all groups|
+|[**listIAMMembers**](#listiammembers) | **GET** /iaminfo/members | Get ALL IAM members list|
+
+# **listIAMGroups**
+> Array<string> listIAMGroups()
+
+
+### Example
+
+```typescript
+import {
+    IAMInfoApi,
+    Configuration
+} from '@cosmotech/api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new IAMInfoApi(configuration);
+
+const { status, data } = await apiInstance.listIAMGroups();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<string>**
+
+### 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 list of all groups |  -  |
+
+[[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)
+
+# **listIAMMembers**
+> Members listIAMMembers()
+
+
+### Example
+
+```typescript
+import {
+    IAMInfoApi,
+    Configuration
+} from '@cosmotech/api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new IAMInfoApi(configuration);
+
+const { status, data } = await apiInstance.listIAMMembers();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Members**
+
+### 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 ALL members 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)
+

package/docs/IngestionStatusEnum.md

@@ -0,0 +1,15 @@
+# IngestionStatusEnum
+
+the Dataset ingestion status
+
+## Enum
+
+* `None` (value: `'NONE'`)
+
+* `Pending` (value: `'PENDING'`)
+
+* `Error` (value: `'ERROR'`)
+
+* `Success` (value: `'SUCCESS'`)
+
+[[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/IoTypesEnum.md

@@ -0,0 +1,11 @@
+# IoTypesEnum
+
+The read and write capabilities of connector
+
+## Enum
+
+* `Read` (value: `'read'`)
+
+* `Write` (value: `'write'`)
+
+[[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/MemberGroup.md

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

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

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

@@ -0,0 +1,52 @@
+# 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()
+
+Retrieve API version information and build details.
+
+### 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,27 @@
+# Organization
+
+an Organization
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | the Organization unique identifier | [optional] [readonly] [default to undefined]
+**name** | **string** | the Organization name | [optional] [default to undefined]
+**ownerId** | **string** | the Owner User Id | [optional] [readonly] [default to undefined]
+**security** | [**OrganizationSecurity**](OrganizationSecurity.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Organization } from '@cosmotech/api-ts';
+
+const instance: Organization = {
+    id,
+    name,
+    ownerId,
+    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
+
+a Organization 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 { 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)