MicrosoftbookingsClient

Attributes

DeleteWebhookResponse `module-attribute`

DeleteWebhookResponse = str

TRIGGER_OPERATIONS `module-attribute`

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'CreateAppointment': {'operation_id': 'CreateAppointment', 'path': '/{connectionId}/BookingsService/api/V1/bookingBusinesses/{SMTPAddress}/webhook/AppointmentCreated', 'method': 'post', 'required_parameters': ['SMTPAddress', 'body'], 'callback_payload_type': 'WebhookResponse'}, 'UpdateAppointment': {'operation_id': 'UpdateAppointment', 'path': '/{connectionId}/BookingsService/api/V1/bookingBusinesses/{SMTPAddress}/webhook/AppointmentUpdated', 'method': 'post', 'required_parameters': ['SMTPAddress', 'body'], 'callback_payload_type': None}, 'CancelAppointment': {'operation_id': 'CancelAppointment', 'path': '/{connectionId}/BookingsService/api/V1/bookingBusinesses/{SMTPAddress}/webhook/AppointmentDeleted', 'method': 'post', 'required_parameters': ['SMTPAddress', 'body'], 'callback_payload_type': None}}

Classes

CreateAppointmentInput `dataclass`

CreateAppointmentInput(webhook: Optional[Dict[str, Any]] = None)

When a appointment is Created

WebhookResponse `dataclass`

WebhookResponse(webhook_id: Optional[str] = None)

Response for When a appointment is Created

Attributes

webhook_id `class-attribute` `instance-attribute`

webhook_id: Optional[str] = field(default=None, metadata={'wire_name': 'webhookId'})

Webhook ID.

UpdateAppointmentInput `dataclass`

UpdateAppointmentInput(webhook: Optional[Dict[str, Any]] = None)

When an appointment is Updated

CancelAppointmentInput `dataclass`

CancelAppointmentInput(webhook: Optional[Dict[str, Any]] = None)

When an appointment is Cancelled

ListMailboxResponse `dataclass`

ListMailboxResponse(mailboxes: Optional[List[MailboxEntity]] = None)

Response for List Booking Businesses where user is an admin

Attributes

mailboxes `class-attribute` `instance-attribute`

mailboxes: Optional[List[MailboxEntity]] = None

All mailbox entities.

MailboxEntity `dataclass`

MailboxEntity(display_name: Optional[str] = None, email: Optional[str] = None)

Definition: MailboxEntity

Attributes

display_name `class-attribute` `instance-attribute`

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Mailbox Display name.

email `class-attribute` `instance-attribute`

email: Optional[str] = None

SMTP of the Booking mailbox.

AppointmentData `dataclass`

AppointmentData(additional_info: Optional[str] = None, customer_email: Optional[str] = None, customer_id: Optional[str] = None, customer_location: Optional[Dict[str, Any]] = None, customer_name: Optional[str] = None, customer_notes: Optional[str] = None, custom_question_answers: Optional[List[CustomQuestion]] = None, customer_phone: Optional[str] = None, customer_time_zone: Optional[str] = None, customers: Optional[List[CustomerData]] = None, duration: Optional[int] = None, end_time: Optional[str] = None, filled_attendees_count: Optional[int] = None, id: Optional[str] = None, is_s_m_s_notifications_enabled: Optional[bool] = None, join_web_u_r_l: Optional[str] = None, max_attendees_count: Optional[int] = None, self_service_appointment_id: Optional[str] = None, service_id: Optional[str] = None, service_name: Optional[str] = None, service_notes: Optional[str] = None, staff_members: Optional[List[StaffMemberData]] = None, start_time: Optional[str] = None, tracking_data: Optional[str] = None, cancel_reason: Optional[str] = None)

Definition: AppointmentData

Attributes

additional_info `class-attribute` `instance-attribute`

additional_info: Optional[str] = field(default=None, metadata={'wire_name': 'AdditionalInfo'})

Additional Info about the booking.

customer_email `class-attribute` `instance-attribute`

