Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace SchedulingTypes

Index

Type aliases

NewNylasBooking: { configurationId: string; emailAddress?: string; formId: number; name?: string; schedulingCancelUrl: string; schedulingRescheduleUrl: string; submissionId: string }

Type declaration

  • configurationId: string
  • Optional emailAddress?: string
  • formId: number
  • Optional name?: string
  • schedulingCancelUrl: string
  • schedulingRescheduleUrl: string
  • submissionId: string
NewSchedulingBooking: { formId: number; nylasSchedulingPageId: number; schedulingCancelUrl: string; schedulingReceiptUrl: string; submissionId: string }

Type declaration

  • formId: number
  • nylasSchedulingPageId: number
  • schedulingCancelUrl: string
  • schedulingReceiptUrl: string
  • submissionId: string
NylasBooking: NewNylasBooking & { createdAt: string; updatedAt: string } & ({ bookingRef?: undefined } | { bookingId: string; bookingRef: string; calendarId: string; cancelledReason?: string; endTime: number; grantId: string; location?: string; previousEndTime?: number; previousStartTime?: number; proposedEventId: string; startTime: number; timezone: string })
NylasSchedulingConfiguration: { appearance: {}; availability: { availability_rules: { availability_method: "collective" | "max-fairness" | "max-availability"; buffer: { after: number; before: number }; default_open_hours: { days: number[]; end: string; exdates: string[]; start: string }[] }; duration_minutes: number; interval_minutes: number; round_to: number }; event_booking: { booking_type: "booking" | "organizer-confirmation"; conferencing: { autocreate: unknown; provider: "Google Meet" | "Zoom Meeting" | "Microsoft Teams" } | { details: { phone: string[]; pin: string; url: string }; provider: "Google Meet" } | { details: { meeting_code: string; password: string; url: string }; provider: "Zoom Meeting" } | { details: { url: string }; provider: "Microsoft Teams" }; description: string; disable_emails: boolean; location: string; reminders: { email_subject: string; minutes_before_event: number; recipient: "host" | "guest" | "all"; type: "email" | "webhook" }[]; timezone: string; title: string }; id: string; name: string; participants: { availability: { calendar_ids: string[]; open_hours: { days: number[]; end: string; exdates: string[]; start: string }[] }; booking: { calendar_id: string }; email: string; is_organizer: boolean; name: string; timezone: string }[]; requires_session_auth: boolean; scheduler: { additional_fields: {}; available_days_in_future: number; cancellation_policy: string; cancellation_url: string; confirmation_redirect_url: string; email_template: { booking_confirmed: { body: string; title: string }; logo: string }; hide_additional_guests: boolean; hide_cancellation_options: boolean; hide_rescheduling_options: boolean; min_booking_notice: number; min_cancellation_notice: number; organizer_confirmation_url: string; rescheduling_url: string }; slug: string }

Type declaration

  • appearance: {}
    • [key: string]: string
  • availability: { availability_rules: { availability_method: "collective" | "max-fairness" | "max-availability"; buffer: { after: number; before: number }; default_open_hours: { days: number[]; end: string; exdates: string[]; start: string }[] }; duration_minutes: number; interval_minutes: number; round_to: number }
    • availability_rules: { availability_method: "collective" | "max-fairness" | "max-availability"; buffer: { after: number; before: number }; default_open_hours: { days: number[]; end: string; exdates: string[]; start: string }[] }
      • availability_method: "collective" | "max-fairness" | "max-availability"
      • buffer: { after: number; before: number }
        • after: number
        • before: number
      • default_open_hours: { days: number[]; end: string; exdates: string[]; start: string }[]
    • duration_minutes: number
    • interval_minutes: number
    • round_to: number
  • event_booking: { booking_type: "booking" | "organizer-confirmation"; conferencing: { autocreate: unknown; provider: "Google Meet" | "Zoom Meeting" | "Microsoft Teams" } | { details: { phone: string[]; pin: string; url: string }; provider: "Google Meet" } | { details: { meeting_code: string; password: string; url: string }; provider: "Zoom Meeting" } | { details: { url: string }; provider: "Microsoft Teams" }; description: string; disable_emails: boolean; location: string; reminders: { email_subject: string; minutes_before_event: number; recipient: "host" | "guest" | "all"; type: "email" | "webhook" }[]; timezone: string; title: string }
    • booking_type: "booking" | "organizer-confirmation"
    • conferencing: { autocreate: unknown; provider: "Google Meet" | "Zoom Meeting" | "Microsoft Teams" } | { details: { phone: string[]; pin: string; url: string }; provider: "Google Meet" } | { details: { meeting_code: string; password: string; url: string }; provider: "Zoom Meeting" } | { details: { url: string }; provider: "Microsoft Teams" }
    • description: string
    • disable_emails: boolean
    • location: string
    • reminders: { email_subject: string; minutes_before_event: number; recipient: "host" | "guest" | "all"; type: "email" | "webhook" }[]
    • timezone: string
    • title: string
  • id: string
  • name: string
  • participants: { availability: { calendar_ids: string[]; open_hours: { days: number[]; end: string; exdates: string[]; start: string }[] }; booking: { calendar_id: string }; email: string; is_organizer: boolean; name: string; timezone: string }[]
  • requires_session_auth: boolean
  • scheduler: { additional_fields: {}; available_days_in_future: number; cancellation_policy: string; cancellation_url: string; confirmation_redirect_url: string; email_template: { booking_confirmed: { body: string; title: string }; logo: string }; hide_additional_guests: boolean; hide_cancellation_options: boolean; hide_rescheduling_options: boolean; min_booking_notice: number; min_cancellation_notice: number; organizer_confirmation_url: string; rescheduling_url: string }
    • additional_fields: {}
      • [key: string]: { label: string; options: string[]; order: number; pattern: string; required: boolean; type: string }
        • label: string
        • options: string[]
        • order: number
        • pattern: string
        • required: boolean
        • type: string
    • available_days_in_future: number
    • cancellation_policy: string
    • cancellation_url: string
    • confirmation_redirect_url: string
    • email_template: { booking_confirmed: { body: string; title: string }; logo: string }
      • booking_confirmed: { body: string; title: string }
        • body: string
        • title: string
      • logo: string
    • hide_additional_guests: boolean
    • hide_cancellation_options: boolean
    • hide_rescheduling_options: boolean
    • min_booking_notice: number
    • min_cancellation_notice: number
    • organizer_confirmation_url: string
    • rescheduling_url: string
  • slug: string
SchedulingBooking: NewSchedulingBooking & { cancelledReason?: string; createdAt?: string; emailAddress?: string; endTime?: number; location?: string; name?: string; nylasCalendarId?: string; nylasEditHash?: string; nylasProposedEventId?: string; previousEndTime?: number; previousStartTime?: number; startTime?: number; timezone?: string; updatedAt?: string }