Function EsaApiAxiosParamCreator

Returns {
    batchMoveCategory: ((teamName, batchMoveOptions, options?) => Promise<RequestArgs>);
    createComment: ((teamName, postNumber, createCommentBody, page?, perPage?, options?) => Promise<RequestArgs>);
    createEmoji: ((teamName, createEmojiBody, options?) => Promise<RequestArgs>);
    createPost: ((teamName, createPostBody, options?) => Promise<RequestArgs>);
    deleteComment: ((teamName, commentId, options?) => Promise<RequestArgs>);
    deleteEmoji: ((teamName, code, options?) => Promise<RequestArgs>);
    deleteMember: ((teamName, screenName, options?) => Promise<RequestArgs>);
    deletePost: ((teamName, postNumber, options?) => Promise<RequestArgs>);
    disinvite: ((teamName, code, options?) => Promise<RequestArgs>);
    getAuthenticatedUser: ((include?, options?) => Promise<RequestArgs>);
    getComment: ((teamName, commentId, include?, options?) => Promise<RequestArgs>);
    getCommentStargazers: ((teamName, commentId, page?, perPage?, options?) => Promise<RequestArgs>);
    getComments: ((teamName, page?, perPage?, options?) => Promise<RequestArgs>);
    getEmojis: ((teamName, include?, options?) => Promise<RequestArgs>);
    getInvitations: ((teamName, options?) => Promise<RequestArgs>);
    getMembers: ((teamName, sort?, order?, page?, perPage?, options?) => Promise<RequestArgs>);
    getPost: ((teamName, postNumber, include?, options?) => Promise<RequestArgs>);
    getPostComments: ((teamName, postNumber, page?, perPage?, options?) => Promise<RequestArgs>);
    getPostStargazers: ((teamName, postNumber, page?, perPage?, options?) => Promise<RequestArgs>);
    getPosts: ((teamName, q?, include?, sort?, order?, page?, perPage?, options?) => Promise<RequestArgs>);
    getTags: ((teamName, page?, perPage?, options?) => Promise<RequestArgs>);
    getTeam: ((teamName, options?) => Promise<RequestArgs>);
    getTeamStats: ((teamName, options?) => Promise<RequestArgs>);
    getTeams: ((page?, perPage?, options?) => Promise<RequestArgs>);
    getWatchers: ((teamName, postNumber, page?, perPage?, options?) => Promise<RequestArgs>);
    invite: ((teamName, inviteBody, options?) => Promise<RequestArgs>);
    starComment: ((teamName, commentId, newStar, options?) => Promise<RequestArgs>);
    starPost: ((teamName, postNumber, newStar, options?) => Promise<RequestArgs>);
    unstarComment: ((teamName, commentId, options?) => Promise<RequestArgs>);
    unstarPost: ((teamName, postNumber, options?) => Promise<RequestArgs>);
    unwachPost: ((teamName, postNumber, options?) => Promise<RequestArgs>);
    updateComment: ((teamName, commentId, updateCommentBody, options?) => Promise<RequestArgs>);
    updatePost: ((teamName, postNumber, updatePostBody, options?) => Promise<RequestArgs>);
    watchPost: ((teamName, postNumber, options?) => Promise<RequestArgs>);
}

