Type alias ApiKeyClient

Type declaration

• annotations: {
      createAnnotation: ((newAnnotation: NewAnnotation) => Promise<Annotation>);
      deleteAnnotation: ((annotationId: string) => Promise<Annotation["id"]>);
      fetchAnnotation: ((annotationId: string) => Promise<Annotation>);
      flagAnnotation: ((annotationId: string) => Promise<boolean>);
      hideAnnotation: ((annotationId: string) => Promise<boolean>);
      showAnnotation: ((annotationId: string) => Promise<boolean>);
      updateAnnotation: ((annotationId: string, updatedAnnotation: NewAnnotation) => Promise<Annotation>);
  }

  • createAnnotation: ((newAnnotation: NewAnnotation) => Promise<Annotation>)

    • • (newAnnotation: NewAnnotation): Promise<Annotation>

      • Creates an annotation based on the information provided POST /annotations

        See

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

        Throws

        ApiError

        Parameters

        • newAnnotation: NewAnnotation

          Annotation to be created

        Returns Promise<Annotation>

  • deleteAnnotation: ((annotationId: string) => Promise<Annotation["id"]>)

    • • (annotationId: string): Promise<Annotation["id"]>

      • Deletes an annotation DELETE /annotations/\{id\}

        See

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

        Throws

        ApiError

        Parameters

        • annotationId: string

          ID of the annotation to be deleted

        Returns Promise<Annotation["id"]>

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

  • flagAnnotation: ((annotationId: string) => Promise<boolean>)

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

      • Flags an annotation PUT /annotations/\{id\}/flag

        See

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

        Throws

        ApiError

        Parameters

        • annotationId: string

          ID of the annotation to be flagged

        Returns Promise<boolean>

  • hideAnnotation: ((annotationId: string) => Promise<boolean>)

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

      • Hides an annotation PUT /annotations/\{id\}/hide

        See

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

        Throws

        ApiError

        Parameters

        • annotationId: string

          ID of the annotation to be hidden

        Returns Promise<boolean>

  • showAnnotation: ((annotationId: string) => Promise<boolean>)

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

      • Shows an annotation DELETE /annotations/\{id\}/hide

        See

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

        Throws

        ApiError

        Parameters

        • annotationId: string

          ID of the annotation to be shown

        Returns Promise<boolean>

  • updateAnnotation: ((annotationId: string, updatedAnnotation: NewAnnotation) => Promise<Annotation>)

    • • (annotationId: string, updatedAnnotation: NewAnnotation): Promise<Annotation>

      • Updates an annotation PATCH /annotations/\{id\}

        See

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

        Throws

        ApiError

        Parameters

        • annotationId: string

          ID of the annotation to be updated

        • updatedAnnotation: NewAnnotation

          Update annotation

        Returns Promise<Annotation>

• groups: {
      createGroup: ((group: NewGroup) => Promise<Group>);
      createOrUpdateGroup: ((groupId: string, newOrUpdatedGroup: NewGroup) => Promise<Group>);
      fetchGroup: ((groupId: string) => Promise<Group>);
      getGroupMembers: ((groupId: string) => Promise<User[]>);
      getListOfGroups: (() => Promise<Group[]>);
      removeGroupMember: ((groupId: string) => Promise<boolean>);
      updateGroup: ((groupId: string, updatedGroup: NewGroup) => Promise<Group>);
  }

  • createGroup: ((group: NewGroup) => Promise<Group>)

    • • (group: NewGroup): Promise<Group>

      • Creates a group POST /groups

        See

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

        Throws

        ApiError

        Parameters

        • group: NewGroup

        Returns Promise<Group>

  • createOrUpdateGroup: ((groupId: string, newOrUpdatedGroup: NewGroup) => Promise<Group>)

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

      • Creates or updates a group PUT /groups/\{id\}

        See

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

        Throws

        ApiError

        Parameters

        • groupId: string

          ID of the group to be created or updated

        • newOrUpdatedGroup: NewGroup

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

  • removeGroupMember: ((groupId: string) => Promise<boolean>)

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

      • Removes a member from a group DELETE /groups/\{id\}/members/\{user\}

        See

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

        Throws

        ApiError

        Parameters

        • groupId: string

          ID of the group from which the member should be removed

        Returns Promise<boolean>

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

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