Office365-REST-Python-Client 2.5.1__py3-none-any.whl → 2.5.3__py3-none-any.whl

office365/sharepoint/changes/type.py

@@ -4,78 +4,78 @@ class ChangeType:
     def __init__(self):
         pass
 
-    NoChange = "NoChange"
+    NoChange = 0
     """Indicates that no change has taken place."""
 
-    Add = "Add"
+    Add = 1
     """Specifies that an object has been added within the scope of a list, site, site collection, or content database"""
 
-    Update = "Update"
+    Update = 2
     """Specifies that an object has been modified within the scope of a list, site, site collection,
     or content database."""
 
-    DeleteObject = "DeleteObject"
+    DeleteObject = 3
     """
     Specifies that an object has been deleted within the scope of a list, site, site collection, or content database
     """
 
-    Rename = "Rename"
+    Rename = 4
     """The leaf in a URL has been renamed."""
 
-    MoveAway = "MoveAway"
+    MoveAway = 5
     """Specifies that a non-leaf segment within a URL has been renamed. The object was moved away from the
     location within the site specified by the change."""
 
-    MoveInto = "MoveInto"
+    MoveInto = 6
     """Specifies that a non-leaf segment within a URL has been renamed. The object was moved into the location within
     the site specified by the change."""
 
-    Restore = "Restore"
+    Restore = 7
     """Specifies that an object (1) has restored from a backup or from the Recycle Bin"""
 
-    RoleAdd = "RoleAdd"
+    RoleAdd = 8
     """Specifies that a role definition has been added."""
 
-    RoleDelete = "RoleDelete"
+    RoleDelete = 9
     """Specifies that a role definition has been deleted."""
 
-    RoleUpdate = "RoleUpdate"
+    RoleUpdate = 10
     """Specifies that a role definition has been updated."""
 
-    AssignmentAdd = "AssignmentAdd"
+    AssignmentAdd = 11
     """Specifies that a user has been given permissions to a list. The list MUST have different permissions from
     its parent."""
 
-    AssignmentDelete = "AssignmentDelete"
+    AssignmentDelete = 12
     """Specifies that a user has lost permissions to a list. The list MUST have different permissions from its parent"""
 
-    MemberAdd = "MemberAdd"
+    MemberAdd = 13
     """Specifies that a user has been added to a group."""
 
-    MemberDelete = "MemberDelete"
+    MemberDelete = 14
     """Specifies that a user has been removed from a group."""
 
-    SystemUpdate = "SystemUpdate"
+    SystemUpdate = 15
     """Specifies that a change has been made to an item by using the protocol server method."""
 
-    Navigation = "Navigation"
+    Navigation = 16
     """Specifies that a change in the navigation structure of a site collection has been made."""
 
-    ScopeAdd = "ScopeAdd"
+    ScopeAdd = 17
     """Specifies that a change in permissions scope has been made to break inheritance from the parent of an object """
 
-    ScopeDelete = "ScopeDelete"
+    ScopeDelete = 18
     """Specifies that a change in permissions scope has been made to revert back to inheriting permissions from
     the parent of an object"""
 
-    ListContentTypeAdd = "ListContentTypeAdd"
+    ListContentTypeAdd = 19
     """Specifies that a list content type has been added."""
 
-    ListContentTypeDelete = "ListContentTypeDelete"
+    ListContentTypeDelete = 20
     """Specifies that a list content type has been deleted."""
 
-    Dirty = "Dirty"
+    Dirty = 21
     """Specifies that this item has a pending modification due to an operation on another item."""
 
-    Activity = "Activity"
+    Activity = 22
     """Specifies that an activity change as specified in section 3.2.5.462 has been made to the object """

office365/sharepoint/changes/web.py

@@ -1,14 +1,18 @@
+from typing import Optional
+
 from office365.sharepoint.changes.change import Change
 
 
 class ChangeWeb(Change):
     """Specifies a change on a site"""
 
+    def __repr__(self):
+        return "Web: {0}, Action: {1}".format(self.web_id, self.change_type_name)
+
     @property
     def web_id(self):
+        # type: () -> Optional[str]
         """
-        Identifies the site (2) that has changed
-
-        :rtype: str or None
+        Identifies the site that has changed
         """
         return self.properties.get("WebId", None)

