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

office365/sharepoint/portal/project/__init__.py

@@ -0,0 +1,9 @@
+from office365.runtime.client_value import ClientValue
+
+
+class MyRecsCacheBlob(ClientValue):
+    """"""
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Portal.Project.MyRecsCacheBlob"

office365/sharepoint/portal/userprofiles/documentsshared/with_group.py

@@ -0,0 +1,38 @@
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.entity import Entity
+from office365.sharepoint.entity_collection import EntityCollection
+from office365.sharepoint.portal.userprofiles.sharedwithme.document import (
+    SharedWithMeDocument,
+)
+
+
+class DocumentsSharedWithGroup(Entity):
+    """
+    Provides methods for working with a list that shares documents with a SharePoint Group on the user's personal site.
+    """
+
+    @staticmethod
+    def get_shared_with_group_docs(context, group_id=None):
+        """
+        Gets a shared documents for a group.
+
+        :param office365.sharepoint.client_context.ClientContext context: SharePoint context
+        :param str group_id:
+        """
+        return_type = EntityCollection(context, SharedWithMeDocument)
+        payload = {"groupId": group_id}
+        qry = ServiceOperationQuery(
+            DocumentsSharedWithGroup(context),
+            "GetSharedWithGroupDocs",
+            None,
+            payload,
+            None,
+            return_type,
+            True,
+        )
+        context.add_query(qry)
+        return return_type
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Portal.UserProfiles.DocumentsSharedWithGroup"

office365/sharepoint/portal/userprofiles/documentsshared/with_person.py

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

office365/sharepoint/{userprofiles → portal/userprofiles}/sharedwithme/document.py