• batchMoveCategory: ((teamName, batchMoveOptions, options?) => Promise<RequestArgs>)

  • • (teamName, batchMoveOptions, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • batchMoveOptions: BatchMoveOptions

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      カテゴリを一括移動する

      Throws

• createComment: ((teamName, postNumber, createCommentBody, page?, perPage?, options?) => Promise<RequestArgs>)

  • • (teamName, postNumber, createCommentBody, page?, perPage?, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • postNumber: number

        記事ID

      • createCommentBody: CreateCommentBody

      • Optional page: number

        ページ番号

      • Optional perPage: number

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

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      コメントを投稿する

      Throws

• createEmoji: ((teamName, createEmojiBody, options?) => Promise<RequestArgs>)

  • • (teamName, createEmojiBody, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • createEmojiBody: CreateEmojiBody

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      絵文字を登録する

      Throws

• createPost: ((teamName, createPostBody, options?) => Promise<RequestArgs>)

  • • (teamName, createPostBody, options?): Promise<RequestArgs>

    • Parameters

      • teamName: string

        チーム名

      • createPostBody: CreatePostBody

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      記事を投稿する

      Throws

• deleteComment: ((teamName, commentId, options?) => Promise<RequestArgs>)

  • • (teamName, commentId, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • commentId: number

        コメントID

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      コメントを削除する

      Throws

• deleteEmoji: ((teamName, code, options?) => Promise<RequestArgs>)

  • • (teamName, code, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • code: string

        絵文字コード

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      絵文字を削除する

      Throws

• deleteMember: ((teamName, screenName, options?) => Promise<RequestArgs>)

  • • (teamName, screenName, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • screenName: string

        削除するメンバーのscreen_name

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      メンバーを削除する

      Throws

• deletePost: ((teamName, postNumber, options?) => Promise<RequestArgs>)

  • • (teamName, postNumber, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • postNumber: number

        記事ID

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      記事を削除する

      Throws

• disinvite: ((teamName, code, options?) => Promise<RequestArgs>)

  • • (teamName, code, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • code: string

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

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      招待を取り下げる

      Throws

• getAuthenticatedUser: ((include?, options?) => Promise<RequestArgs>)

  • • (include?, options?): Promise<RequestArgs>

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

      Parameters

      • Optional include: "teams"

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

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

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

      Throws

• getComment: ((teamName, commentId, include?, options?) => Promise<RequestArgs>)

  • • (teamName, commentId, include?, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • commentId: number

        コメントID

      • Optional include: "stargazers"

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

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      コメントを取得する

      Throws

• getCommentStargazers: ((teamName, commentId, page?, perPage?, options?) => Promise<RequestArgs>)

  • • (teamName, commentId, page?, perPage?, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • commentId: number

        コメントID

      • Optional page: number

        ページ番号

      • Optional perPage: number

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

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      コメントのStarを取得する

      Throws

• getComments: ((teamName, page?, perPage?, options?) => Promise<RequestArgs>)

  • • (teamName, page?, perPage?, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • Optional page: number

        ページ番号

      • Optional perPage: number

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

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      コメント一覧を取得する

      Throws

• getEmojis: ((teamName, include?, options?) => Promise<RequestArgs>)

  • • (teamName, include?, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • Optional include: "all"

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

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      絵文字一覧を取得する

      Throws

• getInvitations: ((teamName, options?) => Promise<RequestArgs>)

  • • (teamName, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

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

      Throws

• getMembers: ((teamName, sort?, order?, page?, perPage?, options?) => Promise<RequestArgs>)

  • • (teamName, sort?, order?, page?, perPage?, options?): Promise<RequestArgs>

    • 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 Promise<RequestArgs>

      Summary

      メンバーを取得する

      Throws

• getPost: ((teamName, postNumber, include?, options?) => Promise<RequestArgs>)

  • • (teamName, postNumber, include?, options?): Promise<RequestArgs>

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

      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 Promise<RequestArgs>

      Summary

      記事を取得する

      Throws

• getPostComments: ((teamName, postNumber, page?, perPage?, options?) => Promise<RequestArgs>)

  • • (teamName, postNumber, page?, perPage?, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • postNumber: number

        記事ID

      • Optional page: number

        ページ番号

      • Optional perPage: number

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

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

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

      Throws

• getPostStargazers: ((teamName, postNumber, page?, perPage?, options?) => Promise<RequestArgs>)

  • • (teamName, postNumber, page?, perPage?, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • postNumber: number

        記事ID

      • Optional page: number

        ページ番号

      • Optional perPage: number

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

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      記事のStarを取得する

      Throws

• getPosts: ((teamName, q?, include?, sort?, order?, page?, perPage?, options?) => Promise<RequestArgs>)

  • • (teamName, q?, include?, sort?, order?, page?, perPage?, options?): Promise<RequestArgs>

    • 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 Promise<RequestArgs>

      Summary

      記事一覧を取得する

      Throws

• getTags: ((teamName, page?, perPage?, options?) => Promise<RequestArgs>)

  • • (teamName, page?, perPage?, options?): Promise<RequestArgs>

    • Parameters

      • teamName: string

        チーム名

      • Optional page: number

        ページ番号

      • Optional perPage: number

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

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

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

      Throws

• getTeam: ((teamName, options?) => Promise<RequestArgs>)

  • • (teamName, options?): Promise<RequestArgs>

    • Parameters

      • teamName: string

        チーム名

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

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

      Throws

• getTeamStats: ((teamName, options?) => Promise<RequestArgs>)

  • • (teamName, options?): Promise<RequestArgs>

    • Parameters

      • teamName: string

        チーム名

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

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

      Throws

• getTeams: ((page?, perPage?, options?) => Promise<RequestArgs>)

  • • (page?, perPage?, options?): Promise<RequestArgs>

    • Parameters

      • Optional page: number

        ページ番号

      • Optional perPage: number

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

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

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

      Throws

• getWatchers: ((teamName, postNumber, page?, perPage?, options?) => Promise<RequestArgs>)

  • • (teamName, postNumber, page?, perPage?, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • postNumber: number

        記事ID

      • Optional page: number

        ページ番号

      • Optional perPage: number

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

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

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

      Throws

• invite: ((teamName, inviteBody, options?) => Promise<RequestArgs>)

  • • (teamName, inviteBody, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • inviteBody: InviteBody

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Emailで招待する

      Throws

• starComment: ((teamName, commentId, newStar, options?) => Promise<RequestArgs>)

  • • (teamName, commentId, newStar, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • commentId: number

        コメントID

      • newStar: NewStar

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      コメントをStarする

      Throws

• starPost: ((teamName, postNumber, newStar, options?) => Promise<RequestArgs>)

  • • (teamName, postNumber, newStar, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • postNumber: number

        記事ID

      • newStar: NewStar

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      記事をStarする

      Throws

• unstarComment: ((teamName, commentId, options?) => Promise<RequestArgs>)

  • • (teamName, commentId, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • commentId: number

        コメントID

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      コメントのStarを取り消す

      Throws

• unstarPost: ((teamName, postNumber, options?) => Promise<RequestArgs>)

  • • (teamName, postNumber, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • postNumber: number

        記事ID

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      記事のStarを取り消す

      Throws

• unwachPost: ((teamName, postNumber, options?) => Promise<RequestArgs>)

  • • (teamName, postNumber, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • postNumber: number

        記事ID

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      記事のWatchを取り消す

      Throws

• updateComment: ((teamName, commentId, updateCommentBody, options?) => Promise<RequestArgs>)

  • • (teamName, commentId, updateCommentBody, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • commentId: number

        コメントID

      • updateCommentBody: UpdateCommentBody

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      コメントを更新する

      Throws

• updatePost: ((teamName, postNumber, updatePostBody, options?) => Promise<RequestArgs>)

  • • (teamName, postNumber, updatePostBody, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • postNumber: number

        記事ID

      • updatePostBody: UpdatePostBody

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      記事を編集する

      Throws

• watchPost: ((teamName, postNumber, options?) => Promise<RequestArgs>)

  • • (teamName, postNumber, options?): Promise<RequestArgs>

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

      Parameters

      • teamName: string

        チーム名

      • postNumber: number

        記事ID

      • Optional options: any = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      記事をWatchする

      Throws