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

office365/sharepoint/files/file.py

@@ -684,7 +684,7 @@ class File(AbstractFile):
                         chunk_downloaded(bytes_read)
                     file_object.write(chunk)
 
-            self.context.add_query(qry).before_execute(
+            self.context.add_query(qry).before_query_execute(
                 _construct_request
             ).after_execute(_process_response)
 

office365/sharepoint/internal/queries/upload_file.py

@@ -1,20 +1,24 @@
+from typing import IO, TYPE_CHECKING
+
 from office365.runtime.http.http_method import HttpMethod
+from office365.runtime.http.request_options import RequestOptions
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 
+if TYPE_CHECKING:
+    from office365.sharepoint.attachments.attachment import Attachment
+    from office365.sharepoint.files.file import File
 
-def create_upload_file_query(file, file_object):
-    """
-    Constructs upload file content query
 
-    :type file: office365.sharepoint.files.file.File
-    :type file_object: typing.IO
-    """
+def create_upload_file_query(file, file_object):
+    # type: (File|Attachment, IO) -> ServiceOperationQuery
+    """Constructs upload file content query"""
     qry = ServiceOperationQuery(file, "$value")
 
-    def _construct_upload_request(request):
+    def _construct_request(request):
+        # type: (RequestOptions) -> None
         request.data = file_object.read()
         request.method = HttpMethod.Post
         request.set_header("X-HTTP-Method", "PUT")
 
-    file.context.before_execute(_construct_upload_request)
+    file.context.before_execute(_construct_request)
     return qry

office365/sharepoint/lists/list.py

@@ -1,6 +1,6 @@
 import os
 from datetime import datetime
-from typing import TYPE_CHECKING, AnyStr, Optional
+from typing import TYPE_CHECKING, AnyStr, Dict, Optional
 
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
@@ -182,11 +182,12 @@ class List(SecurableObject):
         return return_type
 
     def get_site_script(self, options=None):
+        # type: (Dict) -> ClientResult[str]
         """Creates site script syntax
 
         :param dict or None options:
         """
-        return_type = ClientResult(self.context)  # type: ClientResult[str]
+        return_type = ClientResult(self.context)
 
         def _list_loaded():
             list_abs_path = SPResPath.create_absolute(

office365/sharepoint/navigation/node.py

@@ -15,13 +15,14 @@ class NavigationNode(Entity):
     """
 
     def __str__(self):
-        return self.title
+        return self.title or self.entity_type_name
 
     def __repr__(self):
-        return self.url
+        return self.url or self.entity_type_name
 
     @property
     def children(self):
+        # type: () -> NavigationNodeCollection
         """Gets the collection of child nodes of the navigation node."""
         return self.properties.get(
             "Children",
@@ -49,6 +50,7 @@ class NavigationNode(Entity):
 
     @url.setter
     def url(self, value):
+        # type: (str) -> None
         """Sets a value that specifies the URL stored with the navigation node."""
         self.set_property("Url", value)
 

office365/sharepoint/packaging/app_details.py

@@ -1,7 +1,41 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
 class AppDetails(Entity):
+    """Specifies the detail properties for a SharePoint Add-in."""
+
+    @property
+    def eula_url(self):
+        # type: () -> Optional[str]
+        """Specifies the URL to get the End User License Agreement (EULA) information for the SharePoint Add-in."""
+        return self.properties.get("EulaUrl", None)
+
+    @property
+    def privacy_url(self):
+        # type: () -> Optional[str]
+        """Specifies the URL of the privacy statement for the SharePoint Add-in."""
+        return self.properties.get("PrivacyUrl", None)
+
+    @property
+    def publisher(self):
+        # type: () -> Optional[str]
+        """Specifies the publisher name for the SharePoint Add-in."""
+        return self.properties.get("Publisher", None)
+
+    @property
+    def short_description(self):
+        # type: () -> Optional[str]
+        """Specifies a short description for the SharePoint Add-in."""
+        return self.properties.get("ShortDescription", None)
+
+    @property
+    def support_url(self):
+        # type: () -> Optional[str]
+        """Specifies the URL of the support page for the SharePoint Add-in."""
+        return self.properties.get("SupportUrl", None)
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Packaging.AppDetails"

office365/sharepoint/policy/dlp_policy_tip.py

@@ -1,3 +1,6 @@
+from datetime import datetime
+from typing import Optional
+
 from office365.runtime.types.collections import StringCollection
 from office365.sharepoint.entity import Entity
 
@@ -7,23 +10,27 @@ class DlpPolicyTip(Entity):
 
     @property
     def applied_actions_text(self):
+        # type: () -> Optional[str]
         """Specifies the text which states what restrictive actions have been applied to this item."""
         return self.properties.get("AppliedActionsText", None)
 
     @property
     def compliance_url(self):
+        # type: () -> Optional[str]
         """Specifies the URL that provides additional help on the policy tip dialog."""
         return self.properties.get("ComplianceUrl", None)
 
     @property
     def general_text(self):
+        # type: () -> Optional[str]
         """General text that appears on the top of the policy tip dialog."""
         return self.properties.get("GeneralText", None)
 
     @property
     def last_processed_time(self):
+        # type: () -> Optional[datetime]
         """The last time this item was processed for policy matches."""
-        return self.properties.get("LastProcessedTime", None)
+        return self.properties.get("LastProcessedTime", datetime.min)
 
     @property
     def matched_condition_descriptions(self):
@@ -37,5 +44,6 @@ class DlpPolicyTip(Entity):
 
     @property
     def two_letter_iso_language_name(self):
+        # type: () -> Optional[str]
         """The two-letter language code of the generated policy tip detail."""
         return self.properties.get("TwoLetterISOLanguageName", None)

office365/sharepoint/portal/sites/manager.py

@@ -80,7 +80,7 @@ class SPSiteManager(Entity):
             request.method = HttpMethod.Get
             request.url += "?url='{0}'".format(site_url)
 
-        self.context.add_query(qry).before_execute(_construct_request)
+        self.context.add_query(qry).before_query_execute(_construct_request)
         return response
 
     def get_site_url(self, site_id):

office365/sharepoint/principal/principal.py

@@ -11,7 +11,12 @@ class Principal(Entity):
         return self.title or self.entity_type_name
 
     def __repr__(self):
-        return self.user_principal_name or self.id or self.entity_type_name
+        return (
+            self.user_principal_name
+            or self.login_name
+            or self.id
+            or self.entity_type_name
+        )
 
     @property
     def id(self):
@@ -55,6 +60,10 @@ class Principal(Entity):
         """Gets the type of the principal."""
         return self.properties.get("PrincipalType", None)
 
+    @property
+    def property_ref_name(self):
+        return "Id"
+
     def set_property(self, name, value, persist_changes=True):
         super(Principal, self).set_property(name, value, persist_changes)
         # fallback: create a new resource path

office365/sharepoint/principal/users/collection.py

@@ -19,9 +19,7 @@ class UserCollection(EntityCollection[User]):
         self.add_child(return_type)
 
         def _create_and_add_query(login_name):
-            """
-            :type login_name: str
-            """
+            # type: (str) -> None
             return_type.set_property("LoginName", login_name)
             qry = CreateEntityQuery(self, return_type, return_type)
             self.context.add_query(qry)

office365/sharepoint/publishing/sites/communication/site.py

@@ -1,5 +1,6 @@
 from office365.runtime.client_result import ClientResult
 from office365.runtime.http.http_method import HttpMethod
+from office365.runtime.http.request_options import RequestOptions
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.publishing.sites.communication.creation_request import (
@@ -61,13 +62,13 @@ class CommunicationSite(Entity):
         qry = ServiceOperationQuery(
             self, "Status", None, {"url": site_url}, None, response
         )
-        self.context.add_query(qry)
 
-        def _construct_status_request(request):
+        def _construct_request(request):
+            # type: (RequestOptions) -> None
             request.method = HttpMethod.Get
             request.url += "?url='{0}'".format(site_url)
 
-        self.context.before_execute(_construct_status_request)
+        self.context.add_query(qry).before_query_execute(_construct_request)
         return response
 
     def enable(self, design_package_id):

office365/sharepoint/request.py

@@ -1,7 +1,39 @@
+from typing import Optional
+
+from requests import Response
+from typing_extensions import Self
+
+from office365.runtime.auth.authentication_context import AuthenticationContext
+from office365.runtime.auth.client_credential import ClientCredential
+from office365.runtime.auth.user_credential import UserCredential
+from office365.runtime.http.request_options import RequestOptions
 from office365.runtime.odata.request import ODataRequest
 from office365.runtime.odata.v3.json_light_format import JsonLightFormat
 
 
 class SharePointRequest(ODataRequest):
-    def __init__(self):
+    def __init__(self, base_url):
         super().__init__(JsonLightFormat())
+        self._auth_context = AuthenticationContext(url=base_url)
+        self.beforeExecute += self._authenticate_request
+
+    def execute_request(self, path):
+        # type: (str) -> Response
+        request_url = "{0}/_api/{1}".format(self._auth_context.url, path)
+        return self.execute_request_direct(RequestOptions(request_url))
+
+    def with_credentials(self, credentials, environment="commercial"):
+        # type: (UserCredential|ClientCredential, Optional[str]) -> Self
+        """
+        Initializes a client to acquire a token via user or client credentials
+        :type credentials: UserCredential or ClientCredential
+        :param str environment: The Office 365 Cloud Environment endpoint used for authentication
+            defaults to 'commercial'.
+        """
+        self._auth_context.with_credentials(credentials, environment=environment)
+        return self
+
+    def _authenticate_request(self, request):
+        # type: (RequestOptions) -> None
+        """Authenticate request"""
+        self._auth_context.authenticate_request(request)

office365/sharepoint/search/service.py

@@ -1,3 +1,5 @@
+from typing import Any, List
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
@@ -162,6 +164,7 @@ class SearchService(Entity):
         row_limit=None,
         **kwargs
     ):
+        # type: (str, List[str], bool, int, Any) -> ClientResult[SearchResult]
         """The operation is used to retrieve search results through the use of the HTTP protocol
         with method type POST.
 
@@ -172,9 +175,7 @@ class SearchService(Entity):
         :param int row_limit: The number of search results the protocol client wants to receive, starting at the index
             specified in the StartRow element. The RowLimit value MUST be greater than or equal to zero.
         """
-        return_type = ClientResult(
-            self.context, SearchResult()
-        )  # type: ClientResult[SearchResult]
+        return_type = ClientResult(self.context, SearchResult())
         request = SearchRequest(
             query_text=query_text,
             select_properties=select_properties,
@@ -211,6 +212,7 @@ class SearchService(Entity):
         return self
 
     def search_center_url(self):
+        # type: () -> ClientResult[str]
         """The operation is used to get the URI address of the search center by using the HTTP protocol
         with the GET method. The operation returns the URI of the of the search center.
         """

office365/sharepoint/sharing/information.py

@@ -22,6 +22,11 @@ class SharingInformation(Entity):
         """
         return self.properties.get("accessRequestSettings", AccessRequestSettings())
 
+    @property
+    def anonymous_link_expiration_restriction_days(self):
+        """Tenant's anonymous link expiration restriction in days."""
+        return self.properties.get("anonymousLinkExpirationRestrictionDays", None)
+
     @property
     def permissions_information(self):
         """

office365/sharepoint/sharing/permission_collection.py

@@ -14,25 +14,29 @@ class PermissionCollection(ClientValue):
 
     def __init__(
         self,
-        hasInheritedLinks=None,
+        app_consent_principals=None,
+        has_inherited_links=None,
         links=None,
         principals=None,
-        siteAdmins=None,
-        totalNumberOfPrincipals=None,
+        site_admins=None,
+        total_number_of_principals=None,
     ):
         """
-        :param bool hasInheritedLinks:
+        :param bool has_inherited_links:
         :param list[LinkInfo] links: The List of tokenized sharing links with their LinkInfo objects.
         :param list[PrincipalInfo] principals: The List of Principals with their roles on this list item.
-        :param list[PrincipalInfo] siteAdmins: The List of Principals who are Site Admins. This property is returned
+        :param list[PrincipalInfo] site_admins: The List of Principals who are Site Admins. This property is returned
             only if the caller is an Auditor.
-        :param int totalNumberOfPrincipals:
+        :param int total_number_of_principals:
         """
-        self.hasInheritedLinks = hasInheritedLinks
+        self.appConsentPrincipals = ClientValueCollection(
+            PrincipalInfo, app_consent_principals
+        )
+        self.hasInheritedLinks = has_inherited_links
         self.links = ClientValueCollection(LinkInfo, links)
         self.principals = ClientValueCollection(PrincipalInfo, principals)
-        self.siteAdmins = ClientValueCollection(PrincipalInfo, siteAdmins)
-        self.totalNumberOfPrincipals = totalNumberOfPrincipals
+        self.siteAdmins = ClientValueCollection(PrincipalInfo, site_admins)
+        self.totalNumberOfPrincipals = total_number_of_principals
 
     @property
     def entity_type_name(self):

office365/sharepoint/sharing/recipient_limits.py

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

office365/sharepoint/sharing/site_sharing_report_helper.py

@@ -1,5 +1,6 @@
 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.sharing.reports.site_capabilities import (
     SiteSharingReportCapabilities,
@@ -12,9 +13,7 @@ from office365.sharepoint.sharing.site_sharing_report_status import (
 class SiteSharingReportHelper(Entity):
     @staticmethod
     def cancel_sharing_report_job(context):
-        """
-        :type context: office365.sharepoint.client_context.ClientContext
-        """
+        # type: (ClientContext) -> ClientResult[SiteSharingReportStatus]
         return_type = ClientResult(context, SiteSharingReportStatus())
         binding_type = SiteSharingReportHelper(context)
         qry = ServiceOperationQuery(

office365/sharepoint/tenant/administration/tenant.py

@@ -319,6 +319,28 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def get_ransomware_activities(self):
+        # type: () -> ClientResult[AnyStr]
+        """ """
+        return_type = ClientResult(self.context)
+        payload = {"parameters": RenderListDataParameters()}
+        qry = ServiceOperationQuery(
+            self, "GetRansomwareActivities", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def get_sp_list_item_count(self, listName):
+        # type: (str) -> ClientResult[int]
+        """ """
+        return_type = ClientResult(self.context)
+        payload = {"listName": listName}
+        qry = ServiceOperationQuery(
+            self, "GetSPListItemCount", None, payload, 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.

office365/sharepoint/tenant/management/office365_tenant.py

@@ -1,5 +1,7 @@
 from typing import Optional
 
+from typing_extensions import Self
+
 from office365.runtime.client_object_collection import ClientObjectCollection
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
@@ -104,6 +106,22 @@ class Office365Tenant(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def set_block_download_file_type_policy_data(
+        self, blockDownloadFileTypePolicy, fileTypeIds, excludedBlockDownloadGroupIds
+    ):
+        # type: (bool, list[int], list[str]) -> Self
+        """"""
+        payload = {
+            "blockDownloadFileTypePolicy": blockDownloadFileTypePolicy,
+            "fileTypeIds": fileTypeIds,
+            "excludedBlockDownloadGroupIds": excludedBlockDownloadGroupIds,
+        }
+        qry = ServiceOperationQuery(
+            self, "SetBlockDownloadFileTypePolicyData", None, payload
+        )
+        self.context.add_query(qry)
+        return self
+
     def set_tenant_cdn_enabled(self, cdn_type, is_enabled):
         """
         Enables or disables Public content delivery network (CDN) or Private CDN on the tenant level.

office365/sharepoint/userprofiles/profile_loader.py

@@ -47,9 +47,7 @@ class ProfileLoader(ClientObject):
         return return_type
 
     def get_user_profile(self):
-        """
-        The GetUserProfile method returns the user profile for the current user.
-        """
+        """The GetUserProfile method returns the user profile for the current user."""
         result = UserProfile(
             self.context, ResourcePath("GetUserProfile", self.resource_path)
         )

office365/sharepoint/userprofiles/user_profile.py

@@ -1,3 +1,4 @@
+from datetime import datetime
 from typing import Optional
 
 from office365.runtime.client_result import ClientResult
@@ -12,6 +13,12 @@ class UserProfile(Entity):
     """The UserProfile class stores the profile of the individual user, which includes properties such
     as the user's account name, preferred name, and email address."""
 
+    def __str__(self):
+        return self.display_name or self.entity_type_name
+
+    def __repr__(self):
+        return self.account_name or self.entity_type_name
+
     @property
     def account_name(self):
         # type: () -> Optional[str]
@@ -25,19 +32,85 @@ class UserProfile(Entity):
         return self.properties.get("DisplayName", None)
 
     @property
-    def my_site_host_url(self):
+    def follow_personal_site_url(self):
         # type: () -> Optional[str]
+        """The FollowPersonalSiteUrl property specifies the URL to allow the current user to create a personal site.
+        If there is no hybrid & cross-geo setting, it will return the same value as UrlToCreatePersonalSite,
+        otherwise a URL to allow the current user to create a personal site on the remote host.
         """
-        Specifies the URL for the personal site of the current user.
-        """
+        return self.properties.get("FollowPersonalSiteUrl", None)
+
+    @property
+    def is_default_document_library_blocked(self):
+        # type: () -> Optional[bool]
+        """If true, indicates that the access of the user to the default document library in the user’s OneDrive
+        is blocked."""
+        return self.properties.get("IsDefaultDocumentLibraryBlocked", None)
+
+    @property
+    def is_people_list_public(self):
+        # type: () -> Optional[bool]
+        """Specifies whether the list of people that the user is following is public."""
+        return self.properties.get("IsPeopleListPublic", None)
+
+    @property
+    def is_privacy_setting_on(self):
+        # type: () -> Optional[bool]
+        """Specifies whether the privacy setting has been set for the site."""
+        return self.properties.get("IsPrivacySettingOn", None)
+
+    @property
+    def is_self(self):
+        # type: () -> Optional[bool]
+        """Specifies whether the user profile is for the current user."""
+        return self.properties.get("IsSelf", None)
+
+    @property
+    def job_title(self):
+        # type: () -> Optional[str]
+        """Specifies the job title of the user."""
+        return self.properties.get("JobTitle", None)
+
+    @property
+    def my_site_first_run_experience(self):
+        # type: () -> Optional[int]
+        """Specifies the personal site First Run flag of the user."""
+        return self.properties.get("MySiteFirstRunExperience", None)
+
+    @property
+    def my_site_host_url(self):
+        # type: () -> Optional[str]
+        """Specifies the URL for the personal site of the current user."""
         return self.properties.get("MySiteHostUrl", None)
 
+    @property
+    def o15_first_run_experience(self):
+        # type: () -> Optional[int]
+        """Specifies the First Run flag of the user."""
+        return self.properties.get("O15FirstRunExperience", None)
+
+    @property
+    def personal_site_capabilities(self):
+        # type: () -> Optional[int]
+        """The PersonalSiteCapabilities property specifies attributes of the user's personal site."""
+        return self.properties.get("PersonalSiteCapabilities", None)
+
+    @property
+    def personal_site_first_creation_error(self):
+        # type: () -> Optional[str]
+        """Specifies the failure for the personal site first creation attempt."""
+        return self.properties.get("PersonalSiteFirstCreationError", None)
+
+    @property
+    def personal_site_first_creation_time(self):
+        # type: () -> Optional[datetime]
+        """Specifies the time for the personal site first creation attempt."""
+        return self.properties.get("PersonalSiteFirstCreationTime", datetime.min)
+
     @property
     def public_url(self):
         # type: () -> Optional[str]
-        """
-        Specifies the public URL for the personal site of the current user.
-        """
+        """Specifies the public URL for the personal site of the current user."""
         return self.properties.get("PublicUrl", None)
 
     @property
@@ -120,6 +193,7 @@ class UserProfile(Entity):
             property_mapping = {
                 "FollowedContent": self.followed_content,
                 "PersonalSite": self.personal_site,
+                "PersonalSiteFirstCreationTime": self.personal_site_first_creation_time,
             }
             default_value = property_mapping.get(name, None)
         return super(UserProfile, self).get_property(name, default_value)