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

office365/directory/users/activities/activity.py

@@ -4,6 +4,7 @@ from typing import Optional
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.types.json import Json
 from office365.runtime.types.odata_property import odata
 
 
@@ -65,15 +66,48 @@ class UserActivity(Entity):
     @property
     def history_items(self):
         """NavigationProperty/Containment; navigation property to the associated activity."""
-        from office365.directory.users.activities.history_item import (
-            ActivityHistoryItem,
-        )
+        from office365.directory.users.activities.history_item import ActivityHistoryItem
 
         return self.properties.get(
             "historyItems",
-            EntityCollection(
-                self.context,
-                ActivityHistoryItem,
-                ResourcePath("historyItems", self.resource_path),
-            ),
+            EntityCollection(self.context, ActivityHistoryItem, ResourcePath("historyItems", self.resource_path)),
         )
+
+    @property
+    def content_info(self) -> Json:
+        """Gets the contentInfo property"""
+        return self.properties.get("contentInfo", Json())
+
+    @property
+    def content_url(self) -> Optional[str]:
+        """Gets the contentUrl property"""
+        return self.properties.get("contentUrl", None)
+
+    @property
+    def created_date_time(self) -> Optional[datetime]:
+        """Gets the createdDateTime property"""
+        return self.properties.get("createdDateTime", datetime.min)
+
+    @property
+    def expiration_date_time(self) -> Optional[datetime]:
+        """Gets the expirationDateTime property"""
+        return self.properties.get("expirationDateTime", datetime.min)
+
+    @property
+    def fallback_url(self) -> Optional[str]:
+        """Gets the fallbackUrl property"""
+        return self.properties.get("fallbackUrl", None)
+
+    @property
+    def last_modified_date_time(self) -> Optional[datetime]:
+        """Gets the lastModifiedDateTime property"""
+        return self.properties.get("lastModifiedDateTime", datetime.min)
+
+    @property
+    def user_timezone(self) -> Optional[str]:
+        """Gets the userTimezone property"""
+        return self.properties.get("userTimezone", None)
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.UserActivity"

office365/directory/users/settings.py

@@ -1,7 +1,6 @@
 from typing import Optional
 
 from office365.directory.users.insights_settings import UserInsightsSettings
-from office365.directory.users.storage import UserStorage
 from office365.entity import Entity
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.types.odata_property import odata
@@ -12,9 +11,7 @@ class UserSettings(Entity):
     """The current user settings for content discovery."""
 
     @property
-    def contribution_to_content_discovery_as_organization_disabled(
-        self,
-    ) -> Optional[bool]:
+    def contribution_to_content_discovery_as_organization_disabled(self) -> Optional[bool]:
         """Reflects the organization level setting controlling delegate access to the trending API.
         When set to true, the organization doesn't have access to Office Delve. The relevancy of the content
         displayed in Microsoft 365, for example in Suggested sites in SharePoint Home and the Discover view in
@@ -38,21 +35,16 @@ class UserSettings(Entity):
         a user and other items in Microsoft 365, such as documents or sites.
         Get userInsightsSettings through this navigation property."""
         return self.properties.get(
-            "itemInsights",
-            UserInsightsSettings(self.context, ResourcePath("itemInsights", self.resource_path)),
+            "itemInsights", UserInsightsSettings(self.context, ResourcePath("itemInsights", self.resource_path))
         )
 
     @odata(name="shiftPreferences")
     @property
     def shift_preferences(self) -> ShiftPreferences:
         return self.properties.get(
-            "shiftPreferences",
-            ShiftPreferences(self.context, ResourcePath("shiftPreferences", self.resource_path)),
+            "shiftPreferences", ShiftPreferences(self.context, ResourcePath("shiftPreferences", self.resource_path))
         )
 
     @property
-    def storage(self) -> UserStorage:
-        return self.properties.get(
-            "storage",
-            UserStorage(self.context, ResourcePath("storage", self.resource_path)),
-        )
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.UserSettings"

office365/directory/users/user.py

@@ -53,6 +53,7 @@ from office365.onedrive.sites.site import Site
 from office365.onenote.onenote import Onenote
 from office365.outlook.calendar.attendees.base import AttendeeBase
 from office365.outlook.calendar.calendar import Calendar
+from office365.outlook.calendar.collection import CalendarCollection
 from office365.outlook.calendar.dateTimeTimeZone import DateTimeTimeZone
 from office365.outlook.calendar.email_address import EmailAddress
 from office365.outlook.calendar.events.event import Event
