SharePoint API: sharing namespace enhancements

Author: vgrem

office365/runtime/client_result.py

@@ -6,7 +6,7 @@ def __init__(self, context, default_value=None):
         Client result
 
         :type context: office365.runtime.client_runtime_context.ClientRuntimeContext
-        :type default_value: int or str or bool or dict or office365.runtime.client_value.ClientValue
+        :type default_value: int or str or bytes or bool or dict or office365.runtime.client_value.ClientValue
         """
         self._context = context
         self._value = default_value

office365/sharepoint/fields/calculated.py

@@ -12,13 +12,17 @@ class FieldCalculated(Field):
     @property
     def currency_locale_id(self):
         """
+        Gets the locale ID that is used for currency on the Web site.
+
         :rtype: int or None
         """
         return self.properties.get('CurrencyLocaleId', None)
 
     @property
     def formula(self):
         """
+        Specifies the formula for the field
+
         :rtype: str or None
         """
         return self.properties.get('Formula', None)

office365/sharepoint/sharing/ability_status.py

@@ -0,0 +1,18 @@
+from office365.runtime.client_value import ClientValue
+
+
+class SharingAbilityStatus(ClientValue):
+    """Represents the status for a specific sharing capability for the current user."""
+
+    def __init__(self, disabled_reason=None, enabled=None):
+        """
+        :param str disabled_reason:  Indicates the reason why the capability is disabled if the capability is disabled
+            for any reason.
+        :param bool enabled: Indicates whether capability is enabled.
+        """
+        self.disabledReason = disabled_reason
+        self.enabled = enabled
+
+    @property
+    def entity_type_name(self):
+        return "SP.Sharing.SharingAbilityStatus"

office365/sharepoint/sharing/link_abilities.py

@@ -0,0 +1,24 @@
+from office365.runtime.client_value import ClientValue
+from office365.sharepoint.sharing.ability_status import SharingAbilityStatus
+
+
+class SharingLinkAbilities(ClientValue):
+    """
+    Represents the set of capabilities for specific configurations of tokenized sharing link for the current user
+    and whether they are enabled or not.
+    """
+
+    def __init__(self, can_add_new_external_principals=SharingAbilityStatus(),
+                 can_delete_edit_link=SharingAbilityStatus(),
+                 can_delete_manage_list_link=SharingAbilityStatus()):
+        """
+        :param SharingAbilityStatus can_add_new_external_principals:
+        :param SharingAbilityStatus can_delete_edit_link:
+        """
+        self.canAddNewExternalPrincipals = can_add_new_external_principals
+        self.canDeleteEditLink = can_delete_edit_link
+        self.canDeleteManageListLink = can_delete_manage_list_link
+
+    @property
+    def entity_type_name(self):
+        return "SP.Sharing.SharingLinkAbilities"

office365/sharepoint/sharing/permission_information.py

@@ -5,4 +5,33 @@ class SharingPermissionInformation(BaseEntity):
     """
     Contains information about a sharing permission entity such as group or role.
     """
-    pass
+
+    @property
+    def is_default_permission(self):
+        """
+        Identifies whether or not the permission entity is a default SP.Group or role (meaning it is recommended
+        for granting permissions).
+
+        A value of true specifies the current permission is a default SP.Group for granting permissions to a site
+        (site owner, member, or visitor SP.Group) or a default role for granting permission to a file or other
+        non-site object (edit or view). A value of false specifies otherwise.
+
+        For SPSites & SPWebs, there can be three default permission entities: owners, members, or visitors SPGroups.
+        For granting permissions to a file or other non-site object, there can be two default permission entities:
+        a role for view permissions (StandardViewerRoleDefinitionID) and a role for edit permissions
+        (StandardEditorRoleDefinitionID).
+
+        :rtype: bool or None
+        """
+        return self.properties.get("IsDefaultPermission", None)
+
+    @property
+    def permission_id(self):
+        """Gets the ID of this permission in the following formats: group:x, role: xxxxxx.
+        :rtype: str or None
+        """
+        return self.properties.get("PermissionId", None)
+
+    @property
+    def entity_type_name(self):
+        return "SP.SharingPermissionInformation"

office365/sharepoint/sharing/personal_web.py

@@ -1,10 +1,24 @@
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.base_entity import BaseEntity
 
 
 class PersonalWeb(BaseEntity):
     """Microsoft.SharePoint.Client.Sharing.PersonalWeb namespace represents methods that apply to a Web site for
     individual users. Methods act on the users default document library."""
 
+    @staticmethod
+    def fix_permission_inheritance(context):
+        """
+        This method fixes the permission inheritance for the default document library of the personal web when
+        breakRoleInheritance didn't happen correctly during the default document library creation.
+
+        :param office365.sharepoint.client_context.ClientContext context: SharePoint client context
+        """
+        binding_type = PersonalWeb(context)
+        qry = ServiceOperationQuery(binding_type, "FixPermissionInheritance", None, None, None, None, True)
+        context.add_query(qry)
+        return binding_type
+
     @property
     def entity_type_name(self):
         return "SP.Sharing.PersonalWeb"

office365/sharepoint/sharing/web_sharing_manager.py

@@ -2,6 +2,7 @@
 
 
 class WebSharingManager(BaseEntity):
+    """Specifies a placeholder for all web sharing methods."""
 
     @property
     def entity_type_name(self):

office365/sharepoint/tenant/administration/settings_service.py

@@ -13,7 +13,7 @@ def __init__(self, context):
         super(TenantAdminSettingsService, self).__init__(context, static_path)
 
     def get_tenant_sharing_status(self):
-        return_type = ClientResult(self.context)
+        return_type = ClientResult(self.context, int())
         qry = ServiceOperationQuery(self, "GetTenantSharingStatus", None, None, None, return_type)
         self.context.add_query(qry)
         return return_type

office365/sharepoint/tenant/administration/site_properties_collection.py

@@ -2,6 +2,7 @@
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.base_entity_collection import BaseEntityCollection
 from office365.sharepoint.tenant.administration.site_properties import SiteProperties
+from office365.sharepoint.tenant.administration.site_state_properties import SiteStateProperties
 
 
 class SitePropertiesCollection(BaseEntityCollection):
@@ -22,16 +23,25 @@ def get_lock_state_by_id(self, site_id):
         """
         :param str site_id: Site identifier
         """
-        result = ClientResult(self.context)
-        qry = ServiceOperationQuery(self, "GetLockStateById", [site_id], None, None, result)
+        return_type = ClientResult(self.context, int())
+        qry = ServiceOperationQuery(self, "GetLockStateById", [site_id], None, None, return_type)
         self.context.add_query(qry)
-        return result
+        return return_type
+
+    def get_site_state_properties(self, site_id):
+        """
+        :param str site_id: Site identifier
+        """
+        return_type = ClientResult(self.context, SiteStateProperties())
+        qry = ServiceOperationQuery(self, "GetSiteStateProperties", [site_id], None, None, return_type)
+        self.context.add_query(qry)
+        return return_type
 
     def check_site_is_archived_by_id(self, site_id):
         """
         :param str site_id: Site identifier
         """
-        result = ClientResult(self.context)
-        qry = ServiceOperationQuery(self, "CheckSiteIsArchivedById", [site_id], None, None, result)
+        return_type = ClientResult(self.context, bool())
+        qry = ServiceOperationQuery(self, "CheckSiteIsArchivedById", [site_id], None, None, return_type)
         self.context.add_query(qry)
-        return result
+        return return_type

office365/sharepoint/tenant/administration/site_state_properties.py

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

office365/sharepoint/tenant/administration/site_user_group_info.py

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

office365/sharepoint/tenant/administration/tenant.py

@@ -124,7 +124,7 @@ def remove_home_site(self):
 
     def has_valid_education_license(self):
         """"""
-        return_type = ClientResult(self.context)
+        return_type = ClientResult(self.context, bool())
         qry = ServiceOperationQuery(self, "HasValidEducationLicense", None, None, None, return_type)
         self.context.add_query(qry)
         return return_type
@@ -133,17 +133,17 @@ def export_to_csv(self, view_xml=None):
         """
         :param str view_xml:
         """
-        result = ClientResult(self.context)
+        return_type = ClientResult(self.context)
         payload = {
             "viewXml": view_xml
         }
-        qry = ServiceOperationQuery(self, "ExportToCSV", None, payload, None, result)
+        qry = ServiceOperationQuery(self, "ExportToCSV", None, payload, None, return_type)
         self.context.add_query(qry)
-        return result
+        return return_type
 
     def render_policy_report(self):
         """"""
-        return_type = ClientResult(self.context)
+        return_type = ClientResult(self.context, bytes())
         payload = {
             "parameters": RenderListDataParameters(),
             "overrideParameters": RenderListDataOverrideParameters()
@@ -354,10 +354,10 @@ def restore_deleted_site(self, site_url):
 
         :param str site_url: A string representing the URL of the site.
         """
