Office365-REST-Python-Client 2.6.2__py3-none-any.whl → 3.0.0__py3-none-any.whl

office365/onedrive/workbooks/worksheets/collection.py

@@ -1,21 +1,25 @@
+from __future__ import annotations
+
+from office365.directory.permissions.require_permission import require_permission
 from office365.entity_collection import EntityCollection
 from office365.onedrive.workbooks.worksheets.worksheet import WorkbookWorksheet
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 
 
 class WorkbookWorksheetCollection(EntityCollection[WorkbookWorksheet]):
+    """ """
+
     def __init__(self, context, resource_path=None):
-        super(WorkbookWorksheetCollection, self).__init__(
-            context, WorkbookWorksheet, resource_path
-        )
+        super().__init__(context, WorkbookWorksheet, resource_path)
 
-    def add(self, name=None):
-        """
-        Adds a new worksheet to the workbook. The worksheet will be added at the end of existing worksheets.
+    @require_permission(delegated=["Files.ReadWrite"], application=["Files.ReadWrite"])
+    def add(self, name: str | None = None) -> WorkbookWorksheet:
+        """Adds a new worksheet to the workbook. The worksheet will be added at the end of existing worksheets.
         If you wish to activate the newly added worksheet, call ".activate() on it.
 
-        :param str name: The name of the worksheet to be added. If specified, name should be unique.
-            If not specified, Excel determines the name of the new worksheet.
+        Args:
+            name (str): The name of the worksheet to be added. If specified, name should be unique. If not specified,
+              Excel determines the name of the new worksheet.
         """
         return_type = WorkbookWorksheet(self.context)
         self.add_child(return_type)

office365/onedrive/workbooks/worksheets/protection.py

@@ -1,3 +1,7 @@
+from __future__ import annotations
+
+from typing_extensions import Self
+
 from office365.entity import Entity
 from office365.onedrive.workbooks.worksheets.protection_options import (
     WorkbookWorksheetProtectionOptions,
@@ -8,19 +12,19 @@ from office365.runtime.queries.service_operation import ServiceOperationQuery
 class WorkbookWorksheetProtection(Entity):
     """Represents the protection of a sheet object."""
 
-    def protect(self, options=None):
+    def protect(self, options: WorkbookWorksheetProtectionOptions | None = None) -> Self:
         """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):
+    def unprotect(self) -> Self:
         """Unprotect a worksheet"""
         qry = ServiceOperationQuery(self, "unprotect")
         self.context.add_query(qry)
         return self
 
     @property
-    def options(self):
+    def options(self) -> WorkbookWorksheetProtectionOptions:
         """ """
         return self.properties.get("options", WorkbookWorksheetProtectionOptions())

office365/onedrive/workbooks/worksheets/protection_options.py

@@ -1,44 +1,22 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
 from office365.runtime.client_value import ClientValue
 
 
+@dataclass
 class WorkbookWorksheetProtectionOptions(ClientValue):
     """Represents the protection of a sheet object."""
 
-    def __init__(
-        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 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 = 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
+    allowAutoFilter: bool | None = None
+    allowDeleteColumns: bool | None = None
+    allowDeleteRows: bool | None = None
+    allowFormatCells: bool | None = None
+    allowFormatColumns: bool | None = None
+    allowFormatRows: bool | None = None
+    allowInsertColumns: bool | None = None
+    allowInsertHyperlinks: bool | None = None
+    allowInsertRows: bool | None = None
+    allowPivotTables: bool | None = None
+    allowSort: bool | None = None

office365/onedrive/workbooks/worksheets/worksheet.py

@@ -1,5 +1,6 @@
 from typing import Optional
 
+from office365.directory.permissions.require_permission import require_permission
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.onedrive.workbooks.charts.chart import WorkbookChart
@@ -14,6 +15,7 @@ from office365.onedrive.workbooks.worksheets.protection import (
 )
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.function import FunctionQuery
+from office365.runtime.types.odata_property import odata
 
 
 class WorkbookWorksheet(Entity):
@@ -27,36 +29,36 @@ class WorkbookWorksheet(Entity):
     def __str__(self):
         return self.name or self.entity_type_name
 
-    def cell(self, row, column):
+    @require_permission(delegated=["Files.ReadWrite"], application=["Files.ReadWrite"])
+    def cell(self, row: int, column: int) -> WorkbookRange:
         """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.
+
+        Args:
+            row (int): Row number of the cell to be retrieved. Zero-indexed.
+            column (int): Column number of the cell to be retrieved. Zero-indexed.
         """
-        return_type = WorkbookRange(
-            self.context, ResourcePath("range", self.resource_path)
-        )
+        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
 
+    @require_permission(delegated=["Files.ReadWrite"], application=["Files.ReadWrite"])
     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)
