@cosmotech/api-ts 5.0.0-beta4 → 5.0.0-beta6

package/dist/base.d.ts

@@ -2,7 +2,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 5.0.0-beta4
+ * The version of the OpenAPI document: 5.0.0-beta6
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/base.js

@@ -5,7 +5,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 5.0.0-beta4
+ * The version of the OpenAPI document: 5.0.0-beta6
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/common.d.ts

@@ -2,7 +2,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 5.0.0-beta4
+ * The version of the OpenAPI document: 5.0.0-beta6
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/common.js

@@ -5,7 +5,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 5.0.0-beta4
+ * The version of the OpenAPI document: 5.0.0-beta6
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/configuration.d.ts

@@ -2,7 +2,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 5.0.0-beta4
+ * The version of the OpenAPI document: 5.0.0-beta6
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/configuration.js

@@ -5,7 +5,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 5.0.0-beta4
+ * The version of the OpenAPI document: 5.0.0-beta6
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.d.ts

@@ -2,7 +2,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 5.0.0-beta4
+ * The version of the OpenAPI document: 5.0.0-beta6
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.js

@@ -5,7 +5,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 5.0.0-beta4
+ * The version of the OpenAPI document: 5.0.0-beta6
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/Connector.md

@@ -0,0 +1,41 @@
+# Connector
+
+a version of a Connector
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | the Connector version unique identifier | [optional] [readonly] [default to undefined]
+**key** | **string** | the Connector key which group Connector versions | [optional] [default to undefined]
+**name** | **string** | the Connector name | [optional] [default to undefined]
+**description** | **string** | the Connector description | [optional] [default to undefined]
+**repository** | **string** | the registry repository containing the image | [optional] [default to undefined]
+**version** | **string** | the Connector version MAJOR.MINOR.PATCH. Must be aligned with an existing repository tag | [optional] [default to undefined]
+**tags** | **Array<string>** | the list of tags | [optional] [default to undefined]
+**ownerId** | **string** | the user id which own this connector version | [optional] [readonly] [default to undefined]
+**url** | **string** | an optional URL link to connector page | [optional] [default to undefined]
+**ioTypes** | [**Array<IoTypesEnum>**](IoTypesEnum.md) |  | [optional] [default to undefined]
+**parameterGroups** | [**Array<ConnectorParameterGroup>**](ConnectorParameterGroup.md) | the list of connector parameters groups | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Connector } from '@cosmotech/api-ts';
+
+const instance: Connector = {
+    id,
+    key,
+    name,
+    description,
+    repository,
+    version,
+    tags,
+    ownerId,
+    url,
+    ioTypes,
+    parameterGroups,
+};
+```
+
+[[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/ConnectorApi.md

@@ -0,0 +1,218 @@
+# ConnectorApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**findAllConnectors**](#findallconnectors) | **GET** /connectors | List all Connectors|
+|[**findConnectorById**](#findconnectorbyid) | **GET** /connectors/{connector_id} | Get the details of a connector|
+|[**registerConnector**](#registerconnector) | **POST** /connectors | Register a new connector|
+|[**unregisterConnector**](#unregisterconnector) | **DELETE** /connectors/{connector_id} | Unregister a connector|
+
+# **findAllConnectors**
+> Array<Connector> findAllConnectors()
+
+
+### Example
+
+```typescript
+import {
+    ConnectorApi,
+    Configuration
+} from '@cosmotech/api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ConnectorApi(configuration);
+
+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.findAllConnectors(
+    page,
+    size
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **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<Connector>**
+
+### 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 list of Connectors |  -  |
+
+[[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)
+
+# **findConnectorById**
+> Connector findConnectorById()
+
+
+### Example
+
+```typescript
+import {
+    ConnectorApi,
+    Configuration
+} from '@cosmotech/api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ConnectorApi(configuration);
+
+let connectorId: string; //the Connector identifier (default to undefined)
+
+const { status, data } = await apiInstance.findConnectorById(
+    connectorId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **connectorId** | [**string**] | the Connector identifier | defaults to undefined|
+
+
+### Return type
+
+**Connector**
+
+### 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 Connector details |  -  |
+|**404** | the Connector specified is unknown or you don\&#39;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)
+
+# **registerConnector**
+> Connector registerConnector(connector)
+
+
+### Example
+
+```typescript
+import {
+    ConnectorApi,
+    Configuration,
+    Connector
+} from '@cosmotech/api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ConnectorApi(configuration);
+
+let connector: Connector; //the Connector to register
+
+const { status, data } = await apiInstance.registerConnector(
+    connector
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **connector** | **Connector**| the Connector to register | |
+
+
+### Return type
+
+**Connector**
+
+### Authorization
+
+[oAuth2AuthCode](../README.md#oAuth2AuthCode)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/yaml
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | the connector details |  -  |
+|**400** | Bad request |  -  |
+
+[[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)
+
+# **unregisterConnector**
+> unregisterConnector()
+
+
+### Example
+
+```typescript
+import {
+    ConnectorApi,
+    Configuration
+} from '@cosmotech/api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ConnectorApi(configuration);
+
+let connectorId: string; //the Connector identifier (default to undefined)
+
+const { status, data } = await apiInstance.unregisterConnector(
+    connectorId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **connectorId** | [**string**] | the Connector 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 successful |  -  |
+|**404** | the Connector specified is unknown or you don\&#39;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)
+

package/docs/ConnectorParameter.md

@@ -0,0 +1,31 @@
+# ConnectorParameter
+
+a connector parameter
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | the connector parameter id | [default to undefined]
+**label** | **string** | the list of translated parameter group labels | [default to undefined]
+**valueType** | **string** | the parameter value type | [optional] [default to undefined]
+**_options** | **Array<string>** | the list of available and valid values for the parameter | [optional] [default to undefined]
+**_default** | **string** | the default value | [optional] [default to undefined]
+**envVar** | **string** | associated environment variable in connector image | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ConnectorParameter } from '@cosmotech/api-ts';
+
+const instance: ConnectorParameter = {
+    id,
+    label,
+    valueType,
+    _options,
+    _default,
+    envVar,
+};
+```
+
+[[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/ConnectorParameterGroup.md

@@ -0,0 +1,25 @@
+# ConnectorParameterGroup
+
+a connector parameters group
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | the connector parameter group id | [default to undefined]
+**label** | **string** | the list of translated parameter group labels | [default to undefined]
+**parameters** | [**Array<ConnectorParameter>**](ConnectorParameter.md) | the list of parameters | [default to undefined]
+
+## Example
+
+```typescript
+import { ConnectorParameterGroup } from '@cosmotech/api-ts';
+
+const instance: ConnectorParameterGroup = {
+    id,
+    label,
+    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)