Office365-REST-Python-Client 2.5.1__py3-none-any.whl → 2.5.3__py3-none-any.whl

office365/onenote/sectiongroups/section_group.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity_collection import EntityCollection
 from office365.onenote.entity_hierarchy_model import OnenoteEntityHierarchyModel
 from office365.onenote.notebooks.notebook import Notebook
@@ -10,22 +12,21 @@ class SectionGroup(OnenoteEntityHierarchyModel):
 
     @property
     def section_groups_url(self):
-        """The URL for the sectionGroups navigation property, which returns all the section groups in the section group.
-
-        :rtype: str or None
+        # type: () -> Optional[str]
+        """
+        The URL for the sectionGroups navigation property, which returns all the section groups in the section group.
         """
         return self.properties.get("sectionGroupsUrl", None)
 
     @property
     def sections_url(self):
-        """The URL for the sections navigation property, which returns all the sections in the section group.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The URL for the sections navigation property, which returns all the sections in the section group."""
         return self.properties.get("sectionsUrl", None)
 
     @property
     def parent_notebook(self):
+        # type: () -> Notebook
         """The notebook that contains the section group. Read-only."""
         return self.properties.get(
             "parentNotebook",
@@ -34,6 +35,7 @@ class SectionGroup(OnenoteEntityHierarchyModel):
 
     @property
     def sections(self):
+        # type: () -> EntityCollection[OnenoteSection]
         """The sections in the section group. Read-only. Nullable."""
         return self.properties.get(
             "sections",
@@ -46,6 +48,7 @@ class SectionGroup(OnenoteEntityHierarchyModel):
 
     @property
     def section_groups(self):
+        # type: () -> EntityCollection[SectionGroup]
         """Retrieve a list of onenoteSection objects from the specified notebook."""
         return self.properties.get(
             "sectionGroups",

office365/onenote/sections/section.py

@@ -59,7 +59,7 @@ class OnenoteSection(OnenoteEntityHierarchyModel):
         """
         The collection of pages in the section. Read-only. Nullable.
         """
-        from office365.onenote.pages.page import OnenotePage
+        from office365.onenote.pages.page import OnenotePage  # noqa
 
         return self.properties.get(
             "pages",

office365/outlook/calendar/attendees/base.py

@@ -7,7 +7,8 @@ class AttendeeBase(Recipient):
     def __init__(self, email_address=None, attendee_type=None):
         """
 
-        :param office365.mail.emailAddress.EmailAddress email_address: Includes the name and SMTP address of the attendees
+        :param office365.mail.emailAddress.EmailAddress email_address: Includes the name and SMTP address of the
+            attendees
         :param str attendee_type: The type of attendees. The possible values are: required, optional, resource.
             Currently if the attendees is a person, findMeetingTimes always considers the person is of the Required type.
         """

office365/outlook/calendar/calendar.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.directory.extensions.extended_property import (
     MultiValueLegacyExtendedProperty,
     SingleValueLegacyExtendedProperty,
@@ -25,6 +27,9 @@ class Calendar(Entity):
         of a Microsoft 365 group.
     """
 
+    def __repr__(self):
+        return self.name or self.id or self.entity_type_name
+
     def allowed_calendar_sharing_roles(self, user):
         """
         :param str user: User identifier or principal name
@@ -74,62 +79,62 @@ class Calendar(Entity):
 
     @property
     def can_edit(self):
+        # type: () -> Optional[bool]
         """
         true if the user can write to the calendar, false otherwise.
         This property is true for the user who created the calendar.
         This property is also true for a user who has been shared a calendar and granted write access.
-        :rtype: bool or None
         """
         return self.properties.get("canEdit", None)
 
     @property
     def can_share(self):
+        # type: () -> Optional[bool]
         """
         true if the user has the permission to share the calendar, false otherwise.
         Only the user who created the calendar can share it.
-        :rtype: bool or None
         """
         return self.properties.get("canShare", None)
 
     @property
     def can_view_private_items(self):
+        # type: () -> Optional[bool]
         """
         true if the user can read calendar items that have been marked private, false otherwise.
