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

office365/sharepoint/client_context.py

@@ -41,8 +41,15 @@ from office365.sharepoint.webs.web import Web
 class ClientContext(ClientRuntimeContext):
     """SharePoint client context (SharePoint v1 API)"""
 
-    def __init__(self, base_url, auth_context=None):
-        # type: (str, AuthenticationContext | None) -> None
+    def __init__(
+        self,
+        base_url,
+        auth_context=None,
+        environment=None,
+        allow_ntlm=False,
+        browser_mode=False,
+    ):
+        # type: (str, Optional[AuthenticationContext], str, bool, bool) -> None
         """
         Instantiates a SharePoint client context
 
@@ -51,7 +58,12 @@ class ClientContext(ClientRuntimeContext):
         """
         super(ClientContext, self).__init__()
         if auth_context is None:
-            auth_context = AuthenticationContext(url=base_url)
+            auth_context = AuthenticationContext(
+                url=base_url,
+                environment=environment,
+                allow_ntlm=allow_ntlm,
+                browser_mode=browser_mode,
+            )
         self._auth_context = auth_context
         self._web = None
         self._site = None
@@ -138,36 +150,18 @@ class ClientContext(ClientRuntimeContext):
         self.authentication_context.with_access_token(token_func)
         return self
 
-    def with_user_credentials(
-        self,
-        username,
-        password,
-        allow_ntlm=False,
-        browser_mode=False,
-        environment="commercial",
-    ):
-        # type: (str, str, bool, bool, Optional[str]) -> Self
+    def with_user_credentials(self, username, password):
+        # type: (str, str) -> Self
         """
         Initializes a client to acquire a token via user credentials.
         :param str username: Typically, a UPN in the form of an email address
         :param str password: The password
-        :param bool allow_ntlm: Flag indicates whether NTLM scheme is enabled. Disabled by default
-        :param bool browser_mode:
-        :param str environment: The Office 365 Cloud Environment endpoint used for authentication
-            defaults to 'commercial'.
         """
-        self.authentication_context.with_credentials(
-            UserCredential(username, password),
-            allow_ntlm=allow_ntlm,
-            browser_mode=browser_mode,
-            environment=environment,
-        )
+        self.authentication_context.with_credentials(UserCredential(username, password))
         return self
 
-    def with_client_credentials(
-        self, client_id, client_secret, environment="commercial"
-    ):
-        # type: (str, str, Optional[str]) -> Self
+    def with_client_credentials(self, client_id, client_secret):
+        # type: (str, str) -> Self
         """
         Initializes a client to acquire a token via client credentials (SharePoint App-Only)
 
@@ -176,25 +170,19 @@ class ClientContext(ClientRuntimeContext):
 
         :param str client_id: The OAuth client id of the calling application
         :param str client_secret: Secret string that the application uses to prove its identity when requesting a token
-        :param str environment: The Office 365 Cloud Environment endpoint used for authentication
-            defaults to 'commercial'.
         """
         self.authentication_context.with_credentials(
-            ClientCredential(client_id, client_secret), environment=environment
+            ClientCredential(client_id, client_secret)
         )
         return self
 
-    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.authentication_context.with_credentials(
-            credentials, environment=environment
-        )
+        self.authentication_context.with_credentials(credentials)
         return self
 
     def execute_batch(self, items_per_batch=100, success_callback=None):
@@ -498,6 +486,22 @@ class ClientContext(ClientRuntimeContext):
 
         return FolderColoring(self, ResourcePath("foldercoloring"))
 
+    @property
+    def font_packages(self):
+        """Alias to FontPackageCollection"""
+
+        from office365.sharepoint.fontpackages.collection import FontPackageCollection
+
+        return FontPackageCollection(self, ResourcePath("fontpackages"))
+
+    @property
+    def site_font_packages(self):
+        """Alias to FontPackageCollection"""
+
+        from office365.sharepoint.fontpackages.collection import FontPackageCollection
+
+        return FontPackageCollection(self, ResourcePath("sitefontpackages"))
+
     @property
     def group_site_manager(self):
         """Alias to GroupSiteManager"""
@@ -542,6 +546,16 @@ class ClientContext(ClientRuntimeContext):
 
         return ProfileLoader(self)
 
+    @property
+    def document_crawl_log(self):
+        """Alias to DocumentCrawlLog"""
+
+        from office365.sharepoint.search.administration.document_crawl_log import (
+            DocumentCrawlLog,
+        )
+
+        return DocumentCrawlLog(self)
+
     @property
     def lists(self):
         """Alias to ListCollection. Gets information about all lists that the current user can access."""
