Outlook

Attributes

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'CalendarGetOnChangedItemsV2': {'operation_id': 'CalendarGetOnChangedItemsV2', 'path': '/{connectionId}/datasets/calendars/v2/tables/{table}/onchangeditems', 'method': 'get', 'required_parameters': ['table'], 'callback_payload_type': 'CalendarEventListWithActionType'}, 'CalendarGetOnNewItemsV2': {'operation_id': 'CalendarGetOnNewItemsV2', 'path': '/{connectionId}/datasets/calendars/v2/tables/{table}/onnewitems', 'method': 'get', 'required_parameters': ['table'], 'callback_payload_type': 'CalendarEventListClientReceive'}, 'CalendarGetOnUpdatedItemsV2': {'operation_id': 'CalendarGetOnUpdatedItemsV2', 'path': '/{connectionId}/datasets/calendars/v2/tables/{table}/onupdateditems', 'method': 'get', 'required_parameters': ['table'], 'callback_payload_type': 'CalendarEventListClientReceive'}, 'OnFlaggedEmailV2': {'operation_id': 'OnFlaggedEmailV2', 'path': '/{connectionId}/v2/Mail/OnFlaggedEmail', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'TriggerBatchResponseClientReceiveMessage'}, 'OnNewEmailV2': {'operation_id': 'OnNewEmailV2', 'path': '/{connectionId}/v2/Mail/OnNewEmail', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'TriggerBatchResponseClientReceiveMessage'}, 'OnNewMentionMeEmailV2': {'operation_id': 'OnNewMentionMeEmailV2', 'path': '/{connectionId}/v2/Mail/OnNewMentionMeEmail', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'TriggerBatchResponseClientReceiveMessage'}, 'OnUpcomingEventsV2': {'operation_id': 'OnUpcomingEventsV2', 'path': '/{connectionId}/v2/Events/OnUpcomingEvents', 'method': 'get', 'required_parameters': ['table'], 'callback_payload_type': 'CalendarEventListClientReceive'}}

Classes

ClientReceiveMessage dataclass

ClientReceiveMessage(from_: Optional[str] = None, to: Optional[str] = None, cc: Optional[str] = None, bcc: Optional[str] = None, reply_to: Optional[str] = None, subject: Optional[str] = None, body: Optional[str] = None, importance: Optional[int] = None, body_preview: Optional[str] = None, has_attachment: Optional[bool] = None, id: Optional[str] = None, internet_message_id: Optional[str] = None, conversation_id: Optional[str] = None, date_time_received: Optional[str] = None, is_read: Optional[bool] = None, attachments: Optional[List[ClientReceiveFileAttachment]] = None, is_html: Optional[bool] = None)

Response for Get email

Attributes

from_ class-attribute instance-attribute

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

The mailbox owner and sender of the message

to class-attribute instance-attribute

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

The recipients for the message

cc class-attribute instance-attribute

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

The Cc recipients for the message

bcc class-attribute instance-attribute

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

The Bcc recipients for the message

reply_to class-attribute instance-attribute

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

The email addresses to use when replying

subject class-attribute instance-attribute

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

The subject of the message

body class-attribute instance-attribute

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

The body of the message

importance class-attribute instance-attribute

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

The importance of the message (0 - Low, 1 - Normal, 2 - High)

body_preview class-attribute instance-attribute

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

The preview of the message

has_attachment class-attribute instance-attribute

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

Indicates whether the message has attachments

id class-attribute instance-attribute

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

The unique identifier of the message

internet_message_id class-attribute instance-attribute

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

The message ID in the format specified by RFC2822

conversation_id class-attribute instance-attribute

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

The Id of the conversation the email belongs to

date_time_received class-attribute instance-attribute

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

The date and time the message was received

is_read class-attribute instance-attribute

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

Indicates whether the message has been read

attachments class-attribute instance-attribute

attachments: Optional[List[ClientReceiveFileAttachment]] = field(default=None, metadata={'wire_name': 'Attachments'})

The file attachments for the message

is_html class-attribute instance-attribute

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

Is Html?

ClientReceiveMessageStringEnums dataclass

ClientReceiveMessageStringEnums(importance: Optional[str] = None, from_: Optional[str] = None, to: Optional[str] = None, cc: Optional[str] = None, bcc: Optional[str] = None, reply_to: Optional[str] = None, subject: Optional[str] = None, body: Optional[str] = None, body_preview: Optional[str] = None, has_attachment: Optional[bool] = None, id: Optional[str] = None, internet_message_id: Optional[str] = None, conversation_id: Optional[str] = None, date_time_received: Optional[str] = None, is_read: Optional[bool] = None, attachments: Optional[List[ClientReceiveFileAttachment]] = None, is_html: Optional[bool] = None)

Response for Move email

Attributes

importance class-attribute instance-attribute

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

The importance of the message

from_ class-attribute instance-attribute

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

The mailbox owner and sender of the message

to class-attribute instance-attribute

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

The recipients for the message

cc class-attribute instance-attribute

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

The Cc recipients for the message

bcc class-attribute instance-attribute

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

The Bcc recipients for the message

reply_to class-attribute instance-attribute

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

The email addresses to use when replying

subject class-attribute instance-attribute

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

The subject of the message

body class-attribute instance-attribute

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

The body of the message

body_preview class-attribute instance-attribute

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

The preview of the message

has_attachment class-attribute instance-attribute

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

Indicates whether the message has attachments

id class-attribute instance-attribute

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

The unique identifier of the message

internet_message_id class-attribute instance-attribute

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

The message ID in the format specified by RFC2822

conversation_id class-attribute instance-attribute

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

The Id of the conversation the email belongs to

date_time_received class-attribute instance-attribute

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

The date and time the message was received

is_read class-attribute instance-attribute

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

Indicates whether the message has been read

attachments class-attribute instance-attribute

attachments: Optional[List[ClientReceiveFileAttachment]] = field(default=None, metadata={'wire_name': 'Attachments'})

The file attachments for the message

is_html class-attribute instance-attribute

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

Is Html?

SubscriptionResponse dataclass

SubscriptionResponse(id: Optional[str] = None, resource: Optional[str] = None, notification_type: Optional[str] = None, notification_url: Optional[str] = None)

Response for Send email with options

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

Id of the subscription

resource class-attribute instance-attribute

resource: Optional[str] = None

Resource of the subscription request

notification_type class-attribute instance-attribute

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

Notification Type

notification_url class-attribute instance-attribute

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

Notification Url

EntityListResponseTable dataclass

EntityListResponseTable(value: Optional[List[Table]] = None)

Response for Get calendars

Attributes

value class-attribute instance-attribute

value: Optional[List[Table]] = None

List of values

EntityListResponseContactResponse dataclass

EntityListResponseContactResponse(value: Optional[List[ContactResponse]] = None)

Response for Get contacts

Attributes

value class-attribute instance-attribute

value: Optional[List[ContactResponse]] = None

List of values

ContactResponse dataclass

ContactResponse(given_name: Optional[str] = None, home_phones: Optional[List[str]] = None, id: Optional[str] = None, parent_folder_id: Optional[str] = None, birthday: Optional[str] = None, file_as: Optional[str] = None, display_name: Optional[str] = None, initials: Optional[str] = None, middle_name: Optional[str] = None, nick_name: Optional[str] = None, surname: Optional[str] = None, title: Optional[str] = None, generation: Optional[str] = None, email_addresses: Optional[List[EmailAddress]] = None, im_addresses: Optional[List[str]] = None, job_title: Optional[str] = None, company_name: Optional[str] = None, department: Optional[str] = None, office_location: Optional[str] = None, profession: Optional[str] = None, business_home_page: Optional[str] = None, assistant_name: Optional[str] = None, manager: Optional[str] = None, business_phones: Optional[List[str]] = None, mobile_phone1: Optional[str] = None, home_address: Optional[PhysicalAddress] = None, business_address: Optional[PhysicalAddress] = None, other_address: Optional[PhysicalAddress] = None, yomi_company_name: Optional[str] = None, yomi_given_name: Optional[str] = None, yomi_surname: Optional[str] = None, categories: Optional[List[str]] = None, change_key: Optional[str] = None, date_time_created: Optional[str] = None, date_time_last_modified: Optional[str] = None)

Response for Create contact

Attributes

given_name class-attribute instance-attribute

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

