typings improvements for Outlook and OneDrive APIs, examples updates

vgrem · Oct 25, 2023 · 4b62b64 · 4b62b64
1 parent 476b170
commit 4b62b64
Show file tree

Hide file tree

Showing 38 changed files with 202 additions and 95 deletions.
diff --git a/examples/onedrive/__init__.py b/examples/onedrive/__init__.py
@@ -21,8 +21,10 @@ def ensure_workbook_sample(graph_client):
     except ClientRequestException as e:
         if e.response.status_code == 404:
             local_path = "../../data/Financial Sample.xlsx"
-            target_file = graph_client.me.drive.root.upload(local_path).execute_query()
-            print(f"File {target_file.web_url} has been uploaded")
+            target_file = graph_client.me.drive.root.upload_file(
+                local_path
+            ).execute_query()
+            print("File {0} has been uploaded".format(target_file.web_url))
             return target_file.workbook
         else:
             raise ValueError(e.response.text)
diff --git a/examples/onedrive/columns/create_lookup.py b/examples/onedrive/columns/create_lookup.py
@@ -8,19 +8,11 @@
 from tests import create_unique_name
 from tests.graph_case import acquire_token_by_username_password
 
-
-def clean_up(columns):
-    """
-    :type columns: list[office365.onedrive.columns.definition.ColumnDefinition]
-    """
-    [column.delete_object().execute_query() for column in columns]
-
-
 client = GraphClient(acquire_token_by_username_password)
-lib = client.sites.root.lists["Docs"]
+lib = client.sites.root.lists["Documents"]
 
 column_name = create_unique_name("LookupColumn")
 lookup_column = lib.columns.add_lookup(column_name, lib).execute_query()
 print(lookup_column.display_name)
 
-clean_up([lookup_column])
+lookup_column.delete_object().execute_query()  # clean up
diff --git a/examples/onedrive/files/list_shared_with_me.py b/examples/onedrive/files/list_shared_with_me.py
@@ -1,5 +1,7 @@
 """
 Retrieves a collection of DriveItem resources that have been shared with the current user
+
+https://learn.microsoft.com/en-us/graph/api/drive-sharedwithme?view=graph-rest-1.0
 """
 from office365.graph_client import GraphClient
 from tests.graph_case import acquire_token_by_username_password

diff --git a/examples/onedrive/files/share_invitation.py b/examples/onedrive/files/share_invitation.py
@@ -6,9 +6,9 @@
 
 https://learn.microsoft.com/en-us/graph/api/driveitem-invite?view=graph-rest-1.0
 """
-import json
 from datetime import datetime, timedelta
 
+from examples import upload_sample_files
 from office365.graph_client import GraphClient
 from tests.graph_case import acquire_token_by_username_password
 
@@ -24,4 +24,5 @@
     expiration_datetime=None,
     password="password123",
 ).execute_query()
-print(json.dumps(permissions.to_json(), indent=4))
+for perm in permissions:
+    print(perm.granted_to_identities)
diff --git a/examples/onedrive/sites/get_all.py b/examples/onedrive/sites/get_all.py
@@ -1,7 +1,7 @@
 """
 List root sites across geographies in an organization.
 
-https://learn.microsoft.com/en-us/graph/api/site-getallsites?view=graph-rest-1.0&tabs=http
+https://learn.microsoft.com/en-us/graph/api/site-getallsites?view=graph-rest-1.0
 """
 from office365.graph_client import GraphClient
 from tests.graph_case import acquire_token_by_client_credentials

diff --git a/examples/onedrive/sites/grant_permission.py b/examples/onedrive/sites/grant_permission.py
@@ -1,7 +1,7 @@
 """
 Grant permissions on a site.
 
-https://learn.microsoft.com/en-us/graph/api/site-post-permissions?view=graph-rest-1.0&tabs=http
+https://learn.microsoft.com/en-us/graph/api/site-post-permissions?view=graph-rest-1.0
 """
 import json
 

diff --git a/examples/onedrive/sites/list_permissions.py b/examples/onedrive/sites/list_permissions.py
@@ -1,6 +1,6 @@
 """
 List site permissions
