Function PostApiAxiosParamCreator

Returns {
    createPost: ((teamName, createPostBody, options?) => Promise<RequestArgs>);
    deletePost: ((teamName, postNumber, options?) => Promise<RequestArgs>);
    getPost: ((teamName, postNumber, include?, options?) => Promise<RequestArgs>);
    getPosts: ((teamName, q?, include?, sort?, order?, page?, perPage?, options?) => Promise<RequestArgs>);
    updatePost: ((teamName, postNumber, updatePostBody, options?) => Promise<RequestArgs>);
}

• 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

• 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

• 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

• 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

• 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