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

office365/sharepoint/lists/creatables_info.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.lists.creatable_item_info import CreatableItemInfoCollection
 
@@ -14,30 +16,27 @@ class CreatablesInfo(Entity):
 
     @property
     def can_create_folders(self):
+        # type: () -> Optional[bool]
         """
         Indicates if the user is able to create folders in the current list. The user MUST have the appropriate
         permissions and the list MUST allow folder creation.
-
-        :rtype: bool or None
         """
         return self.properties.get("CanCreateFolders", None)
 
     @property
     def can_create_items(self):
+        # type: () -> Optional[bool]
         """
         Indicates whether this list can create items (such as documents (Word/Excel/PowerPoint))
         using Microsoft Office Online.
-
-        :rtype: bool or None
         """
         return self.properties.get("CanCreateItems", None)
 
     @property
     def can_upload_files(self):
+        # type: () -> Optional[bool]
         """
         Indicates whether the user is able to upload files to this list.
-
-        :rtype: bool or None
         """
         return self.properties.get("CanUploadFiles", None)
 

office365/sharepoint/lists/list.py

@@ -1,6 +1,6 @@
 import os
 from datetime import datetime
-from typing import AnyStr, Optional
+from typing import TYPE_CHECKING, AnyStr, Optional
 
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
@@ -59,6 +59,9 @@ from office365.sharepoint.views.collection import ViewCollection
 from office365.sharepoint.views.view import View
 from office365.sharepoint.webhooks.subscription_collection import SubscriptionCollection
 
+if TYPE_CHECKING:
+    from office365.sharepoint.lists.collection import ListCollection
+
 
 class List(SecurableObject):
     """
@@ -74,6 +77,15 @@ class List(SecurableObject):
     def __repr__(self):
         return self.id or self.title or self.entity_type_name
 
+    def clear(self):
+        """Clears the list."""
+
+        def _clear(items):
+            [item.delete_object() for item in items]
+
+        self.items.get().after_execute(_clear, execute_first=True)
+        return self
+
     def create_document_and_get_edit_link(
         self,
         file_name=None,
@@ -610,10 +622,11 @@ class List(SecurableObject):
         )
 
     def get_changes(self, query=None):
+        # type: (ChangeQuery) -> ChangeCollection
         """Returns the collection of changes from the change log that have occurred within the list,
            based on the specified query.
 
-        :param office365.sharepoint.changeQuery.ChangeQuery query: Specifies which changes to return
+        :param ChangeQuery query: Specifies which changes to return
         """
         if query is None:
             query = ChangeQuery(list_=True)
@@ -825,6 +838,12 @@ class List(SecurableObject):
         # type: () -> Optional[bool]
         return self.properties.get("DisableGridEditing", None)
 
+    @property
+    def document_template_url(self):
+        # type: () -> Optional[str]
+        """Specifies the URL of the document template assigned to the list."""
+        return self.properties.get("DocumentTemplateUrl", None)
+
     @property
     def effective_base_permissions(self):
         """
@@ -1294,17 +1313,13 @@ class List(SecurableObject):
 
     @property
     def validation_formula(self):
-        """
-        Specifies the data validation criteria for a list item.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the data validation criteria for a list item."""
         return self.properties.get("ValidationFormula", None)
 
     @property
     def parent_collection(self):
-        """
-        :rtype: office365.sharepoint.lists.collection.ListCollection
-        """
+        # type: () -> ListCollection
         return self._parent_collection
 
     def get_property(self, name, default_value=None):

