@coveo/platform-client 55.13.2 → 56.1.0

package/dist/esm/utils/stringifyNestedObjects.js.map

@@ -1 +1 @@
-{"version":3,"file":"stringifyNestedObjects.js","sourceRoot":"","sources":["../../../src/utils/stringifyNestedObjects.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,GAAW,EAAU,EAAE;IAC1D,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QAC7B,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACvB,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9D,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAC9C,CAAC;IACL,CAAC,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACf,CAAC,CAAC"}
+{"version":3,"file":"stringifyNestedObjects.js","sourceRoot":"","sources":["../../../src/utils/stringifyNestedObjects.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAmB,GAAM,EAAK,EAAE;IAClE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QAC7B,MAAM,KAAK,GAAG,GAAG,CAAC,GAAc,CAAC,CAAC;QAClC,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9D,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAC9C,CAAC;IACL,CAAC,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACf,CAAC,CAAC"}

package/dist/types/APICore.d.ts

@@ -11,12 +11,12 @@ export default class API {
     get organizationId(): string;
     get<T = Record<string, unknown>>(url: string, args?: CoveoPlatformClientRequestInit): Promise<T>;
     post<T = Record<string, unknown>>(url: string, body: undefined, args?: CoveoPlatformClientRequestInit): Promise<T>;
-    post<T = Record<string, unknown>>(url: string, body?: any, args?: Omit<CoveoPlatformClientRequestInit, 'body'>): Promise<T>;
+    post<T = Record<string, unknown>>(url: string, body?: object, args?: Omit<CoveoPlatformClientRequestInit, 'body'>): Promise<T>;
     postForm<T = Record<string, unknown>>(url: string, body: FormData, args?: Omit<CoveoPlatformClientRequestInit, 'body'>): Promise<T>;
     put<T = Record<string, unknown>>(url: string, body: undefined, args?: CoveoPlatformClientRequestInit): Promise<T>;
-    put<T = Record<string, unknown>>(url: string, body?: any, args?: Omit<CoveoPlatformClientRequestInit, 'body'>): Promise<T>;
+    put<T = Record<string, unknown>>(url: string, body?: object, args?: Omit<CoveoPlatformClientRequestInit, 'body'>): Promise<T>;
     patch<T = Record<string, unknown>>(url: string, body: undefined, args?: CoveoPlatformClientRequestInit): Promise<T>;
-    patch<T = Record<string, unknown>>(url: string, body?: any, args?: Omit<CoveoPlatformClientRequestInit, 'body'>): Promise<T>;
+    patch<T = Record<string, unknown>>(url: string, body?: object, args?: Omit<CoveoPlatformClientRequestInit, 'body'>): Promise<T>;
     delete<T = Record<string, unknown>>(url: string, args?: CoveoPlatformClientRequestInit): Promise<T>;
     abortGetRequests(): void;
     checkToken(): Promise<void>;

package/dist/types/handlers/request/RequestHandlerInterfaces.d.ts

@@ -9,7 +9,6 @@ export interface RequestHandler {
     canProcess: Predicate<EnrichedRequestInit>;
     /**
      * How to process the requests.
-     *
      * @param request The [request object](https://developer.mozilla.org/en-US/docs/Web/API/Request).
      */
     process(request: EnrichedRequestInit): EnrichedRequestInit;

package/dist/types/handlers/response/ResponseHandlers.d.ts

@@ -1,9 +1,15 @@
 import 'core-js/actual/json/parse.js';
 import { Predicate } from '../../utils/types.js';
 import { ResponseBodyFormat, ResponseHandler } from './ResponseHandlerInterfaces.js';
-/** Check whether the response status is `204 No Content`. */
+/**
+ * Check whether the response status is `204 No Content`.
+ * @param response
+ */
 export declare const isNoContent: Predicate<Response>;
-/** Check whether the response is considered to have any "ok" status code (not just 200). */
+/**
+ * Check whether the response is considered to have any "ok" status code (not just 200).
+ * @param response
+ */
 export declare const isAnyOkStatus: Predicate<Response>;
 export declare const ResponseHandlers: Readonly<{
     noContent: ResponseHandler;

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

@@ -9,9 +9,8 @@ export default class Activity extends Resource {
     getResourceTypes(): Promise<string[]>;
     /**
      * Retrieves a list of ActivityOperation for a given organization.
-     *
-     * @param {boolean} includeInternal Whether or not to include internal operations.
-     * @returns {Promise<ActivityOperation[]>} A list of activity operations.
+     * @param includeInternal Whether or not to include internal operations.
+     * @returns A list of activity operations.
      */
     getOperationTypes(includeInternal?: boolean): Promise<ActivityOperation[]>;
     getListOfResourcesAndOperations(): Promise<ActivitiesResourceAndOperations>;

package/dist/types/resources/AnalyticsAdmin/Properties/Properties.d.ts

@@ -5,40 +5,41 @@ export default class Properties extends Resource {
     static baseUrl: string;
     /**
      * Build the request path, handling the optional `org` query parameter.
-     *
      * @param route The path part of the request.
      * @param queryParams Optional query parameters object.
      * If this object contains an `org` property, it will override the value from the configuration.
      * @returns The request path including formatted query parameters.
      */
-    protected buildPathWithOrg(route: string, queryParams?: any): string;
+    protected buildPathWithOrg(route: string, queryParams?: object): string;
     /**
      * List all properties
-     *
+     * @param params
      * @returns Promise<PageModel<PropertyModel>>
      */
     list(params?: ListPropertiesParams): Promise<PageModel<PropertyModel>>;
     /**
      * Get a property
-     *
+     * @param trackingId
      * @returns Promise<PropertyModel>
      */
     get(trackingId: string): Promise<PropertyModel>;
     /**
      * Create a property
-     *
+     * @param trackingId
+     * @param displayName
      * @returns Promise<PropertiesResponseMessage>
      */
     create(trackingId: string, displayName: string): Promise<PropertiesResponseMessage>;
     /**
      * Edit a property
-     *
+     * @param trackingId
+     * @param displayName
      * @returns Promise<PropertiesResponseMessage>
      */
     update(trackingId: string, displayName: string): Promise<PropertiesResponseMessage>;
     /**
      * Delete a property
-     *
+     * @param trackingId
      * @returns Promise<PropertiesResponseMessage>
      */
     delete(trackingId: string): Promise<PropertiesResponseMessage>;

package/dist/types/resources/CaseAssistConfigs/CaseAssistConfigInterfaces.d.ts

@@ -10,8 +10,7 @@ export declare enum CaseClassificationStrategies {
     Some = "Some",
     Axon = "Axon"
 }
-export interface CaseAssistConfigListOptions extends Paginated {
-}
+export type CaseAssistConfigListOptions = Paginated;
 export interface ITDConfigurationModel {
     pipeline?: string;
     filter?: string;

package/dist/types/resources/Catalogs/Catalog.d.ts

@@ -8,6 +8,8 @@ export default class Catalog extends Resource {
     delete(catalogId: string): Promise<Record<string, unknown>>;
     get(catalogId: string): Promise<CatalogModel>;
     /**
+     * @param catalogId
+     * @param options
      * @deprecated getFields(catalogId: string, options?: CatalogFieldsOptions) is kept for backward compatibility, you should now use `getFieldStats(catalogId: string, options?: CatalogFieldStatsOptions)`.
      */
     getFields(catalogId: string, options?: CatalogFieldsOptions): Promise<CachedCatalogFieldsModel>;

package/dist/types/resources/Catalogs/ProductListing.d.ts

@@ -8,22 +8,32 @@ export default class ProductListing extends Resource {
     static baseCatalogsUrl: string;
     static baseProductListingsUrl: string;
     /**
+     * @param catalogId
+     * @param options
      * @deprecated
      */
     list(catalogId: string, options?: ProductListingsListOptions): Promise<PageModel<ProductListingModel>>;
     /**
+     * @param catalogId
+     * @param model
      * @deprecated
      */
     create(catalogId: string, model: New<ProductListingModel>): Promise<ProductListingModel>;
     /**
+     * @param catalogId
+     * @param productListingId
      * @deprecated
      */
     delete(catalogId: string, productListingId: string): Promise<Record<string, unknown>>;
     /**
+     * @param catalogId
+     * @param productListingId
      * @deprecated
      */
     get(catalogId: string, productListingId: string): Promise<ProductListingModel>;
     /**
+     * @param catalogId
+     * @param model
      * @deprecated
      */
     update(catalogId: string, model: ProductListingModel): Promise<ProductListingModel>;

package/dist/types/resources/Catalogs/ProductListingConfiguration.d.ts

@@ -7,22 +7,38 @@ import { ProductListingConfigurationModel, ProductListingConfigurationOptions }
 export default class ProductListingConfiguration extends Resource {
     static baseUrl: string;
     /**
+     * @param catalogId
+     * @param productListingId
+     * @param options
      * @deprecated
      */
     list(catalogId: string, productListingId: string, options?: ProductListingConfigurationOptions): Promise<PageModel<ProductListingConfigurationModel>>;
     /**
+     * @param catalogId
+     * @param productListingId
+     * @param rankingConfiguration
      * @deprecated
      */
     create(catalogId: string, productListingId: string, rankingConfiguration: New<ProductListingConfigurationModel>): Promise<Record<string, unknown>>;
     /**
+     * @param catalogId
+     * @param productListingId
+     * @param productListingConfigurationId
      * @deprecated
      */
     delete(catalogId: string, productListingId: string, productListingConfigurationId: string): Promise<Record<string, unknown>>;
     /**
+     * @param catalogId
+     * @param productListingId
+     * @param productListingConfigurationId
      * @deprecated
      */
     get(catalogId: string, productListingId: string, productListingConfigurationId: string): Promise<ProductListingConfigurationModel>;
     /**
+     * @param catalogId
+     * @param productListingId
+     * @param productListingConfigurationId
+     * @param rankingConfiguration
      * @deprecated
      */
     update(catalogId: string, productListingId: string, productListingConfigurationId: string, rankingConfiguration: New<ProductListingConfigurationModel>): Promise<Record<string, unknown>>;

package/dist/types/resources/CrawlingModule/CrawlingModuleInterfaces.d.ts

@@ -186,14 +186,10 @@ export interface CrawlingModuleDeployment {
     name: string;
     /**
      * The status of the Crawling Module
-     *
-     * @type {CrawlingModuleStatus}
      */
     status?: CrawlingModuleStatus;
     /**
      * The component versions of the Crawling Module
-     *
-     * @type {ComponentVersion}.
      */
     versions: ComponentVersion;
 }

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

@@ -11,16 +11,18 @@ export default class Extension extends Resource {
     list(): Promise<ExtensionModel[]>;
     /**
      * Lists all versions of an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
+     * @param extensionId
      */
     listVersions(extensionId: string): Promise<ExtensionContentVersionModel[]>;
     /**
      * Shows a specific version of an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
+     * @param extensionId
+     * @param versionId
      */
     getVersion(extensionId: string, versionId: string): Promise<ExtensionModel>;
     /**
      * Validates the extension's script
-     *
-     * @param {ExtensionCompileCode} extensionCode The code to compile
+     * @param extensionCode The code to compile
      */
     validateCode(extensionCode: ExtensionCompileCode): Promise<ExtensionCompileResult>;
 }

package/dist/types/resources/Extensions/ExtensionsInterfaces.d.ts

@@ -93,13 +93,11 @@ export interface ExtensionCompileError {
 export interface ExtensionContentVersionModel {
     /**
      * The date at which the extension version was created (in number of milliseconds since UNIX epoch), i.e., the date of the modification of the extension when this extension version was created.
-     *
      * @example 1556308241000
      */
     lastModified: number;
     /**
      * The unique identifier of the extension target version.
-     *
      * @example hdJSDb4hTkdnsCynNtF.d657FgLSDydcj
      */
     id: string;

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

@@ -12,6 +12,7 @@ export default class Field extends Resource {
     get(fieldId: string): Promise<FieldModel>;
     update(fieldId: string, options: FieldModel): Promise<Record<string, unknown>>;
     /**
+     * @param params
      * @deprecated list(params?: ListFieldsParams) is kept for backward compatibility, you should now use `search(params?: FieldListingOptions)`.
      */
     list(params?: ListFieldsParams): Promise<PageModel<FieldModel>>;

package/dist/types/resources/HostedInterfacesCore/HostedInterfaceVersionsCore.d.ts

@@ -76,13 +76,11 @@ export interface HostedInterfaceVersion<T> {
 export interface ListHostedInterfaceVersionsParams extends Paginated {
     /**
      * The zero-based page to retrieve.
-     *
      * @default `0`
      */
     page?: number;
     /**
      * The number of versions to return per page.
-     *
      * @default `10`
      */
     perPage?: number;
@@ -97,7 +95,6 @@ export interface ListHostedInterfaceVersionsParams extends Paginated {
      * - `undefined`: Configurations are returned in no specific order.
      * - `asc`: Sort version by number in ascending order.
      * - `desc`: Sort version by number in descending order.
-     *
      * @default `undefined`
      */
     order?: 'asc' | 'desc';
@@ -135,13 +132,11 @@ export interface IAccesses {
     domains: string[];
     /**
      * When set to true, all users can share and see the search page.
-     *
      * @default false
      */
     sharingLinkEnabled?: boolean;
     /**
      * When set to true, the domain sharing is enabled. Otherwise, only users that have explicitly access to the search page can access it.
-     *
      * @default false
      */
     sharingDomainEnabled?: boolean;

package/dist/types/resources/IPXInterfaces/IPXInterface.model.d.ts

@@ -3,10 +3,8 @@ export declare enum IPXResultTemplateLayout {
     Default = "default",
     Thumbnail = "thumbnail"
 }
-export interface IPXFacet extends HostedInterfaceFacet {
-}
-export interface IPXCondition extends HostedInterfaceCondition {
-}
+export type IPXFacet = HostedInterfaceFacet;
+export type IPXCondition = HostedInterfaceCondition;
 export interface IPXTab extends HostedInterfaceTab {
     /**
      * A constant query expression or filter that the Tab should add to any outgoing query.
@@ -17,10 +15,8 @@ export interface IPXTab extends HostedInterfaceTab {
      */
     conditions: IPXCondition[];
 }
-export interface IPXResultTemplateBadge extends HostedInterfaceResultTemplateBadge {
-}
-export interface IPXResultTemplateDetail extends HostedInterfaceResultTemplateDetail {
-}
+export type IPXResultTemplateBadge = HostedInterfaceResultTemplateBadge;
+export type IPXResultTemplateDetail = HostedInterfaceResultTemplateDetail;
 export interface IPXResultTemplate extends HostedInterfaceResultTemplate {
     layout: IPXResultTemplateLayout;
     /**

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

@@ -26,6 +26,7 @@ export default class InProductExperiences extends Resource {
     /**
      * `delete` is a helper method based on observed behavior of the Coveo UI where deletion logic calls out to the
      * Search Pages endpoint to delete an IPX.
+     * @param ipxId
      */
     delete(ipxId: string): Promise<Record<string, unknown>>;
 }

package/dist/types/resources/InProductExperiences/InProductExperiencesInterfaces.d.ts

@@ -327,7 +327,6 @@ export interface IPXButtonModel {
     /**
      * The button host's CSS selector, which defines where the button is rendered.
      * If unset, it defaults to "" and renders a floating button in the `<body>`.
-     *
      * @default `""`
      */
     buttonTargetSelector: string;

package/dist/types/resources/Indexes/Documents/Documents.d.ts

@@ -5,18 +5,15 @@ export default class Documents extends Resource {
     static baseUrl: string;
     /**
      * Lists the [permissions](https://docs.coveo.com/en/223/glossary/permission) of an [item](https://docs.coveo.com/en/210/glossary/item) in a Coveo Cloud organization index.
-     *
-     * @param {string} indexId The unique identifier of the target index.
-     * @param {string} documentId The unique identifier of the item whose permissions to list.
-     *
+     * @param indexId The unique identifier of the target index.
+     * @param documentId The unique identifier of the item whose permissions to list.
      */
     listPermissions(indexId: string, documentId: string): Promise<DocumentPermissionModel>;
     /**
      * Lists the [effective permissions](https://docs.coveo.com/en/194/glossary/effective-permissions) of an [item](https://docs.coveo.com/en/210/glossary/item) in a Coveo Cloud organization index.
-     *
-     * @param {string} indexId The unique identifier of the target index.
-     * @param {string} documentId The unique identifier of the item whose permissions to list.
-     * @param {ListEffectivePermissionsOptions} options
+     * @param indexId The unique identifier of the target index.
+     * @param documentId The unique identifier of the item whose permissions to list.
+     * @param options
      */
     listEffectivePermissions(indexId: string, documentId: string, options?: ListEffectivePermissionsOptions): Promise<SinglePermissionPageModel>;
 }

package/dist/types/resources/InsightPanelConfigs/InsightPanelConfigInterfaces.d.ts

@@ -5,13 +5,11 @@ import { Paginated, WithRequired } from '../BaseInterfaces.js';
 export interface InsightPanelConfigListOptions extends Paginated {
     /**
      * The zero-based page to retrieve.
-     *
      * @default `0`
      */
     page?: number;
     /**
      * The number of configurations to return per page.
-     *
      * @default `10`
      */
     perPage?: number;
@@ -26,7 +24,6 @@ export interface InsightPanelConfigListOptions extends Paginated {
      * - `undefined`: Configurations are returned in no specific order.
      * - `asc`: Sort configurations by name in ascending order.
      * - `desc`: Sort configurations by name in descending order.
-     *
      * @default `undefined`
      */
     order?: 'asc' | 'desc';
@@ -53,7 +50,6 @@ export interface InsightPanelConfigCreationParams {
      * The key is the context information such as `subject` or `description`.
      *
      * The value is a CRM reference allowing the Insight Panel integration to retrieve the context information from the CRM.
-     *
      * @example
      * ```json
      * {
@@ -153,7 +149,6 @@ export interface InsightPanelConfigModel {
      * The key is the context information such as `subject` or `description`.
      *
      * The value is a CRM reference allowing the Insight Panel integration to retrieve the context information from the CRM.
-     *
      * @example
      * ```json
      * {

package/dist/types/resources/InsightPanelInterfaces/InsightPanelInterface.model.d.ts

@@ -4,18 +4,14 @@ export declare enum InsightPanelResultTemplateLayout {
     Default = "default",
     Thumbnail = "thumbnail"
 }
-interface InsightPanelOption extends HostedInterfaceOption {
-}
+type InsightPanelOption = HostedInterfaceOption;
 interface InsightPanelResultTagOptions {
     enabled: boolean;
     color: string;
 }
-export interface InsightPanelResultTemplateBadge extends HostedInterfaceResultTemplateBadge {
-}
-export interface InsightPanelCondition extends HostedInterfaceCondition {
-}
-export interface InsightPanelResultTemplateDetail extends HostedInterfaceResultTemplateDetail {
-}
+export type InsightPanelResultTemplateBadge = HostedInterfaceResultTemplateBadge;
+export type InsightPanelCondition = HostedInterfaceCondition;
+export type InsightPanelResultTemplateDetail = HostedInterfaceResultTemplateDetail;
 export interface InsightPanelResultActions {
     /**
      * An option enabling the ability to attach a given result to a case record.
@@ -81,8 +77,7 @@ export interface InsightPanelResultTemplate extends HostedInterfaceResultTemplat
      */
     tags: InsightPanelResultTags;
 }
-export interface InsightPanelFacet extends HostedInterfaceFacet {
-}
+export type InsightPanelFacet = HostedInterfaceFacet;
 export interface InsightPanelTab extends HostedInterfaceTab {
     /**
      * A constant query expression or filter that the Tab should add to any outgoing query.
@@ -156,14 +151,12 @@ export interface InsightPanelInterfaceConfiguration extends HostedInterfaceConfi
      */
     publishedVersion?: number;
 }
-export interface IListInsightPanelInterfacesParameters extends ListHostedInterfacesParams {
-}
+export type IListInsightPanelInterfacesParameters = ListHostedInterfacesParams;
 export interface InsightPanelInterfaceConfigurationUpdateParams extends Omit<InsightPanelInterfaceConfiguration, 'settings' | 'publishedVersion'>, UpdateVersionedHostedInterfaceExtraParams {
     /**
      * The insight panel settings.
      */
     settings: WithOptional<InsightPanelSettings, 'smartSnippets' | 'disableDynamicNavigation'>;
 }
-export interface InsightPanelInterfaceVersion extends HostedInterfaceVersion<InsightPanelInterfaceConfiguration> {
-}
+export type InsightPanelInterfaceVersion = HostedInterfaceVersion<InsightPanelInterfaceConfiguration>;
 export {};

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

@@ -5,7 +5,6 @@ export interface DeprecatedPaginated {
     page?: number;
     /**
      * The number of elements to list per page.
-     *
      * @deprecated use @see {Paginated} and @see {perPage} instead.
      */
     pageSize?: number;

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

@@ -11,7 +11,6 @@ export default class Limits extends Resource {
     getAllPerLimitType(limitType: LimitType): Promise<AllLimitsModel>;
     /**
      * Shows the status of a specific limit in an organization
-     *
      * @param sectionName The name of the target license section
      * @param limitKey The unique identifier of the target limit status to show
      */

package/dist/types/resources/MachineLearning/CaseClassificationConfiguration/CaseClassificationConfiguration.d.ts

@@ -7,18 +7,22 @@ export default class CaseClassificationConfiguration extends Resource {
     static fieldsUrl: string;
     static previewUrl: string;
     /**
+     * @param configModel
      * @deprecated create(configModel: CaseClassificationConfigurationModel) is kept for backward compatibility. You should now use MachineLearning `register(registration: RegistrationModel)` instead.
      */
     create(configModel: New<CaseClassificationConfigurationModel, 'modelId'>): Promise<CaseClassificationConfigurationModel>;
     /**
+     * @param modelId
      * @deprecated delete(modelId: string) is kept for backward compatibility. You should now use Models `delete(modelId: string)` instead.
      */
     delete(modelId: string): Promise<Record<string, unknown>>;
     /**
+     * @param modelId
      * @deprecated get(modelId: string) is kept for backward compatibility. You should now use Models `get(modelId: string)` instead.
      */
     get(modelId: string): Promise<CaseClassificationConfigurationModel>;
     /**
+     * @param configModel
      * @deprecated update(configModel: CaseClassificationConfigurationModel) is kept for backward compatibility. You should now use Models `update(modelId: string, update: RegistrationModel)` instead.
      */
     update(configModel: CaseClassificationConfigurationModel): Promise<CaseClassificationConfigurationModel>;

package/dist/types/resources/MachineLearning/DocumentInterfaces.d.ts

@@ -5,7 +5,6 @@ export interface DocumentPreviewParamsAdvanced {
     filterConditions?: never;
     /**
      * The query that determines the documents to extract. Cannot be used with other document extraction parameters, e.g. sources, filter conditions, etc.
-     *
      * @Example @source==("My source") AND @permanentid AND @language="English";
      */
     advancedQuery: string;

package/dist/types/resources/MachineLearning/IAPRConfiguration/IAPRConfigurationInterfaces.d.ts

@@ -10,7 +10,6 @@ export interface IAPRConfigurationModel {
     modelDisplayName: string;
     /**
      * The trackingIds that usage analytics events must contain for the model to use those events in its learning process. The model will use an event if it contains at least one of the specified IDs
-     *
      * @Example: [ "sport" ]
      */
     trackingIds: string[];

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

@@ -2,15 +2,16 @@ import API from '../../APICore.js';
 import Resource from '../Resource.js';
 import CaseClassificationConfiguration from './CaseClassificationConfiguration/CaseClassificationConfiguration.js';
 import DNEConfiguration from './DNEConfiguration/DNEConfiguration.js';
-import SmartSnippetsConfiguration from './SmartSnippetsConfiguration/SmartSnippetsConfiguration.js';
+import IAPRConfiguration from './IAPRConfiguration/IAPRConfiguration.js';
 import { MLModelCreated, RegistrationModel } from './MachineLearningInterfaces.js';
+import ModelDetailedInfo from './ModelDetailedInfo/ModelDetailedInfo.js';
+import ModelListing from './ModelListing/ModelListing.js';
 import Models from './Models/Models.js';
 import PQSConfiguration from './PQSConfiguration/PQSConfiguration.js';
-import UserActionHistoryConfiguration from './UserActionHistoryConfiguration/UserActionHistoryConfiguration.js';
-import IAPRConfiguration from './IAPRConfiguration/IAPRConfiguration.js';
-import ModelListing from './ModelListing/ModelListing.js';
 import RelevanceGenerativeAnsweringConfiguration from './RGAConfiguration/RelevanceGenerativeAnsweringConfiguration.js';
 import SemanticEncoderConfiguration from './SemanticEncoderConfiguration/SemanticEncoderConfiguration.js';
+import SmartSnippetsConfiguration from './SmartSnippetsConfiguration/SmartSnippetsConfiguration.js';
+import UserActionHistoryConfiguration from './UserActionHistoryConfiguration/UserActionHistoryConfiguration.js';
 export default class MachineLearning extends Resource {
     protected api: API;
     protected serverlessApi: API;
@@ -25,6 +26,7 @@ export default class MachineLearning extends Resource {
     modelListing: ModelListing;
     relevanceGenerativeAnsweringConfig: RelevanceGenerativeAnsweringConfiguration;
     semanticEncoderConfig: SemanticEncoderConfiguration;
+    modelDetailedInfo: ModelDetailedInfo;
     constructor(api: API, serverlessApi: API);
     register(registration: RegistrationModel): Promise<MLModelCreated>;
 }

package/dist/types/resources/MachineLearning/MachineLearningInterfaces.d.ts

@@ -85,3 +85,14 @@ export interface MLModelCreated extends New<MLModel> {
     startTime?: number;
     resourceId?: string;
 }
+export declare enum MLModelStatus {
+    ARCHIVED = "ARCHIVED",
+    SOON_TO_BE_ARCHIVED = "SOON_TO_BE_ARCHIVED",
+    BUILD_IN_PROGRESS = "BUILD_IN_PROGRESS",
+    ERROR = "ERROR",
+    ERROR_INTERNAL = "ERROR_INTERNAL",
+    LIMITED = "LIMITED",
+    NOT_ASSOCIATED = "NOT_ASSOCIATED",
+    ACTIVE = "ACTIVE",
+    INACTIVE = "INACTIVE"
+}

package/dist/types/resources/MachineLearning/ModelDetailedInfo/ModelDetailedInfo.d.ts

@@ -0,0 +1,6 @@
+import Resource from '../../Resource.js';
+import { ModelWithDetails } from './ModelDetailedInfoInterfaces.js';
+export default class ModelDetailedInfo extends Resource {
+    static baseUrl: string;
+    get(modelId: string): Promise<ModelWithDetails>;
+}