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

office365/directory/audit/signins/signin.py

@@ -1,4 +1,5 @@
 import datetime
+from typing import Optional
 
 from office365.directory.audit.signins.location import SignInLocation
 from office365.directory.audit.signins.status import SignInStatus
@@ -13,34 +14,30 @@ 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
     def client_app_used(self):
+        # type: () -> Optional[str]
         """
         Identifies the client used for the sign-in activity. Modern authentication clients include Browser, modern
         clients. Legacy authentication clients include Exchange ActiveSync, IMAP, MAPI, SMTP, POP, and other clients.
-        :rtype: str
         """
         return self.properties.get("clientAppUsed", None)
 
     @property
     def correlation_id(self):
+        # type: () -> Optional[str]
         """
         The request ID sent from the client when the sign-in is initiated; used to troubleshoot sign-in activity.
-        :rtype: str
         """
         return self.properties.get("correlationId", None)
 
@@ -58,18 +55,14 @@ class SignIn(Entity):
 
     @property
     def ip_address(self):
-        """
-        IP address of the client used to sign in.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """IP address of the client used to sign in."""
         return self.properties.get("ipAddress", None)
 
     @property
     def is_interactive(self):
-        """
-        Indicates if a sign-in is interactive or not.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Indicates if a sign-in is interactive or not."""
         return self.properties.get("isInteractive", None)
 
     @property
@@ -82,50 +75,47 @@ class SignIn(Entity):
 
     @property
     def resource_display_name(self):
-        """
-        Name of the resource the user signed into.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Name of the resource the user signed into."""
         return self.properties.get("resourceDisplayName", None)
 
     @property
     def resource_id(self):
+        # type: () -> Optional[str]
         """
-        ID of the resource that the user signed into.
-        :rtype: str or None
-        """
+        ID of the resource that the user signed into."""
         return self.properties.get("resourceId", None)
 
     @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/authentication.py

@@ -78,6 +78,7 @@ class Authentication(Entity):
 
     @property
     def methods(self):