The contact's given name

home_phones class-attribute instance-attribute

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

The contact's home phone numbers

id class-attribute instance-attribute

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

The contact's unique identifier.

parent_folder_id class-attribute instance-attribute

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

The ID of the contact's parent folder

birthday class-attribute instance-attribute

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

The contact's birthday

file_as class-attribute instance-attribute

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

The name the contact is filed under

display_name class-attribute instance-attribute

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

The contact's display name

initials class-attribute instance-attribute

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

The contact's initials

middle_name class-attribute instance-attribute

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

The contact's middle name

nick_name class-attribute instance-attribute

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

The contact's nickname

surname class-attribute instance-attribute

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

The contact's surname

title class-attribute instance-attribute

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

The contact's title

generation class-attribute instance-attribute

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

The contact's generation

email_addresses class-attribute instance-attribute

email_addresses: Optional[List[EmailAddress]] = field(default=None, metadata={'wire_name': 'EmailAddresses'})

The contact's email addresses

im_addresses class-attribute instance-attribute

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

The contact's instant messaging (IM) addresses

job_title class-attribute instance-attribute

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

The contact's job title

company_name class-attribute instance-attribute

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

The name of the contact's company

department class-attribute instance-attribute

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

The contact's department

office_location class-attribute instance-attribute

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

The location of the contact's office

profession class-attribute instance-attribute

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

The contact's profession

business_home_page class-attribute instance-attribute

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

The business home page of the contact

assistant_name class-attribute instance-attribute

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

The name of the contact's assistant

manager class-attribute instance-attribute

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

The name of the contact's manager

business_phones class-attribute instance-attribute

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

The contact's business phone numbers

mobile_phone1 class-attribute instance-attribute

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

The contact's mobile phone number

yomi_company_name class-attribute instance-attribute

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

The phonetic Japanese company name of the contact

yomi_given_name class-attribute instance-attribute

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

The phonetic Japanese given name (first name) of the contact

yomi_surname class-attribute instance-attribute

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

The phonetic Japanese surname (last name) of the contact

categories class-attribute instance-attribute

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

The categories associated with the contact

change_key class-attribute instance-attribute

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

Identifies the version of the event object

date_time_created class-attribute instance-attribute

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

The time the contact was created

date_time_last_modified class-attribute instance-attribute

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

The time the contact was modified

CalendarEventClientReceiveStringEnums dataclass

CalendarEventClientReceiveStringEnums(importance: Optional[str] = None, response_type: Optional[str] = None, recurrence: Optional[str] = None, show_as: Optional[str] = None, subject: Optional[str] = None, start: Optional[str] = None, end: Optional[str] = None, response_time: Optional[str] = None, i_cal_u_id: Optional[str] = None, id: Optional[str] = None, date_time_created: Optional[str] = None, date_time_last_modified: Optional[str] = None, organizer: Optional[str] = None, time_zone: Optional[str] = None, series_master_id: Optional[str] = None, categories: Optional[List[str]] = None, web_link: Optional[str] = None, required_attendees: Optional[str] = None, optional_attendees: Optional[str] = None, resource_attendees: Optional[str] = None, body: Optional[str] = None, is_html: Optional[bool] = None, location: Optional[str] = None, is_all_day: Optional[bool] = None, recurrence_end: Optional[str] = None, number_of_occurrences: Optional[int] = None, reminder: Optional[int] = None, response_requested: Optional[bool] = None)

Response for Get event

Attributes

importance class-attribute instance-attribute

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

The importance of the event: Low, Normal, or High

response_type class-attribute instance-attribute

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

The response type of the event: None, Organizer, TentativelyAccepted, Accepted, Declined or NotResponded

recurrence class-attribute instance-attribute

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

The recurrence pattern for the event

show_as class-attribute instance-attribute

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

Status to show during the event

subject class-attribute instance-attribute

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

Event subject

start class-attribute instance-attribute

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

Start time of the event (example: '2016-11-01T14:30:00Z')

end class-attribute instance-attribute

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

End time of the event (example: '2016-11-01T15:30:00Z')

response_time class-attribute instance-attribute

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

The response time of the event

i_cal_u_id class-attribute instance-attribute

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

A unique identifier that is shared by all instances of an event across different calendars

id class-attribute instance-attribute

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

The event's unique identifier

date_time_created class-attribute instance-attribute

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

The date and time that the event was created

date_time_last_modified class-attribute instance-attribute

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

The date and time that the event was last modified

organizer class-attribute instance-attribute

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

The organizer of the event

time_zone class-attribute instance-attribute

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

Time zone of the event

series_master_id class-attribute instance-attribute

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

Unique identifier for Series Master event type

categories class-attribute instance-attribute

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

The categories associated with the event

web_link class-attribute instance-attribute

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

The URL to open the event in Outlook Web App

required_attendees class-attribute instance-attribute

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

Required attendees for the event separated by semicolons

optional_attendees class-attribute instance-attribute

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

Optional attendees for the event separated by semicolons

resource_attendees class-attribute instance-attribute

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

Resource attendees for the event separated by semicolons

body class-attribute instance-attribute

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

Body of the message associated with the event

is_html class-attribute instance-attribute

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

Set to true if the body is Html

location class-attribute instance-attribute

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

Location of the event

is_all_day class-attribute instance-attribute

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

Set to true if the event lasts all day

recurrence_end class-attribute instance-attribute

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

End time of the recurrence

number_of_occurrences class-attribute instance-attribute

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

How many times to repeat the event

reminder class-attribute instance-attribute

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

Time in minutes before event start to remind

response_requested class-attribute instance-attribute

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

Set to true if the sender would like a response when the event is accepted or declined

CalendarEventListClientReceive dataclass

CalendarEventListClientReceive(value: Optional[List[CalendarEventClientReceive]] = None)

Response for Get events

Attributes

value class-attribute instance-attribute

value: Optional[List[CalendarEventClientReceive]] = None

List of calendar items

CalendarEventListWithActionType dataclass

CalendarEventListWithActionType(value: Optional[List[CalendarEventClientWithActionType]] = None)

Response for When an event is added, updated or deleted

Attributes

value class-attribute instance-attribute

value: Optional[List[CalendarEventClientWithActionType]] = None

List of calendar items

BatchResponseClientReceiveMessage dataclass

BatchResponseClientReceiveMessage(value: Optional[List[ClientReceiveMessage]] = None)

Response for Get emails

Attributes

value class-attribute instance-attribute

value: Optional[List[ClientReceiveMessage]] = None

A list of the response objects

EntityListResponseCalendarEventClientReceiveStringEnums dataclass

EntityListResponseCalendarEventClientReceiveStringEnums(value: Optional[List[CalendarEventClientReceiveStringEnums]] = None)

Response for Get calendar view of events

Attributes

value class-attribute instance-attribute

value: Optional[List[CalendarEventClientReceiveStringEnums]] = None

List of values

TriggerBatchResponseClientReceiveMessage dataclass

TriggerBatchResponseClientReceiveMessage(value: Optional[List[ClientReceiveMessage]] = None)

Response for When an email is flagged

Attributes

value class-attribute instance-attribute

value: Optional[List[ClientReceiveMessage]] = None

A list of the response objects

TableMetadata dataclass

TableMetadata(name: Optional[str] = None, title: Optional[str] = None, x_ms_permission: Optional[str] = None, x_ms_capabilities: Optional[TableCapabilitiesMetadata] = None, schema: Optional[ObjectEntity] = None, referenced_entities: Optional[ObjectEntity] = None, web_url: Optional[str] = None)

Definition: TableMetadata

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Table name

title class-attribute instance-attribute

title: Optional[str] = None

Table title

x_ms_permission class-attribute instance-attribute

x_ms_permission: Optional[str] = field(default=None, metadata={'wire_name': 'x-ms-permission'})

Table permission

web_url class-attribute instance-attribute

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

Url link

TableCapabilitiesMetadata dataclass

TableCapabilitiesMetadata(sort_restrictions: Optional[TableSortRestrictionsMetadata] = None, filter_restrictions: Optional[TableFilterRestrictionsMetadata] = None, select_restrictions: Optional[TableSelectRestrictionsMetadata] = None, is_only_server_pagable: Optional[bool] = None, filter_function_support: Optional[List[str]] = None, server_paging_options: Optional[List[str]] = None)

