@coveo/platform-client 0.0.0-cjs-attempt

package/dist/types/resources/MachineLearning/Models/ModelsInterfaces.d.ts

@@ -0,0 +1,49 @@
+import { GranularResource } from '../../BaseInterfaces.js';
+import { IntervalUnit, ModelActivenessState, ModelStatus } from '../../Enums.js';
+import { AssociatedPipelineModel } from '../../Pipelines/index.js';
+import { MLModelInfo, MLModelTypeInfo } from '../ModelInformation/index.js';
+export interface MLModel<T extends MLModelTypeInfo = never> extends MLModelInfo<T>, ModelAttributes, GranularResource {
+    orgId: string;
+    id: string;
+    engineId: string;
+    modelName: string;
+    modelDisplayName?: string;
+    modelCreationTime: number;
+    nextModelUpdateTime?: number;
+    modelVersion?: string;
+    engineVersion?: string;
+    platformVersion?: 1 | 2;
+    versionMatcher?: string;
+    modelErrorDescription?: ModelErrorDescription;
+    previousModelUpdateTime?: number;
+    intervalTime: number;
+    intervalUnit: IntervalUnit;
+    exportPeriod: string;
+    exportOffset?: string;
+    status: ModelStatus;
+    commandLineParameters?: string[];
+    extraConfig?: {
+        [key: string]: any;
+    };
+    commonFilter?: string;
+    customEventFilter?: string;
+    searchEventFilter?: string;
+    viewEventFilter?: string;
+    modelSizeStatistic?: number;
+    modelActivenessState?: ModelActivenessState;
+}
+export interface ModelErrorDescription {
+    customer_errors?: CustomerError[];
+}
+export interface CustomerError {
+    description?: string;
+    errorCode?: string;
+    errorType?: string;
+    precision?: string;
+    troubleshoot?: string;
+}
+export interface ModelAttributes {
+    associatedPipelines?: AssociatedPipelineModel[];
+    parsedExportOffset?: string;
+    parsedExportPeriod?: string;
+}

package/dist/types/resources/MachineLearning/Models/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Models.js';
+export * from './ModelsInterfaces.js';

package/dist/types/resources/MachineLearning/PQSConfiguration/PQSConfiguration.d.ts

@@ -0,0 +1,6 @@
+import Resource from '../../Resource.js';
+import { PQSConfigurationModel } from './PQSConfigurationInterfaces.js';
+export default class PQSConfiguration extends Resource {
+    static baseUrl: string;
+    createPQSModel(model: PQSConfigurationModel): Promise<PQSConfigurationModel>;
+}

package/dist/types/resources/MachineLearning/PQSConfiguration/PQSConfigurationInterfaces.d.ts

@@ -0,0 +1,40 @@
+import { IntervalUnit } from '../../Enums.js';
+export interface PQSConfigurationModel {
+    /**
+     * The unique identifier of the catalog to be used by the model to infer
+     * personalized suggestions based on product vectors.
+     */
+    catalogId: string;
+    /**
+     * The filter to apply to the 'Common' event dimensions (shared by all event types)
+     * of the UA data to learn from when rebuilding the model.
+     */
+    commonFilter?: string;
+    /**
+     * The period of UA data to learn from when rebuilding the model.
+     * The exportPeriod uses the moment when the model was last generated as a base.
+     * Must be in the ISO8601 period format (i.e., PyYmMwWdDThHmMsS).
+     */
+    exportPeriod?: string;
+    /**
+     * The number of intervalUnit to wait between each rebuild of the model.
+     * Must be greater than or equal to 1.
+     */
+    intervalTime?: number;
+    /**
+     * The duration unit to use when interpreting the rebuild intervalTime for the model.
+     */
+    intervalUnit?: IntervalUnit;
+    /**
+     * The model display name in the Coveo Administration console.
+     */
+    modelDisplayName: string;
+    /**
+     * The unique identifier of the target machine learning model.
+     */
+    modelId?: string;
+    /**
+     * The filter to apply to the 'Click' and 'Search' event dimensions of the UA data to learn from when rebuilding the model.
+     */
+    searchEventFilter?: string;
+}

