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

office365/directory/serviceprincipals/service_principal.py

@@ -17,6 +17,7 @@ from office365.directory.password_credential import PasswordCredential
 from office365.directory.permissions.grants.oauth2 import OAuth2PermissionGrant
 from office365.directory.permissions.scope import PermissionScope
 from office365.directory.synchronization.synchronization import Synchronization
+from office365.directory.users.user import User
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.appid import AppIdPath
@@ -101,7 +102,82 @@ class ServicePrincipal(DirectoryObject):
         self.context.add_query(qry)
         return return_type
 
-    def grant(self, app, app_role):
+    def _ensure_client_service_principal(self, app, action):
+        if isinstance(app, Application):
+
+            def _after():
+                action(app)
+
+            app.ensure_property("id", _after)
+        else:
+            self.context.service_principals.get_by_app(app).get().after_execute(action)
+
+    def grant_delegated(self, app, principal, scope):
+        # type: (Application|str, User|str, AppRole|str) -> Self
+        """Grants a delegated permission to the client service principal on behalf of a user"""
+
+        def _grant_delegated(principal_id, client_id):
+            # type: (str, str) -> None
+            self.context.oauth2_permission_grants.add(
+                clientId=client_id,
+                consentType="Principal",
+                resourceId=self.id,
+                principalId=principal_id,
+                scope=scope,
+            )
+
+        def _ensure_app(principal_id):
+            def _after(return_type):
+                _grant_delegated(principal_id, return_type.id)
+
+            self._ensure_client_service_principal(app, _after)
+
+        def _ensure_principal():
+            if isinstance(principal, User):
+
+                def _after():
+                    _ensure_app(principal.id)
+
+                principal.ensure_property("id", _after)
+            else:
+                _ensure_app(principal)
+
+        self.ensure_property("id", _ensure_principal)
+        return self
+
+    def revoke_delegated(self, app, principal, scope):
+        # type: (Application|str, User|str, AppRole|str) -> Self
+        """"""
+
+        def _revoke(app_id, principal_id):
+            # type: (str, str) -> None
+
+            def _after(return_type):
+                pass
+
+            query_text = "clientId eq '{0}' and principalId eq '{1}'".format(
+                app_id, principal_id
+            )
+            # query_text = "clientId eq '{0}'".format(app_id)
+            self.context.oauth2_permission_grants.filter(
+                query_text
+            ).get().after_execute(_after)
+
+        def _ensure_principal(return_type):
+            if isinstance(principal, User):
+
+                def _after():
+                    _revoke(principal.id, return_type.id)
+
+                principal.ensure_property("id", _after)
+            else:
+                _revoke(principal, return_type.id)
+
+        self._ensure_client_service_principal(app, _ensure_principal)
+        # self.ensure_property("id", _ensure_principal)
+        return self
+
+    def grant_application(self, app, app_role):
         # type: (Application|str, AppRole|str) -> Self
         """
         Grants an app role assignment to a client service principal
@@ -109,41 +185,54 @@ class ServicePrincipal(DirectoryObject):
         :param AppRole or str app_role: AppRole object or name
         """
 
-        def _grant(principal):
-            # type: ("ServicePrincipal") -> None
+        def _grant(principal_id, app_role_id):
+            # type: (str, str) -> None
             self.app_role_assigned_to.add(
-                principalId=principal.id, resourceId=self.id, appRoleId=app_role.id
+                principalId=principal_id, resourceId=self.id, appRoleId=app_role_id
             )
 
-        def _ensure_principal():
-            self.context.service_principals.get_by_app(app).get().after_execute(_grant)
+        def _ensure_resource():
+            def _after(return_type):
+                if isinstance(app_role, AppRole):
+                    _grant(return_type.id, app_role.id)
+                else:
+                    _grant(return_type.id, self.app_roles[app_role].id)
 
-        self.ensure_property("id", _ensure_principal)
+            self.context.service_principals.get_by_app(app).get().after_execute(_after)
+
+        self.ensure_properties(["id", "appRoles"], _ensure_resource)
         return self
 
-    def revoke(self, app, app_role):
+    def revoke_application(self, app, app_role):
         # type: (Application|str, AppRole|str) -> Self
         """Revokes an app role assignment from a client service principal"""
 
