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

office365/communications/onlinemeetings/online_meeting.py

@@ -2,8 +2,13 @@ from datetime import datetime
 from typing import AnyStr, Optional
 
 from office365.communications.onlinemeetings.participants import MeetingParticipants
+from office365.communications.onlinemeetings.recordings.call import CallRecording
 from office365.entity import Entity
+from office365.entity_collection import EntityCollection
 from office365.outlook.mail.item_body import ItemBody
+from office365.runtime.client_result import ClientResult
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.function import FunctionQuery
 from office365.runtime.types.collections import StringCollection
 
 
@@ -13,6 +18,17 @@ class OnlineMeeting(Entity):
     the attendees list, and the description.
     """
 
+    def get_virtual_appointment_join_web_url(self):
+        """Get a join web URL for a Microsoft Virtual Appointment. This web URL includes enhanced
+        business-to-customer experiences such as mobile browser join and virtual lobby rooms.
+        With Teams Premium, you can configure a custom lobby room experience for attendees by adding your company
+        logo and access the Virtual Appointments usage report for organizational analytics.
+        """
+        return_type = ClientResult(self.context, str())
+        qry = FunctionQuery(self, "getVirtualAppointmentJoinWebUrl", None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def allow_attendee_to_enable_camera(self):
         # type: () -> Optional[bool]
@@ -74,9 +90,7 @@ class OnlineMeeting(Entity):
     @start_datetime.setter
     def start_datetime(self, value):
         # type: (datetime) -> None
-        """
-        Sets the meeting start time in UTC.
-        """
+        """Sets the meeting start time in UTC."""
         self.set_property("startDateTime", value.isoformat())
 
     @property
@@ -107,6 +121,19 @@ class OnlineMeeting(Entity):
         """The video teleconferencing ID."""
         return self.properties.get("videoTeleconferenceId", None)
 
+    @property
+    def recordings(self):
+        # type: () -> EntityCollection[CallRecording]
+        """he recordings of an online meeting"""
+        return self.properties.get(
+            "recordings",
+            EntityCollection(
+                self.context,
+                CallRecording,
+                ResourcePath("recordings", self.resource_path),
+            ),
+        )
+
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {

office365/communications/onlinemeetings/recordings/call.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class CallRecording(Entity):
+    """Represents a recording associated with an online meeting."""

office365/directory/administrative_unit.py

@@ -21,10 +21,17 @@ class AdministrativeUnit(DirectoryObject):
         return self.properties.get("displayName", None)
 
     @property
-    def members(self):
+    def visibility(self):
         """
