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

office365/sharepoint/tenant/administration/sites/properties.py

@@ -1,9 +1,12 @@
+from datetime import datetime
 from typing import Optional
 
 from office365.onedrive.listitems.list_item import ListItem
+from office365.runtime.client_value_collection import ClientValueCollection
 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.runtime.types.collections import StringCollection
 from office365.sharepoint.client_context import ClientContext
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.internal.paths.static_operation import StaticOperationPath
@@ -11,6 +14,7 @@ from office365.sharepoint.tenant.administration.deny_add_and_customize_pages_sta
     DenyAddAndCustomizePagesStatus,
 )
 from office365.sharepoint.tenant.administration.spo_operation import SpoOperation
+from office365.sharepoint.translation.resource_entry import SPResourceEntry
 
 
 class SiteProperties(Entity):
@@ -96,6 +100,38 @@ class SiteProperties(Entity):
         """Gets site version policy for new document libraries."""
         return self.properties.get("ArchivedBy", None)
 
+    @property
+    def archived_time(self):
+        # type: () -> Optional[datetime]
+        """Gets the time when site was archived."""
+        return self.properties.get("ArchivedTime", datetime.min)
+
+    @property
+    def block_download_links_file_type(self):
+        # type: () -> Optional[int]
+        """Block downloads for view-only files in SharePoint and OneDrive."""
+        return self.properties.get("BlockDownloadLinksFileType", None)
+
+    @property
+    def block_download_microsoft365_group_ids(self):
+        # type: () -> Optional[StringCollection]
+        """Block downloads for view-only files in SharePoint and OneDrive."""
+        return self.properties.get(
+            "BlockDownloadMicrosoft365GroupIds", StringCollection()
+        )
+
+    @property
+    def block_download_policy_file_type_ids(self):
+        # type: () -> Optional[StringCollection]
+        """"""
+        return self.properties.get("BlockDownloadPolicyFileTypeIds", StringCollection())
+
+    @property
+    def created_time(self):
+        # type: () -> Optional[datetime]
+        """Gets the time when the site was created."""
+        return self.properties.get("CreatedTime", datetime.min)
+
     @property
     def deny_add_and_customize_pages(self):
         # type: () -> Optional[int]
@@ -110,6 +146,38 @@ class SiteProperties(Entity):
         """Sets the status of the [DenyAddAndCustomizePages] feature on a site collection."""
         self.set_property("DenyAddAndCustomizePages", value)
 
+    @property
+    def last_content_modified_date(self):
+        # type: () -> Optional[datetime]
+        """Gets the last time content was modified on the site."""
+        return self.properties.get("LastContentModifiedDate", datetime.min)
+
+    @property
+    def group_owner_login_name(self):
+        # type: () -> Optional[str]
+        """Gets the Group Owner login name."""
+        return self.properties.get("GroupOwnerLoginName", None)
+
+    @property
+    def is_hub_site(self):
+        # type: () -> Optional[bool]
+        """"""
+        return self.properties.get("IsHubSite", None)
+
+    @property
+    def title(self):
+        # type: () -> Optional[str]
+        """Site title"""
+        return self.properties.get("Title", None)
+
+    @property
+    def title_translations(self):
+        # type: () -> Optional[str]
+        """Site titles"""
+        return self.properties.get(
+            "TitleTranslations", ClientValueCollection(SPResourceEntry)
+        )
+
     @property
     def owner_login_name(self):
         # type: () -> Optional[str]
@@ -173,6 +241,16 @@ class SiteProperties(Entity):
         # type: () -> str
         return "Microsoft.Online.SharePoint.TenantAdministration.SiteProperties"
 
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "ArchivedTime": self.archived_time,
+                "CreatedTime": self.created_time,
+                "LastContentModifiedDate": self.last_content_modified_date,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(SiteProperties, self).get_property(name, default_value)
+
     def set_property(self, name, value, persist_changes=True):
         super(SiteProperties, self).set_property(name, value, persist_changes)
         # fallback: create a new resource path

