Function MemberApiAxiosParamCreator

  • MemberApi - axios parameter creator

    Parameters

    Returns {
        deleteMember: ((teamName, screenName, options?) => Promise<RequestArgs>);
        getMembers: ((teamName, sort?, order?, page?, perPage?, options?) => Promise<RequestArgs>);
    }

    • 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

    • 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

    Export

Generated using TypeDoc