@coveo/platform-client 55.13.2 → 56.0.0

package/dist/types/resources/Pipelines/StatementGroups/StatementGroupsInterfaces.d.ts

@@ -33,7 +33,6 @@ interface StatementGroupModelBase {
     /**
      * Date of creation
      * Format: ISO-8601
-     *
      * @example 2021-09-09T19:00:45.603-04:00
      */
     createdAt: string;
@@ -44,7 +43,6 @@ interface StatementGroupModelBase {
     /**
      * Last date of modification
      * Format: ISO-8601
-     *
      * @example 2021-09-09T19:00:45.603-04:00
      */
     modifiedAt?: string;
@@ -70,14 +68,12 @@ export interface CampaignStatementGroup extends StatementGroupModelBase {
     /**
      * The start date of the campaign.
      * Format: ISO-8601
-     *
      * @example 2020-09-09T19:00:45.603-04:00
      */
     campaignStart: string;
     /**
      * The end date of the campaign.
      * Format: ISO-8601
-     *
      * @example 2021-09-09T19:00:45.603-04:00
      */
     campaignEnd: string;
@@ -149,13 +145,11 @@ export interface ListStatementGroupsOptions extends Paginated {
     types?: StatementGroupType[];
     /**
      * The sort criteria to apply on the results.
-     *
      * @default position
      */
     sortBy?: 'position' | 'description' | 'definition' | 'name' | 'status';
     /**
      * Whether to sort by ascending order.
-     *
      * @default true
      */
     isOrderAscending?: boolean;
@@ -187,23 +181,19 @@ export interface CreateCampaignStatementGroupModel extends CreateStatementGroupM
     /**
      * The start date of the campaign.
      * Format: ISO-8601
-     *
      * @example 2020-09-09T19:00:45.603-04:00
      */
     campaignStart: string;
     /**
      * The end date of the campaign.
      * Format: ISO-8601
-     *
      * @example 2021-09-09T19:00:45.603-04:00
      */
     campaignEnd: string;
 }
 export type UpdateStatementGroupModel = UpdatePermanentStatementGroupModel | UpdateCampaignStatementGroupsModel;
-export interface UpdatePermanentStatementGroupModel extends CreatePermanentStatementGroupModel {
-}
-export interface UpdateCampaignStatementGroupsModel extends CreateCampaignStatementGroupModel {
-}
+export type UpdatePermanentStatementGroupModel = CreatePermanentStatementGroupModel;
+export type UpdateCampaignStatementGroupsModel = CreateCampaignStatementGroupModel;
 export interface UpdateStatementGroupRuleAssociationsRequest {
     /**
      * The rules to add to this group. (max-length: 50)

package/dist/types/resources/Pipelines/Statements/Statements.d.ts

@@ -6,90 +6,80 @@ export default class Statements extends Resource {
     static getStatementUrl: (pipelineId: string, statementId: string) => string;
     /**
      * Gets a sorted page of query pipeline statements matching certain criteria from a specific query pipeline.
-     *
-     * @param {string} pipelineId The unique identifier of the target query pipeline.
-     * @param {ListStatementParams} options Listing options.
-     * @returns {Promise<PageModel<StatementModel, "statements">>} The matching statements in the current page of results
+     * @param pipelineId The unique identifier of the target query pipeline.
+     * @param options Listing options.
+     * @returns The matching statements in the current page of results
      */
     list(pipelineId: string, options?: ListStatementParams): Promise<PageModel<StatementModel, 'statements'>>;
     /**
      * Exports the definition, condition, and description of statements from a specific query pipeline to a CSV file.
-     *
-     * @param {string} pipelineId The unique identifier of the target query pipeline.
-     * @param {ExportStatementParams} options Export options
-     * @returns {Promise<Blob>} The file containing the exported data.
+     * @param pipelineId The unique identifier of the target query pipeline.
+     * @param options Export options
+     * @returns The file containing the exported data.
      */
     exportCSV(pipelineId: string, options?: ExportStatementParams): Promise<Blob>;
     /**
      * Import the definition, condition, and description of statements from a CSV file to a specific query pipeline.
-     *
-     * @param {string} pipelineId The unique identifier of the target query pipeline.
-     * @param {File | string} csvFile The file containing the statements to import.
-     * @param {ExportStatementParams} options Import options
+     * @param pipelineId The unique identifier of the target query pipeline.
+     * @param csvFile The file containing the statements to import.
+     * @param options Import options
      */
     importCSV(pipelineId: string, csvFile: File | string, options?: ExportStatementParams): Promise<Record<string, unknown>>;
     /**
      * Creates a new query pipeline statement in a specific query pipeline.
-     *
-     * @param {string} pipelineId The unique identifier of the target query pipeline.
-     * @param {CreateStatementModel} model The query pipeline statement information.
-     * @returns {Promise<StatementModel>} The created statement.
+     * @param pipelineId The unique identifier of the target query pipeline.
+     * @param model The query pipeline statement information.
+     * @returns The created statement.
      */
     create(pipelineId: string, model: CreateStatementModel): Promise<StatementModel>;
     /**
      * Updates a single query pipeline statement in a specific query pipeline.
-     *
-     * @param {string} pipelineId The unique identifier of the target query pipeline.
-     * @param {string} statementId The unique identifier of the target statement.
-     * @param {CreateStatementModel} model The updated query pipeline statement information.
-     * @returns {Promise<StatementModel>} The updated statement.
+     * @param pipelineId The unique identifier of the target query pipeline.
+     * @param statementId The unique identifier of the target statement.
+     * @param model The updated query pipeline statement information.
+     * @returns The updated statement.
      */
     update(pipelineId: string, statementId: string, model: CreateStatementModel): Promise<StatementModel>;
     /**
      * Copies specific statements from an origin to a target query pipeline. Using the same pipeline as origin and target will duplicate the specified statements in that pipeline.
-     *
-     * @param {string} pipelineId The unique identifier of the target query pipeline.
-     * @param {CopyStatementModel} model The copy operation to perform.
-     * @returns {Promise<PageModel<StatementModel, "statements">>} The matching statements in the current page of results.
+     * @param pipelineId The unique identifier of the target query pipeline.
+     * @param model The copy operation to perform.
+     * @returns The matching statements in the current page of results.
      */
     copy(pipelineId: string, model: CopyStatementModel): Promise<PageModel<StatementModel, "statements">>;
     /**
      * Gets a single query pipeline statement from a specific query pipeline.
-     *
-     * @param {string} pipelineId The unique identifier of the target query pipeline.
-     * @param {string} statementId The unique identifier of the target statement.
-     * @returns {Promise<StatementModel>} The statement
+     * @param pipelineId The unique identifier of the target query pipeline.
+     * @param statementId The unique identifier of the target statement.
+     * @returns The statement
      */
     get(pipelineId: string, statementId: string): Promise<StatementModel>;
     /**
      * Sets the position of a query pipeline statement in a specific query pipeline and updates other statement positions as appropriate.
-     *
-     * @param {string} pipelineId The unique identifier of the target query pipeline.
-     * @param {string} statementId The unique identifier of the target statement.
-     * @param {MoveStatementModel} model The move operation to perform.
-     * @returns {Promise<PageModel<StatementModel, 'statements'>>} The matching statements in the current page of results.
+     * @param pipelineId The unique identifier of the target query pipeline.
+     * @param statementId The unique identifier of the target statement.
+     * @param model The move operation to perform.
+     * @returns The matching statements in the current page of results.
      */
     move(pipelineId: string, statementId: string, model: MoveStatementModel): Promise<PageModel<StatementModel, 'statements'>>;
     /**
      * Deletes a single query pipeline statement from a specific query pipeline.
-     *
-     * @param {string} pipelineId The unique identifier of the target query pipeline.
-     * @param {string} statementId The unique identifier of the target statement.
+     * @param pipelineId The unique identifier of the target query pipeline.
+     * @param statementId The unique identifier of the target statement.
      */
     delete(pipelineId: string, statementId: string): Promise<Record<string, unknown>>;
     /**
      * Gets a sorted page of query pipeline statements matching certain criteria from a specific query pipeline.
-     *
-     * @param {string} pipelineId The unique identifier of the target query pipeline.
-     * @param {BulkGetStatementsParams} params A set of parameters to customize the results.
-     * @returns {Promise<PageModel<StatementModel, 'statements'>>} The matching statements in the current page of results.
+     * @param pipelineId The unique identifier of the target query pipeline.
+     * @param params A set of parameters to customize the results.
+     * @param params.ids
+     * @returns The matching statements in the current page of results.
      */
     bulkGet(pipelineId: string, { ids, ...allQueryStringOptions }: BulkGetStatementsParams): Promise<PageModel<StatementModel, 'statements'>>;
     /**
      * Delete multiple statements at once for a specific pipeline.
-     *
-     * @param {string} pipelineId The unique identifier of the target query pipeline.
-     * @param {string[]} ids A list of resource identifiers to delete. A maximum of 100 can be sent.
+     * @param pipelineId The unique identifier of the target query pipeline.
+     * @param ids A list of resource identifiers to delete. A maximum of 100 can be sent.
      */
     bulkDelete(pipelineId: string, ids: string[]): Promise<Record<string, unknown>>;
 }

package/dist/types/resources/PrivilegeEvaluator/PrivilegeEvaluator.d.ts

@@ -4,8 +4,7 @@ export default class PrivilegeEvaluator extends Ressource {
     static baseUrl: string;
     /**
      * Evaluates a specific privilege request
-     *
-     * @param {RestTokenParams} privilegeEvaluatorParams The privilege request to evaluate
+     * @param privilegeEvaluatorParams The privilege request to evaluate
      */
     evaluate(privilegeEvaluatorParams: PrivilegeEvaluatorModel): Promise<PrivilegeEvaluatorModel>;
 }

package/dist/types/resources/Products/Product.d.ts

@@ -4,6 +4,8 @@ import { ProductsRequestModel, ProductsResultModel } from './ProductInterfaces.j
 export default class Products extends Resource {
     static baseUrl: string;
     /**
+     * @param productsRequest
+     * @param refreshCache
      * @deprecated
      */
     get(productsRequest: New<ProductsRequestModel>, refreshCache?: boolean): Promise<ProductsResultModel>;

package/dist/types/resources/Projects/Project.d.ts

@@ -6,61 +6,53 @@ export default class Project extends Resource {
     static baseUrl: string;
     /**
      * Returns a paginated list of projects.
-     *
-     * @param {ListProjectParams} params
-     * @returns {Promise<PageModel<ProjectModel>>} A paginated list of projects
+     * @param params
+     * @returns A paginated list of projects
      */
     list(params?: ListProjectParams): Promise<PageModel<ProjectModel>>;
     /**
      * Creates and returns a new project.
-     *
-     * @param {ProjectModel} project
-     * @returns {Promise<ProjectModel>} The newly created project
+     * @param project
+     * @returns The newly created project
      */
     create(project: BaseProjectModel): Promise<ProjectModel>;
     /**
      * Updates a project with the model sent and returns the updated project.
-     *
-     * @param {string} projectId
-     * @param {ProjectModel} updateProjectModel
-     * @returns {Promise<ProjectModel>} The updated project
+     * @param projectId
+     * @param updateProjectModel
+     * @returns The updated project
      */
     update(projectId: string, updateProjectModel: ProjectModel): Promise<ProjectModel>;
     /**
      * Returns a project.
-     *
-     * @param {string} projectId
-     * @returns {Promise<ProjectModel>} The project specified by the provided id
+     * @param projectId
+     * @returns The project specified by the provided id
      */
     get(projectId: string): Promise<ProjectModel>;
     /**
      * Deletes a project.
-     *
-     * @param {string} projectId
+     * @param projectId
      */
     delete(projectId: string): Promise<void>;
     /**
      * Returns resource IDs grouped by resource status, for a given project.
-     *
-     * @param {string} projectId
-     * @returns {Promise<Record<ResourceStatus, Record<ProjectResourceType, string[]>>>} A series of resource IDs grouped by their status and resource type.
+     * @param projectId
+     * @returns A series of resource IDs grouped by their status and resource type.
      */
     listResourcesByStatus(projectId: string): Promise<Record<ResourceStatus, Record<ProjectResourceType, string[]>>>;
     /**
      * Returns a paginated list of resources associated to a project.
-     *
-     * @param {string} projectId
-     * @param {ProjectResourceType} resourceType
-     * @param {ResourceParams} params
-     * @returns {Promise<PageModel<ResourceModel>>} A paginated list of resources associated to a project.
+     * @param projectId
+     * @param resourceType
+     * @param params
+     * @returns A paginated list of resources associated to a project.
      */
     listResources(projectId: string, resourceType: ProjectResourceType, params?: ResourceParams): Promise<PageModel<ResourceModel>>;
     /**
      * Returns a list of project IDs associated to the provided resource IDs.
-     *
-     * @param {ProjectResourceType} resourceType
-     * @param {string[]} resourceIds
-     * @returns {Promise<ListAssociatedProjectsModel[]>} List of project IDs associated to the provided resource IDs.
+     * @param resourceType
+     * @param resourceIds
+     * @returns List of project IDs associated to the provided resource IDs.
      */
     listAssociatedProjects(resourceType: ProjectResourceType, resourceIds: string[]): Promise<ListAssociatedProjectsModel[]>;
 }

package/dist/types/resources/Projects/ProjectInterfaces.d.ts

@@ -12,8 +12,6 @@ export declare const projectResourceTypes: string[];
 export type ProjectResourceType = (typeof projectResourceTypes)[number];
 /**
  * Enum representing the possible project types.
- *
- * @enum {string}
  */
 export declare enum ProjectType {
     CaseDeflection = "CASE_DEFLECTION",
@@ -43,13 +41,11 @@ export interface BaseProjectModel {
     type: ProjectType;
     /**
      * The list of usernames that will be points of contact for the project.
-     *
      * @example: ['johndoe@email.com-google', 'janedoe@email.com-office265']
      */
     pointsOfContact?: string[];
     /**
      * The resources associated to the project.
-     *
      * @example: {'SOURCE': ['sourceId1', 'sourceId2']}
      */
     resources?: Record<ProjectResourceType, string[]>;
@@ -61,27 +57,23 @@ export interface ProjectModel extends BaseProjectModel {
     id: string;
     /**
      * The email of the user that created the project.
-     *
      * @example: 'jdoe@email.com'
      */
     createdBy: string;
     /**
      * The date of the project's creation.
      * Note: ISO-8601 format
-     *
      * @example: '2023-06-21T14:59:26.850Z'
      */
     createdDate: string;
     /**
      * The email of the user that last updated the project.
-     *
      * @example: 'jdoe@email.com'
      */
     updatedBy: string;
     /**
      * The date of the project's last update.
      * Note: ISO-8601 format
-     *
      * @example: '2023-06-21T14:59:26.850Z'
      */
     updatedDate: string;
@@ -101,7 +93,6 @@ export interface ListProjectParams extends Paginated {
     sortBy?: ProjectSortBy;
     /**
      * The sorting order to apply on the results.
-     *
      * @example: 'ASC'
      */
     order?: SortingOrder;

package/dist/types/resources/Resource.d.ts

@@ -5,7 +5,7 @@ declare class Resource {
     protected serverlessApi: API;
     static baseUrl: string;
     constructor(api: API, serverlessApi: API);
-    protected buildPath(route: string, parameters?: any, options?: queryString.StringifyOptions): string;
+    protected buildPath(route: string, parameters?: object, options?: queryString.StringifyOptions): string;
     private convertObjectToQueryString;
 }
 export default Resource;

package/dist/types/resources/ResourceSnapshots/ResourceSnapshots.d.ts

@@ -10,22 +10,22 @@ export default class ResourceSnapshots extends Resource {
     listResourceAccess(): Promise<ResourceSnapshotType[]>;
     /**
      * Shows whether the authenticated user has the specified access level (i.e., read or write) to the content of the target snapshot.
+     * @param snapshotId
+     * @param options
      */
     validateAccess(snapshotId: string, options: ValidateAccessOptions): Promise<SnapshotAccessModel>;
     /**
      * Retrieves a ZIP file holding the content of the target snapshot, in the target format.
-     *
-     * @param {string} snapshotId The unique identifier of the target snapshot.
-     * @param {ExportSnapshotContentOptions} [options]
-     * @returns {Promise<Blob>} A newly created Blob object which contains the zipped snapshot
+     * @param snapshotId The unique identifier of the target snapshot.
+     * @param [options]
+     * @returns A newly created Blob object which contains the zipped snapshot
      */
     export(snapshotId: string, options?: ExportSnapshotContentOptions): Promise<Blob>;
     getContent(snapshotId: string, options: GenerateUrlOptions): Promise<Response>;
     /**
      * Creates a snapshot from a file containing the configuration.
-     *
-     * @param {File} file The file containing the configuration.
-     * @param {CreateFromFileOptions} options
+     * @param file The file containing the configuration.
+     * @param options
      */
     createFromFile(file: File, options?: CreateFromFileOptions): Promise<ResourceSnapshotsModel>;
     createFromOrganization(exportConfigurationModel: ResourceSnapshotExportConfigurationModel, options: CreateFromOrganizationOptions): Promise<ResourceSnapshotsModel>;
@@ -43,10 +43,9 @@ export default class ResourceSnapshots extends Resource {
     /**
      * @description Shows the diff report for the target snapshot and dry-run report
      * @experimental
-     *
-     * @param {string} snapshotId - The unique identifier of the target snapshot.
-     * @param {string} relativeReportId - The unique identifier of the dry-run operation report associated with the target diff report.
-     * @param {(number|undefined)} [numberOfLinesMax=undefined] - Maximum number of lines before the diff is downloaded to a file.
+     * @param snapshotId - The unique identifier of the target snapshot.
+     * @param relativeReportId - The unique identifier of the dry-run operation report associated with the target diff report.
+     * @param [numberOfLinesMax] - Maximum number of lines before the diff is downloaded to a file.
      */
     diff(snapshotId: string, relativeReportId: string, numberOfLinesMax?: number): Promise<SnapshotDiffModel>;
 }

package/dist/types/resources/ResourceSnapshots/ResourceSnapshotsInterfaces.d.ts

@@ -279,7 +279,6 @@ export interface CreateFromFileOptions {
 export interface GetSnapshotOptions {
     /**
      * Whether to include reports with the snapshot.
-     *
      * @default false
      */
     includeReports?: boolean;
@@ -289,7 +288,6 @@ export interface ExportSnapshotContentOptions {
      * The format of the snapshot content.
      * - FLAT: Content unified into a single file
      * - SPLIT_PER_TYPE: Content split into one file per resource type
-     *
      * @default SnapshotExportContentFormat.Flat
      */
     contentFormat?: SnapshotExportContentFormat;
@@ -312,16 +310,13 @@ export declare enum ApplyOptionsDeletionScope {
 export interface ApplyOptions {
     /**
      * Whether to delete organization resources not present in the snapshot.
-     *
      * @default false
      */
     deleteMissingResources?: boolean;
     /**
      * The scope of the resources on which to calculate deletions.
      * **Note:** only applies when `deleteMissingResources` is set to `true`.
-     *
      * @default ApplyOptionsDeletionScope.AllManagedResources
-     *
      */
     deletionScope?: ApplyOptionsDeletionScope;
 }

package/dist/types/resources/Resources/Resources.d.ts

@@ -6,10 +6,9 @@ export default class Resources extends Resource {
     static baseUrl: string;
     /**
      * Returns a paginated list of resources.
-     *
      * @param resourceType
-     * @param {ListProjectParams} params
-     * @returns {Promise<PageModel<ResourceModel>>} A paginated list of resources.
+     * @param params
+     * @returns A paginated list of resources.
      */
     list(resourceType: ProjectResourceType, params?: ResourceParams): Promise<PageModel<ResourceModel>>;
 }

package/dist/types/resources/SchemaService/SchemaService.d.ts

@@ -1,8 +1,8 @@
 import API from '../../APICore.js';
-import Ressource from '../Resource.js';
 import { New } from '../BaseInterfaces.js';
-import { SchemaEntities, SchemaServiceQueryParams, SchemaServiceSource, CreateSchemaSourceModel, CreateSchemaSourceOptions, ObjectsToGet, SchemaEntityFields, SimpleSchemaEntity, GetEntitiesQueryParams, GetEntityQueryParams, SlackTokenValidationResult } from './SchemaServiceInterfaces.js';
 import { SourceType } from '../Enums.js';
+import Ressource from '../Resource.js';
+import { CreateSchemaSourceModel, CreateSchemaSourceOptions, GetEntitiesQueryParams, GetEntityQueryParams, ObjectsToGet, SchemaEntities, SchemaEntityFields, SchemaServiceQueryParams, SchemaServiceSource, SimpleSchemaEntity, SlackTokenValidationResult } from './SchemaServiceInterfaces.js';
 export default class SchemaService extends Ressource {
     protected api: API;
     protected serverlessApi: API;
@@ -11,31 +11,25 @@ export default class SchemaService extends Ressource {
     /**
      * Retrieve entities from the targeted instance
      * (can be matches of a given query)
-     *
-     * @param {SourceType} sourceType
-     * @param {GetEntitiesQueryParams} [parameters]
-     * @return {SchemaEntities} schemaEntities
-     * @memberof SchemaService
+     * @param sourceType
+     * @param [parameters]
+     * @returns schemaEntities
      */
     getEntities(sourceType: SourceType, parameters?: GetEntitiesQueryParams): Promise<SchemaEntities>;
     /**
      * Retrieve the entity of matching ID from the targeted instance
-     *
-     * @param {SourceType} sourceType
-     * @param {string} entityId
-     * @param {GetEntityQueryParams} [parameters]
-     * @return {SimpleSchemaEntity} simpleSchemaEntity
-     * @memberof SchemaService
+     * @param sourceType
+     * @param entityId
+     * @param [parameters]
+     * @returns simpleSchemaEntity
      */
     getEntity(sourceType: SourceType, entityId: string, parameters?: GetEntityQueryParams): Promise<SimpleSchemaEntity>;
     /**
      * Retrieve the fields of the given entity from the targeted instance
-     *
-     * @param {SourceType} sourceType
-     * @param {string} entityId
-     * @param {SchemaServiceQueryParams} [parameters]
-     * @return {SchemaEntityFields} schemaEntityFields
-     * @memberof SchemaService
+     * @param sourceType
+     * @param entityId
+     * @param [parameters]
+     * @returns schemaEntityFields
      */
     getFields(sourceType: SourceType, entityId: string, parameters?: SchemaServiceQueryParams): Promise<SchemaEntityFields>;
     delete(sourceId: string): Promise<Record<string, unknown>>;
@@ -48,13 +42,11 @@ export default class SchemaService extends Ressource {
     }>;
     translateToSpecificObjectsToGet(sourceType: SourceType, genericObjectsToGet: ObjectsToGet): Promise<any>;
     translateToSpecificObjectsToGetWithFields(sourceType: SourceType, genericObjectsToGet: ObjectsToGet, parameters?: SchemaServiceQueryParams): Promise<any>;
-    translateToGenericObjectsToGet(sourceType: SourceType, specificObjectsToGet: any): Promise<ObjectsToGet>;
+    translateToGenericObjectsToGet(sourceType: SourceType, specificObjectsToGet: Record<string, unknown>): Promise<ObjectsToGet>;
     /**
      * Retrieve the default objectsToGet of the given sourceType
-     *
-     * @param {string} sourceType
-     * @return {ObjectsToGet} ObjectsToGet
-     * @memberof SchemaService
+     * @param sourceType
+     * @returns ObjectsToGet
      */
     getDefaultObjectsToGet(sourceType: string): Promise<ObjectsToGet>;
     validateSlackToken(accessToken: string): Promise<SlackTokenValidationResult>;

package/dist/types/resources/SchemaService/SchemaServiceInterfaces.d.ts

@@ -151,8 +151,7 @@ export interface CreateSchemaSourceModel extends CreateSourceModel {
      */
     objectsToGetConfiguration?: string;
 }
-export interface CreateSchemaSourceOptions extends CreateSourceOptions {
-}
+export type CreateSchemaSourceOptions = CreateSourceOptions;
 /**
  * Wraps whether or not a Slack token can validly be used with a Slack source
  */

package/dist/types/resources/Search/Search.d.ts

@@ -9,7 +9,6 @@ export default class Search extends Resource {
     query(restQueryParameters: RestQueryParams): Promise<SearchResponse>;
     /**
      * Exports search results to a Microsoft Excel™ spreadsheet
-     *
      * @param restQueryParameters Parameters of the query
      * @returns A .xlsx file containing the search results of the specified query
      */
@@ -17,14 +16,25 @@ export default class Search extends Resource {
     querySuggestPost(restQuerySuggestParameters: PostSearchQuerySuggestBodyParams): Promise<any>;
     /**
      * Get an item's preview in HTML format
+     * @param root0
+     * @param root0.enableNavigation
+     * @param root0.findNext
+     * @param root0.findPrevious
+     * @param root0.organizationId
+     * @param root0.page
+     * @param root0.requestedOutputSize
+     * @param root0.uniqueId
+     * @param root0.viewAllContent
      */
     previewHTML({ enableNavigation, findNext, findPrevious, organizationId, page, requestedOutputSize, uniqueId, viewAllContent, ...body }: ItemPreviewHtmlParameters): Promise<string>;
     /**
      * Get item in JSON format
+     * @param params
      */
     getDocument(params: SingleItemParameters): Promise<RestQueryResult>;
     /**
      * Executes a facet search request.
+     * @param params
      */
     searchFacet(params: RestFacetSearchParameters): Promise<RestFacetSearchResponse>;
 }