Office365-REST-Python-Client 2.5.8__py3-none-any.whl → 2.5.10__py3-none-any.whl

office365/sharepoint/alerts/collection.py

@@ -39,6 +39,18 @@ class AlertCollection(EntityCollection[Alert]):
         self.context.add_query(qry)
         return return_type
 
+    def delete_alert_at_index(self, index):
+        """Deletes the alert based on the given index.
+
+        :param int index:  A 32-bit integer that is greater than or equal to 0 and less than the count of the
+              alert in the collection. Specifies the index of the alert in the collection.
+        """
+        qry = ServiceOperationQuery(
+            self, "DeleteAlertAtIndex", {"index": index}, None, None, None
+        )
+        self.context.add_query(qry)
+        return self
+
     def get_by_id(self, id_alert):
         """
         Gets an alert based on the Id.

office365/sharepoint/attachments/collection.py

@@ -19,7 +19,7 @@ class AttachmentCollection(EntityCollection[Attachment]):
         )
 
     def add(self, attachment_file_information):
-        # type: (AttachmentCreationInformation) -> Attachment
+        # type: (AttachmentCreationInformation|dict) -> Attachment
         """
         Adds the attachment represented by the file name and stream in the specified parameter to the list item.
 

office365/sharepoint/businessdata/infrastructure/securestore/connection_settings.py

@@ -1,8 +1,30 @@
+from typing import Optional
+
+from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.entity import Entity
 
 
 class ConnectionSettings(Entity):
-    """"""
+    """The ConnectionSettings contains information about an endpoint (4) that can be used to connect to it."""
+
+    def __init__(self, context, resource_path=None):
+        if resource_path is None:
+            resource_path = ResourcePath(
+                "Microsoft.BusinessData.Infrastructure.SecureStore.ConnectionSettings"
+            )
+        super(ConnectionSettings, self).__init__(context, resource_path)
+
+    @property
+    def authentication_mode(self):
+        # type: () -> Optional[str]
+        """The authentication mode used by the endpoint"""
+        return self.properties.get("AuthenticationMode", None)
+
+    @property
+    def parent_name(self):
+        # type: () -> Optional[str]
+        """The unique name used to identify the parent of the endpoint"""
+        return self.properties.get("parentName", None)
 
     @property
     def entity_type_name(self):

office365/sharepoint/directory/membership_result.py

@@ -1,7 +1,12 @@
+from office365.runtime.types.collections import StringCollection
 from office365.sharepoint.entity import Entity
 
 
 class MembershipResult(Entity):
+    @property
+    def groups_list(self):
+        return self.properties.get("GroupsList", StringCollection())
+
     @property
     def entity_type_name(self):
         return "SP.Directory.MembershipResult"

office365/sharepoint/entity.py

@@ -16,6 +16,11 @@ if TYPE_CHECKING:
 class Entity(ClientObject):
     """SharePoint specific entity"""
 
+    def execute_query_with_incremental_retry(self, max_retry=5):
+        """Handles throttling requests."""
+        self.context.execute_query_with_incremental_retry(max_retry)
+        return self
+
     def execute_batch(self, items_per_batch=100, success_callback=None):
         # type: (int, Callable[[int], None]) -> Self
         """Construct and submit to a server a batch request"""

office365/sharepoint/fields/date_time.py

@@ -24,3 +24,21 @@ class FieldDateTime(Field):
         # type: () -> Optional[str]
         """ """
         return self.properties.get("DateFormat", None)
+
+    @property
+    def display_format(self):
+        # type: () -> Optional[int]
+        """Specifies the type of date and time format that is used in the field"""
+        return self.properties.get("DisplayFormat", None)
+
+    @property
+    def friendly_display_format(self):
+        # type: () -> Optional[int]
+        """Gets the type of friendly display format that is used in the field"""
+        return self.properties.get("FriendlyDisplayFormat", None)
+
+    @property
+    def time_format(self):
+        # type: () -> Optional[str]
+        """Gets the time format that is used in the field"""
+        return self.properties.get("TimeFormat", None)

office365/sharepoint/fields/lookup.py

@@ -43,3 +43,23 @@ class FieldLookup(Field):
         """Sets a value that specifies the list identifier of the list that contains the field to use as
         the lookup values."""
         self.set_property("LookupList", val, True)
