Office365-REST-Python-Client 2.5.1__py3-none-any.whl → 2.5.3__py3-none-any.whl

office365/directory/users/user.py

@@ -1,4 +1,5 @@
 import json
+from typing import Optional
 
 from office365.communications.onlinemeetings.collection import OnlineMeetingCollection
 from office365.communications.presences.presence import Presence
@@ -54,8 +55,8 @@ from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.http.http_method import HttpMethod
 from office365.runtime.http.request_options import RequestOptions
-from office365.runtime.paths.entity import EntityPath
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.paths.v4.entity import EntityPath
 from office365.runtime.queries.create_entity import CreateEntityQuery
 from office365.runtime.queries.function import FunctionQuery
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -70,6 +71,9 @@ from office365.todo.todo import Todo
 class User(DirectoryObject):
     """Represents an Azure AD user account. Inherits from directoryObject."""
 
+    def __repr__(self):
+        return self.user_principal_name or self.id or self.entity_type_name
+
     def add_extension(self, name):
         """
         Creates an open extension (openTypeExtension object) and add custom properties in a new or existing instance
@@ -141,9 +145,7 @@ class User(DirectoryObject):
         qry = ServiceOperationQuery(self.manager, "$ref")
 
         def _construct_request(request):
-            """
-            :type request: office365.runtime.http.request_options.RequestOptions
-            """
+            # type: (RequestOptions) -> None
             request.method = HttpMethod.Delete
 
         self.context.add_query(qry).before_query_execute(_construct_request)
@@ -445,9 +447,7 @@ class User(DirectoryObject):
 
     @property
     def device_enrollment_limit(self):
-        """
-        :rtype: str
-        """
+        # type: () -> Optional[str]
         return self.properties.get("deviceEnrollmentLimit", None)
 
     @property
@@ -457,15 +457,14 @@ class User(DirectoryObject):
 
     @property
     def account_enabled(self):
+        # type: () -> Optional[bool]
         """True if the account is enabled; otherwise, false. This property is required when a user is created."""
         return self.properties.get("accountEnabled", None)
 
     @property
     def age_group(self):
-        """
-        Gets the age group of the user.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the age group of the user"""
         return self.properties.get("ageGroup", None)
 
     @property
@@ -489,15 +488,15 @@ class User(DirectoryObject):
 
     @property
     def given_name(self):
+        # type: () -> Optional[str]
         """
         The given name (first name) of the user. Maximum length is 64 characters.
-
-        :rtype: str or None
         """
         return self.properties.get("givenName", None)
 
     @property
     def user_principal_name(self):
+        # type: () -> Optional[str]
         """
         The user principal name (UPN) of the user. The UPN is an Internet-style login name for the user based on the
         Internet standard RFC 822. By convention, this should map to the user's email name.
@@ -507,8 +506,6 @@ class User(DirectoryObject):
         NOTE: This property cannot contain accent characters.
         Only the following characters are allowed A - Z, a - z, 0 - 9, ' . - _ ! # ^ ~.
         For the complete list of allowed characters, see username policies.
-
-        :rtype: str or None
         """
         return self.properties.get("userPrincipalName", None)
 
@@ -538,6 +535,7 @@ class User(DirectoryObject):
 
     @property
     def creation_type(self):
+        # type: () -> Optional[str]
         """Indicates whether the user account was created as a regular school or work account (null),
         an external account (Invitation), a local account for an Azure Active Directory B2C tenant (LocalAccount)
         or self-service sign-up using email verification (EmailVerified). Read-only.
@@ -556,6 +554,7 @@ class User(DirectoryObject):
 
     @property
     def mail(self):
+        # type: () -> Optional[str]
         """The SMTP address for the user, for example, "jeff@contoso.onmicrosoft.com".
         Returned by default. Supports $filter and endsWith.
         """
@@ -625,9 +624,7 @@ class User(DirectoryObject):
 
     @property
     def photo(self):