-        :rtype: bool or None
         """
         return self.properties.get("canViewPrivateItems", None)
 
     @property
     def change_key(self):
+        # type: () -> Optional[str]
         """
         Identifies the version of the calendar object. Every time the calendar is changed, changeKey changes as well.
         This allows Exchange to apply changes to the correct version of the object.
-        :rtype: str
         """
         return self.properties.get("changeKey", None)
 
     @property
     def color(self):
+        # type: () -> Optional[str]
         """
         Specifies the color theme to distinguish the calendar from other calendars in a UI.
         The property values are: auto, lightBlue, lightGreen, lightOrange, lightGray, lightYellow, lightTeal,
         lightPink, lightBrown, lightRed, maxColor.
-        :rtype: str
         """
         return self.properties.get("color", None)
 
     @property
     def default_online_meeting_provider(self):
+        # type: () -> Optional[str]
         """
         The default online meeting provider for meetings sent from this calendar.
         Possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness.
-        :rtype: str
         """
         return self.properties.get("defaultOnlineMeetingProvider", None)
 
     @property
     def name(self):
-        # type: () -> str
+        # type: () -> Optional[str]
         """
         The calendar name
         """
@@ -137,26 +142,26 @@ class Calendar(Entity):
 
     @property
     def is_default_calendar(self):
+        # type: () -> Optional[bool]
         """
         true if this is the default calendar where new events are created by default, false otherwise.
-        :rtype: bool or None
         """
         return self.properties.get("isDefaultCalendar", None)
 
     @property
     def is_removable(self):
+        # type: () -> Optional[bool]
         """
         Indicates whether this user calendar can be deleted from the user mailbox.
-        :rtype: bool or None
         """
         return self.properties.get("isRemovable", None)
 
     @property
     def is_tallying_responses(self):
+        # type: () -> Optional[bool]
         """
         Indicates whether this user calendar supports tracking of meeting responses.
         Only meeting invites sent from users' primary calendars support tracking of meeting responses.
-        :rtype: bool or None
         """
         return self.properties.get("isTallyingResponses", None)
 
@@ -179,6 +184,7 @@ class Calendar(Entity):
 
     @property
     def calendar_view(self):
+        # type: () -> EventCollection
         """The calendar view for the calendar. Navigation property. Read-only."""
         return self.properties.get(
             "calendarView",
@@ -199,6 +205,7 @@ class Calendar(Entity):
 
     @property
     def multi_value_extended_properties(self):
+        # type: () -> EntityCollection[MultiValueLegacyExtendedProperty]
         """The collection of multi-value extended properties defined for the Calendar."""
         return self.properties.get(
             "multiValueExtendedProperties",
@@ -211,6 +218,7 @@ class Calendar(Entity):
 
     @property
     def single_value_extended_properties(self):
+        # type: () -> EntityCollection[SingleValueLegacyExtendedProperty]
         """The collection of single-value extended properties defined for the calendar. Read-only. Nullable."""
         return self.properties.get(
             "singleValueExtendedProperties",

office365/outlook/calendar/events/collection.py

@@ -1,8 +1,6 @@
 import datetime
 from typing import List
 
-from typing_extensions import Self
-
 from office365.delta_collection import DeltaCollection
 from office365.outlook.calendar.attendees.attendee import Attendee
 from office365.outlook.calendar.dateTimeTimeZone import DateTimeTimeZone

office365/outlook/calendar/group.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.outlook.calendar.calendar import Calendar
@@ -11,22 +13,19 @@ class CalendarGroup(Entity):
 
     @property
     def name(self):
-        """
-        The group name.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """The group name"""
         return self.properties.get("name", None)
 
     @property
     def class_id(self):
-        """
-        The class identifier
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """The class identifier"""
         return self.properties.get("classId", None)
 
     @property
     def calendars(self):
+        # type: () -> EntityCollection[Calendar]
         """The calendars in the calendar group. Navigation property. Read-only. Nullable."""
         return self.properties.get(
             "calendars",

office365/outlook/calendar/meetingtimes/suggestion.py

@@ -18,13 +18,14 @@ class MeetingTimeSuggestion(ClientValue):
         locations=None,
         meeting_timeslot=TimeSlot(),
     ):
+        # type: (list[AttendeeAvailability], float, list[Location], TimeSlot) -> None
         """
