urembo-hub-api
Preparing search index...
appointments/appointments.controller
AppointmentsController
Class AppointmentsController
Index
Constructors
constructor
Methods
create
Appointment
delete
Appointment
get
All
Appointments
get
Appointment
By
Id
get
Appointments
By
Client
Id
get
Appointments
By
Date
Range
get
Appointments
By
Staff
Id
get
Appointments
By
Status
get
Appointments
By
Vendor
Id
get
Appointment
Stats
get
My
Appointments
get
My
Appointment
Stats
get
My
Upcoming
Appointments
get
Upcoming
Appointments
update
Appointment
update
Appointment
Status
Constructors
constructor
new
AppointmentsController
(
appointmentsService
:
AppointmentsService
,
)
:
AppointmentsController
Parameters
appointmentsService
:
AppointmentsService
Returns
AppointmentsController
Methods
create
Appointment
createAppointment
(
createAppointmentDto
:
CreateAppointmentDto
,
)
:
Promise
<
{
client
:
{
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
}
;
service
:
{
category
:
string
;
durationMinutes
:
number
;
id
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
,
>
Parameters
createAppointmentDto
:
CreateAppointmentDto
Returns
Promise
<
{
client
:
{
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
}
;
service
:
{
category
:
string
;
durationMinutes
:
number
;
id
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
,
>
delete
Appointment
deleteAppointment
(
id
:
string
,
)
:
Promise
<
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
,
>
Parameters
id
:
string
Returns
Promise
<
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
,
>
get
All
Appointments
getAllAppointments
(
limit
?:
string
,
)
:
Promise
<
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
[]
,
>
Parameters
Optional
limit
:
string
Returns
Promise
<
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
[]
,
>
get
Appointment
By
Id
getAppointmentById
(
id
:
string
,
)
:
Promise
<
{
client
:
{
avatarUrl
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
service
:
{
category
:
string
;
description
:
string
;
durationMinutes
:
number
;
id
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
serviceReviews
:
{
createdAt
:
Date
;
id
:
string
;
rating
:
number
;
reviewText
:
string
;
}
[]
;
tickets
:
{
createdAt
:
Date
;
id
:
string
;
priority
:
string
;
status
:
string
;
title
:
string
;
}
[]
;
vendor
:
{
avatarUrl
:
string
;
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
,
>
Parameters
id
:
string
Returns
Promise
<
{
client
:
{
avatarUrl
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
service
:
{
category
:
string
;
description
:
string
;
durationMinutes
:
number
;
id
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
serviceReviews
:
{
createdAt
:
Date
;
id
:
string
;
rating
:
number
;
reviewText
:
string
;
}
[]
;
tickets
:
{
createdAt
:
Date
;
id
:
string
;
priority
:
string
;
status
:
string
;
title
:
string
;
}
[]
;
vendor
:
{
avatarUrl
:
string
;
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
,
>
get
Appointments
By
Client
Id
getAppointmentsByClientId
(
clientId
:
string
,
)
:
Promise
<
(
{
client
:
{
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
}
;
service
:
{
category
:
string
;
durationMinutes
:
number
;
id
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
,
>
Parameters
clientId
:
string
Returns
Promise
<
(
{
client
:
{
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
}
;
service
:
{
category
:
string
;
durationMinutes
:
number
;
id
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
,
>
get
Appointments
By
Date
Range
getAppointmentsByDateRange
(
startDate
:
string
,
endDate
:
string
,
)
:
Promise
<
(
{
client
:
{
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
}
;
service
:
{
category
:
string
;
durationMinutes
:
number
;
id
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
,
>
Parameters
startDate
:
string
endDate
:
string
Returns
Promise
<
(
{
client
:
{
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
}
;
service
:
{
category
:
string
;
durationMinutes
:
number
;
id
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
,
>
get
Appointments
By
Staff
Id
getAppointmentsByStaffId
(
staffId
:
string
,
)
:
Promise
<
(
{
client
:
{
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
}
;
service
:
{
category
:
string
;
durationMinutes
:
number
;
id
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
,
>
Parameters
staffId
:
string
Returns
Promise
<
(
{
client
:
{
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
}
;
service
:
{
category
:
string
;
durationMinutes
:
number
;
id
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
,
>
get
Appointments
By
Status
getAppointmentsByStatus
(
status
:
booking_status
,
)
:
Promise
<
(
{
client
:
{
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
}
;
service
:
{
category
:
string
;
durationMinutes
:
number
;
id
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
,
>
Parameters
status
:
booking_status
Returns
Promise
<
(
{
client
:
{
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
}
;
service
:
{
category
:
string
;
durationMinutes
:
number
;
id
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
,
>
get
Appointments
By
Vendor
Id
getAppointmentsByVendorId
(
vendorId
:
string
,
)
:
Promise
<
(
{
client
:
{
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
}
;
service
:
{
category
:
string
;
durationMinutes
:
number
;
id
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
,
>
Parameters
vendorId
:
string
Returns
Promise
<
(
{
client
:
{
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
}
;
service
:
{
category
:
string
;
durationMinutes
:
number
;
id
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
,
>
get
Appointment
Stats
getAppointmentStats
(
vendorId
?:
string
,
)
:
Promise
<
{
cancelled
:
number
;
completed
:
number
;
confirmed
:
number
;
pending
:
number
;
rejected
:
number
;
total
:
number
;
}
,
>
Parameters
Optional
vendorId
:
string
Returns
Promise
<
{
cancelled
:
number
;
completed
:
number
;
confirmed
:
number
;
pending
:
number
;
rejected
:
number
;
total
:
number
;
}
,
>
get
My
Appointments
getMyAppointments
(
req
:
any
,
)
:
Promise
<
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
[]
,
>
Parameters
req
:
any
Returns
Promise
<
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
[]
,
>
get
My
Appointment
Stats
getMyAppointmentStats
(
req
:
any
,
)
:
Promise
<
{
cancelled
:
number
;
completed
:
number
;
confirmed
:
number
;
pending
:
number
;
rejected
:
number
;
total
:
number
;
}
,
>
Parameters
req
:
any
Returns
Promise
<
{
cancelled
:
number
;
completed
:
number
;
confirmed
:
number
;
pending
:
number
;
rejected
:
number
;
total
:
number
;
}
,
>
get
My
Upcoming
Appointments
getMyUpcomingAppointments
(
req
:
any
,
)
:
Promise
<
(
{
client
:
{
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
}
;
service
:
{
category
:
string
;
durationMinutes
:
number
;
id
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
,
>
Parameters
req
:
any
Returns
Promise
<
(
{
client
:
{
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
}
;
service
:
{
category
:
string
;
durationMinutes
:
number
;
id
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
,
>
get
Upcoming
Appointments
getUpcomingAppointments
(
req
:
any
,
userRole
:
"staff"
|
"client"
|
"vendor"
,
)
:
Promise
<
(
{
client
:
{
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
}
;
service
:
{
category
:
string
;
durationMinutes
:
number
;
id
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
,
>
Parameters
req
:
any
userRole
:
"staff"
|
"client"
|
"vendor"
Returns
Promise
<
(
{
client
:
{
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
}
;
service
:
{
category
:
string
;
durationMinutes
:
number
;
id
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
,
>
update
Appointment
updateAppointment
(
id
:
string
,
updateAppointmentDto
:
UpdateAppointmentDto
,
)
:
Promise
<
{
client
:
{
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
}
;
service
:
{
category
:
string
;
durationMinutes
:
number
;
id
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
,
>
Parameters
id
:
string
updateAppointmentDto
:
UpdateAppointmentDto
Returns
Promise
<
{
client
:
{
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
}
;
service
:
{
category
:
string
;
durationMinutes
:
number
;
id
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
,
>
update
Appointment
Status
updateAppointmentStatus
(
id
:
string
,
updateStatusDto
:
UpdateAppointmentStatusDto
,
)
:
Promise
<
{
client
:
{
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
}
;
service
:
{
category
:
string
;
durationMinutes
:
number
;
id
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
,
>
Parameters
id
:
string
updateStatusDto
:
UpdateAppointmentStatusDto
Returns
Promise
<
{
client
:
{
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
}
;
service
:
{
category
:
string
;
durationMinutes
:
number
;
id
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
phone
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completionConfirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
endTime
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
notes
:
string
;
price
:
Decimal
;
serviceId
:
string
;
staffId
:
string
;
startTime
:
Date
;
status
:
booking_status
;
statusEnhanced
:
appointment_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
vendorId
:
string
;
}
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
create
Appointment
delete
Appointment
get
All
Appointments
get
Appointment
By
Id
get
Appointments
By
Client
Id
get
Appointments
By
Date
Range
get
Appointments
By
Staff
Id
get
Appointments
By
Status
get
Appointments
By
Vendor
Id
get
Appointment
Stats
get
My
Appointments
get
My
Appointment
Stats
get
My
Upcoming
Appointments
get
Upcoming
Appointments
update
Appointment
update
Appointment
Status
urembo-hub-api
Loading...