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

office365/runtime/odata/request.py

@@ -25,7 +25,7 @@ class ODataRequest(ClientRequest):
         """Creates OData request"""
         super(ODataRequest, self).__init__()
         self._default_json_format = json_format
-        self.beforeExecute += self._ensure_json_format
+        self.beforeExecute += self._ensure_http_headers
 
     @property
     def json_format(self):
@@ -111,6 +111,8 @@ class ODataRequest(ClientRequest):
                                 k: v for k, v in self._next_property(value, json_format)
                             }
                         yield name, value
+                    elif name == "@odata.etag":
+                        yield "__etag", value
             else:
                 yield "__value", json
         elif json is not None:
@@ -142,8 +144,16 @@ class ODataRequest(ClientRequest):
             json = {query.parameters_name: json}
         return json
 
-    def _ensure_json_format(self, request):
+    def _ensure_http_headers(self, request):
         # type: (RequestOptions) -> None
+        """
+        Ensures that HTTP Header Fields are specified in the OData request, namely:
+           - The Content-Type header
+           - Accept request-header field
+           - The If-Match request-header field (optional)
+        """
         media_type = self.json_format.media_type
         request.ensure_header("Content-Type", media_type)
         request.ensure_header("Accept", media_type)
+        if self.json_format.etag is not None:
+            request.ensure_header("If-Match", self.json_format.etag)

office365/runtime/queries/upload_session.py

@@ -4,6 +4,11 @@ from office365.runtime.queries.service_operation import ServiceOperationQuery
 
 
 class UploadSessionQuery(ServiceOperationQuery):
