Office365-REST-Python-Client 2.5.7__py3-none-any.whl → 2.5.9__py3-none-any.whl

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/folders/folder.py

@@ -571,8 +571,8 @@ class Folder(Entity):
 
     @property
     def property_ref_name(self):
-        # type: () -> str
-        return "ServerRelativeUrl"
+        # type: () -> Optional[str]
+        return None
 
     def get_property(self, name, default_value=None):
         if default_value is None:

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

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

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

@@ -0,0 +1,9 @@
+from office365.sharepoint.multigeo.move_job_entity_data import MoveJobEntityData
+
+
+class SiteMoveJobEntityData(MoveJobEntityData):
+    """"""
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.MultiGeo.Service.SiteMoveJobEntityData"

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/multigeo/user_personal_site_location.py

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

office365/sharepoint/permissions/securable_object.py

@@ -162,6 +162,7 @@ class SecurableObject(Entity):
 
     @property
     def first_unique_ancestor_securable_object(self):
+        # type: () -> SecurableObject
         """Specifies the object where role assignments for this object are defined"""
         return self.properties.get(
             "FirstUniqueAncestorSecurableObject",
@@ -173,6 +174,7 @@ class SecurableObject(Entity):
 
     @property
     def role_assignments(self):
+        # type: () -> RoleAssignmentCollection
         """The role assignments for the securable object."""
         return self.properties.get(
             "RoleAssignments",

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/sharing/object_sharing_information.py

@@ -241,6 +241,7 @@ class ObjectSharingInformation(Entity):
 
     @property
     def sharing_links(self):
+        # type: () -> ClientValueCollection[SharingLinkInfo]
         """Indicates the collection of all available sharing links for the securable object."""
         return self.properties.get(
             "SharingLinks", ClientValueCollection(SharingLinkInfo)
@@ -248,6 +249,7 @@ class ObjectSharingInformation(Entity):
 
     @property
     def shared_with_users_collection(self):
+        # type: () -> EntityCollection[ObjectSharingInformationUser]
         """A collection of shared with users."""
         return self.properties.get(
             "SharedWithUsersCollection",

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,3 +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
 
@@ -7,6 +10,7 @@ class SharedDocumentInfo(Entity):
 
     @property
     def activity(self):
+        # type: () -> Optional[str]
         """"""
         return self.properties.get("Activity", None)
 
@@ -15,6 +19,30 @@ class SharedDocumentInfo(Entity):
         """"""
         return self.properties.get("Author", Principal())
 
+    @property
+    def caller_stack(self):
+        # type: () -> Optional[str]
+        """"""
+        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/sites/version_policy_manager.py

@@ -1,5 +1,12 @@
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
 
 class SiteVersionPolicyManager(Entity):
     """"""
+
+    def set_auto_expiration(self):
+        """"""
+        qry = ServiceOperationQuery(self, "SetAutoExpiration")
+        self.context.add_query(qry)
+        return self

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"

office365/sharepoint/tenant/administration/powerapps/environment.py

@@ -0,0 +1,31 @@
+from office365.runtime.client_value import ClientValue
+
+
+class PowerAppsEnvironment(ClientValue):
+    """ """
+
+    def __init__(
+        self,
+        AllocatedAICredits=None,
+        DisplayName=None,
+        IsDefault=None,
+        Name=None,
+        PurchasedAICredits=None,
+    ):
+        # type: (float, str, bool, str, float) -> None
+        self.AllocatedAICredits = AllocatedAICredits
+        self.DisplayName = DisplayName
+        self.IsDefault = IsDefault
+        self.Name = Name
+        self.PurchasedAICredits = PurchasedAICredits
+
+    def __str__(self):
+        return self.DisplayName or self.entity_type_name
+
+    def __repr__(self):
+        return self.Name or self.entity_type_name
+
+    @property
+    def entity_type_name(self):
+        # type: () -> str
+        return "Microsoft.Online.SharePoint.TenantAdministration.PowerAppsEnvironment"

office365/sharepoint/tenant/administration/recent_admin_action_report.py

@@ -0,0 +1,14 @@
+from office365.runtime.client_value import ClientValue
+
+
+class RecentAdminActionReport(ClientValue):
+    """ """
+
+    def __init__(self, actions=None, createdByEmail=None):
+        # type: (str, str) -> None
+        self.actions = actions
+        self.createdByEmail = createdByEmail
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Administration.TenantAdmin.RecentAdminActionReport"

office365/sharepoint/tenant/administration/recent_admin_action_report_payload.py

@@ -0,0 +1,10 @@
+from office365.runtime.client_value import ClientValue
+
+
+class RecentAdminActionReportPayload(ClientValue):
+    """ """
+
+    @property
+    def entity_type_name(self):
+        # type: () -> str
+        return "Microsoft.Online.SharePoint.TenantAdministration.RecentAdminActionReportPayload"

office365/sharepoint/tenant/administration/secondary_administrators_info.py

@@ -13,3 +13,8 @@ class SecondaryAdministratorsInfo(ClientValue):
         self.email = email
         self.loginName = loginName
         self.userPrincipalName = userPrincipalName
+
+    @property
+    def entity_type_name(self):
+        # type: () -> str
+        return "Microsoft.Online.SharePoint.TenantAdministration.SecondaryAdministratorsInfo"

office365/sharepoint/tenant/administration/siteinfo_for_site_picker.py

@@ -2,8 +2,12 @@ from office365.runtime.client_value import ClientValue
 
 
 class SiteInfoForSitePicker(ClientValue):
-    def __init__(self, site_name=None):
+    def __init__(self, Error=None, site_id=None, site_name=None, Url=None):
+        # type: (str, str, str, str) -> None
+        self.Error = Error
+        self.SiteId = site_id
         self.SiteName = site_name
+        self.Url = Url
 
     @property
     def entity_type_name(self):

office365/sharepoint/tenant/administration/sites/creation_default_storage_quota.py

@@ -2,6 +2,11 @@ from office365.runtime.client_value import ClientValue
 
 
 class SiteCreationDefaultStorageQuota(ClientValue):
+    def __init__(self, IsReadOnly=None, Value=None):
+        # type: (bool, int) -> None
+        self.IsReadOnly = IsReadOnly
+        self.Value = Value
+
     @property
     def entity_type_name(self):
         return "Microsoft.Online.SharePoint.TenantAdministration.SiteCreationDefaultStorageQuota"

office365/sharepoint/tenant/administration/sites/creation_source.py

@@ -1,3 +1,6 @@
+from datetime import datetime
+from typing import List
+
 from office365.runtime.client_value import ClientValue
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.sharepoint.tenant.administration.sites.creation_data import (
@@ -6,10 +9,22 @@ from office365.sharepoint.tenant.administration.sites.creation_data import (
 
 
 class SiteCreationSource(ClientValue):
-    def __init__(self, site_creation_data=None):
+    def __init__(
+        self,
+        IsSyncThresholdLimitReached=None,
+        LastRefreshTimeStamp=None,
+        site_creation_data=None,
+        SyncThresholdLimit=None,
+        TotalSitesCount=None,
+    ):
+        # type: (bool, datetime, List[SiteCreationData], int, int) -> None
+        self.IsSyncThresholdLimitReached = IsSyncThresholdLimitReached
+        self.LastRefreshTimeStamp = LastRefreshTimeStamp
         self.SiteCreationData = ClientValueCollection(
             SiteCreationData, site_creation_data
         )
+        self.SyncThresholdLimit = SyncThresholdLimit
+        self.TotalSitesCount = TotalSitesCount
 
     @property
     def entity_type_name(self):

office365/sharepoint/tenant/administration/sites/properties_collection.py

@@ -37,6 +37,8 @@ class SitePropertiesCollection(EntityCollection[SiteProperties]):
 
     def get_site_state_properties(self, site_id):
         """
+        Gets site state properties.
+
         :param str site_id: Site identifier
         """
         return_type = ClientResult(self.context, SiteStateProperties())

office365/sharepoint/tenant/administration/sites/state_properties.py

@@ -2,6 +2,20 @@ from office365.runtime.client_value import ClientValue
 
 
 class SiteStateProperties(ClientValue):
+    def __init__(
+        self,
+        GroupSiteRelationship=None,
+        IsArchived=None,
+        IsSiteOnHold=None,
+        LockState=None,
+    ):
+        # type: (int, bool, bool, int) -> None
+        super(SiteStateProperties, self).__init__()
+        self.GroupSiteRelationship = GroupSiteRelationship
+        self.IsArchived = IsArchived
+        self.IsSiteOnHold = IsSiteOnHold
+        self.LockState = LockState
+
     @property
     def entity_type_name(self):
         return "Microsoft.Online.SharePoint.TenantAdministration.SiteStateProperties"