Office365-REST-Python-Client 2.5.5__py3-none-any.whl → 2.5.7__py3-none-any.whl

office365/onedrive/sites/site.py

@@ -13,6 +13,7 @@ from office365.onedrive.lists.collection import ListCollection
 from office365.onedrive.operations.rich_long_running import RichLongRunningOperation
 from office365.onedrive.permissions.collection import PermissionCollection
 from office365.onedrive.sharepoint_ids import SharePointIds
+from office365.onedrive.sitepages.collection import SitePageCollection
 from office365.onedrive.sites.site_collection import SiteCollection
 from office365.onedrive.termstore.store import Store
 from office365.onenote.onenote import Onenote
@@ -224,6 +225,15 @@ class Site(BaseItem):
             Onenote(self.context, ResourcePath("onenote", self.resource_path)),
         )
 
+    @property
+    def pages(self):
+        # type: () -> SitePageCollection
+        """The collection of site pages under this site."""
+        return self.properties.get(
+            "pages",
+            SitePageCollection(self.context, ResourcePath("pages", self.resource_path)),
+        )
+
     @property
     def term_store(self):
         # type: () -> Store

office365/onedrive/sites/sites_with_root.py

@@ -15,9 +15,7 @@ class SitesWithRoot(EntityCollection[Site]):
         super(SitesWithRoot, self).__init__(context, Site, resource_path)
 
     def get_all_sites(self):
-        """
-        List root sites across geographies in an organization.
-        """
+        """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)

office365/onedrive/termstore/store.py

@@ -3,7 +3,6 @@ from typing import Optional
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.onedrive.termstore.groups.collection import GroupCollection
-from office365.onedrive.termstore.groups.group import Group
 from office365.onedrive.termstore.sets.collection import SetCollection
 from office365.onedrive.termstore.sets.set import Set
 from office365.runtime.paths.resource_path import ResourcePath
@@ -23,10 +22,9 @@ class Store(Entity):
 
         def _groups_loaded(groups):
             # type: (GroupCollection) -> None
-            for g in groups:
-                self.context.load(g.sets, after_loaded=_sets_loaded)
+            [grp.sets.get().after_execute(_sets_loaded) for grp in groups]
 
-        self.context.load(self.groups, after_loaded=_groups_loaded)
+        self.groups.get().after_execute(_groups_loaded)
 
         return return_type
 

office365/onedrive/termstore/terms/collection.py

@@ -5,7 +5,7 @@ from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.queries.create_entity import CreateEntityQuery
 
 
-class TermCollection(EntityCollection):
+class TermCollection(EntityCollection[Term]):
     def __init__(self, context, resource_path=None, parent_set=None):
         """
         :param office365.onedrive.termstore.sets.set.Set parent_set: The parent set that contains the term
@@ -17,7 +17,6 @@ class TermCollection(EntityCollection):
         """Create a new term object.
 
         :param str label: The name of the label.
-        :rtype: Term
         """
         return_type = Term(self.context)
         self.add_child(return_type)

office365/onedrive/workbooks/charts/data_labels.py

@@ -1,7 +1,19 @@
+from typing import Optional
+
 from office365.entity import Entity
 
 
 class WorkbookChartDataLabels(Entity):
     """Represents a collection of all the data labels on a chart point."""
 
-    pass
+    @property
+    def position(self):
+        # type: () -> Optional[str]
+        """DataLabelPosition value that represents the position of the data label."""
+        return self.properties.get("position", None)
+
+    @property
+    def separator(self):
+        # type: () -> Optional[str]
+        """String representing the separator used for the data labels on a chart."""
+        return self.properties.get("separator", None)

office365/onedrive/workbooks/filter.py

@@ -1,5 +1,14 @@
+from typing import Optional
+
 from office365.entity import Entity
+from office365.onedrive.workbooks.filter_criteria import WorkbookFilterCriteria
 
 
 class WorkbookFilter(Entity):
     """Manages the filtering of a table's column."""
+
+    @property
+    def criteria(self):
+        # type: () -> Optional[WorkbookFilterCriteria]
+        """The currently applied filter on the given column."""
+        return self.properties.get("criteria", WorkbookFilterCriteria())

office365/onedrive/workbooks/filter_criteria.py

