@coveo/platform-client 37.3.0 → 37.5.0-alpha.0

package/dist/definitions/resources/Pipelines/MLAssociations/MLAssociationsInterfaces.d.ts

@@ -1,57 +1,57 @@
-import { Paginated } from '../../BaseInterfaces';
-import { ModelTypes } from '../../Enums';
-/**
- * @deprecated - Use `PageModel<MLAssociationModel, 'rules'>` instead.
- */
-export interface AssociationsListModel {
-    rules: MLAssociationModel[];
-    totalEntries: number;
-    totalPages: number;
-}
-export interface MLAssociationModel {
-    id: string;
-    position: number;
-    modelId: string;
-    modelStatus: string;
-    cacheMaximumAge: string;
-    modelEngine?: ModelTypes;
-    condition?: string;
-    conditionDefinition?: string;
-    customQueryParameters?: any;
-    enableWordCompletion?: boolean;
-    exclusive?: boolean;
-    intelligentTermDetection?: boolean;
-    matchAdvancedExpression?: boolean;
-    matchBasicExpression?: boolean;
-    maxRecommendations?: number;
-    modelDisplayName?: string;
-    rankingModifier?: number;
-    useAdvancedConfiguration?: boolean;
-}
-export interface ListAssociationsParams extends Paginated {
-}
-export interface CreateAssociation extends EditAssociation {
-    modelId: string;
-}
-export interface EditAssociation {
-    cacheMaximumAge?: string;
-    condition?: string;
-    customQueryParameters?: any;
-    description?: string;
-    enableWordCompletion?: boolean;
-    exclusive?: boolean;
-    intelligentTermDetection?: boolean;
-    matchAdvancedExpression?: boolean;
-    matchBasicExpression?: boolean;
-    maxRecommendations?: number;
-    rankingModifier?: number;
-}
-export interface AssociatedPipelinesData {
-    modelId: string;
-    associations: AssociatedPipelineModel[];
-}
-export interface AssociatedPipelineModel {
-    associationId: string;
-    pipelineId: string;
-    pipelineName: string;
-}
+import { Paginated } from '../../BaseInterfaces';
+import { ModelTypes } from '../../Enums';
+/**
+ * @deprecated - Use `PageModel<MLAssociationModel, 'rules'>` instead.
+ */
+export interface AssociationsListModel {
+    rules: MLAssociationModel[];
+    totalEntries: number;
+    totalPages: number;
+}
+export interface MLAssociationModel {
+    id: string;
+    position: number;
+    modelId: string;
+    modelStatus: string;
+    cacheMaximumAge: string;
+    modelEngine?: ModelTypes;
+    condition?: string;
+    conditionDefinition?: string;
+    customQueryParameters?: any;
+    enableWordCompletion?: boolean;
+    exclusive?: boolean;
+    intelligentTermDetection?: boolean;
+    matchAdvancedExpression?: boolean;
+    matchBasicExpression?: boolean;
+    maxRecommendations?: number;
+    modelDisplayName?: string;
+    rankingModifier?: number;
+    useAdvancedConfiguration?: boolean;
+}
+export interface ListAssociationsParams extends Paginated {
+}
+export interface CreateAssociation extends EditAssociation {
+    modelId: string;
+}
+export interface EditAssociation {
+    cacheMaximumAge?: string;
+    condition?: string;
+    customQueryParameters?: any;
+    description?: string;
+    enableWordCompletion?: boolean;
+    exclusive?: boolean;
+    intelligentTermDetection?: boolean;
+    matchAdvancedExpression?: boolean;
+    matchBasicExpression?: boolean;
+    maxRecommendations?: number;
+    rankingModifier?: number;
+}
+export interface AssociatedPipelinesData {
+    modelId: string;
+    associations: AssociatedPipelineModel[];
+}
+export interface AssociatedPipelineModel {
+    associationId: string;
+    pipelineId: string;
+    pipelineName: string;
+}

