Office365-REST-Python-Client 2.5.12__py3-none-any.whl → 2.5.14__py3-none-any.whl

office365/directory/protection/policy/one_drive_for_business.py

@@ -0,0 +1,10 @@
+from office365.directory.protection.policy.base import ProtectionPolicyBase
+
+
+class OneDriveForBusinessProtectionPolicy(ProtectionPolicyBase):
+    """
+    Contains details about protection policies applied to Microsoft 365 data in an organization.
+    Protection policies are defined by the Global Admin (or the SharePoint Online Admin or Exchange Online Admin)
+    and include what data to protect, when to protect it, and for what time period to retain the protected data
+    for a single Microsoft 365 service.
+    """

office365/directory/security/alerts/evidence.py

@@ -3,7 +3,8 @@ from office365.runtime.types.collections import StringCollection
 
 
 class AlertEvidence(ClientValue):
-    """Evidence related to an alert."""
+    """The alertEvidence base type and its derived evidence types provide a means to organize and track rich data
+    about each artifact involved in an alert."""
 
     def __init__(self, created_datetime=None, detailed_roles=None):
         """

office365/directory/security/alerts/malware_evidence.py

@@ -0,0 +1,5 @@
+from office365.directory.security.alerts.evidence import AlertEvidence
+
+
+class MalwareEvidence(AlertEvidence):
+    """"""

office365/directory/security/alerts/process_evidence.py

@@ -0,0 +1,5 @@
+from office365.directory.security.alerts.evidence import AlertEvidence
+
+
+class ProcessEvidence(AlertEvidence):
+    """Represents a process that is reported in the alert as evidence."""

office365/directory/security/attacksimulations/user.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class AttackSimulationUser(ClientValue):
+    """Represents a user in an attack simulation and training campaign."""

office365/directory/security/attacksimulations/user_coverage.py

@@ -3,3 +3,6 @@ from office365.runtime.client_value import ClientValue
 
 class AttackSimulationSimulationUserCoverage(ClientValue):
     """Represents cumulative simulation data and results for a user in attack simulation and training."""
+
+    def __init__(self):
+        pass

office365/directory/security/attacksimulations/users/details.py

@@ -1,5 +1,17 @@
+from office365.directory.security.attacksimulations.user import AttackSimulationUser
 from office365.runtime.client_value import ClientValue
 
 
 class UserSimulationDetails(ClientValue):
     """Represents a user of a tenant and their online actions in an attack simulation and training campaign."""
+
+    def __init__(
+        self, assigned_trainings_count=None, simulation_user=AttackSimulationUser()
+    ):
+        """
+        :param int assigned_trainings_count: Number of trainings assigned to a user in an attack simulation
+            and training campaign.
+        :param AttackSimulationUser simulation_user:
+        """
+        self.assignedTrainingsCount = assigned_trainings_count
+        self.simulationUser = simulation_user

office365/directory/serviceprincipals/service_principal.py

@@ -1,3 +1,4 @@
+from collections.abc import Callable
 from typing import Optional
 
 from typing_extensions import Self
@@ -102,7 +103,8 @@ class ServicePrincipal(DirectoryObject):
         self.context.add_query(qry)
         return return_type
 
-    def _ensure_client_service_principal(self, app, action):
+    def _get_service_principal_by_app(self, app, action):
+        # type: (Application|str, Callable[[Application], None]) -> None
         if isinstance(app, Application):
 
             def _after():
@@ -112,7 +114,63 @@ class ServicePrincipal(DirectoryObject):
         else:
             self.context.service_principals.get_by_app(app).get().after_execute(action)
 
-    def grant_delegated(self, app, principal, scope):
+    def get_delegated_permissions(self, app, principal=None):
+        # type: (Application|str, User|str) -> ClientResult[StringCollection]
+        """Gets a delegated API permission"""
+
+        return_type = ClientResult(self.context, StringCollection())
+
+        def _get_delegated_permissions(client_id, principal_id=None):
+            # type: (str, str) -> None
+
+            if principal_id is None:
+                query_text = (
+                    "clientId eq '{0}'  and consentType eq 'AllPrincipals'".format(
+                        client_id
+                    )
+                )
+            else:
+                query_text = "principalId eq '{0}' and clientId eq '{1}'".format(
+                    principal_id, client_id
+                )
+
+            def _loaded(col):
+                scope_val = next(
+                    iter([g.scope for g in col if g.resource_id == self.id]), None
+                )
+                if scope_val is not None:
+                    [return_type.value.add(name) for name in scope_val.split(" ")]
+
+            (
+                self.context.oauth2_permission_grants.get()
+                .filter(query_text)
+                .after_execute(_loaded)
+            )
+
+        def _resolve_application():
+            # type: () -> None
+            def _after(service_principal):
+                if principal is None:
+                    _get_delegated_permissions(service_principal.id)
+                else:
+                    _resolve_principal(service_principal.id)
+
+            self.context.service_principals.get_by_app(app).get().after_execute(_after)
+
+        def _resolve_principal(app_id):
+            if isinstance(principal, User):
+
+                def _after():
+                    _get_delegated_permissions(app_id, principal.id)
+
+                principal.ensure_property("id", _after)
+            else:
+                _get_delegated_permissions(app_id, principal)
+
+        self.ensure_property("id", _resolve_application)
+        return return_type
+
+    def grant_delegated_permissions(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"""
 
