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

office365/sharepoint/tenant/administration/tenant.py

@@ -19,6 +19,9 @@ from office365.sharepoint.lists.render_override_parameters import (
 from office365.sharepoint.publishing.portal_health_status import PortalHealthStatus
 from office365.sharepoint.sites.home_sites_details import HomeSitesDetails
 from office365.sharepoint.sites.site import Site
+from office365.sharepoint.tenant.administration.app_billing_properties import (
+    SPOAppBillingProperties,
+)
 from office365.sharepoint.tenant.administration.collaboration.insights_data import (
     CollaborationInsightsData,
 )
@@ -88,8 +91,28 @@ class Tenant(Entity):
         )
         super(Tenant, self).__init__(context, static_path)
 
+    def accept_syntex_repository_terms_of_service(self):
+        """
+        Used to accept the Microsoft Syntex repository terms of service for your organization.
+        This acceptance is often necessary for enabling features related to document processing or repositories
+        in Microsoft Syntex.
+        """
+        qry = ServiceOperationQuery(self, "AcceptSyntexRepositoryTermsOfService")
+        self.context.add_query(qry)
+        return self
+
+    def activate_application_billing_policy(self, billing_policy_id):
+        """ """
+        payload = {"billingPolicyId": billing_policy_id}
+        return_type = ClientResult(self.context, SPOAppBillingProperties())
+        qry = ServiceOperationQuery(
+            self, "ActivateApplicationBillingPolicy", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def add_recent_admin_action_report(self):
-        """"""
+        """Logs recent administrative actions within a SharePoint Online tenant"""
         return_type = ClientResult(self.context, RecentAdminActionReport())
         payload = {"payload": RecentAdminActionReportPayload()}
         qry = ServiceOperationQuery(
@@ -121,6 +144,9 @@ class Tenant(Entity):
 
     def delete_policy_definition(self, item_id):
         """
+        Deletes a policy definition from a Microsoft 365 tenant.
+        Policy definitions may refer to specific settings related to compliance, security,
+        or site governance (such as site or group creation policies).
         :param int item_id:
         """
         qry = ServiceOperationQuery(
@@ -140,6 +166,7 @@ class Tenant(Entity):
         return self
 
     def get_spo_tenant_all_web_templates(self):
+        """ """
         return_type = SPOTenantWebTemplateCollection(self.context)
         qry = ServiceOperationQuery(
             self, "GetSPOTenantAllWebTemplates", None, None, None, return_type
@@ -148,6 +175,7 @@ class Tenant(Entity):
         return return_type
 
     def get_onedrive_site_sharing_insights(self, query_mode):
+        """Retrieves insights or reports related to OneDrive for Business site sharing activities"""
         return_type = ClientResult(self.context, OneDriveSiteSharingInsights())
         payload = {"queryMode": query_mode}
         qry = ServiceOperationQuery(
@@ -229,6 +257,7 @@ class Tenant(Entity):
 
     def get_home_sites(self):
         # type: () -> ClientResult[ClientValueCollection[HomeSitesDetails]]
+        """Retrieves the Home Site that has been designated for your Microsoft 365 tenant."""
         return_type = ClientResult(
             self.context,
             ClientValueCollection(HomeSitesDetails),  # pylint: disable=E1120
@@ -238,6 +267,7 @@ class Tenant(Entity):
         return return_type
 
     def get_home_sites_details(self):
+        """Retrieves detailed information about the Home Sites configured in a SharePoint Online tenant."""
         return_type = ClientResult(
             self.context, ClientValueCollection(HomeSitesDetails)
         )
@@ -267,12 +297,23 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return return_type
 
-    def export_to_csv(self, view_xml=None):
+    def export_to_csv(
+        self, view_xml=None, time_zone_id=None, columns_info=None, list_name=None
+    ):
         """
+        Exports tenant-level data to a CSV file.
         :param str view_xml:
+        :param int time_zone_id:
+        :param list columns_info:
+        :param str list_name:
         """
         return_type = ClientResult(self.context)
-        payload = {"viewXml": view_xml}
+        payload = {
+            "viewXml": view_xml,
+            "timeZoneId": time_zone_id,
+            "columnsInfo": columns_info,
+            "listName": list_name,
+        }
         qry = ServiceOperationQuery(
             self, "ExportToCSV", None, payload, None, return_type
         )
@@ -334,6 +375,16 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def get_ransomware_events_overview(self):
+        # type: () -> ClientResult[AnyStr]
+        """ """
+        return_type = ClientResult(self.context)
+        qry = ServiceOperationQuery(
+            self, "GetRansomwareEventsOverview", None, None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def get_sp_list_item_count(self, list_name):
         # type: (str) -> ClientResult[int]
         """ """
@@ -659,9 +710,23 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def get_billing_policy_id_for_app(self, application_id):
+        """ """
+        return_type = ClientResult(self.context)
+        payload = {"applicationId": application_id}
+        qry = ServiceOperationQuery(
+            self, "GetBillingPolicyIdForApp", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def connect_site_to_hub_site_by_id(self, site_url, hub_site_id):
         # type: (str, str) -> Self
-        """Connects Site to Hub Site"""
+        """Connects Site to Hub Site
+
+        :param str site_url:
+        :param str hub_site_id:
+        """
         params = {"siteUrl": site_url, "hubSiteId": hub_site_id}
         qry = ServiceOperationQuery(
             self, "ConnectSiteToHubSiteById", None, params, None, None
@@ -669,6 +734,12 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return self
 
+    def ensure_brand_center_feature(self):
+        """Ensures that the Brand Center feature is enabled"""
+        qry = ServiceOperationQuery(self, "EnsureBrandCenterFeature")
+        self.context.add_query(qry)
+        return self
+
     def send_email(self, site_url):
         # type: (str) -> ClientResult[bool]
         """ """
@@ -749,6 +820,41 @@ class Tenant(Entity):
         """"""
         return self.properties.get("DefaultContentCenterSite", SiteInfoForSitePicker())
 
+    @property
+    def no_access_redirect_url(self):
+        # type: () -> Optional[bool]
+        """Specifies the URL of the redirected site for those site collections which have the locked state "NoAccess"""
+        return self.properties.get("NoAccessRedirectUrl", None)
+
+    @property
+    def notifications_in_share_point_enabled(self):
+        # type: () -> Optional[bool]
+        """Enables or disables notifications in SharePoint."""
+        return self.properties.get("NotificationsInSharePointEnabled", None)
+
+    @property
+    def notify_owners_when_invitations_accepted(self):
+        # type: () -> Optional[bool]
+        """When this parameter is set to true and when an external user accepts an invitation to a resource
+        in a user's OneDrive for Business, the OneDrive for Business owner is notified by e-mail.
+        """
+        return self.properties.get("NotifyOwnersWhenInvitationsAccepted", None)
+
+    @property
+    def one_drive_storage_quota(self):
+        # type: () -> Optional[int]
+        """Gets a default OneDrive for Business storage quota for the tenant. It will be used for new OneDrive
+        for Business sites created."""
+        return self.properties.get("OneDriveStorageQuota", None)
+
+    @property
+    def notify_owners_when_items_reshared(self):
+        # type: () -> Optional[bool]
+        """When is set to true and another user re-shares a document from a
+        user's OneDrive for Business, the OneDrive for Business owner is notified by e-mail.
+        """
+        return self.properties.get("NotifyOwnersWhenItemsReshared", None)
+
     @property
     def root_site_url(self):
         # type: () -> Optional[str]

office365/sharepoint/tenant/administration/types.py

@@ -6,16 +6,28 @@ class DisableGroupify(ClientValue):
 
 
 class AutoQuotaEnabled(ClientValue):
-    """ """
+    """Automatic quota management type"""
 
     def __init__(self, is_read_only=None, value=None):
         self.IsReadOnly = is_read_only
         self.Value = value
 
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantAdministration.AutoQuotaEnabled"
+
 
 class CreatePolicyRequest(ClientValue):
     """ """
 
     def __init__(self, is_preview_run=None, policy_custom_name=None):
+        """
+        :param bool is_preview_run:
+        :param str policy_custom_name:
+        """
         self.isPreviewRun = is_preview_run
         self.policyCustomName = policy_custom_name
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantAdministration.CreatePolicyRequest"

office365/sharepoint/tenant/cdn_api.py

@@ -13,7 +13,9 @@ class TenantCdnApi(Entity):
         )
 
     def get_cdn_urls(self, items=None):
-        """"""
+        """
+        :param list[str] items:
+        """
         payload = {
             "items": items,
         }

office365/sharepoint/tenant/management/office365_tenant.py

@@ -205,6 +205,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/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/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,6 +52,7 @@ 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.available_addins_response import (
@@ -159,6 +161,7 @@ class Web(SecurableObject):
         return return_type
 
     def add_cross_farm_message(self, message):
+        # type: (str) -> ClientResult[bool]
         """
         :param str message:
         """
@@ -170,6 +173,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 +238,35 @@ 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 = "<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
         """ """
@@ -1262,6 +1318,7 @@ class Web(SecurableObject):
         display_format=DateTimeFieldFormatType.DateTime,
         calendar_type=CalendarType.None_,
     ):
+        # type: (str, int, int) -> ClientResult[str]
         """
         Returns parsed DateTime value.
 
@@ -1932,6 +1989,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

office365/sharepoint/workflow/task.py

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