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

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

@@ -7,41 +7,41 @@ from office365.sharepoint.entity_collection import EntityCollection
 class Group(Entity):
     def get_members_info(self, row_limit):
         """"""
-        result = MembersInfo(self.context)
+        return_type = MembersInfo(self.context)
 
         def _user_loaded():
             from office365.sharepoint.directory.helper import SPHelper
 
             SPHelper.get_members_info(
-                self.context, self.properties["Id"], row_limit, result
+                self.context, self.properties["Id"], row_limit, return_type
             )
 
         self.ensure_property("Id", _user_loaded)
-        return result
+        return return_type
 
     def get_members(self):
         """"""
         from office365.directory.users.user import User
 
-        members = EntityCollection(self.context, User)
+        return_type = EntityCollection(self.context, User)
 
         def _group_loaded():
-            SPHelper.get_members(self.context, self.properties["Id"], members)
+            SPHelper.get_members(self.context, self.properties["Id"], return_type)
 
         self.ensure_property("Id", _group_loaded)
-        return members
+        return return_type
 
     def get_owners(self):
         """"""
         from office365.directory.users.user import User
 
-        owners = EntityCollection(self.context, User)
+        return_type = EntityCollection(self.context, User)
 
         def _group_loaded():
-            SPHelper.get_owners(self.context, self.properties["Id"], owners)
+            SPHelper.get_owners(self.context, self.properties["Id"], return_type)
 
         self.ensure_property("Id", _group_loaded)
-        return owners
+        return return_type
 
     @property
     def entity_type_name(self):

office365/sharepoint/directory/helper.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -16,6 +18,7 @@ class SPHelper(Entity):
 
     @staticmethod
     def is_member_of(context, principal_name, group_id, result=None):
+        # type: (ClientContext, str, str, Optional[ClientResult[bool]]) -> ClientResult[bool]
         """
         :param str principal_name: User principal name
         :param str group_id: Group id
@@ -34,10 +37,7 @@ class SPHelper(Entity):
     @staticmethod
     def check_site_availability(context, site_url):
         # type: (ClientContext, str) -> ClientResult[bool]
-        """
-        :param str site_url: Site Url
-        :param office365.sharepoint.client_context.ClientContext context: SharePoint context
-        """
+        """ """
         return_type = ClientResult(context)
         qry = ServiceOperationQuery(
             SPHelper(context),
@@ -121,6 +121,7 @@ class SPHelper(Entity):
 
     @staticmethod
     def get_owners(context, group_id, return_type=None):
+        # type: (ClientContext, str, Optional[EntityCollection[User]]) -> SPHelper
         """
         :param str group_id: Group identifier
         :param office365.sharepoint.client_context.ClientContext context: SharePoint context
@@ -137,6 +138,7 @@ class SPHelper(Entity):
 
     @staticmethod
     def remove_external_members(context, group_id):
