liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
39 lines (38 loc) • 9.2 kB
TypeScript
import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
import type { DeleteListTypeDefinitionData, DeleteListTypeDefinitionResponses, GetListTypeDefinitionData, GetListTypeDefinitionResponses, PatchListTypeDefinitionData, PatchListTypeDefinitionResponses, PutListTypeDefinitionData, PutListTypeDefinitionResponses, DeleteListTypeDefinitionBatchData, DeleteListTypeDefinitionBatchResponses, PostListTypeDefinitionBatchData, PostListTypeDefinitionBatchResponses, PutListTypeDefinitionBatchData, PutListTypeDefinitionBatchResponses, GetListTypeDefinitionByExternalReferenceCodeData, GetListTypeDefinitionByExternalReferenceCodeResponses, PutListTypeDefinitionByExternalReferenceCodeData, PutListTypeDefinitionByExternalReferenceCodeResponses, GetListTypeDefinitionsPageData, GetListTypeDefinitionsPageResponses, PostListTypeDefinitionData, PostListTypeDefinitionResponses, PostListTypeDefinitionsPageExportBatchData, PostListTypeDefinitionsPageExportBatchResponses, DeleteListTypeEntryData, DeleteListTypeEntryResponses, GetListTypeEntryData, GetListTypeEntryResponses, PutListTypeEntryData, PutListTypeEntryResponses, DeleteListTypeEntryBatchData, DeleteListTypeEntryBatchResponses, PutListTypeEntryBatchData, PutListTypeEntryBatchResponses, GetListTypeDefinitionByExternalReferenceCodeListTypeEntriesPageData, GetListTypeDefinitionByExternalReferenceCodeListTypeEntriesPageResponses, PostListTypeDefinitionByExternalReferenceCodeListTypeEntryData, PostListTypeDefinitionByExternalReferenceCodeListTypeEntryResponses, GetListTypeDefinitionListTypeEntriesPageData, GetListTypeDefinitionListTypeEntriesPageResponses, PostListTypeDefinitionListTypeEntryData, PostListTypeDefinitionListTypeEntryResponses, PostListTypeDefinitionListTypeEntriesPageExportBatchData, PostListTypeDefinitionListTypeEntriesPageExportBatchResponses, PostListTypeDefinitionListTypeEntryBatchData, PostListTypeDefinitionListTypeEntryBatchResponses } from './types.gen';
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
/**
* You can provide a client instance returned by `createClient()` instead of
* individual options. This might be also useful if you want to implement a
* custom client.
*/
client?: Client;
/**
* You can pass arbitrary values through the `meta` object. This can be
* used to access values that aren't defined as part of the SDK function.
*/
meta?: Record<string, unknown>;
};
export declare const deleteListTypeDefinition: <ThrowOnError extends boolean = false>(options: Options<DeleteListTypeDefinitionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteListTypeDefinitionResponses, unknown, ThrowOnError, "fields">;
export declare const getListTypeDefinition: <ThrowOnError extends boolean = false>(options: Options<GetListTypeDefinitionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetListTypeDefinitionResponses, unknown, ThrowOnError, "fields">;
export declare const patchListTypeDefinition: <ThrowOnError extends boolean = false>(options: Options<PatchListTypeDefinitionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchListTypeDefinitionResponses, unknown, ThrowOnError, "fields">;
export declare const putListTypeDefinition: <ThrowOnError extends boolean = false>(options: Options<PutListTypeDefinitionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutListTypeDefinitionResponses, unknown, ThrowOnError, "fields">;
export declare const deleteListTypeDefinitionBatch: <ThrowOnError extends boolean = false>(options?: Options<DeleteListTypeDefinitionBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteListTypeDefinitionBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postListTypeDefinitionBatch: <ThrowOnError extends boolean = false>(options?: Options<PostListTypeDefinitionBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostListTypeDefinitionBatchResponses, unknown, ThrowOnError, "fields">;
export declare const putListTypeDefinitionBatch: <ThrowOnError extends boolean = false>(options?: Options<PutListTypeDefinitionBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutListTypeDefinitionBatchResponses, unknown, ThrowOnError, "fields">;
export declare const getListTypeDefinitionByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<GetListTypeDefinitionByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetListTypeDefinitionByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
export declare const putListTypeDefinitionByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<PutListTypeDefinitionByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutListTypeDefinitionByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
export declare const getListTypeDefinitionsPage: <ThrowOnError extends boolean = false>(options?: Options<GetListTypeDefinitionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetListTypeDefinitionsPageResponses, unknown, ThrowOnError, "fields">;
export declare const postListTypeDefinition: <ThrowOnError extends boolean = false>(options?: Options<PostListTypeDefinitionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostListTypeDefinitionResponses, unknown, ThrowOnError, "fields">;
export declare const postListTypeDefinitionsPageExportBatch: <ThrowOnError extends boolean = false>(options?: Options<PostListTypeDefinitionsPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostListTypeDefinitionsPageExportBatchResponses, unknown, ThrowOnError, "fields">;
export declare const deleteListTypeEntry: <ThrowOnError extends boolean = false>(options: Options<DeleteListTypeEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteListTypeEntryResponses, unknown, ThrowOnError, "fields">;
export declare const getListTypeEntry: <ThrowOnError extends boolean = false>(options: Options<GetListTypeEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetListTypeEntryResponses, unknown, ThrowOnError, "fields">;
export declare const putListTypeEntry: <ThrowOnError extends boolean = false>(options: Options<PutListTypeEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutListTypeEntryResponses, unknown, ThrowOnError, "fields">;
export declare const deleteListTypeEntryBatch: <ThrowOnError extends boolean = false>(options?: Options<DeleteListTypeEntryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteListTypeEntryBatchResponses, unknown, ThrowOnError, "fields">;
export declare const putListTypeEntryBatch: <ThrowOnError extends boolean = false>(options?: Options<PutListTypeEntryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutListTypeEntryBatchResponses, unknown, ThrowOnError, "fields">;
export declare const getListTypeDefinitionByExternalReferenceCodeListTypeEntriesPage: <ThrowOnError extends boolean = false>(options: Options<GetListTypeDefinitionByExternalReferenceCodeListTypeEntriesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetListTypeDefinitionByExternalReferenceCodeListTypeEntriesPageResponses, unknown, ThrowOnError, "fields">;
export declare const postListTypeDefinitionByExternalReferenceCodeListTypeEntry: <ThrowOnError extends boolean = false>(options: Options<PostListTypeDefinitionByExternalReferenceCodeListTypeEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostListTypeDefinitionByExternalReferenceCodeListTypeEntryResponses, unknown, ThrowOnError, "fields">;
export declare const getListTypeDefinitionListTypeEntriesPage: <ThrowOnError extends boolean = false>(options: Options<GetListTypeDefinitionListTypeEntriesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetListTypeDefinitionListTypeEntriesPageResponses, unknown, ThrowOnError, "fields">;
export declare const postListTypeDefinitionListTypeEntry: <ThrowOnError extends boolean = false>(options: Options<PostListTypeDefinitionListTypeEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostListTypeDefinitionListTypeEntryResponses, unknown, ThrowOnError, "fields">;
export declare const postListTypeDefinitionListTypeEntriesPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostListTypeDefinitionListTypeEntriesPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostListTypeDefinitionListTypeEntriesPageExportBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postListTypeDefinitionListTypeEntryBatch: <ThrowOnError extends boolean = false>(options: Options<PostListTypeDefinitionListTypeEntryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostListTypeDefinitionListTypeEntryBatchResponses, unknown, ThrowOnError, "fields">;