customer_email: Optional[str] = field(default=None, metadata={'wire_name': 'CustomerEmail'})

Customer Email address in case of 1:1 bookings.

customer_id `class-attribute` `instance-attribute`

customer_id: Optional[str] = field(default=None, metadata={'wire_name': 'CustomerId'})

Customer Id in case of 1:1 bookings.

customer_location `class-attribute` `instance-attribute`

customer_location: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'CustomerLocation'})

Location of customer in 1:1 booking

customer_name `class-attribute` `instance-attribute`

customer_name: Optional[str] = field(default=None, metadata={'wire_name': 'CustomerName'})

Customer Name for 1:1 booking.

customer_notes `class-attribute` `instance-attribute`

customer_notes: Optional[str] = field(default=None, metadata={'wire_name': 'CustomerNotes'})

Customer Notes for 1:1 booking.

custom_question_answers `class-attribute` `instance-attribute`

custom_question_answers: Optional[List[CustomQuestion]] = field(default=None, metadata={'wire_name': 'CustomQuestionAnswers'})

All the custom questions and answers for 1:1 booking.

customer_phone `class-attribute` `instance-attribute`

customer_phone: Optional[str] = field(default=None, metadata={'wire_name': 'CustomerPhone'})

Customer phone for 1:1 booking.

customer_time_zone `class-attribute` `instance-attribute`

customer_time_zone: Optional[str] = field(default=None, metadata={'wire_name': 'CustomerTimeZone'})

Customer Time Zone for 1:1 booking.

customers `class-attribute` `instance-attribute`

customers: Optional[List[CustomerData]] = field(default=None, metadata={'wire_name': 'Customers'})

List of customers in the 1:N booking

duration `class-attribute` `instance-attribute`

duration: Optional[int] = field(default=None, metadata={'wire_name': 'Duration'})

Duration of the appointment

end_time `class-attribute` `instance-attribute`

end_time: Optional[str] = field(default=None, metadata={'wire_name': 'EndTime'})

End Time of the appointment.

filled_attendees_count `class-attribute` `instance-attribute`

filled_attendees_count: Optional[int] = field(default=None, metadata={'wire_name': 'FilledAttendeesCount'})

Number of attendees who have booked this appoinment slot.

id `class-attribute` `instance-attribute`

id: Optional[str] = field(default=None, metadata={'wire_name': 'Id'})

[Deprecated] - use selfServiceAppointmentId as unique identifier for the bookings appointment.

is_s_m_s_notifications_enabled `class-attribute` `instance-attribute`

is_s_m_s_notifications_enabled: Optional[bool] = field(default=None, metadata={'wire_name': 'IsSMSNotificationsEnabled'})

Field to check if SMS notification is enabled for the appointment.

join_web_u_r_l `class-attribute` `instance-attribute`

join_web_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'JoinWebURL'})

URL for joining this online appointment.

max_attendees_count `class-attribute` `instance-attribute`

max_attendees_count: Optional[int] = field(default=None, metadata={'wire_name': 'MaxAttendeesCount'})

Max number of attendees allowed in this appoinment.

self_service_appointment_id `class-attribute` `instance-attribute`

self_service_appointment_id: Optional[str] = field(default=None, metadata={'wire_name': 'SelfServiceAppointmentId'})

Appointment id for the booking appointment.

service_id `class-attribute` `instance-attribute`

service_id: Optional[str] = field(default=None, metadata={'wire_name': 'ServiceId'})

Unique Service Identifier.

service_name `class-attribute` `instance-attribute`

service_name: Optional[str] = field(default=None, metadata={'wire_name': 'ServiceName'})

Name of the bookings service.

service_notes `class-attribute` `instance-attribute`

service_notes: Optional[str] = field(default=None, metadata={'wire_name': 'ServiceNotes'})

Service level notes for the staff and admin.

staff_members `class-attribute` `instance-attribute`

staff_members: Optional[List[StaffMemberData]] = field(default=None, metadata={'wire_name': 'StaffMembers'})