office365/sharepoint/client_context.py

@@ -8,6 +8,7 @@ from office365.runtime.auth.authentication_context import AuthenticationContext
 from office365.runtime.auth.client_credential import ClientCredential
 from office365.runtime.auth.token_response import TokenResponse
 from office365.runtime.auth.user_credential import UserCredential
+from office365.runtime.client_result import ClientResult
 from office365.runtime.client_runtime_context import ClientRuntimeContext
 from office365.runtime.compat import get_absolute_url, urlparse
 from office365.runtime.http.http_method import HttpMethod
@@ -19,8 +20,14 @@ from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.delete_entity import DeleteEntityQuery
 from office365.runtime.queries.update_entity import UpdateEntityQuery
 from office365.runtime.types.event_handler import EventHandler
+from office365.sharepoint.portal.groups.site_info import GroupSiteInfo
+from office365.sharepoint.portal.sites.creation_response import SPSiteCreationResponse
 from office365.sharepoint.portal.sites.status import SiteStatus
+from office365.sharepoint.principal.users.user import User
 from office365.sharepoint.publishing.pages.service import SitePageService
+from office365.sharepoint.publishing.sites.communication.creation_response import (
+    CommunicationSiteCreationResponse,
+)
 from office365.sharepoint.request_user_context import RequestUserContext
 from office365.sharepoint.sites.site import Site
 from office365.sharepoint.tenant.administration.hubsites.collection import (
@@ -279,8 +286,10 @@ class ClientContext(ClientRuntimeContext):
                 request.ensure_header("IF-MATCH", "*")
 
     def create_modern_site(self, title, alias, owner=None):
+        # type: (str, str, Optional[str | User]) -> Site
         """
-        Creates a modern site
+        Creates a modern (Communication) site
+        https://learn.microsoft.com/en-us/sharepoint/dev/apis/site-creation-rest#create-a-modern-site
 
         :param str alias: Site alias which defines site url, e.g. https://contoso.sharepoint.com/sites/{alias}
         :param str title: Site title
@@ -290,19 +299,17 @@ class ClientContext(ClientRuntimeContext):
         site_url = "{base_url}/sites/{alias}".format(
             base_url=get_absolute_url(self.base_url), alias=alias
         )
-        result = self.site_manager.create(title, site_url, owner)
 
-        def _after_site_create(resp):
-            """
-            :type resp: requests.Response
-            """
-            resp.raise_for_status()
+        def _after_site_create(result):
+            # type: (ClientResult[SPSiteCreationResponse]) -> None
             if result.value.SiteStatus == SiteStatus.Error:
                 raise ValueError(result.value.ErrorMessage)
             elif result.value.SiteStatus == SiteStatus.Ready:
                 return_type.set_property("__siteUrl", result.value.SiteUrl)
 
-        self.after_execute(_after_site_create)
+        self.site_manager.create(title, site_url, owner).after_execute(
+            _after_site_create
+        )
         return return_type
 
     def create_team_site(self, alias, title, is_public=True):
@@ -312,20 +319,18 @@ class ClientContext(ClientRuntimeContext):
         :param str title: Site title
         :param bool is_public:
         """
-        result = self.group_site_manager.create_group_ex(title, alias, is_public)
         return_type = Site(self)
 
-        def _after_site_created(resp):
-            """
-            :type resp: requests.Response
-            """
-            resp.raise_for_status()
+        def _after_site_created(result):
+            # type: (ClientResult[GroupSiteInfo]) -> None
             if result.value.SiteStatus == SiteStatus.Error:
                 raise ValueError(result.value.ErrorMessage)
             elif result.value.SiteStatus == SiteStatus.Ready:
                 return_type.set_property("__siteUrl", result.value.SiteUrl)
 
-        self.after_execute(_after_site_created)
+        self.group_site_manager.create_group_ex(title, alias, is_public).after_execute(
+            _after_site_created
+        )
         return return_type
 
     def create_communication_site(self, alias, title):
@@ -341,9 +346,7 @@ class ClientContext(ClientRuntimeContext):
         )
 
         def _after_site_created(result):
