@teemill/blog 0.3.2 → 0.3.4

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * Blog API
  * Read and write blogs on the PodOS platform.
  *
- * The version of the OpenAPI document: 0.3.2
+ * The version of the OpenAPI document: 0.3.4
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,169 +13,37 @@ import type { Configuration } from './configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import type { RequestArgs } from './base';
 import { BaseAPI } from './base';
-/**
- *
- * @export
- * @interface ApiError
- */
 export interface ApiError {
-    /**
-     *
-     * @type {string}
-     * @memberof ApiError
-     */
     'code'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof ApiError
-     */
     'message': string;
 }
-/**
- *
- * @export
- * @interface Blog
- */
 export interface Blog {
-    /**
-     *
-     * @type {string}
-     * @memberof Blog
-     */
     'id': string;
-    /**
-     *
-     * @type {string}
-     * @memberof Blog
-     */
     'title': string;
-    /**
-     *
-     * @type {string}
-     * @memberof Blog
-     */
     'slug': string;
-    /**
-     *
-     * @type {string}
-     * @memberof Blog
-     */
     'description': string;
-    /**
-     *
-     * @type {Array<string>}
-     * @memberof Blog
-     */
     'tags'?: Array<string>;
-    /**
-     *
-     * @type {string}
-     * @memberof Blog
-     */
     'metaImage': string | null;
-    /**
-     *
-     * @type {BlogListingType}
-     * @memberof Blog
-     */
     'type': BlogListingType;
-    /**
-     *
-     * @type {string}
-     * @memberof Blog
-     */
     'publishedAt': string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof Blog
-     */
     'createdAt': string;
-    /**
-     *
-     * @type {string}
-     * @memberof Blog
-     */
     'updatedAt': string;
-    /**
-     *
-     * @type {string}
-     * @memberof Blog
-     */
     'content': string;
 }
-/**
- *
- * @export
- * @interface BlogListing
- */
 export interface BlogListing {
-    /**
-     *
-     * @type {string}
-     * @memberof BlogListing
-     */
     'id': string;
-    /**
-     *
-     * @type {string}
-     * @memberof BlogListing
-     */
     'title': string;
-    /**
-     *
-     * @type {string}
-     * @memberof BlogListing
-     */
     'slug': string;
-    /**
-     *
-     * @type {string}
-     * @memberof BlogListing
-     */
     'description': string;
-    /**
-     *
-     * @type {Array<string>}
-     * @memberof BlogListing
-     */
     'tags'?: Array<string>;
-    /**
-     *
-     * @type {string}
-     * @memberof BlogListing
-     */
     'metaImage': string | null;
-    /**
-     *
-     * @type {BlogListingType}
-     * @memberof BlogListing
-     */
     'type': BlogListingType;
-    /**
-     *
-     * @type {string}
-     * @memberof BlogListing
-     */
     'publishedAt': string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof BlogListing
-     */
     'createdAt': string;
-    /**
-     *
-     * @type {string}
-     * @memberof BlogListing
-     */
     'updatedAt': string;
 }
 /**
  * The type of blog. Project blogs are only visible to the project. Platform blogs are visible to all clients of the platform. Requires the Platform module to be installed. Parent platform blogs are published by the parent platform of the current project.
- * @export
- * @enum {string}
  */
 export declare const BlogListingType: {
     readonly Project: "project";
@@ -183,58 +51,16 @@ export declare const BlogListingType: {
     readonly ParentPlatform: "parent-platform";
 };
 export type BlogListingType = typeof BlogListingType[keyof typeof BlogListingType];
-/**
- *
- * @export
- * @interface CreateBlogRequest
- */
 export interface CreateBlogRequest {
-    /**
-     *
-     * @type {string}
-     * @memberof CreateBlogRequest
-     */
     'title': string;
-    /**
-     *
-     * @type {string}
-     * @memberof CreateBlogRequest
-     */
     'content': string;
-    /**
-     *
-     * @type {string}
-     * @memberof CreateBlogRequest
-     */
     'slug': string;
-    /**
-     *
-     * @type {string}
-     * @memberof CreateBlogRequest
-     */
     'description': string;
-    /**
-     *
-     * @type {Array<string>}
-     * @memberof CreateBlogRequest
-     */
     'tags'?: Array<string>;
-    /**
-     *
-     * @type {string}
-     * @memberof CreateBlogRequest
-     */
     'metaImage': string;
-    /**
-     *
-     * @type {boolean}
-     * @memberof CreateBlogRequest
-     */
     'published'?: boolean;
     /**
      * The type of blog. Project blogs are only visible to the project. Platform blogs are visible to all clients of the project\'s platform. Requires the Platform module to be installed.
-     * @type {string}
-     * @memberof CreateBlogRequest
      */
     'type': CreateBlogRequestTypeEnum;
 }
@@ -243,71 +69,20 @@ export declare const CreateBlogRequestTypeEnum: {
     readonly Platform: "platform";
 };
 export type CreateBlogRequestTypeEnum = typeof CreateBlogRequestTypeEnum[keyof typeof CreateBlogRequestTypeEnum];
-/**
- *
- * @export
- * @interface ListBlogsResponse
- */
 export interface ListBlogsResponse {
-    /**
-     *
-     * @type {Array<BlogListing>}
-     * @memberof ListBlogsResponse
-     */
     'blogs': Array<BlogListing>;
 }
-/**
- *
- * @export
- * @interface UpdateBlogRequest
- */
 export interface UpdateBlogRequest {
-    /**
-     *
-     * @type {string}
-     * @memberof UpdateBlogRequest
-     */
     'title'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof UpdateBlogRequest
-     */
     'content'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof UpdateBlogRequest
-     */
     'slug'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof UpdateBlogRequest
-     */
     'description'?: string;
-    /**
-     *
-     * @type {Array<string>}
-     * @memberof UpdateBlogRequest
-     */
     'tags'?: Array<string>;
-    /**
-     *
-     * @type {string}
-     * @memberof UpdateBlogRequest
-     */
     'metaImage'?: string;
-    /**
-     *
-     * @type {boolean}
-     * @memberof UpdateBlogRequest
-     */
     'published'?: boolean;
 }
 /**
  * BlogApi - axios parameter creator
- * @export
  */
 export declare const BlogApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -362,7 +137,6 @@ export declare const BlogApiAxiosParamCreator: (configuration?: Configuration) =
 };
 /**
  * BlogApi - functional programming interface
- * @export
  */
 export declare const BlogApiFp: (configuration?: Configuration) => {
     /**
@@ -417,7 +191,6 @@ export declare const BlogApiFp: (configuration?: Configuration) => {
 };
 /**
  * BlogApi - factory interface
- * @export
  */
 export declare const BlogApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -463,128 +236,57 @@ export declare const BlogApiFactory: (configuration?: Configuration, basePath?:
 };
 /**
  * Request parameters for createBlog operation in BlogApi.
- * @export
- * @interface BlogApiCreateBlogRequest
  */
 export interface BlogApiCreateBlogRequest {
-    /**
-     *
-     * @type {string}
-     * @memberof BlogApiCreateBlog
-     */
     readonly project: string;
-    /**
-     *
-     * @type {CreateBlogRequest}
-     * @memberof BlogApiCreateBlog
-     */
     readonly createBlogRequest: CreateBlogRequest;
 }
 /**
  * Request parameters for deleteBlog operation in BlogApi.
- * @export
- * @interface BlogApiDeleteBlogRequest
  */
 export interface BlogApiDeleteBlogRequest {
-    /**
-     *
-     * @type {string}
-     * @memberof BlogApiDeleteBlog
-     */
     readonly project: string;
-    /**
-     *
-     * @type {string}
-     * @memberof BlogApiDeleteBlog
-     */
     readonly blogId: string;
 }
 /**
  * Request parameters for getBlog operation in BlogApi.
- * @export
- * @interface BlogApiGetBlogRequest
  */
 export interface BlogApiGetBlogRequest {
-    /**
-     *
-     * @type {string}
-     * @memberof BlogApiGetBlog
-     */
     readonly project: string;
-    /**
-     *
-     * @type {string}
-     * @memberof BlogApiGetBlog
-     */
     readonly blogId: string;
 }
 /**
  * Request parameters for listBlogs operation in BlogApi.
- * @export
- * @interface BlogApiListBlogsRequest
  */
 export interface BlogApiListBlogsRequest {
-    /**
-     *
-     * @type {string}
-     * @memberof BlogApiListBlogs
-     */
     readonly project: string;
     /**
      * Max page size. This is the maximum page size that will be returned, but it might be smaller.
-     * @type {number}
-     * @memberof BlogApiListBlogs
      */
     readonly pageSize?: number;
     /**
      * Page reference token
-     * @type {number}
-     * @memberof BlogApiListBlogs
      */
     readonly pageToken?: number;
     /**
      * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
-     * @type {Array<string>}
-     * @memberof BlogApiListBlogs
      */
     readonly sortBy?: Array<string>;
     /**
      * Search term to filter results
-     * @type {string}
-     * @memberof BlogApiListBlogs
      */
     readonly search?: string;
 }
 /**
  * Request parameters for updateBlog operation in BlogApi.
- * @export
- * @interface BlogApiUpdateBlogRequest
  */
 export interface BlogApiUpdateBlogRequest {
-    /**
-     *
-     * @type {string}
-     * @memberof BlogApiUpdateBlog
-     */
     readonly project: string;
-    /**
-     *
-     * @type {string}
-     * @memberof BlogApiUpdateBlog
-     */
     readonly blogId: string;
-    /**
-     *
-     * @type {UpdateBlogRequest}
-     * @memberof BlogApiUpdateBlog
-     */
     readonly updateBlogRequest: UpdateBlogRequest;
 }
 /**
  * BlogApi - object-oriented interface
- * @export
- * @class BlogApi
- * @extends {BaseAPI}
  */
 export declare class BlogApi extends BaseAPI {
     /**
@@ -593,43 +295,38 @@ export declare class BlogApi extends BaseAPI {
      * @param {BlogApiCreateBlogRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BlogApi
      */
-    createBlog(requestParameters: BlogApiCreateBlogRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Blog, any>>;
+    createBlog(requestParameters: BlogApiCreateBlogRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Blog, any, {}>>;
     /**
      *
      * @summary Delete a blog
      * @param {BlogApiDeleteBlogRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BlogApi
      */
-    deleteBlog(requestParameters: BlogApiDeleteBlogRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    deleteBlog(requestParameters: BlogApiDeleteBlogRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
      *
      * @summary Get a blog
      * @param {BlogApiGetBlogRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BlogApi
      */
-    getBlog(requestParameters: BlogApiGetBlogRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Blog, any>>;
+    getBlog(requestParameters: BlogApiGetBlogRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Blog, any, {}>>;
     /**
      *
      * @summary List blogs
      * @param {BlogApiListBlogsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BlogApi
      */
-    listBlogs(requestParameters: BlogApiListBlogsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBlogsResponse, any>>;
+    listBlogs(requestParameters: BlogApiListBlogsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBlogsResponse, any, {}>>;
     /**
      *
      * @summary Update a blog
      * @param {BlogApiUpdateBlogRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BlogApi
      */
-    updateBlog(requestParameters: BlogApiUpdateBlogRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Blog, any>>;
+    updateBlog(requestParameters: BlogApiUpdateBlogRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Blog, any, {}>>;
 }

package/dist/api.js

@@ -5,7 +5,7 @@
  * Blog API
  * Read and write blogs on the PodOS platform.
  *
- * The version of the OpenAPI document: 0.3.2
+ * The version of the OpenAPI document: 0.3.4
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -31,8 +31,6 @@ const common_1 = require("./common");
 const base_1 = require("./base");
 /**
  * The type of blog. Project blogs are only visible to the project. Platform blogs are visible to all clients of the platform. Requires the Platform module to be installed. Parent platform blogs are published by the parent platform of the current project.
- * @export
- * @enum {string}
  */
 exports.BlogListingType = {
     Project: 'project',
@@ -45,7 +43,6 @@ exports.CreateBlogRequestTypeEnum = {
 };
 /**
  * BlogApi - axios parameter creator
- * @export
  */
 const BlogApiAxiosParamCreator = function (configuration) {
     return {
@@ -272,7 +269,6 @@ const BlogApiAxiosParamCreator = function (configuration) {
 exports.BlogApiAxiosParamCreator = BlogApiAxiosParamCreator;
 /**
  * BlogApi - functional programming interface
- * @export
  */
 const BlogApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.BlogApiAxiosParamCreator)(configuration);
@@ -371,7 +367,6 @@ const BlogApiFp = function (configuration) {
 exports.BlogApiFp = BlogApiFp;
 /**
  * BlogApi - factory interface
- * @export
  */
 const BlogApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.BlogApiFp)(configuration);
@@ -431,9 +426,6 @@ const BlogApiFactory = function (configuration, basePath, axios) {
 exports.BlogApiFactory = BlogApiFactory;
 /**
  * BlogApi - object-oriented interface
- * @export
- * @class BlogApi
- * @extends {BaseAPI}
  */
 class BlogApi extends base_1.BaseAPI {
     /**
@@ -442,7 +434,6 @@ class BlogApi extends base_1.BaseAPI {
      * @param {BlogApiCreateBlogRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BlogApi
      */
     createBlog(requestParameters, options) {
         return (0, exports.BlogApiFp)(this.configuration).createBlog(requestParameters.project, requestParameters.createBlogRequest, options).then((request) => request(this.axios, this.basePath));
@@ -453,7 +444,6 @@ class BlogApi extends base_1.BaseAPI {
      * @param {BlogApiDeleteBlogRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BlogApi
      */
     deleteBlog(requestParameters, options) {
         return (0, exports.BlogApiFp)(this.configuration).deleteBlog(requestParameters.project, requestParameters.blogId, options).then((request) => request(this.axios, this.basePath));
@@ -464,7 +454,6 @@ class BlogApi extends base_1.BaseAPI {
      * @param {BlogApiGetBlogRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BlogApi
      */
     getBlog(requestParameters, options) {
         return (0, exports.BlogApiFp)(this.configuration).getBlog(requestParameters.project, requestParameters.blogId, options).then((request) => request(this.axios, this.basePath));
@@ -475,7 +464,6 @@ class BlogApi extends base_1.BaseAPI {
      * @param {BlogApiListBlogsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BlogApi
      */
     listBlogs(requestParameters, options) {
         return (0, exports.BlogApiFp)(this.configuration).listBlogs(requestParameters.project, requestParameters.pageSize, requestParameters.pageToken, requestParameters.sortBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
@@ -486,7 +474,6 @@ class BlogApi extends base_1.BaseAPI {
      * @param {BlogApiUpdateBlogRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BlogApi
      */
     updateBlog(requestParameters, options) {
         return (0, exports.BlogApiFp)(this.configuration).updateBlog(requestParameters.project, requestParameters.blogId, requestParameters.updateBlogRequest, options).then((request) => request(this.axios, this.basePath));

package/dist/base.d.ts

@@ -2,7 +2,7 @@
  * Blog API
  * Read and write blogs on the PodOS platform.
  *
- * The version of the OpenAPI document: 0.3.2
+ * The version of the OpenAPI document: 0.3.4
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,42 +12,22 @@
 import type { Configuration } from './configuration';
 import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
 export declare const BASE_PATH: string;
-/**
- *
- * @export
- */
 export declare const COLLECTION_FORMATS: {
     csv: string;
     ssv: string;
     tsv: string;
     pipes: string;
 };
-/**
- *
- * @export
- * @interface RequestArgs
- */
 export interface RequestArgs {
     url: string;
     options: RawAxiosRequestConfig;
 }
-/**
- *
- * @export
- * @class BaseAPI
- */
 export declare class BaseAPI {
     protected basePath: string;
     protected axios: AxiosInstance;
     protected configuration: Configuration | undefined;
     constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
 }
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
 export declare class RequiredError extends Error {
     field: string;
     constructor(field: string, msg?: string);
@@ -58,9 +38,5 @@ interface ServerMap {
         description: string;
     }[];
 }
-/**
- *
- * @export
- */
 export declare const operationServerMap: ServerMap;
 export {};

package/dist/base.js

@@ -5,7 +5,7 @@
  * Blog API
  * Read and write blogs on the PodOS platform.
  *
- * The version of the OpenAPI document: 0.3.2
+ * The version of the OpenAPI document: 0.3.4
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,21 +16,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
 const axios_1 = require("axios");
 exports.BASE_PATH = "https://localhost:8080".replace(/\/+$/, "");
-/**
- *
- * @export
- */
 exports.COLLECTION_FORMATS = {
     csv: ",",
     ssv: " ",
     tsv: "\t",
     pipes: "|",
 };
-/**
- *
- * @export
- * @class BaseAPI
- */
 class BaseAPI {
     constructor(configuration, basePath = exports.BASE_PATH, axios = axios_1.default) {
         var _a;
@@ -44,12 +35,6 @@ class BaseAPI {
 }
 exports.BaseAPI = BaseAPI;
 ;
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
 class RequiredError extends Error {
     constructor(field, msg) {
         super(msg);
@@ -58,8 +43,4 @@ class RequiredError extends Error {
     }
 }
 exports.RequiredError = RequiredError;
-/**
- *
- * @export
- */
 exports.operationServerMap = {};

package/dist/common.d.ts

@@ -2,7 +2,7 @@
  * Blog API
  * Read and write blogs on the PodOS platform.
  *
- * The version of the OpenAPI document: 0.3.2
+ * The version of the OpenAPI document: 0.3.4
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).