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

office365/onedrive/workbooks/filter_criteria.py

@@ -4,7 +4,14 @@ from office365.runtime.client_value import ClientValue
 class WorkbookFilterCriteria(ClientValue):
     """Represents the filtering criteria applied to a column."""
 
-    def __init__(self, operator=None, values=None):
-        """ """
+    def __init__(self, color=None, dynamicCriteria=None, operator=None, values=None):
+        """
+        :param str color:  The color applied to the cell.
+        :param str dynamicCriteria:  A dynamic formula specified in a custom filter.
+        :param str operator: An operator in a cell; for example, =, >, <, <=, or <>.
+        :param list values: The values that appear in the cell.
+        """
+        self.color = color
+        self.dynamicCriteria = dynamicCriteria
         self.operator = operator
         self.values = values

office365/onedrive/workbooks/tables/rows/collection.py

@@ -1,5 +1,7 @@
 from office365.entity_collection import EntityCollection
 from office365.onedrive.workbooks.tables.rows.row import WorkbookTableRow
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.function import FunctionQuery
 
 
 class WorkbookTableRowCollection(EntityCollection[WorkbookTableRow]):
@@ -25,3 +27,21 @@ class WorkbookTableRowCollection(EntityCollection[WorkbookTableRow]):
              Any rows below the inserted row are shifted downwards. Zero-indexed.
         """
         return super(WorkbookTableRowCollection, self).add(values=values, index=index)
+
+    def count(self):
+        """"""
+        return_type = ClientResult(self.context, int())
+        qry = FunctionQuery(self, "count", None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def item_at(self, index):
+        # type: (int) -> WorkbookTableRow
+        """Gets a row based on its position in the collection.
+        :param int index: Index value of the object to be retrieved. Zero-indexed.
+        """
+        return_type = WorkbookTableRow(self.context)
+        self.add_child(return_type)
+        qry = FunctionQuery(self, "itemAt", [index], return_type)
+        self.context.add_query(qry)
+        return return_type

office365/onedrive/workbooks/tables/rows/row.py

@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import List, Optional
 
 from office365.entity import Entity
 
@@ -14,6 +14,7 @@ class WorkbookTableRow(Entity):
 
     @property
     def values(self):
+        # type: () -> Optional[List]
         """
         Represents the raw values of the specified range. The data returned could be of type string, number,
         or a boolean. Cell that contain an error will return the error string.

office365/onedrive/workbooks/workbook.py

@@ -1,3 +1,5 @@
+from typing_extensions import Self
+
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.onedrive.workbooks.applications.application import WorkbookApplication
@@ -50,20 +52,21 @@ class Workbook(Entity):
         return return_type
 
     def refresh_session(self, session_id):
+        # type: (str) -> Self
         """Use this API to refresh an existing workbook session.
         :param str session_id: Identifier of the workbook session
         """
-        qry = ServiceOperationQuery(self, "refreshSession")
-        self.context.add_query(qry)
 
         def _construct_request(request):
             # type: (RequestOptions) -> None
             request.set_header("workbook-session-id", session_id)
 
-        self.context.before_execute(_construct_request)
+        qry = ServiceOperationQuery(self, "refreshSession")
+        self.context.add_query(qry).before_query_execute(_construct_request)
         return self
 
     def close_session(self, session_id):
+        # type: (str) -> Self
         """Use this API to close an existing workbook session.
         :param str session_id: Identifier of the workbook session
         """
@@ -73,8 +76,7 @@ class Workbook(Entity):
             # type: (RequestOptions) -> None
             request.set_header("workbook-session-id", session_id)
 
-        self.context.before_execute(_construct_request)
-        self.context.add_query(qry)
+        self.context.add_query(qry).before_query_execute(_construct_request)
         return self
 
     @property

office365/onenote/internal/multipart_page_query.py

@@ -3,6 +3,7 @@ from typing import AnyStr
 
 from office365.runtime.compat import get_mime_type, message_as_bytes_or_string
 from office365.runtime.http.http_method import HttpMethod
+from office365.runtime.http.request_options import RequestOptions
 from office365.runtime.queries.batch import create_boundary
 from office365.runtime.queries.client_query import ClientQuery
 
@@ -32,9 +33,7 @@ class OneNotePageCreateQuery(ClientQuery):
         self._files = attachment_files
 
     def _construct_multipart_request(self, request):
