liferay-headless-rest-client/dist/clients/headless-form-v1.0/sdk.gen.d.ts

A collection of Headless Clients used in Liferay Portal

import { type Options as ClientOptions, type TDataShape, type Client } from '@hey-api/client-fetch';
import type { DeleteFormDocumentData, DeleteFormDocumentResponses, GetFormDocumentData, GetFormDocumentResponses, DeleteFormDocumentBatchData, DeleteFormDocumentBatchResponses, GetFormFormRecordByLatestDraftData, GetFormFormRecordByLatestDraftResponses, GetFormFormRecordsPageData, GetFormFormRecordsPageResponses, PostFormFormRecordData, PostFormFormRecordResponses, GetFormRecordData, GetFormRecordResponses, PutFormRecordData, PutFormRecordResponses, PostFormFormRecordBatchData, PostFormFormRecordBatchResponses, PostFormFormRecordsPageExportBatchData, PostFormFormRecordsPageExportBatchResponses, PutFormRecordBatchData, PutFormRecordBatchResponses, GetFormData, GetFormResponses, GetSiteFormsPageData, GetSiteFormsPageResponses, PostFormEvaluateContextData, PostFormEvaluateContextResponses, PostFormFormDocumentData, PostFormFormDocumentResponses, PostSiteFormsPageExportBatchData, PostSiteFormsPageExportBatchResponses, GetFormStructureData, GetFormStructureResponses, GetSiteFormStructuresPageData, GetSiteFormStructuresPageResponses, PostSiteFormStructuresPageExportBatchData, PostSiteFormStructuresPageExportBatchResponses } 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>;
};
/**
 * @deprecated
 */
export declare const deleteFormDocument: <ThrowOnError extends boolean = false>(options: Options<DeleteFormDocumentData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteFormDocumentResponses, unknown, ThrowOnError, "fields">;
/**
 * @deprecated
 */
export declare const getFormDocument: <ThrowOnError extends boolean = false>(options: Options<GetFormDocumentData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFormDocumentResponses, unknown, ThrowOnError, "fields">;
/**
 * @deprecated
 */
export declare const deleteFormDocumentBatch: <ThrowOnError extends boolean = false>(options?: Options<DeleteFormDocumentBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteFormDocumentBatchResponses, unknown, ThrowOnError, "fields">;
/**
 * @deprecated
 */
export declare const getFormFormRecordByLatestDraft: <ThrowOnError extends boolean = false>(options: Options<GetFormFormRecordByLatestDraftData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFormFormRecordByLatestDraftResponses, unknown, ThrowOnError, "fields">;
/**
 * @deprecated
 */
export declare const getFormFormRecordsPage: <ThrowOnError extends boolean = false>(options: Options<GetFormFormRecordsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFormFormRecordsPageResponses, unknown, ThrowOnError, "fields">;
/**
 * @deprecated
 */
export declare const postFormFormRecord: <ThrowOnError extends boolean = false>(options: Options<PostFormFormRecordData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostFormFormRecordResponses, unknown, ThrowOnError, "fields">;
/**
 * @deprecated
 */
export declare const getFormRecord: <ThrowOnError extends boolean = false>(options: Options<GetFormRecordData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFormRecordResponses, unknown, ThrowOnError, "fields">;
/**
 * @deprecated
 */
export declare const putFormRecord: <ThrowOnError extends boolean = false>(options: Options<PutFormRecordData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutFormRecordResponses, unknown, ThrowOnError, "fields">;
/**
 * @deprecated
 */
export declare const postFormFormRecordBatch: <ThrowOnError extends boolean = false>(options: Options<PostFormFormRecordBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostFormFormRecordBatchResponses, unknown, ThrowOnError, "fields">;
/**
 * @deprecated
 */
export declare const postFormFormRecordsPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostFormFormRecordsPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostFormFormRecordsPageExportBatchResponses, unknown, ThrowOnError, "fields">;
/**
 * @deprecated
 */
export declare const putFormRecordBatch: <ThrowOnError extends boolean = false>(options?: Options<PutFormRecordBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutFormRecordBatchResponses, unknown, ThrowOnError, "fields">;
/**
 * @deprecated
 */
export declare const getForm: <ThrowOnError extends boolean = false>(options: Options<GetFormData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFormResponses, unknown, ThrowOnError, "fields">;
/**
 * @deprecated
 */
export declare const getSiteFormsPage: <ThrowOnError extends boolean = false>(options: Options<GetSiteFormsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSiteFormsPageResponses, unknown, ThrowOnError, "fields">;
/**
 * @deprecated
 */
export declare const postFormEvaluateContext: <ThrowOnError extends boolean = false>(options: Options<PostFormEvaluateContextData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostFormEvaluateContextResponses, unknown, ThrowOnError, "fields">;
/**
 * @deprecated
 */
export declare const postFormFormDocument: <ThrowOnError extends boolean = false>(options: Options<PostFormFormDocumentData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostFormFormDocumentResponses, unknown, ThrowOnError, "fields">;
/**
 * @deprecated
 */
export declare const postSiteFormsPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostSiteFormsPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostSiteFormsPageExportBatchResponses, unknown, ThrowOnError, "fields">;
/**
 * @deprecated
 */
export declare const getFormStructure: <ThrowOnError extends boolean = false>(options: Options<GetFormStructureData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFormStructureResponses, unknown, ThrowOnError, "fields">;
/**
 * @deprecated
 */
export declare const getSiteFormStructuresPage: <ThrowOnError extends boolean = false>(options: Options<GetSiteFormStructuresPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSiteFormStructuresPageResponses, unknown, ThrowOnError, "fields">;
/**
 * @deprecated
 */
export declare const postSiteFormStructuresPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostSiteFormStructuresPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostSiteFormStructuresPageExportBatchResponses, unknown, ThrowOnError, "fields">;