Office365-REST-Python-Client 2.5.1__py3-none-any.whl → 2.5.3__py3-none-any.whl

office365/sharepoint/userprofiles/user_profile.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -12,41 +14,37 @@ class UserProfile(Entity):
 
     @property
     def account_name(self):
-        """
-        The account name of the user.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The account name of the user."""
         return self.properties.get("AccountName", None)
 
     @property
     def display_name(self):
-        """
-        The title of the user.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The title of the user."""
         return self.properties.get("DisplayName", None)
 
     @property
     def my_site_host_url(self):
+        # type: () -> Optional[str]
         """
         Specifies the URL for the personal site of the current user.
-        :rtype: str or None
         """
         return self.properties.get("MySiteHostUrl", None)
 
     @property
     def public_url(self):
+        # type: () -> Optional[str]
         """
         Specifies the public URL for the personal site of the current user.
-        :rtype: str or None
         """
         return self.properties.get("PublicUrl", None)
 
     @property
     def url_to_create_personal_site(self):
+        # type: () -> Optional[str]
         """
         The UrlToCreatePersonalSite property specifies the URL to allow the current user to create a personal site.
-        :rtype: str or None
         """
         return self.properties.get("UrlToCreatePersonalSite", None)
 

office365/sharepoint/utilities/principal_info.py

@@ -1,4 +1,6 @@
 from office365.runtime.client_value import ClientValue
+from office365.runtime.odata.type import ODataType
+from office365.sharepoint.principal.type import PrincipalType
 
 
 class PrincipalInfo(ClientValue):
@@ -12,6 +14,7 @@ class PrincipalInfo(ClientValue):
         login_name=None,
         department=None,
         job_title=None,
+        principal_type=None,
     ):
         """
         :param str principal_id: Specifies an identifier for the principal. It MUST be -1 if the principal
@@ -21,6 +24,7 @@ class PrincipalInfo(ClientValue):
         :param str department: Specifies the department name of the principal.
         :param str job_title: Specifies the job title of the principal.
         :param str login_name: Specifies the login name of the principal.
+        :param int principal_type: Specifies the principal type.
         """
         self.PrincipalId = principal_id
         self.DisplayName = display_name
@@ -28,7 +32,15 @@ class PrincipalInfo(ClientValue):
         self.LoginName = login_name
         self.Department = department
         self.JobTitle = job_title
+        self.PrincipalType = principal_type
 
     @property
     def entity_type_name(self):
         return "SP.Utilities.PrincipalInfo"
+
+    @property
+    def principal_type_name(self):
+        return ODataType.resolve_enum_key(PrincipalType, self.PrincipalType)
+
+    def __str__(self):
+        return "{0}: {1}".format(self.principal_type_name, self.DisplayName)

office365/sharepoint/viva/employee_engagement.py

@@ -26,7 +26,7 @@ class EmployeeEngagement(Entity):
         return return_type
 
     def viva_home_configuration(self):
-        return_type = ClientResult(self.context, dict())
+        return_type = ClientResult(self.context, {})
         qry = FunctionQuery(self, "VivaHomeConfiguration", None, return_type)
         self.context.add_query(qry)
         return return_type

office365/sharepoint/webparts/definition_collection.py

@@ -3,7 +3,7 @@ from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.webparts.definition import WebPartDefinition
 
 
-class WebPartDefinitionCollection(EntityCollection):
+class WebPartDefinitionCollection(EntityCollection[WebPartDefinition]):
     """Implements a collection of Web Part definition objects"""
 
     def __init__(self, context, resource_path=None):

office365/sharepoint/webs/collection.py

@@ -1,5 +1,6 @@
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity_collection import EntityCollection
+from office365.sharepoint.internal.paths.web import WebPath
 from office365.sharepoint.webs.web import Web
 
 
@@ -25,6 +26,13 @@ class WebCollection(EntityCollection[Web]):
         self.context.add_query(qry)
         return return_type
 
+    def create_typed_object(self, initial_properties=None, resource_path=None):
+        if resource_path is None:
+            resource_path = WebPath(self.resource_path)
+        return super(EntityCollection, self).create_typed_object(
+            initial_properties, resource_path
+        )
+
     @property
     def resource_url(self):
         val = super(WebCollection, self).resource_url

office365/sharepoint/webs/template_collection.py

@@ -3,7 +3,7 @@ from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.webs.template import WebTemplate
 
 
-class WebTemplateCollection(EntityCollection):
+class WebTemplateCollection(EntityCollection[WebTemplate]):
     """Specifies a collection of site templates."""
 
     def __init__(self, context, resource_path=None, parent=None):
