Office365-REST-Python-Client 2.6.0__py3-none-any.whl → 2.6.2__py3-none-any.whl

office365/directory/users/user.py

@@ -2,6 +2,8 @@ import json
 from datetime import datetime
 from typing import List, Optional
 
+from typing_extensions import Self
+
 from office365.communications.onlinemeetings.collection import OnlineMeetingCollection
 from office365.communications.presences.presence import Presence
 from office365.delta_collection import DeltaCollection
@@ -12,6 +14,9 @@ from office365.directory.audit.signins.activity import SignInActivity
 from office365.directory.authentication.authentication import Authentication
 from office365.directory.extensions.extension import Extension
 from office365.directory.identities.object_identity import ObjectIdentity
+from office365.directory.identitygovernance.termsofuse.agreement_acceptance import (
+    AgreementAcceptance,
+)
 from office365.directory.insights.office_graph import OfficeGraphInsights
 from office365.directory.licenses.assigned_license import AssignedLicense
 from office365.directory.licenses.assigned_plan import AssignedPlan
@@ -36,6 +41,7 @@ from office365.onedrive.sites.site import Site
 from office365.onenote.onenote import Onenote
 from office365.outlook.calendar.attendees.base import AttendeeBase
 from office365.outlook.calendar.calendar import Calendar
+from office365.outlook.calendar.dateTimeTimeZone import DateTimeTimeZone
 from office365.outlook.calendar.events.event import Event
 from office365.outlook.calendar.events.reminder import Reminder
 from office365.outlook.calendar.group import CalendarGroup
@@ -51,7 +57,8 @@ from office365.outlook.mail.mailbox_settings import MailboxSettings
 from office365.outlook.mail.messages.collection import MessageCollection
 from office365.outlook.mail.messages.message import Message
 from office365.outlook.mail.recipient import Recipient
-from office365.outlook.mail.tips import MailTips
+from office365.outlook.mail.tips.tips import MailTips
+from office365.outlook.person import Person
 from office365.outlook.user import OutlookUser
 from office365.planner.user import PlannerUser
 from office365.runtime.client_result import ClientResult
@@ -66,6 +73,7 @@ from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.runtime.types.collections import StringCollection
 from office365.teams.chats.collection import ChatCollection
 from office365.teams.collection import TeamCollection
+from office365.teams.teamwork.shiftmanagement.user_solution_root import UserSolutionRoot
 from office365.teams.teamwork.user import UserTeamwork
 from office365.teams.viva.employee_experience_user import EmployeeExperienceUser
 from office365.todo.todo import Todo
@@ -77,6 +85,60 @@ class User(DirectoryObject):
     def __repr__(self):
         return self.user_principal_name or self.id or self.entity_type_name
 
+    def enable_automatic_replies_setting(
+        self,
+        status,
+        scheduled_start_datetime,
+        scheduled_end_datetime,
+        internal_reply_message=None,
+        external_reply_message=None,
+    ):
+        # type: (str, datetime, datetime, str, str) -> Self
+        """
+        Enable, configure, automatic replies (notify people automatically upon receipt of their email)
+
+        """
+        from office365.outlook.mail.automatic_replies_setting import (
+            AutomaticRepliesSetting,
+        )
+
+        setting = AutomaticRepliesSetting(
+            status=status,
+            scheduled_start_datetime=DateTimeTimeZone.parse(scheduled_start_datetime),
+            scheduled_end_datetime=DateTimeTimeZone.parse(scheduled_end_datetime),
+            internal_reply_message=internal_reply_message,
+            external_reply_message=external_reply_message,
+        )
+
+        def _construct_request(request):
+            payload = {"automaticRepliesSetting": setting.to_json()}
+            request.data = payload
+            request.url += "/mailboxSettings"
+
+        self.update().before_execute(_construct_request)
+        return self
+
+    def disable_automatic_replies_setting(self, clear_all=False):
+        """
+        Disable automatic replies (notify people automatically upon receipt of their email)
+        :param bool clear_all: If true, clear all automatic replies settings
+        """
+        from office365.outlook.mail.automatic_replies_setting import (
+            AutomaticRepliesSetting,
+        )
+
+        setting = AutomaticRepliesSetting(
+            status="disabled",
+        )
+
+        def _construct_request(request):
+            payload = {"automaticRepliesSetting": setting.to_json()}
+            request.data = payload
+            request.url += "/mailboxSettings"
+
+        self.update().before_execute(_construct_request)
+        return self
+
     def add_extension(self, name):
         """
         Creates an open extension (openTypeExtension object) and add custom properties in a new or existing instance
@@ -210,9 +272,11 @@ class User(DirectoryObject):
         to_recipients,
         cc_recipients=None,
         bcc_recipients=None,
+        reply_to=None,
         save_to_sent_items=False,
+        body_type="Text",
     ):
-        # type: (str, str|ItemBody, List[str], List[str], List[str], bool) -> Message
+        # type: (str, str|ItemBody, List[str], List[str]|None, List[str]|None, List[str]|None, bool, str) -> Message
         """Send a new message on the fly
 
         :param str subject: The subject of the message.
