@inboxychat/sdk 0.0.0-stage → 0.2.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.
Files changed (42) hide show
  1. package/README.md +111 -2
  2. package/dist/api-route-inventory.generated.d.ts +2215 -0
  3. package/dist/api-route-inventory.generated.d.ts.map +1 -0
  4. package/dist/api-route-inventory.generated.js +2769 -0
  5. package/dist/api-route-inventory.generated.js.map +1 -0
  6. package/dist/capabilities.d.ts +24 -0
  7. package/dist/capabilities.d.ts.map +1 -0
  8. package/dist/capabilities.js +39 -0
  9. package/dist/capabilities.js.map +1 -0
  10. package/dist/client.d.ts +80 -0
  11. package/dist/client.d.ts.map +1 -0
  12. package/dist/client.js +314 -0
  13. package/dist/client.js.map +1 -0
  14. package/dist/credentials.d.ts +76 -0
  15. package/dist/credentials.d.ts.map +1 -0
  16. package/dist/credentials.js +323 -0
  17. package/dist/credentials.js.map +1 -0
  18. package/dist/errors.d.ts +48 -0
  19. package/dist/errors.d.ts.map +1 -0
  20. package/dist/errors.js +78 -0
  21. package/dist/errors.js.map +1 -0
  22. package/dist/index.d.ts +10 -0
  23. package/dist/index.d.ts.map +1 -0
  24. package/dist/index.js +10 -0
  25. package/dist/index.js.map +1 -0
  26. package/dist/operations.d.ts +45 -0
  27. package/dist/operations.d.ts.map +1 -0
  28. package/dist/operations.js +467 -0
  29. package/dist/operations.js.map +1 -0
  30. package/dist/redact.d.ts +6 -0
  31. package/dist/redact.d.ts.map +1 -0
  32. package/dist/redact.js +25 -0
  33. package/dist/redact.js.map +1 -0
  34. package/dist/routes.d.ts +60 -0
  35. package/dist/routes.d.ts.map +1 -0
  36. package/dist/routes.js +24 -0
  37. package/dist/routes.js.map +1 -0
  38. package/dist/types.d.ts +295 -0
  39. package/dist/types.d.ts.map +1 -0
  40. package/dist/types.js +69 -0
  41. package/dist/types.js.map +1 -0
  42. package/package.json +38 -3
