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

office365/sharepoint/tenant/administration/app_billing_properties.py

@@ -0,0 +1,21 @@
+from office365.runtime.client_value import ClientValue
+
+
+class SPOAppBillingProperties(ClientValue):
+    """ """
+
+    def __init__(self, application_id=None, azure_region=None, is_activated=None):
+        """
+        :param str application_id: The application ID.
+        :param str azure_region: The Azure region.
+        :param bool is_activated:
+        """
+        self.ApplicationId = application_id
+        self.AzureRegion = azure_region
+        self.IsActivated = is_activated
+
+    @property
+    def entity_type_name(self):
+        return (
+            "Microsoft.Online.SharePoint.TenantAdministration.SPOAppBillingProperties"
+        )

office365/sharepoint/tenant/administration/insights/summary_response.py

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

office365/sharepoint/tenant/administration/internal/aad/permission_grant.py

@@ -0,0 +1,32 @@
+from typing_extensions import Self
+
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.entity import Entity
+from office365.sharepoint.entity_collection import EntityCollection
+
+
+class SPO3rdPartyAADPermissionGrant(Entity):
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantAdministration.Internal.SPO3rdPartyAADPermissionGrant"
+
+
+class SPO3rdPartyAADPermissionGrantCollection(
+    EntityCollection[SPO3rdPartyAADPermissionGrant]
+):
+
+    def __init__(self, context, resource_path=None):
+        super(SPO3rdPartyAADPermissionGrantCollection, self).__init__(
+            context, SPO3rdPartyAADPermissionGrant, resource_path
+        )
+
+    def add(self, service_principal_id, resource, scope):
+        # type: (str, str, str) -> Self
+        payload = {
+            "servicePrincipalId": service_principal_id,
+            "resource": resource,
+            "scope": scope,
+        }
+        qry = ServiceOperationQuery(self, "Add", None, payload)
+        self.context.add_query(qry)
+        return self

office365/sharepoint/tenant/administration/internal/appservice/permission_grant.py

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

office365/sharepoint/tenant/administration/internal/{permission_grant.py → appservice/permission_request.py}

@@ -1,7 +1,9 @@
 from office365.sharepoint.entity import Entity
 
 
-class SPO3rdPartyAADPermissionGrant(Entity):
+class SPOWebAppServicePrincipalPermissionRequest(Entity):
+    """ """
+
     @property
     def entity_type_name(self):
-        return "Microsoft.Online.SharePoint.TenantAdministration.Internal.SPO3rdPartyAADPermissionGrant"
+        return "Microsoft.Online.SharePoint.TenantAdministration.Internal.SPOWebAppServicePrincipalPermissionRequest"

office365/sharepoint/tenant/administration/internal/appservice/principal.py

@@ -0,0 +1,104 @@
+from typing import Optional
+
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.runtime.types.collections import StringCollection
+from office365.sharepoint.entity import Entity
+from office365.sharepoint.entity_collection import EntityCollection
+from office365.sharepoint.tenant.administration.internal.aad.permission_grant import (
+    SPO3rdPartyAADPermissionGrantCollection,
+)
+from office365.sharepoint.tenant.administration.internal.appservice.permission_grant import (
+    SPOWebAppServicePrincipalPermissionGrant,
+)
+from office365.sharepoint.tenant.administration.internal.appservice.permission_request import (
+    SPOWebAppServicePrincipalPermissionRequest,
+)
+
+
+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)
+        return self
+
+    def update_spfx_third_party_app_id(self, app_id):
+        payload = {"appId": app_id}
+        qry = ServiceOperationQuery(self, "UpdateSpfxThirdPartyAppId", None, payload)
+        self.context.add_query(qry)
+        return self
+
+    @property
+    def account_enabled(self):
+        # type: () -> Optional[bool]
+        """ """
+        return self.properties.get("AccountEnabled", False)
+
+    @property
+    def app_id(self):
+        # type: () -> Optional[str]
+        """ """
+        return self.properties.get("AppId", False)
+
+    @property
+    def reply_urls(self):
+        # type: () -> StringCollection
+        """ """
+        return self.properties.get("ReplyUrls", StringCollection())
+
+    @property
+    def grant_manager(self):
+        return self.properties.get(
+            "GrantManager",
+            SPO3rdPartyAADPermissionGrantCollection(
+                self.context,
+                ResourcePath("GrantManager", self.resource_path),
+            ),
+        )
+
+    @property
+    def permission_grants(self):
+        return self.properties.get(
+            "PermissionGrants",
+            EntityCollection(
+                self.context,
+                SPOWebAppServicePrincipalPermissionGrant,
+                ResourcePath("PermissionGrants", self.resource_path),
+            ),
+        )
+
+    @property
+    def permission_requests(self):
+        return self.properties.get(
+            "PermissionRequests",
+            EntityCollection(
+                self.context,
+                SPOWebAppServicePrincipalPermissionRequest,
+                ResourcePath("PermissionRequests", self.resource_path),
+            ),
+        )
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantAdministration.Internal.SPOWebAppServicePrincipal"
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "GrantManager": self.grant_manager,
+                "PermissionRequests": self.permission_requests,
+                "PermissionGrants": self.permission_grants,
+                "ReplyUrls": self.reply_urls,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(SPOWebAppServicePrincipal, self).get_property(name, default_value)

