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

office365/search/entity.py

@@ -7,9 +7,11 @@ from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.paths.v4.entity import EntityPath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
-from office365.search.acronym import Acronym
+from office365.search.acronyms.acronym import Acronym
+from office365.search.bookmarks.bookmark import Bookmark
 from office365.search.entity_type import EntityType
 from office365.search.hit import SearchHit
+from office365.search.qnas.qna import Qna
 from office365.search.query import SearchQuery
 from office365.search.request import SearchRequest
 from office365.search.response import SearchResponse
@@ -28,8 +30,9 @@ class SearchEntity(Entity):
         page_from=None,
         size=None,
         enable_top_results=None,
+        region=None,
     ):
-        # type: (str, Optional[List[str]], Optional[int], Optional[int], Optional[bool]) -> ClientResult[ClientValueCollection[SearchResponse]]
+        # type: (str, Optional[List[str]], Optional[int], Optional[int], Optional[bool], Optional[str]) -> ClientResult[ClientValueCollection[SearchResponse]]
         """
         Runs the query specified in the request body. Search results are provided in the response.
 
@@ -39,6 +42,8 @@ class SearchEntity(Entity):
         :param int page_from: Specifies the offset for the search results. Offset 0 returns the very first result.
         :param int size: The size of the page to be retrieved. The maximum value is 500. Optional.
         :param bool enable_top_results: This triggers hybrid sort for messages
+        :param str region: The geographic location for the search. Required for searches that use application
+             permissions. For details, see Get the region value.
         """
         search_request = SearchRequest(
             query=SearchQuery(query_string),
@@ -46,6 +51,7 @@ class SearchEntity(Entity):
             page_from=page_from,
             size=size,
             enable_top_results=enable_top_results,
+            region=region,
         )
 
         def _patch_hit(search_hit):
@@ -106,6 +112,54 @@ class SearchEntity(Entity):
             size=size,
         )
 
+    def query_list_items(self, query_string, page_from=None, size=None, region=None):
+        """Searches list items. Alias to query method
+
+        :param str query_string: Contains the query terms.
+        :param int page_from: Specifies the offset for the search results. Offset 0 returns the very first result.
+        :param int size: The size of the page to be retrieved. The maximum value is 500.
+        :param str region: The geographic location for the search. Required for searches that use application
+        """
+        return self.query(
+            query_string,
+            entity_types=[EntityType.listItem],
+            page_from=page_from,
+            size=size,
+            region=region,
+        )
+
+    def query_peoples(self, query_string, page_from=None, size=None, region=None):
+        """Searches peoples. Alias to query method
+
+        :param str query_string: Contains the query terms.
+        :param int page_from: Specifies the offset for the search results. Offset 0 returns the very first result.
+        :param int size: The size of the page to be retrieved. The maximum value is 500.
+        :param str region: The geographic location for the search. Required for searches that use application
+        """
+        return self.query(
+            query_string,
+            entity_types=[EntityType.person],
+            page_from=page_from,
+            size=size,
+            region=region,
+        )
+
+    def query_sites(self, query_string, page_from=None, size=None, region=None):
+        """Searches sites. Alias to query method
+
+        :param str query_string: Contains the query terms.
+        :param int page_from: Specifies the offset for the search results. Offset 0 returns the very first result.
+        :param int size: The size of the page to be retrieved. The maximum value is 500.
+        :param str region: The geographic location for the search. Required for searches that use application
+        """
+        return self.query(
+            query_string,
+            entity_types=[EntityType.site],
+            page_from=page_from,
+            size=size,
+            region=region,
+        )
+
     @property
     def acronyms(self):
         """Administrative answer in Microsoft Search results to define common acronyms in an organization."""
@@ -117,3 +171,28 @@ class SearchEntity(Entity):
                 ResourcePath("acronyms", self.resource_path),
             ),
         )
