@revenexx/node 0.1.1 → 0.2.0

package/dist/services/documents-register.d.mts

@@ -0,0 +1,697 @@
+import { Client } from '../client.mjs';
+import { Models } from '../models.mjs';
+import { DocumentsDocumentsListSource } from '../enums/documents-documents-list-source.mjs';
+import { Visibility } from '../enums/visibility.mjs';
+import { DocumentSource } from '../enums/document-source.mjs';
+import { DocumentVisibility } from '../enums/document-visibility.mjs';
+import '../query.mjs';
+import '../enums/accept-line-decision.mjs';
+import '../enums/accept-result-origin.mjs';
+import '../enums/accept-result-status.mjs';
+import '../enums/address-type-row-tone.mjs';
+import '../enums/address-type-row-create-request-tone.mjs';
+import '../enums/address-type-row-update-request-tone.mjs';
+import '../enums/approval-rule-approver-type.mjs';
+import '../enums/approval-rule-condition.mjs';
+import '../enums/approval-rule-effect.mjs';
+import '../enums/approval-rule-create-request-approver-type.mjs';
+import '../enums/approval-rule-create-request-condition.mjs';
+import '../enums/approval-rule-create-request-effect.mjs';
+import '../enums/approval-rule-update-request-approver-type.mjs';
+import '../enums/approval-rule-update-request-condition.mjs';
+import '../enums/approval-rule-update-request-effect.mjs';
+import '../enums/assets-source.mjs';
+import '../enums/assignment-role-tone.mjs';
+import '../enums/assignment-role-create-request-tone.mjs';
+import '../enums/assignment-role-update-request-tone.mjs';
+import '../enums/attach-request-direction.mjs';
+import '../enums/attach-request-visibility.mjs';
+import '../enums/attribute-value-bucket.mjs';
+import '../enums/auth-mail-source.mjs';
+import '../enums/auth-mfa-challenge-request-factor.mjs';
+import '../enums/recovery-mail-source.mjs';
+import '../enums/registration-status.mjs';
+import '../enums/availability-state-tone.mjs';
+import '../enums/banner-draft-layout.mjs';
+import '../enums/banner-draft-update-request-layout.mjs';
+import '../enums/budget-change-reason.mjs';
+import '../enums/budget-movement-result-status.mjs';
+import '../enums/budget-release-scope.mjs';
+import '../enums/budget-release-status.mjs';
+import '../enums/cart-status.mjs';
+import '../enums/cart-merge-strategy.mjs';
+import '../enums/cart-price-snapshot-mode.mjs';
+import '../enums/cart-io-format.mjs';
+import '../enums/cart-export-format.mjs';
+import '../enums/cart-item-type.mjs';
+import '../enums/cart-vocabulary-tone.mjs';
+import '../enums/cart-vocabulary-name.mjs';
+import '../enums/cart-vocabulary-source.mjs';
+import '../enums/cart-vocabulary-ref-name.mjs';
+import '../enums/categories-rule-match.mjs';
+import '../enums/category-rule-operator.mjs';
+import '../enums/category-rule-match.mjs';
+import '../enums/channel-status.mjs';
+import '../enums/channel-unassigned-visibility.mjs';
+import '../enums/channel-unresolved-reason.mjs';
+import '../enums/channel-context-source.mjs';
+import '../enums/channel-inactive-behavior.mjs';
+import '../enums/channel-policy-source.mjs';
+import '../enums/channel-policy-tenant-default.mjs';
+import '../enums/channel-unassigned-policy.mjs';
+import '../enums/channel-type-tone.mjs';
+import '../enums/channel-visibility-reason.mjs';
+import '../enums/channel-vocabulary-tone.mjs';
+import '../enums/channel-vocabulary-name.mjs';
+import '../enums/channel-vocabulary-source.mjs';
+import '../enums/channel-vocabulary-ref-name.mjs';
+import '../enums/consent-record-action.mjs';
+import '../enums/consent-record-surface.mjs';
+import '../enums/consent-record-create-request-action.mjs';
+import '../enums/consent-record-create-request-surface.mjs';
+import '../enums/consent-vocabulary-source.mjs';
+import '../enums/contact-order-approval-mode.mjs';
+import '../enums/contact-registration-status.mjs';
+import '../enums/contact-status.mjs';
+import '../enums/contact-activity-kind.mjs';
+import '../enums/order-approval-mode.mjs';
+import '../enums/contact-create-request-registration-status.mjs';
+import '../enums/contact-event-kind-tone.mjs';
+import '../enums/contact-event-kind-create-request-tone.mjs';
+import '../enums/contact-event-kind-update-request-tone.mjs';
+import '../enums/contact-point-kind-tone.mjs';
+import '../enums/contact-point-kind-create-request-tone.mjs';
+import '../enums/contact-point-kind-update-request-tone.mjs';
+import '../enums/cookie-kind.mjs';
+import '../enums/cookie-create-request-kind.mjs';
+import '../enums/cookie-update-request-kind.mjs';
+import '../enums/cost-center-budget-type.mjs';
+import '../enums/cost-center-create-request-budget-type.mjs';
+import '../enums/cost-center-restriction-type.mjs';
+import '../enums/cost-center-restriction-create-request-type.mjs';
+import '../enums/cost-center-restriction-update-request-type.mjs';
+import '../enums/cost-center-update-request-budget-type.mjs';
+import '../enums/cost-centers-vocabulary-tone.mjs';
+import '../enums/cost-centers-vocabulary-name.mjs';
+import '../enums/cost-centers-vocabulary-source.mjs';
+import '../enums/cost-centers-vocabulary-summary-name.mjs';
+import '../enums/direct-order-status.mjs';
+import '../enums/document-kind-tone.mjs';
+import '../enums/document-vocabulary-default-tone.mjs';
+import '../enums/document-vocabulary-name.mjs';
+import '../enums/document-vocabulary-source.mjs';
+import '../enums/document-vocabulary-tone.mjs';
+import '../enums/payment-fee-type.mjs';
+import '../enums/payment-method-kind.mjs';
+import '../enums/form-status.mjs';
+import '../enums/form-submission-status.mjs';
+import '../enums/form-notify-source.mjs';
+import '../enums/form-submission-prune-request-status.mjs';
+import '../enums/forms-vocabulary-tone.mjs';
+import '../enums/forms-vocabulary-name.mjs';
+import '../enums/forms-vocabulary-summary-name.mjs';
+import '../enums/inventory-receive-warning-code.mjs';
+import '../enums/inventory-vocabulary-default-tone.mjs';
+import '../enums/inventory-vocabulary-source.mjs';
+import '../enums/cart-io-apply-mode.mjs';
+import '../enums/cart-io-direction.mjs';
+import '../enums/cart-io-entity.mjs';
+import '../enums/io-profile-resource-apply-mode.mjs';
+import '../enums/io-profile-resource-direction.mjs';
+import '../enums/inventory-unorderable-reason.mjs';
+import '../enums/lifecycle-stage-tone.mjs';
+import '../enums/lifecycle-stage-create-request-tone.mjs';
+import '../enums/lifecycle-stage-update-request-tone.mjs';
+import '../enums/location-type.mjs';
+import '../enums/market-status.mjs';
+import '../enums/market-default-locale-source.mjs';
+import '../enums/market-locale-fallback.mjs';
+import '../enums/market-locale-granularity.mjs';
+import '../enums/market-pricing-source.mjs';
+import '../enums/market-tax-basis.mjs';
+import '../enums/market-readiness-check-id.mjs';
+import '../enums/market-readiness-severity.mjs';
+import '../enums/markets-vocabulary-tone.mjs';
+import '../enums/markets-vocabulary-name.mjs';
+import '../enums/markets-vocabulary-source.mjs';
+import '../enums/markets-vocabulary-summary-name.mjs';
+import '../enums/note-request-visibility.mjs';
+import '../enums/order-fulfillment-status.mjs';
+import '../enums/order-payment-status.mjs';
+import '../enums/order-status.mjs';
+import '../enums/order-cancellation-scope.mjs';
+import '../enums/order-comment-visibility.mjs';
+import '../enums/order-discount-target.mjs';
+import '../enums/order-discount-effect-kind.mjs';
+import '../enums/order-discount-placement.mjs';
+import '../enums/order-discount-source.mjs';
+import '../enums/order-discount-value-type.mjs';
+import '../enums/order-item-type.mjs';
+import '../enums/order-list-kind-tone.mjs';
+import '../enums/order-list-kind-row-tone.mjs';
+import '../enums/order-list-skip-reason.mjs';
+import '../enums/order-list-cart-mode.mjs';
+import '../enums/order-list-vocabulary-default-tone.mjs';
+import '../enums/order-list-vocabulary-name.mjs';
+import '../enums/order-list-vocabulary-source.mjs';
+import '../enums/order-list-vocabulary-tone.mjs';
+import '../enums/order-return-refund-mode.mjs';
+import '../enums/order-return-status.mjs';
+import '../enums/order-return-settlement.mjs';
+import '../enums/order-vocabulary-tone.mjs';
+import '../enums/order-return-refusal.mjs';
+import '../enums/order-vocabulary-name.mjs';
+import '../enums/order-vocabulary-source.mjs';
+import '../enums/order-vocabulary-summary-name.mjs';
+import '../enums/order-resolution-stage.mjs';
+import '../enums/organization-credit-limit-mode.mjs';
+import '../enums/organization-shipping-advice.mjs';
+import '../enums/organization-status.mjs';
+import '../enums/credit-limit-mode.mjs';
+import '../enums/shipping-advice.mjs';
+import '../enums/page-status.mjs';
+import '../enums/pages-vocabulary-app.mjs';
+import '../enums/pages-vocabulary-tone.mjs';
+import '../enums/pages-vocabulary-name.mjs';
+import '../enums/pages-vocabulary-source.mjs';
+import '../enums/pages-vocabulary-index-app.mjs';
+import '../enums/payment-dunning-stage.mjs';
+import '../enums/payment-failure-code.mjs';
+import '../enums/payment-status.mjs';
+import '../enums/payment-term-tone.mjs';
+import '../enums/payment-term-create-request-tone.mjs';
+import '../enums/payment-term-update-request-tone.mjs';
+import '../enums/payment-vocabulary-tone.mjs';
+import '../enums/pending-approval-approver-type.mjs';
+import '../enums/pending-approval-status.mjs';
+import '../enums/price-ending-rule.mjs';
+import '../enums/price-entries-adjust-response-rounding.mjs';
+import '../enums/price-entries-adjust-response-rounding-mode.mjs';
+import '../enums/price-entries-bulk-mode.mjs';
+import '../enums/price-rounding-mode.mjs';
+import '../enums/price-entry-type.mjs';
+import '../enums/price-line-price-reason.mjs';
+import '../enums/price-list-status.mjs';
+import '../enums/price-list-tax-basis.mjs';
+import '../enums/price-currency-source.mjs';
+import '../enums/price-list-tiebreak.mjs';
+import '../enums/price-tax-inclusive-default.mjs';
+import '../enums/price-tax-unresolved-reason.mjs';
+import '../enums/price-tax-market-source.mjs';
+import '../enums/price-vocabulary-tone.mjs';
+import '../enums/price-vocabulary-name.mjs';
+import '../enums/price-vocabulary-source.mjs';
+import '../enums/price-vocabulary-ref-name.mjs';
+import '../enums/procurement-vocabulary-default-tone.mjs';
+import '../enums/procurement-vocabulary-name.mjs';
+import '../enums/procurement-vocabulary-source.mjs';
+import '../enums/procurement-vocabulary-summary-name.mjs';
+import '../enums/procurement-vocabulary-value-tone.mjs';
+import '../enums/product-categories-source.mjs';
+import '../enums/product-grid-column-source.mjs';
+import '../enums/product-label-source.mjs';
+import '../enums/product-label-attribute-source.mjs';
+import '../enums/products-kind.mjs';
+import '../enums/promotion-condition-match.mjs';
+import '../enums/promotion-reach.mjs';
+import '../enums/promotion-recurrence-kind.mjs';
+import '../enums/promotion-return-behaviour.mjs';
+import '../enums/promotion-status.mjs';
+import '../enums/promotion-bundle-allocation.mjs';
+import '../enums/promotion-bundle-patch-allocation.mjs';
+import '../enums/promotion-bundle-write-allocation.mjs';
+import '../enums/promotion-condition-kind.mjs';
+import '../enums/promotion-condition-match-mode.mjs';
+import '../enums/promotion-condition-patch-kind.mjs';
+import '../enums/promotion-condition-patch-match-mode.mjs';
+import '../enums/promotion-condition-write-kind.mjs';
+import '../enums/promotion-condition-write-match-mode.mjs';
+import '../enums/promotion-effect-kind.mjs';
+import '../enums/promotion-effect-target-scope.mjs';
+import '../enums/promotion-effect-unit-choice.mjs';
+import '../enums/promotion-effect-value-type.mjs';
+import '../enums/promotion-effect-patch-kind.mjs';
+import '../enums/promotion-effect-patch-target-scope.mjs';
+import '../enums/promotion-effect-patch-unit-choice.mjs';
+import '../enums/promotion-effect-patch-value-type.mjs';
+import '../enums/promotion-effect-write-kind.mjs';
+import '../enums/promotion-effect-write-target-scope.mjs';
+import '../enums/promotion-effect-write-unit-choice.mjs';
+import '../enums/promotion-effect-write-value-type.mjs';
+import '../enums/promotion-patch-condition-match.mjs';
+import '../enums/promotion-patch-reach.mjs';
+import '../enums/promotion-patch-recurrence-kind.mjs';
+import '../enums/promotion-patch-return-behaviour.mjs';
+import '../enums/promotion-patch-status.mjs';
+import '../enums/promotion-release-request-reason.mjs';
+import '../enums/promotion-write-condition-match.mjs';
+import '../enums/promotion-write-reach.mjs';
+import '../enums/promotion-write-recurrence-kind.mjs';
+import '../enums/promotion-write-return-behaviour.mjs';
+import '../enums/promotion-write-status.mjs';
+import '../enums/punchout-entry-probe-result-entry-probe-status.mjs';
+import '../enums/punchout-entry-test-result-protocol.mjs';
+import '../enums/punchout-field-mapping-import-request-protocol.mjs';
+import '../enums/punchout-return-preview-protocol.mjs';
+import '../enums/purchase-request-status.mjs';
+import '../enums/purchase-request-event-name.mjs';
+import '../enums/purchase-request-item-type.mjs';
+import '../enums/purchase-request-item-create-request-type.mjs';
+import '../enums/purchase-request-item-update-request-type.mjs';
+import '../enums/purpose-legal-basis.mjs';
+import '../enums/purpose-create-request-legal-basis.mjs';
+import '../enums/purpose-update-request-legal-basis.mjs';
+import '../enums/quote-origin.mjs';
+import '../enums/quote-status.mjs';
+import '../enums/quote-attachment-direction.mjs';
+import '../enums/quote-attachment-visibility.mjs';
+import '../enums/quote-detail-origin.mjs';
+import '../enums/quote-detail-status.mjs';
+import '../enums/quote-event-visibility.mjs';
+import '../enums/quote-item-decision.mjs';
+import '../enums/quote-item-price-reason.mjs';
+import '../enums/quote-line-input-price-reason.mjs';
+import '../enums/redemption-state.mjs';
+import '../enums/reorder-point-source.mjs';
+import '../enums/reservation-status.mjs';
+import '../enums/price-on-request-reason.mjs';
+import '../enums/price-tax-basis.mjs';
+import '../enums/price-tax-basis-source.mjs';
+import '../enums/role-catalog-response-source.mjs';
+import '../enums/sales-rep-vocabulary-default-tone.mjs';
+import '../enums/sales-rep-vocabulary-source.mjs';
+import '../enums/seed-request-mode.mjs';
+import '../enums/seed-result-mode.mjs';
+import '../enums/segment-rule-match.mjs';
+import '../enums/segment-member-source.mjs';
+import '../enums/segment-rule-operator.mjs';
+import '../enums/segment-rule-preview-request-rule-match.mjs';
+import '../enums/segment-rule-preview-request-target.mjs';
+import '../enums/segment-rule-preview-response-rule-match.mjs';
+import '../enums/segment-rule-preview-response-target.mjs';
+import '../enums/segment-rules-target.mjs';
+import '../enums/shipping-carrier-status.mjs';
+import '../enums/shipping-method-matrix-basis.mjs';
+import '../enums/shipping-method-pricing-type.mjs';
+import '../enums/shipping-carrier-source.mjs';
+import '../enums/shipping-rate-pricing-type.mjs';
+import '../enums/shipping-tax-source.mjs';
+import '../enums/shipping-free-above-basis.mjs';
+import '../enums/shipping-rates-basis-matrix-basis-default.mjs';
+import '../enums/shipping-service-level-create-request-tone.mjs';
+import '../enums/shipping-service-level-row-tone.mjs';
+import '../enums/shipping-service-level-update-request-tone.mjs';
+import '../enums/shipping-tax-unresolved-reason.mjs';
+import '../enums/shipping-tax-market-source.mjs';
+import '../enums/shipping-tax-context-via.mjs';
+import '../enums/shipping-tracking-carrier-status.mjs';
+import '../enums/shipping-vocabulary-default-tone.mjs';
+import '../enums/shipping-vocabulary-source.mjs';
+import '../enums/shipping-vocabulary-tone.mjs';
+import '../enums/shipping-weight-unit-create-request-tone.mjs';
+import '../enums/shipping-weight-unit-row-tone.mjs';
+import '../enums/shipping-weight-unit-update-request-tone.mjs';
+import '../enums/stacking-group-mode.mjs';
+import '../enums/stacking-group-patch-mode.mjs';
+import '../enums/stacking-group-write-mode.mjs';
+import '../enums/stock-movement-type.mjs';
+import '../enums/store-asset-request-visibility.mjs';
+import '../enums/submit-item-type.mjs';
+import '../enums/submit-result-outcome.mjs';
+import '../enums/tag-manager-container-check-reason.mjs';
+import '../enums/tag-manager-marketing-tag-kind.mjs';
+import '../enums/tag-manager-marketing-tag-load.mjs';
+import '../enums/tag-manager-marketing-tag-input-kind.mjs';
+import '../enums/tag-manager-marketing-tag-input-load.mjs';
+import '../enums/tag-manager-trigger-kind.mjs';
+import '../enums/tag-manager-trigger-input-kind.mjs';
+import '../enums/tag-manager-variable-kind.mjs';
+import '../enums/tag-manager-variable-input-kind.mjs';
+import '../enums/validation-failed-response-status.mjs';
+import '../enums/vendor-legal-basis-override.mjs';
+import '../enums/vendor-create-request-legal-basis-override.mjs';
+import '../enums/vendor-update-request-legal-basis-override.mjs';
+import '../enums/vocabulary-default-tone.mjs';
+import '../enums/vocabulary-source.mjs';
+import '../enums/vocabulary-tone.mjs';
+import '../enums/voucher-status.mjs';
+import '../enums/voucher-batch-status.mjs';
+import '../enums/voucher-batch-patch-status.mjs';
+import '../enums/voucher-batch-write-status.mjs';
+import '../enums/voucher-patch-status.mjs';
+import '../enums/voucher-write-status.mjs';
+import '../enums/attribute-boolean-status.mjs';
+import '../enums/attribute-datetime-status.mjs';
+import '../enums/attribute-email-status.mjs';
+import '../enums/attribute-enum-status.mjs';
+import '../enums/attribute-float-status.mjs';
+import '../enums/attribute-integer-status.mjs';
+import '../enums/attribute-ip-status.mjs';
+import '../enums/attribute-line-status.mjs';
+import '../enums/attribute-longtext-status.mjs';
+import '../enums/attribute-mediumtext-status.mjs';
+import '../enums/attribute-point-status.mjs';
+import '../enums/attribute-polygon-status.mjs';
+import '../enums/attribute-relationship-status.mjs';
+import '../enums/attribute-string-status.mjs';
+import '../enums/attribute-text-status.mjs';
+import '../enums/attribute-url-status.mjs';
+import '../enums/attribute-varchar-status.mjs';
+import '../enums/column-boolean-status.mjs';
+import '../enums/column-datetime-status.mjs';
+import '../enums/column-email-status.mjs';
+import '../enums/column-enum-status.mjs';
+import '../enums/column-float-status.mjs';
+import '../enums/column-integer-status.mjs';
+import '../enums/column-ip-status.mjs';
+import '../enums/column-line-status.mjs';
+import '../enums/column-longtext-status.mjs';
+import '../enums/column-mediumtext-status.mjs';
+import '../enums/column-point-status.mjs';
+import '../enums/column-polygon-status.mjs';
+import '../enums/column-relationship-status.mjs';
+import '../enums/column-string-status.mjs';
+import '../enums/column-text-status.mjs';
+import '../enums/column-url-status.mjs';
+import '../enums/column-varchar-status.mjs';
+import '../enums/database-type.mjs';
+import '../enums/deployment-status.mjs';
+import '../enums/execution-status.mjs';
+import '../enums/execution-trigger.mjs';
+import '../enums/health-antivirus-status.mjs';
+import '../enums/health-status-status.mjs';
+import '../enums/index-status.mjs';
+import '../enums/message-2-status.mjs';
+
+declare class DocumentsRegister {
+    client: Client;
+    constructor(client: Client);
+    /**
+     * A document is one record a merchant issued and filed against a transaction — an invoice, a delivery note, a credit note, a return receipt. The row is the REGISTER entry: it says which transaction the document belongs to, what kind of record it is, the number a customer quotes, who may read it and where its bytes live. It never holds the bytes, and this app never produces a document. This is the list an account area reads: filter `?entity_type=order&entity_id=…` for one transaction's papers, `?kind=invoice` for one sort of record, `?number=` for the one a customer quoted. Read `visibility` before trusting the answer to be complete — a STOREFRONT caller (one acting for a buyer, or one asking with `?audience=customer`) is confined to the customer documents in the query itself, so an internal one is absent from `items` AND from `page.total`, which is what stops the count telling a buyer how many documents it is not being shown. The narrowing only ever narrows: `?visibility=internal` from such a caller answers the customer ones, not a 403.
+     *
+     * @param {string} params.id - Filter to rows whose `id` is exactly this value. The row's own id, generated by the database. A caller never sends one — it reads one back and puts it in the path of every later call.
+     * @param {string} params.entityType - Filter by the kind of transaction a document belongs to. Send it together with `entity_id`: on its own it selects every document of every order.
+     * @param {string} params.entityId - Filter to ONE transaction's documents — with `entity_type`, this is the pair an account area reads a buyer's papers with.
+     * @param {string} params.kind - Filter by kind. One of the kinds this tenant keeps (GET /documents/kinds); no enum is published, because the set is the merchant's and a value they added this morning must not be refused.
+     * @param {string} params.number - Look a document up by the number printed on it — the search a service desk starts from when a customer quotes one. Exact match, and not unique: two documents of one order may legitimately share a number.
+     * @param {DocumentsDocumentsListSource} params.source - Filter by where the bytes are. The operational use is finding the external ones before a host is retired.
+     * @param {string} params.storageAssetId - Find the document that points at one stored file — the reverse lookup, for a clean-up that has an asset and needs its register entry.
+     * @param {string} params.deliveryPath - Filter to rows whose `delivery_path` is exactly this value. Where the stored file is served from today — a CDN path, and a CACHE of an address rather than an authorisation. Do NOT fetch a document with it: a path is not a permission, so it answers a private asset with 403, and it is stale the moment the file moves. POST /documents/documents/{id}/link is the way to get the bytes; this column is kept for an operator tracing an object through the delivery plane. Null for an external document.
+     * @param {string} params.externalUrl - Filter to rows whose `external_url` is exactly this value. The address of a file this platform does not hold. Required while `source` is 'external' and null otherwise. It is the tenant's own host — a document archive, a finance system's portal — and this app stores the address without fetching it.
+     * @param {string} params.filename - Filter by the exact file name. Useful against a feed that re-sends under a new key; it is an equality, not a search.
+     * @param {string} params.contentType - Filter to rows whose `content_type` is exactly this value. The media type of the file, so a client knows whether to open it or hand it to the browser. Nullable, because a feed does not always say.
+     * @param {number} params.byteSize - Filter to rows whose `byte_size` is exactly this value. How large the file is, in bytes — what a download link shows next to it. Nullable, and never computed here: this app does not read the bytes.
+     * @param {string} params.issuedAt - Exact equality — this API has no range filter. To bound a period, sort with `order` and page. The date ON the document — when the merchant issued it, not when this row was written. It is the date a buyer sorts their invoices by and the one that appears in a tax return, which is why it is a date and not a timestamp: a document is issued on a day.
+     * @param {string} params.dueDate - Exact equality — this API has no range filter. To bound a period, sort with `order` and page. When the amount on this document is due. Only some kinds carry one — an invoice does, a delivery note does not — so it is nullable, and nothing in this app dunns on it.
+     * @param {number} params.totalAmount - Filter to rows whose `total_amount` is exactly this value. The gross amount printed on the document, in `currency`. A COPY of what the document says, kept so a list can show it without fetching the file — it is not recomputed here and never corrects the document. Nullable: a delivery note carries no amount.
+     * @param {string} params.currency - Filter to rows whose `currency` is exactly this value. The ISO 4217 code the amount is in. Nullable exactly where the amount is, and carried per document rather than per tenant because a merchant selling across markets issues in more than one.
+     * @param {Visibility} params.visibility - Filter by who may read the document. A storefront caller is confined to 'customer' whatever it sends here, so this selector narrows an operator's list and can never widen a buyer's.
+     * @param {string} params.externalId - Look a document up by the key the system that issued it knows it by — what a feed does before deciding between a create and an update. Unique per tenant, so this answers at most one document.
+     * @param {string} params.sourceSyncedAt - Exact equality — this API has no range filter. To bound a period, sort with `order` and page. When this row was last confirmed against its source. A delta run asks for changes since it, and an operator reads it to see that a feed has gone quiet. An edit made here does not touch it: it records when the SOURCE was last seen, not when the row changed.
+     * @param {string} params.createdAt - Exact equality — this API has no range filter. To bound a period, sort with `order` and page. When the row was created. Server-set: it is in no request body, and a value sent for it is ignored.
+     * @param {string} params.updatedAt - Exact equality — this API has no range filter. To bound a period, sort with `order` and page. When the row was last written. Server-set — every route that changes this row stamps it.
+     * @param {number} params.limit - Page size (default 50, max 200). A larger value is clamped rather than refused.
+     * @param {number} params.offset - Row offset for pagination (default 0). Page with `page.total` and `page.hasMore`.
+     * @param {string} params.order - Sort by one column: 'column' | 'column.asc' | 'column.desc' — a bare column sorts ascending. The column has to be one this entity has; anything else is refused with 400.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    documentsDocumentsList(params?: {
+        id?: string;
+        entityType?: string;
+        entityId?: string;
+        kind?: string;
+        number?: string;
+        source?: DocumentsDocumentsListSource;
+        storageAssetId?: string;
+        deliveryPath?: string;
+        externalUrl?: string;
+        filename?: string;
+        contentType?: string;
+        byteSize?: number;
+        issuedAt?: string;
+        dueDate?: string;
+        totalAmount?: number;
+        currency?: string;
+        visibility?: Visibility;
+        externalId?: string;
+        sourceSyncedAt?: string;
+        createdAt?: string;
+        updatedAt?: string;
+        limit?: number;
+        offset?: number;
+        order?: string;
+    }): Promise<{}>;
+    /**
+     * A document is one record a merchant issued and filed against a transaction — an invoice, a delivery note, a credit note, a return receipt. The row is the REGISTER entry: it says which transaction the document belongs to, what kind of record it is, the number a customer quotes, who may read it and where its bytes live. It never holds the bytes, and this app never produces a document. This is the list an account area reads: filter `?entity_type=order&entity_id=…` for one transaction's papers, `?kind=invoice` for one sort of record, `?number=` for the one a customer quoted. Read `visibility` before trusting the answer to be complete — a STOREFRONT caller (one acting for a buyer, or one asking with `?audience=customer`) is confined to the customer documents in the query itself, so an internal one is absent from `items` AND from `page.total`, which is what stops the count telling a buyer how many documents it is not being shown. The narrowing only ever narrows: `?visibility=internal` from such a caller answers the customer ones, not a 403.
+     *
+     * @param {string} id - Filter to rows whose `id` is exactly this value. The row's own id, generated by the database. A caller never sends one — it reads one back and puts it in the path of every later call.
+     * @param {string} entityType - Filter by the kind of transaction a document belongs to. Send it together with `entity_id`: on its own it selects every document of every order.
+     * @param {string} entityId - Filter to ONE transaction's documents — with `entity_type`, this is the pair an account area reads a buyer's papers with.
+     * @param {string} kind - Filter by kind. One of the kinds this tenant keeps (GET /documents/kinds); no enum is published, because the set is the merchant's and a value they added this morning must not be refused.
+     * @param {string} number - Look a document up by the number printed on it — the search a service desk starts from when a customer quotes one. Exact match, and not unique: two documents of one order may legitimately share a number.
+     * @param {DocumentsDocumentsListSource} source - Filter by where the bytes are. The operational use is finding the external ones before a host is retired.
+     * @param {string} storageAssetId - Find the document that points at one stored file — the reverse lookup, for a clean-up that has an asset and needs its register entry.
+     * @param {string} deliveryPath - Filter to rows whose `delivery_path` is exactly this value. Where the stored file is served from today — a CDN path, and a CACHE of an address rather than an authorisation. Do NOT fetch a document with it: a path is not a permission, so it answers a private asset with 403, and it is stale the moment the file moves. POST /documents/documents/{id}/link is the way to get the bytes; this column is kept for an operator tracing an object through the delivery plane. Null for an external document.
+     * @param {string} externalUrl - Filter to rows whose `external_url` is exactly this value. The address of a file this platform does not hold. Required while `source` is 'external' and null otherwise. It is the tenant's own host — a document archive, a finance system's portal — and this app stores the address without fetching it.
+     * @param {string} filename - Filter by the exact file name. Useful against a feed that re-sends under a new key; it is an equality, not a search.
+     * @param {string} contentType - Filter to rows whose `content_type` is exactly this value. The media type of the file, so a client knows whether to open it or hand it to the browser. Nullable, because a feed does not always say.
+     * @param {number} byteSize - Filter to rows whose `byte_size` is exactly this value. How large the file is, in bytes — what a download link shows next to it. Nullable, and never computed here: this app does not read the bytes.
+     * @param {string} issuedAt - Exact equality — this API has no range filter. To bound a period, sort with `order` and page. The date ON the document — when the merchant issued it, not when this row was written. It is the date a buyer sorts their invoices by and the one that appears in a tax return, which is why it is a date and not a timestamp: a document is issued on a day.
+     * @param {string} dueDate - Exact equality — this API has no range filter. To bound a period, sort with `order` and page. When the amount on this document is due. Only some kinds carry one — an invoice does, a delivery note does not — so it is nullable, and nothing in this app dunns on it.
+     * @param {number} totalAmount - Filter to rows whose `total_amount` is exactly this value. The gross amount printed on the document, in `currency`. A COPY of what the document says, kept so a list can show it without fetching the file — it is not recomputed here and never corrects the document. Nullable: a delivery note carries no amount.
+     * @param {string} currency - Filter to rows whose `currency` is exactly this value. The ISO 4217 code the amount is in. Nullable exactly where the amount is, and carried per document rather than per tenant because a merchant selling across markets issues in more than one.
+     * @param {Visibility} visibility - Filter by who may read the document. A storefront caller is confined to 'customer' whatever it sends here, so this selector narrows an operator's list and can never widen a buyer's.
+     * @param {string} externalId - Look a document up by the key the system that issued it knows it by — what a feed does before deciding between a create and an update. Unique per tenant, so this answers at most one document.
+     * @param {string} sourceSyncedAt - Exact equality — this API has no range filter. To bound a period, sort with `order` and page. When this row was last confirmed against its source. A delta run asks for changes since it, and an operator reads it to see that a feed has gone quiet. An edit made here does not touch it: it records when the SOURCE was last seen, not when the row changed.
+     * @param {string} createdAt - Exact equality — this API has no range filter. To bound a period, sort with `order` and page. When the row was created. Server-set: it is in no request body, and a value sent for it is ignored.
+     * @param {string} updatedAt - Exact equality — this API has no range filter. To bound a period, sort with `order` and page. When the row was last written. Server-set — every route that changes this row stamps it.
+     * @param {number} limit - Page size (default 50, max 200). A larger value is clamped rather than refused.
+     * @param {number} offset - Row offset for pagination (default 0). Page with `page.total` and `page.hasMore`.
+     * @param {string} order - Sort by one column: 'column' | 'column.asc' | 'column.desc' — a bare column sorts ascending. The column has to be one this entity has; anything else is refused with 400.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    documentsDocumentsList(id?: string, entityType?: string, entityId?: string, kind?: string, number?: string, source?: DocumentsDocumentsListSource, storageAssetId?: string, deliveryPath?: string, externalUrl?: string, filename?: string, contentType?: string, byteSize?: number, issuedAt?: string, dueDate?: string, totalAmount?: number, currency?: string, visibility?: Visibility, externalId?: string, sourceSyncedAt?: string, createdAt?: string, updatedAt?: string, limit?: number, offset?: number, order?: string): Promise<{}>;
+    /**
+     * A document is one record a merchant issued and filed against a transaction — an invoice, a delivery note, a credit note, a return receipt. The row is the REGISTER entry: it says which transaction the document belongs to, what kind of record it is, the number a customer quotes, who may read it and where its bytes live. It never holds the bytes, and this app never produces a document. This route is written for a FEED, because a feed re-runs: a body carrying an `external_id` this tenant already holds UPDATES that document and answers 200, and a body with none is a plain create and answers 201. That is what stops a retry, a restart or a full re-sync showing a buyer one invoice three times; the unique index behind `external_id` is the net under it rather than the mechanism. Four fields are owed — `entity_type`, `entity_id`, `kind` and `filename` — and two are decided for you: `source` defaults to 'storage' and `visibility` to 'customer', because a document a finance system issues to a customer is the normal case. Three refusals are worth knowing before the first call: `entity_type` accepts `order` and nothing else yet and its refusal NAMES what it accepts, `kind` has to be one this tenant keeps (GET /documents/kinds) and its refusal lists them, and the byte binding is the database's — `source: 'storage'` needs a `storage_asset_id`, `source: 'external'` an `external_url`.
+     *
+     * @param {string} params.entityId - WHICH transaction this document belongs to — the id of the order, as the orders app knows it. Nothing here checks that the transaction exists: it lives in another app, and a register that called it on every write would fail a whole feed for one deleted order. Together with `entity_type` this is the filter an account area reads a buyer's papers with.
+     * @param {string} params.entityType - WHAT KIND of transaction this document belongs to. `order` is the only value this app accepts today, and a write naming anything else is refused with a message listing what is accepted. The column carries no database constraint on purpose: a return receipt hangs off a return, a contract off an organization and a certificate off a product, so the next kind of owner is a release of this app rather than a migration.
+     * @param {string} params.filename - What the file is called — the name a person is offered when they download it, and the only thing the register has to show them. Required, at least one character: a row that names no file is an offer of a download nobody can complete.
+     * @param {string} params.kind - What kind of record this is, as a code from GET /documents/kinds — `invoice`, `delivery_note`, `credit_note`, `return_receipt` on a fresh install, plus whatever the merchant added. The check is a membership test against the tenant's own table and NOT a database constraint, because a merchant adds a proforma invoice or a dunning letter without a release of this app. A code the tenant does not keep is refused with 400 and the list of the ones they do.
+     * @param {number} params.byteSize - How large the file is, in bytes — what a download link shows next to it. Nullable, and never computed here: this app does not read the bytes.
+     * @param {string} params.contentType - The media type of the file, so a client knows whether to open it or hand it to the browser. Nullable, because a feed does not always say.
+     * @param {string} params.currency - The ISO 4217 code the amount is in. Nullable exactly where the amount is, and carried per document rather than per tenant because a merchant selling across markets issues in more than one.
+     * @param {string} params.deliveryPath - Where the stored file is served from today — a CDN path, and a CACHE of an address rather than an authorisation. Do NOT fetch a document with it: a path is not a permission, so it answers a private asset with 403, and it is stale the moment the file moves. POST /documents/documents/{id}/link is the way to get the bytes; this column is kept for an operator tracing an object through the delivery plane. Null for an external document.
+     * @param {string} params.dueDate - When the amount on this document is due. Only some kinds carry one — an invoice does, a delivery note does not — so it is nullable, and nothing in this app dunns on it.
+     * @param {string} params.externalId - The key this document has in the system that ISSUED it — a finance system, a warehouse. Unique per tenant, and the key this register recognises a feed's own rows by: a write carrying one this tenant already holds UPDATES that document and answers 200 instead of filing a second copy. The document number is deliberately NOT that key, because a merchant may renumber and one number may cover an invoice and its delivery note.
+     * @param {object} params.externalRefs - Every OTHER system that knows this row, keyed by system name. `external_id` is the leading system; this is the rest, and a new one costs no column. Answered and NOT filterable — see the note on `metadata`.
+     * @param {string} params.externalUrl - The address of a file this platform does not hold. Required while `source` is 'external' and null otherwise. It is the tenant's own host — a document archive, a finance system's portal — and this app stores the address without fetching it.
+     * @param {string} params.issuedAt - The date ON the document — when the merchant issued it, not when this row was written. It is the date a buyer sorts their invoices by and the one that appears in a tax return, which is why it is a date and not a timestamp: a document is issued on a day.
+     * @param {object} params.metadata - Free-form data the tenant keeps on the row. No route in this app reads it; it is stored and handed back unchanged. It is answered and is NOT a query parameter: a jsonb column is compared as a WHOLE document, so `?metadata=erp` is refused with 400 `invalid_value` rather than answered with an empty page, and a selector whose every plausible use fails is worse than none.
+     * @param {string} params.number - The number printed on the document — what a customer quotes when they call about it, and what a service desk searches for. The DOCUMENT's own number, not the order's: an invoice and its credit note carry different ones. Nullable, because a delivery note is not always numbered, and NOT unique: a merchant who issues an invoice and its delivery note under one number is ordinary practice, and the source key is what identifies a row instead.
+     * @param {DocumentSource} params.source - WHERE the bytes are, and which of the two address columns is filled. 'storage' — an asset this platform holds, addressed by `storage_asset_id`, and the only case POST /documents/documents/{id}/link can hand over: the bucket is private, so the link is a signed, short-lived URL. 'external' — a file on a host the tenant runs, addressed by `external_url`, which this app neither fetches nor signs. The database pairs them: `(source = 'storage' AND storage_asset_id IS NOT NULL) OR (source = 'external' AND external_url IS NOT NULL)`, the same CHECK the product assets carry, so neither pairing can be half-filled. It is a discriminator rather than a preference. Defaults to 'storage'.
+     * @param {object} params.sourceData - What the source said about this row, kept as it said it. Carries the ETag a write-back has to return in `If-Match`, and the source fields this app does not model — without it those are lost on the first edit here. Answered and NOT filterable — see the note on `metadata`.
+     * @param {string} params.sourceSyncedAt - When this row was last confirmed against its source. A delta run asks for changes since it, and an operator reads it to see that a feed has gone quiet. An edit made here does not touch it: it records when the SOURCE was last seen, not when the row changed.
+     * @param {string} params.storageAssetId - The stable identity of the stored file, as the platform's storage service issued it. Required while `source` is 'storage' and null otherwise. It is the IDENTITY, not an address: it survives a move or a rename, which `delivery_path` does not, and it is what POST /documents/documents/{id}/link signs. The file is uploaded by whoever ISSUES the document — this app stores no bytes and has no upload route.
+     * @param {number} params.totalAmount - The gross amount printed on the document, in `currency`. A COPY of what the document says, kept so a list can show it without fetching the file — it is not recomputed here and never corrects the document. Nullable: a delivery note carries no amount.
+     * @param {DocumentVisibility} params.visibility - Who may read this document. 'customer' — the buyer may, which is what an account area shows and the column's default, because a document a finance system issues to a customer is the normal case. 'internal' — the merchant's side only: a margin sheet, a supplier confirmation, a credit note still being argued about. A storefront caller is confined to 'customer' IN THE QUERY, so an internal document is absent from its list, absent from its page total and answered 404 at its own address. This is the one value in this app that, set wrongly, shows a buyer another buyer's invoice. Defaults to 'customer'.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Document>}
+     */
+    documentsDocumentsCreate(params: {
+        entityId: string;
+        entityType: string;
+        filename: string;
+        kind: string;
+        byteSize?: number;
+        contentType?: string;
+        currency?: string;
+        deliveryPath?: string;
+        dueDate?: string;
+        externalId?: string;
+        externalRefs?: object;
+        externalUrl?: string;
+        issuedAt?: string;
+        metadata?: object;
+        number?: string;
+        source?: DocumentSource;
+        sourceData?: object;
+        sourceSyncedAt?: string;
+        storageAssetId?: string;
+        totalAmount?: number;
+        visibility?: DocumentVisibility;
+    }): Promise<Models.Document>;
+    /**
+     * A document is one record a merchant issued and filed against a transaction — an invoice, a delivery note, a credit note, a return receipt. The row is the REGISTER entry: it says which transaction the document belongs to, what kind of record it is, the number a customer quotes, who may read it and where its bytes live. It never holds the bytes, and this app never produces a document. This route is written for a FEED, because a feed re-runs: a body carrying an `external_id` this tenant already holds UPDATES that document and answers 200, and a body with none is a plain create and answers 201. That is what stops a retry, a restart or a full re-sync showing a buyer one invoice three times; the unique index behind `external_id` is the net under it rather than the mechanism. Four fields are owed — `entity_type`, `entity_id`, `kind` and `filename` — and two are decided for you: `source` defaults to 'storage' and `visibility` to 'customer', because a document a finance system issues to a customer is the normal case. Three refusals are worth knowing before the first call: `entity_type` accepts `order` and nothing else yet and its refusal NAMES what it accepts, `kind` has to be one this tenant keeps (GET /documents/kinds) and its refusal lists them, and the byte binding is the database's — `source: 'storage'` needs a `storage_asset_id`, `source: 'external'` an `external_url`.
+     *
+     * @param {string} entityId - WHICH transaction this document belongs to — the id of the order, as the orders app knows it. Nothing here checks that the transaction exists: it lives in another app, and a register that called it on every write would fail a whole feed for one deleted order. Together with `entity_type` this is the filter an account area reads a buyer's papers with.
+     * @param {string} entityType - WHAT KIND of transaction this document belongs to. `order` is the only value this app accepts today, and a write naming anything else is refused with a message listing what is accepted. The column carries no database constraint on purpose: a return receipt hangs off a return, a contract off an organization and a certificate off a product, so the next kind of owner is a release of this app rather than a migration.
+     * @param {string} filename - What the file is called — the name a person is offered when they download it, and the only thing the register has to show them. Required, at least one character: a row that names no file is an offer of a download nobody can complete.
+     * @param {string} kind - What kind of record this is, as a code from GET /documents/kinds — `invoice`, `delivery_note`, `credit_note`, `return_receipt` on a fresh install, plus whatever the merchant added. The check is a membership test against the tenant's own table and NOT a database constraint, because a merchant adds a proforma invoice or a dunning letter without a release of this app. A code the tenant does not keep is refused with 400 and the list of the ones they do.
+     * @param {number} byteSize - How large the file is, in bytes — what a download link shows next to it. Nullable, and never computed here: this app does not read the bytes.
+     * @param {string} contentType - The media type of the file, so a client knows whether to open it or hand it to the browser. Nullable, because a feed does not always say.
+     * @param {string} currency - The ISO 4217 code the amount is in. Nullable exactly where the amount is, and carried per document rather than per tenant because a merchant selling across markets issues in more than one.
+     * @param {string} deliveryPath - Where the stored file is served from today — a CDN path, and a CACHE of an address rather than an authorisation. Do NOT fetch a document with it: a path is not a permission, so it answers a private asset with 403, and it is stale the moment the file moves. POST /documents/documents/{id}/link is the way to get the bytes; this column is kept for an operator tracing an object through the delivery plane. Null for an external document.
+     * @param {string} dueDate - When the amount on this document is due. Only some kinds carry one — an invoice does, a delivery note does not — so it is nullable, and nothing in this app dunns on it.
+     * @param {string} externalId - The key this document has in the system that ISSUED it — a finance system, a warehouse. Unique per tenant, and the key this register recognises a feed's own rows by: a write carrying one this tenant already holds UPDATES that document and answers 200 instead of filing a second copy. The document number is deliberately NOT that key, because a merchant may renumber and one number may cover an invoice and its delivery note.
+     * @param {object} externalRefs - Every OTHER system that knows this row, keyed by system name. `external_id` is the leading system; this is the rest, and a new one costs no column. Answered and NOT filterable — see the note on `metadata`.
+     * @param {string} externalUrl - The address of a file this platform does not hold. Required while `source` is 'external' and null otherwise. It is the tenant's own host — a document archive, a finance system's portal — and this app stores the address without fetching it.
+     * @param {string} issuedAt - The date ON the document — when the merchant issued it, not when this row was written. It is the date a buyer sorts their invoices by and the one that appears in a tax return, which is why it is a date and not a timestamp: a document is issued on a day.
+     * @param {object} metadata - Free-form data the tenant keeps on the row. No route in this app reads it; it is stored and handed back unchanged. It is answered and is NOT a query parameter: a jsonb column is compared as a WHOLE document, so `?metadata=erp` is refused with 400 `invalid_value` rather than answered with an empty page, and a selector whose every plausible use fails is worse than none.
+     * @param {string} number - The number printed on the document — what a customer quotes when they call about it, and what a service desk searches for. The DOCUMENT's own number, not the order's: an invoice and its credit note carry different ones. Nullable, because a delivery note is not always numbered, and NOT unique: a merchant who issues an invoice and its delivery note under one number is ordinary practice, and the source key is what identifies a row instead.
+     * @param {DocumentSource} source - WHERE the bytes are, and which of the two address columns is filled. 'storage' — an asset this platform holds, addressed by `storage_asset_id`, and the only case POST /documents/documents/{id}/link can hand over: the bucket is private, so the link is a signed, short-lived URL. 'external' — a file on a host the tenant runs, addressed by `external_url`, which this app neither fetches nor signs. The database pairs them: `(source = 'storage' AND storage_asset_id IS NOT NULL) OR (source = 'external' AND external_url IS NOT NULL)`, the same CHECK the product assets carry, so neither pairing can be half-filled. It is a discriminator rather than a preference. Defaults to 'storage'.
+     * @param {object} sourceData - What the source said about this row, kept as it said it. Carries the ETag a write-back has to return in `If-Match`, and the source fields this app does not model — without it those are lost on the first edit here. Answered and NOT filterable — see the note on `metadata`.
+     * @param {string} sourceSyncedAt - When this row was last confirmed against its source. A delta run asks for changes since it, and an operator reads it to see that a feed has gone quiet. An edit made here does not touch it: it records when the SOURCE was last seen, not when the row changed.
+     * @param {string} storageAssetId - The stable identity of the stored file, as the platform's storage service issued it. Required while `source` is 'storage' and null otherwise. It is the IDENTITY, not an address: it survives a move or a rename, which `delivery_path` does not, and it is what POST /documents/documents/{id}/link signs. The file is uploaded by whoever ISSUES the document — this app stores no bytes and has no upload route.
+     * @param {number} totalAmount - The gross amount printed on the document, in `currency`. A COPY of what the document says, kept so a list can show it without fetching the file — it is not recomputed here and never corrects the document. Nullable: a delivery note carries no amount.
+     * @param {DocumentVisibility} visibility - Who may read this document. 'customer' — the buyer may, which is what an account area shows and the column's default, because a document a finance system issues to a customer is the normal case. 'internal' — the merchant's side only: a margin sheet, a supplier confirmation, a credit note still being argued about. A storefront caller is confined to 'customer' IN THE QUERY, so an internal document is absent from its list, absent from its page total and answered 404 at its own address. This is the one value in this app that, set wrongly, shows a buyer another buyer's invoice. Defaults to 'customer'.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Document>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    documentsDocumentsCreate(entityId: string, entityType: string, filename: string, kind: string, byteSize?: number, contentType?: string, currency?: string, deliveryPath?: string, dueDate?: string, externalId?: string, externalRefs?: object, externalUrl?: string, issuedAt?: string, metadata?: object, number?: string, source?: DocumentSource, sourceData?: object, sourceSyncedAt?: string, storageAssetId?: string, totalAmount?: number, visibility?: DocumentVisibility): Promise<Models.Document>;
+    /**
+     * A document is one record a merchant issued and filed against a transaction — an invoice, a delivery note, a credit note, a return receipt. The row is the REGISTER entry: it says which transaction the document belongs to, what kind of record it is, the number a customer quotes, who may read it and where its bytes live. It never holds the bytes, and this app never produces a document. Deleting the register entry does NOT delete the file: the bytes live in the platform's asset storage or on the tenant's own host, and this app has never held them. So this is "stop offering this document", not "destroy it" — and there is no undo here, because the row carried the only record of which transaction the file belonged to. A feed that still knows the document will re-file it on its next run, under the same `external_id`.
+     *
+     * @param {string} params.id - The document to remove.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    documentsDocumentsDelete(params: {
+        id: string;
+    }): Promise<{}>;
+    /**
+     * A document is one record a merchant issued and filed against a transaction — an invoice, a delivery note, a credit note, a return receipt. The row is the REGISTER entry: it says which transaction the document belongs to, what kind of record it is, the number a customer quotes, who may read it and where its bytes live. It never holds the bytes, and this app never produces a document. Deleting the register entry does NOT delete the file: the bytes live in the platform's asset storage or on the tenant's own host, and this app has never held them. So this is "stop offering this document", not "destroy it" — and there is no undo here, because the row carried the only record of which transaction the file belonged to. A feed that still knows the document will re-file it on its next run, under the same `external_id`.
+     *
+     * @param {string} id - The document to remove.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    documentsDocumentsDelete(id: string): Promise<{}>;
+    /**
+     * A document is one record a merchant issued and filed against a transaction — an invoice, a delivery note, a credit note, a return receipt. The row is the REGISTER entry: it says which transaction the document belongs to, what kind of record it is, the number a customer quotes, who may read it and where its bytes live. It never holds the bytes, and this app never produces a document. This is the route that turns an id back into a document, and the one place the visibility promise is easiest to get wrong: an `internal` document answers 404 to a storefront caller rather than 403, because a refusal that admitted the document exists would confirm what a guessed address was fishing for. An operator reads the same row at the same address.
+     *
+     * @param {string} params.id - The document to read.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Document>}
+     */
+    documentsDocumentsGet(params: {
+        id: string;
+    }): Promise<Models.Document>;
+    /**
+     * A document is one record a merchant issued and filed against a transaction — an invoice, a delivery note, a credit note, a return receipt. The row is the REGISTER entry: it says which transaction the document belongs to, what kind of record it is, the number a customer quotes, who may read it and where its bytes live. It never holds the bytes, and this app never produces a document. This is the route that turns an id back into a document, and the one place the visibility promise is easiest to get wrong: an `internal` document answers 404 to a storefront caller rather than 403, because a refusal that admitted the document exists would confirm what a guessed address was fishing for. An operator reads the same row at the same address.
+     *
+     * @param {string} id - The document to read.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Document>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    documentsDocumentsGet(id: string): Promise<Models.Document>;
+    /**
+     * A document is one record a merchant issued and filed against a transaction — an invoice, a delivery note, a credit note, a return receipt. The row is the REGISTER entry: it says which transaction the document belongs to, what kind of record it is, the number a customer quotes, who may read it and where its bytes live. It never holds the bytes, and this app never produces a document. A partial update: omitted fields keep their value, and a body carrying no field at all is refused rather than answered as a no-op. The provenance columns are the ones to leave alone — `source_data` holds the ETag a write-back to the issuing system has to return, and an edit here does not touch it, so what the source said survives being re-filed as internal. The same guards as the create apply to `entity_type`, `kind` and the byte binding, and an internal document is a 404 to a storefront caller here too.
+     *
+     * @param {string} params.id - The document to edit.
+     * @param {number} params.byteSize - How large the file is, in bytes — what a download link shows next to it. Nullable, and never computed here: this app does not read the bytes.
+     * @param {string} params.contentType - The media type of the file, so a client knows whether to open it or hand it to the browser. Nullable, because a feed does not always say.
+     * @param {string} params.currency - The ISO 4217 code the amount is in. Nullable exactly where the amount is, and carried per document rather than per tenant because a merchant selling across markets issues in more than one.
+     * @param {string} params.deliveryPath - Where the stored file is served from today — a CDN path, and a CACHE of an address rather than an authorisation. Do NOT fetch a document with it: a path is not a permission, so it answers a private asset with 403, and it is stale the moment the file moves. POST /documents/documents/{id}/link is the way to get the bytes; this column is kept for an operator tracing an object through the delivery plane. Null for an external document.
+     * @param {string} params.dueDate - When the amount on this document is due. Only some kinds carry one — an invoice does, a delivery note does not — so it is nullable, and nothing in this app dunns on it.
+     * @param {string} params.entityId - WHICH transaction this document belongs to — the id of the order, as the orders app knows it. Nothing here checks that the transaction exists: it lives in another app, and a register that called it on every write would fail a whole feed for one deleted order. Together with `entity_type` this is the filter an account area reads a buyer's papers with.
+     * @param {string} params.entityType - WHAT KIND of transaction this document belongs to. `order` is the only value this app accepts today, and a write naming anything else is refused with a message listing what is accepted. The column carries no database constraint on purpose: a return receipt hangs off a return, a contract off an organization and a certificate off a product, so the next kind of owner is a release of this app rather than a migration.
+     * @param {string} params.externalId - The key this document has in the system that ISSUED it — a finance system, a warehouse. Unique per tenant, and the key this register recognises a feed's own rows by: a write carrying one this tenant already holds UPDATES that document and answers 200 instead of filing a second copy. The document number is deliberately NOT that key, because a merchant may renumber and one number may cover an invoice and its delivery note.
+     * @param {object} params.externalRefs - Every OTHER system that knows this row, keyed by system name. `external_id` is the leading system; this is the rest, and a new one costs no column. Answered and NOT filterable — see the note on `metadata`.
+     * @param {string} params.externalUrl - The address of a file this platform does not hold. Required while `source` is 'external' and null otherwise. It is the tenant's own host — a document archive, a finance system's portal — and this app stores the address without fetching it.
+     * @param {string} params.filename - What the file is called — the name a person is offered when they download it, and the only thing the register has to show them. Required, at least one character: a row that names no file is an offer of a download nobody can complete.
+     * @param {string} params.issuedAt - The date ON the document — when the merchant issued it, not when this row was written. It is the date a buyer sorts their invoices by and the one that appears in a tax return, which is why it is a date and not a timestamp: a document is issued on a day.
+     * @param {string} params.kind - What kind of record this is, as a code from GET /documents/kinds — `invoice`, `delivery_note`, `credit_note`, `return_receipt` on a fresh install, plus whatever the merchant added. The check is a membership test against the tenant's own table and NOT a database constraint, because a merchant adds a proforma invoice or a dunning letter without a release of this app. A code the tenant does not keep is refused with 400 and the list of the ones they do.
+     * @param {object} params.metadata - Free-form data the tenant keeps on the row. No route in this app reads it; it is stored and handed back unchanged. It is answered and is NOT a query parameter: a jsonb column is compared as a WHOLE document, so `?metadata=erp` is refused with 400 `invalid_value` rather than answered with an empty page, and a selector whose every plausible use fails is worse than none.
+     * @param {string} params.number - The number printed on the document — what a customer quotes when they call about it, and what a service desk searches for. The DOCUMENT's own number, not the order's: an invoice and its credit note carry different ones. Nullable, because a delivery note is not always numbered, and NOT unique: a merchant who issues an invoice and its delivery note under one number is ordinary practice, and the source key is what identifies a row instead.
+     * @param {DocumentSource} params.source - WHERE the bytes are, and which of the two address columns is filled. 'storage' — an asset this platform holds, addressed by `storage_asset_id`, and the only case POST /documents/documents/{id}/link can hand over: the bucket is private, so the link is a signed, short-lived URL. 'external' — a file on a host the tenant runs, addressed by `external_url`, which this app neither fetches nor signs. The database pairs them: `(source = 'storage' AND storage_asset_id IS NOT NULL) OR (source = 'external' AND external_url IS NOT NULL)`, the same CHECK the product assets carry, so neither pairing can be half-filled. It is a discriminator rather than a preference. Defaults to 'storage'.
+     * @param {object} params.sourceData - What the source said about this row, kept as it said it. Carries the ETag a write-back has to return in `If-Match`, and the source fields this app does not model — without it those are lost on the first edit here. Answered and NOT filterable — see the note on `metadata`.
+     * @param {string} params.sourceSyncedAt - When this row was last confirmed against its source. A delta run asks for changes since it, and an operator reads it to see that a feed has gone quiet. An edit made here does not touch it: it records when the SOURCE was last seen, not when the row changed.
+     * @param {string} params.storageAssetId - The stable identity of the stored file, as the platform's storage service issued it. Required while `source` is 'storage' and null otherwise. It is the IDENTITY, not an address: it survives a move or a rename, which `delivery_path` does not, and it is what POST /documents/documents/{id}/link signs. The file is uploaded by whoever ISSUES the document — this app stores no bytes and has no upload route.
+     * @param {number} params.totalAmount - The gross amount printed on the document, in `currency`. A COPY of what the document says, kept so a list can show it without fetching the file — it is not recomputed here and never corrects the document. Nullable: a delivery note carries no amount.
+     * @param {DocumentVisibility} params.visibility - Who may read this document. 'customer' — the buyer may, which is what an account area shows and the column's default, because a document a finance system issues to a customer is the normal case. 'internal' — the merchant's side only: a margin sheet, a supplier confirmation, a credit note still being argued about. A storefront caller is confined to 'customer' IN THE QUERY, so an internal document is absent from its list, absent from its page total and answered 404 at its own address. This is the one value in this app that, set wrongly, shows a buyer another buyer's invoice. Defaults to 'customer'.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Document>}
+     */
+    documentsDocumentsUpdate(params: {
+        id: string;
+        byteSize?: number;
+        contentType?: string;
+        currency?: string;
+        deliveryPath?: string;
+        dueDate?: string;
+        entityId?: string;
+        entityType?: string;
+        externalId?: string;
+        externalRefs?: object;
+        externalUrl?: string;
+        filename?: string;
+        issuedAt?: string;
+        kind?: string;
+        metadata?: object;
+        number?: string;
+        source?: DocumentSource;
+        sourceData?: object;
+        sourceSyncedAt?: string;
+        storageAssetId?: string;
+        totalAmount?: number;
+        visibility?: DocumentVisibility;
+    }): Promise<Models.Document>;
+    /**
+     * A document is one record a merchant issued and filed against a transaction — an invoice, a delivery note, a credit note, a return receipt. The row is the REGISTER entry: it says which transaction the document belongs to, what kind of record it is, the number a customer quotes, who may read it and where its bytes live. It never holds the bytes, and this app never produces a document. A partial update: omitted fields keep their value, and a body carrying no field at all is refused rather than answered as a no-op. The provenance columns are the ones to leave alone — `source_data` holds the ETag a write-back to the issuing system has to return, and an edit here does not touch it, so what the source said survives being re-filed as internal. The same guards as the create apply to `entity_type`, `kind` and the byte binding, and an internal document is a 404 to a storefront caller here too.
+     *
+     * @param {string} id - The document to edit.
+     * @param {number} byteSize - How large the file is, in bytes — what a download link shows next to it. Nullable, and never computed here: this app does not read the bytes.
+     * @param {string} contentType - The media type of the file, so a client knows whether to open it or hand it to the browser. Nullable, because a feed does not always say.
+     * @param {string} currency - The ISO 4217 code the amount is in. Nullable exactly where the amount is, and carried per document rather than per tenant because a merchant selling across markets issues in more than one.
+     * @param {string} deliveryPath - Where the stored file is served from today — a CDN path, and a CACHE of an address rather than an authorisation. Do NOT fetch a document with it: a path is not a permission, so it answers a private asset with 403, and it is stale the moment the file moves. POST /documents/documents/{id}/link is the way to get the bytes; this column is kept for an operator tracing an object through the delivery plane. Null for an external document.
+     * @param {string} dueDate - When the amount on this document is due. Only some kinds carry one — an invoice does, a delivery note does not — so it is nullable, and nothing in this app dunns on it.
+     * @param {string} entityId - WHICH transaction this document belongs to — the id of the order, as the orders app knows it. Nothing here checks that the transaction exists: it lives in another app, and a register that called it on every write would fail a whole feed for one deleted order. Together with `entity_type` this is the filter an account area reads a buyer's papers with.
+     * @param {string} entityType - WHAT KIND of transaction this document belongs to. `order` is the only value this app accepts today, and a write naming anything else is refused with a message listing what is accepted. The column carries no database constraint on purpose: a return receipt hangs off a return, a contract off an organization and a certificate off a product, so the next kind of owner is a release of this app rather than a migration.
+     * @param {string} externalId - The key this document has in the system that ISSUED it — a finance system, a warehouse. Unique per tenant, and the key this register recognises a feed's own rows by: a write carrying one this tenant already holds UPDATES that document and answers 200 instead of filing a second copy. The document number is deliberately NOT that key, because a merchant may renumber and one number may cover an invoice and its delivery note.
+     * @param {object} externalRefs - Every OTHER system that knows this row, keyed by system name. `external_id` is the leading system; this is the rest, and a new one costs no column. Answered and NOT filterable — see the note on `metadata`.
+     * @param {string} externalUrl - The address of a file this platform does not hold. Required while `source` is 'external' and null otherwise. It is the tenant's own host — a document archive, a finance system's portal — and this app stores the address without fetching it.
+     * @param {string} filename - What the file is called — the name a person is offered when they download it, and the only thing the register has to show them. Required, at least one character: a row that names no file is an offer of a download nobody can complete.
+     * @param {string} issuedAt - The date ON the document — when the merchant issued it, not when this row was written. It is the date a buyer sorts their invoices by and the one that appears in a tax return, which is why it is a date and not a timestamp: a document is issued on a day.
+     * @param {string} kind - What kind of record this is, as a code from GET /documents/kinds — `invoice`, `delivery_note`, `credit_note`, `return_receipt` on a fresh install, plus whatever the merchant added. The check is a membership test against the tenant's own table and NOT a database constraint, because a merchant adds a proforma invoice or a dunning letter without a release of this app. A code the tenant does not keep is refused with 400 and the list of the ones they do.
+     * @param {object} metadata - Free-form data the tenant keeps on the row. No route in this app reads it; it is stored and handed back unchanged. It is answered and is NOT a query parameter: a jsonb column is compared as a WHOLE document, so `?metadata=erp` is refused with 400 `invalid_value` rather than answered with an empty page, and a selector whose every plausible use fails is worse than none.
+     * @param {string} number - The number printed on the document — what a customer quotes when they call about it, and what a service desk searches for. The DOCUMENT's own number, not the order's: an invoice and its credit note carry different ones. Nullable, because a delivery note is not always numbered, and NOT unique: a merchant who issues an invoice and its delivery note under one number is ordinary practice, and the source key is what identifies a row instead.
+     * @param {DocumentSource} source - WHERE the bytes are, and which of the two address columns is filled. 'storage' — an asset this platform holds, addressed by `storage_asset_id`, and the only case POST /documents/documents/{id}/link can hand over: the bucket is private, so the link is a signed, short-lived URL. 'external' — a file on a host the tenant runs, addressed by `external_url`, which this app neither fetches nor signs. The database pairs them: `(source = 'storage' AND storage_asset_id IS NOT NULL) OR (source = 'external' AND external_url IS NOT NULL)`, the same CHECK the product assets carry, so neither pairing can be half-filled. It is a discriminator rather than a preference. Defaults to 'storage'.
+     * @param {object} sourceData - What the source said about this row, kept as it said it. Carries the ETag a write-back has to return in `If-Match`, and the source fields this app does not model — without it those are lost on the first edit here. Answered and NOT filterable — see the note on `metadata`.
+     * @param {string} sourceSyncedAt - When this row was last confirmed against its source. A delta run asks for changes since it, and an operator reads it to see that a feed has gone quiet. An edit made here does not touch it: it records when the SOURCE was last seen, not when the row changed.
+     * @param {string} storageAssetId - The stable identity of the stored file, as the platform's storage service issued it. Required while `source` is 'storage' and null otherwise. It is the IDENTITY, not an address: it survives a move or a rename, which `delivery_path` does not, and it is what POST /documents/documents/{id}/link signs. The file is uploaded by whoever ISSUES the document — this app stores no bytes and has no upload route.
+     * @param {number} totalAmount - The gross amount printed on the document, in `currency`. A COPY of what the document says, kept so a list can show it without fetching the file — it is not recomputed here and never corrects the document. Nullable: a delivery note carries no amount.
+     * @param {DocumentVisibility} visibility - Who may read this document. 'customer' — the buyer may, which is what an account area shows and the column's default, because a document a finance system issues to a customer is the normal case. 'internal' — the merchant's side only: a margin sheet, a supplier confirmation, a credit note still being argued about. A storefront caller is confined to 'customer' IN THE QUERY, so an internal document is absent from its list, absent from its page total and answered 404 at its own address. This is the one value in this app that, set wrongly, shows a buyer another buyer's invoice. Defaults to 'customer'.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Document>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    documentsDocumentsUpdate(id: string, byteSize?: number, contentType?: string, currency?: string, deliveryPath?: string, dueDate?: string, entityId?: string, entityType?: string, externalId?: string, externalRefs?: object, externalUrl?: string, filename?: string, issuedAt?: string, kind?: string, metadata?: object, number?: string, source?: DocumentSource, sourceData?: object, sourceSyncedAt?: string, storageAssetId?: string, totalAmount?: number, visibility?: DocumentVisibility): Promise<Models.Document>;
+    /**
+     * A document is one record a merchant issued and filed against a transaction — an invoice, a delivery note, a credit note, a return receipt. The row is the REGISTER entry: it says which transaction the document belongs to, what kind of record it is, the number a customer quotes, who may read it and where its bytes live. It never holds the bytes, and this app never produces a document. This is how the bytes are handed over, and the ONLY way: the storage bucket is private, so the answer is a signed URL valid for minutes, which the caller then fetches directly. Nothing streams through this app — a 40 MB invoice through a function with a 15-second timeout is a bad trade, and the signature is the authorisation, so proxying it would add a second copy of a check that is already in the URL. There is no upload route for the same reason in reverse: whoever ISSUES the document uploads it to POST /v1/storage/assets itself, takes the `ast_…` id back and records it here. It is a POST because each call mints a new signature with a new expiry, so the answer must not be cached. ⚠ The AUDIENCE RULE applies here exactly as it does at the document's own address: a storefront caller asking for a link to an `internal` document is answered 404 — not 403 — because a link is the one thing that would turn a guessed id into another buyer's invoice. An `external` document has no asset of ours to sign and is refused with its `external_url` instead.
+     *
+     * @param {string} params.id - The document to mint a link for.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.DocumentLink>}
+     */
+    documentsDocumentsLink(params: {
+        id: string;
+    }): Promise<Models.DocumentLink>;
+    /**
+     * A document is one record a merchant issued and filed against a transaction — an invoice, a delivery note, a credit note, a return receipt. The row is the REGISTER entry: it says which transaction the document belongs to, what kind of record it is, the number a customer quotes, who may read it and where its bytes live. It never holds the bytes, and this app never produces a document. This is how the bytes are handed over, and the ONLY way: the storage bucket is private, so the answer is a signed URL valid for minutes, which the caller then fetches directly. Nothing streams through this app — a 40 MB invoice through a function with a 15-second timeout is a bad trade, and the signature is the authorisation, so proxying it would add a second copy of a check that is already in the URL. There is no upload route for the same reason in reverse: whoever ISSUES the document uploads it to POST /v1/storage/assets itself, takes the `ast_…` id back and records it here. It is a POST because each call mints a new signature with a new expiry, so the answer must not be cached. ⚠ The AUDIENCE RULE applies here exactly as it does at the document's own address: a storefront caller asking for a link to an `internal` document is answered 404 — not 403 — because a link is the one thing that would turn a guessed id into another buyer's invoice. An `external` document has no asset of ours to sign and is refused with its `external_url` instead.
+     *
+     * @param {string} id - The document to mint a link for.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.DocumentLink>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    documentsDocumentsLink(id: string): Promise<Models.DocumentLink>;
+}
+
+export { DocumentsRegister };