@@ -12,10 +12,8 @@ class WebTemplateCollection(EntityCollection):
         )
 
     def get_by_name(self, name):
-        """Returns the SP.WebTemplate (section 3.2.5.151) specified by its name.<162>
-
-        :param str name: The name of the SP.WebTemplate that is returned.
-
+        """Returns the SP.WebTemplate (section 3.2.5.151) specified by its name.
+        :param str name: The name of the WebTemplate that is returned.
         """
         return WebTemplate(
             self.context,

office365/sharepoint/webs/web.py

@@ -1,6 +1,6 @@
 # coding=utf-8
 import datetime
-from typing import Optional
+from typing import AnyStr, Optional
 
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
@@ -16,6 +16,7 @@ from office365.sharepoint.authentication.acs_service_principal_info import (
 )
 from office365.sharepoint.businessdata.app_bdc_catalog import AppBdcCatalog
 from office365.sharepoint.changes.collection import ChangeCollection
+from office365.sharepoint.changes.query import ChangeQuery
 from office365.sharepoint.clientsidecomponent.hostedapps.manager import (
     HostedAppsManager,
 )
@@ -40,6 +41,7 @@ from office365.sharepoint.files.file import File
 from office365.sharepoint.flows.synchronization_result import FlowSynchronizationResult
 from office365.sharepoint.folders.collection import FolderCollection
 from office365.sharepoint.folders.folder import Folder
+from office365.sharepoint.internal.paths.web import WebPath
 from office365.sharepoint.listitems.listitem import ListItem
 from office365.sharepoint.lists.collection import ListCollection
 from office365.sharepoint.lists.creation_information import ListCreationInformation
@@ -122,10 +124,13 @@ class Web(SecurableObject):
         :type context: office365.sharepoint.client_context.ClientContext
         """
         if resource_path is None:
-            resource_path = ResourcePath("Web")
+            resource_path = WebPath("Web")
         super(Web, self).__init__(context, resource_path)
         self._web_url = None
 
+    def __str__(self):
+        return self.title
+
     def add_list(self, title, template_type=ListTemplateType.GenericList):
         """
         Creates a new list and adds it to the web.
@@ -575,7 +580,7 @@ class Web(SecurableObject):
         :type webs: office365.sharepoint.webs.collection.WebCollection
         :type all_webs: office365.sharepoint.webs.collection.WebCollection
         """
-        for cur_web in webs:  # type: Web
+        for cur_web in webs:
             all_webs.add_child(cur_web)
 
             def _webs_loaded(web):
@@ -698,7 +703,7 @@ class Web(SecurableObject):
         :param str url: The URL of the site, with the path of the object in SharePoint represented as query
         string parameters
         :param office365.sharepoint.client_context.ClientContext context: client context
-        :param ClientResult return_type: Return type
+        :param ClientResult[str] return_type: Return type
         """
         if return_type is None:
             return_type = ClientResult(context, str())
@@ -814,6 +819,7 @@ class Web(SecurableObject):
             ServiceOperationPath(
                 "getFileByServerRelativeUrl", [str(path)], self.resource_path
             ),
+            self.root_folder.files,
         )
 
     def get_file_by_server_relative_path(self, path):
@@ -830,6 +836,7 @@ class Web(SecurableObject):
             ServiceOperationPath(
                 "getFileByServerRelativePath", path.to_json(), self.resource_path
             ),
+            self.root_folder.files,
         )
 
     def get_folder_by_server_relative_url(self, url):
@@ -842,6 +849,7 @@ class Web(SecurableObject):
             ServiceOperationPath(
                 "getFolderByServerRelativeUrl", [url], self.resource_path
             ),
+            self.folders,
         )
 
     def get_folder_by_server_relative_path(self, decoded_url):
@@ -858,6 +866,7 @@ class Web(SecurableObject):
             ServiceOperationPath(
                 "getFolderByServerRelativePath", path.to_json(), self.resource_path
             ),
+            self.folders,
         )
 
     def get_site_page_copy_to_status(self, work_item_id):
@@ -887,7 +896,6 @@ class Web(SecurableObject):
     def ensure_folder_path(self, path):
         """
         Ensures a nested folder hierarchy exist
