Office365-REST-Python-Client 2.5.6__py3-none-any.whl → 2.5.8__py3-none-any.whl

office365/sharepoint/ui/applicationpages/peoplepicker/web_service_interface.py

@@ -16,39 +16,6 @@ from office365.sharepoint.ui.applicationpages.peoplepicker.query_parameters impo
 class ClientPeoplePickerWebServiceInterface(Entity):
     """Specifies an interface that can be used to query principals."""
 
-    @staticmethod
-    def get_search_results(
-        context,
-        search_pattern,
-        provider_id=None,
-        hierarchy_node_id=None,
-        entity_types=None,
-    ):
-        """
-        Specifies a JSON formatted CSOM String of principals found in the search.
-
-        :type context: office365.sharepoint.client_context.ClientContext
-        :param str search_pattern: Specifies a pattern used to search for principals.
-            The value is implementation-specific.
-        :param str provider_id: The identifier of a claims provider.
-        :param str hierarchy_node_id: The identifier of a node in the hierarchy. The search MUST be conducted under
-            this node.
-        :param str entity_types: The type of principals to search for.
-        """
-        return_type = ClientResult(context, str())
-        payload = {
-            "searchPattern": search_pattern,
-            "providerID": provider_id,
-            "hierarchyNodeID": hierarchy_node_id,
-            "entityTypes": entity_types,
-        }
-        svc = ClientPeoplePickerWebServiceInterface(context)
-        qry = ServiceOperationQuery(
-            svc, "GetSearchResults", None, payload, None, return_type, True
-        )
-        context.add_query(qry)
-        return return_type
-
     @staticmethod
     def get_search_results_by_hierarchy(
         context,
@@ -167,3 +134,42 @@ class ClientPeoplePickerWebServiceInterface(Entity):
     @property
     def entity_type_name(self):
         return "SP.UI.ApplicationPages.ClientPeoplePickerWebServiceInterface"
+
+
+class PeoplePickerWebServiceInterface(Entity):
+    @staticmethod
+    def get_search_results(
+        context,
+        search_pattern,
+        provider_id=None,
+        hierarchy_node_id=None,
+        entity_types=None,
+    ):
+        """
+        Specifies a JSON formatted CSOM String of principals found in the search.
+
+        :type context: office365.sharepoint.client_context.ClientContext
+        :param str search_pattern: Specifies a pattern used to search for principals.
+            The value is implementation-specific.
+        :param str provider_id: The identifier of a claims provider.
+        :param str hierarchy_node_id: The identifier of a node in the hierarchy. The search MUST be conducted under
+            this node.
+        :param str entity_types: The type of principals to search for.
+        """
+        return_type = ClientResult(context, str())
+        payload = {
+            "searchPattern": search_pattern,
+            "providerID": provider_id,
+            "hierarchyNodeID": hierarchy_node_id,
+            "entityTypes": entity_types,
+        }
+        svc = PeoplePickerWebServiceInterface(context)
+        qry = ServiceOperationQuery(
+            svc, "GetSearchResults", None, payload, None, return_type, True
+        )
+        context.add_query(qry)
+        return return_type
+
+    @property
+    def entity_type_name(self):
+        return "SP.UI.ApplicationPages.PeoplePickerWebServiceInterface"

office365/sharepoint/userprofiles/cross_geo_sync.py

@@ -0,0 +1,37 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.client_context import ClientContext
+from office365.sharepoint.entity import Entity
+from office365.sharepoint.userprofiles.cross_geo_sync_user_data_batch import (
+    CrossGeoSyncUserDataBatch,
+)
+
+
+class CrossGeoSync(Entity):
+    """"""
+
+    @staticmethod
+    def read_full_changes_batch(context, targetInstanceId, lastRecordId, batchSize):
+        # type: (ClientContext, str, str, str) -> ClientResult[CrossGeoSyncUserDataBatch]
+        """ """
+        payload = {
+            "targetInstanceId": targetInstanceId,
+            "lastRecordId": lastRecordId,
+            "batchSize": batchSize,
+        }
+        return_type = ClientResult(context, CrossGeoSyncUserDataBatch())
+        qry = ServiceOperationQuery(
+            CrossGeoSync(context),
+            "ReadFullChangesBatch",
+            None,
+            payload,
+            None,
+            return_type,
+            is_static=True,
+        )
+        context.add_query(qry)
+        return return_type
+
+    @property
+    def entity_type_name(self):
+        return "SP.UserProfiles.CrossGeoSync"

office365/sharepoint/userprofiles/cross_geo_sync_user_data_batch.py

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

office365/sharepoint/userprofiles/followed_content.py

@@ -25,6 +25,21 @@ class FollowedContent(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def get_followed_status(self, url):
+        """
+        The GetFollowedStatus method retrieves the followed status of the specified document or site.
+        An item can be followed if the url parameter identifies a document or site that the current user has access to.
+
+        :param str url: URL that identifies the item
+        """
+        return_type = ClientResult(self.context, int())
+        payload = {"url": url}
+        qry = ServiceOperationQuery(
+            self, "GetFollowedStatus", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def followed_documents_url(self):
         # type: () -> Optional[str]

office365/sharepoint/userprofiles/people_manager.py

@@ -75,18 +75,30 @@ class PeopleManager(Entity):
         self.context.add_query(qry)
         return result
 
-    def get_followers_for(self, account_name):
+    def get_followers_for(self, account):
+        # type: (str|User) -> EntityCollection[PersonProperties]
         """
         Gets the people who are following the specified user.
 
-        :param str account_name: Account name of the specified user.
+        :param str|User account: Account name of the specified user.
         """
         return_type = EntityCollection(self.context, PersonProperties)
-        params = {"accountName": account_name}
-        qry = ServiceOperationQuery(
-            self, "GetFollowersFor", params, None, None, return_type
-        )
-        self.context.add_query(qry)
+
+        def _get_followers_for(account_name):
+            params = {"accountName": account_name}
+            qry = ServiceOperationQuery(
+                self, "GetFollowersFor", params, None, None, return_type
+            )
+            self.context.add_query(qry)
+
+        if isinstance(account, User):
+
+            def _account_loaded():
+                _get_followers_for(account.login_name)
+
+            account.ensure_property("LoginName", _account_loaded)
+        else:
+            _get_followers_for(account)
         return return_type
 
     def get_user_information(self, account_name, site_id):
@@ -153,21 +165,22 @@ class PeopleManager(Entity):
         _ensure_user(user_or_name, _user_resolved)
         return return_type
 
-    def get_properties_for(self, user_or_name):
+    def get_properties_for(self, account):
         """
         Gets user properties for the specified user.
-        :param str or User user_or_name: Specifies the User object or its login name.
+        :param str or User account: Specifies the User object or its login name.
         """
         return_type = PersonProperties(self.context)
 
         def _get_properties_for_inner(account_name):
+            # type: (str) -> None
             params = {"accountName": account_name}
             qry = ServiceOperationQuery(
                 self, "GetPropertiesFor", params, None, None, return_type
             )
             self.context.add_query(qry)
 
-        _ensure_user(user_or_name, _get_properties_for_inner)
+        _ensure_user(account, _get_properties_for_inner)
         return return_type
 
     def get_default_document_library(

office365/sharepoint/userprofiles/person_properties.py

@@ -1,5 +1,6 @@
 from typing import Optional
 
+from office365.runtime.odata.type import ODataType
 from office365.runtime.types.collections import StringCollection
 from office365.sharepoint.entity import Entity
 
@@ -79,6 +80,12 @@ class PersonProperties(Entity):
     def entity_type_name(self):
         return "SP.UserProfiles.PersonProperties"
 
+    def set_property(self, k, v, persist_changes=True):
+        if k == "UserProfileProperties":
+            v = ODataType.parse_key_value_collection(v)
+        super(PersonProperties, self).set_property(k, v)
+        return self
+
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {

office365/sharepoint/userprofiles/user_profile.py

@@ -50,9 +50,8 @@ class UserProfile(Entity):
 
     @property
     def followed_content(self):
-        """
-        Gets a FollowedContent object for the user.
-        """
+        # type: () -> FollowedContent
+        """Gets a FollowedContent object for the user."""
         return self.properties.get(
             "FollowedContent",
             FollowedContent(
@@ -62,9 +61,8 @@ class UserProfile(Entity):
 
     @property
     def personal_site(self):
-        """
-        The PersonalSite property specifies the user's personal site
-        """
+        # type: () -> Site
+        """The PersonalSite property specifies the user's personal site"""
         return self.properties.get(
             "PersonalSite",
             Site(self.context, ResourcePath("PersonalSite", self.resource_path)),

office365/sharepoint/views/view.py

@@ -172,6 +172,7 @@ class View(Entity):
 
     @property
     def view_fields(self):
+        # type: () -> ViewFieldCollection
         """Gets a value that specifies the collection of fields in the list view."""
         return self.properties.get(
             "ViewFields",
@@ -199,6 +200,7 @@ class View(Entity):
 
     @property
     def server_relative_path(self):
+        # type: () -> Optional[SPResPath]
         """Gets the server-relative Path of the View."""
         return self.properties.get("ServerRelativePath", SPResPath())
 

office365/sharepoint/webs/information_collection.py

@@ -3,7 +3,7 @@ from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.webs.information import WebInformation
 
 
-class WebInformationCollection(EntityCollection):
+class WebInformationCollection(EntityCollection[WebInformation]):
     """Specifies a collection of objects containing metadata about a site"""
 
     def __init__(self, context, resource_path=None):

office365/sharepoint/webs/regional_settings.py

@@ -9,6 +9,30 @@ from office365.sharepoint.webs.time_zone import TimeZone, TimeZoneCollection
 class RegionalSettings(Entity):
     """Represents regional settings that are used on the server that is running SharePoint Server."""
 
+    @property
+    def adjust_hijri_days(self):
+        # type: () -> Optional[int]
+        """Specifies the number of days to extend or reduce the current month in Hijri calendars on the site"""
+        return self.properties.get("AdjustHijriDays", None)
+
+    @property
+    def alternate_calendar_type(self):
+        # type: () -> Optional[int]
+        """Gets an alternate calendar type that is used on the site"""
+        return self.properties.get("AlternateCalendarType", None)
+
+    @property
+    def am(self):
+        # type: () -> Optional[str]
+        """Specifies the string that is used to represent time before midday on the site"""
+        return self.properties.get("AM", None)
+
+    @property
+    def calendar_type(self):
+        # type: () -> Optional[int]
+        """Specifies the calendar type that SHOULD be used when processing date values on the site"""
+        return self.properties.get("CalendarType", None)
+
     @property
     def collation(self):
         # type: () -> Optional[int]
@@ -19,12 +43,59 @@ class RegionalSettings(Entity):
         """
         return self.properties.get("Collation", None)
 
+    @property
+    def collation_lcid(self):
+        # type: () -> Optional[int]
+        """Gets the language code identifier (LCID) for the collation rules that are used on the site"""
+        return self.properties.get("CollationLCID", None)
+
     @property
     def date_format(self):
         # type: () -> Optional[int]
         """Gets the date format that is used on the server."""
         return self.properties.get("DateFormat", None)
 
+    @property
+    def date_separator(self):
+        # type: () -> Optional[str]
+        """Gets the separator that is used for dates on the server."""
+        return self.properties.get("DateSeparator", None)
+
+    @property
+    def decimal_separator(self):
+        # type: () -> Optional[str]
+        """Gets the separator that is used for decimals on the server."""
+        return self.properties.get("DecimalSeparator", None)
+
+    @property
+    def digit_grouping(self):
+        # type: () -> Optional[str]
+        """Gets the separator that is used in grouping digits."""
+        return self.properties.get("DigitGrouping", None)
+
+    @property
+    def first_day_of_week(self):
+        # type: () -> Optional[int]
+        """Specifies the first day of the week used in calendars on the server.
+        The possible values are specified in the following table:
+
+        - 0 Sunday
+        - 1 Monday
+        - 2 Tuesday
+        - 3 Wednesday
+        - 4 Thursday
+        - 5 Friday
+        - 6 Saturday
+        """
+        return self.properties.get("FirstDayOfWeek", None)
+
+    @property
+    def first_week_of_year(self):
+        # type: () -> Optional[int]
+        """Specifies the first week of the year used in calendars on the server.
+        Specifies which week of a year is considered the first week."""
+        return self.properties.get("FirstWeekOfYear", None)
+
     @property
     def locale_id(self):
         # type: () -> Optional[int]

office365/sharepoint/webs/web.py

@@ -1,6 +1,6 @@
 # coding=utf-8
 import datetime
-from typing import AnyStr, Optional
+from typing import TYPE_CHECKING, AnyStr, Optional
 
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
@@ -89,6 +89,7 @@ from office365.sharepoint.sitescripts.serialization_result import (
     SiteScriptSerializationResult,
 )
 from office365.sharepoint.sitescripts.utility import SiteScriptUtility
+from office365.sharepoint.translation.resource_entry import SPResourceEntry
 from office365.sharepoint.translation.user_resource import UserResource
 from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
 from office365.sharepoint.ui.applicationpages.peoplepicker.web_service_interface import (
@@ -106,6 +107,9 @@ from office365.sharepoint.webs.regional_settings import RegionalSettings
 from office365.sharepoint.webs.template_collection import WebTemplateCollection
 from office365.sharepoint.webs.theme_info import ThemeInfo
 
+if TYPE_CHECKING:
+    from office365.sharepoint.client_context import ClientContext
+
 
 class Web(SecurableObject):
     """
@@ -549,7 +553,9 @@ class Web(SecurableObject):
         :param int order_by: the column by which to order the Recycle Bin query.
         :param int item_state: Recycle Bin stage of items to return in the query.
         """
-        return_type = RecycleBinItemCollection(self.context)
+        return_type = RecycleBinItemCollection(
+            self.context, self.recycle_bin.resource_path
+        )
         payload = {
             "rowLimit": row_limit,
             "isAscending": is_ascending,
@@ -651,15 +657,14 @@ class Web(SecurableObject):
         return return_type
 
     def get_sharing_link_data(self, link_url):
+        # type: (str) -> ClientResult[SharingLinkData]
         """
         This method determines basic information about the supplied link URL, including limited data about the object
         the link URL refers to and any additional sharing link data if the link URL is a tokenized sharing link
 
         :param str link_url: A URL that is either a tokenized sharing link or a canonical URL for a document
         """
-        return_type = ClientResult(
-            self.context, SharingLinkData()
-        )  # type: ClientResult[SharingLinkData]
+        return_type = ClientResult(self.context, SharingLinkData())
         payload = {"linkUrl": link_url}
         qry = ServiceOperationQuery(
             self, "GetSharingLinkData", None, payload, None, return_type
@@ -669,6 +674,7 @@ class Web(SecurableObject):
 
     @staticmethod
     def get_context_web_theme_data(context):
+        # type: (ClientContext) -> ClientResult[str]
         """
         Get ThemeData for the context web.
 
@@ -1853,12 +1859,52 @@ class Web(SecurableObject):
         # type: () -> Optional[bool]
         return self.properties.get("CustomSiteActionsDisabled", None)
 
+    @property
+    def description_translations(self):
+        """"""
+        return self.properties.get(
+            "DescriptionTranslations", ClientValueCollection(SPResourceEntry)
+        )
+
+    @property
+    def design_package_id(self):
+        # type: () -> Optional[str]
+        """Gets or sets the ID of the Design Package used in this SP.Web.
+
+        A value of Guid.Empty will mean that the default Design Package will be used for this SP.Web.
+        The default is determined by the SP.WebTemplate of this SP.Web."""
+        return self.properties.get("DesignPackageId", None)
+
+    @property
+    def disable_app_views(self):
+        # type: () -> Optional[bool]
+        """"""
+        return self.properties.get("DisableAppViews", None)
+
+    @property
+    def disable_flows(self):
+        # type: () -> Optional[bool]
+        """"""
+        return self.properties.get("DisableFlows", None)
+
     @property
     def id(self):
         # type: () -> Optional[str]
         """Specifies the site identifier for the site"""
         return self.properties.get("Id", None)
 
+    @property
+    def language(self):
+        # type: () -> Optional[int]
+        """Specifies the language code identifier (LCID) for the language that is used on the site"""
+        return self.properties.get("Language", None)
+
+    @property
+    def last_item_modified_date(self):
+        # type: () -> Optional[int]
+        """Specifies when an item was last modified in the site"""
+        return self.properties.get("LastItemModifiedDate", datetime.datetime.min)
+
     @property
     def access_requests_list(self):
         """"""
@@ -2416,9 +2462,11 @@ class Web(SecurableObject):
                 "ClientWebParts": self.client_web_parts,
                 "CurrentUser": self.current_user,
                 "DescriptionResource": self.description_resource,
+                "DescriptionTranslations": self.description_translations,
                 "EffectiveBasePermissions": self.effective_base_permissions,
                 "EventReceivers": self.event_receivers,
                 "HostedApps": self.hosted_apps,
+                "LastItemModifiedDate": self.last_item_modified_date,
                 "ListTemplates": self.list_templates,
                 "MultilingualSettings": self.multilingual_settings,
                 "OneDriveSharedItems": self.onedrive_shared_items,

office365/sharepoint/workflowservices/deployment_service.py

@@ -0,0 +1,9 @@
+from office365.sharepoint.entity import Entity
+
+
+class WorkflowDeploymentService(Entity):
+    """"""
+
+    @property
+    def entity_type_name(self):
+        return "SP.WorkflowServices.WorkflowDeploymentService"

office365/teams/apps/catalog.py

@@ -9,6 +9,7 @@ class AppCatalogs(Entity):
 
     @property
     def teams_apps(self):
+        # type: () -> EntityCollection[TeamsApp]
         """List apps from the Microsoft Teams app catalog."""
         return self.properties.get(
             "teamsApps",

office365/teams/chats/chat.py

@@ -41,6 +41,7 @@ class Chat(Entity):
 
     @property
     def members(self):
+        # type: () -> ConversationMemberCollection
         """A collection of membership records associated with the chat."""
         return self.properties.setdefault(
             "members",
@@ -51,6 +52,7 @@ class Chat(Entity):
 
     @property
     def messages(self):
+        # type: () -> EntityCollection[ChatMessage]
         """A collection of all the messages in the chat. Nullable."""
         return self.properties.get(
             "messages",
@@ -61,6 +63,7 @@ class Chat(Entity):
 
     @property
     def operations(self):
+        # type: () -> EntityCollection[TeamsAsyncOperation]
         """
         A collection of all the Teams async operations that ran or are running on the chat. Nullable.
         """
@@ -75,6 +78,7 @@ class Chat(Entity):
 
     @property
     def tabs(self):
+        # type: () -> EntityCollection[TeamsTab]
         """A collection of all the tabs in the chat."""
         return self.properties.get(
             "tabs",

office365/teams/schedule/schedule.py

@@ -22,6 +22,7 @@ class Schedule(Entity):
 
     @property
     def open_shift_change_requests(self):
+        # type: () -> EntityCollection[OpenShiftChangeRequest]
         """The shifts in the shifts."""
         return self.properties.get(
             "openShiftChangeRequests",
@@ -34,6 +35,7 @@ class Schedule(Entity):
 
     @property
     def shifts(self):
+        # type: () -> EntityCollection[Shift]
         """The shifts in the shifts."""
         return self.properties.get(
             "shifts",
@@ -43,7 +45,8 @@ class Schedule(Entity):
         )
 
     @property
-    def scheduling_group(self):
+    def scheduling_groups(self):
+        # type: () -> EntityCollection[SchedulingGroup]
         """The logical grouping of users in the shifts (usually by role)."""
         return self.properties.get(
             "schedulingGroups",
@@ -56,6 +59,7 @@ class Schedule(Entity):
 
     @property
     def time_off_reasons(self):
+        # type: () -> EntityCollection[TimeOffReason]
         """The set of reasons for a time off in the schedule."""
         return self.properties.get(
             "timeOffReasons",
@@ -70,7 +74,7 @@ class Schedule(Entity):
         if default_value is None:
             property_mapping = {
                 "openShiftChangeRequests": self.open_shift_change_requests,
-                "schedulingGroups": self.scheduling_group,
+                "schedulingGroups": self.scheduling_groups,
                 "timeOffReasons": self.time_off_reasons,
             }
             default_value = property_mapping.get(name, None)