@teemill/website 0.14.0 → 0.16.0

package/README.md

@@ -1,4 +1,4 @@
-## @teemill/website@0.14.0
+## @teemill/website@0.16.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.14.0 --save
+npm install @teemill/website@0.16.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.14.0
+ * The version of the OpenAPI document: 0.16.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -249,6 +249,18 @@ export interface Blog {
      * @memberof Blog
      */
     'targetSearchPhraseData'?: TargetSearchPhraseData;
+    /**
+     * 
+     * @type {MetaImage}
+     * @memberof Blog
+     */
+    'metaImage'?: MetaImage;
+    /**
+     * 
+     * @type {string}
+     * @memberof Blog
+     */
+    'publishedAt'?: string | null;
 }
 /**
  * 
@@ -299,6 +311,12 @@ export interface Collection {
      * @memberof Collection
      */
     'slug'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Collection
+     */
+    'longDescription'?: string;
     /**
      * 
      * @type {SeoMetadata}
@@ -311,6 +329,18 @@ export interface Collection {
      * @memberof Collection
      */
     'targetSearchPhraseData'?: TargetSearchPhraseData;
+    /**
+     * History of AI optimisations performed on the collection
+     * @type {Array<OptimisationHistoryItem>}
+     * @memberof Collection
+     */
+    'optimisationHistory'?: Array<OptimisationHistoryItem>;
+    /**
+     * 
+     * @type {MetaImage}
+     * @memberof Collection
+     */
+    'metaImage'?: MetaImage;
 }
 /**
  * 
@@ -493,6 +523,44 @@ export interface MetaField {
      */
     'value': string;
 }
+/**
+ * The image that will in links shared on social media platforms
+ * @export
+ * @interface MetaImage
+ */
+export interface MetaImage {
+    /**
+     * 
+     * @type {string}
+     * @memberof MetaImage
+     */
+    'src'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MetaImage
+     */
+    'alt'?: string;
+}
+/**
+ * 
+ * @export
+ * @interface OptimisationHistoryItem
+ */
+export interface OptimisationHistoryItem {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof OptimisationHistoryItem
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OptimisationHistoryItem
+     */
+    'createdAt'?: string;
+}
 /**
  * 
  * @export
@@ -529,6 +597,24 @@ export interface Page {
      * @memberof Page
      */
     'targetSearchPhraseData'?: TargetSearchPhraseData;
+    /**
+     * History of AI optimisations performed on the page
+     * @type {Array<OptimisationHistoryItem>}
+     * @memberof Page
+     */
+    'optimisationHistory'?: Array<OptimisationHistoryItem>;
+    /**
+     * 
+     * @type {MetaImage}
+     * @memberof Page
+     */
+    'metaImage'?: MetaImage;
+    /**
+     * 
+     * @type {string}
+     * @memberof Page
+     */
+    'publishedAt'?: string | null;
 }
 /**
  * 
@@ -1407,6 +1493,12 @@ export interface UpdateCollectionRequest {
      * @memberof UpdateCollectionRequest
      */
     'slug'?: string;
+    /**
+     * Long-form description for the collection used for SEO.
+     * @type {string}
+     * @memberof UpdateCollectionRequest
+     */
+    'longDescription'?: string;
     /**
      * 
      * @type {UpdateCollectionsRequestCollectionsInnerSeoMetadata}
@@ -1469,6 +1561,12 @@ export interface UpdateCollectionsRequestCollectionsInner {
      * @memberof UpdateCollectionsRequestCollectionsInner
      */
     'slug'?: string;
+    /**
+     * Long-form description for the collection used for SEO.
+     * @type {string}
+     * @memberof UpdateCollectionsRequestCollectionsInner
+     */
+    'longDescription'?: string;
     /**
      * 
      * @type {UpdateCollectionsRequestCollectionsInnerSeoMetadata}
@@ -2097,6 +2195,54 @@ export interface Video {
  */
 export const BlogsApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