@@ -212,7 +213,7 @@ class User(DirectoryObject):
         def _assign_manager(user_id: str | None) -> None:
             if user_id is None:
                 return
-            payload = {"@odata.id": f"https://graph.microsoft.com/v1.0/users/{user_id}"}
+            payload = {"@odata.id": f"{self.context.users.resource_url}/{user_id}"}
             qry = ServiceOperationQuery(self.manager, "$ref", None, payload)
             self.context.add_query(qry).before_execute(_construct_request)
 
@@ -820,10 +821,10 @@ class User(DirectoryObject):
         return self.properties.get("calendar", Calendar(self.context, ResourcePath("calendar", self.resource_path)))
 
     @property
-    def calendars(self) -> EntityCollection[Calendar]:
+    def calendars(self) -> CalendarCollection:
         """The user's calendar groups. Read-only. Nullable."""
         return self.properties.get(
-            "calendars", EntityCollection(self.context, Calendar, ResourcePath("calendars", self.resource_path))
+            "calendars", CalendarCollection(self.context, ResourcePath("calendars", self.resource_path))
         )
 
     @property

office365/directory/users/work_location_update_scope.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class WorkLocationUpdateScope(Enum):
+    currentSegment = "1"
+    currentDay = "2"
+    unknownFutureValue = "3"
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.WorkLocationUpdateScope"

office365/education/related_contact.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from office365.education.contactrelationship import ContactRelationship
+from office365.runtime.client_value import ClientValue
+
+
+@dataclass
+class RelatedContact(ClientValue):
+    accessConsent: bool | None = None
+    displayName: str | None = None
+    emailAddress: str | None = None
+    mobilePhone: str | None = None
+    relationship: ContactRelationship = ContactRelationship.parent
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.RelatedContact"

office365/entity_collection.py

@@ -2,8 +2,6 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any, Dict, Optional, Type, Union, cast
 
-from typing_extensions import Self
-
 from office365.entity import Entity
 from office365.runtime.client_object import ClientObjectT
 from office365.runtime.client_object_collection import ClientObjectCollection
@@ -26,17 +24,6 @@ class EntityCollection(ClientObjectCollection[ClientObjectT]):
         parent: Optional[Entity] = None,
     ) -> None:
         super().__init__(context, item_type, resource_path, parent)
