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

office365/sharepoint/tenant/administration/hubsites/hub_site.py

@@ -1,53 +1,49 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
 class HubSite(Entity):
     """SharePoint hub sites help you meet the needs of your organization by connecting and organizing sites"""
 
+    def __str__(self):
+        return self.title or self.entity_type_name
+
+    def __repr__(self):
+        return self.site_url or self.entity_type_name
+
     @property
     def id(self):
-        """Gets the id of the hub site.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the id of the hub site."""
         return self.properties.get("ID", None)
 
     @property
     def description(self):
-        """Gets the description of the hub site type.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the description of the hub site type."""
         return self.properties.get("Description", None)
 
     @property
     def site_url(self):
-        """Gets the url of the hub site.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the url of the hub site."""
         return self.properties.get("SiteUrl", None)
 
     @property
     def targets(self):
-        """List of security groups with access to join the hub site. Null if everyone has permission.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """List of security groups with access to join the hub site. Null if everyone has permission."""
         return self.properties.get("Targets", None)
 
     @property
     def title(self):
-        """Gets the title of the hub site.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the title of the hub site."""
         return self.properties.get("Title", None)
 
     @property
     def tenant_instance_id(self):
-        """Gets The tenant instance ID in which the hub site is located.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets The tenant instance ID in which the hub site is located."""
         return self.properties.get("TenantInstanceId", None)

office365/sharepoint/tenant/administration/internal/permission_grant.py

@@ -0,0 +1,7 @@
+from office365.sharepoint.entity import Entity
+
+
+class SPO3rdPartyAADPermissionGrant(Entity):
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantAdministration.Internal.SPO3rdPartyAADPermissionGrant"

office365/sharepoint/tenant/administration/sites/properties.py

@@ -1,24 +1,27 @@
 from typing import Optional
 
-from office365.runtime.paths.key import KeyPath
+from office365.onedrive.listitems.list_item import ListItem
 from office365.runtime.paths.service_operation import ServiceOperationPath
+from office365.runtime.paths.v3.entity import EntityPath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.client_context import ClientContext
 from office365.sharepoint.entity import Entity
-from office365.sharepoint.sites.site import Site
+from office365.sharepoint.internal.paths.static_operation import StaticOperationPath
 from office365.sharepoint.tenant.administration.deny_add_and_customize_pages_status import (
     DenyAddAndCustomizePagesStatus,
 )
+from office365.sharepoint.tenant.administration.spo_operation import SpoOperation
 
 
 class SiteProperties(Entity):
     """Contains a property bag of information about a site."""
 
+    def __repr__(self):
+        return self.url or self.entity_type_name
+
     @staticmethod
     def clear_sharing_lock_down(context, site_url):
-        """
-        :param office365.sharepoint.client_context.ClientContext context: SharePoint client service
-        :param str site_url:
-        """
+        # type: (ClientContext, str) -> SiteProperties
         payload = {"siteUrl": site_url}
         binding_type = SiteProperties(context)
         qry = ServiceOperationQuery(
@@ -30,75 +33,71 @@ class SiteProperties(Entity):
     def update(self):
         """Updates the site collection properties with the new properties specified in the SiteProperties object."""
 
-        site = Site(self.context)
-        site.set_property("__siteUrl", self.url)
-
-        def _site_loaded(return_type):
-            self._resource_path = KeyPath(site.id, self.parent_collection.resource_path)
+        def _update():
             super(SiteProperties, self).update()
 
-        self.context.load(site, after_loaded=_site_loaded)
+        self._ensure_site_path(_update)
         return self
 
+    def update_ex(self):
+        """Updates the site collection properties with the new properties specified in the SiteProperties object."""
+        return_type = SpoOperation(self.context)
+
+        def _update_ex():
+            qry = ServiceOperationQuery(
+                self, "Update", parameters_type=self, return_type=return_type
+            )
+            self.context.add_query(qry)
+
+        self._ensure_site_path(_update_ex)
+        return return_type
+
     @property
     def deny_add_and_customize_pages(self):
-        """
-        Represents the status of the [DenyAddAndCustomizePages] feature on a site collection.
-        """
+        # type: () -> Optional[int]
+        """Represents the status of the [DenyAddAndCustomizePages] feature on a site collection."""
         return self.properties.get(
             "DenyAddAndCustomizePages", DenyAddAndCustomizePagesStatus.Unknown
         )
 
     @deny_add_and_customize_pages.setter
     def deny_add_and_customize_pages(self, value):
-        """
-        Sets the status of the [DenyAddAndCustomizePages] feature on a site collection.
-
-        :param int value:
-        """
+        # type: (int) -> None
+        """Sets the status of the [DenyAddAndCustomizePages] feature on a site collection."""
         self.set_property("DenyAddAndCustomizePages", value)
 
     @property
     def owner_login_name(self):
-        """
-        :rtype: str
-        """
+        # type: () -> Optional[str]
         return self.properties.get("OwnerLoginName", None)
 
     @property
     def webs_count(self):
-        """
-        Gets the number of Web objects in the site.
-        :rtype: int
-        """
+        # type: () -> Optional[str]
+        """Gets the number of Web objects in the site."""
         return self.properties.get("WebsCount", None)
 
     @property
     def url(self):
         # type: () -> Optional[str]
-        """
-        Gets the URL of the site.
-        """
+        """Gets the URL of the site."""
         return self.properties.get("Url", None)
 
     @property
     def compatibility_level(self):
         # type: () -> Optional[str]
-        """
-        Gets the compatibility level of the site.
-        """
+        """Gets the compatibility level of the site."""
         return self.properties.get("CompatibilityLevel", None)
 
     @property
     def lock_state(self):
         # type: () -> Optional[str]
-        """
-        Gets or sets the lock state of the site.
-        """
+        """Gets or sets the lock state of the site."""
         return self.properties.get("LockState", None)
 
     @property
     def sharing_capability(self):
+        # type: () -> Optional[int]
         """
         Determines what level of sharing is available for the site.
 
