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

office365/sharepoint/storagemetrics/storage_metrics.py

@@ -7,6 +7,12 @@ from office365.sharepoint.entity import Entity
 class StorageMetrics(Entity):
     """Specifies the storage-related metrics for list folders in the site"""
 
+    @property
+    def additional_file_stream_size(self):
+        # type: () -> Optional[int]
+        """ """
+        return self.properties.get("AdditionalFileStreamSize", None)
+
     @property
     def last_modified(self):
         # type: () -> Optional[datetime.datetime]
@@ -41,3 +47,15 @@ class StorageMetrics(Entity):
         Total size for a file/folder includes stream, version, and metadata sizes.
         """
         return self.properties.get("TotalSize", None)
+
+    @property
+    def version_count(self):
+        # type: () -> Optional[int]
+        """ """
+        return self.properties.get("VersionCount", None)
+
+    @property
+    def version_size(self):
+        # type: () -> Optional[int]
+        """ """
+        return self.properties.get("VersionSize", None)

office365/sharepoint/tenant/administration/copilot/agentinsights/client.py

@@ -0,0 +1,42 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.runtime.paths.service_operation import ServiceOperationPath
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.client_context import ClientContext
+from office365.sharepoint.tenant.administration.copilot.agentinsights.report_metadata import (
+    SPOCopilotAgentInsightsReportMetadata,
+)
+from office365.sharepoint.tenant.administration.datagovernance.client_base import (
+    SPDataGovernanceRestApiClientBase,
+)
+
+
+class SPOCopilotAgentInsightsRestApiClient(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(SPOCopilotAgentInsightsRestApiClient, self).__init__(context, static_path)
+
+    def get_all_copilot_agent_insights_reports_metadata(self):
+        return_type = ClientResult(
+            self.context, ClientValueCollection(SPOCopilotAgentInsightsReportMetadata)
+        )
+        qry = ServiceOperationQuery(
+            self,
+            "GetAllCopilotAgentInsightsReportsMetadata",
+            None,
+            None,
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type

office365/sharepoint/tenant/administration/copilot/agentinsights/report_metadata.py

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

office365/sharepoint/tenant/administration/group.py

@@ -1,7 +1,18 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.client_value import ClientValue
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
 
+class GroupInfo(ClientValue):
+    """"""
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantAdministration.GroupInfo"
+
+
 class SPOGroup(Entity):
     """ """
 
@@ -12,6 +23,29 @@ class SPOGroup(Entity):
             )
         super(SPOGroup, self).__init__(context, resource_path)
 
+    def add_as_group_owner_and_member(self, group_id, user_id, user_principal_name):
+        """ """
+        payload = {
+            "groupId": group_id,
+            "userId": user_id,
+            "userPrincipalName": user_principal_name,
+        }
+        qry = ServiceOperationQuery(
+            self, "AddAsGroupOwnerAndMember", None, payload, None
+        )
+        self.context.add_query(qry)
+        return self
+
+    def get_group_info(self, group_id):
+        """"""
+        return_type = ClientResult(self.context, GroupInfo())
+        payload = {"groupId": group_id}
+        qry = ServiceOperationQuery(
+            self, "GetGroupInfo", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def entity_type_name(self):
         return "Microsoft.Online.SharePoint.TenantAdministration.SPOGroup"

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

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

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

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

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

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

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

@@ -10,6 +10,9 @@ class SitePropertiesEnumerableFilter(ClientValue):
         include_personal_site=None,
         group_id_defined=None,
         template=None,
+        archived_by=None,
+        archived_time=None,
+        archive_status=None,
     ):
         """
         :param str _filter:
