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

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"

office365/sharepoint/activities/facets/version.py

@@ -0,0 +1,12 @@
+from office365.runtime.client_value import ClientValue
+
+
+class VersionFacet(ClientValue):
+    """"""
+
+    def __init__(self, fromVersion=None):
+        self.fromVersion = fromVersion
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Activities.VersionFacet"

office365/sharepoint/activities/identity_item.py

@@ -2,11 +2,26 @@ from office365.runtime.client_value import ClientValue
 
 
 class ActivityIdentityItem(ClientValue):
-    def __init__(self, client_id=None):
+    def __init__(
+        self,
+        client_id=None,
+        clientIdProvider=None,
+        displayName=None,
+        email=None,
+        userPrincipalName=None,
+    ):
         """
         :param str client_id:
+        :param str clientIdProvider:
+        :param str displayName:
+        :param str email:
+        :param str userPrincipalName:
         """
         self.clientId = client_id
+        self.clientIdProvider = clientIdProvider
+        self.displayName = displayName
+        self.email = email
+        self.userPrincipalName = userPrincipalName
 
     @property
     def entity_type_name(self):

office365/sharepoint/alerts/collection.py

@@ -39,6 +39,18 @@ class AlertCollection(EntityCollection[Alert]):
         self.context.add_query(qry)
         return return_type
 
+    def delete_alert_at_index(self, index):
+        """Deletes the alert based on the given index.
+
+        :param int index:  A 32-bit integer that is greater than or equal to 0 and less than the count of the
+              alert in the collection. Specifies the index of the alert in the collection.
+        """
+        qry = ServiceOperationQuery(
+            self, "DeleteAlertAtIndex", {"index": index}, None, None, None
+        )
+        self.context.add_query(qry)
+        return self
+
     def get_by_id(self, id_alert):
         """
         Gets an alert based on the Id.

office365/sharepoint/attachments/attachment.py

@@ -10,6 +10,9 @@ from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
 class Attachment(Entity):
     """Represents an attachment file in a SharePoint List Item."""
 
+    def __repr__(self):
+        return self.server_relative_url or self.entity_type_name
+
     def download(self, file_object, use_path=True):
         """Download attachment file
 

office365/sharepoint/attachments/collection.py

@@ -1,4 +1,5 @@
-from typing import AnyStr
+import os
+from typing import IO, AnyStr
 
 from office365.runtime.paths.service_operation import ServiceOperationPath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -18,7 +19,7 @@ class AttachmentCollection(EntityCollection[Attachment]):
         )
 
     def add(self, attachment_file_information):
-        # type: (AttachmentCreationInformation) -> Attachment
+        # type: (AttachmentCreationInformation|dict) -> Attachment
         """
         Adds the attachment represented by the file name and stream in the specified parameter to the list item.
 
@@ -55,14 +56,35 @@ class AttachmentCollection(EntityCollection[Attachment]):
         :param str content_stream: Stream containing the content of the attachment.
         """
         return_type = Attachment(self.context)
-        payload = {"DecodedUrl": decoded_url, "contentStream": content_stream}
+        params = {"DecodedUrl": decoded_url}
         qry = ServiceOperationQuery(
-            self, "AddUsingPath", None, payload, None, return_type
+            self, "AddUsingPath", params, content_stream, None, return_type
         )
         self.context.add_query(qry)
         self.add_child(return_type)
         return return_type
 
