Function EsaApiFactory

Returns {
    batchMoveCategory(teamName, batchMoveOptions, options?) => AxiosPromise<BatchMoveResult>;
    createComment(teamName, postNumber, createCommentBody, page?, perPage?, options?) => AxiosPromise<Comment>;
    createEmoji(teamName, createEmojiBody, options?) => AxiosPromise<CreatedEmoji>;
    createPost(teamName, createPostBody, options?) => AxiosPromise<Post>;
    deleteComment(teamName, commentId, options?) => AxiosPromise<void>;
    deleteEmoji(teamName, code, options?) => AxiosPromise<void>;
    deleteMember(teamName, screenName, options?) => AxiosPromise<void>;
    deletePost(teamName, postNumber, options?) => AxiosPromise<void>;
    disinvite(teamName, code, options?) => AxiosPromise<void>;
    getAuthenticatedUser(include?, options?) => AxiosPromise<AuthenticatedUser>;
    getComment(teamName, commentId, include?, options?) => AxiosPromise<Comment>;
    getCommentStargazers(teamName, commentId, page?, perPage?, options?) => AxiosPromise<PaginatedStargazers>;
    getComments(teamName, page?, perPage?, options?) => AxiosPromise<PaginatedComments>;
    getEmojis(teamName, include?, options?) => AxiosPromise<EmojiList>;
    getInvitations(teamName, options?) => AxiosPromise<InvitationList>;
    getMembers(teamName, sort?, order?, page?, perPage?, options?) => AxiosPromise<PaginatedMembers>;
    getPost(teamName, postNumber, include?, options?) => AxiosPromise<Post>;
    getPostComments(teamName, postNumber, page?, perPage?, options?) => AxiosPromise<PaginatedComments>;
    getPostStargazers(teamName, postNumber, page?, perPage?, options?) => AxiosPromise<PaginatedStargazers>;
    getPosts(teamName, q?, include?, sort?, order?, page?, perPage?, options?) => AxiosPromise<PaginatedPosts>;
    getTags(teamName, page?, perPage?, options?) => AxiosPromise<PaginatedTags>;
    getTeam(teamName, options?) => AxiosPromise<Team>;
    getTeamStats(teamName, options?) => AxiosPromise<TeamStats>;
    getTeams(page?, perPage?, options?) => AxiosPromise<PaginatedTeams>;
    getWatchers(teamName, postNumber, page?, perPage?, options?) => AxiosPromise<PaginatedWatchers>;
    invite(teamName, inviteBody, options?) => AxiosPromise<InvitationList>;
    starComment(teamName, commentId, newStar, options?) => AxiosPromise<void>;
    starPost(teamName, postNumber, newStar, options?) => AxiosPromise<void>;
    unstarComment(teamName, commentId, options?) => AxiosPromise<void>;
    unstarPost(teamName, postNumber, options?) => AxiosPromise<void>;
    unwachPost(teamName, postNumber, options?) => AxiosPromise<void>;
    updateComment(teamName, commentId, updateCommentBody, options?) => AxiosPromise<Comment>;
    updatePost(teamName, postNumber, updatePostBody, options?) => AxiosPromise<Post>;
    watchPost(teamName, postNumber, options?) => AxiosPromise<void>;
}

• batchMoveCategory:function

  • batchMoveCategory(teamName, batchMoveOptions, options?): AxiosPromise<BatchMoveResult>

  • 指定されたカテゴリを配下のカテゴリを含めて一括で変更します。

    Parameters

    • teamName: string

      チーム名

    • batchMoveOptions: BatchMoveOptions

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<BatchMoveResult>

    Summary

    カテゴリを一括移動する

    Throws

• createComment:function

  • createComment(teamName, postNumber, createCommentBody, page?, perPage?, options?): AxiosPromise<Comment>

  • 記事に新しいコメントを作成します。

    Parameters

    • teamName: string

      チーム名

    • postNumber: number

      記事ID

    • createCommentBody: CreateCommentBody

    • Optional page: number

      ページ番号

    • Optional perPage: number

      1ページあたりに含まれる要素数

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<Comment>

    Summary

    コメントを投稿する

    Throws