@@ -20,12 +23,15 @@ class SitePropertiesEnumerableFilter(ClientValue):
         :param str template:
         """
         super(SitePropertiesEnumerableFilter, self).__init__()
+        self.ArchivedBy = archived_by
         self.Filter = _filter
         self.GroupIdDefined = group_id_defined
         self.IncludeDetail = include_detail
         self.IncludePersonalSite = include_personal_site
         self.StartIndex = start_index
         self.Template = template
+        self.ArchivedTime = archived_time
+        self.ArchiveStatus = archive_status
 
     @property
     def entity_type_name(self):

office365/sharepoint/tenant/administration/tenant.py

@@ -37,9 +37,16 @@ from office365.sharepoint.tenant.administration.insights.top_files_sharing impor
 from office365.sharepoint.tenant.administration.policies.app_billing_properties import (
     SPOAppBillingProperties,
 )
+from office365.sharepoint.tenant.administration.policies.content_security_configuration import (
+    SPOContentSecurityPolicyConfiguration,
+)
 from office365.sharepoint.tenant.administration.policies.definition import (
     TenantAdminPolicyDefinition,
 )
+from office365.sharepoint.tenant.administration.policies.file_version_types import (
+    SPOFileVersionBatchDeleteJobProgress,
+    SPOFileVersionPolicySettings,
+)
 from office365.sharepoint.tenant.administration.powerapps.environment import (
     PowerAppsEnvironment,
 )
@@ -221,6 +228,15 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def get_content_security_policy(self):
+        """"""
+        return_type = SPOContentSecurityPolicyConfiguration(self.context)
+        qry = ServiceOperationQuery(
+            self, "GetContentSecurityPolicy", None, None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def get_spo_app_billing_policies(self):
         """ """
         return_type = ClientResult(
@@ -310,6 +326,32 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def is_request_content_management_assessment_eligible(self):
+        return_type = ClientResult(self.context, bool())
+        qry = ServiceOperationQuery(
+            self,
+            "IsRequestContentManagementAssessmentEligible",
+            None,
+            None,
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def is_syntex_repository_terms_of_service_accepted(self):
+        return_type = ClientResult(self.context, bool())
+        qry = ServiceOperationQuery(
+            self,
+            "IsSyntexRepositoryTermsOfServiceAccepted",
+            None,
+            None,
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def export_to_csv(
         self, view_xml=None, time_zone_id=None, columns_info=None, list_name=None
     ):
@@ -398,6 +440,20 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def get_root_site_url(self):
+        """ """
+        return_type = ClientResult(self.context, str())
+        qry = ServiceOperationQuery(
+            self,
+            "GetRootSiteUrl",
+            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}
@@ -714,9 +770,53 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def restore_deleted_site_by_id(self, site_id):
+        """Restores deleted site with the specified URL
+        :param str site_id: A string representing the site identifier.
+        """
+        return_type = SpoOperation(self.context)
+        qry = ServiceOperationQuery(
+            self, "RestoreDeletedSiteById", [site_id], None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def get_file_version_policy_for_library(self, site_url, list_params=None):
+        """ """
+        return_type = ClientResult(self.context, SPOFileVersionPolicySettings())
+        payload = {"siteUrl": site_url, "listParams": list_params}
+        qry = ServiceOperationQuery(
+            self,
+            "GetFileVersionPolicyForLibrary",
+            None,
+            payload,
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def get_file_version_batch_delete_job_progress_for_library(
+        self, site_url, list_params
+    ):
+        """Gets the progress of the file version batch delete job for the specified site and list parameters."""
+        return_type = ClientResult(self.context, SPOFileVersionBatchDeleteJobProgress())
+        payload = {"siteUrl": site_url, "listParams": list_params}
+        qry = ServiceOperationQuery(
+            self,
+            "GetFileVersionBatchDeleteJobProgressForLibrary",
+            None,
+            payload,
+            None,
+            return_type,
+        )
+        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
-        """
+        """Gets the site properties for the specified site ID.
+
         :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.
         """
@@ -733,6 +833,8 @@ class Tenant(Entity):
     def get_site_properties_by_url(self, url, include_detail=False):
         # type: (str, bool) -> SiteProperties
         """
+         Gets the site properties for the specified URL.
+
         :param str url: A string that represents the site URL.
         :param bool include_detail: A Boolean value that indicates whether to include all of the SPSite properties.
         """
@@ -798,15 +900,84 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return self
 
