@coveo/platform-client 0.0.0-cjs-attempt

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

@@ -0,0 +1,213 @@
+import { GranularResource, PageModel, Paginated } from '../BaseInterfaces.js';
+import { ConditionModel } from './Conditions/index.js';
+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 | undefined;
+    };
+}
+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 type PaginatedListPipelinesModel = Omit<PageModel<PipelineModel>, 'totalPages'>;
+export type ListPipelinesReturnVariant<ListPipelineVariant> = ListPipelineVariant extends {
+    enablePagination: true;
+} ? PaginatedListPipelinesModel : PipelineModel[];
+export {};

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

@@ -0,0 +1,16 @@
+import Resource from '../../Resource.js';
+import { BulkGetResultRankingsParams, CopyResultRankingRequest, CopyResultRankingResponse, ListResultRankingParams, ListResultRankingResponse, ResultRanking, ResultRankingProps } from './ResultRankingsInterfaces.js';
+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>;
+    bulkGet(pipelineId: string, { ids, ...allQueryStringOptions }: BulkGetResultRankingsParams): Promise<ListResultRankingResponse>;
+}

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

@@ -0,0 +1,282 @@
+import { Paginated } from '../../BaseInterfaces.js';
+import { CampaignStatementGroupStatusType, ListStatementSortBy, PermanentStatementGroupStatusType, ResultRankingLocales, ResultRankingMatchOperators, ResultRankingsKind, ResultRankingsRuleTypes, ResultRankingsStatuses } from '../../Enums.js';
+export interface ResultRanking {
+    /**
+     * The unique identifier of the result ranking rule.
+     */
+    id: string;
+    /**
+     * The configuration of the result ranking rule.
+     */
+    resultRanking: ResultRankingProps;
+    /**
+     * Associated statement group's information.
+     */
+    associatedGroup?: ResultRankingAssociatedGroup;
+    /**
+     * The identifier of the Coveo Cloud platform user who last modified this.
+     */
+    modifiedBy?: string;
+    /**
+     * The last time this was modified. (ISO 8601)
+     */
+    modifiedAt?: string;
+}
+export interface ListResultRanking extends ResultRanking {
+    /**
+     * Associated statement group's information.
+     */
+    associatedGroup?: ResultRankingAssociatedGroupWithStatus;
+}
+export interface ResultRankingProps {
+    /**
+     * The name of the result ranking.
+     */
+    name: string;
+    /**
+     * The kind of result ranking. The default value is "featured_result".
+     */
+    kind?: ResultRankingsKind;
+    defaultMatchOperator: ResultRankingMatchOperator;
+    predicates: ResultRankingPredicate[];
+    targets: Array<ResultRankingTargetUniqueId | ResultRankingTargetLocalizedContent | ResultRankingTargetQueryExpression>;
+    qplPredicates?: ResultRankingQplCodePredicate;
+    /**
+     * Whether to add the current Query (q) to the Disjunction part (dq) of the combined expression using an OR operator.
+     */
+    matchQuery?: boolean;
+    /**
+     * Whether to append the current Advanced Query (aq) to the Disjunction part (dq) of the combined query expression using an OR operator.
+     */
+    matchAdvancedQuery?: boolean;
+    includeInFacets?: boolean;
+    /**
+     * Whether this result ranking uses the latest features and is not managed by a legacy client.
+     */
+    isMigrated?: boolean;
+    /**
+     * The intended purpose of this result ranking.
+     */
+    description?: string;
+    /**
+     * The ranking score modifier to apply.
+     * Use a positive value to promote the target, or a negative value to demote it.
+     */
+    rankingModifier?: number;
+    /**
+     * Whether to treat the expression as a Constant Query (cq) expression (and cache its result set).
+     */
+    isConstant?: boolean;
+    /**
+     * Whether to apply the Query Ranking Expression (QRE) to every item in the expression query result set, regardless of its current ranking score. When this option is set to 'false', the QRE only applies to query result set items whose current ranking score is considered high enough by the index.
+     */
+    applyToEveryResult?: boolean;
+    /**
+     * Whether this result ranking should be used by the query pipeline.
+     */
+    enabled?: boolean;
+    condition?: {
+        /**
+         * The ID of a mandatory condition to satisfy.
+         */
+        reference: string;
+    };
+    statementGroupId?: string;
+    associatedGroup?: ResultRankingAssociatedGroup;
+}
+export interface ResultRankingAssociatedGroup {
+    id: string;
+    name: string;
+    isActive: boolean;
+}
+export interface ResultRankingAssociatedGroupWithStatus extends ResultRankingAssociatedGroup {
+    /**
+     * Activation status.
+     */
+    status: CampaignStatementGroupStatusType | PermanentStatementGroupStatusType;
+}
+export interface ResultRankingMatchOperator {
+    /**
+     * The kind of match operator.
+     */
+    kind: string | ResultRankingMatchOperators;
+}
+export interface ResultRankingPredicate {
+    kind: string;
+    /**
+     * The value to compare with the search query's actual q value.
+     */
+    basicQueryExpression?: string;
+    matchOperator: ResultRankingMatchOperator;
+    locale?: ResultRankingPredicateLocale;
+    /**
+     * The Query Pipeline Language (QPL) definition of the condition.
+     */
+    code?: string;
+}
+export interface ResultRankingPredicateLocale {
+    /**
+     * The kind of locale.
+     */
+    kind?: string | ResultRankingLocales;
+    /**
+     * An additional condition expressed with the Query Pipeline Language (QPL).
+     */
+    code?: string;
+}
+export interface ResultRankingTargetUniqueId {
+    /**
+     * Select a document by unique id (urihash value).
+     */
+    uniqueId: string;
+}
+export interface ResultRankingTargetLocalizedContent {
+    localizedContent: ResultRankingLocalizedContent;
+}
+export interface ResultRankingLocalizedContent {
+    /**
+     * The ID of the knowledge article to show.
+     */
+    familyId: string;
+    locale: ResultRankingLocalizedContentLocaleAuto | ResultRankingLocalizedContentLocaleSpecific;
+    /**
+     * Field that identifies the knowledge article.
+     */
+    familyIdField: string;
+    /**
+     * Field that identifies the locale of the document.
+     */
+    localeField: string;
+}
+export interface ResultRankingLocalizedContentLocaleAuto {
+    auto: {
+        /**
+         * The default locale of the knowledge article to default to if it's not available in the user's locale.
+         */
+        default: string;
+    };
+}
+export interface ResultRankingLocalizedContentLocaleSpecific {
+    /**
+     * The locale code of the knowledge article to show.
+     */
+    specific: string;
+}
+export interface ResultRankingTargetQueryExpression {
+    /**
+     * Select documents using a query expression.
+     */
+    queryExpression: string;
+}
+export interface ResultRankingQplCodePredicate {
+    code: string;
+}
+export interface ResultRankingGroupByStatementGroups {
+    associated: Record<string, number>;
+    orphaned: number;
+}
+export interface ResultRankingGroupByStatus {
+    active: number;
+    inactive: number;
+}
+export interface ResultRankingGroupByTypes {
+    rankingExpressions: number;
+    featuredResults: number;
+}
+export interface ResultRankingGroupBy {
+    groups: ResultRankingGroupByStatementGroups;
+    status: ResultRankingGroupByStatus;
+    type: ResultRankingGroupByTypes;
+}
+export interface ListResultRankingResponse {
+    resultRankings: ListResultRanking[];
+    groupedBy: ResultRankingGroupBy;
+    totalCount: number;
+    totalPages: number;
+}
+interface CoreGetResultRankingParams 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 0-based number of the page of results to get.
+     */
+    page?: number;
+    /**
+     * The number of results to include per page.
+     */
+    perPage?: number;
+    /**
+     * The unique identifier of the target Coveo Cloud organization.
+     */
+    organizationId?: string;
+    /**
+     * @deprecated `ruleTypes` should be preferred over _kind_.
+     * @see ruleTypes
+     */
+    kind?: ResultRankingsKind;
+}
+export interface ListResultRankingParams extends CoreGetResultRankingParams {
+    sortBy?: ListStatementSortBy;
+    /**
+     * The group names to allow in the results.
+     */
+    associatedGroups?: Array<string | null>;
+    /**
+     * 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[];
+    /**
+     * The rule status to allow in the results.
+     */
+    ruleStatuses?: ResultRankingsStatuses[];
+}
+export interface CopyResultRankingRequest {
+    /**
+     * The unique identifier of the query pipeline to copy the statements to.
+     */
+    destinationPipelineId: string;
+    /**
+     * The unique identifiers of the result ranking rules to copy.
+     */
+    resultRankingIds: string[];
+}
+export interface CopyResultRankingResponse {
+    /**
+     * The list of result rankings that were copied to the destination pipeline.
+     */
+    resultRankings: Array<{
+        /**
+         * The identifier of the result ranking rule.
+         */
+        id: string;
+        /**
+         * The result ranking rule content.
+         */
+        resultRanking: ResultRankingProps;
+    }>;
+}
+export interface BulkGetResultRankingsParams extends CoreGetResultRankingParams {
+    ids: string[];
+    /**
+     * The enabled status of result ranking rules to allow in the returned list.
+     * Set to true to only allow rules whose enabled property is set to true, and vice versa.
+     * By default, both enabled and disabled rules are allowed.
+     */
+    enabledStatus?: boolean;
+    /**
+     * The unique identifier of the statement group.
+     */
+    statementGroupId?: string;
+}
+export {};

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

@@ -0,0 +1,2 @@
+export * from './ResultRankings.js';
+export * from './ResultRankingsInterfaces.js';

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

@@ -0,0 +1,13 @@
+import Resource from '../../Resource.js';
+import { CreateStatementGroupModel, UpdateStatementGroupModel, ListStatementGroupsOptions, StatementGroupList, StatementGroupModel, UpdateStatementGroupRuleAssociationsRequest, UpdateStatementGroupRuleAssociationsResponse } from './StatementGroupsInterfaces.js';
+export default class StatementGroups extends Resource {
+    static getBaseUrl: (pipelineId: string) => string;
+    static getStatementGroupUrl: (pipelineId: string, groupId: string) => string;
+    list(pipelineId: string, options?: ListStatementGroupsOptions): Promise<StatementGroupList>;
+    create(pipelineId: string, model: CreateStatementGroupModel): Promise<StatementGroupModel>;
+    get(pipelineId: string, groupId: string): Promise<StatementGroupModel>;
+    update(pipelineId: string, groupId: string, groupModel: UpdateStatementGroupModel): Promise<void>;
+    delete(pipelineId: string, groupId: string): Promise<void>;
+    toggleActive(pipelineId: string, groupId: string, isActive: boolean): Promise<void>;
+    bulkUpdateRuleAssociations(pipelineId: string, groupId: string, request: UpdateStatementGroupRuleAssociationsRequest): Promise<UpdateStatementGroupRuleAssociationsResponse>;
+}