office365/sharepoint/tenant/administration/sites/properties_collection.py

@@ -1,6 +1,10 @@
 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_collection import EntityCollection
+from office365.sharepoint.tenant.administration.site_user_group_info import (
+    SiteUserGroupInfo,
+)
 from office365.sharepoint.tenant.administration.sites.properties import SiteProperties
 from office365.sharepoint.tenant.administration.sites.state_properties import (
     SiteStateProperties,
@@ -48,6 +52,21 @@ class SitePropertiesCollection(EntityCollection[SiteProperties]):
         self.context.add_query(qry)
         return return_type
 
+    def get_site_user_groups(self, site_id):
+        """
+        Gets site user groups.
+
+        :param str site_id: Site identifier
+        """
+        return_type = ClientResult(
+            self.context, ClientValueCollection(SiteUserGroupInfo)
+        )
+        qry = ServiceOperationQuery(
+            self, "GetSiteUserGroups", [site_id], None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def check_site_is_archived_by_id(self, site_id):
         """
         :param str site_id: Site identifier

office365/sharepoint/tenant/administration/tenant.py

@@ -17,7 +17,7 @@ from office365.sharepoint.lists.render_override_parameters import (
     RenderListDataOverrideParameters,
 )
 from office365.sharepoint.publishing.portal_health_status import PortalHealthStatus
-from office365.sharepoint.sites.home_sites_details import HomeSitesDetails
+from office365.sharepoint.sites.home.details import HomeSitesDetails
 from office365.sharepoint.sites.site import Site
 from office365.sharepoint.tenant.administration.collaboration.insights_data import (
     CollaborationInsightsData,
@@ -34,6 +34,9 @@ from office365.sharepoint.tenant.administration.insights.onedrive_site_sharing i
 from office365.sharepoint.tenant.administration.insights.top_files_sharing import (
     TopFilesSharingInsights,
 )
+from office365.sharepoint.tenant.administration.policies.app_billing_properties import (
+    SPOAppBillingProperties,
+)
 from office365.sharepoint.tenant.administration.policies.definition import (
     TenantAdminPolicyDefinition,
 )
@@ -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(
@@ -181,6 +209,7 @@ class Tenant(Entity):
         return return_type
 
     def render_recent_admin_actions(self):
+        """ """
         return_type = ClientResult(self.context)
         payload = {
             "parameters": RenderListDataParameters(),
@@ -192,8 +221,20 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return return_type
 
-    def get_top_files_sharing_insights(self, query_mode):
+    def get_spo_app_billing_policies(self):
+        """ """
+        return_type = ClientResult(
+            self.context, ClientValueCollection(SPOAppBillingProperties)
+        )
+        qry = ServiceOperationQuery(
+            self, "GetSPOAppBillingPolicies", None, None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def get_top_files_sharing_insights(self, query_mode=None):
         """
+        Retrieves a report or data about the most shared files within a SharePoint Online tenant
         :param int query_mode:
         """
         payload = {"queryMode": query_mode}
@@ -229,6 +270,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 +280,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 +310,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 +388,43 @@ 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_site_authorization_code_for_migration(self, endpoint_url):
+        return_type = ClientResult(self.context, str())
+        payload = {"endpointUrl": endpoint_url}
+        qry = ServiceOperationQuery(
+            self,
+            "GetSiteAuthorizationCodeForMigration",
+            None,
+            payload,
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def get_site_subscription_id(self):
+        return_type = ClientResult(self.context, str())
+        qry = ServiceOperationQuery(
+            self,
+            "GetSiteSubscriptionId",
+            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]
         """ """
@@ -438,6 +529,7 @@ class Tenant(Entity):
 
     def get_site_health_status(self, source_url):
         """
+        Checks the sitehealth of a specific SharePoint site or site collection in their tenant
         :type source_url: str
         """
         result = ClientResult(self.context, PortalHealthStatus())
@@ -598,6 +690,7 @@ class Tenant(Entity):
 
     def reorder_home_sites(self, home_sites_site_ids):
         """
+        Reorders Home Sites within a SharePoint Online tenant
         :param list[str] home_sites_site_ids:
         """
         payload = {"homeSitesSiteIds": home_sites_site_ids}
@@ -621,6 +714,22 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def get_site_properties_by_site_id(self, site_id, include_detail=False):
+        # type: (str, bool) -> SiteProperties
+        """
+        :param str site_id: A string that represents the site identifier.
+        :param bool include_detail: A Boolean value that indicates whether to include all of the SPSite properties.
+        """
+        return_type = SiteProperties(self.context)
+        return_type.set_property("siteId", site_id, False)
+        self.sites.add_child(return_type)
+        payload = {"siteId": site_id, "includeDetail": include_detail}
+        qry = ServiceOperationQuery(
+            self, "GetSitePropertiesBySiteId", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def get_site_properties_by_url(self, url, include_detail=False):
         # type: (str, bool) -> SiteProperties
         """
@@ -659,9 +768,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 +792,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]
         """ """
@@ -680,7 +809,7 @@ class Tenant(Entity):
 
     @property
     def admin_settings(self):
-        """ """
+        """Manage various tenant-level settings related to SharePoint administration"""
         from office365.sharepoint.tenant.administration.settings_service import (
             TenantAdminSettingsService,
         )
@@ -696,6 +825,24 @@ class Tenant(Entity):
 
         return MigrationCenterServices(self.context)
 
+    @property
+    def comms_messages(self):
+        """ """
+
+        from office365.sharepoint.tenant.administration.coms.messages_service_proxy import (
+            Office365CommsMessagesServiceProxy,
+        )
+
+        return Office365CommsMessagesServiceProxy(self.context)
+
+    @property
+    def multi_geo(self):
+        """ """
+
+        from office365.sharepoint.multigeo.services import MultiGeoServices
+
+        return MultiGeoServices(self.context)
+
     @property
     def ai_builder_enabled(self):
         # type: () -> Optional[str]
@@ -711,6 +858,7 @@ class Tenant(Entity):
 
     @property
     def _aggregated_site_collections_list(self):
+        """ """
         return self.context.web.lists.get_by_title(
             "DO_NOT_DELETE_SPLIST_TENANTADMIN_AGGREGATED_SITECOLLECTIONS"
         )
@@ -749,6 +897,69 @@ class Tenant(Entity):
         """"""
         return self.properties.get("DefaultContentCenterSite", SiteInfoForSitePicker())
 
+    @property
+    def information_barriers_suspension(self):
+        # type: () -> Optional[bool]
+        """Gets information barriers in SharePoint and OneDrive in your organization"""
+        return self.properties.get("InformationBarriersSuspension", None)
+
+    @property
+    def ip_address_allow_list(self):
+        # type: () -> Optional[str]
+        """Configures multiple IP addresses or IP address ranges (IPv4 or IPv6), that are recognized as trusted."""
+        return self.properties.get("IPAddressAllowList", None)
+
+    @property
+    def ip_address_enforcement(self):
+        # type: () -> Optional[bool]
+        """Determines whether access from network locations that are defined by an administrator is allowed."""
+        return self.properties.get("IPAddressEnforcement", None)
+
+    @ip_address_enforcement.setter
+    def ip_address_enforcement(self, value):
+        # type: (bool) -> None
+        """
+        Allows access from network locations that are defined by an administrator.
+        Before the IPAddressEnforcement parameter is set, make sure you add a valid IPv4 or IPv6 address to the
+        IPAddressAllowList parameter.
+        """
+        self.set_property("IPAddressEnforcement", value)
+
+    @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]
@@ -767,17 +978,39 @@ class Tenant(Entity):
 
     @property
     def cdn_api(self):