+    def delete_all(self):
+        """Deletes all attachments"""
+
+        def _delete_all(return_type):
+            # type: ("AttachmentCollection") -> None
+            [a.delete_object() for a in return_type]
+
+        self.get().after_execute(_delete_all)
+        return self
+
+    def upload(self, file, use_path=True):
+        # type: (IO, bool) -> Attachment
+        """
+        Uploads the attachment
+        """
+        info = AttachmentCreationInformation(os.path.basename(file.name), file.read())
+        if use_path:
+            return self.add_using_path(info.filename, info.content)
+        else:
+            return self.add(info)
+
     def get_by_filename(self, filename):
         """Retrieve Attachment file object by filename
 

office365/sharepoint/client_context.py

@@ -410,6 +410,16 @@ class ClientContext(ClientRuntimeContext):
 
         return AnnouncementsController(self, ResourcePath("Announcements"))
 
+    @property
+    def client_people_picker(self):
+        """Query principals service alias"""
+
+        from office365.sharepoint.ui.applicationpages.peoplepicker.web_service_interface import (
+            ClientPeoplePickerWebServiceInterface,
+        )
+
+        return ClientPeoplePickerWebServiceInterface(self)
+
     @property
     def consumer_permissions(self):
         """Consumer permissions alias"""
@@ -431,6 +441,15 @@ class ClientContext(ClientRuntimeContext):
 
         return EmployeeEngagement(self)
 
+    @property
+    def directory_provider(self):
+        """Alias to SharePointDirectoryProvider"""
+        from office365.sharepoint.directory.provider.provider import (
+            SharePointDirectoryProvider,
+        )
+
+        return SharePointDirectoryProvider(self)
+
     @property
     def employee_experience(self):
         """Alias to EmployeeExperience"""
@@ -612,6 +631,16 @@ class ClientContext(ClientRuntimeContext):
 
         return SPHSite(self, ResourcePath("SPHSite"))
 
+    @property
+    def people_picker(self):
+        """Query principals service alias"""
+
+        from office365.sharepoint.ui.applicationpages.peoplepicker.web_service_interface import (
+            PeoplePickerWebServiceInterface,
+        )
+
+        return PeoplePickerWebServiceInterface(self)
+
     @property
     def publications(self):
         from office365.sharepoint.contentcenter.machinelearning.publications.publication import (

office365/sharepoint/comments/collection.py

@@ -4,7 +4,7 @@ from office365.sharepoint.comments.comment import Comment
 from office365.sharepoint.entity_collection import EntityCollection
 
 
-class CommentCollection(EntityCollection):
+class CommentCollection(EntityCollection[Comment]):
     def __init__(self, context, resource_path=None):
         super(CommentCollection, self).__init__(context, Comment, resource_path)
 

office365/sharepoint/compliance/store_proxy.py

@@ -1,3 +1,5 @@
+from typing import TYPE_CHECKING, Optional
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -5,8 +7,49 @@ from office365.runtime.types.collections import StringCollection
 from office365.sharepoint.compliance.tag import ComplianceTag
 from office365.sharepoint.entity import Entity
 
+if TYPE_CHECKING:
+    from office365.sharepoint.client_context import ClientContext
+
 
 class SPPolicyStoreProxy(Entity):
+    @staticmethod
+    def check_site_is_deletable_by_id(context, site_id, return_type=None):
+        # type: (ClientContext, str, Optional[ClientResult[bool]]) -> ClientResult[bool]
+        """ """
+        if return_type is None:
+            return_type = ClientResult(context, bool())
+        payload = {"siteId": site_id}
+        qry = ServiceOperationQuery(
+            SPPolicyStoreProxy(context),
+            "CheckSiteIsDeletableById",
+            None,
+            payload,
+            None,
+            return_type,
+            True,
+        )
+        context.add_query(qry)
+        return return_type
+
+    @staticmethod
+    def is_site_deletable(context, site_url, return_type=None):
+        # type: (ClientContext, str, Optional[ClientResult[bool]]) -> ClientResult[bool]
+        """ """
+        if return_type is None:
+            return_type = ClientResult(context, bool())
+        payload = {"siteUrl": site_url}
+        qry = ServiceOperationQuery(
+            SPPolicyStoreProxy(context),
+            "IsSiteDeletable",
+            None,
+            payload,
+            None,
+            return_type,
+            True,
+        )
+        context.add_query(qry)
+        return return_type
+
     @staticmethod
     def get_available_tags_for_site(context, site_url, return_type=None):
         """

office365/sharepoint/directory/provider/alternate_id_data.py

@@ -0,0 +1,9 @@
+from office365.runtime.client_value import ClientValue
+
+
+class AlternateIdData(ClientValue):
+    """"""
+
+    @property
+    def entity_type_name(self):
+        return "SP.Directory.Provider.AlternateIdData"

office365/sharepoint/directory/provider/notification.py

