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

office365/sharepoint/brandcenter/brand_center.py

@@ -0,0 +1,9 @@
+from office365.sharepoint.entity import Entity
+
+
+class BrandCenter(Entity):
+    """
+    The SharePoint brand center API offers a centralized branding management application
+    that empowers your brand managers or designated brand owners to help your organization to customize
+    the look and feel of their experiences.
+    """

office365/sharepoint/brandcenter/configuration.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class BrandCenterConfiguration(ClientValue):
+    """ """

office365/sharepoint/changes/change.py

@@ -16,9 +16,7 @@ class Change(Entity):
 
     @property
     def change_token(self):
-        """
-        Returns an ChangeToken that represents the change.
-        """
+        """Returns an ChangeToken that represents the change."""
         return self.properties.get("ChangeToken", ChangeToken())
 
     @property

office365/sharepoint/changes/collection.py

@@ -22,6 +22,7 @@ class ChangeCollection(EntityCollection[Change]):
         from office365.sharepoint.changes.item import ChangeItem
         from office365.sharepoint.changes.list import ChangeList
         from office365.sharepoint.changes.user import ChangeUser
+        from office365.sharepoint.changes.view import ChangeView
         from office365.sharepoint.changes.web import ChangeWeb
 
         if "ItemId" in properties and "ListId" in properties:
@@ -40,3 +41,5 @@ class ChangeCollection(EntityCollection[Change]):
             self._item_type = ChangeAlert
         elif "FieldId" in properties:
             self._item_type = ChangeField
+        elif "ViewId" in properties:
+            self._item_type = ChangeView

office365/sharepoint/changes/folder.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.changes.change import Change
 
 
@@ -6,8 +8,12 @@ class ChangeFolder(Change):
 
     @property
     def unique_id(self):
+        # type: () -> Optional[str]
+        """Identifies the folder that has changed."""
         return self.properties.get("UniqueId", None)
 
     @property
     def web_id(self):
+        # type: () -> Optional[str]
+        """Identifies the site that contains the changed folder."""
         return self.properties.get("WebId", None)

office365/sharepoint/changes/group.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.changes.change import Change
 
 
@@ -6,5 +8,6 @@ class ChangeGroup(Change):
 
     @property
     def group_id(self):
+        # type: () -> Optional[int]
         """Identifies the changed group."""
         return self.properties.get("GroupId", None)

office365/sharepoint/changes/list.py

@@ -16,9 +16,22 @@ class ChangeList(Change):
 
     @property
     def base_template(self):
+        # type: () -> Optional[int]
         """An SP.ListTemplateType object that returns the list template type of the list."""
         return self.properties.get("BaseTemplate", None)
 
+    @property
+    def editor(self):
+        # type: () -> Optional[str]
+        """A string that returns the name of the user who modified the list."""
+        return self.properties.get("Editor", None)
+
+    @property
+    def hidden(self):
+        # type: () -> Optional[bool]
+        """Returns a Boolean value that indicates whether a list is a hidden list."""
+        return self.properties.get("Hidden", None)
+
     @property
     def list_id(self):
         # type: () -> Optional[str]

office365/sharepoint/changes/view.py

@@ -0,0 +1,25 @@
+from typing import Optional
+
+from office365.sharepoint.changes.change import Change
+
+
+class ChangeView(Change):
+    """Specifies a change on a view."""
+
+    @property
+    def view_id(self):
+        # type: () -> Optional[str]
+        """Identifies the changed view."""
+        return self.properties.get("ViewId", None)
+
+    @property
+    def list_id(self):
+        # type: () -> Optional[str]
+        """Identifies the list that contains the changed view."""
+        return self.properties.get("ListId", None)
+
+    @property
+    def web_id(self):
+        # type: () -> Optional[str]
+        """Identifies the site that contains the changed view."""
+        return self.properties.get("WebId", None)

office365/sharepoint/client_context.py

@@ -42,7 +42,7 @@ class ClientContext(ClientRuntimeContext):
     """SharePoint client context (SharePoint v1 API)"""
 
     def __init__(self, base_url, auth_context=None):
-        # type: (str, AuthenticationContext) -> None
+        # type: (str, AuthenticationContext | None) -> None
         """
         Instantiates a SharePoint client context
 
@@ -411,6 +411,14 @@ class ClientContext(ClientRuntimeContext):
 
         return AnnouncementsController(self, ResourcePath("Announcements"))
 
+    @property
+    def brand_center(self):
+        """Alias to BrandCenter"""
+
+        from office365.sharepoint.brandcenter.brand_center import BrandCenter
+
+        return BrandCenter(self, ResourcePath("BrandCenter"))
+
     @property
     def client_people_picker(self):
         """Query principals service alias"""
@@ -702,6 +710,16 @@ class ClientContext(ClientRuntimeContext):
 
         return WorkflowServicesManager.current(self)
 
+    @property
+    def workflow_deployment_service(self):
+        """Alias to WorkflowServicesManager"""
+
+        from office365.sharepoint.workflowservices.deployment_service import (
+            WorkflowDeploymentService,
+        )
+
+        return WorkflowDeploymentService(self)
+
     @property
     def work_items(self):
         """"""

office365/sharepoint/contenttypes/fieldlinks/collection.py

@@ -1,3 +1,5 @@
+from typing_extensions import Self
+
 from office365.runtime.paths.service_operation import ServiceOperationPath
 from office365.runtime.queries.create_entity import CreateEntityQuery
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -52,6 +54,7 @@ class FieldLinkCollection(EntityCollection[FieldLink]):
         )
 
     def reorder(self, internal_names):
+        # type: (list[str]) -> Self
         """
         Rearranges the collection of field links in the order in which field internal names are specified.
 

