redblack-python-sdk 0.1.0__py3-none-any.whl

redblack/resources/restrictions.py

@@ -0,0 +1,146 @@
+"""Restrictions resource operations."""
+
+from __future__ import annotations
+
+from collections.abc import Iterator
+from typing import Literal, overload
+
+from ..models import Restriction, RestrictionExportJob
+from ..odata import DEFAULT_PAGE_SIZE
+from ..pagination import Page
+from ._base import ApiResponseProtocol, HttpInfoMode
+from ._collections import CollectionResource
+from ._exports import ExportJobHandle, ExportOperations, ExportResource
+
+
+class RestrictionsResource(CollectionResource[HttpInfoMode], ExportResource[HttpInfoMode]):
+    """Restrictions, including exports present in the operation contract.
+
+    The narrative export guide lists only accounts and households, while the
+    2026.3.0 operation contract also exposes restrictions.  The method is kept
+    because it is a real documented operation, but live support remains a UAT
+    validation item.
+    """
+
+    LIST_OPERATION_ID = "Restriction_QueryRestrictions"
+    EXPORT_OPERATIONS = ExportOperations(
+        create="Restrictions_ExportJob",
+        status="Restrictions_GetExportJobStatus",
+        file="Restrictions_GetExportFile",
+        body_required=True,
+    )
+    OPERATION_IDS = frozenset(
+        {
+            LIST_OPERATION_ID,
+            EXPORT_OPERATIONS.create,
+            EXPORT_OPERATIONS.status,
+            EXPORT_OPERATIONS.file,
+        }
+    )
+
+    @overload
+    def list(
+        self: RestrictionsResource[Literal[False]],
+        *,
+        filter: str | None = None,
+        order_by: str | None = None,
+        top: int | None = None,
+        skip: int | None = None,
+        count: bool | None = None,
+    ) -> Page[Restriction]: ...
+
+    @overload
+    def list(
+        self: RestrictionsResource[Literal[True]],
+        *,
+        filter: str | None = None,
+        order_by: str | None = None,
+        top: int | None = None,
+        skip: int | None = None,
+        count: bool | None = None,
+    ) -> ApiResponseProtocol[Page[Restriction]]: ...
+
+    def list(
+        self,
+        *,
+        filter: str | None = None,
+        order_by: str | None = None,
+        top: int | None = None,
+        skip: int | None = None,
+        count: bool | None = None,
+    ) -> Page[Restriction] | ApiResponseProtocol[Page[Restriction]]:
+        return self._list(filter=filter, order_by=order_by, top=top, skip=skip, count=count)
+
+    def iter_pages(
+        self,
+        *,
+        filter: str | None = None,
+        order_by: str | None = None,
+        count: bool | None = None,
+        start_skip: int = 0,
+        page_size: int = DEFAULT_PAGE_SIZE,
+        max_items: int | None = None,
+    ) -> Iterator[Page[Restriction]]:
+        return self._iter_pages(
+            filter=filter,
+            order_by=order_by,
+            count=count,
+            start_skip=start_skip,
+            page_size=page_size,
+            max_items=max_items,
+        )
+
+    def iter_all(
+        self,
+        *,
+        filter: str | None = None,
+        order_by: str | None = None,
+        count: bool | None = None,
+        start_skip: int = 0,
+        page_size: int = DEFAULT_PAGE_SIZE,
+        max_items: int | None = None,
+    ) -> Iterator[Restriction]:
+        return self._iter_all(
+            filter=filter,
+            order_by=order_by,
+            count=count,
+            start_skip=start_skip,
+            page_size=page_size,
+            max_items=max_items,
+        )
+
+    @overload
+    def create_export(
+        self: RestrictionsResource[Literal[False]], *, filter: str | None = None
+    ) -> ExportJobHandle[RestrictionExportJob]: ...
+
+    @overload
+    def create_export(
+        self: RestrictionsResource[Literal[True]], *, filter: str | None = None
+    ) -> ApiResponseProtocol[ExportJobHandle[RestrictionExportJob]]: ...
+
+    def create_export(
+        self, *, filter: str | None = None
+    ) -> (
+        ExportJobHandle[RestrictionExportJob]
+        | ApiResponseProtocol[ExportJobHandle[RestrictionExportJob]]
+    ):
+        return self._create_export(filter=filter)
+
+    @overload
+    def get_export(
+        self: RestrictionsResource[Literal[False]], job_id: int
+    ) -> ExportJobHandle[RestrictionExportJob]: ...
+
+    @overload
+    def get_export(
+        self: RestrictionsResource[Literal[True]], job_id: int
+    ) -> ApiResponseProtocol[ExportJobHandle[RestrictionExportJob]]: ...
+
+    def get_export(
+        self, job_id: int
+    ) -> (
+        ExportJobHandle[RestrictionExportJob]
+        | ApiResponseProtocol[ExportJobHandle[RestrictionExportJob]]
+    ):
+        return self._get_export(job_id)