Definition: TableCapabilitiesMetadata

Attributes

is_only_server_pagable class-attribute instance-attribute

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

Server paging restrictions

filter_function_support class-attribute instance-attribute

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

List of supported filter capabilities

server_paging_options class-attribute instance-attribute

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

List of supported server-driven paging capabilities

ObjectEntity dataclass

ObjectEntity(additional_properties: Dict[str, Any] = dict())

Definition: Object

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

TableSortRestrictionsMetadata dataclass

TableSortRestrictionsMetadata(sortable: Optional[bool] = None, unsortable_properties: Optional[List[str]] = None, ascending_only_properties: Optional[List[str]] = None)

Definition: TableSortRestrictionsMetadata

Attributes

sortable class-attribute instance-attribute

sortable: Optional[bool] = None

Indicates whether this table has sortable columns

unsortable_properties class-attribute instance-attribute

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

List of unsortable properties

ascending_only_properties class-attribute instance-attribute

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

List of properties which support ascending order only

TableFilterRestrictionsMetadata dataclass

TableFilterRestrictionsMetadata(filterable: Optional[bool] = None, non_filterable_properties: Optional[List[str]] = None, required_properties: Optional[List[str]] = None)

Definition: TableFilterRestrictionsMetadata

Attributes

filterable class-attribute instance-attribute

filterable: Optional[bool] = None

Indicates whether this table has filterable columns

non_filterable_properties class-attribute instance-attribute

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

List of non filterable properties

required_properties class-attribute instance-attribute

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

List of required properties

TableSelectRestrictionsMetadata dataclass

TableSelectRestrictionsMetadata(selectable: Optional[bool] = None)

Definition: TableSelectRestrictionsMetadata

Attributes

selectable class-attribute instance-attribute

selectable: Optional[bool] = None

Indicates whether this table has selectable columns

CalendarEventList dataclass

CalendarEventList(value: Optional[List[CalendarEventBackend]] = None)

Definition: CalendarEventList

Attributes

value class-attribute instance-attribute

value: Optional[List[CalendarEventBackend]] = None

List of calendar items

CalendarEventBackend dataclass

CalendarEventBackend(id: Optional[str] = None, attendees: Optional[List[Attendee]] = None, body: Optional[ItemBody] = None, body_preview: Optional[str] = None, categories: Optional[List[str]] = None, change_key: Optional[str] = None, date_time_created: Optional[str] = None, date_time_last_modified: Optional[str] = None, end: Optional[str] = None, end_time_zone: Optional[str] = None, has_attachments: Optional[bool] = None, i_cal_u_id: Optional[str] = None, importance: Optional[str] = None, is_all_day: Optional[bool] = None, is_cancelled: Optional[bool] = None, is_organizer: Optional[bool] = None, location: Optional[Location] = None, organizer: Optional[Recipient] = None, recurrence: Optional[PatternedRecurrence] = None, reminder: Optional[int] = None, response_requested: Optional[bool] = None, response_status: Optional[ResponseStatus] = None, series_master_id: Optional[str] = None, show_as: Optional[str] = None, start: Optional[str] = None, start_time_zone: Optional[str] = None, subject: Optional[str] = None, type_: Optional[str] = None, web_link: Optional[str] = None, reason: Optional[str] = None)

Definition: CalendarEventBackend

Attributes

id class-attribute instance-attribute

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

The Event's unique identifier

attendees class-attribute instance-attribute

attendees: Optional[List[Attendee]] = field(default=None, metadata={'wire_name': 'Attendees'})

List of attendees for the event

body_preview class-attribute instance-attribute

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

The preview of the message associated with the event

categories class-attribute instance-attribute

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

The categories associated with the event

change_key class-attribute instance-attribute

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

This property identifies the version of the event object. Every time the event is changed, ChangeKey changes as well.

date_time_created class-attribute instance-attribute

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

The date and time that the event was created

date_time_last_modified class-attribute instance-attribute

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

The date and time that the event was last modified

end class-attribute instance-attribute

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

The end time of the event

end_time_zone class-attribute instance-attribute

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

This property specifies the time zone of the meeting end time. The value must be as defined in Windows (example: 'Pacific Standard Time').

has_attachments class-attribute instance-attribute

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

Set to true if the event has attachments

i_cal_u_id class-attribute instance-attribute

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

A unique identifier that is shared by all instances of an event across different calendars

importance class-attribute instance-attribute

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

The importance of the event: Low, Normal, or High

is_all_day class-attribute instance-attribute

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

Set to true if the event lasts all day

is_cancelled class-attribute instance-attribute

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

Set to true if the event has been canceled

is_organizer class-attribute instance-attribute

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

Set to true if the message sender is also the organizer

reminder class-attribute instance-attribute

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

Time in minutes before event start to remind

response_requested class-attribute instance-attribute

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

Set to true if the sender would like a response when the event is accepted or declined

series_master_id class-attribute instance-attribute

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

Unique identifier for Series Master event type

show_as class-attribute instance-attribute

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

Shows as free or busy

start class-attribute instance-attribute

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

The start time of the event

start_time_zone class-attribute instance-attribute

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

This property specifies the time zone of the meeting start time. The value must be as defined in Windows (example: 'Pacific Standard Time').

subject class-attribute instance-attribute

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

Event subject

type_ class-attribute instance-attribute

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

The event type: Single Instance, Occurrence, Exception, or Series Master

web_link class-attribute instance-attribute

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

The preview of the message associated with the event

reason class-attribute instance-attribute

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

The reason property used by O365 sync events protocol, will be 'deleted' if its a deleted event.

Attendee dataclass

Attendee(status: Optional[ResponseStatus] = None, type_: Optional[str] = None, email_address: Optional[EmailAddress] = None)

Definition: Attendee

ItemBody dataclass

ItemBody(content_type: Optional[str] = None, content: Optional[str] = None)

Definition: ItemBody

Location dataclass

Location(display_name: Optional[str] = None, address: Optional[PhysicalAddress] = None, coordinates: Optional[GeoCoordinates] = None)

Definition: Location

Recipient dataclass

Recipient(email_address: Optional[EmailAddress] = None)

Definition: Recipient

PatternedRecurrence dataclass

PatternedRecurrence(pattern: Optional[RecurrencePattern] = None, range: Optional[RecurrenceRange] = None)

Definition: PatternedRecurrence

ResponseStatus dataclass

ResponseStatus(response: Optional[str] = None, time: Optional[str] = None)

Definition: ResponseStatus

EmailAddress dataclass

EmailAddress(name: Optional[str] = None, address: Optional[str] = None)

Definition: EmailAddress

PhysicalAddress dataclass

PhysicalAddress(street: Optional[str] = None, city: Optional[str] = None, state: Optional[str] = None, country_or_region: Optional[str] = None, postal_code: Optional[str] = None)

Definition: PhysicalAddress

GeoCoordinates dataclass

GeoCoordinates(altitude: Optional[float] = None, latitude: Optional[float] = None, longitude: Optional[float] = None, accuracy: Optional[float] = None, altitude_accuracy: Optional[float] = None)

Definition: GeoCoordinates

RecurrencePattern dataclass

RecurrencePattern(type_: Optional[str] = None, interval: Optional[int] = None, month: Optional[int] = None, day_of_month: Optional[int] = None, days_of_week: Optional[List[str]] = None, first_day_of_week: Optional[str] = None, index: Optional[str] = None)

Definition: RecurrencePattern

RecurrenceRange dataclass

RecurrenceRange(type_: Optional[str] = None, start_date: Optional[str] = None, end_date: Optional[str] = None, number_of_occurrences: Optional[int] = None)

Definition: RecurrenceRange

CalendarEventClientReceive dataclass

CalendarEventClientReceive(subject: Optional[str] = None, start: Optional[str] = None, end: Optional[str] = None, show_as: Optional[int] = None, recurrence: Optional[int] = None, response_type: Optional[int] = None, response_time: Optional[str] = None, i_cal_u_id: Optional[str] = None, importance: Optional[int] = None, id: Optional[str] = None, date_time_created: Optional[str] = None, date_time_last_modified: Optional[str] = None, organizer: Optional[str] = None, time_zone: Optional[str] = None, series_master_id: Optional[str] = None, categories: Optional[List[str]] = None, web_link: Optional[str] = None, required_attendees: Optional[str] = None, optional_attendees: Optional[str] = None, resource_attendees: Optional[str] = None, body: Optional[str] = None, is_html: Optional[bool] = None, location: Optional[str] = None, is_all_day: Optional[bool] = None, recurrence_end: Optional[str] = None, number_of_occurrences: Optional[int] = None, reminder: Optional[int] = None, response_requested: Optional[bool] = None)

