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

office365/sharepoint/tenant/administration/tenant.py

@@ -1,6 +1,8 @@
 import time
 from typing import AnyStr, Optional
 
+from typing_extensions import Self
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
@@ -9,6 +11,7 @@ from office365.sharepoint.entity import Entity
 from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.gtp.request_options import ChatGptRequestOptions
 from office365.sharepoint.listitems.collection import ListItemCollection
+from office365.sharepoint.listitems.listitem import ListItem
 from office365.sharepoint.lists.render_data_parameters import RenderListDataParameters
 from office365.sharepoint.lists.render_override_parameters import (
     RenderListDataOverrideParameters,
@@ -310,14 +313,11 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return return_type
 
-    def get_site_status(self, url):
-        """
-        :param str url:
-        """
-        result = self.aggregated_site_collections_list.items.filter(
-            "SiteUrl eq '{0}'".format(url)
+    def get_site(self, site_url):
+        # type: (str) -> ListItem
+        return self._aggregated_site_collections_list.items.single(
+            "SiteUrl eq '{0}'".format(site_url.rstrip("/"))
         ).get()
-        return result
 
     def get_sites_by_state(self, states=None):
         """
@@ -325,7 +325,7 @@ class Tenant(Entity):
         """
         return_type = ListItemCollection(
             self.context,
-            ResourcePath("items", self.aggregated_site_collections_list.resource_path),
+            ResourcePath("items", self._aggregated_site_collections_list.resource_path),
         )
         payload = {"states": states}
         qry = ServiceOperationQuery(
@@ -424,11 +424,8 @@ class Tenant(Entity):
         return self
 
     def register_hub_site(self, site_url):
-        """
-        Registers an existing site as a hub site.
-
-        :param str site_url:
-        """
+        # type: (str) -> HubSiteProperties
+        """Registers an existing site as a hub site."""
         return_type = HubSiteProperties(self.context)
         params = {"siteUrl": site_url}
         qry = ServiceOperationQuery(
@@ -438,11 +435,8 @@ class Tenant(Entity):
         return return_type
 
     def unregister_hub_site(self, site_url):
-        """
-        Unregisters a hub site so that it is no longer a hub site.
-
-        :param str site_url: Site Url
-        """
+        # type: (str) -> Self
+        """Unregisters a hub site so that it is no longer a hub site."""
         payload = {"siteUrl": site_url}
         qry = ServiceOperationQuery(
             self, "UnregisterHubSite", None, payload, None, None
@@ -526,7 +520,6 @@ class Tenant(Entity):
 
     def restore_deleted_site(self, site_url):
         """Restores deleted site with the specified URL
-
         :param str site_url: A string representing the URL of the site.
         """
         return_type = SpoOperation(self.context)
@@ -543,6 +536,7 @@ class Tenant(Entity):
         :param bool include_detail: A Boolean value that indicates whether to include all of the SPSite properties.
         """
         return_type = SiteProperties(self.context)
+        return_type.set_property("Url", url, False)
         self.sites.add_child(return_type)
         payload = {"url": url, "includeDetail": include_detail}
         qry = ServiceOperationQuery(
@@ -574,12 +568,8 @@ class Tenant(Entity):
         return return_type
 
     def connect_site_to_hub_site_by_id(self, site_url, hub_site_id):
-        """
-
-        :param str site_url:
-        :param str hub_site_id:
-        :return:
-        """
+        # type: (str, str) -> Self
+        """Connects Site to Hub Site"""
         params = {"siteUrl": site_url, "hubSiteId": hub_site_id}
         qry = ServiceOperationQuery(
             self, "ConnectSiteToHubSiteById", None, params, None, None
@@ -588,9 +578,8 @@ class Tenant(Entity):
         return self
 
     def send_email(self, site_url):
-        """
-        :type site_url: str
-        """
+        # type: (str) -> ClientResult[bool]
+        """ """
         return_type = ClientResult(self.context, bool())
         payload = {"siteUrl": site_url}
         qry = ServiceOperationQuery(self, "SendEmail", None, payload, None, return_type)
@@ -599,10 +588,8 @@ class Tenant(Entity):
 
     @property
     def ai_builder_enabled(self):
-        """
-        Gets the value if the AIBuilder settings should be shown in the tenant
-        :rtype: bool or None
-        """
+        # type: () -> Optional[str]
+        """Gets the value if the AIBuilder settings should be shown in the tenant"""
         return self.properties.get("AIBuilderEnabled", None)
 
     @property
@@ -613,26 +600,26 @@ class Tenant(Entity):
         )
 
     @property
-    def aggregated_site_collections_list(self):
+    def _aggregated_site_collections_list(self):
         return self.context.web.lists.get_by_title(
             "DO_NOT_DELETE_SPLIST_TENANTADMIN_AGGREGATED_SITECOLLECTIONS"
         )
 
     @property
     def allow_comments_text_on_email_enabled(self):
+        # type: () -> Optional[bool]
         """
         When enabled, the email notification that a user receives when is mentioned,
-            includes the surrounding document context
-        :rtype: bool or None
+        includes the surrounding document context
         """
         return self.properties.get("AllowCommentsTextOnEmailEnabled", None)
 
     @property
     def allow_everyone_except_external_users_claim_in_private_site(self):
+        # type: () -> Optional[bool]
         """
         Gets the value if EveryoneExceptExternalUsers claim is allowed or not in people picker in a private group site.
         False value means it is blocked
-        :rtype: bool or None
         """
         return self.properties.get(
             "AllowEveryoneExceptExternalUsersClaimInPrivateSite", None
@@ -640,10 +627,10 @@ class Tenant(Entity):
 
     @property
     def allow_editing(self):
+        # type: () -> Optional[bool]
         """
         Prevents users from editing Office files in the browser and copying and pasting Office file contents
         out of the browser window.
-        :rtype: bool or None
         """
         return self.properties.get("AllowEditing", None)
 
@@ -655,9 +642,7 @@ class Tenant(Entity):
     @property
     def root_site_url(self):
         # type: () -> Optional[str]
-        """
-        The tenant's root site url
-        """
+        """The tenant's root site url"""
         return self.properties.get("RootSiteUrl", None)
 
     @property

office365/sharepoint/usercustomactions/collection.py

@@ -13,7 +13,6 @@ class UserCustomActionCollection(EntityCollection[UserCustomAction]):
     def clear(self):
         """
         Deletes all custom actions in the collection.
-
         Exceptions:
         - 2130575305 Microsoft.SharePoint.SPException Custom action was modified on the server  in a way that
              prevents changes from being committed, as determined by the protocol server.

office365/sharepoint/webs/collection.py

@@ -1,5 +1,6 @@
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity_collection import EntityCollection
+from office365.sharepoint.internal.paths.web import WebPath
 from office365.sharepoint.webs.web import Web
 
 
@@ -25,6 +26,13 @@ class WebCollection(EntityCollection[Web]):
         self.context.add_query(qry)
         return return_type
 
+    def create_typed_object(self, initial_properties=None, resource_path=None):
+        if resource_path is None:
+            resource_path = WebPath(self.resource_path)
+        return super(EntityCollection, self).create_typed_object(
+            initial_properties, resource_path
+        )
+
     @property
     def resource_url(self):
         val = super(WebCollection, self).resource_url

office365/sharepoint/webs/template_collection.py

@@ -12,10 +12,8 @@ class WebTemplateCollection(EntityCollection[WebTemplate]):
         )
 
     def get_by_name(self, name):
-        """Returns the SP.WebTemplate (section 3.2.5.151) specified by its name.<162>
-
-        :param str name: The name of the SP.WebTemplate that is returned.
-
+        """Returns the SP.WebTemplate (section 3.2.5.151) specified by its name.
+        :param str name: The name of the WebTemplate that is returned.
         """
         return WebTemplate(
             self.context,

office365/sharepoint/webs/web.py

@@ -41,6 +41,7 @@ from office365.sharepoint.files.file import File
 from office365.sharepoint.flows.synchronization_result import FlowSynchronizationResult
 from office365.sharepoint.folders.collection import FolderCollection
 from office365.sharepoint.folders.folder import Folder
+from office365.sharepoint.internal.paths.web import WebPath
 from office365.sharepoint.listitems.listitem import ListItem
 from office365.sharepoint.lists.collection import ListCollection
 from office365.sharepoint.lists.creation_information import ListCreationInformation
@@ -123,10 +124,13 @@ class Web(SecurableObject):
         :type context: office365.sharepoint.client_context.ClientContext
         """
         if resource_path is None:
-            resource_path = ResourcePath("Web")
+            resource_path = WebPath("Web")
         super(Web, self).__init__(context, resource_path)
         self._web_url = None
 
+    def __str__(self):
+        return self.title
+
     def add_list(self, title, template_type=ListTemplateType.GenericList):
         """
         Creates a new list and adds it to the web.
@@ -576,7 +580,7 @@ class Web(SecurableObject):
         :type webs: office365.sharepoint.webs.collection.WebCollection
         :type all_webs: office365.sharepoint.webs.collection.WebCollection
         """
-        for cur_web in webs:  # type: Web
+        for cur_web in webs:
             all_webs.add_child(cur_web)
 
             def _webs_loaded(web):
@@ -1098,7 +1102,6 @@ class Web(SecurableObject):
     def get_file_by_guest_url(self, guest_url):
         """
         Returns the file object from the guest access URL.
-
         :param str guest_url: The guest access URL to get the file with.
         """
         return_type = File(self.context)
@@ -1201,7 +1204,7 @@ class Web(SecurableObject):
 
         :param str guest_url: The tokenized sharing link URL for the folder.
         """
-        return_type = Folder(self.context)
+        return_type = Folder(self.context, parent_collection=self.folders)
         payload = {"guestUrl": guest_url}
         qry = ServiceOperationQuery(
             self, "GetFolderByGuestUrl", None, payload, None, return_type
@@ -1225,7 +1228,7 @@ class Web(SecurableObject):
         :param bool ensure_access: Indicates if the request to the tokenized sharing link grants perpetual access to
             the calling user.
         """
-        return_type = Folder(self.context)
+        return_type = Folder(self.context, parent_collection=self.folders)
         payload = {
             "guestUrl": guest_url,
             "requestSettings": SharingLinkAccessRequest(ensure_access, password),
@@ -1282,9 +1285,10 @@ class Web(SecurableObject):
         """
         return_type = SharingResult(self.context)
 
-        def _picker_value_resolved(resp, picker_result, group):
+        def _share(picker_result, group):
+            # type: (ClientResult[str], Group) -> None
             picker_input = "[{0}]".format(picker_result.value)
-            role_value = "group:{groupId}".format(groupId=group.properties["Id"])
+            role_value = "group:{groupId}".format(groupId=group.id)
             Web.share_object(
                 self.context,
                 self.url,
@@ -1299,26 +1303,26 @@ class Web(SecurableObject):
                 return_type=return_type,
             )
 
-        def _grp_resolved(group):
-            picker_result = (
-                ClientPeoplePickerWebServiceInterface.client_people_picker_resolve_user(
-                    self.context, user_principal_name
-                )
-            )
-            self.context.after_execute(
-                _picker_value_resolved, True, picker_result, group
-            )
-
         def _web_resolved():
             groups = {
                 ExternalSharingSiteOption.View: self.associated_visitor_group,
                 ExternalSharingSiteOption.Edit: self.associated_member_group,
                 ExternalSharingSiteOption.Owner: self.associated_owner_group,
-            }
-            selected_group = groups[share_option]
-            self.context.load(selected_group, after_loaded=_grp_resolved)
+            }  # type: dict[ExternalSharingSiteOption, Group]
+
+            ClientPeoplePickerWebServiceInterface.client_people_picker_resolve_user(
+                self.context, user_principal_name
+            ).after_execute(_share, groups[share_option])
 
-        self.ensure_property("Url", _web_resolved)
+        self.ensure_properties(
+            [
+                "Url",
+                "AssociatedVisitorGroup",
+                "AssociatedMemberGroup",
+                "AssociatedOwnerGroup",
+            ],
+            _web_resolved,
+        )
         return return_type
 
     def unshare(self):
@@ -2380,9 +2384,7 @@ class Web(SecurableObject):
 
     @property
     def server_relative_path(self):
-        """
-        Gets the server-relative Path of the Web.
-        """
+        """Gets the server-relative Path of the Web."""
         return self.properties.get("ServerRelativePath", SPResPath())
 
     @property
@@ -2450,6 +2452,7 @@ class Web(SecurableObject):
         super(Web, self).set_property(name, value, persist_changes)
         if name == "Url":
             self._web_url = value
+            self._resource_path.patch(value)
         return self
 
     @property

office365/teams/apps/app.py

@@ -9,6 +9,7 @@ class TeamsApp(Entity):
 
     @property
     def app_definitions(self):
+        # type: () -> EntityCollection[TeamsAppDefinition]
         """The details for each version of the app."""
         return self.properties.get(
             "appDefinitions",

office365/teams/collection.py

@@ -1,10 +1,10 @@
 from typing import Callable
 
+import requests
 from typing_extensions import Self
 
-from office365.directory.groups.group import Group
 from office365.entity_collection import EntityCollection
-from office365.runtime.odata.path_builder import ODataPathBuilder
+from office365.runtime.paths.builder import ODataPathBuilder
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.create_entity import CreateEntityQuery
 from office365.teams.operations.async_operation import TeamsAsyncOperation
@@ -44,26 +44,22 @@ class TeamCollection(EntityCollection[Team]):
         return_type = Team(self.context)
         self.add_child(return_type)
 
-        payload = {
-            "displayName": display_name,
-            "description": description,
-            "template@odata.bind": "https://graph.microsoft.com/v1.0/teamsTemplates('standard')",
-        }
-        qry = CreateEntityQuery(self, payload, return_type)
-        self.context.add_query(qry)
-
         def _process_response(resp):
-            """
-            :type resp: requests.Response
-            """
+            # type: (requests.Response) -> None
             content_loc = resp.headers.get("Content-Location", None)
-            team_path = ODataPathBuilder.parse(content_loc)
+            team_path = ODataPathBuilder.parse_url(content_loc)
             return_type.set_property("id", team_path.segment, False)
 
             loc = resp.headers.get("Location", None)
-            operation_path = ODataPathBuilder.parse(loc)
+            operation_path = ODataPathBuilder.parse_url(loc)
             operation = TeamsAsyncOperation(self.context, operation_path)
             return_type.operations.add_child(operation)
 
-        self.context.after_execute(_process_response)
+        payload = {
+            "displayName": display_name,
+            "description": description,
+            "template@odata.bind": "https://graph.microsoft.com/v1.0/teamsTemplates('standard')",
+        }
+        qry = CreateEntityQuery(self, payload, return_type)
+        self.context.add_query(qry).after_execute(_process_response)
         return return_type

office365/teams/members/conversation_collection.py

@@ -2,7 +2,7 @@ from office365.entity_collection import EntityCollection
 from office365.teams.members.conversation import ConversationMember
 
 
-class ConversationMemberCollection(EntityCollection):
+class ConversationMemberCollection(EntityCollection[ConversationMember]):
     def __init__(self, context, resource_path=None):
         super(ConversationMemberCollection, self).__init__(
             context, ConversationMember, resource_path
@@ -18,8 +18,6 @@ class ConversationMemberCollection(EntityCollection):
             Each member must be assigned a role of owner or guest. Guest tenant members must be assigned the guest role
         :param list[str] roles: The roles for that user.
         :param datetime.datetime visible_history_start_datetime:
-
-        :rtype: ConversationMember
         """
         return_type = super(ConversationMemberCollection, self).add(roles=roles)
         from office365.directory.users.user import User

office365/teams/operations/async_operation.py

@@ -68,16 +68,14 @@ class TeamsAsyncOperation(Entity):
 
     @property
     def target_resource_location(self):
+        # type: () -> Optional[str]
         """The location of the object that's created or modified as result of this async operation.
         This URL should be treated as an opaque value and not parsed into its component paths.
-        :rtype: str or None
         """
         return self.properties.get("targetResourceLocation", None)
 
     @property
     def status(self):
-        """
-        Operation status.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Operation status."""
         return self.properties.get("status", None)

office365/teams/schedule/groups/group.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.types.collections import StringCollection
 from office365.teams.schedule.change_tracked_entity import ChangeTrackedEntity
 
@@ -7,6 +9,7 @@ class SchedulingGroup(ChangeTrackedEntity):
 
     @property
     def is_active(self):
+        # type: () -> Optional[bool]
         """Indicates whether the schedulingGroup can be used when creating new entities or updating existing ones"""
         return self.properties.get("isActive", None)
 

office365/teams/team.py

@@ -321,6 +321,6 @@ class Team(Entity):
     def set_property(self, name, value, persist_changes=True):
         super(Team, self).set_property(name, value, persist_changes)
         # fallback: determine whether resource path is resolved
-        if name == "id" and self._resource_path.key == "team":
+        if name == "id" and self._resource_path.segment == "team":
             self._resource_path = ResourcePath(value, ResourcePath("teams"))
         return self

office365/todo/attachments/base.py

@@ -1,4 +1,5 @@
 import datetime
+from typing import Optional
 
 from office365.entity import Entity
 
@@ -9,14 +10,13 @@ class AttachmentBase(Entity):
 
     @property
     def content_type(self):
-        """
-        The MIME type.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The MIME type."""
         return self.properties.get("contentType", None)
 
     @property
     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.
         """
@@ -24,16 +24,14 @@ class AttachmentBase(Entity):
 
     @property
     def name(self):
+        # type: () -> Optional[str]
         """
         The display name of the attachment. This does not need to be the actual file name.
-        :rtype: str or None
         """
         return self.properties.get("name", None)
 
     @property
     def size(self):
-        """
-        The length of the attachment in bytes.
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """The length of the attachment in bytes."""
         return self.properties.get("size", None)

office365/runtime/odata/path_builder.py

@@ -1,23 +0,0 @@
-import json
-import re
-
-from office365.runtime.client_value import ClientValue
-from office365.runtime.compat import is_string_type
-from office365.runtime.paths.resource_path import ResourcePath
-
-
-class ODataPathBuilder(object):
-    @staticmethod
-    def parse(path_str):
-        """
-        Parses path from a string
-
-        :param str path_str:
-        """
-        segments = [n for n in re.split(r"[('')]|/", path_str) if n]
-        if not segments:
-            raise TypeError("Invalid path")
-        path = None
-        for segment in segments:
-            path = ResourcePath(segment, path)
-        return path

office365/runtime/paths/entity.py

@@ -1,34 +0,0 @@
-from office365.runtime.paths.resource_path import ResourcePath
-
-
-class EntityPath(ResourcePath):
-    def __init__(self, key=None, parent=None, collection=None):
-        """
-        :param str or None key: Entity key
-        :param ResourcePath or None collection:
-        """
-        super(EntityPath, self).__init__(key, parent)
-        self._collection = collection
-
-    @property
-    def collection(self):
-        return self._collection
-
-    @property
-    def segment(self):
-        return str(self.key or "<key>")
-
-    def patch(self, key, inplace=False):
-        """
-        Patches path
-
-        :type key: str or None
-        :type inplace: bool
-        """
-        if inplace:
-            self._key = key
-            self._parent = self.collection
-            self.__class__ = ResourcePath
-            return self
-        else:
-            return ResourcePath(key, self.collection)

office365/sharepoint/internal/key_value.py

@@ -1,28 +0,0 @@
-from office365.runtime.client_value import ClientValue
-from office365.runtime.client_value_collection import ClientValueCollection
-
-
-class KeyValue(ClientValue):
-    """Represents a key value pair."""
-
-    def __init__(self, key=None, value=None, value_type=None):
-        """
-        :param str key: The value of the key in the key value pair.
-        :param str value: The string representation of the value in the key value pair.
-        :param str value_type: The EDM type name of the value in the key value pair.
-        """
-        self.Key = key
-        self.Value = value
-        self.ValueType = value_type
-
-    @property
-    def entity_type_name(self):
-        return "SP.KeyValue"
-
-
-class KeyValueCollection(ClientValueCollection):
-    def __init__(self, initial_values=None):
-        """
-        :type initial_values: list[KeyValue] or None
-        """
-        super(KeyValueCollection, self).__init__(KeyValue, initial_values)