@@ -0,0 +1,15 @@
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.sharepoint.entity import Entity
+
+
+class DirectoryNotification(Entity):
+    """"""
+
+    def __init__(self, context, resource_path=None):
+        if resource_path is None:
+            resource_path = ResourcePath("SP.Directory.Provider.DirectoryNotification")
+        super(DirectoryNotification, self).__init__(context, resource_path)
+
+    @property
+    def entity_type_name(self):
+        return "SP.Directory.Provider.DirectoryNotification"

office365/sharepoint/directory/provider/object_data.py

@@ -0,0 +1,14 @@
+from office365.runtime.client_value import ClientValue
+from office365.sharepoint.directory.provider.alternate_id_data import AlternateIdData
+
+
+class DirectoryObjectData(ClientValue):
+    """"""
+
+    def __init__(self, AlternateId=AlternateIdData(), Id=None):
+        self.AlternateId = AlternateId
+        self.Id = Id
+
+    @property
+    def entity_type_name(self):
+        return "SP.Directory.Provider.DirectoryObjectData"

office365/sharepoint/directory/provider/provider.py

@@ -1,4 +1,7 @@
+from office365.runtime.client_result import ClientResult
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.directory.provider.object_data import DirectoryObjectData
 from office365.sharepoint.entity import Entity
 
 
@@ -10,6 +13,16 @@ class SharePointDirectoryProvider(Entity):
             )
         super(SharePointDirectoryProvider, self).__init__(context, resource_path)
 
