Function HypothesisRest

HypothesisRest(options?: {
apiUrl?: string;
}): UnauthenticatedClient
For unauthenticated access

See
- API: https://h.readthedocs.io/en/latest/api/
- Authorization: https://h.readthedocs.io/en/latest/api-reference/#section/Hypothesis-API/Authorization
Parameters
- Optional options: {
  apiUrl?: string;
  }
  - Optional apiUrl?: string
    
    (optional) Target annotation database API URL. Default: https://hypothes.is/api
Returns UnauthenticatedClient
- Defined in src/HypothesisRest.ts:495
HypothesisRest(options: {
apiKey: string;
apiUrl?: string;
}): ApiKeyClient
For access authenticated via API Key

See
- API: https://h.readthedocs.io/en/latest/api/
- API-Key: https://h.readthedocs.io/en/latest/api-reference/#section/Authentication/ApiKey
- Access-Tokens: https://h.readthedocs.io/en/latest/api/authorization/#access-tokens
Parameters
- options: {
  apiKey: string;
  apiUrl?: string;
  }
  - apiKey: string
    
    API Key to use for authorizing the request
  - Optional apiUrl?: string
    
    (optional) Target annotation database API URL. Default: https://hypothes.is/api
Returns ApiKeyClient
- Defined in src/HypothesisRest.ts:504
HypothesisRest(options: {
apiUrl?: string;
authClient: string;
}): AuthClientClient
For access authenticated via Auth Client

See
- API: https://h.readthedocs.io/en/latest/api/
- AuthClient: https://h.readthedocs.io/en/latest/api-reference/#section/Authentication/AuthClient
- Using-OAuth: https://h.readthedocs.io/en/latest/api/using-oauth/
Parameters
- options: {
  apiUrl?: string;
  authClient: string;
  }
  - Optional apiUrl?: string
    
    (optional) Target annotation database API URL. Default: https://hypothes.is/api
  - authClient: string
    
    Auth Client to use for authorizing the request
Returns AuthClientClient
- Defined in src/HypothesisRest.ts:513
HypothesisRest(options: {
apiUrl?: string;
authClientForwardedUser: string;
}): AuthClientForwardedUserClient
For access authenticated via Auth Client Forwarded User

See
- API: https://h.readthedocs.io/en/latest/api/
- AuthClientForwardedUser: https://h.readthedocs.io/en/latest/api-reference/#section/Authentication/AuthClientForwardedUser
- Using-OAuth: https://h.readthedocs.io/en/latest/api/using-oauth/
Parameters
- options: {
  apiUrl?: string;
  authClientForwardedUser: string;
  }
  - Optional apiUrl?: string
    
    (optional) Target annotation database API URL. Default: https://hypothes.is/api
  - authClientForwardedUser: string
Returns AuthClientForwardedUserClient
- Defined in src/HypothesisRest.ts:522

Generated using TypeDoc