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

office365/sharepoint/sites/site.py

@@ -109,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():
@@ -130,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():
@@ -143,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
 
@@ -153,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():
@@ -165,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():
@@ -177,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():
@@ -438,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
@@ -464,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
@@ -560,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
@@ -583,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))
@@ -590,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
@@ -711,6 +690,7 @@ class Site(Entity):
 
     @property
     def features(self):
+        # type: () -> FeatureCollection
         """Get features"""
         return self.properties.get(
             "Features",
@@ -731,9 +711,7 @@ class Site(Entity):
     @property
     def needs_b2b_upgrade(self):
         # type: () -> Optional[bool]
-        """
-        Specifies whether the site needs a Build-to-Build upgrade.
-        """
+        """Specifies whether the site needs a Build-to-Build upgrade."""
         return self.properties.get("NeedsB2BUpgrade", None)
 
     @property

office365/sharepoint/taxonomy/item.py

@@ -28,9 +28,11 @@ class TaxonomyItem(ClientObject):
 
     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

@@ -57,16 +57,12 @@ class TermStore(TaxonomyItem):
     @property
     def default_language_tag(self):
         # type: () -> Optional[str]
-        """
-        Gets or sets the LCID of the default working language.
-        """
+        """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/tenant/administration/internal/permission_grant.py

@@ -0,0 +1,7 @@
+from office365.sharepoint.entity import Entity
+
+
+class SPO3rdPartyAADPermissionGrant(Entity):
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantAdministration.Internal.SPO3rdPartyAADPermissionGrant"

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

@@ -1,24 +1,27 @@
 from typing import Optional
 
-from office365.runtime.paths.key import KeyPath
+from office365.onedrive.listitems.list_item import ListItem
 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.client_context import ClientContext
 from office365.sharepoint.entity import Entity
-from office365.sharepoint.sites.site import Site
+from office365.sharepoint.internal.paths.static_operation import StaticOperationPath
 from office365.sharepoint.tenant.administration.deny_add_and_customize_pages_status import (
     DenyAddAndCustomizePagesStatus,
 )
+from office365.sharepoint.tenant.administration.spo_operation import SpoOperation
 
 
 class SiteProperties(Entity):
     """Contains a property bag of information about a site."""
 
+    def __repr__(self):
+        return self.url or self.entity_type_name
+
     @staticmethod
     def clear_sharing_lock_down(context, site_url):
-        """
-        :param office365.sharepoint.client_context.ClientContext context: SharePoint client service
-        :param str site_url:
-        """
+        # type: (ClientContext, str) -> SiteProperties
         payload = {"siteUrl": site_url}
         binding_type = SiteProperties(context)
         qry = ServiceOperationQuery(
@@ -30,75 +33,71 @@ class SiteProperties(Entity):
     def update(self):
         """Updates the site collection properties with the new properties specified in the SiteProperties object."""
 
-        site = Site(self.context)
-        site.set_property("__siteUrl", self.url)
-
-        def _site_loaded(return_type):
-            self._resource_path = KeyPath(site.id, self.parent_collection.resource_path)
+        def _update():
             super(SiteProperties, self).update()
 
-        self.context.load(site, after_loaded=_site_loaded)
+        self._ensure_site_path(_update)
         return self
 
+    def update_ex(self):
+        """Updates the site collection properties with the new properties specified in the SiteProperties object."""
+        return_type = SpoOperation(self.context)
+
+        def _update_ex():
+            qry = ServiceOperationQuery(
+                self, "Update", parameters_type=self, return_type=return_type
+            )
+            self.context.add_query(qry)
+
+        self._ensure_site_path(_update_ex)
+        return return_type
+
     @property
     def deny_add_and_customize_pages(self):
-        """
-        Represents the status of the [DenyAddAndCustomizePages] feature on a site collection.
-        """
+        # type: () -> Optional[int]
+        """Represents the status of the [DenyAddAndCustomizePages] feature on a site collection."""
         return self.properties.get(
             "DenyAddAndCustomizePages", DenyAddAndCustomizePagesStatus.Unknown
         )
 
     @deny_add_and_customize_pages.setter
     def deny_add_and_customize_pages(self, value):
-        """
-        Sets the status of the [DenyAddAndCustomizePages] feature on a site collection.
-
-        :param int value:
-        """
+        # type: (int) -> None
+        """Sets the status of the [DenyAddAndCustomizePages] feature on a site collection."""
         self.set_property("DenyAddAndCustomizePages", value)
 
     @property
     def owner_login_name(self):
-        """
-        :rtype: str
-        """
+        # type: () -> Optional[str]
         return self.properties.get("OwnerLoginName", None)
 
     @property
     def webs_count(self):
-        """
-        Gets the number of Web objects in the site.
-        :rtype: int
-        """
+        # type: () -> Optional[str]
+        """Gets the number of Web objects in the site."""
         return self.properties.get("WebsCount", None)
 
     @property
     def url(self):
         # type: () -> Optional[str]
-        """
-        Gets the URL of the site.
-        """
+        """Gets the URL of the site."""
         return self.properties.get("Url", None)
 
     @property
     def compatibility_level(self):
         # type: () -> Optional[str]
-        """
-        Gets the compatibility level of the site.
-        """
+        """Gets the compatibility level of the site."""
         return self.properties.get("CompatibilityLevel", None)
 
     @property
     def lock_state(self):
         # type: () -> Optional[str]
-        """
-        Gets or sets the lock state of the site.
-        """
+        """Gets or sets the lock state of the site."""
         return self.properties.get("LockState", None)
 
     @property
     def sharing_capability(self):
+        # type: () -> Optional[int]
         """
         Determines what level of sharing is available for the site.
 
@@ -115,29 +114,41 @@ class SiteProperties(Entity):
 
     @sharing_capability.setter
     def sharing_capability(self, value):
-        """
-        Sets the level of sharing for the site.
-        :type value: int
-        """
+        # type: (int) -> None
+        """Sets the level of sharing for the site."""
         self.set_property("SharingCapability", value)
 
     @property
     def time_zone_id(self):
         # type: () -> Optional[str]
-        """
-        Gets the time zone ID of the site.
-        """
+        """Gets the time zone ID of the site."""
         return self.properties.get("TimeZoneId", None)
 
     @property
     def entity_type_name(self):
+        # type: () -> str
         return "Microsoft.Online.SharePoint.TenantAdministration.SiteProperties"
 
     def set_property(self, name, value, persist_changes=True):
         super(SiteProperties, self).set_property(name, value, persist_changes)
         # fallback: create a new resource path
         if name == "Url" and self._resource_path is None:
-            self._resource_path = ServiceOperationPath(
+            self._resource_path = StaticOperationPath(
                 self.entity_type_name, {"Url": value}
             )
         return self
+
+    def _ensure_site_path(self, action):
+        if isinstance(self.resource_path, ServiceOperationPath):
+
+            def _loaded(return_type):
+                # type: (ListItem) -> None
+                site_id = return_type.get_property("SiteId")
+                self._resource_path = EntityPath(
+                    site_id, self.parent_collection.resource_path
+                )
+                action()
+
+            self.context.tenant.get_site(self.url).after_execute(_loaded)
+        else:
+            action()