Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
docs(sdk): list the name filter and id refusal as missing from 0.5.0
Yudhi Armyndharis67af632e8d48
diff --git a/docs/18-sdk-design.md b/docs/18-sdk-design.mdindex e16b9bf42..3582d6928 100644--- a/docs/18-sdk-design.md+++ b/docs/18-sdk-design.md@@ -45,7 +45,7 @@ All five SDKs expose the same fluent surface:| `media` | conversionStatus, convertVoice _(OPERATOR)_, convertVideo _(OPERATOR)_ || `health` | check, live, ready |-The tables describe `main`. The 0.5.0 registry builds do not include `sessions.getProxy`, `sessions.updateProxy` or `messages.clickButton` (`get_proxy`, `update_proxy` and `click_button` in Python; `GetProxy`, `UpdateProxy` and `ClickButton` in Go); they ship with the next SDK release. The webhook signature helpers (`verifyWebhookSignature`, `verify_webhook_signature`, `VerifyWebhookSignature`, `WebhookSignature.verify`, `WebhookSignature::verify`), the `WebhookDelivery` types and the API error code, retry-delay and headers accessors are not in 0.5.0 either; they also ship with the next SDK release. Nor is the Java fallback to `UNKNOWN`: 0.5.0 decodes a response enum value it does not recognise to `null` (`MessageType` and `ChatKind` included), and `SessionStatus`, `DeliveryStatus` and the other response enums that lack an `unknown` wire value have no `UNKNOWN` constant there.+The tables describe `main`. The 0.5.0 registry builds do not include `sessions.getProxy`, `sessions.updateProxy` or `messages.clickButton` (`get_proxy`, `update_proxy` and `click_button` in Python; `GetProxy`, `UpdateProxy` and `ClickButton` in Go); they ship with the next SDK release. The webhook signature helpers (`verifyWebhookSignature`, `verify_webhook_signature`, `VerifyWebhookSignature`, `WebhookSignature.verify`, `WebhookSignature::verify`), the `WebhookDelivery` types and the API error code, retry-delay and headers accessors are not in 0.5.0 either; they also ship with the next SDK release. Nor is the Java fallback to `UNKNOWN`: 0.5.0 decodes a response enum value it does not recognise to `null` (`MessageType` and `ChatKind` included), and `SessionStatus`, `DeliveryStatus` and the other response enums that lack an `unknown` wire value have no `UNKNOWN` constant there. Nor is the `name` filter on `sessions.list` (`ListSessionsQuery.Name` in Go, the `name` field of `ListSessionsQuery` in Java, JavaScript and Python); it ships with the next SDK release. The refusal of an empty, `.` or `..` id (and, in the JavaScript, Go and Java raw-request methods, of a `.` or `..` path segment) and the PHP `sessions->create()` fix that sends an empty `config` as `{}` are not in 0.5.0 either; they ship with the next SDK release.> The SDKs cover the user-facing resources above and stop there. The administrative and operational surfaces are deliberately left out — `auth/api-keys`, `audit`, `settings`, `stats`, `automation`, `infra`, `plugins` and the `integration` management routes are predominantly `ADMIN`-gated; `metrics` is a `@Public()` Prometheus scrape gated by `METRICS_TOKEN` rather than by role; `mcp` is a Streamable-HTTP transport mounted straight onto the Express adapter; and `ingress` is the `@Public()` receiver that integration providers post into. `docker` has no HTTP surface at all — it is an internal service module. Methods that require an `OPERATOR`-level key are annotated **OPERATOR** in the per-language tables below.