Office365-REST-Python-Client 2.6.0__py3-none-any.whl → 2.6.2__py3-none-any.whl

office365/directory/protection/information.py

@@ -1,4 +1,4 @@
-from office365.directory.protection.threatassessment.request import (
+from office365.directory.protection.threatassessment.requests.request import (
     ThreatAssessmentRequest,
 )
 from office365.entity import Entity
@@ -11,6 +11,77 @@ from office365.runtime.queries.create_entity import CreateEntityQuery
 class InformationProtection(Entity):
     """Exposes methods that you can use to get Microsoft Purview Information Protection labels and label policies."""
 
+    def create_email_file_assessment(
+        self, recipient_email, content_data, expected_assessment, category
+    ):
+        """Create an email assessment request
+
+        :param str recipient_email: The mail recipient whose policies are used to assess the mail.
+        :param str content_data: Base64 encoded file content. The file content can't fetch back because it isn't stored.
+        :param str expected_assessment: The expected assessment from submitter. Possible values are: block, unblock.
+        :param str category: The threat category. Possible values are: spam, phishing, malware.
+        """
+
+        from office365.directory.protection.threatassessment.requests.email_file import (
+            EmailFileAssessmentRequest,
+        )
+
+        return_type = EmailFileAssessmentRequest(self.context)
+        return_type.set_property("recipientEmail", recipient_email)
+        return_type.set_property("contentData", content_data)
+        return_type.set_property("expectedAssessment", expected_assessment)
+        return_type.set_property("category", category)
+        self.threat_assessment_requests.add_child(return_type)
+        qry = CreateEntityQuery(
+            self.threat_assessment_requests, return_type, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def create_file_assessment(
+        self, file_name, content_data, expected_assessment, category
+    ):
+        """Create a new threat assessment request.
+
+        :param str file_name: File name
+        :param str content_data: Base64 encoded file content. The file content can't fetch back because it isn't stored.
+        :param str expected_assessment: The expected assessment from submitter. Possible values are: block, unblock.
+        :param str category: The threat category. Possible values are: spam, phishing, malware.
+        """
+
+        from office365.directory.protection.threatassessment.requests.file import (
+            FileAssessmentRequest,
+        )
+
+        return_type = FileAssessmentRequest(self.context)
+        return_type.set_property("fileName", file_name)
+        return_type.set_property("contentData", content_data)
+        return_type.set_property("expectedAssessment", expected_assessment)
+        return_type.set_property("category", category)
+        self.threat_assessment_requests.add_child(return_type)
+        qry = CreateEntityQuery(
+            self.threat_assessment_requests, return_type, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def create_url_assessment(self, url, expected_assessment, category):
+        """Create a new threat assessment request."""
+        from office365.directory.protection.threatassessment.requests.url import (
+            UrlAssessmentRequest,
+        )
+
+        return_type = UrlAssessmentRequest(self.context)
+        return_type.set_property("url", url)
+        return_type.set_property("expectedAssessment", expected_assessment)
+        return_type.set_property("category", category)
+        self.threat_assessment_requests.add_child(return_type)
+        qry = CreateEntityQuery(
+            self.threat_assessment_requests, return_type, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def create_mail_assessment(
         self, message, recipient=None, expected_assessment="block", category="spam"
     ):
@@ -22,7 +93,7 @@ class InformationProtection(Entity):
         :param str category:
         """
 
-        from office365.directory.protection.threatassessment.mail_request import (
+        from office365.directory.protection.threatassessment.requests.mail import (
             MailAssessmentRequest,
         )
 

office365/directory/protection/riskyusers/collection.py

@@ -4,7 +4,7 @@ from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.runtime.types.collections import StringCollection
 
 
-class RiskyUserCollection(EntityCollection):
+class RiskyUserCollection(EntityCollection[RiskyUser]):
     """RiskyUser's collection"""
 
     def __init__(self, context, resource_path=None):

office365/directory/protection/threatassessment/{email_file_request.py → requests/email_file.py}

@@ -1,6 +1,6 @@
 from typing import Optional
 
-from office365.directory.protection.threatassessment.request import (
+from office365.directory.protection.threatassessment.requests.request import (
     ThreatAssessmentRequest,
 )
 
@@ -18,3 +18,11 @@ class EmailFileAssessmentRequest(ThreatAssessmentRequest):
         Base64 encoded .eml email file content. The file content can't fetch back because it isn't stored.
         """
         return self.properties.get("contentData", None)
+
+    @property
+    def file_name(self):
+        # type: () -> Optional[str]
+        """
+        Base64 encoded .eml email file content. The file content can't fetch back because it isn't stored.
+        """
+        return self.properties.get("fileName", None)

office365/directory/protection/threatassessment/requests/file.py

@@ -0,0 +1,10 @@
+from office365.directory.protection.threatassessment.requests.request import (
+    ThreatAssessmentRequest,
+)
+
+
+class FileAssessmentRequest(ThreatAssessmentRequest):
+    """Used to create and retrieve a file threat assessment, derived from threatAssessmentRequest.
+
+    The file can be a text file or Word document or binary file received in an email attachment.
+    """

office365/directory/protection/threatassessment/{mail_request.py → requests/mail.py}

@@ -1,4 +1,4 @@
-from office365.directory.protection.threatassessment.request import (
+from office365.directory.protection.threatassessment.requests.request import (
     ThreatAssessmentRequest,
 )
 

office365/directory/protection/threatassessment/requests/url.py

@@ -0,0 +1,9 @@
+from office365.directory.protection.threatassessment.requests.request import (
+    ThreatAssessmentRequest,
+)
+
+
+class UrlAssessmentRequest(ThreatAssessmentRequest):
+    """
+    Used to create and retrieve a URL threat assessment, derived from threatAssessmentRequest.
+    """

office365/directory/rolemanagement/app_scope.py

@@ -0,0 +1,14 @@
+from office365.entity import Entity
+
+
+class AppScope(Entity):
+    """
+    The scope of a role assignment determines the set of resources for which the principal has been granted access.
+    An app scope is a scope defined and understood by a specific application, unlike directory scopes that are
+    shared scopes stored in the directory and understood by multiple applications.
+
+    This may be in both the following principal and scope scenarios:
+
+    A single principal and a single scope
+    Multiple principals and multiple scopes.
+    """

office365/directory/rolemanagement/application.py

@@ -1,10 +1,10 @@
 from office365.directory.identitygovernance.privilegedaccess.unified_role_assignment_schedule_request import (
     UnifiedRoleAssignmentScheduleRequest,
 )
-from office365.directory.rolemanagement.unified_role_assignment import (
+from office365.directory.rolemanagement.unifiedrole.assignment import (
     UnifiedRoleAssignment,
 )
-from office365.directory.rolemanagement.unified_role_definition import (
+from office365.directory.rolemanagement.unifiedrole.definition import (
     UnifiedRoleDefinition,
 )
 from office365.entity import Entity
@@ -31,6 +31,7 @@ class RbacApplication(Entity):
             ),
         )
 
+    @property
     def role_definitions(self):
         # type: () -> EntityCollection[UnifiedRoleDefinition]
         """Resource representing the roles allowed by RBAC providers and the permissions assigned to the roles."""

office365/directory/rolemanagement/role.py

@@ -1,6 +1,8 @@
 from typing import Optional
 
 from office365.directory.object import DirectoryObject
+from office365.directory.permissions.scoped_role_membership import ScopedRoleMembership
+from office365.entity_collection import EntityCollection
 from office365.runtime.paths.resource_path import ResourcePath
 
 
@@ -36,3 +38,16 @@ class DirectoryRole(DirectoryObject):
                 self.context, ResourcePath("members", self.resource_path)
             ),
         )
+
+    @property
+    def scoped_members(self):
+        """Members of this directory role that are scoped to administrative units."""
+
+        return self.properties.get(
+            "scopedMembers",
+            EntityCollection(
+                self.context,
+                ScopedRoleMembership,
+                ResourcePath("scopedMembers", self.resource_path),
+            ),
+        )

office365/directory/rolemanagement/{unified_role_assignment.py → unifiedrole/assignment.py}

@@ -1,6 +1,7 @@
 from typing import Optional
 
-from office365.directory.rolemanagement.unified_role_definition import (
+from office365.directory.rolemanagement.app_scope import AppScope
+from office365.directory.rolemanagement.unifiedrole.definition import (
     UnifiedRoleDefinition,
 )
 from office365.entity import Entity
@@ -30,6 +31,29 @@ class UnifiedRoleAssignment(Entity):
         """ """
         return self.properties.get("condition", None)
 
+    @property
+    def principal_id(self):
+        # type: () -> Optional[str]
+        """Identifier of the principal to which the assignment is granted. Supported principals are users,
+        role-assignable groups, and service principals. Supports $filter (eq, in)."""
+        return self.properties.get("principalId", None)
+
+    @property
+    def role_definition_id(self):
+        # type: () -> Optional[str]
+        """Identifier of the unifiedRoleDefinition the assignment is for. Read-only. Supports $filter (eq, in)."""
+        return self.properties.get("roleDefinitionId", None)
+
+    @property
+    def directory_scope_id(self):
+        # type: () -> Optional[str]
+        """Identifier of the directory object representing the scope of the assignment.
+        The scope of an assignment determines the set of resources for which the principal has been granted access.
+        Directory scopes are shared scopes stored in the directory that are understood by multiple applications,
+        unlike app scopes that are defined and understood by a resource application only. Supports $filter (eq, in).
+        """
+        return self.properties.get("directoryScopeId", None)
+
     @property
     def role_definition(self):
         """
@@ -42,9 +66,21 @@ class UnifiedRoleAssignment(Entity):
             ),
         )
 
+    @property
+    def app_scope(self):
+        """
+        Read-only property with details of the app specific scope when the assignment scope is app specific.
+        Containment entity. Supports $expand for the entitlement provider only.
+        """
+        return self.properties.get(
+            "appScope",
+            AppScope(self.context, ResourcePath("appScope", self.resource_path)),
+        )
+
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {
+                "appScope": self.app_scope,
                 "roleDefinition": self.role_definition,
             }
             default_value = property_mapping.get(name, None)

office365/directory/rolemanagement/{unified_role_definition.py → unifiedrole/definition.py}

@@ -1,6 +1,6 @@
 from typing import Optional
 
-from office365.directory.rolemanagement.unified_role_permission import (
+from office365.directory.rolemanagement.unifiedrole.permission import (
     UnifiedRolePermission,
 )
 from office365.entity import Entity
@@ -13,6 +13,9 @@ class UnifiedRoleDefinition(Entity):
     """A role definition is a collection of permissions in Azure Active Directory (Azure AD) listing the operations
     that can be performed and the resources against which they can performed."""
 
+    def __str__(self):
+        return self.display_name or self.entity_type_name
+
     @property
     def display_name(self):
         # type: () -> Optional[str]
@@ -29,6 +32,7 @@ class UnifiedRoleDefinition(Entity):
 
     @property
     def role_permissions(self):
+        # type: () -> ClientValueCollection[UnifiedRolePermission]
         """
         List of permissions included in the role. Read-only when isBuiltIn is true. Required.
         """
@@ -56,6 +60,7 @@ class UnifiedRoleDefinition(Entity):
         if default_value is None:
             property_mapping = {
                 "inheritsPermissionsFrom": self.inherits_permissions_from,
+                "rolePermissions": self.role_permissions,
             }
             default_value = property_mapping.get(name, None)
         return super(UnifiedRoleDefinition, self).get_property(name, default_value)

office365/directory/security/alerts/file_security_state.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class FileSecurityState(ClientValue):
+    """Contains information about the file (not process) related to the alert."""

office365/directory/security/attacksimulations/automation.py

@@ -26,3 +26,11 @@ class SimulationAutomation(Entity):
                 ResourcePath("runs", self.resource_path),
             ),
         )
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "createdBy": self.created_by,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(SimulationAutomation, self).get_property(name, default_value)

office365/directory/security/attacksimulations/automation_run.py

@@ -1,5 +1,13 @@
+from typing import Optional
+
 from office365.entity import Entity
 
 
 class SimulationAutomationRun(Entity):
     """Represents a run of an attack simulation automation on a tenant."""
+
+    @property
+    def simulation_id(self):
+        # type: () -> Optional[str]
+        """"""
+        return self.properties.get("simulationId", None)

office365/directory/security/attacksimulations/repeat_offender.py

@@ -1,6 +1,13 @@
+from office365.directory.security.attacksimulations.user import AttackSimulationUser
 from office365.runtime.client_value import ClientValue
 
 
 class AttackSimulationRepeatOffender(ClientValue):
     """Represents a user in a tenant who has given way to attacks more than once across various attack simulation
     and training campaigns."""
+
+    def __init__(
+        self, attack_simulation_user=AttackSimulationUser(), repeat_offence_count=None
+    ):
+        self.attackSimulationUser = attack_simulation_user
+        self.repeatOffenceCount = repeat_offence_count

office365/directory/security/attacksimulations/report.py

@@ -14,11 +14,11 @@ class SimulationReport(ClientValue):
     participated in the campaign.
     """
 
-    def __init__(self, overview=SimulationReportOverview(), simulationUsers=None):
+    def __init__(self, overview=SimulationReportOverview(), simulation_users=None):
         """
         :param SimulationReportOverview overview: Overview of an attack simulation and training campaign.
         """
         self.overview = overview
         self.simulationUsers = ClientValueCollection(
-            UserSimulationDetails, simulationUsers
+            UserSimulationDetails, simulation_users
         )

office365/directory/security/attacksimulations/user.py

@@ -3,3 +3,8 @@ from office365.runtime.client_value import ClientValue
 
 class AttackSimulationUser(ClientValue):
     """Represents a user in an attack simulation and training campaign."""
+
+    def __init__(self, display_name=None, email=None, user_id=None):
+        self.displayName = display_name
+        self.email = email
+        self.userId = user_id

office365/directory/security/incidents/incident.py

@@ -44,7 +44,7 @@ class Incident(Entity):
     @property
     def created_datetime(self):
         """Time when the incident was first created."""
-        return self.properties("createdDateTime", datetime.min)
+        return self.properties.get("createdDateTime", datetime.min)
 
     @property
     def alerts(self):
@@ -57,6 +57,11 @@ class Incident(Entity):
             ),
         )
 
+    @property
+    def entity_type_name(self):
+        # type: () -> str
+        return "microsoft.graph.security.incident"
+
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {"createdDateTime": self.created_datetime}

office365/directory/security/security.py

@@ -123,3 +123,8 @@ class Security(Entity):
             }
             default_value = property_mapping.get(name, None)
         return super(Security, self).get_property(name, default_value)
+
+    @property
+    def entity_type_name(self):
+        # type: () -> str
+        return "microsoft.graph.security.alert"

office365/directory/subscriptions/company.py

@@ -0,0 +1,7 @@
+from office365.entity import Entity
+
+
+class CompanySubscription(Entity):
+    """Represents a commercial subscription for a tenant. Use the values of skuId and serviceStatus > servicePlanId
+    to assign licenses to unassigned users and groups through the user: assignLicense and group: assignLicense
+    APIs respectively."""

office365/directory/synchronization/progress.py

@@ -3,3 +3,15 @@ from office365.runtime.client_value import ClientValue
 
 class SynchronizationProgress(ClientValue):
     """Represents the progress of a synchronizationJob toward completion."""
+
+    def __init__(
+        self,
+        completed_units=None,
+        progress_observation_date_time=None,
+        total_units=None,
+        units=None,
+    ):
+        self.completedUnits = completed_units
+        self.progressObservationDateTime = progress_observation_date_time
+        self.totalUnits = total_units
+        self.units = units

office365/directory/users/activities/activity.py

@@ -57,6 +57,11 @@ class UserActivity(Entity):
         """Set by the server. DateTime in UTC when the object was created on the server."""
         return self.properties.get("createdDateTime", datetime.min)
 
+    @property
+    def expiration_datetime(self):
+        """Set by the server. DateTime in UTC when the object was created on the server."""
+        return self.properties.get("expirationDateTime", datetime.min)
+
     @property
     def history_items(self):
         """NavigationProperty/Containment; navigation property to the associated activity."""
@@ -75,6 +80,10 @@ class UserActivity(Entity):
 
     def get_property(self, name, default_value=None):
         if default_value is None:
-            property_mapping = {"historyItems": self.history_items}
+            property_mapping = {
+                "createdDateTime": self.created_datetime,
+                "expirationDateTime": self.expiration_datetime,
+                "historyItems": self.history_items,
+            }
             default_value = property_mapping.get(name, None)
         return super(UserActivity, self).get_property(name, default_value)

office365/directory/users/settings.py

@@ -1,3 +1,7 @@
+from typing import Optional
+
+from office365.directory.users.insights_settings import UserInsightsSettings
+from office365.directory.users.storage import UserStorage
 from office365.entity import Entity
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.teams.schedule.shifts.preferences import ShiftPreferences
@@ -6,6 +10,41 @@ from office365.teams.schedule.shifts.preferences import ShiftPreferences
 class UserSettings(Entity):
     """The current user settings for content discovery."""
 
+    @property
+    def contribution_to_content_discovery_as_organization_disabled(self):
+        # type: () -> Optional[bool]
+        """Reflects the organization level setting controlling delegate access to the trending API.
+        When set to true, the organization doesn't have access to Office Delve. The relevancy of the content
+        displayed in Microsoft 365, for example in Suggested sites in SharePoint Home and the Discover view in
+        OneDrive for work or school is affected for the whole organization. This setting is read-only and can only
+        be changed by administrators in the SharePoint admin center."""
+        return self.properties.get(
+            "contributionToContentDiscoveryAsOrganizationDisabled", None
+        )
+
+    @property
+    def contribution_to_content_discovery_disabled(self):
+        # type: () -> Optional[bool]
+        """When set to true, the delegate access to the user's trending API is disabled.
+        When set to true, documents in the user's Office Delve are disabled. When set to true, the relevancy of
+        the content displayed in Microsoft 365, for example in Suggested sites in SharePoint Home and the
+        Discover view in OneDrive for work or school is affected. Users can control this setting in Office Delve
+        """
+        return self.properties.get("contributionToContentDiscoveryDisabled", None)
+
+    @property
+    def item_insights(self):
+        # type: () -> UserInsightsSettings
+        """The user's settings for the visibility of meeting hour insights, and insights derived between
+        a user and other items in Microsoft 365, such as documents or sites.
+        Get userInsightsSettings through this navigation property."""
+        return self.properties.get(
+            "itemInsights",
+            UserInsightsSettings(
+                self.context, ResourcePath("itemInsights", self.resource_path)
+            ),
+        )
+
     @property
     def shift_preferences(self):
         # type: () -> ShiftPreferences
@@ -16,8 +55,19 @@ class UserSettings(Entity):
             ),
         )
 
+    @property
+    def storage(self):
+        # type: () -> ShiftPreferences
+        return self.properties.get(
+            "storage",
+            UserStorage(self.context, ResourcePath("storage", self.resource_path)),
+        )
+
     def get_property(self, name, default_value=None):
         if default_value is None:
-            property_mapping = {"shiftPreferences": self.shift_preferences}
+            property_mapping = {
+                "itemInsights": self.item_insights,
+                "shiftPreferences": self.shift_preferences,
+            }
             default_value = property_mapping.get(name, None)
         return super(UserSettings, self).get_property(name, default_value)

office365/directory/users/storage.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class UserStorage(Entity):
+    """"""