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

office365/onedrive/lists/collection.py

@@ -1,5 +1,6 @@
 from office365.entity_collection import EntityCollection
 from office365.onedrive.lists.list import List
+from office365.runtime.paths.item import ItemPath
 from office365.runtime.queries.create_entity import CreateEntityQuery
 
 
@@ -11,20 +12,25 @@ class ListCollection(EntityCollection):
 
     def __getitem__(self, key):
         """
-        Address List by identifier or name
+        Gets List by it's identifier or name
         :param str key: List identifier or name
         :rtype: List
         """
         return super(ListCollection, self).__getitem__(key)
 
-    def add(self, creation_information):
+    def add(self, display_name, list_template="genericList"):
         """
-        Creates a Drive list resource
+        Create a new list.
 
-        :param Any creation_information:
+        :param str display_name: The displayable title of the list.
+        :param str list_template: The base list template used in creating the list
         """
-        return_type = List(self.context)
+        return_type = List(self.context, ItemPath(self.resource_path))
         self.add_child(return_type)
-        qry = CreateEntityQuery(self, creation_information, return_type)
+        payload = {
+            "displayName": display_name,
+            "list": {"template": list_template},
+        }
+        qry = CreateEntityQuery(self, payload, return_type)
         self.context.add_query(qry)
         return return_type

office365/onedrive/lists/list.py

@@ -4,6 +4,7 @@ from office365.onedrive.columns.definition_collection import ColumnDefinitionCol
 from office365.onedrive.contenttypes.collection import ContentTypeCollection
 from office365.onedrive.listitems.list_item import ListItem
 from office365.onedrive.lists.info import ListInfo
+from office365.onedrive.operations.rich_long_running import RichLongRunningOperation
 from office365.onedrive.sharepoint_ids import SharePointIds
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.subscriptions.subscription import Subscription
@@ -17,7 +18,6 @@ class List(BaseItem):
     def display_name(self):
         """
         The displayable title of the list.
-
         :rtype: str or None
         """
         return self.properties.get("displayName", None)
@@ -42,9 +42,9 @@ class List(BaseItem):
     @property
     def columns(self):
         """The collection of columns under this site."""
-        return self.properties.get('columns',
-                                   ColumnDefinitionCollection(self.context,
-                                                              ResourcePath("columns", self.resource_path), self))
+        return self.properties.setdefault('columns',
+                                          ColumnDefinitionCollection(self.context,
+                                                                     ResourcePath("columns", self.resource_path), self))
 
     @property
     def content_types(self):
@@ -57,7 +57,15 @@ class List(BaseItem):
     def items(self):
         """All items contained in the list."""
         return self.properties.get('items',
-                                   EntityCollection(self.context, ListItem, ResourcePath("items", self.resource_path)))
+                                   EntityCollection(self.context, ListItem,
+                                                    ResourcePath("items", self.resource_path)))
+
+    @property
+    def operations(self):
+        """The collection of long-running operations on the list."""
+        return self.properties.get('operations',
+                                   EntityCollection(self.context, RichLongRunningOperation,
+                                                    ResourcePath("operations", self.resource_path)))
 
     @property
     def subscriptions(self):

office365/onedrive/operations/long_running.py

