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

office365/sharepoint/tenant/administration/audit/unified_record.py

@@ -1,7 +1,25 @@
 from office365.runtime.client_value import ClientValue
+from office365.sharepoint.tenant.administration.audit.data import AuditData
 
 
 class UnifiedAuditRecord(ClientValue):
+
+    def __init__(
+        self,
+        audit_data=AuditData(),
+        creation_date=None,
+        operation=None,
+        record_id=None,
+        record_type=None,
+        user_id=None,
+    ):
+        self.AuditData = audit_data
+        self.CreationDate = creation_date
+        self.Operation = operation
+        self.RecordId = record_id
+        self.RecordType = record_type
+        self.UserId = user_id
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Administration.TenantAdmin.UnifiedAuditRecord"

office365/sharepoint/tenant/administration/coms/messages_fields_data.py

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

office365/sharepoint/tenant/administration/coms/messages_service_proxy.py

@@ -0,0 +1,16 @@
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.sharepoint.entity import Entity
+
+
+class Office365CommsMessagesServiceProxy(Entity):
+    """"""
+
+    def __init__(self, context):
+        static_path = ResourcePath(
+            "Microsoft.Online.SharePoint.TenantAdministration.Office365CommsMessagesServiceProxy"
+        )
+        super(Office365CommsMessagesServiceProxy, self).__init__(context, static_path)
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantAdministration.Office365CommsMessagesServiceProxy"

office365/sharepoint/tenant/administration/copilot/adaptive_card_config.py

@@ -0,0 +1,11 @@
+from office365.runtime.client_value import ClientValue
+
+
+class AdaptiveCardConfig(ClientValue):
+    """"""
+
+    @property
+    def entity_type_name(self):
+        return (
+            "Microsoft.SharePoint.Administration.TenantAdmin.Copilot.AdaptiveCardConfig"
+        )

office365/sharepoint/tenant/administration/datagovernance/client_base.py

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

office365/sharepoint/tenant/administration/datagovernance/insight_client.py

