API referenceresources
ovok_sdk.resources.invites
The `ovok.invites` namespace: create and accept invitations.
- Stable unknown
- Release candidate since 0.1.0-rc.4
- Development since 0.1.0-dev.25+2ba84b0
The ovok.invites namespace: create and accept invitations.
InviteFlowResource
InviteFlowResource(http: HttpClient, path: str)Creates and accepts one kind of invitation.
Access it as ovok.invites.<flow>, such as ovok.invites.care.
create()
create(body: JsonObject) -> AnyCreate an invitation.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
body | JsonObject | The invitation as the route takes it. |
Returns
Any: The created invitation.
accept()
accept(body: JsonObject) -> AnyAccept an invitation.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
body | JsonObject | The acceptance as the route takes it, usually the invite token. |
Returns
Any: The API's response.
InvitesResource
InvitesResource(http: HttpClient, session: UserSession | None = None)Invitation flows: record shares, care, practitioners and patients.
Created by Ovok; access it as ovok.invites.
accept()
accept(body: JsonObject) -> AnyAccept an invitation through the flow that fits the signed-in profile.
A Practitioner accepts a record share; a Patient accepts a care invitation.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
body | JsonObject | The acceptance as the route takes it. |
Returns
Any: The API's response.
Raises
OvokConfigError: No Patient or Practitioner is signed in.
Last updated on