@@ -3,7 +3,7 @@ from typing import Optional
 
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.sharepoint.entity import Entity
-from office365.sharepoint.userprofiles.sharedwithme.document_user import (
+from office365.sharepoint.portal.userprofiles.sharedwithme.document_user import (
     SharedWithMeDocumentUser,
 )
 

office365/sharepoint/{userprofiles → portal/userprofiles}/sharedwithme/items.py

@@ -1,7 +1,9 @@
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.entity_collection import EntityCollection
-from office365.sharepoint.userprofiles.sharedwithme.document import SharedWithMeDocument
+from office365.sharepoint.portal.userprofiles.sharedwithme.document import (
+    SharedWithMeDocument,
+)
 
 
 class SharedWithMeItems(Entity):

office365/sharepoint/publishing/pages/campaign_publication.py

@@ -1,5 +1,6 @@
 from typing import Optional
 
+from office365.runtime.client_result import ClientResult
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.publishing.highlights_info import HighlightsInfo
 from office365.sharepoint.publishing.pages.page import SitePage
@@ -15,6 +16,15 @@ class CampaignPublication(SitePage):
         self.context.add_query(qry)
         return return_type
 
+    def send_test_email(self):
+        """ """
+        return_type = ClientResult(self.context)
+        qry = ServiceOperationQuery(
+            self, "SendTestEmail", None, None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def email_endpoint(self):
         # type: () -> Optional[str]

office365/sharepoint/publishing/pages/coauth_state.py

@@ -0,0 +1,8 @@
+from office365.runtime.client_value import ClientValue
+
+
+class SitePageCoAuthState(ClientValue):
+
+    @property
+    def entity_type_name(self):
+        return "SP.Publishing.SitePageCoAuthState"

office365/sharepoint/publishing/pages/page.py

@@ -5,6 +5,7 @@ from office365.runtime.client_value import ClientValue
 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.publishing.pages.coauth_state import SitePageCoAuthState
 from office365.sharepoint.publishing.pages.fields_data import SitePageFieldsData
 from office365.sharepoint.publishing.pages.metadata import SitePageMetadata
 from office365.sharepoint.translation.status_collection import (
@@ -135,6 +136,16 @@ class SitePage(SitePageMetadata):
         self.context.add_query(qry)
         return return_type
 
+    def save_page_co_auth(self, page_stream):
+        """ """
+        return_type = ClientResult(self.context, SitePageCoAuthState())
+        payload = {"pageStream": page_stream}
+        qry = ServiceOperationQuery(
+            self, "SavePageCoAuth", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def demote_from_news(self):
         """
         Updates the promoted state of the site page to 0. On success MUST return true.

office365/sharepoint/publishing/pages/stream_content.py

@@ -0,0 +1,9 @@
+from office365.runtime.client_value import ClientValue
+
+
+class SitePageStreamContent(ClientValue):
+    """ """
+
+    @property
+    def entity_type_name(self):
+        return "SP.Publishing.SitePageStreamContent"

office365/sharepoint/publishing/pages/stream_data.py

@@ -0,0 +1,8 @@
+from office365.runtime.client_value import ClientValue
+
+
+class SitePageStreamData(ClientValue):
+
+    @property
+    def entity_type_name(self):
+        return "SP.Publishing.SitePageStreamData"

office365/sharepoint/quotamanagement/consumer/non_quota_backfill_api.py

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

office365/sharepoint/request.py

@@ -13,6 +13,9 @@ from office365.runtime.odata.v3.json_light_format import JsonLightFormat
 
 class SharePointRequest(ODataRequest):
     def __init__(self, base_url):
+        """
+        :param str base_url: Absolute Web or Site Url
+        """
         super().__init__(JsonLightFormat())
         self._auth_context = AuthenticationContext(url=base_url)
         self.beforeExecute += self._authenticate_request

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/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/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,4 +1,7 @@
+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
 
 
@@ -10,6 +13,7 @@ class TargetApplication(Entity):
 
     @staticmethod
     def create(context, application_id, friendly_name):
+        # type: (ClientContext, str, str) -> "TargetApplication"
         """
         Creates a target application
 
@@ -25,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/inherited_from.py

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

office365/sharepoint/sharing/internal/sharing_restrictions.py

@@ -0,0 +1,22 @@
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.sharepoint.entity import Entity
+from office365.sharepoint.sharing.internal.types import CAnonymousLinkUseLimit
+
+
+class SharingRestrictions(Entity):
+    """ """
+
+    def __init__(self, context):
+        static_path = ResourcePath(
+            "Microsoft.SharePoint.Sharing.Internal.SharingRestrictions"
+        )
+        super(SharingRestrictions, self).__init__(context, static_path)
+
+    @property
+    def anonymous_link_use_limit(self):
+        return self.properties.get("anonymousLinkUseLimit", CAnonymousLinkUseLimit())
+
+    @property
+    def entity_type_name(self):
+        # type: () -> str
+        return "Microsoft.SharePoint.Sharing.Internal.SharingRestrictions"

office365/sharepoint/sharing/internal/types.py

@@ -0,0 +1,17 @@
+from office365.runtime.client_value import ClientValue
+
+
+class CAnonymousLinkUseLimit(ClientValue):
+
+    @property
+    def entity_type_name(self):
+        # type: () -> str
+        return "Microsoft.SharePoint.Sharing.Internal.CAnonymousLinkUseLimit"
+
+
+class CExternalSharingEnforcement(ClientValue):
+
+    @property
+    def entity_type_name(self):
+        # type: () -> str
+        return "Microsoft.SharePoint.Sharing.Internal.CExternalSharingEnforcement"

office365/sharepoint/sharing/link_info.py

@@ -1,6 +1,30 @@
 from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.sharepoint.sharing.inherited_from import InheritedFrom
+from office365.sharepoint.sharing.links.info import SharingLinkInfo
+from office365.sharepoint.sharing.principal import Principal
 
 
 class LinkInfo(ClientValue):
     """This class provides metadata for the tokenized sharing link including settings details, inheritance status,
     and an optional array of members."""
+
+    def __init__(
+        self,
+        inherited_from=InheritedFrom(),
+        is_inherited=None,
+        link_details=SharingLinkInfo(),
+        link_members=None,
+        link_status=None,
+        total_link_members_count=None,
+    ):
+        """
+        :param bool is_inherited: Boolean that indicates if the tokenized sharing link is present due to
+             inherited permissions from a parent object.
+        """
+        self.inherited_from = inherited_from
+        self.isInherited = is_inherited
+        self.linkDetails = link_details
+        self.linkMembers = ClientValueCollection(Principal, link_members)
+        self.linkStatus = link_status
+        self.totalLinkMembersCount = total_link_members_count

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
@@ -132,6 +135,15 @@ class Site(Entity):
         self.ensure_property("Url", _site_loaded)
         return return_type
 
+    def get_block_download_policy_for_files_data(self):
+        """ """
+        return_type = ClientResult(self.context, str())
+        qry = ServiceOperationQuery(
+            self, "GetBlockDownloadPolicyForFilesData", None, None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def get_migration_status(self):
         """"""
         return_type = EntityCollection(self.context, SPMigrationJobStatus)
@@ -495,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):
@@ -565,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,12 +1,45 @@
+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):
     """"""
 
+    @property
+    def major_version_limit(self):
+        # type: () -> Optional[int]
+        """ """
+        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"