office365/sharepoint/tenant/administration/policies/definition.py

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

office365/sharepoint/tenant/administration/settings_service.py

@@ -4,7 +4,10 @@ from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.runtime.types.collections import StringCollection
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.tenant.administration.smtp_server import SmtpServer
-from office365.sharepoint.tenant.administration.types import DisableGroupify
+from office365.sharepoint.tenant.administration.types import (
+    AutoQuotaEnabled,
+    DisableGroupify,
+)
 
 
 class TenantAdminSettingsService(Entity):
@@ -25,6 +28,14 @@ class TenantAdminSettingsService(Entity):
         self.context.add_query(qry)
         return return_type
 
+    @property
+    def auto_quota_enabled(self):
+        """Controls whether automatic quota management is enabled for SharePoint Online site collections.
+        When this feature is enabled, SharePoint Online automatically adjusts the storage quota for site collections
+        based on their usage, helping to ensure that site collections don't run out of space.
+        """
+        return self.properties.get("AutoQuotaEnabled", AutoQuotaEnabled())
+
     @property
     def available_managed_paths_for_site_creation(self):
         """"""

office365/sharepoint/tenant/administration/sites/creation_source.py

@@ -11,20 +11,20 @@ from office365.sharepoint.tenant.administration.sites.creation_data import (
 class SiteCreationSource(ClientValue):
     def __init__(
         self,
-        IsSyncThresholdLimitReached=None,
-        LastRefreshTimeStamp=None,
+        is_sync_threshold_limit_reached=None,
+        last_refresh_time_stamp=None,
         site_creation_data=None,
-        SyncThresholdLimit=None,
-        TotalSitesCount=None,
+        sync_threshold_limit=None,
+        total_sites_count=None,
     ):
         # type: (bool, datetime, List[SiteCreationData], int, int) -> None
-        self.IsSyncThresholdLimitReached = IsSyncThresholdLimitReached
-        self.LastRefreshTimeStamp = LastRefreshTimeStamp
+        self.IsSyncThresholdLimitReached = is_sync_threshold_limit_reached
+        self.LastRefreshTimeStamp = last_refresh_time_stamp
         self.SiteCreationData = ClientValueCollection(
             SiteCreationData, site_creation_data
         )
-        self.SyncThresholdLimit = SyncThresholdLimit
-        self.TotalSitesCount = TotalSitesCount
+        self.SyncThresholdLimit = sync_threshold_limit
+        self.TotalSitesCount = total_sites_count
 
     @property
     def entity_type_name(self):

office365/sharepoint/tenant/administration/sites/properties.py

@@ -52,6 +52,50 @@ class SiteProperties(Entity):
         self._ensure_site_path(_update_ex)
         return return_type
 
+    @property
+    def allow_downloading_non_web_viewable_files(self):
+        # type: () -> Optional[bool]
+        """Specifies if non web viewable files can be downloaded."""
+        return self.properties.get("AllowDownloadingNonWebViewableFiles", None)
+
+    @property
+    def allow_editing(self):
+        # type: () -> Optional[bool]
+        """Prevents users from editing Office files in the browser and copying and pasting Office file contents
+        out of the browser window."""
+        return self.properties.get("AllowEditing", None)
+
+    @property
+    def allow_self_service_upgrade(self):
+        # type: () -> Optional[bool]
+        """Whether version to version upgrade is allowed on this site."""
+        return self.properties.get("AllowSelfServiceUpgrade", None)
+
+    @property
+    def anonymous_link_expiration_in_days(self):
+        # type: () -> Optional[int]
+        """Specifies all anonymous/anyone links that have been created
+        (or will be created) will expire after the set number of days."""
+        return self.properties.get("AnonymousLinkExpirationInDays", None)
+
+    @property
+    def apply_to_existing_document_libraries(self):
+        # type: () -> Optional[bool]
+        """Create a job to apply the version history limits setting to existing document libraries."""
+        return self.properties.get("ApplyToExistingDocumentLibraries", None)
+
+    @property
+    def apply_to_new_document_libraries(self):
+        # type: () -> Optional[bool]
+        """Gets site version policy for new document libraries."""
+        return self.properties.get("ApplyToNewDocumentLibraries", None)
+
+    @property
+    def archived_by(self):
+        # type: () -> Optional[str]
+        """Gets site version policy for new document libraries."""
+        return self.properties.get("ArchivedBy", None)
+
     @property
     def deny_add_and_customize_pages(self):
         # type: () -> Optional[int]
@@ -69,6 +113,7 @@ class SiteProperties(Entity):
     @property
     def owner_login_name(self):
         # type: () -> Optional[str]
+        """ """
         return self.properties.get("OwnerLoginName", None)
 
     @property

office365/sharepoint/tenant/administration/tenant.py

@@ -19,6 +19,9 @@ from office365.sharepoint.lists.render_override_parameters import (
 from office365.sharepoint.publishing.portal_health_status import PortalHealthStatus
 from office365.sharepoint.sites.home_sites_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,
 )
@@ -34,6 +37,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.definition import (
+    TenantAdminPolicyDefinition,
+)
 from office365.sharepoint.tenant.administration.powerapps.environment import (
     PowerAppsEnvironment,
 )
@@ -69,6 +75,7 @@ from office365.sharepoint.tenant.administration.spo_operation import SpoOperatio
 from office365.sharepoint.tenant.administration.syntex.billing_context import (
     SyntexBillingContext,
 )
+from office365.sharepoint.tenant.administration.types import CreatePolicyRequest
 from office365.sharepoint.tenant.administration.webs.templates.collection import (
     SPOTenantWebTemplateCollection,
 )
@@ -84,8 +91,28 @@ class Tenant(Entity):
         )
         super(Tenant, self).__init__(context, static_path)
 
