Office365-REST-Python-Client 2.5.12__py3-none-any.whl → 2.5.14__py3-none-any.whl

office365/sharepoint/utilities/wopi_host.py

@@ -0,0 +1,45 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.client_context import ClientContext
+from office365.sharepoint.entity import Entity
+
+
+class WopiHostUtility(Entity):
+    """ """
+
+    @staticmethod
+    def generate_file_bundle(context):
+        # type: (ClientContext) -> ClientResult[str]
+        """ """
+        return_type = ClientResult(context)
+        qry = ServiceOperationQuery(
+            WopiHostUtility(context),
+            "GenerateFileBundle",
+            None,
+            None,
+            None,
+            return_type,
+            True,
+        )
+        context.add_query(qry)
+        return return_type
+
+    @staticmethod
+    def get_wopi_origins(context):
+        return_type = ClientResult(context, ClientValueCollection(str))
+        qry = ServiceOperationQuery(
+            WopiHostUtility(context),
+            "GetWopiOrigins",
+            None,
+            None,
+            None,
+            return_type,
+            True,
+        )
+        context.add_query(qry)
+        return return_type
+
+    @property
+    def entity_type_name(self):
+        return "SP.Utilities.WopiHostUtility"

office365/sharepoint/viva/connections_page.py

@@ -0,0 +1,8 @@
+from office365.sharepoint.entity import Entity
+
+
+class VivaConnectionsPage(Entity):
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.EmployeeEngagement.VivaConnectionsPage"

office365/sharepoint/viva/dashboard_configuration.py

@@ -0,0 +1,8 @@
+from office365.runtime.client_value import ClientValue
+
+
+class DashboardConfiguration(ClientValue):
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.EmployeeEngagement.DashboardConfiguration"

office365/sharepoint/viva/employee_engagement.py

@@ -4,6 +4,8 @@ from office365.runtime.queries.function import FunctionQuery
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.viva.app_configuration import AppConfiguration
+from office365.sharepoint.viva.connections_page import VivaConnectionsPage
+from office365.sharepoint.viva.dashboard_configuration import DashboardConfiguration
 from office365.sharepoint.viva.home import VivaHome
 
 
@@ -18,13 +20,31 @@ class EmployeeEngagement(Entity):
         :param str override_language_code:
         """
         return_type = ClientResult(self.context, str())
-        payload = {"return return_type": override_language_code}
+        payload = {"override_language_code": override_language_code}
         qry = ServiceOperationQuery(
             self, "DashboardContent", None, payload, None, return_type
         )
         self.context.add_query(qry)
         return return_type
 
+    def full_dashboard_content(
+        self, canvas_as_json=None, include_personalization_data=None
+    ):
+        """
+        :param bool canvas_as_json:
+        :param bool include_personalization_data:
+        """
+        return_type = ClientResult(self.context, DashboardConfiguration())
+        payload = {
+            "canvasAsJson": canvas_as_json,
+            "includePersonalizationData": include_personalization_data,
+        }
+        qry = ServiceOperationQuery(
+            self, "FullDashboardContent", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def viva_home_configuration(self):
         return_type = ClientResult(self.context, {})
         qry = FunctionQuery(self, "VivaHomeConfiguration", None, return_type)
@@ -45,3 +65,21 @@ class EmployeeEngagement(Entity):
                 self.context, ResourcePath("AppConfiguration", self.resource_path)
             ),
         )
+
+    @property
+    def viva_connections_page(self):
+        return self.properties.get(
+            "VivaConnectionsPage",
+            VivaConnectionsPage(
+                self.context, ResourcePath("VivaConnectionsPage", self.resource_path)
+            ),
+        )
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "AppConfiguration": self.app_configuration,
+                "VivaConnectionsPage": self.viva_connections_page,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(EmployeeEngagement, self).get_property(name, default_value)

office365/sharepoint/viva/resource_get_endpoint.py

@@ -0,0 +1,8 @@
+from office365.sharepoint.entity import Entity
+
+
+class VivaResourceGetEndpoint(Entity):
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.EmployeeEngagement.VivaResourceGetEndpoint"

office365/sharepoint/viva/resource_link.py

@@ -0,0 +1,8 @@
+from office365.runtime.client_value import ClientValue
+
+
+class VivaResourceLink(ClientValue):
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.EmployeeEngagement.ResourceLink"

office365/sharepoint/webs/information.py

@@ -1,7 +1,72 @@
+from datetime import datetime
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
 class WebInformation(Entity):
     """Specifies metadata about a site"""
 
-    pass
+    def __repr__(self):
+        return self.server_relative_url or self.entity_type_name
+
+    @property
+    def configuration(self):
+        # type: () -> Optional[str]
+        """Specifies the identifier (ID) of the site definition configuration that was used to create the site"""
+        return self.properties.get("Configuration", None)
+
+    @property
+    def created(self):
+        # type: () -> Optional[datetime]
+        """Specifies when the site (2) was created."""
+        return self.properties.get("Created", datetime.min)
+
+    @property
+    def description(self):
+        # type: () -> Optional[str]
+        """Specifies the description for the site"""
+        return self.properties.get("Description", None)
+
+    @property
+    def id(self):
+        # type: () -> Optional[str]
+        """Specifies the site identifier for the site"""
+        return self.properties.get("Id", None)
+
+    @property
+    def language(self):
+        # type: () -> Optional[int]
+        """Specifies the language code identifier (LCID) for the language that is used on the site"""
+        return self.properties.get("Language", None)
+
+    @property
+    def last_item_modified_date(self):
+        # type: () -> Optional[datetime]
+        """Gets the date and time that an item was last modified in the site by a non-system update.
+        A non-system update is a change to a list item that is visible to end users."""
+        return self.properties.get("LastItemModifiedDate", datetime.min)
+
+    @property
+    def server_relative_url(self):
+        # type: () -> Optional[str]
+        """Specifies the server-relative URL of the site"""
+        return self.properties.get("ServerRelativeUrl", None)
+
+    @property
+    def title(self):
+        # type: () -> Optional[str]
+        """Specifies the title for the site. Its length MUST be equal to or less than 255."""
+        return self.properties.get("Title", None)
+
+    @property
+    def web_template(self):
+        # type: () -> Optional[str]
+        """Specifies the name of the site template that was used to create the site."""
+        return self.properties.get("WebTemplate", None)
+
+    @property
+    def web_template_id(self):
+        # type: () -> Optional[int]
+        """Specifies the identifier of the site template that was used to create the site"""
+        return self.properties.get("WebTemplateId", None)

office365/sharepoint/webs/regional_settings.py

@@ -102,6 +102,44 @@ class RegionalSettings(Entity):
         """Gets the locale identifier in use on the server."""
         return self.properties.get("LocaleId", None)
 
+    @property
+    def negative_sign(self):
+        # type: () -> Optional[str]
+        """ """
+        return self.properties.get("NegativeSign", None)
+
+    @property
+    def neg_number_mode(self):
+        # type: () -> Optional[int]
+        """Specifies the negative number mode that is used for displaying negative numbers in calculated fields
+        based on the locale of the server."""
+        return self.properties.get("NegNumberMode", None)
+
+    @property
+    def pm(self):
+        # type: () -> Optional[str]
+        """Specifies the string that is used to represent time after noon on the site"""
+        return self.properties.get("PM", None)
+
+    @property
+    def positive_sign(self):
+        # type: () -> Optional[str]
+        """Specifies the symbol that is used to represent a positive number on the site"""
+        return self.properties.get("PositiveSign", None)
+
+    @property
+    def show_weeks(self):
+        # type: () -> Optional[bool]
+        """Specifies whether to display the week number in day or week views of a calendar."""
+        return self.properties.get("ShowWeeks", None)
+
+    @property
+    def thousand_separator(self):
+        # type: () -> Optional[str]
+        """Specifies the symbol that is used to separate thousands for numbers on the site. For example,
+        if the symbol is "," the number 123456789 would appear as "123,456,789"."""
+        return self.properties.get("ThousandSeparator", None)
+
     @property
     def work_days(self):
         # type: () -> Optional[int]

office365/sharepoint/webs/time_zone.py

@@ -44,7 +44,7 @@ class TimeZone(Entity):
         return self.properties.get("Information", TimeZoneInformation())
 
 
-class TimeZoneCollection(EntityCollection):
+class TimeZoneCollection(EntityCollection[TimeZone]):
     """TimeZone collection"""
 
     def __init__(self, context, resource_path=None):

office365/sharepoint/webs/web.py

@@ -6,6 +6,7 @@ from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.paths.service_operation import ServiceOperationPath
+from office365.runtime.queries.client_query import ClientQuery
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.runtime.types.collections import StringCollection
 from office365.sharepoint.activities.entity import SPActivityEntity
@@ -42,6 +43,7 @@ from office365.sharepoint.flows.synchronization_result import FlowSynchronizatio
 from office365.sharepoint.folders.collection import FolderCollection
 from office365.sharepoint.folders.folder import Folder
 from office365.sharepoint.internal.paths.web import WebPath
+from office365.sharepoint.largeoperation.operation import SPLargeOperation
 from office365.sharepoint.listitems.listitem import ListItem
 from office365.sharepoint.lists.collection import ListCollection
 from office365.sharepoint.lists.creation_information import ListCreationInformation
@@ -50,6 +52,7 @@ from office365.sharepoint.lists.document_library_information import (
 )
 from office365.sharepoint.lists.get_parameters import GetListsParameters
 from office365.sharepoint.lists.list import List
+from office365.sharepoint.lists.render_data_parameters import RenderListDataParameters
 from office365.sharepoint.lists.template_collection import ListTemplateCollection
 from office365.sharepoint.lists.template_type import ListTemplateType
 from office365.sharepoint.marketplace.corporatecuratedgallery.available_addins_response import (
@@ -158,6 +161,7 @@ class Web(SecurableObject):
         return return_type
 
     def add_cross_farm_message(self, message):
+        # type: (str) -> ClientResult[bool]
         """
         :param str message:
         """
@@ -169,6 +173,30 @@ class Web(SecurableObject):
         self.context.add_query(qry)
         return return_type
 
+    def get_access_request_list(self):
+        """ """
+        return_type = List(self.context)
+        self.lists.add_child(return_type)
+
+        def _get_access_request_list():
+            return_type.set_property("Url", self.access_request_list_url)
+
+        self.ensure_properties(["AccessRequestListUrl"], _get_access_request_list)
+        return return_type
+
+    def get_document_by_doc_id(self, doc_id):
+        """ """
+        return_type = ClientResult(self.context)
+        qry = ClientQuery(self.context, return_type=return_type)
+
+        def _construct_request(request):
+            request.url = "{0}/_layouts/15/DocIdRedir.aspx?ID={1}".format(
+                self.context.base_url, doc_id
+            )
+
+        self.context.add_query(qry).before_query_execute(_construct_request)
+        return return_type
+
     def get_site_script(
         self,
         include_branding=True,
@@ -210,6 +238,50 @@ class Web(SecurableObject):
         self.context.add_query(qry)
         return return_type
 
+    def get_list_data_as_stream(self, path, view_xml=None):
+        """Returns list data from the specified list url and for the specified query parameters.
+
+        :param str path: A string that contains the site-relative URL for a list, for example, /Lists/Announcements.
+        :param str view_xml:
+        """
+        if view_xml is None:
+            view_xml = "<View><Query></Query></View>"
+        return_type = ClientResult(self.context, dict())
+
+        def _get_list_data_as_stream():
+            list_abs_url = self.url + path
+            parameters = RenderListDataParameters(view_xml=view_xml)
+            List.get_list_data_as_stream(
+                self.context, list_abs_url, parameters, return_type=return_type
+            )
+
+        self.ensure_property("Url", _get_list_data_as_stream)
+        return return_type
+
+    def get_onedrive_list_data_as_stream(self, view_xml=None):
+        """Returns list data from the specified list url and for the specified query parameters.
+
+        :param str view_xml:
+        """
+        if view_xml is None:
+            view_xml = "<View><Query></Query></View>"
+        return List.get_onedrive_list_data_as_stream(self.context, view_xml)
+
+    def get_list_operation(self, list_id, operation_id):
+        # type: (str, str) -> SPLargeOperation
+        """ """
+        return_type = SPLargeOperation(self.context)
+        qry = ServiceOperationQuery(
+            self,
+            "GetListOperation",
+            None,
+            {"listId": list_id, "operationId": operation_id},
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def get_push_notification_subscriber(self, device_app_instance_id):
         """
         Specifies the push notification subscriber over the site for the specified device app instance identifier.