+        """ """
         from office365.sharepoint.tenant.cdn_api import TenantCdnApi
 
         return TenantCdnApi(self.context)
 
+    @property
+    def crawl_versions_info_provider(self):
+        """Retrieves information about crawl versions for a tenant in SharePoint"""
+
+        from office365.sharepoint.search.administration.tenant_crawl_versions_info_provider import (
+            TenantCrawlVersionsInfoProvider,
+        )
+
+        return TenantCrawlVersionsInfoProvider(self.context)
+
     @property
     def syntex_billing_subscription_settings(self):
-        """"""
+        """
+        Manages billing and subscription details for Microsoft Syntex in SharePoint Online or Microsoft 365 environments
+        """
         return self.properties.get(
             "SyntexBillingSubscriptionSettings", SyntexBillingContext()
         )
 
+    @property
+    def admin_endpoints(self):
+        """ """
+        from office365.sharepoint.tenant.administration.endpoints import (
+            TenantAdminEndpoints,
+        )
+
+        return TenantAdminEndpoints(self.context)
+
     @property
     def entity_type_name(self):
         return "Microsoft.Online.SharePoint.TenantAdministration.Tenant"

office365/sharepoint/tenant/administration/types.py

@@ -4,18 +4,105 @@ from office365.runtime.client_value import ClientValue
 class DisableGroupify(ClientValue):
     """ """
 
