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

package/dist/definitions/resources/InProductExperiences/InProductExperiencesInterfaces.d.ts

@@ -1,327 +0,0 @@
-import { RestTokenParams } from '../Search';
-import { CSSResourceModel, JavaScriptResourceModel } from '../SearchPages';
-export interface SharedInProductExperienceModel {
-    /**
-     * The unique name of the search page.
-     *
-     * string
-     * example: My_Page
-     */
-    name: string;
-    /**
-     * The search page HTML title tag value.
-     *
-     * string
-     * example: My page
-     */
-    title: string;
-}
-export interface InProductExperienceModel extends SharedInProductExperienceModel {
-    /**
-     * The button.
-     */
-    button: IPXButtonModel;
-    /**
-     * The HTML body content of the widget's page.
-     *
-     * string
-     * example: <main><h1>My page</h1></main>
-     */
-    content: string;
-    /**
-     * Whether or not this InAppWidget has a search token.
-     *
-     * boolean
-     * default: true
-     * example: true
-     */
-    hasToken: boolean;
-    /**
-     * The HTML head content of the widget's page.
-     */
-    header: {
-        /**
-         * The CSS resources of the widget.
-         */
-        css: CSSResourceModel[];
-        /**
-         * The JavaScript resources of the widget.
-         */
-        javascript: JavaScriptResourceModel[];
-    };
-    /**
-     * The unique identifier of the search page.
-     *
-     * string
-     * example: 12b627f9-e3aa-49db-a0f5-5c0c1392e59e
-     */
-    id: string;
-    /**
-     * The time at which the search page was last modified.
-     *
-     * string
-     * example: 2019-10-31T20:17:35-04:00
-     */
-    lastModified: string;
-    /**
-     * The unique identifier of the parent Coveo Cloud organization.
-     *
-     * string
-     * example: mycoveocloudv2organizationg8tp8wu3
-     */
-    orgId: string;
-    token: RestTokenParams;
-}
-export interface CreateUpdateInProductExperienceModel extends SharedInProductExperienceModel {
-    /**
-     * The CSS classes of the button.
-     *
-     * default: btn mod-primary
-     * example: myframework-button myframework-button-blue
-     */
-    buttonCSSClasses?: string;
-    /**
-     * The value of the button CSS background-color property.
-     *
-     * string
-     * example: #2a2aa2
-     */
-    buttonColor?: string;
-    /**
-     * The value of the button CSS font-family property.
-     *
-     * string
-     * example: 'Courier New', Courier, monospace
-     */
-    buttonFont?: string;
-    /**
-     * The value of the button CSS font-size property.
-     *
-     * string
-     * example: 24px
-     */
-    buttonFontSize?: string;
-    /**
-     * The stringified HTML icon of the button.
-     *
-     * string
-     * example: '<svg><circle/></svg>'
-     */
-    buttonIcon?: string;
-    /**
-     * The horizontal alignment of the button.
-     *
-     * string
-     * default: right
-     * example: center
-     */
-    buttonPositionHorizontal?: ButtonPositionHorizontalRequestModel;
-    /**
-     * The vertical alignment of the button.
-     *
-     * string
-     * default: bottom
-     * example: middle
-     */
-    buttonPositionVertical?: ButtonPositionVerticalRequestModel;
-    /**
-     * The selector corresponding to a DOM element that should open the in-app search page when clicked.
-     *
-     * string
-     * example: .in-app-portal-target
-     */
-    buttonTargetSelector?: string;
-    /**
-     * The value of the button CSS color property.
-     *
-     * string
-     * example: #e0e0e0
-     */
-    buttonTextColor?: string;
-    /**
-     * The constant query expression ('cq') to apply when executing search requests with the token.
-     * See: https://docs.coveo.com/en/179/
-     *
-     * string
-     * example: @source==KnowledgeBase
-     */
-    filter?: string;
-    /**
-     * The name of the query pipeline to enforce when executing search requests with the token.
-     *
-     * string
-     * example: InternalSearch
-     */
-    queryPipeline?: string;
-    /**
-     * The name of the search hub / origin level 1 to pass when executing search requests and logging usage analytics events with the token.
-     *
-     * string
-     * example: SupportHub
-     */
-    searchHub: string;
-    /**
-     * The userDisplayName to pass when logging usage analytics search events.
-     *
-     * string
-     * default: Anonymous
-     * example: Alice Smith
-     */
-    userDisplayName?: string;
-    /**
-     * The userGroups to pass when logging usage analytics search events. Must be a stringified array in JSON.
-     *
-     * string
-     * default: []
-     * example: ["Tech support agents", "Employees"]
-     */
-    userGroups?: string;
-    /**
-     * The security identities to impersonate when authenticating a query with this search token. Must be a stringified array in JSON.
-     * By default, the service uses a single security identity representing an anonymous user.
-     *
-     * string
-     * default: [{"name":"anonymous@coveo.com","provider":"Email Security Provider"}]
-     * example: [{"name":"johndoe@coveo.com","provider":"Email Security Provider"}]
-     */
-    userIds?: string;
-    /**
-     * The number of milliseconds the search token will remain valid for once it has been created.
-     *
-     * integer
-     * default: 86400000
-     * maximum: 86400000
-     * minimum: 900000
-     * example: 3600000
-     */
-    validFor?: number;
-}
-export declare enum ButtonPositionHorizontalRequestModel {
-    Left = "left",
-    Center = "center",
-    Right = "right"
-}
-export declare enum ButtonPositionVerticalRequestModel {
-    Top = "top",
-    Middle = "middle",
-    Bottom = "bottom"
-}
-export declare enum ButtonPositionHorizontalResponseModel {
-    Undefined = "Undefined",
-    Left = "Left",
-    Center = "Center",
-    Right = "Right"
-}
-export declare enum ButtonPositionVerticalResponseModel {
-    Undefined = "Undefined",
-    Top = "Top",
-    Middle = "Middle",
-    Bottom = "Bottom"
-}
-/**
- * The configuration to use for the new InAppWidget.
- */
-export declare type CreateInProductExperienceModel = CreateUpdateInProductExperienceModel;
-export declare type CreateInProductExperienceResponse = Pick<InProductExperienceModel, 'id' | 'name' | 'lastModified' | 'title' | 'button' | 'token'> & {
-    /**
-     * The <script> HTML tag to include in the head content.
-     *
-     * string
-     * default: <script async src='https://platformdev.cloud.coveo.com/rest/organizations/{organizationID}/pages/{pageID}/inappwidget/loader'></script>
-     */
-    scriptToInclude: string;
-};
-/**
- * The new configuration to use for the updated InAppWidget.
- */
-export declare type UpdateInProductExperienceModel = CreateUpdateInProductExperienceModel;
-export declare type InProductExperienceLoader = string;
-export interface IPXButtonModel {
-    /**
-     * The button's CSS.
-     */
-    buttonCSS: CSSResourceModel[];
-    /**
-     * The CSS classes of the button.
-     *
-     * string[]
-     * example: List [ "btn", "mod-primary" ]
-     */
-    buttonCSSClasses: string[];
-    /**
-     * The button's colors.
-     */
-    buttonColor: {
-        /**
-         * The value of the button CSS background-color property.
-         *
-         * string
-         * example: #2a2aa2
-         */
-        color: string;
-        /**
-         * The value of the CSS color property.
-         *
-         * string
-         * example: #e0e0e0
-         */
-        textColor: string;
-    };
-    /**
-     * The button's font.
-     */
-    buttonFont: {
-        /**
-         * The value of the CSS font-family property.
-         *
-         * string
-         * example: 'Courier New', Courier, monospace
-         */
-        family: string;
-        /**
-         * The value of the CSS font-size property.
-         *
-         * string
-         * example: 24px
-         */
-        size: string;
-    };
-    /**
-     * The button's icon.
-     */
-    buttonIcon: {
-        /**
-         * The icon's stringified HTML.
-         *
-         * string
-         * default: <svg width="22" height="22" viewBox="0 0 22 22"> <g fill="currentColor"> <path d="m1,11c0,5.52 4.48,10 10,10s10,-4.48 10,-10s-4.48,-10 -10,-10s-10,4.48 -10,10z" fill="transparent"></path> <path d="m11,22c-6.07,0 -11,-4.935 -11,-11s4.935,-11 11,-11s11,4.935 11,11s-4.935,11 -11,11m0,-20c-4.962,0 -9,4.04 -9,9s4.04,9 9,9s9,-4.04 9,-9s-4.04,-9 -9,-9"></path> <path d="m10,17l2,0l0,-2l-2,0l0,2m1,-12.344c-2.21,0 -4,1.79 -4,4l2,0c0,-1.1 0.9,-2 2,-2s2,0.9 2,2c0,2 -3,1.75 -3,5l2,0c0,-2.25 3,-2.5 3,-5c0,-2.21 -1.79,-4 -4,-4"></path> </g> </svg>
-         * example: <svg><circle/></svg>
-         */
-        value: string;
-    };
-    /**
-     * The button's JavaScript.
-     */
-    buttonJS: JavaScriptResourceModel[];
-    /**
-     * The button's text alignment.
-     */
-    buttonPosition: {
-        /**
-         * The horizontal alignment of the button.
-         *
-         * string
-         * default: Right
-         * example: Center
-         */
-        horizontalPosition: ButtonPositionHorizontalResponseModel;
-        /**
-         * The vertical alignment of the button.
-         *
-         * string
-         * default: Bottom
-         * example: Middle
-         */
-        verticalPosition: ButtonPositionVerticalResponseModel;
-    };
-}

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