package/dist/definitions/resources/Pipelines/MLAssociations/index.d.ts

@@ -1,2 +1,2 @@
-export * from './MLAssociations';
-export * from './MLAssociationsInterfaces';
+export * from './MLAssociations';
+export * from './MLAssociationsInterfaces';

package/dist/definitions/resources/Pipelines/Pipelines.d.ts

@@ -1,30 +1,30 @@
-import API from '../../APICore';
-import { GranularResource } from '../BaseInterfaces';
-import Resource from '../Resource';
-import Condition from './Conditions/Condition';
-import FacetStateRules from './FacetStateRules/FacetStateRules';
-import MLAssociations from './MLAssociations/MLAssociations';
-import { ListPipelinesOptions, ListPipelinesReturnVariant, NewPipelineModel, PipelineBackendVersion, PipelineModel, UpdatePipelineModel } from './PipelinesInterfaces';
-import ResultRankings from './ResultRankings/ResultRankings';
-import StatementGroups from './StatementGroups/StatementGroups';
-import Statements from './Statements/Statements';
-export default class Pipelines extends Resource {
-    protected api: API;
-    protected serverlessApi: API;
-    static searchUrlVersion2: string;
-    static searchUrlVersion1: string;
-    associations: MLAssociations;
-    statements: Statements;
-    resultRanking: ResultRankings;
-    conditions: Condition;
-    groups: StatementGroups;
-    facetRules: FacetStateRules;
-    constructor(api: API, serverlessApi: API);
-    getMLVersion(): Promise<PipelineBackendVersion>;
-    list<ListPipelinesVariant extends ListPipelinesOptions>(options?: ListPipelinesVariant): Promise<ListPipelinesReturnVariant<ListPipelinesVariant>>;
-    get(pipelineId: string): Promise<PipelineModel>;
-    delete(pipelineId: string): Promise<Record<string, unknown>>;
-    update(pipeline: UpdatePipelineModel): Promise<PipelineModel>;
-    duplicate(pipelineId: string, granularResource?: GranularResource): Promise<PipelineModel>;
-    create(pipeline: NewPipelineModel): Promise<PipelineModel>;
-}
+import API from '../../APICore';
+import { GranularResource } from '../BaseInterfaces';
+import Resource from '../Resource';
+import Condition from './Conditions/Condition';
+import FacetStateRules from './FacetStateRules/FacetStateRules';
+import MLAssociations from './MLAssociations/MLAssociations';
+import { ListPipelinesOptions, ListPipelinesReturnVariant, NewPipelineModel, PipelineBackendVersion, PipelineModel, UpdatePipelineModel } from './PipelinesInterfaces';
+import ResultRankings from './ResultRankings/ResultRankings';
+import StatementGroups from './StatementGroups/StatementGroups';
+import Statements from './Statements/Statements';
+export default class Pipelines extends Resource {
+    protected api: API;
+    protected serverlessApi: API;
+    static searchUrlVersion2: string;
+    static searchUrlVersion1: string;
+    associations: MLAssociations;
+    statements: Statements;
+    resultRanking: ResultRankings;
+    conditions: Condition;
+    groups: StatementGroups;
+    facetRules: FacetStateRules;
+    constructor(api: API, serverlessApi: API);
+    getMLVersion(): Promise<PipelineBackendVersion>;
+    list<ListPipelinesVariant extends ListPipelinesOptions>(options?: ListPipelinesVariant): Promise<ListPipelinesReturnVariant<ListPipelinesVariant>>;
+    get(pipelineId: string): Promise<PipelineModel>;
+    delete(pipelineId: string): Promise<Record<string, unknown>>;
+    update(pipeline: UpdatePipelineModel): Promise<PipelineModel>;
+    duplicate(pipelineId: string, granularResource?: GranularResource): Promise<PipelineModel>;
+    create(pipeline: NewPipelineModel): Promise<PipelineModel>;
+}

