Function CommentApiAxiosParamCreator

  • CommentApi - axios parameter creator

    Parameters

    Returns {
        createComment: ((teamName, postNumber, createCommentBody, page?, perPage?, options?) => Promise<RequestArgs>);
        deleteComment: ((teamName, commentId, options?) => Promise<RequestArgs>);
        getComment: ((teamName, commentId, include?, options?) => Promise<RequestArgs>);
        getComments: ((teamName, page?, perPage?, options?) => Promise<RequestArgs>);
        getPostComments: ((teamName, postNumber, page?, perPage?, options?) => Promise<RequestArgs>);
        updateComment: ((teamName, commentId, updateCommentBody, options?) => Promise<RequestArgs>);
    }

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    Export

Generated using TypeDoc