+        # type: () -> EntityCollection[AuthenticationMethod]
         """Represents all authentication methods registered to a user."""
         return self.properties.get(
             "methods",

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/authentication/methods/phone.py

@@ -8,7 +8,9 @@ class PhoneAuthenticationMethod(AuthenticationMethod):
     to sign in via SMS.
 
     A phone has one of three types: mobile, alternate mobile, or office. A user can have one number registered
-    for each type, and must have a mobile phone before an alternate mobile phone is added. When using a phone for multi-factor authentication (MFA) or self-service password reset (SSPR), the mobile phone is the default and the alternate mobile phone is the backup.
+    for each type, and must have a mobile phone before an alternate mobile phone is added. When using a phone for
+    multi-factor authentication (MFA) or self-service password reset (SSPR), the mobile phone is the default and the
+    alternate mobile phone is the backup.
 
     Mobile phones can be used for both SMS and voice calls, depending on the tenant settings.
 

office365/directory/extensions/extension_property.py

@@ -1,4 +1,6 @@
 # coding=utf-8
+from typing import Optional
+
 from office365.directory.object import DirectoryObject
 from office365.runtime.types.collections import StringCollection
 
@@ -13,22 +15,19 @@ class ExtensionProperty(DirectoryObject):
 
     @property
     def name(self):
-        """
-        Name of the extension property.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Name of the extension property"""
         return self.properties.get("name", None)
 
     @property
     def app_display_name(self):
-        """
-        Display name of the application object on which this extension property is defined. Read-only.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Display name of the application object on which this extension property is defined. Read-only"""
         return self.properties.get("appDisplayName", None)
 
     @property
     def data_type(self):
+        # type: () -> Optional[str]
         """
         Specifies the data type of the value the extension property can hold. Following values are supported.
             Binary - 256 bytes maximum
@@ -37,7 +36,6 @@ class ExtensionProperty(DirectoryObject):
             Integer - 32-bit value.
             LargeInteger - 64-bit value.
             String - 256 characters maximum
-        :rtype: str
         """
         return self.properties.get("dataType", None)
 

office365/directory/groups/collection.py

@@ -25,17 +25,18 @@ class GroupCollection(DeltaCollection[Group]):
         self.context.add_query(qry)
         return return_type
 
-    def create_m365_group(self, name, description=None):
+    def create_m365(self, name, description=None, owner=None):
         """
         Creates a Microsoft 365 group.
         If the owners have not been specified, the calling user is automatically added as the owner of the group.
         :param str name: The display name for the group
         :param str description: An optional description for the group
+        :param str owner: The group owner
         """
         params = GroupProfile(name, description, True, False, ["Unified"])
         return self.add(params)
 
-    def create_security_group(self, name, description=None):
+    def create_security(self, name, description=None):
         """
         Creates a Security group
         :param str name: The display name for the group
@@ -56,6 +57,12 @@ class GroupCollection(DeltaCollection[Group]):
         """
 
         def _after_group_created(return_type):
+            # type: (Group) -> None
             return_type.add_team()
 
-        return self.create_m365_group(group_name).after_execute(_after_group_created)
+        return self.create_m365(group_name).after_execute(_after_group_created)
+
+    def get_by_name(self, name):
+        # type: (str) -> Group
+        """Retrieves group by displayName"""
+        return self.single("displayName eq '{0}'".format(name))

office365/directory/groups/group.py

@@ -24,6 +24,7 @@ from office365.outlook.mail.conversation_thread import ConversationThread
 from office365.planner.group import PlannerGroup
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.http.http_method import HttpMethod
+from office365.runtime.http.request_options import RequestOptions
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.runtime.types.collections import StringCollection
@@ -34,7 +35,7 @@ class Group(DirectoryObject):
     """Represents an Azure Active Directory (Azure AD) group, which can be an Office 365 group, or a security group."""
 
     def __repr__(self):
-        return self.display_name
+        return self.display_name or self.id or self.entity_type_name
 
     def renew(self):
         """
@@ -98,9 +99,7 @@ class Group(DirectoryObject):
         qry = ServiceOperationQuery(self, "team", None, self.team, None, self.team)
 
         def _construct_request(request):
-            """
-            :type request: office365.runtime.http.request_options.RequestOptions
-            """
+            # type: (RequestOptions) -> None
             request.method = HttpMethod.Put
             request.set_header("Content-Type", "application/json")
             request.data = json.dumps(request.data)
@@ -122,18 +121,17 @@ class Group(DirectoryObject):
 
     @property
     def assigned_labels(self):
-        """
-        The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group.
-        """
+        # type: () -> ClientValueCollection[AssignedLabel]
+        """The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group."""
         return self.properties.get(
             "assignedLabels", ClientValueCollection(AssignedLabel)
         )
 
     @property
     def classification(self):
+        # type: () -> Optional[str]
         """Describes a classification for the group (such as low, medium or high business impact). Valid values for
         this property are defined by creating a ClassificationList setting value, based on the template definition.
-        :rtype: str or None
         """
         return self.properties.get("classification", None)
 
@@ -165,18 +163,19 @@ class Group(DirectoryObject):
 
     @property
     def has_members_with_license_errors(self):
+        # type: () -> Optional[bool]
         """
         Indicates whether there are members in this group that have license errors from its group-based license
         assignment.
 
         This property is never returned on a GET operation. You can use it as a $filter argument to get groups that
         have members with license errors (that is, filter for this property being true)
-        :rtype: bool or None
         """
         return self.properties.get("hasMembersWithLicenseErrors", None)
 
     @property
     def is_assignable_to_role(self):
+        # type: () -> Optional[bool]
         """
         Indicates whether this group can be assigned to an Azure Active Directory role or not. Optional.
 
@@ -187,7 +186,6 @@ class Group(DirectoryObject):
         Only callers in Global Administrator and Privileged Role Administrator roles can set this property.
         The caller must also be assigned the RoleManagement.ReadWrite.Directory permission to set this property or
         update the membership of such groups. For more, see Using a group to manage Azure AD role assignments
-        :rtype: bool or None
         """
         return self.properties.get("isAssignableToRole", None)
 
@@ -200,38 +198,37 @@ class Group(DirectoryObject):
 
     @property
     def mail(self):
+        # type: () -> Optional[str]
         """
         The SMTP address for the group, for example, "serviceadmins@contoso.onmicrosoft.com".
-        :rtype: str or None
         """
         return self.properties.get("mail", None)
 
     @property
     def mail_enabled(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether the group is mail-enabled. Required.
-        :rtype: bool or None
         """
         return self.properties.get("mailEnabled", None)
 
     @property
     def mail_nickname(self):
+        # type: () -> Optional[str]
         """
         The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64
         characters.
-        :rtype: str or None
         """
         return self.properties.get("mailNickname", None)
 
     @property
     def on_premises_domain_name(self):
-        """
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
         return self.properties.get("onPremisesDomainName", None)
 
     @property
     def conversations(self):
+        # type: () -> EntityCollection[Conversation]
         """The group's conversations."""
         return self.properties.get(
             "conversations",
@@ -249,6 +246,7 @@ class Group(DirectoryObject):
 
     @property
     def extensions(self):
+        # type: () -> EntityCollection[Extension]
         """
         The collection of open extensions defined for the group
         """
@@ -261,9 +259,7 @@ class Group(DirectoryObject):
 
     @property
     def members(self):
-        """
-        Users and groups that are members of this group.
-        """
+        """Users and groups that are members of this group."""
         return self.properties.get(
             "members",
             DirectoryObjectCollection(
@@ -300,6 +296,7 @@ class Group(DirectoryObject):
 
     @property
     def threads(self):
+        # type: () -> EntityCollection[ConversationThread]
         """The group's conversation threads"""
         return self.properties.get(
             "threads",
@@ -322,6 +319,7 @@ class Group(DirectoryObject):
 
     @property
     def drives(self):
+        # type: () -> EntityCollection[Drive]
         """
         The group's drives. Read-only.
         """
@@ -346,6 +344,7 @@ class Group(DirectoryObject):
 
     @property
     def events(self):
+        # type: () -> EventCollection
         """Get an event collection or an event."""
         return self.properties.get(
             "events",
@@ -380,6 +379,7 @@ class Group(DirectoryObject):
 
     @property
     def permission_grants(self):
+        # type: () -> EntityCollection[ResourceSpecificPermissionGrant]
         """
         List permissions that have been granted to apps to access the group.
         """

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/insights/usage_details.py

@@ -1,16 +1,21 @@
-from datetime import datetime
+from typing import TYPE_CHECKING
 
 from office365.runtime.client_value import ClientValue
 
+if TYPE_CHECKING:
+    from datetime import datetime
+    from typing import Optional
+
 
 class UsageDetails(ClientValue):
     """Complex type containing properties of Used items. Information on when the resource was last accessed (viewed)
     or modified (edited) by the user."""
 
     def __init__(self, last_accessed_datetime=None, last_modified_datetime=None):
+        # type: (Optional[datetime], Optional[datetime]) -> None
         """
-        :param datetime.datetime last_accessed_datetime: The date and time the resource was last accessed by the user.
-        :param datetime.datetime last_modified_datetime: The date and time the resource was last modified by the user.
+        :param last_accessed_datetime: The date and time the resource was last accessed by the user.
+        :param last_modified_datetime: The date and time the resource was last modified by the user.
         """
         self.lastAccessedDateTime = last_accessed_datetime
         self.lastModifiedDateTime = last_modified_datetime

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/invitations/collection.py

@@ -3,7 +3,7 @@ from office365.entity_collection import EntityCollection
 from office365.runtime.queries.create_entity import CreateEntityQuery
 
 
-class InvitationCollection(EntityCollection):
+class InvitationCollection(EntityCollection[Invitation]):
     """Invitation's collection"""
 
     def __init__(self, context, resource_path=None):

office365/directory/invitations/invitation.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.directory.invitations.message_info import InvitedUserMessageInfo
 from office365.directory.users.user import User
 from office365.entity import Entity
@@ -27,16 +29,14 @@ class Invitation(Entity):
 
     @property
     def invited_user_display_name(self):
-        """The display name of the user being invited.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """The display name of the user being invited."""
         return self.properties.get("invitedUserDisplayName", None)
 
     @property
     def invited_user_email_address(self):
-        """The email address of the user being invited.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """The email address of the user being invited."""
         return self.properties.get("invitedUserEmailAddress", None)
 
     @property

office365/directory/object_collection.py

@@ -3,6 +3,7 @@ from office365.directory.object import DirectoryObject
 from office365.entity_collection import EntityCollection
 from office365.runtime.client_result import ClientResult
 from office365.runtime.http.http_method import HttpMethod
+from office365.runtime.http.request_options import RequestOptions
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 
 
@@ -68,9 +69,7 @@ class DirectoryObjectCollection(DeltaCollection[DirectoryObject]):
         qry = ServiceOperationQuery(self, "{0}/$ref".format(user_id))
 
         def _construct_request(request):
-            """
-            :type request: RequestOptions
-            """
+            # type: (RequestOptions) -> None
             request.method = HttpMethod.Delete
 
         self.context.add_query(qry).before_query_execute(_construct_request)

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