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

office365/onedrive/drives/drive.py

@@ -12,6 +12,7 @@ from office365.onedrive.driveitems.system_facet import SystemFacet
 from office365.onedrive.drives.quota import Quota
 from office365.onedrive.internal.paths.root import RootPath
 from office365.onedrive.lists.list import List
+from office365.onedrive.recyclebin.recyclebin import RecycleBin
 from office365.onedrive.sharepoint.ids import SharePointIds
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.create_entity import CreateEntityQuery
@@ -198,6 +199,14 @@ class Drive(BaseItem):
         """Gets the list property"""
         return self.properties.get("list", List(self.context, ResourcePath("list", self.resource_path)))
 
+    @property
+    def recycle_bin(self) -> RecycleBin:
+        """Represents a container for a collection of recycleBinItem resources in a SharePoint site or a
+        SharePoint Embedded fileStorageContainer."""
+        return self.properties.get(
+            "recycleBin", RecycleBin(self.context, ResourcePath("recycleBin", self.resource_path))
+        )
+
     @property
     def entity_type_name(self) -> str:
         return "microsoft.graph.Drive"

office365/onedrive/drives/quota.py

@@ -1,7 +1,8 @@
 from __future__ import annotations
 
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 
+from office365.onedrive.storage_plan_information import StoragePlanInformation
 from office365.runtime.client_value import ClientValue
 
 
@@ -15,3 +16,10 @@ class Quota(ClientValue):
     deleted: int | None = None
     remaining: int | None = None
     state: str | None = None
+    total: int | None = None
+    used: int | None = None
+    storagePlanInformation: StoragePlanInformation = field(default_factory=StoragePlanInformation)
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.Quota"

office365/onedrive/files/file.py

@@ -17,3 +17,7 @@ class File(ClientValue):
     hashes: str | None = None
     mimeType: str | None = None
     processingMetadata: str | None = field(default=None, init=False)
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.File"

office365/onedrive/files/system_info.py

@@ -13,3 +13,7 @@ class FileSystemInfo(ClientValue):
     createdDateTime: str | None = None
     lastAccessedDateTime: str | None = None
     lastModifiedDateTime: str | None = None
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.FileSystemInfo"

office365/onedrive/filestorage/containertypes/app_permission.py

@@ -2,4 +2,23 @@ from office365.runtime.client_value import ClientValue
 
 
 class FileStorageContainerTypeAppPermission(ClientValue):
-    pass
+    none = "0"
+    readContent = "1"
+    writeContent = "2"
+    manageContent = "3"
+    create = "4"
+    delete = "5"
+    read = "6"
+    write = "7"
+    enumeratePermissions = "8"
+    addPermissions = "9"
+    updatePermissions = "10"
+    deletePermissions = "11"
+    deleteOwnPermission = "12"
+    managePermissions = "13"
+    full = "14"
+    unknownFutureValue = "15"
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.FileStorageContainerTypeAppPermission"

office365/onedrive/filestorage/containertypes/billing_classification.py

@@ -17,3 +17,11 @@ class FileStorageContainerBillingClassification(str, Enum):
     Standard = "standard"
     DirectToCustomer = "directToCustomer"
     UnknownFutureValue = "unknownFutureValue"
+    standard = "0"
+    trial = "1"
+    directToCustomer = "2"
+    unknownFutureValue = "3"
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.FileStorageContainerBillingClassification"

office365/onedrive/filestorage/containertypes/billing_status.py

@@ -17,3 +17,10 @@ class FileStorageContainerBillingStatus(str, Enum):
     Warning = "warning"
     Expired = "expired"
     UnknownFutureValue = "unknownFutureValue"
+    invalid = "0"
+    valid = "1"
+    unknownFutureValue = "2"
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.FileStorageContainerBillingStatus"

office365/onedrive/filestorage/containertypes/settings_override.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class FileStorageContainerTypeSettingsOverride(Enum):
+    urlTemplate = "0"
+    isDiscoverabilityEnabled = "1"
+    isSearchEnabled = "2"
+    isItemVersioningEnabled = "3"
+    itemMajorVersionLimit = "4"
+    maxStoragePerContainerInBytes = "5"
+    unknownFutureValue = "6"
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.FileStorageContainerTypeSettingsOverride"

office365/onedrive/folders/folder.py

