@suin/esa-api

/** * esa API v1 * チームのナレッジ共有サービス[esa.io](https://esa.io/)のAPI v1の仕様書 * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { AxiosPromise, AxiosInstance } from "axios"; import { Configuration } from "../configuration"; import { RequestArgs, BaseAPI } from "../base"; import { CreatePostBody } from "../models"; import { PaginatedPosts } from "../models"; import { Post } from "../models"; import { UpdatePostBody } from "../models"; /** * PostApi - axios parameter creator * @export */ export declare const PostApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary 記事を投稿する * @param {string} teamName チーム名 * @param {CreatePostBody} createPostBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPost: (teamName: string, createPostBody: CreatePostBody, options?: any) => Promise<RequestArgs>; /** * 指定された記事を削除します。 * @summary 記事を削除する * @param {string} teamName チーム名 * @param {number} postNumber 記事ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePost: (teamName: string, postNumber: number, options?: any) => Promise<RequestArgs>; /** * 指定された記事を取得します。 * @summary 記事を取得する * @param {string} teamName チーム名 * @param {number} postNumber 記事ID * @param {Array<'comments' | 'comments.stargazers' | 'stargazers'>} [include] - `comments` を指定するとコメントの配列を含んだレスポンスを返します。 - `comments,comments.stargazers`を指定するとコメントとコメントに対するStarの配列を含んだレスポンスを返します。 - `stargazers` を指定するとStarの配列を含んだレスポンスを返します。 - `stargazers,comments` のように `,` で区切ることで複数指定できます * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPost: (teamName: string, postNumber: number, include?: Array<"comments" | "comments.stargazers" | "stargazers">, options?: any) => Promise<RequestArgs>; /** * * @summary 記事一覧を取得する * @param {string} teamName チーム名 * @param {string} [q] 記事を絞り込むための条件を指定します * @param {Array<'comments' | 'comments.stargazers' | 'stargazers'>} [include] - `comments` を指定するとコメントの配列を含んだレスポンスを返します。 - `comments,comments.stargazers`を指定するとコメントとコメントに対するStarの配列を含んだレスポンスを返します。 - `stargazers` を指定するとStarの配列を含んだレスポンスを返します。 - `stargazers,comments` のように `,` で区切ることで複数指定できます * @param {'updated' | 'created' | 'number' | 'stars' | 'watches' | 'comments' | 'best_match'} [sort] 記事の並び順を指定します - 設定可能な値 - `updated` (default) - 記事の更新日時 - `created` - 記事の作成日時 - `number` - 記事番号 - `stars` - 記事へのStarの数 - `watches` - 記事へのWatchの数 - `comments` - 記事へのCommentの数 - `best_match` - 総合的な記事のスコア * @param {'asc' | 'desc'} [order] 設定可能な値: - `desc`: 降順 (default) - `asc`: 昇順 * @param {number} [page] ページ番号 * @param {number} [perPage] 1ページあたりに含まれる要素数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPosts: (teamName: string, q?: string, include?: Array<"comments" | "comments.stargazers" | "stargazers">, sort?: "updated" | "created" | "number" | "stars" | "watches" | "comments" | "best_match", order?: "asc" | "desc", page?: number, perPage?: number, options?: any) => Promise<RequestArgs>; /** * 指定された記事を編集します。 * @summary 記事を編集する * @param {string} teamName チーム名 * @param {number} postNumber 記事ID * @param {UpdatePostBody} updatePostBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePost: (teamName: string, postNumber: number, updatePostBody: UpdatePostBody, options?: any) => Promise<RequestArgs>; }; /** * PostApi - functional programming interface * @export */ export declare const PostApiFp: (configuration?: Configuration) => { /** * * @summary 記事を投稿する * @param {string} teamName チーム名 * @param {CreatePostBody} createPostBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPost(teamName: string, createPostBody: CreatePostBody, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Post>>; /** * 指定された記事を削除します。 * @summary 記事を削除する * @param {string} teamName チーム名 * @param {number} postNumber 記事ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePost(teamName: string, postNumber: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * 指定された記事を取得します。 * @summary 記事を取得する * @param {string} teamName チーム名 * @param {number} postNumber 記事ID * @param {Array<'comments' | 'comments.stargazers' | 'stargazers'>} [include] - `comments` を指定するとコメントの配列を含んだレスポンスを返します。 - `comments,comments.stargazers`を指定するとコメントとコメントに対するStarの配列を含んだレスポンスを返します。 - `stargazers` を指定するとStarの配列を含んだレスポンスを返します。 - `stargazers,comments` のように `,` で区切ることで複数指定できます * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPost(teamName: string, postNumber: number, include?: Array<"comments" | "comments.stargazers" | "stargazers">, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Post>>; /** * * @summary 記事一覧を取得する * @param {string} teamName チーム名 * @param {string} [q] 記事を絞り込むための条件を指定します * @param {Array<'comments' | 'comments.stargazers' | 'stargazers'>} [include] - `comments` を指定するとコメントの配列を含んだレスポンスを返します。 - `comments,comments.stargazers`を指定するとコメントとコメントに対するStarの配列を含んだレスポンスを返します。 - `stargazers` を指定するとStarの配列を含んだレスポンスを返します。 - `stargazers,comments` のように `,` で区切ることで複数指定できます * @param {'updated' | 'created' | 'number' | 'stars' | 'watches' | 'comments' | 'best_match'} [sort] 記事の並び順を指定します - 設定可能な値 - `updated` (default) - 記事の更新日時 - `created` - 記事の作成日時 - `number` - 記事番号 - `stars` - 記事へのStarの数 - `watches` - 記事へのWatchの数 - `comments` - 記事へのCommentの数 - `best_match` - 総合的な記事のスコア * @param {'asc' | 'desc'} [order] 設定可能な値: - `desc`: 降順 (default) - `asc`: 昇順 * @param {number} [page] ページ番号 * @param {number} [perPage] 1ページあたりに含まれる要素数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPosts(teamName: string, q?: string, include?: Array<"comments" | "comments.stargazers" | "stargazers">, sort?: "updated" | "created" | "number" | "stars" | "watches" | "comments" | "best_match", order?: "asc" | "desc", page?: number, perPage?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedPosts>>; /** * 指定された記事を編集します。 * @summary 記事を編集する * @param {string} teamName チーム名 * @param {number} postNumber 記事ID * @param {UpdatePostBody} updatePostBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePost(teamName: string, postNumber: number, updatePostBody: UpdatePostBody, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Post>>; }; /** * PostApi - factory interface * @export */ export declare const PostApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary 記事を投稿する * @param {string} teamName チーム名 * @param {CreatePostBody} createPostBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPost(teamName: string, createPostBody: CreatePostBody, options?: any): AxiosPromise<Post>; /** * 指定された記事を削除します。 * @summary 記事を削除する * @param {string} teamName チーム名 * @param {number} postNumber 記事ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePost(teamName: string, postNumber: number, options?: any): AxiosPromise<void>; /** * 指定された記事を取得します。 * @summary 記事を取得する * @param {string} teamName チーム名 * @param {number} postNumber 記事ID * @param {Array<'comments' | 'comments.stargazers' | 'stargazers'>} [include] - `comments` を指定するとコメントの配列を含んだレスポンスを返します。 - `comments,comments.stargazers`を指定するとコメントとコメントに対するStarの配列を含んだレスポンスを返します。 - `stargazers` を指定するとStarの配列を含んだレスポンスを返します。 - `stargazers,comments` のように `,` で区切ることで複数指定できます * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPost(teamName: string, postNumber: number, include?: Array<"comments" | "comments.stargazers" | "stargazers">, options?: any): AxiosPromise<Post>; /** * * @summary 記事一覧を取得する * @param {string} teamName チーム名 * @param {string} [q] 記事を絞り込むための条件を指定します * @param {Array<'comments' | 'comments.stargazers' | 'stargazers'>} [include] - `comments` を指定するとコメントの配列を含んだレスポンスを返します。 - `comments,comments.stargazers`を指定するとコメントとコメントに対するStarの配列を含んだレスポンスを返します。 - `stargazers` を指定するとStarの配列を含んだレスポンスを返します。 - `stargazers,comments` のように `,` で区切ることで複数指定できます * @param {'updated' | 'created' | 'number' | 'stars' | 'watches' | 'comments' | 'best_match'} [sort] 記事の並び順を指定します - 設定可能な値 - `updated` (default) - 記事の更新日時 - `created` - 記事の作成日時 - `number` - 記事番号 - `stars` - 記事へのStarの数 - `watches` - 記事へのWatchの数 - `comments` - 記事へのCommentの数 - `best_match` - 総合的な記事のスコア * @param {'asc' | 'desc'} [order] 設定可能な値: - `desc`: 降順 (default) - `asc`: 昇順 * @param {number} [page] ページ番号 * @param {number} [perPage] 1ページあたりに含まれる要素数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPosts(teamName: string, q?: string, include?: Array<"comments" | "comments.stargazers" | "stargazers">, sort?: "updated" | "created" | "number" | "stars" | "watches" | "comments" | "best_match", order?: "asc" | "desc", page?: number, perPage?: number, options?: any): AxiosPromise<PaginatedPosts>; /** * 指定された記事を編集します。 * @summary 記事を編集する * @param {string} teamName チーム名 * @param {number} postNumber 記事ID * @param {UpdatePostBody} updatePostBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePost(teamName: string, postNumber: number, updatePostBody: UpdatePostBody, options?: any): AxiosPromise<Post>; }; /** * Request parameters for createPost operation in PostApi. * @export * @interface PostApiCreatePostRequest */ export interface PostApiCreatePostRequest { /** * チーム名 * @type {string} * @memberof PostApiCreatePost */ readonly teamName: string; /** * * @type {CreatePostBody} * @memberof PostApiCreatePost */ readonly createPostBody: CreatePostBody; } /** * Request parameters for deletePost operation in PostApi. * @export * @interface PostApiDeletePostRequest */ export interface PostApiDeletePostRequest { /** * チーム名 * @type {string} * @memberof PostApiDeletePost */ readonly teamName: string; /** * 記事ID * @type {number} * @memberof PostApiDeletePost */ readonly postNumber: number; } /** * Request parameters for getPost operation in PostApi. * @export * @interface PostApiGetPostRequest */ export interface PostApiGetPostRequest { /** * チーム名 * @type {string} * @memberof PostApiGetPost */ readonly teamName: string; /** * 記事ID * @type {number} * @memberof PostApiGetPost */ readonly postNumber: number; /** * - `comments` を指定するとコメントの配列を含んだレスポンスを返します。 - `comments,comments.stargazers`を指定するとコメントとコメントに対するStarの配列を含んだレスポンスを返します。 - `stargazers` を指定するとStarの配列を含んだレスポンスを返します。 - `stargazers,comments` のように `,` で区切ることで複数指定できます * @type {Array<'comments' | 'comments.stargazers' | 'stargazers'>} * @memberof PostApiGetPost */ readonly include?: Array<"comments" | "comments.stargazers" | "stargazers">; } /** * Request parameters for getPosts operation in PostApi. * @export * @interface PostApiGetPostsRequest */ export interface PostApiGetPostsRequest { /** * チーム名 * @type {string} * @memberof PostApiGetPosts */ readonly teamName: string; /** * 記事を絞り込むための条件を指定します * @type {string} * @memberof PostApiGetPosts */ readonly q?: string; /** * - `comments` を指定するとコメントの配列を含んだレスポンスを返します。 - `comments,comments.stargazers`を指定するとコメントとコメントに対するStarの配列を含んだレスポンスを返します。 - `stargazers` を指定するとStarの配列を含んだレスポンスを返します。 - `stargazers,comments` のように `,` で区切ることで複数指定できます * @type {Array<'comments' | 'comments.stargazers' | 'stargazers'>} * @memberof PostApiGetPosts */ readonly include?: Array<"comments" | "comments.stargazers" | "stargazers">; /** * 記事の並び順を指定します - 設定可能な値 - `updated` (default) - 記事の更新日時 - `created` - 記事の作成日時 - `number` - 記事番号 - `stars` - 記事へのStarの数 - `watches` - 記事へのWatchの数 - `comments` - 記事へのCommentの数 - `best_match` - 総合的な記事のスコア * @type {'updated' | 'created' | 'number' | 'stars' | 'watches' | 'comments' | 'best_match'} * @memberof PostApiGetPosts */ readonly sort?: "updated" | "created" | "number" | "stars" | "watches" | "comments" | "best_match"; /** * 設定可能な値: - `desc`: 降順 (default) - `asc`: 昇順 * @type {'asc' | 'desc'} * @memberof PostApiGetPosts */ readonly order?: "asc" | "desc"; /** * ページ番号 * @type {number} * @memberof PostApiGetPosts */ readonly page?: number; /** * 1ページあたりに含まれる要素数 * @type {number} * @memberof PostApiGetPosts */ readonly perPage?: number; } /** * Request parameters for updatePost operation in PostApi. * @export * @interface PostApiUpdatePostRequest */ export interface PostApiUpdatePostRequest { /** * チーム名 * @type {string} * @memberof PostApiUpdatePost */ readonly teamName: string; /** * 記事ID * @type {number} * @memberof PostApiUpdatePost */ readonly postNumber: number; /** * * @type {UpdatePostBody} * @memberof PostApiUpdatePost */ readonly updatePostBody: UpdatePostBody; } /** * PostApi - object-oriented interface * @export * @class PostApi * @extends {BaseAPI} */ export declare class PostApi extends BaseAPI { /** * * @summary 記事を投稿する * @param {PostApiCreatePostRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PostApi */ createPost(requestParameters: PostApiCreatePostRequest, options?: any): Promise<import("axios").AxiosResponse<Post, any>>; /** * 指定された記事を削除します。 * @summary 記事を削除する * @param {PostApiDeletePostRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PostApi */ deletePost(requestParameters: PostApiDeletePostRequest, options?: any): Promise<import("axios").AxiosResponse<void, any>>; /** * 指定された記事を取得します。 * @summary 記事を取得する * @param {PostApiGetPostRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PostApi */ getPost(requestParameters: PostApiGetPostRequest, options?: any): Promise<import("axios").AxiosResponse<Post, any>>; /** * * @summary 記事一覧を取得する * @param {PostApiGetPostsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PostApi */ getPosts(requestParameters: PostApiGetPostsRequest, options?: any): Promise<import("axios").AxiosResponse<PaginatedPosts, any>>; /** * 指定された記事を編集します。 * @summary 記事を編集する * @param {PostApiUpdatePostRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PostApi */ updatePost(requestParameters: PostApiUpdatePostRequest, options?: any): Promise<import("axios").AxiosResponse<Post, any>>; } //# sourceMappingURL=post-api.d.ts.map