@coveo/platform-client 35.0.0

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

@@ -0,0 +1,230 @@
+import { Paginated } from '../../BaseInterfaces';
+import { CampaignStatementGroupStatusType, ListStatementGroupStatusType, PermanentStatementGroupStatusType, StatementGroupType } from '../../Enums';
+export interface StatementGroupList {
+    groups: StatementGroupModel[];
+    /**
+     * The total number of matching statements across all pages of results.
+     */
+    totalCount: number;
+    groupComposition: PipelineGroupsComposition;
+}
+export declare type StatementGroupModel = PermanentStatementGroup | CampaignStatementGroup;
+interface StatementGroupModelBase {
+    /**
+     * The unique identifier of the statement group.
+     */
+    id: string;
+    /**
+     * The name of the statement group.
+     */
+    name: string;
+    /**
+     * The intented purpose of this statement group.
+     */
+    description?: string;
+    /**
+     * The unique identifier of the condition that must be satisfied for a request to be processed by the statement group.
+     */
+    conditionId?: string;
+    /**
+     * The definition of the condition that must be satisfied for a request to be processed by the statement group.
+     */
+    conditionDefinition?: string;
+    /**
+     * Date of creation
+     * Format: ISO-8601
+     *
+     * @example 2021-09-09T19:00:45.603-04:00
+     */
+    createdAt: string;
+    /**
+     * The creator principal.
+     */
+    createdBy?: string;
+    /**
+     * Last date of modification
+     * Format: ISO-8601
+     *
+     * @example 2021-09-09T19:00:45.603-04:00
+     */
+    modifiedAt?: string;
+    /**
+     * The last modified principal.
+     */
+    modifiedBy?: string;
+    statementComposition: StatementGroupComposition;
+}
+export interface PermanentStatementGroup extends StatementGroupModelBase {
+    type: StatementGroupType.permanent;
+    /**
+     * Whether the group is active.
+     */
+    isActive?: boolean;
+    /**
+     * The status of the group.
+     */
+    status: PermanentStatementGroupStatusType;
+}
+export interface CampaignStatementGroup extends StatementGroupModelBase {
+    type: StatementGroupType.campaign;
+    /**
+     * The start date of the campaign.
+     * Format: ISO-8601
+     *
+     * @example 2020-09-09T19:00:45.603-04:00
+     */
+    campaignStart: string;
+    /**
+     * The end date of the campaign.
+     * Format: ISO-8601
+     *
+     * @example 2021-09-09T19:00:45.603-04:00
+     */
+    campaignEnd: string;
+    /**
+     * The status of the campaign.
+     */
+    status: CampaignStatementGroupStatusType;
+}
+export interface PipelineGroupsComposition {
+    /**
+     * The number of active groups in the pipeline.
+     */
+    activeGroupCount: number;
+    /**
+     * The number of inactive groups in the pipeline.
+     */
+    inactiveGroupCount: number;
+    /**
+     * The number of expired groups in the pipeline.
+     */
+    expiredGroupCount: number;
+    /**
+     * The number of not started groups in the pipeline.
+     */
+    notStartedGroupCount: number;
+    /**
+     * The number of campaign groups in the pipeline.
+     */
+    campaignGroupCount: number;
+    /**
+     * The number of permanent groups in the pipeline.
+     */
+    permanentGroupCount: number;
+}
+export interface StatementGroupComposition {
+    /**
+     * The number of result ranking statements in this group.
+     */
+    resultRankingStatementCount: number;
+    /**
+     * The number of other types of statements in this group.
+     */
+    otherStatementCount: number;
+}
+export interface ListStatementGroupsOptions extends Paginated {
+    /**
+     * The 0-based number of the page of results to get.
+     */
+    page?: number;
+    /**
+     * The number of results to include per page.
+     */
+    perPage?: number;
+    /**
+     * The query filter to match.
+     *
+     * This allows you to search within group name, group user notes and condition definition.
+     */
+    filter?: string;
+    /**
+     * The list of group status allowed in the results.
+     * If you leave this parameter <em>undefined</em> or pass an empty array, all group's status will be allowed in the results.
+     */
+    status?: ListStatementGroupStatusType[];
+    /**
+     * The list of group types allowed in the results.
+     * If you leave this parameter <em>undefined</em> or pass an empty array, all group types will be allowed in the results.
+     */
+    types?: StatementGroupType[];
+}
+export declare type CreateStatementGroupModel = CreatePermanentStatementGroupModel | CreateCampaignStatementGroupModel;
+interface CreateStatementGroupModelBase {
+    /**
+     * The name of the statement group.
+     */
+    name: string;
+    /**
+     * The intended purpose of this statement group.
+     */
+    description?: string;
+    /**
+     * The unique identifier of the condition that must be satisfied for a request to be processed by the statement group.
+     */
+    conditionId?: string;
+}
+export interface CreatePermanentStatementGroupModel extends CreateStatementGroupModelBase {
+    type: StatementGroupType.permanent;
+    /**
+     * Whether the group is active.
+     */
+    isActive?: boolean;
+}
+export interface CreateCampaignStatementGroupModel extends CreateStatementGroupModelBase {
+    type: StatementGroupType.campaign;
+    /**
+     * The start date of the campaign.
+     * Format: ISO-8601
+     *
+     * @example 2020-09-09T19:00:45.603-04:00
+     */
+    campaignStart: string;
+    /**
+     * The end date of the campaign.
+     * Format: ISO-8601
+     *
+     * @example 2021-09-09T19:00:45.603-04:00
+     */
+    campaignEnd: string;
+}
+export declare type UpdateStatementGroupModel = UpdatePermanentStatementGroupModel | UpdateCampaignStatementGroupsModel;
+export interface UpdatePermanentStatementGroupModel extends CreatePermanentStatementGroupModel {
+}
+export interface UpdateCampaignStatementGroupsModel extends CreateCampaignStatementGroupModel {
+}
+export interface UpdateStatementGroupRuleAssociationsRequest {
+    /**
+     * The rules to add to this group. (max-length: 50)
+     *
+     * If you specify a rule from another group, it will be removed from the original group and added to this one instead.
+     *
+     * **Note**: Invalid rule IDs will cause the request to fail.
+     */
+    toAdd?: StatementGroupRuleAssociationItem[];
+    /**
+     * The rules to remove from this group. (max-length: 50)
+     *
+     * **Note**: Orphaned rules, rules that are associated with another group, and non-existent rules will be ignored.
+     */
+    toRemove?: StatementGroupRuleAssociationItem[];
+}
+export interface StatementGroupRuleAssociationItem {
+    /**
+     * The query pipeline feature that's enabled by this rule.
+     */
+    featureType: StatementGroupRuleAssociationFeatureTypeEnum;
+    /**
+     * The unique identifier of the rule.
+     */
+    ruleId: string;
+}
+export declare enum StatementGroupRuleAssociationFeatureTypeEnum {
+    ResultRankings = "resultRankings"
+}
+export interface UpdateStatementGroupRuleAssociationsResponse {
+    /**
+     * The rules associated with this group.
+     */
+    associatedRules: StatementGroupRuleAssociationItem[];
+}
+export {};

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

