@tellescope/schema 1.4.46 → 1.4.49

package/src/schema.ts

@@ -5,6 +5,7 @@ import {
   ObjectId,
   ModelName,
   User,
+  AppointmentBookingPage,
 } from "@tellescope/types-server"
 import {
   ErrorInfo,
@@ -33,9 +34,11 @@ import {
   AvailabilityBlock,
   WithLinkOpenTrackingIds,
   CommunicationsChannel,
+  AppointmentTerm,
 } from "@tellescope/types-models"
 
 import {
+  AppointmentBookingPage as AppointmentBookingPageClient,
   UserDisplayInfo,
   Enduser,
   Journey,
@@ -48,6 +51,9 @@ import {
   CalendarEvent,
   Organization,
   User as UserClient,
+  AppointmentLocation,
+  CalendarEventTemplate,
+  Product,
 } from "@tellescope/types-client"
 
 import {
@@ -156,6 +162,13 @@ import {
   sharedWithOrganizationIdsValidator,
   stringValidator1000Optional,
   tellescopeGenderValidator,
+  appointmentTermsValidator,
+  currencyValidator,
+  paymentProcessorValidator,
+  purchaseCreditValueValidator,
+  costValidator,
+  integrationTitleValidator,
+  IntegrationsTitleType,
 } from "@tellescope/validation"
 
 import {
@@ -468,6 +481,8 @@ export type CustomActions = {
   integrations: {
     generate_google_auth_url: CustomAction<{ }, { authUrl: string, }>, 
     disconnect_google_integration: CustomAction<{}, {}>,
+    generate_oauth2_auth_url: CustomAction<{ integration: IntegrationsTitleType }, { authUrl: string, }>, 
+    disconnect_oauth2_integration: CustomAction<{ integration: IntegrationsTitleType }, {}>,
     refresh_oauth2_session: CustomAction<{ title: string }, { access_token: string, expiry_date: number }>, 
   },
   emails: {
@@ -477,12 +492,14 @@ export type CustomActions = {
     get_events_for_user: CustomAction<{ userId: string, from: Date, to?: Date, limit?: number }, { events: CalendarEvent[] }>, 
     generate_meeting_link: CustomAction<{ eventId: string, enduserId: string }, { link: string }>, 
     get_appointment_availability: CustomAction<{ 
-      from: Date, calendarEventTemplateId: string, to?: Date, restrictedByState?: boolean, limit?: number,
+      from: Date, calendarEventTemplateId: string, to?: Date, restrictedByState?: boolean, limit?: number, locationId?: string,
+      businessId?: string, // for accessing while unauthenticated
     }, { 
       availabilityBlocks: AvailabilityBlock[],
     }>,
     book_appointment: CustomAction<{ 
-      userId: string, startTime: Date, calendarEventTemplateId: string,
+      userId: string, startTime: Date, calendarEventTemplateId: string, locationId?: string,
+      agreedToTerms?: AppointmentTerm[],
     }, { 
       createdEvent: CalendarEvent,
     }>,
@@ -526,6 +543,29 @@ export type PublicActions = {
       // organizationIds?: string[]
     }, { accessCode: string, authToken: string, url: string, path: string }>,
   },
+  calendar_events: {
+    session_for_public_appointment_booking: CustomAction<{ 
+      fname?: string, 
+      lname?: string, 
+      dateOfBirth?: string,
+      email: string, 
+      phone?: string, 
+      calendarEventTemplateId: string, 
+      businessId: string,
+    }, { authToken: string }>,
+    details_for_appointment_booking_page: CustomAction<
+      { 
+        appointmentBookingPageId: string, 
+        businessId: string,
+      }, 
+      { 
+        appointmentBookingPage: AppointmentBookingPageClient,
+        locations: AppointmentLocation[],
+        calendarEventTemplates: CalendarEventTemplate[],
+        products: Product[],
+      }
+    >,
+  },
 }
 
 export type SchemaV1 = Schema & { 
@@ -964,21 +1004,32 @@ export const schema: SchemaV1 = 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: {},
+        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: { 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: {
@@ -1705,6 +1756,9 @@ export const schema: SchemaV1 = build_schema({
         validator: fieldsValidator,
         redactions: ['enduser'],
       },
+      unredactedFields: {
+        validator: fieldsValidator,
+      },
       username: {
         validator: subdomainValidator,
         readonly: true, // able to set once, then not change (for now, due to email configuration)
@@ -2536,9 +2590,11 @@ export const schema: SchemaV1 = 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 }
@@ -2553,13 +2609,52 @@ export const schema: SchemaV1 = 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' as any },
         },
       },
     },
-    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 }, // organizationIds can be pulled from the corresponding appointment
+          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' as any, required: true },
+          calendarEventTemplates: { validator: 'calendar_event_templates' as any, required: true },
+          locations: { validator: 'appointment_locations' as any, required: true },
+          products: { validator: 'products' as any, required: true },
+          
+        },
+      }
+    },
+    enduserActions: { read: {}, readMany: {}, get_appointment_availability: {}, book_appointment: {}, session_for_public_appointment_booking: {} },
     fields: {
       ...BuiltInFields, 
       title: {
@@ -2577,8 +2672,10 @@ export const schema: SchemaV1 = build_schema({
         examples: [100],
         required: true,
       },
+      locationId: { validator: mongoIdStringValidator },
       type: { validator: stringValidator100 },
       description: { validator: stringValidator5000 },
+      agreedToTerms: { validator: appointmentTermsValidator },
       meetingId: { validator: mongoIdStringValidator, readonly: true },
       meetingStatus: { validator: meetingStatusValidator },
       attachments: { validator: listOfGenericAttachmentsValidator },
@@ -2654,6 +2751,7 @@ export const schema: SchemaV1 = build_schema({
         examples: [100],
         required: true,
       },
+      productIds: { validator: listOfMongoIdStringValidatorEmptyOk },
       type: { validator: stringValidator100 },
       description: { validator: stringValidator5000 },
       reminders: {
@@ -2665,6 +2763,7 @@ export const schema: SchemaV1 = build_schema({
       enableSelfScheduling: { validator: booleanValidator }, 
       restrictedByState: { validator: booleanValidator }, 
       image: { validator: stringValidator5000 },
+      // confirmationSenderId: { validator: mongoIdStringValidator },
     }
   },
   calendar_event_RSVPs: {
@@ -3432,6 +3531,10 @@ export const schema: SchemaV1 = build_schema({
         required: true,
         examples: ["subdomain"],
       },
+      limits: { 
+        validator: organizationLimitsValidator,
+        readonly: true, // to be set by Tellescope super admin only
+      },
       parentOrganizationId: { validator: mongoIdStringValidator },
       subscriptionExpiresAt: { validator: dateValidator },
       subscriptionPeriod: { validator: numberValidator },
@@ -3445,10 +3548,7 @@ export const schema: SchemaV1 = build_schema({
       customPortalURL: { validator: stringValidator250 },
       portalSettings: { validator: portalSettingsValidator },
       settings: { validator: organizationSettingsValidator },
-      limits: { 
-        validator: organizationLimitsValidator,
-        readonly: true, // to be set by Tellescope super admin only
-      },
+      timezone: { validator: timezoneValidator },
     },
   },
   databases: {
@@ -3656,6 +3756,182 @@ export const schema: SchemaV1 = build_schema({
       }
     }
   },
+  appointment_booking_pages: {
+    info: {},
+    constraints: {
+      unique: ['title'], 
+      relationship: [],
+    },
+    defaultActions: DEFAULT_OPERATIONS,
+    customActions: {},
+    enduserActions: {},
+    fields: {
+      ...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: {
+      ...BuiltInFields, 
+      title: {
+        validator: stringValidator100,
+        required: true,
+        examples: ["Appointment Booking Title"]
+      },
+      address: { validator: stringValidator1000 },
+      zipCode: { validator: stringValidator1000 },
+      phone: { validator: stringValidator }, // phoneValidator assumes cell phone and strips formatting, this should not
+      state: { validator: stateValidator },
+      timezone: { validator: timezoneValidator },
+    }
+  },
+  products: {
+    info: {},
+    constraints: {
+      unique: ['title'], 
+      relationship: [],
+    },
+    defaultActions: DEFAULT_OPERATIONS,
+    customActions: {},
+    enduserActions: {},
+    fields: {
+      ...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: {
+      ...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: {
+      ...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