lorebase-client 0.2.3__tar.gz → 0.3.0__tar.gz

{lorebase_client-0.2.3 → lorebase_client-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: lorebase-client
-Version: 0.2.3
+Version: 0.3.0
 Summary: Lorebase client: typed sync and async HTTP client for the Keeper API
 Requires-Python: >=3.12
 Requires-Dist: httpx>=0.27

{lorebase_client-0.2.3 → lorebase_client-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "lorebase-client"
-version = "0.2.3"
+version = "0.3.0"
 description = "Lorebase client: typed sync and async HTTP client for the Keeper API"
 requires-python = ">=3.12"
 dependencies = [

{lorebase_client-0.2.3 → lorebase_client-0.3.0}/src/lorebase_client/__init__.py

@@ -45,7 +45,7 @@ from lorebase_client.errors import (
     error_from_response,
 )
 
-__version__ = "0.2.3"
+__version__ = "0.3.0"
 
 __all__ = [
     "ENV_API_KEY",

{lorebase_client-0.2.3 → lorebase_client-0.3.0}/src/lorebase_client/aclient.py

@@ -106,6 +106,7 @@ class AsyncLorebaseClient:
         self.proposals = Proposals(self)
         self.agents = Agents(self)
         self.webhooks = Webhooks(self)
+        self.reconciliation = Reconciliation(self)
         self.sources = Sources(self)
         self.documents = Documents(self)
 
@@ -181,6 +182,11 @@ class AsyncLorebaseClient:
         """The authenticated caller."""
         return await self.send(ep.whoami())
 
+    async def session_info(self) -> m.SessionInfo:
+        """The browser session the caller's session cookie belongs to; 401 for API keys and
+        bearer tokens."""
+        return await self.send(ep.session_info())
+
     def idempotency_key(self, prefix: str | None = None) -> str:
         """A fresh key to pass as `idempotency_key=` to a write."""
         return new_idempotency_key(prefix)
@@ -228,9 +234,14 @@ class Domains(_Resource):
         return await self._c.send(ep.get_domain(id))
 
     async def update(
-        self, id: str, *, display_name: str | None = None, description: str | None = None
+        self,
+        id: str,
+        *,
+        display_name: str | None = None,
+        description: str | None = None,
+        settings: JsonObject | None = None,
     ) -> m.Domain:
-        body = m.DomainUpdate(display_name=display_name, description=description)
+        body = m.DomainUpdate(display_name=display_name, description=description, settings=settings)
         return await self._c.send(ep.update_domain(id, body))
 
     async def delete(self, id: str, *, confirm: str) -> None:
@@ -854,6 +865,10 @@ class Records(_Resource):
         body = request if isinstance(request, m.SearchRequest) else m.SearchRequest(**request)
         return await self._c.send(ep.search(domain, body))
 
+    async def resolve(self, domain: str, request: m.ResolveRequest | JsonObject) -> m.ResolveResult:
+        body = request if isinstance(request, m.ResolveRequest) else m.ResolveRequest(**request)
+        return await self._c.send(ep.resolve(domain, body))
+
 
 def _query_request(query: m.QueryRequest | JsonObject) -> m.QueryRequest:
     return query if isinstance(query, m.QueryRequest) else m.QueryRequest(**query)
@@ -1189,6 +1204,7 @@ class Proposals(_Resource):
         source: str | None = None,
         target: str | None = None,
         author: str | None = None,
+        assigned: m.AssignedFilter | None = None,
         limit: int | None = None,
         cursor: str | None = None,
     ) -> m.Page[m.Proposal]:
@@ -1200,6 +1216,7 @@ class Proposals(_Resource):
                 source=source,
                 target=target,
                 author=author,
+                assigned=assigned,
                 limit=limit,
                 cursor=cursor,
             )
@@ -1214,6 +1231,7 @@ class Proposals(_Resource):
         source: str | None = None,
         target: str | None = None,
         author: str | None = None,
+        assigned: m.AssignedFilter | None = None,
         page_size: int | None = None,
     ) -> AsyncIterator[m.Proposal]:
         call = ep.list_proposals(
@@ -1223,6 +1241,7 @@ class Proposals(_Resource):
             source=source,
             target=target,
             author=author,
+            assigned=assigned,
             limit=page_size,
         )
         return self._c.iterate(call)
@@ -1515,6 +1534,141 @@ class Webhooks(_Resource):
         await self._c.send(ep.delete_webhook(domain, webhook_id))
 
 
+class Reconciliation(_Resource):
+    async def list(
+        self,
+        domain: str,
+        *,
+        branch: str | None = None,
+        type: m.CandidateType | None = None,
+        status: m.CandidateStatus | None = None,
+        kind: str | None = None,
+        attribute: str | None = None,
+        source: str | None = None,
+        assigned: m.AssignedFilter | None = None,
+        limit: int | None = None,
+        cursor: str | None = None,
+    ) -> m.Page[m.ReconciliationCandidate]:
+        """One page of the candidates of a branch (default: the default branch), newest first.
+
+        `kind` and `attribute` are api names (`attribute` needs `kind`); `source` is a Source
+        identity such as `source:src_...`."""
+        return await self._c.send(
+            ep.list_reconciliation(
+                domain,
+                branch=branch,
+                type=type,
+                status=status,
+                kind=kind,
+                attribute=attribute,
+                source=source,
+                assigned=assigned,
+                limit=limit,
+                cursor=cursor,
+            )
+        )
+
+    def iterate(
+        self,
+        domain: str,
+        *,
+        branch: str | None = None,
+        type: m.CandidateType | None = None,
+        status: m.CandidateStatus | None = None,
+        kind: str | None = None,
+        attribute: str | None = None,
+        source: str | None = None,
+        assigned: m.AssignedFilter | None = None,
+        page_size: int | None = None,
+    ) -> AsyncIterator[m.ReconciliationCandidate]:
+        call = ep.list_reconciliation(
+            domain,
+            branch=branch,
+            type=type,
+            status=status,
+            kind=kind,
+            attribute=attribute,
+            source=source,
+            assigned=assigned,
+            limit=page_size,
+        )
+        return self._c.iterate(call)
+
+    async def get(self, domain: str, candidate_id: str) -> m.ReconciliationCandidate:
+        return await self._c.send(ep.get_reconciliation_candidate(domain, candidate_id))
+
+    async def resolve(
+        self,
+        domain: str,
+        candidate_id: str,
+        choice: m.ReconcileChoice,
+        *,
+        reason: str,
+        claim_id: str | None = None,
+        value: JsonValue = None,
+        policy: m.ReconcilePolicy | None = None,
+        survivor: str | None = None,
+        values: JsonObject | None = None,
+        dry_run: bool = False,
+    ) -> m.ReconciliationDecision:
+        """Decide a candidate; `dry_run` reports the outcome without writing."""
+        body = m.ReconcileIn(
+            choice=choice,
+            claim_id=claim_id,
+            value=value,
+            policy=policy,
+            survivor=survivor,
+            values=None if values is None else dict(values),
+            reason=reason,
+            dry_run=dry_run,
+        )
+        return await self._c.send(ep.resolve_reconciliation(domain, candidate_id, body))
+
+    async def dismiss(
+        self, domain: str, candidate_id: str, *, reason: str
+    ) -> m.ReconciliationDecision:
+        return await self._c.send(
+            ep.dismiss_reconciliation(domain, candidate_id, m.ReasonIn(reason=reason))
+        )
+
+    async def reopen(
+        self, domain: str, candidate_id: str, *, reason: str
+    ) -> m.ReconciliationDecision:
+        """Reopen a dismissed candidate."""
+        return await self._c.send(
+            ep.reopen_reconciliation(domain, candidate_id, m.ReasonIn(reason=reason))
+        )
+
+    async def resolve_many(
+        self,
+        domain: str,
+        choice: m.BulkChoice,
+        *,
+        reason: str,
+        ids: Sequence[str] | None = None,
+        where: m.ReconcileFilter | None = None,
+        policy: m.ReconcilePolicy | None = None,
+        dry_run: bool = False,
+    ) -> m.BulkDecision:
+        """Apply a policy or a dismissal to the `ids` given, or to the open candidates
+        matching `where`."""
+        body = m.BulkReconcileIn(
+            ids=None if ids is None else list(ids),
+            filter=where,
+            choice=choice,
+            policy=policy,
+            reason=reason,
+            dry_run=dry_run,
+        )
+        return await self._c.send(ep.resolve_reconciliation_bulk(domain, body))
+
+    async def queue_sweep(self, domain: str, *, branch: str | None = None) -> m.SweepQueued:
+        """Queue a reconciliation sweep of a branch for Scribe."""
+        return await self._c.send(
+            ep.queue_reconciliation_sweep(domain, m.SweepRequest(branch=branch))
+        )
+
+
 class Sources(_Resource):
     async def sync(self, domain: str, source: str, *, dry_run: bool = False) -> m.SyncQueued:
         """Queue a synchronization of the Source (id or api name) for Scribe."""
@@ -1541,12 +1695,16 @@ class Documents(_Resource):
         filename: str | None = None,
         extract: bool | None = None,
         tiers: Sequence[int] | None = None,
+        source_key: str | None = None,
     ) -> m.DocumentUploaded:
         """Upload a document: a path (named after the file) or bytes with a `filename`.
 
-        `extract` (server default: true) queues an extraction job on the given `tiers`.
+        `extract` (server default: true) queues an extraction job on the given `tiers`. With a
+        `source_key`, new bytes become a new version of the key's document.
         """
