Office365-REST-Python-Client 2.5.1__py3-none-any.whl → 2.5.3__py3-none-any.whl

office365/sharepoint/search/service.py

@@ -133,17 +133,19 @@ class SearchService(Entity):
             "rankingModelId": ranking_model_id,
             "startRow": start_row,
             "rowsPerPage": rows_per_page,
-            "selectProperties": str(StringCollection(select_properties)),
-            "refinementFilters": str(StringCollection(refinement_filters)),
-            "refiners": str(StringCollection(refiners)),
-            "sortList": str(StringCollection([str(s) for s in sort_list]))
-            if sort_list
-            else None,
             "trimDuplicates": trim_duplicates,
             "rowLimit": row_limit,
             "enableQueryRules": enable_query_rules,
             "enableSorting": enable_sorting,
         }
+        if refinement_filters:
+            params["refinementFilters"] = str(StringCollection(refinement_filters))
+        if sort_list:
+            params["sortList"] = str(StringCollection([str(s) for s in sort_list]))
+        if select_properties:
+            params["selectProperties"] = str(StringCollection(select_properties))
+        if refiners:
+            params["refiners"] = str(StringCollection(refiners))
         params.update(**kwargs)
         return_type = ClientResult(
             self.context, SearchResult()

office365/sharepoint/sharing/links/info.py

@@ -17,6 +17,7 @@ class SharingLinkInfo(ClientValue):
         last_modified_by=Principal(),
         password_last_modified_by=Principal(),
         track_link_users=None,
+        share_token_string=None,
         url=None,
     ):
         """
@@ -36,6 +37,7 @@ class SharingLinkInfo(ClientValue):
              This value MUST be null if the last modified by value is not recorded.
         :param Principal password_last_modified_by:
         :param bool track_link_users:
+        :param str share_token_string:
         """
         super(SharingLinkInfo, self).__init__()
         self.AllowsAnonymousAccess = allows_anonymous_access
@@ -48,13 +50,14 @@ class SharingLinkInfo(ClientValue):
         self.LastModifiedBy = last_modified_by
         self.PasswordLastModifiedBy = password_last_modified_by
         self.TrackLinkUsers = track_link_users
+        self.ShareTokenString = share_token_string
         self.Url = url
 
     def __str__(self):
-        return self.Url
+        return self.Url or ""
 
     def __repr__(self):
-        return self.Url or ""
+        return self.Url or self.entity_type_name
 
     @property
     def entity_type_name(self):

office365/sharepoint/sharing/links/share_response.py

@@ -13,6 +13,9 @@ class ShareLinkResponse(ClientValue):
         """
         self.sharingLinkInfo = sharing_link_info
 
+    def __str__(self):
+        return self.sharingLinkInfo.Url
+
     @property
     def entity_type_name(self):
         return "SP.Sharing.ShareLinkResponse"

office365/sharepoint/sharing/links/share_settings.py

@@ -15,6 +15,7 @@ class ShareLinkSettings(ClientValue):
         role=None,
         track_link_users=None,
         share_id=None,
+        update_password=None,
     ):
         """
         :param bool allow_anonymous_access: Indicates if the tokenized sharing link supports anonymous access.
@@ -33,6 +34,7 @@ class ShareLinkSettings(ClientValue):
         :param bool track_link_users:
         :param str share_id: The optional unique identifier of an existing section tokenized sharing link to be
              retrieved and updated if necessary.