@@ -3,3 +3,8 @@ from office365.runtime.client_value import ClientValue
 
 class WorkbookFilterCriteria(ClientValue):
     """Represents the filtering criteria applied to a column."""
+
+    def __init__(self, operator=None, values=None):
+        """ """
+        self.operator = operator
+        self.values = values

office365/onedrive/workbooks/functions/functions.py

@@ -48,11 +48,14 @@ class WorkbookFunctions(Entity):
     def days(self, start_date, end_date):
         """Returns the number of days between two dates.
 
-        :param datetime start_date: Two dates between which you want to know the number of days.
-        :param datetime end_date: Two dates between which you want to know the number of days.
+        :param datetime.datetime start_date: Two dates between which you want to know the number of days.
+        :param datetime.datetime end_date: Two dates between which you want to know the number of days.
         """
         return_type = WorkbookFunctionResult(self.context)
-        payload = {"startDate": start_date, "endDate": end_date}
+        payload = {
+            "startDate": start_date.isoformat() + "Z",
+            "endDate": end_date.isoformat() + "Z",
+        }
         qry = ServiceOperationQuery(self, "days", None, payload, None, return_type)
         self.context.add_query(qry)
         return return_type

office365/onedrive/workbooks/functions/result.py

@@ -2,6 +2,8 @@ from office365.entity import Entity
 
 
 class WorkbookFunctionResult(Entity):
+    """"""
+
     @property
     def value(self):
         return self.properties.get("value", None)

office365/onedrive/workbooks/operations/workbook.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.onedrive.workbooks.operations.error import WorkbookOperationError
 
@@ -7,22 +9,17 @@ class WorkbookOperation(Entity):
 
     @property
     def error(self):
-        """
-        The error returned by the operation.
-        """
+        """The error returned by the operation."""
         return self.properties.get("error", WorkbookOperationError())
 
     @property
     def resource_location(self):
-        """The resource URI for the result.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The resource URI for the result."""
         return self.properties.get("resourceLocation", None)
 
     @property
     def status(self):
-        """
-        The current status of the operation. Possible values are: NotStarted, Running, Completed, Failed.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The current status of the operation. Possible values are: NotStarted, Running, Completed, Failed."""
         return self.properties.get("status", None)

office365/onedrive/workbooks/tables/pivot_table.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -6,27 +8,25 @@ from office365.runtime.queries.service_operation import ServiceOperationQuery
 class WorkbookPivotTable(Entity):
     """Represents an Excel PivotTable."""
 
+    def __str__(self):
+        return self.name or self.entity_type_name
+
     def refresh(self):
-        """
-        Refreshes the PivotTable.
-        """
+        """Refreshes the PivotTable."""
         qry = ServiceOperationQuery(self, "refresh")
         self.context.add_query(qry)
         return self
 
     def refresh_all(self):
-        """
-        Refreshes the PivotTable within a given worksheet.
-        """
+        """Refreshes the PivotTable within a given worksheet."""
         qry = ServiceOperationQuery(self, "refreshAll")
         self.context.add_query(qry)
         return self
 
     @property
     def name(self):
-        """Name of the PivotTable.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Name of the PivotTable."""
         return self.properties.get("Name", None)
 
     @property

office365/onedrive/workbooks/tables/sort.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class WorkbookTableSort(Entity):
+    """Manages sorting operations on Table objects."""

office365/onedrive/workbooks/tables/table.py

