@teemill/website 0.17.0 → 0.18.0

package/dist/esm/api.d.ts

@@ -2,7 +2,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.17.0
+ * The version of the OpenAPI document: 0.18.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -363,6 +363,19 @@ export interface CreateSearchRedirectRequest {
      */
     'destinationUrl': string;
 }
+/**
+ *
+ * @export
+ * @interface ExportPages202Response
+ */
+export interface ExportPages202Response {
+    /**
+     * A message describing the export status
+     * @type {string}
+     * @memberof ExportPages202Response
+     */
+    'message'?: string;
+}
 /**
  * Image description
  * @export
@@ -2195,6 +2208,14 @@ export interface Video {
  * @export
  */
 export declare const BlogsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Export blogs as a CSV file.
+     * @summary Export blogs
+     * @param {string} project What project it is
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportBlogs: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Get website blog post
@@ -2243,6 +2264,14 @@ export declare const BlogsApiAxiosParamCreator: (configuration?: Configuration)
  * @export
  */
 export declare const BlogsApiFp: (configuration?: Configuration) => {
+    /**
+     * Export blogs as a CSV file.
+     * @summary Export blogs
+     * @param {string} project What project it is
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportBlogs(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
     /**
      *
      * @summary Get website blog post
@@ -2291,6 +2320,14 @@ export declare const BlogsApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const BlogsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Export blogs as a CSV file.
+     * @summary Export blogs
+     * @param {BlogsApiExportBlogsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportBlogs(requestParameters: BlogsApiExportBlogsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
     /**
      *
      * @summary Get website blog post
@@ -2324,6 +2361,19 @@ export declare const BlogsApiFactory: (configuration?: Configuration, basePath?:
      */
     updateBlogs(requestParameters: BlogsApiUpdateBlogsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BlogsResponse>;
 };
+/**
+ * Request parameters for exportBlogs operation in BlogsApi.
+ * @export
+ * @interface BlogsApiExportBlogsRequest
+ */
+export interface BlogsApiExportBlogsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof BlogsApiExportBlogs
+     */
+    readonly project: string;
+}
 /**
  * Request parameters for getBlog operation in BlogsApi.
  * @export
@@ -2443,6 +2493,15 @@ export interface BlogsApiUpdateBlogsRequest {
  * @extends {BaseAPI}
  */
 export declare class BlogsApi extends BaseAPI {
+    /**
+     * Export blogs as a CSV file.
+     * @summary Export blogs
+     * @param {BlogsApiExportBlogsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BlogsApi
+     */
+    exportBlogs(requestParameters: BlogsApiExportBlogsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
     /**
      *
      * @summary Get website blog post
@@ -2485,6 +2544,14 @@ export declare class BlogsApi extends BaseAPI {
  * @export
  */
 export declare const CollectionsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Export collections as a CSV file.
+     * @summary Export collections
+     * @param {string} project What project it is
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportCollections: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Get website collection
@@ -2507,7 +2574,7 @@ export declare const CollectionsApiAxiosParamCreator: (configuration?: Configura
     listCollections: (project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * AI SEO optimises collections by a set of given IDs.
-     * @summary AI SEO optimise collections.
+     * @summary AI SEO optimise collections
      * @param {string} project What project it is
      * @param {SeoOptimiseCollectionsRequest} [seoOptimiseCollectionsRequest] A set of collection IDs to AI SEO optimise.
      * @param {*} [options] Override http request option.
@@ -2542,6 +2609,14 @@ export declare const CollectionsApiAxiosParamCreator: (configuration?: Configura
  * @export
  */
 export declare const CollectionsApiFp: (configuration?: Configuration) => {
+    /**
+     * Export collections as a CSV file.
+     * @summary Export collections
+     * @param {string} project What project it is
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportCollections(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
     /**
      *
      * @summary Get website collection
@@ -2564,7 +2639,7 @@ export declare const CollectionsApiFp: (configuration?: Configuration) => {
     listCollections(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollectionsResponse>>;
     /**
      * AI SEO optimises collections by a set of given IDs.
-     * @summary AI SEO optimise collections.
+     * @summary AI SEO optimise collections
      * @param {string} project What project it is
      * @param {SeoOptimiseCollectionsRequest} [seoOptimiseCollectionsRequest] A set of collection IDs to AI SEO optimise.
      * @param {*} [options] Override http request option.
@@ -2599,6 +2674,14 @@ export declare const CollectionsApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const CollectionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Export collections as a CSV file.
+     * @summary Export collections
+     * @param {CollectionsApiExportCollectionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportCollections(requestParameters: CollectionsApiExportCollectionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
     /**
      *
      * @summary Get website collection
@@ -2617,7 +2700,7 @@ export declare const CollectionsApiFactory: (configuration?: Configuration, base
     listCollections(requestParameters: CollectionsApiListCollectionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<CollectionsResponse>;
     /**
      * AI SEO optimises collections by a set of given IDs.
-     * @summary AI SEO optimise collections.
+     * @summary AI SEO optimise collections
      * @param {CollectionsApiSeoOptimiseCollectionsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -2640,6 +2723,19 @@ export declare const CollectionsApiFactory: (configuration?: Configuration, base
      */
     updateCollections(requestParameters: CollectionsApiUpdateCollectionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<CollectionsResponse>;
 };
+/**
+ * Request parameters for exportCollections operation in CollectionsApi.
+ * @export
+ * @interface CollectionsApiExportCollectionsRequest
+ */
+export interface CollectionsApiExportCollectionsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof CollectionsApiExportCollections
+     */
+    readonly project: string;
+}
 /**
  * Request parameters for getCollection operation in CollectionsApi.
  * @export
@@ -2778,6 +2874,15 @@ export interface CollectionsApiUpdateCollectionsRequest {
  * @extends {BaseAPI}
  */
 export declare class CollectionsApi extends BaseAPI {
+    /**
+     * Export collections as a CSV file.
+     * @summary Export collections
+     * @param {CollectionsApiExportCollectionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionsApi
+     */
+    exportCollections(requestParameters: CollectionsApiExportCollectionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
     /**
      *
      * @summary Get website collection
@@ -2798,7 +2903,7 @@ export declare class CollectionsApi extends BaseAPI {
     listCollections(requestParameters: CollectionsApiListCollectionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CollectionsResponse, any>>;
     /**
      * AI SEO optimises collections by a set of given IDs.
-     * @summary AI SEO optimise collections.
+     * @summary AI SEO optimise collections
      * @param {CollectionsApiSeoOptimiseCollectionsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -3097,6 +3202,14 @@ export declare class MenuApi extends BaseAPI {
  * @export
  */
 export declare const PagesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Export pages as a CSV file.
+     * @summary Export pages
+     * @param {string} project What project it is
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportPages: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Get website page
@@ -3119,7 +3232,7 @@ export declare const PagesApiAxiosParamCreator: (configuration?: Configuration)
     listPages: (project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * AI SEO optimises pages by a set of given IDs.
-     * @summary AI SEO optimise pages.
+     * @summary AI SEO optimise pages
      * @param {string} project What project it is
      * @param {SeoOptimisePagesRequest} [seoOptimisePagesRequest] A set of page IDs to AI SEO optimise.
      * @param {*} [options] Override http request option.
@@ -3154,6 +3267,14 @@ export declare const PagesApiAxiosParamCreator: (configuration?: Configuration)
  * @export
  */
 export declare const PagesApiFp: (configuration?: Configuration) => {
+    /**
+     * Export pages as a CSV file.
+     * @summary Export pages
+     * @param {string} project What project it is
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportPages(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
     /**
      *
      * @summary Get website page
@@ -3176,7 +3297,7 @@ export declare const PagesApiFp: (configuration?: Configuration) => {
     listPages(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PagesResponse>>;
     /**
      * AI SEO optimises pages by a set of given IDs.
-     * @summary AI SEO optimise pages.
+     * @summary AI SEO optimise pages
      * @param {string} project What project it is
      * @param {SeoOptimisePagesRequest} [seoOptimisePagesRequest] A set of page IDs to AI SEO optimise.
      * @param {*} [options] Override http request option.
@@ -3211,6 +3332,14 @@ export declare const PagesApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const PagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Export pages as a CSV file.
+     * @summary Export pages
+     * @param {PagesApiExportPagesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportPages(requestParameters: PagesApiExportPagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
     /**
      *
      * @summary Get website page
@@ -3229,7 +3358,7 @@ export declare const PagesApiFactory: (configuration?: Configuration, basePath?:
     listPages(requestParameters: PagesApiListPagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<PagesResponse>;
     /**
      * AI SEO optimises pages by a set of given IDs.
-     * @summary AI SEO optimise pages.
+     * @summary AI SEO optimise pages
      * @param {PagesApiSeoOptimisePagesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -3252,6 +3381,19 @@ export declare const PagesApiFactory: (configuration?: Configuration, basePath?:
      */
     updatePages(requestParameters: PagesApiUpdatePagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<PagesResponse>;
 };
+/**
+ * Request parameters for exportPages operation in PagesApi.
+ * @export
+ * @interface PagesApiExportPagesRequest
+ */
+export interface PagesApiExportPagesRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof PagesApiExportPages
+     */
+    readonly project: string;
+}
 /**
  * Request parameters for getPage operation in PagesApi.
  * @export
@@ -3390,6 +3532,15 @@ export interface PagesApiUpdatePagesRequest {
  * @extends {BaseAPI}
  */
 export declare class PagesApi extends BaseAPI {
+    /**
+     * Export pages as a CSV file.
+     * @summary Export pages
+     * @param {PagesApiExportPagesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PagesApi
+     */
+    exportPages(requestParameters: PagesApiExportPagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
     /**
      *
      * @summary Get website page
@@ -3410,7 +3561,7 @@ export declare class PagesApi extends BaseAPI {
     listPages(requestParameters: PagesApiListPagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PagesResponse, any>>;
     /**
      * AI SEO optimises pages by a set of given IDs.
-     * @summary AI SEO optimise pages.
+     * @summary AI SEO optimise pages
      * @param {PagesApiSeoOptimisePagesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}