@healthcloudai/hc-sdk 3.2.0 → 3.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +13 -0
- package/dist/index.d.cts +22 -1
- package/dist/index.d.ts +22 -1
- package/dist/index.js +13 -0
- package/docs/clients/AppointmentsClient.md +1 -0
- package/docs/docs-manifest.json +3 -2
- package/docs/examples/index.md +1 -0
- package/docs/index.md +1 -0
- package/docs/operations/appointments.getTelehealthLink.md +118 -0
- package/package.json +1 -1
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
# Get the telehealth join link for an Athena-booked appointment
|
|
2
|
+
|
|
3
|
+
Operation ID: `appointments.getTelehealthLink`
|
|
4
|
+
|
|
5
|
+
Get the telehealth join link for an Athena-booked appointment
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`getTelehealthLink`
|
|
10
|
+
|
|
11
|
+
Signature: `appointments.getTelehealthLink(appointmentId)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<GetTelehealthLinkResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
None documented.
|
|
24
|
+
|
|
25
|
+
## HTTP
|
|
26
|
+
|
|
27
|
+
`GET /appointments/{appointment_id}/telehealth-link`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
32
|
+
|---|---|---:|---|---|---|---:|---|
|
|
33
|
+
| `appointment_id` | `string` | Yes | | | | No | |
|
|
34
|
+
|
|
35
|
+
## Query parameters
|
|
36
|
+
|
|
37
|
+
None.
|
|
38
|
+
|
|
39
|
+
## Body parameters
|
|
40
|
+
|
|
41
|
+
None.
|
|
42
|
+
|
|
43
|
+
Request model: None.
|
|
44
|
+
|
|
45
|
+
## Request example
|
|
46
|
+
|
|
47
|
+
None declared in canonical OpenAPI.
|
|
48
|
+
|
|
49
|
+
## Success responses
|
|
50
|
+
|
|
51
|
+
| Status | Shape | Content type | Description |
|
|
52
|
+
|---|---|---|---|
|
|
53
|
+
| `200` | `object` | application/json | The telehealth join link written to this appointment's Athena notes at booking time |
|
|
54
|
+
|
|
55
|
+
## Success response examples
|
|
56
|
+
|
|
57
|
+
### 200
|
|
58
|
+
|
|
59
|
+
```json
|
|
60
|
+
{}
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Common errors
|
|
64
|
+
|
|
65
|
+
| Status | Shape | Content type | Description |
|
|
66
|
+
|---|---|---|---|
|
|
67
|
+
| `401` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
68
|
+
| `500` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Internal server error |
|
|
69
|
+
|
|
70
|
+
## Error examples
|
|
71
|
+
|
|
72
|
+
### 401 — Missing or invalid access token
|
|
73
|
+
|
|
74
|
+
```json
|
|
75
|
+
{
|
|
76
|
+
"error": "Authorization required"
|
|
77
|
+
}
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### 500 — Unexpected service failure (sanitized example)
|
|
81
|
+
|
|
82
|
+
```json
|
|
83
|
+
{
|
|
84
|
+
"error": "Internal server error"
|
|
85
|
+
}
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## NodeJS / TypeScript implementation
|
|
89
|
+
|
|
90
|
+
```ts
|
|
91
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
```ts
|
|
95
|
+
const appointmentId = "<APPOINTMENT_ID>";
|
|
96
|
+
|
|
97
|
+
const result = await appointments.getTelehealthLink(appointmentId);
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## cURL
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
curl -X GET \
|
|
104
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
105
|
+
'https://dev-api-appointments.health.cloud/appointments/%3CAPPOINTMENT_ID%3E/telehealth-link'
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
## Notes
|
|
109
|
+
|
|
110
|
+
None.
|
|
111
|
+
|
|
112
|
+
## Prepared Test Console scenario
|
|
113
|
+
|
|
114
|
+
No canonical scenario is currently associated.
|
|
115
|
+
|
|
116
|
+
## Real response
|
|
117
|
+
|
|
118
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
package/package.json
CHANGED