Office365-REST-Python-Client 2.4.3__py3-none-any.whl → 2.4.4__py3-none-any.whl

office365/base_item.py

@@ -1,6 +1,8 @@
+from datetime import datetime
 from office365.directory.permissions.identity_set import IdentitySet
 from office365.entity import Entity
 from office365.onedrive.listitems.item_reference import ItemReference
+from office365.runtime.paths.resource_path import ResourcePath
 
 
 class BaseItem(Entity):
@@ -17,20 +19,38 @@ class BaseItem(Entity):
         """Identity of the user, device, or application which created the item."""
         return self.properties.get('createdBy', IdentitySet())
 
+    @property
+    def created_by_user(self):
+        """
+        Identity of the user who created the item
+        """
+        from office365.directory.users.user import User
+        return self.properties.get('createdByUser',
+                                   User(self.context, ResourcePath("createdByUser", self.resource_path)))
+
     @property
     def last_modified_by(self):
         """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.
+        """
+        from office365.directory.users.user import User
+        return self.properties.get('lastModifiedByUser',
+                                   User(self.context, ResourcePath("lastModifiedByUser", self.resource_path)))
+
     @property
     def created_datetime(self):
         """Gets date and time of item creation."""
-        return self.properties.get('createdDateTime', None)
+        return self.properties.get('createdDateTime', datetime.min)
 
     @property
     def last_modified_datetime(self):
         """Gets date and time the item was last modified."""
-        return self.properties.get('lastModifiedDateTime', None)
+        return self.properties.get('lastModifiedDateTime', datetime.min)
 
     @property
     def name(self):
@@ -50,7 +70,6 @@ class BaseItem(Entity):
     def description(self):
         """
         Provides a user-visible description of the item.
-
         :rtype: str or None
         """
         return self.properties.get('description', None)
@@ -63,7 +82,6 @@ class BaseItem(Entity):
     def web_url(self):
         """
         URL that displays the resource in the browser.
-
         :rtype: str or None
         """
         return self.properties.get('webUrl', None)
@@ -81,7 +99,11 @@ class BaseItem(Entity):
         if default_value is None:
             property_mapping = {
                 "createdBy": self.created_by,
+                "createdByUser": self.created_by_user,
+                "createdDateTime": self.created_datetime,
+                "lastModifiedDateTime": self.last_modified_datetime,
                 "lastModifiedBy": self.last_modified_by,
+                "lastModifiedByUser": self.last_modified_by_user,
                 "parentReference": self.parent_reference
             }
             default_value = property_mapping.get(name, None)

office365/communications/calls/invitation_participant_info.py

@@ -1,6 +1,22 @@
+from office365.directory.permissions.identity_set import IdentitySet
 from office365.runtime.client_value import ClientValue
 
 
 class InvitationParticipantInfo(ClientValue):
     """This resource is used to represent the entity that is being invited to a group call."""
-    pass
+
+    def __init__(self, hidden=None, identity=IdentitySet(), participant_id=None,
+                 remove_from_default_audio_routing_group=None, replaces_call_id=None):
+        """
+        :param bool hidden: Optional. Whether to hide the participant from the roster.
+        :param IdentitySet identity: The identitySet associated with this invitation.
+        :param str participant_id: Optional. The ID of the target participant.
+        :param bool remove_from_default_audio_routing_group: Optional. Whether to remove them from the main mixer.
+        :param str replaces_call_id: Optional. The call which the target identity is currently a part of.
+            For peer-to-peer case, the call will be dropped once the participant is added successfully.
+        """
+        self.hidden = hidden
+        self.identity = identity
+        self.participantId = participant_id
+        self.removeFromDefaultAudioRoutingGroup = remove_from_default_audio_routing_group
+        self.replacesCallId = replaces_call_id

office365/communications/calls/options.py

@@ -3,3 +3,12 @@ from office365.runtime.client_value import ClientValue
 
 class CallOptions(ClientValue):
     """Represents an abstract base class that contains the optional features for a call."""
+
+    def __init__(self, hide_bot_after_escalation=None, is_content_sharing_notification_enabled=None):
+        """
+        :param bool hide_bot_after_escalation: Indicates whether to hide the app after the call is escalated.
+        :param bool is_content_sharing_notification_enabled: Indicates whether content sharing notifications should be
+           enabled for the call.
+        """
+        self.hideBotAfterEscalation = hide_bot_after_escalation
+        self.isContentSharingNotificationEnabled = is_content_sharing_notification_enabled

