Class Members

Constructors

constructor

Methods

getMember getMembers updateMember

Constructors

constructor

Methods

getMember

  • getMember(
        context: "team" | "organisation" | "admin",
        contextId: number,
        id: number | "me",
        options?: { includeDetails?: boolean },
    ): Promise<Member>

  • Parameters

    • context: "team" | "organisation" | "admin"

      The point of view from where the request takes place

    • contextId: number

      Either a team, organisation or admin's id

    • id: number | "me"

      Member the resource belongs to. Either an id or "me"

    • Optionaloptions: { includeDetails?: boolean }

    Returns Promise<Member>

    • A member

getMembers

  • getMembers(
        context: "team" | "organisation" | "admin",
        contextId: number,
        options?: {
            deleted?: boolean;
            id?: number | number[];
            id_tag?: string;
            name?: string;
            order?: "asc" | "desc";
            page?: number;
            size?: number;
            sort?: "createdAt" | "id" | "updatedAt";
            statuses?: (null | number)[];
            team_id?: number;
        },
    ): Promise<Member[]>

  • Parameters

    • context: "team" | "organisation" | "admin"

      The point of view from where the request takes place

    • contextId: number

      Either a team, organisation or admin's id

    • Optionaloptions: {
          deleted?: boolean;
          id?: number | number[];
          id_tag?: string;
          name?: string;
          order?: "asc" | "desc";
          page?: number;
          size?: number;
          sort?: "createdAt" | "id" | "updatedAt";
          statuses?: (null | number)[];
          team_id?: number;
      }
      • Optionaldeleted?: boolean

        Return only deleted members

      • Optionalid?: number | number[]

        A list of ids

      • Optionalid_tag?: string

        RFID tag or barcode

      • Optionalname?: string

        The member's name

      • Optionalorder?: "asc" | "desc"
      • Optionalpage?: number

        Page number

      • Optionalsize?: number

        Items per page

      • Optionalsort?: "createdAt" | "id" | "updatedAt"
      • Optionalstatuses?: (null | number)[]

        One or more member statuses. Some statuses require extra permissions.

      • Optionalteam_id?: number

        The numeric identifier for a resource

    Returns Promise<Member[]>

    • A list of members

updateMember

  • updateMember(
        context: string,
        contextId: number,
        id: number,
        updates: MemberUpdate,
    ): Promise<void>

  • Parameters

    • context: string
    • contextId: number
    • id: number
    • updates: MemberUpdate

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Methods