openclaw-client 1.1.0 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +99 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -56,21 +56,118 @@ interface OpenClawClientConfig {
|
|
|
56
56
|
|
|
57
57
|
#### Methods
|
|
58
58
|
|
|
59
|
+
**Connection Management**
|
|
59
60
|
- `connect(): Promise<HelloOk>` - Connect and authenticate
|
|
60
61
|
- `disconnect(): void` - Disconnect from Gateway
|
|
61
62
|
- `isConnected(): boolean` - Check connection status
|
|
63
|
+
- `getConnectionId(): string | null` - Get the current connection ID
|
|
62
64
|
- `addEventListener(listener): () => void` - Add event listener
|
|
65
|
+
|
|
66
|
+
**Configuration**
|
|
63
67
|
- `getConfig(params?): Promise<any>` - Get configuration
|
|
64
68
|
- `setConfig(params): Promise<any>` - Update configuration
|
|
69
|
+
- `getConfigSchema(params?): Promise<ConfigSchemaResponse>` - Get configuration schema
|
|
70
|
+
- `applyConfig(params): Promise<any>` - Apply configuration changes
|
|
71
|
+
- `patchConfig(params): Promise<any>` - Patch configuration
|
|
72
|
+
|
|
73
|
+
**Sessions**
|
|
65
74
|
- `listSessions(params?): Promise<any>` - List sessions
|
|
66
75
|
- `deleteSession(params): Promise<any>` - Delete a session
|
|
67
|
-
- `
|
|
76
|
+
- `previewSessions(params): Promise<any>` - Preview sessions
|
|
77
|
+
- `resolveSession(params): Promise<any>` - Resolve session
|
|
78
|
+
- `patchSession(params): Promise<any>` - Patch session
|
|
79
|
+
- `resetSession(params): Promise<any>` - Reset session
|
|
80
|
+
- `compactSession(params): Promise<any>` - Compact session
|
|
81
|
+
|
|
82
|
+
**Agents**
|
|
83
|
+
- `listAgents(params?): Promise<AgentsListResult>` - List available agents
|
|
84
|
+
- `getAgentIdentity(params?): Promise<AgentIdentityResult>` - Get agent identity
|
|
85
|
+
- `sendToAgent(params): Promise<any>` - Send a message to agent
|
|
86
|
+
- `waitForAgent(params): Promise<any>` - Wait for agent run to complete
|
|
87
|
+
|
|
88
|
+
**Agent Files**
|
|
68
89
|
- `getAgentFile(params): Promise<AgentsFilesGetResult>` - Get agent file
|
|
69
90
|
- `listAgentFiles(params): Promise<AgentsFilesListResult>` - List agent files
|
|
70
91
|
- `setAgentFile(params): Promise<AgentsFilesSetResult>` - Update agent file
|
|
92
|
+
|
|
93
|
+
**Models**
|
|
71
94
|
- `listModels(params?): Promise<ModelsListResult>` - List available models
|
|
95
|
+
|
|
96
|
+
**Messaging**
|
|
97
|
+
- `send(params): Promise<any>` - Send a message
|
|
98
|
+
- `poll(params): Promise<any>` - Send a poll
|
|
99
|
+
- `wake(params): Promise<any>` - Wake the system
|
|
100
|
+
|
|
101
|
+
**Chat**
|
|
102
|
+
- `getChatHistory(params): Promise<any>` - Get chat history
|
|
103
|
+
- `sendChat(params): Promise<any>` - Send chat message
|
|
104
|
+
- `abortChat(params): Promise<any>` - Abort chat
|
|
105
|
+
- `injectChat(params): Promise<any>` - Inject chat message
|
|
106
|
+
|
|
107
|
+
**Wizard**
|
|
108
|
+
- `startWizard(params?): Promise<WizardStartResult>` - Start wizard
|
|
109
|
+
- `wizardNext(params): Promise<WizardNextResult>` - Wizard next step
|
|
110
|
+
- `cancelWizard(params): Promise<any>` - Cancel wizard
|
|
111
|
+
- `getWizardStatus(params): Promise<WizardStatusResult>` - Get wizard status
|
|
112
|
+
|
|
113
|
+
**Channels**
|
|
114
|
+
- `getChannelsStatus(params?): Promise<ChannelsStatusResult>` - Get channels status
|
|
115
|
+
- `logoutChannel(params): Promise<any>` - Logout from channel
|
|
116
|
+
- `setTalkMode(params): Promise<any>` - Set talk mode
|
|
117
|
+
|
|
118
|
+
**Authentication**
|
|
119
|
+
- `startWebLogin(params?): Promise<any>` - Start web login
|
|
120
|
+
- `waitForWebLogin(params?): Promise<any>` - Wait for web login
|
|
121
|
+
|
|
122
|
+
**Skills**
|
|
123
|
+
- `getSkillsStatus(params?): Promise<any>` - Get skills status
|
|
124
|
+
- `getSkillsBins(params?): Promise<SkillsBinsResult>` - Get skills bins
|
|
125
|
+
- `installSkill(params): Promise<any>` - Install skill
|
|
126
|
+
- `updateSkill(params): Promise<any>` - Update skill
|
|
127
|
+
|
|
128
|
+
**Cron Jobs**
|
|
129
|
+
- `listCronJobs(params?): Promise<{ jobs: CronJob[] }>` - List cron jobs
|
|
130
|
+
- `getCronStatus(params?): Promise<any>` - Get cron status
|
|
131
|
+
- `addCronJob(params): Promise<{ job: CronJob }>` - Add cron job
|
|
132
|
+
- `updateCronJob(params): Promise<{ job: CronJob }>` - Update cron job
|
|
133
|
+
- `removeCronJob(params): Promise<any>` - Remove cron job
|
|
134
|
+
- `runCronJob(params): Promise<any>` - Run cron job
|
|
135
|
+
- `getCronRuns(params): Promise<{ runs: CronRunLogEntry[] }>` - Get cron job runs
|
|
136
|
+
|
|
137
|
+
**Execution Approvals**
|
|
138
|
+
- `getExecApprovals(params?): Promise<ExecApprovalsSnapshot>` - Get exec approvals
|
|
139
|
+
- `setExecApprovals(params): Promise<ExecApprovalsSnapshot>` - Set exec approvals
|
|
140
|
+
- `getNodeExecApprovals(params): Promise<ExecApprovalsSnapshot>` - Get node exec approvals
|
|
141
|
+
- `setNodeExecApprovals(params): Promise<ExecApprovalsSnapshot>` - Set node exec approvals
|
|
142
|
+
- `requestExecApproval(params): Promise<any>` - Request exec approval
|
|
143
|
+
- `resolveExecApproval(params): Promise<any>` - Resolve exec approval
|
|
144
|
+
|
|
145
|
+
**Device Pairing**
|
|
146
|
+
- `listDevicePairings(params?): Promise<any>` - List device pairing requests
|
|
147
|
+
- `approveDevicePairing(params): Promise<any>` - Approve device pairing
|
|
148
|
+
- `rejectDevicePairing(params): Promise<any>` - Reject device pairing
|
|
149
|
+
- `rotateDeviceToken(params): Promise<any>` - Rotate device token
|
|
150
|
+
- `revokeDeviceToken(params): Promise<any>` - Revoke device token
|
|
151
|
+
|
|
152
|
+
**Node Management**
|
|
153
|
+
- `requestNodePairing(params): Promise<any>` - Request node pairing
|
|
154
|
+
- `listNodePairings(params?): Promise<any>` - List node pairing requests
|
|
155
|
+
- `approveNodePairing(params): Promise<any>` - Approve node pairing
|
|
156
|
+
- `rejectNodePairing(params): Promise<any>` - Reject node pairing
|
|
157
|
+
- `verifyNodePairing(params): Promise<any>` - Verify node pairing
|
|
158
|
+
- `renameNode(params): Promise<any>` - Rename node
|
|
159
|
+
- `listNodes(params?): Promise<any>` - List nodes
|
|
160
|
+
- `describeNode(params): Promise<any>` - Describe node
|
|
161
|
+
- `invokeNode(params): Promise<any>` - Invoke node command
|
|
162
|
+
|
|
163
|
+
**Logs**
|
|
72
164
|
- `getLogTail(params?): Promise<LogsTailResult>` - Get log tail
|
|
73
|
-
|
|
165
|
+
|
|
166
|
+
**Updates**
|
|
167
|
+
- `updateRun(params): Promise<any>` - Update and run
|
|
168
|
+
|
|
169
|
+
**Generic**
|
|
170
|
+
- `call<T>(method, params?): Promise<T>` - Generic RPC method call for any method
|
|
74
171
|
|
|
75
172
|
### `ServerOpenClawClient`
|
|
76
173
|
|