Office365-REST-Python-Client 2.5.11__py3-none-any.whl → 2.5.13__py3-none-any.whl

office365/onedrive/sharepoint_settings.py

@@ -1,6 +1,7 @@
 from typing import Optional
 
 from office365.entity import Entity
+from office365.onedrive.idle_session_signout import IdleSessionSignOut
 from office365.runtime.types.collections import StringCollection
 
 
@@ -26,6 +27,18 @@ class SharepointSettings(Entity):
             "excludedFileExtensionsForSyncApp", StringCollection()
         )
 
+    @property
+    def idle_session_sign_out(self):
+        # type: () -> IdleSessionSignOut
+        """Specifies the idle session sign-out policies for the tenant."""
+        return self.properties.get("idleSessionSignOut", IdleSessionSignOut())
+
+    @property
+    def is_commenting_on_site_pages_enabled(self):
+        # type: () -> Optional[bool]
+        """Indicates whether comments are allowed on modern site pages in SharePoint."""
+        return self.properties.get("isCommentingOnSitePagesEnabled", None)
+
     @property
     def site_creation_default_managed_path(self):
         # type: () -> Optional[str]

office365/onedrive/sitepages/title_area.py

@@ -4,10 +4,20 @@ 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):
+    def __init__(
+        self,
+        alternative_text=None,
+        enable_gradient_effect=None,
+        image_web_url=None,
+        show_author=None,
+    ):
         """
-        :param str alternativeText: Alternative text on the title area.
-        :param bool enableGradientEffect: Indicates whether the title area has a gradient effect enabled.
+        :param str alternative_text: Alternative text on the title area.
+        :param bool enable_gradient_effect: Indicates whether the title area has a gradient effect enabled.
+        :param str image_web_url:
+        :param bool show_author:
         """
-        self.alternativeText = alternativeText
-        self.enableGradientEffect = enableGradientEffect
+        self.alternativeText = alternative_text
+        self.enableGradientEffect = enable_gradient_effect
+        self.imageWebUrl = image_web_url
+        self.showAuthor = show_author

office365/outlook/calendar/sharing/message_action.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class CalendarSharingMessageAction(ClientValue):
+    """"""

office365/outlook/calendar/sharing_message.py

@@ -1,5 +1,24 @@
+from office365.outlook.calendar.sharing.message_action import (
+    CalendarSharingMessageAction,
+)
 from office365.outlook.mail.messages.message import Message
 
 
 class CalendarSharingMessage(Message):
     """"""
+
+    @property
+    def sharing_message_action(self):
+        """"""
+        return self.properties.setdefault(
+            "sharingMessageAction", CalendarSharingMessageAction()
+        )
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_type_mapping = {
+                "sharingMessageAction": self.sharing_message_action,
+            }
+            default_value = property_type_mapping.get(name, None)
+
+        return super(CalendarSharingMessage, self).get_property(name, default_value)

office365/outlook/calendar/timezones/custom.py

@@ -5,3 +5,12 @@ class CustomTimeZone(TimeZoneBase):
     """
     Represents a time zone where the transition from standard to daylight saving time, or vice versa is not standard.
     """
+
+    def __init__(self, bias=None):
+        """
+        :param int bias: The time offset of the time zone from Coordinated Universal Time (UTC). This value is in
+            minutes. Time zones that are ahead of UTC have a positive offset; time zones that are behind UTC have
+            a negative offset.
+        """
+        super(CustomTimeZone, self).__init__()
+        self.bias = bias

office365/outlook/mail/automatic_replies_setting.py

@@ -1,3 +1,4 @@
+from office365.outlook.calendar.dateTimeTimeZone import DateTimeTimeZone
 from office365.runtime.client_value import ClientValue
 
 
@@ -12,6 +13,9 @@ class AutomaticRepliesSetting(ClientValue):
         external_audience=None,
         external_reply_message=None,
         internal_reply_message=None,
+        scheduled_end_datetime=DateTimeTimeZone(),
+        scheduled_start_datetime=DateTimeTimeZone(),
+        status=None,
     ):
         """
         :param str external_audience: The set of audience external to the signed-in user's organization who will
@@ -25,3 +29,6 @@ class AutomaticRepliesSetting(ClientValue):
         self.externalAudience = external_audience
         self.externalReplyMessage = external_reply_message
         self.internalReplyMessage = internal_reply_message
+        self.scheduledEndDateTime = scheduled_end_datetime
+        self.scheduledStartDateTime = scheduled_start_datetime
+        self.status = status

office365/outlook/mail/messages/rules/predicates.py

@@ -15,6 +15,8 @@ class MessageRulePredicates(ClientValue):
         from_addresses=None,
         has_attachments=None,
         header_contains=None,
+        importance=None,
+        is_approval_request=None,
     ):
         """
         :param list[str] body_contains: Represents the strings that should appear in the body of an incoming message
