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

office365/onedrive/sitepages/site_page.py

@@ -0,0 +1,116 @@
+from typing import Optional
+
+from office365.entity_collection import EntityCollection
+from office365.onedrive.sitepages.base import BaseSitePage
+from office365.onedrive.sitepages.canvas_layout import CanvasLayout
+from office365.onedrive.sitepages.title_area import TitleArea
+from office365.onedrive.sitepages.web_part import WebPart
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.function import FunctionQuery
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+
+
+class SitePage(BaseSitePage):
+    """This resource represents a page in the sitePages list. It contains the title, layout, and a collection of
+    webParts."""
+
+    def get_web_parts_by_position(
+        self, webPartIndex, horizontalSectionId, isInVerticalSection, columnId
+    ):
+        """
+        Get a collection of webPart by providing webPartPosition information.
+
+        :param float webPartIndex: Index of the current WebPart. Represents the order of WebPart in this column or
+             section. Only works if either columnId or isInVerticalSection is provided.
+        :param float horizontalSectionId: Indicate the horizontal section where the WebPart located in.
+        :param bool isInVerticalSection: Indicate whether the WebPart located in the vertical section.
+        :param float columnId: Indicate the identifier of the column where the WebPart located in. Only works
+             if horizontalSectionId is provided.
+        """
+        params = {
+            "webPartIndex": webPartIndex,
+            "horizontalSectionId": horizontalSectionId,
+            "isInverticalSection": isInVerticalSection,
+            "columnId": columnId,
+        }
+        return_type = EntityCollection(
+            self.context, WebPart, ResourcePath("webParts", self.resource_path)
+        )
+        qry = FunctionQuery(self, "getWebPartsByPosition", params, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def publish(self):
+        """
+        Publish 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.
+
+        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")
+        self.context.add_query(qry)
+        return self
+
+    @property
+    def promotion_kind(self):
+        # type: () -> Optional[str]
+        """Indicates the promotion kind of the sitePage."""
+        return self.properties.get("promotionKind", None)
+
+    @property
+    def show_comments(self):
+        # type: () -> Optional[bool]
+        """Determines whether or not to show comments at the bottom of the page."""
+        return self.properties.get("showComments", None)
+
+    @property
+    def show_recommended_pages(self):
+        # type: () -> Optional[bool]
+        """Determines whether or not to show recommended pages at the bottom of the page."""
+        return self.properties.get("showRecommendedPages", None)
+
+    @property
+    def thumbnail_web_url(self):
+        # type: () -> Optional[str]
+        """Indicates the promotion kind of the sitePage."""
+        return self.properties.get("thumbnailWebUrl", None)
+
+    @property
+    def title_area(self):
+        # type: () -> Optional[str]
+        """Title area on the SharePoint page."""
+        return self.properties.get("titleArea", TitleArea())
+
+    @property
+    def canvas_layout(self):
+        # type: () -> CanvasLayout
+        """The default termStore under this site."""
+        return self.properties.get(
+            "canvasLayout",
+            CanvasLayout(
+                self.context, ResourcePath("canvasLayout", self.resource_path)
+            ),
+        )
+
+    @property
+    def web_parts(self):
+        # type: () -> EntityCollection[WebPart]
+        """Collection of webparts on the SharePoint page."""
+        return self.properties.get(
+            "webParts",
+            EntityCollection(
+                self.context, WebPart, ResourcePath("webParts", self.resource_path)
+            ),
+        )
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "canvasLayout": self.canvas_layout,
+                "titleArea": self.title_area,
+                "webParts": self.web_parts,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(SitePage, self).get_property(name, default_value)

office365/onedrive/sitepages/title_area.py

@@ -0,0 +1,13 @@
+from office365.runtime.client_value import ClientValue
+
+
+class TitleArea(ClientValue):
+    """Represents the title area of a given SharePoint page."""
+
+    def __init__(self, alternativeText=None, enableGradientEffect=None):
+        """
+        :param str alternativeText: Alternative text on the title area.
+        :param bool enableGradientEffect: Indicates whether the title area has a gradient effect enabled.
+        """
+        self.alternativeText = alternativeText
+        self.enableGradientEffect = enableGradientEffect

office365/onedrive/sitepages/vertical_section.py

@@ -0,0 +1,27 @@
+from office365.entity import Entity
+from office365.entity_collection import EntityCollection
+from office365.onedrive.sitepages.web_part import WebPart
+from office365.runtime.paths.resource_path import ResourcePath
+
+
+class VerticalSection(Entity):
+    """Represents the vertical section in a given SharePoint page."""
+
+    @property
+    def web_parts(self):
+        # type: () -> EntityCollection[WebPart]
+        """The set of web parts in this section."""
+        return self.properties.get(
+            "webParts",
+            EntityCollection(
+                self.context, WebPart, ResourcePath("webParts", self.resource_path)
+            ),
+        )
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "webParts": self.web_parts,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(VerticalSection, self).get_property(name, default_value)

office365/onedrive/sitepages/web_part.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class WebPart(Entity):
+    """Represents a specific web part instance on a SharePoint page."""

office365/onedrive/sites/site.py

@@ -13,6 +13,7 @@ from office365.onedrive.lists.collection import ListCollection
 from office365.onedrive.operations.rich_long_running import RichLongRunningOperation
 from office365.onedrive.permissions.collection import PermissionCollection
 from office365.onedrive.sharepoint_ids import SharePointIds
+from office365.onedrive.sitepages.collection import SitePageCollection
 from office365.onedrive.sites.site_collection import SiteCollection
 from office365.onedrive.termstore.store import Store
 from office365.onenote.onenote import Onenote
@@ -224,6 +225,15 @@ class Site(BaseItem):
             Onenote(self.context, ResourcePath("onenote", self.resource_path)),
         )
 
+    @property
+    def pages(self):
+        # type: () -> SitePageCollection
+        """The collection of site pages under this site."""
+        return self.properties.get(
+            "pages",
+            SitePageCollection(self.context, ResourcePath("pages", self.resource_path)),
+        )
+
     @property
     def term_store(self):
         # type: () -> Store

office365/onedrive/workbooks/charts/data_labels.py

@@ -1,7 +1,19 @@
+from typing import Optional
+
 from office365.entity import Entity
 
 
 class WorkbookChartDataLabels(Entity):
     """Represents a collection of all the data labels on a chart point."""
 
-    pass
+    @property
+    def position(self):
+        # type: () -> Optional[str]
+        """DataLabelPosition value that represents the position of the data label."""
+        return self.properties.get("position", None)
+
+    @property
+    def separator(self):
+        # type: () -> Optional[str]
+        """String representing the separator used for the data labels on a chart."""
+        return self.properties.get("separator", None)

office365/onedrive/workbooks/tables/sort.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class WorkbookTableSort(Entity):
+    """Manages sorting operations on Table objects."""

office365/onedrive/workbooks/tables/table.py

@@ -8,6 +8,7 @@ from office365.onedrive.workbooks.tables.columns.collection import (
 from office365.onedrive.workbooks.tables.rows.collection import (
     WorkbookTableRowCollection,
 )
+from office365.onedrive.workbooks.tables.sort import WorkbookTableSort
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.function import FunctionQuery
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -56,12 +57,59 @@ class WorkbookTable(Entity):
         self.context.add_query(qry)
         return self
 
+    @property
+    def highlight_first_column(self):
+        # type: () -> Optional[bool]
+        """Indicates whether the first column contains special formatting."""
+        return self.properties.get("highlightFirstColumn", None)
+
+    @property
+    def highlight_last_column(self):
+        # type: () -> Optional[bool]
+        """Indicates whether the last column contains special formatting."""
+        return self.properties.get("highlightLastColumn", None)
+
+    @property
+    def legacy_id(self):
+        # type: () -> Optional[str]
+        """Legacy Id used in older Excel clients. The value of the identifier remains the same even when the table
+        is renamed. This property should be interpreted as an opaque string value and shouldn't be parsed to any
+        other type."""
+        return self.properties.get("legacyId", None)
+
     @property
     def name(self):
         # type: () -> Optional[str]
         """Name of the table."""
         return self.properties.get("name", None)
 
+    @property
+    def show_banded_columns(self):
+        # type: () -> Optional[bool]
+        """Indicates whether the columns show banded formatting in which odd columns are highlighted differently
+        from even ones to make reading the table easier."""
+        return self.properties.get("showBandedColumns", None)
+
+    @property
+    def show_banded_rows(self):
+        # type: () -> Optional[bool]
+        """Indicates whether the rows show banded formatting in which odd rows are highlighted differently from even
+        ones to make reading the table easier."""
+        return self.properties.get("showBandedRows", None)
+
+    @property
+    def show_filter_button(self):
+        # type: () -> Optional[bool]
+        """Indicates whether the filter buttons are visible at the top of each column header. Setting this is only
+        allowed if the table contains a header row."""
+        return self.properties.get("showFilterButton", None)
+
+    @property
+    def show_headers(self):
+        # type: () -> Optional[bool]
+        """Indicates whether the header row is visible or not. This value can be set to show or remove the header row"""
+        return self.properties.get("showHeaders", None)
+
     @property
     def columns(self):
         # type: () -> WorkbookTableColumnCollection
@@ -84,6 +132,15 @@ class WorkbookTable(Entity):
             ),
         )
 
+    @property
+    def sort(self):
+        # type: () -> WorkbookTableSort
+        """Represents the sorting for the table."""
+        return self.properties.get(
+            "sort",
+            WorkbookTableSort(self.context, ResourcePath("sort", self.resource_path)),
+        )
+
     @property
     def worksheet(self):
         """The worksheet containing the current table."""

office365/onedrive/workbooks/worksheets/protection.py

@@ -1,7 +1,26 @@
 from office365.entity import Entity
+from office365.onedrive.workbooks.worksheets.protection_options import (
+    WorkbookWorksheetProtectionOptions,
+)
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 
 
 class WorkbookWorksheetProtection(Entity):
     """Represents the protection of a sheet object."""
 
-    pass
+    def protect(self, options=None):
+        """Protect a worksheet. It throws if the worksheet has been protected."""
+        qry = ServiceOperationQuery(self, "protect", parameters_type=options)
+        self.context.add_query(qry)
+        return self
+
+    def unprotect(self):
+        """Unprotect a worksheet"""
+        qry = ServiceOperationQuery(self, "unprotect")
+        self.context.add_query(qry)
+        return self
+
+    @property
+    def options(self):
+        """ """
+        return self.properties.get("options", WorkbookWorksheetProtectionOptions())

office365/onedrive/workbooks/worksheets/protection_options.py

@@ -3,3 +3,10 @@ from office365.runtime.client_value import ClientValue
 
 class WorkbookWorksheetProtectionOptions(ClientValue):
     """Represents the protection of a sheet object."""
+
+    def __init__(
+        self, allowAutoFilter=None, allowDeleteColumns=None, allowDeleteRows=None
+    ):
+        self.allowAutoFilter = allowAutoFilter
+        self.allowDeleteColumns = allowDeleteColumns
+        self.allowDeleteRows = allowDeleteRows

office365/outlook/calendar/calendar.py

@@ -135,9 +135,7 @@ class Calendar(Entity):
     @property
     def name(self):
         # type: () -> Optional[str]
-        """
-        The calendar name
-        """
+        """The calendar name"""
         return self.properties.get("name", None)
 
     @property

office365/outlook/calendar/events/event.py

@@ -8,6 +8,7 @@ from office365.directory.extensions.extension import Extension
 from office365.entity_collection import EntityCollection
 from office365.outlook.calendar.attendees.attendee import Attendee
 from office365.outlook.calendar.dateTimeTimeZone import DateTimeTimeZone
+from office365.outlook.calendar.response_status import ResponseStatus
 from office365.outlook.item import OutlookItem
 from office365.outlook.mail.attachments.collection import AttachmentCollection
 from office365.outlook.mail.item_body import ItemBody
@@ -195,6 +196,30 @@ class Event(OutlookItem):
         """The preview of the message associated with the event. It is in text format."""
         return self.properties.get("bodyPreview", None)
 
+    @property
+    def reminder_minutes_before_start(self):
+        # type: () -> Optional[int]
+        """The number of minutes before the event start time that the reminder alert occurs."""
+        return self.properties.get("reminderMinutesBeforeStart", None)
+
+    @property
+    def response_requested(self):
+        # type: () -> Optional[bool]
+        """Default is true, which represents the organizer would like an invitee to send a response to the event."""
+        return self.properties.get("responseRequested", None)
+
+    @property
+    def response_status(self):
+        # type: () -> Optional[str]
+        """Indicates the type of response sent in response to an event message."""
+        return self.properties.get("responseStatus", ResponseStatus())
+
+    @property
+    def series_master_id(self):
+        # type: () -> Optional[str]
+        """The ID for the recurring series master item, if this event is part of a recurring series."""
+        return self.properties.get("seriesMasterId", None)
+
     @property
     def subject(self):
         # type: () -> Optional[str]
@@ -212,6 +237,26 @@ class Event(OutlookItem):
         """The location of the event."""
         return self.properties.get("location", Location())
 
+    @property
+    def transaction_id(self):
+        # type: () -> Optional[str]
+        """
+        A custom identifier specified by a client app for the server to avoid redundant POST operations in case of
+        client retries to create the same event. This is useful when low network connectivity causes the client to
+        time out before receiving a response from the server for the client's prior create-event request.
+        After you set transactionId when creating an event, you cannot change transactionId in a subsequent update.
+        This property is only returned in a response payload if an app has set it
+        """
+        return self.properties.get("transactionId", None)
+
+    @property
+    def type(self):
+        # type: () -> Optional[str]
+        """
+        The event type. Possible values are: singleInstance, occurrence, exception, seriesMaster
+        """
+        return self.properties.get("type", None)
+
     @property
     def web_link(self):
         # type: () -> Optional[str]

office365/outlook/calendar/response_status.py

@@ -0,0 +1,11 @@
+from office365.runtime.client_value import ClientValue
+
+
+class ResponseStatus(ClientValue):
+    """Represents the response status of an attendee or organizer for a meeting request."""
+
+    def __init__(self, response=None):
+        """
+        :type response: str
+        """
+        self.response = response

office365/outlook/calendar/rooms/room.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.outlook.calendar.place import Place
 
 
@@ -6,3 +8,15 @@ class Room(Place):
     Represents a room in a tenant.
     In Exchange Online, each room is associated with a room mailbox. Derived from place.
     """
+
+    @property
+    def audio_device_name(self):
+        # type: () -> Optional[str]
+        """Specifies the name of the audio device in the room."""
+        return self.properties.get("audioDeviceName", None)
+
+    @property
+    def building(self):
+        # type: () -> Optional[str]
+        """Specifies the building name or building number that the room is in."""
+        return self.properties.get("building", None)

office365/outlook/mail/automatic_replies_mailtips.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class AutomaticRepliesMailTips(ClientValue):
+    """MailTips about any automatic replies that have been set up on a mailbox."""

office365/outlook/mail/conversation.py

@@ -49,9 +49,7 @@ class Conversation(Entity):
 
     @property
     def unique_senders(self):
-        """
-        All the users that sent a message to this Conversation.
-        """
+        """All the users that sent a message to this Conversation."""
         return self.properties.get("uniqueSenders", StringCollection())
 
     @property

office365/outlook/mail/folders/folder.py

@@ -86,9 +86,7 @@ class MailFolder(Entity):
     @property
     def parent_folder_id(self):
         # type: () -> Optional[str]
-        """
-        The unique identifier for the mailFolder's parent mailFolder.
-        """
+        """The unique identifier for the mailFolder's parent mailFolder."""
         return self.properties.get("parentFolderId", None)
 
     @property

office365/outlook/mail/tips.py

@@ -0,0 +1,17 @@
+from office365.outlook.mail.automatic_replies_mailtips import AutomaticRepliesMailTips
+from office365.runtime.client_value import ClientValue
+
+
+class MailTips(ClientValue):
+    """Informative messages about a recipient, that are displayed to users while they're composing a message.
+    For example, an out-of-office message as an automatic reply for a message recipient.
+    """
+
+    def __init__(self, automaticReplies=AutomaticRepliesMailTips(), customMailTip=None):
+        """
+        :param AutomaticRepliesMailTips automaticReplies: Mail tips for automatic reply if it has been set up by
+            the recipient.
+        :param str customMailTip: A custom mail tip that can be set on the recipient's mailbox.
+        """
+        self.automaticReplies = automaticReplies
+        self.customMailTip = customMailTip

office365/planner/plans/plan.py

@@ -7,6 +7,7 @@ from office365.planner.buckets.bucket import PlannerBucket
 from office365.planner.plans.container import PlannerPlanContainer
 from office365.planner.plans.details import PlannerPlanDetails
 from office365.planner.tasks.task import PlannerTask
+from office365.runtime.http.request_options import RequestOptions
 from office365.runtime.paths.resource_path import ResourcePath
 
 
@@ -18,11 +19,20 @@ class PlannerPlan(Entity):
     """
 
     def __str__(self):
-        return self.title
+        return self.title or self.entity_type_name
 
     def __repr__(self):
         return self.id or self.entity_type_name
 
+    def delete_object(self):
+        def _construct_request(request):
+            # type: (RequestOptions) -> None
+            request.set_header("If-Match", self.properties.get("__etag"))
+
+        return (
+            super(PlannerPlan, self).delete_object().before_execute(_construct_request)
+        )
+
     @property
     def container(self):
         """Identity of the user, device, or application which created the plan."""

office365/reports/root.py

@@ -11,6 +11,17 @@ from office365.runtime.queries.function import FunctionQuery
 class ReportRoot(Entity):
     """Represents a container for Azure Active Directory (Azure AD) reporting resources."""
 
+    def device_configuration_device_activity(self):
+        """
+        Metadata for the device configuration device activity report
+        """
+        return_type = ClientResult(self.context, Report())
+        qry = FunctionQuery(
+            self, "deviceConfigurationDeviceActivity", None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def device_configuration_user_activity(self):
         """
         Metadata for the device configuration user activity report
@@ -20,6 +31,15 @@ class ReportRoot(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def managed_device_enrollment_failure_details(self):
+        """ """
+        return_type = ClientResult(self.context, Report())
+        qry = FunctionQuery(
+            self, "managedDeviceEnrollmentFailureDetails", None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def managed_device_enrollment_top_failures(self, period=None):
         """
         Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.
@@ -188,6 +208,19 @@ class ReportRoot(Entity):
         self.context.add_query(qry)
         return qry.return_type
 
+    def get_mailbox_usage_quota_status_mailbox_counts(self, period):
+        """
+
+        :param str period: Specifies the length of time over which the report is aggregated.
+            The supported values for {period_value} are: D7, D30, D90, and D180. These values follow the format
+            Dn where n represents the number of days over which the report is aggregated. Required.
+        """
+        qry = create_report_query(
+            self, "getMailboxUsageQuotaStatusMailboxCounts", period
+        )
+        self.context.add_query(qry)
+        return qry.return_type
+
     def get_sharepoint_activity_pages(self, period):
         """
         Get the number of unique pages visited by users.

office365/runtime/auth/authentication_context.py

@@ -47,6 +47,7 @@ class AuthenticationContext(object):
         cert_path=None,
         private_key=None,
         scopes=None,
+        passphrase=None,
     ):
         """Initializes a client to acquire a token via certificate credentials
 
@@ -56,6 +57,7 @@ class AuthenticationContext(object):
         :param str or None cert_path: Path to A PEM encoded certificate private key.
         :param str or None private_key: A PEM encoded certificate private key.
         :param list[str] or None scopes:  Scopes requested to access a protected API (a resource)
+        :param str passphrase: Passphrase if the private_key is encrypted
         """
         if scopes is None:
             resource = get_absolute_url(self.url)
@@ -70,7 +72,11 @@ class AuthenticationContext(object):
 
         def _acquire_token():
             authority_url = "https://login.microsoftonline.com/{0}".format(tenant)
-            credentials = {"thumbprint": thumbprint, "private_key": private_key}
+            credentials = {
+                "thumbprint": thumbprint,
+                "private_key": private_key,
+                "passphrase": passphrase,
+            }
             import msal
 
             app = msal.ConfidentialClientApplication(
@@ -187,7 +193,11 @@ class AuthenticationContext(object):
                 browser_mode = kwargs.get("browser_mode", False)
                 environment = kwargs.get("environment")
                 provider = SamlTokenProvider(
-                    self.url, credentials.userName, credentials.password, browser_mode, environment
+                    self.url,
+                    credentials.userName,
+                    credentials.password,
+                    browser_mode,
+                    environment,
                 )
         else:
             raise ValueError("Unknown credential type")

office365/runtime/odata/json_format.py

@@ -4,9 +4,10 @@ from abc import ABCMeta
 class ODataJsonFormat(object):
     """OData JSON format"""
 
-    def __init__(self, metadata_level=None):
-        # type: (str) -> None
+    def __init__(self, metadata_level=None, etag=None):
+        # type: (str, str) -> None
         self.metadata_level = metadata_level
+        self.etag = etag
 
     __metaclass__ = ABCMeta