@coveo/platform-client 35.0.0

package/dist/definitions/resources/Notification/Subscription/SubscriptionInterfaces.d.ts

@@ -0,0 +1,41 @@
+import { SubscriptionFrequencyEnum, SubscriptionStatusHealthIndicatorEnum, SubscriptionTypeEnum } from '../../Enums';
+export interface EditSubscriptionModel {
+    description?: string;
+    enabled: boolean;
+    frequency: SubscriptionFrequencyEnum;
+    name: string;
+    parameters?: SubscriptionParameters;
+    pattern?: SubscriptionPatternModel;
+    type: SubscriptionTypeEnum;
+}
+export interface SubscriptionModel extends EditSubscriptionModel {
+    createdDate: number;
+    id: string;
+    lastModified: number;
+    organizationId: string;
+    status?: SubscriptionStatusModel;
+    userId: string;
+}
+export interface SubscriptionParameters {
+    emailRecipients?: string[];
+    emailSubject?: string;
+    fromDisplayName?: string;
+    serviceUrl?: string;
+}
+export interface SubscriptionPatternModel {
+    content: Record<string, unknown>;
+    operations: string[];
+    resourceTypes: string[];
+    resultTypes: string[];
+}
+export interface SubscriptionStatusModel {
+    healthIndicator: SubscriptionStatusHealthIndicatorEnum;
+    latestResponseMessage: string;
+    statistics: SubscriptionStatisticsModel;
+}
+export interface SubscriptionStatisticsModel {
+    numberOfCancellations: number;
+    numberOfErrors: number;
+    numberOfFailures: number;
+    numberOfSucces: number;
+}

package/dist/definitions/resources/Notification/Subscription/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Subscription';
+export * from './SubscriptionInterfaces';

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

@@ -0,0 +1,2 @@
+export * from './Subscription';
+export * from './notification';

package/dist/definitions/resources/Notification/notification.d.ts

@@ -0,0 +1,9 @@
+import API from '../../APICore';
+import Resource from '../Resource';
+import Subscription from './Subscription/Subscription';
+export default class Notifications extends Resource {
+    protected api: API;
+    protected serverlessApi: API;
+    subscription: Subscription;
+    constructor(api: API, serverlessApi: API);
+}

package/dist/definitions/resources/OrganizationAccess/Access.d.ts

@@ -0,0 +1,7 @@
+import Resource from '../Resource';
+import { AccessModel, AccessParams } from './AccessInterfaces';
+export default class Access extends Resource {
+    static baseUrl: string;
+    getApiKeys(params: AccessParams): Promise<AccessModel[]>;
+    getGroups(params: AccessParams): Promise<AccessModel[]>;
+}

package/dist/definitions/resources/OrganizationAccess/AccessInterfaces.d.ts

@@ -0,0 +1,13 @@
+import { AccessLevel, PrivilegeholderType } from '../Enums';
+export interface AccessParams {
+    accessLevel: AccessLevel[];
+    privilegeOwner: string;
+    privilegeTargetDomain: string;
+}
+export interface AccessModel {
+    accessLevel: AccessLevel[];
+    callerPartOf: boolean;
+    displayName: string;
+    id: string;
+    privilegeholderType: PrivilegeholderType[];
+}

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

@@ -0,0 +1,2 @@
+export * from './Access';
+export * from './AccessInterfaces';

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

@@ -0,0 +1,8 @@
+import Resource from '../../Resource';
+import { OrganizationMemberModel } from './MembersInterface';
+export default class Members extends Resource {
+    static baseUrl: string;
+    getAll(): Promise<OrganizationMemberModel[]>;
+    delete(username: string): Promise<void>;
+    get(username: string): Promise<OrganizationMemberModel>;
+}

package/dist/definitions/resources/Organizations/Members/MembersInterface.d.ts

@@ -0,0 +1,37 @@
+import { AuthProvider } from '../../Enums';
+export interface OrganizationMemberModel {
+    /**
+     * The display name of the member
+     */
+    displayName: string;
+    /**
+     * The email address of the member
+     */
+    email: string;
+    /**
+     * The groups the member is a part of
+     */
+    groups: OrganizationMemberGroupModel[];
+    /**
+     * The provider of the member
+     */
+    provider: AuthProvider;
+    /**
+     * The username used for the assigned provider
+     */
+    providerUsername: string;
+    /**
+     * The username of the member
+     */
+    username: string;
+}
+export interface OrganizationMemberGroupModel {
+    /**
+     * The display name of the group
+     */
+    displayName: string;
+    /**
+     * The id of the group
+     */
+    id: string;
+}

package/dist/definitions/resources/Organizations/Members/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Members';
+export * from './MembersInterface';

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

@@ -0,0 +1,42 @@
+import API from '../../APICore';
+import { PageModel, PrivilegeModel } from '../BaseInterfaces';
+import Resource from '../Resource';
+import Members from './Members/Members';
+import { CreateOrganizationOptions, DefinitionModel, GetOrganizationOptions, ListOrganizationOptions, OrganizationModel, OrganizationsStatusModel } from './OrganizationInterfaces';
+import { AuthProvider } from '../Enums';
+export declare type NoPagination = undefined | null;
+export default class Organization extends Resource {
+    protected api: API;
+    protected serverlessApi: API;
+    static baseUrl: string;
+    members: Members;
+    constructor(api: API, serverlessApi: API);
+    list(noPagination?: NoPagination): Promise<OrganizationModel[]>;
+    list<T extends ListOrganizationOptions>(options: T): keyof T extends never ? Promise<OrganizationModel[]> : Promise<PageModel<OrganizationModel>>;
+    create(options: CreateOrganizationOptions): Promise<OrganizationModel>;
+    delete(organizationId: string): Promise<Record<string, unknown>>;
+    get(organizationId: string, options?: GetOrganizationOptions): Promise<OrganizationModel>;
+    update(organization: Partial<OrganizationModel>): Promise<OrganizationModel>;
+    updateSupportActivated(organizationId: string, supportActivated: boolean): Promise<Record<string, unknown>>;
+    status(organizationId?: string): Promise<OrganizationsStatusModel>;
+    /**
+     * Pauses an [organization](https://docs.coveo.com/en/222/).
+     * Required privilege: Organization - Edit
+     */
+    pause(organizationId?: string): Promise<Record<string, unknown>>;
+    /**
+     * Resumes a paused [organization](https://docs.coveo.com/en/222/).
+     * Required privilege: Organization - Edit
+     */
+    resume(organizationId?: string): Promise<Record<string, unknown>>;
+    updateAdditionalInformation(additionalInformationObj: Record<string, unknown>): Promise<Record<string, unknown>>;
+    getAdditionalInformation(organizationId?: string): Promise<any>;
+    getExperimentalStatus(organizationId?: string): Promise<boolean>;
+    updateExperimentalStatus(isAllowed?: boolean): Promise<boolean>;
+    listPrivileges(): Promise<PrivilegeModel[]>;
+    listMyPrivileges(): Promise<PrivilegeModel[]>;
+    listApiKeysPrivileges(): Promise<PrivilegeModel[]>;
+    getDefinition(): Promise<DefinitionModel>;
+    updateDefinition(organizationDefinition: DefinitionModel): Promise<DefinitionModel>;
+    getAllowedAuthenticationProviders(organizationId?: string): Promise<AuthProvider[]>;
+}

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

@@ -0,0 +1,176 @@
+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

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

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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,25 @@
+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

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

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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,45 @@
+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

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

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

@@ -0,0 +1,13 @@
+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

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

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

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

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

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