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

office365/sharepoint/tenant/administration/tenant.py

@@ -17,11 +17,8 @@ from office365.sharepoint.lists.render_override_parameters import (
     RenderListDataOverrideParameters,
 )
 from office365.sharepoint.publishing.portal_health_status import PortalHealthStatus
-from office365.sharepoint.sites.home_sites_details import HomeSitesDetails
+from office365.sharepoint.sites.home.details import HomeSitesDetails
 from office365.sharepoint.sites.site import Site
-from office365.sharepoint.tenant.administration.app_billing_properties import (
-    SPOAppBillingProperties,
-)
 from office365.sharepoint.tenant.administration.collaboration.insights_data import (
     CollaborationInsightsData,
 )
@@ -37,6 +34,9 @@ from office365.sharepoint.tenant.administration.insights.onedrive_site_sharing i
 from office365.sharepoint.tenant.administration.insights.top_files_sharing import (
     TopFilesSharingInsights,
 )
+from office365.sharepoint.tenant.administration.policies.app_billing_properties import (
+    SPOAppBillingProperties,
+)
 from office365.sharepoint.tenant.administration.policies.definition import (
     TenantAdminPolicyDefinition,
 )
@@ -209,6 +209,7 @@ class Tenant(Entity):
         return return_type
 
     def render_recent_admin_actions(self):
+        """ """
         return_type = ClientResult(self.context)
         payload = {
             "parameters": RenderListDataParameters(),
@@ -220,8 +221,20 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return return_type
 
-    def get_top_files_sharing_insights(self, query_mode):
+    def get_spo_app_billing_policies(self):
+        """ """
+        return_type = ClientResult(
+            self.context, ClientValueCollection(SPOAppBillingProperties)
+        )
+        qry = ServiceOperationQuery(
+            self, "GetSPOAppBillingPolicies", None, None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def get_top_files_sharing_insights(self, query_mode=None):
         """
+        Retrieves a report or data about the most shared files within a SharePoint Online tenant
         :param int query_mode:
         """
         payload = {"queryMode": query_mode}
@@ -385,6 +398,33 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def get_site_authorization_code_for_migration(self, endpoint_url):
+        return_type = ClientResult(self.context, str())
+        payload = {"endpointUrl": endpoint_url}
+        qry = ServiceOperationQuery(
+            self,
+            "GetSiteAuthorizationCodeForMigration",
+            None,
+            payload,
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def get_site_subscription_id(self):
+        return_type = ClientResult(self.context, str())
+        qry = ServiceOperationQuery(
+            self,
+            "GetSiteSubscriptionId",
+            None,
+            None,
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def get_sp_list_item_count(self, list_name):
         # type: (str) -> ClientResult[int]
         """ """
@@ -489,6 +529,7 @@ class Tenant(Entity):
 
     def get_site_health_status(self, source_url):
         """
+        Checks the sitehealth of a specific SharePoint site or site collection in their tenant
         :type source_url: str
         """
         result = ClientResult(self.context, PortalHealthStatus())
@@ -649,6 +690,7 @@ class Tenant(Entity):
 
     def reorder_home_sites(self, home_sites_site_ids):
         """
+        Reorders Home Sites within a SharePoint Online tenant
         :param list[str] home_sites_site_ids:
         """
         payload = {"homeSitesSiteIds": home_sites_site_ids}
@@ -672,6 +714,22 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def get_site_properties_by_site_id(self, site_id, include_detail=False):
+        # type: (str, bool) -> SiteProperties
+        """
+        :param str site_id: A string that represents the site identifier.
+        :param bool include_detail: A Boolean value that indicates whether to include all of the SPSite properties.
+        """
+        return_type = SiteProperties(self.context)
+        return_type.set_property("siteId", site_id, False)
+        self.sites.add_child(return_type)
+        payload = {"siteId": site_id, "includeDetail": include_detail}
+        qry = ServiceOperationQuery(
+            self, "GetSitePropertiesBySiteId", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def get_site_properties_by_url(self, url, include_detail=False):
         # type: (str, bool) -> SiteProperties
         """
@@ -751,7 +809,7 @@ class Tenant(Entity):
 
     @property
     def admin_settings(self):
-        """ """
+        """Manage various tenant-level settings related to SharePoint administration"""
         from office365.sharepoint.tenant.administration.settings_service import (
             TenantAdminSettingsService,
         )
@@ -767,6 +825,24 @@ class Tenant(Entity):
 
         return MigrationCenterServices(self.context)
 
+    @property
+    def comms_messages(self):
+        """ """
+
+        from office365.sharepoint.tenant.administration.coms.messages_service_proxy import (
+            Office365CommsMessagesServiceProxy,
+        )
+
+        return Office365CommsMessagesServiceProxy(self.context)
+
+    @property
+    def multi_geo(self):
+        """ """
+
+        from office365.sharepoint.multigeo.services import MultiGeoServices
+
+        return MultiGeoServices(self.context)
+
     @property
     def ai_builder_enabled(self):
         # type: () -> Optional[str]
@@ -782,6 +858,7 @@ class Tenant(Entity):
 
     @property
     def _aggregated_site_collections_list(self):
+        """ """
         return self.context.web.lists.get_by_title(
             "DO_NOT_DELETE_SPLIST_TENANTADMIN_AGGREGATED_SITECOLLECTIONS"
         )
@@ -820,6 +897,34 @@ class Tenant(Entity):
         """"""
         return self.properties.get("DefaultContentCenterSite", SiteInfoForSitePicker())
 
+    @property
+    def information_barriers_suspension(self):
+        # type: () -> Optional[bool]
+        """Gets information barriers in SharePoint and OneDrive in your organization"""
+        return self.properties.get("InformationBarriersSuspension", None)
+
+    @property
+    def ip_address_allow_list(self):
+        # type: () -> Optional[str]
+        """Configures multiple IP addresses or IP address ranges (IPv4 or IPv6), that are recognized as trusted."""
+        return self.properties.get("IPAddressAllowList", None)
+
+    @property
+    def ip_address_enforcement(self):
+        # type: () -> Optional[bool]
+        """Determines whether access from network locations that are defined by an administrator is allowed."""
+        return self.properties.get("IPAddressEnforcement", None)
+
+    @ip_address_enforcement.setter
+    def ip_address_enforcement(self, value):
+        # type: (bool) -> None
+        """
+        Allows access from network locations that are defined by an administrator.
+        Before the IPAddressEnforcement parameter is set, make sure you add a valid IPv4 or IPv6 address to the
+        IPAddressAllowList parameter.
+        """
+        self.set_property("IPAddressEnforcement", value)
+
     @property
     def no_access_redirect_url(self):
         # type: () -> Optional[bool]
@@ -873,17 +978,39 @@ class Tenant(Entity):
 
     @property
     def cdn_api(self):
+        """ """
         from office365.sharepoint.tenant.cdn_api import TenantCdnApi
 
         return TenantCdnApi(self.context)
 
+    @property
+    def crawl_versions_info_provider(self):
+        """Retrieves information about crawl versions for a tenant in SharePoint"""
+
+        from office365.sharepoint.search.administration.tenant_crawl_versions_info_provider import (
+            TenantCrawlVersionsInfoProvider,
+        )
+
+        return TenantCrawlVersionsInfoProvider(self.context)
+
     @property
     def syntex_billing_subscription_settings(self):
-        """"""
+        """
+        Manages billing and subscription details for Microsoft Syntex in SharePoint Online or Microsoft 365 environments
+        """
         return self.properties.get(
             "SyntexBillingSubscriptionSettings", SyntexBillingContext()
         )
 
+    @property
+    def admin_endpoints(self):
+        """ """
+        from office365.sharepoint.tenant.administration.endpoints import (
+            TenantAdminEndpoints,
+        )
+
+        return TenantAdminEndpoints(self.context)
+
     @property
     def entity_type_name(self):
         return "Microsoft.Online.SharePoint.TenantAdministration.Tenant"

office365/sharepoint/tenant/administration/types.py

@@ -4,6 +4,50 @@ from office365.runtime.client_value import ClientValue
 class DisableGroupify(ClientValue):
     """ """
 
+    def __init__(self, is_read_only=None, value=None):
+        # type: (bool, bool) -> None
+        self.IsReadOnly = is_read_only
+        self.Value = value
+
+    def __repr__(self):
+        return f"(IsReadOnly={self.IsReadOnly}, Value={self.Value})"
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantAdministration.DisableGroupify"
+
+
+class EnableAutoNewsDigest(ClientValue):
+    """ """
+
+    def __init__(self, is_read_only=None, value=None):
+        # type: (bool, bool) -> None
+        self.IsReadOnly = is_read_only
+        self.Value = value
+
+    def __repr__(self):
+        return f"(IsReadOnly={self.IsReadOnly}, Value={self.Value})"
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantAdministration.EnableAutoNewsDigest"
+
+
+class DisableSelfServiceSiteCreation(ClientValue):
+    """ """
+
+    def __init__(self, is_read_only=None, value=None):
+        # type: (bool, bool) -> None
+        self.IsReadOnly = is_read_only
+        self.Value = value
+
+    def __repr__(self):
+        return f"(IsReadOnly={self.IsReadOnly}, Value={self.Value})"
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantAdministration.DisableSelfServiceSiteCreation"
+
 
 class AutoQuotaEnabled(ClientValue):
     """Automatic quota management type"""
@@ -12,6 +56,9 @@ class AutoQuotaEnabled(ClientValue):
         self.IsReadOnly = is_read_only
         self.Value = value
 
+    def __repr__(self):
+        return f"(IsReadOnly={self.IsReadOnly}, Value={self.Value})"
+
     @property
     def entity_type_name(self):
         return "Microsoft.Online.SharePoint.TenantAdministration.AutoQuotaEnabled"
@@ -20,13 +67,41 @@ class AutoQuotaEnabled(ClientValue):
 class CreatePolicyRequest(ClientValue):
     """ """
 
-    def __init__(self, is_preview_run=None, policy_custom_name=None):
+    def __init__(
+        self,
+        is_preview_run=None,
+        policy_custom_name=None,
+        policy_definition_details=None,
+        policy_description=None,
+        policy_frequency_unit=None,
+        policy_frequency_value=None,
+        policy_id=None,
+        policy_tags=None,
+        policy_template=None,
+        policy_type=None,
+    ):
         """
         :param bool is_preview_run:
         :param str policy_custom_name:
+        :param str policy_definition_details:
+        :param str policy_description:
+        :param int policy_frequency_unit:
+        :param int policy_frequency_value:
+        :param str policy_id:
+        :param str policy_tags:
+        :param str policy_template:
+        :param int policy_type:
         """
         self.isPreviewRun = is_preview_run
         self.policyCustomName = policy_custom_name
+        self.policyDefinitionDetails = policy_definition_details
+        self.policyDescription = policy_description
+        self.policyFrequencyUnit = policy_frequency_unit
+        self.policyFrequencyValue = policy_frequency_value
+        self.policyId = policy_id
+        self.policyTags = policy_tags
+        self.policyTemplate = policy_template
+        self.policyType = policy_type
 
     @property
     def entity_type_name(self):

office365/sharepoint/tenant/insights/report_manager.py

@@ -1,5 +1,34 @@
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
+from office365.sharepoint.tenant.insights.report_metadata import (
+    SPTenantIBInsightsReportMetadata,
+)
 
 
 class SPTenantIBInsightsReportManager(Entity):
     """ """
+
+    def __init__(self, context):
+        static_path = ResourcePath(
+            "Microsoft.SharePoint.Insights.SPTenantIBInsightsReportManager"
+        )
+        super(SPTenantIBInsightsReportManager, self).__init__(context, static_path)
+
+    def create_report(self):
+        """"""
+        return_type = SPTenantIBInsightsReportMetadata(self.context)
+        qry = ServiceOperationQuery(
+            self,
+            "CreateReport",
+            None,
+            None,
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Insights.SPTenantIBInsightsReportManager"

office365/sharepoint/tenant/management/office365_tenant.py

@@ -107,14 +107,17 @@ class Office365Tenant(Entity):
         return return_type
 
     def set_block_download_file_type_policy_data(
-        self, blockDownloadFileTypePolicy, fileTypeIds, excludedBlockDownloadGroupIds
+        self,
+        block_download_file_type_policy,
+        file_type_ids,
+        excluded_block_download_group_ids,
     ):
         # type: (bool, list[int], list[str]) -> Self
         """"""
         payload = {
-            "blockDownloadFileTypePolicy": blockDownloadFileTypePolicy,
-            "fileTypeIds": fileTypeIds,
-            "excludedBlockDownloadGroupIds": excludedBlockDownloadGroupIds,
+            "blockDownloadFileTypePolicy": block_download_file_type_policy,
+            "fileTypeIds": file_type_ids,
+            "excludedBlockDownloadGroupIds": excluded_block_download_group_ids,
         }
         qry = ServiceOperationQuery(
             self, "SetBlockDownloadFileTypePolicyData", None, payload

office365/sharepoint/translation/job_status.py

@@ -1,4 +1,8 @@
+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.entity import Entity
+from office365.sharepoint.translation.job_info import TranslationJobInfo
 
 
 class TranslationJobStatus(Entity):
@@ -7,6 +11,24 @@ class TranslationJobStatus(Entity):
     TranslationJobInfo (section 3.1.5.4) and TranslationItemInfo (section 3.1.5.2) objects.
     """
 
+    @staticmethod
+    def get_all_jobs(context, return_type=None):
+        if return_type is None:
+            return_type = ClientResult(
+                context, ClientValueCollection(TranslationJobInfo)
+            )
+        qry = ServiceOperationQuery(
+            TranslationJobStatus(context),
+            "GetAllJobs",
+            None,
+            None,
+            None,
+            return_type,
+            True,
+        )
+        context.add_query(qry)
+        return return_type
+
     @property
     def entity_type_name(self):
         return "SP.Translation.TranslationJobStatus"

office365/sharepoint/userprofiles/user_profile.py

@@ -107,6 +107,12 @@ class UserProfile(Entity):
         """Specifies the time for the personal site first creation attempt."""
         return self.properties.get("PersonalSiteFirstCreationTime", datetime.min)
 
+    @property
+    def picture_url(self):
+        # type: () -> Optional[str]
+        """Specifies the photo URL for the current user."""
+        return self.properties.get("PictureUrl", None)
+
     @property
     def public_url(self):
         # type: () -> Optional[str]

office365/sharepoint/webparts/tile_data.py

@@ -1,5 +1,26 @@
 from office365.runtime.client_value import ClientValue
+from office365.runtime.types.collections import StringCollection
 
 
 class TileData(ClientValue):
     """Represents a Tile that describes a graphical link the user can click."""
+
+    def __init__(
+        self,
+        background_collage_image_locations=None,
+        background_image_location=None,
+        background_image_renders_as_icon=None,
+        body_text=None,
+        description=None,
+        hover_disabled=None,
+        id_=None,
+    ):
+        self.BackgroundCollageImageLocations = StringCollection(
+            background_collage_image_locations
+        )
+        self.BackgroundImageLocation = background_image_location
+        self.BackgroundImageRendersAsIcon = background_image_renders_as_icon
+        self.BodyText = body_text
+        self.Description = description
+        self.HoverDisabled = hover_disabled
+        self.ID = id_

office365/sharepoint/webs/dataleakage_prevention_status_info.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.entity import Entity
+
+
+class SPDataLeakagePreventionStatusInfo(Entity):
+    """"""

office365/sharepoint/webs/web.py

@@ -55,6 +55,9 @@ 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.addins.principals_response import (
+    SPGetAddinPrincipalsResponse,
+)
 from office365.sharepoint.marketplace.corporatecuratedgallery.available_addins_response import (
     SPAvailableAddinsResponse,
 )
@@ -103,6 +106,9 @@ from office365.sharepoint.views.view import View
 from office365.sharepoint.webparts.client.collection import ClientWebPartCollection
 from office365.sharepoint.webs.calendar_type import CalendarType
 from office365.sharepoint.webs.context_web_information import ContextWebInformation
+from office365.sharepoint.webs.dataleakage_prevention_status_info import (
+    SPDataLeakagePreventionStatusInfo,
+)
 from office365.sharepoint.webs.information_collection import WebInformationCollection
 from office365.sharepoint.webs.modernize_homepage_result import ModernizeHomepageResult
 from office365.sharepoint.webs.multilingual_settings import MultilingualSettings
@@ -264,7 +270,8 @@ class Web(SecurableObject):
         :param str view_xml:
         """
         if view_xml is None:
-            view_xml = "<View><Query></Query></View>"
+            view_xml = RenderListDataParameters()
+            view_xml.ViewXml = "<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):
@@ -536,6 +543,26 @@ class Web(SecurableObject):
         self.context.add_query(qry)
         return return_type
 
+    def get_addin_principals_having_permissions_in_sites(
+        self, server_relative_urls=None, urls=None
+    ):
+        """
+        :param list[str] server_relative_urls:
+        :param list[str] urls:
+        """
+        payload = {"serverRelativeUrls": server_relative_urls, "urls": urls}
+        return_type = ClientResult(self.context, SPGetAddinPrincipalsResponse())
+        qry = ServiceOperationQuery(
+            self,
+            "GetAddinPrincipalsHavingPermissionsInSites",
+            None,
+            payload,
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def get_app_bdc_catalog(self):
         """
         Returns the Business Data Connectivity (BDC) MetadataCatalog for an application that gives access to the
@@ -641,6 +668,42 @@ class Web(SecurableObject):
         self.context.add_query(qry)
         return return_type
 
+    def get_recycle_bin_items_by_query_info(
+        self,
+        is_ascending=True,
+        item_state=None,
+        order_by=None,
+        paging_info=None,
+        row_limit=100,
+        show_only_my_items=False,
+    ):
+        """
+        Gets the recycle bin items that are based on the specified query.
+
+        :param str paging_info: an Object that is used to obtain the next set of rows in a paged view of the Recycle Bin
+        :param int row_limit: a limit for the number of items returned in the query per page.
+        :param bool is_ascending: a Boolean value that specifies whether to sort in ascending order.
+        :param int order_by: the column by which to order the Recycle Bin query.
+        :param int item_state: Recycle Bin stage of items to return in the query.
+        :param bool show_only_my_items:
+        """
+        return_type = RecycleBinItemCollection(
+            self.context, self.recycle_bin.resource_path
+        )
+        payload = {
+            "rowLimit": row_limit,
+            "isAscending": is_ascending,
+            "pagingInfo": paging_info,
+            "orderBy": order_by,
+            "itemState": item_state,
+            "ShowOnlyMyItems": show_only_my_items,
+        }
+        qry = ServiceOperationQuery(
+            self, "GetRecycleBinItemsByQueryInfo", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def get_all_webs(self):
         """Returns a collection containing a flat list of all Web objects in the Web."""
         from office365.sharepoint.webs.collection import WebCollection
@@ -2197,6 +2260,16 @@ class Web(SecurableObject):
         """
         return self.properties.get("Configuration", None)
 
+    @property
+    def data_leakage_prevention_status_info(self):
+        return self.properties.get(
+            "DataLeakagePreventionStatusInfo",
+            SPDataLeakagePreventionStatusInfo(
+                self.context,
+                ResourcePath("DataLeakagePreventionStatusInfo", self.resource_path),
+            ),
+        )
+
     @property
     def description_resource(self):
         """A UserResource object that represents the description of this web."""
@@ -2562,6 +2635,11 @@ class Web(SecurableObject):
         """Specifies whether the tree view is enabled on the site"""
         return self.properties.get("TreeViewEnabled", None)
 
+    @property
+    def taxonomy_list(self):
+        """A special list that stores the mapping between taxonomy term IDs and their corresponding values"""
+        return self.lists.get_by_title("TaxonomyHiddenList")
+
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {
@@ -2575,6 +2653,7 @@ class Web(SecurableObject):
                 "ContentTypes": self.content_types,
                 "ClientWebParts": self.client_web_parts,
                 "CurrentUser": self.current_user,
+                "DataLeakagePreventionStatusInfo": self.data_leakage_prevention_status_info,
                 "DescriptionResource": self.description_resource,
                 "DescriptionTranslations": self.description_translations,
                 "EffectiveBasePermissions": self.effective_base_permissions,

office365/teams/chats/event_message_detail.py

@@ -0,0 +1,8 @@
+from office365.runtime.client_value import ClientValue
+
+
+class EventMessageDetail(ClientValue):
+    """Represents details of a system event message.
+
+    System messages are messages generated for events such as members added to a channel, members added to a chat,
+    and team description updated."""

office365/teams/deleted.py

@@ -0,0 +1,24 @@
+from office365.entity import Entity
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.teams.channels.collection import ChannelCollection
+
+
+class DeletedTeam(Entity):
+    """
+    A deleted team in Microsoft Teams is a collection of channel objects. A channel represents a topic,
+    and therefore a logical isolation of discussion, within a deleted team.
+
+    Every deleted team is associated with a Microsoft 365 group. For more information about working with groups
+    and members in teams, see Use the Microsoft Graph REST API to work with Microsoft Teams.
+    """
+
+    @property
+    def channels(self):
+        # type: () -> ChannelCollection
+        """The collection of channels & messages associated with the team."""
+        return self.properties.get(
+            "channels",
+            ChannelCollection(
+                self.context, ResourcePath("channels", self.resource_path)
+            ),
+        )

office365/teams/work.py

@@ -0,0 +1,35 @@
+from typing import Optional
+
+from office365.entity import Entity
+from office365.entity_collection import EntityCollection
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.teams.deleted import DeletedTeam
+
+
+class Teamwork(Entity):
+    """A container for the range of Microsoft Teams functionalities that are available for the organization."""
+
+    @property
+    def is_teams_enabled(self):
+        # type: () -> Optional[bool]
+        """Indicates whether Microsoft Teams is enabled for the organization."""
+        return self.properties.get("isTeamsEnabled", None)
+
+    @property
+    def region(self):
+        # type: () -> Optional[str]
+        """Represents the region of the organization or the tenant.
+        The region value can be any region supported by the Teams payload"""
+        return self.properties.get("region", None)
+
+    @property
+    def deleted_teams(self):
+        """The tags associated with the team."""
+        return self.properties.get(
+            "deletedTeams",
+            EntityCollection(
+                self.context,
+                DeletedTeam,
+                ResourcePath("deletedTeams", self.resource_path),
+            ),
+        )