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

office365/sharepoint/lists/list.py

@@ -1,4 +1,3 @@
-import json
 import os
 from datetime import datetime
 from typing import IO, TYPE_CHECKING, AnyStr, Callable, Dict, Optional
@@ -22,12 +21,12 @@ 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,
 )
 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
@@ -44,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,
 )
@@ -84,60 +85,9 @@ class List(SecurableObject):
     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)
-            )
+        from office365.sharepoint.lists.exporter import ListExporter
 
-        self.ensure_properties(["SchemaXml", "RootFolder"], _save_schema)
-
-        return self
+        return ListExporter.export(self, local_file, include_content, item_exported)
 
     def clear(self):
         """Clears the list."""
@@ -263,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))
@@ -392,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,
         }
-        target_list = context.web.get_list(list_full_url)
         qry = ServiceOperationQuery(
-            target_list, "GetListDataAsStream", None, payload, None, result
+            List(context), "GetListDataAsStream", None, payload, None, return_type, True
         )
         context.add_query(qry)
-        return result
+        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,
+        }
+        qry = ServiceOperationQuery(
+            List(context),
+            "GetOneDriveListDataAsStream",
+            None,
+            payload,
+            None,
+            return_type,
+            True,
+        )
+        context.add_query(qry)
+        return return_type
 
     def bulk_validate_update_list_items(
         self,
@@ -450,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:
         """
@@ -711,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."""
@@ -751,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]
@@ -1016,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
@@ -1128,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(
@@ -1408,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)
@@ -1420,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/migration/copy_migration_options.py

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

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"

office365/sharepoint/portal/project/__init__.py

@@ -0,0 +1,9 @@
+from office365.runtime.client_value import ClientValue
+
+
+class MyRecsCacheBlob(ClientValue):
+    """"""
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Portal.Project.MyRecsCacheBlob"

office365/sharepoint/portal/userprofiles/documentsshared/with_group.py

@@ -0,0 +1,38 @@
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.entity import Entity
+from office365.sharepoint.entity_collection import EntityCollection
+from office365.sharepoint.portal.userprofiles.sharedwithme.document import (
+    SharedWithMeDocument,
+)
+
+
+class DocumentsSharedWithGroup(Entity):
+    """
+    Provides methods for working with a list that shares documents with a SharePoint Group on the user's personal site.
+    """
+
+    @staticmethod
+    def get_shared_with_group_docs(context, group_id=None):
+        """
+        Gets a shared documents for a group.
+
+        :param office365.sharepoint.client_context.ClientContext context: SharePoint context
+        :param str group_id:
+        """
+        return_type = EntityCollection(context, SharedWithMeDocument)
+        payload = {"groupId": group_id}
+        qry = ServiceOperationQuery(
+            DocumentsSharedWithGroup(context),
+            "GetSharedWithGroupDocs",
+            None,
+            payload,
+            None,
+            return_type,
+            True,
+        )
+        context.add_query(qry)
+        return return_type
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Portal.UserProfiles.DocumentsSharedWithGroup"

office365/sharepoint/portal/userprofiles/documentsshared/with_person.py

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

office365/sharepoint/{userprofiles → portal/userprofiles}/sharedwithme/document.py

@@ -3,7 +3,7 @@ from typing import Optional
 
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.sharepoint.entity import Entity
-from office365.sharepoint.userprofiles.sharedwithme.document_user import (
+from office365.sharepoint.portal.userprofiles.sharedwithme.document_user import (
     SharedWithMeDocumentUser,
 )
 

office365/sharepoint/{userprofiles → portal/userprofiles}/sharedwithme/items.py

@@ -1,7 +1,9 @@
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.entity_collection import EntityCollection
-from office365.sharepoint.userprofiles.sharedwithme.document import SharedWithMeDocument
+from office365.sharepoint.portal.userprofiles.sharedwithme.document import (
+    SharedWithMeDocument,
+)
 
 
 class SharedWithMeItems(Entity):

office365/sharepoint/publishing/pages/coauth_state.py

@@ -0,0 +1,8 @@
+from office365.runtime.client_value import ClientValue
+
+
+class SitePageCoAuthState(ClientValue):
+
+    @property
+    def entity_type_name(self):
+        return "SP.Publishing.SitePageCoAuthState"

office365/sharepoint/publishing/pages/page.py

@@ -5,6 +5,7 @@ from office365.runtime.client_value import ClientValue
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.runtime.types.collections import StringCollection
+from office365.sharepoint.publishing.pages.coauth_state import SitePageCoAuthState
 from office365.sharepoint.publishing.pages.fields_data import SitePageFieldsData
 from office365.sharepoint.publishing.pages.metadata import SitePageMetadata
 from office365.sharepoint.translation.status_collection import (
@@ -135,6 +136,16 @@ class SitePage(SitePageMetadata):
         self.context.add_query(qry)
         return return_type
 
+    def save_page_co_auth(self, page_stream):
+        """ """
+        return_type = ClientResult(self.context, SitePageCoAuthState())
+        payload = {"pageStream": page_stream}
+        qry = ServiceOperationQuery(
+            self, "SavePageCoAuth", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def demote_from_news(self):
         """
         Updates the promoted state of the site page to 0. On success MUST return true.

office365/sharepoint/publishing/pages/stream_content.py

@@ -0,0 +1,9 @@
+from office365.runtime.client_value import ClientValue
+
+
+class SitePageStreamContent(ClientValue):
+    """ """
+
+    @property
+    def entity_type_name(self):
+        return "SP.Publishing.SitePageStreamContent"

office365/sharepoint/publishing/pages/stream_data.py

@@ -0,0 +1,8 @@
+from office365.runtime.client_value import ClientValue
+
+
+class SitePageStreamData(ClientValue):
+
+    @property
+    def entity_type_name(self):
+        return "SP.Publishing.SitePageStreamData"

office365/sharepoint/quotamanagement/consumer/non_quota_backfill_api.py

@@ -0,0 +1,8 @@
+from office365.sharepoint.entity import Entity
+
+
+class NonQuotaBackfillApi(Entity):
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.QuotaManagement.Consumer.NonQuotaBackfillApi"

office365/sharepoint/request.py

@@ -13,6 +13,9 @@ from office365.runtime.odata.v3.json_light_format import JsonLightFormat
 
 class SharePointRequest(ODataRequest):
     def __init__(self, base_url):
+        """
+        :param str base_url: Absolute Web or Site Url
+        """
         super().__init__(JsonLightFormat())
         self._auth_context = AuthenticationContext(url=base_url)
         self.beforeExecute += self._authenticate_request

office365/sharepoint/search/administration/site_content_processing_info_provider.py

@@ -1,7 +1,18 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
 
 class SiteContentProcessingInfoProvider(Entity):
+
+    def get_azure_container_token(self):
+        return_type = ClientResult(self.context, str())
+        qry = ServiceOperationQuery(
+            self, "GetAzureContainerToken", None, None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Client.Search.Administration.SiteContentProcessingInfoProvider"

office365/sharepoint/search/ranking_labeling.py

@@ -28,6 +28,7 @@ class RankingLabeling(Entity):
         return self
 
     def normalize_result_url(self, url):
+        # type: (str) -> ClientResult[str]
         """
         A URL string after normalization. The input and output URL strings MUST resolve to the same document.