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

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

@@ -1,6 +1,27 @@
+from __future__ import annotations
+
 from typing import Optional
+from uuid import UUID
+
+from typing_extensions import Self
 
+from office365.runtime.client_result import ClientResult
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.runtime.queries.function import FunctionQuery
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.runtime.types.collections import StringCollection
+from office365.sharepoint.publishing.amplify.clientamplifyanywhereresults import ClientAmplifyAnywhereResults
+from office365.sharepoint.publishing.amplify.clientamplifyresults import ClientAmplifyResults
+from office365.sharepoint.publishing.amplify.history import AmplifyPublishingHistory
+from office365.sharepoint.publishing.amplify.requestparams import AmplifyRequestParams
+from office365.sharepoint.publishing.boostfieldsdata import BoostFieldsData
+from office365.sharepoint.publishing.pages.coauth_state import SitePageCoAuthState
+from office365.sharepoint.publishing.pages.dependency_metadata import SitePageDependencyMetadata
 from office365.sharepoint.publishing.pages.page import SitePage
+from office365.sharepoint.publishing.pages.sendtestemailresponse import SendTestEmailResponse
+from office365.sharepoint.publishing.pages.sendtestteamsmessageresponse import SendTestTeamsMessageResponse
+from office365.sharepoint.publishing.pages.versioninfocollection import SitePageVersionInfoCollection
+from office365.sharepoint.publishing.sitepageauthoringmetadata import SitePageAuthoringMetadata
 
 
 class RepostPage(SitePage):
@@ -22,3 +43,316 @@ class RepostPage(SitePage):
     @property
     def entity_type_name(self):
         return "SP.Publishing.RepostPage"
