Type alias UnauthenticatedClient

Type declaration

• annotations: {
      fetchAnnotation: ((annotationId: string) => Promise<Annotation>);
  }

  • fetchAnnotation: ((annotationId: string) => Promise<Annotation>)

    • • (annotationId: string): Promise<Annotation>

      • Fetches an annotation by its ID GET /annotations/\{id\}

        See

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

        Throws

        ApiError

        Parameters

        • annotationId: string

          ID of the annotation to be fetched

        Returns Promise<Annotation>

• groups: {
      fetchGroup: ((groupId: string) => Promise<Group>);
      getGroupMembers: ((groupId: string) => Promise<User[]>);
      getListOfGroups: (() => Promise<Group[]>);
  }

  • 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[]>

  • getListOfGroups: (() => Promise<Group[]>)

    • • (): Promise<Group[]>

      • Retrieve a list of applicable Groups as well as a user's private Groups. GET /groups

        See

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

        Throws

        ApiError

        Returns Promise<Group[]>

• profile: {
      fetchProfile: (() => Promise<Profile>);
      fetchUsersGroups: (() => Promise<Group[]>);
  }

  • fetchProfile: (() => Promise<Profile>)

    • • (): Promise<Profile>

      • Fetches user's profile GET /profile

        See

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

        Throws

        ApiError

        Returns Promise<Profile>

  • fetchUsersGroups: (() => Promise<Group[]>)

    • • (): Promise<Group[]>

      • Fetch the groups for which the currently-authenticated user is a member. GET /profile/groups

        See

        fetchUsersGroups: https://h.readthedocs.io/en/latest/api-reference/#tag/profile/paths/~1profile~1groups/get

        Throws

        ApiError

        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>