Class TeamAPI

constructor

• new TeamAPI(httpRequest): TeamAPI

• Parameters

  • httpRequest: BaseHttpRequest

  Returns TeamAPI

Readonly httpRequest

completeInviteFlow

• completeInviteFlow(__namedParameters): CancelablePromise<CompleteInviteFlowResponse>

• Complete Invite Flow Completes the invitation flow by validating the auth provider user ID, invite token and cementing the users's membership in the team

  Parameters

  • __namedParameters: {
        requestBody: CompleteInviteFlowBody;
    }

    • requestBody: CompleteInviteFlowBody

  Returns CancelablePromise<CompleteInviteFlowResponse>

  CompleteInviteFlowResponse

  Throws

  ApiError

exchangeTokenForEmail

• exchangeTokenForEmail(__namedParameters): CancelablePromise<ExchangeTokenForDetailsResponse>

• Exchange token for email Exchange token for email

  Parameters

  • __namedParameters: {
        token: string;
    }

    • token: string

      Team invite token

  Returns CancelablePromise<ExchangeTokenForDetailsResponse>

  ExchangeTokenForDetailsResponse

  Throws

  ApiError

inviteTeamMember

• inviteTeamMember(__namedParameters): CancelablePromise<TeamInviteResponse>

• Invite Team Member Invite a person to join your team. This operation sends an invite via email to the person.

  Parameters

  • __namedParameters: {
        requestBody: InviteTeamMemberRequestBody;
    }

    • requestBody: InviteTeamMemberRequestBody

  Returns CancelablePromise<TeamInviteResponse>

  TeamInviteResponse

  Throws

  ApiError

listTeamMembers

• listTeamMembers(): CancelablePromise<ListTeamMembersResponse>

• List Team Members Get all team members in your account

  Returns CancelablePromise<ListTeamMembersResponse>

  ListTeamMembersResponse

  Throws

  ApiError

removeTeamMember

• removeTeamMember(__namedParameters): CancelablePromise<DeleteTeamMemberResponse>

• Remove Team Member Remove a member of the team.

  Parameters

  • __namedParameters: {
        companyId: string;
        userId: string;
    }

    • companyId: string

      Company ID the team member belongs to

    • userId: string

      User ID of the team member to remove

  Returns CancelablePromise<DeleteTeamMemberResponse>

  DeleteTeamMemberResponse

  Throws

  ApiError

resendInvite

• resendInvite(__namedParameters): CancelablePromise<APIResponse>

• Resend Invite Resend an invite to the person you wish to have on your team

  Parameters

  • __namedParameters: {
        requestBody: ResendInviteRequestBody;
    }

    • requestBody: ResendInviteRequestBody

  Returns CancelablePromise<APIResponse>

  APIResponse

  Throws

  ApiError

teamInvitesControllerAccept

• teamInvitesControllerAccept(__namedParameters): CancelablePromise<any>

• Parameters

  • __namedParameters: {
        token: string;
    }

    • token: string

  Returns CancelablePromise<any>

  any

  Throws

  ApiError

updateTeamMemberRole

• updateTeamMemberRole(__namedParameters): CancelablePromise<UpdateTeamMemberResponse>

• Update Member Role Update the role of an existing team member

  Parameters

  • __namedParameters: {
        companyId: string;
        requestBody: UpdateTeamMemberRequestBody;
        userId: string;
    }

    • companyId: string

      Company ID the team member belongs to

    • requestBody: UpdateTeamMemberRequestBody

    • userId: string

      User ID of the team member

  Returns CancelablePromise<UpdateTeamMemberResponse>

  UpdateTeamMemberResponse

  Throws

  ApiError