package/dist/definitions/resources/Pipelines/PipelinesInterfaces.d.ts

@@ -1,213 +1,213 @@
-import { GranularResource, PageModel, Paginated } from '../BaseInterfaces';
-import { ConditionModel } from './Conditions';
-export interface PipelineBackendVersion {
-    version: '1' | '2';
-}
-interface PipelineInterfaceUrl {
-    /**
-     * Url of the pages affected by this query pipeline.
-     *
-     * string
-     *
-     * @example: 'www.acme.com'
-     */
-    url: string;
-}
-interface PipelineAduiConfigTooltipsDismissed {
-    /**
-     * The identifier of the tooltip that was dismissed.
-     *
-     * string
-     */
-    id: string;
-}
-interface PipelineAduiConfig {
-    /**
-     * A list of tooltips that were dismissed by the user.
-     */
-    tooltipsDismissed?: PipelineAduiConfigTooltipsDismissed[];
-}
-interface PipelineShared {
-    /**
-     * The name of this query pipeline.
-     *
-     * string
-     *
-     * @example: 'Community'
-     */
-    name: string;
-    /**
-     * The intended purpose of this query pipeline.
-     *
-     * string
-     *
-     * @example: 'Provide contextually relevant query recommendations/results to Community site users.'
-     
-     */
-    description?: string;
-    /**
-     * Whether this query pipeline is the default query pipeline.
-     *
-     * **Note**: There must be one and only one default query pipeline in a Coveo Cloud organization.
-     * Therefore, setting isDefault to true on this query pipeline will automatically
-     * set it to false in the current default query pipeline as a side effect
-     * (assuming, of course, that this query pipeline is not the current default query pipeline).
-     *
-     * boolean
-     *
-     * @example: false
-     */
-    isDefault?: boolean;
-    /**
-     *
-     */
-    condition?: ConditionModel;
-    /**
-     * Whether to enable the A/B test.
-     *
-     * See also the `splitTestName`, `splitTestTarget`, and `splitTestRatio` properties.
-     *
-     * boolean
-     */
-    splitTestEnabled?: boolean;
-    /**
-     * A name which summarizes the intended purpose of the A/B test.
-     *
-     * See also the `splitTestTarget`, `splitTestRatio`, and `splitTestEnabled` properties.
-     *
-     * string
-     *
-     * @example: 'Community VS default'
-     */
-    splitTestName?: string;
-    /**
-     * The percentage of queries to route through query pipeline B if the A/B test is enabled.
-     * Remaining queries will be routed through this query pipeline.
-     *
-     * See also the `splitTestName`, `splitTestTarget`, and `splitTestEnabled` properties.
-     *
-     * double
-     * maximum: 1
-     * minimum: 0
-     *
-     * @example: 0.5
-     */
-    splitTestRatio?: number;
-    /**
-     * The unique identifier of query pipeline B in the A/B test.
-     *
-     * See also the `splitTestName`, `splitTestRatio`, and `splitTestEnabled` properties.
-     *
-     * string
-     *
-     * @example: '22a3860e-fa6f-4e64-a9f1-ef738af0786e'
-     */
-    splitTestTarget?: string;
-    /**
-     * A constant query expression to add to all queries routed through this query pipeline.
-     *
-     * **Notes**:
-     * - The filter expression is added to the constant part of the query expression (cq)
-     * using an AND operator;
-     * - Avoid including dynamically evaluated values in the filter expression,
-     * otherwise you risk filling up the cache with useless data.
-     *
-     * string
-     *
-     * @example: '@source==CommunityForum OR @source==CommunityDocumentation'
-     */
-    filter?: string;
-    /**
-     * The use case for which this query pipeline should apply.
-     * This option allows you to categorize your query pipeline and enables Coveo
-     * to provide better support and improve the tools we provide.
-     *
-     * string
-     *
-     * @example: 'Service & Support'
-     */
-    useCase?: string;
-    interfaceUrls?: PipelineInterfaceUrl[];
-    aduiConfig?: PipelineAduiConfig;
-}
-export interface PipelineModel extends PipelineShared {
-    /**
-     * The unique identifier of this query pipeline.
-     *
-     * string
-     *
-     * @example: '120deecf-7822-4d7b-885f-53f184a3a76c'
-     */
-    id: string;
-    /**
-     * The 0-based position of this query pipeline relative to other query pipelines
-     * in this Coveo Cloud organization.
-     *
-     * integer
-     *
-     * @example: 3
-     */
-    position?: number;
-    /**
-     * The identifier of the Coveo Cloud platform user who originally created this query pipeline.
-     *
-     * string
-     *
-     * @example: 'asmith@coveo.com'
-     */
-    created_by?: string;
-    /**
-     * The identifier of the Coveo Cloud platform user who last modified this query pipeline.
-     *
-     * string
-     *
-     * @example: 'bjones@coveo.com'
-     */
-    last_modified_by?: string;
-    statementComposition?: {
-        totalCount?: number;
-        [key: string]: number;
-    };
-}
-export interface NewPipelineModel extends PipelineShared, GranularResource {
-}
-export interface UpdatePipelineModel extends PipelineModel, GranularResource {
-}
-export interface ListPipelinesOptions extends Paginated {
-    /**
-     * Whether to sort the results in ascending order.
-     */
-    isOrderAscending?: boolean;
-    /**
-     * The query filter to match.
-     *
-     * This allows you to search within query pipeline statement definitions and descriptions.
-     *
-     * By default, results are not required to match a specific query filter.
-     */
-    filter?: string;
-    /**
-     * The sort criteria to apply on the results.
-     *
-     * Allowed values: `definition`, `description`, and `position`.
-     *
-     * Default: `position`
-     */
-    sortby?: 'definition' | 'description' | 'position';
-    feature?: string;
-    /**
-     * The unique identifier of the target Coveo Cloud organization.
-     *
-     * Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.
-     */
-    organizationId?: string;
-    /**
-     * Whether to enable pagination.
-     */
-    enablePagination?: boolean;
-}
-export declare type PaginatedListPipelinesModel = Omit<PageModel<PipelineModel>, 'totalPages'>;
-export declare type ListPipelinesReturnVariant<ListPipelineVariant> = ListPipelineVariant extends {
-    enablePagination: true;
-} ? PaginatedListPipelinesModel : PipelineModel[];
-export {};
+import { GranularResource, PageModel, Paginated } from '../BaseInterfaces';
+import { ConditionModel } from './Conditions';
+export interface PipelineBackendVersion {
+    version: '1' | '2';
+}
+interface PipelineInterfaceUrl {
+    /**
+     * Url of the pages affected by this query pipeline.
+     *
+     * string
+     *
+     * @example: 'www.acme.com'
+     */
+    url: string;
+}
+interface PipelineAduiConfigTooltipsDismissed {
+    /**
+     * The identifier of the tooltip that was dismissed.
+     *
+     * string
+     */
+    id: string;
+}
+interface PipelineAduiConfig {
+    /**
+     * A list of tooltips that were dismissed by the user.
+     */
+    tooltipsDismissed?: PipelineAduiConfigTooltipsDismissed[];
+}
+interface PipelineShared {
+    /**
+     * The name of this query pipeline.
+     *
+     * string
+     *
+     * @example: 'Community'
+     */
+    name: string;
+    /**
+     * The intended purpose of this query pipeline.
+     *
+     * string
+     *
+     * @example: 'Provide contextually relevant query recommendations/results to Community site users.'
+     
+     */
+    description?: string;
+    /**
+     * Whether this query pipeline is the default query pipeline.
+     *
+     * **Note**: There must be one and only one default query pipeline in a Coveo Cloud organization.
+     * Therefore, setting isDefault to true on this query pipeline will automatically
+     * set it to false in the current default query pipeline as a side effect
+     * (assuming, of course, that this query pipeline is not the current default query pipeline).
+     *
+     * boolean
+     *
+     * @example: false
+     */
+    isDefault?: boolean;
+    /**
+     *
+     */
+    condition?: ConditionModel;
+    /**
+     * Whether to enable the A/B test.
+     *
+     * See also the `splitTestName`, `splitTestTarget`, and `splitTestRatio` properties.
+     *
+     * boolean
+     */
+    splitTestEnabled?: boolean;
+    /**
+     * A name which summarizes the intended purpose of the A/B test.
+     *
+     * See also the `splitTestTarget`, `splitTestRatio`, and `splitTestEnabled` properties.
+     *
+     * string
+     *
+     * @example: 'Community VS default'
+     */
+    splitTestName?: string;
+    /**
+     * The percentage of queries to route through query pipeline B if the A/B test is enabled.
+     * Remaining queries will be routed through this query pipeline.
+     *
+     * See also the `splitTestName`, `splitTestTarget`, and `splitTestEnabled` properties.
+     *
+     * double
+     * maximum: 1
+     * minimum: 0
+     *
+     * @example: 0.5
+     */
+    splitTestRatio?: number;
+    /**
+     * The unique identifier of query pipeline B in the A/B test.
+     *
+     * See also the `splitTestName`, `splitTestRatio`, and `splitTestEnabled` properties.
+     *
+     * string
+     *
+     * @example: '22a3860e-fa6f-4e64-a9f1-ef738af0786e'
+     */
+    splitTestTarget?: string;
+    /**
+     * A constant query expression to add to all queries routed through this query pipeline.
+     *
+     * **Notes**:
+     * - The filter expression is added to the constant part of the query expression (cq)
+     * using an AND operator;
+     * - Avoid including dynamically evaluated values in the filter expression,
+     * otherwise you risk filling up the cache with useless data.
+     *
+     * string
+     *
+     * @example: '@source==CommunityForum OR @source==CommunityDocumentation'
+     */
+    filter?: string;
+    /**
+     * The use case for which this query pipeline should apply.
+     * This option allows you to categorize your query pipeline and enables Coveo
+     * to provide better support and improve the tools we provide.
+     *
+     * string
+     *
+     * @example: 'Service & Support'
+     */
+    useCase?: string;
+    interfaceUrls?: PipelineInterfaceUrl[];
+    aduiConfig?: PipelineAduiConfig;
+}
+export interface PipelineModel extends PipelineShared {
+    /**
+     * The unique identifier of this query pipeline.
+     *
+     * string
+     *
+     * @example: '120deecf-7822-4d7b-885f-53f184a3a76c'
+     */
+    id: string;
+    /**
+     * The 0-based position of this query pipeline relative to other query pipelines
+     * in this Coveo Cloud organization.
+     *
+     * integer
+     *
+     * @example: 3
+     */
+    position?: number;
+    /**
+     * The identifier of the Coveo Cloud platform user who originally created this query pipeline.
+     *
+     * string
+     *
+     * @example: 'asmith@coveo.com'
+     */
+    created_by?: string;
+    /**
+     * The identifier of the Coveo Cloud platform user who last modified this query pipeline.
+     *
+     * string
+     *
+     * @example: 'bjones@coveo.com'
+     */
+    last_modified_by?: string;
+    statementComposition?: {
+        totalCount?: number;
+        [key: string]: number;
+    };
+}
+export interface NewPipelineModel extends PipelineShared, GranularResource {
+}
+export interface UpdatePipelineModel extends PipelineModel, GranularResource {
+}
+export interface ListPipelinesOptions extends Paginated {
+    /**
+     * Whether to sort the results in ascending order.
+     */
+    isOrderAscending?: boolean;
+    /**
+     * The query filter to match.
+     *
+     * This allows you to search within query pipeline statement definitions and descriptions.
+     *
+     * By default, results are not required to match a specific query filter.
+     */
+    filter?: string;
+    /**
+     * The sort criteria to apply on the results.
+     *
+     * Allowed values: `definition`, `description`, and `position`.
+     *
+     * Default: `position`
+     */
+    sortby?: 'definition' | 'description' | 'position';
+    feature?: string;
+    /**
+     * The unique identifier of the target Coveo Cloud organization.
+     *
+     * Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.
+     */
+    organizationId?: string;
+    /**
+     * Whether to enable pagination.
+     */
+    enablePagination?: boolean;
+}
+export declare type PaginatedListPipelinesModel = Omit<PageModel<PipelineModel>, 'totalPages'>;
+export declare type ListPipelinesReturnVariant<ListPipelineVariant> = ListPipelineVariant extends {
+    enablePagination: true;
+} ? PaginatedListPipelinesModel : PipelineModel[];
+export {};

