publishing & viva namespaces new types and methods

Author: vgrem

examples/sharepoint/users/search_tenant_users.py

@@ -12,7 +12,7 @@
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
 result = ClientPeoplePickerWebServiceInterface.client_people_picker_search_user(
-    ctx, "Joe"
+    ctx, "Jon"
 ).execute_query()
 entries = json.loads(result.value)
 for entry in entries:

generator/import_metadata.py

@@ -26,13 +26,13 @@ def export_to_file(path, content):
     "--endpoint",
     dest="endpoint",
     help="Import metadata endpoint",
-    default="sharepoint",
+    default="graph",
 )
 parser.add_argument(
     "-p",
     "--path",
     dest="path",
-    default="./metadata/SharePoint.xml",
+    default="./metadata/Graph.xml",
     help="Import metadata endpoint",
 )
 

office365/admin/people_settings.py

@@ -1,5 +1,21 @@
 from office365.entity import Entity
+from office365.entity_collection import EntityCollection
+from office365.outlook.people.profile_card_property import ProfileCardProperty
+from office365.runtime.paths.resource_path import ResourcePath
 
 
 class PeopleAdminSettings(Entity):
     """Represents a setting to control people-related admin settings in the tenant."""
+
+    @property
+    def profile_card_properties(self):
+        """Contains a collection of the properties an administrator has defined as visible on the
+        Microsoft 365 profile card."""
+        return self.properties.get(
+            "profileCardProperties",
+            EntityCollection(
+                self.context,
+                ProfileCardProperty,
+                ResourcePath("profileCardProperties", self.resource_path),
+            ),
+        )

office365/directory/identitygovernance/privilegedaccess/group.py

@@ -1,5 +1,5 @@
 from office365.directory.identitygovernance.privilegedaccess.approval import Approval