-https://learn.microsoft.com/en-us/graph/api/site-list-permissions?view=graph-rest-1.0&tabs=http
+https://learn.microsoft.com/en-us/graph/api/site-list-permissions?view=graph-rest-1.0
 """
 
 from office365.graph_client import GraphClient
@@ -12,4 +12,4 @@
     client.sites.get_by_url(test_team_site_url).permissions.get().execute_query()
 )
 for perm in permissions:
-    print(perm)
+    print(perm.granted_to)
diff --git a/examples/outlook/calendars/list_my.py b/examples/outlook/calendars/list_my.py
@@ -9,4 +9,4 @@
 client = GraphClient(acquire_token_by_username_password)
 calendars = client.me.calendars.top(10).get().execute_query()
 for cal in calendars:
-    print(cal.name)
+    print(cal)
diff --git a/examples/outlook/events/list.py b/examples/outlook/events/list.py
@@ -4,10 +4,11 @@
 https://learn.microsoft.com/en-us/graph/api/calendar-list-events?view=graph-rest-1.0
 """
 from office365.graph_client import GraphClient
-from office365.outlook.calendar.events.event import Event
 from tests.graph_case import acquire_token_by_username_password
 
 client = GraphClient(acquire_token_by_username_password)
-events = client.me.calendar.events.get_all().select(["subject", "body"]).execute_query()
+events = (
+    client.me.calendar.events.get().top(100).select(["subject", "body"]).execute_query()
+)
 for event in events:
     print(event.subject)
diff --git a/generator/metadata/MicrosoftGraph.xml b/generator/metadata/MicrosoftGraph.xml
@@ -14985,10 +14985,10 @@
          <Annotations Target="microsoft.graph.schedulingGroup/isActive">
             <Annotation Term="Org.OData.Core.V1.Computed" Bool="true"/>
          </Annotations>
-         <Annotations Target="microsoft.graph.security.host">
+         <Annotations Target="microsoft.graph.security.hostComponent">
             <Annotation Term="Org.OData.Capabilities.V1.CountRestrictions">
                <Record>
-                  <PropertyValue Property="Countable" Bool="false"/>
+                  <PropertyValue Property="Countable" Bool="true"/>
                </Record>
             </Annotation>
             <Annotation Term="Org.OData.Capabilities.V1.ExpandRestrictions">
@@ -15011,18 +15011,13 @@
                   <PropertyValue Property="Selectable" Bool="true"/>
                </Record>
             </Annotation>
-            <Annotation Term="Org.OData.Capabilities.V1.SkipSupported" Bool="false"/>
-            <Annotation Term="Org.OData.Capabilities.V1.SortRestrictions">
-               <Record>
-                  <PropertyValue Property="Sortable" Bool="false"/>
-               </Record>
-            </Annotation>
-            <Annotation Term="Org.OData.Capabilities.V1.TopSupported" Bool="false"/>
+            <Annotation Term="Org.OData.Capabilities.V1.SkipSupported" Bool="true"/>
+            <Annotation Term="Org.OData.Capabilities.V1.TopSupported" Bool="true"/>
          </Annotations>
-         <Annotations Target="microsoft.graph.security.article">
+         <Annotations Target="microsoft.graph.security.host">
             <Annotation Term="Org.OData.Capabilities.V1.CountRestrictions">
                <Record>
-                  <PropertyValue Property="Countable" Bool="true"/>
+                  <PropertyValue Property="Countable" Bool="false"/>
                </Record>
             </Annotation>
             <Annotation Term="Org.OData.Capabilities.V1.ExpandRestrictions">
@@ -15037,23 +15032,23 @@
             </Annotation>
             <Annotation Term="Org.OData.Capabilities.V1.SearchRestrictions">
                <Record>
-                  <PropertyValue Property="Searchable" Bool="true"/>
+                  <PropertyValue Property="Searchable" Bool="false"/>
                </Record>
             </Annotation>
             <Annotation Term="Org.OData.Capabilities.V1.SelectRestrictions">
                <Record>
                   <PropertyValue Property="Selectable" Bool="true"/>
                </Record>
             </Annotation>
-            <Annotation Term="Org.OData.Capabilities.V1.SkipSupported" Bool="true"/>
+            <Annotation Term="Org.OData.Capabilities.V1.SkipSupported" Bool="false"/>
             <Annotation Term="Org.OData.Capabilities.V1.SortRestrictions">
                <Record>
                   <PropertyValue Property="Sortable" Bool="false"/>
                </Record>
             </Annotation>
-            <Annotation Term="Org.OData.Capabilities.V1.TopSupported" Bool="true"/>
+            <Annotation Term="Org.OData.Capabilities.V1.TopSupported" Bool="false"/>
          </Annotations>
