@coveo/platform-client 0.0.0-cjs-attempt

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

@@ -0,0 +1,176 @@
+import { Paginated } from '../BaseInterfaces.js';
+import { LicenseModel } from '../License/index.js';
+import { ModifierModel, ModifierStatementModel } from '../ModifierTemplates/ModifierTemplateInterfaces.js';
+/**
+ * Describes the status of an organization.
+ */
+export interface OrganizationsStatusModel {
+    /**
+     * A list of error codes that are present in the organization at the time of the request.
+     *
+     * **Allowed values:**
+     * - `SEARCH_ERROR`: An error occurred during a search request.
+     * - `PAUSING_FAILED`: An error occurred when attempting to pause the organization.
+     * - `RESUMING_FAILED`: An error occurred when attempting to resume the organization.
+     */
+    errorCodes: string[];
+    /**
+     * The life-cycle state of the organization.
+     *
+     * **Allowed values:**
+     * - `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;
+    /**
+     * The pause status of the organization.
+     *
+     * **Allowed values:**
+     * - `ACTIVE`: The organization is active.
+     * - `IDLE`: The organization is inactive.
+     * - `PAUSING`: The organization is transitioning to `PAUSED`.
+     * - `PAUSED`: The organization is paused.
+     * - `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;
+    /**
+     * Whether the organization is currently paused.
+     */
+    paused: boolean;
+    /**
+     * The provisioning status of the organization.
+     */
+    provisioningStatus: {
+        /**
+         * The progress, in percentage, of the ongoing provisioning.
+         *
+         * @example `100`
+         */
+        currentProvisioningProgress: number;
+        /**
+         * Whether the initial provisioning has been completed.
+         */
+        initialProvisioningDone: boolean;
+        /**
+         * The last time provisioning was successfully completed in number of milliseconds since UNIX epoch.
+         *
+         * @example `1556722921779`
+         */
+        lastProvisioningCompletedDate: number;
+        /**
+         * Whether the provisioning is currently ongoing.
+         */
+        ongoing: boolean;
+        /**
+         * The status of the last provisioning.
+         *
+         * **Allowed values:**
+         * - `ERROR`: The last provisioning failed with an error.
+         * - `HEALTHY`: The last provisioning finished successfully.
+         */
+        status: string;
+    };
+    /**
+     * 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;
+    /**
+     * The current status of the organization.
+     *
+     * **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;
+    /**
+     * Whether support has been activated for the organization.
+     * See [Coveo Customer Global Support and Success Guide](https://docs.coveo.com/en/1352/).
+     */
+    supportActivated: boolean;
+}
+export interface OrganizationModel {
+    id: string;
+    displayName: string;
+    createdDate: number;
+    publicContentOnly: boolean;
+    type: string;
+    owner: {
+        email: string;
+    };
+    readOnly: boolean;
+    license?: LicenseModel;
+    organizationStatusModel?: OrganizationsStatusModel;
+}
+export type AdditionalOrganizationField = 'status' | 'license' | string;
+export interface GetOrganizationOptions {
+    additionalFields?: AdditionalOrganizationField | AdditionalOrganizationField[];
+}
+export interface ListOrganizationOptions extends Paginated {
+    additionalFields?: AdditionalOrganizationField | AdditionalOrganizationField[];
+    filter?: string;
+    order?: string;
+    sortBy?: string;
+    type?: string;
+}
+export interface CreateOrganizationOptions {
+    name: string;
+    organizationTemplate?: string;
+    owner?: string;
+    creationOrigin?: OrganizationCreationOrigin;
+}
+export interface DefinitionModel {
+    /**
+     * Id of the organization the definition applies to
+     */
+    organizationId: string;
+    /**
+     * License template used as the "foundation" before applying the modifiers and overrides
+     */
+    baseLicenseTemplateId: string;
+    /**
+     * List of modifiers to apply when computing the resulting license
+     */
+    modifiers: ModifierModel[];
+    /**
+     * List of overrides to apply when computing the resulting license
+     */
+    overrides: OverrideModel[];
+}
+export interface OverrideModel {
+    /**
+     * Id of the override
+     * Every organization is given a "Default" override which should be used a vast majority of the time
+     */
+    id: string;
+    /**
+     * List of statements to apply when computing the resulting license
+     */
+    statements: ModifierStatementModel[];
+}
+export declare enum OrganizationCreationOrigin {
+    ADMIN_UI = "ADMIN_UI",
+    API = "API",
+    CLI = "CLI",
+    BUSINESS_CRM = "BUSINESS_CRM",
+    TRAINING = "TRAINING",
+    PARTNER_PROGRAM = "PARTNER_PROGRAM",
+    TEST = "TEST",
+    WEBSITE = "WEBSITE",
+    SALESFORCE_INTEGRATION_TRIAL = "SALESFORCE_INTEGRATION_TRIAL",
+    SERVICENOW_INTEGRATION_TRIAL = "SERVICENOW_INTEGRATION_TRIAL",
+    SITECORE_INTEGRATION_TRIAL = "SITECORE_INTEGRATION_TRIAL",
+    UNKNOWN = "UNKNOWN"
+}