@@ -15,3 +15,7 @@ class Folder(ClientValue):
 
     childCount: int | None = None
     view: FolderView | None = None
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.Folder"

office365/onedrive/internal/paths/shared.py

@@ -6,9 +6,7 @@ from office365.runtime.paths.v4.entity import EntityPath
 
 def _url_to_shared_token(url: str) -> str:
     """Converts url into shared token"""
-    value = base64.b64encode(url.encode("ascii")).decode("ascii")
-    if value.endswith("="):
-        value = value[:-1]
+    value = base64.b64encode(url.encode("utf-8")).decode("ascii").rstrip("=")
     return "u!" + value.replace("/", "_").replace("+", "-")
 
 

office365/onedrive/internal/paths/site.py

@@ -1,6 +1,7 @@
+from urllib.parse import urlparse
+
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.paths.v4.entity import EntityPath
-from office365.runtime.utilities import urlparse
 
 
 class SitePath(EntityPath):

office365/onedrive/listitems/collection.py

@@ -2,8 +2,8 @@ from typing import TYPE_CHECKING
 
 from typing_extensions import Self
 
+from office365.delta_collection import DeltaCollection
 from office365.directory.permissions.require_permission import require_permission
-from office365.entity_collection import EntityCollection
 from office365.onedrive.listitems.list_item import ListItem
 from office365.runtime.http.request_options import RequestOptions
 from office365.runtime.paths.resource_path import ResourcePath
@@ -12,7 +12,7 @@ if TYPE_CHECKING:
     from office365.graph_client import GraphClient
 
 
-class ListItemCollection(EntityCollection[ListItem]):
+class ListItemCollection(DeltaCollection[ListItem]):
     """Represents a collection of SharePoint/OneDrive list items with enhanced query capabilities.
 
     Provides methods to:

office365/onedrive/lists/info.py

@@ -14,3 +14,7 @@ class ListInfo(ClientValue):
     template: str | None = None
     contentTypesEnabled: bool = False
     hidden: bool = False
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.ListInfo"

office365/onedrive/operations/pending.py

@@ -11,3 +11,7 @@ class PendingOperations(ClientValue):
     """Indicates that one or more operations that might affect the state of the driveItem are pending completion."""
 
     pendingContentUpdate: PendingContentUpdate | None = field(default_factory=PendingContentUpdate)
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.PendingOperations"

office365/onedrive/operations/public_inner_error.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from office365.onedrive.operations.public_error_detail import PublicErrorDetail
+from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+
+
+@dataclass
+class PublicInnerError(ClientValue):
+    code: str | None = None
+    details: ClientValueCollection[PublicErrorDetail] = field(
+        default_factory=lambda: ClientValueCollection(PublicErrorDetail)
+    )
+    message: str | None = None
+    target: str | None = None
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.PublicInnerError"

office365/onedrive/sensitivitylabels/usagerights.py

@@ -22,8 +22,8 @@ class UsageRights(Enum):
     encryptedProtectionTypeNotSupportedException = "131072"
     purviewClaimsChallengeNotSupportedException = "262144"
     exception = "524288"
-    # unknownFutureValue = "1048576"
     labelNotFoundException = "1048576"
+    unknownFutureValue = "2097152"
 
     @property
     def entity_type_name(self):

office365/onedrive/share_point_migration_job_error_level.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class SharePointMigrationJobErrorLevel(Enum):
+    important = "0"
+    warning = "1"
+    error = "2"
+    fatalError = "3"
+    unknownFutureValue = "4"
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.SharePointMigrationJobErrorLevel"

office365/onedrive/share_point_migration_object_type.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class SharePointMigrationObjectType(Enum):
+    site = "0"
+    web = "1"
+    folder = "2"
+    list = "3"
+    listItem = "4"
+    file = "5"
+    alert = "6"
+    sharedWithObject = "7"
+    invalid = "8"
+    unknownFutureValue = "9"
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.SharePointMigrationObjectType"

office365/onedrive/shares/shared.py

@@ -18,3 +18,7 @@ class Shared(ClientValue):
     scope: str | None = None
     sharedBy: IdentitySet | None = field(default_factory=IdentitySet)
     sharedDateTime: datetime | None = None
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.Shared"

office365/onedrive/sites/collection.py

@@ -15,3 +15,7 @@ class SiteCollection(ClientValue):
     hostname: str | None = None
     dataLocationCode: str | None = None
     archivalDetails: SiteArchivalDetails | None = field(default_factory=SiteArchivalDetails)
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.SiteCollection"

office365/onedrive/sites/sites_with_root.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from office365.entity_collection import EntityCollection
+from office365.delta_collection import DeltaCollection
 from office365.onedrive.internal.paths.root import RootPath
 from office365.onedrive.internal.paths.site import SitePath
 from office365.onedrive.sites.site import Site
@@ -10,7 +10,7 @@ from office365.runtime.queries.read_entity import ReadEntityQuery
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 
 
-class SitesWithRoot(EntityCollection[Site]):
+class SitesWithRoot(DeltaCollection[Site]):
     """Sites container"""
 
     def __init__(self, context, resource_path=None):
@@ -59,7 +59,7 @@ class SitesWithRoot(EntityCollection[Site]):
         multiple properties when retrieving the search results.
         """
         return_type = SitesWithRoot(self.context, ResourcePath("sites"))
