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

office365/sharepoint/folders/collection.py

@@ -1,7 +1,10 @@
+import os
+
 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_collection import EntityCollection
+from office365.sharepoint.folders.coloring_information import FolderColoringInformation
 from office365.sharepoint.folders.folder import Folder
 from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
 
@@ -42,14 +45,28 @@ class FolderCollection(EntityCollection[Folder]):
             folder = folder.add(name)
         return folder
 
-    def add(self, name):
+    def add(self, name, color_hex=None):
         """Adds the folder that is located at the specified URL to the collection.
-        :param str name: Specifies the Name of the folder.
+        :param str name: Specifies the Name or Path of the folder.
+        :param str color_hex: Specifies the color of the folder.
         """
         return_type = Folder(self.context, EntityPath(name, self.resource_path))
-        self.add_child(return_type)
-        qry = ServiceOperationQuery(self, "Add", [name], None, None, return_type)
-        self.context.add_query(qry)
+        if color_hex:
+
+            def _add_coloring():
+                path = os.path.join(
+                    self.parent.properties.get("ServerRelativeUrl"), name
+                )
+                coloring_info = FolderColoringInformation(color_hex=color_hex)
+                self.context.folder_coloring.create_folder(
+                    path, coloring_info, return_type=return_type
+                )
+
+            self.parent.ensure_property("ServerRelativeUrl", _add_coloring)
+        else:
+            self.add_child(return_type)
+            qry = ServiceOperationQuery(self, "Add", [name], None, None, return_type)
+            self.context.add_query(qry)
         return return_type
 
     def get_by_url(self, url):

office365/sharepoint/folders/coloring.py

@@ -1,6 +1,10 @@
+from typing_extensions import Self
+
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
+from office365.sharepoint.folders.coloring_information import FolderColoringInformation
 from office365.sharepoint.folders.folder import Folder
+from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
 
 
 class FolderColoring(Entity):
@@ -9,22 +13,19 @@ class FolderColoring(Entity):
     def create_folder(
         self,
         decoded_url,
-        ensure_unique_file_name=True,
-        overwrite=True,
-        coloring_information=None,
+        coloring_information=FolderColoringInformation(color_hex="1"),
+        return_type=None,
     ):
         """
         :param str decoded_url:
-        :param bool ensure_unique_file_name:
-        :param bool overwrite:
         :param FolderColoringInformation coloring_information:
+        :param Folder return_type: Return type
         """
