Client API Reference
Generated reference for schema-registry client methods.
Client API Reference
packages/schema/scripts/gen-client-reference-docs.ts generates these pages from the schema registry and method files.
Preferred interface
Choose how you want to use open-wa. Code examples across the docs follow this choice. The SocketClient protocol is the basis for clients in other languages.
Namespaces
Business
3 client methods
ChatIds
1 client methods
Chats
15 client methods
Communities
6 client methods
Contacts
10 client methods
Groups
22 client methods
Labels
4 client methods
Media
2 client methods
Messages
39 client methods
Mystatus
1 client methods
Session
16 client methods
Status
6 client methods
How the client works
- Schema pipeline — one definition, many projections
- BaseClient — the generated flat client and dispatch table
- Namespaced client — namespace member mapping
- Argument normalization — positional vs object args, aliases
- Aliases — function and parameter key aliases
- Data models — Message, Contact, Chat, GroupMetadata
- Generated types — where input/output type aliases come from
- Worked example: sendText
- Events — registered events and payloads
- Licensed methods — what needs a license key
- All client methods — alphabetical index
Was this helpful?
Your answer includes the page path and docs version.