@ironfang/n8n-nodes-ironfang 0.2.3 → 0.3.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 (39) hide show
  1. package/README.md +164 -100
  2. package/dist/credentials/IronfangApi.credentials.js +6 -1
  3. package/dist/credentials/IronfangS3.credentials.d.ts +8 -0
  4. package/dist/credentials/IronfangS3.credentials.js +15 -0
  5. package/dist/credentials/IronfangWebhookApi.credentials.d.ts +8 -0
  6. package/dist/credentials/IronfangWebhookApi.credentials.js +14 -0
  7. package/dist/nodes/Ironfang/Ironfang.node.d.ts +7 -10
  8. package/dist/nodes/Ironfang/Ironfang.node.js +36 -535
  9. package/dist/nodes/Ironfang/IronfangTrigger.node.d.ts +11 -0
  10. package/dist/nodes/Ironfang/IronfangTrigger.node.js +56 -0
  11. package/dist/nodes/Ironfang/catalog.d.ts +2 -0
  12. package/dist/nodes/Ironfang/catalog.js +1806 -0
  13. package/dist/nodes/Ironfang/credentialTest.js +24 -14
  14. package/dist/nodes/Ironfang/destinationCredentialTest.d.ts +2 -0
  15. package/dist/nodes/Ironfang/destinationCredentialTest.js +12 -0
  16. package/dist/nodes/Ironfang/execute.d.ts +2 -0
  17. package/dist/nodes/Ironfang/execute.js +205 -0
  18. package/dist/nodes/Ironfang/files.d.ts +10 -0
  19. package/dist/nodes/Ironfang/files.js +50 -0
  20. package/dist/nodes/Ironfang/parameters.d.ts +2 -0
  21. package/dist/nodes/Ironfang/parameters.js +50 -0
  22. package/dist/nodes/Ironfang/renderOptions.d.ts +2 -0
  23. package/dist/nodes/Ironfang/renderOptions.js +8 -0
  24. package/dist/nodes/Ironfang/renderwolf.d.ts +19 -0
  25. package/dist/nodes/Ironfang/renderwolf.js +556 -0
  26. package/dist/nodes/Ironfang/templates.d.ts +2 -0
  27. package/dist/nodes/Ironfang/templates.js +15 -0
  28. package/dist/nodes/Ironfang/transport.d.ts +3 -1
  29. package/dist/nodes/Ironfang/transport.js +20 -5
  30. package/dist/nodes/Ironfang/types.d.ts +31 -0
  31. package/dist/nodes/Ironfang/types.js +2 -0
  32. package/dist/nodes/Ironfang/webhook.d.ts +4 -0
  33. package/dist/nodes/Ironfang/webhook.js +39 -0
  34. package/docs/operations.md +1046 -0
  35. package/docs/validation.md +58 -0
  36. package/examples/audit-polling.json +223 -0
  37. package/examples/invoice-generation-storage.json +83 -0
  38. package/examples/invoice-validation.json +54 -0
  39. package/package.json +16 -7
