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

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/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
@@ -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/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/folders/folder.py

@@ -571,8 +571,8 @@ class Folder(Entity):
 
     @property
     def property_ref_name(self):
-        # type: () -> str
-        return "ServerRelativeUrl"
+        # type: () -> Optional[str]
+        return None
 
     def get_property(self, name, default_value=None):
         if default_value is None:

office365/sharepoint/multigeo/move_job_entity_data.py

@@ -0,0 +1,9 @@
+from office365.sharepoint.entity import Entity
+
+
+class MoveJobEntityData(Entity):
+    """"""
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.MultiGeo.Service.MoveJobEntityData"

office365/sharepoint/multigeo/site_move_job_entity_data.py

@@ -0,0 +1,9 @@
+from office365.sharepoint.multigeo.move_job_entity_data import MoveJobEntityData
+
+
+class SiteMoveJobEntityData(MoveJobEntityData):
+    """"""
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.MultiGeo.Service.SiteMoveJobEntityData"

office365/sharepoint/multigeo/user_personal_site_location.py

@@ -0,0 +1,9 @@
+from office365.sharepoint.entity import Entity
+
+
+class UserPersonalSiteLocation(Entity):
+    """"""
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.MultiGeo.Service.UserPersonalSiteLocation"

office365/sharepoint/permissions/securable_object.py

@@ -162,6 +162,7 @@ class SecurableObject(Entity):
 
     @property
     def first_unique_ancestor_securable_object(self):