@@ -220,12 +284,14 @@ class User(DirectoryObject):
         :param list[str] to_recipients: The To: recipients for the message.
         :param list[str] cc_recipients: The CC: recipients for the message.
         :param list[str] bcc_recipients: The BCC: recipients for the message.
+        :param list[str] reply_to: The Reply-To: : recipients for the reply to the message.
         :param bool save_to_sent_items: Indicates whether to save the message in Sent Items. Specify it only if
             the parameter is false; default is true
+        :param str body_type: The type of the message body. It can be "HTML" or "Text". Default is "Text".
         """
         return_type = Message(self.context)
         return_type.subject = subject
-        return_type.body = body
+        return_type.body = (body, body_type)
         [
             return_type.to_recipients.add(Recipient.from_email(email))
             for email in to_recipients
@@ -240,6 +306,11 @@ class User(DirectoryObject):
                 return_type.cc_recipients.add(Recipient.from_email(email))
                 for email in cc_recipients
             ]
+        if reply_to is not None:
+            [
+                return_type.reply_to.add(Recipient.from_email(email))
+                for email in reply_to
+            ]
 
         payload = {"message": return_type, "saveToSentItems": save_to_sent_items}
         qry = ServiceOperationQuery(self, "sendmail", None, payload)
@@ -727,6 +798,10 @@ class User(DirectoryObject):
         """Get the user's mailboxSettings."""
         return self.properties.get("mailboxSettings", MailboxSettings())
 
+    @mailbox_settings.setter
+    def mailbox_settings(self, value):
+        self.set_property("mailboxSettings", value)
+
     @property
     def calendar(self):
         # type: () -> Calendar
@@ -964,6 +1039,17 @@ class User(DirectoryObject):
             OutlookUser(self.context, ResourcePath("outlook", self.resource_path)),
         )
 
+    @property
+    def people(self):
+        # type: () -> EntityCollection[Person]
+        """People that are relevant to the user. Read-only. Nullable."""
+        return self.properties.get(
+            "people",
+            EntityCollection(
+                self.context, Person, ResourcePath("people", self.resource_path)
+            ),
+        )
+
     @property
     def onenote(self):
         # type: () -> Onenote
@@ -989,6 +1075,20 @@ class User(DirectoryObject):
             PlannerUser(self.context, ResourcePath("planner", self.resource_path)),
         )
 
+    @property
+    def agreement_acceptances(self):
+        """
+        The user's terms of use acceptance statuses
+        """
+        return self.properties.get(
+            "agreementAcceptances",
+            EntityCollection(
+                self.context,
+                AgreementAcceptance,
+                ResourcePath("agreementAcceptances", self.resource_path),
+            ),
+        )
+
     @property
     def extensions(self):
         # type: () -> EntityCollection[Extension]
@@ -1079,6 +1179,17 @@ class User(DirectoryObject):
             UserTeamwork(self.context, ResourcePath("teamwork", self.resource_path)),
         )
 
