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

package/dist/definitions/resources/MachineLearning/Models/Models.d.ts

@@ -1,13 +0,0 @@
-import Resource from '../../Resource';
-import { RegistrationModel } from '../MachineLearningInterfaces';
-import { MLModel } from './ModelsInterfaces';
-import { MLModelTypeInfo } from '../ModelInformation';
-export default class Models extends Resource {
-    static baseUrl: string;
-    list(engines?: string[]): Promise<MLModel<never>[]>;
-    listDetails(): Promise<MLModel<MLModelTypeInfo>[]>;
-    getDetails<T extends MLModelTypeInfo>(modelId: string): Promise<MLModel<T>>;
-    get(modelId: string): Promise<MLModel<never>>;
-    delete(modelId: string): Promise<Record<string, unknown>>;
-    update(modelId: string, update: RegistrationModel): Promise<MLModel<never>>;
-}

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

@@ -1,49 +0,0 @@
-import { GranularResource } from '../../BaseInterfaces';
-import { IntervalUnit, ModelActivenessState, ModelStatus } from '../../Enums';
-import { AssociatedPipelineModel } from '../../Pipelines';
-import { MLModelInfo, MLModelTypeInfo } from '../ModelInformation';
-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/definitions/resources/MachineLearning/Models/index.d.ts

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

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

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

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

@@ -1,40 +0,0 @@
-import { IntervalUnit } from '../../Enums';
-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/definitions/resources/MachineLearning/PQSConfiguration/index.d.ts

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

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

@@ -1,17 +0,0 @@
-import { New } from '../../BaseInterfaces';
-import Resource from '../../Resource';
-import { SmartSnippetsConfigurationModel, SmartSnippetsContentFields, SmartSnippetsContentFieldsParams, SmartSnippetsDocumentGroupPreview, SmartSnippetsDocumentGroupPreviewParams, SmartSnippetsDocumentTypes, SmartSnippetsDocumentTypesParams } from './SmartSnippetsConfigurationInterfaces';
-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/definitions/resources/MachineLearning/SmartSnippetsConfiguration/SmartSnippetsConfigurationInterfaces.d.ts

@@ -1,131 +0,0 @@
-import { FilterConditions } from '../FilterConditions';
-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 declare 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/definitions/resources/MachineLearning/SmartSnippetsConfiguration/index.d.ts

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,21 +0,0 @@
-import Ressource from '../../Resource';
-import { EditSubscriptionModel, SubscriptionModel } from './SubscriptionInterfaces';
-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/definitions/resources/Notification/Subscription/SubscriptionInterfaces.d.ts

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,42 +0,0 @@
-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[]>;
-}