Office365-REST-Python-Client 2.5.4__py3-none-any.whl → 2.5.6__py3-none-any.whl

office365/onedrive/operations/long_running.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 
 
@@ -6,14 +8,12 @@ class LongRunningOperation(Entity):
 
     @property
     def resource_location(self):
-        """URI of the resource that the operation is performed on.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """URI of the resource that the operation is performed on."""
         return self.properties.get("resourceLocation", None)
 
     @property
     def status_detail(self):
-        """Details about the status of the operation.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Details about the status of the operation."""
         return self.properties.get("statusDetail", None)

office365/onedrive/operations/rich_long_running.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.onedrive.operations.long_running import LongRunningOperation
 
 
@@ -6,7 +8,6 @@ class RichLongRunningOperation(LongRunningOperation):
 
     @property
     def resource_id(self):
-        """The unique identifier for the result.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The unique identifier for the result."""
         return self.properties.get("resourceId", None)

office365/onedrive/permissions/collection.py

@@ -69,19 +69,6 @@ class PermissionCollection(EntityCollection[Permission]):
         identity.ensure_properties(["displayName"], _add)
         return return_type
 
-    def delete(self, roles, identity):
-        # type: (list[str], Application|User|Group|Device) -> Permission
-        """Deletes the permission."""
-
-        def _delete(col):
-            pass
-
-        def _identity_loaded():
-            self.get_all(page_loaded=_delete)
-
-        identity.ensure_property("id", _identity_loaded)
-        return self
-
     def delete_all(self):
         """Remove all access to resource"""
 
@@ -90,5 +77,5 @@ class PermissionCollection(EntityCollection[Permission]):
             for permission in return_type:
                 permission.delete_object()
 
-        self.context.load(self, after_loaded=_after_loaded)
+        self.get().after_execute(_after_loaded)
         return self

office365/onedrive/sharepoint_settings.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.runtime.types.collections import StringCollection
 
@@ -26,26 +28,24 @@ class SharepointSettings(Entity):
 
     @property
     def site_creation_default_managed_path(self):
+        # type: () -> Optional[str]
         """
         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
-        """
+        # type: () -> Optional[int]
+        """The default storage quota for a new site upon creation. Measured in megabytes (MB)."""
         return self.properties.get("siteCreationDefaultStorageLimitInMB", None)
 
     @property
     def tenant_default_timezone(self):
+        # type: () -> Optional[str]
         """
         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)
 

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/comments/comment.py

@@ -1,3 +1,5 @@
+from typing import AnyStr, Optional
+
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.onedrive.workbooks.comments.reply import WorkbookCommentReply
@@ -9,20 +11,19 @@ class WorkbookComment(Entity):
 
     @property
     def content(self):
-        """The content of comment.
-        :rtype: str or None
-        """
+        # type: () -> Optional[AnyStr]
+        """The content of comment."""
         return self.properties.get("content", None)
 
     @property
     def content_type(self):
-        """Indicates the type for the comment.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Indicates the type for the comment."""
         return self.properties.get("contentType", None)
 
     @property
     def replies(self):
