Office365-REST-Python-Client 2.5.2__py3-none-any.whl → 2.5.3__py3-none-any.whl

office365/base_item.py

@@ -25,9 +25,7 @@ class BaseItem(Entity):
 
     @property
     def created_by_user(self):
-        """
-        Identity of the user who created the item
-        """
+        """Identity of the user who created the item"""
         from office365.directory.users.user import User
 
         return self.properties.get(
@@ -37,14 +35,13 @@ class BaseItem(Entity):
 
     @property
     def last_modified_by(self):
+        # type: () -> IdentitySet
         """Identity of the user, device, and application which last modified the item."""
         return self.properties.get("lastModifiedBy", IdentitySet())
 
     @property
     def last_modified_by_user(self):
-        """
-        Identity of the user who last modified the item.
-        """
+        """Identity of the user who last modified the item."""
         from office365.directory.users.user import User
 
         return self.properties.get(
@@ -54,11 +51,13 @@ class BaseItem(Entity):
 
     @property
     def created_datetime(self):
+        # type: () -> Optional[datetime]
         """Gets date and time of item creation."""
         return self.properties.get("createdDateTime", datetime.min)
 
     @property
     def last_modified_datetime(self):
+        # type: () -> Optional[datetime]
         """Gets date and time the item was last modified."""
         return self.properties.get("lastModifiedDateTime", datetime.min)
 
@@ -70,39 +69,32 @@ class BaseItem(Entity):
 
     @name.setter
     def name(self, value):
-        """
-        Sets the name of the item.
-        """
+        # type: (str) -> None
+        """Sets the name of the item."""
         self.set_property("name", value)
 
     @property
     def description(self):
         # type: () -> Optional[str]
-        """
-        Provides a user-visible description of the item.
-        """
+        """Provides a user-visible description of the item."""
         return self.properties.get("description", None)
 
     @description.setter
     def description(self, value):
+        # type: (str) -> None
         self.set_property("description", value)
 
     @property
     def web_url(self):
         # type: () -> Optional[str]
-        """
-        URL that displays the resource in the browser
-        """
+        """URL that displays the resource in the browser"""
         return self.properties.get("webUrl", None)
 
     @property
     def parent_reference(self):
+        # type: () -> ItemReference
         """Parent information, if the item has a parent."""
-        return self.properties.get("parentReference", ItemReference())
-
-    @parent_reference.setter
-    def parent_reference(self, value):
-        self.set_property("parentReference", value, False)
+        return self.properties.setdefault("parentReference", ItemReference())
 
     def get_property(self, name, default_value=None):
         if default_value is None:

office365/communications/presences/presence.py

@@ -1,5 +1,8 @@
+from typing import Optional
+
 from office365.communications.presences.status_message import PresenceStatusMessage
 from office365.entity import Entity
+from office365.outlook.calendar.dateTimeTimeZone import DateTimeTimeZone
 from office365.outlook.mail.item_body import ItemBody
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 
@@ -50,12 +53,22 @@ class Presence(Entity):
         self.context.add_query(qry)
         return self
 
-    def set_status_message(self, message):
+    def set_status_message(self, message, expiry=None):
         """
         Set a presence status message for a user. An optional expiration date and time can be supplied.
-        :param str message: Status message item.
+        :param str or ItemBody message: Status message item.
+        :param datetime.datetime expiry: Time in which the status message expires. If not provided, the status message
+            doesn't expire.
         """
-        payload = {"statusMessage": PresenceStatusMessage(message=ItemBody(message))}
+        if not isinstance(message, ItemBody):
+            message = ItemBody(message)
+        if expiry:
+            expiry = DateTimeTimeZone.parse(expiry)
+        payload = {
+            "statusMessage": PresenceStatusMessage(
+                message=message, expiry_datetime=expiry
+            )
+        }
         qry = ServiceOperationQuery(self, "setStatusMessage", None, payload)
         self.context.add_query(qry)
         return self
@@ -88,22 +101,20 @@ class Presence(Entity):
 
     @property
     def activity(self):
+        # type: () -> Optional[str]
         """
         The supplemental information to a user's availability.
         Possible values are Available, Away, BeRightBack, Busy, DoNotDisturb, InACall, InAConferenceCall, Inactive,
         InAMeeting, Offline, OffWork, OutOfOffice, PresenceUnknown, Presenting, UrgentInterruptionsOnly.
-
-        :rtype: str or None
         """
         return self.properties.get("activity", None)
 
     @property
     def availability(self):
+        # type: () -> Optional[str]
         """
         The base presence information for a user.
         Possible values are Available, AvailableIdle, Away, BeRightBack, Busy, BusyIdle, DoNotDisturb, Offline,
            PresenceUnknown
-
-        :rtype: str or None
         """
         return self.properties.get("availability", None)

office365/delta_path.py

@@ -1,4 +1,4 @@
-from office365.runtime.paths.entity import EntityPath
+from office365.runtime.paths.v4.entity import EntityPath
 
 
 class DeltaPath(EntityPath):

office365/directory/administrative_unit.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.directory.extensions.extension import Extension
 from office365.directory.object import DirectoryObject
 from office365.entity_collection import EntityCollection
@@ -14,10 +16,8 @@ class AdministrativeUnit(DirectoryObject):
 
     @property
     def display_name(self):
-        """
-        Display name for the administrative unit
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Display name for the administrative unit"""
         return self.properties.get("displayName", None)
 
     @property
@@ -36,9 +36,8 @@ class AdministrativeUnit(DirectoryObject):
 
     @property
     def extensions(self):
-        """
-        The collection of open extensions defined for this administrative unit.
-        """
+        # type: () -> EntityCollection[Extension]
+        """The collection of open extensions defined for this administrative unit."""
         return self.properties.get(
             "extensions",
             EntityCollection(

office365/directory/applications/application.py

@@ -30,6 +30,17 @@ class Application(DirectoryObject):
     an Application in Azure AD
     """
 
+    def __repr__(self):
+        return self.id or self.app_id or self.entity_type_name
+
+    def __str__(self):
+        if self.display_name:
+            return "Name: {0}".format(self.display_name)
+        elif self.app_id:
+            return "App Id: {0}".format(self.app_id)
+        else:
+            return self.entity_type_name
+
     def add_certificate(
         self, cert_data, display_name, start_datetime=None, end_datetime=None
     ):
@@ -62,7 +73,7 @@ class Application(DirectoryObject):
         Remove a certificate from an application.
         :param str thumbprint: The unique identifier for the password.
         """
-        raise NotImplementedError("")
+        raise NotImplementedError("remove_certificate")
 
     def add_password(self, display_name):
         """Adds a strong password to an application.
@@ -178,6 +189,7 @@ class Application(DirectoryObject):
 
     @property
     def app_roles(self):
+        # type: () -> ClientValueCollection[AppRole]
         """
         The collection of roles defined for the application. With app role assignments, these roles can be assigned to
         users, groups, or service principals associated with other applications
@@ -191,16 +203,12 @@ class Application(DirectoryObject):
 
     @property
     def certification(self):
-        """
-        Specifies the certification status of the application.
-        """
+        """Specifies the certification status of the application."""
         return self.properties.get("certification", Certification())
 
     @property
     def created_datetime(self):
-        """
-        The date and time the application was registered.
-        """
+        """The date and time the application was registered."""
         return self.properties.get("createdDateTime", datetime.datetime.min)
 
     @property
@@ -318,9 +326,3 @@ class Application(DirectoryObject):
             }
             default_value = property_mapping.get(name, None)
         return super(Application, self).get_property(name, default_value)
-
-    def __repr__(self):
-        return self.id
-
-    def __str__(self):
-        return self.display_name

office365/directory/audit/signins/signin.py

@@ -14,18 +14,14 @@ class SignIn(Entity):
 
     @property
     def app_display_name(self):
-        """
-        App name displayed in the Azure Portal.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """App name displayed in the Azure Portal."""
         return self.properties.get("appDisplayName", None)
 
     @property
     def app_id(self):
-        """
-        Unique GUID representing the app ID in the Azure Active Directory.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Unique GUID representing the app ID in the Azure Active Directory."""
         return self.properties.get("appId", None)
 
     @property
@@ -92,34 +88,34 @@ class SignIn(Entity):
 
     @property
     def risk_detail(self):
+        # type: () -> Optional[str]
         """
         Provides the 'reason' behind a specific state of a risky user, sign-in or a risk event.
-        :rtype: str or None
         """
         return self.properties.get("riskDetail", None)
 
     @property
     def user_id(self):
+        # type: () -> Optional[str]
         """
         ID of the user that initiated the sign-in. Supports $filter (eq operator only).
-        :rtype: str or None
         """
         return self.properties.get("userId", None)
 
     @property
     def user_principal_name(self):
+        # type: () -> Optional[str]
         """
         User principal name of the user that initiated the sign-in. Supports $filter (eq and startsWith operators only).
-        :rtype: str or None
         """
         return self.properties.get("userPrincipalName", None)
 
     @property
     def status(self):
+        # type: () -> Optional[SignInStatus]
         """
         Sign-in status. Includes the error code and description of the error (in case of a sign-in failure).
         Supports $filter (eq operator only) on errorCode property.
-        :rtype: str or None
         """
         return self.properties.get("status", SignInStatus())
 

office365/directory/authentication/methods/details.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 
 
@@ -8,55 +10,55 @@ class UserRegistrationDetails(Entity):
 
     @property
     def is_admin(self):
+        # type: () -> Optional[bool]
         """
         Indicates whether the user has an admin role in the tenant. This value can be used to check the authentication
         methods that privileged accounts are registered for and capable of.
-        :rtype: bool
         """
         return self.properties.get("isAdmin", None)
 
     @property
     def is_mfa_registered(self):
+        # type: () -> Optional[bool]
         """
         Indicates whether the user has registered a strong authentication method for multi-factor authentication.
         The method may not necessarily be allowed by the authentication methods policy.
-        :rtype: bool
         """
         return self.properties.get("isMfaRegistered", None)
 
     @property
     def is_passwordless_capable(self):
+        # type: () -> Optional[bool]
         """
         Indicates whether the user has registered a passwordless strong authentication method (including FIDO2,
         Windows Hello for Business, and Microsoft Authenticator (Passwordless)) that is allowed by the authentication
         methods policy.
-        :rtype: bool
         """
         return self.properties.get("isPasswordlessCapable", None)
 
     @property
     def is_sspr_capable(self):
+        # type: () -> Optional[bool]
         """
         Indicates whether the user has registered the required number of authentication methods for self-service
         password reset and the user is allowed to perform self-service password reset by policy.
-        :rtype: bool
         """
         return self.properties.get("isSsprCapable", None)
 
     @property
     def is_sspr_enabled(self):
+        # type: () -> Optional[bool]
         """
         Indicates whether the user is allowed to perform self-service password reset by policy. The user may not
         necessarily have registered the required number of authentication methods for self-service password reset.
-        :rtype: bool
         """
         return self.properties.get("isSsprEnabled", None)
 
     @property
     def user_type(self):
+        # type: () -> Optional[str]
         """
         Identifies whether the user is a member or guest in the tenant.
         The possible values are: member, guest, unknownFutureValue.
-        :rtype: str or None
         """
         return self.properties.get("userType", None)

office365/directory/groups/lifecycle_policy.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.runtime.client_result import ClientResult
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -28,12 +30,12 @@ class GroupLifecyclePolicy(Entity):
         return return_type
 
     def remove_group(self, group_id):
+        # type: (str) -> ClientResult[bool]
         """
         Removes a group from a lifecycle policy.
-
         :param str group_id: The identifier of the group to add to the policy.
         """
-        return_type = ClientResult[bool](self.context)
+        return_type = ClientResult(self.context)
         payload = {"groupId": group_id}
         qry = ServiceOperationQuery(
             self, "removeGroup", None, payload, None, return_type
@@ -43,25 +45,24 @@ class GroupLifecyclePolicy(Entity):
 
     @property
     def alternate_notification_emails(self):
+        # type: () -> Optional[str]
         """
         List of email address to send notifications for groups without owners.
         Multiple email address can be defined by separating email address with a semicolon.
-        :rtype: str or None
         """
         return self.properties.get("alternateNotificationEmails", None)
 
     @property
     def group_lifetime_in_days(self):
+        # type: () -> Optional[int]
         """
         Number of days before a group expires and needs to be renewed. Once renewed, the group expiration is extended
         by the number of days defined.
-        :rtype: int or None
         """
         return self.properties.get("groupLifetimeInDays", None)
 
     @property
     def managed_group_types(self):
-        """The group type for which the expiration policy applies. Possible values are All, Selected or None.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The group type for which the expiration policy applies. Possible values are All, Selected or None."""
         return self.properties.get("managedGroupTypes", None)

office365/directory/identities/provider.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 
 
@@ -11,20 +13,17 @@ class IdentityProvider(Entity):
 
     @property
     def client_id(self):
+        # type: () -> Optional[str]
         """
         The client ID for the application. This is the client ID obtained when registering the application
-        with the identity provider.
-
-        :rtype: str or None
-        """
+        with the identity provider."""
         return self.properties.get("clientId", None)
 
     @property
     def client_secret(self):
+        # type: () -> Optional[str]
         """
         The client secret for the application. This is the client secret obtained when registering the application
         with the identity provider. This is write-only. A read operation will return ****
-
-        :rtype: str or None
         """
         return self.properties.get("clientSecret", None)

office365/directory/internal/paths/me.py

@@ -1,5 +1,5 @@
-from office365.runtime.paths.entity import EntityPath
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.paths.v4.entity import EntityPath
 
 
 class MePath(EntityPath):

office365/directory/permissions/email_identity.py

@@ -3,3 +3,10 @@ from office365.directory.permissions.identity import Identity
 
 class EmailIdentity(Identity):
     """Represents the email identity of a user."""
+
+    def __init__(self, id_=None, email=None, display_name=None):
+        """
+        :param str email:
+        """
+        super(EmailIdentity, self).__init__(display_name, id_)
+        self.email = email

office365/directory/rolemanagement/role.py

@@ -8,7 +8,10 @@ class DirectoryRole(DirectoryObject):
     """Represents an Azure AD directory role. Azure AD directory roles are also known as administrator roles"""
 
     def __repr__(self):
-        return self.display_name
+        return self.id or self.entity_type_name
+
+    def __str__(self):
+        return "Name: {0}".format(self.display_name)
 
     @property
     def description(self):
@@ -24,9 +27,7 @@ class DirectoryRole(DirectoryObject):
 
     @property
     def members(self):
-        """
-        Users that are members of this directory role.
-        """
+        """Users that are members of this directory role."""
         from office365.directory.object_collection import DirectoryObjectCollection
 
         return self.properties.get(

office365/directory/rolemanagement/template.py

@@ -13,15 +13,11 @@ class DirectoryRoleTemplate(DirectoryObject):
     @property
     def display_name(self):
         # type: () -> Optional[str]
-        """
-        The display name to set for the directory role
-        """
+        """The display name to set for the directory role"""
         return self.properties.get("displayName", None)
 
     @property
     def description(self):
         # type: () -> Optional[str]
-        """
-        The display name to set for the directory role
-        """
+        """The display name to set for the directory role"""
         return self.properties.get("description", None)

office365/directory/rolemanagement/unified_role_assignment.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.directory.rolemanagement.unified_role_definition import (
     UnifiedRoleDefinition,
 )
@@ -13,20 +15,19 @@ class UnifiedRoleAssignment(Entity):
 
     @property
     def app_scope_id(self):
+        # type: () -> Optional[str]
         """
         Identifier of the app-specific scope when the assignment scope is app-specific. Either this property or
         directoryScopeId is required. App scopes are scopes that are defined and understood by this application only.
         Use / for tenant-wide app scopes. Use directoryScopeId to limit the scope to particular directory objects,
         for example, administrative units. Supports $filter (eq, in).
-        :rtype: str
         """
         return self.properties.get("appScopeId", None)
 
     @property
     def condition(self):
-        """
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """ """
         return self.properties.get("condition", None)
 
     @property

office365/directory/rolemanagement/unified_role_definition.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.directory.rolemanagement.unified_role_permission import (
     UnifiedRolePermission,
 )
@@ -13,16 +15,15 @@ class UnifiedRoleDefinition(Entity):
 
     @property
     def display_name(self):
-        """The display name for the unifiedRoleDefinition.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """The display name for the unifiedRoleDefinition."""
         return self.properties.get("displayName", None)
 
     @property
     def is_built_in(self):
+        # type: () -> Optional[bool]
         """Flag indicating whether the role definition is part of the default set included in
         Azure Active Directory (Azure AD) or a custom definition.
-        :rtype: bool
         """
         return self.properties.get("isBuiltIn", None)
 
@@ -37,6 +38,7 @@ class UnifiedRoleDefinition(Entity):
 
     @property
     def inherits_permissions_from(self):
+        # type: () -> EntityCollection[UnifiedRoleDefinition]
         """
         Read-only collection of role definitions that the given role definition inherits from. Only Azure AD built-in
         roles (isBuiltIn is true) support this attribute. Supports $expand.

office365/directory/serviceprincipals/service_principal.py

@@ -28,6 +28,9 @@ from office365.runtime.types.collections import StringCollection
 class ServicePrincipal(DirectoryObject):
     """Represents an instance of an application in a directory."""
 
+    def __str__(self):
+        return self.display_name
+
     def add_key(self, key_credential, password_credential, proof):
         """
         Adds a key credential to a servicePrincipal. This method along with removeKey can be used by a servicePrincipal
@@ -185,9 +188,7 @@ class ServicePrincipal(DirectoryObject):
     @property
     def app_display_name(self):
         # type: () -> Optional[str]
-        """
-        The display name exposed by the associated application.
-        """
+        """The display name exposed by the associated application."""
         return self.properties.get("appDisplayName", None)
 
     @property
@@ -209,12 +210,16 @@ class ServicePrincipal(DirectoryObject):
         """
         return self.properties.get("appRoles", AppRoleCollection())
 
+    @property
+    def display_name(self):
+        # type: () -> Optional[str]
+        """The display name."""
+        return self.properties.get("displayName", None)
+
     @property
     def homepage(self):
         # type: () -> Optional[str]
-        """
-        Home page or landing page of the application.
-        """
+        """Home page or landing page of the application"""
         return self.properties.get("homepage", None)
 
     @property