planner & todo new types and methods

Author: vgrem

examples/onedrive/files/get_permissions.py

@@ -14,4 +14,4 @@
 file_item = client.me.drive.root.get_by_path(file_path)
 permissions = file_item.permissions.get().execute_query()
 for perm in permissions:
-   print(perm.granted_to_v2)
+    print(perm.granted_to_v2)

examples/planner/create_task.py

@@ -15,5 +15,5 @@
 plans = group.planner.plans.get().execute_query()
 if len(plans) == 0:
     sys.exit("No plans were found")
-task = plans[0].tasks.add(title="New task").execute_query()
+task = client.planner.tasks.add("Update client list", plans[0]).execute_query()
 print("Task {0} has been created".format(task.title))

office365/directory/security/alerts/file_security_state.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class FileSecurityState(ClientValue):
+    """Contains information about the file (not process) related to the alert."""

office365/onedrive/workbooks/charts/title.py

@@ -8,7 +8,7 @@ class WorkbookChartTitle(Entity):
 
     @property
     def format(self):
-        """	The formatting of a chart title, which includes fill and font formatting."""
+        """The formatting of a chart title, which includes fill and font formatting."""
         return self.properties.get(
             "format",
             WorkbookChartTitleFormat(

office365/planner/category_descriptions.py

@@ -0,0 +1,6 @@
+from office365.runtime.client_value import ClientValue
+
+
+class PlannerCategoryDescriptions(ClientValue):
+    """Represents the descriptive labels for the categories that have been defined for a plan.
+    It belongs to the plan details object. There can be up to 25 categories defined."""

office365/planner/external_references.py

@@ -0,0 +1,7 @@
+from office365.runtime.client_value import ClientValue
+
+
+class PlannerExternalReferences(ClientValue):
+    """The plannerExternalReferences resource represents the collection of references on a task. This is an Open Type.
+    It's part of the task details object. The value in the property-value pair is the externalReference object.
+    """

office365/planner/planner.py

@@ -2,7 +2,7 @@
 from office365.entity_collection import EntityCollection
 from office365.planner.buckets.bucket import PlannerBucket
 from office365.planner.plans.collection import PlannerPlanCollection
-from office365.planner.tasks.task import PlannerTask
+from office365.planner.tasks.collection import PlannerTaskCollection
 from office365.runtime.paths.resource_path import ResourcePath
 
 
@@ -25,12 +25,12 @@ def buckets(self):
 
     @property
     def tasks(self):
-        # type: () -> EntityCollection[PlannerTask]
+        # type: () -> PlannerTaskCollection
         """Returns the plannerTasks assigned to the user."""
         return self.properties.get(
             "tasks",
-            EntityCollection(
-                self.context, PlannerTask, ResourcePath("tasks", self.resource_path)
+            PlannerTaskCollection(
+                self.context, ResourcePath("tasks", self.resource_path)
             ),
         )
 

office365/planner/plans/container.py

@@ -9,3 +9,15 @@ class PlannerPlanContainer(ClientValue):
     the contained plans are also deleted. The properties of the plannerPlanContainer cannot be changed after the plan
     is created.
     """
+
+    def __init__(self, container_id=None, type_=None, url=None):
+        """
+        :param str container_id: The identifier of the resource that contains the plan
+        :param str type_: The type of the resource that contains the plan. For supported types, see the previous
+            table. Possible values are: group, unknownFutureValue, roster. Use the Prefer: include-unknown-enum-members
+            request header to get the following value in this evolvable enum: roster.
+        :param str url: 	The full canonical URL of the container.
+        """
+        self.containerId = container_id
+        self.type = type_
+        self.url = url

office365/planner/plans/details.py

@@ -1,8 +1,39 @@
 from office365.entity import Entity
+from office365.planner.category_descriptions import PlannerCategoryDescriptions
+from office365.planner.user_ids import PlannerUserIds
 
 
 class PlannerPlanDetails(Entity):
     """
     The plannerPlanDetails resource represents the additional information about a plan.
     Each plan object has a details object.
     """
+
+    @property
+    def category_descriptions(self):
+        # type: () -> PlannerCategoryDescriptions
+        """
+        An object that specifies the descriptions of the 25 categories that can be associated with tasks in the plan.
+        """
+        return self.properties.get(
+            "categoryDescriptions", PlannerCategoryDescriptions()
+        )
+
+    @property
+    def shared_with(self):
+        # type: () -> PlannerUserIds
+        """
+        Set of user IDs that this plan is shared with. If you're using Microsoft 365 groups, use the Groups
+        API to manage group membership to share the group's plan. You can also add existing members of the group to
+        this collection, although it isn't required for them to access the plan owned by the group.
+        """
+        return self.properties.get("sharedWith", PlannerUserIds())
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "categoryDescriptions": self.category_descriptions,
+                "sharedWith": self.shared_with,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(PlannerPlanDetails, self).get_property(name, default_value)

office365/planner/tasks/collection.py

@@ -0,0 +1,37 @@
+from office365.entity_collection import EntityCollection
+from office365.planner.plans.plan import PlannerPlan
+from office365.planner.tasks.task import PlannerTask
+from office365.runtime.queries.create_entity import CreateEntityQuery
+
+
+class PlannerTaskCollection(EntityCollection[PlannerTask]):
+    def __init__(self, context, resource_path=None):
+        super(PlannerTaskCollection, self).__init__(context, PlannerTask, resource_path)
+
+    def add(self, title, plan, bucket=None):
+        """
+        Create a new plannerTask.
+
+        :param str title: Task title
+        :param str|PlannerPlan plan: Plan identifier or Plan object
+        :param str|PlannerBucket bucket: Bucket identifier or Plan object
+        """
+        return_type = PlannerTask(self.context)
+        self.add_child(return_type)
+
+        def _add(plan_id):
+            # type: (str) -> None
+            payload = {"title": title, "planId": plan_id, "bucketId": bucket}
+            qry = CreateEntityQuery(self, payload, return_type)
+            self.context.add_query(qry)
+
+        if isinstance(plan, PlannerPlan):
+
+            def _parent_loaded():
+                _add(plan.id)
+
+            plan.ensure_property("id", _parent_loaded)
+        else:
+            _add(plan)
+
+        return return_type

office365/planner/tasks/task.py

@@ -1,3 +1,6 @@
+from datetime import datetime
+
+from office365.directory.permissions.identity_set import IdentitySet
 from office365.entity import Entity
 from office365.planner.tasks.task_details import PlannerTaskDetails
 from office365.runtime.paths.resource_path import ResourcePath
@@ -11,6 +14,18 @@ class PlannerTask(Entity):
     See overview for more information regarding relationships between group, plan and task.
     """
 
+    @property
+    def created_by(self):
+        """Identity of the user that created the task."""
+        return self.properties.get("createdBy", IdentitySet())
+
+    @property
+    def created_datetime(self):
+        """
+        Date and time at which the task is created.
+        """
+        return self.properties.get("createdDateTime", datetime.min)
+
     @property
     def title(self):
         """Required. Title of the task."""
@@ -25,3 +40,12 @@ def details(self):
                 self.context, ResourcePath("details", self.resource_path)
             ),
         )
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "createdBy": self.created_by,
+                "createdDateTime": self.created_datetime,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(PlannerTask, self).get_property(name, default_value)

office365/planner/tasks/task_details.py

@@ -1,4 +1,8 @@
+from typing import Optional
+
 from office365.entity import Entity
+from office365.planner.external_references import PlannerExternalReferences
+from office365.planner.tasks.check_list_items import PlannerChecklistItems
 
 
 class PlannerTaskDetails(Entity):
@@ -7,4 +11,33 @@ class PlannerTaskDetails(Entity):
     Each task object has a details object.
     """
 
-    pass
+    @property
+    def checklist(self):
+        # type: () -> PlannerChecklistItems
+        """
+        The collection of checklist items on the task.
+        """
+        return self.properties.get("checklist", PlannerChecklistItems())
+
+    @property
+    def description(self):
+        # type: () -> Optional[str]
+        """Description of the task."""
+        return self.properties.get("description", None)
+
+    @property
+    def preview_type(self):
+        # type: () -> Optional[str]
+        """This sets the type of preview that shows up on the task.
+        The possible values are: automatic, noPreview, checklist, description, reference.
+        When set to automatic the displayed preview is chosen by the app viewing the task.
+        """
+        return self.properties.get("previewType", None)
+
+    @property
+    def references(self):
+        # type: () -> PlannerExternalReferences
+        """
+        The collection of references on the task.
+        """
+        return self.properties.get("references", PlannerExternalReferences())

office365/planner/user_ids.py

@@ -0,0 +1,8 @@
+from office365.runtime.client_value import ClientValue
+
+
+class PlannerUserIds(ClientValue):
+    """The plannerUserIds resource represents the list of users IDs that a plan is shared with, and is an Open Type.
+    If you're using Microsoft 365 groups, use the Groups API to manage group membership to share the group's plan.
+    You can also add existing members of the group to this collection though it isn't required for them to access
+    the plan owned by the group."""

office365/runtime/odata/request.py

@@ -99,7 +99,7 @@ def _next_property(self, json, json_format):
             elif isinstance(json, dict):
                 for name, value in json.items():
                     if isinstance(json_format, JsonLightFormat):
-                        is_valid = name != "__metadata" and not (
+                        is_valid = name != json_format.metadata_type and not (
                             isinstance(value, dict) and "__deferred" in value
                         )
                     else:

office365/runtime/odata/v3/json_light_format.py

@@ -34,6 +34,10 @@ def collection_delta(self):
     def metadata_type(self):
         return "__metadata"
 
+    @property
+    def deferred_type(self):
+        return "__deferred"
+
     @property
     def value_tag(self):
         return "__value"

office365/sharepoint/files/file.py

@@ -717,6 +717,19 @@ def activity_capabilities(self):
         """"""
         return self.properties.get("ActivityCapabilities", ActivityCapabilities())
 
+    @property
+    def checkin_comment(self):
+        # type: () -> Optional[str]
+        """Specifies the comment used when a document is checked into a document library.
+        Its length MUST be equal to or less than 1023."""
+        return self.properties.get("CheckInComment", None)
+
+    @property
+    def content_tag(self):
+        # type: () -> Optional[str]
+        """Returns internal version of content, used to validate document equality for read purposes."""
+        return self.properties.get("ContentTag", None)
+
     @property
     def author(self):
         """Specifies the user who added the file."""

office365/sharepoint/storagemetrics/storage_metrics.py

@@ -7,6 +7,12 @@
 class StorageMetrics(Entity):
     """Specifies the storage-related metrics for list folders in the site"""
 
+    @property
+    def additional_file_stream_size(self):
+        # type: () -> Optional[int]
+        """ """
+        return self.properties.get("AdditionalFileStreamSize", None)
+
     @property
     def last_modified(self):
         # type: () -> Optional[datetime.datetime]
@@ -41,3 +47,15 @@ def total_size(self):
         Total size for a file/folder includes stream, version, and metadata sizes.
         """
         return self.properties.get("TotalSize", None)
+
+    @property
+    def version_count(self):
+        # type: () -> Optional[int]
+        """ """
+        return self.properties.get("VersionCount", None)
+
+    @property
+    def version_size(self):
+        # type: () -> Optional[int]
+        """ """
+        return self.properties.get("VersionSize", None)

office365/sharepoint/webs/regional_settings.py

@@ -96,6 +96,33 @@ def first_week_of_year(self):
         Specifies which week of a year is considered the first week."""
         return self.properties.get("FirstWeekOfYear", None)
 
+    @property
+    def is_east_asia(self):
+        # type: () -> Optional[bool]
+        """Returns "true" if the web locale is an East Asia locale; "false" otherwise."""
+        return self.properties.get("IsEastAsia", None)
+
+    @property
+    def is_right_to_left(self):
+        # type: () -> Optional[bool]
+        """Specifies whether the site uses a right-to-left language. If it uses a right-to-left language,
+        this value MUST be "true". Otherwise, this value MUST be "false"."""
+        return self.properties.get("IsRightToLeft", None)
+
+    @property
+    def is_ui_right_to_left(self):
+        # type: () -> Optional[bool]
+        """Specifies whether the UI of the site (2) uses a right-to-left language. If it uses a right-to-left language,
+        this value MUST be "true". Otherwise, this value MUST be "false"."""
+        return self.properties.get("IsUIRightToLeft", None)
+
+    @property
+    def list_separator(self):
+        # type: () -> Optional[str]
+        """Specifies the separator that is used for lists on the server. For example, if the separator is ",",
+        items in a list will appear as "1,2,3,4"."""
+        return self.properties.get("ListSeparator", None)
+
     @property
     def locale_id(self):
         # type: () -> Optional[int]

office365/todo/attachments/task_file.py

@@ -1,3 +1,5 @@
+from typing import AnyStr, Optional
+
 from office365.todo.attachments.base import AttachmentBase
 
 
@@ -10,5 +12,6 @@ class TaskFileAttachment(AttachmentBase):
 
     @property
     def content_bytes(self):
+        # type: () -> Optional[AnyStr]
         """The base64-encoded contents of the file."""
         return self.properties.get("contentBytes", None)

office365/todo/checklist_item.py

@@ -1,6 +1,17 @@
+from typing import Optional
+
 from office365.entity import Entity
 
 
 class ChecklistItem(Entity):
     """Represents a subtask in a bigger todoTask. ChecklistItem allows breaking down a complex task into more
     actionable, smaller tasks."""
+
+    def __str__(self):
+        return self.display_name or self.entity_type_name
+
+    @property
+    def display_name(self):
+        # type: () -> Optional[str]
+        """Indicates the title of the checklistItem."""
+        return self.properties.get("displayName", None)