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

office365/sharepoint/permissions/irm/settings.py

@@ -1,4 +1,5 @@
 import datetime
+from typing import Optional
 
 from office365.sharepoint.entity import Entity
 
@@ -8,46 +9,41 @@ class InformationRightsManagementSettings(Entity):
 
     @property
     def allow_print(self):
-        """
-        Specifies whether a user can print the downloaded document.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether a user can print the downloaded document."""
         return self.properties.get("AllowPrint", None)
 
     @property
     def allow_script(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether a user can run scripts on the downloaded document.
-        :rtype: bool or None
         """
         return self.properties.get("AllowScript", None)
 
     @property
     def allow_write_copy(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether a user can write in a copy of the downloaded document.
-        :rtype: bool or None
         """
         return self.properties.get("AllowWriteCopy", None)
 
     @property
     def disable_document_browser_view(self):
-        """
-        Specifies whether a user can write in a copy of the downloaded document.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether a user can write in a copy of the downloaded document."""
         return self.properties.get("DisableDocumentBrowserView", None)
 
     @property
     def document_access_expire_days(self):
-        """
-        Specifies the number of days after which the downloaded document will expire.
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Specifies the number of days after which the downloaded document will expire."""
         return self.properties.get("DocumentAccessExpireDays", None)
 
     @property
     def document_library_protection_expire_date(self):
+        # type: () -> Optional[datetime.datetime]
         """
         Specifies the date on which the Information Rights Management (IRM) protection of this document library will
         stop.
@@ -58,66 +54,52 @@ class InformationRightsManagementSettings(Entity):
 
     @property
     def enable_document_access_expire(self):
-        """
-        Specifies whether the downloaded document will expire.
-        :rtype: int or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether the downloaded document will expire."""
         return self.properties.get("EnableDocumentAccessExpire", None)
 
     @property
     def enable_group_protection(self):
-        """
-        Specifies whether the permission of the downloaded document is applicable to a group.
-        :rtype: int or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether the permission of the downloaded document is applicable to a group."""
         return self.properties.get("EnableGroupProtection", None)
 
     @property
     def enable_license_cache_expire(self):
-        """
-        Specifies whether a user MUST verify his or her credentials after certain intervals.
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Specifies whether a user MUST verify his or her credentials after certain intervals."""
         return self.properties.get("EnableLicenseCacheExpire", None)
 
     @property
     def policy_title(self):
-        """
-        Specifies the permission policy title.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the permission policy title."""
         return self.properties.get("PolicyTitle", None)
 
     @property
     def policy_description(self):
-        """
-        Specifies the permission policy description.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the permission policy description."""
         return self.properties.get("PolicyDescription", None)
 
     @property
     def group_name(self):
-        """
-        Specifies the group name (email address) that the permission is also applicable to.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the group name (email address) that the permission is also applicable to."""
         return self.properties.get("GroupName", None)
 
     @property
     def license_cache_expire_days(self):
+        # type: () -> Optional[int]
         """
         Specifies the number of days that the Information Rights Management (IRM) license can be cached by the
         application to open the downloaded document. When these elapse, the application will connect to the IRM
         server to validate the license.
-        :rtype: int or None
         """
         return self.properties.get("LicenseCacheExpireDays", None)
 
     @property
     def template_id(self):
-        """
-        Gets or sets the ID of the RMS template that will be applied to the file or library.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets or sets the ID of the RMS template that will be applied to the file or library."""
         return self.properties.get("TemplateId", None)

office365/sharepoint/portal/groups/site_manager.py

@@ -1,6 +1,7 @@
 from office365.runtime.client_object import ClientObject
 from office365.runtime.client_result import ClientResult
 from office365.runtime.http.http_method import HttpMethod
+from office365.runtime.http.request_options import RequestOptions
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.portal.groups.creation_context import GroupCreationContext
@@ -98,21 +99,19 @@ class GroupSiteManager(ClientObject):
         return return_type
 
     def get_status(self, group_id):
-        """Get the status of a SharePoint site
-
-        :type group_id: str
-        """
+        # type: (str) -> ClientResult[GroupSiteInfo]
+        """Get the status of a SharePoint site"""
         return_type = ClientResult(self.context, GroupSiteInfo())
         qry = ServiceOperationQuery(
             self, "GetSiteStatus", None, {"groupId": group_id}, None, return_type
         )
-        self.context.add_query(qry)
 
-        def _construct_status_request(request):
+        def _construct_request(request):
+            # type: (RequestOptions) -> None
             request.method = HttpMethod.Get
             request.url += "?groupId='{0}'".format(group_id)
 
-        self.context.before_execute(_construct_status_request)
+        self.context.add_query(qry).before_execute(_construct_request)
         return return_type
 
     def get_current_user_joined_teams(

office365/sharepoint/principal/principal.py

@@ -8,7 +8,7 @@ class Principal(Entity):
     """Represents a user or group that can be assigned permissions to control security."""
 
     def __str__(self):
-        return self.title
+        return self.title or self.entity_type_name
 
     def __repr__(self):
         return self.user_principal_name or self.id or self.entity_type_name
@@ -28,9 +28,7 @@ class Principal(Entity):
     @title.setter
     def title(self, value):
         # type: (str) -> None
-        """
-        Sets a value that specifies the name of the principal.
-        """
+        """Sets a value that specifies the name of the principal."""
         self.set_property("Title", value)
 
     @property

office365/sharepoint/publishing/embed_data_v1.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
@@ -5,25 +7,16 @@ class EmbedDataV1(Entity):
     """Represents embedded meta data of the page."""
 
     def url(self):
-        """
-        The URL of the page.
-
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """The URL of the page."""
         return self.properties.get("Url", None)
 
     def video_id(self):
-        """
-        If the page represents a video, the value will be video id.
-
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """If the page represents a video, the value will be video id."""
         return self.properties.get("VideoId", None)
 
     def web_id(self):
-        """
-        If the page belongs to website, the value will be website id, otherwise the value will be empty.
-
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """If the page belongs to website, the value will be website id, otherwise the value will be empty."""
         return self.properties.get("WebId", None)

office365/sharepoint/publishing/pages/campaign_publication.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.publishing.highlights_info import HighlightsInfo
 from office365.sharepoint.publishing.pages.page import SitePage
@@ -15,9 +17,8 @@ class CampaignPublication(SitePage):
 
     @property
     def email_endpoint(self):
-        """
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """"""
         return self.properties.get("EmailEndpoint", None)
 
     @property

office365/sharepoint/publishing/primary_city_time.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
@@ -6,21 +8,18 @@ class PrimaryCityTime(Entity):
 
     @property
     def location(self):
-        """
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """ """
         return self.properties.get("Location", None)
 
     @property
     def time(self):
-        """
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """"""
         return self.properties.get("Time", None)
 
     @property
     def utc_offset(self):
-        """
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """"""
         return self.properties.get("UtcOffset", None)

office365/sharepoint/publishing/video/service_discoverer.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.entity import Entity
 
@@ -10,7 +12,6 @@ class VideoServiceDiscoverer(Entity):
 
     @property
     def video_portal_url(self):
-        """
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """ """
         return self.properties.get("VideoPortalUrl", None)

office365/sharepoint/pushnotifications/subscriber.py

@@ -1,4 +1,5 @@
 import datetime
+from typing import Optional
 
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.entity import Entity
@@ -9,42 +10,37 @@ class PushNotificationSubscriber(Entity):
 
     @property
     def custom_args(self):
-        """Gets the custom arguments specified by the app.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Gets the custom arguments specified by the app."""
         return self.properties.get("CustomArgs", None)
 
     @property
     def service_token(self):
-        """Specifies the delivery channel URI for push notifications. It must not be null. It must not be empty.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Specifies the delivery channel URI for push notifications. It must not be null. It must not be empty."""
         return self.properties.get("ServiceToken", None)
 
     @service_token.setter
     def service_token(self, value):
-        """
-        Specifies the delivery channel URI for push notifications. It must not be null. It must not be empty.
-
-        :type value: str
-        """
+        # type: (str) -> None
+        """Specifies the delivery channel URI for push notifications. It must not be null. It must not be empty."""
         self.set_property("ServiceToken", value)
 
     @property
     def device_app_instance_id(self):
-        """Specifies a device app instance identifier.
-
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Specifies a device app instance identifier."""
         return self.properties.get("DeviceAppInstanceId", None)
 
     @property
     def last_modified_time_stamp(self):
+        # type: () -> Optional[datetime.datetime]
         """Specifies the time and date when the subscriber was last updated."""
         return self.properties.get("LastModifiedTimeStamp", datetime.datetime.min)
 
     @property
     def registration_time_stamp(self):
+        # type: () -> Optional[datetime.datetime]
         """Specifies the time and date when the subscriber registered for push notifications."""
         return self.properties.get("RegistrationTimeStamp", datetime.datetime.min)
 

office365/sharepoint/recyclebin/item.py

@@ -1,16 +1,22 @@
-from typing import Optional
+from datetime import datetime
+from typing import TYPE_CHECKING, Optional
 
 from office365.runtime.paths.resource_path import ResourcePath
-from office365.runtime.paths.service_operation import ServiceOperationPath
-from office365.runtime.paths.v3.entity import EntityPath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.principal.users.user import User
+from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
+
+if TYPE_CHECKING:
+    from office365.sharepoint.recyclebin.item_collection import RecycleBinItemCollection
 
 
 class RecycleBinItem(Entity):
     """Represents a Recycle Bin item in the Recycle Bin of a site or a site collection."""
 
+    def __str__(self):
+        return self.title or self.entity_type_name
+
     def restore(self):
         """Restores the Recycle Bin item to its original location."""
         qry = ServiceOperationQuery(self, "Restore")
@@ -26,17 +32,95 @@ class RecycleBinItem(Entity):
         self.context.add_query(qry)
         return self
 
+    @property
+    def author_email(self):
+        # type: () -> Optional[str]
+        """Gets the email address of the user who originally created the Recycle Bin item."""
+        return self.properties.get("AuthorEmail", None)
+
+    @property
+    def author_name(self):
+        # type: () -> Optional[str]
+        """Gets the user display name of the user who originally created the Recycle Bin item."""
+        return self.properties.get("AuthorName", None)
+
+    @property
+    def deleted_by_email(self):
+        # type: () -> Optional[str]
+        """Gets the email address of the user who deleted the Recycle Bin item."""
+        return self.properties.get("DeletedByEmail", None)
+
+    @property
+    def deleted_by_name(self):
+        # type: () -> Optional[str]
+        """Gets the user display name of the user who deleted the Recycle Bin item."""
+        return self.properties.get("DeletedByName", None)
+
+    @property
+    def deleted_date_local_formatted(self):
+        # type: () -> Optional[str]
+        """
+        Specifies when, in the default time zone for the current site,
+        the Recycle Bin item was moved to the Recycle Bin.
+        """
+        return self.properties.get("DeletedDateLocalFormatted", None)
+
+    @property
+    def dir_name(self):
+        # type: () -> Optional[str]
+        """
+        Specifies the site-relative URL of the list or folder that originally contained the Recycle Bin item.
+        """
+        return self.properties.get("DirName", None)
+
+    @property
+    def dir_name_path(self):
+        # type: () -> Optional[SPResPath]
+        """Returns the site relative path of the list or folder that originally contained the Recycle Bin item."""
+        return self.properties.get("DirNamePath", SPResPath())
+
+    @property
+    def item_state(self):
+        # type: () -> Optional[int]
+        """Specifies the Recycle Bin stage of the Recycle Bin item."""
+        return self.properties.get("ItemState", None)
+
+    @property
+    def item_type(self):
+        # type: () -> Optional[int]
+        """Specifies the type of the Recycle Bin item."""
+        return self.properties.get("ItemType", None)
+
     @property
     def id(self):
+        # type: () -> Optional[str]
         """Gets a value that specifies the identifier of the Recycle Bin item."""
         return self.properties.get("Id", None)
 
+    @property
+    def leaf_name(self):
+        # type: () -> Optional[str]
+        """Specifies the leaf name of the Recycle Bin item."""
+        return self.properties.get("LeafName", None)
+
+    @property
+    def leaf_name_path(self):
+        # type: () -> Optional[SPResPath]
+        """Returns the leaf name path of the Recycle Bin item."""
+        return self.properties.get("LeafNamePath", SPResPath())
+
     @property
     def size(self):
         # type: () -> Optional[int]
         """Gets a value that specifies the size of the Recycle Bin item in bytes."""
         return self.properties.get("Size", None)
 
+    @property
+    def title(self):
+        # type: () -> Optional[str]
+        """Specifies the title of the Recycle Bin item."""
+        return self.properties.get("Title", None)
+
     @property
     def author(self):
         """Gets a value that specifies the user who created the Recycle Bin item."""
@@ -55,7 +139,23 @@ class RecycleBinItem(Entity):
     @property
     def deleted_date(self):
         """Gets a value that specifies when the Recycle Bin item was moved to the Recycle Bin."""
-        return self.properties.get("DeletedDate", None)
+        return self.properties.get("DeletedDate", datetime.min)
+
+    @property
+    def parent_collection(self):
+        # type: () -> RecycleBinItemCollection
+        return self._parent_collection
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "DeletedBy": self.deleted_by,
+                "DeletedDate": self.deleted_date,
+                "DirNamePath": self.dir_name_path,
+                "LeafNamePath": self.leaf_name_path,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(RecycleBinItem, self).get_property(name, default_value)
 
     def set_property(self, name, value, persist_changes=True):
         super(RecycleBinItem, self).set_property(name, value, persist_changes)
@@ -63,8 +163,8 @@ class RecycleBinItem(Entity):
 
         if name == "Id":
             if self._resource_path is None:
-                self._resource_path = ServiceOperationPath(
-                    "GetById", [value], self._parent_collection.resource_path
-                )
+                self._resource_path = self.parent_collection.get_by_id(
+                    value
+                ).resource_path
             else:
                 self._resource_path.patch(value)

office365/sharepoint/sharing/information.py

@@ -5,6 +5,7 @@ from office365.sharepoint.sharing.access_request_settings import AccessRequestSe
 from office365.sharepoint.sharing.links.default_templates_collection import (
     SharingLinkDefaultTemplatesCollection,
 )
+from office365.sharepoint.sharing.permission_collection import PermissionCollection
 from office365.sharepoint.sharing.picker_settings import PickerSettings
 
 
@@ -21,6 +22,13 @@ class SharingInformation(Entity):
         """
         return self.properties.get("accessRequestSettings", AccessRequestSettings())
 
+    @property
+    def permissions_information(self):
+        """
+        The PermissionCollection that are on the list item. It contains a collection of PrincipalInfo and LinkInfo.
+        """
+        return self.properties.get("permissionsInformation", PermissionCollection())
+
     @property
     def picker_settings(self):
         """PickerSettings used by the PeoplePicker Control."""
@@ -49,6 +57,7 @@ class SharingInformation(Entity):
         if default_value is None:
             property_mapping = {
                 "accessRequestSettings": self.access_request_settings,
+                "permissionsInformation": self.permissions_information,
                 "pickerSettings": self.picker_settings,
                 "sharingAbilities": self.sharing_abilities,
                 "sharingLinkTemplates": self.sharing_link_templates,

office365/sharepoint/sharing/link_info.py

@@ -0,0 +1,6 @@
+from office365.runtime.client_value import ClientValue
+
+
+class LinkInfo(ClientValue):
+    """This class provides metadata for the tokenized sharing link including settings details, inheritance status,
+    and an optional array of members."""