@revenexx/node 0.0.2 → 0.1.1

package/dist/services/search.d.mts

@@ -1,32 +1,204 @@
 import { Client } from '../client.mjs';
+import { Models } from '../models.mjs';
 import { Collection } from '../enums/collection.mjs';
-import '../models.mjs';
-import '../enums/address-type.mjs';
+import '../query.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,31 +240,57 @@ 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 '../query.mjs';
+import '../enums/message-2-status.mjs';
 
 declare class Search {
     client: Client;
     constructor(client: Client);
     /**
-     * The collections the tenant's installed apps have provisioned.
+     * The collections the tenant's installed apps have provisioned. Available on the API-gateway-trust path only — a `revx_` key authorises a single collection, so discovery is a gateway concern and a key-authenticated caller gets 403.
      *
-     * @throws {RevenexxAPIRevenexxException}
-     * @returns {Promise<{}>}
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.CollectionList>}
      */
-    searchListCollections(): Promise<{}>;
+    searchListCollections(): Promise<Models.CollectionList>;
     /**
-     * Full-text search within one collection using Typesense query parameters as the query string.
-     *
-     * @param {Collection} params.collection - Collection key (one the tenant has installed).
-     * @param {string} params.q - Query text. Use `*` to match all.
-     * @param {string} params.queryBy - Comma-separated fields to search.
-     * @param {string} params.filterBy - Filter expression.
-     * @param {string} params.sortBy - Sort expression.
-     * @param {number} params.page - 1-based page.
-     * @param {number} params.perPage - Hits per page (max 250).
-     * @throws {RevenexxAPIRevenexxException}
-     * @returns {Promise<{}>}
+     * Returns the Typesense collection definition (fields, defaults, document count). Requires the `collections:read` action.
+     *
+     * @param {Collection} params.collection - A collection the tenant owns (see `GET /api/v1/collections`). Resolved to its namespaced Typesense name server-side; a collection the tenant does not own is a 404.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.DefaultCollection>}
+     */
+    searchGetCollection(params: {
+        collection: Collection;
+    }): Promise<Models.DefaultCollection>;
+    /**
+     * Returns the Typesense collection definition (fields, defaults, document count). Requires the `collections:read` action.
+     *
+     * @param {Collection} collection - A collection the tenant owns (see `GET /api/v1/collections`). Resolved to its namespaced Typesense name server-side; a collection the tenant does not own is a 404.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.DefaultCollection>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    searchGetCollection(collection: Collection): Promise<Models.DefaultCollection>;
+    /**
+     * Full-text search within one collection. Typesense search parameters are passed through verbatim as the query string, so parameters not listed here still reach Typesense. Requires the `documents:search` action.
+     *
+     * @param {Collection} params.collection - A collection the tenant owns (see `GET /api/v1/collections`). Resolved to its namespaced Typesense name server-side; a collection the tenant does not own is a 404.
+     * @param {string} params.q - Query text. Use `*` to match everything.
+     * @param {string} params.queryBy - Comma-separated fields to search, in weight order.
+     * @param {string} params.filterBy - Filter expression, e.g. `in_stock:=true && price:<100`. ANDed with the tenant filter the proxy injects.
+     * @param {string} params.sortBy - Sort expression, e.g. `price:desc`.
+     * @param {string} params.facetBy - Comma-separated fields to facet on.
+     * @param {number} params.maxFacetValues - Facet values to return per field.
+     * @param {string} params.groupBy - Comma-separated fields to group results by.
+     * @param {string} params.includeFields - Comma-separated document fields to return.
+     * @param {string} params.excludeFields - Comma-separated document fields to omit.
+     * @param {string} params.highlightFullFields - Comma-separated fields to highlight in full.
+     * @param {number} params.numTypos - Typos tolerated per query token.
+     * @param {string} params.prefix - Whether the last token is a prefix; per-field when comma-separated.
+     * @param {number} params.page - 1-based page number.
+     * @param {number} params.perPage - Hits per page.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.DefaultSearchResult>}
      */
     searchSearchDocumentsGet(params: {
         collection: Collection;
@@ -100,70 +298,107 @@ declare class Search {
         queryBy?: string;
         filterBy?: string;
         sortBy?: string;
+        facetBy?: string;
+        maxFacetValues?: number;
+        groupBy?: string;
+        includeFields?: string;
+        excludeFields?: string;
+        highlightFullFields?: string;
+        numTypos?: number;
+        prefix?: string;
         page?: number;
         perPage?: number;
-    }): Promise<{}>;
+    }): Promise<Models.DefaultSearchResult>;
     /**
-     * Full-text search within one collection using Typesense query parameters as the query string.
-     *
-     * @param {Collection} collection - Collection key (one the tenant has installed).
-     * @param {string} q - Query text. Use `*` to match all.
-     * @param {string} queryBy - Comma-separated fields to search.
-     * @param {string} filterBy - Filter expression.
-     * @param {string} sortBy - Sort expression.
-     * @param {number} page - 1-based page.
-     * @param {number} perPage - Hits per page (max 250).
-     * @throws {RevenexxAPIRevenexxException}
-     * @returns {Promise<{}>}
+     * Full-text search within one collection. Typesense search parameters are passed through verbatim as the query string, so parameters not listed here still reach Typesense. Requires the `documents:search` action.
+     *
+     * @param {Collection} collection - A collection the tenant owns (see `GET /api/v1/collections`). Resolved to its namespaced Typesense name server-side; a collection the tenant does not own is a 404.
+     * @param {string} q - Query text. Use `*` to match everything.
+     * @param {string} queryBy - Comma-separated fields to search, in weight order.
+     * @param {string} filterBy - Filter expression, e.g. `in_stock:=true && price:<100`. ANDed with the tenant filter the proxy injects.
+     * @param {string} sortBy - Sort expression, e.g. `price:desc`.
+     * @param {string} facetBy - Comma-separated fields to facet on.
+     * @param {number} maxFacetValues - Facet values to return per field.
+     * @param {string} groupBy - Comma-separated fields to group results by.
+     * @param {string} includeFields - Comma-separated document fields to return.
+     * @param {string} excludeFields - Comma-separated document fields to omit.
+     * @param {string} highlightFullFields - Comma-separated fields to highlight in full.
+     * @param {number} numTypos - Typos tolerated per query token.
+     * @param {string} prefix - Whether the last token is a prefix; per-field when comma-separated.
+     * @param {number} page - 1-based page number.
+     * @param {number} perPage - Hits per page.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.DefaultSearchResult>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    searchSearchDocumentsGet(collection: Collection, q?: string, queryBy?: string, filterBy?: string, sortBy?: string, page?: number, perPage?: number): Promise<{}>;
+    searchSearchDocumentsGet(collection: Collection, q?: string, queryBy?: string, filterBy?: string, sortBy?: string, facetBy?: string, maxFacetValues?: number, groupBy?: string, includeFields?: string, excludeFields?: string, highlightFullFields?: string, numTypos?: number, prefix?: string, page?: number, perPage?: number): Promise<Models.DefaultSearchResult>;
     /**
-     * Full-text search within one collection. The body holds Typesense search parameters.
+     * Full-text search within one collection, with the Typesense search parameters in the body. Requires the `documents:search` action.
      *
-     * @param {Collection} params.collection - Collection key (one the tenant has installed).
+     * @param {Collection} params.collection - A collection the tenant owns (see `GET /api/v1/collections`). Resolved to its namespaced Typesense name server-side; a collection the tenant does not own is a 404.
+     * @param {string} params.excludeFields - Comma-separated document fields to omit.
      * @param {string} params.facetBy - Comma-separated fields to facet on.
-     * @param {string} params.filterBy - Filter expression, e.g. `in_stock:=true`.
-     * @param {number} params.page -
-     * @param {number} params.perPage -
-     * @param {string} params.q - Query text. Use `*` to match all.
-     * @param {string} params.queryBy - Comma-separated fields to search.
+     * @param {string} params.filterBy - Filter expression, e.g. `in_stock:=true && price:<100`. ANDed with the tenant filter the proxy injects.
+     * @param {string} params.groupBy - Comma-separated fields to group results by.
+     * @param {string} params.highlightFullFields - Comma-separated fields to highlight in full.
+     * @param {string} params.includeFields - Comma-separated document fields to return.
+     * @param {number} params.maxFacetValues - Facet values to return per field.
+     * @param {number} params.numTypos - Typos tolerated per query token.
+     * @param {number} params.page - 1-based page number.
+     * @param {number} params.perPage - Hits per page.
+     * @param {string} params.prefix - Whether the last token is a prefix; per-field when comma-separated.
+     * @param {string} params.q - Query text. Use `*` to match everything.
+     * @param {string} params.queryBy - Comma-separated fields to search, in weight order.
      * @param {string} params.sortBy - Sort expression, e.g. `price:desc`.
-     * @throws {RevenexxAPIRevenexxException}
-     * @returns {Promise<{}>}
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.DefaultSearchResult>}
      */
     searchSearchDocuments(params: {
         collection: Collection;
+        excludeFields?: string;
         facetBy?: string;
         filterBy?: string;
+        groupBy?: string;
+        highlightFullFields?: string;
+        includeFields?: string;
+        maxFacetValues?: number;
+        numTypos?: number;
         page?: number;
         perPage?: number;
+        prefix?: string;
         q?: string;
         queryBy?: string;
         sortBy?: string;
-    }): Promise<{}>;
+    }): Promise<Models.DefaultSearchResult>;
     /**
-     * Full-text search within one collection. The body holds Typesense search parameters.
+     * Full-text search within one collection, with the Typesense search parameters in the body. Requires the `documents:search` action.
      *
-     * @param {Collection} collection - Collection key (one the tenant has installed).
+     * @param {Collection} collection - A collection the tenant owns (see `GET /api/v1/collections`). Resolved to its namespaced Typesense name server-side; a collection the tenant does not own is a 404.
+     * @param {string} excludeFields - Comma-separated document fields to omit.
      * @param {string} facetBy - Comma-separated fields to facet on.
-     * @param {string} filterBy - Filter expression, e.g. `in_stock:=true`.
-     * @param {number} page -
-     * @param {number} perPage -
-     * @param {string} q - Query text. Use `*` to match all.
-     * @param {string} queryBy - Comma-separated fields to search.
+     * @param {string} filterBy - Filter expression, e.g. `in_stock:=true && price:<100`. ANDed with the tenant filter the proxy injects.
+     * @param {string} groupBy - Comma-separated fields to group results by.
+     * @param {string} highlightFullFields - Comma-separated fields to highlight in full.
+     * @param {string} includeFields - Comma-separated document fields to return.
+     * @param {number} maxFacetValues - Facet values to return per field.
+     * @param {number} numTypos - Typos tolerated per query token.
+     * @param {number} page - 1-based page number.
+     * @param {number} perPage - Hits per page.
+     * @param {string} prefix - Whether the last token is a prefix; per-field when comma-separated.
+     * @param {string} q - Query text. Use `*` to match everything.
+     * @param {string} queryBy - Comma-separated fields to search, in weight order.
      * @param {string} sortBy - Sort expression, e.g. `price:desc`.
-     * @throws {RevenexxAPIRevenexxException}
-     * @returns {Promise<{}>}
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.DefaultSearchResult>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    searchSearchDocuments(collection: Collection, facetBy?: string, filterBy?: string, page?: number, perPage?: number, q?: string, queryBy?: string, sortBy?: string): Promise<{}>;
+    searchSearchDocuments(collection: Collection, excludeFields?: string, facetBy?: string, filterBy?: string, groupBy?: string, highlightFullFields?: string, includeFields?: string, maxFacetValues?: number, numTypos?: number, page?: number, perPage?: number, prefix?: string, q?: string, queryBy?: string, sortBy?: string): Promise<Models.DefaultSearchResult>;
     /**
-     * Fetch a single document by id from a collection the tenant has installed.
+     * Fetch a single document by id. The document shape is the collection's own schema, so it is described as a free-form object. Requires the `documents:get` action.
      *
-     * @param {Collection} params.collection - Collection key (one the tenant has installed).
-     * @param {string} params.documentId - Document id within the collection.
-     * @throws {RevenexxAPIRevenexxException}
+     * @param {Collection} params.collection - A collection the tenant owns (see `GET /api/v1/collections`). Resolved to its namespaced Typesense name server-side; a collection the tenant does not own is a 404.
+     * @param {string} params.documentId - The document's `id` within the collection.
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     searchGetDocument(params: {
@@ -171,34 +406,96 @@ declare class Search {
         documentId: string;
     }): Promise<{}>;
     /**
-     * Fetch a single document by id from a collection the tenant has installed.
+     * Fetch a single document by id. The document shape is the collection's own schema, so it is described as a free-form object. Requires the `documents:get` action.
      *
-     * @param {Collection} collection - Collection key (one the tenant has installed).
-     * @param {string} documentId - Document id within the collection.
-     * @throws {RevenexxAPIRevenexxException}
+     * @param {Collection} collection - A collection the tenant owns (see `GET /api/v1/collections`). Resolved to its namespaced Typesense name server-side; a collection the tenant does not own is a 404.
+     * @param {string} documentId - The document's `id` within the collection.
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     searchGetDocument(collection: Collection, documentId: string): Promise<{}>;
     /**
-     * Run several searches in one request (the InstantSearch adapter uses this). Each entry names its collection.
+     * Idempotent, and bounded by the tenant's own configuration: it can add
+     * no field for an attribute the tenant has not marked `is_filterable`,
+     * and drops only fields whose attribute it has itself un-marked. A run
+     * that changes nothing makes zero calls to Typesense.
+     *
+     * Body (optional) narrows the sweep to one app:
+     *
+     *     {"vendor": "revenexx", "app": "products"}
      *
-     * @param {object[]} params.searches -
-     * @throws {RevenexxAPIRevenexxException}
+     * Omitted, every app the tenant has installed is swept. Apps outside the
+     * facet-sync allowlist are included in the response with
+     * `skipped: app_not_enabled` rather than silently dropped — a caller
+     * asking for an app that cannot have facets deserves to be told so.
+     *
+     * The response shape below is DECLARED rather than inferred. Its entries
+     * are built by spreading AttributeFacetSyncer::syncForCollection()'s
+     * summary, and the generator cannot see through an array spread: left to
+     * itself it emits an unnamed property and a null in `required`, which
+     * Spectral rejects as `"1" property must be string`.
+     * AppController::resyncFacets() carries the same declaration for the same
+     * reason — keep both in step with syncForApp()'s return type.
+     *
+     * @param {string} params.app -
+     * @param {string} params.vendor -
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
-    searchMultiSearch(params: {
-        searches: object[];
+    gatewayFacetResync(params?: {
+        app?: string;
+        vendor?: string;
     }): Promise<{}>;
     /**
-     * Run several searches in one request (the InstantSearch adapter uses this). Each entry names its collection.
+     * Idempotent, and bounded by the tenant's own configuration: it can add
+     * no field for an attribute the tenant has not marked `is_filterable`,
+     * and drops only fields whose attribute it has itself un-marked. A run
+     * that changes nothing makes zero calls to Typesense.
      *
-     * @param {object[]} searches -
-     * @throws {RevenexxAPIRevenexxException}
+     * Body (optional) narrows the sweep to one app:
+     *
+     *     {"vendor": "revenexx", "app": "products"}
+     *
+     * Omitted, every app the tenant has installed is swept. Apps outside the
+     * facet-sync allowlist are included in the response with
+     * `skipped: app_not_enabled` rather than silently dropped — a caller
+     * asking for an app that cannot have facets deserves to be told so.
+     *
+     * The response shape below is DECLARED rather than inferred. Its entries
+     * are built by spreading AttributeFacetSyncer::syncForCollection()'s
+     * summary, and the generator cannot see through an array spread: left to
+     * itself it emits an unnamed property and a null in `required`, which
+     * Spectral rejects as `"1" property must be string`.
+     * AppController::resyncFacets() carries the same declaration for the same
+     * reason — keep both in step with syncForApp()'s return type.
+     *
+     * @param {string} app -
+     * @param {string} vendor -
+     * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    searchMultiSearch(searches: object[]): Promise<{}>;
+    gatewayFacetResync(app?: string, vendor?: string): Promise<{}>;
+    /**
+     * Run several searches in one round trip — the endpoint the typesense-js `multiSearch` helper and the InstantSearch adapter use for every query. On the gateway-trust path each entry must name a collection the tenant owns. With a `revx_` key `collection_name` is optional and is forced to the key's own collection. Requires the `documents:search` action.
+     *
+     * @param {Models.MultiSearchEntry[]} params.searches - The searches to run, in order. Must not be empty.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.MultiSearchResult>}
+     */
+    searchMultiSearch(params: {
+        searches: Models.MultiSearchEntry[];
+    }): Promise<Models.MultiSearchResult>;
+    /**
+     * Run several searches in one round trip — the endpoint the typesense-js `multiSearch` helper and the InstantSearch adapter use for every query. On the gateway-trust path each entry must name a collection the tenant owns. With a `revx_` key `collection_name` is optional and is forced to the key's own collection. Requires the `documents:search` action.
+     *
+     * @param {Models.MultiSearchEntry[]} searches - The searches to run, in order. Must not be empty.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.MultiSearchResult>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    searchMultiSearch(searches: Models.MultiSearchEntry[]): Promise<Models.MultiSearchResult>;
 }
 
 export { Search };