+        :param bool update_password:
         """
         self.allowAnonymousAccess = allow_anonymous_access
         self.applicationLink = application_link
@@ -43,6 +45,7 @@ class ShareLinkSettings(ClientValue):
         self.role = role
         self.shareId = share_id
         self.trackLinkUsers = track_link_users
+        self.updatePassword = update_password
 
     @property
     def entity_type_name(self):

office365/sharepoint/sharing/object_sharing_information.py

@@ -1,3 +1,5 @@
+from typing import TYPE_CHECKING
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
@@ -9,6 +11,11 @@ from office365.sharepoint.sharing.object_sharing_information_user import (
     ObjectSharingInformationUser,
 )
 
+if TYPE_CHECKING:
+    from typing import Optional  # noqa
+
+    from office365.sharepoint.client_context import ClientContext  # noqa
+
 
 class ObjectSharingInformation(Entity):
     """Provides information about the sharing state of a securable object."""
@@ -123,26 +130,27 @@ class ObjectSharingInformation(Entity):
         check_for_access_requests=False,
         return_type=None,
     ):
+        # type: (ClientContext, str, int, Optional[bool], Optional[bool], Optional[bool], Optional[bool], Optional[bool], Optional[bool], Optional[ObjectSharingInformation]) -> ObjectSharingInformation
         """
         Retrieves information about the sharing state for a given list.
 
-        :param bool check_for_access_requests: Specifies whether the returned sharing state information will contain a URL
+        :param check_for_access_requests: Specifies whether the returned sharing state information will contain a URL
         to a location which describes any access requests present in the site (2), if such a URL is available.
-        :param bool retrieve_user_info_details: Specifies whether the returned sharing state information will contain
+        :param retrieve_user_info_details: Specifies whether the returned sharing state information will contain
         basic or detailed information about the users with permissions to the list item.
-        :param bool retrieve_anonymous_links: Specifies whether the returned sharing state information will contain
+        :param retrieve_anonymous_links: Specifies whether the returned sharing state information will contain
         information about a URL that allows an anonymous user to access the list item.
-        :param bool exclude_security_groups: Specifies whether the returned sharing state information will exclude
+        :param exclude_security_groups: Specifies whether the returned sharing state information will exclude
         information about security groups which have permissions to the list item.
-        :param bool exclude_site_admin:  Specifies whether the returned sharing state information will exclude
+        :param exclude_site_admin:  Specifies whether the returned sharing state information will exclude
         information about users who are site collection administrators of the site collection which contains the list.
-        :param bool exclude_current_user: Specifies whether the returned sharing state information will exclude
+        :param exclude_current_user: Specifies whether the returned sharing state information will exclude
         information about the user making the request.
-        :param int item_id: The list item identifier for the list item for which the sharing state is requested.
-        :param str list_id: The list identifier for the list which contains the list item for which
+        :param item_id: The list item identifier for the list item for which the sharing state is requested.
+        :param list_id: The list identifier for the list which contains the list item for which
         the sharing state is requested.
-        :param office365.sharepoint.client_context.ClientContext context: SharePoint client context
-        :param ObjectSharingInformation return_type: Return type
+        :param context: SharePoint client context
+        :param return_type: Return type
         """
         binding_type = ObjectSharingInformation(context)
         payload = {
@@ -171,65 +179,63 @@ class ObjectSharingInformation(Entity):
 
     @property
     def anonymous_edit_link(self):
+        # type: () -> Optional[str]
         """
         Provides the URL that allows an anonymous user to edit the securable object.
         If such a URL is not available, this property will provide an empty string.
-
-        :rtype: str
         """
         return self.properties.get("AnonymousEditLink", None)
 
     @property
     def anonymous_view_link(self):
+        # type: () -> Optional[str]
         """
         Provides the URL that allows an anonymous user to view the securable object.
         If such a URL is not available, this property will provide an empty string.
-
-        :rtype: str
         """
         return self.properties.get("AnonymousViewLink", None)
 
     @property
     def can_be_shared(self):
+        # type: () -> Optional[bool]
         """
         Indicates whether the current securable object can be shared.
-        :rtype: bool
         """
         return self.properties.get("CanBeShared", None)
 
     @property
     def can_be_unshared(self):
+        # type: () -> Optional[bool]
         """
         Indicates whether the current securable object can be unshared.