• createEmoji:function

  • createEmoji(teamName, createEmojiBody, options?): AxiosPromise<CreatedEmoji>

  • 新しい絵文字を登録します。

    Parameters

    • teamName: string

      チーム名

    • createEmojiBody: CreateEmojiBody

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<CreatedEmoji>

    Summary

    絵文字を登録する

    Throws

• createPost:function

  • createPost(teamName, createPostBody, options?): AxiosPromise<Post>

  • Parameters

    • teamName: string

      チーム名

    • createPostBody: CreatePostBody

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<Post>

    Summary

    記事を投稿する

    Throws

• deleteComment:function

  • deleteComment(teamName, commentId, options?): AxiosPromise<void>

  • 指定されたコメントを削除します。

    Parameters

    • teamName: string

      チーム名

    • commentId: number

      コメントID

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    コメントを削除する

    Throws

• deleteEmoji:function

  • deleteEmoji(teamName, code, options?): AxiosPromise<void>

  • 登録したチーム固有の絵文字を削除します。

    Parameters

    • teamName: string

      チーム名

    • code: string

      絵文字コード

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    絵文字を削除する

    Throws

• deleteMember:function

  • deleteMember(teamName, screenName, options?): AxiosPromise<void>

  • 指定した screen_name のメンバーをチームから削除します。 - チームの owner である必要があります - APIで自分自身をチームから削除することはできません。

    Parameters

    • teamName: string

      チーム名

    • screenName: string

      削除するメンバーのscreen_name

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    メンバーを削除する

    Throws

• deletePost:function

  • deletePost(teamName, postNumber, options?): AxiosPromise<void>

  • 指定された記事を削除します。

    Parameters

    • teamName: string

      チーム名

    • postNumber: number

      記事ID

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    記事を削除する

    Throws

• disinvite:function

  • disinvite(teamName, code, options?): AxiosPromise<void>

  • 招待中のメンバーの招待を削除します。招待時に送信されたメールに記載された招待用のURLは無効となります。 このAPIはteamのownerだけがご利用可能です。

    Parameters

    • teamName: string

      チーム名

    • code: string

      招待時の識別子を指定します

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    招待を取り下げる

    Throws

• getAuthenticatedUser:function

  • getAuthenticatedUser(include?, options?): AxiosPromise<AuthenticatedUser>

  • 現在のアクセストークンで認証中のユーザーの情報を取得します。

    Parameters

    • Optional include: "teams"

      teams を指定すると所属するチームの配列を含んだレスポンスを返します。

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<AuthenticatedUser>

    Summary

    認証中のユーザーを取得する

    Throws

• getComment:function

  • getComment(teamName, commentId, include?, options?): AxiosPromise<Comment>

  • 指定されたコメントを取得します。

    Parameters

    • teamName: string

      チーム名

    • commentId: number

      コメントID

    • Optional include: "stargazers"

      `stargazers`を指定するとStarの配列を含んだレスポンスを返します。

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<Comment>

    Summary

    コメントを取得する

    Throws

• getCommentStargazers:function

  • getCommentStargazers(teamName, commentId, page?, perPage?, options?): AxiosPromise<PaginatedStargazers>

  • 指定されたコメントにStarをしたユーザ一覧を取得します。

    Parameters

    • teamName: string

      チーム名

    • commentId: number

      コメントID

    • Optional page: number

      ページ番号

    • Optional perPage: number

      1ページあたりに含まれる要素数

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<PaginatedStargazers>

    Summary

    コメントのStarを取得する

    Throws

• getComments:function

  • getComments(teamName, page?, perPage?, options?): AxiosPromise<PaginatedComments>

  • チーム全体のコメント一覧を作成日の降順で返却します。

    Parameters

    • teamName: string

      チーム名

    • Optional page: number

      ページ番号

    • Optional perPage: number

      1ページあたりに含まれる要素数

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<PaginatedComments>

    Summary

    コメント一覧を取得する

    Throws

• getEmojis:function

  • getEmojis(teamName, include?, options?): AxiosPromise<EmojiList>

  • チームで利用可能な絵文字を取得します。URIクエリ文字列を含めない場合、チーム固有の絵文字だけを取得します。

    Parameters

    • teamName: string

      チーム名

    • Optional include: "all"

      `all`を指定すると、チーム固有の絵文字だけではなく、すべての絵文字を返します。

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<EmojiList>

    Summary

    絵文字一覧を取得する

    Throws

