Office365-REST-Python-Client 2.5.13__py3-none-any.whl → 2.5.14__py3-none-any.whl

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 @@ class SPAuthEventCollection(EntityCollection[SPAuthEvent]):
         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

office365/sharepoint/authpolicy/events/role_assignment_resource_payload.py

@@ -3,3 +3,7 @@ from office365.runtime.client_value import ClientValue
 
 class RoleAssignmentResourcePayload(ClientValue):
     """ """
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.AuthPolicy.Events.RoleAssignmentResourcePayload"

office365/sharepoint/documentmanagement/document_id.py

@@ -31,22 +31,47 @@ class DocumentId(Entity):
         self.context.add_query(qry)
         return self
 
-    def reset_docids_in_library(self, decoded_url, content_type_id):
+    def reset_doc_ids_in_library(self, decoded_url, content_type_id=None):
         """
         Performs the same function as ResetDocIdByServerRelativePath (section 3.1.5.10.2.1.1), but for every
         document in the specified document library.
 
         :param str decoded_url: Server relative path to the document library, for which all document identifiers
             MUST be reset to guarantee global uniqueness in the farm.
-        :param str content_type_id: The content type identifier.
+        :param str or None content_type_id: The content type identifier.
         """
-        payload = {"DecodedUrl": decoded_url, "contentTypeId": content_type_id}
+        payload = {"decodedUrl": decoded_url, "contentTypeId": content_type_id}
         qry = ServiceOperationQuery(
             self, "ResetDocIdsInLibrary", None, payload, None, None
         )
         self.context.add_query(qry)
         return self
 
+    def set_doc_id_site_prefix(
+        self, prefix, schedule_assignment, overwrite_existing_ids
+    ):
+        """
+        Allows to set or change the prefix used for Document IDs
+
+        :param str prefix:
+        :param bool schedule_assignment:
+        :param bool overwrite_existing_ids:
+        """
+        payload = {
+            "prefix": prefix,
+            "scheduleAssignment": schedule_assignment,
+            "overwriteExistingIds": overwrite_existing_ids,
+        }
+        qry = ServiceOperationQuery(
+            self, "SetDocIdSitePrefix", None, payload, None, None
+        )
+        self.context.add_query(qry)
+        return self
+
     @property
     def entity_type_name(self):
         return "SP.DocumentManagement.DocumentId"
+
+    @property
+    def entity_type_id(self):
+        return "fb7276a2-cd36-448b-8a60-a589205f5a8f"

office365/sharepoint/files/file.py

@@ -1,5 +1,6 @@
 import datetime
 from typing import TYPE_CHECKING, AnyStr
+from urllib.parse import quote
 
 import requests
 
@@ -607,8 +608,11 @@ class File(AbstractFile):
         :type server_relative_url: str
         :type content: str
         """
-        url = r"{0}/web/getFileByServerRelativePath(DecodedUrl='{1}')/\$value".format(
-            context.service_root_url(), server_relative_url
+        url = quote(
+            r"{0}/web/getFileByServerRelativePath(DecodedUrl='{1}')/\$value".format(
+                context.service_root_url(), server_relative_url
+            ),
+            safe=":/",
         )
         request = RequestOptions(url)
         request.method = HttpMethod.Post
@@ -626,8 +630,11 @@ class File(AbstractFile):
         :type server_relative_url: str
         :return Response
         """
