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

office365/graph_client.py

@@ -25,6 +25,7 @@ from office365.directory.internal.paths.me import MePath
 from office365.directory.invitations.collection import InvitationCollection
 from office365.directory.licenses.subscribed_sku import SubscribedSku
 from office365.directory.object_collection import DirectoryObjectCollection
+from office365.directory.permissions.grants.oauth2 import OAuth2PermissionGrant
 from office365.directory.permissions.grants.resource_specific import (
     ResourceSpecificPermissionGrant,
 )
@@ -516,6 +517,13 @@ class GraphClient(ClientRuntimeContext):
         """Gets all places in a tenant"""
         return EntityCollection(self, Place, ResourcePath("places"))
 
+    @property
+    def oauth2_permission_grants(self):
+        """Permission grants container"""
+        return DeltaCollection(
+            self, OAuth2PermissionGrant, ResourcePath("oauth2PermissionGrants")
+        )
+
     @property
     def room_lists(self):
         """Gets all the room lists in a tenant"""

office365/onedrive/driveitems/driveItem.py

@@ -2,6 +2,8 @@ from __future__ import annotations
 
 import os
 from datetime import datetime
+from functools import partial
+from os.path import isfile, join
 from typing import IO, AnyStr, Callable, Optional, TypeVar
 
 import requests
@@ -20,6 +22,7 @@ from office365.onedrive.driveitems.item_preview_info import ItemPreviewInfo
 from office365.onedrive.driveitems.photo import Photo
 from office365.onedrive.driveitems.publication_facet import PublicationFacet
 from office365.onedrive.driveitems.remote_item import RemoteItem