-        :rtype: bool
         """
         return self.properties.get("CanBeUnshared", None)
 
     @property
     def can_manage_permissions(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether the current user is allowed to change the permissions of the securable object.
-        :rtype: bool
         """
         return self.properties.get("CanManagePermissions", None)
 
     @property
     def has_pending_access_requests(self):
+        # type: () -> Optional[bool]
         """
         Provides information about whether there are any pending access requests for the securable object.
 
         This information is only provided if the current user has sufficient permissions to view any pending
         access requests. If the current user does not have such permissions, this property will return false.
-        :rtype: bool
         """
         return self.properties.get("HasPendingAccessRequests", None)
 
     @property
     def has_permission_levels(self):
+        # type: () -> Optional[bool]
         """
         Indicates whether the object sharing information contains permissions information in addition to the identities
         of the users who have access to the securable object.
-        :rtype: bool
         """
         return self.properties.get("HasPermissionLevels", None)
 

office365/sharepoint/sharing/object_sharing_information_user.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.principal.principal import Principal
@@ -9,42 +11,31 @@ class ObjectSharingInformationUser(Entity):
 
     @property
     def email(self):
-        """
-        Specifies the email address for the user.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the email address for the user."""
         return self.properties.get("Email", None)
 
     @property
     def sip_address(self):
-        """
-        Specifies the SIP address of the user.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the SIP address of the user."""
         return self.properties.get("SipAddress", None)
 
     @property
     def login_name(self):
-        """
-        Specifies the login name for the principal.
-        """
+        # type: () -> Optional[str]
+        """Specifies the login name for the principal."""
         return self.properties.get("LoginName", None)
 
     def principal(self):
-        """
-        The principal with whom a securable object is shared. It is either a user or a group.
-        """
+        """The principal with whom a securable object is shared. It is either a user or a group."""
         return self.properties.get(
             "Principal",
             Principal(self.context, ResourcePath("Principal", self.resource_path)),
         )
 
     def user(self):
-        """
-        Specifies the user with whom a securable object is shared.
-        """
+        """Specifies the user with whom a securable object is shared."""
         return self.properties.get(
             "User", User(self.context, ResourcePath("User", self.resource_path))
         )

office365/sharepoint/sharing/result.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.entity import Entity
@@ -13,63 +15,48 @@ class SharingResult(Entity):
 
     @property
     def url(self):
-        """Gets the URL of the securable object being shared.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the URL of the securable object being shared."""
         return self.properties.get("Url", None)
 
     @property
     def error_message(self):
-        """Gets an error message about the failure if sharing was unsuccessful.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets an error message about the failure if sharing was unsuccessful."""
         return self.properties.get("ErrorMessage", None)
 
     @property
     def name(self):
-        """
-        Gets the name of the securable object being shared.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the name of the securable object being shared."""
         return self.properties.get("Name", None)
 
     @property
     def icon_url(self):
-        """
-        Gets a URL to an icon that represents the securable object, if one exists.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets a URL to an icon that represents the securable object, if one exists."""
         return self.properties.get("IconUrl", None)
 
     @property
     def status_code(self):
+        # type: () -> Optional[int]
         """
         Gets the enumeration value which summarizes the result of the sharing operation.
-
-        :rtype: int or None
         """
         return self.properties.get("StatusCode", None)
 
     @property
     def permissions_page_relative_url(self):
-        """
-        Gets the relative URL of the page that shows permissions.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the relative URL of the page that shows permissions."""
         return self.properties.get("PermissionsPageRelativeUrl", None)
 
     @property
     def invited_users(self):
