@supscale/sculdoc-client 0.1.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.
@@ -0,0 +1,4322 @@
1
+ export interface paths {
2
+ "/me": {
3
+ parameters: {
4
+ query?: never;
5
+ header?: never;
6
+ path?: never;
7
+ cookie?: never;
8
+ };
9
+ /** Who am I: user and organizations, or API key and its organization */
10
+ get: operations["getMe"];
11
+ put?: never;
12
+ post?: never;
13
+ delete?: never;
14
+ options?: never;
15
+ head?: never;
16
+ patch?: never;
17
+ trace?: never;
18
+ };
19
+ "/folders": {
20
+ parameters: {
21
+ query?: never;
22
+ header?: never;
23
+ path?: never;
24
+ cookie?: never;
25
+ };
26
+ /** Folder tree of the organization (flat list, linked by parentId) */
27
+ get: operations["listFolders"];
28
+ put?: never;
29
+ post?: never;
30
+ delete?: never;
31
+ options?: never;
32
+ head?: never;
33
+ patch?: never;
34
+ trace?: never;
35
+ };
36
+ "/folders/{folderId}": {
37
+ parameters: {
38
+ query?: never;
39
+ header?: never;
40
+ path?: never;
41
+ cookie?: never;
42
+ };
43
+ /** Get a folder */
44
+ get: operations["getFolder"];
45
+ put?: never;
46
+ post?: never;
47
+ delete?: never;
48
+ options?: never;
49
+ head?: never;
50
+ patch?: never;
51
+ trace?: never;
52
+ };
53
+ "/templates": {
54
+ parameters: {
55
+ query?: never;
56
+ header?: never;
57
+ path?: never;
58
+ cookie?: never;
59
+ };
60
+ /** List templates (optionally of one folder; folderId=root for the root) */
61
+ get: operations["listTemplates"];
62
+ put?: never;
63
+ /** Create a template (empty: save a draft next) */
64
+ post: operations["createTemplate"];
65
+ delete?: never;
66
+ options?: never;
67
+ head?: never;
68
+ patch?: never;
69
+ trace?: never;
70
+ };
71
+ "/templates/{template}": {
72
+ parameters: {
73
+ query?: never;
74
+ header?: never;
75
+ path?: never;
76
+ cookie?: never;
77
+ };
78
+ /** Get a template by id or slug */
79
+ get: operations["getTemplate"];
80
+ put?: never;
81
+ post?: never;
82
+ delete?: never;
83
+ options?: never;
84
+ head?: never;
85
+ patch?: never;
86
+ trace?: never;
87
+ };
88
+ "/templates/{template}/versions": {
89
+ parameters: {
90
+ query?: never;
91
+ header?: never;
92
+ path?: never;
93
+ cookie?: never;
94
+ };
95
+ /** Version history (draft first, then newest to oldest) */
96
+ get: operations["listVersions"];
97
+ put?: never;
98
+ post?: never;
99
+ delete?: never;
100
+ options?: never;
101
+ head?: never;
102
+ patch?: never;
103
+ trace?: never;
104
+ };
105
+ "/templates/{template}/versions/draft": {
106
+ parameters: {
107
+ query?: never;
108
+ header?: never;
109
+ path?: never;
110
+ cookie?: never;
111
+ };
112
+ get?: never;
113
+ /** Create or replace the single draft of a template */
114
+ put: operations["saveDraft"];
115
+ post?: never;
116
+ /** Discard the draft */
117
+ delete: operations["deleteDraft"];
118
+ options?: never;
119
+ head?: never;
120
+ patch?: never;
121
+ trace?: never;
122
+ };
123
+ "/templates/{template}/versions/draft/publish": {
124
+ parameters: {
125
+ query?: never;
126
+ header?: never;
127
+ path?: never;
128
+ cookie?: never;
129
+ };
130
+ get?: never;
131
+ put?: never;
132
+ /**
133
+ * Publish the draft as the next immutable version
134
+ * @description Checks: valid SDM document, at least one sample, includes pinned by version and hash, assets resolved, data schema covering every path the template uses, samples valid against the schema. All issues are reported at once (422). Font families are resolved against the organization depot, then the platform depot; a family in neither is substituted by a platform family, pinned in the version and reported in `warnings`.
135
+ */
136
+ post: operations["publishDraft"];
137
+ delete?: never;
138
+ options?: never;
139
+ head?: never;
140
+ patch?: never;
141
+ trace?: never;
142
+ };
143
+ "/templates/{template}/diff": {
144
+ parameters: {
145
+ query?: never;
146
+ header?: never;
147
+ path?: never;
148
+ cookie?: never;
149
+ };
150
+ /** Structural diff of the IR (by node id) and diff of the data schema between two versions */
151
+ get: operations["diffVersions"];
152
+ put?: never;
153
+ post?: never;
154
+ delete?: never;
155
+ options?: never;
156
+ head?: never;
157
+ patch?: never;
158
+ trace?: never;
159
+ };
160
+ "/templates/{template}/check": {
161
+ parameters: {
162
+ query?: never;
163
+ header?: never;
164
+ path?: never;
165
+ cookie?: never;
166
+ };
167
+ get?: never;
168
+ put?: never;
169
+ /**
170
+ * Dry run of a publication: inline content checked like the draft at publication, and diffed
171
+ * @description Templates as code (pull requests): the content is checked exactly like `POST …/versions/draft/publish` would check the draft (all issues at once, in `issues`), nothing is stored, and it is diffed against `against` (`latest` by default). The template may not exist yet: `against` and `diff` are then null. Assets and fonts must already be deposited (content-addressed).
172
+ */
173
+ post: operations["checkPublication"];
174
+ delete?: never;
175
+ options?: never;
176
+ head?: never;
177
+ patch?: never;
178
+ trace?: never;
179
+ };
180
+ "/templates/{template}/versions/{version}": {
181
+ parameters: {
182
+ query?: never;
183
+ header?: never;
184
+ path?: never;
185
+ cookie?: never;
186
+ };
187
+ /** Get a version with its content */
188
+ get: operations["getVersion"];
189
+ put?: never;
190
+ post?: never;
191
+ delete?: never;
192
+ options?: never;
193
+ head?: never;
194
+ patch?: never;
195
+ trace?: never;
196
+ };
197
+ "/templates/{template}/versions/{version}/schema": {
198
+ parameters: {
199
+ query?: never;
200
+ header?: never;
201
+ path?: never;
202
+ cookie?: never;
203
+ };
204
+ /** Data contract of a version (JSON Schema 2020-12) */
205
+ get: operations["getVersionSchema"];
206
+ put?: never;
207
+ post?: never;
208
+ delete?: never;
209
+ options?: never;
210
+ head?: never;
211
+ patch?: never;
212
+ trace?: never;
213
+ };
214
+ "/templates/{template}/versions/{version}/samples": {
215
+ parameters: {
216
+ query?: never;
217
+ header?: never;
218
+ path?: never;
219
+ cookie?: never;
220
+ };
221
+ /** Samples of a version (named data sets: preview, tests, documentation, `sample` of renders) */
222
+ get: operations["listSamples"];
223
+ put?: never;
224
+ post?: never;
225
+ delete?: never;
226
+ options?: never;
227
+ head?: never;
228
+ patch?: never;
229
+ trace?: never;
230
+ };
231
+ "/templates/{template}/versions/{version}/samples/{sample}": {
232
+ parameters: {
233
+ query?: never;
234
+ header?: never;
235
+ path?: never;
236
+ cookie?: never;
237
+ };
238
+ /** One sample of a version */
239
+ get: operations["getSample"];
240
+ put?: never;
241
+ post?: never;
242
+ delete?: never;
243
+ options?: never;
244
+ head?: never;
245
+ patch?: never;
246
+ trace?: never;
247
+ };
248
+ "/templates/{template}/versions/draft/samples/{sample}": {
249
+ parameters: {
250
+ query?: never;
251
+ header?: never;
252
+ path?: never;
253
+ cookie?: never;
254
+ };
255
+ get?: never;
256
+ /**
257
+ * Add a sample to the draft, or replace the data of the sample of that name
258
+ * @description At most 50 samples. Samples are checked against the data schema at publication.
259
+ */
260
+ put: operations["putDraftSample"];
261
+ post?: never;
262
+ /** Remove a sample from the draft */
263
+ delete: operations["deleteDraftSample"];
264
+ options?: never;
265
+ head?: never;
266
+ /** Rename a sample of the draft */
267
+ patch: operations["renameDraftSample"];
268
+ trace?: never;
269
+ };
270
+ "/templates/{template}/versions/{version}/docs": {
271
+ parameters: {
272
+ query?: never;
273
+ header?: never;
274
+ path?: never;
275
+ cookie?: never;
276
+ };
277
+ /**
278
+ * Generated documentation of a version: changelog, output profile, data contract, samples, calls
279
+ * @description JSON by default; `format=html` (or `Accept: text/html`) returns a standalone HTML page in French or English (`lang`), with the first page of each sample rendered by the engine and embedded. The thumbnails of a published version are cached; `GET …/samples/{sample}/preview.png` serves them one by one.
280
+ */
281
+ get: operations["getVersionDocs"];
282
+ put?: never;
283
+ post?: never;
284
+ delete?: never;
285
+ options?: never;
286
+ head?: never;
287
+ patch?: never;
288
+ trace?: never;
289
+ };
290
+ "/assets": {
291
+ parameters: {
292
+ query?: never;
293
+ header?: never;
294
+ path?: never;
295
+ cookie?: never;
296
+ };
297
+ /** Assets visible to the organization (its own and the platform ones) */
298
+ get: operations["listAssets"];
299
+ put?: never;
300
+ /** Upload an asset (content-addressed: the same bytes are stored once) */
301
+ post: operations["createAsset"];
302
+ delete?: never;
303
+ options?: never;
304
+ head?: never;
305
+ patch?: never;
306
+ trace?: never;
307
+ };
308
+ "/fonts": {
309
+ parameters: {
310
+ query?: never;
311
+ header?: never;
312
+ path?: never;
313
+ cookie?: never;
314
+ };
315
+ /**
316
+ * Fonts a template may name: organization depot, then platform depot (ADR-013)
317
+ * @description `families` lists each family once, with the scope that provides it at publication (an organization font shadows a platform family of the same name). A family in neither depot is substituted by a platform family at publication, and reported.
318
+ */
319
+ get: operations["listFonts"];
320
+ put?: never;
321
+ /**
322
+ * Deposit a font of the organization (TTF, OTF or TTC; content-addressed)
323
+ * @description The organization holds the license of the fonts it deposits (ADR-013): `fsType` and the license mention are recorded as information, never as a refusal. Depositing the same bytes again returns the existing font (200).
324
+ */
325
+ post: operations["createFont"];
326
+ delete?: never;
327
+ options?: never;
328
+ head?: never;
329
+ patch?: never;
330
+ trace?: never;
331
+ };
332
+ "/renders": {
333
+ parameters: {
334
+ query?: never;
335
+ header?: never;
336
+ path?: never;
337
+ cookie?: never;
338
+ };
339
+ /**
340
+ * Render journal of the organization
341
+ * @description Every render, successful or not, newest first by default. Filters combine; pages follow `nextCursor` (null on the last page).
342
+ */
343
+ get: operations["listRenders"];
344
+ put?: never;
345
+ /**
346
+ * Render a document synchronously (light limits)
347
+ * @description Validates `data` against the schema of the version, renders in an isolated engine process, stores the PDF and its manifest. Returns the PDF by default, or JSON (render + signed URL) with `Accept: application/json`. Documents beyond the light limits go through POST /jobs.
348
+ */
349
+ post: operations["createRender"];
350
+ delete?: never;
351
+ options?: never;
352
+ head?: never;
353
+ patch?: never;
354
+ trace?: never;
355
+ };
356
+ "/renders/{renderId}": {
357
+ parameters: {
358
+ query?: never;
359
+ header?: never;
360
+ path?: never;
361
+ cookie?: never;
362
+ };
363
+ /** A render: manifest, hashes, download link, post-processing chain, seal */
364
+ get: operations["getRender"];
365
+ put?: never;
366
+ post?: never;
367
+ delete?: never;
368
+ options?: never;
369
+ head?: never;
370
+ patch?: never;
371
+ trace?: never;
372
+ };
373
+ "/renders/{renderId}/verify": {
374
+ parameters: {
375
+ query?: never;
376
+ header?: never;
377
+ path?: never;
378
+ cookie?: never;
379
+ };
380
+ get?: never;
381
+ put?: never;
382
+ /**
383
+ * Control re-render: same version, same data, same creation date → PDF hashes compared
384
+ * @description Renders again from the snapshot of the version (light limits), with the data of the render: kept by the organization (`keepRenderData`), still held by its job, or sent in `data` (checked against the recorded hash). A sealed document is compared before its seal. Nothing is stored.
385
+ */
386
+ post: operations["verifyRender"];
387
+ delete?: never;
388
+ options?: never;
389
+ head?: never;
390
+ patch?: never;
391
+ trace?: never;
392
+ };
393
+ "/documents/{documentId}": {
394
+ parameters: {
395
+ query?: never;
396
+ header?: never;
397
+ path?: never;
398
+ cookie?: never;
399
+ };
400
+ /**
401
+ * Signed URL of a stored PDF (the document id is the render id)
402
+ * @description `410 document.expired` once the retention of the organization has deleted it; `409 document.intermediate` for an item of a sealed merged batch (only the sealed merged document is handed out).
403
+ */
404
+ get: operations["getDocument"];
405
+ put?: never;
406
+ post?: never;
407
+ delete?: never;
408
+ options?: never;
409
+ head?: never;
410
+ patch?: never;
411
+ trace?: never;
412
+ };
413
+ "/jobs": {
414
+ parameters: {
415
+ query?: never;
416
+ header?: never;
417
+ path?: never;
418
+ cookie?: never;
419
+ };
420
+ /**
421
+ * Jobs of the organization
422
+ * @description Newest first by default; same filters as the render journal; pages follow `nextCursor`.
423
+ */
424
+ get: operations["listJobs"];
425
+ put?: never;
426
+ /**
427
+ * Render asynchronously, one document or a batch; poll GET /jobs/{id} or give a `callbackUrl`
428
+ * @description One document (`data` or `sample`), or a batch (`items`, 1 000 at most): every item is validated at submission (422 with the paths of the faulty items), then rendered in parallel within the quotas of the organization, one render and one manifest each; `output` says what the batch delivers (GET /jobs/{id}/output). Queue `light` when the template bounds its pages within the light limits (`meta.limits.maxPages`), `heavy` otherwise. With `Idempotency-Key`, the first response is replayed for 24 hours to the same request; the same key with another request is a 409.
429
+ */
430
+ post: operations["createJob"];
431
+ delete?: never;
432
+ options?: never;
433
+ head?: never;
434
+ patch?: never;
435
+ trace?: never;
436
+ };
437
+ "/jobs/{jobId}": {
438
+ parameters: {
439
+ query?: never;
440
+ header?: never;
441
+ path?: never;
442
+ cookie?: never;
443
+ };
444
+ /**
445
+ * Job status; `renderId` names the render (and the document) once succeeded
446
+ * @description A batch reports the progress of its items (`progress`); its documents are listed by GET /jobs/{id}/items, its archive or merged PDF is given by GET /jobs/{id}/output.
447
+ */
448
+ get: operations["getJob"];
449
+ put?: never;
450
+ post?: never;
451
+ delete?: never;
452
+ options?: never;
453
+ head?: never;
454
+ patch?: never;
455
+ trace?: never;
456
+ };
457
+ "/jobs/{jobId}/items": {
458
+ parameters: {
459
+ query?: never;
460
+ header?: never;
461
+ path?: never;
462
+ cookie?: never;
463
+ };
464
+ /**
465
+ * Items of a batch, in the order of the request, with their render and their error
466
+ * @description A succeeded item names its render (`renderId`, GET /renders/{id}) and its document (GET /documents/{id}); a failed item carries its error. Pages follow `nextCursor`.
467
+ */
468
+ get: operations["listJobItems"];
469
+ put?: never;
470
+ post?: never;
471
+ delete?: never;
472
+ options?: never;
473
+ head?: never;
474
+ patch?: never;
475
+ trace?: never;
476
+ };
477
+ "/jobs/{jobId}/output": {
478
+ parameters: {
479
+ query?: never;
480
+ header?: never;
481
+ path?: never;
482
+ cookie?: never;
483
+ };
484
+ /**
485
+ * Signed URL of the archive (`zip`) or of the merged PDF (`merged`) of a succeeded batch
486
+ * @description `410 document.expired` once the retention of the organization has deleted it.
487
+ */
488
+ get: operations["getJobOutput"];
489
+ put?: never;
490
+ post?: never;
491
+ delete?: never;
492
+ options?: never;
493
+ head?: never;
494
+ patch?: never;
495
+ trace?: never;
496
+ };
497
+ "/jobs/{jobId}/deliveries": {
498
+ parameters: {
499
+ query?: never;
500
+ header?: never;
501
+ path?: never;
502
+ cookie?: never;
503
+ };
504
+ /** Notifications of the `callbackUrl` of a job, with their attempts */
505
+ get: operations["listJobDeliveries"];
506
+ put?: never;
507
+ post?: never;
508
+ delete?: never;
509
+ options?: never;
510
+ head?: never;
511
+ patch?: never;
512
+ trace?: never;
513
+ };
514
+ "/validate": {
515
+ parameters: {
516
+ query?: never;
517
+ header?: never;
518
+ path?: never;
519
+ cookie?: never;
520
+ };
521
+ get?: never;
522
+ put?: never;
523
+ /** Dry run: validate an inline template, or data against the schema of a version */
524
+ post: operations["validate"];
525
+ delete?: never;
526
+ options?: never;
527
+ head?: never;
528
+ patch?: never;
529
+ trace?: never;
530
+ };
531
+ }
532
+ export type webhooks = Record<string, never>;
533
+ export interface components {
534
+ schemas: {
535
+ Organization: {
536
+ id: string;
537
+ slug: string;
538
+ name: string;
539
+ logo: string | null;
540
+ /** Format: date-time */
541
+ createdAt: string;
542
+ };
543
+ Error: {
544
+ error: {
545
+ /** @example validation */
546
+ code: string;
547
+ message: string;
548
+ path?: string;
549
+ issues: {
550
+ /** @example $.items[2].total */
551
+ path: string;
552
+ message: string;
553
+ }[];
554
+ /** @description 429: seconds before the same request may succeed (also in the `Retry-After` header) */
555
+ retryAfter?: number;
556
+ };
557
+ requestId: string;
558
+ };
559
+ Folder: {
560
+ id: string;
561
+ parentId: string | null;
562
+ name: string;
563
+ /** Format: date-time */
564
+ createdAt: string;
565
+ /** Format: date-time */
566
+ updatedAt: string;
567
+ };
568
+ Template: {
569
+ id: string;
570
+ folderId: string | null;
571
+ slug: string;
572
+ name: string;
573
+ description: string;
574
+ /** Format: date-time */
575
+ createdAt: string;
576
+ /** Format: date-time */
577
+ updatedAt: string;
578
+ };
579
+ VersionSummary: {
580
+ id: string;
581
+ /** @description null while draft */
582
+ number: number | null;
583
+ /** @enum {string} */
584
+ status: "draft" | "published" | "deprecated" | "archived";
585
+ changelog: string | null;
586
+ contentHash: string | null;
587
+ rollbackOf: number | null;
588
+ publishedBy: string | null;
589
+ /** Format: date-time */
590
+ publishedAt: string | null;
591
+ /** Format: date-time */
592
+ deprecatedAt: string | null;
593
+ /** Format: date-time */
594
+ archivedAt: string | null;
595
+ /** Format: date-time */
596
+ createdAt: string;
597
+ /** Format: date-time */
598
+ updatedAt: string;
599
+ };
600
+ Version: {
601
+ id: string;
602
+ /** @description null while draft */
603
+ number: number | null;
604
+ /** @enum {string} */
605
+ status: "draft" | "published" | "deprecated" | "archived";
606
+ changelog: string | null;
607
+ contentHash: string | null;
608
+ rollbackOf: number | null;
609
+ publishedBy: string | null;
610
+ /** Format: date-time */
611
+ publishedAt: string | null;
612
+ /** Format: date-time */
613
+ deprecatedAt: string | null;
614
+ /** Format: date-time */
615
+ archivedAt: string | null;
616
+ /** Format: date-time */
617
+ createdAt: string;
618
+ /** Format: date-time */
619
+ updatedAt: string;
620
+ /** @description SDM document (packages/model) */
621
+ ir: {
622
+ [key: string]: unknown;
623
+ };
624
+ /** @description JSON Schema 2020-12 of the data */
625
+ dataSchema: {
626
+ [key: string]: unknown;
627
+ } | null;
628
+ samples: components["schemas"]["Sample"][];
629
+ fingerprints: {
630
+ [key: string]: unknown;
631
+ } | null;
632
+ engine: {
633
+ typst: string;
634
+ codegen: string;
635
+ sdm: string;
636
+ } | null;
637
+ };
638
+ Sample: {
639
+ /** @example facture-standard */
640
+ name: string;
641
+ data?: unknown;
642
+ };
643
+ PublishedVersion: {
644
+ id: string;
645
+ /** @description null while draft */
646
+ number: number | null;
647
+ /** @enum {string} */
648
+ status: "draft" | "published" | "deprecated" | "archived";
649
+ changelog: string | null;
650
+ contentHash: string | null;
651
+ rollbackOf: number | null;
652
+ publishedBy: string | null;
653
+ /** Format: date-time */
654
+ publishedAt: string | null;
655
+ /** Format: date-time */
656
+ deprecatedAt: string | null;
657
+ /** Format: date-time */
658
+ archivedAt: string | null;
659
+ /** Format: date-time */
660
+ createdAt: string;
661
+ /** Format: date-time */
662
+ updatedAt: string;
663
+ /** @description SDM document (packages/model) */
664
+ ir: {
665
+ [key: string]: unknown;
666
+ };
667
+ /** @description JSON Schema 2020-12 of the data */
668
+ dataSchema: {
669
+ [key: string]: unknown;
670
+ } | null;
671
+ samples: components["schemas"]["Sample"][];
672
+ fingerprints: {
673
+ [key: string]: unknown;
674
+ } | null;
675
+ engine: {
676
+ typst: string;
677
+ codegen: string;
678
+ sdm: string;
679
+ } | null;
680
+ /** @description Reported without refusing the publication: font families substituted */
681
+ warnings: {
682
+ path: string;
683
+ message: string;
684
+ }[];
685
+ };
686
+ VersionDiff: {
687
+ from: {
688
+ number: number | null;
689
+ /** @enum {string} */
690
+ status: "draft" | "published" | "deprecated" | "archived";
691
+ contentHash: string | null;
692
+ };
693
+ to: {
694
+ number: number | null;
695
+ /** @enum {string} */
696
+ status: "draft" | "published" | "deprecated" | "archived";
697
+ contentHash: string | null;
698
+ };
699
+ ir: {
700
+ nodes: {
701
+ id: string;
702
+ type: string;
703
+ /** @enum {string} */
704
+ kind: "added" | "removed" | "changed" | "moved";
705
+ parent: string;
706
+ }[];
707
+ sections: string[];
708
+ identical: boolean;
709
+ };
710
+ schema: {
711
+ path: string;
712
+ /** @enum {string} */
713
+ kind: "added" | "removed" | "type-changed" | "required-added" | "required-removed";
714
+ breaking: boolean;
715
+ from?: unknown;
716
+ to?: unknown;
717
+ }[];
718
+ breaking: boolean;
719
+ };
720
+ PublicationCheck: {
721
+ valid: boolean;
722
+ /** @description Why the publication would be refused (JSON paths) */
723
+ issues: {
724
+ path: string;
725
+ message: string;
726
+ }[];
727
+ /** @description Font families that would be substituted */
728
+ warnings: {
729
+ path: string;
730
+ message: string;
731
+ }[];
732
+ /** @description Content hash the publication would freeze */
733
+ contentHash: string | null;
734
+ /** @description Version compared with; null: no such version */
735
+ against: {
736
+ number: number | null;
737
+ /** @enum {string} */
738
+ status: "draft" | "published" | "deprecated" | "archived";
739
+ contentHash: string | null;
740
+ } | null;
741
+ /** @description Publishing would freeze the same content as `against` */
742
+ unchanged: boolean;
743
+ diff: {
744
+ ir: {
745
+ nodes: {
746
+ id: string;
747
+ type: string;
748
+ /** @enum {string} */
749
+ kind: "added" | "removed" | "changed" | "moved";
750
+ parent: string;
751
+ }[];
752
+ sections: string[];
753
+ identical: boolean;
754
+ };
755
+ schema: {
756
+ path: string;
757
+ /** @enum {string} */
758
+ kind: "added" | "removed" | "type-changed" | "required-added" | "required-removed";
759
+ breaking: boolean;
760
+ from?: unknown;
761
+ to?: unknown;
762
+ }[];
763
+ breaking: boolean;
764
+ } | null;
765
+ };
766
+ DataSchema: {
767
+ [key: string]: unknown;
768
+ };
769
+ VersionDocs: {
770
+ template: {
771
+ id: string;
772
+ slug: string;
773
+ name: string;
774
+ description: string;
775
+ };
776
+ version: {
777
+ number: number | null;
778
+ /** @enum {string} */
779
+ status: "draft" | "published" | "deprecated" | "archived";
780
+ changelog: string | null;
781
+ contentHash: string | null;
782
+ rollbackOf: number | null;
783
+ /** Format: date-time */
784
+ publishedAt: string | null;
785
+ /** Format: date-time */
786
+ deprecatedAt: string | null;
787
+ /** Format: date-time */
788
+ archivedAt: string | null;
789
+ };
790
+ title: string;
791
+ profile: string;
792
+ engine: {
793
+ typst: string;
794
+ codegen: string;
795
+ sdm: string;
796
+ } | null;
797
+ fonts: {
798
+ family: string;
799
+ /** @enum {string} */
800
+ scope: "organization" | "platform";
801
+ hashes: string[];
802
+ substitute?: string;
803
+ }[];
804
+ history: {
805
+ number: number;
806
+ /** @enum {string} */
807
+ status: "draft" | "published" | "deprecated" | "archived";
808
+ changelog: string;
809
+ /** Format: date-time */
810
+ publishedAt: string | null;
811
+ }[];
812
+ schema: {
813
+ jsonSchema: {
814
+ [key: string]: unknown;
815
+ };
816
+ fields: {
817
+ /** @example $.lines[].qty */
818
+ path: string;
819
+ type: string;
820
+ /** @description In its parent object */
821
+ required: boolean;
822
+ description?: string;
823
+ format?: string;
824
+ enum?: unknown[];
825
+ /** @description Values taken from the samples */
826
+ examples: unknown[];
827
+ }[];
828
+ };
829
+ samples: {
830
+ name: string;
831
+ data?: unknown;
832
+ /** @description Path of the PNG of the first page (GET) */
833
+ preview: string;
834
+ }[];
835
+ calls: {
836
+ render: {
837
+ /** @enum {string} */
838
+ method: "POST";
839
+ path: string;
840
+ body: {
841
+ [key: string]: unknown;
842
+ };
843
+ curl: string;
844
+ };
845
+ renderSample: {
846
+ /** @enum {string} */
847
+ method: "POST";
848
+ path: string;
849
+ body: {
850
+ [key: string]: unknown;
851
+ };
852
+ curl: string;
853
+ } | null;
854
+ job: {
855
+ /** @enum {string} */
856
+ method: "POST";
857
+ path: string;
858
+ body: {
859
+ [key: string]: unknown;
860
+ };
861
+ curl: string;
862
+ };
863
+ typescript: string;
864
+ };
865
+ /** Format: date-time */
866
+ generatedAt: string;
867
+ };
868
+ Asset: {
869
+ id: string;
870
+ /** @description Templates reference assets as `sha256:<hex, 16+ digits>` */
871
+ sha256: string;
872
+ name: string;
873
+ mime: string;
874
+ size: number;
875
+ /** @enum {string} */
876
+ scope: "organization" | "platform";
877
+ /** Format: date-time */
878
+ createdAt: string;
879
+ };
880
+ Font: {
881
+ /** @description null for platform fonts */
882
+ id: string | null;
883
+ sha256: string;
884
+ name: string;
885
+ /** @enum {string} */
886
+ format: "ttf" | "otf" | "ttc";
887
+ size: number;
888
+ /** @enum {string} */
889
+ scope: "organization" | "platform";
890
+ families: string[];
891
+ faces: {
892
+ family: string;
893
+ subfamily: string;
894
+ /** @enum {string} */
895
+ style: "normal" | "italic";
896
+ weight: number;
897
+ fsType: number;
898
+ /** @enum {string} */
899
+ embedding: "installable" | "editable" | "preview-print" | "restricted";
900
+ }[];
901
+ /** @description Mention entered at deposit (informative) */
902
+ license: string | null;
903
+ /** @description Embedding remarks read from fsType (informative) */
904
+ notes: string[];
905
+ /** Format: date-time */
906
+ createdAt: string | null;
907
+ };
908
+ FontFamily: {
909
+ family: string;
910
+ /** @enum {string} */
911
+ scope: "organization" | "platform";
912
+ hashes: string[];
913
+ };
914
+ Render: {
915
+ id: string;
916
+ /**
917
+ * @description `expired`: the document was deleted by the retention of the organization; the manifest is kept
918
+ * @enum {string}
919
+ */
920
+ status: "succeeded" | "failed" | "expired";
921
+ templateId: string;
922
+ templateSlug?: string | null;
923
+ version: number | null;
924
+ jobId: string | null;
925
+ /** @enum {string} */
926
+ callerType: "user" | "api_key";
927
+ callerId: string;
928
+ idempotencyKey: string | null;
929
+ profile: string;
930
+ pages: number | null;
931
+ size: number | null;
932
+ pdfSha256: string | null;
933
+ dataSha256: string;
934
+ durationMs: number;
935
+ /** @description Generation manifest (ADR-008) */
936
+ manifest: {
937
+ [key: string]: unknown;
938
+ } | null;
939
+ error: {
940
+ code: string;
941
+ message: string;
942
+ issues?: {
943
+ path: string;
944
+ message: string;
945
+ }[];
946
+ } | null;
947
+ /** @description The data of the render are kept (encrypted): POST /renders/{id}/verify needs no `data` */
948
+ dataRetained: boolean;
949
+ /** Format: date-time */
950
+ expiredAt: string | null;
951
+ /** Format: date-time */
952
+ createdAt: string;
953
+ };
954
+ Document: {
955
+ id: string;
956
+ /** @description Time-limited signed URL of the stored PDF */
957
+ url: string;
958
+ /** Format: date-time */
959
+ expiresAt: string;
960
+ sha256: string;
961
+ size: number;
962
+ pages: number;
963
+ };
964
+ Warning: {
965
+ /** @example version.latest */
966
+ code: string;
967
+ message: string;
968
+ path?: string;
969
+ };
970
+ RenderRequest: {
971
+ /** @description Template id or slug */
972
+ template: string;
973
+ /** @description Pin a number in production; `latest` = highest published version */
974
+ version?: number | ("latest" | "draft");
975
+ /** @description Validated against the JSON Schema of the version */
976
+ data?: unknown;
977
+ /** @description Name of a sample of the version, rendered instead of `data` (exclusive with `data`) */
978
+ sample?: string;
979
+ /**
980
+ * @description Overrides the output profile of the template
981
+ * @enum {string}
982
+ */
983
+ profile?: "standard" | "archive" | "accessible";
984
+ locale?: string;
985
+ /** @description Advanced electronic seal (PAdES, ADR-014), last step of the chain; the template may request one too */
986
+ seal?: {
987
+ /** @enum {string} */
988
+ level?: "b-t" | "b-lta";
989
+ };
990
+ };
991
+ RenderDetail: {
992
+ id: string;
993
+ /**
994
+ * @description `expired`: the document was deleted by the retention of the organization; the manifest is kept
995
+ * @enum {string}
996
+ */
997
+ status: "succeeded" | "failed" | "expired";
998
+ templateId: string;
999
+ templateSlug?: string | null;
1000
+ version: number | null;
1001
+ jobId: string | null;
1002
+ /** @enum {string} */
1003
+ callerType: "user" | "api_key";
1004
+ callerId: string;
1005
+ idempotencyKey: string | null;
1006
+ profile: string;
1007
+ pages: number | null;
1008
+ size: number | null;
1009
+ pdfSha256: string | null;
1010
+ dataSha256: string;
1011
+ durationMs: number;
1012
+ /** @description Generation manifest (ADR-008) */
1013
+ manifest: {
1014
+ [key: string]: unknown;
1015
+ } | null;
1016
+ error: {
1017
+ code: string;
1018
+ message: string;
1019
+ issues?: {
1020
+ path: string;
1021
+ message: string;
1022
+ }[];
1023
+ } | null;
1024
+ /** @description The data of the render are kept (encrypted): POST /renders/{id}/verify needs no `data` */
1025
+ dataRetained: boolean;
1026
+ /** Format: date-time */
1027
+ expiredAt: string | null;
1028
+ /** Format: date-time */
1029
+ createdAt: string;
1030
+ /** @description Time-limited signed URL of the stored PDF; null once expired or failed */
1031
+ download: {
1032
+ url: string;
1033
+ /** Format: date-time */
1034
+ expiresAt: string;
1035
+ } | null;
1036
+ /** @description Post-processing chain (pikepdf): operations, PDF/A and PDF/UA identification, sizes */
1037
+ postprocess: {
1038
+ [key: string]: unknown;
1039
+ } | null;
1040
+ /** @description Electronic seal: level, certificate, timestamp authority */
1041
+ seal: {
1042
+ [key: string]: unknown;
1043
+ } | null;
1044
+ };
1045
+ Verification: {
1046
+ renderId: string;
1047
+ /** @enum {string} */
1048
+ result: "identical" | "different";
1049
+ /**
1050
+ * @description `document`: stored PDF; `unsealed-document`: a sealed PDF compared before its seal; `engine-output`: PDF of the engine (sealed renders of older manifests)
1051
+ * @enum {string}
1052
+ */
1053
+ basis: "document" | "unsealed-document" | "engine-output";
1054
+ /** @enum {string} */
1055
+ dataSource: "request" | "snapshot" | "job";
1056
+ original: {
1057
+ sha256: string;
1058
+ pdfSha256: string | null;
1059
+ };
1060
+ rerender: {
1061
+ sha256: string;
1062
+ pages: number;
1063
+ bytes: number;
1064
+ durationMs: number;
1065
+ };
1066
+ /** @description Manifest fields that differ (engine, fonts, sizes…); volatile fields (timings, ids) excluded */
1067
+ differences: {
1068
+ path: string;
1069
+ original?: unknown;
1070
+ rerender?: unknown;
1071
+ }[];
1072
+ /** Format: date-time */
1073
+ verifiedAt: string;
1074
+ };
1075
+ JobAccepted: {
1076
+ id: string;
1077
+ /** @enum {string} */
1078
+ status: "queued" | "running" | "succeeded" | "failed";
1079
+ /** @enum {string} */
1080
+ queue: "light" | "heavy";
1081
+ templateId: string;
1082
+ version: number | null;
1083
+ profile: string;
1084
+ /** @enum {string} */
1085
+ callerType: "user" | "api_key";
1086
+ callerId: string;
1087
+ idempotencyKey: string | null;
1088
+ callbackUrl: string | null;
1089
+ renderId: string | null;
1090
+ error: {
1091
+ code: string;
1092
+ message: string;
1093
+ issues?: {
1094
+ path: string;
1095
+ message: string;
1096
+ }[];
1097
+ } | null;
1098
+ /**
1099
+ * @description Batch jobs: one ZIP archive, one merged PDF, or the documents of the items; null: one document
1100
+ * @enum {string|null}
1101
+ */
1102
+ output: "zip" | "merged" | "separate" | null;
1103
+ /** @description Batch jobs: items rendered so far (failures listed by GET /jobs/{id}/items) */
1104
+ progress: {
1105
+ total: number;
1106
+ done: number;
1107
+ succeeded: number;
1108
+ failed: number;
1109
+ } | null;
1110
+ /** Format: date-time */
1111
+ createdAt: string;
1112
+ /** Format: date-time */
1113
+ startedAt: string | null;
1114
+ /** Format: date-time */
1115
+ finishedAt: string | null;
1116
+ /** @description `version.latest`: an API key asked for `latest`; pin a version number in production */
1117
+ warnings: components["schemas"]["Warning"][];
1118
+ };
1119
+ Job: {
1120
+ id: string;
1121
+ /** @enum {string} */
1122
+ status: "queued" | "running" | "succeeded" | "failed";
1123
+ /** @enum {string} */
1124
+ queue: "light" | "heavy";
1125
+ templateId: string;
1126
+ version: number | null;
1127
+ profile: string;
1128
+ /** @enum {string} */
1129
+ callerType: "user" | "api_key";
1130
+ callerId: string;
1131
+ idempotencyKey: string | null;
1132
+ callbackUrl: string | null;
1133
+ renderId: string | null;
1134
+ error: {
1135
+ code: string;
1136
+ message: string;
1137
+ issues?: {
1138
+ path: string;
1139
+ message: string;
1140
+ }[];
1141
+ } | null;
1142
+ /**
1143
+ * @description Batch jobs: one ZIP archive, one merged PDF, or the documents of the items; null: one document
1144
+ * @enum {string|null}
1145
+ */
1146
+ output: "zip" | "merged" | "separate" | null;
1147
+ /** @description Batch jobs: items rendered so far (failures listed by GET /jobs/{id}/items) */
1148
+ progress: {
1149
+ total: number;
1150
+ done: number;
1151
+ succeeded: number;
1152
+ failed: number;
1153
+ } | null;
1154
+ /** Format: date-time */
1155
+ createdAt: string;
1156
+ /** Format: date-time */
1157
+ startedAt: string | null;
1158
+ /** Format: date-time */
1159
+ finishedAt: string | null;
1160
+ };
1161
+ JobRequest: {
1162
+ /** @description Template id or slug */
1163
+ template: string;
1164
+ /** @description Pin a number in production; `latest` = highest published version */
1165
+ version?: number | ("latest" | "draft");
1166
+ /** @description Validated against the JSON Schema of the version */
1167
+ data?: unknown;
1168
+ /** @description Name of a sample of the version, rendered instead of `data` (exclusive with `data`) */
1169
+ sample?: string;
1170
+ /**
1171
+ * @description Overrides the output profile of the template
1172
+ * @enum {string}
1173
+ */
1174
+ profile?: "standard" | "archive" | "accessible";
1175
+ locale?: string;
1176
+ /** @description Advanced electronic seal (PAdES, ADR-014), last step of the chain; the template may request one too */
1177
+ seal?: {
1178
+ /** @enum {string} */
1179
+ level?: "b-t" | "b-lta";
1180
+ };
1181
+ /**
1182
+ * Format: uri
1183
+ * @description Notified like a webhook when the job ends (`job.completed`, `job.failed`, `job.lost`), signed with the callback secret of the organization (GET /webhooks/callback-secret)
1184
+ */
1185
+ callbackUrl?: string;
1186
+ /** @description Batch: documents of the same template and version (instead of `data` / `sample`), each validated at submission; at most `batchMaxItems` of the organization */
1187
+ items?: components["schemas"]["BatchItem"][];
1188
+ /**
1189
+ * @description Batch only (default `zip`): one ZIP archive with an index `items.json`; one merged PDF (one bookmark per document, one seal); or the documents of the items only
1190
+ * @enum {string}
1191
+ */
1192
+ output?: "zip" | "merged" | "separate";
1193
+ };
1194
+ BatchItem: {
1195
+ /** @description Validated against the JSON Schema of the version */
1196
+ data?: unknown;
1197
+ /** @description Name of a sample of the version, rendered instead of `data` (exclusive with `data`) */
1198
+ sample?: string;
1199
+ /** @description File name in the archive (`.pdf` appended when missing), bookmark of the merged document without its extension; `<position>.pdf` by default. Unique within the batch (case-insensitive). */
1200
+ filename?: string;
1201
+ /** @description References of the caller, returned with the item and in the index of the archive */
1202
+ metadata?: {
1203
+ [key: string]: unknown;
1204
+ };
1205
+ };
1206
+ JobItem: {
1207
+ /** @description Id of the item, of its render and of its document */
1208
+ id: string;
1209
+ /** @description Position in `items` of the request */
1210
+ index: number;
1211
+ /** @enum {string} */
1212
+ status: "queued" | "running" | "succeeded" | "failed";
1213
+ /** @enum {string} */
1214
+ queue: "light" | "heavy";
1215
+ filename: string;
1216
+ metadata: {
1217
+ [key: string]: unknown;
1218
+ } | null;
1219
+ sample: string | null;
1220
+ dataSha256: string;
1221
+ renderId: string | null;
1222
+ pages: number | null;
1223
+ error: {
1224
+ code: string;
1225
+ message: string;
1226
+ issues?: {
1227
+ path: string;
1228
+ message: string;
1229
+ }[];
1230
+ } | null;
1231
+ /** Format: date-time */
1232
+ startedAt: string | null;
1233
+ /** Format: date-time */
1234
+ finishedAt: string | null;
1235
+ };
1236
+ JobOutput: {
1237
+ /** @description Time-limited signed URL */
1238
+ url: string;
1239
+ /** Format: date-time */
1240
+ expiresAt: string;
1241
+ /** @enum {string} */
1242
+ contentType: "application/pdf" | "application/zip";
1243
+ sha256: string;
1244
+ size: number;
1245
+ /** @description Merged document */
1246
+ pages: number | null;
1247
+ };
1248
+ WebhookDelivery: {
1249
+ id: string;
1250
+ /** @description null: `callbackUrl` of a job */
1251
+ webhookId: string | null;
1252
+ jobId: string | null;
1253
+ /** @description Same for every delivery of an event: receivers dedupe on it */
1254
+ eventId: string;
1255
+ event: string;
1256
+ url: string;
1257
+ /** @enum {string} */
1258
+ status: "pending" | "succeeded" | "failed";
1259
+ attempts: {
1260
+ /** Format: date-time */
1261
+ at: string;
1262
+ /** @description HTTP status; null: no answer */
1263
+ status: number | null;
1264
+ durationMs: number;
1265
+ error?: string;
1266
+ }[];
1267
+ responseStatus: number | null;
1268
+ /** @description First bytes of the last answer */
1269
+ responseBody: string | null;
1270
+ redeliveryOf: string | null;
1271
+ /** @description Body POSTed to the receiver: `{ id, type, createdAt, organizationId, data }`, signed in `X-Sculdoc-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256(secret, "<t>.<body>")>` */
1272
+ payload: {
1273
+ [key: string]: unknown;
1274
+ };
1275
+ /** Format: date-time */
1276
+ createdAt: string;
1277
+ /** Format: date-time */
1278
+ lastAttemptAt: string | null;
1279
+ /** Format: date-time */
1280
+ finishedAt: string | null;
1281
+ };
1282
+ Validation: {
1283
+ valid: boolean;
1284
+ issues: {
1285
+ path: string;
1286
+ message: string;
1287
+ }[];
1288
+ /** @description `version.latest`: an API key asked for `latest`; pin a version number in production */
1289
+ warnings: components["schemas"]["Warning"][];
1290
+ };
1291
+ };
1292
+ responses: never;
1293
+ parameters: never;
1294
+ requestBodies: never;
1295
+ headers: never;
1296
+ pathItems: never;
1297
+ }
1298
+ export type $defs = Record<string, never>;
1299
+ export interface operations {
1300
+ getMe: {
1301
+ parameters: {
1302
+ query?: never;
1303
+ header?: never;
1304
+ path?: never;
1305
+ cookie?: never;
1306
+ };
1307
+ requestBody?: never;
1308
+ responses: {
1309
+ /** @description Identity */
1310
+ 200: {
1311
+ headers: {
1312
+ [name: string]: unknown;
1313
+ };
1314
+ content: {
1315
+ "application/json": {
1316
+ /** @enum {string} */
1317
+ type: "user" | "api_key";
1318
+ user: {
1319
+ id: string;
1320
+ email: string;
1321
+ name: string;
1322
+ platformAdmin: boolean;
1323
+ } | null;
1324
+ organizations: (components["schemas"]["Organization"] & {
1325
+ role: string | null;
1326
+ })[];
1327
+ /** @description Sign-in providers enabled on this deployment */
1328
+ providers: string[];
1329
+ };
1330
+ };
1331
+ };
1332
+ /** @description Malformed request */
1333
+ 400: {
1334
+ headers: {
1335
+ [name: string]: unknown;
1336
+ };
1337
+ content: {
1338
+ "application/json": components["schemas"]["Error"];
1339
+ };
1340
+ };
1341
+ /** @description Authentication required */
1342
+ 401: {
1343
+ headers: {
1344
+ [name: string]: unknown;
1345
+ };
1346
+ content: {
1347
+ "application/json": components["schemas"]["Error"];
1348
+ };
1349
+ };
1350
+ /** @description Insufficient permissions */
1351
+ 403: {
1352
+ headers: {
1353
+ [name: string]: unknown;
1354
+ };
1355
+ content: {
1356
+ "application/json": components["schemas"]["Error"];
1357
+ };
1358
+ };
1359
+ /** @description Not found in this organization */
1360
+ 404: {
1361
+ headers: {
1362
+ [name: string]: unknown;
1363
+ };
1364
+ content: {
1365
+ "application/json": components["schemas"]["Error"];
1366
+ };
1367
+ };
1368
+ /** @description Conflict with the current state */
1369
+ 409: {
1370
+ headers: {
1371
+ [name: string]: unknown;
1372
+ };
1373
+ content: {
1374
+ "application/json": components["schemas"]["Error"];
1375
+ };
1376
+ };
1377
+ /** @description Validation failed (issues carry JSON paths) */
1378
+ 422: {
1379
+ headers: {
1380
+ [name: string]: unknown;
1381
+ };
1382
+ content: {
1383
+ "application/json": components["schemas"]["Error"];
1384
+ };
1385
+ };
1386
+ };
1387
+ };
1388
+ listFolders: {
1389
+ parameters: {
1390
+ query?: never;
1391
+ header?: never;
1392
+ path?: never;
1393
+ cookie?: never;
1394
+ };
1395
+ requestBody?: never;
1396
+ responses: {
1397
+ /** @description Folders */
1398
+ 200: {
1399
+ headers: {
1400
+ [name: string]: unknown;
1401
+ };
1402
+ content: {
1403
+ "application/json": {
1404
+ folders: components["schemas"]["Folder"][];
1405
+ };
1406
+ };
1407
+ };
1408
+ /** @description Malformed request */
1409
+ 400: {
1410
+ headers: {
1411
+ [name: string]: unknown;
1412
+ };
1413
+ content: {
1414
+ "application/json": components["schemas"]["Error"];
1415
+ };
1416
+ };
1417
+ /** @description Authentication required */
1418
+ 401: {
1419
+ headers: {
1420
+ [name: string]: unknown;
1421
+ };
1422
+ content: {
1423
+ "application/json": components["schemas"]["Error"];
1424
+ };
1425
+ };
1426
+ /** @description Insufficient permissions */
1427
+ 403: {
1428
+ headers: {
1429
+ [name: string]: unknown;
1430
+ };
1431
+ content: {
1432
+ "application/json": components["schemas"]["Error"];
1433
+ };
1434
+ };
1435
+ /** @description Not found in this organization */
1436
+ 404: {
1437
+ headers: {
1438
+ [name: string]: unknown;
1439
+ };
1440
+ content: {
1441
+ "application/json": components["schemas"]["Error"];
1442
+ };
1443
+ };
1444
+ /** @description Conflict with the current state */
1445
+ 409: {
1446
+ headers: {
1447
+ [name: string]: unknown;
1448
+ };
1449
+ content: {
1450
+ "application/json": components["schemas"]["Error"];
1451
+ };
1452
+ };
1453
+ /** @description Validation failed (issues carry JSON paths) */
1454
+ 422: {
1455
+ headers: {
1456
+ [name: string]: unknown;
1457
+ };
1458
+ content: {
1459
+ "application/json": components["schemas"]["Error"];
1460
+ };
1461
+ };
1462
+ };
1463
+ };
1464
+ getFolder: {
1465
+ parameters: {
1466
+ query?: never;
1467
+ header?: never;
1468
+ path: {
1469
+ folderId: string;
1470
+ };
1471
+ cookie?: never;
1472
+ };
1473
+ requestBody?: never;
1474
+ responses: {
1475
+ /** @description Folder */
1476
+ 200: {
1477
+ headers: {
1478
+ [name: string]: unknown;
1479
+ };
1480
+ content: {
1481
+ "application/json": components["schemas"]["Folder"];
1482
+ };
1483
+ };
1484
+ /** @description Malformed request */
1485
+ 400: {
1486
+ headers: {
1487
+ [name: string]: unknown;
1488
+ };
1489
+ content: {
1490
+ "application/json": components["schemas"]["Error"];
1491
+ };
1492
+ };
1493
+ /** @description Authentication required */
1494
+ 401: {
1495
+ headers: {
1496
+ [name: string]: unknown;
1497
+ };
1498
+ content: {
1499
+ "application/json": components["schemas"]["Error"];
1500
+ };
1501
+ };
1502
+ /** @description Insufficient permissions */
1503
+ 403: {
1504
+ headers: {
1505
+ [name: string]: unknown;
1506
+ };
1507
+ content: {
1508
+ "application/json": components["schemas"]["Error"];
1509
+ };
1510
+ };
1511
+ /** @description Not found in this organization */
1512
+ 404: {
1513
+ headers: {
1514
+ [name: string]: unknown;
1515
+ };
1516
+ content: {
1517
+ "application/json": components["schemas"]["Error"];
1518
+ };
1519
+ };
1520
+ /** @description Conflict with the current state */
1521
+ 409: {
1522
+ headers: {
1523
+ [name: string]: unknown;
1524
+ };
1525
+ content: {
1526
+ "application/json": components["schemas"]["Error"];
1527
+ };
1528
+ };
1529
+ /** @description Validation failed (issues carry JSON paths) */
1530
+ 422: {
1531
+ headers: {
1532
+ [name: string]: unknown;
1533
+ };
1534
+ content: {
1535
+ "application/json": components["schemas"]["Error"];
1536
+ };
1537
+ };
1538
+ };
1539
+ };
1540
+ listTemplates: {
1541
+ parameters: {
1542
+ query?: {
1543
+ folderId?: string;
1544
+ };
1545
+ header?: never;
1546
+ path?: never;
1547
+ cookie?: never;
1548
+ };
1549
+ requestBody?: never;
1550
+ responses: {
1551
+ /** @description Templates */
1552
+ 200: {
1553
+ headers: {
1554
+ [name: string]: unknown;
1555
+ };
1556
+ content: {
1557
+ "application/json": {
1558
+ templates: components["schemas"]["Template"][];
1559
+ };
1560
+ };
1561
+ };
1562
+ /** @description Malformed request */
1563
+ 400: {
1564
+ headers: {
1565
+ [name: string]: unknown;
1566
+ };
1567
+ content: {
1568
+ "application/json": components["schemas"]["Error"];
1569
+ };
1570
+ };
1571
+ /** @description Authentication required */
1572
+ 401: {
1573
+ headers: {
1574
+ [name: string]: unknown;
1575
+ };
1576
+ content: {
1577
+ "application/json": components["schemas"]["Error"];
1578
+ };
1579
+ };
1580
+ /** @description Insufficient permissions */
1581
+ 403: {
1582
+ headers: {
1583
+ [name: string]: unknown;
1584
+ };
1585
+ content: {
1586
+ "application/json": components["schemas"]["Error"];
1587
+ };
1588
+ };
1589
+ /** @description Not found in this organization */
1590
+ 404: {
1591
+ headers: {
1592
+ [name: string]: unknown;
1593
+ };
1594
+ content: {
1595
+ "application/json": components["schemas"]["Error"];
1596
+ };
1597
+ };
1598
+ /** @description Conflict with the current state */
1599
+ 409: {
1600
+ headers: {
1601
+ [name: string]: unknown;
1602
+ };
1603
+ content: {
1604
+ "application/json": components["schemas"]["Error"];
1605
+ };
1606
+ };
1607
+ /** @description Validation failed (issues carry JSON paths) */
1608
+ 422: {
1609
+ headers: {
1610
+ [name: string]: unknown;
1611
+ };
1612
+ content: {
1613
+ "application/json": components["schemas"]["Error"];
1614
+ };
1615
+ };
1616
+ };
1617
+ };
1618
+ createTemplate: {
1619
+ parameters: {
1620
+ query?: never;
1621
+ header?: never;
1622
+ path?: never;
1623
+ cookie?: never;
1624
+ };
1625
+ requestBody: {
1626
+ content: {
1627
+ "application/json": {
1628
+ name: string;
1629
+ /**
1630
+ * @description Stable identifier used by API callers
1631
+ * @example certificat-etalonnage
1632
+ */
1633
+ slug?: string;
1634
+ description?: string;
1635
+ folderId?: string | null;
1636
+ };
1637
+ };
1638
+ };
1639
+ responses: {
1640
+ /** @description Created */
1641
+ 201: {
1642
+ headers: {
1643
+ [name: string]: unknown;
1644
+ };
1645
+ content: {
1646
+ "application/json": components["schemas"]["Template"];
1647
+ };
1648
+ };
1649
+ /** @description Malformed request */
1650
+ 400: {
1651
+ headers: {
1652
+ [name: string]: unknown;
1653
+ };
1654
+ content: {
1655
+ "application/json": components["schemas"]["Error"];
1656
+ };
1657
+ };
1658
+ /** @description Authentication required */
1659
+ 401: {
1660
+ headers: {
1661
+ [name: string]: unknown;
1662
+ };
1663
+ content: {
1664
+ "application/json": components["schemas"]["Error"];
1665
+ };
1666
+ };
1667
+ /** @description Insufficient permissions */
1668
+ 403: {
1669
+ headers: {
1670
+ [name: string]: unknown;
1671
+ };
1672
+ content: {
1673
+ "application/json": components["schemas"]["Error"];
1674
+ };
1675
+ };
1676
+ /** @description Not found in this organization */
1677
+ 404: {
1678
+ headers: {
1679
+ [name: string]: unknown;
1680
+ };
1681
+ content: {
1682
+ "application/json": components["schemas"]["Error"];
1683
+ };
1684
+ };
1685
+ /** @description Conflict with the current state */
1686
+ 409: {
1687
+ headers: {
1688
+ [name: string]: unknown;
1689
+ };
1690
+ content: {
1691
+ "application/json": components["schemas"]["Error"];
1692
+ };
1693
+ };
1694
+ /** @description Validation failed (issues carry JSON paths) */
1695
+ 422: {
1696
+ headers: {
1697
+ [name: string]: unknown;
1698
+ };
1699
+ content: {
1700
+ "application/json": components["schemas"]["Error"];
1701
+ };
1702
+ };
1703
+ };
1704
+ };
1705
+ getTemplate: {
1706
+ parameters: {
1707
+ query?: never;
1708
+ header?: never;
1709
+ path: {
1710
+ /** @description Template id or slug */
1711
+ template: string;
1712
+ };
1713
+ cookie?: never;
1714
+ };
1715
+ requestBody?: never;
1716
+ responses: {
1717
+ /** @description Template */
1718
+ 200: {
1719
+ headers: {
1720
+ [name: string]: unknown;
1721
+ };
1722
+ content: {
1723
+ "application/json": components["schemas"]["Template"];
1724
+ };
1725
+ };
1726
+ /** @description Malformed request */
1727
+ 400: {
1728
+ headers: {
1729
+ [name: string]: unknown;
1730
+ };
1731
+ content: {
1732
+ "application/json": components["schemas"]["Error"];
1733
+ };
1734
+ };
1735
+ /** @description Authentication required */
1736
+ 401: {
1737
+ headers: {
1738
+ [name: string]: unknown;
1739
+ };
1740
+ content: {
1741
+ "application/json": components["schemas"]["Error"];
1742
+ };
1743
+ };
1744
+ /** @description Insufficient permissions */
1745
+ 403: {
1746
+ headers: {
1747
+ [name: string]: unknown;
1748
+ };
1749
+ content: {
1750
+ "application/json": components["schemas"]["Error"];
1751
+ };
1752
+ };
1753
+ /** @description Not found in this organization */
1754
+ 404: {
1755
+ headers: {
1756
+ [name: string]: unknown;
1757
+ };
1758
+ content: {
1759
+ "application/json": components["schemas"]["Error"];
1760
+ };
1761
+ };
1762
+ /** @description Conflict with the current state */
1763
+ 409: {
1764
+ headers: {
1765
+ [name: string]: unknown;
1766
+ };
1767
+ content: {
1768
+ "application/json": components["schemas"]["Error"];
1769
+ };
1770
+ };
1771
+ /** @description Validation failed (issues carry JSON paths) */
1772
+ 422: {
1773
+ headers: {
1774
+ [name: string]: unknown;
1775
+ };
1776
+ content: {
1777
+ "application/json": components["schemas"]["Error"];
1778
+ };
1779
+ };
1780
+ };
1781
+ };
1782
+ listVersions: {
1783
+ parameters: {
1784
+ query?: never;
1785
+ header?: never;
1786
+ path: {
1787
+ /** @description Template id or slug */
1788
+ template: string;
1789
+ };
1790
+ cookie?: never;
1791
+ };
1792
+ requestBody?: never;
1793
+ responses: {
1794
+ /** @description Versions */
1795
+ 200: {
1796
+ headers: {
1797
+ [name: string]: unknown;
1798
+ };
1799
+ content: {
1800
+ "application/json": {
1801
+ versions: components["schemas"]["VersionSummary"][];
1802
+ };
1803
+ };
1804
+ };
1805
+ /** @description Malformed request */
1806
+ 400: {
1807
+ headers: {
1808
+ [name: string]: unknown;
1809
+ };
1810
+ content: {
1811
+ "application/json": components["schemas"]["Error"];
1812
+ };
1813
+ };
1814
+ /** @description Authentication required */
1815
+ 401: {
1816
+ headers: {
1817
+ [name: string]: unknown;
1818
+ };
1819
+ content: {
1820
+ "application/json": components["schemas"]["Error"];
1821
+ };
1822
+ };
1823
+ /** @description Insufficient permissions */
1824
+ 403: {
1825
+ headers: {
1826
+ [name: string]: unknown;
1827
+ };
1828
+ content: {
1829
+ "application/json": components["schemas"]["Error"];
1830
+ };
1831
+ };
1832
+ /** @description Not found in this organization */
1833
+ 404: {
1834
+ headers: {
1835
+ [name: string]: unknown;
1836
+ };
1837
+ content: {
1838
+ "application/json": components["schemas"]["Error"];
1839
+ };
1840
+ };
1841
+ /** @description Conflict with the current state */
1842
+ 409: {
1843
+ headers: {
1844
+ [name: string]: unknown;
1845
+ };
1846
+ content: {
1847
+ "application/json": components["schemas"]["Error"];
1848
+ };
1849
+ };
1850
+ /** @description Validation failed (issues carry JSON paths) */
1851
+ 422: {
1852
+ headers: {
1853
+ [name: string]: unknown;
1854
+ };
1855
+ content: {
1856
+ "application/json": components["schemas"]["Error"];
1857
+ };
1858
+ };
1859
+ };
1860
+ };
1861
+ saveDraft: {
1862
+ parameters: {
1863
+ query?: never;
1864
+ header?: never;
1865
+ path: {
1866
+ /** @description Template id or slug */
1867
+ template: string;
1868
+ };
1869
+ cookie?: never;
1870
+ };
1871
+ requestBody: {
1872
+ content: {
1873
+ "application/json": {
1874
+ ir: {
1875
+ [key: string]: unknown;
1876
+ };
1877
+ dataSchema?: {
1878
+ [key: string]: unknown;
1879
+ } | null;
1880
+ samples?: components["schemas"]["Sample"][];
1881
+ };
1882
+ };
1883
+ };
1884
+ responses: {
1885
+ /** @description Draft */
1886
+ 200: {
1887
+ headers: {
1888
+ [name: string]: unknown;
1889
+ };
1890
+ content: {
1891
+ "application/json": components["schemas"]["Version"];
1892
+ };
1893
+ };
1894
+ /** @description Malformed request */
1895
+ 400: {
1896
+ headers: {
1897
+ [name: string]: unknown;
1898
+ };
1899
+ content: {
1900
+ "application/json": components["schemas"]["Error"];
1901
+ };
1902
+ };
1903
+ /** @description Authentication required */
1904
+ 401: {
1905
+ headers: {
1906
+ [name: string]: unknown;
1907
+ };
1908
+ content: {
1909
+ "application/json": components["schemas"]["Error"];
1910
+ };
1911
+ };
1912
+ /** @description Insufficient permissions */
1913
+ 403: {
1914
+ headers: {
1915
+ [name: string]: unknown;
1916
+ };
1917
+ content: {
1918
+ "application/json": components["schemas"]["Error"];
1919
+ };
1920
+ };
1921
+ /** @description Not found in this organization */
1922
+ 404: {
1923
+ headers: {
1924
+ [name: string]: unknown;
1925
+ };
1926
+ content: {
1927
+ "application/json": components["schemas"]["Error"];
1928
+ };
1929
+ };
1930
+ /** @description Conflict with the current state */
1931
+ 409: {
1932
+ headers: {
1933
+ [name: string]: unknown;
1934
+ };
1935
+ content: {
1936
+ "application/json": components["schemas"]["Error"];
1937
+ };
1938
+ };
1939
+ /** @description Validation failed (issues carry JSON paths) */
1940
+ 422: {
1941
+ headers: {
1942
+ [name: string]: unknown;
1943
+ };
1944
+ content: {
1945
+ "application/json": components["schemas"]["Error"];
1946
+ };
1947
+ };
1948
+ };
1949
+ };
1950
+ deleteDraft: {
1951
+ parameters: {
1952
+ query?: never;
1953
+ header?: never;
1954
+ path: {
1955
+ /** @description Template id or slug */
1956
+ template: string;
1957
+ };
1958
+ cookie?: never;
1959
+ };
1960
+ requestBody?: never;
1961
+ responses: {
1962
+ /** @description Discarded */
1963
+ 204: {
1964
+ headers: {
1965
+ [name: string]: unknown;
1966
+ };
1967
+ content?: never;
1968
+ };
1969
+ /** @description Malformed request */
1970
+ 400: {
1971
+ headers: {
1972
+ [name: string]: unknown;
1973
+ };
1974
+ content: {
1975
+ "application/json": components["schemas"]["Error"];
1976
+ };
1977
+ };
1978
+ /** @description Authentication required */
1979
+ 401: {
1980
+ headers: {
1981
+ [name: string]: unknown;
1982
+ };
1983
+ content: {
1984
+ "application/json": components["schemas"]["Error"];
1985
+ };
1986
+ };
1987
+ /** @description Insufficient permissions */
1988
+ 403: {
1989
+ headers: {
1990
+ [name: string]: unknown;
1991
+ };
1992
+ content: {
1993
+ "application/json": components["schemas"]["Error"];
1994
+ };
1995
+ };
1996
+ /** @description Not found in this organization */
1997
+ 404: {
1998
+ headers: {
1999
+ [name: string]: unknown;
2000
+ };
2001
+ content: {
2002
+ "application/json": components["schemas"]["Error"];
2003
+ };
2004
+ };
2005
+ /** @description Conflict with the current state */
2006
+ 409: {
2007
+ headers: {
2008
+ [name: string]: unknown;
2009
+ };
2010
+ content: {
2011
+ "application/json": components["schemas"]["Error"];
2012
+ };
2013
+ };
2014
+ /** @description Validation failed (issues carry JSON paths) */
2015
+ 422: {
2016
+ headers: {
2017
+ [name: string]: unknown;
2018
+ };
2019
+ content: {
2020
+ "application/json": components["schemas"]["Error"];
2021
+ };
2022
+ };
2023
+ };
2024
+ };
2025
+ publishDraft: {
2026
+ parameters: {
2027
+ query?: never;
2028
+ header?: never;
2029
+ path: {
2030
+ /** @description Template id or slug */
2031
+ template: string;
2032
+ };
2033
+ cookie?: never;
2034
+ };
2035
+ requestBody: {
2036
+ content: {
2037
+ "application/json": {
2038
+ /** @description Mandatory at publication */
2039
+ changelog: string;
2040
+ };
2041
+ };
2042
+ };
2043
+ responses: {
2044
+ /** @description Published */
2045
+ 201: {
2046
+ headers: {
2047
+ [name: string]: unknown;
2048
+ };
2049
+ content: {
2050
+ "application/json": components["schemas"]["PublishedVersion"];
2051
+ };
2052
+ };
2053
+ /** @description Malformed request */
2054
+ 400: {
2055
+ headers: {
2056
+ [name: string]: unknown;
2057
+ };
2058
+ content: {
2059
+ "application/json": components["schemas"]["Error"];
2060
+ };
2061
+ };
2062
+ /** @description Authentication required */
2063
+ 401: {
2064
+ headers: {
2065
+ [name: string]: unknown;
2066
+ };
2067
+ content: {
2068
+ "application/json": components["schemas"]["Error"];
2069
+ };
2070
+ };
2071
+ /** @description Insufficient permissions */
2072
+ 403: {
2073
+ headers: {
2074
+ [name: string]: unknown;
2075
+ };
2076
+ content: {
2077
+ "application/json": components["schemas"]["Error"];
2078
+ };
2079
+ };
2080
+ /** @description Not found in this organization */
2081
+ 404: {
2082
+ headers: {
2083
+ [name: string]: unknown;
2084
+ };
2085
+ content: {
2086
+ "application/json": components["schemas"]["Error"];
2087
+ };
2088
+ };
2089
+ /** @description Conflict with the current state */
2090
+ 409: {
2091
+ headers: {
2092
+ [name: string]: unknown;
2093
+ };
2094
+ content: {
2095
+ "application/json": components["schemas"]["Error"];
2096
+ };
2097
+ };
2098
+ /** @description Validation failed (issues carry JSON paths) */
2099
+ 422: {
2100
+ headers: {
2101
+ [name: string]: unknown;
2102
+ };
2103
+ content: {
2104
+ "application/json": components["schemas"]["Error"];
2105
+ };
2106
+ };
2107
+ };
2108
+ };
2109
+ diffVersions: {
2110
+ parameters: {
2111
+ query: {
2112
+ from: string;
2113
+ to: string;
2114
+ };
2115
+ header?: never;
2116
+ path: {
2117
+ /** @description Template id or slug */
2118
+ template: string;
2119
+ };
2120
+ cookie?: never;
2121
+ };
2122
+ requestBody?: never;
2123
+ responses: {
2124
+ /** @description Diff */
2125
+ 200: {
2126
+ headers: {
2127
+ [name: string]: unknown;
2128
+ };
2129
+ content: {
2130
+ "application/json": components["schemas"]["VersionDiff"];
2131
+ };
2132
+ };
2133
+ /** @description Malformed request */
2134
+ 400: {
2135
+ headers: {
2136
+ [name: string]: unknown;
2137
+ };
2138
+ content: {
2139
+ "application/json": components["schemas"]["Error"];
2140
+ };
2141
+ };
2142
+ /** @description Authentication required */
2143
+ 401: {
2144
+ headers: {
2145
+ [name: string]: unknown;
2146
+ };
2147
+ content: {
2148
+ "application/json": components["schemas"]["Error"];
2149
+ };
2150
+ };
2151
+ /** @description Insufficient permissions */
2152
+ 403: {
2153
+ headers: {
2154
+ [name: string]: unknown;
2155
+ };
2156
+ content: {
2157
+ "application/json": components["schemas"]["Error"];
2158
+ };
2159
+ };
2160
+ /** @description Not found in this organization */
2161
+ 404: {
2162
+ headers: {
2163
+ [name: string]: unknown;
2164
+ };
2165
+ content: {
2166
+ "application/json": components["schemas"]["Error"];
2167
+ };
2168
+ };
2169
+ /** @description Conflict with the current state */
2170
+ 409: {
2171
+ headers: {
2172
+ [name: string]: unknown;
2173
+ };
2174
+ content: {
2175
+ "application/json": components["schemas"]["Error"];
2176
+ };
2177
+ };
2178
+ /** @description Validation failed (issues carry JSON paths) */
2179
+ 422: {
2180
+ headers: {
2181
+ [name: string]: unknown;
2182
+ };
2183
+ content: {
2184
+ "application/json": components["schemas"]["Error"];
2185
+ };
2186
+ };
2187
+ };
2188
+ };
2189
+ checkPublication: {
2190
+ parameters: {
2191
+ query?: never;
2192
+ header?: never;
2193
+ path: {
2194
+ /** @description Template id or slug */
2195
+ template: string;
2196
+ };
2197
+ cookie?: never;
2198
+ };
2199
+ requestBody: {
2200
+ content: {
2201
+ "application/json": {
2202
+ ir: {
2203
+ [key: string]: unknown;
2204
+ };
2205
+ dataSchema?: {
2206
+ [key: string]: unknown;
2207
+ } | null;
2208
+ samples?: components["schemas"]["Sample"][];
2209
+ /**
2210
+ * @description Version number or `latest`
2211
+ * @default latest
2212
+ * @example latest
2213
+ */
2214
+ against?: string;
2215
+ };
2216
+ };
2217
+ };
2218
+ responses: {
2219
+ /** @description Check */
2220
+ 200: {
2221
+ headers: {
2222
+ [name: string]: unknown;
2223
+ };
2224
+ content: {
2225
+ "application/json": components["schemas"]["PublicationCheck"];
2226
+ };
2227
+ };
2228
+ /** @description Malformed request */
2229
+ 400: {
2230
+ headers: {
2231
+ [name: string]: unknown;
2232
+ };
2233
+ content: {
2234
+ "application/json": components["schemas"]["Error"];
2235
+ };
2236
+ };
2237
+ /** @description Authentication required */
2238
+ 401: {
2239
+ headers: {
2240
+ [name: string]: unknown;
2241
+ };
2242
+ content: {
2243
+ "application/json": components["schemas"]["Error"];
2244
+ };
2245
+ };
2246
+ /** @description Insufficient permissions */
2247
+ 403: {
2248
+ headers: {
2249
+ [name: string]: unknown;
2250
+ };
2251
+ content: {
2252
+ "application/json": components["schemas"]["Error"];
2253
+ };
2254
+ };
2255
+ /** @description Not found in this organization */
2256
+ 404: {
2257
+ headers: {
2258
+ [name: string]: unknown;
2259
+ };
2260
+ content: {
2261
+ "application/json": components["schemas"]["Error"];
2262
+ };
2263
+ };
2264
+ /** @description Conflict with the current state */
2265
+ 409: {
2266
+ headers: {
2267
+ [name: string]: unknown;
2268
+ };
2269
+ content: {
2270
+ "application/json": components["schemas"]["Error"];
2271
+ };
2272
+ };
2273
+ /** @description Validation failed (issues carry JSON paths) */
2274
+ 422: {
2275
+ headers: {
2276
+ [name: string]: unknown;
2277
+ };
2278
+ content: {
2279
+ "application/json": components["schemas"]["Error"];
2280
+ };
2281
+ };
2282
+ };
2283
+ };
2284
+ getVersion: {
2285
+ parameters: {
2286
+ query?: never;
2287
+ header?: never;
2288
+ path: {
2289
+ /** @description Template id or slug */
2290
+ template: string;
2291
+ /** @description Version number, `latest` or `draft` */
2292
+ version: string;
2293
+ };
2294
+ cookie?: never;
2295
+ };
2296
+ requestBody?: never;
2297
+ responses: {
2298
+ /** @description Version */
2299
+ 200: {
2300
+ headers: {
2301
+ [name: string]: unknown;
2302
+ };
2303
+ content: {
2304
+ "application/json": components["schemas"]["Version"];
2305
+ };
2306
+ };
2307
+ /** @description Malformed request */
2308
+ 400: {
2309
+ headers: {
2310
+ [name: string]: unknown;
2311
+ };
2312
+ content: {
2313
+ "application/json": components["schemas"]["Error"];
2314
+ };
2315
+ };
2316
+ /** @description Authentication required */
2317
+ 401: {
2318
+ headers: {
2319
+ [name: string]: unknown;
2320
+ };
2321
+ content: {
2322
+ "application/json": components["schemas"]["Error"];
2323
+ };
2324
+ };
2325
+ /** @description Insufficient permissions */
2326
+ 403: {
2327
+ headers: {
2328
+ [name: string]: unknown;
2329
+ };
2330
+ content: {
2331
+ "application/json": components["schemas"]["Error"];
2332
+ };
2333
+ };
2334
+ /** @description Not found in this organization */
2335
+ 404: {
2336
+ headers: {
2337
+ [name: string]: unknown;
2338
+ };
2339
+ content: {
2340
+ "application/json": components["schemas"]["Error"];
2341
+ };
2342
+ };
2343
+ /** @description Conflict with the current state */
2344
+ 409: {
2345
+ headers: {
2346
+ [name: string]: unknown;
2347
+ };
2348
+ content: {
2349
+ "application/json": components["schemas"]["Error"];
2350
+ };
2351
+ };
2352
+ /** @description Validation failed (issues carry JSON paths) */
2353
+ 422: {
2354
+ headers: {
2355
+ [name: string]: unknown;
2356
+ };
2357
+ content: {
2358
+ "application/json": components["schemas"]["Error"];
2359
+ };
2360
+ };
2361
+ };
2362
+ };
2363
+ getVersionSchema: {
2364
+ parameters: {
2365
+ query?: never;
2366
+ header?: never;
2367
+ path: {
2368
+ /** @description Template id or slug */
2369
+ template: string;
2370
+ /** @description Version number, `latest` or `draft` */
2371
+ version: string;
2372
+ };
2373
+ cookie?: never;
2374
+ };
2375
+ requestBody?: never;
2376
+ responses: {
2377
+ /** @description JSON Schema */
2378
+ 200: {
2379
+ headers: {
2380
+ [name: string]: unknown;
2381
+ };
2382
+ content: {
2383
+ "application/json": components["schemas"]["DataSchema"];
2384
+ };
2385
+ };
2386
+ /** @description Malformed request */
2387
+ 400: {
2388
+ headers: {
2389
+ [name: string]: unknown;
2390
+ };
2391
+ content: {
2392
+ "application/json": components["schemas"]["Error"];
2393
+ };
2394
+ };
2395
+ /** @description Authentication required */
2396
+ 401: {
2397
+ headers: {
2398
+ [name: string]: unknown;
2399
+ };
2400
+ content: {
2401
+ "application/json": components["schemas"]["Error"];
2402
+ };
2403
+ };
2404
+ /** @description Insufficient permissions */
2405
+ 403: {
2406
+ headers: {
2407
+ [name: string]: unknown;
2408
+ };
2409
+ content: {
2410
+ "application/json": components["schemas"]["Error"];
2411
+ };
2412
+ };
2413
+ /** @description Not found in this organization */
2414
+ 404: {
2415
+ headers: {
2416
+ [name: string]: unknown;
2417
+ };
2418
+ content: {
2419
+ "application/json": components["schemas"]["Error"];
2420
+ };
2421
+ };
2422
+ /** @description Conflict with the current state */
2423
+ 409: {
2424
+ headers: {
2425
+ [name: string]: unknown;
2426
+ };
2427
+ content: {
2428
+ "application/json": components["schemas"]["Error"];
2429
+ };
2430
+ };
2431
+ /** @description Validation failed (issues carry JSON paths) */
2432
+ 422: {
2433
+ headers: {
2434
+ [name: string]: unknown;
2435
+ };
2436
+ content: {
2437
+ "application/json": components["schemas"]["Error"];
2438
+ };
2439
+ };
2440
+ };
2441
+ };
2442
+ listSamples: {
2443
+ parameters: {
2444
+ query?: never;
2445
+ header?: never;
2446
+ path: {
2447
+ /** @description Template id or slug */
2448
+ template: string;
2449
+ /** @description Version number, `latest` or `draft` */
2450
+ version: string;
2451
+ };
2452
+ cookie?: never;
2453
+ };
2454
+ requestBody?: never;
2455
+ responses: {
2456
+ /** @description Samples */
2457
+ 200: {
2458
+ headers: {
2459
+ [name: string]: unknown;
2460
+ };
2461
+ content: {
2462
+ "application/json": {
2463
+ samples: components["schemas"]["Sample"][];
2464
+ };
2465
+ };
2466
+ };
2467
+ /** @description Malformed request */
2468
+ 400: {
2469
+ headers: {
2470
+ [name: string]: unknown;
2471
+ };
2472
+ content: {
2473
+ "application/json": components["schemas"]["Error"];
2474
+ };
2475
+ };
2476
+ /** @description Authentication required */
2477
+ 401: {
2478
+ headers: {
2479
+ [name: string]: unknown;
2480
+ };
2481
+ content: {
2482
+ "application/json": components["schemas"]["Error"];
2483
+ };
2484
+ };
2485
+ /** @description Insufficient permissions */
2486
+ 403: {
2487
+ headers: {
2488
+ [name: string]: unknown;
2489
+ };
2490
+ content: {
2491
+ "application/json": components["schemas"]["Error"];
2492
+ };
2493
+ };
2494
+ /** @description Not found in this organization */
2495
+ 404: {
2496
+ headers: {
2497
+ [name: string]: unknown;
2498
+ };
2499
+ content: {
2500
+ "application/json": components["schemas"]["Error"];
2501
+ };
2502
+ };
2503
+ /** @description Conflict with the current state */
2504
+ 409: {
2505
+ headers: {
2506
+ [name: string]: unknown;
2507
+ };
2508
+ content: {
2509
+ "application/json": components["schemas"]["Error"];
2510
+ };
2511
+ };
2512
+ /** @description Validation failed (issues carry JSON paths) */
2513
+ 422: {
2514
+ headers: {
2515
+ [name: string]: unknown;
2516
+ };
2517
+ content: {
2518
+ "application/json": components["schemas"]["Error"];
2519
+ };
2520
+ };
2521
+ };
2522
+ };
2523
+ getSample: {
2524
+ parameters: {
2525
+ query?: never;
2526
+ header?: never;
2527
+ path: {
2528
+ /** @description Template id or slug */
2529
+ template: string;
2530
+ /** @description Version number, `latest` or `draft` */
2531
+ version: string;
2532
+ sample: string;
2533
+ };
2534
+ cookie?: never;
2535
+ };
2536
+ requestBody?: never;
2537
+ responses: {
2538
+ /** @description Sample */
2539
+ 200: {
2540
+ headers: {
2541
+ [name: string]: unknown;
2542
+ };
2543
+ content: {
2544
+ "application/json": components["schemas"]["Sample"];
2545
+ };
2546
+ };
2547
+ /** @description Malformed request */
2548
+ 400: {
2549
+ headers: {
2550
+ [name: string]: unknown;
2551
+ };
2552
+ content: {
2553
+ "application/json": components["schemas"]["Error"];
2554
+ };
2555
+ };
2556
+ /** @description Authentication required */
2557
+ 401: {
2558
+ headers: {
2559
+ [name: string]: unknown;
2560
+ };
2561
+ content: {
2562
+ "application/json": components["schemas"]["Error"];
2563
+ };
2564
+ };
2565
+ /** @description Insufficient permissions */
2566
+ 403: {
2567
+ headers: {
2568
+ [name: string]: unknown;
2569
+ };
2570
+ content: {
2571
+ "application/json": components["schemas"]["Error"];
2572
+ };
2573
+ };
2574
+ /** @description Not found in this organization */
2575
+ 404: {
2576
+ headers: {
2577
+ [name: string]: unknown;
2578
+ };
2579
+ content: {
2580
+ "application/json": components["schemas"]["Error"];
2581
+ };
2582
+ };
2583
+ /** @description Conflict with the current state */
2584
+ 409: {
2585
+ headers: {
2586
+ [name: string]: unknown;
2587
+ };
2588
+ content: {
2589
+ "application/json": components["schemas"]["Error"];
2590
+ };
2591
+ };
2592
+ /** @description Validation failed (issues carry JSON paths) */
2593
+ 422: {
2594
+ headers: {
2595
+ [name: string]: unknown;
2596
+ };
2597
+ content: {
2598
+ "application/json": components["schemas"]["Error"];
2599
+ };
2600
+ };
2601
+ };
2602
+ };
2603
+ putDraftSample: {
2604
+ parameters: {
2605
+ query?: never;
2606
+ header?: never;
2607
+ path: {
2608
+ /** @description Template id or slug */
2609
+ template: string;
2610
+ sample: string;
2611
+ };
2612
+ cookie?: never;
2613
+ };
2614
+ requestBody: {
2615
+ content: {
2616
+ "application/json": {
2617
+ /** @description JSON data set */
2618
+ data?: unknown;
2619
+ };
2620
+ };
2621
+ };
2622
+ responses: {
2623
+ /** @description Replaced */
2624
+ 200: {
2625
+ headers: {
2626
+ [name: string]: unknown;
2627
+ };
2628
+ content: {
2629
+ "application/json": components["schemas"]["Sample"];
2630
+ };
2631
+ };
2632
+ /** @description Added */
2633
+ 201: {
2634
+ headers: {
2635
+ [name: string]: unknown;
2636
+ };
2637
+ content: {
2638
+ "application/json": components["schemas"]["Sample"];
2639
+ };
2640
+ };
2641
+ /** @description Malformed request */
2642
+ 400: {
2643
+ headers: {
2644
+ [name: string]: unknown;
2645
+ };
2646
+ content: {
2647
+ "application/json": components["schemas"]["Error"];
2648
+ };
2649
+ };
2650
+ /** @description Authentication required */
2651
+ 401: {
2652
+ headers: {
2653
+ [name: string]: unknown;
2654
+ };
2655
+ content: {
2656
+ "application/json": components["schemas"]["Error"];
2657
+ };
2658
+ };
2659
+ /** @description Insufficient permissions */
2660
+ 403: {
2661
+ headers: {
2662
+ [name: string]: unknown;
2663
+ };
2664
+ content: {
2665
+ "application/json": components["schemas"]["Error"];
2666
+ };
2667
+ };
2668
+ /** @description Not found in this organization */
2669
+ 404: {
2670
+ headers: {
2671
+ [name: string]: unknown;
2672
+ };
2673
+ content: {
2674
+ "application/json": components["schemas"]["Error"];
2675
+ };
2676
+ };
2677
+ /** @description Conflict with the current state */
2678
+ 409: {
2679
+ headers: {
2680
+ [name: string]: unknown;
2681
+ };
2682
+ content: {
2683
+ "application/json": components["schemas"]["Error"];
2684
+ };
2685
+ };
2686
+ /** @description Validation failed (issues carry JSON paths) */
2687
+ 422: {
2688
+ headers: {
2689
+ [name: string]: unknown;
2690
+ };
2691
+ content: {
2692
+ "application/json": components["schemas"]["Error"];
2693
+ };
2694
+ };
2695
+ };
2696
+ };
2697
+ deleteDraftSample: {
2698
+ parameters: {
2699
+ query?: never;
2700
+ header?: never;
2701
+ path: {
2702
+ /** @description Template id or slug */
2703
+ template: string;
2704
+ sample: string;
2705
+ };
2706
+ cookie?: never;
2707
+ };
2708
+ requestBody?: never;
2709
+ responses: {
2710
+ /** @description Removed */
2711
+ 204: {
2712
+ headers: {
2713
+ [name: string]: unknown;
2714
+ };
2715
+ content?: never;
2716
+ };
2717
+ /** @description Malformed request */
2718
+ 400: {
2719
+ headers: {
2720
+ [name: string]: unknown;
2721
+ };
2722
+ content: {
2723
+ "application/json": components["schemas"]["Error"];
2724
+ };
2725
+ };
2726
+ /** @description Authentication required */
2727
+ 401: {
2728
+ headers: {
2729
+ [name: string]: unknown;
2730
+ };
2731
+ content: {
2732
+ "application/json": components["schemas"]["Error"];
2733
+ };
2734
+ };
2735
+ /** @description Insufficient permissions */
2736
+ 403: {
2737
+ headers: {
2738
+ [name: string]: unknown;
2739
+ };
2740
+ content: {
2741
+ "application/json": components["schemas"]["Error"];
2742
+ };
2743
+ };
2744
+ /** @description Not found in this organization */
2745
+ 404: {
2746
+ headers: {
2747
+ [name: string]: unknown;
2748
+ };
2749
+ content: {
2750
+ "application/json": components["schemas"]["Error"];
2751
+ };
2752
+ };
2753
+ /** @description Conflict with the current state */
2754
+ 409: {
2755
+ headers: {
2756
+ [name: string]: unknown;
2757
+ };
2758
+ content: {
2759
+ "application/json": components["schemas"]["Error"];
2760
+ };
2761
+ };
2762
+ /** @description Validation failed (issues carry JSON paths) */
2763
+ 422: {
2764
+ headers: {
2765
+ [name: string]: unknown;
2766
+ };
2767
+ content: {
2768
+ "application/json": components["schemas"]["Error"];
2769
+ };
2770
+ };
2771
+ };
2772
+ };
2773
+ renameDraftSample: {
2774
+ parameters: {
2775
+ query?: never;
2776
+ header?: never;
2777
+ path: {
2778
+ /** @description Template id or slug */
2779
+ template: string;
2780
+ sample: string;
2781
+ };
2782
+ cookie?: never;
2783
+ };
2784
+ requestBody: {
2785
+ content: {
2786
+ "application/json": {
2787
+ /** @example facture-standard */
2788
+ name: string;
2789
+ };
2790
+ };
2791
+ };
2792
+ responses: {
2793
+ /** @description Renamed */
2794
+ 200: {
2795
+ headers: {
2796
+ [name: string]: unknown;
2797
+ };
2798
+ content: {
2799
+ "application/json": components["schemas"]["Sample"];
2800
+ };
2801
+ };
2802
+ /** @description Malformed request */
2803
+ 400: {
2804
+ headers: {
2805
+ [name: string]: unknown;
2806
+ };
2807
+ content: {
2808
+ "application/json": components["schemas"]["Error"];
2809
+ };
2810
+ };
2811
+ /** @description Authentication required */
2812
+ 401: {
2813
+ headers: {
2814
+ [name: string]: unknown;
2815
+ };
2816
+ content: {
2817
+ "application/json": components["schemas"]["Error"];
2818
+ };
2819
+ };
2820
+ /** @description Insufficient permissions */
2821
+ 403: {
2822
+ headers: {
2823
+ [name: string]: unknown;
2824
+ };
2825
+ content: {
2826
+ "application/json": components["schemas"]["Error"];
2827
+ };
2828
+ };
2829
+ /** @description Not found in this organization */
2830
+ 404: {
2831
+ headers: {
2832
+ [name: string]: unknown;
2833
+ };
2834
+ content: {
2835
+ "application/json": components["schemas"]["Error"];
2836
+ };
2837
+ };
2838
+ /** @description Conflict with the current state */
2839
+ 409: {
2840
+ headers: {
2841
+ [name: string]: unknown;
2842
+ };
2843
+ content: {
2844
+ "application/json": components["schemas"]["Error"];
2845
+ };
2846
+ };
2847
+ /** @description Validation failed (issues carry JSON paths) */
2848
+ 422: {
2849
+ headers: {
2850
+ [name: string]: unknown;
2851
+ };
2852
+ content: {
2853
+ "application/json": components["schemas"]["Error"];
2854
+ };
2855
+ };
2856
+ };
2857
+ };
2858
+ getVersionDocs: {
2859
+ parameters: {
2860
+ query?: {
2861
+ format?: "json" | "html";
2862
+ lang?: "fr" | "en";
2863
+ };
2864
+ header?: never;
2865
+ path: {
2866
+ /** @description Template id or slug */
2867
+ template: string;
2868
+ /** @description Version number, `latest` or `draft` */
2869
+ version: string;
2870
+ };
2871
+ cookie?: never;
2872
+ };
2873
+ requestBody?: never;
2874
+ responses: {
2875
+ /** @description Documentation */
2876
+ 200: {
2877
+ headers: {
2878
+ [name: string]: unknown;
2879
+ };
2880
+ content: {
2881
+ "application/json": components["schemas"]["VersionDocs"];
2882
+ "text/html": string;
2883
+ };
2884
+ };
2885
+ /** @description Malformed request */
2886
+ 400: {
2887
+ headers: {
2888
+ [name: string]: unknown;
2889
+ };
2890
+ content: {
2891
+ "application/json": components["schemas"]["Error"];
2892
+ };
2893
+ };
2894
+ /** @description Authentication required */
2895
+ 401: {
2896
+ headers: {
2897
+ [name: string]: unknown;
2898
+ };
2899
+ content: {
2900
+ "application/json": components["schemas"]["Error"];
2901
+ };
2902
+ };
2903
+ /** @description Insufficient permissions */
2904
+ 403: {
2905
+ headers: {
2906
+ [name: string]: unknown;
2907
+ };
2908
+ content: {
2909
+ "application/json": components["schemas"]["Error"];
2910
+ };
2911
+ };
2912
+ /** @description Not found in this organization */
2913
+ 404: {
2914
+ headers: {
2915
+ [name: string]: unknown;
2916
+ };
2917
+ content: {
2918
+ "application/json": components["schemas"]["Error"];
2919
+ };
2920
+ };
2921
+ /** @description Conflict with the current state */
2922
+ 409: {
2923
+ headers: {
2924
+ [name: string]: unknown;
2925
+ };
2926
+ content: {
2927
+ "application/json": components["schemas"]["Error"];
2928
+ };
2929
+ };
2930
+ /** @description Validation failed (issues carry JSON paths) */
2931
+ 422: {
2932
+ headers: {
2933
+ [name: string]: unknown;
2934
+ };
2935
+ content: {
2936
+ "application/json": components["schemas"]["Error"];
2937
+ };
2938
+ };
2939
+ };
2940
+ };
2941
+ listAssets: {
2942
+ parameters: {
2943
+ query?: never;
2944
+ header?: never;
2945
+ path?: never;
2946
+ cookie?: never;
2947
+ };
2948
+ requestBody?: never;
2949
+ responses: {
2950
+ /** @description Assets */
2951
+ 200: {
2952
+ headers: {
2953
+ [name: string]: unknown;
2954
+ };
2955
+ content: {
2956
+ "application/json": {
2957
+ assets: components["schemas"]["Asset"][];
2958
+ };
2959
+ };
2960
+ };
2961
+ /** @description Malformed request */
2962
+ 400: {
2963
+ headers: {
2964
+ [name: string]: unknown;
2965
+ };
2966
+ content: {
2967
+ "application/json": components["schemas"]["Error"];
2968
+ };
2969
+ };
2970
+ /** @description Authentication required */
2971
+ 401: {
2972
+ headers: {
2973
+ [name: string]: unknown;
2974
+ };
2975
+ content: {
2976
+ "application/json": components["schemas"]["Error"];
2977
+ };
2978
+ };
2979
+ /** @description Insufficient permissions */
2980
+ 403: {
2981
+ headers: {
2982
+ [name: string]: unknown;
2983
+ };
2984
+ content: {
2985
+ "application/json": components["schemas"]["Error"];
2986
+ };
2987
+ };
2988
+ /** @description Not found in this organization */
2989
+ 404: {
2990
+ headers: {
2991
+ [name: string]: unknown;
2992
+ };
2993
+ content: {
2994
+ "application/json": components["schemas"]["Error"];
2995
+ };
2996
+ };
2997
+ /** @description Conflict with the current state */
2998
+ 409: {
2999
+ headers: {
3000
+ [name: string]: unknown;
3001
+ };
3002
+ content: {
3003
+ "application/json": components["schemas"]["Error"];
3004
+ };
3005
+ };
3006
+ /** @description Validation failed (issues carry JSON paths) */
3007
+ 422: {
3008
+ headers: {
3009
+ [name: string]: unknown;
3010
+ };
3011
+ content: {
3012
+ "application/json": components["schemas"]["Error"];
3013
+ };
3014
+ };
3015
+ };
3016
+ };
3017
+ createAsset: {
3018
+ parameters: {
3019
+ query?: never;
3020
+ header?: never;
3021
+ path?: never;
3022
+ cookie?: never;
3023
+ };
3024
+ requestBody: {
3025
+ content: {
3026
+ "application/json": {
3027
+ name: string;
3028
+ /** @enum {string} */
3029
+ mime: "image/png" | "image/jpeg" | "image/svg+xml" | "image/gif" | "image/webp" | "application/pdf";
3030
+ /** @description Base64, at most 20971520 bytes decoded */
3031
+ content: string;
3032
+ };
3033
+ };
3034
+ };
3035
+ responses: {
3036
+ /** @description Stored */
3037
+ 201: {
3038
+ headers: {
3039
+ [name: string]: unknown;
3040
+ };
3041
+ content: {
3042
+ "application/json": components["schemas"]["Asset"];
3043
+ };
3044
+ };
3045
+ /** @description Malformed request */
3046
+ 400: {
3047
+ headers: {
3048
+ [name: string]: unknown;
3049
+ };
3050
+ content: {
3051
+ "application/json": components["schemas"]["Error"];
3052
+ };
3053
+ };
3054
+ /** @description Authentication required */
3055
+ 401: {
3056
+ headers: {
3057
+ [name: string]: unknown;
3058
+ };
3059
+ content: {
3060
+ "application/json": components["schemas"]["Error"];
3061
+ };
3062
+ };
3063
+ /** @description Insufficient permissions */
3064
+ 403: {
3065
+ headers: {
3066
+ [name: string]: unknown;
3067
+ };
3068
+ content: {
3069
+ "application/json": components["schemas"]["Error"];
3070
+ };
3071
+ };
3072
+ /** @description Not found in this organization */
3073
+ 404: {
3074
+ headers: {
3075
+ [name: string]: unknown;
3076
+ };
3077
+ content: {
3078
+ "application/json": components["schemas"]["Error"];
3079
+ };
3080
+ };
3081
+ /** @description Conflict with the current state */
3082
+ 409: {
3083
+ headers: {
3084
+ [name: string]: unknown;
3085
+ };
3086
+ content: {
3087
+ "application/json": components["schemas"]["Error"];
3088
+ };
3089
+ };
3090
+ /** @description Validation failed (issues carry JSON paths) */
3091
+ 422: {
3092
+ headers: {
3093
+ [name: string]: unknown;
3094
+ };
3095
+ content: {
3096
+ "application/json": components["schemas"]["Error"];
3097
+ };
3098
+ };
3099
+ };
3100
+ };
3101
+ listFonts: {
3102
+ parameters: {
3103
+ query?: never;
3104
+ header?: never;
3105
+ path?: never;
3106
+ cookie?: never;
3107
+ };
3108
+ requestBody?: never;
3109
+ responses: {
3110
+ /** @description Fonts */
3111
+ 200: {
3112
+ headers: {
3113
+ [name: string]: unknown;
3114
+ };
3115
+ content: {
3116
+ "application/json": {
3117
+ fonts: components["schemas"]["Font"][];
3118
+ families: components["schemas"]["FontFamily"][];
3119
+ };
3120
+ };
3121
+ };
3122
+ /** @description Malformed request */
3123
+ 400: {
3124
+ headers: {
3125
+ [name: string]: unknown;
3126
+ };
3127
+ content: {
3128
+ "application/json": components["schemas"]["Error"];
3129
+ };
3130
+ };
3131
+ /** @description Authentication required */
3132
+ 401: {
3133
+ headers: {
3134
+ [name: string]: unknown;
3135
+ };
3136
+ content: {
3137
+ "application/json": components["schemas"]["Error"];
3138
+ };
3139
+ };
3140
+ /** @description Insufficient permissions */
3141
+ 403: {
3142
+ headers: {
3143
+ [name: string]: unknown;
3144
+ };
3145
+ content: {
3146
+ "application/json": components["schemas"]["Error"];
3147
+ };
3148
+ };
3149
+ /** @description Not found in this organization */
3150
+ 404: {
3151
+ headers: {
3152
+ [name: string]: unknown;
3153
+ };
3154
+ content: {
3155
+ "application/json": components["schemas"]["Error"];
3156
+ };
3157
+ };
3158
+ /** @description Conflict with the current state */
3159
+ 409: {
3160
+ headers: {
3161
+ [name: string]: unknown;
3162
+ };
3163
+ content: {
3164
+ "application/json": components["schemas"]["Error"];
3165
+ };
3166
+ };
3167
+ /** @description Validation failed (issues carry JSON paths) */
3168
+ 422: {
3169
+ headers: {
3170
+ [name: string]: unknown;
3171
+ };
3172
+ content: {
3173
+ "application/json": components["schemas"]["Error"];
3174
+ };
3175
+ };
3176
+ };
3177
+ };
3178
+ createFont: {
3179
+ parameters: {
3180
+ query?: never;
3181
+ header?: never;
3182
+ path?: never;
3183
+ cookie?: never;
3184
+ };
3185
+ requestBody: {
3186
+ content: {
3187
+ "application/json": {
3188
+ /** @example Corporate-Regular.ttf */
3189
+ name: string;
3190
+ /** @description Base64, at most 20971520 bytes decoded */
3191
+ content: string;
3192
+ /** @example proprietary */
3193
+ license?: string;
3194
+ };
3195
+ };
3196
+ };
3197
+ responses: {
3198
+ /** @description Already deposited */
3199
+ 200: {
3200
+ headers: {
3201
+ [name: string]: unknown;
3202
+ };
3203
+ content: {
3204
+ "application/json": components["schemas"]["Font"];
3205
+ };
3206
+ };
3207
+ /** @description Deposited */
3208
+ 201: {
3209
+ headers: {
3210
+ [name: string]: unknown;
3211
+ };
3212
+ content: {
3213
+ "application/json": components["schemas"]["Font"];
3214
+ };
3215
+ };
3216
+ /** @description Malformed request */
3217
+ 400: {
3218
+ headers: {
3219
+ [name: string]: unknown;
3220
+ };
3221
+ content: {
3222
+ "application/json": components["schemas"]["Error"];
3223
+ };
3224
+ };
3225
+ /** @description Authentication required */
3226
+ 401: {
3227
+ headers: {
3228
+ [name: string]: unknown;
3229
+ };
3230
+ content: {
3231
+ "application/json": components["schemas"]["Error"];
3232
+ };
3233
+ };
3234
+ /** @description Insufficient permissions */
3235
+ 403: {
3236
+ headers: {
3237
+ [name: string]: unknown;
3238
+ };
3239
+ content: {
3240
+ "application/json": components["schemas"]["Error"];
3241
+ };
3242
+ };
3243
+ /** @description Not found in this organization */
3244
+ 404: {
3245
+ headers: {
3246
+ [name: string]: unknown;
3247
+ };
3248
+ content: {
3249
+ "application/json": components["schemas"]["Error"];
3250
+ };
3251
+ };
3252
+ /** @description Conflict with the current state */
3253
+ 409: {
3254
+ headers: {
3255
+ [name: string]: unknown;
3256
+ };
3257
+ content: {
3258
+ "application/json": components["schemas"]["Error"];
3259
+ };
3260
+ };
3261
+ /** @description Validation failed (issues carry JSON paths) */
3262
+ 422: {
3263
+ headers: {
3264
+ [name: string]: unknown;
3265
+ };
3266
+ content: {
3267
+ "application/json": components["schemas"]["Error"];
3268
+ };
3269
+ };
3270
+ };
3271
+ };
3272
+ listRenders: {
3273
+ parameters: {
3274
+ query?: {
3275
+ /** @description Template id or slug */
3276
+ template?: string;
3277
+ version?: number;
3278
+ /** @description Created at or after (inclusive) */
3279
+ from?: string;
3280
+ /** @description Created before (exclusive) */
3281
+ to?: string;
3282
+ callerType?: "user" | "api_key";
3283
+ /** @description API key id or user id */
3284
+ callerId?: string;
3285
+ profile?: "standard" | "archive" | "accessible";
3286
+ idempotencyKey?: string;
3287
+ /** @description By creation date */
3288
+ order?: "desc" | "asc";
3289
+ status?: "succeeded" | "failed" | "expired";
3290
+ limit?: number;
3291
+ /** @description `nextCursor` of the previous page */
3292
+ cursor?: string;
3293
+ };
3294
+ header?: never;
3295
+ path?: never;
3296
+ cookie?: never;
3297
+ };
3298
+ requestBody?: never;
3299
+ responses: {
3300
+ /** @description A page of the journal */
3301
+ 200: {
3302
+ headers: {
3303
+ [name: string]: unknown;
3304
+ };
3305
+ content: {
3306
+ "application/json": {
3307
+ renders: components["schemas"]["Render"][];
3308
+ nextCursor: string | null;
3309
+ };
3310
+ };
3311
+ };
3312
+ /** @description Malformed request */
3313
+ 400: {
3314
+ headers: {
3315
+ [name: string]: unknown;
3316
+ };
3317
+ content: {
3318
+ "application/json": components["schemas"]["Error"];
3319
+ };
3320
+ };
3321
+ /** @description Authentication required */
3322
+ 401: {
3323
+ headers: {
3324
+ [name: string]: unknown;
3325
+ };
3326
+ content: {
3327
+ "application/json": components["schemas"]["Error"];
3328
+ };
3329
+ };
3330
+ /** @description Insufficient permissions */
3331
+ 403: {
3332
+ headers: {
3333
+ [name: string]: unknown;
3334
+ };
3335
+ content: {
3336
+ "application/json": components["schemas"]["Error"];
3337
+ };
3338
+ };
3339
+ /** @description Not found in this organization */
3340
+ 404: {
3341
+ headers: {
3342
+ [name: string]: unknown;
3343
+ };
3344
+ content: {
3345
+ "application/json": components["schemas"]["Error"];
3346
+ };
3347
+ };
3348
+ /** @description Conflict with the current state */
3349
+ 409: {
3350
+ headers: {
3351
+ [name: string]: unknown;
3352
+ };
3353
+ content: {
3354
+ "application/json": components["schemas"]["Error"];
3355
+ };
3356
+ };
3357
+ /** @description Validation failed (issues carry JSON paths) */
3358
+ 422: {
3359
+ headers: {
3360
+ [name: string]: unknown;
3361
+ };
3362
+ content: {
3363
+ "application/json": components["schemas"]["Error"];
3364
+ };
3365
+ };
3366
+ };
3367
+ };
3368
+ createRender: {
3369
+ parameters: {
3370
+ query?: never;
3371
+ header?: {
3372
+ /** @description Replays return the first result */
3373
+ "idempotency-key"?: string;
3374
+ };
3375
+ path?: never;
3376
+ cookie?: never;
3377
+ };
3378
+ requestBody: {
3379
+ content: {
3380
+ "application/json": components["schemas"]["RenderRequest"];
3381
+ };
3382
+ };
3383
+ responses: {
3384
+ /** @description PDF (default) or render description */
3385
+ 200: {
3386
+ headers: {
3387
+ [name: string]: unknown;
3388
+ };
3389
+ content: {
3390
+ "application/pdf": string;
3391
+ "application/json": {
3392
+ render: components["schemas"]["Render"];
3393
+ document: components["schemas"]["Document"];
3394
+ /** @description `version.latest`: an API key asked for `latest`; pin a version number in production */
3395
+ warnings: components["schemas"]["Warning"][];
3396
+ };
3397
+ };
3398
+ };
3399
+ /** @description Malformed request */
3400
+ 400: {
3401
+ headers: {
3402
+ [name: string]: unknown;
3403
+ };
3404
+ content: {
3405
+ "application/json": components["schemas"]["Error"];
3406
+ };
3407
+ };
3408
+ /** @description Authentication required */
3409
+ 401: {
3410
+ headers: {
3411
+ [name: string]: unknown;
3412
+ };
3413
+ content: {
3414
+ "application/json": components["schemas"]["Error"];
3415
+ };
3416
+ };
3417
+ /** @description Insufficient permissions */
3418
+ 403: {
3419
+ headers: {
3420
+ [name: string]: unknown;
3421
+ };
3422
+ content: {
3423
+ "application/json": components["schemas"]["Error"];
3424
+ };
3425
+ };
3426
+ /** @description Not found in this organization */
3427
+ 404: {
3428
+ headers: {
3429
+ [name: string]: unknown;
3430
+ };
3431
+ content: {
3432
+ "application/json": components["schemas"]["Error"];
3433
+ };
3434
+ };
3435
+ /** @description Conflict with the current state */
3436
+ 409: {
3437
+ headers: {
3438
+ [name: string]: unknown;
3439
+ };
3440
+ content: {
3441
+ "application/json": components["schemas"]["Error"];
3442
+ };
3443
+ };
3444
+ /** @description The version is archived */
3445
+ 410: {
3446
+ headers: {
3447
+ [name: string]: unknown;
3448
+ };
3449
+ content: {
3450
+ "application/json": {
3451
+ [key: string]: unknown;
3452
+ };
3453
+ };
3454
+ };
3455
+ /** @description Validation failed (issues carry JSON paths) */
3456
+ 422: {
3457
+ headers: {
3458
+ [name: string]: unknown;
3459
+ };
3460
+ content: {
3461
+ "application/json": components["schemas"]["Error"];
3462
+ };
3463
+ };
3464
+ /** @description Rate limit or quota exceeded */
3465
+ 429: {
3466
+ headers: {
3467
+ [name: string]: unknown;
3468
+ };
3469
+ content: {
3470
+ "application/json": components["schemas"]["Error"];
3471
+ };
3472
+ };
3473
+ };
3474
+ };
3475
+ getRender: {
3476
+ parameters: {
3477
+ query?: never;
3478
+ header?: never;
3479
+ path: {
3480
+ renderId: string;
3481
+ };
3482
+ cookie?: never;
3483
+ };
3484
+ requestBody?: never;
3485
+ responses: {
3486
+ /** @description Render */
3487
+ 200: {
3488
+ headers: {
3489
+ [name: string]: unknown;
3490
+ };
3491
+ content: {
3492
+ "application/json": components["schemas"]["RenderDetail"];
3493
+ };
3494
+ };
3495
+ /** @description Malformed request */
3496
+ 400: {
3497
+ headers: {
3498
+ [name: string]: unknown;
3499
+ };
3500
+ content: {
3501
+ "application/json": components["schemas"]["Error"];
3502
+ };
3503
+ };
3504
+ /** @description Authentication required */
3505
+ 401: {
3506
+ headers: {
3507
+ [name: string]: unknown;
3508
+ };
3509
+ content: {
3510
+ "application/json": components["schemas"]["Error"];
3511
+ };
3512
+ };
3513
+ /** @description Insufficient permissions */
3514
+ 403: {
3515
+ headers: {
3516
+ [name: string]: unknown;
3517
+ };
3518
+ content: {
3519
+ "application/json": components["schemas"]["Error"];
3520
+ };
3521
+ };
3522
+ /** @description Not found in this organization */
3523
+ 404: {
3524
+ headers: {
3525
+ [name: string]: unknown;
3526
+ };
3527
+ content: {
3528
+ "application/json": components["schemas"]["Error"];
3529
+ };
3530
+ };
3531
+ /** @description Conflict with the current state */
3532
+ 409: {
3533
+ headers: {
3534
+ [name: string]: unknown;
3535
+ };
3536
+ content: {
3537
+ "application/json": components["schemas"]["Error"];
3538
+ };
3539
+ };
3540
+ /** @description Validation failed (issues carry JSON paths) */
3541
+ 422: {
3542
+ headers: {
3543
+ [name: string]: unknown;
3544
+ };
3545
+ content: {
3546
+ "application/json": components["schemas"]["Error"];
3547
+ };
3548
+ };
3549
+ };
3550
+ };
3551
+ verifyRender: {
3552
+ parameters: {
3553
+ query?: never;
3554
+ header?: never;
3555
+ path: {
3556
+ renderId: string;
3557
+ };
3558
+ cookie?: never;
3559
+ };
3560
+ requestBody?: {
3561
+ content: {
3562
+ "application/json": {
3563
+ /** @description Data of the render, when the organization does not keep them */
3564
+ data?: unknown;
3565
+ };
3566
+ };
3567
+ };
3568
+ responses: {
3569
+ /** @description Comparison */
3570
+ 200: {
3571
+ headers: {
3572
+ [name: string]: unknown;
3573
+ };
3574
+ content: {
3575
+ "application/json": components["schemas"]["Verification"];
3576
+ };
3577
+ };
3578
+ /** @description Malformed request */
3579
+ 400: {
3580
+ headers: {
3581
+ [name: string]: unknown;
3582
+ };
3583
+ content: {
3584
+ "application/json": components["schemas"]["Error"];
3585
+ };
3586
+ };
3587
+ /** @description Authentication required */
3588
+ 401: {
3589
+ headers: {
3590
+ [name: string]: unknown;
3591
+ };
3592
+ content: {
3593
+ "application/json": components["schemas"]["Error"];
3594
+ };
3595
+ };
3596
+ /** @description Insufficient permissions */
3597
+ 403: {
3598
+ headers: {
3599
+ [name: string]: unknown;
3600
+ };
3601
+ content: {
3602
+ "application/json": components["schemas"]["Error"];
3603
+ };
3604
+ };
3605
+ /** @description Not found in this organization */
3606
+ 404: {
3607
+ headers: {
3608
+ [name: string]: unknown;
3609
+ };
3610
+ content: {
3611
+ "application/json": components["schemas"]["Error"];
3612
+ };
3613
+ };
3614
+ /** @description Conflict with the current state */
3615
+ 409: {
3616
+ headers: {
3617
+ [name: string]: unknown;
3618
+ };
3619
+ content: {
3620
+ "application/json": components["schemas"]["Error"];
3621
+ };
3622
+ };
3623
+ /** @description Validation failed (issues carry JSON paths) */
3624
+ 422: {
3625
+ headers: {
3626
+ [name: string]: unknown;
3627
+ };
3628
+ content: {
3629
+ "application/json": components["schemas"]["Error"];
3630
+ };
3631
+ };
3632
+ };
3633
+ };
3634
+ getDocument: {
3635
+ parameters: {
3636
+ query?: never;
3637
+ header?: never;
3638
+ path: {
3639
+ documentId: string;
3640
+ };
3641
+ cookie?: never;
3642
+ };
3643
+ requestBody?: never;
3644
+ responses: {
3645
+ /** @description Document */
3646
+ 200: {
3647
+ headers: {
3648
+ [name: string]: unknown;
3649
+ };
3650
+ content: {
3651
+ "application/json": components["schemas"]["Document"];
3652
+ };
3653
+ };
3654
+ /** @description Malformed request */
3655
+ 400: {
3656
+ headers: {
3657
+ [name: string]: unknown;
3658
+ };
3659
+ content: {
3660
+ "application/json": components["schemas"]["Error"];
3661
+ };
3662
+ };
3663
+ /** @description Authentication required */
3664
+ 401: {
3665
+ headers: {
3666
+ [name: string]: unknown;
3667
+ };
3668
+ content: {
3669
+ "application/json": components["schemas"]["Error"];
3670
+ };
3671
+ };
3672
+ /** @description Insufficient permissions */
3673
+ 403: {
3674
+ headers: {
3675
+ [name: string]: unknown;
3676
+ };
3677
+ content: {
3678
+ "application/json": components["schemas"]["Error"];
3679
+ };
3680
+ };
3681
+ /** @description Not found in this organization */
3682
+ 404: {
3683
+ headers: {
3684
+ [name: string]: unknown;
3685
+ };
3686
+ content: {
3687
+ "application/json": components["schemas"]["Error"];
3688
+ };
3689
+ };
3690
+ /** @description Conflict with the current state */
3691
+ 409: {
3692
+ headers: {
3693
+ [name: string]: unknown;
3694
+ };
3695
+ content: {
3696
+ "application/json": components["schemas"]["Error"];
3697
+ };
3698
+ };
3699
+ /** @description Deleted by the retention */
3700
+ 410: {
3701
+ headers: {
3702
+ [name: string]: unknown;
3703
+ };
3704
+ content: {
3705
+ "application/json": {
3706
+ [key: string]: unknown;
3707
+ };
3708
+ };
3709
+ };
3710
+ /** @description Validation failed (issues carry JSON paths) */
3711
+ 422: {
3712
+ headers: {
3713
+ [name: string]: unknown;
3714
+ };
3715
+ content: {
3716
+ "application/json": components["schemas"]["Error"];
3717
+ };
3718
+ };
3719
+ };
3720
+ };
3721
+ listJobs: {
3722
+ parameters: {
3723
+ query?: {
3724
+ /** @description Template id or slug */
3725
+ template?: string;
3726
+ version?: number;
3727
+ /** @description Created at or after (inclusive) */
3728
+ from?: string;
3729
+ /** @description Created before (exclusive) */
3730
+ to?: string;
3731
+ callerType?: "user" | "api_key";
3732
+ /** @description API key id or user id */
3733
+ callerId?: string;
3734
+ profile?: "standard" | "archive" | "accessible";
3735
+ idempotencyKey?: string;
3736
+ /** @description By creation date */
3737
+ order?: "desc" | "asc";
3738
+ status?: "queued" | "running" | "succeeded" | "failed";
3739
+ limit?: number;
3740
+ /** @description `nextCursor` of the previous page */
3741
+ cursor?: string;
3742
+ };
3743
+ header?: never;
3744
+ path?: never;
3745
+ cookie?: never;
3746
+ };
3747
+ requestBody?: never;
3748
+ responses: {
3749
+ /** @description Jobs */
3750
+ 200: {
3751
+ headers: {
3752
+ [name: string]: unknown;
3753
+ };
3754
+ content: {
3755
+ "application/json": {
3756
+ jobs: components["schemas"]["Job"][];
3757
+ nextCursor: string | null;
3758
+ };
3759
+ };
3760
+ };
3761
+ /** @description Malformed request */
3762
+ 400: {
3763
+ headers: {
3764
+ [name: string]: unknown;
3765
+ };
3766
+ content: {
3767
+ "application/json": components["schemas"]["Error"];
3768
+ };
3769
+ };
3770
+ /** @description Authentication required */
3771
+ 401: {
3772
+ headers: {
3773
+ [name: string]: unknown;
3774
+ };
3775
+ content: {
3776
+ "application/json": components["schemas"]["Error"];
3777
+ };
3778
+ };
3779
+ /** @description Insufficient permissions */
3780
+ 403: {
3781
+ headers: {
3782
+ [name: string]: unknown;
3783
+ };
3784
+ content: {
3785
+ "application/json": components["schemas"]["Error"];
3786
+ };
3787
+ };
3788
+ /** @description Not found in this organization */
3789
+ 404: {
3790
+ headers: {
3791
+ [name: string]: unknown;
3792
+ };
3793
+ content: {
3794
+ "application/json": components["schemas"]["Error"];
3795
+ };
3796
+ };
3797
+ /** @description Conflict with the current state */
3798
+ 409: {
3799
+ headers: {
3800
+ [name: string]: unknown;
3801
+ };
3802
+ content: {
3803
+ "application/json": components["schemas"]["Error"];
3804
+ };
3805
+ };
3806
+ /** @description Validation failed (issues carry JSON paths) */
3807
+ 422: {
3808
+ headers: {
3809
+ [name: string]: unknown;
3810
+ };
3811
+ content: {
3812
+ "application/json": components["schemas"]["Error"];
3813
+ };
3814
+ };
3815
+ };
3816
+ };
3817
+ createJob: {
3818
+ parameters: {
3819
+ query?: never;
3820
+ header?: {
3821
+ /** @description Replays return the first result */
3822
+ "idempotency-key"?: string;
3823
+ };
3824
+ path?: never;
3825
+ cookie?: never;
3826
+ };
3827
+ requestBody: {
3828
+ content: {
3829
+ "application/json": components["schemas"]["JobRequest"];
3830
+ };
3831
+ };
3832
+ responses: {
3833
+ /** @description Accepted */
3834
+ 202: {
3835
+ headers: {
3836
+ [name: string]: unknown;
3837
+ };
3838
+ content: {
3839
+ "application/json": components["schemas"]["JobAccepted"];
3840
+ };
3841
+ };
3842
+ /** @description Malformed request */
3843
+ 400: {
3844
+ headers: {
3845
+ [name: string]: unknown;
3846
+ };
3847
+ content: {
3848
+ "application/json": components["schemas"]["Error"];
3849
+ };
3850
+ };
3851
+ /** @description Authentication required */
3852
+ 401: {
3853
+ headers: {
3854
+ [name: string]: unknown;
3855
+ };
3856
+ content: {
3857
+ "application/json": components["schemas"]["Error"];
3858
+ };
3859
+ };
3860
+ /** @description Insufficient permissions */
3861
+ 403: {
3862
+ headers: {
3863
+ [name: string]: unknown;
3864
+ };
3865
+ content: {
3866
+ "application/json": components["schemas"]["Error"];
3867
+ };
3868
+ };
3869
+ /** @description Not found in this organization */
3870
+ 404: {
3871
+ headers: {
3872
+ [name: string]: unknown;
3873
+ };
3874
+ content: {
3875
+ "application/json": components["schemas"]["Error"];
3876
+ };
3877
+ };
3878
+ /** @description Conflict with the current state */
3879
+ 409: {
3880
+ headers: {
3881
+ [name: string]: unknown;
3882
+ };
3883
+ content: {
3884
+ "application/json": components["schemas"]["Error"];
3885
+ };
3886
+ };
3887
+ /** @description Validation failed (issues carry JSON paths) */
3888
+ 422: {
3889
+ headers: {
3890
+ [name: string]: unknown;
3891
+ };
3892
+ content: {
3893
+ "application/json": components["schemas"]["Error"];
3894
+ };
3895
+ };
3896
+ /** @description Rate limit or quota exceeded */
3897
+ 429: {
3898
+ headers: {
3899
+ [name: string]: unknown;
3900
+ };
3901
+ content: {
3902
+ "application/json": components["schemas"]["Error"];
3903
+ };
3904
+ };
3905
+ };
3906
+ };
3907
+ getJob: {
3908
+ parameters: {
3909
+ query?: never;
3910
+ header?: never;
3911
+ path: {
3912
+ jobId: string;
3913
+ };
3914
+ cookie?: never;
3915
+ };
3916
+ requestBody?: never;
3917
+ responses: {
3918
+ /** @description Job */
3919
+ 200: {
3920
+ headers: {
3921
+ [name: string]: unknown;
3922
+ };
3923
+ content: {
3924
+ "application/json": components["schemas"]["Job"];
3925
+ };
3926
+ };
3927
+ /** @description Malformed request */
3928
+ 400: {
3929
+ headers: {
3930
+ [name: string]: unknown;
3931
+ };
3932
+ content: {
3933
+ "application/json": components["schemas"]["Error"];
3934
+ };
3935
+ };
3936
+ /** @description Authentication required */
3937
+ 401: {
3938
+ headers: {
3939
+ [name: string]: unknown;
3940
+ };
3941
+ content: {
3942
+ "application/json": components["schemas"]["Error"];
3943
+ };
3944
+ };
3945
+ /** @description Insufficient permissions */
3946
+ 403: {
3947
+ headers: {
3948
+ [name: string]: unknown;
3949
+ };
3950
+ content: {
3951
+ "application/json": components["schemas"]["Error"];
3952
+ };
3953
+ };
3954
+ /** @description Not found in this organization */
3955
+ 404: {
3956
+ headers: {
3957
+ [name: string]: unknown;
3958
+ };
3959
+ content: {
3960
+ "application/json": components["schemas"]["Error"];
3961
+ };
3962
+ };
3963
+ /** @description Conflict with the current state */
3964
+ 409: {
3965
+ headers: {
3966
+ [name: string]: unknown;
3967
+ };
3968
+ content: {
3969
+ "application/json": components["schemas"]["Error"];
3970
+ };
3971
+ };
3972
+ /** @description Validation failed (issues carry JSON paths) */
3973
+ 422: {
3974
+ headers: {
3975
+ [name: string]: unknown;
3976
+ };
3977
+ content: {
3978
+ "application/json": components["schemas"]["Error"];
3979
+ };
3980
+ };
3981
+ };
3982
+ };
3983
+ listJobItems: {
3984
+ parameters: {
3985
+ query?: {
3986
+ status?: "queued" | "running" | "succeeded" | "failed";
3987
+ limit?: number;
3988
+ /** @description `nextCursor` of the previous page */
3989
+ cursor?: string;
3990
+ };
3991
+ header?: never;
3992
+ path: {
3993
+ jobId: string;
3994
+ };
3995
+ cookie?: never;
3996
+ };
3997
+ requestBody?: never;
3998
+ responses: {
3999
+ /** @description Items */
4000
+ 200: {
4001
+ headers: {
4002
+ [name: string]: unknown;
4003
+ };
4004
+ content: {
4005
+ "application/json": {
4006
+ items: components["schemas"]["JobItem"][];
4007
+ nextCursor: string | null;
4008
+ };
4009
+ };
4010
+ };
4011
+ /** @description Malformed request */
4012
+ 400: {
4013
+ headers: {
4014
+ [name: string]: unknown;
4015
+ };
4016
+ content: {
4017
+ "application/json": components["schemas"]["Error"];
4018
+ };
4019
+ };
4020
+ /** @description Authentication required */
4021
+ 401: {
4022
+ headers: {
4023
+ [name: string]: unknown;
4024
+ };
4025
+ content: {
4026
+ "application/json": components["schemas"]["Error"];
4027
+ };
4028
+ };
4029
+ /** @description Insufficient permissions */
4030
+ 403: {
4031
+ headers: {
4032
+ [name: string]: unknown;
4033
+ };
4034
+ content: {
4035
+ "application/json": components["schemas"]["Error"];
4036
+ };
4037
+ };
4038
+ /** @description Not found in this organization */
4039
+ 404: {
4040
+ headers: {
4041
+ [name: string]: unknown;
4042
+ };
4043
+ content: {
4044
+ "application/json": components["schemas"]["Error"];
4045
+ };
4046
+ };
4047
+ /** @description Conflict with the current state */
4048
+ 409: {
4049
+ headers: {
4050
+ [name: string]: unknown;
4051
+ };
4052
+ content: {
4053
+ "application/json": components["schemas"]["Error"];
4054
+ };
4055
+ };
4056
+ /** @description Validation failed (issues carry JSON paths) */
4057
+ 422: {
4058
+ headers: {
4059
+ [name: string]: unknown;
4060
+ };
4061
+ content: {
4062
+ "application/json": components["schemas"]["Error"];
4063
+ };
4064
+ };
4065
+ };
4066
+ };
4067
+ getJobOutput: {
4068
+ parameters: {
4069
+ query?: never;
4070
+ header?: never;
4071
+ path: {
4072
+ jobId: string;
4073
+ };
4074
+ cookie?: never;
4075
+ };
4076
+ requestBody?: never;
4077
+ responses: {
4078
+ /** @description Output */
4079
+ 200: {
4080
+ headers: {
4081
+ [name: string]: unknown;
4082
+ };
4083
+ content: {
4084
+ "application/json": components["schemas"]["JobOutput"];
4085
+ };
4086
+ };
4087
+ /** @description Malformed request */
4088
+ 400: {
4089
+ headers: {
4090
+ [name: string]: unknown;
4091
+ };
4092
+ content: {
4093
+ "application/json": components["schemas"]["Error"];
4094
+ };
4095
+ };
4096
+ /** @description Authentication required */
4097
+ 401: {
4098
+ headers: {
4099
+ [name: string]: unknown;
4100
+ };
4101
+ content: {
4102
+ "application/json": components["schemas"]["Error"];
4103
+ };
4104
+ };
4105
+ /** @description Insufficient permissions */
4106
+ 403: {
4107
+ headers: {
4108
+ [name: string]: unknown;
4109
+ };
4110
+ content: {
4111
+ "application/json": components["schemas"]["Error"];
4112
+ };
4113
+ };
4114
+ /** @description Not found in this organization */
4115
+ 404: {
4116
+ headers: {
4117
+ [name: string]: unknown;
4118
+ };
4119
+ content: {
4120
+ "application/json": components["schemas"]["Error"];
4121
+ };
4122
+ };
4123
+ /** @description Conflict with the current state */
4124
+ 409: {
4125
+ headers: {
4126
+ [name: string]: unknown;
4127
+ };
4128
+ content: {
4129
+ "application/json": components["schemas"]["Error"];
4130
+ };
4131
+ };
4132
+ /** @description Deleted by the retention */
4133
+ 410: {
4134
+ headers: {
4135
+ [name: string]: unknown;
4136
+ };
4137
+ content: {
4138
+ "application/json": {
4139
+ [key: string]: unknown;
4140
+ };
4141
+ };
4142
+ };
4143
+ /** @description Validation failed (issues carry JSON paths) */
4144
+ 422: {
4145
+ headers: {
4146
+ [name: string]: unknown;
4147
+ };
4148
+ content: {
4149
+ "application/json": components["schemas"]["Error"];
4150
+ };
4151
+ };
4152
+ };
4153
+ };
4154
+ listJobDeliveries: {
4155
+ parameters: {
4156
+ query?: never;
4157
+ header?: never;
4158
+ path: {
4159
+ jobId: string;
4160
+ };
4161
+ cookie?: never;
4162
+ };
4163
+ requestBody?: never;
4164
+ responses: {
4165
+ /** @description Deliveries */
4166
+ 200: {
4167
+ headers: {
4168
+ [name: string]: unknown;
4169
+ };
4170
+ content: {
4171
+ "application/json": {
4172
+ deliveries: components["schemas"]["WebhookDelivery"][];
4173
+ };
4174
+ };
4175
+ };
4176
+ /** @description Malformed request */
4177
+ 400: {
4178
+ headers: {
4179
+ [name: string]: unknown;
4180
+ };
4181
+ content: {
4182
+ "application/json": components["schemas"]["Error"];
4183
+ };
4184
+ };
4185
+ /** @description Authentication required */
4186
+ 401: {
4187
+ headers: {
4188
+ [name: string]: unknown;
4189
+ };
4190
+ content: {
4191
+ "application/json": components["schemas"]["Error"];
4192
+ };
4193
+ };
4194
+ /** @description Insufficient permissions */
4195
+ 403: {
4196
+ headers: {
4197
+ [name: string]: unknown;
4198
+ };
4199
+ content: {
4200
+ "application/json": components["schemas"]["Error"];
4201
+ };
4202
+ };
4203
+ /** @description Not found in this organization */
4204
+ 404: {
4205
+ headers: {
4206
+ [name: string]: unknown;
4207
+ };
4208
+ content: {
4209
+ "application/json": components["schemas"]["Error"];
4210
+ };
4211
+ };
4212
+ /** @description Conflict with the current state */
4213
+ 409: {
4214
+ headers: {
4215
+ [name: string]: unknown;
4216
+ };
4217
+ content: {
4218
+ "application/json": components["schemas"]["Error"];
4219
+ };
4220
+ };
4221
+ /** @description Validation failed (issues carry JSON paths) */
4222
+ 422: {
4223
+ headers: {
4224
+ [name: string]: unknown;
4225
+ };
4226
+ content: {
4227
+ "application/json": components["schemas"]["Error"];
4228
+ };
4229
+ };
4230
+ };
4231
+ };
4232
+ validate: {
4233
+ parameters: {
4234
+ query?: never;
4235
+ header?: never;
4236
+ path?: never;
4237
+ cookie?: never;
4238
+ };
4239
+ requestBody: {
4240
+ content: {
4241
+ "application/json": {
4242
+ template?: string;
4243
+ /** @description Pin a number in production; `latest` = highest published version */
4244
+ version?: number | ("latest" | "draft");
4245
+ /** @description Inline SDM document (unsaved editor state); signed-in users only */
4246
+ ir?: {
4247
+ [key: string]: unknown;
4248
+ };
4249
+ data?: unknown;
4250
+ /** @description Name of a sample of the version, rendered instead of `data` (exclusive with `data`) */
4251
+ sample?: string;
4252
+ locale?: string;
4253
+ };
4254
+ };
4255
+ };
4256
+ responses: {
4257
+ /** @description Validation report */
4258
+ 200: {
4259
+ headers: {
4260
+ [name: string]: unknown;
4261
+ };
4262
+ content: {
4263
+ "application/json": components["schemas"]["Validation"];
4264
+ };
4265
+ };
4266
+ /** @description Malformed request */
4267
+ 400: {
4268
+ headers: {
4269
+ [name: string]: unknown;
4270
+ };
4271
+ content: {
4272
+ "application/json": components["schemas"]["Error"];
4273
+ };
4274
+ };
4275
+ /** @description Authentication required */
4276
+ 401: {
4277
+ headers: {
4278
+ [name: string]: unknown;
4279
+ };
4280
+ content: {
4281
+ "application/json": components["schemas"]["Error"];
4282
+ };
4283
+ };
4284
+ /** @description Insufficient permissions */
4285
+ 403: {
4286
+ headers: {
4287
+ [name: string]: unknown;
4288
+ };
4289
+ content: {
4290
+ "application/json": components["schemas"]["Error"];
4291
+ };
4292
+ };
4293
+ /** @description Not found in this organization */
4294
+ 404: {
4295
+ headers: {
4296
+ [name: string]: unknown;
4297
+ };
4298
+ content: {
4299
+ "application/json": components["schemas"]["Error"];
4300
+ };
4301
+ };
4302
+ /** @description Conflict with the current state */
4303
+ 409: {
4304
+ headers: {
4305
+ [name: string]: unknown;
4306
+ };
4307
+ content: {
4308
+ "application/json": components["schemas"]["Error"];
4309
+ };
4310
+ };
4311
+ /** @description Validation failed (issues carry JSON paths) */
4312
+ 422: {
4313
+ headers: {
4314
+ [name: string]: unknown;
4315
+ };
4316
+ content: {
4317
+ "application/json": components["schemas"]["Error"];
4318
+ };
4319
+ };
4320
+ };
4321
+ };
4322
+ }