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

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

office365/sharepoint/lists/list.py

@@ -1,6 +1,8 @@
 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
@@ -19,6 +21,7 @@ from office365.sharepoint.eventreceivers.definition_collection import (
     EventReceiverDefinitionCollection,
 )
 from office365.sharepoint.fields.collection import FieldCollection
+from office365.sharepoint.fields.field import Field
 from office365.sharepoint.fields.related_field_collection import RelatedFieldCollection
 from office365.sharepoint.files.checked_out_file_collection import (
     CheckedOutFileCollection,
@@ -40,7 +43,9 @@ from office365.sharepoint.listitems.listitem import ListItem
 from office365.sharepoint.lists.bloom_filter import ListBloomFilter
 from office365.sharepoint.lists.creatables_info import CreatablesInfo
 from office365.sharepoint.lists.data_source import ListDataSource
+from office365.sharepoint.lists.render_data_parameters import RenderListDataParameters
 from office365.sharepoint.lists.rule import SPListRule
+from office365.sharepoint.lists.version_policy_manager import VersionPolicyManager
 from office365.sharepoint.navigation.configured_metadata_items import (
     ConfiguredMetadataNavigationItemCollection,
 )
@@ -77,6 +82,13 @@ 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"""
+        from office365.sharepoint.lists.exporter import ListExporter
+
+        return ListExporter.export(self, local_file, include_content, item_exported)
+
     def clear(self):
         """Clears the list."""
 
@@ -125,6 +137,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
@@ -200,6 +213,16 @@ class List(SecurableObject):
         self.ensure_property("RootFolder", _list_loaded)
         return return_type
 
+    def ensure_signoff_status_field(self):
+        """"""
+        return_type = Field(self.context)
+        self.fields.add_child(return_type)
+        qry = ServiceOperationQuery(
+            self, "EnsureSignoffStatusField", None, None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def get_all_rules(self):
         """Retrieves rules of a List"""
         return_type = ClientResult(self.context, ClientValueCollection(SPListRule))
@@ -329,25 +352,72 @@ class List(SecurableObject):
         return return_type
 
     @staticmethod
-    def get_list_data_as_stream(context, list_full_url, parameters=None):
+    def get_list_data_as_stream(
+        context,
+        list_full_url,
+        parameters=None,
+        casc_del_warn_message=None,
+        custom_action=None,
+        drill_down=None,
+        field=None,
+        field_internal_name=None,
+        return_type=None,
+    ):
         """
         Returns list data from the specified list url and for the specified query parameters.
 
         :param office365.sharepoint.client_context.ClientContext context: Client context
         :param str list_full_url: The absolute URL of the list.
         :param RenderListDataParameters parameters: The parameters to be used.
-        """
-        result = ClientResult(context)
+        :param str casc_del_warn_message:
+        :param str custom_action:
+        :param str drill_down:
+        :param str field:
+        :param str field_internal_name:
+        :param ClientResult[dict] return_type: The return type.
+        """
+        if return_type is None:
+            return_type = ClientResult(context, dict())
         payload = {
             "listFullUrl": list_full_url,
             "parameters": parameters,
+            "CascDelWarnMessage": casc_del_warn_message,
+            "CustomAction": custom_action,
+            "DrillDown": drill_down,
+            "Field": field,
+            "FieldInternalName": field_internal_name,
+        }
+        qry = ServiceOperationQuery(
+            List(context), "GetListDataAsStream", None, payload, None, return_type, True
+        )
+        context.add_query(qry)
+        return return_type
+
+    @staticmethod
+    def get_onedrive_list_data_as_stream(context, parameters=None, return_type=None):
+        """
+        Returns list data from the specified list url and for the specified query parameters.
+
+        :param office365.sharepoint.client_context.ClientContext context: Client context
+        :param RenderListDataParameters parameters: The parameters to be used.
+        :param ClientResult[dict] return_type: The return type.
+        """
+        if return_type is None:
+            return_type = ClientResult(context, dict())
+        payload = {
+            "parameters": parameters,
         }
-        target_list = context.web.get_list(list_full_url)
         qry = ServiceOperationQuery(
-            target_list, "GetListDataAsStream", None, payload, None, result
+            List(context),
+            "GetOneDriveListDataAsStream",
+            None,
+            payload,
+            None,
+            return_type,
+            True,
         )
         context.add_query(qry)
-        return result
+        return return_type
 
     def bulk_validate_update_list_items(
         self,
@@ -387,6 +457,7 @@ class List(SecurableObject):
 
     def get_lookup_field_choices(self, target_field_name, paging_info=None):
         """
+        Retrieves the possible choices or values for a lookup field in a SharePoint list
         :param str target_field_name:
         :param str paging_info:
         """
@@ -648,6 +719,31 @@ class List(SecurableObject):
         self.context.add_query(qry)
         return return_type
 
+    def render_list_data_as_stream(
+        self, view_xml=None, render_options=None, expand_groups=None
+    ):
+        """Returns the data for the specified query view.
+
+        :param str view_xml: Specifies the CAML view XML.
+        :param int render_options: Specifies the type of output to return.
+        :param bool expand_groups: Specifies whether to expand the grouping or not.
+        """
+        return_type = ClientResult(self.context, dict())
+        if view_xml is None:
+            view_xml = "<View/>"
+        payload = {
+            "parameters": RenderListDataParameters(
+                view_xml=view_xml,
+                render_options=render_options,
+                expand_groups=expand_groups,
+            ),
+        }
+        qry = ServiceOperationQuery(
+            self, "RenderListDataAsStream", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def reserve_list_item_id(self):
         # type: () -> ClientResult[int]
         """Reserves the returned list item identifier for the idempotent creation of a list item."""
@@ -688,6 +784,17 @@ class List(SecurableObject):
         self.context.add_query(qry)
         return return_type
 
+    def reset_doc_id(self):
+        """"""
+        from office365.sharepoint.documentmanagement.document_id import DocumentId
+
+        def _loaded():
+            doc_mng = DocumentId(self.context)
+            doc_mng.reset_doc_ids_in_library(self.root_folder.serverRelativeUrl)
+
+        self.ensure_property("RootFolder", _loaded)
+        return self
+
     @property
     def id(self):
         # type: () -> Optional[str]
@@ -953,6 +1060,34 @@ class List(SecurableObject):
         """ """
         return self.properties.get("HasContentAssemblyTemplates", None)
 
+    @property
+    def has_external_data_source(self):
+        # type: () -> Optional[bool]
+        """
+        Specifies whether the list is an external list.
+        """
+        return self.properties.get("HasExternalDataSource", None)
+
+    @property
+    def has_folder_coloring_fields(self):
+        # type: () -> Optional[bool]
+        """ """
+        return self.properties.get("HasFolderColoringFields", None)
+
+    @property
+    def irm_enabled(self):
+        # type: () -> Optional[bool]
+        """Gets a Boolean value that specifies whether Information Rights Management (IRM) is enabled for the list."""
+        return self.properties.get("IrmEnabled", None)
+
+    @property
+    def irm_expire(self):
+        # type: () -> Optional[bool]
+        """Gets a Boolean value that specifies whether Information Rights Management (IRM) expiration is enabled
+        for the list
+        """
+        return self.properties.get("IrmExpire", None)
+
     @property
     def items(self):
         # type: () -> ListItemCollection
@@ -1065,6 +1200,16 @@ class List(SecurableObject):
             ),
         )
 
+    @property
+    def version_policies(self):
+        """ """
+        return self.properties.get(
+            "VersionPolicies",
+            VersionPolicyManager(
+                self.context, ResourcePath("VersionPolicies", self.resource_path)
+            ),
+        )
+
     @property
     def custom_action_elements(self):
         return self.properties.get(
@@ -1345,6 +1490,7 @@ class List(SecurableObject):
                 "RootFolder": self.root_folder,
                 "TitleResource": self.title_resource,
                 "UserCustomActions": self.user_custom_actions,
+                "VersionPolicies": self.version_policies,
             }
             default_value = property_mapping.get(name, None)
         return super(List, self).get_property(name, default_value)
@@ -1357,4 +1503,8 @@ class List(SecurableObject):
                 self._resource_path = self.parent_collection.get_by_id(
                     value
                 ).resource_path
+            elif name == "Url":
+                self._resource_path = ServiceOperationPath(
+                    "getList", [value], self.context.web.resource_path
+                )
         return self

office365/sharepoint/lists/render_data_parameters.py

@@ -1,6 +1,25 @@
 from office365.runtime.client_value import ClientValue
 
 
+class RenderListDataOptions:
+    """The type of data to return when rendering a list view as JSON."""
+
+    """Default render type."""
+    None_ = 0
+
+    """ Returns the list data context information. """
+    ContextInfo = 1
+
+    """ Returns the list data. """
+    ListData = 2
+
+    """ Returns the list schema. """
+    ListSchema = 4
+
+    """ Returns the menu view of the list. """
+    MenuView = 8
+
+
 class RenderListDataParameters(ClientValue):
     """Specifies the parameters to be used to render list data as a JSON string"""
 
@@ -16,6 +35,10 @@ class RenderListDataParameters(ClientValue):
         expand_groups=None,
         expand_user_field=None,
         filter_out_channel_folders_in_default_doc_lib=None,
+        render_options=None,
+        require_folder_coloring_fields=None,
+        show_stub_file=None,
+        view_xml=None,
     ):
         """
         :param bool add_all_fields:
@@ -29,6 +52,10 @@ class RenderListDataParameters(ClientValue):
         :param bool expand_groups: Specifies whether to expand the grouping or not.
         :param bool expand_user_field:
         :param bool filter_out_channel_folders_in_default_doc_lib:
+        :param int render_options: Specifies the type of output to return.
+        :param bool require_folder_coloring_fields:
+        :param bool show_stub_file:
+        :param str view_xml: Specifies the CAML view XML.
         """
         self.AddAllFields = add_all_fields
         self.AddAllViewFields = add_all_view_fields