-        self._delta_request_url = None
-
-    def token(self, value: str) -> Self:
-        """Apply delta query
-
-        Args:
-            value (str): If unspecified, enumerates the hierarchy's current state. If latest, returns empty response
-              with latest delta token. If a previous delta token, returns new state since that token.
-        """
-        self.query_options.custom["token"] = value
-        return self
 
     def __getitem__(self, key: Union[int, str]) -> ClientObjectT:
         """Args:
@@ -66,13 +53,6 @@ class EntityCollection(ClientObjectCollection[ClientObjectT]):
             resource_path = EntityPath(None, self.resource_path)
         return super().create_typed_object(initial_properties, resource_path)
 
-    def set_property(self, name: str, value: Any, persist_changes: bool = False) -> Self:
-        if name == self.context.pending_request().json_format.collection_delta:
-            self._delta_request_url = value
-        else:
-            super().set_property(name, value, persist_changes)
-        return self
-
     @property
     def context(self) -> GraphClient:
         from office365.graph_client import GraphClient

office365/externalconnectors/acl_type.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class AclType(Enum):
+    user = "1"
+    group = "2"
+    everyone = "3"
+    everyoneExceptGuests = "4"
+    externalGroup = "5"
+    unknownFutureValue = "6"
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.externalConnectors.AclType"

office365/externalconnectors/binary_operator.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class BinaryOperator(Enum):
+    or_ = "0"
+    and_ = "1"
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.BinaryOperator"

office365/externalconnectors/connection_operation_status.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class ConnectionOperationStatus(Enum):
+    unspecified = "0"
+    inprogress = "1"
+    completed = "2"
+    failed = "3"
+    unknownFutureValue = "4"
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.externalConnectors.ConnectionOperationStatus"

office365/externalconnectors/connection_state.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class ConnectionState(Enum):
+    draft = "1"
+    ready = "2"
+    obsolete = "3"
+    limitExceeded = "4"
+    unknownFutureValue = "5"
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.externalConnectors.ConnectionState"

office365/externalconnectors/external_activity_type.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class ExternalActivityType(Enum):
+    viewed = "1"
+    modified = "2"
+    created = "3"
+    commented = "4"
+    unknownFutureValue = "5"
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.externalConnectors.ExternalActivityType"

office365/externalconnectors/external_item_content_type.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class ExternalItemContentType(Enum):
+    text = "1"
+    html = "2"
+    unknownFutureValue = "3"
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.externalConnectors.ExternalItemContentType"

office365/externalconnectors/identity_type.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class IdentityType(Enum):
+    user = "1"
+    group = "2"
+    externalGroup = "3"
+    unknownFutureValue = "4"
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.externalConnectors.IdentityType"

office365/externalconnectors/label.py

@@ -0,0 +1,65 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class Label(Enum):
+    title = "0"
+    url = "1"
+    createdBy = "2"
+    lastModifiedBy = "3"
+    authors = "4"
+    createdDateTime = "5"
+    lastModifiedDateTime = "6"
+    fileName = "7"
+    fileExtension = "8"
+    unknownFutureValue = "12"
+    containerName = "13"
+    containerUrl = "14"
+    iconUrl = "15"
+    assignedToPeople = "16"
+    closedBy = "17"
+    closedDate = "18"
+    priority = "19"
+    sprintName = "20"
+    tags = "21"
+    severity = "22"
+    state = "23"
+    dueDate = "24"
+    itemParentId = "25"
+    itemPath = "26"
+    itemType = "27"
+    numberOfReactions = "28"
+    parentUrl = "29"
+    priorityNormalized = "30"
+    reportedBy = "31"
+    secondaryId = "32"
+    personEmails = "33"
+    personAddresses = "34"
+    personAnniversaries = "35"
+    personName = "36"
+    personNote = "37"
+    personPhones = "38"
+    personCurrentPosition = "39"
+    personWebAccounts = "40"
+    personWebSite = "41"
+    personSkills = "42"
+    personProjects = "43"
+    personAccount = "44"
+    personAwards = "45"
+    personCertifications = "46"
+    personAssistants = "47"
+    personColleagues = "48"
+    personManager = "49"
+    personAlternateContacts = "50"
+    personEmergencyContacts = "51"
+    personEducationalActivities = "52"
+    personInterests = "53"
+    personLanguages = "54"
+    personPublications = "55"
+    personPatents = "56"
+    personWorkPositions = "57"
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.externalConnectors.Label"

office365/externalconnectors/property_type.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class PropertyType(Enum):
+    string = "0"
+    int64 = "1"
+    double = "2"
+    dateTime = "3"
+    boolean = "4"
+    stringCollection = "5"
+    int64Collection = "6"
+    doubleCollection = "7"
+    dateTimeCollection = "8"
+    unknownFutureValue = "9"
+    principal = "10"
+    principalCollection = "11"
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.externalConnectors.PropertyType"

office365/externalconnectors/rule_operation.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class RuleOperation(Enum):
+    null = "0"
+    equals = "1"
+    notEquals = "2"
+    contains = "3"
+    notContains = "4"
+    lessThan = "5"
+    greaterThan = "6"
+    startsWith = "7"
+    unknownFutureValue = "8"
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.externalConnectors.RuleOperation"

office365/graph_client.py

@@ -65,7 +65,7 @@ from office365.outlook.calendar.rooms.list import RoomList
 from office365.planner.planner import Planner
 from office365.reports.root import ReportRoot
 from office365.runtime.client_runtime_context import ClientRuntimeContext
-from office365.runtime.odata.v4.batch_request import ODataV4BatchRequest
+from office365.runtime.odata.v4.batch_request import DEFAULT_MAX_BATCH_BYTES, ODataV4BatchRequest
 from office365.runtime.odata.v4.json_format import V4JsonFormat
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.search.entity import SearchEntity
@@ -87,6 +87,7 @@ if TYPE_CHECKING:
     from office365.directory.groups.setting import GroupSetting
     from office365.directory.rolemanagement.templates.collection import DirectoryRoleTemplateCollection
     from office365.runtime.client_result import ClientResult
+    from office365.runtime.queries.batch import BatchQuery
     from office365.runtime.types.collections import StringCollection
 
 
@@ -100,6 +101,7 @@ class GraphClient(ClientRuntimeContext):
         scopes: Optional[List[str]] = None,
         token_cache: Any = None,
         environment: AzureEnvironment = AzureEnvironment.Global,
+        authority: Optional[str] = None,
     ):
         """
         Initialize Microsoft Graph client
