@teemill/platform 0.20.0 → 0.21.0

package/README.md

@@ -1,4 +1,4 @@
-## @teemill/platform@0.20.0
+## @teemill/platform@0.21.0
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @teemill/platform@0.20.0 --save
+npm install @teemill/platform@0.21.0 --save
 ```
 
 _unPublished (not recommended):_
@@ -73,6 +73,8 @@ Class | Method | HTTP request | Description
 *ReviewsApi* | [**getReview**](docs/ReviewsApi.md#getreview) | **GET** /v1/platform/{platformId}/reviews/{reviewId} | Get review
 *ReviewsApi* | [**listReviews**](docs/ReviewsApi.md#listreviews) | **GET** /v1/platform/{platformId}/reviews | List reviews
 *ReviewsApi* | [**moderateReview**](docs/ReviewsApi.md#moderatereview) | **PATCH** /v1/platform/{platformId}/reviews/{reviewId}/moderate | Moderate review
+*TermsApi* | [**getTerms**](docs/TermsApi.md#getterms) | **GET** /v1/platform/{platformId}/terms | Get the platform\'s terms
+*TermsApi* | [**saveTerms**](docs/TermsApi.md#saveterms) | **POST** /v1/platform/{platformId}/terms | Save the platform\'s terms
 
 
 ### Documentation For Models
@@ -121,9 +123,11 @@ Class | Method | HTTP request | Description
  - [ReviewReply](docs/ReviewReply.md)
  - [ReviewReplyAuthor](docs/ReviewReplyAuthor.md)
  - [ReviewsResponse](docs/ReviewsResponse.md)
+ - [SaveTermsRequest](docs/SaveTermsRequest.md)
  - [ShippingMethod](docs/ShippingMethod.md)
  - [Statistics](docs/Statistics.md)
  - [StatusHistoryItem](docs/StatusHistoryItem.md)
+ - [Terms](docs/Terms.md)
  - [UpdateFulfillmentRequest](docs/UpdateFulfillmentRequest.md)
  - [UpdatePlatformRequest](docs/UpdatePlatformRequest.md)
  - [ValidationError](docs/ValidationError.md)

package/api.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).
@@ -1374,6 +1374,31 @@ export interface ReviewsResponse {
      */
     'nextPageToken'?: number | null;
 }
+/**
+ * 
+ * @export
+ * @interface SaveTermsRequest
+ */
+export interface SaveTermsRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof SaveTermsRequest
+     */
+    'title': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SaveTermsRequest
+     */
+    'content': string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SaveTermsRequest
+     */
+    'enabled': boolean;
+}
 /**
  * 
  * @export
@@ -1475,6 +1500,55 @@ export interface StatusHistoryItem {
 }
 
 
+/**
+ * 
+ * @export
+ * @interface Terms
+ */
+export interface Terms {
+    /**
+     * 
+     * @type {string}
+     * @memberof Terms
+     */
+    'id': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Terms
+     */
+    'title': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Terms
+     */
+    'content': string;
+    /**
+     * 
+     * @type {number}
+     * @memberof Terms
+     */
+    'version': number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Terms
+     */
+    'enabled': boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof Terms
+     */
+    'createdAt': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Terms
+     */
+    'updatedAt': string;
+}
 /**
  * 
  * @export
@@ -4736,3 +4810,266 @@ export class ReviewsApi extends BaseAPI {
 
 
 
+/**
+ * TermsApi - axios parameter creator
+ * @export
+ */
+export const TermsApiAxiosParamCreator = function (configuration?: 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: async (project: string, platformId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // 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 = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication session-oauth required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
+
+            // authentication api-key required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...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: async (project: string, platformId: string, saveTermsRequest: SaveTermsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // 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 = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication session-oauth required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
+
+            // authentication api-key required
+            await 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 = {...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?: 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}
+         */
+        async getTerms(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Terms>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getTerms(project, platformId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['TermsApi.getTerms']?.[localVarOperationServerIndex]?.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}
+         */
+        async saveTerms(project: string, platformId: string, saveTermsRequest: SaveTermsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Terms>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.saveTerms(project, platformId, saveTermsRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['TermsApi.saveTerms']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * TermsApi - factory interface
+ * @export
+ */
+export const TermsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    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: TermsApiGetTermsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Terms> {
+            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: TermsApiSaveTermsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Terms> {
+            return localVarFp.saveTerms(requestParameters.project, requestParameters.platformId, requestParameters.saveTermsRequest, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for getTerms operation in TermsApi.
+ * @export
+ * @interface TermsApiGetTermsRequest
+ */
+export interface TermsApiGetTermsRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof TermsApiGetTerms
+     */
+    readonly project: string
+
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof TermsApiGetTerms
+     */
+    readonly platformId: string
+}
+
+/**
+ * Request parameters for saveTerms operation in TermsApi.
+ * @export
+ * @interface TermsApiSaveTermsRequest
+ */
+export interface TermsApiSaveTermsRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof TermsApiSaveTerms
+     */
+    readonly project: string
+
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof TermsApiSaveTerms
+     */
+    readonly platformId: string
+
+    /**
+     * Save terms
+     * @type {SaveTermsRequest}
+     * @memberof TermsApiSaveTerms
+     */
+    readonly saveTermsRequest: SaveTermsRequest
+}
+
+/**
+ * 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
+     */
+    public getTerms(requestParameters: TermsApiGetTermsRequest, options?: RawAxiosRequestConfig) {
+        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
+     */
+    public saveTerms(requestParameters: TermsApiSaveTermsRequest, options?: RawAxiosRequestConfig) {
+        return TermsApiFp(this.configuration).saveTerms(requestParameters.project, requestParameters.platformId, requestParameters.saveTermsRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+
+
+

package/base.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/common.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/configuration.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/dist/api.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).
@@ -1349,6 +1349,31 @@ export interface ReviewsResponse {
      */
     'nextPageToken'?: number | null;
 }
+/**
+ *
+ * @export
+ * @interface SaveTermsRequest
+ */
+export interface SaveTermsRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof SaveTermsRequest
+     */
+    'title': string;
+    /**
+     *
+     * @type {string}
+     * @memberof SaveTermsRequest
+     */
+    'content': string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SaveTermsRequest
+     */
+    'enabled': boolean;
+}
 /**
  *
  * @export
@@ -1448,6 +1473,55 @@ export interface StatusHistoryItem {
      */
     'createdAt'?: string;
 }
+/**
+ *
+ * @export
+ * @interface Terms
+ */
+export interface Terms {
+    /**
+     *
+     * @type {string}
+     * @memberof Terms
+     */
+    'id': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Terms
+     */
+    'title': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Terms
+     */
+    'content': string;
+    /**
+     *
+     * @type {number}
+     * @memberof Terms
+     */
+    'version': number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Terms
+     */
+    'enabled': boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof Terms
+     */
+    'createdAt': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Terms
+     */
+    'updatedAt': string;
+}
 /**
  *
  * @export
@@ -3269,3 +3343,145 @@ export declare class ReviewsApi extends BaseAPI {
      */
     moderateReview(requestParameters: ReviewsApiModerateReviewRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Review, any>>;
 }
+/**
+ * TermsApi - axios parameter creator
+ * @export
+ */
+export declare const TermsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @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: string, platformId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @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: string, platformId: string, saveTermsRequest: SaveTermsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * TermsApi - functional programming interface
+ * @export
+ */
+export declare const TermsApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @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: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Terms>>;
+    /**
+     *
+     * @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: string, platformId: string, saveTermsRequest: SaveTermsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Terms>>;
+};
+/**
+ * TermsApi - factory interface
+ * @export
+ */
+export declare const TermsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Get the platform\'s terms
+     * @param {TermsApiGetTermsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTerms(requestParameters: TermsApiGetTermsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Terms>;
+    /**
+     *
+     * @summary Save the platform\'s terms
+     * @param {TermsApiSaveTermsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    saveTerms(requestParameters: TermsApiSaveTermsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Terms>;
+};
+/**
+ * Request parameters for getTerms operation in TermsApi.
+ * @export
+ * @interface TermsApiGetTermsRequest
+ */
+export interface TermsApiGetTermsRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof TermsApiGetTerms
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof TermsApiGetTerms
+     */
+    readonly platformId: string;
+}
+/**
+ * Request parameters for saveTerms operation in TermsApi.
+ * @export
+ * @interface TermsApiSaveTermsRequest
+ */
+export interface TermsApiSaveTermsRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof TermsApiSaveTerms
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof TermsApiSaveTerms
+     */
+    readonly platformId: string;
+    /**
+     * Save terms
+     * @type {SaveTermsRequest}
+     * @memberof TermsApiSaveTerms
+     */
+    readonly saveTermsRequest: SaveTermsRequest;
+}
+/**
+ * TermsApi - object-oriented interface
+ * @export
+ * @class TermsApi
+ * @extends {BaseAPI}
+ */
+export declare 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: TermsApiGetTermsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Terms, any>>;
+    /**
+     *
+     * @summary Save the platform\'s terms
+     * @param {TermsApiSaveTermsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TermsApi
+     */
+    saveTerms(requestParameters: TermsApiSaveTermsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Terms, any>>;
+}