-        call = ep.upload_document(domain, file, filename=filename, extract=extract, tiers=tiers)
+        call = ep.upload_document(
+            domain, file, filename=filename, extract=extract, tiers=tiers, source_key=source_key
+        )
         return await self._c.send(call)
 
     async def upload_url(
@@ -1557,6 +1715,7 @@ class Documents(_Resource):
         filename: str | None = None,
         extract: bool | None = None,
         tiers: Sequence[int] | None = None,
+        source_key: str | None = None,
     ) -> m.DocumentUploaded:
         """Have the server fetch the document from an allowlisted URL."""
         body = m.DocumentFromUrl(
@@ -1564,17 +1723,55 @@ class Documents(_Resource):
             filename=filename,
             extract=extract,
             tiers=None if tiers is None else list(tiers),
+            source_key=source_key,
         )
         return await self._c.send(ep.upload_document_url(domain, body))
 
     async def list(
-        self, domain: str, *, limit: int | None = None, cursor: str | None = None
+        self,
+        domain: str,
+        *,
+        source_key: str | None = None,
+        limit: int | None = None,
+        cursor: str | None = None,
     ) -> m.Page[m.Document]:
-        """Documents of the Domain, newest first."""
-        return await self._c.send(ep.list_documents(domain, limit=limit, cursor=cursor))
+        """Documents of the Domain, newest first; `source_key` keeps one key's versions."""
+        call = ep.list_documents(domain, source_key=source_key, limit=limit, cursor=cursor)
+        return await self._c.send(call)
+
+    def iterate(
+        self, domain: str, *, source_key: str | None = None, page_size: int | None = None
+    ) -> AsyncIterator[m.Document]:
+        return self._c.iterate(ep.list_documents(domain, source_key=source_key, limit=page_size))
+
+    async def versions(
+        self,
+        domain: str,
+        document_id: str,
+        *,
+        limit: int | None = None,
+        cursor: str | None = None,
+    ) -> m.Page[m.Document]:
+        """The versions of the document's source key, newest first."""
+        call = ep.document_versions(domain, document_id, limit=limit, cursor=cursor)
+        return await self._c.send(call)
 