• getInvitations:function

  • getInvitations(teamName, options?): AxiosPromise<InvitationList>

  • 招待中のメンバーの一覧を取得します。 このAPIはteamのownerだけがご利用可能です。

    Parameters

    • teamName: string

      チーム名

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<InvitationList>

    Summary

    招待中のメンバー一覧を取得する

    Throws

• getMembers:function

  • getMembers(teamName, sort?, order?, page?, perPage?, options?): AxiosPromise<PaginatedMembers>

  • Parameters

    • teamName: string

      チーム名

    • Optional sort: "posts_count" | "joined" | "last_accessed"

    • Optional order: "asc" | "desc"

      設定可能な値: - `desc`: 降順 (default) - `asc`: 昇順

    • Optional page: number

      ページ番号

    • Optional perPage: number

      1ページあたりに含まれる要素数

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<PaginatedMembers>

    Summary

    メンバーを取得する

    Throws

• getPost:function

  • getPost(teamName, postNumber, include?, options?): AxiosPromise<Post>

  • 指定された記事を取得します。

    Parameters

    • teamName: string

      チーム名

    • postNumber: number

      記事ID

    • Optional include: ("stargazers" | "comments" | "comments.stargazers")[]

      `comments` を指定するとコメントの配列を含んだレスポンスを返します。 - `comments,comments.stargazers`を指定するとコメントとコメントに対するStarの配列を含んだレスポンスを返します。 - `stargazers` を指定するとStarの配列を含んだレスポンスを返します。 - `stargazers,comments` のように `,` で区切ることで複数指定できます

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<Post>

    Summary

    記事を取得する

    Throws

• getPostComments:function

  • getPostComments(teamName, postNumber, page?, perPage?, options?): AxiosPromise<PaginatedComments>

  • 記事のコメント一覧を更新日の降順で返却します。

    Parameters

    • teamName: string

      チーム名

    • postNumber: number

      記事ID

    • Optional page: number

      ページ番号

    • Optional perPage: number

      1ページあたりに含まれる要素数

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<PaginatedComments>

    Summary

    記事のコメント一覧を取得する

    Throws

• getPostStargazers:function

  • getPostStargazers(teamName, postNumber, page?, perPage?, options?): AxiosPromise<PaginatedStargazers>

  • 指定された記事にStarをしたユーザ一覧を取得します。

    Parameters

    • teamName: string

      チーム名

    • postNumber: number

      記事ID

    • Optional page: number

      ページ番号

    • Optional perPage: number

      1ページあたりに含まれる要素数

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<PaginatedStargazers>

    Summary

    記事のStarを取得する

    Throws

• getPosts:function

  • getPosts(teamName, q?, include?, sort?, order?, page?, perPage?, options?): AxiosPromise<PaginatedPosts>

  • Parameters

    • teamName: string

      チーム名

    • Optional q: string

      記事を絞り込むための条件を指定します

    • Optional include: ("stargazers" | "comments" | "comments.stargazers")[]

      `comments` を指定するとコメントの配列を含んだレスポンスを返します。 - `comments,comments.stargazers`を指定するとコメントとコメントに対するStarの配列を含んだレスポンスを返します。 - `stargazers` を指定するとStarの配列を含んだレスポンスを返します。 - `stargazers,comments` のように `,` で区切ることで複数指定できます

    • Optional sort: "number" | "comments" | "updated" | "created" | "stars" | "watches" | "best_match"

      記事の並び順を指定します - 設定可能な値 - `updated` (default) - 記事の更新日時 - `created` - 記事の作成日時 - `number` - 記事番号 - `stars` - 記事へのStarの数 - `watches` - 記事へのWatchの数 - `comments` - 記事へのCommentの数 - `best_match` - 総合的な記事のスコア

    • Optional order: "asc" | "desc"

      設定可能な値: - `desc`: 降順 (default) - `asc`: 昇順

    • Optional page: number

      ページ番号

    • Optional perPage: number

      1ページあたりに含まれる要素数

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<PaginatedPosts>

    Summary

    記事一覧を取得する

    Throws

• getTags:function

  • getTags(teamName, page?, perPage?, options?): AxiosPromise<PaginatedTags>

  • Parameters

    • teamName: string

      チーム名

    • Optional page: number

      ページ番号

    • Optional perPage: number

      1ページあたりに含まれる要素数

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<PaginatedTags>

    Summary

    タグ一覧をタグ付けされた記事数の降順で取得する

    Throws

