liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
22 lines (21 loc) • 2.7 kB
TypeScript
import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
import type { GetSiteDsEnvelopeData, GetSiteDsEnvelopeResponses, GetSiteDsEnvelopesPageData, GetSiteDsEnvelopesPageResponses, PostSiteDsEnvelopeData, PostSiteDsEnvelopeResponses, PostSiteDsEnvelopeBatchData, PostSiteDsEnvelopeBatchResponses, PostSiteDsEnvelopesPageExportBatchData, PostSiteDsEnvelopesPageExportBatchResponses, PostSiteDsRecipientViewDefinitionData, PostSiteDsRecipientViewDefinitionResponses } 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 getSiteDsEnvelope: <ThrowOnError extends boolean = false>(options: Options<GetSiteDsEnvelopeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSiteDsEnvelopeResponses, unknown, ThrowOnError, "fields">;
export declare const getSiteDsEnvelopesPage: <ThrowOnError extends boolean = false>(options: Options<GetSiteDsEnvelopesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSiteDsEnvelopesPageResponses, unknown, ThrowOnError, "fields">;
export declare const postSiteDsEnvelope: <ThrowOnError extends boolean = false>(options: Options<PostSiteDsEnvelopeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostSiteDsEnvelopeResponses, unknown, ThrowOnError, "fields">;
export declare const postSiteDsEnvelopeBatch: <ThrowOnError extends boolean = false>(options: Options<PostSiteDsEnvelopeBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostSiteDsEnvelopeBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postSiteDsEnvelopesPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostSiteDsEnvelopesPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostSiteDsEnvelopesPageExportBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postSiteDsRecipientViewDefinition: <ThrowOnError extends boolean = false>(options: Options<PostSiteDsRecipientViewDefinitionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostSiteDsRecipientViewDefinitionResponses, unknown, ThrowOnError, "fields">;