@tellescope/types-models 1.119.0 → 1.121.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/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', { }>,
@@ -182,6 +183,7 @@ export type OrganizationSettings = {
182
183
  autofillSignature?: boolean,
183
184
  showFullVitalsTab?: boolean,
184
185
  canMoveCalls?: boolean,
186
+ canMoveSMS?: boolean,
185
187
  inboxRepliesMarkRead?: boolean,
186
188
  },
187
189
  tickets?: {
@@ -308,6 +310,7 @@ export interface Organization extends Organization_readonly, Organization_requir
308
310
  hasConnectedPagerDuty?: boolean,
309
311
  hasConnectedSmartMeter?: boolean,
310
312
  hasConnectedAthena?: boolean,
313
+ hasConnectedActiveCampaign?: boolean,
311
314
  hasConnectedDocsumo?: boolean,
312
315
  hasConfiguredZoom?: boolean,
313
316
  hasTicketQueues?: boolean,
@@ -677,6 +680,7 @@ export interface Enduser_updatesDisabled {
677
680
  references?: RelatedRecord[],
678
681
  }
679
682
  export interface Enduser extends Enduser_readonly, Enduser_required, Enduser_updatesDisabled {
683
+ healthie_dietitian_id?: string,
680
684
  unsubscribePhone?: boolean; // on AWS STOP reply
681
685
  externalId?: string;
682
686
  humanReadableId?: string;
@@ -745,6 +749,8 @@ export interface Enduser extends Enduser_readonly, Enduser_required, Enduser_upd
745
749
  athenaPracticeId?: string,
746
750
  athenaDepartmentId?: string,
747
751
  vitalTriggersDisabled?: boolean,
752
+ defaultFromPhone?: string,
753
+ defaultFromEmail?: string,
748
754
  // unsubscribedFromEmail?: boolean,
749
755
  // unsubscribedFromSMS?: boolean,
750
756
  }
@@ -1098,6 +1104,10 @@ export interface ChatRoom extends ChatRoom_readonly, ChatRoom_required, ChatRoom
1098
1104
  suggestedReply?: string,
1099
1105
  assignedTo?: string[],
1100
1106
  discussionRoomId?: string,
1107
+ identifier?: string,
1108
+ source?: string,
1109
+ externalId?: string,
1110
+ references?: RelatedRecord[] // internal, for storing built-in integrations info
1101
1111
  }
1102
1112
 
1103
1113
  export type ChatAttachmentType = 'image' | 'video' | 'file' | string
@@ -1140,6 +1150,7 @@ export interface ChatMessage extends ChatMessage_readonly, ChatMessage_required,
1140
1150
  canvasId?: string,
1141
1151
  isAutoreply?: boolean,
1142
1152
  quote?: string[],
1153
+ references?: RelatedRecord[] // internal, for storing built-in integrations info
1143
1154
  }
1144
1155
 
1145
1156
  export type MessageTemplateType = 'enduser' | 'Reply' | 'team' // default to 'enduser'
@@ -1200,6 +1211,7 @@ export type TicketActions = {
1200
1211
  "Complete Form": TicketActionBuilder<'Complete Form', { formId: string, formResponseId?: string }>,
1201
1212
  "Create Prescription": TicketActionBuilder<'Create Prescription', { }>,
1202
1213
  "Send SMS": TicketActionBuilder<'Send SMS', { templateId: string, smsId?: string }>,
1214
+ "Send Email": TicketActionBuilder<'Send Email', { templateId: string, emailId?: string }>,
1203
1215
  }
1204
1216
  export type TicketActionType = keyof TicketActions
1205
1217
  export type TicketAction = TicketActions[TicketActionType]
@@ -1419,7 +1431,9 @@ export type FormFieldOptions = FormFieldValidation & {
1419
1431
  holdAppointmentMinutes?: number,
1420
1432
  rangeStepSize?: number,
1421
1433
  redirectFormId?: string,
1434
+ redirectExternalUrl?: string,
1422
1435
  groupPadding?: number,
1436
+ saveIntakeOnPartial?: boolean,
1423
1437
  }
1424
1438
  export type MultipleChoiceOptions = Pick<FormFieldOptions, 'choices' | 'radio' | 'other'>
1425
1439
 
@@ -1560,6 +1574,12 @@ export type IntegrationAuthentication = (
1560
1574
  }
1561
1575
  )
1562
1576
 
1577
+ export type FieldMapping = {
1578
+ field: string,
1579
+ externalField: string,
1580
+ type: string,
1581
+ }
1582
+
1563
1583
  export interface Integration_readonly extends ClientRecord {
1564
1584
  lastSync?: number,
1565
1585
  lastSyncId?: string,
@@ -1589,6 +1609,8 @@ export interface Integration extends Integration_readonly, Integration_required,
1589
1609
  fhirAccessToken?: string,
1590
1610
  fhirExpiryDate?: number,
1591
1611
  defaultAttendeeId?: string,
1612
+ sendEmailOnSync?: boolean,
1613
+ enduserFieldMapping?: FieldMapping[],
1592
1614
  }