@@ -1246,6 +1318,7 @@ class Web(SecurableObject):
         display_format=DateTimeFieldFormatType.DateTime,
         calendar_type=CalendarType.None_,
     ):
+        # type: (str, int, int) -> ClientResult[str]
         """
         Returns parsed DateTime value.
 
@@ -1916,6 +1989,7 @@ class Web(SecurableObject):
     @property
     def access_request_list_url(self):
         # type: () -> Optional[str]
+        """Gets the URL of the access request list to the current site"""
         return self.properties.get("AccessRequestListUrl", None)
 
     @property
@@ -2311,9 +2385,49 @@ class Web(SecurableObject):
 
     @property
     def recycle_bin_enabled(self):
+        # type: () -> Optional[bool]
         """Specifies whether the Recycle Bin is enabled."""
         return self.properties.get("RecycleBinEnabled", None)
 
+    @property
+    def related_hub_site_ids(self):
+        # type: () -> Optional[str]
+        """ """
+        return self.properties.get("RelatedHubSiteIds", None)
+
+    @property
+    def request_access_email(self):
+        # type: () -> Optional[str]
+        """Gets the e-mail address to which requests for access are sent."""
+        return self.properties.get("RequestAccessEmail", None)
+
+    @property
+    def save_site_as_template_enabled(self):
+        # type: () -> Optional[bool]
+        """Specifies if the site (2) can be saved as a site template.
+
+        A feature that creates content which is not compatible for a site template can set this value to false to
+        stop users of this site (2) from generating an invalid site template.
+
+        A feature ought to never set this value to true when it is deactivated or at any other time since another
+        feature might have created content that is not compatible in a site template.
+
+        Setting this value to false, if it was true, will result in a site template that is not supported.
+        """
+        return self.properties.get("SaveSiteAsTemplateEnabled", None)
+
+    @property
+    def search_box_in_navbar(self):
+        # type: () -> Optional[int]
+        """Gets the e-mail address to which requests for access are sent."""
+        return self.properties.get("SearchBoxInNavBar", None)
+
+    @property
+    def search_box_placeholder_text(self):
+        # type: () -> Optional[str]
+        """Gets the placeholder text in SharePoint online search box for a given (sub) site."""
+        return self.properties.get("SearchBoxPlaceholderText", None)
+
     @property
     def navigation(self):
         """Specifies the navigation structure on the site (2), including the Quick Launch area and the link bar."""

office365/sharepoint/workflow/definition.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.entity import Entity
+
+
+class WorkflowDefinition(Entity):
+    """Represents a workflow definition and associated properties."""

office365/sharepoint/workflow/task.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.listitems.listitem import ListItem
+
+
+class SPWorkflowTask(ListItem):
+    """ """

office365/sharepoint/workflowservices/deployment_service.py

@@ -1,9 +1,32 @@
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
+from office365.sharepoint.entity_collection import EntityCollection
+from office365.sharepoint.workflow.definition import WorkflowDefinition
 
 
 class WorkflowDeploymentService(Entity):
     """"""
 
+    def get_definition(self, definition_id):
+        """Returns a WorkflowDefinition from the workflow store."""
+        return_type = WorkflowDefinition(self.context)
+        payload = {"definitionId": definition_id}
+        qry = ServiceOperationQuery(
+            self, "GetDefinition", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def enumerate_definitions(self, published_only=False):
+        """Returns the WorkflowDefinition objects from the workflow store that match the specified parameters."""
+        return_type = EntityCollection(self.context, WorkflowDefinition)
+        payload = {"publishedOnly": published_only}
+        qry = ServiceOperationQuery(
+            self, "EnumerateDefinitions", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def entity_type_name(self):
         return "SP.WorkflowServices.WorkflowDeploymentService"

office365/subscriptions/collection.py

@@ -17,6 +17,9 @@ class SubscriptionCollection(EntityCollection[Subscription]):
         expiration,
         client_state=None,
         latest_supported_tls_version=None,
+        include_resource_data=None,
+        encryption_certificate=None,
+        encryption_certificate_id=None,
     ):
         """
         Subscribes a listener application to receive change notifications when the requested type of changes occur
