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

lorebase_client-0.3.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Antonio Antenore
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

lorebase_client-0.3.1/PKG-INFO

@@ -0,0 +1,38 @@
+Metadata-Version: 2.5
+Name: lorebase-client
+Version: 0.3.1
+Summary: Lorebase client: typed sync and async HTTP client for the Keeper API
+Project-URL: Homepage, https://github.com/aantenore/lorebase
+Project-URL: Documentation, https://aantenore.github.io/lorebase/
+Project-URL: Repository, https://github.com/aantenore/lorebase
+Project-URL: Changelog, https://github.com/aantenore/lorebase/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/aantenore/lorebase/issues
+Author: Antonio Antenore
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: knowledge-graph,mcp,ontology,postgres,versioning
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Database
+Requires-Python: >=3.12
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic>=2.7
+Description-Content-Type: text/markdown
+
+# lorebase-client
+
+Part of [Lorebase](https://github.com/aantenore/lorebase), an open-source ontology platform: a versioned, governed knowledge graph on Postgres with git-like branching and three-way merge.
+
+Typed sync and async Python client for the Keeper REST API.
+
+```sh
+pip install lorebase-client
+```
+
+A library: it has no command of its own.
+
+Documentation: [Agents](https://aantenore.github.io/lorebase/agents/) and the [documentation site](https://aantenore.github.io/lorebase/). License: Apache-2.0.

lorebase_client-0.3.1/README.md

@@ -0,0 +1,13 @@
+# lorebase-client
+
+Part of [Lorebase](https://github.com/aantenore/lorebase), an open-source ontology platform: a versioned, governed knowledge graph on Postgres with git-like branching and three-way merge.
+
+Typed sync and async Python client for the Keeper REST API.
+
+```sh
+pip install lorebase-client
+```
+
+A library: it has no command of its own.
+
+Documentation: [Agents](https://aantenore.github.io/lorebase/agents/) and the [documentation site](https://aantenore.github.io/lorebase/). License: Apache-2.0.

lorebase_client-0.3.1/pyproject.toml

@@ -0,0 +1,39 @@
+[project]
+name = "lorebase-client"
+version = "0.3.1"
+description = "Lorebase client: typed sync and async HTTP client for the Keeper API"
+requires-python = ">=3.12"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "Antonio Antenore" }]
+keywords = ["ontology", "knowledge-graph", "mcp", "postgres", "versioning"]
+classifiers = [
+  "Development Status :: 2 - Pre-Alpha",
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Database",
+]
+dependencies = [
+  # Transport: one HTTP stack with sync and async clients and pluggable transports.
+  "httpx>=0.27",
+  # Typed request and response models.
+  "pydantic>=2.7",
+]
+
+[project.urls]
+Homepage = "https://github.com/aantenore/lorebase"
+Documentation = "https://aantenore.github.io/lorebase/"
+Repository = "https://github.com/aantenore/lorebase"
+Changelog = "https://github.com/aantenore/lorebase/blob/main/CHANGELOG.md"
+Issues = "https://github.com/aantenore/lorebase/issues"
+
+[build-system]
+requires = ["hatchling>=1.27"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/lorebase_client"]

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

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

{lorebase_client-0.2.3 → lorebase_client-0.3.1}/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."""