Office365-REST-Python-Client 2.5.14__py3-none-any.whl → 2.6.1__py3-none-any.whl

office365/graph_request.py

@@ -1,30 +1,89 @@
+from typing import Callable, Optional
+
+from office365.azure_env import AzureEnvironment
+from office365.runtime.auth.entra.authentication_context import AuthenticationContext
+from office365.runtime.http.request_options import RequestOptions
 from office365.runtime.odata.request import ODataRequest
 from office365.runtime.odata.v4.json_format import V4JsonFormat
 
-environments_endpoints = {
-    "GCCH": {
-        "graph_url": "https://graph.microsoft.com",
-        "entra_url": "https://login.microsoftonline.com",
-    },
-    "GCC High": {
-        "graph_url": "https://graph.microsoft.us",
-        "entra_url": "https://login.microsoftonline.us",
-    },
-    "DoD": {
-        "graph_url": "https://dod-graph.microsoft.us",
-        "entra_url": "https://login.chinacloudapi.cn",
-    },
-}
-
 
 class GraphRequest(ODataRequest):
-    def __init__(self, version="v1.0", environment="GCCH"):
-        # type: (str, str) -> None
+    def __init__(
+        self, version="v1.0", tenant=None, environment=AzureEnvironment.Global
+    ):
+        # type: (str, str, str) -> None
         super(GraphRequest, self).__init__(V4JsonFormat())
         self._version = version
-        self._environment_endpoints = environments_endpoints.get(environment, None)
+        self._environment = environment
+        self._auth_context = AuthenticationContext(
+            environment=environment, tenant=tenant
+        )
+        self.beforeExecute += self.authenticate_request
+
+    def with_access_token(self, token_callback):
+        # type: (Callable[[], dict]) -> "GraphRequest"
+        """
+        Initializes the confidential client with token callback.
+        """
+        self._auth_context.with_access_token(token_callback)
+        return self
+
+    def with_certificate(self, client_id, thumbprint, private_key):
+        # type: (str, str, str) -> "GraphRequest"
+        """
+        Initializes the confidential client with client certificate
+
+        :param str client_id: The OAuth client id of the calling application.
+        :param str thumbprint: Thumbprint
+        :param str private_key: Private key
+        """
+        self._auth_context.with_certificate(client_id, thumbprint, private_key)
+        return self
+
+    def with_client_secret(self, client_id, client_secret):
+        # type: (str, str) -> "GraphRequest"
+        """
+        Initializes the confidential client with client secret
+
+        :param str client_id: The OAuth client id of the calling application.
+        :param str client_secret: Client secret
+        """
+        self._auth_context.with_client_secret(client_id, client_secret)
+        return self
+
+    def with_token_interactive(self, client_id, username=None):
+        # type: (str, Optional[str]) -> "GraphRequest"
+        """
+        Initializes the client via user credentials
+        Note: only works if your app is registered with redirect_uri as http://localhost
+
+
+        :param str client_id: The OAuth client id of the calling application.
+        :param str username: Typically a UPN in the form of an email address.
+        """
+        self._auth_context.with_token_interactive(client_id, username)
+        return self
+
+    def with_username_and_password(self, client_id, username, password):
+        # type: (str, str, str) -> "GraphRequest"
+        """
+        Initializes the client via user credentials
+        :param str client_id: The OAuth client id of the calling application.
+        :param str username: Typically a UPN in the form of an email address.
+        :param str password: The password.
+        """
+        self._auth_context.with_username_and_password(client_id, username, password)
+        return self
+
+    def authenticate_request(self, request):
+        # type: (RequestOptions) -> None
+        """Authenticate request"""
+        token = self._auth_context.acquire_token()
+        request.ensure_header("Authorization", "Bearer {0}".format(token.accessToken))
 
     @property
     def service_root_url(self):
         # type: () -> str
-        return "https://graph.microsoft.com/{0}".format(self._version)
+        return "{0}/{1}".format(
+            AzureEnvironment.get_graph_authority(self._environment), self._version
+        )

office365/intune/servicecommunications/health/health.py

@@ -2,4 +2,4 @@ from office365.entity import Entity
 
 
 class ServiceHealth(Entity):
-    """Represents the health information of a service subscribed by a tenant."""
+    """Represents the sitehealth information of a service subscribed by a tenant."""

office365/intune/servicecommunications/issues/issue.py

