@tellescope/validation 1.224.0 → 1.226.0

package/src/validation.ts

@@ -121,6 +121,7 @@ import {
   StateCredentialInfo,
   BaseAvailabilityBlock,
   WeeklyAvailability,
+  MonthlyRestriction,
   Timezone,
   TIMEZONE_MAP,
   FormType,
@@ -330,6 +331,8 @@ import {
   AIDecisionAutomationAction,
   AssignInboxItemAutomationAction,
   OnAIDecisionAutomationEvent,
+  OnErrorEventInfo,
+  OnErrorAutomationEvent,
   AIContextSource,
 } from "@tellescope/types-models"
 import {
@@ -1263,6 +1266,11 @@ export const numberValidator = numberValidatorBuilder({ lower: -10000000000000,
 export const numberValidatorOptional = numberValidatorBuilder({ lower: -10000000000000, upper: 10000000000000, isOptional: true, emptyStringOk: true }) // max is 2286 in UTC MS
 export const listOfNumbersValidatorUniqueOptionalOrEmptyOkay = listValidatorUniqueOptionalEmptyOkay(numberValidator, { isNumber: true })
 
+// Day of month and time validators for automation events
+export const numberValidatorMin1Max31 = numberValidatorBuilder({ lower: 1, upper: 31 })
+export const numberValidatorMin0Max23Optional = numberValidatorBuilder({ lower: 0, upper: 23, isOptional: true })
+export const numberValidatorMin0Max59Optional = numberValidatorBuilder({ lower: 0, upper: 59, isOptional: true })
+
 export const fileSizeValidator = numberValidatorBuilder({ lower: 0, upper: MAX_FILE_SIZE })
 
 export const numberOrStringValidatorEmptyOkay = orValidator({
@@ -2447,6 +2455,7 @@ const _AUTOMATION_EVENTS: { [K in AutomationEventType]: any } = {
   waitForTrigger: '',
   onCallOutcome: '',
   onAIDecision: '',
+  onError: '',
 }
 export const AUTOMATION_EVENTS = Object.keys(_AUTOMATION_EVENTS) as AutomationEventType[]
 export const automationEventTypeValidator = exactMatchValidator<AutomationEventType>(AUTOMATION_EVENTS)
@@ -2652,6 +2661,11 @@ export const automationEventValidator = orValidator<{ [K in AutomationEventType]
       eventCondition: objectValidator<AfterActionAutomationEvent['info']['eventCondition']>({
         before: booleanValidatorOptional,
       }, { isOptional: true, emptyOk: true }),
+      dayOfMonthCondition: objectValidator<AfterActionAutomationEvent['info']['dayOfMonthCondition']>({
+        dayOfMonth: numberValidatorMin1Max31,
+        hour: numberValidatorMin0Max23Optional,
+        minute: numberValidatorMin0Max59Optional,
+      }, { isOptional: true, emptyOk: true }),
       skipIfDelayPassed: booleanValidatorOptional,
     }, { emptyOk: false }),
   }),
@@ -2696,11 +2710,17 @@ export const automationEventValidator = orValidator<{ [K in AutomationEventType]
   }),
   onAIDecision: objectValidator<OnAIDecisionAutomationEvent>({
     type: exactMatchValidator(['onAIDecision']),
-    info: objectValidator<OnAIDecisionAutomationEvent['info']>({ 
-      automationStepId: mongoIdStringRequired, 
+    info: objectValidator<OnAIDecisionAutomationEvent['info']>({
+      automationStepId: mongoIdStringRequired,
       outcomes: listOfStringsValidator,
     }, { emptyOk: false }),
   }),
+  onError: objectValidator<OnErrorAutomationEvent>({
+    type: exactMatchValidator(['onError']),
+    info: objectValidator<OnErrorEventInfo>({
+      automationStepId: mongoIdStringRequired,
+    }, { emptyOk: false }),
+  }),
 })
 export const automationEventsValidator = listValidatorEmptyOk(automationEventValidator)
 
@@ -3279,9 +3299,10 @@ export const automationActionValidator = orValidator<{ [K in AutomationActionTyp
   stripeChargeCardOnFile: objectValidator<StripeChargeCardOnFileAutomationAction>({
     ...sharedAutomationActionValidators,
     type: exactMatchValidator(['stripeChargeCardOnFile']),
-    info: objectValidator<StripeChargeCardOnFileAutomationAction['info']>({ 
+    info: objectValidator<StripeChargeCardOnFileAutomationAction['info']>({
       stripeKey: stringValidatorOptionalEmptyOkay,
       priceIds: listOfStringsValidatorEmptyOk,
+      productIds: listOfStringsValidatorOptionalOrEmptyOk,
       subscriptionPriceId: stringValidatorOptionalEmptyOkay,
     }, { emptyOk: false }) // at least tags is required
   }),
@@ -3330,6 +3351,8 @@ export const journeyContextValidator = objectValidator<JourneyContext>({
   fileId: mongoIdStringOptional,
   chatRoomId: mongoIdStringOptional,
   twilioNumber: stringValidatorOptionalEmptyOkay,
+  ticketThreadId: mongoIdStringOptional,
+  ticketThreadCommentId: mongoIdStringOptional,
 })
 
 export const relatedRecordValidator = objectValidator<RelatedRecord>({
@@ -3583,6 +3606,7 @@ export const formFieldOptionsValidator = objectValidator<FormFieldOptions>({
   })),
   validFileTypes: listOfStringsValidatorOptionalOrEmptyOk,
   maxFileSize: numberValidatorOptional,
+  hideFromPortal: booleanValidatorOptional,
   productIds: listOfStringsValidatorOptionalOrEmptyOk,
   chargeImmediately: booleanValidatorOptional,
   signatureUrl: stringValidator5000Optional,
@@ -3656,74 +3680,95 @@ export const formFieldOptionsValidator = objectValidator<FormFieldOptions>({
   allowAddToDatabase: booleanValidatorOptional,
 })
 
+export const blockStyleValidator = objectValidator({
+  width: numberValidatorOptional,
+  height: numberValidatorOptional,
+  backgroundColor: stringValidatorOptional,
+  borderColor: stringValidatorOptional,
+  borderWidth: numberValidatorOptional,
+  textColor: stringValidatorOptional,
+}, { isOptional: true, emptyOk: true })
+
 export const blockValidator = orValidator<{ [K in BlockType]: Block & { type: K } } >({
   h1: objectValidator<BlockContentH1>({
     type: exactMatchValidator(['h1']),
     info: objectValidator<BlockContentH1['info']>({
       text: stringValidator5000EmptyOkay,
     }),
+    style: blockStyleValidator,
   }),
   h2: objectValidator<BlockContentH2>({
     type: exactMatchValidator(['h2']),
     info: objectValidator<BlockContentH1['info']>({
       text: stringValidator5000EmptyOkay,
     }),
+    style: blockStyleValidator,
   }),
   html: objectValidator<BlockContentHTML>({
     type: exactMatchValidator(['html']),
     info: objectValidator<BlockContentHTML['info']>({
       html: stringValidator25000EmptyOkay,
     }),
+    style: blockStyleValidator,
   }),
   image: objectValidator<BlockContentImage>({
     type: exactMatchValidator(['image']),
     info: objectValidator<BlockContentImage['info']>({
       link: stringValidator5000EmptyOkay,
       name: stringValidatorOptional,
+      alt: stringValidatorOptional,
       height: numberValidatorOptional,
       maxHeight: numberValidatorOptional,
       width: numberValidatorOptional,
       maxWidth: numberValidatorOptional,
     }),
+    style: blockStyleValidator,
   }),
   pdf: objectValidator<BlockContentPDF>({
     type: exactMatchValidator(['pdf']),
     info: objectValidator<BlockContentPDF['info']>({
       link: stringValidator5000EmptyOkay,
       name: stringValidatorOptional,
+      alt: stringValidatorOptional,
       height: numberValidatorOptional,
       maxHeight: numberValidatorOptional,
       width: numberValidatorOptional,
       maxWidth: numberValidatorOptional,
     }),
+    style: blockStyleValidator,
   }),
   youtube: objectValidator<BlockContentYoutube>({
     type: exactMatchValidator(['youtube']),
     info: objectValidator<BlockContentYoutube['info']>({
       link: stringValidator5000EmptyOkay,
       name: stringValidatorOptional,
+      alt: stringValidatorOptional,
       height: numberValidatorOptional,
       maxHeight: numberValidatorOptional,
       width: numberValidatorOptional,
       maxWidth: numberValidatorOptional,
     }),
+    style: blockStyleValidator,
   }),
   iframe: objectValidator<BlockContentIFrame>({
     type: exactMatchValidator(['iframe']),
     info: objectValidator<BlockContentIFrame['info']>({
       link: stringValidator5000EmptyOkay,
       name: stringValidatorOptional,
+      alt: stringValidatorOptional,
       height: numberValidatorOptional,
       maxHeight: numberValidatorOptional,
       width: numberValidatorOptional,
       maxWidth: numberValidatorOptional,
     }),
+    style: blockStyleValidator,
   }),
   "content-link": objectValidator<BlockContentLink>({
     type: exactMatchValidator(["content-link"]),
     info: objectValidator<BlockContentLink['info']>({
       recordId: mongoIdStringRequired,
     }),
+    style: blockStyleValidator,
   }),
 })
 
@@ -4027,6 +4072,13 @@ export const portalBlockValidator = orValidator<{ [K in PortalBlockType]: Portal
     info: objectValidator<PortalBlockForType['HTML']['info']>({
       html: stringValidator5000,
     })
+  }),
+  pinnedForms: objectValidator<PortalBlockForType['pinnedForms']>({
+    type: exactMatchValidator(['pinnedForms']),
+    info: objectValidator<PortalBlockForType['pinnedForms']['info']>({
+      title: stringValidatorOptional,
+      formIds: listOfMongoIdStringValidatorEmptyOk,
+    })
   }), 
 })
 export const portalBlocksValidator = listValidatorEmptyOk(portalBlockValidator)
@@ -4041,6 +4093,7 @@ const _PORTAL_BLOCK_TYPES: { [K in PortalBlockType]: any } = {
   "Manage Subscription Button": '',
   Orders: '',
   HTML: '',
+  pinnedForms: '',
 }
 export const PORTAL_BLOCK_TYPES = Object.keys(_PORTAL_BLOCK_TYPES) as PortalBlockType[]
 export const portalTypeValidator = exactMatchValidator<PortalBlockType>(PORTAL_BLOCK_TYPES)
@@ -4079,6 +4132,27 @@ export const baseAvailabilityBlockValidator = objectValidator<BaseAvailabilityBl
 })
 export const baseAvailabilityBlocksValidator = listValidatorEmptyOk(baseAvailabilityBlockValidator)
 
+const monthlyOccurrenceValidator: ValidatorDefinition<1 | 2 | 3 | 4 | 5> = {
+  validate: (o={}) => build_validator(
+    (value: JSONType) => {
+      if (![1, 2, 3, 4, 5].includes(value as number)) {
+        throw new Error(`Value must be one of 1, 2, 3, 4, 5`)
+      }
+      return value as 1 | 2 | 3 | 4 | 5
+    },
+    { ...o, listOf: false }
+  ),
+  getExample: () => 1,
+  getType: getTypeString,
+}
+
+export const monthlyRestrictionValidator = objectValidator<MonthlyRestriction>({
+  occurrences: listValidator(monthlyOccurrenceValidator),
+})
+export const monthlyRestrictionOptionalValidator = objectValidator<MonthlyRestriction>({
+  occurrences: listValidator(monthlyOccurrenceValidator),
+}, { isOptional: true, emptyOk: true })
+
 export const weeklyAvailabilityValidator = objectValidator<WeeklyAvailability>({
   dayOfWeekStartingSundayIndexedByZero: nonNegNumberValidator,
   endTimeInMinutes: nonNegNumberValidator,
@@ -4090,6 +4164,7 @@ export const weeklyAvailabilityValidator = objectValidator<WeeklyAvailability>({
   intervalInMinutes: numberValidatorOptional,
   priority: numberValidatorOptional,
   bufferStartMinutes: numberValidatorOptional,
+  monthlyRestriction: monthlyRestrictionOptionalValidator,
 })
 export const weeklyAvailabilitiesValidator = listValidatorEmptyOk(weeklyAvailabilityValidator)
 
@@ -4140,6 +4215,7 @@ export const customEnduserFieldValidator = orValidator<{ [K in CustomEnduserFiel
     required: booleanValidatorOptional,
     hiddenFromProfile: booleanValidatorOptional,
     requireConfirmation: booleanValidatorOptional,
+    tags: listOfStringsValidatorOptionalOrEmptyOk,
   }), 
   "Multiple Select": objectValidator<CustomEnduserFields['Multiple Select']>({
     type: exactMatchValidator(['Multiple Select']),
@@ -4150,6 +4226,7 @@ export const customEnduserFieldValidator = orValidator<{ [K in CustomEnduserFiel
     required: booleanValidatorOptional,
     hiddenFromProfile: booleanValidatorOptional,
     requireConfirmation: booleanValidatorOptional,
+    tags: listOfStringsValidatorOptionalOrEmptyOk,
   }), 
   Text: objectValidator<CustomEnduserFields['Text']>({
     type: exactMatchValidator(['Text']),
@@ -4158,6 +4235,7 @@ export const customEnduserFieldValidator = orValidator<{ [K in CustomEnduserFiel
     required: booleanValidatorOptional,
     hiddenFromProfile: booleanValidatorOptional,
     requireConfirmation: booleanValidatorOptional,
+    tags: listOfStringsValidatorOptionalOrEmptyOk,
   }), 
   Number: objectValidator<CustomEnduserFields['Number']>({
     type: exactMatchValidator(['Number']),
@@ -4166,6 +4244,7 @@ export const customEnduserFieldValidator = orValidator<{ [K in CustomEnduserFiel
     required: booleanValidatorOptional,
     hiddenFromProfile: booleanValidatorOptional,
     requireConfirmation: booleanValidatorOptional,
+    tags: listOfStringsValidatorOptionalOrEmptyOk,
   }), 
   File: objectValidator<CustomEnduserFields['File']>({
     type: exactMatchValidator(['File']),
@@ -4174,6 +4253,7 @@ export const customEnduserFieldValidator = orValidator<{ [K in CustomEnduserFiel
     required: booleanValidatorOptional,
     hiddenFromProfile: booleanValidatorOptional,
     requireConfirmation: booleanValidatorOptional,
+    tags: listOfStringsValidatorOptionalOrEmptyOk,
   }), 
   "Multiple Text": objectValidator<CustomEnduserFields["Multiple Text"]>({
     type: exactMatchValidator(["Multiple Text"]),
@@ -4182,6 +4262,7 @@ export const customEnduserFieldValidator = orValidator<{ [K in CustomEnduserFiel
     required: booleanValidatorOptional,
     hiddenFromProfile: booleanValidatorOptional,
     requireConfirmation: booleanValidatorOptional,
+    tags: listOfStringsValidatorOptionalOrEmptyOk,
   }), 
   Date: objectValidator<CustomEnduserFields['Date']>({
     type: exactMatchValidator(['Date']),
@@ -4190,6 +4271,7 @@ export const customEnduserFieldValidator = orValidator<{ [K in CustomEnduserFiel
     required: booleanValidatorOptional,
     hiddenFromProfile: booleanValidatorOptional,
     requireConfirmation: booleanValidatorOptional,
+    tags: listOfStringsValidatorOptionalOrEmptyOk,
   }), 
   "Auto Detect": objectValidator<CustomEnduserFields["Auto Detect"]>({
     type: exactMatchValidator(["Auto Detect"]),
@@ -4198,6 +4280,7 @@ export const customEnduserFieldValidator = orValidator<{ [K in CustomEnduserFiel
     required: booleanValidatorOptional,
     hiddenFromProfile: booleanValidatorOptional,
     requireConfirmation: booleanValidatorOptional,
+    tags: listOfStringsValidatorOptionalOrEmptyOk,
   }), 
   "Table": objectValidator<CustomEnduserFields["Table"]>({
     type: exactMatchValidator(["Table"]),
@@ -4208,6 +4291,7 @@ export const customEnduserFieldValidator = orValidator<{ [K in CustomEnduserFiel
     required: booleanValidatorOptional,
     hiddenFromProfile: booleanValidatorOptional,
     requireConfirmation: booleanValidatorOptional,
+    tags: listOfStringsValidatorOptionalOrEmptyOk,
   }), 
   "Checkbox": objectValidator<CustomEnduserFields["Checkbox"]>({
     type: exactMatchValidator(["Checkbox"]),
@@ -4216,6 +4300,7 @@ export const customEnduserFieldValidator = orValidator<{ [K in CustomEnduserFiel
     required: booleanValidatorOptional,
     hiddenFromProfile: booleanValidatorOptional,
     requireConfirmation: booleanValidatorOptional,
+    tags: listOfStringsValidatorOptionalOrEmptyOk,
   }), 
   "Database Select": objectValidator<CustomEnduserFields["Database Select"]>({
     type: exactMatchValidator(["Database Select"]),
@@ -4227,6 +4312,7 @@ export const customEnduserFieldValidator = orValidator<{ [K in CustomEnduserFiel
     required: booleanValidatorOptional,
     hiddenFromProfile: booleanValidatorOptional,
     requireConfirmation: booleanValidatorOptional,
+    tags: listOfStringsValidatorOptionalOrEmptyOk,
   }), 
 })
 export const customEnduserFieldsValidatorOptionalOrEmpty = listValidatorOptionalOrEmptyOk(customEnduserFieldValidator)
@@ -4570,6 +4656,7 @@ export const automationTriggerEventValidator = orValidator<{ [K in AutomationTri
     type: exactMatchValidator(['Appointment Rescheduled']),
     info: objectValidator<AutomationTriggerEvents['Appointment Rescheduled']['info']>({
       titles: listOfStringsValidatorOptionalOrEmptyOk,
+      detectManualReschedules: booleanValidatorOptional,
     }),
     conditions: optionalEmptyObjectValidator,
   }), 
@@ -4758,6 +4845,7 @@ const _AUTOMATION_TRIGGER_ACTION_TYPES: { [K in AutomationTriggerActionType]: an
   "Reply to Chat": true,
   "Create User Notifications": true,
   "Assign to Incoming Message": true,
+  "Zendesk: Update Ticket Assignee": true,
 }
 export const AUTOMATION_TRIGGER_ACTION_TYPES = Object.keys(_AUTOMATION_TRIGGER_ACTION_TYPES) as AutomationTriggerActionType[]
 
@@ -4880,6 +4968,11 @@ export const automationTriggerActionValidator = orValidator<{ [K in AutomationTr
       maxUsers: numberValidatorOptional,
     }),
   }),
+  "Zendesk: Update Ticket Assignee": objectValidator<AutomationTriggerActions["Zendesk: Update Ticket Assignee"]>({
+    type: exactMatchValidator(['Zendesk: Update Ticket Assignee']),
+    info: objectValidator<AutomationTriggerActions['Zendesk: Update Ticket Assignee']['info']>({
+    }),
+  }),
 })
 
 
@@ -5367,6 +5460,7 @@ export const analyticsQueryValidator = orValidator<{ [K in AnalyticsQueryType]:
       State: booleanValidatorOptional,
       Phone: booleanValidatorOptional,
       "Scheduled By": booleanValidatorOptional,
+      "Completed By": booleanValidatorOptional,
       alsoGroupByHost: booleanValidatorOptional,
       "Cancel Reason": booleanValidatorOptional,
     }, { isOptional: true, emptyOk: true }),