@tellescope/types-models 1.225.0 → 1.227.0

package/src/index.ts

@@ -105,6 +105,7 @@ export type PortalSettings = {
     loginTitle?: string,
     loginDescription?: string,
     loginGraphic?: string,
+    loginBottomHTML?: string,
     registerTitle?: string,
     registerDescription?: string,
     registerGraphic?: string,
@@ -132,13 +133,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 }>,
@@ -403,6 +405,7 @@ export interface Organization extends Organization_readonly, Organization_requir
   hasConnectedSuperDial?: boolean,
   hasConnectedBeluga?: boolean,
   hasConnectedMetriport?: boolean,
+  hasConnectedPaubox?: boolean,
   hasConfiguredZoom?: boolean,
   hasTicketQueues?: boolean,
   vitalTeamId?: string,
@@ -467,6 +470,7 @@ export interface Organization extends Organization_readonly, Organization_requir
   hasIntegrations?: string[],
   outOfOfficeHours?: OutOfOfficeBlock[],
   // _AIEnabled?: boolean,
+  skipActivePatientBilling?: boolean,
 }
 export type OrganizationTheme = {
   name: string,
@@ -574,6 +578,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,
@@ -585,6 +595,7 @@ export type WeeklyAvailability = {
   locationIds?: string[],
   validTemplateIds?: string[],
   priority?: number,
+  monthlyRestriction?: MonthlyRestriction,
 }
 export type NotificationPreference = {
   email?: boolean 
@@ -606,6 +617,7 @@ export interface User_readonly extends ClientRecord {
   organization?: string 
   username?: string;
   orgEmail?: string;
+  pauboxEmail?: string;
   lastActive?: Date;
   lastLogout?: Date;
   isa?: boolean,
@@ -899,6 +911,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[],
@@ -1628,11 +1641,16 @@ export type FormFieldFeedback = {
   ifEquals: string,
   display: string,
 }
+export type FormFieldOptionDetails = {
+  option: string,
+  description?: string,
+}
 export interface CanvasConsentCategory extends CanvasCoding {}
 export type FormFieldOptions = FormFieldValidation & {
   default?: string,
-  tableChoices?: TableInputChoice[],  
+  tableChoices?: TableInputChoice[],
   choices?: string[];
+  optionDetails?: FormFieldOptionDetails[];
   canvasCodings?: CanvasCoding[],
   from?: number,
   to?: number,
@@ -1650,6 +1668,7 @@ export type FormFieldOptions = FormFieldValidation & {
   databaseId?: string,
   databaseLabel?: string,
   databaseLabels?: string[],
+  filterByEnduserState?: boolean,
   databaseFilter?: {
     fieldId?: string,
     databaseLabel?: string,
@@ -1682,6 +1701,7 @@ export type FormFieldOptions = FormFieldValidation & {
   groupPadding?: number,
   saveIntakeOnPartial?: boolean,
   stripeKey?: string, // publishable key of custom stripe API keys
+  stripeProductSelectionMode?: boolean, // enable product selection step for Stripe questions
   dataSource?: string, // e.g. Canvas for Allergies
   canvasDocumentCoding?: Pick<CanvasCoding, 'system' | 'code'> // for category
   canvasDocumentType?: CanvasCoding, // for type
@@ -1702,7 +1722,7 @@ export type FormFieldOptions = FormFieldValidation & {
   elationAppendToNote?: boolean,
   elationAppendToNotePrefix?: string,
 }
-export type MultipleChoiceOptions = Pick<FormFieldOptions, 'choices' | 'radio' | 'other'>
+export type MultipleChoiceOptions = Pick<FormFieldOptions, 'choices' | 'radio' | 'other' | 'optionDetails' | 'radioChoices'>
 
 export type FormFieldCalloutConditionComparison = 'Equals'
 export type FormFieldCalloutCondition = {
@@ -1985,6 +2005,7 @@ export interface Database_updatesDisabled {}
 export interface Database extends Database_readonly, Database_required, Database_updatesDisabled {
   // organizationRead?: boolean,
   visibleForRoles?: string[],
+  isReferralDatabase?: boolean,
 }
 
 export interface DatabaseRecord_readonly extends ClientRecord {}
@@ -2212,6 +2233,7 @@ export interface FormResponse_required {
   publicSubmit?: boolean,
   submittedBy?: string,
   submittedByIsPlaceholder?: boolean,
+  markedAsSubmitted?: boolean,
   submittedAt?: Date,
   accessCode?: string,
   userEmail?: string,
@@ -2428,6 +2450,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[],
@@ -2457,6 +2480,7 @@ export interface CalendarEvent extends CalendarEvent_readonly, CalendarEvent_req
   preventRescheduleMinutesInAdvance?: number,
   preventCancelMinutesInAdvance?: number,
   sendIcsEmail?: boolean,
+  healthieInsuranceBillingEnabled?: boolean,
   // isAllDay?: boolean,
 }
 
@@ -2589,6 +2613,7 @@ export interface CalendarEventTemplate extends CalendarEventTemplate_readonly, C
   generateAthenaTelehealthLink?: boolean,
   athenaTypeId?: string, // for searching slots (default booking type)
   athenaBookingTypeId?: string, // for booking a different type than the slot
+  healthieInsuranceBillingEnabled?: boolean,
 }
 
 export interface AppointmentLocation_readonly extends ClientRecord {}
@@ -2817,6 +2842,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> 
@@ -3322,6 +3352,7 @@ export type PortalBlockForType = {
     title: string,
     roles?: string[],
     showAll?: boolean,
+    hideContactButton?: boolean,
     // members: CareTeamMemberPortalCustomizationInfo[],
   }>,
   carePlan: BuildPortalBlockInfo<'carePlan', {}>,
@@ -3549,6 +3580,7 @@ export type UserUIRestrictions = {
   hideMergeEndusers?: boolean,
   hideQueuedTicketsViewer?: boolean,
   hideIncomingFaxesIcon?: boolean,
+  hideNotificationsIcon?: boolean,
   hideBulkEnduserActions?: boolean,
   visibleIntegrations?: string[],
 }
@@ -3647,6 +3679,8 @@ export type AnalyticsQueryInfoForType = {
   },
   "Journey Logs": { Total:  AnalyticsQueryInfoBuilder<'Total', undefined> },
   "Orders": { Total:  AnalyticsQueryInfoBuilder<'Total', undefined> },
+  "Chat Rooms": { Total:  AnalyticsQueryInfoBuilder<'Total', undefined> },
+  "Chats": { Total:  AnalyticsQueryInfoBuilder<'Total', undefined> },
 }
 export type AnalyticsQueryInfoType = keyof AnalyticsQueryInfoForType
 export type AnalyticsQueryInfo = AnalyticsQueryInfoForType[AnalyticsQueryInfoType]
@@ -3718,10 +3752,12 @@ export type AnalyticsQueryFilterForType = {
   Files: { 
     names?: string[],
   },
-  "Journey Logs": { 
+  "Journey Logs": {
     automationStepIds?: string[],
   },
   Orders: { },
+  "Chat Rooms": { },
+  "Chats": { },
 }
 
 export type EnduserGrouping = {
@@ -3739,6 +3775,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 },
@@ -3768,8 +3805,10 @@ export type AnalyticsQueryGroupingForType = {
   "Medications": {} & EnduserGrouping & { Enduser: string },
   "Files": {} & EnduserGrouping & { Enduser: string },
   "Journey Logs": {} & EnduserGrouping & { Enduser: string },
-  "Meetings": { Host?: boolean },  
+  "Meetings": { Host?: boolean },
   "Orders": {} & EnduserGrouping & { Enduser: string },
+  "Chat Rooms": {} & EnduserGrouping & { Enduser: string },
+  "Chats": {} & EnduserGrouping & { Enduser: string },
 }
 
 type DefaultRangeKey = 'Created At' | 'Updated At'
@@ -3788,6 +3827,8 @@ export type AnalyticsQueryRangeKeyForType = {
   "Meetings": DefaultRangeKey,
   "Journey Logs": DefaultRangeKey,
   "Orders": DefaultRangeKey,
+  "Chat Rooms": DefaultRangeKey,
+  "Chats": DefaultRangeKey,
 }
 export type RangeKey = DefaultRangeKey | 'Submitted At' | "Closed At"
 
@@ -3897,12 +3938,26 @@ export type AnalyticsQueryForType = {
     AnalyticsQueryRangeKeyForType['Journey Logs']
   >,
   "Orders": AnalyticsQueryBuilder<
-    "Orders", 
+    "Orders",
     AnalyticsQueryInfoForType['Orders'][keyof AnalyticsQueryInfoForType['Orders']],
     AnalyticsQueryFilterForType['Orders'],
     AnalyticsQueryGroupingForType['Orders'],
     AnalyticsQueryRangeKeyForType['Orders']
   >,
+  "Chat Rooms": AnalyticsQueryBuilder<
+    "Chat Rooms",
+    AnalyticsQueryInfoForType['Chat Rooms'][keyof AnalyticsQueryInfoForType['Chat Rooms']],
+    AnalyticsQueryFilterForType['Chat Rooms'],
+    AnalyticsQueryGroupingForType['Chat Rooms'],
+    AnalyticsQueryRangeKeyForType['Chat Rooms']
+  >,
+  "Chats": AnalyticsQueryBuilder<
+    "Chats",
+    AnalyticsQueryInfoForType['Chats'][keyof AnalyticsQueryInfoForType['Chats']],
+    AnalyticsQueryFilterForType['Chats'],
+    AnalyticsQueryGroupingForType['Chats'],
+    AnalyticsQueryRangeKeyForType['Chats']
+  >,
 }
 export type AnalyticsQueryType = keyof AnalyticsQueryForType
 export type AnalyticsQuery = AnalyticsQueryForType[AnalyticsQueryType]
@@ -3922,6 +3977,8 @@ export const resource_to_modelName: { [K in AnalyticsQueryType] : ModelName } =
   Meetings: "meetings",
   "Journey Logs": "automated_actions",
   Orders: "enduser_orders",
+  "Chat Rooms": "chat_rooms",
+  "Chats": "chats",
 }
 
 export type AnalyticsQueryOptions = {
@@ -3950,8 +4007,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,
@@ -3965,6 +4022,7 @@ export interface AnalyticsFrame extends
   visibleForRoles?: string[],
   visibleForUserIds?: string[],
   index?: number,
+  tags?: string[],
 }
 
 
@@ -4117,7 +4175,7 @@ export type AutomationTriggerEvents = {
     hasExpiredEvent?: boolean,
   }, {}>,
   'Form Unsubmitted': AutomationTriggerEventBuilder<"Form Unsubmitted", { formId: string, intervalInMS: number }, {}>,
-  'Purchase Made': AutomationTriggerEventBuilder<"Purchase Made", { titles?: string[], productIds?: string[] }, {}>,
+  'Purchase Made': AutomationTriggerEventBuilder<"Purchase Made", { titles?: string[], productIds?: string[], titlePartialMatches?: string[] }, {}>,
   'Refund Issued': AutomationTriggerEventBuilder<"Refund Issued", { }, {}>,
   'Subscription Ended': AutomationTriggerEventBuilder<"Subscription Ended", { productIds?: string[] }, {}>,
   'Subscription Payment Failed': AutomationTriggerEventBuilder<"Subscription Payment Failed", { }, {}>,
@@ -4135,7 +4193,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,