@@ -7,9 +7,9 @@ from office365.runtime.queries.function import FunctionQuery
 
 class ServiceHealthIssue(ServiceAnnouncementBase):
     """
-    Represents a service health issue in a service.
+    Represents a service sitehealth issue in a service.
 
-    The service health issue can be a service incident or service advisory. For example:
+    The service sitehealth issue can be a service incident or service advisory. For example:
 
        - Service incident: "Exchange mailbox service is down".
        - Service advisory: "Users may experience delays in emails reception".

office365/onedrive/columns/definition.py

@@ -1,6 +1,6 @@
 from typing import Optional
 
-from office365.base_item import BaseItem
+from office365.onedrive.base_item import BaseItem
 from office365.onedrive.columns.boolean import BooleanColumn
 from office365.onedrive.columns.calculated import CalculatedColumn
 from office365.onedrive.columns.choice import ChoiceColumn

office365/onedrive/contenttypes/content_type.py

@@ -1,7 +1,7 @@
 from typing import Optional
 
-from office365.base_item import BaseItem
 from office365.entity_collection import EntityCollection
+from office365.onedrive.base_item import BaseItem
 from office365.onedrive.columns.column_link import ColumnLink
 from office365.onedrive.columns.definition import ColumnDefinition
 from office365.onedrive.contenttypes.order import ContentTypeOrder

office365/onedrive/driveitems/driveItem.py

@@ -9,11 +9,11 @@ from typing import IO, AnyStr, Callable, Optional, TypeVar
 import requests
 from typing_extensions import Self
 
-from office365.base_item import BaseItem
 from office365.delta_path import DeltaPath
 from office365.entity_collection import EntityCollection
 from office365.onedrive.analytics.item_activity_stat import ItemActivityStat
 from office365.onedrive.analytics.item_analytics import ItemAnalytics
+from office365.onedrive.base_item import BaseItem
 from office365.onedrive.driveitems.audio import Audio
 from office365.onedrive.driveitems.conflict_behavior import ConflictBehavior
 from office365.onedrive.driveitems.geo_coordinates import GeoCoordinates
@@ -66,6 +66,7 @@ class DriveItem(BaseItem):
     OneDrive and SharePoint are returned as driveItem resources"""
 
     def get_files(self, recursive=False, page_size=None):
+        # type: (bool, Optional[int]) -> EntityCollection["DriveItem"]
         """Retrieves files
         :param bool recursive: Determines whether to enumerate folders recursively
         :param int page_size: Page size
@@ -94,6 +95,7 @@ class DriveItem(BaseItem):
         return return_type
 
     def get_folders(self, recursive=False, page_size=None):
+        # type: (bool, Optional[int]) -> EntityCollection["DriveItem"]
         """Retrieves folders
         :param bool recursive: Determines whether to enumerate folders recursively
         :param int page_size: Page size
@@ -177,6 +179,16 @@ class DriveItem(BaseItem):
         self.context.add_query(qry)
         return return_type
 
