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

office365/sharepoint/fields/user_value.py

@@ -9,7 +9,7 @@ class FieldUserValue(FieldLookupValue):
 
     @staticmethod
     def from_user(user):
-        # type: (User) -> FieldUserValue
+        # type: (User) -> "FieldUserValue"
         """
         Initialize field value from User
         :param User user: User object

office365/sharepoint/folders/folder.py

@@ -554,9 +554,7 @@ class Folder(Entity):
     @property
     def time_created(self):
         # type: () -> Optional[datetime]
-        """
-        Gets when the folder was created in UTC.
-        """
+        """Gets when the folder was created in UTC."""
         return self.properties.get("TimeCreated", datetime.min)
 
     @property
@@ -573,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/deploy_status.py

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

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

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

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

@@ -0,0 +1,7 @@
+from office365.sharepoint.migrationcenter.service.performance.entity_data import (
+    MigrationPerformanceEntityData,
+)
+
+
+class PerformanceData(MigrationPerformanceEntityData):
+    """"""

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

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

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

@@ -8,7 +8,7 @@ class Principal(Entity):
     """Represents a user or group that can be assigned permissions to control security."""
 
     def __str__(self):
-        return self.title
+        return self.title or self.entity_type_name
 
     def __repr__(self):
         return self.user_principal_name or self.id or self.entity_type_name
@@ -28,9 +28,7 @@ class Principal(Entity):
     @title.setter
     def title(self, value):
         # type: (str) -> None
-        """
-        Sets a value that specifies the name of the principal.
-        """
+        """Sets a value that specifies the name of the principal."""
         self.set_property("Title", value)
 
     @property

office365/sharepoint/recyclebin/item.py

@@ -1,16 +1,22 @@
-from typing import Optional
+from datetime import datetime
+from typing import TYPE_CHECKING, Optional
 
 from office365.runtime.paths.resource_path import ResourcePath
-from office365.runtime.paths.service_operation import ServiceOperationPath
-from office365.runtime.paths.v3.entity import EntityPath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.principal.users.user import User
+from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
+
+if TYPE_CHECKING:
+    from office365.sharepoint.recyclebin.item_collection import RecycleBinItemCollection
 
 
 class RecycleBinItem(Entity):
     """Represents a Recycle Bin item in the Recycle Bin of a site or a site collection."""
 
+    def __str__(self):
+        return self.title or self.entity_type_name
+
     def restore(self):
         """Restores the Recycle Bin item to its original location."""
         qry = ServiceOperationQuery(self, "Restore")
@@ -26,17 +32,95 @@ class RecycleBinItem(Entity):
         self.context.add_query(qry)
         return self
 
+    @property
+    def author_email(self):
+        # type: () -> Optional[str]
+        """Gets the email address of the user who originally created the Recycle Bin item."""
+        return self.properties.get("AuthorEmail", None)
+
+    @property
+    def author_name(self):
+        # type: () -> Optional[str]
+        """Gets the user display name of the user who originally created the Recycle Bin item."""
+        return self.properties.get("AuthorName", None)
+
+    @property
+    def deleted_by_email(self):
+        # type: () -> Optional[str]
+        """Gets the email address of the user who deleted the Recycle Bin item."""
+        return self.properties.get("DeletedByEmail", None)
+
+    @property
+    def deleted_by_name(self):
+        # type: () -> Optional[str]
+        """Gets the user display name of the user who deleted the Recycle Bin item."""
+        return self.properties.get("DeletedByName", None)
+
+    @property
+    def deleted_date_local_formatted(self):
+        # type: () -> Optional[str]
+        """
+        Specifies when, in the default time zone for the current site,
+        the Recycle Bin item was moved to the Recycle Bin.
+        """
+        return self.properties.get("DeletedDateLocalFormatted", None)
+
+    @property
+    def dir_name(self):
+        # type: () -> Optional[str]
+        """
+        Specifies the site-relative URL of the list or folder that originally contained the Recycle Bin item.
+        """
+        return self.properties.get("DirName", None)
+
+    @property
+    def dir_name_path(self):
+        # type: () -> Optional[SPResPath]
+        """Returns the site relative path of the list or folder that originally contained the Recycle Bin item."""
+        return self.properties.get("DirNamePath", SPResPath())
+
+    @property
+    def item_state(self):
+        # type: () -> Optional[int]
+        """Specifies the Recycle Bin stage of the Recycle Bin item."""
+        return self.properties.get("ItemState", None)
+
+    @property
+    def item_type(self):
+        # type: () -> Optional[int]
+        """Specifies the type of the Recycle Bin item."""
+        return self.properties.get("ItemType", None)
+
     @property
     def id(self):
+        # type: () -> Optional[str]
         """Gets a value that specifies the identifier of the Recycle Bin item."""
         return self.properties.get("Id", None)
 
+    @property
+    def leaf_name(self):
+        # type: () -> Optional[str]
+        """Specifies the leaf name of the Recycle Bin item."""
+        return self.properties.get("LeafName", None)
+
+    @property
+    def leaf_name_path(self):
+        # type: () -> Optional[SPResPath]
+        """Returns the leaf name path of the Recycle Bin item."""
+        return self.properties.get("LeafNamePath", SPResPath())
+
     @property
     def size(self):
         # type: () -> Optional[int]
         """Gets a value that specifies the size of the Recycle Bin item in bytes."""
         return self.properties.get("Size", None)
 
+    @property
+    def title(self):
+        # type: () -> Optional[str]
+        """Specifies the title of the Recycle Bin item."""
+        return self.properties.get("Title", None)
+
     @property
     def author(self):
         """Gets a value that specifies the user who created the Recycle Bin item."""
@@ -55,7 +139,23 @@ class RecycleBinItem(Entity):
     @property
     def deleted_date(self):
         """Gets a value that specifies when the Recycle Bin item was moved to the Recycle Bin."""
-        return self.properties.get("DeletedDate", None)
+        return self.properties.get("DeletedDate", datetime.min)
+
+    @property
+    def parent_collection(self):
+        # type: () -> RecycleBinItemCollection
+        return self._parent_collection
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "DeletedBy": self.deleted_by,
+                "DeletedDate": self.deleted_date,
+                "DirNamePath": self.dir_name_path,
+                "LeafNamePath": self.leaf_name_path,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(RecycleBinItem, self).get_property(name, default_value)
 
     def set_property(self, name, value, persist_changes=True):
         super(RecycleBinItem, self).set_property(name, value, persist_changes)
@@ -63,8 +163,8 @@ class RecycleBinItem(Entity):
 
         if name == "Id":
             if self._resource_path is None:
-                self._resource_path = ServiceOperationPath(
-                    "GetById", [value], self._parent_collection.resource_path
-                )
+                self._resource_path = self.parent_collection.get_by_id(
+                    value
+                ).resource_path
             else:
                 self._resource_path.patch(value)

office365/sharepoint/sharing/information.py

@@ -5,6 +5,7 @@ from office365.sharepoint.sharing.access_request_settings import AccessRequestSe
 from office365.sharepoint.sharing.links.default_templates_collection import (
     SharingLinkDefaultTemplatesCollection,
 )
+from office365.sharepoint.sharing.permission_collection import PermissionCollection
 from office365.sharepoint.sharing.picker_settings import PickerSettings
 
 
@@ -21,6 +22,13 @@ class SharingInformation(Entity):
         """
         return self.properties.get("accessRequestSettings", AccessRequestSettings())
 