@@ -28,6 +30,7 @@ class MessageRulePredicates(ClientValue):
         :param bool has_attachments: Indicates whether an incoming message must have attachments in order for the
              condition or exception to apply.
         :param list[str] header_contains:
+        :param bool is_approval_request:
         """
         self.bodyContains = StringCollection(body_contains)
         self.bodyOrSubjectContains = StringCollection(body_or_subject_contains)
@@ -35,3 +38,5 @@ class MessageRulePredicates(ClientValue):
         self.fromAddresses = ClientValueCollection(Recipient, from_addresses)
         self.hasAttachments = has_attachments
         self.headerContains = StringCollection(header_contains)
+        self.importance = importance
+        self.isApprovalRequest = is_approval_request

office365/outlook/mail/messages/rules/rule.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.outlook.mail.messages.rules.actions import MessageRuleActions
 from office365.outlook.mail.messages.rules.predicates import MessageRulePredicates
@@ -26,7 +28,6 @@ class MessageRule(Entity):
 
     @property
     def is_read_only(self):
-        """
-        Indicates if the rule is read-only and cannot be modified or deleted by the rules REST API.
-        """
+        # type: () -> Optional[bool]
+        """Indicates if the rule is read-only and cannot be modified or deleted by the rules REST API."""
         return self.properties.get("isReadOnly", None)

office365/runtime/client_object.py

@@ -6,6 +6,7 @@ from typing import TYPE_CHECKING, Any, Callable, Generic, List, Optional, TypeVa
 from requests import Response
 from typing_extensions import Self
 
+from office365.runtime.client_request_exception import ClientRequestException
 from office365.runtime.client_runtime_context import ClientRuntimeContext
 from office365.runtime.client_value import ClientValue
 from office365.runtime.http.request_options import RequestOptions
@@ -55,7 +56,12 @@ class ClientObject(Generic[T]):
         return self
 
     def execute_query_retry(
-        self, max_retry=5, timeout_secs=5, success_callback=None, failure_callback=None
+        self,
+        max_retry=5,
+        timeout_secs=5,
+        success_callback=None,
+        failure_callback=None,
+        exceptions=(ClientRequestException,),
     ):
         """
         Executes the current set of data retrieval queries and method invocations and retries it if needed.
@@ -66,12 +72,14 @@ class ClientObject(Generic[T]):
             if the request executes successfully.
         :param (int, requests.exceptions.RequestException)-> None failure_callback: A callback to call if the request
             fails to execute