+    def discard_checkout(self):
+        """Discard the check out of a driveItem. This action releases a driveItem resource that was previously
+        checked out. Any changes made to the item while it was checked out are discarded.
+
+        The same user that performed the checkout must discard it. Another alternative is to use application permissions
+        """
+        qry = ServiceOperationQuery(self, "discardCheckout")
+        self.context.add_query(qry)
+        return self
+
     def extract_sensitivity_labels(self):
         # type: () -> ClientResult[ExtractSensitivityLabelsResult]
         """

office365/onedrive/drives/drive.py

@@ -1,8 +1,8 @@
 from typing import Optional
 
-from office365.base_item import BaseItem
 from office365.directory.permissions.identity_set import IdentitySet
 from office365.entity_collection import EntityCollection
+from office365.onedrive.base_item import BaseItem
 from office365.onedrive.driveitems.conflict_behavior import ConflictBehavior
 from office365.onedrive.driveitems.driveItem import DriveItem
 from office365.onedrive.driveitems.system_facet import SystemFacet

office365/onedrive/filestorage/container.py

@@ -0,0 +1,7 @@
+from office365.entity import Entity
+
+
+class FileStorageContainer(Entity):
+    """Represents a location where multiple users or a group of users can store files and access them
+    via an application. All file system objects in a fileStorageContainer are returned as driveItem resources.
+    """

office365/onedrive/filestorage/file_storage.py

@@ -0,0 +1,20 @@
+from office365.entity import Entity
+from office365.entity_collection import EntityCollection
+from office365.onedrive.filestorage.container import FileStorageContainer
+from office365.runtime.paths.resource_path import ResourcePath
+
+
+class FileStorage(Entity):
+    """Represents the structure of active and deleted fileStorageContainer objects."""
+
+    @property
+    def containers(self):
+        """The collection of active fileStorageContainers"""
+        return self.properties.get(
+            "containers",
+            EntityCollection(
+                self.context,
+                FileStorageContainer,
+                ResourcePath("containers", self.resource_path),
+            ),
+        )

office365/onedrive/listitems/field_value_set.py

@@ -1,4 +1,4 @@
-from office365.base_item import BaseItem
+from office365.onedrive.base_item import BaseItem
 
 
 class FieldValueSet(BaseItem):

office365/onedrive/listitems/list_item.py

@@ -1,6 +1,6 @@
-from office365.base_item import BaseItem
 from office365.entity_collection import EntityCollection
 from office365.onedrive.analytics.item_analytics import ItemAnalytics
+from office365.onedrive.base_item import BaseItem
 from office365.onedrive.contenttypes.info import ContentTypeInfo
 from office365.onedrive.documentsets.version import DocumentSetVersion
 from office365.onedrive.internal.queries.get_activities_by_interval import (

office365/onedrive/lists/list.py

@@ -1,7 +1,7 @@
 from typing import Optional
 
-from office365.base_item import BaseItem
 from office365.entity_collection import EntityCollection
+from office365.onedrive.base_item import BaseItem
 from office365.onedrive.columns.definition_collection import ColumnDefinitionCollection
 from office365.onedrive.contenttypes.collection import ContentTypeCollection
 from office365.onedrive.listitems.list_item import ListItem

office365/onedrive/recyclebin/item.py

@@ -0,0 +1,6 @@
+from office365.onedrive.base_item import BaseItem
+
+
+class RecycleBinItem(BaseItem):
+    """Represents information about a deleted item in a recycleBin of a SharePoint site or a SharePoint
+    Embedded fileStorageContainer."""

office365/onedrive/recyclebin/recyclebin.py

@@ -0,0 +1,29 @@
+from office365.entity_collection import EntityCollection
+from office365.onedrive.base_item import BaseItem
+from office365.onedrive.recyclebin.item import RecycleBinItem
+from office365.onedrive.recyclebin.settings import RecycleBinSettings
+from office365.runtime.paths.resource_path import ResourcePath
+
+
+class RecycleBin(BaseItem):
+    """Represents a container for a collection of recycleBinItem resources in a SharePoint site or a
+    SharePoint Embedded fileStorageContainer."""
+
+    @property
+    def items(self):
+        # type: () -> EntityCollection[RecycleBinItem]
+        """List of the recycleBinItems deleted by a user."""
+        return self.properties.setdefault(
+            "items",
+            EntityCollection(
+                self.context,
+                RecycleBinItem,
+                ResourcePath("items", self.resource_path),
+                self,
+            ),
+        )
+
+    @property
+    def settings(self):
+        """Settings for the recycleBin"""
+        return self.properties.get("settings", RecycleBinSettings())

office365/onedrive/recyclebin/settings.py

@@ -0,0 +1,13 @@
+from office365.runtime.client_value import ClientValue
+
+
+class RecycleBinSettings(ClientValue):
+    """Represents settings for the recycleBin resource type."""
+
+    def __init__(self, retention_period_override_days=None):
+        """
+        :param int retention_period_override_days: Recycle bin retention period override in days for deleted content.
+        The default value is 93; the value range is 7 to 180. The setting applies to newly deleted content only.
+        Setting this property to null reverts to its default value.
+        """
+        self.retentionPeriodOverrideDays = retention_period_override_days

office365/onedrive/shares/drive_item.py

@@ -1,6 +1,6 @@
-from office365.base_item import BaseItem
 from office365.directory.permissions.identity_set import IdentitySet
 from office365.entity_collection import EntityCollection
+from office365.onedrive.base_item import BaseItem
 from office365.onedrive.driveitems.driveItem import DriveItem
 from office365.onedrive.internal.paths.root import RootPath
 from office365.onedrive.listitems.list_item import ListItem

office365/onedrive/sitepages/base.py

@@ -1,6 +1,6 @@
 from typing import Optional
 
-from office365.base_item import BaseItem
+from office365.onedrive.base_item import BaseItem
 from office365.onedrive.driveitems.publication_facet import PublicationFacet
 
 

office365/onedrive/sitepages/canvas_layout.py

@@ -1,7 +1,7 @@
 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.onedrive.sitepages.sections.horizontal import HorizontalSection
+from office365.onedrive.sitepages.sections.vertical import VerticalSection
 from office365.runtime.paths.resource_path import ResourcePath
 
 

office365/onedrive/sitepages/{horizontal_section.py → sections/horizontal.py}

@@ -1,6 +1,6 @@
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
-from office365.onedrive.sitepages.horizontal_section_column import (
+from office365.onedrive.sitepages.sections.horizontal_column import (
     HorizontalSectionColumn,
 )
 from office365.runtime.paths.resource_path import ResourcePath

office365/onedrive/sitepages/webparts/data.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class WebPartData(ClientValue):
+    """"""

office365/onedrive/sitepages/webparts/position.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class WebPartPosition(ClientValue):
+    """Represents the position information of the given web part to the current page"""

office365/onedrive/sitepages/webparts/standard.py

@@ -1,5 +1,14 @@
+from typing import Optional
+
+from office365.onedrive.sitepages.webparts.data import WebPartData
 from office365.onedrive.sitepages.webparts.web_part import WebPart
 
 
 class StandardWebPart(WebPart):
     """Represents a standard web part instance on a SharePoint page."""
+
+    @property
+    def data(self):
+        # type: () -> Optional[WebPartData]
+        """Data of the webPart."""
+        return self.properties.get("data", WebPartData())

office365/onedrive/sitepages/webparts/web_part.py

@@ -1,5 +1,17 @@
 from office365.entity import Entity
+from office365.onedrive.sitepages.webparts.position import WebPartPosition
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 
 
 class WebPart(Entity):
     """Represents a specific web part instance on a SharePoint page."""
+
+    def get_position_of_web_part(self):
+        """Returns the position of the specified web part in the page."""
+        return_type = ClientResult(self.context, WebPartPosition())
+        qry = ServiceOperationQuery(
+            self, "getPositionOfWebPart", return_type=return_type
+        )
+        self.context.add_query(qry)
+        return self

office365/onedrive/sites/site.py

@@ -1,10 +1,10 @@
 from datetime import datetime
 from typing import Optional
 
-from office365.base_item import BaseItem
 from office365.entity_collection import EntityCollection
 from office365.onedrive.analytics.item_activity_stat import ItemActivityStat
 from office365.onedrive.analytics.item_analytics import ItemAnalytics
+from office365.onedrive.base_item import BaseItem
 from office365.onedrive.columns.definition_collection import ColumnDefinitionCollection
 from office365.onedrive.contenttypes.collection import ContentTypeCollection
 from office365.onedrive.drives.drive import Drive

office365/onedrive/storage/storage.py

@@ -1,5 +1,15 @@
 from office365.entity import Entity
+from office365.onedrive.filestorage.file_storage import FileStorage
+from office365.runtime.paths.resource_path import ResourcePath
 
 
 class Storage(Entity):
     """Facilitates the structures of fileStorageContainers."""
+
+    @property
+    def file_storage(self):
+        """FileStorageContainer"""
+        return self.properties.get(
+            "fileStorage",
+            FileStorage(self.context, ResourcePath("fileStorage", self.resource_path)),
+        )

office365/onedrive/workbooks/charts/axes.py

@@ -1,7 +1,47 @@
 from office365.entity import Entity
+from office365.onedrive.workbooks.charts.axis import WorkbookChartAxis
+from office365.runtime.paths.resource_path import ResourcePath
 
 
 class WorkbookChartAxes(Entity):
     """Represents the chart axes."""
 
-    pass
+    @property
+    def category_axis(self):
+        """Represents the category axis in a chart."""
+        return self.properties.get(
+            "categoryAxis",
+            WorkbookChartAxis(
+                self.context, ResourcePath("categoryAxis", self.resource_path)
+            ),
+        )
+
+    @property
+    def series_axis(self):
+        """Represents the series axis of a 3-dimensional chart."""
+        return self.properties.get(
+            "seriesAxis",
+            WorkbookChartAxis(
+                self.context, ResourcePath("seriesAxis", self.resource_path)
+            ),
+        )
+
+    @property
+    def value_axis(self):
+        """Represents the value axis in an axis."""
+        return self.properties.get(
+            "valueAxis",
+            WorkbookChartAxis(
+                self.context, ResourcePath("valueAxis", self.resource_path)
+            ),
+        )
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "categoryAxis": self.category_axis,
+                "seriesAxis": self.series_axis,
+                "valueAxis": self.value_axis,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(WorkbookChartAxes, self).get_property(name, default_value)

office365/onedrive/workbooks/charts/axis.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class WorkbookChartAxis(Entity):
+    """Represents a single axis in a chart."""

office365/onedrive/workbooks/charts/chart.py

@@ -1,21 +1,50 @@
 from office365.entity import Entity
+from office365.entity_collection import EntityCollection
 from office365.onedrive.workbooks.charts.axes import WorkbookChartAxes
 from office365.onedrive.workbooks.charts.data_labels import WorkbookChartDataLabels
+from office365.onedrive.workbooks.charts.legend.legend import WorkbookChartLegend
+from office365.onedrive.workbooks.charts.series.series import WorkbookChartSeries
+from office365.onedrive.workbooks.charts.title import WorkbookChartTitle
+from office365.runtime.client_result import ClientResult
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.function import FunctionQuery
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 
 
 class WorkbookChart(Entity):
     """Represents a chart object in a workbook."""
 
-    def set_position(self, startCell, endCell):
+    def image(self, width=None, height=None):
+        """Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions.
+
+        :param int width: Specifies the width of the rendered image in pixels.
+        :param int height: Specifies the height of the rendered image in pixels.
+        """
+        return_type = ClientResult(self.context)
+        params = {"width": width, "height": height}
+        qry = FunctionQuery(self, "image", params, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def set_data(self, source_data, series_by):
+        """
+        Updates the data source of a chart
+        :param dict source_data:
+        :param str series_by:
+        """
+        payload = {"sourceData": source_data, "seriesBy": series_by}
+        qry = ServiceOperationQuery(self, "setData", None, payload)
+        self.context.add_query(qry)
+        return self
+
+    def set_position(self, start_cell, end_cell):
         """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
