@tellescope/validation 1.225.0 → 1.227.0

package/src/validation.ts

@@ -121,6 +121,7 @@ import {
   StateCredentialInfo,
   BaseAvailabilityBlock,
   WeeklyAvailability,
+  MonthlyRestriction,
   Timezone,
   TIMEZONE_MAP,
   FormType,
@@ -267,6 +268,8 @@ import {
   SmartMeterPlaceOrderAutomationAction,
   SmartMeterOrderLineItem,
   FormFieldFeedback,
+  FormFieldOptionDetails,
+  MultipleChoiceOptions,
   CandidProcedureCode,
   BasicWebhook,
   RemoveEnduserTagsAutomationAction,
@@ -1265,6 +1268,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({
@@ -1541,11 +1549,6 @@ export const labeledFieldsValidator = listValidatorOptionalOrEmptyOk(objectValid
   value: stringValidator5000,
 }))
 
-type MultipleChoiceOptions = {
-  choices: string[],
-  other: boolean,
-  radio: boolean,
-}
 
 const DEFAULT_ENDUSER_FIELDS = [
   '_id', 'email', 'phone', 'fname', 'lname', 'journeys', 'tags', 'preference'
@@ -1665,11 +1668,12 @@ export const FORM_FIELD_VALIDATORS_BY_TYPE: { [K in FormFieldType | 'userEmail'
     }
 
     const parsed = []
+    const choices = fieldOptions.choices || []
     for (const i of indexes) {
       if (typeof i !== 'number') throw new Error(`Choice ${i} is not a valid index`)
-      if (i < 0 || i >= fieldOptions.choices.length) throw new Error(`Choice ${i} is not a valid index`)
+      if (i < 0 || i >= choices.length) throw new Error(`Choice ${i} is not a valid index`)
 
-      parsed.push(fieldOptions.choices[i])
+      parsed.push(choices[i])
     }
     if (otherText && fieldOptions.other === true) parsed.push(otherText)
     // todo: add length limit to otherText?
@@ -2655,6 +2659,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 }),
   }),