@@ -636,7 +650,7 @@ class ClientContext(ClientRuntimeContext):
     @property
     def home_site(self):
         """Alias to SPHSite."""
-        from office365.sharepoint.sites.sph_site import SPHSite
+        from office365.sharepoint.sites.home.site import SPHSite
 
         return SPHSite(self, ResourcePath("SPHSite"))
 
@@ -661,8 +675,17 @@ class ClientContext(ClientRuntimeContext):
             self, SPMachineLearningPublication, ResourcePath("publications")
         )
 
+    @property
+    def server_settings(self):
+        """Provides methods for obtaining server properties"""
+
+        from office365.sharepoint.server_settings import ServerSettings
+
+        return ServerSettings(self)
+
     @property
     def social_following_manager(self):
+        """ """
         from office365.sharepoint.social.following.manager import SocialFollowingManager
 
         return SocialFollowingManager(self)
@@ -697,6 +720,7 @@ class ClientContext(ClientRuntimeContext):
 
     @property
     def viva_site_manager(self):
+        """"""
         from office365.sharepoint.viva.site_manager import VivaSiteManager
 
         return VivaSiteManager(self)

office365/sharepoint/directory/group.py

@@ -5,6 +5,8 @@ from office365.sharepoint.entity_collection import EntityCollection
 
 
 class Group(Entity):
+    """ """
+
     def get_members_info(self, row_limit):
         """"""
         return_type = MembersInfo(self.context)

office365/sharepoint/directory/helper.py

@@ -88,6 +88,8 @@ class SPHelper(Entity):
     @staticmethod
     def get_my_groups(context, logon_name, offset, length, return_type=None):
         """
+        Retrieves information about groups that a user belongs to.
+
         :param office365.sharepoint.client_context.ClientContext context: SharePoint context
         :param str logon_name: User's login
         :param int offset: Result offset

office365/sharepoint/directory/provider/provider.py

@@ -13,6 +13,12 @@ class SharePointDirectoryProvider(Entity):
             )
         super(SharePointDirectoryProvider, self).__init__(context, resource_path)
 
+    def check_site_availability(self, site_url):
+        """"""
+        from office365.sharepoint.directory.helper import SPHelper
+
+        return SPHelper.check_site_availability(self.context, site_url)
+
     def read_directory_object(self, data):
         # type: (DirectoryObjectData) -> ClientResult[DirectoryObjectData]
         """"""

office365/sharepoint/directory/user.py

@@ -1,10 +1,27 @@
+from typing import Optional
+
 from office365.runtime.client_result import ClientResult
 from office365.sharepoint.directory.my_groups_result import MyGroupsResult
 from office365.sharepoint.entity import Entity
 
 
 class User(Entity):
+    """Represents a user in the SharePoint Directory"""
+
+    @property
+    def about_me(self):
+        # type: () -> Optional[str]
+        """Stores a short description or bio of the user."""
+        return self.properties.get("aboutMe", None)
+
+    @property
+    def account_enabled(self):
+        # type: () -> Optional[bool]
+        """Gets weather the account is active (user can log in and access services) or not"""
+        return self.properties.get("accountEnabled", None)
+
     def is_member_of(self, group_id):
+        # type: (str) -> ClientResult[bool]
         return_type = ClientResult(self.context)
 
         def _user_loaded():
@@ -18,6 +35,9 @@ class User(Entity):
         return return_type
 
     def get_my_groups(self):
+        """
+        Retrieves information about groups that a user belongs to.
+        """
         return_type = MyGroupsResult(self.context)
 
         def _user_loaded():

office365/sharepoint/files/publish/status.py

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

office365/sharepoint/flows/connector_result.py

@@ -0,0 +1,17 @@
+from typing import Optional
+
+from office365.sharepoint.entity import Entity
+
+
+class ConnectorResult(Entity):
+    """ """
+
+    @property
+    def context_data(self):
+        # type: () -> Optional[str]
+        return self.properties.get("ContextData", None)
+
+    @property
+    def value(self):
+        # type: () -> Optional[str]
+        return self.properties.get("Value", None)

office365/sharepoint/flows/permissions.py

@@ -1,17 +1,21 @@
-from office365.runtime.client_result import ClientResult
+from typing import TYPE_CHECKING, Optional
+
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
+from office365.sharepoint.flows.connector_result import ConnectorResult
+
+if TYPE_CHECKING:
+    from office365.sharepoint.client_context import ClientContext
 
 
 class FlowPermissions(Entity):
 
     @staticmethod
-    def get_flow_permission_level_on_list(context, list_name):
-        """
-        :param office365.sharepoint.client_context.ClientContext context: SharePoint client context
-         :param str list_name: Specifies the list name.
-        """
-        return_type = ClientResult(context)
+    def get_flow_permission_level_on_list(context, list_name, return_type=None):
+        # type: (ClientContext, str, Optional[ConnectorResult]) -> ConnectorResult
+        """ """
+        if return_type is None:
+            return_type = ConnectorResult(context)
         payload = {"listName": list_name}
         qry = ServiceOperationQuery(
             FlowPermissions(context),

office365/sharepoint/fontpackages/collection.py

@@ -0,0 +1,26 @@
+from typing import TYPE_CHECKING, Optional
+
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.paths.service_operation import ServiceOperationPath
+from office365.sharepoint.entity_collection import EntityCollection
+from office365.sharepoint.fontpackages.font_package import FontPackage
+
+if TYPE_CHECKING:
+    from office365.sharepoint.client_context import ClientContext
+
+
+class FontPackageCollection(EntityCollection):
+    """Represents a collection of View resources."""
+
+    def __init__(self, context, resource_path=None):
+        # type: (ClientContext, Optional[ResourcePath]) -> None
+        super(FontPackageCollection, self).__init__(context, FontPackage, resource_path)
+
+    def get_by_title(self, title):
+        """
+        :param str title: The title of the font package to return.
+        """
+        return FontPackage(
+            self.context,
+            ServiceOperationPath("GetByTitle", [title], self.resource_path),
+        )

office365/sharepoint/fontpackages/creation_parameters.py

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

office365/sharepoint/fontpackages/font_package.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.entity import Entity
+
+
+class FontPackage(Entity):
+    """Represents a font package."""

office365/sharepoint/fontpackages/oob_settings.py

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

office365/sharepoint/forms/customization.py

@@ -1,7 +1,33 @@
+from typing import TYPE_CHECKING, Optional
+
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
+from office365.sharepoint.flows.connector_result import ConnectorResult
+
+if TYPE_CHECKING:
+    from office365.sharepoint.client_context import ClientContext
 
 
 class FormsCustomization(Entity):
+
+    @staticmethod
+    def can_customize_forms(context, list_name, return_type=None):
+        # type: (ClientContext, str, Optional[ConnectorResult]) -> ConnectorResult
+        """"""
+        if return_type is None:
+            return_type = ConnectorResult(context)
+        payload = {"listName": list_name}
+        qry = ServiceOperationQuery(
+            FormsCustomization(context),
+            "CanCustomizeForms",
+            None,
+            payload,
+            None,
+            return_type,
+        )
+        context.add_query(qry)
+        return return_type
+
     @property
     def entity_type_name(self):
         return "SP.Internal.FormsCustomization"

office365/sharepoint/ir/migration.py

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

office365/sharepoint/lists/list.py

@@ -89,6 +89,21 @@ class List(SecurableObject):
 
         return ListExporter.export(self, local_file, include_content, item_exported)
 
+    def can_customize_forms(self):
+        """"""
+        from office365.sharepoint.flows.connector_result import ConnectorResult
+        from office365.sharepoint.forms.customization import FormsCustomization
+
+        return_type = ConnectorResult(self.context)
+
+        def _can_customize_forms():
+            FormsCustomization.can_customize_forms(
+                self.context, self.title, return_type
+            )
+
+        self.ensure_property("Title", _can_customize_forms)
+        return return_type
+
     def clear(self):
         """Clears the list."""
 
@@ -177,6 +192,21 @@ class List(SecurableObject):
         self.root_folder.ensure_property("ServerRelativeUrl", _loaded)
         return return_type
 
+    def get_flow_permission_level(self):
+        """"""
+        from office365.sharepoint.flows.connector_result import ConnectorResult
+        from office365.sharepoint.flows.permissions import FlowPermissions
+
+        return_type = ConnectorResult(self.context)
+
+        def _loaded():
+            FlowPermissions.get_flow_permission_level_on_list(
+                self.context, self.title, return_type
+            )
+
+        self.ensure_property("Title", _loaded)
+        return return_type
+
     def get_sharing_settings(self):
         """Retrieves a sharing settings for a List"""
         return_type = ObjectSharingSettings(self.context)

office365/sharepoint/marketplace/app_metadata.py

@@ -7,6 +7,9 @@ from office365.sharepoint.entity import Entity
 class CorporateCatalogAppMetadata(Entity):
     """App metadata for apps stored in the corporate catalog."""
 
+    def __str__(self):
+        return self.title or self.entity_type_name
+
     def deploy(self, skip_feature_deployment):
         """This method deploys an app on the app catalog.  It MUST be called in the context of the tenant app
         catalog web or it will fail.
