Class APITeams

Constructors

constructor

Methods

createTeam createTeamInvite deleteTeam getAllUserTeams joinOrLeaveTeam kickTeamMember updateMemberPermissions updateTeam

Constructors

constructor

Methods

createTeam

  • createTeam(__namedParameters): Promise<WebResponse<string>>

  • Parameters

    • __namedParameters: {
          auth: string;
          team: {
              activeInvites?: {
                  bitfieldToSet?: string;
                  code?: string;
                  currentUses?: number;
                  expiresAt?: null | Date;
                  maxUses?: null | number;
              }[];
              teamId?: string;
              teamMembers?: {
                  bitfield?: string;
                  joinedAt?: Date;
                  userId?: string;
              }[];
              teamName?: string;
          };
      }
      • auth: string
      • team: {
            activeInvites?: {
                bitfieldToSet?: string;
                code?: string;
                currentUses?: number;
                expiresAt?: null | Date;
                maxUses?: null | number;
            }[];
            teamId?: string;
            teamMembers?: {
                bitfield?: string;
                joinedAt?: Date;
                userId?: string;
            }[];
            teamName?: string;
        }
        • OptionalactiveInvites?: {
              bitfieldToSet?: string;
              code?: string;
              currentUses?: number;
              expiresAt?: null | Date;
              maxUses?: null | number;
          }[]
        • OptionalteamId?: string
        • OptionalteamMembers?: {
              bitfield?: string;
              joinedAt?: Date;
              userId?: string;
          }[]
        • OptionalteamName?: string

    Returns Promise<WebResponse<string>>

createTeamInvite

  • createTeamInvite(__namedParameters): Promise<WebResponse<string>>

  • Parameters

    • __namedParameters: {
          auth: string;
          bitfieldToSet: string;
          expiresAt?: number;
          maxUses?: number;
          teamId: string;
      }
      • auth: string
      • bitfieldToSet: string
      • OptionalexpiresAt?: number
      • OptionalmaxUses?: number
      • teamId: string

    Returns Promise<WebResponse<string>>

deleteTeam

  • deleteTeam(__namedParameters): Promise<WebResponse<string>>

  • Parameters

    • __namedParameters: {
          auth: string;
          teamId: string;
      }
      • auth: string
      • teamId: string

    Returns Promise<WebResponse<string>>

getAllUserTeams

joinOrLeaveTeam

  • joinOrLeaveTeam(__namedParameters): Promise<WebResponse<string>>

  • Parameters

    • __namedParameters: {
          action: "leave" | "join";
          auth: string;
          teamOrCode: string;
      }
      • action: "leave" | "join"
      • auth: string
      • teamOrCode: string

    Returns Promise<WebResponse<string>>

kickTeamMember

  • kickTeamMember(__namedParameters): Promise<WebResponse<string>>

  • Parameters

    • __namedParameters: {
          auth: string;
          teamId: string;
          userId: string;
      }
      • auth: string
      • teamId: string
      • userId: string

    Returns Promise<WebResponse<string>>

updateMemberPermissions

  • updateMemberPermissions(__namedParameters): Promise<WebResponse<string>>

  • Parameters

    • __namedParameters: {
          auth: string;
          bitfieldToSet: string;
          teamId: string;
          userId: string;
      }
      • auth: string
      • bitfieldToSet: string
      • teamId: string
      • userId: string

    Returns Promise<WebResponse<string>>

updateTeam

  • updateTeam(__namedParameters): Promise<WebResponse<string>>

  • Parameters

    • __namedParameters: {
          auth: string;
          team: {
              activeInvites?: {
                  bitfieldToSet?: string;
                  code?: string;
                  currentUses?: number;
                  expiresAt?: null | Date;
                  maxUses?: null | number;
              }[];
              teamId?: string;
              teamMembers?: {
                  bitfield?: string;
                  joinedAt?: Date;
                  userId?: string;
              }[];
              teamName?: string;
          };
          teamId: string;
      }
      • auth: string
      • team: {
            activeInvites?: {
                bitfieldToSet?: string;
                code?: string;
                currentUses?: number;
                expiresAt?: null | Date;
                maxUses?: null | number;
            }[];
            teamId?: string;
            teamMembers?: {
                bitfield?: string;
                joinedAt?: Date;
                userId?: string;
            }[];
            teamName?: string;
        }
        • OptionalactiveInvites?: {
              bitfieldToSet?: string;
              code?: string;
              currentUses?: number;
              expiresAt?: null | Date;
              maxUses?: null | number;
          }[]
        • OptionalteamId?: string
        • OptionalteamMembers?: {
              bitfield?: string;
              joinedAt?: Date;
              userId?: string;
          }[]
        • OptionalteamName?: string
      • teamId: string

    Returns Promise<WebResponse<string>>

Settings

Member Visibility

On This Page

Constructors
Methods