@@ -10,3 +10,10 @@ class LongRunningOperation(Entity):
         :rtype: str or None
         """
         return self.properties.get('resourceLocation', None)
+
+    @property
+    def status_detail(self):
+        """Details about the status of the operation.
+        :rtype: str or None
+        """
+        return self.properties.get('statusDetail', None)

office365/onedrive/operations/pending.py

@@ -0,0 +1,13 @@
+from office365.onedrive.operations.pending_content_update import PendingContentUpdate
+from office365.runtime.client_value import ClientValue
+
+
+class PendingOperations(ClientValue):
+    """Indicates that one or more operations that might affect the state of the driveItem are pending completion."""
+
+    def __init__(self, pending_content_update=PendingContentUpdate()):
+        """
+        :param str pending_content_update: A property that indicates that an operation that might update the binary
+            content of a file is pending completion.
+        """
+        self.pendingContentUpdate = pending_content_update

office365/onedrive/operations/pending_content_update.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class PendingContentUpdate(ClientValue):
+    """Indicates that an operation that might affect the binary content of the driveItem is pending completion."""

office365/onedrive/permissions/collection.py

@@ -1,5 +1,4 @@
 from office365.directory.permissions.identity import Identity
-from office365.directory.permissions.identity_set import IdentitySet
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.onedrive.permissions.permission import Permission
@@ -7,7 +6,7 @@ from office365.runtime.queries.create_entity import CreateEntityQuery
 
 
 class PermissionCollection(EntityCollection):
-    """Drive list's collection"""
+    """Permission's collection"""
 
     def __init__(self, context, resource_path=None):
         super(PermissionCollection, self).__init__(context, Permission, resource_path)
@@ -23,7 +22,7 @@ class PermissionCollection(EntityCollection):
 
         return_type = Permission(self.context)
 