-        :param list[AttendeeAvailability] attendee_availability: An array that shows the availability status of each
+        :param attendee_availability: An array that shows the availability status of each
             attendees for this meeting suggestion.
-        :param float confidence: A percentage that represents the likelhood of all the attendees attending.
-        :param list[Location] locations: An array that specifies the name and geographic location of each meeting location
+        :param confidence: A percentage that represents the likelhood of all the attendees attending.
+        :param locations: An array that specifies the name and geographic location of each meeting location
              for this meeting suggestion.
-        :param TimeSlot meeting_timeslot: A time period suggested for the meeting.
+        :param meeting_timeslot: A time period suggested for the meeting.
         """
         self.attendeeAvailability = ClientValueCollection(
             AttendeeAvailability, attendee_availability
@@ -32,3 +33,6 @@ class MeetingTimeSuggestion(ClientValue):
         self.confidence = confidence
         self.locations = ClientValueCollection(Location, locations)
         self.meetingTimeSlot = meeting_timeslot
+
+    def __repr__(self):
+        return repr(self.meetingTimeSlot)

office365/outlook/calendar/meetingtimes/time_slot.py

@@ -14,3 +14,6 @@ class TimeSlot(ClientValue):
         super(TimeSlot, self).__init__()
         self.start = start
         self.end = end
+
+    def __repr__(self):
+        return "({0} - {1})".format(self.start, self.end)

office365/outlook/calendar/permissions/collection.py

@@ -3,7 +3,7 @@ from office365.outlook.calendar.email_address import EmailAddress
 from office365.outlook.calendar.permissions.permission import CalendarPermission
 
 
-class CalendarPermissionCollection(EntityCollection):
+class CalendarPermissionCollection(EntityCollection[CalendarPermission]):
     def __init__(self, context, resource_path=None):
         super(CalendarPermissionCollection, self).__init__(
             context, CalendarPermission, resource_path

office365/outlook/calendar/rooms/list.py

@@ -0,0 +1,27 @@
+from typing import Optional
+
+from office365.entity_collection import EntityCollection
+from office365.outlook.calendar.place import Place
+from office365.outlook.calendar.rooms.room import Room
+from office365.runtime.paths.resource_path import ResourcePath
+
+
+class RoomList(Place):
+    """Represents a group of room objects defined in the tenant."""
+
+    @property
+    def email_address(self):
+        # type: () -> Optional[str]
+        """The email address of the room list"""
+        return self.properties.get("emailAddress", None)
+
+    @property
+    def calendars(self):
+        # type: () -> EntityCollection[Room]
+        """The calendars in the calendar group. Navigation property. Read-only. Nullable."""
+        return self.properties.get(
+            "rooms",
+            EntityCollection(
+                self.context, Room, ResourcePath("rooms", self.resource_path)
+            ),
+        )

office365/outlook/calendar/rooms/room.py

@@ -0,0 +1,8 @@
+from office365.outlook.calendar.place import Place
+
+
+class Room(Place):
+    """
+    Represents a room in a tenant.
+    In Exchange Online, each room is associated with a room mailbox. Derived from place.
+    """

office365/outlook/calendar/schedule/information.py

@@ -17,7 +17,6 @@ class ScheduleInformation(ClientValue):
         working_hours=WorkingHours(),
     ):
         """
-
         :param WorkingHours working_hours: The days of the week and hours in a specific time zone that the user works.
              These are set as part of the user's mailboxSettings.
         :param str error: Error information from attempting to get the availability of the user, distribution list,

office365/outlook/contacts/collection.py

@@ -18,7 +18,6 @@ class ContactCollection(DeltaCollection[Contact]):
         :param str surname: The contact's surname.
         :param str email_address: Default email address
         :param str business_phone: Default contact's business phone number.
-        :rtype: Contact
         """
 
         def _create_email_address(address):
@@ -33,10 +32,3 @@ class ContactCollection(DeltaCollection[Contact]):
         if business_phone:
             kwargs["businessPhones"] = StringCollection([business_phone])
         return super(ContactCollection, self).add(**kwargs)
-
-    def __getitem__(self, key):
-        """
-        :param int or str key: Contact identifier or index
-        :rtype: Contact
-        """
-        return super(ContactCollection, self).__getitem__(key)

office365/outlook/contacts/contact.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.directory.extensions.extended_property import (
     MultiValueLegacyExtendedProperty,
     SingleValueLegacyExtendedProperty,
@@ -23,45 +25,39 @@ class Contact(OutlookItem):
 
     @property
     def display_name(self):
+        # type: () -> Optional[str]
         """
         The contact's display name. You can specify the display name in a create or update operation.
         Note that later updates to other properties may cause an automatically generated value to overwrite the
         displayName value you have specified. To preserve a pre-existing value, always include it as displayName
         in an update operation.
