@teemill/platform 0.30.5 → 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.30.5
+ * The version of the OpenAPI document: 0.32.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -30,6 +30,10 @@ export const AmendOrderRequestAmendmentsInnerActionEnum = {
     Refund: 'refund',
     Exchange: 'exchange'
 };
+export const AmendmentLogAmendmentTypeEnum = {
+    Refund: 'refund',
+    Exchange: 'exchange'
+};
 export const CustomsInformationPreRegistrationTypeEnum = {
     Ioss: 'IOSS'
 };
@@ -540,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
@@ -3121,6 +3321,79 @@ export class PlatformApi extends BaseAPI {
  */
 export const ReviewsApiAxiosParamCreator = function (configuration) {
     return {
+        /**
+         *
+         * @summary Create a review
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {CreateReviewRequest} createReviewRequest
+         * @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 {string} [start] Start of date range to filter by
+         * @param {string} [end] End of date range to filter by
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createReview: (project_1, platformId_1, createReviewRequest_1, pageToken_1, pageSize_1, search_1, sortBy_1, start_1, end_1, ...args_1) => __awaiter(this, [project_1, platformId_1, createReviewRequest_1, pageToken_1, pageSize_1, search_1, sortBy_1, start_1, end_1, ...args_1], void 0, function* (project, platformId, createReviewRequest, pageToken, pageSize, search, sortBy, start, end, options = {}) {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('createReview', 'project', project);
+            // verify required parameter 'platformId' is not null or undefined
+            assertParamExists('createReview', 'platformId', platformId);
+            // verify required parameter 'createReviewRequest' is not null or undefined
+            assertParamExists('createReview', 'createReviewRequest', createReviewRequest);
+            const localVarPath = `/v1/platform/{platformId}/reviews`
+                .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;
+            }
+            if (pageToken !== undefined) {
+                localVarQueryParameter['pageToken'] = pageToken;
+            }
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+            if (sortBy) {
+                localVarQueryParameter['sortBy'] = sortBy;
+            }
+            if (start !== undefined) {
+                localVarQueryParameter['start'] = (start instanceof Date) ?
+                    start.toISOString() :
+                    start;
+            }
+            if (end !== undefined) {
+                localVarQueryParameter['end'] = (end instanceof Date) ?
+                    end.toISOString() :
+                    end;
+            }
+            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(createReviewRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Export reviews as a CSV file.
          * @summary Export reviews
@@ -3343,6 +3616,30 @@ export const ReviewsApiAxiosParamCreator = function (configuration) {
 export const ReviewsApiFp = function (configuration) {
     const localVarAxiosParamCreator = ReviewsApiAxiosParamCreator(configuration);
     return {
+        /**
+         *
+         * @summary Create a review
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {CreateReviewRequest} createReviewRequest
+         * @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 {string} [start] Start of date range to filter by
+         * @param {string} [end] End of date range to filter by
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createReview(project, platformId, createReviewRequest, pageToken, pageSize, search, sortBy, start, end, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.createReview(project, platformId, createReviewRequest, pageToken, pageSize, search, sortBy, start, end, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReviewsApi.createReview']) === 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);
+            });
+        },
         /**
          * Export reviews as a CSV file.
          * @summary Export reviews
@@ -3431,6 +3728,16 @@ export const ReviewsApiFp = function (configuration) {
 export const ReviewsApiFactory = function (configuration, basePath, axios) {
     const localVarFp = ReviewsApiFp(configuration);
     return {
+        /**
+         *
+         * @summary Create a review
+         * @param {ReviewsApiCreateReviewRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createReview(requestParameters, options) {
+            return localVarFp.createReview(requestParameters.project, requestParameters.platformId, requestParameters.createReviewRequest, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
+        },
         /**
          * Export reviews as a CSV file.
          * @summary Export reviews
@@ -3480,6 +3787,17 @@ export const ReviewsApiFactory = function (configuration, basePath, axios) {
  * @extends {BaseAPI}
  */
 export class ReviewsApi extends BaseAPI {
+    /**
+     *
+     * @summary Create a review
+     * @param {ReviewsApiCreateReviewRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReviewsApi
+     */
+    createReview(requestParameters, options) {
+        return ReviewsApiFp(this.configuration).createReview(requestParameters.project, requestParameters.platformId, requestParameters.createReviewRequest, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Export reviews as a CSV file.
      * @summary Export reviews

package/dist/esm/base.d.ts

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

package/docs/AmendmentLog.md

@@ -0,0 +1,30 @@
+# AmendmentLog
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**orderItemId** | **string** | A reference to the order item that was amended. | [default to undefined]
+**originalOrderItemId** | **string** | A reference to the top level order item that was amended, useful for finding the original item within a chain of exchanges, for example. | [default to undefined]
+**amendmentType** | **string** |  | [default to undefined]
+**quantity** | **number** |  | [default to undefined]
+**createdAt** | **string** | ISO 8601 Timestamp | [default to undefined]
+
+## Example
+
+```typescript
+import { AmendmentLog } from '@teemill/platform';
+
+const instance: AmendmentLog = {
+    id,
+    orderItemId,
+    originalOrderItemId,
+    amendmentType,
+    quantity,
+    createdAt,
+};
+```
+
+[[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/BulkCreateReviewPayload.md

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

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

@@ -0,0 +1,42 @@
+# CreateReview201Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**text** | **string** | Text content of the review | [default to undefined]
+**product** | [**ReviewProduct**](ReviewProduct.md) |  | [optional] [default to undefined]
+**author** | [**ReviewAuthor**](ReviewAuthor.md) |  | [optional] [default to undefined]
+**rating** | **number** | Rating of the review | [optional] [default to undefined]
+**sentiment** | **number** | Google\'s sentiment analysis score | [optional] [default to undefined]
+**enabled** | **boolean** | Whether the review has been approved or not. If the review is not enabled, it will not be visible to the public. | [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**project** | [**Project**](Project.md) |  | [default to undefined]
+**images** | [**Array<ReviewImagesInner>**](ReviewImagesInner.md) |  | [optional] [default to undefined]
+**replies** | [**Array<ReviewReply>**](ReviewReply.md) |  | [optional] [default to undefined]
+**reviews** | [**Array<Review>**](Review.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateReview201Response } from '@teemill/platform';
+
+const instance: CreateReview201Response = {
+    id,
+    text,
+    product,
+    author,
+    rating,
+    sentiment,
+    enabled,
+    createdAt,
+    project,
+    images,
+    replies,
+    reviews,
+};
+```
+
+[[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/CreateReviewPayload.md

@@ -0,0 +1,34 @@
+# CreateReviewPayload
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**author** | [**CreateReviewPayloadAuthor**](CreateReviewPayloadAuthor.md) |  | [default to undefined]
+**title** | **string** | The title of the review | [optional] [default to undefined]
+**text** | **string** | The text of the review | [default to undefined]
+**productRef** | **string** | A reference to the product being ordered | [default to undefined]
+**rating** | **number** | The rating of the review | [default to undefined]
+**images** | [**Array<Image>**](Image.md) |  | [optional] [default to undefined]
+**enabled** | **boolean** | Whether the review has been approved or not. If the review is not enabled, it will not be visible to the public. | [default to false]
+**projectRef** | **string** | A reference to the project being ordered | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateReviewPayload } from '@teemill/platform';
+
+const instance: CreateReviewPayload = {
+    author,
+    title,
+    text,
+    productRef,
+    rating,
+    images,
+    enabled,
+    projectRef,
+};
+```
+
+[[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/CreateReviewPayloadAuthor.md

@@ -0,0 +1,22 @@
+# CreateReviewPayloadAuthor
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | The name of the author | [optional] [default to undefined]
+**email** | **string** | The email of the author | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateReviewPayloadAuthor } from '@teemill/platform';
+
+const instance: CreateReviewPayloadAuthor = {
+    name,
+    email,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)