+        # type: () -> EntityCollection[WorkbookCommentReply]
         """"""
         return self.properties.get(
             "replies",

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/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

@@ -2,4 +2,6 @@ from office365.entity import Entity
 
 
 class WorkbookWorksheetProtection(Entity):
+    """Represents the protection of a sheet object."""
+
     pass

office365/onedrive/workbooks/worksheets/worksheet.py

@@ -4,12 +4,14 @@ from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.onedrive.workbooks.charts.chart import WorkbookChart
 from office365.onedrive.workbooks.names.named_item import WorkbookNamedItem
+from office365.onedrive.workbooks.ranges.range import WorkbookRange
 from office365.onedrive.workbooks.tables.collection import WorkbookTableCollection
 from office365.onedrive.workbooks.tables.pivot_table import WorkbookPivotTable
 from office365.onedrive.workbooks.worksheets.protection import (
     WorkbookWorksheetProtection,
 )
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.function import FunctionQuery
 
 
 class WorkbookWorksheet(Entity):
@@ -18,10 +20,36 @@ class WorkbookWorksheet(Entity):
     """
 
     def __repr__(self):
-        return self.name
+        return self.name or self.entity_type_name
 
     def __str__(self):
-        return self.name
+        return self.name or self.entity_type_name
+
+    def cell(self, row, column):
+        """Gets the range object containing the single cell based on row and column numbers.
+        The cell can be outside the bounds of its parent range, so long as it's stays within the worksheet grid.
+        :param int row: Row number of the cell to be retrieved. Zero-indexed.
+        :param int column: Column number of the cell to be retrieved. Zero-indexed.
+        """
+        return_type = WorkbookRange(
+            self.context, ResourcePath("range", self.resource_path)
+        )
+        params = {"row": row, "column": column}
+        qry = FunctionQuery(self, "cell", method_params=params, return_type=return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def range(self, address=None):
+        """Gets the range object specified by the address or name."""
+        return_type = WorkbookRange(
+            self.context, ResourcePath("range", self.resource_path)
+        )
+        params = {"address": address}
+        qry = FunctionQuery(
+            self, "range", method_params=params, return_type=return_type
+        )
+        self.context.add_query(qry)
+        return return_type
 
     @property
     def charts(self):

office365/onenote/notebooks/collection.py

@@ -18,7 +18,6 @@ class NotebookCollection(EntityCollection[Notebook]):
 
         :param str display_name: Name for the notebook. Notebook names must be unique. The name cannot contain more
             than 128 characters or contain the following characters: ?*/:<>|'"
-        :rtype: Notebook
         """
         return super(NotebookCollection, self).add(displayName=display_name)
 

office365/outlook/calendar/events/event.py

@@ -1,6 +1,5 @@
 from typing import Optional
 
-from office365.delta_collection import DeltaCollection
 from office365.directory.extensions.extended_property import (
     MultiValueLegacyExtendedProperty,
     SingleValueLegacyExtendedProperty,
@@ -9,7 +8,6 @@ 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.email_address import EmailAddress
 from office365.outlook.item import OutlookItem
 from office365.outlook.mail.attachments.collection import AttachmentCollection
 from office365.outlook.mail.item_body import ItemBody
@@ -74,70 +72,62 @@ class Event(OutlookItem):
         return self
 
     def dismiss_reminder(self):
-        """
-        Dismiss a reminder that has been triggered for an event in a user calendar.
-        """
+        """Dismiss a reminder that has been triggered for an event in a user calendar."""
         qry = ServiceOperationQuery(self, "dismissReminder")
         self.context.add_query(qry)
         return self
 
     @property
     def allow_new_time_proposals(self):
+        # type: () -> Optional[bool]
         """
         true if the meeting organizer allows invitees to propose a new time when responding; otherwise, false.
         Optional. Default is true.
-        :rtype: bool or None
         """
         return self.properties.get("allowNewTimeProposals", None)
 
     @property
     def has_attachments(self):
-        """
-        Set to true if the event has attachments.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Set to true if the event has attachments."""
         return self.properties.get("hasAttachments", None)
 
     @property
     def hide_attendees(self):
+        # type: () -> Optional[bool]
         """
         When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list.
         Default is false.
-        :rtype: bool or None
         """
         return self.properties.get("hideAttendees", None)
 
     @property
     def ical_uid(self):
+        # type: () -> Optional[str]
         """
         A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring
-        series. Read-only.
-        :rtype: str or None
+        series.
         """
         return self.properties.get("iCalUId", None)
 
     @property
     def importance(self):
-        """
-        The importance of the event. The possible values are: low, normal, high.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """The importance of the event. The possible values are: low, normal, high."""
         return self.properties.get("importance", None)
 
     @property
     def is_all_day(self):
+        # type: () -> Optional[bool]
         """
         Set to true if the event lasts all day. If true, regardless of whether it's a single-day or multi-day event,
         start and end time must be set to midnight and be in the same time zone.
-        :rtype: bool or None
         """
         return self.properties.get("isAllDay", None)
 
     @property
     def start(self):
-        """
-        The date, time, and time zone that the event starts. By default, the start time is in UTC.
-        """
+        """The date, time, and time zone that the event starts. By default, the start time is in UTC."""
         return self.properties.get("start", DateTimeTimeZone())
 
     @start.setter
@@ -151,9 +141,7 @@ class Event(OutlookItem):
 
     @property
     def end(self):
-        """
-        The date, time, and time zone that the event starts. By default, the start time is in UTC.
-        """
+        """The date, time, and time zone that the event starts. By default, the start time is in UTC."""
         return self.properties.get("end", DateTimeTimeZone())
 
     @end.setter
@@ -167,6 +155,7 @@ class Event(OutlookItem):
 
     @property
     def single_value_extended_properties(self):
+        # type: () -> EntityCollection[SingleValueLegacyExtendedProperty]
         """The collection of single-value extended properties defined for the event."""
         return self.properties.get(
             "singleValueExtendedProperties",
@@ -179,6 +168,7 @@ class Event(OutlookItem):
 
     @property
     def multi_value_extended_properties(self):
+        # type: () -> EntityCollection[MultiValueLegacyExtendedProperty]
         """The collection of multi-value extended properties defined for the event."""
         return self.properties.get(
             "multiValueExtendedProperties",
@@ -191,51 +181,40 @@ class Event(OutlookItem):
 
     @property
     def body(self):
-        """
-        The body of the message associated with the event. It can be in HTML or text format.
-        """
+        """The body of the message associated with the event. It can be in HTML or text format."""
         return self.properties.get("body", ItemBody())
 
     @body.setter
     def body(self, value):
-        """
-        Sets The body of the message associated with the event. It can be in HTML or text format.
-        """
+        """Sets The body of the message associated with the event. It can be in HTML or text format."""
         self.set_property("body", ItemBody(value, "HTML"))
 
     @property
     def body_preview(self):
-        """
-        The preview of the message associated with the event. It is in text format.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The preview of the message associated with the event. It is in text format."""
         return self.properties.get("bodyPreview", None)
 
     @property
     def subject(self):
         # type: () -> Optional[str]
-        """
-        The text of the event's subject line.
-        """
+        """The text of the event's subject line."""
         return self.properties.get("subject", None)
 
     @subject.setter
     def subject(self, value):
-        """
-        Sets The text of the event's subject line.
-        :type: str or None
-        """
+        # type: (str) -> None
+        """Sets The text of the event's subject line."""
         self.set_property("subject", value)
 
     @property
     def location(self):
-        """
-        The location of the event.
-        """
+        """The location of the event."""
         return self.properties.get("location", Location())
 
     @property
     def web_link(self):
+        # type: () -> Optional[str]
         """
         The URL to open the event in Outlook on the web.
 
@@ -243,8 +222,6 @@ class Event(OutlookItem):
         on the web prompts you to sign in.
 
         This URL cannot be accessed from within an iFrame.
-
-        :rtype: str or None
         """
         return self.properties.get("webLink", None)
 
@@ -275,6 +252,7 @@ class Event(OutlookItem):
 
     @property
     def extensions(self):
+        # type: () -> EntityCollection[Extension]
         """The collection of open extensions defined for the event. Nullable."""
         return self.properties.get(
             "extensions",

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):