package/dist/types/resources/MachineLearning/PQSConfiguration/index.d.ts

@@ -0,0 +1,2 @@
+export * from './PQSConfiguration.js';
+export * from './PQSConfigurationInterfaces.js';

package/dist/types/resources/MachineLearning/SmartSnippetsConfiguration/SmartSnippetsConfiguration.d.ts

@@ -0,0 +1,17 @@
+import { New } from '../../BaseInterfaces.js';
+import Resource from '../../Resource.js';
+import { SmartSnippetsConfigurationModel, SmartSnippetsContentFields, SmartSnippetsContentFieldsParams, SmartSnippetsDocumentGroupPreview, SmartSnippetsDocumentGroupPreviewParams, SmartSnippetsDocumentTypes, SmartSnippetsDocumentTypesParams } from './SmartSnippetsConfigurationInterfaces.js';
+export default class SmartSnippetsConfiguration extends Resource {
+    static baseUrl: string;
+    static modelUrl: string;
+    static contentFieldsUrl: string;
+    static documentTypesUrl: string;
+    static previewUrl: string;
+    create(configModel: New<SmartSnippetsConfigurationModel, 'modelId'>): Promise<SmartSnippetsConfigurationModel>;
+    delete(modelId: string): Promise<Record<string, unknown>>;
+    get(modelId: string): Promise<SmartSnippetsConfigurationModel>;
+    update(configModel: SmartSnippetsConfigurationModel): Promise<SmartSnippetsConfigurationModel>;
+    contentFields(params: SmartSnippetsContentFieldsParams): Promise<SmartSnippetsContentFields>;
+    documentTypes(params: SmartSnippetsDocumentTypesParams): Promise<SmartSnippetsDocumentTypes>;
+    preview(params: SmartSnippetsDocumentGroupPreviewParams): Promise<SmartSnippetsDocumentGroupPreview>;
+}

package/dist/types/resources/MachineLearning/SmartSnippetsConfiguration/SmartSnippetsConfigurationInterfaces.d.ts

@@ -0,0 +1,131 @@
+import { FilterConditions } from '../FilterConditions.js';
+export interface DocumentType {
+    /**
+     * The fields containing the content to use for smart snippets.
+     */
+    contentFields: string[];
+    /**
+     * The document type.
+     */
+    documentType: string;
+}
+export interface SmartSnippetsConfigurationModel {
+    /**
+     * The unique ID of the model.
+     */
+    modelId: string;
+    /**
+     * The model name to display.
+     * Example: My First Model
+     */
+    modelDisplayName: string;
+    /**
+     * The sources to consider.
+     */
+    sources: string[];
+    /**
+     * An array of filtering conditions.
+     */
+    filterConditions: FilterConditions[];
+    /**
+     * An array of css selectors to evaluate content to exclude.
+     */
+    cssSelectorsToExclude?: string[];
+    /**
+     * The document type for which content is in custom index fields.
+     */
+    documentTypes?: DocumentType[];
+}
+export type SmartSnippetsDocumentRequirementStatus = 'OK' | 'INSUFFICIENT_DOCUMENTS';
+export interface SmartSnippetsDocumentGroupPreviewParams {
+    /**
+     * The sources to consider.
+     */
+    sources: string[];
+    /**
+     * An array of filtering conditions.
+     */
+    filterConditions: FilterConditions[];
+}
+export interface SmartSnippetsDocumentGroupPreview {
+    /**
+     * The query that was used to fetch document information.
+     */
+    query: string;
+    /**
+     * Status indicating whether there are enough candidates for learning.
+     */
+    documentRequirementStatus: SmartSnippetsDocumentRequirementStatus;
+    /**
+     * The total number of documents in all sources.
+     */
+    numberOfDocuments: number;
+    /**
+     * The number of documents that match the conditions.
+     */
+    numberOfDocumentsMatchingConditions: number;
+    /**
+     * The number of documents that match the conditions and have a permanent id.
+     */
+    numberOfDocumentsWithPermanentId: number;
+    /**
+     * The number of documents that are candidates for learning.
+     */
+    numberOfValidDocuments: number;
+}
+export interface SmartSnippetsContentFieldsParams {
+    /**
+     * The type of documents to target.
+     */
+    documentType: string;
+    /**
+     * The sources to consider.
+     */
+    sources: string[];
+    /**
+     * An array of filtering conditions.
+     */
+    filterConditions: FilterConditions[];
+}
+export interface SmartSnippetsContentField {
+    /**
+     * The name of the field.
+     */
+    name: string;
+}
+export interface SmartSnippetsContentFields {
+    /**
+     * The query that was used to fetch document information.
+     */
+    query: string;
+    /**
+     * The list of fields that are non-empty for at least one document.
+     */
+    fields: SmartSnippetsContentField[];
+}
+export interface SmartSnippetsDocumentTypesParams {
+    /**
+     * The sources to consider.
+     */
+    sources: string[];
+    /**
+     * An array of filtering conditions.
+     */
+    filterConditions: FilterConditions[];
+}
+export interface SmartSnippetsDocumentType {
+    /**
+     * The document type.
+     */
+    documentType: string;
+}
+export interface SmartSnippetsDocumentTypes {
+    /**
+     * The query that was used to fetch document information.
+     */
+    query: string;
+    /**
+     * The document types in all sources.
+     */
+    documentTypes: SmartSnippetsDocumentType[];
+}

