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

A collection of Headless Clients used in Liferay Portal

export type DocumentBulkSelection = {
    documentIds?: Array<string>;
    selectionScope?: SelectionScope;
    readonly 'x-class-name'?: string;
};
export type KeywordBulkSelection = {
    documentBulkSelection?: DocumentBulkSelection;
    keywordsToAdd?: Array<string>;
    keywordsToRemove?: Array<string>;
    readonly 'x-class-name'?: string;
};
export type SelectionScope = {
    folderId?: number;
    repositoryId?: number;
    selectAll?: boolean;
    readonly 'x-class-name'?: string;
};
export type Facet = {
    facetCriteria?: string;
    facetValues?: Array<FacetValue>;
};
export type FacetValue = {
    numberOfOccurrences?: number;
    term?: string;
};
export type Keyword = {
    name?: string;
    readonly 'x-class-name'?: string;
};
export type PageKeyword = {
    items?: Array<Keyword>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type Selection = {
    size?: number;
    readonly 'x-class-name'?: string;
};
export type Status = {
    actionInProgress?: boolean;
    readonly 'x-class-name'?: string;
};
export type TaxonomyCategoryBulkSelection = {
    documentBulkSelection?: DocumentBulkSelection;
    taxonomyCategoryIdsToAdd?: Array<number>;
    taxonomyCategoryIdsToRemove?: Array<number>;
    readonly 'x-class-name'?: string;
};
export type PageTaxonomyVocabulary = {
    items?: Array<TaxonomyVocabulary>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type TaxonomyCategory = {
    taxonomyCategoryId?: number;
    taxonomyCategoryName?: string;
    readonly 'x-class-name'?: string;
};
export type TaxonomyVocabulary = {
    multiValued?: boolean;
    name?: string;
    required?: boolean;
    taxonomyCategories?: Array<TaxonomyCategory>;
    taxonomyVocabularyId?: number;
    readonly 'x-class-name'?: string;
};
export type PatchKeywordBatchData = {
    body?: KeywordBulkSelection;
    path?: never;
    query?: never;
    url: '/o/bulk/v1.0/keywords/batch';
};
export type PatchKeywordBatchResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type PutKeywordBatchData = {
    body?: KeywordBulkSelection;
    path?: never;
    query?: never;
    url: '/o/bulk/v1.0/keywords/batch';
};
export type PutKeywordBatchResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type PostKeywordsCommonPageData = {
    body?: DocumentBulkSelection;
    path?: never;
    query?: never;
    url: '/o/bulk/v1.0/keywords/common';
};
export type PostKeywordsCommonPageResponses = {
    /**
     * default response
     */
    default: PageKeyword;
};
export type PostKeywordsCommonPageResponse = PostKeywordsCommonPageResponses[keyof PostKeywordsCommonPageResponses];
export type PostBulkSelectionData = {
    body?: DocumentBulkSelection;
    path?: never;
    query?: never;
    url: '/o/bulk/v1.0/bulk-selection';
};
export type PostBulkSelectionResponses = {
    /**
     * default response
     */
    default: Selection;
};
export type PostBulkSelectionResponse = PostBulkSelectionResponses[keyof PostBulkSelectionResponses];
export type GetStatusData = {
    body?: never;
    path?: never;
    query?: never;
    url: '/o/bulk/v1.0/status';
};
export type GetStatusResponses = {
    /**
     * default response
     */
    default: Status;
};
export type GetStatusResponse = GetStatusResponses[keyof GetStatusResponses];
export type PatchTaxonomyCategoryBatchData = {
    body?: TaxonomyCategoryBulkSelection;
    path?: never;
    query?: never;
    url: '/o/bulk/v1.0/taxonomy-categories/batch';
};
export type PatchTaxonomyCategoryBatchResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type PutTaxonomyCategoryBatchData = {
    body?: TaxonomyCategoryBulkSelection;
    path?: never;
    query?: never;
    url: '/o/bulk/v1.0/taxonomy-categories/batch';
};
export type PutTaxonomyCategoryBatchResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type PostSiteTaxonomyVocabulariesCommonPageData = {
    body?: DocumentBulkSelection;
    path: {
        siteId: string;
    };
    query?: never;
    url: '/o/bulk/v1.0/sites/{siteId}/taxonomy-vocabularies/common';
};
export type PostSiteTaxonomyVocabulariesCommonPageResponses = {
    /**
     * default response
     */
    default: PageTaxonomyVocabulary;
};
export type PostSiteTaxonomyVocabulariesCommonPageResponse = PostSiteTaxonomyVocabulariesCommonPageResponses[keyof PostSiteTaxonomyVocabulariesCommonPageResponses];
export type ClientOptions = {
    baseUrl: 'http://localhost:8080' | (string & {});
};