-        :rtype: str or None
         """
         return self.properties.get("displayName", None)
 
     @property
     def manager(self):
+        # type: () -> Optional[str]
         """
         The name of the contact's manager.
-        :rtype: str or None
         """
         return self.properties.get("manager", None)
 
     @manager.setter
     def manager(self, value):
-        """
-        Sets name of the contact's manager.
-        :type value: str
-        """
+        # type: (str) -> None
+        """Sets name of the contact's manager."""
         self.set_property("manager", value)
 
     @property
     def mobile_phone(self):
-        """
-        The contact's mobile phone number.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The contact's mobile phone number."""
         return self.properties.get("mobilePhone", None)
 
     @mobile_phone.setter
     def mobile_phone(self, value):
-        """
-        Sets contact's mobile phone number.
-        :type value: str
-        """
+        # type: (str) -> None
+        """Sets contact's mobile phone number."""
         self.set_property("mobilePhone", value)
 
     @property
@@ -71,6 +67,7 @@ class Contact(OutlookItem):
 
     @property
     def email_addresses(self):
+        # type: () -> ClientValueCollection[EmailAddress]
         """The contact's email addresses."""
         return self.properties.setdefault(
             "emailAddresses", ClientValueCollection(EmailAddress)
@@ -78,6 +75,7 @@ class Contact(OutlookItem):
 
     @property
     def extensions(self):
+        # type: () -> EntityCollection[Extension]
         """The collection of open extensions defined for the contact. Nullable."""
         return self.properties.get(
             "extensions",
@@ -96,6 +94,7 @@ class Contact(OutlookItem):
 
     @property
     def multi_value_extended_properties(self):
+        # type: () -> EntityCollection[MultiValueLegacyExtendedProperty]
         """The collection of multi-value extended properties defined for the Contact."""
         return self.properties.get(
             "multiValueExtendedProperties",
@@ -108,6 +107,7 @@ class Contact(OutlookItem):
 
     @property
     def single_value_extended_properties(self):
+        # type: () -> EntityCollection[SingleValueLegacyExtendedProperty]
         """The collection of single-value extended properties defined for the Contact."""
         return self.properties.get(
             "singleValueExtendedProperties",

office365/outlook/contacts/folder.py

@@ -24,6 +24,7 @@ class ContactFolder(Entity):
 
     @property
     def child_folders(self):
+        # type: () -> EntityCollection["ContactFolder"]
         """The collection of child folders in the folder. Navigation property. Read-only. Nullable."""
         return self.properties.get(
             "childFolders",
@@ -36,6 +37,7 @@ class ContactFolder(Entity):
 
     @property
     def multi_value_extended_properties(self):
+        # type: () -> EntityCollection[MultiValueLegacyExtendedProperty]
         """The collection of multi-value extended properties defined for the Contact folder."""
         return self.properties.get(
             "multiValueExtendedProperties",
@@ -48,6 +50,7 @@ class ContactFolder(Entity):
 
     @property
     def single_value_extended_properties(self):
+        # type: () -> EntityCollection[SingleValueLegacyExtendedProperty]
         """The collection of single-value extended properties defined for the Contact folder."""
         return self.properties.get(
             "singleValueExtendedProperties",

office365/outlook/mail/attachments/attachment.py

@@ -1,3 +1,8 @@
+import datetime
+from typing import IO, AnyStr, Optional
+
+from typing_extensions import Self
+
 from office365.entity import Entity
 from office365.runtime.client_result import ClientResult
 from office365.runtime.queries.function import FunctionQuery
@@ -6,22 +11,23 @@ from office365.runtime.queries.function import FunctionQuery
 class Attachment(Entity):
     """A file or item (contact, event or message) attached to an event or message."""
 
-    def download(self, file_object):
-        """Downloads raw contents of a file or item attachment
+    def __repr__(self):
+        return self.name or self.id
 
-        :type file_object: typing.IO
-        """
+    def download(self, file_object):
+        # type: (IO) -> Self
+        """Downloads raw contents of a file or item attachment"""
 
         def _save_content(return_type):
+            # type: (ClientResult[AnyStr]) -> None
             file_object.write(return_type.value)
 
         self.get_content().after_execute(_save_content)
         return self
 
     def get_content(self):
-        """
-        Gets the raw contents of a file or item attachment
-        """
+        # type: () -> ClientResult[AnyStr]
+        """Gets the raw contents of a file or item attachment"""
         return_type = ClientResult(self.context)
         qry = FunctionQuery(self, "$value", None, return_type)
         self.context.add_query(qry)
@@ -29,47 +35,41 @@ class Attachment(Entity):
 
     @property
     def name(self):
-        """
-        The attachment's file name.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The attachment's file name."""
         return self.properties.get("name", None)
 
     @name.setter
     def name(self, value):
-        """
-        Sets the attachment's file name.
-        :type: value: str
-        """
+        # type: (str) -> None
+        """Sets the attachment's file name."""
         self.set_property("name", value)
 
     @property
     def content_type(self):
-        """
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
         return self.properties.get("contentType", None)
 
     @content_type.setter
     def content_type(self, value):
-        """
-        :type: value: str
-        """
+        # type: (str) -> None
         self.set_property("contentType", value)
 
     @property
     def size(self):
-        """
-
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
         return self.properties.get("size", None)
 
     @property
-    def last_modified_date_time(self):
-        """
-        The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
+    def last_modified_datetime(self):
+        # type: () -> Optional[datetime.datetime]
+        """The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time."""
+        return self.properties.get("lastModifiedDateTime", datetime.datetime.min)
 
-        :rtype: int or None
-        """
-        return self.properties.get("lastModifiedDateTime", None)
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "lastModifiedDateTime": self.last_modified_datetime,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(Attachment, self).get_property(name, default_value)

office365/outlook/mail/attachments/collection.py

@@ -1,10 +1,11 @@
 import base64
 
+import requests
+
 from office365.entity_collection import EntityCollection
-from office365.outlook.internal.queries.attachment_upload import (
-    create_attachment_upload_query,
-)
 from office365.outlook.mail.attachments.attachment import Attachment
+from office365.runtime.compat import parse_query_string
+from office365.runtime.odata.v4.upload_session_request import UploadSessionRequest
 from office365.runtime.queries.upload_session import UploadSessionQuery
 
 
@@ -49,14 +50,41 @@ class AttachmentCollection(EntityCollection[Attachment]):
         :param int chunk_size: File chunk size
         :param (int)->None chunk_uploaded: Upload action
         """
+        from office365.outlook.mail.attachments.attachment_item import AttachmentItem
         from office365.outlook.mail.attachments.file import FileAttachment
 
         return_type = FileAttachment(self.context)
         self.add_child(return_type)
-        qry = create_attachment_upload_query(
-            self, return_type, source_path, chunk_size, chunk_uploaded
+
+        qry = UploadSessionQuery(
+            self, {"AttachmentItem": AttachmentItem.create_file(source_path)}
+        )
+
+        def _start_upload():
+            with open(source_path, "rb") as local_file:
+                session_request = UploadSessionRequest(
+                    local_file, chunk_size, chunk_uploaded
+                )
+
+                def _construct_request(request):
+                    auth_token = parse_query_string(request.url, "authtoken")
+                    request.set_header("Authorization", "Bearer {0}".format(auth_token))
+
+                def _process_response(response):
+                    # type: (requests.Response) -> None
+                    location = response.headers.get("Location", None)
+                    if location is None:
+                        return
+                    attachment_id = location[location.find("Attachments(") + 13 : -2]
+                    return_type.set_property("id", attachment_id)
+
+                session_request.beforeExecute += _construct_request
+                session_request.afterExecute += _process_response
+                session_request.execute_query(qry)
+
+        self.context.add_query(qry).after_query_execute(
+            _start_upload, execute_first=True
         )
-        self.context.add_query(qry)
         return self
 
     def create_upload_session(self, attachment_item):