-        """
-        :type request: office365.runtime.http.request_options.RequestOptions
-        """
+        # type: (RequestOptions) -> None
         request.method = HttpMethod.Post
         boundary = create_boundary("PageBoundary", True)
         request.set_header(

office365/outlook/category.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 
 
@@ -6,13 +8,18 @@ class OutlookCategory(Entity):
     The user defines categories in a master list, and can apply one or more
     of these user-defined categories to an item."""
 
+    def __str__(self):
+        return self.display_name or self.entity_type_name
+
     @property
     def color(self):
+        # type: () -> Optional[str]
         """A pre-set color constant that characterizes a category, and that is mapped to one of 25 predefined colors"""
         return self.properties.get("color", None)
 
     @property
     def display_name(self):
+        # type: () -> Optional[str]
         """A unique name that identifies a category in the user's mailbox.
         After a category is created, the name cannot be changed"""
         return self.properties.get("displayName", None)

office365/outlook/mail/item_body.py

@@ -6,7 +6,6 @@ class ItemBody(ClientValue):
 
     def __init__(self, content=None, content_type="Text"):
         """
-
         :param str content: The content of the item.
         :param str content_type: The type of the content. Possible values are text and html.
         """
@@ -14,5 +13,15 @@ class ItemBody(ClientValue):
         self.content = content
         self.contentType = content_type
 
+    @staticmethod
+    def text(content):
+        # type: (str) -> "ItemBody"
+        return ItemBody(content)
+
+    @staticmethod
+    def html(content):
+        # type: (str) -> "ItemBody"
+        return ItemBody(content, "html")
+
     def __repr__(self):
         return self.content

office365/outlook/mail/messages/collection.py

@@ -1,3 +1,5 @@
+from typing import List
+
 from office365.delta_collection import DeltaCollection
 from office365.outlook.mail.item_body import ItemBody
 from office365.outlook.mail.messages.message import Message
@@ -10,6 +12,7 @@ class MessageCollection(DeltaCollection[Message]):
         super(MessageCollection, self).__init__(context, Message, resource_path)
 
     def add(self, subject=None, body=None, to_recipients=None, **kwargs):
+        # type: (str, str|ItemBody, List[str], ...) -> Message
         """
         Create a draft of a new message in either JSON or MIME format.
 

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

@@ -3,6 +3,7 @@ from __future__ import annotations
 import datetime
 from typing import TYPE_CHECKING, Any, Callable, Generic, List, Optional, TypeVar
 
+from requests import Response
 from typing_extensions import Self
 
 from office365.runtime.client_runtime_context import ClientRuntimeContext
@@ -80,10 +81,10 @@ class ClientObject(Generic[T]):
         self.context.before_execute(action)
         return self
 
-    def after_execute(self, action, execute_first=False):
-        # type: (Callable[[Self], None], bool) -> Self
+    def after_execute(self, action, execute_first=False, include_response=False):
+        # type: (Callable[[Self|Response], None], bool, bool) -> Self
         """Attach an event handler to client object which gets triggered after query is submitted to server"""
-        self.context.after_query_execute(action, execute_first)
+        self.context.after_query_execute(action, execute_first, include_response)
         return self
 
     def get(self):

office365/runtime/client_request.py

@@ -35,7 +35,6 @@ class ClientRequest(object):
         try:
             request = self.build_request(query)
             response = self.execute_request_direct(request)
-            response.raise_for_status()
             self.process_response(response, query)
             self.afterExecute.notify(response)
         except HTTPError as e:
@@ -99,4 +98,5 @@ class ClientRequest(object):
                 stream=request.stream,
                 proxies=request.proxies,
             )
+        response.raise_for_status()
         return response

office365/runtime/client_runtime_context.py

@@ -126,8 +126,8 @@ class ClientRuntimeContext(object):
         self.pending_request().beforeExecute += _process_request
         return self
 
-    def after_query_execute(self, action, execute_first=False):
-        # type: (Callable[[T], None], bool) -> Self
+    def after_query_execute(self, action, execute_first=False, include_response=False):
+        # type: (Callable[[T|Response], None], bool, bool) -> Self
         """Attach an event handler which is triggered after query is submitted to server"""
         if len(self._queries) == 0:
             return
@@ -138,7 +138,7 @@ class ClientRuntimeContext(object):
             resp.raise_for_status()
             if self.current_query.id == query.id:
                 self.pending_request().afterExecute -= _process_response
-                action(query.return_type)
+                action(resp if include_response else query.return_type)
 
         self.pending_request().afterExecute += _process_response
 

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/paths/resource_path.py

@@ -27,6 +27,9 @@ class ResourcePath(object):
     def __str__(self):
         return self.to_url()
 
+    def __eq__(self, other):
+        return self.to_url() == other.to_url()
+
     def to_url(self):
         # type: () -> str
         """Builds url"""

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/businessdata/infrastructure/securestore/connection_settings.py

@@ -1,8 +1,30 @@
+from typing import Optional
+
+from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.entity import Entity
 
 
 class ConnectionSettings(Entity):
-    """"""
+    """The ConnectionSettings contains information about an endpoint (4) that can be used to connect to it."""
+
+    def __init__(self, context, resource_path=None):
+        if resource_path is None:
+            resource_path = ResourcePath(
+                "Microsoft.BusinessData.Infrastructure.SecureStore.ConnectionSettings"
+            )
+        super(ConnectionSettings, self).__init__(context, resource_path)
+
+    @property
+    def authentication_mode(self):
+        # type: () -> Optional[str]
+        """The authentication mode used by the endpoint"""
+        return self.properties.get("AuthenticationMode", None)
+
+    @property
+    def parent_name(self):
+        # type: () -> Optional[str]
+        """The unique name used to identify the parent of the endpoint"""
+        return self.properties.get("parentName", None)
 
     @property
     def entity_type_name(self):

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/directory/membership_result.py

@@ -1,7 +1,12 @@
+from office365.runtime.types.collections import StringCollection
 from office365.sharepoint.entity import Entity
 
 
 class MembershipResult(Entity):
+    @property
+    def groups_list(self):
+        return self.properties.get("GroupsList", StringCollection())
+
     @property
     def entity_type_name(self):
         return "SP.Directory.MembershipResult"

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

@@ -16,6 +16,11 @@ if TYPE_CHECKING:
 class Entity(ClientObject):
     """SharePoint specific entity"""
 
+    def execute_query_with_incremental_retry(self, max_retry=5):
+        """Handles throttling requests."""
+        self.context.execute_query_with_incremental_retry(max_retry)
+        return self
+
     def execute_batch(self, items_per_batch=100, success_callback=None):
         # type: (int, Callable[[int], None]) -> Self
         """Construct and submit to a server a batch request"""

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