office365/communications/onlinemeetings/provider_type.py

@@ -5,6 +5,9 @@ class OnlineMeetingProviderType:
         pass
 
     unknown = 0
+
     skypeForBusiness = 1
+
     skypeForConsumer = 2
+
     teamsForBusiness = 3

office365/communications/presences/presence.py

@@ -1,4 +1,6 @@
+from office365.communications.presences.status_message import PresenceStatusMessage
 from office365.entity import Entity
+from office365.outlook.mail.item_body import ItemBody
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 
 
@@ -46,6 +48,18 @@ class Presence(Entity):
         self.context.add_query(qry)
         return self
 
+    def set_status_message(self, message):
+        """
+        Set a presence status message for a user. An optional expiration date and time can be supplied.
+        :param str message: Status message item.
+        """
+        payload = {
+            "statusMessage": PresenceStatusMessage(ItemBody(message))
+        }
+        qry = ServiceOperationQuery(self, "setStatusMessage", None, payload)
+        self.context.add_query(qry)
+        return self
+
     def set_user_preferred_presence(self, availability="Available", activity="Available", expiration_duration=None):
         """
         Set the preferred availability and activity status for a user. If the preferred presence of a user is set,

office365/communications/presences/status_message.py

@@ -0,0 +1,12 @@
+from office365.outlook.mail.item_body import ItemBody
+from office365.runtime.client_value import ClientValue
+
+
+class PresenceStatusMessage(ClientValue):
+    """Represents a presence status message related to the presence of a user in Microsoft Teams."""
+
+    def __init__(self, message=ItemBody()):
+        """
+        :param ItemBody message: Status message item.
+        """
+        self.message = message

office365/directory/audit/signins/activity.py

@@ -0,0 +1,31 @@
+from office365.runtime.client_value import ClientValue
+
+
+class SignInActivity(ClientValue):
+    """Provides the last interactive or non-interactive sign-in time for a specific user. Since signInActivity
+    describes a property of the user object, Azure AD stores sign in activity for your users for as long as the
+    user object exists."""
+
+    def __init__(self, last_non_interactive_sign_in_datetime=None, last_non_interactive_sign_in_request_id=None,
+                 last_sign_in_datetime=None, last_sign_in_request_id=None):
+        """
+        :param datetime.datetime last_non_interactive_sign_in_datetime: The last non-interactive sign-in date for a
+            specific user. You can use this field to calculate the last time a client attempted to sign into the
+            directory on behalf of a user. Because some users may use clients to access tenant resources rather
+            than signing into your tenant directly, you can use the non-interactive sign-in date to along with
+            lastSignInDateTime to identify inactive users.
+        :param str last_non_interactive_sign_in_request_id: Request identifier of the last non-interactive sign-in
+            performed by this user.
+        :param datetime.datetime last_sign_in_datetime: The last interactive sign-in date and time for a specific user.
+            You can use this field to calculate the last time a user attempted to sign into the directory with an
+            interactive authentication method. This field can be used to build reports, such as inactive users.
+            The timestamp represents date and time information using ISO 8601 format and is always in UTC time.
+            For example, midnight UTC on Jan 1, 2014 is: '2014-01-01T00:00:00Z'. Azure AD maintains interactive
+            sign-ins going back to April 2020. For more information about using the value of this property,
+            see Manage inactive user accounts in Azure AD.
+        :param str last_sign_in_request_id: Request identifier of the last interactive sign-in performed by this user.
+        """
+        self.lastNonInteractiveSignInDateTime = last_non_interactive_sign_in_datetime
+        self.lastNonInteractiveSignInRequestId = last_non_interactive_sign_in_request_id
+        self.lastSignInDateTime = last_sign_in_datetime
+        self.lastSignInRequestId = last_sign_in_request_id

office365/directory/audit/signins/location.py

@@ -1,5 +1,22 @@
+from office365.onedrive.driveitems.geo_coordinates import GeoCoordinates
 from office365.runtime.client_value import ClientValue
 
 
 class SignInLocation(ClientValue):
     """Provides the city, state and country/region from where the sign-in happened."""
+
+    def __init__(self, city=None, country_or_region=None, geo_coordinates=GeoCoordinates(), state=None):
+        """
+        :param str city: Provides the city where the sign-in originated. This is calculated using latitude/longitude
+            information from the sign-in activity.
+        :param str country_or_region: Provides the country code info (2 letter code) where the sign-in originated.
+            This is calculated using latitude/longitude information from the sign-in activity.
+        :param GeoCoordinates geo_coordinates: Provides the latitude, longitude and altitude where the sign-in
+            originated.
+        :param str state: Provides the State where the sign-in originated. This is calculated using latitude/longitude
+            information from the sign-in activity.
+        """
+        self.city = city
+        self.countryOrRegion = country_or_region
+        self.geoCoordinates = geo_coordinates
+        self.state = state

office365/directory/audit/signins/signin.py

@@ -9,6 +9,31 @@ class SignIn(Entity):
     You must have an Azure AD Premium P1 or P2 license to download sign-in logs using the Microsoft Graph API.
     """
 
+    @property
+    def app_display_name(self):
+        """
+        App name displayed in the Azure Portal.
+        :rtype: str
+        """
+        return self.properties.get("appDisplayName", None)
+
+    @property
+    def app_id(self):
+        """
+        Unique GUID representing the app ID in the Azure Active Directory.
+        :rtype: str
+        """
+        return self.properties.get("appId", None)
+
+    @property
+    def client_app_used(self):
+        """
+        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 device_detail(self):
         """Device information from where the sign-in occurred; includes device ID, operating system, and browser.

office365/directory/authentication/authentication.py

@@ -10,6 +10,14 @@ class Authentication(Entity):
     for users.
     """
 
+    @property
+    def email_methods(self):
+        """The email address registered to a user for authentication."""
+        from office365.directory.authentication.methods.email import EmailAuthenticationMethod
+        return self.properties.get('emailMethods',
+                                   EntityCollection(self.context, EmailAuthenticationMethod,
+                                                    ResourcePath("emailMethods", self.resource_path)))
+
     @property
     def fido2_methods(self):
         """Represents the FIDO2 security keys registered to a user for authentication."""
@@ -45,6 +53,7 @@ class Authentication(Entity):
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {
+                "emailMethods": self.email_methods,
                 "fido2Methods": self.fido2_methods,
                 "passwordMethods": self.password_methods,
                 "phoneMethods": self.phone_methods

office365/directory/authentication/methods/details.py

@@ -5,3 +5,21 @@ class UserRegistrationDetails(Entity):
     """Represents the state of a user's authentication methods, including which methods are registered and which
     features the user is registered and capable of (such as multi-factor authentication, self-service password reset,
     and passwordless authentication)."""
+
+    @property
+    def is_admin(self):
+        """
+        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):
+        """
+        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)

office365/directory/authentication/methods/email.py

@@ -0,0 +1,16 @@
+from office365.directory.authentication.methods.method import AuthenticationMethod
+
+
+class EmailAuthenticationMethod(AuthenticationMethod):
+    """
+    Represents an email address registered to a user. Email as an authentication method is available only for
+    self-service password reset (SSPR). Users may only have one email authentication method.
+    """
+
+    @property
+    def email_address(self):
+        """
+        The email address registered to this user.
+        :rtype: str
+        """
+        return self.properties.get("emailAddress", None)

office365/directory/authentication/methods/root.py

@@ -1,12 +1,22 @@
 from office365.directory.authentication.methods.details import UserRegistrationDetails
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
+from office365.reports.userregistration.method_summary import UserRegistrationMethodSummary
+from office365.runtime.client_result import ClientResult
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.function import FunctionQuery
 
 
 class AuthenticationMethodsRoot(Entity):
     """Container for navigation properties for Azure AD authentication methods resources."""
 
+    def users_registered_by_method(self):
+        """Get the number of users registered for each authentication method."""
+        return_type = ClientResult(self.context, UserRegistrationMethodSummary())
+        qry = FunctionQuery(self, "usersRegisteredByMethod", None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def user_registration_details(self):
         """Represents the state of a user's authentication methods, including which methods are registered and which

office365/directory/certificates/authority.py

@@ -4,14 +4,19 @@ from office365.runtime.client_value import ClientValue
 class CertificateAuthority(ClientValue):
     """Represents a certificate authority."""
 
-    def __init__(self, certificate=None, certificate_revocation_list_url=None, is_root_authority=None):
+    def __init__(self, certificate=None, certificate_revocation_list_url=None, is_root_authority=None,
+                 issuer=None, issuer_ski=None):
         """
         :param str certificate: The base64 encoded string representing the public certificate.
         :param str certificate_revocation_list_url: The URL of the certificate revocation list.
         :param str is_root_authority: Required. true if the trusted certificate is a root authority, false if the
             trusted certificate is an intermediate authority.
+        :param str issuer: The issuer of the certificate, calculated from the certificate value
+        :param str issuer_ski: The subject key identifier of the certificate, calculated from the certificate value.
         """
         super(CertificateAuthority, self).__init__()
         self.certificate = certificate
         self.certificateRevocationListUrl = certificate_revocation_list_url
         self.isRootAuthority = is_root_authority
