Office365-REST-Python-Client 2.5.10__py3-none-any.whl → 2.5.12__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/calendar/sharing/message_action.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class CalendarSharingMessageAction(ClientValue):
+    """"""

office365/outlook/calendar/sharing_message.py

@@ -1,5 +1,24 @@
+from office365.outlook.calendar.sharing.message_action import (
+    CalendarSharingMessageAction,
+)
 from office365.outlook.mail.messages.message import Message
 
 
 class CalendarSharingMessage(Message):
     """"""
+
+    @property
+    def sharing_message_action(self):
+        """"""
+        return self.properties.setdefault(
+            "sharingMessageAction", CalendarSharingMessageAction()
+        )
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_type_mapping = {
+                "sharingMessageAction": self.sharing_message_action,
+            }
+            default_value = property_type_mapping.get(name, None)
+
+        return super(CalendarSharingMessage, self).get_property(name, default_value)

office365/outlook/calendar/timezones/custom.py

@@ -5,3 +5,12 @@ class CustomTimeZone(TimeZoneBase):
     """
     Represents a time zone where the transition from standard to daylight saving time, or vice versa is not standard.
     """
+
+    def __init__(self, bias=None):
+        """
+        :param int bias: The time offset of the time zone from Coordinated Universal Time (UTC). This value is in
+            minutes. Time zones that are ahead of UTC have a positive offset; time zones that are behind UTC have
+            a negative offset.
+        """
+        super(CustomTimeZone, self).__init__()
+        self.bias = bias

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

@@ -1,3 +1,4 @@
+from office365.outlook.calendar.dateTimeTimeZone import DateTimeTimeZone
 from office365.runtime.client_value import ClientValue
 
 
@@ -12,6 +13,9 @@ class AutomaticRepliesSetting(ClientValue):
         external_audience=None,
         external_reply_message=None,
         internal_reply_message=None,
+        scheduled_end_datetime=DateTimeTimeZone(),
+        scheduled_start_datetime=DateTimeTimeZone(),
+        status=None,
     ):
         """
         :param str external_audience: The set of audience external to the signed-in user's organization who will
@@ -25,3 +29,6 @@ class AutomaticRepliesSetting(ClientValue):
         self.externalAudience = external_audience
         self.externalReplyMessage = external_reply_message
         self.internalReplyMessage = internal_reply_message
+        self.scheduledEndDateTime = scheduled_end_datetime
+        self.scheduledStartDateTime = scheduled_start_datetime
+        self.status = status

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/outlook/mail/messages/rules/predicates.py

@@ -15,6 +15,8 @@ class MessageRulePredicates(ClientValue):
         from_addresses=None,
         has_attachments=None,
         header_contains=None,
+        importance=None,
+        is_approval_request=None,
     ):
         """
         :param list[str] body_contains: Represents the strings that should appear in the body of an incoming message
@@ -28,6 +30,7 @@ class MessageRulePredicates(ClientValue):
         :param bool has_attachments: Indicates whether an incoming message must have attachments in order for the
              condition or exception to apply.
         :param list[str] header_contains:
+        :param bool is_approval_request:
         """
         self.bodyContains = StringCollection(body_contains)
         self.bodyOrSubjectContains = StringCollection(body_or_subject_contains)
@@ -35,3 +38,5 @@ class MessageRulePredicates(ClientValue):
         self.fromAddresses = ClientValueCollection(Recipient, from_addresses)
         self.hasAttachments = has_attachments
         self.headerContains = StringCollection(header_contains)
+        self.importance = importance
+        self.isApprovalRequest = is_approval_request

office365/outlook/mail/messages/rules/rule.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.outlook.mail.messages.rules.actions import MessageRuleActions
 from office365.outlook.mail.messages.rules.predicates import MessageRulePredicates
@@ -26,7 +28,6 @@ class MessageRule(Entity):
 
     @property
     def is_read_only(self):
-        """
-        Indicates if the rule is read-only and cannot be modified or deleted by the rules REST API.
-        """
+        # type: () -> Optional[bool]
+        """Indicates if the rule is read-only and cannot be modified or deleted by the rules REST API."""
         return self.properties.get("isReadOnly", None)

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/odata/query_options.py

@@ -59,6 +59,9 @@ class QueryOptions(object):
                 ClientObjectCollection,
             )
 
+            if name in query_options.select:
+                continue
+
             if isinstance(client_object, ClientObjectCollection):
                 prop = client_object.create_typed_object().get_property(name)
             else:

office365/runtime/queries/batch.py

@@ -61,3 +61,7 @@ class BatchQuery(ClientQuery):
     @property
     def url(self):
         return "{0}/$batch".format(self.context.service_root_url())
+
+    @property
+    def return_type(self):
+        return [q.return_type for q in self._queries]

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/appprincipal/identity_provider.py

@@ -1,3 +1,4 @@
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
 
@@ -6,4 +7,9 @@ class AppPrincipalIdentityProvider(Entity):
 
     @staticmethod
     def external(context):
-        pass
+        return_type = AppPrincipalIdentityProvider(context)
+        qry = ServiceOperationQuery(
+            return_type, "External", None, None, None, return_type, True
+        )
+        context.add_query(qry)
+        return return_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/client_context.py

@@ -8,6 +8,7 @@ from office365.runtime.auth.authentication_context import AuthenticationContext
 from office365.runtime.auth.client_credential import ClientCredential
 from office365.runtime.auth.token_response import TokenResponse
 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.client_runtime_context import ClientRuntimeContext
 from office365.runtime.compat import get_absolute_url, urlparse
@@ -197,11 +198,11 @@ class ClientContext(ClientRuntimeContext):
         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
         :param int items_per_batch: Maximum to be selected for bulk operation
-        :param (int)-> None success_callback: A callback
+        :param (List[ClientObject|ClientResult])-> None success_callback: A success callback
         """
         batch_request = ODataBatchV3Request(JsonLightFormat())
         batch_request.beforeExecute += self._authenticate_request
@@ -210,7 +211,7 @@ class ClientContext(ClientRuntimeContext):
             qry = self._get_next_query(items_per_batch)
             batch_request.execute_query(qry)
             if callable(success_callback):
-                success_callback(items_per_batch)
+                success_callback(qry.return_type)
         return self
 
     def pending_request(self):

office365/sharepoint/directory/group.py

@@ -7,41 +7,41 @@ from office365.sharepoint.entity_collection import EntityCollection
 class Group(Entity):
     def get_members_info(self, row_limit):
         """"""
-        result = MembersInfo(self.context)
+        return_type = MembersInfo(self.context)
 
         def _user_loaded():
             from office365.sharepoint.directory.helper import SPHelper
 
             SPHelper.get_members_info(
-                self.context, self.properties["Id"], row_limit, result
+                self.context, self.properties["Id"], row_limit, return_type
             )
 
         self.ensure_property("Id", _user_loaded)
-        return result
+        return return_type
 
     def get_members(self):
         """"""
         from office365.directory.users.user import User
 
-        members = EntityCollection(self.context, User)
+        return_type = EntityCollection(self.context, User)
 
         def _group_loaded():
-            SPHelper.get_members(self.context, self.properties["Id"], members)
+            SPHelper.get_members(self.context, self.properties["Id"], return_type)
 
         self.ensure_property("Id", _group_loaded)
-        return members
+        return return_type
 
     def get_owners(self):
         """"""
         from office365.directory.users.user import User
 
-        owners = EntityCollection(self.context, User)
+        return_type = EntityCollection(self.context, User)
 
         def _group_loaded():
-            SPHelper.get_owners(self.context, self.properties["Id"], owners)
+            SPHelper.get_owners(self.context, self.properties["Id"], return_type)
 
         self.ensure_property("Id", _group_loaded)
-        return owners
+        return return_type
 
     @property
     def entity_type_name(self):