-        result = SpoOperation(self.context)
-        qry = ServiceOperationQuery(self, "RestoreDeletedSite", [site_url], None, None, result)
+        return_type = SpoOperation(self.context)
+        qry = ServiceOperationQuery(self, "RestoreDeletedSite", [site_url], None, None, return_type)
         self.context.add_query(qry)
-        return result
+        return return_type
 
     def get_site_properties_by_url(self, url, include_detail=False):
         """
@@ -410,7 +410,7 @@ def send_email(self, site_url):
         """
         :type site_url: str
         """
-        return_type = ClientResult(self.context)
+        return_type = ClientResult(self.context, bool())
         payload = {"siteUrl": site_url}
         qry = ServiceOperationQuery(self, "SendEmail", None, payload, None, return_type)
         self.context.add_query(qry)

office365/sharepoint/tenant/management/externalusers/__init__.py

@@ -0,0 +1,15 @@
+from office365.runtime.paths.service_operation import ServiceOperationPath
+from office365.sharepoint.base_entity_collection import BaseEntityCollection
+from office365.sharepoint.tenant.management.externalusers.external_user import ExternalUser
+
+
+class ExternalUserCollection(BaseEntityCollection):
+
+    def __init__(self, context, resource_path=None):
+        super(ExternalUserCollection, self).__init__(context, ExternalUser, resource_path)
+
+    def get_by_id(self, unique_id):
+        """
+        :param str unique_id: The Id of the external user.
+        """
+        return ExternalUser(self.context, ServiceOperationPath("GetById", [unique_id], self.resource_path))

office365/sharepoint/tenant/management/externalusers/collection.py

@@ -0,0 +1,8 @@
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class ExternalUser(BaseEntity):
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantManagement.ExternalUser"

office365/sharepoint/tenant/management/externalusers/external_user.py

@@ -0,0 +1,23 @@
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.sharepoint.base_entity import BaseEntity
+from office365.sharepoint.tenant.management.externalusers.collection import ExternalUserCollection
+
+
+class GetExternalUsersResults(BaseEntity):
+
+    @property
+    def total_user_count(self):
+        return self.properties.get("TotalUserCount", None)
+
+    @property
+    def user_collection_position(self):
+        return self.properties.get("UserCollectionPosition", None)
+
+    @property
+    def external_user_collection(self):
+        return self.properties.get("ExternalUserCollection",
+                                   ExternalUserCollection(self.context, ResourcePath("ExternalUserCollection")))
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantManagement.GetExternalUsersResults"

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

@@ -0,0 +1,8 @@
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class RemoveExternalUsersResults(BaseEntity):
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantManagement.RemoveExternalUsersResults"

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

@@ -0,0 +1,10 @@
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class SPOUserSessionRevocationResult(BaseEntity):
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantManagement.SPOUserSessionRevocationResult"
+
+

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

@@ -6,8 +6,9 @@
 from office365.sharepoint.base_entity import BaseEntity
 from office365.sharepoint.principal.user import User
 from office365.sharepoint.tenant.administration.siteinfo_for_site_picker import SiteInfoForSitePicker
-from office365.sharepoint.tenant.management.users_results import GetExternalUsersResults, RemoveExternalUsersResults, \
-    SPOUserSessionRevocationResult
+from office365.sharepoint.tenant.management.externalusers.results.session_revocation import SPOUserSessionRevocationResult
+from office365.sharepoint.tenant.management.externalusers.results.remove import RemoveExternalUsersResults
+from office365.sharepoint.tenant.management.externalusers.results.get import GetExternalUsersResults
 from office365.sharepoint.tenant.administration.theme_properties import ThemeProperties