+        self.issuer = issuer
+        self.issuerSki = issuer_ski

office365/directory/extensions/extended_property.py

@@ -4,7 +4,14 @@ from office365.runtime.types.collections import StringCollection
 
 class SingleValueLegacyExtendedProperty(Entity):
     """An extended property that contains a single value."""
-    pass
+
+    @property
+    def value(self):
+        """
+        A property value.
+        :rtype: str
+        """
+        return self.properties.get("value", None)
 
 
 class MultiValueLegacyExtendedProperty(Entity):

office365/directory/extensions/extension_property.py

@@ -15,7 +15,6 @@ class ExtensionProperty(DirectoryObject):
     def name(self):
         """
         Name of the extension property.
-
         :rtype: str
         """
         return self.properties.get("name", None)
@@ -24,7 +23,6 @@ class ExtensionProperty(DirectoryObject):
     def app_display_name(self):
         """
         Display name of the application object on which this extension property is defined. Read-only.
-
         :rtype: str
         """
         return self.properties.get("appDisplayName", None)
@@ -39,7 +37,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/extensions/open_type.py

@@ -7,3 +7,11 @@ class OpenTypeExtension(Extension):
     an extensibility option that provides an easy way to directly add untyped properties to a resource
     in Microsoft Graph.
     """
+
+    @property
+    def extension_name(self):
+        """
+        A unique text identifier for an open type data extension. Optional.
+        :rtype: str
+        """
+        return self.properties.get("extensionName", None)

office365/directory/groups/group.py

@@ -40,8 +40,9 @@ class Group(DirectoryObject):
         return self
 
     def check_granted_permissions_for_app(self):
+        """"""
         return_type = EntityCollection(self.context, ResourceSpecificPermissionGrant)
-        qry = ServiceOperationQuery(self, "checkGrantedPermissionsForApp", None, None, None, return_type)
+        qry = ServiceOperationQuery(self, "checkGrantedPermissionsForApp", return_type=return_type)
         self.context.add_query(qry)
         return return_type
 

office365/directory/identities/governance.py

@@ -11,3 +11,5 @@ class IdentityGovernance(Entity):
        - App consent
        - Terms of use
     """
+
+

office365/directory/insights/shared.py

@@ -1,5 +1,7 @@
 from office365.directory.insights.resource_reference import ResourceReference
+from office365.directory.insights.sharing_detail import SharingDetail
 from office365.entity import Entity
+from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
 
 
@@ -12,6 +14,11 @@ class SharedInsight(Entity):
       that users share as a links in an email.
     """
 
+    @property
+    def last_shared(self):
+        """Details about the shared item. Read-only"""
+        return self.properties.get("lastShared", SharingDetail())
+
     @property
     def resource_reference(self):
         """Reference properties of the used document, such as the url and type of the document. Read-only"""
@@ -24,10 +31,17 @@ class SharedInsight(Entity):
         return self.properties.get('resource',
                                    Entity(self.context, ResourcePath("resource", self.resource_path)))
 
+    @property
+    def sharing_history(self):
+        """Details about the sharing history. Read-only"""
+        return self.properties.get("sharingHistory", ClientValueCollection(SharingDetail))
+
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {
-                "resourceReference": self.resource_reference
+                "lastShared": self.last_shared,
+                "resourceReference": self.resource_reference,
+                "sharingHistory": self.sharing_history
             }
             default_value = property_mapping.get(name, None)
         return super(SharedInsight, self).get_property(name, default_value)

office365/directory/insights/usage_details.py

@@ -0,0 +1,16 @@
+from datetime import datetime
+
+from office365.runtime.client_value import ClientValue
+
+
+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):
+        """
+        :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.
+        """
+        self.lastAccessedDateTime = last_accessed_datetime
+        self.lastModifiedDateTime = last_modified_datetime

office365/directory/insights/used.py

@@ -1,4 +1,5 @@
 from office365.directory.insights.resource_reference import ResourceReference
+from office365.directory.insights.usage_details import UsageDetails
 from office365.entity import Entity
 from office365.runtime.paths.resource_path import ResourcePath
 
@@ -11,6 +12,11 @@ class UsedInsight(Entity):
       SharePoint
     """
 