+    @property
+    def solutions(self):
+        # type: () -> UserSolutionRoot
+        """The identifier that relates the user to the working time schedule triggers. Read-Only. Nullable."""
+        return self.properties.get(
+            "solutions",
+            UserSolutionRoot(
+                self.context, ResourcePath("solutions", self.resource_path)
+            ),
+        )
+
     @property
     def todo(self):
         # type: () -> Todo

office365/entity_collection.py

@@ -1,5 +1,7 @@
 from typing import TYPE_CHECKING, Any, Optional, Type, TypeVar
 
+from typing_extensions import Self
+
 from office365.entity import Entity
 from office365.runtime.client_object_collection import ClientObjectCollection
 from office365.runtime.compat import is_string_type
@@ -21,6 +23,17 @@ class EntityCollection(ClientObjectCollection[T]):
         super(EntityCollection, self).__init__(
             context, item_type, resource_path, parent
         )
+        self._delta_request_url = None
+
+    def token(self, value):
+        """
+        Apply delta query
+
+        :param str value: If unspecified, enumerates the hierarchy's current state. If latest, returns empty
+            response with latest delta token. If a previous delta token, returns new state since that token.
+        """
+        self.query_options.custom["token"] = value
+        return self
 
     def __getitem__(self, key):
         # type: (int | str) -> T
@@ -58,6 +71,14 @@ class EntityCollection(ClientObjectCollection[T]):
             initial_properties, resource_path
         )
 
+    def set_property(self, key, value, persist_changes=False):
+        # type: (str | int, dict, bool) -> Self
+        if key == self.context.pending_request().json_format.collection_delta:
+            self._delta_request_url = value
+        else:
+            super(EntityCollection, self).set_property(key, value, persist_changes)
+        return self
+
     @property
     def context(self):
         # type: () -> GraphClient

office365/onedrive/contenttypes/collection.py

@@ -6,6 +6,8 @@ from office365.runtime.queries.service_operation import ServiceOperationQuery
 
 
 class ContentTypeCollection(EntityCollection[ContentType]):
+    """Content type collection"""
+
     def __init__(self, context, resource_path):
         super(ContentTypeCollection, self).__init__(context, ContentType, resource_path)
 

office365/onedrive/driveitems/driveItem.py

@@ -449,8 +449,9 @@ class DriveItem(BaseItem):
                     chunk_downloaded(bytes_read)
                 file_object.write(chunk)
 
-        self.get_content().before_execute(_construct_request)
-        self.context.after_execute(_process_response)
+        self.get_content().before_execute(_construct_request).after_execute(
+            _process_response, include_response=True
+        )
         return self
 
     def create_folder(self, name, conflict_behavior=ConflictBehavior.Rename):

office365/onedrive/driveitems/publication_facet.py

@@ -1,8 +1,12 @@
+from office365.directory.permissions.identity_set import IdentitySet
 from office365.runtime.client_value import ClientValue
 
 
 class PublicationFacet(ClientValue):
-    def __init__(self, level=None, version_id=None):
+    """The publicationFacet resource provides details on the published status of a driveItemVersion or driveItem
+    resource."""
+
+    def __init__(self, checked_out_by=IdentitySet(), level=None, version_id=None):
         """
         The publicationFacet resource provides details on the published status of a driveItemVersion
         or driveItem resource.
@@ -11,5 +15,6 @@ class PublicationFacet(ClientValue):
         :param str version_id: The unique identifier for the version that is visible to the current caller. Read-only.
         """
         super(PublicationFacet, self).__init__()
+        self.checkedOutBy = checked_out_by
         self.level = level
         self.versionId = version_id

office365/onedrive/filestorage/container.py

@@ -1,3 +1,6 @@
+from datetime import datetime
+from typing import Optional
+
 from office365.entity import Entity
 
 
@@ -5,3 +8,22 @@ class FileStorageContainer(Entity):
     """Represents a location where multiple users or a group of users can store files and access them
     via an application. All file system objects in a fileStorageContainer are returned as driveItem resources.
     """
