@suin/esa-api
Version:
esa.io APIクライアント
1,177 lines • 93.4 kB
TypeScript
/**
* 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 { AuthenticatedUser } from "../models";
import { BatchMoveOptions } from "../models";
import { BatchMoveResult } from "../models";
import { Comment } from "../models";
import { CreateCommentBody } from "../models";
import { CreateEmojiBody } from "../models";
import { CreatePostBody } from "../models";
import { CreatedEmoji } from "../models";
import { EmojiList } from "../models";
import { InvitationList } from "../models";
import { InviteBody } from "../models";
import { NewStar } from "../models";
import { PaginatedComments } from "../models";
import { PaginatedMembers } from "../models";
import { PaginatedPosts } from "../models";
import { PaginatedStargazers } from "../models";
import { PaginatedTags } from "../models";
import { PaginatedTeams } from "../models";
import { PaginatedWatchers } from "../models";
import { Post } from "../models";
import { Team } from "../models";
import { TeamStats } from "../models";
import { UpdateCommentBody } from "../models";
import { UpdatePostBody } from "../models";
/**
* EsaApi - axios parameter creator
* @export
*/
export declare const EsaApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* 指定されたカテゴリを配下のカテゴリを含めて一括で変更します。
* @summary カテゴリを一括移動する
* @param {string} teamName チーム名
* @param {BatchMoveOptions} batchMoveOptions
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
batchMoveCategory: (teamName: string, batchMoveOptions: BatchMoveOptions, options?: any) => Promise<RequestArgs>;
/**
* 記事に新しいコメントを作成します。
* @summary コメントを投稿する
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {CreateCommentBody} createCommentBody
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createComment: (teamName: string, postNumber: number, createCommentBody: CreateCommentBody, page?: number, perPage?: number, options?: any) => Promise<RequestArgs>;
/**
* 新しい絵文字を登録します。
* @summary 絵文字を登録する
* @param {string} teamName チーム名
* @param {CreateEmojiBody} createEmojiBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createEmoji: (teamName: string, createEmojiBody: CreateEmojiBody, options?: any) => Promise<RequestArgs>;
/**
*
* @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} commentId コメントID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteComment: (teamName: string, commentId: number, options?: any) => Promise<RequestArgs>;
/**
* 登録したチーム固有の絵文字を削除します。
* @summary 絵文字を削除する
* @param {string} teamName チーム名
* @param {string} code 絵文字コード
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteEmoji: (teamName: string, code: string, options?: any) => Promise<RequestArgs>;
/**
* 指定した screen_name のメンバーをチームから削除します。 - チームの owner である必要があります - APIで自分自身をチームから削除することはできません。
* @summary メンバーを削除する
* @param {string} teamName チーム名
* @param {string} screenName 削除するメンバーのscreen_name
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteMember: (teamName: string, screenName: string, 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>;
/**
* 招待中のメンバーの招待を削除します。招待時に送信されたメールに記載された招待用のURLは無効となります。 このAPIは**team**の**owner**だけがご利用可能です。
* @summary 招待を取り下げる
* @param {string} teamName チーム名
* @param {string} code 招待時の識別子を指定します
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
disinvite: (teamName: string, code: string, options?: any) => Promise<RequestArgs>;
/**
* 現在のアクセストークンで認証中のユーザーの情報を取得します。
* @summary 認証中のユーザーを取得する
* @param {'teams'} [include] teams を指定すると所属するチームの配列を含んだレスポンスを返します。
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAuthenticatedUser: (include?: "teams", options?: any) => Promise<RequestArgs>;
/**
* 指定されたコメントを取得します。
* @summary コメントを取得する
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {'stargazers'} [include] `stargazers`を指定するとStarの配列を含んだレスポンスを返します。
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getComment: (teamName: string, commentId: number, include?: "stargazers", options?: any) => Promise<RequestArgs>;
/**
* 指定されたコメントにStarをしたユーザ一覧を取得します。
* @summary コメントのStarを取得する
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCommentStargazers: (teamName: string, commentId: number, page?: number, perPage?: number, options?: any) => Promise<RequestArgs>;
/**
* チーム全体のコメント一覧を作成日の降順で返却します。
* @summary コメント一覧を取得する
* @param {string} teamName チーム名
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getComments: (teamName: string, page?: number, perPage?: number, options?: any) => Promise<RequestArgs>;
/**
* チームで利用可能な絵文字を取得します。URIクエリ文字列を含めない場合、チーム固有の絵文字だけを取得します。
* @summary 絵文字一覧を取得する
* @param {string} teamName チーム名
* @param {'all'} [include] `all`を指定すると、チーム固有の絵文字だけではなく、すべての絵文字を返します。
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getEmojis: (teamName: string, include?: "all", options?: any) => Promise<RequestArgs>;
/**
* 招待中のメンバーの一覧を取得します。 このAPIは**team**の**owner**だけがご利用可能です。
* @summary 招待中のメンバー一覧を取得する
* @param {string} teamName チーム名
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getInvitations: (teamName: string, options?: any) => Promise<RequestArgs>;
/**
*
* @summary メンバーを取得する
* @param {string} teamName チーム名
* @param {'posts_count' | 'joined' | 'last_accessed'} [sort]
* @param {'asc' | 'desc'} [order] 設定可能な値: - `desc`: 降順 (default) - `asc`: 昇順
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMembers: (teamName: string, sort?: "posts_count" | "joined" | "last_accessed", order?: "asc" | "desc", page?: number, perPage?: 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 {number} postNumber 記事ID
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPostComments: (teamName: string, postNumber: number, page?: number, perPage?: number, options?: any) => Promise<RequestArgs>;
/**
* 指定された記事にStarをしたユーザ一覧を取得します。
* @summary 記事のStarを取得する
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPostStargazers: (teamName: string, postNumber: number, page?: number, perPage?: number, 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} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTags: (teamName: string, page?: number, perPage?: number, options?: any) => Promise<RequestArgs>;
/**
*
* @summary 所属するチームを取得する
* @param {string} teamName チーム名
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTeam: (teamName: string, options?: any) => Promise<RequestArgs>;
/**
*
* @summary チームの統計情報を取得する
* @param {string} teamName チーム名
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTeamStats: (teamName: string, options?: any) => Promise<RequestArgs>;
/**
*
* @summary 所属するチーム一覧を取得する
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTeams: (page?: number, perPage?: number, options?: any) => Promise<RequestArgs>;
/**
* 指定された記事にWatchをしたユーザ一覧を取得します。
* @summary Watchしたユーザー一覧を取得する
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getWatchers: (teamName: string, postNumber: number, page?: number, perPage?: number, options?: any) => Promise<RequestArgs>;
/**
* 招待したいメンバーへ個別の招待URLを発行し、指定したEメールアドレスへ送信します。 このAPIは**team**の**owner**だけがご利用可能です。
* @summary Emailで招待する
* @param {string} teamName チーム名
* @param {InviteBody} inviteBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
invite: (teamName: string, inviteBody: InviteBody, options?: any) => Promise<RequestArgs>;
/**
* 指定されたコメントにStarをします。
* @summary コメントをStarする
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {NewStar} newStar
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
starComment: (teamName: string, commentId: number, newStar: NewStar, options?: any) => Promise<RequestArgs>;
/**
* 指定された記事にStarをします。
* @summary 記事をStarする
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {NewStar} newStar
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
starPost: (teamName: string, postNumber: number, newStar: NewStar, options?: any) => Promise<RequestArgs>;
/**
* 指定されたコメントへのStarを取り消します。
* @summary コメントのStarを取り消す
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
unstarComment: (teamName: string, commentId: number, options?: any) => Promise<RequestArgs>;
/**
* 指定された記事へのStarを取り消します。
* @summary 記事のStarを取り消す
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
unstarPost: (teamName: string, postNumber: number, options?: any) => Promise<RequestArgs>;
/**
* 指定された記事へのWatchを取り消します。
* @summary 記事のWatchを取り消す
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
unwachPost: (teamName: string, postNumber: number, options?: any) => Promise<RequestArgs>;
/**
* 指定されたコメントを更新します。
* @summary コメントを更新する
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {UpdateCommentBody} updateCommentBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateComment: (teamName: string, commentId: number, updateCommentBody: UpdateCommentBody, 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>;
/**
* 指定された記事にWatchをします。
* @summary 記事をWatchする
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
watchPost: (teamName: string, postNumber: number, options?: any) => Promise<RequestArgs>;
};
/**
* EsaApi - functional programming interface
* @export
*/
export declare const EsaApiFp: (configuration?: Configuration) => {
/**
* 指定されたカテゴリを配下のカテゴリを含めて一括で変更します。
* @summary カテゴリを一括移動する
* @param {string} teamName チーム名
* @param {BatchMoveOptions} batchMoveOptions
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
batchMoveCategory(teamName: string, batchMoveOptions: BatchMoveOptions, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BatchMoveResult>>;
/**
* 記事に新しいコメントを作成します。
* @summary コメントを投稿する
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {CreateCommentBody} createCommentBody
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createComment(teamName: string, postNumber: number, createCommentBody: CreateCommentBody, page?: number, perPage?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Comment>>;
/**
* 新しい絵文字を登録します。
* @summary 絵文字を登録する
* @param {string} teamName チーム名
* @param {CreateEmojiBody} createEmojiBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createEmoji(teamName: string, createEmojiBody: CreateEmojiBody, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatedEmoji>>;
/**
*
* @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} commentId コメントID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteComment(teamName: string, commentId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
* 登録したチーム固有の絵文字を削除します。
* @summary 絵文字を削除する
* @param {string} teamName チーム名
* @param {string} code 絵文字コード
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteEmoji(teamName: string, code: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
* 指定した screen_name のメンバーをチームから削除します。 - チームの owner である必要があります - APIで自分自身をチームから削除することはできません。
* @summary メンバーを削除する
* @param {string} teamName チーム名
* @param {string} screenName 削除するメンバーのscreen_name
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteMember(teamName: string, screenName: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
* 指定された記事を削除します。
* @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>>;
/**
* 招待中のメンバーの招待を削除します。招待時に送信されたメールに記載された招待用のURLは無効となります。 このAPIは**team**の**owner**だけがご利用可能です。
* @summary 招待を取り下げる
* @param {string} teamName チーム名
* @param {string} code 招待時の識別子を指定します
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
disinvite(teamName: string, code: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
* 現在のアクセストークンで認証中のユーザーの情報を取得します。
* @summary 認証中のユーザーを取得する
* @param {'teams'} [include] teams を指定すると所属するチームの配列を含んだレスポンスを返します。
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAuthenticatedUser(include?: "teams", options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticatedUser>>;
/**
* 指定されたコメントを取得します。
* @summary コメントを取得する
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {'stargazers'} [include] `stargazers`を指定するとStarの配列を含んだレスポンスを返します。
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getComment(teamName: string, commentId: number, include?: "stargazers", options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Comment>>;
/**
* 指定されたコメントにStarをしたユーザ一覧を取得します。
* @summary コメントのStarを取得する
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCommentStargazers(teamName: string, commentId: number, page?: number, perPage?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedStargazers>>;
/**
* チーム全体のコメント一覧を作成日の降順で返却します。
* @summary コメント一覧を取得する
* @param {string} teamName チーム名
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getComments(teamName: string, page?: number, perPage?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedComments>>;
/**
* チームで利用可能な絵文字を取得します。URIクエリ文字列を含めない場合、チーム固有の絵文字だけを取得します。
* @summary 絵文字一覧を取得する
* @param {string} teamName チーム名
* @param {'all'} [include] `all`を指定すると、チーム固有の絵文字だけではなく、すべての絵文字を返します。
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getEmojis(teamName: string, include?: "all", options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmojiList>>;
/**
* 招待中のメンバーの一覧を取得します。 このAPIは**team**の**owner**だけがご利用可能です。
* @summary 招待中のメンバー一覧を取得する
* @param {string} teamName チーム名
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getInvitations(teamName: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvitationList>>;
/**
*
* @summary メンバーを取得する
* @param {string} teamName チーム名
* @param {'posts_count' | 'joined' | 'last_accessed'} [sort]
* @param {'asc' | 'desc'} [order] 設定可能な値: - `desc`: 降順 (default) - `asc`: 昇順
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMembers(teamName: string, sort?: "posts_count" | "joined" | "last_accessed", order?: "asc" | "desc", page?: number, perPage?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedMembers>>;
/**
* 指定された記事を取得します。
* @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 {number} postNumber 記事ID
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPostComments(teamName: string, postNumber: number, page?: number, perPage?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedComments>>;
/**
* 指定された記事にStarをしたユーザ一覧を取得します。
* @summary 記事のStarを取得する
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPostStargazers(teamName: string, postNumber: number, page?: number, perPage?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedStargazers>>;
/**
*
* @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} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTags(teamName: string, page?: number, perPage?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedTags>>;
/**
*
* @summary 所属するチームを取得する
* @param {string} teamName チーム名
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTeam(teamName: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Team>>;
/**
*
* @summary チームの統計情報を取得する
* @param {string} teamName チーム名
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTeamStats(teamName: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TeamStats>>;
/**
*
* @summary 所属するチーム一覧を取得する
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTeams(page?: number, perPage?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedTeams>>;
/**
* 指定された記事にWatchをしたユーザ一覧を取得します。
* @summary Watchしたユーザー一覧を取得する
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getWatchers(teamName: string, postNumber: number, page?: number, perPage?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedWatchers>>;
/**
* 招待したいメンバーへ個別の招待URLを発行し、指定したEメールアドレスへ送信します。 このAPIは**team**の**owner**だけがご利用可能です。
* @summary Emailで招待する
* @param {string} teamName チーム名
* @param {InviteBody} inviteBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
invite(teamName: string, inviteBody: InviteBody, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvitationList>>;
/**
* 指定されたコメントにStarをします。
* @summary コメントをStarする
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {NewStar} newStar
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
starComment(teamName: string, commentId: number, newStar: NewStar, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
* 指定された記事にStarをします。
* @summary 記事をStarする
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {NewStar} newStar
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
starPost(teamName: string, postNumber: number, newStar: NewStar, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
* 指定されたコメントへのStarを取り消します。
* @summary コメントのStarを取り消す
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
unstarComment(teamName: string, commentId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
* 指定された記事へのStarを取り消します。
* @summary 記事のStarを取り消す
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
unstarPost(teamName: string, postNumber: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
* 指定された記事へのWatchを取り消します。
* @summary 記事のWatchを取り消す
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
unwachPost(teamName: string, postNumber: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
* 指定されたコメントを更新します。
* @summary コメントを更新する
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {UpdateCommentBody} updateCommentBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateComment(teamName: string, commentId: number, updateCommentBody: UpdateCommentBody, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Comment>>;
/**
* 指定された記事を編集します。
* @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>>;
/**
* 指定された記事にWatchをします。
* @summary 記事をWatchする
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
watchPost(teamName: string, postNumber: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
};
/**
* EsaApi - factory interface
* @export
*/
export declare const EsaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* 指定されたカテゴリを配下のカテゴリを含めて一括で変更します。
* @summary カテゴリを一括移動する
* @param {string} teamName チーム名
* @param {BatchMoveOptions} batchMoveOptions
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
batchMoveCategory(teamName: string, batchMoveOptions: BatchMoveOptions, options?: any): AxiosPromise<BatchMoveResult>;
/**
* 記事に新しいコメントを作成します。
* @summary コメントを投稿する
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {CreateCommentBody} createCommentBody
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createComment(teamName: string, postNumber: number, createCommentBody: CreateCommentBody, page?: number, perPage?: number, options?: any): AxiosPromise<Comment>;
/**
* 新しい絵文字を登録します。
* @summary 絵文字を登録する
* @param {string} teamName チーム名
* @param {CreateEmojiBody} createEmojiBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createEmoji(teamName: string, createEmojiBody: CreateEmojiBody, options?: any): AxiosPromise<CreatedEmoji>;
/**
*
* @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} commentId コメントID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteComment(teamName: string, commentId: number, options?: any): AxiosPromise<void>;
/**
* 登録したチーム固有の絵文字を削除します。
* @summary 絵文字を削除する
* @param {string} teamName チーム名
* @param {string} code 絵文字コード
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteEmoji(teamName: string, code: string, options?: any): AxiosPromise<void>;
/**
* 指定した screen_name のメンバーをチームから削除します。 - チームの owner である必要があります - APIで自分自身をチームから削除することはできません。
* @summary メンバーを削除する
* @param {string} teamName チーム名
* @param {string} screenName 削除するメンバーのscreen_name
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteMember(teamName: string, screenName: string, options?: any): AxiosPromise<void>;
/**
* 指定された記事を削除します。
* @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>;
/**
* 招待中のメンバーの招待を削除します。招待時に送信されたメールに記載された招待用のURLは無効となります。 このAPIは**team**の**owner**だけがご利用可能です。
* @summary 招待を取り下げる
* @param {string} teamName チーム名
* @param {string} code 招待時の識別子を指定します
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
disinvite(teamName: string, code: string, options?: any): AxiosPromise<void>;
/**
* 現在のアクセストークンで認証中のユーザーの情報を取得します。
* @summary 認証中のユーザーを取得する
* @param {'teams'} [include] teams を指定すると所属するチームの配列を含んだレスポンスを返します。
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAuthenticatedUser(include?: "teams", options?: any): AxiosPromise<AuthenticatedUser>;
/**
* 指定されたコメントを取得します。
* @summary コメントを取得する
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {'stargazers'} [include] `stargazers`を指定するとStarの配列を含んだレスポンスを返します。
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getComment(teamName: string, commentId: number, include?: "stargazers", options?: any): AxiosPromise<Comment>;
/**
* 指定されたコメントにStarをしたユーザ一覧を取得します。
* @summary コメントのStarを取得する
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCommentStargazers(teamName: string, commentId: number, page?: number, perPage?: number, options?: any): AxiosPromise<PaginatedStargazers>;
/**
* チーム全体のコメント一覧を作成日の降順で返却します。
* @summary コメント一覧を取得する
* @param {string} teamName チーム名
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getComments(teamName: string, page?: number, perPage?: number, options?: any): AxiosPromise<PaginatedComments>;
/**
* チームで利用可能な絵文字を取得します。URIクエリ文字列を含めない場合、チーム固有の絵文字だけを取得します。
* @summary 絵文字一覧を取得する
* @param {string} teamName チーム名
* @param {'all'} [include] `all`を指定すると、チーム固有の絵文字だけではなく、すべての絵文字を返します。
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getEmojis(teamName: string, include?: "all", options?: any): AxiosPromise<EmojiList>;
/**
* 招待中のメンバーの一覧を取得します。 このAPIは**team**の**owner**だけがご利用可能です。
* @summary 招待中のメンバー一覧を取得する
* @param {string} teamName チーム名
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getInvitations(teamName: string, options?: any): AxiosPromise<InvitationList>;
/**
*
* @summary メンバーを取得する
* @param {string} teamName チーム名
* @param {'posts_count' | 'joined' | 'last_accessed'} [sort]
* @param {'asc' | 'desc'} [order] 設定可能な値: - `desc`: 降順 (default) - `asc`: 昇順
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMembers(teamName: string, sort?: "posts_count" | "joined" | "last_accessed", order?: "asc" | "desc", page?: number, perPage?: number, options?: any): AxiosPromise<PaginatedMembers>;
/**
* 指定された記事を取得します。
* @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 {number} postNumber 記事ID
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPostComments(teamName: string, postNumber: number, page?: number, perPage?: number, options?: any): AxiosPromise<PaginatedComments>;
/**
* 指定された記事にStarをしたユーザ一覧を取得します。
* @summary 記事のStarを取得する
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPostStargazers(teamName: string, postNumber: number, page?: number, perPage?: number, options?: any): AxiosPromise<PaginatedStargazers>;
/**
*
* @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} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTags(teamName: string, page?: number, perPage?: number, options?: any): AxiosPromise<PaginatedTags>;
/**
*
* @summary 所属するチームを取得する
* @param {string} teamName チーム名
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTeam(teamName: string, options?: any): AxiosPromise<Team>;
/**
*
* @summary チームの統計情報を取得する
* @param {string} teamName チーム名
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTeamStats(teamName: string, options?: any): AxiosPromise<TeamStats>;
/**
*
* @summary 所属するチーム一覧を取得する
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTeams(page?: number, perPage?: number, options?: any): AxiosPromise<PaginatedTeams>;
/**
* 指定された記事にWatchをしたユーザ一覧を取得します。
* @summary Watchしたユーザー一覧を取得する
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getWatchers(teamName: string, postNumber: number, page?: number, perPage?: number, options?: any): AxiosPromise<PaginatedWatchers>;
/**
* 招待したいメンバーへ個別の招待URLを発行し、指定したEメールアドレスへ送信します。 このAPIは**team**の**owner**だけがご利用可能です。
* @summary Emailで招待する
* @param {string} teamName チーム名
* @param {InviteBody} inviteBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
invite(teamName: string, inviteBody: InviteBody, options?: any): AxiosPromise<InvitationList>;
/**
* 指定されたコメントにStarをします。
* @summary コメントをStarする
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {NewStar} newStar
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
starComment(teamName: string, commentId: number, newStar: NewStar, options?: any): AxiosPromise<void>;
/**
* 指定された記事にStarをします。
* @summary 記事をStarする
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {NewStar} newStar
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
starPost(teamName: string, postNumber: number, newStar: NewStar, options?: any): AxiosPromise<void>;
/**
* 指定されたコメントへのStarを取り消します。
* @summary コメントのStarを取り消す
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
unstarComment(teamName: string, commentId: number, options?: any): AxiosPromise<void>;
/**
* 指定された記事へのStarを取り消します。
* @summary 記事のStarを取り消す
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
unstarPost(teamName: string, postNumber: number, options?: any): AxiosPromise<void>;
/**
* 指定された記事へのWatchを取り消します。
* @summary 記事のWatchを取り消す
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
unwachPost(teamName: string, postNumber: number, options?: any): AxiosPromise<void>;
/**
* 指定されたコメントを更新します。
* @summary コメントを更新する
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {UpdateCommentBody} updateCommentBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateComment(teamName: string, commentId: number, updateCommentBody: UpdateCommentBody, options?: any): AxiosPromise<Comment>;
/**
* 指定された記事を編集します。
* @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>;
/**
* 指定された記事にWatchをします。
* @summary 記事をWatchする
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
watchPost(teamName: string, postNumber: number, options?: any): AxiosPromise<void>;
};
/**
* Request parameters for batchMoveCategory operation in EsaApi.
* @export
* @interface EsaApiBatchMoveCategoryRequest
*/
export interface EsaApiBatchMoveCategoryRequest {
/**
* チーム名
* @type {string}
* @memberof EsaApiBatchMoveCategory
*/
readonly teamName: string;
/**
*
* @type {BatchMoveOptions}
* @memberof EsaApiBatchMoveCategory
*/
readonly batchMoveOptions: BatchMoveOptions;
}
/**
* Request parameters for createComment operation in EsaApi.
* @export
* @interface EsaApiCreateCommentRequest
*/
export interface EsaApiCreateCommentRequest {
/**
* チーム名
* @type {string}
* @memberof EsaApiCreateComment
*/
readonly teamName: string;
/**
* 記事ID
* @type {number}
* @memberof EsaApiCreateComment
*/
readonly postNumber: number;
/**
*
* @type {CreateCommentBody}
* @memberof EsaApiCreateComment
*/
readonly createCommentBody: CreateCommentBody;
/**
* ページ番号
* @type {number}
* @memberof EsaApiCreateComment
*/
readonly page?: number;
/**
* 1ページあたりに含まれる要素数
* @type {number}
* @memberof EsaApiCreateComment
*/
readonly perPage?: number;
}
/**
* Request parameters for createEmoji operation in EsaApi.
* @export
* @interface EsaApiCreateEmojiRequest
*/
export interface EsaApiCreateEmojiRequest {
/**
* チーム名
* @type {string}
* @memberof EsaApiCreateEmoji
*/
readonly teamName: string;
/**
*
* @type {CreateEmojiBody}
* @memberof EsaApiCreateEmoji
*/
readonly createEmojiBody: CreateEmojiBody;
}
/**
* Request parameters for createPost operation in EsaApi.
* @export
* @interface EsaApiCreatePostRequest
*/
export interface EsaApiCreatePostRequest {
/**
* チーム名
* @type {string}
* @memberof EsaApiCreatePost
*/
readonly teamName: string;
/**
*
* @type {CreatePostBody}
* @memberof EsaApiCreatePost
*/
readonly createPostBody: CreatePostBody;
}
/**
* Request parameters for deleteComment operation in EsaApi.
* @export
* @interface EsaApiDeleteCommentRequest
*/
export interface EsaApiDeleteCommentRequest {
/**
* チーム名
* @type {string}
* @memberof EsaApiDeleteComment
*/
readonly teamName: string;
/**
* コメントID
* @type {number}
* @memberof EsaApiDeleteComment
*/
readonly commentId: number;
}
/**
* Request parameters for deleteEmoji operation in EsaApi.
* @export
* @interface EsaApiDeleteEmojiRequest
*/
export interface EsaApiDeleteEmojiRequest {
/**
* チーム名
* @type {string}
* @memberof EsaApiDeleteEmoji
*/
readonly teamName: string;
/**
* 絵文字コード
* @type {string}
* @memberof EsaApiDeleteEmoji
*/
readonly code: string;
}
/**
* Request parameters for de