@@ -0,0 +1,1806 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.operations = void 0;
4
+ exports.operations = [
5
+ {
6
+ "product": "auditwolf",
7
+ "id": "archiveMonitorsByMonitorId",
8
+ "name": "Archive Monitor",
9
+ "description": "Archive a monitor (one-way; its audits and evidence remain)",
10
+ "method": "POST",
11
+ "path": "/v1/monitors/{monitorId}/archive",
12
+ "scope": "auditwolf:manage",
13
+ "query": [],
14
+ "input": "none",
15
+ "response": "json"
16
+ },
17
+ {
18
+ "product": "auditwolf",
19
+ "id": "bulkUpdateFindings",
20
+ "name": "Bulk Update Findings",
21
+ "description": "Apply one decision to several findings",
22
+ "method": "POST",
23
+ "path": "/v1/findings/bulk",
24
+ "scope": "auditwolf:manage",
25
+ "query": [],
26
+ "input": "json",
27
+ "response": "json",
28
+ "example": {
29
+ "ids": [
30
+ ""
31
+ ]
32
+ }
33
+ },
34
+ {
35
+ "product": "auditwolf",
36
+ "id": "getPageObservationsByObservationIdComparison",
37
+ "name": "Compare Page Observation",
38
+ "description": "What changed against the observation before it",
39
+ "method": "GET",
40
+ "path": "/v1/page-observations/{observationId}/comparison",
41
+ "scope": "auditwolf:read",
42
+ "query": [],
43
+ "input": "none",
44
+ "response": "json"
45
+ },
46
+ {
47
+ "product": "auditwolf",
48
+ "id": "createExportDestinations",
49
+ "name": "Create Export Destination",
50
+ "description": "Create an encrypted S3/S3-compatible destination",
51
+ "method": "POST",
52
+ "path": "/v1/export-destinations",
53
+ "scope": "auditwolf:integrations",
54
+ "query": [],
55
+ "input": "json",
56
+ "response": "json",
57
+ "example": {
58
+ "region": "eu-west-2",
59
+ "bucket": "your-bucket",
60
+ "prefix": "auditwolf",
61
+ "export_mode": "manual_only"
62
+ }
63
+ },
64
+ {
65
+ "product": "auditwolf",
66
+ "id": "createSitesBySiteIdMonitors",
67
+ "name": "Create Monitor",
68
+ "description": "Create a monitor",
69
+ "method": "POST",
70
+ "path": "/v1/sites/{siteId}/monitors",
71
+ "scope": "auditwolf:manage",
72
+ "query": [],
73
+ "input": "none",
74
+ "response": "json"
75
+ },
76
+ {
77
+ "product": "auditwolf",
78
+ "id": "createSitesBySiteIdRules",
79
+ "name": "Create Rule",
80
+ "description": "Create a deterministic rule",
81
+ "method": "POST",
82
+ "path": "/v1/sites/{siteId}/rules",
83
+ "scope": "auditwolf:manage",
84
+ "query": [],
85
+ "input": "json",
86
+ "response": "json",
87
+ "example": {
88
+ "name": "",
89
+ "rule_type": "",
90
+ "configuration": {}
91
+ }
92
+ },
93
+ {
94
+ "product": "auditwolf",
95
+ "id": "createSites",
96
+ "name": "Create Site",
97
+ "description": "Create a site",
98
+ "method": "POST",
99
+ "path": "/v1/sites",
100
+ "scope": "auditwolf:manage",
101
+ "query": [],
102
+ "input": "json",
103
+ "response": "json",
104
+ "example": {
105
+ "name": "Example site",
106
+ "url": "https://example.com"
107
+ }
108
+ },
109
+ {
110
+ "product": "auditwolf",
111
+ "id": "createWebhooks",
112
+ "name": "Create Webhook",
113
+ "description": "Create a signed webhook endpoint",
114
+ "method": "POST",
115
+ "path": "/v1/webhooks",
116
+ "scope": "auditwolf:integrations",
117
+ "query": [],
118
+ "input": "json",
119
+ "response": "json",
120
+ "example": {
121
+ "url": "https://example.com/webhook",
122
+ "events": [
123
+ "audit.completed"
124
+ ]
125
+ }
126
+ },
127
+ {
128
+ "product": "auditwolf",
129
+ "id": "deleteWebhooksByEndpointId",
130
+ "name": "Delete Webhook",
131
+ "description": "Retire an endpoint (soft; its delivery history is kept)",
132
+ "method": "DELETE",
133
+ "path": "/v1/webhooks/{endpointId}",
134
+ "scope": "auditwolf:integrations",
135
+ "query": [],
136
+ "input": "none",
137
+ "response": "json"
138
+ },
139
+ {
140
+ "product": "auditwolf",
141
+ "id": "disableRulesByLineageId",
142
+ "name": "Disable Rule",
143
+ "description": "Disable a rule for future audits",
144
+ "method": "POST",
145
+ "path": "/v1/rules/{lineageId}/disable",
146
+ "scope": "auditwolf:manage",
147
+ "query": [],
148
+ "input": "none",
149
+ "response": "json"
150
+ },
151
+ {
152
+ "product": "auditwolf",
153
+ "id": "getArtifactsByArtifactId",
154
+ "name": "Download Artifact",
155
+ "description": "Stream an authenticated raw artifact",
156
+ "method": "GET",
157
+ "path": "/v1/artifacts/{artifactId}",
158
+ "scope": "auditwolf:evidence",
159
+ "query": [],
160
+ "input": "none",
161
+ "response": "binary"
162
+ },
163
+ {
164
+ "product": "auditwolf",
165
+ "id": "listAuditsByAuditIdEvidence",
166
+ "name": "Download Audit Evidence",
167
+ "description": "Download the independently verifiable evidence ZIP",
168
+ "method": "GET",
169
+ "path": "/v1/audits/{auditId}/evidence",
170
+ "scope": "auditwolf:evidence",
171
+ "query": [],
172
+ "input": "none",
173
+ "response": "binary"
174
+ },
175
+ {
176
+ "product": "auditwolf",
177
+ "id": "enableRulesByLineageId",
178
+ "name": "Enable Rule",
179
+ "description": "Enable a rule for future audits",
180
+ "method": "POST",
181
+ "path": "/v1/rules/{lineageId}/enable",
182
+ "scope": "auditwolf:manage",
183
+ "query": [],
184
+ "input": "none",
185
+ "response": "json"
186
+ },
187
+ {
188
+ "product": "auditwolf",
189
+ "id": "exportAuditsByAuditId",
190
+ "name": "Export Audit",
191
+ "description": "Queue a manual S3 export",
192
+ "method": "POST",
193
+ "path": "/v1/audits/{auditId}/exports",
194
+ "scope": "auditwolf:integrations",
195
+ "query": [],
196
+ "input": "json",
197
+ "response": "json",
198
+ "example": {
199
+ "destination_id": ""
200
+ }
201
+ },
202
+ {
203
+ "product": "auditwolf",
204
+ "id": "getAuditsByAuditId",
205
+ "name": "Get Audit",
206
+ "description": "Get audit lifecycle, compliance and integrity state",
207
+ "method": "GET",
208
+ "path": "/v1/audits/{auditId}",
209
+ "scope": "auditwolf:read",
210
+ "query": [],
211
+ "input": "none",
212
+ "response": "json"
213
+ },
214
+ {
215
+ "product": "auditwolf",
216
+ "id": "getFindingsByFindingId",
217
+ "name": "Get Finding",
218
+ "description": "Get one finding",
219
+ "method": "GET",
220
+ "path": "/v1/findings/{findingId}",
221
+ "scope": "auditwolf:read",
222
+ "query": [],
223
+ "input": "none",
224
+ "response": "json"
225
+ },
226
+ {
227
+ "product": "auditwolf",
228
+ "id": "getFindingsSummary",
229
+ "name": "Get Findings Summary",
230
+ "description": "The numbers at the top of the finding inbox",
231
+ "method": "GET",
232
+ "path": "/v1/findings/summary",
233
+ "scope": "auditwolf:read",
234
+ "query": [],
235
+ "input": "none",
236
+ "response": "json"
237
+ },
238
+ {
239
+ "product": "auditwolf",
240
+ "id": "getMonitorsByMonitorId",
241
+ "name": "Get Monitor",
242
+ "description": "Get a monitor with its URL set",
243
+ "method": "GET",
244
+ "path": "/v1/monitors/{monitorId}",
245
+ "scope": "auditwolf:read",
246
+ "query": [],
247
+ "input": "none",
248
+ "response": "json"
249
+ },
250
+ {
251
+ "product": "auditwolf",
252
+ "id": "getPageObservationsByObservationId",
253
+ "name": "Get Page Observation",
254
+ "description": "One observation with its artifacts and rule results",
255
+ "method": "GET",
256
+ "path": "/v1/page-observations/{observationId}",
257
+ "scope": "auditwolf:read",
258
+ "query": [],
259
+ "input": "none",
260
+ "response": "json"
261
+ },
262
+ {
263
+ "product": "auditwolf",
264
+ "id": "getRulesByLineageId",
265
+ "name": "Get Rule",
266
+ "description": "Get the active revision of a rule",
267
+ "method": "GET",
268
+ "path": "/v1/rules/{lineageId}",
269
+ "scope": "auditwolf:read",
270
+ "query": [],
271
+ "input": "none",
272
+ "response": "json"
273
+ },
274
+ {
275
+ "product": "auditwolf",
276
+ "id": "getSitesBySiteId",
277
+ "name": "Get Site",
278
+ "description": "Get a site",
279
+ "method": "GET",
280
+ "path": "/v1/sites/{siteId}",
281
+ "scope": "auditwolf:read",
282
+ "query": [],
283
+ "input": "none",
284
+ "response": "json"
285
+ },
286
+ {
287
+ "product": "auditwolf",
288
+ "id": "getProductHome",
289
+ "name": "Home",
290
+ "description": "Tenant-scoped setup facts and recent activity for the portal",
291
+ "method": "GET",
292
+ "path": "/v1/home",
293
+ "scope": "auditwolf:read",
294
+ "query": [],
295
+ "input": "none",
296
+ "response": "json"
297
+ },
298
+ {
299
+ "product": "auditwolf",
300
+ "id": "createSitesBySiteIdRulePacks",
301
+ "name": "Install Rule Pack",
302
+ "description": "Install a rule pack",
303
+ "method": "POST",
304
+ "path": "/v1/sites/{siteId}/rule-packs",
305
+ "scope": "auditwolf:manage",
306
+ "query": [],
307
+ "input": "json",
308
+ "response": "json",
309
+ "example": {
310
+ "pack_key": "",
311
+ "variables": {}
312
+ }
313
+ },
314
+ {
315
+ "product": "auditwolf",
316
+ "id": "listAuditsByAuditIdPages",
317
+ "name": "List Audit Pages",
318
+ "description": "Page observations of an audit",
319
+ "method": "GET",
320
+ "path": "/v1/audits/{auditId}/pages",
321
+ "scope": "auditwolf:read",
322
+ "query": [
323
+ {
324
+ "name": "change",
325
+ "label": "Change",
326
+ "type": "string",
327
+ "default": ""
328
+ },
329
+ {
330
+ "name": "compliance",
331
+ "label": "Compliance",
332
+ "type": "string",
333
+ "default": ""
334
+ },
335
+ {
336
+ "name": "capture",
337
+ "label": "Capture",
338
+ "type": "string",
339
+ "default": ""
340
+ },
341
+ {
342
+ "name": "q",
343
+ "label": "Q",
344
+ "type": "string",
345
+ "default": ""
346
+ }
347
+ ],
348
+ "input": "none",
349
+ "response": "json"
350
+ },
351
+ {
352
+ "product": "auditwolf",
353
+ "id": "listAudits",
354
+ "name": "List Audits",
355
+ "description": "List organisation audits",
356
+ "method": "GET",
357
+ "path": "/v1/audits",
358
+ "scope": "auditwolf:read",
359
+ "query": [
360
+ {
361
+ "name": "site_id",
362
+ "label": "Site ID",
363
+ "type": "string",
364
+ "default": ""
365
+ }
366
+ ],
367
+ "input": "none",
368
+ "response": "json"
369
+ },
370
+ {
371
+ "product": "auditwolf",
372
+ "id": "listEvents",
373
+ "name": "List Events",
374
+ "description": "The organisation's recent product events, newest first",
375
+ "method": "GET",
376
+ "path": "/v1/events",
377
+ "scope": "auditwolf:read",
378
+ "query": [],
379
+ "input": "none",
380
+ "response": "json"
381
+ },
382
+ {
383
+ "product": "auditwolf",
384
+ "id": "listExportDestinations",
385
+ "name": "List Export Destinations",
386
+ "description": "List S3 destinations",
387
+ "method": "GET",
388
+ "path": "/v1/export-destinations",
389
+ "scope": "auditwolf:integrations",
390
+ "query": [],
391
+ "input": "none",
392
+ "response": "json"
393
+ },
394
+ {
395
+ "product": "auditwolf",
396
+ "id": "listExports",
397
+ "name": "List Exports",
398
+ "description": "List export jobs",
399
+ "method": "GET",
400
+ "path": "/v1/exports",
401
+ "scope": "auditwolf:integrations",
402
+ "query": [],
403
+ "input": "none",
404
+ "response": "json"
405
+ },
406
+ {
407
+ "product": "auditwolf",
408
+ "id": "listFindingsByFindingIdEvents",
409
+ "name": "List Finding Events",
410
+ "description": "The append-only history of a finding",
411
+ "method": "GET",
412
+ "path": "/v1/findings/{findingId}/events",
413
+ "scope": "auditwolf:read",
414
+ "query": [],
415
+ "input": "none",
416
+ "response": "json"
417
+ },
418
+ {
419
+ "product": "auditwolf",
420
+ "id": "listFindings",
421
+ "name": "List Findings",
422
+ "description": "The finding inbox",
423
+ "method": "GET",
424
+ "path": "/v1/findings",
425
+ "scope": "auditwolf:read",
426
+ "query": [
427
+ {
428
+ "name": "site_id",
429
+ "label": "Site ID",
430
+ "type": "string",
431
+ "required": false,
432
+ "default": "",
433
+ "description": "",
434
+ "enum": []
435
+ },
436
+ {
437
+ "name": "page_id",
438
+ "label": "Page ID",
439
+ "type": "string",
440
+ "required": false,
441
+ "default": "",
442
+ "description": "",
443
+ "enum": []
444
+ },
445
+ {
446
+ "name": "rule_id",
447
+ "label": "Rule ID",
448
+ "type": "string",
449
+ "required": false,
450
+ "default": "",
451
+ "description": "The rule lineage id, so a reworded rule keeps its findings.",
452
+ "enum": []
453
+ },
454
+ {
455
+ "name": "state",
456
+ "label": "State",
457
+ "type": "array",
458
+ "required": false,
459
+ "default": "",
460
+ "description": "Repeatable. Omit for everything still outstanding.",
461
+ "enum": []
462
+ },
463
+ {
464
+ "name": "severity",
465
+ "label": "Severity",
466
+ "type": "string",
467
+ "required": false,
468
+ "default": "",
469
+ "description": "",
470
+ "enum": [
471
+ "info",
472
+ "warning",
473
+ "failure",
474
+ "critical"
475
+ ]
476
+ },
477
+ {
478
+ "name": "assignee",
479
+ "label": "Assignee",
480
+ "type": "string",
481
+ "required": false,
482
+ "default": "",
483
+ "description": "",
484
+ "enum": []
485
+ },
486
+ {
487
+ "name": "open_longer_than_days",
488
+ "label": "Open Longer Than Days",
489
+ "type": "integer",
490
+ "required": false,
491
+ "default": "",
492
+ "description": "Findings first seen more than this many days ago.",
493
+ "enum": []
494
+ },
495
+ {
496
+ "name": "limit",
497
+ "label": "Limit",
498
+ "type": "integer",
499
+ "required": false,
500
+ "default": 50,
501
+ "description": "",
502
+ "enum": []
503
+ },
504
+ {
505
+ "name": "offset",
506
+ "label": "Offset",
507
+ "type": "integer",
508
+ "required": false,
509
+ "default": 0,
510
+ "description": "",
511
+ "enum": []
512
+ }
513
+ ],
514
+ "input": "none",
515
+ "response": "json",
516
+ "pagination": {
517
+ "key": "findings",
518
+ "parameter": "offset",
519
+ "size": 200
520
+ }
521
+ },
522
+ {
523
+ "product": "auditwolf",
524
+ "id": "listSitesBySiteIdRulePacks",
525
+ "name": "List Installed Rule Packs",
526
+ "description": "Packs installed on this site",
527
+ "method": "GET",
528
+ "path": "/v1/sites/{siteId}/rule-packs",
529
+ "scope": "auditwolf:read",
530
+ "query": [],
531
+ "input": "none",
532
+ "response": "json"
533
+ },
534
+ {
535
+ "product": "auditwolf",
536
+ "id": "listMonitorsByMonitorIdRuns",
537
+ "name": "List Monitor Runs",
538
+ "description": "The monitor's audits, newest first",
539
+ "method": "GET",
540
+ "path": "/v1/monitors/{monitorId}/runs",
541
+ "scope": "auditwolf:read",
542
+ "query": [],
543
+ "input": "none",
544
+ "response": "json"
545
+ },
546
+ {
547
+ "product": "auditwolf",
548
+ "id": "listPagesByPageIdObservations",
549
+ "name": "List Page Observations",
550
+ "description": "A page's observation history, newest first",
551
+ "method": "GET",
552
+ "path": "/v1/pages/{pageId}/observations",
553
+ "scope": "auditwolf:read",
554
+ "query": [
555
+ {
556
+ "name": "cursor",
557
+ "label": "Cursor",
558
+ "type": "string",
559
+ "default": ""
560
+ },
561
+ {
562
+ "name": "limit",
563
+ "label": "Limit",
564
+ "type": "integer",
565
+ "default": 50
566
+ }
567
+ ],
568
+ "input": "none",
569
+ "response": "json",
570
+ "pagination": {
571
+ "key": "observations",
572
+ "parameter": "cursor",
573
+ "size": 100
574
+ }
575
+ },
576
+ {
577
+ "product": "auditwolf",
578
+ "id": "listRulePacks",
579
+ "name": "List Rule Packs",
580
+ "description": "The rule pack catalogue",
581
+ "method": "GET",
582
+ "path": "/v1/rule-packs",
583
+ "scope": "auditwolf:read",
584
+ "query": [],
585
+ "input": "none",
586
+ "response": "json"
587
+ },
588
+ {
589
+ "product": "auditwolf",
590
+ "id": "listRulesByLineageIdRevisions",
591
+ "name": "List Rule Revisions",
592
+ "description": "List every revision of a rule, newest first",
593
+ "method": "GET",
594
+ "path": "/v1/rules/{lineageId}/revisions",
595
+ "scope": "auditwolf:read",
596
+ "query": [],
597
+ "input": "none",
598
+ "response": "json"
599
+ },
600
+ {
601
+ "product": "auditwolf",
602
+ "id": "listSitesBySiteIdAudits",
603
+ "name": "List Site Audits",
604
+ "description": "List site audits",
605
+ "method": "GET",
606
+ "path": "/v1/sites/{siteId}/audits",
607
+ "scope": "auditwolf:read",
608
+ "query": [],
609
+ "input": "none",
610
+ "response": "json"
611
+ },
612
+ {
613
+ "product": "auditwolf",
614
+ "id": "listSitesBySiteIdMonitors",
615
+ "name": "List Site Monitors",
616
+ "description": "List the site's monitors",
617
+ "method": "GET",
618
+ "path": "/v1/sites/{siteId}/monitors",
619
+ "scope": "auditwolf:read",
620
+ "query": [],
621
+ "input": "none",
622
+ "response": "json"
623
+ },
624
+ {
625
+ "product": "auditwolf",
626
+ "id": "listSitesBySiteIdRules",
627
+ "name": "List Site Rules",
628
+ "description": "List the site's versioned deterministic rules",
629
+ "method": "GET",
630
+ "path": "/v1/sites/{siteId}/rules",
631
+ "scope": "auditwolf:read",
632
+ "query": [],
633
+ "input": "none",
634
+ "response": "json"
635
+ },
636
+ {
637
+ "product": "auditwolf",
638
+ "id": "listSites",
639
+ "name": "List Sites",
640
+ "description": "List sites",
641
+ "method": "GET",
642
+ "path": "/v1/sites",
643
+ "scope": "auditwolf:read",
644
+ "query": [],
645
+ "input": "none",
646
+ "response": "json"
647
+ },
648
+ {
649
+ "product": "auditwolf",
650
+ "id": "listWebhooksByEndpointIdDeliveries",
651
+ "name": "List Webhook Deliveries",
652
+ "description": "List delivery attempts",
653
+ "method": "GET",
654
+ "path": "/v1/webhooks/{endpointId}/deliveries",
655
+ "scope": "auditwolf:integrations",
656
+ "query": [],
657
+ "input": "none",
658
+ "response": "json"
659
+ },
660
+ {
661
+ "product": "auditwolf",
662
+ "id": "listWebhooks",
663
+ "name": "List Webhooks",
664
+ "description": "List lifecycle webhook endpoints",
665
+ "method": "GET",
666
+ "path": "/v1/webhooks",
667
+ "scope": "auditwolf:integrations",
668
+ "query": [],
669
+ "input": "none",
670
+ "response": "json"
671
+ },
672
+ {
673
+ "product": "auditwolf",
674
+ "id": "pauseMonitorsByMonitorId",
675
+ "name": "Pause Monitor",
676
+ "description": "Pause scheduling",
677
+ "method": "POST",
678
+ "path": "/v1/monitors/{monitorId}/pause",
679
+ "scope": "auditwolf:manage",
680
+ "query": [],
681
+ "input": "none",
682
+ "response": "json"
683
+ },
684
+ {
685
+ "product": "auditwolf",
686
+ "id": "replaceMonitorsByMonitorIdUrls",
687
+ "name": "Replace Monitor URLs",
688
+ "description": "Replace a url_set monitor's URL list",
689
+ "method": "PUT",
690
+ "path": "/v1/monitors/{monitorId}/urls",
691
+ "scope": "auditwolf:manage",
692
+ "query": [],
693
+ "input": "none",
694
+ "response": "json"
695
+ },
696
+ {
697
+ "product": "auditwolf",
698
+ "id": "resumeMonitorsByMonitorId",
699
+ "name": "Resume Monitor",
700
+ "description": "Resume scheduling",
701
+ "method": "POST",
702
+ "path": "/v1/monitors/{monitorId}/resume",
703
+ "scope": "auditwolf:manage",
704
+ "query": [],
705
+ "input": "none",
706
+ "response": "json"
707
+ },
708
+ {
709
+ "product": "auditwolf",
710
+ "id": "deleteRulesByLineageId",
711
+ "name": "Retire Rule",
712
+ "description": "Retire a rule",
713
+ "method": "DELETE",
714
+ "path": "/v1/rules/{lineageId}",
715
+ "scope": "auditwolf:manage",
716
+ "query": [],
717
+ "input": "none",
718
+ "response": "json"
719
+ },
720
+ {
721
+ "product": "auditwolf",
722
+ "id": "retryWebhooksByEndpointIdDeliveriesByDeliveryId",
723
+ "name": "Retry Webhook Delivery",
724
+ "description": "Re-queue a failed delivery",
725
+ "method": "POST",
726
+ "path": "/v1/webhooks/{endpointId}/deliveries/{deliveryId}/retry",
727
+ "scope": "auditwolf:integrations",
728
+ "query": [],
729
+ "input": "none",
730
+ "response": "json"
731
+ },
732
+ {
733
+ "product": "auditwolf",
734
+ "id": "rotateWebhooksByEndpointIdSecret",
735
+ "name": "Rotate Webhook Secret",
736
+ "description": "Replace the endpoint's signing secret",
737
+ "method": "POST",
738
+ "path": "/v1/webhooks/{endpointId}/rotate-secret",
739
+ "scope": "auditwolf:integrations",
740
+ "query": [],
741
+ "input": "none",
742
+ "response": "json"
743
+ },
744
+ {
745
+ "product": "auditwolf",
746
+ "id": "runMonitorsByMonitorId",
747
+ "name": "Run Monitor",
748
+ "description": "Queue an audit now with the monitor's scope frozen as the scheduler would freeze it",
749
+ "method": "POST",
750
+ "path": "/v1/monitors/{monitorId}/run",
751
+ "scope": "auditwolf:run",
752
+ "query": [],
753
+ "input": "none",
754
+ "response": "json",
755
+ "idempotency": true
756
+ },
757
+ {
758
+ "product": "auditwolf",
759
+ "id": "createSitesBySiteIdAudits",
760
+ "name": "Run Site Audit",
761
+ "description": "Trigger an asynchronous audit",
762
+ "method": "POST",
763
+ "path": "/v1/sites/{siteId}/audits",
764
+ "scope": "auditwolf:run",
765
+ "query": [],
766
+ "input": "json",
767
+ "response": "json",
768
+ "example": {
769
+ "reason": "Scheduled n8n check",
770
+ "trigger_type": "api"
771
+ },
772
+ "idempotency": true
773
+ },
774
+ {
775
+ "product": "auditwolf",
776
+ "id": "testExportDestinationsByDestinationId",
777
+ "name": "Test Export Destination",
778
+ "description": "Upload and verify a connection-test object",
779
+ "method": "POST",
780
+ "path": "/v1/export-destinations/{destinationId}/test",
781
+ "scope": "auditwolf:integrations",
782
+ "query": [],
783
+ "input": "none",
784
+ "response": "json"
785
+ },
786
+ {
787
+ "product": "auditwolf",
788
+ "id": "testWebhooksByEndpointId",
789
+ "name": "Test Webhook",
790
+ "description": "Send a signed endpoint.test event",
791
+ "method": "POST",
792
+ "path": "/v1/webhooks/{endpointId}/test",
793
+ "scope": "auditwolf:integrations",
794
+ "query": [],
795
+ "input": "none",
796
+ "response": "json"
797
+ },
798
+ {
799
+ "product": "auditwolf",
800
+ "id": "deleteRulePacksInstalledByInstallationId",
801
+ "name": "Uninstall Rule Pack",
802
+ "description": "Uninstall a pack",
803
+ "method": "DELETE",
804
+ "path": "/v1/rule-packs/installed/{installationId}",
805
+ "scope": "auditwolf:manage",
806
+ "query": [],
807
+ "input": "none",
808
+ "response": "json"
809
+ },
810
+ {
811
+ "product": "auditwolf",
812
+ "id": "updateFindingsByFindingId",
813
+ "name": "Update Finding",
814
+ "description": "Assign, schedule, acknowledge, accept the risk, or close a finding",
815
+ "method": "PATCH",
816
+ "path": "/v1/findings/{findingId}",
817
+ "scope": "auditwolf:manage",
818
+ "query": [],
819
+ "input": "json",
820
+ "response": "json",
821
+ "example": {}
822
+ },
823
+ {
824
+ "product": "auditwolf",
825
+ "id": "updateMonitorsByMonitorId",
826
+ "name": "Update Monitor",
827
+ "description": "Change a monitor's name, cadence, anchor, timezone, capture profile or change policy",
828
+ "method": "PATCH",
829
+ "path": "/v1/monitors/{monitorId}",
830
+ "scope": "auditwolf:manage",
831
+ "query": [],
832
+ "input": "none",
833
+ "response": "json"
834
+ },
835
+ {
836
+ "product": "auditwolf",
837
+ "id": "updateRulesByLineageId",
838
+ "name": "Update Rule",
839
+ "description": "Revise a rule",
840
+ "method": "PATCH",
841
+ "path": "/v1/rules/{lineageId}",
842
+ "scope": "auditwolf:manage",
843
+ "query": [],
844
+ "input": "json",
845
+ "response": "json",
846
+ "example": {}
847
+ },
848
+ {
849
+ "product": "auditwolf",
850
+ "id": "updateWebhooksByEndpointId",
851
+ "name": "Update Webhook",
852
+ "description": "Enable or disable an endpoint, or change its subscribed events",
853
+ "method": "PATCH",
854
+ "path": "/v1/webhooks/{endpointId}",
855
+ "scope": "auditwolf:integrations",
856
+ "query": [],
857
+ "input": "none",
858
+ "response": "json"
859
+ },
860
+ {
861
+ "product": "auditwolf",
862
+ "id": "upgradeRulePacksInstalledByInstallationId",
863
+ "name": "Upgrade Rule Pack",
864
+ "description": "Upgrade an installed pack, or change its values",
865
+ "method": "POST",
866
+ "path": "/v1/rule-packs/installed/{installationId}/upgrade",
867
+ "scope": "auditwolf:manage",
868
+ "query": [],
869
+ "input": "json",
870
+ "response": "json",
871
+ "example": {}
872
+ },
873
+ {
874
+ "product": "auditwolf",
875
+ "id": "getUsage",
876
+ "name": "Usage",
877
+ "description": "Credits, quota position, projection and hosted evidence",
878
+ "method": "GET",
879
+ "path": "/v1/usage",
880
+ "scope": "auditwolf:read",
881
+ "query": [],
882
+ "input": "none",
883
+ "response": "json"
884
+ },
885
+ {
886
+ "product": "financewolf",
887
+ "id": "deleteValidationResult",
888
+ "name": "Delete Result",
889
+ "description": "Delete saved result bytes and findings",
890
+ "method": "DELETE",
891
+ "path": "/v1/einvoices/results/{id}",
892
+ "scope": "financewolf:einvoices:write",
893
+ "query": [],
894
+ "input": "none",
895
+ "response": "json"
896
+ },
897
+ {
898
+ "product": "financewolf",
899
+ "id": "generateEInvoice",
900
+ "name": "Generate E-Invoice",
901
+ "description": "Generate and validate one UBL e-invoice",
902
+ "method": "POST",
903
+ "path": "/v1/einvoices/generate",
904
+ "scope": "financewolf:einvoices:write",
905
+ "query": [
906
+ {
907
+ "name": "ruleset",
908
+ "label": "Ruleset",
909
+ "type": "string",
910
+ "required": true,
911
+ "default": "latest",
912
+ "description": "",
913
+ "enum": []
914
+ },
915
+ {
916
+ "name": "profile",
917
+ "label": "Profile",
918
+ "type": "string",
919
+ "required": true,
920
+ "default": "peppol-bis-billing-3",
921
+ "description": "",
922
+ "enum": [
923
+ "peppol-bis-billing-3"
924
+ ]
925
+ }
926
+ ],
927
+ "input": "json",
928
+ "response": "json",
929
+ "example": {
930
+ "input_schema_version": "financewolf/einvoice/generation-input/v1",
931
+ "document_type": "invoice",
932
+ "id": "EXAMPLE-INV-001",
933
+ "issue_date": "2026-09-08",
934
+ "due_date": "2026-10-08",
935
+ "currency": "GBP",
936
+ "buyer_reference": "BUYER-REF-001",
937
+ "seller": {
938
+ "name": "Example Supplier Ltd",
939
+ "endpoint": {
940
+ "scheme": "0088",
941
+ "value": "7300010000001"
942
+ },
943
+ "legal_identifier": {
944
+ "value": "12345678"
945
+ },
946
+ "vat_identifier": "GB123456789",
947
+ "address": {
948
+ "street": "1 Example Street",
949
+ "city": "London",
950
+ "postal_code": "SW1A 1AA",
951
+ "country": "GB"
952
+ }
953
+ },
954
+ "buyer": {
955
+ "name": "Example Buyer Ltd",
956
+ "endpoint": {
957
+ "scheme": "0088",
958
+ "value": "7300010000001"
959
+ },
960
+ "legal_identifier": {
961
+ "value": "87654321"
962
+ },
963
+ "address": {
964
+ "street": "2 Example Street",
965
+ "city": "London",
966
+ "postal_code": "SW1A 2AA",
967
+ "country": "GB"
968
+ }
969
+ },
970
+ "lines": [
971
+ {
972
+ "id": "1",
973
+ "quantity": "2",
974
+ "unit": "C62",
975
+ "price_amount": "12.50",
976
+ "item": {
977
+ "name": "Example service"
978
+ },
979
+ "tax": {
980
+ "category": "S",
981
+ "rate": "20"
982
+ }
983
+ }
984
+ ]
985
+ },
986
+ "idempotency": true,
987
+ "public": true
988
+ },
989
+ {
990
+ "product": "financewolf",
991
+ "id": "getValidationResult",
992
+ "name": "Get Result",
993
+ "description": "Read a saved validation or generation result",
994
+ "method": "GET",
995
+ "path": "/v1/einvoices/results/{id}",
996
+ "scope": "financewolf:einvoices:read",
997
+ "query": [],
998
+ "input": "none",
999
+ "response": "json"
1000
+ },
1001
+ {
1002
+ "product": "financewolf",
1003
+ "id": "getEInvoiceRuleset",
1004
+ "name": "Get Ruleset",
1005
+ "description": "Fetch one ruleset by its immutable id",
1006
+ "method": "GET",
1007
+ "path": "/v1/einvoices/rulesets/{id}",
1008
+ "scope": "financewolf:einvoices:rulesets:read",
1009
+ "query": [],
1010
+ "input": "none",
1011
+ "response": "json",
1012
+ "public": true
1013
+ },
1014
+ {
1015
+ "product": "financewolf",
1016
+ "id": "listValidationResults",
1017
+ "name": "List Results",
1018
+ "description": "List saved validation results",
1019
+ "method": "GET",
1020
+ "path": "/v1/einvoices/results",
1021
+ "scope": "financewolf:einvoices:read",
1022
+ "query": [
1023
+ {
1024
+ "name": "before",
1025
+ "label": "Before",
1026
+ "type": "string",
1027
+ "required": false,
1028
+ "default": "",
1029
+ "description": "Last operation ID from the preceding page.",
1030
+ "enum": []
1031
+ }
1032
+ ],
1033
+ "input": "none",
1034
+ "response": "json",
1035
+ "pagination": {
1036
+ "key": "results",
1037
+ "parameter": "before",
1038
+ "size": 20
1039
+ }
1040
+ },
1041
+ {
1042
+ "product": "financewolf",
1043
+ "id": "listEInvoiceRulesets",
1044
+ "name": "List Rulesets",
1045
+ "description": "List rulesets available for selection and reproduction",
1046
+ "method": "GET",
1047
+ "path": "/v1/einvoices/rulesets",
1048
+ "scope": "financewolf:einvoices:rulesets:read",
1049
+ "query": [
1050
+ {
1051
+ "name": "document_type",
1052
+ "label": "Document Type",
1053
+ "type": "string",
1054
+ "required": false,
1055
+ "default": "",
1056
+ "description": "Restrict to one document type. Omit for both. A repeated or unknown query parameter is `400 malformed_request`.",
1057
+ "enum": [
1058
+ "invoice",
1059
+ "credit_note"
1060
+ ]
1061
+ },
1062
+ {
1063
+ "name": "profile",
1064
+ "label": "Profile",
1065
+ "type": "string",
1066
+ "required": false,
1067
+ "default": "",
1068
+ "description": "",
1069
+ "enum": [
1070
+ "peppol-bis-billing-3"
1071
+ ]
1072
+ },
1073
+ {
1074
+ "name": "state",
1075
+ "label": "State",
1076
+ "type": "string",
1077
+ "required": false,
1078
+ "default": "",
1079
+ "description": "Restrict to one lifecycle state.",
1080
+ "enum": [
1081
+ "scheduled",
1082
+ "sendable",
1083
+ "historical"
1084
+ ]
1085
+ }
1086
+ ],
1087
+ "input": "none",
1088
+ "response": "json",
1089
+ "public": true
1090
+ },
1091
+ {
1092
+ "product": "financewolf",
1093
+ "id": "validateEInvoice",
1094
+ "name": "Validate E-Invoice",
1095
+ "description": "Validate one e-invoice XML document",
1096
+ "method": "POST",
1097
+ "path": "/v1/einvoices/validate",
1098
+ "scope": "financewolf:einvoices:write",
1099
+ "query": [
1100
+ {
1101
+ "name": "ruleset",
1102
+ "label": "Ruleset",
1103
+ "type": "string",
1104
+ "required": false,
1105
+ "default": "latest",
1106
+ "description": "`latest` (default) or an exact ruleset id. Read for raw XML bodies only.",
1107
+ "enum": []
1108
+ },
1109
+ {
1110
+ "name": "profile",
1111
+ "label": "Profile",
1112
+ "type": "string",
1113
+ "required": false,
1114
+ "default": "",
1115
+ "description": "Profile family to resolve `latest` within. Omit to detect it from the document. Read for raw XML bodies only.",
1116
+ "enum": [
1117
+ "peppol-bis-billing-3"
1118
+ ]
1119
+ },
1120
+ {
1121
+ "name": "document_type",
1122
+ "label": "Document Type",
1123
+ "type": "string",
1124
+ "required": false,
1125
+ "default": "auto",
1126
+ "description": "Expected document type, or `auto` (default) to detect it from the root element. A mismatch is `422 unsupported_document_type`. Read for raw XML bodies only.",
1127
+ "enum": [
1128
+ "invoice",
1129
+ "credit_note",
1130
+ "auto"
1131
+ ]
1132
+ }
1133
+ ],
1134
+ "input": "xml",
1135
+ "response": "json",
1136
+ "idempotency": true,
1137
+ "public": true
1138
+ },
1139
+ {
1140
+ "product": "renderwolf",
1141
+ "id": "cancelJob",
1142
+ "name": "Cancel Job",
1143
+ "description": "Cancel a job",
1144
+ "method": "DELETE",
1145
+ "path": "/v1/jobs/{id}",
1146
+ "scope": "renderwolf:render",
1147
+ "query": [],
1148
+ "input": "none",
1149
+ "response": "json"
1150
+ },
1151
+ {
1152
+ "product": "renderwolf",
1153
+ "id": "getCapabilities",
1154
+ "name": "Capabilities",
1155
+ "description": "What Renderwolf does, is building and does not offer",
1156
+ "method": "GET",
1157
+ "path": "/v1/capabilities",
1158
+ "scope": "none",
1159
+ "query": [],
1160
+ "input": "none",
1161
+ "response": "json",
1162
+ "public": true
1163
+ },
1164
+ {
1165
+ "product": "renderwolf",
1166
+ "id": "createDestination",
1167
+ "name": "Create Destination",
1168
+ "description": "Register a delivery destination",
1169
+ "method": "POST",
1170
+ "path": "/v1/destinations",
1171
+ "scope": "renderwolf:destinations",
1172
+ "query": [],
1173
+ "input": "json",
1174
+ "response": "json",
1175
+ "example": {
1176
+ "name": "n8n delivery",
1177
+ "url": "https://example.com/webhook"
1178
+ }
1179
+ },
1180
+ {
1181
+ "product": "renderwolf",
1182
+ "id": "createTemplate",
1183
+ "name": "Create Template",
1184
+ "description": "Create a template",
1185
+ "method": "POST",
1186
+ "path": "/v1/templates",
1187
+ "scope": "renderwolf:templates:write",
1188
+ "query": [],
1189
+ "input": "json",
1190
+ "response": "json",
1191
+ "example": {
1192
+ "name": "example-card",
1193
+ "html": "<h1>{{title}}</h1>",
1194
+ "width": 1200,
1195
+ "height": 630
1196
+ }
1197
+ },
1198
+ {
1199
+ "product": "renderwolf",
1200
+ "id": "deleteDestination",
1201
+ "name": "Delete Destination",
1202
+ "description": "Remove a destination",
1203
+ "method": "DELETE",
1204
+ "path": "/v1/destinations/{id}",
1205
+ "scope": "renderwolf:destinations",
1206
+ "query": [],
1207
+ "input": "none",
1208
+ "response": "json"
1209
+ },
1210
+ {
1211
+ "product": "renderwolf",
1212
+ "id": "deleteTemplate",
1213
+ "name": "Delete Template",
1214
+ "description": "Delete a template",
1215
+ "method": "DELETE",
1216
+ "path": "/v1/templates/{id}",
1217
+ "scope": "renderwolf:templates:write",
1218
+ "query": [],
1219
+ "input": "none",
1220
+ "response": "json"
1221
+ },
1222
+ {
1223
+ "product": "renderwolf",
1224
+ "id": "getJobResult",
1225
+ "name": "Download Job Result",
1226
+ "description": "Collect a job's result",
1227
+ "method": "GET",
1228
+ "path": "/v1/jobs/{id}/result",
1229
+ "scope": "renderwolf:render",
1230
+ "query": [],
1231
+ "input": "none",
1232
+ "response": "redirect"
1233
+ },
1234
+ {
1235
+ "product": "renderwolf",
1236
+ "id": "getBatch",
1237
+ "name": "Get Batch",
1238
+ "description": "Poll a batch",
1239
+ "method": "GET",
1240
+ "path": "/v1/batches/{id}",
1241
+ "scope": "renderwolf:render",
1242
+ "query": [],
1243
+ "input": "none",
1244
+ "response": "json"
1245
+ },
1246
+ {
1247
+ "product": "renderwolf",
1248
+ "id": "getDelivery",
1249
+ "name": "Get Delivery",
1250
+ "description": "One delivery, with the body it posted",
1251
+ "method": "GET",
1252
+ "path": "/v1/deliveries/{id}",
1253
+ "scope": "renderwolf:render",
1254
+ "query": [],
1255
+ "input": "none",
1256
+ "response": "json"
1257
+ },
1258
+ {
1259
+ "product": "renderwolf",
1260
+ "id": "getDestination",
1261
+ "name": "Get Destination",
1262
+ "description": "Get a destination",
1263
+ "method": "GET",
1264
+ "path": "/v1/destinations/{id}",
1265
+ "scope": "renderwolf:destinations",
1266
+ "query": [],
1267
+ "input": "none",
1268
+ "response": "json"
1269
+ },
1270
+ {
1271
+ "product": "renderwolf",
1272
+ "id": "getJob",
1273
+ "name": "Get Job",
1274
+ "description": "Poll a job",
1275
+ "method": "GET",
1276
+ "path": "/v1/jobs/{id}",
1277
+ "scope": "renderwolf:render",
1278
+ "query": [],
1279
+ "input": "none",
1280
+ "response": "json"
1281
+ },
1282
+ {
1283
+ "product": "renderwolf",
1284
+ "id": "getTemplate",
1285
+ "name": "Get Template",
1286
+ "description": "Fetch a template",
1287
+ "method": "GET",
1288
+ "path": "/v1/templates/{id}",
1289
+ "scope": "renderwolf:templates:read",
1290
+ "query": [],
1291
+ "input": "none",
1292
+ "response": "json"
1293
+ },
1294
+ {
1295
+ "product": "renderwolf",
1296
+ "id": "listDeliveries",
1297
+ "name": "List Deliveries",
1298
+ "description": "List deliveries",
1299
+ "method": "GET",
1300
+ "path": "/v1/deliveries",
1301
+ "scope": "renderwolf:render",
1302
+ "query": [
1303
+ {
1304
+ "name": "destination",
1305
+ "label": "Destination",
1306
+ "type": "string",
1307
+ "required": false,
1308
+ "default": "",
1309
+ "description": "",
1310
+ "enum": []
1311
+ },
1312
+ {
1313
+ "name": "limit",
1314
+ "label": "Limit",
1315
+ "type": "integer",
1316
+ "required": false,
1317
+ "default": "",
1318
+ "description": "",
1319
+ "enum": []
1320
+ },
1321
+ {
1322
+ "name": "cursor",
1323
+ "label": "Cursor",
1324
+ "type": "string",
1325
+ "required": false,
1326
+ "default": "",
1327
+ "description": "",
1328
+ "enum": []
1329
+ }
1330
+ ],
1331
+ "input": "none",
1332
+ "response": "json",
1333
+ "pagination": {
1334
+ "key": "deliveries",
1335
+ "parameter": "cursor",
1336
+ "size": 100
1337
+ }
1338
+ },
1339
+ {
1340
+ "product": "renderwolf",
1341
+ "id": "listDestinations",
1342
+ "name": "List Destinations",
1343
+ "description": "List destinations",
1344
+ "method": "GET",
1345
+ "path": "/v1/destinations",
1346
+ "scope": "renderwolf:destinations",
1347
+ "query": [],
1348
+ "input": "none",
1349
+ "response": "json"
1350
+ },
1351
+ {
1352
+ "product": "renderwolf",
1353
+ "id": "listJobs",
1354
+ "name": "List Jobs",
1355
+ "description": "List jobs",
1356
+ "method": "GET",
1357
+ "path": "/v1/jobs",
1358
+ "scope": "renderwolf:render",
1359
+ "query": [
1360
+ {
1361
+ "name": "status",
1362
+ "label": "Status",
1363
+ "type": "string",
1364
+ "required": false,
1365
+ "default": "",
1366
+ "description": "",
1367
+ "enum": []
1368
+ },
1369
+ {
1370
+ "name": "limit",
1371
+ "label": "Limit",
1372
+ "type": "integer",
1373
+ "required": false,
1374
+ "default": "",
1375
+ "description": "",
1376
+ "enum": []
1377
+ },
1378
+ {
1379
+ "name": "cursor",
1380
+ "label": "Cursor",
1381
+ "type": "string",
1382
+ "required": false,
1383
+ "default": "",
1384
+ "description": "",
1385
+ "enum": []
1386
+ }
1387
+ ],
1388
+ "input": "none",
1389
+ "response": "json",
1390
+ "pagination": {
1391
+ "key": "jobs",
1392
+ "parameter": "cursor",
1393
+ "size": 100
1394
+ }
1395
+ },
1396
+ {
1397
+ "product": "renderwolf",
1398
+ "id": "listRequests",
1399
+ "name": "List Requests",
1400
+ "description": "Request history",
1401
+ "method": "GET",
1402
+ "path": "/v1/requests",
1403
+ "scope": "renderwolf:usage:read",
1404
+ "query": [
1405
+ {
1406
+ "name": "since",
1407
+ "label": "Since",
1408
+ "type": "string",
1409
+ "required": false,
1410
+ "default": "",
1411
+ "description": "",
1412
+ "enum": []
1413
+ },
1414
+ {
1415
+ "name": "until",
1416
+ "label": "Until",
1417
+ "type": "string",
1418
+ "required": false,
1419
+ "default": "",
1420
+ "description": "",
1421
+ "enum": []
1422
+ },
1423
+ {
1424
+ "name": "outcome",
1425
+ "label": "Outcome",
1426
+ "type": "string",
1427
+ "required": false,
1428
+ "default": "",
1429
+ "description": "",
1430
+ "enum": [
1431
+ "ok",
1432
+ "error",
1433
+ "cancelled"
1434
+ ]
1435
+ },
1436
+ {
1437
+ "name": "kind",
1438
+ "label": "Kind",
1439
+ "type": "string",
1440
+ "required": false,
1441
+ "default": "",
1442
+ "description": "",
1443
+ "enum": [
1444
+ "screenshot",
1445
+ "pdf",
1446
+ "qr",
1447
+ "image",
1448
+ "clip",
1449
+ "site_preview"
1450
+ ]
1451
+ },
1452
+ {
1453
+ "name": "cache",
1454
+ "label": "Cache",
1455
+ "type": "string",
1456
+ "required": false,
1457
+ "default": "",
1458
+ "description": "",
1459
+ "enum": [
1460
+ "hit",
1461
+ "miss"
1462
+ ]
1463
+ },
1464
+ {
1465
+ "name": "key",
1466
+ "label": "Key",
1467
+ "type": "string",
1468
+ "required": false,
1469
+ "default": "",
1470
+ "description": "API key id",
1471
+ "enum": []
1472
+ },
1473
+ {
1474
+ "name": "error",
1475
+ "label": "Error",
1476
+ "type": "string",
1477
+ "required": false,
1478
+ "default": "",
1479
+ "description": "Safe error code",
1480
+ "enum": []
1481
+ },
1482
+ {
1483
+ "name": "id",
1484
+ "label": "ID",
1485
+ "type": "string",
1486
+ "required": false,
1487
+ "default": "",
1488
+ "description": "Request id, job id or your X-Request-ID",
1489
+ "enum": []
1490
+ },
1491
+ {
1492
+ "name": "limit",
1493
+ "label": "Limit",
1494
+ "type": "integer",
1495
+ "required": false,
1496
+ "default": 50,
1497
+ "description": "",
1498
+ "enum": []
1499
+ },
1500
+ {
1501
+ "name": "offset",
1502
+ "label": "Offset",
1503
+ "type": "integer",
1504
+ "required": false,
1505
+ "default": 0,
1506
+ "description": "",
1507
+ "enum": []
1508
+ }
1509
+ ],
1510
+ "input": "none",
1511
+ "response": "json",
1512
+ "pagination": {
1513
+ "key": "requests",
1514
+ "parameter": "offset",
1515
+ "size": 200
1516
+ }
1517
+ },
1518
+ {
1519
+ "product": "renderwolf",
1520
+ "id": "listTemplates",
1521
+ "name": "List Templates",
1522
+ "description": "List templates",
1523
+ "method": "GET",
1524
+ "path": "/v1/templates",
1525
+ "scope": "renderwolf:templates:read",
1526
+ "query": [
1527
+ {
1528
+ "name": "cursor",
1529
+ "label": "Cursor",
1530
+ "type": "string",
1531
+ "required": false,
1532
+ "default": "",
1533
+ "description": "Opaque next_cursor from the previous page.",
1534
+ "enum": []
1535
+ },
1536
+ {
1537
+ "name": "limit",
1538
+ "label": "Limit",
1539
+ "type": "integer",
1540
+ "required": false,
1541
+ "default": 50,
1542
+ "description": "Maximum templates per page.",
1543
+ "enum": []
1544
+ },
1545
+ {
1546
+ "name": "summary",
1547
+ "label": "Summary",
1548
+ "type": "boolean",
1549
+ "required": false,
1550
+ "default": false,
1551
+ "description": "Omit HTML bodies from the database read.",
1552
+ "enum": []
1553
+ }
1554
+ ],
1555
+ "input": "none",
1556
+ "response": "json",
1557
+ "pagination": {
1558
+ "key": "templates",
1559
+ "parameter": "cursor",
1560
+ "size": 100
1561
+ }
1562
+ },
1563
+ {
1564
+ "product": "renderwolf",
1565
+ "id": "createQr",
1566
+ "name": "QR Code",
1567
+ "description": "Render a QR code",
1568
+ "method": "POST",
1569
+ "path": "/v1/qr",
1570
+ "scope": "renderwolf:render",
1571
+ "query": [],
1572
+ "input": "json",
1573
+ "response": "binary",
1574
+ "example": {
1575
+ "data": "https://example.com/menu"
1576
+ }
1577
+ },
1578
+ {
1579
+ "product": "renderwolf",
1580
+ "id": "redeliverDelivery",
1581
+ "name": "Redeliver Delivery",
1582
+ "description": "Send a delivery again",
1583
+ "method": "POST",
1584
+ "path": "/v1/deliveries/{id}/redeliver",
1585
+ "scope": "renderwolf:destinations",
1586
+ "query": [],
1587
+ "input": "none",
1588
+ "response": "json"
1589
+ },
1590
+ {
1591
+ "product": "renderwolf",
1592
+ "id": "createSitePreview",
1593
+ "name": "Site Preview",
1594
+ "description": "Render a scrolling website preview",
1595
+ "method": "POST",
1596
+ "path": "/v1/site-preview",
1597
+ "scope": "renderwolf:render",
1598
+ "query": [],
1599
+ "input": "json",
1600
+ "response": "multipart",
1601
+ "example": {
1602
+ "url": "https://example.com",
1603
+ "width": 672,
1604
+ "height": 494,
1605
+ "motion": "per_page"
1606
+ }
1607
+ },
1608
+ {
1609
+ "product": "renderwolf",
1610
+ "id": "submitBatch",
1611
+ "name": "Submit Batch",
1612
+ "description": "Submit up to 100 jobs together",
1613
+ "method": "POST",
1614
+ "path": "/v1/batches",
1615
+ "scope": "renderwolf:render",
1616
+ "query": [],
1617
+ "input": "json",
1618
+ "response": "json",
1619
+ "example": {
1620
+ "items": [
1621
+ {
1622
+ "kind": "screenshot",
1623
+ "request": {
1624
+ "url": "https://example.com"
1625
+ }
1626
+ }
1627
+ ]
1628
+ },
1629
+ "idempotency": true
1630
+ },
1631
+ {
1632
+ "product": "renderwolf",
1633
+ "id": "submitJob",
1634
+ "name": "Submit Job",
1635
+ "description": "Submit a durable render job",
1636
+ "method": "POST",
1637
+ "path": "/v1/jobs",
1638
+ "scope": "renderwolf:render",
1639
+ "query": [],
1640
+ "input": "json",
1641
+ "response": "json",
1642
+ "example": {
1643
+ "kind": "screenshot",
1644
+ "request": {
1645
+ "url": "https://example.com"
1646
+ }
1647
+ },
1648
+ "idempotency": true
1649
+ },
1650
+ {
1651
+ "product": "renderwolf",
1652
+ "id": "testDestination",
1653
+ "name": "Test Destination",
1654
+ "description": "Test a destination now",
1655
+ "method": "POST",
1656
+ "path": "/v1/destinations/{id}/test",
1657
+ "scope": "renderwolf:destinations",
1658
+ "query": [],
1659
+ "input": "none",
1660
+ "response": "json"
1661
+ },
1662
+ {
1663
+ "product": "renderwolf",
1664
+ "id": "updateDestination",
1665
+ "name": "Update Destination",
1666
+ "description": "Rename or enable a destination",
1667
+ "method": "PATCH",
1668
+ "path": "/v1/destinations/{id}",
1669
+ "scope": "renderwolf:destinations",
1670
+ "query": [],
1671
+ "input": "json",
1672
+ "response": "json",
1673
+ "example": {}
1674
+ },
1675
+ {
1676
+ "product": "renderwolf",
1677
+ "id": "updateTemplate",
1678
+ "name": "Update Template",
1679
+ "description": "Replace a template",
1680
+ "method": "PUT",
1681
+ "path": "/v1/templates/{id}",
1682
+ "scope": "renderwolf:templates:write",
1683
+ "query": [],
1684
+ "input": "json",
1685
+ "response": "json",
1686
+ "example": {
1687
+ "name": "example-card",
1688
+ "html": "<h1>{{title}}</h1>",
1689
+ "width": 1200,
1690
+ "height": 630
1691
+ }
1692
+ },
1693
+ {
1694
+ "product": "tools",
1695
+ "id": "convertImage",
1696
+ "name": "Convert Image",
1697
+ "description": "Convert Image",
1698
+ "method": "POST",
1699
+ "path": "/v1/convert",
1700
+ "scope": "none",
1701
+ "query": [],
1702
+ "input": "upload",
1703
+ "response": "binary",
1704
+ "example": {
1705
+ "format": "png"
1706
+ },
1707
+ "public": true
1708
+ },
1709
+ {
1710
+ "product": "tools",
1711
+ "id": "createFavicon",
1712
+ "name": "Create Favicon ZIP",
1713
+ "description": "Create Favicon ZIP",
1714
+ "method": "POST",
1715
+ "path": "/v1/favicon",
1716
+ "scope": "none",
1717
+ "query": [],
1718
+ "input": "upload",
1719
+ "response": "binary",
1720
+ "example": {
1721
+ "fit": "pad",
1722
+ "bg": "transparent"
1723
+ },
1724
+ "public": true
1725
+ },
1726
+ {
1727
+ "product": "tools",
1728
+ "id": "freeScreenshot",
1729
+ "name": "Free Screenshot",
1730
+ "description": "Free Screenshot",
1731
+ "method": "POST",
1732
+ "path": "/v1/screenshot",
1733
+ "scope": "none",
1734
+ "query": [],
1735
+ "input": "json",
1736
+ "response": "binary",
1737
+ "example": {
1738
+ "url": "https://example.com",
1739
+ "width": 1280
1740
+ },
1741
+ "public": true
1742
+ },
1743
+ {
1744
+ "product": "tools",
1745
+ "id": "generateQr",
1746
+ "name": "Generate QR Code",
1747
+ "description": "Generate QR Code",
1748
+ "method": "POST",
1749
+ "path": "/v1/qr",
1750
+ "scope": "none",
1751
+ "query": [],
1752
+ "input": "json",
1753
+ "response": "binary",
1754
+ "example": {
1755
+ "data": "https://example.com"
1756
+ },
1757
+ "public": true
1758
+ },
1759
+ {
1760
+ "product": "tools",
1761
+ "id": "generateUuid",
1762
+ "name": "Generate UUID",
1763
+ "description": "Generate UUID",
1764
+ "method": "POST",
1765
+ "path": "/v1/uuid",
1766
+ "scope": "none",
1767
+ "query": [],
1768
+ "input": "json",
1769
+ "response": "json",
1770
+ "example": {
1771
+ "version": "v7",
1772
+ "count": 1
1773
+ },
1774
+ "public": true
1775
+ },
1776
+ {
1777
+ "product": "tools",
1778
+ "id": "inspectUuid",
1779
+ "name": "Inspect UUID",
1780
+ "description": "Inspect UUID",
1781
+ "method": "POST",
1782
+ "path": "/v1/uuid/inspect",
1783
+ "scope": "none",
1784
+ "query": [],
1785
+ "input": "json",
1786
+ "response": "json",
1787
+ "example": {
1788
+ "value": "01900000-0000-7000-8000-000000000000"
1789
+ },
1790
+ "public": true
1791
+ },
1792
+ {
1793
+ "product": "tools",
1794
+ "id": "verifyQr",
1795
+ "name": "Verify QR Code",
1796
+ "description": "Verify QR Code",
1797
+ "method": "POST",
1798
+ "path": "/v1/qr/verify",
1799
+ "scope": "none",
1800
+ "query": [],
1801
+ "input": "upload",
1802
+ "response": "json",
1803
+ "example": {},
1804
+ "public": true
1805
+ }
1806
+ ];