@@ -34,6 +37,16 @@ class SubscriptionCollection(EntityCollection[Subscription]):
         :param str latest_supported_tls_version:  Specifies the latest version of Transport Layer Security (TLS) that
             the notification endpoint, specified by notificationUrl, supports.
             The possible values are: v1_0, v1_1, v1_2, v1_3.
+        :param bool include_resource_data: Indicates whether the resource data for the resource that generated the
+            change notification should be included in the payload of the notification.
+        :param str encryption_certificate: Specifies the public key certificate which contains only the public key
+            that Microsoft Graph uses to encrypt the resource data it returns to your app. For security, Microsoft
+            Graph encrypts the resource data returned in a rich notification. You must provide a public encryption
+            key as part of creating the subscription.
+        :param str encryption_certificate_id: Specifies the identifier of the certificate used to encrypt the content
+            of the change notification. Use this ID to match in each change notification, which certificate to use
+            for decryption.
+        :return: Subscription
         """
         return_type = Subscription(self.context)
         self.add_child(return_type)
@@ -44,6 +57,9 @@ class SubscriptionCollection(EntityCollection[Subscription]):
             "expirationDateTime": expiration.isoformat() + "Z",
             "clientState": client_state,
             "latestSupportedTlsVersion": latest_supported_tls_version,
+            "includeResourceData": include_resource_data,
+            "encryptionCertificate": encryption_certificate,
+            "encryptionCertificateId": encryption_certificate_id,
         }
         qry = CreateEntityQuery(self, payload, return_type)
         self.context.add_query(qry)

office365/teams/members/settings.py

@@ -5,9 +5,9 @@ class TeamMemberSettings(ClientValue):
     """Settings to configure whether members can perform certain actions, for example, create channels and add bots,
     in the team."""
 
-    def __init__(self):
+    def __init__(self, allow_create_update_channels=None):
         super(TeamMemberSettings, self).__init__()
-        self.allowCreateUpdateChannels = True
+        self.allowCreateUpdateChannels = allow_create_update_channels
         self.allowDeleteChannels = True
         self.allowAddRemoveApps = True
         self.allowCreateUpdateRemoveTabs = True

office365/sharepoint/portal/userprofiles/documents_shared_with_group.py

@@ -1,11 +0,0 @@
-from office365.sharepoint.entity import Entity
-
-
-class DocumentsSharedWithGroup(Entity):
-    """
-    Provides methods for working with a list that shares documents with a SharePoint Group on the user's personal site.
-    """
-
-    @property
-    def entity_type_name(self):
-        return "Microsoft.SharePoint.Portal.UserProfiles.DocumentsSharedWithGroup"

office365/sharepoint/tenant/administration/internal/web_appservice_principal.py

@@ -1,23 +0,0 @@
-from office365.runtime.paths.resource_path import ResourcePath
-from office365.runtime.queries.service_operation import ServiceOperationQuery
-from office365.sharepoint.entity import Entity
-
-
-class SPOWebAppServicePrincipal(Entity):
-    def __init__(self, context):
-        stat_path = ResourcePath(
-            "Microsoft.Online.SharePoint.TenantAdministration.Internal.SPOWebAppServicePrincipal"
-        )
-        super(SPOWebAppServicePrincipal, self).__init__(context, stat_path)
-
-    def update_spfx_client_secret(self, secret_value):
-        """
-        :param str secret_value:
-        """
-        payload = {"secretValue": secret_value}
-        qry = ServiceOperationQuery(self, "UpdateSpfxClientSecret", None, payload)
-        self.context.add_query(qry)
-
-    @property
-    def entity_type_name(self):
-        return "Microsoft.Online.SharePoint.TenantAdministration.Internal.SPOWebAppServicePrincipal"