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

office365/sharepoint/sites/site.py

@@ -8,6 +8,7 @@ from office365.runtime.paths.service_operation import ServiceOperationPath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.audit.audit import Audit
 from office365.sharepoint.changes.collection import ChangeCollection
+from office365.sharepoint.changes.query import ChangeQuery
 from office365.sharepoint.changes.token import ChangeToken
 from office365.sharepoint.compliance.store_proxy import SPPolicyStoreProxy
 from office365.sharepoint.compliance.tag import ComplianceTag
@@ -108,7 +109,7 @@ class Site(Entity):
         return ClientContext(url).site
 
     def get_available_tags(self):
-        """"""
+        """ """
         return_type = ClientResult(self.context, ClientValueCollection(ComplianceTag))
 
         def _site_loaded():
@@ -129,9 +130,7 @@ class Site(Entity):
         return return_type
 
     def get_site_logo(self):
-        """
-        Downloads a site logo
-        """
+        """Downloads a site logo"""
         return_type = ClientResult(self.context)
 
         def _site_loaded():
@@ -142,6 +141,18 @@ class Site(Entity):
         self.ensure_property("Url", _site_loaded)
         return return_type
 
+    def get_site_logo_ex(self):
+        """Gets site logo image"""
+        return_type = ClientResult(self.context)
+
+        def _site_loaded():
+            self.context.group_service.get_group_image(
+                group_id=self.group_id, return_type=return_type
+            )
+
+        self.ensure_property("GroupId", _site_loaded)
+        return return_type
+
     def set_site_logo(self, relative_logo_url):
         """Uploads a site logo
 
@@ -152,9 +163,7 @@ class Site(Entity):
         return self
 
     def is_comm_site(self):
-        """
-        Determines whether a site is communication site
-        """
+        """Determines whether a site is communication site"""
         return_type = ClientResult(self.context)  # type: ClientResult[bool]
 
         def _site_loaded():
@@ -164,9 +173,7 @@ class Site(Entity):
         return return_type
 
     def is_valid_home_site(self):
-        """
-        Determines whether a site is landing site for your intranet.
-        """
+        """Determines whether a site is landing site for your intranet."""
         return_type = ClientResult(self.context)  # type: ClientResult[bool]
 
         def _site_loaded():
@@ -176,9 +183,7 @@ class Site(Entity):
         return return_type
 
     def set_as_home_site(self):
-        """
-        Sets a site as a landing site for your intranet.
-        """
+        """Sets a site as a landing site for your intranet."""
         return_type = ClientResult(self.context)
 
         def _site_loaded():
@@ -189,12 +194,14 @@ class Site(Entity):
         self.ensure_property("Url", _site_loaded)
         return return_type
 
-    def get_changes(self, query):
+    def get_changes(self, query=None):
         """Returns the collection of all changes from the change log that have occurred within the scope of the site,
         based on the specified query.
 
         :param office365.sharepoint.changes.query.ChangeQuery query: Specifies which changes to return
         """
+        if query is None:
+            query = ChangeQuery(site=True, fetch_limit=100)
         return_type = ChangeCollection(self.context)
         payload = {"query": query}
         qry = ServiceOperationQuery(
@@ -237,7 +244,7 @@ class Site(Entity):
     def get_web_templates(self, lcid=1033, override_compat_level=0):
         """
         Returns the collection of site definitions that are available for creating
-            Web sites within the site collection.<99>
+            Web sites within the site collection.
 
         :param int lcid: A 32-bit unsigned integer that specifies the language of the site definitions that are
             returned from the site collection.
@@ -435,9 +442,7 @@ class Site(Entity):
         return return_type
 
     def unregister_hub_site(self):
-        """
-        Disables the hub site feature on a site.
-        """
+        """Disables the hub site feature on a site."""
         qry = ServiceOperationQuery(self, "UnRegisterHubSite")
         self.context.add_query(qry)
         return self
@@ -461,93 +466,80 @@ class Site(Entity):
 
     @property
     def allow_create_declarative_workflow(self):
