Office365-REST-Python-Client 2.5.2__py3-none-any.whl → 2.5.4__py3-none-any.whl

office365/directory/serviceprincipals/service_principal.py

@@ -28,6 +28,9 @@ from office365.runtime.types.collections import StringCollection
 class ServicePrincipal(DirectoryObject):
     """Represents an instance of an application in a directory."""
 
+    def __str__(self):
+        return self.display_name
+
     def add_key(self, key_credential, password_credential, proof):
         """
         Adds a key credential to a servicePrincipal. This method along with removeKey can be used by a servicePrincipal
@@ -185,9 +188,7 @@ class ServicePrincipal(DirectoryObject):
     @property
     def app_display_name(self):
         # type: () -> Optional[str]
-        """
-        The display name exposed by the associated application.
-        """
+        """The display name exposed by the associated application."""
         return self.properties.get("appDisplayName", None)
 
     @property
@@ -209,12 +210,16 @@ class ServicePrincipal(DirectoryObject):
         """
         return self.properties.get("appRoles", AppRoleCollection())
 
+    @property
+    def display_name(self):
+        # type: () -> Optional[str]
+        """The display name."""
+        return self.properties.get("displayName", None)
+
     @property
     def homepage(self):
         # type: () -> Optional[str]
-        """
-        Home page or landing page of the application.
-        """
+        """Home page or landing page of the application"""
         return self.properties.get("homepage", None)
 
     @property

office365/directory/users/user.py

@@ -55,8 +55,8 @@ from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.http.http_method import HttpMethod
 from office365.runtime.http.request_options import RequestOptions
-from office365.runtime.paths.entity import EntityPath
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.paths.v4.entity import EntityPath
 from office365.runtime.queries.create_entity import CreateEntityQuery
 from office365.runtime.queries.function import FunctionQuery
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -71,6 +71,9 @@ from office365.todo.todo import Todo
 class User(DirectoryObject):
     """Represents an Azure AD user account. Inherits from directoryObject."""
 
