Microsoft Search API improvements

Author: vgrem

examples/directory/applications/grant_application_perms.py

@@ -16,14 +16,13 @@
 
 from office365.graph_client import GraphClient
 from tests import (
-    test_admin_principal_name,
     test_client_id,
     test_client_secret,
     test_tenant,
 )
 
 # client = GraphClient.with_token_interactive(
-#    test_tenant, test_client_id, test_admin_principal_name
+#   test_tenant, test_client_id, test_admin_principal_name
 # )
 client = GraphClient.with_client_secret(test_tenant, test_client_id, test_client_secret)
 

examples/outlook/messages/__init__.py

@@ -10,11 +10,17 @@
     test_client_secret,
     test_tenant,
     test_user_principal_name,
+    test_username,
 )
 
 client = GraphClient.with_client_secret(test_tenant, test_client_id, test_client_secret)
-client.users[test_user_principal_name].messages.add(
-    subject="Meet for lunch?",
-    body="The new cafeteria is open.",
-    to_recipients=["fannyd@contoso.onmicrosoft.com"],
-).send().execute_query()
+draft_message = (
+    client.users[test_user_principal_name]
+    .messages.add(
+        subject="Meet for lunch?",
+        body="The new cafeteria is open.",
+        to_recipients=["fannyd@contoso.onmicrosoft.com", test_username],
+    )
+    .execute_query()
+)
+print(draft_message)

examples/outlook/messages/create_draft.py

@@ -10,7 +10,7 @@
 client = GraphClient.with_username_and_password(
     test_tenant, test_client_id, test_username, test_password
 )
-result = client.search.query_messages("Let's go for lunch").execute_query()
+result = client.search.query_messages("Meet for lunch?").execute_query()
 for item in result.value:
     for hit in item.hitsContainers[0].hits:
         print(hit.resource.get("webLink"))

examples/outlook/messages/search.py

@@ -0,0 +1,18 @@
+"""
+Search messages in a user's mailbox
+
+https://learn.microsoft.com/en-us/graph/search-concept-messages
+"""
+
+from office365.graph_client import GraphClient
+from tests import test_client_id, test_password, test_tenant, test_username
+
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
+result = client.search.query_messages(
+    "Meet for lunch?", page_from=1, size=10
+).execute_query()
+for item in result.value:
+    for hit in item.hitsContainers[0].hits:
+        print(hit.resource.get_property("webLink"))

examples/outlook/messages/search_custom.py

@@ -0,0 +1,25 @@
+"""
+Create a single-value extended property for a message
+
+Demonstrates how to update the properties of a message object.
+
+https://learn.microsoft.com/en-us/graph/api/message-update?view=graph-rest-1.0
+"""
+
+import sys
+
+from office365.graph_client import GraphClient
+from tests import test_client_id, test_password, test_tenant, test_username
+
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
+messages = client.me.messages.top(1).get().execute_query()
+if len(messages) == 0:
+    sys.exit("No messages were found")
+
+
+message = messages[0]
+message.subject = "Updated subject"
+message.body = "Updated body text"
+message.update().execute_query()

examples/outlook/messages/update.py

@@ -47,7 +47,7 @@ def _resolve_template_file(self, type_name):
             "EntityType": "entity_type.py",
         }
         path = abspath(
-            os.path.join(self._options["templatePath"], file_mapping[type_name])
+            os.path.join(self._options.get("templatepath"), file_mapping[type_name])
         )
         return path
 
@@ -65,7 +65,7 @@ def _resolve_type(self, type_name):
         else:
             type_info["state"] = "detached"
             type_info["file"] = abspath(
-                os.path.join(self._options["outputPath"], type_name + ".py")
+                os.path.join(self._options["outputpath"], type_name + ".py")
             )
         return type_info
 

generator/builders/type_builder.py

@@ -1,14 +1,14 @@
+from configparser import ConfigParser
+
 from generator import load_settings
 from generator.builders.type_builder import TypeBuilder
+from office365.runtime.odata.model import ODataModel
 from office365.runtime.odata.v3.metadata_reader import ODataV3Reader
 from office365.runtime.odata.v4.metadata_reader import ODataV4Reader
 
 
 def generate_files(model, options):
-    """
-    :type model: office365.runtime.odata.model.ODataModel
-    :type options: ConfigParser
-    """
+    # type: (ODataModel, dict) -> None
     for name in model.types:
         type_schema = model.types[name]
         builder = TypeBuilder(type_schema, options)
@@ -18,16 +18,18 @@ def generate_files(model, options):
 
 
 def generate_sharepoint_model(settings):
+    # type: (ConfigParser) -> None
     reader = ODataV3Reader(settings.get("sharepoint", "metadataPath"))
     reader.format_file()
     model = reader.generate_model()
-    generate_files(model, settings)
+    generate_files(model, dict(settings.items("sharepoint")))
 
 
 def generate_graph_model(settings):
+    # type: (ConfigParser) -> None
     reader = ODataV4Reader(settings.get("microsoftgraph", "metadataPath"))
     model = reader.generate_model()
-    generate_files(model, settings)
+    generate_files(model, dict(settings.items("microsoftgraph")))
 
 
 if __name__ == "__main__":

generator/generate_model.py

@@ -26,13 +26,13 @@ def export_to_file(path, content):
     "--endpoint",
     dest="endpoint",
     help="Import metadata endpoint",
-    default="graph",
+    default="sharepoint",
 )
 parser.add_argument(
     "-p",
     "--path",
     dest="path",
-    default="./metadata/MicrosoftGraph.xml",
+    default="./metadata/SharePoint.xml",
     help="Import metadata endpoint",
 )
 

generator/import_metadata.py

@@ -3948,6 +3948,11 @@
                   <PropertyValue Property="Filterable" Bool="true"/>
                </Record>
             </Annotation>
+            <Annotation Term="Org.OData.Capabilities.V1.NavigationRestrictions">
+               <Record>
+                  <PropertyValue Property="Referenceable" Bool="false"/>
+               </Record>
+            </Annotation>
             <Annotation Term="Org.OData.Capabilities.V1.SelectSupport">
                <Record>
                   <PropertyValue Property="Supported" Bool="true"/>
@@ -5350,6 +5355,11 @@
                   <PropertyValue Property="Insertable" Bool="false"/>
                </Record>
             </Annotation>
+            <Annotation Term="Org.OData.Capabilities.V1.NavigationRestrictions">
+               <Record>
+                  <PropertyValue Property="Referenceable" Bool="false"/>
+               </Record>
+            </Annotation>
             <Annotation Term="Org.OData.Capabilities.V1.SelectSupport">
                <Record>
                   <PropertyValue Property="Supported" Bool="false"/>
@@ -5401,6 +5411,11 @@
                   <PropertyValue Property="Insertable" Bool="false"/>
                </Record>
             </Annotation>
+            <Annotation Term="Org.OData.Capabilities.V1.NavigationRestrictions">
+               <Record>
+                  <PropertyValue Property="Referenceable" Bool="false"/>
+               </Record>
+            </Annotation>
             <Annotation Term="Org.OData.Capabilities.V1.SkipSupported" Bool="false"/>
             <Annotation Term="Org.OData.Capabilities.V1.SortRestrictions">
                <Record>
@@ -28342,6 +28357,9 @@ within the time frame of their original request."/>
             <Property Name="isSearchable" Type="Edm.Boolean"/>
             <Property Name="value" Type="Edm.String" Nullable="false"/>
          </ComplexType>
+         <ComplexType Name="fileStorageContainerSettings">
+            <Property Name="isOcrEnabled" Type="Edm.Boolean"/>
+         </ComplexType>
          <ComplexType Name="fileStorageContainerViewpoint">
             <Property Name="effectiveRole" Type="Edm.String" Nullable="false"/>
          </ComplexType>
@@ -28359,6 +28377,7 @@ within the time frame of their original request."/>
             <Property Name="customProperties" Type="graph.fileStorageContainerCustomPropertyDictionary"/>
             <Property Name="description" Type="Edm.String"/>
             <Property Name="displayName" Type="Edm.String" Nullable="false"/>
+            <Property Name="settings" Type="graph.fileStorageContainerSettings" Nullable="false"/>
             <Property Name="status" Type="graph.fileStorageContainerStatus"/>
             <Property Name="viewpoint" Type="graph.fileStorageContainerViewpoint"/>
             <NavigationProperty Name="drive" Type="graph.drive" ContainsTarget="true"/>
@@ -34260,6 +34279,8 @@ within the time frame of their original request."/>
          </ComplexType>
          <ComplexType Name="chatMessageReaction">
             <Property Name="createdDateTime" Type="Edm.DateTimeOffset" Nullable="false"/>
+            <Property Name="displayName" Type="Edm.String"/>
+            <Property Name="reactionContentUrl" Type="Edm.String"/>
             <Property Name="reactionType" Type="Edm.String" Nullable="false"/>
             <Property Name="user" Type="graph.chatMessageReactionIdentitySet" Nullable="false"/>
          </ComplexType>
@@ -35397,6 +35418,9 @@ within the time frame of their original request."/>
          <Action Name="instantiate" IsBound="true">
             <Parameter Name="bindingParameter" Type="graph.applicationTemplate"/>
             <Parameter Name="displayName" Type="Edm.String" Unicode="false"/>
+            <Parameter Name="serviceManagementReference" Type="Edm.String" Unicode="false">
+               <Annotation Term="Org.OData.Core.V1.OptionalParameter"/>
+            </Parameter>
             <ReturnType Type="graph.applicationServicePrincipal"/>
          </Action>
          <Action Name="setVerifiedPublisher" IsBound="true">
@@ -40705,8 +40729,8 @@ within the time frame of their original request."/>
          </EnumType>
          <EnumType Name="purgeType">
             <Member Name="recoverable" Value="0"/>
-            <Member Name="permanentlyDeleted" Value="1"/>
-            <Member Name="unknownFutureValue" Value="2"/>
+            <Member Name="unknownFutureValue" Value="1"/>
+            <Member Name="permanentlyDelete" Value="2"/>
          </EnumType>
          <EnumType Name="sourceType" IsFlags="true">
             <Member Name="mailbox" Value="1"/>