+
+    @property
+    def original_source_list_id(self) -> Optional[UUID]:
+        """Gets the OriginalSourceListId property"""
+        return self.properties.get("OriginalSourceListId", None)
+
+    @property
+    def original_source_site_id(self) -> Optional[UUID]:
+        """Gets the OriginalSourceSiteId property"""
+        return self.properties.get("OriginalSourceSiteId", None)
+
+    @property
+    def original_source_web_id(self) -> Optional[UUID]:
+        """Gets the OriginalSourceWebId property"""
+        return self.properties.get("OriginalSourceWebId", None)
+
+    @property
+    def should_save_as_draft(self) -> Optional[bool]:
+        """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.
+
+        Args:
+            request (AmplifyRequestParams): request parameter
+        """
+        return_type = ClientResult(self.context, ClientAmplifyAnywhereResults())
+        qry = ServiceOperationQuery(self, "Amplify", None, {"request": request}, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def amplify_history(self) -> ClientResult[AmplifyPublishingHistory]:
+        """AmplifyHistory operation."""
+        return_type = ClientResult(self.context, AmplifyPublishingHistory())
+        qry = ServiceOperationQuery(self, "AmplifyHistory", None, {}, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def amplify_send_test_email_message(self, content_stream: bytes) -> ClientResult[ClientAmplifyResults]:
+        """AmplifySendTestEmailMessage operation.
+
+        Args:
+            content_stream (bytes): contentStream parameter
+        """
+        return_type = ClientResult(self.context, ClientAmplifyResults())
+        qry = ServiceOperationQuery(
+            self, "AmplifySendTestEmailMessage", None, {"contentStream": content_stream}, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def amplify_send_test_teams_message(
+        self, audience_id: str, group_id: UUID, transpile_content: str, channel_name: str, team_name: str
+    ) -> ClientResult[ClientAmplifyResults]:
+        """AmplifySendTestTeamsMessage operation.
+
+        Args:
+            audience_id (str): audienceId parameter
+            group_id (UUID): groupId parameter
+            transpile_content (str): transpileContent parameter
+            channel_name (str): channelName parameter
+            team_name (str): teamName parameter
+        """
+        return_type = ClientResult(self.context, ClientAmplifyResults())
+        qry = ServiceOperationQuery(
+            self,
+            "AmplifySendTestTeamsMessage",
+            None,
+            {
+                "audienceId": audience_id,
+                "groupId": group_id,
+                "transpileContent": transpile_content,
+                "channelName": channel_name,
+                "teamName": team_name,
+            },
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def boost_news(self, site_page_boost: BoostFieldsData) -> Self:
+        """BoostNews operation.
+
+        Args:
+            site_page_boost (BoostFieldsData): SitePageBoost parameter
+        """
+        qry = ServiceOperationQuery(self, "BoostNews", None, {"SitePageBoost": site_page_boost}, None, None)
+        self.context.add_query(qry)
+        return self
+
+    def check_out(self) -> ClientResult[bool]:
+        """CheckOut operation."""
+        return_type = ClientResult(self.context, bool())
+        qry = ServiceOperationQuery(self, "CheckOut", None, {}, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def demote_from_news(self) -> ClientResult[bool]:
+        """DemoteFromNews operation."""
+        return_type = ClientResult(self.context, bool())
+        qry = ServiceOperationQuery(self, "DemoteFromNews", None, {}, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def extend_session_co_auth(
+        self, authoring_metadata: SitePageAuthoringMetadata, connectivity_update_reason: int
+    ) -> ClientResult[SitePageCoAuthState]:
+        """ExtendSessionCoAuth operation.
+
+        Args:
+            authoring_metadata (SitePageAuthoringMetadata): authoringMetadata parameter
+            connectivity_update_reason (int): connectivityUpdateReason parameter
+        """
+        return_type = ClientResult(self.context, SitePageCoAuthState())
+        qry = ServiceOperationQuery(
+            self,
+            "ExtendSessionCoAuth",
+            None,
+            {"authoringMetadata": authoring_metadata, "connectivityUpdateReason": connectivity_update_reason},
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def get_dependency_metadata(self) -> ClientResult[ClientValueCollection[SitePageDependencyMetadata]]:
+        """GetDependencyMetadata operation."""
+        return_type = ClientResult(self.context, ClientValueCollection[SitePageDependencyMetadata]())
+        qry = FunctionQuery(self, "GetDependencyMetadata", [], return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def get_latest_versions_in_descending_order(
+        self, num_versions: int
+    ) -> ClientResult[ClientValueCollection[SitePageVersionInfoCollection]]:
+        """GetLatestVersionsInDescendingOrder operation.
+
+        Args:
+            num_versions (int): numVersions parameter
+        """
+        return_type = ClientResult(self.context, ClientValueCollection[SitePageVersionInfoCollection]())
+        qry = FunctionQuery(self, "GetLatestVersionsInDescendingOrder", [num_versions], return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def promote_to_news(self) -> ClientResult[bool]:
+        """PromoteToNews operation."""
+        return_type = ClientResult(self.context, bool())
+        qry = ServiceOperationQuery(self, "PromoteToNews", None, {}, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def publish(self) -> ClientResult[bool]:
+        """Publish operation."""
+        return_type = ClientResult(self.context, bool())
+        qry = ServiceOperationQuery(self, "Publish", None, {}, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def publish_co_auth(self, page_stream: bytes) -> ClientResult[SitePageCoAuthState]:
+        """PublishCoAuth operation.
+
+        Args:
+            page_stream (bytes): pageStream parameter
+        """
+        return_type = ClientResult(self.context, SitePageCoAuthState())
+        qry = ServiceOperationQuery(self, "PublishCoAuth", None, {"pageStream": page_stream}, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def restore_by_label(self, versionlabel: str) -> Self:
+        """RestoreByLabel operation.
+
+        Args:
+            versionlabel (str): versionlabel parameter
+        """
+        qry = ServiceOperationQuery(self, "RestoreByLabel", None, {"versionlabel": versionlabel}, None, None)
+        self.context.add_query(qry)
+        return self
+
+    def save_page_co_auth(self, page_stream: bytes) -> ClientResult[SitePageCoAuthState]:
+        """SavePageCoAuth operation.
+
+        Args:
+            page_stream (bytes): pageStream parameter
+        """
+        return_type = ClientResult(self.context, SitePageCoAuthState())
+        qry = ServiceOperationQuery(self, "SavePageCoAuth", None, {"pageStream": page_stream}, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def save_streams(self, content_stream: bytes, shared_lock_id: str, scenario: int) -> Self:
+        """SaveStreams operation.
+
+        Args:
+            content_stream (bytes): contentStream parameter
+            shared_lock_id (str): sharedLockId parameter
+            scenario (int): scenario parameter
+        """
+        qry = ServiceOperationQuery(
+            self,
+            "SaveStreams",
+            None,
+            {"contentStream": content_stream, "sharedLockId": shared_lock_id, "scenario": scenario},
+            None,
+            None,
+        )
+        self.context.add_query(qry)
+        return self
+
+    def send_test_email(
+        self, transpile_content: str, subject: str, sensitivity_label_id: str
+    ) -> ClientResult[SendTestEmailResponse]:
+        """SendTestEmail operation.
+
+        Args:
+            transpile_content (str): transpileContent parameter
+            subject (str): subject parameter
+            sensitivity_label_id (str): sensitivityLabelId parameter
+        """
+        return_type = ClientResult(self.context, SendTestEmailResponse())
+        qry = ServiceOperationQuery(
+            self,
+            "SendTestEmail",
+            None,
+            {"transpileContent": transpile_content, "subject": subject, "sensitivityLabelId": sensitivity_label_id},
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def send_test_email_stream(self, content_stream: bytes) -> ClientResult[SendTestEmailResponse]:
+        """SendTestEmailStream operation.
+
+        Args:
+            content_stream (bytes): contentStream parameter
+        """
+        return_type = ClientResult(self.context, SendTestEmailResponse())
+        qry = ServiceOperationQuery(
+            self, "SendTestEmailStream", None, {"contentStream": content_stream}, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def send_test_teams_message(
+        self, audience_id: str, transpile_content: str
+    ) -> ClientResult[SendTestTeamsMessageResponse]:
+        """SendTestTeamsMessage operation.
+
+        Args:
+            audience_id (str): audienceId parameter
+            transpile_content (str): transpileContent parameter
+        """
+        return_type = ClientResult(self.context, SendTestTeamsMessageResponse())
+        qry = ServiceOperationQuery(
+            self,
+            "SendTestTeamsMessage",
+            None,
+            {"audienceId": audience_id, "transpileContent": transpile_content},
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def share_page_preview_by_email(self, message: str, recipient_emails: list[str]) -> Self:
+        """SharePagePreviewByEmail operation.
+
+        Args:
+            message (str): message parameter
+            recipient_emails (list[str]): recipientEmails parameter
+        """
+        qry = ServiceOperationQuery(
+            self,
+            "SharePagePreviewByEmail",
+            None,
+            {"message": message, "recipientEmails": StringCollection(recipient_emails)},
+            None,
+            None,
+        )
+        self.context.add_query(qry)
+        return self
+
+    def start_exclusive_authoring(self) -> ClientResult[bool]:
+        """StartExclusiveAuthoring operation."""
+        return_type = ClientResult(self.context, bool())
+        qry = ServiceOperationQuery(self, "StartExclusiveAuthoring", None, {}, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def try_process_source_page_after_page_move_publish(self) -> ClientResult[bool]:
+        """TryProcessSourcePageAfterPageMovePublish operation."""
+        return_type = ClientResult(self.context, bool())
+        qry = ServiceOperationQuery(self, "TryProcessSourcePageAfterPageMovePublish", None, {}, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def try_process_source_page_before_page_move_publish(self) -> ClientResult[bool]:
+        """TryProcessSourcePageBeforePageMovePublish operation."""
+        return_type = ClientResult(self.context, bool())
+        qry = ServiceOperationQuery(self, "TryProcessSourcePageBeforePageMovePublish", None, {}, None, return_type)
+        self.context.add_query(qry)
+        return return_type

office365/sharepoint/publishing/pages/service.py

@@ -2,18 +2,22 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Optional
 
+from typing_extensions import Self
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.runtime.types.collections import StringCollection
+from office365.runtime.types.odata_property import odata
 from office365.sharepoint.administration.orgassets.org_assets import OrgAssets
-from office365.sharepoint.clientsidecomponent.query_result import (
-    SPClientSideComponentQueryResult,
-)
+from office365.sharepoint.clientsidecomponent.query_result import SPClientSideComponentQueryResult
 from office365.sharepoint.entity import Entity
+from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.files.file import File
+from office365.sharepoint.publishing.campaign.campaign import Campaign
 from office365.sharepoint.publishing.file_picker_options import FilePickerOptions
+from office365.sharepoint.publishing.gettyimage import GettyImage
 from office365.sharepoint.publishing.pages.collection import SitePageCollection
 from office365.sharepoint.publishing.pages.page import SitePage
 from office365.sharepoint.publishing.primary_city_time import PrimaryCityTime
@@ -35,23 +39,33 @@ class SitePageService(Entity):
     @property
     def pages(self) -> SitePageCollection:
         """Gets the SitePageCollection for the current web."""
-        return self.properties.get(
-            "pages",
-            SitePageCollection(self.context, ResourcePath("pages", self.resource_path)),
-        )
+        return self.properties.get("pages", SitePageCollection(self.context, ResourcePath("pages", self.resource_path)))
 
+    @odata(name="CommunicationSite")
     @property
     def communication_site(self) -> CommunicationSite:
         """Gets a CommunicationSite for the current web."""
         return self.properties.get(
-            "CommunicationSite",
-            CommunicationSite(self.context, ResourcePath("CommunicationSite", self.resource_path)),
+            "CommunicationSite", CommunicationSite(self.context, ResourcePath("CommunicationSite", self.resource_path))
         )
 
     @property
     def entity_type_name(self):
         return "SP.Publishing.SitePageService"
 
+    @property
+    def custom_content_approval_enabled(self) -> Optional[bool]:
+        """Gets the CustomContentApprovalEnabled property"""
+        return self.properties.get("CustomContentApprovalEnabled", None)
+
+    @property
+    def campaigns(self) -> EntityCollection[Campaign]:
+        """Gets the Campaigns property"""
+        return self.properties.get(
+            "Campaigns",
+            EntityCollection[Campaign](self.context, Campaign, ResourcePath("Campaigns", self.resource_path)),
+        )
+
     def create_page(self, title: str, language: Optional[str] = None) -> SitePage:
         """Create a new sitePage in the site pages list in a site.
 
@@ -134,7 +148,7 @@ class SitePageService(Entity):
         context (office365.sharepoint.client_context.ClientContext): Client context
         title (str): The title of the page.
         """
-        return_type = ClientResult(context)
+        return_type = ClientResult[str](context)
         binding_type = SitePageService(context)
         params = {"title": title}
         qry = ServiceOperationQuery(binding_type, "ComputeFileName", params, None, None, return_type, True)
@@ -146,31 +160,17 @@ class SitePageService(Entity):
         return_type = ClientResult(context, ClientValueCollection(SPClientSideComponentQueryResult))
         params = {"includeErrors": include_errors, "project": project}
         qry = ServiceOperationQuery(
-            SitePageService(context),
-            "GetAvailableFullPageApplications",
-            None,
-            params,
-            None,
-            return_type,
-            True,
+            SitePageService(context), "GetAvailableFullPageApplications", None, params, None, return_type, True
         )
         context.add_query(qry)
         return return_type
 
     @staticmethod
-    def is_file_picker_external_image_search_enabled(
-        context: ClientContext,
-    ) -> ClientResult[bool]:
-        return_type = ClientResult(context)
+    def is_file_picker_external_image_search_enabled(context: ClientContext) -> ClientResult[bool]:
+        return_type = ClientResult[bool](context)
         binding_type = SitePageService(context)
         qry = ServiceOperationQuery(
-            binding_type,
-            "IsFilePickerExternalImageSearchEnabled",
-            None,
-            None,
-            None,
-            return_type,
-            True,
+            binding_type, "IsFilePickerExternalImageSearchEnabled", None, None, None, return_type, True
         )
         context.add_query(qry)
         return return_type
@@ -184,9 +184,7 @@ class SitePageService(Entity):
         return return_type
 
     @staticmethod
-    def file_picker_tab_options(
-        context: ClientContext,
-    ) -> ClientResult[FilePickerOptions]:
+    def file_picker_tab_options(context: ClientContext) -> ClientResult[FilePickerOptions]:
         return_type = ClientResult(context, FilePickerOptions())
         svc = SitePageService(context)
         qry = ServiceOperationQuery(svc, "FilePickerTabOptions", None, None, None, return_type, True)
@@ -205,11 +203,7 @@ class SitePageService(Entity):
             File
         """
         return_type = File(self.context)
-        params = {
-            "pageName": page_name,
-            "imageFileName": image_file_name,
-            "imageStream": image_stream,
-        }
+        params = {"pageName": page_name, "imageFileName": image_file_name, "imageStream": image_stream}
         qry = ServiceOperationQuery(self, "AddImage", params, None, None, return_type, True)
         self.context.add_query(qry)
         return return_type
@@ -238,10 +232,68 @@ class SitePageService(Entity):
         self.context.add_query(qry)
         return return_type
 
-    def get_property(self, name, default_value=None):
-        if default_value is None:
-            property_mapping = {
-                "CommunicationSite": self.communication_site,
-            }
-            default_value = property_mapping.get(name, None)
-        return super().get_property(name, default_value)
+    def enable_amplify_from_anywhere(self) -> Self:
+        """EnableAmplifyFromAnywhere operation."""
+        qry = ServiceOperationQuery(self, "EnableAmplifyFromAnywhere", None, {}, None, None)
+        self.context.add_query(qry)
+        return self
+
+    def enable_announcements(self) -> Self:
+        """EnableAnnouncements operation."""
+        qry = ServiceOperationQuery(self, "EnableAnnouncements", None, {}, None, None)
+        self.context.add_query(qry)
+        return self
+
+    def enable_categories(self) -> Self:
+        """EnableCategories operation."""
+        qry = ServiceOperationQuery(self, "EnableCategories", None, {}, None, None)
+        self.context.add_query(qry)
+        return self
+
+    def enable_lightweight_campaign(self) -> Self:
+        """EnableLightweightCampaign operation."""
+        qry = ServiceOperationQuery(self, "EnableLightweightCampaign", None, {}, None, None)
+        self.context.add_query(qry)
+        return self
+
+    def get_or_create_asset_folder(
+        self, page_name: str, create_folder_if_needed: bool, sub_folder_name: str, page_id: int
+    ) -> ClientResult[str]:
+        """GetOrCreateAssetFolder operation.
+
+        Args:
+            page_name (str): pageName parameter
+            create_folder_if_needed (bool): createFolderIfNeeded parameter
+            sub_folder_name (str): subFolderName parameter
+            page_id (int): pageId parameter
+        """
+        return_type = ClientResult(self.context, str())
+        qry = ServiceOperationQuery(
+            self,
+            "GetOrCreateAssetFolder",
+            None,
+            {
+                "pageName": page_name,
+                "createFolderIfNeeded": create_folder_if_needed,
+                "subFolderName": sub_folder_name,
+                "pageId": page_id,
+            },
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def report_getty_images(self, images: ClientValueCollection[GettyImage], is_timer_job: bool) -> ClientResult[bool]:
+        """ReportGettyImages operation.
+
+        Args:
+            images (ClientValueCollection[GettyImage]): images parameter
+            is_timer_job (bool): isTimerJob parameter
+        """
+        return_type = ClientResult(self.context, bool())
+        qry = ServiceOperationQuery(
+            self, "ReportGettyImages", None, {"images": images, "isTimerJob": is_timer_job}, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type