Type alias AuthClientForwardedUserClient

Type declaration

• groups: {
      createGroup: ((group: NewGroup) => Promise<Group>);
      createOrUpdateGroup: ((groupId: string, newOrUpdatedGroup: NewGroup) => Promise<Group>);
      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>

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