Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
docs(sdk): note what the 0.5.0 SDK builds do not include
Yudhi Armyndharis46f53fdc4a46
diff --git a/docs/18-sdk-design.md b/docs/18-sdk-design.mdindex 25f375d93..d0b622faf 100644--- a/docs/18-sdk-design.md+++ b/docs/18-sdk-design.md@@ -45,6 +45,8 @@ All five SDKs expose the same fluent surface:| `media` | conversionStatus, convertVoice, 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. 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 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.## 18.2 TypeScript / JavaScript SDK@@ -1171,4 +1173,4 @@ cd sdk/python && python -m pytest -qcd sdk/php && composer install && ./vendor/bin/phpunit```-CI runs all five suites (`sdk-ci.yml`), path-filtered to `sdk/**` plus the server-side contract surfaces the SDKs are written against — `src/**/dto/**`, `src/**/*.controller.ts`, `src/**/*.service.ts` and `whatsapp-engine.interface.ts` — so a change to the wire contract re-runs them. The PHP package is mirrored to its own Packagist repository via a `git subtree split`, and that mirror publish is gated on the PHP tests passing, so a broken SDK cannot auto-publish. Bump the version, update the SDK's CHANGELOG, run the suite above, then tag/publish to the relevant registry.+CI runs all five suites (`sdk-ci.yml`), path-filtered to `sdk/**` plus the server-side contract surfaces the SDKs are written against — `src/**/dto/**`, `src/**/*.controller.ts`, `src/**/*.service.ts` and `whatsapp-engine.interface.ts` — so a change to the wire contract re-runs them. The PHP package is mirrored to its own Packagist repository via a `git subtree split`, and that mirror publish is gated on the PHP tests passing, so a broken SDK cannot auto-publish. Bump the version, record the change in the root `CHANGELOG.md` `[Unreleased]` section prefixed with the SDK's name (for example `Java SDK:`), drop the methods it ships from the unreleased note in §18.1 and `sdk/README.md`, run the suite above, then tag/publish to the relevant registry.diff --git a/sdk/README.md b/sdk/README.mdindex f11788914..ae745c54d 100644--- a/sdk/README.md+++ b/sdk/README.md@@ -41,6 +41,15 @@ All five SDKs expose the same fluent resource surface:| `media` | conversionStatus, convertVoice, convertVideo _(OPERATOR)_ || `health` | check, live, ready |+The table describes `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.+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.+> ⚠️ Endpoints requiring an `OPERATOR`-level API key are noted in the inline> docs. Deliberately **not** exposed, matching `docs/18-sdk-design.md` exactly:> `auth`/api-keys, `audit`, `settings`, `stats`, `automation`, `infra`,