@@ -3419,6 +3428,7 @@ export const portalSettingsValidator = objectValidator<PortalSettings>({
     loginDescription: stringValidator1000Optional,
     loginGraphic: stringValidator1000Optional,
     loginTitle: stringValidator1000Optional,
+    loginBottomHTML: stringValidator5000OptionalEmptyOkay,
     registerDescription: stringValidator1000Optional,
     registerGraphic: stringValidator1000Optional,
     registerTitle: stringValidator1000Optional,
@@ -3577,12 +3587,17 @@ export const formFieldFeedbackValidator = objectValidator<FormFieldFeedback>({
   ifEquals: stringValidator,
   display: stringValidator,
 })
+export const formFieldOptionDetailsValidator = objectValidator<FormFieldOptionDetails>({
+  option: stringValidator,
+  description: stringValidator5000Optional,
+})
 
 export const formFieldOptionsValidator = objectValidator<FormFieldOptions>({
   default: stringValidatorOptional,
   bookingPageId: stringValidatorOptional,
   tableChoices: listValidatorOptionalOrEmptyOk(tableInputChoiceValidator),
   choices: listOfStringsValidatorOptionalOrEmptyOk,
+  optionDetails: listValidatorOptionalOrEmptyOk(formFieldOptionDetailsValidator),
   radioChoices: listOfStringsValidatorOptionalOrEmptyOk,
   canvasCodings: listValidatorOptionalOrEmptyOk(canvasCodingValidator),
   from: numberValidatorOptional,
@@ -3605,6 +3620,7 @@ export const formFieldOptionsValidator = objectValidator<FormFieldOptions>({
   databaseId: mongoIdStringOptional,
   databaseLabel: stringValidatorOptionalEmptyOkay,
   databaseLabels: listOfStringsValidatorOptionalOrEmptyOk,
+  filterByEnduserState: booleanValidatorOptional,
   databaseFilter: objectValidator<FormFieldOptions['databaseFilter']>({
     databaseLabel: stringValidator1000Optional,
     fieldId: mongoIdStringOptional,
@@ -3652,6 +3668,7 @@ export const formFieldOptionsValidator = objectValidator<FormFieldOptions>({
   max: numberValidatorOptional,
   min: numberValidatorOptional,
   stripeKey: stringValidatorOptionalEmptyOkay,
+  stripeProductSelectionMode: booleanValidatorOptional,
   dataSource: stringValidatorOptionalEmptyOkay,
   esignatureTermsCompanyName: stringValidatorOptionalEmptyOkay,
   observationCode: stringValidatorOptionalEmptyOkay,
@@ -4030,6 +4047,7 @@ export const portalBlockValidator = orValidator<{ [K in PortalBlockType]: Portal
       title: stringValidator,
       roles: listOfStringsValidatorOptionalOrEmptyOk,
       showAll: booleanValidatorOptional,
+      hideContactButton: booleanValidatorOptional,
       // members: listValidatorEmptyOk(
       //   objectValidator<CareTeamMemberPortalCustomizationInfo>({
       //     title: stringValidator(),
@@ -4121,6 +4139,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,
@@ -4132,6 +4171,7 @@ export const weeklyAvailabilityValidator = objectValidator<WeeklyAvailability>({
   intervalInMinutes: numberValidatorOptional,
   priority: numberValidatorOptional,
   bufferStartMinutes: numberValidatorOptional,
+  monthlyRestriction: monthlyRestrictionOptionalValidator,
 })
 export const weeklyAvailabilitiesValidator = listValidatorEmptyOk(weeklyAvailabilityValidator)
 
@@ -4182,6 +4222,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']),
@@ -4192,6 +4233,7 @@ export const customEnduserFieldValidator = orValidator<{ [K in CustomEnduserFiel
     required: booleanValidatorOptional,
     hiddenFromProfile: booleanValidatorOptional,
     requireConfirmation: booleanValidatorOptional,
+    tags: listOfStringsValidatorOptionalOrEmptyOk,
   }), 
   Text: objectValidator<CustomEnduserFields['Text']>({
     type: exactMatchValidator(['Text']),
@@ -4200,6 +4242,7 @@ export const customEnduserFieldValidator = orValidator<{ [K in CustomEnduserFiel
     required: booleanValidatorOptional,
     hiddenFromProfile: booleanValidatorOptional,
     requireConfirmation: booleanValidatorOptional,
+    tags: listOfStringsValidatorOptionalOrEmptyOk,
   }), 
   Number: objectValidator<CustomEnduserFields['Number']>({
     type: exactMatchValidator(['Number']),
@@ -4208,6 +4251,7 @@ export const customEnduserFieldValidator = orValidator<{ [K in CustomEnduserFiel
     required: booleanValidatorOptional,
     hiddenFromProfile: booleanValidatorOptional,
     requireConfirmation: booleanValidatorOptional,
+    tags: listOfStringsValidatorOptionalOrEmptyOk,
   }), 
   File: objectValidator<CustomEnduserFields['File']>({
     type: exactMatchValidator(['File']),
@@ -4216,6 +4260,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"]),
@@ -4224,6 +4269,7 @@ export const customEnduserFieldValidator = orValidator<{ [K in CustomEnduserFiel
     required: booleanValidatorOptional,
     hiddenFromProfile: booleanValidatorOptional,
     requireConfirmation: booleanValidatorOptional,
+    tags: listOfStringsValidatorOptionalOrEmptyOk,
   }), 
   Date: objectValidator<CustomEnduserFields['Date']>({
     type: exactMatchValidator(['Date']),
@@ -4232,6 +4278,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"]),
@@ -4240,6 +4287,7 @@ export const customEnduserFieldValidator = orValidator<{ [K in CustomEnduserFiel
     required: booleanValidatorOptional,
     hiddenFromProfile: booleanValidatorOptional,
     requireConfirmation: booleanValidatorOptional,
+    tags: listOfStringsValidatorOptionalOrEmptyOk,
   }), 
   "Table": objectValidator<CustomEnduserFields["Table"]>({
     type: exactMatchValidator(["Table"]),
@@ -4250,6 +4298,7 @@ export const customEnduserFieldValidator = orValidator<{ [K in CustomEnduserFiel
     required: booleanValidatorOptional,
     hiddenFromProfile: booleanValidatorOptional,
     requireConfirmation: booleanValidatorOptional,
+    tags: listOfStringsValidatorOptionalOrEmptyOk,
   }), 
   "Checkbox": objectValidator<CustomEnduserFields["Checkbox"]>({
     type: exactMatchValidator(["Checkbox"]),
@@ -4258,6 +4307,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"]),
@@ -4269,6 +4319,7 @@ export const customEnduserFieldValidator = orValidator<{ [K in CustomEnduserFiel
     required: booleanValidatorOptional,
     hiddenFromProfile: booleanValidatorOptional,
     requireConfirmation: booleanValidatorOptional,
+    tags: listOfStringsValidatorOptionalOrEmptyOk,
   }), 
 })
 export const customEnduserFieldsValidatorOptionalOrEmpty = listValidatorOptionalOrEmptyOk(customEnduserFieldValidator)
@@ -4537,6 +4588,7 @@ export const automationTriggerEventValidator = orValidator<{ [K in AutomationTri
     info: objectValidator<AutomationTriggerEvents['Purchase Made']['info']>({
       titles: listOfStringsValidatorOptionalOrEmptyOk,
       productIds: listOfMongoIdStringValidatorOptionalOrEmptyOk,
+      titlePartialMatches: listOfStringsValidatorOptionalOrEmptyOk,
     }),
     conditions: optionalEmptyObjectValidator,
   }), 
@@ -4612,6 +4664,7 @@ export const automationTriggerEventValidator = orValidator<{ [K in AutomationTri
     type: exactMatchValidator(['Appointment Rescheduled']),
     info: objectValidator<AutomationTriggerEvents['Appointment Rescheduled']['info']>({
       titles: listOfStringsValidatorOptionalOrEmptyOk,
+      detectManualReschedules: booleanValidatorOptional,
     }),
     conditions: optionalEmptyObjectValidator,
   }), 
@@ -5415,6 +5468,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 }),
@@ -5753,6 +5807,56 @@ export const analyticsQueryValidator = orValidator<{ [K in AnalyticsQueryType]:
       key: exactMatchValidator<AnalyticsQueryRangeKeyForType['Orders']>(['Created At', 'Updated At']),
     }, { isOptional: true, emptyOk: true })
   }),
+  "Chat Rooms": objectValidator<AnalyticsQueryForType['Chat Rooms']>({
+    resource: exactMatchValidator<'Chat Rooms'>(['Chat Rooms']),
+    filter: objectValidator<AnalyticsQueryFilterForType['Chat Rooms']>({
+    }, { isOptional: true, emptyOk: true }),
+    info: orValidator<{ [K in keyof AnalyticsQueryInfoForType['Chat Rooms']]: AnalyticsQueryInfoForType['Chat Rooms'][K] }>({
+      "Total": objectValidator<AnalyticsQueryInfoForType['Chat Rooms']['Total']>({
+        method: exactMatchValidator<"Total">(['Total']),
+        parameters: optionalEmptyObjectValidator,
+      }),
+    }),
+    grouping: objectValidator<AnalyticsQueryGroupingForType['Chat Rooms']>({
+      Enduser: booleanValidatorOptional,
+      Gender: booleanValidatorOptional,
+      "Assigned To": booleanValidatorOptional,
+      Field: stringValidatorOptionalEmptyOkay,
+      Tags: booleanValidatorOptional,
+      Age: booleanValidatorOptional,
+      State: booleanValidatorOptional,
+      Phone: booleanValidatorOptional,
+    }, { isOptional: true, emptyOk: true }),
+    range: objectValidator<AnalyticsQueryRange<any>>({
+      interval: exactMatchValidator<AnalyticsQueryRangeInterval>(['Daily', 'Weekly', 'Monthly', 'Hourly']),
+      key: exactMatchValidator<AnalyticsQueryRangeKeyForType['Chat Rooms']>(['Created At', 'Updated At']),
+    }, { isOptional: true, emptyOk: true })
+  }),
+  "Chats": objectValidator<AnalyticsQueryForType['Chats']>({
+    resource: exactMatchValidator<'Chats'>(['Chats']),
+    filter: objectValidator<AnalyticsQueryFilterForType['Chats']>({
+    }, { isOptional: true, emptyOk: true }),
+    info: orValidator<{ [K in keyof AnalyticsQueryInfoForType['Chats']]: AnalyticsQueryInfoForType['Chats'][K] }>({
+      "Total": objectValidator<AnalyticsQueryInfoForType['Chats']['Total']>({
+        method: exactMatchValidator<"Total">(['Total']),
+        parameters: optionalEmptyObjectValidator,
+      }),
+    }),
+    grouping: objectValidator<AnalyticsQueryGroupingForType['Chats']>({
+      Enduser: booleanValidatorOptional,
+      Gender: booleanValidatorOptional,
+      "Assigned To": booleanValidatorOptional,
+      Field: stringValidatorOptionalEmptyOkay,
+      Tags: booleanValidatorOptional,
+      Age: booleanValidatorOptional,
+      State: booleanValidatorOptional,
+      Phone: booleanValidatorOptional,
+    }, { isOptional: true, emptyOk: true }),
+    range: objectValidator<AnalyticsQueryRange<any>>({
+      interval: exactMatchValidator<AnalyticsQueryRangeInterval>(['Daily', 'Weekly', 'Monthly', 'Hourly']),
+      key: exactMatchValidator<AnalyticsQueryRangeKeyForType['Chats']>(['Created At', 'Updated At']),
+    }, { isOptional: true, emptyOk: true })
+  }),
 })
 export const analyticsQueriesValidatorOptional = listValidatorOptionalOrEmptyOk(analyticsQueryValidator)
 
@@ -5777,6 +5881,8 @@ const _ANALYTICS_QUERY_TYPES: { [K in AnalyticsQueryType]: any } = {
   Meetings: true,
   "Journey Logs": true,
   Orders: true,
+  "Chat Rooms": true,
+  "Chats": true,
 }
 export const ANALYTICS_QUERY_TYPES = Object.keys(_ANALYTICS_QUERY_TYPES) as AnalyticsQueryType[]
 export const analyticsQueryTypeValidator = exactMatchValidator<AnalyticsQueryType>(ANALYTICS_QUERY_TYPES)
@@ -5810,6 +5916,7 @@ export const userUIRestrictionsValidator = objectValidator<UserUIRestrictions>({
   hideMergeEndusers: booleanValidatorOptional,
   hideQueuedTicketsViewer: booleanValidatorOptional,
   hideIncomingFaxesIcon: booleanValidatorOptional,
+  hideNotificationsIcon: booleanValidatorOptional,
   hideBulkEnduserActions: booleanValidatorOptional,
   visibleIntegrations: listOfStringsValidatorUniqueOptionalOrEmptyOkay,
 }, { emptyOk: true })