-        return_type.query_options.custom["search"] = query_text
+        return_type.query_options.custom["$search"] = query_text
         self.context.load(return_type)
         return return_type
 

office365/onedrive/sites/website.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from office365.onedrive.sites.website_type import WebsiteType
+from office365.runtime.client_value import ClientValue
+
+
+@dataclass
+class Website(ClientValue):
+    address: str | None = None
+    displayName: str | None = None
+    type: WebsiteType = WebsiteType.other
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.Website"

office365/onedrive/sites/website_type.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class WebsiteType(Enum):
+    other = "0"
+    home = "1"
+    work = "2"
+    blog = "3"
+    profile = "4"
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.WebsiteType"

office365/onedrive/termstore/groups/collection.py

@@ -1,7 +1,6 @@
 from office365.directory.permissions.require_permission import require_permission
 from office365.entity_collection import EntityCollection
 from office365.onedrive.termstore.groups.group import Group
-from office365.runtime.client_request_exception import ClientRequestException, DuplicatedObjectException
 
 
 class GroupCollection(EntityCollection[Group]):
@@ -31,14 +30,8 @@ class GroupCollection(EntityCollection[Group]):
         """Returns the group with the specified name."""
         return self.single(f"displayName eq '{name}'")
 
-    def get_or_add(self, name: str) -> Group:
+    def ensure(self, name: str) -> Group:
         """Gets existing group by name or creates a new one (idempotent)."""
-        group = self.add(name)
+        from office365.runtime.queries.get_or_create import create_or_get
 
-        def _on_name_exists(error: ClientRequestException):
-            if not isinstance(error, DuplicatedObjectException):
-                raise error
-            self.get_by_name(name).after_execute(lambda existing: group.copy_from(existing), execute_first=True)
-
-        group.on_error(_on_name_exists)
-        return group
+        return create_or_get(create=lambda: self.add(name), find=lambda: self.get_by_name(name))

office365/onedrive/termstore/groups/group.py

@@ -1,15 +1,20 @@
 from __future__ import annotations
 
-from typing import Self
+from typing_extensions import Self
 
 from office365.entity import Entity
 from office365.onedrive.termstore.sets.collection import SetCollection
+from office365.onedrive.termstore.sets.set import Set
 from office365.runtime.paths.resource_path import ResourcePath
 
 
 class Group(Entity):
     """Term Group"""
 
+    def ensure_set(self, name: str) -> Set:
+        """Gets existing set by name or creates a new one (idempotent)."""
+        return self.sets.ensure_set(name)
+
     def delete_object(self) -> Self:
         def _delete_group():
             super(Group, self).delete_object()

office365/onedrive/termstore/relation_type.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class RelationType(Enum):
+    pin = "0"
+    reuse = "1"
+    unknownFutureValue = "2"
+
+    @property
+    def entity_type_name(self) -> str:
+        return "microsoft.graph.termStore.RelationType"

office365/onedrive/termstore/sets/collection.py

@@ -6,7 +6,6 @@ from office365.directory.permissions.require_permission import require_permissio
 from office365.entity_collection import EntityCollection
 from office365.onedrive.termstore.sets.name import LocalizedName
 from office365.onedrive.termstore.sets.set import Set