@@ -1,2 +0,0 @@
-export * from './InProductExperiences';
-export * from './InProductExperiencesInterfaces';

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

@@ -1,26 +0,0 @@
-import { PageModel } from '../BaseInterfaces';
-import Resource from '../Resource';
-import { CreateCoveoIndexModel, IndexAttributes, IndexBackupsItems, IndexBackupsOptions, IndexStatisticsModel, RawIndexConfig } from './IndexesInterface';
-export default class Indexes extends Resource {
-    static baseUrl: string;
-    static indexBackupUrl: string;
-    list(): Promise<IndexAttributes[]>;
-    create(indexModal?: CreateCoveoIndexModel): Promise<{
-        id: string;
-    }>;
-    delete(indexId: string): Promise<Record<string, unknown>>;
-    get(indexId: string): Promise<IndexAttributes>;
-    backup(indexId: string): Promise<{
-        id: string;
-    }>;
-    getBackups(options?: IndexBackupsOptions): Promise<PageModel<IndexBackupsItems, "items">>;
-    forceCommit(indexId: string): Promise<Record<string, unknown>>;
-    readOnly(indexId: string, isReadOnly: boolean): Promise<Record<string, unknown>>;
-    resize(indexId: string, sizeInGibibytes: number): Promise<Record<string, unknown>>;
-    stats(indexId: string): Promise<IndexStatisticsModel>;
-    isOnline(indexId: string, isOnline: boolean): Promise<Record<string, unknown>>;
-    restore(indexId: string, backupId: string): Promise<Record<string, unknown>>;
-    getJson(indexId: string): Promise<RawIndexConfig>;
-    editJson(indexId: string, indexConfig: RawIndexConfig): Promise<Record<string, unknown>>;
-    editJsonAll(indexConfig: RawIndexConfig): Promise<Record<string, unknown>>;
-}

