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

office365/sharepoint/client_context.py

@@ -41,8 +41,15 @@ from office365.sharepoint.webs.web import Web
 class ClientContext(ClientRuntimeContext):
     """SharePoint client context (SharePoint v1 API)"""
 
-    def __init__(self, base_url, auth_context=None):
-        # type: (str, AuthenticationContext | None) -> None
+    def __init__(
+        self,
+        base_url,
+        auth_context=None,
+        environment=None,
+        allow_ntlm=False,
+        browser_mode=False,
+    ):
+        # type: (str, Optional[AuthenticationContext], str, bool, bool) -> None
         """
         Instantiates a SharePoint client context
 
@@ -51,7 +58,12 @@ class ClientContext(ClientRuntimeContext):
         """
         super(ClientContext, self).__init__()
         if auth_context is None:
-            auth_context = AuthenticationContext(url=base_url)
+            auth_context = AuthenticationContext(
+                url=base_url,
+                environment=environment,
+                allow_ntlm=allow_ntlm,
+                browser_mode=browser_mode,
+            )
         self._auth_context = auth_context
         self._web = None
         self._site = None
@@ -138,36 +150,18 @@ class ClientContext(ClientRuntimeContext):
         self.authentication_context.with_access_token(token_func)
         return self
 
-    def with_user_credentials(
-        self,
-        username,
-        password,
-        allow_ntlm=False,
-        browser_mode=False,
-        environment="commercial",
-    ):
-        # type: (str, str, bool, bool, Optional[str]) -> Self
+    def with_user_credentials(self, username, password):
+        # type: (str, str) -> Self
         """
         Initializes a client to acquire a token via user credentials.
         :param str username: Typically, a UPN in the form of an email address
         :param str password: The password
-        :param bool allow_ntlm: Flag indicates whether NTLM scheme is enabled. Disabled by default
-        :param bool browser_mode:
-        :param str environment: The Office 365 Cloud Environment endpoint used for authentication
-            defaults to 'commercial'.
         """
-        self.authentication_context.with_credentials(
-            UserCredential(username, password),
-            allow_ntlm=allow_ntlm,
-            browser_mode=browser_mode,
-            environment=environment,
-        )
+        self.authentication_context.with_credentials(UserCredential(username, password))
         return self
 
-    def with_client_credentials(
-        self, client_id, client_secret, environment="commercial"
-    ):
-        # type: (str, str, Optional[str]) -> Self
+    def with_client_credentials(self, client_id, client_secret):
+        # type: (str, str) -> Self
         """
         Initializes a client to acquire a token via client credentials (SharePoint App-Only)
 
@@ -176,25 +170,19 @@ class ClientContext(ClientRuntimeContext):
 
         :param str client_id: The OAuth client id of the calling application
         :param str client_secret: Secret string that the application uses to prove its identity when requesting a token
-        :param str environment: The Office 365 Cloud Environment endpoint used for authentication
-            defaults to 'commercial'.
         """
         self.authentication_context.with_credentials(
-            ClientCredential(client_id, client_secret), environment=environment
+            ClientCredential(client_id, client_secret)
         )
         return self
 
-    def with_credentials(self, credentials, environment="commercial"):
-        # type: (UserCredential|ClientCredential, Optional[str]) -> Self
+    def with_credentials(self, credentials):
+        # type: (UserCredential|ClientCredential) -> Self
         """
         Initializes a client to acquire a token via user or client credentials
         :type credentials: UserCredential or ClientCredential
-        :param str environment: The Office 365 Cloud Environment endpoint used for authentication
-            defaults to 'commercial'.
         """
-        self.authentication_context.with_credentials(
-            credentials, environment=environment
-        )
+        self.authentication_context.with_credentials(credentials)
         return self
 
     def execute_batch(self, items_per_batch=100, success_callback=None):
@@ -498,6 +486,22 @@ class ClientContext(ClientRuntimeContext):
 
         return FolderColoring(self, ResourcePath("foldercoloring"))
 
