Office365-REST-Python-Client 3.1.0__py3-none-any.whl → 3.2.0__py3-none-any.whl

office365/sharepoint/publishing/pages/page.py

@@ -51,12 +51,6 @@ class SitePage(SitePageMetadata):
         self.context.add_query(qry)
         return self
 
-    def ensure_title_resource(self) -> Self:
-        """"""
-        qry = ServiceOperationQuery(self, "EnsureTitleResource")
-        self.context.add_query(qry)
-        return self
-
     def get_dependency_metadata(self) -> ClientResult[ClientValueCollection[SitePageDependencyMetadata]]:
         """ """
         return_type = ClientResult(self.context, ClientValueCollection(SitePageDependencyMetadata))
@@ -357,117 +351,6 @@ class SitePage(SitePageMetadata):
         """Gets the TemplateScope property"""
         return self.properties.get("TemplateScope", None)
 
-    def create_app_page(self, web_part_data_as_json: str) -> ClientResult[str]:
-        """CreateAppPage operation.
-
-        Args:
-            web_part_data_as_json (str): webPartDataAsJson parameter
-        """
-        return_type = ClientResult(self.context, str())
-        qry = ServiceOperationQuery(
-            self, "CreateAppPage", None, {"webPartDataAsJson": web_part_data_as_json}, None, return_type
-        )
-        self.context.add_query(qry)
-        return return_type
-
-    def get_page_column_state(self, url: str) -> ClientResult[int]:
-        """GetPageColumnState operation.
-
-        Args:
-            url (str): url parameter
-        """
-        return_type = ClientResult(self.context, int())
-        qry = FunctionQuery(self, "GetPageColumnState", [url], return_type)
-        self.context.add_query(qry)
-        return return_type
-
-    def is_site_page(self, url: str) -> ClientResult[bool]:
-        """IsSitePage operation.
-
-        Args:
-            url (str): url parameter
-        """
-        return_type = ClientResult(self.context, bool())
-        qry = FunctionQuery(self, "IsSitePage", [url], return_type)
-        self.context.add_query(qry)
-        return return_type
-
-    def set_html_pages_feature(self, enabled: bool) -> Self:
-        """SetHtmlPagesFeature operation.
-
-        Args:
-            enabled (bool): enabled parameter
-        """
-        qry = ServiceOperationQuery(self, "SetHtmlPagesFeature", None, {"enabled": enabled}, None, None)
-        self.context.add_query(qry)
-        return self
-
-    def set_multilingual(self, enabled: bool) -> Self:
-        """SetMultilingual operation.
-
-        Args:
-            enabled (bool): enabled parameter
-        """
-        qry = ServiceOperationQuery(self, "SetMultilingual", None, {"enabled": enabled}, None, None)
-        self.context.add_query(qry)
-        return self
-
-    def set_scheduling(self, enabled: bool) -> Self:
-        """SetScheduling operation.
-
-        Args:
-            enabled (bool): enabled parameter
-        """
-        qry = ServiceOperationQuery(self, "SetScheduling", None, {"enabled": enabled}, None, None)
-        self.context.add_query(qry)
-        return self
-
-    def update_app_page(
-        self, page_id: int, web_part_data_as_json: str, title: str, include_in_navigation: bool
-    ) -> ClientResult[str]:
-        """UpdateAppPage operation.
-
-        Args:
-            page_id (int): pageId parameter
-            web_part_data_as_json (str): webPartDataAsJson parameter
-            title (str): title parameter
-            include_in_navigation (bool): includeInNavigation parameter
-        """
-        return_type = ClientResult(self.context, str())
-        qry = ServiceOperationQuery(
-            self,
-            "UpdateAppPage",
-            None,
-            {
-                "pageId": page_id,
-                "webPartDataAsJson": web_part_data_as_json,
-                "title": title,
-                "includeInNavigation": include_in_navigation,
-            },
-            None,
-            return_type,
-        )
-        self.context.add_query(qry)
-        return return_type
-
-    def update_full_page_app(self, server_relative_url: str, web_part_data_as_json: str) -> Self:
-        """UpdateFullPageApp operation.
-
-        Args:
-            server_relative_url (str): serverRelativeUrl parameter
-            web_part_data_as_json (str): webPartDataAsJson parameter
-        """
-        qry = ServiceOperationQuery(
-            self,
-            "UpdateFullPageApp",
-            None,
-            {"serverRelativeUrl": server_relative_url, "webPartDataAsJson": web_part_data_as_json},
-            None,
-            None,
-        )
-        self.context.add_query(qry)
-        return self
-
     def amplify(self, request: AmplifyRequestParams) -> ClientResult[ClientAmplifyAnywhereResults]:
         """Amplify operation.
 

office365/sharepoint/publishing/pages/reposts/repost.py

@@ -64,13 +64,6 @@ class RepostPage(SitePage):
         """Gets the ShouldSaveAsDraft property"""
         return self.properties.get("ShouldSaveAsDraft", None)
 
-    def is_content_type_available(self) -> ClientResult[bool]:
-        """IsContentTypeAvailable operation."""
-        return_type = ClientResult(self.context, bool())
-        qry = FunctionQuery(self, "IsContentTypeAvailable", [], return_type)
-        self.context.add_query(qry)
-        return return_type
-
     def amplify(self, request: AmplifyRequestParams) -> ClientResult[ClientAmplifyAnywhereResults]:
         """Amplify operation.
 