+        # type: () ->  ClientValueCollection[SPInvitationCreationResult]
         """
         Gets a list of SPInvitationCreationResult (section 3.2.5.325) objects representing the external users being
         invited to have access.
-
-        :rtype: ClientValueCollection
         """
         return self.properties.get(
             "InvitedUsers", ClientValueCollection(SPInvitationCreationResult)
@@ -77,20 +64,13 @@ class SharingResult(Entity):
 
     @property
     def uniquely_permissioned_users(self):
-        """
-
-        :rtype: ClientValueCollection
-        """
+        # type: () ->  ClientValueCollection[UserSharingResult]
         return self.properties.get(
             "UniquelyPermissionedUsers", ClientValueCollection(UserSharingResult)
         )
 
     @property
     def groups_shared_with(self):
-        """
-
-        :rtype: ClientValueCollection
-        """
         return self.properties.get(
             "GroupsSharedWith",
             GroupCollection(
@@ -100,11 +80,8 @@ class SharingResult(Entity):
 
     @property
     def users_added_to_group(self):
-        """
-        Gets the list of users being added to the SharePoint permissions group.
-
-        :rtype: ClientValueCollection
-        """
+        # type: () ->  ClientValueCollection[UserSharingResult]
+        """Gets the list of users being added to the SharePoint permissions group."""
         return self.properties.get(
             "UsersAddedToGroup", ClientValueCollection(UserSharingResult)
         )
@@ -124,5 +101,5 @@ class SharingResult(Entity):
         if self._resource_path is None:
             if name == "Name":
                 pass
-                # self._resource_path = ResourcePath(value, self._parent_collection.resource_path)
+                # self._resource_path = ResourcePath(value, self.parent_collection.resource_path)
         return self

office365/sharepoint/sharing/role.py

@@ -0,0 +1,20 @@
+from office365.runtime.client_value import ClientValue
+
+
+class Role(ClientValue):
+    """
+    Specifies a set of abstract roles that a user can be assigned to share a securable object in a document library
+    """
+
+    View = 1
+    """The user can only read a securable object."""
+
+    Edit = 2
+    """The user can edit or read a securable object, but cannot delete it."""
+
+    Owner = 3
+    """The user is an owner of a securable object and can manage permissions, and edit, read or delete the object."""
+
+    @property
+    def entity_type_name(self):
+        return "SP.Sharing.Role"

office365/sharepoint/sharing/role_type.py

@@ -55,6 +55,7 @@ class RoleType:
         the following: ViewPages, ViewListItems and ViewItemsRequiresOpen."""
 
     RestrictedReader = 8
+    """"""
 
     System = 255
     """For SharePoint internal use only. System roles can not be deleted, nor modified."""

office365/sharepoint/sharing/user_sharing_result.py

@@ -1,5 +1,7 @@
 from office365.runtime.client_value import ClientValue
 from office365.runtime.client_value_collection import ClientValueCollection
+from office365.runtime.odata.type import ODataType
+from office365.sharepoint.sharing.role import Role
 
 
 class UserSharingResult(ClientValue):
@@ -42,6 +44,16 @@ class UserSharingResult(ClientValue):
         self.Status = status
         self.User = user
 
+    @property
+    def current_role_name(self):
+        return ODataType.resolve_enum_key(Role, self.CurrentRole)
+
     @property
     def entity_type_name(self):
         return "SP.Sharing"
+
+    def __str__(self):
+        return "{0}: {1}".format(self.User, self.current_role_name)
+
+    def __repr__(self):
+        return "{0}: {1}".format(self.User, self.current_role_name)

office365/sharepoint/sites/language.py

@@ -13,3 +13,9 @@ class Language(ClientValue):
         self.DisplayName = display_name
         self.LanguageTag = language_tag
         self.Lcid = lcid
+
+    def __str__(self):
+        return self.DisplayName
+
+    def __repr__(self):
+        return "{0}: {1}".format(self.DisplayName, self.LanguageTag)

office365/sharepoint/sites/language_collection.py

@@ -15,6 +15,9 @@ class LanguageCollection(Entity):
     def items(self):
         return self.properties.get("Items", ClientValueCollection(Language))
 
+    def __len__(self):
+        return len(self.items)
+
     def __repr__(self):
         return repr(self.items)