SharePoint API (tenant namespace) & directory improvements

vgrem · vgrem · commit 8bad836d2b43 · 2024-10-03T23:19:13.000+03:00
diff --git a/examples/directory/applications/list_delegated_perms.py b/examples/directory/applications/list_delegated_perms.py
@@ -24,9 +24,7 @@
 resource = (
     client.service_principals.get_by_name("Microsoft Graph").get().execute_query()
 )
-result = resource.get_delegated_permissions(
-    test_client_id, only_admin_consent=True
-).execute_query()
+result = resource.get_delegated_permissions(test_client_id).execute_query()
 
 for grant in result:
-    print(grant.scope)
+    print(grant.scope + ";")
diff --git a/examples/onedrive/sitepages/create.py b/examples/onedrive/sitepages/create.py
@@ -5,9 +5,9 @@
 """
 
 from office365.graph_client import GraphClient
-from tests import test_client_id, test_client_secret, test_tenant
+from tests import test_client_id, test_client_secret, test_team_site_url, test_tenant
 
 client = GraphClient.with_client_secret(test_tenant, test_client_id, test_client_secret)
-root_site = client.sites.root.get().execute_query()
-page = root_site.pages.add("test").execute_query()
+site = client.sites.get_by_url(test_team_site_url)
+page = site.pages.add("test456").execute_query()
 print("Page url: {0}".format(page))
diff --git a/examples/onedrive/sitepages/list.py b/examples/onedrive/sitepages/list.py
@@ -0,0 +1,14 @@
+"""
+Get the collection of sitePage objects from the site pages list in a site.
+
+https://learn.microsoft.com/en-us/graph/api/sitepage-list?view=graph-rest-1.0
+"""
+
+from office365.graph_client import GraphClient
+from tests import test_client_id, test_client_secret, test_team_site_url, test_tenant
+
+client = GraphClient.with_client_secret(test_tenant, test_client_id, test_client_secret)
+site = client.sites.get_by_url(test_team_site_url)
+pages = site.pages.get().execute_query()
+for page in pages:
+    print("Page url: {0}".format(page))
diff --git a/generator/metadata/SharePoint.xml b/generator/metadata/SharePoint.xml
@@ -35662,11 +35662,11 @@
          </EntityType>
          <EntityType Name="CorporateCatalogAppMetadata">
             <Key>
-               <PropertyRef Name="AppCatalogVersion"/>
+               <PropertyRef Name="AadAppId"/>
             </Key>
-            <Property Name="AadAppId" Type="Edm.String"/>
+            <Property Name="AadAppId" Type="Edm.String" Nullable="false"/>
             <Property Name="AadPermissions" Type="Edm.String"/>
-            <Property Name="AppCatalogVersion" Type="Edm.String" Nullable="false"/>
+            <Property Name="AppCatalogVersion" Type="Edm.String"/>
             <Property Name="CanUpgrade" Type="Edm.Boolean" Nullable="false"/>
             <Property Name="CDNLocation" Type="Edm.String"/>
             <Property Name="ContainsTenantWideExtension" Type="Edm.Boolean" Nullable="false"/>
@@ -38795,10 +38795,10 @@
          </EntityType>
          <EntityType Name="TenantAdminEndpoints">
             <Key>
-               <PropertyRef Name="CdnDefaultEndpoint"/>
+               <PropertyRef Name="AADAdminCenterEndpoint"/>
             </Key>
-            <Property Name="AADAdminCenterEndpoint" Type="Edm.String"/>
-            <Property Name="CdnDefaultEndpoint" Type="Edm.String" Nullable="false"/>
+            <Property Name="AADAdminCenterEndpoint" Type="Edm.String" Nullable="false"/>
+            <Property Name="CdnDefaultEndpoint" Type="Edm.String"/>
             <Property Name="CFRMSGraphEndpoint" Type="Edm.String"/>
             <Property Name="MigrationAgentUrl" Type="Edm.String"/>
             <Property Name="MiniMavenEndpoint" Type="Edm.String"/>
diff --git a/office365/directory/serviceprincipals/service_principal.py b/office365/directory/serviceprincipals/service_principal.py
@@ -114,28 +114,32 @@ def _after():
         else:
             self.context.service_principals.get_by_app(app).get().after_execute(action)
 
-    def get_delegated_permissions(self, app, principal=None, only_admin_consent=False):
-        # type: (Application|str, User|str, bool) -> DeltaCollection[OAuth2PermissionGrant]
+    def get_delegated_permissions(self, app, principal=None):
+        # type: (Application|str, User|str) -> ClientResult[StringCollection]
         """Gets a delegated API permission"""
 
-        return_type = DeltaCollection(self.context, OAuth2PermissionGrant)
+        return_type = ClientResult(self.context, StringCollection())
 
         def _get_delegated_permissions(client_id, principal_id=None):
             # type: (str, str) -> None
 
             if principal_id is None:
-
-                query_text = "clientId eq '{0}'".format(client_id)
-                if only_admin_consent:
-                    query_text = query_text + " and consentType eq 'AllPrincipals'"
-
+                query_text = (
+                    "clientId eq '{0}'  and consentType eq 'AllPrincipals'".format(
+                        client_id
+                    )
+                )
             else:
                 query_text = "principalId eq '{0}' and clientId eq '{1}'".format(
                     principal_id, client_id
                 )
 
             def _loaded(col):
-                [return_type.add_child(g) for g in col if g.resource_id == self.id]
+                scope_val = next(
+                    iter([g.scope for g in col if g.resource_id == self.id]), None
+                )
+                if scope_val is not None:
+                    [return_type.value.add(name) for name in scope_val.split(" ")]
 
             (
                 self.context.oauth2_permission_grants.get()
diff --git a/office365/onedrive/driveitems/driveItem.py b/office365/onedrive/driveitems/driveItem.py
@@ -366,7 +366,7 @@ def _save_content(return_type):
     def download_folder(
         self, download_file, after_file_downloaded=None, recursive=True
     ):
-        # type: (IO, Callable[[File], None], bool) -> "DriveItem"
+        # type: (IO, Callable[["DriveItem"], None], bool) -> "DriveItem"
         """
         Download the folder content
         """
diff --git a/office365/onedrive/driveitems/retention_label.py b/office365/onedrive/driveitems/retention_label.py
@@ -1,7 +1,11 @@
+from datetime import datetime
 from typing import Optional
 
 from office365.directory.permissions.identity_set import IdentitySet
 from office365.entity import Entity
+from office365.onedrive.driveitems.retention_label_settings import (
+    RetentionLabelSettings,
+)
 
 
 class ItemRetentionLabel(Entity):
@@ -23,3 +27,32 @@ def label_applied_by(self):
         # type: () -> Optional[IdentitySet]
         """Identity of the user who applied the label. Read-only."""
         return self.properties.get("labelAppliedBy", IdentitySet())
+
+    @property
+    def label_applied_datetime(self):
+        # type: () -> Optional[datetime]
+        """The date and time when the label was applied on the item.
+        The timestamp type represents date and time information using ISO 8601 format and is always in UTC.
+        """
+        return self.properties.get("labelAppliedDateTime", datetime.min)
+
+    @property
+    def name(self):
+        # type: () -> Optional[str]
+        """The retention label on the document. Read-write."""
+        return self.properties.get("name", None)
+
+    @property
+    def retention_settings(self):
+        # type: () -> RetentionLabelSettings
+        """The retention settings enforced on the item. Read-write."""
+        return self.properties.get("retentionSettings", RetentionLabelSettings())
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "labelAppliedBy": self.label_applied_by,
+                "retentionSettings": self.retention_settings,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(ItemRetentionLabel, self).get_property(name, default_value)
diff --git a/office365/onedrive/driveitems/retention_label_settings.py b/office365/onedrive/driveitems/retention_label_settings.py
@@ -0,0 +1,7 @@
+from office365.runtime.client_value import ClientValue
+
+
+class RetentionLabelSettings(ClientValue):
+    """
+    Groups all the compliance retention restrictions on the item into a single structure.
+    """
diff --git a/office365/onedrive/sitepages/base.py b/office365/onedrive/sitepages/base.py
@@ -7,6 +7,9 @@
 class BaseSitePage(BaseItem):
     """An abstract type that represents a page in the site page library."""
 
+    def __repr__(self):
+        return self.name or self.entity_type_name
+
     @property
     def publishing_state(self):
         # type: () -> Optional[str]
diff --git a/office365/onedrive/sitepages/collection.py b/office365/onedrive/sitepages/collection.py
@@ -10,10 +10,22 @@ class SitePageCollection(EntityCollection[SitePage]):
     def __init__(self, context, resource_path=None):
         super(SitePageCollection, self).__init__(context, SitePage, resource_path)
 
+    def get(self):
+        def _construct_request(request):
+            # type: (RequestOptions) -> None
+            # request.url += "/microsoft.graph.sitePage"
+            pass
+
+        return super(SitePageCollection, self).get().before_execute(_construct_request)
+
+    def get_by_name(self, name):
+        return self.single("name eq '{0}'".format(name))
+
     def add(self, title):
         """
         Create a new sitePage in the site pages list in a site.
 