@@ -111,6 +113,7 @@ class GraphClient(ClientRuntimeContext):
             token_cache: Token cache implementation. Refer
                 https://msal-python.readthedocs.io/en/latest/#msal.SerializableTokenCache
             environment: Azure environment (default: AzureEnvironment.Global)
+            authority: Override the MSAL authority URL (e.g. https://<tenant>.ciamlogin.com)
         """
 
         super().__init__()
@@ -120,6 +123,7 @@ class GraphClient(ClientRuntimeContext):
         self._environment = environment
         self._scopes = scopes
         self._directory: Optional[Directory] = None
+        self._authority = authority
 
     def with_certificate(self, client_id: str, thumbprint: str, private_key: str) -> Self:
         """
@@ -186,9 +190,9 @@ class GraphClient(ClientRuntimeContext):
         self.pending_request().with_device_flow(client_id)
         return self
 
-    def require_application_permission(self, scope: str) -> Self:
+    def require_application_permission(self, *scopes: str) -> Self:
         """
-        Exit if the application lacks the required Graph application permission.
+        Exit if the application lacks at least one of the required Graph application permissions.
 
         Typical usage at the top of example scripts:
 
@@ -198,21 +202,94 @@ class GraphClient(ClientRuntimeContext):
                 .require_application_permission("DeviceManagementConfiguration.Read.All")
             )
 
+            client = (
+                GraphClient(tenant=tenant)
+                .with_client_secret(client_id, secret)
+                .require_application_permission("RoleManagement.Read.Directory", "Directory.Read.All")
+            )
+
         Args:
-            scope: Application permission name (e.g. "DeviceManagementConfiguration.Read.All")
+            *scopes: Application permission names (e.g. "DeviceManagementConfiguration.Read.All");
+                at least one must be granted to the app
         """
         from office365.runtime.client_request_exception import ClientRequestException
 
+        if not scopes:
+            return self
         client_id = self.pending_request().authentication_context.client_id
         try:
             assert client_id is not None
             result = self.get_application_permissions(client_id).execute_query()
-            has_perms = any(role.value == scope for role in result.value)
+            granted = {role.value for role in result.value}
+            has_perms = any(scope in granted for scope in scopes)
+            if not has_perms:
+                print(f"Missing required application permission: need at least one of: {', '.join(scopes)}")
+                sys.exit(1)
+        except ClientRequestException:
+            print(f"Could not verify permissions {scopes}: ensure Application.Read.All is granted.")
+            sys.exit(1)
+        return self
+
+    def require_delegated_permission(self, *scopes: str) -> Self:
+        """
+        Exit if the application lacks at least one of the required Graph delegated permissions.
+
+        Typical usage at the top of example scripts that call delegated APIs (e.g. ``/me``):
+
+            client = (
+                GraphClient(tenant=tenant)
+                .with_username_and_password(client_id, username, password)
+                .require_delegated_permission("User.Read")
+            )
+
+        Args:
+            *scopes: Delegated permission names (e.g. "User.Read");
+                at least one must be granted to the app
+        """
+        from office365.runtime.client_request_exception import ClientRequestException
+
+        if not scopes:
+            return self
+        client_id = self.pending_request().authentication_context.client_id
+        try:
+            assert client_id is not None
+            result = self.get_delegated_permissions(client_id).execute_query()
+            granted = set(result.value)
+            has_perms = any(scope in granted for scope in scopes)
             if not has_perms:
-                print(f"Missing required application permission: {scope}")
+                print(f"Missing required delegated permission: need at least one of: {', '.join(scopes)}")
                 sys.exit(1)
         except ClientRequestException:
-            print(f"Could not verify permission '{scope}' — ensure Application.Read.All is granted.")
+            print(f"Could not verify permissions {scopes}: ensure Application.Read.All is granted.")
+            sys.exit(1)
+        return self
+
+    def require_license(self, *keywords: str) -> Self:
+        """Exit if the tenant has no subscribed SKU matching any of the given keywords.
+
+        Typical usage at the top of example scripts that require a paid
+        add-on license:
+
+            client = (
+                GraphClient(tenant=tenant)
+                .with_client_secret(client_id, client_secret)
+                .require_license("BACKUP")
+            )
+
+        Args:
+            *keywords: Substrings to match against SKU part numbers
+                (case-insensitive); at least one must match
+        """
+        if not keywords:
+            return self
+        skus = self.subscribed_skus.get().execute_query()
+        matched = [
+            s.sku_part_number
+            for s in skus
+            if s.sku_part_number and any(keyword.lower() in s.sku_part_number.lower() for keyword in keywords)
+        ]
+        if not matched:
+            print(f"Missing required license: no subscribed SKU matches: {', '.join(keywords)}")
             sys.exit(1)
         return self
 
@@ -280,27 +357,54 @@ class GraphClient(ClientRuntimeContext):
         self,
         items_per_batch: int = 20,
         success_callback: Optional[Callable[[List[Any]], None]] = None,
-    ):
+        concurrency: int = 1,
+        max_batch_bytes: Optional[int] = None,
+    ) -> Self:
         """
         Execute batched requests
 
+        With ``concurrency`` > 1 the batches run on a thread pool; each batch
+        is an independent HTTP request. Batches are capped by item count
+        (``items_per_batch``) and by estimated payload size (``max_batch_bytes``).
+        Throttled sub-requests (HTTP 429/503) are retried individually, honoring
+        ``Retry-After`` — only the failed sub-requests are re-sent, so successful
+        writes aren't re-applied. ``success_callback`` runs on the caller thread
+        in completion order (not submission order).
+
         Args:
             items_per_batch: Maximum items per batch (default: 20)
             success_callback: Optional callback for successful requests
-        """
+            concurrency: Maximum number of concurrent batch requests (default 1)
+            max_batch_bytes: Maximum estimated batch payload size (default ~3 MB)
+        """
+        max_bytes = DEFAULT_MAX_BATCH_BYTES if max_batch_bytes is None else max_batch_bytes
+        batches = self._split_batches(items_per_batch, max_bytes)
+        if concurrency <= 1:
+            batch_request = ODataV4BatchRequest("", V4JsonFormat())
+            batch_request.beforeExecute += self.pending_request().authenticate_request
+            for qry in batches:
+                batch_request.execute_query_with_retry(qry)
+                if callable(success_callback) and qry.return_type is not None:
+                    success_callback(qry.return_type)
+            return self
+
+        self.pending_request()
+        self._execute_batches_in_parallel(batches, concurrency, success_callback)
+        return self
+
+    def _execute_batch(self, batch_qry: "BatchQuery") -> list[Any]:
+        """Execute a single batch unit on a worker thread (with per-request retry)."""
         batch_request = ODataV4BatchRequest("", V4JsonFormat())
         batch_request.beforeExecute += self.pending_request().authenticate_request
-        while self.has_pending_request:
-            qry = self._get_next_query(items_per_batch)
-            batch_request.execute_query(qry)
-            if callable(success_callback) and qry.return_type is not None:
-                success_callback(qry.return_type)
-        return self
+        batch_request.execute_query_with_retry(batch_qry)
+        return batch_qry.return_types
 
     def pending_request(self) -> GraphRequest:
         """Get or create the pending request"""
         if self._pending_request is None:
-            self._pending_request = GraphRequest(tenant=self._tenant, environment=self._environment)
+            self._pending_request = GraphRequest(
+                tenant=self._tenant, environment=self._environment, authority=self._authority
+            )
             if callable(self._token_callback):
                 self._pending_request.with_access_token(self._token_callback)
         return self._pending_request  # type: ignore[return-value]

office365/graph_request.py

@@ -22,6 +22,7 @@ class GraphRequest(ODataRequest):
         version: GraphVersion = GraphVersion.default(),
         tenant: Optional[str] = None,
         environment: AzureEnvironment = AzureEnvironment.Global,
+        authority: Optional[str] = None,
     ):
         """
         Initialize a Microsoft Graph API request handler.
@@ -30,11 +31,12 @@ class GraphRequest(ODataRequest):
             version: API version (default: "v1.0")
             tenant: Tenant ID or domain name
             environment: Azure environment (default: AzureEnvironment.Global)
+            authority: Override the MSAL authority URL (e.g. https://<tenant>.ciamlogin.com)
         """
         super().__init__("", V4JsonFormat())
         self._version = version
         self._environment = environment
-        self._auth_context = AuthenticationContext(environment=environment, tenant=tenant)
+        self._auth_context = AuthenticationContext(environment=environment, tenant=tenant, authority=authority)
         self.beforeExecute += self.authenticate_request
 
     def with_access_token(self, token_callback: Callable[[], Dict[str, str]]) -> GraphRequest: