workbook namespace new types

Author: vgrem

examples/onedrive/files/get_permissions.py

@@ -13,4 +13,5 @@
 file_path = "Archive/Financial Sample.xlsx"
 file_item = client.me.drive.root.get_by_path(file_path)
 permissions = file_item.permissions.get().execute_query()
-print(permissions)
+for perm in permissions:
+   print(perm.granted_to_v2)

generator/metadata/SharePoint.xml

@@ -1,5 +1,17 @@
 from office365.entity import Entity
+from office365.onedrive.workbooks.charts.title_format import WorkbookChartTitleFormat
+from office365.runtime.paths.resource_path import ResourcePath
 
 
 class WorkbookChartTitle(Entity):
     """Represents a chart title object of a chart."""
+
+    @property
+    def format(self):
+        """	The formatting of a chart title, which includes fill and font formatting."""
+        return self.properties.get(
+            "format",
+            WorkbookChartTitleFormat(
+                self.context, ResourcePath("format", self.resource_path)
+            ),
+        )

office365/onedrive/workbooks/charts/title.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class WorkbookChartTitleFormat(Entity):
+    """Represents a chart title object of a chart."""

office365/onedrive/workbooks/charts/title_format.py

@@ -1,5 +1,35 @@
+from typing import Optional
+
 from office365.entity import Entity
 
 
 class WorkbookRangeBorder(Entity):
     """Represents the border of an object."""
+
+    @property
+    def color(self):
+        # type: () -> Optional[str]
+        """The HTML color code that represents the color of the border line. Can either be of the form #RRGGBB,
+        for example "FFA500", or a named HTML color, for example orange."""
+        return self.properties.get("color", None)
+
+    @property
+    def side_index(self):
+        # type: () -> Optional[str]
+        """Indicates the specific side of the border.
+        The possible values are: EdgeTop, EdgeBottom, EdgeLeft, EdgeRight, InsideVertical, InsideHorizontal,
+        DiagonalDown, DiagonalUp. Read-only."""
+        return self.properties.get("sideIndex", None)
+
+    @property
+    def style(self):
+        # type: () -> Optional[str]
+        """Indicates the line style for the border. The possible values are: None, Continuous, Dash, DashDot,
+        DashDotDot, Dot, Double, SlantDashDot."""
+        return self.properties.get("style", None)
+
+    @property
+    def weight(self):
+        # type: () -> Optional[str]
+        """The weight of the border around a range. The possible values are: Hairline, Thin, Medium, Thick."""
+        return self.properties.get("weight", None)

office365/onedrive/workbooks/ranges/border.py

@@ -120,6 +120,12 @@ def column_index(self):
         """Represents the column number of the first cell in the range. Zero-indexed. Read-only."""
         return self.properties.get("columnIndex", None)
 
+    @property
+    def row_index(self):
+        # type: () -> Optional[int]
+        """Returns the row number of the first cell in the range. Zero-indexed. Read-only."""
+        return self.properties.get("rowIndex", None)
+
     @property
     def format(self):
         """Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties"""

office365/onedrive/workbooks/ranges/range.py

