@healthcloudai/hc-sdk 2.0.2 → 2.1.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 (42) hide show
  1. package/README.md +3 -1
  2. package/dist/index.cjs +24 -10
  3. package/dist/index.d.cts +545 -471
  4. package/dist/index.d.ts +545 -471
  5. package/dist/index.js +24 -10
  6. package/docs/clients/FieldAgentClient.md +3 -0
  7. package/docs/clients/PatientClient.md +0 -1
  8. package/docs/clients/TelehealthClient.md +0 -1
  9. package/docs/docs-manifest.json +15 -10
  10. package/docs/examples/index.md +3 -2
  11. package/docs/index.md +3 -2
  12. package/docs/models/AddDependentRequest.md +10 -6
  13. package/docs/models/AddDependentResponse.md +17 -0
  14. package/docs/models/AddNotificationResponse.md +19 -0
  15. package/docs/models/DependentResponse.md +17 -0
  16. package/docs/models/GetPatientPhotoResponse.md +15 -0
  17. package/docs/models/ListDependentsResponse.md +2 -2
  18. package/docs/models/ListNotificationsResponse.md +2 -2
  19. package/docs/models/NotificationResponse.md +19 -0
  20. package/docs/models/NotificationUpsertRequest.md +23 -0
  21. package/docs/models/PatientPhotoUploadUrlResponse.md +14 -0
  22. package/docs/models/UploadPatientPhotoRequest.md +14 -0
  23. package/docs/models/{FetchRtcTokenResponse.md → UploadPatientPhotoResponse.md} +3 -4
  24. package/docs/models/index.md +9 -5
  25. package/docs/operations/fieldagent.confirmResetPassword.md +1 -1
  26. package/docs/operations/fieldagent.getPatientPhoto.md +85 -0
  27. package/docs/operations/{patient.commsRtcToken.md → fieldagent.patientPhotoUploadUrl.md} +19 -18
  28. package/docs/operations/fieldagent.uploadPatientPhoto.md +87 -0
  29. package/docs/operations/patient.addDependent.md +2 -2
  30. package/docs/operations/patient.addNotification.md +3 -3
  31. package/docs/operations/patient.checkEligibility.md +1 -1
  32. package/docs/operations/patient.confirmResetPassword.md +1 -1
  33. package/docs/operations/patient.listDependents.md +1 -1
  34. package/docs/operations/patient.listNotifications.md +1 -1
  35. package/docs/operations/person.confirmResetPassword.md +1 -1
  36. package/docs/operations/provider.confirmResetPassword.md +1 -1
  37. package/package.json +1 -2
  38. package/docs/models/AddNotificationRequest.md +0 -17
  39. package/docs/models/CommsRtcTokenRequest.md +0 -15
  40. package/docs/models/CommsRtcTokenResponse.md +0 -19
  41. package/docs/models/FetchRtcTokenRequest.md +0 -15
  42. package/docs/operations/telehealth.fetchRtcToken.md +0 -82