@@ -18,6 +21,13 @@ class CorporateCatalogAppMetadata(Entity):
         self.context.add_query(qry)
         return self
 
+    def remove(self):
+        """This is the inverse of the add step above. One removed from the app catalog,
+        the solution can't be deployed."""
+        qry = ServiceOperationQuery(self, "Remove")
+        self.context.add_query(qry)
+        return self
+
     def install(self):
         """This method allows an app which is already deployed to be installed on a web."""
         qry = ServiceOperationQuery(self, "Install")
@@ -68,7 +78,8 @@ class CorporateCatalogAppMetadata(Entity):
 
     @property
     def property_ref_name(self):
-        return "AadAppId"
+        # return "AadAppId"
+        return "ID"
 
     @property
     def entity_type_name(self):

office365/sharepoint/marketplace/app_metadata_collection.py

@@ -22,3 +22,11 @@ class CorporateCatalogAppMetadataCollection(
         return CorporateCatalogAppMetadata(
             self.context, ServiceOperationPath("GetById", [app_id], self.resource_path)
         )
+
+    def get_by_title(self, title):
+        """
+        Get app metadata by title.
+
+        :param str title: The title of the app to retrieve.
+        """
+        return self.first("title eq '{0}'".format(title))

office365/sharepoint/marketplace/corporatecuratedgallery/addins/instance_info.py

@@ -2,6 +2,28 @@ from office365.runtime.client_value import ClientValue
 
 
 class SPAddinInstanceInfo(ClientValue):
+
+    def __init__(
+        self,
+        app_identifier=None,
+        app_instance_id=None,
+        tenant_app_data=None,
+        tenant_app_data_update_time=None,
+        title=None,
+    ):
+        """
+        :param str app_identifier:
+        :param str app_instance_id:
+        :param str tenant_app_data:
+        :param datetime.datetime tenant_app_data_update_time:
+        :param str title:
+        """
+        self.appIdentifier = app_identifier
+        self.appInstanceId = app_instance_id
+        self.tenantAppData = tenant_app_data
+        self.tenantAppDataUpdateTime = tenant_app_data_update_time
+        self.title = title
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Marketplace.CorporateCuratedGallery.SPAddinInstanceInfo"

office365/sharepoint/marketplace/corporatecuratedgallery/addins/permission_failed_info.py

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

office365/sharepoint/marketplace/corporatecuratedgallery/addins/permission_info.py

@@ -0,0 +1,12 @@
+from office365.runtime.client_value import ClientValue
+
+
+class SPAddinPermissionInfo(ClientValue):
+    """"""
+
+    def __init__(self, absolute_url=None):
+        self.absoluteUrl = absolute_url
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Marketplace.CorporateCuratedGallery.SPAddinPermissionInfo"

office365/sharepoint/marketplace/corporatecuratedgallery/addins/permission_response.py

@@ -1,9 +1,24 @@
 from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.sharepoint.marketplace.corporatecuratedgallery.addins.permission_failed_info import (
+    SPAddinPermissionFailedInfo,
+)
+from office365.sharepoint.marketplace.corporatecuratedgallery.addins.permission_info import (
+    SPAddinPermissionInfo,
+)
 
 
 class SPAddinPermissionResponse(ClientValue):
     """"""
 
+    def __init__(self, addin_permissions=None, failed_addins=None):
+        self.addinPermissions = ClientValueCollection(
+            SPAddinPermissionInfo, addin_permissions
+        )
+        self.failedAddins = ClientValueCollection(
+            SPAddinPermissionFailedInfo, failed_addins
+        )
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Marketplace.CorporateCuratedGallery.SPAddinPermissionResponse"

office365/sharepoint/marketplace/corporatecuratedgallery/addins/principals_response.py

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

office365/sharepoint/marketplace/corporatecuratedgallery/app_request_information.py

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

office365/sharepoint/marketplace/corporatecuratedgallery/app_response_information.py

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

office365/sharepoint/marketplace/corporatecuratedgallery/available_addins_response.py

@@ -8,3 +8,7 @@ from office365.sharepoint.marketplace.corporatecuratedgallery.addins.instance_in
 class SPAvailableAddinsResponse(ClientValue):
     def __init__(self, addins=None):
         self.addins = ClientValueCollection(SPAddinInstanceInfo, addins)
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Marketplace.CorporateCuratedGallery.SPAvailableAddinsResponse"

office365/sharepoint/marketplace/corporatecuratedgallery/card_design.py

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

office365/sharepoint/marketplace/corporatecuratedgallery/card_designs.py

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

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"