@@ -126,30 +184,33 @@ class ServicePrincipal(DirectoryObject):
                 scope=scope,
             )
 
-        def _ensure_app(principal_id):
-            def _after(return_type):
+        def _principal_resolved(principal_id):
+            # type: (str) -> None
+            def _client_loaded(return_type):
                 _grant_delegated(principal_id, return_type.id)
 
-            self._ensure_client_service_principal(app, _after)
+            self.context.service_principals.get_by_app(app).get().after_execute(
+                _client_loaded
+            )
 
-        def _ensure_principal():
+        def _resource_resolved():
             if isinstance(principal, User):
 
                 def _after():
-                    _ensure_app(principal.id)
+                    _principal_resolved(principal.id)
 
                 principal.ensure_property("id", _after)
             else:
-                _ensure_app(principal)
+                _principal_resolved(principal)
 
-        self.ensure_property("id", _ensure_principal)
+        self.ensure_property("id", _resource_resolved)
         return self
 
-    def revoke_delegated(self, app, principal, scope):
+    def revoke_delegated_permissions(self, app, principal, scope):
         # type: (Application|str, User|str, AppRole|str) -> Self
         """"""
 
-        def _revoke(app_id, principal_id):
+        def _revoke_delegated_permissions(app_id, principal_id):
             # type: (str, str) -> None
 
             def _after(return_type):
@@ -158,7 +219,6 @@ class ServicePrincipal(DirectoryObject):
             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)
@@ -167,17 +227,40 @@ class ServicePrincipal(DirectoryObject):
             if isinstance(principal, User):
 
                 def _after():
-                    _revoke(principal.id, return_type.id)
+                    _revoke_delegated_permissions(principal.id, return_type.id)
 
                 principal.ensure_property("id", _after)
             else:
-                _revoke(principal, return_type.id)
+                _revoke_delegated_permissions(principal, return_type.id)
 
-        self._ensure_client_service_principal(app, _ensure_principal)
-        # self.ensure_property("id", _ensure_principal)
+        self._get_service_principal_by_app(app, _ensure_principal)
         return self
 
-    def grant_application(self, app, app_role):
+    def get_application_permissions(self, app):
+        # type: (Application|str) -> ClientResult[AppRoleCollection]
+        return_type = ClientResult(self.context, AppRoleCollection())
+
+        def _get_application_permissions(app_id):
+            app_role_ids = [
+                app_role.app_role_id
+                for app_role in self.app_role_assigned_to
+                if app_role.principal_id == app_id
+            ]
+            for app_role in self.app_roles:
+                if app_role.id in app_role_ids:
+                    return_type.value.add(app_role)
+
+        def _resolve_app():
+
+            def _after(service_principal):
+                _get_application_permissions(service_principal.id)
+
+            self.context.service_principals.get_by_app(app).get().after_execute(_after)
+
+        self.ensure_properties(["id", "appRoles", "appRoleAssignedTo"], _resolve_app)
+        return return_type
+
+    def grant_application_permissions(self, app, app_role):
         # type: (Application|str, AppRole|str) -> Self
         """
         Grants an app role assignment to a client service principal
@@ -203,7 +286,7 @@ class ServicePrincipal(DirectoryObject):
         self.ensure_properties(["id", "appRoles"], _ensure_resource)
         return self
 
-    def revoke_application(self, app, app_role):
+    def revoke_application_permissions(self, app, app_role):
         # type: (Application|str, AppRole|str) -> Self
         """Revokes an app role assignment from a client service principal"""
 
@@ -275,6 +358,12 @@ class ServicePrincipal(DirectoryObject):
         """The display name exposed by the associated application."""
         return self.properties.get("appDisplayName", None)
 
+    @property
+    def app_id(self):
+        # type: () -> Optional[str]
+        """The unique identifier for the associated application (its appId property)."""
+        return self.properties.get("appId", None)
+
     @property
     def app_role_assigned_to(self):
         """