-from office365.runtime.client_request_exception import ClientRequestException, DuplicatedObjectException
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.v4.entity import EntityPath
 from office365.runtime.queries.create_entity import CreateEntityQuery
@@ -74,14 +73,8 @@ class SetCollection(EntityCollection[Set]):
 
         return return_type
 
-    def get_or_add(self, name: str) -> Set:
+    def ensure_set(self, name: str) -> Set:
         """Gets existing set by name or creates a new one (idempotent)."""
-        term_set = self.add(name)
+        from office365.runtime.queries.get_or_create import create_or_get
 
-        def _on_name_exists(error: ClientRequestException):
-            if not isinstance(error, DuplicatedObjectException):
-                raise error
-            self.get_by_name(name).after_execute(lambda existing: term_set.copy_from(existing), execute_first=True)
-
-        term_set.on_error(_on_name_exists)
-        return term_set
+        return create_or_get(create=lambda: self.add(name), find=lambda: self.get_by_name(name))

office365/onedrive/termstore/store.py

@@ -1,18 +1,15 @@
 from __future__ import annotations
 
-import json
-from os import PathLike
 from typing import Optional
 
 from typing_extensions import Self
 
 from office365.entity import Entity
 from office365.onedrive.termstore.groups.collection import GroupCollection
+from office365.onedrive.termstore.groups.group import Group
 from office365.onedrive.termstore.sets.collection import SetCollection
-from office365.onedrive.termstore.store_exporter import StoreExporter
-from office365.onedrive.termstore.store_importer import StoreImporter
+from office365.onedrive.termstore.store_manager import StoreManager
 from office365.onedrive.termstore.terms.collection import TermCollection
-from office365.runtime.client_result import ClientResult
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.types.collections import StringCollection
 from office365.runtime.types.odata_property import odata
@@ -21,33 +18,21 @@ from office365.runtime.types.odata_property import odata
 class Store(Entity):
     """Represents a taxonomy term store."""
 
-    def search_term(self, search_label: str) -> TermCollection:
-        return_type = TermCollection(self.context)
-
-        def _on_terms_loaded(terms: TermCollection):
-            for t in terms:
-                if t.display_name == search_label:
-                    return_type.add_child(t)
-
-        def _on_sets_loaded(sets: SetCollection):
-            for s in sets:
-                s.terms.get().after_execute(lambda terms: _on_terms_loaded(terms))
+    def ensure_group(self, name: str) -> Group:
+        """Gets existing group by name or creates a new one (idempotent)."""
+        return self.groups.ensure(name)
 
-        def _on_groups_loaded(groups: GroupCollection):
-            for g in groups:
-                g.sets.get().after_execute(lambda sets: _on_sets_loaded(sets))
-
-        self.groups.get().after_execute(lambda groups: _on_groups_loaded(groups))
-        return return_type
+    def search_term(self, search_label: str) -> TermCollection:
+        """Search for a term by label across all sets in the term store."""
+        return StoreManager(self).search_term(search_label)
 
-    def export_to_json(self) -> ClientResult[list]:
-        return StoreExporter(self).export()
+    def get_all_terms(self) -> TermCollection:
+        """Flatten the whole term store into a single ``TermCollection`` (deferred)."""
+        return StoreManager(self).get_all_terms()
 
-    def import_from_json(self, path: str | PathLike) -> Self:
-        """Import term store hierarchy from a JSON file."""
-        with open(path) as f:
-            data = json.load(f)
-        StoreImporter(self).import_from_data(data)
+    def from_json(self, data: list[dict]) -> Self:
+        """Import a term hierarchy from a list of group dicts (deferred)."""
+        StoreManager(self).from_json(data)
         return self
 
     @property

office365/onedrive/termstore/store_manager.py

