liferay-headless-rest-client/dist/clients/analytics-cms-rest-v1.0/types.gen.d.ts

A collection of Headless Clients used in Liferay Portal

export type InventoryAnalysis = {
    inventoryAnalysisItems?: Array<InventoryAnalysisItem>;
    totalCount?: number;
    readonly 'x-class-name'?: string;
};
export type InventoryAnalysisItem = {
    count?: number;
    key?: string;
    title?: string;
    readonly 'x-class-name'?: string;
};
export type Metric = {
    metricType?: string;
    previousValue?: number;
    previousValueKey?: string;
    trend?: Trend;
    value?: number;
    valueKey?: string;
    readonly 'x-class-name'?: string;
};
export type ObjectEntryMetric = {
    dataSourceId?: string;
    defaultMetric?: Metric;
    externalReferenceCode?: string;
    selectedMetrics?: Array<Metric>;
    readonly 'x-class-name'?: string;
};
export type Trend = {
    percentage?: number;
    readonly 'x-class-name'?: string;
    classification?: 'NEGATIVE' | 'NEUTRAL' | 'POSITIVE';
};
export type Overview = {
    categoriesCount?: number;
    tagsCount?: number;
    totalCount?: number;
    trend?: Trend;
    vocabulariesCount?: number;
    readonly 'x-class-name'?: string;
};
export type GetInventoryAnalysisData = {
    body?: never;
    path?: never;
    query?: {
        categoryId?: string;
        groupBy?: string;
        languageId?: string;
        page?: string;
        pageSize?: string;
        rangeEnd?: string;
        rangeKey?: string;
        rangeStart?: string;
        spaceId?: string;
        structureId?: string;
        tagId?: string;
        vocabularyId?: string;
    };
    url: '/o/analytics-cms-rest/v1.0/inventory-analysis';
};
export type GetInventoryAnalysisResponses = {
    /**
     * default response
     */
    default: InventoryAnalysis;
};
export type GetInventoryAnalysisResponse = GetInventoryAnalysisResponses[keyof GetInventoryAnalysisResponses];
export type GetObjectEntryMetricData = {
    body?: never;
    path?: never;
    query?: {
        externalReferenceCode?: string;
        groupId?: string;
        rangeKey?: string;
        selectedMetrics?: string;
    };
    url: '/o/analytics-cms-rest/v1.0/object-entry-metric';
};
export type GetObjectEntryMetricResponses = {
    /**
     * default response
     */
    default: ObjectEntryMetric;
};
export type GetObjectEntryMetricResponse = GetObjectEntryMetricResponses[keyof GetObjectEntryMetricResponses];
export type GetContentOverviewData = {
    body?: never;
    path?: never;
    query?: {
        languageId?: string;
        rangeEnd?: string;
        rangeKey?: string;
        rangeStart?: string;
        spaceId?: string;
    };
    url: '/o/analytics-cms-rest/v1.0/content-overview';
};
export type GetContentOverviewResponses = {
    /**
     * default response
     */
    default: Overview;
};
export type GetContentOverviewResponse = GetContentOverviewResponses[keyof GetContentOverviewResponses];
export type GetFileOverviewData = {
    body?: never;
    path?: never;
    query?: {
        languageId?: string;
        rangeEnd?: string;
        rangeKey?: string;
        rangeStart?: string;
        spaceId?: string;
    };
    url: '/o/analytics-cms-rest/v1.0/file-overview';
};
export type GetFileOverviewResponses = {
    /**
     * default response
     */
    default: Overview;
};
export type GetFileOverviewResponse = GetFileOverviewResponses[keyof GetFileOverviewResponses];
export type ClientOptions = {
    baseUrl: 'http://localhost:8080' | (string & {});
};