+        # type: () -> SecurableObject
         """Specifies the object where role assignments for this object are defined"""
         return self.properties.get(
             "FirstUniqueAncestorSecurableObject",
@@ -173,6 +174,7 @@ class SecurableObject(Entity):
 
     @property
     def role_assignments(self):
+        # type: () -> RoleAssignmentCollection
         """The role assignments for the securable object."""
         return self.properties.get(
             "RoleAssignments",

office365/sharepoint/sharing/object_sharing_information.py

@@ -241,6 +241,7 @@ class ObjectSharingInformation(Entity):
 
     @property
     def sharing_links(self):
+        # type: () -> ClientValueCollection[SharingLinkInfo]
         """Indicates the collection of all available sharing links for the securable object."""
         return self.properties.get(
             "SharingLinks", ClientValueCollection(SharingLinkInfo)
@@ -248,6 +249,7 @@ class ObjectSharingInformation(Entity):
 
     @property
     def shared_with_users_collection(self):
+        # type: () -> EntityCollection[ObjectSharingInformationUser]
         """A collection of shared with users."""
         return self.properties.get(
             "SharedWithUsersCollection",

office365/sharepoint/sharing/shared_document_info.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.sharing.principal import Principal
 
@@ -7,6 +9,7 @@ class SharedDocumentInfo(Entity):
 
     @property
     def activity(self):
+        # type: () -> Optional[str]
         """"""
         return self.properties.get("Activity", None)
 
@@ -15,6 +18,12 @@ class SharedDocumentInfo(Entity):
         """"""
         return self.properties.get("Author", Principal())
 
+    @property
+    def caller_stack(self):
+        # type: () -> Optional[str]
+        """"""
+        return self.properties.get("CallerStack", None)
+
     @property
     def entity_type_name(self):
         return "SP.Sharing.SharedDocumentInfo"

office365/sharepoint/sites/version_policy_manager.py

@@ -1,5 +1,12 @@
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
 
 class SiteVersionPolicyManager(Entity):
     """"""
+
+    def set_auto_expiration(self):
+        """"""
+        qry = ServiceOperationQuery(self, "SetAutoExpiration")
+        self.context.add_query(qry)
+        return self

office365/sharepoint/tenant/administration/secondary_administrators_info.py

@@ -13,3 +13,8 @@ class SecondaryAdministratorsInfo(ClientValue):
         self.email = email
         self.loginName = loginName
         self.userPrincipalName = userPrincipalName
+
+    @property
+    def entity_type_name(self):
+        # type: () -> str
+        return "Microsoft.Online.SharePoint.TenantAdministration.SecondaryAdministratorsInfo"

office365/sharepoint/tenant/administration/tenant.py

@@ -587,6 +587,14 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return return_type
 
+    @property
+    def admin_settings(self):
+        from office365.sharepoint.tenant.administration.settings_service import (
+            TenantAdminSettingsService,
+        )
+
+        return TenantAdminSettingsService(self.context)
+
     @property
     def ai_builder_enabled(self):
         # type: () -> Optional[str]
@@ -656,6 +664,12 @@ class Tenant(Entity):
             ),
         )
 
+    @property
+    def cdn_api(self):
+        from office365.sharepoint.tenant.cdn_api import TenantCdnApi
+
+        return TenantCdnApi(self.context)
+
     @property
     def syntex_billing_subscription_settings(self):
         """"""

office365/sharepoint/tenant/cdn_api.py

@@ -1,5 +1,9 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
+from office365.sharepoint.tenant.cdn_url import TenantCdnUrl
 
 
 class TenantCdnApi(Entity):
@@ -8,6 +12,18 @@ class TenantCdnApi(Entity):
             context, ResourcePath("Microsoft.SharePoint.TenantCdn.TenantCdnApi")
         )
 
+    def get_cdn_urls(self, items=None):
+        """"""
+        payload = {
+            "items": items,
+        }
+        return_type = ClientResult(self.context, ClientValueCollection(TenantCdnUrl))
+        qry = ServiceOperationQuery(
+            self, "GetCdnUrls", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.TenantCdn.TenantCdnApi"

office365/sharepoint/tenant/management/externalusers/results/get.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.tenant.management.externalusers.collection import (
@@ -8,10 +10,12 @@ from office365.sharepoint.tenant.management.externalusers.collection import (
 class GetExternalUsersResults(Entity):
     @property
     def total_user_count(self):
+        # type: () -> Optional[int]
         return self.properties.get("TotalUserCount", None)
 
     @property
     def user_collection_position(self):
+        # type: () -> Optional[int]
         return self.properties.get("UserCollectionPosition", None)
 
     @property

office365/sharepoint/tenant/management/office365_tenant.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.client_object_collection import ClientObjectCollection
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
@@ -29,8 +31,19 @@ class Office365Tenant(Entity):
         )
         super(Office365Tenant, self).__init__(context, static_path)
 
+    @property
+    def addressbar_link_permission(self):
+        # type: () -> Optional[int]
+        return self.properties.get("AddressbarLinkPermission", None)
+
+    @property
+    def allow_comments_text_on_email_enabled(self):
+        # type: () -> Optional[bool]
+        return self.properties.get("AllowCommentsTextOnEmailEnabled", None)
+
     @property
     def allow_editing(self):
+        # type: () -> Optional[bool]
         return self.properties.get("AllowEditing", None)
 
     @property
@@ -62,6 +75,7 @@ class Office365Tenant(Entity):
 
     def disable_sharing_for_non_owners_of_site(self, site_url):
         """
+        Disables Sharing For Non Owners
         :param str site_url:
         """
         payload = {"siteUrl": site_url}

office365/sharepoint/ui/applicationpages/peoplepicker/web_service_interface.py

@@ -16,39 +16,6 @@ from office365.sharepoint.ui.applicationpages.peoplepicker.query_parameters impo
 class ClientPeoplePickerWebServiceInterface(Entity):
     """Specifies an interface that can be used to query principals."""
 
-    @staticmethod
-    def get_search_results(
-        context,
-        search_pattern,
-        provider_id=None,
-        hierarchy_node_id=None,
-        entity_types=None,
-    ):
-        """
-        Specifies a JSON formatted CSOM String of principals found in the search.
-
-        :type context: office365.sharepoint.client_context.ClientContext
-        :param str search_pattern: Specifies a pattern used to search for principals.
-            The value is implementation-specific.
-        :param str provider_id: The identifier of a claims provider.
-        :param str hierarchy_node_id: The identifier of a node in the hierarchy. The search MUST be conducted under
-            this node.
-        :param str entity_types: The type of principals to search for.
-        """
-        return_type = ClientResult(context, str())
-        payload = {
-            "searchPattern": search_pattern,
-            "providerID": provider_id,
-            "hierarchyNodeID": hierarchy_node_id,
-            "entityTypes": entity_types,
-        }
-        svc = ClientPeoplePickerWebServiceInterface(context)
-        qry = ServiceOperationQuery(
-            svc, "GetSearchResults", None, payload, None, return_type, True
-        )
-        context.add_query(qry)
-        return return_type
-
     @staticmethod
     def get_search_results_by_hierarchy(
         context,
@@ -167,3 +134,42 @@ class ClientPeoplePickerWebServiceInterface(Entity):
     @property
     def entity_type_name(self):
         return "SP.UI.ApplicationPages.ClientPeoplePickerWebServiceInterface"
+
+
+class PeoplePickerWebServiceInterface(Entity):
+    @staticmethod
+    def get_search_results(
+        context,
+        search_pattern,
+        provider_id=None,
+        hierarchy_node_id=None,
+        entity_types=None,
+    ):
+        """
+        Specifies a JSON formatted CSOM String of principals found in the search.
+
+        :type context: office365.sharepoint.client_context.ClientContext
+        :param str search_pattern: Specifies a pattern used to search for principals.
+            The value is implementation-specific.
+        :param str provider_id: The identifier of a claims provider.
+        :param str hierarchy_node_id: The identifier of a node in the hierarchy. The search MUST be conducted under
+            this node.
+        :param str entity_types: The type of principals to search for.
+        """
+        return_type = ClientResult(context, str())
+        payload = {
+            "searchPattern": search_pattern,
+            "providerID": provider_id,
+            "hierarchyNodeID": hierarchy_node_id,
+            "entityTypes": entity_types,
+        }
+        svc = PeoplePickerWebServiceInterface(context)
+        qry = ServiceOperationQuery(
+            svc, "GetSearchResults", None, payload, None, return_type, True
+        )
+        context.add_query(qry)
+        return return_type
+
+    @property
+    def entity_type_name(self):
+        return "SP.UI.ApplicationPages.PeoplePickerWebServiceInterface"