+
+    @property
+    def primary_field_id(self):
+        # type: () -> Optional[str]
+        """Specifies the primary lookup field identifier if this is a dependent lookup field.
+        Otherwise, it is an empty string."""
+        return self.properties.get("PrimaryFieldId", None)
+
+    @property
+    def relationship_delete_behavior(self):
+        # type: () -> Optional[int]
+        """Gets a value that specifies the relationship delete behavior of the lookup field."""
+        return self.properties.get("RelationshipDeleteBehavior", None)
+
+    @property
+    def unlimited_length_in_document_library(self):
+        # type: () -> Optional[bool]
+        """Gets or sets a Boolean value that specifies whether to allow values with unlimited text
+        in the lookup field."""
+        return self.properties.get("UnlimitedLengthInDocumentLibrary", None)

office365/sharepoint/fields/multi_line_text.py

@@ -31,3 +31,28 @@ class FieldMultiLineText(Field):
         # type: (int) -> None
         """Set the number of lines to display in the field."""
         self.set_property("NumberOfLines", val)
+
+    @property
+    def restricted_mode(self):
+        # type: () -> Optional[bool]
+        """Specifies whether the field supports a subset of rich text formatting."""
+        return self.properties.get("RestrictedMode", None)
+
+    @property
+    def rich_text(self):
+        # type: () -> Optional[bool]
+        """Specifies whether the field supports rich text formatting."""
+        return self.properties.get("RichText", None)
+
+    @property
+    def unlimited_length_in_document_library(self):
+        # type: () -> Optional[bool]
+        """Gets a Boolean value that specifies whether to allow unlimited field length in document libraries."""
+        return self.properties.get("UnlimitedLengthInDocumentLibrary", None)
+
+    @property
+    def wiki_linking(self):
+        # type: () -> Optional[bool]
+        """Specifies whether an implementation-specific mechanism for linking wiki pages is supported.
+        It MUST be "false" if RichText is "false"."""
+        return self.properties.get("WikiLinking", None)

office365/sharepoint/fields/rating_scale.py

@@ -15,11 +15,8 @@ class FieldRatingScale(FieldMultiChoice):
 
     @grid_start_number.setter
     def grid_start_number(self, value):
-        """
-        Gets the start number for the rating scale.
-
-        :type value: int
-        """
+        # type: (int) -> None
+        """Gets the start number for the rating scale."""
         self.set_property("GridStartNumber", value)
 
     @property

office365/sharepoint/files/collection.py

@@ -24,22 +24,23 @@ class FileCollection(EntityCollection[File]):
         # type: (ClientContext, ResourcePath, Folder) -> None
         super(FileCollection, self).__init__(context, File, resource_path, parent)
 
-    def upload(self, path_or_file):
-        # type: (str|IO) -> File
+    def upload(self, path_or_file, file_name=None):
+        # type: (str|IO, str) -> File
         """Uploads a file into folder.
 
         Note: This method only supports files up to 4MB in size!
         Consider create_upload_session method instead for larger files
-        :param str or typing.IO path_or_file: path where file to upload resides or file handle
+        :param str or typing.IO path_or_file: Path where file to upload resides or file handle
+        :param str file_name: New file name
         """
         if hasattr(path_or_file, "read"):
+            name = file_name or os.path.basename(path_or_file.name)
             content = path_or_file.read()
-            name = os.path.basename(path_or_file.name)
             return self.add(name, content, True)
         else:
             with open(path_or_file, "rb") as f:
                 content = f.read()
-            name = os.path.basename(path_or_file)
+            name = file_name or os.path.basename(path_or_file)
             return self.add(name, content, True)
 
     def upload_with_checksum(self, file_object, chunk_size=1024):

office365/sharepoint/files/versions/version.py

@@ -1,3 +1,4 @@
+from datetime import datetime
 from typing import IO, AnyStr, Optional
 
 from typing_extensions import Self
@@ -54,6 +55,12 @@ class FileVersion(Entity):
         self.context.add_query(qry)
         return return_type
 
+    @property
+    def created(self):
+        # type: () -> Optional[datetime]
+        """Specifies the creation date and time for the file version."""
+        return self.properties.get("Created", datetime.min)
+
     @property
     def created_by(self):
         """Gets the user that created the file version."""

