Teams API: new types, type hints improvements

Author: vgrem

examples/onedrive/README.md

@@ -0,0 +1 @@
+# Working with OneDrive and SharePoint API v2 APIs 

examples/outlook/README.md

@@ -0,0 +1,6 @@
+# Working with Outlook API
+
+The list of supported APIs:
+-   [Outlook Contacts REST API](https://msdn.microsoft.com/en-us/office/office365/api/contacts-rest-operations)
+-   [Outlook Calendar REST API](https://msdn.microsoft.com/en-us/office/office365/api/calendar-rest-operations)
+-   [Outlook Mail REST API](https://msdn.microsoft.com/en-us/office/office365/api/mail-rest-operations)

examples/sharepoint/README.md

@@ -3,20 +3,26 @@
 This directory contains examples for SharePoint REST API v1
 
 
-###  [Working with folders and files](./files/)  
-   - **Download** a file: [`download.py`](./files/download.py)  
-   - **Upload** a file: [`upload.py`](./files/upload.py)  
-   - **Create** a folder: [`create.py`](./folders/create.py)
-
-###  [Working with lists](./lists/)  
-   - **Create** a list item: [`create_item.py`](./lists/create_item.py)   
-   - **Read** list items (paged): [`read_items.py`](./lists/read_items.py)  
-
-###   [Working with list items](./listitems/)  
-   - **Update** items in batch: [`update_batch.py`](./listitems/update_batch.py)  
-   - **Delete** an item: [`delete.py`](./listitems/delete.py)  
-
-
+###  Working with folders and files  
+   - **Download** a file: [`./files/download.py`](./files/download.py)  
+   - **Upload** a file: [`./files/upload.py`](./files/upload.py)  
+   - **Create** a folder: [`./folders/create.py`](./folders/create.py)
+   - **Upload** large file: [`./files/upload_large.py`](./files/upload_large.py) 
+   - **List** file version history: [`./versions/list.py`](./files/versions/list.py)
+
+###  Working with lists and list items  
+   - **Create** a list item: [`/lists/create_item.py`](./lists/create_item.py)   
+   - **Read** list items (paged): [`/lists/read_items.py`](./lists/read_items.py)
+   - **Update** items in batch: [`./listitems/update_batch.py`](./listitems/update_batch.py)  
+   - **Delete** an list item: [`./listitems/delete.py`](./listitems/delete.py)
+
+###   Working with fields and field values  
+   - **Create** lookup field: [`create_lookup.py`](./fields/create_lookup.py)  
+   
+###   Working with taxonomy  
+   - **Get** field value : [`get_field_value.py`](./taxonomy/get_field_value.py)  
+   
+###   Working with site  
 
 ---
 

generator/metadata/Graph.xml

@@ -41874,6 +41874,7 @@ within the time frame of their original request."/>
             <Member Name="microsoftDefenderThreatIntelligenceAnalytics" Value="1073741846"/>
             <Member Name="builtInMl" Value="1073741847"/>
             <Member Name="microsoftInsiderRiskManagement" Value="1073741848"/>
+            <Member Name="microsoftThreatIntelligence" Value="1073741849"/>
             <Member Name="microsoftSentinel" Value="268435456"/>
          </EnumType>
          <EnumType Name="detectionStatus">
@@ -42025,6 +42026,7 @@ within the time frame of their original request."/>
             <Member Name="microsoftDefenderForCloud" Value="256"/>
             <Member Name="microsoftSentinel" Value="512"/>
             <Member Name="microsoftInsiderRiskManagement" Value="1024"/>
+            <Member Name="microsoftThreatIntelligence" Value="2048"/>
          </EnumType>
          <EnumType Name="teamsDeliveryLocation">
             <Member Name="unknown" Value="0"/>

office365/directory/authentication/methods/sms.py

@@ -1,9 +1,26 @@
 from office365.directory.authentication.method_configuration import (
     AuthenticationMethodConfiguration,
 )
+from office365.directory.authentication.methods.sms_target import (
+    SmsAuthenticationMethodTarget,
+)
+from office365.entity_collection import EntityCollection
+from office365.runtime.paths.resource_path import ResourcePath
 
 
 class SmsAuthenticationMethodConfiguration(AuthenticationMethodConfiguration):
     """Represents a text message authentication methods policy. Authentication methods policies define
     configuration settings and users or groups that are enabled to use the authentication method.
     """
+
+    @property
+    def include_targets(self):
+        """Groups of users that are excluded from the policy."""
+        return self.properties.get(
+            "includeTargets",
+            EntityCollection(
+                self.context,
+                SmsAuthenticationMethodTarget,
+                ResourcePath("includeTargets", self.resource_path),
+            ),
+        )

office365/directory/authentication/methods/sms_target.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.entity import Entity
+
+
+class SmsAuthenticationMethodTarget(Entity):
+    """Represents the users or groups of users that are excluded from a policy."""

office365/directory/security/alerts/history_state.py

@@ -3,3 +3,9 @@
 
 class AlertHistoryState(ClientValue):
     """Stores changes made to alerts."""
+
+    def __init__(self, app_id=None, assigned_to=None, comments=None):
+        # type: (str, str, list[str]) -> None
+        self.appId = app_id
+        self.assignedTo = assigned_to
+        self.comments = comments

office365/directory/security/hunting_query_results.py

@@ -1,5 +1,10 @@
+from office365.directory.security.hunting_row_result import HuntingRowResult
 from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
 
 
 class HuntingQueryResults(ClientValue):
     """The results of running a query for advanced hunting."""
+
+    def __init__(self, results=None):
+        self.results = ClientValueCollection(HuntingRowResult, results)

office365/directory/security/hunting_row_result.py

@@ -0,0 +1,8 @@
+from office365.runtime.client_value import ClientValue
+
+
+class HuntingRowResult(ClientValue):
+    """Represents a row of the results from running an advanced hunting query.
+
+    The content of the results is depended on the submitted KQL query, see KQL quick reference.
+    """

office365/directory/security/security.py

@@ -6,6 +6,9 @@
 from office365.directory.security.incidents.incident import Incident
 from office365.directory.security.labels.root import LabelsRoot
 from office365.directory.security.scorecontrol.profile import SecureScoreControlProfile
+from office365.directory.security.subjectrightsrequests.request import (
+    SubjectRightsRequest,
+)
 from office365.directory.security.threatintelligence.threat_intelligence import (
     ThreatIntelligence,
 )
@@ -93,6 +96,19 @@ def labels(self):
             LabelsRoot(self.context, ResourcePath("labels", self.resource_path)),
         )
 
+    @property
+    def subject_rights_requests(self):
+        # type: () -> EntityCollection[SubjectRightsRequest]
+        """Get a list of the subjectRightsRequest objects and their properties."""
+        return self.properties.get(
+            "subjectRightsRequests",
+            EntityCollection(
+                self.context,
+                SubjectRightsRequest,
+                ResourcePath("subjectRightsRequests", self.resource_path),
+            ),
+        )
+
     @property
     def secure_score_control_profiles(self):
         """"""
@@ -128,6 +144,7 @@ def get_property(self, name, default_value=None):
             property_mapping = {
                 "alerts_v2": self.alerts_v2,
                 "attackSimulation": self.attack_simulation,
+                "subjectRightsRequests": self.subject_rights_requests,
                 "secureScoreControlProfiles": self.secure_score_control_profiles,
                 "threatIntelligence": self.threat_intelligence,
             }

office365/directory/security/subjectrightsrequests/request.py

@@ -0,0 +1,6 @@
+from office365.entity import Entity
+
+
+class SubjectRightsRequest(Entity):
+    """Represents the properties of a subject rights request, which is a formal request by a data subject to
+    a controller to take an action on their personal data."""

office365/directory/security/subjectrightsrequests/stage_detail.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class SubjectRightsRequestStageDetail(ClientValue):
+    """Represents the properties of the stages of a subject rights request."""

office365/directory/synchronization/attribute_mapping_function_schema.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class AttributeMappingFunctionSchema(Entity):
+    """Describes a function that can be used in an attribute mapping to transform values during synchronization."""

office365/directory/synchronization/schema.py

@@ -1,7 +1,11 @@
+from office365.directory.synchronization.attribute_mapping_function_schema import (
+    AttributeMappingFunctionSchema,
+)
 from office365.directory.synchronization.directory_definition import DirectoryDefinition
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.function import FunctionQuery
 
 
 class SynchronizationSchema(Entity):
@@ -13,6 +17,13 @@ class SynchronizationSchema(Entity):
     The following sections describe the high-level components of the synchronization schema.
     """
 
+    def functions(self):
+        """List all the functions currently supported in the attributeMappingSource."""
+        return_type = EntityCollection(self.context, AttributeMappingFunctionSchema)
+        qry = FunctionQuery(self, "functions", None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def directories(self):
         # type: () -> EntityCollection[DirectoryDefinition]

office365/entity_collection.py

@@ -1,4 +1,4 @@
-from typing import TYPE_CHECKING, Any, Optional, Type, TypeVar
+from typing import TYPE_CHECKING, Any, Optional, Type
 
 from typing_extensions import Self
 
@@ -12,7 +12,7 @@
 if TYPE_CHECKING:
     from office365.graph_client import GraphClient
 
-T = TypeVar("T")
+from office365.runtime.client_object import T
 
 
 class EntityCollection(ClientObjectCollection[T]):
@@ -26,6 +26,7 @@ def __init__(self, context, item_type, resource_path=None, parent=None):
         self._delta_request_url = None
 
     def token(self, value):
+        # type: (str) -> T
         """
         Apply delta query
 

office365/onedrive/driveitems/driveItem.py

@@ -4,7 +4,7 @@
 from datetime import datetime
 from functools import partial
 from os.path import isfile, join
-from typing import IO, AnyStr, Callable, Optional, TypeVar
+from typing import IO, AnyStr, Callable, Optional
 
 import requests
 from typing_extensions import Self
@@ -58,8 +58,6 @@
 from office365.runtime.queries.upload_session import UploadSessionQuery
 from office365.subscriptions.collection import SubscriptionCollection
 
-P_T = TypeVar("P_T")
-
 
 class DriveItem(BaseItem):
     """The driveItem resource represents a file, folder, or other item stored in a drive. All file system objects in
@@ -931,7 +929,6 @@ def set_property(self, name, value, persist_changes=True):
         return self
 
     def get_property(self, name, default_value=None):
-        # type: (str, P_T) -> P_T
         if default_value is None:
             property_mapping = {
                 "fileSystemInfo": self.file_system_info,

office365/outlook/mail/messages/message.py

@@ -17,7 +17,7 @@
 from office365.outlook.mail.messages.followup_flag import FollowupFlag
 from office365.outlook.mail.messages.internet_header import InternetMessageHeader
 from office365.outlook.mail.recipient import Recipient
-from office365.runtime.client_object import persist_property
+from office365.runtime.client_object_meta import persist_property
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath

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

@@ -3,7 +3,7 @@
 from office365.entity import Entity
 from office365.outlook.mail.messages.rules.actions import MessageRuleActions
 from office365.outlook.mail.messages.rules.predicates import MessageRulePredicates
-from office365.runtime.client_object import persist_property
+from office365.runtime.client_object_meta import persist_property
 
 
 class MessageRule(Entity):

office365/runtime/client_object.py

@@ -1,7 +1,16 @@
 from __future__ import annotations
 
 import datetime
-from typing import TYPE_CHECKING, Any, Callable, Generic, List, Optional, TypeVar
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Callable,
+    Generic,
+    List,
+    Optional,
+    TypeVar,
+    Union,
+)
 
 from requests import Response
 from typing_extensions import Self
@@ -20,27 +29,8 @@
     from office365.runtime.client_object_collection import ClientObjectCollection
 
 
-T = TypeVar("T")
-P_T = TypeVar("P_T")
-"""Property Type."""
-
-
-def persist_property(property_name=None):
-    # type: (Optional[str]) -> Callable[[Callable[..., P_T]], Callable[..., P_T]]
-    """Decorator to automatically track property access for persistence"""
-
-    def decorator(method):
-        # type: (Callable[..., P_T]) -> Callable[..., P_T]
-        def wrapper(self, *args, **kwargs):
-            # type: (ClientObject, *Any, **Any) -> P_T
-            name = property_name if property_name is not None else method.__name__
-            if name not in self._properties_to_persist:
-                self._properties_to_persist.append(name)
-            return method(self, *args, **kwargs)
-
-        return wrapper
-
-    return decorator
+T = TypeVar("T", bound="ClientObject")
+PropertyT = Union[bool, int, float, str, bytes, ClientValue]
 
 
 class ClientObject(Generic[T]):
@@ -67,6 +57,9 @@ def clear_state(self):
         self._query_options = QueryOptions()
         return self
 
+    # @overload
+    # def execute_query(self: T) -> T: ...
+
     def execute_query(self):
         # type: () -> Self
         """Submit request(s) to the server."""
@@ -113,6 +106,9 @@ def after_execute(self, action, execute_first=False, include_response=False):
         self.context.after_query_execute(action, execute_first, include_response)
         return self
 
+    # @overload
+    # def get(self: T) -> T: ...
+
     def get(self):
         # type: () -> Self
         """Retrieves a client object from the server."""
@@ -162,15 +158,15 @@ def _persist_changes(self, name):
         return self
 
     def get_property(self, name, default_value=None):
-        # type: (str, P_T) -> P_T
+        # type: (str, PropertyT) -> PropertyT
         """Gets property value."""
         if default_value is None:
             normalized_name = name[0].lower() + name[1:]
             default_value = getattr(self, normalized_name, None)
         return self._properties.get(name, default_value)
 
     def set_property(self, name, value, persist_changes=True):
-        # type: (str|int, P_T, bool) -> Self
+        # type: (str|int, PropertyT, bool) -> Self
         """Sets property value"""
         if persist_changes:
             self._properties_to_persist.append(name)

office365/runtime/client_object_meta.py

@@ -0,0 +1,23 @@
+from __future__ import annotations
+
+from typing import Any, Callable, Optional
+
+from office365.runtime.client_object import ClientObject, PropertyT
+
+
+def persist_property(property_name=None):
+    # type: (Optional[str]) -> Callable[[Callable[..., PropertyT]], Callable[..., PropertyT]]
+    """Decorator to automatically track property access for persistence"""
+
+    def decorator(method):
+        # type: (Callable[..., PropertyT]) -> Callable[..., PropertyT]
+        def wrapper(self, *args, **kwargs):
+            # type: (ClientObject, *Any, **Any) -> PropertyT
+            name = property_name if property_name is not None else method.__name__
+            if name not in self._properties_to_persist:
+                self._properties_to_persist.append(name)
+            return method(self, *args, **kwargs)
+
+        return wrapper
+
+    return decorator