@tellescope/types-models 1.223.0 → 1.225.0

package/src/index.ts

@@ -308,6 +308,11 @@ export type StripeKeyDetail = {
   title: string,
 }
 
+export type MetriportIntegrationDetail = {
+  title: string,
+  environment?: string,
+}
+
 // for setting holiday/out of office hours with custom reply
 export type OutOfOfficeBlock = {
   from: Date,
@@ -375,6 +380,7 @@ export interface Organization extends Organization_readonly, Organization_requir
   externalCalendarEventPlaceholderDescription?: string,
   customZoomEmailTemplate?: string,
   customZoomEmailSubject?: string,
+  customZoomSMSTemplate?: string,
   customVoicemailText?: string,
   hasConnectedOpenAI?: boolean,
   hasConnectedHealthie?: boolean,
@@ -443,6 +449,7 @@ export interface Organization extends Organization_readonly, Organization_requir
   }[],
   stripePublicKeys?: string[],
   stripeKeyDetails?: StripeKeyDetail[],
+  metriportIntegrationDetails?: MetriportIntegrationDetail[],
   additionalIterableKeys?: string[],
   defaultDoseSpotPharmacies?: { id: string, name: string }[]
   groups?: string[],
@@ -1636,6 +1643,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,
@@ -1798,6 +1806,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,
@@ -2661,6 +2670,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
 }
 
@@ -2698,7 +2709,7 @@ export interface WebhookCall {
   description?: string,
 }
 
-export type AutomationEventType = 
+export type AutomationEventType =
     'onJourneyStart'
   | 'afterAction'
   | "formResponse"
@@ -2709,6 +2720,7 @@ export type AutomationEventType =
   | 'waitForTrigger'
   | "onCallOutcome"
   | "onAIDecision"
+  | "onError"
 
 interface AutomationEventBuilder <T extends AutomationEventType, V extends object> {
   type: T,
@@ -2813,11 +2825,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
@@ -2826,6 +2843,7 @@ export type AutomationEventForType = {
   'waitForTrigger': WaitForTriggerAutomationEvent
   'onCallOutcome': OnCallOutcomeAutomationEvent,
   'onAIDecision': OnAIDecisionAutomationEvent
+  'onError': OnErrorAutomationEvent
 }
 export type AutomationEvent = AutomationEventForType[keyof AutomationEventForType]
 
@@ -2941,7 +2959,7 @@ export type CreateCarePlanAutomationAction = AutomationActionBuilder<'createCare
 export type CompleteCarePlanAutomationAction = AutomationActionBuilder<'completeCarePlan', {}>
 export type ZusSyncAutomationAction = AutomationActionBuilder<'zusSync', {}>
 export type ZusPullAutomationAction = AutomationActionBuilder<'zusPull', {}>
-export type MetriportSyncAutomationAction = AutomationActionBuilder<'metriportSync', { facilityId: string }>
+export type MetriportSyncAutomationAction = AutomationActionBuilder<'metriportSync', { facilityId: string, integrationTitle?: string }>
 export type ZusSubscribeAutomationAction = AutomationActionBuilder<'zusSubscribe', { practitionerId: string, packageIds: string[] }>
 export type PagerDutyCreateIncidentAutomationAction = AutomationActionBuilder<'pagerDutyCreateIncident', { type: string, title: string, serviceId: string }>
 export type SmartMeterOrderLineItem = { quantity: number, sku: string }
@@ -3040,6 +3058,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
 }>
 
@@ -3194,15 +3213,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,
@@ -3287,7 +3318,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,
@@ -3301,6 +3332,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]
@@ -3549,7 +3584,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 | '',
@@ -4052,6 +4088,20 @@ export type AutomationTriggerActions = {
   "Reply to Chat": AutomationTriggerActionBuilder<'Reply to Chat', { 
     message: string,
   }>,
+  "Create User Notifications": AutomationTriggerActionBuilder<'Create User Notifications', {
+    message: string,
+    notificationType: string,
+    careTeamOnly?: boolean,
+    tags?: ListOfStringsWithQualifier,
+    maxUsers?: number,
+  }>,
+  "Assign to Incoming Message": AutomationTriggerActionBuilder<'Assign to Incoming Message', {
+    careTeamOnly?: boolean,
+    tags?: ListOfStringsWithQualifier,
+    maxUsers?: number,
+  }>,
+  "Zendesk: Update Ticket Assignee": AutomationTriggerActionBuilder<'Zendesk: Update Ticket Assignee', {
+  }>,
 }
 export type AutomationTriggerActionType = keyof AutomationTriggerActions
 export type AutomationTriggerAction = AutomationTriggerActions[AutomationTriggerActionType]
@@ -5302,6 +5352,8 @@ export type JourneyContext = {
   fileId?: string,
   chatRoomId?: string,
   twilioNumber?: string,
+  ticketThreadId?: string,
+  ticketThreadCommentId?: string,
 }
 
 // https://gist.github.com/aviflax/a4093965be1cd008f172/