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

office365/sharepoint/search/administration/site_content_processing_info_provider.py

@@ -1,7 +1,18 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
 
 class SiteContentProcessingInfoProvider(Entity):
+
+    def get_azure_container_token(self):
+        return_type = ClientResult(self.context, str())
+        qry = ServiceOperationQuery(
+            self, "GetAzureContainerToken", None, None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Client.Search.Administration.SiteContentProcessingInfoProvider"

office365/sharepoint/search/administration/tenant_crawl_versions_info_provider.py

@@ -4,7 +4,7 @@ from office365.sharepoint.entity import Entity
 
 
 class TenantCrawlVersionsInfoProvider(Entity):
-    """ """
+    """Retrieves information about crawl versions for a tenant in SharePoint"""
 
     def disable_crawl_versions(self, site_id):
         """

office365/sharepoint/search/ranking_labeling.py

@@ -28,6 +28,7 @@ class RankingLabeling(Entity):
         return self
 
     def normalize_result_url(self, url):
+        # type: (str) -> ClientResult[str]
         """
         A URL string after normalization. The input and output URL strings MUST resolve to the same document.
 

office365/sharepoint/search/reports/abandoned_queries.py

@@ -1,3 +1,7 @@
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.sharepoint.search.reports.abandonedqueries.item import (
+    ReportAbandonedQueriesItem,
+)
 from office365.sharepoint.search.reports.base import ReportBase
 
 
@@ -6,4 +10,10 @@ class ReportAbandonedQueries(ReportBase):
     queries that might create user dissatisfaction and to improve the discoverability of content.
     """
 
-    pass
+    def __init__(self, reports=None):
+        super(ReportAbandonedQueries, self).__init__()
+        self.Reports = ClientValueCollection(ReportAbandonedQueriesItem, reports)
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Office.Server.Search.REST.ReportAbandonedQueries"

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

@@ -0,0 +1,11 @@
+from office365.runtime.client_value import ClientValue
+
+
+class ReportAbandonedQueriesItem(ClientValue):
+
+    def __init__(self, date=None):
+        self.Date = date
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Office.Server.Search.REST.ReportAbandonedQueriesItem"

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

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

office365/sharepoint/sharing/information.py

@@ -2,6 +2,9 @@ from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.sharing.abilities import SharingAbilities
 from office365.sharepoint.sharing.access_request_settings import AccessRequestSettings
+from office365.sharepoint.sharing.domain_restriction_settings import (
+    DomainRestrictionSettings,
+)
 from office365.sharepoint.sharing.links.default_templates_collection import (
     SharingLinkDefaultTemplatesCollection,
 )
@@ -24,9 +27,17 @@ class SharingInformation(Entity):
 
     @property
     def anonymous_link_expiration_restriction_days(self):
+        # type: () -> Optional[int]
         """Tenant's anonymous link expiration restriction in days."""
         return self.properties.get("anonymousLinkExpirationRestrictionDays", None)
 
+    @property
+    def domain_restriction_settings(self):
+        """Whether DomainRestrictionSettings is used to limit the external Users set by Admin."""
+        return self.properties.get(
+            "anonymousLinkExpirationRestrictionDays", DomainRestrictionSettings()
+        )
+
     @property
     def permissions_information(self):
         """
@@ -62,6 +73,7 @@ class SharingInformation(Entity):
         if default_value is None:
             property_mapping = {
                 "accessRequestSettings": self.access_request_settings,
+                "domain_restriction_settings": self.domain_restriction_settings,
                 "permissionsInformation": self.permissions_information,
                 "pickerSettings": self.picker_settings,
                 "sharingAbilities": self.sharing_abilities,

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/sitehealth/result.py

@@ -2,13 +2,13 @@ from office365.runtime.client_value import ClientValue
 
 
 class SiteHealthResult(ClientValue):
-    """Specifies the result of running a site collection health rule."""
+    """Specifies the result of running a site collection sitehealth rule."""
 
     def __init__(self, message_as_text=None, rule_help_link=None, rule_id=None):
         """
-        :param str message_as_text: Specifies a summary of the results of running a site collection health rule.
-        :param str rule_help_link: Specifies a hyperlink to help information about the site collection health rule.
-        :param str rule_id: Specifies the unique identifier of the site collection health rule.
+        :param str message_as_text: Specifies a summary of the results of running a site collection sitehealth rule.
+        :param str rule_help_link: Specifies a hyperlink to help information about the site collection sitehealth rule.
+        :param str rule_id: Specifies the unique identifier of the site collection sitehealth rule.
         """
         self.MessageAsText = message_as_text
         self.RuleHelpLink = rule_help_link

office365/sharepoint/sitehealth/summary.py

@@ -6,29 +6,29 @@ from office365.sharepoint.sitehealth.result import SiteHealthResult
 
 
 class SiteHealthSummary(Entity):
-    """Specifies a summary of the results of running a set of site collection health rules."""
+    """Specifies a summary of the results of running a set of site collection sitehealth rules."""
 
     @property
     def failed_error_count(self):
         # type: () -> Optional[int]
-        """Specifies the number of site collection health rules that failed with an error."""
+        """Specifies the number of site collection sitehealth rules that failed with an error."""
         return self.properties.get("FailedErrorCount", None)
 
     @property
     def failed_warning_count(self):
         # type: () -> Optional[int]
-        """Specifies the number of site collection health rules that failed with a warning."""
+        """Specifies the number of site collection sitehealth rules that failed with a warning."""
         return self.properties.get("FailedWarningCount", None)
 
     @property
     def passed_count(self):
         # type: () -> Optional[int]
-        """Specifies the number of site collection health rules that passed."""
+        """Specifies the number of site collection sitehealth rules that passed."""
         return self.properties.get("PassedCount", None)
 
     @property
     def results(self):
-        """Specifies a list of site collection health rule results, one for each site collection health rule that
+        """Specifies a list of site collection sitehealth rule results, one for each site collection sitehealth rule that
         was run."""
         return self.properties.get("Results", ClientValueCollection(SiteHealthResult))
 

office365/sharepoint/sites/copy_job_progress.py

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

office365/sharepoint/sites/copy_migration_iInfo.py

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

office365/sharepoint/sites/{sph_site.py → home/site.py}

@@ -2,7 +2,7 @@ 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
-from office365.sharepoint.sites.home_site_reference import SPHSiteReference
+from office365.sharepoint.sites.home.reference import SPHSiteReference
 
 
 class SPHSite(Entity):

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,7 +27,11 @@ from office365.sharepoint.sitehealth.summary import SiteHealthSummary
 from office365.sharepoint.sites.azure_container_Info import (
     ProvisionedTemporaryAzureContainerInfo,
 )
-from office365.sharepoint.sites.sph_site import SPHSite
+from office365.sharepoint.sites.copy_job_progress import CopyJobProgress
+from office365.sharepoint.sites.home.site import SPHSite
+from office365.sharepoint.sites.html_field_security_setting import (
+    HTMLFieldSecuritySetting,
+)
 from office365.sharepoint.sites.upgrade_info import UpgradeInfo
 from office365.sharepoint.sites.usage_info import UsageInfo
 from office365.sharepoint.sites.version_policy_manager import SiteVersionPolicyManager
@@ -150,6 +154,18 @@ class Site(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def get_copy_job_progress(self, copy_job_info=None):
+        """
+        :param copy_job_info: Optional copyJobInfo object.
+        """
+        payload = {"copyJobInfo": copy_job_info}
+        return_type = ClientResult(self.context, CopyJobProgress())
+        qry = ServiceOperationQuery(
+            self, "GetCopyJobProgress", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def get_site_logo(self):
         """Downloads a site logo"""
         return_type = ClientResult(self.context)
@@ -262,6 +278,18 @@ class Site(Entity):
         self.ensure_property("Id", _site_loaded)
         return return_type
 
+    def get_web_path(self, site_id, web_id):
+        """
+        :param int site_id: The site identifier
+        :param int web_id: The web identifier
+        """
+        params = {"siteId": site_id, "webId": web_id}
+        return_type = ClientResult(self.context, SPResPath())
+
+        qry = ServiceOperationQuery(self, "GetWebPath", params, None, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
     def get_web_templates(self, lcid=1033, override_compat_level=0):
         """
         Returns the collection of site definitions that are available for creating
@@ -504,7 +532,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 +602,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_service_principal_public.py

@@ -0,0 +1,17 @@
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.sharepoint.entity import Entity
+
+
+class SPOWebAppServicePrincipalPublic(Entity):
+    """ """
+
+    def __init__(self, context):
+        """ """
+        static_path = ResourcePath(
+            "Microsoft.Online.SharePoint.TenantAdministration.SPOWebAppServicePrincipalPublic"
+        )
+        super(SPOWebAppServicePrincipalPublic, self).__init__(context, static_path)
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantAdministration.SPOWebAppServicePrincipalPublic"

office365/sharepoint/tenant/administration/audit/data.py

@@ -1,7 +1,19 @@
 from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.sharepoint.tenant.administration.modified_property import (
+    ModifiedProperty,
+)
 
 
 class AuditData(ClientValue):
+
+    def __init__(self, client_ip=None, correlation_id=None, modified_properties=None):
+        self.ClientIP = client_ip
+        self.CorrelationId = correlation_id
+        self.ModifiedProperties = ClientValueCollection(
+            ModifiedProperty, modified_properties
+        )
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Administration.TenantAdmin.AuditData"

office365/sharepoint/tenant/administration/audit/unified_record.py

@@ -1,7 +1,25 @@
 from office365.runtime.client_value import ClientValue
+from office365.sharepoint.tenant.administration.audit.data import AuditData
 
 
 class UnifiedAuditRecord(ClientValue):
+
+    def __init__(
+        self,
+        audit_data=AuditData(),
+        creation_date=None,
+        operation=None,
+        record_id=None,
+        record_type=None,
+        user_id=None,
+    ):
+        self.AuditData = audit_data
+        self.CreationDate = creation_date
+        self.Operation = operation
+        self.RecordId = record_id
+        self.RecordType = record_type
+        self.UserId = user_id
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Administration.TenantAdmin.UnifiedAuditRecord"

office365/sharepoint/tenant/administration/coms/messages_fields_data.py

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

office365/sharepoint/tenant/administration/coms/messages_service_proxy.py

@@ -0,0 +1,16 @@
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.sharepoint.entity import Entity
+
+
+class Office365CommsMessagesServiceProxy(Entity):
+    """"""
+
+    def __init__(self, context):
+        static_path = ResourcePath(
+            "Microsoft.Online.SharePoint.TenantAdministration.Office365CommsMessagesServiceProxy"
+        )
+        super(Office365CommsMessagesServiceProxy, self).__init__(context, static_path)
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantAdministration.Office365CommsMessagesServiceProxy"