@@ -5,11 +5,40 @@ class WorkbookWorksheetProtectionOptions(ClientValue):
     """Represents the protection of a sheet object."""
 
     def __init__(
-        self, allowAutoFilter=None, allowDeleteColumns=None, allowDeleteRows=None
+        self,
+        allow_auto_filter=None,
+        allow_delete_columns=None,
+        allow_delete_rows=None,
+        allow_format_cells=None,
+        allow_format_columns=None,
+        allow_format_rows=None,
+        allow_insert_columns=None,
+        allow_insert_hyperlinks=None,
+        allow_insert_rows=None,
+        allow_pivot_tables=None,
+        allow_sort=None,
     ):
         """
-        :param bool allowAutoFilter:
+        :param bool allow_auto_filter: Represents the worksheet protection option of allowing using auto filter feature.
+        :param bool allow_delete_columns: Represents the worksheet protection option of allowing deleting columns.
+        :param bool allow_delete_rows: Represents the worksheet protection option of allowing deleting rows.
+        :param bool allow_format_cells: Represents the worksheet protection option of allowing formatting cells.
+        :param bool allow_format_columns: Represents the worksheet protection option of allowing formatting columns.
+        :param bool allow_format_rows: Represents the worksheet protection option of allowing formatting rows.
+        :param bool allow_insert_columns: Represents the worksheet protection option of allowing inserting columns.
+        :param bool allow_insert_hyperlinks: Represents the worksheet protection option of allowing inserting hyperlinks.
+        :param bool allow_insert_rows: Represents the worksheet protection option of allowing inserting rows.
+        :param bool allow_pivot_tables: Represents the worksheet protection option of allowing using pivot table feature.
+        :param bool allow_sort: Represents the worksheet protection option of allowing sorting.
         """
-        self.allowAutoFilter = allowAutoFilter
-        self.allowDeleteColumns = allowDeleteColumns
-        self.allowDeleteRows = allowDeleteRows
+        self.allowAutoFilter = allow_auto_filter
+        self.allowDeleteColumns = allow_delete_columns
+        self.allowDeleteRows = allow_delete_rows
+        self.allowFormatCells = allow_format_cells
+        self.allowFormatColumns = allow_format_columns
+        self.allowFormatRows = allow_format_rows
+        self.allowInsertColumns = allow_insert_columns
+        self.allowInsertHyperlinks = allow_insert_hyperlinks
+        self.allowInsertRows = allow_insert_rows
+        self.allowPivotTables = allow_pivot_tables
+        self.allowSort = allow_sort

office365/onedrive/workbooks/worksheets/protection_options.py

@@ -78,6 +78,16 @@ def dismiss_reminder(self):
         self.context.add_query(qry)
         return self
 
+    def permanent_delete(self):
+        """
+        Permanently delete an event and place it in the purges folder in the dumpster in the user's mailbox.
+        Email clients such as outlook or outlook on the web can't access permanently deleted items.
+        Unless there's a hold set on the mailbox, the items are permanently deleted after a set period of time.
+        """
+        qry = ServiceOperationQuery(self, "permanentDelete")
+        self.context.add_query(qry)
+        return self
+
     @property
     def allow_new_time_proposals(self):
         # type: () -> Optional[bool]
