Office365-REST-Python-Client 2.5.5__py3-none-any.whl → 2.5.6__py3-none-any.whl

office365/graph_client.py

@@ -6,6 +6,12 @@ from office365.delta_collection import DeltaCollection
 from office365.directory.applications.collection import ApplicationCollection
 from office365.directory.applications.template import ApplicationTemplate
 from office365.directory.audit.log_root import AuditLogRoot
+from office365.directory.authentication.method_configuration import (
+    AuthenticationMethodConfiguration,
+)
+from office365.directory.certificates.auth_configuration import (
+    CertificateBasedAuthConfiguration,
+)
 from office365.directory.directory import Directory
 from office365.directory.domains.domain import Domain
 from office365.directory.extensions.schema import SchemaExtension
@@ -35,6 +41,7 @@ from office365.directory.users.user import User
 from office365.education.root import EducationRoot
 from office365.entity_collection import EntityCollection
 from office365.intune.devices.app_management import DeviceAppManagement
+from office365.intune.devices.collection import DeviceCollection
 from office365.intune.devices.management.management import DeviceManagement
 from office365.intune.organizations.contact import OrgContact
 from office365.intune.organizations.organization import Organization
@@ -65,19 +72,31 @@ from office365.teams.collection import TeamCollection
 from office365.teams.template import TeamsTemplate
 from office365.teams.viva.employee_experience import EmployeeExperience
 
+environments_endpoints = {
+    "GCCH": {
+        "graph_url": "https://graph.microsoft.com",
+        "entra_url": "https://login.microsoftonline.com",
+    },
+    "GCC High": {
+        "graph_url": "https://graph.microsoft.us",
+        "entra_url": "https://login.microsoftonline.us",
+    },
+    "DoD": {
+        "graph_url": "https://dod-graph.microsoft.us",
+        "entra_url": "https://login.chinacloudapi.cn",
+    },
+}
+
 
 class GraphClient(ClientRuntimeContext):
     """Graph Service client"""
 
-    def __init__(self, acquire_token_callback):
-        # type: (Callable[[], dict]) -> None
-        """
-        :param () -> dict acquire_token_callback: Acquire token function
-        """
+    def __init__(self, acquire_token_callback, version="v1.0", environment="GCCH"):
+        # type: (Callable[[], dict], str, str) -> None
         super(GraphClient, self).__init__()
         self._pending_request = None
-        self._resource = "https://graph.microsoft.com"
-        self._authority_host_url = "https://login.microsoftonline.com"
+        self._version = version
+        self._environment_endpoints = environments_endpoints.get(environment, None)
         self._acquire_token_callback = acquire_token_callback
 
     @staticmethod
@@ -130,7 +149,7 @@ class GraphClient(ClientRuntimeContext):
         :param str client_secret: Client secret
         :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