• getTeam:function

  • getTeam(teamName, options?): AxiosPromise<Team>

  • Parameters

    • teamName: string

      チーム名

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<Team>

    Summary

    所属するチームを取得する

    Throws

• getTeamStats:function

  • getTeamStats(teamName, options?): AxiosPromise<TeamStats>

  • Parameters

    • teamName: string

      チーム名

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<TeamStats>

    Summary

    チームの統計情報を取得する

    Throws

• getTeams:function

  • getTeams(page?, perPage?, options?): AxiosPromise<PaginatedTeams>

  • Parameters

    • Optional page: number

      ページ番号

    • Optional perPage: number

      1ページあたりに含まれる要素数

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<PaginatedTeams>

    Summary

    所属するチーム一覧を取得する

    Throws

• getWatchers:function

  • getWatchers(teamName, postNumber, page?, perPage?, options?): AxiosPromise<PaginatedWatchers>

  • 指定された記事にWatchをしたユーザ一覧を取得します。

    Parameters

    • teamName: string

      チーム名

    • postNumber: number

      記事ID

    • Optional page: number

      ページ番号

    • Optional perPage: number

      1ページあたりに含まれる要素数

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<PaginatedWatchers>

    Summary

    Watchしたユーザー一覧を取得する

    Throws

• invite:function

  • invite(teamName, inviteBody, options?): AxiosPromise<InvitationList>

  • 招待したいメンバーへ個別の招待URLを発行し、指定したEメールアドレスへ送信します。 このAPIはteamのownerだけがご利用可能です。

    Parameters

    • teamName: string

      チーム名

    • inviteBody: InviteBody

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<InvitationList>

    Summary

    Emailで招待する

    Throws

• starComment:function

  • starComment(teamName, commentId, newStar, options?): AxiosPromise<void>

  • 指定されたコメントにStarをします。

    Parameters

    • teamName: string

      チーム名

    • commentId: number

      コメントID

    • newStar: NewStar

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    コメントをStarする

    Throws

• starPost:function

  • starPost(teamName, postNumber, newStar, options?): AxiosPromise<void>

  • 指定された記事にStarをします。

    Parameters

    • teamName: string

      チーム名

    • postNumber: number

      記事ID

    • newStar: NewStar

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    記事をStarする

    Throws

• unstarComment:function

  • unstarComment(teamName, commentId, options?): AxiosPromise<void>

  • 指定されたコメントへのStarを取り消します。

    Parameters

    • teamName: string

      チーム名

    • commentId: number

      コメントID

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    コメントのStarを取り消す

    Throws

• unstarPost:function

  • unstarPost(teamName, postNumber, options?): AxiosPromise<void>

  • 指定された記事へのStarを取り消します。

    Parameters

    • teamName: string

      チーム名

    • postNumber: number

      記事ID

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    記事のStarを取り消す

    Throws

• unwachPost:function

  • unwachPost(teamName, postNumber, options?): AxiosPromise<void>

  • 指定された記事へのWatchを取り消します。

    Parameters

    • teamName: string

      チーム名

    • postNumber: number

      記事ID

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    記事のWatchを取り消す

    Throws

• updateComment:function

  • updateComment(teamName, commentId, updateCommentBody, options?): AxiosPromise<Comment>

  • 指定されたコメントを更新します。

    Parameters

    • teamName: string

      チーム名

    • commentId: number

      コメントID

    • updateCommentBody: UpdateCommentBody

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<Comment>

    Summary

    コメントを更新する

    Throws

• updatePost:function

  • updatePost(teamName, postNumber, updatePostBody, options?): AxiosPromise<Post>

  • 指定された記事を編集します。

    Parameters

    • teamName: string

      チーム名

    • postNumber: number

      記事ID

    • updatePostBody: UpdatePostBody

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<Post>

    Summary

    記事を編集する

    Throws

• watchPost:function

  • watchPost(teamName, postNumber, options?): AxiosPromise<void>

  • 指定された記事にWatchをします。

    Parameters

    • teamName: string

      チーム名

    • postNumber: number

      記事ID

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    記事をWatchする

    Throws