1593
1615
 
1594
1616
  export type BuildDatabaseRecordField <K extends string, V, O> = { type: K, value: V, options: O & { width?: string } }
@@ -1939,6 +1961,7 @@ export interface CalendarEvent_required {
1939
1961
  }
1940
1962
  export interface CalendarEvent_updatesDisabled {}
1941
1963
  export interface CalendarEvent extends CalendarEvent_readonly, CalendarEvent_required, CalendarEvent_updatesDisabled {
1964
+ reason?: string,
1942
1965
  attendees: UserIdentity[],
1943
1966
  color?: string,
1944
1967
  enableVideoCall?: boolean,
@@ -1988,6 +2011,7 @@ export interface CalendarEvent extends CalendarEvent_readonly, CalendarEvent_req
1988
2011
  bufferStartMinutes?: number,
1989
2012
  bufferEndMinutes?: number,
1990
2013
  canvasCoding?: CanvasCoding,
2014
+ canvasReasonCoding?: CanvasCoding,
1991
2015
  canvasLocationId?: string,
1992
2016
  completedAt?: Date | '',
1993
2017
  holdUntil?: Date,
@@ -2105,6 +2129,7 @@ export interface CalendarEventTemplate extends CalendarEventTemplate_readonly, C
2105
2129
  bufferEndMinutes?: number,
2106
2130
 
2107
2131
  canvasCoding?: CanvasCoding,
2132
+ canvasReasonCoding?: CanvasCoding,
2108
2133
  tags?: string[],
2109
2134
  matchToHealthieTemplate?: boolean,
2110
2135
  useUserURL?: boolean,
@@ -2167,6 +2192,7 @@ export interface AppointmentBookingPage extends AppointmentBookingPage_readonly,
2167
2192
  limitedByState?: boolean,
2168
2193
  limitedByTagsPortal?: string[],
2169
2194
  requireLocationSelection?: boolean,
2195
+ collectReason?: "Do Not Collect" | 'Optional' | 'Required'
2170
2196
  // productIds?: string[], // defer to specific template
2171
2197
  }
2172
2198
 
@@ -2426,6 +2452,7 @@ export type CreateCarePlanAutomationAction = AutomationActionBuilder<'createCare
2426
2452
  }>
2427
2453
  export type CompleteCarePlanAutomationAction = AutomationActionBuilder<'completeCarePlan', {}>
2428
2454
  export type ZusSyncAutomationAction = AutomationActionBuilder<'zusSync', {}>
2455
+ export type ZusPullAutomationAction = AutomationActionBuilder<'zusPull', {}>
2429
2456
  export type PagerDutyCreateIncidentAutomationAction = AutomationActionBuilder<'pagerDutyCreateIncident', { type: string, title: string, serviceId: string }>
2430
2457
  export type SmartMeterOrderLineItem = { quantity: number, sku: string }
2431
2458
  export type SmartMeterPlaceOrderAutomationAction = AutomationActionBuilder<'smartMeterPlaceOrder', {
@@ -2434,8 +2461,10 @@ export type SmartMeterPlaceOrderAutomationAction = AutomationActionBuilder<'smar
2434
2461
  }>
2435
2462
  export type HealthieSyncAutomationAction = AutomationActionBuilder<'healthieSync', {}>
2436
2463
  export type HealthieAddToCourseAutomationAction = AutomationActionBuilder<'healthieAddToCourse', { courseId: string }>
2464
+ export type HealthieSendChatAutomationAction = AutomationActionBuilder<'healthieSendChat', { templateId: string, identifier: string, includeCareTeam?: boolean }>
2437
2465
  export type CompleteTicketsAutomationAction = AutomationActionBuilder<'completeTickets', { journeyIds?: string[] }>
2438
2466
  export type ChangeContactTypeAutomationAction = AutomationActionBuilder<'changeContactType', { type: string }>
2467
+ export type ActiveCampaignSyncAutomationAction = AutomationActionBuilder<'activeCampaignSync', { }>
2439
2468
 