-    def send_email(self, site_url):
-        # type: (str) -> ClientResult[bool]
-        """ """
+    def export_unlicensed_one_drive_for_business_list_to_csv(self):
+        """Exports a list of OneDrive for Business sites that are associated with unlicensed users into a CSV file"""
+        return_type = ClientResult(self.context, str())
+        qry = ServiceOperationQuery(
+            self, "ExportUnlicensedOneDriveForBusinessListToCSV"
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def send_email(self, site_url, activity_event_json):
+        # type: (str, str) -> ClientResult[bool]
+        """Send Email"""
         return_type = ClientResult(self.context, bool())
-        payload = {"siteUrl": site_url}
+        payload = {"siteUrl": site_url, "activityEventJson": activity_event_json}
         qry = ServiceOperationQuery(self, "SendEmail", None, payload, None, return_type)
         self.context.add_query(qry)
         return return_type
 
+    def set_copilot_promo_optin_status(self, copilot_promo_optin_enabled):
+        # type: (bool) -> ClientResult[bool]
+        """ """
+        payload = {"copilotPromoOptInEnabled": copilot_promo_optin_enabled}
+        qry = ServiceOperationQuery(self, "SetCopilotPromoOptInStatus", None, payload)
+        self.context.add_query(qry)
+        return self
+
+    def set_default_view(self, view_id, list_name):
+        # type: (str, str) -> Self
+        """ """
+        payload = {"viewId": view_id, "listName": list_name}
+        qry = ServiceOperationQuery(self, "SetDefaultView", None, payload)
+        self.context.add_query(qry)
+        return self
+
+    def get_file_version_policy(self):
+        return_type = ClientResult(self.context, str())
+
+        def _get_file_version_policy():
+            return_type.set_property("__value", self.file_version_policy_xml)
+
+        self.ensure_property("FileVersionPolicyXml", _get_file_version_policy)
+        return return_type
+
+    def set_file_version_policy(
+        self, is_auto_trim_enabled, major_version_limit, expire_versions_after_days
+    ):
+        """
+        Automatically delete older versions of documents after a specified number of days.
+        Specify the maximum number of major versions to retain and the number of major versions
+        for which all minor versions will be kept.
+
+        :param bool is_auto_trim_enabled: If true, versions are trimmed automatically.
+        :param int major_version_limit: Retains only many major versions.
+        :param int expire_versions_after_days: Deletes versions older than this many days.
+        """
+        payload = {
+            "isAutoTrimEnabled": is_auto_trim_enabled,
+            "majorVersionLimit": major_version_limit,
+            "expireVersionsAfterDays": expire_versions_after_days,
+        }
+        qry = ServiceOperationQuery(self, "SetFileVersionPolicy", None, payload)
+        self.context.add_query(qry)
+        return self
+
+    def clear_file_version_policy(self):
+        self.set_property("FileVersionPolicyXml", "")
+        self.update()
+        return self
+
+    @property
+    def app_service_principal(self):
+        """ """
+        from office365.sharepoint.tenant.administration.internal.appservice.principal import (
+            SPOWebAppServicePrincipal,
+        )
+
+        return SPOWebAppServicePrincipal(self.context)
+
     @property
     def admin_settings(self):
         """Manage various tenant-level settings related to SharePoint administration"""
@@ -897,6 +1068,12 @@ class Tenant(Entity):
         """"""
         return self.properties.get("DefaultContentCenterSite", SiteInfoForSitePicker())
 
+    @property
+    def file_version_policy_xml(self):
+        # type: () -> Optional[str]
+        """ """
+        return self.properties.get("FileVersionPolicyXml", None)
+
     @property
     def information_barriers_suspension(self):
         # type: () -> Optional[bool]

office365/sharepoint/userprofiles/people_manager.py

@@ -148,14 +148,16 @@ class PeopleManager(Entity):
         return self
 
     def get_user_profile_properties(self, user_or_name):
+        # type: (str|User) -> ClientResult[dict]
         """
         Gets the specified user profile properties for the specified user.
 
         :param str or User user_or_name: User or Login name of the specified user.
         """
-        return_type = ClientResult(self.context)
+        return_type = ClientResult(self.context, {})
 
         def _user_resolved(account_name):
+            # type: (str) -> None
             params = {"accountName": account_name}
             qry = ServiceOperationQuery(
                 self, "GetUserProfileProperties", params, None, None, return_type

office365/sharepoint/utilities/utility.py

@@ -144,6 +144,22 @@ class Utility(Entity):
         context.add_query(qry)
         return utility
 
+    @staticmethod
+    def unmark_discussion_as_featured(context, list_id, topic_ids):
+        """
+        This method is a static method.
+        :type context: office365.sharepoint.client_context.ClientContext
+        :type list_id: str
+        :type topic_ids: str
+        """
+        utility = Utility(context)
+        payload = {"listID": list_id, "topicIDs": topic_ids}
+        qry = ServiceOperationQuery(
+            utility, "UnmarkDiscussionAsFeatured", None, payload, None, None, True
+        )
+        context.add_query(qry)
+        return utility
+
     @staticmethod
     def expand_groups_to_principals(context, inputs, max_count=None, return_type=None):
         """

office365/sharepoint/webparts/definition.py

@@ -8,6 +8,17 @@ class WebPartDefinition(Entity):
     """Represents a Web Part on a Web Part Page. Provides operations for moving, deleting, and changing the state of
     the Web Part."""
 
+    def close_web_part(self):
+        """
+        Closes the Web Part. If the Web Part is already closed, this method does nothing.
+
+        If the current user does not have permissions to modify the Web Part,
+        the server MUST ignore the call to this method.
+        """
+        qry = ServiceOperationQuery(self, "CloseWebPart")
+        self.context.add_query(qry)
+        return self
+
     def delete_web_part(self):
         """
         Deletes the Web Part from the page.
@@ -18,6 +29,21 @@ class WebPartDefinition(Entity):
         self.context.add_query(qry)
         return self
 
+    def save_web_part_changes(self):
+        """
+        Saves changes to the Web Part made by using other properties and methods on the WebPartDefinition object (1).
+
+        If the current user does not have permissions to modify the Web Part,
+        the protocol server MUST ignore the call to this method.
+        """
+        qry = ServiceOperationQuery(self, "SaveWebPartChanges")
+        self.context.add_query(qry)
+        return self
+
+    @property
+    def id(self):
+        return self.properties.get("Id", None)
+
     @property
     def web_part(self):
         """The WebPart object, as specified in section 3.2.5.148, associated with this WebPartDefinition.

office365/sharepoint/webparts/limited_manager.py

@@ -1,5 +1,8 @@
+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
+from office365.sharepoint.webparts.definition import WebPartDefinition
 from office365.sharepoint.webparts.definition_collection import (
     WebPartDefinitionCollection,
 )
@@ -9,6 +12,56 @@ class LimitedWebPartManager(Entity):
     """Provides operations to access and modify the existing Web Parts on a Web Part Page, and add new ones
     to the Web Part Page."""
 
+    def export_web_part(self, web_part):
+        # type: (str or WebPartDefinition) -> ClientResult[str]
+        """Exports the specified Web Part, given its ID.
+        :param str or WebPartDefinition web_part: The WebPartDefinition or  Id of the Web Part to export.
+        """
+        return_type = ClientResult(self.context, str())
+        self.web_parts.add_child(return_type)
+
+        def _export_web_part(web_part_id):
+            # type: (str) -> None
+            params = {"webPartId": web_part_id}
+            qry = ServiceOperationQuery(
+                self, "ExportWebPart", params, None, None, return_type
+            )
+            self.context.add_query(qry)
+
+        if isinstance(web_part, WebPartDefinition):
+
+            def _web_part_loaded():
+                _export_web_part(web_part.id)
+
+            web_part.ensure_property("Id", _web_part_loaded)
+        else:
+            _export_web_part(web_part)
+
+        return return_type
+
+    def import_web_part(self, web_part_xml):
+        """
+        Imports a Web Part from a string in the .dwp format as specified in [MS-WPPS] section 2.2.4.2,
+        or the .webpart format as specified in [MS-WPPS] section 2.2.3.1.
+        After importing, the Web Part is not added to a Web Part Page. To add a Web Part to a Web Part Page,
+        use AddWebPart, supplying the object (1) returned by this method.
+        A reference to the added SP.WebParts.WebPartDefinition is returned.
+
+        When Scope is User, the current user MUST have permissions to add and delete personalized Web Parts.
+        When Scope is Shared, the current user MUST have permissions to customize pages.
+
+        :param str web_part_xml: The Web Part markup to import.
+        """
+        return_type = WebPartDefinition(self.context)
+        self.web_parts.add_child(return_type)
+        payload = {"webPartXml": web_part_xml}
+        qry = ServiceOperationQuery(
+            self, "ImportWebPart", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    @property
     def web_parts(self):
         """A collection of the Web Parts on the Web Part Page available to the current user based
         on the current user’s permissions."""

office365/sharepoint/webparts/webpart.py

@@ -9,6 +9,53 @@ class WebPart(Entity):
     It has a standard property schema and displays that content in a cohesive unit on a webpage. See also Web Parts Page
     """
 
+    def __str__(self):
+        return self.title or self.entity_type_name
+
+    @property
+    def export_mode(self):
+        # type: () -> Optional[int]
+        """
+        Gets or sets the export mode of a Web Part.
+        """
+        return self.properties.get("ExportMode", None)
+
+    @property
+    def hidden(self):
+        # type: () -> Optional[bool]
+        """
+        Specifies whether a Web Part is displayed on a Web Part Page.
+
+        If "true", the Web Part MUST be hidden. Web Parts that are hidden MUST NOT be displayed on the page to
+        the end user, but SHOULD still participate normally in the rendering of the page. The default value is "false".
+        """
+        return self.properties.get("Hidden", None)
+
+    @property
+    def title(self):
+        # type: () -> Optional[str]
+        """
+        Specifies the title of a Web Part.
+
+        If this property is set to NULL, the title of the Web Part MUST instead be reset to its default value if one
+        is specified in the Web Part's definition.
+        """
+        return self.properties.get("Title", None)
+
+    @property
+    def title_url(self):
+        # type: () -> Optional[str]
+        """
+        Specifies a URL to the supplemental information about a Web Part.
+
+        If this property is set to NULL, the title URL of the Web Part MUST instead be reset to its default value
+        if one is specified in the Web Part's definition.
+
+         The value of this property SHOULD be a valid URL, but the protocol server MAY accept other strings
+         without validating them.
+        """
+        return self.properties.get("TitleUrl", None)
+
     @property
     def zone_index(self):
         # type: () -> Optional[int]