-         <Annotations Target="microsoft.graph.security.articleIndicator">
+         <Annotations Target="microsoft.graph.security.article">
             <Annotation Term="Org.OData.Capabilities.V1.CountRestrictions">
                <Record>
                   <PropertyValue Property="Countable" Bool="true"/>
@@ -15071,7 +15066,7 @@
             </Annotation>
             <Annotation Term="Org.OData.Capabilities.V1.SearchRestrictions">
                <Record>
-                  <PropertyValue Property="Searchable" Bool="false"/>
+                  <PropertyValue Property="Searchable" Bool="true"/>
                </Record>
             </Annotation>
             <Annotation Term="Org.OData.Capabilities.V1.SelectRestrictions">
@@ -15080,9 +15075,14 @@
                </Record>
             </Annotation>
             <Annotation Term="Org.OData.Capabilities.V1.SkipSupported" Bool="true"/>
+            <Annotation Term="Org.OData.Capabilities.V1.SortRestrictions">
+               <Record>
+                  <PropertyValue Property="Sortable" Bool="false"/>
+               </Record>
+            </Annotation>
             <Annotation Term="Org.OData.Capabilities.V1.TopSupported" Bool="true"/>
          </Annotations>
-         <Annotations Target="microsoft.graph.security.hostComponent">
+         <Annotations Target="microsoft.graph.security.articleIndicator">
             <Annotation Term="Org.OData.Capabilities.V1.CountRestrictions">
                <Record>
                   <PropertyValue Property="Countable" Bool="true"/>
@@ -37265,6 +37265,17 @@
             <Member Name="appGovernanceDetection" Value="2097152"/>
             <Member Name="unknownFutureValue" Value="4194303"/>
             <Member Name="microsoftDefenderForCloud" Value="4194304"/>
+            <Member Name="microsoftDefenderForIoT" Value="1073741833"/>
+            <Member Name="microsoftDefenderForServers" Value="1073741834"/>
+            <Member Name="microsoftDefenderForStorage" Value="1073741835"/>
+            <Member Name="microsoftDefenderForDNS" Value="1073741836"/>
+            <Member Name="microsoftDefenderForDatabases" Value="1073741837"/>
+            <Member Name="microsoftDefenderForContainers" Value="1073741838"/>
+            <Member Name="microsoftDefenderForNetwork" Value="1073741839"/>
+            <Member Name="microsoftDefenderForAppService" Value="1073741840"/>
+            <Member Name="microsoftDefenderForKeyVault" Value="1073741841"/>
+            <Member Name="microsoftDefenderForResourceManager" Value="1073741842"/>
+            <Member Name="microsoftDefenderForApiManagement" Value="1073741843"/>
             <Member Name="nrtAlerts" Value="1073741844"/>
             <Member Name="scheduledAlerts" Value="1073741845"/>
             <Member Name="microsoftDefenderThreatIntelligenceAnalytics" Value="1073741846"/>
@@ -37424,6 +37435,17 @@
             <Member Name="markdown" Value="2"/>
             <Member Name="unknownFutureValue" Value="3"/>
          </EnumType>
+         <EnumType Name="hostPortProtocol">
+            <Member Name="tcp" Value="0"/>
+            <Member Name="udp" Value="1"/>
+            <Member Name="unknownFutureValue" Value="2"/>
+         </EnumType>
+         <EnumType Name="hostPortStatus">
+            <Member Name="open" Value="0"/>
+            <Member Name="filtered" Value="1"/>
+            <Member Name="closed" Value="2"/>
+            <Member Name="unknownFutureValue" Value="3"/>
+         </EnumType>
          <EnumType Name="hostReputationClassification">
             <Member Name="unknown" Value="0"/>
             <Member Name="neutral" Value="1"/>
@@ -37532,6 +37554,7 @@
             <NavigationProperty Name="hostComponents" Type="Collection(microsoft.graph.security.hostComponent)" ContainsTarget="true"/>
             <NavigationProperty Name="hostCookies" Type="Collection(microsoft.graph.security.hostCookie)" ContainsTarget="true"/>
             <NavigationProperty Name="hostPairs" Type="Collection(microsoft.graph.security.hostPair)" ContainsTarget="true"/>
+            <NavigationProperty Name="hostPorts" Type="Collection(microsoft.graph.security.hostPort)" ContainsTarget="true"/>
             <NavigationProperty Name="hosts" Type="Collection(microsoft.graph.security.host)" ContainsTarget="true"/>
             <NavigationProperty Name="hostSslCertificates" Type="Collection(microsoft.graph.security.hostSslCertificate)" ContainsTarget="true"/>
             <NavigationProperty Name="hostTrackers" Type="Collection(microsoft.graph.security.hostTracker)" ContainsTarget="true"/>
