Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Node<Graph.Appointment>
    • Appointment

Index

Properties

appointmentServices

appointmentServices: AppointmentService[]

A collection of appointment services.

calendarLinks

calendarLinks: CalendarLinks

Calendar links for the appointment

cancellable

cancellable: boolean

Whether or not the client can cancel this appointment

cancellation

Information about the cancellation, if present

cancelled

cancelled: boolean

Boolean signifying if the appointment is cancelled or not

clientDuration

clientDuration: number

The duration of the appointment for the client

confirmable

confirmable: boolean

Whether or not the client can confirm this appointment at this time

createdAt

createdAt: any

When the appointment was created (in Etc/UTC)

duration

duration: number

The duration of the appointment

endAt

endAt: any

End time for the appointment

id

id: string

The ID of an object

isGroup

isGroup: boolean

Whether or not the appointment is a group appointment

isRecurring

isRecurring: boolean

Whether or not the appointment is recurring

notes

notes: string

Internal notes on the appointment

reschedulable

reschedulable: boolean

Whether or not the client can reschedule this appointment

startAt

startAt: any

Start time for the appointment

state

The state of the appointment.

Methods

Protected cancel

  • Cancel an Appointment.

    async

    Parameters

    • Optional notes: string

    Returns Promise<Appointment>

    Promise containing the updated Appointment

getClient

  • getClient(): Promise<Client>
  • Fetch the Client for this appointment.

    async

    Returns Promise<Client>

    Promise containing the Client

getLocation

  • Fetch the Location for this appointment.

    async

    Returns Promise<Location>

    Promise containing the Client

Protected reschedule

  • Reschedule the provided appointment to a new date and time.

    async

    Parameters

    • bookableTime: CartBookableTime

      The encoded data representing an available appointment slot (can be computed using rescheduleAvailableTimes())

    • sendNotification: boolean

      Creates a notification for the dashboard users to let them know that the appointment has been self-rescheduled by the client.

    Returns Promise<Appointment>

    Promise containing the updated Appointment

Protected rescheduleAvailableDates

  • Get the available dates for the provided appointment.

    async

    Parameters

    • searchRangeLower: any

      The lower range (inclusive) of dates to search for appointment availability.

    • searchRangeUpper: any

      The upper range (inclusive) of dates to search for appointment availability.

    Returns Promise<AvailableRescheduleDate[]>

    Promise containing a list of AvailableRescheduleDate

Protected rescheduleAvailableTimes

  • Get the available appointment times on a particular date for the provided appointment.

    async
    todo

    Timezone support

    Parameters

    • date: any

      The date that should be searched for available times.

    Returns Promise<AvailableRescheduleTime[]>

    Promise containing a list of AvailableRescheduleTime

Generated using TypeDoc