Definition: CalendarEventClientReceive

Attributes

subject class-attribute instance-attribute

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

Event subject

start class-attribute instance-attribute

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

Start time of the event (example: '2016-11-01T14:30:00Z')

end class-attribute instance-attribute

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

End time of the event (example: '2016-11-01T15:30:00Z')

show_as class-attribute instance-attribute

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

Status to show during the event (Unknown - -1, Free - 0, Tentative - 1, Busy - 2, Oof - 3, WorkingElsewhere - 4)

recurrence class-attribute instance-attribute

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

The recurrence pattern for the event (None - 0, Daily - 1, Weekly - 2, Monthly - 3, Yearly - 4)

response_type class-attribute instance-attribute

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

The response type of the event (None - 0, Organizer - 1, TentativelyAccepted - 2, Accepted - 3, Declined - 4, NotResponded - 5)

response_time class-attribute instance-attribute

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

The response time of the event

i_cal_u_id class-attribute instance-attribute

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

A unique identifier that is shared by all instances of an event across different calendars

importance class-attribute instance-attribute

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

The importance of the event (0 - Low, 1 - Normal, 2 - High)

id class-attribute instance-attribute

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

The event's unique identifier

date_time_created class-attribute instance-attribute

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

The date and time that the event was created

date_time_last_modified class-attribute instance-attribute

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

The date and time that the event was last modified

organizer class-attribute instance-attribute

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

The organizer of the event

time_zone class-attribute instance-attribute

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

Time zone of the event

series_master_id class-attribute instance-attribute

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

Unique identifier for Series Master event type

categories class-attribute instance-attribute

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

The categories associated with the event

web_link class-attribute instance-attribute

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

The URL to open the event in Outlook Web App

required_attendees class-attribute instance-attribute

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

Required attendees for the event separated by semicolons

optional_attendees class-attribute instance-attribute

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

Optional attendees for the event separated by semicolons

resource_attendees class-attribute instance-attribute

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

Resource attendees for the event separated by semicolons

body class-attribute instance-attribute

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

Body of the message associated with the event

is_html class-attribute instance-attribute

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

Set to true if the body is Html

location class-attribute instance-attribute

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

Location of the event

is_all_day class-attribute instance-attribute

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

Set to true if the event lasts all day

recurrence_end class-attribute instance-attribute

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

End time of the recurrence

number_of_occurrences class-attribute instance-attribute

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

How many times to repeat the event

reminder class-attribute instance-attribute

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

Time in minutes before event start to remind

response_requested class-attribute instance-attribute

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

Set to true if the sender would like a response when the event is accepted or declined

PaginatedListResponseCalendarEventClientReceiveStringEnums dataclass

PaginatedListResponseCalendarEventClientReceiveStringEnums(values: Optional[List[CalendarEventClientReceiveStringEnums]] = None)

Definition: PaginatedListResponse[CalendarEventClientReceiveStringEnums]

Attributes

values class-attribute instance-attribute

values: Optional[List[CalendarEventClientReceiveStringEnums]] = field(default=None, metadata={'wire_name': 'Values'})

Values

ClientSubscription dataclass

ClientSubscription(notification_url: Optional[str] = None)

Definition: ClientSubscription

Attributes

notification_url class-attribute instance-attribute

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

Callback url to the flow engine. Expected as part of the request and provided by Flow.

EntityListResponseFilePickerFile dataclass

EntityListResponseFilePickerFile(value: Optional[List[FilePickerFile]] = None)

Definition: EntityListResponse[FilePickerFile]

Attributes

value class-attribute instance-attribute

value: Optional[List[FilePickerFile]] = None

List of values

FilePickerFile dataclass

FilePickerFile(id: Optional[str] = None, display_name: Optional[str] = None, is_folder: Optional[bool] = None, path: Optional[str] = None)

Definition: FilePickerFile

Attributes

id class-attribute instance-attribute

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

Uniquely identifies the file

display_name class-attribute instance-attribute

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

Display name for the file

is_folder class-attribute instance-attribute

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

Set to true if the file is a folder

path class-attribute instance-attribute

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

Path of the file

ClientSendMessage dataclass

ClientSendMessage(cc: Optional[str] = None, bcc: Optional[str] = None, to: Optional[str] = None, subject: Optional[str] = None, body: Optional[str] = None, attachments: Optional[List[ClientSendAttachment]] = None, reply_to: Optional[str] = None, importance: Optional[str] = None, is_html: Optional[bool] = None)

Definition: ClientSendMessage

Attributes

cc class-attribute instance-attribute

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

Specify email addresses separated by semicolons like someone@contoso.com

bcc class-attribute instance-attribute

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

Specify email addresses separated by semicolons like someone@contoso.com

to class-attribute instance-attribute

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

Specify email addresses separated by semicolons like someone@contoso.com

subject class-attribute instance-attribute

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

Specify the subject of the mail

body class-attribute instance-attribute

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

Specify the body of the mail

attachments class-attribute instance-attribute

attachments: Optional[List[ClientSendAttachment]] = field(default=None, metadata={'wire_name': 'Attachments'})

Attachments

reply_to class-attribute instance-attribute

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

The email addresses to use when replying

importance class-attribute instance-attribute

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

Importance

is_html class-attribute instance-attribute

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

Is Html?

ClientSendAttachment dataclass

ClientSendAttachment(name: Optional[str] = None, content_bytes: Optional[str] = None)

Definition: ClientSendAttachment

Attributes

name class-attribute instance-attribute

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

Attachment name

content_bytes class-attribute instance-attribute

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

Attachment content

ClientReceiveFileAttachment dataclass

ClientReceiveFileAttachment(id: Optional[str] = None, name: Optional[str] = None, content_bytes: Optional[str] = None, content_type: Optional[str] = None, size: Optional[int] = None, is_inline: Optional[bool] = None, last_modified_date_time: Optional[str] = None, content_id: Optional[str] = None)

Definition: ClientReceiveFileAttachment

Attributes

id class-attribute instance-attribute

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

Attachment Id

name class-attribute instance-attribute

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

Attachment name

content_bytes class-attribute instance-attribute

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

Attachment content

content_type class-attribute instance-attribute

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

Attachment content type

size class-attribute instance-attribute

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

The size in bytes of the attachment

is_inline class-attribute instance-attribute

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

Set to true if this is an inline attachment

last_modified_date_time class-attribute instance-attribute

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

The date and time when the attachment was last modified

content_id class-attribute instance-attribute

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

Content Id

ClientSendHtmlMessage dataclass

ClientSendHtmlMessage(to: Optional[str] = None, subject: Optional[str] = None, body: Optional[str] = None, from_: Optional[str] = None, cc: Optional[str] = None, bcc: Optional[str] = None, attachments: Optional[List[ClientSendAttachment]] = None, reply_to: Optional[str] = None, importance: Optional[str] = None)

Definition: ClientSendHtmlMessage

Attributes

to class-attribute instance-attribute

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

Specify email addresses separated by semicolons like someone@contoso.com

subject class-attribute instance-attribute

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

Specify the subject of the mail

body class-attribute instance-attribute

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

Specify the body of the mail

from_ class-attribute instance-attribute

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

Email address to send mail from (requires "Send as" or "Send on behalf of" permission for that mailbox). For more info on granting permissions please refer https://docs.microsoft.com/office365/admin/manage/send-email-as-distribution-list

cc class-attribute instance-attribute

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

Specify email addresses separated by semicolons like someone@contoso.com

bcc class-attribute instance-attribute

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

Specify email addresses separated by semicolons like someone@contoso.com

attachments class-attribute instance-attribute

attachments: Optional[List[ClientSendAttachment]] = field(default=None, metadata={'wire_name': 'Attachments'})

Attachments

reply_to class-attribute instance-attribute

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

The email addresses to use when replying

importance class-attribute instance-attribute

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

Importance

ReplyMessage dataclass

