@cosmotech/api-ts 3.3.4 → 4.2.5-onprem

package/dist/base.d.ts

@@ -2,7 +2,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 3.3.4
+ * The version of the OpenAPI document: 4.2.5-onprem
  * 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: 3.3.4
+ * The version of the OpenAPI document: 4.2.5-onprem
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -30,7 +30,7 @@ var __extends = (this && this.__extends) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
 var axios_1 = require("axios");
-exports.BASE_PATH = "https://dev.api.cosmotech.com".replace(/\/+$/, "");
+exports.BASE_PATH = "http://localhost".replace(/\/+$/, "");
 /**
  *
  * @export

package/dist/common.d.ts

@@ -2,7 +2,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 3.3.4
+ * The version of the OpenAPI document: 4.2.5-onprem
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,54 +12,23 @@
 import type { Configuration } from "./configuration";
 import type { RequestArgs } from "./base";
 import type { AxiosInstance, AxiosResponse } from 'axios';
-/**
- *
- * @export
- */
 export declare const DUMMY_BASE_URL = "https://example.com";
 /**
  *
  * @throws {RequiredError}
- * @export
  */
 export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
-/**
- *
- * @export
- */
 export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
-/**
- *
- * @export
- */
 export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
 /**
- *
- * @export
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
  */
+export declare const replaceWithSerializableTypeIfNeeded: (key: string, value: any) => any;
 export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
-/**
- *
- * @export
- */
 export declare const toPathString: (url: URL) => string;
-/**
- *
- * @export
- */
 export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/dist/common.js

@@ -5,7 +5,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 3.3.4
+ * The version of the OpenAPI document: 4.2.5-onprem
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -60,17 +60,12 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
+exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.replaceWithSerializableTypeIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
 var base_1 = require("./base");