+        :param exceptions: tuple of exceptions that we retry
         """
         self.context.execute_query_retry(
             max_retry=max_retry,
             timeout_secs=timeout_secs,
             success_callback=success_callback,
             failure_callback=failure_callback,
+            exceptions=exceptions,
         )
         return self
 

office365/runtime/client_object_collection.py

@@ -138,7 +138,7 @@ class ClientObjectCollection(ClientObject, Generic[T]):
         return self
 
     def paged(self, page_size=None, page_loaded=None):
-        # type: (int, Callable[[Self], None]) -> Self
+        # type: (int, Callable[[Self], None] | None) -> Self
         """Retrieves via server-driven paging mode"""
         self._paged_mode = True
         if callable(page_loaded):
@@ -158,7 +158,7 @@ class ClientObjectCollection(ClientObject, Generic[T]):
         return self
 
     def get_all(self, page_size=None, page_loaded=None):
-        # type: (int, Callable[[Self], None]) -> Self
+        # type: (int, Callable[[Self], None] | None) -> Self
         """Gets all the items in a collection, regardless of the size."""
 
         def _page_loaded(col):

office365/runtime/client_result.py

@@ -3,6 +3,7 @@ from typing import TYPE_CHECKING, Callable, Generic, Optional, TypeVar
 
 from typing_extensions import Self
 
+from office365.runtime.client_request_exception import ClientRequestException
 from office365.runtime.http.request_options import RequestOptions
 
 if TYPE_CHECKING:
@@ -54,13 +55,29 @@ class ClientResult(Generic[T]):
         return self
 
     def execute_query_retry(
-        self, max_retry=5, timeout_secs=5, success_callback=None, failure_callback=None
+        self,
+        max_retry=5,
+        timeout_secs=5,
+        success_callback=None,
+        failure_callback=None,
+        exceptions=(ClientRequestException,),
     ):
-        """Executes the current set of data retrieval queries and method invocations and retries it if needed."""
+        """
+        Executes the current set of data retrieval queries and method invocations and retries it if needed.
+
+        :param int max_retry: Number of times to retry the request
+        :param int timeout_secs: Seconds to wait before retrying the request.
+        :param (office365.runtime.client_object.ClientObject)-> None success_callback: A callback to call
+            if the request executes successfully.
+        :param (int, requests.exceptions.RequestException)-> None failure_callback: A callback to call if the request
+            fails to execute
+        :param exceptions: tuple of exceptions that we retry
+        """
         self._context.execute_query_retry(
             max_retry=max_retry,
             timeout_secs=timeout_secs,
             success_callback=success_callback,
             failure_callback=failure_callback,
+            exceptions=exceptions,
         )
         return self

office365/runtime/odata/query_options.py

@@ -59,6 +59,9 @@ class QueryOptions(object):
                 ClientObjectCollection,
             )
 
+            if name in query_options.select:
+                continue
+
             if isinstance(client_object, ClientObjectCollection):
                 prop = client_object.create_typed_object().get_property(name)
             else:

office365/runtime/odata/v4/batch_request.py

@@ -46,11 +46,8 @@ class ODataV4BatchRequest(ODataRequest):
             yield qry, resp
 
     def _prepare_payload(self, query):
-        """
-        Serializes a batch request body.
-
-        :type query: office365.runtime.queries.batch.BatchQuery
-        """
+        # type: (BatchQuery) -> Dict
+        """Serializes a batch request body."""
         requests_json = []
         for qry in query.queries:
             qry_id = str(len(requests_json))
@@ -63,16 +60,16 @@ class ODataV4BatchRequest(ODataRequest):
         # type: (ClientQuery, str, Optional[List[str]]) -> Dict[str, Any]
         """ """
         request = query.build_request()
-        allowed_props = ["id", "method", "headers", "url", "body"]
-        request_json = dict(
-            (k, v)
-            for k, v in vars(request).items()
-            if v is not None and k in allowed_props
-        )
-        request_json["id"] = query_id
+
+        request_json = {
+            "id": query_id,
+            "url": request.url.replace(query.context.service_root_url(), ""),
+            "method": request.method,
+            "headers": request.headers,
+        }
+        if request.data:
+            request_json["body"] = request.data
+
         if depends_on is not None:
             request_json["dependsOn"] = depends_on
-        request_json["url"] = request_json["url"].replace(
-            query.context.service_root_url(), ""
-        )
         return request_json

office365/runtime/queries/batch.py

@@ -61,3 +61,7 @@ class BatchQuery(ClientQuery):
     @property
     def url(self):
         return "{0}/$batch".format(self.context.service_root_url())
+
+    @property
+    def return_type(self):
+        return [q.return_type for q in self._queries]

office365/sharepoint/appprincipal/identity_provider.py

@@ -1,3 +1,4 @@
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
 
@@ -6,4 +7,9 @@ class AppPrincipalIdentityProvider(Entity):
 
     @staticmethod
     def external(context):
-        pass
+        return_type = AppPrincipalIdentityProvider(context)
+        qry = ServiceOperationQuery(
+            return_type, "External", None, None, None, return_type, True
+        )
+        context.add_query(qry)
+        return return_type

office365/sharepoint/apps/context_site.py

@@ -0,0 +1,41 @@
+from office365.onedrive.sites.site import Site
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.paths.service_operation import ServiceOperationPath
+from office365.sharepoint.client_context import ClientContext
+from office365.sharepoint.entity import Entity
+from office365.sharepoint.webs.web import Web
+
+
+class AppContextSite(Entity):
+    """ """
+
+    def __init__(self, context, site_url):
+        # type: (ClientContext, str) -> None
+        """"""
+        static_path = ServiceOperationPath(
+            "SP.AppContextSite",
+            {"siteUrl": site_url},
+        )
+        super(AppContextSite, self).__init__(context, static_path)
+
+    @property
+    def site(self):
+        """"""
+        return self.properties.get(
+            "Site",
+            Site(
+                self.context,
+                ResourcePath("Site", self.resource_path),
+            ),
+        )
+
+    @property
+    def web(self):
+        """"""
+        return self.properties.get(
+            "Web",
+            Web(
+                self.context,
+                ResourcePath("Web", self.resource_path),
+            ),
+        )

office365/sharepoint/authpolicy/events/collection.py

@@ -0,0 +1,11 @@
+from office365.sharepoint.authpolicy.events.event import SPAuthEvent
+from office365.sharepoint.entity_collection import EntityCollection
+
+
+class SPAuthEventCollection(EntityCollection[SPAuthEvent]):
+    """Represents a collection of Field resource."""
+
+    def __init__(self, context, resource_path=None, parent=None):
+        super(SPAuthEventCollection, self).__init__(
+            context, SPAuthEvent, resource_path, parent
+        )

office365/sharepoint/authpolicy/events/{auth_event.py → event.py}

@@ -2,6 +2,7 @@ from office365.sharepoint.entity import Entity
 
 
 class SPAuthEvent(Entity):
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.AuthPolicy.Events.SPAuthEvent"

office365/sharepoint/authpolicy/events/role_assignment_resource_payload.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class RoleAssignmentResourcePayload(ClientValue):
+    """ """

office365/sharepoint/brandcenter/brand_center.py

@@ -0,0 +1,9 @@
+from office365.sharepoint.entity import Entity
+
+
+class BrandCenter(Entity):
+    """
+    The SharePoint brand center API offers a centralized branding management application
+    that empowers your brand managers or designated brand owners to help your organization to customize
+    the look and feel of their experiences.
+    """

office365/sharepoint/brandcenter/configuration.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class BrandCenterConfiguration(ClientValue):
+    """ """

office365/sharepoint/changes/change.py

@@ -16,9 +16,7 @@ class Change(Entity):
 
     @property
     def change_token(self):
-        """
-        Returns an ChangeToken that represents the change.
-        """
+        """Returns an ChangeToken that represents the change."""
         return self.properties.get("ChangeToken", ChangeToken())
 
     @property

office365/sharepoint/changes/collection.py

@@ -22,6 +22,7 @@ class ChangeCollection(EntityCollection[Change]):
         from office365.sharepoint.changes.item import ChangeItem
         from office365.sharepoint.changes.list import ChangeList
         from office365.sharepoint.changes.user import ChangeUser
+        from office365.sharepoint.changes.view import ChangeView
         from office365.sharepoint.changes.web import ChangeWeb
 
         if "ItemId" in properties and "ListId" in properties:
@@ -40,3 +41,5 @@ class ChangeCollection(EntityCollection[Change]):
             self._item_type = ChangeAlert
         elif "FieldId" in properties:
             self._item_type = ChangeField
+        elif "ViewId" in properties:
+            self._item_type = ChangeView

office365/sharepoint/changes/folder.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.changes.change import Change
 
 
@@ -6,8 +8,12 @@ class ChangeFolder(Change):
 
     @property
     def unique_id(self):
+        # type: () -> Optional[str]
+        """Identifies the folder that has changed."""
         return self.properties.get("UniqueId", None)
 
     @property
     def web_id(self):
+        # type: () -> Optional[str]
+        """Identifies the site that contains the changed folder."""
         return self.properties.get("WebId", None)

office365/sharepoint/changes/group.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.changes.change import Change
 
 
@@ -6,5 +8,6 @@ class ChangeGroup(Change):
 
     @property
     def group_id(self):
+        # type: () -> Optional[int]
         """Identifies the changed group."""
         return self.properties.get("GroupId", None)

office365/sharepoint/changes/list.py

@@ -16,9 +16,22 @@ class ChangeList(Change):
 
     @property
     def base_template(self):
+        # type: () -> Optional[int]
         """An SP.ListTemplateType object that returns the list template type of the list."""
         return self.properties.get("BaseTemplate", None)
 
+    @property
+    def editor(self):
+        # type: () -> Optional[str]
+        """A string that returns the name of the user who modified the list."""
+        return self.properties.get("Editor", None)
+
+    @property
+    def hidden(self):
+        # type: () -> Optional[bool]
+        """Returns a Boolean value that indicates whether a list is a hidden list."""
+        return self.properties.get("Hidden", None)
+
     @property
     def list_id(self):
         # type: () -> Optional[str]

office365/sharepoint/changes/view.py

@@ -0,0 +1,25 @@
+from typing import Optional
+
+from office365.sharepoint.changes.change import Change
+
+
+class ChangeView(Change):
+    """Specifies a change on a view."""
+
+    @property
+    def view_id(self):
+        # type: () -> Optional[str]
+        """Identifies the changed view."""
+        return self.properties.get("ViewId", None)
+
+    @property
+    def list_id(self):
+        # type: () -> Optional[str]
+        """Identifies the list that contains the changed view."""
+        return self.properties.get("ListId", None)
+
+    @property
+    def web_id(self):
+        # type: () -> Optional[str]
+        """Identifies the site that contains the changed view."""
+        return self.properties.get("WebId", None)

office365/sharepoint/client_context.py

@@ -8,6 +8,7 @@ from office365.runtime.auth.authentication_context import AuthenticationContext
 from office365.runtime.auth.client_credential import ClientCredential
 from office365.runtime.auth.token_response import TokenResponse
 from office365.runtime.auth.user_credential import UserCredential
+from office365.runtime.client_object import ClientObject
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_runtime_context import ClientRuntimeContext
 from office365.runtime.compat import get_absolute_url, urlparse
@@ -41,7 +42,7 @@ class ClientContext(ClientRuntimeContext):
     """SharePoint client context (SharePoint v1 API)"""
 
     def __init__(self, base_url, auth_context=None):
-        # type: (str, AuthenticationContext) -> None
+        # type: (str, AuthenticationContext | None) -> None
         """
         Instantiates a SharePoint client context
 
