Office365-REST-Python-Client 3.0.0__py3-none-any.whl → 3.2.0__py3-none-any.whl

office365/sharepoint/viva/vivaresources.py

@@ -1,7 +1,67 @@
+from typing_extensions import Self
+
+from office365.runtime.client_result import ClientResult
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
+from office365.sharepoint.viva.resource_link import VivaResourceLink
 
 
 class VivaResources(Entity):
     @property
     def entity_type_name(self) -> str:
         return "Microsoft.SharePoint.EmployeeEngagement.VivaResources"
+
+    def add_link(self, new_link: VivaResourceLink) -> ClientResult[int]:
+        """AddLink operation.
+
+        Args:
+            new_link (VivaResourceLink): newLink parameter
+        """
+        return_type = ClientResult(self.context, int())
+        qry = ServiceOperationQuery(self, "AddLink", None, {"newLink": new_link}, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def remove_link(self, id_: int) -> Self:
+        """RemoveLink operation.
+
+        Args:
+            id_ (int): id parameter
+        """
+        qry = ServiceOperationQuery(self, "RemoveLink", None, {"id": id_}, None, None)
+        self.context.add_query(qry)
+        return self
+
+    def reorder_link(self, link_id: int, prev_link_id: int) -> Self:
+        """ReorderLink operation.
+
+        Args:
+            link_id (int): linkId parameter
+            prev_link_id (int): prevLinkId parameter
+        """
+        qry = ServiceOperationQuery(
+            self, "ReorderLink", None, {"linkId": link_id, "prevLinkId": prev_link_id}, None, None
+        )
+        self.context.add_query(qry)
+        return self
+
+    def update_link(self, updated_link: VivaResourceLink) -> Self:
+        """UpdateLink operation.
+
+        Args:
+            updated_link (VivaResourceLink): updatedLink parameter
+        """
+        qry = ServiceOperationQuery(self, "UpdateLink", None, {"updatedLink": updated_link}, None, None)
+        self.context.add_query(qry)
+        return self
+
+    def update_links(self, links: ClientValueCollection[VivaResourceLink]) -> Self:
+        """UpdateLinks operation.
+
+        Args:
+            links (ClientValueCollection[VivaResourceLink]): links parameter
+        """
+        qry = ServiceOperationQuery(self, "UpdateLinks", None, {"links": links}, None, None)
+        self.context.add_query(qry)
+        return self

office365/sharepoint/webhooks/subscription.py

@@ -1,7 +1,11 @@
 from datetime import datetime
 from typing import Optional, Union
 
+from typing_extensions import Self
+
 from office365.runtime.paths.service_operation import ServiceOperationPath
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.runtime.types.collections import StringCollection
 from office365.sharepoint.entity import Entity
 
 
@@ -42,7 +46,6 @@ class Subscription(Entity):
             self.set_property("expirationDateTime", value)
 
     def set_property(self, name, value, persist_changes=True):
-        # fallback: create a new resource path
         if self._resource_path is None:
             if name == "id":
                 assert self._parent_collection is not None
@@ -52,3 +55,29 @@ class Subscription(Entity):
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Webhooks.Subscription"
+
+    @property
+    def client_state(self) -> Optional[str]:
+        """Gets the clientState property"""
+        return self.properties.get("clientState", None)
+
+    @property
+    def resource(self) -> Optional[str]:
+        """Gets the resource property"""
+        return self.properties.get("resource", None)
+
+    @property
+    def resource_data(self) -> Optional[str]:
+        """Gets the resourceData property"""
+        return self.properties.get("resourceData", None)
+
+    @property
+    def scenarios(self) -> StringCollection:
+        """Gets the scenarios property"""
+        return self.properties.get("scenarios", StringCollection())
+
+    def delete(self) -> Self:
+        """Delete operation."""
+        qry = ServiceOperationQuery(self, "Delete", None, {}, None, None)
+        self.context.add_query(qry)
+        return self

office365/sharepoint/webhooks/subscription_information.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from dataclasses import dataclass, field
 from datetime import datetime
-from typing import Optional
+from typing import Dict, Optional, cast
 
 from office365.runtime.client_value import ClientValue
 from office365.runtime.types.collections import StringCollection
@@ -20,7 +20,7 @@ class SubscriptionInformation(ClientValue):
     scenarios: StringCollection = field(default_factory=StringCollection)
 
     def to_json(self, json_format=None):
-        json = super().to_json(json_format)
+        json = cast(Dict, super().to_json(json_format))
         json["expirationDateTime"] = self.expirationDateTime.isoformat()
         return json
 

office365/sharepoint/webparts/definitions/definition.py

@@ -1,7 +1,10 @@
 from typing import Optional
 
+from typing_extensions import Self
+
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.runtime.types.odata_property import odata
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.webparts.webpart import WebPart
 
@@ -10,7 +13,7 @@ class WebPartDefinition(Entity):
     """Represents a Web Part on a Web Part Page. Provides operations for moving, deleting, and changing the state of
     the Web Part."""
 
-    def close_web_part(self):
+    def close_web_part(self) -> Self:
         """
         Closes the Web Part. If the Web Part is already closed, this method does nothing.
 
@@ -21,7 +24,7 @@ class WebPartDefinition(Entity):
         self.context.add_query(qry)
         return self
 
-    def delete_web_part(self):
+    def delete_web_part(self) -> Self:
         """
         Deletes the Web Part from the page.
         When Scope is User, the current user MUST have permissions to add and delete personalized Web Parts.
@@ -31,7 +34,7 @@ class WebPartDefinition(Entity):
         self.context.add_query(qry)
         return self
 
-    def open_web_part(self):
+    def open_web_part(self) -> Self:
         """
         Opens the Web Part. If the Web Part is already open, this method does nothing.
 
@@ -42,7 +45,7 @@ class WebPartDefinition(Entity):
         self.context.add_query(qry)
         return self
 
-    def save_web_part_changes(self):
+    def save_web_part_changes(self) -> Self:
         """
         Saves changes to the Web Part made by using other properties and methods on the WebPartDefinition object (1).
 
@@ -58,6 +61,7 @@ class WebPartDefinition(Entity):
         """Gets a value that specifies the identifier of the Web Part."""
         return self.properties.get("Id", None)
 
+    @odata(name="WebPart")
     @property
     def web_part(self) -> WebPart:
         """The WebPart object, as specified in section 3.2.5.148, associated with this WebPartDefinition.
@@ -65,12 +69,6 @@ class WebPartDefinition(Entity):
         WebPartDefinition object"""
         return self.properties.get("WebPart", WebPart(self.context, ResourcePath("WebPart", self.resource_path)))
 
-    def get_property(self, name, default_value=None):
-        if default_value is None:
-            property_mapping = {"WebPart": self.web_part}
-            default_value = property_mapping.get(name, None)
-        return super().get_property(name, default_value)
-
     @property
     def zone_id(self) -> Optional[str]:
         """Gets the ZoneId property"""
@@ -79,3 +77,16 @@ class WebPartDefinition(Entity):
     @property
     def entity_type_name(self):
         return "SP.WebParts.WebPartDefinition"
+
+    def move_web_part_to(self, zone_id: str, zone_index: int) -> Self:
+        """MoveWebPartTo operation.
+
+        Args:
+            zone_id (str): zoneID parameter
+            zone_index (int): zoneIndex parameter
+        """
+        qry = ServiceOperationQuery(
+            self, "MoveWebPartTo", None, {"zoneID": zone_id, "zoneIndex": zone_index}, None, None
+        )
+        self.context.add_query(qry)
+        return self

office365/sharepoint/webparts/limited_manager.py

@@ -1,12 +1,11 @@
-from typing import Union
+from typing import Optional, Union
 
 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.runtime.types.odata_property import odata
 from office365.sharepoint.entity import Entity
-from office365.sharepoint.webparts.definitions.collection import (
-    WebPartDefinitionCollection,
-)
+from office365.sharepoint.webparts.definitions.collection import WebPartDefinitionCollection
 from office365.sharepoint.webparts.definitions.definition import WebPartDefinition
 
 
@@ -35,7 +34,6 @@ class LimitedWebPartManager(Entity):
             web_part.ensure_property("Id").after_execute(lambda _: _web_part_loaded())
         else:
             _export_web_part(web_part)
-
         return return_type
 
     def import_web_part(self, web_part_xml: str) -> WebPartDefinition:
@@ -58,21 +56,41 @@ class LimitedWebPartManager(Entity):
         self.context.add_query(qry)
         return return_type
 
+    @odata(name="WebParts")
     @property
     def web_parts(self) -> WebPartDefinitionCollection:
         """A collection of the Web Parts on the Web Part Page available to the current user based
         on the current user’s permissions."""
         return self.properties.get(
-            "WebParts",
-            WebPartDefinitionCollection(self.context, ResourcePath("WebParts", self.resource_path)),
+            "WebParts", WebPartDefinitionCollection(self.context, ResourcePath("WebParts", self.resource_path))
         )
 
     @property
     def entity_type_name(self):
         return "SP.WebParts.LimitedWebPartManager"
 
-    def get_property(self, name, default_value=None):
-        if default_value is None:
-            property_mapping = {"WebParts": self.web_parts}
-            default_value = property_mapping.get(name, None)
-        return super().get_property(name, default_value)
+    @property
+    def has_personalized_parts(self) -> Optional[bool]:
+        """Gets the HasPersonalizedParts property"""
+        return self.properties.get("HasPersonalizedParts", None)
+
+    @property
+    def has_web_part_connections(self) -> Optional[bool]:
+        """Gets the HasWebPartConnections property"""
+        return self.properties.get("HasWebPartConnections", None)
+
+    @property
+    def scope(self) -> Optional[int]:
+        """Gets the Scope property"""
+        return self.properties.get("Scope", None)
+
+    def export_web_part_ex(self, web_part_id: str) -> ClientResult[str]:
+        """ExportWebPartEx operation.
+
+        Args:
+            web_part_id (UUID): webPartId parameter
+        """
+        return_type = ClientResult(self.context, str())
+        qry = ServiceOperationQuery(self, "ExportWebPartEx", None, {"webPartId": web_part_id}, None, return_type)
+        self.context.add_query(qry)
+        return return_type

office365/sharepoint/webs/context_web_information.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import math
 import time
 from dataclasses import dataclass, field
 from typing import Optional
@@ -8,6 +7,11 @@ from typing import Optional
 from office365.runtime.client_value import ClientValue
 from office365.runtime.types.collections import StringCollection
 
+# Conservative fallback when the server omits FormDigestTimeoutSeconds, and a
+# safety margin so a digest is refreshed before it can expire mid-flight.
+_DEFAULT_TIMEOUT_SECONDS = 1800
+_REFRESH_MARGIN_SECONDS = 60
+
 
 @dataclass
 class ContextWebInformation(ClientValue):
@@ -19,14 +23,15 @@ class ContextWebInformation(ClientValue):
     SiteFullUrl: Optional[str] = None
     SupportedSchemaVersions: StringCollection = field(default_factory=StringCollection)
     WebFullUrl: Optional[str] = None
-    _valid_from: float = 0.0
+    # Set at construction time (which is when the digest is fetched/mapped);
+    # excluded from the public constructor and repr.
+    _valid_from: float = field(default_factory=time.time, init=False, repr=False)
 
     @property
-    def is_valid(self):
-        """
-        Determines whether FormDigest has been expired or not
-        """
-        if self.FormDigestTimeoutSeconds is None:
+    def is_valid(self) -> bool:
+        """Whether the form digest is still valid (with a refresh margin)."""
+        if self.FormDigestValue is None:
             return False
-        expires_in_sec = math.ceil(time.time() - self._valid_from)
-        return expires_in_sec < self.FormDigestTimeoutSeconds
+        timeout = self.FormDigestTimeoutSeconds or _DEFAULT_TIMEOUT_SECONDS
+        elapsed = time.time() - self._valid_from
+        return elapsed + _REFRESH_MARGIN_SECONDS < timeout

office365/sharepoint/webs/regional_settings.py

@@ -1,8 +1,10 @@
 from typing import Optional
 
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.types.odata_property import odata
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.sites.language_collection import LanguageCollection
+from office365.sharepoint.webs.calendar_type import CalendarType
 from office365.sharepoint.webs.time_zone import TimeZone, TimeZoneCollection
 
 
@@ -24,10 +26,11 @@ class RegionalSettings(Entity):
         """Specifies the string that is used to represent time before midday on the site"""
         return self.properties.get("AM", None)
 
+    @odata(name="CalendarType")
     @property
-    def calendar_type(self) -> Optional[int]:
+    def calendar_type(self) -> Optional[CalendarType]:
         """Specifies the calendar type that SHOULD be used when processing date values on the site"""
-        return self.properties.get("CalendarType", None)
+        return self.properties.get("CalendarType", CalendarType.Unknown)
 
     @property
     def collation(self) -> Optional[int]:
@@ -149,35 +152,28 @@ class RegionalSettings(Entity):
         """Gets a number that represents the work days of Web site calendars."""
         return self.properties.get("WorkDays", None)
 
+    @odata(name="TimeZone")
     @property
-    def time_zone(self):
+    def time_zone(self) -> TimeZone:
         """Gets the time zone that is used on the server."""
         return self.properties.get(
             "TimeZone",
             TimeZone(self.context, ResourcePath("TimeZone", self.resource_path)),
         )
 
+    @odata(name="TimeZones")
     @property
-    def time_zones(self):
+    def time_zones(self) -> TimeZoneCollection:
         """Gets the collection of time zones used in a server farm."""
         return self.properties.get(
             "TimeZones",
             TimeZoneCollection(self.context, ResourcePath("TimeZones", self.resource_path)),
         )
 
+    @odata(name="InstalledLanguages")
     @property
-    def installed_languages(self):
+    def installed_languages(self) -> LanguageCollection:
         return self.properties.get(
             "InstalledLanguages",
             LanguageCollection(self.context, ResourcePath("InstalledLanguages", self.resource_path)),
         )
-
-    def get_property(self, name, default_value=None):
-        if default_value is None:
-            property_mapping = {
-                "TimeZones": self.time_zones,
-                "TimeZone": self.time_zone,
-                "InstalledLanguages": self.installed_languages,
-            }
-            default_value = property_mapping.get(name, None)
-        return super().get_property(name, default_value)

office365/sharepoint/webs/templates/__init__.py

@@ -0,0 +1,11 @@
+"""SharePoint web (site) templates — the template entity, collection, and catalog."""
+
+from office365.sharepoint.webs.templates.collection import WebTemplateCollection
+from office365.sharepoint.webs.templates.template import WebTemplate
+from office365.sharepoint.webs.templates.type import WebTemplateType
+
+__all__ = [
+    "WebTemplate",
+    "WebTemplateCollection",
+    "WebTemplateType",
+]

office365/sharepoint/webs/templates/type.py

@@ -2,40 +2,99 @@ from enum import Enum
 
 
 class WebTemplateType(Enum):
-    """Enum representing SharePoint web templates with their internal names and values."""
+    """SharePoint web (site) templates — internal name plus configuration id.
+
+    The value is the ``WebTemplate`` passed to ``WebCreationInformation`` (the
+    ``Name#Configuration`` string returned by ``Get-SpoWebTemplate``). The catalog
+    below is the union of the classic on-premises site definitions and the
+    Microsoft 365 templates; the classic ones that have no Microsoft 365
+    equivalent are the migration assessment's unsupported set.
+
+    See https://techcommunity.microsoft.com/discussions/sharepointdev/sharepoint-site-templates/2093214
+    """
 
     def __str__(self):
         return self.value
 
-    # Global/Common Templates
-    GLOBAL = "GLOBAL#0"  # Global template (classic team site)
+    @property
+    def name_part(self) -> str:
+        """The template name without the ``#configuration`` suffix (e.g. ``"STS"``)."""
+        return self.value.split("#", 1)[0]
+
+    # Global / common
+    GLOBAL = "GLOBAL#0"  # Global template
     STS = "STS#0"  # Classic team site
+    BLANK_SITE = "STS#1"  # Blank site
+    DOCUMENT_WORKSPACE = "STS#2"  # Document workspace
     STS_MODERN = "STS#3"  # Modern team site
     GROUP = "GROUP#0"  # M365 Group-connected team site
 
-    # Publishing Templates
-    BLANK_INTERNET = "BLANKINTERNET#0"  # Publishing portal
+    # Publishing
+    BLANK_INTERNET = "BLANKINTERNET#0"  # Publishing site
+    PRESS_RELEASES = "BLANKINTERNET#1"  # Press releases site
+    PUBLISHING_WITH_WORKFLOW = "BLANKINTERNET#2"  # Publishing site with workflow
+    PUBLISHING_PORTAL = "BLANKINTERNETCONTAINER#0"  # Publishing portal
     CMS_PUBLISHING = "CMSPUBLISHING#0"  # Publishing site
     ENTERPRISE_WIKI = "ENTERWIKI#0"  # Enterprise wiki
 
-    # Collaboration Templates
-    DOCUMENT_WORKSPACE = "STS#2"  # Document workspace
+    # Collaboration
     BLOG = "BLOG#0"  # Blog site
     WIKI = "WIKI#0"  # Wiki site
     PROJECT_SITE = "PROJECTSITE#0"  # Project site
+    GROUP_WORK_SITE = "SGS#0"  # Group work site
+    COMMUNITY_SITE = "COMMUNITY#0"  # Community site
+    COMMUNITY_AREA = "SPSCOMMU#0"  # Community area
 
-    # Meeting Workspaces
+    # Meeting workspaces
     MEETING_BASIC = "MPS#0"  # Basic meeting workspace
     MEETING_BLANK = "MPS#1"  # Blank meeting workspace
+    MEETING_DECISION = "MPS#2"  # Decision meeting workspace
+    MEETING_SOCIAL = "MPS#3"  # Social meeting workspace
+    MEETING_MULTIPAGE = "MPS#4"  # Multipage meeting workspace
 
-    # Special Templates
-    SEARCH_CENTER = "SRCHCEN#0"  # Search center
-    BI_CENTER = "BICENTER#0"  # Business Intelligence Center
-    DEV_SITE = "DEV#0"  # Developer site
+    # Search / catalog
+    SEARCH_CENTER = "SRCHCEN#0"  # Enterprise search center
+    BASIC_SEARCH_CENTER = "SRCHCENTERLITE#0"  # Basic search center
+    FAST_SEARCH_CENTER = "SRCHCENTERFAST#0"  # FAST search center
     APP_CATALOG = "APPCATALOG#0"  # App catalog
+    PRODUCT_CATALOG = "PRODUCTCATALOG#0"  # Product catalog
+    DEV_SITE = "DEV#0"  # Developer site
     COMMUNICATION_SITE = "SITEPAGEPUBLISHING#0"  # Communication site
 
-    # Custom/Add-on Templates
-    COMMUNITY_SITE = "COMMUNITY#0"  # Community site
-    PRODUCT_CATALOG = "PRODUCTCATALOG#0"  # Product catalog
+    # Records / document centers
+    DOCUMENT_CENTER = "BDR#0"  # Document center
     RECORDS_CENTER = "OFFILE#0"  # Records center
+    VISIO_PROCESS_REPOSITORY = "visprus#0"  # Visio process repository
+
+    # Business intelligence / reporting
+    BI_CENTER = "BICENTER#0"  # Business Intelligence Center
+    BUSINESS_INTELLIGENCE_CENTER = "PPSMASite#0"  # Business Intelligence Center
+    REPORT_CENTER = "SPSREPORTCENTER#0"  # Report center
+
+    # Access services web databases
+    ACCESS_SERVICES = "ACCSRV#0"  # Access services site
+    ASSETS_WEB_DATABASE = "ACCSRV#1"  # Assets web database
+    CHARITABLE_CONTRIBUTIONS_WEB_DATABASE = "ACCSRV#3"  # Charitable contributions web database
+    CONTACTS_WEB_DATABASE = "ACCSRV#4"  # Contacts web database
+    PROJECTS_WEB_DATABASE = "ACCSRV#5"  # Projects web database
+    ISSUES_WEB_DATABASE = "ACCSRV#6"  # Issues web database
+
+    # Administration / personal / legacy portals
+    CENTRAL_ADMIN = "CENTRALADMIN#0"  # Central administration site
+    TENANT_ADMIN = "TENANTADMIN#0"  # Tenant administration site
+    SHAREPOINT_ONLINE_TENANT_ADMIN = "TenantAdminSpo#0"  # SharePoint Online tenant admin
+    SHARED_SERVICES_ADMINISTRATION = "OSRV#0"  # Shared services administration site
+    SHAREPOINT_PORTAL_SERVER_SITE = "SPS#0"  # SharePoint Portal Server site
+    SHAREPOINT_PORTAL_PERSONAL_SPACE = "SPSPERS#0"  # SharePoint Portal Server personal space
+    PERSONALIZATION_SITE = "SPSMSITE#0"  # Personalization site
+    MY_SITE_HOST = "SPSMSITEHOST#0"  # My Site host
+    CONTENTS_AREA = "SPSTOC#0"  # Contents area template
+    TOPIC_AREA = "SPSTOPIC#0"  # Topic area template
+    NEWS_SITE = "SPSNEWS#0"  # News site
+    NEWS_HOME = "SPSNHOME#0"  # News home
+    SITE_DIRECTORY = "SPSSITES#0"  # Site directory
+    COLLABORATION_PORTAL = "SPSPORTAL#0"  # Collaboration portal
+    PROFILES = "PROFILES#0"  # Profiles
+    EXPRESS_TEAM_SITE = "EXPRESS#0"  # Express team site
+    EXPRESS_HOSTED_SITE = "EHS#0"  # Express hosted site
+    POWERPOINT_BROADCAST = "PowerPointBroadcast#0"  # PowerPoint broadcast site

office365/sharepoint/webs/time_zone.py

@@ -1,6 +1,8 @@
 from datetime import datetime
 from typing import Optional
 
+from typing_extensions import Self
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
@@ -11,22 +13,23 @@ from office365.sharepoint.webs.time_zone_information import TimeZoneInformation
 class TimeZone(Entity):
     """Represents the time zone setting that is implemented on a SharePoint Web site."""
 
-    def local_time_to_utc(self, date: datetime) -> ClientResult:  # type: ignore[type-arg]
+    def local_time_to_utc(self, date: datetime) -> ClientResult[datetime]:
         """Converts the specified date from local time to Coordinated Universal Time (UTC).
 
         Args:
             date (datetime): The local date and time value to convert.
         """
-        result = ClientResult(self.context)
-        qry = ServiceOperationQuery(self, "LocalTimeToUTC", [date], None, None, result)
+        result = ClientResult[datetime](self.context, datetime.min)
+        params = {"date": date.isoformat()}
+        qry = ServiceOperationQuery(self, "LocalTimeToUTC", None, params, None, result)
         self.context.add_query(qry)
         return result
 
-    def set_id(self, _id):
+    def set_id(self, id_) -> Self:
         """Args:
-        _id (int):
+        id_ (int):
         """
-        qry = ServiceOperationQuery(self, "SetId", [_id], None, None, None)
+        qry = ServiceOperationQuery(self, "SetId", [id_], None, None, None)
         self.context.add_query(qry)
         return self