@@ -0,0 +1,2 @@
+export * from './StatementGroups';
+export * from './StatementGroupsInterfaces';

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

@@ -0,0 +1,16 @@
+import { PageModel } from '../../BaseInterfaces';
+import Resource from '../../Resource';
+import { CopyStatementModel, CreateStatementModel, ExportStatementParams, ListStatementParams, MoveStatementModel, StatementModel } from './StatementsInterfaces';
+export default class Statements extends Resource {
+    static getBaseUrl: (pipelineId: string) => string;
+    static getStatementUrl: (pipelineId: string, statementId: string) => string;
+    list(pipelineId: string, options?: ListStatementParams): Promise<PageModel<StatementModel, "statements">>;
+    exportCSV(pipelineId: string, options?: ExportStatementParams): Promise<Blob>;
+    importCSV(pipelineId: string, csvFile: File | string, options?: ExportStatementParams): Promise<Record<string, unknown>>;
+    create(pipelineId: string, model: CreateStatementModel): Promise<StatementModel>;
+    update(pipelineId: string, statementId: string, model: CreateStatementModel): Promise<StatementModel>;
+    copy(pipelineId: string, model: CopyStatementModel): Promise<PageModel<StatementModel, "statements">>;
+    get(pipelineId: string, statementId: string): Promise<StatementModel>;
+    move(pipelineId: string, statementId: string, model: MoveStatementModel): Promise<PageModel<StatementModel, "statements">>;
+    delete(pipelineId: string, statementId: string): Promise<Record<string, unknown>>;
+}

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