-from office365.directory.identitygovernance.privilegedaccess.group_assignment_schedule_instance import (
+from office365.directory.identitygovernance.privilegedaccess.schedule.group_assignment_instance import (
     PrivilegedAccessGroupAssignmentScheduleInstance,
 )
 from office365.entity import Entity

office365/directory/identitygovernance/privilegedaccess/schedule/__init__.py

@@ -1,4 +1,4 @@
-from office365.directory.identitygovernance.privilegedaccess.schedule_instance import (
+from office365.directory.identitygovernance.privilegedaccess.schedule.instance import (
     PrivilegedAccessScheduleInstance,
 )
 

office365/directory/identitygovernance/privilegedaccess/group_assignment_schedule_instance.py renamed to office365/directory/identitygovernance/privilegedaccess/schedule/group_assignment_instance.py

@@ -0,0 +1,6 @@
+from office365.entity import Entity
+
+
+class PrivilegedAccessSchedule(Entity):
+    """An abstract type that exposes properties relating to the schedule of assigned and eligible membership and
+    ownership to groups that are governed by PIM."""

office365/directory/identitygovernance/privilegedaccess/schedule_instance.py renamed to office365/directory/identitygovernance/privilegedaccess/schedule/instance.py

@@ -0,0 +1,15 @@
+from office365.entity import Entity
+
+
+class ProfileCardProperty(Entity):
+    """
+    Represents an attribute of a user on the Microsoft 365 profile card for an organization to surface in a shared,
+    people experience.
+
+    The attribute can be an Microsoft Entra ID built-in attribute, such as Alias or UserPrincipalName,
+    or it can be a custom attribute. For a custom attribute, an administrator can define an en-us default display name
+    String and a set of alternative translations for the languages supported in their organization.
+
+    For more information about how to add properties to the profile card for an organization, see Add or remove
+    custom attributes on a profile card using the profile card API.
+    """

office365/directory/identitygovernance/privilegedaccess/schedule/schedule.py

@@ -119,6 +119,19 @@ def get_email_app_usage_user_counts(self, period):
         self.context.add_query(qry)
         return qry.return_type
 
+    ###
+    def get_email_app_usage_user_detail(self, period):
+        """
+        Get details about which activities users performed on the various email apps.
+
+        :param str period: Specifies the length of time over which the report is aggregated.
+            The supported values for {period_value} are: D7, D30, D90, and D180. These values follow the format
+            Dn where n represents the number of days over which the report is aggregated. Required.
+        """
+        qry = create_report_query(self, "getEmailAppUsageUserDetail", period, True)
+        self.context.add_query(qry)
+        return qry.return_type
+
     def get_mailbox_usage_storage(self, period):
         """
         Get the amount of storage used in your organization.

office365/outlook/people/__init__.py

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

office365/outlook/people/profile_card_property.py

@@ -1,4 +1,9 @@
+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.brandcenter.configuration import BrandCenterConfiguration
 from office365.sharepoint.entity import Entity
+from office365.sharepoint.sites.themes import SiteThemes
 
 
 class BrandCenter(Entity):
@@ -7,3 +12,22 @@ class BrandCenter(Entity):
     that empowers your brand managers or designated brand owners to help your organization to customize
     the look and feel of their experiences.
     """
+
+    def __init__(self, context):
+        super(BrandCenter, self).__init__(context, ResourcePath("SP.BrandCenter"))
+
+    def configuration(self):
+        return_type = ClientResult(self.context, BrandCenterConfiguration())
+        qry = ServiceOperationQuery(
+            self, "Configuration", None, None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def get_site_themes(self):
+        return_type = ClientResult(self.context, SiteThemes())
+        qry = ServiceOperationQuery(
+            self, "GetSiteThemes", None, None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type

office365/reports/root.py

@@ -405,7 +405,7 @@ def brand_center(self):
 
         from office365.sharepoint.brandcenter.brand_center import BrandCenter
 
-        return BrandCenter(self, ResourcePath("BrandCenter"))
+        return BrandCenter(self)
 
     @property
     def client_people_picker(self):
@@ -631,6 +631,14 @@ def site_manager(self):
 
         return SPSiteManager(self, ResourcePath("spSiteManager"))
 
+    @property
+    def site_manager_svc(self):
+        """Alias to SiteManagerService."""
+
+        from office365.sharepoint.sites.manager.service import SiteManagerService
+
+        return SiteManagerService(self)
+
     @property
     def social_feed_manager(self):
         """Alias to SocialFeedManager."""

office365/sharepoint/apps/launcher.py

@@ -59,6 +59,13 @@ def __init__(self, context, resource_path=None, parent_list=None):
         if parent_list is not None:
             self.set_property("ParentList", parent_list, False)
 
+    def archive(self):
+        """Archives the list item."""
+        return_type = ClientResult(self.context, str())
+        qry = ServiceOperationQuery(self, "Archive", None, None, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
     def share_link(self, link_kind, expiration=None, role=None, password=None):
         # type: (int, Optional[datetime.datetime], Optional[int], Optional[str]) -> ClientResult[ShareLinkResponse]
         """Creates a tokenized sharing link for a list item based on the specified parameters and optionally

office365/sharepoint/brandcenter/brand_center.py

@@ -0,0 +1,39 @@
+from typing import TYPE_CHECKING
+
+from office365.runtime.paths.service_operation import ServiceOperationPath
+from office365.sharepoint.entity import Entity
+
+if TYPE_CHECKING:
+    from office365.sharepoint.client_context import ClientContext
+
+
+class MigrationUrlParser(Entity):
+    """"""
+
+    def __init__(
+        self,
+        context,
+        user_input_destination_url,
+        retrive_all_lists,
+        retrieve_all_lists_sub_folders,
+        force_my_site_default_list,
+        migration_type,
+        current_context_site_subscription_id,
+    ):
+        # type: (ClientContext, str, bool, bool, bool, str, str) -> None
+        static_path = ServiceOperationPath(
+            "SP.AppContextSite",
+            {
+                "userInputDestinationUrl": user_input_destination_url,
+                "retriveAllLists": retrive_all_lists,
+                "retrieveAllListsSubFolders": retrieve_all_lists_sub_folders,
+                "forceMySiteDefaultList": force_my_site_default_list,
+                "migrationType": migration_type,
+                "currentContextSiteSubscriptionId": current_context_site_subscription_id,
+            },
+        )
+        super(MigrationUrlParser, self).__init__(context, static_path)
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.MigrationCenter.Common.MigrationUrlParser"

office365/sharepoint/client_context.py

@@ -7,6 +7,8 @@
 
 
 class CampaignPublication(SitePage):
+    """ """
+
     def get_highlights_info(self):
         """ """
         return_type = HighlightsInfo(self.context)

office365/sharepoint/listitems/listitem.py

@@ -0,0 +1,18 @@
+from office365.runtime.client_value import ClientValue
+from office365.sharepoint.publishing.pages.fields_data import SitePageFieldsData
+
+
+class CampaignPublicationMailDraftData(ClientValue):
+    """ """
+
+    @property
+    def entity_type_name(self):
+        return "SP.Publishing.CampaignPublicationMailDraftData"
+
+
+class CampaignPublicationFieldsData(SitePageFieldsData):
+    """ """
+
+    @property
+    def entity_type_name(self):
+        return "SP.Publishing.CampaignPublicationFieldsData"

office365/sharepoint/migrationcenter/common/url_parser.py

@@ -3,6 +3,26 @@
 
 class SitePageCoAuthState(ClientValue):
 
+    def __init__(
+        self,
+        action=None,
+        has_reached_minor_versions_limit=None,
+        is_new_session=None,
+        is_partition_flushed=None,
+        lock_action=None,
+        lock_duration=None,
+        overwrite_existing_version=None,
+        shared_lock_id=None,
+    ):
+        self.Action = action
+        self.HasReachedMinorVersionsLimit = has_reached_minor_versions_limit
+        self.IsNewSession = is_new_session
+        self.IsPartitionFlushed = is_partition_flushed
+        self.LockAction = lock_action
+        self.LockDuration = lock_duration
+        self.OverwriteExistingVersion = overwrite_existing_version
+        self.SharedLockId = shared_lock_id
+
     @property
     def entity_type_name(self):
         return "SP.Publishing.SitePageCoAuthState"

office365/sharepoint/publishing/pages/campaign/__init__.py

@@ -129,13 +129,3 @@ def get_property(self, name, default_value=None):
             }
             default_value = property_mapping.get(name, None)
         return super(SitePageMetadata, self).get_property(name, default_value)
-
-    def set_property(self, name, value, persist_changes=True):
-        if name == "Id":
-            if self._resource_path is None:
-                self._resource_path = self.parent_collection.get_by_id(
-                    value
-                ).resource_path
-            else:
-                self._resource_path.patch(value)
-        return super(SitePageMetadata, self).set_property(name, value, persist_changes)

office365/sharepoint/publishing/pages/campaign_publication.py renamed to office365/sharepoint/publishing/pages/campaign/publication.py

@@ -218,6 +218,12 @@ def canvas_content(self):
         """Gets the CanvasContent1 for the current Site Page"""
         return self.properties.get("CanvasContent1", None)
 
+    @property
+    def language(self):
+        # type: () -> Optional[str]
+        """Gets the Language for the Site Page."""
+        return self.properties.get("Language", None)
+
     @canvas_content.setter
     def canvas_content(self, value):
         # type: (str) -> None

office365/sharepoint/publishing/pages/campaign/types.py

@@ -50,24 +50,25 @@ def communication_site(self):
     def entity_type_name(self):
         return "SP.Publishing.SitePageService"
 
-    def create_page(self, title):
-        # type: (str) -> SitePage
+    def create_page(self, title, language=None):
+        # type: (str, Optional[str]) -> SitePage
         """Create a new sitePage in the site pages list in a site.
         :param str title: The title of Site Page
+        :param str language: The language of the Site Page.
         """
 
         def _page_created(return_type):
             # type: (SitePage) -> None
 
             def _draft_saved(result):
                 # type: (ClientResult[bool]) -> None
-                pass
+                return_type.get()
 
             return_type.save_draft(title=title).after_execute(
                 _draft_saved, execute_first=True
             )
 
-        return self.pages.add().after_execute(_page_created).get()
+        return self.pages.add().after_execute(_page_created)
 
     def create_and_publish_page(self, title):
         """

office365/sharepoint/publishing/pages/coauth_state.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class BrandCenterConfiguration(ClientValue):
+    """ """

office365/sharepoint/publishing/pages/metadata.py

@@ -0,0 +1,34 @@
+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.entity import Entity
+from office365.sharepoint.sites.manager.types import TopSiteFilesResult
+
+
+class SiteManagerService(Entity):
+    """ """
+
+    def __init__(self, context):
+        static_path = ResourcePath(
+            "Microsoft.SharePoint.SiteManager.SiteManagerService"
+        )
+        super(SiteManagerService, self).__init__(context, static_path)
+
+    def top_files(self, max_count=None):
+        """ """
+        return_type = ClientResult(self.context, TopSiteFilesResult())
+        payload = {"maxCount": max_count}
+        qry = ServiceOperationQuery(
+            self,
+            "TopFiles",
+            None,
+            payload,
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.SiteManager.SiteManagerService"

office365/sharepoint/publishing/pages/page.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class TopSiteFilesResult(ClientValue):
+    """ """

office365/sharepoint/publishing/pages/service.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class SiteThemes(ClientValue):
+    """ """