+        /**
+         * 
+         * @summary Get website blog post
+         * @param {string} project What project it is
+         * @param {string} blogId Blog\&#39;s unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getBlog: async (project: string, blogId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('getBlog', 'project', project)
+            // verify required parameter 'blogId' is not null or undefined
+            assertParamExists('getBlog', 'blogId', blogId)
+            const localVarPath = `/v1/website/blogs/{blogId}`
+                .replace(`{${"blogId"}}`, encodeURIComponent(String(blogId)));
+            // 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 List website blog posts
@@ -2281,6 +2427,20 @@ export const BlogsApiAxiosParamCreator = function (configuration?: Configuration
 export const BlogsApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = BlogsApiAxiosParamCreator(configuration)
     return {
+        /**
+         * 
+         * @summary Get website blog post
+         * @param {string} project What project it is
+         * @param {string} blogId Blog\&#39;s unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getBlog(project: string, blogId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Blog>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getBlog(project, blogId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['BlogsApi.getBlog']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @summary List website blog posts
@@ -2339,6 +2499,16 @@ export const BlogsApiFp = function(configuration?: Configuration) {
 export const BlogsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = BlogsApiFp(configuration)
     return {
+        /**
+         * 
+         * @summary Get website blog post
+         * @param {BlogsApiGetBlogRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getBlog(requestParameters: BlogsApiGetBlogRequest, options?: RawAxiosRequestConfig): AxiosPromise<Blog> {
+            return localVarFp.getBlog(requestParameters.project, requestParameters.blogId, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary List website blog posts
@@ -2372,6 +2542,27 @@ export const BlogsApiFactory = function (configuration?: Configuration, basePath
     };
 };
 
+/**
+ * Request parameters for getBlog operation in BlogsApi.
+ * @export
+ * @interface BlogsApiGetBlogRequest
+ */
+export interface BlogsApiGetBlogRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof BlogsApiGetBlog
+     */
+    readonly project: string
+
+    /**
+     * Blog\&#39;s unique identifier
+     * @type {string}
+     * @memberof BlogsApiGetBlog
+     */
+    readonly blogId: string
+}
+
 /**
  * Request parameters for listBlogs operation in BlogsApi.
  * @export
@@ -2484,6 +2675,18 @@ export interface BlogsApiUpdateBlogsRequest {
  * @extends {BaseAPI}
  */
 export class BlogsApi extends BaseAPI {
+    /**
+     * 
+     * @summary Get website blog post
+     * @param {BlogsApiGetBlogRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BlogsApi
+     */
+    public getBlog(requestParameters: BlogsApiGetBlogRequest, options?: RawAxiosRequestConfig) {
+        return BlogsApiFp(this.configuration).getBlog(requestParameters.project, requestParameters.blogId, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary List website blog posts
@@ -2529,6 +2732,54 @@ export class BlogsApi extends BaseAPI {
  */
 export const CollectionsApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
+        /**
+         * 
+         * @summary Get website collection
+         * @param {string} project What project it is
+         * @param {string} collectionId Collection\&#39;s unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCollection: async (project: string, collectionId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('getCollection', 'project', project)
+            // verify required parameter 'collectionId' is not null or undefined
+            assertParamExists('getCollection', 'collectionId', collectionId)
+            const localVarPath = `/v1/website/collections/{collectionId}`
+                .replace(`{${"collectionId"}}`, encodeURIComponent(String(collectionId)));
+            // 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 List website collections
@@ -2761,6 +3012,20 @@ export const CollectionsApiAxiosParamCreator = function (configuration?: Configu
 export const CollectionsApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = CollectionsApiAxiosParamCreator(configuration)
     return {
+        /**
+         * 
+         * @summary Get website collection
+         * @param {string} project What project it is
+         * @param {string} collectionId Collection\&#39;s unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getCollection(project: string, collectionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Collection>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getCollection(project, collectionId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['CollectionsApi.getCollection']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @summary List website collections
@@ -2833,6 +3098,16 @@ export const CollectionsApiFp = function(configuration?: Configuration) {
 export const CollectionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = CollectionsApiFp(configuration)
     return {
+        /**
+         * 
+         * @summary Get website collection
+         * @param {CollectionsApiGetCollectionRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCollection(requestParameters: CollectionsApiGetCollectionRequest, options?: RawAxiosRequestConfig): AxiosPromise<Collection> {
+            return localVarFp.getCollection(requestParameters.project, requestParameters.collectionId, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary List website collections
@@ -2876,6 +3151,27 @@ export const CollectionsApiFactory = function (configuration?: Configuration, ba
     };
 };
 
+/**
+ * Request parameters for getCollection operation in CollectionsApi.
+ * @export
+ * @interface CollectionsApiGetCollectionRequest
+ */
+export interface CollectionsApiGetCollectionRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof CollectionsApiGetCollection
+     */
+    readonly project: string
+
+    /**
+     * Collection\&#39;s unique identifier
+     * @type {string}
+     * @memberof CollectionsApiGetCollection
+     */
+    readonly collectionId: string
+}
+
 /**
  * Request parameters for listCollections operation in CollectionsApi.
  * @export
@@ -3009,6 +3305,18 @@ export interface CollectionsApiUpdateCollectionsRequest {
  * @extends {BaseAPI}
  */
 export class CollectionsApi extends BaseAPI {
+    /**
+     * 
+     * @summary Get website collection
+     * @param {CollectionsApiGetCollectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionsApi
+     */
+    public getCollection(requestParameters: CollectionsApiGetCollectionRequest, options?: RawAxiosRequestConfig) {
+        return CollectionsApiFp(this.configuration).getCollection(requestParameters.project, requestParameters.collectionId, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary List website collections
@@ -3564,6 +3872,54 @@ export class MenuApi extends BaseAPI {
  */
 export const PagesApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
+        /**
+         * 
+         * @summary Get website page
+         * @param {string} project What project it is
+         * @param {string} pageId Page\&#39;s unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPage: async (project: string, pageId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('getPage', 'project', project)
+            // verify required parameter 'pageId' is not null or undefined
+            assertParamExists('getPage', 'pageId', pageId)
+            const localVarPath = `/v1/website/pages/{pageId}`
+                .replace(`{${"pageId"}}`, encodeURIComponent(String(pageId)));
+            // 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 List website pages
@@ -3796,6 +4152,20 @@ export const PagesApiAxiosParamCreator = function (configuration?: Configuration
 export const PagesApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = PagesApiAxiosParamCreator(configuration)
     return {
+        /**
+         * 
+         * @summary Get website page
+         * @param {string} project What project it is
+         * @param {string} pageId Page\&#39;s unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getPage(project: string, pageId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Page>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getPage(project, pageId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['PagesApi.getPage']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @summary List website pages
@@ -3868,6 +4238,16 @@ export const PagesApiFp = function(configuration?: Configuration) {
 export const PagesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = PagesApiFp(configuration)
     return {
+        /**
+         * 
+         * @summary Get website page
+         * @param {PagesApiGetPageRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPage(requestParameters: PagesApiGetPageRequest, options?: RawAxiosRequestConfig): AxiosPromise<Page> {
+            return localVarFp.getPage(requestParameters.project, requestParameters.pageId, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary List website pages
@@ -3911,6 +4291,27 @@ export const PagesApiFactory = function (configuration?: Configuration, basePath
     };
 };
 
+/**
+ * Request parameters for getPage operation in PagesApi.
+ * @export
+ * @interface PagesApiGetPageRequest
+ */
+export interface PagesApiGetPageRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof PagesApiGetPage
+     */
+    readonly project: string
+
+    /**
+     * Page\&#39;s unique identifier
+     * @type {string}
+     * @memberof PagesApiGetPage
+     */
+    readonly pageId: string
+}
+
 /**
  * Request parameters for listPages operation in PagesApi.
  * @export
@@ -4044,6 +4445,18 @@ export interface PagesApiUpdatePagesRequest {
  * @extends {BaseAPI}
  */
 export class PagesApi extends BaseAPI {
+    /**
+     * 
+     * @summary Get website page
+     * @param {PagesApiGetPageRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PagesApi
+     */
+    public getPage(requestParameters: PagesApiGetPageRequest, options?: RawAxiosRequestConfig) {
+        return PagesApiFp(this.configuration).getPage(requestParameters.project, requestParameters.pageId, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary List website pages

package/base.ts

@@ -4,7 +4,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.14.0
+ * The version of the OpenAPI document: 0.16.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.14.0
+ * The version of the OpenAPI document: 0.16.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.14.0
+ * The version of the OpenAPI document: 0.16.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).