-        Users and groups that are members of this administrative unit
+        Controls whether the administrative unit and its members are hidden or public. Can be set to HiddenMembership.
+        If not set (value is null), the default behavior is public. When set to HiddenMembership, only members of
+        the administrative unit can list other members of the administrative unit.
         """
+        return self.properties.get("visibility", None)
+
+    @property
+    def members(self):
+        """Users and groups that are members of this administrative unit"""
         from office365.directory.object_collection import DirectoryObjectCollection
 
         return self.properties.get(

office365/directory/applications/roles/collection.py

@@ -10,4 +10,8 @@ class AppRoleCollection(ClientValueCollection[AppRole]):
 
     def __getitem__(self, key):
         # type: (str) -> AppRole
-        return next(iter([item for item in self._data if item.value == key]), None)
+        return self.get_by_value(key)
+
+    def get_by_value(self, value):
+        # type: (str) -> AppRole
+        return next(iter([item for item in self._data if item.value == value]), None)

office365/directory/applications/roles/role.py

@@ -38,4 +38,4 @@ class AppRole(ClientValue):
         return "{0}  {1}".format(self.allowedMemberTypes, self.value)
 
     def __repr__(self):
-        return "{0}".format(self.id)
+        return self.value or self.id or self.entity_type_name

office365/directory/audit/provisioning/object_summary.py

@@ -1,3 +1,6 @@
+from datetime import datetime
+from typing import Optional
+
 from office365.directory.audit.provisioning.service_principal import (
     ProvisioningServicePrincipal,
 )
@@ -7,6 +10,29 @@ from office365.entity import Entity
 class ProvisioningObjectSummary(Entity):
     """Represents an action performed by the Azure AD Provisioning service and its associated properties."""
 
+    @property
+    def activity_datetime(self):
+        """Represents date and time information using ISO 8601 format and is always in UTC time."""
+        return self.properties.get("activityDateTime", datetime.min)
+
+    @property
+    def change_id(self):
+        # type: () -> Optional[str]
+        """Unique ID of this change in this cycle. Supports $filter (eq, contains)."""
+        return self.properties.get("changeId", None)
+
+    @property
+    def cycle_id(self):
+        # type: () -> Optional[str]
+        """Unique ID per job iteration. Supports $filter (eq, contains)."""
+        return self.properties.get("cycleId", None)
+
+    @property
+    def duration_in_milliseconds(self):
+        # type: () -> Optional[int]
+        """Indicates how long this provisioning action took to finish. Measured in milliseconds."""
+        return self.properties.get("durationInMilliseconds", None)
+
     @property
     def service_principal(self):
         """Represents the service principal used for provisioning."""
@@ -14,6 +40,9 @@ class ProvisioningObjectSummary(Entity):
 
     def get_property(self, name, default_value=None):
         if default_value is None:
-            property_mapping = {"servicePrincipal": self.service_principal}
+            property_mapping = {
+                "activityDateTime": self.activity_datetime,
+                "servicePrincipal": self.service_principal,
+            }
             default_value = property_mapping.get(name, None)
         return super(ProvisioningObjectSummary, self).get_property(name, default_value)

office365/directory/authentication/methods/fido.py

@@ -1,5 +1,13 @@
+from typing import Optional
+
 from office365.directory.authentication.methods.method import AuthenticationMethod
 
 
 class Fido2AuthenticationMethod(AuthenticationMethod):
     """Representation of a FIDO2 security key registered to a user. FIDO2 is a sign-in authentication method."""
+
+    @property
+    def model(self):
+        # type: () -> Optional[str]
+        """The manufacturer-assigned model of the FIDO2 security key."""
+        return self.properties.get("model", None)

office365/directory/authentication/methods/password.py

@@ -1,6 +1,29 @@
+from datetime import datetime
+from typing import Optional
+
 from office365.directory.authentication.methods.method import AuthenticationMethod
 
 
 class PasswordAuthenticationMethod(AuthenticationMethod):
     """A representation of a user's password. For security, the password itself will never be returned in the object,
     but action can be taken to reset a password."""
+
+    @property
+    def created_datetime(self):
+        # type: () -> datetime
+        """The date and time when this password was last updated. This property is currently not populated."""
+        return self.properties.get("createdDateTime", datetime.min)
+
+    @property
+    def password(self):
+        # type: () -> Optional[str]
+        """For security, the password is always returned as null from a LIST or GET operation."""
+        return self.properties.get("password", None)
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {"createdDateTime": self.created_datetime}
+            default_value = property_mapping.get(name, None)
+        return super(PasswordAuthenticationMethod, self).get_property(
+            name, default_value
+        )

office365/directory/custom_security_attribute_definition.py

@@ -0,0 +1,7 @@
+from office365.entity import Entity
+
+
+class CustomSecurityAttributeDefinition(Entity):
+    """Represents the schema of a custom security attribute (key-value pair).
+    For example, the custom security attribute name, description, data type, and allowed values.
+    """

office365/directory/device_local_credential_info.py

@@ -0,0 +1,6 @@
+from office365.entity import Entity
+
+
+class DeviceLocalCredentialInfo(Entity):
+    """Represents local administrator credential information for all device objects in Azure Active Directory
+    that are enabled with Local Admin Password Solution (LAPS)."""

office365/directory/directory.py

@@ -1,4 +1,8 @@
 from office365.directory.administrative_unit import AdministrativeUnit
+from office365.directory.custom_security_attribute_definition import (
+    CustomSecurityAttributeDefinition,
+)
+from office365.directory.device_local_credential_info import DeviceLocalCredentialInfo
 from office365.directory.object_collection import DirectoryObjectCollection
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
@@ -10,6 +14,42 @@ class Directory(Entity):
     "container". Deleted items will remain available to restore for up to 30 days. After 30 days, the items are
     permanently deleted."""
 