@@ -287,6 +376,16 @@ class ServicePrincipal(DirectoryObject):
             ),
         )
 
+    @property
+    def app_role_assignments(self):
+        """Get an event collection or an appRoleAssignments."""
+        return self.properties.get(
+            "appRoleAssignments",
+            AppRoleAssignmentCollection(
+                self.context, ResourcePath("appRoleAssignments", self.resource_path)
+            ),
+        )
+
     @property
     def app_roles(self):
         """The roles exposed by the application which this service principal represents."""
@@ -452,6 +551,7 @@ class ServicePrincipal(DirectoryObject):
             property_mapping = {
                 "appRoles": self.app_roles,
                 "appRoleAssignedTo": self.app_role_assigned_to,
+                "appRoleAssignments": self.app_role_assignments,
                 "created_objects": self.created_objects,
                 "keyCredentials": self.key_credentials,
                 "oauth2PermissionScopes": self.oauth2_permission_scopes,

office365/directory/users/user.py

@@ -193,6 +193,16 @@ class User(DirectoryObject):
         self.context.add_query(qry)
         return return_type
 
+    def get_my_site(self):
+        """Gets user's site"""
+        return_type = Site(self.context)
+
+        def _loaded():
+            return_type.set_property("webUrl", self.my_site)
+
+        self.ensure_property("mySite", _loaded)
+        return return_type
+
     def send_mail(
         self,
         subject,
@@ -535,11 +545,21 @@ class User(DirectoryObject):
     @property
     def given_name(self):
         # type: () -> Optional[str]
-        """
-        The given name (first name) of the user. Maximum length is 64 characters.
-        """
+        """The given name (first name) of the user. Maximum length is 64 characters"""
         return self.properties.get("givenName", None)
 
+    @property
+    def my_site(self):
+        # type: () -> Optional[str]
+        """The URL for the user's site."""
+        return self.properties.get("mySite", None)
+
+    @property
+    def office_location(self):
+        # type: () -> Optional[str]
+        """The office location in the user's place of business."""
+        return self.properties.get("officeLocation", None)
+
     @property
     def user_principal_name(self):
         # type: () -> Optional[str]

office365/graph_client.py

@@ -229,9 +229,11 @@ class GraphClient(ClientRuntimeContext):
 
         return GraphClient(_acquire_token)
 
-    def execute_batch(self, items_per_batch=100, success_callback=None):
+    def execute_batch(self, items_per_batch=20, success_callback=None):
         """Constructs and submit a batch request
 
+        Per Batch size limitations: JSON batch requests are currently limited to 20 individual requests.
+
         :param int items_per_batch: Maximum to be selected for bulk operation
         :param (List[ClientObject|ClientResult])-> None success_callback: A success callback
         """

office365/intune/devices/management/management.py

@@ -9,6 +9,8 @@ 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.intune.devices.management.terms_and_conditions import TermsAndConditions
+from office365.intune.devices.management.virtual_endpoint import VirtualEndpoint
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
@@ -40,6 +42,28 @@ class DeviceManagement(Entity):
             ),
         )
 
+    @property
+    def virtual_endpoint(self):
+        """"""
+        return self.properties.get(
+            "virtualEndpoint",
+            VirtualEndpoint(
+                self.context, ResourcePath("virtualEndpoint", self.resource_path)
+            ),
+        )
+
+    @property
+    def terms_and_conditions(self):
+        """"""
+        return self.properties.get(
+            "termsAndConditions",
+            EntityCollection(
+                self.context,
+                TermsAndConditions,
+                ResourcePath("termsAndConditions", self.resource_path),
+            ),
+        )
+
     @property
     def device_categories(self):
         """"""
@@ -98,6 +122,8 @@ class DeviceManagement(Entity):
                 "deviceEnrollmentConfigurations": self.device_enrollment_configurations,
                 "intuneBrand": self.intune_brand,
                 "managedDevices": self.managed_devices,
