@tellescope/types-models 1.205.0 → 1.207.0

package/src/index.ts

@@ -260,6 +260,7 @@ export type OrganizationSettings = {
   },
   integrations?: {
     vitalLabOrderPhysicianOptional?: boolean,
+    athenaAppointmentSyncJITSeconds?: number,
   },
   interface?: {
     dontPersistSearches?: boolean,
@@ -328,6 +329,7 @@ export interface Organization_updatesDisabled {
   subdomain: string;
 }
 export interface Organization extends Organization_readonly, Organization_required, Organization_updatesDisabled {
+  bedrockAIAllowed?: boolean,
   subdomains?: string[],
   owner?: string,
   timezone?: Timezone,
@@ -435,6 +437,8 @@ export interface Organization extends Organization_readonly, Organization_requir
   customerIOFields?: string[],
   customerIOIdField?: string,
   createEnduserForms?: string[],
+  creditCount?: number,
+  creditTrialStartedAt?: Date,
   // _AIEnabled?: boolean,
 }
 export type OrganizationTheme = {
@@ -458,6 +462,7 @@ export type OrganizationTheme = {
   customPoliciesVersion?: string,
   requireCustomTermsOnMagicLink?: boolean,
   hasConnectedVital?: boolean,
+  brandId?: string,
 }
 
 
@@ -762,6 +767,13 @@ export type EnduserInsurance = {
   startDate?: string,
 }
 
+export type EnduserDevice = {
+  title: string,
+  id: string,
+  gatewayId?: string,
+  disabled?: boolean,
+}
+
 export type EnduserDiagnosis = {
   id?: string, // if created in Tellescope
   createdAt?: Date,
@@ -863,11 +875,7 @@ export interface Enduser extends Enduser_readonly, Enduser_required, Enduser_upd
   insurance?: EnduserInsurance,
   insuranceSecondary?: EnduserInsurance,
   bookingNotes?: { bookingPageId: string, note: string }[]
-  devices?: {
-    title: string,
-    id: string,
-    disabled?: boolean,
-  }[],
+  devices?: EnduserDevice[],
   salesforceId?: string,
   athenaPracticeId?: string,
   athenaDepartmentId?: string,
@@ -1610,6 +1618,7 @@ export type FormFieldOptions = FormFieldValidation & {
     fieldId?: string,
     databaseLabel?: string,
   },
+  allowAddToDatabase?: boolean,
   useDatePicker?: boolean,
   sharedIntakeFields?: string[],
   hiddenDefaultFields?: string[],
@@ -1674,6 +1683,7 @@ export interface FormField_required {
 }
 export interface FormField_updatesDisabled {}
 export interface FormField extends FormField_readonly, FormField_required, FormField_updatesDisabled {
+  internalNote?: string,
   placeholder ?: string,
   isOptional  ?: boolean,
   fullZIP     ?: boolean,
@@ -2300,6 +2310,7 @@ export interface CalendarEvent_required {
 }
 export interface CalendarEvent_updatesDisabled {}
 export interface CalendarEvent extends CalendarEvent_readonly, CalendarEvent_required, CalendarEvent_updatesDisabled {
+  updateKey?: string,
   createAndBookAthenaSlot?: boolean,
   athenaDepartmentId?: string,
   generateAthenaTelehealthLink?: boolean,
@@ -2645,6 +2656,7 @@ export type AutomationEventType =
   | "formsUnsubmitted"
   | "ticketCompleted"
   | 'waitForTrigger'
+  | "onCallOutcome"
 
 interface AutomationEventBuilder <T extends AutomationEventType, V extends object> {
   type: T,
@@ -2691,6 +2703,8 @@ export interface AutomationForWebhook {
   url?: string,
   secret?: string,
   fields?: LabeledField[],
+  headers?: LabeledField[],
+  method?: 'get' | 'patch' | 'post' | 'put' | 'delete',
 }
 
 export type FormResponseAutomationEvent = AutomationEventBuilder<'formResponse', {
@@ -2745,6 +2759,7 @@ export type FormsUnsubmittedEvent = AutomationEventBuilder<'formsUnsubmitted', F
 export type OnJourneyStartAutomationEvent = AutomationEventBuilder<'onJourneyStart', {}> 
 export type TicketCompletedAutomationEvent = AutomationEventBuilder<'ticketCompleted', TicketCompletedEventInfo>
 export type WaitForTriggerAutomationEvent = AutomationEventBuilder<'waitForTrigger', { automationStepId: string, triggerId: string }> 
+export type OnCallOutcomeAutomationEvent = AutomationEventBuilder<'onCallOutcome', { automationStepId: string, outcome: string }> 
 
 export type AutomationEvent = 
   FormResponseAutomationEvent
@@ -2755,6 +2770,7 @@ export type AutomationEvent =
   | FormsUnsubmittedEvent
   | TicketCompletedAutomationEvent
   | WaitForTriggerAutomationEvent
+  | OnCallOutcomeAutomationEvent
 
 export type AutomationEventForType = {
   'onJourneyStart': OnJourneyStartAutomationEvent
@@ -2765,6 +2781,7 @@ export type AutomationEventForType = {
   'formsUnsubmitted': FormsUnsubmittedEvent
   'ticketCompleted': TicketCompletedAutomationEvent
   'waitForTrigger': WaitForTriggerAutomationEvent
+  'onCallOutcome': OnCallOutcomeAutomationEvent,
 }
 
 export type SetEnduserStatusInfo = { status: string }
@@ -2842,7 +2859,7 @@ export type CreateTicketActionInfo = {
   disableEditTitle?: boolean,
 }
 
-export type SendEmailAutomationAction = AutomationActionBuilder<'sendEmail', AutomationForMessage & { fromEmailOverride?: string }>
+export type SendEmailAutomationAction = AutomationActionBuilder<'sendEmail', AutomationForMessage & { fromEmailOverride?: string, ccRelatedContactTypes?: string[], }>
 export type NotifyTeamAutomationAction = AutomationActionBuilder<'notifyTeam', {
   templateId: string,
   forAssigned: boolean,
@@ -2890,6 +2907,7 @@ export type SendChatAutomationAction = AutomationActionBuilder<'sendChat', {
   identifier: string, 
   includeCareTeam?: boolean,
   userIds?: string[], // for when not includeCareTeam
+  sendToDestinationOfRelatedContactTypes?: string[],
 }>
 export type HealthieSyncAutomationAction = AutomationActionBuilder<'healthieSync', {}>
 export type HealthieAddToCourseAutomationAction = AutomationActionBuilder<'healthieAddToCourse', { courseId: string }>
@@ -2954,8 +2972,12 @@ export type AutomationConditionBuilder <T extends AutomationConditionType, V ext
 }
 export type AtJourneyStateAutomationCondition = AutomationConditionBuilder<'atJourneyState', AutomationForJourneyAndState>
 export type AutomationCondition = AtJourneyStateAutomationCondition
+export type OutboundCallAutomationAction = AutomationActionBuilder<'outboundCall', {
+  treeId: string, // id of the call tree to use
+}>
 
 export type AutomationActionForType = {
+  'outboundCall': OutboundCallAutomationAction,
   "sendEmail" : SendEmailAutomationAction,
   "sendSMS": SendSMSAutomationAction,
   "sendChat": SendChatAutomationAction,
@@ -3210,6 +3232,7 @@ export interface PortalCustomization extends PortalCustomization_readonly, Porta
   hideReschedule?: boolean,
   hiddenEventTitles?: string[],
   hiddenFormIds?: string[],
+  brandId?: string,
 }
 export const MOBILE_BOTTOM_NAVIGATION_DISABLED_POSITION = 1000
 export const DEFAULT_PATIENT_PORTAL_BOTTOM_NAVIGATION_POSITIONS: { [K in PortalPage]: number } = {
@@ -3585,6 +3608,7 @@ export type AnalyticsQueryGroupingForType = {
     Type: boolean,
     "Scheduled By"?: boolean,
     alsoGroupByHost?: boolean, // for further breaking down a grouping by host
+    "Cancel Reason"?: boolean,
   } & EnduserGrouping & { Enduser: string },
   "Form Responses": {
     "Submitted By"?: boolean,
@@ -3943,6 +3967,7 @@ export type AutomationTriggerEvents = {
   'Subscription Payment Failed': AutomationTriggerEventBuilder<"Subscription Payment Failed", { }, {}>,
   'Appointment No-Showed': AutomationTriggerEventBuilder<"Appointment No-Showed", { titles?: string[], templateIds?: string[] }, { }>,
   'Field Equals': AutomationTriggerEventBuilder<"Field Equals", { field: string, value: string }, { }>,
+  'Fields Changed': AutomationTriggerEventBuilder<"Fields Changed", { fields: string[] }, { }>,
   'Tag Added': AutomationTriggerEventBuilder<"Tag Added", { tag: string }, { }>,
   'Contact Created': AutomationTriggerEventBuilder<"Contact Created", { entityTypes?: string[] }, { }>,
   'Appointment Created': AutomationTriggerEventBuilder<"Appointment Created", { titles?: string[], templateIds?: string[], excludeTemplateIds?: string[] }, {}>,
@@ -4118,7 +4143,7 @@ export type PhoneTreeActions = {
   // 'Play': PhoneTreeActionBuilder<"Play", { playback: PhonePlayback }>
   'Gather': PhoneTreeActionBuilder<"Gather", { digits: boolean, speech: boolean, playback: PhonePlayback, duration?: number }>
   'Voicemail': PhoneTreeActionBuilder<"Voicemail", { playback: PhonePlayback, journeyId?: string }>
-  'Play Message': PhoneTreeActionBuilder<"Play Message", { playback: PhonePlayback, journeyId?: string }>
+  'Play Message': PhoneTreeActionBuilder<"Play Message", { playback: PhonePlayback, journeyId?: string, outcome?: string, cancelAppointment?: boolean, confirmAppointment?: boolean }>
   'Dial Users': PhoneTreeActionBuilder<"Dial Users", { userIds: string[], playback?: Partial<PhonePlayback>, duration?: number }>
   'Route Call': PhoneTreeActionBuilder<"Route Call", { 
     prePlayback?: Partial<PhonePlayback>,
@@ -4164,7 +4189,7 @@ export type PhoneTreeEnduserCondition = (
 )
 export interface PhoneTree_readonly extends ClientRecord {}
 export interface PhoneTree_required {
-  number: string,
+  number: string, // blank for outbound phone trees
   nodes: PhoneTreeNode[],
   isActive: boolean,
 }
@@ -4175,6 +4200,8 @@ export interface PhoneTree extends PhoneTree_readonly, PhoneTree_required, Phone
   bypassOOO?: boolean,
   defaultEntityType?: string,
   tags?: string[],
+  title?: string, // set for outbound phone trees
+  outboundNumber?: string, // set for outbound phone trees
 }
 
 export type TableViewColumn = {
@@ -4512,6 +4539,7 @@ export interface PortalBranding extends PortalBranding_readonly, PortalBranding_
   logoURL?: string,
   subdomain?: string,
   customPortalURL?: string,
+  portalSettings?: PortalSettings,
 }
 
 export interface WebhookLog_readonly extends ClientRecord { 
@@ -4614,7 +4642,29 @@ export interface Waitlist extends Waitlist_readonly, Waitlist_required, Waitlist
   tags?: string[],
 }
 
+export type AICOnversationMessageContent = {
+  type: 'text' | 'image' | 'file',
+  text?: string,
+}
+export type AIConversationMessage = {
+  role: 'user' | 'assistant',
+  text: string,
+  timestamp: Date,
+  tokens: number,
+  content?: AICOnversationMessageContent[],
+  userId?: string, // for user messages
+}
+export interface AIConversation_readonly extends ClientRecord {}
+export interface AIConversation_required {
+  type: string,
+  modelName: string,
+  messages: AIConversationMessage[],
+}
+export interface AIConversation_updatesDisabled {}
+export interface AIConversation extends AIConversation_readonly, AIConversation_required, AIConversation_updatesDisabled {}
+
 export type ModelForName_required = {
+  ai_conversations: AIConversation_required,
   waitlists: Waitlist_required,
   agent_records: AgentRecord_required,
   enduser_eligibility_results: EnduserEligibilityResult_required,
@@ -4705,6 +4755,7 @@ export type ModelForName_required = {
 export type ClientModel_required = ModelForName_required[keyof ModelForName_required]
 
 export interface ModelForName_readonly {
+  ai_conversations: AIConversation_readonly,
   waitlists: Waitlist_readonly,
   agent_records: AgentRecord_readonly,
   enduser_eligibility_results: EnduserEligibilityResult_readonly,
@@ -4795,6 +4846,7 @@ export interface ModelForName_readonly {
 export type ClientModel_readonly = ModelForName_readonly[keyof ModelForName_readonly]
 
 export interface ModelForName_updatesDisabled {
+  ai_conversations: AIConversation_updatesDisabled,
   waitlists: Waitlist_updatesDisabled,
   agent_records: AgentRecord_updatesDisabled,
   enduser_eligibility_results: EnduserEligibilityResult_updatesDisabled,
@@ -4885,6 +4937,7 @@ export interface ModelForName_updatesDisabled {
 export type ClientModel_updatesDisabled = ModelForName_updatesDisabled[keyof ModelForName_updatesDisabled]
 
 export interface ModelForName extends ModelForName_required, ModelForName_readonly { 
+  ai_conversations: AIConversation,
   waitlists: Waitlist,
   agent_records: AgentRecord,
   enduser_eligibility_results: EnduserEligibilityResult,
@@ -4985,6 +5038,7 @@ export interface UserActivityInfo {
 export type UserActivityStatus = 'Active' | 'Away' | 'Unavailable'
 
 export const modelNameChecker: { [K in ModelName] : true } = {
+  ai_conversations: true,
   waitlists: true,
   agent_records: true,
   enduser_eligibility_results: true,