List of staff members

start_time `class-attribute` `instance-attribute`

start_time: Optional[str] = field(default=None, metadata={'wire_name': 'StartTime'})

Start Time of the appointment.

tracking_data `class-attribute` `instance-attribute`

tracking_data: Optional[str] = field(default=None, metadata={'wire_name': 'TrackingData'})

Campaign tracking Data.

cancel_reason `class-attribute` `instance-attribute`

cancel_reason: Optional[str] = field(default=None, metadata={'wire_name': 'CancelReason'})

Reason for cancellation of this booking appointment

CustomerData `dataclass`

CustomerData(email: Optional[str] = None, id: Optional[str] = None, location: Optional[Dict[str, Any]] = None, name: Optional[str] = None, notes: Optional[str] = None, time_zone: Optional[str] = None, answers: Optional[List[CustomQuestion]] = None)

Definition: CustomerData

Attributes

email `class-attribute` `instance-attribute`

email: Optional[str] = field(default=None, metadata={'wire_name': 'Email'})

Email of the customer in the group booking.

id `class-attribute` `instance-attribute`

id: Optional[str] = field(default=None, metadata={'wire_name': 'Id'})

Unique ID of the customer in the group booking.

location `class-attribute` `instance-attribute`

location: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'Location'})

Location of customer in a group booking.

name `class-attribute` `instance-attribute`

name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

Display Name of the customer in the group booking.

notes `class-attribute` `instance-attribute`

notes: Optional[str] = field(default=None, metadata={'wire_name': 'Notes'})

Notes of the customer in the group booking.

time_zone `class-attribute` `instance-attribute`

time_zone: Optional[str] = field(default=None, metadata={'wire_name': 'TimeZone'})

Timezone of the customer in the group booking.

answers `class-attribute` `instance-attribute`

answers: Optional[List[CustomQuestion]] = field(default=None, metadata={'wire_name': 'Answers'})

All the custom questions and answers.

StaffMemberData `dataclass`

StaffMemberData(display_name: Optional[str] = None, email_address: Optional[str] = None, id: Optional[str] = None)

Definition: StaffMemberData

Attributes

display_name `class-attribute` `instance-attribute`

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'DisplayName'})

Display Name of the staff assigned for this appointment.

email_address `class-attribute` `instance-attribute`

email_address: Optional[str] = field(default=None, metadata={'wire_name': 'EmailAddress'})

Email Address of the staff assigned to this appointment.

id `class-attribute` `instance-attribute`

id: Optional[str] = field(default=None, metadata={'wire_name': 'Id'})

Unique Staff identifier.

CustomQuestion `dataclass`

CustomQuestion(answer: Optional[str] = None, answer_options: Optional[List[str]] = None, is_required: Optional[bool] = None, question: Optional[str] = None, question_id: Optional[str] = None, selected_options: Optional[List[int]] = None)

Definition: CustomQuestion

Attributes

answer `class-attribute` `instance-attribute`

answer: Optional[str] = field(default=None, metadata={'wire_name': 'Answer'})

Answer to this custom question.

answer_options `class-attribute` `instance-attribute`

answer_options: Optional[List[str]] = field(default=None, metadata={'wire_name': 'AnswerOptions'})

All the answer options.

is_required `class-attribute` `instance-attribute`

is_required: Optional[bool] = field(default=None, metadata={'wire_name': 'IsRequired'})

Tells if answering this question is mandatory.

question `class-attribute` `instance-attribute`

question: Optional[str] = field(default=None, metadata={'wire_name': 'Question'})

Question to be answered.

question_id `class-attribute` `instance-attribute`

question_id: Optional[str] = field(default=None, metadata={'wire_name': 'QuestionID'})

Unique Identifier of the Question to be answered.

selected_options `class-attribute` `instance-attribute`

selected_options: Optional[List[int]] = field(default=None, metadata={'wire_name': 'SelectedOptions'})

All the selected answer options.