@@ -38026,6 +38049,28 @@
             <Property Name="content" Type="Edm.String"/>
             <Property Name="format" Type="microsoft.graph.security.contentFormat"/>
          </ComplexType>
+         <ComplexType Name="hostPortBanner">
+            <Property Name="banner" Type="Edm.String" Nullable="false"/>
+            <Property Name="firstSeenDateTime" Type="Edm.DateTimeOffset"/>
+            <Property Name="lastSeenDateTime" Type="Edm.DateTimeOffset"/>
+            <Property Name="scanProtocol" Type="Edm.String"/>
+            <Property Name="timesObserved" Type="Edm.Int32"/>
+         </ComplexType>
+         <ComplexType Name="hostPortComponent">
+            <Property Name="firstSeenDateTime" Type="Edm.DateTimeOffset"/>
+            <Property Name="isRecent" Type="Edm.Boolean"/>
+            <Property Name="lastSeenDateTime" Type="Edm.DateTimeOffset"/>
+            <NavigationProperty Name="component" Type="microsoft.graph.security.hostComponent"/>
+         </ComplexType>
+         <EntityType Name="artifact" BaseType="graph.entity" Abstract="true"/>
+         <EntityType Name="hostComponent" BaseType="microsoft.graph.security.artifact">
+            <Property Name="category" Type="Edm.String"/>
+            <Property Name="firstSeenDateTime" Type="Edm.DateTimeOffset" Nullable="false"/>
+            <Property Name="lastSeenDateTime" Type="Edm.DateTimeOffset" Nullable="false"/>
+            <Property Name="name" Type="Edm.String" Nullable="false"/>
+            <Property Name="version" Type="Edm.String"/>
+            <NavigationProperty Name="host" Type="microsoft.graph.security.host" Nullable="false"/>
+         </EntityType>
          <ComplexType Name="hostReputationRule">
             <Property Name="description" Type="Edm.String" Nullable="false"/>
             <Property Name="name" Type="Edm.String" Nullable="false"/>
@@ -38069,7 +38114,6 @@
             <Property Name="lastSeenDateTime" Type="Edm.DateTimeOffset"/>
             <NavigationProperty Name="host" Type="microsoft.graph.security.host" Nullable="false"/>
          </ComplexType>
-         <EntityType Name="artifact" BaseType="graph.entity" Abstract="true"/>
          <EntityType Name="host" BaseType="microsoft.graph.security.artifact" Abstract="true">
             <Property Name="firstSeenDateTime" Type="Edm.DateTimeOffset"/>
             <Property Name="lastSeenDateTime" Type="Edm.DateTimeOffset"/>
@@ -38080,6 +38124,7 @@
             <NavigationProperty Name="parentHostPairs" Type="Collection(microsoft.graph.security.hostPair)"/>
             <NavigationProperty Name="passiveDns" Type="Collection(microsoft.graph.security.passiveDnsRecord)"/>
             <NavigationProperty Name="passiveDnsReverse" Type="Collection(microsoft.graph.security.passiveDnsRecord)"/>
+            <NavigationProperty Name="ports" Type="Collection(microsoft.graph.security.hostPort)"/>
             <NavigationProperty Name="reputation" Type="microsoft.graph.security.hostReputation" ContainsTarget="true"/>
             <NavigationProperty Name="sslCertificates" Type="Collection(microsoft.graph.security.hostSslCertificate)"/>
             <NavigationProperty Name="subdomains" Type="Collection(microsoft.graph.security.subdomain)"/>
@@ -38109,14 +38154,6 @@
             <NavigationProperty Name="childHost" Type="microsoft.graph.security.host" Nullable="false"/>
             <NavigationProperty Name="parentHost" Type="microsoft.graph.security.host" Nullable="false"/>
          </EntityType>
-         <EntityType Name="hostComponent" BaseType="microsoft.graph.security.artifact">
-            <Property Name="category" Type="Edm.String"/>
-            <Property Name="firstSeenDateTime" Type="Edm.DateTimeOffset" Nullable="false"/>
-            <Property Name="lastSeenDateTime" Type="Edm.DateTimeOffset" Nullable="false"/>
-            <Property Name="name" Type="Edm.String" Nullable="false"/>
-            <Property Name="version" Type="Edm.String"/>
-            <NavigationProperty Name="host" Type="microsoft.graph.security.host" Nullable="false"/>
-         </EntityType>
          <EntityType Name="hostCookie" BaseType="microsoft.graph.security.artifact">
             <Property Name="domain" Type="Edm.String" Nullable="false"/>
             <Property Name="firstSeenDateTime" Type="Edm.DateTimeOffset" Nullable="false"/>