-/**
- *
- * @export
- */
 exports.DUMMY_BASE_URL = 'https://example.com';
 /**
  *
  * @throws {RequiredError}
- * @export
  */
 var assertParamExists = function (functionName, paramName, paramValue) {
     if (paramValue === null || paramValue === undefined) {
@@ -78,10 +73,6 @@ var assertParamExists = function (functionName, paramName, paramValue) {
     }
 };
 exports.assertParamExists = assertParamExists;
-/**
- *
- * @export
- */
 var setApiKeyToObject = function (object, keyParamName, configuration) {
     return __awaiter(this, void 0, void 0, function () {
         var localVarApiKeyValue, _a;
@@ -108,20 +99,12 @@ var setApiKeyToObject = function (object, keyParamName, configuration) {
     });
 };
 exports.setApiKeyToObject = setApiKeyToObject;
-/**
- *
- * @export
- */
 var setBasicAuthToObject = function (object, configuration) {
     if (configuration && (configuration.username || configuration.password)) {
         object["auth"] = { username: configuration.username, password: configuration.password };
     }
 };
 exports.setBasicAuthToObject = setBasicAuthToObject;
-/**
- *
- * @export
- */
 var setBearerAuthToObject = function (object, configuration) {
     return __awaiter(this, void 0, void 0, function () {
         var accessToken, _a;
@@ -148,10 +131,6 @@ var setBearerAuthToObject = function (object, configuration) {
     });
 };
 exports.setBearerAuthToObject = setBearerAuthToObject;
-/**
- *
- * @export
- */
 var setOAuthToObject = function (object, name, scopes, configuration) {
     return __awaiter(this, void 0, void 0, function () {
         var localVarAccessTokenValue, _a;
@@ -183,7 +162,7 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key) {
     if (parameter == null)
         return;
     if (typeof parameter === "object") {
-        if (Array.isArray(parameter)) {
+        if (Array.isArray(parameter) || parameter instanceof Set) {
             parameter.forEach(function (item) { return setFlattenedQueryParams(urlSearchParams, item, key); });
         }
         else {
@@ -201,10 +180,6 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key) {
         }
     }
 }
-/**
- *
- * @export
- */
 var setSearchParams = function (url) {
     var objects = [];
     for (var _i = 1; _i < arguments.length; _i++) {
@@ -216,31 +191,34 @@ var setSearchParams = function (url) {
 };
 exports.setSearchParams = setSearchParams;
 /**
- *
- * @export
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
  */
+// @ts-ignore
+var replaceWithSerializableTypeIfNeeded = function (key, value) {
+    if (value instanceof Set) {
+        return Array.from(value);
+    }
+    else {
+        return value;
+    }
+};
+exports.replaceWithSerializableTypeIfNeeded = replaceWithSerializableTypeIfNeeded;
 var serializeDataIfNeeded = function (value, requestOptions, configuration) {
     var nonString = typeof value !== 'string';
     var needsSerialization = nonString && configuration && configuration.isJsonMime
         ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
         : nonString;
     return needsSerialization
-        ? JSON.stringify(value !== undefined ? value : {})
+        ? JSON.stringify(value !== undefined ? value : {}, exports.replaceWithSerializableTypeIfNeeded)
         : (value || "");
 };
 exports.serializeDataIfNeeded = serializeDataIfNeeded;
-/**
- *
- * @export
- */
 var toPathString = function (url) {
     return url.pathname + url.search + url.hash;
 };
 exports.toPathString = toPathString;
-/**
- *
- * @export
- */
 var createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
     return function (axios, basePath) {
         var _a;

package/dist/configuration.d.ts

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

package/dist/configuration.js

@@ -5,25 +5,37 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 3.3.4
+ * The version of the OpenAPI document: 4.2.5-onprem
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Configuration = void 0;
 var Configuration = /** @class */ (function () {
     function Configuration(param) {
         if (param === void 0) { param = {}; }
+        var _a;
         this.apiKey = param.apiKey;
         this.username = param.username;
         this.password = param.password;
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
+        this.baseOptions = __assign(__assign({}, param.baseOptions), { headers: __assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
         this.formDataCtor = param.formDataCtor;
     }
     /**

package/dist/index.d.ts

@@ -2,7 +2,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 3.3.4
+ * The version of the OpenAPI document: 4.2.5-onprem
  * 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: 3.3.4
+ * The version of the OpenAPI document: 4.2.5-onprem
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/AboutInfo.md

@@ -0,0 +1,21 @@
+# AboutInfo
+
+Misc information about the api
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**version** | [**AboutInfoVersion**](AboutInfoVersion.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { AboutInfo } from '@cosmotech/api-ts';
+
+const instance: AboutInfo = {
+    version,
+};
+```
+
+[[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/AboutInfoVersion.md

@@ -0,0 +1,33 @@
+# AboutInfoVersion
+
+API version details
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**full** | **string** | Full version representation | [default to undefined]
+**release** | **string** | Release main version representation | [default to undefined]
+**major** | **number** | Major version number | [default to undefined]
+**minor** | **number** | Minor version number | [default to undefined]
+**patch** | **number** | Patch version number | [default to undefined]
+**label** | **string** | Label version, may be empty | [default to undefined]
+**build** | **string** | Build VCS id | [default to undefined]
+
+## Example
+
+```typescript
+import { AboutInfoVersion } from '@cosmotech/api-ts';
+
+const instance: AboutInfoVersion = {
+    full,
+    release,
+    major,
+    minor,
+    patch,
+    label,
+    build,
+};
+```
+
+[[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/ComponentRolePermissions.md

@@ -0,0 +1,23 @@
+# ComponentRolePermissions
+
+a RBAC by component
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**component** | **string** |  | [optional] [default to undefined]
+**roles** | **{ [key: string]: Array<string>; }** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ComponentRolePermissions } from '@cosmotech/api-ts';
+
+const instance: ComponentRolePermissions = {
+    component,
+    roles,
+};
+```
+
+[[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/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)