+
+    @property
+    def bookmarks(self):
+        """Administrative answer in Microsoft Search results for common search queries in an organization."""
+        return self.properties.get(
+            "bookmarks",
+            EntityCollection(
+                self.context,
+                Bookmark,
+                ResourcePath("bookmarks", self.resource_path),
+            ),
+        )
+
+    @property
+    def qnas(self):
+        """Administrative answer in Microsoft Search results that provide answers for specific search keywords in
+        an organization."""
+        return self.properties.get(
+            "qnas",
+            EntityCollection(
+                self.context,
+                Qna,
+                ResourcePath("qnas", self.resource_path),
+            ),
+        )

office365/search/entity_type.py

@@ -7,6 +7,8 @@ from office365.onedrive.lists.list import List
 from office365.onedrive.sites.site import Site
 from office365.outlook.calendar.events.event import Event
 from office365.outlook.mail.messages.message import Message
+from office365.outlook.person import Person
+from office365.search.external.item import ExternalItem
 
 
 class EntityType:
@@ -20,7 +22,8 @@ class EntityType:
         "message": Message,
         "drive": Drive,
         "driveItem": DriveItem,
-        # "externalItem": ExternalItem
+        "externalItem": ExternalItem,
+        "person": Person,
     }
 
     def __init__(self):
@@ -47,3 +50,5 @@ class EntityType:
     driveItem = "driveItem"
 
     externalItem = "externalItem"
+
+    person = "person"

office365/search/external/item.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class ExternalItem(Entity):
+    """An item added to a Microsoft Graph connection."""

office365/search/identity_set.py

@@ -0,0 +1,11 @@
+from office365.runtime.client_value import ClientValue
+
+
+class IdentitySet(ClientValue):
+    """Represents a keyed collection of identity resources. It is used to represent a set of
+    identities associated with various events for an item, such as created by or last modified by.
+    """
+
+    @property
+    def entity_type_name(self):
+        return "microsoft.graph.search.identitySet"

office365/search/qnas/qna.py

@@ -0,0 +1,9 @@
+from office365.search.answer import SearchAnswer
+
+
+class Qna(SearchAnswer):
+    """Represents a question and answer (Q&A) in Microsoft Search. Q&As are administrative answer results in the
+    search results page that provide answers for specific search keywords. Q&As allow administrators
+    to answer the user's questions directly in search instead of providing a link to a webpage.
+    A Q&A has many properties that allow administrators to make common resources more accessible in their organization.
+    """

office365/sharepoint/activities/client_response.py

@@ -4,12 +4,12 @@ from office365.runtime.client_value import ClientValue
 class ActivityClientResponse(ClientValue):
     """"""
 
-    def __init__(self, id_, message=None, serverId=None, status=None):
+    def __init__(self, id_, message=None, server_id=None, status=None):
         # type: (str, str, str, int) -> None
         """ """
         self.id = id_
         self.message = message
-        self.serverId = serverId
+        self.serverId = server_id
         self.status = status
 
     @property

office365/sharepoint/apps/launcher.py

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

office365/sharepoint/brandcenter/brand_center.py

@@ -1,4 +1,9 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.brandcenter.configuration import BrandCenterConfiguration
 from office365.sharepoint.entity import Entity
+from office365.sharepoint.sites.themes import SiteThemes
 
 
 class BrandCenter(Entity):
@@ -7,3 +12,24 @@ class BrandCenter(Entity):
     that empowers your brand managers or designated brand owners to help your organization to customize
     the look and feel of their experiences.
     """
+
+    def __init__(self, context):
+        super(BrandCenter, self).__init__(context, ResourcePath("SP.BrandCenter"))
+
+    def configuration(self):
+        """ """
+        return_type = ClientResult(self.context, BrandCenterConfiguration())
+        qry = ServiceOperationQuery(
+            self, "Configuration", None, None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def get_site_themes(self):
+        """ """
+        return_type = ClientResult(self.context, SiteThemes())
+        qry = ServiceOperationQuery(
+            self, "GetSiteThemes", None, None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type

office365/sharepoint/client_context.py

@@ -405,7 +405,7 @@ class ClientContext(ClientRuntimeContext):
 
         from office365.sharepoint.brandcenter.brand_center import BrandCenter
 
-        return BrandCenter(self, ResourcePath("BrandCenter"))
+        return BrandCenter(self)
 
     @property
     def client_people_picker(self):
@@ -417,6 +417,16 @@ class ClientContext(ClientRuntimeContext):
 
         return ClientPeoplePickerWebServiceInterface(self)
 
+    @property
+    def component_context_info(self):
+        """ComponentContextInfo alias"""
+
+        from office365.sharepoint.clientsidecomponent.component_context_info import (
+            ComponentContextInfo,
+        )
+
+        return ComponentContextInfo(self, ResourcePath("ComponentContextInfo"))
+
     @property
     def consumer_permissions(self):
         """Consumer permissions alias"""
@@ -631,6 +641,14 @@ class ClientContext(ClientRuntimeContext):
 
         return SPSiteManager(self, ResourcePath("spSiteManager"))
 
+    @property
+    def site_manager_svc(self):
+        """Alias to SiteManagerService."""
+
+        from office365.sharepoint.sites.manager.service import SiteManagerService
+
+        return SiteManagerService(self)
+
     @property
     def social_feed_manager(self):
         """Alias to SocialFeedManager."""

office365/sharepoint/compliance/preserve_document_submitter.py

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

office365/sharepoint/compliance/store_proxy.py

@@ -12,6 +12,8 @@ if TYPE_CHECKING:
 
 
 class SPPolicyStoreProxy(Entity):
+    """ """
+
     @staticmethod
     def check_site_is_deletable_by_id(context, site_id, return_type=None):
         # type: (ClientContext, str, Optional[ClientResult[bool]]) -> ClientResult[bool]
@@ -84,6 +86,79 @@ class SPPolicyStoreProxy(Entity):
         self.context.add_query(qry)
         return return_type
 
+    @staticmethod
+    def get_list_compliance_tag(context, list_url, return_type=None):
+        """ """
+        if return_type is None:
+            return_type = ClientResult(context, ComplianceTag())
+        payload = {"listUrl": list_url}
+        qry = ServiceOperationQuery(
+            SPPolicyStoreProxy(context),
+            "GetListComplianceTag",
+            None,
+            payload,
+            None,
+            return_type,
+            True,
+        )
+        context.add_query(qry)
+        return return_type
+
+    @staticmethod
+    def set_list_compliance_tag(
+        context,
+        list_url,
+        compliance_tag_value,
+        block_delete=None,
+        block_edit=None,
+        sync_to_items=None,
+    ):
+        """ """
+        payload = {
+            "listUrl": list_url,
+            "complianceTagValue": compliance_tag_value,
+            "blockDelete": block_delete,
+            "blockEdit": block_edit,
+            "syncToItems": sync_to_items,
+        }
+        binding_type = SPPolicyStoreProxy(context)
+        qry = ServiceOperationQuery(
+            binding_type,
+            "SetListComplianceTag",
+            None,
+            payload,
+            None,
+            None,
+            True,
+        )
+        context.add_query(qry)
+        return binding_type
+
+    @staticmethod
+    def lock_record_item(
+        context, list_url, item_id, refresh_labeled_time, return_type=None
+    ):
+        """ """
+        if return_type is None:
+            return_type = ClientResult(context, int())
+        payload = {
+            "listUrl": list_url,
+            "itemId": item_id,
+            "refreshLabeledTime": refresh_labeled_time,
+        }
+
+        qry = ServiceOperationQuery(
+            SPPolicyStoreProxy(context),
+            "LockRecordItem",
+            None,
+            payload,
+            None,
+            return_type,
+            True,
+        )
+        context.add_query(qry)
+        return return_type
+
     @property
     def entity_type_name(self):
         return "SP.CompliancePolicy.SPPolicyStoreProxy"

office365/sharepoint/convergence/migration_complete_state_api.py

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

office365/sharepoint/copilot/file_metadata.py

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

office365/sharepoint/fields/builtin_field_id.py

@@ -10,6 +10,14 @@ class SPBuiltInFieldId:
     FSObjType = "FSObjType"
     """Identifies a field that contains information about the file system type"""
 
+    FileDirRef = "FileDirRef"
+    """Identifies a field that contains information about the file directory for the specified
+    SharePoint Foundation object."""
+
+    FileLeafRef = "FileLeafRef"
+    """Identifies a field that contains information about the server-relative URL for the file node that is
+    associated with the specified SharePoint Foundation object."""
+
     FileType = "FileType"
     """Identifies a field that contains information about the file type for version history of the specified
     SharePoint Foundation library picture object."""

office365/sharepoint/files/collection.py

@@ -11,6 +11,7 @@ from office365.sharepoint.client_context import ClientContext
 from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.files.creation_information import FileCreationInformation
 from office365.sharepoint.files.file import File
+from office365.sharepoint.files.publish.status import FileStatus
 from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
 
 if TYPE_CHECKING:
@@ -24,6 +25,15 @@ class FileCollection(EntityCollection[File]):
         # type: (ClientContext, ResourcePath, Folder) -> None
         super(FileCollection, self).__init__(context, File, resource_path, parent)
 
+    def get_published_file(self, base_file_path):
+        """ """
+        return_type = FileStatus(self.context)
+        qry = ServiceOperationQuery(
+            self, "GetPublishedFile", [base_file_path], None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def upload(self, path_or_file, file_name=None):
         # type: (str|IO, str) -> File
         """Uploads a file into folder.