-        return_type = Folder(self.context)
+        if return_type is None:
+            return_type = Folder(self.context)
 
         payload = {
-            "DecodedUrl": decoded_url,
-            "EnsureUniqueFileName": ensure_unique_file_name,
-            "Overwrite": overwrite,
+            "path": SPResPath(decoded_url),
             "coloringInformation": coloring_information,
         }
         qry = ServiceOperationQuery(
@@ -34,6 +35,7 @@ class FolderColoring(Entity):
         return return_type
 
     def stamp_color(self, decoded_url, coloring_information):
+        # type: (str, FolderColoringInformation) -> Self
         """
         :param str decoded_url:
         :param FolderColoringInformation coloring_information:

office365/sharepoint/folders/coloring_information.py

@@ -1,6 +1,40 @@
 from office365.runtime.client_value import ClientValue
 
 
+class FolderColors(object):
+    Yellow = "#FFCE3C"
+
+    Grey = "#B0B7BA"
+
+    DarkRed = "#E73E29"
+
+    LightRed = "#FFBCB2"
+
+    DarkOrange = "#EE7110"
+
+    LightOrange = "#FFBF84"
+
+    DarkGreen = "#3F9F4A"
+
+    LightGreen = "#8ED290"
+
+    DarkTeal = "#27938E"
+
+    LightTeal = "#7AD1CD"
+
+    DarkBlue = "#1E84D0"
+
+    LightBlue = "#86C8F7"
+
+    DarkPurple = "#9A61C7"
+
+    LightPurple = "#D4AFF6"
+
+    DarkPink = "#CC53B4"
+
+    LightPink = "#F7AAE7"
+
+
 class FolderColoringInformation(ClientValue):
     """"""
 
@@ -13,3 +47,7 @@ class FolderColoringInformation(ClientValue):
         self.ColorHex = color_hex
         self.ColorTag = color_tag
         self.Emoji = emoji
+
+    @property
+    def entity_type_name(self):
+        return "SP.FolderColoringInformation"

office365/sharepoint/folders/folder.py

@@ -30,7 +30,7 @@ class Folder(Entity):
     """Represents a folder in a SharePoint Web site."""
 
     def __str__(self):
-        return self.name
+        return self.name or self.entity_type_name
 
     def __repr__(self):
         return self.serverRelativeUrl or self.unique_id or self.entity_type_name
@@ -69,14 +69,14 @@ class Folder(Entity):
 
         return_type = FolderCollection(self.context, self.folders.resource_path, self)
 
-        def _loaded(parent):
+        def _get_folders(parent):
             # type: ("Folder") -> None
             [return_type.add_child(f) for f in parent.folders]
             if recursive:
                 for folder in parent.folders:
-                    folder.ensure_properties(["Folders"], _loaded, parent=folder)
+                    folder.ensure_properties(["Folders"], _get_folders, parent=folder)
 
-        self.ensure_properties(["Folders"], _loaded, parent=self)
+        self.ensure_properties(["Folders"], _get_folders, parent=self)
         return return_type
 
     def get_files(self, recursive=False):
@@ -88,16 +88,16 @@ class Folder(Entity):
 
         return_type = FileCollection(self.context, self.files.resource_path, self)
 
-        def _loaded(parent):
+        def _get_files(parent):
             # type: ("Folder") -> None
             [return_type.add_child(f) for f in parent.files]
             if recursive:
                 for folder in parent.folders:
                     folder.ensure_properties(
-                        ["Files", "Folders"], _loaded, parent=folder
+                        ["Files", "Folders"], _get_files, parent=folder
                     )
 
-        self.ensure_properties(["Files", "Folders"], _loaded, parent=self)
+        self.ensure_properties(["Files", "Folders"], _get_files, parent=self)
         return return_type
 
     def get_sharing_information(self):
@@ -115,18 +115,17 @@ class Folder(Entity):
             where to move a folder.
         """
 
-        def _update_folder(url):
-            self.set_property("ServerRelativeUrl", url)
-
         def _move_to(destination_folder):
             # type: ("Folder") -> None
             destination_url = "/".join(
                 [destination_folder.serverRelativeUrl, self.name]
             )
             qry = ServiceOperationQuery(self, "MoveTo", {"newUrl": destination_url})
-            self.context.add_query(qry).after_query_execute(
-                _update_folder, destination_url
-            )
+
+            def _update_folder(return_type):
+                self.set_property("ServerRelativeUrl", destination_url)
+
+            self.context.add_query(qry).after_query_execute(_update_folder)
 
         def _source_folder_resolved():
             if isinstance(destination, Folder):
@@ -146,21 +145,20 @@ class Folder(Entity):
             where to move a folder.
         """
 
-        def _update_folder(url):
-            self.set_property("ServerRelativePath", url)
-
         def _move_to_using_path(destination_folder):
             # type: ("Folder") -> None
-            destination_url = "/".join(
+            destination_path = "/".join(
                 [str(destination_folder.server_relative_path), self.name]
             )
             qry = ServiceOperationQuery(
-                self, "MoveToUsingPath", {"DecodedUrl": destination_url}
-            )
-            self.context.add_query(qry).after_query_execute(
-                _update_folder, destination_url
+                self, "MoveToUsingPath", {"DecodedUrl": destination_path}
             )
 
+            def _update_folder(url):
+                self.set_property("ServerRelativePath", destination_path)
+
+            self.context.add_query(qry).after_query_execute(_update_folder)
+
         def _source_folder_resolved():
             if isinstance(destination, Folder):
                 destination.ensure_property(
@@ -380,7 +378,7 @@ class Folder(Entity):
         return_type = Folder(self.context)
         self.parent_collection.add_child(return_type)
 
-        def _copy_folder(destination_folder):
+        def _copy_to(destination_folder):
             # type: ("Folder") -> None
             destination_url = "/".join(
                 [destination_folder.serverRelativeUrl, self.name]
@@ -396,15 +394,11 @@ class Folder(Entity):
 
         def _source_folder_resolved():
             if isinstance(destination, Folder):
-                destination.ensure_property(
-                    "ServerRelativeUrl", _copy_folder, destination
-                )
+                destination.ensure_property("ServerRelativeUrl", _copy_to, destination)
             else:
-                self.context.web.ensure_folder_path(destination).after_execute(
-                    _copy_folder
-                )
+                self.context.web.ensure_folder_path(destination).after_execute(_copy_to)
 
-        self.ensure_property("ServerRelativeUrl", _source_folder_resolved)
+        self.ensure_properties(["ServerRelativeUrl", "Name"], _source_folder_resolved)
         return return_type
 
     def copy_to_using_path(
@@ -491,7 +485,9 @@ class Folder(Entity):
 
         return self.properties.get(
             "Folders",
-            FolderCollection(self.context, ResourcePath("Folders", self.resource_path)),
+            FolderCollection(
+                self.context, ResourcePath("Folders", self.resource_path), self
+            ),
         )
 
     @property

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

@@ -210,14 +210,15 @@ class ListItem(SecurableObject):
             ExternalSharingSiteOption.Edit: "role:1073741827",
         }
 
-        def _picker_value_resolved(resp, picker_result):
-            file_abs_url = self.get_property("EncodedAbsUrl")
+        def _picker_value_resolved(picker_result):
+            # type: (ClientResult) -> None
+            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,
@@ -229,15 +230,12 @@ class ListItem(SecurableObject):
                 return_type=return_type,
             )
 
-        def _property_resolved():
-            picker_result = (
-                ClientPeoplePickerWebServiceInterface.client_people_picker_resolve_user(
-                    self.context, user_principal_name
-                )
-            )
-            self.context.after_execute(_picker_value_resolved, True, picker_result)
+        def _url_resolved():
+            ClientPeoplePickerWebServiceInterface.client_people_picker_resolve_user(
+                self.context, user_principal_name
+            ).after_execute(_picker_value_resolved)
 
-        self.ensure_property("EncodedAbsUrl", _property_resolved)
+        self.ensure_property("EncodedAbsUrl", _url_resolved)
         return return_type
 
     def unshare(self):

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,
@@ -301,7 +313,7 @@ class List(SecurableObject):
 
     def render_list_data(self, view_xml):
         """
-        Returns the data for the specified query view.<56> The result is implementation-specific, used for
+        Returns the data for the specified query view. The result is implementation-specific, used for
         providing data to a user interface.
 
         :param str view_xml:  Specifies the query as XML that conforms to the ViewDefinition type as specified in
@@ -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(