@teemill/platform 0.30.5 → 0.32.0

package/dist/esm/api.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).
@@ -117,6 +117,54 @@ export declare const AmendOrderRequestAmendmentsInnerActionEnum: {
     readonly Exchange: "exchange";
 };
 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 declare const AmendmentLogAmendmentTypeEnum: {
+    readonly Refund: "refund";
+    readonly Exchange: "exchange";
+};
+export type AmendmentLogAmendmentTypeEnum = typeof AmendmentLogAmendmentTypeEnum[keyof typeof AmendmentLogAmendmentTypeEnum];
 /**
  *
  * @export
@@ -136,6 +184,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
@@ -344,6 +418,90 @@ 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
@@ -447,6 +605,51 @@ export declare const CustomsInformationPreRegistrationTypeEnum: {
     readonly Ioss: "IOSS";
 };
 export type CustomsInformationPreRegistrationTypeEnum = typeof CustomsInformationPreRegistrationTypeEnum[keyof typeof CustomsInformationPreRegistrationTypeEnum];
+/**
+ *
+ * @export
+ * @interface DashboardItem
+ */
+export interface DashboardItem {
+    /**
+     *
+     * @type {string}
+     * @memberof DashboardItem
+     */
+    'id': string;
+    /**
+     *
+     * @type {string}
+     * @memberof DashboardItem
+     */
+    'type': string;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof DashboardItem
+     */
+    'properties': {
+        [key: string]: any;
+    } | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof DashboardItem
+     */
+    'published': boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof DashboardItem
+     */
+    'sortOrder': number;
+    /**
+     *
+     * @type {Array<DashboardItem>}
+     * @memberof DashboardItem
+     */
+    'items'?: Array<DashboardItem> | null;
+}
 /**
  *
  * @export
@@ -774,6 +977,19 @@ export interface FulfillmentItem {
      */
     'quantity'?: number;
 }
+/**
+ *
+ * @export
+ * @interface GetDashboardResponse
+ */
+export interface GetDashboardResponse {
+    /**
+     *
+     * @type {Array<DashboardItem>}
+     * @memberof GetDashboardResponse
+     */
+    'items'?: Array<DashboardItem>;
+}
 /**
  * Image description
  * @export
@@ -1169,6 +1385,12 @@ export interface OrderItem {
      * @memberof OrderItem
      */
     'recipientCost'?: Price;
+    /**
+     *
+     * @type {Array<AmendmentLog>}
+     * @memberof OrderItem
+     */
+    'amendmentLogs'?: Array<AmendmentLog>;
 }
 /**
  *
@@ -1581,7 +1803,7 @@ export interface Review {
      * @type {Array<ReviewReply>}
      * @memberof Review
      */
-    'replies'?: Array<ReviewReply>;
+    'replies'?: Array<ReviewReply> | null;
 }
 /**
  *
@@ -1703,6 +1925,19 @@ export interface ReviewsResponse {
      */
     'nextPageToken'?: number | null;
 }
+/**
+ *
+ * @export
+ * @interface SaveDashboardRequest
+ */
+export interface SaveDashboardRequest {
+    /**
+     *
+     * @type {Array<DashboardItem>}
+     * @memberof SaveDashboardRequest
+     */
+    'items'?: Array<DashboardItem>;
+}
 /**
  *
  * @export
@@ -2505,6 +2740,148 @@ export declare const ListCustomersGenderEnum: {
     readonly Female: "female";
 };
 export type ListCustomersGenderEnum = typeof ListCustomersGenderEnum[keyof typeof ListCustomersGenderEnum];
+/**
+ * DashboardApi - axios parameter creator
+ * @export
+ */
+export declare const DashboardApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @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: string, platformId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @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: string, platformId: string, saveDashboardRequest: SaveDashboardRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * DashboardApi - functional programming interface
+ * @export
+ */
+export declare const DashboardApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @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: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDashboardResponse>>;
+    /**
+     *
+     * @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: string, platformId: string, saveDashboardRequest: SaveDashboardRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDashboardResponse>>;
+};
+/**
+ * DashboardApi - factory interface
+ * @export
+ */
+export declare const DashboardApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Get the platform\'s dashboard
+     * @param {DashboardApiGetDashboardRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDashboard(requestParameters: DashboardApiGetDashboardRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDashboardResponse>;
+    /**
+     *
+     * @summary Save the platform\'s dashboard
+     * @param {DashboardApiSaveDashboardRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    saveDashboard(requestParameters: DashboardApiSaveDashboardRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDashboardResponse>;
+};
+/**
+ * Request parameters for getDashboard operation in DashboardApi.
+ * @export
+ * @interface DashboardApiGetDashboardRequest
+ */
+export interface DashboardApiGetDashboardRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof DashboardApiGetDashboard
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof DashboardApiGetDashboard
+     */
+    readonly platformId: string;
+}
+/**
+ * Request parameters for saveDashboard operation in DashboardApi.
+ * @export
+ * @interface DashboardApiSaveDashboardRequest
+ */
+export interface DashboardApiSaveDashboardRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof DashboardApiSaveDashboard
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof DashboardApiSaveDashboard
+     */
+    readonly platformId: string;
+    /**
+     * Save dashboard
+     * @type {SaveDashboardRequest}
+     * @memberof DashboardApiSaveDashboard
+     */
+    readonly saveDashboardRequest: SaveDashboardRequest;
+}
+/**
+ * DashboardApi - object-oriented interface
+ * @export
+ * @class DashboardApi
+ * @extends {BaseAPI}
+ */
+export declare 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: DashboardApiGetDashboardRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDashboardResponse, any>>;
+    /**
+     *
+     * @summary Save the platform\'s dashboard
+     * @param {DashboardApiSaveDashboardRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardApi
+     */
+    saveDashboard(requestParameters: DashboardApiSaveDashboardRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDashboardResponse, any>>;
+}
 /**
  * EnquiriesApi - axios parameter creator
  * @export
@@ -4429,6 +4806,22 @@ export declare class PlatformApi extends BaseAPI {
  * @export
  */
 export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @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: string, platformId: string, createReviewRequest: CreateReviewRequest, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Export reviews as a CSV file.
      * @summary Export reviews
@@ -4482,6 +4875,22 @@ export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration
  * @export
  */
 export declare const ReviewsApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @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: 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>>;
     /**
      * Export reviews as a CSV file.
      * @summary Export reviews
@@ -4535,6 +4944,14 @@ export declare const ReviewsApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const ReviewsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Create a review
+     * @param {ReviewsApiCreateReviewRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createReview(requestParameters: ReviewsApiCreateReviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateReview201Response>;
     /**
      * Export reviews as a CSV file.
      * @summary Export reviews
@@ -4568,6 +4985,67 @@ export declare const ReviewsApiFactory: (configuration?: Configuration, basePath
      */
     moderateReview(requestParameters: ReviewsApiModerateReviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<Review>;
 };
+/**
+ * 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
@@ -4717,6 +5195,15 @@ export interface ReviewsApiModerateReviewRequest {
  * @extends {BaseAPI}
  */
 export declare 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: ReviewsApiCreateReviewRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateReview201Response, any>>;
     /**
      * Export reviews as a CSV file.
      * @summary Export reviews