-        )
+        return_type = WorkbookRange(self.context, ResourcePath("range", self.resource_path))
         params = {"address": address}
-        qry = FunctionQuery(
-            self, "range", method_params=params, return_type=return_type
-        )
+        qry = FunctionQuery(self, "range", method_params=params, return_type=return_type)
         self.context.add_query(qry)
         return return_type
 
-    def used_range(self, values_only=False):
+    @require_permission(delegated=["Files.ReadWrite"], application=["Files.ReadWrite"])
+    def used_range(self, values_only: bool = False) -> WorkbookRange:
         """Return the used range of the given range object.
 
-        :param bool values_only: Optional. Considers only cells with values as used cells.
+        Args:
+            values_only (bool): Optional. Considers only cells with values as used cells.
         """
         return_type = WorkbookRange(self.context)
         params = {"valuesOnly": values_only}
@@ -65,25 +67,20 @@ class WorkbookWorksheet(Entity):
         return return_type
 
     @property
-    def charts(self):
-        # type: () -> EntityCollection[WorkbookChart]
+    def charts(self) -> EntityCollection[WorkbookChart]:
         """Returns collection of charts that are part of the worksheet"""
         return self.properties.get(
             "charts",
-            EntityCollection(
-                self.context, WorkbookChart, ResourcePath("charts", self.resource_path)
-            ),
+            EntityCollection(self.context, WorkbookChart, ResourcePath("charts", self.resource_path)),
         )
 
     @property
-    def name(self):
-        # type: () -> Optional[str]
+    def name(self) -> Optional[str]:
         """The display name of the worksheet."""
         return self.properties.get("name", None)
 
     @property
-    def names(self):
-        # type: () -> EntityCollection[WorkbookNamedItem]
+    def names(self) -> EntityCollection[WorkbookNamedItem]:
         """Returns collection of names that are associated with the worksheet"""
         return self.properties.get(
             "names",
@@ -95,19 +92,16 @@ class WorkbookWorksheet(Entity):
         )
 
     @property
-    def tables(self):
-        # type: () -> WorkbookTableCollection
+    def tables(self) -> WorkbookTableCollection:
         """Collection of tables that are part of the worksheet."""
         return self.properties.get(
             "tables",
-            WorkbookTableCollection(
-                self.context, ResourcePath("tables", self.resource_path)
-            ),
+            WorkbookTableCollection(self.context, ResourcePath("tables", self.resource_path)),
         )
 
+    @odata(name="pivotTables")
     @property
-    def pivot_tables(self):
-        # type: () -> WorkbookPivotTableCollection
+    def pivot_tables(self) -> WorkbookPivotTableCollection:
         """Collection of PivotTables that are part of the worksheet."""
         return self.properties.get(
             "pivotTables",
@@ -118,20 +112,9 @@ class WorkbookWorksheet(Entity):
         )
 
     @property
-    def protection(self):
-        # type: () -> WorkbookWorksheetProtection
+    def protection(self) -> WorkbookWorksheetProtection:
         """Returns sheet protection object for a worksheet."""
         return self.properties.get(
             "protection",
-            WorkbookWorksheetProtection(
-                self.context, ResourcePath("protection", self.resource_path)
-            ),
+            WorkbookWorksheetProtection(self.context, ResourcePath("protection", self.resource_path)),
         )
-
-    def get_property(self, name, default_value=None):
-        if default_value is None:
-            property_mapping = {
-                "pivotTables": self.pivot_tables,
-            }
-            default_value = property_mapping.get(name, None)
-        return super(WorkbookWorksheet, self).get_property(name, default_value)

office365/onenote/diagnostic.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from office365.runtime.client_value import ClientValue
+
+
+@dataclass
+class Diagnostic(ClientValue):
+    message: str | None = None
+    url: str | None = None
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.Diagnostic"

