Type alias AuthClientClient

Type declaration

• groups: {
      addGroupMember: ((groupId: string, userId: string) => Promise<boolean>);
      fetchGroup: ((groupId: string) => Promise<Group>);
      getGroupMembers: ((groupId: string) => Promise<User[]>);
      updateGroup: ((groupId: string, updatedGroup: NewGroup) => Promise<Group>);
  }

  • addGroupMember: ((groupId: string, userId: string) => Promise<boolean>)

    • • (groupId: string, userId: string): Promise<boolean>

      • Adds a member to a group POST /groups/\{id\}/members/\{user\}

        See

        addGroupMember: https://h.readthedocs.io/en/latest/api-reference/#tag/groups/paths/~1groups~1{id}~1members~1{user}/post

        Throws

        ApiError

        Parameters

        • groupId: string

          ID of the group to which the member should be added

        • userId: string

          ID of the user to add to the group as a new member

        Returns Promise<boolean>

  • fetchGroup: ((groupId: string) => Promise<Group>)

    • • (groupId: string): Promise<Group>

      • Fetches a group by its ID GET /groups/\{id\}

        See

        fetchGroup: https://h.readthedocs.io/en/latest/api-reference/#tag/groups/paths/~1groups~1{id}/get

        Throws

        ApiError

        Parameters

        • groupId: string

          ID of the group to be fetched

        Returns Promise<Group>

  • getGroupMembers: ((groupId: string) => Promise<User[]>)

    • • (groupId: string): Promise<User[]>

      • Gets group members by group ID GET /groups/\{id\}/members

        See

        getGroupMembers: https://h.readthedocs.io/en/latest/api-reference/#tag/groups/paths/~1groups~1{id}~1members/get

        Throws

        ApiError

        Parameters

        • groupId: string

          ID of the group to be created or updated

        Returns Promise<User[]>

  • updateGroup: ((groupId: string, updatedGroup: NewGroup) => Promise<Group>)

    • • (groupId: string, updatedGroup: NewGroup): Promise<Group>

      • Updates a group by its ID PATCH /groups/\{id\}

        See

        updateGroup: https://h.readthedocs.io/en/latest/api-reference/#tag/groups/paths/~1groups~1{id}/patch

        Throws

        ApiError

        Parameters

        • groupId: string

          ID of the group to be updated

        • updatedGroup: NewGroup

        Returns Promise<Group>

• root: (() => Promise<IndexResponse>)

  • • (): Promise<IndexResponse>

    • Performs a request against the API root, returning a list of available services GET /

      See

      root: https://h.readthedocs.io/en/latest/api-reference/#tag/general/paths/~1/get

      Throws

      ApiError

      Returns Promise<IndexResponse>

• search: ((query: Query) => Promise<Result>)

  • • (query: Query): Promise<Result>

    • Finds annotations based on a query object GET /search

      See

      search: https://h.readthedocs.io/en/latest/api-reference/#tag/annotations/paths/~1search/get

      Throws

      ApiError

      Parameters

      • query: Query

        Search query object

      Returns Promise<Result>

• users: {
      createUser: ((newUser: NewUser) => Promise<User>);
      fetchUser: ((userId: User["userid"]) => Promise<User>);
      updateUser: ((userId: User["userid"], newUser: NewUser) => Promise<User>);
  }

  • createUser: ((newUser: NewUser) => Promise<User>)

    • • (newUser: NewUser): Promise<User>

      • Creates a new user POST /users

        See

        createUser: https://h.readthedocs.io/en/latest/api-reference/#tag/users/paths/~1users/post

        Throws

        ApiError

        Parameters

        • newUser: NewUser

          New User to be created

        Returns Promise<User>

  • fetchUser: ((userId: User["userid"]) => Promise<User>)

    • • (userId: User["userid"]): Promise<User>

      • Fetches a user by ID GET /users/\{id\}

        See

        fetchUser: https://h.readthedocs.io/en/latest/api-reference/#tag/users/paths/~1users~1{user}/get

        Throws

        ApiError

        Parameters

        • userId: User["userid"]

          ID of the user to fetch

        Returns Promise<User>

  • updateUser: ((userId: User["userid"], newUser: NewUser) => Promise<User>)

    • • (userId: User["userid"], newUser: NewUser): Promise<User>

      • Updates a user PATCH /users/\{id\}

        See

        updateUser: https://h.readthedocs.io/en/latest/api-reference/#tag/users/paths/~1users~1{username}/patch

        Throws

        ApiError

        Parameters

        • userId: User["userid"]

          ID of the user to update

        • newUser: NewUser

        Returns Promise<User>