+        :param str start_cell: 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
+        :param str end_cell: 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}
+        payload = {"startCell": start_cell, "endCell": end_cell}
         qry = ServiceOperationQuery(self, "setPosition", None, payload)
         self.context.add_query(qry)
         return self
@@ -30,7 +59,7 @@ class WorkbookChart(Entity):
 
     @property
     def data_labels(self):
-        """Represents the datalabels on the chart."""
+        """Represents the data labels on the chart."""
         return self.properties.get(
             "dataLabels",
             WorkbookChartDataLabels(
@@ -38,6 +67,36 @@ class WorkbookChart(Entity):
             ),
         )
 
+    @property
+    def legend(self):
+        """Represents the legend on the chart."""
+        return self.properties.get(
+            "legend",
+            WorkbookChartLegend(
+                self.context, ResourcePath("legend", self.resource_path)
+            ),
+        )
+
+    @property
+    def series(self):
+        """Represents chart series."""
+        return self.properties.get(
+            "series",
+            EntityCollection(
+                self.context,
+                WorkbookChartSeries,
+                ResourcePath("series", self.resource_path),
+            ),
+        )
+
+    @property
+    def title(self):
+        """Represents the title on the chart."""
+        return self.properties.get(
+            "title",
+            WorkbookChartTitle(self.context, ResourcePath("title", self.resource_path)),
+        )
+
     @property
     def worksheet(self):
         """The worksheet containing the current chart."""