@@ -0,0 +1,139 @@
+import { Paginated } from '../../BaseInterfaces';
+import { ListStatementSortBy, StatementsFeature } from '../../Enums';
+import { ConditionModel } from '../Conditions';
+export interface StatementModel {
+    /**
+     * The unique identifier of this statement
+     */
+    id: string;
+    /**
+     * The query pipeline feature expressed by this statement
+     */
+    feature: StatementsFeature;
+    /**
+     * The query pipeline language expression that defines this statement
+     */
+    definition: string;
+    /**
+     * Whether the underlying Coveo Machine Learning model is ready. This property only has a meaning with recommendation, topClicks, and querySuggest statements.
+     */
+    ready: boolean;
+    detailed: any;
+    /**
+     * @deprecated this property is exposed for backward compatibility reasons.
+     */
+    childrenCount: number;
+    /**
+     * The 1-based position of this statement relative to other statements in the same query pipeline.
+     * Query pipeline statements are evaluated sequentially from the lowest to the highest position, which implies that higher-positioned statements can override or complement lower-positioned ones.
+     */
+    position: number;
+    /**
+     * The intended purpose of this statement in an actual implementation.
+     */
+    description?: string;
+    parent?: ConditionModel;
+    condition?: ConditionModel;
+    /**
+     * The warning messages that apply to this query pipeline statement.
+     */
+    warnings?: string[];
+    /**
+     * The display name for this Machine Learning model. This property only has a meaning with recommendation, topClicks, and querySuggest statements.
+     */
+    displayName?: string;
+    /**
+     * The identifier of the Coveo Cloud platform user who last modified this.
+     */
+    modifiedBy?: string;
+    /**
+     * The last time this was modified.
+     */
+    modifiedAt?: string;
+}
+export interface CreateStatementModel {
+    /**
+     * The query pipeline feature expressed by this statement
+     */
+    feature: StatementsFeature;
+    /**
+     * The query pipeline language expression that defines this statement
+     */
+    definition: string;
+    /**
+     * The 1-based position of this statement relative to other statements in the same query pipeline.
+     * Query pipeline statements are evaluated sequentially from the lowest to the highest position, which implies that higher-positioned statements can override or complement lower-positioned ones.
+     */
+    position: number;
+    /**
+     * The unique identifier of this statement
+     */
+    id?: string;
+    /**
+     * The intended purpose of this statement in an actual implementation.
+     */
+    description?: string;
+    parent?: string;
+}
+export interface MoveStatementModel {
+    /**
+     * The 1-based position of this statement relative to other statements in the same query pipeline.
+     * Query pipeline statements are evaluated sequentially from the lowest to the highest position, which implies that higher-positioned statements can override or complement lower-positioned ones.
+     */
+    position?: number;
+    after?: string;
+}
+export interface CopyStatementModel {
+    statementIds: string[];
+    destinationPipelineId: string;
+}
+/**
+ * @deprecated - Use `PageModel<StatementModel, 'statements'>` instead.
+ */
+export interface StatementModelList {
+    statements: StatementModel[];
+    totalEntries: number;
+    totalPages: number;
+}
+export interface ListStatementParams 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.
+     */
+    sortBy?: ListStatementSortBy;
+    /**
+     * The 0-based number of the page of results to get.
+     */
+    page?: number;
+    /**
+     * The number of results to include per page.
+     */
+    perPage?: number;
+    /**
+     * The query pipeline feature to match.
+     */
+    feature?: StatementsFeature;
+    /**
+     * The unique identifier of the target Coveo Cloud organization.
+     */
+    organizationId?: string;
+}
+export interface ExportStatementParams {
+    /**
+     * The query pipeline feature to match.
+     */
+    feature?: StatementsFeature;
+    /**
+     * The unique identifier of the target Coveo Cloud organization.
+     */
+    organizationId?: string;
+}

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