2440
2469
  export type IterableFieldsMapping = {
2441
2470
  iterable: string,
@@ -2485,12 +2514,15 @@ export type AutomationActionForType = {
2485
2514
  'createCarePlan': CreateCarePlanAutomationAction,
2486
2515
  'completeCarePlan': CompleteCarePlanAutomationAction,
2487
2516
  'zusSync': ZusSyncAutomationAction,
2517
+ 'zusPull': ZusPullAutomationAction,
2488
2518
  'pagerDutyCreateIncident': PagerDutyCreateIncidentAutomationAction,
2489
2519
  'smartMeterPlaceOrder': SmartMeterPlaceOrderAutomationAction,
2490
2520
  'healthieSync': HealthieSyncAutomationAction,
2491
2521
  healthieAddToCourse: HealthieAddToCourseAutomationAction,
2522
+ healthieSendChat: HealthieSendChatAutomationAction,
2492
2523
  'completeTickets': CompleteTicketsAutomationAction,
2493
2524
  'changeContactType': ChangeContactTypeAutomationAction,
2525
+ activeCampaignSync: ActiveCampaignSyncAutomationAction,
2494
2526
  }
2495
2527
  export type AutomationActionType = keyof AutomationActionForType
2496
2528
  export type AutomationAction = AutomationActionForType[AutomationActionType]
@@ -3149,6 +3181,11 @@ export type AnalyticsQueryOptions = {
3149
3181
  groupByCareTeam?: boolean, // supports multi-grouping for both care team and a normal field
3150
3182
  }
3151
3183
 
3184
+ export type AnalyticsFrameGroupingCategory = {
3185
+ category: string,
3186
+ keys: string[],
3187
+ }
3188
+
3152
3189
  export type AnalyticsFrameType = 'Percentage'
3153
3190
  export interface AnalyticsFrame_readonly extends ClientRecord {}
3154
3191
  export interface AnalyticsFrame_required {
@@ -3164,6 +3201,8 @@ export interface AnalyticsFrame extends
3164
3201
  type?: AnalyticsFrameType,
3165
3202
  groupMin?: number | '',
3166
3203
  groupMax?: number | '',
3204
+ displayType?: string,
3205
+ analyticsFrameGroupingCategory?: AnalyticsFrameGroupingCategory[],
3167
3206
  }
3168
3207
 
3169
3208
 
@@ -3219,6 +3258,9 @@ export type EnduserProfileViewBlocks = {
3219
3258
  formId: string,
3220
3259
  fieldIds: string[],
3221
3260
  }>,
3261
+ "Zus Encounters": EnduserProfileViewBlockBuilder<"Zus Encounters", {
3262
+ title: string,
3263
+ }>,
3222
3264
  }
3223
3265
  export type EnduserProfileViewBlockType = keyof EnduserProfileViewBlocks
3224
3266
  export type EnduserProfileViewBlock = EnduserProfileViewBlocks[EnduserProfileViewBlockType]
@@ -3266,7 +3308,7 @@ export type AutomationTriggerEvents = {
3266
3308
  }, {}>,
3267
3309
  'Form Unsubmitted': AutomationTriggerEventBuilder<"Form Unsubmitted", { formId: string, intervalInMS: number }, {}>,
3268
3310
  'Purchase Made': AutomationTriggerEventBuilder<"Purchase Made", { }, {}>,
3269
- 'Appointment No-Showed': AutomationTriggerEventBuilder<"Appointment No-Showed", { }, {}>,
3311
+ 'Appointment No-Showed': AutomationTriggerEventBuilder<"Appointment No-Showed", { titles?: string[], templateIds?: string[] }, { }>,
3270
3312
  'Field Equals': AutomationTriggerEventBuilder<"Field Equals", { field: string, value: string }, { }>,
3271
3313
  'Appointment Created': AutomationTriggerEventBuilder<"Appointment Created", { titles?: string[] }, {}>,
3272
3314
  'Appointment Completed': AutomationTriggerEventBuilder<"Appointment Completed", { titles?: string[] }, {}>,
@@ -3623,6 +3665,7 @@ export type Diagnosis = {
3623
3665
  }
3624
3666
  export interface EnduserEncounter_readonly extends ClientRecord {
3625
3667
  externalId?: string,
3668
+ source?: string,
3626
3669
  integration?: 'Candid',
3627
3670
  }
3628
3671
  export interface EnduserEncounter_updatesDisabled {}
@@ -3639,6 +3682,11 @@ export interface EnduserEncounter extends EnduserEncounter_readonly, EnduserEnco
3639
3682
  serviceFacilityAddress?: Address, // could also collect rendering provider address, but it's typically the same as service facility address
3640
3683
  modifiers?: string[],
3641
3684
  error?: string, // e.g. for errors with push to Candid
3685
+ class?: string, // for Zus, e.g. Emergency or Ambulator
3686
+ status?: string, // for Zus, e.g. "finished" or "in-progress" in zus as "Finished" or "In Progress"
3687
+ location?: string, // for Zus, name of location
3688
+ providerNames?: string[], // for Zus, display name of provider
3689
+ diagnosisDisplays?: string[], // for Zus, display name of diagnoses
3642
3690
  }
3643
3691
 
3644
3692
  export interface TicketQueue_readonly extends ClientRecord {