+                "termsAndConditions": self.terms_and_conditions,
+                "virtualEndpoint": self.virtual_endpoint,
             }
             default_value = property_mapping.get(name, None)
         return super(DeviceManagement, self).get_property(name, default_value)

office365/intune/devices/management/terms_and_conditions.py

@@ -0,0 +1,10 @@
+from office365.entity import Entity
+
+
+class TermsAndConditions(Entity):
+    """
+    A termsAndConditions entity represents the metadata and contents of a given Terms and Conditions (T&C) policy.
+    T&C policies’ contents are presented to users upon their first attempt to enroll into Intune and subsequently
+    upon edits where an administrator has required re-acceptance. They enable administrators to communicate
+    the provisions to which a user must agree in order to have devices enrolled into Intune.
+    """

office365/intune/devices/management/virtual_endpoint.py

@@ -0,0 +1,8 @@
+from office365.entity import Entity
+
+
+class VirtualEndpoint(Entity):
+    """
+    Use the Cloud PC API to provision and manage virtual desktops for employees in an organization,
+    or along with the Intune API to manage physical and virtual endpoints.
+    """

office365/onedrive/driveitems/driveItem.py

@@ -366,7 +366,7 @@ class DriveItem(BaseItem):
     def download_folder(
         self, download_file, after_file_downloaded=None, recursive=True
     ):
-        # type: (IO, Callable[[File], None], bool) -> "DriveItem"
+        # type: (IO, Callable[["DriveItem"], None], bool) -> "DriveItem"
         """
         Download the folder content
         """

office365/onedrive/driveitems/retention_label.py

@@ -1,7 +1,11 @@
+from datetime import datetime
 from typing import Optional
 
 from office365.directory.permissions.identity_set import IdentitySet
 from office365.entity import Entity
+from office365.onedrive.driveitems.retention_label_settings import (
+    RetentionLabelSettings,
+)
 
 
 class ItemRetentionLabel(Entity):
@@ -23,3 +27,32 @@ class ItemRetentionLabel(Entity):
         # type: () -> Optional[IdentitySet]
         """Identity of the user who applied the label. Read-only."""
         return self.properties.get("labelAppliedBy", IdentitySet())
+
+    @property
+    def label_applied_datetime(self):
+        # type: () -> Optional[datetime]
+        """The date and time when the label was applied on the item.
+        The timestamp type represents date and time information using ISO 8601 format and is always in UTC.
+        """
+        return self.properties.get("labelAppliedDateTime", datetime.min)
+
+    @property
+    def name(self):
+        # type: () -> Optional[str]
+        """The retention label on the document. Read-write."""
+        return self.properties.get("name", None)
+
+    @property
+    def retention_settings(self):
+        # type: () -> RetentionLabelSettings
+        """The retention settings enforced on the item. Read-write."""
+        return self.properties.get("retentionSettings", RetentionLabelSettings())
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "labelAppliedBy": self.label_applied_by,
+                "retentionSettings": self.retention_settings,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(ItemRetentionLabel, self).get_property(name, default_value)

office365/onedrive/driveitems/retention_label_settings.py

@@ -0,0 +1,7 @@
+from office365.runtime.client_value import ClientValue
+
+
+class RetentionLabelSettings(ClientValue):
+    """
+    Groups all the compliance retention restrictions on the item into a single structure.
+    """

office365/onedrive/sitepages/base.py

@@ -7,6 +7,9 @@ from office365.onedrive.driveitems.publication_facet import PublicationFacet
 class BaseSitePage(BaseItem):
     """An abstract type that represents a page in the site page library."""
 
+    def __repr__(self):
+        return self.name or self.entity_type_name
+
     @property
     def publishing_state(self):
         # type: () -> Optional[str]

office365/onedrive/sitepages/collection.py

@@ -10,10 +10,22 @@ class SitePageCollection(EntityCollection[SitePage]):
     def __init__(self, context, resource_path=None):
         super(SitePageCollection, self).__init__(context, SitePage, resource_path)
 
+    def get(self):
+        def _construct_request(request):
+            # type: (RequestOptions) -> None
+            # request.url += "/microsoft.graph.sitePage"
+            pass
+
+        return super(SitePageCollection, self).get().before_execute(_construct_request)
+
+    def get_by_name(self, name):
+        return self.single("name eq '{0}'".format(name))
+
     def add(self, title):
         """
         Create a new sitePage in the site pages list in a site.
 
+        :param str title:
         """
 
         def _construct_request(request):