+             Refer https://msal-python.readthedocs.io/en/latest/#msal.SerializableTokenCache
         """
         if scopes is None:
             scopes = ["https://graph.microsoft.com/.default"]
@@ -248,7 +267,7 @@ class GraphClient(ClientRuntimeContext):
 
     def service_root_url(self):
         # type: () -> str
-        return "https://graph.microsoft.com/v1.0"
+        return "https://graph.microsoft.com/{0}".format(self._version)
 
     def _build_specific_query(self, request):
         # type: (RequestOptions) -> None
@@ -334,6 +353,11 @@ class GraphClient(ClientRuntimeContext):
         """Directory Objects container"""
         return DirectoryObjectCollection(self, ResourcePath("directoryObjects"))
 
+    @property
+    def devices(self):
+        """Devices container"""
+        return DeviceCollection(self, ResourcePath("devices"))
+
     @property
     def teams(self):
         """Teams container"""
@@ -393,11 +417,29 @@ class GraphClient(ClientRuntimeContext):
             self, ApplicationTemplate, ResourcePath("applicationTemplates")
         )
 
+    @property
+    def authentication_method_configurations(self):
+        """Get the list of application templates in this organization."""
+        return EntityCollection(
+            self,
+            AuthenticationMethodConfiguration,
+            ResourcePath("authenticationMethodConfigurations"),
+        )
+
     @property
     def applications(self):
         """Get the list of applications in this organization."""
         return ApplicationCollection(self, ResourcePath("applications"))
 
+    @property
+    def certificate_based_auth_configuration(self):
+        """Get the list of applications in this organization."""
+        return EntityCollection(
+            self,
+            CertificateBasedAuthConfiguration,
+            ResourcePath("certificateBasedAuthConfiguration"),
+        )
+
     @property
     def service_principals(self):
         """Retrieve a list of servicePrincipal objects."""
@@ -429,16 +471,12 @@ class GraphClient(ClientRuntimeContext):
 
     @property
     def communications(self):
-        """
-        Cloud communications API endpoint
-        """
+        """Cloud communications API endpoint"""
         return CloudCommunications(self, ResourcePath("communications"))
 
     @property
     def identity_governance(self):
-        """
-        The identity governance singleton
-        """
+        """The identity governance singleton"""
         return IdentityGovernance(self, ResourcePath("identityGovernance"))
 
     @property
@@ -503,9 +541,7 @@ class GraphClient(ClientRuntimeContext):
 
     @property
     def teams_templates(self):
-        """
-        Get the list of teams templates.
-        """
+        """Get the list of teams templates."""
         return EntityCollection(self, TeamsTemplate, ResourcePath("teamsTemplates"))
 
     @property
@@ -518,34 +554,26 @@ class GraphClient(ClientRuntimeContext):
 
     @property
     def permission_grants(self):
-        """
-        List all resource-specific permission grants
-        """
+        """List all resource-specific permission grants"""
         return EntityCollection(
             self, ResourceSpecificPermissionGrant, ResourcePath("permissionGrants")
         )
 
     @property
     def print(self):
-        """
-        Used to manage printers and print jobs within Universal Print.
-        """
+        """Used to manage printers and print jobs within Universal Print."""
         from office365.intune.printing.print import Print
 
         return Print(self, ResourcePath("print"))
 
     @property
     def search(self):
-        """
-        The search endpoint is the entry point for Microsoft Search API to query data.
-        """
+        """The search endpoint is the entry point for Microsoft Search API to query data."""
         return SearchEntity(self, ResourcePath("search"))
 
     @property
     def employee_experience(self):
-        """
-        An alias to EmployeeExperience
-        """
+        """An alias to EmployeeExperience"""
         return EmployeeExperience(self, ResourcePath("employeeExperience"))
 
     @property

office365/intune/audit/event.py

@@ -17,9 +17,7 @@ class AuditEvent(Entity):
 
     @property
     def actor(self):
-        """
-        AAD user and application that are associated with the audit event.
-        """
+        """AAD user and application that are associated with the audit event."""
         return self.properties.get("actor", AuditActor())
 
     @property

office365/intune/audit/event_collection.py

@@ -5,7 +5,7 @@ from office365.runtime.queries.function import FunctionQuery
 from office365.runtime.types.collections import StringCollection
 
 
-class AuditEventCollection(EntityCollection):
+class AuditEventCollection(EntityCollection[AuditEvent]):
     def __init__(self, context, resource_path=None):
         super(AuditEventCollection, self).__init__(context, AuditEvent, resource_path)
 

office365/intune/devices/alternative_security_id.py

@@ -3,3 +3,7 @@ from office365.runtime.client_value import ClientValue
 
 class AlternativeSecurityId(ClientValue):
     """"""
+
+    def __init__(self, type_=None, key=None):
+        self.type = type_
+        self.key = key

office365/intune/devices/collection.py

@@ -0,0 +1,57 @@
+import random
+import string
+import uuid
+
+from office365.delta_collection import DeltaCollection
+from office365.intune.devices.alternative_security_id import AlternativeSecurityId
+from office365.intune.devices.device import Device
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.runtime.queries.create_entity import CreateEntityQuery
+
+
+class DeviceCollection(DeltaCollection[Device]):
+    """Device's collection"""
+
+    def __init__(self, context, resource_path=None):
+        super(DeviceCollection, self).__init__(context, Device, resource_path)
+
+    def add(
+        self,
+        display_name,
+        operating_system,
+        operating_system_version,
+        account_enabled=False,
+        alternative_security_id=None,
+        device_id=None,
+    ):
+        """Create and register a new device in the organization.
+        :param str display_name: The display name for the device
+        :param str operating_system:
+        :param str operating_system_version:
+        :param bool account_enabled:
+        :param AlternativeSecurityId alternative_security_id:
+        :param str device_id:
+        """
+
+        if alternative_security_id is None:
+            key_id = "base64" + "".join(
+                random.choice(string.ascii_lowercase + string.digits) for _ in range(10)
+            )
+            alternative_security_id = AlternativeSecurityId(2, key_id)
+        if device_id is None:
+            device_id = str(uuid.uuid4())
+
+        return_type = Device(self.context)
+        return_type.set_property("displayName", display_name)
+        return_type.set_property("operatingSystem", operating_system)
+        return_type.set_property("operatingSystemVersion", operating_system_version)
+        return_type.set_property("accountEnabled", account_enabled)
+        return_type.set_property("deviceId", device_id)
+        return_type.set_property(
+            "alternativeSecurityIds",
+            ClientValueCollection(AlternativeSecurityId, [alternative_security_id]),
+        )
+        self.add_child(return_type)
+        qry = CreateEntityQuery(self, return_type, return_type)
+        self.context.add_query(qry)
+        return return_type

