@teemill/website 0.15.0 → 0.17.0

package/dist/esm/api.d.ts

@@ -2,7 +2,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.15.0
+ * The version of the OpenAPI document: 0.17.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;
 }
 /**
  *
@@ -306,6 +318,12 @@ export interface Collection {
      * @memberof Collection
      */
     'optimisationHistory'?: Array<OptimisationHistoryItem>;
+    /**
+     *
+     * @type {MetaImage}
+     * @memberof Collection
+     */
+    'metaImage'?: MetaImage;
 }
 /**
  *
@@ -456,6 +474,18 @@ export interface MenuItem {
      * @memberof MenuItem
      */
     'link': string;
+    /**
+     *
+     * @type {string}
+     * @memberof MenuItem
+     */
+    'color': string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof MenuItem
+     */
+    'backgroundColor': string | null;
     /**
      *
      * @type {number}
@@ -488,6 +518,25 @@ 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
@@ -549,6 +598,18 @@ export interface Page {
      * @memberof Page
      */
     'optimisationHistory'?: Array<OptimisationHistoryItem>;
+    /**
+     *
+     * @type {MetaImage}
+     * @memberof Page
+     */
+    'metaImage'?: MetaImage;
+    /**
+     *
+     * @type {string}
+     * @memberof Page
+     */
+    'publishedAt'?: string | null;
 }
 /**
  *
@@ -1235,6 +1296,18 @@ export interface SubmenuItem {
      * @memberof SubmenuItem
      */
     'link': string;
+    /**
+     *
+     * @type {string}
+     * @memberof SubmenuItem
+     */
+    'color': string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SubmenuItem
+     */
+    'backgroundColor': string | null;
     /**
      *
      * @type {number}
@@ -1558,6 +1631,18 @@ export interface UpdateMenuRequestItem {
      * @memberof UpdateMenuRequestItem
      */
     'link': string;
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateMenuRequestItem
+     */
+    'color'?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateMenuRequestItem
+     */
+    'backgroundColor'?: string | null;
     /**
      *
      * @type {number}
@@ -1803,6 +1888,18 @@ export interface UpdateMenuRequestSubmenuItem {
      * @memberof UpdateMenuRequestSubmenuItem
      */
     'link': string;
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateMenuRequestSubmenuItem
+     */
+    'color'?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateMenuRequestSubmenuItem
+     */
+    'backgroundColor'?: string | null;
     /**
      *
      * @type {number}
@@ -2098,6 +2195,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
@@ -2137,6 +2243,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
@@ -2176,6 +2291,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
@@ -2201,6 +2324,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
@@ -2301,6 +2443,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
@@ -2334,6 +2485,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
@@ -2382,6 +2542,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
@@ -2430,6 +2599,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
@@ -2463,6 +2640,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
@@ -2582,6 +2778,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
@@ -2892,6 +3097,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
@@ -2940,6 +3154,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
@@ -2988,6 +3211,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
@@ -3021,6 +3252,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
@@ -3140,6 +3390,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