ReplyMessage(to: Optional[str] = None, cc: Optional[str] = None, bcc: Optional[str] = None, subject: Optional[str] = None, body: Optional[str] = None, reply_all: Optional[bool] = None, is_html: Optional[bool] = None, importance: Optional[str] = None, attachments: Optional[List[ClientSendAttachment]] = None)

Definition: ReplyMessage

Attributes

to class-attribute instance-attribute

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

Example: recipient1@domain.com; recipient2@domain.com

cc class-attribute instance-attribute

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

Example: recipient1@domain.com; recipient2@domain.com

bcc class-attribute instance-attribute

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

Example: recipient1@domain.com; recipient2@domain.com

subject class-attribute instance-attribute

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

Email subject (if empty, the original subject used).

body class-attribute instance-attribute

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

Content of the email.

reply_all class-attribute instance-attribute

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

True to reply to all recipients. (default: False)

is_html class-attribute instance-attribute

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

True to send the reply as HTML. (default: True)

importance class-attribute instance-attribute

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

Pick an importance. (default: Low)

attachments class-attribute instance-attribute

attachments: Optional[List[ClientSendAttachment]] = field(default=None, metadata={'wire_name': 'Attachments'})

Details of attachments to be sent along with the reply.

ReplyHtmlMessage dataclass

ReplyHtmlMessage(to: Optional[str] = None, cc: Optional[str] = None, bcc: Optional[str] = None, subject: Optional[str] = None, body: Optional[str] = None, reply_all: Optional[bool] = None, importance: Optional[str] = None, attachments: Optional[List[ClientSendAttachment]] = None)

Definition: ReplyHtmlMessage

Attributes

to class-attribute instance-attribute

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

Example: recipient1@domain.com; recipient2@domain.com

cc class-attribute instance-attribute

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

Example: recipient1@domain.com; recipient2@domain.com

bcc class-attribute instance-attribute

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

Example: recipient1@domain.com; recipient2@domain.com

subject class-attribute instance-attribute

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

Email subject (if empty, the original subject used).

body class-attribute instance-attribute

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

Content of the email.

reply_all class-attribute instance-attribute

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

True to reply to all recipients. (default: False)

importance class-attribute instance-attribute

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

Pick an importance. (default: Low)

attachments class-attribute instance-attribute

attachments: Optional[List[ClientSendAttachment]] = field(default=None, metadata={'wire_name': 'Attachments'})

Details of attachments to be sent along with the reply.

DataSetsMetadata dataclass

DataSetsMetadata(tabular: Optional[TabularDataSetsMetadata] = None, blob: Optional[BlobDataSetsMetadata] = None)

Definition: DataSetsMetadata

TabularDataSetsMetadata dataclass

TabularDataSetsMetadata(source: Optional[str] = None, display_name: Optional[str] = None, url_encoding: Optional[str] = None, table_display_name: Optional[str] = None, table_plural_name: Optional[str] = None)

Definition: TabularDataSetsMetadata

Attributes

source class-attribute instance-attribute

source: Optional[str] = None

Dataset source

display_name class-attribute instance-attribute

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

Dataset display name

url_encoding class-attribute instance-attribute

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

Dataset url encoding

table_display_name class-attribute instance-attribute

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

Table display name

table_plural_name class-attribute instance-attribute

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

Table plural display name

BlobDataSetsMetadata dataclass

BlobDataSetsMetadata(source: Optional[str] = None, display_name: Optional[str] = None, url_encoding: Optional[str] = None)

Definition: BlobDataSetsMetadata

Attributes

source class-attribute instance-attribute

source: Optional[str] = None

Blob dataset source

display_name class-attribute instance-attribute

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

Blob dataset display name

url_encoding class-attribute instance-attribute

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

Blob dataset url encoding

OptionsEmailSubscription dataclass

OptionsEmailSubscription(notification_url: Optional[str] = None, message: Optional[MessageWithOptions] = None)

Definition: OptionsEmailSubscription

Attributes

notification_url class-attribute instance-attribute

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

Gets or sets callback url to flow engine. It is expected as part of request

MessageWithOptions dataclass

MessageWithOptions(to: Optional[str] = None, subject: Optional[str] = None, options: Optional[str] = None, header_text: Optional[str] = None, selection_text: Optional[str] = None, body: Optional[str] = None, importance: Optional[str] = None, attachments: Optional[List[ClientSendAttachment]] = None, use_only_h_t_m_l_message: Optional[bool] = None, hide_h_t_m_l_message: Optional[bool] = None, show_h_t_m_l_confirmation_dialog: Optional[bool] = None)

Definition: MessageWithOptions

Attributes

to class-attribute instance-attribute

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

Specify email addresses separated by semicolons like someone@contoso.com

subject class-attribute instance-attribute

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

Subject of the email

options class-attribute instance-attribute

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

List of comma separated options for the email response

header_text class-attribute instance-attribute

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

Header text for email body

selection_text class-attribute instance-attribute

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

Header text for users options selection

body class-attribute instance-attribute

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

Body of the email

importance class-attribute instance-attribute

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

Importance

attachments class-attribute instance-attribute

attachments: Optional[List[ClientSendAttachment]] = field(default=None, metadata={'wire_name': 'Attachments'})

Attachments

use_only_h_t_m_l_message class-attribute instance-attribute

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

Use only HTML message

hide_h_t_m_l_message class-attribute instance-attribute

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

If set to Yes, then the email body is hidden and only message card is displayed. Email clients which do not support actionable messages will display HTML message regardless of the parameter value.

show_h_t_m_l_confirmation_dialog class-attribute instance-attribute

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

If set to Yes then a dialog wil be shown to confirm selected option of HTML message

ApprovalEmailResponse dataclass

ApprovalEmailResponse(selected_option: Optional[str] = None)

Definition: ApprovalEmailResponse

Attributes

selected_option class-attribute instance-attribute

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

User response

ApprovalEmailSubscription dataclass

ApprovalEmailSubscription(notification_url: Optional[str] = None, message: Optional[ApprovalMessage] = None)

Definition: ApprovalEmailSubscription

Attributes

notification_url class-attribute instance-attribute

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

Gets or sets callback url to flow engine. It is expected as part of request

ApprovalMessage dataclass

ApprovalMessage(to: Optional[str] = None, subject: Optional[str] = None, options: Optional[str] = None, header_text: Optional[str] = None, selection_text: Optional[str] = None, body: Optional[str] = None, importance: Optional[str] = None, attachments: Optional[List[ClientSendAttachment]] = None, use_only_h_t_m_l_message: Optional[bool] = None, hide_h_t_m_l_message: Optional[bool] = None, show_h_t_m_l_confirmation_dialog: Optional[bool] = None)

Definition: ApprovalMessage

Attributes

to class-attribute instance-attribute

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

Specify email addresses separated by semicolons like someone@contoso.com

subject class-attribute instance-attribute

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

Subject

options class-attribute instance-attribute

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

User Options

header_text class-attribute instance-attribute

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

Header text for email body

selection_text class-attribute instance-attribute

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

Header text for users options selection

body class-attribute instance-attribute

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

Body

importance class-attribute instance-attribute

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

Importance

attachments class-attribute instance-attribute

attachments: Optional[List[ClientSendAttachment]] = field(default=None, metadata={'wire_name': 'Attachments'})

Attachments

use_only_h_t_m_l_message class-attribute instance-attribute

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

Use only HTML message

hide_h_t_m_l_message class-attribute instance-attribute

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

If set to Yes, then the email body is hidden and only message card is displayed. Email clients which do not support actionable messages will display HTML message regardless of the parameter value.

show_h_t_m_l_confirmation_dialog class-attribute instance-attribute

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

If set to Yes then a dialog wil be shown to confirm selected option of HTML message

SubscriptionPayloadOutlookReceiveMessage dataclass

SubscriptionPayloadOutlookReceiveMessage(value: Optional[List[SubscriptionPayloadEntityOutlookReceiveMessage]] = None)

Definition: SubscriptionPayload[OutlookReceiveMessage]

Attributes

value class-attribute instance-attribute

value: Optional[List[SubscriptionPayloadEntityOutlookReceiveMessage]] = None

List of values

SubscriptionPayloadEntityOutlookReceiveMessage dataclass

SubscriptionPayloadEntityOutlookReceiveMessage(sequence_number: Optional[int] = None, change_type: Optional[str] = None, client_state: Optional[str] = None, resource: Optional[str] = None, resource_data: Optional[OutlookReceiveMessage] = None)