+        # type: (ClientContext, str) -> SPHelper
         """
         :param str group_id: Group identifier
         :param office365.sharepoint.client_context.ClientContext context: SharePoint context

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

@@ -1,10 +1,11 @@
-from typing import TYPE_CHECKING, Callable
+from typing import TYPE_CHECKING, Callable, List
 
 from typing_extensions import Self
 
 from office365.runtime.auth.client_credential import ClientCredential
 from office365.runtime.auth.user_credential import UserCredential
 from office365.runtime.client_object import ClientObject
+from office365.runtime.client_result import ClientResult
 from office365.runtime.paths.v3.entity import EntityPath
 from office365.runtime.queries.delete_entity import DeleteEntityQuery
 from office365.runtime.queries.update_entity import UpdateEntityQuery
@@ -22,13 +23,13 @@ class Entity(ClientObject):
         return self
 
     def execute_batch(self, items_per_batch=100, success_callback=None):
-        # type: (int, Callable[[int], None]) -> Self
+        # type: (int, Callable[[List[ClientObject|ClientResult]], None]) -> Self
         """Construct and submit to a server a batch request"""
         return self.context.execute_batch(items_per_batch, success_callback)
 
     def with_credentials(self, credentials):
         # type: (UserCredential|ClientCredential) -> Self
-        """ """
+        """Initializes a client to acquire a token via user or client credentials"""
         self.context.with_credentials(credentials)
         return self
 

office365/sharepoint/lists/list.py

@@ -1,6 +1,9 @@
+import json
 import os
 from datetime import datetime
-from typing import TYPE_CHECKING, AnyStr, Dict, Optional
+from typing import IO, TYPE_CHECKING, AnyStr, Callable, Dict, Optional
+
+from typing_extensions import Self
 
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
@@ -24,6 +27,7 @@ from office365.sharepoint.files.checked_out_file_collection import (
     CheckedOutFileCollection,
 )
 from office365.sharepoint.files.file import File
+from office365.sharepoint.files.system_object_type import FileSystemObjectType
 from office365.sharepoint.flows.synchronization_result import FlowSynchronizationResult
 from office365.sharepoint.folders.folder import Folder
 from office365.sharepoint.forms.collection import FormCollection
@@ -77,6 +81,64 @@ class List(SecurableObject):
     def __repr__(self):
         return self.id or self.title or self.entity_type_name
 
+    def export(self, local_file, include_content=False, item_exported=None):
+        # type: (IO, bool, Callable[[ListItem|File|Folder], None]) -> Self
+        """Exports SharePoint List"""
+        import zipfile
+
+        def _append_file(name, data):
+            with zipfile.ZipFile(local_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(
+                    self.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 = item.properties["FileRef"].replace(self.root_folder.serverRelativeUrl, "")
+                item_path = str(item.id) + ".json"
+
+                if item.file_system_object_type == FileSystemObjectType.Folder:
+                    pass
+                else:
+                    _append_file(item_path, json.dumps(item.to_json()))
+
+                    if include_content:
+                        _download_content(item)
+
+                    if callable(item_exported):
+                        item_exported(item)
+
+        def _save_schema():
+            (
+                self.items.select(
+                    [
+                        "*",
+                        "Id",
+                        "FileRef",
+                        "FileDirRef",
+                        "FileLeafRef",
+                        "FileSystemObjectType",
+                    ]
+                )
+                # .expand(["File", "Folder"])
+                .get().paged(page_loaded=_export_items)
+            )
+
+        self.ensure_properties(["SchemaXml", "RootFolder"], _save_schema)
+
+        return self
+
     def clear(self):
         """Clears the list."""
 
@@ -125,6 +187,7 @@ class List(SecurableObject):
         return self
 
     def get_async_action_config(self):
+        """ """
         return_type = ClientResult(self.context)
         qry = ServiceOperationQuery(
             self, "GetAsyncActionConfig", return_type=return_type

office365/sharepoint/logger/log_export.py

@@ -14,12 +14,14 @@ class LogExport(Entity):
         )
 
     def get_files(self):
+        """ """
         return_type = LogFileInfoCollection(self.context)
         qry = ServiceOperationQuery(self, "GetFiles", None, None, None, return_type)
         self.context.add_query(qry)
         return return_type
 
     def get_log_types(self):
+        """ """
         return_type = ClientResult(self.context)
         qry = ServiceOperationQuery(self, "GetLogTypes", None, None, None, return_type)
         self.context.add_query(qry)

office365/sharepoint/migrationcenter/service/performance/data.py

@@ -31,14 +31,14 @@ class PerformanceDataCollection(EntityCollection[PerformanceData]):
             context, PerformanceData, resource_path
         )
 
-    def get_data(self, StartTime=None, EndTime=None, AgentId=None, TimeUnit=None):
+    def get_data(self, start_time=None, end_time=None, agent_id=None, time_unit=None):
         """ """
         return_type = ClientResult(self.context, PerformanceDashboardData())
         payload = {
-            "StartTime": StartTime,
-            "EndTime": EndTime,
-            "AgentId": AgentId,
-            "TimeUnit": TimeUnit,
+            "StartTime": start_time,
+            "EndTime": end_time,
+            "AgentId": agent_id,
+            "TimeUnit": time_unit,
         }
         qry = ServiceOperationQuery(self, "GetData", None, payload, None, return_type)
         self.context.add_query(qry)

office365/sharepoint/multigeo/services.py

@@ -1,7 +1,11 @@
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.multigeo.unified_group import UnifiedGroup
+from office365.sharepoint.multigeo.user_personal_site_location import (
+    UserPersonalSiteLocation,
+)
 
 
 class MultiGeoServices(Entity):
@@ -15,6 +19,26 @@ class MultiGeoServices(Entity):
     data residency requirements.
     """
 
