@tellescope/types-models 1.224.0 → 1.226.0

package/src/index.ts

@@ -132,13 +132,14 @@ export type PortalSettings = {
 
 export type WithLinkOpenTrackingIds = { linkOpenTrackingIds: string[] }
 
-type BuildCustomEnduserField <T, I> = { 
+type BuildCustomEnduserField <T, I> = {
   type: T,
   info: I,
   field: string,
   required?: boolean,
   hiddenFromProfile?: boolean,
   requireConfirmation?: boolean,
+  tags?: string[],
 }
 export type CustomEnduserFields = {
   "Select": BuildCustomEnduserField<'Select', { options: string[], other?: boolean }>,
@@ -380,6 +381,7 @@ export interface Organization extends Organization_readonly, Organization_requir
   externalCalendarEventPlaceholderDescription?: string,
   customZoomEmailTemplate?: string,
   customZoomEmailSubject?: string,
+  customZoomSMSTemplate?: string,
   customVoicemailText?: string,
   hasConnectedOpenAI?: boolean,
   hasConnectedHealthie?: boolean,
@@ -573,6 +575,12 @@ export type StateCredentialInfo = {
   expiresAt?: Date,
 }
 
+export type MonthlyRestriction = {
+  // Which occurrences of this day within the month (1st, 2nd, 3rd, 4th, 5th)
+  // For example: [1, 3] means "only on the 1st and 3rd occurrence of this day in the month"
+  occurrences: (1 | 2 | 3 | 4 | 5)[]
+}
+
 export type WeeklyAvailability = {
   dayOfWeekStartingSundayIndexedByZero: number,
   startTimeInMinutes: number,
@@ -584,6 +592,7 @@ export type WeeklyAvailability = {
   locationIds?: string[],
   validTemplateIds?: string[],
   priority?: number,
+  monthlyRestriction?: MonthlyRestriction,
 }
 export type NotificationPreference = {
   email?: boolean 
@@ -898,6 +907,7 @@ export interface Enduser extends Enduser_readonly, Enduser_required, Enduser_upd
   markedReadAt?: Date | '',
   markedUnreadAt?: Date | '',
   note?: string,
+  noteIsFlagged?: boolean,
   mfa?: MFASettings,
   lastZendeskSyncAt?: Date,
   accessTags?: string[],
@@ -1642,6 +1652,7 @@ export type FormFieldOptions = FormFieldValidation & {
   subFields?: FormSubField[],
   validFileTypes?: string[], // should be human readable files where the lower-case version is included in a filetype, e.g. Image, Video, PDF
   maxFileSize?: number, // in bytes
+  hideFromPortal?: boolean, // hide uploaded files from patient portal
   signatureUrl?: string,
   productIds?: string[],
   chargeImmediately?: boolean,
@@ -1804,6 +1815,7 @@ export interface Form extends Form_readonly, Form_required, Form_updatesDisabled
   htmlThanksMessage?: string,
   type?: FormType,
   scoring?: FormScoring[]
+  realTimeScoring?: boolean,
   externalId?: string,
   ga4measurementId?: string,
   backgroundColor?: string,
@@ -2425,6 +2437,7 @@ export interface CalendarEvent extends CalendarEvent_readonly, CalendarEvent_req
   canvasReasonCoding?: CanvasCoding,
   canvasLocationId?: string,
   completedAt?: Date | '',
+  completedBy?: string, // user ID when manually completed, or integration title when completed via integration
   holdUntil?: Date,
   holdFormResponseId?: string,
   tags?: string[],
@@ -2667,6 +2680,8 @@ export interface AppointmentBookingPage extends AppointmentBookingPage_readonly,
   archivedAt?: Date | '',
   gtmTag?: string,
   dontRestrictRescheduleToOriginalHost?: boolean,
+  calendarTitleText?: string, // Custom text for "Pick a date and time for your visit" - can be empty to hide
+  emailFieldBehavior?: "required" | "optional" | "hidden",
   // productIds?: string[], // defer to specific template
 }
 
@@ -2704,7 +2719,7 @@ export interface WebhookCall {
   description?: string,
 }
 
-export type AutomationEventType = 
+export type AutomationEventType =
     'onJourneyStart'
   | 'afterAction'
   | "formResponse"
@@ -2715,6 +2730,7 @@ export type AutomationEventType =
   | 'waitForTrigger'
   | "onCallOutcome"
   | "onAIDecision"
+  | "onError"
 
 interface AutomationEventBuilder <T extends AutomationEventType, V extends object> {
   type: T,
@@ -2811,6 +2827,11 @@ export type AfterActionAutomationEvent = AutomationEventBuilder<'afterAction', A
   eventCondition?: {
     before?: boolean,
   },
+  dayOfMonthCondition?: {
+    dayOfMonth: number, // 1-31
+    hour?: number, // 0-23, defaults to 9 AM
+    minute?: number, // 0-59, defaults to 0
+  },
   skipIfDelayPassed?: boolean,
 }> 
 export type FormUnsubmittedEvent = AutomationEventBuilder<'formUnsubmitted', FormUnsubmittedEventInfo> 
@@ -2819,11 +2840,16 @@ export type OnJourneyStartAutomationEvent = AutomationEventBuilder<'onJourneySta
 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 OnAIDecisionAutomationEvent = AutomationEventBuilder<'onAIDecision', { automationStepId: string, outcomes: string[] }> 
+export type OnAIDecisionAutomationEvent = AutomationEventBuilder<'onAIDecision', { automationStepId: string, outcomes: string[] }>
+
+export type OnErrorEventInfo = {
+  automationStepId: string,
+}
+export type OnErrorAutomationEvent = AutomationEventBuilder<'onError', OnErrorEventInfo>
 
 export type AutomationEventForType = {
   'onJourneyStart': OnJourneyStartAutomationEvent
-  'afterAction': AfterActionAutomationEvent 
+  'afterAction': AfterActionAutomationEvent
   "formResponse":  FormResponseAutomationEvent
   "formResponses": FormResponsesAutomationEvent
   'formUnsubmitted': FormUnsubmittedEvent
@@ -2832,6 +2858,7 @@ export type AutomationEventForType = {
   'waitForTrigger': WaitForTriggerAutomationEvent
   'onCallOutcome': OnCallOutcomeAutomationEvent,
   'onAIDecision': OnAIDecisionAutomationEvent
+  'onError': OnErrorAutomationEvent
 }
 export type AutomationEvent = AutomationEventForType[keyof AutomationEventForType]
 
@@ -3046,6 +3073,7 @@ export type CallUserAutomationAction = AutomationActionBuilder<
 export type StripeChargeCardOnFileAutomationAction = AutomationActionBuilder<'stripeChargeCardOnFile', {
   stripeKey?: string, // indicating custom vs. stripe connect
   priceIds: string[], // Stripe price ids to charge
+  productIds?: string[], // Tellescope product IDs to extract price IDs from
   subscriptionPriceId?: string
 }>
 
@@ -3200,15 +3228,27 @@ export interface EnduserObservation extends EnduserObservation_readonly, Enduser
 }
 
 export type BlockType = 'h1' | 'h2' | 'html' | 'image' | 'youtube' | 'pdf' | 'iframe' | 'content-link'
+
+export type BlockStyle = {
+  width?: number,
+  height?: number,
+  backgroundColor?: string,
+  borderColor?: string,
+  borderWidth?: number,
+  textColor?: string,
+}
+
 export type ContentBlockBuilder <BLOCK extends BlockType, INFO extends object> = {
   type: BLOCK,
   info: INFO,
+  style?: BlockStyle,
 }
 
 export type BlockContentText = { text: string }
 export type BlockContentMedia = {
   link: string,
   name?: string,
+  alt?: string,
   height?: number,
   maxHeight?: number,
   width?: number,
@@ -3293,7 +3333,7 @@ export type CareTeamMemberPortalCustomizationInfo = {
   role?: string, // for matching to care team role for a specific team member
 }
 export type PortalBlockForType = {
-  careTeam: BuildPortalBlockInfo<'careTeam', { 
+  careTeam: BuildPortalBlockInfo<'careTeam', {
     title: string,
     roles?: string[],
     showAll?: boolean,
@@ -3307,6 +3347,10 @@ export type PortalBlockForType = {
   "Orders": BuildPortalBlockInfo<'Orders', { }>
   "Manage Subscription Button": BuildPortalBlockInfo<'Manage Subscription Button', { }>
   HTML: BuildPortalBlockInfo<'HTML', { html: string }>
+  pinnedForms: BuildPortalBlockInfo<'pinnedForms', {
+    title?: string,
+    formIds?: string[],
+  }>
 }
 export type PortalBlockType = keyof PortalBlockForType
 export type PortalBlock = PortalBlockForType[PortalBlockType]
@@ -3555,7 +3599,8 @@ export interface PhoneCall extends PhoneCall_readonly, PhoneCall_required, Phone
   externalConferenceId?: string,
   conferenceAttendees?: (string[]) | (string[][]), // old code caused multiple lists to be pushed by mistake
   unread?: boolean,
-  transcription?: string,
+  transcription?: string, // Twilio voicemail transcription
+  recordingTranscriptionData?: string, // Full AWS Transcribe JSON response (stringified) with metadata
   note?: string,
   userId?: string,
   pinnedAt?: Date | '',
@@ -3709,6 +3754,7 @@ export type AnalyticsQueryGroupingForType = {
   "Calendar Events": {
     Type: boolean,
     "Scheduled By"?: boolean,
+    "Completed By"?: boolean,
     alsoGroupByHost?: boolean, // for further breaking down a grouping by host
     "Cancel Reason"?: boolean,
   } & EnduserGrouping & { Enduser: string },
@@ -3920,8 +3966,8 @@ export interface AnalyticsFrame_required {
   groupByCareTeam?: boolean, // supports multi-grouping for both care team and a normal field
 }
 export interface AnalyticsFrame_updatesDisabled {}
-export interface AnalyticsFrame extends 
-  AnalyticsFrame_readonly, AnalyticsFrame_required, AnalyticsFrame_updatesDisabled, AnalyticsQueryOptions 
+export interface AnalyticsFrame extends
+  AnalyticsFrame_readonly, AnalyticsFrame_required, AnalyticsFrame_updatesDisabled, AnalyticsQueryOptions
 {
   parentFrame?: string,
   type?: AnalyticsFrameType,
@@ -3935,6 +3981,7 @@ export interface AnalyticsFrame extends
   visibleForRoles?: string[],
   visibleForUserIds?: string[],
   index?: number,
+  tags?: string[],
 }
 
 
@@ -4070,6 +4117,8 @@ export type AutomationTriggerActions = {
     tags?: ListOfStringsWithQualifier,
     maxUsers?: number,
   }>,
+  "Zendesk: Update Ticket Assignee": AutomationTriggerActionBuilder<'Zendesk: Update Ticket Assignee', {
+  }>,
 }
 export type AutomationTriggerActionType = keyof AutomationTriggerActions
 export type AutomationTriggerAction = AutomationTriggerActions[AutomationTriggerActionType]
@@ -4103,7 +4152,7 @@ export type AutomationTriggerEvents = {
     excludeCancelUpcomingEventsJourney?: boolean, // if true, will not trigger from cancelUpcomingEvents Journey action
     by?: '' | 'enduser' | 'user', // only implemented for enduser for now
   }, {}>,
-  'Appointment Rescheduled': AutomationTriggerEventBuilder<"Appointment Rescheduled", { titles?: string[] }, {}>,
+  'Appointment Rescheduled': AutomationTriggerEventBuilder<"Appointment Rescheduled", { titles?: string[], detectManualReschedules?: boolean }, {}>,
   'Medication Added': AutomationTriggerEventBuilder<"Medication Added", { titles: string[] }, {}>,
   'No Recent Appointment': AutomationTriggerEventBuilder<"No Recent Appointment", { 
     intervalInMS: number, 
@@ -5320,6 +5369,8 @@ export type JourneyContext = {
   fileId?: string,
   chatRoomId?: string,
   twilioNumber?: string,
+  ticketThreadId?: string,
+  ticketThreadCommentId?: string,
 }
 
 // https://gist.github.com/aviflax/a4093965be1cd008f172/