@coveo/platform-client 68.5.0 → 68.6.0

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

@@ -1,5 +1,6 @@
 import { Paginated } from '../../BaseInterfaces.js';
 import { CampaignStatementGroupStatusType, ListStatementSortBy, PermanentStatementGroupStatusType, ResultRankingLocales, ResultRankingMatchOperators, ResultRankingsKind, ResultRankingsRuleTypes, ResultRankingsStatuses } from '../../Enums.js';
+import { DetailedCondition } from '../Conditions/ConditionInterfaces.js';
 export interface ResultRanking {
     /**
      * The unique identifier of the result ranking rule.
@@ -80,6 +81,12 @@ export interface ResultRankingProps {
          * The ID of a mandatory condition to satisfy.
          */
         reference: string;
+        /**
+         * The detailed version of the condition.
+         */
+        detailed?: {
+            condition: DetailedCondition;
+        };
     };
     statementGroupId?: string;
     associatedGroup?: ResultRankingAssociatedGroup;
@@ -223,6 +230,7 @@ interface CoreGetResultRankingParams extends Paginated {
      */
     kind?: ResultRankingsKind;
 }
+export type ListResultRankingExpandOptions = 'condition.detailed';
 export interface ListResultRankingParams extends CoreGetResultRankingParams {
     sortBy?: ListStatementSortBy;
     /**
@@ -239,6 +247,12 @@ export interface ListResultRankingParams extends CoreGetResultRankingParams {
      * The rule status to allow in the results.
      */
     ruleStatuses?: ResultRankingsStatuses[];
+    /**
+     * The related resources to expand in the response.
+     *
+     * Set to `condition.detailed` to include the detailed version of the condition alongside `condition.reference` in each result ranking condition.
+     */
+    expand?: ListResultRankingExpandOptions[];
 }
 export interface CopyResultRankingRequest {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@coveo/platform-client",
-    "version": "68.5.0",
+    "version": "68.6.0",
     "description": "",
     "type": "module",
     "exports": {