package/dist/definitions/resources/Indexes/IndexesInterface.d.ts

@@ -1,198 +0,0 @@
-import { Paginated } from '../BaseInterfaces';
-export interface IndexStorageSpec {
-    numberOfIops: number;
-    sizeInGibibytes: number;
-    sizeInGigabytes: number;
-    storageType: string;
-    throughputInMebibytes: number;
-}
-export interface IndexMachineSpec {
-    architecture: string;
-    storageSpec: IndexStorageSpec;
-}
-export interface IndexSourceStatistics {
-    collectionId: number;
-    documentCount: number;
-    documentTotalSize: number;
-    sourceId: number;
-}
-export interface IndexStatisticsModel {
-    diskSpaceUsed: number;
-    documentCount: number;
-    documentsTotalSize: number;
-    lastAppliedTransactionTimestamp: number;
-    lastCommitTimestamp: number;
-    numberOfQueries: number;
-    numberOfSlices: number;
-    pendingTransactions: number;
-    realtimeDiskSpaceUsed: number;
-    realtimeDocumentCount: number;
-    realtimeDocumentsTotalSize: number;
-    realtimePendingTransactions: number;
-    remainingDiskSpace: number;
-    sourceStatistics: IndexSourceStatistics[];
-    totalMemoryUsed: number;
-    totalPhysicalMemory: number;
-}
-export interface IndexStatus {
-    internalStatus: string;
-    online: boolean;
-    readOnlyStatus: string;
-    stats: IndexStatisticsModel;
-    syncStatus?: IndexSyncStatusAttributes;
-    backupStatus?: IndexSyncStatusAttributes;
-}
-export interface IndexAttributes {
-    adminUri: string;
-    agentId: string;
-    id: string;
-    logicalIndex: string;
-    machineSpec: IndexMachineSpec;
-    name: string;
-    organizationId: string;
-    region: string;
-    searchUri: string;
-    status: IndexStatus;
-    storages: IndexStorageSpec[];
-    type: string;
-}
-export interface CreateCoveoIndexModel {
-    copyFromId?: string;
-    logicalIndexId?: string;
-    machineSpec?: MachineSpecModel;
-    online?: boolean;
-    region?: string;
-    versions?: IndexVersionsModel;
-}
-export interface MachineSpecModel {
-    architecture: string;
-    storageSpec: IndexStorageSpecModel;
-}
-export interface IndexStorageSpecModel {
-    numberOfIops: number;
-    sizeInGibibytes: number;
-    storageType: string;
-    throughputInMebibytes: number;
-}
-export interface IndexVersionsModel {
-    indexerVersion: string;
-    securityCacheVersion: string;
-}
-export interface IndexBackupsItems {
-    backupId: string;
-    creationDate: number;
-    indexId: string;
-    logicalIndex: string;
-    organizationId: string;
-}
-export interface IndexBackupsOptions extends Paginated {
-    backupId?: string;
-    from?: number;
-    indexId?: string;
-    order?: string;
-    sortBy?: string;
-    to?: number;
-}
-export interface IndexSyncStatusAttributes {
-    currentFileName: string;
-    currentFileNumber: number;
-    totalNumberOfFiles: number;
-    transferredSize: number;
-    totalSize: number;
-}
-export interface IndexPhysicalIndexModel {
-    applyStemmingOnExactPhraseTerms: boolean;
-    description: string;
-    enableRealtimeIndexing: boolean;
-    groupByMaxToCache: number;
-    languagesSettings: string;
-    name: string;
-    normalizerUnicodeSetExclusion: string;
-    performanceCacheMemory: number;
-    realtimeIndexingDocumentsThreshold: number;
-    realtimeIndexingStartThreshold: number;
-    uniqueTermsPerDocument: number;
-    wildcardsNumberOfLeadingChars: number;
-    wildcardsNumberOfTerms: number;
-}
-export interface IndexHighlightTagModel {
-    end: string;
-    id: number;
-    start: string;
-}
-export interface IndexQueryHighlighterModel {
-    highlightTags: IndexHighlightTagModel[];
-    ignoreAccents: boolean;
-    ignoredFields: string;
-    useStemming: boolean;
-}
-export interface IndexRankingModel {
-    adjacencyMult: number;
-    conceptMult: number;
-    customDocumentWeightMult: number;
-    docDateMult: number;
-    formattedMult: number;
-    languageMult: number;
-    linkRankMult: number;
-    numberOfResultsToRefine: number;
-    qualityMult: number;
-    rankingHeuristic: string;
-    rankingHeuristicUseIndexSize: boolean;
-    sourceReputationMult: number;
-    summaryMult: number;
-    tFIDFMult: number;
-    termCasingMult: number;
-    termCorrelationMult: number;
-    titleMult: number;
-    uRIMult: number;
-}
-export interface IndexSystemModel {
-    documentDuplicateFactor: number;
-    documentLimitWarning: number;
-    documentsChunkToDefragment: number;
-    documentsFragmentationTarget: number;
-    enableInternalLiveTagging: boolean;
-    enableLiveTagging: boolean;
-    enableQueryMetrics: boolean;
-    enableSearchDebugArgument: boolean;
-    enableServiceIndexMetrics: boolean;
-    enableTransactionsIndexMetrics: boolean;
-    enableWordCorrectorLexicon: boolean;
-    freeSpaceBeforeRebalancingBTree: number;
-    freeSpaceBeforeRebalancingBTreeDuringCleanup: number;
-    indexingBlockerMode: string;
-    limitSystemFileCacheSize: boolean;
-    maxBTreeFlushPendingMemoryMB: number;
-    maxChunksCleanupPerTransactionPeakPeriod: number;
-    maxChunksCleanupTimePerTransactionPeakPeriod: number;
-    maxDocIDRecyclingTimePerTransactionPeakPeriod: number;
-    maxMMFFlushPendingMemoryMB: number;
-    maxRecycledTermIDCleanupTimePeakPeriod: number;
-    maxRecycledTermIDCleanupTimePercentPeakPeriod: number;
-    maxSystemFileCacheSize: number;
-    maxTermDefragmentationTimePeakPeriod: number;
-    maxTermDefragmentationTimePercentPeakPeriod: number;
-    maxWriterBTreeShrinkTimePeakPeriod: number;
-    maximumResults: number;
-    maximumTermsPerQuery: number;
-    minDocIDCountForRecycling: number;
-    minTermIDCountForRecycling: number;
-    minimumDiskSpace: number;
-    numberOfBatchQueryThreads: number;
-    numberOfQueryThreads: number;
-    performanceCacheMemory: number;
-    performanceMinimumCacheMemory: number;
-    recyclingThresholdMultiplierInIndexingMode: number;
-    securityEntityResolverRefreshDelayInSeconds: number;
-    streamCompressionMethod: string;
-    systemFileCacheTrimInterval: number;
-    termsChunksToDefragmentPerTransactionPeakPeriod: number;
-    transactionMaxDocumentsSize: number;
-    transactionUpdateFrequency: number;
-}
-export interface RawIndexConfig {
-    physicalIndex: IndexPhysicalIndexModel;
-    queryHighlighter: IndexQueryHighlighterModel;
-    ranking: IndexRankingModel;
-    system: IndexSystemModel;
-}

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

@@ -1,2 +0,0 @@
-export * from './Indexes';
-export * from './IndexesInterface';

package/dist/definitions/resources/InsightPanelConfigs/InsightPanelConfig.d.ts

@@ -1,11 +0,0 @@
-import { New, PageModel } from '../BaseInterfaces';
-import Resource from '../Resource';
-import { InsightPanelConfigCreationParams, InsightPanelConfigListOptions, InsightPanelConfigModel, InsightPanelConfigUpdateParams } from './InsightPanelConfigInterfaces';
-export default class InsightPanelConfig extends Resource {
-    static baseUrl: string;
-    list(options?: InsightPanelConfigListOptions): Promise<PageModel<InsightPanelConfigModel, "items">>;
-    create(insightPanelConfig: New<InsightPanelConfigCreationParams>): Promise<InsightPanelConfigModel>;
-    delete(insightPanelConfigId: string): Promise<Record<string, unknown>>;
-    get(insightPanelConfigId: string): Promise<InsightPanelConfigModel>;
-    update(insightPanelConfig: InsightPanelConfigUpdateParams): Promise<InsightPanelConfigModel>;
-}