package/dist/types/resources/MachineLearning/SmartSnippetsConfiguration/index.d.ts

@@ -0,0 +1,2 @@
+export * from './SmartSnippetsConfiguration.js';
+export * from './SmartSnippetsConfigurationInterfaces.js';

package/dist/types/resources/MachineLearning/UserActionHistoryConfiguration/UserActionHistoryConfiguration.d.ts

@@ -0,0 +1,7 @@
+import Resource from '../../Resource.js';
+export default class UserActionHistoryConfiguration extends Resource {
+    static baseUrl: string;
+    create(): Promise<void>;
+    delete(): Promise<void>;
+    get(): Promise<boolean>;
+}

package/dist/types/resources/MachineLearning/UserActionHistoryConfiguration/index.d.ts

@@ -0,0 +1 @@
+export * from './UserActionHistoryConfiguration.js';

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

@@ -0,0 +1,11 @@
+export * from './MachineLearning.js';
+export * from './MachineLearningInterfaces.js';
+export * from './FilterConditions.js';
+export * from './Models/index.js';
+export * from './ModelInformation/index.js';
+export * from './ModelConfiguration/index.js';
+export * from './DNEConfiguration/index.js';
+export * from './CaseClassificationConfiguration/index.js';
+export * from './SmartSnippetsConfiguration/index.js';
+export * from './PQSConfiguration/index.js';
+export * from './UserActionHistoryConfiguration/index.js';

package/dist/types/resources/ModifierTemplates/ModifierTemplateInterfaces.d.ts

@@ -0,0 +1,71 @@
+export interface ModifierModel {
+    /**
+     * Unique identifier
+     */
+    id: string;
+    /**
+     * English human friendly name
+     */
+    displayName: string;
+    /**
+     * Category the modifier belongs to.
+     * LICENSE and SYSTEM are more for internal use and might need to be filtered out from display
+     */
+    modifierType: ModifierType;
+    /**
+     * List of statements contained in the modifier
+     */
+    statements: ModifierStatementModel[];
+}
+export interface ModifierStatementModel {
+    /**
+     * The statement key to apply the value to
+     */
+    key: string;
+    /**
+     * The value to set on the key, always a string so "0" or "true" are correct
+     */
+    value: string;
+    /**
+     * How the value will be applied if there are other statements on the same key
+     */
+    operation: StatementOperation;
+}
+export interface ModifierStatementDetailModel {
+    /**
+     * The statement key to apply the value to
+     */
+    statementKey: string;
+    /**
+     * The license property the statement affects
+     */
+    mapping: string;
+    /**
+     * The type of value that should be used in the license when recomputing the properties
+     */
+    valueType: StatementOperation;
+    /**
+     * The strategy that will be used to resolve conflicts for statements on the same key
+     */
+    mergeStrategy: MergeStrategy;
+}
+export declare enum ModifierType {
+    system = "SYSTEM",
+    license = "LICENSE",
+    integration = "INTEGRATION",
+    extension = "EXTENSION",
+    feature = "FEATURE"
+}
+export declare enum StatementOperation {
+    set = "SET",
+    append = "APPEND",
+    remove = "REMOVE"
+}
+export declare enum MergeStrategy {
+    integerBiggerWins = "INTEGER_BIGGER_WINS",
+    integerLowerWins = "INTEGER_LOWER_WINS",
+    booleanFalseWins = "BOOLEAN_FALSE_WINS",
+    booleanTrueWins = "BOOLEAN_TRUE_WINS",
+    specificEnumValueWins = "SPECIFIC_ENUM_VALUE_WINS",
+    noMerge = "NO_MERGE"
+}

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