+    def read_directory_object(self, data):
+        """"""
+        return_type = ClientResult(self.context, DirectoryObjectData())
+        payload = {"data": data}
+        qry = ServiceOperationQuery(
+            self, "ReadDirectoryObject", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def entity_type_name(self):
         return "SP.Directory.Provider.SharePointDirectoryProvider"

office365/sharepoint/entity.py

@@ -5,6 +5,7 @@ from typing_extensions import Self
 from office365.runtime.auth.client_credential import ClientCredential
 from office365.runtime.auth.user_credential import UserCredential
 from office365.runtime.client_object import ClientObject
+from office365.runtime.paths.v3.entity import EntityPath
 from office365.runtime.queries.delete_entity import DeleteEntityQuery
 from office365.runtime.queries.update_entity import UpdateEntityQuery
 
@@ -53,3 +54,17 @@ class Entity(ClientObject):
     @property
     def property_ref_name(self):
         return "Id"
+
+    def set_property(self, name, value, persist_changes=True):
+        super(Entity, self).set_property(name, value, persist_changes)
+        if name == self.property_ref_name:
+            if self.resource_path is None:
+                if self.parent_collection:
+                    self._resource_path = EntityPath(
+                        value, self.parent_collection.resource_path
+                    )
+                else:
+                    pass
+            else:
+                self._resource_path.patch(value)
+        return self

office365/sharepoint/features/collection.py

@@ -11,6 +11,7 @@ class FeatureCollection(EntityCollection[Feature]):
         super(FeatureCollection, self).__init__(context, Feature, resource_path, parent)
 
     def add(self, feature_id, force, featdef_scope, verify_if_activated=False):
+        # type: (str, bool, int, bool) -> Feature
         """
         Adds the feature to the collection of activated features and returns the added feature.
 
@@ -43,6 +44,7 @@ class FeatureCollection(EntityCollection[Feature]):
         return return_type
 
     def get_by_id(self, feature_id):
+        # type: (str) -> Feature
         """Returns the feature for the given feature identifier. Returns NULL if no feature is available for the given
             feature identifier.
 

office365/sharepoint/fields/date_time.py

@@ -24,3 +24,21 @@ class FieldDateTime(Field):
         # type: () -> Optional[str]
         """ """
         return self.properties.get("DateFormat", None)
+
+    @property
+    def display_format(self):
+        # type: () -> Optional[int]
+        """Specifies the type of date and time format that is used in the field"""
+        return self.properties.get("DisplayFormat", None)
+
+    @property
+    def friendly_display_format(self):
+        # type: () -> Optional[int]
+        """Gets the type of friendly display format that is used in the field"""
+        return self.properties.get("FriendlyDisplayFormat", None)
+
+    @property
+    def time_format(self):
+        # type: () -> Optional[str]
+        """Gets the time format that is used in the field"""
+        return self.properties.get("TimeFormat", None)

office365/sharepoint/fields/lookup.py

@@ -43,3 +43,23 @@ class FieldLookup(Field):
         """Sets a value that specifies the list identifier of the list that contains the field to use as
         the lookup values."""
         self.set_property("LookupList", val, True)
+
+    @property
+    def primary_field_id(self):
+        # type: () -> Optional[str]
+        """Specifies the primary lookup field identifier if this is a dependent lookup field.
+        Otherwise, it is an empty string."""
+        return self.properties.get("PrimaryFieldId", None)
+
+    @property
+    def relationship_delete_behavior(self):
+        # type: () -> Optional[int]
+        """Gets a value that specifies the relationship delete behavior of the lookup field."""
+        return self.properties.get("RelationshipDeleteBehavior", None)
+
+    @property
+    def unlimited_length_in_document_library(self):
+        # type: () -> Optional[bool]
+        """Gets or sets a Boolean value that specifies whether to allow values with unlimited text
+        in the lookup field."""
+        return self.properties.get("UnlimitedLengthInDocumentLibrary", None)

office365/sharepoint/fields/multi_line_text.py

@@ -31,3 +31,28 @@ class FieldMultiLineText(Field):
         # type: (int) -> None
         """Set the number of lines to display in the field."""
         self.set_property("NumberOfLines", val)
+
+    @property
+    def restricted_mode(self):
+        # type: () -> Optional[bool]
+        """Specifies whether the field supports a subset of rich text formatting."""
+        return self.properties.get("RestrictedMode", None)
+
+    @property
+    def rich_text(self):
+        # type: () -> Optional[bool]
+        """Specifies whether the field supports rich text formatting."""
+        return self.properties.get("RichText", None)
+
+    @property
+    def unlimited_length_in_document_library(self):
+        # type: () -> Optional[bool]
+        """Gets a Boolean value that specifies whether to allow unlimited field length in document libraries."""
+        return self.properties.get("UnlimitedLengthInDocumentLibrary", None)
+
+    @property
+    def wiki_linking(self):
+        # type: () -> Optional[bool]
+        """Specifies whether an implementation-specific mechanism for linking wiki pages is supported.
+        It MUST be "false" if RichText is "false"."""
+        return self.properties.get("WikiLinking", None)

office365/sharepoint/fields/rating_scale.py

@@ -15,11 +15,8 @@ class FieldRatingScale(FieldMultiChoice):
 
     @grid_start_number.setter
     def grid_start_number(self, value):
-        """
-        Gets the start number for the rating scale.
-
-        :type value: int
-        """
+        # type: (int) -> None
+        """Gets the start number for the rating scale."""
         self.set_property("GridStartNumber", value)
 
     @property

office365/sharepoint/fields/user_value.py

@@ -9,7 +9,7 @@ class FieldUserValue(FieldLookupValue):
 
     @staticmethod
     def from_user(user):
-        # type: (User) -> FieldUserValue
+        # type: (User) -> "FieldUserValue"
         """
         Initialize field value from User
         :param User user: User object

office365/sharepoint/files/collection.py

@@ -24,22 +24,23 @@ class FileCollection(EntityCollection[File]):
         # type: (ClientContext, ResourcePath, Folder) -> None
         super(FileCollection, self).__init__(context, File, resource_path, parent)
 
-    def upload(self, path_or_file):
-        # type: (str|IO) -> File
+    def upload(self, path_or_file, file_name=None):
+        # type: (str|IO, str) -> File
         """Uploads a file into folder.
 
         Note: This method only supports files up to 4MB in size!
         Consider create_upload_session method instead for larger files
-        :param str or typing.IO path_or_file: path where file to upload resides or file handle
+        :param str or typing.IO path_or_file: Path where file to upload resides or file handle
+        :param str file_name: New file name
         """
         if hasattr(path_or_file, "read"):
+            name = file_name or os.path.basename(path_or_file.name)
             content = path_or_file.read()
-            name = os.path.basename(path_or_file.name)
             return self.add(name, content, True)
         else:
             with open(path_or_file, "rb") as f:
                 content = f.read()
-            name = os.path.basename(path_or_file)
+            name = file_name or os.path.basename(path_or_file)
             return self.add(name, content, True)
 
     def upload_with_checksum(self, file_object, chunk_size=1024):