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

office365/sharepoint/sharing/object_sharing_settings.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.sharing.object_sharing_information import (
@@ -18,84 +20,64 @@ class ObjectSharingSettings(Entity):
 
     @property
     def web_url(self):
-        """
-        The URL pointing to the containing SP.Web object.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """The URL pointing to the containing SP.Web object."""
         return self.properties.get("WebUrl", None)
 
     @property
     def access_request_mode(self):
-        """
-        Boolean indicating whether the sharing context operates under the access request mode.
-        :rtype: bool
-        """
+        # type: () -> Optional[bool]
+        """Boolean indicating whether the sharing context operates under the access request mode."""
         return self.properties.get("AccessRequestMode", None)
 
     @property
     def block_people_picker_and_sharing(self):
-        """
-        Boolean indicating whether the current user can use the People Picker to do any sharing.
-        :rtype: bool
-        """
+        # type: () -> Optional[bool]
+        """Boolean indicating whether the current user can use the People Picker to do any sharing."""
         return self.properties.get("BlockPeoplePickerAndSharing", None)
 
     @property
     def can_current_user_manage_organization_readonly_link(self):
-        """
-        Boolean indicating whether the current user can create or disable an organization View link.
-        :rtype: bool
-        """
+        # type: () -> Optional[bool]
+        """Boolean indicating whether the current user can create or disable an organization View link."""
         return self.properties.get("CanCurrentUserManageOrganizationReadonlyLink", None)
 
     @property
     def can_current_user_manage_organization_read_write_link(self):
-        """
-        Boolean indicating whether the current user can create or disable an organization Edit link.
-        :rtype: bool
-        """
+        # type: () -> Optional[bool]
+        """Boolean indicating whether the current user can create or disable an organization Edit link."""
         return self.properties.get(
             "CanCurrentUserManageOrganizationReadWriteLink", None
         )
 
     @property
     def can_current_user_manage_readonly_link(self):
-        """
-        Boolean indicating whether the current user can create or disable an anonymous View link.
-        :rtype: bool
-        """
+        # type: () -> Optional[bool]
+        """Boolean indicating whether the current user can create or disable an anonymous View link."""
         return self.properties.get("CanCurrentUserManageReadonlyLink", None)
 
     @property
     def can_send_email(self):
-        """
-        Boolean indicating whether email invitations can be sent.
-        :rtype: bool
-        """
+        # type: () -> Optional[bool]
+        """Boolean indicating whether email invitations can be sent."""
         return self.properties.get("CanSendEmail", None)
 
     @property
     def can_send_link(self):
-        """
-        Boolean indicating whether the current user can make use of Share-By-Link.
-        :rtype: bool
-        """
+        # type: () -> Optional[bool]
+        """Boolean indicating whether the current user can make use of Share-By-Link."""
         return self.properties.get("CanSendLink", None)
 
     @property
     def is_user_site_admin(self):
-        """
-        Boolean that indicates whether or not the current user is a site collection administrator.
-        :return: bool
-        """
+        # type: () -> Optional[bool]
+        """Boolean that indicates whether or not the current user is a site collection administrator"""
         return self.properties.get("IsUserSiteAdmin", None)
 
     @property
     def list_id(self):
-        """
-        The unique ID of the parent list (if applicable).
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """The unique ID of the parent list (if applicable)."""
         return self.properties.get("ListId", None)
 
     @property
@@ -120,9 +102,7 @@ class ObjectSharingSettings(Entity):
 
     @property
     def sharepoint_settings(self):
-        """
-        An object that contains the SharePoint UI specific sharing settings.
-        """
+        """An object that contains the SharePoint UI specific sharing settings."""
         return self.properties.get(
             "SharePointSettings",
             SharePointSharingSettings(
@@ -132,9 +112,7 @@ class ObjectSharingSettings(Entity):
 
     @property
     def sharing_permissions(self):
-        """
-        A list of SharingPermissionInformation objects that can be used to share.
-        """
+        """A list of SharingPermissionInformation objects that can be used to share."""
         return self.properties.get(
             "SharingPermissions",
             SharingPermissionInformation(

office365/sharepoint/sharing/permission_collection.py

@@ -1,4 +1,7 @@
 from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.sharepoint.sharing.link_info import LinkInfo
+from office365.sharepoint.utilities.principal_info import PrincipalInfo
 
 
 class PermissionCollection(ClientValue):
@@ -9,6 +12,21 @@ class PermissionCollection(ClientValue):
     implicit access.
     """
 
+    def __init__(
+        self, hasInheritedLinks=None, links=None, principals=None, siteAdmins=None
+    ):
+        """
+        :param bool hasInheritedLinks:
+        :param list[LinkInfo] links: The List of tokenized sharing links with their LinkInfo objects.
+        :param list[PrincipalInfo] principals: The List of Principals with their roles on this list item.
+        :param list[PrincipalInfo] siteAdmins: The List of Principals who are Site Admins. This property is returned
+            only if the caller is an Auditor.
+        """
+        self.hasInheritedLinks = hasInheritedLinks
+        self.links = ClientValueCollection(LinkInfo, links)
+        self.principals = ClientValueCollection(PrincipalInfo, principals)
+        self.siteAdmins = ClientValueCollection(PrincipalInfo, siteAdmins)
+
     @property
     def entity_type_name(self):
         return "SP.Sharing.PermissionCollection"

office365/sharepoint/sharing/permission_information.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
@@ -8,6 +10,7 @@ class SharingPermissionInformation(Entity):
 
     @property
     def is_default_permission(self):
+        # type: () -> Optional[bool]
         """
         Identifies whether or not the permission entity is a default SP.Group or role (meaning it is recommended
         for granting permissions).
@@ -20,16 +23,13 @@ class SharingPermissionInformation(Entity):
         For granting permissions to a file or other non-site object, there can be two default permission entities:
         a role for view permissions (StandardViewerRoleDefinitionID) and a role for edit permissions
         (StandardEditorRoleDefinitionID).
-
-        :rtype: bool or None
         """
         return self.properties.get("IsDefaultPermission", None)
 
     @property
     def permission_id(self):
-        """Gets the ID of this permission in the following formats: group:x, role: xxxxxx.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the ID of this permission in the following formats: group:x, role: xxxxxx."""
         return self.properties.get("PermissionId", None)
 
     @property

office365/sharepoint/sharing/result.py

@@ -91,6 +91,7 @@ class SharingResult(Entity):
             property_mapping = {
                 "GroupsSharedWith": self.groups_shared_with,
                 "UsersAddedToGroup": self.users_added_to_group,
+                "UniquelyPermissionedUsers": self.uniquely_permissioned_users,
             }
             default_value = property_mapping.get(name, None)
         return super(SharingResult, self).get_property(name, default_value)

office365/sharepoint/sitedesigns/run.py

@@ -1,12 +1,13 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
 class SiteDesignRun(Entity):
     @property
     def site_design_id(self):
-        """
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """"""
         return self.properties.get("SiteDesignID", None)
 
     @property

office365/sharepoint/sites/script_safe_domain.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.entity import Entity
+
+
+class ScriptSafeDomain(Entity):
+    """"""

office365/sharepoint/sites/site.py

@@ -219,7 +219,9 @@ class Site(Entity):
             specified in the orderBy parameter. A value of true indicates ascending order, and a value of false
             indicates descending order.
         """
-        return_type = RecycleBinItemCollection(self.context)
+        return_type = RecycleBinItemCollection(
+            self.context, self.recycle_bin.resource_path
+        )
         payload = {"rowLimit": row_limit, "isAscending": is_ascending}
         qry = ServiceOperationQuery(
             self, "GetRecycleBinItems", None, payload, None, return_type
@@ -228,9 +230,7 @@ class Site(Entity):
         return return_type
 
     def get_site_administrators(self):
-        """
-        Gets site collection administrators
-        """
+        """Gets site collection administrators"""
         return_type = ClientResult(
             self.context, ClientValueCollection(SiteAdministratorsInfo)
         )
@@ -521,6 +521,12 @@ class Site(Entity):
         """
         return self.properties.get("CanUpgrade", None)
 
+    @property
+    def channel_group_id(self):
+        # type: () -> Optional[str]
+        """ """
+        return self.properties.get("ChannelGroupId", None)
+
     @property
     def classification(self):
         # type: () -> Optional[str]
@@ -621,25 +627,20 @@ class Site(Entity):
 
     @property
     def trim_audit_log(self):
-        """
-        When this flag is set for the site, the audit events are trimmed periodically.
-        :rtype: bool or none
-        """
+        # type: () -> Optional[bool]
+        """When this flag is set for the site, the audit events are trimmed periodically."""
         return self.properties.get("TrimAuditLog", None)
 
     @property
     def write_locked(self):
-        """
-        :rtype: bool or none
-        """
+        # type: () -> Optional[bool]
+        """ """
         return self.properties.get("WriteLocked", None)
 
     @property
     def id(self):
         # type: () -> Optional[str]
-        """
-        Specifies the GUID that identifies the site collection.
-        """
+        """Specifies the GUID that identifies the site collection."""
         return self.properties.get("Id", None)
 
     @property
@@ -651,9 +652,7 @@ class Site(Entity):
     @property
     def is_hub_site(self):
         # type: () -> Optional[bool]
-        """
-        Returns whether the specified site is a hub site
-        """
+        """Returns whether the specified site is a hub site"""
         return self.properties.get("IsHubSite", None)
 
     @property
@@ -665,9 +664,7 @@ class Site(Entity):
     @property
     def status_bar_link(self):
         # type: () -> Optional[str]
-        """
-        Gets the status bar message link target for this site.
-        """
+        """Gets the status bar message link target for this site."""
         return self.properties.get("StatusBarLink", None)
 
     @property

office365/sharepoint/taxonomy/field.py

@@ -1,4 +1,5 @@
 import uuid
+from typing import Optional
 
 from office365.sharepoint.fields.lookup import FieldLookup
 from office365.sharepoint.taxonomy.create_xml_parameters import (
@@ -9,6 +10,20 @@ from office365.sharepoint.taxonomy.create_xml_parameters import (
 class TaxonomyField(FieldLookup):
     """Represents a taxonomy field."""
 
+    def set_field_value_by_value(self, item, tax_value):
+        """
+        Sets the value of the corresponding field in the list item to the value of the specified TaxonomyFieldValue
+        :param ListItem item: The ListItem object whose field is to be updated.
+        :param TaxonomyFieldValue tax_value:  The TaxonomyFieldValue object whose value is to be used to
+            update this field.
+        """
+
+        def _set_field_value_by_value():
+            item.set_property(self.internal_name, tax_value)
+
+        self.ensure_property("InternalName", _set_field_value_by_value)
+        return self
+
     @staticmethod
     def create(
         fields,
@@ -77,103 +92,99 @@ class TaxonomyField(FieldLookup):
 
     @property
     def anchor_id(self):
-        """Gets or sets the GUID of the anchor Term object for a TaxonomyField object.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets or sets the GUID of the anchor Term object for a TaxonomyField object."""
         return self.properties.get("AnchorId", None)
 
     @property
     def create_values_in_edit_form(self):
+        # type: () -> Optional[bool]
         """
         Specifies a Boolean value that specifies whether the new Term  objects can be added to the
         TermSet while typing in the TaxonomyField editor control.
-        :rtype: bool or None
         """
         return self.properties.get("CreateValuesInEditForm", None)
 
     @property
     def is_anchor_valid(self):
-        """Gets a Boolean value that specifies whether the Term object identified by the AnchorId property is valid.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Gets a Boolean value that specifies whether the Term object identified by the AnchorId property is valid."""
         return self.properties.get("IsAnchorValid", None)
 
     @property
     def is_doc_tags_enabled(self):
-        """
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """ """
         return self.properties.get("IsDocTagsEnabled", None)
 
     @property
     def is_keyword(self):
+        # type: () -> Optional[bool]
         """
         Specifies a Boolean value that indicates whether the TaxonomyField value points to the
         keywords term set  object.
-        :rtype: bool or None
         """
         return self.properties.get("IsKeyword", None)
 
     @property
     def is_path_rendered(self):
+        # type: () -> Optional[bool]
         """
         Specifies a Boolean value that specifies whether the default Label objects of all the parent
         Term objects of a Term in the TaxonomyField object will be rendered in
         addition to the default label of that Term.
-        :rtype: bool or None
         """
         return self.properties.get("IsPathRendered", None)
 
     @property
     def is_term_set_valid(self):
+        # type: () -> Optional[bool]
         """
         Gets a Boolean value that specifies whether the TermSet object identified by the TermSetId
         property exists and is available for tagging.
-        :rtype: bool or None
         """
         return self.properties.get("IsTermSetValid", None)
 
     @property
     def open(self):
+        # type: () -> Optional[bool]
         """
         Specifies a Boolean value that specifies whether the TaxonomyField object is linked to an
         open TermSet (section 3.1.5.20) object or a closed TermSet.
-        :rtype: bool or None
         """
         return self.properties.get("Open", None)
 
     @property
     def ssp_id(self):
+        # type: () -> Optional[str]
         """
         Specifies the GUID that identifies the TermStore object, which contains the Enterprise
         keywords for the site that the current TaxonomyField belongs to.
-        :rtype: str or None
         """
         return self.properties.get("SspId", None)
 
     @property
     def target_template(self):
+        # type: () -> Optional[str]
         """
         Specifies the Web-relative Uniform Resource Locator (URL) of the target page that is used to construct the
         hyperlink on each Term object when the TaxonomyField (section 3.1.5.27) object is rendered.
-        :rtype: str or None
         """
         return self.properties.get("TargetTemplate", None)
 
     @property
     def term_set_id(self):
+        # type: () -> Optional[str]
         """
         Specifies the GUID of the TermSet object that contains the Term
         objects used by the current TaxonomyField () object.
-        :rtype: str or None
         """
         return self.properties.get("TermSetId", None)
 
     @property
     def text_field_id(self):
-        """Gets the GUID that identifies the hidden text field in an item.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the GUID that identifies the hidden text field in an item."""
         return self.properties.get("TextField", None)
 
     @property
@@ -185,10 +196,10 @@ class TaxonomyField(FieldLookup):
 
     @property
     def user_created(self):
+        # type: () -> Optional[bool]
         """
         Specifies a Boolean value that specifies whether the TaxonomyField object is linked to a
         customized TermSet object.
-        :rtype: bool or None
         """
         return self.properties.get("UserCreated", None)
 

office365/sharepoint/taxonomy/field_value.py

@@ -25,7 +25,7 @@ class TaxonomyFieldValue(ClientValue):
         return "SP.Taxonomy.TaxonomyFieldValue"
 
 
-class TaxonomyFieldValueCollection(ClientValueCollection):
+class TaxonomyFieldValueCollection(ClientValueCollection[TaxonomyFieldValue]):
     """Represents the multi-value object for the taxonomy column."""
 
     def __init__(self, initial_values):

office365/sharepoint/taxonomy/groups/group.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.taxonomy.item import TaxonomyItem
 from office365.sharepoint.taxonomy.item_collection import TaxonomyItemCollection
@@ -8,6 +10,9 @@ from office365.sharepoint.taxonomy.sets.set import TermSet
 class TermGroup(TaxonomyItem):
     """Represents the top-level container in a TermStore object."""
 
+    def __str__(self):
+        return self.display_name or self.entity_type_name
+
     def get_term_sets_by_name(self, label, lcid=None):
         """
         Search term set by name
@@ -26,7 +31,7 @@ class TermGroup(TaxonomyItem):
             ]
 
         def _group_resolved():
-            self.context.load(self.term_sets, after_loaded=_sets_loaded)
+            self.term_sets.get().after_execute(_sets_loaded)
 
         self.ensure_property("id", _group_resolved)
         return return_type
@@ -44,6 +49,12 @@ class TermGroup(TaxonomyItem):
             ),
         )
 
+    @property
+    def display_name(self):
+        # type: () -> Optional[str]
+        """Gets the name of the Term Group"""
+        return self.properties.get("displayName", None)
+
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {"termSets": self.term_sets}

office365/sharepoint/taxonomy/sets/set.py

@@ -9,6 +9,12 @@ from office365.sharepoint.taxonomy.terms.term import Term
 class TermSet(TaxonomyItem):
     """Represents a hierarchical or flat set of Term objects known as a 'TermSet'."""
 
+    def __repr__(self):
+        if self.is_property_available("localizedNames"):
+            return repr(self.localized_names[0])
+        else:
+            return self.entity_type_name
+
     @property
     def localized_names(self):
         return self.properties.get(

office365/sharepoint/taxonomy/stores/store.py

@@ -26,10 +26,12 @@ class TermStore(TaxonomyItem):
 
         def _groups_loaded(col):
             # type: (TermGroupCollection) -> None
-            for grp in col:
+            [
                 grp.get_term_sets_by_name(label, lcid).after_execute(_sets_loaded)
+                for grp in col
+            ]
 
-        self.context.load(self.term_groups, after_loaded=_groups_loaded)
+        self.term_groups.get().after_execute(_groups_loaded)
         return return_type
 
     def search_term(self, label, set_id=None, parent_term_id=None, language_tag=None):

office365/sharepoint/teams/channel.py

@@ -1,17 +1,17 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
 class TeamChannel(Entity):
     @property
     def folder_id(self):
-        """
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """ """
         return self.properties.get("folderId", None)
 
     @property
     def group_id(self):
-        """
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """ """
         return self.properties.get("groupId", None)

office365/sharepoint/tenant/administration/endpoints.py

@@ -1,12 +1,13 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
 class TenantAdminEndpoints(Entity):
     @property
     def o365_admin_center_endpoint(self):
-        """
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """"""
         return self.properties.get("O365AdminCenterEndpoint", None)
 
     @property

office365/sharepoint/tenant/administration/hubsites/properties.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.tenant.administration.hubsites.permission import (
@@ -14,11 +16,8 @@ class HubSiteProperties(Entity):
 
     @property
     def site_id(self):
-        """
-        Returns the Site identifier
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Returns the Site identifier"""
         return self.properties.get("SiteId", None)
 
     @property

office365/sharepoint/tenant/administration/powerapps/environment_context.py

@@ -0,0 +1,8 @@
+from office365.runtime.client_value import ClientValue
+
+
+class PowerAppsEnvironmentContext(ClientValue):
+    @property
+    def entity_type_name(self):
+        # type: () -> str
+        return "Microsoft.Online.SharePoint.TenantAdministration.PowerAppsEnvironmentContext"

office365/sharepoint/tenant/administration/sites/properties.py

@@ -108,7 +108,6 @@ class SiteProperties(Entity):
             - ExternalUserSharingOnly - External user sharing (share by email) is enabled, but guest link sharing
                  is disabled.
             - ExistingExternalUserSharingOnly - Only guests already in your organization's directory.
-        :rtype: int
         """
         return self.properties.get("SharingCapability", None)
 

office365/sharepoint/tenant/administration/spo_operation.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.client_object import ClientObject
 
 
@@ -6,10 +8,8 @@ class SpoOperation(ClientObject):
 
     @property
     def has_timedout(self):
-        """
-        Gets a value that indicates whether the maximum wait time for the operation has been exceeded.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Gets a value that indicates whether the maximum wait time for the operation has been exceeded."""
         return self.properties.get("HasTimedout", None)
 
     @property

office365/sharepoint/tenant/administration/tenant.py

@@ -335,6 +335,7 @@ class Tenant(Entity):
         return return_type
 
     def _poll_site_status(self, site_url, polling_interval_secs):
+        # type: (str, int) -> None
         states = [0, 1, 2]
         time.sleep(polling_interval_secs)