@teemill/platform 0.31.0 → 0.32.0

package/dist/esm/api.js

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.31.0
+ * The version of the OpenAPI document: 0.32.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -544,6 +544,202 @@ export const ListCustomersGenderEnum = {
     Male: 'male',
     Female: 'female'
 };
+/**
+ * DashboardApi - axios parameter creator
+ * @export
+ */
+export const DashboardApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         *
+         * @summary Get the platform\'s dashboard
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDashboard: (project_1, platformId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, ...args_1], void 0, function* (project, platformId, options = {}) {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('getDashboard', 'project', project);
+            // verify required parameter 'platformId' is not null or undefined
+            assertParamExists('getDashboard', 'platformId', platformId);
+            const localVarPath = `/v1/platform/{platformId}/dashboard`
+                .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication session-oauth required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
+            // authentication api-key required
+            yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         *
+         * @summary Save the platform\'s dashboard
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {SaveDashboardRequest} saveDashboardRequest Save dashboard
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        saveDashboard: (project_1, platformId_1, saveDashboardRequest_1, ...args_1) => __awaiter(this, [project_1, platformId_1, saveDashboardRequest_1, ...args_1], void 0, function* (project, platformId, saveDashboardRequest, options = {}) {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('saveDashboard', 'project', project);
+            // verify required parameter 'platformId' is not null or undefined
+            assertParamExists('saveDashboard', 'platformId', platformId);
+            // verify required parameter 'saveDashboardRequest' is not null or undefined
+            assertParamExists('saveDashboard', 'saveDashboardRequest', saveDashboardRequest);
+            const localVarPath = `/v1/platform/{platformId}/dashboard`
+                .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication session-oauth required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
+            // authentication api-key required
+            yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(saveDashboardRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * DashboardApi - functional programming interface
+ * @export
+ */
+export const DashboardApiFp = function (configuration) {
+    const localVarAxiosParamCreator = DashboardApiAxiosParamCreator(configuration);
+    return {
+        /**
+         *
+         * @summary Get the platform\'s dashboard
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDashboard(project, platformId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDashboard(project, platformId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DashboardApi.getDashboard']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         *
+         * @summary Save the platform\'s dashboard
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {SaveDashboardRequest} saveDashboardRequest Save dashboard
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        saveDashboard(project, platformId, saveDashboardRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.saveDashboard(project, platformId, saveDashboardRequest, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DashboardApi.saveDashboard']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+    };
+};
+/**
+ * DashboardApi - factory interface
+ * @export
+ */
+export const DashboardApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = DashboardApiFp(configuration);
+    return {
+        /**
+         *
+         * @summary Get the platform\'s dashboard
+         * @param {DashboardApiGetDashboardRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDashboard(requestParameters, options) {
+            return localVarFp.getDashboard(requestParameters.project, requestParameters.platformId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *
+         * @summary Save the platform\'s dashboard
+         * @param {DashboardApiSaveDashboardRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        saveDashboard(requestParameters, options) {
+            return localVarFp.saveDashboard(requestParameters.project, requestParameters.platformId, requestParameters.saveDashboardRequest, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * DashboardApi - object-oriented interface
+ * @export
+ * @class DashboardApi
+ * @extends {BaseAPI}
+ */
+export class DashboardApi extends BaseAPI {
+    /**
+     *
+     * @summary Get the platform\'s dashboard
+     * @param {DashboardApiGetDashboardRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardApi
+     */
+    getDashboard(requestParameters, options) {
+        return DashboardApiFp(this.configuration).getDashboard(requestParameters.project, requestParameters.platformId, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     *
+     * @summary Save the platform\'s dashboard
+     * @param {DashboardApiSaveDashboardRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardApi
+     */
+    saveDashboard(requestParameters, options) {
+        return DashboardApiFp(this.configuration).saveDashboard(requestParameters.project, requestParameters.platformId, requestParameters.saveDashboardRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+}
 /**
  * EnquiriesApi - axios parameter creator
  * @export

package/dist/esm/base.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.31.0
+ * The version of the OpenAPI document: 0.32.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/base.js

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.31.0
+ * The version of the OpenAPI document: 0.32.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.31.0
+ * The version of the OpenAPI document: 0.32.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.js

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.31.0
+ * The version of the OpenAPI document: 0.32.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.31.0
+ * The version of the OpenAPI document: 0.32.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.js

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.31.0
+ * The version of the OpenAPI document: 0.32.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/index.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.31.0
+ * The version of the OpenAPI document: 0.32.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/index.js

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.31.0
+ * The version of the OpenAPI document: 0.32.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.31.0
+ * The version of the OpenAPI document: 0.32.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.js

@@ -5,7 +5,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.31.0
+ * The version of the OpenAPI document: 0.32.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/DashboardApi.md

@@ -0,0 +1,127 @@
+# DashboardApi
+
+All URIs are relative to *https://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getDashboard**](#getdashboard) | **GET** /v1/platform/{platformId}/dashboard | Get the platform\'s dashboard|
+|[**saveDashboard**](#savedashboard) | **PUT** /v1/platform/{platformId}/dashboard | Save the platform\'s dashboard|
+
+# **getDashboard**
+> GetDashboardResponse getDashboard()
+
+
+### Example
+
+```typescript
+import {
+    DashboardApi,
+    Configuration
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new DashboardApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+
+const { status, data } = await apiInstance.getDashboard(
+    project,
+    platformId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+
+
+### Return type
+
+**GetDashboardResponse**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved the dashboard. |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[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)
+
+# **saveDashboard**
+> GetDashboardResponse saveDashboard(saveDashboardRequest)
+
+
+### Example
+
+```typescript
+import {
+    DashboardApi,
+    Configuration,
+    SaveDashboardRequest
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new DashboardApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+let saveDashboardRequest: SaveDashboardRequest; //Save dashboard
+
+const { status, data } = await apiInstance.saveDashboard(
+    project,
+    platformId,
+    saveDashboardRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **saveDashboardRequest** | **SaveDashboardRequest**| Save dashboard | |
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+
+
+### Return type
+
+**GetDashboardResponse**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved the dashboard. |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[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/DashboardItem.md

@@ -0,0 +1,30 @@
+# DashboardItem
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**type** | **string** |  | [default to undefined]
+**properties** | **{ [key: string]: any; }** |  | [default to undefined]
+**published** | **boolean** |  | [default to undefined]
+**sortOrder** | **number** |  | [default to undefined]
+**items** | [**Array<DashboardItem>**](DashboardItem.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DashboardItem } from '@teemill/platform';
+
+const instance: DashboardItem = {
+    id,
+    type,
+    properties,
+    published,
+    sortOrder,
+    items,
+};
+```
+
+[[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/GetDashboardResponse.md

@@ -0,0 +1,20 @@
+# GetDashboardResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<DashboardItem>**](DashboardItem.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetDashboardResponse } from '@teemill/platform';
+
+const instance: GetDashboardResponse = {
+    items,
+};
+```
+
+[[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/SaveDashboardRequest.md

@@ -0,0 +1,20 @@
+# SaveDashboardRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<DashboardItem>**](DashboardItem.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SaveDashboardRequest } from '@teemill/platform';
+
+const instance: SaveDashboardRequest = {
+    items,
+};
+```
+
+[[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/index.ts

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.31.0
+ * The version of the OpenAPI document: 0.32.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teemill/platform",
-  "version": "0.31.0",
+  "version": "0.32.0",
   "description": "OpenAPI client for @teemill/platform",
   "author": "OpenAPI-Generator Contributors",
   "repository": {