+    @property
+    def device_local_credentials(self):
+        """Conceptual container for user and group directory objects."""
+        return self.properties.get(
+            "deviceLocalCredentials",
+            EntityCollection(
+                self.context,
+                DeviceLocalCredentialInfo,
+                ResourcePath("deviceLocalCredentials", self.resource_path),
+            ),
+        )
+
+    @property
+    def administrative_units(self):
+        """Conceptual container for user and group directory objects."""
+        return self.properties.get(
+            "administrativeUnits",
+            EntityCollection(
+                self.context,
+                AdministrativeUnit,
+                ResourcePath("administrativeUnits", self.resource_path),
+            ),
+        )
+
+    @property
+    def custom_security_attribute_definitions(self):
+        """Conceptual container for customSecurityAttributeDefinition objects and their properties."""
+        return self.properties.get(
+            "customSecurityAttributeDefinitions",
+            EntityCollection(
+                self.context,
+                CustomSecurityAttributeDefinition,
+                ResourcePath("customSecurityAttributeDefinitions", self.resource_path),
+            ),
+        )
+
     def deleted_items(self, entity_type=None):
         """Recently deleted items. Read-only. Nullable."""
         if entity_type:
@@ -27,18 +67,6 @@ class Directory(Entity):
                 ),
             )
 
-    @property
-    def administrative_units(self):
-        """Conceptual container for user and group directory objects."""
-        return self.properties.get(
-            "administrativeUnits",
-            EntityCollection(
-                self.context,
-                AdministrativeUnit,
-                ResourcePath("administrativeUnits", self.resource_path),
-            ),
-        )
-
     @property
     def deleted_groups(self):
         """Recently deleted groups"""

office365/directory/identitygovernance/appconsent/request_collection.py

@@ -3,7 +3,7 @@ from office365.entity_collection import EntityCollection
 from office365.runtime.queries.function import FunctionQuery
 
 
-class AppConsentRequestCollection(EntityCollection):
+class AppConsentRequestCollection(EntityCollection[AppConsentRequest]):
     """AppConsentRequest's collection"""
 
     def __init__(self, context, resource_path=None):

office365/directory/identitygovernance/entitlementmanagement/entitlement_management.py

@@ -0,0 +1,7 @@
+from office365.entity import Entity
+
+
+class EntitlementManagement(Entity):
+    """The entitlement management singleton is the container for entitlement management resources,
+    including accessPackageCatalog, connectedOrganization, and entitlementManagementSettings.
+    """

office365/directory/identitygovernance/governance.py

@@ -2,6 +2,9 @@ from office365.directory.identitygovernance.accessreview.set import AccessReview
 from office365.directory.identitygovernance.appconsent.approval_route import (
     AppConsentApprovalRoute,
 )
+from office365.directory.identitygovernance.entitlementmanagement.entitlement_management import (
+    EntitlementManagement,
+)
 from office365.directory.identitygovernance.privilegedaccess.root import (
     PrivilegedAccessRoot,
 )
@@ -68,3 +71,16 @@ class IdentityGovernance(Entity):
                 self.context, ResourcePath("termsOfUse", self.resource_path)
             ),
         )
+
+    @property
+    def entitlement_management(self):
+        """
+        Container for entitlement management resources, including accessPackageCatalog, connectedOrganization,
+        and entitlementManagementSettings.
+        """
+        return self.properties.get(
+            "entitlementManagement",
+            EntitlementManagement(
+                self.context, ResourcePath("entitlementManagement", self.resource_path)
+            ),
+        )