+    @property
+    def font_packages(self):
+        """Alias to FontPackageCollection"""
+
+        from office365.sharepoint.fontpackages.collection import FontPackageCollection
+
+        return FontPackageCollection(self, ResourcePath("fontpackages"))
+
+    @property
+    def site_font_packages(self):
+        """Alias to FontPackageCollection"""
+
+        from office365.sharepoint.fontpackages.collection import FontPackageCollection
+
+        return FontPackageCollection(self, ResourcePath("sitefontpackages"))
+
     @property
     def group_site_manager(self):
         """Alias to GroupSiteManager"""
@@ -542,6 +546,16 @@ class ClientContext(ClientRuntimeContext):
 
         return ProfileLoader(self)
 
+    @property
+    def document_crawl_log(self):
+        """Alias to DocumentCrawlLog"""
+
+        from office365.sharepoint.search.administration.document_crawl_log import (
+            DocumentCrawlLog,
+        )
+
+        return DocumentCrawlLog(self)
+
     @property
     def lists(self):
         """Alias to ListCollection. Gets information about all lists that the current user can access."""
@@ -636,7 +650,7 @@ class ClientContext(ClientRuntimeContext):
     @property
     def home_site(self):
         """Alias to SPHSite."""
-        from office365.sharepoint.sites.sph_site import SPHSite
+        from office365.sharepoint.sites.home.site import SPHSite
 
         return SPHSite(self, ResourcePath("SPHSite"))
 
@@ -661,8 +675,17 @@ class ClientContext(ClientRuntimeContext):
             self, SPMachineLearningPublication, ResourcePath("publications")
         )
 
+    @property
+    def server_settings(self):
+        """Provides methods for obtaining server properties"""
+
+        from office365.sharepoint.server_settings import ServerSettings
+
+        return ServerSettings(self)
+
     @property
     def social_following_manager(self):
+        """ """
         from office365.sharepoint.social.following.manager import SocialFollowingManager
 
         return SocialFollowingManager(self)
@@ -697,6 +720,7 @@ class ClientContext(ClientRuntimeContext):
 
     @property
     def viva_site_manager(self):
+        """"""
         from office365.sharepoint.viva.site_manager import VivaSiteManager
 
         return VivaSiteManager(self)

office365/sharepoint/directory/group.py

@@ -5,6 +5,8 @@ from office365.sharepoint.entity_collection import EntityCollection
 
 
 class Group(Entity):
+    """ """
+
     def get_members_info(self, row_limit):
         """"""
         return_type = MembersInfo(self.context)

office365/sharepoint/directory/helper.py