+    """
+    The UploadSession query provides information about how to upload large files to OneDrive, OneDrive for
+    Business, or SharePoint document libraries
+    """
+
     def __init__(self, binding_type, parameters_type):
         super(UploadSessionQuery, self).__init__(
             binding_type, "createUploadSession", None, parameters_type

office365/sharepoint/alerts/collection.py

@@ -5,7 +5,7 @@ from office365.sharepoint.alerts.alert import Alert
 from office365.sharepoint.entity_collection import EntityCollection
 
 
-class AlertCollection(EntityCollection):
+class AlertCollection(EntityCollection[Alert]):
     """Content Type resource collection"""
 
     def __init__(self, context, resource_path=None):
@@ -26,6 +26,7 @@ class AlertCollection(EntityCollection):
         return return_type
 
     def contains(self, id_alert):
+        # type: (str) -> ClientResult[bool]
         """
         Returns true if the given alert exists in the alert collection. False otherwise.
 

office365/sharepoint/attachments/attachment.py

@@ -76,16 +76,12 @@ class Attachment(Entity):
     @property
     def file_name(self):
         # type: () -> Optional[str]
-        """
-        Specifies the file name of the list item attachment.
-        """
+        """Specifies the file name of the list item attachment."""
         return self.properties.get("FileName", None)
 
     @property
     def file_name_as_path(self):
-        """
-        The file name of the attachment as a SP.ResourcePath.
-        """
+        """The file name of the attachment as a SP.ResourcePath."""
         return self.properties.get("FileNameAsPath", SPResPath())
 
     @property
@@ -96,9 +92,7 @@ class Attachment(Entity):
 
     @property
     def server_relative_path(self):
-        """
-        The server-relative-path of the attachment.
-        """
+        """The server-relative-path of the attachment."""
         return self.properties.get("ServerRelativePath", SPResPath())
 
     @property

office365/sharepoint/client_context.py

@@ -82,8 +82,9 @@ class ClientContext(ClientRuntimeContext):
         cert_path=None,
         private_key=None,
         scopes=None,
+        passphrase=None,
     ):
-        # type: (str, str, str, Optional[str], Optional[str], Optional[List[str]]) -> Self
+        # type: (str, str, str, Optional[str], Optional[str], Optional[List[str]], Optional[str]) -> Self
         """
         Creates authenticated SharePoint context via certificate credentials
 
@@ -93,9 +94,10 @@ class ClientContext(ClientRuntimeContext):
         :param str thumbprint: Hex encoded thumbprint of the certificate.
         :param str client_id: The OAuth client id of the calling application.
         :param list[str] or None scopes:  Scopes requested to access a protected API (a resource)
+        :param str passphrase: Passphrase if the private_key is encrypted
         """
         self.authentication_context.with_client_certificate(
-            tenant, client_id, thumbprint, cert_path, private_key, scopes
+            tenant, client_id, thumbprint, cert_path, private_key, scopes, passphrase
         )
         return self
 

office365/sharepoint/contenttypes/content_type.py

@@ -20,7 +20,7 @@ class ContentType(Entity):
     """
 
     def __str__(self):
-        return self.name
+        return self.name or self.entity_type_name
 
     def __repr__(self):
         return self.string_id or str(self.id) or self.entity_type_name
@@ -111,6 +111,12 @@ class ContentType(Entity):
         """
         return self.properties.get("Id", ContentTypeId())
 
+    @property
+    def scope(self):
+        # type: () -> Optional[str]
+        """Specifies a server-relative path to the content type scope of the content type."""
+        return self.properties.get("Scope", None)
+
     @property
     def sealed(self):
         # type: () -> Optional[bool]
@@ -142,6 +148,12 @@ class ContentType(Entity):
         item forms"""
         return self.properties.get("NewFormClientSideComponentProperties", None)
 
+    @property
+    def new_form_url(self):
+        # type: () -> Optional[str]
+        """Specifies the URL of a custom new form to use for list items that have been assigned the content type."""
+        return self.properties.get("NewFormUrl", None)
+
     @property
     def description(self):
         # type: () -> Optional[str]

office365/sharepoint/contenttypes/fieldlinks/collection.py

@@ -7,7 +7,7 @@ from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.fields.field import Field
 
 
-class FieldLinkCollection(EntityCollection):
+class FieldLinkCollection(EntityCollection[FieldLink]):
     """Specifies a Collection for field links."""
 
     def __init__(self, context, resource_path=None):

office365/sharepoint/directory/helper.py

@@ -1,6 +1,7 @@
 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.client_context import ClientContext
 from office365.sharepoint.directory.members_info import MembersInfo
 from office365.sharepoint.directory.membership_result import MembershipResult
 from office365.sharepoint.directory.my_groups_result import MyGroupsResult
@@ -32,6 +33,7 @@ class SPHelper(Entity):
 
     @staticmethod
     def check_site_availability(context, site_url):
+        # type: (ClientContext, str) -> ClientResult[bool]
         """
         :param str site_url: Site Url
         :param office365.sharepoint.client_context.ClientContext context: SharePoint context

office365/sharepoint/fields/collection.py

@@ -13,6 +13,7 @@ from office365.sharepoint.fields.number import FieldNumber
 from office365.sharepoint.fields.text import FieldText
 from office365.sharepoint.fields.type import FieldType
 from office365.sharepoint.fields.url import FieldUrl
+from office365.sharepoint.fields.user import FieldUser
 from office365.sharepoint.fields.xmlSchemaFieldCreationInformation import (
     XmlSchemaFieldCreationInformation,
 )
@@ -123,13 +124,12 @@ class FieldCollection(EntityCollection[Field]):
         :param str title: Specifies the display name of the field.
         """
         from office365.sharepoint.fields.lookup import FieldLookup
+        from office365.sharepoint.lists.list import List  # noqa
 
         return_type = FieldLookup(self.context)
 
         def _add_lookup_field(lookup_list_id):
-            """
-            :type lookup_list_id: str
-            """
+            # type: (str) -> None
             if allow_multiple_values:
                 field_schema = """
                         <Field Type="LookupMulti" Mult="TRUE" DisplayName="{title}" Required="FALSE" Hidden="TRUE" \
@@ -176,6 +176,7 @@ class FieldCollection(EntityCollection[Field]):
         return self.add_field(create_field_info)
 
     def add_user_field(self, title):
+        # type: (str) -> FieldUser
         """
         Creates a User field
 

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

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/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/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/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/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/webs/information_collection.py

@@ -3,7 +3,7 @@ from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.webs.information import WebInformation
 
 
-class WebInformationCollection(EntityCollection):
+class WebInformationCollection(EntityCollection[WebInformation]):
     """Specifies a collection of objects containing metadata about a site"""
 
     def __init__(self, context, resource_path=None):