@teemill/blog 0.1.1

package/dist/esm/api.d.ts

@@ -0,0 +1,545 @@
+/**
+ * Blog API
+ * Read and write blogs on the PodOS platform.  Currently this API is in development and is not yet publicly accessible. All paths and models are subject to change.  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
+ *
+ * The version of the OpenAPI document: 0.1.1
+ * Contact: hello@teemill.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+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 {string}
+     * @memberof Blog
+     */
+    'metaImage': string | null;
+    /**
+     *
+     * @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 {string}
+     * @memberof BlogListing
+     */
+    'metaImage': string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof BlogListing
+     */
+    'publishedAt': string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof BlogListing
+     */
+    'createdAt': string;
+    /**
+     *
+     * @type {string}
+     * @memberof BlogListing
+     */
+    'updatedAt': string;
+}
+/**
+ *
+ * @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 {string}
+     * @memberof CreateBlogRequest
+     */
+    'metaImage': string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CreateBlogRequest
+     */
+    'published'?: boolean;
+}
+/**
+ *
+ * @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 {string}
+     * @memberof UpdateBlogRequest
+     */
+    'metaImage'?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UpdateBlogRequest
+     */
+    'published'?: boolean;
+}
+/**
+ * BlogApi - axios parameter creator
+ * @export
+ */
+export declare const BlogApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Create a blog
+     * @param {string} project
+     * @param {CreateBlogRequest} createBlogRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBlog: (project: string, createBlogRequest: CreateBlogRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Delete a blog
+     * @param {string} project
+     * @param {string} blogId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteBlog: (project: string, blogId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get a blog
+     * @param {string} project
+     * @param {string} blogId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBlog: (project: string, blogId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary List blogs
+     * @param {string} project
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBlogs: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Update a blog
+     * @param {string} project
+     * @param {string} blogId
+     * @param {UpdateBlogRequest} updateBlogRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateBlog: (project: string, blogId: string, updateBlogRequest: UpdateBlogRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * BlogApi - functional programming interface
+ * @export
+ */
+export declare const BlogApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Create a blog
+     * @param {string} project
+     * @param {CreateBlogRequest} createBlogRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBlog(project: string, createBlogRequest: CreateBlogRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Blog>>;
+    /**
+     *
+     * @summary Delete a blog
+     * @param {string} project
+     * @param {string} blogId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteBlog(project: string, blogId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Get a blog
+     * @param {string} project
+     * @param {string} blogId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBlog(project: string, blogId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Blog>>;
+    /**
+     *
+     * @summary List blogs
+     * @param {string} project
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBlogs(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBlogsResponse>>;
+    /**
+     *
+     * @summary Update a blog
+     * @param {string} project
+     * @param {string} blogId
+     * @param {UpdateBlogRequest} updateBlogRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateBlog(project: string, blogId: string, updateBlogRequest: UpdateBlogRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Blog>>;
+};
+/**
+ * BlogApi - factory interface
+ * @export
+ */
+export declare const BlogApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Create a blog
+     * @param {BlogApiCreateBlogRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBlog(requestParameters: BlogApiCreateBlogRequest, options?: RawAxiosRequestConfig): AxiosPromise<Blog>;
+    /**
+     *
+     * @summary Delete a blog
+     * @param {BlogApiDeleteBlogRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteBlog(requestParameters: BlogApiDeleteBlogRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Get a blog
+     * @param {BlogApiGetBlogRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBlog(requestParameters: BlogApiGetBlogRequest, options?: RawAxiosRequestConfig): AxiosPromise<Blog>;
+    /**
+     *
+     * @summary List blogs
+     * @param {BlogApiListBlogsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBlogs(requestParameters: BlogApiListBlogsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListBlogsResponse>;
+    /**
+     *
+     * @summary Update a blog
+     * @param {BlogApiUpdateBlogRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateBlog(requestParameters: BlogApiUpdateBlogRequest, options?: RawAxiosRequestConfig): AxiosPromise<Blog>;
+};
+/**
+ * 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;
+}
+/**
+ * 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 {
+    /**
+     *
+     * @summary Create a blog
+     * @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>>;
+    /**
+     *
+     * @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>>;
+    /**
+     *
+     * @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>>;
+    /**
+     *
+     * @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>>;
+    /**
+     *
+     * @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>>;
+}