@@ -0,0 +1,7 @@
+import Resource from '../Resource.js';
+import { ModifierModel, ModifierStatementDetailModel } from './ModifierTemplateInterfaces.js';
+export default class ModifierTemplates extends Resource {
+    static baseUrl: string;
+    list(): Promise<ModifierModel[]>;
+    listPossibleStatements(): Promise<ModifierStatementDetailModel[]>;
+}

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

@@ -0,0 +1,2 @@
+export * from './ModifierTemplates.js';
+export * from './ModifierTemplateInterfaces.js';

package/dist/types/resources/Notification/Subscription/Subscription.d.ts

@@ -0,0 +1,21 @@
+import Ressource from '../../Resource.js';
+import { EditSubscriptionModel, SubscriptionModel } from './SubscriptionInterfaces.js';
+export default class Subscription extends Ressource {
+    static getBaseUrl: (orgId: string) => string;
+    list(): Promise<SubscriptionModel[]>;
+    listCurrent(): Promise<SubscriptionModel[]>;
+    show(subscriptionId: string): Promise<SubscriptionModel>;
+    showCurrent(subscriptionId: string): Promise<SubscriptionModel>;
+    create(editSubscriptionModel: EditSubscriptionModel): Promise<SubscriptionModel>;
+    createCurrent(editSubscriptionModel: EditSubscriptionModel): Promise<SubscriptionModel>;
+    edit(subscriptionId: string, editSubscriptionModel: EditSubscriptionModel): Promise<SubscriptionModel>;
+    editCurrent(subscriptionId: string, editSubscriptionModel: EditSubscriptionModel): Promise<SubscriptionModel>;
+    delete(subscriptionId: string): Promise<Record<string, unknown>>;
+    deleteCurrent(subscriptionId: string): Promise<Record<string, unknown>>;
+    enable(subscriptionId: string): Promise<Record<string, unknown>>;
+    enableCurrent(subscriptionId: string): Promise<Record<string, unknown>>;
+    disable(subscriptionId: string): Promise<Record<string, unknown>>;
+    disableCurrent(subscriptionId: string): Promise<Record<string, unknown>>;
+    test(subscriptionId: string): Promise<Record<string, unknown>>;
+    testCurrent(subscriptionId: string): Promise<Record<string, unknown>>;
+}

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

@@ -0,0 +1,41 @@
+import { SubscriptionFrequencyEnum, SubscriptionStatusHealthIndicatorEnum, SubscriptionTypeEnum } from '../../Enums.js';
+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/types/resources/Notification/Subscription/index.d.ts

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,37 @@
+import { AuthProvider } from '../../Enums.js';
+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/types/resources/Organizations/Members/index.d.ts

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

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

@@ -0,0 +1,42 @@
+import API from '../../APICore.js';
+import { PageModel, PrivilegeModel } from '../BaseInterfaces.js';
+import Resource from '../Resource.js';
+import Members from './Members/Members.js';
+import { CreateOrganizationOptions, DefinitionModel, GetOrganizationOptions, ListOrganizationOptions, OrganizationModel, OrganizationsStatusModel } from './OrganizationInterfaces.js';
+import { AuthProvider } from '../Enums.js';
+export 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[]>;
+}