+    def __repr__(self):
+        return self.user_principal_name or self.id or self.entity_type_name
+
     def add_extension(self, name):
         """
         Creates an open extension (openTypeExtension object) and add custom properties in a new or existing instance
@@ -621,9 +624,7 @@ class User(DirectoryObject):
 
     @property
     def photo(self):
-        """
-        The user's profile photo. Read-only.
-        """
+        """The user's profile photo. Read-only."""
         return self.properties.get(
             "photo",
             ProfilePhoto(self.context, ResourcePath("photo", self.resource_path)),
@@ -631,9 +632,7 @@ class User(DirectoryObject):
 
     @property
     def manager(self):
-        """
-        The user or contact that is this user's manager
-        """
+        """The user or contact that is this user's manager"""
         return self.properties.get(
             "manager",
             DirectoryObject(self.context, ResourcePath("manager", self.resource_path)),
@@ -641,17 +640,15 @@ class User(DirectoryObject):
 
     @property
     def preferred_language(self):
+        # type: () -> Optional[str]
         """
         The preferred language for the user. Should follow ISO 639-1 Code; for example en-US.
-        :rtype: str or None
         """
         return self.properties.get("preferredLanguage", None)
 
     @property
     def mailbox_settings(self):
-        """
-        Get the user's mailboxSettings.
-        """
+        """Get the user's mailboxSettings."""
         return self.properties.get("mailboxSettings", MailboxSettings())
 
     @property

office365/entity.py

@@ -3,8 +3,8 @@ from typing import TYPE_CHECKING, Optional, TypeVar
 from typing_extensions import Self
 
 from office365.runtime.client_object import ClientObject
-from office365.runtime.paths.entity import EntityPath
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.paths.v4.entity import EntityPath
 from office365.runtime.queries.delete_entity import DeleteEntityQuery
 from office365.runtime.queries.update_entity import UpdateEntityQuery
 
@@ -72,5 +72,5 @@ class Entity(ClientObject[T]):
                         value, self.parent_collection.resource_path
                     )
             else:
-                self._resource_path.patch(value, inplace=True)
+                self._resource_path.patch(value)
         return self

office365/entity_collection.py

@@ -5,6 +5,7 @@ from office365.runtime.client_object_collection import ClientObjectCollection
 from office365.runtime.compat import is_string_type
 from office365.runtime.paths.item import ItemPath
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.paths.v4.entity import EntityPath
 from office365.runtime.queries.create_entity import CreateEntityQuery
 
 if TYPE_CHECKING:
@@ -32,7 +33,7 @@ class EntityCollection(ClientObjectCollection[T]):
             return super(EntityCollection, self).__getitem__(key)
         elif is_string_type(key):
             return self.create_typed_object(
-                resource_path=ResourcePath(key, self.resource_path)
+                resource_path=EntityPath(key, self.resource_path)
             )
         else:
             raise ValueError(
@@ -41,15 +42,21 @@ class EntityCollection(ClientObjectCollection[T]):
 
     def add(self, **kwargs):
         # type: (Any) -> T
-        """
-        Creates an entity and prepares the query
-        """
+        """Creates an entity and prepares the query"""
         return_type = self.create_typed_object(kwargs, ItemPath(self.resource_path))
         self.add_child(return_type)
         qry = CreateEntityQuery(self, return_type, return_type)
         self.context.add_query(qry)
         return return_type
 
+    def create_typed_object(self, initial_properties=None, resource_path=None):
+        # type: (Optional[dict], Optional[ResourcePath]) -> T
+        if resource_path is None:
+            resource_path = EntityPath(None, self.resource_path)
+        return super(EntityCollection, self).create_typed_object(
+            initial_properties, resource_path
+        )
+
     @property
     def context(self):
         # type: () -> GraphClient

office365/intune/devices/enrollment/configuration.py

@@ -1,4 +1,5 @@
 import datetime
+from typing import Optional
 
 from office365.entity import Entity
 
@@ -6,6 +7,9 @@ from office365.entity import Entity
 class DeviceEnrollmentConfiguration(Entity):
     """The Base Class of Device Enrollment Configuration"""
 
+    def __str__(self):
+        return self.display_name
+
     @property
     def created_datetime(self):
         """
@@ -15,10 +19,8 @@ class DeviceEnrollmentConfiguration(Entity):
 
     @property
     def display_name(self):
-        """
-        The display name of the device enrollment configuration
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """The display name of the device enrollment configuration"""
         return self.properties.get("displayName", None)
 
     def get_property(self, name, default_value=None):

office365/intune/devices/managed.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.intune.devices.category import DeviceCategory
@@ -17,12 +19,12 @@ class ManagedDevice(Entity):
 
     @property
     def activation_lock_bypass_code(self):
+        # type: () -> Optional[str]
         """
         The code that allows the Activation Lock on managed device to be bypassed. Default,
         is Null (Non-Default property) for this property when returned as part of managedDevice entity in LIST call.
         To retrieve actual values GET call needs to be made, with device id and included in select parameter.
         Supports: $select. $Search is not supported. Read-only. This property is read-only.
-        :rtype: str
         """
         return self.properties.get("activationLockBypassCode", None)
 
@@ -38,25 +40,20 @@ class ManagedDevice(Entity):
 
     @property
     def manufacturer(self):
-        """
-        Manufacturer of the device.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Manufacturer of the device."""
         return self.properties.get("manufacturer", None)
 
     @property
     def operating_system(self):
-        """
-        Manufacturer of the device.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Manufacturer of the device."""
         return self.properties.get("operatingSystem", None)
 
     @property
     def device_compliance_policy_states(self):
-        """
-        Device compliance policy states for this device
-        """
+        # type: () -> EntityCollection[DeviceCompliancePolicyState]
+        """Device compliance policy states for this device"""
         return self.properties.get(
             "deviceCompliancePolicyStates",
             EntityCollection(

office365/onedrive/analytics/item_activity_stat.py

@@ -1,4 +1,5 @@
 from datetime import datetime
+from typing import Optional
 
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
@@ -38,9 +39,8 @@ class ItemActivityStat(Entity):
 
     @property
     def is_trending(self):
-        """Indicates whether the item is trending.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Indicates whether the item is trending."""
         return self.properties.get("isTrending", None)
 
     @property
@@ -55,6 +55,7 @@ class ItemActivityStat(Entity):
 
     @property
     def activities(self):
+        # type: () -> EntityCollection[ItemActivity]
         """Exposes the itemActivities represented in this itemActivityStat resource."""
         return self.properties.get(
             "activities",

office365/onedrive/columns/definition.py

@@ -32,6 +32,12 @@ class ColumnDefinition(BaseItem):
     To list hidden field values on listItems, include the desired columns by name in your $select statement.
     """
 
+    def __str__(self):
+        return self.name
+
+    def __repr__(self):
+        return self.name or self.id or self.entity_type_name
+
     @property
     def display_name(self):
         # type: () -> Optional[str]
@@ -41,9 +47,7 @@ class ColumnDefinition(BaseItem):
     @property
     def enforce_unique_values(self):
         # type: () -> Optional[bool]
-        """
-        If true, no two list items may have the same value for this column.
-        """
+        """If true, no two list items may have the same value for this column."""
         return self.properties.get("enforceUniqueValues", None)
 
     @property
@@ -145,9 +149,7 @@ class ColumnDefinition(BaseItem):
     @property
     def is_reorderable(self):
         # type: () -> Optional[bool]
-        """
-        Indicates whether values in the column can be reordered. Read-only.
-        """
+        """Indicates whether values in the column can be reordered."""
         return self.properties.get("isReorderable", None)
 
     @property
@@ -195,9 +197,7 @@ class ColumnDefinition(BaseItem):
     @property
     def type(self):
         # type: () -> Optional[str]
-        """
-        For site columns, the type of column.
-        """
+        """For site columns, the type of column."""
         return self.properties.get("type", None)
 
     def get_property(self, name, default_value=None):

office365/onedrive/documentsets/version.py

@@ -25,9 +25,7 @@ class DocumentSetVersion(ListItemVersion):
     @property
     def created_datetime(self):
         # type: () -> datetime.datetime
-        """
-        Date and time when this version was created.
-        """
+        """Date and time when this version was created."""
         return self.properties("createdDateTime", datetime.datetime.min)
 
     @property

office365/onedrive/driveitems/driveItem.py

@@ -62,13 +62,30 @@ class DriveItem(BaseItem):
     """The driveItem resource represents a file, folder, or other item stored in a drive. All file system objects in
     OneDrive and SharePoint are returned as driveItem resources"""
 
-    def get_by_path(self, url_path):
-        # type: (str) -> "DriveItem"
+    def get_files(self, recursive=False):
+        """Retrieves files
+        :param bool recursive: Determines whether to enumerate folders recursively
         """
-        Retrieve DriveItem by server relative path
+        return_type = EntityCollection(self.context, DriveItem, self.resource_path)
 
-        :type url_path: str
-        """
+        def _get_files(parent_drive_item):
+            # type: (DriveItem) -> None
+            def _after_loaded():
+                for drive_item in parent_drive_item.children:
+                    if drive_item.is_folder:
+                        if recursive:
+                            _get_files(drive_item)
+                    else:
+                        return_type.add_child(drive_item)
+
+            parent_drive_item.ensure_properties(["children"], _after_loaded)
+
+        _get_files(self)
+        return return_type
+
+    def get_by_path(self, url_path):
+        # type: (str) -> "DriveItem"
+        """Retrieve DriveItem by server relative path"""
         return DriveItem(
             self.context, UrlPath(url_path, self.resource_path), self.children
         )
@@ -77,7 +94,6 @@ class DriveItem(BaseItem):
         # type: (str) -> "DriveItem"
         """
         Creates a PowerPoint file
-
         :param str name: File name
         """
         return self.upload(name, None)
@@ -140,18 +156,14 @@ class DriveItem(BaseItem):
 
     def follow(self):
         # type: () -> Self
-        """
-        Follow a driveItem.
-        """
+        """Follow a driveItem."""
         qry = ServiceOperationQuery(self, "follow")
         self.context.add_query(qry)
         return self
 
     def unfollow(self):
         # type: () -> Self
-        """
-        Unfollow a driveItem.
-        """
+        """Unfollow a driveItem."""
         qry = ServiceOperationQuery(self, "unfollow")
         self.context.add_query(qry)
         return self
@@ -363,9 +375,7 @@ class DriveItem(BaseItem):
         return_type = ClientResult(self.context)  # type: ClientResult[str]
 
         def _create_request(request):
-            """
-            :type request: office365.runtime.http.request_options.RequestOptions
-            """
+            # type: (RequestOptions) -> None
             request.url += "?@microsoft.graph.conflictBehavior={0}".format(
                 conflict_behavior
             )
@@ -533,14 +543,13 @@ class DriveItem(BaseItem):
 
         qry = _create_query()
         self.context.add_query(qry)
-
         return return_type
 
     def permanent_delete(self):
         """
         Permanently delete a driveItem.
         Note that if you delete items using this method, they will be permanently removed and won't be sent to the
-        recycle bin. Therefore, they cannot be restored afterward.
+        recycle bin. Therefore, they cannot be restored afterward. For non-permanent delete, use delete_object()
         """
         qry = ServiceOperationQuery(self, "permanentDelete")
         self.context.add_query(qry)
@@ -583,10 +592,7 @@ class DriveItem(BaseItem):
 
     def validate_permission(self, challenge_token=None, password=None):
         # type: (Optional[str], Optional[str]) -> Self
-        """
-        :type challenge_token: str
-        :type password: str
-        """
+        """ """
         payload = {"challengeToken": challenge_token, "password": password}
         qry = ServiceOperationQuery(self, "validatePermission", None, payload)
         self.context.add_query(qry)
@@ -619,9 +625,7 @@ class DriveItem(BaseItem):
     @property
     def location(self):
         # type: () -> GeoCoordinates
-        """
-        Location metadata, if the item has location data. Read-only.
-        """
+        """Location metadata, if the item has location data"""
         return self.properties.get("location", GeoCoordinates())
 
     @property
@@ -664,15 +668,12 @@ class DriveItem(BaseItem):
     @property
     def web_dav_url(self):
         # type: () -> str or None
-        """
-        WebDAV compatible URL for the item.
-        :rtype: str or None
-        """
+        """WebDAV compatible URL for the item."""
         return self.properties.get("webDavUrl", None)
 
     @property
     def children(self):
-        # type: () -> EntityCollection[DriveItem]
+        # type: () -> EntityCollection["DriveItem"]
         """Collection containing Item objects for the immediate children of Item. Only items representing folders
         have children.
         """
@@ -794,6 +795,12 @@ class DriveItem(BaseItem):
             ),
         )
 
+    def set_property(self, name, value, persist_changes=True):
+        super(DriveItem, self).set_property(name, value, persist_changes)
+        if name == "parentReference":
+            self._resource_path.parent.patch(self.parent_reference.driveId)
+        return self
+
     def get_property(self, name, default_value=None):
         # type: (str, P_T) -> P_T
         if default_value is None:

office365/onedrive/internal/paths/children.py

@@ -1,4 +1,4 @@
-from office365.runtime.paths.entity import EntityPath
+from office365.runtime.paths.v4.entity import EntityPath
 
 
 class ChildrenPath(EntityPath):
@@ -13,5 +13,5 @@ class ChildrenPath(EntityPath):
             if isinstance(self.parent, EntityPath):
                 self._collection = self.parent.collection
             else:
-                self._collection = self.parent.parent
+                self._collection = self.parent
         return self._collection

office365/onedrive/internal/paths/root.py

@@ -1,4 +1,4 @@
-from office365.runtime.paths.entity import EntityPath
+from office365.runtime.paths.v4.entity import EntityPath
 
 
 class RootPath(EntityPath):

office365/onedrive/internal/paths/shared.py

@@ -1,22 +1,27 @@
 import base64
 
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.paths.v4.entity import EntityPath
 
 
 def _url_to_shared_token(url):
-    """
-    Converts url into shared token
-    :param str url:
-    """
+    # type: (str) -> str
+    """Converts url into shared token"""
     value = base64.b64encode(url.encode("ascii")).decode("ascii")
     if value.endswith("="):
         value = value[:-1]
     return "u!" + value.replace("/", "_").replace("+", "-")
 
 
-class SharedPath(ResourcePath):
+class SharedPath(EntityPath):
     """Shared token path"""
 
+    def patch(self, key):
+        self._key = "items"
+        self._parent = ResourcePath(key, ResourcePath("drives"))
+        self.__class__ = ResourcePath
+        return self
+
     @property
     def segment(self):
-        return _url_to_shared_token(self.key)
+        return _url_to_shared_token(self._key)

office365/onedrive/internal/paths/site.py

@@ -1,6 +1,6 @@
 from office365.runtime.compat import is_absolute_url, urlparse
-from office365.runtime.paths.entity import EntityPath
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.paths.v4.entity import EntityPath
 
 
 class SitePath(EntityPath):
@@ -8,8 +8,8 @@ class SitePath(EntityPath):
 
     @property
     def segment(self):
-        if is_absolute_url(self.key):
-            url_result = urlparse(self.key)
+        if is_absolute_url(self._key):
+            url_result = urlparse(self._key)
             return ":".join([url_result.hostname, url_result.path])
         else:
             return super(SitePath, self).segment

office365/onedrive/internal/paths/url.py

@@ -1,5 +1,5 @@
 from office365.onedrive.internal.paths.root import RootPath
-from office365.runtime.paths.entity import EntityPath
+from office365.runtime.paths.v4.entity import EntityPath
 
 
 class UrlPath(EntityPath):
@@ -11,7 +11,7 @@ class UrlPath(EntityPath):
         :type parent: office365.runtime.paths.resource_path.ResourcePath
         """
         if isinstance(parent, UrlPath):
-            url = "/".join([parent.key, url])
+            url = "/".join([parent._key, url])
             collection = parent.collection
             parent = parent.parent
         elif isinstance(parent, RootPath):

office365/onedrive/listitems/list_item.py

@@ -60,6 +60,7 @@ class ListItem(BaseItem):
 
     @property
     def content_type(self):
+        # type: () -> ContentTypeInfo
         """The content type of this list item"""
         return self.properties.get("contentType", ContentTypeInfo())
 
@@ -73,6 +74,7 @@ class ListItem(BaseItem):
 
     @property
     def document_set_versions(self):
+        # type: () -> EntityCollection[DocumentSetVersion]
         """Version information for a document set version created by a user."""
         return self.properties.get(
             "documentSetVersions",

office365/onedrive/lists/list.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.base_item import BaseItem
 from office365.entity_collection import EntityCollection
 from office365.onedrive.columns.definition_collection import ColumnDefinitionCollection
@@ -14,12 +16,13 @@ class List(BaseItem):
     """The list resource represents a list in a site. This resource contains the top level properties of the list,
     including template and field definitions."""
 
+    def __str__(self):
+        return self.display_name
+
     @property
     def display_name(self):
-        """
-        The displayable title of the list
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The displayable title of the list"""
         return self.properties.get("displayName", None)
 
     @property