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

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/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

@@ -111,10 +111,8 @@ class ServicePrincipal(DirectoryObject):
 
         def _grant(principal):
             # type: ("ServicePrincipal") -> None
-            app_role_id = repr(app_role)
-            principal_id = principal.id
             self.app_role_assigned_to.add(
-                principalId=principal_id, resourceId=self.id, appRoleId=app_role_id
+                principalId=principal.id, resourceId=self.id, appRoleId=app_role.id
             )
 
         def _ensure_principal():
@@ -128,20 +126,17 @@ class ServicePrincipal(DirectoryObject):
         """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)
+            # type: ("ServicePrincipal") -> None
             app_role_assigned_to_ids = [
                 item.id
                 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 len(app_role_assigned_to_ids) > 0:
                 self.app_role_assigned_to[app_role_assigned_to_ids[0]].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_principal():
             self.context.service_principals.get_by_app(app).get().after_execute(

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,

office365/onedrive/driveitems/driveItem.py

@@ -2,6 +2,8 @@ from __future__ import annotations
 
 import os
 from datetime import datetime
+from functools import partial
+from os.path import isfile, join
 from typing import IO, AnyStr, Callable, Optional, TypeVar
 
 import requests
@@ -272,6 +274,30 @@ class DriveItem(BaseItem):
             name = os.path.basename(path_or_file)
             return self.upload(name, content)
 
+    def upload_folder(self, path, file_uploaded=None):
+        # type: (str, Callable[["DriveItem"], None]) -> "DriveItem"
+
+        def _after_file_upload(return_type):
+            # type: ("DriveItem") -> None
+            if callable(file_uploaded):
+                file_uploaded(return_type)
+
+        def _upload_folder(source_path, target_folder):
+            # type: (str, "DriveItem") -> None
+            for name in os.listdir(source_path):
+                cur_path = join(source_path, name)
+                if isfile(cur_path):
+                    with open(cur_path, "rb") as f:
+                        target_folder.upload_file(f).after_execute(_after_file_upload)
+                else:
+                    target_folder.create_folder(name).after_execute(
+                        partial(_upload_folder, cur_path)
+                    )
+
+        """Uploads a folder"""
+        _upload_folder(path, self)
+        return self
+
     def get_content(self, format_name=None):
         # type: (Optional[str]) -> ClientResult[AnyStr]
         """
@@ -302,6 +328,52 @@ class DriveItem(BaseItem):
         self.get_content().after_execute(_save_content)
         return self
 
+    def download_folder(
+        self, download_file, after_file_downloaded=None, recursive=True
+    ):
+        # type: (IO, Callable[[File], None], bool) -> "DriveItem"
+        """
+        Download the folder content
+        """
+        import zipfile
+
+        def _after_file_downloaded(drive_item, base_path, result):
+            # type: ("DriveItem", str, ClientResult[AnyStr]) -> None
+            with zipfile.ZipFile(download_file.name, "a", zipfile.ZIP_DEFLATED) as zf:
+                zip_path = (
+                    "/".join([base_path, drive_item.name])
+                    if base_path is not None
+                    else drive_item.name
+                )
+                zf.writestr(zip_path, result.value)
+                if callable(after_file_downloaded):
+                    after_file_downloaded(drive_item)
+
+        def _after_folder_downloaded(parent_item, base_path=None):
+            # type: ("DriveItem", str) -> None
+            for drive_item in parent_item.children:
+                if drive_item.is_file:
+                    drive_item.get_content().after_execute(
+                        partial(_after_file_downloaded, drive_item, base_path)
+                    )
+                else:
+                    if recursive:
+                        if base_path is None:
+                            next_base_path = str(drive_item.name)
+                        else:
+                            next_base_path = "/".join([base_path, drive_item.name])
+                        _download_folder(drive_item, next_base_path)
+
+        def _download_folder(drive_item, prev_result=None):
+            # type: ("DriveItem", str) -> None
+            drive_item.ensure_properties(
+                ["children", "name"],
+                partial(_after_folder_downloaded, drive_item, prev_result),
+            )
+
+        _download_folder(self)
+        return self
+
     def download_session(
         self, file_object, chunk_downloaded=None, chunk_size=1024 * 1024
     ):
@@ -600,9 +672,7 @@ class DriveItem(BaseItem):
     @property
     def audio(self):
         # type: () -> Audio
-        """
-        Audio metadata, if the item is an audio file. Read-only.
-        """
+        """Audio metadata, if the item is an audio file. Read-only."""
         return self.properties.get("audio", Audio())
 
     @property
@@ -616,9 +686,7 @@ class DriveItem(BaseItem):
     @property
     def photo(self):
         # type: () -> Photo
-        """
-        Photo metadata, if the item is a photo. Read-only.
-        """
+        """Photo metadata, if the item is a photo. Read-only."""
         return self.properties.get("photo", Photo())
 
     @property

office365/onedrive/lists/list.py