-    def iterate(self, domain: str, *, page_size: int | None = None) -> AsyncIterator[m.Document]:
-        return self._c.iterate(ep.list_documents(domain, limit=page_size))
+    def iterate_versions(
+        self, domain: str, document_id: str, *, page_size: int | None = None
+    ) -> AsyncIterator[m.Document]:
+        return self._c.iterate(ep.document_versions(domain, document_id, limit=page_size))
+
+    async def retire(self, domain: str, document_id: str, *, reason: str) -> m.DocumentRetired:
+        """Retire a document: it is never extracted again and its evidence is re-checked."""
+        body = m.RetirementIn(reason=reason)
+        return await self._c.send(ep.retire_document(domain, document_id, body))
+
+    async def purge(
+        self, domain: str, document_id: str, *, reason: str, confirm: str
+    ) -> m.DocumentPurged:
+        """Irreversibly delete the content of a document; `confirm` is the document id."""
+        body = m.PurgeIn(reason=reason, confirm=confirm)
+        return await self._c.send(ep.purge_document(domain, document_id, body))
 
     async def get(self, domain: str, document_id: str) -> m.DocumentDetail:
         """A document with its extraction jobs."""

{lorebase_client-0.2.3 → lorebase_client-0.3.0}/src/lorebase_client/client.py

