miscellaneous: add new types and methods for SharePoint API

Author: vgrem

examples/directory/applications/find_consent_grants.py

@@ -0,0 +1,34 @@
+"""
+Find consent grants for app permissions
+"""
+
+from office365.graph_client import GraphClient
+from tests import test_client_id, test_client_secret, test_tenant
+
+client = GraphClient(tenant=test_tenant).with_client_secret(
+    test_client_id, test_client_secret
+)
+
+
+col = client.service_principals.get().execute_query()
+for sp in col:
+    print("--- ", sp.display_name, " ---")
+
+    grants = sp.oauth2_permission_grants.get().execute_query()
+    if len(grants) > 0:
+        print("Delegated Permissions (User Consent)")
+        for grant in grants:
+            consent_info = grant.consent_type
+            if grant.consent_type != "AllPrincipals":
+                user = client.users[grant.principal_id].get().execute_query()
+                consent_info += " (" + user.user_principal_name + ")"
+            print(consent_info, ": ", grant.scope)
+
+    app_roles = sp.app_role_assignments.get().execute_query()
+    if len(app_roles) > 0:
+        print("Application Permissions (Admin Consent)")
+        for app_role in app_roles:
+            resource_sp = (
+                client.service_principals[app_role.resource_id].get().execute_query()
+            )
+            print(app_role.resource_display_name, ": ", resource_sp.app_roles)

examples/sharepoint/sharing/share_file.py

@@ -28,7 +28,7 @@
 print(json.dumps(result.value.to_json(), indent=4))
 link_url = result.value.sharingLinkInfo.Url
 
-print("Verifyng sharing link ...")
+print("Verifying sharing link ...")
 result = Web.get_sharing_link_kind(ctx, link_url).execute_query()
 print(sharing_messages.get(result.value, "Unknown sharing link"))
 
@@ -39,6 +39,6 @@
 print("Unsharing a file link...")
 remote_file.unshare_link(SharingLinkKind.AnonymousView).execute_query()
 
-# Get a file sharing info
+# Get file sharing info
 info = remote_file.get_sharing_information().execute_query()
 print("AnonymousViewLink:", info.properties.get("AnonymousViewLink"))

office365/directory/protection/information.py

@@ -11,6 +11,60 @@
 class InformationProtection(Entity):
     """Exposes methods that you can use to get Microsoft Purview Information Protection labels and label policies."""
 