@@ -8,6 +8,7 @@ from office365.onedrive.workbooks.tables.columns.collection import (
 from office365.onedrive.workbooks.tables.rows.collection import (
     WorkbookTableRowCollection,
 )
+from office365.onedrive.workbooks.tables.sort import WorkbookTableSort
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.function import FunctionQuery
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -56,12 +57,59 @@ class WorkbookTable(Entity):
         self.context.add_query(qry)
         return self
 
+    @property
+    def highlight_first_column(self):
+        # type: () -> Optional[bool]
+        """Indicates whether the first column contains special formatting."""
+        return self.properties.get("highlightFirstColumn", None)
+
+    @property
+    def highlight_last_column(self):
+        # type: () -> Optional[bool]
+        """Indicates whether the last column contains special formatting."""
+        return self.properties.get("highlightLastColumn", None)
+
+    @property
+    def legacy_id(self):
+        # type: () -> Optional[str]
+        """Legacy Id used in older Excel clients. The value of the identifier remains the same even when the table
+        is renamed. This property should be interpreted as an opaque string value and shouldn't be parsed to any
+        other type."""
+        return self.properties.get("legacyId", None)
+
     @property
     def name(self):
         # type: () -> Optional[str]
         """Name of the table."""
         return self.properties.get("name", None)
 
+    @property
+    def show_banded_columns(self):
+        # type: () -> Optional[bool]
+        """Indicates whether the columns show banded formatting in which odd columns are highlighted differently
+        from even ones to make reading the table easier."""
+        return self.properties.get("showBandedColumns", None)
+
+    @property
+    def show_banded_rows(self):
+        # type: () -> Optional[bool]
+        """Indicates whether the rows show banded formatting in which odd rows are highlighted differently from even
+        ones to make reading the table easier."""
+        return self.properties.get("showBandedRows", None)
+
+    @property
+    def show_filter_button(self):
+        # type: () -> Optional[bool]
+        """Indicates whether the filter buttons are visible at the top of each column header. Setting this is only
+        allowed if the table contains a header row."""
+        return self.properties.get("showFilterButton", None)
+
+    @property
+    def show_headers(self):
+        # type: () -> Optional[bool]
+        """Indicates whether the header row is visible or not. This value can be set to show or remove the header row"""
+        return self.properties.get("showHeaders", None)
+
     @property
     def columns(self):
         # type: () -> WorkbookTableColumnCollection
@@ -84,6 +132,15 @@ class WorkbookTable(Entity):
             ),
         )
 
+    @property
+    def sort(self):
+        # type: () -> WorkbookTableSort
+        """Represents the sorting for the table."""
+        return self.properties.get(
+            "sort",
+            WorkbookTableSort(self.context, ResourcePath("sort", self.resource_path)),
+        )
+
     @property
     def worksheet(self):
         """The worksheet containing the current table."""

office365/onedrive/workbooks/worksheets/collection.py

@@ -9,12 +9,6 @@ class WorkbookWorksheetCollection(EntityCollection[WorkbookWorksheet]):
             context, WorkbookWorksheet, resource_path
         )
 
-    def __getitem__(self, id_or_name):
-        """
-        :rtype: WorkbookWorksheet
-        """
-        return super(WorkbookWorksheetCollection, self).__getitem__(id_or_name)
-
     def add(self, name=None):
         """
         Adds a new worksheet to the workbook. The worksheet will be added at the end of existing worksheets.

office365/onedrive/workbooks/worksheets/protection.py

@@ -1,5 +1,26 @@
 from office365.entity import Entity
+from office365.onedrive.workbooks.worksheets.protection_options import (
+    WorkbookWorksheetProtectionOptions,
+)
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 
 
 class WorkbookWorksheetProtection(Entity):
-    pass
+    """Represents the protection of a sheet object."""
+
+    def protect(self, options=None):
+        """Protect a worksheet. It throws if the worksheet has been protected."""
+        qry = ServiceOperationQuery(self, "protect", parameters_type=options)
+        self.context.add_query(qry)
+        return self
+
+    def unprotect(self):
+        """Unprotect a worksheet"""
+        qry = ServiceOperationQuery(self, "unprotect")
+        self.context.add_query(qry)
+        return self
+
+    @property
+    def options(self):
+        """ """
+        return self.properties.get("options", WorkbookWorksheetProtectionOptions())

office365/onedrive/workbooks/worksheets/protection_options.py

@@ -3,3 +3,10 @@ from office365.runtime.client_value import ClientValue
 
 class WorkbookWorksheetProtectionOptions(ClientValue):
     """Represents the protection of a sheet object."""
+
+    def __init__(
+        self, allowAutoFilter=None, allowDeleteColumns=None, allowDeleteRows=None
+    ):
+        self.allowAutoFilter = allowAutoFilter
+        self.allowDeleteColumns = allowDeleteColumns
+        self.allowDeleteRows = allowDeleteRows

office365/outlook/calendar/calendar.py

@@ -135,9 +135,7 @@ class Calendar(Entity):
     @property
     def name(self):
         # type: () -> Optional[str]
-        """
-        The calendar name
-        """
+        """The calendar name"""
         return self.properties.get("name", None)
 
     @property

office365/outlook/calendar/events/event.py

@@ -8,6 +8,7 @@ from office365.directory.extensions.extension import Extension
 from office365.entity_collection import EntityCollection
 from office365.outlook.calendar.attendees.attendee import Attendee
 from office365.outlook.calendar.dateTimeTimeZone import DateTimeTimeZone
+from office365.outlook.calendar.response_status import ResponseStatus
 from office365.outlook.item import OutlookItem
 from office365.outlook.mail.attachments.collection import AttachmentCollection
 from office365.outlook.mail.item_body import ItemBody
@@ -195,6 +196,30 @@ class Event(OutlookItem):
         """The preview of the message associated with the event. It is in text format."""
         return self.properties.get("bodyPreview", None)
 
+    @property
+    def reminder_minutes_before_start(self):
+        # type: () -> Optional[int]
+        """The number of minutes before the event start time that the reminder alert occurs."""
+        return self.properties.get("reminderMinutesBeforeStart", None)
+
+    @property
+    def response_requested(self):
+        # type: () -> Optional[bool]
+        """Default is true, which represents the organizer would like an invitee to send a response to the event."""
+        return self.properties.get("responseRequested", None)
+
+    @property
+    def response_status(self):
+        # type: () -> Optional[str]
+        """Indicates the type of response sent in response to an event message."""
+        return self.properties.get("responseStatus", ResponseStatus())
+
+    @property
+    def series_master_id(self):
+        # type: () -> Optional[str]
+        """The ID for the recurring series master item, if this event is part of a recurring series."""
+        return self.properties.get("seriesMasterId", None)
+
     @property
     def subject(self):
         # type: () -> Optional[str]
@@ -212,6 +237,26 @@ class Event(OutlookItem):
         """The location of the event."""
         return self.properties.get("location", Location())
 
+    @property
+    def transaction_id(self):
+        # type: () -> Optional[str]
+        """
+        A custom identifier specified by a client app for the server to avoid redundant POST operations in case of
+        client retries to create the same event. This is useful when low network connectivity causes the client to
+        time out before receiving a response from the server for the client's prior create-event request.
+        After you set transactionId when creating an event, you cannot change transactionId in a subsequent update.
+        This property is only returned in a response payload if an app has set it
+        """
+        return self.properties.get("transactionId", None)
+
+    @property
+    def type(self):
+        # type: () -> Optional[str]
+        """
+        The event type. Possible values are: singleInstance, occurrence, exception, seriesMaster
+        """
+        return self.properties.get("type", None)
+
     @property
     def web_link(self):
         # type: () -> Optional[str]

office365/outlook/calendar/permissions/permission.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.outlook.calendar.email_address import EmailAddress
 from office365.runtime.types.collections import StringCollection
@@ -37,28 +39,26 @@ class CalendarPermission(Entity):
 
     @property
     def is_inside_organization(self):
+        # type: () -> Optional[bool]
         """
-        True if the user in context (sharee or delegate) is inside the same organization as the calendar owner.
-        :rtype: bool or None
+        True if the user in context (sharee or delegate) is inside the same organization as the calendar owner
         """
         return self.properties.get("isInsideOrganization", None)
 
     @property
     def is_removable(self):
+        # type: () -> Optional[bool]
         """
         True if the user can be removed from the list of sharees or delegates for the specified calendar,
         false otherwise. The "My organization" user determines the permissions other people within your organization
         have to the given calendar. You cannot remove "My organization" as a sharee to a calendar.
-        :rtype: bool or None
         """
         return self.properties.get("isRemovable", None)
 
     @property
     def role(self):
-        """
-        Current permission level of the calendar sharee or delegate.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Current permission level of the calendar sharee or delegate."""
         return self.properties.get("role", None)
 
     def get_property(self, name, default_value=None):

office365/outlook/calendar/place.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.outlook.mail.physical_address import PhysicalAddress
 
@@ -8,9 +10,8 @@ class Place(Entity):
 
     @property
     def display_name(self):
-        """The name associated with the place.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The name associated with the place."""
         return self.properties.get("displayName", None)
 
     @property
@@ -20,5 +21,6 @@ class Place(Entity):
 
     @property
     def phone(self):
+        # type: () -> Optional[str]
         """The phone number of the place."""
         return self.properties.get("phone", None)

office365/outlook/calendar/response_status.py

@@ -0,0 +1,11 @@
+from office365.runtime.client_value import ClientValue
+
+
+class ResponseStatus(ClientValue):
+    """Represents the response status of an attendee or organizer for a meeting request."""
+
+    def __init__(self, response=None):
+        """
+        :type response: str
+        """
+        self.response = response

office365/outlook/calendar/rooms/room.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.outlook.calendar.place import Place
 
 
@@ -6,3 +8,15 @@ class Room(Place):
     Represents a room in a tenant.
     In Exchange Online, each room is associated with a room mailbox. Derived from place.
     """