office365/directory/identitygovernance/termsofuse/agreement_acceptance.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 
 
@@ -6,3 +8,9 @@ class AgreementAcceptance(Entity):
     Represents the current status of a user's response to a company's customizable terms of use agreement powered by
     Azure Active Directory (Azure AD).
     """
+
+    @property
+    def user_principal_name(self):
+        # type: () -> Optional[str]
+        """UPN of the user when the acceptance was recorded."""
+        return self.properties.get("userPrincipalName", None)

office365/directory/identitygovernance/userconsent/request_collection.py

@@ -4,7 +4,7 @@ from office365.directory.identitygovernance.userconsent.request import (
 from office365.entity_collection import EntityCollection
 
 
-class UserConsentRequestCollection(EntityCollection):
+class UserConsentRequestCollection(EntityCollection[UserConsentRequest]):
     """AppConsentRequest's collection"""
 
     def __init__(self, context, resource_path=None):

office365/directory/insights/resource_reference.py

@@ -15,7 +15,7 @@ class ResourceReference(ClientValue):
         self.webUrl = web_url
 
     def __str__(self):
-        return self.type
+        return self.type or ""
 
     def __repr__(self):
         return "{0}:{1}".format(self.type, self.webUrl)

office365/directory/policies/device_registration.py

@@ -0,0 +1,6 @@
+from office365.entity import Entity
+
+
+class DeviceRegistrationPolicy(Entity):
+    """Represents the policy scope that controls quota restrictions, additional authentication, and authorization
+    policies to register device identities to your organization."""

office365/directory/policies/root.py

@@ -9,6 +9,7 @@ from office365.directory.policies.authentication_strength import (
 from office365.directory.policies.authorization import AuthorizationPolicy
 from office365.directory.policies.conditional_access import ConditionalAccessPolicy
 from office365.directory.policies.cross_tenant_access import CrossTenantAccessPolicy
+from office365.directory.policies.device_registration import DeviceRegistrationPolicy
 from office365.directory.policies.permission_grant import PermissionGrantPolicy
 from office365.directory.policies.tenant_app_management import TenantAppManagementPolicy
 from office365.entity import Entity
@@ -33,6 +34,17 @@ class PolicyRoot(Entity):
             ),
         )
 