-            """
-            :type result: ClientResult
-            """
+            # type: (ClientResult[CommunicationSiteCreationResponse]) -> None
             if result.value.SiteStatus == SiteStatus.Error:
                 raise ValueError("Site creation error")
             elif result.value.SiteStatus == SiteStatus.Ready:

office365/sharepoint/clientsidecomponent/hostedapps/manager.py

@@ -4,14 +4,14 @@ from office365.sharepoint.entity import Entity
 
 
 class HostedAppsManager(Entity):
-    def get_by_id(self, _id):
+    def get_by_id(self, id_):
         """
         Gets an hosted app based on the Id.
 
-        :param str _id: The Id of the hosted app to get.
+        :param str id_: The Id of the hosted app to get.
         """
         return HostedApp(
-            self.context, ServiceOperationPath("GetById", [_id], self.resource_path)
+            self.context, ServiceOperationPath("GetById", [id_], self.resource_path)
         )
 
     @property

office365/sharepoint/contenttypes/content_type.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.runtime.types.collections import StringCollection
@@ -17,6 +19,12 @@ class ContentType(Entity):
     to items of those types
     """
 
+    def __str__(self):
+        return self.name
+
+    def __repr__(self):
+        return self.string_id or str(self.id) or self.entity_type_name
+
     def reorder_fields(self, field_names):
         """
         The ReorderFields method is called to change the order in which fields appear in a content type.
@@ -43,58 +51,56 @@ class ContentType(Entity):
 
     @property
     def client_form_custom_formatter(self):
-        """
-        :rtype: str
-        """
+        # type: () -> Optional[str]
         return self.properties.get("ClientFormCustomFormatter", None)
 
     @property
     def display_form_client_side_component_id(self):
+        # type: () -> Optional[str]
         """
         The component ID of an SPFx Form Customizer to connect to this content type for usage with display forms.
-        :rtype: str
         """
         return self.properties.get("DisplayFormClientSideComponentId", None)
 
     @property
     def display_form_client_side_component_properties(self):
+        # type: () -> Optional[str]
         """
         The component properties of an SPFx Form Customizer to connect to this content type for usage with display forms
-        :rtype: str
         """
         return self.properties.get("DisplayFormClientSideComponentProperties", None)
 
     @property
     def display_form_template_name(self):
+        # type: () -> Optional[str]
         """
         Specifies the name of a custom display form template to use for list items that have been assigned
         the content type.
-        :rtype: str or None
         """
         return self.properties.get("DisplayFormTemplateName", None)
 
     @property
     def display_form_url(self):
+        # type: () -> Optional[str]
         """
         Specifies the URL of a custom display form to use for list items that have been assigned the content type.
-        :rtype: str or None
         """
         return self.properties.get("DisplayFormUrl", None)
 
     @property
     def edit_form_client_side_component_id(self):
+        # type: () -> Optional[str]
         """
         The component properties of an SPFx Form Customizer to connect to this content type for usage with edit item
             forms
-        :rtype: str or None
         """
         return self.properties.get("EditFormClientSideComponentId", None)
 
     @property
     def edit_form_client_side_component_properties(self):
+        # type: () -> Optional[str]
         """
         The component ID of an SPFx Form Customizer to connect to this content type for usage with edit item forms
-        :rtype: str
         """
         return self.properties.get("EditFormClientSideComponentProperties", None)
 
@@ -107,53 +113,45 @@ class ContentType(Entity):
 
     @property
     def sealed(self):
-        """Specifies whether the content type can be changed.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether the content type can be changed."""
         return self.properties.get("Sealed", None)
 
     @property
     def string_id(self):
-        """A string representation of the value of the Id
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """A string representation of the value of the Id"""
         return self.properties.get("StringId", None)
 
     @property
     def name(self):
-        """Gets the name of the content type.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the name of the content type."""
         return self.properties.get("Name", None)
 
     @name.setter
     def name(self, value):
-        """Sets the name of the content type.
-        :rtype: str or None
-        """
+        # type: (str) -> None
+        """Sets the name of the content type."""
         self.set_property("Name", value)
 
     @property
     def new_form_client_side_component_properties(self):
-        """
-        The component properties of an SPFx Form Customizer to connect to this content type for usage with new item forms
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The component properties of an SPFx Form Customizer to connect to this content type for usage with new
+        item forms"""
         return self.properties.get("NewFormClientSideComponentProperties", None)
 
     @property
     def description(self):
-        """Gets the description of the content type.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the description of the content type."""
         return self.properties.get("Description", None)
 
     @description.setter
     def description(self, value):
-        """Sets the description of the content type.
-
-        :type value: str
-        """
+        # type: (str) -> None
+        """Sets the description of the content type."""
         self.set_property("Description", value)
 
     @property
@@ -168,60 +166,54 @@ class ContentType(Entity):
 
     @property
     def document_template(self):
-        """
-        Specifies the file path to the document template (1) used for a new list item that has been assigned
-            the content type.
-        :rtype: str or None
+        # type: () -> Optional[str]
+        """Specifies the file path to the document template (1) used for a new list item that has been assigned
+        the content type.
         """
         return self.properties.get("DocumentTemplate", None)
 
     @property
     def document_template_url(self):
-        """
-        Specifies the URL of the document template assigned to the content type.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the URL of the document template assigned to the content type."""
         return self.properties.get("DocumentTemplateUrl", None)
 
     @property
     def edit_form_url(self):
+        # type: () -> Optional[str]
         """
         Specifies the URL of a custom edit form to use for list items that have been assigned the content type.
-        :rtype: str or None
         """
         return self.properties.get("EditFormUrl", None)
 
     @property
     def group(self):
-        """Gets the group of the content type.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the group of the content type."""
         return self.properties.get("Group", None)
 
     @group.setter
     def group(self, value):
-        """Sets the group of the content type.
-        :type value: str or None
-        """
+        # type: (str) -> None
+        """Sets the group of the content type."""
         self.set_property("Group", value)
 
     @property
     def hidden(self):
+        # type: () -> Optional[bool]
         """Specifies whether the content type is unavailable for creation or usage directly from a user interface."""
         return self.properties.get("Hidden", None)
 
     @property
     def js_link(self):
-        """Gets or sets the JSLink for the content type custom form template
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets or sets the JSLink for the content type custom form template"""
         return self.properties.get("JSLink", None)
 
     @property
     def read_only(self):
-        """Specifies whether changes to the content type properties are denied.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether changes to the content type properties are denied."""
         return self.properties.get("ReadOnly", None)
 
     @property
@@ -236,9 +228,8 @@ class ContentType(Entity):
 
     @property
     def schema_xml(self):
-        """Specifies the XML schema that represents the content type.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the XML schema that represents the content type."""
         return self.properties.get("SchemaXml", None)
 
     @property

office365/sharepoint/contenttypes/content_type_id.py

@@ -20,4 +20,4 @@ class ContentTypeId(ClientValue):
         self.StringValue = string_value
 
     def __repr__(self):
-        return self.StringValue
+        return self.StringValue or self.entity_type_name

office365/sharepoint/documentmanagement/document_id.py

@@ -36,8 +36,8 @@ class DocumentId(Entity):
         Performs the same function as ResetDocIdByServerRelativePath (section 3.1.5.10.2.1.1), but for every
         document in the specified document library.
 
