@teemill/website 0.14.0 → 0.16.0

package/dist/esm/api.d.ts

@@ -2,7 +2,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).
@@ -232,6 +232,18 @@ export interface Blog {
      * @memberof Blog
      */
     'targetSearchPhraseData'?: TargetSearchPhraseData;
+    /**
+     *
+     * @type {MetaImage}
+     * @memberof Blog
+     */
+    'metaImage'?: MetaImage;
+    /**
+     *
+     * @type {string}
+     * @memberof Blog
+     */
+    'publishedAt'?: string | null;
 }
 /**
  *
@@ -282,6 +294,12 @@ export interface Collection {
      * @memberof Collection
      */
     'slug'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Collection
+     */
+    'longDescription'?: string;
     /**
      *
      * @type {SeoMetadata}
@@ -294,6 +312,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;
 }
 /**
  *
@@ -476,6 +506,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
@@ -512,6 +580,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;
 }
 /**
  *
@@ -1372,6 +1458,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}
@@ -1434,6 +1526,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}
@@ -2049,6 +2147,15 @@ export interface Video {
  * @export
  */
 export declare const BlogsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @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: (project: string, blogId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary List website blog posts
@@ -2088,6 +2195,15 @@ export declare const BlogsApiAxiosParamCreator: (configuration?: Configuration)
  * @export
  */
 export declare const BlogsApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @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(project: string, blogId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Blog>>;
     /**
      *
      * @summary List website blog posts
@@ -2127,6 +2243,14 @@ export declare const BlogsApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const BlogsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @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>;
     /**
      *
      * @summary List website blog posts
@@ -2152,6 +2276,25 @@ export declare const BlogsApiFactory: (configuration?: Configuration, basePath?:
      */
     updateBlogs(requestParameters: BlogsApiUpdateBlogsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BlogsResponse>;
 };
+/**
+ * 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
@@ -2252,6 +2395,15 @@ export interface BlogsApiUpdateBlogsRequest {
  * @extends {BaseAPI}
  */
 export declare class BlogsApi extends BaseAPI {
+    /**
+     *
+     * @summary Get website blog post
+     * @param {BlogsApiGetBlogRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BlogsApi
+     */
+    getBlog(requestParameters: BlogsApiGetBlogRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Blog, any>>;
     /**
      *
      * @summary List website blog posts
@@ -2285,6 +2437,15 @@ export declare class BlogsApi extends BaseAPI {
  * @export
  */
 export declare const CollectionsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @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: (project: string, collectionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary List website collections
@@ -2333,6 +2494,15 @@ export declare const CollectionsApiAxiosParamCreator: (configuration?: Configura
  * @export
  */
 export declare const CollectionsApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @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(project: string, collectionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Collection>>;
     /**
      *
      * @summary List website collections
@@ -2381,6 +2551,14 @@ export declare const CollectionsApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const CollectionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Get website collection
+     * @param {CollectionsApiGetCollectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCollection(requestParameters: CollectionsApiGetCollectionRequest, options?: RawAxiosRequestConfig): AxiosPromise<Collection>;
     /**
      *
      * @summary List website collections
@@ -2414,6 +2592,25 @@ export declare const CollectionsApiFactory: (configuration?: Configuration, base
      */
     updateCollections(requestParameters: CollectionsApiUpdateCollectionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<CollectionsResponse>;
 };
+/**
+ * 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
@@ -2533,6 +2730,15 @@ export interface CollectionsApiUpdateCollectionsRequest {
  * @extends {BaseAPI}
  */
 export declare class CollectionsApi extends BaseAPI {
+    /**
+     *
+     * @summary Get website collection
+     * @param {CollectionsApiGetCollectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionsApi
+     */
+    getCollection(requestParameters: CollectionsApiGetCollectionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Collection, any>>;
     /**
      *
      * @summary List website collections
@@ -2843,6 +3049,15 @@ export declare class MenuApi extends BaseAPI {
  * @export
  */
 export declare const PagesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @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: (project: string, pageId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary List website pages
@@ -2891,6 +3106,15 @@ export declare const PagesApiAxiosParamCreator: (configuration?: Configuration)
  * @export
  */
 export declare const PagesApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @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(project: string, pageId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Page>>;
     /**
      *
      * @summary List website pages
@@ -2939,6 +3163,14 @@ export declare const PagesApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const PagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Get website page
+     * @param {PagesApiGetPageRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPage(requestParameters: PagesApiGetPageRequest, options?: RawAxiosRequestConfig): AxiosPromise<Page>;
     /**
      *
      * @summary List website pages
@@ -2972,6 +3204,25 @@ export declare const PagesApiFactory: (configuration?: Configuration, basePath?:
      */
     updatePages(requestParameters: PagesApiUpdatePagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<PagesResponse>;
 };
+/**
+ * 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
@@ -3091,6 +3342,15 @@ export interface PagesApiUpdatePagesRequest {
  * @extends {BaseAPI}
  */
 export declare class PagesApi extends BaseAPI {
+    /**
+     *
+     * @summary Get website page
+     * @param {PagesApiGetPageRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PagesApi
+     */
+    getPage(requestParameters: PagesApiGetPageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Page, any>>;
     /**
      *
      * @summary List website pages