office365/onedrive/workbooks/charts/fill.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class WorkbookChartFill(Entity):
+    """Represents the fill formatting for a chart element."""

office365/onedrive/workbooks/charts/font.py

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

office365/onedrive/workbooks/charts/legend/format.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class WorkbookChartLegendFormat(Entity):
+    """Encapsulates the format properties of a chart legend."""

office365/onedrive/workbooks/charts/legend/legend.py

@@ -0,0 +1,26 @@
+from typing import Optional
+
+from office365.entity import Entity
+
+
+class WorkbookChartLegend(Entity):
+    """Represents the legend in a chart."""
+
+    @property
+    def overlay(self):
+        # type: () -> Optional[bool]
+        """Indicates whether the chart legend should overlap with the main body of the chart."""
+        return self.properties.get("overlay", None)
+
+    @property
+    def position(self):
+        # type: () -> Optional[str]
+        """Represents the position of the legend on the chart.
+        The possible values are: Top, Bottom, Left, Right, Corner, Custom."""
+        return self.properties.get("position", None)
+
+    @property
+    def visible(self):
+        # type: () -> Optional[bool]
+        """Indicates whether the chart legend is visible."""
+        return self.properties.get("visible", None)

office365/onedrive/workbooks/charts/point.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class WorkbookChartPoint(Entity):
+    """Represents a point of a series in a chart."""