Outlook API new types and methods

Author: vgrem

examples/auth/interactive.py

@@ -17,4 +17,4 @@
 me = client.me.get().execute_query()
 print("Welcome,  {0}!".format(me.given_name))
 site = client.sites.root.get().execute_query()
-print("Site Url:  {0}!".format(site.web_url))
+print("Site Url:  {0}".format(site.web_url))

office365/directory/identitygovernance/workflow/__init__.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class WorkflowBase(Entity):
+    """An abstract type that exposes the properties for configuring a custom lifecycle workflow."""

office365/directory/identitygovernance/workflow/base.py

@@ -3,3 +3,15 @@
 
 class SynchronizationProgress(ClientValue):
     """Represents the progress of a synchronizationJob toward completion."""
+
+    def __init__(
+        self,
+        completed_units=None,
+        progress_observation_date_time=None,
+        total_units=None,
+        units=None,
+    ):
+        self.completedUnits = completed_units
+        self.progressObservationDateTime = progress_observation_date_time
+        self.totalUnits = total_units
+        self.units = units

office365/directory/synchronization/progress.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class UserInsightsSettings(Entity):
+    """"""

office365/directory/users/insights_settings.py

@@ -1,3 +1,7 @@
+from typing import Optional
+
+from office365.directory.users.insights_settings import UserInsightsSettings
+from office365.directory.users.storage import UserStorage
 from office365.entity import Entity
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.teams.schedule.shifts.preferences import ShiftPreferences
@@ -6,6 +10,41 @@
 class UserSettings(Entity):
     """The current user settings for content discovery."""
 
+    @property
+    def contribution_to_content_discovery_as_organization_disabled(self):
+        # type: () -> Optional[bool]
+        """Reflects the organization level setting controlling delegate access to the trending API.
+        When set to true, the organization doesn't have access to Office Delve. The relevancy of the content
+        displayed in Microsoft 365, for example in Suggested sites in SharePoint Home and the Discover view in
+        OneDrive for work or school is affected for the whole organization. This setting is read-only and can only
+        be changed by administrators in the SharePoint admin center."""
+        return self.properties.get(
+            "contributionToContentDiscoveryAsOrganizationDisabled", None
+        )
+
+    @property
+    def contribution_to_content_discovery_disabled(self):
+        # type: () -> Optional[bool]
+        """When set to true, the delegate access to the user's trending API is disabled.
+        When set to true, documents in the user's Office Delve are disabled. When set to true, the relevancy of
+        the content displayed in Microsoft 365, for example in Suggested sites in SharePoint Home and the
+        Discover view in OneDrive for work or school is affected. Users can control this setting in Office Delve
+        """
+        return self.properties.get("contributionToContentDiscoveryDisabled", None)
+
+    @property
+    def item_insights(self):
+        # type: () -> UserInsightsSettings
+        """The user's settings for the visibility of meeting hour insights, and insights derived between
+        a user and other items in Microsoft 365, such as documents or sites.
+        Get userInsightsSettings through this navigation property."""
+        return self.properties.get(
+            "itemInsights",
+            UserInsightsSettings(
+                self.context, ResourcePath("itemInsights", self.resource_path)
+            ),
+        )
+
     @property
     def shift_preferences(self):
         # type: () -> ShiftPreferences
@@ -16,8 +55,19 @@ def shift_preferences(self):
             ),
         )
 
+    @property
+    def storage(self):
+        # type: () -> ShiftPreferences
+        return self.properties.get(
+            "storage",
+            UserStorage(self.context, ResourcePath("storage", self.resource_path)),
+        )
+
     def get_property(self, name, default_value=None):
         if default_value is None:
-            property_mapping = {"shiftPreferences": self.shift_preferences}
+            property_mapping = {
+                "itemInsights": self.item_insights,
+                "shiftPreferences": self.shift_preferences,
+            }
             default_value = property_mapping.get(name, None)
         return super(UserSettings, self).get_property(name, default_value)

office365/directory/users/settings.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class UserStorage(Entity):
+    """"""

office365/directory/users/storage.py

@@ -1,5 +1,7 @@
 from typing import TYPE_CHECKING, Any, Optional, Type, TypeVar
 
+from typing_extensions import Self
+
 from office365.entity import Entity
 from office365.runtime.client_object_collection import ClientObjectCollection
 from office365.runtime.compat import is_string_type
@@ -21,6 +23,17 @@ def __init__(self, context, item_type, resource_path=None, parent=None):
         super(EntityCollection, self).__init__(
             context, item_type, resource_path, parent
         )
+        self._delta_request_url = None
+
+    def token(self, value):
+        """
+        Apply delta query
+
+        :param str value: If unspecified, enumerates the hierarchy's current state. If latest, returns empty
+            response with latest delta token. If a previous delta token, returns new state since that token.
+        """
+        self.query_options.custom["token"] = value
+        return self
 
     def __getitem__(self, key):
         # type: (int | str) -> T
@@ -58,6 +71,14 @@ def create_typed_object(self, initial_properties=None, resource_path=None):
             initial_properties, resource_path
         )
 
+    def set_property(self, key, value, persist_changes=False):
+        # type: (str | int, dict, bool) -> Self
+        if key == "__deltaLinkUrl":
+            self._delta_request_url = value
+        else:
+            super(EntityCollection, self).set_property(key, value, persist_changes)
+        return self
+
     @property
     def context(self):
         # type: () -> GraphClient

office365/entity_collection.py

