@coveo/platform-client 0.0.0-clidev.1 → 0.0.0-development

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

@@ -1,176 +0,0 @@
-import { Paginated } from '../BaseInterfaces';
-import { LicenseModel } from '../License';
-import { ModifierModel, ModifierStatementModel } from '../ModifierTemplates/ModifierTemplateInterfaces';
-/**
- * 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 declare 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/definitions/resources/Organizations/index.d.ts

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

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

@@ -1,11 +0,0 @@
-import { PageModel } from '../../BaseInterfaces';
-import Resource from '../../Resource';
-import { ConditionModel, ListConditionsOptions, NewConditionModel } from './ConditionInterfaces';
-export default class Condition extends Resource {
-    static baseUrl: string;
-    list(options?: ListConditionsOptions): Promise<PageModel<ConditionModel, "statements">>;
-    create(conditionModel: NewConditionModel): Promise<ConditionModel>;
-    delete(conditionId: string): Promise<Record<string, unknown>>;
-    get(conditionId: string): Promise<ConditionModel>;
-    update(conditionId: string, conditionModel: ConditionModel | NewConditionModel): Promise<ConditionModel>;
-}

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

@@ -1,25 +0,0 @@
-import { Paginated } from '../../BaseInterfaces';
-import { ListStatementSortBy } from '../../Enums';
-export interface ConditionModel {
-    id: string;
-    description: string;
-    definition: string;
-    detailed: any;
-    childrenCount: number;
-    feature: string;
-    position: number;
-    ready: boolean;
-    parent?: string;
-    condition?: string;
-}
-export interface NewConditionModel {
-    definition: string;
-    id?: string;
-    description?: string;
-}
-export interface ListConditionsOptions extends Paginated {
-    isOrderDescending?: boolean;
-    filter?: string;
-    sortBy?: ListStatementSortBy;
-    organizationId?: string;
-}

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

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

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

@@ -1,11 +0,0 @@
-import Ressource from '../../Resource';
-import { FacetStateRule, ListFacetStateRuleParams, ListFacetStateRuleResponse } from './FacetStateRulesInterface';
-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/definitions/resources/Pipelines/FacetStateRules/FacetStateRulesInterface.d.ts

@@ -1,45 +0,0 @@
-import { Paginated } from '../../BaseInterfaces';
-import { FacetRuleKind, FacetRuleState, ListStatementSortBy, PredicateKind, PredicateLocaleKind, PredicateMatchOperator } from '../../Enums';
-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/definitions/resources/Pipelines/FacetStateRules/index.d.ts

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

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

@@ -1,13 +0,0 @@
-import { PageModel } from '../../BaseInterfaces';
-import Resource from '../../Resource';
-import { AssociatedPipelinesData, CreateAssociation, EditAssociation, ListAssociationsParams, MLAssociationModel } from './MLAssociationsInterfaces';
-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[]>;
-}

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

@@ -1,57 +0,0 @@
-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 +0,0 @@
-export * from './MLAssociations';
-export * from './MLAssociationsInterfaces';

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

@@ -1,30 +0,0 @@
-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, 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(options?: ListPipelinesOptions): Promise<PipelineModel[]>;
-    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,183 +0,0 @@
-import { GranularResource, 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 {
-    isOrderAscending?: boolean;
-    filter?: string;
-    sortby?: string;
-    feature?: string;
-    organizationId?: string;
-}
-export {};

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

@@ -1,15 +0,0 @@
-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>;
-}