@@ -197,11 +198,11 @@ class ClientContext(ClientRuntimeContext):
         return self
 
     def execute_batch(self, items_per_batch=100, success_callback=None):
-        # type: (int, Callable[[int], None]) -> Self
+        # type: (int, Callable[[List[ClientObject|ClientResult]], None]) -> Self
         """
         Construct and submit to a server a batch request
         :param int items_per_batch: Maximum to be selected for bulk operation
-        :param (int)-> None success_callback: A callback
+        :param (List[ClientObject|ClientResult])-> None success_callback: A success callback
         """
         batch_request = ODataBatchV3Request(JsonLightFormat())
         batch_request.beforeExecute += self._authenticate_request
@@ -210,7 +211,7 @@ class ClientContext(ClientRuntimeContext):
             qry = self._get_next_query(items_per_batch)
             batch_request.execute_query(qry)
             if callable(success_callback):
-                success_callback(items_per_batch)
+                success_callback(qry.return_type)
         return self
 
     def pending_request(self):
@@ -410,6 +411,14 @@ class ClientContext(ClientRuntimeContext):
 
         return AnnouncementsController(self, ResourcePath("Announcements"))
 
+    @property
+    def brand_center(self):
+        """Alias to BrandCenter"""
+
+        from office365.sharepoint.brandcenter.brand_center import BrandCenter
+
+        return BrandCenter(self, ResourcePath("BrandCenter"))
+
     @property
     def client_people_picker(self):
         """Query principals service alias"""
