MicrosoftbookingsClient
Attributes
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
dataclass
When a appointment is Created
dataclass
dataclass
When an appointment is Updated
dataclass
When an appointment is Cancelled
dataclass
dataclass
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 | Mapping[str, Any]]] = None, customer_phone: Optional[str] = None, customer_time_zone: Optional[str] = None, customers: Optional[List[CustomerData | Mapping[str, Any]]] = 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 | Mapping[str, Any]]] = None, start_time: Optional[str] = None, tracking_data: Optional[str] = None, cancel_reason: Optional[str] = None)
Definition: AppointmentData
Attributes
class-attribute
instance-attribute
additional_info: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AdditionalInfo'})
Additional Info about the booking.
class-attribute
instance-attribute
customer_email: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomerEmail'})
Customer Email address in case of 1:1 bookings.
class-attribute
instance-attribute
customer_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomerId'})
Customer Id in case of 1:1 bookings.
class-attribute
instance-attribute
customer_location: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomerLocation'})
Location of customer in 1:1 booking
class-attribute
instance-attribute
customer_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomerName'})
Customer Name for 1:1 booking.
class-attribute
instance-attribute
customer_notes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomerNotes'})
Customer Notes for 1:1 booking.
class-attribute
instance-attribute
custom_question_answers: Optional[List[CustomQuestion | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomQuestionAnswers'})
All the custom questions and answers for 1:1 booking.
class-attribute
instance-attribute
customer_phone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomerPhone'})
Customer phone for 1:1 booking.
class-attribute
instance-attribute
customer_time_zone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomerTimeZone'})
Customer Time Zone for 1:1 booking.
class-attribute
instance-attribute
customers: Optional[List[CustomerData | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Customers'})
List of customers in the 1:N booking
class-attribute
instance-attribute
duration: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Duration'})
Duration of the appointment
class-attribute
instance-attribute
end_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EndTime'})
End Time of the appointment.
class-attribute
instance-attribute
filled_attendees_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FilledAttendeesCount'})
Number of attendees who have booked this appoinment slot.
class-attribute
instance-attribute
[Deprecated] - use selfServiceAppointmentId as unique identifier for the bookings appointment.
class-attribute
instance-attribute
is_s_m_s_notifications_enabled: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsSMSNotificationsEnabled'})
Field to check if SMS notification is enabled for the appointment.
class-attribute
instance-attribute
join_web_u_r_l: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'JoinWebURL'})
URL for joining this online appointment.
class-attribute
instance-attribute
max_attendees_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MaxAttendeesCount'})
Max number of attendees allowed in this appoinment.
class-attribute
instance-attribute
self_service_appointment_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SelfServiceAppointmentId'})
Appointment id for the booking appointment.
class-attribute
instance-attribute
service_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ServiceId'})
Unique Service Identifier.
class-attribute
instance-attribute
service_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ServiceName'})
Name of the bookings service.
class-attribute
instance-attribute
service_notes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ServiceNotes'})
Service level notes for the staff and admin.
class-attribute
instance-attribute
staff_members: Optional[List[StaffMemberData | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StaffMembers'})
List of staff members
class-attribute
instance-attribute
start_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StartTime'})
Start Time of the appointment.
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 | Mapping[str, Any]]] = None)
Definition: CustomerData
Attributes
class-attribute
instance-attribute
Email of the customer in the group booking.
class-attribute
instance-attribute
Unique ID of the customer in the group booking.
class-attribute
instance-attribute
location: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Location'})
Location of customer in a group booking.
class-attribute
instance-attribute
Display Name of the customer in the group booking.
class-attribute
instance-attribute
Notes of the customer in the group booking.
dataclass
StaffMemberData(*, display_name: Optional[str] = None, email_address: Optional[str] = None, id: Optional[str] = None)
Definition: StaffMemberData
Attributes
class-attribute
instance-attribute
display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DisplayName'})
Display Name of the staff assigned for this appointment.
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
class-attribute
instance-attribute
answer: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Answer'})
Answer to this custom question.
class-attribute
instance-attribute
answer_options: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AnswerOptions'})
All the answer options.
class-attribute
instance-attribute
is_required: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsRequired'})
Tells if answering this question is mandatory.
class-attribute
instance-attribute
question: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Question'})
Question to be answered.
MicrosoftbookingsClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)
Bases: ConnectorClientBase
Typed client for microsoftbookings connector.
Initialize a MicrosoftbookingsClient.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_runtime_url
|
str
|
The connection runtime URL from Azure Portal. |
required |
credential
|
AsyncTokenCredential | AzureKeyCredential
|
Caller-owned Azure Core credential. |
required |
max_retry_attempts
|
int
|
The maximum number of request attempts. |
3
|
timeout
|
float
|
The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. |
30.0
|
use_exponential_backoff
|
bool
|
Whether retries use exponential backoff. |
True
|
initial_retry_delay_seconds
|
float
|
The initial retry delay in seconds. |
0.5
|
maximum_retry_delay_seconds
|
float
|
The maximum retry delay in seconds. |
120.0
|
retry_jitter_factor
|
float
|
The jitter fraction applied to retry delays. |
0.1
|
retry_unsafe_http_methods
|
bool
|
Whether unsafe HTTP methods may be retried. |
False
|
transport
|
Optional[AsyncHttpTransport]
|
Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle. |
None
|
**kwargs
|
Any
|
Optional Azure Core pipeline policy settings. |
{}
|
Methods:
list_bookings_business_user_as_admin(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List Booking Businesses where user is an admin
Operation used to list all mailboxes for which the accessing user is an Administrator.
Returns a single-page Azure Core async collection.
Swagger operation ID: ListBookingsBusinessUserAsAdmin.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |