@revenexx/node 0.0.2 → 0.1.1

package/dist/services/storage.d.mts

@@ -1,32 +1,203 @@
 import { Client, UploadProgress } from '../client.mjs';
 import { Visibility } from '../enums/visibility.mjs';
 import '../models.mjs';
-import '../enums/address-type.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/attribute-value-bucket.mjs';
+import '../enums/auth-mail-source.mjs';
+import '../enums/recovery-mail-source.mjs';
+import '../enums/registration-status.mjs';
+import '../enums/budget-change-reason.mjs';
+import '../enums/budget-movement-result-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-type.mjs';
-import '../enums/contact-role.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/contact-registration-status.mjs';
 import '../enums/contact-status.mjs';
+import '../enums/contact-activity-kind.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-update-request-registration-status.mjs';
+import '../enums/cost-center-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/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-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/cart-io-format.mjs';
+import '../enums/io-profile-resource-apply-mode.mjs';
+import '../enums/io-profile-resource-direction.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/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-item-type.mjs';
-import '../enums/order-list-kind.mjs';
-import '../enums/order-payment-status.mjs';
+import '../enums/order-list-kind-tone.mjs';
+import '../enums/order-list-kind-row-tone.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-status.mjs';
+import '../enums/order-return-settlement.mjs';
+import '../enums/order-return-refusal.mjs';
+import '../enums/order-vocabulary-tone.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-status.mjs';
 import '../enums/page-status.mjs';
-import '../enums/payment-fee-type.mjs';
-import '../enums/payment-method-kind.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-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/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/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/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/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/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/validation-failed-response-status.mjs';
+import '../enums/vocabulary-default-tone.mjs';
+import '../enums/vocabulary-source.mjs';
+import '../enums/vocabulary-tone.mjs';
 import '../enums/attribute-boolean-status.mjs';
 import '../enums/attribute-datetime-status.mjs';
 import '../enums/attribute-email-status.mjs';
@@ -68,32 +239,65 @@ 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-status.mjs';
+import '../enums/message-2-status.mjs';
 import '../query.mjs';
 
 declare class Storage {
     client: Client;
     constructor(client: Client);
     /**
+     * List the media assets in this tenant, newest first. Narrow the list with
+     * `filter[folder_id]`, `filter[kind]`, `filter[status]` and a
+     * `filter[created_at][gte]`/`[lte]` range; search original names, display
+     * names, alt text and descriptions with `search`; order by `created_at`,
+     * `size_bytes` or `original_name` (prefix with `-` to reverse). One page is
+     * returned, 50 records by default and 200 at most.
+     *
+     * Records only: no file content is returned — fetch bytes with
+     * `GET /assets/{id}/download` or hand out a link with
+     * `POST /assets/{id}/sign`. Deleted assets are not listed.
      *
      * @param {string} params.search -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     assetIndex(params?: {
         search?: string;
     }): Promise<{}>;
     /**
+     * List the media assets in this tenant, newest first. Narrow the list with
+     * `filter[folder_id]`, `filter[kind]`, `filter[status]` and a
+     * `filter[created_at][gte]`/`[lte]` range; search original names, display
+     * names, alt text and descriptions with `search`; order by `created_at`,
+     * `size_bytes` or `original_name` (prefix with `-` to reverse). One page is
+     * returned, 50 records by default and 200 at most.
+     *
+     * Records only: no file content is returned — fetch bytes with
+     * `GET /assets/{id}/download` or hand out a link with
+     * `POST /assets/{id}/sign`. Deleted assets are not listed.
      *
      * @param {string} search -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     assetIndex(search?: string): Promise<{}>;
     /**
+     * Upload one file into this tenant's media library. The file is checked
+     * against the tenant's single-file limit and its remaining storage quota,
+     * its media type is sniffed from the content rather than trusted from the
+     * request, and it is virus-scanned before anything is written. The stored
+     * asset comes back with status `pending_processing`; metadata extraction
+     * finishes asynchronously and moves it to `available`. `folder_id`,
+     * `visibility`, `alt_text`, `description`, `display_name` and `tags` are
+     * applied on the way in; set `unpack` to also queue an uploaded archive's
+     * members for ingestion.
+     *
+     * Every call creates a new asset — this never replaces the content of an
+     * existing one — and it takes exactly one file. Use `POST /assets/bulk` for
+     * several.
      *
-     * @param {string} params.file -
+     * @param {File} params.file -
      * @param {string} params.altText -
      * @param {string} params.description -
      * @param {string} params.displayName -
@@ -102,11 +306,11 @@ declare class Storage {
      * @param {string[]} params.tags -
      * @param {boolean} params.unpack - Archives only: unpack the members after upload (see AssetController).
      * @param {Visibility} params.visibility -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     assetStore(params: {
-        file: string;
+        file: File;
         altText?: string;
         description?: string;
         displayName?: string;
@@ -118,8 +322,21 @@ declare class Storage {
         onProgress?: (progress: UploadProgress) => void;
     }): Promise<{}>;
     /**
+     * Upload one file into this tenant's media library. The file is checked
+     * against the tenant's single-file limit and its remaining storage quota,
+     * its media type is sniffed from the content rather than trusted from the
+     * request, and it is virus-scanned before anything is written. The stored
+     * asset comes back with status `pending_processing`; metadata extraction
+     * finishes asynchronously and moves it to `available`. `folder_id`,
+     * `visibility`, `alt_text`, `description`, `display_name` and `tags` are
+     * applied on the way in; set `unpack` to also queue an uploaded archive's
+     * members for ingestion.
      *
-     * @param {string} file -
+     * Every call creates a new asset — this never replaces the content of an
+     * existing one — and it takes exactly one file. Use `POST /assets/bulk` for
+     * several.
+     *
+     * @param {File} file -
      * @param {string} altText -
      * @param {string} description -
      * @param {string} displayName -
@@ -128,16 +345,27 @@ declare class Storage {
      * @param {string[]} tags -
      * @param {boolean} unpack - Archives only: unpack the members after upload (see AssetController).
      * @param {Visibility} visibility -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    assetStore(file: string, altText?: string, description?: string, displayName?: string, folderId?: string, keepArchive?: boolean, tags?: string[], unpack?: boolean, visibility?: Visibility, onProgress?: (progress: UploadProgress) => void): Promise<{}>;
+    assetStore(file: File, altText?: string, description?: string, displayName?: string, folderId?: string, keepArchive?: boolean, tags?: string[], unpack?: boolean, visibility?: Visibility, onProgress?: (progress: UploadProgress) => void): Promise<{}>;
     /**
+     * Upload a batch of files in one request under `files`, each ingested
+     * exactly as `POST /assets` ingests a single file. The batch is rejected as
+     * a whole when it carries no files, more files than one request may carry,
+     * or too many bytes in total. Past that point every file is attempted
+     * independently and the call answers 207 with a `results` entry per file:
+     * either the created asset or the error that rejected it. A partial failure
+     * is therefore a successful call, not an error status — read `results`.
+     *
+     * Only `folder_id` and `visibility` apply, and they apply to the whole
+     * batch; per-file metadata is not accepted here. Set it afterwards with
+     * `PATCH /assets/{id}`.
      *
      * @param {string} params.folderId -
      * @param {string} params.visibility -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     assetBulk(params?: {
@@ -145,49 +373,94 @@ declare class Storage {
         visibility?: string;
     }): Promise<{}>;
     /**
+     * Upload a batch of files in one request under `files`, each ingested
+     * exactly as `POST /assets` ingests a single file. The batch is rejected as
+     * a whole when it carries no files, more files than one request may carry,
+     * or too many bytes in total. Past that point every file is attempted
+     * independently and the call answers 207 with a `results` entry per file:
+     * either the created asset or the error that rejected it. A partial failure
+     * is therefore a successful call, not an error status — read `results`.
+     *
+     * Only `folder_id` and `visibility` apply, and they apply to the whole
+     * batch; per-file metadata is not accepted here. Set it afterwards with
+     * `PATCH /assets/{id}`.
      *
      * @param {string} folderId -
      * @param {string} visibility -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     assetBulk(folderId?: string, visibility?: string): Promise<{}>;
     /**
+     * Soft-delete an asset: it stops being listed and served, its status
+     * becomes `soft_deleted`, and it is scheduled for permanent deletion once
+     * the retention window has passed. Until then `POST /assets/{id}/restore`
+     * brings it back.
+     *
+     * The stored file is not erased at this point and its bytes still count
+     * against the tenant's storage quota — use `DELETE /assets/{id}/permanent`
+     * to erase it and free the quota immediately.
      *
      * @param {string} params.id -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     assetDestroy(params: {
         id: string;
     }): Promise<{}>;
     /**
+     * Soft-delete an asset: it stops being listed and served, its status
+     * becomes `soft_deleted`, and it is scheduled for permanent deletion once
+     * the retention window has passed. Until then `POST /assets/{id}/restore`
+     * brings it back.
+     *
+     * The stored file is not erased at this point and its bytes still count
+     * against the tenant's storage quota — use `DELETE /assets/{id}/permanent`
+     * to erase it and free the quota immediately.
      *
      * @param {string} id -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     assetDestroy(id: string): Promise<{}>;
     /**
+     * Fetch one asset's record by id: name, folder, media type, size, status,
+     * tags, the extracted metadata and the delivery URL (null for a private
+     * asset, which is reachable only through a signed URL). Metadata only — the
+     * bytes are served by `GET /assets/{id}/download`. A deleted asset is not
+     * visible here until `POST /assets/{id}/restore` brings it back.
      *
      * @param {string} params.id -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     assetShow(params: {
         id: string;
     }): Promise<{}>;
     /**
+     * Fetch one asset's record by id: name, folder, media type, size, status,
+     * tags, the extracted metadata and the delivery URL (null for a private
+     * asset, which is reachable only through a signed URL). Metadata only — the
+     * bytes are served by `GET /assets/{id}/download`. A deleted asset is not
+     * visible here until `POST /assets/{id}/restore` brings it back.
      *
      * @param {string} id -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     assetShow(id: string): Promise<{}>;
     /**
+     * Change an asset's metadata: `display_name`, `alt_text`, `description`,
+     * `visibility` and `tags`. Sending `folder_id` moves it and sending `name`
+     * renames it; either re-derives the asset's public delivery path, so links
+     * built from the old path stop resolving. Only the fields present in the
+     * request are touched.
+     *
+     * The stored file itself is never modified here — to change the content,
+     * upload a new asset.
      *
      * @param {string} params.id -
      * @param {string} params.altText -
@@ -197,7 +470,7 @@ declare class Storage {
      * @param {string} params.name -
      * @param {string[]} params.tags -
      * @param {Visibility} params.visibility -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     assetUpdate(params: {
@@ -211,6 +484,14 @@ declare class Storage {
         visibility?: Visibility;
     }): Promise<{}>;
     /**
+     * Change an asset's metadata: `display_name`, `alt_text`, `description`,
+     * `visibility` and `tags`. Sending `folder_id` moves it and sending `name`
+     * renames it; either re-derives the asset's public delivery path, so links
+     * built from the old path stop resolving. Only the fields present in the
+     * request are touched.
+     *
+     * The stored file itself is never modified here — to change the content,
+     * upload a new asset.
      *
      * @param {string} id -
      * @param {string} altText -
@@ -220,84 +501,149 @@ declare class Storage {
      * @param {string} name -
      * @param {string[]} tags -
      * @param {Visibility} visibility -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     assetUpdate(id: string, altText?: string, description?: string, displayName?: string, folderId?: string, name?: string, tags?: string[], visibility?: Visibility): Promise<{}>;
     /**
+     * Stream the asset's original file back as an attachment, named after the
+     * asset. This is the authenticated read path — every call carries the
+     * caller's credentials — and the bytes are the ones that were uploaded: no
+     * resizing, re-encoding or other transformation is applied.
+     *
+     * To let a browser, an email or a third party fetch the file without an API
+     * credential, mint a link with `POST /assets/{id}/sign` instead.
      *
      * @param {string} params.id -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     assetDownload(params: {
         id: string;
     }): Promise<{}>;
     /**
+     * Stream the asset's original file back as an attachment, named after the
+     * asset. This is the authenticated read path — every call carries the
+     * caller's credentials — and the bytes are the ones that were uploaded: no
+     * resizing, re-encoding or other transformation is applied.
+     *
+     * To let a browser, an email or a third party fetch the file without an API
+     * credential, mint a link with `POST /assets/{id}/sign` instead.
      *
      * @param {string} id -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     assetDownload(id: string): Promise<{}>;
     /**
+     * Erase an asset and its stored file for good and credit its bytes back to
+     * the tenant's used storage. Works on live and soft-deleted assets alike.
+     *
+     * This cannot be undone: there is no restore afterwards, and links to the
+     * asset stop resolving at once. Use `DELETE /assets/{id}` for the
+     * reversible variant. Requires the elevated (admin) tier.
      *
      * @param {string} params.id -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     assetPermanent(params: {
         id: string;
     }): Promise<{}>;
     /**
+     * Erase an asset and its stored file for good and credit its bytes back to
+     * the tenant's used storage. Works on live and soft-deleted assets alike.
+     *
+     * This cannot be undone: there is no restore afterwards, and links to the
+     * asset stop resolving at once. Use `DELETE /assets/{id}` for the
+     * reversible variant. Requires the elevated (admin) tier.
      *
      * @param {string} id -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     assetPermanent(id: string): Promise<{}>;
     /**
+     * Re-run post-upload processing for one asset. It returns to
+     * `pending_processing` and the job re-extracts its metadata — and, for a 3D
+     * model, re-renders the preview and mesh derivatives — before marking it
+     * `available` again. The usual reason is an asset stuck in
+     * `processing_failed`.
+     *
+     * The stored file is neither re-uploaded nor altered, and no thumbnails are
+     * produced: delivery transforms are applied on the fly when the asset is
+     * served, not here.
      *
      * @param {string} params.id -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     assetReprocess(params: {
         id: string;
     }): Promise<{}>;
     /**
+     * Re-run post-upload processing for one asset. It returns to
+     * `pending_processing` and the job re-extracts its metadata — and, for a 3D
+     * model, re-renders the preview and mesh derivatives — before marking it
+     * `available` again. The usual reason is an asset stuck in
+     * `processing_failed`.
+     *
+     * The stored file is neither re-uploaded nor altered, and no thumbnails are
+     * produced: delivery transforms are applied on the fly when the asset is
+     * served, not here.
      *
      * @param {string} id -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     assetReprocess(id: string): Promise<{}>;
     /**
+     * Bring a soft-deleted asset back: the scheduled permanent deletion is
+     * cleared and the asset returns to `available`, listed and served again
+     * under its original path. Only works while the asset is still inside its
+     * retention window — once it has been erased, by
+     * `DELETE /assets/{id}/permanent` or by the retention sweep, there is
+     * nothing left to restore.
      *
      * @param {string} params.id -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     assetRestore(params: {
         id: string;
     }): Promise<{}>;
     /**
+     * Bring a soft-deleted asset back: the scheduled permanent deletion is
+     * cleared and the asset returns to `available`, listed and served again
+     * under its original path. Only works while the asset is still inside its
+     * retention window — once it has been erased, by
+     * `DELETE /assets/{id}/permanent` or by the retention sweep, there is
+     * nothing left to restore.
      *
      * @param {string} id -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     assetRestore(id: string): Promise<{}>;
     /**
+     * Mint a time-limited URL that serves this asset without an API credential
+     * — the way to hand a private asset to a browser, an email or a third
+     * party. `ttl_seconds` sets the lifetime: one hour by default, seven days
+     * at most. The response carries the URL and the lifetime it was issued
+     * with.
+     *
+     * The signature is checked at the delivery edge. A link cannot be revoked
+     * before it expires, so keep the lifetime short. A public asset already
+     * carries an unsigned delivery URL on its record and does not need this.
      *
      * @param {string} params.id -
      * @param {number} params.ttlSeconds -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     assetSign(params: {
@@ -305,20 +651,42 @@ declare class Storage {
         ttlSeconds?: number;
     }): Promise<{}>;
     /**
+     * Mint a time-limited URL that serves this asset without an API credential
+     * — the way to hand a private asset to a browser, an email or a third
+     * party. `ttl_seconds` sets the lifetime: one hour by default, seven days
+     * at most. The response carries the URL and the lifetime it was issued
+     * with.
+     *
+     * The signature is checked at the delivery edge. A link cannot be revoked
+     * before it expires, so keep the lifetime short. A public asset already
+     * carries an unsigned delivery URL on its record and does not need this.
      *
      * @param {string} id -
      * @param {number} ttlSeconds -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     assetSign(id: string, ttlSeconds?: number): Promise<{}>;
     /**
+     * Ingest the members of an already-uploaded archive as individual assets.
+     * They land in a folder named after the archive, created under
+     * `target_folder_id` or, when that is omitted, under the archive's own
+     * folder, and the archive's internal directory structure is mirrored
+     * beneath it. Each member goes through the same pipeline as an upload —
+     * media-type sniff, virus scan, quota — and a member that fails is skipped
+     * rather than failing the run. `keep_archive` (true by default) decides
+     * whether the archive asset itself survives.
+     *
+     * Asynchronous: this answers 202 as soon as the work is queued, so poll the
+     * folder or asset list for the results. Only an asset that is an archive of
+     * a supported type can be unpacked; an upload can ask for the same thing
+     * inline with `unpack`.
      *
      * @param {string} params.id -
      * @param {boolean} params.keepArchive -
      * @param {string} params.targetFolderId -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     assetUnpack(params: {
@@ -327,26 +695,53 @@ declare class Storage {
         targetFolderId?: string;
     }): Promise<{}>;
     /**
+     * Ingest the members of an already-uploaded archive as individual assets.
+     * They land in a folder named after the archive, created under
+     * `target_folder_id` or, when that is omitted, under the archive's own
+     * folder, and the archive's internal directory structure is mirrored
+     * beneath it. Each member goes through the same pipeline as an upload —
+     * media-type sniff, virus scan, quota — and a member that fails is skipped
+     * rather than failing the run. `keep_archive` (true by default) decides
+     * whether the archive asset itself survives.
+     *
+     * Asynchronous: this answers 202 as soon as the work is queued, so poll the
+     * folder or asset list for the results. Only an asset that is an archive of
+     * a supported type can be unpacked; an upload can ask for the same thing
+     * inline with `unpack`.
      *
      * @param {string} id -
      * @param {boolean} keepArchive -
      * @param {string} targetFolderId -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     assetUnpack(id: string, keepArchive?: boolean, targetFolderId?: string): Promise<{}>;
     /**
+     * Return every folder in this tenant as one flat list ordered by path, each
+     * record carrying its `parent_id` and its materialized `path`, so a client
+     * can rebuild the tree without walking it. Not paginated and not filtered.
+     *
+     * Folders hold no file content of their own — list a folder's assets with
+     * `GET /assets` and `filter[folder_id]`.
      *
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     folderIndex(): Promise<{}>;
     /**
+     * Create a folder under `parent_id`, or at the library root when it is
+     * omitted. The `name` is slugged into a path segment and appended to the
+     * parent's path; that path is what the public delivery URL of every asset
+     * inside it is built from, so two siblings may not slug to the same
+     * segment.
+     *
+     * Creating a folder moves nothing into it — assign assets with
+     * `folder_id` on upload or with `PATCH /assets/{id}`.
      *
      * @param {string} params.name -
      * @param {string} params.parentId -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     folderStore(params: {
@@ -354,19 +749,35 @@ declare class Storage {
         parentId?: string;
     }): Promise<{}>;
     /**
+     * Create a folder under `parent_id`, or at the library root when it is
+     * omitted. The `name` is slugged into a path segment and appended to the
+     * parent's path; that path is what the public delivery URL of every asset
+     * inside it is built from, so two siblings may not slug to the same
+     * segment.
+     *
+     * Creating a folder moves nothing into it — assign assets with
+     * `folder_id` on upload or with `PATCH /assets/{id}`.
      *
      * @param {string} name -
      * @param {string} parentId -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     folderStore(name: string, parentId?: string): Promise<{}>;
     /**
+     * Delete a folder. By default it has to be empty: a folder that still holds
+     * folders or assets is refused, so pass `recursive=true` to delete it
+     * together with everything beneath it.
+     *
+     * A recursive delete soft-deletes the assets it takes with it — their files
+     * are not erased and their bytes still count against the tenant's storage
+     * quota, and each remains restorable through `POST /assets/{id}/restore`.
+     * System folders cannot be deleted.
      *
      * @param {string} params.id -
      * @param {boolean} params.recursive -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     folderDestroy(params: {
@@ -374,37 +785,67 @@ declare class Storage {
         recursive?: boolean;
     }): Promise<{}>;
     /**
+     * Delete a folder. By default it has to be empty: a folder that still holds
+     * folders or assets is refused, so pass `recursive=true` to delete it
+     * together with everything beneath it.
+     *
+     * A recursive delete soft-deletes the assets it takes with it — their files
+     * are not erased and their bytes still count against the tenant's storage
+     * quota, and each remains restorable through `POST /assets/{id}/restore`.
+     * System folders cannot be deleted.
      *
      * @param {string} id -
      * @param {boolean} recursive -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     folderDestroy(id: string, recursive?: boolean): Promise<{}>;
     /**
+     * Fetch one folder's record by id: its name, its parent, the materialized
+     * path assets inside it are delivered under, and whether it is a system
+     * folder (system folders cannot be renamed, moved or deleted).
+     *
+     * Its contents are not included — list them with `GET /assets` and
+     * `filter[folder_id]`, and its child folders with `GET /folders`.
      *
      * @param {string} params.id -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     folderShow(params: {
         id: string;
     }): Promise<{}>;
     /**
+     * Fetch one folder's record by id: its name, its parent, the materialized
+     * path assets inside it are delivered under, and whether it is a system
+     * folder (system folders cannot be renamed, moved or deleted).
+     *
+     * Its contents are not included — list them with `GET /assets` and
+     * `filter[folder_id]`, and its child folders with `GET /folders`.
      *
      * @param {string} id -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     folderShow(id: string): Promise<{}>;
     /**
+     * Rename a folder with `name`, move it under a different parent with
+     * `parent_id` (null for the root), or both at once. Either rewrites the
+     * folder's materialized path and the path of every folder beneath it, which
+     * changes the public delivery URL of every asset they hold — existing links
+     * built from the old path stop resolving.
+     *
+     * Nothing else about the assets changes; they are not moved, re-uploaded or
+     * reprocessed. A system folder cannot be changed, a folder cannot be moved
+     * inside its own subtree, and the new name has to slug to a segment free
+     * among its new siblings.
      *
      * @param {string} params.id -
      * @param {string} params.name -
      * @param {string} params.parentId -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     folderUpdate(params: {
@@ -413,100 +854,263 @@ declare class Storage {
         parentId?: string;
     }): Promise<{}>;
     /**
+     * Rename a folder with `name`, move it under a different parent with
+     * `parent_id` (null for the root), or both at once. Either rewrites the
+     * folder's materialized path and the path of every folder beneath it, which
+     * changes the public delivery URL of every asset they hold — existing links
+     * built from the old path stop resolving.
+     *
+     * Nothing else about the assets changes; they are not moved, re-uploaded or
+     * reprocessed. A system folder cannot be changed, a folder cannot be moved
+     * inside its own subtree, and the new name has to slug to a segment free
+     * among its new siblings.
      *
      * @param {string} id -
      * @param {string} name -
      * @param {string} parentId -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     folderUpdate(id: string, name?: string, parentId?: string): Promise<{}>;
     /**
+     * Return this tenant's SFTP sync rules, newest first, each with the account
+     * and remote path it pulls from, the folder it imports into, its cron
+     * schedule, whether it is enabled and when it last ran. Not paginated and
+     * not filtered.
+     *
+     * These are the rules themselves, not what they moved: for the files a rule
+     * has actually transferred, see `GET /sftp/sync-history`.
      *
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     syncRuleIndex(): Promise<{}>;
     /**
+     * Schedule a recurring one-way pull from a directory on the tenant's SFTP
+     * storage box into this media library. `sftp_account_id` selects the
+     * account, `source_path` the remote directory, `target_folder_id` the
+     * folder imported assets land in, and `schedule` a cron expression (every
+     * five minutes when omitted) at which the rule falls due. `options` carries
+     * the per-rule knobs: recursion, include/exclude and size filters, how long
+     * a remote file has to have stopped changing before it is taken, and
+     * whether it is deleted from the remote after a successful transfer.
      *
-     * @throws {RevenexxAPIRevenexxException}
+     * Each run ingests every matching remote file exactly as an upload would,
+     * quota, media-type and virus checks included, and records one history
+     * entry per file. Creating the rule transfers nothing: the first run
+     * happens when the schedule next falls due, or immediately if you call
+     * `POST /sftp/rules/{id}/run`. Nothing is ever pushed back to the remote,
+     * beyond the optional delete after a successful transfer. Requires the
+     * elevated (admin) tier.
+     *
+     * @param {string} params.sftpAccountId -
+     * @param {string} params.sourcePath -
+     * @param {boolean} params.enabled -
+     * @param {string[]} params.options -
+     * @param {string} params.schedule -
+     * @param {string} params.targetFolderId -
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
-    syncRuleStore(): Promise<{}>;
+    syncRuleStore(params: {
+        sftpAccountId: string;
+        sourcePath: string;
+        enabled?: boolean;
+        options?: string[];
+        schedule?: string;
+        targetFolderId?: string;
+    }): Promise<{}>;
     /**
+     * Schedule a recurring one-way pull from a directory on the tenant's SFTP
+     * storage box into this media library. `sftp_account_id` selects the
+     * account, `source_path` the remote directory, `target_folder_id` the
+     * folder imported assets land in, and `schedule` a cron expression (every
+     * five minutes when omitted) at which the rule falls due. `options` carries
+     * the per-rule knobs: recursion, include/exclude and size filters, how long
+     * a remote file has to have stopped changing before it is taken, and
+     * whether it is deleted from the remote after a successful transfer.
+     *
+     * Each run ingests every matching remote file exactly as an upload would,
+     * quota, media-type and virus checks included, and records one history
+     * entry per file. Creating the rule transfers nothing: the first run
+     * happens when the schedule next falls due, or immediately if you call
+     * `POST /sftp/rules/{id}/run`. Nothing is ever pushed back to the remote,
+     * beyond the optional delete after a successful transfer. Requires the
+     * elevated (admin) tier.
+     *
+     * @param {string} sftpAccountId -
+     * @param {string} sourcePath -
+     * @param {boolean} enabled -
+     * @param {string[]} options -
+     * @param {string} schedule -
+     * @param {string} targetFolderId -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    syncRuleStore(sftpAccountId: string, sourcePath: string, enabled?: boolean, options?: string[], schedule?: string, targetFolderId?: string): Promise<{}>;
+    /**
+     * Delete a sync rule so it is never scheduled again. The assets it already
+     * imported stay exactly where they are, its recorded run history is kept,
+     * and nothing on the remote is touched.
+     *
+     * To stop a rule only for a while, set `enabled` to false with
+     * `PATCH /sftp/rules/{id}` instead — a deleted rule cannot be restored.
+     * Requires the elevated (admin) tier.
      *
      * @param {string} params.id -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     syncRuleDestroy(params: {
         id: string;
     }): Promise<{}>;
     /**
+     * Delete a sync rule so it is never scheduled again. The assets it already
+     * imported stay exactly where they are, its recorded run history is kept,
+     * and nothing on the remote is touched.
+     *
+     * To stop a rule only for a while, set `enabled` to false with
+     * `PATCH /sftp/rules/{id}` instead — a deleted rule cannot be restored.
+     * Requires the elevated (admin) tier.
      *
      * @param {string} id -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     syncRuleDestroy(id: string): Promise<{}>;
     /**
+     * Fetch one sync rule's configuration by id: the account and remote path it
+     * pulls from, its target folder, its cron schedule, its `options` and
+     * `last_run_at`.
+     *
+     * Configuration only, and `last_run_at` says when a run was last attempted,
+     * not whether it succeeded. What a run did is in
+     * `GET /sftp/rules/{id}/runs/{runId}` and `GET /sftp/sync-history`.
      *
      * @param {string} params.id -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     syncRuleShow(params: {
         id: string;
     }): Promise<{}>;
     /**
+     * Fetch one sync rule's configuration by id: the account and remote path it
+     * pulls from, its target folder, its cron schedule, its `options` and
+     * `last_run_at`.
+     *
+     * Configuration only, and `last_run_at` says when a run was last attempted,
+     * not whether it succeeded. What a run did is in
+     * `GET /sftp/rules/{id}/runs/{runId}` and `GET /sftp/sync-history`.
      *
      * @param {string} id -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     syncRuleShow(id: string): Promise<{}>;
     /**
+     * Change a sync rule in place: its account, remote path, target folder,
+     * schedule or options, or `enabled` to pause and resume it without deleting
+     * it. Only the fields present in the request are touched, but `options` is
+     * replaced wholesale rather than merged — send the whole object.
+     *
+     * A change takes effect from the next run; a run already in flight is not
+     * affected, and nothing a previous run imported is revisited or undone.
+     * Requires the elevated (admin) tier.
      *
      * @param {string} params.id -
-     * @throws {RevenexxAPIRevenexxException}
+     * @param {boolean} params.enabled -
+     * @param {string[]} params.options -
+     * @param {string} params.schedule -
+     * @param {string} params.sftpAccountId -
+     * @param {string} params.sourcePath -
+     * @param {string} params.targetFolderId -
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     syncRuleUpdate(params: {
         id: string;
+        enabled?: boolean;
+        options?: string[];
+        schedule?: string;
+        sftpAccountId?: string;
+        sourcePath?: string;
+        targetFolderId?: string;
     }): Promise<{}>;
     /**
+     * Change a sync rule in place: its account, remote path, target folder,
+     * schedule or options, or `enabled` to pause and resume it without deleting
+     * it. Only the fields present in the request are touched, but `options` is
+     * replaced wholesale rather than merged — send the whole object.
+     *
+     * A change takes effect from the next run; a run already in flight is not
+     * affected, and nothing a previous run imported is revisited or undone.
+     * Requires the elevated (admin) tier.
      *
      * @param {string} id -
-     * @throws {RevenexxAPIRevenexxException}
+     * @param {boolean} enabled -
+     * @param {string[]} options -
+     * @param {string} schedule -
+     * @param {string} sftpAccountId -
+     * @param {string} sourcePath -
+     * @param {string} targetFolderId -
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    syncRuleUpdate(id: string): Promise<{}>;
+    syncRuleUpdate(id: string, enabled?: boolean, options?: string[], schedule?: string, sftpAccountId?: string, sourcePath?: string, targetFolderId?: string): Promise<{}>;
     /**
+     * Queue a run of this rule straight away, outside its schedule. Answers 202
+     * with the rule id as soon as the job is queued — it does not wait for the
+     * transfer and it does not hand back a run id, so follow the outcome in
+     * `GET /sftp/sync-history`.
+     *
+     * The rule's own schedule is untouched, and this does not enable a disabled
+     * rule: the job is queued but does nothing when it picks a disabled rule
+     * up. Requires the elevated (admin) tier.
      *
      * @param {string} params.id -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     syncRuleRun(params: {
         id: string;
     }): Promise<{}>;
     /**
+     * Queue a run of this rule straight away, outside its schedule. Answers 202
+     * with the rule id as soon as the job is queued — it does not wait for the
+     * transfer and it does not hand back a run id, so follow the outcome in
+     * `GET /sftp/sync-history`.
+     *
+     * The rule's own schedule is untouched, and this does not enable a disabled
+     * rule: the job is queued but does nothing when it picks a disabled rule
+     * up. Requires the elevated (admin) tier.
      *
      * @param {string} id -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     syncRuleRun(id: string): Promise<{}>;
     /**
+     * Return the per-file protocol of one run of one sync rule: every entry the
+     * run recorded, oldest first, with the remote source path, the asset it
+     * produced, the bytes transferred, the duration and the error where one
+     * applies — plus a `summary` counting those entries by status (`success`,
+     * `skipped`, `failed`, `quarantined`).
+     *
+     * Use it to find out what one run actually did. It is not paginated, and it
+     * does not list a rule's runs: take the `run_id` from
+     * `GET /sftp/sync-history`. An unknown `runId` under a rule that does exist
+     * is an empty protocol, not a 404.
      *
      * @param {string} params.id -
      * @param {string} params.runId -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     syncRuleRunProtocol(params: {
@@ -514,20 +1118,42 @@ declare class Storage {
         runId: string;
     }): Promise<{}>;
     /**
+     * Return the per-file protocol of one run of one sync rule: every entry the
+     * run recorded, oldest first, with the remote source path, the asset it
+     * produced, the bytes transferred, the duration and the error where one
+     * applies — plus a `summary` counting those entries by status (`success`,
+     * `skipped`, `failed`, `quarantined`).
+     *
+     * Use it to find out what one run actually did. It is not paginated, and it
+     * does not list a rule's runs: take the `run_id` from
+     * `GET /sftp/sync-history`. An unknown `runId` under a rule that does exist
+     * is an empty protocol, not a 404.
      *
      * @param {string} id -
      * @param {string} runId -
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     syncRuleRunProtocol(id: string, runId: string): Promise<{}>;
     /**
+     * Page through this tenant's per-file sync records across every rule,
+     * newest first. Each entry names the run it belongs to, the rule, the
+     * remote source path, the asset it produced where there is one, the
+     * outcome — `success`, `skipped`, `failed` or `quarantined` — the bytes
+     * transferred and how long it took. Narrow it with `rule_id` and a
+     * `from`/`to` range on when the entry was recorded; one page is returned,
+     * 50 entries by default and 200 at most.
+     *
+     * This is the audit trail of what SFTP sync has brought in: every file
+     * taken, skipped and rejected leaves an entry, and a run that matched
+     * nothing leaves one too. To read a single run whole instead, group by
+     * `run_id` and call `GET /sftp/rules/{id}/runs/{runId}`.
      *
      * @param {string} params.ruleId -
-     * @param {string} params.from -
-     * @param {string} params.to -
-     * @throws {RevenexxAPIRevenexxException}
+     * @param {string} params.from - Only runs recorded at or after this instant.
+     * @param {string} params.to - Only runs recorded at or before this instant.
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     syncRuleHistory(params?: {
@@ -536,24 +1162,53 @@ declare class Storage {
         to?: string;
     }): Promise<{}>;
     /**
+     * Page through this tenant's per-file sync records across every rule,
+     * newest first. Each entry names the run it belongs to, the rule, the
+     * remote source path, the asset it produced where there is one, the
+     * outcome — `success`, `skipped`, `failed` or `quarantined` — the bytes
+     * transferred and how long it took. Narrow it with `rule_id` and a
+     * `from`/`to` range on when the entry was recorded; one page is returned,
+     * 50 entries by default and 200 at most.
+     *
+     * This is the audit trail of what SFTP sync has brought in: every file
+     * taken, skipped and rejected leaves an entry, and a run that matched
+     * nothing leaves one too. To read a single run whole instead, group by
+     * `run_id` and call `GET /sftp/rules/{id}/runs/{runId}`.
      *
      * @param {string} ruleId -
-     * @param {string} from -
-     * @param {string} to -
-     * @throws {RevenexxAPIRevenexxException}
+     * @param {string} from - Only runs recorded at or after this instant.
+     * @param {string} to - Only runs recorded at or before this instant.
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     syncRuleHistory(ruleId?: string, from?: string, to?: string): Promise<{}>;
     /**
+     * Break this tenant's library down by asset kind — `image`, `video`,
+     * `audio`, `pdf`, `document`, `archive`, `model3d`, `other` — with a count
+     * and a byte total for each kind that has at least one asset, alongside the
+     * tenant-wide totals.
      *
-     * @throws {RevenexxAPIRevenexxException}
+     * A dashboard figure, not a listing: no asset is named, and nothing here
+     * can be filtered. The tenant-wide byte total is the same running figure
+     * `GET /tenant/usage` reports, so soft-deleted assets are counted in it.
+     *
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     tenantStats(): Promise<{}>;
     /**
+     * Report this tenant's storage consumption: the bytes in use, the byte
+     * quota in force (null when the tenant is uncapped) and how many assets it
+     * holds. This is the figure the quota check on upload compares against — it
+     * is maintained as a running total on every upload and permanent delete
+     * rather than summed on read.
+     *
+     * Soft-deleted assets are still counted, because their files are still
+     * stored; their bytes come back only once they are permanently deleted. For
+     * the breakdown by asset kind, see `GET /tenant/stats`.
      *
-     * @throws {RevenexxAPIRevenexxException}
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     tenantUsage(): Promise<{}>;