@healthcloudai/hc-sdk 3.28.0 → 3.29.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.
Files changed (41) hide show
  1. package/dist/index.cjs +65 -0
  2. package/dist/index.d.cts +755 -5
  3. package/dist/index.d.ts +755 -5
  4. package/dist/index.js +65 -0
  5. package/docs/clients/PatientClient.md +5 -0
  6. package/docs/clients/ProviderClient.md +3 -0
  7. package/docs/docs-manifest.json +23 -3
  8. package/docs/examples/index.md +8 -0
  9. package/docs/index.md +8 -0
  10. package/docs/models/AvailabilityWindow.md +19 -0
  11. package/docs/models/BookPracticeAppointmentRequest.md +18 -0
  12. package/docs/models/CreatePracticeInviteRequest.md +17 -0
  13. package/docs/models/GetPatientResponse.md +1 -0
  14. package/docs/models/PatientDemographics.md +1 -0
  15. package/docs/models/PracticeAppointment.md +26 -0
  16. package/docs/models/PracticeAppointmentResponse.md +17 -0
  17. package/docs/models/PracticeAppointmentsResponse.md +19 -0
  18. package/docs/models/PracticeAvailability.md +22 -0
  19. package/docs/models/PracticeAvailabilityResponse.md +18 -0
  20. package/docs/models/PracticeInviteResponse.md +20 -0
  21. package/docs/models/PracticeSlot.md +19 -0
  22. package/docs/models/PracticeSlotsResponse.md +21 -0
  23. package/docs/models/ProviderPatientProfile.md +1 -0
  24. package/docs/models/ReschedulePracticeAppointmentRequest.md +17 -0
  25. package/docs/models/index.md +12 -0
  26. package/docs/models/patient.RegisterRequest.md +1 -0
  27. package/docs/models/patient.RegisterResponse.md +1 -0
  28. package/docs/operations/fieldagent.listPatients.md +1 -0
  29. package/docs/operations/patient.bookPracticeAppointment.md +180 -0
  30. package/docs/operations/patient.cancelPracticeAppointment.md +158 -0
  31. package/docs/operations/patient.getPatient.md +1 -0
  32. package/docs/operations/patient.getPatientSidebarPatientSidebar.md +1 -0
  33. package/docs/operations/patient.listPracticeAppointmentSlots.md +149 -0
  34. package/docs/operations/patient.listPracticeAppointments.md +156 -0
  35. package/docs/operations/patient.register.md +4 -1
  36. package/docs/operations/patient.reschedulePracticeAppointment.md +182 -0
  37. package/docs/operations/provider.createPracticeInvite.md +140 -0
  38. package/docs/operations/provider.getPatientProfile.md +1 -0
  39. package/docs/operations/provider.getPracticeAvailability.md +136 -0
  40. package/docs/operations/provider.setPracticeAvailability.md +168 -0
  41. package/package.json +1 -1
