Add search service

Author: areed1192

ms_graph/client.py

@@ -15,6 +15,7 @@
 from ms_graph.notes import Notes
 from ms_graph.session import GraphSession
 from ms_graph.drive_items import DriveItems
+from ms_graph.search import Search
 
 
 class MicrosoftGraphClient():
@@ -399,3 +400,17 @@ def notes(self) -> Notes:
         notes_object: Notes = Notes(session=self.graph_session)
 
         return notes_object
+
+    def search(self) -> Search:
+        """Used to access the Search Services and metadata.
+
+        ### Returns
+        ---
+        Groups:
+            The `Search` services Object.
+        """
+
+        # Grab the `Search` Object for the session.
+        search_object: Search = Search(session=self.graph_session)
+
+        return search_object

ms_graph/search.py

@@ -0,0 +1,49 @@
+from typing import Dict
+from ms_graph.session import GraphSession
+
+
+class Search():
+
+    """
+    ## Overview:
+    ----
+    You can use the Microsoft Search API to query Microsoft 365 data in your apps.
+    Search requests run in the context of the signed-in user, identified using an
+    access token with delegated permissions.
+    """
+
+    def __init__(self, session: object) -> None:
+        """Initializes the `Query` object.
+
+        ### Parameters
+        ----
+        session : object
+            An authenticated session for our Microsoft Graph Client.
+        """
+
+        # Set the session.
+        self.graph_session: GraphSession = session
+
+        # Set the endpoint.
+        self.endpoint = 'search'
+
+    def query(self, search_request: Dict) -> Dict:
+        """Runs the query specified in the request body. Search
+        results are provided in the response.
+
+        ### Returns
+        ----
+        Dict:
+            A `SearchResponse` collection.
+        """
+
+        # define the endpoints.
+        endpoint = self.endpoint + "/query"
+
+        content = self.graph_session.make_request(
+            method='post',
+            endpoint=endpoint,
+            json=search_request
+        )
+
+        return content

samples/use_client.py

@@ -11,9 +11,9 @@
     'User.Read.All',
     'Directory.Read.All',
     'Directory.ReadWrite.All',
-    'offline_access',
-    'openid',
-    'profile'
+    # 'offline_access',
+    # 'openid',
+    # 'profile'
 ]
 
 # Initialize the Parser.

samples/use_search_service.py

@@ -0,0 +1,64 @@
+from pprint import pprint
+from ms_graph.client import MicrosoftGraphClient
+from configparser import ConfigParser
+
+scopes = [
+    'Calendars.ReadWrite',
+    'Files.ReadWrite.All',
+    'User.ReadWrite.All',
+    'Notes.ReadWrite.All',
+    'Directory.ReadWrite.All',
+    'User.Read.All',
+    'Directory.Read.All',
+    'Directory.ReadWrite.All',
+    'Mail.ReadWrite',
+    'Sites.ReadWrite.All',
+    'ExternalItem.Read.All'
+]
+
+# Initialize the Parser.
+config = ConfigParser()
+
+# Read the file.
+config.read('config/config.ini')
+
+# Get the specified credentials.
+client_id = config.get('graph_api', 'client_id')
+client_secret = config.get('graph_api', 'client_secret')
+redirect_uri = config.get('graph_api', 'redirect_uri')
+
+# Initialize the Client.
+graph_client = MicrosoftGraphClient(
+    client_id=client_id,
+    client_secret=client_secret,
+    redirect_uri=redirect_uri,
+    scope=scopes,
+    credentials='config/ms_graph_state.jsonc'
+)
+
+# Login to the Client.
+graph_client.login()
+
+# Grab the Search Service.
+search_service = graph_client.search()
+
+# Search for some documents.
+search_response = search_service.query(
+    search_request={
+        "requests": [
+            {
+                "entityTypes": [
+                    "message"
+                ],
+                "query": {
+                    "queryString": "sigma"
+                },
+                "from": 0,
+                "size": 25
+            }
+        ]
+    }
+)
+
+# Print the Output.
+pprint(search_response)