-
         :param str path: relative server URL (path) to a folder
         """
         return self.root_folder.folders.ensure_path(path)
@@ -930,18 +938,6 @@ class Web(SecurableObject):
         self.context.add_query(qry)
         return return_type
 
-    def get_user_effective_permissions(self, user_name):
-        """Gets the effective permissions that the specified user has within the current application scope.
-
-        :param str user_name: Specifies the user login name.
-        """
-        return_type = ClientResult(self.context, BasePermissions())
-        qry = ServiceOperationQuery(
-            self, "GetUserEffectivePermissions", [user_name], None, None, return_type
-        )
-        self.context.add_query(qry)
-        return return_type
-
     def get_list_by_title(self, title):
         """
         Returns the list with the specified display name.
@@ -1019,12 +1015,14 @@ class Web(SecurableObject):
             ServiceOperationPath("getList", [str(safe_path)], self.resource_path),
         )
 
-    def get_changes(self, query):
-        """Returns the collection of all changes from the change log that have occurred within the scope of the site,
+    def get_changes(self, query=None):
+        """Returns the collection of all changes from the change log that have occurred within the scope of the web,
         based on the specified query.
 
         :param office365.sharepoint.changes.query.ChangeQuery query: Specifies which changes to return
         """
+        if query is None:
+            query = ChangeQuery(web=True, fetch_limit=100)
         return_type = ChangeCollection(self.context)
         payload = {"query": query}
         qry = ServiceOperationQuery(
@@ -1104,7 +1102,6 @@ class Web(SecurableObject):
     def get_file_by_guest_url(self, guest_url):
         """
         Returns the file object from the guest access URL.
-
         :param str guest_url: The guest access URL to get the file with.
         """
         return_type = File(self.context)
@@ -1207,7 +1204,7 @@ class Web(SecurableObject):
 
         :param str guest_url: The tokenized sharing link URL for the folder.
         """
-        return_type = Folder(self.context)
+        return_type = Folder(self.context, parent_collection=self.folders)
         payload = {"guestUrl": guest_url}
         qry = ServiceOperationQuery(
             self, "GetFolderByGuestUrl", None, payload, None, return_type
@@ -1231,7 +1228,7 @@ class Web(SecurableObject):
         :param bool ensure_access: Indicates if the request to the tokenized sharing link grants perpetual access to
             the calling user.
         """
-        return_type = Folder(self.context)
+        return_type = Folder(self.context, parent_collection=self.folders)
         payload = {
             "guestUrl": guest_url,
             "requestSettings": SharingLinkAccessRequest(ensure_access, password),
@@ -1285,13 +1282,13 @@ class Web(SecurableObject):
         :param bool send_email: A flag to determine if an email notification SHOULD be sent (if email is configured).
         :param str email_subject: The email subject.
         :param str email_body: The email subject.
-        :rtype: SharingResult
         """
         return_type = SharingResult(self.context)
 
-        def _picker_value_resolved(resp, picker_result, group):
+        def _share(picker_result, group):
+            # type: (ClientResult[str], Group) -> None
             picker_input = "[{0}]".format(picker_result.value)
-            role_value = "group:{groupId}".format(groupId=group.properties["Id"])
+            role_value = "group:{groupId}".format(groupId=group.id)
             Web.share_object(
                 self.context,
                 self.url,
@@ -1306,34 +1303,30 @@ class Web(SecurableObject):
                 return_type=return_type,
             )
 
-        def _grp_resolved(group):
-            picker_result = (
-                ClientPeoplePickerWebServiceInterface.client_people_picker_resolve_user(
-                    self.context, user_principal_name
-                )
-            )
-            self.context.after_execute(
-                _picker_value_resolved, True, picker_result, group
-            )
-
         def _web_resolved():
             groups = {
                 ExternalSharingSiteOption.View: self.associated_visitor_group,
                 ExternalSharingSiteOption.Edit: self.associated_member_group,
                 ExternalSharingSiteOption.Owner: self.associated_owner_group,
-            }
-            selected_group = groups[share_option]
-            self.context.load(selected_group, after_loaded=_grp_resolved)
+            }  # type: dict[ExternalSharingSiteOption, Group]
 
-        self.ensure_property("Url", _web_resolved)
+            ClientPeoplePickerWebServiceInterface.client_people_picker_resolve_user(
+                self.context, user_principal_name
+            ).after_execute(_share, groups[share_option])
+
+        self.ensure_properties(
+            [
+                "Url",
+                "AssociatedVisitorGroup",
+                "AssociatedMemberGroup",
+                "AssociatedOwnerGroup",
+            ],
+            _web_resolved,
+        )
         return return_type
 
     def unshare(self):