+        :param str title:
         """
 
         def _construct_request(request):
diff --git a/office365/onedrive/sitepages/site_page.py b/office365/onedrive/sitepages/site_page.py
@@ -15,23 +15,23 @@ class SitePage(BaseSitePage):
     webParts."""
 
     def get_web_parts_by_position(
-        self, webPartIndex, horizontalSectionId, isInVerticalSection, columnId
+        self, web_part_index, horizontal_section_id, is_in_vertical_section, column_id
     ):
         """
         Get a collection of webPart by providing webPartPosition information.
 
-        :param float webPartIndex: Index of the current WebPart. Represents the order of WebPart in this column or
+        :param float web_part_index: Index of the current WebPart. Represents the order of WebPart in this column or
              section. Only works if either columnId or isInVerticalSection is provided.
-        :param float horizontalSectionId: Indicate the horizontal section where the WebPart located in.
-        :param bool isInVerticalSection: Indicate whether the WebPart located in the vertical section.
-        :param float columnId: Indicate the identifier of the column where the WebPart located in. Only works
+        :param float horizontal_section_id: Indicate the horizontal section where the WebPart located in.
+        :param bool is_in_vertical_section: Indicate whether the WebPart located in the vertical section.
+        :param float column_id: Indicate the identifier of the column where the WebPart located in. Only works
              if horizontalSectionId is provided.
         """
         params = {
-            "webPartIndex": webPartIndex,
-            "horizontalSectionId": horizontalSectionId,
-            "isInverticalSection": isInVerticalSection,
-            "columnId": columnId,
+            "webPartIndex": web_part_index,
+            "horizontalSectionId": horizontal_section_id,
+            "isInverticalSection": is_in_vertical_section,
+            "columnId": column_id,
         }
         return_type = EntityCollection(
             self.context, WebPart, ResourcePath("webParts", self.resource_path)
diff --git a/office365/runtime/client_object_collection.py b/office365/runtime/client_object_collection.py
@@ -8,6 +8,7 @@
 from office365.runtime.odata.json_format import ODataJsonFormat
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.types.event_handler import EventHandler
+from office365.runtime.types.exceptions import NotFoundException
 
 T = TypeVar("T")
 
@@ -213,8 +214,7 @@ def single(self, expression):
         def _after_loaded(col):
             # type: (ClientObjectCollection) -> None
             if len(col) == 0:
-                message = "Not found for filter: {0}".format(expression)
-                raise ValueError(message)
+                raise NotFoundException(return_type, expression)
             elif len(col) > 1:
                 message = "Ambiguous match found for filter: {0}".format(expression)
                 raise ValueError(message)
diff --git a/office365/runtime/types/exceptions.py b/office365/runtime/types/exceptions.py
@@ -0,0 +1,18 @@
+from office365.runtime.client_object import ClientObject
+
+
+class NotFoundException(Exception):
+    def __init__(self, entity=None, query=None):
+        # type: (ClientObject, str) -> None
+        self.entity = entity
+        self.query = query
+
+    def __str__(self):
+        if self.entity is None:
+            message = "Entity not found"
+        else:
+            message = "{0} not found".format(self.entity.entity_type_name)
+
+        if self.query is not None:
+            message = "{0} for query: {1}".format(message, self.query)
+        return message
diff --git a/office365/sharepoint/authpolicy/events/collection.py b/office365/sharepoint/authpolicy/events/collection.py
@@ -1,3 +1,4 @@
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.authpolicy.events.event import SPAuthEvent
 from office365.sharepoint.entity_collection import EntityCollection
 
@@ -9,3 +10,30 @@ def __init__(self, context, resource_path=None, parent=None):
         super(SPAuthEventCollection, self).__init__(
             context, SPAuthEvent, resource_path, parent
         )
+
+    def role_assignment_ms_graph_notify(
+        self, tenant, action, type_, resource_payload, id_, container_id
+    ):
+        """
+        :param str tenant:
+        :param str action:
+        :param str type_:
+        :param RoleAssignmentResourcePayload resource_payload:
+        :param str id_:
+        :param str container_id:
+        """
+        payload = {
+            "tenant": tenant,
+            "action": action,
+            "type": type_,
+            "resourcePayload": resource_payload,
+            "id": id_,
+            "containerId": container_id,
+        }
+        return_type = SPAuthEvent(self.context)
+        self.add_child(return_type)
+        qry = ServiceOperationQuery(
+            self, "RoleAssignmentMSGraphNotify", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
diff --git a/office365/sharepoint/authpolicy/events/role_assignment_resource_payload.py b/office365/sharepoint/authpolicy/events/role_assignment_resource_payload.py
@@ -3,3 +3,7 @@
 
 class RoleAssignmentResourcePayload(ClientValue):
     """ """
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.AuthPolicy.Events.RoleAssignmentResourcePayload"
diff --git a/office365/sharepoint/securestore/target_application.py b/office365/sharepoint/securestore/target_application.py
@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.client_context import ClientContext
 from office365.sharepoint.entity import Entity
@@ -27,6 +29,12 @@ def create(context, application_id, friendly_name):
         context.add_query(qry)
         return return_type
 
+    @property
+    def application_id(self):
+        # type: () -> Optional[str]
+        """"""
+        return self.properties.get("ApplicationId", None)
+
     @property
     def entity_type_name(self):
         return "Microsoft.Office.SecureStoreService.Server.TargetApplication"
diff --git a/office365/sharepoint/tenant/administration/app_billing_properties.py b/office365/sharepoint/tenant/administration/app_billing_properties.py
@@ -4,6 +4,16 @@
 class SPOAppBillingProperties(ClientValue):
     """ """
 
+    def __init__(self, application_id=None, azure_region=None, is_activated=None):
+        """
+        :param str application_id: The application ID.
+        :param str azure_region: The Azure region.
+        :param bool is_activated:
+        """
+        self.ApplicationId = application_id
+        self.AzureRegion = azure_region
+        self.IsActivated = is_activated
+
     @property
     def entity_type_name(self):
         return (
diff --git a/office365/sharepoint/tenant/administration/tenant.py b/office365/sharepoint/tenant/administration/tenant.py
@@ -700,16 +700,36 @@ def get_site_properties_from_sharepoint_by_filters(
         self.context.add_query(qry)
         return return_type
 
+    def get_billing_policy_id_for_app(self, application_id):
+        """ """
+        return_type = ClientResult(self.context)
+        payload = {"applicationId": application_id}
+        qry = ServiceOperationQuery(
+            self, "GetBillingPolicyIdForApp", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def connect_site_to_hub_site_by_id(self, site_url, hub_site_id):
         # type: (str, str) -> Self
-        """Connects Site to Hub Site"""
+        """Connects Site to Hub Site
+
+        :param str site_url:
+        :param str hub_site_id:
+        """
         params = {"siteUrl": site_url, "hubSiteId": hub_site_id}
         qry = ServiceOperationQuery(
             self, "ConnectSiteToHubSiteById", None, params, None, None
         )
         self.context.add_query(qry)
         return self
 
+    def ensure_brand_center_feature(self):
+        """Ensures that the Brand Center feature is enabled"""
+        qry = ServiceOperationQuery(self, "EnsureBrandCenterFeature")
+        self.context.add_query(qry)
+        return self
+
     def send_email(self, site_url):
         # type: (str) -> ClientResult[bool]
         """ """
diff --git a/office365/sharepoint/webs/web.py b/office365/sharepoint/webs/web.py
diff --git a/tests/onedrive/test_sitepage.py b/tests/onedrive/test_sitepage.py
diff --git a/tests/sharepoint/test_admin.py b/tests/sharepoint/test_admin.py