+    @property
+    def device_registration_policy(self):
+        """ """
+        return self.properties.get(
+            "deviceRegistrationPolicy",
+            DeviceRegistrationPolicy(
+                self.context,
+                ResourcePath("deviceRegistrationPolicy", self.resource_path),
+            ),
+        )
+
     def authentication_strength_policies(self):
         # type: () -> EntityCollection[AuthenticationStrengthPolicy]
         """
@@ -147,6 +159,7 @@ class PolicyRoot(Entity):
                 "conditional_access_policies": self.conditional_access_policies,
                 "crossTenantAccessPolicy": self.cross_tenant_access_policy,
                 "defaultAppManagementPolicy": self.default_app_management_policy,
+                "deviceRegistrationPolicy": self.device_registration_policy,
                 "permissionGrantPolicies": self.permission_grant_policies,
             }
             default_value = property_mapping.get(name, None)

office365/directory/security/threatintelligence/article_indicator.py

@@ -0,0 +1,7 @@
+from office365.entity import Entity
+
+
+class ArticleIndicator(Entity):
+    """
+    Represents a resource that communicates indicators of threat or compromise related to the contents of an article
+    """

office365/directory/serviceprincipals/service_principal.py

@@ -17,6 +17,7 @@ from office365.directory.password_credential import PasswordCredential
 from office365.directory.permissions.grants.oauth2 import OAuth2PermissionGrant
 from office365.directory.permissions.scope import PermissionScope
 from office365.directory.synchronization.synchronization import Synchronization
+from office365.directory.users.user import User
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.appid import AppIdPath
@@ -101,7 +102,82 @@ class ServicePrincipal(DirectoryObject):
         self.context.add_query(qry)
         return return_type
 
-    def grant(self, app, app_role):
+    def _ensure_client_service_principal(self, app, action):
+        if isinstance(app, Application):
+
+            def _after():
+                action(app)
+
+            app.ensure_property("id", _after)
+        else:
+            self.context.service_principals.get_by_app(app).get().after_execute(action)
+
+    def grant_delegated(self, app, principal, scope):
+        # type: (Application|str, User|str, AppRole|str) -> Self
+        """Grants a delegated permission to the client service principal on behalf of a user"""
+
+        def _grant_delegated(principal_id, client_id):
+            # type: (str, str) -> None
+            self.context.oauth2_permission_grants.add(
+                clientId=client_id,
+                consentType="Principal",
+                resourceId=self.id,
+                principalId=principal_id,
+                scope=scope,
+            )
+
+        def _ensure_app(principal_id):
+            def _after(return_type):
+                _grant_delegated(principal_id, return_type.id)
+
+            self._ensure_client_service_principal(app, _after)
+
+        def _ensure_principal():
+            if isinstance(principal, User):
+
+                def _after():
+                    _ensure_app(principal.id)
+
+                principal.ensure_property("id", _after)
+            else:
+                _ensure_app(principal)
+
+        self.ensure_property("id", _ensure_principal)
+        return self
+
+    def revoke_delegated(self, app, principal, scope):
+        # type: (Application|str, User|str, AppRole|str) -> Self
+        """"""
+
+        def _revoke(app_id, principal_id):
+            # type: (str, str) -> None
+
+            def _after(return_type):
+                pass
+
+            query_text = "clientId eq '{0}' and principalId eq '{1}'".format(
+                app_id, principal_id
+            )
+            # query_text = "clientId eq '{0}'".format(app_id)
+            self.context.oauth2_permission_grants.filter(
+                query_text
+            ).get().after_execute(_after)
+
+        def _ensure_principal(return_type):
+            if isinstance(principal, User):
+
+                def _after():
+                    _revoke(principal.id, return_type.id)
+
+                principal.ensure_property("id", _after)
+            else:
+                _revoke(principal, return_type.id)
+
+        self._ensure_client_service_principal(app, _ensure_principal)
+        # self.ensure_property("id", _ensure_principal)
+        return self
+
+    def grant_application(self, app, app_role):
         # type: (Application|str, AppRole|str) -> Self
         """
         Grants an app role assignment to a client service principal