office365/sharepoint/copilot/file_collection.py

@@ -0,0 +1,27 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.copilot.file_collection_query_result import (
+    CopilotFileCollectionQueryResult,
+)
+from office365.sharepoint.entity import Entity
+
+
+class CopilotFileCollection(Entity):
+    """ """
+
+    @staticmethod
+    def get_working_set_files(context, top=None, order_by=None, skip_token=None):
+        """ """
+        payload = {"top": top, "orderBy": order_by, "skipToken": skip_token}
+        return_type = ClientResult(context, CopilotFileCollectionQueryResult())
+        qry = ServiceOperationQuery(
+            CopilotFileCollection(context),
+            "GetWorkingSetFiles",
+            None,
+            payload,
+            None,
+            return_type,
+            True,
+        )
+        context.add_query(qry)
+        return return_type

office365/sharepoint/copilot/file_collection_query_result.py

@@ -0,0 +1,10 @@
+from office365.runtime.client_value import ClientValue
+
+
+class CopilotFileCollectionQueryResult(ClientValue):
+    """ """
+
+    @property
+    def entity_type_name(self):
+        # type: () -> str
+        return "Microsoft.SharePoint.Copilot.CopilotFileCollectionQueryResult"

office365/sharepoint/copilot/list_item_extensions.py

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

office365/sharepoint/directory/provider/alternate_id_data.py

@@ -4,6 +4,11 @@ from office365.runtime.client_value import ClientValue
 class AlternateIdData(ClientValue):
     """"""
 
+    def __init__(self, email=None, identifying_property=None, user_principal_name=None):
+        self.Email = email
+        self.IdentifyingProperty = identifying_property
+        self.UserPrincipalName = user_principal_name
+
     @property
     def entity_type_name(self):
         return "SP.Directory.Provider.AlternateIdData"

office365/sharepoint/directory/provider/notification.py

@@ -1,4 +1,5 @@
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
 
@@ -10,6 +11,13 @@ class DirectoryNotification(Entity):
             resource_path = ResourcePath("SP.Directory.Provider.DirectoryNotification")
         super(DirectoryNotification, self).__init__(context, resource_path)
 
+    def notify_changes(self, directory_object_changes):
+        """ """
+        payload = {"directoryObjectChanges": directory_object_changes}
+        qry = ServiceOperationQuery(self, "NotifyChanges", None, payload, None, None)
+        self.context.add_query(qry)
+        return self
+
     @property
     def entity_type_name(self):
         return "SP.Directory.Provider.DirectoryNotification"

office365/sharepoint/directory/provider/object_changes.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class DirectoryObjectChanges(ClientValue):
+    """ """

office365/sharepoint/directory/provider/object_data.py

@@ -1,13 +1,36 @@
 from office365.runtime.client_value import ClientValue
 from office365.sharepoint.directory.provider.alternate_id_data import AlternateIdData
+from office365.sharepoint.directory.provider.session_data import DirectorySessionData
 
 
 class DirectoryObjectData(ClientValue):
     """"""
 
-    def __init__(self, AlternateId=AlternateIdData(), Id=None):
-        self.AlternateId = AlternateId
-        self.Id = Id
+    def __init__(
+        self,
+        alternate_id=AlternateIdData(),
+        attribute_expiration_times=None,
+        change_marker=None,
+        directory_object_sub_type=None,
+        directory_object_type=None,
+        directory_session_data=DirectorySessionData(),
+        id_=None,
+        is_new=None,
+        last_modified_time=None,
+        tenant_context_id=None,
+        version=None,
+    ):
+        self.AlternateId = alternate_id
+        self.AttributeExpirationTimes = attribute_expiration_times
+        self.ChangeMarker = change_marker
+        self.DirectoryObjectSubType = directory_object_sub_type
+        self.DirectoryObjectType = directory_object_type
+        self.DirectorySessionData = directory_session_data
+        self.Id = id_
+        self.IsNew = is_new
+        self.LastModifiedTime = last_modified_time
+        self.TenantContextId = tenant_context_id
+        self.Version = version
 
     @property
     def entity_type_name(self):

office365/sharepoint/directory/provider/provider.py

@@ -14,6 +14,7 @@ class SharePointDirectoryProvider(Entity):
         super(SharePointDirectoryProvider, self).__init__(context, resource_path)
 
     def read_directory_object(self, data):
+        # type: (DirectoryObjectData) -> ClientResult[DirectoryObjectData]
         """"""
         return_type = ClientResult(self.context, DirectoryObjectData())
         payload = {"data": data}

office365/sharepoint/directory/provider/session_data.py

@@ -0,0 +1,9 @@
+from office365.runtime.client_value import ClientValue
+
+
+class DirectorySessionData(ClientValue):
+
+    @property
+    def entity_type_name(self):
+        # type: () -> str
+        return "SP.Directory.Provider.DirectorySessionData"

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."""