@@ -701,6 +710,16 @@ class ClientContext(ClientRuntimeContext):
 
         return WorkflowServicesManager.current(self)
 
+    @property
+    def workflow_deployment_service(self):
+        """Alias to WorkflowServicesManager"""
+
+        from office365.sharepoint.workflowservices.deployment_service import (
+            WorkflowDeploymentService,
+        )
+
+        return WorkflowDeploymentService(self)
+
     @property
     def work_items(self):
         """"""

office365/sharepoint/contenttypes/fieldlinks/collection.py

@@ -1,3 +1,5 @@
+from typing_extensions import Self
+
 from office365.runtime.paths.service_operation import ServiceOperationPath
 from office365.runtime.queries.create_entity import CreateEntityQuery
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -52,6 +54,7 @@ class FieldLinkCollection(EntityCollection[FieldLink]):
         )
 
     def reorder(self, internal_names):
+        # type: (list[str]) -> Self
         """
         Rearranges the collection of field links in the order in which field internal names are specified.
 

office365/sharepoint/copilot/file_collection.py

@@ -0,0 +1,27 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.copilot.file_collection_query_result import (
+    CopilotFileCollectionQueryResult,
+)
+from office365.sharepoint.entity import Entity
+
+
+class CopilotFileCollection(Entity):
+    """ """
+
+    @staticmethod
+    def get_working_set_files(context, top=None, order_by=None, skip_token=None):
+        """ """
+        payload = {"top": top, "orderBy": order_by, "skipToken": skip_token}
+        return_type = ClientResult(context, CopilotFileCollectionQueryResult())
+        qry = ServiceOperationQuery(
+            CopilotFileCollection(context),
+            "GetWorkingSetFiles",
+            None,
+            payload,
+            None,
+            return_type,
+            True,
+        )
+        context.add_query(qry)
+        return return_type