Definition: SubscriptionPayloadEntity[OutlookReceiveMessage]

Attributes

sequence_number class-attribute instance-attribute

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

Sequence number

change_type class-attribute instance-attribute

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

Change type

client_state class-attribute instance-attribute

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

Client state

resource class-attribute instance-attribute

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

Resource

OutlookReceiveMessage dataclass

OutlookReceiveMessage(internet_message_id: Optional[str] = None, body_preview: Optional[str] = None, id: Optional[str] = None, conversation_id: Optional[str] = None, has_attachments: Optional[bool] = None, is_read: Optional[bool] = None, created_date_time: Optional[str] = None, received_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, attachments: Optional[List[OutlookReceiveAttachment]] = None, to_recipients: Optional[List[Recipient]] = None, cc_recipients: Optional[List[Recipient]] = None, bcc_recipients: Optional[List[Recipient]] = None, reply_to: Optional[List[Recipient]] = None, subject: Optional[str] = None, body: Optional[ItemBody] = None, from_: Optional[Recipient] = None, importance: Optional[str] = None, internet_message_headers: Optional[List[InternetMessageHeader]] = None)

Definition: OutlookReceiveMessage

Attributes

internet_message_id class-attribute instance-attribute

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

Internet Message Id

body_preview class-attribute instance-attribute

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

Body preview

id class-attribute instance-attribute

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

Id

conversation_id class-attribute instance-attribute

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

Conversation Id

has_attachments class-attribute instance-attribute

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

Has attachments

is_read class-attribute instance-attribute

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

Is read

created_date_time class-attribute instance-attribute

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

Created date and time

received_date_time class-attribute instance-attribute

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

Received date and time

last_modified_date_time class-attribute instance-attribute

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

Last modified date and time

attachments class-attribute instance-attribute

attachments: Optional[List[OutlookReceiveAttachment]] = field(default=None, metadata={'wire_name': 'Attachments'})

Attachments

to_recipients class-attribute instance-attribute

to_recipients: Optional[List[Recipient]] = field(default=None, metadata={'wire_name': 'ToRecipients'})

To Recipient

cc_recipients class-attribute instance-attribute

cc_recipients: Optional[List[Recipient]] = field(default=None, metadata={'wire_name': 'CcRecipients'})

Cc Recipients

bcc_recipients class-attribute instance-attribute

bcc_recipients: Optional[List[Recipient]] = field(default=None, metadata={'wire_name': 'BccRecipients'})

Bcc Recipients

reply_to class-attribute instance-attribute

reply_to: Optional[List[Recipient]] = field(default=None, metadata={'wire_name': 'ReplyTo'})

The email addresses to use when replying

subject class-attribute instance-attribute

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

Subject

importance class-attribute instance-attribute

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

Importance

internet_message_headers class-attribute instance-attribute

internet_message_headers: Optional[List[InternetMessageHeader]] = field(default=None, metadata={'wire_name': 'InternetMessageHeaders'})

Internet message headers

OutlookReceiveAttachment dataclass

OutlookReceiveAttachment(type_: Optional[str] = None, id: Optional[str] = None, name: Optional[str] = None, content_bytes: Optional[str] = None, content_type: Optional[str] = None, size: Optional[int] = None, permission: Optional[str] = None, provider_type: Optional[str] = None, source_url: Optional[str] = None, is_inline: Optional[bool] = None, last_modified_date_time: Optional[str] = None, content_id: Optional[str] = None)

Definition: OutlookReceiveAttachment

Attributes

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': '@odata.type'})

OData type

id class-attribute instance-attribute

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

Attachment Id

name class-attribute instance-attribute

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

Attachment name

content_bytes class-attribute instance-attribute

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

Attachment content

content_type class-attribute instance-attribute

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

Attachment content type

size class-attribute instance-attribute

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

Attachment size in bytes

permission class-attribute instance-attribute

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

Permission associated with a reference attachment

provider_type class-attribute instance-attribute

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

Provider for the reference attachment

source_url class-attribute instance-attribute

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

Reference attachment source url

is_inline class-attribute instance-attribute

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

Set to true if this is an inline attachment

last_modified_date_time class-attribute instance-attribute

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

The date and time when the attachment was last modified

content_id class-attribute instance-attribute

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

Content Id

InternetMessageHeader dataclass

InternetMessageHeader(name: Optional[str] = None, value: Optional[str] = None)

Definition: InternetMessageHeader

Attributes

name class-attribute instance-attribute

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

Header name

value class-attribute instance-attribute

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

Header value

SubscriptionPayloadSubscriptionEvent dataclass

SubscriptionPayloadSubscriptionEvent(value: Optional[List[SubscriptionPayloadEntitySubscriptionEvent]] = None)

Definition: SubscriptionPayload[SubscriptionEvent]

Attributes

value class-attribute instance-attribute

value: Optional[List[SubscriptionPayloadEntitySubscriptionEvent]] = None

List of values

SubscriptionPayloadEntitySubscriptionEvent dataclass

SubscriptionPayloadEntitySubscriptionEvent(sequence_number: Optional[int] = None, change_type: Optional[str] = None, client_state: Optional[str] = None, resource: Optional[str] = None, resource_data: Optional[SubscriptionEvent] = None)

Definition: SubscriptionPayloadEntity[SubscriptionEvent]

Attributes

sequence_number class-attribute instance-attribute

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

Sequence number

change_type class-attribute instance-attribute

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

Change type

client_state class-attribute instance-attribute

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

Client state

resource class-attribute instance-attribute

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

Resource

SubscriptionEvent dataclass

SubscriptionEvent(id: Optional[str] = None)

Definition: SubscriptionEvent

Attributes

id class-attribute instance-attribute

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

The Event's unique identifier

Table dataclass

Table(name: Optional[str] = None, display_name: Optional[str] = None, dynamic_properties: Optional[Dict[str, Any]] = None)

Definition: Table

Attributes

name class-attribute instance-attribute

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

The name of the table. The name is used at runtime.

display_name class-attribute instance-attribute

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

The display name of the table.

dynamic_properties class-attribute instance-attribute

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

Additional table properties provided by the connector to the clients.

EntityListResponseCalendarEventBackend dataclass

EntityListResponseCalendarEventBackend(value: Optional[List[CalendarEventBackend]] = None)

Definition: EntityListResponse[CalendarEventBackend]

Attributes

value class-attribute instance-attribute

value: Optional[List[CalendarEventBackend]] = None

List of values

CalendarEventClient dataclass

CalendarEventClient(subject: Optional[str] = None, start: Optional[str] = None, end: Optional[str] = None, time_zone: Optional[str] = None, required_attendees: Optional[str] = None, optional_attendees: Optional[str] = None, resource_attendees: Optional[str] = None, body: Optional[str] = None, is_html: Optional[bool] = None, location: Optional[str] = None, importance: Optional[str] = None, is_all_day: Optional[bool] = None, recurrence: Optional[str] = None, recurrence_end: Optional[str] = None, number_of_occurrences: Optional[int] = None, reminder: Optional[int] = None, show_as: Optional[str] = None, response_requested: Optional[bool] = None)

Definition: CalendarEventClient

Attributes

subject class-attribute instance-attribute

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

Event subject

start class-attribute instance-attribute

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

Start time of the event (example: '2016-11-01T14:30:00Z')

end class-attribute instance-attribute

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

End time of the event (example: '2016-11-01T15:30:00Z')

time_zone class-attribute instance-attribute

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

Time zone of the event

required_attendees class-attribute instance-attribute

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

Required attendees for the event separated by semicolons

optional_attendees class-attribute instance-attribute

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

Optional attendees for the event separated by semicolons

resource_attendees class-attribute instance-attribute

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

Resource attendees for the event separated by semicolons

body class-attribute instance-attribute

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

Body of the message associated with the event

is_html class-attribute instance-attribute

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

Set to true if the body is Html

location class-attribute instance-attribute

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

Location of the event

importance class-attribute instance-attribute

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

The importance of the event: Low, Normal, or High

is_all_day class-attribute instance-attribute

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

Set to true if the event lasts all day

recurrence class-attribute instance-attribute

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

The recurrence pattern for the event

recurrence_end class-attribute instance-attribute

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

End time of the recurrence