@@ -109,46 +185,54 @@ class ServicePrincipal(DirectoryObject):
         :param AppRole or str app_role: AppRole object or name
         """
 
-        def _grant(principal):
-            # type: ("ServicePrincipal") -> None
-            app_role_id = repr(app_role)
-            principal_id = principal.id
+        def _grant(principal_id, app_role_id):
+            # type: (str, str) -> None
             self.app_role_assigned_to.add(
                 principalId=principal_id, resourceId=self.id, appRoleId=app_role_id
             )
 
-        def _ensure_principal():
-            self.context.service_principals.get_by_app(app).get().after_execute(_grant)
+        def _ensure_resource():
+            def _after(return_type):
+                if isinstance(app_role, AppRole):
+                    _grant(return_type.id, app_role.id)
+                else:
+                    _grant(return_type.id, self.app_roles[app_role].id)
 
-        self.ensure_property("id", _ensure_principal)
+            self.context.service_principals.get_by_app(app).get().after_execute(_after)
+
+        self.ensure_properties(["id", "appRoles"], _ensure_resource)
         return self
 
-    def revoke(self, app, app_role):
+    def revoke_application(self, app, app_role):
         # type: (Application|str, AppRole|str) -> Self
         """Revokes an app role assignment from a client service principal"""
 
-        def _revoke(principal):
-            # type ("ServicePrincipal") -> None
-            principal_id = principal.id
-            app_role_id = repr(app_role)
-            app_role_assigned_to_ids = [
-                item.id
+        def _revoke(principal_id, app_role_id):
+            # type: (str, str) -> None
+            app_role_to_revoke = [
+                item
                 for item in self.app_role_assigned_to
-                if item.principal_id == principal_id and item.app_role_id == app_role_id
+                # if item.principal_id == principal_id and item.app_role_id == app_role_id
+                if item.principal_id == principal_id
             ]
-            if len(app_role_assigned_to_ids) > 0:
-                self.app_role_assigned_to[app_role_assigned_to_ids[0]].delete_object()
+            if len(app_role_to_revoke) > 0:
+                self.app_role_assigned_to[app_role_to_revoke[0].id].delete_object()
 
-        def _ensure_resource(principal):
-            self.ensure_properties(["id", "appRoleAssignedTo"], _revoke, principal)
-            # self.app_role_assigned_to.get_all(page_loaded=_revoke)
+        def _ensure_app_role(principal):
+            # type: ("ServicePrincipal") -> None
+            if isinstance(app_role, AppRole):
+                _revoke(principal.id, app_role.id)
+            else:
+                _revoke(principal.id, self.app_roles[app_role].id)
 
         def _ensure_principal():
-            self.context.service_principals.get_by_app(app).get().after_execute(
-                _ensure_resource
-            )
+            self.context.service_principals.get_by_app(app).select(
+                ["id"]
+            ).get().after_execute(_ensure_app_role)
 
-        self.ensure_property("id", _ensure_principal)
+        self.ensure_properties(
+            ["id", "appId", "appRoles", "appRoleAssignedTo"], _ensure_principal
+        )
         return self
 
     def remove_password(self, key_id):

office365/directory/synchronization/schema.py

@@ -1,4 +1,7 @@
+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
 
 
 class SynchronizationSchema(Entity):
@@ -9,3 +12,16 @@ class SynchronizationSchema(Entity):
 
     The following sections describe the high-level components of the synchronization schema.
     """
+
+    @property
+    def directories(self):
+        # type: () -> EntityCollection[DirectoryDefinition]
+        """Contains the collection of directories and all of their objects."""
+        return self.properties.get(
+            "directories",
+            EntityCollection(
+                self.context,
+                DirectoryDefinition,
+                ResourcePath("directories", self.resource_path),
+            ),
+        )

office365/directory/users/user.py

@@ -50,6 +50,7 @@ from office365.outlook.mail.mailbox_settings import MailboxSettings
 from office365.outlook.mail.messages.collection import MessageCollection
 from office365.outlook.mail.messages.message import Message
 from office365.outlook.mail.recipient import Recipient
+from office365.outlook.mail.tips import MailTips
 from office365.outlook.user import OutlookUser
 from office365.planner.user import PlannerUser
 from office365.runtime.client_result import ClientResult
@@ -169,6 +170,28 @@ class User(DirectoryObject):
         self.context.add_query(qry)
         return self
 
+    def get_mail_tips(self, email_addresses, mail_tips_options=None):
+        """Get the MailTips of one or more recipients as available to the signed-in user.
+        :param list[str] email_addresses: A collection of SMTP addresses of recipients to get MailTips for.
+        :param str mail_tips_options: A enumeration of flags that represents the requested mailtips.
+            Possible values are: automaticReplies, customMailTip, deliveryRestriction, externalMemberCount,
+            mailboxFullStatus, maxMessageSize, moderationStatus, recipientScope, recipientSuggestions,
+            and totalMemberCount.
+        """
+        return_type = ClientResult(self.context, ClientValueCollection(MailTips))
+        payload = {
+            "EmailAddresses": StringCollection(email_addresses),
+            "MailTipsOptions": mail_tips_options,
+        }
+        qry = ServiceOperationQuery(
+            self,
+            "getMailTips",
+            None,
+            payload,
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def send_mail(
         self,
         subject,