@tellescope/types-models 1.92.0 → 1.94.0

package/src/index.ts

@@ -167,8 +167,9 @@ export type OrganizationSettings = {
     showFreeNote?: boolean,
     canDeleteFreeNote?: boolean,
     recordCalls?: boolean,
+    recordCallAudioPlayback?: string, 
     transcribeCalls?: boolean,
-    transcribeCallInboundPlayback?: string,
+    transcribeCallInboundPlayback?: string, // should be 'recordCall' but too late
     showDeleteCallRecordingOnTimeline?: boolean,
     defaultPhoneNumber?: string,
     sendSMSOnZoomStart?: boolean,
@@ -186,6 +187,7 @@ export type OrganizationSettings = {
     disableSnooze?: boolean,
     showCommunications?: boolean,
     showJourneys?: boolean,
+    requireDueDate?: boolean,
   },
   calendar?: {
     dayStart?: {
@@ -320,6 +322,7 @@ export interface Organization extends Organization_readonly, Organization_requir
   billingOrganizationAddress?: Address,
   videoCallBackgroundImage?: string,
   sendToVoicemailOOO?: boolean
+  onCallUserIds?: string[],
   outOfOfficeVoicemail?: PhonePlayback
   enduserProfileWebhooks?: BasicWebhook[],
   showCommunity?: boolean,
@@ -334,6 +337,7 @@ export interface Organization extends Organization_readonly, Organization_requir
     questionId: string,
   },
   dosespotClinics?: { id: string, name: string }[],
+  enforceMFA?: boolean,
   // _AIEnabled?: boolean,
 }
 export type OrganizationTheme = {
@@ -518,6 +522,8 @@ export interface User extends User_required, User_readonly, User_updatesDisabled
   elationUserId?: number,
   iOSBadgeCount?: number,
   doseSpotUserId?: string,
+  url?: string,
+  requiresMFAConfiguration?: boolean,
 }
 
 export type Preference = 'email' | 'sms' | 'call' | 'chat'
@@ -559,7 +565,13 @@ export type ScheduledJourney = {
 }
 
 export type EnduserRelationship = {
-  type: 'Parent' | 'Child' | 'Spouse' | 'Partner' | 'Sibling' | 'Relates To' | 'Grandparent' | 'Grandchild' | 'Caregiver' | 'Caretaker' | 'Care Recipient'
+  type: (
+    'Parent' | 'Child' | 'Spouse' | 'Partner' | 'Sibling' | 'Grandparent' | 'Grandchild'
+    | 'Caregiver' | 'Caretaker' | 'Care Recipient'
+    | 'Power of Attorney' | 'Power of Attorney For'
+    | "Emergency Contact"  | "Emergency Contact For"
+    | 'Relates To' 
+  )
   id: string,
 }
 export type Language = {
@@ -618,6 +630,7 @@ export type EnduserInsurance = {
     // email?: string, // not needed yet
   },
   payerType?: string, // for Healthie
+  groupNumber?: string,
 }
 
 export type TellescopeGender = "Male" | "Female" | "Other" | "Unknown"
@@ -1104,7 +1117,9 @@ export interface MessageTemplate extends MessageTemplate_readonly, MessageTempla
   isMarketing?: boolean,
   forChannels?: string[],
   forRoles?: string[],
+  forEntityTypes?: string[],
   hideFromCompose?: boolean,
+  tags?: string[],
 }
 
 export interface File_readonly extends ClientRecord {
@@ -1330,6 +1345,7 @@ export type FormFieldOptions = FormFieldValidation & {
   },
   useDatePicker?: boolean,
   sharedIntakeFields?: string[],
+  hiddenDefaultFields?: string[],
   copyResponse?: boolean, // copy to related contacts when created
   disableGoBack?: boolean,
   disableNext?: boolean,
@@ -1344,6 +1360,7 @@ export type FormFieldOptions = FormFieldValidation & {
   validStates?: string[],
   autoAdvance?: boolean,
   prefillSignature?: boolean,
+  includeGroupNumber?: boolean,
 }
 export type MultipleChoiceOptions = Pick<FormFieldOptions, 'choices' | 'radio' | 'other'>
 
@@ -1486,6 +1503,7 @@ export interface Integration extends Integration_readonly, Integration_required,
   authentication: IntegrationAuthentication,
   emailDisabled?: boolean, 
   syncUnrecognizedSenders?: boolean,
+  createEndusersForUnrecognizedSenders?: boolean,
   calendars?: string[],
   environment?: string,
   webhooksSecret?: string,
@@ -1982,7 +2000,8 @@ export interface CalendarEventTemplate extends CalendarEventTemplate_readonly, C
   bufferEndMinutes?: number,
 
   canvasCoding?: CanvasCoding,
-  tags?: string[]
+  tags?: string[],
+  matchToHealthieTemplate?: boolean,
 }
 
 export interface AppointmentLocation_readonly extends ClientRecord {}
