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

office365/sharepoint/search/reports/abandonedqueries/item.py

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

office365/sharepoint/search/reports/top_queries.py

@@ -1,7 +1,14 @@
+from office365.runtime.client_value_collection import ClientValueCollection
 from office365.sharepoint.search.reports.base import ReportBase
+from office365.sharepoint.search.reports.topqueries.item import ReportTopQueriesItem
 
 
 class ReportTopQueries(ReportBase):
+
+    def __init__(self, reports=None):
+        super(ReportTopQueries, self).__init__()
+        self.Reports = ClientValueCollection(ReportTopQueriesItem, reports)
+
     @property
     def entity_type_name(self):
         return "Microsoft.Office.Server.Search.REST.ReportTopQueries"

office365/sharepoint/search/reports/topqueries/data.py

@@ -0,0 +1,9 @@
+from office365.runtime.client_value import ClientValue
+
+
+class ReportTopQueriesData(ClientValue):
+    """ """
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Office.Server.Search.REST.ReportTopQueriesData"

office365/sharepoint/search/reports/topqueries/item.py

@@ -0,0 +1,15 @@
+from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.sharepoint.search.reports.topqueries.data import ReportTopQueriesData
+
+
+class ReportTopQueriesItem(ClientValue):
+    """ """
+
+    def __init__(self, date=None, report=None):
+        self.Date = date
+        self.Report = ClientValueCollection(ReportTopQueriesData, report)
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Office.Server.Search.REST.ReportTopQueriesItem"

office365/sharepoint/search/scs_endpoint.py

@@ -0,0 +1,9 @@
+from office365.runtime.client_value import ClientValue
+
+
+class ScsEndpoint(ClientValue):
+    """ """
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Office.Server.Search.REST.ScsEndpoint"

office365/sharepoint/securestore/target_application.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.client_context import ClientContext
 from office365.sharepoint.entity import Entity
@@ -27,6 +29,12 @@ class TargetApplication(Entity):
         context.add_query(qry)
         return return_type
 
+    @property
+    def application_id(self):
+        # type: () -> Optional[str]
+        """"""
+        return self.properties.get("ApplicationId", None)
+
     @property
     def entity_type_name(self):
         return "Microsoft.Office.SecureStoreService.Server.TargetApplication"

office365/sharepoint/sharing/document_manager.py

@@ -3,11 +3,11 @@ 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.permissions.roles.definitions.definition import RoleDefinition
-from office365.sharepoint.sharing.user_role_assignment import UserRoleAssignment
-from office365.sharepoint.sharing.user_sharing_result import UserSharingResult
-from office365.sharepoint.userprofiles.sharedwithme.view_item_removal_result import (
+from office365.sharepoint.portal.userprofiles.sharedwithme.view_item_removal_result import (
     SharedWithMeViewItemRemovalResult,
 )
+from office365.sharepoint.sharing.user_role_assignment import UserRoleAssignment
+from office365.sharepoint.sharing.user_sharing_result import UserSharingResult
 
 
 class DocumentSharingManager(Entity):

office365/sharepoint/sharing/result.py

@@ -4,6 +4,8 @@ from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.principal.groups.collection import GroupCollection
+from office365.sharepoint.principal.groups.group import Group
+from office365.sharepoint.principal.users.collection import UserCollection
 from office365.sharepoint.sharing.invitation.creation_result import (
     SPInvitationCreationResult,
 )
@@ -78,6 +80,23 @@ class SharingResult(Entity):
             ),
         )
 
+    @property
+    def group_users_added_to(self):
+        return self.properties.get(
+            "GroupUsersAddedTo",
+            Group(self.context, ResourcePath("GroupUsersAddedTo", self.resource_path)),
+        )
+
+    @property
+    def users_with_access_requests(self):
+        return self.properties.get(
+            "UsersWithAccessRequests",
+            UserCollection(
+                self.context,
+                ResourcePath("UsersWithAccessRequests", self.resource_path),
+            ),
+        )
+
     @property
     def users_added_to_group(self):
         # type: () ->  ClientValueCollection[UserSharingResult]
@@ -90,8 +109,10 @@ class SharingResult(Entity):
         if default_value is None:
             property_mapping = {
                 "GroupsSharedWith": self.groups_shared_with,
+                "GroupUsersAddedTo": self.group_users_added_to,
                 "UsersAddedToGroup": self.users_added_to_group,
                 "UniquelyPermissionedUsers": self.uniquely_permissioned_users,
+                "UsersWithAccessRequests": self.users_with_access_requests,
             }
             default_value = property_mapping.get(name, None)
         return super(SharingResult, self).get_property(name, default_value)

office365/sharepoint/sites/html_field_security_setting.py

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

office365/sharepoint/sites/site.py

@@ -27,6 +27,9 @@ from office365.sharepoint.sitehealth.summary import SiteHealthSummary
 from office365.sharepoint.sites.azure_container_Info import (
     ProvisionedTemporaryAzureContainerInfo,
 )
