Merge branch 'O365:master' into docs_for_query

Author: RogerSelwyn

O365/__init__.py

@@ -1,17 +1,18 @@
 """
-A simple python library to interact with Microsoft Graph and Office 365 API
+A simple python library to interact with Microsoft Graph and other MS api
 """
+
 import warnings
 import sys
 
 from .__version__ import __version__
 
 from .account import Account
-from .connection import Connection, Protocol, MSGraphProtocol, MSOffice365Protocol
+from .connection import Connection, Protocol, MSGraphProtocol
 from .utils import FileSystemTokenBackend, EnvTokenBackend
 from .message import Message
 
 
 if sys.warnoptions:
     # allow Deprecation warnings to appear
-    warnings.simplefilter('always', DeprecationWarning)
+    warnings.simplefilter("always", DeprecationWarning)

O365/address_book.py

@@ -19,7 +19,7 @@
 
 
 class Contact(ApiComponent, AttachableMixin):
-    """ Contact manages lists of events on associated contact on office365. """
+    """ Contact manages lists of events on associated contact on Microsoft 365. """
 
     _endpoints = {
         'contact': '/contacts',

O365/calendar.py

@@ -1780,8 +1780,9 @@ def delete(self):
 
         return True
 
-    def get_events(self, limit=25, *, query=None, order_by=None, batch=None,
-                   download_attachments=False, include_recurring=True):
+    def get_events(self, limit: int = 25, *, query=None, order_by=None, batch=None,
+                   download_attachments=False, include_recurring=True,
+                   start_recurring=None, end_recurring=None):
         """ Get events from this Calendar
 
         :param int limit: max no. of events to get. Over 999 uses batch.
@@ -1793,6 +1794,8 @@ def get_events(self, limit=25, *, query=None, order_by=None, batch=None,
          batches allowing to retrieve more items than the limit.
         :param download_attachments: downloads event attachments
         :param bool include_recurring: whether to include recurring events or not
+        :param start_recurring: a string datetime or a Query object with just a start condition
+        :param end_recurring: a string datetime or a Query object with just an end condition
         :return: list of events in this calendar
         :rtype: list[Event] or Pagination
         """
@@ -1822,22 +1825,29 @@ def get_events(self, limit=25, *, query=None, order_by=None, batch=None,
         if include_recurring:
             start = None
             end = None
-            if query and not isinstance(query, str):
-                # extract start and end from query because
-                # those are required by a calendarView
-                start = query.get_filter_by_attribute('start/')
-                end = query.get_filter_by_attribute('start/')
-
-                if start:
-                    start = start.replace("'", '')  # remove the quotes
-                    query.remove_filter('start')
-                if end:
-                    end = end.replace("'", '')  # remove the quotes
-                    query.remove_filter('end')
-
+            if start_recurring is None:
+                pass
+            elif isinstance(start_recurring, str):
+                start = start_recurring
+            elif isinstance(start_recurring, dt.datetime):
+                start = start_recurring.isoformat()
+            else:
+                # it's a Query Object
+                start = start_recurring.get_filter_by_attribute('start/')
+            if end_recurring is None:
+                pass
+            elif isinstance(end_recurring, str):
+                end = end_recurring
+            elif isinstance(end_recurring, dt.datetime):
+                end = end_recurring.isoformat()
+            else:
+                # it's a Query Object
+                end = end_recurring.get_filter_by_attribute('end/')
             if start is None or end is None:
                 raise ValueError("When 'include_recurring' is True you must provide "
-                                 "a 'start' and 'end' datetime inside a 'Query' instance.")
+                                 "a 'start_recurring' and 'end_recurring' with a datetime string.")
+            start = start.replace("'", '')  # remove the quotes
+            end = end.replace("'", '')  # remove the quotes
 
             params[self._cc('startDateTime')] = start
             params[self._cc('endDateTime')] = end
@@ -2088,9 +2098,19 @@ def get_default_calendar(self):
         return self.calendar_constructor(parent=self,
                                          **{self._cloud_data_key: data})
 
-    def get_events(self, limit=25, *, query=None, order_by=None, batch=None,
-                   download_attachments=False, include_recurring=True):
-        """ Get events from the default Calendar
+    def get_events(
+        self,
+        limit=25,
+        *,
+        query=None,
+        order_by=None,
+        batch=None,
+        download_attachments=False,
+        include_recurring=True,
+        start_recurring=None,
+        end_recurring=None,
+    ):
+        """Get events from the default Calendar
 
         :param int limit: max no. of events to get. Over 999 uses batch.
         :param query: applies a OData filter to the request
@@ -2101,16 +2121,24 @@ def get_events(self, limit=25, *, query=None, order_by=None, batch=None,
          batches allowing to retrieve more items than the limit.
         :param bool download_attachments: downloads event attachments
         :param bool include_recurring: whether to include recurring events or not
+        :param start_recurring: a string datetime or a Query object with just a start condition
+        :param end_recurring: a string datetime or a Query object with just an end condition
         :return: list of items in this folder
         :rtype: list[Event] or Pagination
         """
 
         default_calendar = self.calendar_constructor(parent=self)
 
-        return default_calendar.get_events(limit=limit, query=query,
-                                           order_by=order_by, batch=batch,
-                                           download_attachments=download_attachments,
-                                           include_recurring=include_recurring)
+        return default_calendar.get_events(
+            limit=limit,
+            query=query,
+            order_by=order_by,
+            batch=batch,
+            download_attachments=download_attachments,
+            include_recurring=include_recurring,
+            start_recurring=start_recurring,
+            end_recurring=end_recurring,
+        )
 
     def new_event(self, subject=None):
         """ Returns a new (unsaved) Event object in the default calendar

O365/connection.py

@@ -34,7 +34,6 @@
 
 log = logging.getLogger(__name__)
 
-O365_API_VERSION: str = "v2.0"
 GRAPH_API_VERSION: str = "v1.0"
 OAUTH_REDIRECT_URL: str = "https://login.microsoftonline.com/common/oauth2/nativeclient"
 
@@ -193,8 +192,6 @@ def convert_case(self, key: str) -> str:
         When using Microsoft Graph API, the keywords of the API use
         lowerCamelCase Casing
 
-        When using Office 365 API, the keywords of the API use PascalCase Casing
-
         Default case in this API is lowerCamelCase
 
         :param  key: a dictionary key to convert
@@ -298,62 +295,9 @@ def timezone(self, timezone: Union[str, ZoneInfo]) -> None:
         )
 
 
-class MSOffice365Protocol(Protocol):
-    """A Microsoft Office 365 Protocol Implementation
-    https://docs.microsoft.com/en-us/outlook/rest/compare-graph-outlook
-    """
-
-    _protocol_url = "https://outlook.office.com/api/"
-    _oauth_scope_prefix = "https://outlook.office.com/"
-    _oauth_scopes = DEFAULT_SCOPES
-
-    def __init__(self, api_version: str = "v2.0", default_resource: Optional[str] = None, **kwargs):
-        """Create a new Office 365 protocol object
-
-        _protocol_url = 'https://outlook.office.com/api/'
-
-        _oauth_scope_prefix = 'https://outlook.office.com/'
-
-        :param str api_version: api version to use
-        :param str default_resource: the default resource to use when there is
-         nothing explicitly specified during the requests
-        """
-        super().__init__(
-            protocol_url=self._protocol_url,
-            api_version=api_version,
-            default_resource=default_resource,
-            casing_function=to_pascal_case,
-            protocol_scope_prefix=self._oauth_scope_prefix,
-            **kwargs,
-        )
-
-        self.keyword_data_store["message_type"] = "Microsoft.OutlookServices.Message"
-        self.keyword_data_store["event_message_type"] = (
-            "Microsoft.OutlookServices.EventMessage"
-        )
-        self.keyword_data_store["file_attachment_type"] = (
-            "#Microsoft.OutlookServices.FileAttachment"
-        )
-        self.keyword_data_store["item_attachment_type"] = (
-            "#Microsoft.OutlookServices.ItemAttachment"
-        )
-        self.keyword_data_store["prefer_timezone_header"] = (
-            f'outlook.timezone="{get_windows_tz(self.timezone)}"'
-        )
-        #: The max value for 'top' (999).  |br| **Type:** str
-        self.max_top_value = 999  # Max $top parameter value
-
-    @Protocol.timezone.setter
-    def timezone(self, timezone: Union[str, ZoneInfo]) -> None:
-        super()._update_timezone(timezone)
-        self.keyword_data_store["prefer_timezone_header"] = (
-            f'outlook.timezone="{get_windows_tz(self._timezone)}"'
-        )
-
-
 class MSBusinessCentral365Protocol(Protocol):
     """A Microsoft Business Central Protocol Implementation
-    https://docs.microsoft.com/en-us/dynamics-nav/api-reference/v1.0/endpoints-apis-for-dynamics
+    https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v1.0/
     """
 
     _protocol_url = "https://api.businesscentral.dynamics.com/"

O365/excel.py

@@ -9,7 +9,6 @@
 import re
 from urllib.parse import quote
 
-from .connection import MSOffice365Protocol
 from .drive import File
 from .utils import ApiComponent, TrackerSet, to_snake_case
 
@@ -2066,11 +2065,6 @@ def __init__(self, file_item, *, use_session=True, persist=True):
         ):
             raise ValueError("This file is not a valid Excel xlsx file.")
 
