@teemill/website 0.16.0 → 0.18.0

package/README.md

@@ -1,4 +1,4 @@
-## @teemill/website@0.16.0
+## @teemill/website@0.18.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/website@0.16.0 --save
+npm install @teemill/website@0.18.0 --save
 ```
 
 _unPublished (not recommended):_

package/api.ts

@@ -4,7 +4,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.16.0
+ * The version of the OpenAPI document: 0.18.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -380,6 +380,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
@@ -491,6 +504,18 @@ export interface MenuItem {
      * @memberof MenuItem
      */
     'link': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MenuItem
+     */
+    'color': string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof MenuItem
+     */
+    'backgroundColor': string | null;
     /**
      * 
      * @type {number}
@@ -1319,6 +1344,18 @@ export interface SubmenuItem {
      * @memberof SubmenuItem
      */
     'link': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SubmenuItem
+     */
+    'color': string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SubmenuItem
+     */
+    'backgroundColor': string | null;
     /**
      * 
      * @type {number}
@@ -1642,6 +1679,18 @@ export interface UpdateMenuRequestItem {
      * @memberof UpdateMenuRequestItem
      */
     'link': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateMenuRequestItem
+     */
+    'color'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateMenuRequestItem
+     */
+    'backgroundColor'?: string | null;
     /**
      * 
      * @type {number}
@@ -1898,6 +1947,18 @@ export interface UpdateMenuRequestSubmenuItem {
      * @memberof UpdateMenuRequestSubmenuItem
      */
     'link': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateMenuRequestSubmenuItem
+     */
+    'color'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateMenuRequestSubmenuItem
+     */
+    'backgroundColor'?: string | null;
     /**
      * 
      * @type {number}
@@ -2195,6 +2256,50 @@ export interface Video {
  */
 export const BlogsApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
+        /**
+         * 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: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('exportBlogs', 'project', project)
+            const localVarPath = `/v1/website/blogs/export`;
+            // 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: 'GET', ...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;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * 
          * @summary Get website blog post
@@ -2427,6 +2532,19 @@ export const BlogsApiAxiosParamCreator = function (configuration?: Configuration
 export const BlogsApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = BlogsApiAxiosParamCreator(configuration)
     return {
+        /**
+         * Export blogs as a CSV file.
+         * @summary Export blogs
+         * @param {string} project What project it is
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async exportBlogs(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.exportBlogs(project, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['BlogsApi.exportBlogs']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @summary Get website blog post
@@ -2499,6 +2617,16 @@ export const BlogsApiFp = function(configuration?: Configuration) {
 export const BlogsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = BlogsApiFp(configuration)
     return {
+        /**
+         * 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> {
+            return localVarFp.exportBlogs(requestParameters.project, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary Get website blog post
@@ -2542,6 +2670,20 @@ export const BlogsApiFactory = function (configuration?: Configuration, basePath
     };
 };
 
+/**
+ * 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
@@ -2675,6 +2817,18 @@ export interface BlogsApiUpdateBlogsRequest {
  * @extends {BaseAPI}
  */
 export 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
+     */
+    public exportBlogs(requestParameters: BlogsApiExportBlogsRequest, options?: RawAxiosRequestConfig) {
+        return BlogsApiFp(this.configuration).exportBlogs(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary Get website blog post
@@ -2732,6 +2886,50 @@ export class BlogsApi extends BaseAPI {
  */
 export const CollectionsApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
+        /**
+         * 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: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('exportCollections', 'project', project)
+            const localVarPath = `/v1/website/collections/export`;
+            // 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: 'GET', ...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;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * 
          * @summary Get website collection
@@ -2841,7 +3039,7 @@ export const CollectionsApiAxiosParamCreator = function (configuration?: Configu
         },
         /**
          * 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.
@@ -3012,6 +3210,19 @@ export const CollectionsApiAxiosParamCreator = function (configuration?: Configu
 export const CollectionsApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = CollectionsApiAxiosParamCreator(configuration)
     return {
+        /**
+         * Export collections as a CSV file.
+         * @summary Export collections
+         * @param {string} project What project it is
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async exportCollections(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.exportCollections(project, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['CollectionsApi.exportCollections']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @summary Get website collection
@@ -3044,7 +3255,7 @@ export const CollectionsApiFp = function(configuration?: Configuration) {
         },
         /**
          * 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.
@@ -3098,6 +3309,16 @@ export const CollectionsApiFp = function(configuration?: Configuration) {
 export const CollectionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = CollectionsApiFp(configuration)
     return {
+        /**
+         * 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> {
+            return localVarFp.exportCollections(requestParameters.project, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary Get website collection
@@ -3120,7 +3341,7 @@ export const CollectionsApiFactory = function (configuration?: Configuration, ba
         },
         /**
          * 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}
@@ -3151,6 +3372,20 @@ export const CollectionsApiFactory = function (configuration?: Configuration, ba
     };
 };
 
+/**
+ * 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
@@ -3305,6 +3540,18 @@ export interface CollectionsApiUpdateCollectionsRequest {
  * @extends {BaseAPI}
  */
 export 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
+     */
+    public exportCollections(requestParameters: CollectionsApiExportCollectionsRequest, options?: RawAxiosRequestConfig) {
+        return CollectionsApiFp(this.configuration).exportCollections(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary Get website collection
@@ -3331,7 +3578,7 @@ export class CollectionsApi extends BaseAPI {
 
     /**
      * 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}
@@ -3872,6 +4119,50 @@ export class MenuApi extends BaseAPI {
  */
 export const PagesApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
+        /**
+         * 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: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('exportPages', 'project', project)
+            const localVarPath = `/v1/website/pages/export`;
+            // 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: 'GET', ...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;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * 
          * @summary Get website page
@@ -3981,7 +4272,7 @@ export const PagesApiAxiosParamCreator = function (configuration?: Configuration
         },
         /**
          * 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.
@@ -4152,6 +4443,19 @@ export const PagesApiAxiosParamCreator = function (configuration?: Configuration
 export const PagesApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = PagesApiAxiosParamCreator(configuration)
     return {
+        /**
+         * Export pages as a CSV file.
+         * @summary Export pages
+         * @param {string} project What project it is
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async exportPages(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.exportPages(project, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['PagesApi.exportPages']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @summary Get website page
@@ -4184,7 +4488,7 @@ export const PagesApiFp = function(configuration?: Configuration) {
         },
         /**
          * 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.
@@ -4238,6 +4542,16 @@ export const PagesApiFp = function(configuration?: Configuration) {
 export const PagesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = PagesApiFp(configuration)
     return {
+        /**
+         * 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> {
+            return localVarFp.exportPages(requestParameters.project, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary Get website page
@@ -4260,7 +4574,7 @@ export const PagesApiFactory = function (configuration?: Configuration, basePath
         },
         /**
          * 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}
@@ -4291,6 +4605,20 @@ export const PagesApiFactory = function (configuration?: Configuration, basePath
     };
 };
 
+/**
+ * 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
@@ -4445,6 +4773,18 @@ export interface PagesApiUpdatePagesRequest {
  * @extends {BaseAPI}
  */
 export 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
+     */
+    public exportPages(requestParameters: PagesApiExportPagesRequest, options?: RawAxiosRequestConfig) {
+        return PagesApiFp(this.configuration).exportPages(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary Get website page
@@ -4471,7 +4811,7 @@ export class PagesApi extends BaseAPI {
 
     /**
      * 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}

package/base.ts

@@ -4,7 +4,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.16.0
+ * The version of the OpenAPI document: 0.18.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/common.ts

@@ -4,7 +4,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.16.0
+ * The version of the OpenAPI document: 0.18.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/configuration.ts

@@ -4,7 +4,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.16.0
+ * The version of the OpenAPI document: 0.18.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).