number_of_occurrences class-attribute instance-attribute

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

How many times to repeat the event

reminder class-attribute instance-attribute

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

Time in minutes before event start to remind

show_as class-attribute instance-attribute

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

Status to show during the event

response_requested class-attribute instance-attribute

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

Set to true if the sender would like a response when the event is accepted or declined

CalendarEventHtmlClient dataclass

CalendarEventHtmlClient(subject: Optional[str] = None, start: Optional[str] = None, end: Optional[str] = None, time_zone: Optional[str] = None, required_attendees: Optional[str] = None, optional_attendees: Optional[str] = None, resource_attendees: Optional[str] = None, body: Optional[str] = None, location: Optional[str] = None, importance: Optional[str] = None, is_all_day: Optional[bool] = None, recurrence: Optional[str] = None, recurrence_end: Optional[str] = None, number_of_occurrences: Optional[int] = None, reminder: Optional[int] = None, show_as: Optional[str] = None, response_requested: Optional[bool] = None)

Definition: CalendarEventHtmlClient

Attributes

subject class-attribute instance-attribute

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

Event subject

start class-attribute instance-attribute

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

Start time of the event (example: '2016-11-01T14:30:00Z')

end class-attribute instance-attribute

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

End time of the event (example: '2016-11-01T15:30:00Z')

time_zone class-attribute instance-attribute

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

Time zone of the event

required_attendees class-attribute instance-attribute

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

Required attendees for the event separated by semicolons

optional_attendees class-attribute instance-attribute

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

Optional attendees for the event separated by semicolons

resource_attendees class-attribute instance-attribute

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

Resource attendees for the event separated by semicolons

body class-attribute instance-attribute

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

Body of the message associated with the event

location class-attribute instance-attribute

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

Location of the event

importance class-attribute instance-attribute

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

The importance of the event: Low, Normal, or High

is_all_day class-attribute instance-attribute

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

Set to true if the event lasts all day

recurrence class-attribute instance-attribute

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

The recurrence pattern for the event

recurrence_end class-attribute instance-attribute

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

End time of the recurrence

number_of_occurrences class-attribute instance-attribute

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

How many times to repeat the event

reminder class-attribute instance-attribute

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

Time in minutes before event start to remind

show_as class-attribute instance-attribute

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

Status to show during the event

response_requested class-attribute instance-attribute

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

Set to true if the sender would like a response when the event is accepted or declined

CalendarEventClientWithActionType dataclass

CalendarEventClientWithActionType(action_type: Optional[str] = None, is_added: Optional[bool] = None, is_updated: Optional[bool] = None, subject: Optional[str] = None, start: Optional[str] = None, end: Optional[str] = None, show_as: Optional[int] = None, recurrence: Optional[int] = None, response_type: Optional[int] = None, response_time: Optional[str] = None, i_cal_u_id: Optional[str] = None, importance: Optional[int] = None, id: Optional[str] = None, date_time_created: Optional[str] = None, date_time_last_modified: Optional[str] = None, organizer: Optional[str] = None, time_zone: Optional[str] = None, series_master_id: Optional[str] = None, categories: Optional[List[str]] = None, web_link: Optional[str] = None, required_attendees: Optional[str] = None, optional_attendees: Optional[str] = None, resource_attendees: Optional[str] = None, body: Optional[str] = None, is_html: Optional[bool] = None, location: Optional[str] = None, is_all_day: Optional[bool] = None, recurrence_end: Optional[str] = None, number_of_occurrences: Optional[int] = None, reminder: Optional[int] = None, response_requested: Optional[bool] = None)

Definition: CalendarEventClientWithActionType

Attributes

action_type class-attribute instance-attribute

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

Changed action type of the event - added, updated or deleted.

is_added class-attribute instance-attribute

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

Flag that indicates whether the event was added since the last poll of the trigger.

is_updated class-attribute instance-attribute

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

Flag that indicates whether the event was updated since the last poll of the trigger.

subject class-attribute instance-attribute

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

Event subject

start class-attribute instance-attribute

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

Start time of the event (example: '2016-11-01T14:30:00Z')

end class-attribute instance-attribute

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

End time of the event (example: '2016-11-01T15:30:00Z')

show_as class-attribute instance-attribute

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

Status to show during the event (Unknown - -1, Free - 0, Tentative - 1, Busy - 2, Oof - 3, WorkingElsewhere - 4)

recurrence class-attribute instance-attribute

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

The recurrence pattern for the event (None - 0, Daily - 1, Weekly - 2, Monthly - 3, Yearly - 4)

response_type class-attribute instance-attribute

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

The response type of the event (None - 0, Organizer - 1, TentativelyAccepted - 2, Accepted - 3, Declined - 4, NotResponded - 5)

response_time class-attribute instance-attribute

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

The response time of the event

i_cal_u_id class-attribute instance-attribute

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

A unique identifier that is shared by all instances of an event across different calendars

importance class-attribute instance-attribute

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

The importance of the event (0 - Low, 1 - Normal, 2 - High)

id class-attribute instance-attribute

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

The event's unique identifier

date_time_created class-attribute instance-attribute

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

The date and time that the event was created

date_time_last_modified class-attribute instance-attribute

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

The date and time that the event was last modified

organizer class-attribute instance-attribute

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

The organizer of the event

time_zone class-attribute instance-attribute

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

Time zone of the event

series_master_id class-attribute instance-attribute

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

Unique identifier for Series Master event type

categories class-attribute instance-attribute

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

The categories associated with the event

web_link class-attribute instance-attribute

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

The URL to open the event in Outlook Web App

required_attendees class-attribute instance-attribute

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

Required attendees for the event separated by semicolons

optional_attendees class-attribute instance-attribute

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

Optional attendees for the event separated by semicolons

resource_attendees class-attribute instance-attribute

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

Resource attendees for the event separated by semicolons

body class-attribute instance-attribute

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

Body of the message associated with the event

is_html class-attribute instance-attribute

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

Set to true if the body is Html

location class-attribute instance-attribute

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

Location of the event

is_all_day class-attribute instance-attribute

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

Set to true if the event lasts all day

recurrence_end class-attribute instance-attribute

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

End time of the recurrence

number_of_occurrences class-attribute instance-attribute

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

How many times to repeat the event

reminder class-attribute instance-attribute

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

Time in minutes before event start to remind

response_requested class-attribute instance-attribute

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

Set to true if the sender would like a response when the event is accepted or declined

Contact dataclass

Contact(id: Optional[str] = None, parent_folder_id: Optional[str] = None, birthday: Optional[str] = None, file_as: Optional[str] = None, display_name: Optional[str] = None, given_name: Optional[str] = None, initials: Optional[str] = None, middle_name: Optional[str] = None, nick_name: Optional[str] = None, surname: Optional[str] = None, title: Optional[str] = None, generation: Optional[str] = None, email_addresses: Optional[List[EmailAddress]] = None, im_addresses: Optional[List[str]] = None, job_title: Optional[str] = None, company_name: Optional[str] = None, department: Optional[str] = None, office_location: Optional[str] = None, profession: Optional[str] = None, business_home_page: Optional[str] = None, assistant_name: Optional[str] = None, manager: Optional[str] = None, home_phones: Optional[List[str]] = None, business_phones: Optional[List[str]] = None, mobile_phone1: Optional[str] = None, home_address: Optional[PhysicalAddress] = None, business_address: Optional[PhysicalAddress] = None, other_address: Optional[PhysicalAddress] = None, yomi_company_name: Optional[str] = None, yomi_given_name: Optional[str] = None, yomi_surname: Optional[str] = None, categories: Optional[List[str]] = None, change_key: Optional[str] = None, date_time_created: Optional[str] = None, date_time_last_modified: Optional[str] = None)

Definition: Contact

Attributes

id class-attribute instance-attribute

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

The contact's unique identifier.

parent_folder_id class-attribute instance-attribute

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

The ID of the contact's parent folder

birthday class-attribute instance-attribute

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

The contact's birthday

file_as class-attribute instance-attribute

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

The name the contact is filed under

display_name class-attribute instance-attribute

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

The contact's display name

given_name class-attribute instance-attribute

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

The contact's given name

initials class-attribute instance-attribute

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

The contact's initials

middle_name class-attribute instance-attribute

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

The contact's middle name

nick_name class-attribute instance-attribute

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