@@ -17,7 +17,7 @@ class List(BaseItem):
     including template and field definitions."""
 
     def __str__(self):
-        return self.display_name
+        return self.display_name or self.entity_type_name
 
     @property
     def display_name(self):

office365/onedrive/sitepages/base.py

@@ -0,0 +1,29 @@
+from typing import Optional
+
+from office365.base_item import BaseItem
+from office365.onedrive.driveitems.publication_facet import PublicationFacet
+
+
+class BaseSitePage(BaseItem):
+    """An abstract type that represents a page in the site page library."""
+
+    @property
+    def publishing_state(self):
+        # type: () -> Optional[str]
+        """The publishing status and the MM.mm version of the page."""
+        return self.properties.get("publishingState", PublicationFacet())
+
+    @property
+    def page_layout(self):
+        # type: () -> Optional[str]
+        """
+        The name of the page layout of the page.
+        The possible values are: microsoftReserved, article, home, unknownFutureValue.
+        """
+        return self.properties.get("pageLayout", None)
+
+    @property
+    def title(self):
+        # type: () -> Optional[str]
+        """Title of the sitePage."""
+        return self.properties.get("title", None)

office365/onedrive/sitepages/canvas_layout.py

@@ -0,0 +1,43 @@
+from office365.entity import Entity
+from office365.entity_collection import EntityCollection
+from office365.onedrive.sitepages.horizontal_section import HorizontalSection
+from office365.onedrive.sitepages.vertical_section import VerticalSection
+from office365.runtime.paths.resource_path import ResourcePath
+
+
+class CanvasLayout(Entity):
+    """Represents the layout of the content in a given SharePoint page."""
+
+    @property
+    def horizontal_sections(self):
+        # type: () -> EntityCollection[HorizontalSection]
+        """Collection of horizontal sections on the SharePoint page.."""
+        return self.properties.get(
+            "horizontalSections",
+            EntityCollection(
+                self.context,
+                HorizontalSection,
+                ResourcePath("horizontalSections", self.resource_path),
+            ),
+        )
+
+    @property
+    def vertical_section(self):
+        # type: () -> VerticalSection
+        """Vertical section on the SharePoint page."""
+        return self.properties.get(
+            "verticalSection",
+            VerticalSection(
+                self.context,
+                ResourcePath("verticalSection", self.resource_path),
+            ),
+        )
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "horizontalSections": self.horizontal_sections,
+                "verticalSection": self.vertical_section,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(CanvasLayout, self).get_property(name, default_value)

office365/onedrive/sitepages/collection.py

@@ -0,0 +1,32 @@
+from office365.entity_collection import EntityCollection
+from office365.onedrive.sitepages.site_page import SitePage
+from office365.onedrive.sitepages.title_area import TitleArea
+from office365.runtime.http.request_options import RequestOptions
+
+
+class SitePageCollection(EntityCollection[SitePage]):
+    """Sites container"""
+
+    def __init__(self, context, resource_path=None):
+        super(SitePageCollection, self).__init__(context, SitePage, resource_path)
+
+    def add(self, title):
+        """
+        Create a new sitePage in the site pages list in a site.
+
+        """
+
+        def _construct_request(request):
+            # type: (RequestOptions) -> None
+            request.set_header("Content-Type", "application/json")
+
+        return (
+            super(SitePageCollection, self)
+            .add(
+                title=title,
+                name="{0}.aspx".format(title),
+                pageLayout="article",
+                titleArea=TitleArea(),
+            )
+            .before_execute(_construct_request)
+        )

office365/onedrive/sitepages/horizontal_section.py

@@ -0,0 +1,23 @@
+from office365.entity import Entity
+from office365.entity_collection import EntityCollection
+from office365.onedrive.sitepages.horizontal_section_column import (
+    HorizontalSectionColumn,
+)
+from office365.runtime.paths.resource_path import ResourcePath
+
+
+class HorizontalSection(Entity):
+    """Represents a horizontal section in a given SharePoint page."""
+
+    @property
+    def columns(self):
+        # type: () -> EntityCollection[HorizontalSectionColumn]
+        """The set of vertical columns in this section."""
+        return self.properties.get(
+            "columns",
+            EntityCollection(
+                self.context,
+                HorizontalSectionColumn,
+                ResourcePath("columns", self.resource_path),
+            ),
+        )

office365/onedrive/sitepages/horizontal_section_column.py

@@ -0,0 +1,27 @@
+from office365.entity import Entity
+from office365.entity_collection import EntityCollection
+from office365.onedrive.sitepages.web_part import WebPart
+from office365.runtime.paths.resource_path import ResourcePath
+
+
+class HorizontalSectionColumn(Entity):
+    """Represents a vertical column in a given horizontal section."""
+
+    @property
+    def web_parts(self):
+        # type: () -> EntityCollection[WebPart]
+        """The set of web parts in this section."""
+        return self.properties.get(
+            "webParts",
+            EntityCollection(
+                self.context, WebPart, ResourcePath("webParts", self.resource_path)
+            ),
+        )
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "webParts": self.web_parts,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(HorizontalSectionColumn, self).get_property(name, default_value)