@tellescope/types-models 1.224.0 → 1.226.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 +45 -1
- package/lib/cjs/index.d.ts.map +1 -1
- package/lib/cjs/index.js.map +1 -1
- package/lib/esm/index.d.ts +45 -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 +60 -9
package/lib/cjs/index.d.ts
CHANGED
|
@@ -116,6 +116,7 @@ type BuildCustomEnduserField<T, I> = {
|
|
|
116
116
|
required?: boolean;
|
|
117
117
|
hiddenFromProfile?: boolean;
|
|
118
118
|
requireConfirmation?: boolean;
|
|
119
|
+
tags?: string[];
|
|
119
120
|
};
|
|
120
121
|
export type CustomEnduserFields = {
|
|
121
122
|
"Select": BuildCustomEnduserField<'Select', {
|
|
@@ -362,6 +363,7 @@ export interface Organization extends Organization_readonly, Organization_requir
|
|
|
362
363
|
externalCalendarEventPlaceholderDescription?: string;
|
|
363
364
|
customZoomEmailTemplate?: string;
|
|
364
365
|
customZoomEmailSubject?: string;
|
|
366
|
+
customZoomSMSTemplate?: string;
|
|
365
367
|
customVoicemailText?: string;
|
|
366
368
|
hasConnectedOpenAI?: boolean;
|
|
367
369
|
hasConnectedHealthie?: boolean;
|
|
@@ -567,6 +569,9 @@ export type StateCredentialInfo = {
|
|
|
567
569
|
licenseId?: string;
|
|
568
570
|
expiresAt?: Date;
|
|
569
571
|
};
|
|
572
|
+
export type MonthlyRestriction = {
|
|
573
|
+
occurrences: (1 | 2 | 3 | 4 | 5)[];
|
|
574
|
+
};
|
|
570
575
|
export type WeeklyAvailability = {
|
|
571
576
|
dayOfWeekStartingSundayIndexedByZero: number;
|
|
572
577
|
startTimeInMinutes: number;
|
|
@@ -578,6 +583,7 @@ export type WeeklyAvailability = {
|
|
|
578
583
|
locationIds?: string[];
|
|
579
584
|
validTemplateIds?: string[];
|
|
580
585
|
priority?: number;
|
|
586
|
+
monthlyRestriction?: MonthlyRestriction;
|
|
581
587
|
};
|
|
582
588
|
export type NotificationPreference = {
|
|
583
589
|
email?: boolean;
|
|
@@ -837,6 +843,7 @@ export interface Enduser extends Enduser_readonly, Enduser_required, Enduser_upd
|
|
|
837
843
|
markedReadAt?: Date | '';
|
|
838
844
|
markedUnreadAt?: Date | '';
|
|
839
845
|
note?: string;
|
|
846
|
+
noteIsFlagged?: boolean;
|
|
840
847
|
mfa?: MFASettings;
|
|
841
848
|
lastZendeskSyncAt?: Date;
|
|
842
849
|
accessTags?: string[];
|
|
@@ -1613,6 +1620,7 @@ export type FormFieldOptions = FormFieldValidation & {
|
|
|
1613
1620
|
subFields?: FormSubField[];
|
|
1614
1621
|
validFileTypes?: string[];
|
|
1615
1622
|
maxFileSize?: number;
|
|
1623
|
+
hideFromPortal?: boolean;
|
|
1616
1624
|
signatureUrl?: string;
|
|
1617
1625
|
productIds?: string[];
|
|
1618
1626
|
chargeImmediately?: boolean;
|
|
@@ -1769,6 +1777,7 @@ export interface Form extends Form_readonly, Form_required, Form_updatesDisabled
|
|
|
1769
1777
|
htmlThanksMessage?: string;
|
|
1770
1778
|
type?: FormType;
|
|
1771
1779
|
scoring?: FormScoring[];
|
|
1780
|
+
realTimeScoring?: boolean;
|
|
1772
1781
|
externalId?: string;
|
|
1773
1782
|
ga4measurementId?: string;
|
|
1774
1783
|
backgroundColor?: string;
|
|
@@ -2363,6 +2372,7 @@ export interface CalendarEvent extends CalendarEvent_readonly, CalendarEvent_req
|
|
|
2363
2372
|
canvasReasonCoding?: CanvasCoding;
|
|
2364
2373
|
canvasLocationId?: string;
|
|
2365
2374
|
completedAt?: Date | '';
|
|
2375
|
+
completedBy?: string;
|
|
2366
2376
|
holdUntil?: Date;
|
|
2367
2377
|
holdFormResponseId?: string;
|
|
2368
2378
|
tags?: string[];
|
|
@@ -2610,6 +2620,8 @@ export interface AppointmentBookingPage extends AppointmentBookingPage_readonly,
|
|
|
2610
2620
|
archivedAt?: Date | '';
|
|
2611
2621
|
gtmTag?: string;
|
|
2612
2622
|
dontRestrictRescheduleToOriginalHost?: boolean;
|
|
2623
|
+
calendarTitleText?: string;
|
|
2624
|
+
emailFieldBehavior?: "required" | "optional" | "hidden";
|
|
2613
2625
|
}
|
|
2614
2626
|
export interface CalendarEventRSVP_readonly extends ClientRecord {
|
|
2615
2627
|
creatorType: SessionType;
|
|
@@ -2648,7 +2660,7 @@ export interface WebhookCall {
|
|
|
2648
2660
|
integrity: string;
|
|
2649
2661
|
description?: string;
|
|
2650
2662
|
}
|
|
2651
|
-
export type AutomationEventType = 'onJourneyStart' | 'afterAction' | "formResponse" | "formResponses" | "formUnsubmitted" | "formsUnsubmitted" | "ticketCompleted" | 'waitForTrigger' | "onCallOutcome" | "onAIDecision";
|
|
2663
|
+
export type AutomationEventType = 'onJourneyStart' | 'afterAction' | "formResponse" | "formResponses" | "formUnsubmitted" | "formsUnsubmitted" | "ticketCompleted" | 'waitForTrigger' | "onCallOutcome" | "onAIDecision" | "onError";
|
|
2652
2664
|
interface AutomationEventBuilder<T extends AutomationEventType, V extends object> {
|
|
2653
2665
|
type: T;
|
|
2654
2666
|
info: V;
|
|
@@ -2765,6 +2777,11 @@ export type AfterActionAutomationEvent = AutomationEventBuilder<'afterAction', A
|
|
|
2765
2777
|
eventCondition?: {
|
|
2766
2778
|
before?: boolean;
|
|
2767
2779
|
};
|
|
2780
|
+
dayOfMonthCondition?: {
|
|
2781
|
+
dayOfMonth: number;
|
|
2782
|
+
hour?: number;
|
|
2783
|
+
minute?: number;
|
|
2784
|
+
};
|
|
2768
2785
|
skipIfDelayPassed?: boolean;
|
|
2769
2786
|
}>;
|
|
2770
2787
|
export type FormUnsubmittedEvent = AutomationEventBuilder<'formUnsubmitted', FormUnsubmittedEventInfo>;
|
|
@@ -2783,6 +2800,10 @@ export type OnAIDecisionAutomationEvent = AutomationEventBuilder<'onAIDecision',
|
|
|
2783
2800
|
automationStepId: string;
|
|
2784
2801
|
outcomes: string[];
|
|
2785
2802
|
}>;
|
|
2803
|
+
export type OnErrorEventInfo = {
|
|
2804
|
+
automationStepId: string;
|
|
2805
|
+
};
|
|
2806
|
+
export type OnErrorAutomationEvent = AutomationEventBuilder<'onError', OnErrorEventInfo>;
|
|
2786
2807
|
export type AutomationEventForType = {
|
|
2787
2808
|
'onJourneyStart': OnJourneyStartAutomationEvent;
|
|
2788
2809
|
'afterAction': AfterActionAutomationEvent;
|
|
@@ -2794,6 +2815,7 @@ export type AutomationEventForType = {
|
|
|
2794
2815
|
'waitForTrigger': WaitForTriggerAutomationEvent;
|
|
2795
2816
|
'onCallOutcome': OnCallOutcomeAutomationEvent;
|
|
2796
2817
|
'onAIDecision': OnAIDecisionAutomationEvent;
|
|
2818
|
+
'onError': OnErrorAutomationEvent;
|
|
2797
2819
|
};
|
|
2798
2820
|
export type AutomationEvent = AutomationEventForType[keyof AutomationEventForType];
|
|
2799
2821
|
export type SetEnduserStatusInfo = {
|
|
@@ -3044,6 +3066,7 @@ export type CallUserAutomationAction = AutomationActionBuilder<'callUser', {
|
|
|
3044
3066
|
export type StripeChargeCardOnFileAutomationAction = AutomationActionBuilder<'stripeChargeCardOnFile', {
|
|
3045
3067
|
stripeKey?: string;
|
|
3046
3068
|
priceIds: string[];
|
|
3069
|
+
productIds?: string[];
|
|
3047
3070
|
subscriptionPriceId?: string;
|
|
3048
3071
|
}>;
|
|
3049
3072
|
export type AIContextSource = {
|
|
@@ -3195,9 +3218,18 @@ export interface EnduserObservation extends EnduserObservation_readonly, Enduser
|
|
|
3195
3218
|
excludeFromVitalCountLookback?: boolean;
|
|
3196
3219
|
}
|
|
3197
3220
|
export type BlockType = 'h1' | 'h2' | 'html' | 'image' | 'youtube' | 'pdf' | 'iframe' | 'content-link';
|
|
3221
|
+
export type BlockStyle = {
|
|
3222
|
+
width?: number;
|
|
3223
|
+
height?: number;
|
|
3224
|
+
backgroundColor?: string;
|
|
3225
|
+
borderColor?: string;
|
|
3226
|
+
borderWidth?: number;
|
|
3227
|
+
textColor?: string;
|
|
3228
|
+
};
|
|
3198
3229
|
export type ContentBlockBuilder<BLOCK extends BlockType, INFO extends object> = {
|
|
3199
3230
|
type: BLOCK;
|
|
3200
3231
|
info: INFO;
|
|
3232
|
+
style?: BlockStyle;
|
|
3201
3233
|
};
|
|
3202
3234
|
export type BlockContentText = {
|
|
3203
3235
|
text: string;
|
|
@@ -3205,6 +3237,7 @@ export type BlockContentText = {
|
|
|
3205
3237
|
export type BlockContentMedia = {
|
|
3206
3238
|
link: string;
|
|
3207
3239
|
name?: string;
|
|
3240
|
+
alt?: string;
|
|
3208
3241
|
height?: number;
|
|
3209
3242
|
maxHeight?: number;
|
|
3210
3243
|
width?: number;
|
|
@@ -3301,6 +3334,10 @@ export type PortalBlockForType = {
|
|
|
3301
3334
|
HTML: BuildPortalBlockInfo<'HTML', {
|
|
3302
3335
|
html: string;
|
|
3303
3336
|
}>;
|
|
3337
|
+
pinnedForms: BuildPortalBlockInfo<'pinnedForms', {
|
|
3338
|
+
title?: string;
|
|
3339
|
+
formIds?: string[];
|
|
3340
|
+
}>;
|
|
3304
3341
|
};
|
|
3305
3342
|
export type PortalBlockType = keyof PortalBlockForType;
|
|
3306
3343
|
export type PortalBlock = PortalBlockForType[PortalBlockType];
|
|
@@ -3555,6 +3592,7 @@ export interface PhoneCall extends PhoneCall_readonly, PhoneCall_required, Phone
|
|
|
3555
3592
|
conferenceAttendees?: (string[]) | (string[][]);
|
|
3556
3593
|
unread?: boolean;
|
|
3557
3594
|
transcription?: string;
|
|
3595
|
+
recordingTranscriptionData?: string;
|
|
3558
3596
|
note?: string;
|
|
3559
3597
|
userId?: string;
|
|
3560
3598
|
pinnedAt?: Date | '';
|
|
@@ -3739,6 +3777,7 @@ export type AnalyticsQueryGroupingForType = {
|
|
|
3739
3777
|
"Calendar Events": {
|
|
3740
3778
|
Type: boolean;
|
|
3741
3779
|
"Scheduled By"?: boolean;
|
|
3780
|
+
"Completed By"?: boolean;
|
|
3742
3781
|
alsoGroupByHost?: boolean;
|
|
3743
3782
|
"Cancel Reason"?: boolean;
|
|
3744
3783
|
} & EnduserGrouping & {
|
|
@@ -3886,6 +3925,7 @@ export interface AnalyticsFrame extends AnalyticsFrame_readonly, AnalyticsFrame_
|
|
|
3886
3925
|
visibleForRoles?: string[];
|
|
3887
3926
|
visibleForUserIds?: string[];
|
|
3888
3927
|
index?: number;
|
|
3928
|
+
tags?: string[];
|
|
3889
3929
|
}
|
|
3890
3930
|
export interface BackgroundError_readonly extends ClientRecord {
|
|
3891
3931
|
}
|
|
@@ -4062,6 +4102,7 @@ export type AutomationTriggerActions = {
|
|
|
4062
4102
|
tags?: ListOfStringsWithQualifier;
|
|
4063
4103
|
maxUsers?: number;
|
|
4064
4104
|
}>;
|
|
4105
|
+
"Zendesk: Update Ticket Assignee": AutomationTriggerActionBuilder<'Zendesk: Update Ticket Assignee', {}>;
|
|
4065
4106
|
};
|
|
4066
4107
|
export type AutomationTriggerActionType = keyof AutomationTriggerActions;
|
|
4067
4108
|
export type AutomationTriggerAction = AutomationTriggerActions[AutomationTriggerActionType];
|
|
@@ -4126,6 +4167,7 @@ export type AutomationTriggerEvents = {
|
|
|
4126
4167
|
}, {}>;
|
|
4127
4168
|
'Appointment Rescheduled': AutomationTriggerEventBuilder<"Appointment Rescheduled", {
|
|
4128
4169
|
titles?: string[];
|
|
4170
|
+
detectManualReschedules?: boolean;
|
|
4129
4171
|
}, {}>;
|
|
4130
4172
|
'Medication Added': AutomationTriggerEventBuilder<"Medication Added", {
|
|
4131
4173
|
titles: string[];
|
|
@@ -5376,6 +5418,8 @@ export type JourneyContext = {
|
|
|
5376
5418
|
fileId?: string;
|
|
5377
5419
|
chatRoomId?: string;
|
|
5378
5420
|
twilioNumber?: string;
|
|
5421
|
+
ticketThreadId?: string;
|
|
5422
|
+
ticketThreadCommentId?: string;
|
|
5379
5423
|
};
|
|
5380
5424
|
export declare const TIMEZONE_MAP: {
|
|
5381
5425
|
readonly "Africa/Abidjan": "+00:00";
|