package/dist/types/resources/Organizations/index.d.ts

@@ -0,0 +1,3 @@
+export * from './Organization.js';
+export * from './OrganizationInterfaces.js';
+export * from './Members/index.js';

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

@@ -0,0 +1,44 @@
+import { PageModel } from '../../BaseInterfaces.js';
+import Resource from '../../Resource.js';
+import { ConditionModel, ListConditionsOptions, NewConditionModel } from './ConditionInterfaces.js';
+export default class Condition extends Resource {
+    static baseUrl: string;
+    /**
+     * Returns a paginated list of condition models.
+     *
+     * @param {ListConditionsOptions} options
+     */
+    list(options?: ListConditionsOptions): Promise<PageModel<ConditionModel, "statements">>;
+    /**
+     * Creates and returns a new condition model.
+     *
+     * @param {NewConditionModel} conditionModel
+     */
+    create(conditionModel: NewConditionModel): Promise<ConditionModel>;
+    /**
+     * Delete a condition model.
+     *
+     * @param {string} 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.
+     */
+    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
+     */
+    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
+     */
+    bulkGet(conditionIds: string[], params?: ListConditionsOptions): Promise<PageModel<ConditionModel, "statements">>;
+}

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

@@ -0,0 +1,89 @@
+import { Paginated } from '../../BaseInterfaces.js';
+import { ListStatementSortBy } from '../../Enums.js';
+export interface ConditionModel {
+    /**
+     * The unique identifier of this statement.
+     */
+    id: string;
+    /**
+     * The intented purpose of thi statement in an actual implementation.
+     */
+    description: string;
+    /**
+     * The query pipeline language expression that defines this statement.
+     */
+    definition: string;
+    /**
+     * The structured object of the query pipeline language expression of this statement.
+     */
+    detailed: any;
+    /**
+     * @deprecated
+     * This property is exposed for backward compatibility reasons.
+     */
+    childrenCount: number;
+    /**
+     * @deprecated
+     * This property is exposed for backward compatibility reasons.
+     */
+    feature: string;
+    /**
+     * @deprecated
+     * This property is exposed for backward compatibility reasons.
+     */
+    position: number;
+    /**
+     * @deprecated
+     * This property is exposed for backward compatibility reasons.
+     */
+    ready: boolean;
+    /**
+     * @deprecated
+     * This property is exposed for backward compatibility reasons.
+     */
+    parent?: string;
+    /**
+     * @deprecated
+     * This property is exposed for backward compatibility reasons.
+     */
+    condition?: string;
+}
+export interface NewConditionModel {
+    /**
+     * The query pipeline language expression that defines this statement.
+     */
+    definition: string;
+    /**
+     * The unique identifier of this statement.
+     */
+    id?: string;
+    /**
+     * The intented purpose of this statement in an actual implementation.
+     */
+    description?: string;
+}
+export interface ListConditionsOptions extends Paginated {
+    /**
+     * Whether to sort the results in ascending order.
+     *
+     * @default true
+     */
+    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.
+     *
+     * @default ListStatementSortBy.Position
+     */
+    sortBy?: ListStatementSortBy;
+    /**
+     * The unique identifier of the target Coveo Cloud organization.
+     * The value set by default is provided by the API resource
+     */
+    organizationId?: string;
+}

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

@@ -0,0 +1,2 @@
+export * from './Condition.js';
+export * from './ConditionInterfaces.js';

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

@@ -0,0 +1,11 @@
+import Ressource from '../../Resource.js';
+import { FacetStateRule, ListFacetStateRuleParams, ListFacetStateRuleResponse } from './FacetStateRulesInterface.js';
+export default class FacetStateRules extends Ressource {
+    static getBaseUrl: (pipelineId: string) => string;
+    list(pipelineId: string, params?: ListFacetStateRuleParams): Promise<ListFacetStateRuleResponse>;
+    get(pipelineId: string, facetStateRuleId: string): Promise<FacetStateRule>;
+    create(pipelineId: string, facetStateRule: FacetStateRule): Promise<FacetStateRule>;
+    update(pipelineId: string, facetStateRuleId: string, facetStateRule: FacetStateRule): Promise<void>;
+    delete(pipelineId: string, facetStateRuleId: string): Promise<void>;
+    move(pipelineId: string, facetStateRuleId: string, position: number): Promise<void>;
+}