@@ -0,0 +1,85 @@
1
+ # GET /patients/{patient_id}/photo
2
+
3
+ Operation ID: `fieldagent.getPatientPhoto`
4
+
5
+ GET /patients/{patient_id}/photo
6
+
7
+ ## Public method
8
+
9
+ `getPatientPhoto`
10
+
11
+ Signature: `getPatientPhoto<TResponse = GetPhotoResponse>(patientId: string, query?: GetPhotoQuery): Promise<TResponse>`
12
+
13
+ Return type: `Promise<TResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `GET /patients/{patient_id}/photo`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `patient_id` | `string` | Yes | | | | No | |
34
+
35
+ ## Query parameters
36
+
37
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
38
+ |---|---|---:|---|---|---|---:|---|
39
+ | `binary_id` | `string` | Yes | | | | No | Optional binary_id returned by upload_patient_photo. If omitted, the stored patient photo is used. |
40
+
41
+ ## Body parameters
42
+
43
+ None.
44
+
45
+ Request model: None.
46
+
47
+ ## Success responses
48
+
49
+ | Status | Shape | Content type | Description |
50
+ |---|---|---|---|
51
+ | `200` | [`GetPatientPhotoResponse`](../models/GetPatientPhotoResponse.md) | application/json | Patient photo |
52
+
53
+ ## Common errors
54
+
55
+ None declared in canonical OpenAPI.
56
+
57
+ ## NodeJS / TypeScript implementation
58
+
59
+ ```ts
60
+ import { HCSDK } from "@healthcloudai/hc-sdk";
61
+ ```
62
+
63
+ ```ts
64
+ const result = await fieldAgentClient.getPatientPhoto(patientId, query);
65
+ ```
66
+
67
+ ## cURL
68
+
69
+ ```bash
70
+ curl -X GET \
71
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
72
+ '<BASE_URL>/patients/{patient_id}/photo?binary_id=<BINARY_ID>'
73
+ ```
74
+
75
+ ## Notes
76
+
77
+ None.
78
+
79
+ ## Prepared Test Console scenario
80
+
81
+ No canonical scenario is currently associated.
82
+
83
+ ## Real response
84
+
85
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -1,20 +1,22 @@
1
- # POST /communications/rtc-token
1
+ # GET /patients/{patient_id}/photo/upload-url
2
2
 
3
- Operation ID: `patient.commsRtcToken`
3
+ Operation ID: `fieldagent.patientPhotoUploadUrl`
4
4
 
5
- POST /communications/rtc-token
5
+ GET /patients/{patient_id}/photo/upload-url
6
6
 
7
7
  ## Public method
8
8
 
9
- `commsRtcToken`
9
+ `getPatientPhotoUploadUrl`
10
10
 
11
- Signature: `commsRtcToken<TResponse = RtcTokenResponse>(request: RtcTokenRequest): Promise<TResponse>`
11
+ Signature: `getPatientPhotoUploadUrl<TResponse = PhotoUploadUrlResponse>(patientId: string): Promise<TResponse>`
12
12
 
13
13
  Return type: `Promise<TResponse>`
14
14
 
15
15
  ## Authentication
16
16
 
17
- Classification: **UNSPECIFIED**
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
18
20
 
19
21
  ## Prerequisites
20
22
 
@@ -22,11 +24,13 @@ None documented.
22
24
 
23
25
  ## HTTP
24
26
 
25
- `POST /communications/rtc-token`
27
+ `GET /patients/{patient_id}/photo/upload-url`
26
28
 
27
29
  ## Path parameters
28
30
 
29
- None.
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `patient_id` | `string` | Yes | | | | No | |
30
34
 
31
35
  ## Query parameters
32
36
 
@@ -34,17 +38,15 @@ None.
34
38
 
35
39
  ## Body parameters
36
40
 
37
- | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
38
- |---|---|---:|---|---|---|---:|---|
39
- | `body` | [`CommsRtcTokenRequest`](../models/CommsRtcTokenRequest.md) | No | | | | No | |
41
+ None.
40
42
 
41
- Request model: [`CommsRtcTokenRequest`](../models/CommsRtcTokenRequest.md)
43
+ Request model: None.
42
44
 
43
45
  ## Success responses
44
46
 
45
47
  | Status | Shape | Content type | Description |
46
48
  |---|---|---|---|
47
- | `200` | [`CommsRtcTokenResponse`](../models/CommsRtcTokenResponse.md) | application/json | Agora RTC token |
49
+ | `200` | [`PatientPhotoUploadUrlResponse`](../models/PatientPhotoUploadUrlResponse.md) | application/json | Successful Response |
48
50
 
49
51
  ## Common errors
50
52
 
@@ -57,16 +59,15 @@ import { HCSDK } from "@healthcloudai/hc-sdk";
57
59
  ```
58
60
 
59
61
  ```ts
60
- const result = await patientClient.commsRtcToken(request);
62
+ const result = await fieldAgentClient.getPatientPhotoUploadUrl(patientId);
61
63
  ```
62
64
 
63
65
  ## cURL
64
66
 
65
67
  ```bash
66
- curl -X POST \
67
- -H 'Content-Type: application/json' \
68
- -d '<REQUEST_BODY_JSON>' \
69
- '<BASE_URL>/communications/rtc-token'
68
+ curl -X GET \
69
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
70
+ '<BASE_URL>/patients/{patient_id}/photo/upload-url'
70
71
  ```
71
72
 
72
73
  ## Notes
