@teemill/website 0.19.1 → 0.21.0

package/dist/esm/api.d.ts

@@ -2,7 +2,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.19.1
+ * The version of the OpenAPI document: 0.21.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -264,6 +264,19 @@ export interface BlogsResponse {
      */
     'nextPageToken'?: number | null;
 }
+/**
+ *
+ * @export
+ * @interface Brand
+ */
+export interface Brand {
+    /**
+     * The URL of the favicon
+     * @type {string}
+     * @memberof Brand
+     */
+    'favicon'?: string;
+}
 /**
  *
  * @export
@@ -376,6 +389,50 @@ export interface ExportPages202Response {
      */
     'message'?: string;
 }
+/**
+ *
+ * @export
+ * @interface Footer
+ */
+export interface Footer {
+    /**
+     *
+     * @type {Array<FooterItem>}
+     * @memberof Footer
+     */
+    'items'?: Array<FooterItem>;
+}
+/**
+ *
+ * @export
+ * @interface FooterItem
+ */
+export interface FooterItem {
+    /**
+     *
+     * @type {string}
+     * @memberof FooterItem
+     */
+    'id'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FooterItem
+     */
+    'text'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FooterItem
+     */
+    'link'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof FooterItem
+     */
+    'order'?: number;
+}
 /**
  * Image description
  * @export
@@ -594,6 +651,13 @@ export interface Page {
      * @memberof Page
      */
     'id'?: string;
+    /**
+     * The legacy ID of the page
+     * @type {number}
+     * @memberof Page
+     * @deprecated
+     */
+    'legacyId'?: number;
     /**
      *
      * @type {string}
@@ -943,6 +1007,12 @@ export interface Review {
      * @memberof Review
      */
     'text': string;
+    /**
+     *
+     * @type {ReviewProduct}
+     * @memberof Review
+     */
+    'product'?: ReviewProduct;
     /**
      *
      * @type {ReviewAuthor}
@@ -1024,6 +1094,25 @@ export interface 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
@@ -1205,6 +1294,12 @@ export interface SeoOptimiseCollectionsRequest {
      * @memberof SeoOptimiseCollectionsRequest
      */
     'ids'?: Array<string>;
+    /**
+     * If provided, only the specified fields will be updated.
+     * @type {Array<string>}
+     * @memberof SeoOptimiseCollectionsRequest
+     */
+    'fields'?: Array<string>;
 }
 /**
  *
@@ -1231,6 +1326,12 @@ export interface SeoOptimisePagesRequest {
      * @memberof SeoOptimisePagesRequest
      */
     'ids'?: Array<string>;
+    /**
+     * If provided, only the specified fields will be updated.
+     * @type {Array<string>}
+     * @memberof SeoOptimisePagesRequest
+     */
+    'fields'?: Array<string>;
 }
 /**
  *
@@ -1646,6 +1747,19 @@ export interface UpdateBlogsRequestBlogsInnerSeoMetadata {
      */
     'description'?: string | null;
 }
+/**
+ *
+ * @export
+ * @interface UpdateBrandRequest
+ */
+export interface UpdateBrandRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateBrandRequest
+     */
+    'favicon'?: string;
+}
 /**
  *
  * @export
@@ -1782,6 +1896,44 @@ export interface UpdateCollectionsRequestCollectionsInnerSeoMetadata {
      */
     'description'?: string | null;
 }
+/**
+ *
+ * @export
+ * @interface UpdateFooterRequest
+ */
+export interface UpdateFooterRequest {
+    /**
+     *
+     * @type {Array<UpdateFooterRequestItemsInner>}
+     * @memberof UpdateFooterRequest
+     */
+    'items': Array<UpdateFooterRequestItemsInner>;
+}
+/**
+ *
+ * @export
+ * @interface UpdateFooterRequestItemsInner
+ */
+export interface UpdateFooterRequestItemsInner {
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateFooterRequestItemsInner
+     */
+    'text': string;
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateFooterRequestItemsInner
+     */
+    'link': string;
+    /**
+     *
+     * @type {number}
+     * @memberof UpdateFooterRequestItemsInner
+     */
+    'order': number;
+}
 /**
  *
  * @export
@@ -3246,6 +3398,258 @@ export declare class CrossSellApi extends BaseAPI {
      */
     getCrossSellProducts(requestParameters: CrossSellApiGetCrossSellProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product[], any>>;
 }
