@tellescope/types-models 1.188.0 → 1.190.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/cjs/index.d.ts +42 -1
- package/lib/cjs/index.d.ts.map +1 -1
- package/lib/cjs/index.js.map +1 -1
- package/lib/esm/index.d.ts +42 -1
- package/lib/esm/index.d.ts.map +1 -1
- package/lib/esm/index.js.map +1 -1
- package/lib/tsconfig.tsbuildinfo +1 -1
- package/package.json +3 -3
- package/src/index.ts +38 -2
package/src/index.ts
CHANGED
|
@@ -147,6 +147,7 @@ export type CustomEnduserFields = {
|
|
|
147
147
|
"File": BuildCustomEnduserField<'File', { }>,
|
|
148
148
|
'Auto Detect': BuildCustomEnduserField<'Auto Detect', { }>,
|
|
149
149
|
"Table": BuildCustomEnduserField<"Table", { columns: TableInputChoice[] }>
|
|
150
|
+
'Checkbox': BuildCustomEnduserField<'Checkbox', { }>,
|
|
150
151
|
}
|
|
151
152
|
export type CustomEnduserFieldType = keyof CustomEnduserFields
|
|
152
153
|
export type CustomEnduserField = CustomEnduserFields[CustomEnduserFieldType]
|
|
@@ -178,6 +179,7 @@ export type OrganizationSettings = {
|
|
|
178
179
|
disableAutoreplyForCustomEntities?: boolean,
|
|
179
180
|
tags?: string[],
|
|
180
181
|
showFreeNote?: boolean,
|
|
182
|
+
autoSaveFreeNote?: boolean,
|
|
181
183
|
canDeleteFreeNote?: boolean,
|
|
182
184
|
recordCalls?: boolean,
|
|
183
185
|
recordCallAudioPlayback?: string,
|
|
@@ -199,6 +201,7 @@ export type OrganizationSettings = {
|
|
|
199
201
|
alwaysShowInsurance?: boolean,
|
|
200
202
|
defaultToOutboundConferenceCall?: boolean,
|
|
201
203
|
sharedInboxReadStatus?: boolean,
|
|
204
|
+
dontMarkReadForAssigned?: boolean,
|
|
202
205
|
matchEmailAndNames?: boolean,
|
|
203
206
|
hideNotesFromComposeForm?: boolean,
|
|
204
207
|
showSalesforceId?: boolean,
|
|
@@ -392,6 +395,7 @@ export interface Organization extends Organization_readonly, Organization_requir
|
|
|
392
395
|
questionId: string,
|
|
393
396
|
},
|
|
394
397
|
canvasSyncEmailConsent?: boolean,
|
|
398
|
+
canvasSyncPhoneConsent?: boolean,
|
|
395
399
|
dosespotClinics?: { id: string, name: string }[],
|
|
396
400
|
answersSyncToPortal?: { id: string, questions: string[] }[]
|
|
397
401
|
externalFormIdsToSync?: string[],
|
|
@@ -515,6 +519,7 @@ export type WeeklyAvailability = {
|
|
|
515
519
|
startTimeInMinutes: number,
|
|
516
520
|
endTimeInMinutes: number,
|
|
517
521
|
intervalInMinutes?: number,
|
|
522
|
+
bufferStartMinutes?: number,
|
|
518
523
|
active?: DateRange,
|
|
519
524
|
locationId?: string, // deprecated
|
|
520
525
|
locationIds?: string[],
|
|
@@ -1122,6 +1127,7 @@ export interface Email extends Email_required, Email_readonly, Email_updatesDisa
|
|
|
1122
1127
|
discussionRoomId?: string,
|
|
1123
1128
|
markedUnreadForAll?: boolean,
|
|
1124
1129
|
inboxStatus?: string,
|
|
1130
|
+
relatedContactId?: string,
|
|
1125
1131
|
// sentAt: string, // only outgoing
|
|
1126
1132
|
}
|
|
1127
1133
|
|
|
@@ -1175,6 +1181,7 @@ export interface SMSMessage extends SMSMessage_readonly, SMSMessage_required, SM
|
|
|
1175
1181
|
mediaURLs?: string[],
|
|
1176
1182
|
markedUnreadForAll?: boolean,
|
|
1177
1183
|
inboxStatus?: string,
|
|
1184
|
+
relatedContactId?: string,
|
|
1178
1185
|
// usingPublicNumber?: boolean, // flagged on outgoing messages from public number
|
|
1179
1186
|
// sentAt: string, // only outgoing
|
|
1180
1187
|
}
|
|
@@ -1309,7 +1316,6 @@ export interface File_readonly extends ClientRecord {
|
|
|
1309
1316
|
recentlyViewedAt: Date,
|
|
1310
1317
|
type: 'user' | 'enduser'
|
|
1311
1318
|
}>,
|
|
1312
|
-
source?: string
|
|
1313
1319
|
externalId?: string,
|
|
1314
1320
|
timestamp?: Date,
|
|
1315
1321
|
confirmedAt?: Date,
|
|
@@ -1373,6 +1379,7 @@ export interface Ticket_required {
|
|
|
1373
1379
|
}
|
|
1374
1380
|
export interface Ticket_updatesDisabled {}
|
|
1375
1381
|
export interface Ticket extends Ticket_readonly, Ticket_required, Ticket_updatesDisabled {
|
|
1382
|
+
disableEditTitle?: boolean,
|
|
1376
1383
|
queueId?: string,
|
|
1377
1384
|
dequeuedAt?: Date | '',
|
|
1378
1385
|
dequeuedFrom?: string, // for reporting later without affecting access permissions
|
|
@@ -1416,6 +1423,8 @@ export interface Ticket extends Ticket_readonly, Ticket_required, Ticket_updates
|
|
|
1416
1423
|
smsId?: string,
|
|
1417
1424
|
emailId?: string,
|
|
1418
1425
|
calendarEventId?: string,
|
|
1426
|
+
calendarEventTitle?: string,
|
|
1427
|
+
calendarEventStartTimeInMS?: number,
|
|
1419
1428
|
observationId?: string,
|
|
1420
1429
|
tags?: string[],
|
|
1421
1430
|
restrictByState?: string,
|
|
@@ -1423,6 +1432,7 @@ export interface Ticket extends Ticket_readonly, Ticket_required, Ticket_updates
|
|
|
1423
1432
|
restrictByTagsQualifier?: ListQueryQualifier,
|
|
1424
1433
|
archiveReason?: string,
|
|
1425
1434
|
contextFormIds?: string[],
|
|
1435
|
+
contextContentIds?: string[],
|
|
1426
1436
|
triggerFileId?: string,
|
|
1427
1437
|
orderId?: string,
|
|
1428
1438
|
contextEnduserFields?: string[],
|
|
@@ -1729,6 +1739,7 @@ export interface Form extends Form_readonly, Form_required, Form_updatesDisabled
|
|
|
1729
1739
|
canvasNoteCoding?: Partial<CanvasCoding>,
|
|
1730
1740
|
syncToCanvasAsDataImport?: boolean,
|
|
1731
1741
|
matchCareTeamTagsForCanvasPractitionerResolution?: ListOfStringsWithQualifier,
|
|
1742
|
+
dontSyncToCanvasOnSubmission?: boolean,
|
|
1732
1743
|
}
|
|
1733
1744
|
|
|
1734
1745
|
export interface FormGroup_readonly extends ClientRecord {}
|
|
@@ -2305,6 +2316,9 @@ export interface CalendarEvent extends CalendarEvent_readonly, CalendarEvent_req
|
|
|
2305
2316
|
canvasEncounterId?: string,
|
|
2306
2317
|
allowGroupReschedule?: boolean, // allows a patient to reschedule even if there are multiple attendees (e.g. 1 + care giver)
|
|
2307
2318
|
joinedVideoCall?: { id: string, at: Date }[],
|
|
2319
|
+
confirmedAt?: Date | '',
|
|
2320
|
+
preventRescheduleMinutesInAdvance?: number,
|
|
2321
|
+
preventCancelMinutesInAdvance?: number,
|
|
2308
2322
|
// isAllDay?: boolean,
|
|
2309
2323
|
}
|
|
2310
2324
|
|
|
@@ -2426,6 +2440,8 @@ export interface CalendarEventTemplate extends CalendarEventTemplate_readonly, C
|
|
|
2426
2440
|
requiresEnduser?: boolean,
|
|
2427
2441
|
requirePortalCancelReason?: boolean,
|
|
2428
2442
|
allowGroupReschedule?: boolean, // allows a patient to reschedule even if there are multiple attendees (e.g. 1 + care giver)
|
|
2443
|
+
preventRescheduleMinutesInAdvance?: number,
|
|
2444
|
+
preventCancelMinutesInAdvance?: number,
|
|
2429
2445
|
}
|
|
2430
2446
|
|
|
2431
2447
|
export interface AppointmentLocation_readonly extends ClientRecord {}
|
|
@@ -2620,6 +2636,7 @@ export type AfterActionEventInfo = {
|
|
|
2620
2636
|
delay: number, // for displaying in editor
|
|
2621
2637
|
unit: UnitOfTime, // for displaying in editor
|
|
2622
2638
|
officeHoursOnly?: boolean,
|
|
2639
|
+
useEnduserTimezone?: boolean,
|
|
2623
2640
|
cancelConditions?: CancelCondition[]
|
|
2624
2641
|
abTestCondition?: string,
|
|
2625
2642
|
}
|
|
@@ -2741,6 +2758,8 @@ export type CreateTicketActionInfo = {
|
|
|
2741
2758
|
tags?: string[],
|
|
2742
2759
|
contextFormIds?: string[],
|
|
2743
2760
|
contextEnduserFields?: string[],
|
|
2761
|
+
contextContentIds?: string[],
|
|
2762
|
+
disableEditTitle?: boolean,
|
|
2744
2763
|
}
|
|
2745
2764
|
|
|
2746
2765
|
export type SendEmailAutomationAction = AutomationActionBuilder<'sendEmail', AutomationForMessage & { fromEmailOverride?: string }>
|
|
@@ -2801,6 +2820,11 @@ export type ActiveCampaignAddToListsAutomationAction = AutomationActionBuilder<'
|
|
|
2801
2820
|
export type SwitchToRelatedContactAutomationAction = AutomationActionBuilder<'switchToRelatedContact', { type: string, otherTypes?: string[] }>
|
|
2802
2821
|
export type ElationSyncAutomationAction = AutomationActionBuilder<'elationSync', { }>
|
|
2803
2822
|
export type CanvasSyncAutomationAction = AutomationActionBuilder<'canvasSync', {}>
|
|
2823
|
+
export type CanvasCreateNoteAutomationAction = AutomationActionBuilder<'canvasCreateNote', {
|
|
2824
|
+
formIds: string[],
|
|
2825
|
+
matchCareTeamTagsForCanvasPractitionerResolution: ListOfStringsWithQualifier,
|
|
2826
|
+
noteCoding: CanvasCoding,
|
|
2827
|
+
}>
|
|
2804
2828
|
export type CancelFutureAppointmentsAutomationAction = AutomationActionBuilder<'cancelFutureAppointments', {}>
|
|
2805
2829
|
export type DevelopHealthMedicationEligibilityAutomationAction = AutomationActionBuilder<'developHealthMedEligibility', {
|
|
2806
2830
|
drugs: DevelopHealthDrug[],
|
|
@@ -2820,6 +2844,8 @@ export type IterableCustomEventAutomationAction = AutomationActionBuilder<'itera
|
|
|
2820
2844
|
environment?: string, // for additional API keys
|
|
2821
2845
|
customEmailField?: string, // for using custom field as built-in iterable email field
|
|
2822
2846
|
}>
|
|
2847
|
+
export type AddAccessTagsAutomationAction = AutomationActionBuilder<'addAccessTags', { tags: string[], replaceExisting?: boolean }>
|
|
2848
|
+
export type RemoveAccessTagsAutomationAction = AutomationActionBuilder<'removeAccessTags', { tags: string[] }>
|
|
2823
2849
|
|
|
2824
2850
|
export type EnduserFieldSetterType = 'Custom Value' | 'Current Timestamp' | 'Current Date' | "Increment Number"
|
|
2825
2851
|
export type EnduserFieldSetter = {
|
|
@@ -2836,6 +2862,8 @@ export type CustomerIOTrackAction = AutomationActionBuilder<'customerIOTrack', {
|
|
|
2836
2862
|
event: string,
|
|
2837
2863
|
trackProperties?: string[]
|
|
2838
2864
|
}>
|
|
2865
|
+
export type CancelCurrentEventAction = AutomationActionBuilder<'cancelCurrentEvent', {}>
|
|
2866
|
+
export type ConfirmCurrentEventAction = AutomationActionBuilder<'confirmCurrentEvent', {}>
|
|
2839
2867
|
|
|
2840
2868
|
export type AutomationConditionType = 'atJourneyState' // deprecated
|
|
2841
2869
|
export type AutomationConditionBuilder <T extends AutomationConditionType, V extends object> = {
|
|
@@ -2858,6 +2886,8 @@ export type AutomationActionForType = {
|
|
|
2858
2886
|
'notifyTeam': NotifyTeamAutomationAction,
|
|
2859
2887
|
'addEnduserTags': AddEnduserTagsAutomationAction,
|
|
2860
2888
|
'removeEnduserTags': RemoveEnduserTagsAutomationAction,
|
|
2889
|
+
'addAccessTags': AddAccessTagsAutomationAction,
|
|
2890
|
+
'removeAccessTags': RemoveAccessTagsAutomationAction,
|
|
2861
2891
|
'addToJourney': AddToJourneyAutomationAction,
|
|
2862
2892
|
'removeFromJourney': RemoveFromJourneyAutomationAction,
|
|
2863
2893
|
removeFromAllJourneys: RemoveFromAllJourneysAutomationAction,
|
|
@@ -2880,11 +2910,14 @@ export type AutomationActionForType = {
|
|
|
2880
2910
|
switchToRelatedContact: SwitchToRelatedContactAutomationAction,
|
|
2881
2911
|
'elationSync': ElationSyncAutomationAction,
|
|
2882
2912
|
canvasSync: CanvasSyncAutomationAction,
|
|
2913
|
+
canvasCreateNote: CanvasCreateNoteAutomationAction,
|
|
2883
2914
|
pushFormsToPortal: PushFormsAutomationAction,
|
|
2884
2915
|
developHealthMedEligibility: DevelopHealthMedicationEligibilityAutomationAction,
|
|
2885
2916
|
cancelFutureAppointments: CancelFutureAppointmentsAutomationAction,
|
|
2886
2917
|
customerIOIdentify: CustomerIOIdentifyAction,
|
|
2887
2918
|
customerIOTrack: CustomerIOTrackAction,
|
|
2919
|
+
cancelCurrentEvent: CancelCurrentEventAction,
|
|
2920
|
+
confirmCurrentEvent: ConfirmCurrentEventAction,
|
|
2888
2921
|
}
|
|
2889
2922
|
export type AutomationActionType = keyof AutomationActionForType
|
|
2890
2923
|
export type AutomationAction = AutomationActionForType[AutomationActionType]
|
|
@@ -3663,6 +3696,7 @@ export interface AnalyticsFrame extends
|
|
|
3663
3696
|
orderedLabels?: string[],
|
|
3664
3697
|
visibleForRoles?: string[],
|
|
3665
3698
|
visibleForUserIds?: string[],
|
|
3699
|
+
index?: number,
|
|
3666
3700
|
}
|
|
3667
3701
|
|
|
3668
3702
|
|
|
@@ -3808,6 +3842,7 @@ export type AutomationTriggerEvents = {
|
|
|
3808
3842
|
'Appointment Completed': AutomationTriggerEventBuilder<"Appointment Completed", { titles?: string[], templateIds?: string[] }, {}>,
|
|
3809
3843
|
'Appointment Cancelled': AutomationTriggerEventBuilder<"Appointment Cancelled", {
|
|
3810
3844
|
titles?: string[],
|
|
3845
|
+
templateIds?: string[],
|
|
3811
3846
|
by?: '' | 'enduser' | 'user', // only implemented for enduser for now
|
|
3812
3847
|
}, {}>,
|
|
3813
3848
|
'Appointment Rescheduled': AutomationTriggerEventBuilder<"Appointment Rescheduled", { titles?: string[] }, {}>,
|
|
@@ -3831,7 +3866,8 @@ export type AutomationTriggerEvents = {
|
|
|
3831
3866
|
'SMS Reply': AutomationTriggerEventBuilder<"SMS Reply", { templateIds: string[], replyKeywords?: string[] }, {}>,
|
|
3832
3867
|
'Order Status Equals': AutomationTriggerEventBuilder<"Order Status Equals", {
|
|
3833
3868
|
source: string,
|
|
3834
|
-
status: string
|
|
3869
|
+
status: string,
|
|
3870
|
+
fills?: string[],
|
|
3835
3871
|
}, { }>,
|
|
3836
3872
|
'Missed Call': AutomationTriggerEventBuilder<"Missed Call", {
|
|
3837
3873
|
phoneNumbers?: string[],
|