+    @property
+    def last_used(self):
+        """Information about when the item was last viewed or modified by the user."""
+        return self.properties.get("lastUsed", UsageDetails())
+
     @property
     def resource_reference(self):
         """Reference properties of the used document, such as the url and type of the document. Read-only"""
@@ -26,6 +32,7 @@ class UsedInsight(Entity):
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {
+                "lastUsed": self.last_used,
                 "resourceReference": self.resource_reference
             }
             default_value = property_mapping.get(name, None)

office365/directory/licenses/assigned_plan.py

@@ -6,9 +6,21 @@ class AssignedPlan(ClientValue):
     The assignedPlans property of both the user entity and the organization entity is a collection of assignedPlan.
     """
 
-    def __init__(self, assigned_datetime=None):
+    def __init__(self, assigned_datetime=None, capability_status=None, service=None, service_plan_id=None):
         """
-        :param datetime assigned_datetime: The date and time at which the plan was assigned.
+        :param datetime.datetime assigned_datetime: The date and time at which the plan was assigned.
+        :param str capability_status: Condition of the capability assignment.
+            The possible values are Enabled, Warning, Suspended, Deleted, LockedOut.
+            See a detailed description of each value.
+        :param str service: The name of the service; for example, exchange.
+        :param str service_plan_id: A GUID that identifies the service plan. For a complete list of GUIDs and their
+            equivalent friendly service names, see Product names and service plan identifiers for licensing.
         """
         self.assignedDateTime = assigned_datetime
+        self.capabilityStatus = capability_status
+        self.service = service
+        self.servicePlanId = service_plan_id
+
+    def __repr__(self):
+        return self.service
 

office365/directory/licenses/service_plan_info.py

@@ -27,3 +27,7 @@ class ServicePlanInfo(ClientValue):
         self.servicePlanName = name
         self.provisioningStatus = provisioning_status
         self.appliesTo = applies_to
+
+    def __repr__(self):
+        return self.servicePlanName
+

office365/directory/licenses/subscribed_sku.py

@@ -1,4 +1,5 @@
 from office365.directory.licenses.service_plan_info import ServicePlanInfo
+from office365.directory.licenses.units_detail import LicenseUnitsDetail
 from office365.entity import Entity
 from office365.runtime.client_value_collection import ClientValueCollection
 
@@ -9,10 +10,20 @@ class SubscribedSku(Entity):
     @property
     def account_id(self):
         """
+        The unique ID of the account this SKU belongs to.
         :rtype: str
         """
         return self.properties.get("accountId", None)
 
+    @property
+    def applies_to(self):
+        """
+        The target class for this SKU. Only SKUs with target class User are assignable.
+        Possible values are: "User", "Company".
+        :rtype: str
+        """
+        return self.properties.get("appliesTo", None)
+
     @property
     def sku_id(self):
         """
@@ -21,6 +32,20 @@ class SubscribedSku(Entity):
         """
         return self.properties.get("skuId", None)
 
+    @property
+    def sku_part_number(self):
+        """
+        The SKU part number; for example: "AAD_PREMIUM" or "RMSBASIC".
+        To get a list of commercial subscriptions that an organization has acquired, see List subscribedSkus.
+        :rtype: str
+        """
+        return self.properties.get("skuPartNumber", None)
+
+    @property
+    def prepaid_units(self):
+        """Information about the number and status of prepaid licenses."""
+        return self.properties.get("prepaidUnits", LicenseUnitsDetail())
+
     @property
     def service_plans(self):
         """Information about the service plans that are available with the SKU. Not nullable"""
@@ -29,6 +54,7 @@ class SubscribedSku(Entity):
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {
+                "prepaidUnits": self.prepaid_units,
                 "servicePlans": self.service_plans
             }
             default_value = property_mapping.get(name, None)

office365/directory/licenses/units_detail.py

@@ -0,0 +1,11 @@
+from office365.runtime.client_value import ClientValue
+
+
+class LicenseUnitsDetail(ClientValue):
+    """"""
+
+    def __init__(self, enabled=None):
+        """
+        :param int enabled: The number of units that are enabled for the active subscription of the service SKU.
+        """
+        self.enabled = enabled

office365/directory/permissions/email_identity.py

@@ -0,0 +1,5 @@
+from office365.directory.permissions.identity import Identity
+
+
+class EmailIdentity(Identity):
+    """Represents the email identity of a user."""