@@ -7,7 +7,7 @@
 
 Resources group the endpoints (`domains`, `branches`, `tags`, `schema`, `operations`, `records`,
 `revisions`, `api_keys`, `grants`, `principals`, `audit`, `proposals`, `agents`, `webhooks`,
-`sources`, `documents`).
+`reconciliation`, `sources`, `documents`).
 Every list endpoint has a `list` method (one page) and an `iterate` method (all items; pages
 are fetched on demand). Errors
 raise subclasses of `LorebaseError`. The request layer is shared with `AsyncLorebaseClient`
@@ -126,6 +126,7 @@ class LorebaseClient:
         self.proposals = Proposals(self)
         self.agents = Agents(self)
         self.webhooks = Webhooks(self)
+        self.reconciliation = Reconciliation(self)
         self.sources = Sources(self)
         self.documents = Documents(self)
 
@@ -200,6 +201,11 @@ class LorebaseClient:
         """The authenticated caller."""
         return self.send(ep.whoami())
 
+    def session_info(self) -> m.SessionInfo:
+        """The browser session the caller's session cookie belongs to; 401 for API keys and
+        bearer tokens."""
+        return self.send(ep.session_info())
+
     def idempotency_key(self, prefix: str | None = None) -> str:
         """A fresh key to pass as `idempotency_key=` to a write."""
         return new_idempotency_key(prefix)
@@ -245,9 +251,14 @@ class Domains(_Resource):
         return self._c.send(ep.get_domain(id))
 
     def update(
-        self, id: str, *, display_name: str | None = None, description: str | None = None
+        self,
+        id: str,
+        *,
+        display_name: str | None = None,
+        description: str | None = None,
+        settings: JsonObject | None = None,
     ) -> m.Domain:
-        body = m.DomainUpdate(display_name=display_name, description=description)
+        body = m.DomainUpdate(display_name=display_name, description=description, settings=settings)
         return self._c.send(ep.update_domain(id, body))
 
     def delete(self, id: str, *, confirm: str) -> None:
@@ -862,6 +873,10 @@ class Records(_Resource):
         body = request if isinstance(request, m.SearchRequest) else m.SearchRequest(**request)
         return self._c.send(ep.search(domain, body))
 
+    def resolve(self, domain: str, request: m.ResolveRequest | JsonObject) -> m.ResolveResult:
+        body = request if isinstance(request, m.ResolveRequest) else m.ResolveRequest(**request)
+        return self._c.send(ep.resolve(domain, body))
+
 
 def _query_request(query: m.QueryRequest | JsonObject) -> m.QueryRequest:
     return query if isinstance(query, m.QueryRequest) else m.QueryRequest(**query)
@@ -1195,6 +1210,7 @@ class Proposals(_Resource):
         source: str | None = None,
         target: str | None = None,
         author: str | None = None,
+        assigned: m.AssignedFilter | None = None,
         limit: int | None = None,
         cursor: str | None = None,
     ) -> m.Page[m.Proposal]:
@@ -1206,6 +1222,7 @@ class Proposals(_Resource):
                 source=source,
                 target=target,
                 author=author,
+                assigned=assigned,
                 limit=limit,
                 cursor=cursor,
             )
@@ -1220,6 +1237,7 @@ class Proposals(_Resource):
         source: str | None = None,
         target: str | None = None,
         author: str | None = None,
+        assigned: m.AssignedFilter | None = None,
         page_size: int | None = None,
     ) -> Iterator[m.Proposal]:
         call = ep.list_proposals(
@@ -1229,6 +1247,7 @@ class Proposals(_Resource):
             source=source,
             target=target,
             author=author,
+            assigned=assigned,
             limit=page_size,
         )
         return self._c.iterate(call)
@@ -1517,6 +1536,135 @@ class Webhooks(_Resource):
         self._c.send(ep.delete_webhook(domain, webhook_id))
 
 