office365/sharepoint/lists/list.py

@@ -1,6 +1,6 @@
 import os
 from datetime import datetime
-from typing import TYPE_CHECKING, AnyStr, Optional
+from typing import TYPE_CHECKING, AnyStr, Dict, Optional
 
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
@@ -182,11 +182,12 @@ class List(SecurableObject):
         return return_type
 
     def get_site_script(self, options=None):
+        # type: (Dict) -> ClientResult[str]
         """Creates site script syntax
 
         :param dict or None options:
         """
-        return_type = ClientResult(self.context)  # type: ClientResult[str]
+        return_type = ClientResult(self.context)
 
         def _list_loaded():
             list_abs_path = SPResPath.create_absolute(

office365/sharepoint/migrationcenter/service/performance/dashboard_data.py

@@ -1,9 +1,21 @@
 from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.runtime.types.collections import StringCollection
+from office365.sharepoint.migrationcenter.service.performance.throughput_data import (
+    ThroughputData,
+)
 
 
 class PerformanceDashboardData(ClientValue):
     """"""
 
+    def __init__(
+        self, bottleneck_list=None, recommendation_list=None, throughput_trend=None
+    ):
+        self.BottleneckList = StringCollection(bottleneck_list)
+        self.RecommendationList = StringCollection(recommendation_list)
+        self.ThroughputTrend = ClientValueCollection(ThroughputData, throughput_trend)
+
     @property
     def entity_type_name(self):
         return "Microsoft.Online.SharePoint.MigrationCenter.Service.PerformanceDashboardData"

office365/sharepoint/migrationcenter/service/performance/data.py

@@ -1,3 +1,10 @@
+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_collection import EntityCollection
+from office365.sharepoint.migrationcenter.service.performance.dashboard_data import (
+    PerformanceDashboardData,
+)
 from office365.sharepoint.migrationcenter.service.performance.entity_data import (
     MigrationPerformanceEntityData,
 )
@@ -5,3 +12,34 @@ from office365.sharepoint.migrationcenter.service.performance.entity_data import
 
 class PerformanceData(MigrationPerformanceEntityData):
     """"""
+
+    def __init__(self, context, resource_path=None):
+        if resource_path is None:
+            resource_path = ResourcePath(
+                "Microsoft.Online.SharePoint.MigrationCenter.Service.PerformanceData"
+            )
+        super(PerformanceData, self).__init__(context, resource_path)
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.MigrationCenter.Service.PerformanceData"
+
+
+class PerformanceDataCollection(EntityCollection[PerformanceData]):
+    def __init__(self, context, resource_path=None):
+        super(PerformanceDataCollection, self).__init__(
+            context, PerformanceData, resource_path
+        )
+
+    def get_data(self, StartTime=None, EndTime=None, AgentId=None, TimeUnit=None):
+        """ """
+        return_type = ClientResult(self.context, PerformanceDashboardData())
+        payload = {
+            "StartTime": StartTime,
+            "EndTime": EndTime,
+            "AgentId": AgentId,
+            "TimeUnit": TimeUnit,
+        }
+        qry = ServiceOperationQuery(self, "GetData", None, payload, None, return_type)
+        self.context.add_query(qry)
+        return return_type

office365/sharepoint/migrationcenter/service/performance/throughput_data.py

@@ -0,0 +1,9 @@
+from office365.runtime.client_value import ClientValue
+
+
+class ThroughputData(ClientValue):
+    """"""
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.MigrationCenter.Service.ThroughputData"

office365/sharepoint/migrationcenter/service/services.py

@@ -1,7 +1,29 @@
+from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.entity import Entity
+from office365.sharepoint.migrationcenter.service.performance.data import (
+    PerformanceDataCollection,
+)
 
 
 class MigrationCenterServices(Entity):
+    def __init__(self, context, resource_path=None):
+        if resource_path is None:
+            resource_path = ResourcePath(
+                "Microsoft.Online.SharePoint.MigrationCenter.Service.MigrationCenterServices"
+            )
+        super(MigrationCenterServices, self).__init__(context, resource_path)
+
+    @property
+    def performance_data(self):
+        # type: () -> PerformanceDataCollection
+        """Get root web"""
+        return self.properties.get(
+            "PerformanceData",
+            PerformanceDataCollection(
+                self.context, ResourcePath("PerformanceData", self.resource_path)
+            ),
+        )
+
     @property
     def entity_type_name(self):
         return "Microsoft.Online.SharePoint.MigrationCenter.Service.MigrationCenterServices"

office365/sharepoint/multigeo/api_versions.py

@@ -0,0 +1,28 @@
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.types.collections import StringCollection
+from office365.sharepoint.entity import Entity
+
+
+class MultiGeoApiVersions(Entity):
+    """"""
+
+    def __init__(self, context, resource_path=None):
+        if resource_path is None:
+            resource_path = ResourcePath(
+                "Microsoft.Online.SharePoint.MultiGeo.Service.MultiGeoApiVersions"
+            )
+        super(MultiGeoApiVersions, self).__init__(context, resource_path)
+
+    @property
+    def supported_versions(self):
+        return self.properties.get("SupportedVersions", StringCollection())
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.MultiGeo.Service.MultiGeoApiVersions"
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {"SupportedVersions": self.supported_versions}
+            default_value = property_mapping.get(name, None)
+        return super(MultiGeoApiVersions, self).get_property(name, default_value)

office365/sharepoint/multigeo/services.py

@@ -0,0 +1,39 @@
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.sharepoint.entity import Entity
+from office365.sharepoint.entity_collection import EntityCollection
+from office365.sharepoint.multigeo.unified_group import UnifiedGroup
+
+
+class MultiGeoServices(Entity):
+    """
+    Multi-Geo capabilities in OneDrive and SharePoint enable control of shared resources like SharePoint team sites
+    and Microsoft 365 Group mailboxes stored at rest in a specified geo location.
+
+    Each user, Group mailbox, and SharePoint site have a Preferred Data Location (PDL) which denotes the geo location
+    where related data is to be stored. Users' personal data (Exchange mailbox and OneDrive) along with any
+    Microsoft 365 Groups or SharePoint sites that they create can be stored in the specified geo location to meet
+    data residency requirements.
+    """
+
+    @property
+    def unified_groups(self):
+        # type: () -> EntityCollection[UnifiedGroup]
+        """ """
+        return self.properties.get(
+            "UnifiedGroups",
+            EntityCollection(
+                self.context,
+                UnifiedGroup,
+                ResourcePath("UnifiedGroups", self.resource_path),
+            ),
+        )
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.MultiGeo.Service.MultiGeoServicesBeta"
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {"UnifiedGroups": self.unified_groups}
+            default_value = property_mapping.get(name, None)
+        return super(MultiGeoServices, self).get_property(name, default_value)

office365/sharepoint/multigeo/tenant_information.py

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

office365/sharepoint/publishing/portal_health_details.py

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

office365/sharepoint/publishing/portal_health_status.py

@@ -1,9 +1,16 @@
 from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.sharepoint.publishing.portal_health_details import PortalHealthDetails
 
 
 class PortalHealthStatus(ClientValue):
-    def __init__(self, status=None):
+    def __init__(self, details=None, status=None):
         """
         :param int status:
         """
+        self.Details = ClientValueCollection(PortalHealthDetails, details)
         self.Status = status
+
+    @property
+    def entity_type_name(self):
+        return "SP.Publishing.PortalHealthStatus"

office365/sharepoint/search/service.py

@@ -1,3 +1,5 @@
+from typing import Any, List
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
@@ -162,6 +164,7 @@ class SearchService(Entity):
         row_limit=None,
         **kwargs
     ):