@@ -88,6 +88,8 @@ class SPHelper(Entity):
     @staticmethod
     def get_my_groups(context, logon_name, offset, length, return_type=None):
         """
+        Retrieves information about groups that a user belongs to.
+
         :param office365.sharepoint.client_context.ClientContext context: SharePoint context
         :param str logon_name: User's login
         :param int offset: Result offset

office365/sharepoint/directory/provider/provider.py

@@ -13,6 +13,12 @@ class SharePointDirectoryProvider(Entity):
             )
         super(SharePointDirectoryProvider, self).__init__(context, resource_path)
 
+    def check_site_availability(self, site_url):
+        """"""
+        from office365.sharepoint.directory.helper import SPHelper
+
+        return SPHelper.check_site_availability(self.context, site_url)
+
     def read_directory_object(self, data):
         # type: (DirectoryObjectData) -> ClientResult[DirectoryObjectData]
         """"""

office365/sharepoint/directory/user.py

@@ -1,10 +1,27 @@
+from typing import Optional
+
 from office365.runtime.client_result import ClientResult
 from office365.sharepoint.directory.my_groups_result import MyGroupsResult
 from office365.sharepoint.entity import Entity
 
 
 class User(Entity):
+    """Represents a user in the SharePoint Directory"""
+
+    @property
+    def about_me(self):
+        # type: () -> Optional[str]
+        """Stores a short description or bio of the user."""
+        return self.properties.get("aboutMe", None)
+
+    @property
+    def account_enabled(self):
+        # type: () -> Optional[bool]
+        """Gets weather the account is active (user can log in and access services) or not"""
+        return self.properties.get("accountEnabled", None)
+
     def is_member_of(self, group_id):
+        # type: (str) -> ClientResult[bool]
         return_type = ClientResult(self.context)
 
         def _user_loaded():
@@ -18,6 +35,9 @@ class User(Entity):
         return return_type
 
     def get_my_groups(self):
+        """
+        Retrieves information about groups that a user belongs to.
+        """
         return_type = MyGroupsResult(self.context)
 
         def _user_loaded():

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/publish/status.py

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

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/connector_result.py

@@ -0,0 +1,17 @@
+from typing import Optional
+
+from office365.sharepoint.entity import Entity
+
+
+class ConnectorResult(Entity):
+    """ """
+
+    @property
+    def context_data(self):
+        # type: () -> Optional[str]
+        return self.properties.get("ContextData", None)
+
+    @property
+    def value(self):
+        # type: () -> Optional[str]
+        return self.properties.get("Value", None)

office365/sharepoint/flows/permissions.py

@@ -0,0 +1,34 @@
+from typing import TYPE_CHECKING, Optional
+
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.entity import Entity
+from office365.sharepoint.flows.connector_result import ConnectorResult
+
+if TYPE_CHECKING:
+    from office365.sharepoint.client_context import ClientContext
+
+
+class FlowPermissions(Entity):
+
+    @staticmethod
+    def get_flow_permission_level_on_list(context, list_name, return_type=None):
+        # type: (ClientContext, str, Optional[ConnectorResult]) -> ConnectorResult
+        """ """
+        if return_type is None:
+            return_type = ConnectorResult(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/fontpackages/collection.py

@@ -0,0 +1,26 @@
+from typing import TYPE_CHECKING, Optional
+
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.paths.service_operation import ServiceOperationPath
+from office365.sharepoint.entity_collection import EntityCollection
+from office365.sharepoint.fontpackages.font_package import FontPackage
+
+if TYPE_CHECKING:
+    from office365.sharepoint.client_context import ClientContext
+
+
+class FontPackageCollection(EntityCollection):
+    """Represents a collection of View resources."""
+
+    def __init__(self, context, resource_path=None):
+        # type: (ClientContext, Optional[ResourcePath]) -> None
+        super(FontPackageCollection, self).__init__(context, FontPackage, resource_path)
+
+    def get_by_title(self, title):
+        """
+        :param str title: The title of the font package to return.
+        """
+        return FontPackage(
+            self.context,
+            ServiceOperationPath("GetByTitle", [title], self.resource_path),
+        )

office365/sharepoint/fontpackages/creation_parameters.py

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

office365/sharepoint/fontpackages/font_package.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.entity import Entity
+
+
+class FontPackage(Entity):
+    """Represents a font package."""

office365/sharepoint/fontpackages/oob_settings.py

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

office365/sharepoint/forms/customization.py

@@ -1,7 +1,33 @@
+from typing import TYPE_CHECKING, Optional
+
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
+from office365.sharepoint.flows.connector_result import ConnectorResult
+
+if TYPE_CHECKING:
+    from office365.sharepoint.client_context import ClientContext
 
 
 class FormsCustomization(Entity):
+
+    @staticmethod
+    def can_customize_forms(context, list_name, return_type=None):
+        # type: (ClientContext, str, Optional[ConnectorResult]) -> ConnectorResult
+        """"""
+        if return_type is None:
+            return_type = ConnectorResult(context)
+        payload = {"listName": list_name}
+        qry = ServiceOperationQuery(
+            FormsCustomization(context),
+            "CanCustomizeForms",
+            None,
+            payload,
+            None,
+            return_type,
+        )
+        context.add_query(qry)
+        return return_type
+
     @property
     def entity_type_name(self):
         return "SP.Internal.FormsCustomization"

office365/sharepoint/ir/migration.py

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

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