@@ -0,0 +1,2215 @@
1
+ /** Generated discovery metadata only. These routes are NOT automatically executable. */
2
+ export declare const API_ROUTE_INVENTORY: readonly [{
3
+ readonly route: "POST /api/v1/whatsapp/messages/text";
4
+ readonly scope: "messages:send";
5
+ readonly summary: "Send a WhatsApp text message";
6
+ }, {
7
+ readonly route: "POST /api/v1/whatsapp/messages/template";
8
+ readonly scope: "messages:send";
9
+ readonly summary: "Send an approved WhatsApp template";
10
+ }, {
11
+ readonly route: "POST /api/v1/whatsapp/messages/media";
12
+ readonly scope: "messages:send";
13
+ readonly summary: "Send WhatsApp media (image, video, audio, document)";
14
+ }, {
15
+ readonly route: "POST /api/v1/whatsapp/messages/buttons";
16
+ readonly scope: "messages:send";
17
+ readonly summary: "Send a WhatsApp reply-buttons message";
18
+ }, {
19
+ readonly route: "POST /api/v1/whatsapp/messages/list";
20
+ readonly scope: "messages:send";
21
+ readonly summary: "Send a WhatsApp list message";
22
+ }, {
23
+ readonly route: "POST /api/v1/inbox/conversations/:conversationId/messages";
24
+ readonly scope: "messages:send";
25
+ readonly summary: "Reply in a conversation on any channel";
26
+ }, {
27
+ readonly route: "POST /api/v1/whatsapp/messages/cta-url";
28
+ readonly scope: "messages:send";
29
+ readonly summary: "Send a WhatsApp call-to-action URL button";
30
+ }, {
31
+ readonly route: "POST /api/v1/whatsapp/messages/location-request";
32
+ readonly scope: "messages:send";
33
+ readonly summary: "Ask the customer to share their location";
34
+ }, {
35
+ readonly route: "POST /api/v1/whatsapp/messages/location";
36
+ readonly scope: "messages:send";
37
+ readonly summary: "Send a location pin";
38
+ }, {
39
+ readonly route: "POST /api/v1/whatsapp/messages/contacts";
40
+ readonly scope: "messages:send";
41
+ readonly summary: "Send contact cards";
42
+ }, {
43
+ readonly route: "POST /api/v1/whatsapp/messages/contact";
44
+ readonly scope: "messages:send";
45
+ readonly summary: "Send one contact card";
46
+ }, {
47
+ readonly route: "POST /api/v1/whatsapp/messages/catalog";
48
+ readonly scope: "messages:send";
49
+ readonly summary: "Send the WhatsApp catalog";
50
+ }, {
51
+ readonly route: "POST /api/v1/whatsapp/messages/product";
52
+ readonly scope: "messages:send";
53
+ readonly summary: "Send one catalog product";
54
+ }, {
55
+ readonly route: "POST /api/v1/whatsapp/messages/product-list";
56
+ readonly scope: "messages:send";
57
+ readonly summary: "Send a multi-product message";
58
+ }, {
59
+ readonly route: "POST /api/v1/whatsapp/messages/catalog-card";
60
+ readonly scope: "messages:send";
61
+ readonly summary: "Send an Inboxy product or service card";
62
+ }, {
63
+ readonly route: "POST /api/v1/whatsapp/messages/:messageId/read";
64
+ readonly scope: "messages:send";
65
+ readonly summary: "Mark an inbound WhatsApp message as read";
66
+ }, {
67
+ readonly route: "POST /api/v1/whatsapp/media/upload";
68
+ readonly scope: "messages:send";
69
+ readonly summary: "Upload media to WhatsApp and get a media id for sends";
70
+ }, {
71
+ readonly route: "POST /api/v1/interactive-messages/send-saved";
72
+ readonly scope: "messages:send";
73
+ readonly summary: "Send a saved interactive message into a conversation";
74
+ }, {
75
+ readonly route: "GET /api/v1/whatsapp/templates";
76
+ readonly scope: "templates:read";
77
+ readonly summary: "List WhatsApp templates";
78
+ }, {
79
+ readonly route: "GET /api/v1/whatsapp/templates/:templateId";
80
+ readonly scope: "templates:read";
81
+ readonly summary: "Get a WhatsApp template";
82
+ }, {
83
+ readonly route: "GET /api/v1/whatsapp/templates/:templateName/usage";
84
+ readonly scope: "templates:read";
85
+ readonly summary: "Delivery ledger for a template";
86
+ }, {
87
+ readonly route: "POST /api/v1/whatsapp/templates";
88
+ readonly scope: "templates:write";
89
+ readonly summary: "Create a WhatsApp template and submit it to Meta for review";
90
+ }, {
91
+ readonly route: "PUT /api/v1/whatsapp/templates/:templateId";
92
+ readonly scope: "templates:write";
93
+ readonly summary: "Edit a submitted template and send it back to Meta for review";
94
+ }, {
95
+ readonly route: "DELETE /api/v1/whatsapp/templates/:templateName";
96
+ readonly scope: "templates:write";
97
+ readonly summary: "Delete a WhatsApp template (all languages) from Meta and Inboxy";
98
+ }, {
99
+ readonly route: "POST /api/v1/whatsapp/templates/sync";
100
+ readonly scope: "templates:write";
101
+ readonly summary: "Sync templates and their approval status from Meta";
102
+ }, {
103
+ readonly route: "POST /api/v1/whatsapp/media/upload-for-template";
104
+ readonly scope: "templates:write";
105
+ readonly summary: "Upload a template header file and get its media handle";
106
+ }, {
107
+ readonly route: "PATCH /api/v1/whatsapp/templates/:templateId/media";
108
+ readonly scope: "templates:write";
109
+ readonly summary: "Attach the media every send of this template uses";
110
+ }, {
111
+ readonly route: "PATCH /api/v1/whatsapp/templates/:templateName/mapping";
112
+ readonly scope: "templates:write";
113
+ readonly summary: "Change where template variables get their values";
114
+ }, {
115
+ readonly route: "GET /api/v1/whatsapp/campaigns";
116
+ readonly scope: "campaigns:read";
117
+ readonly summary: "List WhatsApp campaigns";
118
+ }, {
119
+ readonly route: "GET /api/v1/whatsapp/campaigns/:id";
120
+ readonly scope: "campaigns:read";
121
+ readonly summary: "Get a campaign";
122
+ }, {
123
+ readonly route: "GET /api/v1/whatsapp/campaigns/:id/details";
124
+ readonly scope: "campaigns:read";
125
+ readonly summary: "Get campaign details and counts";
126
+ }, {
127
+ readonly route: "GET /api/v1/whatsapp/campaigns/:id/recipients";
128
+ readonly scope: "campaigns:read";
129
+ readonly summary: "List campaign recipients";
130
+ }, {
131
+ readonly route: "GET /api/v1/whatsapp/campaigns/:id/analytics";
132
+ readonly scope: "campaigns:read";
133
+ readonly summary: "Get campaign link clicks";
134
+ }, {
135
+ readonly route: "GET /api/v1/whatsapp/campaigns/:id/timeseries";
136
+ readonly scope: "campaigns:read";
137
+ readonly summary: "Get deliveries over time";
138
+ }, {
139
+ readonly route: "POST /api/v1/whatsapp/campaigns/preview";
140
+ readonly scope: "campaigns:read";
141
+ readonly summary: "Preview audience size and cost without creating";
142
+ }, {
143
+ readonly route: "POST /api/v1/whatsapp/campaigns";
144
+ readonly scope: "campaigns:write";
145
+ readonly summary: "Create a campaign";
146
+ }, {
147
+ readonly route: "PUT /api/v1/whatsapp/campaigns/:id";
148
+ readonly scope: "campaigns:write";
149
+ readonly summary: "Update a draft or scheduled campaign";
150
+ }, {
151
+ readonly route: "DELETE /api/v1/whatsapp/campaigns/:id";
152
+ readonly scope: "campaigns:write";
153
+ readonly summary: "Delete a campaign";
154
+ }, {
155
+ readonly route: "POST /api/v1/whatsapp/campaigns/import-audience";
156
+ readonly scope: "campaigns:write";
157
+ readonly summary: "Import an audience (matches or creates contacts)";
158
+ }, {
159
+ readonly route: "GET /api/v1/whatsapp/campaigns/:id/action-preview";
160
+ readonly scope: "campaigns:read";
161
+ readonly summary: "Preview exact campaign recipients, content, sender and timing";
162
+ }, {
163
+ readonly route: "POST /api/v1/whatsapp/campaigns/:id/approved-send";
164
+ readonly scope: "campaigns:write";
165
+ readonly summary: "Send the exact approved campaign snapshot";
166
+ }, {
167
+ readonly route: "POST /api/v1/whatsapp/campaigns/:id/approved-schedule";
168
+ readonly scope: "campaigns:write";
169
+ readonly summary: "Schedule the exact approved campaign snapshot";
170
+ }, {
171
+ readonly route: "POST /api/v1/whatsapp/campaigns/:id/approved-resume";
172
+ readonly scope: "campaigns:write";
173
+ readonly summary: "Resume the exact approved remaining audience";
174
+ }, {
175
+ readonly route: "POST /api/v1/whatsapp/campaigns/:id/run";
176
+ readonly scope: "campaigns:write";
177
+ readonly summary: "Start sending a campaign";
178
+ }, {
179
+ readonly route: "POST /api/v1/whatsapp/campaigns/:id/pause";
180
+ readonly scope: "campaigns:write";
181
+ readonly summary: "Pause a running campaign";
182
+ }, {
183
+ readonly route: "POST /api/v1/whatsapp/campaigns/:id/resume";
184
+ readonly scope: "campaigns:write";
185
+ readonly summary: "Resume a paused campaign";
186
+ }, {
187
+ readonly route: "POST /api/v1/whatsapp/campaigns/:id/cancel";
188
+ readonly scope: "campaigns:write";
189
+ readonly summary: "Cancel a campaign";
190
+ }, {
191
+ readonly route: "POST /api/v1/whatsapp/campaigns/:id/retry";
192
+ readonly scope: "campaigns:write";
193
+ readonly summary: "Retry failed recipients";
194
+ }, {
195
+ readonly route: "GET /api/v1/scheduled-messages";
196
+ readonly scope: "messages:read";
197
+ readonly summary: "List scheduled messages";
198
+ }, {
199
+ readonly route: "GET /api/v1/scheduled-messages/:id";
200
+ readonly scope: "messages:read";
201
+ readonly summary: "Get one scheduled message";
202
+ }, {
203
+ readonly route: "POST /api/v1/scheduled-messages";
204
+ readonly scope: "messages:send";
205
+ readonly summary: "Schedule a message";
206
+ }, {
207
+ readonly route: "PATCH /api/v1/scheduled-messages/:id";
208
+ readonly scope: "messages:send";
209
+ readonly summary: "Reschedule or edit a scheduled message";
210
+ }, {
211
+ readonly route: "POST /api/v1/scheduled-messages/:id/retry";
212
+ readonly scope: "messages:send";
213
+ readonly summary: "Retry a failed scheduled message";
214
+ }, {
215
+ readonly route: "POST /api/v1/scheduled-messages/:id/cancel";
216
+ readonly scope: "messages:send";
217
+ readonly summary: "Cancel a scheduled message";
218
+ }, {
219
+ readonly route: "POST /api/v1/scheduled-messages/:id/pause";
220
+ readonly scope: "messages:send";
221
+ readonly summary: "Pause a recurring message";
222
+ }, {
223
+ readonly route: "POST /api/v1/scheduled-messages/:id/resume";
224
+ readonly scope: "messages:send";
225
+ readonly summary: "Resume a paused message";
226
+ }, {
227
+ readonly route: "POST /api/v1/scheduled-messages/:id/send-now";
228
+ readonly scope: "messages:send";
229
+ readonly summary: "Send a scheduled message now";
230
+ }, {
231
+ readonly route: "DELETE /api/v1/scheduled-messages/:id";
232
+ readonly scope: "messages:send";
233
+ readonly summary: "Delete a scheduled message";
234
+ }, {
235
+ readonly route: "GET /api/v1/interactive-messages";
236
+ readonly scope: "library:read";
237
+ readonly summary: "List saved interactive messages";
238
+ }, {
239
+ readonly route: "GET /api/v1/interactive-messages/stats";
240
+ readonly scope: "library:read";
241
+ readonly summary: "Saved interactive message stats";
242
+ }, {
243
+ readonly route: "GET /api/v1/interactive-messages/categories";
244
+ readonly scope: "library:read";
245
+ readonly summary: "List library categories";
246
+ }, {
247
+ readonly route: "GET /api/v1/interactive-messages/:id";
248
+ readonly scope: "library:read";
249
+ readonly summary: "Get a saved interactive message";
250
+ }, {
251
+ readonly route: "POST /api/v1/interactive-messages";
252
+ readonly scope: "library:write";
253
+ readonly summary: "Save an interactive message";
254
+ }, {
255
+ readonly route: "PUT /api/v1/interactive-messages/:id";
256
+ readonly scope: "library:write";
257
+ readonly summary: "Update a saved interactive message";
258
+ }, {
259
+ readonly route: "DELETE /api/v1/interactive-messages/:id";
260
+ readonly scope: "library:write";
261
+ readonly summary: "Delete a saved interactive message";
262
+ }, {
263
+ readonly route: "POST /api/v1/interactive-messages/:id/duplicate";
264
+ readonly scope: "library:write";
265
+ readonly summary: "Duplicate a saved interactive message";
266
+ }, {
267
+ readonly route: "GET /api/v1/me/channels";
268
+ readonly scope: "channels:read";
269
+ readonly summary: "Connection status of every channel (WhatsApp, Instagram, Messenger, Telegram, website chat)";
270
+ }, {
271
+ readonly route: "POST /api/v1/instagram/send";
272
+ readonly scope: "messages:send";
273
+ readonly summary: "Send an Instagram DM";
274
+ }, {
275
+ readonly route: "POST /api/v1/instagram/send/buttons";
276
+ readonly scope: "messages:send";
277
+ readonly summary: "Send an Instagram DM with buttons";
278
+ }, {
279
+ readonly route: "POST /api/v1/instagram/send/carousel";
280
+ readonly scope: "messages:send";
281
+ readonly summary: "Send an Instagram carousel";
282
+ }, {
283
+ readonly route: "POST /api/v1/instagram/send/quick-replies";
284
+ readonly scope: "messages:send";
285
+ readonly summary: "Send Instagram quick replies";
286
+ }, {
287
+ readonly route: "POST /api/v1/instagram/send/media-template";
288
+ readonly scope: "messages:send";
289
+ readonly summary: "Send an Instagram media template";
290
+ }, {
291
+ readonly route: "POST /api/v1/instagram/templates/:id/send";
292
+ readonly scope: "messages:send";
293
+ readonly summary: "Send a saved Instagram template";
294
+ }, {
295
+ readonly route: "GET /api/v1/instagram/conversations/:conversationId/window";
296
+ readonly scope: "conversations:read";
297
+ readonly summary: "Check the Instagram messaging window";
298
+ }, {
299
+ readonly route: "GET /api/v1/instagram/templates";
300
+ readonly scope: "templates:read";
301
+ readonly summary: "List saved Instagram templates";
302
+ }, {
303
+ readonly route: "GET /api/v1/instagram/templates/:id";
304
+ readonly scope: "templates:read";
305
+ readonly summary: "Get a saved Instagram template";
306
+ }, {
307
+ readonly route: "GET /api/v1/instagram/templates/:id/detail";
308
+ readonly scope: "templates:read";
309
+ readonly summary: "Get template detail and usage";
310
+ }, {
311
+ readonly route: "POST /api/v1/instagram/templates";
312
+ readonly scope: "templates:write";
313
+ readonly summary: "Save an Instagram template";
314
+ }, {
315
+ readonly route: "PUT /api/v1/instagram/templates/:id";
316
+ readonly scope: "templates:write";
317
+ readonly summary: "Update a saved Instagram template";
318
+ }, {
319
+ readonly route: "DELETE /api/v1/instagram/templates/:id";
320
+ readonly scope: "templates:write";
321
+ readonly summary: "Delete a saved Instagram template";
322
+ }, {
323
+ readonly route: "GET /api/v1/instagram/quick-replies";
324
+ readonly scope: "library:read";
325
+ readonly summary: "List Instagram quick replies";
326
+ }, {
327
+ readonly route: "GET /api/v1/instagram/quick-replies/categories";
328
+ readonly scope: "library:read";
329
+ readonly summary: "List quick reply categories";
330
+ }, {
331
+ readonly route: "GET /api/v1/instagram/quick-replies/:id";
332
+ readonly scope: "library:read";
333
+ readonly summary: "Get an Instagram quick reply";
334
+ }, {
335
+ readonly route: "POST /api/v1/instagram/quick-replies";
336
+ readonly scope: "library:write";
337
+ readonly summary: "Create an Instagram quick reply";
338
+ }, {
339
+ readonly route: "PUT /api/v1/instagram/quick-replies/:id";
340
+ readonly scope: "library:write";
341
+ readonly summary: "Update an Instagram quick reply";
342
+ }, {
343
+ readonly route: "DELETE /api/v1/instagram/quick-replies/:id";
344
+ readonly scope: "library:write";
345
+ readonly summary: "Delete an Instagram quick reply";
346
+ }, {
347
+ readonly route: "GET /api/v1/instagram/interactive-messages";
348
+ readonly scope: "library:read";
349
+ readonly summary: "List Instagram interactive messages";
350
+ }, {
351
+ readonly route: "GET /api/v1/instagram/interactive-messages/:id";
352
+ readonly scope: "library:read";
353
+ readonly summary: "Get an Instagram interactive message";
354
+ }, {
355
+ readonly route: "POST /api/v1/instagram/interactive-messages";
356
+ readonly scope: "library:write";
357
+ readonly summary: "Save an Instagram interactive message";
358
+ }, {
359
+ readonly route: "PUT /api/v1/instagram/interactive-messages/:id";
360
+ readonly scope: "library:write";
361
+ readonly summary: "Update an Instagram interactive message";
362
+ }, {
363
+ readonly route: "DELETE /api/v1/instagram/interactive-messages/:id";
364
+ readonly scope: "library:write";
365
+ readonly summary: "Delete an Instagram interactive message";
366
+ }, {
367
+ readonly route: "GET /api/v1/instagram/campaigns";
368
+ readonly scope: "campaigns:read";
369
+ readonly summary: "List Instagram campaigns";
370
+ }, {
371
+ readonly route: "GET /api/v1/instagram/campaigns/:id";
372
+ readonly scope: "campaigns:read";
373
+ readonly summary: "Get an Instagram campaign";
374
+ }, {
375
+ readonly route: "GET /api/v1/instagram/campaigns/:id/recipients";
376
+ readonly scope: "campaigns:read";
377
+ readonly summary: "List campaign recipients";
378
+ }, {
379
+ readonly route: "GET /api/v1/instagram/campaigns/:id/stats";
380
+ readonly scope: "campaigns:read";
381
+ readonly summary: "Campaign delivery stats";
382
+ }, {
383
+ readonly route: "POST /api/v1/instagram/campaigns";
384
+ readonly scope: "campaigns:write";
385
+ readonly summary: "Create an Instagram campaign";
386
+ }, {
387
+ readonly route: "PUT /api/v1/instagram/campaigns/:id";
388
+ readonly scope: "campaigns:write";
389
+ readonly summary: "Update an Instagram campaign";
390
+ }, {
391
+ readonly route: "DELETE /api/v1/instagram/campaigns/:id";
392
+ readonly scope: "campaigns:write";
393
+ readonly summary: "Delete an Instagram campaign";
394
+ }, {
395
+ readonly route: "POST /api/v1/instagram/campaigns/:id/recipients";
396
+ readonly scope: "campaigns:write";
397
+ readonly summary: "Add campaign recipients";
398
+ }, {
399
+ readonly route: "POST /api/v1/instagram/campaigns/:id/run";
400
+ readonly scope: "campaigns:write";
401
+ readonly summary: "Start an Instagram campaign";
402
+ }, {
403
+ readonly route: "POST /api/v1/instagram/campaigns/:id/pause";
404
+ readonly scope: "campaigns:write";
405
+ readonly summary: "Pause an Instagram campaign";
406
+ }, {
407
+ readonly route: "POST /api/v1/instagram/campaigns/:id/resume";
408
+ readonly scope: "campaigns:write";
409
+ readonly summary: "Resume an Instagram campaign";
410
+ }, {
411
+ readonly route: "POST /api/v1/instagram/campaigns/:id/cancel";
412
+ readonly scope: "campaigns:write";
413
+ readonly summary: "Cancel an Instagram campaign";
414
+ }, {
415
+ readonly route: "POST /api/v1/instagram/campaigns/:id/duplicate";
416
+ readonly scope: "campaigns:write";
417
+ readonly summary: "Duplicate an Instagram campaign";
418
+ }, {
419
+ readonly route: "GET /api/v1/instagram/comment-automations";
420
+ readonly scope: "automations:read";
421
+ readonly summary: "List comment-to-DM automations";
422
+ }, {
423
+ readonly route: "GET /api/v1/instagram/comment-automations/:id";
424
+ readonly scope: "automations:read";
425
+ readonly summary: "Get a comment-to-DM automation";
426
+ }, {
427
+ readonly route: "GET /api/v1/instagram/comment-automations/posts";
428
+ readonly scope: "channels:read";
429
+ readonly summary: "List your Instagram posts";
430
+ }, {
431
+ readonly route: "GET /api/v1/instagram/comment-automations/posts/:mediaId/comments";
432
+ readonly scope: "channels:read";
433
+ readonly summary: "List comments on an Instagram post";
434
+ }, {
435
+ readonly route: "POST /api/v1/instagram/comment-automations";
436
+ readonly scope: "automations:write";
437
+ readonly summary: "Auto-reply to comments on a post (public reply and/or DM)";
438
+ }, {
439
+ readonly route: "PUT /api/v1/instagram/comment-automations/:id";
440
+ readonly scope: "automations:write";
441
+ readonly summary: "Update a comment-to-DM automation";
442
+ }, {
443
+ readonly route: "PATCH /api/v1/instagram/comment-automations/:id/toggle";
444
+ readonly scope: "automations:write";
445
+ readonly summary: "Turn a comment-to-DM automation on or off";
446
+ }, {
447
+ readonly route: "DELETE /api/v1/instagram/comment-automations/:id";
448
+ readonly scope: "automations:write";
449
+ readonly summary: "Delete a comment-to-DM automation";
450
+ }, {
451
+ readonly route: "GET /api/v1/instagram/ice-breakers";
452
+ readonly scope: "channels:read";
453
+ readonly summary: "List Instagram ice breakers";
454
+ }, {
455
+ readonly route: "POST /api/v1/instagram/ice-breakers";
456
+ readonly scope: "channels:write";
457
+ readonly summary: "Replace Instagram ice breakers";
458
+ }, {
459
+ readonly route: "POST /api/v1/instagram/ice-breakers/add";
460
+ readonly scope: "channels:write";
461
+ readonly summary: "Add an ice breaker";
462
+ }, {
463
+ readonly route: "POST /api/v1/instagram/ice-breakers/reorder";
464
+ readonly scope: "channels:write";
465
+ readonly summary: "Reorder ice breakers";
466
+ }, {
467
+ readonly route: "PUT /api/v1/instagram/ice-breakers/:index";
468
+ readonly scope: "channels:write";
469
+ readonly summary: "Update an ice breaker";
470
+ }, {
471
+ readonly route: "DELETE /api/v1/instagram/ice-breakers/:index";
472
+ readonly scope: "channels:write";
473
+ readonly summary: "Delete an ice breaker";
474
+ }, {
475
+ readonly route: "DELETE /api/v1/instagram/ice-breakers";
476
+ readonly scope: "channels:write";
477
+ readonly summary: "Remove all ice breakers";
478
+ }, {
479
+ readonly route: "GET /api/v1/instagram/story-mentions/config";
480
+ readonly scope: "automations:read";
481
+ readonly summary: "Story mention auto-reply settings";
482
+ }, {
483
+ readonly route: "PUT /api/v1/instagram/story-mentions/config";
484
+ readonly scope: "automations:write";
485
+ readonly summary: "Change story mention auto-reply settings";
486
+ }, {
487
+ readonly route: "POST /api/v1/instagram/story-mentions/responses";
488
+ readonly scope: "automations:write";
489
+ readonly summary: "Add a story mention reply";
490
+ }, {
491
+ readonly route: "PUT /api/v1/instagram/story-mentions/responses/:id";
492
+ readonly scope: "automations:write";
493
+ readonly summary: "Update a story mention reply";
494
+ }, {
495
+ readonly route: "DELETE /api/v1/instagram/story-mentions/responses/:id";
496
+ readonly scope: "automations:write";
497
+ readonly summary: "Delete a story mention reply";
498
+ }, {
499
+ readonly route: "GET /api/v1/instagram/story-mentions/stats";
500
+ readonly scope: "analytics:read";
501
+ readonly summary: "Story mention stats";
502
+ }, {
503
+ readonly route: "GET /api/v1/instagram/stats";
504
+ readonly scope: "analytics:read";
505
+ readonly summary: "Instagram message totals";
506
+ }, {
507
+ readonly route: "GET /api/v1/instagram/top-performers";
508
+ readonly scope: "analytics:read";
509
+ readonly summary: "Top Instagram templates and replies";
510
+ }, {
511
+ readonly route: "GET /api/v1/instagram/volume-timeline";
512
+ readonly scope: "analytics:read";
513
+ readonly summary: "Instagram message volume over time";
514
+ }, {
515
+ readonly route: "GET /api/v1/instagram/rate-limit";
516
+ readonly scope: "channels:read";
517
+ readonly summary: "Remaining Instagram send quota";
518
+ }, {
519
+ readonly route: "POST /api/v1/messenger/send";
520
+ readonly scope: "messages:send";
521
+ readonly summary: "Send a Messenger message";
522
+ }, {
523
+ readonly route: "POST /api/v1/messenger/send/media";
524
+ readonly scope: "messages:send";
525
+ readonly summary: "Send Messenger media";
526
+ }, {
527
+ readonly route: "POST /api/v1/messenger/send/buttons";
528
+ readonly scope: "messages:send";
529
+ readonly summary: "Send a Messenger button template";
530
+ }, {
531
+ readonly route: "POST /api/v1/messenger/send/carousel";
532
+ readonly scope: "messages:send";
533
+ readonly summary: "Send a Messenger carousel";
534
+ }, {
535
+ readonly route: "POST /api/v1/messenger/send/quick-replies";
536
+ readonly scope: "messages:send";
537
+ readonly summary: "Send Messenger quick replies";
538
+ }, {
539
+ readonly route: "POST /api/v1/messenger/send/media-template";
540
+ readonly scope: "messages:send";
541
+ readonly summary: "Send a Messenger media template";
542
+ }, {
543
+ readonly route: "POST /api/v1/messenger/send/receipt";
544
+ readonly scope: "messages:send";
545
+ readonly summary: "Send a Messenger order receipt";
546
+ }, {
547
+ readonly route: "POST /api/v1/messenger/send/tag";
548
+ readonly scope: "messages:send";
549
+ readonly summary: "Send outside the 24-hour window with a message tag";
550
+ }, {
551
+ readonly route: "POST /api/v1/messenger/templates/:id/send";
552
+ readonly scope: "messages:send";
553
+ readonly summary: "Send a saved Messenger template";
554
+ }, {
555
+ readonly route: "GET /api/v1/messenger/window/:conversationId";
556
+ readonly scope: "conversations:read";
557
+ readonly summary: "Check the Messenger messaging window";
558
+ }, {
559
+ readonly route: "GET /api/v1/messenger/templates";
560
+ readonly scope: "templates:read";
561
+ readonly summary: "List saved Messenger templates";
562
+ }, {
563
+ readonly route: "GET /api/v1/messenger/templates/:id";
564
+ readonly scope: "templates:read";
565
+ readonly summary: "Get a saved Messenger template";
566
+ }, {
567
+ readonly route: "GET /api/v1/messenger/templates/:id/detail";
568
+ readonly scope: "templates:read";
569
+ readonly summary: "Get template detail and usage";
570
+ }, {
571
+ readonly route: "POST /api/v1/messenger/templates";
572
+ readonly scope: "templates:write";
573
+ readonly summary: "Save a Messenger template";
574
+ }, {
575
+ readonly route: "PUT /api/v1/messenger/templates/:id";
576
+ readonly scope: "templates:write";
577
+ readonly summary: "Update a saved Messenger template";
578
+ }, {
579
+ readonly route: "DELETE /api/v1/messenger/templates/:id";
580
+ readonly scope: "templates:write";
581
+ readonly summary: "Delete a saved Messenger template";
582
+ }, {
583
+ readonly route: "POST /api/v1/messenger/templates/:id/duplicate";
584
+ readonly scope: "templates:write";
585
+ readonly summary: "Duplicate a Messenger template";
586
+ }, {
587
+ readonly route: "GET /api/v1/messenger/quick-replies";
588
+ readonly scope: "library:read";
589
+ readonly summary: "List Messenger quick replies";
590
+ }, {
591
+ readonly route: "GET /api/v1/messenger/quick-replies/categories";
592
+ readonly scope: "library:read";
593
+ readonly summary: "List quick reply categories";
594
+ }, {
595
+ readonly route: "GET /api/v1/messenger/quick-replies/:id";
596
+ readonly scope: "library:read";
597
+ readonly summary: "Get a Messenger quick reply";
598
+ }, {
599
+ readonly route: "POST /api/v1/messenger/quick-replies";
600
+ readonly scope: "library:write";
601
+ readonly summary: "Create a Messenger quick reply";
602
+ }, {
603
+ readonly route: "PUT /api/v1/messenger/quick-replies/:id";
604
+ readonly scope: "library:write";
605
+ readonly summary: "Update a Messenger quick reply";
606
+ }, {
607
+ readonly route: "DELETE /api/v1/messenger/quick-replies/:id";
608
+ readonly scope: "library:write";
609
+ readonly summary: "Delete a Messenger quick reply";
610
+ }, {
611
+ readonly route: "POST /api/v1/messenger/quick-replies/:id/duplicate";
612
+ readonly scope: "library:write";
613
+ readonly summary: "Duplicate a Messenger quick reply";
614
+ }, {
615
+ readonly route: "GET /api/v1/messenger/interactive-messages";
616
+ readonly scope: "library:read";
617
+ readonly summary: "List Messenger interactive messages";
618
+ }, {
619
+ readonly route: "GET /api/v1/messenger/interactive-messages/:id";
620
+ readonly scope: "library:read";
621
+ readonly summary: "Get a Messenger interactive message";
622
+ }, {
623
+ readonly route: "POST /api/v1/messenger/interactive-messages";
624
+ readonly scope: "library:write";
625
+ readonly summary: "Save a Messenger interactive message";
626
+ }, {
627
+ readonly route: "PUT /api/v1/messenger/interactive-messages/:id";
628
+ readonly scope: "library:write";
629
+ readonly summary: "Update a Messenger interactive message";
630
+ }, {
631
+ readonly route: "DELETE /api/v1/messenger/interactive-messages/:id";
632
+ readonly scope: "library:write";
633
+ readonly summary: "Delete a Messenger interactive message";
634
+ }, {
635
+ readonly route: "GET /api/v1/messenger/campaigns";
636
+ readonly scope: "campaigns:read";
637
+ readonly summary: "List Messenger campaigns";
638
+ }, {
639
+ readonly route: "GET /api/v1/messenger/campaigns/:id";
640
+ readonly scope: "campaigns:read";
641
+ readonly summary: "Get a Messenger campaign";
642
+ }, {
643
+ readonly route: "GET /api/v1/messenger/campaigns/:id/recipients";
644
+ readonly scope: "campaigns:read";
645
+ readonly summary: "List campaign recipients";
646
+ }, {
647
+ readonly route: "GET /api/v1/messenger/campaigns/:id/stats";
648
+ readonly scope: "campaigns:read";
649
+ readonly summary: "Campaign delivery stats";
650
+ }, {
651
+ readonly route: "POST /api/v1/messenger/campaigns";
652
+ readonly scope: "campaigns:write";
653
+ readonly summary: "Create a Messenger campaign";
654
+ }, {
655
+ readonly route: "PUT /api/v1/messenger/campaigns/:id";
656
+ readonly scope: "campaigns:write";
657
+ readonly summary: "Update a Messenger campaign";
658
+ }, {
659
+ readonly route: "DELETE /api/v1/messenger/campaigns/:id";
660
+ readonly scope: "campaigns:write";
661
+ readonly summary: "Delete a Messenger campaign";
662
+ }, {
663
+ readonly route: "POST /api/v1/messenger/campaigns/:id/recipients";
664
+ readonly scope: "campaigns:write";
665
+ readonly summary: "Add campaign recipients";
666
+ }, {
667
+ readonly route: "POST /api/v1/messenger/campaigns/:id/run";
668
+ readonly scope: "campaigns:write";
669
+ readonly summary: "Start a Messenger campaign";
670
+ }, {
671
+ readonly route: "POST /api/v1/messenger/campaigns/:id/pause";
672
+ readonly scope: "campaigns:write";
673
+ readonly summary: "Pause a Messenger campaign";
674
+ }, {
675
+ readonly route: "POST /api/v1/messenger/campaigns/:id/resume";
676
+ readonly scope: "campaigns:write";
677
+ readonly summary: "Resume a Messenger campaign";
678
+ }, {
679
+ readonly route: "POST /api/v1/messenger/campaigns/:id/cancel";
680
+ readonly scope: "campaigns:write";
681
+ readonly summary: "Cancel a Messenger campaign";
682
+ }, {
683
+ readonly route: "POST /api/v1/messenger/campaigns/:id/duplicate";
684
+ readonly scope: "campaigns:write";
685
+ readonly summary: "Duplicate a Messenger campaign";
686
+ }, {
687
+ readonly route: "GET /api/v1/messenger/comment-automations";
688
+ readonly scope: "automations:read";
689
+ readonly summary: "List comment-to-DM automations";
690
+ }, {
691
+ readonly route: "GET /api/v1/messenger/comment-automations/:id";
692
+ readonly scope: "automations:read";
693
+ readonly summary: "Get a comment-to-DM automation";
694
+ }, {
695
+ readonly route: "GET /api/v1/messenger/comment-automations/posts";
696
+ readonly scope: "channels:read";
697
+ readonly summary: "List your Facebook Page posts";
698
+ }, {
699
+ readonly route: "GET /api/v1/messenger/comment-automations/posts/:mediaId/comments";
700
+ readonly scope: "channels:read";
701
+ readonly summary: "List comments on a Page post";
702
+ }, {
703
+ readonly route: "POST /api/v1/messenger/comment-automations";
704
+ readonly scope: "automations:write";
705
+ readonly summary: "Auto-reply to comments on a Page post (public reply and/or DM)";
706
+ }, {
707
+ readonly route: "PUT /api/v1/messenger/comment-automations/:id";
708
+ readonly scope: "automations:write";
709
+ readonly summary: "Update a comment-to-DM automation";
710
+ }, {
711
+ readonly route: "PATCH /api/v1/messenger/comment-automations/:id/toggle";
712
+ readonly scope: "automations:write";
713
+ readonly summary: "Turn a comment-to-DM automation on or off";
714
+ }, {
715
+ readonly route: "DELETE /api/v1/messenger/comment-automations/:id";
716
+ readonly scope: "automations:write";
717
+ readonly summary: "Delete a comment-to-DM automation";
718
+ }, {
719
+ readonly route: "GET /api/v1/messenger/profile";
720
+ readonly scope: "channels:read";
721
+ readonly summary: "Messenger profile (greeting, menu, ice breakers)";
722
+ }, {
723
+ readonly route: "GET /api/v1/messenger/profile/get-started";
724
+ readonly scope: "channels:read";
725
+ readonly summary: "Get Started button";
726
+ }, {
727
+ readonly route: "POST /api/v1/messenger/profile/get-started";
728
+ readonly scope: "channels:write";
729
+ readonly summary: "Set the Get Started button";
730
+ }, {
731
+ readonly route: "DELETE /api/v1/messenger/profile/get-started";
732
+ readonly scope: "channels:write";
733
+ readonly summary: "Remove the Get Started button";
734
+ }, {
735
+ readonly route: "GET /api/v1/messenger/profile/greeting";
736
+ readonly scope: "channels:read";
737
+ readonly summary: "Greeting text";
738
+ }, {
739
+ readonly route: "POST /api/v1/messenger/profile/greeting";
740
+ readonly scope: "channels:write";
741
+ readonly summary: "Set the greeting text";
742
+ }, {
743
+ readonly route: "DELETE /api/v1/messenger/profile/greeting";
744
+ readonly scope: "channels:write";
745
+ readonly summary: "Remove the greeting text";
746
+ }, {
747
+ readonly route: "GET /api/v1/messenger/profile/ice-breakers";
748
+ readonly scope: "channels:read";
749
+ readonly summary: "Ice breakers";
750
+ }, {
751
+ readonly route: "POST /api/v1/messenger/profile/ice-breakers";
752
+ readonly scope: "channels:write";
753
+ readonly summary: "Set ice breakers";
754
+ }, {
755
+ readonly route: "DELETE /api/v1/messenger/profile/ice-breakers";
756
+ readonly scope: "channels:write";
757
+ readonly summary: "Remove ice breakers";
758
+ }, {
759
+ readonly route: "GET /api/v1/messenger/profile/persistent-menu";
760
+ readonly scope: "channels:read";
761
+ readonly summary: "Persistent menu";
762
+ }, {
763
+ readonly route: "POST /api/v1/messenger/profile/persistent-menu";
764
+ readonly scope: "channels:write";
765
+ readonly summary: "Set the persistent menu";
766
+ }, {
767
+ readonly route: "DELETE /api/v1/messenger/profile/persistent-menu";
768
+ readonly scope: "channels:write";
769
+ readonly summary: "Remove the persistent menu";
770
+ }, {
771
+ readonly route: "GET /api/v1/messenger/stats";
772
+ readonly scope: "analytics:read";
773
+ readonly summary: "Messenger message totals";
774
+ }, {
775
+ readonly route: "GET /api/v1/messenger/analytics/summary";
776
+ readonly scope: "analytics:read";
777
+ readonly summary: "Messenger analytics summary";
778
+ }, {
779
+ readonly route: "GET /api/v1/messenger/top-performers";
780
+ readonly scope: "analytics:read";
781
+ readonly summary: "Top Messenger templates and replies";
782
+ }, {
783
+ readonly route: "GET /api/v1/messenger/volume-timeline";
784
+ readonly scope: "analytics:read";
785
+ readonly summary: "Messenger message volume over time";
786
+ }, {
787
+ readonly route: "GET /api/v1/messenger/rate-limit";
788
+ readonly scope: "channels:read";
789
+ readonly summary: "Remaining Messenger send quota";
790
+ }, {
791
+ readonly route: "POST /api/v1/telegram/send";
792
+ readonly scope: "messages:send";
793
+ readonly summary: "Send a Telegram message";
794
+ }, {
795
+ readonly route: "POST /api/v1/telegram/send/inline-keyboard";
796
+ readonly scope: "messages:send";
797
+ readonly summary: "Send a message with inline buttons";
798
+ }, {
799
+ readonly route: "POST /api/v1/telegram/send/reply-keyboard";
800
+ readonly scope: "messages:send";
801
+ readonly summary: "Send a message with a reply keyboard";
802
+ }, {
803
+ readonly route: "POST /api/v1/telegram/send/remove-keyboard";
804
+ readonly scope: "messages:send";
805
+ readonly summary: "Remove the reply keyboard";
806
+ }, {
807
+ readonly route: "POST /api/v1/telegram/send/media-group";
808
+ readonly scope: "messages:send";
809
+ readonly summary: "Send an album";
810
+ }, {
811
+ readonly route: "POST /api/v1/telegram/send/animation";
812
+ readonly scope: "messages:send";
813
+ readonly summary: "Send a GIF / animation";
814
+ }, {
815
+ readonly route: "POST /api/v1/telegram/send/sticker";
816
+ readonly scope: "messages:send";
817
+ readonly summary: "Send a sticker";
818
+ }, {
819
+ readonly route: "POST /api/v1/telegram/send/video-note";
820
+ readonly scope: "messages:send";
821
+ readonly summary: "Send a round video note";
822
+ }, {
823
+ readonly route: "POST /api/v1/telegram/send/location";
824
+ readonly scope: "messages:send";
825
+ readonly summary: "Send a location";
826
+ }, {
827
+ readonly route: "POST /api/v1/telegram/send/venue";
828
+ readonly scope: "messages:send";
829
+ readonly summary: "Send a venue";
830
+ }, {
831
+ readonly route: "POST /api/v1/telegram/send/contact";
832
+ readonly scope: "messages:send";
833
+ readonly summary: "Send a contact";
834
+ }, {
835
+ readonly route: "POST /api/v1/telegram/send/poll";
836
+ readonly scope: "messages:send";
837
+ readonly summary: "Send a poll";
838
+ }, {
839
+ readonly route: "POST /api/v1/telegram/send/dice";
840
+ readonly scope: "messages:send";
841
+ readonly summary: "Send an animated dice";
842
+ }, {
843
+ readonly route: "POST /api/v1/telegram/send/invoice";
844
+ readonly scope: "messages:send";
845
+ readonly summary: "Send an invoice";
846
+ }, {
847
+ readonly route: "POST /api/v1/telegram/create-invoice-link";
848
+ readonly scope: "messages:send";
849
+ readonly summary: "Create a payment link";
850
+ }, {
851
+ readonly route: "POST /api/v1/telegram/copy";
852
+ readonly scope: "messages:send";
853
+ readonly summary: "Copy a message to another chat";
854
+ }, {
855
+ readonly route: "POST /api/v1/telegram/forward";
856
+ readonly scope: "messages:send";
857
+ readonly summary: "Forward a message";
858
+ }, {
859
+ readonly route: "PUT /api/v1/telegram/message";
860
+ readonly scope: "messages:send";
861
+ readonly summary: "Edit a sent message";
862
+ }, {
863
+ readonly route: "DELETE /api/v1/telegram/message";
864
+ readonly scope: "messages:send";
865
+ readonly summary: "Delete a message";
866
+ }, {
867
+ readonly route: "POST /api/v1/telegram/message/pin";
868
+ readonly scope: "messages:send";
869
+ readonly summary: "Pin a message";
870
+ }, {
871
+ readonly route: "POST /api/v1/telegram/message/unpin";
872
+ readonly scope: "messages:send";
873
+ readonly summary: "Unpin a message";
874
+ }, {
875
+ readonly route: "POST /api/v1/telegram/templates/:id/use";
876
+ readonly scope: "messages:send";
877
+ readonly summary: "Record a Telegram template use";
878
+ }, {
879
+ readonly route: "GET /api/v1/telegram/chat/:chatId";
880
+ readonly scope: "conversations:read";
881
+ readonly summary: "Get chat info";
882
+ }, {
883
+ readonly route: "GET /api/v1/telegram/chat/:chatId/member-count";
884
+ readonly scope: "conversations:read";
885
+ readonly summary: "Get group member count";
886
+ }, {
887
+ readonly route: "POST /api/v1/telegram/chat/invite-link";
888
+ readonly scope: "channels:write";
889
+ readonly summary: "Create a group invite link";
890
+ }, {
891
+ readonly route: "POST /api/v1/telegram/chat/ban";
892
+ readonly scope: "channels:write";
893
+ readonly summary: "Ban a user from a group";
894
+ }, {
895
+ readonly route: "POST /api/v1/telegram/chat/unban";
896
+ readonly scope: "channels:write";
897
+ readonly summary: "Unban a user";
898
+ }, {
899
+ readonly route: "GET /api/v1/telegram/templates";
900
+ readonly scope: "templates:read";
901
+ readonly summary: "List Telegram templates";
902
+ }, {
903
+ readonly route: "GET /api/v1/telegram/templates/:id";
904
+ readonly scope: "templates:read";
905
+ readonly summary: "Get a Telegram template";
906
+ }, {
907
+ readonly route: "POST /api/v1/telegram/templates";
908
+ readonly scope: "templates:write";
909
+ readonly summary: "Save a Telegram template";
910
+ }, {
911
+ readonly route: "PUT /api/v1/telegram/templates/:id";
912
+ readonly scope: "templates:write";
913
+ readonly summary: "Update a Telegram template";
914
+ }, {
915
+ readonly route: "DELETE /api/v1/telegram/templates/:id";
916
+ readonly scope: "templates:write";
917
+ readonly summary: "Delete a Telegram template";
918
+ }, {
919
+ readonly route: "POST /api/v1/telegram/templates/:id/duplicate";
920
+ readonly scope: "templates:write";
921
+ readonly summary: "Duplicate a Telegram template";
922
+ }, {
923
+ readonly route: "GET /api/v1/telegram/campaigns";
924
+ readonly scope: "campaigns:read";
925
+ readonly summary: "List Telegram campaigns";
926
+ }, {
927
+ readonly route: "GET /api/v1/telegram/campaigns/:id";
928
+ readonly scope: "campaigns:read";
929
+ readonly summary: "Get a Telegram campaign";
930
+ }, {
931
+ readonly route: "POST /api/v1/telegram/campaigns";
932
+ readonly scope: "campaigns:write";
933
+ readonly summary: "Create a Telegram campaign";
934
+ }, {
935
+ readonly route: "DELETE /api/v1/telegram/campaigns/:id";
936
+ readonly scope: "campaigns:write";
937
+ readonly summary: "Delete a Telegram campaign";
938
+ }, {
939
+ readonly route: "POST /api/v1/telegram/campaigns/:id/send";
940
+ readonly scope: "campaigns:write";
941
+ readonly summary: "Start a Telegram campaign";
942
+ }, {
943
+ readonly route: "POST /api/v1/telegram/campaigns/:id/pause";
944
+ readonly scope: "campaigns:write";
945
+ readonly summary: "Pause a Telegram campaign";
946
+ }, {
947
+ readonly route: "POST /api/v1/telegram/campaigns/:id/resume";
948
+ readonly scope: "campaigns:write";
949
+ readonly summary: "Resume a Telegram campaign";
950
+ }, {
951
+ readonly route: "POST /api/v1/telegram/campaigns/:id/cancel";
952
+ readonly scope: "campaigns:write";
953
+ readonly summary: "Cancel a Telegram campaign";
954
+ }, {
955
+ readonly route: "GET /api/v1/telegram/commands";
956
+ readonly scope: "channels:read";
957
+ readonly summary: "List bot commands";
958
+ }, {
959
+ readonly route: "POST /api/v1/telegram/commands";
960
+ readonly scope: "channels:write";
961
+ readonly summary: "Set bot commands";
962
+ }, {
963
+ readonly route: "DELETE /api/v1/telegram/commands";
964
+ readonly scope: "channels:write";
965
+ readonly summary: "Remove bot commands";
966
+ }, {
967
+ readonly route: "GET /api/v1/telegram/bot/profile";
968
+ readonly scope: "channels:read";
969
+ readonly summary: "Bot name, description and about text";
970
+ }, {
971
+ readonly route: "PUT /api/v1/telegram/bot/profile";
972
+ readonly scope: "channels:write";
973
+ readonly summary: "Change the bot name, description and about text";
974
+ }, {
975
+ readonly route: "GET /api/v1/telegram/stats";
976
+ readonly scope: "analytics:read";
977
+ readonly summary: "Telegram message totals";
978
+ }, {
979
+ readonly route: "GET /api/v1/telegram/top-performers";
980
+ readonly scope: "analytics:read";
981
+ readonly summary: "Top Telegram templates";
982
+ }, {
983
+ readonly route: "GET /api/v1/telegram/volume-timeline";
984
+ readonly scope: "analytics:read";
985
+ readonly summary: "Telegram message volume over time";
986
+ }, {
987
+ readonly route: "GET /api/v1/automations-v2";
988
+ readonly scope: "automations:read";
989
+ readonly summary: "List workflows";
990
+ }, {
991
+ readonly route: "GET /api/v1/automations-v2/:workflowId";
992
+ readonly scope: "automations:read";
993
+ readonly summary: "Get a workflow";
994
+ }, {
995
+ readonly route: "GET /api/v1/automations-v2/:workflowId/activation-preview";
996
+ readonly scope: "automations:read";
997
+ readonly summary: "Preview the exact published workflow before activation";
998
+ }, {
999
+ readonly route: "POST /api/v1/automations-v2/:workflowId/activate";
1000
+ readonly scope: "automations:write";
1001
+ readonly summary: "Activate the exact approved workflow snapshot";
1002
+ }, {
1003
+ readonly route: "GET /api/v1/automations-v2/:workflowId/graph";
1004
+ readonly scope: "automations:read";
1005
+ readonly summary: "Get a workflow with its nodes and edges";
1006
+ }, {
1007
+ readonly route: "GET /api/v1/automations-v2/:workflowId/export";
1008
+ readonly scope: "automations:read";
1009
+ readonly summary: "Export a workflow as a portable document";
1010
+ }, {
1011
+ readonly route: "GET /api/v1/automations-v2/:workflowId/runs";
1012
+ readonly scope: "automations:read";
1013
+ readonly summary: "List runs (execution history)";
1014
+ }, {
1015
+ readonly route: "GET /api/v1/automations-v2/:workflowId/runs/:runId";
1016
+ readonly scope: "automations:read";
1017
+ readonly summary: "Get one run with its steps";
1018
+ }, {
1019
+ readonly route: "GET /api/v1/automations-v2/:workflowId/sample-events";
1020
+ readonly scope: "automations:read";
1021
+ readonly summary: "Recent real events this workflow’s trigger would receive";
1022
+ }, {
1023
+ readonly route: "GET /api/v1/automations-v2/:workflowId/stats";
1024
+ readonly scope: "analytics:read";
1025
+ readonly summary: "Run statistics for a workflow";
1026
+ }, {
1027
+ readonly route: "POST /api/v1/automations-v2";
1028
+ readonly scope: "automations:write";
1029
+ readonly summary: "Create a workflow";
1030
+ }, {
1031
+ readonly route: "POST /api/v1/automations-v2/import";
1032
+ readonly scope: "automations:write";
1033
+ readonly summary: "Import a workflow document";
1034
+ }, {
1035
+ readonly route: "POST /api/v1/automations-v2/:workflowId/publish";
1036
+ readonly scope: "automations:write";
1037
+ readonly summary: "Validate and publish a workflow graph";
1038
+ }, {
1039
+ readonly route: "PATCH /api/v1/automations-v2/:workflowId/status";
1040
+ readonly scope: "automations:write";
1041
+ readonly summary: "Turn a workflow on, pause or archive it";
1042
+ }, {
1043
+ readonly route: "POST /api/v1/automations-v2/:workflowId/test-run";
1044
+ readonly scope: "automations:write";
1045
+ readonly summary: "Dry-run a workflow on a sample event (nothing is sent)";
1046
+ }, {
1047
+ readonly route: "POST /api/v1/automations-v2/:workflowId/test-arm";
1048
+ readonly scope: "automations:write";
1049
+ readonly summary: "Capture the next real trigger event as a sample (60 seconds)";
1050
+ }, {
1051
+ readonly route: "DELETE /api/v1/automations-v2/:workflowId";
1052
+ readonly scope: "automations:write";
1053
+ readonly summary: "Delete a workflow";
1054
+ }, {
1055
+ readonly route: "GET /api/v1/web-events";
1056
+ readonly scope: "automations:read";
1057
+ readonly summary: "List web event integrations";
1058
+ }, {
1059
+ readonly route: "GET /api/v1/web-events/:id";
1060
+ readonly scope: "automations:read";
1061
+ readonly summary: "Get a web event integration";
1062
+ }, {
1063
+ readonly route: "GET /api/v1/web-events/:id/logs";
1064
+ readonly scope: "automations:read";
1065
+ readonly summary: "List received events";
1066
+ }, {
1067
+ readonly route: "GET /api/v1/web-events/:id/logs/:logId";
1068
+ readonly scope: "automations:read";
1069
+ readonly summary: "Get one received event";
1070
+ }, {
1071
+ readonly route: "GET /api/v1/web-events/:id/variables";
1072
+ readonly scope: "automations:read";
1073
+ readonly summary: "Variables this integration exposes to automations and templates";
1074
+ }, {
1075
+ readonly route: "POST /api/v1/web-events";
1076
+ readonly scope: "automations:write";
1077
+ readonly summary: "Create an integration your website posts events to";
1078
+ }, {
1079
+ readonly route: "PUT /api/v1/web-events/:id";
1080
+ readonly scope: "automations:write";
1081
+ readonly summary: "Update an integration";
1082
+ }, {
1083
+ readonly route: "DELETE /api/v1/web-events/:id";
1084
+ readonly scope: "automations:write";
1085
+ readonly summary: "Delete an integration";
1086
+ }, {
1087
+ readonly route: "PATCH /api/v1/web-events/:id/toggle";
1088
+ readonly scope: "automations:write";
1089
+ readonly summary: "Enable or disable an integration";
1090
+ }, {
1091
+ readonly route: "POST /api/v1/web-events/:id/event-types";
1092
+ readonly scope: "automations:write";
1093
+ readonly summary: "Declare an event type";
1094
+ }, {
1095
+ readonly route: "DELETE /api/v1/web-events/:id/event-types/:typeId";
1096
+ readonly scope: "automations:write";
1097
+ readonly summary: "Remove an event type";
1098
+ }, {
1099
+ readonly route: "POST /api/v1/web-events/:id/test";
1100
+ readonly scope: "automations:write";
1101
+ readonly summary: "Send a test event through the integration";
1102
+ }, {
1103
+ readonly route: "GET /api/v1/orders";
1104
+ readonly scope: "orders:read";
1105
+ readonly summary: "List orders";
1106
+ }, {
1107
+ readonly route: "GET /api/v1/orders/stats";
1108
+ readonly scope: "orders:read";
1109
+ readonly summary: "Order statistics";
1110
+ }, {
1111
+ readonly route: "GET /api/v1/orders/:id";
1112
+ readonly scope: "orders:read";
1113
+ readonly summary: "Get an order";
1114
+ }, {
1115
+ readonly route: "GET /api/v1/orders/:id/messages";
1116
+ readonly scope: "orders:read";
1117
+ readonly summary: "Messages linked to an order";
1118
+ }, {
1119
+ readonly route: "GET /api/v1/orders/:id/confirmation-thread";
1120
+ readonly scope: "orders:read";
1121
+ readonly summary: "The WhatsApp confirmation exchange for an order";
1122
+ }, {
1123
+ readonly route: "PATCH /api/v1/orders/:id/confirmation";
1124
+ readonly scope: "orders:write";
1125
+ readonly summary: "Set the order confirmation status";
1126
+ }, {
1127
+ readonly route: "POST /api/v1/orders/:id/messages";
1128
+ readonly scope: "orders:write";
1129
+ readonly summary: "Link a message to an order";
1130
+ }, {
1131
+ readonly route: "POST /api/v1/orders/:id/push-to-platform";
1132
+ readonly scope: "orders:write";
1133
+ readonly summary: "Push an Inboxy-created order to the connected store (Shopify, Salla, WooCommerce)";
1134
+ }, {
1135
+ readonly route: "DELETE /api/v1/orders/:id";
1136
+ readonly scope: "orders:write";
1137
+ readonly summary: "Delete an order";
1138
+ }, {
1139
+ readonly route: "GET /api/v1/products";
1140
+ readonly scope: "products:read";
1141
+ readonly summary: "List products";
1142
+ }, {
1143
+ readonly route: "GET /api/v1/products/stats";
1144
+ readonly scope: "products:read";
1145
+ readonly summary: "Product statistics";
1146
+ }, {
1147
+ readonly route: "GET /api/v1/products/:id";
1148
+ readonly scope: "products:read";
1149
+ readonly summary: "Get a product";
1150
+ }, {
1151
+ readonly route: "PUT /api/v1/products/categories/:id";
1152
+ readonly scope: "products:write";
1153
+ readonly summary: "Update a product category";
1154
+ }, {
1155
+ readonly route: "DELETE /api/v1/products/categories/:id";
1156
+ readonly scope: "products:write";
1157
+ readonly summary: "Delete a product category";
1158
+ }, {
1159
+ readonly route: "POST /api/v1/products/merge";
1160
+ readonly scope: "products:write";
1161
+ readonly summary: "Merge a duplicate product into another";
1162
+ }, {
1163
+ readonly route: "POST /api/v1/products/import-from-url/save";
1164
+ readonly scope: "products:write";
1165
+ readonly summary: "Save extracted products";
1166
+ }, {
1167
+ readonly route: "GET /api/v1/services";
1168
+ readonly scope: "products:read";
1169
+ readonly summary: "List services";
1170
+ }, {
1171
+ readonly route: "GET /api/v1/services/stats";
1172
+ readonly scope: "products:read";
1173
+ readonly summary: "Service statistics";
1174
+ }, {
1175
+ readonly route: "GET /api/v1/services/categories";
1176
+ readonly scope: "products:read";
1177
+ readonly summary: "List service categories";
1178
+ }, {
1179
+ readonly route: "GET /api/v1/services/:id";
1180
+ readonly scope: "products:read";
1181
+ readonly summary: "Get a service";
1182
+ }, {
1183
+ readonly route: "POST /api/v1/services";
1184
+ readonly scope: "products:write";
1185
+ readonly summary: "Create a service";
1186
+ }, {
1187
+ readonly route: "PUT /api/v1/services/:id";
1188
+ readonly scope: "products:write";
1189
+ readonly summary: "Update a service";
1190
+ }, {
1191
+ readonly route: "DELETE /api/v1/services/:id";
1192
+ readonly scope: "products:write";
1193
+ readonly summary: "Delete a service";
1194
+ }, {
1195
+ readonly route: "POST /api/v1/services/categories";
1196
+ readonly scope: "products:write";
1197
+ readonly summary: "Create a service category";
1198
+ }, {
1199
+ readonly route: "PUT /api/v1/services/categories/:id";
1200
+ readonly scope: "products:write";
1201
+ readonly summary: "Update a service category";
1202
+ }, {
1203
+ readonly route: "DELETE /api/v1/services/categories/:id";
1204
+ readonly scope: "products:write";
1205
+ readonly summary: "Delete a service category";
1206
+ }, {
1207
+ readonly route: "GET /api/v1/catalog-cards";
1208
+ readonly scope: "products:read";
1209
+ readonly summary: "List catalog cards (products and services ready to send)";
1210
+ }, {
1211
+ readonly route: "GET /api/v1/catalog-cards/status";
1212
+ readonly scope: "products:read";
1213
+ readonly summary: "Store sync state and card readiness";
1214
+ }, {
1215
+ readonly route: "GET /api/v1/catalog-cards/:itemType/:itemId";
1216
+ readonly scope: "products:read";
1217
+ readonly summary: "Preview one catalog card";
1218
+ }, {
1219
+ readonly route: "POST /api/v1/catalog-cards/sync";
1220
+ readonly scope: "products:write";
1221
+ readonly summary: "Sync the catalog from a connected store";
1222
+ }, {
1223
+ readonly route: "POST /api/v1/catalog-cards/send/whatsapp";
1224
+ readonly scope: "messages:send";
1225
+ readonly summary: "Send a catalog card on WhatsApp";
1226
+ }, {
1227
+ readonly route: "POST /api/v1/catalog-cards/send/instagram";
1228
+ readonly scope: "messages:send";
1229
+ readonly summary: "Send a catalog card on Instagram";
1230
+ }, {
1231
+ readonly route: "POST /api/v1/catalog-cards/send/messenger";
1232
+ readonly scope: "messages:send";
1233
+ readonly summary: "Send a catalog card on Messenger";
1234
+ }, {
1235
+ readonly route: "POST /api/v1/catalog-cards/send/telegram";
1236
+ readonly scope: "messages:send";
1237
+ readonly summary: "Send a catalog card on Telegram";
1238
+ }, {
1239
+ readonly route: "POST /api/v1/catalog-cards/send/web";
1240
+ readonly scope: "messages:send";
1241
+ readonly summary: "Send a catalog card in the website chat";
1242
+ }, {
1243
+ readonly route: "GET /api/v1/ecommerce/overview";
1244
+ readonly scope: "ecommerce:read";
1245
+ readonly summary: "Store KPIs: orders, revenue, store connectivity";
1246
+ }, {
1247
+ readonly route: "GET /api/v1/ecommerce/customers";
1248
+ readonly scope: "ecommerce:read";
1249
+ readonly summary: "List store customers across platforms";
1250
+ }, {
1251
+ readonly route: "GET /api/v1/ecommerce/customers/:id";
1252
+ readonly scope: "ecommerce:read";
1253
+ readonly summary: "Get a store customer with orders";
1254
+ }, {
1255
+ readonly route: "GET /api/v1/shopify/config";
1256
+ readonly scope: "channels:read";
1257
+ readonly summary: "Shopify connection status (no secrets)";
1258
+ }, {
1259
+ readonly route: "POST /api/v1/shopify/sync";
1260
+ readonly scope: "channels:write";
1261
+ readonly summary: "Sync everything from Shopify";
1262
+ }, {
1263
+ readonly route: "POST /api/v1/shopify/sync/customers";
1264
+ readonly scope: "channels:write";
1265
+ readonly summary: "Sync Shopify customers";
1266
+ }, {
1267
+ readonly route: "POST /api/v1/shopify/sync/orders";
1268
+ readonly scope: "channels:write";
1269
+ readonly summary: "Sync Shopify orders";
1270
+ }, {
1271
+ readonly route: "POST /api/v1/shopify/sync/products";
1272
+ readonly scope: "channels:write";
1273
+ readonly summary: "Sync Shopify products";
1274
+ }, {
1275
+ readonly route: "GET /api/v1/salla/config";
1276
+ readonly scope: "channels:read";
1277
+ readonly summary: "Salla connection status (no secrets)";
1278
+ }, {
1279
+ readonly route: "POST /api/v1/salla/sync";
1280
+ readonly scope: "channels:write";
1281
+ readonly summary: "Sync from Salla";
1282
+ }, {
1283
+ readonly route: "GET /api/v1/zid/config";
1284
+ readonly scope: "channels:read";
1285
+ readonly summary: "Zid connection status (no secrets)";
1286
+ }, {
1287
+ readonly route: "POST /api/v1/zid/sync";
1288
+ readonly scope: "channels:write";
1289
+ readonly summary: "Sync orders from Zid";
1290
+ }, {
1291
+ readonly route: "GET /api/v1/easy-orders/config";
1292
+ readonly scope: "channels:read";
1293
+ readonly summary: "EasyOrders connection status (no secrets)";
1294
+ }, {
1295
+ readonly route: "POST /api/v1/easy-orders/sync";
1296
+ readonly scope: "channels:write";
1297
+ readonly summary: "Sync from EasyOrders";
1298
+ }, {
1299
+ readonly route: "POST /api/v1/woocommerce/sync";
1300
+ readonly scope: "channels:write";
1301
+ readonly summary: "Sync from WooCommerce (?full=true for a full reconcile)";
1302
+ }, {
1303
+ readonly route: "POST /api/v1/woocommerce/sync/customers";
1304
+ readonly scope: "channels:write";
1305
+ readonly summary: "Sync WooCommerce customers";
1306
+ }, {
1307
+ readonly route: "POST /api/v1/woocommerce/sync/orders";
1308
+ readonly scope: "channels:write";
1309
+ readonly summary: "Sync WooCommerce orders";
1310
+ }, {
1311
+ readonly route: "POST /api/v1/woocommerce/sync/products";
1312
+ readonly scope: "channels:write";
1313
+ readonly summary: "Sync WooCommerce products";
1314
+ }, {
1315
+ readonly route: "GET /api/v1/woocommerce/abandoned-carts";
1316
+ readonly scope: "ecommerce:read";
1317
+ readonly summary: "WooCommerce abandoned carts";
1318
+ }, {
1319
+ readonly route: "GET /api/v1/woocommerce/abandoned-carts/stats";
1320
+ readonly scope: "ecommerce:read";
1321
+ readonly summary: "WooCommerce cart recovery stats";
1322
+ }, {
1323
+ readonly route: "PATCH /api/v1/woocommerce/abandoned-carts/:id/recover";
1324
+ readonly scope: "ecommerce:write";
1325
+ readonly summary: "Mark a WooCommerce cart recovered";
1326
+ }, {
1327
+ readonly route: "GET /api/v1/salla/abandoned-carts";
1328
+ readonly scope: "ecommerce:read";
1329
+ readonly summary: "Salla abandoned carts";
1330
+ }, {
1331
+ readonly route: "GET /api/v1/salla/abandoned-carts/stats";
1332
+ readonly scope: "ecommerce:read";
1333
+ readonly summary: "Salla cart recovery stats";
1334
+ }, {
1335
+ readonly route: "PATCH /api/v1/salla/abandoned-carts/:id/recover";
1336
+ readonly scope: "ecommerce:write";
1337
+ readonly summary: "Mark a Salla cart recovered";
1338
+ }, {
1339
+ readonly route: "GET /api/v1/zid/abandoned-carts";
1340
+ readonly scope: "ecommerce:read";
1341
+ readonly summary: "Zid abandoned carts";
1342
+ }, {
1343
+ readonly route: "GET /api/v1/whatsapp/stats";
1344
+ readonly scope: "analytics:read";
1345
+ readonly summary: "WhatsApp message and conversation totals";
1346
+ }, {
1347
+ readonly route: "GET /api/v1/whatsapp/analytics/summary";
1348
+ readonly scope: "analytics:read";
1349
+ readonly summary: "WhatsApp analytics summary";
1350
+ }, {
1351
+ readonly route: "GET /api/v1/whatsapp/analytics/messages";
1352
+ readonly scope: "analytics:read";
1353
+ readonly summary: "Message volume";
1354
+ }, {
1355
+ readonly route: "GET /api/v1/whatsapp/analytics/messages/trends";
1356
+ readonly scope: "analytics:read";
1357
+ readonly summary: "Message trends";
1358
+ }, {
1359
+ readonly route: "GET /api/v1/whatsapp/analytics/response-times";
1360
+ readonly scope: "analytics:read";
1361
+ readonly summary: "Response times";
1362
+ }, {
1363
+ readonly route: "GET /api/v1/whatsapp/analytics/templates";
1364
+ readonly scope: "analytics:read";
1365
+ readonly summary: "Template performance";
1366
+ }, {
1367
+ readonly route: "GET /api/v1/whatsapp/analytics/conversations";
1368
+ readonly scope: "analytics:read";
1369
+ readonly summary: "Conversation metrics";
1370
+ }, {
1371
+ readonly route: "GET /api/v1/whatsapp/analytics/agents";
1372
+ readonly scope: "analytics:read";
1373
+ readonly summary: "Agent performance";
1374
+ }, {
1375
+ readonly route: "GET /api/v1/whatsapp/analytics/channels";
1376
+ readonly scope: "analytics:read";
1377
+ readonly summary: "Channel breakdown";
1378
+ }, {
1379
+ readonly route: "GET /api/v1/inbox/conversations";
1380
+ readonly scope: "conversations:read";
1381
+ readonly summary: "List inbox conversations";
1382
+ }, {
1383
+ readonly route: "GET /api/v1/inbox/conversations/:conversationId";
1384
+ readonly scope: "conversations:read";
1385
+ readonly summary: "Get a conversation";
1386
+ }, {
1387
+ readonly route: "GET /api/v1/inbox/conversations/:conversationId/messages";
1388
+ readonly scope: "messages:read";
1389
+ readonly summary: "List messages in a conversation";
1390
+ }, {
1391
+ readonly route: "GET /api/v1/inbox/conversations/:conversationId/window";
1392
+ readonly scope: "conversations:read";
1393
+ readonly summary: "Check the 24-hour messaging window";
1394
+ }, {
1395
+ readonly route: "PATCH /api/v1/inbox/conversations/:conversationId/status";
1396
+ readonly scope: "conversations:write";
1397
+ readonly summary: "Change conversation status";
1398
+ }, {
1399
+ readonly route: "PATCH /api/v1/inbox/conversations/:conversationId/assign";
1400
+ readonly scope: "conversations:write";
1401
+ readonly summary: "Assign a conversation to an agent";
1402
+ }, {
1403
+ readonly route: "PATCH /api/v1/inbox/conversations/:conversationId/labels";
1404
+ readonly scope: "conversations:write";
1405
+ readonly summary: "Set conversation labels";
1406
+ }, {
1407
+ readonly route: "GET /api/v1/inbox/conversations/:conversationId/notes/list";
1408
+ readonly scope: "conversations:read";
1409
+ readonly summary: "List internal notes";
1410
+ }, {
1411
+ readonly route: "POST /api/v1/inbox/conversations/:conversationId/notes/list";
1412
+ readonly scope: "conversations:write";
1413
+ readonly summary: "Add an internal note";
1414
+ }, {
1415
+ readonly route: "GET /api/v1/contacts";
1416
+ readonly scope: "contacts:read";
1417
+ readonly summary: "List contacts";
1418
+ }, {
1419
+ readonly route: "GET /api/v1/contacts/search";
1420
+ readonly scope: "contacts:read";
1421
+ readonly summary: "Search contacts";
1422
+ }, {
1423
+ readonly route: "GET /api/v1/contacts/custom-field-keys";
1424
+ readonly scope: "contacts:read";
1425
+ readonly summary: "List custom field keys";
1426
+ }, {
1427
+ readonly route: "GET /api/v1/contacts/:id";
1428
+ readonly scope: "contacts:read";
1429
+ readonly summary: "Get a contact";
1430
+ }, {
1431
+ readonly route: "GET /api/v1/contacts/:id/timeline";
1432
+ readonly scope: "contacts:read";
1433
+ readonly summary: "Get a contact timeline";
1434
+ }, {
1435
+ readonly route: "GET /api/v1/contacts/tags/all";
1436
+ readonly scope: "contacts:read";
1437
+ readonly summary: "List tags";
1438
+ }, {
1439
+ readonly route: "POST /api/v1/contacts";
1440
+ readonly scope: "contacts:write";
1441
+ readonly summary: "Create a contact";
1442
+ }, {
1443
+ readonly route: "POST /api/v1/contacts/find-or-create";
1444
+ readonly scope: "contacts:write";
1445
+ readonly summary: "Find a contact or create it";
1446
+ }, {
1447
+ readonly route: "PUT /api/v1/contacts/:id";
1448
+ readonly scope: "contacts:write";
1449
+ readonly summary: "Update a contact";
1450
+ }, {
1451
+ readonly route: "DELETE /api/v1/contacts/:id";
1452
+ readonly scope: "contacts:write";
1453
+ readonly summary: "Delete a contact";
1454
+ }, {
1455
+ readonly route: "POST /api/v1/contacts/:id/tags/:tagId";
1456
+ readonly scope: "contacts:write";
1457
+ readonly summary: "Add a tag to a contact";
1458
+ }, {
1459
+ readonly route: "DELETE /api/v1/contacts/:id/tags/:tagId";
1460
+ readonly scope: "contacts:write";
1461
+ readonly summary: "Remove a tag from a contact";
1462
+ }, {
1463
+ readonly route: "POST /api/v1/contacts/tags";
1464
+ readonly scope: "contacts:write";
1465
+ readonly summary: "Create a tag";
1466
+ }, {
1467
+ readonly route: "PUT /api/v1/contacts/tags/:tagId";
1468
+ readonly scope: "contacts:write";
1469
+ readonly summary: "Update a tag";
1470
+ }, {
1471
+ readonly route: "DELETE /api/v1/contacts/tags/:tagId";
1472
+ readonly scope: "contacts:write";
1473
+ readonly summary: "Delete a tag";
1474
+ }, {
1475
+ readonly route: "PATCH /api/v1/contacts/:id/status";
1476
+ readonly scope: "contacts:write";
1477
+ readonly summary: "Set contact status";
1478
+ }, {
1479
+ readonly route: "PATCH /api/v1/contacts/:id/stage";
1480
+ readonly scope: "contacts:write";
1481
+ readonly summary: "Set contact lifecycle stage";
1482
+ }, {
1483
+ readonly route: "PATCH /api/v1/contacts/:id/assign";
1484
+ readonly scope: "contacts:write";
1485
+ readonly summary: "Assign a contact to an agent";
1486
+ }, {
1487
+ readonly route: "POST /api/v1/contacts/:id/note";
1488
+ readonly scope: "contacts:write";
1489
+ readonly summary: "Add a note to a contact";
1490
+ }, {
1491
+ readonly route: "POST /api/v1/contacts/bulk/tags";
1492
+ readonly scope: "contacts:write";
1493
+ readonly summary: "Tag many contacts";
1494
+ }, {
1495
+ readonly route: "GET /api/v1/tasks";
1496
+ readonly scope: "tasks:read";
1497
+ readonly summary: "List tasks";
1498
+ }, {
1499
+ readonly route: "GET /api/v1/tasks/stats";
1500
+ readonly scope: "tasks:read";
1501
+ readonly summary: "Get task stats";
1502
+ }, {
1503
+ readonly route: "GET /api/v1/tasks/my";
1504
+ readonly scope: "tasks:read";
1505
+ readonly summary: "List tasks assigned to the token owner";
1506
+ }, {
1507
+ readonly route: "GET /api/v1/tasks/contact/:contactId";
1508
+ readonly scope: "tasks:read";
1509
+ readonly summary: "List tasks for a contact";
1510
+ }, {
1511
+ readonly route: "GET /api/v1/tasks/:id";
1512
+ readonly scope: "tasks:read";
1513
+ readonly summary: "Get a task";
1514
+ }, {
1515
+ readonly route: "POST /api/v1/tasks";
1516
+ readonly scope: "tasks:write";
1517
+ readonly summary: "Create a task";
1518
+ }, {
1519
+ readonly route: "PUT /api/v1/tasks/:id";
1520
+ readonly scope: "tasks:write";
1521
+ readonly summary: "Update a task";
1522
+ }, {
1523
+ readonly route: "DELETE /api/v1/tasks/:id";
1524
+ readonly scope: "tasks:write";
1525
+ readonly summary: "Delete a task";
1526
+ }, {
1527
+ readonly route: "POST /api/v1/tasks/:id/complete";
1528
+ readonly scope: "tasks:write";
1529
+ readonly summary: "Mark a task complete";
1530
+ }, {
1531
+ readonly route: "POST /api/v1/tasks/:id/assign";
1532
+ readonly scope: "tasks:write";
1533
+ readonly summary: "Assign a task";
1534
+ }, {
1535
+ readonly route: "GET /api/v1/tasks/:id/subtasks";
1536
+ readonly scope: "tasks:read";
1537
+ readonly summary: "List checklist items on a task";
1538
+ }, {
1539
+ readonly route: "POST /api/v1/tasks/:id/subtasks";
1540
+ readonly scope: "tasks:write";
1541
+ readonly summary: "Add a checklist item to a task";
1542
+ }, {
1543
+ readonly route: "PATCH /api/v1/tasks/subtasks/:subtaskId";
1544
+ readonly scope: "tasks:write";
1545
+ readonly summary: "Toggle a checklist item";
1546
+ }, {
1547
+ readonly route: "DELETE /api/v1/tasks/subtasks/:subtaskId";
1548
+ readonly scope: "tasks:write";
1549
+ readonly summary: "Delete a checklist item";
1550
+ }, {
1551
+ readonly route: "GET /api/v1/tasks/:id/comments";
1552
+ readonly scope: "tasks:read";
1553
+ readonly summary: "List task comments";
1554
+ }, {
1555
+ readonly route: "POST /api/v1/tasks/:id/comments";
1556
+ readonly scope: "tasks:write";
1557
+ readonly summary: "Add a task comment";
1558
+ }, {
1559
+ readonly route: "POST /api/v1/meetings";
1560
+ readonly scope: "meetings:write";
1561
+ readonly summary: "Create a meeting";
1562
+ }, {
1563
+ readonly route: "GET /api/v1/meetings/week";
1564
+ readonly scope: "meetings:read";
1565
+ readonly summary: "List meetings in a calendar week";
1566
+ }, {
1567
+ readonly route: "GET /api/v1/meetings/contact/:contactId";
1568
+ readonly scope: "meetings:read";
1569
+ readonly summary: "List meetings for a contact";
1570
+ }, {
1571
+ readonly route: "GET /api/v1/meetings/:id";
1572
+ readonly scope: "meetings:read";
1573
+ readonly summary: "Get a meeting";
1574
+ }, {
1575
+ readonly route: "PUT /api/v1/meetings/:id";
1576
+ readonly scope: "meetings:write";
1577
+ readonly summary: "Update a meeting";
1578
+ }, {
1579
+ readonly route: "DELETE /api/v1/meetings/:id";
1580
+ readonly scope: "meetings:write";
1581
+ readonly summary: "Delete a meeting";
1582
+ }, {
1583
+ readonly route: "POST /api/v1/meetings/:id/complete";
1584
+ readonly scope: "meetings:write";
1585
+ readonly summary: "Mark a meeting completed";
1586
+ }, {
1587
+ readonly route: "POST /api/v1/meetings/:id/cancel";
1588
+ readonly scope: "meetings:write";
1589
+ readonly summary: "Mark a meeting cancelled";
1590
+ }, {
1591
+ readonly route: "GET /api/v1/knowledge-center/categories";
1592
+ readonly scope: "knowledge:read";
1593
+ readonly summary: "List knowledge categories";
1594
+ }, {
1595
+ readonly route: "POST /api/v1/knowledge-center/categories";
1596
+ readonly scope: "knowledge:write";
1597
+ readonly summary: "Create a knowledge category";
1598
+ }, {
1599
+ readonly route: "PUT /api/v1/knowledge-center/categories/:id";
1600
+ readonly scope: "knowledge:write";
1601
+ readonly summary: "Update a knowledge category";
1602
+ }, {
1603
+ readonly route: "DELETE /api/v1/knowledge-center/categories/:id";
1604
+ readonly scope: "knowledge:write";
1605
+ readonly summary: "Delete a knowledge category";
1606
+ }, {
1607
+ readonly route: "PUT /api/v1/knowledge-center/categories/reorder";
1608
+ readonly scope: "knowledge:write";
1609
+ readonly summary: "Reorder knowledge categories";
1610
+ }, {
1611
+ readonly route: "GET /api/v1/knowledge-center/articles";
1612
+ readonly scope: "knowledge:read";
1613
+ readonly summary: "List knowledge articles";
1614
+ }, {
1615
+ readonly route: "POST /api/v1/knowledge-center/articles";
1616
+ readonly scope: "knowledge:write";
1617
+ readonly summary: "Create a knowledge article";
1618
+ }, {
1619
+ readonly route: "GET /api/v1/knowledge-center/articles/:id";
1620
+ readonly scope: "knowledge:read";
1621
+ readonly summary: "Get a knowledge article";
1622
+ }, {
1623
+ readonly route: "PUT /api/v1/knowledge-center/articles/:id";
1624
+ readonly scope: "knowledge:write";
1625
+ readonly summary: "Update a knowledge article";
1626
+ }, {
1627
+ readonly route: "DELETE /api/v1/knowledge-center/articles/:id";
1628
+ readonly scope: "knowledge:write";
1629
+ readonly summary: "Delete a knowledge article";
1630
+ }, {
1631
+ readonly route: "POST /api/v1/knowledge-center/articles/:id/publish";
1632
+ readonly scope: "knowledge:write";
1633
+ readonly summary: "Publish a knowledge article";
1634
+ }, {
1635
+ readonly route: "POST /api/v1/knowledge-center/articles/:id/archive";
1636
+ readonly scope: "knowledge:write";
1637
+ readonly summary: "Archive a knowledge article";
1638
+ }, {
1639
+ readonly route: "GET /api/v1/knowledge-center/search";
1640
+ readonly scope: "knowledge:read";
1641
+ readonly summary: "Search knowledge articles";
1642
+ }, {
1643
+ readonly route: "GET /api/v1/knowledge-center/quick-search";
1644
+ readonly scope: "knowledge:read";
1645
+ readonly summary: "Quick-search knowledge articles";
1646
+ }, {
1647
+ readonly route: "POST /api/v1/knowledge-center/articles/:id/feedback";
1648
+ readonly scope: "knowledge:write";
1649
+ readonly summary: "Submit article feedback";
1650
+ }, {
1651
+ readonly route: "GET /api/v1/quick-replies";
1652
+ readonly scope: "library:read";
1653
+ readonly summary: "List quick replies";
1654
+ }, {
1655
+ readonly route: "GET /api/v1/quick-replies/categories";
1656
+ readonly scope: "library:read";
1657
+ readonly summary: "List quick reply categories";
1658
+ }, {
1659
+ readonly route: "POST /api/v1/quick-replies/categories/rename";
1660
+ readonly scope: "library:write";
1661
+ readonly summary: "Rename a quick reply category";
1662
+ }, {
1663
+ readonly route: "POST /api/v1/quick-replies/categories/delete";
1664
+ readonly scope: "library:write";
1665
+ readonly summary: "Remove a category from its quick replies";
1666
+ }, {
1667
+ readonly route: "GET /api/v1/quick-replies/:id";
1668
+ readonly scope: "library:read";
1669
+ readonly summary: "Get a quick reply";
1670
+ }, {
1671
+ readonly route: "POST /api/v1/quick-replies";
1672
+ readonly scope: "library:write";
1673
+ readonly summary: "Create a quick reply";
1674
+ }, {
1675
+ readonly route: "PUT /api/v1/quick-replies/:id";
1676
+ readonly scope: "library:write";
1677
+ readonly summary: "Update a quick reply";
1678
+ }, {
1679
+ readonly route: "DELETE /api/v1/quick-replies/:id";
1680
+ readonly scope: "library:write";
1681
+ readonly summary: "Delete a quick reply";
1682
+ }, {
1683
+ readonly route: "POST /api/v1/quick-replies/:id/use";
1684
+ readonly scope: "library:write";
1685
+ readonly summary: "Record quick reply usage";
1686
+ }, {
1687
+ readonly route: "GET /api/v1/saved-contacts";
1688
+ readonly scope: "library:read";
1689
+ readonly summary: "List saved contacts";
1690
+ }, {
1691
+ readonly route: "GET /api/v1/saved-contacts/categories";
1692
+ readonly scope: "library:read";
1693
+ readonly summary: "List saved contact categories";
1694
+ }, {
1695
+ readonly route: "GET /api/v1/saved-contacts/:id";
1696
+ readonly scope: "library:read";
1697
+ readonly summary: "Get a saved contact";
1698
+ }, {
1699
+ readonly route: "GET /api/v1/saved-contacts/:id/whatsapp";
1700
+ readonly scope: "library:read";
1701
+ readonly summary: "Get a saved contact in WhatsApp vCard format";
1702
+ }, {
1703
+ readonly route: "POST /api/v1/saved-contacts";
1704
+ readonly scope: "library:write";
1705
+ readonly summary: "Create a saved contact";
1706
+ }, {
1707
+ readonly route: "PUT /api/v1/saved-contacts/:id";
1708
+ readonly scope: "library:write";
1709
+ readonly summary: "Update a saved contact";
1710
+ }, {
1711
+ readonly route: "DELETE /api/v1/saved-contacts/:id";
1712
+ readonly scope: "library:write";
1713
+ readonly summary: "Delete a saved contact";
1714
+ }, {
1715
+ readonly route: "POST /api/v1/saved-contacts/:id/use";
1716
+ readonly scope: "library:write";
1717
+ readonly summary: "Record saved contact usage";
1718
+ }, {
1719
+ readonly route: "GET /api/v1/saved-locations";
1720
+ readonly scope: "library:read";
1721
+ readonly summary: "List saved locations";
1722
+ }, {
1723
+ readonly route: "GET /api/v1/saved-locations/categories";
1724
+ readonly scope: "library:read";
1725
+ readonly summary: "List saved location categories";
1726
+ }, {
1727
+ readonly route: "GET /api/v1/saved-locations/:id";
1728
+ readonly scope: "library:read";
1729
+ readonly summary: "Get a saved location";
1730
+ }, {
1731
+ readonly route: "GET /api/v1/saved-locations/:id/whatsapp";
1732
+ readonly scope: "library:read";
1733
+ readonly summary: "Get a saved location in WhatsApp location format";
1734
+ }, {
1735
+ readonly route: "POST /api/v1/saved-locations";
1736
+ readonly scope: "library:write";
1737
+ readonly summary: "Create a saved location";
1738
+ }, {
1739
+ readonly route: "PUT /api/v1/saved-locations/:id";
1740
+ readonly scope: "library:write";
1741
+ readonly summary: "Update a saved location";
1742
+ }, {
1743
+ readonly route: "DELETE /api/v1/saved-locations/:id";
1744
+ readonly scope: "library:write";
1745
+ readonly summary: "Delete a saved location";
1746
+ }, {
1747
+ readonly route: "POST /api/v1/saved-locations/:id/use";
1748
+ readonly scope: "library:write";
1749
+ readonly summary: "Record saved location usage";
1750
+ }, {
1751
+ readonly route: "GET /api/v1/media";
1752
+ readonly scope: "library:read";
1753
+ readonly summary: "List media library files";
1754
+ }, {
1755
+ readonly route: "GET /api/v1/media/stats";
1756
+ readonly scope: "library:read";
1757
+ readonly summary: "Get media library stats";
1758
+ }, {
1759
+ readonly route: "GET /api/v1/media/:id";
1760
+ readonly scope: "library:read";
1761
+ readonly summary: "Get a media file";
1762
+ }, {
1763
+ readonly route: "GET /api/v1/media/limits";
1764
+ readonly scope: "library:read";
1765
+ readonly summary: "Per-channel accepted file types and sizes";
1766
+ }, {
1767
+ readonly route: "GET /api/v1/media/:id/usage";
1768
+ readonly scope: "library:read";
1769
+ readonly summary: "Where a media file is used";
1770
+ }, {
1771
+ readonly route: "PUT /api/v1/media/:id";
1772
+ readonly scope: "library:write";
1773
+ readonly summary: "Rename a media file or set its AI-accessibility";
1774
+ }, {
1775
+ readonly route: "DELETE /api/v1/media/:id";
1776
+ readonly scope: "library:write";
1777
+ readonly summary: "Delete a media file (409 MEDIA_IN_USE unless ?force=true)";
1778
+ }, {
1779
+ readonly route: "POST /api/v1/media/bulk-delete";
1780
+ readonly scope: "library:write";
1781
+ readonly summary: "Bulk delete media files";
1782
+ }, {
1783
+ readonly route: "POST /api/v1/media/:id/use";
1784
+ readonly scope: "library:write";
1785
+ readonly summary: "Record media file usage";
1786
+ }, {
1787
+ readonly route: "GET /api/v1/leads/pipeline";
1788
+ readonly scope: "leads:read";
1789
+ readonly summary: "Get the lead pipeline";
1790
+ }, {
1791
+ readonly route: "GET /api/v1/leads/statuses";
1792
+ readonly scope: "leads:read";
1793
+ readonly summary: "List lead statuses";
1794
+ }, {
1795
+ readonly route: "GET /api/v1/leads/stats";
1796
+ readonly scope: "leads:read";
1797
+ readonly summary: "Get lead pipeline stats";
1798
+ }, {
1799
+ readonly route: "GET /api/v1/leads/list";
1800
+ readonly scope: "leads:read";
1801
+ readonly summary: "List leads (paginated table view)";
1802
+ }, {
1803
+ readonly route: "POST /api/v1/leads/suggest";
1804
+ readonly scope: "leads:write";
1805
+ readonly summary: "AI-suggest lead fields from a conversation";
1806
+ }, {
1807
+ readonly route: "POST /api/v1/leads/statuses";
1808
+ readonly scope: "leads:write";
1809
+ readonly summary: "Create a lead status";
1810
+ }, {
1811
+ readonly route: "PATCH /api/v1/leads/statuses/reorder";
1812
+ readonly scope: "leads:write";
1813
+ readonly summary: "Reorder lead statuses";
1814
+ }, {
1815
+ readonly route: "PATCH /api/v1/leads/statuses/:statusId";
1816
+ readonly scope: "leads:write";
1817
+ readonly summary: "Update a lead status";
1818
+ }, {
1819
+ readonly route: "DELETE /api/v1/leads/statuses/:statusId";
1820
+ readonly scope: "leads:write";
1821
+ readonly summary: "Delete a lead status";
1822
+ }, {
1823
+ readonly route: "POST /api/v1/leads/:id/move";
1824
+ readonly scope: "leads:write";
1825
+ readonly summary: "Move a lead to a stage";
1826
+ }, {
1827
+ readonly route: "POST /api/v1/leads/:id/win";
1828
+ readonly scope: "leads:write";
1829
+ readonly summary: "Mark a lead won";
1830
+ }, {
1831
+ readonly route: "POST /api/v1/leads/:id/lose";
1832
+ readonly scope: "leads:write";
1833
+ readonly summary: "Mark a lead lost";
1834
+ }, {
1835
+ readonly route: "POST /api/v1/leads/:id/assign";
1836
+ readonly scope: "leads:write";
1837
+ readonly summary: "Assign a lead";
1838
+ }, {
1839
+ readonly route: "PATCH /api/v1/leads/:id/status";
1840
+ readonly scope: "leads:write";
1841
+ readonly summary: "Set lead status";
1842
+ }, {
1843
+ readonly route: "PATCH /api/v1/leads/:id/rating";
1844
+ readonly scope: "leads:write";
1845
+ readonly summary: "Set lead star rating";
1846
+ }, {
1847
+ readonly route: "PATCH /api/v1/leads/:id/priority";
1848
+ readonly scope: "leads:write";
1849
+ readonly summary: "Set lead priority";
1850
+ }, {
1851
+ readonly route: "GET /api/v1/leads/:id/feedback";
1852
+ readonly scope: "leads:read";
1853
+ readonly summary: "List the feedback thread on a lead";
1854
+ }, {
1855
+ readonly route: "POST /api/v1/leads/:id/feedback";
1856
+ readonly scope: "leads:write";
1857
+ readonly summary: "Add a lead feedback entry";
1858
+ }, {
1859
+ readonly route: "POST /api/v1/leads/:id/follow-up";
1860
+ readonly scope: "leads:write";
1861
+ readonly summary: "Schedule a lead follow-up task";
1862
+ }, {
1863
+ readonly route: "GET /api/v1/leads/:id/follow-ups";
1864
+ readonly scope: "leads:read";
1865
+ readonly summary: "List lead follow-up tasks";
1866
+ }, {
1867
+ readonly route: "GET /api/v1/leads/:id";
1868
+ readonly scope: "leads:read";
1869
+ readonly summary: "Get a lead";
1870
+ }, {
1871
+ readonly route: "GET /api/v1/tickets";
1872
+ readonly scope: "tickets:read";
1873
+ readonly summary: "List tickets";
1874
+ }, {
1875
+ readonly route: "GET /api/v1/tickets/stats";
1876
+ readonly scope: "tickets:read";
1877
+ readonly summary: "Get ticket stats";
1878
+ }, {
1879
+ readonly route: "GET /api/v1/tickets/my";
1880
+ readonly scope: "tickets:read";
1881
+ readonly summary: "List tickets assigned to the token owner";
1882
+ }, {
1883
+ readonly route: "GET /api/v1/tickets/contact/:contactId";
1884
+ readonly scope: "tickets:read";
1885
+ readonly summary: "List tickets for a contact";
1886
+ }, {
1887
+ readonly route: "GET /api/v1/tickets/types";
1888
+ readonly scope: "tickets:read";
1889
+ readonly summary: "List ticket types";
1890
+ }, {
1891
+ readonly route: "POST /api/v1/tickets/types";
1892
+ readonly scope: "tickets:write";
1893
+ readonly summary: "Create a ticket type";
1894
+ }, {
1895
+ readonly route: "PUT /api/v1/tickets/types/:typeId";
1896
+ readonly scope: "tickets:write";
1897
+ readonly summary: "Update a ticket type";
1898
+ }, {
1899
+ readonly route: "DELETE /api/v1/tickets/types/:typeId";
1900
+ readonly scope: "tickets:write";
1901
+ readonly summary: "Delete a ticket type";
1902
+ }, {
1903
+ readonly route: "POST /api/v1/tickets";
1904
+ readonly scope: "tickets:write";
1905
+ readonly summary: "Create a ticket";
1906
+ }, {
1907
+ readonly route: "GET /api/v1/tickets/:id";
1908
+ readonly scope: "tickets:read";
1909
+ readonly summary: "Get a ticket";
1910
+ }, {
1911
+ readonly route: "PUT /api/v1/tickets/:id";
1912
+ readonly scope: "tickets:write";
1913
+ readonly summary: "Update a ticket";
1914
+ }, {
1915
+ readonly route: "DELETE /api/v1/tickets/:id";
1916
+ readonly scope: "tickets:write";
1917
+ readonly summary: "Delete a ticket";
1918
+ }, {
1919
+ readonly route: "PATCH /api/v1/tickets/:id/status";
1920
+ readonly scope: "tickets:write";
1921
+ readonly summary: "Change ticket status";
1922
+ }, {
1923
+ readonly route: "POST /api/v1/tickets/:id/assign";
1924
+ readonly scope: "tickets:write";
1925
+ readonly summary: "Assign a ticket";
1926
+ }, {
1927
+ readonly route: "POST /api/v1/tickets/:id/close";
1928
+ readonly scope: "tickets:write";
1929
+ readonly summary: "Close a ticket";
1930
+ }, {
1931
+ readonly route: "GET /api/v1/tickets/:id/comments";
1932
+ readonly scope: "tickets:read";
1933
+ readonly summary: "List ticket comments";
1934
+ }, {
1935
+ readonly route: "POST /api/v1/tickets/:id/comments";
1936
+ readonly scope: "tickets:write";
1937
+ readonly summary: "Comment on a ticket";
1938
+ }, {
1939
+ readonly route: "GET /api/v1/tickets/:id/attachments";
1940
+ readonly scope: "tickets:read";
1941
+ readonly summary: "List ticket attachments";
1942
+ }, {
1943
+ readonly route: "POST /api/v1/tickets/:id/attachments";
1944
+ readonly scope: "tickets:write";
1945
+ readonly summary: "Add a ticket attachment (URL reference, not an upload)";
1946
+ }, {
1947
+ readonly route: "DELETE /api/v1/tickets/attachments/:attachmentId";
1948
+ readonly scope: "tickets:write";
1949
+ readonly summary: "Delete a ticket attachment";
1950
+ }, {
1951
+ readonly route: "GET /api/v1/tickets/:id/activity";
1952
+ readonly scope: "tickets:read";
1953
+ readonly summary: "Get the ticket audit trail";
1954
+ }, {
1955
+ readonly route: "POST /api/v1/orders";
1956
+ readonly scope: "orders:write";
1957
+ readonly summary: "Create an order";
1958
+ }, {
1959
+ readonly route: "PUT /api/v1/orders/:id";
1960
+ readonly scope: "orders:write";
1961
+ readonly summary: "Update an order";
1962
+ }, {
1963
+ readonly route: "PATCH /api/v1/orders/:id/status";
1964
+ readonly scope: "orders:write";
1965
+ readonly summary: "Change order status";
1966
+ }, {
1967
+ readonly route: "PATCH /api/v1/orders/:id/payment";
1968
+ readonly scope: "orders:write";
1969
+ readonly summary: "Change payment status";
1970
+ }, {
1971
+ readonly route: "PATCH /api/v1/orders/:id/fulfillment";
1972
+ readonly scope: "orders:write";
1973
+ readonly summary: "Change fulfillment status";
1974
+ }, {
1975
+ readonly route: "GET /api/v1/products/categories";
1976
+ readonly scope: "products:read";
1977
+ readonly summary: "List product categories";
1978
+ }, {
1979
+ readonly route: "POST /api/v1/products";
1980
+ readonly scope: "products:write";
1981
+ readonly summary: "Create a product";
1982
+ }, {
1983
+ readonly route: "PUT /api/v1/products/:id";
1984
+ readonly scope: "products:write";
1985
+ readonly summary: "Update a product";
1986
+ }, {
1987
+ readonly route: "DELETE /api/v1/products/:id";
1988
+ readonly scope: "products:write";
1989
+ readonly summary: "Delete a product";
1990
+ }, {
1991
+ readonly route: "POST /api/v1/products/categories";
1992
+ readonly scope: "products:write";
1993
+ readonly summary: "Create a product category";
1994
+ }, {
1995
+ readonly route: "GET /api/v1/webhooks/events";
1996
+ readonly scope: "webhooks:read";
1997
+ readonly summary: "List webhook event types";
1998
+ }, {
1999
+ readonly route: "GET /api/v1/webhooks";
2000
+ readonly scope: "webhooks:read";
2001
+ readonly summary: "List webhooks";
2002
+ }, {
2003
+ readonly route: "GET /api/v1/webhooks/:webhookId";
2004
+ readonly scope: "webhooks:read";
2005
+ readonly summary: "Get a webhook";
2006
+ }, {
2007
+ readonly route: "GET /api/v1/webhooks/:webhookId/logs";
2008
+ readonly scope: "webhooks:read";
2009
+ readonly summary: "List webhook deliveries";
2010
+ }, {
2011
+ readonly route: "POST /api/v1/webhooks";
2012
+ readonly scope: "webhooks:write";
2013
+ readonly summary: "Register a webhook";
2014
+ }, {
2015
+ readonly route: "PUT /api/v1/webhooks/:webhookId";
2016
+ readonly scope: "webhooks:write";
2017
+ readonly summary: "Update a webhook";
2018
+ }, {
2019
+ readonly route: "DELETE /api/v1/webhooks/:webhookId";
2020
+ readonly scope: "webhooks:write";
2021
+ readonly summary: "Delete a webhook";
2022
+ }, {
2023
+ readonly route: "POST /api/v1/webhooks/:webhookId/test";
2024
+ readonly scope: "webhooks:write";
2025
+ readonly summary: "Send a test delivery";
2026
+ }, {
2027
+ readonly route: "GET /api/v1/webhooks/:webhookId/secret";
2028
+ readonly scope: "webhooks:write";
2029
+ readonly summary: "Reveal the signing secret (to verify X-Inboxy-Signature)";
2030
+ }, {
2031
+ readonly route: "POST /api/v1/webhooks/:webhookId/regenerate-secret";
2032
+ readonly scope: "webhooks:write";
2033
+ readonly summary: "Rotate the signing secret";
2034
+ }, {
2035
+ readonly route: "POST /api/v1/webhooks/:webhookId/replay";
2036
+ readonly scope: "webhooks:write";
2037
+ readonly summary: "Redeliver the failed deliveries of the last 7 days";
2038
+ }, {
2039
+ readonly route: "GET /api/v1/team";
2040
+ readonly scope: "team:read";
2041
+ readonly summary: "List team members";
2042
+ }, {
2043
+ readonly route: "GET /api/v1/team/:userId";
2044
+ readonly scope: "team:read";
2045
+ readonly summary: "Get a team member";
2046
+ }, {
2047
+ readonly route: "GET /api/v1/team/stats";
2048
+ readonly scope: "team:read";
2049
+ readonly summary: "Get team headcount and role breakdown";
2050
+ }, {
2051
+ readonly route: "GET /api/v1/company";
2052
+ readonly scope: "team:read";
2053
+ readonly summary: "Get company profile and settings";
2054
+ }, {
2055
+ readonly route: "GET /api/v1/csat/config";
2056
+ readonly scope: "analytics:read";
2057
+ readonly summary: "Get the CSAT survey config";
2058
+ }, {
2059
+ readonly route: "GET /api/v1/csat/analytics";
2060
+ readonly scope: "analytics:read";
2061
+ readonly summary: "Get CSAT analytics for a period";
2062
+ }, {
2063
+ readonly route: "PUT /api/v1/ai-agents/:agentId/channels";
2064
+ readonly scope: "ai:write";
2065
+ readonly summary: "Configure employee channel assignments";
2066
+ }, {
2067
+ readonly route: "POST /api/v1/ai-agents/:agentId/knowledge";
2068
+ readonly scope: "ai:write";
2069
+ readonly summary: "Create employee text knowledge";
2070
+ }, {
2071
+ readonly route: "PUT /api/v1/ai-agents/:agentId/knowledge/:knowledgeId";
2072
+ readonly scope: "ai:write";
2073
+ readonly summary: "Update employee knowledge";
2074
+ }, {
2075
+ readonly route: "GET /api/v1/ai-agents/channels";
2076
+ readonly scope: "ai:read";
2077
+ readonly summary: "List channels available for agent assignment";
2078
+ }, {
2079
+ readonly route: "GET /api/v1/ai-agents/presets/personalities";
2080
+ readonly scope: "ai:read";
2081
+ readonly summary: "List agent personality presets";
2082
+ }, {
2083
+ readonly route: "GET /api/v1/ai-agents/presets/agent-types";
2084
+ readonly scope: "ai:read";
2085
+ readonly summary: "List agent type presets";
2086
+ }, {
2087
+ readonly route: "GET /api/v1/ai-agents";
2088
+ readonly scope: "ai:read";
2089
+ readonly summary: "List AI agents";
2090
+ }, {
2091
+ readonly route: "GET /api/v1/ai-agents/stats";
2092
+ readonly scope: "ai:read";
2093
+ readonly summary: "Get AI agent stats";
2094
+ }, {
2095
+ readonly route: "GET /api/v1/ai-agents/insights/schedule";
2096
+ readonly scope: "ai:read";
2097
+ readonly summary: "Get the conversation insights schedule";
2098
+ }, {
2099
+ readonly route: "PUT /api/v1/ai-agents/insights/schedule";
2100
+ readonly scope: "ai:write";
2101
+ readonly summary: "Set the conversation insights schedule";
2102
+ }, {
2103
+ readonly route: "GET /api/v1/ai-agents/insights/reports";
2104
+ readonly scope: "ai:read";
2105
+ readonly summary: "List conversation insight reports";
2106
+ }, {
2107
+ readonly route: "GET /api/v1/ai-agents/insights/reports/:reportId";
2108
+ readonly scope: "ai:read";
2109
+ readonly summary: "Get a conversation insight report";
2110
+ }, {
2111
+ readonly route: "POST /api/v1/ai-agents/insights/run";
2112
+ readonly scope: "ai:write";
2113
+ readonly summary: "Queue a manual conversation insight report";
2114
+ }, {
2115
+ readonly route: "GET /api/v1/ai-agents/historical-learning";
2116
+ readonly scope: "ai:read";
2117
+ readonly summary: "List historical learning profiles";
2118
+ }, {
2119
+ readonly route: "PUT /api/v1/ai-agents/:agentId/historical-learning";
2120
+ readonly scope: "ai:write";
2121
+ readonly summary: "Enable or disable historical learning for an agent";
2122
+ }, {
2123
+ readonly route: "POST /api/v1/ai-agents/:agentId/historical-learning/run";
2124
+ readonly scope: "ai:write";
2125
+ readonly summary: "Run historical learning analysis for an agent";
2126
+ }, {
2127
+ readonly route: "POST /api/v1/ai-agents/drafts";
2128
+ readonly scope: "ai:write";
2129
+ readonly summary: "Create or resume an inactive AI draft";
2130
+ }, {
2131
+ readonly route: "POST /api/v1/ai-agents/:agentId/test";
2132
+ readonly scope: "ai:write";
2133
+ readonly summary: "Test an AI employee without customer messages";
2134
+ }, {
2135
+ readonly route: "POST /api/v1/ai-agents/:agentId/setup-test";
2136
+ readonly scope: "ai:write";
2137
+ readonly summary: "Check AI employee readiness";
2138
+ }, {
2139
+ readonly route: "POST /api/v1/ai-agents/:agentId/publish";
2140
+ readonly scope: "ai:write";
2141
+ readonly summary: "Activate AI employee on selected channels";
2142
+ }, {
2143
+ readonly route: "POST /api/v1/ai-agents";
2144
+ readonly scope: "ai:write";
2145
+ readonly summary: "Create an AI agent";
2146
+ }, {
2147
+ readonly route: "GET /api/v1/ai-agents/:agentId";
2148
+ readonly scope: "ai:read";
2149
+ readonly summary: "Get an AI agent";
2150
+ }, {
2151
+ readonly route: "PUT /api/v1/ai-agents/:agentId";
2152
+ readonly scope: "ai:write";
2153
+ readonly summary: "Update an AI agent";
2154
+ }, {
2155
+ readonly route: "DELETE /api/v1/ai-agents/:agentId";
2156
+ readonly scope: "ai:write";
2157
+ readonly summary: "Delete an AI agent";
2158
+ }, {
2159
+ readonly route: "GET /api/v1/ai-agents/:agentId/knowledge";
2160
+ readonly scope: "ai:read";
2161
+ readonly summary: "List agent knowledge entries";
2162
+ }, {
2163
+ readonly route: "GET /api/v1/ai-agents/:agentId/knowledge/categories";
2164
+ readonly scope: "ai:read";
2165
+ readonly summary: "List agent knowledge categories";
2166
+ }, {
2167
+ readonly route: "GET /api/v1/ai-agents/:agentId/knowledge/:knowledgeId";
2168
+ readonly scope: "ai:read";
2169
+ readonly summary: "Get an agent knowledge entry";
2170
+ }, {
2171
+ readonly route: "DELETE /api/v1/ai-agents/:agentId/knowledge/:knowledgeId";
2172
+ readonly scope: "ai:write";
2173
+ readonly summary: "Delete an agent knowledge entry";
2174
+ }, {
2175
+ readonly route: "GET /api/v1/ai-agents/upload/info";
2176
+ readonly scope: "ai:read";
2177
+ readonly summary: "Get supported knowledge upload file types";
2178
+ }, {
2179
+ readonly route: "GET /api/v1/ai-agents/logs";
2180
+ readonly scope: "ai:read";
2181
+ readonly summary: "List agent event logs";
2182
+ }, {
2183
+ readonly route: "GET /api/v1/ai-agents/logs/stats";
2184
+ readonly scope: "ai:read";
2185
+ readonly summary: "Get agent log stats";
2186
+ }, {
2187
+ readonly route: "GET /api/v1/ai-agents/functions/builtin";
2188
+ readonly scope: "ai:read";
2189
+ readonly summary: "List built-in agent functions";
2190
+ }, {
2191
+ readonly route: "GET /api/v1/ai-agents/:agentId/functions";
2192
+ readonly scope: "ai:read";
2193
+ readonly summary: "List agent functions";
2194
+ }, {
2195
+ readonly route: "POST /api/v1/ai-agents/:agentId/functions";
2196
+ readonly scope: "ai:write";
2197
+ readonly summary: "Create an agent function";
2198
+ }, {
2199
+ readonly route: "PUT /api/v1/ai-agents/:agentId/functions/:functionId";
2200
+ readonly scope: "ai:write";
2201
+ readonly summary: "Update an agent function";
2202
+ }, {
2203
+ readonly route: "DELETE /api/v1/ai-agents/:agentId/functions/:functionId";
2204
+ readonly scope: "ai:write";
2205
+ readonly summary: "Delete an agent function";
2206
+ }, {
2207
+ readonly route: "PATCH /api/v1/ai-agents/:agentId/functions/:functionId/toggle";
2208
+ readonly scope: "ai:write";
2209
+ readonly summary: "Enable or disable an agent function";
2210
+ }, {
2211
+ readonly route: "POST /api/v1/ai-agents/functions/sync";
2212
+ readonly scope: "ai:write";
2213
+ readonly summary: "Sync built-in functions to all agents";
2214
+ }];
2215
+ //# sourceMappingURL=api-route-inventory.generated.d.ts.map