+/**
+ * DefaultApi - axios parameter creator
+ * @export
+ */
+export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Get the brand for the project
+     * @summary Get brand
+     * @param {string} project What project it is
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBrand: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update the brand for the project
+     * @summary Update brand
+     * @param {string} project What project it is
+     * @param {UpdateBrandRequest} [updateBrandRequest] Update brand request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateBrand: (project: string, updateBrandRequest?: UpdateBrandRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * DefaultApi - functional programming interface
+ * @export
+ */
+export declare const DefaultApiFp: (configuration?: Configuration) => {
+    /**
+     * Get the brand for the project
+     * @summary Get brand
+     * @param {string} project What project it is
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBrand(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Brand>>;
+    /**
+     * Update the brand for the project
+     * @summary Update brand
+     * @param {string} project What project it is
+     * @param {UpdateBrandRequest} [updateBrandRequest] Update brand request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateBrand(project: string, updateBrandRequest?: UpdateBrandRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Brand>>;
+};
+/**
+ * DefaultApi - factory interface
+ * @export
+ */
+export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Get the brand for the project
+     * @summary Get brand
+     * @param {DefaultApiGetBrandRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBrand(requestParameters: DefaultApiGetBrandRequest, options?: RawAxiosRequestConfig): AxiosPromise<Brand>;
+    /**
+     * Update the brand for the project
+     * @summary Update brand
+     * @param {DefaultApiUpdateBrandRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateBrand(requestParameters: DefaultApiUpdateBrandRequest, options?: RawAxiosRequestConfig): AxiosPromise<Brand>;
+};
+/**
+ * Request parameters for getBrand operation in DefaultApi.
+ * @export
+ * @interface DefaultApiGetBrandRequest
+ */
+export interface DefaultApiGetBrandRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof DefaultApiGetBrand
+     */
+    readonly project: string;
+}
+/**
+ * Request parameters for updateBrand operation in DefaultApi.
+ * @export
+ * @interface DefaultApiUpdateBrandRequest
+ */
+export interface DefaultApiUpdateBrandRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof DefaultApiUpdateBrand
+     */
+    readonly project: string;
+    /**
+     * Update brand request
+     * @type {UpdateBrandRequest}
+     * @memberof DefaultApiUpdateBrand
+     */
+    readonly updateBrandRequest?: UpdateBrandRequest;
+}
+/**
+ * DefaultApi - object-oriented interface
+ * @export
+ * @class DefaultApi
+ * @extends {BaseAPI}
+ */
+export declare class DefaultApi extends BaseAPI {
+    /**
+     * Get the brand for the project
+     * @summary Get brand
+     * @param {DefaultApiGetBrandRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    getBrand(requestParameters: DefaultApiGetBrandRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Brand, any>>;
+    /**
+     * Update the brand for the project
+     * @summary Update brand
+     * @param {DefaultApiUpdateBrandRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    updateBrand(requestParameters: DefaultApiUpdateBrandRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Brand, any>>;
+}
+/**
+ * FooterApi - axios parameter creator
+ * @export
+ */
+export declare const FooterApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Get the footer for the project
+     * @summary Get footer
+     * @param {string} project What project it is
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFooter: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update a footer
+     * @summary Update footer
+     * @param {string} project What project it is
+     * @param {UpdateFooterRequest} [updateFooterRequest] Update footer
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateFooter: (project: string, updateFooterRequest?: UpdateFooterRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * FooterApi - functional programming interface
+ * @export
+ */
+export declare const FooterApiFp: (configuration?: Configuration) => {
+    /**
+     * Get the footer for the project
+     * @summary Get footer
+     * @param {string} project What project it is
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFooter(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Footer>>>;
+    /**
+     * Update a footer
+     * @summary Update footer
+     * @param {string} project What project it is
+     * @param {UpdateFooterRequest} [updateFooterRequest] Update footer
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateFooter(project: string, updateFooterRequest?: UpdateFooterRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Footer>>>;
+};
+/**
+ * FooterApi - factory interface
+ * @export
+ */
+export declare const FooterApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Get the footer for the project
+     * @summary Get footer
+     * @param {FooterApiGetFooterRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFooter(requestParameters: FooterApiGetFooterRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Footer>>;
+    /**
+     * Update a footer
+     * @summary Update footer
+     * @param {FooterApiUpdateFooterRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateFooter(requestParameters: FooterApiUpdateFooterRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Footer>>;
+};
+/**
+ * Request parameters for getFooter operation in FooterApi.
+ * @export
+ * @interface FooterApiGetFooterRequest
+ */
+export interface FooterApiGetFooterRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof FooterApiGetFooter
+     */
+    readonly project: string;
+}
+/**
+ * Request parameters for updateFooter operation in FooterApi.
+ * @export
+ * @interface FooterApiUpdateFooterRequest
+ */
+export interface FooterApiUpdateFooterRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof FooterApiUpdateFooter
+     */
+    readonly project: string;
+    /**
+     * Update footer
+     * @type {UpdateFooterRequest}
+     * @memberof FooterApiUpdateFooter
+     */
+    readonly updateFooterRequest?: UpdateFooterRequest;
+}
+/**
+ * FooterApi - object-oriented interface
+ * @export
+ * @class FooterApi
+ * @extends {BaseAPI}
+ */
+export declare class FooterApi extends BaseAPI {
+    /**
+     * Get the footer for the project
+     * @summary Get footer
+     * @param {FooterApiGetFooterRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FooterApi
+     */
+    getFooter(requestParameters: FooterApiGetFooterRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Footer[], any>>;
+    /**
+     * Update a footer
+     * @summary Update footer
+     * @param {FooterApiUpdateFooterRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FooterApi
+     */
+    updateFooter(requestParameters: FooterApiUpdateFooterRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Footer[], any>>;
+}
 /**
  * MenuApi - axios parameter creator
  * @export
@@ -3931,6 +4335,16 @@ export declare class PaymentApi extends BaseAPI {
  * @export
  */
 export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Export reviews as a CSV file.
+     * @summary Export reviews
+     * @param {string} project What project it is
+     * @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, start?: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Get review
@@ -3948,10 +4362,12 @@ export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration
      * @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, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    listReviews: (project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Moderate review
@@ -3968,6 +4384,16 @@ export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration
  * @export
  */
 export declare const ReviewsApiFp: (configuration?: Configuration) => {
+    /**
+     * Export reviews as a CSV file.
+     * @summary Export reviews
+     * @param {string} project What project it is
+     * @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, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
     /**
      *
      * @summary Get review
@@ -3985,10 +4411,12 @@ export declare const ReviewsApiFp: (configuration?: Configuration) => {
      * @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, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReviewsResponse>>;
+    listReviews(project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReviewsResponse>>;
     /**
      *
      * @summary Moderate review
@@ -4005,6 +4433,14 @@ export declare const ReviewsApiFp: (configuration?: Configuration) => {
  * @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>;
     /**
      *
      * @summary Get review
@@ -4030,6 +4466,31 @@ export declare const ReviewsApiFactory: (configuration?: Configuration, basePath
      */
     moderateReview(requestParameters: ReviewsApiModerateReviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<Review>;
 };
+/**
+ * Request parameters for exportReviews operation in ReviewsApi.
+ * @export
+ * @interface ReviewsApiExportReviewsRequest
+ */
+export interface ReviewsApiExportReviewsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof ReviewsApiExportReviews
+     */
+    readonly project: 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
@@ -4085,6 +4546,18 @@ export interface ReviewsApiListReviewsRequest {
      * @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.
@@ -4118,6 +4591,15 @@ export interface ReviewsApiModerateReviewRequest {
  * @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>>;
     /**
      *
      * @summary Get review