@tellescope/types-models 1.101.1 → 1.103.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 +49 -2
- package/lib/cjs/index.d.ts.map +1 -1
- package/lib/cjs/index.js +1 -0
- package/lib/cjs/index.js.map +1 -1
- package/lib/esm/index.d.ts +49 -2
- package/lib/esm/index.d.ts.map +1 -1
- package/lib/esm/index.js +1 -0
- package/lib/esm/index.js.map +1 -1
- package/lib/tsconfig.tsbuildinfo +1 -1
- package/package.json +2 -2
- package/src/index.ts +49 -3
package/src/index.ts
CHANGED
|
@@ -311,6 +311,7 @@ export interface Organization extends Organization_readonly, Organization_requir
|
|
|
311
311
|
altVitalTeamIds?: { teamId: string, label: string }[],
|
|
312
312
|
zendeskSettings?: { priorityGroups?: string[], resolutionFieldId?: string, resolutionFieldOptions?: string[] }
|
|
313
313
|
replyToAllEmails?: string,
|
|
314
|
+
replyToEnduserTransactionalEmails?: string,
|
|
314
315
|
forwardAllIncomingEmailsTo?: string,
|
|
315
316
|
numCustomTypes?: number,
|
|
316
317
|
ticketThreadsEnabled?: boolean, // zendesk enabled
|
|
@@ -473,6 +474,8 @@ export interface User_updatesDisabled {
|
|
|
473
474
|
verifiedEmail: boolean,
|
|
474
475
|
}
|
|
475
476
|
export interface User extends User_required, User_readonly, User_updatesDisabled {
|
|
477
|
+
termsSigned?: Date,
|
|
478
|
+
termsVersion?: string,
|
|
476
479
|
externalId?: string,
|
|
477
480
|
phone?: string;
|
|
478
481
|
fname?: string;
|
|
@@ -668,6 +671,7 @@ export interface Enduser extends Enduser_readonly, Enduser_required, Enduser_upd
|
|
|
668
671
|
fname? : string;
|
|
669
672
|
mname? : string;
|
|
670
673
|
lname? : string;
|
|
674
|
+
suffix?: string;
|
|
671
675
|
journeys?: Indexable<string>;
|
|
672
676
|
scheduledJourneys?: ScheduledJourney[],
|
|
673
677
|
tags? : string[];
|
|
@@ -718,6 +722,7 @@ export interface Enduser extends Enduser_readonly, Enduser_required, Enduser_upd
|
|
|
718
722
|
salesforceId?: string,
|
|
719
723
|
athenaPracticeId?: string,
|
|
720
724
|
athenaDepartmentId?: string,
|
|
725
|
+
vitalTriggersDisabled?: boolean,
|
|
721
726
|
// unsubscribedFromEmail?: boolean,
|
|
722
727
|
// unsubscribedFromSMS?: boolean,
|
|
723
728
|
}
|
|
@@ -1371,6 +1376,7 @@ export type FormFieldOptions = FormFieldValidation & {
|
|
|
1371
1376
|
prefillSignature?: boolean,
|
|
1372
1377
|
includeGroupNumber?: boolean,
|
|
1373
1378
|
holdAppointmentMinutes?: number,
|
|
1379
|
+
rangeStepSize?: number,
|
|
1374
1380
|
}
|
|
1375
1381
|
export type MultipleChoiceOptions = Pick<FormFieldOptions, 'choices' | 'radio' | 'other'>
|
|
1376
1382
|
|
|
@@ -1479,6 +1485,13 @@ export interface Form extends Form_readonly, Form_required, Form_updatesDisabled
|
|
|
1479
1485
|
canvasQuestionId?: string,
|
|
1480
1486
|
}
|
|
1481
1487
|
|
|
1488
|
+
export interface FormGroup_readonly extends ClientRecord {}
|
|
1489
|
+
export interface FormGroup_required {}
|
|
1490
|
+
export interface FormGroup_updatesDisabled {}
|
|
1491
|
+
export interface FormGroup extends FormGroup_readonly, FormGroup_required, FormGroup_updatesDisabled {
|
|
1492
|
+
title: string,
|
|
1493
|
+
formIds: string[],
|
|
1494
|
+
}
|
|
1482
1495
|
|
|
1483
1496
|
export type OAuth2AuthenticationFields = {
|
|
1484
1497
|
access_token: string,
|
|
@@ -1522,6 +1535,7 @@ export interface Integration extends Integration_readonly, Integration_required,
|
|
|
1522
1535
|
shouldCreateNotifications?: boolean, // for indicating users should receive email notifications
|
|
1523
1536
|
disableEnduserAutoSync?: boolean,
|
|
1524
1537
|
disableTicketAutoSync?: boolean,
|
|
1538
|
+
pushCalendarDetails?: boolean,
|
|
1525
1539
|
redactExternalEvents?: boolean,
|
|
1526
1540
|
fhirClientId?: string,
|
|
1527
1541
|
fhirClientSecret?: string,
|
|
@@ -1791,6 +1805,9 @@ export interface FormResponse extends FormResponse_readonly, FormResponse_requir
|
|
|
1791
1805
|
context?: string,
|
|
1792
1806
|
calendarEventId?: string,
|
|
1793
1807
|
copiedFrom?: string,
|
|
1808
|
+
groupId?: string,
|
|
1809
|
+
groupInstance?: string,
|
|
1810
|
+
groupPosition?: number,
|
|
1794
1811
|
}
|
|
1795
1812
|
|
|
1796
1813
|
export interface WebHook_readonly extends ClientRecord {}
|
|
@@ -2266,6 +2283,10 @@ export type CreateTicketAssignmentStrategies = {
|
|
|
2266
2283
|
type: 'Recently-Booked Appointment Host',
|
|
2267
2284
|
info: {},
|
|
2268
2285
|
},
|
|
2286
|
+
'Form Submitter for Journey Trigger': {
|
|
2287
|
+
type: 'Form Submitter for Journey Trigger',
|
|
2288
|
+
info: {},
|
|
2289
|
+
},
|
|
2269
2290
|
'default': {
|
|
2270
2291
|
type: 'default',
|
|
2271
2292
|
info: {},
|
|
@@ -2287,6 +2308,7 @@ export type CreateTicketActionInfo = {
|
|
|
2287
2308
|
actions?: TicketAction[],
|
|
2288
2309
|
closeOnFinishedActions?: boolean,
|
|
2289
2310
|
dueDateOffsetInMS?: number,
|
|
2311
|
+
skipDaysOfWeekForDueDate?: number[], // following JS convention of Sunday = 0
|
|
2290
2312
|
requireConfirmation?: boolean,
|
|
2291
2313
|
reminders?: TicketReminder[],
|
|
2292
2314
|
priority?: number,
|
|
@@ -2856,7 +2878,10 @@ export type AnalyticsQueryFilterForType = {
|
|
|
2856
2878
|
}
|
|
2857
2879
|
"Purchases": { },
|
|
2858
2880
|
"Purchase Credits": { },
|
|
2859
|
-
"Tickets": {
|
|
2881
|
+
"Tickets": {
|
|
2882
|
+
titles?: string[],
|
|
2883
|
+
closeReasons?: string[],
|
|
2884
|
+
},
|
|
2860
2885
|
"Phone Calls": { },
|
|
2861
2886
|
"SMS Messages": {
|
|
2862
2887
|
direction?: string,
|
|
@@ -2891,7 +2916,11 @@ export type AnalyticsQueryGroupingForType = {
|
|
|
2891
2916
|
Cost?: boolean,
|
|
2892
2917
|
} & EnduserGrouping & { Enduser: string },
|
|
2893
2918
|
"Purchase Credits": {} & EnduserGrouping & { Enduser: string },
|
|
2894
|
-
"Tickets": {
|
|
2919
|
+
"Tickets": {
|
|
2920
|
+
Owner?: boolean,
|
|
2921
|
+
Title?: boolean,
|
|
2922
|
+
Outcome?: boolean,
|
|
2923
|
+
} & EnduserGrouping & { Enduser: string },
|
|
2895
2924
|
"Phone Calls": {} & EnduserGrouping & { Enduser: string },
|
|
2896
2925
|
"SMS Messages": {
|
|
2897
2926
|
Score?: boolean,
|
|
@@ -3141,7 +3170,12 @@ export type AutomationTriggerAction = AutomationTriggerActions[AutomationTrigger
|
|
|
3141
3170
|
export type AutomationTriggerEventBuilder <T, I, C> = { type: T, info: I, conditions?: C }
|
|
3142
3171
|
|
|
3143
3172
|
export type AutomationTriggerEvents = {
|
|
3144
|
-
'Form Submitted': AutomationTriggerEventBuilder<"Form Submitted", {
|
|
3173
|
+
'Form Submitted': AutomationTriggerEventBuilder<"Form Submitted", {
|
|
3174
|
+
formId: string,
|
|
3175
|
+
submitterType?: SessionType | 'Anyone',
|
|
3176
|
+
publicIdentifier?: string,
|
|
3177
|
+
hasExpiredEvent?: boolean,
|
|
3178
|
+
}, {}>,
|
|
3145
3179
|
'Form Unsubmitted': AutomationTriggerEventBuilder<"Form Unsubmitted", { formId: string, intervalInMS: number }, {}>,
|
|
3146
3180
|
'Purchase Made': AutomationTriggerEventBuilder<"Purchase Made", { }, {}>,
|
|
3147
3181
|
'Appointment No-Showed': AutomationTriggerEventBuilder<"Appointment No-Showed", { }, {}>,
|
|
@@ -3181,6 +3215,8 @@ export type AutomationTriggerEvents = {
|
|
|
3181
3215
|
'Message Delivery Failure': AutomationTriggerEventBuilder<"Message Delivery Failure", { }, {}>,
|
|
3182
3216
|
'Incoming Message': AutomationTriggerEventBuilder<"Incoming Message", { noCareTeam?: boolean, destinations?: string[], channels?: string[], }, {}>,
|
|
3183
3217
|
'Pregnancy Ended': AutomationTriggerEventBuilder<"Pregnancy Ended", { reason?: string }, {}>,
|
|
3218
|
+
'Form Group Completed': AutomationTriggerEventBuilder<"Form Group Completed", { groupId: string }, {}>,
|
|
3219
|
+
'Form Group Incomplete': AutomationTriggerEventBuilder<"Form Group Incomplete", { groupId: string, intervalInMS: number }, {}>,
|
|
3184
3220
|
}
|
|
3185
3221
|
export type AutomationTriggerEventType = keyof AutomationTriggerEvents
|
|
3186
3222
|
export type AutomationTriggerEvent = AutomationTriggerEvents[AutomationTriggerEventType]
|
|
@@ -3390,6 +3426,7 @@ export interface TicketThreadComment_required {
|
|
|
3390
3426
|
export interface TicketThreadComment_updatesDisabled {}
|
|
3391
3427
|
export interface TicketThreadComment extends TicketThreadComment_readonly, TicketThreadComment_required, TicketThreadComment_updatesDisabled {
|
|
3392
3428
|
userId?: string,
|
|
3429
|
+
userDisplayName?: string,
|
|
3393
3430
|
type?: string,
|
|
3394
3431
|
attachments?: ChatAttachment[]
|
|
3395
3432
|
voice?: {
|
|
@@ -3574,6 +3611,8 @@ export interface VitalConfiguration extends VitalConfiguration_readonly, VitalCo
|
|
|
3574
3611
|
unit: string,
|
|
3575
3612
|
ranges: VitalConfigurationRange[],
|
|
3576
3613
|
mealStatus?: "Before" | "After" | "Any",
|
|
3614
|
+
originalConfigurationId?: string, // for linking to another configuration
|
|
3615
|
+
enduserId?: string, // for specifying an enduser for a new configuration
|
|
3577
3616
|
}
|
|
3578
3617
|
|
|
3579
3618
|
export interface BlockedPhone_readonly extends ClientRecord { }
|
|
@@ -3615,6 +3654,7 @@ export interface WebhookLog_updatesDisabled {}
|
|
|
3615
3654
|
export interface WebhookLog extends WebhookLog_readonly, WebhookLog_required, WebhookLog_updatesDisabled {}
|
|
3616
3655
|
|
|
3617
3656
|
export type ModelForName_required = {
|
|
3657
|
+
form_groups: FormGroup_required,
|
|
3618
3658
|
webhook_logs: WebhookLog_required,
|
|
3619
3659
|
flowchart_notes: FlowchartNote_required,
|
|
3620
3660
|
enduser_problems: EnduserProblem_required,
|
|
@@ -3693,6 +3733,7 @@ export type ModelForName_required = {
|
|
|
3693
3733
|
export type ClientModel_required = ModelForName_required[keyof ModelForName_required]
|
|
3694
3734
|
|
|
3695
3735
|
export interface ModelForName_readonly {
|
|
3736
|
+
form_groups: FormGroup_readonly,
|
|
3696
3737
|
webhook_logs: WebhookLog_readonly,
|
|
3697
3738
|
flowchart_notes: FlowchartNote_readonly,
|
|
3698
3739
|
enduser_problems: EnduserProblem_readonly,
|
|
@@ -3771,6 +3812,7 @@ export interface ModelForName_readonly {
|
|
|
3771
3812
|
export type ClientModel_readonly = ModelForName_readonly[keyof ModelForName_readonly]
|
|
3772
3813
|
|
|
3773
3814
|
export interface ModelForName_updatesDisabled {
|
|
3815
|
+
form_groups: FormGroup_updatesDisabled,
|
|
3774
3816
|
webhook_logs: WebhookLog_updatesDisabled,
|
|
3775
3817
|
flowchart_notes: FlowchartNote_updatesDisabled,
|
|
3776
3818
|
enduser_problems: EnduserProblem_updatesDisabled,
|
|
@@ -3849,6 +3891,7 @@ export interface ModelForName_updatesDisabled {
|
|
|
3849
3891
|
export type ClientModel_updatesDisabled = ModelForName_updatesDisabled[keyof ModelForName_updatesDisabled]
|
|
3850
3892
|
|
|
3851
3893
|
export interface ModelForName extends ModelForName_required, ModelForName_readonly {
|
|
3894
|
+
form_groups: FormGroup,
|
|
3852
3895
|
webhook_logs: WebhookLog,
|
|
3853
3896
|
flowchart_notes: FlowchartNote,
|
|
3854
3897
|
enduser_problems: EnduserProblem,
|
|
@@ -3937,6 +3980,7 @@ export interface UserActivityInfo {
|
|
|
3937
3980
|
export type UserActivityStatus = 'Active' | 'Away' | 'Unavailable'
|
|
3938
3981
|
|
|
3939
3982
|
export const modelNameChecker: { [K in ModelName] : true } = {
|
|
3983
|
+
form_groups: true,
|
|
3940
3984
|
webhook_logs: true,
|
|
3941
3985
|
flowchart_notes: true,
|
|
3942
3986
|
enduser_problems: true,
|
|
@@ -4040,6 +4084,8 @@ export type JourneyContext = {
|
|
|
4040
4084
|
observationId?: string,
|
|
4041
4085
|
phoneCallId?: string,
|
|
4042
4086
|
smsId?: string,
|
|
4087
|
+
formGroupId?: string,
|
|
4088
|
+
publicIdentifier?: string,
|
|
4043
4089
|
}
|
|
4044
4090
|
|
|
4045
4091
|
// https://gist.github.com/aviflax/a4093965be1cd008f172/
|