@@ -2292,6 +2311,7 @@ export type SmartMeterPlaceOrderAutomationAction = AutomationActionBuilder<'smar
 }>
 export type HealthieSyncAutomationAction = AutomationActionBuilder<'healthieSync', {}>
 export type CompleteTicketsAutomationAction = AutomationActionBuilder<'completeTickets', { journeyIds?: string[] }>
+export type ChangeContactTypeAutomationAction = AutomationActionBuilder<'changeContactType', { type: string }>
 
 export type IterableFieldsMapping = {
   iterable: string,
@@ -2345,6 +2365,7 @@ export type AutomationActionForType = {
   'smartMeterPlaceOrder': SmartMeterPlaceOrderAutomationAction,
   'healthieSync': HealthieSyncAutomationAction,
   'completeTickets': CompleteTicketsAutomationAction,
+  'changeContactType': ChangeContactTypeAutomationAction,
 }
 export type AutomationActionType = keyof AutomationActionForType
 export type AutomationAction = AutomationActionForType[AutomationActionType]
@@ -3052,6 +3073,11 @@ export type EnduserProfileViewBlocks = {
     fields: string[],
     displayFields?: { field: string, display: string }[],
   }>,
+  "Form Responses": EnduserProfileViewBlockBuilder<"Form Responses", { 
+    title: string, 
+    formId: string,
+    fieldIds: string[],
+  }>,
 }
 export type EnduserProfileViewBlockType = keyof EnduserProfileViewBlocks
 export type EnduserProfileViewBlock = EnduserProfileViewBlocks[EnduserProfileViewBlockType]
