npm - @coveo/platform-client - Versions diffs - 55.13.2 → 56.0.0 - Mend

@coveo/platform-client 55.13.2 → 56.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (271) hide show

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

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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/ModelListing/ModelListingInterfaces.d.ts CHANGED Viewed

@@ -1,43 +1,36 @@
 export interface MLListingModel {
     /**
      * The model display name in the Coveo Administration console.
-     *
      * @Example `MyModelDisplayName`
      */
     modelDisplayName: string;
     /**
      * The unique identifier of the target machine learning model.
-     *
      * @Example `My_Model_ID`
      */
     modelId: string;
     /**
      * The id of the engine.
-     *
      * @Example `topclicks`
      */
     engineId: string;
     /**
      * The date and time the model was last updated.
-     *
      * @Example `1691762520000`
-     **/
+     */
     estimatedPreviousModelUpdateTime: number;
     /**
      * The date and time the model is scheduled to start its next update.
-     *
      * @Example `1691762520000`
      */
     nextModelUpdateTime: number;
     /**
      * Version of the platform.
-     *
      * @Example `2`
      */
     platformVersion: 1 | 2;
     /**
      * The model size statistic. Depending on the model type, this value represents the number of items or queries on which the model was built.
-     *
      * @Example `5`
      */
     modelSizeStatistic: number;
@@ -55,13 +48,11 @@ export interface MLListingModel {
 export interface MLModelStatusInfo {
     /**
      * The status of the model.
-     *
      * @Example `ACTIVE`
      */
     modelStatus: 'ARCHIVED' | 'SOON_TO_BE_ARCHIVED' | 'BUILD_IN_PROGRESS' | 'ERROR' | 'ERROR_INTERNAL' | 'LIMITED' | 'NOT_ASSOCIATED' | 'ACTIVE' | 'INACTIVE';
     /**
      * The remaining days until the model is archived.
-     *
      * @Example `4`
      */
     daysUntilArchival?: number;
@@ -69,25 +60,21 @@ export interface MLModelStatusInfo {
 export interface MLModelAssociation {
     /**
      * The unique identifier of the query pipeline to which the model is associated.
-     *
      * @Example `38b08160-d7d4-4626-8e03-53587c23415d`
      */
     parentId: string;
     /**
      * The unique identifier of the model association.
-     *
      * @Example `917af358-13fd-4c8e-94af-7cf649bddc48`
      */
     id: string;
     /**
      * The name of the query pipeline or case assist configuration the model is associated with.
-     *
      * @Example `association name`
      */
     name: string;
     /**
      * The type of the association.
-     *
      * @Example `QUERY_PIPELINE`
      */
     associationType: 'QUERY_PIPELINE' | 'CASE_ASSIST';

package/dist/types/resources/MachineLearning/PQSConfiguration/PQSConfigurationInterfaces.d.ts CHANGED Viewed

@@ -39,7 +39,6 @@ export interface PQSConfigurationModel {
     searchEventFilter?: 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/RGAConfiguration/RelevanceGenerativeAnsweringConfigurationInterface.d.ts CHANGED Viewed

@@ -2,7 +2,6 @@ import { DocumentRequirementStatus } from '../DocumentInterfaces.js';
 export interface RelevanceGenerativeAnsweringDocumentGroupPreview {
     /**
      * The query that was used to fetch document information.
-     *
      * @Example @source==("Salesforce Notifier")
      */
     query: string;
@@ -28,7 +27,6 @@ export interface RelevanceGenerativeAnsweringDocumentGroupPreview {
     documentLimit: number;
     /**
      * Status for the number of required documents to build the model.
-     *
      * @Example OK
      */
     documentRequirementStatus: DocumentRequirementStatus;

package/dist/types/resources/MachineLearning/SemanticEncoderConfiguration/SemanticEncoderConfigurationInterfaces.d.ts CHANGED Viewed

@@ -2,7 +2,6 @@ import { DocumentRequirementStatus } from '../DocumentInterfaces.js';
 export interface SemanticEncoderDocumentGroupPreview {
     /**
      * The query that was used to fetch document information.
-     *
      * @Example @source==("Salesforce Notifier")
      */
     query: string;
@@ -28,7 +27,6 @@ export interface SemanticEncoderDocumentGroupPreview {
     documentLimit: number;
     /**
      * Status for the number of required documents to build the model.
-     *
      * @Example OK
      */
     documentRequirementStatus: DocumentRequirementStatus;

package/dist/types/resources/MachineLearning/SmartSnippetsConfiguration/SmartSnippetsConfigurationInterfaces.d.ts CHANGED Viewed

@@ -13,7 +13,6 @@ export interface DocumentType {
 export interface SmartSnippetsDocumentGroupPreview {
     /**
      * The query that was used to fetch document information.
-     *
      * @Example @source==("Salesforce Notifier")
      */
     query: string;
@@ -47,7 +46,6 @@ export interface SmartSnippetsDocumentGroupPreview {
     numberOfDocumentsInSourcesMatchingFiltersWithPermanentId: number;
     /**
      * Status for the number of required documents to build the model.
-     *
      * @Example OK
      */
     documentRequirementStatus: DocumentRequirementStatus;

package/dist/types/resources/Organizations/Members/Members.d.ts CHANGED Viewed

@@ -11,13 +11,11 @@ export default class Members extends Resource {
     /**
      * deletes the member from all groups of an organization.
      * Note: Deleted users can still be included by domain.
-     *
      * @param username The username of the member to delete.
      */
     delete(username: string): Promise<void>;
     /**
      * Shows a member of an organization.
-     *
      * @param username  The username of the member to show.
      */
     get(username: string): Promise<OrganizationMemberModel>;
@@ -27,19 +25,19 @@ export default class Members extends Resource {
     getPrivileges(): Promise<GlobalPrivilegeModel[]>;
     /**
      * Updates the members of an organization.
-     *
      * @param sendEmailToInvitedUsers Whether to send an invitation email alongside the invite(s). Default to true.
+     * @param model
+     * @param options
      */
     updateOrganizationMembers(model: OrganizationMemberModel[], options?: UpdateGroupOptions): Promise<OrganizationMemberModel[]>;
     /**
      * Updates a member of an organization.
-     *
      * @param username The username of the member to update.
+     * @param model
      */
     updateMember(username: string, model: OrganizationMemberModel): Promise<OrganizationMemberModel>;
     /**
      * Lists the groups to which an organization member belongs.
-     *
      * @param username The username of the user for which to list groups.
      */
     getGroups(username: string): Promise<GroupModel[]>;

package/dist/types/resources/Organizations/Organization.d.ts CHANGED Viewed

@@ -22,15 +22,17 @@ export default class Organization extends Resource {
     /**
      * Pauses an [organization](https://docs.coveo.com/en/222/).
      * Required privilege: Organization - Edit
+     * @param organizationId
      */
     pause(organizationId?: string): Promise<Record<string, unknown>>;
     /**
      * Resumes a paused [organization](https://docs.coveo.com/en/222/).
      * Required privilege: Organization - Edit
+     * @param organizationId
      */
     resume(organizationId?: string): Promise<Record<string, unknown>>;
     updateAdditionalInformation(additionalInformationObj: Record<string, unknown>): Promise<Record<string, unknown>>;
-    getAdditionalInformation(organizationId?: string): Promise<any>;
+    getAdditionalInformation(organizationId?: string): Promise<Record<string, unknown>>;
     updateExperimentalStatus(allowed?: boolean): Promise<boolean>;
     listPrivileges(): Promise<PrivilegeModel[]>;
     listMyPrivileges(): Promise<PrivilegeModel[]>;

package/dist/types/resources/Organizations/OrganizationInterfaces.d.ts CHANGED Viewed

@@ -21,7 +21,6 @@ export interface OrganizationsStatusModel {
      * - `ACTIVE`: The organization is healthy and fully functional.
      * - `PAUSED`: The organization is currently inactive.
      * - `DELETING`: The organization is currently in the process of being deleted.
-     *
      * @example `PAUSED`
      */
     lifeCycleState: string;
@@ -36,7 +35,6 @@ export interface OrganizationsStatusModel {
      * - `RESUMING`: The organization is transitioning to `ACTIVE`.
      * - `PAUSING_FAILED`: The organization threw an error while transitioning to `PAUSED`.
      * - `RESUMING_FAILED`: The organization threw an error while transitioning to `ACTIVE`.
-     *
      * @example `PAUSED`
      */
     pauseState: string;
@@ -50,7 +48,6 @@ export interface OrganizationsStatusModel {
     provisioningStatus: {
         /**
          * The progress, in percentage, of the ongoing provisioning.
-         *
          * @example `100`
          */
         currentProvisioningProgress: number;
@@ -60,7 +57,6 @@ export interface OrganizationsStatusModel {
         initialProvisioningDone: boolean;
         /**
          * The last time provisioning was successfully completed in number of milliseconds since UNIX epoch.
-         *
          * @example `1556722921779`
          */
         lastProvisioningCompletedDate: number;
@@ -81,7 +77,6 @@ export interface OrganizationsStatusModel {
      * Whether the organization enforces all of its resources (e.g., query pipelines, sources, etc.) to be read-only.
      *
      * **Note:** This parameter is typically only updated when an organization is inactive.
-     *
      * @default `false`
      */
     readOnly: boolean;
@@ -91,7 +86,6 @@ export interface OrganizationsStatusModel {
      * **Allowed values:**
      * - `HEALTHY`: The organization is healthy and fully functional.
      * - `ERROR`: The organization has thrown an error and is currently inactive.
-     *
      * @example `ERROR`
      */
     status: string;
@@ -117,7 +111,7 @@ export interface OrganizationModel {
         servingExperimentAllowed: boolean;
     };
 }
-export type AdditionalOrganizationField = 'status' | 'license' | string;
+export type AdditionalOrganizationField = 'status' | 'license' | (string & {});
 export interface GetOrganizationOptions {
     additionalFields?: AdditionalOrganizationField | AdditionalOrganizationField[];
 }

package/dist/types/resources/Pipelines/Conditions/Condition.d.ts CHANGED Viewed

@@ -5,38 +5,32 @@ export default class Condition extends Resource {
     static baseUrl: string;
     /**
      * Returns a paginated list of condition models.
-     *
-     * @param {ListConditionsOptions} options
+     * @param options
      */
     list(options?: ListConditionsOptions): Promise<PageModel<ConditionModel, "statements">>;
     /**
      * Creates and returns a new condition model.
-     *
-     * @param {NewConditionModel} conditionModel
+     * @param conditionModel
      */
     create(conditionModel: NewConditionModel): Promise<ConditionModel>;
     /**
      * Delete a condition model.
-     *
-     * @param {string} conditionId The unique identifier of the condition to be deleted.
+     * @param conditionId The unique identifier of the condition to be deleted.
      */
     delete(conditionId: string): Promise<Record<string, unknown>>;
     /**
      * Returns a condition model.
-     *
-     * @param {string} conditionId The unique identifier of the condition to be fetched.
+     * @param conditionId The unique identifier of the condition to be fetched.
      */
     get(conditionId: string): Promise<ConditionModel>;
     /**
      * Update a condition model with the model sent and returns the updated condition model.
-     *
-     * @param {string} conditionId The unique identifier of the condition to be updated.
-     * @param {ConditionModel | NewConditionModel} conditionModel
+     * @param conditionId The unique identifier of the condition to be updated.
+     * @param conditionModel
      */
     update(conditionId: string, conditionModel: ConditionModel | NewConditionModel): Promise<ConditionModel>;
     /**
      * Bulk get a list of conditions corresponding of the ids sent.
-     *
      * @param {string[]} conditionIds The list of condition's ids to be fetched. Limit of 1000 incoming ids.
      * @param {ListConditionsOptions} params
      */

package/dist/types/resources/Pipelines/Conditions/ConditionInterfaces.d.ts CHANGED Viewed

@@ -65,7 +65,6 @@ export interface NewConditionModel {
 export interface ListConditionsOptions extends Paginated {
     /**
      * Whether to sort the results in ascending order.
-     *
      * @default true
      */
     isOrderAscending?: boolean;
@@ -77,7 +76,6 @@ export interface ListConditionsOptions extends Paginated {
     filter?: string;
     /**
      * The sort criteria to apply on the results.
-     *
      * @default ListStatementSortBy.Position
      */
     sortBy?: ListStatementSortBy;

package/dist/types/resources/Pipelines/MLAssociations/MLAssociationsInterfaces.d.ts CHANGED Viewed

@@ -28,8 +28,7 @@ export interface MLAssociationModel {
     rankingModifier?: number;
     useAdvancedConfiguration?: boolean;
 }
-export interface ListAssociationsParams extends Paginated {
-}
+export type ListAssociationsParams = Paginated;
 export interface BulkGetAssociationsParams extends Paginated {
     ids: string[];
 }

package/dist/types/resources/Pipelines/PipelinesInterfaces.d.ts CHANGED Viewed

@@ -5,7 +5,6 @@ interface PipelineInterfaceUrl {
      * Url of the pages affected by this query pipeline.
      *
      * string
-     *
      * @example: 'www.acme.com'
      */
     url: string;
@@ -29,7 +28,6 @@ interface PipelineShared {
      * The name of this query pipeline.
      *
      * string
-     *
      * @example: 'Community'
      */
     name: string;
@@ -37,9 +35,7 @@ interface PipelineShared {
      * The intended purpose of this query pipeline.
      *
      * string
-     *
      * @example: 'Provide contextually relevant query recommendations/results to Community site users.'
      */
     description?: string;
     /**
@@ -51,7 +47,6 @@ interface PipelineShared {
      * (assuming, of course, that this query pipeline is not the current default query pipeline).
      *
      * boolean
-     *
      * @example: false
      */
     isDefault?: boolean;
@@ -73,7 +68,6 @@ interface PipelineShared {
      * See also the `splitTestTarget`, `splitTestRatio`, and `splitTestEnabled` properties.
      *
      * string
-     *
      * @example: 'Community VS default'
      */
     splitTestName?: string;
@@ -86,7 +80,6 @@ interface PipelineShared {
      * double
      * maximum: 1
      * minimum: 0
-     *
      * @example: 0.5
      */
     splitTestRatio?: number;
@@ -96,7 +89,6 @@ interface PipelineShared {
      * See also the `splitTestName`, `splitTestRatio`, and `splitTestEnabled` properties.
      *
      * string
-     *
      * @example: '22a3860e-fa6f-4e64-a9f1-ef738af0786e'
      */
     splitTestTarget?: string;
@@ -110,7 +102,6 @@ interface PipelineShared {
      * otherwise you risk filling up the cache with useless data.
      *
      * string
-     *
      * @example: '@source==CommunityForum OR @source==CommunityDocumentation'
      */
     filter?: string;
@@ -120,7 +111,6 @@ interface PipelineShared {
      * to provide better support and improve the tools we provide.
      *
      * string
-     *
      * @example: 'Service & Support'
      */
     useCase?: string;
@@ -132,7 +122,6 @@ export interface PipelineModel extends PipelineShared {
      * The unique identifier of this query pipeline.
      *
      * string
-     *
      * @example: '120deecf-7822-4d7b-885f-53f184a3a76c'
      */
     id: string;
@@ -141,7 +130,6 @@ export interface PipelineModel extends PipelineShared {
      * in this Coveo Cloud organization.
      *
      * integer
-     *
      * @example: 3
      */
     position?: number;
@@ -149,7 +137,6 @@ export interface PipelineModel extends PipelineShared {
      * The identifier of the Coveo Cloud platform user who originally created this query pipeline.
      *
      * string
-     *
      * @example: 'asmith@coveo.com'
      */
     created_by?: string;
@@ -157,7 +144,6 @@ export interface PipelineModel extends PipelineShared {
      * The identifier of the Coveo Cloud platform user who last modified this query pipeline.
      *
      * string
-     *
      * @example: 'bjones@coveo.com'
      */
     last_modified_by?: string;
@@ -171,7 +157,6 @@ export interface PipelineDetailedModel extends PipelineModel {
      * The unique identifier of query pipeline A in the A/B test.
      *
      * See also the splitTestName, splitTestRatio, and splitTestEnabled properties
-     *
      * @example: '22a3860e-fa6f-4e64-a9f1-ef738af0786e'
      */
     splitTestOriginalPipeline?: string;

package/dist/types/resources/Pipelines/ResultRankings/ResultRankings.d.ts CHANGED Viewed

@@ -15,7 +15,6 @@ export default class ResultRankings extends Resource {
     bulkGet(pipelineId: string, { ids, ...allQueryStringOptions }: BulkGetResultRankingsParams): Promise<ListResultRankingResponse>;
     /**
      * Delete multiple result rankings rules in batch for a specific pipeline.
-     *
      * @param pipelineId The unique identifier of the target query pipeline.
      * @param ids A list of result ranking rule identifiers to delete. A maximum of 100 can be sent.
      */

package/dist/types/resources/Pipelines/ResultRankings/ResultRankingsInterfaces.d.ts CHANGED Viewed

@@ -232,7 +232,6 @@ export interface ListResultRankingParams extends CoreGetResultRankingParams {
     /**
      * Similar to `kind`, the _ruleTypes_ parameter allows to filter by result ranking rule type.
      * This new parameter should be preferred over `kind` as it may eventually support other rule types.
-     *
      * @see kind
      */
     ruleTypes?: ResultRankingsRuleTypes[];