@@ -115,29 +114,41 @@ class SiteProperties(Entity):
 
     @sharing_capability.setter
     def sharing_capability(self, value):
-        """
-        Sets the level of sharing for the site.
-        :type value: int
-        """
+        # type: (int) -> None
+        """Sets the level of sharing for the site."""
         self.set_property("SharingCapability", value)
 
     @property
     def time_zone_id(self):
         # type: () -> Optional[str]
-        """
-        Gets the time zone ID of the site.
-        """
+        """Gets the time zone ID of the site."""
         return self.properties.get("TimeZoneId", None)
 
     @property
     def entity_type_name(self):
+        # type: () -> str
         return "Microsoft.Online.SharePoint.TenantAdministration.SiteProperties"
 
     def set_property(self, name, value, persist_changes=True):
         super(SiteProperties, self).set_property(name, value, persist_changes)
         # fallback: create a new resource path
         if name == "Url" and self._resource_path is None:
-            self._resource_path = ServiceOperationPath(
+            self._resource_path = StaticOperationPath(
                 self.entity_type_name, {"Url": value}
             )
         return self
+
+    def _ensure_site_path(self, action):
+        if isinstance(self.resource_path, ServiceOperationPath):
+
+            def _loaded(return_type):
+                # type: (ListItem) -> None
+                site_id = return_type.get_property("SiteId")
+                self._resource_path = EntityPath(
+                    site_id, self.parent_collection.resource_path
+                )
+                action()
+
+            self.context.tenant.get_site(self.url).after_execute(_loaded)
+        else:
+            action()

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,
@@ -19,6 +22,9 @@ from office365.sharepoint.sites.site import Site
 from office365.sharepoint.tenant.administration.collaboration.insights_data import (
     CollaborationInsightsData,
 )
+from office365.sharepoint.tenant.administration.collaboration.insights_overview import (
+    CollaborationInsightsOverview,
+)
 from office365.sharepoint.tenant.administration.hubsites.properties import (
     HubSiteProperties,
 )
@@ -139,6 +145,18 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def get_collaboration_insights_overview(self):
+        """"""
+        return_type = ClientResult[CollaborationInsightsData](
+            self.context, CollaborationInsightsOverview()
+        )
+
+        qry = ServiceOperationQuery(
+            self, "GetCollaborationInsightsOverview", None, None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def render_recent_admin_actions(self):
         return_type = ClientResult(self.context)
         payload = {
@@ -189,7 +207,8 @@ class Tenant(Entity):
     def get_home_sites(self):
         # type: () -> ClientResult[ClientValueCollection[HomeSitesDetails]]
         return_type = ClientResult(
-            self.context, ClientValueCollection[HomeSitesDetails]()
+            self.context,
+            ClientValueCollection(HomeSitesDetails),  # pylint: disable=E1120
         )
         qry = ServiceOperationQuery(self, "GetHomeSites", None, None, None, return_type)
         self.context.add_query(qry)
@@ -294,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):
         """
@@ -309,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(
@@ -318,6 +334,26 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def _poll_site_status(self, site_url, polling_interval_secs):
+        states = [0, 1, 2]
+        time.sleep(polling_interval_secs)
+
+        def _after(items):
+            completed = (
+                len(
+                    [
+                        item
+                        for item in items
+                        if item.properties.get("SiteUrl") == site_url
+                    ]
+                )
+                > 0
+            )
+            if not completed:
+                self._poll_site_status(site_url, polling_interval_secs)
+
+        self.get_sites_by_state(states).after_execute(_after, execute_first=True)
+
     def get_site_health_status(self, source_url):
         """
         :type source_url: str
@@ -388,12 +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:
-        :return:
-        """
+        # type: (str) -> HubSiteProperties
+        """Registers an existing site as a hub site."""
         return_type = HubSiteProperties(self.context)
         params = {"siteUrl": site_url}
         qry = ServiceOperationQuery(
@@ -403,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
@@ -437,39 +466,19 @@ class Tenant(Entity):
     def create_site_sync(self, url, owner, title=None):
         """Creates a site collection
 
-         :param str title: Sets the new site’s title.
+        :param str title: Sets the new site’s title.
         :param str url: Sets the new site’s URL.
         :param str owner: Sets the login name of the owner of the new site.
         """
         return_type = Site(self.context)
-        op = self.create_site(url, owner, title)
-
-        def _verify_site_status(resp, items=None):
-            """
-            :type resp: requests.Response
-            """
-            resp.raise_for_status()
-            if items is None:
-                is_complete = op.is_complete
-            else:
-                is_complete = (
-                    len(
-                        [
-                            item
-                            for item in items
-                            if item.properties.get("SiteUrl") == url
-                        ]
-                    )
-                    > 0
-                )
-            if not is_complete:
-                time.sleep(op.polling_interval_secs)
-                items = self.get_sites_by_state([0, 1, 2])
-                self.context.after_execute(_verify_site_status, items=items)
+        return_type.set_property("__siteUrl", url)
 
-            return_type.set_property("__siteUrl", url)
+        def _ensure_status(op):
+            # type: (SpoOperation) -> None
+            if not op.is_complete:
+                self._poll_site_status(url, op.polling_interval_secs)
 
-        self.context.after_execute(_verify_site_status)
+        self.create_site(url, owner, title).after_execute(_ensure_status)
         return return_type
 
     def remove_site(self, site_url):
@@ -511,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)
@@ -528,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(
@@ -559,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
@@ -573,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)
@@ -584,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
@@ -598,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
@@ -625,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)
 
@@ -640,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/types/resource_path.py

@@ -44,7 +44,7 @@ class ResourcePath(ClientValue):
         return "SP.ResourcePath"
 
     def __str__(self):
-        return str(self.DecodedUrl)
+        return self.DecodedUrl
 
     def __repr__(self):
-        return str(self.DecodedUrl)
+        return self.DecodedUrl or self.entity_type_name

office365/sharepoint/ui/applicationpages/peoplepicker/query_parameters.py

@@ -24,7 +24,7 @@ class ClientPeoplePickerQueryParameters(ClientValue):
         Specifies the properties of a principal query
 
         :type int urlZone: Specifies a location in the topology of the farm for the principal query.
-        :param int sharepoint_group_id: specifies a group containing allowed principals to be used in the principal query.
+        :param int sharepoint_group_id: specifies a group containing allowed principals to be used in the principal query
         :param str query_string: Specifies the value to be used in the principal query.
         :param int principal_type: Specifies the type to be used in the principal query.
         :param int principal_source: Specifies the source to be used in the principal query.

office365/sharepoint/usercustomactions/collection.py

@@ -3,7 +3,7 @@ from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.usercustomactions.action import UserCustomAction
 
 
-class UserCustomActionCollection(EntityCollection):
+class UserCustomActionCollection(EntityCollection[UserCustomAction]):
     def __init__(self, context, resource_path=None):
         """Specifies a collection of custom actions."""
         super(UserCustomActionCollection, self).__init__(
@@ -13,7 +13,6 @@ class UserCustomActionCollection(EntityCollection):
     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/userprofiles/my_site_links.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
@@ -23,22 +25,20 @@ class MySiteLinks(Entity):
 
     @property
     def all_documents_link(self):
+        # type: () -> Optional[str]
         """
         This property value is the URL of the user’s document library on their personal site. This property value is
         null if the user does not have a personal site or the user does not have a document library in their personal
         site.
-
-        :rtype: str
         """
         return self.properties.get("AllDocumentsLink", None)
 
     @property
     def all_sites_link(self):
+        # type: () -> Optional[str]
         """
         This property value is the URL of the user’s followed sites view on their personal site.  This property value
         is null if the user does not have a personal site or social features are not enabled on their personal site.
-
-        :rtype: str
         """
         return self.properties.get("AllSitesLink", None)
 

office365/sharepoint/userprofiles/people_manager.py

@@ -95,7 +95,7 @@ class PeopleManager(Entity):
         :param str account_name: Account name of the specified user.
         :param str site_id: Site Identifier.
         """
-        return_type = ClientResult(self.context, dict())
+        return_type = ClientResult(self.context, {})
         params = {"accountName": account_name, "siteId": site_id}
         qry = ServiceOperationQuery(
             self, "GetSPUserInformation", params, None, None, return_type
@@ -157,9 +157,7 @@ class PeopleManager(Entity):
     def get_properties_for(self, user_or_name):
         """
         Gets user properties for the specified user.
-
         :param str or User user_or_name: Specifies the User object or its login name.
-        :return: PersonProperties
         """
         return_type = PersonProperties(self.context)