@teemill/platform 0.30.4 → 0.31.0

package/README.md

@@ -1,4 +1,4 @@
-## @teemill/platform@0.30.4
+## @teemill/platform@0.31.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.30.4 --save
+npm install @teemill/platform@0.31.0 --save
 ```
 
 _unPublished (not recommended):_
@@ -83,6 +83,7 @@ Class | Method | HTTP request | Description
 *PlatformApi* | [**listClientDomains**](docs/PlatformApi.md#listclientdomains) | **GET** /v1/platform/client/domains | List platform client domains
 *PlatformApi* | [**listDomains**](docs/PlatformApi.md#listdomains) | **GET** /v1/platform/domains | List platform domains
 *PlatformApi* | [**updatePlatform**](docs/PlatformApi.md#updateplatform) | **PATCH** /v1/platform | Update platform
+*ReviewsApi* | [**createReview**](docs/ReviewsApi.md#createreview) | **POST** /v1/platform/{platformId}/reviews | Create a review
 *ReviewsApi* | [**exportReviews**](docs/ReviewsApi.md#exportreviews) | **GET** /v1/platform/{platformId}/reviews/export | Export reviews
 *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
@@ -96,7 +97,10 @@ Class | Method | HTTP request | Description
  - [Address](docs/Address.md)
  - [AmendOrderRequest](docs/AmendOrderRequest.md)
  - [AmendOrderRequestAmendmentsInner](docs/AmendOrderRequestAmendmentsInner.md)
+ - [AmendmentLog](docs/AmendmentLog.md)
  - [ApiError](docs/ApiError.md)
+ - [BulkCreateReviewPayload](docs/BulkCreateReviewPayload.md)
+ - [BulkCreatedReviews](docs/BulkCreatedReviews.md)
  - [Client](docs/Client.md)
  - [ConfirmOrderFulfillment](docs/ConfirmOrderFulfillment.md)
  - [ConfirmOrderFulfillmentShipment](docs/ConfirmOrderFulfillmentShipment.md)
@@ -107,6 +111,10 @@ Class | Method | HTTP request | Description
  - [CreateDomainRequest](docs/CreateDomainRequest.md)
  - [CreateOrder](docs/CreateOrder.md)
  - [CreateOrderContactInformation](docs/CreateOrderContactInformation.md)
+ - [CreateReview201Response](docs/CreateReview201Response.md)
+ - [CreateReviewPayload](docs/CreateReviewPayload.md)
+ - [CreateReviewPayloadAuthor](docs/CreateReviewPayloadAuthor.md)
+ - [CreateReviewRequest](docs/CreateReviewRequest.md)
  - [Customer](docs/Customer.md)
  - [CustomersResponse](docs/CustomersResponse.md)
  - [CustomsInformation](docs/CustomsInformation.md)

package/api.ts

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.30.4
+ * The version of the OpenAPI document: 0.31.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -130,6 +130,57 @@ export const AmendOrderRequestAmendmentsInnerActionEnum = {
 
 export type AmendOrderRequestAmendmentsInnerActionEnum = typeof AmendOrderRequestAmendmentsInnerActionEnum[keyof typeof AmendOrderRequestAmendmentsInnerActionEnum];
 
+/**
+ * 
+ * @export
+ * @interface AmendmentLog
+ */
+export interface AmendmentLog {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof AmendmentLog
+     */
+    'id': string;
+    /**
+     * A reference to the order item that was amended.
+     * @type {string}
+     * @memberof AmendmentLog
+     */
+    'orderItemId': 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.
+     * @type {string}
+     * @memberof AmendmentLog
+     */
+    'originalOrderItemId': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AmendmentLog
+     */
+    'amendmentType': AmendmentLogAmendmentTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof AmendmentLog
+     */
+    'quantity': number;
+    /**
+     * ISO 8601 Timestamp
+     * @type {string}
+     * @memberof AmendmentLog
+     */
+    'createdAt': string;
+}
+
+export const AmendmentLogAmendmentTypeEnum = {
+    Refund: 'refund',
+    Exchange: 'exchange'
+} as const;
+
+export type AmendmentLogAmendmentTypeEnum = typeof AmendmentLogAmendmentTypeEnum[keyof typeof AmendmentLogAmendmentTypeEnum];
+
 /**
  * 
  * @export
@@ -149,6 +200,32 @@ export interface ApiError {
      */
     'message': string;
 }
+/**
+ * 
+ * @export
+ * @interface BulkCreateReviewPayload
+ */
+export interface BulkCreateReviewPayload {
+    /**
+     * 
+     * @type {Array<CreateReviewPayload>}
+     * @memberof BulkCreateReviewPayload
+     */
+    'reviews': Array<CreateReviewPayload>;
+}
+/**
+ * 
+ * @export
+ * @interface BulkCreatedReviews
+ */
+export interface BulkCreatedReviews {
+    /**
+     * 
+     * @type {Array<Review>}
+     * @memberof BulkCreatedReviews
+     */
+    'reviews': Array<Review>;
+}
 /**
  * 
  * @export
@@ -357,6 +434,92 @@ export interface CreateOrderContactInformation {
      */
     'phone'?: string | null;
 }
+/**
+ * @type CreateReview201Response
+ * @export
+ */
+export type CreateReview201Response = BulkCreatedReviews | Review;
+
+/**
+ * 
+ * @export
+ * @interface CreateReviewPayload
+ */
+export interface CreateReviewPayload {
+    /**
+     * 
+     * @type {CreateReviewPayloadAuthor}
+     * @memberof CreateReviewPayload
+     */
+    'author': CreateReviewPayloadAuthor;
+    /**
+     * The title of the review
+     * @type {string}
+     * @memberof CreateReviewPayload
+     */
+    'title'?: string;
+    /**
+     * The text of the review
+     * @type {string}
+     * @memberof CreateReviewPayload
+     */
+    'text': string;
+    /**
+     * A reference to the product being ordered
+     * @type {string}
+     * @memberof CreateReviewPayload
+     */
+    'productRef': string;
+    /**
+     * The rating of the review
+     * @type {number}
+     * @memberof CreateReviewPayload
+     */
+    'rating': number;
+    /**
+     * 
+     * @type {Array<Image>}
+     * @memberof CreateReviewPayload
+     */
+    'images'?: Array<Image>;
+    /**
+     * 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 CreateReviewPayload
+     */
+    'enabled': boolean;
+    /**
+     * A reference to the project being ordered
+     * @type {string}
+     * @memberof CreateReviewPayload
+     */
+    'projectRef': string;
+}
+/**
+ * 
+ * @export
+ * @interface CreateReviewPayloadAuthor
+ */
+export interface CreateReviewPayloadAuthor {
+    /**
+     * The name of the author
+     * @type {string}
+     * @memberof CreateReviewPayloadAuthor
+     */
+    'name'?: string;
+    /**
+     * The email of the author
+     * @type {string}
+     * @memberof CreateReviewPayloadAuthor
+     */
+    'email'?: string;
+}
+/**
+ * @type CreateReviewRequest
+ * @export
+ */
+export type CreateReviewRequest = BulkCreateReviewPayload | CreateReviewPayload;
+
 /**
  * The customer that has placed an order on your platform
  * @export
@@ -1193,6 +1356,12 @@ export interface OrderItem {
      * @memberof OrderItem
      */
     'recipientCost'?: Price;
+    /**
+     * 
+     * @type {Array<AmendmentLog>}
+     * @memberof OrderItem
+     */
+    'amendmentLogs'?: Array<AmendmentLog>;
 }
 /**
  * 
@@ -1612,7 +1781,7 @@ export interface Review {
      * @type {Array<ReviewReply>}
      * @memberof Review
      */
-    'replies'?: Array<ReviewReply>;
+    'replies'?: Array<ReviewReply> | null;
 }
 /**
  * 
@@ -2033,6 +2202,12 @@ export interface Variant {
      * @memberof Variant
      */
     'ref': string;
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof Variant
+     */
+    'productRef': string;
     /**
      * A reference to the resource location
      * @type {string}
@@ -6482,6 +6657,94 @@ export class PlatformApi extends BaseAPI {
  */
 export const ReviewsApiAxiosParamCreator = function (configuration?: 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: async (project: string, platformId: string, createReviewRequest: CreateReviewRequest, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // 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 = { 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;
+            }
+
+            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 as any instanceof Date) ?
+                    (start as any).toISOString() :
+                    start;
+            }
+
+            if (end !== undefined) {
+                localVarQueryParameter['end'] = (end as any instanceof Date) ?
+                    (end as any).toISOString() :
+                    end;
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...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
@@ -6746,6 +7009,27 @@ export const ReviewsApiAxiosParamCreator = function (configuration?: Configurati
 export const ReviewsApiFp = function(configuration?: 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}
+         */
+        async createReview(project: string, platformId: string, createReviewRequest: CreateReviewRequest, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateReview201Response>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createReview(project, platformId, createReviewRequest, pageToken, pageSize, search, sortBy, start, end, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ReviewsApi.createReview']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Export reviews as a CSV file.
          * @summary Export reviews
@@ -6823,6 +7107,16 @@ export const ReviewsApiFp = function(configuration?: Configuration) {
 export const ReviewsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = ReviewsApiFp(configuration)
     return {
+        /**
+         * 
+         * @summary Create a review
+         * @param {ReviewsApiCreateReviewRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createReview(requestParameters: ReviewsApiCreateReviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateReview201Response> {
+            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
@@ -6866,6 +7160,76 @@ export const ReviewsApiFactory = function (configuration?: Configuration, basePa
     };
 };
 
+/**
+ * Request parameters for createReview operation in ReviewsApi.
+ * @export
+ * @interface ReviewsApiCreateReviewRequest
+ */
+export interface ReviewsApiCreateReviewRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof ReviewsApiCreateReview
+     */
+    readonly project: string
+
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof ReviewsApiCreateReview
+     */
+    readonly platformId: string
+
+    /**
+     * 
+     * @type {CreateReviewRequest}
+     * @memberof ReviewsApiCreateReview
+     */
+    readonly createReviewRequest: CreateReviewRequest
+
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof ReviewsApiCreateReview
+     */
+    readonly pageToken?: number
+
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof ReviewsApiCreateReview
+     */
+    readonly pageSize?: number
+
+    /**
+     * Search term to filter results
+     * @type {string}
+     * @memberof ReviewsApiCreateReview
+     */
+    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 ReviewsApiCreateReview
+     */
+    readonly sortBy?: Array<string>
+
+    /**
+     * Start of date range to filter by
+     * @type {string}
+     * @memberof ReviewsApiCreateReview
+     */
+    readonly start?: string
+
+    /**
+     * End of date range to filter by
+     * @type {string}
+     * @memberof ReviewsApiCreateReview
+     */
+    readonly end?: string
+}
+
 /**
  * Request parameters for exportReviews operation in ReviewsApi.
  * @export
@@ -7034,6 +7398,18 @@ export interface ReviewsApiModerateReviewRequest {
  * @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
+     */
+    public createReview(requestParameters: ReviewsApiCreateReviewRequest, options?: RawAxiosRequestConfig) {
+        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/base.ts

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