@almadar/core 10.80.0 → 10.81.0
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/dist/builders.d.ts +3 -3
- package/dist/builders.js +28 -0
- package/dist/builders.js.map +1 -1
- package/dist/{effect-C4uehm-r.d.ts → effect-BHoSW19_.d.ts} +259 -4
- package/dist/{entityAccess-BMKFgmsc.d.ts → entityAccess-0POr1WuY.d.ts} +1 -1
- package/dist/factory/index.d.ts +4 -4
- package/dist/factory/index.js +400 -0
- package/dist/factory/index.js.map +1 -1
- package/dist/factory-runtime/index.d.ts +3 -3
- package/dist/factory-runtime/index.js +28 -0
- package/dist/factory-runtime/index.js.map +1 -1
- package/dist/{index-DqUnw2Oo.d.ts → index-rVlLkZJu.d.ts} +4 -4
- package/dist/index.d.ts +10 -10
- package/dist/index.js +1553 -406
- package/dist/index.js.map +1 -1
- package/dist/mock/index.d.ts +4 -4
- package/dist/mock/index.js +28 -0
- package/dist/mock/index.js.map +1 -1
- package/dist/patterns/component-mapping.json +11 -1
- package/dist/patterns/event-contracts.json +1 -1
- package/dist/patterns/index.d.ts +2611 -438
- package/dist/patterns/index.js +1391 -405
- package/dist/patterns/index.js.map +1 -1
- package/dist/patterns/integrators-registry.json +1004 -402
- package/dist/patterns/patterns-registry.json +373 -1
- package/dist/patterns/registry.json +373 -1
- package/dist/patterns/services-registry.json +1171 -424
- package/dist/{schema-Cma07_18.d.ts → schema-CkTTGH6l.d.ts} +2 -2
- package/dist/{trait-BXkQKZbO.d.ts → trait-D269f6pt.d.ts} +1 -1
- package/dist/types/index.d.ts +5 -5
- package/dist/types/index.js +164 -1
- package/dist/types/index.js.map +1 -1
- package/dist/{types-DoAKLgCZ.d.ts → types-7PHjoE7m.d.ts} +2 -2
- package/package.json +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": "1.0.0",
|
|
3
|
-
"exportedAt": "2026-
|
|
3
|
+
"exportedAt": "2026-09-03T08:33:38.850Z",
|
|
4
4
|
"integrators": {
|
|
5
5
|
"github": {
|
|
6
6
|
"name": "github",
|
|
@@ -9,25 +9,25 @@
|
|
|
9
9
|
"actions": [
|
|
10
10
|
{
|
|
11
11
|
"name": "cloneRepo",
|
|
12
|
-
"description": "",
|
|
12
|
+
"description": "Clone a repository via the git CLI into a local target directory, using the configured token for auth.",
|
|
13
13
|
"params": [
|
|
14
14
|
{
|
|
15
15
|
"name": "repoUrl",
|
|
16
16
|
"type": "string",
|
|
17
17
|
"required": true,
|
|
18
|
-
"description": ""
|
|
18
|
+
"description": "HTTPS clone URL, e.g. https://github.com/owner/repo. Owner/repo are parsed from it when not preconfigured."
|
|
19
19
|
},
|
|
20
20
|
{
|
|
21
21
|
"name": "targetDir",
|
|
22
22
|
"type": "string",
|
|
23
23
|
"required": true,
|
|
24
|
-
"description": ""
|
|
24
|
+
"description": "Local directory to clone into."
|
|
25
25
|
},
|
|
26
26
|
{
|
|
27
27
|
"name": "branch",
|
|
28
28
|
"type": "string",
|
|
29
29
|
"required": false,
|
|
30
|
-
"description": ""
|
|
30
|
+
"description": "Branch to check out after cloning; defaults to the repo's default branch."
|
|
31
31
|
}
|
|
32
32
|
],
|
|
33
33
|
"responseShape": {
|
|
@@ -36,19 +36,19 @@
|
|
|
36
36
|
},
|
|
37
37
|
{
|
|
38
38
|
"name": "createBranch",
|
|
39
|
-
"description": "",
|
|
39
|
+
"description": "Create a new local branch via the git CLI in the configured working directory.",
|
|
40
40
|
"params": [
|
|
41
41
|
{
|
|
42
42
|
"name": "branchName",
|
|
43
43
|
"type": "string",
|
|
44
44
|
"required": true,
|
|
45
|
-
"description": ""
|
|
45
|
+
"description": "Name of the branch to create."
|
|
46
46
|
},
|
|
47
47
|
{
|
|
48
48
|
"name": "baseBranch",
|
|
49
49
|
"type": "string",
|
|
50
50
|
"required": false,
|
|
51
|
-
"description": ""
|
|
51
|
+
"description": "Branch to branch from; defaults to the current branch."
|
|
52
52
|
}
|
|
53
53
|
],
|
|
54
54
|
"responseShape": {
|
|
@@ -57,19 +57,19 @@
|
|
|
57
57
|
},
|
|
58
58
|
{
|
|
59
59
|
"name": "commit",
|
|
60
|
-
"description": "",
|
|
60
|
+
"description": "Commit staged (or given) changes via the git CLI in the configured working directory.",
|
|
61
61
|
"params": [
|
|
62
62
|
{
|
|
63
63
|
"name": "message",
|
|
64
64
|
"type": "string",
|
|
65
65
|
"required": true,
|
|
66
|
-
"description": ""
|
|
66
|
+
"description": "Commit message."
|
|
67
67
|
},
|
|
68
68
|
{
|
|
69
69
|
"name": "files",
|
|
70
70
|
"type": "string[]",
|
|
71
71
|
"required": false,
|
|
72
|
-
"description": ""
|
|
72
|
+
"description": "Specific files to commit; when omitted, all changes are committed."
|
|
73
73
|
}
|
|
74
74
|
],
|
|
75
75
|
"responseShape": {
|
|
@@ -78,19 +78,19 @@
|
|
|
78
78
|
},
|
|
79
79
|
{
|
|
80
80
|
"name": "push",
|
|
81
|
-
"description": "",
|
|
81
|
+
"description": "Push a local branch to the remote via the git CLI, using the configured token for auth.",
|
|
82
82
|
"params": [
|
|
83
83
|
{
|
|
84
84
|
"name": "branchName",
|
|
85
85
|
"type": "string",
|
|
86
86
|
"required": true,
|
|
87
|
-
"description": ""
|
|
87
|
+
"description": "Branch name to push."
|
|
88
88
|
},
|
|
89
89
|
{
|
|
90
90
|
"name": "force",
|
|
91
91
|
"type": "boolean",
|
|
92
92
|
"required": false,
|
|
93
|
-
"description": ""
|
|
93
|
+
"description": "Force-push (overwrites remote history); never set true in an agent context."
|
|
94
94
|
}
|
|
95
95
|
],
|
|
96
96
|
"responseShape": {
|
|
@@ -99,37 +99,37 @@
|
|
|
99
99
|
},
|
|
100
100
|
{
|
|
101
101
|
"name": "createPR",
|
|
102
|
-
"description": "",
|
|
102
|
+
"description": "Open a pull request via the GitHub REST API.",
|
|
103
103
|
"params": [
|
|
104
104
|
{
|
|
105
105
|
"name": "title",
|
|
106
106
|
"type": "string",
|
|
107
107
|
"required": true,
|
|
108
|
-
"description": ""
|
|
108
|
+
"description": "Pull request title."
|
|
109
109
|
},
|
|
110
110
|
{
|
|
111
111
|
"name": "body",
|
|
112
112
|
"type": "string",
|
|
113
113
|
"required": true,
|
|
114
|
-
"description": ""
|
|
114
|
+
"description": "Pull request description body."
|
|
115
115
|
},
|
|
116
116
|
{
|
|
117
117
|
"name": "baseBranch",
|
|
118
118
|
"type": "string",
|
|
119
119
|
"required": true,
|
|
120
|
-
"description": ""
|
|
120
|
+
"description": "Branch the PR merges into, e.g. main."
|
|
121
121
|
},
|
|
122
122
|
{
|
|
123
123
|
"name": "headBranch",
|
|
124
124
|
"type": "string",
|
|
125
125
|
"required": true,
|
|
126
|
-
"description": ""
|
|
126
|
+
"description": "Branch the PR merges from (the feature branch)."
|
|
127
127
|
},
|
|
128
128
|
{
|
|
129
129
|
"name": "draft",
|
|
130
130
|
"type": "boolean",
|
|
131
131
|
"required": false,
|
|
132
|
-
"description": ""
|
|
132
|
+
"description": "Open as a draft PR instead of ready-for-review."
|
|
133
133
|
}
|
|
134
134
|
],
|
|
135
135
|
"responseShape": {
|
|
@@ -140,55 +140,93 @@
|
|
|
140
140
|
},
|
|
141
141
|
{
|
|
142
142
|
"name": "getPRComments",
|
|
143
|
-
"description": "",
|
|
143
|
+
"description": "List review comments on a pull request via the GitHub REST API.",
|
|
144
144
|
"params": [
|
|
145
145
|
{
|
|
146
146
|
"name": "prNumber",
|
|
147
147
|
"type": "number",
|
|
148
148
|
"required": true,
|
|
149
|
-
"description": ""
|
|
149
|
+
"description": "Pull request number."
|
|
150
150
|
}
|
|
151
151
|
],
|
|
152
152
|
"responseShape": {
|
|
153
|
-
"comments":
|
|
153
|
+
"comments": {
|
|
154
|
+
"type": "array",
|
|
155
|
+
"items": {
|
|
156
|
+
"type": "object",
|
|
157
|
+
"properties": {
|
|
158
|
+
"id": {
|
|
159
|
+
"type": "number",
|
|
160
|
+
"required": true
|
|
161
|
+
},
|
|
162
|
+
"body": {
|
|
163
|
+
"type": "string",
|
|
164
|
+
"required": true
|
|
165
|
+
},
|
|
166
|
+
"user": {
|
|
167
|
+
"type": "string",
|
|
168
|
+
"required": true
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
}
|
|
172
|
+
}
|
|
154
173
|
}
|
|
155
174
|
},
|
|
156
175
|
{
|
|
157
176
|
"name": "listIssues",
|
|
158
|
-
"description": "",
|
|
177
|
+
"description": "List issues on the configured repository via the GitHub REST API.",
|
|
159
178
|
"params": [
|
|
160
179
|
{
|
|
161
180
|
"name": "state",
|
|
162
181
|
"type": "string",
|
|
163
182
|
"required": false,
|
|
164
|
-
"description": ""
|
|
183
|
+
"description": "Issue state filter: 'open', 'closed', or 'all'; defaults to open."
|
|
165
184
|
},
|
|
166
185
|
{
|
|
167
186
|
"name": "labels",
|
|
168
187
|
"type": "string[]",
|
|
169
188
|
"required": false,
|
|
170
|
-
"description": ""
|
|
189
|
+
"description": "Only issues carrying all of these labels."
|
|
171
190
|
},
|
|
172
191
|
{
|
|
173
192
|
"name": "per_page",
|
|
174
193
|
"type": "number",
|
|
175
194
|
"required": false,
|
|
176
|
-
"description": ""
|
|
195
|
+
"description": "Page size for the GitHub API request."
|
|
177
196
|
}
|
|
178
197
|
],
|
|
179
198
|
"responseShape": {
|
|
180
|
-
"issues":
|
|
199
|
+
"issues": {
|
|
200
|
+
"type": "array",
|
|
201
|
+
"items": {
|
|
202
|
+
"type": "object",
|
|
203
|
+
"properties": {
|
|
204
|
+
"number": {
|
|
205
|
+
"type": "number",
|
|
206
|
+
"required": true
|
|
207
|
+
},
|
|
208
|
+
"title": {
|
|
209
|
+
"type": "string",
|
|
210
|
+
"required": true
|
|
211
|
+
},
|
|
212
|
+
"state": {
|
|
213
|
+
"type": "string",
|
|
214
|
+
"required": true
|
|
215
|
+
}
|
|
216
|
+
}
|
|
217
|
+
}
|
|
218
|
+
}
|
|
181
219
|
}
|
|
182
220
|
},
|
|
183
221
|
{
|
|
184
222
|
"name": "getIssue",
|
|
185
|
-
"description": "",
|
|
223
|
+
"description": "Fetch a single issue's details via the GitHub REST API.",
|
|
186
224
|
"params": [
|
|
187
225
|
{
|
|
188
226
|
"name": "issueNumber",
|
|
189
227
|
"type": "number",
|
|
190
228
|
"required": true,
|
|
191
|
-
"description": ""
|
|
229
|
+
"description": "Issue number."
|
|
192
230
|
}
|
|
193
231
|
],
|
|
194
232
|
"responseShape": {
|
|
@@ -200,31 +238,31 @@
|
|
|
200
238
|
},
|
|
201
239
|
{
|
|
202
240
|
"name": "getFile",
|
|
203
|
-
"description": "",
|
|
241
|
+
"description": "Read a file's content from a repository at a given ref (declared intent — dispatch is being wired).",
|
|
204
242
|
"params": [
|
|
205
243
|
{
|
|
206
244
|
"name": "owner",
|
|
207
245
|
"type": "string",
|
|
208
246
|
"required": true,
|
|
209
|
-
"description": ""
|
|
247
|
+
"description": "Repository owner (user or org)."
|
|
210
248
|
},
|
|
211
249
|
{
|
|
212
250
|
"name": "repo",
|
|
213
251
|
"type": "string",
|
|
214
252
|
"required": true,
|
|
215
|
-
"description": ""
|
|
253
|
+
"description": "Repository name."
|
|
216
254
|
},
|
|
217
255
|
{
|
|
218
256
|
"name": "path",
|
|
219
257
|
"type": "string",
|
|
220
258
|
"required": true,
|
|
221
|
-
"description": ""
|
|
259
|
+
"description": "File path within the repository."
|
|
222
260
|
},
|
|
223
261
|
{
|
|
224
262
|
"name": "ref",
|
|
225
263
|
"type": "string",
|
|
226
264
|
"required": false,
|
|
227
|
-
"description": ""
|
|
265
|
+
"description": "Branch, tag, or commit SHA to read from; defaults to the default branch."
|
|
228
266
|
}
|
|
229
267
|
],
|
|
230
268
|
"responseShape": {
|
|
@@ -236,76 +274,99 @@
|
|
|
236
274
|
},
|
|
237
275
|
{
|
|
238
276
|
"name": "listCommits",
|
|
239
|
-
"description": "",
|
|
277
|
+
"description": "List commits on a repository, optionally filtered by file path (declared intent — dispatch is being wired).",
|
|
240
278
|
"params": [
|
|
241
279
|
{
|
|
242
280
|
"name": "owner",
|
|
243
281
|
"type": "string",
|
|
244
282
|
"required": true,
|
|
245
|
-
"description": ""
|
|
283
|
+
"description": "Repository owner (user or org)."
|
|
246
284
|
},
|
|
247
285
|
{
|
|
248
286
|
"name": "repo",
|
|
249
287
|
"type": "string",
|
|
250
288
|
"required": true,
|
|
251
|
-
"description": ""
|
|
289
|
+
"description": "Repository name."
|
|
252
290
|
},
|
|
253
291
|
{
|
|
254
292
|
"name": "path",
|
|
255
293
|
"type": "string",
|
|
256
294
|
"required": false,
|
|
257
|
-
"description": ""
|
|
295
|
+
"description": "Only commits touching this file path."
|
|
258
296
|
},
|
|
259
297
|
{
|
|
260
298
|
"name": "ref",
|
|
261
299
|
"type": "string",
|
|
262
300
|
"required": false,
|
|
263
|
-
"description": ""
|
|
301
|
+
"description": "Branch, tag, or commit SHA to start from; defaults to the default branch."
|
|
264
302
|
},
|
|
265
303
|
{
|
|
266
304
|
"name": "per_page",
|
|
267
305
|
"type": "number",
|
|
268
306
|
"required": false,
|
|
269
|
-
"description": ""
|
|
307
|
+
"description": "Page size for the GitHub API request."
|
|
270
308
|
}
|
|
271
309
|
],
|
|
272
310
|
"responseShape": {
|
|
273
|
-
"commits":
|
|
311
|
+
"commits": {
|
|
312
|
+
"type": "array",
|
|
313
|
+
"items": {
|
|
314
|
+
"type": "object",
|
|
315
|
+
"properties": {
|
|
316
|
+
"sha": {
|
|
317
|
+
"type": "string",
|
|
318
|
+
"required": true
|
|
319
|
+
},
|
|
320
|
+
"message": {
|
|
321
|
+
"type": "string",
|
|
322
|
+
"required": true
|
|
323
|
+
},
|
|
324
|
+
"author": {
|
|
325
|
+
"type": "string",
|
|
326
|
+
"required": true
|
|
327
|
+
},
|
|
328
|
+
"date": {
|
|
329
|
+
"type": "string",
|
|
330
|
+
"required": true
|
|
331
|
+
}
|
|
332
|
+
}
|
|
333
|
+
}
|
|
334
|
+
}
|
|
274
335
|
}
|
|
275
336
|
},
|
|
276
337
|
{
|
|
277
338
|
"name": "createIssue",
|
|
278
|
-
"description": "",
|
|
339
|
+
"description": "Open a new issue on a repository (declared intent — dispatch is being wired).",
|
|
279
340
|
"params": [
|
|
280
341
|
{
|
|
281
342
|
"name": "owner",
|
|
282
343
|
"type": "string",
|
|
283
344
|
"required": true,
|
|
284
|
-
"description": ""
|
|
345
|
+
"description": "Repository owner (user or org)."
|
|
285
346
|
},
|
|
286
347
|
{
|
|
287
348
|
"name": "repo",
|
|
288
349
|
"type": "string",
|
|
289
350
|
"required": true,
|
|
290
|
-
"description": ""
|
|
351
|
+
"description": "Repository name."
|
|
291
352
|
},
|
|
292
353
|
{
|
|
293
354
|
"name": "title",
|
|
294
355
|
"type": "string",
|
|
295
356
|
"required": true,
|
|
296
|
-
"description": ""
|
|
357
|
+
"description": "Issue title."
|
|
297
358
|
},
|
|
298
359
|
{
|
|
299
360
|
"name": "body",
|
|
300
361
|
"type": "string",
|
|
301
362
|
"required": false,
|
|
302
|
-
"description": ""
|
|
363
|
+
"description": "Issue body/description."
|
|
303
364
|
},
|
|
304
365
|
{
|
|
305
366
|
"name": "labels",
|
|
306
367
|
"type": "string[]",
|
|
307
368
|
"required": false,
|
|
308
|
-
"description": ""
|
|
369
|
+
"description": "Labels to apply to the new issue."
|
|
309
370
|
}
|
|
310
371
|
],
|
|
311
372
|
"responseShape": {
|
|
@@ -323,25 +384,25 @@
|
|
|
323
384
|
"actions": [
|
|
324
385
|
{
|
|
325
386
|
"name": "createPaymentIntent",
|
|
326
|
-
"description": "",
|
|
387
|
+
"description": "Create a Stripe PaymentIntent for a one-off charge.",
|
|
327
388
|
"params": [
|
|
328
389
|
{
|
|
329
390
|
"name": "amount",
|
|
330
391
|
"type": "number",
|
|
331
392
|
"required": true,
|
|
332
|
-
"description": ""
|
|
393
|
+
"description": "Charge amount in the currency's smallest unit (e.g. cents for USD)."
|
|
333
394
|
},
|
|
334
395
|
{
|
|
335
396
|
"name": "currency",
|
|
336
397
|
"type": "string",
|
|
337
398
|
"required": true,
|
|
338
|
-
"description": ""
|
|
399
|
+
"description": "ISO 4217 currency code, e.g. usd."
|
|
339
400
|
},
|
|
340
401
|
{
|
|
341
402
|
"name": "metadata",
|
|
342
403
|
"type": "object",
|
|
343
404
|
"required": false,
|
|
344
|
-
"description": ""
|
|
405
|
+
"description": "Arbitrary key-value tags attached to the PaymentIntent (string values only)."
|
|
345
406
|
}
|
|
346
407
|
],
|
|
347
408
|
"responseShape": {
|
|
@@ -350,17 +411,18 @@
|
|
|
350
411
|
"status": "string",
|
|
351
412
|
"amount": "number",
|
|
352
413
|
"currency": "string"
|
|
353
|
-
}
|
|
414
|
+
},
|
|
415
|
+
"synonyms": "charge, pay"
|
|
354
416
|
},
|
|
355
417
|
{
|
|
356
418
|
"name": "confirmPayment",
|
|
357
|
-
"description": "",
|
|
419
|
+
"description": "Confirm a previously created PaymentIntent, attempting to complete the charge.",
|
|
358
420
|
"params": [
|
|
359
421
|
{
|
|
360
422
|
"name": "paymentIntentId",
|
|
361
423
|
"type": "string",
|
|
362
424
|
"required": true,
|
|
363
|
-
"description": ""
|
|
425
|
+
"description": "The PaymentIntent id returned by createPaymentIntent."
|
|
364
426
|
}
|
|
365
427
|
],
|
|
366
428
|
"responseShape": {
|
|
@@ -370,19 +432,19 @@
|
|
|
370
432
|
},
|
|
371
433
|
{
|
|
372
434
|
"name": "refund",
|
|
373
|
-
"description": "",
|
|
435
|
+
"description": "Refund a charged PaymentIntent, in full or in part.",
|
|
374
436
|
"params": [
|
|
375
437
|
{
|
|
376
438
|
"name": "paymentIntentId",
|
|
377
439
|
"type": "string",
|
|
378
440
|
"required": true,
|
|
379
|
-
"description": ""
|
|
441
|
+
"description": "The PaymentIntent id to refund."
|
|
380
442
|
},
|
|
381
443
|
{
|
|
382
444
|
"name": "amount",
|
|
383
445
|
"type": "number",
|
|
384
446
|
"required": false,
|
|
385
|
-
"description": ""
|
|
447
|
+
"description": "Amount to refund in the currency's smallest unit; omit for a full refund."
|
|
386
448
|
}
|
|
387
449
|
],
|
|
388
450
|
"responseShape": {
|
|
@@ -400,65 +462,85 @@
|
|
|
400
462
|
"actions": [
|
|
401
463
|
{
|
|
402
464
|
"name": "generate",
|
|
403
|
-
"description": "",
|
|
465
|
+
"description": "Generate free-form text from a prompt via the configured LLM provider (default 'You are a helpful assistant.' system prompt).",
|
|
404
466
|
"params": [
|
|
405
467
|
{
|
|
406
468
|
"name": "userPrompt",
|
|
407
469
|
"type": "string",
|
|
408
470
|
"required": true,
|
|
409
|
-
"description": ""
|
|
471
|
+
"description": "The user/task prompt sent to the model."
|
|
410
472
|
},
|
|
411
473
|
{
|
|
412
474
|
"name": "systemPrompt",
|
|
413
475
|
"type": "string",
|
|
414
476
|
"required": false,
|
|
415
|
-
"description": ""
|
|
477
|
+
"description": "System prompt steering the model's behavior; defaults to a generic assistant prompt."
|
|
416
478
|
},
|
|
417
479
|
{
|
|
418
480
|
"name": "model",
|
|
419
481
|
"type": "string",
|
|
420
482
|
"required": false,
|
|
421
|
-
"description": ""
|
|
483
|
+
"description": "Model id override; when set, a fresh client is built for this call instead of the shared one."
|
|
422
484
|
},
|
|
423
485
|
{
|
|
424
486
|
"name": "temperature",
|
|
425
487
|
"type": "number",
|
|
426
488
|
"required": false,
|
|
427
|
-
"description": ""
|
|
489
|
+
"description": "Sampling temperature (0-1ish, provider-dependent); higher is more random."
|
|
428
490
|
},
|
|
429
491
|
{
|
|
430
492
|
"name": "maxTokens",
|
|
431
493
|
"type": "number",
|
|
432
494
|
"required": false,
|
|
433
|
-
"description": ""
|
|
495
|
+
"description": "Maximum tokens to generate; defaults to 1024."
|
|
434
496
|
}
|
|
435
497
|
],
|
|
436
498
|
"responseShape": {
|
|
437
499
|
"content": "string",
|
|
438
|
-
"usage":
|
|
500
|
+
"usage": {
|
|
501
|
+
"type": "object",
|
|
502
|
+
"properties": {
|
|
503
|
+
"promptTokens": {
|
|
504
|
+
"type": "number",
|
|
505
|
+
"required": false
|
|
506
|
+
},
|
|
507
|
+
"completionTokens": {
|
|
508
|
+
"type": "number",
|
|
509
|
+
"required": false
|
|
510
|
+
},
|
|
511
|
+
"totalTokens": {
|
|
512
|
+
"type": "number",
|
|
513
|
+
"required": false
|
|
514
|
+
},
|
|
515
|
+
"tokens": {
|
|
516
|
+
"type": "number",
|
|
517
|
+
"required": false
|
|
518
|
+
}
|
|
519
|
+
}
|
|
520
|
+
}
|
|
439
521
|
}
|
|
440
522
|
},
|
|
441
523
|
{
|
|
442
524
|
"name": "classify",
|
|
443
|
-
"description": "",
|
|
525
|
+
"description": "Classify text into exactly one of a caller-supplied category list, with a confidence score and reasoning.",
|
|
444
526
|
"params": [
|
|
445
527
|
{
|
|
446
528
|
"name": "text",
|
|
447
529
|
"type": "string",
|
|
448
530
|
"required": true,
|
|
449
|
-
"description": ""
|
|
531
|
+
"description": "Text to classify."
|
|
450
532
|
},
|
|
451
533
|
{
|
|
452
534
|
"name": "categories",
|
|
453
535
|
"type": "string[]",
|
|
454
536
|
"required": true,
|
|
455
|
-
"description": ""
|
|
537
|
+
"description": "Closed set of category labels the model must choose from."
|
|
456
538
|
},
|
|
457
539
|
{
|
|
458
540
|
"name": "model",
|
|
459
541
|
"type": "string",
|
|
460
542
|
"required": false,
|
|
461
|
-
"description": ""
|
|
543
|
+
"description": "Model id override."
|
|
462
544
|
}
|
|
463
545
|
],
|
|
464
546
|
"responseShape": {
|
|
@@ -469,56 +551,56 @@
|
|
|
469
551
|
},
|
|
470
552
|
{
|
|
471
553
|
"name": "extract",
|
|
472
|
-
"description": "",
|
|
554
|
+
"description": "Extract structured data from text according to a JSON-schema-shaped description; returned data is not validated against the schema.",
|
|
473
555
|
"params": [
|
|
474
556
|
{
|
|
475
557
|
"name": "text",
|
|
476
558
|
"type": "string",
|
|
477
559
|
"required": true,
|
|
478
|
-
"description": ""
|
|
560
|
+
"description": "Source text to extract data from."
|
|
479
561
|
},
|
|
480
562
|
{
|
|
481
563
|
"name": "schema",
|
|
482
564
|
"type": "IntegrationParams",
|
|
483
565
|
"required": true,
|
|
484
|
-
"description": ""
|
|
566
|
+
"description": "JSON-schema-like description of the fields to extract; passed to the model as a prompt, not enforced structurally."
|
|
485
567
|
},
|
|
486
568
|
{
|
|
487
569
|
"name": "model",
|
|
488
570
|
"type": "string",
|
|
489
571
|
"required": false,
|
|
490
|
-
"description": ""
|
|
572
|
+
"description": "Model id override."
|
|
491
573
|
}
|
|
492
574
|
],
|
|
493
575
|
"responseShape": {}
|
|
494
576
|
},
|
|
495
577
|
{
|
|
496
578
|
"name": "summarize",
|
|
497
|
-
"description": "",
|
|
579
|
+
"description": "Summarize text, optionally constrained by length and style, returning a summary plus key points.",
|
|
498
580
|
"params": [
|
|
499
581
|
{
|
|
500
582
|
"name": "text",
|
|
501
583
|
"type": "string",
|
|
502
584
|
"required": true,
|
|
503
|
-
"description": ""
|
|
585
|
+
"description": "Text to summarize."
|
|
504
586
|
},
|
|
505
587
|
{
|
|
506
588
|
"name": "maxLength",
|
|
507
589
|
"type": "number",
|
|
508
590
|
"required": false,
|
|
509
|
-
"description": ""
|
|
591
|
+
"description": "Target maximum summary length in words."
|
|
510
592
|
},
|
|
511
593
|
{
|
|
512
594
|
"name": "style",
|
|
513
595
|
"type": "string",
|
|
514
596
|
"required": false,
|
|
515
|
-
"description": ""
|
|
597
|
+
"description": "Summary style: 'bullet' for bullet points, 'detailed' for thorough, otherwise concise."
|
|
516
598
|
},
|
|
517
599
|
{
|
|
518
600
|
"name": "model",
|
|
519
601
|
"type": "string",
|
|
520
602
|
"required": false,
|
|
521
|
-
"description": ""
|
|
603
|
+
"description": "Model id override."
|
|
522
604
|
}
|
|
523
605
|
],
|
|
524
606
|
"responseShape": {
|
|
@@ -528,19 +610,19 @@
|
|
|
528
610
|
},
|
|
529
611
|
{
|
|
530
612
|
"name": "embed",
|
|
531
|
-
"description": "",
|
|
613
|
+
"description": "Generate embedding vectors for an array of texts via the configured embedding model (default baai/bge-base-en-v1.5 on OpenRouter, independent of the chat provider).",
|
|
532
614
|
"params": [
|
|
533
615
|
{
|
|
534
616
|
"name": "texts",
|
|
535
617
|
"type": "string[]",
|
|
536
618
|
"required": true,
|
|
537
|
-
"description": ""
|
|
619
|
+
"description": "Texts to embed, one vector per entry, in order."
|
|
538
620
|
},
|
|
539
621
|
{
|
|
540
622
|
"name": "model",
|
|
541
623
|
"type": "string",
|
|
542
624
|
"required": false,
|
|
543
|
-
"description": ""
|
|
625
|
+
"description": "Embedding model id override."
|
|
544
626
|
}
|
|
545
627
|
],
|
|
546
628
|
"responseShape": {
|
|
@@ -556,19 +638,19 @@
|
|
|
556
638
|
"actions": [
|
|
557
639
|
{
|
|
558
640
|
"name": "infer",
|
|
559
|
-
"description": "",
|
|
641
|
+
"description": "Run inference against a deployed model-serving orbital by posting an INFER event and reading the prediction back out of the emitted INFERRED result; may cold-start (up to 60s default timeout).",
|
|
560
642
|
"params": [
|
|
561
643
|
{
|
|
562
644
|
"name": "model",
|
|
563
645
|
"type": "string",
|
|
564
646
|
"required": true,
|
|
565
|
-
"description": ""
|
|
647
|
+
"description": "Checkpoint or model identifier the serving orbital resolves."
|
|
566
648
|
},
|
|
567
649
|
{
|
|
568
650
|
"name": "input",
|
|
569
651
|
"type": "ServiceParamsValue",
|
|
570
652
|
"required": true,
|
|
571
|
-
"description": ""
|
|
653
|
+
"description": "JSON-safe model input payload."
|
|
572
654
|
}
|
|
573
655
|
],
|
|
574
656
|
"responseShape": {
|
|
@@ -586,38 +668,38 @@
|
|
|
586
668
|
"actions": [
|
|
587
669
|
{
|
|
588
670
|
"name": "search",
|
|
589
|
-
"description": "",
|
|
671
|
+
"description": "Search YouTube via the Data API and return matching video snippets.",
|
|
590
672
|
"params": [
|
|
591
673
|
{
|
|
592
674
|
"name": "query",
|
|
593
675
|
"type": "string",
|
|
594
676
|
"required": true,
|
|
595
|
-
"description": ""
|
|
677
|
+
"description": "Search query text."
|
|
596
678
|
},
|
|
597
679
|
{
|
|
598
680
|
"name": "maxResults",
|
|
599
681
|
"type": "number",
|
|
600
682
|
"required": false,
|
|
601
|
-
"description": ""
|
|
683
|
+
"description": "Maximum number of results; defaults to 10."
|
|
602
684
|
},
|
|
603
685
|
{
|
|
604
686
|
"name": "type",
|
|
605
687
|
"type": "string",
|
|
606
688
|
"required": false,
|
|
607
|
-
"description": ""
|
|
689
|
+
"description": "Resource type filter passed to the Data API (e.g. 'video', 'channel', 'playlist')."
|
|
608
690
|
}
|
|
609
691
|
],
|
|
610
692
|
"responseShape": {}
|
|
611
693
|
},
|
|
612
694
|
{
|
|
613
695
|
"name": "getVideo",
|
|
614
|
-
"description": "",
|
|
696
|
+
"description": "Fetch a video's snippet and statistics via the YouTube Data API.",
|
|
615
697
|
"params": [
|
|
616
698
|
{
|
|
617
699
|
"name": "videoId",
|
|
618
700
|
"type": "string",
|
|
619
701
|
"required": true,
|
|
620
|
-
"description": ""
|
|
702
|
+
"description": "YouTube video id."
|
|
621
703
|
}
|
|
622
704
|
],
|
|
623
705
|
"responseShape": {
|
|
@@ -629,13 +711,13 @@
|
|
|
629
711
|
},
|
|
630
712
|
{
|
|
631
713
|
"name": "getChannel",
|
|
632
|
-
"description": "",
|
|
714
|
+
"description": "Fetch a channel's snippet and statistics via the YouTube Data API.",
|
|
633
715
|
"params": [
|
|
634
716
|
{
|
|
635
717
|
"name": "channelId",
|
|
636
718
|
"type": "string",
|
|
637
719
|
"required": true,
|
|
638
|
-
"description": ""
|
|
720
|
+
"description": "YouTube channel id."
|
|
639
721
|
}
|
|
640
722
|
],
|
|
641
723
|
"responseShape": {
|
|
@@ -653,47 +735,48 @@
|
|
|
653
735
|
"actions": [
|
|
654
736
|
{
|
|
655
737
|
"name": "sendSMS",
|
|
656
|
-
"description": "",
|
|
738
|
+
"description": "Send an SMS message via Twilio.",
|
|
657
739
|
"params": [
|
|
658
740
|
{
|
|
659
741
|
"name": "to",
|
|
660
742
|
"type": "string",
|
|
661
743
|
"required": true,
|
|
662
|
-
"description": ""
|
|
744
|
+
"description": "Destination phone number, E.164 format."
|
|
663
745
|
},
|
|
664
746
|
{
|
|
665
747
|
"name": "body",
|
|
666
748
|
"type": "string",
|
|
667
749
|
"required": true,
|
|
668
|
-
"description": ""
|
|
750
|
+
"description": "Message text."
|
|
669
751
|
},
|
|
670
752
|
{
|
|
671
753
|
"name": "from",
|
|
672
754
|
"type": "string",
|
|
673
755
|
"required": false,
|
|
674
|
-
"description": ""
|
|
756
|
+
"description": "Sender phone number; defaults to TWILIO_PHONE_NUMBER."
|
|
675
757
|
}
|
|
676
758
|
],
|
|
677
759
|
"responseShape": {
|
|
678
760
|
"sid": "string",
|
|
679
761
|
"status": "string"
|
|
680
|
-
}
|
|
762
|
+
},
|
|
763
|
+
"synonyms": "text message, text"
|
|
681
764
|
},
|
|
682
765
|
{
|
|
683
766
|
"name": "sendWhatsApp",
|
|
684
|
-
"description": "",
|
|
767
|
+
"description": "Send a WhatsApp message via Twilio, using the configured phone number as sender on both ends.",
|
|
685
768
|
"params": [
|
|
686
769
|
{
|
|
687
770
|
"name": "to",
|
|
688
771
|
"type": "string",
|
|
689
772
|
"required": true,
|
|
690
|
-
"description": ""
|
|
773
|
+
"description": "Destination phone number, E.164 format (sent as whatsapp:number)."
|
|
691
774
|
},
|
|
692
775
|
{
|
|
693
776
|
"name": "body",
|
|
694
777
|
"type": "string",
|
|
695
778
|
"required": true,
|
|
696
|
-
"description": ""
|
|
779
|
+
"description": "Message text."
|
|
697
780
|
}
|
|
698
781
|
],
|
|
699
782
|
"responseShape": {
|
|
@@ -710,31 +793,31 @@
|
|
|
710
793
|
"actions": [
|
|
711
794
|
{
|
|
712
795
|
"name": "send",
|
|
713
|
-
"description": "",
|
|
796
|
+
"description": "Send a transactional email via the configured provider (SendGrid or Resend).",
|
|
714
797
|
"params": [
|
|
715
798
|
{
|
|
716
799
|
"name": "to",
|
|
717
800
|
"type": "string",
|
|
718
801
|
"required": true,
|
|
719
|
-
"description": ""
|
|
802
|
+
"description": "Recipient email address."
|
|
720
803
|
},
|
|
721
804
|
{
|
|
722
805
|
"name": "subject",
|
|
723
806
|
"type": "string",
|
|
724
807
|
"required": true,
|
|
725
|
-
"description": ""
|
|
808
|
+
"description": "Email subject line."
|
|
726
809
|
},
|
|
727
810
|
{
|
|
728
811
|
"name": "body",
|
|
729
812
|
"type": "string",
|
|
730
813
|
"required": true,
|
|
731
|
-
"description": ""
|
|
814
|
+
"description": "Plain-text (or HTML, if `htmlBody` is absent) body content."
|
|
732
815
|
},
|
|
733
816
|
{
|
|
734
817
|
"name": "from",
|
|
735
818
|
"type": "string",
|
|
736
819
|
"required": false,
|
|
737
|
-
"description": ""
|
|
820
|
+
"description": "Sender address; defaults to FROM_EMAIL."
|
|
738
821
|
},
|
|
739
822
|
{
|
|
740
823
|
"name": "htmlBody",
|
|
@@ -746,7 +829,7 @@
|
|
|
746
829
|
"name": "replyTo",
|
|
747
830
|
"type": "string",
|
|
748
831
|
"required": false,
|
|
749
|
-
"description": ""
|
|
832
|
+
"description": "Reply-To address."
|
|
750
833
|
},
|
|
751
834
|
{
|
|
752
835
|
"name": "templateId",
|
|
@@ -769,31 +852,31 @@
|
|
|
769
852
|
"actions": [
|
|
770
853
|
{
|
|
771
854
|
"name": "send",
|
|
772
|
-
"description": "",
|
|
855
|
+
"description": "POST a JSON event notification to an external URL, HMAC-SHA256-signed when a secret is configured; 5xx responses retry, 4xx do not.",
|
|
773
856
|
"params": [
|
|
774
857
|
{
|
|
775
858
|
"name": "url",
|
|
776
859
|
"type": "string",
|
|
777
860
|
"required": true,
|
|
778
|
-
"description": ""
|
|
861
|
+
"description": "Destination URL to POST to."
|
|
779
862
|
},
|
|
780
863
|
{
|
|
781
864
|
"name": "event",
|
|
782
865
|
"type": "string",
|
|
783
866
|
"required": true,
|
|
784
|
-
"description": ""
|
|
867
|
+
"description": "Event name, carried in the body and the X-Almadar-Event header."
|
|
785
868
|
},
|
|
786
869
|
{
|
|
787
870
|
"name": "payload",
|
|
788
871
|
"type": "object",
|
|
789
872
|
"required": false,
|
|
790
|
-
"description": ""
|
|
873
|
+
"description": "Event payload; defaults to an empty object."
|
|
791
874
|
},
|
|
792
875
|
{
|
|
793
876
|
"name": "secret",
|
|
794
877
|
"type": "string",
|
|
795
878
|
"required": false,
|
|
796
|
-
"description": ""
|
|
879
|
+
"description": "Per-call HMAC signing secret, overriding WEBHOOK_SIGNING_SECRET."
|
|
797
880
|
}
|
|
798
881
|
],
|
|
799
882
|
"responseShape": {
|
|
@@ -811,37 +894,57 @@
|
|
|
811
894
|
"actions": [
|
|
812
895
|
{
|
|
813
896
|
"name": "send",
|
|
814
|
-
"description": "",
|
|
897
|
+
"description": "Send a VAPID-signed Web Push notification to a browser PushSubscription endpoint.",
|
|
815
898
|
"params": [
|
|
816
899
|
{
|
|
817
900
|
"name": "subscription",
|
|
818
901
|
"type": "object",
|
|
819
902
|
"required": true,
|
|
820
|
-
"description": ""
|
|
903
|
+
"description": "Browser PushSubscription: endpoint URL plus the p256dh/auth encryption keys.",
|
|
904
|
+
"properties": {
|
|
905
|
+
"endpoint": {
|
|
906
|
+
"type": "string",
|
|
907
|
+
"required": true
|
|
908
|
+
},
|
|
909
|
+
"keys": {
|
|
910
|
+
"type": "object",
|
|
911
|
+
"required": true,
|
|
912
|
+
"properties": {
|
|
913
|
+
"p256dh": {
|
|
914
|
+
"type": "string",
|
|
915
|
+
"required": true
|
|
916
|
+
},
|
|
917
|
+
"auth": {
|
|
918
|
+
"type": "string",
|
|
919
|
+
"required": true
|
|
920
|
+
}
|
|
921
|
+
}
|
|
922
|
+
}
|
|
923
|
+
}
|
|
821
924
|
},
|
|
822
925
|
{
|
|
823
926
|
"name": "title",
|
|
824
927
|
"type": "string",
|
|
825
928
|
"required": true,
|
|
826
|
-
"description": ""
|
|
929
|
+
"description": "Notification title."
|
|
827
930
|
},
|
|
828
931
|
{
|
|
829
932
|
"name": "body",
|
|
830
933
|
"type": "string",
|
|
831
934
|
"required": true,
|
|
832
|
-
"description": ""
|
|
935
|
+
"description": "Notification body text."
|
|
833
936
|
},
|
|
834
937
|
{
|
|
835
938
|
"name": "url",
|
|
836
939
|
"type": "string",
|
|
837
940
|
"required": false,
|
|
838
|
-
"description": ""
|
|
941
|
+
"description": "URL to open when the notification is clicked."
|
|
839
942
|
},
|
|
840
943
|
{
|
|
841
944
|
"name": "icon",
|
|
842
945
|
"type": "string",
|
|
843
946
|
"required": false,
|
|
844
|
-
"description": ""
|
|
947
|
+
"description": "Notification icon URL."
|
|
845
948
|
}
|
|
846
949
|
],
|
|
847
950
|
"responseShape": {
|
|
@@ -859,89 +962,128 @@
|
|
|
859
962
|
"actions": [
|
|
860
963
|
{
|
|
861
964
|
"name": "listEvents",
|
|
862
|
-
"description": "",
|
|
965
|
+
"description": "List events on a Google Calendar; pass `syncToken` for incremental sync instead of a time window (the API rejects combining them).",
|
|
863
966
|
"params": [
|
|
864
967
|
{
|
|
865
968
|
"name": "calendarId",
|
|
866
969
|
"type": "string",
|
|
867
970
|
"required": false,
|
|
868
|
-
"description": ""
|
|
971
|
+
"description": "Calendar id; defaults to GOOGLE_CALENDAR_ID (or 'primary')."
|
|
869
972
|
},
|
|
870
973
|
{
|
|
871
974
|
"name": "timeMin",
|
|
872
975
|
"type": "string",
|
|
873
976
|
"required": false,
|
|
874
|
-
"description": ""
|
|
977
|
+
"description": "ISO start of the time window (ignored when `syncToken` is set)."
|
|
875
978
|
},
|
|
876
979
|
{
|
|
877
980
|
"name": "timeMax",
|
|
878
981
|
"type": "string",
|
|
879
982
|
"required": false,
|
|
880
|
-
"description": ""
|
|
983
|
+
"description": "ISO end of the time window (ignored when `syncToken` is set)."
|
|
881
984
|
},
|
|
882
985
|
{
|
|
883
986
|
"name": "syncToken",
|
|
884
987
|
"type": "string",
|
|
885
988
|
"required": false,
|
|
886
|
-
"description": ""
|
|
989
|
+
"description": "Incremental-sync token from a previous call's `nextSyncToken`; supersedes timeMin/timeMax."
|
|
887
990
|
},
|
|
888
991
|
{
|
|
889
992
|
"name": "maxResults",
|
|
890
993
|
"type": "number",
|
|
891
994
|
"required": false,
|
|
892
|
-
"description": ""
|
|
995
|
+
"description": "Maximum events to return; defaults to 250."
|
|
893
996
|
}
|
|
894
997
|
],
|
|
895
998
|
"responseShape": {
|
|
896
|
-
"events":
|
|
999
|
+
"events": {
|
|
1000
|
+
"type": "array",
|
|
1001
|
+
"items": {
|
|
1002
|
+
"type": "object",
|
|
1003
|
+
"properties": {
|
|
1004
|
+
"id": {
|
|
1005
|
+
"type": "string",
|
|
1006
|
+
"required": true
|
|
1007
|
+
},
|
|
1008
|
+
"summary": {
|
|
1009
|
+
"type": "string",
|
|
1010
|
+
"required": true
|
|
1011
|
+
},
|
|
1012
|
+
"description": {
|
|
1013
|
+
"type": "string",
|
|
1014
|
+
"required": true
|
|
1015
|
+
},
|
|
1016
|
+
"location": {
|
|
1017
|
+
"type": "string",
|
|
1018
|
+
"required": true
|
|
1019
|
+
},
|
|
1020
|
+
"start": {
|
|
1021
|
+
"type": "string",
|
|
1022
|
+
"required": true
|
|
1023
|
+
},
|
|
1024
|
+
"end": {
|
|
1025
|
+
"type": "string",
|
|
1026
|
+
"required": true
|
|
1027
|
+
},
|
|
1028
|
+
"status": {
|
|
1029
|
+
"type": "string",
|
|
1030
|
+
"required": true
|
|
1031
|
+
},
|
|
1032
|
+
"updated": {
|
|
1033
|
+
"type": "string",
|
|
1034
|
+
"required": true
|
|
1035
|
+
}
|
|
1036
|
+
}
|
|
1037
|
+
}
|
|
1038
|
+
},
|
|
897
1039
|
"nextSyncToken": "string | null"
|
|
898
1040
|
}
|
|
899
1041
|
},
|
|
900
1042
|
{
|
|
901
1043
|
"name": "createEvent",
|
|
902
|
-
"description": "",
|
|
1044
|
+
"description": "Create a calendar event; an all-day event uses a 10-char (YYYY-MM-DD) start with no `end`/`durationMinutes`, defaulting to the next day.",
|
|
903
1045
|
"params": [
|
|
904
1046
|
{
|
|
905
1047
|
"name": "calendarId",
|
|
906
1048
|
"type": "string",
|
|
907
1049
|
"required": false,
|
|
908
|
-
"description": ""
|
|
1050
|
+
"description": "Calendar id; defaults to GOOGLE_CALENDAR_ID."
|
|
909
1051
|
},
|
|
910
1052
|
{
|
|
911
1053
|
"name": "summary",
|
|
912
1054
|
"type": "string",
|
|
913
1055
|
"required": true,
|
|
914
|
-
"description": ""
|
|
1056
|
+
"description": "Event title."
|
|
915
1057
|
},
|
|
916
1058
|
{
|
|
917
1059
|
"name": "description",
|
|
918
1060
|
"type": "string",
|
|
919
1061
|
"required": false,
|
|
920
|
-
"description": ""
|
|
1062
|
+
"description": "Event description."
|
|
921
1063
|
},
|
|
922
1064
|
{
|
|
923
1065
|
"name": "location",
|
|
924
1066
|
"type": "string",
|
|
925
1067
|
"required": false,
|
|
926
|
-
"description": ""
|
|
1068
|
+
"description": "Event location text."
|
|
927
1069
|
},
|
|
928
1070
|
{
|
|
929
1071
|
"name": "start",
|
|
930
1072
|
"type": "string",
|
|
931
1073
|
"required": true,
|
|
932
|
-
"description": ""
|
|
1074
|
+
"description": "ISO start (10 chars = all-day date, longer = dateTime)."
|
|
933
1075
|
},
|
|
934
1076
|
{
|
|
935
1077
|
"name": "end",
|
|
936
1078
|
"type": "string",
|
|
937
1079
|
"required": false,
|
|
938
|
-
"description": ""
|
|
1080
|
+
"description": "ISO end; if omitted, derived from `durationMinutes` or the all-day next-day convention."
|
|
939
1081
|
},
|
|
940
1082
|
{
|
|
941
1083
|
"name": "durationMinutes",
|
|
942
1084
|
"type": "number",
|
|
943
1085
|
"required": false,
|
|
944
|
-
"description": ""
|
|
1086
|
+
"description": "Duration in minutes used to derive `end` when `end` is omitted (non-all-day events only)."
|
|
945
1087
|
}
|
|
946
1088
|
],
|
|
947
1089
|
"responseShape": {
|
|
@@ -952,49 +1094,49 @@
|
|
|
952
1094
|
},
|
|
953
1095
|
{
|
|
954
1096
|
"name": "updateEvent",
|
|
955
|
-
"description": "",
|
|
1097
|
+
"description": "Patch an existing event's fields; only fields present in params are changed.",
|
|
956
1098
|
"params": [
|
|
957
1099
|
{
|
|
958
1100
|
"name": "calendarId",
|
|
959
1101
|
"type": "string",
|
|
960
1102
|
"required": false,
|
|
961
|
-
"description": ""
|
|
1103
|
+
"description": "Calendar id; defaults to GOOGLE_CALENDAR_ID."
|
|
962
1104
|
},
|
|
963
1105
|
{
|
|
964
1106
|
"name": "eventId",
|
|
965
1107
|
"type": "string",
|
|
966
1108
|
"required": true,
|
|
967
|
-
"description": ""
|
|
1109
|
+
"description": "Id of the event to update."
|
|
968
1110
|
},
|
|
969
1111
|
{
|
|
970
1112
|
"name": "summary",
|
|
971
1113
|
"type": "string",
|
|
972
1114
|
"required": false,
|
|
973
|
-
"description": ""
|
|
1115
|
+
"description": "New event title."
|
|
974
1116
|
},
|
|
975
1117
|
{
|
|
976
1118
|
"name": "description",
|
|
977
1119
|
"type": "string",
|
|
978
1120
|
"required": false,
|
|
979
|
-
"description": ""
|
|
1121
|
+
"description": "New event description."
|
|
980
1122
|
},
|
|
981
1123
|
{
|
|
982
1124
|
"name": "location",
|
|
983
1125
|
"type": "string",
|
|
984
1126
|
"required": false,
|
|
985
|
-
"description": ""
|
|
1127
|
+
"description": "New event location text."
|
|
986
1128
|
},
|
|
987
1129
|
{
|
|
988
1130
|
"name": "start",
|
|
989
1131
|
"type": "string",
|
|
990
1132
|
"required": false,
|
|
991
|
-
"description": ""
|
|
1133
|
+
"description": "New ISO start."
|
|
992
1134
|
},
|
|
993
1135
|
{
|
|
994
1136
|
"name": "end",
|
|
995
1137
|
"type": "string",
|
|
996
1138
|
"required": false,
|
|
997
|
-
"description": ""
|
|
1139
|
+
"description": "New ISO end."
|
|
998
1140
|
}
|
|
999
1141
|
],
|
|
1000
1142
|
"responseShape": {
|
|
@@ -1004,19 +1146,19 @@
|
|
|
1004
1146
|
},
|
|
1005
1147
|
{
|
|
1006
1148
|
"name": "deleteEvent",
|
|
1007
|
-
"description": "",
|
|
1149
|
+
"description": "Delete a calendar event.",
|
|
1008
1150
|
"params": [
|
|
1009
1151
|
{
|
|
1010
1152
|
"name": "calendarId",
|
|
1011
1153
|
"type": "string",
|
|
1012
1154
|
"required": false,
|
|
1013
|
-
"description": ""
|
|
1155
|
+
"description": "Calendar id; defaults to GOOGLE_CALENDAR_ID."
|
|
1014
1156
|
},
|
|
1015
1157
|
{
|
|
1016
1158
|
"name": "eventId",
|
|
1017
1159
|
"type": "string",
|
|
1018
1160
|
"required": true,
|
|
1019
|
-
"description": ""
|
|
1161
|
+
"description": "Id of the event to delete."
|
|
1020
1162
|
}
|
|
1021
1163
|
],
|
|
1022
1164
|
"responseShape": {
|
|
@@ -1026,58 +1168,73 @@
|
|
|
1026
1168
|
},
|
|
1027
1169
|
{
|
|
1028
1170
|
"name": "freeBusy",
|
|
1029
|
-
"description": "",
|
|
1171
|
+
"description": "Query busy time blocks on a calendar within a window.",
|
|
1030
1172
|
"params": [
|
|
1031
1173
|
{
|
|
1032
1174
|
"name": "calendarId",
|
|
1033
1175
|
"type": "string",
|
|
1034
1176
|
"required": false,
|
|
1035
|
-
"description": ""
|
|
1177
|
+
"description": "Calendar id; defaults to GOOGLE_CALENDAR_ID."
|
|
1036
1178
|
},
|
|
1037
1179
|
{
|
|
1038
1180
|
"name": "timeMin",
|
|
1039
1181
|
"type": "string",
|
|
1040
1182
|
"required": true,
|
|
1041
|
-
"description": ""
|
|
1183
|
+
"description": "ISO start of the query window."
|
|
1042
1184
|
},
|
|
1043
1185
|
{
|
|
1044
1186
|
"name": "timeMax",
|
|
1045
1187
|
"type": "string",
|
|
1046
1188
|
"required": true,
|
|
1047
|
-
"description": ""
|
|
1189
|
+
"description": "ISO end of the query window."
|
|
1048
1190
|
}
|
|
1049
1191
|
],
|
|
1050
1192
|
"responseShape": {
|
|
1051
|
-
"busy":
|
|
1193
|
+
"busy": {
|
|
1194
|
+
"type": "array",
|
|
1195
|
+
"items": {
|
|
1196
|
+
"type": "object",
|
|
1197
|
+
"properties": {
|
|
1198
|
+
"start": {
|
|
1199
|
+
"type": "string",
|
|
1200
|
+
"required": true
|
|
1201
|
+
},
|
|
1202
|
+
"end": {
|
|
1203
|
+
"type": "string",
|
|
1204
|
+
"required": true
|
|
1205
|
+
}
|
|
1206
|
+
}
|
|
1207
|
+
}
|
|
1208
|
+
}
|
|
1052
1209
|
}
|
|
1053
1210
|
},
|
|
1054
1211
|
{
|
|
1055
1212
|
"name": "watch",
|
|
1056
|
-
"description": "",
|
|
1213
|
+
"description": "Register a push-notification channel for calendar change events (Google Calendar API watch).",
|
|
1057
1214
|
"params": [
|
|
1058
1215
|
{
|
|
1059
1216
|
"name": "calendarId",
|
|
1060
1217
|
"type": "string",
|
|
1061
1218
|
"required": false,
|
|
1062
|
-
"description": ""
|
|
1219
|
+
"description": "Calendar id; defaults to GOOGLE_CALENDAR_ID."
|
|
1063
1220
|
},
|
|
1064
1221
|
{
|
|
1065
1222
|
"name": "channelId",
|
|
1066
1223
|
"type": "string",
|
|
1067
1224
|
"required": true,
|
|
1068
|
-
"description": ""
|
|
1225
|
+
"description": "Caller-chosen id identifying this notification channel."
|
|
1069
1226
|
},
|
|
1070
1227
|
{
|
|
1071
1228
|
"name": "address",
|
|
1072
1229
|
"type": "string",
|
|
1073
1230
|
"required": true,
|
|
1074
|
-
"description": ""
|
|
1231
|
+
"description": "HTTPS callback URL Google POSTs change notifications to."
|
|
1075
1232
|
},
|
|
1076
1233
|
{
|
|
1077
1234
|
"name": "ttlSeconds",
|
|
1078
1235
|
"type": "number",
|
|
1079
1236
|
"required": false,
|
|
1080
|
-
"description": ""
|
|
1237
|
+
"description": "Requested channel time-to-live in seconds."
|
|
1081
1238
|
}
|
|
1082
1239
|
],
|
|
1083
1240
|
"responseShape": {
|
|
@@ -1088,19 +1245,19 @@
|
|
|
1088
1245
|
},
|
|
1089
1246
|
{
|
|
1090
1247
|
"name": "stopWatch",
|
|
1091
|
-
"description": "",
|
|
1248
|
+
"description": "Stop an active watch channel, ending calendar change notifications.",
|
|
1092
1249
|
"params": [
|
|
1093
1250
|
{
|
|
1094
1251
|
"name": "channelId",
|
|
1095
1252
|
"type": "string",
|
|
1096
1253
|
"required": true,
|
|
1097
|
-
"description": ""
|
|
1254
|
+
"description": "The channel id from the corresponding `watch` call."
|
|
1098
1255
|
},
|
|
1099
1256
|
{
|
|
1100
1257
|
"name": "resourceId",
|
|
1101
1258
|
"type": "string",
|
|
1102
1259
|
"required": true,
|
|
1103
|
-
"description": ""
|
|
1260
|
+
"description": "The resourceId returned by the corresponding `watch` call."
|
|
1104
1261
|
}
|
|
1105
1262
|
],
|
|
1106
1263
|
"responseShape": {
|
|
@@ -1116,40 +1273,71 @@
|
|
|
1116
1273
|
"actions": [
|
|
1117
1274
|
{
|
|
1118
1275
|
"name": "listFiles",
|
|
1119
|
-
"description": "",
|
|
1276
|
+
"description": "List non-trashed files in a Google Drive folder, optionally filtered by a Drive API query clause.",
|
|
1120
1277
|
"params": [
|
|
1121
1278
|
{
|
|
1122
1279
|
"name": "folderId",
|
|
1123
1280
|
"type": "string",
|
|
1124
1281
|
"required": false,
|
|
1125
|
-
"description": ""
|
|
1282
|
+
"description": "Restrict to files whose parents include this folder id."
|
|
1126
1283
|
},
|
|
1127
1284
|
{
|
|
1128
1285
|
"name": "query",
|
|
1129
1286
|
"type": "string",
|
|
1130
1287
|
"required": false,
|
|
1131
|
-
"description": ""
|
|
1288
|
+
"description": "Extra Drive API query clause, ANDed with the folder/trashed filters."
|
|
1132
1289
|
},
|
|
1133
1290
|
{
|
|
1134
1291
|
"name": "maxResults",
|
|
1135
1292
|
"type": "number",
|
|
1136
1293
|
"required": false,
|
|
1137
|
-
"description": ""
|
|
1294
|
+
"description": "Maximum files to return; defaults to 100."
|
|
1138
1295
|
}
|
|
1139
1296
|
],
|
|
1140
1297
|
"responseShape": {
|
|
1141
|
-
"files":
|
|
1298
|
+
"files": {
|
|
1299
|
+
"type": "array",
|
|
1300
|
+
"items": {
|
|
1301
|
+
"type": "object",
|
|
1302
|
+
"properties": {
|
|
1303
|
+
"id": {
|
|
1304
|
+
"type": "string",
|
|
1305
|
+
"required": true
|
|
1306
|
+
},
|
|
1307
|
+
"name": {
|
|
1308
|
+
"type": "string",
|
|
1309
|
+
"required": true
|
|
1310
|
+
},
|
|
1311
|
+
"mimeType": {
|
|
1312
|
+
"type": "string",
|
|
1313
|
+
"required": true
|
|
1314
|
+
},
|
|
1315
|
+
"size": {
|
|
1316
|
+
"type": "number",
|
|
1317
|
+
"required": true
|
|
1318
|
+
},
|
|
1319
|
+
"modifiedTime": {
|
|
1320
|
+
"type": "string",
|
|
1321
|
+
"required": true
|
|
1322
|
+
},
|
|
1323
|
+
"webViewLink": {
|
|
1324
|
+
"type": "string",
|
|
1325
|
+
"required": true
|
|
1326
|
+
}
|
|
1327
|
+
}
|
|
1328
|
+
}
|
|
1329
|
+
}
|
|
1142
1330
|
}
|
|
1143
1331
|
},
|
|
1144
1332
|
{
|
|
1145
1333
|
"name": "getFile",
|
|
1146
|
-
"description": "",
|
|
1334
|
+
"description": "Download a file's content, base64-encoded.",
|
|
1147
1335
|
"params": [
|
|
1148
1336
|
{
|
|
1149
1337
|
"name": "fileId",
|
|
1150
1338
|
"type": "string",
|
|
1151
1339
|
"required": true,
|
|
1152
|
-
"description": ""
|
|
1340
|
+
"description": "Drive file id."
|
|
1153
1341
|
}
|
|
1154
1342
|
],
|
|
1155
1343
|
"responseShape": {
|
|
@@ -1162,54 +1350,55 @@
|
|
|
1162
1350
|
},
|
|
1163
1351
|
{
|
|
1164
1352
|
"name": "uploadFile",
|
|
1165
|
-
"description": "",
|
|
1353
|
+
"description": "Upload a file to Drive; writes go through the user OAuth client when configured (service-account uploads have no storage quota on personal accounts).",
|
|
1166
1354
|
"params": [
|
|
1167
1355
|
{
|
|
1168
1356
|
"name": "name",
|
|
1169
1357
|
"type": "string",
|
|
1170
1358
|
"required": true,
|
|
1171
|
-
"description": ""
|
|
1359
|
+
"description": "File name to create."
|
|
1172
1360
|
},
|
|
1173
1361
|
{
|
|
1174
1362
|
"name": "content",
|
|
1175
1363
|
"type": "string",
|
|
1176
1364
|
"required": true,
|
|
1177
|
-
"description": ""
|
|
1365
|
+
"description": "File content as a base64 data URL (data:mime;base64,...) or raw base64/plain text."
|
|
1178
1366
|
},
|
|
1179
1367
|
{
|
|
1180
1368
|
"name": "mimeType",
|
|
1181
1369
|
"type": "string",
|
|
1182
1370
|
"required": false,
|
|
1183
|
-
"description": ""
|
|
1371
|
+
"description": "MIME type; inferred from a data URL when omitted."
|
|
1184
1372
|
},
|
|
1185
1373
|
{
|
|
1186
1374
|
"name": "folderId",
|
|
1187
1375
|
"type": "string",
|
|
1188
1376
|
"required": false,
|
|
1189
|
-
"description": ""
|
|
1377
|
+
"description": "Parent folder id; defaults to GOOGLE_DRIVE_FOLDER_ID."
|
|
1190
1378
|
}
|
|
1191
1379
|
],
|
|
1192
1380
|
"responseShape": {
|
|
1193
1381
|
"id": "string",
|
|
1194
1382
|
"name": "string",
|
|
1195
1383
|
"webViewLink": "string"
|
|
1196
|
-
}
|
|
1384
|
+
},
|
|
1385
|
+
"synonyms": "upload file"
|
|
1197
1386
|
},
|
|
1198
1387
|
{
|
|
1199
1388
|
"name": "createFolder",
|
|
1200
|
-
"description": "",
|
|
1389
|
+
"description": "Create a new Drive folder.",
|
|
1201
1390
|
"params": [
|
|
1202
1391
|
{
|
|
1203
1392
|
"name": "name",
|
|
1204
1393
|
"type": "string",
|
|
1205
1394
|
"required": true,
|
|
1206
|
-
"description": ""
|
|
1395
|
+
"description": "Folder name to create."
|
|
1207
1396
|
},
|
|
1208
1397
|
{
|
|
1209
1398
|
"name": "parentId",
|
|
1210
1399
|
"type": "string",
|
|
1211
1400
|
"required": false,
|
|
1212
|
-
"description": ""
|
|
1401
|
+
"description": "Parent folder id; defaults to GOOGLE_DRIVE_FOLDER_ID."
|
|
1213
1402
|
}
|
|
1214
1403
|
],
|
|
1215
1404
|
"responseShape": {
|
|
@@ -1219,25 +1408,25 @@
|
|
|
1219
1408
|
},
|
|
1220
1409
|
{
|
|
1221
1410
|
"name": "shareFile",
|
|
1222
|
-
"description": "",
|
|
1411
|
+
"description": "Grant a user permission on a Drive file.",
|
|
1223
1412
|
"params": [
|
|
1224
1413
|
{
|
|
1225
1414
|
"name": "fileId",
|
|
1226
1415
|
"type": "string",
|
|
1227
1416
|
"required": true,
|
|
1228
|
-
"description": ""
|
|
1417
|
+
"description": "Drive file id."
|
|
1229
1418
|
},
|
|
1230
1419
|
{
|
|
1231
1420
|
"name": "email",
|
|
1232
1421
|
"type": "string",
|
|
1233
1422
|
"required": true,
|
|
1234
|
-
"description": ""
|
|
1423
|
+
"description": "Email address of the grantee."
|
|
1235
1424
|
},
|
|
1236
1425
|
{
|
|
1237
1426
|
"name": "role",
|
|
1238
1427
|
"type": "'reader' | 'writer' | 'commenter'",
|
|
1239
1428
|
"required": false,
|
|
1240
|
-
"description": ""
|
|
1429
|
+
"description": "Permission level; defaults to 'reader'."
|
|
1241
1430
|
}
|
|
1242
1431
|
],
|
|
1243
1432
|
"responseShape": {
|
|
@@ -1254,31 +1443,25 @@
|
|
|
1254
1443
|
"actions": [
|
|
1255
1444
|
{
|
|
1256
1445
|
"name": "getSpend",
|
|
1257
|
-
"description": "",
|
|
1446
|
+
"description": "Fetch total ad spend, impressions, and clicks for an account over a date range via the Meta Graph API Marketing Insights endpoint (read-only).",
|
|
1258
1447
|
"params": [
|
|
1259
1448
|
{
|
|
1260
1449
|
"name": "accountId",
|
|
1261
1450
|
"type": "string",
|
|
1262
1451
|
"required": false,
|
|
1263
|
-
"description": ""
|
|
1452
|
+
"description": "Ad account id (with or without the `act_` prefix); defaults to META_AD_ACCOUNT_ID."
|
|
1264
1453
|
},
|
|
1265
1454
|
{
|
|
1266
1455
|
"name": "since",
|
|
1267
1456
|
"type": "string",
|
|
1268
1457
|
"required": true,
|
|
1269
|
-
"description": ""
|
|
1458
|
+
"description": "Range start date (YYYY-MM-DD)."
|
|
1270
1459
|
},
|
|
1271
1460
|
{
|
|
1272
1461
|
"name": "until",
|
|
1273
1462
|
"type": "string",
|
|
1274
1463
|
"required": true,
|
|
1275
|
-
"description": ""
|
|
1276
|
-
},
|
|
1277
|
-
{
|
|
1278
|
-
"name": "clientTag",
|
|
1279
|
-
"type": "string",
|
|
1280
|
-
"required": false,
|
|
1281
|
-
"description": ""
|
|
1464
|
+
"description": "Range end date (YYYY-MM-DD)."
|
|
1282
1465
|
}
|
|
1283
1466
|
],
|
|
1284
1467
|
"responseShape": {
|
|
@@ -1290,23 +1473,46 @@
|
|
|
1290
1473
|
},
|
|
1291
1474
|
{
|
|
1292
1475
|
"name": "listCampaigns",
|
|
1293
|
-
"description": "",
|
|
1476
|
+
"description": "List campaigns on an ad account via the Meta Graph API (read-only); dailyBudget is converted from Meta's minor-unit reporting.",
|
|
1294
1477
|
"params": [
|
|
1295
1478
|
{
|
|
1296
1479
|
"name": "accountId",
|
|
1297
1480
|
"type": "string",
|
|
1298
1481
|
"required": false,
|
|
1299
|
-
"description": ""
|
|
1482
|
+
"description": "Ad account id (with or without the `act_` prefix); defaults to META_AD_ACCOUNT_ID."
|
|
1300
1483
|
},
|
|
1301
1484
|
{
|
|
1302
1485
|
"name": "status",
|
|
1303
1486
|
"type": "string",
|
|
1304
1487
|
"required": false,
|
|
1305
|
-
"description": ""
|
|
1488
|
+
"description": "Filter by campaign effective_status (e.g. 'ACTIVE', 'PAUSED')."
|
|
1306
1489
|
}
|
|
1307
1490
|
],
|
|
1308
1491
|
"responseShape": {
|
|
1309
|
-
"campaigns":
|
|
1492
|
+
"campaigns": {
|
|
1493
|
+
"type": "array",
|
|
1494
|
+
"items": {
|
|
1495
|
+
"type": "object",
|
|
1496
|
+
"properties": {
|
|
1497
|
+
"id": {
|
|
1498
|
+
"type": "string",
|
|
1499
|
+
"required": true
|
|
1500
|
+
},
|
|
1501
|
+
"name": {
|
|
1502
|
+
"type": "string",
|
|
1503
|
+
"required": true
|
|
1504
|
+
},
|
|
1505
|
+
"status": {
|
|
1506
|
+
"type": "string",
|
|
1507
|
+
"required": true
|
|
1508
|
+
},
|
|
1509
|
+
"dailyBudget": {
|
|
1510
|
+
"type": "number",
|
|
1511
|
+
"required": true
|
|
1512
|
+
}
|
|
1513
|
+
}
|
|
1514
|
+
}
|
|
1515
|
+
}
|
|
1310
1516
|
}
|
|
1311
1517
|
}
|
|
1312
1518
|
]
|
|
@@ -1318,19 +1524,64 @@
|
|
|
1318
1524
|
"actions": [
|
|
1319
1525
|
{
|
|
1320
1526
|
"name": "exportInvoices",
|
|
1321
|
-
"description": "",
|
|
1527
|
+
"description": "Shape invoice rows into an import-ready CSV export (no accounting-vendor connection — generic column set).",
|
|
1322
1528
|
"params": [
|
|
1323
1529
|
{
|
|
1324
1530
|
"name": "invoices",
|
|
1325
1531
|
"type": "array",
|
|
1326
1532
|
"required": true,
|
|
1327
|
-
"description": ""
|
|
1533
|
+
"description": "Invoice rows to export, in column order id/number/customer/issuedAt/dueAt/currency/net/tax/gross/status.",
|
|
1534
|
+
"items": {
|
|
1535
|
+
"type": "object",
|
|
1536
|
+
"properties": {
|
|
1537
|
+
"id": {
|
|
1538
|
+
"type": "string",
|
|
1539
|
+
"required": true
|
|
1540
|
+
},
|
|
1541
|
+
"number": {
|
|
1542
|
+
"type": "string",
|
|
1543
|
+
"required": true
|
|
1544
|
+
},
|
|
1545
|
+
"customer": {
|
|
1546
|
+
"type": "string",
|
|
1547
|
+
"required": true
|
|
1548
|
+
},
|
|
1549
|
+
"issuedAt": {
|
|
1550
|
+
"type": "string",
|
|
1551
|
+
"required": true
|
|
1552
|
+
},
|
|
1553
|
+
"dueAt": {
|
|
1554
|
+
"type": "string",
|
|
1555
|
+
"required": true
|
|
1556
|
+
},
|
|
1557
|
+
"currency": {
|
|
1558
|
+
"type": "string",
|
|
1559
|
+
"required": true
|
|
1560
|
+
},
|
|
1561
|
+
"net": {
|
|
1562
|
+
"type": "number",
|
|
1563
|
+
"required": true
|
|
1564
|
+
},
|
|
1565
|
+
"tax": {
|
|
1566
|
+
"type": "number",
|
|
1567
|
+
"required": true
|
|
1568
|
+
},
|
|
1569
|
+
"gross": {
|
|
1570
|
+
"type": "number",
|
|
1571
|
+
"required": true
|
|
1572
|
+
},
|
|
1573
|
+
"status": {
|
|
1574
|
+
"type": "string",
|
|
1575
|
+
"required": true
|
|
1576
|
+
}
|
|
1577
|
+
}
|
|
1578
|
+
}
|
|
1328
1579
|
},
|
|
1329
1580
|
{
|
|
1330
1581
|
"name": "format",
|
|
1331
1582
|
"type": "'csv'",
|
|
1332
1583
|
"required": false,
|
|
1333
|
-
"description": ""
|
|
1584
|
+
"description": "Export format; only 'csv' is currently supported."
|
|
1334
1585
|
}
|
|
1335
1586
|
],
|
|
1336
1587
|
"responseShape": {
|
|
@@ -1341,19 +1592,48 @@
|
|
|
1341
1592
|
},
|
|
1342
1593
|
{
|
|
1343
1594
|
"name": "exportJournal",
|
|
1344
|
-
"description": "",
|
|
1595
|
+
"description": "Shape journal entry rows into an import-ready CSV export.",
|
|
1345
1596
|
"params": [
|
|
1346
1597
|
{
|
|
1347
1598
|
"name": "entries",
|
|
1348
1599
|
"type": "array",
|
|
1349
1600
|
"required": true,
|
|
1350
|
-
"description": ""
|
|
1601
|
+
"description": "Journal entry rows to export, in column order date/account/description/debit/credit/reference.",
|
|
1602
|
+
"items": {
|
|
1603
|
+
"type": "object",
|
|
1604
|
+
"properties": {
|
|
1605
|
+
"date": {
|
|
1606
|
+
"type": "string",
|
|
1607
|
+
"required": true
|
|
1608
|
+
},
|
|
1609
|
+
"account": {
|
|
1610
|
+
"type": "string",
|
|
1611
|
+
"required": true
|
|
1612
|
+
},
|
|
1613
|
+
"description": {
|
|
1614
|
+
"type": "string",
|
|
1615
|
+
"required": true
|
|
1616
|
+
},
|
|
1617
|
+
"debit": {
|
|
1618
|
+
"type": "number",
|
|
1619
|
+
"required": true
|
|
1620
|
+
},
|
|
1621
|
+
"credit": {
|
|
1622
|
+
"type": "number",
|
|
1623
|
+
"required": true
|
|
1624
|
+
},
|
|
1625
|
+
"reference": {
|
|
1626
|
+
"type": "string",
|
|
1627
|
+
"required": true
|
|
1628
|
+
}
|
|
1629
|
+
}
|
|
1630
|
+
}
|
|
1351
1631
|
},
|
|
1352
1632
|
{
|
|
1353
1633
|
"name": "format",
|
|
1354
1634
|
"type": "'csv'",
|
|
1355
1635
|
"required": false,
|
|
1356
|
-
"description": ""
|
|
1636
|
+
"description": "Export format; only 'csv' is currently supported."
|
|
1357
1637
|
}
|
|
1358
1638
|
],
|
|
1359
1639
|
"responseShape": {
|
|
@@ -1371,25 +1651,25 @@
|
|
|
1371
1651
|
"actions": [
|
|
1372
1652
|
{
|
|
1373
1653
|
"name": "createRequisition",
|
|
1374
|
-
"description": "",
|
|
1654
|
+
"description": "Start a GoCardless Bank Account Data requisition (bank-connection consent flow); the returned `link` is where the end user authorizes access.",
|
|
1375
1655
|
"params": [
|
|
1376
1656
|
{
|
|
1377
1657
|
"name": "institutionId",
|
|
1378
1658
|
"type": "string",
|
|
1379
1659
|
"required": true,
|
|
1380
|
-
"description": ""
|
|
1660
|
+
"description": "GoCardless institution id (the bank to connect)."
|
|
1381
1661
|
},
|
|
1382
1662
|
{
|
|
1383
1663
|
"name": "redirectUrl",
|
|
1384
1664
|
"type": "string",
|
|
1385
1665
|
"required": true,
|
|
1386
|
-
"description": ""
|
|
1666
|
+
"description": "URL GoCardless redirects the user to after consent."
|
|
1387
1667
|
},
|
|
1388
1668
|
{
|
|
1389
1669
|
"name": "reference",
|
|
1390
1670
|
"type": "string",
|
|
1391
1671
|
"required": false,
|
|
1392
|
-
"description": ""
|
|
1672
|
+
"description": "Caller-chosen reference to correlate the requisition."
|
|
1393
1673
|
}
|
|
1394
1674
|
],
|
|
1395
1675
|
"responseShape": {
|
|
@@ -1399,13 +1679,13 @@
|
|
|
1399
1679
|
},
|
|
1400
1680
|
{
|
|
1401
1681
|
"name": "listAccounts",
|
|
1402
|
-
"description": "",
|
|
1682
|
+
"description": "List account ids linked under a completed requisition.",
|
|
1403
1683
|
"params": [
|
|
1404
1684
|
{
|
|
1405
1685
|
"name": "requisitionId",
|
|
1406
1686
|
"type": "string",
|
|
1407
1687
|
"required": true,
|
|
1408
|
-
"description": ""
|
|
1688
|
+
"description": "Requisition id from createRequisition."
|
|
1409
1689
|
}
|
|
1410
1690
|
],
|
|
1411
1691
|
"responseShape": {
|
|
@@ -1414,29 +1694,60 @@
|
|
|
1414
1694
|
},
|
|
1415
1695
|
{
|
|
1416
1696
|
"name": "listTransactions",
|
|
1417
|
-
"description": "",
|
|
1697
|
+
"description": "List booked transactions on a linked bank account, optionally filtered by date range.",
|
|
1418
1698
|
"params": [
|
|
1419
1699
|
{
|
|
1420
1700
|
"name": "accountId",
|
|
1421
1701
|
"type": "string",
|
|
1422
1702
|
"required": true,
|
|
1423
|
-
"description": ""
|
|
1703
|
+
"description": "GoCardless account id."
|
|
1424
1704
|
},
|
|
1425
1705
|
{
|
|
1426
1706
|
"name": "dateFrom",
|
|
1427
1707
|
"type": "string",
|
|
1428
1708
|
"required": false,
|
|
1429
|
-
"description": ""
|
|
1709
|
+
"description": "Only transactions booked on/after this date (YYYY-MM-DD)."
|
|
1430
1710
|
},
|
|
1431
1711
|
{
|
|
1432
1712
|
"name": "dateTo",
|
|
1433
1713
|
"type": "string",
|
|
1434
1714
|
"required": false,
|
|
1435
|
-
"description": ""
|
|
1715
|
+
"description": "Only transactions booked on/before this date (YYYY-MM-DD)."
|
|
1436
1716
|
}
|
|
1437
1717
|
],
|
|
1438
1718
|
"responseShape": {
|
|
1439
|
-
"transactions":
|
|
1719
|
+
"transactions": {
|
|
1720
|
+
"type": "array",
|
|
1721
|
+
"items": {
|
|
1722
|
+
"type": "object",
|
|
1723
|
+
"properties": {
|
|
1724
|
+
"id": {
|
|
1725
|
+
"type": "string",
|
|
1726
|
+
"required": true
|
|
1727
|
+
},
|
|
1728
|
+
"amount": {
|
|
1729
|
+
"type": "number",
|
|
1730
|
+
"required": true
|
|
1731
|
+
},
|
|
1732
|
+
"currency": {
|
|
1733
|
+
"type": "string",
|
|
1734
|
+
"required": true
|
|
1735
|
+
},
|
|
1736
|
+
"date": {
|
|
1737
|
+
"type": "string",
|
|
1738
|
+
"required": true
|
|
1739
|
+
},
|
|
1740
|
+
"description": {
|
|
1741
|
+
"type": "string",
|
|
1742
|
+
"required": true
|
|
1743
|
+
},
|
|
1744
|
+
"counterparty": {
|
|
1745
|
+
"type": "string",
|
|
1746
|
+
"required": true
|
|
1747
|
+
}
|
|
1748
|
+
}
|
|
1749
|
+
}
|
|
1750
|
+
}
|
|
1440
1751
|
}
|
|
1441
1752
|
}
|
|
1442
1753
|
]
|
|
@@ -1448,37 +1759,37 @@
|
|
|
1448
1759
|
"actions": [
|
|
1449
1760
|
{
|
|
1450
1761
|
"name": "sendEnvelope",
|
|
1451
|
-
"description": "",
|
|
1762
|
+
"description": "Send a document for e-signature via DocuSign; accepts the document content as a data URL or raw base64.",
|
|
1452
1763
|
"params": [
|
|
1453
1764
|
{
|
|
1454
1765
|
"name": "recipientEmail",
|
|
1455
1766
|
"type": "string",
|
|
1456
1767
|
"required": true,
|
|
1457
|
-
"description": ""
|
|
1768
|
+
"description": "Signer's email address."
|
|
1458
1769
|
},
|
|
1459
1770
|
{
|
|
1460
1771
|
"name": "recipientName",
|
|
1461
1772
|
"type": "string",
|
|
1462
1773
|
"required": true,
|
|
1463
|
-
"description": ""
|
|
1774
|
+
"description": "Signer's display name."
|
|
1464
1775
|
},
|
|
1465
1776
|
{
|
|
1466
1777
|
"name": "documentName",
|
|
1467
1778
|
"type": "string",
|
|
1468
1779
|
"required": true,
|
|
1469
|
-
"description": ""
|
|
1780
|
+
"description": "Document file name (its extension also picks the DocuSign fileExtension)."
|
|
1470
1781
|
},
|
|
1471
1782
|
{
|
|
1472
1783
|
"name": "documentContent",
|
|
1473
1784
|
"type": "string",
|
|
1474
1785
|
"required": true,
|
|
1475
|
-
"description": ""
|
|
1786
|
+
"description": "Document content as a base64 data URL or raw base64."
|
|
1476
1787
|
},
|
|
1477
1788
|
{
|
|
1478
1789
|
"name": "emailSubject",
|
|
1479
1790
|
"type": "string",
|
|
1480
1791
|
"required": false,
|
|
1481
|
-
"description": ""
|
|
1792
|
+
"description": "Envelope email subject; defaults to \"Please sign: \" + documentName."
|
|
1482
1793
|
}
|
|
1483
1794
|
],
|
|
1484
1795
|
"responseShape": {
|
|
@@ -1488,13 +1799,13 @@
|
|
|
1488
1799
|
},
|
|
1489
1800
|
{
|
|
1490
1801
|
"name": "getEnvelopeStatus",
|
|
1491
|
-
"description": "",
|
|
1802
|
+
"description": "Poll a DocuSign envelope's signing status.",
|
|
1492
1803
|
"params": [
|
|
1493
1804
|
{
|
|
1494
1805
|
"name": "envelopeId",
|
|
1495
1806
|
"type": "string",
|
|
1496
1807
|
"required": true,
|
|
1497
|
-
"description": ""
|
|
1808
|
+
"description": "DocuSign envelope id from sendEnvelope."
|
|
1498
1809
|
}
|
|
1499
1810
|
],
|
|
1500
1811
|
"responseShape": {
|
|
@@ -1504,13 +1815,13 @@
|
|
|
1504
1815
|
},
|
|
1505
1816
|
{
|
|
1506
1817
|
"name": "downloadDocument",
|
|
1507
|
-
"description": "",
|
|
1818
|
+
"description": "Download the combined signed document(s) for a completed envelope, base64-encoded PDF.",
|
|
1508
1819
|
"params": [
|
|
1509
1820
|
{
|
|
1510
1821
|
"name": "envelopeId",
|
|
1511
1822
|
"type": "string",
|
|
1512
1823
|
"required": true,
|
|
1513
|
-
"description": ""
|
|
1824
|
+
"description": "DocuSign envelope id."
|
|
1514
1825
|
}
|
|
1515
1826
|
],
|
|
1516
1827
|
"responseShape": {
|
|
@@ -1527,31 +1838,31 @@
|
|
|
1527
1838
|
"actions": [
|
|
1528
1839
|
{
|
|
1529
1840
|
"name": "build",
|
|
1530
|
-
"description": "",
|
|
1841
|
+
"description": "Simulate building a container image (in-memory backend — no real Docker daemon/SDK; a real build is not yet implemented).",
|
|
1531
1842
|
"params": [
|
|
1532
1843
|
{
|
|
1533
1844
|
"name": "tag",
|
|
1534
1845
|
"type": "string",
|
|
1535
1846
|
"required": true,
|
|
1536
|
-
"description": ""
|
|
1847
|
+
"description": "Image tag to build, e.g. myapp:latest."
|
|
1537
1848
|
},
|
|
1538
1849
|
{
|
|
1539
1850
|
"name": "dockerfile",
|
|
1540
1851
|
"type": "string",
|
|
1541
1852
|
"required": false,
|
|
1542
|
-
"description": ""
|
|
1853
|
+
"description": "Dockerfile path; defaults to 'Dockerfile'."
|
|
1543
1854
|
},
|
|
1544
1855
|
{
|
|
1545
1856
|
"name": "context",
|
|
1546
1857
|
"type": "string",
|
|
1547
1858
|
"required": false,
|
|
1548
|
-
"description": ""
|
|
1859
|
+
"description": "Build context directory; defaults to '.'."
|
|
1549
1860
|
},
|
|
1550
1861
|
{
|
|
1551
1862
|
"name": "buildArgs",
|
|
1552
1863
|
"type": "object",
|
|
1553
1864
|
"required": false,
|
|
1554
|
-
"description": ""
|
|
1865
|
+
"description": "Build-time --build-arg values."
|
|
1555
1866
|
}
|
|
1556
1867
|
],
|
|
1557
1868
|
"responseShape": {
|
|
@@ -1563,61 +1874,110 @@
|
|
|
1563
1874
|
},
|
|
1564
1875
|
{
|
|
1565
1876
|
"name": "run",
|
|
1566
|
-
"description": "",
|
|
1877
|
+
"description": "Simulate starting a container from an image (in-memory backend).",
|
|
1567
1878
|
"params": [
|
|
1568
1879
|
{
|
|
1569
1880
|
"name": "image",
|
|
1570
1881
|
"type": "string",
|
|
1571
1882
|
"required": true,
|
|
1572
|
-
"description": ""
|
|
1883
|
+
"description": "Image to run (as built/tagged by the `build` action, or an arbitrary name)."
|
|
1573
1884
|
},
|
|
1574
1885
|
{
|
|
1575
1886
|
"name": "name",
|
|
1576
1887
|
"type": "string",
|
|
1577
1888
|
"required": false,
|
|
1578
|
-
"description": ""
|
|
1889
|
+
"description": "Container name; auto-generated when omitted."
|
|
1579
1890
|
},
|
|
1580
1891
|
{
|
|
1581
1892
|
"name": "ports",
|
|
1582
1893
|
"type": "array",
|
|
1583
1894
|
"required": false,
|
|
1584
|
-
"description": ""
|
|
1895
|
+
"description": "Host/container port mappings.",
|
|
1896
|
+
"items": {
|
|
1897
|
+
"type": "object",
|
|
1898
|
+
"properties": {
|
|
1899
|
+
"host": {
|
|
1900
|
+
"type": "number",
|
|
1901
|
+
"required": true
|
|
1902
|
+
},
|
|
1903
|
+
"container": {
|
|
1904
|
+
"type": "number",
|
|
1905
|
+
"required": true
|
|
1906
|
+
},
|
|
1907
|
+
"protocol": {
|
|
1908
|
+
"type": "string",
|
|
1909
|
+
"required": false
|
|
1910
|
+
}
|
|
1911
|
+
}
|
|
1912
|
+
}
|
|
1585
1913
|
},
|
|
1586
1914
|
{
|
|
1587
1915
|
"name": "env",
|
|
1588
1916
|
"type": "object",
|
|
1589
1917
|
"required": false,
|
|
1590
|
-
"description": ""
|
|
1918
|
+
"description": "Environment variables set inside the container."
|
|
1591
1919
|
},
|
|
1592
1920
|
{
|
|
1593
1921
|
"name": "volumes",
|
|
1594
1922
|
"type": "array",
|
|
1595
1923
|
"required": false,
|
|
1596
|
-
"description": ""
|
|
1924
|
+
"description": "Host/container path mounts.",
|
|
1925
|
+
"items": {
|
|
1926
|
+
"type": "object",
|
|
1927
|
+
"properties": {
|
|
1928
|
+
"host": {
|
|
1929
|
+
"type": "string",
|
|
1930
|
+
"required": true
|
|
1931
|
+
},
|
|
1932
|
+
"container": {
|
|
1933
|
+
"type": "string",
|
|
1934
|
+
"required": true
|
|
1935
|
+
}
|
|
1936
|
+
}
|
|
1937
|
+
}
|
|
1597
1938
|
},
|
|
1598
1939
|
{
|
|
1599
1940
|
"name": "command",
|
|
1600
1941
|
"type": "string",
|
|
1601
1942
|
"required": false,
|
|
1602
|
-
"description": ""
|
|
1943
|
+
"description": "Override command run inside the container."
|
|
1603
1944
|
}
|
|
1604
1945
|
],
|
|
1605
1946
|
"responseShape": {
|
|
1606
1947
|
"containerId": "string",
|
|
1607
1948
|
"name": "string",
|
|
1608
1949
|
"status": "string",
|
|
1609
|
-
"ports":
|
|
1950
|
+
"ports": {
|
|
1951
|
+
"type": "array",
|
|
1952
|
+
"items": {
|
|
1953
|
+
"type": "object",
|
|
1954
|
+
"properties": {
|
|
1955
|
+
"host": {
|
|
1956
|
+
"type": "number",
|
|
1957
|
+
"required": true
|
|
1958
|
+
},
|
|
1959
|
+
"container": {
|
|
1960
|
+
"type": "number",
|
|
1961
|
+
"required": true
|
|
1962
|
+
},
|
|
1963
|
+
"protocol": {
|
|
1964
|
+
"type": "string",
|
|
1965
|
+
"required": true
|
|
1966
|
+
}
|
|
1967
|
+
}
|
|
1968
|
+
}
|
|
1969
|
+
}
|
|
1610
1970
|
}
|
|
1611
1971
|
},
|
|
1612
1972
|
{
|
|
1613
1973
|
"name": "stop",
|
|
1614
|
-
"description": "",
|
|
1974
|
+
"description": "Stop a running (or paused) simulated container.",
|
|
1615
1975
|
"params": [
|
|
1616
1976
|
{
|
|
1617
1977
|
"name": "containerId",
|
|
1618
1978
|
"type": "string",
|
|
1619
1979
|
"required": true,
|
|
1620
|
-
"description": ""
|
|
1980
|
+
"description": "Container id, or a unique id prefix."
|
|
1621
1981
|
}
|
|
1622
1982
|
],
|
|
1623
1983
|
"responseShape": {
|
|
@@ -1628,19 +1988,19 @@
|
|
|
1628
1988
|
},
|
|
1629
1989
|
{
|
|
1630
1990
|
"name": "remove",
|
|
1631
|
-
"description": "",
|
|
1991
|
+
"description": "Remove a simulated container; fails if it is running unless `force` is set.",
|
|
1632
1992
|
"params": [
|
|
1633
1993
|
{
|
|
1634
1994
|
"name": "containerId",
|
|
1635
1995
|
"type": "string",
|
|
1636
1996
|
"required": true,
|
|
1637
|
-
"description": ""
|
|
1997
|
+
"description": "Container id, or a unique id prefix."
|
|
1638
1998
|
},
|
|
1639
1999
|
{
|
|
1640
2000
|
"name": "force",
|
|
1641
2001
|
"type": "boolean",
|
|
1642
2002
|
"required": false,
|
|
1643
|
-
"description": ""
|
|
2003
|
+
"description": "Remove even if the container is currently running."
|
|
1644
2004
|
}
|
|
1645
2005
|
],
|
|
1646
2006
|
"responseShape": {
|
|
@@ -1650,25 +2010,25 @@
|
|
|
1650
2010
|
},
|
|
1651
2011
|
{
|
|
1652
2012
|
"name": "logs",
|
|
1653
|
-
"description": "",
|
|
2013
|
+
"description": "Fetch generated log lines for a simulated container.",
|
|
1654
2014
|
"params": [
|
|
1655
2015
|
{
|
|
1656
2016
|
"name": "containerId",
|
|
1657
2017
|
"type": "string",
|
|
1658
2018
|
"required": true,
|
|
1659
|
-
"description": ""
|
|
2019
|
+
"description": "Container id, or a unique id prefix."
|
|
1660
2020
|
},
|
|
1661
2021
|
{
|
|
1662
2022
|
"name": "tail",
|
|
1663
2023
|
"type": "number",
|
|
1664
2024
|
"required": false,
|
|
1665
|
-
"description": ""
|
|
2025
|
+
"description": "Number of most-recent lines to return; defaults to 100."
|
|
1666
2026
|
},
|
|
1667
2027
|
{
|
|
1668
2028
|
"name": "since",
|
|
1669
2029
|
"type": "string",
|
|
1670
2030
|
"required": false,
|
|
1671
|
-
"description": ""
|
|
2031
|
+
"description": "Only lines timestamped at/after this ISO time."
|
|
1672
2032
|
}
|
|
1673
2033
|
],
|
|
1674
2034
|
"responseShape": {
|
|
@@ -1679,13 +2039,13 @@
|
|
|
1679
2039
|
},
|
|
1680
2040
|
{
|
|
1681
2041
|
"name": "status",
|
|
1682
|
-
"description": "",
|
|
2042
|
+
"description": "Fetch a simulated container's current status and metadata.",
|
|
1683
2043
|
"params": [
|
|
1684
2044
|
{
|
|
1685
2045
|
"name": "containerId",
|
|
1686
2046
|
"type": "string",
|
|
1687
2047
|
"required": true,
|
|
1688
|
-
"description": ""
|
|
2048
|
+
"description": "Container id, or a unique id prefix."
|
|
1689
2049
|
}
|
|
1690
2050
|
],
|
|
1691
2051
|
"responseShape": {
|
|
@@ -1693,7 +2053,26 @@
|
|
|
1693
2053
|
"name": "string",
|
|
1694
2054
|
"image": "string",
|
|
1695
2055
|
"status": "string",
|
|
1696
|
-
"ports":
|
|
2056
|
+
"ports": {
|
|
2057
|
+
"type": "array",
|
|
2058
|
+
"items": {
|
|
2059
|
+
"type": "object",
|
|
2060
|
+
"properties": {
|
|
2061
|
+
"host": {
|
|
2062
|
+
"type": "number",
|
|
2063
|
+
"required": true
|
|
2064
|
+
},
|
|
2065
|
+
"container": {
|
|
2066
|
+
"type": "number",
|
|
2067
|
+
"required": true
|
|
2068
|
+
},
|
|
2069
|
+
"protocol": {
|
|
2070
|
+
"type": "string",
|
|
2071
|
+
"required": true
|
|
2072
|
+
}
|
|
2073
|
+
}
|
|
2074
|
+
}
|
|
2075
|
+
},
|
|
1697
2076
|
"createdAt": "number",
|
|
1698
2077
|
"startedAt": "number | null",
|
|
1699
2078
|
"stoppedAt": "number | null"
|
|
@@ -1701,23 +2080,71 @@
|
|
|
1701
2080
|
},
|
|
1702
2081
|
{
|
|
1703
2082
|
"name": "list",
|
|
1704
|
-
"description": "",
|
|
2083
|
+
"description": "List simulated containers; by default only running ones (like `docker ps`).",
|
|
1705
2084
|
"params": [
|
|
1706
2085
|
{
|
|
1707
2086
|
"name": "all",
|
|
1708
2087
|
"type": "boolean",
|
|
1709
2088
|
"required": false,
|
|
1710
|
-
"description": ""
|
|
2089
|
+
"description": "Include stopped/exited containers, not just running ones."
|
|
1711
2090
|
},
|
|
1712
2091
|
{
|
|
1713
2092
|
"name": "filterByLabel",
|
|
1714
2093
|
"type": "string",
|
|
1715
2094
|
"required": false,
|
|
1716
|
-
"description": ""
|
|
2095
|
+
"description": "Filter by a `key` or `key=value` label match."
|
|
1717
2096
|
}
|
|
1718
2097
|
],
|
|
1719
2098
|
"responseShape": {
|
|
1720
|
-
"containers":
|
|
2099
|
+
"containers": {
|
|
2100
|
+
"type": "array",
|
|
2101
|
+
"items": {
|
|
2102
|
+
"type": "object",
|
|
2103
|
+
"properties": {
|
|
2104
|
+
"id": {
|
|
2105
|
+
"type": "string",
|
|
2106
|
+
"required": true
|
|
2107
|
+
},
|
|
2108
|
+
"name": {
|
|
2109
|
+
"type": "string",
|
|
2110
|
+
"required": true
|
|
2111
|
+
},
|
|
2112
|
+
"image": {
|
|
2113
|
+
"type": "string",
|
|
2114
|
+
"required": true
|
|
2115
|
+
},
|
|
2116
|
+
"status": {
|
|
2117
|
+
"type": "string",
|
|
2118
|
+
"required": true
|
|
2119
|
+
},
|
|
2120
|
+
"ports": {
|
|
2121
|
+
"type": "array",
|
|
2122
|
+
"required": true,
|
|
2123
|
+
"items": {
|
|
2124
|
+
"type": "object",
|
|
2125
|
+
"properties": {
|
|
2126
|
+
"host": {
|
|
2127
|
+
"type": "number",
|
|
2128
|
+
"required": true
|
|
2129
|
+
},
|
|
2130
|
+
"container": {
|
|
2131
|
+
"type": "number",
|
|
2132
|
+
"required": true
|
|
2133
|
+
},
|
|
2134
|
+
"protocol": {
|
|
2135
|
+
"type": "string",
|
|
2136
|
+
"required": true
|
|
2137
|
+
}
|
|
2138
|
+
}
|
|
2139
|
+
}
|
|
2140
|
+
},
|
|
2141
|
+
"createdAt": {
|
|
2142
|
+
"type": "number",
|
|
2143
|
+
"required": true
|
|
2144
|
+
}
|
|
2145
|
+
}
|
|
2146
|
+
}
|
|
2147
|
+
},
|
|
1721
2148
|
"total": "number"
|
|
1722
2149
|
}
|
|
1723
2150
|
}
|
|
@@ -1730,55 +2157,73 @@
|
|
|
1730
2157
|
"actions": [
|
|
1731
2158
|
{
|
|
1732
2159
|
"name": "upload",
|
|
1733
|
-
"description": "",
|
|
2160
|
+
"description": "Upload an object to an S3-compatible bucket (real S3/R2/MinIO backend when storage credentials are configured, in-memory dev fallback otherwise — refused in production). Admits either the canonical `key`+`content` pair or the file-form `file` payload (UploadDropZone's `{ name, size, type, content }` shape); when `file` is present its `key`/`content` are derived from it.",
|
|
1734
2161
|
"params": [
|
|
1735
2162
|
{
|
|
1736
2163
|
"name": "bucket",
|
|
1737
2164
|
"type": "string",
|
|
1738
2165
|
"required": true,
|
|
1739
|
-
"description": ""
|
|
2166
|
+
"description": "Target bucket; defaults to STORAGE_BUCKET."
|
|
1740
2167
|
},
|
|
1741
2168
|
{
|
|
1742
2169
|
"name": "key",
|
|
1743
2170
|
"type": "string",
|
|
1744
2171
|
"required": false,
|
|
1745
|
-
"description": ""
|
|
2172
|
+
"description": "Object key to store under (canonical shape); ignored when `file` is present."
|
|
1746
2173
|
},
|
|
1747
2174
|
{
|
|
1748
2175
|
"name": "content",
|
|
1749
2176
|
"type": "string",
|
|
1750
2177
|
"required": false,
|
|
1751
|
-
"description": ""
|
|
2178
|
+
"description": "Object content as a base64 data URL, raw base64, or plain text (canonical shape); ignored when `file` is present."
|
|
1752
2179
|
},
|
|
1753
2180
|
{
|
|
1754
2181
|
"name": "contentType",
|
|
1755
2182
|
"type": "string",
|
|
1756
2183
|
"required": false,
|
|
1757
|
-
"description": ""
|
|
2184
|
+
"description": "MIME type override for the canonical shape; inferred from a data URL when omitted."
|
|
1758
2185
|
},
|
|
1759
2186
|
{
|
|
1760
2187
|
"name": "file",
|
|
1761
2188
|
"type": "object",
|
|
1762
2189
|
"required": false,
|
|
1763
|
-
"description": ""
|
|
2190
|
+
"description": "File-form upload payload (as emitted by UploadDropZone); `content` is a base64 data URL.",
|
|
2191
|
+
"properties": {
|
|
2192
|
+
"name": {
|
|
2193
|
+
"type": "string",
|
|
2194
|
+
"required": true
|
|
2195
|
+
},
|
|
2196
|
+
"size": {
|
|
2197
|
+
"type": "number",
|
|
2198
|
+
"required": true
|
|
2199
|
+
},
|
|
2200
|
+
"type": {
|
|
2201
|
+
"type": "string",
|
|
2202
|
+
"required": true
|
|
2203
|
+
},
|
|
2204
|
+
"content": {
|
|
2205
|
+
"type": "string",
|
|
2206
|
+
"required": false
|
|
2207
|
+
}
|
|
2208
|
+
}
|
|
1764
2209
|
},
|
|
1765
2210
|
{
|
|
1766
2211
|
"name": "acl",
|
|
1767
2212
|
"type": "'public' | 'private'",
|
|
1768
2213
|
"required": false,
|
|
1769
|
-
"description": ""
|
|
2214
|
+
"description": "Object ACL — 'public' produces a public URL, otherwise the URL is signed/private."
|
|
1770
2215
|
},
|
|
1771
2216
|
{
|
|
1772
2217
|
"name": "maxSize",
|
|
1773
2218
|
"type": "number",
|
|
1774
2219
|
"required": false,
|
|
1775
|
-
"description": ""
|
|
2220
|
+
"description": "Reject the upload if the file-form payload's declared size exceeds this many bytes."
|
|
1776
2221
|
},
|
|
1777
2222
|
{
|
|
1778
2223
|
"name": "metadata",
|
|
1779
2224
|
"type": "IntegrationParams",
|
|
1780
2225
|
"required": false,
|
|
1781
|
-
"description": ""
|
|
2226
|
+
"description": "Arbitrary metadata stored alongside the object (in-memory backend only)."
|
|
1782
2227
|
}
|
|
1783
2228
|
],
|
|
1784
2229
|
"responseShape": {
|
|
@@ -1788,57 +2233,110 @@
|
|
|
1788
2233
|
"etag": "string",
|
|
1789
2234
|
"id": "string",
|
|
1790
2235
|
"url": "string"
|
|
1791
|
-
}
|
|
2236
|
+
},
|
|
2237
|
+
"synonyms": "upload file, upload object"
|
|
1792
2238
|
},
|
|
1793
2239
|
{
|
|
1794
2240
|
"name": "uploadMany",
|
|
1795
|
-
"description": "",
|
|
2241
|
+
"description": "Upload a whole UploadDropZone batch in one call, one item per file — the FSM-friendly shape for bulk-persisting uploaded-file rows.",
|
|
1796
2242
|
"params": [
|
|
1797
2243
|
{
|
|
1798
2244
|
"name": "bucket",
|
|
1799
2245
|
"type": "string",
|
|
1800
2246
|
"required": true,
|
|
1801
|
-
"description": ""
|
|
2247
|
+
"description": "Target bucket; defaults to STORAGE_BUCKET."
|
|
1802
2248
|
},
|
|
1803
2249
|
{
|
|
1804
2250
|
"name": "files",
|
|
1805
2251
|
"type": "array",
|
|
1806
2252
|
"required": true,
|
|
1807
|
-
"description": ""
|
|
2253
|
+
"description": "Files to upload, in UploadDropZone's `{ name, size, type, content }` shape.",
|
|
2254
|
+
"items": {
|
|
2255
|
+
"type": "object",
|
|
2256
|
+
"properties": {
|
|
2257
|
+
"name": {
|
|
2258
|
+
"type": "string",
|
|
2259
|
+
"required": true
|
|
2260
|
+
},
|
|
2261
|
+
"size": {
|
|
2262
|
+
"type": "number",
|
|
2263
|
+
"required": true
|
|
2264
|
+
},
|
|
2265
|
+
"type": {
|
|
2266
|
+
"type": "string",
|
|
2267
|
+
"required": true
|
|
2268
|
+
},
|
|
2269
|
+
"content": {
|
|
2270
|
+
"type": "string",
|
|
2271
|
+
"required": false
|
|
2272
|
+
}
|
|
2273
|
+
}
|
|
2274
|
+
}
|
|
1808
2275
|
},
|
|
1809
2276
|
{
|
|
1810
2277
|
"name": "acl",
|
|
1811
2278
|
"type": "'public' | 'private'",
|
|
1812
2279
|
"required": false,
|
|
1813
|
-
"description": ""
|
|
2280
|
+
"description": "Object ACL applied to every file in the batch."
|
|
1814
2281
|
},
|
|
1815
2282
|
{
|
|
1816
2283
|
"name": "maxSize",
|
|
1817
2284
|
"type": "number",
|
|
1818
2285
|
"required": false,
|
|
1819
|
-
"description": ""
|
|
2286
|
+
"description": "Reject any file whose declared size exceeds this many bytes."
|
|
1820
2287
|
}
|
|
1821
2288
|
],
|
|
1822
2289
|
"responseShape": {
|
|
1823
|
-
"items":
|
|
2290
|
+
"items": {
|
|
2291
|
+
"type": "array",
|
|
2292
|
+
"items": {
|
|
2293
|
+
"type": "object",
|
|
2294
|
+
"properties": {
|
|
2295
|
+
"id": {
|
|
2296
|
+
"type": "string",
|
|
2297
|
+
"required": true
|
|
2298
|
+
},
|
|
2299
|
+
"key": {
|
|
2300
|
+
"type": "string",
|
|
2301
|
+
"required": true
|
|
2302
|
+
},
|
|
2303
|
+
"url": {
|
|
2304
|
+
"type": "string",
|
|
2305
|
+
"required": true
|
|
2306
|
+
},
|
|
2307
|
+
"name": {
|
|
2308
|
+
"type": "string",
|
|
2309
|
+
"required": true
|
|
2310
|
+
},
|
|
2311
|
+
"sizeBytes": {
|
|
2312
|
+
"type": "number",
|
|
2313
|
+
"required": true
|
|
2314
|
+
},
|
|
2315
|
+
"mimeType": {
|
|
2316
|
+
"type": "string",
|
|
2317
|
+
"required": true
|
|
2318
|
+
}
|
|
2319
|
+
}
|
|
2320
|
+
}
|
|
2321
|
+
},
|
|
1824
2322
|
"count": "number"
|
|
1825
2323
|
}
|
|
1826
2324
|
},
|
|
1827
2325
|
{
|
|
1828
2326
|
"name": "download",
|
|
1829
|
-
"description": "",
|
|
2327
|
+
"description": "Download an object's content, base64-encoded.",
|
|
1830
2328
|
"params": [
|
|
1831
2329
|
{
|
|
1832
2330
|
"name": "bucket",
|
|
1833
2331
|
"type": "string",
|
|
1834
2332
|
"required": true,
|
|
1835
|
-
"description": ""
|
|
2333
|
+
"description": "Bucket the object lives in; defaults to STORAGE_BUCKET."
|
|
1836
2334
|
},
|
|
1837
2335
|
{
|
|
1838
2336
|
"name": "key",
|
|
1839
2337
|
"type": "string",
|
|
1840
2338
|
"required": true,
|
|
1841
|
-
"description": ""
|
|
2339
|
+
"description": "Object key."
|
|
1842
2340
|
}
|
|
1843
2341
|
],
|
|
1844
2342
|
"responseShape": {
|
|
@@ -1850,54 +2348,73 @@
|
|
|
1850
2348
|
},
|
|
1851
2349
|
{
|
|
1852
2350
|
"name": "list",
|
|
1853
|
-
"description": "",
|
|
2351
|
+
"description": "List object keys in a bucket, optionally prefix-filtered, one page at a time.",
|
|
1854
2352
|
"params": [
|
|
1855
2353
|
{
|
|
1856
2354
|
"name": "bucket",
|
|
1857
2355
|
"type": "string",
|
|
1858
2356
|
"required": true,
|
|
1859
|
-
"description": ""
|
|
2357
|
+
"description": "Bucket to list; defaults to STORAGE_BUCKET."
|
|
1860
2358
|
},
|
|
1861
2359
|
{
|
|
1862
2360
|
"name": "prefix",
|
|
1863
2361
|
"type": "string",
|
|
1864
2362
|
"required": false,
|
|
1865
|
-
"description": ""
|
|
2363
|
+
"description": "Only keys starting with this prefix."
|
|
1866
2364
|
},
|
|
1867
2365
|
{
|
|
1868
2366
|
"name": "maxKeys",
|
|
1869
2367
|
"type": "number",
|
|
1870
2368
|
"required": false,
|
|
1871
|
-
"description": ""
|
|
2369
|
+
"description": "Maximum keys per page; defaults to 1000."
|
|
1872
2370
|
},
|
|
1873
2371
|
{
|
|
1874
2372
|
"name": "continuationToken",
|
|
1875
2373
|
"type": "string",
|
|
1876
2374
|
"required": false,
|
|
1877
|
-
"description": ""
|
|
2375
|
+
"description": "Pagination token from a previous call's `nextToken`."
|
|
1878
2376
|
}
|
|
1879
2377
|
],
|
|
1880
2378
|
"responseShape": {
|
|
1881
|
-
"keys":
|
|
2379
|
+
"keys": {
|
|
2380
|
+
"type": "array",
|
|
2381
|
+
"items": {
|
|
2382
|
+
"type": "object",
|
|
2383
|
+
"properties": {
|
|
2384
|
+
"key": {
|
|
2385
|
+
"type": "string",
|
|
2386
|
+
"required": true
|
|
2387
|
+
},
|
|
2388
|
+
"size": {
|
|
2389
|
+
"type": "number",
|
|
2390
|
+
"required": true
|
|
2391
|
+
},
|
|
2392
|
+
"lastModified": {
|
|
2393
|
+
"type": "number",
|
|
2394
|
+
"required": true
|
|
2395
|
+
}
|
|
2396
|
+
}
|
|
2397
|
+
}
|
|
2398
|
+
},
|
|
1882
2399
|
"truncated": "boolean",
|
|
1883
2400
|
"nextToken": "string"
|
|
1884
2401
|
}
|
|
1885
2402
|
},
|
|
1886
2403
|
{
|
|
1887
2404
|
"name": "delete",
|
|
1888
|
-
"description": "",
|
|
2405
|
+
"description": "Delete an object from a bucket.",
|
|
1889
2406
|
"params": [
|
|
1890
2407
|
{
|
|
1891
2408
|
"name": "bucket",
|
|
1892
2409
|
"type": "string",
|
|
1893
2410
|
"required": true,
|
|
1894
|
-
"description": ""
|
|
2411
|
+
"description": "Bucket the object lives in; defaults to STORAGE_BUCKET."
|
|
1895
2412
|
},
|
|
1896
2413
|
{
|
|
1897
2414
|
"name": "key",
|
|
1898
2415
|
"type": "string",
|
|
1899
2416
|
"required": true,
|
|
1900
|
-
"description": ""
|
|
2417
|
+
"description": "Object key to delete."
|
|
1901
2418
|
}
|
|
1902
2419
|
],
|
|
1903
2420
|
"responseShape": {
|
|
@@ -1906,31 +2423,31 @@
|
|
|
1906
2423
|
},
|
|
1907
2424
|
{
|
|
1908
2425
|
"name": "getSignedUrl",
|
|
1909
|
-
"description": "",
|
|
2426
|
+
"description": "Generate a time-limited pre-signed URL for direct GET or PUT access to an object.",
|
|
1910
2427
|
"params": [
|
|
1911
2428
|
{
|
|
1912
2429
|
"name": "bucket",
|
|
1913
2430
|
"type": "string",
|
|
1914
2431
|
"required": true,
|
|
1915
|
-
"description": ""
|
|
2432
|
+
"description": "Bucket the object lives in; defaults to STORAGE_BUCKET."
|
|
1916
2433
|
},
|
|
1917
2434
|
{
|
|
1918
2435
|
"name": "key",
|
|
1919
2436
|
"type": "string",
|
|
1920
2437
|
"required": true,
|
|
1921
|
-
"description": ""
|
|
2438
|
+
"description": "Object key."
|
|
1922
2439
|
},
|
|
1923
2440
|
{
|
|
1924
2441
|
"name": "expiresIn",
|
|
1925
2442
|
"type": "number",
|
|
1926
2443
|
"required": false,
|
|
1927
|
-
"description": ""
|
|
2444
|
+
"description": "URL validity window in seconds; defaults to 3600."
|
|
1928
2445
|
},
|
|
1929
2446
|
{
|
|
1930
2447
|
"name": "operation",
|
|
1931
2448
|
"type": "'get' | 'put'",
|
|
1932
2449
|
"required": false,
|
|
1933
|
-
"description": ""
|
|
2450
|
+
"description": "Whether the URL authorizes a read or a write; defaults to 'get'."
|
|
1934
2451
|
}
|
|
1935
2452
|
],
|
|
1936
2453
|
"responseShape": {
|
|
@@ -1947,31 +2464,31 @@
|
|
|
1947
2464
|
"actions": [
|
|
1948
2465
|
{
|
|
1949
2466
|
"name": "enqueue",
|
|
1950
|
-
"description": "",
|
|
2467
|
+
"description": "Add a job to an in-memory job queue, ordered by priority (higher first) among ready jobs.",
|
|
1951
2468
|
"params": [
|
|
1952
2469
|
{
|
|
1953
2470
|
"name": "queue",
|
|
1954
2471
|
"type": "string",
|
|
1955
2472
|
"required": true,
|
|
1956
|
-
"description": ""
|
|
2473
|
+
"description": "Queue name."
|
|
1957
2474
|
},
|
|
1958
2475
|
{
|
|
1959
2476
|
"name": "payload",
|
|
1960
2477
|
"type": "ServiceParams",
|
|
1961
2478
|
"required": true,
|
|
1962
|
-
"description": ""
|
|
2479
|
+
"description": "Arbitrary job payload."
|
|
1963
2480
|
},
|
|
1964
2481
|
{
|
|
1965
2482
|
"name": "delay",
|
|
1966
2483
|
"type": "number",
|
|
1967
2484
|
"required": false,
|
|
1968
|
-
"description": ""
|
|
2485
|
+
"description": "Delay before the job becomes eligible for dequeue, in milliseconds."
|
|
1969
2486
|
},
|
|
1970
2487
|
{
|
|
1971
2488
|
"name": "priority",
|
|
1972
2489
|
"type": "number",
|
|
1973
2490
|
"required": false,
|
|
1974
|
-
"description": ""
|
|
2491
|
+
"description": "Priority — higher values are dequeued before lower ones."
|
|
1975
2492
|
}
|
|
1976
2493
|
],
|
|
1977
2494
|
"responseShape": {
|
|
@@ -1981,13 +2498,13 @@
|
|
|
1981
2498
|
},
|
|
1982
2499
|
{
|
|
1983
2500
|
"name": "dequeue",
|
|
1984
|
-
"description": "",
|
|
2501
|
+
"description": "Pop the highest-priority pending job whose delay has elapsed, marking it 'processing'; returns null if none is ready.",
|
|
1985
2502
|
"params": [
|
|
1986
2503
|
{
|
|
1987
2504
|
"name": "queue",
|
|
1988
2505
|
"type": "string",
|
|
1989
2506
|
"required": true,
|
|
1990
|
-
"description": ""
|
|
2507
|
+
"description": "Queue name."
|
|
1991
2508
|
}
|
|
1992
2509
|
],
|
|
1993
2510
|
"responseShape": {
|
|
@@ -1996,13 +2513,13 @@
|
|
|
1996
2513
|
},
|
|
1997
2514
|
{
|
|
1998
2515
|
"name": "status",
|
|
1999
|
-
"description": "",
|
|
2516
|
+
"description": "Look up a job's current status by id.",
|
|
2000
2517
|
"params": [
|
|
2001
2518
|
{
|
|
2002
2519
|
"name": "jobId",
|
|
2003
2520
|
"type": "string",
|
|
2004
2521
|
"required": true,
|
|
2005
|
-
"description": ""
|
|
2522
|
+
"description": "Job id from enqueue."
|
|
2006
2523
|
}
|
|
2007
2524
|
],
|
|
2008
2525
|
"responseShape": {
|
|
@@ -2012,19 +2529,19 @@
|
|
|
2012
2529
|
},
|
|
2013
2530
|
{
|
|
2014
2531
|
"name": "complete",
|
|
2015
|
-
"description": "",
|
|
2532
|
+
"description": "Mark a 'processing' job completed and store its result; no-op (returns false) if the job isn't in 'processing' state.",
|
|
2016
2533
|
"params": [
|
|
2017
2534
|
{
|
|
2018
2535
|
"name": "jobId",
|
|
2019
2536
|
"type": "string",
|
|
2020
2537
|
"required": true,
|
|
2021
|
-
"description": ""
|
|
2538
|
+
"description": "Job id."
|
|
2022
2539
|
},
|
|
2023
2540
|
{
|
|
2024
2541
|
"name": "result",
|
|
2025
2542
|
"type": "ServiceParams",
|
|
2026
2543
|
"required": false,
|
|
2027
|
-
"description": ""
|
|
2544
|
+
"description": "Result payload to attach to the job."
|
|
2028
2545
|
}
|
|
2029
2546
|
],
|
|
2030
2547
|
"responseShape": {
|
|
@@ -2033,19 +2550,19 @@
|
|
|
2033
2550
|
},
|
|
2034
2551
|
{
|
|
2035
2552
|
"name": "fail",
|
|
2036
|
-
"description": "",
|
|
2553
|
+
"description": "Mark a 'processing' job failed; no-op (returns false) if the job isn't in 'processing' state.",
|
|
2037
2554
|
"params": [
|
|
2038
2555
|
{
|
|
2039
2556
|
"name": "jobId",
|
|
2040
2557
|
"type": "string",
|
|
2041
2558
|
"required": true,
|
|
2042
|
-
"description": ""
|
|
2559
|
+
"description": "Job id."
|
|
2043
2560
|
},
|
|
2044
2561
|
{
|
|
2045
2562
|
"name": "error",
|
|
2046
2563
|
"type": "string",
|
|
2047
2564
|
"required": false,
|
|
2048
|
-
"description": ""
|
|
2565
|
+
"description": "Failure reason to attach to the job."
|
|
2049
2566
|
}
|
|
2050
2567
|
],
|
|
2051
2568
|
"responseShape": {
|
|
@@ -2054,13 +2571,13 @@
|
|
|
2054
2571
|
},
|
|
2055
2572
|
{
|
|
2056
2573
|
"name": "cancel",
|
|
2057
|
-
"description": "",
|
|
2574
|
+
"description": "Remove a 'pending' job from its queue; no-op (returns false) once it has been dequeued.",
|
|
2058
2575
|
"params": [
|
|
2059
2576
|
{
|
|
2060
2577
|
"name": "jobId",
|
|
2061
2578
|
"type": "string",
|
|
2062
2579
|
"required": true,
|
|
2063
|
-
"description": ""
|
|
2580
|
+
"description": "Job id."
|
|
2064
2581
|
}
|
|
2065
2582
|
],
|
|
2066
2583
|
"responseShape": {
|
|
@@ -2069,13 +2586,13 @@
|
|
|
2069
2586
|
},
|
|
2070
2587
|
{
|
|
2071
2588
|
"name": "size",
|
|
2072
|
-
"description": "",
|
|
2589
|
+
"description": "Count pending and processing jobs in a queue.",
|
|
2073
2590
|
"params": [
|
|
2074
2591
|
{
|
|
2075
2592
|
"name": "queue",
|
|
2076
2593
|
"type": "string",
|
|
2077
2594
|
"required": true,
|
|
2078
|
-
"description": ""
|
|
2595
|
+
"description": "Queue name."
|
|
2079
2596
|
}
|
|
2080
2597
|
],
|
|
2081
2598
|
"responseShape": {
|
|
@@ -2093,13 +2610,13 @@
|
|
|
2093
2610
|
"actions": [
|
|
2094
2611
|
{
|
|
2095
2612
|
"name": "get",
|
|
2096
|
-
"description": "",
|
|
2613
|
+
"description": "Read a key's value from the in-memory cache; returns null (as `value`) if absent or expired.",
|
|
2097
2614
|
"params": [
|
|
2098
2615
|
{
|
|
2099
2616
|
"name": "key",
|
|
2100
2617
|
"type": "string",
|
|
2101
2618
|
"required": true,
|
|
2102
|
-
"description": ""
|
|
2619
|
+
"description": "Cache key."
|
|
2103
2620
|
}
|
|
2104
2621
|
],
|
|
2105
2622
|
"responseShape": {
|
|
@@ -2108,25 +2625,25 @@
|
|
|
2108
2625
|
},
|
|
2109
2626
|
{
|
|
2110
2627
|
"name": "set",
|
|
2111
|
-
"description": "",
|
|
2628
|
+
"description": "Write a key's value, optionally with an expiry.",
|
|
2112
2629
|
"params": [
|
|
2113
2630
|
{
|
|
2114
2631
|
"name": "key",
|
|
2115
2632
|
"type": "string",
|
|
2116
2633
|
"required": true,
|
|
2117
|
-
"description": ""
|
|
2634
|
+
"description": "Cache key."
|
|
2118
2635
|
},
|
|
2119
2636
|
{
|
|
2120
2637
|
"name": "value",
|
|
2121
2638
|
"type": "ServiceParams",
|
|
2122
2639
|
"required": true,
|
|
2123
|
-
"description": ""
|
|
2640
|
+
"description": "Value to store."
|
|
2124
2641
|
},
|
|
2125
2642
|
{
|
|
2126
2643
|
"name": "ttl",
|
|
2127
2644
|
"type": "number",
|
|
2128
2645
|
"required": false,
|
|
2129
|
-
"description": ""
|
|
2646
|
+
"description": "Time-to-live in seconds; omit for no expiry."
|
|
2130
2647
|
}
|
|
2131
2648
|
],
|
|
2132
2649
|
"responseShape": {
|
|
@@ -2135,13 +2652,13 @@
|
|
|
2135
2652
|
},
|
|
2136
2653
|
{
|
|
2137
2654
|
"name": "delete",
|
|
2138
|
-
"description": "",
|
|
2655
|
+
"description": "Delete a key.",
|
|
2139
2656
|
"params": [
|
|
2140
2657
|
{
|
|
2141
2658
|
"name": "key",
|
|
2142
2659
|
"type": "string",
|
|
2143
2660
|
"required": true,
|
|
2144
|
-
"description": ""
|
|
2661
|
+
"description": "Cache key."
|
|
2145
2662
|
}
|
|
2146
2663
|
],
|
|
2147
2664
|
"responseShape": {
|
|
@@ -2150,19 +2667,19 @@
|
|
|
2150
2667
|
},
|
|
2151
2668
|
{
|
|
2152
2669
|
"name": "lock",
|
|
2153
|
-
"description": "",
|
|
2670
|
+
"description": "Acquire a mutex on a key; fails (returns acquired:false) if another lock on the key is still alive.",
|
|
2154
2671
|
"params": [
|
|
2155
2672
|
{
|
|
2156
2673
|
"name": "key",
|
|
2157
2674
|
"type": "string",
|
|
2158
2675
|
"required": true,
|
|
2159
|
-
"description": ""
|
|
2676
|
+
"description": "Lock key."
|
|
2160
2677
|
},
|
|
2161
2678
|
{
|
|
2162
2679
|
"name": "ttl",
|
|
2163
2680
|
"type": "number",
|
|
2164
2681
|
"required": false,
|
|
2165
|
-
"description": ""
|
|
2682
|
+
"description": "Lock time-to-live in milliseconds; defaults to 30000 (30s)."
|
|
2166
2683
|
}
|
|
2167
2684
|
],
|
|
2168
2685
|
"responseShape": {
|
|
@@ -2172,19 +2689,19 @@
|
|
|
2172
2689
|
},
|
|
2173
2690
|
{
|
|
2174
2691
|
"name": "unlock",
|
|
2175
|
-
"description": "",
|
|
2692
|
+
"description": "Release a lock; only succeeds when `lockId` matches the current holder.",
|
|
2176
2693
|
"params": [
|
|
2177
2694
|
{
|
|
2178
2695
|
"name": "key",
|
|
2179
2696
|
"type": "string",
|
|
2180
2697
|
"required": true,
|
|
2181
|
-
"description": ""
|
|
2698
|
+
"description": "Lock key."
|
|
2182
2699
|
},
|
|
2183
2700
|
{
|
|
2184
2701
|
"name": "lockId",
|
|
2185
2702
|
"type": "string",
|
|
2186
2703
|
"required": true,
|
|
2187
|
-
"description": ""
|
|
2704
|
+
"description": "Lock id returned by the corresponding `lock` call."
|
|
2188
2705
|
}
|
|
2189
2706
|
],
|
|
2190
2707
|
"responseShape": {
|
|
@@ -2193,19 +2710,19 @@
|
|
|
2193
2710
|
},
|
|
2194
2711
|
{
|
|
2195
2712
|
"name": "increment",
|
|
2196
|
-
"description": "",
|
|
2713
|
+
"description": "Atomically add to a numeric key's value (creating it at 0 if absent), preserving any existing TTL.",
|
|
2197
2714
|
"params": [
|
|
2198
2715
|
{
|
|
2199
2716
|
"name": "key",
|
|
2200
2717
|
"type": "string",
|
|
2201
2718
|
"required": true,
|
|
2202
|
-
"description": ""
|
|
2719
|
+
"description": "Cache key."
|
|
2203
2720
|
},
|
|
2204
2721
|
{
|
|
2205
2722
|
"name": "by",
|
|
2206
2723
|
"type": "number",
|
|
2207
2724
|
"required": false,
|
|
2208
|
-
"description": ""
|
|
2725
|
+
"description": "Amount to add; defaults to 1 (can be negative to decrement)."
|
|
2209
2726
|
}
|
|
2210
2727
|
],
|
|
2211
2728
|
"responseShape": {
|
|
@@ -2214,19 +2731,19 @@
|
|
|
2214
2731
|
},
|
|
2215
2732
|
{
|
|
2216
2733
|
"name": "expire",
|
|
2217
|
-
"description": "",
|
|
2734
|
+
"description": "Set (or reset) a key's expiry; no-op (returns set:false) if the key doesn't exist or is already expired.",
|
|
2218
2735
|
"params": [
|
|
2219
2736
|
{
|
|
2220
2737
|
"name": "key",
|
|
2221
2738
|
"type": "string",
|
|
2222
2739
|
"required": true,
|
|
2223
|
-
"description": ""
|
|
2740
|
+
"description": "Cache key."
|
|
2224
2741
|
},
|
|
2225
2742
|
{
|
|
2226
2743
|
"name": "ttl",
|
|
2227
2744
|
"type": "number",
|
|
2228
2745
|
"required": true,
|
|
2229
|
-
"description": ""
|
|
2746
|
+
"description": "New time-to-live in seconds."
|
|
2230
2747
|
}
|
|
2231
2748
|
],
|
|
2232
2749
|
"responseShape": {
|
|
@@ -2235,19 +2752,19 @@
|
|
|
2235
2752
|
},
|
|
2236
2753
|
{
|
|
2237
2754
|
"name": "publish",
|
|
2238
|
-
"description": "",
|
|
2755
|
+
"description": "Publish a message to a channel; delivered synchronously to in-process subscriber callbacks only.",
|
|
2239
2756
|
"params": [
|
|
2240
2757
|
{
|
|
2241
2758
|
"name": "channel",
|
|
2242
2759
|
"type": "string",
|
|
2243
2760
|
"required": true,
|
|
2244
|
-
"description": ""
|
|
2761
|
+
"description": "Channel name."
|
|
2245
2762
|
},
|
|
2246
2763
|
{
|
|
2247
2764
|
"name": "message",
|
|
2248
2765
|
"type": "ServiceParams",
|
|
2249
2766
|
"required": true,
|
|
2250
|
-
"description": ""
|
|
2767
|
+
"description": "Message payload."
|
|
2251
2768
|
}
|
|
2252
2769
|
],
|
|
2253
2770
|
"responseShape": {
|
|
@@ -2256,13 +2773,13 @@
|
|
|
2256
2773
|
},
|
|
2257
2774
|
{
|
|
2258
2775
|
"name": "subscribe",
|
|
2259
|
-
"description": "",
|
|
2776
|
+
"description": "Register interest in a channel; does not itself wire a callback (that happens at a higher-level API).",
|
|
2260
2777
|
"params": [
|
|
2261
2778
|
{
|
|
2262
2779
|
"name": "channel",
|
|
2263
2780
|
"type": "string",
|
|
2264
2781
|
"required": true,
|
|
2265
|
-
"description": ""
|
|
2782
|
+
"description": "Channel name."
|
|
2266
2783
|
}
|
|
2267
2784
|
],
|
|
2268
2785
|
"responseShape": {
|
|
@@ -2278,25 +2795,25 @@
|
|
|
2278
2795
|
"actions": [
|
|
2279
2796
|
{
|
|
2280
2797
|
"name": "authorize",
|
|
2281
|
-
"description": "",
|
|
2798
|
+
"description": "Build the provider authorization URL (PKCE + state) for an OAuth/OIDC login redirect; real OIDC discovery when OAUTH_CLIENT_ID/SECRET are configured, an in-memory mock otherwise.",
|
|
2282
2799
|
"params": [
|
|
2283
2800
|
{
|
|
2284
2801
|
"name": "provider",
|
|
2285
2802
|
"type": "'google' | 'github' | 'auth0'",
|
|
2286
2803
|
"required": true,
|
|
2287
|
-
"description": ""
|
|
2804
|
+
"description": "Identity provider; OIDC issuer defaults to Google unless OIDC_ISSUER_URL overrides it."
|
|
2288
2805
|
},
|
|
2289
2806
|
{
|
|
2290
2807
|
"name": "scopes",
|
|
2291
2808
|
"type": "string[]",
|
|
2292
2809
|
"required": true,
|
|
2293
|
-
"description": ""
|
|
2810
|
+
"description": "OAuth scopes to request."
|
|
2294
2811
|
},
|
|
2295
2812
|
{
|
|
2296
2813
|
"name": "redirectUri",
|
|
2297
2814
|
"type": "string",
|
|
2298
2815
|
"required": true,
|
|
2299
|
-
"description": ""
|
|
2816
|
+
"description": "Callback URL the provider redirects back to after consent."
|
|
2300
2817
|
}
|
|
2301
2818
|
],
|
|
2302
2819
|
"responseShape": {
|
|
@@ -2306,19 +2823,19 @@
|
|
|
2306
2823
|
},
|
|
2307
2824
|
{
|
|
2308
2825
|
"name": "token",
|
|
2309
|
-
"description": "",
|
|
2826
|
+
"description": "Exchange an authorization code for tokens, consuming the one-time-use `state` from the matching `authorize` call.",
|
|
2310
2827
|
"params": [
|
|
2311
2828
|
{
|
|
2312
2829
|
"name": "code",
|
|
2313
2830
|
"type": "string",
|
|
2314
2831
|
"required": true,
|
|
2315
|
-
"description": ""
|
|
2832
|
+
"description": "Authorization code from the provider's redirect callback."
|
|
2316
2833
|
},
|
|
2317
2834
|
{
|
|
2318
2835
|
"name": "state",
|
|
2319
2836
|
"type": "string",
|
|
2320
2837
|
"required": true,
|
|
2321
|
-
"description": ""
|
|
2838
|
+
"description": "The `state` value returned by `authorize`."
|
|
2322
2839
|
}
|
|
2323
2840
|
],
|
|
2324
2841
|
"responseShape": {
|
|
@@ -2330,13 +2847,13 @@
|
|
|
2330
2847
|
},
|
|
2331
2848
|
{
|
|
2332
2849
|
"name": "refresh",
|
|
2333
|
-
"description": "",
|
|
2850
|
+
"description": "Exchange a refresh token for a new access token.",
|
|
2334
2851
|
"params": [
|
|
2335
2852
|
{
|
|
2336
2853
|
"name": "refreshToken",
|
|
2337
2854
|
"type": "string",
|
|
2338
2855
|
"required": true,
|
|
2339
|
-
"description": ""
|
|
2856
|
+
"description": "Refresh token from a prior `token` call."
|
|
2340
2857
|
}
|
|
2341
2858
|
],
|
|
2342
2859
|
"responseShape": {
|
|
@@ -2346,13 +2863,13 @@
|
|
|
2346
2863
|
},
|
|
2347
2864
|
{
|
|
2348
2865
|
"name": "revoke",
|
|
2349
|
-
"description": "",
|
|
2866
|
+
"description": "Revoke an access or refresh token.",
|
|
2350
2867
|
"params": [
|
|
2351
2868
|
{
|
|
2352
2869
|
"name": "token",
|
|
2353
2870
|
"type": "string",
|
|
2354
2871
|
"required": true,
|
|
2355
|
-
"description": ""
|
|
2872
|
+
"description": "The access or refresh token to revoke."
|
|
2356
2873
|
}
|
|
2357
2874
|
],
|
|
2358
2875
|
"responseShape": {
|
|
@@ -2361,13 +2878,13 @@
|
|
|
2361
2878
|
},
|
|
2362
2879
|
{
|
|
2363
2880
|
"name": "userinfo",
|
|
2364
|
-
"description": "",
|
|
2881
|
+
"description": "Fetch the authenticated user's profile claims for an access token.",
|
|
2365
2882
|
"params": [
|
|
2366
2883
|
{
|
|
2367
2884
|
"name": "accessToken",
|
|
2368
2885
|
"type": "string",
|
|
2369
2886
|
"required": true,
|
|
2370
|
-
"description": ""
|
|
2887
|
+
"description": "Access token from a prior `token`/`refresh` call."
|
|
2371
2888
|
}
|
|
2372
2889
|
],
|
|
2373
2890
|
"responseShape": {
|
|
@@ -2386,41 +2903,76 @@
|
|
|
2386
2903
|
"actions": [
|
|
2387
2904
|
{
|
|
2388
2905
|
"name": "list",
|
|
2389
|
-
"description": "",
|
|
2906
|
+
"description": "List declared credentials and their masked (last-4) configuration status; open to any caller.",
|
|
2390
2907
|
"params": [
|
|
2391
2908
|
{
|
|
2392
2909
|
"name": "service",
|
|
2393
2910
|
"type": "string",
|
|
2394
2911
|
"required": false,
|
|
2395
|
-
"description": ""
|
|
2912
|
+
"description": "Restrict the listing to one service's declared credentials; omit for all services."
|
|
2396
2913
|
}
|
|
2397
2914
|
],
|
|
2398
2915
|
"responseShape": {
|
|
2399
2916
|
"enabled": "boolean",
|
|
2400
|
-
"entries":
|
|
2917
|
+
"entries": {
|
|
2918
|
+
"type": "array",
|
|
2919
|
+
"items": {
|
|
2920
|
+
"type": "object",
|
|
2921
|
+
"properties": {
|
|
2922
|
+
"service": {
|
|
2923
|
+
"type": "string",
|
|
2924
|
+
"required": true
|
|
2925
|
+
},
|
|
2926
|
+
"envVar": {
|
|
2927
|
+
"type": "string",
|
|
2928
|
+
"required": true
|
|
2929
|
+
},
|
|
2930
|
+
"required": {
|
|
2931
|
+
"type": "boolean",
|
|
2932
|
+
"required": true
|
|
2933
|
+
},
|
|
2934
|
+
"description": {
|
|
2935
|
+
"type": "string",
|
|
2936
|
+
"required": true
|
|
2937
|
+
},
|
|
2938
|
+
"configured": {
|
|
2939
|
+
"type": "boolean",
|
|
2940
|
+
"required": true
|
|
2941
|
+
},
|
|
2942
|
+
"source": {
|
|
2943
|
+
"type": "'store' | 'env' | 'none'",
|
|
2944
|
+
"required": true
|
|
2945
|
+
},
|
|
2946
|
+
"last4": {
|
|
2947
|
+
"type": "string",
|
|
2948
|
+
"required": true
|
|
2949
|
+
}
|
|
2950
|
+
}
|
|
2951
|
+
}
|
|
2952
|
+
}
|
|
2401
2953
|
}
|
|
2402
2954
|
},
|
|
2403
2955
|
{
|
|
2404
2956
|
"name": "set",
|
|
2405
|
-
"description": "",
|
|
2957
|
+
"description": "Save a credential value into the hosted store; the env var must be one declared for the service (or a well-formed connection-ref name for `database`). Admin/owner role required.",
|
|
2406
2958
|
"params": [
|
|
2407
2959
|
{
|
|
2408
2960
|
"name": "service",
|
|
2409
2961
|
"type": "string",
|
|
2410
2962
|
"required": true,
|
|
2411
|
-
"description": ""
|
|
2963
|
+
"description": "Integration name the credential belongs to."
|
|
2412
2964
|
},
|
|
2413
2965
|
{
|
|
2414
2966
|
"name": "envVar",
|
|
2415
2967
|
"type": "string",
|
|
2416
2968
|
"required": true,
|
|
2417
|
-
"description": ""
|
|
2969
|
+
"description": "Declared env-var name being set."
|
|
2418
2970
|
},
|
|
2419
2971
|
{
|
|
2420
2972
|
"name": "value",
|
|
2421
2973
|
"type": "string",
|
|
2422
2974
|
"required": true,
|
|
2423
|
-
"description": ""
|
|
2975
|
+
"description": "Secret value to store; never logged."
|
|
2424
2976
|
}
|
|
2425
2977
|
],
|
|
2426
2978
|
"responseShape": {
|
|
@@ -2432,19 +2984,19 @@
|
|
|
2432
2984
|
},
|
|
2433
2985
|
{
|
|
2434
2986
|
"name": "remove",
|
|
2435
|
-
"description": "",
|
|
2987
|
+
"description": "Delete a stored credential from the hosted store. Admin/owner role required.",
|
|
2436
2988
|
"params": [
|
|
2437
2989
|
{
|
|
2438
2990
|
"name": "service",
|
|
2439
2991
|
"type": "string",
|
|
2440
2992
|
"required": true,
|
|
2441
|
-
"description": ""
|
|
2993
|
+
"description": "Integration name the credential belongs to."
|
|
2442
2994
|
},
|
|
2443
2995
|
{
|
|
2444
2996
|
"name": "envVar",
|
|
2445
2997
|
"type": "string",
|
|
2446
2998
|
"required": true,
|
|
2447
|
-
"description": ""
|
|
2999
|
+
"description": "Env-var name to remove."
|
|
2448
3000
|
}
|
|
2449
3001
|
],
|
|
2450
3002
|
"responseShape": {
|
|
@@ -2453,13 +3005,13 @@
|
|
|
2453
3005
|
},
|
|
2454
3006
|
{
|
|
2455
3007
|
"name": "test",
|
|
2456
|
-
"description": "",
|
|
3008
|
+
"description": "Check whether a service's required credentials are present and, if a live probe is declared for it, exercise the service to confirm they actually work. Admin/owner role required.",
|
|
2457
3009
|
"params": [
|
|
2458
3010
|
{
|
|
2459
3011
|
"name": "service",
|
|
2460
3012
|
"type": "string",
|
|
2461
3013
|
"required": true,
|
|
2462
|
-
"description": ""
|
|
3014
|
+
"description": "Integration name to test."
|
|
2463
3015
|
}
|
|
2464
3016
|
],
|
|
2465
3017
|
"responseShape": {
|
|
@@ -2473,7 +3025,7 @@
|
|
|
2473
3025
|
},
|
|
2474
3026
|
{
|
|
2475
3027
|
"name": "rotate",
|
|
2476
|
-
"description": "",
|
|
3028
|
+
"description": "Re-encrypt all stored credentials under the current master key (ALMADAR_CREDENTIAL_MASTER_KEY), retiring ALMADAR_CREDENTIAL_MASTER_KEY_PREVIOUS. Admin/owner role required.",
|
|
2477
3029
|
"params": [],
|
|
2478
3030
|
"responseShape": {
|
|
2479
3031
|
"rotated": "number",
|
|
@@ -2490,25 +3042,25 @@
|
|
|
2490
3042
|
"actions": [
|
|
2491
3043
|
{
|
|
2492
3044
|
"name": "startSpan",
|
|
2493
|
-
"description": "",
|
|
3045
|
+
"description": "Start a trace span (in-memory backend — no OpenTelemetry SDK/exporter).",
|
|
2494
3046
|
"params": [
|
|
2495
3047
|
{
|
|
2496
3048
|
"name": "name",
|
|
2497
3049
|
"type": "string",
|
|
2498
3050
|
"required": true,
|
|
2499
|
-
"description": ""
|
|
3051
|
+
"description": "Span name."
|
|
2500
3052
|
},
|
|
2501
3053
|
{
|
|
2502
3054
|
"name": "attributes",
|
|
2503
3055
|
"type": "IntegrationParams",
|
|
2504
3056
|
"required": false,
|
|
2505
|
-
"description": ""
|
|
3057
|
+
"description": "Key-value attributes attached to the span."
|
|
2506
3058
|
},
|
|
2507
3059
|
{
|
|
2508
3060
|
"name": "traceId",
|
|
2509
3061
|
"type": "string",
|
|
2510
3062
|
"required": false,
|
|
2511
|
-
"description": ""
|
|
3063
|
+
"description": "Existing trace id to attach this span to; a new one is generated when omitted."
|
|
2512
3064
|
}
|
|
2513
3065
|
],
|
|
2514
3066
|
"responseShape": {
|
|
@@ -2518,19 +3070,19 @@
|
|
|
2518
3070
|
},
|
|
2519
3071
|
{
|
|
2520
3072
|
"name": "endSpan",
|
|
2521
|
-
"description": "",
|
|
3073
|
+
"description": "Mark a span ended, optionally recording its final status; no-op (returns ended:false) for an unknown span id.",
|
|
2522
3074
|
"params": [
|
|
2523
3075
|
{
|
|
2524
3076
|
"name": "spanId",
|
|
2525
3077
|
"type": "string",
|
|
2526
3078
|
"required": true,
|
|
2527
|
-
"description": ""
|
|
3079
|
+
"description": "Span id from startSpan."
|
|
2528
3080
|
},
|
|
2529
3081
|
{
|
|
2530
3082
|
"name": "status",
|
|
2531
3083
|
"type": "'ok' | 'error'",
|
|
2532
3084
|
"required": false,
|
|
2533
|
-
"description": ""
|
|
3085
|
+
"description": "Final span status."
|
|
2534
3086
|
}
|
|
2535
3087
|
],
|
|
2536
3088
|
"responseShape": {
|
|
@@ -2539,25 +3091,25 @@
|
|
|
2539
3091
|
},
|
|
2540
3092
|
{
|
|
2541
3093
|
"name": "addEvent",
|
|
2542
|
-
"description": "",
|
|
3094
|
+
"description": "Attach a timestamped event to an open span; no-op (returns added:false) for an unknown span id.",
|
|
2543
3095
|
"params": [
|
|
2544
3096
|
{
|
|
2545
3097
|
"name": "spanId",
|
|
2546
3098
|
"type": "string",
|
|
2547
3099
|
"required": true,
|
|
2548
|
-
"description": ""
|
|
3100
|
+
"description": "Span id from startSpan."
|
|
2549
3101
|
},
|
|
2550
3102
|
{
|
|
2551
3103
|
"name": "name",
|
|
2552
3104
|
"type": "string",
|
|
2553
3105
|
"required": true,
|
|
2554
|
-
"description": ""
|
|
3106
|
+
"description": "Event name."
|
|
2555
3107
|
},
|
|
2556
3108
|
{
|
|
2557
3109
|
"name": "attributes",
|
|
2558
3110
|
"type": "IntegrationParams",
|
|
2559
3111
|
"required": false,
|
|
2560
|
-
"description": ""
|
|
3112
|
+
"description": "Key-value attributes attached to the event."
|
|
2561
3113
|
}
|
|
2562
3114
|
],
|
|
2563
3115
|
"responseShape": {
|
|
@@ -2566,31 +3118,31 @@
|
|
|
2566
3118
|
},
|
|
2567
3119
|
{
|
|
2568
3120
|
"name": "recordMetric",
|
|
2569
|
-
"description": "",
|
|
3121
|
+
"description": "Record a metric sample: counters accumulate, gauges overwrite, histograms append to the sample list.",
|
|
2570
3122
|
"params": [
|
|
2571
3123
|
{
|
|
2572
3124
|
"name": "name",
|
|
2573
3125
|
"type": "string",
|
|
2574
3126
|
"required": true,
|
|
2575
|
-
"description": ""
|
|
3127
|
+
"description": "Metric name."
|
|
2576
3128
|
},
|
|
2577
3129
|
{
|
|
2578
3130
|
"name": "value",
|
|
2579
3131
|
"type": "number",
|
|
2580
3132
|
"required": true,
|
|
2581
|
-
"description": ""
|
|
3133
|
+
"description": "Sample value."
|
|
2582
3134
|
},
|
|
2583
3135
|
{
|
|
2584
3136
|
"name": "type",
|
|
2585
3137
|
"type": "'counter' | 'gauge' | 'histogram'",
|
|
2586
3138
|
"required": false,
|
|
2587
|
-
"description": ""
|
|
3139
|
+
"description": "Aggregation kind; defaults to 'counter'."
|
|
2588
3140
|
},
|
|
2589
3141
|
{
|
|
2590
3142
|
"name": "labels",
|
|
2591
3143
|
"type": "IntegrationParams",
|
|
2592
3144
|
"required": false,
|
|
2593
|
-
"description": ""
|
|
3145
|
+
"description": "Key-value labels attached to the metric (replaces prior labels on the same name)."
|
|
2594
3146
|
}
|
|
2595
3147
|
],
|
|
2596
3148
|
"responseShape": {
|
|
@@ -2599,20 +3151,20 @@
|
|
|
2599
3151
|
},
|
|
2600
3152
|
{
|
|
2601
3153
|
"name": "getSpan",
|
|
2602
|
-
"description": "",
|
|
3154
|
+
"description": "Fetch a stored span's full record by id; null if unknown.",
|
|
2603
3155
|
"params": [
|
|
2604
3156
|
{
|
|
2605
3157
|
"name": "spanId",
|
|
2606
3158
|
"type": "string",
|
|
2607
3159
|
"required": true,
|
|
2608
|
-
"description": ""
|
|
3160
|
+
"description": "Span id from startSpan."
|
|
2609
3161
|
}
|
|
2610
3162
|
],
|
|
2611
3163
|
"responseShape": {}
|
|
2612
3164
|
},
|
|
2613
3165
|
{
|
|
2614
3166
|
"name": "getMetrics",
|
|
2615
|
-
"description": "",
|
|
3167
|
+
"description": "Fetch all recorded metrics, keyed by metric name.",
|
|
2616
3168
|
"params": [],
|
|
2617
3169
|
"responseShape": {}
|
|
2618
3170
|
}
|
|
@@ -2625,13 +3177,13 @@
|
|
|
2625
3177
|
"actions": [
|
|
2626
3178
|
{
|
|
2627
3179
|
"name": "validate",
|
|
2628
|
-
"description": "",
|
|
3180
|
+
"description": "Validate an orbital schema by writing it to a temp file and shelling out to `npx",
|
|
2629
3181
|
"params": [
|
|
2630
3182
|
{
|
|
2631
3183
|
"name": "schema",
|
|
2632
3184
|
"type": "string",
|
|
2633
3185
|
"required": true,
|
|
2634
|
-
"description": ""
|
|
3186
|
+
"description": "Raw .orb schema content to validate."
|
|
2635
3187
|
}
|
|
2636
3188
|
],
|
|
2637
3189
|
"responseShape": {
|
|
@@ -2650,31 +3202,31 @@
|
|
|
2650
3202
|
"actions": [
|
|
2651
3203
|
{
|
|
2652
3204
|
"name": "sendMessage",
|
|
2653
|
-
"description": "",
|
|
3205
|
+
"description": "Send a chat message to the DeepAgent server (POST /api/agent/message), continuing an existing thread or starting one.",
|
|
2654
3206
|
"params": [
|
|
2655
3207
|
{
|
|
2656
3208
|
"name": "message",
|
|
2657
3209
|
"type": "string",
|
|
2658
3210
|
"required": true,
|
|
2659
|
-
"description": ""
|
|
3211
|
+
"description": "Message text."
|
|
2660
3212
|
},
|
|
2661
3213
|
{
|
|
2662
3214
|
"name": "threadId",
|
|
2663
3215
|
"type": "string",
|
|
2664
3216
|
"required": false,
|
|
2665
|
-
"description": ""
|
|
3217
|
+
"description": "Existing thread id to continue; a new thread starts when omitted."
|
|
2666
3218
|
},
|
|
2667
3219
|
{
|
|
2668
3220
|
"name": "skill",
|
|
2669
3221
|
"type": "string",
|
|
2670
3222
|
"required": false,
|
|
2671
|
-
"description": ""
|
|
3223
|
+
"description": "Named skill to invoke for this message."
|
|
2672
3224
|
},
|
|
2673
3225
|
{
|
|
2674
3226
|
"name": "context",
|
|
2675
3227
|
"type": "IntegrationParams",
|
|
2676
3228
|
"required": false,
|
|
2677
|
-
"description": ""
|
|
3229
|
+
"description": "Extra context passed through to the agent."
|
|
2678
3230
|
}
|
|
2679
3231
|
],
|
|
2680
3232
|
"responseShape": {
|
|
@@ -2684,13 +3236,13 @@
|
|
|
2684
3236
|
},
|
|
2685
3237
|
{
|
|
2686
3238
|
"name": "cancelGeneration",
|
|
2687
|
-
"description": "",
|
|
3239
|
+
"description": "Cancel an in-flight generation on a DeepAgent thread (POST /api/agent/cancel).",
|
|
2688
3240
|
"params": [
|
|
2689
3241
|
{
|
|
2690
3242
|
"name": "threadId",
|
|
2691
3243
|
"type": "string",
|
|
2692
3244
|
"required": true,
|
|
2693
|
-
"description": ""
|
|
3245
|
+
"description": "Thread whose generation to cancel."
|
|
2694
3246
|
}
|
|
2695
3247
|
],
|
|
2696
3248
|
"responseShape": {
|
|
@@ -2699,13 +3251,13 @@
|
|
|
2699
3251
|
},
|
|
2700
3252
|
{
|
|
2701
3253
|
"name": "validateSchema",
|
|
2702
|
-
"description": "",
|
|
3254
|
+
"description": "Validate a schema via the DeepAgent server (POST /api/schema/validate).",
|
|
2703
3255
|
"params": [
|
|
2704
3256
|
{
|
|
2705
3257
|
"name": "schema",
|
|
2706
3258
|
"type": "string",
|
|
2707
3259
|
"required": true,
|
|
2708
|
-
"description": ""
|
|
3260
|
+
"description": "Schema content to validate."
|
|
2709
3261
|
}
|
|
2710
3262
|
],
|
|
2711
3263
|
"responseShape": {
|
|
@@ -2715,19 +3267,19 @@
|
|
|
2715
3267
|
},
|
|
2716
3268
|
{
|
|
2717
3269
|
"name": "compileSchema",
|
|
2718
|
-
"description": "",
|
|
3270
|
+
"description": "Compile a schema to a target shell via the DeepAgent server (POST /api/schema/compile).",
|
|
2719
3271
|
"params": [
|
|
2720
3272
|
{
|
|
2721
3273
|
"name": "schema",
|
|
2722
3274
|
"type": "string",
|
|
2723
3275
|
"required": true,
|
|
2724
|
-
"description": ""
|
|
3276
|
+
"description": "Schema content to compile."
|
|
2725
3277
|
},
|
|
2726
3278
|
{
|
|
2727
3279
|
"name": "shell",
|
|
2728
3280
|
"type": "string",
|
|
2729
3281
|
"required": false,
|
|
2730
|
-
"description": ""
|
|
3282
|
+
"description": "Target codegen shell (e.g. 'typescript')."
|
|
2731
3283
|
}
|
|
2732
3284
|
],
|
|
2733
3285
|
"responseShape": {
|
|
@@ -2737,17 +3289,36 @@
|
|
|
2737
3289
|
},
|
|
2738
3290
|
{
|
|
2739
3291
|
"name": "getThreadHistory",
|
|
2740
|
-
"description": "",
|
|
3292
|
+
"description": "Fetch a thread's message history via the DeepAgent server (POST /api/agent/history).",
|
|
2741
3293
|
"params": [
|
|
2742
3294
|
{
|
|
2743
3295
|
"name": "threadId",
|
|
2744
3296
|
"type": "string",
|
|
2745
3297
|
"required": true,
|
|
2746
|
-
"description": ""
|
|
3298
|
+
"description": "Thread id."
|
|
2747
3299
|
}
|
|
2748
3300
|
],
|
|
2749
3301
|
"responseShape": {
|
|
2750
|
-
"messages":
|
|
3302
|
+
"messages": {
|
|
3303
|
+
"type": "array",
|
|
3304
|
+
"items": {
|
|
3305
|
+
"type": "object",
|
|
3306
|
+
"properties": {
|
|
3307
|
+
"role": {
|
|
3308
|
+
"type": "string",
|
|
3309
|
+
"required": true
|
|
3310
|
+
},
|
|
3311
|
+
"content": {
|
|
3312
|
+
"type": "string",
|
|
3313
|
+
"required": true
|
|
3314
|
+
},
|
|
3315
|
+
"timestamp": {
|
|
3316
|
+
"type": "number",
|
|
3317
|
+
"required": true
|
|
3318
|
+
}
|
|
3319
|
+
}
|
|
3320
|
+
}
|
|
3321
|
+
}
|
|
2751
3322
|
}
|
|
2752
3323
|
}
|
|
2753
3324
|
]
|
|
@@ -2759,25 +3330,25 @@
|
|
|
2759
3330
|
"actions": [
|
|
2760
3331
|
{
|
|
2761
3332
|
"name": "query",
|
|
2762
|
-
"description": "",
|
|
3333
|
+
"description": "Run a single read-only SELECT against a Postgres connection (write statements and multi-statement SQL are rejected before execution).",
|
|
2763
3334
|
"params": [
|
|
2764
3335
|
{
|
|
2765
3336
|
"name": "connectionRef",
|
|
2766
3337
|
"type": "string",
|
|
2767
3338
|
"required": true,
|
|
2768
|
-
"description": ""
|
|
3339
|
+
"description": "Env-var NAME whose value is the Postgres connection string — never the secret itself; resolved from the credential store/environment at run time."
|
|
2769
3340
|
},
|
|
2770
3341
|
{
|
|
2771
3342
|
"name": "sql",
|
|
2772
3343
|
"type": "string",
|
|
2773
3344
|
"required": true,
|
|
2774
|
-
"description": ""
|
|
3345
|
+
"description": "SQL text; must be exactly one SELECT statement."
|
|
2775
3346
|
},
|
|
2776
3347
|
{
|
|
2777
3348
|
"name": "params",
|
|
2778
3349
|
"type": "DatabaseQueryParamValue[]",
|
|
2779
3350
|
"required": false,
|
|
2780
|
-
"description": ""
|
|
3351
|
+
"description": "Positional bind parameters for the query."
|
|
2781
3352
|
}
|
|
2782
3353
|
],
|
|
2783
3354
|
"responseShape": {
|
|
@@ -2794,13 +3365,13 @@
|
|
|
2794
3365
|
"actions": [
|
|
2795
3366
|
{
|
|
2796
3367
|
"name": "getPage",
|
|
2797
|
-
"description": "",
|
|
3368
|
+
"description": "Look up a Wikipedia page (redirect-resolved): a one-line description, a Commons thumbnail, and the lead-section extract; empty fields on a miss.",
|
|
2798
3369
|
"params": [
|
|
2799
3370
|
{
|
|
2800
3371
|
"name": "title",
|
|
2801
3372
|
"type": "string",
|
|
2802
3373
|
"required": true,
|
|
2803
|
-
"description": ""
|
|
3374
|
+
"description": "Page title to look up."
|
|
2804
3375
|
}
|
|
2805
3376
|
],
|
|
2806
3377
|
"responseShape": {
|
|
@@ -2819,13 +3390,13 @@
|
|
|
2819
3390
|
"actions": [
|
|
2820
3391
|
{
|
|
2821
3392
|
"name": "svgExists",
|
|
2822
|
-
"description": "",
|
|
3393
|
+
"description": "Check whether an icon exists at the given Iconify API path (a GET, not a HEAD, despite the name).",
|
|
2823
3394
|
"params": [
|
|
2824
3395
|
{
|
|
2825
3396
|
"name": "path",
|
|
2826
3397
|
"type": "string",
|
|
2827
3398
|
"required": true,
|
|
2828
|
-
"description": ""
|
|
3399
|
+
"description": "Iconify API path segment to probe, e.g. 'prefix/name.svg'."
|
|
2829
3400
|
}
|
|
2830
3401
|
],
|
|
2831
3402
|
"responseShape": {
|
|
@@ -2834,19 +3405,19 @@
|
|
|
2834
3405
|
},
|
|
2835
3406
|
{
|
|
2836
3407
|
"name": "search",
|
|
2837
|
-
"description": "",
|
|
3408
|
+
"description": "Search Iconify's icon sets by relevance.",
|
|
2838
3409
|
"params": [
|
|
2839
3410
|
{
|
|
2840
3411
|
"name": "query",
|
|
2841
3412
|
"type": "string",
|
|
2842
3413
|
"required": true,
|
|
2843
|
-
"description": ""
|
|
3414
|
+
"description": "Search query text."
|
|
2844
3415
|
},
|
|
2845
3416
|
{
|
|
2846
3417
|
"name": "limit",
|
|
2847
3418
|
"type": "number",
|
|
2848
3419
|
"required": false,
|
|
2849
|
-
"description": ""
|
|
3420
|
+
"description": "Maximum icon ids to return; defaults to 1."
|
|
2850
3421
|
}
|
|
2851
3422
|
],
|
|
2852
3423
|
"responseShape": {
|
|
@@ -2855,13 +3426,13 @@
|
|
|
2855
3426
|
},
|
|
2856
3427
|
{
|
|
2857
3428
|
"name": "getIconBody",
|
|
2858
|
-
"description": "",
|
|
3429
|
+
"description": "Fetch an icon's raw SVG body (for color-tone classification); null if the icon or its collection isn't found.",
|
|
2859
3430
|
"params": [
|
|
2860
3431
|
{
|
|
2861
3432
|
"name": "iconId",
|
|
2862
3433
|
"type": "string",
|
|
2863
3434
|
"required": true,
|
|
2864
|
-
"description": ""
|
|
3435
|
+
"description": "Icon id in \"prefix:name\" form."
|
|
2865
3436
|
}
|
|
2866
3437
|
],
|
|
2867
3438
|
"responseShape": {
|
|
@@ -2877,23 +3448,54 @@
|
|
|
2877
3448
|
"actions": [
|
|
2878
3449
|
{
|
|
2879
3450
|
"name": "search",
|
|
2880
|
-
"description": "",
|
|
3451
|
+
"description": "Search arXiv's public Atom API by relevance.",
|
|
2881
3452
|
"params": [
|
|
2882
3453
|
{
|
|
2883
3454
|
"name": "query",
|
|
2884
3455
|
"type": "string",
|
|
2885
3456
|
"required": true,
|
|
2886
|
-
"description": ""
|
|
3457
|
+
"description": "Search query text (matched across all fields)."
|
|
2887
3458
|
},
|
|
2888
3459
|
{
|
|
2889
3460
|
"name": "maxResults",
|
|
2890
3461
|
"type": "number",
|
|
2891
3462
|
"required": false,
|
|
2892
|
-
"description": ""
|
|
3463
|
+
"description": "Maximum results to return; defaults to 8."
|
|
2893
3464
|
}
|
|
2894
3465
|
],
|
|
2895
3466
|
"responseShape": {
|
|
2896
|
-
"results":
|
|
3467
|
+
"results": {
|
|
3468
|
+
"type": "array",
|
|
3469
|
+
"items": {
|
|
3470
|
+
"type": "object",
|
|
3471
|
+
"properties": {
|
|
3472
|
+
"id": {
|
|
3473
|
+
"type": "string",
|
|
3474
|
+
"required": true
|
|
3475
|
+
},
|
|
3476
|
+
"title": {
|
|
3477
|
+
"type": "string",
|
|
3478
|
+
"required": true
|
|
3479
|
+
},
|
|
3480
|
+
"summary": {
|
|
3481
|
+
"type": "string",
|
|
3482
|
+
"required": true
|
|
3483
|
+
},
|
|
3484
|
+
"authors": {
|
|
3485
|
+
"type": "string[]",
|
|
3486
|
+
"required": true
|
|
3487
|
+
},
|
|
3488
|
+
"published": {
|
|
3489
|
+
"type": "string",
|
|
3490
|
+
"required": true
|
|
3491
|
+
},
|
|
3492
|
+
"url": {
|
|
3493
|
+
"type": "string",
|
|
3494
|
+
"required": true
|
|
3495
|
+
}
|
|
3496
|
+
}
|
|
3497
|
+
}
|
|
3498
|
+
}
|
|
2897
3499
|
}
|
|
2898
3500
|
}
|
|
2899
3501
|
]
|