-        if isinstance(file_item.protocol, MSOffice365Protocol):
-            raise ValueError(
-                "Excel capabilities are only allowed on the MSGraph protocol"
-            )
-
         # append the workbook path
         main_resource = "{}{}/workbook".format(
             file_item.main_resource,

O365/groups.py

@@ -7,7 +7,7 @@
 
 
 class Group(ApiComponent):
-    """ A Microsoft O365 group """
+    """ A Microsoft 365 group """
 
     _endpoints = {
             'get_group_owners': '/groups/{group_id}/owners',
@@ -17,7 +17,7 @@ class Group(ApiComponent):
     member_constructor = User  #: :meta private:
 
     def __init__(self, *, parent=None, con=None, **kwargs):
-        """ A Microsoft O365 group
+        """ A Microsoft 365 group
 
         :param parent: parent object
         :type parent: Teams
@@ -156,7 +156,7 @@ def __repr__(self):
         return 'Microsoft O365 Group parent class'
 
     def get_group_by_id(self, group_id = None):
-        """ Returns Microsoft O365/AD group with given id
+        """ Returns Microsoft 365/AD group with given id
 
         :param group_id: group id of group
 
@@ -181,7 +181,7 @@ def get_group_by_id(self, group_id = None):
         return self.group_constructor(parent=self, **{self._cloud_data_key: data})
 
     def get_group_by_mail(self, group_mail=None):
-        """Returns Microsoft O365/AD group by mail field
+        """Returns Microsoft 365/AD group by mail field
 
         :param group_name: mail of group
 

O365/message.py

@@ -1160,16 +1160,8 @@ def save_draft(self, target_folder=OutlookWellKnowFolderNames.DRAFTS):
             self.object_id = message.get(self._cc('id'), None)
             self.folder_id = message.get(self._cc('parentFolderId'), None)
 
-            # fallback to office365 v1.0
-            self.__created = message.get(self._cc('createdDateTime'),
-                                         message.get(
-                                             self._cc('dateTimeCreated'),
-                                             None))
-            # fallback to office365 v1.0
-            self.__modified = message.get(self._cc('lastModifiedDateTime'),
-                                          message.get(
-                                              self._cc('dateTimeModified'),
-                                              None))
+            self.__created = message.get(self._cc('createdDateTime'),None)
+            self.__modified = message.get(self._cc('lastModifiedDateTime'),None)
 
             self.__created = parse(self.__created).astimezone(
                 self.protocol.timezone) if self.__created else None

O365/planner.py

@@ -12,7 +12,7 @@ class TaskDetails(ApiComponent):
     _endpoints = {"task_detail": "/planner/tasks/{id}/details"}
 
     def __init__(self, *, parent=None, con=None, **kwargs):
-        """A Microsoft O365 plan details
+        """A Microsoft 365 plan details
 
         :param parent: parent object
         :type parent: Task
@@ -180,7 +180,7 @@ class PlanDetails(ApiComponent):
     _endpoints = {"plan_detail": "/planner/plans/{id}/details"}
 
     def __init__(self, *, parent=None, con=None, **kwargs):
-        """A Microsoft O365 plan details
+        """A Microsoft 365 plan details
 
         :param parent: parent object
         :type parent: Plan
@@ -386,7 +386,7 @@ def __eq__(self, other):
         return self.object_id == other.object_id
 
     def get_details(self):
-        """Returns Microsoft O365/AD plan with given id
+        """Returns Microsoft 365/AD plan with given id
 
         :rtype: PlanDetails
         """
@@ -507,7 +507,7 @@ class Bucket(ApiComponent):
     task_constructor = Task  #: :meta private:
 
     def __init__(self, *, parent=None, con=None, **kwargs):
-        """A Microsoft O365 bucket
+        """A Microsoft 365 bucket
 
         :param parent: parent object
         :type parent: Planner or Plan
@@ -751,7 +751,7 @@ class Plan(ApiComponent):
     plan_details_constructor = PlanDetails  #: :meta private:
 
     def __init__(self, *, parent=None, con=None, **kwargs):
-        """A Microsoft O365 plan
+        """A Microsoft 365 plan
 
         :param parent: parent object
         :type parent: Planner
@@ -861,7 +861,7 @@ def list_tasks(self):
             return tasks
 
     def get_details(self):
-        """Returns Microsoft O365/AD plan with given id
+        """Returns Microsoft 365/AD plan with given id
 
         :rtype: PlanDetails
         """
@@ -1040,7 +1040,7 @@ def get_my_tasks(self, *args):
         ]
 
     def get_plan_by_id(self, plan_id=None):
-        """Returns Microsoft O365/AD plan with given id
+        """Returns Microsoft 365/AD plan with given id
 
         :param plan_id: plan id of plan
 
@@ -1067,7 +1067,7 @@ def get_plan_by_id(self, plan_id=None):
         )
 
     def get_bucket_by_id(self, bucket_id=None):
-        """Returns Microsoft O365/AD plan with given id
+        """Returns Microsoft 365/AD plan with given id
 
         :param bucket_id: bucket id of buckets
 
@@ -1091,7 +1091,7 @@ def get_bucket_by_id(self, bucket_id=None):
         return self.bucket_constructor(parent=self, **{self._cloud_data_key: data})
 
     def get_task_by_id(self, task_id=None):
-        """Returns Microsoft O365/AD plan with given id
+        """Returns Microsoft 365/AD plan with given id
 
         :param task_id: task id of tasks
 
@@ -1115,7 +1115,7 @@ def get_task_by_id(self, task_id=None):
         return self.task_constructor(parent=self, **{self._cloud_data_key: data})
 
     def list_user_tasks(self, user_id=None):
-        """Returns Microsoft O365/AD plan with given id
+        """Returns Microsoft 365/AD plan with given id
 
         :param user_id: user id