@@ -44,6 +71,10 @@ class RenderListDataParameters(ClientValue):
         self.FilterOutChannelFoldersInDefaultDocLib = (
             filter_out_channel_folders_in_default_doc_lib
         )
+        self.RenderOptions = render_options
+        self.RequireFolderColoringFields = require_folder_coloring_fields
+        self.ShowStubFile = show_stub_file
+        self.ViewXml = view_xml
 
     @property
     def entity_type_name(self):

office365/sharepoint/lists/version_policy_manager.py

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

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/migration/copy_migration_options.py

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

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/portal/groups/site_manager.py

@@ -4,6 +4,7 @@ from office365.runtime.http.http_method import HttpMethod
 from office365.runtime.http.request_options import RequestOptions
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.portal.channels.info_collection import ChannelInfoCollection
 from office365.sharepoint.portal.groups.creation_context import GroupCreationContext
 from office365.sharepoint.portal.groups.creation_information import (
     GroupCreationInformation,
@@ -15,12 +16,17 @@ from office365.sharepoint.portal.teams.recent_and_joined_response import (
 
 
 class GroupSiteManager(ClientObject):
+    """Management of Group Sites in SharePoint. Group Sites, also known as Microsoft 365 Groups,
+    provide collaboration spaces that integrate with various Microsoft 365 services like Teams, Outlook, and Planner.
+    """
+
     def __init__(self, context, resource_path=None):
         if resource_path is None:
             resource_path = ResourcePath("GroupSiteManager")
         super(GroupSiteManager, self).__init__(context, resource_path)
 
     def can_user_create_group(self):
+        """Determines if the current user can create group site"""
         return_type = ClientResult(self.context, bool())
         qry = ServiceOperationQuery(
             self, "CanUserCreateGroup", None, None, None, return_type
@@ -83,6 +89,7 @@ class GroupSiteManager(ClientObject):
         return self
 
     def ensure_team_for_group(self):
+        """ """
         return_type = ClientResult(self.context)
         qry = ServiceOperationQuery(
             self, "EnsureTeamForGroup", None, None, None, return_type
@@ -91,6 +98,7 @@ class GroupSiteManager(ClientObject):
         return return_type
 
     def get_group_creation_context(self):
+        """ """
         return_type = ClientResult(self.context, GroupCreationContext())
         qry = ServiceOperationQuery(
             self, "GetGroupCreationContext", None, None, None, return_type
@@ -131,6 +139,7 @@ class GroupSiteManager(ClientObject):
         return result
 
     def get_current_user_shared_channel_member_groups(self):
+        """ """
         return_type = ClientResult(self.context)
         qry = ServiceOperationQuery(
             self,
@@ -145,6 +154,8 @@ class GroupSiteManager(ClientObject):
 
     def get_team_channels(self, team_id, use_staging_endpoint=False):
         """
+        Retrieves the channels associated with a specific Microsoft 365 Group (or Team)
+
         :param str team_id:
         :param bool use_staging_endpoint:
         """
@@ -170,6 +181,21 @@ class GroupSiteManager(ClientObject):
         self.context.add_query(qry)
         return return_type
 
+    def get_team_channels_with_site_url(self, site_url):
+        """
+        Returns a list of team channels associated with a Microsoft 365 Group.
+        :param str site_url:
+        """
+        return_type = ClientResult(self.context, ChannelInfoCollection())
+        payload = {
+            "siteUrl": site_url,
+        }
+        qry = ServiceOperationQuery(
+            self, "GetTeamChannelsWithSiteUrl", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def notebook(self, group_id):
         """
         :param str group_id:
@@ -188,6 +214,8 @@ class GroupSiteManager(ClientObject):
         existing_joined_teams_data=None,
     ):
         """
+        Retrieves a list of teams that a user has recently accessed or joined
+
         :param bool include_recent:
         :param bool include_teams:
         :param bool include_pinned:
@@ -205,3 +233,7 @@ class GroupSiteManager(ClientObject):
         )
         self.context.add_query(qry)
         return return_type
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Portal.GroupSiteManager"