+    def __init__(self, is_read_only=None, value=None):
+        # type: (bool, bool) -> None
+        self.IsReadOnly = is_read_only
+        self.Value = value
 
-class AutoQuotaEnabled(ClientValue):
+    def __repr__(self):
+        return f"(IsReadOnly={self.IsReadOnly}, Value={self.Value})"
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantAdministration.DisableGroupify"
+
+
+class EnableAutoNewsDigest(ClientValue):
+    """ """
+
+    def __init__(self, is_read_only=None, value=None):
+        # type: (bool, bool) -> None
+        self.IsReadOnly = is_read_only
+        self.Value = value
+
+    def __repr__(self):
+        return f"(IsReadOnly={self.IsReadOnly}, Value={self.Value})"
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantAdministration.EnableAutoNewsDigest"
+
+
+class DisableSelfServiceSiteCreation(ClientValue):
     """ """
 
+    def __init__(self, is_read_only=None, value=None):
+        # type: (bool, bool) -> None
+        self.IsReadOnly = is_read_only
+        self.Value = value
+
+    def __repr__(self):
+        return f"(IsReadOnly={self.IsReadOnly}, Value={self.Value})"
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantAdministration.DisableSelfServiceSiteCreation"
+
+
+class AutoQuotaEnabled(ClientValue):
+    """Automatic quota management type"""
+
     def __init__(self, is_read_only=None, value=None):
         self.IsReadOnly = is_read_only
         self.Value = value
 
+    def __repr__(self):
+        return f"(IsReadOnly={self.IsReadOnly}, Value={self.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):
+    def __init__(
+        self,
+        is_preview_run=None,
+        policy_custom_name=None,
+        policy_definition_details=None,
+        policy_description=None,
+        policy_frequency_unit=None,
+        policy_frequency_value=None,
+        policy_id=None,
+        policy_tags=None,
+        policy_template=None,
+        policy_type=None,
+    ):
+        """
+        :param bool is_preview_run:
+        :param str policy_custom_name:
+        :param str policy_definition_details:
+        :param str policy_description:
+        :param int policy_frequency_unit:
+        :param int policy_frequency_value:
+        :param str policy_id:
+        :param str policy_tags:
+        :param str policy_template:
+        :param int policy_type:
+        """
         self.isPreviewRun = is_preview_run
         self.policyCustomName = policy_custom_name
+        self.policyDefinitionDetails = policy_definition_details
+        self.policyDescription = policy_description
+        self.policyFrequencyUnit = policy_frequency_unit
+        self.policyFrequencyValue = policy_frequency_value
+        self.policyId = policy_id
+        self.policyTags = policy_tags
+        self.policyTemplate = policy_template
+        self.policyType = policy_type
+
+    @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,
         }