@@ -0,0 +1,128 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from office365.onedrive.termstore.groups.collection import GroupCollection
+from office365.onedrive.termstore.sets.collection import SetCollection
+from office365.onedrive.termstore.terms.collection import TermCollection
+from office365.runtime.client_result import ClientResult
+
+if TYPE_CHECKING:
+    from office365.onedrive.termstore.store import Store
+
+
+class StoreManager:
+    """Traverse, search, and import the term store hierarchy.
+
+    All operations are deferred: queries are queued and run with a single
+    ``execute_query()``. ``get_all_terms()`` returns a flattened ``TermCollection``
+    with each term's ``children`` attached, so the standard collection pipeline
+    (``to_json()``, ``write_csv``) can serialize the full tree.
+    """
+
+    def __init__(self, store: Store):
+        self.store = store
+
+    def get_all_terms(self) -> TermCollection:
+        """Flatten the whole term store into a single ``TermCollection``.
+
+        Traverses groups -> sets -> terms -> children and collects every term
+        into one flat collection. No queries run until ``execute_query()``.
+        """
+        all_terms = TermCollection(self.store.context)
+
+        def _on_terms_loaded(terms: TermCollection) -> None:
+            for term in terms:
+                all_terms.add_child(term)
+                term.children.get().after_execute(_on_terms_loaded)
+
+        def _on_sets_loaded(sets: SetCollection) -> None:
+            for term_set in sets:
+                term_set.children.get().after_execute(_on_terms_loaded)
+
+        def _on_groups_loaded(groups: GroupCollection) -> None:
+            for group in groups:
+                group.sets.get().after_execute(_on_sets_loaded)
+
+        self.store.groups.get().after_execute(_on_groups_loaded)
+        return all_terms
+
+    def search_term(self, search_label: str) -> TermCollection:
+        """Search for a term by label across all sets in the term store."""
+        return_type = TermCollection(self.store.context)
+
+        def _on_terms_loaded(terms: TermCollection) -> None:
+            for t in terms:
+                if t.display_name == search_label:
+                    return_type.add_child(t)
+
+        def _on_sets_loaded(sets: SetCollection) -> None:
+            for s in sets:
+                s.terms.get().after_execute(lambda terms: _on_terms_loaded(terms))
+
+        def _on_groups_loaded(groups: GroupCollection) -> None:
+            for g in groups:
+                g.sets.get().after_execute(lambda sets: _on_sets_loaded(sets))
+
+        self.store.groups.get().after_execute(lambda groups: _on_groups_loaded(groups))
+        return return_type
+
+    def from_json(self, data: list[dict]) -> Store:
+        """Import a term hierarchy from a list of group dicts.
+
+        Args:
+            data: List of ``{name, sets: [{name, children: [{name, children: []}]}]}``.
+
+        Returns:
+            self.store for chaining — call ``execute_query()`` to process.
+        """
+        for group_data in data:
+            group = self.store.ensure_group(group_data["name"])
+            for set_data in group_data.get("sets", []):
+                term_set = group.ensure_set(set_data["name"])
+                self._create_terms(term_set.children, set_data.get("children", []))
+        return self.store
+
+    def to_json(self) -> ClientResult[list]:
+        """Export the term hierarchy as nested JSON.
+
+        Builds ``[{name, sets: [{name, children: [{name, children: []}]}]}]`` —
+        the symmetric counterpart of :meth:`from_json`. Deferred, like every
+        other operation here: ``execute_query()`` then read ``result.value``.
+
+            >>> result = store_manager.to_json().execute_query()
+            >>> tree = result.value
+        """
+        return_type = ClientResult(self.store.context, [])
+        tree: list = []
+
+        def _on_terms_loaded(terms: TermCollection, container: list) -> None:
+            for term in terms:
+                node = {"name": term.display_name, "children": []}
+                container.append(node)
+                term.children.get().after_execute(
+                    lambda children, parent=node: _on_terms_loaded(children, parent["children"])
+                )
+
+        def _on_sets_loaded(sets: SetCollection, set_container: list) -> None:
+            for term_set in sets:
+                set_node = {"name": term_set.display_name, "children": []}
+                set_container.append(set_node)
+                term_set.children.get().after_execute(
+                    lambda terms, parent=set_node: _on_terms_loaded(terms, parent["children"])
+                )
+
+        def _on_groups_loaded(groups: GroupCollection) -> None:
+            for group in groups:
+                group_node = {"name": group.display_name, "sets": []}
+                tree.append(group_node)
+                group.sets.get().after_execute(lambda sets, parent=group_node: _on_sets_loaded(sets, parent["sets"]))
+
+        self.store.groups.get().after_execute(_on_groups_loaded)
+        return_type.set_property("__value", tree)
+        return return_type
+
+    def _create_terms(self, collection: TermCollection, terms: list[dict]) -> None:
+        for term_data in terms:
+            node = collection.ensure(term_data["name"])
+            self._create_terms(node.children, term_data.get("children", []))