-        """
-        Specifies whether a designer can be used to create declarative workflows on this site collection
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether a designer can be used to create declarative workflows on this site collection"""
         return self.properties.get("AllowCreateDeclarativeWorkflow", None)
 
     @property
     def allow_designer(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether a designer can be used on this site collection.
         See Microsoft.SharePoint.Client.Web.AllowDesignerForCurrentUser, which is the scalar property used
         to determine the behavior for the current user. The default, if not disabled on the Web application, is "true".
-        :rtype: bool or None
         """
         return self.properties.get("AllowDesigner", None)
 
     @property
     def allowed_external_domains(self):
-        """
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
         return self.properties.get("AllowedExternalDomains", None)
 
     @property
     def allow_master_page_editing(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether master page editing is allowed on this site collection.
         See Web.AllowMasterPageEditingForCurrentUser, which is the scalar property used to
         determine the behavior for the current user. The default, if not disabled on the Web application, is "false".
-        :rtype: bool or None
         """
         return self.properties.get("AllowMasterPageEditing", None)
 
     @property
     def allow_revert_from_template(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether this site collection can be reverted to its base template.
         See Web.AllowRevertFromTemplateForCurrentUser, which is the scalar property used to determine the behavior
         for the current user. The default, if not disabled on the Web application, is "false".
-        :rtype: bool or None
         """
         return self.properties.get("AllowRevertFromTemplate", None)
 
     @property
     def audit(self):
-        """
-        Enables auditing of how site collection is accessed, changed, and used.
-        """
+        """Enables auditing of how site collection is accessed, changed, and used."""
         return self.properties.get(
             "Audit", Audit(self.context, ResourcePath("Audit", self.resource_path))
         )
 
     @property
     def can_upgrade(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether this site collection is in an implementation-specific valid state for site collection upgrade,
          "true" if it is; otherwise, "false".
-
-        :rtype: bool
         """
         return self.properties.get("CanUpgrade", None)
 
     @property
     def classification(self):
-        """
-        Gets the classification of this site.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the classification of this site."""
         return self.properties.get("Classification", None)
 
     @property
     def compatibility_level(self):
+        # type: () -> Optional[str]
         """
         Specifies the compatibility level of the site collection for the purpose of major version level compatibility
         checks
-
-        :rtype: str
         """
         return self.properties.get("CompatibilityLevel", None)
 
     @property
     def comments_on_site_pages_disabled(self):
-        """
-        Indicates whether comments on site pages are disabled or not.
-        :rtype: bool
-        """
+        # type: () -> Optional[bool]
+        """Indicates whether comments on site pages are disabled or not."""
         return self.properties.get("CommentsOnSitePagesDisabled", None)
 
     @property
@@ -557,17 +549,14 @@ class Site(Entity):
 
     @property
     def group_id(self):
-        """
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Group identifier"""
         return self.properties.get("GroupId", None)
 
     @property
     def lock_issue(self):
-        """
-        Specifies the comment that is used when a site collection is locked
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the comment that is used when a site collection is locked"""
         return self.properties.get("LockIssue", None)
 
     @property
@@ -580,6 +569,7 @@ class Site(Entity):
 
     @property
     def owner(self):
+        # type: () -> User
         """Gets or sets the owner of the site collection. (Read-only in sandboxed solutions.)"""
         return self.properties.get(
             "Owner", User(self.context, ResourcePath("Owner", self.resource_path))
@@ -587,54 +577,46 @@ class Site(Entity):
 
     @property
     def read_only(self):
+        # type: () -> Optional[bool]
         """
         Gets a Boolean value that specifies whether the site collection is read-only,
         locked, and unavailable for write access.
-
-        :rtype: bool
         """
         return self.properties.get("ReadOnly", None)
 
     @property
     def required_designer_version(self):
+        # type: () -> Optional[str]
         """
         Specifies the required minimum version of the designer that can be used on this site collection.
         The default, if not disabled on the Web application, is "15.0.0.0".
-
-        :rtype: str
         """
         return self.properties.get("RequiredDesignerVersion", None)
 
     @property
     def url(self):
         # type: () -> Optional[str]
-        """
-        Specifies the full URL of the site (2), including host name, port number and path
-        """
+        """Specifies the full URL of the site (2), including host name, port number and path"""
         return self.properties.get("Url", None)
 
     @property
     def server_relative_url(self):
-        """
-        Specifies the server-relative URL of the top-level site in the site collection.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Specifies the server-relative URL of the top-level site in the site collection."""
         return self.properties.get("ServerRelativeUrl", None)
 
     @property
     def share_by_email_enabled(self):
+        # type: () -> Optional[bool]
         """
         When true, users will be able to grant permissions to guests for resources within the site collection.
-        :rtype: bool or none
         """
         return self.properties.get("ShareByEmailEnabled", None)
 
     @property
     def status_bar_text(self):
-        """
-        Gets or sets the status bar message text for this site.
-        :rtype: str or none
-        """
+        # type: () -> Optional[str]
+        """Gets or sets the status bar message text for this site."""
         return self.properties.get("StatusBarText", None)
 
     @property
@@ -654,40 +636,37 @@ class Site(Entity):
 
     @property
     def id(self):
+        # type: () -> Optional[str]
         """
         Specifies the GUID that identifies the site collection.
-        :rtype: str
         """
         return self.properties.get("Id", None)
 
     @property
     def hub_site_id(self):
-        """
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """ """
         return self.properties.get("HubSiteId", None)
 
     @property
     def is_hub_site(self):
+        # type: () -> Optional[bool]
         """
         Returns whether the specified site is a hub site
-        :rtype: bool
         """
         return self.properties.get("IsHubSite", None)
 
     @property
     def server_relative_path(self):
-        """Gets the server-relative Path of the Site.
-        :rtype: SPResPath or None
-        """
+        # type: () -> Optional[SPResPath]
+        """Gets the server-relative Path of the Site."""
         return self.properties.get("ServerRelativePath", SPResPath())
 
     @property
     def status_bar_link(self):
+        # type: () -> Optional[str]
         """
         Gets the status bar message link target for this site.
-
-        :rtype: str or None
         """
         return self.properties.get("StatusBarLink", None)
 
@@ -711,6 +690,7 @@ class Site(Entity):
 
     @property
     def features(self):
+        # type: () -> FeatureCollection
         """Get features"""
         return self.properties.get(
             "Features",
@@ -721,19 +701,17 @@ class Site(Entity):
 
     @property
     def max_items_per_throttled_operation(self):
+        # type: () -> Optional[int]
         """
         Specifies the maximum number of list items allowed to be returned for each retrieve request before throttling
         occurs. If throttling occurs, list items MUST NOT be returned.
-        :rtype: int or None
         """
         return self.properties.get("MaxItemsPerThrottledOperation", None)
 
     @property
     def needs_b2b_upgrade(self):
-        """
-        Specifies whether the site needs a Build-to-Build upgrade.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether the site needs a Build-to-Build upgrade."""
         return self.properties.get("NeedsB2BUpgrade", None)
 
     @property
@@ -750,19 +728,19 @@ class Site(Entity):
 
     @property
     def show_url_structure(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether the URL structure of this site collection is viewable.
         See Web.ShowURLStructureForCurrentUser, which is the scalar property used to determine the behavior for the
         current user. The default, if not disabled on the Web application, is "false".
-        :rtype: bool or None
         """
         return self.properties.get("ShowUrlStructure", None)
 
     @property
     def ui_version_configuration_enabled(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether the visual upgrade UI for this site collection is displayed.
-        :rtype: bool or None
         """
         return self.properties.get("UIVersionConfigurationEnabled", None)
 
@@ -785,15 +763,16 @@ class Site(Entity):
 
     @property
     def upgrade_scheduled(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether the upgrade has been scheduled. It can only be set to false by a farm administrator.
         To set it to true, set the UpgradeScheduledDate to a future time.
-        :rtype: bool or None
         """
         return self.properties.get("UpgradeScheduled", None)
 
     @property
     def upgrade_scheduled_date(self):
+        # type: () -> Optional[datetime.datetime]
         """
         Specifies the upgrade scheduled date in UTC (Coordinated Universal Time). Only the Date part is used.
         If UpgradeScheduled is false, returns SqlDateTime.MinValue.
@@ -802,9 +781,9 @@ class Site(Entity):
 
     @property
     def upgrading(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether the user will be able to share links to the documents that can be accessed without signing in.
-        :rtype: bool or None
         """
         return self.properties.get("Upgrading", None)
 

office365/sharepoint/storagemetrics/storage_metrics.py

@@ -1,4 +1,5 @@
 import datetime
+from typing import Optional
 
 from office365.sharepoint.entity import Entity
 
@@ -8,37 +9,35 @@ class StorageMetrics(Entity):
 
     @property
     def last_modified(self):
+        # type: () -> Optional[datetime.datetime]
         """
         Last modified date for all the items under the corresponding folder.
-        :rtype: int or None
         """
         return self.properties.get("LastModified", datetime.datetime.min)
 
     @property
     def total_file_count(self):
+        # type: () -> Optional[int]
         """
         Aggregate number of files within the corresponding folder and its sub-folders.
         Excludes versions, list item attachments, and non-customized documents.
-        :rtype: int or None
         """
         return self.properties.get("TotalFileCount", None)
 
     @property
     def total_file_stream_size(self):
+        # type: () -> Optional[int]
         """
         Aggregate stream size in bytes for all files under the corresponding folder and its sub-folders.
         Excludes version, metadata, list item attachment, and non-customized document sizes.
-
-        :rtype: int or None
         """
         return self.properties.get("TotalFileStreamSize", None)
 
     @property
     def total_size(self):
+        # type: () -> Optional[int]
         """
         Aggregate of total sizes in bytes for all items under the corresponding folder and its sub-folders.
         Total size for a file/folder includes stream, version, and metadata sizes.
-
-        :rtype: int or None
         """
         return self.properties.get("TotalSize", None)

office365/sharepoint/taxonomy/item.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.client_object import ClientObject
 from office365.runtime.paths.resource_path import ResourcePath
 
@@ -9,29 +11,28 @@ class TaxonomyItem(ClientObject):
 
     @property
     def id(self):
-        """Gets the Id of the current TaxonomyItem
-
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Gets the Id of the current TaxonomyItem"""
         return self.properties.get("id", None)
 
     @property
     def name(self):
-        """Gets the name of the current TaxonomyItem object
-
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Gets the name of the current TaxonomyItem object"""
         return self.properties.get("name", None)
 
     @property
     def property_ref_name(self):
+        # type: () -> str
         return "id"
 
     def set_property(self, name, value, persist_changes=True):
         super(TaxonomyItem, self).set_property(name, value, persist_changes)
-        if self._resource_path is None:
-            if name == self.property_ref_name:
+        if name == self.property_ref_name:
+            if self._resource_path is None:
                 self._resource_path = ResourcePath(
                     value, self.parent_collection.resource_path
                 )
+            else:
+                self._resource_path.patch(value)
         return self

office365/sharepoint/taxonomy/stores/store.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.function import FunctionQuery
 from office365.runtime.types.collections import StringCollection
@@ -39,7 +41,9 @@ class TermStore(TaxonomyItem):
         :param str or None parent_term_id:
         :param str or None language_tag:
         """
-        return_type = TaxonomyItemCollection(self.context, Term, self.resource_path)
+        return_type = TaxonomyItemCollection[Term](
+            self.context, Term, self.resource_path
+        )
         params = {
             "label": label,
             "setId": set_id,
@@ -52,17 +56,13 @@ class TermStore(TaxonomyItem):
 
     @property
     def default_language_tag(self):
-        """
-        Gets or sets the LCID of the default working language.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Gets or sets the LCID of the default working language."""
         return self.properties.get("defaultLanguageTag", None)
 
     @property
     def language_tags(self):
-        """
-        Gets an integer collection of LCIDs.
-        """
+        """Gets an integer collection of LCIDs."""
         return self.properties.get("languageTags", StringCollection())
 
     @property

office365/sharepoint/taxonomy/terms/label.py

@@ -16,3 +16,6 @@ class Label(ClientValue):
 
     def __str__(self):
         return self.name
+
+    def __repr__(self):
+        return "{0}:{1}".format(self.languageTag, self.name)

office365/sharepoint/taxonomy/terms/term.py

@@ -1,4 +1,7 @@
+import datetime
+
 from office365.runtime.client_value_collection import ClientValueCollection
+from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.taxonomy.item import TaxonomyItem
 from office365.sharepoint.taxonomy.terms.label import Label
 
@@ -6,7 +9,35 @@ from office365.sharepoint.taxonomy.terms.label import Label
 class Term(TaxonomyItem):
     """Represents a Term or a Keyword in a managed metadata hierarchy."""
 
+    def __repr__(self):
+        return "{0}".format(self.id)
+
+    @property
+    def is_deprecated(self):
+        # type: () -> bool
+        """"""
+        return self.properties.get("isDeprecated", None)
+
+    @property
+    def children_count(self):
+        # type: () -> int
+        """"""
+        return self.properties.get("childrenCount", None)
+
+    @property
+    def created_datetime(self):
+        # type: () -> datetime.datetime
+        """"""
+        return self.properties.get("createdDateTime", None)
+
     @property
     def labels(self):
         """Gets a collection of Label objects for the current Term object."""
         return self.properties.get("labels", ClientValueCollection(Label))
+
+    @property
+    def parent(self):
+        return self.properties.get(
+            "parent",
+            Term(self.context, ResourcePath("parent", self.resource_path)),
+        )

office365/sharepoint/tenant/administration/collaboration/insights_overview.py

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

office365/sharepoint/tenant/administration/hubsites/collection.py

@@ -5,7 +5,7 @@ from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.tenant.administration.hubsites.hub_site import HubSite
 
 
-class HubSiteCollection(EntityCollection):
+class HubSiteCollection(EntityCollection[HubSite]):
     """Represents a collection of HubSite resources."""
 
     def __init__(self, context, resource_path=None):
@@ -13,7 +13,6 @@ class HubSiteCollection(EntityCollection):
 
     def get_by_id(self, _id):
         """Retrieve Hub site by id
-
         :type _id: str
         """
         return HubSite(