@@ -0,0 +1,2 @@
+export * from './Statements';
+export * from './StatementsInterfaces';

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

@@ -0,0 +1,8 @@
+export * from './Pipelines';
+export * from './PipelinesInterfaces';
+export * from './MLAssociations/';
+export * from './Statements/';
+export * from './ResultRankings/';
+export * from './Conditions';
+export * from './StatementGroups/';
+export * from './FacetStateRules';

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

@@ -0,0 +1,95 @@
+import API from '../APICore';
+import ApiKey from './ApiKeys/ApiKeys';
+import AWS from './AWS/AWS';
+import CaseAssistConfig from './CaseAssistConfigs/CaseAssistConfig';
+import Catalog from './Catalogs/Catalog';
+import CatalogConfiguration from './Catalogs/CatalogConfiguration';
+import Cluster from './Clusters/Cluster';
+import Connectivity from './Connectivity/Connectivity';
+import CrawlingModule from './CrawlingModule/CrawlingModule';
+import Extensions from './Extensions/Extensions';
+import Field from './Fields/Fields';
+import Global from './Global/Global';
+import GlobalGroup from './GlobalGroups/GlobalGroup';
+import Group from './Groups/Groups';
+import Index from './Indexes/Indexes';
+import InProductExperiences from './InProductExperiences/InProductExperiences';
+import InsightPanelConfig from './InsightPanelConfigs/InsightPanelConfig';
+import InsightPanelInterface from './InsightPanelInterfaces/InsightPanelInterface';
+import License from './License/License';
+import Limits from './Limits/Limits';
+import Links from './Links/Links';
+import Logs from './Logs/Logs';
+import MachineLearning from './MachineLearning/MachineLearning';
+import ModifierTemplates from './ModifierTemplates/ModifierTemplates';
+import Notifications from './Notification/notification';
+import Organization from './Organizations/Organization';
+import Pipelines from './Pipelines/Pipelines';
+import PrivilegeEvaluator from './PrivilegeEvaluator/PrivilegeEvaluator';
+import ProductListing from './Catalogs/ProductListing';
+import Products from './Products/Product';
+import PushApi from './PushApi/PushApi';
+import ResourceSnapshots from './ResourceSnapshots/ResourceSnapshots';
+import Saml from './Saml/Saml';
+import SchemaService from './SchemaService/SchemaService';
+import Search from './Search/Search';
+import SearchInterfaces from './SearchInterfaces/SearchInterfaces';
+import SearchPages from './SearchPages/SearchPages';
+import SearchUsageMetrics from './SearchUsageMetrics/SearchUsageMetrics';
+import SecurityCache from './SecurityCache/SecurityCache';
+import Sources from './Sources/Sources';
+import UsageAnalytics from './UsageAnalytics/UsageAnalytics';
+import User from './Users/User';
+import Vaults from './Vaults/Vaults';
+import TableauService from './TableauService/TableauService';
+import Access from './OrganizationAccess/Access';
+declare class PlatformResources {
+    protected API: API;
+    protected ServerlessAPI: API;
+    apiKey: ApiKey;
+    aws: AWS;
+    caseAssistConfig: CaseAssistConfig;
+    catalog: Catalog;
+    catalogConfiguration: CatalogConfiguration;
+    cluster: Cluster;
+    crawlingModule: CrawlingModule;
+    connectivity: Connectivity;
+    extension: Extensions;
+    field: Field;
+    global: Global;
+    globalGroup: GlobalGroup;
+    group: Group;
+    index: Index;
+    insightPanelConfig: InsightPanelConfig;
+    insightPanelInterface: InsightPanelInterface;
+    ipx: InProductExperiences;
+    license: License;
+    limits: Limits;
+    links: Links;
+    logs: Logs;
+    ml: MachineLearning;
+    modifierTemplates: ModifierTemplates;
+    notification: Notifications;
+    organization: Organization;
+    organizationAccess: Access;
+    pipeline: Pipelines;
+    privilegeEvaluator: PrivilegeEvaluator;
+    productListing: ProductListing;
+    products: Products;
+    pushApi: PushApi;
+    resourceSnapshot: ResourceSnapshots;
+    saml: Saml;
+    schemaService: SchemaService;
+    search: Search;
+    searchInterfaces: SearchInterfaces;
+    searchPages: SearchPages;
+    searchUsageMetrics: SearchUsageMetrics;
+    securityCache: SecurityCache;
+    source: Sources;
+    ua: UsageAnalytics;
+    user: User;
+    vault: Vaults;
+    tableauService: TableauService;
+    registerAll(): void;
+}
+export default PlatformResources;

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