office365/intune/devices/device.py

@@ -1,5 +1,9 @@
+from typing import Optional
+
 from office365.directory.object import DirectoryObject
 from office365.directory.object_collection import DirectoryObjectCollection
+from office365.intune.devices.alternative_security_id import AlternativeSecurityId
+from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
 
 
@@ -10,16 +14,28 @@ class Device(DirectoryObject):
     authentication. These devices can range from desktop and laptop machines to phones and tablets.
     """
 
-    def get_property(self, name, default_value=None):
-        if default_value is None:
-            property_mapping = {
-                "memberOf": self.member_of,
-                "registeredOwners": self.registered_owners,
-                "registeredUsers": self.registered_users,
-                "transitiveMemberOf": self.transitive_member_of,
-            }
-            default_value = property_mapping.get(name, None)
-        return super(Device, self).get_property(name, default_value)
+    def __repr__(self):
+        return self.device_id or self.entity_type_name
+
+    @property
+    def alternative_security_ids(self):
+        """For internal use only."""
+        return self.properties.get(
+            "alternativeSecurityIds", ClientValueCollection(AlternativeSecurityId)
+        )
+
+    @property
+    def device_id(self):
+        # type: () -> Optional[str]
+        """Unique identifier set by Azure Device Registration Service at the time of registration.
+        This is an alternate key that can be used to reference the device object."""
+        return self.properties.get("deviceId", None)
+
+    @property
+    def device_ownership(self):
+        # type: () -> Optional[str]
+        """Ownership of the device. This property is set by Intune. Possible values are: unknown, company, personal."""
+        return self.properties.get("deviceOwnership", None)
 
     @property
     def member_of(self):
@@ -65,3 +81,15 @@ class Device(DirectoryObject):
                 self.context, ResourcePath("transitiveMemberOf", self.resource_path)
             ),
         )
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "alternativeSecurityIds": self.alternative_security_ids,
+                "memberOf": self.member_of,
+                "registeredOwners": self.registered_owners,
+                "registeredUsers": self.registered_users,
+                "transitiveMemberOf": self.transitive_member_of,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(Device, self).get_property(name, default_value)

office365/intune/devices/management/management.py

@@ -1,3 +1,4 @@
+from office365.directory.rolemanagement.role_permission import RolePermission
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.intune.audit.event_collection import AuditEventCollection
@@ -8,7 +9,10 @@ from office365.intune.devices.enrollment.configuration import (
 )
 from office365.intune.devices.managed import ManagedDevice
 from office365.intune.devices.management.reports.reports import DeviceManagementReports
+from office365.runtime.client_result import ClientResult
+from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.function import FunctionQuery
 
 
 class DeviceManagement(Entity):
@@ -18,6 +22,14 @@ class DeviceManagement(Entity):
     configuration.
     """
 
+    def get_effective_permissions(self, scope=None):
+        """Retrieves the effective permissions of the currently authenticated user"""
+        return_type = ClientResult(self.context, ClientValueCollection(RolePermission))
+        # params = {"scope": scope}
+        qry = FunctionQuery(self, "getEffectivePermissions", None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def audit_events(self):
         """"""

office365/intune/organizations/organization.py

@@ -43,6 +43,7 @@ class Organization(DirectoryObject):
 
     @property
     def extensions(self):
+        # type: () -> EntityCollection[Extension]
         """The collection of open extensions defined for the message. Nullable."""
         return self.properties.get(
             "extensions",

office365/onedrive/analytics/item_activity_stat.py

@@ -65,3 +65,12 @@ class ItemActivityStat(Entity):
                 ResourcePath("activities", self.resource_path),
             ),
         )
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "endDateTime": self.end_datetime,
+                "startDateTime": self.start_datetime,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(ItemActivityStat, self).get_property(name, default_value)