@@ -0,0 +1,87 @@
1
+ # POST /patients/{patient_id}/photo
2
+
3
+ Operation ID: `fieldagent.uploadPatientPhoto`
4
+
5
+ POST /patients/{patient_id}/photo
6
+
7
+ ## Public method
8
+
9
+ `uploadPatientPhoto`
10
+
11
+ Signature: `uploadPatientPhoto<TResponse = PhotoUploadResponse>(patientId: string, request: PhotoUploadRequest): Promise<TResponse>`
12
+
13
+ Return type: `Promise<TResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `POST /patients/{patient_id}/photo`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `patient_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` | [`UploadPatientPhotoRequest`](../models/UploadPatientPhotoRequest.md) | No | | | | No | |
44
+
45
+ Request model: [`UploadPatientPhotoRequest`](../models/UploadPatientPhotoRequest.md)
46
+
47
+ ## Success responses
48
+
49
+ | Status | Shape | Content type | Description |
50
+ |---|---|---|---|
51
+ | `201` | [`UploadPatientPhotoResponse`](../models/UploadPatientPhotoResponse.md) | application/json | Patient photo stored |
52
+
53
+ ## Common errors
54
+
55
+ None declared in canonical OpenAPI.
56
+
57
+ ## NodeJS / TypeScript implementation
58
+
59
+ ```ts
60
+ import { HCSDK } from "@healthcloudai/hc-sdk";
61
+ ```
62
+
63
+ ```ts
64
+ const result = await fieldAgentClient.uploadPatientPhoto(patientId, request);
65
+ ```
66
+
67
+ ## cURL
68
+
69
+ ```bash
70
+ curl -X POST \
71
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
72
+ -H 'Content-Type: application/json' \
73
+ -d '<REQUEST_BODY_JSON>' \
74
+ '<BASE_URL>/patients/{patient_id}/photo'
75
+ ```
76
+
77
+ ## Notes
78
+
79
+ None.
80
+
81
+ ## Prepared Test Console scenario
82
+
83
+ No canonical scenario is currently associated.
84
+
85
+ ## Real response
86
+
87
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -38,7 +38,7 @@ None.
38
38
 
39
39
  | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
40
40
  |---|---|---:|---|---|---|---:|---|
41
- | `body` | [`AddDependentRequest`](../models/AddDependentRequest.md) | No | | | | No | |
41
+ | `body` | [`AddDependentRequest`](../models/AddDependentRequest.md) | Yes | | | | No | |
42
42
 
43
43
  Request model: [`AddDependentRequest`](../models/AddDependentRequest.md)
44
44
 
@@ -46,7 +46,7 @@ Request model: [`AddDependentRequest`](../models/AddDependentRequest.md)
46
46
 
47
47
  | Status | Shape | Content type | Description |
48
48
  |---|---|---|---|
49
- | `200` | [`FhirResource`](../models/FhirResource.md) | application/json | Successful Response |
49
+ | `201` | [`AddDependentResponse`](../models/AddDependentResponse.md) | application/json | Dependent created |
50
50
 
51
51
  ## Common errors
52
52
 
@@ -38,15 +38,15 @@ None.
38
38
 
39
39
  | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
40
40
  |---|---|---:|---|---|---|---:|---|
41
- | `body` | [`AddNotificationRequest`](../models/AddNotificationRequest.md) | No | | | | No | |
41
+ | `body` | [`NotificationUpsertRequest`](../models/NotificationUpsertRequest.md) | Yes | | | | No | |
42
42
 
43
- Request model: [`AddNotificationRequest`](../models/AddNotificationRequest.md)
43
+ Request model: [`NotificationUpsertRequest`](../models/NotificationUpsertRequest.md)
44
44
 
45
45
  ## Success responses
46
46
 
47
47
  | Status | Shape | Content type | Description |
48
48
  |---|---|---|---|
49
- | `200` | [`FhirResource`](../models/FhirResource.md) | application/json | Successful Response |
49
+ | `201` | [`AddNotificationResponse`](../models/AddNotificationResponse.md) | application/json | Notification created |
50
50
 
51
51
  ## Common errors
52
52
 
@@ -8,7 +8,7 @@ POST /insurance/eligibility
8
8
 
9
9
  `checkInsuranceEligibility`
10
10
 
11
- Signature: `checkInsuranceEligibility<TResponse = JsonValue>(request: InsuranceEligibilityRequest): Promise<TResponse>`
11
+ Signature: `checkInsuranceEligibility<TResponse = JsonValue>(request: CheckEligibilityRequest): Promise<TResponse>`
12
12
 
13
13
  Return type: `Promise<TResponse>`
14
14
 
@@ -8,7 +8,7 @@ POST /auth/confirm-reset-password
8
8
 
9
9
  `confirmPassword`
10
10
 
11
- Signature: `confirmPassword<TResponse = VerifiedResponse>(request: ConfirmPatientPasswordRequest): Promise<TResponse>`
11
+ Signature: `confirmPassword<TResponse = ResetPatientPasswordResponse>(request: ConfirmPatientPasswordRequest): Promise<TResponse>`
12
12
 
13
13
  Return type: `Promise<TResponse>`
14
14
 
@@ -44,7 +44,7 @@ Request model: None.
44
44
 
45
45
  | Status | Shape | Content type | Description |
46
46
  |---|---|---|---|
47
- | `200` | [`ListDependentsResponse`](../models/ListDependentsResponse.md) | application/json | Successful Response |
47
+ | `200` | [`ListDependentsResponse`](../models/ListDependentsResponse.md) | application/json | List the authenticated patient's dependents |
48
48
 
49
49
  ## Common errors
50
50
 
@@ -44,7 +44,7 @@ Request model: None.
44
44
 
45
45
  | Status | Shape | Content type | Description |
46
46
  |---|---|---|---|
47
- | `200` | [`ListNotificationsResponse`](../models/ListNotificationsResponse.md) | application/json | Successful Response |
47
+ | `200` | [`ListNotificationsResponse`](../models/ListNotificationsResponse.md) | application/json | List the authenticated patient's notifications |
48
48
 
49
49
  ## Common errors
50
50
 
@@ -8,7 +8,7 @@ POST /auth/confirm-reset-password
8
8
 
9
9
  `confirmPassword`
10
10
 
11
- Signature: `confirmPassword<TResponse = VerifiedResponse>(request: ConfirmPersonPasswordRequest): Promise<TResponse>`
11
+ Signature: `confirmPassword<TResponse = ResetPersonPasswordResponse>(request: ConfirmPersonPasswordRequest): Promise<TResponse>`
12
12
 
13
13
  Return type: `Promise<TResponse>`
14
14
 
@@ -8,7 +8,7 @@ POST /auth/confirm-reset-password
8
8
 
9
9
  `confirmPassword`
10
10
 
11
- Signature: `confirmPassword<TResponse = VerifiedResponse>(request: ConfirmPractitionerPasswordRequest): Promise<TResponse>`
11
+ Signature: `confirmPassword<TResponse = ResetPractitionerPasswordResponse>(request: ConfirmPractitionerPasswordRequest): Promise<TResponse>`
12
12
 
13
13
  Return type: `Promise<TResponse>`
14
14
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@healthcloudai/hc-sdk",
3
- "version": "2.0.2",
3
+ "version": "2.1.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",
@@ -41,7 +41,6 @@
41
41
  "prepublishOnly": "npm run build",
42
42
  "test:live:connectors": "vitest run --config vitest.live.config.ts tests/live/connectors",
43
43
  "test:live:connector": "vitest run --config vitest.live.config.ts",
44
- "test:scenarios:validate": "tsx tests/integration/validateScenarios.ts",
45
44
  "export:la28": "tsx scripts/export-la28.ts",
46
45
  "export:patient-insurance-appointments": "tsx scripts/export-patient-insurance-appointments.ts"
47
46
  },
@@ -1,17 +0,0 @@
1
- # AddNotificationRequest
2
-
3
- Model ID: `AddNotificationRequest`
4
-
5
- No description.
6
-
7
- Type: `object`
8
-
9
- ## Fields
10
-
11
- | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
- |---|---|---:|---|---|---|---:|---|
13
- | `payload` | `array` | No | | | | No | |
14
- | `priority` | `string` | No | | | | No | |
15
- | `sent` | `string` | No | date-time | | | No | |
16
- | `status` | `string` | No | | | | No | |
17
- | `topic` | `object` | No | | | | No | |
@@ -1,15 +0,0 @@
1
- # CommsRtcTokenRequest
2
-
3
- Model ID: `CommsRtcTokenRequest`
4
-
5
- No description.
6
-
7
- Type: `object`
8
-
9
- ## Fields
10
-
11
- | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
- |---|---|---:|---|---|---|---:|---|
13
- | `channelName` | `string` | No | | | | No | |
14
- | `role` | `string` | No | | publisher, subscriber | `"publisher"` | No | |
15
- | `uid` | `string|integer` | No | | | | No | |
@@ -1,19 +0,0 @@
1
- # CommsRtcTokenResponse
2
-
3
- Model ID: `CommsRtcTokenResponse`
4
-
5
- No description.
6
-
7
- Type: `object`
8
-
9
- ## Fields
10
-
11
- | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
- |---|---|---:|---|---|---|---:|---|
13
- | `appId` | `string` | Yes | | | | No | |
14
- | `channelName` | `string` | Yes | | | | No | |
15
- | `expiresAt` | `string` | Yes | date-time | | | No | |
16
- | `role` | `string` | Yes | | | `"publisher"` | No | |
17
- | `rtcToken` | `string` | Yes | | | | No | |
18
- | `ttlSeconds` | `integer` | Yes | | | | No | |
19
- | `uid` | `string` | Yes | | | | No | Echoes the caller-supplied contact id. |
@@ -1,15 +0,0 @@
1
- # LegacyRtcTokenRequest
2
-
3
- Model ID: `FetchRtcTokenRequest`
4
-
5
- No description.
6
-
7
- Type: `object`
8
-
9
- ## Fields
10
-
11
- | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
- |---|---|---:|---|---|---|---:|---|
13
- | `channel_name` | `string` | Yes | | | | No | |
14
- | `role` | `integer` | Yes | | | | No | |
15
- | `uid` | `integer|string` | Yes | | | | No | |
@@ -1,82 +0,0 @@
1
- # POST /fetch_rtc_token
2
-
3
- Operation ID: `telehealth.fetchRtcToken`
4
-
5
- POST /fetch_rtc_token
6
-
7
- ## Public method
8
-
9
- `fetchRtcToken`
10
-
11
- Signature: `fetchRtcToken<TResponse = LegacyRtcTokenResponse>(request: LegacyRtcTokenRequest): Promise<TResponse>`
12
-
13
- Return type: `Promise<TResponse>`
14
-
15
- ## Authentication
16
-
17
- Classification: **UNSPECIFIED**
18
-
19
- ## Prerequisites
20
-
21
- None documented.
22
-
23
- ## HTTP
24
-
25
- `POST /fetch_rtc_token`
26
-
27
- ## Path parameters
28
-
29
- None.
30
-
31
- ## Query parameters
32
-
33
- None.
34
-
35
- ## Body parameters
36
-
37
- | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
38
- |---|---|---:|---|---|---|---:|---|
39
- | `body` | [`FetchRtcTokenRequest`](../models/FetchRtcTokenRequest.md) | Yes | | | | No | |
40
-
41
- Request model: [`FetchRtcTokenRequest`](../models/FetchRtcTokenRequest.md)
42
-
43
- ## Success responses
44
-
45
- | Status | Shape | Content type | Description |
46
- |---|---|---|---|
47
- | `200` | [`FetchRtcTokenResponse`](../models/FetchRtcTokenResponse.md) | application/json | Successful Response |
48
-
49
- ## Common errors
50
-
51
- None declared in canonical OpenAPI.
52
-
53
- ## NodeJS / TypeScript implementation
54
-
55
- ```ts
56
- import { HCSDK } from "@healthcloudai/hc-sdk";
57
- ```
58
-
59
- ```ts
60
- const result = await telehealthClient.fetchRtcToken(request);
61
- ```
62
-
63
- ## cURL
64
-
65
- ```bash
66
- curl -X POST \
67
- -H 'Content-Type: application/json' \
68
- -d '<REQUEST_BODY_JSON>' \
69
- '<BASE_URL>/fetch_rtc_token'
70
- ```
71
-
72
- ## Notes
73
-
74
- None.
75
-
76
- ## Prepared Test Console scenario
77
-
78
- No canonical scenario is currently associated.
79
-
80
- ## Real response
81
-
82
- No approved real integration response is currently published. Unapproved candidates are never rendered as examples.