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

office365/outlook/mail/messages/message.py

@@ -1,7 +1,7 @@
 import os
 import uuid
 from datetime import datetime
-from typing import IO, AnyStr, Optional
+from typing import IO, AnyStr, List, Optional
 
 from typing_extensions import Self
 
@@ -42,6 +42,7 @@ class Message(OutlookItem):
         return self
 
     def create_forward(self, to_recipients=None, message=None, comment=None):
+        # type: (List[Recipient], "Message", str) -> Message
         """
         Create a draft to forward an existing message, in either JSON or MIME format.
 
@@ -373,9 +374,7 @@ class Message(OutlookItem):
     @property
     def subject(self):
         # type: () -> Optional[str]
-        """
-        The subject of the message.
-        """
+        """The subject of the message."""
         return self.properties.get("subject", None)
 
     @subject.setter

office365/runtime/auth/providers/saml_token_provider.py

@@ -40,7 +40,7 @@ def is_valid_auth_cookies(values):
 
 
 class SamlTokenProvider(AuthenticationProvider, office365.logger.LoggerContext):
-    def __init__(self, url, username, password, browser_mode, environment='commercial'):
+    def __init__(self, url, username, password, browser_mode, environment="commercial"):
         """
         SAML Security Token Service provider (claims-based authentication)
 
@@ -281,9 +281,9 @@ class SamlTokenProvider(AuthenticationProvider, office365.logger.LoggerContext):
         if not federated or self._browser_mode:
             headers = {"Content-Type": "application/x-www-form-urlencoded"}
             if self._browser_mode:
-                headers[
-                    "User-Agent"
-                ] = "Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; WOW64; Trident/5.0)"
+                headers["User-Agent"] = (
+                    "Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; WOW64; Trident/5.0)"
+                )
             session.post(
                 self._sts_profile.signin_page_url, data=security_token, headers=headers
             )

office365/runtime/http/request_options.py

@@ -1,20 +1,22 @@
+from typing import Any
+
 from office365.runtime.http.http_method import HttpMethod
 
 
 class RequestOptions(object):
     """Request options"""
 
-    def __init__(self, url):
+    def __init__(self, url, method=HttpMethod.Get, data=None):
         """
         Request options
 
         :param str url: URL for the new :class:`requests.Request` object
         """
         self.url = url
-        self.data = None
+        self.data = data
         self.headers = {}
         self.auth = None
-        self.method = HttpMethod.Get
+        self.method = method
         self.verify = True
         self.stream = False
         self.proxies = None
@@ -28,8 +30,10 @@ class RequestOptions(object):
         return hasattr(self.data, "decode") and callable(self.data.decode)
 
     def set_header(self, name, value):
+        # type: (str, Any) -> None
         self.headers[name] = value
 
     def ensure_header(self, name, value):
+        # type: (str, Any) -> None
         if name not in self.headers:
             self.headers[name] = value

office365/runtime/queries/create_entity.py

@@ -1,16 +1,14 @@
+from typing import Dict
+
+from office365.runtime.client_object import ClientObject
+from office365.runtime.client_value import ClientValue
 from office365.runtime.queries.client_query import ClientQuery
 
 
 class CreateEntityQuery(ClientQuery):
     def __init__(self, parent_entity, parameters, return_type=None):
-        """
-        Create entity query
-
-        :type return_type: office365.runtime.client_object.ClientObject
-        :type parameters: office365.runtime.client_object.ClientObject or office365.runtime.client_value.ClientValue
-            or dict
-        :type parent_entity: office365.runtime.client_object.ClientObject
-        """
+        # type: (ClientObject, ClientObject|ClientValue|Dict, ClientObject) -> None
+        """Create entity query"""
         super(CreateEntityQuery, self).__init__(
             parent_entity.context, parent_entity, parameters, None, return_type
         )

office365/runtime/queries/update_entity.py

@@ -1,13 +1,11 @@
+from office365.runtime.client_object import ClientObject
 from office365.runtime.queries.client_query import ClientQuery
 
 
 class UpdateEntityQuery(ClientQuery):
     def __init__(self, update_type):
