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

office365/sharepoint/marketplace/corporatecuratedgallery/teams_package_download.py

@@ -1,9 +1,23 @@
+from typing import AnyStr
+
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
 
 class TeamsPackageDownload(Entity):
     """"""
 
+    def download_teams(self):
+        # type: () -> ClientResult[AnyStr]
+        """ """
+        return_type = ClientResult(self.context)
+        qry = ServiceOperationQuery(
+            self, "DownloadTeams", None, None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Marketplace.CorporateCuratedGallery.TeamsPackageDownload"

office365/sharepoint/marketplace/tenant/appcatalog/accessor.py

@@ -1,3 +1,5 @@
+import os
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.paths.service_operation import ServiceOperationPath
@@ -8,9 +10,18 @@ from office365.sharepoint.marketplace.app_metadata import CorporateCatalogAppMet
 from office365.sharepoint.marketplace.app_metadata_collection import (
     CorporateCatalogAppMetadataCollection,
 )
+from office365.sharepoint.marketplace.corporatecuratedgallery.app_request_information import (
+    SPStoreAppRequestInformation,
+)
+from office365.sharepoint.marketplace.corporatecuratedgallery.app_response_information import (
+    SPStoreAppResponseInformation,
+)
 from office365.sharepoint.marketplace.corporatecuratedgallery.app_upgrade_availability import (
     AppUpgradeAvailability,
 )
+from office365.sharepoint.marketplace.corporatecuratedgallery.card_designs import (
+    CardDesigns,
+)
 from office365.sharepoint.marketplace.corporatecuratedgallery.teams_package_download import (
     TeamsPackageDownload,
 )
@@ -22,7 +33,7 @@ from office365.sharepoint.marketplace.sitecollection.appcatalog.allowed_items im
 class TenantCorporateCatalogAccessor(Entity):
     """Accessor for the tenant corporate catalog."""
 
-    def add(self, content, overwrite, url):
+    def add(self, content, overwrite, url=None):
         """
         Adds a file to the corporate catalog.
 
@@ -32,13 +43,34 @@ class TenantCorporateCatalogAccessor(Entity):
         :param str url: Specifies the URL of the file to be added.
         """
         return_type = File(self.context)
-        payload = {"Content": content, "Overwrite": overwrite, "Url": url}
-        qry = ServiceOperationQuery(self, "Add", None, payload, None, return_type)
+        params = {"Overwrite": overwrite, "Url": url}
+        qry = ServiceOperationQuery(self, "Add", params, content, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def app_from_path(self, path, overwrite):
+        # type: (str, bool) -> File
+        """
+        Adds a file to the corporate catalog.
+        """
+        with open(path, "rb") as f:
+            content = f.read()
+        url = os.path.basename(path)
+        return self.add(content=content, overwrite=overwrite, url=url)
+
+    def app_requests(self):
+        """"""
+        return_type = ClientResult(self.context, SPStoreAppResponseInformation())
+        payload = {"AppRequestInfo": SPStoreAppRequestInformation()}
+        qry = ServiceOperationQuery(
+            self, "AppRequests", None, payload, None, return_type
+        )
         self.context.add_query(qry)
         return return_type
 
     def download_teams_solution(self, _id):
         """
+        Downloads a Microsoft Teams solution package associated with an app from the SharePoint App Catalog
         :param int _id:
         """
         return_type = TeamsPackageDownload(self.context)
@@ -60,6 +92,7 @@ class TenantCorporateCatalogAccessor(Entity):
 
     def is_app_upgrade_available(self, _id):
         """
+        Determines if an upgrade is available for an app in the SharePoint app catalog
         :param int _id:
         """
         return_type = ClientResult(self.context, AppUpgradeAvailability())
@@ -70,8 +103,21 @@ class TenantCorporateCatalogAccessor(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def upload(self, content, overwrite, url, xor_hash=None):
+        """"""
+        payload = {
+            "Content": content,
+            "Overwrite": overwrite,
+            "Url": url,
+            "XorHash": xor_hash,
+        }
+        qry = ServiceOperationQuery(self, "Upload", None, payload)
+        self.context.add_query(qry)
+        return self
+
     def send_app_request_status_notification_email(self, request_guid):
         """
+        Sends email notifications about the status of an app request in the corporate app catalog
         :param str request_guid:
         """
         qry = ServiceOperationQuery(
@@ -90,6 +136,14 @@ class TenantCorporateCatalogAccessor(Entity):
             ),
         )
 
+    @property
+    def card_designs(self):
+        """Returns the card designs available in this corporate catalog."""
+        return self.properties.get(
+            "CardDesigns",
+            CardDesigns(self.context, ResourcePath("CardDesigns", self.resource_path)),
+        )
+
     @property
     def site_collection_app_catalogs_sites(self):
         """Returns an accessor to the allow list of site collections allowed to have site collection corporate
@@ -102,10 +156,15 @@ class TenantCorporateCatalogAccessor(Entity):
             ),
         )
 
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Marketplace.CorporateCuratedGallery.TenantCorporateCatalogAccessor"
+
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {
                 "AvailableApps": self.available_apps,
+                "CardDesigns": self.card_designs,
                 "SiteCollectionAppCatalogsSites": self.site_collection_app_catalogs_sites,
             }
             default_value = property_mapping.get(name, None)

office365/sharepoint/migration/copy_migration_options.py

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

office365/sharepoint/multigeo/services.py

@@ -2,6 +2,7 @@ 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.entity_collection import EntityCollection
+from office365.sharepoint.multigeo.storage_quota import StorageQuota
 from office365.sharepoint.multigeo.unified_group import UnifiedGroup
 from office365.sharepoint.multigeo.user_personal_site_location import (
     UserPersonalSiteLocation,
@@ -39,6 +40,19 @@ class MultiGeoServices(Entity):
         self.context.add_query(qry)
         return return_type
 
+    @property
+    def storage_quotas(self):
+        # type: () -> EntityCollection[UnifiedGroup]
+        """ """
+        return self.properties.get(
+            "StorageQuotas",
+            EntityCollection(
+                self.context,
+                StorageQuota,
+                ResourcePath("StorageQuotas", self.resource_path),
+            ),
+        )
+
     @property
     def unified_groups(self):
         # type: () -> EntityCollection[UnifiedGroup]

office365/sharepoint/multigeo/storage_quota.py

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

office365/sharepoint/policy/license_utilities.py

@@ -0,0 +1,27 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.entity import Entity
+
+
+class PolicyLicenseUtilities(Entity):
+    """"""
+
+    @staticmethod
+    def check_tenant_m365_copilot_business_chat_license(context, return_type=None):
+        """"""
+        if return_type is None:
+            return_type = ClientResult(context, bool())
+        qry = ServiceOperationQuery(
+            PolicyLicenseUtilities(context),
+            "CheckTenantM365CopilotBusinessChatLicense",
+            None,
+            None,
+            None,
+            return_type,
+        )
+        context.add_query(qry)
+        return return_type
+
+    @property
+    def entity_type_name(self):
+        return "SP.Utilities.PolicyLicenseUtilities"

office365/sharepoint/portal/groups/site_manager.py

@@ -4,6 +4,7 @@ from office365.runtime.http.http_method import HttpMethod
 from office365.runtime.http.request_options import RequestOptions
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.portal.channels.info_collection import ChannelInfoCollection
 from office365.sharepoint.portal.groups.creation_context import GroupCreationContext
 from office365.sharepoint.portal.groups.creation_information import (
     GroupCreationInformation,
@@ -15,12 +16,17 @@ from office365.sharepoint.portal.teams.recent_and_joined_response import (
 
 
 class GroupSiteManager(ClientObject):
+    """Management of Group Sites in SharePoint. Group Sites, also known as Microsoft 365 Groups,
+    provide collaboration spaces that integrate with various Microsoft 365 services like Teams, Outlook, and Planner.
+    """
+
     def __init__(self, context, resource_path=None):
         if resource_path is None:
             resource_path = ResourcePath("GroupSiteManager")
         super(GroupSiteManager, self).__init__(context, resource_path)
 
     def can_user_create_group(self):
+        """Determines if the current user can create group site"""
         return_type = ClientResult(self.context, bool())
         qry = ServiceOperationQuery(
             self, "CanUserCreateGroup", None, None, None, return_type
@@ -83,6 +89,7 @@ class GroupSiteManager(ClientObject):
         return self
 
     def ensure_team_for_group(self):
+        """ """
         return_type = ClientResult(self.context)
         qry = ServiceOperationQuery(
             self, "EnsureTeamForGroup", None, None, None, return_type
@@ -91,6 +98,7 @@ class GroupSiteManager(ClientObject):
         return return_type
 
     def get_group_creation_context(self):
+        """ """
         return_type = ClientResult(self.context, GroupCreationContext())
         qry = ServiceOperationQuery(
             self, "GetGroupCreationContext", None, None, None, return_type
@@ -131,6 +139,7 @@ class GroupSiteManager(ClientObject):
         return result
 
     def get_current_user_shared_channel_member_groups(self):
+        """ """
         return_type = ClientResult(self.context)
         qry = ServiceOperationQuery(
             self,
@@ -145,6 +154,8 @@ class GroupSiteManager(ClientObject):
 
     def get_team_channels(self, team_id, use_staging_endpoint=False):
         """
+        Retrieves the channels associated with a specific Microsoft 365 Group (or Team)
+
         :param str team_id:
         :param bool use_staging_endpoint:
         """
@@ -170,6 +181,21 @@ class GroupSiteManager(ClientObject):
         self.context.add_query(qry)
         return return_type
 
+    def get_team_channels_with_site_url(self, site_url):
+        """
+        Returns a list of team channels associated with a Microsoft 365 Group.
+        :param str site_url:
+        """
+        return_type = ClientResult(self.context, ChannelInfoCollection())
+        payload = {
+            "siteUrl": site_url,
+        }
+        qry = ServiceOperationQuery(
+            self, "GetTeamChannelsWithSiteUrl", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def notebook(self, group_id):
         """
         :param str group_id:
@@ -188,6 +214,8 @@ class GroupSiteManager(ClientObject):
         existing_joined_teams_data=None,
     ):
         """
+        Retrieves a list of teams that a user has recently accessed or joined
+
         :param bool include_recent:
         :param bool include_teams:
         :param bool include_pinned:
@@ -205,3 +233,7 @@ class GroupSiteManager(ClientObject):
         )
         self.context.add_query(qry)
         return return_type
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Portal.GroupSiteManager"

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

@@ -1,7 +1,9 @@
 from typing import Optional
 
+from office365.runtime.odata.type import ODataType
 from office365.runtime.paths.service_operation import ServiceOperationPath
 from office365.sharepoint.entity import Entity
+from office365.sharepoint.principal.type import PrincipalType
 
 
 class Principal(Entity):
@@ -60,6 +62,10 @@ class Principal(Entity):
         """Gets the type of the principal."""
         return self.properties.get("PrincipalType", None)
 
+    @property
+    def principal_type_name(self):
+        return ODataType.resolve_enum_key(PrincipalType, self.principal_type)
+
     @property
     def property_ref_name(self):
         return "Id"

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

@@ -1,10 +1,11 @@
-from typing import Optional
+from typing import Callable, List, Optional
 
 from requests import Response
 from typing_extensions import Self
 
 from office365.runtime.auth.authentication_context import AuthenticationContext
 from office365.runtime.auth.client_credential import ClientCredential
+from office365.runtime.auth.token_response import TokenResponse
 from office365.runtime.auth.user_credential import UserCredential
 from office365.runtime.http.request_options import RequestOptions
 from office365.runtime.odata.request import ODataRequest
@@ -12,28 +13,115 @@ from office365.runtime.odata.v3.json_light_format import JsonLightFormat
 
 
 class SharePointRequest(ODataRequest):
-    def __init__(self, base_url):
+    def __init__(
+        self, base_url, environment="commercial", allow_ntlm=False, browser_mode=False
+    ):
+        """
+        :param str base_url: Absolute Web or Site Url
+        :param str environment: The Office 365 Cloud Environment endpoint used for authentication
+            defaults to 'commercial'.
+        :param bool allow_ntlm: Flag indicates whether NTLM scheme is enabled. Disabled by default
+        :param bool browser_mode: Allow browser authentication
+        """
         super().__init__(JsonLightFormat())
-        self._auth_context = AuthenticationContext(url=base_url)
+        self._auth_context = AuthenticationContext(
+            url=base_url,
+            environment=environment,
+            allow_ntlm=allow_ntlm,
+            browser_mode=browser_mode,
+        )
         self.beforeExecute += self._authenticate_request
 
     def execute_request(self, path):
         # type: (str) -> Response
-        request_url = "{0}/_api/{1}".format(self._auth_context.url, path)
+        request_url = "{0}/{1}".format(self.service_root_url, path)
         return self.execute_request_direct(RequestOptions(request_url))
 
-    def with_credentials(self, credentials, environment="commercial"):
-        # type: (UserCredential|ClientCredential, Optional[str]) -> Self
+    def with_credentials(self, credentials):
+        # type: (UserCredential|ClientCredential) -> Self
         """
         Initializes a client to acquire a token via user or client credentials
-        :type credentials: UserCredential or ClientCredential
-        :param str environment: The Office 365 Cloud Environment endpoint used for authentication
-            defaults to 'commercial'.
         """
-        self._auth_context.with_credentials(credentials, environment=environment)
+        self._auth_context.with_credentials(credentials)
+        return self
+
+    def with_client_certificate(
+        self,
+        tenant,
+        client_id,
+        thumbprint,
+        cert_path=None,
+        private_key=None,
+        scopes=None,
+        passphrase=None,
+    ):
+        # type: (str, str, str, Optional[str], Optional[str], Optional[List[str]], Optional[str]) -> Self
+        """
+        Creates authenticated SharePoint context via certificate credentials
+
+        :param str tenant: Tenant name
+        :param str or None cert_path: Path to A PEM encoded certificate private key.
+        :param str or None private_key: A PEM encoded certificate private key.
+        :param str thumbprint: Hex encoded thumbprint of the certificate.
+        :param str client_id: The OAuth client id of the calling application.
+        :param list[str] or None scopes:  Scopes requested to access a protected API (a resource)
+        :param str passphrase: Passphrase if the private_key is encrypted
+        """
+        self._auth_context.with_client_certificate(
+            tenant, client_id, thumbprint, cert_path, private_key, scopes, passphrase
+        )
+        return self
+
+    def with_device_flow(self, tenant, client_id, scopes=None):
+        # type: (str, str, Optional[List[str]]) -> Self
+        """
+        Initializes a client to acquire a token via device flow auth.
+
+        :param str tenant: Tenant name, for example: contoso.onmicrosoft.com
+        :param str client_id: The OAuth client id of the calling application.
+        :param list[str] or None scopes:  Scopes requested to access a protected API (a resource)
+        """
+        self._auth_context.with_device_flow(tenant, client_id, scopes)
+        return self
+
+    def with_interactive(self, tenant, client_id, scopes=None):
+        # type: (str, str, Optional[List[str]]) -> Self
+        """
+        Initializes a client to acquire a token interactively i.e. via a local browser.
+
+        Prerequisite: In Azure Portal, configure the Redirect URI of your
+        "Mobile and Desktop application" as ``http://localhost``.
+
+        :param str tenant: Tenant name, for example: contoso.onmicrosoft.com
+        :param str client_id: The OAuth client id of the calling application.
+        :param list[str] or None scopes:  Scopes requested to access a protected API (a resource)
+        """
+        self._auth_context.with_interactive(tenant, client_id, scopes)
+        return self
+
+    def with_access_token(self, token_func):
+        # type: (Callable[[], TokenResponse]) -> Self
+        """
+        Initializes a client to acquire a token from a callback
+        :param () -> TokenResponse token_func: A token callback
+        """
+        self._auth_context.with_access_token(token_func)
         return self
 
     def _authenticate_request(self, request):
         # type: (RequestOptions) -> None
         """Authenticate request"""
         self._auth_context.authenticate_request(request)
+
+    @property
+    def authentication_context(self):
+        return self._auth_context
+
+    @property
+    def base_url(self):
+        """Represents Base Url"""
+        return self._auth_context.url
+
+    @property
+    def service_root_url(self):
+        return "{0}/_api".format(self._auth_context.url)

office365/sharepoint/search/administration/document_crawl_log.py

@@ -15,15 +15,29 @@ class DocumentCrawlLog(Entity):
         )
         super(DocumentCrawlLog, self).__init__(context, static_path)
 
-    def get_crawled_urls(self, get_count_only=False):
+    def get_crawled_urls(
+        self,
+        get_count_only=False,
+        max_rows=None,
+        query_string=None,
+        content_source_id=None,
+    ):
         """
         Retrieves information about all the contents that were crawled.
 
         :param bool get_count_only: f true, only the count of the contents crawled MUST be returned.
              If false, all the information about the crawled contents MUST be returned.
+        :param int max_rows:
+        :param str query_string:
+        :param int content_source_id:
         """
         return_type = ClientResult(self.context, SimpleDataTable())
-        payload = {"getCountOnly": get_count_only}
+        payload = {
+            "getCountOnly": get_count_only,
+            "maxRows": max_rows,
+            "queryString": query_string,
+            "contentSourceID": content_source_id,
+        }
         qry = ServiceOperationQuery(
             self, "GetCrawledUrls", None, payload, None, return_type
         )