liferay-headless-rest-client/dist/clients/headless-admin-list-type-v1.0/types.gen.d.ts

A collection of Headless Clients used in Liferay Portal

export type ListTypeDefinition = {
    readonly actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    readonly dateCreated?: string;
    readonly dateModified?: string;
    defaultLanguageId?: string;
    externalReferenceCode?: string;
    readonly id?: number;
    listTypeEntries?: Array<ListTypeEntry>;
    name?: string;
    name_i18n?: {
        [key: string]: string;
    };
    system?: boolean;
    readonly 'x-class-name'?: string;
};
export type ListTypeEntry = {
    readonly actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    readonly dateCreated?: string;
    readonly dateModified?: string;
    externalReferenceCode?: string;
    readonly id?: number;
    key?: string;
    name?: string;
    name_i18n?: {
        [key: string]: string;
    };
    system?: boolean;
    type?: string;
    readonly 'x-class-name'?: string;
};
export type Facet = {
    facetCriteria?: string;
    facetValues?: Array<FacetValue>;
};
export type FacetValue = {
    numberOfOccurrences?: number;
    term?: string;
};
export type PageListTypeDefinition = {
    items?: Array<ListTypeDefinition>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type PageListTypeEntry = {
    items?: Array<ListTypeEntry>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type DeleteListTypeDefinitionData = {
    body?: never;
    path: {
        listTypeDefinitionId: string;
    };
    query?: never;
    url: '/o/headless-admin-list-type/v1.0/list-type-definitions/{listTypeDefinitionId}';
};
export type DeleteListTypeDefinitionResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type GetListTypeDefinitionData = {
    body?: never;
    path: {
        listTypeDefinitionId: string;
    };
    query?: never;
    url: '/o/headless-admin-list-type/v1.0/list-type-definitions/{listTypeDefinitionId}';
};
export type GetListTypeDefinitionResponses = {
    /**
     * default response
     */
    default: ListTypeDefinition;
};
export type GetListTypeDefinitionResponse = GetListTypeDefinitionResponses[keyof GetListTypeDefinitionResponses];
export type PatchListTypeDefinitionData = {
    body?: ListTypeDefinition;
    path: {
        listTypeDefinitionId: string;
    };
    query?: never;
    url: '/o/headless-admin-list-type/v1.0/list-type-definitions/{listTypeDefinitionId}';
};
export type PatchListTypeDefinitionResponses = {
    /**
     * default response
     */
    default: ListTypeDefinition;
};
export type PatchListTypeDefinitionResponse = PatchListTypeDefinitionResponses[keyof PatchListTypeDefinitionResponses];
export type PutListTypeDefinitionData = {
    body?: ListTypeDefinition;
    path: {
        listTypeDefinitionId: string;
    };
    query?: never;
    url: '/o/headless-admin-list-type/v1.0/list-type-definitions/{listTypeDefinitionId}';
};
export type PutListTypeDefinitionResponses = {
    /**
     * default response
     */
    default: ListTypeDefinition;
};
export type PutListTypeDefinitionResponse = PutListTypeDefinitionResponses[keyof PutListTypeDefinitionResponses];
export type DeleteListTypeDefinitionBatchData = {
    body?: {
        [key: string]: unknown;
    };
    path?: never;
    query?: {
        callbackURL?: string;
    };
    url: '/o/headless-admin-list-type/v1.0/list-type-definitions/batch';
};
export type DeleteListTypeDefinitionBatchResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type PostListTypeDefinitionBatchData = {
    body?: {
        [key: string]: unknown;
    };
    path?: never;
    query?: {
        callbackURL?: string;
    };
    url: '/o/headless-admin-list-type/v1.0/list-type-definitions/batch';
};
export type PostListTypeDefinitionBatchResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type PutListTypeDefinitionBatchData = {
    body?: {
        [key: string]: unknown;
    };
    path?: never;
    query?: {
        callbackURL?: string;
    };
    url: '/o/headless-admin-list-type/v1.0/list-type-definitions/batch';
};
export type PutListTypeDefinitionBatchResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type GetListTypeDefinitionByExternalReferenceCodeData = {
    body?: never;
    path: {
        externalReferenceCode: string;
    };
    query?: never;
    url: '/o/headless-admin-list-type/v1.0/list-type-definitions/by-external-reference-code/{externalReferenceCode}';
};
export type GetListTypeDefinitionByExternalReferenceCodeResponses = {
    /**
     * default response
     */
    default: ListTypeDefinition;
};
export type GetListTypeDefinitionByExternalReferenceCodeResponse = GetListTypeDefinitionByExternalReferenceCodeResponses[keyof GetListTypeDefinitionByExternalReferenceCodeResponses];
export type PutListTypeDefinitionByExternalReferenceCodeData = {
    body?: ListTypeDefinition;
    path: {
        externalReferenceCode: string;
    };
    query?: never;
    url: '/o/headless-admin-list-type/v1.0/list-type-definitions/by-external-reference-code/{externalReferenceCode}';
};
export type PutListTypeDefinitionByExternalReferenceCodeResponses = {
    /**
     * default response
     */
    default: ListTypeDefinition;
};
export type PutListTypeDefinitionByExternalReferenceCodeResponse = PutListTypeDefinitionByExternalReferenceCodeResponses[keyof PutListTypeDefinitionByExternalReferenceCodeResponses];
export type GetListTypeDefinitionsPageData = {
    body?: never;
    path?: never;
    query?: {
        aggregationTerms?: string;
        filter?: string;
        page?: string;
        pageSize?: string;
        search?: string;
        sort?: string;
        nestedFields?: string;
    };
    url: '/o/headless-admin-list-type/v1.0/list-type-definitions';
};
export type GetListTypeDefinitionsPageResponses = {
    /**
     * default response
     */
    default: PageListTypeDefinition;
};
export type GetListTypeDefinitionsPageResponse = GetListTypeDefinitionsPageResponses[keyof GetListTypeDefinitionsPageResponses];
export type PostListTypeDefinitionData = {
    body?: ListTypeDefinition;
    path?: never;
    query?: never;
    url: '/o/headless-admin-list-type/v1.0/list-type-definitions';
};
export type PostListTypeDefinitionResponses = {
    /**
     * default response
     */
    default: ListTypeDefinition;
};
export type PostListTypeDefinitionResponse = PostListTypeDefinitionResponses[keyof PostListTypeDefinitionResponses];
export type PostListTypeDefinitionsPageExportBatchData = {
    body?: never;
    path?: never;
    query?: {
        filter?: string;
        search?: string;
        sort?: string;
        callbackURL?: string;
        contentType?: string;
        fieldNames?: string;
    };
    url: '/o/headless-admin-list-type/v1.0/list-type-definitions/export-batch';
};
export type PostListTypeDefinitionsPageExportBatchResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type DeleteListTypeEntryData = {
    body?: never;
    path: {
        listTypeEntryId: string;
    };
    query?: never;
    url: '/o/headless-admin-list-type/v1.0/list-type-entries/{listTypeEntryId}';
};
export type DeleteListTypeEntryResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type GetListTypeEntryData = {
    body?: never;
    path: {
        listTypeEntryId: string;
    };
    query?: never;
    url: '/o/headless-admin-list-type/v1.0/list-type-entries/{listTypeEntryId}';
};
export type GetListTypeEntryResponses = {
    /**
     * default response
     */
    default: ListTypeEntry;
};
export type GetListTypeEntryResponse = GetListTypeEntryResponses[keyof GetListTypeEntryResponses];
export type PutListTypeEntryData = {
    body?: ListTypeEntry;
    path: {
        listTypeEntryId: string;
    };
    query?: never;
    url: '/o/headless-admin-list-type/v1.0/list-type-entries/{listTypeEntryId}';
};
export type PutListTypeEntryResponses = {
    /**
     * default response
     */
    default: ListTypeEntry;
};
export type PutListTypeEntryResponse = PutListTypeEntryResponses[keyof PutListTypeEntryResponses];
export type DeleteListTypeEntryBatchData = {
    body?: {
        [key: string]: unknown;
    };
    path?: never;
    query?: {
        callbackURL?: string;
    };
    url: '/o/headless-admin-list-type/v1.0/list-type-entries/batch';
};
export type DeleteListTypeEntryBatchResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type PutListTypeEntryBatchData = {
    body?: {
        [key: string]: unknown;
    };
    path?: never;
    query?: {
        callbackURL?: string;
    };
    url: '/o/headless-admin-list-type/v1.0/list-type-entries/batch';
};
export type PutListTypeEntryBatchResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type GetListTypeDefinitionByExternalReferenceCodeListTypeEntriesPageData = {
    body?: never;
    path: {
        externalReferenceCode: string;
    };
    query?: {
        aggregationTerms?: string;
        filter?: string;
        page?: string;
        pageSize?: string;
        search?: string;
        sort?: string;
        nestedFields?: string;
    };
    url: '/o/headless-admin-list-type/v1.0/list-type-definitions/by-external-reference-code/{externalReferenceCode}/list-type-entries';
};
export type GetListTypeDefinitionByExternalReferenceCodeListTypeEntriesPageResponses = {
    /**
     * default response
     */
    default: PageListTypeEntry;
};
export type GetListTypeDefinitionByExternalReferenceCodeListTypeEntriesPageResponse = GetListTypeDefinitionByExternalReferenceCodeListTypeEntriesPageResponses[keyof GetListTypeDefinitionByExternalReferenceCodeListTypeEntriesPageResponses];
export type PostListTypeDefinitionByExternalReferenceCodeListTypeEntryData = {
    body?: ListTypeEntry;
    path: {
        externalReferenceCode: string;
    };
    query?: never;
    url: '/o/headless-admin-list-type/v1.0/list-type-definitions/by-external-reference-code/{externalReferenceCode}/list-type-entries';
};
export type PostListTypeDefinitionByExternalReferenceCodeListTypeEntryResponses = {
    /**
     * default response
     */
    default: ListTypeEntry;
};
export type PostListTypeDefinitionByExternalReferenceCodeListTypeEntryResponse = PostListTypeDefinitionByExternalReferenceCodeListTypeEntryResponses[keyof PostListTypeDefinitionByExternalReferenceCodeListTypeEntryResponses];
export type GetListTypeDefinitionListTypeEntriesPageData = {
    body?: never;
    path: {
        listTypeDefinitionId: string;
    };
    query?: {
        aggregationTerms?: string;
        filter?: string;
        page?: string;
        pageSize?: string;
        search?: string;
        sort?: string;
        nestedFields?: string;
    };
    url: '/o/headless-admin-list-type/v1.0/list-type-definitions/{listTypeDefinitionId}/list-type-entries';
};
export type GetListTypeDefinitionListTypeEntriesPageResponses = {
    /**
     * default response
     */
    default: PageListTypeEntry;
};
export type GetListTypeDefinitionListTypeEntriesPageResponse = GetListTypeDefinitionListTypeEntriesPageResponses[keyof GetListTypeDefinitionListTypeEntriesPageResponses];
export type PostListTypeDefinitionListTypeEntryData = {
    body?: ListTypeEntry;
    path: {
        listTypeDefinitionId: string;
    };
    query?: never;
    url: '/o/headless-admin-list-type/v1.0/list-type-definitions/{listTypeDefinitionId}/list-type-entries';
};
export type PostListTypeDefinitionListTypeEntryResponses = {
    /**
     * default response
     */
    default: ListTypeEntry;
};
export type PostListTypeDefinitionListTypeEntryResponse = PostListTypeDefinitionListTypeEntryResponses[keyof PostListTypeDefinitionListTypeEntryResponses];
export type PostListTypeDefinitionListTypeEntriesPageExportBatchData = {
    body?: never;
    path: {
        listTypeDefinitionId: string;
    };
    query?: {
        filter?: string;
        search?: string;
        sort?: string;
        callbackURL?: string;
        contentType?: string;
        fieldNames?: string;
    };
    url: '/o/headless-admin-list-type/v1.0/list-type-definitions/{listTypeDefinitionId}/list-type-entries/export-batch';
};
export type PostListTypeDefinitionListTypeEntriesPageExportBatchResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type PostListTypeDefinitionListTypeEntryBatchData = {
    body?: {
        [key: string]: unknown;
    };
    path: {
        listTypeDefinitionId: string;
    };
    query?: {
        callbackURL?: string;
    };
    url: '/o/headless-admin-list-type/v1.0/list-type-definitions/{listTypeDefinitionId}/list-type-entries/batch';
};
export type PostListTypeDefinitionListTypeEntryBatchResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type ClientOptions = {
    baseUrl: 'http://localhost:8080' | (string & {});
};