memorysync 1.3.0__tar.gz → 1.4.0__tar.gz

{memorysync-1.3.0 → memorysync-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: memorysync
-Version: 1.3.0
+Version: 1.4.0
 Summary: Official Python client for the MemorySync API.
 Project-URL: Homepage, https://memorysync.io
 Project-URL: Documentation, https://docs.memorysync.io

{memorysync-1.3.0 → memorysync-1.4.0}/pyproject.toml

@@ -1,44 +1,44 @@
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-
-[project]
-name = "memorysync"
-version = "1.3.0"
-description = "Official Python client for the MemorySync API."
-readme = "README.md"
-license = { text = "MIT" }
-requires-python = ">=3.9"
-authors = [{ name = "MemorySync" }]
-keywords = ["memorysync", "memory", "sdk", "client"]
-classifiers = [
-  "Development Status :: 5 - Production/Stable",
-  "Intended Audience :: Developers",
-  "License :: OSI Approved :: MIT License",
-  "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3.9",
-  "Programming Language :: Python :: 3.10",
-  "Programming Language :: Python :: 3.11",
-  "Programming Language :: Python :: 3.12",
-  "Topic :: Software Development :: Libraries :: Python Modules",
-  "Typing :: Typed",
-]
-dependencies = [
-  "httpx>=0.25,<1.0",
-  "typing-extensions>=4.5; python_version < '3.11'",
-]
-
-[project.urls]
-Homepage = "https://memorysync.io"
-Documentation = "https://docs.memorysync.io"
-
-[tool.hatch.build.targets.wheel]
-packages = ["src/memorysync"]
-
-[tool.hatch.build.targets.sdist]
-include = [
-  "src/memorysync",
-  "README.md",
-  "LICENSE",
-  "pyproject.toml",
-]
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "memorysync"
+version = "1.4.0"
+description = "Official Python client for the MemorySync API."
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.9"
+authors = [{ name = "MemorySync" }]
+keywords = ["memorysync", "memory", "sdk", "client"]
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Typing :: Typed",
+]
+dependencies = [
+  "httpx>=0.25,<1.0",
+  "typing-extensions>=4.5; python_version < '3.11'",
+]
+
+[project.urls]
+Homepage = "https://memorysync.io"
+Documentation = "https://docs.memorysync.io"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/memorysync"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+  "src/memorysync",
+  "README.md",
+  "LICENSE",
+  "pyproject.toml",
+]

memorysync-1.4.0/src/memorysync/_version.py

@@ -0,0 +1 @@
+__version__ = "1.4.0"

{memorysync-1.3.0 → memorysync-1.4.0}/src/memorysync/connections.py

@@ -38,7 +38,7 @@ shapes (memories, history, feedback, ontology).
 
 from __future__ import annotations
 
-from typing import Any, Callable, Dict, Optional, Sequence
+from typing import Any, Callable, Dict, Mapping, Optional, Sequence
 from urllib.parse import quote
 
 _V2 = "/api/v2/integrations"
@@ -58,6 +58,20 @@ def _seg(value: Any) -> str:
     return quote(str(value), safe="")
 
 
+def _as_item(value: Any, key: str) -> Dict[str, Any]:
+    """Normalize one selection entry into the object the API expects.
+
+    Two of the approval endpoints take a list of objects rather than a list of
+    ids — Slack channels carry an optional name and type, S3 prefixes carry an
+    optional bucket and label. Callers almost always have just the id, so both
+    forms are accepted here and widened to the object form, rather than making
+    every caller write ``{"id": channel_id}`` and making the simple case ugly.
+    """
+    if isinstance(value, Mapping):
+        return dict(value)
+    return {key: value}
+
+
 class _Namespace:
     """Holds the bound request function. Subclasses add methods."""
 
@@ -97,11 +111,22 @@ class SlackNamespace(_Namespace):
             "GET", f"{_V2}/connections/{_seg(connection_id)}/slack/channels"
         )
 
-    def add_channels(self, connection_id: str, channel_ids: Sequence[str]) -> Any:
-        """Select channels for syncing."""
+    def add_channels(self, connection_id: str, channels: Sequence[Any]) -> Any:
+        """Select channels for syncing.
+
+        Accepts bare channel ids, which is the common case::
+
+            client.connections.slack.add_channels("c1", ["C0123", "C0456"])
+
+        or dicts when you want to carry the name and type across so the server
+        does not have to look them up again::
+
+            add_channels("c1", [{"id": "C0123", "name": "support",
+                                 "is_private": False}])
+        """
         return self._request(
             "POST", f"{_V2}/connections/{_seg(connection_id)}/slack/channels",
-            json={"channel_ids": list(channel_ids)},
+            json={"channels": [_as_item(c, "id") for c in channels]},
         )
 
     def remove_channel(self, connection_id: str, channel_id: str) -> Any:
@@ -195,18 +220,47 @@ class S3Namespace(_Namespace):
             "GET", f"{_V2}/connections/{_seg(connection_id)}/s3/prefixes"
         )
 
-    def add_prefixes(self, connection_id: str, prefixes: Sequence[str]) -> Any:
-        """Select prefixes for syncing."""
+    def add_prefixes(self, connection_id: str, prefixes: Sequence[Any]) -> Any:
+        """Select prefixes for syncing.
+
+        Accepts bare prefixes, or dicts carrying ``bucket`` and ``label``::
+
+            add_prefixes("c1", ["handbook/", "policies/"])
+            add_prefixes("c1", [{"prefix": "handbook/", "label": "Handbook"}])
+
+        An empty string means the bucket root. The bucket defaults to the one the
+        connection's credentials were validated against, and the API rejects any
+        other bucket rather than indexing one nobody proved access to.
+        """
         return self._request(
             "POST", f"{_V2}/connections/{_seg(connection_id)}/s3/prefixes",
-            json={"prefixes": list(prefixes)},
-        )
-
-    def remove_prefixes(self, connection_id: str, prefixes: Sequence[str]) -> Any:
-        """Stop syncing the given prefixes."""
+            json={"prefixes": [_as_item(p, "prefix") for p in prefixes]},
+        )
+
+    def remove_prefix(
+        self,
+        connection_id: str,
+        prefix: str = "",
+        *,
+        bucket: Optional[str] = None,
+        purge: bool = False,
+    ) -> Any:
+        """Revoke one prefix approval, optionally purging what it produced.
+
+        The prefix travels as a query parameter, not in the body and not as a path
+        segment: prefixes contain slashes, which a path segment cannot carry
+        unambiguously, and this endpoint reads no body at all.
+
+        Pass ``purge=True`` to also delete the memories already derived from the
+        prefix. The default leaves them in place, so revoking an approval does not
+        silently destroy knowledge.
+        """
+        params: Dict[str, Any] = {"prefix": prefix, "purge": purge}
+        if bucket is not None:
+            params["bucket"] = bucket
         return self._request(
             "DELETE", f"{_V2}/connections/{_seg(connection_id)}/s3/prefixes",
-            json={"prefixes": list(prefixes)},
+            params=params,
         )
 
     def exclusion_policy(self, connection_id: str) -> Any:
@@ -286,10 +340,15 @@ class GranolaNamespace(_Namespace):
         )
 
     def relink_identity(self, connection_id: str, **body: Any) -> Any:
-        """Move an existing mapping to a different end user."""
+        """Re-run identity matching for this connection.
+
+        Takes no arguments: the route reads no body and re-matches the whole
+        roster. ``**body`` is kept only so a forward-compatible field can be
+        passed once the route grows one.
+        """
         return self._request(
             "POST", f"{_V2}/connections/{_seg(connection_id)}/granola/identities/relink",
-            json=body,
+            json=body or None,
         )
 
     def settings(self, connection_id: str) -> Any:
@@ -321,7 +380,7 @@ class ConnectionOAuthNamespace(_Namespace):
         platform back. Poll :meth:`status` to find out how it went — the callback
         does not come to your backend.
         """
-        payload = {"provider": provider}
+        payload = {"provider_id": provider}
         payload.update(body)
         return self._request("POST", f"{_V2}/oauth/initiate", json=payload)
 
@@ -361,14 +420,18 @@ class ConnectionsNamespace(_Namespace):
         return self._request("GET", f"{_V2}/connections/{_seg(connection_id)}")
 
     def create_with_api_key(self, provider: str, api_key: str, **body: Any) -> Any:
-        """Connect a provider that authenticates with an API key or bot token."""
-        payload: Dict[str, Any] = {"provider": provider, "api_key": api_key}
+        """Connect a provider that authenticates with an API key or bot token.
+
+        The wire field is ``provider_id``; the argument is named ``provider``
+        because that is what the rest of this namespace calls it.
+        """
+        payload: Dict[str, Any] = {"provider_id": provider, "api_key": api_key}
         payload.update(body)
         return self._request("POST", f"{_V2}/connections/api-key", json=payload)
 
     def create_with_credentials(self, provider: str, credentials: Dict[str, Any], **body: Any) -> Any:
         """Connect a provider that needs a credential bundle, such as S3 keys."""
-        payload: Dict[str, Any] = {"provider": provider, "credentials": credentials}
+        payload: Dict[str, Any] = {"provider_id": provider, "credentials": credentials}
         payload.update(body)
         return self._request("POST", f"{_V2}/connections/credentials", json=payload)
 

memorysync-1.3.0/src/memorysync/_version.py

@@ -1 +0,0 @@
-__version__ = "1.3.0"