The contact's nickname

surname class-attribute instance-attribute

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

The contact's surname

title class-attribute instance-attribute

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

The contact's title

generation class-attribute instance-attribute

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

The contact's generation

email_addresses class-attribute instance-attribute

email_addresses: Optional[List[EmailAddress]] = field(default=None, metadata={'wire_name': 'EmailAddresses'})

The contact's email addresses

im_addresses class-attribute instance-attribute

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

The contact's instant messaging (IM) addresses

job_title class-attribute instance-attribute

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

The contact's job title

company_name class-attribute instance-attribute

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

The name of the contact's company

department class-attribute instance-attribute

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

The contact's department

office_location class-attribute instance-attribute

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

The location of the contact's office

profession class-attribute instance-attribute

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

The contact's profession

business_home_page class-attribute instance-attribute

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

The business home page of the contact

assistant_name class-attribute instance-attribute

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

The name of the contact's assistant

manager class-attribute instance-attribute

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

The name of the contact's manager

home_phones class-attribute instance-attribute

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

The contact's home phone numbers

business_phones class-attribute instance-attribute

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

The contact's business phone numbers

mobile_phone1 class-attribute instance-attribute

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

The contact's mobile phone number

yomi_company_name class-attribute instance-attribute

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

The phonetic Japanese company name of the contact

yomi_given_name class-attribute instance-attribute

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

The phonetic Japanese given name (first name) of the contact

yomi_surname class-attribute instance-attribute

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

The phonetic Japanese surname (last name) of the contact

categories class-attribute instance-attribute

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

The categories associated with the contact

change_key class-attribute instance-attribute

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

Identifies the version of the event object

date_time_created class-attribute instance-attribute

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

The time the contact was created

date_time_last_modified class-attribute instance-attribute

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

The time the contact was modified

DataSetsList dataclass

DataSetsList(value: Optional[List[DataSet]] = None)

Definition: DataSetsList

Attributes

value class-attribute instance-attribute

value: Optional[List[DataSet]] = None

List of datasets

DataSet dataclass

DataSet(name: Optional[str] = None, display_name: Optional[str] = None, query: Optional[List[PassThroughNativeQuery]] = None)

Definition: DataSet

Attributes

name class-attribute instance-attribute

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

Dataset name

display_name class-attribute instance-attribute

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

Dataset display name

query class-attribute instance-attribute

query: Optional[List[PassThroughNativeQuery]] = None

Pass-through Native Queries

Procedure dataclass

Procedure(name: Optional[str] = None, display_name: Optional[str] = None)

Definition: Procedure

Attributes

name class-attribute instance-attribute

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

Procedure name

display_name class-attribute instance-attribute

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

Procedure display name

PassThroughNativeQuery dataclass

PassThroughNativeQuery(language: Optional[str] = None)

Definition: PassThroughNativeQuery

Attributes

language class-attribute instance-attribute

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

Query language

ResponseToEventInvite dataclass

ResponseToEventInvite(comment: Optional[str] = None, send_response: Optional[bool] = None)

Definition: ResponseToEventInvite

Attributes

comment class-attribute instance-attribute

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

Comment

send_response class-attribute instance-attribute

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

Send response to organizer?

DirectForwardMessage dataclass

DirectForwardMessage(comment: Optional[str] = None, to_recipients: Optional[str] = None)

Definition: DirectForwardMessage

Attributes

comment class-attribute instance-attribute

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

Comment

to_recipients class-attribute instance-attribute

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

Semicolon separated list of recipients to forward the message to

OutlookClient

OutlookClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for outlook connector.

Initialize a OutlookClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

get_email_async async

get_email_async(message_id: str, include_attachments: Optional[bool] = None, internet_message_id: Optional[str] = None) -> dict[str, Any] | None

Get email

This operation gets an email by id.

delete_email_async async

delete_email_async(message_id: str) -> None

Delete email

This operation deletes an email by id.

move_async async

move_async(message_id: str, folder_path: str) -> dict[str, Any] | None

Move email

This operation moves an email to the specified folder.

flag_async async

flag_async(message_id: str) -> None

Flag email

This operation flags an email.

mark_as_read_async async

mark_as_read_async(message_id: str) -> None

Mark as read

This operation marks an email as having been read.

get_attachment_async async

get_attachment_async(message_id: str, attachment_id: str) -> bytes

Get attachment

This operation gets an email attachment by id.

send_mail_with_options_async async

send_mail_with_options_async(input: OptionsEmailSubscription) -> dict[str, Any] | None

Send email with options

This operation sends an email with multiple options and waits for the recipient to respond back with one of the options. Please refer to the following link regarding the support of actionable messages in different mail clients: https://docs.microsoft.com/outlook/actionable-messages/#outlook-version-requirements-for-actionable-messages.

send_approval_mail_async async

send_approval_mail_async(input: ApprovalEmailSubscription) -> dict[str, Any] | None

Send approval email

This operation sends an approval email and waits for a response from the recipient. Please refer to the following link regarding the support of actionable messages in different mail clients: https://docs.microsoft.com/outlook/actionable-messages/#outlook-version-requirements-for-actionable-messages.

calendar_get_tables_async async

calendar_get_tables_async() -> dict[str, Any] | None

Get calendars

This operation lists available calendars.

calendar_delete_item_async async

calendar_delete_item_async(table: str, id: str) -> None

Delete event

This operation deletes an event in a calendar.

contact_get_tables_async async

contact_get_tables_async() -> dict[str, Any] | None

Get contact folders

This operation lists available contacts folders.

contact_get_items_async async

contact_get_items_async(table: str, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None) -> dict[str, Any] | None

Get contacts

This operation gets contacts from a contacts folder.

contact_post_item_async async

contact_post_item_async(input: Contact, table: str) -> dict[str, Any] | None

Create contact

This operation creates a new contact in a contacts folder.

contact_get_item_async async

contact_get_item_async(table: str, id: str) -> dict[str, Any] | None

Get contact

This operation gets a specific contact from a contacts folder.

contact_delete_item_async async

contact_delete_item_async(table: str, id: str) -> None

Delete contact

This operation deletes a contact from a contacts folder.

contact_patch_item_async async

contact_patch_item_async(input: Contact, table: str, id: str) -> dict[str, Any] | None

Update contact

This operation updates a contact in a contacts folder.

respond_to_event_async async

respond_to_event_async(input: ResponseToEventInvite, event_id: str, response: str) -> None

Respond to an event invite

Respond to an event invite.

forward_email_async async

forward_email_async(input: DirectForwardMessage, message_id: str) -> None

Forward an email

Forward an email.

calendar_get_item_async async

calendar_get_item_async(table: str, id: str) -> dict[str, Any] | None

Get event

This operation gets a specific event from a calendar.

calendar_get_items_async async

calendar_get_items_async(table: str, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None) -> dict[str, Any] | None

Get events

This operation gets events from a calendar.

calendar_patch_item_async async

calendar_patch_item_async(input: CalendarEventHtmlClient, table: str, id: str) -> dict[str, Any] | None

Update event

This operation updates an event in a calendar.

calendar_post_item_async async

calendar_post_item_async(input: CalendarEventHtmlClient, table: str) -> dict[str, Any] | None

Create event

This operation creates a new event in a calendar.

get_emails_async async

get_emails_async(folder_path: Optional[str] = None, to: Optional[str] = None, cc: Optional[str] = None, to_or_cc: Optional[str] = None, from_: Optional[str] = None, importance: Optional[str] = None, fetch_only_with_attachment: Optional[bool] = None, subject_filter: Optional[str] = None, fetch_only_unread: Optional[bool] = None, include_attachments: Optional[bool] = None, search_query: Optional[str] = None, top: Optional[int] = None) -> dict[str, Any] | None

Get emails

This operation gets emails from a folder.

get_events_calendar_view_async async

get_events_calendar_view_async(calendar_id: str, start_date_time_offset: str, end_date_time_offset: str, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, search: Optional[str] = None) -> dict[str, Any] | None

Get calendar view of events

This operation gets all events (including instances of recurrences) in a calendar.

reply_to_async async

reply_to_async(input: ReplyHtmlMessage, message_id: str) -> None

Reply to email

This operation replies to an email.

send_email_async async

send_email_async(input: ClientSendHtmlMessage) -> None

Send an email

This operation sends an email message.