Office365-REST-Python-Client 2.5.1__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/onlinemeetings/collection.py

@@ -4,7 +4,7 @@ from office365.runtime.queries.create_entity import CreateEntityQuery
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 
 
-class OnlineMeetingCollection(EntityCollection):
+class OnlineMeetingCollection(EntityCollection[OnlineMeeting]):
     def __init__(self, context, resource_path=None):
         super(OnlineMeetingCollection, self).__init__(
             context, OnlineMeeting, resource_path

office365/communications/onlinemeetings/online_meeting.py

@@ -1,4 +1,5 @@
 from datetime import datetime
+from typing import AnyStr, Optional
 
 from office365.communications.onlinemeetings.participants import MeetingParticipants
 from office365.entity import Entity
@@ -14,49 +15,37 @@ class OnlineMeeting(Entity):
 
     @property
     def allow_attendee_to_enable_camera(self):
-        """
-        Indicates whether attendees can turn on their camera.
-        :rtype: str
-        """
+        # type: () -> Optional[bool]
+        """Indicates whether attendees can turn on their camera."""
         return self.properties.get("allowAttendeeToEnableCamera", None)
 
     @property
     def allow_attendee_to_enable_mic(self):
-        """
-        Indicates whether attendees can turn on their microphone.
-        :rtype: str
-        """
+        # type: () -> Optional[bool]
+        """Indicates whether attendees can turn on their microphone."""
         return self.properties.get("allowAttendeeToEnableMic", None)
 
     @property
     def allowed_presenters(self):
-        """
-        Specifies who can be a presenter in a meeting. Possible values are listed in the following table.
-        """
+        """Specifies who can be a presenter in a meeting. Possible values are listed in the following table."""
         return self.properties.get("allowedPresenters", StringCollection())
 
     @property
     def allow_meeting_chat(self):
-        """
-        Specifies the mode of meeting chat.
-        :rtype: str or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies the mode of meeting chat."""
         return self.properties.get("allowMeetingChat", None)
 
     @property
     def allow_participants_to_change_name(self):
-        """
-        Specifies if participants are allowed to rename themselves in an instance of the meeting.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies if participants are allowed to rename themselves in an instance of the meeting."""
         return self.properties.get("allowParticipantsToChangeName", None)
 
     @property
     def attendee_report(self):
-        """
-        The content stream of the attendee report of a Microsoft Teams live event.
-        :rtype: bytes or None
-        """
+        # type: () -> Optional[AnyStr]
+        """The content stream of the attendee report of a Microsoft Teams live event."""
         return self.properties.get("attendeeReport", None)
 
     @property
@@ -68,17 +57,13 @@ class OnlineMeeting(Entity):
 
     @property
     def subject(self):
-        """
-        The subject of the online meeting.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The subject of the online meeting."""
         return self.properties.get("subject", None)
 
     @subject.setter
     def subject(self, value):
-        """
-        :type value: str
-        """
+        # type: (str) -> None
         self.set_property("subject", value)
 
     @property
@@ -88,9 +73,9 @@ class OnlineMeeting(Entity):
 
     @start_datetime.setter
     def start_datetime(self, value):
+        # type: (datetime) -> None
         """
         Sets the meeting start time in UTC.
-        :type value: datetime.datetime
         """
         self.set_property("startDateTime", value.isoformat())
 
@@ -101,10 +86,8 @@ class OnlineMeeting(Entity):
 
     @end_datetime.setter
     def end_datetime(self, value):
-        """
-        Sets the meeting end time in UTC.
-        :type value: datetime.datetime
-        """
+        # type: (datetime) -> None
+        """Sets the meeting end time in UTC."""
         self.set_property("endDateTime", value.isoformat())
 
     @property
@@ -114,11 +97,13 @@ class OnlineMeeting(Entity):
 
     @property
     def join_web_url(self):
+        # type: () -> Optional[str]
         """The join URL of the online meeting. Read-only."""
         return self.properties.get("joinWebUrl", None)
 
     @property
     def video_teleconference_id(self):
+        # type: () -> Optional[str]
         """The video teleconferencing ID."""
         return self.properties.get("videoTeleconferenceId", 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_collection.py

@@ -1,12 +1,21 @@
-from typing import TypeVar
+from typing import TYPE_CHECKING, Optional, Type, TypeVar
 
 from office365.delta_path import DeltaPath
+from office365.entity import Entity
 from office365.entity_collection import EntityCollection
+from office365.runtime.paths.resource_path import ResourcePath
 
 T = TypeVar("T")
 
+if TYPE_CHECKING:
+    from office365.graph_client import GraphClient
+
 
 class DeltaCollection(EntityCollection[T]):
+    def __init__(self, context, item_type, resource_path=None, parent=None):
+        # type: (GraphClient, Type[T], Optional[ResourcePath], Optional[Entity]) -> None
+        super(DeltaCollection, self).__init__(context, item_type, resource_path, parent)
+
     def change_type(self, type_name):
         """
         Specifies a custom query option to filter the delta response based on the type of change.

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.
@@ -166,20 +177,19 @@ class Application(DirectoryObject):
 
     @property
     def app_id(self):
-        """The unique identifier for the application that is assigned to an application by Azure AD. Not nullable.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """The unique identifier for the application that is assigned to an application by Azure AD. Not nullable."""
         return self.properties.get("appId", None)
 
     @property
     def application_template_id(self):
-        """Unique identifier of the applicationTemplate
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Unique identifier of the applicationTemplate"""
         return self.properties.get("applicationTemplateId", None)
 
     @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
@@ -193,23 +203,18 @@ 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
     def default_redirect_uri(self):
-        """
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """ """
         return self.properties.get("defaultRedirectUri", None)
 
     @property
@@ -254,12 +259,11 @@ class Application(DirectoryObject):
 
     @property
     def signin_audience(self):
+        # type: () -> Optional[str]
         """
         Specifies the Microsoft accounts that are supported for the current application.
         Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount,
         PersonalMicrosoftAccount
-
-        :rtype: str or None
         """
         return self.properties.get("signInAudience", None)
 
@@ -285,6 +289,7 @@ class Application(DirectoryObject):
 
     @property
     def extension_properties(self):
+        # type: () -> EntityCollection[ExtensionProperty]
         """List extension properties on an application object."""
         return self.properties.get(
             "extensionProperties",
@@ -297,6 +302,7 @@ class Application(DirectoryObject):
 
     @property
     def token_issuance_policies(self):
+        # type: () -> EntityCollection[TokenIssuancePolicy]
         """Get all tokenIssuancePolicies assigned to this object."""
         return self.properties.get(
             "tokenIssuancePolicies",

office365/directory/applications/roles/assignment.py

@@ -1,4 +1,5 @@
 from datetime import datetime
+from typing import Optional
 
 from office365.directory.object import DirectoryObject
 
@@ -11,46 +12,57 @@ class AppRoleAssignment(DirectoryObject):
     a resource application (the app's service principal) and an app role defined on the resource application.
     """
 
+    def __str__(self):
+        return "Principal: {0}, AppRole: {1}".format(
+            self.principal_display_name, self.app_role_id
+        )
+
     @property
     def app_role_id(self):
+        # type: () -> Optional[str]
         """
         The identifier (id) for the app role which is assigned to the principal.
         This app role must be exposed in the appRoles property on
         the resource application's service principal (resourceId). If the resource application has not declared
         any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal
         that the principal is assigned to the resource app without any specific app roles. Required on create.
-        :rtype: str
         """
         return self.properties.get("appRoleId", None)
 
     @property
     def created_datetime(self):
+        # type: () -> datetime
         """The time when the app role assignment was created."""
         return self.properties.get("createdDateTime", datetime.min)
 
     @property
     def principal_display_name(self):
+        # type: () -> Optional[str]
         """The display name of the user, group, or service principal that was granted the app role assignment."""
         return self.properties.get("principalDisplayName", None)
 
     @property
     def principal_id(self):
+        # type: () -> Optional[str]
         """The unique identifier (id) for the user, security group, or service principal being granted the app role.
         Security groups with dynamic memberships are supported. Required on create."""
         return self.properties.get("principalId", None)
 
     @property
     def principal_type(self):
+        # type: () -> Optional[str]
         """The type of the assigned principal. This can either be User, Group, or ServicePrincipal."""
         return self.properties.get("principalType", None)
 
     @property
     def resource_display_name(self):
+        # type: () -> Optional[str]
         """The display name of the resource app's service principal to which the assignment is made."""
         return self.properties.get("resourceDisplayName", None)
 
     @property
     def resource_id(self):
+        # type: () -> Optional[str]
         """The unique identifier (id) for the resource service principal for which the assignment is made.
         Required on create."""
         return self.properties.get("resourceId", None)

office365/directory/applications/roles/collection.py

@@ -0,0 +1,13 @@
+from office365.directory.applications.roles.role import AppRole
+from office365.runtime.client_value_collection import ClientValueCollection
+
+
+class AppRoleCollection(ClientValueCollection[AppRole]):
+    """"""
+
+    def __init__(self, initial_values=None):
+        super(AppRoleCollection, self).__init__(AppRole, initial_values)
+
+    def __getitem__(self, name):
+        # type: (str) -> AppRole
+        return next(iter([item for item in self._data if item.value == name]), None)

office365/directory/applications/roles/role.py

@@ -10,6 +10,7 @@ class AppRole(ClientValue):
 
     def __init__(
         self,
+        id_=None,
         allowed_member_types=None,
         description=None,
         display_name=None,
@@ -25,6 +26,7 @@ class AppRole(ClientValue):
             on application entities.
         :param str value:
         """
+        self.id = id_
         self.allowedMemberTypes = StringCollection(allowed_member_types)
         self.description = description
         self.displayName = display_name
@@ -32,5 +34,8 @@ class AppRole(ClientValue):
         self.origin = origin
         self.value = value
 
+    def __str__(self):
+        return "{0}  {1}".format(self.allowedMemberTypes, self.value)
+
     def __repr__(self):
-        return self.value
+        return "{0}".format(self.id)

office365/directory/audit/directory.py

@@ -1,4 +1,5 @@
 import datetime
+from typing import Optional
 
 from office365.directory.audit.activity_initiator import AuditActivityInitiator
 from office365.entity import Entity
@@ -8,7 +9,7 @@ class DirectoryAudit(Entity):
     """Represents the directory audit items and its collection."""
 
     def __repr__(self):
-        return self.activity_display_name
+        return self.activity_display_name or self.entity_type_name
 
     @property
     def activity_datetime(self):
@@ -17,28 +18,28 @@ class DirectoryAudit(Entity):
 
     @property
     def activity_display_name(self):
+        # type: () -> Optional[str]
         """
         Indicates the activity name or the operation name (examples: "Create User" and "Add member to group").
         For a list of activities logged, refer to Azure AD audit log categories and activities.
-        :rtype: str
         """
         return self.properties.get("activityDisplayName", None)
 
     @property
     def category(self):
+        # type: () -> Optional[str]
         """
         Indicates which resource category that's targeted by the activity.
         For example: UserManagement, GroupManagement, ApplicationManagement, RoleManagement.
-        :rtype: str
         """
         return self.properties.get("category", None)
 
     @property
     def correlation_id(self):
+        # type: () -> Optional[str]
         """
         Indicates a unique ID that helps correlate activities that span across various services.
         Can be used to trace logs across services.
-        :rtype: str
         """
         return self.properties.get("correlationId", None)
 
@@ -51,28 +52,28 @@ class DirectoryAudit(Entity):
 
     @property
     def operation_type(self):
+        # type: () -> Optional[str]
         """
         Indicates the type of operation that was performed. The possible values include but are not limited
         to the following: Add, Assign, Update, Unassign, and Delete.
-        :rtype: str
         """
         return self.properties.get("operationType", None)
 
     @property
     def logged_by_service(self):
+        # type: () -> Optional[str]
         """
         Indicates information on which service initiated the activity. For example:
         Self-service Password Management, Core Directory, B2C, Invited Users, Microsoft Identity Manager,
         Privileged Identity Management.
-        :rtype: str
         """
         return self.properties.get("loggedByService", None)
 
     @property
     def result_reason(self):
+        # type: () -> Optional[str]
         """
         Indicates the reason for failure if the result is failure or timeout.
-        :rtype: str
         """
         return self.properties.get("resultReason", None)
 

office365/directory/audit/log_root.py

@@ -15,6 +15,7 @@ class AuditLogRoot(Entity):
 
     @property
     def directory_audits(self):
+        # type: () -> EntityCollection[DirectoryAudit]
         """
         Get the list of audit logs generated by Azure Active Directory. This includes audit logs generated
         by various services within Azure AD, including user, app, device and group Management,
@@ -32,6 +33,7 @@ class AuditLogRoot(Entity):
 
     @property
     def signins(self):
+        # type: () -> EntityCollection[SignIn]
         """
         Retrieve the Azure AD user sign-ins for your tenant. Sign-ins that are interactive in nature
         (where a username/password is passed as part of auth token) and successful federated sign-ins are currently
@@ -47,6 +49,7 @@ class AuditLogRoot(Entity):
 
     @property
     def provisioning(self):
+        # type: () -> EntityCollection[ProvisioningObjectSummary]
         """
         Get all provisioning events that occurred in your tenant, such as the deletion of a group in
         a target application or the creation of a user when provisioning user accounts from your HR system.