package/dist/definitions/resources/Pipelines/ResultRankings/ResultRankings.d.ts

@@ -1,15 +1,15 @@
-import Resource from '../../Resource';
-import { CopyResultRankingRequest, CopyResultRankingResponse, ListResultRankingParams, ListResultRankingResponse, ResultRanking, ResultRankingProps } from './ResultRankingsInterfaces';
-export default class ResultRankings extends Resource {
-    static getBaseUrl: (pipelineId: string) => string;
-    static getResultRankingsUrl: (pipelineId: string, resultRankingsId: string) => string;
-    delete(pipelineId: string, resultRankingsId: string): Promise<ResultRanking>;
-    get(pipelineId: string, resultRankingsId: string): Promise<ResultRankingProps>;
-    update(pipelineId: string, resultRankingsId: string, resultRanking: ResultRankingProps): Promise<void>;
-    updateJSON(pipelineId: string, resultRankingsId: string, resultRanking: string): Promise<void>;
-    list(pipelineId: string, params?: ListResultRankingParams): Promise<ListResultRankingResponse>;
-    create(pipelineId: string, resultRanking: ResultRankingProps): Promise<ResultRanking>;
-    createJSON(pipelineId: string, resultRanking: string): Promise<ResultRanking>;
-    duplicate(pipelineId: string, resultRankingsId: string): Promise<ResultRanking>;
-    copyTo(pipelineId: string, copyResultRankingRequest: CopyResultRankingRequest): Promise<CopyResultRankingResponse>;
-}
+import Resource from '../../Resource';
+import { CopyResultRankingRequest, CopyResultRankingResponse, ListResultRankingParams, ListResultRankingResponse, ResultRanking, ResultRankingProps } from './ResultRankingsInterfaces';
+export default class ResultRankings extends Resource {
+    static getBaseUrl: (pipelineId: string) => string;
+    static getResultRankingsUrl: (pipelineId: string, resultRankingsId: string) => string;
+    delete(pipelineId: string, resultRankingsId: string): Promise<ResultRanking>;
+    get(pipelineId: string, resultRankingsId: string): Promise<ResultRankingProps>;
+    update(pipelineId: string, resultRankingsId: string, resultRanking: ResultRankingProps): Promise<void>;
+    updateJSON(pipelineId: string, resultRankingsId: string, resultRanking: string): Promise<void>;
+    list(pipelineId: string, params?: ListResultRankingParams): Promise<ListResultRankingResponse>;
+    create(pipelineId: string, resultRanking: ResultRankingProps): Promise<ResultRanking>;
+    createJSON(pipelineId: string, resultRanking: string): Promise<ResultRanking>;
+    duplicate(pipelineId: string, resultRankingsId: string): Promise<ResultRanking>;
+    copyTo(pipelineId: string, copyResultRankingRequest: CopyResultRankingRequest): Promise<CopyResultRankingResponse>;
+}