+from office365.onedrive.driveitems.retention_label import ItemRetentionLabel
 from office365.onedrive.driveitems.special_folder import SpecialFolder
 from office365.onedrive.driveitems.thumbnail_set import ThumbnailSet
 from office365.onedrive.driveitems.uploadable_properties import (
@@ -272,6 +275,30 @@ class DriveItem(BaseItem):
             name = os.path.basename(path_or_file)
             return self.upload(name, content)
 
+    def upload_folder(self, path, file_uploaded=None):
+        # type: (str, Callable[["DriveItem"], None]) -> "DriveItem"
+
+        def _after_file_upload(return_type):
+            # type: ("DriveItem") -> None
+            if callable(file_uploaded):
+                file_uploaded(return_type)
+
+        def _upload_folder(source_path, target_folder):
+            # type: (str, "DriveItem") -> None
+            for name in os.listdir(source_path):
+                cur_path = join(source_path, name)
+                if isfile(cur_path):
+                    with open(cur_path, "rb") as f:
+                        target_folder.upload_file(f).after_execute(_after_file_upload)
+                else:
+                    target_folder.create_folder(name).after_execute(
+                        partial(_upload_folder, cur_path)
+                    )
+
+        """Uploads a folder"""
+        _upload_folder(path, self)
+        return self
+
     def get_content(self, format_name=None):
         # type: (Optional[str]) -> ClientResult[AnyStr]
         """
@@ -302,6 +329,52 @@ class DriveItem(BaseItem):
         self.get_content().after_execute(_save_content)
         return self
 
+    def download_folder(
+        self, download_file, after_file_downloaded=None, recursive=True
+    ):
+        # type: (IO, Callable[[File], None], bool) -> "DriveItem"
+        """
+        Download the folder content
+        """
+        import zipfile
+
+        def _after_file_downloaded(drive_item, base_path, result):
+            # type: ("DriveItem", str, ClientResult[AnyStr]) -> None
+            with zipfile.ZipFile(download_file.name, "a", zipfile.ZIP_DEFLATED) as zf:
+                zip_path = (
+                    "/".join([base_path, drive_item.name])
+                    if base_path is not None
+                    else drive_item.name
+                )
+                zf.writestr(zip_path, result.value)
+                if callable(after_file_downloaded):
+                    after_file_downloaded(drive_item)
+
+        def _after_folder_downloaded(parent_item, base_path=None):
+            # type: ("DriveItem", str) -> None
+            for drive_item in parent_item.children:
+                if drive_item.is_file:
+                    drive_item.get_content().after_execute(
+                        partial(_after_file_downloaded, drive_item, base_path)
+                    )
+                else:
+                    if recursive:
+                        if base_path is None:
+                            next_base_path = str(drive_item.name)
+                        else:
+                            next_base_path = "/".join([base_path, drive_item.name])
+                        _download_folder(drive_item, next_base_path)
+
+        def _download_folder(drive_item, prev_result=None):
+            # type: ("DriveItem", str) -> None
+            drive_item.ensure_properties(
+                ["children", "name"],
+                partial(_after_folder_downloaded, drive_item, prev_result),
+            )
+
+        _download_folder(self)
+        return self
+
     def download_session(
         self, file_object, chunk_downloaded=None, chunk_size=1024 * 1024
     ):
@@ -600,9 +673,7 @@ class DriveItem(BaseItem):
     @property
     def audio(self):
         # type: () -> Audio
-        """
-        Audio metadata, if the item is an audio file. Read-only.
-        """
+        """Audio metadata, if the item is an audio file. Read-only."""
         return self.properties.get("audio", Audio())
 
     @property
@@ -616,9 +687,7 @@ class DriveItem(BaseItem):
     @property
     def photo(self):
         # type: () -> Photo
-        """
-        Photo metadata, if the item is a photo. Read-only.
-        """
+        """Photo metadata, if the item is a photo. Read-only."""
         return self.properties.get("photo", Photo())
 
     @property
@@ -717,6 +786,17 @@ class DriveItem(BaseItem):
             ),
         )
 
+    @property
+    def retention_label(self):
+        # type: () -> ItemRetentionLabel
+        """Information about retention label and settings enforced on the driveItem."""
+        return self.properties.get(
+            "retentionLabel",
+            ItemRetentionLabel(
+                self.context, ResourcePath("retentionLabel", self.resource_path)
+            ),
+        )
+
     @property
     def publication(self):
         # type: () -> PublicationFacet

office365/onedrive/driveitems/retention_label.py

@@ -0,0 +1,25 @@
+from typing import Optional
+
+from office365.directory.permissions.identity_set import IdentitySet
+from office365.entity import Entity
+
+
+class ItemRetentionLabel(Entity):
+    """
+    Groups retention and compliance-related properties on an item into a single structure.
+    Currently, supported only for driveItem.
+    """
+
+    @property
+    def is_label_applied_explicitly(self):
+        # type: () -> Optional[bool]
+        """Specifies whether the label is applied explicitly on the item.
+        True indicates that the label is applied explicitly; otherwise, the label is inherited from its parent.
+        Read-only."""
+        return self.properties.get("isLabelAppliedExplicitly", None)
+
+    @property
+    def label_applied_by(self):
+        # type: () -> Optional[IdentitySet]
+        """Identity of the user who applied the label. Read-only."""
+        return self.properties.get("labelAppliedBy", IdentitySet())

office365/onedrive/lists/list.py

@@ -17,7 +17,7 @@ class List(BaseItem):
     including template and field definitions."""
 
     def __str__(self):
-        return self.display_name
+        return self.display_name or self.entity_type_name
 
     @property
     def display_name(self):

office365/onedrive/sitepages/base.py

@@ -0,0 +1,29 @@
+from typing import Optional
+
+from office365.base_item import BaseItem
+from office365.onedrive.driveitems.publication_facet import PublicationFacet
+
+
+class BaseSitePage(BaseItem):
+    """An abstract type that represents a page in the site page library."""
+
+    @property
+    def publishing_state(self):
+        # type: () -> Optional[str]
+        """The publishing status and the MM.mm version of the page."""
+        return self.properties.get("publishingState", PublicationFacet())
+
+    @property
+    def page_layout(self):
+        # type: () -> Optional[str]
+        """
+        The name of the page layout of the page.
+        The possible values are: microsoftReserved, article, home, unknownFutureValue.
+        """
+        return self.properties.get("pageLayout", None)
+
+    @property
+    def title(self):
+        # type: () -> Optional[str]
+        """Title of the sitePage."""
+        return self.properties.get("title", None)

office365/onedrive/sitepages/canvas_layout.py

@@ -0,0 +1,43 @@
+from office365.entity import Entity
+from office365.entity_collection import EntityCollection
+from office365.onedrive.sitepages.horizontal_section import HorizontalSection
+from office365.onedrive.sitepages.vertical_section import VerticalSection
+from office365.runtime.paths.resource_path import ResourcePath
+
+
+class CanvasLayout(Entity):
+    """Represents the layout of the content in a given SharePoint page."""
+
+    @property
+    def horizontal_sections(self):
+        # type: () -> EntityCollection[HorizontalSection]
+        """Collection of horizontal sections on the SharePoint page.."""
+        return self.properties.get(
+            "horizontalSections",
+            EntityCollection(
+                self.context,
+                HorizontalSection,
+                ResourcePath("horizontalSections", self.resource_path),
+            ),
+        )
+
+    @property
+    def vertical_section(self):
+        # type: () -> VerticalSection
+        """Vertical section on the SharePoint page."""
+        return self.properties.get(
+            "verticalSection",
+            VerticalSection(
+                self.context,
+                ResourcePath("verticalSection", self.resource_path),
+            ),
+        )
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "horizontalSections": self.horizontal_sections,
+                "verticalSection": self.vertical_section,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(CanvasLayout, self).get_property(name, default_value)

office365/onedrive/sitepages/collection.py

@@ -0,0 +1,32 @@
+from office365.entity_collection import EntityCollection
+from office365.onedrive.sitepages.site_page import SitePage
+from office365.onedrive.sitepages.title_area import TitleArea
+from office365.runtime.http.request_options import RequestOptions
+
+
+class SitePageCollection(EntityCollection[SitePage]):
+    """Sites container"""
+
+    def __init__(self, context, resource_path=None):
+        super(SitePageCollection, self).__init__(context, SitePage, resource_path)
+
+    def add(self, title):
+        """
+        Create a new sitePage in the site pages list in a site.
+
+        """
+
+        def _construct_request(request):
+            # type: (RequestOptions) -> None
+            request.set_header("Content-Type", "application/json")
+
+        return (
+            super(SitePageCollection, self)
+            .add(
+                title=title,
+                name="{0}.aspx".format(title),
+                pageLayout="article",
+                titleArea=TitleArea(),
+            )
+            .before_execute(_construct_request)
+        )

office365/onedrive/sitepages/horizontal_section.py

@@ -0,0 +1,23 @@
+from office365.entity import Entity
+from office365.entity_collection import EntityCollection
+from office365.onedrive.sitepages.horizontal_section_column import (
+    HorizontalSectionColumn,
+)
+from office365.runtime.paths.resource_path import ResourcePath
+
+
+class HorizontalSection(Entity):
+    """Represents a horizontal section in a given SharePoint page."""
+
+    @property
+    def columns(self):
+        # type: () -> EntityCollection[HorizontalSectionColumn]
+        """The set of vertical columns in this section."""
+        return self.properties.get(
+            "columns",
+            EntityCollection(
+                self.context,
+                HorizontalSectionColumn,
+                ResourcePath("columns", self.resource_path),
+            ),
+        )

office365/onedrive/sitepages/horizontal_section_column.py

@@ -0,0 +1,27 @@
+from office365.entity import Entity
+from office365.entity_collection import EntityCollection
+from office365.onedrive.sitepages.web_part import WebPart
+from office365.runtime.paths.resource_path import ResourcePath
+
+
+class HorizontalSectionColumn(Entity):
+    """Represents a vertical column in a given horizontal section."""
+
+    @property
+    def web_parts(self):
+        # type: () -> EntityCollection[WebPart]
+        """The set of web parts in this section."""
+        return self.properties.get(
+            "webParts",
+            EntityCollection(
+                self.context, WebPart, ResourcePath("webParts", self.resource_path)
+            ),
+        )
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "webParts": self.web_parts,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(HorizontalSectionColumn, self).get_property(name, default_value)

office365/onedrive/sitepages/site_page.py

@@ -0,0 +1,116 @@
+from typing import Optional
+
+from office365.entity_collection import EntityCollection
+from office365.onedrive.sitepages.base import BaseSitePage
+from office365.onedrive.sitepages.canvas_layout import CanvasLayout
+from office365.onedrive.sitepages.title_area import TitleArea
+from office365.onedrive.sitepages.web_part import WebPart
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.function import FunctionQuery
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+
+
+class SitePage(BaseSitePage):
+    """This resource represents a page in the sitePages list. It contains the title, layout, and a collection of
+    webParts."""
+
+    def get_web_parts_by_position(
+        self, webPartIndex, horizontalSectionId, isInVerticalSection, columnId
+    ):
+        """
+        Get a collection of webPart by providing webPartPosition information.
+
+        :param float webPartIndex: Index of the current WebPart. Represents the order of WebPart in this column or
+             section. Only works if either columnId or isInVerticalSection is provided.
+        :param float horizontalSectionId: Indicate the horizontal section where the WebPart located in.
+        :param bool isInVerticalSection: Indicate whether the WebPart located in the vertical section.
+        :param float columnId: Indicate the identifier of the column where the WebPart located in. Only works
+             if horizontalSectionId is provided.
+        """
+        params = {
+            "webPartIndex": webPartIndex,
+            "horizontalSectionId": horizontalSectionId,
+            "isInverticalSection": isInVerticalSection,
+            "columnId": columnId,
+        }
+        return_type = EntityCollection(
+            self.context, WebPart, ResourcePath("webParts", self.resource_path)
+        )
+        qry = FunctionQuery(self, "getWebPartsByPosition", params, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def publish(self):
+        """
+        Publish the latest version of a sitePage resource, which makes the version of the page available to all users.
+        If the page is checked out, check in the page and publish it. If the page is checked out to the caller
+        of this API, the page is automatically checked in and then published.
+
+        If a page approval flow has been activated in the page library, the page is not published until the approval
+        flow is completed.
+        """
+        qry = ServiceOperationQuery(self, "publish")
+        self.context.add_query(qry)
+        return self
+
+    @property
+    def promotion_kind(self):
+        # type: () -> Optional[str]
+        """Indicates the promotion kind of the sitePage."""
+        return self.properties.get("promotionKind", None)
+
+    @property
+    def show_comments(self):
+        # type: () -> Optional[bool]
+        """Determines whether or not to show comments at the bottom of the page."""
+        return self.properties.get("showComments", None)
+
+    @property
+    def show_recommended_pages(self):
+        # type: () -> Optional[bool]
+        """Determines whether or not to show recommended pages at the bottom of the page."""
+        return self.properties.get("showRecommendedPages", None)
+
+    @property
+    def thumbnail_web_url(self):
+        # type: () -> Optional[str]
+        """Indicates the promotion kind of the sitePage."""
+        return self.properties.get("thumbnailWebUrl", None)
+
+    @property
+    def title_area(self):
+        # type: () -> Optional[str]
+        """Title area on the SharePoint page."""
+        return self.properties.get("titleArea", TitleArea())
+
+    @property
+    def canvas_layout(self):
+        # type: () -> CanvasLayout
+        """The default termStore under this site."""
+        return self.properties.get(
+            "canvasLayout",
+            CanvasLayout(
+                self.context, ResourcePath("canvasLayout", self.resource_path)
+            ),
+        )
+
+    @property
+    def web_parts(self):
+        # type: () -> EntityCollection[WebPart]
+        """Collection of webparts on the SharePoint page."""
+        return self.properties.get(
+            "webParts",
+            EntityCollection(
+                self.context, WebPart, ResourcePath("webParts", self.resource_path)
+            ),
+        )
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "canvasLayout": self.canvas_layout,
+                "titleArea": self.title_area,
+                "webParts": self.web_parts,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(SitePage, self).get_property(name, default_value)

office365/onedrive/sitepages/title_area.py

@@ -0,0 +1,13 @@
+from office365.runtime.client_value import ClientValue
+
+
+class TitleArea(ClientValue):
+    """Represents the title area of a given SharePoint page."""
+
+    def __init__(self, alternativeText=None, enableGradientEffect=None):
+        """
+        :param str alternativeText: Alternative text on the title area.
+        :param bool enableGradientEffect: Indicates whether the title area has a gradient effect enabled.
+        """
+        self.alternativeText = alternativeText
+        self.enableGradientEffect = enableGradientEffect

office365/onedrive/sitepages/vertical_section.py

@@ -0,0 +1,27 @@
+from office365.entity import Entity
+from office365.entity_collection import EntityCollection
+from office365.onedrive.sitepages.web_part import WebPart
+from office365.runtime.paths.resource_path import ResourcePath
+
+
+class VerticalSection(Entity):
+    """Represents the vertical section in a given SharePoint page."""
+
+    @property
+    def web_parts(self):
+        # type: () -> EntityCollection[WebPart]
+        """The set of web parts in this section."""
+        return self.properties.get(
+            "webParts",
+            EntityCollection(
+                self.context, WebPart, ResourcePath("webParts", self.resource_path)
+            ),
+        )
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "webParts": self.web_parts,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(VerticalSection, self).get_property(name, default_value)

office365/onedrive/sitepages/web_part.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class WebPart(Entity):
+    """Represents a specific web part instance on a SharePoint page."""

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/workbooks/charts/chart.py

@@ -2,11 +2,24 @@ from office365.entity import Entity
 from office365.onedrive.workbooks.charts.axes import WorkbookChartAxes
 from office365.onedrive.workbooks.charts.data_labels import WorkbookChartDataLabels
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 
 
 class WorkbookChart(Entity):
     """Represents a chart object in a workbook."""
 
+    def set_position(self, startCell, endCell):
+        """Positions the chart relative to cells on the worksheet.
+        :param str startCell: The start cell. It is where the chart is moved to. The start cell is the top-left or
+             top-right cell, depending on the user's right-to-left display settings.
+        :param str endCell: The end cell. If specified, the chart's width and height is set to fully cover up
+             this cell/range.
+        """
+        payload = {"startCell": startCell, "endCell": endCell}
+        qry = ServiceOperationQuery(self, "setPosition", None, payload)
+        self.context.add_query(qry)
+        return self
+
     @property
     def axes(self):
         """Represents chart axes."""

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/icon.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class WorkbookIcon(ClientValue):
+    """Represents a cell icon."""

office365/onedrive/workbooks/names/named_item.py

@@ -33,6 +33,12 @@ class WorkbookNamedItem(Entity):
         """Represents the comment associated with this name."""
         return self.properties.get("comment", None)
 
+    @property
+    def scope(self):
+        # type: () -> Optional[str]
+        """Indicates whether the name is scoped to the workbook or to a specific worksheet."""
+        return self.properties.get("scope", None)
+
     @property
     def worksheet(self):
         """Returns the worksheet on which the named item is scoped to. Available only if the item is scoped

office365/onedrive/workbooks/ranges/font.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class WorkbookRangeFont(Entity):
+    """This object represents the font attributes (font name, font size, color, etc.) for an object."""