office365/onenote/entity_base_model.py

@@ -1,7 +1,14 @@
 from office365.entity import Entity
+from office365.runtime.paths.builder import ODataPathBuilder
 
 
 class OnenoteEntityBaseModel(Entity):
     """This is the base type for OneNote entities."""
 
-    pass
+    def set_property(self, name, value, persist_changes=True):
+        super().set_property(name, value, persist_changes)
+        if name == "self" and self.resource_url != value:
+            # Fallback to canonical path
+            path_str = value.replace(self.context.service_root_url, "")
+            self._resource_path = ODataPathBuilder.parse_url(path_str)
+        return self

office365/onenote/entity_hierarchy_model.py

@@ -1,39 +1,33 @@
+from datetime import datetime
 from typing import Optional
 
 from office365.directory.permissions.identity_set import IdentitySet
 from office365.onenote.entity_schema_object_model import OnenoteEntitySchemaObjectModel
+from office365.runtime.types.odata_property import odata
 
 
 class OnenoteEntityHierarchyModel(OnenoteEntitySchemaObjectModel):
+    """ """
+
     @property
-    def display_name(self):
-        # type: () -> Optional[str]
+    def display_name(self) -> Optional[str]:
         """The name of the section."""
         return self.properties.get("displayName", None)
 
+    @odata(name="createdBy")
     @property
-    def created_by(self):
-        # type: () -> IdentitySet
+    def created_by(self) -> IdentitySet:
         """Identity of the user, device, and application which created the item. Read-only."""
         return self.properties.get("createdBy", IdentitySet())
 
+    @odata(name="lastModifiedBy")
     @property
-    def last_modified_by(self):
+    def last_modified_by(self) -> IdentitySet:
         """Identity of the user, device, and application which created the item. Read-only."""
         return self.properties.get("lastModifiedBy", IdentitySet())
 
+    @odata(name="lastModifiedDateTime")
     @property
-    def last_modified_datetime(self):
+    def last_modified_datetime(self) -> datetime:
         """Gets date and time the item was last modified."""
-        return self.properties.get("lastModifiedDateTime", None)
-
-    def get_property(self, name, default_value=None):
-        if default_value is None:
-            property_mapping = {
-                "createdBy": self.created_by,
-                "lastModifiedBy": self.last_modified_by,
-            }
-            default_value = property_mapping.get(name, None)
-        return super(OnenoteEntityHierarchyModel, self).get_property(
-            name, default_value
-        )
+        return self.properties.get("lastModifiedDateTime", datetime.min)

office365/onenote/entity_schema_object_model.py

@@ -2,26 +2,17 @@ from datetime import datetime
 from typing import Optional
 
 from office365.onenote.entity_base_model import OnenoteEntityBaseModel
+from office365.runtime.types.odata_property import odata
 
 
 class OnenoteEntitySchemaObjectModel(OnenoteEntityBaseModel):
     """This is a base type for OneNote entities."""
 
+    @odata(name="createdDateTime")
     @property
-    def created_datetime(self):
-        # type: () -> Optional[datetime]
+    def created_datetime(self) -> Optional[datetime]:
         """
         The date and time when the page was created. 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.
         """
         return self.properties.get("createdDateTime", datetime.min)
-
-    def get_property(self, name, default_value=None):
-        if default_value is None:
-            property_mapping = {
-                "createdDateTime": self.created_datetime,
-            }
-            default_value = property_mapping.get(name, None)
-        return super(OnenoteEntitySchemaObjectModel, self).get_property(
-            name, default_value
-        )

office365/onenote/notebook_links.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from office365.onenote.pages.external_link import ExternalLink
+from office365.runtime.client_value import ClientValue
+
+
+@dataclass
+class NotebookLinks(ClientValue):
+    oneNoteClientUrl: ExternalLink = field(default_factory=ExternalLink)
+    oneNoteWebUrl: ExternalLink = field(default_factory=ExternalLink)
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.NotebookLinks"

office365/onenote/notebooks/collection.py

