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

office365/sharepoint/lists/list.py

@@ -13,6 +13,7 @@ from office365.sharepoint.changes.collection import ChangeCollection
 from office365.sharepoint.changes.log_item_query import ChangeLogItemQuery
 from office365.sharepoint.changes.query import ChangeQuery
 from office365.sharepoint.changes.token import ChangeToken
+from office365.sharepoint.compliance.tag import ComplianceTag
 from office365.sharepoint.contenttypes.collection import ContentTypeCollection
 from office365.sharepoint.customactions.element_collection import (
     CustomActionElementCollection,
@@ -174,6 +175,23 @@ class List(SecurableObject):
         self.context.add_query(qry)
         return return_type
 
+    def get_compliance_tag(self):
+        """ """
+        from office365.sharepoint.compliance.store_proxy import SPPolicyStoreProxy
+
+        return_type = ClientResult(self.context, ComplianceTag())
+        list_folder = self.root_folder
+
+        def _get_compliance_tag():
+            SPPolicyStoreProxy.get_list_compliance_tag(
+                self.context,
+                list_folder.serverRelativeUrl,
+                return_type=return_type,
+            )
+
+        list_folder.ensure_property("ServerRelativeUrl", _get_compliance_tag)
+        return return_type
+
     def get_metadata_navigation_settings(self):
         """Retrieves the configured metadata navigation settings for the list."""
         from office365.sharepoint.navigation.metadata_settings import (
@@ -407,7 +425,7 @@ class List(SecurableObject):
         :param ClientResult[dict] return_type: The return type.
         """
         if return_type is None:
-            return_type = ClientResult(context, dict())
+            return_type = ClientResult(context, {})
         payload = {
             "listFullUrl": list_full_url,
             "parameters": parameters,
@@ -433,7 +451,7 @@ class List(SecurableObject):
         :param ClientResult[dict] return_type: The return type.
         """
         if return_type is None:
-            return_type = ClientResult(context, dict())
+            return_type = ClientResult(context, {})
         payload = {
             "parameters": parameters,
         }
@@ -758,7 +776,7 @@ class List(SecurableObject):
         :param int render_options: Specifies the type of output to return.
         :param bool expand_groups: Specifies whether to expand the grouping or not.
         """
-        return_type = ClientResult(self.context, dict())
+        return_type = ClientResult(self.context, {})
         if view_xml is None:
             view_xml = "<View/>"
         payload = {
@@ -825,6 +843,22 @@ class List(SecurableObject):
         self.ensure_property("RootFolder", _loaded)
         return self
 
+    def set_exempt_from_block_download_of_non_viewable_files(self, value):
+        """
+        Method to set the ExemptFromBlockDownloadOfNonViewableFiles property.
+        Ensures that only a tenant administrator can set the exemption.
+        """
+        qry = ServiceOperationQuery(
+            self,
+            "SetExemptFromBlockDownloadOfNonViewableFiles",
+            [value],
+            None,
+            None,
+            None,
+        )
+        self.context.add_query(qry)
+        return self
+
     @property
     def id(self):
         # type: () -> Optional[str]

office365/sharepoint/migrationcenter/common/results/batch_creation.py

@@ -1,5 +1,29 @@
 from office365.runtime.client_value import ClientValue
+from office365.runtime.types.collections import StringCollection
 
 
 class BatchCreationResult(ClientValue):
     """"""
+
+    def __init__(
+        self,
+        created_count=None,
+        created_task_id_list=None,
+        error_code=None,
+        error_message=None,
+        field_error=None,
+        processing_milliseconds=None,
+        total_count=None,
+    ):
+        self.CreatedCount = created_count
+        self.CreatedTaskIdList = StringCollection(created_task_id_list)
+        self.ErrorCode = error_code
+        self.ErrorMessage = error_message
+        self.FieldError = field_error
+        self.ProcessingMilliseconds = processing_milliseconds
+        self.TotalCount = total_count
+
+    @property
+    def entity_type_name(self):
+        # type: () -> str
+        return "Microsoft.Online.SharePoint.MigrationCenter.Common.BatchCreationResult"

office365/sharepoint/migrationcenter/common/task.py

@@ -1,9 +1,17 @@
+from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.migrationcenter.common.task_entity_data import (
     MigrationTaskEntityData,
 )
 
 
 class MigrationTask(MigrationTaskEntityData):
+
+    def __init__(self, context):
+        static_path = ResourcePath(
+            "Microsoft.Online.SharePoint.MigrationCenter.Service.MigrationTask"
+        )
+        super(MigrationTask, self).__init__(context, static_path)
+
     @property
     def entity_type_name(self):
         return "Microsoft.Online.SharePoint.MigrationCenter.Service.MigrationTask"

office365/sharepoint/migrationcenter/common/task_definition.py

@@ -2,4 +2,10 @@ from office365.runtime.client_value import ClientValue
 
 
 class MigrationTaskDefinition(ClientValue):
-    pass
+
+    @property
+    def entity_type_name(self):
+        # type: () -> str
+        return (
+            "Microsoft.Online.SharePoint.MigrationCenter.Common.MigrationTaskDefinition"
+        )

office365/sharepoint/migrationcenter/common/teams/channel_resource.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.entity import Entity
+
+
+class ChannelResource(Entity):
+    """"""

office365/sharepoint/migrationcenter/common/teams/team_resource.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.entity import Entity
+
+
+class TeamResource(Entity):
+    """ """

office365/sharepoint/migrationcenter/common/url_parser.py

@@ -0,0 +1,39 @@
+from typing import TYPE_CHECKING
+
+from office365.runtime.paths.service_operation import ServiceOperationPath
+from office365.sharepoint.entity import Entity
+
+if TYPE_CHECKING:
+    from office365.sharepoint.client_context import ClientContext
+
+
+class MigrationUrlParser(Entity):
+    """"""
+
+    def __init__(
+        self,
+        context,
+        user_input_destination_url,
+        retrive_all_lists,
+        retrieve_all_lists_sub_folders,
+        force_my_site_default_list,
+        migration_type,
+        current_context_site_subscription_id,
+    ):
+        # type: (ClientContext, str, bool, bool, bool, str, str) -> None
+        static_path = ServiceOperationPath(
+            "SP.AppContextSite",
+            {
+                "userInputDestinationUrl": user_input_destination_url,
+                "retriveAllLists": retrive_all_lists,
+                "retrieveAllListsSubFolders": retrieve_all_lists_sub_folders,
+                "forceMySiteDefaultList": force_my_site_default_list,
+                "migrationType": migration_type,
+                "currentContextSiteSubscriptionId": current_context_site_subscription_id,
+            },
+        )
+        super(MigrationUrlParser, self).__init__(context, static_path)
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.MigrationCenter.Common.MigrationUrlParser"

office365/sharepoint/migrationcenter/service/services.py

@@ -3,6 +3,7 @@ from office365.sharepoint.entity import Entity
 from office365.sharepoint.migrationcenter.service.performance.data import (
     PerformanceDataCollection,
 )
+from office365.sharepoint.migrationcenter.service.teams import MigrationCenterTeams
 
 
 class MigrationCenterServices(Entity):
@@ -16,7 +17,7 @@ class MigrationCenterServices(Entity):
     @property
     def performance_data(self):
         # type: () -> PerformanceDataCollection
-        """Get root web"""
+        """"""
         return self.properties.get(
             "PerformanceData",
             PerformanceDataCollection(
@@ -24,6 +25,17 @@ class MigrationCenterServices(Entity):
             ),
         )
 
+    @property
+    def teams(self):
+        # type: () -> PerformanceDataCollection
+        """"""
+        return self.properties.get(
+            "Teams",
+            MigrationCenterTeams(
+                self.context, ResourcePath("Teams", self.resource_path)
+            ),
+        )
+
     @property
     def entity_type_name(self):
         return "Microsoft.Online.SharePoint.MigrationCenter.Service.MigrationCenterServices"

office365/sharepoint/migrationcenter/service/teams.py

@@ -0,0 +1,11 @@
+from office365.sharepoint.entity import Entity
+
+
+class MigrationCenterTeams(Entity):
+    """"""
+
+    @property
+    def entity_type_name(self):
+        return (
+            "Microsoft.Online.SharePoint.MigrationCenter.Service.MigrationCenterTeams"
+        )

office365/sharepoint/navigation/node.py

@@ -1,12 +1,9 @@
-from typing import TYPE_CHECKING, Optional
+from typing import Optional
 
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.translation.user_resource import UserResource
 
-if TYPE_CHECKING:
-    from office365.sharepoint.navigation.node_collection import NavigationNodeCollection
-
 
 class NavigationNode(Entity):
     """
@@ -22,8 +19,12 @@ class NavigationNode(Entity):
 
     @property
     def children(self):
-        # type: () -> NavigationNodeCollection
+        # type: () -> 'NavigationNodeCollection'
         """Gets the collection of child nodes of the navigation node."""
+        from office365.sharepoint.navigation.node_collection import (
+            NavigationNodeCollection,
+        )
+
         return self.properties.get(
             "Children",
             NavigationNodeCollection(
@@ -68,7 +69,7 @@ class NavigationNode(Entity):
 
     @property
     def parent_collection(self):
-        # type: () -> NavigationNodeCollection
+        # type: () -> 'NavigationNodeCollection'
         return self._parent_collection
 
     @property
@@ -86,13 +87,3 @@ class NavigationNode(Entity):
             property_mapping = {"TitleResource": self.title_resource}
             default_value = property_mapping.get(name, None)
         return super(NavigationNode, self).get_property(name, default_value)
-
-    def set_property(self, name, value, persist_changes=True):
-        super(NavigationNode, self).set_property(name, value, persist_changes)
-        # fallback: create a new resource path
-        if self._resource_path is None:
-            if name == "Id":
-                self._resource_path = self.parent_collection.get_by_id(
-                    value
-                ).resource_path
-        return self

office365/sharepoint/policy/license_utilities.py

@@ -18,6 +18,7 @@ class PolicyLicenseUtilities(Entity):
             None,
             None,
             return_type,
+            True,
         )
         context.add_query(qry)
         return return_type

office365/sharepoint/portal/groups/creation_context.py

@@ -2,6 +2,17 @@ from office365.runtime.client_value import ClientValue
 
 
 class GroupCreationContext(ClientValue):
+
+    def __init__(
+        self,
+        preferred_language=None,
+        sensitivity_label_policy_mandatory=None,
+        site_path=None,
+    ):
+        self.PreferredLanguage = preferred_language
+        self.SensitivityLabelPolicyMandatory = sensitivity_label_policy_mandatory
+        self.SitePath = site_path
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Portal.GroupCreationContext"

office365/sharepoint/portal/groups/service.py

@@ -26,7 +26,7 @@ class GroupService(Entity):
             request.url += "?id='{0}'&hash={1}".format(group_id, image_hash)
             request.method = HttpMethod.Get
 
-        self.context.add_query(qry).before_execute(_create_request)
+        self.context.add_query(qry).before_query_execute(_create_request)
         return return_type
 
     def sync_group_properties(self):

office365/sharepoint/portal/groups/site_manager.py

@@ -119,7 +119,7 @@ class GroupSiteManager(ClientObject):
             request.method = HttpMethod.Get
             request.url += "?groupId='{0}'".format(group_id)
 
-        self.context.add_query(qry).before_execute(_construct_request)
+        self.context.add_query(qry).before_query_execute(_construct_request)
         return return_type
 
     def get_current_user_joined_teams(

office365/sharepoint/publishing/pages/3d/types.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.publishing.pages.fields_data import SitePageFieldsData
+
+
+class SitePage3DFieldsData(SitePageFieldsData):
+    """ """

office365/sharepoint/publishing/pages/{campaign_publication.py → campaign/publication.py}

@@ -7,6 +7,8 @@ from office365.sharepoint.publishing.pages.page import SitePage
 
 
 class CampaignPublication(SitePage):
+    """ """
+
     def get_highlights_info(self):
         """ """
         return_type = HighlightsInfo(self.context)

office365/sharepoint/publishing/pages/campaign/types.py

@@ -0,0 +1,18 @@
+from office365.runtime.client_value import ClientValue
+from office365.sharepoint.publishing.pages.fields_data import SitePageFieldsData
+
+
+class CampaignPublicationMailDraftData(ClientValue):
+    """ """
+
+    @property
+    def entity_type_name(self):
+        return "SP.Publishing.CampaignPublicationMailDraftData"
+
+
+class CampaignPublicationFieldsData(SitePageFieldsData):
+    """ """
+
+    @property
+    def entity_type_name(self):
+        return "SP.Publishing.CampaignPublicationFieldsData"

office365/sharepoint/publishing/pages/coauth_state.py

@@ -3,6 +3,26 @@ from office365.runtime.client_value import ClientValue
 
 class SitePageCoAuthState(ClientValue):
 
+    def __init__(
+        self,
+        action=None,
+        has_reached_minor_versions_limit=None,
+        is_new_session=None,
+        is_partition_flushed=None,
+        lock_action=None,
+        lock_duration=None,
+        overwrite_existing_version=None,
+        shared_lock_id=None,
+    ):
+        self.Action = action
+        self.HasReachedMinorVersionsLimit = has_reached_minor_versions_limit
+        self.IsNewSession = is_new_session
+        self.IsPartitionFlushed = is_partition_flushed
+        self.LockAction = lock_action
+        self.LockDuration = lock_duration
+        self.OverwriteExistingVersion = overwrite_existing_version
+        self.SharedLockId = shared_lock_id
+
     @property
     def entity_type_name(self):
         return "SP.Publishing.SitePageCoAuthState"

office365/sharepoint/publishing/pages/dependency_metadata.py

@@ -0,0 +1,9 @@
+from office365.runtime.client_value import ClientValue
+
+
+class SitePageDependencyMetadata(ClientValue):
+    """ """
+
+    @property
+    def entity_type_name(self):
+        return "SP.Publishing.SitePageDependencyMetadata"

office365/sharepoint/publishing/pages/metadata.py

@@ -129,13 +129,3 @@ class SitePageMetadata(Entity):
             }
             default_value = property_mapping.get(name, None)
         return super(SitePageMetadata, self).get_property(name, default_value)
-
-    def set_property(self, name, value, persist_changes=True):
-        if name == "Id":
-            if self._resource_path is None:
-                self._resource_path = self.parent_collection.get_by_id(
-                    value
-                ).resource_path
-            else:
-                self._resource_path.patch(value)
-        return super(SitePageMetadata, self).set_property(name, value, persist_changes)

office365/sharepoint/publishing/pages/page.py

@@ -2,10 +2,14 @@ from typing import Optional
 
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value import ClientValue
+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.sharepoint.publishing.pages.coauth_state import SitePageCoAuthState
+from office365.sharepoint.publishing.pages.dependency_metadata import (
+    SitePageDependencyMetadata,
+)
 from office365.sharepoint.publishing.pages.fields_data import SitePageFieldsData
 from office365.sharepoint.publishing.pages.metadata import SitePageMetadata
 from office365.sharepoint.translation.status_collection import (
@@ -56,6 +60,25 @@ class SitePage(SitePageMetadata):
         self.context.add_query(qry)
         return self
 
+    def get_dependency_metadata(self):
+        """ """
+        return_type = ClientResult(
+            self.context, ClientValueCollection(SitePageDependencyMetadata)
+        )
+        qry = ServiceOperationQuery(
+            self, "GetDependencyMetadata", return_type=return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def get_version(self, version_id):
+        """ """
+        return_type = SitePage(self.context, self.resource_path)
+        qry = ServiceOperationQuery(
+            self, "GetVersion", [version_id], None, None, return_type
+        )
+        self.context.add_query(qry)
+
     def save_page(
         self, title, canvas_content=None, banner_image_url=None, topic_header=None
     ):
@@ -218,6 +241,12 @@ class SitePage(SitePageMetadata):
         """Gets the CanvasContent1 for the current Site Page"""
         return self.properties.get("CanvasContent1", None)
 
+    @property
+    def language(self):
+        # type: () -> Optional[str]
+        """Gets the Language for the Site Page."""
+        return self.properties.get("Language", None)
+
     @canvas_content.setter
     def canvas_content(self, value):
         # type: (str) -> None

office365/sharepoint/publishing/pages/service.py

@@ -1,10 +1,14 @@
 from typing import TYPE_CHECKING, Optional
 
 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.sharepoint.administration.orgassets.org_assets import OrgAssets
+from office365.sharepoint.clientsidecomponent.query_result import (
+    SPClientSideComponentQueryResult,
+)
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.files.file import File
 from office365.sharepoint.publishing.file_picker_options import FilePickerOptions
@@ -50,10 +54,11 @@ class SitePageService(Entity):
     def entity_type_name(self):
         return "SP.Publishing.SitePageService"
 
-    def create_page(self, title):
-        # type: (str) -> SitePage
+    def create_page(self, title, language=None):
+        # type: (str, Optional[str]) -> SitePage
         """Create a new sitePage in the site pages list in a site.
         :param str title: The title of Site Page
+        :param str language: The language of the Site Page.
         """
 
         def _page_created(return_type):
@@ -61,13 +66,13 @@ class SitePageService(Entity):
 
             def _draft_saved(result):
                 # type: (ClientResult[bool]) -> None
-                pass
+                return_type.get()
 
             return_type.save_draft(title=title).after_execute(
                 _draft_saved, execute_first=True
             )
 
-        return self.pages.add().after_execute(_page_created).get()
+        return self.pages.add().after_execute(_page_created)
 
     def create_and_publish_page(self, title):
         """
@@ -155,8 +160,24 @@ class SitePageService(Entity):
         return return_type
 
     @staticmethod
-    def get_available_full_page_applications():
-        pass
+    def get_available_full_page_applications(
+        context, include_errors=None, project=None
+    ):
+        return_type = ClientResult(
+            context, ClientValueCollection(SPClientSideComponentQueryResult)
+        )
+        params = {"includeErrors": include_errors, "project": project}
+        qry = ServiceOperationQuery(
+            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):

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

@@ -2,6 +2,6 @@ from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.publishing.pages.topics.topic import TopicSitePage
 
 
-class TopicPageCollection(EntityCollection):
+class TopicPageCollection(EntityCollection[TopicSitePage]):
     def __init__(self, context, resource_path=None):
         super(TopicPageCollection, self).__init__(context, TopicSitePage, resource_path)

office365/sharepoint/request.py

@@ -3,6 +3,7 @@ from typing import Callable, List, Optional
 from requests import Response
 from typing_extensions import Self
 
+from office365.azure_env import AzureEnvironment
 from office365.runtime.auth.authentication_context import AuthenticationContext
 from office365.runtime.auth.client_credential import ClientCredential
 from office365.runtime.auth.token_response import TokenResponse
@@ -14,12 +15,15 @@ from office365.runtime.odata.v3.json_light_format import JsonLightFormat
 
 class SharePointRequest(ODataRequest):
     def __init__(
-        self, base_url, environment="commercial", allow_ntlm=False, browser_mode=False
+        self,
+        base_url,
+        environment=AzureEnvironment.Global,
+        allow_ntlm=False,
+        browser_mode=False,
     ):
         """
         :param str base_url: Absolute Web or Site Url
         :param str environment: The Office 365 Cloud Environment endpoint used for authentication
-            defaults to 'commercial'.
         :param bool allow_ntlm: Flag indicates whether NTLM scheme is enabled. Disabled by default
         :param bool browser_mode: Allow browser authentication
         """

office365/sharepoint/search/administration/tenant_crawl_versions_info_provider.py

@@ -1,11 +1,27 @@
+from typing import TYPE_CHECKING
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
+if TYPE_CHECKING:
+    from office365.sharepoint.client_context import ClientContext
+
 
 class TenantCrawlVersionsInfoProvider(Entity):
     """Retrieves information about crawl versions for a tenant in SharePoint"""
 
+    @staticmethod
+    def create(context):
+        # type: (ClientContext) -> TenantCrawlVersionsInfoProvider
+        return_type = TenantCrawlVersionsInfoProvider(context)
+        qry = ServiceOperationQuery(
+            return_type, "Create", None, None, None, return_type
+        )
+        qry.static = True
+        context.add_query(qry)
+        return return_type
+
     def disable_crawl_versions(self, site_id):
         """
         :param str site_id:

office365/sharepoint/sharing/access_request_settings.py

@@ -7,6 +7,24 @@ class AccessRequestSettings(ClientValue):
     Microsoft.SharePoint.Client.Sharing.SecurableObjectExtensions.GetSharingInformation() call on a list item.
     """
 
+    def __init__(
+        self,
+        has_pending_access_requests=None,
+        pending_access_requests_link=None,
+        requires_access_approval=None,
+    ):
+        """
+        :param bool has_pending_access_requests: Boolean indicating whether there are pending access requests
+            for the list item.
+        :param str pending_access_requests_link: The full URL to the access requests page for the list item,
+             or an empty string if the link is not available.
+        :param bool requires_access_approval: Boolean indicating whether the current user’s access on the list item
+             requires approval from admin for sharing to others.
+        """
+        self.hasPendingAccessRequests = has_pending_access_requests
+        self.pendingAccessRequestsLink = pending_access_requests_link
+        self.requiresAccessApproval = requires_access_approval
+
     @property
     def entity_type_name(self):
         return "SP.Sharing.AccessRequestSettings"

office365/sharepoint/sharing/address_bar_link_settings.py

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