@@ -0,0 +1,11 @@
+import Ressource from '../Resource';
+import { PrivilegeEvaluatorModel } from './PrivilegeEvaluatorInterfaces';
+export default class PrivilegeEvaluator extends Ressource {
+    static baseUrl: string;
+    /**
+     * Evaluates a specific privilege request
+     *
+     * @param {RestTokenParams} privilegeEvaluatorParams The privilege request to evaluate
+     */
+    evaluate(privilegeEvaluatorParams: PrivilegeEvaluatorModel): Promise<PrivilegeEvaluatorModel>;
+}

package/dist/definitions/resources/PrivilegeEvaluator/PrivilegeEvaluatorInterfaces.d.ts

@@ -0,0 +1,29 @@
+import { PrivilegeModel } from '../BaseInterfaces';
+export interface PrivilegeEvaluatorModel {
+    /**
+     * Whether the request has been approved.
+     */
+    approved?: boolean;
+    /**
+     * A privilege request evaluation report.
+     */
+    evaluationReport?: PrivilegeRequestEvaluationReportModel;
+    /**
+     * The unique identifier of the organization in which the target privilege applies.
+     */
+    organizationId?: string;
+    /**
+     * The unique identifier of the organization in which the target privilege applies.
+     */
+    requestedPrivilege: PrivilegeModel;
+}
+export declare enum PrivilegeRequestEvaluationReportModel {
+    operationForbiddenForAnonymousAuthentication = "OPERATION_FORBIDDEN_FOR_ANONYMOUS_AUTHENTICATION",
+    operationForbiddenForAuthenticationBoundToDifferentOrganization = "OPERATION_FORBIDDEN_FOR_AUTHENTICATION_BOUND_TO_DIFFERENT_ORGANIZATION",
+    operationForbiddenForOrganization = "OPERATION_FORBIDDEN_FOR_ORGANIZATION",
+    operationForbiddenForOrganizationInReadOnly = "OPERATION_FORBIDDEN_FOR_ORGANIZATION_IN_READ_ONLY",
+    operationForbiddenFromRequestLocation = "OPERATION_FORBIDDEN_FROM_REQUEST_LOCATION",
+    operationForbiddenInvalidPrivilegeRequest = "OPERATION_FORBIDDEN_INVALID_PRIVILEGE_REQUEST",
+    operationGranted = "OPERATION_GRANTED",
+    operationNotAllowed = "OPERATION_NOT_ALLOWED"
+}

package/dist/definitions/resources/PrivilegeEvaluator/index.d.ts

@@ -0,0 +1,2 @@
+export * from './PrivilegeEvaluator';
+export * from './PrivilegeEvaluatorInterfaces';

package/dist/definitions/resources/Products/Product.d.ts

@@ -0,0 +1,7 @@
+import { New } from '../BaseInterfaces';
+import Resource from '../Resource';
+import { ProductsRequestModel, ProductsResultModel } from './ProductInterfaces';
+export default class Products extends Resource {
+    static baseUrl: string;
+    get(productsRequest: New<ProductsRequestModel>): Promise<ProductsResultModel>;
+}