Office365-REST-Python-Client 2.5.10__py3-none-any.whl → 2.5.12__py3-none-any.whl

office365/sharepoint/directory/helper.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
@@ -16,6 +18,7 @@ class SPHelper(Entity):
 
     @staticmethod
     def is_member_of(context, principal_name, group_id, result=None):
+        # type: (ClientContext, str, str, Optional[ClientResult[bool]]) -> ClientResult[bool]
         """
         :param str principal_name: User principal name
         :param str group_id: Group id
@@ -34,10 +37,7 @@ class SPHelper(Entity):
     @staticmethod
     def check_site_availability(context, site_url):
         # type: (ClientContext, str) -> ClientResult[bool]
-        """
-        :param str site_url: Site Url
-        :param office365.sharepoint.client_context.ClientContext context: SharePoint context
-        """
+        """ """
         return_type = ClientResult(context)
         qry = ServiceOperationQuery(
             SPHelper(context),
@@ -121,6 +121,7 @@ class SPHelper(Entity):
 
     @staticmethod
     def get_owners(context, group_id, return_type=None):
+        # type: (ClientContext, str, Optional[EntityCollection[User]]) -> SPHelper
         """
         :param str group_id: Group identifier
         :param office365.sharepoint.client_context.ClientContext context: SharePoint context
@@ -137,6 +138,7 @@ class SPHelper(Entity):
 
     @staticmethod
     def remove_external_members(context, group_id):
+        # type: (ClientContext, str) -> SPHelper
         """
         :param str group_id: Group identifier
         :param office365.sharepoint.client_context.ClientContext context: SharePoint context

office365/sharepoint/documentmanagement/document_set.py

@@ -21,16 +21,9 @@ class DocumentSet(Folder):
 
         return_type = DocumentSet(context)
 
-        def _parent_folder_loaded():
-            custom_props = parent_folder.get_property("Properties")
-            list_id = custom_props.get("vti_x005f_listname")
-            target_list = context.web.lists.get_by_id(list_id)
-            target_list.ensure_property("Title", _create, target_list=target_list)
-
         def _create(target_list):
             # type: (List) -> None
             qry = ClientQuery(context, return_type=return_type)
-            context.add_query(qry)
             folder_url = parent_folder.serverRelativeUrl + "/" + name
             return_type.set_property("ServerRelativeUrl", folder_url)
 
@@ -43,7 +36,13 @@ class DocumentSet(Folder):
                 request.set_header("Slug", "{0}|{1}".format(folder_url, ct_id))
                 request.method = HttpMethod.Post
 
-            context.before_execute(_construct_request)
+            context.add_query(qry).before_query_execute(_construct_request)
+
+        def _parent_folder_loaded():
+            custom_props = parent_folder.get_property("Properties")
+            list_id = custom_props.get("vti_x005f_listname")
+            target_list = context.web.lists.get_by_id(list_id)
+            target_list.ensure_property("Title", _create, target_list=target_list)
 
         parent_folder.ensure_properties(
             ["UniqueId", "Properties", "ServerRelativeUrl"], _parent_folder_loaded

office365/sharepoint/entity.py

@@ -1,10 +1,11 @@
-from typing import TYPE_CHECKING, Callable
+from typing import TYPE_CHECKING, Callable, List
 
 from typing_extensions import Self
 
 from office365.runtime.auth.client_credential import ClientCredential
 from office365.runtime.auth.user_credential import UserCredential
 from office365.runtime.client_object import ClientObject
+from office365.runtime.client_result import ClientResult
 from office365.runtime.paths.v3.entity import EntityPath
 from office365.runtime.queries.delete_entity import DeleteEntityQuery
 from office365.runtime.queries.update_entity import UpdateEntityQuery
@@ -22,13 +23,13 @@ class Entity(ClientObject):
         return self
 
     def execute_batch(self, items_per_batch=100, success_callback=None):
-        # type: (int, Callable[[int], None]) -> Self
+        # type: (int, Callable[[List[ClientObject|ClientResult]], None]) -> Self
         """Construct and submit to a server a batch request"""
         return self.context.execute_batch(items_per_batch, success_callback)
 
     def with_credentials(self, credentials):
         # type: (UserCredential|ClientCredential) -> Self
-        """ """
+        """Initializes a client to acquire a token via user or client credentials"""
         self.context.with_credentials(credentials)
         return self
 

office365/sharepoint/fields/builtin_field_id.py

@@ -9,3 +9,22 @@ class SPBuiltInFieldId:
 
     FSObjType = "FSObjType"
     """Identifies a field that contains information about the file system type"""
+
+    FileType = "FileType"
+    """Identifies a field that contains information about the file type for version history of the specified
+    SharePoint Foundation library picture object."""
+
+    FirstName = "FirstName"
+    """Identifies a field that contains the first name for the specified SharePoint Foundation contact object."""
+
+    FormData = "FormData"
+    """Identifies a field that contains the FormData property for the specified
+    Microsoft SharePoint Foundation contact object."""
+
+    FormURN = "FormURN"
+    """Identifies a field that contains the FormURN property for the specified
+    Microsoft SharePoint Foundation contact object."""
+
+    fRecurrence = "fRecurrence"
+    """Identifies a field that contains information about the recurrence field of the specified SharePoint Foundation
+    calendar event object."""

office365/sharepoint/fields/choice.py

@@ -1,5 +1,5 @@
-from office365.sharepoint.fields.field import Field
+from office365.sharepoint.fields.multi_choice import FieldMultiChoice
 
 
-class FieldChoice(Field):
+class FieldChoice(FieldMultiChoice):
     """Represents a choice field control."""

office365/sharepoint/fields/collection.py

@@ -222,9 +222,7 @@ class FieldCollection(EntityCollection[Field]):
 
         :type field_create_information: office365.sharepoint.fields.creation_information.FieldCreationInformation
         """