@@ -0,0 +1,82 @@
+from typing import TYPE_CHECKING
+
+from office365.runtime.client_result import ClientResult
+from office365.runtime.paths.service_operation import ServiceOperationPath
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.tenant.administration.datagovernance.client_base import (
+    SPDataGovernanceRestApiClientBase,
+)
+from office365.sharepoint.tenant.administration.datagovernance.insight_metadata import (
+    SPDataGovernanceInsightMetadata,
+)
+
+if TYPE_CHECKING:
+    from office365.sharepoint.client_context import ClientContext
+
+
+class SPDataGovernanceInsightRestApiClient(SPDataGovernanceRestApiClientBase):
+    """"""
+
+    def __init__(self, context, authorization_header, url, user_agent):
+        # type: (ClientContext, str, str, str) -> None
+        static_path = ServiceOperationPath(
+            "Microsoft.Online.SharePoint.TenantAdministration.SPDataGovernanceInsightRestApiClient",
+            {
+                "authorizationHeader": authorization_header,
+                "url": url,
+                "userAgent": user_agent,
+            },
+        )
+        super(SPDataGovernanceInsightRestApiClient, self).__init__(context, static_path)
+
+    def create_data_access_governance_report(
+        self,
+        report_entity,
+        workload,
+        report_type,
+        file_sensitivity_label_name,
+        file_sensitivity_label_guid,
+        name,
+        template,
+        privacy,
+        site_sensitivity_label_guid,
+        count_of_users_more_than,
+    ):
+        """ """
+        return_type = ClientResult(self.context, SPDataGovernanceInsightMetadata())
+        payload = {
+            "reportEntity": report_entity,
+            "workload": workload,
+            "reportType": report_type,
+            "fileSensitivityLabelName": file_sensitivity_label_name,
+            "fileSensitivityLabelGUID": file_sensitivity_label_guid,
+            "name": name,
+            "template": template,
+            "privacy": privacy,
+            "siteSensitivityLabelGUID": site_sensitivity_label_guid,
+            "countOfUsersMoreThan": count_of_users_more_than,
+        }
+        qry = ServiceOperationQuery(
+            self,
+            "CreateDataAccessGovernanceReport",
+            None,
+            payload,
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def export_spo_data_access_governance_insight(self, report_id):
+        return_type = ClientResult(self.context, str())
+        payload = {"reportId": report_id}
+        qry = ServiceOperationQuery(
+            self,
+            "ExportSPODataAccessGovernanceInsight",
+            None,
+            payload,
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type

office365/sharepoint/tenant/administration/datagovernance/insight_metadata.py

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

office365/sharepoint/tenant/administration/default_time_zone_id.py

@@ -0,0 +1,11 @@
+from office365.runtime.client_value import ClientValue
+
+
+class TenantDefaultTimeZoneId(ClientValue):
+    """ """
+
+    @property
+    def entity_type_name(self):
+        return (
+            "Microsoft.Online.SharePoint.TenantAdministration.TenantDefaultTimeZoneId"
+        )

office365/sharepoint/tenant/administration/endpoints.py

@@ -1,15 +1,66 @@
-from typing import Optional
+from typing import TYPE_CHECKING, Optional
 
+from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.entity import Entity
 
+if TYPE_CHECKING:
+    from office365.sharepoint.client_context import ClientContext
+
 
 class TenantAdminEndpoints(Entity):
+
+    def __init__(self, context):
+        # type: (ClientContext) -> None
+        static_path = ResourcePath(
+            "Microsoft.Online.SharePoint.TenantAdministration.TenantAdminEndpoints"
+        )
+        super(TenantAdminEndpoints, self).__init__(context, static_path)
+
+    @property
+    def aad_admin_center_endpoint(self):
+        # type: () -> Optional[str]
+        """The URL for the Azure Active Directory Admin Center."""
+        return self.properties.get("AADAdminCenterEndpoint", None)
+
+    @property
+    def cdn_default_endpoint(self):
+        # type: () -> Optional[str]
+        """The base address of the default Content Delivery Network (CDN) used by SharePoint Online."""
+        return self.properties.get("CdnDefaultEndpoint", None)
+
     @property
     def o365_admin_center_endpoint(self):
         # type: () -> Optional[str]
-        """"""
+        """The endpoint (URL) to the Office 365 Admin Center."""
         return self.properties.get("O365AdminCenterEndpoint", None)
 
+    @property
+    def cfrms_graph_endpoint(self):
+        # type: () -> Optional[str]
+        """The URL of the Microsoft Graph API specifically for managing Conditional Access policies and Rights
+        Management Services (RMS) settings within a tenant."""
+        return self.properties.get("CFRMSGraphEndpoint", None)
+
+    @property
+    def migration_agent_url(self):
+        # type: () -> Optional[str]
+        """The endpoint where the migration agent software or services can be accessed"""
+        return self.properties.get("MigrationAgentUrl", None)
+
+    @property
+    def mini_maven_endpoint(self):
+        # type: () -> Optional[str]
+        """URL used internally by SharePoint or Microsoft 365 services. It may be part of Microsoft's orchestration
+        or lightweight service framework for tenant or feature management."""
+        return self.properties.get("MiniMavenEndpoint", None)
+
+    @property
+    def sp_migration_tool_url(self):
+        # type: () -> Optional[str]
+        """URL to access the SharePoint Migration Tool, enabling users to download the software
+        for performing migrations"""
+        return self.properties.get("SPMigrationToolUrl", None)
+
     @property
     def entity_type_name(self):
         return "Microsoft.Online.SharePoint.TenantAdministration.TenantAdminEndpoints"

office365/sharepoint/tenant/administration/insights/onedrive_site_sharing.py

@@ -3,3 +3,7 @@ from office365.runtime.client_value import ClientValue
 
 class OneDriveSiteSharingInsights(ClientValue):
     """"""
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantAdministration.OneDriveSiteSharingInsights"

office365/sharepoint/tenant/administration/internal/appservice/permission_request.py

@@ -4,6 +4,10 @@ from office365.sharepoint.entity import Entity
 class SPOWebAppServicePrincipalPermissionRequest(Entity):
     """ """
 
+    @property
+    def client_component_item_unique_id(self):
+        return self.properties.get("ClientComponentItemUniqueId", False)
+
     @property
     def entity_type_name(self):
         return "Microsoft.Online.SharePoint.TenantAdministration.Internal.SPOWebAppServicePrincipalPermissionRequest"

office365/sharepoint/tenant/administration/malware/file.py

@@ -0,0 +1,18 @@
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.sharepoint.entity import Entity
+from office365.sharepoint.files.file import File
+
+
+class SPOMalwareFile(Entity):
+    """ """
+
+    @property
+    def file(self):
+        return self.properties.get(
+            "File",
+            File(self.context, ResourcePath("File", self.resource_path)),
+        )
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantAdministration.SPOMalwareFile"

office365/sharepoint/tenant/administration/modified_property.py

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

office365/sharepoint/tenant/administration/policies/content_security_configuration.py

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

office365/sharepoint/tenant/administration/recent_action.py

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

office365/sharepoint/tenant/administration/settings_service.py

@@ -3,15 +3,20 @@ from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.runtime.types.collections import StringCollection
 from office365.sharepoint.entity import Entity
+from office365.sharepoint.tenant.administration.default_time_zone_id import (
+    TenantDefaultTimeZoneId,
+)
 from office365.sharepoint.tenant.administration.smtp_server import SmtpServer
 from office365.sharepoint.tenant.administration.types import (
     AutoQuotaEnabled,
     DisableGroupify,
+    DisableSelfServiceSiteCreation,
+    EnableAutoNewsDigest,
 )
 
 
 class TenantAdminSettingsService(Entity):
-    """"""
+    """Manage various tenant-level settings related to SharePoint administration"""
 
     def __init__(self, context):
         static_path = ResourcePath(
@@ -20,7 +25,7 @@ class TenantAdminSettingsService(Entity):
         super(TenantAdminSettingsService, self).__init__(context, static_path)
 
     def get_tenant_sharing_status(self):
-        """"""
+        """Retrieves the current state of sharing settings for a tenant"""
         return_type = ClientResult(self.context, int())
         qry = ServiceOperationQuery(
             self, "GetTenantSharingStatus", None, None, None, return_type
@@ -38,21 +43,44 @@ class TenantAdminSettingsService(Entity):
 
     @property
     def available_managed_paths_for_site_creation(self):
-        """"""
+        """
+        Specifies the managed paths that are available for the creation of new SharePoint sites within a tenant.
+        """
         return self.properties.get(
             "AvailableManagedPathsForSiteCreation", StringCollection()
         )
 
     @property
     def disable_groupify(self):
-        """"""
+        """
+        Controls whether SharePoint site owners in your tenant are allowed to convert classic SharePoint sites into
+        Microsoft 365 Groups (a process commonly known as "groupifying" a site)
+        """
         return self.properties.get("DisableGroupify", DisableGroupify())
 
+    @property
+    def disable_self_service_site_creation(self):
+        """ " """
+        return self.properties.get(
+            "DisableSelfServiceSiteCreation", DisableSelfServiceSiteCreation()
+        )
+
+    @property
+    def enable_auto_news_digest(self):
+        """ " """
+        return self.properties.get("EnableAutoNewsDigest", EnableAutoNewsDigest())
+
     @property
     def smtp_server(self):
-        """"""
+        """Specifies the server address or endpoint of the SMTP server that SharePoint Online or tenant-related
+        services use for sending emails"""
         return self.properties.get("SmtpServer", SmtpServer())
 
+    @property
+    def tenant_default_time_zone_id(self):
+        """Default time zone configured for a SharePoint Online tenant"""
+        return self.properties.get("TenantDefaultTimeZoneId", TenantDefaultTimeZoneId())
+
     @property
     def entity_type_name(self):
         return "Microsoft.Online.SharePoint.TenantAdministration.TenantAdminSettingsService"
@@ -61,7 +89,12 @@ class TenantAdminSettingsService(Entity):
         if default_value is None:
             property_mapping = {
                 "AvailableManagedPathsForSiteCreation": self.available_managed_paths_for_site_creation,
+                "AutoQuotaEnabled": self.auto_quota_enabled,
+                "DisableGroupify": self.disable_groupify,
+                "DisableSelfServiceSiteCreation": self.disable_self_service_site_creation,
+                "EnableAutoNewsDigest": self.enable_auto_news_digest,
                 "SmtpServer": self.smtp_server,
+                "TenantDefaultTimeZoneId": self.tenant_default_time_zone_id,
             }
             default_value = property_mapping.get(name, None)
         return super(TenantAdminSettingsService, self).get_property(name, default_value)

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