Office365-REST-Python-Client 2.5.7__py3-none-any.whl → 2.5.9__py3-none-any.whl

office365/sharepoint/tenant/administration/tenant.py

@@ -34,6 +34,15 @@ from office365.sharepoint.tenant.administration.insights.onedrive_site_sharing i
 from office365.sharepoint.tenant.administration.insights.top_files_sharing import (
     TopFilesSharingInsights,
 )
+from office365.sharepoint.tenant.administration.powerapps.environment import (
+    PowerAppsEnvironment,
+)
+from office365.sharepoint.tenant.administration.recent_admin_action_report import (
+    RecentAdminActionReport,
+)
+from office365.sharepoint.tenant.administration.recent_admin_action_report_payload import (
+    RecentAdminActionReportPayload,
+)
 from office365.sharepoint.tenant.administration.secondary_administrators_fields_data import (
     SecondaryAdministratorsFieldsData,
 )
@@ -75,6 +84,16 @@ class Tenant(Entity):
         )
         super(Tenant, self).__init__(context, static_path)
 
+    def add_recent_admin_action_report(self):
+        """"""
+        return_type = ClientResult(self.context, RecentAdminActionReport())
+        payload = {"payload": RecentAdminActionReportPayload()}
+        qry = ServiceOperationQuery(
+            self, "AddRecentAdminActionReport", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def get_corporate_catalog_site(self):
         """Retrieves Corporate Catalog Site"""
         settings = TenantSettings.current(self.context)
@@ -281,13 +300,25 @@ class Tenant(Entity):
 
     def get_lock_state_by_id(self, site_id):
         """
-        :param str site_id:
+        :param str site_id: The GUID to uniquely identify a SharePoint site
         """
         return self.sites.get_lock_state_by_id(site_id)
 
     def hub_sites(self, site_url):
         pass
 
+    def get_power_apps_environments(self):
+        """ """
+        return_type = ClientResult(
+            self.context,
+            ClientValueCollection(PowerAppsEnvironment),
+        )
+        qry = ServiceOperationQuery(
+            self, "GetPowerAppsEnvironments", None, None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def check_tenant_intune_license(self):
         """
         Checks whether a tenant has the Intune license.
@@ -587,6 +618,24 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return return_type
 
+    @property
+    def admin_settings(self):
+        """ """
+        from office365.sharepoint.tenant.administration.settings_service import (
+            TenantAdminSettingsService,
+        )
+
+        return TenantAdminSettingsService(self.context)
+
+    @property
+    def migration_center(self):
+        """ """
+        from office365.sharepoint.migrationcenter.service.services import (
+            MigrationCenterServices,
+        )
+
+        return MigrationCenterServices(self.context)
+
     @property
     def ai_builder_enabled(self):
         # type: () -> Optional[str]
@@ -656,6 +705,12 @@ class Tenant(Entity):
             ),
         )
 
+    @property
+    def cdn_api(self):
+        from office365.sharepoint.tenant.cdn_api import TenantCdnApi
+
+        return TenantCdnApi(self.context)
+
     @property
     def syntex_billing_subscription_settings(self):
         """"""

office365/sharepoint/tenant/cdn_api.py

@@ -1,5 +1,9 @@
+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.sharepoint.entity import Entity
+from office365.sharepoint.tenant.cdn_url import TenantCdnUrl
 
 
 class TenantCdnApi(Entity):
@@ -8,6 +12,18 @@ class TenantCdnApi(Entity):
             context, ResourcePath("Microsoft.SharePoint.TenantCdn.TenantCdnApi")
         )
 
+    def get_cdn_urls(self, items=None):
+        """"""
+        payload = {
+            "items": items,
+        }
+        return_type = ClientResult(self.context, ClientValueCollection(TenantCdnUrl))
+        qry = ServiceOperationQuery(
+            self, "GetCdnUrls", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.TenantCdn.TenantCdnApi"

office365/sharepoint/tenant/management/externalusers/results/get.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.tenant.management.externalusers.collection import (
@@ -8,10 +10,12 @@ from office365.sharepoint.tenant.management.externalusers.collection import (
 class GetExternalUsersResults(Entity):
     @property
     def total_user_count(self):
+        # type: () -> Optional[int]
         return self.properties.get("TotalUserCount", None)
 
     @property
     def user_collection_position(self):
+        # type: () -> Optional[int]
         return self.properties.get("UserCollectionPosition", None)
 
     @property

office365/sharepoint/tenant/management/office365_tenant.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.client_object_collection import ClientObjectCollection
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
@@ -29,8 +31,19 @@ class Office365Tenant(Entity):
         )
         super(Office365Tenant, self).__init__(context, static_path)
 
+    @property
+    def addressbar_link_permission(self):
+        # type: () -> Optional[int]
+        return self.properties.get("AddressbarLinkPermission", None)
+
+    @property
+    def allow_comments_text_on_email_enabled(self):
+        # type: () -> Optional[bool]
+        return self.properties.get("AllowCommentsTextOnEmailEnabled", None)
+
     @property
     def allow_editing(self):
+        # type: () -> Optional[bool]
         return self.properties.get("AllowEditing", None)
 
     @property
@@ -62,6 +75,7 @@ class Office365Tenant(Entity):
 
     def disable_sharing_for_non_owners_of_site(self, site_url):
         """
+        Disables Sharing For Non Owners
         :param str site_url:
         """
         payload = {"siteUrl": site_url}

office365/sharepoint/types/resource_path.py

@@ -44,7 +44,7 @@ class ResourcePath(ClientValue):
         return "SP.ResourcePath"
 
     def __str__(self):
-        return self.DecodedUrl
+        return self.DecodedUrl or ""
 
     def __repr__(self):
         return self.DecodedUrl or self.entity_type_name

office365/sharepoint/ui/applicationpages/peoplepicker/web_service_interface.py

@@ -16,39 +16,6 @@ from office365.sharepoint.ui.applicationpages.peoplepicker.query_parameters impo
 class ClientPeoplePickerWebServiceInterface(Entity):
     """Specifies an interface that can be used to query principals."""
 
-    @staticmethod
-    def get_search_results(
-        context,
-        search_pattern,
-        provider_id=None,
-        hierarchy_node_id=None,
-        entity_types=None,
-    ):
-        """
-        Specifies a JSON formatted CSOM String of principals found in the search.
-
-        :type context: office365.sharepoint.client_context.ClientContext
-        :param str search_pattern: Specifies a pattern used to search for principals.
-            The value is implementation-specific.
-        :param str provider_id: The identifier of a claims provider.
-        :param str hierarchy_node_id: The identifier of a node in the hierarchy. The search MUST be conducted under
-            this node.
-        :param str entity_types: The type of principals to search for.
-        """
-        return_type = ClientResult(context, str())
-        payload = {
-            "searchPattern": search_pattern,
-            "providerID": provider_id,
-            "hierarchyNodeID": hierarchy_node_id,
-            "entityTypes": entity_types,
-        }
-        svc = ClientPeoplePickerWebServiceInterface(context)
-        qry = ServiceOperationQuery(
-            svc, "GetSearchResults", None, payload, None, return_type, True
-        )
-        context.add_query(qry)
-        return return_type
-
     @staticmethod
     def get_search_results_by_hierarchy(
         context,
@@ -167,3 +134,42 @@ class ClientPeoplePickerWebServiceInterface(Entity):
     @property
     def entity_type_name(self):
         return "SP.UI.ApplicationPages.ClientPeoplePickerWebServiceInterface"
+
+
+class PeoplePickerWebServiceInterface(Entity):
+    @staticmethod
+    def get_search_results(
+        context,
+        search_pattern,
+        provider_id=None,
+        hierarchy_node_id=None,
+        entity_types=None,
+    ):
+        """
+        Specifies a JSON formatted CSOM String of principals found in the search.
+
+        :type context: office365.sharepoint.client_context.ClientContext
+        :param str search_pattern: Specifies a pattern used to search for principals.
+            The value is implementation-specific.
+        :param str provider_id: The identifier of a claims provider.
+        :param str hierarchy_node_id: The identifier of a node in the hierarchy. The search MUST be conducted under
+            this node.
+        :param str entity_types: The type of principals to search for.
+        """
+        return_type = ClientResult(context, str())
+        payload = {
+            "searchPattern": search_pattern,
+            "providerID": provider_id,
+            "hierarchyNodeID": hierarchy_node_id,
+            "entityTypes": entity_types,
+        }
+        svc = PeoplePickerWebServiceInterface(context)
+        qry = ServiceOperationQuery(
+            svc, "GetSearchResults", None, payload, None, return_type, True
+        )
+        context.add_query(qry)
+        return return_type
+
+    @property
+    def entity_type_name(self):
+        return "SP.UI.ApplicationPages.PeoplePickerWebServiceInterface"

office365/sharepoint/userprofiles/cross_geo_sync.py

@@ -0,0 +1,37 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.client_context import ClientContext
+from office365.sharepoint.entity import Entity
+from office365.sharepoint.userprofiles.cross_geo_sync_user_data_batch import (
+    CrossGeoSyncUserDataBatch,
+)
+
+
+class CrossGeoSync(Entity):
+    """"""
+
+    @staticmethod
+    def read_full_changes_batch(context, targetInstanceId, lastRecordId, batchSize):
+        # type: (ClientContext, str, str, str) -> ClientResult[CrossGeoSyncUserDataBatch]
+        """ """
+        payload = {
+            "targetInstanceId": targetInstanceId,
+            "lastRecordId": lastRecordId,
+            "batchSize": batchSize,
+        }
+        return_type = ClientResult(context, CrossGeoSyncUserDataBatch())
+        qry = ServiceOperationQuery(
+            CrossGeoSync(context),
+            "ReadFullChangesBatch",
+            None,
+            payload,
+            None,
+            return_type,
+            is_static=True,
+        )
+        context.add_query(qry)
+        return return_type
+
+    @property
+    def entity_type_name(self):
+        return "SP.UserProfiles.CrossGeoSync"

office365/sharepoint/userprofiles/cross_geo_sync_user_data_batch.py

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

office365/sharepoint/userprofiles/followed_content.py

@@ -25,6 +25,21 @@ class FollowedContent(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def get_followed_status(self, url):
+        """
+        The GetFollowedStatus method retrieves the followed status of the specified document or site.
+        An item can be followed if the url parameter identifies a document or site that the current user has access to.
+
+        :param str url: URL that identifies the item
+        """
+        return_type = ClientResult(self.context, int())
+        payload = {"url": url}
+        qry = ServiceOperationQuery(
+            self, "GetFollowedStatus", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def followed_documents_url(self):
         # type: () -> Optional[str]

office365/sharepoint/userprofiles/people_manager.py

@@ -75,18 +75,30 @@ class PeopleManager(Entity):
         self.context.add_query(qry)
         return result
 
-    def get_followers_for(self, account_name):
+    def get_followers_for(self, account):
+        # type: (str|User) -> EntityCollection[PersonProperties]
         """
         Gets the people who are following the specified user.
 
-        :param str account_name: Account name of the specified user.
+        :param str|User account: Account name of the specified user.
         """
         return_type = EntityCollection(self.context, PersonProperties)
-        params = {"accountName": account_name}
-        qry = ServiceOperationQuery(
-            self, "GetFollowersFor", params, None, None, return_type
-        )
-        self.context.add_query(qry)
+
+        def _get_followers_for(account_name):
+            params = {"accountName": account_name}
+            qry = ServiceOperationQuery(
+                self, "GetFollowersFor", params, None, None, return_type
+            )
+            self.context.add_query(qry)
+
+        if isinstance(account, User):
+
+            def _account_loaded():
+                _get_followers_for(account.login_name)
+
+            account.ensure_property("LoginName", _account_loaded)
+        else:
+            _get_followers_for(account)
         return return_type
 
     def get_user_information(self, account_name, site_id):
@@ -153,21 +165,22 @@ class PeopleManager(Entity):
         _ensure_user(user_or_name, _user_resolved)
         return return_type
 
-    def get_properties_for(self, user_or_name):
+    def get_properties_for(self, account):
         """
         Gets user properties for the specified user.
-        :param str or User user_or_name: Specifies the User object or its login name.
+        :param str or User account: Specifies the User object or its login name.
         """
         return_type = PersonProperties(self.context)
 
         def _get_properties_for_inner(account_name):
+            # type: (str) -> None
             params = {"accountName": account_name}
             qry = ServiceOperationQuery(
                 self, "GetPropertiesFor", params, None, None, return_type
             )
             self.context.add_query(qry)
 
-        _ensure_user(user_or_name, _get_properties_for_inner)
+        _ensure_user(account, _get_properties_for_inner)
         return return_type
 
     def get_default_document_library(

office365/sharepoint/userprofiles/person_properties.py

@@ -1,5 +1,6 @@
 from typing import Optional
 
+from office365.runtime.odata.type import ODataType
 from office365.runtime.types.collections import StringCollection
 from office365.sharepoint.entity import Entity
 
@@ -79,6 +80,12 @@ class PersonProperties(Entity):
     def entity_type_name(self):
         return "SP.UserProfiles.PersonProperties"
 
+    def set_property(self, k, v, persist_changes=True):
+        if k == "UserProfileProperties":
+            v = ODataType.parse_key_value_collection(v)
+        super(PersonProperties, self).set_property(k, v)
+        return self
+
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {

office365/sharepoint/userprofiles/user_profile.py

@@ -50,9 +50,8 @@ class UserProfile(Entity):
 
     @property
     def followed_content(self):
-        """
-        Gets a FollowedContent object for the user.
-        """
+        # type: () -> FollowedContent
+        """Gets a FollowedContent object for the user."""
         return self.properties.get(
             "FollowedContent",
             FollowedContent(
@@ -62,9 +61,8 @@ class UserProfile(Entity):
 
     @property
     def personal_site(self):
-        """
-        The PersonalSite property specifies the user's personal site
-        """
+        # type: () -> Site
+        """The PersonalSite property specifies the user's personal site"""
         return self.properties.get(
             "PersonalSite",
             Site(self.context, ResourcePath("PersonalSite", self.resource_path)),

office365/sharepoint/views/view.py

@@ -9,7 +9,7 @@ from office365.sharepoint.listitems.caml.query import CamlQuery
 from office365.sharepoint.listitems.collection import ListItemCollection
 from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
 from office365.sharepoint.views.field_collection import ViewFieldCollection
-from office365.sharepoint.views.visualization import Visualization
+from office365.sharepoint.views.visualization.visualization import Visualization
 
 if TYPE_CHECKING:
     from office365.sharepoint.views.collection import ViewCollection
@@ -172,6 +172,7 @@ class View(Entity):
 
     @property
     def view_fields(self):
+        # type: () -> ViewFieldCollection
         """Gets a value that specifies the collection of fields in the list view."""
         return self.properties.get(
             "ViewFields",
@@ -199,6 +200,7 @@ class View(Entity):
 
     @property
     def server_relative_path(self):
+        # type: () -> Optional[SPResPath]
         """Gets the server-relative Path of the View."""
         return self.properties.get("ServerRelativePath", SPResPath())
 

office365/sharepoint/views/visualization/field.py

@@ -0,0 +1,14 @@
+from office365.runtime.client_value import ClientValue
+
+
+class VisualizationField(ClientValue):
+    """Contains CSS properties relating to how an individual field is layed out relative to it's container."""
+
+    def __init__(self, InternalName=None, Style=None):
+        """
+        :param str InternalName: A Property which will specify which set of sub-elements to apply this set of
+            CSS properties on.
+        :param str Style: CSS properties in serialized JSON format.
+        """
+        self.InternalName = InternalName
+        self.Style = Style

office365/sharepoint/views/visualization/style_set.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class VisualizationStyleSet(ClientValue):
+    """Microsoft.SharePoint.Client.VisualizationStyleSet is not applicable."""

office365/sharepoint/webs/web.py

@@ -89,6 +89,7 @@ from office365.sharepoint.sitescripts.serialization_result import (
     SiteScriptSerializationResult,
 )
 from office365.sharepoint.sitescripts.utility import SiteScriptUtility
+from office365.sharepoint.translation.resource_entry import SPResourceEntry
 from office365.sharepoint.translation.user_resource import UserResource
 from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
 from office365.sharepoint.ui.applicationpages.peoplepicker.web_service_interface import (
@@ -1858,12 +1859,52 @@ class Web(SecurableObject):
         # type: () -> Optional[bool]
         return self.properties.get("CustomSiteActionsDisabled", None)
 
+    @property
+    def description_translations(self):
+        """"""
+        return self.properties.get(
+            "DescriptionTranslations", ClientValueCollection(SPResourceEntry)
+        )
+
+    @property
+    def design_package_id(self):
+        # type: () -> Optional[str]
+        """Gets or sets the ID of the Design Package used in this SP.Web.
+
+        A value of Guid.Empty will mean that the default Design Package will be used for this SP.Web.
+        The default is determined by the SP.WebTemplate of this SP.Web."""
+        return self.properties.get("DesignPackageId", None)
+
+    @property
+    def disable_app_views(self):
+        # type: () -> Optional[bool]
+        """"""
+        return self.properties.get("DisableAppViews", None)
+
+    @property
+    def disable_flows(self):
+        # type: () -> Optional[bool]
+        """"""
+        return self.properties.get("DisableFlows", None)
+
     @property
     def id(self):
         # type: () -> Optional[str]
         """Specifies the site identifier for the site"""
         return self.properties.get("Id", None)
 
+    @property
+    def language(self):
+        # type: () -> Optional[int]
+        """Specifies the language code identifier (LCID) for the language that is used on the site"""
+        return self.properties.get("Language", None)
+
+    @property
+    def last_item_modified_date(self):
+        # type: () -> Optional[int]
+        """Specifies when an item was last modified in the site"""
+        return self.properties.get("LastItemModifiedDate", datetime.datetime.min)
+
     @property
     def access_requests_list(self):
         """"""
@@ -2421,9 +2462,11 @@ class Web(SecurableObject):
                 "ClientWebParts": self.client_web_parts,
                 "CurrentUser": self.current_user,
                 "DescriptionResource": self.description_resource,
+                "DescriptionTranslations": self.description_translations,
                 "EffectiveBasePermissions": self.effective_base_permissions,
                 "EventReceivers": self.event_receivers,
                 "HostedApps": self.hosted_apps,
+                "LastItemModifiedDate": self.last_item_modified_date,
                 "ListTemplates": self.list_templates,
                 "MultilingualSettings": self.multilingual_settings,
                 "OneDriveSharedItems": self.onedrive_shared_items,

office365/sharepoint/workflow/manager.py

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

office365/sharepoint/workflowservices/deployment_service.py

@@ -0,0 +1,9 @@
+from office365.sharepoint.entity import Entity
+
+
+class WorkflowDeploymentService(Entity):
+    """"""
+
+    @property
+    def entity_type_name(self):
+        return "SP.WorkflowServices.WorkflowDeploymentService"