@@ -1,3 +1,4 @@
+from office365.directory.permissions.require_permission import require_permission
 from office365.entity_collection import EntityCollection
 from office365.onenote.notebooks.copy_notebook_model import CopyNotebookModel
 from office365.onenote.notebooks.notebook import Notebook
@@ -10,39 +11,51 @@ from office365.runtime.queries.service_operation import ServiceOperationQuery
 
 class NotebookCollection(EntityCollection[Notebook]):
     def __init__(self, context, resource_path=None):
-        super(NotebookCollection, self).__init__(context, Notebook, resource_path)
+        super().__init__(context, Notebook, resource_path)
 
-    def add(self, display_name):
-        """
-        Create a new OneNote notebook.
+    @require_permission(
+        delegated=["Notes.Create", "Notes.ReadWrite", "Notes.ReadWrite.All"], application=["Notes.ReadWrite.All"]
+    )
+    def add(self, display_name: str) -> Notebook:
+        """Create a new OneNote 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: ?*/:<>|'"
+        Args:
+            display_name (str): Name for the notebook. Notebook names must be unique. The name cannot contain more
+              than 128 characters or contain the following characters: ?*/:<>|'"
         """
-        return super(NotebookCollection, self).add(displayName=display_name)
+        return super().add(displayName=display_name)
 
-    def get_notebook_from_web_url(self, web_url):
-        """
-        Retrieve the properties and relationships of a notebook object by using its URL path.
+    @require_permission(
+        delegated=["Notes.Read", "Notes.Read.All", "Notes.ReadWrite", "Notes.ReadWrite.All"],
+        application=["Notes.Read.All", "Notes.ReadWrite.All"],
+    )
+    def get_notebook_from_web_url(self, web_url: str) -> ClientResult[CopyNotebookModel]:
+        """Retrieve the properties and relationships of a notebook object by using its URL path.
         The location can be user notebooks on Microsoft 365, group notebooks,
         or SharePoint site-hosted team notebooks on Microsoft 365.
 
-        :param str web_url: The URL path of the notebook to retrieve. It can also contain a "onenote:" prefix.
+        Args:
+            web_url (str): The URL path of the notebook to retrieve. It can also contain a "onenote:" prefix.
         """
         return_type = ClientResult(self.context, CopyNotebookModel())
         params = {"webUrl": web_url}
-        qry = ServiceOperationQuery(
-            self, "getNotebookFromWebUrl", params, None, None, return_type
-        )
+        qry = ServiceOperationQuery(self, "getNotebookFromWebUrl", params, None, None, return_type)
         self.context.add_query(qry)
         return return_type
 
-    def get_recent_notebooks(self, include_personal_notebooks=True):
+    @require_permission(
+        delegated=["Notes.Read", "Notes.Read.All", "Notes.ReadWrite", "Notes.ReadWrite.All"],
+        application=["Notes.Read.All", "Notes.ReadWrite.All"],
+    )
+    def get_recent_notebooks(
+        self, include_personal_notebooks: bool = True
+    ) -> ClientResult[ClientValueCollection[RecentNotebook]]:
         """Get a list of recentNotebook instances that have been accessed by the signed-in user.
 
-        :param bool include_personal_notebooks: Include notebooks owned by the user. Set to true to include notebooks
-            owned by the user; otherwise, set to false. If you don't include the includePersonalNotebooks parameter,
-            your request will return a 400 error response.
+        Args:
+            include_personal_notebooks (bool): Include notebooks owned by the user. Set to true to include notebooks
+              owned by the user; otherwise, set to false. If you don't include the includePersonalNotebooks parameter,
+              your request will return a 400 error response.
         """
 
         return_type = ClientResult(self.context, ClientValueCollection(RecentNotebook))

office365/onenote/notebooks/copy_notebook_model.py

@@ -1,5 +1,31 @@
+from __future__ import annotations
+
+from dataclasses import field
+from datetime import datetime
+
+from office365.directory.permissions.identity_set import IdentitySet
+from office365.onenote.notebook_links import NotebookLinks
+from office365.onenote.userrole import OnenoteUserRole
 from office365.runtime.client_value import ClientValue
 
 
 class CopyNotebookModel(ClientValue):