@@ -0,0 +1,168 @@
1
+ # Set the practice's telehealth booking rules
2
+
3
+ Operation ID: `provider.setPracticeAvailability`
4
+
5
+ Replaces the practice's booking rules. Windows are `{day, start, end}` in the practice's IANA `timezone` and may not overlap; `slot_minutes` is 15, 20, 30, 45 or 60. Patients see slots computed from these rules. Practice owner, own record only.
6
+
7
+ ## Public method
8
+
9
+ `setPracticeAvailability`
10
+
11
+ Signature: `provider.setPracticeAvailability(practitionerId, availability)`
12
+
13
+ Return type: `Promise<PracticeAvailabilityResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `PUT /practitioners/{practitioner_id}/availability`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `practitioner_id` | `string` | Yes | | | | No | |
34
+
35
+ ## Query parameters
36
+
37
+ None.
38
+
39
+ ## Body parameters
40
+
41
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
42
+ |---|---|---:|---|---|---|---:|---|
43
+ | `body` | [`PracticeAvailability`](../models/PracticeAvailability.md) | No | | | | Yes | |
44
+
45
+ Request model: [`PracticeAvailability`](../models/PracticeAvailability.md)
46
+
47
+ ## Request example
48
+
49
+ ```json
50
+ {
51
+ "horizon_days": 14,
52
+ "min_lead_hours": 2,
53
+ "slot_minutes": 30,
54
+ "timezone": "string",
55
+ "unavailable_dates": [
56
+ "2026-01-01"
57
+ ],
58
+ "windows": [
59
+ {
60
+ "day": "mon",
61
+ "end": "string",
62
+ "start": "string"
63
+ }
64
+ ]
65
+ }
66
+ ```
67
+
68
+ ## Success responses
69
+
70
+ | Status | Shape | Content type | Description |
71
+ |---|---|---|---|
72
+ | `200` | [`PracticeAvailabilityResponse`](../models/PracticeAvailabilityResponse.md) | application/json | The saved booking rules |
73
+
74
+ ## Success response examples
75
+
76
+ ### 200
77
+
78
+ ```json
79
+ {
80
+ "availability": {
81
+ "horizon_days": 14,
82
+ "min_lead_hours": 2,
83
+ "slot_minutes": 30,
84
+ "timezone": "string",
85
+ "unavailable_dates": [
86
+ "2026-01-01"
87
+ ],
88
+ "windows": [
89
+ {
90
+ "day": "mon",
91
+ "end": "string",
92
+ "start": "string"
93
+ }
94
+ ]
95
+ },
96
+ "practitioner_id": "string"
97
+ }
98
+ ```
99
+
100
+ ## Common errors
101
+
102
+ | Status | Shape | Content type | Description |
103
+ |---|---|---|---|
104
+ | `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Invalid booking rules |
105
+ | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider authorization required |
106
+ | `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Not a practice owner, or not your own record |
107
+
108
+ ## Error examples
109
+
110
+ ### 400
111
+
112
+ ```json
113
+ {
114
+ "error": "string"
115
+ }
116
+ ```
117
+
118
+ ### 401
119
+
120
+ ```json
121
+ {
122
+ "error": "string"
123
+ }
124
+ ```
125
+
126
+ ### 403
127
+
128
+ ```json
129
+ {
130
+ "error": "string"
131
+ }
132
+ ```
133
+
134
+ ## NodeJS / TypeScript implementation
135
+
136
+ ```ts
137
+ import { HCSDK } from "@healthcloudai/hc-sdk";
138
+ ```
139
+
140
+ ```ts
141
+ const practitionerId = "<PRACTITIONER_ID>";
142
+
143
+ const availability = "<AVAILABILITY>";
144
+
145
+ const result = await provider.setPracticeAvailability(practitionerId, availability);
146
+ ```
147
+
148
+ ## cURL
149
+
150
+ ```bash
151
+ curl -X PUT \
152
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
153
+ -H 'Content-Type: application/json' \
154
+ -d '{"horizon_days":14,"min_lead_hours":2,"slot_minutes":30,"timezone":"string","unavailable_dates":["2026-01-01"],"windows":[{"day":"mon","end":"string","start":"string"}]}' \
155
+ 'https://dev-api-provider.health.cloud/practitioners/%3CPRACTITIONER_ID%3E/availability'
156
+ ```
157
+
158
+ ## Notes
159
+
160
+ None.
161
+
162
+ ## Prepared Test Console scenario
163
+
164
+ No canonical scenario is currently associated.
165
+
166
+ ## Real response
167
+
168
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@healthcloudai/hc-sdk",
3
- "version": "3.28.0",
3
+ "version": "3.29.0",
4
4
  "description": "All-in-one HealthCloud SDK with typed platform APIs and secure connector clients.",
5
5
  "author": "Healthcheck Systems Inc",
6
6
  "license": "MIT",