+from office365.sharepoint.sites.html_field_security_setting import (
+    HTMLFieldSecuritySetting,
+)
 from office365.sharepoint.sites.sph_site import SPHSite
 from office365.sharepoint.sites.upgrade_info import UpgradeInfo
 from office365.sharepoint.sites.usage_info import UsageInfo
@@ -504,7 +507,7 @@ class Site(Entity):
     @property
     def allowed_external_domains(self):
         # type: () -> Optional[bool]
-        return self.properties.get("AllowedExternalDomains", None)
+        return self.properties.get("AllowedExternalDomains", HTMLFieldSecuritySetting())
 
     @property
     def allow_master_page_editing(self):
@@ -574,6 +577,32 @@ class Site(Entity):
         """Gets the current change token that is used in the change log for the site collection."""
         return self.properties.get("CurrentChangeToken", ChangeToken())
 
+    @property
+    def disable_flows(self):
+        # type: () -> Optional[bool]
+        """"""
+        return self.properties.get("DisableFlows", None)
+
+    @property
+    def external_sharing_tips_enabled(self):
+        # type: () -> Optional[bool]
+        """Gets a Boolean value that specifies whether users will be greeted with a notification bar telling them that
+        the site can be shared with external users. The value is true if the notification bar is enabled; otherwise,
+        it is false."""
+        return self.properties.get("ExternalSharingTipsEnabled", None)
+
+    @property
+    def external_user_expiration_in_days(self):
+        # type: () -> Optional[int]
+        """"""
+        return self.properties.get("ExternalUserExpirationInDays", None)
+
+    @property
+    def geo_location(self):
+        # type: () -> Optional[str]
+        """"""
+        return self.properties.get("GeoLocation", None)
+
     @property
     def group_id(self):
         # type: () -> Optional[str]

office365/sharepoint/sites/version_policy_manager.py

@@ -1,7 +1,9 @@
 from typing import Optional
 
+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.lists.version_policy_manager import VersionPolicyManager
 
 
 class SiteVersionPolicyManager(Entity):
@@ -13,8 +15,31 @@ class SiteVersionPolicyManager(Entity):
         """ """
         return self.properties.get("MajorVersionLimit", None)
 
+    @property
+    def version_policies(self):
+        return self.properties.get(
+            "VersionPolicies",
+            VersionPolicyManager(
+                self.context, ResourcePath("VersionPolicies", self.resource_path)
+            ),
+        )
+
+    def inherit_tenant_settings(self):
+        """ """
+        qry = ServiceOperationQuery(self, "InheritTenantSettings")
+        self.context.add_query(qry)
+        return self
+
     def set_auto_expiration(self):
         """"""
         qry = ServiceOperationQuery(self, "SetAutoExpiration")
         self.context.add_query(qry)
         return self
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "VersionPolicies": self.version_policies,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(SiteVersionPolicyManager, self).get_property(name, default_value)

office365/sharepoint/sitescripts/metadata.py

@@ -2,11 +2,36 @@ from office365.runtime.client_value import ClientValue
 
 
 class SiteScriptMetadata(ClientValue):
-    def __init__(self, _id=None, content=None, description=None):
+    """Represents metadata about a SharePoint site script in the SharePoint framework.
+    Site scripts are used to automate the provisioning of SharePoint sites by defining actions like
+    applying a theme, adding lists, and configuring site settings."""
+
+    def __init__(
+        self,
+        id_=None,
+        content=None,
+        description=None,
+        is_site_script_package=None,
+        title=None,
+        version=None,
+    ):
         """
-        :param str content:
+        :param str id_: unique identifier (GUID) for the site script. This is used to uniquely identify the script
+             within SharePoint.
+        :param str content: The actual JSON content of the site script. This contains the actions that the script
+             will execute when applied to a SharePoint site.
         :param str description:
+        :param bool is_site_script_package:
+        :param str title:
+        :param int version:
         """
-        self.Id = _id
+        self.Id = id_
         self.Content = content
         self.Description = description
+        self.IsSiteScriptPackage = is_site_script_package
+        self.Title = title
+        self.Version = version
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptMetadata"

office365/sharepoint/sitescripts/utility.py

@@ -42,6 +42,23 @@ class SiteScriptUtility(Entity):
         context.add_query(qry)
         return return_type
 
+    @staticmethod
+    def get_list_designs(context, store=None):
+        """
+        Gets a list designs.
+
+        :param office365.sharepoint.client_context.ClientContext context: SharePoint context
+        :param str store:
+        """
+        return_type = ClientResult(context, SiteDesignMetadata())
+        utility = SiteScriptUtility(context)
+        payload = {"store": store}
+        qry = ServiceOperationQuery(
+            utility, "GetListDesigns", None, payload, None, return_type, True
+        )
+        context.add_query(qry)
+        return return_type
+
     @staticmethod
     def add_site_design_task(context, web_url, site_design_id):
         """

office365/sharepoint/smartcache/item.py

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

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/settings_service.py

@@ -30,7 +30,10 @@ class TenantAdminSettingsService(Entity):
 
     @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

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):