office365/onedrive/sitepages/site_page.py

@@ -15,23 +15,23 @@ class SitePage(BaseSitePage):
     webParts."""
 
     def get_web_parts_by_position(
-        self, webPartIndex, horizontalSectionId, isInVerticalSection, columnId
+        self, web_part_index, horizontal_section_id, is_in_vertical_section, column_id
     ):
         """
         Get a collection of webPart by providing webPartPosition information.
 
-        :param float webPartIndex: Index of the current WebPart. Represents the order of WebPart in this column or
+        :param float web_part_index: Index of the current WebPart. Represents the order of WebPart in this column or
              section. Only works if either columnId or isInVerticalSection is provided.
-        :param float horizontalSectionId: Indicate the horizontal section where the WebPart located in.
-        :param bool isInVerticalSection: Indicate whether the WebPart located in the vertical section.
-        :param float columnId: Indicate the identifier of the column where the WebPart located in. Only works
+        :param float horizontal_section_id: Indicate the horizontal section where the WebPart located in.
+        :param bool is_in_vertical_section: Indicate whether the WebPart located in the vertical section.
+        :param float column_id: Indicate the identifier of the column where the WebPart located in. Only works
              if horizontalSectionId is provided.
         """
         params = {
-            "webPartIndex": webPartIndex,
-            "horizontalSectionId": horizontalSectionId,
-            "isInverticalSection": isInVerticalSection,
-            "columnId": columnId,
+            "webPartIndex": web_part_index,
+            "horizontalSectionId": horizontal_section_id,
+            "isInverticalSection": is_in_vertical_section,
+            "columnId": column_id,
         }
         return_type = EntityCollection(
             self.context, WebPart, ResourcePath("webParts", self.resource_path)

office365/onedrive/sites/archival_details.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class SiteArchivalDetails(ClientValue):
+    """Represents the archival details of a siteCollection."""

office365/onedrive/sites/site_collection.py

@@ -1,17 +1,26 @@
+from office365.onedrive.sites.archival_details import SiteArchivalDetails
 from office365.runtime.client_value import ClientValue
 
 
 class SiteCollection(ClientValue):
     """The siteCollection resource provides more information about a site collection."""
 
-    def __init__(self, root=None, hostname=None, data_location_code=None):
+    def __init__(
+        self,
+        root=None,
+        hostname=None,
+        data_location_code=None,
+        archival_details=SiteArchivalDetails(),
+    ):
         """
 
         :param office365.onedrive.root.Root root: The hostname for the site collection.
         :param str hostname: The hostname for the site collection.
         :param str data_location_code: The geographic region code for where this site collection resides
+        :param str archival_details: Represents the archival details of a siteCollection.
         """
         super(SiteCollection, self).__init__()
         self.root = root
         self.hostname = hostname
         self.dataLocationCode = data_location_code
+        self.archivalDetails = archival_details

office365/onedrive/workbooks/functions/functions.py

@@ -45,6 +45,29 @@ class WorkbookFunctions(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def accr_int_m(self, issue, settlement, rate, par, basis):
+        """
+        Returns the accrued interest for a security that pays periodic interest.
+
+        :param any issue: The real number of which you want the absolute value.
+        :param any settlement: The security's settlement date. The security settlement date is the date after
+            the issue date when the security is traded to the buyer.
+        :param any rate: The security's annual coupon rate.
+        :param any par: The security's par value. If you omit par, ACCRINT uses $1,000.
+        :param any basis:
+        """
+        return_type = WorkbookFunctionResult(self.context)
+        payload = {
+            "issue": issue,
+            "settlement": settlement,
+            "rate": rate,
+            "par": par,
+            "basis": basis,
+        }
+        qry = ServiceOperationQuery(self, "accrIntM", None, payload, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
     def days(self, start_date, end_date):
         """Returns the number of days between two dates.
 

office365/planner/tasks/check_list_item.py

@@ -7,4 +7,8 @@ class PlannerChecklistItem(ClientValue):
     The checklist on a task is represented by the checklistItems object.
     """
 
-    pass
+    def __init__(self, title=None):
+        """
+        :param str|None title: The title of the checklist.
+        """
+        self.title = title