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

office365/sharepoint/likes/liked_by_information.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.entity_collection import EntityCollection
@@ -9,24 +11,19 @@ class LikedByInformation(Entity):
 
     @property
     def like_count(self):
-        """
-        Number of users that have liked the item.
-
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Number of users that have liked the item."""
         return self.properties.get("LikeCount", None)
 
     @property
     def is_liked_by_user(self):
-        """
-        MUST be TRUE if the current user has liked the list item.
-
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """MUST be TRUE if the current user has liked the list item."""
         return self.properties.get("isLikedByUser", None)
 
     @property
     def liked_by(self):
+        # type: () -> EntityCollection[UserEntity]
         """
         List of like entries corresponding to individual likes. MUST NOT contain more than one entry
         for the same user in the set.

office365/sharepoint/likes/user_entity.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
@@ -6,16 +8,12 @@ class UserEntity(Entity):
 
     @property
     def creation_date(self):
-        """
-        The Datetime of the like.
-        """
+        # type: () -> Optional[str]
+        """The Datetime of the like."""
         return self.properties.get("creationDate", None)
 
     @property
     def email(self):
-        """
-        The email of the user who liked the item.
-
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """The email of the user who liked the item."""
         return self.properties.get("email", None)

office365/sharepoint/listitems/form_update_value.py

@@ -7,7 +7,14 @@ from office365.sharepoint.fields.lookup_value import FieldLookupValue
 class ListItemFormUpdateValue(ClientValue):
     """Specifies the properties of a list item field and its value."""
 
-    def __init__(self, name=None, value=None, has_exception=None, error_code=None):
+    def __init__(
+        self,
+        name=None,
+        value=None,
+        has_exception=None,
+        error_code=None,
+        error_message=None,
+    ):
         """
         :param str name: Specifies the field internal name for a field.
         :param str value: Specifies a value for a field.
@@ -19,6 +26,15 @@ class ListItemFormUpdateValue(ClientValue):
         self.FieldValue = value
         self.HasException = has_exception
         self.ErrorCode = error_code
+        self.ErrorMessage = error_message
+
+    def __repr__(self):
+        if self.HasException:
+            return "{0} update failed: Message: {1}".format(
+                self.FieldName, self.ErrorMessage
+            )
+        else:
+            return "{0} update succeeded".format(self.FieldName)
 
     def to_json(self, json_format=None):
         json = super(ListItemFormUpdateValue, self).to_json(json_format)

office365/sharepoint/listitems/listitem.py

@@ -212,13 +212,13 @@ class ListItem(SecurableObject):
 
         def _picker_value_resolved(picker_result):
             # type: (ClientResult) -> None
-            file_abs_url = self.get_property("EncodedAbsUrl")
+            abs_url = self.get_property("EncodedAbsUrl")
             picker_value = "[{0}]".format(picker_result.value)
             from office365.sharepoint.webs.web import Web
 
             Web.share_object(
                 self.context,
-                file_abs_url,
+                abs_url,
                 picker_value,
                 role_values[share_option],
                 0,

office365/sharepoint/lists/bloom_filter.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.sharepoint.entity import Entity
 
@@ -7,15 +9,11 @@ class ListBloomFilter(Entity):
 
     @property
     def bloom_filter_size(self):
-        """
-        The length of the Bloom Filter
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """The length of the Bloom Filter"""
         return self.properties.get("BloomFilterSize", None)
 
     @property
     def index_map(self):
-        """
-        Specifies a list of bloom indexes for item.
-        """
+        """Specifies a list of bloom indexes for item."""
         return self.properties.get("IndexMap", ClientValueCollection(int))

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/migrationcenter/deploy_status.py

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

office365/sharepoint/migrationcenter/service/performance/dashboard_data.py

@@ -0,0 +1,9 @@
+from office365.runtime.client_value import ClientValue
+
+
+class PerformanceDashboardData(ClientValue):
+    """"""
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.MigrationCenter.Service.PerformanceDashboardData"

office365/sharepoint/migrationcenter/service/performance/data.py

@@ -0,0 +1,7 @@
+from office365.sharepoint.migrationcenter.service.performance.entity_data import (
+    MigrationPerformanceEntityData,
+)
+
+
+class PerformanceData(MigrationPerformanceEntityData):
+    """"""

office365/sharepoint/migrationcenter/service/performance/entity_data.py

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

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)