@tellescope/schema 1.4.46 → 1.4.49

package/lib/esm/schema.js

@@ -10,7 +10,7 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 import { WEBHOOK_MODELS, } from "@tellescope/types-models";
-import { booleanValidator, dateValidator, emailValidator, fieldsValidator, journeysValidator, journeyStatesValidator, phoneValidator, nameValidator, nonNegNumberValidator, mongoIdValidator, mongoIdStringRequired as mongoIdStringValidator, listOfMongoIdStringValidator, preferenceValidator, objectAnyFieldsAnyValuesValidator, stringValidator, stringValidator100, listOfStringsValidator, emailEncodingValidator, numberToDateValidator, SMSMessageValidator, chatRoomTypeValidator, idStringToDateValidator, subdomainValidator, messageTemplateTypeValidator, stringValidator250, stringValidator5000, listOfDisplayNameInfo, fileTypeValidator, fileSizeValidator, meetingStatusValidator, listOfAttendeesValidator, meetingInfoValidator, listOfUserIndentitiesValidator, meetingsListValidator, urlValidator, WebhookSubscriptionValidator, attendeeValidator, meetingDisplayInfoValidator, intakePhoneValidator, formResponsesValidator, stringValidator25000, automationActionValidator, automationEventValidator, automatedActionStatusValidator, listOfStringsValidatorEmptyOk, listOfChatAttachmentsValidator, listOfCalendarEventRemindersValidator, messageTemplateModeValidator, listOfAutomationConditionsValidator, chatRoomUserInfoValidator, CUDStringValidator, listOfRelatedRecordsValidator, cancelConditionsValidator, notificationPreferencesValidator, FHIRObservationCategoryValidator, FHIRObservationStatusCodeValidator, FHIRObservationValueValidator, userIdentityValidator, formFieldTypeValidator, previousFormFieldsValidator, numberValidator, organizationThemeValidator, managedContentRecordTypeValidator, passwordValidator, flowchartUIValidator, integrationAuthenticationsValidator, listOfMongoIdStringValidatorEmptyOk, formFieldOptionsValidator, blocksValidator, sessionTypeValidator, portalSettingsValidator, emailValidatorEmptyOkay, phoneValidatorOptional, stringValidator1000, databaseFieldsValidator, databaseRecordValuesValidator, automationEventsValidator, portalPageValidator, portalBlocksValidator, enduserFormResponsesForEventValidator, enduserTasksForEventValidator, stateCredentialsValidator, stateValidator, availabilityBlocksValidator, weeklyAvailabilitiesValidator, timezoneValidator, formTypeValidator, managedContentRecordAssignmentTypeValidator, listOfGenericAttachmentsValidator, accessPermissionsValidator, organizationLimitsValidator, organizationSettingsValidator, communicationsChannelValidator, genericUnitWithQuantityValidator, stringValidator25000EmptyOkay, slugValidator, stringValidator5000EmptyOkay, loginFlowResultValidator, sharedWithOrganizationIdsValidator, stringValidator1000Optional, tellescopeGenderValidator, } from "@tellescope/validation";
+import { booleanValidator, dateValidator, emailValidator, fieldsValidator, journeysValidator, journeyStatesValidator, phoneValidator, nameValidator, nonNegNumberValidator, mongoIdValidator, mongoIdStringRequired as mongoIdStringValidator, listOfMongoIdStringValidator, preferenceValidator, objectAnyFieldsAnyValuesValidator, stringValidator, stringValidator100, listOfStringsValidator, emailEncodingValidator, numberToDateValidator, SMSMessageValidator, chatRoomTypeValidator, idStringToDateValidator, subdomainValidator, messageTemplateTypeValidator, stringValidator250, stringValidator5000, listOfDisplayNameInfo, fileTypeValidator, fileSizeValidator, meetingStatusValidator, listOfAttendeesValidator, meetingInfoValidator, listOfUserIndentitiesValidator, meetingsListValidator, urlValidator, WebhookSubscriptionValidator, attendeeValidator, meetingDisplayInfoValidator, intakePhoneValidator, formResponsesValidator, stringValidator25000, automationActionValidator, automationEventValidator, automatedActionStatusValidator, listOfStringsValidatorEmptyOk, listOfChatAttachmentsValidator, listOfCalendarEventRemindersValidator, messageTemplateModeValidator, listOfAutomationConditionsValidator, chatRoomUserInfoValidator, CUDStringValidator, listOfRelatedRecordsValidator, cancelConditionsValidator, notificationPreferencesValidator, FHIRObservationCategoryValidator, FHIRObservationStatusCodeValidator, FHIRObservationValueValidator, userIdentityValidator, formFieldTypeValidator, previousFormFieldsValidator, numberValidator, organizationThemeValidator, managedContentRecordTypeValidator, passwordValidator, flowchartUIValidator, integrationAuthenticationsValidator, listOfMongoIdStringValidatorEmptyOk, formFieldOptionsValidator, blocksValidator, sessionTypeValidator, portalSettingsValidator, emailValidatorEmptyOkay, phoneValidatorOptional, stringValidator1000, databaseFieldsValidator, databaseRecordValuesValidator, automationEventsValidator, portalPageValidator, portalBlocksValidator, enduserFormResponsesForEventValidator, enduserTasksForEventValidator, stateCredentialsValidator, stateValidator, availabilityBlocksValidator, weeklyAvailabilitiesValidator, timezoneValidator, formTypeValidator, managedContentRecordAssignmentTypeValidator, listOfGenericAttachmentsValidator, accessPermissionsValidator, organizationLimitsValidator, organizationSettingsValidator, communicationsChannelValidator, genericUnitWithQuantityValidator, stringValidator25000EmptyOkay, slugValidator, stringValidator5000EmptyOkay, loginFlowResultValidator, sharedWithOrganizationIdsValidator, stringValidator1000Optional, tellescopeGenderValidator, appointmentTermsValidator, paymentProcessorValidator, purchaseCreditValueValidator, costValidator, integrationTitleValidator, } from "@tellescope/validation";
 import { CREATOR_ONLY_ACCESS, DEFAULT_OPERATIONS, PLACEHOLDER_ID, ENDUSER_SESSION_TYPE, USER_SESSION_TYPE, } from "@tellescope/constants";
 var sideEffects = {
     handleJourneyStateChange: {
@@ -460,21 +460,32 @@ export var schema = build_schema({
                 op: 'custom', access: 'create', method: 'post',
                 path: '/generate-google-auth-url',
                 name: 'Generates a link to create a Google integration with Tellescope',
+                description: "", parameters: {},
+                returns: { authUrl: { validator: stringValidator, required: true }, }
+            },
+            disconnect_google_integration: {
+                op: 'custom', access: 'create', method: 'post',
+                path: '/generate-square-auth-url',
+                name: 'Generates a link to create a Square integration with Tellescope',
+                description: "", parameters: {},
+                returns: { authUrl: { validator: stringValidator, required: true }, }
+            },
+            generate_oauth2_auth_url: {
+                op: 'custom', access: 'delete', method: 'post',
+                path: '/generate-oauth2-auth-url',
                 description: "",
-                parameters: {},
+                parameters: { integration: { validator: integrationTitleValidator, } },
                 returns: {
-                    authUrl: {
-                        validator: stringValidator,
-                        required: true
-                    },
+                    authUrl: { validator: stringValidator, required: true },
+                    state: { validator: stringValidator, required: true },
                 }
             },
-            disconnect_google_integration: {
+            disconnect_oauth2_integration: {
                 op: 'custom', access: 'delete', method: 'post',
-                path: '/disconnect-google-integration',
-                name: 'Disconnects an integration with Google',
-                description: "",
-                parameters: {},
+                path: '/disconnect-oauth2-integration',
+                name: 'Disconnects an integration with Square',
+                refresh_oauth2_sessiondescription: "",
+                parameters: { integration: { validator: integrationTitleValidator } },
                 returns: {}
             },
             refresh_oauth2_session: {
@@ -1119,6 +1130,8 @@ export var schema = build_schema({
             }, fields: {
                 validator: fieldsValidator,
                 redactions: ['enduser'],
+            }, unredactedFields: {
+                validator: fieldsValidator,
             }, username: {
                 validator: subdomainValidator,
                 readonly: true,
@@ -1806,9 +1819,11 @@ export var schema = build_schema({
                 parameters: {
                     calendarEventTemplateId: { validator: mongoIdStringValidator, required: true },
                     from: { validator: dateValidator, required: true },
+                    locationId: { validator: mongoIdStringValidator },
                     restrictedByState: { validator: booleanValidator },
                     to: { validator: dateValidator },
                     limit: { validator: nonNegNumberValidator },
+                    businessId: { validator: mongoIdStringValidator }, // required for unauthenticated access
                 },
                 returns: {
                     availabilityBlocks: { validator: availabilityBlocksValidator, required: true }
@@ -1823,13 +1838,51 @@ export var schema = build_schema({
                     calendarEventTemplateId: { validator: mongoIdStringValidator, required: true },
                     userId: { validator: mongoIdStringValidator, required: true },
                     startTime: { validator: dateValidator, required: true },
+                    locationId: { validator: mongoIdStringValidator },
+                    agreedToTerms: { validator: appointmentTermsValidator },
                 },
                 returns: {
                     createdEvent: { validator: 'calenar_event' },
                 },
             },
         },
-        enduserActions: { read: {}, readMany: {}, get_appointment_availability: {}, book_appointment: {} },
+        publicActions: {
+            session_for_public_appointment_booking: {
+                op: "custom", access: 'create', method: "post",
+                path: '/session-for-public-appointment-booking',
+                name: 'Generate Session for Public Appointment Booking',
+                description: "Generates a session for booking an appointment",
+                parameters: {
+                    email: { validator: emailValidator, required: true },
+                    calendarEventTemplateId: { validator: mongoIdStringValidator, required: true },
+                    businessId: { validator: mongoIdStringValidator, required: true },
+                    dateOfBirth: { validator: stringValidator },
+                    phone: { validator: phoneValidator },
+                    fname: { validator: nameValidator },
+                    lname: { validator: nameValidator },
+                },
+                returns: {
+                    authToken: { validator: stringValidator250, required: true },
+                },
+            },
+            details_for_appointment_booking_page: {
+                op: "custom", access: 'read', method: "get",
+                path: '/details-for-appointment-booking-page',
+                name: 'Gets Appointment Booking Details',
+                description: "Gets details related to booking an appointment",
+                parameters: {
+                    appointmentBookingPageId: { validator: mongoIdStringValidator, required: true },
+                    businessId: { validator: mongoIdStringValidator, required: true }, // organizationIds can be pulled from the corresponding appointment
+                },
+                returns: {
+                    appointmentBookingPage: { validator: 'appointment_booking_page', required: true },
+                    calendarEventTemplates: { validator: 'calendar_event_templates', required: true },
+                    locations: { validator: 'appointment_locations', required: true },
+                    products: { validator: 'products', required: true },
+                },
+            }
+        },
+        enduserActions: { read: {}, readMany: {}, get_appointment_availability: {}, book_appointment: {}, session_for_public_appointment_booking: {} },
         fields: __assign(__assign({}, BuiltInFields), { title: {
                 validator: stringValidator250,
                 required: true,
@@ -1842,7 +1895,7 @@ export var schema = build_schema({
                 validator: nonNegNumberValidator,
                 examples: [100],
                 required: true,
-            }, type: { validator: stringValidator100 }, description: { validator: stringValidator5000 }, meetingId: { validator: mongoIdStringValidator, readonly: true }, meetingStatus: { validator: meetingStatusValidator }, attachments: { validator: listOfGenericAttachmentsValidator }, chatRoomId: {
+            }, locationId: { validator: mongoIdStringValidator }, type: { validator: stringValidator100 }, description: { validator: stringValidator5000 }, agreedToTerms: { validator: appointmentTermsValidator }, meetingId: { validator: mongoIdStringValidator, readonly: true }, meetingStatus: { validator: meetingStatusValidator }, attachments: { validator: listOfGenericAttachmentsValidator }, chatRoomId: {
                 validator: mongoIdStringValidator,
                 dependencies: [{
                         dependsOn: ['chat_rooms'],
@@ -1892,7 +1945,7 @@ export var schema = build_schema({
                 validator: nonNegNumberValidator,
                 examples: [100],
                 required: true,
-            }, type: { validator: stringValidator100 }, description: { validator: stringValidator5000 }, reminders: {
+            }, productIds: { validator: listOfMongoIdStringValidatorEmptyOk }, type: { validator: stringValidator100 }, description: { validator: stringValidator5000 }, reminders: {
                 validator: listOfCalendarEventRemindersValidator,
                 initializer: function () { return []; },
             }, publicRead: { validator: booleanValidator }, enableVideoCall: { validator: booleanValidator }, enableSelfScheduling: { validator: booleanValidator }, restrictedByState: { validator: booleanValidator }, image: { validator: stringValidator5000 } })
@@ -2548,10 +2601,10 @@ export var schema = build_schema({
                 validator: slugValidator,
                 required: true,
                 examples: ["subdomain"],
-            }, parentOrganizationId: { validator: mongoIdStringValidator }, subscriptionExpiresAt: { validator: dateValidator }, subscriptionPeriod: { validator: numberValidator }, logoVersion: { validator: numberValidator }, faviconVersion: { validator: numberValidator }, roles: { validator: listOfStringsValidatorEmptyOk }, skills: { validator: listOfStringsValidator }, themeColor: { validator: stringValidator100 }, themeColorSecondary: { validator: stringValidator100 }, enduserDisplayName: { validator: stringValidator100 }, customPortalURL: { validator: stringValidator250 }, portalSettings: { validator: portalSettingsValidator }, settings: { validator: organizationSettingsValidator }, limits: {
+            }, limits: {
                 validator: organizationLimitsValidator,
                 readonly: true, // to be set by Tellescope super admin only
-            } }),
+            }, parentOrganizationId: { validator: mongoIdStringValidator }, subscriptionExpiresAt: { validator: dateValidator }, subscriptionPeriod: { validator: numberValidator }, logoVersion: { validator: numberValidator }, faviconVersion: { validator: numberValidator }, roles: { validator: listOfStringsValidatorEmptyOk }, skills: { validator: listOfStringsValidator }, themeColor: { validator: stringValidator100 }, themeColorSecondary: { validator: stringValidator100 }, enduserDisplayName: { validator: stringValidator100 }, customPortalURL: { validator: stringValidator250 }, portalSettings: { validator: portalSettingsValidator }, settings: { validator: organizationSettingsValidator }, timezone: { validator: timezoneValidator } }),
     },
     databases: {
         info: {},
@@ -2725,6 +2778,136 @@ export var schema = build_schema({
                 ]
             } })
     },
+    appointment_booking_pages: {
+        info: {},
+        constraints: {
+            unique: ['title'],
+            relationship: [],
+        },
+        defaultActions: DEFAULT_OPERATIONS,
+        customActions: {},
+        enduserActions: {},
+        fields: __assign(__assign({}, BuiltInFields), { title: {
+                validator: stringValidator100,
+                required: true,
+                examples: ["Appointment Booking Title"]
+            }, calendarEventTemplateIds: {
+                validator: listOfMongoIdStringValidator,
+                required: true,
+                examples: [[PLACEHOLDER_ID]]
+            }, locationIds: {
+                validator: listOfMongoIdStringValidatorEmptyOk,
+                required: true,
+                examples: [[PLACEHOLDER_ID]]
+            }, terms: { validator: appointmentTermsValidator }, endDate: { validator: dateValidator }, startDate: { validator: dateValidator }, backgroundColor: { validator: stringValidator100 }, primaryColor: { validator: stringValidator100 }, secondaryColor: { validator: stringValidator100 }, intakeTitle: { validator: stringValidator1000 }, intakeDescription: { validator: stringValidator1000 }, thankYouTitle: { validator: stringValidator1000 }, thankYouDescription: { validator: stringValidator1000 }, thankYouHeaderImageURL: { validator: stringValidator1000 }, thankYouMainImageURL: { validator: stringValidator1000 } })
+    },
+    appointment_locations: {
+        info: {},
+        constraints: {
+            unique: ['title'],
+            relationship: [],
+        },
+        defaultActions: DEFAULT_OPERATIONS,
+        customActions: {},
+        enduserActions: {},
+        fields: __assign(__assign({}, BuiltInFields), { title: {
+                validator: stringValidator100,
+                required: true,
+                examples: ["Appointment Booking Title"]
+            }, address: { validator: stringValidator1000 }, zipCode: { validator: stringValidator1000 }, phone: { validator: stringValidator }, state: { validator: stateValidator }, timezone: { validator: timezoneValidator } })
+    },
+    products: {
+        info: {},
+        constraints: {
+            unique: ['title'],
+            relationship: [],
+        },
+        defaultActions: DEFAULT_OPERATIONS,
+        customActions: {},
+        enduserActions: {},
+        fields: __assign(__assign({}, BuiltInFields), { title: {
+                validator: stringValidator100,
+                required: true,
+                examples: ["Product Title"]
+            }, cost: {
+                validator: costValidator,
+                required: true,
+                examples: [{ amount: 500, currency: 'USD' }],
+            }, processor: {
+                validator: paymentProcessorValidator,
+                required: true,
+                examples: ['Stripe'],
+            }, description: { validator: stringValidator5000EmptyOkay } })
+    },
+    purchases: {
+        info: {},
+        constraints: { unique: [], relationship: [] },
+        defaultActions: DEFAULT_OPERATIONS,
+        customActions: {},
+        enduserActions: {},
+        fields: __assign(__assign({}, BuiltInFields), { productId: {
+                validator: mongoIdStringValidator,
+                required: true,
+                examples: [PLACEHOLDER_ID],
+                dependencies: [{
+                        dependsOn: ['products'],
+                        dependencyField: '_id',
+                        relationship: 'foreignKey',
+                        onDependencyDelete: 'nop',
+                    }]
+            }, enduserId: {
+                validator: mongoIdStringValidator,
+                examples: [PLACEHOLDER_ID],
+                required: true,
+                dependencies: [{
+                        dependsOn: ['endusers'],
+                        dependencyField: '_id',
+                        relationship: 'foreignKey',
+                        onDependencyDelete: 'delete',
+                    }]
+            }, title: {
+                validator: stringValidator100,
+                required: true,
+                examples: ["Product Title"]
+            }, cost: {
+                validator: costValidator,
+                required: true,
+                examples: [{ amount: 500, currency: 'USD' }],
+            }, processor: {
+                validator: paymentProcessorValidator,
+                required: true,
+                examples: ['Stripe'],
+            }, description: { validator: stringValidator5000EmptyOkay } })
+    },
+    purchase_credits: {
+        info: {},
+        constraints: { unique: [], relationship: [], },
+        defaultActions: DEFAULT_OPERATIONS,
+        customActions: {},
+        enduserActions: {},
+        fields: __assign(__assign({}, BuiltInFields), { enduserId: {
+                validator: mongoIdStringValidator,
+                examples: [PLACEHOLDER_ID],
+                required: true,
+                dependencies: [{
+                        dependsOn: ['endusers'],
+                        dependencyField: '_id',
+                        relationship: 'foreignKey',
+                        onDependencyDelete: 'delete',
+                    }]
+            }, title: {
+                validator: stringValidator100,
+                required: true,
+                examples: ["Purchase Credit"]
+            }, value: {
+                validator: purchaseCreditValueValidator,
+                required: true,
+                examples: [{
+                        type: "Voucher",
+                        info: {},
+                    }]
+            }, usedAt: { validator: dateValidator, }, description: { validator: stringValidator5000EmptyOkay } })
+    },
 });
 // export type SchemaType = typeof schema
 // export type SchemaV1 = SchemaType// & Schema