-        """
-        The user's profile photo. Read-only.
-        """
+        """The user's profile photo. Read-only."""
         return self.properties.get(
             "photo",
             ProfilePhoto(self.context, ResourcePath("photo", self.resource_path)),
@@ -635,9 +632,7 @@ class User(DirectoryObject):
 
     @property
     def manager(self):
-        """
-        The user or contact that is this user's manager
-        """
+        """The user or contact that is this user's manager"""
         return self.properties.get(
             "manager",
             DirectoryObject(self.context, ResourcePath("manager", self.resource_path)),
@@ -645,17 +640,15 @@ class User(DirectoryObject):
 
     @property
     def preferred_language(self):
+        # type: () -> Optional[str]
         """
         The preferred language for the user. Should follow ISO 639-1 Code; for example en-US.
-        :rtype: str or None
         """
         return self.properties.get("preferredLanguage", None)
 
     @property
     def mailbox_settings(self):
-        """
-        Get the user's mailboxSettings.
-        """
+        """Get the user's mailboxSettings."""
         return self.properties.get("mailboxSettings", MailboxSettings())
 
     @property
@@ -680,6 +673,7 @@ class User(DirectoryObject):
 
     @property
     def calendar_groups(self):
+        # type: () -> EntityCollection[CalendarGroup]
         """The user's calendar groups. Read-only. Nullable."""
         return self.properties.get(
             "calendarGroups",
@@ -692,6 +686,7 @@ class User(DirectoryObject):
 
     @property
     def license_details(self):
+        # type: () -> EntityCollection[LicenseDetails]
         """Retrieve the properties and relationships of a Drive resource."""
         return self.properties.get(
             "licenseDetails",
@@ -798,6 +793,7 @@ class User(DirectoryObject):
 
     @property
     def oauth2_permission_grants(self):
+        # type: () -> DeltaCollection[OAuth2PermissionGrant]
         """"""
         return self.properties.get(
             "oauth2PermissionGrants",
@@ -810,20 +806,20 @@ class User(DirectoryObject):
 
     @property
     def on_premises_distinguished_name(self):
+        # type: () -> Optional[str]
         """
         Contains the on-premises Active Directory distinguished name or DN. The property is only populated for
         customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect
-        :rtype: str
         """
         return self.properties.get("onPremisesDistinguishedName", None)
 
     @property
     def on_premises_domain_name(self):
+        # type: () -> Optional[str]
         """
         Contains the on-premises domainFQDN, also called dnsDomainName synchronized from the on-premises directory.
         The property is only populated for customers who are synchronizing their on-premises directory to
         Azure Active Directory via Azure AD Connect.
-        :rtype: str
         """
         return self.properties.get("onPremisesDomainName", None)
 
@@ -919,6 +915,7 @@ class User(DirectoryObject):
 
     @property
     def extensions(self):
+        # type: () -> EntityCollection[Extension]
         """The collection of open extensions defined for the user. Nullable."""
         return self.properties.get(
             "extensions",
@@ -929,9 +926,7 @@ class User(DirectoryObject):
 
     @property
     def direct_reports(self):
-        """
-        Get a user's direct reports.
-        """
+        """Get a user's direct reports"""
         return self.properties.get(
             "directReports",
             DirectoryObjectCollection(
@@ -953,12 +948,12 @@ class User(DirectoryObject):
 
     @property
     def password_policies(self):
+        # type: () -> Optional[str]
         """
         Specifies password policies for the user. This value is an enumeration with one possible value being
         DisableStrongPassword, which allows weaker passwords than the default policy to be specified.
         DisablePasswordExpiration can also be specified. The two may be specified together; for example:
         DisablePasswordExpiration, DisableStrongPassword.
-        :rtype: str
         """
         return self.properties.get("passwordPolicies", None)
 
@@ -991,17 +986,17 @@ class User(DirectoryObject):
 
     @property
     def street_address(self):
+        # type: () -> Optional[str]
         """
         The street address of the user's place of business. Maximum length is 1024 characters.
-        :rtype: str
         """
         return self.properties.get("streetAddress", None)
 
     @property
     def security_identifier(self):
+        # type: () -> Optional[str]
         """
         Security identifier (SID) of the user, used in Windows scenarios.
-        :rtype: str
         """
         return self.properties.get("securityIdentifier", None)
 
@@ -1033,10 +1028,10 @@ class User(DirectoryObject):
 
     @property
     def usage_location(self):
+        # type: () -> Optional[str]
         """
         A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to
         legal requirement to check for availability of services in countries. Examples include: US, JP, and GB.
-        :rtype: str
         """
         return self.properties.get("usageLocation", None)
 

office365/entity.py

@@ -3,8 +3,8 @@ from typing import TYPE_CHECKING, Optional, TypeVar
 from typing_extensions import Self
 
 from office365.runtime.client_object import ClientObject
-from office365.runtime.paths.entity import EntityPath
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.paths.v4.entity import EntityPath
 from office365.runtime.queries.delete_entity import DeleteEntityQuery
 from office365.runtime.queries.update_entity import UpdateEntityQuery
 
@@ -72,5 +72,5 @@ class Entity(ClientObject[T]):
                         value, self.parent_collection.resource_path
                     )
             else:
-                self._resource_path.patch(value, inplace=True)
+                self._resource_path.patch(value)
         return self

office365/entity_collection.py

@@ -5,6 +5,7 @@ from office365.runtime.client_object_collection import ClientObjectCollection
 from office365.runtime.compat import is_string_type
 from office365.runtime.paths.item import ItemPath
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.paths.v4.entity import EntityPath
 from office365.runtime.queries.create_entity import CreateEntityQuery
 
 if TYPE_CHECKING:
@@ -28,11 +29,11 @@ class EntityCollection(ClientObjectCollection[T]):
         :param key: key is used to address an entity by either an index or by identifier
         :type key: int or str
         """
-        if type(key) == int:
+        if isinstance(key, int):
             return super(EntityCollection, self).__getitem__(key)
         elif is_string_type(key):
             return self.create_typed_object(
-                resource_path=ResourcePath(key, self.resource_path)
+                resource_path=EntityPath(key, self.resource_path)
             )
         else:
             raise ValueError(
@@ -41,15 +42,21 @@ class EntityCollection(ClientObjectCollection[T]):
 
     def add(self, **kwargs):
         # type: (Any) -> T
-        """
-        Creates an entity and prepares the query
-        """
+        """Creates an entity and prepares the query"""
         return_type = self.create_typed_object(kwargs, ItemPath(self.resource_path))
         self.add_child(return_type)
         qry = CreateEntityQuery(self, return_type, return_type)
         self.context.add_query(qry)
         return return_type
 
+    def create_typed_object(self, initial_properties=None, resource_path=None):
+        # type: (Optional[dict], Optional[ResourcePath]) -> T
+        if resource_path is None:
+            resource_path = EntityPath(None, self.resource_path)
+        return super(EntityCollection, self).create_typed_object(
+            initial_properties, resource_path
+        )
+
     @property
     def context(self):
         # type: () -> GraphClient

office365/graph_client.py

@@ -1,4 +1,4 @@
-from typing import Callable, List
+from typing import Any, Callable, List, Optional
 
 from office365.booking.solutions.root import SolutionsRoot
 from office365.communications.cloud_communications import CloudCommunications
@@ -43,6 +43,7 @@ from office365.onedrive.drives.drive import Drive
 from office365.onedrive.shares.collection import SharesCollection
 from office365.onedrive.sites.sites_with_root import SitesWithRoot
 from office365.outlook.calendar.place import Place
+from office365.outlook.calendar.rooms.list import RoomList
 from office365.planner.planner import Planner
 from office365.reports.root import ReportRoot
 from office365.runtime.auth.token_response import TokenResponse
@@ -79,10 +80,48 @@ class GraphClient(ClientRuntimeContext):
         self._authority_host_url = "https://login.microsoftonline.com"
         self._acquire_token_callback = acquire_token_callback
 
+    @staticmethod
+    def with_certificate(
+        tenant, client_id, thumbprint, private_key, scopes=None, token_cache=None
+    ):
+        """
+        Initializes the confidential client with client certificate
+
+        :param str tenant: Tenant name, for example: contoso.onmicrosoft.com
+        :param str client_id: The OAuth client id of the calling application.
+        :param str thumbprint: Thumbprint
+        :param str private_key: Private key
+        :param list[str] or None scopes: Scopes requested to access an API
+        :param Any token_cache: Default cache is in memory only,
+        Refer https://msal-python.readthedocs.io/en/latest/#msal.SerializableTokenCache
+        """
+        if scopes is None:
+            scopes = ["https://graph.microsoft.com/.default"]
+        authority_url = "https://login.microsoftonline.com/{0}".format(tenant)
+        import msal
+
+        app = msal.ConfidentialClientApplication(
+            client_id,
+            authority=authority_url,
+            client_credential={
+                "thumbprint": thumbprint,
+                "private_key": private_key,
+            },
+            token_cache=token_cache  # Default cache is in memory only.
+            # You can learn how to use SerializableTokenCache from
+            # https://msal-python.readthedocs.io/en/latest/#msal.SerializableTokenCache
+        )
+
+        def _acquire_token():
+            return app.acquire_token_for_client(scopes=scopes)
+
+        return GraphClient(_acquire_token)
+
     @staticmethod
     def with_client_secret(
         tenant, client_id, client_secret, scopes=None, token_cache=None
     ):
+        # type: (str, str, str, List[str], Any) -> "GraphClient"
         """
         Initializes the confidential client with client secret
 
@@ -106,7 +145,45 @@ class GraphClient(ClientRuntimeContext):
         )
 
         def _acquire_token():
-            result = app.acquire_token_for_client(scopes=scopes)
+            return app.acquire_token_for_client(scopes=scopes)
+
+        return GraphClient(_acquire_token)
+
+    @staticmethod
+    def with_token_interactive(tenant, client_id, username=None, scopes=None):
+        # type: (str, str, Optional[str], List[str]) -> "GraphClient"
+        """
+        Initializes the client via user credentials
+        Note: only works if your app is registered with redirect_uri as http://localhost
+
+        :param str tenant: Tenant name, for example: contoso.onmicrosoft.com
+        :param str client_id: The OAuth client id of the calling application.
+        :param str username: Typically a UPN in the form of an email address.
+        :param list[str] or None scopes: Scopes requested to access an API
+        """
+        if scopes is None:
+            scopes = ["https://graph.microsoft.com/.default"]
+        authority_url = "https://login.microsoftonline.com/{0}".format(tenant)
+        import msal
+
+        app = msal.PublicClientApplication(client_id, authority=authority_url)
+
+        def _acquire_token():
+            # The pattern to acquire a token looks like this.
+            result = None
+
+            # Firstly, check the cache to see if this end user has signed in before
+            accounts = app.get_accounts(username=username)
+            if accounts:
+                chosen = accounts[0]  # Assuming the end user chose this one to proceed
+                # Now let's try to find a token in cache for this account
+                result = app.acquire_token_silent(scopes, account=chosen)
+
+            if not result:
+                result = app.acquire_token_interactive(
+                    scopes,
+                    login_hint=username,
+                )
             return result
 
         return GraphClient(_acquire_token)
@@ -393,18 +470,23 @@ class GraphClient(ClientRuntimeContext):
 
     @property
     def audit_logs(self):
-        """
-        Get the list of audit logs generated by Azure Active Directory.
-        """
+        """Gets the list of audit logs generated by Azure Active Directory."""
         return AuditLogRoot(self, ResourcePath("auditLogs"))
 
     @property
     def places(self):
-        """
-        Get all places in a tenant
-        """
+        """Gets all places in a tenant"""
         return EntityCollection(self, Place, ResourcePath("places"))
 
+    @property
+    def room_lists(self):
+        """Gets all the room lists in a tenant"""
+        return EntityCollection(
+            self,
+            RoomList,
+            ResourcePath("microsoft.graph.roomlist", ResourcePath("places")),
+        )
+
     @property
     def reports(self):
         """Represents a container for Azure Active Directory (Azure AD) reporting resources."""

office365/intune/audit/event.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.intune.audit.actor import AuditActor
 from office365.intune.audit.resource import AuditResource
@@ -9,9 +11,8 @@ class AuditEvent(Entity):
 
     @property
     def activity(self):
-        """Friendly name of the activity.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Friendly name of the activity."""
         return self.properties.get("activity", None)
 
     @property

office365/intune/devices/enrollment/configuration.py

@@ -1,4 +1,5 @@
 import datetime
+from typing import Optional
 
 from office365.entity import Entity
 
@@ -6,6 +7,9 @@ from office365.entity import Entity
 class DeviceEnrollmentConfiguration(Entity):
     """The Base Class of Device Enrollment Configuration"""
 
+    def __str__(self):
+        return self.display_name
+
     @property
     def created_datetime(self):
         """
@@ -15,10 +19,8 @@ class DeviceEnrollmentConfiguration(Entity):
 
     @property
     def display_name(self):
-        """
-        The display name of the device enrollment configuration
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """The display name of the device enrollment configuration"""
         return self.properties.get("displayName", None)
 
     def get_property(self, name, default_value=None):

office365/intune/devices/managed.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.intune.devices.category import DeviceCategory
@@ -17,12 +19,12 @@ class ManagedDevice(Entity):
 
     @property
     def activation_lock_bypass_code(self):
+        # type: () -> Optional[str]
         """
         The code that allows the Activation Lock on managed device to be bypassed. Default,
         is Null (Non-Default property) for this property when returned as part of managedDevice entity in LIST call.
         To retrieve actual values GET call needs to be made, with device id and included in select parameter.
         Supports: $select. $Search is not supported. Read-only. This property is read-only.
-        :rtype: str
         """
         return self.properties.get("activationLockBypassCode", None)
 
@@ -38,25 +40,20 @@ class ManagedDevice(Entity):
 
     @property
     def manufacturer(self):
-        """
-        Manufacturer of the device.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Manufacturer of the device."""
         return self.properties.get("manufacturer", None)
 
     @property
     def operating_system(self):
-        """
-        Manufacturer of the device.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Manufacturer of the device."""
         return self.properties.get("operatingSystem", None)
 
     @property
     def device_compliance_policy_states(self):
-        """
-        Device compliance policy states for this device
-        """
+        # type: () -> EntityCollection[DeviceCompliancePolicyState]
+        """Device compliance policy states for this device"""
         return self.properties.get(
             "deviceCompliancePolicyStates",
             EntityCollection(

office365/onedrive/analytics/item_activity_stat.py

@@ -1,4 +1,5 @@
 from datetime import datetime
+from typing import Optional
 
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
@@ -38,9 +39,8 @@ class ItemActivityStat(Entity):
 
     @property
     def is_trending(self):
-        """Indicates whether the item is trending.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Indicates whether the item is trending."""
         return self.properties.get("isTrending", None)
 
     @property
@@ -55,6 +55,7 @@ class ItemActivityStat(Entity):
 
     @property
     def activities(self):
+        # type: () -> EntityCollection[ItemActivity]
         """Exposes the itemActivities represented in this itemActivityStat resource."""
         return self.properties.get(
             "activities",

office365/onedrive/columns/column_link.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 
 
@@ -6,8 +8,6 @@ class ColumnLink(Entity):
 
     @property
     def name(self):
-        """
-        The name of the column in this content type.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The name of the column in this content type."""
         return self.properties.get("name", None)