@@ -126,6 +136,53 @@ def is_all_day(self):
         """
         return self.properties.get("isAllDay", None)
 
+    @property
+    def is_cancelled(self):
+        # type: () -> Optional[bool]
+        """
+        Set to true if the event has been canceled.
+        """
+        return self.properties.get("isCancelled", None)
+
+    @property
+    def is_draft(self):
+        # type: () -> Optional[bool]
+        """
+        Set to true if the user has updated the meeting in Outlook but hasn't sent the updates to attendees.
+        Set to false if all changes are sent, or if the event is an appointment without any attendees.
+        """
+        return self.properties.get("isDraft", None)
+
+    @property
+    def is_online_meeting(self):
+        # type: () -> Optional[bool]
+        """
+        True if this event has online meeting information
+        (that is, onlineMeeting points to an onlineMeetingInfo resource), false otherwise.
+        Default is false (onlineMeeting is null). Optional.
+        After you set isOnlineMeeting to true, Microsoft Graph initializes onlineMeeting.
+        Subsequently, Outlook ignores any further changes to isOnlineMeeting, and the meeting remains available online.
+        """
+        return self.properties.get("isOnlineMeeting", None)
+
+    @property
+    def is_organizer(self):
+        # type: () -> Optional[bool]
+        """
+        Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of
+        the event (specified by the organizer property of the event). It also applies if a delegate organized the
+        event on behalf of the owner.
+        """
+        return self.properties.get("isOrganizer", None)
+
+    @property
+    def is_reminder_on(self):
+        # type: () -> Optional[bool]
+        """
+        Set to true if an alert is set to remind the user of the event.
+        """
+        return self.properties.get("isReminderOn", None)
+
     @property
     def start(self):
         """The date, time, and time zone that the event starts. By default, the start time is in UTC."""

office365/outlook/calendar/events/event.py

@@ -4,10 +4,9 @@
 class ODataJsonFormat(object):
     """OData JSON format"""
 
-    def __init__(self, metadata_level=None, etag=None):
-        # type: (str, str) -> None
+    def __init__(self, metadata_level=None):
+        # type: (str) -> None
         self.metadata_level = metadata_level
-        self.etag = etag
 
     __metaclass__ = ABCMeta
 
@@ -23,6 +22,18 @@ def collection(self):
     def collection_next(self):
         raise NotImplementedError
 
+    @property
+    def collection_delta(self):
+        raise NotImplementedError
+
+    @property
+    def etag(self):
+        raise NotImplementedError
+
+    @property
+    def value_tag(self):
+        raise NotImplementedError
+
     @property
     def media_type(self):
         # type: () -> str

office365/runtime/odata/json_format.py

@@ -155,5 +155,3 @@ def _ensure_http_headers(self, request):
         media_type = self.json_format.media_type
         request.ensure_header("Content-Type", media_type)
         request.ensure_header("Accept", media_type)
-        if self.json_format.etag is not None:
-            request.ensure_header("If-Match", self.json_format.etag)

office365/runtime/odata/request.py

@@ -25,10 +25,24 @@ def collection_next(self):
         """Property name for a reference to the next page of results"""
         return "__next"
 
+    @property
+    def collection_delta(self):
+        """Property name for a reference to the next page of results"""
+        return "__delta"
+
     @property
     def metadata_type(self):
         return "__metadata"
 
+    @property
+    def value_tag(self):
+        return "__value"
+
+    @property
+    def etag(self):
+        """The entity tag that represents the version of the object."""
+        return "__etag"
+
     @property
     def media_type(self):
         return "application/json;odata={0}".format(self.metadata_level)

office365/runtime/odata/v3/json_light_format.py

@@ -14,16 +14,35 @@ def __init__(self, metadata_level=ODataV4MetadataLevel.Minimal):
 
     @property
     def metadata_type(self):
+        """The OData entity type in Microsoft Graph that describes the represented object."""
         return "@odata.type"
 
+    @property
+    def value_tag(self):
+        """The OData entity type in Microsoft Graph that describes the represented object."""
+        return "@odata.value"
+
     @property
     def collection(self):
         return "value"
 
     @property
     def collection_next(self):
+        """
+        Property name for a reference to the next page of results
+        """
         return "@odata.nextLink"
 
+    @property
+    def collection_delta(self):
+        """ """
+        return "@odata.deltaLink"
+
+    @property
+    def etag(self):
+        """The entity tag that represents the version of the object."""
+        return "@odata.etag"
+
     @property
     def media_type(self):
         return "application/json;odata.metadata={0};odata.streaming={1};IEEE754Compatible={2}".format(

office365/runtime/odata/v4/json_format.py

@@ -49,6 +49,6 @@ def test7_list_changes(self):
         result = self.client.me.drive.root.delta.get().execute_query()
         self.assertIsNotNone(result.resource_path)
 
-    #def test8_get_delta_link(self):
+    # def test8_get_delta_link(self):
     #    result = self.client.me.drive.root.delta.token("latest").get().execute_query()
     #    self.assertIsNotNone(result.resource_path)

tests/onedrive/test_drive.py

@@ -41,7 +41,7 @@ def test3_used_range(self):
 
     def test4_protect_worksheet(self):
         ws = self.__class__.worksheet
-        options = WorkbookWorksheetProtectionOptions(allowDeleteRows=False)
+        options = WorkbookWorksheetProtectionOptions(allow_delete_rows=False)
         ws.protection.protect(options).execute_query()
         result = ws.protection.get().execute_query()
         self.assertFalse(result.options.allowDeleteRows)