+    def create_email_file_assessment(
+        self, recipient_email, content_data, expected_assessment, category
+    ):
+        """Create an email assessment request
+
+        :param str recipient_email: The mail recipient whose policies are used to assess the mail.
+        :param str content_data: Base64 encoded file content. The file content can't fetch back because it isn't stored.
+        :param str expected_assessment: The expected assessment from submitter. Possible values are: block, unblock.
+        :param str category: The threat category. Possible values are: spam, phishing, malware.
+        """
+
+        from office365.directory.protection.threatassessment.requests.email_file import (
+            EmailFileAssessmentRequest,
+        )
+
+        return_type = EmailFileAssessmentRequest(self.context)
+        return_type.set_property("recipientEmail", recipient_email)
+        return_type.set_property("contentData", content_data)
+        return_type.set_property("expectedAssessment", expected_assessment)
+        return_type.set_property("category", category)
+        self.threat_assessment_requests.add_child(return_type)
+        qry = CreateEntityQuery(
+            self.threat_assessment_requests, return_type, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def create_file_assessment(
+        self, file_name, content_data, expected_assessment, category
+    ):
+        """Create a new threat assessment request.
+
+        :param str file_name: File name
+        :param str content_data: Base64 encoded file content. The file content can't fetch back because it isn't stored.
+        :param str expected_assessment: The expected assessment from submitter. Possible values are: block, unblock.
+        :param str category: The threat category. Possible values are: spam, phishing, malware.
+        """
+
+        from office365.directory.protection.threatassessment.requests.file import (
+            FileAssessmentRequest,
+        )
+
+        return_type = FileAssessmentRequest(self.context)
+        return_type.set_property("fileName", file_name)
+        return_type.set_property("contentData", content_data)
+        return_type.set_property("expectedAssessment", expected_assessment)
+        return_type.set_property("category", category)
+        self.threat_assessment_requests.add_child(return_type)
+        qry = CreateEntityQuery(
+            self.threat_assessment_requests, return_type, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def create_url_assessment(self, url, expected_assessment, category):
         """Create a new threat assessment request."""
         from office365.directory.protection.threatassessment.requests.url import (

office365/directory/protection/threatassessment/requests/file.py

@@ -0,0 +1,10 @@
+from office365.directory.protection.threatassessment.requests.request import (
+    ThreatAssessmentRequest,
+)
+
+
+class FileAssessmentRequest(ThreatAssessmentRequest):
+    """Used to create and retrieve a file threat assessment, derived from threatAssessmentRequest.
+
+    The file can be a text file or Word document or binary file received in an email attachment.
+    """

office365/sharepoint/activities/client_response.py

@@ -4,12 +4,12 @@
 class ActivityClientResponse(ClientValue):
     """"""
 
-    def __init__(self, id_, message=None, serverId=None, status=None):
+    def __init__(self, id_, message=None, server_id=None, status=None):
         # type: (str, str, str, int) -> None
         """ """
         self.id = id_
         self.message = message
-        self.serverId = serverId
+        self.serverId = server_id
         self.status = status
 
     @property

office365/sharepoint/client_context.py

@@ -417,6 +417,16 @@ def client_people_picker(self):
 
         return ClientPeoplePickerWebServiceInterface(self)
 
+    @property
+    def component_context_info(self):
+        """ComponentContextInfo alias"""
+
+        from office365.sharepoint.clientsidecomponent.component_context_info import (
+            ComponentContextInfo,
+        )
+
+        return ComponentContextInfo(self, ResourcePath("ComponentContextInfo"))
+
     @property
     def consumer_permissions(self):
         """Consumer permissions alias"""

office365/sharepoint/compliance/preserve_document_submitter.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.entity import Entity
+
+
+class PreserveDocumentSubmitter(Entity):
+    """ """

office365/sharepoint/compliance/store_proxy.py

@@ -12,6 +12,8 @@
 
 
 class SPPolicyStoreProxy(Entity):
+    """ """
+
     @staticmethod
     def check_site_is_deletable_by_id(context, site_id, return_type=None):
         # type: (ClientContext, str, Optional[ClientResult[bool]]) -> ClientResult[bool]
@@ -84,6 +86,79 @@ def get_dynamic_scope_binding_by_site_id(self, site_id):
         self.context.add_query(qry)
         return return_type
 
+    @staticmethod
+    def get_list_compliance_tag(context, list_url, return_type=None):
+        """ """
+        if return_type is None:
+            return_type = ClientResult(context, ComplianceTag())
+        payload = {"listUrl": list_url}
+        qry = ServiceOperationQuery(
+            SPPolicyStoreProxy(context),
+            "GetListComplianceTag",
+            None,
+            payload,
+            None,
+            return_type,
+            True,
+        )
+        context.add_query(qry)
+        return return_type
+
+    @staticmethod
+    def set_list_compliance_tag(
+        context,
+        list_url,
+        compliance_tag_value,
+        block_delete=None,
+        block_edit=None,
+        sync_to_items=None,
+    ):
+        """ """
+        payload = {
+            "listUrl": list_url,
+            "complianceTagValue": compliance_tag_value,
+            "blockDelete": block_delete,
+            "blockEdit": block_edit,
+            "syncToItems": sync_to_items,
+        }
+        binding_type = SPPolicyStoreProxy(context)
+        qry = ServiceOperationQuery(
+            binding_type,
+            "SetListComplianceTag",
+            None,
+            payload,
+            None,
+            None,
+            True,
+        )
+        context.add_query(qry)
+        return binding_type
+
+    @staticmethod
+    def lock_record_item(
+        context, list_url, item_id, refresh_labeled_time, return_type=None
+    ):
+        """ """
+        if return_type is None:
+            return_type = ClientResult(context, int())
+        payload = {
+            "listUrl": list_url,
+            "itemId": item_id,
+            "refreshLabeledTime": refresh_labeled_time,
+        }
+
+        qry = ServiceOperationQuery(
+            SPPolicyStoreProxy(context),
+            "LockRecordItem",
+            None,
+            payload,
+            None,
+            return_type,
+            True,
+        )
+        context.add_query(qry)
+        return return_type
+
     @property
     def entity_type_name(self):
         return "SP.CompliancePolicy.SPPolicyStoreProxy"

office365/sharepoint/convergence/migration_complete_state_api.py

@@ -0,0 +1,9 @@
+from office365.sharepoint.entity import Entity
+
+
+class MigrationCompleteStateApi(Entity):
+    """"""
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Convergence.MigrationCompleteStateApi"

office365/sharepoint/files/collection.py

@@ -11,6 +11,7 @@
 from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.files.creation_information import FileCreationInformation
 from office365.sharepoint.files.file import File
+from office365.sharepoint.files.publish.status import FileStatus
 from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
 
 if TYPE_CHECKING:
@@ -24,6 +25,15 @@ def __init__(self, context, resource_path=None, parent=None):
         # type: (ClientContext, ResourcePath, Folder) -> None
         super(FileCollection, self).__init__(context, File, resource_path, parent)
 
+    def get_published_file(self, base_file_path):
+        """ """
+        return_type = FileStatus(self.context)
+        qry = ServiceOperationQuery(
+            self, "GetPublishedFile", [base_file_path], None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def upload(self, path_or_file, file_name=None):
         # type: (str|IO, str) -> File
         """Uploads a file into folder.