+class Reconciliation(_Resource):
+    def list(
+        self,
+        domain: str,
+        *,
+        branch: str | None = None,
+        type: m.CandidateType | None = None,
+        status: m.CandidateStatus | None = None,
+        kind: str | None = None,
+        attribute: str | None = None,
+        source: str | None = None,
+        assigned: m.AssignedFilter | None = None,
+        limit: int | None = None,
+        cursor: str | None = None,
+    ) -> m.Page[m.ReconciliationCandidate]:
+        """One page of the candidates of a branch (default: the default branch), newest first.
+
+        `kind` and `attribute` are api names (`attribute` needs `kind`); `source` is a Source
+        identity such as `source:src_...`."""
+        return self._c.send(
+            ep.list_reconciliation(
+                domain,
+                branch=branch,
+                type=type,
+                status=status,
+                kind=kind,
+                attribute=attribute,
+                source=source,
+                assigned=assigned,
+                limit=limit,
+                cursor=cursor,
+            )
+        )
+
+    def iterate(
+        self,
+        domain: str,
+        *,
+        branch: str | None = None,
+        type: m.CandidateType | None = None,
+        status: m.CandidateStatus | None = None,
+        kind: str | None = None,
+        attribute: str | None = None,
+        source: str | None = None,
+        assigned: m.AssignedFilter | None = None,
+        page_size: int | None = None,
+    ) -> Iterator[m.ReconciliationCandidate]:
+        call = ep.list_reconciliation(
+            domain,
+            branch=branch,
+            type=type,
+            status=status,
+            kind=kind,
+            attribute=attribute,
+            source=source,
+            assigned=assigned,
+            limit=page_size,
+        )
+        return self._c.iterate(call)
+
+    def get(self, domain: str, candidate_id: str) -> m.ReconciliationCandidate:
+        return self._c.send(ep.get_reconciliation_candidate(domain, candidate_id))
+
+    def resolve(
+        self,
+        domain: str,
+        candidate_id: str,
+        choice: m.ReconcileChoice,
+        *,
+        reason: str,
+        claim_id: str | None = None,
+        value: JsonValue = None,
+        policy: m.ReconcilePolicy | None = None,
+        survivor: str | None = None,
+        values: JsonObject | None = None,
+        dry_run: bool = False,
+    ) -> m.ReconciliationDecision:
+        """Decide a candidate; `dry_run` reports the outcome without writing."""
+        body = m.ReconcileIn(
+            choice=choice,
+            claim_id=claim_id,
+            value=value,
+            policy=policy,
+            survivor=survivor,
+            values=None if values is None else dict(values),
+            reason=reason,
+            dry_run=dry_run,
+        )
+        return self._c.send(ep.resolve_reconciliation(domain, candidate_id, body))
+
+    def dismiss(self, domain: str, candidate_id: str, *, reason: str) -> m.ReconciliationDecision:
+        return self._c.send(
+            ep.dismiss_reconciliation(domain, candidate_id, m.ReasonIn(reason=reason))
+        )
+
+    def reopen(self, domain: str, candidate_id: str, *, reason: str) -> m.ReconciliationDecision:
+        """Reopen a dismissed candidate."""
+        return self._c.send(
+            ep.reopen_reconciliation(domain, candidate_id, m.ReasonIn(reason=reason))
+        )
+
+    def resolve_many(
+        self,
+        domain: str,
+        choice: m.BulkChoice,
+        *,
+        reason: str,
+        ids: Sequence[str] | None = None,
+        where: m.ReconcileFilter | None = None,
+        policy: m.ReconcilePolicy | None = None,
+        dry_run: bool = False,
+    ) -> m.BulkDecision:
+        """Apply a policy or a dismissal to the `ids` given, or to the open candidates
+        matching `where`."""
+        body = m.BulkReconcileIn(
+            ids=None if ids is None else list(ids),
+            filter=where,
+            choice=choice,
+            policy=policy,
+            reason=reason,
+            dry_run=dry_run,
+        )
+        return self._c.send(ep.resolve_reconciliation_bulk(domain, body))
+
+    def queue_sweep(self, domain: str, *, branch: str | None = None) -> m.SweepQueued:
+        """Queue a reconciliation sweep of a branch for Scribe."""
+        return self._c.send(ep.queue_reconciliation_sweep(domain, m.SweepRequest(branch=branch)))
+
+
 class Sources(_Resource):
     def sync(self, domain: str, source: str, *, dry_run: bool = False) -> m.SyncQueued:
         """Queue a synchronization of the Source (id or api name) for Scribe."""