office365/sharepoint/files/file.py

@@ -1,6 +1,6 @@
 import datetime
 from typing import TYPE_CHECKING, AnyStr
-from urllib.parse import quote
+from urllib.parse import quote, unquote
 
 import requests
 
@@ -608,9 +608,13 @@ class File(AbstractFile):
         :type server_relative_url: str
         :type content: str
         """
+        try:
+            decoded_server_relative_url = unquote(server_relative_url)
+        except (ValueError, AttributeError, TypeError):
+            decoded_server_relative_url = server_relative_url
         url = quote(
             r"{0}/web/getFileByServerRelativePath(DecodedUrl='{1}')/\$value".format(
-                context.service_root_url(), server_relative_url
+                context.service_root_url(), decoded_server_relative_url
             ),
             safe=":/",
         )
@@ -630,9 +634,13 @@ class File(AbstractFile):
         :type server_relative_url: str
         :return Response
         """
+        try:
+            decoded_server_relative_url = unquote(server_relative_url)
+        except (ValueError, AttributeError, TypeError):
+            decoded_server_relative_url = server_relative_url
         url = quote(
             r"{0}/web/getFileByServerRelativePath(DecodedUrl='{1}')/\$value".format(
-                context.service_root_url(), server_relative_url
+                context.service_root_url(), decoded_server_relative_url
             ),
             safe=":/",
         )
@@ -717,6 +725,19 @@ class File(AbstractFile):
         """"""
         return self.properties.get("ActivityCapabilities", ActivityCapabilities())
 
+    @property
+    def checkin_comment(self):
+        # type: () -> Optional[str]
+        """Specifies the comment used when a document is checked into a document library.
+        Its length MUST be equal to or less than 1023."""
+        return self.properties.get("CheckInComment", None)
+
+    @property
+    def content_tag(self):
+        # type: () -> Optional[str]
+        """Returns internal version of content, used to validate document equality for read purposes."""
+        return self.properties.get("ContentTag", None)
+
     @property
     def author(self):
         """Specifies the user who added the file."""

office365/sharepoint/listitems/listitem.py

@@ -3,7 +3,10 @@ from typing import TYPE_CHECKING
 
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
+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.paths.service_operation import ServiceOperationPath
 from office365.runtime.paths.v3.entity import EntityPath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.attachments.collection import AttachmentCollection
@@ -56,6 +59,13 @@ class ListItem(SecurableObject):
         if parent_list is not None:
             self.set_property("ParentList", parent_list, False)
 