-    pass
+    createdBy: str | None = None
+    createdByIdentity: IdentitySet = field(default_factory=IdentitySet)
+    createdTime: datetime | None = None
+    id: str | None = None
+    isDefault: bool | None = None
+    isShared: bool | None = None
+    lastModifiedBy: str | None = None
+    lastModifiedByIdentity: IdentitySet = field(default_factory=IdentitySet)
+    lastModifiedTime: datetime | None = None
+    links: NotebookLinks = field(default_factory=NotebookLinks)
+    name: str | None = None
+    sectionGroupsUrl: str | None = None
+    sectionsUrl: str | None = None
+    self: str | None = None
+    userRole: OnenoteUserRole = OnenoteUserRole.Unknown
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.CopyNotebookModel"

office365/onenote/notebooks/notebook.py

@@ -1,17 +1,15 @@
-from typing import TYPE_CHECKING
-
 from office365.entity_collection import EntityCollection
 from office365.onenote.entity_hierarchy_model import OnenoteEntityHierarchyModel
 from office365.onenote.sections.section import OnenoteSection
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.types.odata_property import odata
 
 
 class Notebook(OnenoteEntityHierarchyModel):
     """A OneNote notebook."""
 
     @property
-    def sections(self):
-        # type: () -> EntityCollection[OnenoteSection]
+    def sections(self) -> EntityCollection[OnenoteSection]:
         """
         Retrieve a list of onenoteSection objects from the specified notebook.
         """
@@ -24,6 +22,7 @@ class Notebook(OnenoteEntityHierarchyModel):
             ),
         )
 
+    @odata(name="sectionGroups")
     @property
     def section_groups(self):
         """
@@ -41,8 +40,6 @@ class Notebook(OnenoteEntityHierarchyModel):
             ),
         )
 
-    def get_property(self, name, default_value=None):
-        if default_value is None:
-            property_mapping = {"sectionGroups": self.section_groups}
-            default_value = property_mapping.get(name, None)
-        return super(Notebook, self).get_property(name, default_value)
+    @property
+    def entity_type_name(self) -> str:
+        return None  # type: ignore

office365/onenote/notebooks/recent.py

@@ -1,16 +1,26 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
 from office365.onenote.notebooks.recent_links import RecentNotebookLinks
 from office365.runtime.client_value import ClientValue
 
 
+@dataclass
 class RecentNotebook(ClientValue):
-    """A recently accessed OneNote notebook. A recentNotebook is similar to a notebook but has fewer properties."""
+    """A recently accessed OneNote notebook. A recentNotebook is similar to a notebook but has fewer properties.
+
+    Args:
+        displayName (str): The name of the notebook.
+        links (RecentNotebookLinks): Links for opening the notebook. The oneNoteClientURL link opens the notebook in
+          the OneNote client, if it's installed. The oneNoteWebURL link opens the notebook in OneNote on the web.
+    """
+
+    displayName: str | None = None
+    lastAccessedTime: str | None = None
+    links: RecentNotebookLinks = field(default_factory=RecentNotebookLinks)
+    sourceService: str | None = None
 
-    def __init__(self, display_name=None, links=RecentNotebookLinks()):
-        """
-        :param str display_name: The name of the notebook.
-        :param RecentNotebookLinks links: Links for opening the notebook.
-            The oneNoteClientURL link opens the notebook in the OneNote client, if it's installed.
-            The oneNoteWebURL link opens the notebook in OneNote on the web.
-        """
-        self.displayName = display_name
-        self.links = links
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.RecentNotebook"

office365/onenote/notebooks/recent_links.py

@@ -1,14 +1,18 @@
+from dataclasses import dataclass, field
+
 from office365.onenote.pages.external_link import ExternalLink
 from office365.runtime.client_value import ClientValue
 
 
+@dataclass
 class RecentNotebookLinks(ClientValue):
     """
     Links for opening a OneNote notebook. This resource type exists as a property on a recentNotebook resource.
     """
 
-    def __init__(
-        self, onenote_client_url=ExternalLink(), onenote_web_url=ExternalLink()
-    ):
-        self.oneNoteClientUrl = onenote_client_url
-        self.oneNoteWebUrl = onenote_web_url
+    oneNoteClientUrl: ExternalLink = field(default_factory=ExternalLink)
+    oneNoteWebUrl: ExternalLink = field(default_factory=ExternalLink)
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.RecentNotebookLinks"