@@ -3096,6 +3122,8 @@ export type AutomationTriggerEvents = {
   'Field Equals': AutomationTriggerEventBuilder<"Field Equals", { field: string, value: string }, { }>,
   'Appointment Created': AutomationTriggerEventBuilder<"Appointment Created", { titles?: string[] }, {}>,
   'Appointment Completed': AutomationTriggerEventBuilder<"Appointment Completed", { titles?: string[] }, {}>,
+  'Appointment Cancelled': AutomationTriggerEventBuilder<"Appointment Cancelled", { titles?: string[] }, {}>,
+  'Appointment Rescheduled': AutomationTriggerEventBuilder<"Appointment Rescheduled", { titles?: string[] }, {}>,
   'Medication Added': AutomationTriggerEventBuilder<"Medication Added", { titles: string[] }, {}>,
   'No Recent Appointment': AutomationTriggerEventBuilder<"No Recent Appointment", { 
     intervalInMS: number, 
@@ -3122,6 +3150,10 @@ export type AutomationTriggerEvents = {
     phoneNumbers?: string[], 
     inputs?: string[], 
   }, {}>,
+  'Order Created': AutomationTriggerEventBuilder<"Order Created", { titles?: string[] }, {}>,
+  'Problem Created': AutomationTriggerEventBuilder<"Problem Created", { titles?: string[] }, {}>,
+  'Message Delivery Failure': AutomationTriggerEventBuilder<"Message Delivery Failure", { }, {}>,
+  'Incoming Message (No Care Team)': AutomationTriggerEventBuilder<"Incoming Message (No Care Team)", { }, {}>,
 }
 export type AutomationTriggerEventType = keyof AutomationTriggerEvents
 export type AutomationTriggerEvent = AutomationTriggerEvents[AutomationTriggerEventType]
@@ -3225,7 +3257,7 @@ export type PhoneTreeActions = {
   // 'Play': PhoneTreeActionBuilder<"Play", { playback: PhonePlayback }>
   'Gather': PhoneTreeActionBuilder<"Gather", { digits: boolean, speech: boolean, playback: PhonePlayback }>
   'Voicemail': PhoneTreeActionBuilder<"Voicemail", { playback: PhonePlayback }>
-  'Play Message': PhoneTreeActionBuilder<"Play Message", { playback: PhonePlayback }>
+  'Play Message': PhoneTreeActionBuilder<"Play Message", { playback: PhonePlayback, journeyId?: string }>
   'Dial Users': PhoneTreeActionBuilder<"Dial Users", { userIds: string[], playback?: Partial<PhonePlayback> }>
   'Route Call': PhoneTreeActionBuilder<"Route Call", { 
     prePlayback?: Partial<PhonePlayback>,
@@ -3373,6 +3405,7 @@ export interface EnduserOrder extends EnduserOrder_readonly, EnduserOrder_requir
   externalId: string,
   source: string,
   title: string,
+  description?: string,
   status: string,
   enduserId: string,
   userId?: string,
@@ -3384,6 +3417,19 @@ export interface EnduserOrder extends EnduserOrder_readonly, EnduserOrder_requir
   tracking?: string,
 }
 
+export interface EnduserProblem_readonly extends ClientRecord {}
+export interface EnduserProblem_updatesDisabled {}
+export interface EnduserProblem_required {}
+export interface EnduserProblem extends EnduserProblem_readonly, EnduserProblem_required, EnduserProblem_updatesDisabled {
+  externalId?: string,
+  source?: string,
+  title: string,
+  enduserId: string,
+  code?: string,
+  codeset?: string,
+  references?: RelatedRecord[],
+}
+
 export type CandidProcedureCode = {
   code: string,
   quantity: number,
@@ -3516,9 +3562,22 @@ export interface PrescriptionRoute extends PrescriptionRoute_readonly, Prescript
   state: string,
   templateIds: string[],
   pharmacyId?: string,
+  pharmacyLabel?: string,
+  tags?: string[],
+}
+
+export interface FlowchartNote_readonly extends ClientRecord { }
+export interface FlowchartNote_required {}
+export interface FlowchartNote_updatesDisabled {}
+export interface FlowchartNote extends FlowchartNote_readonly, FlowchartNote_required, FlowchartNote_updatesDisabled {
+  flowchartId: string,
+  note: string,
+  flowchartUI?: FlowchartUI,
 }
 
 export type ModelForName_required = {
+  flowchart_notes: FlowchartNote_required,
+  enduser_problems: EnduserProblem_required,
   prescription_routes: PrescriptionRoute_required,
   vital_configurations: VitalConfiguration_required,
   blocked_phones: BlockedPhone_required,
@@ -3594,6 +3653,8 @@ export type ModelForName_required = {
 export type ClientModel_required = ModelForName_required[keyof ModelForName_required]
 
 export interface ModelForName_readonly {
+  flowchart_notes: FlowchartNote_readonly,
+  enduser_problems: EnduserProblem_readonly,
   prescription_routes: PrescriptionRoute_readonly,
   blocked_phones: BlockedPhone_readonly,
   vital_configurations: VitalConfiguration_readonly,
@@ -3669,6 +3730,8 @@ export interface ModelForName_readonly {
 export type ClientModel_readonly = ModelForName_readonly[keyof ModelForName_readonly]
 
 export interface ModelForName_updatesDisabled {
+  flowchart_notes: FlowchartNote_updatesDisabled,
+  enduser_problems: EnduserProblem_updatesDisabled,
   prescription_routes: PrescriptionRoute_updatesDisabled,
   blocked_phones: BlockedPhone_updatesDisabled,
   vital_configurations: VitalConfiguration_updatesDisabled,
@@ -3744,6 +3807,8 @@ export interface ModelForName_updatesDisabled {
 export type ClientModel_updatesDisabled = ModelForName_updatesDisabled[keyof ModelForName_updatesDisabled]
 
 export interface ModelForName extends ModelForName_required, ModelForName_readonly {
+  flowchart_notes: FlowchartNote,
+  enduser_problems: EnduserProblem,
   prescription_routes: PrescriptionRoute,
   blocked_phones: BlockedPhone,
   vital_configurations: VitalConfiguration,
@@ -3829,6 +3894,8 @@ export interface UserActivityInfo {
 export type UserActivityStatus = 'Active' | 'Away' | 'Unavailable'
 
 export const modelNameChecker: { [K in ModelName] : true } = {
+  flowchart_notes: true,
+  enduser_problems: true,
   prescription_routes: true,
   blocked_phones: true,
   vital_configurations: true,
@@ -3928,6 +3995,7 @@ export type JourneyContext = {
   orderId?: string,
   observationId?: string,
   phoneCallId?: string,
+  smsId?: string,
 }
 
 // https://gist.github.com/aviflax/a4093965be1cd008f172/