-        def _revoke(principal):
-            # type: ("ServicePrincipal") -> None
-            app_role_assigned_to_ids = [
-                item.id
+        def _revoke(principal_id, app_role_id):
+            # type: (str, str) -> None
+            app_role_to_revoke = [
+                item
                 for item in self.app_role_assigned_to
-                if item.principal_id == principal.id and item.app_role_id == app_role.id
+                # if item.principal_id == principal_id and item.app_role_id == app_role_id
+                if item.principal_id == principal_id
             ]
-            if len(app_role_assigned_to_ids) > 0:
-                self.app_role_assigned_to[app_role_assigned_to_ids[0]].delete_object()
+            if len(app_role_to_revoke) > 0:
+                self.app_role_assigned_to[app_role_to_revoke[0].id].delete_object()
 
-        def _ensure_resource(principal):
-            self.ensure_properties(["id", "appRoleAssignedTo"], _revoke, principal)
+        def _ensure_app_role(principal):
+            # type: ("ServicePrincipal") -> None
+            if isinstance(app_role, AppRole):
+                _revoke(principal.id, app_role.id)
+            else:
+                _revoke(principal.id, self.app_roles[app_role].id)
 
         def _ensure_principal():
-            self.context.service_principals.get_by_app(app).get().after_execute(
-                _ensure_resource
-            )
+            self.context.service_principals.get_by_app(app).select(
+                ["id"]
+            ).get().after_execute(_ensure_app_role)
 
-        self.ensure_property("id", _ensure_principal)
+        self.ensure_properties(
+            ["id", "appId", "appRoles", "appRoleAssignedTo"], _ensure_principal
+        )
         return self
 
     def remove_password(self, key_id):

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

@@ -22,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 (
@@ -785,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/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/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."""

office365/onedrive/workbooks/ranges/format.py

@@ -1,5 +1,10 @@
+from typing import Optional
+
 from office365.entity import Entity
+from office365.entity_collection import EntityCollection
+from office365.onedrive.workbooks.ranges.border import WorkbookRangeBorder
 from office365.onedrive.workbooks.ranges.fill import WorkbookRangeFill
+from office365.onedrive.workbooks.ranges.font import WorkbookRangeFont
 from office365.onedrive.workbooks.ranges.format_protection import (
     WorkbookFormatProtection,
 )
@@ -9,6 +14,53 @@ from office365.runtime.paths.resource_path import ResourcePath
 class WorkbookRangeFormat(Entity):
     """A format object encapsulating the range's font, fill, borders, alignment, and other properties."""
 
+    @property
+    def column_width(self):
+        # type: () -> Optional[float]
+        """Gets or sets the width of all columns within the range. If the column widths aren't uniform,
+        null will be returned."""
+        return self.properties.get("columnWidth", None)
+
+    @property
+    def horizontal_alignment(self):
+        # type: () -> Optional[str]
+        """Represents the horizontal alignment for the specified object"""
+        return self.properties.get("horizontalAlignment", None)
+
+    @property
+    def row_height(self):
+        # type: () -> Optional[float]
+        """Gets or sets the height of all rows in the range. If the row heights aren't uniform null will be returned."""
+        return self.properties.get("rowHeight", None)
+
+    @property
+    def vertical_alignment(self):
+        # type: () -> Optional[str]
+        """Represents the vertical alignment for the specified object.
+        Possible values are: Top, Center, Bottom, Justify, Distributed."""
+        return self.properties.get("verticalAlignment", None)
+
+    @property
+    def wrap_text(self):
+        # type: () -> Optional[bool]
+        """Indicates if Excel wraps the text in the object.
+        A null value indicates that the entire range doesn't have uniform wrap setting
+        """
+        return self.properties.get("wrapText", None)
+
+    @property
+    def borders(self):
+        # type: () -> EntityCollection[WorkbookRangeBorder]
+        """Collection of border objects that apply to the overall range selected."""
+        return self.properties.get(
+            "borders",
+            EntityCollection(
+                self.context,
+                WorkbookRangeBorder,
+                ResourcePath("borders", self.resource_path),
+            ),
+        )
+
     @property
     def fill(self):
         """Returns the fill object defined on the overall range"""
@@ -17,6 +69,14 @@ class WorkbookRangeFormat(Entity):
             WorkbookRangeFill(self.context, ResourcePath("fill", self.resource_path)),
         )
 
+    @property
+    def font(self):
+        """Returns the font object defined on the overall range selected"""
+        return self.properties.get(
+            "font",
+            WorkbookRangeFont(self.context, ResourcePath("font", self.resource_path)),
+        )
+
     @property
     def protection(self):
         """Returns the format protection object for a range"""

office365/onedrive/workbooks/ranges/range.py

@@ -82,6 +82,18 @@ class WorkbookRange(Entity):
         """Represents the total number of columns in the range. Read-only."""
         return self.properties.get("columnCount", None)
 
+    @property
+    def column_hidden(self):
+        # type: () -> Optional[bool]
+        """Represents if all columns of the current range are hidden."""
+        return self.properties.get("columnHidden", None)
+
+    @property
+    def column_index(self):
+        # type: () -> Optional[int]
+        """Represents the column number of the first cell in the range. Zero-indexed. Read-only."""
+        return self.properties.get("columnIndex", None)
+
     @property
     def format(self):
         """Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties"""

office365/onedrive/workbooks/ranges/reference.py

@@ -3,3 +3,9 @@ from office365.runtime.client_value import ClientValue
 
 class WorkbookRangeReference(ClientValue):
     """"""
+
+    def __init__(self, address=None):
+        """
+        :param str address:
+        """
+        self.address = address

office365/onedrive/workbooks/sort_field.py

@@ -0,0 +1,26 @@
+from office365.onedrive.workbooks.icon import WorkbookIcon
+from office365.runtime.client_value import ClientValue
+
+
+class WorkbookSortField(ClientValue):
+    """Represents a condition in a sorting operation."""
+
+    def __init__(
+        self, ascending=None, color=None, dataOption=None, icon=WorkbookIcon(), key=None
+    ):
+        """
+        :param bool ascending: Represents whether the sorting is done in an ascending fashion.
+        :param str color: Represents the color that is the target of the condition if the sorting is on font
+             or cell color.
+        :param str dataOption: Represents additional sorting options for this field.
+             Possible values are: Normal, TextAsNumber.
+        :param WorkbookIcon icon: Represents the icon that is the target of the condition if the sorting
+             is on the cell's icon.
+        :param str key: Represents the column (or row, depending on the sort orientation) that the condition is on.
+              Represented as an offset from the first column (or row).
+        """
+        self.ascending = ascending
+        self.color = color
+        self.dataOption = dataOption
+        self.icon = icon
+        self.key = key

office365/onedrive/workbooks/tables/pivot_table_collection.py

@@ -0,0 +1,16 @@
+from office365.entity_collection import EntityCollection
+from office365.onedrive.workbooks.tables.pivot_table import WorkbookPivotTable
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+
+
+class WorkbookPivotTableCollection(EntityCollection[WorkbookPivotTable]):
+    def __init__(self, context, resource_path=None):
+        super(WorkbookPivotTableCollection, self).__init__(
+            context, WorkbookPivotTable, resource_path
+        )
+
+    def refresh_all(self):
+        """Refreshes the PivotTable."""
+        qry = ServiceOperationQuery(self, "refreshAll")
+        self.context.add_query(qry)
+        return self

office365/onedrive/workbooks/worksheets/protection_options.py

@@ -7,6 +7,9 @@ class WorkbookWorksheetProtectionOptions(ClientValue):
     def __init__(
         self, allowAutoFilter=None, allowDeleteColumns=None, allowDeleteRows=None
     ):
+        """
+        :param bool allowAutoFilter:
+        """
         self.allowAutoFilter = allowAutoFilter
         self.allowDeleteColumns = allowDeleteColumns
         self.allowDeleteRows = allowDeleteRows

office365/onedrive/workbooks/worksheets/worksheet.py

@@ -6,7 +6,9 @@ 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.tables.pivot_table_collection import (
+    WorkbookPivotTableCollection,
+)
 from office365.onedrive.workbooks.worksheets.protection import (
     WorkbookWorksheetProtection,
 )
@@ -94,13 +96,12 @@ class WorkbookWorksheet(Entity):
 
     @property
     def pivot_tables(self):
-        # type: () -> EntityCollection[WorkbookPivotTable]
+        # type: () -> WorkbookPivotTableCollection
         """Collection of PivotTables that are part of the worksheet."""
         return self.properties.get(
             "pivotTables",
-            EntityCollection(
+            WorkbookPivotTableCollection(
                 self.context,
-                WorkbookPivotTable,
                 ResourcePath("pivotTables", self.resource_path),
             ),
         )

office365/sharepoint/activities/action_facet.py

@@ -7,8 +7,15 @@ from office365.sharepoint.activities.facets.delete import DeleteFacet
 from office365.sharepoint.activities.facets.discard_checkout import DiscardCheckoutFacet
 from office365.sharepoint.activities.facets.edit import EditFacet
 from office365.sharepoint.activities.facets.get_comment import GetCommentFacet
+from office365.sharepoint.activities.facets.get_mention import GetMentionFacet
+from office365.sharepoint.activities.facets.move import MoveFacet
+from office365.sharepoint.activities.facets.point_in_time_restore import (
+    PointInTimeRestoreFacet,
+)
 from office365.sharepoint.activities.facets.rename import RenameFacet
 from office365.sharepoint.activities.facets.sharing import SharingFacet
+from office365.sharepoint.activities.facets.task_completed import TaskCompletedFacet
+from office365.sharepoint.activities.facets.version import VersionFacet
 
 
 class ActionFacet(ClientValue):
@@ -22,8 +29,13 @@ class ActionFacet(ClientValue):
         delete=DeleteFacet(),
         discard_checkout=DiscardCheckoutFacet(),
         edit=EditFacet(),
+        mention=GetMentionFacet(),
+        move=MoveFacet(),
+        pointInTimeRestore=PointInTimeRestoreFacet(),
         rename=RenameFacet(),
         share=SharingFacet(),
+        taskCompleted=TaskCompletedFacet(),
+        version=VersionFacet(),
     ):
         """
         :param AddToOneDriveFacet add_to_one_drive:
@@ -42,8 +54,13 @@ class ActionFacet(ClientValue):
         self.delete = delete
         self.discardCheckout = discard_checkout
         self.edit = edit
+        self.mention = mention
+        self.move = move
+        self.pointInTimeRestore = pointInTimeRestore
         self.rename = rename
         self.share = share
+        self.taskCompleted = taskCompleted
+        self.version = version
 
     def __repr__(self):
         return self.facet_type

office365/sharepoint/activities/client_request.py

@@ -1,7 +1,11 @@
 from office365.runtime.client_value import ClientValue
+from office365.sharepoint.activities.facets.revision_set import RevisionSetFacet
 
 
 class ActivityClientRequest(ClientValue):
+    def __init__(self, revisionSet=RevisionSetFacet()):
+        self.revisionSet = revisionSet
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Activities.ActivityClientRequest"

office365/sharepoint/activities/client_response.py

@@ -4,6 +4,14 @@ from office365.runtime.client_value import ClientValue
 class ActivityClientResponse(ClientValue):
     """"""
 
+    def __init__(self, id_, message=None, serverId=None, status=None):
+        # type: (str, str, str, int) -> None
+        """ """
+        self.id = id_
+        self.message = message
+        self.serverId = serverId
+        self.status = status
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Activities.ActivityClientResponse"

office365/sharepoint/activities/entity.py

@@ -34,6 +34,16 @@ class SPActivityEntity(Entity):
     def times(self):
         return self.properties.get("times", ActivityTimeFacet())
 
+    @property
+    def property_ref_name(self):
+        return "id"
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Activities.SPActivityEntity"
+
+    def set_property(self, name, value, persist_changes=True):
+        super(SPActivityEntity, self).set_property(name, value, persist_changes)
+        if name == self.property_ref_name:
+            self._resource_path.patch(value)
+        return self

office365/sharepoint/activities/facets/delete.py

@@ -5,6 +5,7 @@ class DeleteFacet(ClientValue):
     """"""
 
     def __init__(self, name=None):
+        # type: (str) -> None
         self.name = name
 
     @property

office365/sharepoint/activities/facets/get_mention.py

@@ -0,0 +1,10 @@
+from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.sharepoint.activities.identity import ActivityIdentity
+
+
+class GetMentionFacet(ClientValue):
+    """"""
+
+    def __init__(self, mentionees=None):
+        self.mentionees = ClientValueCollection(ActivityIdentity, mentionees)

office365/sharepoint/activities/facets/in_doc.py

@@ -4,6 +4,10 @@ from office365.runtime.client_value import ClientValue
 class InDocFacet(ClientValue):
     """"""
 
+    def __init__(self, contentId=None, navigationId=None):
+        self.contentId = contentId
+        self.navigationId = navigationId
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Activities.InDocFacet"

office365/sharepoint/activities/facets/move.py

@@ -0,0 +1,14 @@
+from office365.runtime.client_value import ClientValue
+from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
+
+
+class MoveFacet(ClientValue):
+    """"""
+
+    def __init__(self, from_=SPResPath(), to=SPResPath()):
+        self.from_ = from_
+        self.to = to
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Activities.MoveFacet"

office365/sharepoint/activities/facets/point_in_time_restore.py

@@ -0,0 +1,9 @@
+from office365.runtime.client_value import ClientValue
+
+
+class PointInTimeRestoreFacet(ClientValue):
+    """"""
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Activities.PointInTimeRestoreFacet"

office365/sharepoint/activities/facets/revision_set.py

@@ -0,0 +1,9 @@
+from office365.runtime.client_value import ClientValue
+
+
+class RevisionSetFacet(ClientValue):
+    """ """
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Activities.RevisionSetFacet"

office365/sharepoint/activities/facets/task_completed.py

@@ -0,0 +1,9 @@
+from office365.runtime.client_value import ClientValue
+
+
+class TaskCompletedFacet(ClientValue):
+    """ """
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Activities.TaskCompletedFacet"