+    def __init__(self, context):
+        static_path = ResourcePath(
+            "Microsoft.Online.SharePoint.MultiGeo.Service.MultiGeoServicesBeta"
+        )
+        super(MultiGeoServices, self).__init__(context, static_path)
+
+    def user_personal_site_location(self, user_principal_name):
+        # type: (str) -> UserPersonalSiteLocation
+        return_type = UserPersonalSiteLocation(self.context)
+        qry = ServiceOperationQuery(
+            self,
+            "UserPersonalSiteLocation",
+            [user_principal_name],
+            None,
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def unified_groups(self):
         # type: () -> EntityCollection[UnifiedGroup]

office365/sharepoint/navigation/menu_node.py

@@ -1,15 +1,57 @@
 from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.sharepoint.translation.resource_entry import SPResourceEntry
 
 
 class MenuNode(ClientValue):
     """Represents a navigation node in the navigation hierarchy. A navigation hierarchy is a tree structure of
     navigation nodes."""
 
-    def __init__(self, current_lcid=None, title=None):
+    def __init__(
+        self,
+        audience_ids=None,
+        current_lcid=None,
+        title=None,
+        is_deleted=None,
+        is_hidden=None,
+        key=None,
+        nodes=None,
+        node_type=None,
+        open_in_new_window=None,
+        simple_url=None,
+        translations=None,
+    ):
         """
+        :param list[str] audience_ids:
         :param int current_lcid:
         :param str title: Specifies the title of the navigation node. The value is in the preferred language of the
             user, if available, or is in the default language of the site (2) as a fallback.
+        :param int node_type: Specifies the type of the navigation node.
+        :param bool is_deleted: A client MUST use this property set to TRUE to indicate that this node MUST be
+             deleted by the server. When set to TRUE the server MUST delete the node including all the child nodes
+             when present. When set to FALSE the server SHOULD NOT delete this node.
+        :param bool is_hidden: Specifies whether the node will be hidden in the navigation menu. During editing,
+             all nodes temporarily become visible so that they can be edited.
+        :param str key: Specifies the identifier for the navigation node in the menu tree. If the navigation node does
+             not exist on the protocol server, this value MUST be an empty string.
+        :param list[MenuNode] nodes:
+        :param bool open_in_new_window:
+        :param str simple_url: If the NodeType (section 3.2.5.244.1.1.7) property is set to "SimpleLink",
+            this property represents the URL of the navigation node. The URL can be relative or absolute.
+            If the value is a relative URL, it can begin with URL tokens "~site" and "~sitecollection".
+            These tokens indicate that the URL is either relative to the site (2) or to the site collection
+            respectively. If the NodeType (section 3.2.5.244.1.1.7) property is not set to "SimpleLink",
+            the value MUST be an empty string.
+         :param list[SPResourceEntry] translations:
         """
+        self.AudienceIds = audience_ids
         self.CurrentLCID = current_lcid
+        self.IsDeleted = is_deleted
+        self.IsHidden = is_hidden
+        self.Key = key
+        self.Nodes = ClientValueCollection(MenuNode, nodes)
+        self.NodeType = node_type
+        self.OpenInNewWindow = open_in_new_window
+        self.SimpleUrl = simple_url
         self.Title = title
+        self.Translations = ClientValueCollection(SPResourceEntry, translations)

office365/sharepoint/navigation/node_collection.py

@@ -39,7 +39,7 @@ class NavigationNodeCollection(EntityCollection[NavigationNode]):
         :param int previous_node_id: Identifier of the navigation node after which the node identified by nodeId moves to
         """
         params = {"nodeId": node_id, "previousNodeId": previous_node_id}
-        qry = ServiceOperationQuery(self, "GetByIndex", params)
+        qry = ServiceOperationQuery(self, "MoveAfter", params)
         self.context.add_query(qry)
         return self
 

office365/sharepoint/oauth/token.py

@@ -0,0 +1,22 @@
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.entity import Entity
+from office365.sharepoint.oauth.token_response import TokenResponse
+
+
+class Token(Entity):
+    """"""
+
+    def __init__(self, context):
+        super(Token, self).__init__(context, ResourcePath("SP.OAuth.Token"))
+
+    def acquire(self):
+        """ """
+        return_type = TokenResponse(self.context)
+        qry = ServiceOperationQuery(self, "Acquire", return_type=return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    @property
+    def entity_type_name(self):
+        return "SP.OAuth.Token"

office365/sharepoint/oauth/token_response.py

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

office365/sharepoint/publishing/pages/campaign_publication.py

@@ -1,5 +1,6 @@
 from typing import Optional
 
+from office365.runtime.client_result import ClientResult
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.publishing.highlights_info import HighlightsInfo
 from office365.sharepoint.publishing.pages.page import SitePage
@@ -15,6 +16,15 @@ class CampaignPublication(SitePage):
         self.context.add_query(qry)
         return return_type
 
+    def send_test_email(self):
+        """ """
+        return_type = ClientResult(self.context)
+        qry = ServiceOperationQuery(
+            self, "SendTestEmail", None, None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def email_endpoint(self):
         # type: () -> Optional[str]

office365/sharepoint/publishing/pages/collection.py

@@ -62,7 +62,7 @@ class SitePageCollection(SitePageMetadataCollection[SitePage]):
         return return_type
 
     def get_page_column_state(self, url):
-        """ "
+        """
         Determines whether a specific SitePage is a single or multicolumn page.
 
         :param str url: URL of the SitePage for which to return state.

office365/sharepoint/securestore/target_application.py

@@ -1,4 +1,5 @@
 from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.client_context import ClientContext
 from office365.sharepoint.entity import Entity
 
 
@@ -10,6 +11,7 @@ class TargetApplication(Entity):
 
     @staticmethod
     def create(context, application_id, friendly_name):
+        # type: (ClientContext, str, str) -> "TargetApplication"
         """
         Creates a target application
 

office365/sharepoint/sharing/inherited_from.py

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

office365/sharepoint/sharing/internal/sharing_restrictions.py

@@ -0,0 +1,22 @@
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.sharepoint.entity import Entity
+from office365.sharepoint.sharing.internal.types import CAnonymousLinkUseLimit
+
+
+class SharingRestrictions(Entity):
+    """ """
+
+    def __init__(self, context):
+        static_path = ResourcePath(
+            "Microsoft.SharePoint.Sharing.Internal.SharingRestrictions"
+        )
+        super(SharingRestrictions, self).__init__(context, static_path)
+
+    @property
+    def anonymous_link_use_limit(self):
+        return self.properties.get("anonymousLinkUseLimit", CAnonymousLinkUseLimit())
+
+    @property
+    def entity_type_name(self):
+        # type: () -> str
+        return "Microsoft.SharePoint.Sharing.Internal.SharingRestrictions"

office365/sharepoint/sharing/internal/types.py

@@ -0,0 +1,17 @@
+from office365.runtime.client_value import ClientValue
+
+
+class CAnonymousLinkUseLimit(ClientValue):
+
+    @property
+    def entity_type_name(self):
+        # type: () -> str
+        return "Microsoft.SharePoint.Sharing.Internal.CAnonymousLinkUseLimit"
+
+
+class CExternalSharingEnforcement(ClientValue):
+
+    @property
+    def entity_type_name(self):
+        # type: () -> str
+        return "Microsoft.SharePoint.Sharing.Internal.CExternalSharingEnforcement"

office365/sharepoint/sharing/link_info.py

@@ -1,6 +1,30 @@
 from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.sharepoint.sharing.inherited_from import InheritedFrom
+from office365.sharepoint.sharing.links.info import SharingLinkInfo
+from office365.sharepoint.sharing.principal import Principal
 
 
 class LinkInfo(ClientValue):
     """This class provides metadata for the tokenized sharing link including settings details, inheritance status,
     and an optional array of members."""
+
+    def __init__(
+        self,
+        inherited_from=InheritedFrom(),
+        is_inherited=None,
+        link_details=SharingLinkInfo(),
+        link_members=None,
+        link_status=None,
+        total_link_members_count=None,
+    ):
+        """
+        :param bool is_inherited: Boolean that indicates if the tokenized sharing link is present due to
+             inherited permissions from a parent object.
+        """
+        self.inherited_from = inherited_from
+        self.isInherited = is_inherited
+        self.linkDetails = link_details
+        self.linkMembers = ClientValueCollection(Principal, link_members)
+        self.linkStatus = link_status
+        self.totalLinkMembersCount = total_link_members_count

office365/sharepoint/sites/site.py

@@ -132,6 +132,15 @@ class Site(Entity):
         self.ensure_property("Url", _site_loaded)
         return return_type
 
+    def get_block_download_policy_for_files_data(self):
+        """ """
+        return_type = ClientResult(self.context, str())
+        qry = ServiceOperationQuery(
+            self, "GetBlockDownloadPolicyForFilesData", None, None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def get_migration_status(self):
         """"""
         return_type = EntityCollection(self.context, SPMigrationJobStatus)