deepflow-opendesk-cli 0.1.3__tar.gz → 0.1.4__tar.gz

{deepflow_opendesk_cli-0.1.3 → deepflow_opendesk_cli-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deepflow-opendesk-cli
-Version: 0.1.3
+Version: 0.1.4
 Summary: Command-line client for OpenDesk admin configuration and outbound task APIs.
 Author: DeepFlow AI
 Project-URL: Repository, https://github.com/DeepFlowAI/opendesk-dev
@@ -100,6 +100,47 @@ deepflow_opendesk_cli call courses.list
 deepflow_opendesk_cli call exams.list
 ```
 
+## Web Channel Bot Process Visibility
+
+After deploying a server that supports `config.open_agent_hide_process`, the
+existing generic commands can read and update this setting. No dedicated CLI
+flag is required. Refresh the cached schema to discover the new boolean field:
+
+```bash
+deepflow_opendesk_cli schema fetch
+deepflow_opendesk_cli docs schema ChannelConfig
+deepflow_opendesk_cli docs show channels.update
+```
+
+Channel updates replace the full configuration; sending only the new boolean
+can reset other settings. Read the channel first, preserve its editable fields
+and complete `config`, then change the boolean. For example, using `jq`:
+
+```bash
+deepflow_opendesk_cli call channels.get --path channel_id=12 > channel-current.json
+jq -e '.ok == true and (.data.config | type == "object")' channel-current.json
+jq '.data | {name, channel_type, access_mode, logo_url, favicon_url, config}
+    | .config.open_agent_hide_process = true' \
+  channel-current.json > channel-update.json
+
+deepflow_opendesk_cli call channels.update --path channel_id=12 \
+  --json-file channel-update.json --dry-run
+deepflow_opendesk_cli call channels.update --path channel_id=12 \
+  --json-file channel-update.json
+deepflow_opendesk_cli call channels.get --path channel_id=12
+```
+
+Continue to the update only if the read and validation succeeded. Use JSON
+`false` to restore process visibility, not the string `"false"`. Both new and
+legacy channels default to `false` when the field is missing. The setting affects
+visitor display only; disabling the bot does not clear it. Existing channel
+management permissions still apply. Concurrent edits between the read and update
+can be overwritten, so read the latest configuration before applying the change.
+
+`request PUT /api/v1/channels/12 --json-file channel-update.json` is equivalent;
+batch and workflow bodies also pass the same field through unchanged. `--dry-run`
+prints the request without sending it; the server performs field validation.
+
 ## Outbound Tasks
 
 The outbound commands use the API-key OpenAPI under

{deepflow_opendesk_cli-0.1.3 → deepflow_opendesk_cli-0.1.4}/README.md

@@ -78,6 +78,47 @@ deepflow_opendesk_cli call courses.list
 deepflow_opendesk_cli call exams.list
 ```
 
+## Web Channel Bot Process Visibility
+
+After deploying a server that supports `config.open_agent_hide_process`, the
+existing generic commands can read and update this setting. No dedicated CLI
+flag is required. Refresh the cached schema to discover the new boolean field:
+
+```bash
+deepflow_opendesk_cli schema fetch
+deepflow_opendesk_cli docs schema ChannelConfig
+deepflow_opendesk_cli docs show channels.update
+```
+
+Channel updates replace the full configuration; sending only the new boolean
+can reset other settings. Read the channel first, preserve its editable fields
+and complete `config`, then change the boolean. For example, using `jq`:
+
+```bash
+deepflow_opendesk_cli call channels.get --path channel_id=12 > channel-current.json
+jq -e '.ok == true and (.data.config | type == "object")' channel-current.json
+jq '.data | {name, channel_type, access_mode, logo_url, favicon_url, config}
+    | .config.open_agent_hide_process = true' \
+  channel-current.json > channel-update.json
+
+deepflow_opendesk_cli call channels.update --path channel_id=12 \
+  --json-file channel-update.json --dry-run
+deepflow_opendesk_cli call channels.update --path channel_id=12 \
+  --json-file channel-update.json
+deepflow_opendesk_cli call channels.get --path channel_id=12
+```
+
+Continue to the update only if the read and validation succeeded. Use JSON
+`false` to restore process visibility, not the string `"false"`. Both new and
+legacy channels default to `false` when the field is missing. The setting affects
+visitor display only; disabling the bot does not clear it. Existing channel
+management permissions still apply. Concurrent edits between the read and update
+can be overwritten, so read the latest configuration before applying the change.
+
+`request PUT /api/v1/channels/12 --json-file channel-update.json` is equivalent;
+batch and workflow bodies also pass the same field through unchanged. `--dry-run`
+prints the request without sending it; the server performs field validation.
+
 ## Outbound Tasks
 
 The outbound commands use the API-key OpenAPI under

{deepflow_opendesk_cli-0.1.3 → deepflow_opendesk_cli-0.1.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "deepflow-opendesk-cli"
-version = "0.1.3"
+version = "0.1.4"
 description = "Command-line client for OpenDesk admin configuration and outbound task APIs."
 readme = "README.md"
 requires-python = ">=3.11"

{deepflow_opendesk_cli-0.1.3 → deepflow_opendesk_cli-0.1.4}/setup.py

@@ -7,7 +7,7 @@ from setuptools import find_packages, setup
 
 setup(
     name="deepflow-opendesk-cli",
-    version="0.1.3",
+    version="0.1.4",
     description="Command-line client for OpenDesk admin configuration and outbound task APIs.",
     long_description=Path("README.md").read_text(encoding="utf-8"),
     long_description_content_type="text/markdown",

{deepflow_opendesk_cli-0.1.3 → deepflow_opendesk_cli-0.1.4}/src/deepflow_opendesk_cli/__init__.py

@@ -1,3 +1,3 @@
 """OpenDesk admin configuration and outbound task API CLI."""
 
-__version__ = "0.1.3"
+__version__ = "0.1.4"

{deepflow_opendesk_cli-0.1.3 → deepflow_opendesk_cli-0.1.4}/src/deepflow_opendesk_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deepflow-opendesk-cli
-Version: 0.1.3
+Version: 0.1.4
 Summary: Command-line client for OpenDesk admin configuration and outbound task APIs.
 Author: DeepFlow AI
 Project-URL: Repository, https://github.com/DeepFlowAI/opendesk-dev
@@ -100,6 +100,47 @@ deepflow_opendesk_cli call courses.list
 deepflow_opendesk_cli call exams.list
 ```
 
+## Web Channel Bot Process Visibility
+
+After deploying a server that supports `config.open_agent_hide_process`, the
+existing generic commands can read and update this setting. No dedicated CLI
+flag is required. Refresh the cached schema to discover the new boolean field:
+
+```bash
+deepflow_opendesk_cli schema fetch
+deepflow_opendesk_cli docs schema ChannelConfig
+deepflow_opendesk_cli docs show channels.update
+```
+
+Channel updates replace the full configuration; sending only the new boolean
+can reset other settings. Read the channel first, preserve its editable fields
+and complete `config`, then change the boolean. For example, using `jq`:
+
+```bash
+deepflow_opendesk_cli call channels.get --path channel_id=12 > channel-current.json
+jq -e '.ok == true and (.data.config | type == "object")' channel-current.json
+jq '.data | {name, channel_type, access_mode, logo_url, favicon_url, config}
+    | .config.open_agent_hide_process = true' \
+  channel-current.json > channel-update.json
+
+deepflow_opendesk_cli call channels.update --path channel_id=12 \
+  --json-file channel-update.json --dry-run
+deepflow_opendesk_cli call channels.update --path channel_id=12 \
+  --json-file channel-update.json
+deepflow_opendesk_cli call channels.get --path channel_id=12
+```
+
+Continue to the update only if the read and validation succeeded. Use JSON
+`false` to restore process visibility, not the string `"false"`. Both new and
+legacy channels default to `false` when the field is missing. The setting affects
+visitor display only; disabling the bot does not clear it. Existing channel
+management permissions still apply. Concurrent edits between the read and update
+can be overwritten, so read the latest configuration before applying the change.
+
+`request PUT /api/v1/channels/12 --json-file channel-update.json` is equivalent;
+batch and workflow bodies also pass the same field through unchanged. `--dry-run`
+prints the request without sending it; the server performs field validation.
+
 ## Outbound Tasks
 
 The outbound commands use the API-key OpenAPI under

{deepflow_opendesk_cli-0.1.3 → deepflow_opendesk_cli-0.1.4}/tests/test_cli.py

@@ -1,10 +1,85 @@
 import json
+from copy import deepcopy
+
+import pytest
 
 from deepflow_opendesk_cli.cli import main
 from deepflow_opendesk_cli.client import HttpResult, OpenDeskClient
 from test_schema import SAMPLE_SCHEMA
 
 
+@pytest.fixture
+def channel_schema_file(tmp_path):
+    schema = deepcopy(SAMPLE_SCHEMA)
+    schema["paths"]["/api/v1/channels/{channel_id}"]["put"] = {
+        "tags": ["Channels"],
+        "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ChannelUpdate"}}}},
+    }
+    schema["components"]["schemas"].update({
+        "ChannelConfig": {
+            "type": "object",
+            "properties": {"open_agent_hide_process": {"type": "boolean", "default": False}},
+        },
+        "ChannelUpdate": {
+            "type": "object",
+            "properties": {"config": {"$ref": "#/components/schemas/ChannelConfig"}},
+        },
+    })
+    path = tmp_path / "channel-openapi.json"
+    path.write_text(json.dumps(schema), encoding="utf-8")
+    return str(path)
+
+
+def test_channel_docs_discover_process_visibility(channel_schema_file, capsys) -> None:
+    assert main(["docs", "show", "channels.update", "--schema-file", channel_schema_file, "--json"]) == 0
+    payload = json.loads(capsys.readouterr().out)
+    field = payload["body_fields"]["properties"]["config"]["properties"]["open_agent_hide_process"]
+    assert field["type"] == "boolean"
+    assert field["default"] is False
+
+
+@pytest.mark.parametrize("hide_process", [False, True])
+@pytest.mark.parametrize("command", ["call", "request", "batch", "workflow"])
+def test_channel_update_preserves_visibility_and_other_config(
+    channel_schema_file, monkeypatch, capsys, tmp_path, hide_process, command,
+) -> None:
+    monkeypatch.setenv("OPENDESK_CONFIG_HOME", str(tmp_path))
+    body = {
+        "name": "Support", "channel_type": "web", "access_mode": "embed",
+        "logo_url": None, "favicon_url": None,
+        "config": {
+            "open_agent_enabled": True,
+            "open_agent_agent_id": 7,
+            "open_agent_hide_process": hide_process,
+            "open_agent_feedback_enabled": True,
+            "open_agent_custom_buttons": [{"label": "Help", "value": "help"}],
+        },
+    }
+    body_path = tmp_path / "channel-update.json"
+    body_path.write_text(json.dumps(body), encoding="utf-8")
+    operation = {"key": "channels.update", "path": {"channel_id": 12}, "body": body}
+    if command == "call":
+        args = ["call", "channels.update", "--path", "channel_id=12", "--json-file", str(body_path)]
+    elif command == "request":
+        args = ["request", "PUT", "/api/v1/channels/12", "--json-file", str(body_path)]
+    elif command == "batch":
+        plan = tmp_path / "operations.jsonl"
+        plan.write_text(json.dumps(operation) + "\n", encoding="utf-8")
+        args = ["batch", "run", str(plan)]
+    else:
+        plan = tmp_path / "operations.json"
+        plan.write_text(json.dumps([operation]), encoding="utf-8")
+        args = ["workflow", "run", "setup-web-channel", "--json-file", str(plan)]
+
+    assert main([*args, "--schema-file", channel_schema_file, "--dry-run"]) == 0
+    payload = json.loads(capsys.readouterr().out)
+    assert payload["method"] == "PUT"
+    assert payload["path"] == "/api/v1/channels/12"
+    assert payload["dry_run"] is True
+    assert payload["data"]["body"] == body
+    assert payload["data"]["body"]["config"]["open_agent_hide_process"] is hide_process
+
+
 def write_schema(tmp_path) -> str:
     path = tmp_path / "openapi.json"
     path.write_text(json.dumps(SAMPLE_SCHEMA), encoding="utf-8")