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

office365/sharepoint/tenant/insights/report_manager.py

@@ -1,5 +1,34 @@
+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.tenant.insights.report_metadata import (
+    SPTenantIBInsightsReportMetadata,
+)
 
 
 class SPTenantIBInsightsReportManager(Entity):
     """ """
+
+    def __init__(self, context):
+        static_path = ResourcePath(
+            "Microsoft.SharePoint.Insights.SPTenantIBInsightsReportManager"
+        )
+        super(SPTenantIBInsightsReportManager, self).__init__(context, static_path)
+
+    def create_report(self):
+        """"""
+        return_type = SPTenantIBInsightsReportMetadata(self.context)
+        qry = ServiceOperationQuery(
+            self,
+            "CreateReport",
+            None,
+            None,
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Insights.SPTenantIBInsightsReportManager"

office365/sharepoint/tenant/management/office365_tenant.py

@@ -107,14 +107,17 @@ class Office365Tenant(Entity):
         return return_type
 
     def set_block_download_file_type_policy_data(
-        self, blockDownloadFileTypePolicy, fileTypeIds, excludedBlockDownloadGroupIds
+        self,
+        block_download_file_type_policy,
+        file_type_ids,
+        excluded_block_download_group_ids,
     ):
         # type: (bool, list[int], list[str]) -> Self
         """"""
         payload = {
-            "blockDownloadFileTypePolicy": blockDownloadFileTypePolicy,
-            "fileTypeIds": fileTypeIds,
-            "excludedBlockDownloadGroupIds": excludedBlockDownloadGroupIds,
+            "blockDownloadFileTypePolicy": block_download_file_type_policy,
+            "fileTypeIds": file_type_ids,
+            "excludedBlockDownloadGroupIds": excluded_block_download_group_ids,
         }
         qry = ServiceOperationQuery(
             self, "SetBlockDownloadFileTypePolicyData", None, payload
@@ -205,6 +208,8 @@ class Office365Tenant(Entity):
 
         def _revoke_all_user_sessions(login_name):
             """
+            Logouts a user's sessions across all their devices
+
             :type login_name: str
             """
             qry = ServiceOperationQuery(

office365/sharepoint/tenant/settings.py

@@ -1,5 +1,6 @@
 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
 from office365.sharepoint.entity import Entity
@@ -16,6 +17,15 @@ class TenantSettings(Entity):
         self.context.add_query(qry)
         return self
 
+    def get_data_access_governance_report_config(self):
+        """ """
+        return_type = ClientResult(self.context, str())
+        qry = ServiceOperationQuery(
+            self, "GetDataAccessGovernanceReportConfig", None, None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def set_corporate_catalog(self, url):
         """
         :param str url:

office365/sharepoint/translation/job_status.py

@@ -1,4 +1,8 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
+from office365.sharepoint.translation.job_info import TranslationJobInfo
 
 
 class TranslationJobStatus(Entity):
@@ -7,6 +11,24 @@ class TranslationJobStatus(Entity):
     TranslationJobInfo (section 3.1.5.4) and TranslationItemInfo (section 3.1.5.2) objects.
     """
 
+    @staticmethod
+    def get_all_jobs(context, return_type=None):
+        if return_type is None:
+            return_type = ClientResult(
+                context, ClientValueCollection(TranslationJobInfo)
+            )
+        qry = ServiceOperationQuery(
+            TranslationJobStatus(context),
+            "GetAllJobs",
+            None,
+            None,
+            None,
+            return_type,
+            True,
+        )
+        context.add_query(qry)
+        return return_type
+
     @property
     def entity_type_name(self):
         return "SP.Translation.TranslationJobStatus"

office365/sharepoint/userprofiles/user_profile.py

@@ -107,6 +107,12 @@ class UserProfile(Entity):
         """Specifies the time for the personal site first creation attempt."""
         return self.properties.get("PersonalSiteFirstCreationTime", datetime.min)
 
+    @property
+    def picture_url(self):
+        # type: () -> Optional[str]
+        """Specifies the photo URL for the current user."""
+        return self.properties.get("PictureUrl", None)
+
     @property
     def public_url(self):
         # type: () -> Optional[str]

office365/sharepoint/utilities/utility.py

@@ -1,3 +1,5 @@
+from typing import TYPE_CHECKING
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
@@ -8,6 +10,9 @@ from office365.sharepoint.files.file import File
 from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
 from office365.sharepoint.utilities.principal_info import PrincipalInfo
 
+if TYPE_CHECKING:
+    from office365.sharepoint.client_context import ClientContext
+
 
 class Utility(Entity):
     """
@@ -161,6 +166,7 @@ class Utility(Entity):
 
     @staticmethod
     def log_custom_app_error(context, error):
+        # type: (ClientContext, str) -> ClientResult[int]
         """
         Logs an error from a SharePoint Add-in. The return value indicates the success or failure of this operation.
         These errors are of interest to administrators who monitor such apps (2).

office365/sharepoint/viva/connections_page.py

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

office365/sharepoint/viva/dashboard_configuration.py

@@ -0,0 +1,8 @@
+from office365.runtime.client_value import ClientValue
+
+
+class DashboardConfiguration(ClientValue):
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.EmployeeEngagement.DashboardConfiguration"

office365/sharepoint/viva/employee_engagement.py

@@ -4,6 +4,8 @@ from office365.runtime.queries.function import FunctionQuery
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.viva.app_configuration import AppConfiguration
+from office365.sharepoint.viva.connections_page import VivaConnectionsPage
+from office365.sharepoint.viva.dashboard_configuration import DashboardConfiguration
 from office365.sharepoint.viva.home import VivaHome
 
 
@@ -18,13 +20,31 @@ class EmployeeEngagement(Entity):
         :param str override_language_code:
         """
         return_type = ClientResult(self.context, str())
-        payload = {"return return_type": override_language_code}
+        payload = {"override_language_code": override_language_code}
         qry = ServiceOperationQuery(
             self, "DashboardContent", None, payload, None, return_type
         )
         self.context.add_query(qry)
         return return_type
 
+    def full_dashboard_content(
+        self, canvas_as_json=None, include_personalization_data=None
+    ):
+        """
+        :param bool canvas_as_json:
+        :param bool include_personalization_data:
+        """
+        return_type = ClientResult(self.context, DashboardConfiguration())
+        payload = {
+            "canvasAsJson": canvas_as_json,
+            "includePersonalizationData": include_personalization_data,
+        }
+        qry = ServiceOperationQuery(
+            self, "FullDashboardContent", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def viva_home_configuration(self):
         return_type = ClientResult(self.context, {})
         qry = FunctionQuery(self, "VivaHomeConfiguration", None, return_type)
@@ -45,3 +65,21 @@ class EmployeeEngagement(Entity):
                 self.context, ResourcePath("AppConfiguration", self.resource_path)
             ),
         )
+
+    @property
+    def viva_connections_page(self):
+        return self.properties.get(
+            "VivaConnectionsPage",
+            VivaConnectionsPage(
+                self.context, ResourcePath("VivaConnectionsPage", self.resource_path)
+            ),
+        )
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "AppConfiguration": self.app_configuration,
+                "VivaConnectionsPage": self.viva_connections_page,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(EmployeeEngagement, self).get_property(name, default_value)

office365/sharepoint/viva/resource_get_endpoint.py

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

office365/sharepoint/viva/resource_link.py

@@ -0,0 +1,8 @@
+from office365.runtime.client_value import ClientValue
+
+
+class VivaResourceLink(ClientValue):
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.EmployeeEngagement.ResourceLink"

office365/sharepoint/webparts/tile_data.py

@@ -1,5 +1,26 @@
 from office365.runtime.client_value import ClientValue
+from office365.runtime.types.collections import StringCollection
 
 
 class TileData(ClientValue):
     """Represents a Tile that describes a graphical link the user can click."""
+
+    def __init__(
+        self,
+        background_collage_image_locations=None,
+        background_image_location=None,
+        background_image_renders_as_icon=None,
+        body_text=None,
+        description=None,
+        hover_disabled=None,
+        id_=None,
+    ):
+        self.BackgroundCollageImageLocations = StringCollection(
+            background_collage_image_locations
+        )
+        self.BackgroundImageLocation = background_image_location
+        self.BackgroundImageRendersAsIcon = background_image_renders_as_icon
+        self.BodyText = body_text
+        self.Description = description
+        self.HoverDisabled = hover_disabled
+        self.ID = id_

office365/sharepoint/webs/dataleakage_prevention_status_info.py

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

office365/sharepoint/webs/information.py

@@ -1,7 +1,72 @@
+from datetime import datetime
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
 class WebInformation(Entity):
     """Specifies metadata about a site"""
 
-    pass
+    def __repr__(self):
+        return self.server_relative_url or self.entity_type_name
+
+    @property
+    def configuration(self):
+        # type: () -> Optional[str]
+        """Specifies the identifier (ID) of the site definition configuration that was used to create the site"""
+        return self.properties.get("Configuration", None)
+
+    @property
+    def created(self):
+        # type: () -> Optional[datetime]
+        """Specifies when the site (2) was created."""
+        return self.properties.get("Created", datetime.min)
+
+    @property
+    def description(self):
+        # type: () -> Optional[str]
+        """Specifies the description for the site"""
+        return self.properties.get("Description", None)
+
+    @property
+    def id(self):
+        # type: () -> Optional[str]
+        """Specifies the site identifier for the site"""
+        return self.properties.get("Id", None)
+
+    @property
+    def language(self):
+        # type: () -> Optional[int]
+        """Specifies the language code identifier (LCID) for the language that is used on the site"""
+        return self.properties.get("Language", None)
+
+    @property
+    def last_item_modified_date(self):
+        # type: () -> Optional[datetime]
+        """Gets the date and time that an item was last modified in the site by a non-system update.
+        A non-system update is a change to a list item that is visible to end users."""
+        return self.properties.get("LastItemModifiedDate", datetime.min)
+
+    @property
+    def server_relative_url(self):
+        # type: () -> Optional[str]
+        """Specifies the server-relative URL of the site"""
+        return self.properties.get("ServerRelativeUrl", None)
+
+    @property
+    def title(self):
+        # type: () -> Optional[str]
+        """Specifies the title for the site. Its length MUST be equal to or less than 255."""
+        return self.properties.get("Title", None)
+
+    @property
+    def web_template(self):
+        # type: () -> Optional[str]
+        """Specifies the name of the site template that was used to create the site."""
+        return self.properties.get("WebTemplate", None)
+
+    @property
+    def web_template_id(self):
+        # type: () -> Optional[int]
+        """Specifies the identifier of the site template that was used to create the site"""
+        return self.properties.get("WebTemplateId", None)

office365/sharepoint/webs/regional_settings.py

@@ -108,6 +108,38 @@ class RegionalSettings(Entity):
         """ """
         return self.properties.get("NegativeSign", None)
 
+    @property
+    def neg_number_mode(self):
+        # type: () -> Optional[int]
+        """Specifies the negative number mode that is used for displaying negative numbers in calculated fields
+        based on the locale of the server."""
+        return self.properties.get("NegNumberMode", None)
+
+    @property
+    def pm(self):
+        # type: () -> Optional[str]
+        """Specifies the string that is used to represent time after noon on the site"""
+        return self.properties.get("PM", None)
+
+    @property
+    def positive_sign(self):
+        # type: () -> Optional[str]
+        """Specifies the symbol that is used to represent a positive number on the site"""
+        return self.properties.get("PositiveSign", None)
+
+    @property
+    def show_weeks(self):
+        # type: () -> Optional[bool]
+        """Specifies whether to display the week number in day or week views of a calendar."""
+        return self.properties.get("ShowWeeks", None)
+
+    @property
+    def thousand_separator(self):
+        # type: () -> Optional[str]
+        """Specifies the symbol that is used to separate thousands for numbers on the site. For example,
+        if the symbol is "," the number 123456789 would appear as "123,456,789"."""
+        return self.properties.get("ThousandSeparator", None)
+
     @property
     def work_days(self):
         # type: () -> Optional[int]

office365/sharepoint/webs/time_zone.py

@@ -44,7 +44,7 @@ class TimeZone(Entity):
         return self.properties.get("Information", TimeZoneInformation())
 
 
-class TimeZoneCollection(EntityCollection):
+class TimeZoneCollection(EntityCollection[TimeZone]):
     """TimeZone collection"""
 
     def __init__(self, context, resource_path=None):

office365/sharepoint/webs/web.py

@@ -6,6 +6,7 @@ from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.paths.service_operation import ServiceOperationPath
+from office365.runtime.queries.client_query import ClientQuery
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.runtime.types.collections import StringCollection
 from office365.sharepoint.activities.entity import SPActivityEntity
@@ -51,8 +52,12 @@ from office365.sharepoint.lists.document_library_information import (
 )
 from office365.sharepoint.lists.get_parameters import GetListsParameters
 from office365.sharepoint.lists.list import List
+from office365.sharepoint.lists.render_data_parameters import RenderListDataParameters
 from office365.sharepoint.lists.template_collection import ListTemplateCollection
 from office365.sharepoint.lists.template_type import ListTemplateType
+from office365.sharepoint.marketplace.corporatecuratedgallery.addins.principals_response import (
+    SPGetAddinPrincipalsResponse,
+)
 from office365.sharepoint.marketplace.corporatecuratedgallery.available_addins_response import (
     SPAvailableAddinsResponse,
 )
@@ -101,6 +106,9 @@ from office365.sharepoint.views.view import View
 from office365.sharepoint.webparts.client.collection import ClientWebPartCollection
 from office365.sharepoint.webs.calendar_type import CalendarType
 from office365.sharepoint.webs.context_web_information import ContextWebInformation
+from office365.sharepoint.webs.dataleakage_prevention_status_info import (
+    SPDataLeakagePreventionStatusInfo,
+)
 from office365.sharepoint.webs.information_collection import WebInformationCollection
 from office365.sharepoint.webs.modernize_homepage_result import ModernizeHomepageResult
 from office365.sharepoint.webs.multilingual_settings import MultilingualSettings
@@ -159,6 +167,7 @@ class Web(SecurableObject):
         return return_type
 
     def add_cross_farm_message(self, message):
+        # type: (str) -> ClientResult[bool]
         """
         :param str message:
         """
@@ -170,6 +179,30 @@ class Web(SecurableObject):
         self.context.add_query(qry)
         return return_type
 
+    def get_access_request_list(self):
+        """ """
+        return_type = List(self.context)
+        self.lists.add_child(return_type)
+
+        def _get_access_request_list():
+            return_type.set_property("Url", self.access_request_list_url)
+
+        self.ensure_properties(["AccessRequestListUrl"], _get_access_request_list)
+        return return_type
+
+    def get_document_by_doc_id(self, doc_id):
+        """ """
+        return_type = ClientResult(self.context)
+        qry = ClientQuery(self.context, return_type=return_type)
+
+        def _construct_request(request):
+            request.url = "{0}/_layouts/15/DocIdRedir.aspx?ID={1}".format(
+                self.context.base_url, doc_id
+            )
+
+        self.context.add_query(qry).before_query_execute(_construct_request)
+        return return_type
+
     def get_site_script(
         self,
         include_branding=True,
@@ -211,6 +244,36 @@ class Web(SecurableObject):
         self.context.add_query(qry)
         return return_type
 
+    def get_list_data_as_stream(self, path, view_xml=None):
+        """Returns list data from the specified list url and for the specified query parameters.
+
+        :param str path: A string that contains the site-relative URL for a list, for example, /Lists/Announcements.
+        :param str view_xml:
+        """
+        if view_xml is None:
+            view_xml = "<View><Query></Query></View>"
+        return_type = ClientResult(self.context, dict())
+
+        def _get_list_data_as_stream():
+            list_abs_url = self.url + path
+            parameters = RenderListDataParameters(view_xml=view_xml)
+            List.get_list_data_as_stream(
+                self.context, list_abs_url, parameters, return_type=return_type
+            )
+
+        self.ensure_property("Url", _get_list_data_as_stream)
+        return return_type
+
+    def get_onedrive_list_data_as_stream(self, view_xml=None):
+        """Returns list data from the specified list url and for the specified query parameters.
+
+        :param str view_xml:
+        """
+        if view_xml is None:
+            view_xml = RenderListDataParameters()
+            view_xml.ViewXml = "<View><Query></Query></View>"
+        return List.get_onedrive_list_data_as_stream(self.context, view_xml)
+
     def get_list_operation(self, list_id, operation_id):
         # type: (str, str) -> SPLargeOperation
         """ """
@@ -480,6 +543,26 @@ class Web(SecurableObject):
         self.context.add_query(qry)
         return return_type
 
+    def get_addin_principals_having_permissions_in_sites(
+        self, server_relative_urls=None, urls=None
+    ):
+        """
+        :param list[str] server_relative_urls:
+        :param list[str] urls:
+        """
+        payload = {"serverRelativeUrls": server_relative_urls, "urls": urls}
+        return_type = ClientResult(self.context, SPGetAddinPrincipalsResponse())
+        qry = ServiceOperationQuery(
+            self,
+            "GetAddinPrincipalsHavingPermissionsInSites",
+            None,
+            payload,
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def get_app_bdc_catalog(self):
         """
         Returns the Business Data Connectivity (BDC) MetadataCatalog for an application that gives access to the
@@ -585,6 +668,42 @@ class Web(SecurableObject):
         self.context.add_query(qry)
         return return_type
 
+    def get_recycle_bin_items_by_query_info(
+        self,
+        is_ascending=True,
+        item_state=None,
+        order_by=None,
+        paging_info=None,
+        row_limit=100,
+        show_only_my_items=False,
+    ):
+        """
+        Gets the recycle bin items that are based on the specified query.
+
+        :param str paging_info: an Object that is used to obtain the next set of rows in a paged view of the Recycle Bin
+        :param int row_limit: a limit for the number of items returned in the query per page.
+        :param bool is_ascending: a Boolean value that specifies whether to sort in ascending order.
+        :param int order_by: the column by which to order the Recycle Bin query.
+        :param int item_state: Recycle Bin stage of items to return in the query.
+        :param bool show_only_my_items:
+        """
+        return_type = RecycleBinItemCollection(
+            self.context, self.recycle_bin.resource_path
+        )
+        payload = {
+            "rowLimit": row_limit,
+            "isAscending": is_ascending,
+            "pagingInfo": paging_info,
+            "orderBy": order_by,
+            "itemState": item_state,
+            "ShowOnlyMyItems": show_only_my_items,
+        }
+        qry = ServiceOperationQuery(
+            self, "GetRecycleBinItemsByQueryInfo", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def get_all_webs(self):
         """Returns a collection containing a flat list of all Web objects in the Web."""
         from office365.sharepoint.webs.collection import WebCollection
@@ -1262,6 +1381,7 @@ class Web(SecurableObject):
         display_format=DateTimeFieldFormatType.DateTime,
         calendar_type=CalendarType.None_,
     ):
+        # type: (str, int, int) -> ClientResult[str]
         """
         Returns parsed DateTime value.
 
@@ -1932,6 +2052,7 @@ class Web(SecurableObject):
     @property
     def access_request_list_url(self):
         # type: () -> Optional[str]
+        """Gets the URL of the access request list to the current site"""
         return self.properties.get("AccessRequestListUrl", None)
 
     @property
@@ -2139,6 +2260,16 @@ class Web(SecurableObject):
         """
         return self.properties.get("Configuration", None)
 
+    @property
+    def data_leakage_prevention_status_info(self):
+        return self.properties.get(
+            "DataLeakagePreventionStatusInfo",
+            SPDataLeakagePreventionStatusInfo(
+                self.context,
+                ResourcePath("DataLeakagePreventionStatusInfo", self.resource_path),
+            ),
+        )
+
     @property
     def description_resource(self):
         """A UserResource object that represents the description of this web."""
@@ -2504,6 +2635,11 @@ class Web(SecurableObject):
         """Specifies whether the tree view is enabled on the site"""
         return self.properties.get("TreeViewEnabled", None)
 
+    @property
+    def taxonomy_list(self):
+        """A special list that stores the mapping between taxonomy term IDs and their corresponding values"""
+        return self.lists.get_by_title("TaxonomyHiddenList")
+
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {
@@ -2517,6 +2653,7 @@ class Web(SecurableObject):
                 "ContentTypes": self.content_types,
                 "ClientWebParts": self.client_web_parts,
                 "CurrentUser": self.current_user,
+                "DataLeakagePreventionStatusInfo": self.data_leakage_prevention_status_info,
                 "DescriptionResource": self.description_resource,
                 "DescriptionTranslations": self.description_translations,
                 "EffectiveBasePermissions": self.effective_base_permissions,

office365/sharepoint/workflow/task.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.listitems.listitem import ListItem
+
+
+class SPWorkflowTask(ListItem):
+    """ """