@supscale/sculdoc-client 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -6,7 +6,7 @@ export interface paths {
6
6
  path?: never;
7
7
  cookie?: never;
8
8
  };
9
- /** Who am I: user and organizations, or API key and its organization */
9
+ /** Who am I: user, organizations with roles and permissions, active organization; or API key */
10
10
  get: operations["getMe"];
11
11
  put?: never;
12
12
  post?: never;
@@ -60,7 +60,10 @@ export interface paths {
60
60
  /** List templates (optionally of one folder; folderId=root for the root) */
61
61
  get: operations["listTemplates"];
62
62
  put?: never;
63
- /** Create a template (empty: save a draft next) */
63
+ /**
64
+ * Create a template, empty (save a draft next) or from a starter of the platform
65
+ * @description `fromStarter` (deprecated: POST /library/{slug}/copy): the slug of a template of the public library, copied as by POST /library/{slug}/copy (draft with the content, samples and assets of its current public version, `origin` kept).
66
+ */
64
67
  post: operations["createTemplate"];
65
68
  delete?: never;
66
69
  options?: never;
@@ -110,7 +113,10 @@ export interface paths {
110
113
  cookie?: never;
111
114
  };
112
115
  get?: never;
113
- /** Create or replace the single draft of a template */
116
+ /**
117
+ * Create or replace the single draft of a template
118
+ * @description The response carries the `ETag` of the saved draft. With `If-Match`, a draft changed since it was read is not overwritten: 409 `draft.conflict` with the current draft in `current`.
119
+ */
114
120
  put: operations["saveDraft"];
115
121
  post?: never;
116
122
  /** Discard the draft */
@@ -131,7 +137,7 @@ export interface paths {
131
137
  put?: never;
132
138
  /**
133
139
  * 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`.
140
+ * @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`. The Typst version (`engine.typst`) is `engine.version` when given (an explicit change, refused with `publish.engine` when the platform does not carry it), else `meta.engine.version` of the draft, else the version of the last publication, else the default (`GET /v1/engines`); a deprecated version publishes with the warning `engine.deprecated`.
135
141
  */
136
142
  post: operations["publishDraft"];
137
143
  delete?: never;
@@ -184,7 +190,10 @@ export interface paths {
184
190
  path?: never;
185
191
  cookie?: never;
186
192
  };
187
- /** Get a version with its content */
193
+ /**
194
+ * Get a version with its content
195
+ * @description `draft`: the response carries the `ETag` to send in `If-Match` with the next save, and the soft edit lock (`lock`).
196
+ */
188
197
  get: operations["getVersion"];
189
198
  put?: never;
190
199
  post?: never;
@@ -463,7 +472,7 @@ export interface paths {
463
472
  };
464
473
  /**
465
474
  * 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`.
475
+ * @description A succeeded item names its render (`renderId`, GET /renders/{id}) and its document (GET /documents/{id}; `409 document.intermediate` for an item of a sealed merged batch); a failed item carries its error. Pages follow `nextCursor`.
467
476
  */
468
477
  get: operations["listJobItems"];
469
478
  put?: never;
@@ -528,34 +537,536 @@ export interface paths {
528
537
  patch?: never;
529
538
  trace?: never;
530
539
  };
540
+ "/api-keys/{keyId}/usage": {
541
+ parameters: {
542
+ query?: never;
543
+ header?: never;
544
+ path?: never;
545
+ cookie?: never;
546
+ };
547
+ /**
548
+ * Counters and limits of a key: renders of the minute, pages of the day
549
+ * @description Sliding windows (60 seconds, 24 hours), like GET /organization/usage. Owners and admins read every key; a key reads its own counters (to pace itself).
550
+ */
551
+ get: operations["getApiKeyUsage"];
552
+ put?: never;
553
+ post?: never;
554
+ delete?: never;
555
+ options?: never;
556
+ head?: never;
557
+ patch?: never;
558
+ trace?: never;
559
+ };
560
+ "/imports": {
561
+ parameters: {
562
+ query?: never;
563
+ header?: never;
564
+ path?: never;
565
+ cookie?: never;
566
+ };
567
+ /** Imports of the organization, newest first */
568
+ get: operations["listImports"];
569
+ put?: never;
570
+ post?: never;
571
+ delete?: never;
572
+ options?: never;
573
+ head?: never;
574
+ patch?: never;
575
+ trace?: never;
576
+ };
577
+ "/imports/{importId}": {
578
+ parameters: {
579
+ query?: never;
580
+ header?: never;
581
+ path?: never;
582
+ cookie?: never;
583
+ };
584
+ /** State, report and warnings of an import */
585
+ get: operations["getImport"];
586
+ put?: never;
587
+ post?: never;
588
+ delete?: never;
589
+ options?: never;
590
+ head?: never;
591
+ patch?: never;
592
+ trace?: never;
593
+ };
594
+ "/imports/{importId}/candidates": {
595
+ parameters: {
596
+ query?: never;
597
+ header?: never;
598
+ path?: never;
599
+ cookie?: never;
600
+ };
601
+ /**
602
+ * Variable candidates of a succeeded import
603
+ * @description Candidates found by rules (dates, amounts, identifiers, label/value pairs, table cells), `safe` (confidence ≥ 0.7) or `suspect`, with their box on the source page, the rules that fired and the node of the draft that shows them.
604
+ */
605
+ get: operations["getImportCandidates"];
606
+ put?: never;
607
+ post?: never;
608
+ delete?: never;
609
+ options?: never;
610
+ head?: never;
611
+ patch?: never;
612
+ trace?: never;
613
+ };
614
+ "/engines": {
615
+ parameters: {
616
+ query?: never;
617
+ header?: never;
618
+ path?: never;
619
+ cookie?: never;
620
+ };
621
+ /**
622
+ * Typst versions in service: the default one and the deprecated ones
623
+ * @description Every published version pins the Typst version it is rendered with (`engine.typst`, `meta.engine.version` of the template). A publication keeps the version of the previous one; changing it is an explicit republication (`engine.version` of the publish request), whose visual diff compares the renders of the samples by both versions.
624
+ */
625
+ get: operations["listEngines"];
626
+ put?: never;
627
+ post?: never;
628
+ delete?: never;
629
+ options?: never;
630
+ head?: never;
631
+ patch?: never;
632
+ trace?: never;
633
+ };
531
634
  }
532
635
  export type webhooks = Record<string, never>;
533
636
  export interface components {
534
637
  schemas: {
638
+ /** @enum {string} */
639
+ PlanId: "free" | "pro" | "business" | "enterprise";
640
+ /**
641
+ * @description Currency of the prices and of the billing (C-164): the one chosen in the billing details, else from their country (euros in Europe and by default, US dollars elsewhere)
642
+ * @enum {string}
643
+ */
644
+ Currency: "EUR" | "USD";
535
645
  Organization: {
536
646
  id: string;
537
647
  slug: string;
538
648
  name: string;
539
649
  logo: string | null;
650
+ plan: components["schemas"]["PlanId"];
651
+ currency: components["schemas"]["Currency"];
540
652
  /** Format: date-time */
541
653
  createdAt: string;
542
654
  };
655
+ /**
656
+ * @description Errors carry a stable `code` and `params` (values quoted by the message); interfaces translate them, the English `message` is for logs. Issues carry a JSON `path`, and a `code` with `params` too.
657
+ *
658
+ * **Error responses (`error.code`)**
659
+ *
660
+ * | Code | Status | Params | Description |
661
+ * |---|---|---|---|
662
+ * | `bad_request` | 400 | | Malformed request: body, query or parameters (issues: `request.*`) |
663
+ * | `payload_too_large` | 413 | | Request body larger than 32 MB |
664
+ * | `unauthorized` | 401 | | Authentication required: session cookie or API key |
665
+ * | `forbidden` | 403 | | The role, API key access or folder scope does not allow this action |
666
+ * | `not_found` | 404 | `resource` | Resource not found in this organization (never 403: existence is not disclosed) |
667
+ * | `internal` | 500 | | Unexpected error of the platform |
668
+ * | `unavailable` | 503 | | The database of the platform is saturated or unreachable for a moment: retry after `retryAfter` |
669
+ * | `rate_limited` | 429 | | Rate limit of an API key or of the previews; `retryAfter` gives the wait |
670
+ * | `validation` | 422 | | Semantically invalid request (issues carry JSON paths) |
671
+ * | `organization.required` | 400 | | Several organizations: name one with the `x-sculdoc-organization` header |
672
+ * | `cursor.invalid` | 400 | | Unknown pagination cursor: use the `nextCursor` of a previous page |
673
+ * | `request.data_or_sample` | 400 | | `data` and `sample` are exclusive |
674
+ * | `organization.slug_taken` | 409 | | Another organization uses this slug |
675
+ * | `organization.issuer_missing` | 422 | | The organization has no Factur-X issuer: fill it in the settings of the organization |
676
+ * | `member.exists` | 409 | | This user is already a member |
677
+ * | `api_key.replaced` | 409 | | This API key was already rotated: rotate its replacement |
678
+ * | `member.last_owner` | 409 | | The last owner of an organization cannot leave or lose the role |
679
+ * | `invitation.email_unverified` | 403 | | The sign-in provider did not verify the e-mail address of this account |
680
+ * | `invitation.exists` | 409 | | A pending invitation already targets this e-mail address |
681
+ * | `invitation.expired` | 409 | | The invitation has expired |
682
+ * | `invitation.limit` | | `max`, `period` | Too many invitations (per day, or pending) |
683
+ * | `invitation.not_pending` | 409 | `status` | The invitation is no longer pending |
684
+ * | `auth.email_unverified` | 403 | | The e-mail address of the account is not verified |
685
+ * | `auth.two_factor_required` | 403 | `organizationId` | This organization requires a second factor of its members: activate it in the account settings (GET /me/two-factor) |
686
+ * | `organization.two_factor_owner_first` | 409 | | Activate a second factor on your own account before requiring it of the members |
687
+ * | `platform.two_factor_absent` | 409 | | This account has no second factor to remove |
688
+ * | `auth.reauthentication_required` | 403 | `maxAgeSeconds` | Sign in again: changing the sign-in methods needs a session opened in the last minutes |
689
+ * | `terms.required` | 403 | | Accept the terms of use and the privacy policy first (POST /me/terms) |
690
+ * | `terms.version` | 422 | `current` | These are not the terms in force: reload them |
691
+ * | `password.exists` | 409 | | The account has a password already: change it instead |
692
+ * | `password.too_short` | 422 | | The password is too short (12 characters at least) |
693
+ * | `password.too_long` | 422 | | The password is too long (128 characters at most) |
694
+ * | `password.compromised` | 422 | | The password appears in lists of compromised passwords |
695
+ * | `password.personal` | 422 | | The password is made of the e-mail address or the name of the account |
696
+ * | `account.last_method` | 409 | | The account keeps at least one sign-in method |
697
+ * | `organization.limit` | 409 | `max` | The user owns as many organizations as their plans allow |
698
+ * | `organization.members_limit` | 409 | `max`, `plan` | The plan of the organization allows no more members (pending invitations included) |
699
+ * | `organization.legal_hold` | 409 | `documents` | Documents under legal hold forbid the deletion of the organization |
700
+ * | `organization.confirm` | 422 | | Type the name of the organization to confirm its deletion |
701
+ * | `organization.suspended` | 403 | | The organization is suspended by the platform: renders are refused |
702
+ * | `organization.deletion_scheduled` | 403 | | The deletion of the organization is scheduled: renders are refused until it is canceled |
703
+ * | `member.same` | 409 | | This member already owns the organization |
704
+ * | `plan.feature_required` | 403 | `feature`, `plan` | The plan of the organization does not include this feature |
705
+ * | `billing.unavailable` | 503 | | Self-service subscriptions are not open on this platform |
706
+ * | `billing.catalog_missing` | 503 | | The plan is not in the catalog of the payment provider yet |
707
+ * | `billing.plan_not_sold` | 409 | | This plan is sold on contract only: contact the platform |
708
+ * | `billing.contract` | 409 | | The organization is billed under a contract: the platform changes its plan |
709
+ * | `billing.subscribed` | 409 | | The organization already has a subscription with the payment provider |
710
+ * | `billing.plan_granted` | 409 | | The organization has a plan granted by the platform: contact it to change it |
711
+ * | `billing.no_customer` | 409 | | The organization has never subscribed through the payment provider |
712
+ * | `billing.not_subscribed` | 409 | | The organization has no subscription to change |
713
+ * | `billing.past_due` | 409 | | A payment is late: update the payment method in the portal first |
714
+ * | `billing.provider_managed` | 409 | | The plan follows the subscription of the payment provider |
715
+ * | `billing.contract_managed` | 409 | | The plan is set by the contract of the organization |
716
+ * | `billing.signature` | 401 | | The notification is not signed by the payment provider |
717
+ * | `billing.contract_active` | 409 | | The organization already has a contract: end it first |
718
+ * | `billing.no_contract` | 409 | | Invoices are issued to an organization under contract |
719
+ * | `billing.details_required` | 422 | | A contract needs the company name and the country of the billing details of the organization |
720
+ * | `billing.vat_number_required` | 422 | | A business of the European Union is invoiced with its VAT number (reverse charge) |
721
+ * | `billing.vat_number_invalid` | 422 | | VIES does not find the VAT number valid |
722
+ * | `billing.vies_unavailable` | 503 | `reason` | VIES could not check the number (a member state busy or down: `reason`, its error code): retry later |
723
+ * | `billing.price_required` | 422 | | The plan has no grid price: the contract names its price |
724
+ * | `billing.issuer_unavailable` | 409 | | The organization that issues the invoices does not exist |
725
+ * | `billing.issuer_missing` | 409 | | The organization that issues the invoices has no Factur-X issuer |
726
+ * | `billing.issuer_tax_number` | 409 | | The issuer of the invoices gives its tax number as tax registration (BT-32), without VAT identifier |
727
+ * | `billing.invoice_empty` | 422 | | An invoice has at least one line |
728
+ * | `billing.invoice_amount` | 422 | | An invoice is for a positive amount |
729
+ * | `billing.invoice_rendering` | 409 | | The document of the invoice is being produced: retry later |
730
+ * | `billing.invoice_canceled` | 409 | | The invoice is already canceled by a credit note |
731
+ * | `billing.invoice_paid` | 409 | | The invoice has payments: refund them before crediting it |
732
+ * | `billing.credit_note_of_credit_note` | 409 | | A credit note cannot be credited |
733
+ * | `billing.payment_allocation` | 422 | | The allocations of the payment do not match its amount or the invoices |
734
+ * | `billing.overage_carried` | 409 | | The overage of this month is already carried |
735
+ * | `billing.test_clock` | 403 | | The billing runs as of today on this platform |
736
+ * | `sso.discovery` | 422 | | The issuer does not serve a usable OpenID Connect discovery document |
737
+ * | `sso.domain_invalid` | 422 | | Not a domain name |
738
+ * | `sso.domain_exists` | 409 | | The domain is already listed for this provider |
739
+ * | `sso.domain_claimed` | 409 | `domain` | The domain is verified by another organization |
740
+ * | `sso.domain_unverified` | 422 | `name`, `value`, `found` | The DNS record proving the domain was not found (`name`, `value` expected) |
741
+ * | `sso.not_configured` | 404 | | The organization has no identity provider |
742
+ * | `plan.current` | 409 | | The organization already has this plan |
743
+ * | `plan.requests_discontinued` | 410 | | Plans are no longer requested through the API: contact the platform (`contactEmail` of GET /auth/methods) |
744
+ * | `folder.name_taken` | 409 | | A sibling folder already has this name |
745
+ * | `folder.not_empty` | 409 | | The folder still contains folders or templates |
746
+ * | `folder.cycle` | 422 | | A folder cannot be moved into its own subtree |
747
+ * | `template.slug_taken` | 409 | | Another template of the organization uses this slug |
748
+ * | `template.invalid` | 422 | | Not a valid document of the model (issues: `model.*` and the rules of the model) |
749
+ * | `raw.forbidden` | 422 | | Typst code (`raw` node) is not allowed in this organization (setting `allowRaw`) |
750
+ * | `patch.invalid` | 422 | | A JSON Patch operation failed or produced an invalid document |
751
+ * | `draft.conflict` | 409 | | The draft changed since it was read: `current` holds the current draft |
752
+ * | `draft.precondition_required` | 428 | | `If-Match` is required to patch a draft |
753
+ * | `schema.invalid` | 422 | | The data schema of the author is not a valid JSON Schema |
754
+ * | `version.archived` | 410 | | This version is archived and can no longer be rendered |
755
+ * | `version.draft` | 403 | | API keys cannot render a draft |
756
+ * | `version.immutable` | 409 | | A published version cannot be changed |
757
+ * | `version.not_draft` | 409 | | Only the draft can be changed |
758
+ * | `version.number_taken` | 409 | | This version number is already published |
759
+ * | `version.transition` | 409 | `status`, `action` | This lifecycle change is not allowed |
760
+ * | `version.unpinned` | 422 | | This organization requires API keys to name a version number |
761
+ * | `publish.invalid` | 422 | | The publication is refused: every problem is in `issues` |
762
+ * | `closure.invalid` | 422 | | The dependencies of the version cannot be resolved (includes, assets) |
763
+ * | `include.depth` | 422 | | Includes are nested too deeply (cycle?) |
764
+ * | `include.unavailable` | 422 | `ref`, `template` | An include is not available |
765
+ * | `asset.unresolved` | 422 | `hash` | An asset of the template is not in the asset store |
766
+ * | `sample.duplicate` | 422 | | Two samples have the same name |
767
+ * | `sample.exists` | 409 | `name` | The draft already has a sample of this name |
768
+ * | `sample.limit` | 422 | `max` | Too many samples in one version |
769
+ * | `sample.unknown` | 422 | `name` | This version has no sample of this name |
770
+ * | `asset.bytes` | 422 | `max` | Asset size out of bounds |
771
+ * | `asset.type` | 422 | `declared`, `detected`, `accepted` | Unsupported or mismatching asset type |
772
+ * | `asset.encoding` | 422 | | The content is not standard base64 |
773
+ * | `font.bytes` | 422 | `max` | Font size out of bounds |
774
+ * | `font.encoding` | 422 | | The content is not standard base64 |
775
+ * | `font.format` | 422 | | Not a TrueType/OpenType font file |
776
+ * | `font.parse` | 422 | | The font file cannot be read |
777
+ * | `font.pinned` | 409 | | Published versions are closed over this font (issues: the versions) |
778
+ * | `data.invalid` | 422 | | The data do not match the contract of the version (issues: `data.*`) |
779
+ * | `data.json` | 422 | | The data must be a JSON document |
780
+ * | `data.required` | 422 | | `data` is required |
781
+ * | `profile.unsupported` | 422 | `profile` | The template cannot be rendered in this output profile (issues: `profile.*`) |
782
+ * | `document.expired` | 410 | | The document was deleted by the retention of the organization (its manifest remains) |
783
+ * | `document.intermediate` | 409 | | A part of a sealed merged document: download the output of the batch |
784
+ * | `verify.data_mismatch` | 422 | | These data are not the data of this render |
785
+ * | `verify.data_unavailable` | 422 | | The data of this render are no longer available: send them in `data` |
786
+ * | `verify.draft` | 422 | | A render of a draft cannot be verified |
787
+ * | `verify.no_manifest` | 422 | | A failed render has no manifest to verify |
788
+ * | `render.unavailable` | 503 | | The render worker cannot be reached: retry later |
789
+ * | `render.protocol` | 503 | | Unexpected answer of the render worker |
790
+ * | `batch.items` | 422 | `max`, `count` | Too many items in a batch |
791
+ * | `batch.filename` | 422 | | File names of the items of a batch are invalid or not unique |
792
+ * | `batch.merge_unsupported` | 422 | | These documents cannot be merged (accessible profile, Factur-X, attachments) |
793
+ * | `idempotency.key_length` | 422 | `max` | `Idempotency-Key` is too long |
794
+ * | `idempotency.mismatch` | 409 | | This `Idempotency-Key` was used with a different request |
795
+ * | `idempotency.in_progress` | 409 | | The first request with this `Idempotency-Key` has not completed |
796
+ * | `quota.renders_per_minute` | 429 | `max` | Quota of renders per minute of the organization |
797
+ * | `quota.pages_per_day` | 429 | `used`, `max` | Quota of pages per day of the organization |
798
+ * | `quota.key_renders_per_minute` | 429 | `max` | Limit of renders per minute of the API key |
799
+ * | `quota.key_pages_per_day` | 429 | `used`, `max` | Limit of pages per day of the API key |
800
+ * | `quota.storage` | 429 | `used`, `max` | Storage of the free plan full (documents, kept render data, batch outputs): space is freed by the retention, a paid plan goes beyond |
801
+ * | `import.size` | 422 | `max` | PDF size out of bounds (413 above the limit of the request) |
802
+ * | `import.unavailable` | 503 | | No import worker is configured: retry later |
803
+ * | `import.profile` | 422 | `profile` | The background mode embeds the source PDF page: not in a PDF/A profile |
804
+ * | `import.dispatch` | 503 | | The import could not be queued: retry |
805
+ * | `import.result` | 422 | | Unexpected outcome of the import worker |
806
+ * | `upload.used` | 409 | | This upload was already imported: request a new one |
807
+ * | `upload.unknown` | 422 | | Unknown upload: PUT the PDF to the URL of POST /imports/uploads first |
808
+ * | `pdf.invalid` | 422 | | The file is not a PDF |
809
+ * | `asset.unknown` | 422 | | Unknown asset: deposit it with POST /assets |
810
+ * | `folder.missing` | 422 | | The target folder was deleted during the import |
811
+ * | `quota.documents_per_month` | 429 | `used`, `max` | Documents of the month included in the plan (`free`; a paid plan counts its overage instead) |
812
+ * | `quota.ai_imports_per_month` | 429 | `used`, `max` | AI imports of the month: none left on a plan that sells none (`free`) |
813
+ * | `usage.month` | 422 | | The month of a statement is written YYYY-MM and has started |
814
+ * | `quota.imports_per_day` | 429 | `max` | Quota of imports per day of the organization |
815
+ * | `quota.uploads_per_day` | 429 | `max` | Quota of uploads per day of the organization (that of the imports) |
816
+ * | `import.batch_size` | 422 | `min`, `max`, `count` | A batch has 2 to 50 exemplars |
817
+ * | `import.archive` | 422 | | The ZIP archive of exemplars cannot be read |
818
+ * | `import.llm_disabled` | 422 | | No longer returned: the LLM pass is included according to the plan, no longer enabled by the organization |
819
+ * | `issuer.lookup_id` | 422 | | Not a SIREN (9 digits) or a SIRET (14 digits) with a valid key |
820
+ * | `issuer.lookup_not_found` | 404 | | No public company with this SIREN or SIRET in the directory of the companies |
821
+ * | `issuer.lookup_unavailable` | 503 | | The directory of the companies does not answer: fill the issuer by hand |
822
+ * | `issuer.lookup_rate` | 429 | | Too many lookups of companies: try again in a moment |
823
+ * | `import.llm_unavailable` | 422 | | The LLM pass is not available on this platform (no Claude credentials) |
824
+ * | `import.pending` | 409 | | The import is not finished: no candidates yet, nor a run again |
825
+ * | `import.source_expired` | 410 | | The PDF of the import is no longer stored (30 days): import it again |
826
+ * | `template.missing` | 422 | | The template of the import was deleted or moved while it ran again |
827
+ * | `library.unavailable` | 409 | | The organization of the public library does not exist |
828
+ * | `library.asset_missing` | 503 | | An asset of the library is missing: retry later |
829
+ * | `library.source_taken` | 409 | `slug` | This template already feeds a library template: publish a new version of it |
830
+ * | `library.slug_taken` | 409 | | A library template already uses this slug |
831
+ * | `library.unchanged` | 409 | `version` | The current public version already holds this content |
832
+ * | `library.concurrent` | 409 | | Another public version was published at the same time: retry |
833
+ * | `library.immutable` | 409 | | A public version cannot be changed |
834
+ * | `library.transition` | 409 | `visibility`, `action` | This change of visibility is not allowed |
835
+ * | `library.retired` | 409 | | This library template is retired: it can no longer be copied |
836
+ * | `webhook.url` | 422 | | This receiver URL is not accepted (https, public address) |
837
+ * | `seal.unavailable` | 503 | | No seal service is configured on this platform |
838
+ * | `seal.certificate_missing` | 422 | | Upload the certificate of the organization first |
839
+ * | `seal.tsa_url` | 422 | | The timestamp authority must be a public https URL |
840
+ * | `seal.appearance_template` | 422 | | The appearance of the seal must be a published template of the organization |
841
+ * | `seal.signer.pkcs12` | 422 | | The PKCS#12 file cannot be opened: wrong passphrase, or no key and certificate |
842
+ * | `seal.signer.key_type` | 422 | | The key must be EC (P-256, P-384) or RSA of 2048 bits at least |
843
+ * | `seal.signer.mismatch` | 422 | | The certificate does not match the key |
844
+ * | `seal.signer.expired` | 422 | | The certificate is not valid at this date |
845
+ * | `seal.signer.key_usage` | 422 | | The certificate does not allow signatures (key usage) |
846
+ * | `seal.signer.kms_key` | 422 | | The Cloud KMS key cannot be used by the seal service |
847
+ * | `seal.signer.kms_owner` | 422 | | The Cloud KMS key must carry the label `sculdoc-organization` with the id of the organization |
848
+ * | `seal.signer.certificate` | 422 | | The certificate file cannot be read (PEM) |
849
+ * | `seal.signer.disabled` | 422 | | Organization certificates are not enabled on this platform |
850
+ * | `seal.kms.unavailable` | 503 | | The KMS cannot be reached: retry later |
851
+ * | `seal.request.invalid` | 400 | | Invalid request to the seal service |
852
+ * | `seal.request.too_large` | 422 | | The certificate file is too large |
853
+ * | `conformance.validators` | 503 | | The conformance validators (veraPDF, Mustang) are not available here |
854
+ * | `conformance.not_applicable` | 422 | | Only documents of the archive or accessible profile can be validated |
855
+ * | `conformance.limit` | 429 | `pending`, `perHour` | Too many validations pending or in the last hour for this organization |
856
+ * | `mapping.platform_admin_removed` | 422 | | A provider no longer grants the administration of the platform: platform administrators are managed at /platform/admins |
857
+ * | `platform.admin_exists` | 409 | | This account is already a platform administrator |
858
+ * | `platform.last_admin` | 409 | | The last platform administrator cannot be removed |
859
+ *
860
+ * **Issues (`issues[].code`)**
861
+ *
862
+ * | Code | Status | Params | Description |
863
+ * |---|---|---|---|
864
+ * | `request.invalid_type` | | `expected` | Wrong type |
865
+ * | `request.too_small` | | `origin`, `minimum`, `inclusive` | Too small, too short or too few |
866
+ * | `request.too_big` | | `origin`, `maximum`, `inclusive` | Too big, too long or too many |
867
+ * | `request.invalid_format` | | `format`, `pattern` | Wrong format |
868
+ * | `request.invalid_value` | | `values` | Not one of the allowed values |
869
+ * | `request.unrecognized_keys` | | `keys` | Unknown properties |
870
+ * | `request.invalid_union` | | | Matches none of the allowed shapes |
871
+ * | `request.not_multiple_of` | | `divisor` | Not a multiple |
872
+ * | `request.invalid_key` | | | Invalid key |
873
+ * | `request.invalid_element` | | | Invalid element |
874
+ * | `request.custom` | | | Rule of the API (see the message) |
875
+ * | `api_key.limit` | | `limit`, `max` | A limit of an API key exceeds the quota of its organization |
876
+ * | `retention.beyond_plan` | | `max`, `plan` | A retention longer than the plan of the organization allows (days) |
877
+ * | `model.invalid_type` | | `expected` | Wrong type |
878
+ * | `model.too_small` | | `origin`, `minimum`, `inclusive` | Too small, too short or too few |
879
+ * | `model.too_big` | | `origin`, `maximum`, `inclusive` | Too big, too long or too many |
880
+ * | `model.invalid_format` | | `format`, `pattern` | Wrong format |
881
+ * | `model.invalid_value` | | `values` | Not one of the allowed values |
882
+ * | `model.unrecognized_keys` | | `keys` | Unknown properties |
883
+ * | `model.invalid_union` | | | Matches none of the allowed shapes |
884
+ * | `model.not_multiple_of` | | `divisor` | Not a multiple |
885
+ * | `model.invalid_key` | | | Invalid key |
886
+ * | `model.invalid_element` | | | Invalid element |
887
+ * | `model.custom` | | | Rule of the model (see the message) |
888
+ * | `model.reserved_name` | | `name` | Reserved name: `page` stands for the page counters (`page.number`, `page.total`…), no alias or include data key may use it |
889
+ * | `data.required` | | `missingProperty` | Required property missing |
890
+ * | `data.type` | | `type` | Wrong type |
891
+ * | `data.enum` | | `allowedValues` | Not one of the allowed values |
892
+ * | `data.const` | | `allowedValue` | Not the expected value |
893
+ * | `data.format` | | `format` | Wrong format |
894
+ * | `data.pattern` | | `pattern` | Does not match the pattern |
895
+ * | `data.minLength` | | `limit` | Too short |
896
+ * | `data.maxLength` | | `limit` | Too long |
897
+ * | `data.minimum` | | `limit`, `comparison` | Too small |
898
+ * | `data.maximum` | | `limit`, `comparison` | Too big |
899
+ * | `data.exclusiveMinimum` | | `limit`, `comparison` | Too small |
900
+ * | `data.exclusiveMaximum` | | `limit`, `comparison` | Too big |
901
+ * | `data.minItems` | | `limit` | Too few items |
902
+ * | `data.maxItems` | | `limit` | Too many items |
903
+ * | `data.uniqueItems` | | `i`, `j` | Duplicate items |
904
+ * | `data.additionalProperties` | | `additionalProperty` | Property not allowed |
905
+ * | `data.anyOf` | | | Matches none of the allowed shapes |
906
+ * | `data.oneOf` | | | Matches none or several of the allowed shapes |
907
+ * | `data.multipleOf` | | `multipleOf` | Not a multiple |
908
+ * | `schema.undeclared` | | | Used by the template but not declared in the schema of the author |
909
+ * | `schema.items_undeclared` | | | Array items used by the template but not declared |
910
+ * | `schema.ref` | | `ref` | The template uses this path as a standard type |
911
+ * | `schema.reserved` | | `name` | The schema of the author declares the reserved root `page` (page counters, computed at render time) |
912
+ * | `publish.samples_missing` | | | At least one sample is required to derive and check the data schema |
913
+ * | `publish.engine` | | `engine`, `available` | This engine version is not available |
914
+ * | `publish.compile` | | `code` | The template does not compile with a sample (see the message) |
915
+ * | `raw.node` | | | Typst code (`raw` node) is not allowed in this organization |
916
+ * | `include.unpinned` | | | An include must pin a published version number and its content hash |
917
+ * | `include.missing` | | `template` | The included template has no such published version |
918
+ * | `asset.missing` | | `hash` | This asset is not in the asset store of the organization |
919
+ * | `batch.filename` | | `item` | Same file name as another item |
920
+ * | `batch.merge` | | `reason` | This template cannot be merged in a batch |
921
+ * | `font.substituted` | | `family`, `substitute` | A font family is in no depot: a platform family replaces it |
922
+ * | `sample.reserved` | | `name` | A sample sends the reserved root key `page`: ignored, the page counters are computed at render time |
923
+ * | `version.latest` | | `resolved` | `latest` was resolved: pin a version number in production |
924
+ * | `engine.deprecated` | | `engine`, `replacement`, `removal` | The Typst version of this version is deprecated: republish with its replacement |
925
+ * | `profile.alt_missing` | | `node` | A text alternative is required in the accessible profile |
926
+ * | `profile.pdf_embed` | | `profile` | A PDF page cannot be embedded in this profile (PDF/A) |
927
+ * | `profile.pdf_background` | | `profile`, `master` | A PDF page background cannot be embedded in this profile (PDF/A) |
928
+ * | `profile.title_missing` | | `profile` | The accessible profile needs a document title |
929
+ * | `plan.feature` | | `feature`, `plan` | The plan of the organization does not include this feature (dry run of a publication) |
930
+ * | `profile.facturx_standard` | | | Factur-X needs the archive or accessible profile (PDF/A-3) |
931
+ * | `profile.attachment_reserved` | | `name` | `factur-x.xml` is reserved for the Factur-X invoice |
932
+ * | `profile.seal_visible` | | | A visible seal is not allowed in the accessible profile (PDF/UA) |
933
+ * | `profile.seal_appearance` | | | The seal appearance must be a declared asset of kind pdf |
934
+ * | `facturx.invoice` | | `level`, `sample` | The invoice of the sample does not satisfy the contract of the level |
935
+ * | `facturx.expression` | | `sample` | The invoice expression cannot be evaluated with the sample |
936
+ * | `facturx.issuer` | | `level` | The issuer of the organization does not satisfy the contract of the level |
937
+ * | `facturx.issuer_missing` | | | The organization has no Factur-X issuer |
938
+ *
939
+ * **Failures of a render (`error.code` of a render, job or item)**
940
+ *
941
+ * | Code | Status | Params | Description |
942
+ * |---|---|---|---|
943
+ * | `job.invalid` | | | Invalid render job |
944
+ * | `job.scope` | | | A resource outside the organization of the job |
945
+ * | `job.linearize` | | | A sealed document is not linearized |
946
+ * | `job.lost` | | | The job or item has no outcome after one hour |
947
+ * | `job.dispatch` | | | The job could not be queued |
948
+ * | `batch.failed` | | | No item of the batch succeeded |
949
+ * | `import.lost` | | | The import has no outcome after one hour |
950
+ * | `import.completion` | | | The template of the import could not be created |
951
+ * | `import.batch_clusters` | | | The files of the batch are exemplars of several models (issues: the model of each file) |
952
+ * | `ocr.failed` | | | Tesseract failed on a scanned page |
953
+ * | `snapshot.invalid` | | | The snapshot of the version is invalid |
954
+ * | `storage.not_found` | | | An asset or a snapshot is missing from the storage |
955
+ * | `data.bytes` | | | The data are too large for this queue |
956
+ * | `asset.hash` | | | The bytes of an asset do not match its hash |
957
+ * | `asset.invalid` | | | An image cannot be read |
958
+ * | `asset.pixels` | | | An image has too many pixels |
959
+ * | `asset.svg` | | | An SVG image holds forbidden content (script, external reference…) |
960
+ * | `asset.path` | | | An asset has no path (development renders) |
961
+ * | `font.missing` | | | A pinned font is in no depot |
962
+ * | `font.hash` | | | The bytes of a font do not match its hash |
963
+ * | `font.scope` | | | A font outside the scope of the job |
964
+ * | `engine.version` | | `engine`, `pinned` | The job names another version of Typst than the one pinned by the template |
965
+ * | `engine.unavailable` | | `engine`, `available` | The render worker does not carry this version of Typst |
966
+ * | `render.timeout` | | | The render exceeded its time limit |
967
+ * | `render.memory` | | | The render exceeded its memory limit |
968
+ * | `render.pages` | | `max`, `actual` | The document exceeds the page limit of its queue |
969
+ * | `render.limits` | | `limit`, `max`, `actual` | The document exceeds a limit of its template (`meta.limits`: maxPages, maxRows or maxImagePixels) |
970
+ * | `render.engine` | | | Typst refused the document (see the message) |
971
+ * | `render.killed` | | | The engine was stopped from outside: retry |
972
+ * | `render.output` | | | The engine produced no document |
973
+ * | `render.package` | | | A Typst package was imported |
974
+ * | `master.missing` | | | A template needs at least one master |
975
+ * | `master.unknown` | | `master` | Unknown master |
976
+ * | `style.unknown` | | `style` | Unknown style |
977
+ * | `style.cycle` | | | Style inheritance too deep (cycle?) |
978
+ * | `image.source` | | | An image needs an asset or an expression |
979
+ * | `datatable.incomplete` | | | A data table needs a spec, or a source, columns and a row template |
980
+ * | `datatable.spec` | | `expr` | The expression of a data table must give a TableSpec |
981
+ * | `limits.maxRows` | | `rows`, `max` | Too many rows for `meta.limits.maxRows` |
982
+ * | `attachment.unsupported` | | | An attachment cannot be resolved |
983
+ * | `include.hash` | | | The content of an include does not match its pinned hash |
984
+ * | `data.file` | | | Data file not found (development renders) |
985
+ * | `measure.failed` | | | The measure of the anchored headers failed |
986
+ * | `boxes.failed` | | | The query of the boxes of the preview failed |
987
+ * | `facturx.issuer` | | | The template declares Factur-X and the organization has no issuer |
988
+ * | `facturx.invalid` | | | The invoice or the issuer does not satisfy the contract of the level (issues: paths) |
989
+ * | `post.unavailable` | | | The post-processing service is not available |
990
+ * | `post.failed` | | | The post-processing failed |
991
+ * | `post.protocol` | | | Unexpected answer of the post-processing service |
992
+ * | `post.attachment.pdfa` | | | Attachments need PDF/A-3 |
993
+ * | `post.facturx.pdfa` | | | Factur-X needs PDF/A-3 |
994
+ * | `post.pdf.signed` | | | A signed document cannot be post-processed |
995
+ * | `assemble.bytes` | | | The documents of the batch are too large to assemble |
996
+ * | `assemble.hash` | | | A document of the batch does not match its hash |
997
+ * | `assemble.names` | | | Invalid or duplicate file names in the batch |
998
+ * | `assemble.pages` | | | The merged document exceeds 20,000 pages |
999
+ * | `assemble.seal_size` | | | The merged document exceeds 64 MB and cannot be sealed |
1000
+ * | `seal.unavailable` | | | No seal service is configured |
1001
+ * | `seal.unreachable` | | | The seal service cannot be reached: retry |
1002
+ * | `seal.protocol` | | | Unexpected answer of the seal service |
1003
+ * | `seal.failed` | | | The seal failed |
1004
+ * | `seal.visible` | | | A visible seal is not allowed in the accessible profile |
1005
+ * | `seal.field` | | | The signature field is already signed |
1006
+ * | `seal.page` | | | The page of the visible seal is outside the document |
1007
+ * | `seal.appearance` | | | The appearance of the visible seal is invalid |
1008
+ * | `seal.tsa.unavailable` | | | The timestamp authority is unavailable: retry |
1009
+ * | `seal.kms.integrity` | | | The KMS answer failed its integrity check: retry |
1010
+ * | `seal.pdf.invalid` | | | The document cannot be read by the seal service |
1011
+ * | `seal.pdf.encrypted` | | | An encrypted document cannot be sealed |
1012
+ * | `seal.signer.invalid` | | | The certificate of the organization cannot be used: upload it again |
1013
+ * | `seal.signer.expired` | | | The certificate of the organization has expired |
1014
+ * | `seal.tsa.address` | | | The timestamp authority of the organization resolves to a private address |
1015
+ * | `seal.request.too_large` | | | The document is too large to be sealed |
1016
+ * | `conformance.failed` | | | The document does not conform to its profile (veraPDF, Mustang) |
1017
+ * | `conformance.error` | | | The validators could not check the document |
1018
+ * | `expr.syntax.too_long` | | `max`, `pos`, `src` | Expression too long |
1019
+ * | `expr.syntax.number` | | `pos`, `src` | Malformed number |
1020
+ * | `expr.syntax.unterminated_string` | | `pos`, `src` | Unterminated string |
1021
+ * | `expr.syntax.identifier` | | `pos`, `src` | Malformed identifier |
1022
+ * | `expr.syntax.character` | | `char`, `pos`, `src` | Unexpected character |
1023
+ * | `expr.syntax.expected` | | `expected`, `pos`, `src` | Missing character |
1024
+ * | `expr.syntax.too_deep` | | `pos`, `src` | Expression nested too deeply |
1025
+ * | `expr.syntax.filter_name` | | `pos`, `src` | Expected a filter name after `|` |
1026
+ * | `expr.syntax.property_name` | | `pos`, `src` | Expected a property name after `.` |
1027
+ * | `expr.syntax.token` | | `pos`, `src` | Unexpected token |
1028
+ * | `expr.syntax.trailing` | | `pos`, `src` | Unexpected trailing input |
1029
+ * | `expr.eval.forbidden_property` | | `property`, `src` | Forbidden property |
1030
+ * | `expr.eval.unary_minus` | | `src` | Unary minus on a value that is not a number |
1031
+ * | `expr.eval.unknown_filter` | | `name`, `src` | Unknown filter |
1032
+ * | `expr.eval.unknown_function` | | `name`, `src` | Unknown function |
1033
+ * | `expr.eval.index_type` | | `value`, `src` | An index must be a number or a string |
1034
+ * | `expr.eval.division_by_zero` | | `src` | Division by zero |
1035
+ * | `expr.eval.unknown_operator` | | `op`, `src` | Unknown operator |
1036
+ * | `expr.eval.not_a_number` | | `value`, `src` | Not a number |
1037
+ * | `expr.eval.reserved_variable` | | `name`, `src` | Reserved variable: `page.*` other than the page counters (`page.number`, `page.total`, `page.sectionNumber`, `page.sectionTotal`) is not a data variable |
1038
+ */
543
1039
  Error: {
544
1040
  error: {
545
- /** @example validation */
1041
+ /**
1042
+ * @description Stable code (catalogue below)
1043
+ * @example validation
1044
+ */
546
1045
  code: string;
1046
+ /** @description English message, for logs; interfaces translate `code` */
547
1047
  message: string;
548
1048
  path?: string;
549
- issues: {
550
- /** @example $.items[2].total */
551
- path: string;
552
- message: string;
553
- }[];
1049
+ /** @description Values quoted by the message, for a translated message (see the catalogue of codes) */
1050
+ params?: {
1051
+ [key: string]: string | number | boolean;
1052
+ };
1053
+ issues: components["schemas"]["Issue"][];
554
1054
  /** @description 429: seconds before the same request may succeed (also in the `Retry-After` header) */
555
1055
  retryAfter?: number;
556
1056
  };
557
1057
  requestId: string;
558
1058
  };
1059
+ Issue: {
1060
+ /** @example $.items[2].total */
1061
+ path: string;
1062
+ message: string;
1063
+ /** @example data.type */
1064
+ code?: string;
1065
+ /** @description Values quoted by the message, for a translated message (see the catalogue of codes) */
1066
+ params?: {
1067
+ [key: string]: string | number | boolean;
1068
+ };
1069
+ };
559
1070
  Folder: {
560
1071
  id: string;
561
1072
  parentId: string | null;
@@ -575,6 +1086,13 @@ export interface components {
575
1086
  createdAt: string;
576
1087
  /** Format: date-time */
577
1088
  updatedAt: string;
1089
+ /** @description Library template this template was copied from (GET /library/{librarySlug}); never updated by the platform */
1090
+ origin: {
1091
+ libraryId: string;
1092
+ librarySlug: string;
1093
+ /** @description Public version copied */
1094
+ version: number;
1095
+ } | null;
578
1096
  };
579
1097
  VersionSummary: {
580
1098
  id: string;
@@ -596,6 +1114,10 @@ export interface components {
596
1114
  createdAt: string;
597
1115
  /** Format: date-time */
598
1116
  updatedAt: string;
1117
+ /** @description Draft: incremented by every save (see `ETag`) */
1118
+ revision: number;
1119
+ /** @description Last author of the draft (user id) */
1120
+ updatedBy: string | null;
599
1121
  };
600
1122
  Version: {
601
1123
  id: string;
@@ -617,6 +1139,10 @@ export interface components {
617
1139
  createdAt: string;
618
1140
  /** Format: date-time */
619
1141
  updatedAt: string;
1142
+ /** @description Draft: incremented by every save (see `ETag`) */
1143
+ revision: number;
1144
+ /** @description Last author of the draft (user id) */
1145
+ updatedBy: string | null;
620
1146
  /** @description SDM document (packages/model) */
621
1147
  ir: {
622
1148
  [key: string]: unknown;
@@ -634,12 +1160,427 @@ export interface components {
634
1160
  codegen: string;
635
1161
  sdm: string;
636
1162
  } | null;
1163
+ /** @description Draft only: who is editing it (soft lock, information only) */
1164
+ lock?: components["schemas"]["DraftLock"] | null;
637
1165
  };
638
1166
  Sample: {
639
1167
  /** @example facture-standard */
640
1168
  name: string;
641
1169
  data?: unknown;
642
1170
  };
1171
+ DraftLock: {
1172
+ userId: string;
1173
+ name: string;
1174
+ email: string;
1175
+ /** Format: date-time */
1176
+ expiresAt: string;
1177
+ };
1178
+ /**
1179
+ * @description Errors carry a stable `code` and `params` (values quoted by the message); interfaces translate them, the English `message` is for logs. Issues carry a JSON `path`, and a `code` with `params` too.
1180
+ *
1181
+ * **Error responses (`error.code`)**
1182
+ *
1183
+ * | Code | Status | Params | Description |
1184
+ * |---|---|---|---|
1185
+ * | `bad_request` | 400 | | Malformed request: body, query or parameters (issues: `request.*`) |
1186
+ * | `payload_too_large` | 413 | | Request body larger than 32 MB |
1187
+ * | `unauthorized` | 401 | | Authentication required: session cookie or API key |
1188
+ * | `forbidden` | 403 | | The role, API key access or folder scope does not allow this action |
1189
+ * | `not_found` | 404 | `resource` | Resource not found in this organization (never 403: existence is not disclosed) |
1190
+ * | `internal` | 500 | | Unexpected error of the platform |
1191
+ * | `unavailable` | 503 | | The database of the platform is saturated or unreachable for a moment: retry after `retryAfter` |
1192
+ * | `rate_limited` | 429 | | Rate limit of an API key or of the previews; `retryAfter` gives the wait |
1193
+ * | `validation` | 422 | | Semantically invalid request (issues carry JSON paths) |
1194
+ * | `organization.required` | 400 | | Several organizations: name one with the `x-sculdoc-organization` header |
1195
+ * | `cursor.invalid` | 400 | | Unknown pagination cursor: use the `nextCursor` of a previous page |
1196
+ * | `request.data_or_sample` | 400 | | `data` and `sample` are exclusive |
1197
+ * | `organization.slug_taken` | 409 | | Another organization uses this slug |
1198
+ * | `organization.issuer_missing` | 422 | | The organization has no Factur-X issuer: fill it in the settings of the organization |
1199
+ * | `member.exists` | 409 | | This user is already a member |
1200
+ * | `api_key.replaced` | 409 | | This API key was already rotated: rotate its replacement |
1201
+ * | `member.last_owner` | 409 | | The last owner of an organization cannot leave or lose the role |
1202
+ * | `invitation.email_unverified` | 403 | | The sign-in provider did not verify the e-mail address of this account |
1203
+ * | `invitation.exists` | 409 | | A pending invitation already targets this e-mail address |
1204
+ * | `invitation.expired` | 409 | | The invitation has expired |
1205
+ * | `invitation.limit` | | `max`, `period` | Too many invitations (per day, or pending) |
1206
+ * | `invitation.not_pending` | 409 | `status` | The invitation is no longer pending |
1207
+ * | `auth.email_unverified` | 403 | | The e-mail address of the account is not verified |
1208
+ * | `auth.two_factor_required` | 403 | `organizationId` | This organization requires a second factor of its members: activate it in the account settings (GET /me/two-factor) |
1209
+ * | `organization.two_factor_owner_first` | 409 | | Activate a second factor on your own account before requiring it of the members |
1210
+ * | `platform.two_factor_absent` | 409 | | This account has no second factor to remove |
1211
+ * | `auth.reauthentication_required` | 403 | `maxAgeSeconds` | Sign in again: changing the sign-in methods needs a session opened in the last minutes |
1212
+ * | `terms.required` | 403 | | Accept the terms of use and the privacy policy first (POST /me/terms) |
1213
+ * | `terms.version` | 422 | `current` | These are not the terms in force: reload them |
1214
+ * | `password.exists` | 409 | | The account has a password already: change it instead |
1215
+ * | `password.too_short` | 422 | | The password is too short (12 characters at least) |
1216
+ * | `password.too_long` | 422 | | The password is too long (128 characters at most) |
1217
+ * | `password.compromised` | 422 | | The password appears in lists of compromised passwords |
1218
+ * | `password.personal` | 422 | | The password is made of the e-mail address or the name of the account |
1219
+ * | `account.last_method` | 409 | | The account keeps at least one sign-in method |
1220
+ * | `organization.limit` | 409 | `max` | The user owns as many organizations as their plans allow |
1221
+ * | `organization.members_limit` | 409 | `max`, `plan` | The plan of the organization allows no more members (pending invitations included) |
1222
+ * | `organization.legal_hold` | 409 | `documents` | Documents under legal hold forbid the deletion of the organization |
1223
+ * | `organization.confirm` | 422 | | Type the name of the organization to confirm its deletion |
1224
+ * | `organization.suspended` | 403 | | The organization is suspended by the platform: renders are refused |
1225
+ * | `organization.deletion_scheduled` | 403 | | The deletion of the organization is scheduled: renders are refused until it is canceled |
1226
+ * | `member.same` | 409 | | This member already owns the organization |
1227
+ * | `plan.feature_required` | 403 | `feature`, `plan` | The plan of the organization does not include this feature |
1228
+ * | `billing.unavailable` | 503 | | Self-service subscriptions are not open on this platform |
1229
+ * | `billing.catalog_missing` | 503 | | The plan is not in the catalog of the payment provider yet |
1230
+ * | `billing.plan_not_sold` | 409 | | This plan is sold on contract only: contact the platform |
1231
+ * | `billing.contract` | 409 | | The organization is billed under a contract: the platform changes its plan |
1232
+ * | `billing.subscribed` | 409 | | The organization already has a subscription with the payment provider |
1233
+ * | `billing.plan_granted` | 409 | | The organization has a plan granted by the platform: contact it to change it |
1234
+ * | `billing.no_customer` | 409 | | The organization has never subscribed through the payment provider |
1235
+ * | `billing.not_subscribed` | 409 | | The organization has no subscription to change |
1236
+ * | `billing.past_due` | 409 | | A payment is late: update the payment method in the portal first |
1237
+ * | `billing.provider_managed` | 409 | | The plan follows the subscription of the payment provider |
1238
+ * | `billing.contract_managed` | 409 | | The plan is set by the contract of the organization |
1239
+ * | `billing.signature` | 401 | | The notification is not signed by the payment provider |
1240
+ * | `billing.contract_active` | 409 | | The organization already has a contract: end it first |
1241
+ * | `billing.no_contract` | 409 | | Invoices are issued to an organization under contract |
1242
+ * | `billing.details_required` | 422 | | A contract needs the company name and the country of the billing details of the organization |
1243
+ * | `billing.vat_number_required` | 422 | | A business of the European Union is invoiced with its VAT number (reverse charge) |
1244
+ * | `billing.vat_number_invalid` | 422 | | VIES does not find the VAT number valid |
1245
+ * | `billing.vies_unavailable` | 503 | `reason` | VIES could not check the number (a member state busy or down: `reason`, its error code): retry later |
1246
+ * | `billing.price_required` | 422 | | The plan has no grid price: the contract names its price |
1247
+ * | `billing.issuer_unavailable` | 409 | | The organization that issues the invoices does not exist |
1248
+ * | `billing.issuer_missing` | 409 | | The organization that issues the invoices has no Factur-X issuer |
1249
+ * | `billing.issuer_tax_number` | 409 | | The issuer of the invoices gives its tax number as tax registration (BT-32), without VAT identifier |
1250
+ * | `billing.invoice_empty` | 422 | | An invoice has at least one line |
1251
+ * | `billing.invoice_amount` | 422 | | An invoice is for a positive amount |
1252
+ * | `billing.invoice_rendering` | 409 | | The document of the invoice is being produced: retry later |
1253
+ * | `billing.invoice_canceled` | 409 | | The invoice is already canceled by a credit note |
1254
+ * | `billing.invoice_paid` | 409 | | The invoice has payments: refund them before crediting it |
1255
+ * | `billing.credit_note_of_credit_note` | 409 | | A credit note cannot be credited |
1256
+ * | `billing.payment_allocation` | 422 | | The allocations of the payment do not match its amount or the invoices |
1257
+ * | `billing.overage_carried` | 409 | | The overage of this month is already carried |
1258
+ * | `billing.test_clock` | 403 | | The billing runs as of today on this platform |
1259
+ * | `sso.discovery` | 422 | | The issuer does not serve a usable OpenID Connect discovery document |
1260
+ * | `sso.domain_invalid` | 422 | | Not a domain name |
1261
+ * | `sso.domain_exists` | 409 | | The domain is already listed for this provider |
1262
+ * | `sso.domain_claimed` | 409 | `domain` | The domain is verified by another organization |
1263
+ * | `sso.domain_unverified` | 422 | `name`, `value`, `found` | The DNS record proving the domain was not found (`name`, `value` expected) |
1264
+ * | `sso.not_configured` | 404 | | The organization has no identity provider |
1265
+ * | `plan.current` | 409 | | The organization already has this plan |
1266
+ * | `plan.requests_discontinued` | 410 | | Plans are no longer requested through the API: contact the platform (`contactEmail` of GET /auth/methods) |
1267
+ * | `folder.name_taken` | 409 | | A sibling folder already has this name |
1268
+ * | `folder.not_empty` | 409 | | The folder still contains folders or templates |
1269
+ * | `folder.cycle` | 422 | | A folder cannot be moved into its own subtree |
1270
+ * | `template.slug_taken` | 409 | | Another template of the organization uses this slug |
1271
+ * | `template.invalid` | 422 | | Not a valid document of the model (issues: `model.*` and the rules of the model) |
1272
+ * | `raw.forbidden` | 422 | | Typst code (`raw` node) is not allowed in this organization (setting `allowRaw`) |
1273
+ * | `patch.invalid` | 422 | | A JSON Patch operation failed or produced an invalid document |
1274
+ * | `draft.conflict` | 409 | | The draft changed since it was read: `current` holds the current draft |
1275
+ * | `draft.precondition_required` | 428 | | `If-Match` is required to patch a draft |
1276
+ * | `schema.invalid` | 422 | | The data schema of the author is not a valid JSON Schema |
1277
+ * | `version.archived` | 410 | | This version is archived and can no longer be rendered |
1278
+ * | `version.draft` | 403 | | API keys cannot render a draft |
1279
+ * | `version.immutable` | 409 | | A published version cannot be changed |
1280
+ * | `version.not_draft` | 409 | | Only the draft can be changed |
1281
+ * | `version.number_taken` | 409 | | This version number is already published |
1282
+ * | `version.transition` | 409 | `status`, `action` | This lifecycle change is not allowed |
1283
+ * | `version.unpinned` | 422 | | This organization requires API keys to name a version number |
1284
+ * | `publish.invalid` | 422 | | The publication is refused: every problem is in `issues` |
1285
+ * | `closure.invalid` | 422 | | The dependencies of the version cannot be resolved (includes, assets) |
1286
+ * | `include.depth` | 422 | | Includes are nested too deeply (cycle?) |
1287
+ * | `include.unavailable` | 422 | `ref`, `template` | An include is not available |
1288
+ * | `asset.unresolved` | 422 | `hash` | An asset of the template is not in the asset store |
1289
+ * | `sample.duplicate` | 422 | | Two samples have the same name |
1290
+ * | `sample.exists` | 409 | `name` | The draft already has a sample of this name |
1291
+ * | `sample.limit` | 422 | `max` | Too many samples in one version |
1292
+ * | `sample.unknown` | 422 | `name` | This version has no sample of this name |
1293
+ * | `asset.bytes` | 422 | `max` | Asset size out of bounds |
1294
+ * | `asset.type` | 422 | `declared`, `detected`, `accepted` | Unsupported or mismatching asset type |
1295
+ * | `asset.encoding` | 422 | | The content is not standard base64 |
1296
+ * | `font.bytes` | 422 | `max` | Font size out of bounds |
1297
+ * | `font.encoding` | 422 | | The content is not standard base64 |
1298
+ * | `font.format` | 422 | | Not a TrueType/OpenType font file |
1299
+ * | `font.parse` | 422 | | The font file cannot be read |
1300
+ * | `font.pinned` | 409 | | Published versions are closed over this font (issues: the versions) |
1301
+ * | `data.invalid` | 422 | | The data do not match the contract of the version (issues: `data.*`) |
1302
+ * | `data.json` | 422 | | The data must be a JSON document |
1303
+ * | `data.required` | 422 | | `data` is required |
1304
+ * | `profile.unsupported` | 422 | `profile` | The template cannot be rendered in this output profile (issues: `profile.*`) |
1305
+ * | `document.expired` | 410 | | The document was deleted by the retention of the organization (its manifest remains) |
1306
+ * | `document.intermediate` | 409 | | A part of a sealed merged document: download the output of the batch |
1307
+ * | `verify.data_mismatch` | 422 | | These data are not the data of this render |
1308
+ * | `verify.data_unavailable` | 422 | | The data of this render are no longer available: send them in `data` |
1309
+ * | `verify.draft` | 422 | | A render of a draft cannot be verified |
1310
+ * | `verify.no_manifest` | 422 | | A failed render has no manifest to verify |
1311
+ * | `render.unavailable` | 503 | | The render worker cannot be reached: retry later |
1312
+ * | `render.protocol` | 503 | | Unexpected answer of the render worker |
1313
+ * | `batch.items` | 422 | `max`, `count` | Too many items in a batch |
1314
+ * | `batch.filename` | 422 | | File names of the items of a batch are invalid or not unique |
1315
+ * | `batch.merge_unsupported` | 422 | | These documents cannot be merged (accessible profile, Factur-X, attachments) |
1316
+ * | `idempotency.key_length` | 422 | `max` | `Idempotency-Key` is too long |
1317
+ * | `idempotency.mismatch` | 409 | | This `Idempotency-Key` was used with a different request |
1318
+ * | `idempotency.in_progress` | 409 | | The first request with this `Idempotency-Key` has not completed |
1319
+ * | `quota.renders_per_minute` | 429 | `max` | Quota of renders per minute of the organization |
1320
+ * | `quota.pages_per_day` | 429 | `used`, `max` | Quota of pages per day of the organization |
1321
+ * | `quota.key_renders_per_minute` | 429 | `max` | Limit of renders per minute of the API key |
1322
+ * | `quota.key_pages_per_day` | 429 | `used`, `max` | Limit of pages per day of the API key |
1323
+ * | `quota.storage` | 429 | `used`, `max` | Storage of the free plan full (documents, kept render data, batch outputs): space is freed by the retention, a paid plan goes beyond |
1324
+ * | `import.size` | 422 | `max` | PDF size out of bounds (413 above the limit of the request) |
1325
+ * | `import.unavailable` | 503 | | No import worker is configured: retry later |
1326
+ * | `import.profile` | 422 | `profile` | The background mode embeds the source PDF page: not in a PDF/A profile |
1327
+ * | `import.dispatch` | 503 | | The import could not be queued: retry |
1328
+ * | `import.result` | 422 | | Unexpected outcome of the import worker |
1329
+ * | `upload.used` | 409 | | This upload was already imported: request a new one |
1330
+ * | `upload.unknown` | 422 | | Unknown upload: PUT the PDF to the URL of POST /imports/uploads first |
1331
+ * | `pdf.invalid` | 422 | | The file is not a PDF |
1332
+ * | `asset.unknown` | 422 | | Unknown asset: deposit it with POST /assets |
1333
+ * | `folder.missing` | 422 | | The target folder was deleted during the import |
1334
+ * | `quota.documents_per_month` | 429 | `used`, `max` | Documents of the month included in the plan (`free`; a paid plan counts its overage instead) |
1335
+ * | `quota.ai_imports_per_month` | 429 | `used`, `max` | AI imports of the month: none left on a plan that sells none (`free`) |
1336
+ * | `usage.month` | 422 | | The month of a statement is written YYYY-MM and has started |
1337
+ * | `quota.imports_per_day` | 429 | `max` | Quota of imports per day of the organization |
1338
+ * | `quota.uploads_per_day` | 429 | `max` | Quota of uploads per day of the organization (that of the imports) |
1339
+ * | `import.batch_size` | 422 | `min`, `max`, `count` | A batch has 2 to 50 exemplars |
1340
+ * | `import.archive` | 422 | | The ZIP archive of exemplars cannot be read |
1341
+ * | `import.llm_disabled` | 422 | | No longer returned: the LLM pass is included according to the plan, no longer enabled by the organization |
1342
+ * | `issuer.lookup_id` | 422 | | Not a SIREN (9 digits) or a SIRET (14 digits) with a valid key |
1343
+ * | `issuer.lookup_not_found` | 404 | | No public company with this SIREN or SIRET in the directory of the companies |
1344
+ * | `issuer.lookup_unavailable` | 503 | | The directory of the companies does not answer: fill the issuer by hand |
1345
+ * | `issuer.lookup_rate` | 429 | | Too many lookups of companies: try again in a moment |
1346
+ * | `import.llm_unavailable` | 422 | | The LLM pass is not available on this platform (no Claude credentials) |
1347
+ * | `import.pending` | 409 | | The import is not finished: no candidates yet, nor a run again |
1348
+ * | `import.source_expired` | 410 | | The PDF of the import is no longer stored (30 days): import it again |
1349
+ * | `template.missing` | 422 | | The template of the import was deleted or moved while it ran again |
1350
+ * | `library.unavailable` | 409 | | The organization of the public library does not exist |
1351
+ * | `library.asset_missing` | 503 | | An asset of the library is missing: retry later |
1352
+ * | `library.source_taken` | 409 | `slug` | This template already feeds a library template: publish a new version of it |
1353
+ * | `library.slug_taken` | 409 | | A library template already uses this slug |
1354
+ * | `library.unchanged` | 409 | `version` | The current public version already holds this content |
1355
+ * | `library.concurrent` | 409 | | Another public version was published at the same time: retry |
1356
+ * | `library.immutable` | 409 | | A public version cannot be changed |
1357
+ * | `library.transition` | 409 | `visibility`, `action` | This change of visibility is not allowed |
1358
+ * | `library.retired` | 409 | | This library template is retired: it can no longer be copied |
1359
+ * | `webhook.url` | 422 | | This receiver URL is not accepted (https, public address) |
1360
+ * | `seal.unavailable` | 503 | | No seal service is configured on this platform |
1361
+ * | `seal.certificate_missing` | 422 | | Upload the certificate of the organization first |
1362
+ * | `seal.tsa_url` | 422 | | The timestamp authority must be a public https URL |
1363
+ * | `seal.appearance_template` | 422 | | The appearance of the seal must be a published template of the organization |
1364
+ * | `seal.signer.pkcs12` | 422 | | The PKCS#12 file cannot be opened: wrong passphrase, or no key and certificate |
1365
+ * | `seal.signer.key_type` | 422 | | The key must be EC (P-256, P-384) or RSA of 2048 bits at least |
1366
+ * | `seal.signer.mismatch` | 422 | | The certificate does not match the key |
1367
+ * | `seal.signer.expired` | 422 | | The certificate is not valid at this date |
1368
+ * | `seal.signer.key_usage` | 422 | | The certificate does not allow signatures (key usage) |
1369
+ * | `seal.signer.kms_key` | 422 | | The Cloud KMS key cannot be used by the seal service |
1370
+ * | `seal.signer.kms_owner` | 422 | | The Cloud KMS key must carry the label `sculdoc-organization` with the id of the organization |
1371
+ * | `seal.signer.certificate` | 422 | | The certificate file cannot be read (PEM) |
1372
+ * | `seal.signer.disabled` | 422 | | Organization certificates are not enabled on this platform |
1373
+ * | `seal.kms.unavailable` | 503 | | The KMS cannot be reached: retry later |
1374
+ * | `seal.request.invalid` | 400 | | Invalid request to the seal service |
1375
+ * | `seal.request.too_large` | 422 | | The certificate file is too large |
1376
+ * | `conformance.validators` | 503 | | The conformance validators (veraPDF, Mustang) are not available here |
1377
+ * | `conformance.not_applicable` | 422 | | Only documents of the archive or accessible profile can be validated |
1378
+ * | `conformance.limit` | 429 | `pending`, `perHour` | Too many validations pending or in the last hour for this organization |
1379
+ * | `mapping.platform_admin_removed` | 422 | | A provider no longer grants the administration of the platform: platform administrators are managed at /platform/admins |
1380
+ * | `platform.admin_exists` | 409 | | This account is already a platform administrator |
1381
+ * | `platform.last_admin` | 409 | | The last platform administrator cannot be removed |
1382
+ *
1383
+ * **Issues (`issues[].code`)**
1384
+ *
1385
+ * | Code | Status | Params | Description |
1386
+ * |---|---|---|---|
1387
+ * | `request.invalid_type` | | `expected` | Wrong type |
1388
+ * | `request.too_small` | | `origin`, `minimum`, `inclusive` | Too small, too short or too few |
1389
+ * | `request.too_big` | | `origin`, `maximum`, `inclusive` | Too big, too long or too many |
1390
+ * | `request.invalid_format` | | `format`, `pattern` | Wrong format |
1391
+ * | `request.invalid_value` | | `values` | Not one of the allowed values |
1392
+ * | `request.unrecognized_keys` | | `keys` | Unknown properties |
1393
+ * | `request.invalid_union` | | | Matches none of the allowed shapes |
1394
+ * | `request.not_multiple_of` | | `divisor` | Not a multiple |
1395
+ * | `request.invalid_key` | | | Invalid key |
1396
+ * | `request.invalid_element` | | | Invalid element |
1397
+ * | `request.custom` | | | Rule of the API (see the message) |
1398
+ * | `api_key.limit` | | `limit`, `max` | A limit of an API key exceeds the quota of its organization |
1399
+ * | `retention.beyond_plan` | | `max`, `plan` | A retention longer than the plan of the organization allows (days) |
1400
+ * | `model.invalid_type` | | `expected` | Wrong type |
1401
+ * | `model.too_small` | | `origin`, `minimum`, `inclusive` | Too small, too short or too few |
1402
+ * | `model.too_big` | | `origin`, `maximum`, `inclusive` | Too big, too long or too many |
1403
+ * | `model.invalid_format` | | `format`, `pattern` | Wrong format |
1404
+ * | `model.invalid_value` | | `values` | Not one of the allowed values |
1405
+ * | `model.unrecognized_keys` | | `keys` | Unknown properties |
1406
+ * | `model.invalid_union` | | | Matches none of the allowed shapes |
1407
+ * | `model.not_multiple_of` | | `divisor` | Not a multiple |
1408
+ * | `model.invalid_key` | | | Invalid key |
1409
+ * | `model.invalid_element` | | | Invalid element |
1410
+ * | `model.custom` | | | Rule of the model (see the message) |
1411
+ * | `model.reserved_name` | | `name` | Reserved name: `page` stands for the page counters (`page.number`, `page.total`…), no alias or include data key may use it |
1412
+ * | `data.required` | | `missingProperty` | Required property missing |
1413
+ * | `data.type` | | `type` | Wrong type |
1414
+ * | `data.enum` | | `allowedValues` | Not one of the allowed values |
1415
+ * | `data.const` | | `allowedValue` | Not the expected value |
1416
+ * | `data.format` | | `format` | Wrong format |
1417
+ * | `data.pattern` | | `pattern` | Does not match the pattern |
1418
+ * | `data.minLength` | | `limit` | Too short |
1419
+ * | `data.maxLength` | | `limit` | Too long |
1420
+ * | `data.minimum` | | `limit`, `comparison` | Too small |
1421
+ * | `data.maximum` | | `limit`, `comparison` | Too big |
1422
+ * | `data.exclusiveMinimum` | | `limit`, `comparison` | Too small |
1423
+ * | `data.exclusiveMaximum` | | `limit`, `comparison` | Too big |
1424
+ * | `data.minItems` | | `limit` | Too few items |
1425
+ * | `data.maxItems` | | `limit` | Too many items |
1426
+ * | `data.uniqueItems` | | `i`, `j` | Duplicate items |
1427
+ * | `data.additionalProperties` | | `additionalProperty` | Property not allowed |
1428
+ * | `data.anyOf` | | | Matches none of the allowed shapes |
1429
+ * | `data.oneOf` | | | Matches none or several of the allowed shapes |
1430
+ * | `data.multipleOf` | | `multipleOf` | Not a multiple |
1431
+ * | `schema.undeclared` | | | Used by the template but not declared in the schema of the author |
1432
+ * | `schema.items_undeclared` | | | Array items used by the template but not declared |
1433
+ * | `schema.ref` | | `ref` | The template uses this path as a standard type |
1434
+ * | `schema.reserved` | | `name` | The schema of the author declares the reserved root `page` (page counters, computed at render time) |
1435
+ * | `publish.samples_missing` | | | At least one sample is required to derive and check the data schema |
1436
+ * | `publish.engine` | | `engine`, `available` | This engine version is not available |
1437
+ * | `publish.compile` | | `code` | The template does not compile with a sample (see the message) |
1438
+ * | `raw.node` | | | Typst code (`raw` node) is not allowed in this organization |
1439
+ * | `include.unpinned` | | | An include must pin a published version number and its content hash |
1440
+ * | `include.missing` | | `template` | The included template has no such published version |
1441
+ * | `asset.missing` | | `hash` | This asset is not in the asset store of the organization |
1442
+ * | `batch.filename` | | `item` | Same file name as another item |
1443
+ * | `batch.merge` | | `reason` | This template cannot be merged in a batch |
1444
+ * | `font.substituted` | | `family`, `substitute` | A font family is in no depot: a platform family replaces it |
1445
+ * | `sample.reserved` | | `name` | A sample sends the reserved root key `page`: ignored, the page counters are computed at render time |
1446
+ * | `version.latest` | | `resolved` | `latest` was resolved: pin a version number in production |
1447
+ * | `engine.deprecated` | | `engine`, `replacement`, `removal` | The Typst version of this version is deprecated: republish with its replacement |
1448
+ * | `profile.alt_missing` | | `node` | A text alternative is required in the accessible profile |
1449
+ * | `profile.pdf_embed` | | `profile` | A PDF page cannot be embedded in this profile (PDF/A) |
1450
+ * | `profile.pdf_background` | | `profile`, `master` | A PDF page background cannot be embedded in this profile (PDF/A) |
1451
+ * | `profile.title_missing` | | `profile` | The accessible profile needs a document title |
1452
+ * | `plan.feature` | | `feature`, `plan` | The plan of the organization does not include this feature (dry run of a publication) |
1453
+ * | `profile.facturx_standard` | | | Factur-X needs the archive or accessible profile (PDF/A-3) |
1454
+ * | `profile.attachment_reserved` | | `name` | `factur-x.xml` is reserved for the Factur-X invoice |
1455
+ * | `profile.seal_visible` | | | A visible seal is not allowed in the accessible profile (PDF/UA) |
1456
+ * | `profile.seal_appearance` | | | The seal appearance must be a declared asset of kind pdf |
1457
+ * | `facturx.invoice` | | `level`, `sample` | The invoice of the sample does not satisfy the contract of the level |
1458
+ * | `facturx.expression` | | `sample` | The invoice expression cannot be evaluated with the sample |
1459
+ * | `facturx.issuer` | | `level` | The issuer of the organization does not satisfy the contract of the level |
1460
+ * | `facturx.issuer_missing` | | | The organization has no Factur-X issuer |
1461
+ *
1462
+ * **Failures of a render (`error.code` of a render, job or item)**
1463
+ *
1464
+ * | Code | Status | Params | Description |
1465
+ * |---|---|---|---|
1466
+ * | `job.invalid` | | | Invalid render job |
1467
+ * | `job.scope` | | | A resource outside the organization of the job |
1468
+ * | `job.linearize` | | | A sealed document is not linearized |
1469
+ * | `job.lost` | | | The job or item has no outcome after one hour |
1470
+ * | `job.dispatch` | | | The job could not be queued |
1471
+ * | `batch.failed` | | | No item of the batch succeeded |
1472
+ * | `import.lost` | | | The import has no outcome after one hour |
1473
+ * | `import.completion` | | | The template of the import could not be created |
1474
+ * | `import.batch_clusters` | | | The files of the batch are exemplars of several models (issues: the model of each file) |
1475
+ * | `ocr.failed` | | | Tesseract failed on a scanned page |
1476
+ * | `snapshot.invalid` | | | The snapshot of the version is invalid |
1477
+ * | `storage.not_found` | | | An asset or a snapshot is missing from the storage |
1478
+ * | `data.bytes` | | | The data are too large for this queue |
1479
+ * | `asset.hash` | | | The bytes of an asset do not match its hash |
1480
+ * | `asset.invalid` | | | An image cannot be read |
1481
+ * | `asset.pixels` | | | An image has too many pixels |
1482
+ * | `asset.svg` | | | An SVG image holds forbidden content (script, external reference…) |
1483
+ * | `asset.path` | | | An asset has no path (development renders) |
1484
+ * | `font.missing` | | | A pinned font is in no depot |
1485
+ * | `font.hash` | | | The bytes of a font do not match its hash |
1486
+ * | `font.scope` | | | A font outside the scope of the job |
1487
+ * | `engine.version` | | `engine`, `pinned` | The job names another version of Typst than the one pinned by the template |
1488
+ * | `engine.unavailable` | | `engine`, `available` | The render worker does not carry this version of Typst |
1489
+ * | `render.timeout` | | | The render exceeded its time limit |
1490
+ * | `render.memory` | | | The render exceeded its memory limit |
1491
+ * | `render.pages` | | `max`, `actual` | The document exceeds the page limit of its queue |
1492
+ * | `render.limits` | | `limit`, `max`, `actual` | The document exceeds a limit of its template (`meta.limits`: maxPages, maxRows or maxImagePixels) |
1493
+ * | `render.engine` | | | Typst refused the document (see the message) |
1494
+ * | `render.killed` | | | The engine was stopped from outside: retry |
1495
+ * | `render.output` | | | The engine produced no document |
1496
+ * | `render.package` | | | A Typst package was imported |
1497
+ * | `master.missing` | | | A template needs at least one master |
1498
+ * | `master.unknown` | | `master` | Unknown master |
1499
+ * | `style.unknown` | | `style` | Unknown style |
1500
+ * | `style.cycle` | | | Style inheritance too deep (cycle?) |
1501
+ * | `image.source` | | | An image needs an asset or an expression |
1502
+ * | `datatable.incomplete` | | | A data table needs a spec, or a source, columns and a row template |
1503
+ * | `datatable.spec` | | `expr` | The expression of a data table must give a TableSpec |
1504
+ * | `limits.maxRows` | | `rows`, `max` | Too many rows for `meta.limits.maxRows` |
1505
+ * | `attachment.unsupported` | | | An attachment cannot be resolved |
1506
+ * | `include.hash` | | | The content of an include does not match its pinned hash |
1507
+ * | `data.file` | | | Data file not found (development renders) |
1508
+ * | `measure.failed` | | | The measure of the anchored headers failed |
1509
+ * | `boxes.failed` | | | The query of the boxes of the preview failed |
1510
+ * | `facturx.issuer` | | | The template declares Factur-X and the organization has no issuer |
1511
+ * | `facturx.invalid` | | | The invoice or the issuer does not satisfy the contract of the level (issues: paths) |
1512
+ * | `post.unavailable` | | | The post-processing service is not available |
1513
+ * | `post.failed` | | | The post-processing failed |
1514
+ * | `post.protocol` | | | Unexpected answer of the post-processing service |
1515
+ * | `post.attachment.pdfa` | | | Attachments need PDF/A-3 |
1516
+ * | `post.facturx.pdfa` | | | Factur-X needs PDF/A-3 |
1517
+ * | `post.pdf.signed` | | | A signed document cannot be post-processed |
1518
+ * | `assemble.bytes` | | | The documents of the batch are too large to assemble |
1519
+ * | `assemble.hash` | | | A document of the batch does not match its hash |
1520
+ * | `assemble.names` | | | Invalid or duplicate file names in the batch |
1521
+ * | `assemble.pages` | | | The merged document exceeds 20,000 pages |
1522
+ * | `assemble.seal_size` | | | The merged document exceeds 64 MB and cannot be sealed |
1523
+ * | `seal.unavailable` | | | No seal service is configured |
1524
+ * | `seal.unreachable` | | | The seal service cannot be reached: retry |
1525
+ * | `seal.protocol` | | | Unexpected answer of the seal service |
1526
+ * | `seal.failed` | | | The seal failed |
1527
+ * | `seal.visible` | | | A visible seal is not allowed in the accessible profile |
1528
+ * | `seal.field` | | | The signature field is already signed |
1529
+ * | `seal.page` | | | The page of the visible seal is outside the document |
1530
+ * | `seal.appearance` | | | The appearance of the visible seal is invalid |
1531
+ * | `seal.tsa.unavailable` | | | The timestamp authority is unavailable: retry |
1532
+ * | `seal.kms.integrity` | | | The KMS answer failed its integrity check: retry |
1533
+ * | `seal.pdf.invalid` | | | The document cannot be read by the seal service |
1534
+ * | `seal.pdf.encrypted` | | | An encrypted document cannot be sealed |
1535
+ * | `seal.signer.invalid` | | | The certificate of the organization cannot be used: upload it again |
1536
+ * | `seal.signer.expired` | | | The certificate of the organization has expired |
1537
+ * | `seal.tsa.address` | | | The timestamp authority of the organization resolves to a private address |
1538
+ * | `seal.request.too_large` | | | The document is too large to be sealed |
1539
+ * | `conformance.failed` | | | The document does not conform to its profile (veraPDF, Mustang) |
1540
+ * | `conformance.error` | | | The validators could not check the document |
1541
+ * | `expr.syntax.too_long` | | `max`, `pos`, `src` | Expression too long |
1542
+ * | `expr.syntax.number` | | `pos`, `src` | Malformed number |
1543
+ * | `expr.syntax.unterminated_string` | | `pos`, `src` | Unterminated string |
1544
+ * | `expr.syntax.identifier` | | `pos`, `src` | Malformed identifier |
1545
+ * | `expr.syntax.character` | | `char`, `pos`, `src` | Unexpected character |
1546
+ * | `expr.syntax.expected` | | `expected`, `pos`, `src` | Missing character |
1547
+ * | `expr.syntax.too_deep` | | `pos`, `src` | Expression nested too deeply |
1548
+ * | `expr.syntax.filter_name` | | `pos`, `src` | Expected a filter name after `|` |
1549
+ * | `expr.syntax.property_name` | | `pos`, `src` | Expected a property name after `.` |
1550
+ * | `expr.syntax.token` | | `pos`, `src` | Unexpected token |
1551
+ * | `expr.syntax.trailing` | | `pos`, `src` | Unexpected trailing input |
1552
+ * | `expr.eval.forbidden_property` | | `property`, `src` | Forbidden property |
1553
+ * | `expr.eval.unary_minus` | | `src` | Unary minus on a value that is not a number |
1554
+ * | `expr.eval.unknown_filter` | | `name`, `src` | Unknown filter |
1555
+ * | `expr.eval.unknown_function` | | `name`, `src` | Unknown function |
1556
+ * | `expr.eval.index_type` | | `value`, `src` | An index must be a number or a string |
1557
+ * | `expr.eval.division_by_zero` | | `src` | Division by zero |
1558
+ * | `expr.eval.unknown_operator` | | `op`, `src` | Unknown operator |
1559
+ * | `expr.eval.not_a_number` | | `value`, `src` | Not a number |
1560
+ * | `expr.eval.reserved_variable` | | `name`, `src` | Reserved variable: `page.*` other than the page counters (`page.number`, `page.total`, `page.sectionNumber`, `page.sectionTotal`) is not a data variable |
1561
+ */
1562
+ DraftConflict: {
1563
+ error: {
1564
+ /**
1565
+ * @description Stable code (catalogue below)
1566
+ * @example validation
1567
+ */
1568
+ code: string;
1569
+ /** @description English message, for logs; interfaces translate `code` */
1570
+ message: string;
1571
+ path?: string;
1572
+ /** @description Values quoted by the message, for a translated message (see the catalogue of codes) */
1573
+ params?: {
1574
+ [key: string]: string | number | boolean;
1575
+ };
1576
+ issues: components["schemas"]["Issue"][];
1577
+ /** @description 429: seconds before the same request may succeed (also in the `Retry-After` header) */
1578
+ retryAfter?: number;
1579
+ };
1580
+ requestId: string;
1581
+ /** @description The draft as it is now (null: no draft any more) */
1582
+ current: components["schemas"]["Version"] | null;
1583
+ };
643
1584
  PublishedVersion: {
644
1585
  id: string;
645
1586
  /** @description null while draft */
@@ -660,6 +1601,10 @@ export interface components {
660
1601
  createdAt: string;
661
1602
  /** Format: date-time */
662
1603
  updatedAt: string;
1604
+ /** @description Draft: incremented by every save (see `ETag`) */
1605
+ revision: number;
1606
+ /** @description Last author of the draft (user id) */
1607
+ updatedBy: string | null;
663
1608
  /** @description SDM document (packages/model) */
664
1609
  ir: {
665
1610
  [key: string]: unknown;
@@ -677,11 +1622,10 @@ export interface components {
677
1622
  codegen: string;
678
1623
  sdm: string;
679
1624
  } | null;
1625
+ /** @description Draft only: who is editing it (soft lock, information only) */
1626
+ lock?: components["schemas"]["DraftLock"] | null;
680
1627
  /** @description Reported without refusing the publication: font families substituted */
681
- warnings: {
682
- path: string;
683
- message: string;
684
- }[];
1628
+ warnings: components["schemas"]["Issue"][];
685
1629
  };
686
1630
  VersionDiff: {
687
1631
  from: {
@@ -720,15 +1664,9 @@ export interface components {
720
1664
  PublicationCheck: {
721
1665
  valid: boolean;
722
1666
  /** @description Why the publication would be refused (JSON paths) */
723
- issues: {
724
- path: string;
725
- message: string;
726
- }[];
1667
+ issues: components["schemas"]["Issue"][];
727
1668
  /** @description Font families that would be substituted */
728
- warnings: {
729
- path: string;
730
- message: string;
731
- }[];
1669
+ warnings: components["schemas"]["Issue"][];
732
1670
  /** @description Content hash the publication would freeze */
733
1671
  contentHash: string | null;
734
1672
  /** @description Version compared with; null: no such version */
@@ -762,6 +1700,14 @@ export interface components {
762
1700
  }[];
763
1701
  breaking: boolean;
764
1702
  } | null;
1703
+ /** @description JSON Schema derived from the template and the samples, reported even when other issues refuse the publication; null when it cannot be derived (invalid document, unresolved includes or assets, compilation error) */
1704
+ derivedSchema: {
1705
+ [key: string]: unknown;
1706
+ } | null;
1707
+ /** @description Data contract the publication would freeze (the author's schema, else the derived one); null when refused */
1708
+ dataSchema: {
1709
+ [key: string]: unknown;
1710
+ } | null;
765
1711
  };
766
1712
  DataSchema: {
767
1713
  [key: string]: unknown;
@@ -939,10 +1885,10 @@ export interface components {
939
1885
  error: {
940
1886
  code: string;
941
1887
  message: string;
942
- issues?: {
943
- path: string;
944
- message: string;
945
- }[];
1888
+ params?: {
1889
+ [key: string]: string | number | boolean;
1890
+ };
1891
+ issues?: components["schemas"]["Issue"][];
946
1892
  } | null;
947
1893
  /** @description The data of the render are kept (encrypted): POST /renders/{id}/verify needs no `data` */
948
1894
  dataRetained: boolean;
@@ -966,6 +1912,9 @@ export interface components {
966
1912
  code: string;
967
1913
  message: string;
968
1914
  path?: string;
1915
+ params?: {
1916
+ [key: string]: string | number | boolean;
1917
+ };
969
1918
  };
970
1919
  RenderRequest: {
971
1920
  /** @description Template id or slug */
@@ -1016,10 +1965,10 @@ export interface components {
1016
1965
  error: {
1017
1966
  code: string;
1018
1967
  message: string;
1019
- issues?: {
1020
- path: string;
1021
- message: string;
1022
- }[];
1968
+ params?: {
1969
+ [key: string]: string | number | boolean;
1970
+ };
1971
+ issues?: components["schemas"]["Issue"][];
1023
1972
  } | null;
1024
1973
  /** @description The data of the render are kept (encrypted): POST /renders/{id}/verify needs no `data` */
1025
1974
  dataRetained: boolean;
@@ -1090,10 +2039,10 @@ export interface components {
1090
2039
  error: {
1091
2040
  code: string;
1092
2041
  message: string;
1093
- issues?: {
1094
- path: string;
1095
- message: string;
1096
- }[];
2042
+ params?: {
2043
+ [key: string]: string | number | boolean;
2044
+ };
2045
+ issues?: components["schemas"]["Issue"][];
1097
2046
  } | null;
1098
2047
  /**
1099
2048
  * @description Batch jobs: one ZIP archive, one merged PDF, or the documents of the items; null: one document
@@ -1134,10 +2083,10 @@ export interface components {
1134
2083
  error: {
1135
2084
  code: string;
1136
2085
  message: string;
1137
- issues?: {
1138
- path: string;
1139
- message: string;
1140
- }[];
2086
+ params?: {
2087
+ [key: string]: string | number | boolean;
2088
+ };
2089
+ issues?: components["schemas"]["Issue"][];
1141
2090
  } | null;
1142
2091
  /**
1143
2092
  * @description Batch jobs: one ZIP archive, one merged PDF, or the documents of the items; null: one document
@@ -1223,10 +2172,10 @@ export interface components {
1223
2172
  error: {
1224
2173
  code: string;
1225
2174
  message: string;
1226
- issues?: {
1227
- path: string;
1228
- message: string;
1229
- }[];
2175
+ params?: {
2176
+ [key: string]: string | number | boolean;
2177
+ };
2178
+ issues?: components["schemas"]["Issue"][];
1230
2179
  } | null;
1231
2180
  /** Format: date-time */
1232
2181
  startedAt: string | null;
@@ -1281,13 +2230,181 @@ export interface components {
1281
2230
  };
1282
2231
  Validation: {
1283
2232
  valid: boolean;
1284
- issues: {
1285
- path: string;
1286
- message: string;
1287
- }[];
2233
+ issues: components["schemas"]["Issue"][];
1288
2234
  /** @description `version.latest`: an API key asked for `latest`; pin a version number in production */
1289
2235
  warnings: components["schemas"]["Warning"][];
1290
2236
  };
2237
+ ApiKeyUsage: {
2238
+ limits: {
2239
+ rendersPerMinute: number | null;
2240
+ pagesPerDay: number | null;
2241
+ };
2242
+ /** @description What applies: the limit of the key, else the quota of the organization */
2243
+ effective: {
2244
+ rendersPerMinute: number;
2245
+ pagesPerDay: number;
2246
+ };
2247
+ usage: {
2248
+ rendersLastMinute: number;
2249
+ pagesLast24Hours: number;
2250
+ };
2251
+ };
2252
+ Import: {
2253
+ id: string;
2254
+ /** @enum {string} */
2255
+ status: "queued" | "running" | "succeeded" | "failed";
2256
+ /**
2257
+ * @description `flow` (default): the document rebuilt as a flow (paragraphs, rows, tables, running headers and footers in the masters), fixed blocks only where the flow cannot lay them out; `zones`: everything rebuilt as absolute zones; `background`: the source page as background with the variables re-rendered on white patches (standard profile only)
2258
+ * @enum {string}
2259
+ */
2260
+ mode: "flow" | "zones" | "background";
2261
+ /** @enum {string} */
2262
+ profile: "standard" | "archive" | "accessible";
2263
+ templateName: string;
2264
+ folderId: string | null;
2265
+ source: {
2266
+ name: string;
2267
+ sha256: string;
2268
+ bytes: number;
2269
+ };
2270
+ /** @description Batch import: every exemplar, the source being the first one; null for one PDF */
2271
+ exemplars: {
2272
+ name: string;
2273
+ sha256: string;
2274
+ bytes: number;
2275
+ }[] | null;
2276
+ options: {
2277
+ ocr: boolean;
2278
+ /** @enum {string} */
2279
+ clusters: "reject" | "largest";
2280
+ llm: {
2281
+ /** @enum {string} */
2282
+ model: "sonnet" | "haiku";
2283
+ } | null;
2284
+ /** @description Import run again in another mode (`POST /imports/{id}/reimport`): its id */
2285
+ from?: string;
2286
+ };
2287
+ /** @description Usage of the LLM pass (`report.llm` tells why it did not run) */
2288
+ llm: {
2289
+ model: string;
2290
+ inputTokens: number;
2291
+ outputTokens: number;
2292
+ /** @description Cost of the pass to the platform (US dollars): platform administrators only, absent for any other caller (C-164); an organization counts AI imports (GET /organization/usage) */
2293
+ costUsd?: number;
2294
+ } | null;
2295
+ pages: number | null;
2296
+ /** @description Template created with the imported draft (succeeded); for an import run again, the template whose draft it replaces */
2297
+ templateId: string | null;
2298
+ candidates: {
2299
+ total: number;
2300
+ safe: number;
2301
+ suspect: number;
2302
+ } | null;
2303
+ warnings: {
2304
+ [key: string]: unknown;
2305
+ }[];
2306
+ /** @description Blocks, tables, candidates, fonts and their substitutions, warnings, timings */
2307
+ report: {
2308
+ [key: string]: unknown;
2309
+ } | null;
2310
+ error: {
2311
+ code: string;
2312
+ message: string;
2313
+ issues?: {
2314
+ path: string;
2315
+ message: string;
2316
+ /** @description Values the message quotes; `import.batch_clusters`: `file`, `cluster` (1-based), `clusters`, `files` (of the group), `pages` */
2317
+ params?: {
2318
+ [key: string]: string | number | boolean;
2319
+ };
2320
+ }[];
2321
+ } | null;
2322
+ /** Format: date-time */
2323
+ createdAt: string;
2324
+ /** Format: date-time */
2325
+ startedAt: string | null;
2326
+ /** Format: date-time */
2327
+ finishedAt: string | null;
2328
+ links: {
2329
+ [key: string]: string;
2330
+ };
2331
+ };
2332
+ ImportList: {
2333
+ imports: components["schemas"]["Import"][];
2334
+ nextCursor: string | null;
2335
+ };
2336
+ ImportCandidates: {
2337
+ importId: string;
2338
+ templateId: string;
2339
+ total: number;
2340
+ safe: number;
2341
+ suspect: number;
2342
+ candidates: components["schemas"]["ImportCandidate"][];
2343
+ };
2344
+ ImportCandidate: {
2345
+ /** @description Zone or table cell of the draft that shows the variable */
2346
+ id: string;
2347
+ /**
2348
+ * @description Data path in the imported sample
2349
+ * @example dateDEmission
2350
+ */
2351
+ path: string;
2352
+ text: string;
2353
+ page: number;
2354
+ /** @description [x0, y0, x1, y1] in mm from the top left of the page */
2355
+ bbox: number[];
2356
+ /**
2357
+ * @example [
2358
+ * "date",
2359
+ * "value_of_label"
2360
+ * ]
2361
+ */
2362
+ rules: string[];
2363
+ confidence: number;
2364
+ /** @enum {string} */
2365
+ status: "safe" | "suspect";
2366
+ /** @enum {string} */
2367
+ kind: "text" | "cell";
2368
+ /** @description `rule`: found by the rules on its text; `exemplar`: varies between the exemplars of a batch (sure); `llm`: named and typed by the LLM pass */
2369
+ sources?: ("rule" | "exemplar" | "llm")[];
2370
+ /** @description Proposal of the LLM pass (the path is already renamed after it) */
2371
+ llm?: {
2372
+ variable?: boolean;
2373
+ name?: string | null;
2374
+ type?: string | null;
2375
+ format?: string | null;
2376
+ group?: string | null;
2377
+ confidence?: number;
2378
+ };
2379
+ };
2380
+ Engines: {
2381
+ /**
2382
+ * @description Version given to new templates
2383
+ * @example 0.15.1
2384
+ */
2385
+ default: string;
2386
+ engines: {
2387
+ /** @example 0.15.1 */
2388
+ version: string;
2389
+ default: boolean;
2390
+ deprecated: components["schemas"]["EngineDeprecation"];
2391
+ }[];
2392
+ };
2393
+ /** @description Renders of a deprecated version carry the warning `engine.deprecated` */
2394
+ EngineDeprecation: {
2395
+ /**
2396
+ * @description Date of the deprecation (ISO 8601)
2397
+ * @example 2026-10-22
2398
+ */
2399
+ since: string;
2400
+ /** @description Earliest removal date; a version is only removed once no template’s last publication pins it */
2401
+ removal: string;
2402
+ /**
2403
+ * @description Version to republish with
2404
+ * @example 0.15.1
2405
+ */
2406
+ replacement: string;
2407
+ } | null;
1291
2408
  };
1292
2409
  responses: never;
1293
2410
  parameters: never;
@@ -1319,13 +2436,43 @@ export interface operations {
1319
2436
  id: string;
1320
2437
  email: string;
1321
2438
  name: string;
2439
+ image: string | null;
1322
2440
  platformAdmin: boolean;
2441
+ emailVerified: boolean;
2442
+ /** @enum {string|null} */
2443
+ locale: "fr" | "en" | null;
2444
+ /**
2445
+ * @description null: an account of a partner provider created before the self-service
2446
+ * @enum {string|null}
2447
+ */
2448
+ signupMethod: "password" | "magic_link" | "google" | "oidc" | null;
2449
+ /** Format: date-time */
2450
+ termsAcceptedAt: string | null;
2451
+ /** @description A second factor (TOTP) is active on the account */
2452
+ twoFactorEnabled: boolean;
1323
2453
  } | null;
1324
2454
  organizations: (components["schemas"]["Organization"] & {
2455
+ /** @description null: platform administrator without membership */
1325
2456
  role: string | null;
2457
+ /** @description What the caller may do in it */
2458
+ permissions: string[];
2459
+ /** @description The organization requires a second factor this session lacks: its requests answer 403 `auth.two_factor_required` until the account activates one */
2460
+ twoFactorRequired: boolean;
1326
2461
  })[];
2462
+ /** @description Organization of the requests without `x-sculdoc-organization`: the active one of the session (POST /me/organization), else the only membership */
2463
+ activeOrganizationId: string | null;
1327
2464
  /** @description Sign-in providers enabled on this deployment */
1328
2465
  providers: string[];
2466
+ onboarding: {
2467
+ /** @description A self-service account accepts the terms in force before acting (POST /me/terms) */
2468
+ termsRequired: boolean;
2469
+ termsVersion: string;
2470
+ organizationsOwned: number;
2471
+ /** @description Organizations the user may own: the limit of the best plan among those they own */
2472
+ organizationsLimit: number;
2473
+ canCreateOrganization: boolean;
2474
+ pendingInvitations: number;
2475
+ } | null;
1329
2476
  };
1330
2477
  };
1331
2478
  };
@@ -1633,6 +2780,8 @@ export interface operations {
1633
2780
  slug?: string;
1634
2781
  description?: string;
1635
2782
  folderId?: string | null;
2783
+ /** @description Deprecated: slug of a library template (POST /library/{slug}/copy) */
2784
+ fromStarter?: string;
1636
2785
  };
1637
2786
  };
1638
2787
  };
@@ -1861,7 +3010,10 @@ export interface operations {
1861
3010
  saveDraft: {
1862
3011
  parameters: {
1863
3012
  query?: never;
1864
- header?: never;
3013
+ header?: {
3014
+ /** @description ETag of the draft as last read (`GET …/versions/draft`, previous save): the write is refused with 409 and the current draft if it changed since; `*` = any existing draft */
3015
+ "if-match"?: string;
3016
+ };
1865
3017
  path: {
1866
3018
  /** @description Template id or slug */
1867
3019
  template: string;
@@ -1927,13 +3079,13 @@ export interface operations {
1927
3079
  "application/json": components["schemas"]["Error"];
1928
3080
  };
1929
3081
  };
1930
- /** @description Conflict with the current state */
3082
+ /** @description The draft changed since it was read (`If-Match`) */
1931
3083
  409: {
1932
3084
  headers: {
1933
3085
  [name: string]: unknown;
1934
3086
  };
1935
3087
  content: {
1936
- "application/json": components["schemas"]["Error"];
3088
+ "application/json": components["schemas"]["DraftConflict"];
1937
3089
  };
1938
3090
  };
1939
3091
  /** @description Validation failed (issues carry JSON paths) */
@@ -2037,6 +3189,11 @@ export interface operations {
2037
3189
  "application/json": {
2038
3190
  /** @description Mandatory at publication */
2039
3191
  changelog: string;
3192
+ /** @description Typst version of this publication (`GET /v1/engines`): an explicit change of the version of the template; compare the renders of both versions with the visual diff of the two versions */
3193
+ engine?: {
3194
+ /** @example 0.15.1 */
3195
+ version: string;
3196
+ };
2040
3197
  };
2041
3198
  };
2042
3199
  };
@@ -2206,6 +3363,11 @@ export interface operations {
2206
3363
  [key: string]: unknown;
2207
3364
  } | null;
2208
3365
  samples?: components["schemas"]["Sample"][];
3366
+ /** @description Typst version of this publication (`GET /v1/engines`): an explicit change of the version of the template; compare the renders of both versions with the visual diff of the two versions */
3367
+ engine?: {
3368
+ /** @example 0.15.1 */
3369
+ version: string;
3370
+ };
2209
3371
  /**
2210
3372
  * @description Version number or `latest`
2211
3373
  * @default latest
@@ -2603,7 +3765,10 @@ export interface operations {
2603
3765
  putDraftSample: {
2604
3766
  parameters: {
2605
3767
  query?: never;
2606
- header?: never;
3768
+ header?: {
3769
+ /** @description ETag of the draft as last read (`GET …/versions/draft`, previous save): the write is refused with 409 and the current draft if it changed since; `*` = any existing draft */
3770
+ "if-match"?: string;
3771
+ };
2607
3772
  path: {
2608
3773
  /** @description Template id or slug */
2609
3774
  template: string;
@@ -2674,13 +3839,13 @@ export interface operations {
2674
3839
  "application/json": components["schemas"]["Error"];
2675
3840
  };
2676
3841
  };
2677
- /** @description Conflict with the current state */
3842
+ /** @description The draft changed since it was read (`If-Match`) */
2678
3843
  409: {
2679
3844
  headers: {
2680
3845
  [name: string]: unknown;
2681
3846
  };
2682
3847
  content: {
2683
- "application/json": components["schemas"]["Error"];
3848
+ "application/json": components["schemas"]["DraftConflict"];
2684
3849
  };
2685
3850
  };
2686
3851
  /** @description Validation failed (issues carry JSON paths) */
@@ -2697,7 +3862,10 @@ export interface operations {
2697
3862
  deleteDraftSample: {
2698
3863
  parameters: {
2699
3864
  query?: never;
2700
- header?: never;
3865
+ header?: {
3866
+ /** @description ETag of the draft as last read (`GET …/versions/draft`, previous save): the write is refused with 409 and the current draft if it changed since; `*` = any existing draft */
3867
+ "if-match"?: string;
3868
+ };
2701
3869
  path: {
2702
3870
  /** @description Template id or slug */
2703
3871
  template: string;
@@ -2750,13 +3918,13 @@ export interface operations {
2750
3918
  "application/json": components["schemas"]["Error"];
2751
3919
  };
2752
3920
  };
2753
- /** @description Conflict with the current state */
3921
+ /** @description The draft changed since it was read (`If-Match`) */
2754
3922
  409: {
2755
3923
  headers: {
2756
3924
  [name: string]: unknown;
2757
3925
  };
2758
3926
  content: {
2759
- "application/json": components["schemas"]["Error"];
3927
+ "application/json": components["schemas"]["DraftConflict"];
2760
3928
  };
2761
3929
  };
2762
3930
  /** @description Validation failed (issues carry JSON paths) */
@@ -2773,7 +3941,10 @@ export interface operations {
2773
3941
  renameDraftSample: {
2774
3942
  parameters: {
2775
3943
  query?: never;
2776
- header?: never;
3944
+ header?: {
3945
+ /** @description ETag of the draft as last read (`GET …/versions/draft`, previous save): the write is refused with 409 and the current draft if it changed since; `*` = any existing draft */
3946
+ "if-match"?: string;
3947
+ };
2777
3948
  path: {
2778
3949
  /** @description Template id or slug */
2779
3950
  template: string;
@@ -2835,13 +4006,13 @@ export interface operations {
2835
4006
  "application/json": components["schemas"]["Error"];
2836
4007
  };
2837
4008
  };
2838
- /** @description Conflict with the current state */
4009
+ /** @description The draft changed since it was read (`If-Match`) */
2839
4010
  409: {
2840
4011
  headers: {
2841
4012
  [name: string]: unknown;
2842
4013
  };
2843
4014
  content: {
2844
- "application/json": components["schemas"]["Error"];
4015
+ "application/json": components["schemas"]["DraftConflict"];
2845
4016
  };
2846
4017
  };
2847
4018
  /** @description Validation failed (issues carry JSON paths) */
@@ -4319,4 +5490,390 @@ export interface operations {
4319
5490
  };
4320
5491
  };
4321
5492
  };
5493
+ getApiKeyUsage: {
5494
+ parameters: {
5495
+ query?: never;
5496
+ header?: never;
5497
+ path: {
5498
+ keyId: string;
5499
+ };
5500
+ cookie?: never;
5501
+ };
5502
+ requestBody?: never;
5503
+ responses: {
5504
+ /** @description Usage of the key */
5505
+ 200: {
5506
+ headers: {
5507
+ [name: string]: unknown;
5508
+ };
5509
+ content: {
5510
+ "application/json": components["schemas"]["ApiKeyUsage"];
5511
+ };
5512
+ };
5513
+ /** @description Malformed request */
5514
+ 400: {
5515
+ headers: {
5516
+ [name: string]: unknown;
5517
+ };
5518
+ content: {
5519
+ "application/json": components["schemas"]["Error"];
5520
+ };
5521
+ };
5522
+ /** @description Authentication required */
5523
+ 401: {
5524
+ headers: {
5525
+ [name: string]: unknown;
5526
+ };
5527
+ content: {
5528
+ "application/json": components["schemas"]["Error"];
5529
+ };
5530
+ };
5531
+ /** @description Insufficient permissions */
5532
+ 403: {
5533
+ headers: {
5534
+ [name: string]: unknown;
5535
+ };
5536
+ content: {
5537
+ "application/json": components["schemas"]["Error"];
5538
+ };
5539
+ };
5540
+ /** @description Not found in this organization */
5541
+ 404: {
5542
+ headers: {
5543
+ [name: string]: unknown;
5544
+ };
5545
+ content: {
5546
+ "application/json": components["schemas"]["Error"];
5547
+ };
5548
+ };
5549
+ /** @description Conflict with the current state */
5550
+ 409: {
5551
+ headers: {
5552
+ [name: string]: unknown;
5553
+ };
5554
+ content: {
5555
+ "application/json": components["schemas"]["Error"];
5556
+ };
5557
+ };
5558
+ /** @description Validation failed (issues carry JSON paths) */
5559
+ 422: {
5560
+ headers: {
5561
+ [name: string]: unknown;
5562
+ };
5563
+ content: {
5564
+ "application/json": components["schemas"]["Error"];
5565
+ };
5566
+ };
5567
+ };
5568
+ };
5569
+ listImports: {
5570
+ parameters: {
5571
+ query?: {
5572
+ status?: "queued" | "running" | "succeeded" | "failed";
5573
+ /** @description Imports of this template (the editor: its review) */
5574
+ templateId?: string;
5575
+ /** @description `true`: only the imports launched by the caller (the signed-in user, or this API key): the background tasks of the application */
5576
+ mine?: "true" | "false";
5577
+ limit?: number;
5578
+ cursor?: string;
5579
+ };
5580
+ header?: never;
5581
+ path?: never;
5582
+ cookie?: never;
5583
+ };
5584
+ requestBody?: never;
5585
+ responses: {
5586
+ /** @description Imports */
5587
+ 200: {
5588
+ headers: {
5589
+ [name: string]: unknown;
5590
+ };
5591
+ content: {
5592
+ "application/json": components["schemas"]["ImportList"];
5593
+ };
5594
+ };
5595
+ /** @description Malformed request */
5596
+ 400: {
5597
+ headers: {
5598
+ [name: string]: unknown;
5599
+ };
5600
+ content: {
5601
+ "application/json": components["schemas"]["Error"];
5602
+ };
5603
+ };
5604
+ /** @description Authentication required */
5605
+ 401: {
5606
+ headers: {
5607
+ [name: string]: unknown;
5608
+ };
5609
+ content: {
5610
+ "application/json": components["schemas"]["Error"];
5611
+ };
5612
+ };
5613
+ /** @description Insufficient permissions */
5614
+ 403: {
5615
+ headers: {
5616
+ [name: string]: unknown;
5617
+ };
5618
+ content: {
5619
+ "application/json": components["schemas"]["Error"];
5620
+ };
5621
+ };
5622
+ /** @description Not found in this organization */
5623
+ 404: {
5624
+ headers: {
5625
+ [name: string]: unknown;
5626
+ };
5627
+ content: {
5628
+ "application/json": components["schemas"]["Error"];
5629
+ };
5630
+ };
5631
+ /** @description Conflict with the current state */
5632
+ 409: {
5633
+ headers: {
5634
+ [name: string]: unknown;
5635
+ };
5636
+ content: {
5637
+ "application/json": components["schemas"]["Error"];
5638
+ };
5639
+ };
5640
+ /** @description Validation failed (issues carry JSON paths) */
5641
+ 422: {
5642
+ headers: {
5643
+ [name: string]: unknown;
5644
+ };
5645
+ content: {
5646
+ "application/json": components["schemas"]["Error"];
5647
+ };
5648
+ };
5649
+ };
5650
+ };
5651
+ getImport: {
5652
+ parameters: {
5653
+ query?: never;
5654
+ header?: never;
5655
+ path: {
5656
+ importId: string;
5657
+ };
5658
+ cookie?: never;
5659
+ };
5660
+ requestBody?: never;
5661
+ responses: {
5662
+ /** @description Import */
5663
+ 200: {
5664
+ headers: {
5665
+ [name: string]: unknown;
5666
+ };
5667
+ content: {
5668
+ "application/json": components["schemas"]["Import"];
5669
+ };
5670
+ };
5671
+ /** @description Malformed request */
5672
+ 400: {
5673
+ headers: {
5674
+ [name: string]: unknown;
5675
+ };
5676
+ content: {
5677
+ "application/json": components["schemas"]["Error"];
5678
+ };
5679
+ };
5680
+ /** @description Authentication required */
5681
+ 401: {
5682
+ headers: {
5683
+ [name: string]: unknown;
5684
+ };
5685
+ content: {
5686
+ "application/json": components["schemas"]["Error"];
5687
+ };
5688
+ };
5689
+ /** @description Insufficient permissions */
5690
+ 403: {
5691
+ headers: {
5692
+ [name: string]: unknown;
5693
+ };
5694
+ content: {
5695
+ "application/json": components["schemas"]["Error"];
5696
+ };
5697
+ };
5698
+ /** @description Not found in this organization */
5699
+ 404: {
5700
+ headers: {
5701
+ [name: string]: unknown;
5702
+ };
5703
+ content: {
5704
+ "application/json": components["schemas"]["Error"];
5705
+ };
5706
+ };
5707
+ /** @description Conflict with the current state */
5708
+ 409: {
5709
+ headers: {
5710
+ [name: string]: unknown;
5711
+ };
5712
+ content: {
5713
+ "application/json": components["schemas"]["Error"];
5714
+ };
5715
+ };
5716
+ /** @description Validation failed (issues carry JSON paths) */
5717
+ 422: {
5718
+ headers: {
5719
+ [name: string]: unknown;
5720
+ };
5721
+ content: {
5722
+ "application/json": components["schemas"]["Error"];
5723
+ };
5724
+ };
5725
+ };
5726
+ };
5727
+ getImportCandidates: {
5728
+ parameters: {
5729
+ query?: {
5730
+ status?: "safe" | "suspect";
5731
+ };
5732
+ header?: never;
5733
+ path: {
5734
+ importId: string;
5735
+ };
5736
+ cookie?: never;
5737
+ };
5738
+ requestBody?: never;
5739
+ responses: {
5740
+ /** @description Candidates */
5741
+ 200: {
5742
+ headers: {
5743
+ [name: string]: unknown;
5744
+ };
5745
+ content: {
5746
+ "application/json": components["schemas"]["ImportCandidates"];
5747
+ };
5748
+ };
5749
+ /** @description Malformed request */
5750
+ 400: {
5751
+ headers: {
5752
+ [name: string]: unknown;
5753
+ };
5754
+ content: {
5755
+ "application/json": components["schemas"]["Error"];
5756
+ };
5757
+ };
5758
+ /** @description Authentication required */
5759
+ 401: {
5760
+ headers: {
5761
+ [name: string]: unknown;
5762
+ };
5763
+ content: {
5764
+ "application/json": components["schemas"]["Error"];
5765
+ };
5766
+ };
5767
+ /** @description Insufficient permissions */
5768
+ 403: {
5769
+ headers: {
5770
+ [name: string]: unknown;
5771
+ };
5772
+ content: {
5773
+ "application/json": components["schemas"]["Error"];
5774
+ };
5775
+ };
5776
+ /** @description Not found in this organization */
5777
+ 404: {
5778
+ headers: {
5779
+ [name: string]: unknown;
5780
+ };
5781
+ content: {
5782
+ "application/json": components["schemas"]["Error"];
5783
+ };
5784
+ };
5785
+ /** @description Conflict with the current state */
5786
+ 409: {
5787
+ headers: {
5788
+ [name: string]: unknown;
5789
+ };
5790
+ content: {
5791
+ "application/json": components["schemas"]["Error"];
5792
+ };
5793
+ };
5794
+ /** @description Validation failed (issues carry JSON paths) */
5795
+ 422: {
5796
+ headers: {
5797
+ [name: string]: unknown;
5798
+ };
5799
+ content: {
5800
+ "application/json": components["schemas"]["Error"];
5801
+ };
5802
+ };
5803
+ };
5804
+ };
5805
+ listEngines: {
5806
+ parameters: {
5807
+ query?: never;
5808
+ header?: never;
5809
+ path?: never;
5810
+ cookie?: never;
5811
+ };
5812
+ requestBody?: never;
5813
+ responses: {
5814
+ /** @description Engine versions */
5815
+ 200: {
5816
+ headers: {
5817
+ [name: string]: unknown;
5818
+ };
5819
+ content: {
5820
+ "application/json": components["schemas"]["Engines"];
5821
+ };
5822
+ };
5823
+ /** @description Malformed request */
5824
+ 400: {
5825
+ headers: {
5826
+ [name: string]: unknown;
5827
+ };
5828
+ content: {
5829
+ "application/json": components["schemas"]["Error"];
5830
+ };
5831
+ };
5832
+ /** @description Authentication required */
5833
+ 401: {
5834
+ headers: {
5835
+ [name: string]: unknown;
5836
+ };
5837
+ content: {
5838
+ "application/json": components["schemas"]["Error"];
5839
+ };
5840
+ };
5841
+ /** @description Insufficient permissions */
5842
+ 403: {
5843
+ headers: {
5844
+ [name: string]: unknown;
5845
+ };
5846
+ content: {
5847
+ "application/json": components["schemas"]["Error"];
5848
+ };
5849
+ };
5850
+ /** @description Not found in this organization */
5851
+ 404: {
5852
+ headers: {
5853
+ [name: string]: unknown;
5854
+ };
5855
+ content: {
5856
+ "application/json": components["schemas"]["Error"];
5857
+ };
5858
+ };
5859
+ /** @description Conflict with the current state */
5860
+ 409: {
5861
+ headers: {
5862
+ [name: string]: unknown;
5863
+ };
5864
+ content: {
5865
+ "application/json": components["schemas"]["Error"];
5866
+ };
5867
+ };
5868
+ /** @description Validation failed (issues carry JSON paths) */
5869
+ 422: {
5870
+ headers: {
5871
+ [name: string]: unknown;
5872
+ };
5873
+ content: {
5874
+ "application/json": components["schemas"]["Error"];
5875
+ };
5876
+ };
5877
+ };
5878
+ };
4322
5879
  }