@teemill/platform 0.20.0 → 0.21.0

package/dist/esm/api.js

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.20.0
+ * The version of the OpenAPI document: 0.21.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2251,3 +2251,199 @@ export class ReviewsApi extends BaseAPI {
         return ReviewsApiFp(this.configuration).moderateReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, requestParameters.moderateReviewRequest, options).then((request) => request(this.axios, this.basePath));
     }
 }
+/**
+ * TermsApi - axios parameter creator
+ * @export
+ */
+export const TermsApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         *
+         * @summary Get the platform\'s terms
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getTerms: (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('getTerms', 'project', project);
+            // verify required parameter 'platformId' is not null or undefined
+            assertParamExists('getTerms', 'platformId', platformId);
+            const localVarPath = `/v1/platform/{platformId}/terms`
+                .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 terms
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {SaveTermsRequest} saveTermsRequest Save terms
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        saveTerms: (project_1, platformId_1, saveTermsRequest_1, ...args_1) => __awaiter(this, [project_1, platformId_1, saveTermsRequest_1, ...args_1], void 0, function* (project, platformId, saveTermsRequest, options = {}) {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('saveTerms', 'project', project);
+            // verify required parameter 'platformId' is not null or undefined
+            assertParamExists('saveTerms', 'platformId', platformId);
+            // verify required parameter 'saveTermsRequest' is not null or undefined
+            assertParamExists('saveTerms', 'saveTermsRequest', saveTermsRequest);
+            const localVarPath = `/v1/platform/{platformId}/terms`
+                .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: 'POST' }, 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(saveTermsRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * TermsApi - functional programming interface
+ * @export
+ */
+export const TermsApiFp = function (configuration) {
+    const localVarAxiosParamCreator = TermsApiAxiosParamCreator(configuration);
+    return {
+        /**
+         *
+         * @summary Get the platform\'s terms
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getTerms(project, platformId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getTerms(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['TermsApi.getTerms']) === 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 terms
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {SaveTermsRequest} saveTermsRequest Save terms
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        saveTerms(project, platformId, saveTermsRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.saveTerms(project, platformId, saveTermsRequest, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['TermsApi.saveTerms']) === 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);
+            });
+        },
+    };
+};
+/**
+ * TermsApi - factory interface
+ * @export
+ */
+export const TermsApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = TermsApiFp(configuration);
+    return {
+        /**
+         *
+         * @summary Get the platform\'s terms
+         * @param {TermsApiGetTermsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getTerms(requestParameters, options) {
+            return localVarFp.getTerms(requestParameters.project, requestParameters.platformId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *
+         * @summary Save the platform\'s terms
+         * @param {TermsApiSaveTermsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        saveTerms(requestParameters, options) {
+            return localVarFp.saveTerms(requestParameters.project, requestParameters.platformId, requestParameters.saveTermsRequest, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * TermsApi - object-oriented interface
+ * @export
+ * @class TermsApi
+ * @extends {BaseAPI}
+ */
+export class TermsApi extends BaseAPI {
+    /**
+     *
+     * @summary Get the platform\'s terms
+     * @param {TermsApiGetTermsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TermsApi
+     */
+    getTerms(requestParameters, options) {
+        return TermsApiFp(this.configuration).getTerms(requestParameters.project, requestParameters.platformId, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     *
+     * @summary Save the platform\'s terms
+     * @param {TermsApiSaveTermsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TermsApi
+     */
+    saveTerms(requestParameters, options) {
+        return TermsApiFp(this.configuration).saveTerms(requestParameters.project, requestParameters.platformId, requestParameters.saveTermsRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+}

package/dist/esm/base.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.20.0
+ * The version of the OpenAPI document: 0.21.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.20.0
+ * The version of the OpenAPI document: 0.21.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.20.0
+ * The version of the OpenAPI document: 0.21.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.20.0
+ * The version of the OpenAPI document: 0.21.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.20.0
+ * The version of the OpenAPI document: 0.21.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.20.0
+ * The version of the OpenAPI document: 0.21.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.20.0
+ * The version of the OpenAPI document: 0.21.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.20.0
+ * The version of the OpenAPI document: 0.21.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.20.0
+ * The version of the OpenAPI document: 0.21.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.20.0
+ * The version of the OpenAPI document: 0.21.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/SaveTermsRequest.md

@@ -0,0 +1,24 @@
+# SaveTermsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** |  | [default to undefined]
+**content** | **string** |  | [default to undefined]
+**enabled** | **boolean** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SaveTermsRequest } from '@teemill/platform';
+
+const instance: SaveTermsRequest = {
+    title,
+    content,
+    enabled,
+};
+```
+
+[[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/Terms.md

@@ -0,0 +1,32 @@
+# Terms
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**title** | **string** |  | [default to undefined]
+**content** | **string** |  | [default to undefined]
+**version** | **number** |  | [default to undefined]
+**enabled** | **boolean** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Terms } from '@teemill/platform';
+
+const instance: Terms = {
+    id,
+    title,
+    content,
+    version,
+    enabled,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[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/TermsApi.md

@@ -0,0 +1,127 @@
+# TermsApi
+
+All URIs are relative to *https://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getTerms**](#getterms) | **GET** /v1/platform/{platformId}/terms | Get the platform\'s terms|
+|[**saveTerms**](#saveterms) | **POST** /v1/platform/{platformId}/terms | Save the platform\'s terms|
+
+# **getTerms**
+> Terms getTerms()
+
+
+### Example
+
+```typescript
+import {
+    TermsApi,
+    Configuration
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new TermsApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+
+const { status, data } = await apiInstance.getTerms(
+    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
+
+**Terms**
+
+### 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 terms. |  -  |
+|**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)
+
+# **saveTerms**
+> Terms saveTerms(saveTermsRequest)
+
+
+### Example
+
+```typescript
+import {
+    TermsApi,
+    Configuration,
+    SaveTermsRequest
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new TermsApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+let saveTermsRequest: SaveTermsRequest; //Save terms
+
+const { status, data } = await apiInstance.saveTerms(
+    project,
+    platformId,
+    saveTermsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **saveTermsRequest** | **SaveTermsRequest**| Save terms | |
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+
+
+### Return type
+
+**Terms**
+
+### 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 terms. |  -  |
+|**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/index.ts

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.20.0
+ * The version of the OpenAPI document: 0.21.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.20.0",
+  "version": "0.21.0",
   "description": "OpenAPI client for @teemill/platform",
   "author": "OpenAPI-Generator Contributors",
   "repository": {