Function MemberApiFactory

  • MemberApi - factory interface

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns {
        deleteMember(teamName, screenName, options?) => AxiosPromise<void>;
        getMembers(teamName, sort?, order?, page?, perPage?, options?) => AxiosPromise<PaginatedMembers>;
    }

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

        Parameters

        • teamName: string

          チーム名

        • screenName: string

          削除するメンバーのscreen_name

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<void>

        Summary

        メンバーを削除する

        Throws

    • getMembers:function
      • 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

    Export

Generated using TypeDoc