Function InvitationApiAxiosParamCreator

  • InvitationApi - axios parameter creator

    Parameters

    Returns {
        disinvite: ((teamName, code, options?) => Promise<RequestArgs>);
        getInvitations: ((teamName, options?) => Promise<RequestArgs>);
        invite: ((teamName, inviteBody, options?) => Promise<RequestArgs>);
    }

    • disinvite: ((teamName, code, options?) => Promise<RequestArgs>)
        • (teamName, code, options?): Promise<RequestArgs>
        • 招待中のメンバーの招待を削除します。招待時に送信されたメールに記載された招待用のURLは無効となります。 このAPIはteamownerだけがご利用可能です。

          Parameters

          • teamName: string

            チーム名

          • code: string

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

          • Optional options: any = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          招待を取り下げる

          Throws

    • getInvitations: ((teamName, options?) => Promise<RequestArgs>)
        • (teamName, options?): Promise<RequestArgs>
        • 招待中のメンバーの一覧を取得します。 このAPIはteamownerだけがご利用可能です。

          Parameters

          • teamName: string

            チーム名

          • Optional options: any = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

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

          Throws

    • invite: ((teamName, inviteBody, options?) => Promise<RequestArgs>)
        • (teamName, inviteBody, options?): Promise<RequestArgs>
        • 招待したいメンバーへ個別の招待URLを発行し、指定したEメールアドレスへ送信します。 このAPIはteamownerだけがご利用可能です。

          Parameters

          • teamName: string

            チーム名

          • inviteBody: InviteBody
          • Optional options: any = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          Emailで招待する

          Throws

    Export

Generated using TypeDoc