-        """
-        Removes Sharing permissions on a Web
-
-        :rtype: SharingResult
-        """
+        """Removes Sharing permissions on a Web"""
         return_type = SharingResult(self.context)
 
         def _web_initialized():
@@ -1602,12 +1595,12 @@ class Web(SecurableObject):
         )
 
     def get_list_item(self, str_url):
+        # type: (str) -> ListItem
         """
         Returns the list item that is associated with the specified server-relative URL.
 
         :param str str_url: A string that contains the server-relative URL,
         for example, "/sites/MySite/Shared Documents/MyDocument.docx".
-        :return: ListItem
         """
         return ListItem(
             self.context,
@@ -1615,12 +1608,12 @@ class Web(SecurableObject):
         )
 
     def get_list_item_using_path(self, decoded_url):
+        # type: (str) -> ListItem
         """
         Returns the list item that is associated with the specified server-relative path.
 
         :param str decoded_url: A string that contains the server-relative path,
         for example, "/sites/MySite/Shared Documents/MyDocument.docx" or "Shared Documents/MyDocument.docx".
-        :return: ListItem
         """
         params = SPResPath.create_relative(self.context.base_url, decoded_url)
         return ListItem(
@@ -1639,6 +1632,7 @@ class Web(SecurableObject):
         )
 
     def page_context_info(self, include_odb_settings, emit_navigation_info):
+        # type: (bool, bool) -> ClientResult[AnyStr]
         """
         Return Page context info for the current list being rendered.
 
@@ -1794,6 +1788,7 @@ class Web(SecurableObject):
 
     @property
     def activities(self):
+        # type: () -> EntityCollection[SPActivityEntity]
         return self.properties.get(
             "Activities",
             EntityCollection(
@@ -1815,22 +1810,21 @@ class Web(SecurableObject):
 
     @property
     def allow_rss_feeds(self):
+        # type: () -> Optional[bool]
         """
         Gets a Boolean value that specifies whether the site collection allows RSS feeds.
-        :rtype: str
         """
         return self.properties.get("AllowRssFeeds", None)
 
     @property
     def alternate_css_url(self):
-        """Gets the URL for an alternate cascading style sheet (CSS) to use in the website.
-
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Gets the URL for an alternate cascading style sheet (CSS) to use in the website."""
         return self.properties.get("AlternateCssUrl", None)
 
     @property
     def app_instance_id(self):
+        # type: () -> Optional[str]
         """
         Specifies the identifier of the app instance that this site (2) represents. If this site (2) does not
         represent an app instance, then this MUST specify an empty GUID.
@@ -1848,31 +1842,25 @@ class Web(SecurableObject):
 
     @property
     def created(self):
-        """
-        Specifies when the site was created.
-        """
+        # type: () -> datetime.datetime
+        """Specifies when the site was created"""
         return self.properties.get("Created", datetime.datetime.min)
 
     @property
     def custom_master_url(self):
-        """Gets the URL for a custom master page to apply to the Web site
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the URL for a custom master page to apply to the Web site"""
         return self.properties.get("CustomMasterUrl", None)
 
     @property
     def custom_site_actions_disabled(self):