-        url = r"{0}/web/getFileByServerRelativePath(DecodedUrl='{1}')/\$value".format(
-            context.service_root_url(), server_relative_url
+        url = quote(
+            r"{0}/web/getFileByServerRelativePath(DecodedUrl='{1}')/\$value".format(
+                context.service_root_url(), server_relative_url
+            ),
+            safe=":/",
         )
         request = RequestOptions(url)
         request.method = HttpMethod.Get

office365/sharepoint/files/versions/event.py

@@ -32,3 +32,12 @@ class FileVersionEvent(Entity):
         return self.properties.get(
             "SharedWithUsers", ClientValueCollection(SharedWithUser)
         )
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "SharedByUser": self.shared_by_user,
+                "SharedWithUsers": self.shared_with_users,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(FileVersionEvent, self).get_property(name, default_value)

office365/sharepoint/flows/permissions.py

@@ -0,0 +1,30 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.entity import Entity
+
+
+class FlowPermissions(Entity):
+
+    @staticmethod
+    def get_flow_permission_level_on_list(context, list_name):
+        """
+        :param office365.sharepoint.client_context.ClientContext context: SharePoint client context
+         :param str list_name: Specifies the list name.
+        """
+        return_type = ClientResult(context)
+        payload = {"listName": list_name}
+        qry = ServiceOperationQuery(
+            FlowPermissions(context),
+            "GetFlowPermissionLevelOnList",
+            None,
+            payload,
+            None,
+            return_type,
+            True,
+        )
+        context.add_query(qry)
+        return return_type
+
+    @property
+    def entity_type_name(self):
+        return "SP.Internal.FlowPermissions"

office365/sharepoint/listhome/favorite_item.py

@@ -0,0 +1,9 @@
+from office365.sharepoint.listhome.item import ListHomeItem
+
+
+class FavoriteListHomeItem(ListHomeItem):
+    """ """
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.ListHome.FavoriteListHomeItem"

office365/sharepoint/listitems/listitem.py

@@ -14,9 +14,11 @@ from office365.sharepoint.fields.image_value import ImageFieldValue
 from office365.sharepoint.fields.lookup_value import FieldLookupValue
 from office365.sharepoint.fields.multi_lookup_value import FieldMultiLookupValue
 from office365.sharepoint.fields.string_values import FieldStringValues
+from office365.sharepoint.fields.url_value import FieldUrlValue
 from office365.sharepoint.likes.liked_by_information import LikedByInformation
 from office365.sharepoint.listitems.compliance_info import ListItemComplianceInfo
 from office365.sharepoint.listitems.form_update_value import ListItemFormUpdateValue
+from office365.sharepoint.listitems.update_parameters import ListItemUpdateParameters
 from office365.sharepoint.listitems.versions.collection import ListItemVersionCollection
 from office365.sharepoint.permissions.securable_object import SecurableObject
 from office365.sharepoint.policy.dlp_policy_tip import DlpPolicyTip
@@ -275,7 +277,7 @@ class ListItem(SecurableObject):
         """Validates and sets the values of the specified collection of fields for the list item.
 
         :param dict form_values: Specifies a collection of field internal names and values for the given field
-        :param dict new_document_update: Specifies whether the list item is a document being updated after upload.
+        :param bool new_document_update: Specifies whether the list item is a document being updated after upload.
         :param str checkin_comment: Check-in comment, if any. This parameter is only applicable when the list item
              is checked out.
         :param bool or None dates_in_utc:
@@ -310,10 +312,59 @@ class ListItem(SecurableObject):
         super(ListItem, self).update()
         return self
 
+    def update_ex(self, bypass_quota_check=None, bypass_shared_lock=None):
+        """
+
+        :param bool bypass_quota_check:
+        :param bool bypass_shared_lock:
+        """
+        payload = {
+            "parameters": ListItemUpdateParameters(
+                bypass_quota_check, bypass_shared_lock
+            )
+        }
+        qry = ServiceOperationQuery(self, "UpdateEx", None, payload)
+        self.context.add_query(qry)
+        return self
+
     def system_update(self):
         """Update the list item."""
-        qry = ServiceOperationQuery(self, "SystemUpdate")
-        self.context.add_query(qry)
+
+        sys_metadata = ["EditorId", "Modified"]
+
+        def _after_system_update(result):
+            # type: (ClientResult[ClientValueCollection[ListItemFormUpdateValue]]) -> None
+            has_any_error = any([item.HasException for item in result.value])
+            if has_any_error:
+                raise ValueError("Update ListItem failed")
+
+        def _system_update():
+            from office365.sharepoint.fields.user_value import FieldUserValue
+
+            form_values = self.persistable_properties
+            for n in sys_metadata:
+                if n == "Id":
+                    pass
+                elif n.endswith("Id"):
+                    user = self.context.web.site_users.get_by_id(self.get_property(n))
+                    form_values[n[:-2]] = FieldUserValue.from_user(user)
+                else:
+                    form_values[n] = self.get_property(n)
+
+            self.validate_update_list_item(
+                form_values=form_values,
+                dates_in_utc=True,
+                new_document_update=True,
+            ).after_execute(_after_system_update)
+
+        def _list_loaded():
+            if self.parent_list.base_template == 101:
+                self.ensure_properties(sys_metadata, _system_update)
+            else:
+                next_qry = ServiceOperationQuery(self, "SystemUpdate")
+                self.context.add_query(next_qry)
+
+        self.parent_list.ensure_properties(["BaseTemplate"], _list_loaded)
         return self
 
     def update_overwrite_version(self):
@@ -332,6 +383,17 @@ class ListItem(SecurableObject):
         self.context.add_query(qry)
         return self
 
+    def set_compliance_tag_with_hold(self, compliance_tag):
+        """
+        Sets a compliance tag with a hold
+
+        :param str compliance_tag: The applying label (tag) to the list item
+        """
+        payload = {"complianceTag": compliance_tag}
+        qry = ServiceOperationQuery(self, "SetComplianceTagWithHold", None, payload)
+        self.context.add_query(qry)
+        return self
+
     def get_comments(self):
         """Retrieve ListItem comments"""
         return_type = CommentCollection(self.context)
@@ -377,7 +439,7 @@ class ListItem(SecurableObject):
         """Get parent List"""
         from office365.sharepoint.lists.list import List
 
-        return self.properties.get(
+        return self.properties.setdefault(
             "ParentList",
             List(self.context, ResourcePath("ParentList", self.resource_path)),
         )
@@ -507,12 +569,25 @@ class ListItem(SecurableObject):
             ),
         )
 
+    @property
+    def doc_id(self):
+        # type: () -> Optional[str]
+        """Document ID fora document"""
+        return self.properties.get("OData__dlc_DocId", None)
+
+    @property
+    def doc_id_url(self):
+        # type: () -> Optional[FieldUrlValue]
+        """Document ID fora document"""
+        return self.properties.get("OData__dlc_DocIdUrl", FieldUrlValue())
+
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {
                 "AttachmentFiles": self.attachment_files,
                 "ContentType": self.content_type,
                 "ComplianceInfo": self.compliance_info,
+                "OData__dlc_DocIdUrl": self.doc_id_url,
                 "EffectiveBasePermissions": self.effective_base_permissions,
                 "GetDlpPolicyTip": self.get_dlp_policy_tip,
                 "FieldValuesAsHtml": self.field_values_as_html,

office365/sharepoint/listitems/update_parameters.py

@@ -2,4 +2,7 @@ from office365.runtime.client_value import ClientValue
 
 
 class ListItemUpdateParameters(ClientValue):
-    pass
+
+    def __init__(self, bypass_quota_check=None, bypass_shared_lock=None):
+        self.BypassQuotaCheck = bypass_quota_check
+        self.BypassSharedLock = bypass_shared_lock

office365/sharepoint/lists/data_parameters.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class RenderListFilterDataParameters(ClientValue):
+    """Specifies the parameters that are used to retrieve filter data."""

office365/sharepoint/lists/exporter.py

@@ -0,0 +1,73 @@
+import json
+from typing import IO, AnyStr, Callable
+
+from typing_extensions import Self
+
+from office365.runtime.client_result import ClientResult
+from office365.sharepoint.files.system_object_type import FileSystemObjectType
+from office365.sharepoint.listitems.collection import ListItemCollection
+from office365.sharepoint.listitems.listitem import ListItem
+from office365.sharepoint.lists.list import List
+
+
+class ListExporter(object):
+
+    @staticmethod
+    def export(
+        source_list, destination_file, include_content=False, item_exported=None
+    ):
+        # type: (List, IO, bool, Callable[[ListItem], None]) -> Self
+        """Exports SharePoint List"""
+        import zipfile
+
+        def _append_file(name, data):
+            with zipfile.ZipFile(
+                destination_file.name, "a", zipfile.ZIP_DEFLATED
+            ) as zf:
+                zf.writestr(name, data)
+
+        def _download_content(list_item):
+            # type: (ListItem) -> None
+            def _after_downloaded(result):
+                # type: (ClientResult[AnyStr]) -> None
+                item_path = list_item.properties["FileRef"].replace(
+                    source_list.root_folder.serverRelativeUrl, ""
+                )
+                _append_file(item_path, result.value)
+
+            list_item.file.get_content().after_execute(_after_downloaded)
+
+        def _export_items(items):
+            # type: (ListItemCollection) -> None
+
+            for item in items:
+                item_path = str(item.id) + ".json"
+
+                if item.file_system_object_type == FileSystemObjectType.File:
+                    _append_file(item_path, json.dumps(item.to_json()))
+
+                    if include_content:
+                        _download_content(item)
+
+                    if callable(item_exported):
+                        item_exported(item)
+
+        def _get_items():
+            (
+                source_list.items.select(
+                    [
+                        "*",
+                        "Id",
+                        "FileRef",
+                        "FileDirRef",
+                        "FileLeafRef",
+                        "FileSystemObjectType",
+                    ]
+                )
+                .get()
+                .paged(page_loaded=_export_items)
+            )
+
+        source_list.ensure_properties(["SchemaXml", "RootFolder"], _get_items)
+
+        return source_list