+
+    @property
+    def audio_device_name(self):
+        # type: () -> Optional[str]
+        """Specifies the name of the audio device in the room."""
+        return self.properties.get("audioDeviceName", None)
+
+    @property
+    def building(self):
+        # type: () -> Optional[str]
+        """Specifies the building name or building number that the room is in."""
+        return self.properties.get("building", None)

office365/outlook/mail/attachments/collection.py

@@ -4,7 +4,10 @@ import requests
 
 from office365.entity_collection import EntityCollection
 from office365.outlook.mail.attachments.attachment import Attachment
+from office365.runtime.client_result import ClientResult
 from office365.runtime.compat import parse_query_string
+from office365.runtime.http.request_options import RequestOptions
+from office365.runtime.odata.v4.upload_session import UploadSession
 from office365.runtime.odata.v4.upload_session_request import UploadSessionRequest
 from office365.runtime.queries.upload_session import UploadSessionQuery
 
@@ -60,13 +63,15 @@ class AttachmentCollection(EntityCollection[Attachment]):
             self, {"AttachmentItem": AttachmentItem.create_file(source_path)}
         )
 
-        def _start_upload():
+        def _start_upload(result):
+            # type: (ClientResult[UploadSession]) -> None
             with open(source_path, "rb") as local_file:
                 session_request = UploadSessionRequest(
                     local_file, chunk_size, chunk_uploaded
                 )
 
                 def _construct_request(request):
+                    # type: (RequestOptions) -> None
                     auth_token = parse_query_string(request.url, "authtoken")
                     request.set_header("Authorization", "Bearer {0}".format(auth_token))
 

office365/outlook/mail/automatic_replies_mailtips.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class AutomaticRepliesMailTips(ClientValue):
+    """MailTips about any automatic replies that have been set up on a mailbox."""

office365/outlook/mail/conversation.py

@@ -49,9 +49,7 @@ class Conversation(Entity):
 
     @property
     def unique_senders(self):
-        """
-        All the users that sent a message to this Conversation.
-        """
+        """All the users that sent a message to this Conversation."""
         return self.properties.get("uniqueSenders", StringCollection())
 
     @property

office365/outlook/mail/folders/folder.py

@@ -86,9 +86,7 @@ class MailFolder(Entity):
     @property
     def parent_folder_id(self):
         # type: () -> Optional[str]
-        """
-        The unique identifier for the mailFolder's parent mailFolder.
-        """
+        """The unique identifier for the mailFolder's parent mailFolder."""
         return self.properties.get("parentFolderId", None)
 
     @property

office365/outlook/mail/messages/message.py

@@ -103,7 +103,7 @@ class Message(OutlookItem):
         if a file that's smaller than 3 MB, then add_file_attachment method is utilized
 
         :param str file_path:
-        :param ()->None chunk_uploaded: Upload action
+        :param (int)->None chunk_uploaded: Upload action
         """
         max_upload_chunk = 1000000 * 3
         file_size = os.stat(file_path).st_size

office365/outlook/mail/tips.py

@@ -0,0 +1,17 @@
+from office365.outlook.mail.automatic_replies_mailtips import AutomaticRepliesMailTips
+from office365.runtime.client_value import ClientValue
+
+
+class MailTips(ClientValue):
+    """Informative messages about a recipient, that are displayed to users while they're composing a message.
+    For example, an out-of-office message as an automatic reply for a message recipient.
+    """
+
+    def __init__(self, automaticReplies=AutomaticRepliesMailTips(), customMailTip=None):
+        """
+        :param AutomaticRepliesMailTips automaticReplies: Mail tips for automatic reply if it has been set up by
+            the recipient.
+        :param str customMailTip: A custom mail tip that can be set on the recipient's mailbox.
+        """
+        self.automaticReplies = automaticReplies
+        self.customMailTip = customMailTip