-        return_type = Field.create_field_from_type(
-            self.context, field_create_information
-        )
+        return_type = Field.create_field(self.context, field_create_information)
         self.add_child(return_type)
         qry = CreateEntityQuery(self, return_type, return_type)
         self.context.add_query(qry)

office365/sharepoint/fields/field.py

@@ -14,8 +14,11 @@ class Field(Entity):
     def __init__(self, context, resource_path=None):
         super(Field, self).__init__(context, resource_path)
 
+    def __str__(self):
+        return self.title or self.entity_type_name
+
     def __repr__(self):
-        return self.internal_name or self.id
+        return self.internal_name or self.id or self.entity_type_name
 
     @staticmethod
     def resolve_field_type(type_id_or_name):
@@ -63,7 +66,7 @@ class Field(Entity):
                 return Field
 
     @staticmethod
-    def create_field_from_type(context, field_parameters):
+    def create_field(context, field_parameters):
         """
         Creates a field based on its type
 

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/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/pages/collection.py

@@ -62,7 +62,7 @@ class SitePageCollection(SitePageMetadataCollection[SitePage]):
         return return_type
 
     def get_page_column_state(self, url):
-        """ "
+        """
         Determines whether a specific SitePage is a single or multicolumn page.
 
         :param str url: URL of the SitePage for which to return state.

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/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/recent_admin_action_report.py

@@ -4,10 +4,10 @@ from office365.runtime.client_value import ClientValue
 class RecentAdminActionReport(ClientValue):
     """ """
 
-    def __init__(self, actions=None, createdByEmail=None):
+    def __init__(self, actions=None, created_by_email=None):
         # type: (str, str) -> None
         self.actions = actions
-        self.createdByEmail = createdByEmail
+        self.createdByEmail = created_by_email
 
     @property
     def entity_type_name(self):

office365/sharepoint/tenant/administration/tenant.py

@@ -319,11 +319,57 @@ 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, list_name):
+        # type: (str) -> ClientResult[int]
+        """ """
+        return_type = ClientResult(self.context)
+        payload = {"listName": list_name}
+        qry = ServiceOperationQuery(
+            self, "GetSPListItemCount", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def get_sp_list_root_folder_properties(self, list_name):
+        # type: (str) -> ClientResult[dict]
+        """ """
+        return_type = ClientResult(self.context)
+        payload = {"listName": list_name}
+        qry = ServiceOperationQuery(
+            self, "GetSPListRootFolderProperties", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def get_spo_all_web_templates(self, culture_name=None, compatibility_level=None):
+        # type: (str, int) -> SPOTenantWebTemplateCollection
+        """ """
+        return_type = SPOTenantWebTemplateCollection(self.context)
+        payload = {
+            "cultureName": culture_name,
+            "compatibilityLevel": compatibility_level,
+        }
+        qry = ServiceOperationQuery(
+            self, "GetSPOAllWebTemplates", 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.
-        """
-        return_type = ClientResult(self.context)  # type: ClientResult[bool]
+        # type: () -> ClientResult[bool]
+        """Checks whether a tenant has the Intune license."""
+        return_type = ClientResult(self.context)
         qry = ServiceOperationQuery(
             self, "CheckTenantIntuneLicense", None, None, None, return_type
         )