package/dist/types/resources/Pipelines/FacetStateRules/FacetStateRulesInterface.d.ts

@@ -0,0 +1,45 @@
+import { Paginated } from '../../BaseInterfaces.js';
+import { FacetRuleKind, FacetRuleState, ListStatementSortBy, PredicateKind, PredicateLocaleKind, PredicateMatchOperator } from '../../Enums.js';
+export interface IdentifiedFacetStateRule {
+    id: string;
+    position: number;
+    rule: FacetStateRule;
+}
+export interface FacetStateRule {
+    condition?: FacetStateRuleCondition;
+    defaultMatchOperator?: FacetStateRuleMatchOperator;
+    description?: string;
+    field?: string;
+    kind: FacetRuleKind;
+    predicates?: FacetStateRulePredicate[];
+    state?: FacetRuleState;
+    values?: string[];
+}
+export interface FacetStateRuleCondition {
+    reference: string;
+}
+export interface FacetStateRulePredicate {
+    basicQueryExpression?: string;
+    code?: string;
+    kind: PredicateKind;
+    locale?: PredicateLocale;
+    matchOperator: FacetStateRuleMatchOperator;
+}
+export interface FacetStateRuleMatchOperator {
+    kind: PredicateMatchOperator;
+}
+export interface PredicateLocale {
+    code: string;
+    kind: PredicateLocaleKind;
+}
+export interface ListFacetStateRuleParams extends Paginated {
+    isOrderAscending?: boolean;
+    filter?: string;
+    sortBy?: ListStatementSortBy;
+    organizationId: string;
+}
+export interface ListFacetStateRuleResponse {
+    facetStateRules: IdentifiedFacetStateRule[];
+    totalCount: number;
+    totalPages: number;
+}

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

@@ -0,0 +1,2 @@
+export * from './FacetStateRules.js';
+export * from './FacetStateRulesInterface.js';

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

@@ -0,0 +1,14 @@
+import { PageModel } from '../../BaseInterfaces.js';
+import Resource from '../../Resource.js';
+import { AssociatedPipelinesData, BulkGetAssociationsParams, CreateAssociation, EditAssociation, ListAssociationsParams, MLAssociationModel } from './MLAssociationsInterfaces.js';
+export default class MLAssociations extends Resource {
+    static getBaseUrl: (pipelineId: string) => string;
+    list(pipelineId: string, options?: ListAssociationsParams): Promise<PageModel<MLAssociationModel, "rules">>;
+    associate(pipelineId: string, options: CreateAssociation): Promise<Record<string, unknown>>;
+    getAssociation(pipelineId: string, associationId: string): Promise<MLAssociationModel>;
+    disassociate(pipelineId: string, associationId: string): Promise<Record<string, unknown>>;
+    updateAssociation(pipelineId: string, associationId: string, options?: EditAssociation): Promise<Record<string, unknown>>;
+    updatePosition(pipelineId: string, associationId: string, position: number): Promise<Record<string, unknown>>;
+    getAssociatedPipelines(): Promise<AssociatedPipelinesData[]>;
+    bulkGet(pipelineId: string, { ids, ...allQueryStringOptions }: BulkGetAssociationsParams): Promise<PageModel<MLAssociationModel, "rules">>;
+}

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

@@ -0,0 +1,60 @@
+import { Paginated } from '../../BaseInterfaces.js';
+import { ModelTypes } from '../../Enums.js';
+/**
+ * @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 BulkGetAssociationsParams extends Paginated {
+    ids: string[];
+}
+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/types/resources/Pipelines/MLAssociations/index.d.ts

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

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

@@ -0,0 +1,30 @@
+import API from '../../APICore.js';
+import { GranularResource } from '../BaseInterfaces.js';
+import Resource from '../Resource.js';
+import Condition from './Conditions/Condition.js';
+import FacetStateRules from './FacetStateRules/FacetStateRules.js';
+import MLAssociations from './MLAssociations/MLAssociations.js';
+import { ListPipelinesOptions, ListPipelinesReturnVariant, NewPipelineModel, PipelineBackendVersion, PipelineModel, UpdatePipelineModel } from './PipelinesInterfaces.js';
+import ResultRankings from './ResultRankings/ResultRankings.js';
+import StatementGroups from './StatementGroups/StatementGroups.js';
+import Statements from './Statements/Statements.js';
+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>;
+}