+        # type: (str, List[str], bool, int, Any) -> ClientResult[SearchResult]
         """The operation is used to retrieve search results through the use of the HTTP protocol
         with method type POST.
 
@@ -172,9 +175,7 @@ class SearchService(Entity):
         :param int row_limit: The number of search results the protocol client wants to receive, starting at the index
             specified in the StartRow element. The RowLimit value MUST be greater than or equal to zero.
         """
-        return_type = ClientResult(
-            self.context, SearchResult()
-        )  # type: ClientResult[SearchResult]
+        return_type = ClientResult(self.context, SearchResult())
         request = SearchRequest(
             query_text=query_text,
             select_properties=select_properties,
@@ -211,6 +212,7 @@ class SearchService(Entity):
         return self
 
     def search_center_url(self):
+        # type: () -> ClientResult[str]
         """The operation is used to get the URI address of the search center by using the HTTP protocol
         with the GET method. The operation returns the URI of the of the search center.
         """

office365/sharepoint/sharing/permission_collection.py

@@ -13,7 +13,12 @@ class PermissionCollection(ClientValue):
     """
 
     def __init__(
-        self, hasInheritedLinks=None, links=None, principals=None, siteAdmins=None
+        self,
+        hasInheritedLinks=None,
+        links=None,
+        principals=None,
+        siteAdmins=None,
+        totalNumberOfPrincipals=None,
     ):
         """
         :param bool hasInheritedLinks:
@@ -21,11 +26,13 @@ class PermissionCollection(ClientValue):
         :param list[PrincipalInfo] principals: The List of Principals with their roles on this list item.
         :param list[PrincipalInfo] siteAdmins: The List of Principals who are Site Admins. This property is returned
             only if the caller is an Auditor.
+        :param int totalNumberOfPrincipals:
         """
         self.hasInheritedLinks = hasInheritedLinks
         self.links = ClientValueCollection(LinkInfo, links)
         self.principals = ClientValueCollection(PrincipalInfo, principals)
         self.siteAdmins = ClientValueCollection(PrincipalInfo, siteAdmins)
+        self.totalNumberOfPrincipals = totalNumberOfPrincipals
 
     @property
     def entity_type_name(self):

office365/sharepoint/sharing/shared_document_info.py

@@ -1,5 +1,6 @@
 from typing import Optional
 
+from office365.sharepoint.contenttypes.content_type_id import ContentTypeId
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.sharing.principal import Principal
 
@@ -24,6 +25,24 @@ class SharedDocumentInfo(Entity):
         """"""
         return self.properties.get("CallerStack", None)
 
+    @property
+    def color_hex(self):
+        # type: () -> Optional[str]
+        """"""
+        return self.properties.get("ColorHex", None)
+
+    @property
+    def color_tag(self):
+        # type: () -> Optional[str]
+        """"""
+        return self.properties.get("ColorTag", None)
+
+    @property
+    def content_type_id(self):
+        # type: () -> Optional[str]
+        """"""
+        return self.properties.get("ContentTypeId", ContentTypeId())
+
     @property
     def entity_type_name(self):
         return "SP.Sharing.SharedDocumentInfo"

office365/sharepoint/sitehealth/summary.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.sitehealth.result import SiteHealthResult
@@ -6,6 +8,24 @@ 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."""
 
+    @property
+    def failed_error_count(self):
+        # type: () -> Optional[int]
+        """Specifies the number of site collection health 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."""
+        return self.properties.get("FailedWarningCount", None)
+
+    @property
+    def passed_count(self):
+        # type: () -> Optional[int]
+        """Specifies the number of site collection health 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

office365/sharepoint/sites/site.py

@@ -88,6 +88,18 @@ class Site(Entity):
         self.ensure_properties(["Url", "GroupId", "Id"], _site_resolved)
         return self
 
+    def check_is_deletable(self):
+        """Check Site Is Deletable"""
+        return_type = ClientResult(self.context, bool())
+
+        def _check_is_deletable():
+            SPPolicyStoreProxy.check_site_is_deletable_by_id(
+                self.context, self.id, return_type
+            )
+
+        self.ensure_property("Id", _check_is_deletable)
+        return return_type
+
     def extend_upgrade_reminder_date(self):
         """
         Extend the upgrade reminder date for this site collection, so that site collection administrators will

office365/sharepoint/tenant/administration/container_properties.py

@@ -0,0 +1,17 @@
+from office365.runtime.client_value import ClientValue
+
+
+class SPContainerProperties(ClientValue):
+    """"""
+
+    def __init__(self, AllowEditing=None, AuthenticationContextName=None):
+        """
+        :param bool AllowEditing:
+        :param str AuthenticationContextName:
+        """
+        self.AllowEditing = AllowEditing
+        self.AuthenticationContextName = AuthenticationContextName
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantAdministration.SPContainerProperties"

office365/sharepoint/tenant/administration/group.py

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