office365/onedrive/analytics/item_analytics.py

@@ -19,6 +19,7 @@ class ItemAnalytics(Entity):
 
     @property
     def item_activity_stats(self):
+        # type: () -> EntityCollection[ItemActivityStat]
         return self.properties.get(
             "itemActivityStats",
             EntityCollection(

office365/onedrive/contenttypes/content_type.py

@@ -20,9 +20,7 @@ class ContentType(BaseItem):
     columns that must be present on every listItem in a list."""
 
     def is_published(self):
-        """
-        Check the publishing status of a contentType in a content type hub site.
-        """
+        """Check the publishing status of a contentType in a content type hub site."""
         return_type = ClientResult(self.context, bool())
         qry = FunctionQuery(self, "isPublished", None, return_type)
         self.context.add_query(qry)
@@ -57,9 +55,7 @@ class ContentType(BaseItem):
         return self
 
     def unpublish(self):
-        """
-        Unpublish a contentType from a content type hub site.
-        """
+        """Unpublish a contentType from a content type hub site."""
         qry = ServiceOperationQuery(self, "unpublish")
         self.context.add_query(qry)
         return self
@@ -75,9 +71,7 @@ class ContentType(BaseItem):
 
     @property
     def document_set(self):
-        """
-        Document Set metadata.
-        """
+        """Document Set metadata."""
         return self.properties.get("documentSet", DocumentSet())
 
     @property
@@ -115,9 +109,7 @@ class ContentType(BaseItem):
     @property
     def read_only(self):
         # type: () -> Optional[bool]
-        """
-        If true, the content type cannot be modified unless this value is first set to false.
-        """
+        """If true, the content type cannot be modified unless this value is first set to false."""
         return self.properties.get("readOnly", None)
 
     @property

office365/onedrive/driveitems/driveItem.py

@@ -209,7 +209,8 @@ class DriveItem(BaseItem):
         :param int chunk_size: chunk size
         """
 
-        def _start_upload():
+        def _start_upload(result):
+            # type: (ClientResult[UploadSession]) -> None
             with open(source_path, "rb") as local_file:
                 session_request = UploadSessionRequest(
                     local_file, chunk_size, chunk_uploaded

office365/onedrive/files/hashes.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class Hashes(ClientValue):
+    """The Hashes resource groups available hashes into a single structure for an item."""

office365/onedrive/lists/collection.py

@@ -1,6 +1,6 @@
 from office365.entity_collection import EntityCollection
 from office365.onedrive.lists.list import List
-from office365.runtime.paths.item import ItemPath
+from office365.runtime.paths.v4.entity import EntityPath
 from office365.runtime.queries.create_entity import CreateEntityQuery
 
 
@@ -17,7 +17,7 @@ class ListCollection(EntityCollection[List]):
         :param str display_name: The displayable title of the list.
         :param str list_template: The base list template used in creating the list
         """
-        return_type = List(self.context, ItemPath(self.resource_path))
+        return_type = List(self.context, EntityPath(None, self.resource_path))
         self.add_child(return_type)
         payload = {
             "displayName": display_name,

office365/onedrive/operations/long_running.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 
 
@@ -6,14 +8,12 @@ class LongRunningOperation(Entity):
 
     @property
     def resource_location(self):
-        """URI of the resource that the operation is performed on.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """URI of the resource that the operation is performed on."""
         return self.properties.get("resourceLocation", None)
 
     @property
     def status_detail(self):
-        """Details about the status of the operation.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Details about the status of the operation."""
         return self.properties.get("statusDetail", None)

office365/onedrive/operations/rich_long_running.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.onedrive.operations.long_running import LongRunningOperation
 
 
@@ -6,7 +8,6 @@ class RichLongRunningOperation(LongRunningOperation):
 
     @property
     def resource_id(self):
-        """The unique identifier for the result.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The unique identifier for the result."""
         return self.properties.get("resourceId", None)

office365/onedrive/permissions/collection.py

@@ -69,19 +69,6 @@ class PermissionCollection(EntityCollection[Permission]):
         identity.ensure_properties(["displayName"], _add)
         return return_type
 
-    def delete(self, roles, identity):
-        # type: (list[str], Application|User|Group|Device) -> Permission
-        """Deletes the permission."""
-
-        def _delete(col):
-            pass
-
-        def _identity_loaded():
-            self.get_all(page_loaded=_delete)
-
-        identity.ensure_property("id", _identity_loaded)
-        return self
-
     def delete_all(self):
         """Remove all access to resource"""
 
@@ -90,5 +77,5 @@ class PermissionCollection(EntityCollection[Permission]):
             for permission in return_type:
                 permission.delete_object()
 
-        self.context.load(self, after_loaded=_after_loaded)
+        self.get().after_execute(_after_loaded)
         return self

office365/onedrive/sharepoint_settings.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.runtime.types.collections import StringCollection
 
@@ -26,26 +28,24 @@ class SharepointSettings(Entity):
 
     @property
     def site_creation_default_managed_path(self):
+        # type: () -> Optional[str]
         """
         The value of the team site managed path. This is the path under which new team sites will be created.
-        :rtype: str
         """
         return self.properties.get("siteCreationDefaultManagedPath", None)
 
     @property
     def site_creation_default_storage_limit_in_mb(self):
-        """
-        The default storage quota for a new site upon creation. Measured in megabytes (MB).
-        :rtype: int
-        """
+        # type: () -> Optional[int]
+        """The default storage quota for a new site upon creation. Measured in megabytes (MB)."""
         return self.properties.get("siteCreationDefaultStorageLimitInMB", None)
 
     @property
     def tenant_default_timezone(self):
+        # type: () -> Optional[str]
         """
         The default timezone of a tenant for newly created sites. For a list of possible values,
         see SPRegionalSettings.TimeZones property.
-        :rtype: str
         """
         return self.properties.get("tenantDefaultTimezone", None)
 

office365/onedrive/sites/sites_with_root.py

@@ -15,9 +15,7 @@ class SitesWithRoot(EntityCollection[Site]):
         super(SitesWithRoot, self).__init__(context, Site, resource_path)
 
     def get_all_sites(self):
-        """
-        List root sites across geographies in an organization.
-        """
+        """List root sites across geographies in an organization."""
         return_type = SitesWithRoot(self.context)
         qry = FunctionQuery(self, "getAllSites", return_type=return_type)
         self.context.add_query(qry)

office365/onedrive/termstore/store.py

@@ -3,7 +3,6 @@ from typing import Optional
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.onedrive.termstore.groups.collection import GroupCollection
-from office365.onedrive.termstore.groups.group import Group
 from office365.onedrive.termstore.sets.collection import SetCollection
 from office365.onedrive.termstore.sets.set import Set
 from office365.runtime.paths.resource_path import ResourcePath
@@ -23,10 +22,9 @@ class Store(Entity):
 
         def _groups_loaded(groups):
             # type: (GroupCollection) -> None
-            for g in groups:
-                self.context.load(g.sets, after_loaded=_sets_loaded)
+            [grp.sets.get().after_execute(_sets_loaded) for grp in groups]
 
-        self.context.load(self.groups, after_loaded=_groups_loaded)
+        self.groups.get().after_execute(_groups_loaded)
 
         return return_type
 

office365/onedrive/termstore/terms/collection.py

@@ -5,7 +5,7 @@ from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.queries.create_entity import CreateEntityQuery
 
 
-class TermCollection(EntityCollection):
+class TermCollection(EntityCollection[Term]):
     def __init__(self, context, resource_path=None, parent_set=None):
         """
         :param office365.onedrive.termstore.sets.set.Set parent_set: The parent set that contains the term
@@ -17,7 +17,6 @@ class TermCollection(EntityCollection):
         """Create a new term object.
 
         :param str label: The name of the label.
-        :rtype: Term
         """
         return_type = Term(self.context)
         self.add_child(return_type)

office365/onedrive/workbooks/filter.py

@@ -1,5 +1,14 @@
+from typing import Optional
+
 from office365.entity import Entity
+from office365.onedrive.workbooks.filter_criteria import WorkbookFilterCriteria
 
 
 class WorkbookFilter(Entity):
     """Manages the filtering of a table's column."""
+
+    @property
+    def criteria(self):
+        # type: () -> Optional[WorkbookFilterCriteria]
+        """The currently applied filter on the given column."""
+        return self.properties.get("criteria", WorkbookFilterCriteria())