+    def accept_syntex_repository_terms_of_service(self):
+        """
+        Used to accept the Microsoft Syntex repository terms of service for your organization.
+        This acceptance is often necessary for enabling features related to document processing or repositories
+        in Microsoft Syntex.
+        """
+        qry = ServiceOperationQuery(self, "AcceptSyntexRepositoryTermsOfService")
+        self.context.add_query(qry)
+        return self
+
+    def activate_application_billing_policy(self, billing_policy_id):
+        """ """
+        payload = {"billingPolicyId": billing_policy_id}
+        return_type = ClientResult(self.context, SPOAppBillingProperties())
+        qry = ServiceOperationQuery(
+            self, "ActivateApplicationBillingPolicy", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def add_recent_admin_action_report(self):
-        """"""
+        """Logs recent administrative actions within a SharePoint Online tenant"""
         return_type = ClientResult(self.context, RecentAdminActionReport())
         payload = {"payload": RecentAdminActionReportPayload()}
         qry = ServiceOperationQuery(
@@ -117,6 +144,9 @@ class Tenant(Entity):
 
     def delete_policy_definition(self, item_id):
         """
+        Deletes a policy definition from a Microsoft 365 tenant.
+        Policy definitions may refer to specific settings related to compliance, security,
+        or site governance (such as site or group creation policies).
         :param int item_id:
         """
         qry = ServiceOperationQuery(
@@ -136,6 +166,7 @@ class Tenant(Entity):
         return self
 
     def get_spo_tenant_all_web_templates(self):
+        """ """
         return_type = SPOTenantWebTemplateCollection(self.context)
         qry = ServiceOperationQuery(
             self, "GetSPOTenantAllWebTemplates", None, None, None, return_type
@@ -144,6 +175,7 @@ class Tenant(Entity):
         return return_type
 
     def get_onedrive_site_sharing_insights(self, query_mode):
+        """Retrieves insights or reports related to OneDrive for Business site sharing activities"""
         return_type = ClientResult(self.context, OneDriveSiteSharingInsights())
         payload = {"queryMode": query_mode}
         qry = ServiceOperationQuery(
@@ -225,6 +257,7 @@ class Tenant(Entity):
 
     def get_home_sites(self):
         # type: () -> ClientResult[ClientValueCollection[HomeSitesDetails]]
+        """Retrieves the Home Site that has been designated for your Microsoft 365 tenant."""
         return_type = ClientResult(
             self.context,
             ClientValueCollection(HomeSitesDetails),  # pylint: disable=E1120
@@ -234,6 +267,7 @@ class Tenant(Entity):
         return return_type
 
     def get_home_sites_details(self):
+        """Retrieves detailed information about the Home Sites configured in a SharePoint Online tenant."""
         return_type = ClientResult(
             self.context, ClientValueCollection(HomeSitesDetails)
         )
@@ -263,12 +297,23 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return return_type
 
-    def export_to_csv(self, view_xml=None):
+    def export_to_csv(
+        self, view_xml=None, time_zone_id=None, columns_info=None, list_name=None
+    ):
         """
+        Exports tenant-level data to a CSV file.
         :param str view_xml:
+        :param int time_zone_id:
+        :param list columns_info:
+        :param str list_name:
         """
         return_type = ClientResult(self.context)
-        payload = {"viewXml": view_xml}
+        payload = {
+            "viewXml": view_xml,
+            "timeZoneId": time_zone_id,
+            "columnsInfo": columns_info,
+            "listName": list_name,
+        }
         qry = ServiceOperationQuery(
             self, "ExportToCSV", None, payload, None, return_type
         )
@@ -330,6 +375,16 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def get_ransomware_events_overview(self):
+        # type: () -> ClientResult[AnyStr]
+        """ """
+        return_type = ClientResult(self.context)
+        qry = ServiceOperationQuery(
+            self, "GetRansomwareEventsOverview", 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]
         """ """
@@ -522,6 +577,16 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return self
 
+    def create_policy_definition(self):
+        """ """
+        return_type = ClientResult(self.context, TenantAdminPolicyDefinition())
+        payload = {"policyInputParameters": CreatePolicyRequest()}
+        qry = ServiceOperationQuery(
+            self, "CreatePolicyDefinition", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def create_site(self, url, owner, title=None):
         """Queues a site collection for creation with the specified properties.
 
@@ -645,9 +710,23 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def get_billing_policy_id_for_app(self, application_id):
+        """ """
+        return_type = ClientResult(self.context)
+        payload = {"applicationId": application_id}
+        qry = ServiceOperationQuery(
+            self, "GetBillingPolicyIdForApp", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def connect_site_to_hub_site_by_id(self, site_url, hub_site_id):
         # type: (str, str) -> Self
-        """Connects Site to Hub Site"""
+        """Connects Site to Hub Site
+
+        :param str site_url:
+        :param str hub_site_id:
+        """
         params = {"siteUrl": site_url, "hubSiteId": hub_site_id}
         qry = ServiceOperationQuery(
             self, "ConnectSiteToHubSiteById", None, params, None, None
@@ -655,6 +734,12 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return self
 
+    def ensure_brand_center_feature(self):
+        """Ensures that the Brand Center feature is enabled"""
+        qry = ServiceOperationQuery(self, "EnsureBrandCenterFeature")
+        self.context.add_query(qry)
+        return self
+
     def send_email(self, site_url):
         # type: (str) -> ClientResult[bool]
         """ """
@@ -735,6 +820,41 @@ class Tenant(Entity):
         """"""
         return self.properties.get("DefaultContentCenterSite", SiteInfoForSitePicker())
 
+    @property
+    def no_access_redirect_url(self):
+        # type: () -> Optional[bool]
+        """Specifies the URL of the redirected site for those site collections which have the locked state "NoAccess"""
+        return self.properties.get("NoAccessRedirectUrl", None)
+
+    @property
+    def notifications_in_share_point_enabled(self):
+        # type: () -> Optional[bool]
+        """Enables or disables notifications in SharePoint."""
+        return self.properties.get("NotificationsInSharePointEnabled", None)
+
+    @property
+    def notify_owners_when_invitations_accepted(self):
+        # type: () -> Optional[bool]
+        """When this parameter is set to true and when an external user accepts an invitation to a resource
+        in a user's OneDrive for Business, the OneDrive for Business owner is notified by e-mail.
+        """
+        return self.properties.get("NotifyOwnersWhenInvitationsAccepted", None)
+
+    @property
+    def one_drive_storage_quota(self):
+        # type: () -> Optional[int]
+        """Gets a default OneDrive for Business storage quota for the tenant. It will be used for new OneDrive
+        for Business sites created."""
+        return self.properties.get("OneDriveStorageQuota", None)
+
+    @property
+    def notify_owners_when_items_reshared(self):
+        # type: () -> Optional[bool]
+        """When is set to true and another user re-shares a document from a
+        user's OneDrive for Business, the OneDrive for Business owner is notified by e-mail.
+        """
+        return self.properties.get("NotifyOwnersWhenItemsReshared", None)
+
     @property
     def root_site_url(self):
         # type: () -> Optional[str]

office365/sharepoint/tenant/administration/types.py

@@ -2,4 +2,32 @@ from office365.runtime.client_value import ClientValue
 
 
 class DisableGroupify(ClientValue):
-    """"""
+    """ """
+
+
+class AutoQuotaEnabled(ClientValue):
+    """Automatic quota management type"""
+
+    def __init__(self, is_read_only=None, value=None):
+        self.IsReadOnly = is_read_only
+        self.Value = value
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantAdministration.AutoQuotaEnabled"
+
+
+class CreatePolicyRequest(ClientValue):
+    """ """
+
+    def __init__(self, is_preview_run=None, policy_custom_name=None):
+        """
+        :param bool is_preview_run:
+        :param str policy_custom_name:
+        """
+        self.isPreviewRun = is_preview_run
+        self.policyCustomName = policy_custom_name
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantAdministration.CreatePolicyRequest"

office365/sharepoint/tenant/cdn_api.py

@@ -13,7 +13,9 @@ class TenantCdnApi(Entity):
         )
 
     def get_cdn_urls(self, items=None):
-        """"""
+        """
+        :param list[str] items:
+        """
         payload = {
             "items": items,
         }

office365/sharepoint/tenant/management/office365_tenant.py

@@ -205,6 +205,8 @@ class Office365Tenant(Entity):
 
         def _revoke_all_user_sessions(login_name):
             """
+            Logouts a user's sessions across all their devices
+
             :type login_name: str
             """
             qry = ServiceOperationQuery(

office365/sharepoint/tenant/settings.py

@@ -1,5 +1,6 @@
 from typing import Optional
 
+from office365.runtime.client_result import ClientResult
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
@@ -16,6 +17,15 @@ class TenantSettings(Entity):
         self.context.add_query(qry)
         return self
 
+    def get_data_access_governance_report_config(self):
+        """ """
+        return_type = ClientResult(self.context, str())
+        qry = ServiceOperationQuery(
+            self, "GetDataAccessGovernanceReportConfig", None, None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def set_corporate_catalog(self, url):
         """
         :param str url:

office365/sharepoint/utilities/utility.py

@@ -1,3 +1,5 @@
+from typing import TYPE_CHECKING
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
@@ -8,6 +10,9 @@ from office365.sharepoint.files.file import File
 from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
 from office365.sharepoint.utilities.principal_info import PrincipalInfo
 
+if TYPE_CHECKING:
+    from office365.sharepoint.client_context import ClientContext
+
 
 class Utility(Entity):
     """
@@ -161,6 +166,7 @@ class Utility(Entity):
 
     @staticmethod
     def log_custom_app_error(context, error):
+        # type: (ClientContext, str) -> ClientResult[int]
         """
         Logs an error from a SharePoint Add-in. The return value indicates the success or failure of this operation.
         These errors are of interest to administrators who monitor such apps (2).