+    def archive(self):
+        """Archives the list item."""
+        return_type = ClientResult(self.context, str())
+        qry = ServiceOperationQuery(self, "Archive", None, None, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
     def share_link(self, link_kind, expiration=None, role=None, password=None):
         # type: (int, Optional[datetime.datetime], Optional[int], Optional[str]) -> ClientResult[ShareLinkResponse]
         """Creates a tokenized sharing link for a list item based on the specified parameters and optionally
@@ -334,7 +344,7 @@ class ListItem(SecurableObject):
 
         def _after_system_update(result):
             # type: (ClientResult[ClientValueCollection[ListItemFormUpdateValue]]) -> None
-            has_any_error = any([item.HasException for item in result.value])
+            has_any_error = any(item.HasException for item in result.value)
             if has_any_error:
                 raise ValueError("Update ListItem failed")
 
@@ -396,9 +406,16 @@ class ListItem(SecurableObject):
 
     def get_comments(self):
         """Retrieve ListItem comments"""
-        return_type = CommentCollection(self.context)
+        return_type = CommentCollection(
+            self.context, ServiceOperationPath("GetComments", [], self.resource_path)
+        )
         qry = ServiceOperationQuery(self, "GetComments", [], None, None, return_type)
-        self.context.add_query(qry)
+
+        def _create_request(request):
+            # type: (RequestOptions) -> None
+            request.method = HttpMethod.Get
+
+        self.context.add_query(qry).before_query_execute(_create_request)
         return return_type
 
     def override_policy_tip(self, user_action, justification):
@@ -495,6 +512,17 @@ class ListItem(SecurableObject):
 
         return self.properties.get("EffectiveBasePermissions", BasePermissions())
 
+    @property
+    def effective_base_permissions_for_ui(self):
+        """Specifies the effective base permissions for the current user, as they SHOULD be displayed in the user
+        interface (UI). If the list is not in read-only UI mode, the value of EffectiveBasePermissionsForUI
+        MUST be the same as the value of EffectiveBasePermissions (section 3.2.5.87.1.1.2).
+        If the list is in read-only UI mode, the value of EffectiveBasePermissionsForUI MUST be a subset of the
+        value of EffectiveBasePermissions."""
+        from office365.sharepoint.permissions.base_permissions import BasePermissions
+
+        return self.properties.get("EffectiveBasePermissionsForUI", BasePermissions())
+
     @property
     def field_values(self):
         # type: () -> Optional[dict]
@@ -513,12 +541,41 @@ class ListItem(SecurableObject):
         """Gets a value that specifies whether the list item is a file or a list folder"""
         return self.properties.get("FileSystemObjectType", None)
 
+    @property
+    def icon_overlay(self):
+        # type: () -> Optional[str]
+        """This is an overlay icon for the item. If the parent list of the item does not already have the IconOverlay
+        field and The user setting the property does not have rights to add the field to the list then the property
+        will not be set for the item."""
+        return self.properties.get("IconOverlay", None)
+
     @property
     def id(self):
         # type: () -> Optional[int]
         """Gets a value that specifies the list item identifier."""
         return self.properties.get("Id", None)
 
+    @property
+    def server_redirected_embed_uri(self):
+        # type: () -> Optional[str]
+        """Returns the path for previewing a document in the browser, often in an interactive way, if
+        that feature exists."""
+        return self.properties.get("ServerRedirectedEmbedUri", None)
+
+    @property
+    def server_redirected_embed_url(self):
+        # type: () -> Optional[str]
+        """Returns the URL for previewing a document in the browser, often in an interactive way, if that feature
+        exists. This is currently used in the hovering panel of search results and document library.
+        """
+        return self.properties.get("ServerRedirectedEmbedUri", None)
+
+    @property
+    def client_title(self):
+        # type: () -> Optional[str]
+        """ """
+        return self.properties.get("Client_Title", None)
+
     @property
     def compliance_info(self):
         return self.properties.get("ComplianceInfo", ListItemComplianceInfo())
@@ -589,6 +646,7 @@ class ListItem(SecurableObject):
                 "ComplianceInfo": self.compliance_info,
                 "OData__dlc_DocIdUrl": self.doc_id_url,
                 "EffectiveBasePermissions": self.effective_base_permissions,
+                "EffectiveBasePermissionsForUI": self.effective_base_permissions_for_ui,
                 "GetDlpPolicyTip": self.get_dlp_policy_tip,
                 "FieldValuesAsHtml": self.field_values_as_html,
                 "LikedByInformation": self.liked_by_information,

office365/sharepoint/lists/exporter.py

@@ -11,6 +11,7 @@ from office365.sharepoint.lists.list import List
 
 
 class ListExporter(object):
+    """ """
 
     @staticmethod
     def export(