@tellescope/types-models 1.120.0 → 1.122.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/lib/cjs/index.d.ts +47 -1
- package/lib/cjs/index.d.ts.map +1 -1
- package/lib/cjs/index.js.map +1 -1
- package/lib/esm/index.d.ts +47 -1
- package/lib/esm/index.d.ts.map +1 -1
- package/lib/esm/index.js.map +1 -1
- package/lib/tsconfig.tsbuildinfo +1 -1
- package/package.json +2 -2
- package/src/index.ts +46 -3
package/src/index.ts
CHANGED
|
@@ -131,6 +131,7 @@ export type CustomEnduserFields = {
|
|
|
131
131
|
"Select": BuildCustomEnduserField<'Select', { options: string[], other?: boolean }>,
|
|
132
132
|
"Multiple Select": BuildCustomEnduserField<'Multiple Select', { options: string[] }>,
|
|
133
133
|
"Text": BuildCustomEnduserField<'Text', { }>,
|
|
134
|
+
"Number": BuildCustomEnduserField<'Number', { }>,
|
|
134
135
|
"Multiple Text": BuildCustomEnduserField<'Multiple Text', { }>,
|
|
135
136
|
"Date": BuildCustomEnduserField<'Date', { }>,
|
|
136
137
|
"File": BuildCustomEnduserField<'File', { }>,
|
|
@@ -184,6 +185,7 @@ export type OrganizationSettings = {
|
|
|
184
185
|
canMoveCalls?: boolean,
|
|
185
186
|
canMoveSMS?: boolean,
|
|
186
187
|
inboxRepliesMarkRead?: boolean,
|
|
188
|
+
alwaysShowInsurance?: boolean,
|
|
187
189
|
},
|
|
188
190
|
tickets?: {
|
|
189
191
|
defaultJourneyDueDateOffsetInMS?: number | '',
|
|
@@ -309,6 +311,7 @@ export interface Organization extends Organization_readonly, Organization_requir
|
|
|
309
311
|
hasConnectedPagerDuty?: boolean,
|
|
310
312
|
hasConnectedSmartMeter?: boolean,
|
|
311
313
|
hasConnectedAthena?: boolean,
|
|
314
|
+
hasConnectedActiveCampaign?: boolean,
|
|
312
315
|
hasConnectedDocsumo?: boolean,
|
|
313
316
|
hasConfiguredZoom?: boolean,
|
|
314
317
|
hasTicketQueues?: boolean,
|
|
@@ -549,6 +552,7 @@ export interface User extends User_required, User_readonly, User_updatesDisabled
|
|
|
549
552
|
url?: string,
|
|
550
553
|
requiresMFAConfiguration?: boolean,
|
|
551
554
|
templateFields?: LabeledField[]
|
|
555
|
+
dashboardView?: CustomDashboardView,
|
|
552
556
|
}
|
|
553
557
|
|
|
554
558
|
export type Preference = 'email' | 'sms' | 'call' | 'chat'
|
|
@@ -747,6 +751,9 @@ export interface Enduser extends Enduser_readonly, Enduser_required, Enduser_upd
|
|
|
747
751
|
athenaPracticeId?: string,
|
|
748
752
|
athenaDepartmentId?: string,
|
|
749
753
|
vitalTriggersDisabled?: boolean,
|
|
754
|
+
defaultFromPhone?: string,
|
|
755
|
+
defaultFromEmail?: string,
|
|
756
|
+
useDefaultFromEmailInAutomations?: boolean,
|
|
750
757
|
// unsubscribedFromEmail?: boolean,
|
|
751
758
|
// unsubscribedFromSMS?: boolean,
|
|
752
759
|
}
|
|
@@ -783,6 +790,7 @@ export interface EnduserMedication extends EnduserMedication_readonly, EnduserMe
|
|
|
783
790
|
calendarEventId?: string,
|
|
784
791
|
prescribedBy?: string,
|
|
785
792
|
prescribedAt?: Date | '',
|
|
793
|
+
prescriberName?: string,
|
|
786
794
|
startedTakingAt?: Date | '',
|
|
787
795
|
stoppedTakingAt?: Date | '',
|
|
788
796
|
rxNormCode?: string,
|
|
@@ -1207,6 +1215,7 @@ export type TicketActions = {
|
|
|
1207
1215
|
"Complete Form": TicketActionBuilder<'Complete Form', { formId: string, formResponseId?: string }>,
|
|
1208
1216
|
"Create Prescription": TicketActionBuilder<'Create Prescription', { }>,
|
|
1209
1217
|
"Send SMS": TicketActionBuilder<'Send SMS', { templateId: string, smsId?: string }>,
|
|
1218
|
+
"Send Email": TicketActionBuilder<'Send Email', { templateId: string, emailId?: string }>,
|
|
1210
1219
|
}
|
|
1211
1220
|
export type TicketActionType = keyof TicketActions
|
|
1212
1221
|
export type TicketAction = TicketActions[TicketActionType]
|
|
@@ -1468,7 +1477,8 @@ export interface FormField extends FormField_readonly, FormField_required, FormF
|
|
|
1468
1477
|
databaseId?: string,
|
|
1469
1478
|
field?: string,
|
|
1470
1479
|
overwrite?: boolean,
|
|
1471
|
-
}
|
|
1480
|
+
},
|
|
1481
|
+
titleFontSize?: number,
|
|
1472
1482
|
}
|
|
1473
1483
|
|
|
1474
1484
|
export type FormScoring = {
|
|
@@ -1569,6 +1579,12 @@ export type IntegrationAuthentication = (
|
|
|
1569
1579
|
}
|
|
1570
1580
|
)
|
|
1571
1581
|
|
|
1582
|
+
export type FieldMapping = {
|
|
1583
|
+
field: string,
|
|
1584
|
+
externalField: string,
|
|
1585
|
+
type: string,
|
|
1586
|
+
}
|
|
1587
|
+
|
|
1572
1588
|
export interface Integration_readonly extends ClientRecord {
|
|
1573
1589
|
lastSync?: number,
|
|
1574
1590
|
lastSyncId?: string,
|
|
@@ -1599,6 +1615,7 @@ export interface Integration extends Integration_readonly, Integration_required,
|
|
|
1599
1615
|
fhirExpiryDate?: number,
|
|
1600
1616
|
defaultAttendeeId?: string,
|
|
1601
1617
|
sendEmailOnSync?: boolean,
|
|
1618
|
+
enduserFieldMapping?: FieldMapping[],
|
|
1602
1619
|
}
|
|
1603
1620
|
|
|
1604
1621
|
export type BuildDatabaseRecordField <K extends string, V, O> = { type: K, value: V, options: O & { width?: string } }
|
|
@@ -1999,6 +2016,7 @@ export interface CalendarEvent extends CalendarEvent_readonly, CalendarEvent_req
|
|
|
1999
2016
|
bufferStartMinutes?: number,
|
|
2000
2017
|
bufferEndMinutes?: number,
|
|
2001
2018
|
canvasCoding?: CanvasCoding,
|
|
2019
|
+
canvasReasonCoding?: CanvasCoding,
|
|
2002
2020
|
canvasLocationId?: string,
|
|
2003
2021
|
completedAt?: Date | '',
|
|
2004
2022
|
holdUntil?: Date,
|
|
@@ -2116,6 +2134,7 @@ export interface CalendarEventTemplate extends CalendarEventTemplate_readonly, C
|
|
|
2116
2134
|
bufferEndMinutes?: number,
|
|
2117
2135
|
|
|
2118
2136
|
canvasCoding?: CanvasCoding,
|
|
2137
|
+
canvasReasonCoding?: CanvasCoding,
|
|
2119
2138
|
tags?: string[],
|
|
2120
2139
|
matchToHealthieTemplate?: boolean,
|
|
2121
2140
|
useUserURL?: boolean,
|
|
@@ -2407,11 +2426,12 @@ export type CreateTicketActionInfo = {
|
|
|
2407
2426
|
tags?: string[],
|
|
2408
2427
|
}
|
|
2409
2428
|
|
|
2410
|
-
export type SendEmailAutomationAction = AutomationActionBuilder<'sendEmail', AutomationForMessage>
|
|
2429
|
+
export type SendEmailAutomationAction = AutomationActionBuilder<'sendEmail', AutomationForMessage & { fromEmailOverride?: string }>
|
|
2411
2430
|
export type NotifyTeamAutomationAction = AutomationActionBuilder<'notifyTeam', {
|
|
2412
2431
|
templateId: string,
|
|
2413
2432
|
forAssigned: boolean,
|
|
2414
2433
|
roles?: string[],
|
|
2434
|
+
tags?: ListOfStringsWithQualifier,
|
|
2415
2435
|
}>
|
|
2416
2436
|
export type SendSMSAutomationAction = AutomationActionBuilder<'sendSMS', AutomationForMessage>
|
|
2417
2437
|
export type SendFormAutomationAction = AutomationActionBuilder<'sendForm', AutomationForFormRequest>
|
|
@@ -2438,6 +2458,7 @@ export type CreateCarePlanAutomationAction = AutomationActionBuilder<'createCare
|
|
|
2438
2458
|
}>
|
|
2439
2459
|
export type CompleteCarePlanAutomationAction = AutomationActionBuilder<'completeCarePlan', {}>
|
|
2440
2460
|
export type ZusSyncAutomationAction = AutomationActionBuilder<'zusSync', {}>
|
|
2461
|
+
export type ZusPullAutomationAction = AutomationActionBuilder<'zusPull', {}>
|
|
2441
2462
|
export type PagerDutyCreateIncidentAutomationAction = AutomationActionBuilder<'pagerDutyCreateIncident', { type: string, title: string, serviceId: string }>
|
|
2442
2463
|
export type SmartMeterOrderLineItem = { quantity: number, sku: string }
|
|
2443
2464
|
export type SmartMeterPlaceOrderAutomationAction = AutomationActionBuilder<'smartMeterPlaceOrder', {
|
|
@@ -2449,6 +2470,7 @@ export type HealthieAddToCourseAutomationAction = AutomationActionBuilder<'healt
|
|
|
2449
2470
|
export type HealthieSendChatAutomationAction = AutomationActionBuilder<'healthieSendChat', { templateId: string, identifier: string, includeCareTeam?: boolean }>
|
|
2450
2471
|
export type CompleteTicketsAutomationAction = AutomationActionBuilder<'completeTickets', { journeyIds?: string[] }>
|
|
2451
2472
|
export type ChangeContactTypeAutomationAction = AutomationActionBuilder<'changeContactType', { type: string }>
|
|
2473
|
+
export type ActiveCampaignSyncAutomationAction = AutomationActionBuilder<'activeCampaignSync', { }>
|
|
2452
2474
|
|
|
2453
2475
|
export type IterableFieldsMapping = {
|
|
2454
2476
|
iterable: string,
|
|
@@ -2498,6 +2520,7 @@ export type AutomationActionForType = {
|
|
|
2498
2520
|
'createCarePlan': CreateCarePlanAutomationAction,
|
|
2499
2521
|
'completeCarePlan': CompleteCarePlanAutomationAction,
|
|
2500
2522
|
'zusSync': ZusSyncAutomationAction,
|
|
2523
|
+
'zusPull': ZusPullAutomationAction,
|
|
2501
2524
|
'pagerDutyCreateIncident': PagerDutyCreateIncidentAutomationAction,
|
|
2502
2525
|
'smartMeterPlaceOrder': SmartMeterPlaceOrderAutomationAction,
|
|
2503
2526
|
'healthieSync': HealthieSyncAutomationAction,
|
|
@@ -2505,6 +2528,7 @@ export type AutomationActionForType = {
|
|
|
2505
2528
|
healthieSendChat: HealthieSendChatAutomationAction,
|
|
2506
2529
|
'completeTickets': CompleteTicketsAutomationAction,
|
|
2507
2530
|
'changeContactType': ChangeContactTypeAutomationAction,
|
|
2531
|
+
activeCampaignSync: ActiveCampaignSyncAutomationAction,
|
|
2508
2532
|
}
|
|
2509
2533
|
export type AutomationActionType = keyof AutomationActionForType
|
|
2510
2534
|
export type AutomationAction = AutomationActionForType[AutomationActionType]
|
|
@@ -2928,7 +2952,10 @@ export type DateRange = { from?: Date | '', to?: Date | '' }
|
|
|
2928
2952
|
|
|
2929
2953
|
type AnalyticsQueryInfoBuilder <M extends string, P extends object | undefined> = { method: M, parameters: P }
|
|
2930
2954
|
export type AnalyticsQueryInfoForType = {
|
|
2931
|
-
"Endusers": {
|
|
2955
|
+
"Endusers": {
|
|
2956
|
+
Total: AnalyticsQueryInfoBuilder<'Total', undefined>,
|
|
2957
|
+
"Sum of Field": AnalyticsQueryInfoBuilder<"Sum of Field", { field: string }>,
|
|
2958
|
+
},
|
|
2932
2959
|
"Calendar Events": { Total: AnalyticsQueryInfoBuilder<'Total', undefined> },
|
|
2933
2960
|
"Form Responses": { Total: AnalyticsQueryInfoBuilder<'Total', undefined> },
|
|
2934
2961
|
"Purchases": { Total: AnalyticsQueryInfoBuilder<'Total', undefined> },
|
|
@@ -3163,6 +3190,11 @@ export type AnalyticsQueryOptions = {
|
|
|
3163
3190
|
groupByCareTeam?: boolean, // supports multi-grouping for both care team and a normal field
|
|
3164
3191
|
}
|
|
3165
3192
|
|
|
3193
|
+
export type AnalyticsFrameGroupingCategory = {
|
|
3194
|
+
category: string,
|
|
3195
|
+
keys: string[],
|
|
3196
|
+
}
|
|
3197
|
+
|
|
3166
3198
|
export type AnalyticsFrameType = 'Percentage'
|
|
3167
3199
|
export interface AnalyticsFrame_readonly extends ClientRecord {}
|
|
3168
3200
|
export interface AnalyticsFrame_required {
|
|
@@ -3178,6 +3210,8 @@ export interface AnalyticsFrame extends
|
|
|
3178
3210
|
type?: AnalyticsFrameType,
|
|
3179
3211
|
groupMin?: number | '',
|
|
3180
3212
|
groupMax?: number | '',
|
|
3213
|
+
displayType?: string,
|
|
3214
|
+
analyticsFrameGroupingCategory?: AnalyticsFrameGroupingCategory[],
|
|
3181
3215
|
}
|
|
3182
3216
|
|
|
3183
3217
|
|
|
@@ -3233,6 +3267,9 @@ export type EnduserProfileViewBlocks = {
|
|
|
3233
3267
|
formId: string,
|
|
3234
3268
|
fieldIds: string[],
|
|
3235
3269
|
}>,
|
|
3270
|
+
"Zus Encounters": EnduserProfileViewBlockBuilder<"Zus Encounters", {
|
|
3271
|
+
title: string,
|
|
3272
|
+
}>,
|
|
3236
3273
|
}
|
|
3237
3274
|
export type EnduserProfileViewBlockType = keyof EnduserProfileViewBlocks
|
|
3238
3275
|
export type EnduserProfileViewBlock = EnduserProfileViewBlocks[EnduserProfileViewBlockType]
|
|
@@ -3637,6 +3674,7 @@ export type Diagnosis = {
|
|
|
3637
3674
|
}
|
|
3638
3675
|
export interface EnduserEncounter_readonly extends ClientRecord {
|
|
3639
3676
|
externalId?: string,
|
|
3677
|
+
source?: string,
|
|
3640
3678
|
integration?: 'Candid',
|
|
3641
3679
|
}
|
|
3642
3680
|
export interface EnduserEncounter_updatesDisabled {}
|
|
@@ -3653,6 +3691,11 @@ export interface EnduserEncounter extends EnduserEncounter_readonly, EnduserEnco
|
|
|
3653
3691
|
serviceFacilityAddress?: Address, // could also collect rendering provider address, but it's typically the same as service facility address
|
|
3654
3692
|
modifiers?: string[],
|
|
3655
3693
|
error?: string, // e.g. for errors with push to Candid
|
|
3694
|
+
class?: string, // for Zus, e.g. Emergency or Ambulator
|
|
3695
|
+
status?: string, // for Zus, e.g. "finished" or "in-progress" in zus as "Finished" or "In Progress"
|
|
3696
|
+
location?: string, // for Zus, name of location
|
|
3697
|
+
providerNames?: string[], // for Zus, display name of provider
|
|
3698
|
+
diagnosisDisplays?: string[], // for Zus, display name of diagnoses
|
|
3656
3699
|
}
|
|
3657
3700
|
|
|
3658
3701
|
export interface TicketQueue_readonly extends ClientRecord {
|