office365/sharepoint/lists/template.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.paths.service_operation import ServiceOperationPath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -16,6 +18,9 @@ class ListTemplate(Entity):
     list template from the collection.
     """
 
+    def __repr__(self):
+        return self.internal_name or self.entity_type_name
+
     def get_global_schema_xml(self):
         """Retrieves the global schema.xml file."""
         return_type = ClientResult(self.context)
@@ -27,10 +32,8 @@ class ListTemplate(Entity):
 
     @property
     def internal_name(self):
-        """Gets a value that specifies the identifier for the list template.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets a value that specifies the identifier for the list template."""
         return self.properties.get("InternalName", None)
 
     def set_property(self, name, value, persist_changes=True):

office365/sharepoint/lists/template_collection.py

@@ -3,7 +3,7 @@ from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.lists.template import ListTemplate
 
 
-class ListTemplateCollection(EntityCollection):
+class ListTemplateCollection(EntityCollection[ListTemplate]):
     """Specifies a collection of list templates"""
 
     def __init__(self, context, resource_path=None):
@@ -13,9 +13,7 @@ class ListTemplateCollection(EntityCollection):
         )
 
     def get_by_name(self, name):
-        """
-        Returns the list template with the specified name.
-
+        """Returns the list template with the specified name.
         :param str name: The specified name.
         """
         return ListTemplate(

office365/sharepoint/marketplace/app_metadata.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
@@ -30,49 +32,38 @@ class CorporateCatalogAppMetadata(Entity):
 
     @property
     def aad_permissions(self):
-        """
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """ """
         return self.properties.get("AadPermissions", None)
 
     @property
     def app_catalog_version(self):
-        """The version of the app stored in the corporate catalog.
-
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """The version of the app stored in the corporate catalog."""
         return self.properties.get("AppCatalogVersion", None)
 
     @property
     def can_upgrade(self):
-        """Whether an existing instance of an app can be upgraded.
-
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Whether an existing instance of an app can be upgraded."""
         return self.properties.get("CanUpgrade", None)
 
     @property
     def is_client_side_solution(self):
-        """Whether the app is a client-side solution.
-
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Whether the app is a client-side solution."""
         return self.properties.get("IsClientSideSolution", None)
 
     @property
     def title(self):
-        """The title of the app.
-
-        :rtype: bool or None
-        """
+        # type: () -> Optional[str]
+        """The title of the app."""
         return self.properties.get("Title", None)
 
     @property
     def id(self):
-        """The identifier of the app.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The identifier of the app."""
         return self.properties.get("ID", None)
 
     @property

office365/sharepoint/marketplace/sitecollection/appcatalog/allowed_item.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
@@ -6,18 +8,14 @@ class SiteCollectionAppCatalogAllowedItem(Entity):
 
     @property
     def site_id(self):
-        """The ID of a site collection in the allow list.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The ID of a site collection in the allow list."""
         return self.properties.get("SiteID", None)
 
     @property
     def absolute_url(self):
-        """The absolute URL of a site collection in the allow list.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The absolute URL of a site collection in the allow list."""
         return self.properties.get("AbsoluteUrl", None)
 
     @property

office365/sharepoint/navigation/node.py

@@ -1,9 +1,12 @@
-from typing import Optional
+from typing import TYPE_CHECKING, Optional
 
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.translation.user_resource import UserResource
 
+if TYPE_CHECKING:
+    from office365.sharepoint.navigation.node_collection import NavigationNodeCollection
+
 
 class NavigationNode(Entity):
     """
@@ -20,10 +23,6 @@ class NavigationNode(Entity):
     @property
     def children(self):
         """Gets the collection of child nodes of the navigation node."""
-        from office365.sharepoint.navigation.node_collection import (
-            NavigationNodeCollection,
-        )
-
         return self.properties.get(
             "Children",
             NavigationNodeCollection(
@@ -67,9 +66,7 @@ class NavigationNode(Entity):
 
     @property
     def parent_collection(self):
-        """
-        :rtype: office365.sharepoint.navigation.node_collection.NavigationNodeCollection
-        """
+        # type: () -> NavigationNodeCollection
         return self._parent_collection
 
     @property

office365/sharepoint/permissions/irm/effective_settings.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
@@ -6,16 +8,12 @@ class EffectiveInformationRightsManagementSettings(Entity):
 
     @property
     def allow_print(self):
-        """
-        Specifies whether a user can print the downloaded document.
-        :rtype: bool
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether a user can print the downloaded document."""
         return self.properties.get("AllowPrint", None)
 
     @property
     def template_id(self):
-        """
-        Gets the template ID of the RMS template that will be applied to the file/library.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the template ID of the RMS template that will be applied to the file/library."""
         return self.properties.get("TemplateId", None)

office365/sharepoint/permissions/irm/file_settings.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
@@ -13,43 +15,43 @@ class InformationRightsManagementFileSettings(Entity):
 
     @property
     def allow_print(self):
+        # type: () -> Optional[bool]
         """
         Gets a value indicating whether or not the user can print the downloaded document.
         True if print is allowed; otherwise, it is false. The default value is false.
-        :rtype: bool
         """
         return self.properties.get("AllowPrint", None)
 
     @allow_print.setter
     def allow_print(self, value):
+        # type: (bool) -> None
         """
-         Sets a value indicating whether or not the user can print the downloaded document.
-        :param bool value:
+        Sets a value indicating whether or not the user can print the downloaded document.
         """
         self.set_property("AllowPrint", value)
 
     @property
     def allow_script(self):
+        # type: () -> Optional[bool]
         """
         Gets a value indicating whether or not the user can run a script on the downloaded document.
         True if the script is allowed to run; otherwise, it is false. The default value is false.
-        :rtype: bool
         """
         return self.properties.get("AllowScript", None)
 
     @allow_script.setter
     def allow_script(self, value):
+        # type: (bool) -> None
         """
         Sets a value indicating whether or not the user can run a script on the downloaded document.
-        :param bool value:
         """
         self.set_property("AllowPrint", value)
 
     @property
     def allow_write_copy(self):
+        # type: () -> Optional[bool]
         """
         Getsa value indicating whether or not the user can write on a copy of the downloaded document.
         True if write on a copy is allowed; otherwise, it is false. The default value is false.
-        :rtype: bool
         """
         return self.properties.get("AllowWriteCopy", None)

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/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)