@teemill/platform 0.15.0 → 0.16.0

package/dist/esm/api.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.15.0
+ * The version of the OpenAPI document: 0.16.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -387,6 +387,19 @@ export interface Image {
      */
     'sortOrder'?: number;
 }
+/**
+ *
+ * @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
@@ -834,6 +847,199 @@ export interface Project {
      */
     'name': 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 {ReviewProduct}
+     * @memberof Review
+     */
+    'product'?: ReviewProduct;
+    /**
+     *
+     * @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 {Project}
+     * @memberof Review
+     */
+    'project': Project;
+    /**
+     *
+     * @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;
+}
+/**
+ * The product that the review is for
+ * @export
+ * @interface ReviewProduct
+ */
+export interface ReviewProduct {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof ReviewProduct
+     */
+    'id'?: string;
+    /**
+     * The title of the product
+     * @type {string}
+     * @memberof ReviewProduct
+     */
+    'title'?: 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
@@ -1069,7 +1275,7 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
      * @param {string} platformId The platform identifier
      * @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 based on order reference, customer name and email
+     * @param {string} [search] Search term to filter results
      * @param {Array<ListCustomersSortByEnum>} [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 {number} [totalOrderCount] Filter customers by total order count equal to the value provided
      * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
@@ -1116,7 +1322,7 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
      * @param {string} platformId The platform identifier
      * @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 based on order reference, customer name and email
+     * @param {string} [search] Search term to filter results
      * @param {Array<ListCustomersSortByEnum>} [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 {number} [totalOrderCount] Filter customers by total order count equal to the value provided
      * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
@@ -1262,7 +1468,7 @@ export interface CustomersApiListCustomersRequest {
      */
     readonly pageSize?: number;
     /**
-     * Search term to filter based on order reference, customer name and email
+     * Search term to filter results
      * @type {string}
      * @memberof CustomersApiListCustomers
      */
@@ -2118,3 +2324,333 @@ export declare class PlatformApi extends BaseAPI {
      */
     updatePlatform(requestParameters: PlatformApiUpdatePlatformRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Platform, any>>;
 }
+/**
+ * ReviewsApi - axios parameter creator
+ * @export
+ */
+export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Export reviews as a CSV file.
+     * @summary Export reviews
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @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}
+     */
+    exportReviews: (project: string, platformId: string, start: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a review left on a platform by a given review ID.
+     * @summary Get review
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} reviewId The review identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getReview: (project: string, platformId: string, reviewId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List reviews left on projects belonging to this platform, paginated into configurable chunks.
+     * @summary List reviews
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @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}
+     */
+    listReviews: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Moderate a review left on a platform.
+     * @summary Moderate review
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} reviewId The review identifier
+     * @param {ModerateReviewRequest} [moderateReviewRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    moderateReview: (project: string, platformId: string, reviewId: string, moderateReviewRequest?: ModerateReviewRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ReviewsApi - functional programming interface
+ * @export
+ */
+export declare const ReviewsApiFp: (configuration?: Configuration) => {
+    /**
+     * Export reviews as a CSV file.
+     * @summary Export reviews
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @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}
+     */
+    exportReviews(project: string, platformId: string, start: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    /**
+     * Get a review left on a platform by a given review ID.
+     * @summary Get review
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} reviewId The review identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getReview(project: string, platformId: string, reviewId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Review>>;
+    /**
+     * List reviews left on projects belonging to this platform, paginated into configurable chunks.
+     * @summary List reviews
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @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}
+     */
+    listReviews(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReviewsResponse>>;
+    /**
+     * Moderate a review left on a platform.
+     * @summary Moderate review
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} reviewId The review identifier
+     * @param {ModerateReviewRequest} [moderateReviewRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    moderateReview(project: string, platformId: string, reviewId: string, moderateReviewRequest?: ModerateReviewRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Review>>;
+};
+/**
+ * ReviewsApi - factory interface
+ * @export
+ */
+export declare const ReviewsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Export reviews as a CSV file.
+     * @summary Export reviews
+     * @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportReviews(requestParameters: ReviewsApiExportReviewsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
+    /**
+     * Get a review left on a platform by a given review ID.
+     * @summary Get review
+     * @param {ReviewsApiGetReviewRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getReview(requestParameters: ReviewsApiGetReviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<Review>;
+    /**
+     * List reviews left on projects belonging to this platform, paginated into configurable chunks.
+     * @summary List reviews
+     * @param {ReviewsApiListReviewsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listReviews(requestParameters: ReviewsApiListReviewsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReviewsResponse>;
+    /**
+     * Moderate a review left on a platform.
+     * @summary Moderate review
+     * @param {ReviewsApiModerateReviewRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    moderateReview(requestParameters: ReviewsApiModerateReviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<Review>;
+};
+/**
+ * Request parameters for exportReviews operation in ReviewsApi.
+ * @export
+ * @interface ReviewsApiExportReviewsRequest
+ */
+export interface ReviewsApiExportReviewsRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof ReviewsApiExportReviews
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof ReviewsApiExportReviews
+     */
+    readonly platformId: string;
+    /**
+     * Start of date range to filter by
+     * @type {string}
+     * @memberof ReviewsApiExportReviews
+     */
+    readonly start: string;
+    /**
+     * End of date range to filter by
+     * @type {string}
+     * @memberof ReviewsApiExportReviews
+     */
+    readonly end?: string;
+}
+/**
+ * Request parameters for getReview operation in ReviewsApi.
+ * @export
+ * @interface ReviewsApiGetReviewRequest
+ */
+export interface ReviewsApiGetReviewRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof ReviewsApiGetReview
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof ReviewsApiGetReview
+     */
+    readonly platformId: string;
+    /**
+     * The review identifier
+     * @type {string}
+     * @memberof ReviewsApiGetReview
+     */
+    readonly reviewId: string;
+}
+/**
+ * Request parameters for listReviews operation in ReviewsApi.
+ * @export
+ * @interface ReviewsApiListReviewsRequest
+ */
+export interface ReviewsApiListReviewsRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof ReviewsApiListReviews
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof ReviewsApiListReviews
+     */
+    readonly platformId: 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>;
+    /**
+     * Start of date range to filter by
+     * @type {string}
+     * @memberof ReviewsApiListReviews
+     */
+    readonly start?: string;
+    /**
+     * End of date range to filter by
+     * @type {string}
+     * @memberof ReviewsApiListReviews
+     */
+    readonly end?: string;
+}
+/**
+ * Request parameters for moderateReview operation in ReviewsApi.
+ * @export
+ * @interface ReviewsApiModerateReviewRequest
+ */
+export interface ReviewsApiModerateReviewRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof ReviewsApiModerateReview
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof ReviewsApiModerateReview
+     */
+    readonly platformId: string;
+    /**
+     * The review 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 declare class ReviewsApi extends BaseAPI {
+    /**
+     * Export reviews as a CSV file.
+     * @summary Export reviews
+     * @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReviewsApi
+     */
+    exportReviews(requestParameters: ReviewsApiExportReviewsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
+    /**
+     * Get a review left on a platform by a given review ID.
+     * @summary Get review
+     * @param {ReviewsApiGetReviewRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReviewsApi
+     */
+    getReview(requestParameters: ReviewsApiGetReviewRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Review, any>>;
+    /**
+     * List reviews left on projects belonging to this platform, paginated into configurable chunks.
+     * @summary List reviews
+     * @param {ReviewsApiListReviewsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReviewsApi
+     */
+    listReviews(requestParameters: ReviewsApiListReviewsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReviewsResponse, any>>;
+    /**
+     * Moderate a review left on a platform.
+     * @summary Moderate review
+     * @param {ReviewsApiModerateReviewRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReviewsApi
+     */
+    moderateReview(requestParameters: ReviewsApiModerateReviewRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Review, any>>;
+}