+
+    @property
+    def created_datetime(self):
+        # type: () -> Optional[datetime]
+        """Date and time of the fileStorageContainer creation. Read-only."""
+        return self.properties.get("createdDateTime", datetime.min)
+
+    @property
+    def entity_type_name(self):
+        # type: () -> str
+        return "graph.fileStorageContainer"
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "createdDateTime": self.created_datetime,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(FileStorageContainer, self).get_property(name, default_value)

office365/onedrive/filestorage/container_collection.py

@@ -0,0 +1,37 @@
+import uuid
+
+from office365.entity_collection import EntityCollection
+from office365.onedrive.filestorage.container import FileStorageContainer
+from office365.runtime.queries.create_entity import CreateEntityQuery
+
+
+class FileStorageContainerCollection(EntityCollection[FileStorageContainer]):
+    """FileStorageContainer collection"""
+
+    def __init__(self, context, resource_path=None):
+        super(FileStorageContainerCollection, self).__init__(
+            context, FileStorageContainer, resource_path
+        )
+
+    def add(self, display_name, container_type_id=uuid.uuid4()):
+        """
+        Create a new fileStorageContainer object.
+
+        The container type identified by containerTypeId must be registered in the tenant.
+
+        For delegated calls, the calling user is set as the owner of the fileStorageContainer.
+
+        This API is available in the following national cloud deployments.
+
+        :param str display_name: The display name of the container.
+        :param str container_type_id: The identifier of the container type.
+        """
+        return_type = FileStorageContainer(self.context)
+        self.add_child(return_type)
+        payload = {
+            "displayName": display_name,
+            "containerTypeId": str(container_type_id),
+        }
+        qry = CreateEntityQuery(self, payload, return_type)
+        self.context.add_query(qry)
+        return return_type

office365/onedrive/filestorage/file_storage.py

@@ -1,6 +1,7 @@
 from office365.entity import Entity
-from office365.entity_collection import EntityCollection
-from office365.onedrive.filestorage.container import FileStorageContainer
+from office365.onedrive.filestorage.container_collection import (
+    FileStorageContainerCollection,
+)
 from office365.runtime.paths.resource_path import ResourcePath
 
 