-        known_identity_endpoints = {
+        known_identities = {
             "application": self.context.applications,
             "user": self.context.users,
             "device": self.context.device_app_management,
@@ -35,10 +34,10 @@ class PermissionCollection(EntityCollection):
         else:
             if identity_type is None:
                 raise ValueError("Identity type is a mandatory when identity identifier is specified")
-            known_identity_endpoint = known_identity_endpoints.get(identity_type, None)
-            if known_identity_endpoint is None:
+            known_identity = known_identities.get(identity_type, None)
+            if known_identity is None:
                 raise ValueError("Unknown identity type")
-            identity = known_identity_endpoint[identity]
+            identity = known_identity[identity]
 
         def _create():
             payload = {

office365/onedrive/permissions/sharing_link.py

@@ -1,15 +1,30 @@
+from office365.directory.permissions.identity import Identity
 from office365.runtime.client_value import ClientValue
 
 
 class SharingLink(ClientValue):
     """The SharingLink resource groups link-related data items into a single structure."""
 
-    def __init__(self, _type=None, scope=None):
+    def __init__(self, _type=None, scope=None, web_html=None, web_url=None, prevents_download=None,
+                 application=Identity()):
         """
         :param str _type: The type of the link created.
         :param str scope: The scope of the link represented by this permission. Value anonymous indicates the link is
              usable by anyone, organization indicates the link is only usable for users signed into the same tenant.
+         :param str web_html: For embed links, this property contains the HTML code for an <iframe> element that will
+             embed the item in a webpage.
+         :param str web_url: A URL that opens the item in the browser on the OneDrive website.
+         :param bool prevents_download: If true then the user can only use this link to view the item on the web,
+              and cannot use it to download the contents of the item. Only for OneDrive for Business and SharePoint.
+         :param Identity application: The app the link is associated with.
         """
         super(SharingLink, self).__init__()
         self.type = _type
         self.scope = scope
+        self.webHtml = web_html
+        self.webUrl = web_url
+        self.preventsDownload = prevents_download
+        self.application = application
+
+    def __repr__(self):
+        return self.webUrl

office365/onedrive/sensitivitylabels/assignment.py

@@ -0,0 +1,17 @@
+from office365.runtime.client_value import ClientValue
+
+
+class SensitivityLabelAssignment(ClientValue):
+    """Provides details about a sensitivity label assigned to a file in SharePoint or OneDrive for Business."""
+
+    def __init__(self, assignment_method=None, sensitivity_label_id=None, tenant_id=None):
+        """
+        :param str assignment_method: Indicates whether the label assignment is done automatically, as a standard,
+            or a privileged operation.
+        :param str sensitivity_label_id: The unique identifier for the sensitivity label assigned to the file.
+        : 	The unique identifier for the tenant that hosts the file when this label is applied.
+        :param str tenant_id: The unique identifier for the tenant that hosts the file when this label is applied.
+        """
+        self.assignmentMethod = assignment_method
+        self.sensitivityLabelId = sensitivity_label_id
+        self.tenantId = tenant_id

office365/onedrive/sensitivitylabels/assignment_method.py

@@ -0,0 +1,4 @@
+class SensitivityLabelAssignmentMethod:
+
+    standard = "standard"
+    """The assignment method for the label is standard."""

office365/onedrive/sensitivitylabels/extract_result.py

@@ -0,0 +1,13 @@
+from office365.onedrive.sensitivitylabels.assignment import SensitivityLabelAssignment
+from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+
+
+class ExtractSensitivityLabelsResult(ClientValue):
+    """Represents the response format for the extractSensitivityLabels API."""
+
+    def __init__(self, labels=None):
+        """
+        :param list[SensitivityLabelAssignment] labels: List of sensitivity labels assigned to a file.
+        """
+        self.labels = ClientValueCollection(SensitivityLabelAssignment, labels)

office365/onedrive/sharepoint_settings.py

@@ -20,6 +20,31 @@ class SharepointSettings(Entity):
         """Collection of file extensions not uploaded by the OneDrive sync app. """
         return self.properties.get("excludedFileExtensionsForSyncApp", StringCollection())
 
+    @property
+    def site_creation_default_managed_path(self):
+        """
+        The value of the team site managed path. This is the path under which new team sites will be created.
+        :rtype: str
+        """
+        return self.properties.get("siteCreationDefaultManagedPath", None)
+
+    @property
+    def site_creation_default_storage_limit_in_mb(self):
+        """
+        The default storage quota for a new site upon creation. Measured in megabytes (MB).
+        :rtype: int
+        """
+        return self.properties.get("siteCreationDefaultStorageLimitInMB", None)
+
+    @property
+    def tenant_default_timezone(self):
+        """
+        The default timezone of a tenant for newly created sites. For a list of possible values,
+        see SPRegionalSettings.TimeZones property.
+        :rtype: str
+        """
+        return self.properties.get("tenantDefaultTimezone", None)
+
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {

office365/onedrive/sites/sites_with_root.py

@@ -3,6 +3,7 @@ from office365.onedrive.internal.paths.root import RootPath
 from office365.onedrive.internal.paths.site import SitePath
 from office365.onedrive.sites.site import Site
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.function import FunctionQuery
 from office365.runtime.queries.read_entity import ReadEntityQuery
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 
@@ -10,9 +11,18 @@ from office365.runtime.queries.service_operation import ServiceOperationQuery
 class SitesWithRoot(EntityCollection):
     """Sites container"""
 
-    def __init__(self, context, resource_path):
+    def __init__(self, context, resource_path=None):
         super(SitesWithRoot, self).__init__(context, Site, resource_path)
 
+    def get_all_sites(self):
+        """
+        List root sites across geographies in an organization.
+        """
+        return_type = SitesWithRoot(self.context)
+        qry = FunctionQuery(self, "getAllSites", return_type=return_type)
+        self.context.add_query(qry)
+        return return_type
+
     def get_by_url(self, url):
         """Address Site resource by absolute url
 

office365/onedrive/termstore/groups/collection.py

@@ -23,4 +23,4 @@ class GroupCollection(EntityCollection):
         :param str name: Group name
         :rtype: Group
         """
-        return self.filter("displayName eq '{0}'".format(name)).single()
+        return self.single("displayName eq '{0}'".format(name))

office365/onedrive/termstore/groups/group.py

@@ -4,6 +4,7 @@ from office365.runtime.paths.resource_path import ResourcePath
 
 
 class Group(Entity):
+    """Term Group"""
 
     @property
     def display_name(self):

office365/onedrive/termstore/sets/collection.py

@@ -21,7 +21,7 @@ class SetCollection(EntityCollection):
         :param str name: Term set name
         :rtype: Set
         """
-        return self.filter("displayName eq '{0}'".format(name)).single()
+        return self.single("displayName eq '{0}'".format(name))
 
     def add(self, name, parent_group=None):
         """Create a new set object.

office365/onenote/operations/operation.py

@@ -1,5 +1,14 @@
+from datetime import datetime
+
 from office365.entity import Entity
 
 
 class Operation(Entity):
-    pass
+    """The status of a long-running operation."""
+
+    @property
+    def created_datetime(self):
+        """
+        The start time of the operation.
+        """
+        return self.properties("createdDateTime", datetime.min)

office365/onenote/resources/resource.py

@@ -2,6 +2,7 @@ from office365.onenote.entity_base_model import OnenoteEntityBaseModel
 from office365.runtime.client_result import ClientResult
 from office365.runtime.queries.function import FunctionQuery
 
+
 class OnenoteResource(OnenoteEntityBaseModel):
     """An image or other file resource on a OneNote page."""
 

office365/outlook/calendar/calendar.py

@@ -1,14 +1,18 @@
+from office365.directory.extensions.extended_property import MultiValueLegacyExtendedProperty, \
+    SingleValueLegacyExtendedProperty
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.outlook.calendar.dateTimeTimeZone import DateTimeTimeZone
 from office365.outlook.calendar.email_address import EmailAddress
 from office365.outlook.calendar.events.collection import EventCollection
-from office365.outlook.calendar.permission import CalendarPermission
+from office365.outlook.calendar.permissions.collection import CalendarPermissionCollection
 from office365.outlook.calendar.schedule.information import ScheduleInformation
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.function import FunctionQuery
 from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.runtime.types.collections import StringCollection
 
 
 class Calendar(Entity):
@@ -17,7 +21,17 @@ class Calendar(Entity):
         of a Microsoft 365 group.
     """
 
-    def get_schedule(self, schedules, start_time=None, end_time=None, availability_view_interval=30):
+    def allowed_calendar_sharing_roles(self, user):
+        """
+        :param str user: User identifier or principal name
+        """
+        params = {"user": user}
+        return_type = ClientResult(self.context, StringCollection())
+        qry = FunctionQuery(self, "allowedCalendarSharingRoles", params, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def get_schedule(self, schedules, start_time, end_time, availability_view_interval=30):
         """
         Get the free/busy availability information for a collection of users, distributions lists, or resources
         (rooms or equipment) for a specified time period.
@@ -40,24 +54,102 @@ class Calendar(Entity):
         self.context.add_query(qry)
         return return_type
 
+    @property
+    def allowed_online_meeting_providers(self):
+        """
+        Represent the online meeting service providers that can be used to create online meetings in this calendar.
+        Possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness.
+        """
+        return self.properties.get('allowedOnlineMeetingProviders', StringCollection())
+
     @property
     def can_edit(self):
         """
         true if the user can write to the calendar, false otherwise.
         This property is true for the user who created the calendar.
         This property is also true for a user who has been shared a calendar and granted write access.
-
         :rtype: bool or None
         """
         return self.properties.get('canEdit', None)
 
+    @property
+    def can_share(self):
+        """
+        true if the user has the permission to share the calendar, false otherwise.
+        Only the user who created the calendar can share it.
+        :rtype: bool or None
+        """
+        return self.properties.get('canShare', None)
+
+    @property
+    def can_view_private_items(self):
+        """
+        true if the user can read calendar items that have been marked private, false otherwise.
+        :rtype: bool or None
+        """
+        return self.properties.get('canViewPrivateItems', None)
+
+    @property
+    def change_key(self):
+        """
+        Identifies the version of the calendar object. Every time the calendar is changed, changeKey changes as well.
+        This allows Exchange to apply changes to the correct version of the object.
+        :rtype: str
+        """
+        return self.properties.get('changeKey', None)
+
+    @property
+    def color(self):
+        """
+        Specifies the color theme to distinguish the calendar from other calendars in a UI.
+        The property values are: auto, lightBlue, lightGreen, lightOrange, lightGray, lightYellow, lightTeal,
+        lightPink, lightBrown, lightRed, maxColor.
+        :rtype: str
+        """
+        return self.properties.get('color', None)
+
+    @property
+    def default_online_meeting_provider(self):
+        """
+        The default online meeting provider for meetings sent from this calendar.
+        Possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness.
+        :rtype: str
+        """
+        return self.properties.get('defaultOnlineMeetingProvider', None)
+
     @property
     def name(self):
         """
         The calendar name.
+        :rtype: str
         """
         return self.properties.get('name', None)
 
+    @property
+    def is_default_calendar(self):
+        """
+        true if this is the default calendar where new events are created by default, false otherwise.
+        :rtype: bool or None
+        """
+        return self.properties.get('isDefaultCalendar', None)
+
+    @property
+    def is_removable(self):
+        """
+        Indicates whether this user calendar can be deleted from the user mailbox.
+        :rtype: bool or None
+        """
+        return self.properties.get("isRemovable", None)
+
+    @property
+    def is_tallying_responses(self):
+        """
+        Indicates whether this user calendar supports tracking of meeting responses.
+        Only meeting invites sent from users' primary calendars support tracking of meeting responses.
+        :rtype: bool or None
+        """
+        return self.properties.get("isTallyingResponses", None)
+
     @property
     def owner(self):
         """If set, this represents the user who created or added the calendar.
@@ -83,14 +175,32 @@ class Calendar(Entity):
     def calendar_permissions(self):
         """The permissions of the users with whom the calendar is shared."""
         return self.properties.get('calendarPermissions',
-                                   EntityCollection(self.context, CalendarPermission,
-                                                    ResourcePath("calendarPermissions", self.resource_path)))
+                                   CalendarPermissionCollection(self.context,
+                                                                ResourcePath("calendarPermissions",
+                                                                             self.resource_path)))
+
+    @property
+    def multi_value_extended_properties(self):
+        """The collection of multi-value extended properties defined for the Calendar."""
+        return self.properties.get('multiValueExtendedProperties',
+                                   EntityCollection(self.context, MultiValueLegacyExtendedProperty,
+                                                    ResourcePath("multiValueExtendedProperties", self.resource_path)))
+
+    @property
+    def single_value_extended_properties(self):
+        """The collection of single-value extended properties defined for the calendar. Read-only. Nullable."""
+        return self.properties.get('singleValueExtendedProperties',
+                                   EntityCollection(self.context, SingleValueLegacyExtendedProperty,
+                                                    ResourcePath("singleValueExtendedProperties", self.resource_path)))
 
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {
+                "allowedOnlineMeetingProviders": self.allowed_online_meeting_providers,
                 "calendarView": self.calendar_view,
-                "calendarPermissions": self.calendar_permissions
+                "calendarPermissions": self.calendar_permissions,
+                "multiValueExtendedProperties": self.multi_value_extended_properties,
+                "singleValueExtendedProperties": self.single_value_extended_properties
             }
             default_value = property_mapping.get(name, None)
         return super(Calendar, self).get_property(name, default_value)

office365/outlook/calendar/dateTimeTimeZone.py

@@ -16,9 +16,13 @@ class DateTimeTimeZone(ClientValue):
         self.dateTime = datetime
         self.timeZone = timezone
 
+    def __repr__(self):
+        return "{0}, {1}".format(self.dateTime, self.timeZone)
+
     @staticmethod
     def parse(dt):
         """
+        Parses from datetime
         :type dt: datetime.datetime
         """
         local_dt = dt.replace(tzinfo=pytz.utc)

office365/outlook/calendar/email_address.py

@@ -5,6 +5,13 @@ class EmailAddress(ClientValue):
     """The name and email address of a contact or message recipient."""
 
     def __init__(self, address=None, name=None):
+        """
+        :param str address:
+        :param str name:
+        """
         super(EmailAddress, self).__init__()
         self.address = address
         self.name = name
+
+    def __repr__(self):
+        return "{0} <{1}>".format(self.name, self.address)

office365/outlook/calendar/events/event.py

@@ -86,8 +86,6 @@ class Event(OutlookItem):
     def start(self):
         """
         The date, time, and time zone that the event starts. By default, the start time is in UTC.
-
-        :rtype: DateTimeTimeZone
         """
         return self.properties.get("start", DateTimeTimeZone())
 
@@ -104,8 +102,6 @@ class Event(OutlookItem):
     def end(self):
         """
         The date, time, and time zone that the event starts. By default, the start time is in UTC.
-
-        :rtype: DateTimeTimeZone
         """
         return self.properties.get("end", DateTimeTimeZone())
 

office365/outlook/calendar/events/reminder.py

@@ -1,15 +1,34 @@
+from office365.outlook.calendar.dateTimeTimeZone import DateTimeTimeZone
+from office365.outlook.mail.location import Location
 from office365.runtime.client_value import ClientValue
 
 
 class Reminder(ClientValue):
     """A reminder for an event in a user calendar."""
 
-    def __init__(self, event_id=None, event_location=None):
+    def __init__(self, change_key=None, event_end_time=DateTimeTimeZone(), event_id=None, event_location=Location(),
+                 event_start_time=DateTimeTimeZone(), event_subject=None, event_web_link=None,
+                 reminder_fire_time=DateTimeTimeZone()):
         """
-
+        :param str change_key: Identifies the version of the reminder. Every time the reminder is changed, changeKey
+            changes as well. This allows Exchange to apply changes to the correct version of the object.
+        :param DateTimeTimeZone event_end_time: The date, time and time zone that the event ends.
         :param str event_id: The unique ID of the event. Read only.
-        :param str event_location:
+        :param Location event_location: The location of the event.
+        :param DateTimeTimeZone event_start_time: The date, time, and time zone that the event starts.
+        :param str event_subject: The text of the event's subject line.
+        :param str event_web_link: The URL to open the event in Outlook on the web.
+             The event will open in the browser if you are logged in to your mailbox via Outlook on the web.
+             You will be prompted to login if you are not already logged in with the browser.
+             This URL cannot be accessed from within an iFrame.
+        :param DateTimeTimeZone reminder_fire_time: The date, time, and time zone that the reminder is set to occur.
         """
         super(Reminder, self).__init__()
+        self.changeKey = change_key
+        self.eventStartTime = event_start_time
+        self.eventEndTime = event_end_time
         self.eventId = event_id
         self.eventLocation = event_location
+        self.eventSubject = event_subject
+        self.eventWebLink = event_web_link
+        self.reminderFireTime = reminder_fire_time

office365/outlook/calendar/group.py

@@ -13,7 +13,6 @@ class CalendarGroup(Entity):
     def name(self):
         """
         The group name.
-
         :rtype: str
         """
         return self.properties.get("name", None)
@@ -22,7 +21,6 @@ class CalendarGroup(Entity):
     def class_id(self):
         """
         The class identifier
-
         :rtype: str
         """
         return self.properties.get("classId", None)

office365/outlook/calendar/location_constraint.py

@@ -1,6 +1,21 @@
+from office365.outlook.mail.location_constraint_item import LocationConstraintItem
 from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
 
 
 class LocationConstraint(ClientValue):
     """The conditions stated by a client for the location of a meeting."""
-    pass
+
+    def __init__(self, is_required=None, locations=None, suggest_location=None):
+        """
+        :param bool is_required: 	The client requests the service to include in the response a meeting location
+            for the meeting. If this is true and all the resources are busy, findMeetingTimes will not return any
+            meeting time suggestions. If this is false and all the resources are busy, findMeetingTimes would still
+            look for meeting times without locations.
+        :param list[LocationConstraintItem] locations: Constraint information for one or more locations that the client
+            requests for the meeting
+        :param bool suggest_location: The client requests the service to suggest one or more meeting locations.
+        """
+        self.isRequired = is_required
+        self.locations = ClientValueCollection(LocationConstraintItem, locations)
+        self.suggestLocation = suggest_location