@@ -7,7 +7,7 @@
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.outlook.mail.messages.collection import MessageCollection
-from office365.outlook.mail.messages.rules.rule import MessageRule
+from office365.outlook.mail.messages.rules.collection import MessageRuleCollection
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 
@@ -116,13 +116,12 @@ def child_folders(self):
 
     @property
     def message_rules(self):
-        # type: () -> EntityCollection[MessageRule]
+        # type: () -> MessageRuleCollection
         """"""
         return self.properties.get(
             "messageRules",
-            EntityCollection(
+            MessageRuleCollection(
                 self.context,
-                MessageRule,
                 ResourcePath("messageRules", self.resource_path),
             ),
         )

office365/outlook/mail/folders/folder.py

@@ -0,0 +1,26 @@
+from office365.entity_collection import EntityCollection
+from office365.outlook.mail.messages.rules.rule import MessageRule
+
+
+class MessageRuleCollection(EntityCollection[MessageRule]):
+    def __init__(self, context, resource_path=None):
+        super(MessageRuleCollection, self).__init__(context, MessageRule, resource_path)
+
+    def add(self, display_name, sequence, actions, **kwargs):
+        """
+        Create a messageRule object by specifying a set of conditions and actions.
+        Outlook carries out those actions if an incoming message in the user's Inbox meets the specified conditions.
+        This API is available in the following national cloud deployments.
+
+        :param str display_name: The display name of the rule.
+        :param int sequence: Indicates the order in which the rule is executed, among other rules.
+        :param MessageRuleActions actions: Actions to be taken on a message when the corresponding conditions,
+            if any, are fulfilled.
+        """
+        props = {
+            "displayName": display_name,
+            "sequence": sequence,
+            "actions": actions.to_json(),
+            **kwargs,
+        }
+        return super(MessageRuleCollection, self).add(**props)

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

@@ -234,7 +234,7 @@ def parent(self):
     @property
     def has_next(self):
         # type: () -> bool
-        """"""
+        """Determines whether the collection contains a next page of data."""
         return self._next_request_url is not None
 
     @property

office365/runtime/client_object_collection.py

@@ -961,6 +961,7 @@ def get_client_side_components_by_id(self, component_ids=None):
         return return_type
 
     def get_file_by_server_relative_url(self, server_relative_url):
+        # type: (str) -> File
         """
         Returns the file object located at the specified server-relative URL, for example:
             - "/sites/MySite/Shared Documents/MyDocument.docx"
@@ -978,6 +979,7 @@ def get_file_by_server_relative_url(self, server_relative_url):
         )
 
     def get_file_by_server_relative_path(self, path):
+        # type: (str) -> File
         """Returns the file object located at the specified server-relative path, for example:
             - "/sites/MySite/Shared Documents/MyDocument.docx"
             - "Shared Documents/MyDocument.docx"
@@ -995,6 +997,7 @@ def get_file_by_server_relative_path(self, path):
         )
 
     def get_folder_by_server_relative_url(self, url):
+        # type: (str) -> Folder
         """Returns the folder object located at the specified server-relative URL.
 
         :param str url: Specifies the server-relative URL for the folder.
@@ -1008,6 +1011,7 @@ def get_folder_by_server_relative_url(self, url):
         )
 
     def get_folder_by_server_relative_path(self, decoded_url):
+        # type: (str) -> Folder
         """Returns the folder object located at the specified server-relative URL, for example:
              - "/sites/MySite/Shared Documents"
              - "Shared Documents"

office365/sharepoint/webs/web.py

@@ -15,7 +15,7 @@ def setUpClass(cls):
         super(TestServicePrincipal, cls).setUpClass()
         app_name = create_unique_name("App")
         cls.target_app = cls.client.applications.add(
-            display_name=app_name
+            displayName=app_name
         ).execute_query()
 
     @classmethod

tests/directory/test_service_principal.py

@@ -44,3 +44,11 @@ def test5_shared_with_me(self):
     # def test6_list_bundles(self):
     #    result = self.client.me.drive.bundles.get().execute_query()
     #    self.assertIsNotNone(result.resource_path)
+
+    def test7_list_changes(self):
+        result = self.client.me.drive.root.delta.get().execute_query()
+        self.assertIsNotNone(result.resource_path)
+
+    #def test8_get_delta_link(self):
+    #    result = self.client.me.drive.root.delta.token("latest").get().execute_query()
+    #    self.assertIsNotNone(result.resource_path)

tests/onedrive/test_drive.py

@@ -1,11 +1,25 @@
+from office365.outlook.mail.messages.rules.actions import MessageRuleActions
 from office365.outlook.mail.messages.rules.rule import MessageRule
+from office365.outlook.mail.recipient import Recipient
 from tests.graph_case import GraphTestCase
 
 
 class TestMessageRules(GraphTestCase):
     target_message_rule = None  # type: MessageRule
 
-    def test1_list_inbox_rules(self):
+    def test1_create_rule(self):
+        actions = MessageRuleActions(
+            forward_to=[Recipient.from_email("[email protected]")],
+            stop_processing_rules=True,
+        )
+        message_rules = (
+            self.client.me.mail_folders["inbox"]
+            .message_rules.add("From partner", 2, actions)
+            .execute_query()
+        )
+        self.assertIsNotNone(message_rules.resource_path)
+
+    def test2_list_rules(self):
         message_rules = (
             self.client.me.mail_folders["inbox"].message_rules.get().execute_query()
         )