@@ -12,9 +13,8 @@ class FileStorage(Entity):
         """The collection of active fileStorageContainers"""
         return self.properties.get(
             "containers",
-            EntityCollection(
+            FileStorageContainerCollection(
                 self.context,
-                FileStorageContainer,
                 ResourcePath("containers", self.resource_path),
             ),
         )

office365/onedrive/listitems/collection.py

@@ -0,0 +1,38 @@
+from office365.entity_collection import EntityCollection
+from office365.onedrive.listitems.list_item import ListItem
+from office365.runtime.http.request_options import RequestOptions
+
+
+class ListItemCollection(EntityCollection[ListItem]):
+    """List Item's collection"""
+
+    def __init__(self, context, resource_path):
+        super(ListItemCollection, self).__init__(context, ListItem, resource_path)
+        self._honor_nonindexed = True
+
+    def honor_nonindexed(self, value):
+        # type: (bool) -> "ListItemCollection"
+        """Sets if true HonorNonIndexedQueriesWarningMayFailRandomly header
+        to allow non-indexed properties to be queried."""
+        self._honor_nonindexed = value
+        return self
+
+    def get(self):
+        """Retrieve a list item"""
+
+        def _construct_request(request):
+            # type: (RequestOptions) -> None
+            if self._honor_nonindexed:
+                request.headers["Prefer"] = (
+                    "HonorNonIndexedQueriesWarningMayFailRandomly"
+                )
+
+        return super(ListItemCollection, self).get().before_execute(_construct_request)
+
+    def get_by_name(self, name):
+        """Retrieve a list item by name"""
+        return self.single("fields/FileLeafRef eq '{0}'".format(name))
+
+    def get_by_path(self, path):
+        """Retrieve a list item by path"""
+        return self.single("fields/FileRef eq '{0}'".format(path))

office365/onedrive/lists/list.py

@@ -4,7 +4,7 @@ from office365.entity_collection import EntityCollection
 from office365.onedrive.base_item import BaseItem
 from office365.onedrive.columns.definition_collection import ColumnDefinitionCollection
 from office365.onedrive.contenttypes.collection import ContentTypeCollection
-from office365.onedrive.listitems.list_item import ListItem
+from office365.onedrive.listitems.collection import ListItemCollection
 from office365.onedrive.lists.info import ListInfo
 from office365.onedrive.operations.rich_long_running import RichLongRunningOperation
 from office365.onedrive.sharepoint_ids import SharePointIds
@@ -68,13 +68,11 @@ class List(BaseItem):
 
     @property
     def items(self):
-        # type: () -> EntityCollection[ListItem]
+        # type: () -> ListItemCollection
         """All items contained in the list."""
         return self.properties.get(
             "items",
-            EntityCollection(
-                self.context, ListItem, ResourcePath("items", self.resource_path)
-            ),
+            ListItemCollection(self.context, ResourcePath("items", self.resource_path)),
         )
 
     @property

office365/onedrive/sitepages/base.py

@@ -30,3 +30,11 @@ class BaseSitePage(BaseItem):
         # type: () -> Optional[str]
         """Title of the sitePage."""
         return self.properties.get("title", None)
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "publishingState": self.publishing_state,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(BaseSitePage, self).get_property(name, default_value)

office365/onedrive/sitepages/collection.py

@@ -19,13 +19,19 @@ class SitePageCollection(EntityCollection[SitePage]):
         return super(SitePageCollection, self).get().before_execute(_construct_request)
 
     def get_by_name(self, name):
+        """Get a sitePage by name."""
         return self.single("name eq '{0}'".format(name))
 
-    def add(self, title):
+    def get_by_title(self, title):
+        """Get a sitePage by title."""
+        return self.single("title eq '{0}'".format(title))
+
+    def add(self, title, page_layout="article"):
         """
         Create a new sitePage in the site pages list in a site.
 
         :param str title:
+        :param str page_layout:
         """
 
         def _construct_request(request):
@@ -37,7 +43,7 @@ class SitePageCollection(EntityCollection[SitePage]):
             .add(
                 title=title,
                 name="{0}.aspx".format(title),
-                pageLayout="article",
+                pageLayout=page_layout,
                 titleArea=TitleArea(),
             )
             .before_execute(_construct_request)

office365/onedrive/sitepages/site_page.py

@@ -15,7 +15,11 @@ class SitePage(BaseSitePage):
     webParts."""
 
     def get_web_parts_by_position(
-        self, web_part_index, horizontal_section_id, is_in_vertical_section, column_id
+        self,
+        web_part_index=None,
+        horizontal_section_id=None,
+        is_in_vertical_section=None,
+        column_id=None,
     ):
         """
         Get a collection of webPart by providing webPartPosition information.
@@ -40,6 +44,13 @@ class SitePage(BaseSitePage):
         self.context.add_query(qry)
         return return_type
 
+    def checkin(self):
+        """
+        Check in the latest version of a sitePage resource, which makes the version of the page available to all users.
+        If the page is checked out, check in the page and publish it. If the page is checked out to the caller
+        of this API, the page is automatically checked in and then published."""
+        return self
+
     def publish(self):
         """
         Publish the latest version of a sitePage resource, which makes the version of the page available to all users.
@@ -49,7 +60,7 @@ class SitePage(BaseSitePage):
         If a page approval flow has been activated in the page library, the page is not published until the approval
         flow is completed.
         """
-        qry = ServiceOperationQuery(self, "publish")
+        qry = ServiceOperationQuery(self, "microsoft.graph.sitePage/publish")
         self.context.add_query(qry)
         return self
 

office365/onedrive/sites/site.py

@@ -26,7 +26,7 @@ class Site(BaseItem):
     """The site resource provides metadata and relationships for a SharePoint site."""
 
     def __str__(self):
-        return self.name
+        return self.name or self.entity_type_name
 
     def __repr__(self):
         return self.name or self.web_url or self.id or self.entity_type_name

office365/onedrive/workbooks/charts/title.py

@@ -1,5 +1,17 @@
 from office365.entity import Entity
+from office365.onedrive.workbooks.charts.title_format import WorkbookChartTitleFormat
+from office365.runtime.paths.resource_path import ResourcePath
 
 
 class WorkbookChartTitle(Entity):
     """Represents a chart title object of a chart."""
+
+    @property
+    def format(self):
+        """The formatting of a chart title, which includes fill and font formatting."""
+        return self.properties.get(
+            "format",
+            WorkbookChartTitleFormat(
+                self.context, ResourcePath("format", self.resource_path)
+            ),
+        )

office365/onedrive/workbooks/charts/title_format.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class WorkbookChartTitleFormat(Entity):
+    """Represents a chart title object of a chart."""

office365/onedrive/workbooks/functions/functions.py

@@ -82,3 +82,19 @@ class WorkbookFunctions(Entity):
         qry = ServiceOperationQuery(self, "days", None, payload, None, return_type)
         self.context.add_query(qry)
         return return_type
+
+    def power(self, number, power):
+        """
+        Returns the result of a number raised to a power.
+
+        :param int number: The base number.
+        :param int power: The exponent to which the base number is raised.
+        """
+        return_type = WorkbookFunctionResult(self.context)
+        payload = {
+            "number": number,
+            "power": power,
+        }
+        qry = ServiceOperationQuery(self, "power", None, payload, None, return_type)
+        self.context.add_query(qry)
+        return return_type

office365/onedrive/workbooks/ranges/border.py

@@ -1,5 +1,35 @@
+from typing import Optional
+
 from office365.entity import Entity
 
 
 class WorkbookRangeBorder(Entity):
     """Represents the border of an object."""
+
+    @property
+    def color(self):
+        # type: () -> Optional[str]
+        """The HTML color code that represents the color of the border line. Can either be of the form #RRGGBB,
+        for example "FFA500", or a named HTML color, for example orange."""
+        return self.properties.get("color", None)
+
+    @property
+    def side_index(self):
+        # type: () -> Optional[str]
+        """Indicates the specific side of the border.
+        The possible values are: EdgeTop, EdgeBottom, EdgeLeft, EdgeRight, InsideVertical, InsideHorizontal,
+        DiagonalDown, DiagonalUp. Read-only."""
+        return self.properties.get("sideIndex", None)
+
+    @property
+    def style(self):
+        # type: () -> Optional[str]
+        """Indicates the line style for the border. The possible values are: None, Continuous, Dash, DashDot,
+        DashDotDot, Dot, Double, SlantDashDot."""
+        return self.properties.get("style", None)
+
+    @property
+    def weight(self):
+        # type: () -> Optional[str]
+        """The weight of the border around a range. The possible values are: Hairline, Thin, Medium, Thick."""
+        return self.properties.get("weight", None)

office365/onedrive/workbooks/ranges/font.py

@@ -1,5 +1,44 @@
+from typing import Optional
+
 from office365.entity import Entity
 
 
 class WorkbookRangeFont(Entity):
     """This object represents the font attributes (font name, font size, color, etc.) for an object."""
+
+    @property
+    def bold(self):
+        # type: () -> Optional[bool]
+        """Inidicates whether the font is bold."""
+        return self.properties.get("bold", None)
+
+    @property
+    def color(self):
+        # type: () -> Optional[str]
+        """The HTML color code representation of the text color. For example, #FF0000 represents the color red."""
+        return self.properties.get("color", None)
+
+    @property
+    def italic(self):
+        # type: () -> Optional[bool]
+        """Inidicates whether the font is italic."""
+        return self.properties.get("italic", None)
+
+    @property
+    def name(self):
+        # type: () -> Optional[str]
+        """The font name. For example, "Calibri"."""
+        return self.properties.get("name", None)
+
+    @property
+    def size(self):
+        # type: () -> Optional[float]
+        """The font size."""
+        return self.properties.get("size", None)
+
+    @property
+    def underline(self):
+        # type: () -> Optional[bool]
+        """The type of underlining applied to the font. The possible values are:
+        None, Single, Double, SingleAccountant, DoubleAccountant."""
+        return self.properties.get("underline", None)