-        :param str decoded_url: Server relative path to the document library, for which all document identifiers MUST be reset to guarantee
-            global uniqueness in the farm.
+        :param str decoded_url: Server relative path to the document library, for which all document identifiers
+            MUST be reset to guarantee global uniqueness in the farm.
         :param str content_type_id: The content type identifier.
         """
         payload = {"DecodedUrl": decoded_url, "contentTypeId": content_type_id}

office365/sharepoint/documentmanagement/document_set.py

@@ -1,6 +1,8 @@
 from office365.runtime.http.http_method import HttpMethod
+from office365.runtime.http.request_options import RequestOptions
 from office365.runtime.queries.client_query import ClientQuery
 from office365.sharepoint.folders.folder import Folder
+from office365.sharepoint.lists.list import List
 
 
 class DocumentSet(Folder):
@@ -10,7 +12,8 @@ class DocumentSet(Folder):
         Creates a DocumentSet (section 3.1.5.3) object on the server.
 
         :type context: office365.sharepoint.client_context.ClientContext
-        :param office365.sharepoint.folders.folder.Folder parent_folder: The folder inside which to create the new DocumentSet.
+        :param office365.sharepoint.folders.folder.Folder parent_folder: The folder inside which to create the new
+            DocumentSet.
         :param str name: The name to give to the new DocumentSet
         :param office365.sharepoint.contenttypes.content_type_id.ContentTypeId ct_id: The identifier of the content
             type to give to the new document set.
@@ -25,18 +28,14 @@ class DocumentSet(Folder):
             target_list.ensure_property("Title", _create, target_list=target_list)
 
         def _create(target_list):
-            """
-            :type target_list: office365.sharepoint.lists.list.List
-            """
+            # type: (List) -> None
             qry = ClientQuery(context, return_type=return_type)
             context.add_query(qry)
             folder_url = parent_folder.serverRelativeUrl + "/" + name
             return_type.set_property("ServerRelativeUrl", folder_url)
 
             def _construct_request(request):
-                """
-                :type request: office365.runtime.http.request_options.RequestOptions
-                """
+                # type: (RequestOptions) -> None
                 list_name = target_list.title.replace(" ", "")
                 request.url = r"{0}/_vti_bin/listdata.svc/{1}".format(
                     context.base_url, list_name

office365/sharepoint/entity_collection.py

@@ -2,6 +2,7 @@ from typing import TYPE_CHECKING, Optional, Type, TypeVar
 
 from office365.runtime.client_object_collection import ClientObjectCollection
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.paths.v3.entity import EntityPath
 from office365.sharepoint.entity import Entity
 
 if TYPE_CHECKING:
@@ -21,6 +22,14 @@ class EntityCollection(ClientObjectCollection[T]):
             context, item_type, resource_path, parent
         )
 
+    def create_typed_object(self, initial_properties=None, resource_path=None):
+        # type: (Optional[dict], Optional[ResourcePath]) -> T
+        if resource_path is None:
+            resource_path = EntityPath(None, self.resource_path)
+        return super(EntityCollection, self).create_typed_object(
+            initial_properties, resource_path
+        )
+
     @property
     def context(self):
         # type: () -> ClientContext

office365/sharepoint/features/feature.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
@@ -6,16 +8,12 @@ class Feature(Entity):
 
     @property
     def definition_id(self):
-        """
-        Gets the GUID that identifies this feature.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the GUID that identifies this feature."""
         return self.properties.get("DefinitionId", None)
 
     @property
     def display_name(self):
-        """
-        Gets the GUID that identifies this feature.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the GUID that identifies this feature."""
         return self.properties.get("DisplayName", None)

office365/sharepoint/fields/collection.py

@@ -104,10 +104,10 @@ class FieldCollection(EntityCollection[Field]):
             """
             if allow_multiple_values:
                 field_schema = """
-                            <Field Type="LookupMulti" Mult="TRUE" DisplayName="{title}" Required="FALSE" Hidden="TRUE" \
-                            ShowField="{lookup_field_name}" List="{{{lookup_list_id}}}" StaticName="{title}" Name="{title}">
-                            </Field>
-                            """.format(
+                        <Field Type="LookupMulti" Mult="TRUE" DisplayName="{title}" Required="FALSE" Hidden="TRUE" \
+                        ShowField="{lookup_field_name}" List="{{{lookup_list_id}}}" StaticName="{title}" Name="{title}">
+                        </Field>
+                        """.format(
                     title=title,
                     lookup_field_name=lookup_field_name,
                     lookup_list_id=lookup_list_id,
@@ -172,7 +172,8 @@ class FieldCollection(EntityCollection[Field]):
         """Adds a secondary lookup field to a field collection (target).
         Args:
             display_name (str): title of the added field in the target FieldCollection.
-            primary_lookup_field_id (str): ID of the main lookup-field in the target to associate the dependent lookup field with.
+            primary_lookup_field_id (str): ID of the main lookup-field in the target to
+                associate the dependent lookup field with.
             show_field (str): name of the field from the source list to include data from.
         Returns:
             Field: reference to the SP.Field that was added.