-        """
-        Update client object query
-
-        :type update_type: office365.runtime.client_object.ClientObject
-        """
+        # type: (ClientObject) -> None
+        """Update client object query"""
         super(UpdateEntityQuery, self).__init__(
             update_type.context, update_type, update_type
         )

office365/sharepoint/attachments/attachment.py

@@ -1,6 +1,9 @@
-from typing import AnyStr, Optional
+from typing import IO, AnyStr, Optional
+
+from typing_extensions import Self
 
 from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.function import FunctionQuery
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.internal.queries.upload_file import create_upload_file_query
@@ -42,6 +45,14 @@ class Attachment(Entity):
             self.ensure_property("ServerRelativeUrl", _download_file_by_url)
         return self
 
+    def get_content(self):
+        # type: () -> ClientResult[AnyStr]
+        """Gets the raw contents of attachment"""
+        return_type = ClientResult(self.context)
+        qry = FunctionQuery(self, "$value", None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
     def recycle_object(self):
         """Move this attachment to site recycle bin."""
         qry = ServiceOperationQuery(self, "RecycleObject")
@@ -49,6 +60,7 @@ class Attachment(Entity):
         return self
 
     def upload(self, file_object, use_path=True):
+        # type: (IO, bool) -> Self
         """
         Upload attachment into list item
 
@@ -90,7 +102,7 @@ class Attachment(Entity):
     @property
     def server_relative_url(self):
         # type: () -> Optional[str]
-        """ """
+        """The server-relative-url of the attachment"""
         return self.properties.get("ServerRelativeUrl", None)
 
     @property

office365/sharepoint/attachments/collection.py

@@ -1,6 +1,10 @@
 import os
-from typing import IO, AnyStr
+from functools import partial
+from typing import IO, AnyStr, Callable, Optional
 
+from typing_extensions import Self
+
+from office365.runtime.client_result import ClientResult
 from office365.runtime.paths.service_operation import ServiceOperationPath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.attachments.attachment import Attachment
@@ -74,11 +78,30 @@ class AttachmentCollection(EntityCollection[Attachment]):
         self.get().after_execute(_delete_all)
         return self
 
+    def download(self, download_file, file_downloaded=None):
+        # type: (IO, Optional[Callable[[Attachment], None]]) -> Self
+        """Downloads attachments as a zip file"""
+        import zipfile
+
+        def _file_downloaded(attachment_file, result):
+            # type: (Attachment, ClientResult[AnyStr]) -> None
+            with zipfile.ZipFile(download_file.name, "a", zipfile.ZIP_DEFLATED) as zf:
+                zf.writestr(attachment_file.file_name, result.value)
+                if callable(file_downloaded):
+                    file_downloaded(attachment_file)
+
+        def _download(return_type):
+            for attachment_file in return_type:
+                attachment_file.get_content().after_execute(
+                    partial(_file_downloaded, attachment_file)
+                )
+
+        self.get().after_execute(_download)
+        return self
+
     def upload(self, file, use_path=True):
         # type: (IO, bool) -> Attachment
-        """
-        Uploads the attachment
-        """
+        """Uploads the attachment"""
         info = AttachmentCreationInformation(os.path.basename(file.name), file.read())
         if use_path:
             return self.add_using_path(info.filename, info.content)

office365/sharepoint/changes/app_consent_principal.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.changes.change import Change
+
+
+class ChangeAppConsentPrincipal(Change):
+    """"""

office365/sharepoint/changes/file.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.changes.change import Change
 
 
@@ -6,10 +8,12 @@ class ChangeFile(Change):
 
     @property
     def unique_id(self):
+        # type: () -> Optional[str]
         """Identifies the file that changed."""
         return self.properties.get("UniqueId", None)
 
     @property
     def web_id(self):
+        # type: () -> Optional[str]
         """Identifies the site that contains the changed file."""
         return self.properties.get("WebId", None)

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/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/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):
         """