-        """
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
         return self.properties.get("CustomSiteActionsDisabled", None)
 
     @property
     def id(self):
-        """
-        Specifies the site identifier for the site
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Specifies the site identifier for the site"""
         return self.properties.get("Id", None)
 
     @property
@@ -1885,44 +1873,41 @@ class Web(SecurableObject):
 
     @property
     def access_request_list_url(self):
-        """
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
         return self.properties.get("AccessRequestListUrl", None)
 
     @property
     def allow_designer_for_current_user(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether the current user is allowed to use a designer application to customize this site
-        :rtype: bool or None
         """
         return self.properties.get("AllowDesignerForCurrentUser", None)
 
     @property
     def allow_master_page_editing_for_current_user(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether the current user is allowed to edit the master page.
-        :rtype: bool or None
         """
         return self.properties.get("AllowMasterPageEditingForCurrentUser", None)
 
     @property
     def allow_revert_from_template_for_current_user(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether the current user is allowed to revert the site (2) to a default site template.
-        :rtype: bool or None
         """
         return self.properties.get("AllowRevertFromTemplateForCurrentUser", None)
 
     @property
     def effective_base_permissions(self):
         """Specifies the effective permissions that are assigned to the current user"""
-        from office365.sharepoint.permissions.base_permissions import BasePermissions
-
         return self.properties.get("EffectiveBasePermissions", BasePermissions())
 
     @property
     def enable_minimal_download(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether the site will use the minimal download strategy by default.
 
@@ -1975,6 +1960,7 @@ class Web(SecurableObject):
 
     @property
     def onedrive_shared_items(self):
+        # type: () -> EntityCollection[SharedDocumentInfo]
         """"""
         return self.properties.get(
             "OneDriveSharedItems",
@@ -2027,6 +2013,7 @@ class Web(SecurableObject):
 
     @property
     def associated_visitor_group(self):
+        # type: () -> Group
         """Gets or sets the associated visitor group of the Web site."""
         return self.properties.get(
             "AssociatedVisitorGroup",
@@ -2037,6 +2024,7 @@ class Web(SecurableObject):
 
     @property
     def associated_owner_group(self):
+        # type: () -> Group
         """Gets or sets the associated owner group of the Web site."""
         return self.properties.get(
             "AssociatedOwnerGroup",
@@ -2047,6 +2035,7 @@ class Web(SecurableObject):
 
     @property
     def associated_member_group(self):
+        # type: () -> Group
         """Gets or sets the group of users who have been given contribute permissions to the Web site."""
         return self.properties.get(
             "AssociatedMemberGroup",
@@ -2209,10 +2198,8 @@ class Web(SecurableObject):
 
     @quick_launch_enabled.setter
     def quick_launch_enabled(self, value):
-        """Sets a value that specifies whether the Quick Launch area is enabled on the site.
-
-        :type value: bool
-        """
+        # type: (bool) -> None
+        """Sets a value that specifies whether the Quick Launch area is enabled on the site."""
         self.set_property("QuickLaunchEnabled", value)
 
     @property
@@ -2240,10 +2227,9 @@ class Web(SecurableObject):
 
     @is_multilingual.setter
     def is_multilingual(self, val):
+        # type: (bool) -> None
         """
         Sets whether Multilingual UI is turned on for this web or not.
-
-        :type val: bool
         """
         self.set_property("IsMultilingual", val)
 
@@ -2341,6 +2327,7 @@ class Web(SecurableObject):
 
     @property
     def available_content_types(self):
+        # type: () -> ContentTypeCollection
         """
         Specifies the collection of all site content types that apply to the current scope,
         including those of the current site (2), as well as any parent sites.
@@ -2364,19 +2351,14 @@ class Web(SecurableObject):
 
     @property
     def title(self):
-        """Gets the title of the web.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the title of the web."""
         return self.properties.get("Title", None)
 
     @property
     def welcome_page(self):
-        """
-        Specifies the URL of the Welcome page for the site
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the URL of the Welcome page for the site"""
         return self.properties.get("WelcomePage", None)
 
     @property
@@ -2386,11 +2368,8 @@ class Web(SecurableObject):
 
     @property
     def ui_version(self):
-        """
-        Gets or sets the user interface (UI) version of the Web site.
-
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Gets or sets the user interface (UI) version of the Web site."""
         return self.properties.get("UIVersion", None)
 
     @property
@@ -2405,13 +2384,12 @@ class Web(SecurableObject):
 
     @property
     def server_relative_path(self):
-        """
-        Gets the server-relative Path of the Web.
-        """
+        """Gets the server-relative Path of the Web."""
         return self.properties.get("ServerRelativePath", SPResPath())
 
     @property
     def syndication_enabled(self):
+        # type: () -> Optional[bool]
         """Specifies whether the [RSS2.0] feeds are enabled on the site"""
         return self.properties.get("SyndicationEnabled", None)
 
@@ -2427,6 +2405,7 @@ class Web(SecurableObject):
 
     @property
     def treeview_enabled(self):
+        # type: () -> Optional[bool]
         """Specifies whether the tree view is enabled on the site"""
         return self.properties.get("TreeViewEnabled", None)
 
@@ -2473,6 +2452,7 @@ class Web(SecurableObject):
         super(Web, self).set_property(name, value, persist_changes)
         if name == "Url":
             self._web_url = value
+            self._resource_path.patch(value)
         return self
 
     @property

office365/subscriptions/collection.py

@@ -3,7 +3,7 @@ from office365.runtime.queries.create_entity import CreateEntityQuery
 from office365.subscriptions.subscription import Subscription
 
 
-class SubscriptionCollection(EntityCollection):
+class SubscriptionCollection(EntityCollection[Subscription]):
     def __init__(self, context, resource_path=None):
         super(SubscriptionCollection, self).__init__(
             context, Subscription, resource_path