Function InvitationApiFp

Returns {
    disinvite(teamName, code, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    getInvitations(teamName, options?) => Promise<((axios?, basePath?) => AxiosPromise<InvitationList>)>;
    invite(teamName, inviteBody, options?) => Promise<((axios?, basePath?) => AxiosPromise<InvitationList>)>;
}

• disinvite:function

  • disinvite(teamName, code, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

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

    Parameters

    • teamName: string

      チーム名

    • code: string

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

    • Optional options: any

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    招待を取り下げる

    Throws

• getInvitations:function

  • getInvitations(teamName, options?): Promise<((axios?, basePath?) => AxiosPromise<InvitationList>)>

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

    Parameters

    • teamName: string

      チーム名

    • Optional options: any

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<InvitationList>)>

    Summary

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

    Throws

• invite:function

  • invite(teamName, inviteBody, options?): Promise<((axios?, basePath?) => AxiosPromise<InvitationList>)>

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

    Parameters

    • teamName: string

      チーム名

    • inviteBody: InviteBody

    • Optional options: any

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<InvitationList>)>

    Summary

    Emailで招待する

    Throws