@@ -38132,6 +38169,19 @@
             <NavigationProperty Name="artifact" Type="microsoft.graph.security.artifact" Nullable="false"/>
             <NavigationProperty Name="parentHost" Type="microsoft.graph.security.host" Nullable="false"/>
          </EntityType>
+         <EntityType Name="hostPort" BaseType="graph.entity">
+            <Property Name="banners" Type="Collection(microsoft.graph.security.hostPortBanner)"/>
+            <Property Name="firstSeenDateTime" Type="Edm.DateTimeOffset"/>
+            <Property Name="lastScanDateTime" Type="Edm.DateTimeOffset"/>
+            <Property Name="lastSeenDateTime" Type="Edm.DateTimeOffset"/>
+            <Property Name="port" Type="Edm.Int32" Nullable="false"/>
+            <Property Name="protocol" Type="microsoft.graph.security.hostPortProtocol"/>
+            <Property Name="services" Type="Collection(microsoft.graph.security.hostPortComponent)"/>
+            <Property Name="status" Type="microsoft.graph.security.hostPortStatus"/>
+            <Property Name="timesObserved" Type="Edm.Int32"/>
+            <NavigationProperty Name="host" Type="microsoft.graph.security.host" Nullable="false"/>
+            <NavigationProperty Name="mostRecentSslCertificate" Type="microsoft.graph.security.sslCertificate"/>
+         </EntityType>
          <EntityType Name="hostReputation" BaseType="graph.entity">
             <Property Name="classification" Type="microsoft.graph.security.hostReputationClassification" Nullable="false"/>
             <Property Name="rules" Type="Collection(microsoft.graph.security.hostReputationRule)"/>
@@ -38926,6 +38976,7 @@
          <EntityType Name="externalConnection" BaseType="graph.entity">
             <Property Name="activitySettings" Type="microsoft.graph.externalConnectors.activitySettings"/>
             <Property Name="configuration" Type="microsoft.graph.externalConnectors.configuration"/>
+            <Property Name="connectorId" Type="Edm.String"/>
             <Property Name="description" Type="Edm.String"/>
             <Property Name="name" Type="Edm.String"/>
             <Property Name="searchSettings" Type="microsoft.graph.externalConnectors.searchSettings"/>

diff --git a/office365/directory/object_collection.py b/office365/directory/object_collection.py
@@ -3,6 +3,7 @@
 from office365.entity_collection import EntityCollection
 from office365.runtime.client_result import ClientResult
 from office365.runtime.http.http_method import HttpMethod
+from office365.runtime.http.request_options import RequestOptions
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 
 
@@ -68,9 +69,7 @@ def remove(self, user_id):
         qry = ServiceOperationQuery(self, "{0}/$ref".format(user_id))
 
         def _construct_request(request):
-            """
-            :type request: RequestOptions
-            """
+            # type: (RequestOptions) -> None
             request.method = HttpMethod.Delete
 
         self.context.add_query(qry).before_query_execute(_construct_request)

diff --git a/office365/directory/permissions/email_identity.py b/office365/directory/permissions/email_identity.py
@@ -1,5 +1,13 @@
+from typing import Optional
+
 from office365.directory.permissions.identity import Identity
 
 
 class EmailIdentity(Identity):
     """Represents the email identity of a user."""
+
+    @property
+    def email(self):
+        # type: () -> Optional[str]
+        """Email address of the user"""
+        return self.properties.get("email", None)
diff --git a/office365/directory/permissions/identity.py b/office365/directory/permissions/identity.py
@@ -16,3 +16,6 @@ def __init__(self, display_name=None, _id=None):
         super(Identity, self).__init__()
         self.displayName = display_name
         self.id = _id
+
+    def __repr__(self):
+        return repr(self.to_json())
diff --git a/office365/directory/permissions/identity_set.py b/office365/directory/permissions/identity_set.py
@@ -17,3 +17,6 @@ def __init__(self, application=Identity(), device=Identity(), user=Identity()):
         self.application = application
         self.device = device
         self.user = user
+
+    def __repr__(self):
+        return repr({n: v.to_json() for n, v in self if v.to_json()})