@@ -1543,12 +1691,16 @@ class Documents(_Resource):
         filename: str | None = None,
         extract: bool | None = None,
         tiers: Sequence[int] | None = None,
+        source_key: str | None = None,
     ) -> m.DocumentUploaded:
         """Upload a document: a path (named after the file) or bytes with a `filename`.
 
-        `extract` (server default: true) queues an extraction job on the given `tiers`.
+        `extract` (server default: true) queues an extraction job on the given `tiers`. With a
+        `source_key`, new bytes become a new version of the key's document.
         """
-        call = ep.upload_document(domain, file, filename=filename, extract=extract, tiers=tiers)
+        call = ep.upload_document(
+            domain, file, filename=filename, extract=extract, tiers=tiers, source_key=source_key
+        )
         return self._c.send(call)
 
     def upload_url(
@@ -1559,6 +1711,7 @@ class Documents(_Resource):
         filename: str | None = None,
         extract: bool | None = None,
         tiers: Sequence[int] | None = None,
+        source_key: str | None = None,
     ) -> m.DocumentUploaded:
         """Have the server fetch the document from an allowlisted URL."""
         body = m.DocumentFromUrl(
@@ -1566,17 +1719,55 @@ class Documents(_Resource):
             filename=filename,
             extract=extract,
             tiers=None if tiers is None else list(tiers),
+            source_key=source_key,
         )
         return self._c.send(ep.upload_document_url(domain, body))
 
     def list(
-        self, domain: str, *, limit: int | None = None, cursor: str | None = None
+        self,
+        domain: str,
+        *,
+        source_key: str | None = None,
+        limit: int | None = None,
+        cursor: str | None = None,
     ) -> m.Page[m.Document]:
-        """Documents of the Domain, newest first."""
-        return self._c.send(ep.list_documents(domain, limit=limit, cursor=cursor))
+        """Documents of the Domain, newest first; `source_key` keeps one key's versions."""
+        call = ep.list_documents(domain, source_key=source_key, limit=limit, cursor=cursor)
+        return self._c.send(call)
+
+    def iterate(
+        self, domain: str, *, source_key: str | None = None, page_size: int | None = None
+    ) -> Iterator[m.Document]:
+        return self._c.iterate(ep.list_documents(domain, source_key=source_key, limit=page_size))
+
+    def versions(
+        self,
+        domain: str,
+        document_id: str,
+        *,
+        limit: int | None = None,
+        cursor: str | None = None,
+    ) -> m.Page[m.Document]:
+        """The versions of the document's source key, newest first."""
+        call = ep.document_versions(domain, document_id, limit=limit, cursor=cursor)
+        return self._c.send(call)
 
-    def iterate(self, domain: str, *, page_size: int | None = None) -> Iterator[m.Document]:
-        return self._c.iterate(ep.list_documents(domain, limit=page_size))
+    def iterate_versions(
+        self, domain: str, document_id: str, *, page_size: int | None = None
+    ) -> Iterator[m.Document]:
+        return self._c.iterate(ep.document_versions(domain, document_id, limit=page_size))
+
+    def retire(self, domain: str, document_id: str, *, reason: str) -> m.DocumentRetired:
+        """Retire a document: it is never extracted again and its evidence is re-checked."""
+        body = m.RetirementIn(reason=reason)
+        return self._c.send(ep.retire_document(domain, document_id, body))
+
+    def purge(
+        self, domain: str, document_id: str, *, reason: str, confirm: str
+    ) -> m.DocumentPurged:
+        """Irreversibly delete the content of a document; `confirm` is the document id."""
+        body = m.PurgeIn(reason=reason, confirm=confirm)
+        return self._c.send(ep.purge_document(domain, document_id, body))
 
     def get(self, domain: str, document_id: str) -> m.DocumentDetail:
         """A document with its extraction jobs."""