office365/sharepoint/publishing/pages/topics/topic.py

@@ -47,13 +47,6 @@ class TopicSitePage(SitePage):
     def entity_type_name(self):
         return "SP.Publishing.TopicSitePage"
 
-    def is_content_type_available(self) -> ClientResult[bool]:
-        """IsContentTypeAvailable operation."""
-        return_type = ClientResult(self.context, bool())
-        qry = FunctionQuery(self, "IsContentTypeAvailable", [], return_type)
-        self.context.add_query(qry)
-        return return_type
-
     def amplify(self, request: AmplifyRequestParams) -> ClientResult[ClientAmplifyAnywhereResults]:
         """Amplify operation.
 

office365/sharepoint/publishing/subtitlefile.py

@@ -1,10 +1,5 @@
 from typing import Optional
 
-from typing_extensions import Self
-
-from office365.runtime.client_result import ClientResult
-from office365.runtime.queries.function import FunctionQuery
-from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
 
@@ -27,38 +22,3 @@ class SubtitleFile(Entity):
     @property
     def entity_type_name(self):
         return "SP.Publishing.SubtitleFile"
-
-    def add(self, language: str, extension: str, stream: bytes) -> Self:
-        """Add operation.
-
-        Args:
-            language (str): language parameter
-            extension (str): extension parameter
-            stream (bytes): stream parameter
-        """
-        qry = ServiceOperationQuery(
-            self, "Add", None, {"language": language, "extension": extension, "stream": stream}, None, None
-        )
-        self.context.add_query(qry)
-        return self
-
-    def get_subtitle_file(self, name: str) -> ClientResult[bytes]:
-        """GetSubtitleFile operation.
-
-        Args:
-            name (str): name parameter
-        """
-        return_type = ClientResult(self.context, bytes())
-        qry = FunctionQuery(self, "GetSubtitleFile", [name], return_type, return_raw_content=True)
-        self.context.add_query(qry)
-        return return_type
-
-    def remove(self, name: str) -> Self:
-        """Remove operation.
-
-        Args:
-            name (str): name parameter
-        """
-        qry = ServiceOperationQuery(self, "Remove", None, {"name": name}, None, None)
-        self.context.add_query(qry)
-        return self

office365/sharepoint/quotamanagement/consumer/consumer_quota_info_api.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.function import FunctionQuery
+from office365.sharepoint.entity import Entity
+
+
+class ConsumerQuotaInfoApi(Entity):
+    def get_quota_info(self) -> ClientResult[str]:
+        """GetQuotaInfo operation."""
+        return_type = ClientResult(self.context, str())
+        qry = FunctionQuery(self, "GetQuotaInfo", [], return_type)
+        self.context.add_query(qry)
+        return return_type

office365/sharepoint/quotamanagement/consumer/non_quota_backfill_api.py

@@ -1,3 +1,8 @@
+from __future__ import annotations
+
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.runtime.types.collections import StringCollection
 from office365.sharepoint.entity import Entity
 
 
@@ -5,3 +10,21 @@ class NonQuotaBackfillApi(Entity):
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.QuotaManagement.Consumer.NonQuotaBackfillApi"
+
+    def backfill_non_quota(self, backfill_userfacts: list[str]) -> ClientResult[str]:
+        """BackfillNonQuota operation.
+
+        Args:
+            backfill_userfacts (list[str]): backfillUserfacts parameter
+        """
+        return_type = ClientResult(self.context, str())
+        qry = ServiceOperationQuery(
+            self,
+            "BackfillNonQuota",
+            None,
+            {"backfillUserfacts": StringCollection(backfill_userfacts)},
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type

office365/sharepoint/quotamanagement/consumer/nonquotamigrationapi.py

@@ -1,3 +1,5 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
 
@@ -5,3 +7,10 @@ class NonQuotaMigrationApi(Entity):
     @property
     def entity_type_name(self) -> str:
         return "Microsoft.SharePoint.QuotaManagement.Consumer.NonQuotaMigrationApi"
+
+    def migrate_non_quota(self) -> ClientResult[str]:
+        """MigrateNonQuota operation."""
+        return_type = ClientResult(self.context, str())
+        qry = ServiceOperationQuery(self, "MigrateNonQuota", None, {}, None, return_type)
+        self.context.add_query(qry)
+        return return_type

office365/sharepoint/quotamanagement/consumer/quotamigrationapi.py

@@ -1,3 +1,5 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
 
@@ -5,3 +7,14 @@ class QuotaMigrationApi(Entity):
     @property
     def entity_type_name(self) -> str:
         return "Microsoft.SharePoint.QuotaManagement.Consumer.QuotaMigrationApi"
+
+    def migrate_quota(self, is_max_quota_call: bool) -> ClientResult[str]:
+        """MigrateQuota operation.
+
+        Args:
+            is_max_quota_call (bool): IsMaxQuotaCall parameter
+        """
+        return_type = ClientResult(self.context, str())
+        qry = ServiceOperationQuery(self, "MigrateQuota", None, {"IsMaxQuotaCall": is_max_quota_call}, None, return_type)
+        self.context.add_query(qry)
+        return return_type

office365/sharepoint/request.py

@@ -20,6 +20,7 @@ from office365.runtime.odata.v3.json_light_format import JsonLightFormat
 from office365.runtime.queries.client_query import ClientQuery
 from office365.runtime.queries.delete_entity import DeleteEntityQuery
 from office365.runtime.queries.update_entity import UpdateEntityQuery
+from office365.sharepoint.exceptions import SecurityValidationException
 from office365.sharepoint.webs.context_web_information import ContextWebInformation
 
 
@@ -70,7 +71,14 @@ class SharePointRequest(ODataRequest):
 
     def _authenticate_request(self, request: RequestOptions) -> None:
         """Authenticate the request, resolving the auth context lazily so it can be
-        swapped via :meth:`reuse`."""
+        swapped via :meth:`reuse`.
+
+        A transport carrying its own handler (``session.auth``, e.g. ``HttpNtlmAuth``)
+        signs the request itself. Such a session counts as credentials when no
+        provider is configured on the auth context.
+        """
+        if not self._auth_context.is_configured and self._transport.auth is not None:
+            return
         self._auth_context.authenticate_request(request)
 
     def set_base_url(self, url: str) -> Self:
@@ -102,28 +110,61 @@ class SharePointRequest(ODataRequest):
                 request.ensure_header("IF-MATCH", "*")
         return request
 
-    def _get_context_web_information(self):
-        """Returns a ContextWebInformation object that specifies metadata about the site."""
-        client = ODataRequest(self._base_url, JsonLightFormat())
-        client._transport = self._transport
-        client.beforeExecute += self._auth_context.authenticate_request
-        request = RequestOptions(f"{self.service_root_url}/contextInfo")
-        request.method = HttpMethod.Post
-        response = client.execute_request_direct(request)
-        json_format = JsonLightFormat()
-        json_format.function = "GetContextWebInformation"
-        return_value = ContextWebInformation()
-        client.map_json(response.json(), return_value, json_format)
-        return return_value
+    def _fetch_context_web_information(self) -> ContextWebInformation:
+        """Fetches the form digest (``/_api/contextInfo``), retrying throttling.
 
-    def ensure_form_digest(self, request: RequestOptions) -> None:
+        A throttled digest refresh would otherwise abort the whole run; retry
+        transient failures honoring the server's ``Retry-After``.
+        """
+        from office365.runtime.retry import response_retry_after, retry
+
+        def _attempt() -> ContextWebInformation:
+            client = ODataRequest(self._base_url, JsonLightFormat())
+            client._transport = self._transport
+            client.beforeExecute += self._authenticate_request
+            request = RequestOptions(f"{self.service_root_url}/contextInfo")
+            request.method = HttpMethod.Post
+            response = client.execute_request_direct(request)
+            json_format = JsonLightFormat()
+            json_format.function = "GetContextWebInformation"
+            return_value = ContextWebInformation()
+            client.map_json(response.json(), return_value, json_format)
+            return return_value
+
+        return retry(
+            _attempt,
+            on_failure=lambda _attempt_num, ex: response_retry_after(getattr(ex, "response", None)),
+        )
+
+    def _ensure_digest(self) -> None:
+        """Single-flight fetch of a valid form digest."""
         if not self.context_info.is_valid:
             with self._digest_lock:
                 if not self.context_info.is_valid:
-                    self._ctx_web_info = self._get_context_web_information()
+                    self._ctx_web_info = self._fetch_context_web_information()
+
+    def warm_up(self) -> None:
+        """Fetch the form digest once (e.g. before dispatching parallel batches)."""
+        self._ensure_digest()
+
+    def invalidate_digest(self) -> None:
+        """Drop the cached digest so the next request re-fetches it."""
+        with self._digest_lock:
+            self._ctx_web_info = None
+
+    def ensure_form_digest(self, request: RequestOptions) -> None:
+        self._ensure_digest()
         assert self._ctx_web_info is not None
         request.set_header("X-RequestDigest", self._ctx_web_info.FormDigestValue)
 
+    def execute_request_direct(self, request: RequestOptions) -> Response:
+        """Send a request, recovering once from an expired/invalidated form digest."""
+        try:
+            return super().execute_request_direct(request)
+        except SecurityValidationException:
+            self.invalidate_digest()
+            return super().execute_request_direct(request)
+
     @property
     def context_info(self) -> ContextWebInformation:
         """Returns a ContextWebInformation object that specifies metadata about the site."""

office365/sharepoint/search/administration/document_crawl_log.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from datetime import datetime
 from typing import TYPE_CHECKING, Optional
 
 from office365.runtime.client_result import ClientResult
@@ -28,13 +29,7 @@ class DocumentCrawlLog(Entity):
         context.add_query(qry)
         return return_type
 
-    def get_crawled_urls(
-        self,
-        get_count_only=False,
-        max_rows=None,
-        query_string=None,
-        content_source_id=None,
-    ):
+    def get_crawled_urls(self, get_count_only=False, max_rows=None, query_string=None, content_source_id=None):
         """Retrieves information about all the contents that were crawled.
 
         Args:
@@ -70,3 +65,25 @@ class DocumentCrawlLog(Entity):
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Client.Search.Administration.DocumentCrawlLog"
+
+    def get_unsuccesful_crawled_urls_for_ediscovery(
+        self, display_url: str, start_date_time: datetime, end_date_time: datetime
+    ) -> ClientResult[SimpleDataTable]:
+        """GetUnsuccesfulCrawledUrlsForEdiscovery operation.
+
+        Args:
+            display_url (str): displayUrl parameter
+            start_date_time (datetime): startDateTime parameter
+            end_date_time (datetime): endDateTime parameter
+        """
+        return_type = ClientResult(self.context, SimpleDataTable())
+        qry = ServiceOperationQuery(
+            self,
+            "GetUnsuccesfulCrawledUrlsForEdiscovery",
+            None,
+            {"displayUrl": display_url, "startDateTime": start_date_time, "endDateTime": end_date_time},
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type

office365/sharepoint/search/administration/providers/crawl_versions_info.py

@@ -57,3 +57,32 @@ class TenantCrawlVersionsInfoProvider(Entity):
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Client.Search.Administration.TenantCrawlVersionsInfoProvider"
+
+    def enable_crawl_versions(self, site_id: str) -> ClientResult[bool]:
+        """EnableCrawlVersions operation.
+
+        Args:
+            site_id (UUID): siteId parameter
+        """
+        return_type = ClientResult(self.context, bool())
+        qry = ServiceOperationQuery(self, "EnableCrawlVersions", None, {"siteId": site_id}, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def enable_crawl_versions_for_tenant(self) -> ClientResult[bool]:
+        """EnableCrawlVersionsForTenant operation."""
+        return_type = ClientResult(self.context, bool())
+        qry = ServiceOperationQuery(self, "EnableCrawlVersionsForTenant", None, {}, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def get_site_crawl_version_status(self, site_id: str) -> ClientResult[dict]:
+        """GetSiteCrawlVersionStatus operation.
+
+        Args:
+            site_id (UUID): siteId parameter
+        """
+        return_type = ClientResult(self.context, dict())
+        qry = ServiceOperationQuery(self, "GetSiteCrawlVersionStatus", None, {"siteId": site_id}, None, return_type)
+        self.context.add_query(qry)
+        return return_type

office365/sharepoint/search/administration/providers/recycle_bin_info.py

@@ -1,3 +1,5 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
 
@@ -7,3 +9,24 @@ class TenantRecycleBinInfoProvider(Entity):
     @property
     def entity_type_name(self) -> str:
         return "Microsoft.SharePoint.Client.Search.Administration.TenantRecycleBinInfoProvider"
+
+    def disable_recycle_bin_discoverability_for_tenant(self) -> ClientResult[bool]:
+        """DisableRecycleBinDiscoverabilityForTenant operation."""
+        return_type = ClientResult(self.context, bool())
+        qry = ServiceOperationQuery(self, "DisableRecycleBinDiscoverabilityForTenant", None, {}, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def enable_recycle_bin_discoverability_for_tenant(self) -> ClientResult[bool]:
+        """EnableRecycleBinDiscoverabilityForTenant operation."""
+        return_type = ClientResult(self.context, bool())
+        qry = ServiceOperationQuery(self, "EnableRecycleBinDiscoverabilityForTenant", None, {}, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def is_recycle_bin_discoverability_enabled_for_tenant(self) -> ClientResult[bool]:
+        """IsRecycleBinDiscoverabilityEnabledForTenant operation."""
+        return_type = ClientResult(self.context, bool())
+        qry = ServiceOperationQuery(self, "IsRecycleBinDiscoverabilityEnabledForTenant", None, {}, None, return_type)
+        self.context.add_query(qry)
+        return return_type

office365/sharepoint/search/administration/providers/site_content_processing_info.py

@@ -1,3 +1,7 @@
+from uuid import UUID
+
+from typing_extensions import Self
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
@@ -13,3 +17,66 @@ class SiteContentProcessingInfoProvider(Entity):
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Client.Search.Administration.SiteContentProcessingInfoProvider"
+
+    def notify_content_processing_status(self, web_id: str, list_id: str, unique_id: str, properties: dict) -> Self:
+        """NotifyContentProcessingStatus operation.
+
+        Args:
+            web_id (UUID): webId parameter
+            list_id (UUID): listId parameter
+            unique_id (UUID): uniqueId parameter
+            properties (dict): properties parameter
+        """
+        qry = ServiceOperationQuery(
+            self,
+            "NotifyContentProcessingStatus",
+            None,
+            {"webId": web_id, "listId": list_id, "uniqueId": unique_id, "properties": properties},
+            None,
+            None,
+        )
+        self.context.add_query(qry)
+        return self
+
+    def report_content_processing_status(
+        self,
+        web_id: UUID,
+        list_id: UUID,
+        unique_id: UUID,
+        azure_container_token_uri: str,
+        encryption_key: bytes,
+        priority: int,
+        error_code: int,
+        error_description: str,
+    ) -> Self:
+        """ReportContentProcessingStatus operation.
+
+        Args:
+            web_id (str): webId parameter
+            list_id (str): listId parameter
+            unique_id (str): uniqueId parameter
+            azure_container_token_uri (str): azureContainerTokenUri parameter
+            encryption_key (bytes): encryptionKey parameter
+            priority (int): priority parameter
+            error_code (int): errorCode parameter
+            error_description (str): errorDescription parameter
+        """
+        qry = ServiceOperationQuery(
+            self,
+            "ReportContentProcessingStatus",
+            None,
+            {
+                "webId": web_id,
+                "listId": list_id,
+                "uniqueId": unique_id,
+                "azureContainerTokenUri": azure_container_token_uri,
+                "encryptionKey": encryption_key,
+                "priority": priority,
+                "errorCode": error_code,
+                "errorDescription": error_description,
+            },
+            None,
+            None,
+        )
+        self.context.add_query(qry)
+        return self