+    @property
+    def permissions_information(self):
+        """
+        The PermissionCollection that are on the list item. It contains a collection of PrincipalInfo and LinkInfo.
+        """
+        return self.properties.get("permissionsInformation", PermissionCollection())
+
     @property
     def picker_settings(self):
         """PickerSettings used by the PeoplePicker Control."""
@@ -49,6 +57,7 @@ class SharingInformation(Entity):
         if default_value is None:
             property_mapping = {
                 "accessRequestSettings": self.access_request_settings,
+                "permissionsInformation": self.permissions_information,
                 "pickerSettings": self.picker_settings,
                 "sharingAbilities": self.sharing_abilities,
                 "sharingLinkTemplates": self.sharing_link_templates,

office365/sharepoint/sharing/link_info.py

@@ -0,0 +1,6 @@
+from office365.runtime.client_value import ClientValue
+
+
+class LinkInfo(ClientValue):
+    """This class provides metadata for the tokenized sharing link including settings details, inheritance status,
+    and an optional array of members."""

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

@@ -1,4 +1,7 @@
 from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.sharepoint.sharing.link_info import LinkInfo
+from office365.sharepoint.utilities.principal_info import PrincipalInfo
 
 
 class PermissionCollection(ClientValue):
@@ -9,6 +12,21 @@ class PermissionCollection(ClientValue):
     implicit access.
     """
 
+    def __init__(
+        self, hasInheritedLinks=None, links=None, principals=None, siteAdmins=None
+    ):
+        """
+        :param bool hasInheritedLinks:
+        :param list[LinkInfo] links: The List of tokenized sharing links with their LinkInfo objects.
+        :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.
+        """
+        self.hasInheritedLinks = hasInheritedLinks
+        self.links = ClientValueCollection(LinkInfo, links)
+        self.principals = ClientValueCollection(PrincipalInfo, principals)
+        self.siteAdmins = ClientValueCollection(PrincipalInfo, siteAdmins)
+
     @property
     def entity_type_name(self):
         return "SP.Sharing.PermissionCollection"

office365/sharepoint/sharing/shared_document_info.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.sharing.principal import Principal
 
@@ -7,6 +9,7 @@ class SharedDocumentInfo(Entity):
 
     @property
     def activity(self):
+        # type: () -> Optional[str]
         """"""
         return self.properties.get("Activity", None)
 
@@ -15,6 +18,12 @@ 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 entity_type_name(self):
         return "SP.Sharing.SharedDocumentInfo"

office365/sharepoint/sites/script_safe_domain.py

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

office365/sharepoint/sites/site.py

@@ -219,7 +219,9 @@ class Site(Entity):
             specified in the orderBy parameter. A value of true indicates ascending order, and a value of false
             indicates descending order.
         """
-        return_type = RecycleBinItemCollection(self.context)
+        return_type = RecycleBinItemCollection(
+            self.context, self.recycle_bin.resource_path
+        )
         payload = {"rowLimit": row_limit, "isAscending": is_ascending}
         qry = ServiceOperationQuery(
             self, "GetRecycleBinItems", None, payload, None, return_type
@@ -228,9 +230,7 @@ class Site(Entity):
         return return_type
 
     def get_site_administrators(self):
-        """
-        Gets site collection administrators
-        """
+        """Gets site collection administrators"""
         return_type = ClientResult(
             self.context, ClientValueCollection(SiteAdministratorsInfo)
         )
@@ -521,6 +521,12 @@ class Site(Entity):
         """
         return self.properties.get("CanUpgrade", None)
 
+    @property
+    def channel_group_id(self):
+        # type: () -> Optional[str]
+        """ """
+        return self.properties.get("ChannelGroupId", None)
+
     @property
     def classification(self):
         # type: () -> Optional[str]

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/taxonomy/field_value.py

@@ -25,7 +25,7 @@ class TaxonomyFieldValue(ClientValue):
         return "SP.Taxonomy.TaxonomyFieldValue"
 
 
-class TaxonomyFieldValueCollection(ClientValueCollection):
+class TaxonomyFieldValueCollection(ClientValueCollection[TaxonomyFieldValue]):
     """Represents the multi-value object for the taxonomy column."""
 
     def __init__(self, initial_values):

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

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

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

@@ -587,6 +587,14 @@ class Tenant(Entity):
         self.context.add_query(qry)
         return return_type
 
+    @property
+    def admin_settings(self):
+        from office365.sharepoint.tenant.administration.settings_service import (
+            TenantAdminSettingsService,
+        )
+
+        return TenantAdminSettingsService(self.context)
+
     @property
     def ai_builder_enabled(self):
         # type: () -> Optional[str]
@@ -656,6 +664,12 @@ class Tenant(Entity):
             ),
         )
 
+    @property
+    def cdn_api(self):
+        from office365.sharepoint.tenant.cdn_api import TenantCdnApi
+
+        return TenantCdnApi(self.context)
+
     @property
     def syntex_billing_subscription_settings(self):
         """"""

office365/sharepoint/tenant/cdn_api.py

@@ -1,5 +1,9 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.client_value_collection import ClientValueCollection
 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.tenant.cdn_url import TenantCdnUrl
 
 
 class TenantCdnApi(Entity):
@@ -8,6 +12,18 @@ class TenantCdnApi(Entity):
             context, ResourcePath("Microsoft.SharePoint.TenantCdn.TenantCdnApi")
         )
 
+    def get_cdn_urls(self, items=None):
+        """"""
+        payload = {
+            "items": items,
+        }
+        return_type = ClientResult(self.context, ClientValueCollection(TenantCdnUrl))
+        qry = ServiceOperationQuery(
+            self, "GetCdnUrls", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.TenantCdn.TenantCdnApi"

office365/sharepoint/tenant/management/externalusers/results/get.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.tenant.management.externalusers.collection import (
@@ -8,10 +10,12 @@ from office365.sharepoint.tenant.management.externalusers.collection import (
 class GetExternalUsersResults(Entity):
     @property
     def total_user_count(self):
+        # type: () -> Optional[int]
         return self.properties.get("TotalUserCount", None)
 
     @property
     def user_collection_position(self):
+        # type: () -> Optional[int]
         return self.properties.get("UserCollectionPosition", None)
 
     @property

office365/sharepoint/tenant/management/office365_tenant.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.client_object_collection import ClientObjectCollection
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
@@ -29,8 +31,19 @@ class Office365Tenant(Entity):
         )
         super(Office365Tenant, self).__init__(context, static_path)
 
+    @property
+    def addressbar_link_permission(self):
+        # type: () -> Optional[int]
+        return self.properties.get("AddressbarLinkPermission", None)
+
+    @property
+    def allow_comments_text_on_email_enabled(self):
+        # type: () -> Optional[bool]
+        return self.properties.get("AllowCommentsTextOnEmailEnabled", None)
+
     @property
     def allow_editing(self):
+        # type: () -> Optional[bool]
         return self.properties.get("AllowEditing", None)
 
     @property
@@ -62,6 +75,7 @@ class Office365Tenant(Entity):
 
     def disable_sharing_for_non_owners_of_site(self, site_url):
         """
+        Disables Sharing For Non Owners
         :param str site_url:
         """
         payload = {"siteUrl": site_url}