@teemill/website 0.18.0 → 0.19.1

package/README.md

@@ -1,4 +1,4 @@
-## @teemill/website@0.18.0
+## @teemill/website@0.19.1
 
 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/website@0.18.0 --save
+npm install @teemill/website@0.19.1 --save
 ```
 
 _unPublished (not recommended):_

package/api.ts

@@ -4,7 +4,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.18.0
+ * The version of the OpenAPI document: 0.19.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -567,6 +567,19 @@ export interface MetaImage {
      */
     'alt'?: string;
 }
+/**
+ * 
+ * @export
+ * @interface ModerateReviewRequest
+ */
+export interface ModerateReviewRequest {
+    /**
+     * Whether the review has been approved or not. If the review is not enabled, it will not be visible to the public.
+     * @type {boolean}
+     * @memberof ModerateReviewRequest
+     */
+    'enabled'?: boolean;
+}
 /**
  * 
  * @export
@@ -933,6 +946,168 @@ export interface ProductWarehouseProduct {
      */
     'gfnProductRef'?: string;
 }
+/**
+ * 
+ * @export
+ * @interface Review
+ */
+export interface Review {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof Review
+     */
+    'id': string;
+    /**
+     * Text content of the review
+     * @type {string}
+     * @memberof Review
+     */
+    'text': string;
+    /**
+     * 
+     * @type {ReviewAuthor}
+     * @memberof Review
+     */
+    'author'?: ReviewAuthor;
+    /**
+     * Rating of the review
+     * @type {number}
+     * @memberof Review
+     */
+    'rating'?: number;
+    /**
+     * Google\'s sentiment analysis score
+     * @type {number}
+     * @memberof Review
+     */
+    'sentiment'?: number;
+    /**
+     * Whether the review has been approved or not. If the review is not enabled, it will not be visible to the public.
+     * @type {boolean}
+     * @memberof Review
+     */
+    'enabled': boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof Review
+     */
+    'createdAt'?: string;
+    /**
+     * 
+     * @type {Array<ReviewImagesInner>}
+     * @memberof Review
+     */
+    'images'?: Array<ReviewImagesInner>;
+    /**
+     * 
+     * @type {Array<ReviewReply>}
+     * @memberof Review
+     */
+    'replies'?: Array<ReviewReply>;
+}
+/**
+ * 
+ * @export
+ * @interface ReviewAuthor
+ */
+export interface ReviewAuthor {
+    /**
+     * Name of the review\'s author
+     * @type {string}
+     * @memberof ReviewAuthor
+     */
+    'name'?: string;
+    /**
+     * Email of the review\'s author
+     * @type {string}
+     * @memberof ReviewAuthor
+     */
+    'email'?: string;
+}
+/**
+ * 
+ * @export
+ * @interface ReviewImagesInner
+ */
+export interface ReviewImagesInner {
+    /**
+     * URL of the image
+     * @type {string}
+     * @memberof ReviewImagesInner
+     */
+    'src'?: string;
+    /**
+     * Alternative text for the image
+     * @type {string}
+     * @memberof ReviewImagesInner
+     */
+    'alt'?: string;
+}
+/**
+ * 
+ * @export
+ * @interface ReviewReply
+ */
+export interface ReviewReply {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof ReviewReply
+     */
+    'id': string;
+    /**
+     * Text content of the reply
+     * @type {string}
+     * @memberof ReviewReply
+     */
+    'text': string;
+    /**
+     * 
+     * @type {ReviewReplyAuthor}
+     * @memberof ReviewReply
+     */
+    'author'?: ReviewReplyAuthor;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReviewReply
+     */
+    'createdAt'?: string;
+}
+/**
+ * 
+ * @export
+ * @interface ReviewReplyAuthor
+ */
+export interface ReviewReplyAuthor {
+    /**
+     * Name of the reply\'s author
+     * @type {string}
+     * @memberof ReviewReplyAuthor
+     */
+    'name'?: string;
+}
+/**
+ * 
+ * @export
+ * @interface ReviewsResponse
+ */
+export interface ReviewsResponse {
+    /**
+     * 
+     * @type {Array<Review>}
+     * @memberof ReviewsResponse
+     */
+    'reviews'?: Array<Review>;
+    /**
+     * The token referencing the next page number
+     * @type {number}
+     * @memberof ReviewsResponse
+     */
+    'nextPageToken'?: number | null;
+}
 /**
  * 
  * @export
@@ -5166,6 +5341,412 @@ export class PaymentApi extends BaseAPI {
 
 
 
+/**
+ * ReviewsApi - axios parameter creator
+ * @export
+ */
+export const ReviewsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 
+         * @summary Get review
+         * @param {string} project What project it is
+         * @param {string} reviewId Review\&#39;s unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getReview: async (project: string, reviewId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('getReview', 'project', project)
+            // verify required parameter 'reviewId' is not null or undefined
+            assertParamExists('getReview', 'reviewId', reviewId)
+            const localVarPath = `/v1/website/reviews/{reviewId}`
+                .replace(`{${"reviewId"}}`, encodeURIComponent(String(reviewId)));
+            // 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 List Reviews
+         * @param {string} project What project it is
+         * @param {number} [pageToken] Page reference token
+         * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+         * @param {string} [search] Search term to filter results
+         * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listReviews: async (project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('listReviews', 'project', project)
+            const localVarPath = `/v1/website/reviews`;
+            // 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;
+            }
+
+            if (pageToken !== undefined) {
+                localVarQueryParameter['pageToken'] = pageToken;
+            }
+
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+
+            if (sortBy) {
+                localVarQueryParameter['sortBy'] = sortBy;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Moderate review
+         * @param {string} project What project it is
+         * @param {string} reviewId Review\&#39;s unique identifier
+         * @param {ModerateReviewRequest} [moderateReviewRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        moderateReview: async (project: string, reviewId: string, moderateReviewRequest?: ModerateReviewRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('moderateReview', 'project', project)
+            // verify required parameter 'reviewId' is not null or undefined
+            assertParamExists('moderateReview', 'reviewId', reviewId)
+            const localVarPath = `/v1/website/reviews/{reviewId}/moderate`
+                .replace(`{${"reviewId"}}`, encodeURIComponent(String(reviewId)));
+            // 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: 'PATCH', ...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(moderateReviewRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * ReviewsApi - functional programming interface
+ * @export
+ */
+export const ReviewsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = ReviewsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 
+         * @summary Get review
+         * @param {string} project What project it is
+         * @param {string} reviewId Review\&#39;s unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getReview(project: string, reviewId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Review>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getReview(project, reviewId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ReviewsApi.getReview']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary List Reviews
+         * @param {string} project What project it is
+         * @param {number} [pageToken] Page reference token
+         * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+         * @param {string} [search] Search term to filter results
+         * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listReviews(project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReviewsResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listReviews(project, pageToken, pageSize, search, sortBy, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ReviewsApi.listReviews']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary Moderate review
+         * @param {string} project What project it is
+         * @param {string} reviewId Review\&#39;s unique identifier
+         * @param {ModerateReviewRequest} [moderateReviewRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async moderateReview(project: string, reviewId: string, moderateReviewRequest?: ModerateReviewRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Review>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.moderateReview(project, reviewId, moderateReviewRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ReviewsApi.moderateReview']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * ReviewsApi - factory interface
+ * @export
+ */
+export const ReviewsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = ReviewsApiFp(configuration)
+    return {
+        /**
+         * 
+         * @summary Get review
+         * @param {ReviewsApiGetReviewRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getReview(requestParameters: ReviewsApiGetReviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<Review> {
+            return localVarFp.getReview(requestParameters.project, requestParameters.reviewId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary List Reviews
+         * @param {ReviewsApiListReviewsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listReviews(requestParameters: ReviewsApiListReviewsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReviewsResponse> {
+            return localVarFp.listReviews(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary Moderate review
+         * @param {ReviewsApiModerateReviewRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        moderateReview(requestParameters: ReviewsApiModerateReviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<Review> {
+            return localVarFp.moderateReview(requestParameters.project, requestParameters.reviewId, requestParameters.moderateReviewRequest, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for getReview operation in ReviewsApi.
+ * @export
+ * @interface ReviewsApiGetReviewRequest
+ */
+export interface ReviewsApiGetReviewRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof ReviewsApiGetReview
+     */
+    readonly project: string
+
+    /**
+     * Review\&#39;s unique identifier
+     * @type {string}
+     * @memberof ReviewsApiGetReview
+     */
+    readonly reviewId: string
+}
+
+/**
+ * Request parameters for listReviews operation in ReviewsApi.
+ * @export
+ * @interface ReviewsApiListReviewsRequest
+ */
+export interface ReviewsApiListReviewsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof ReviewsApiListReviews
+     */
+    readonly project: string
+
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof ReviewsApiListReviews
+     */
+    readonly pageToken?: number
+
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof ReviewsApiListReviews
+     */
+    readonly pageSize?: number
+
+    /**
+     * Search term to filter results
+     * @type {string}
+     * @memberof ReviewsApiListReviews
+     */
+    readonly search?: string
+
+    /**
+     * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
+     * @type {Array<string>}
+     * @memberof ReviewsApiListReviews
+     */
+    readonly sortBy?: Array<string>
+}
+
+/**
+ * Request parameters for moderateReview operation in ReviewsApi.
+ * @export
+ * @interface ReviewsApiModerateReviewRequest
+ */
+export interface ReviewsApiModerateReviewRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof ReviewsApiModerateReview
+     */
+    readonly project: string
+
+    /**
+     * Review\&#39;s unique identifier
+     * @type {string}
+     * @memberof ReviewsApiModerateReview
+     */
+    readonly reviewId: string
+
+    /**
+     * 
+     * @type {ModerateReviewRequest}
+     * @memberof ReviewsApiModerateReview
+     */
+    readonly moderateReviewRequest?: ModerateReviewRequest
+}
+
+/**
+ * ReviewsApi - object-oriented interface
+ * @export
+ * @class ReviewsApi
+ * @extends {BaseAPI}
+ */
+export class ReviewsApi extends BaseAPI {
+    /**
+     * 
+     * @summary Get review
+     * @param {ReviewsApiGetReviewRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReviewsApi
+     */
+    public getReview(requestParameters: ReviewsApiGetReviewRequest, options?: RawAxiosRequestConfig) {
+        return ReviewsApiFp(this.configuration).getReview(requestParameters.project, requestParameters.reviewId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary List Reviews
+     * @param {ReviewsApiListReviewsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReviewsApi
+     */
+    public listReviews(requestParameters: ReviewsApiListReviewsRequest, options?: RawAxiosRequestConfig) {
+        return ReviewsApiFp(this.configuration).listReviews(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary Moderate review
+     * @param {ReviewsApiModerateReviewRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReviewsApi
+     */
+    public moderateReview(requestParameters: ReviewsApiModerateReviewRequest, options?: RawAxiosRequestConfig) {
+        return ReviewsApiFp(this.configuration).moderateReview(requestParameters.project, requestParameters.reviewId, requestParameters.moderateReviewRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+
+
+
 /**
  * RoutesApi - axios parameter creator
  * @export

package/base.ts

@@ -4,7 +4,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.18.0
+ * The version of the OpenAPI document: 0.19.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/common.ts

@@ -4,7 +4,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.18.0
+ * The version of the OpenAPI document: 0.19.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/configuration.ts

@@ -4,7 +4,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.18.0
+ * The version of the OpenAPI document: 0.19.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).