liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
34 lines (33 loc) • 2.94 kB
TypeScript
import { type Options as ClientOptions, type TDataShape, type Client } from '@hey-api/client-fetch';
import type { DeleteSiteData, DeleteSiteResponses, DeleteSiteByExternalReferenceCodeData, DeleteSiteByExternalReferenceCodeResponses, GetSiteByExternalReferenceCodeData, GetSiteByExternalReferenceCodeResponses, PutSiteByExternalReferenceCodeData, PutSiteByExternalReferenceCodeResponses, GetSiteByExternalReferenceCodeSiteInitializerData, GetSiteByExternalReferenceCodeSiteInitializerResponses, PostSite1Data, PostSite1Responses } 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>;
};
/**
* Deletes a site and all of its associated content.
*/
export declare const deleteSite: <ThrowOnError extends boolean = false>(options: Options<DeleteSiteData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteSiteResponses, unknown, ThrowOnError, "fields">;
/**
* Deletes a site and all of its associated content.
*/
export declare const deleteSiteByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<DeleteSiteByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteSiteByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
export declare const getSiteByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<GetSiteByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSiteByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Adds or update a new site
*/
export declare const putSiteByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<PutSiteByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutSiteByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
export declare const getSiteByExternalReferenceCodeSiteInitializer: <ThrowOnError extends boolean = false>(options: Options<GetSiteByExternalReferenceCodeSiteInitializerData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSiteByExternalReferenceCodeSiteInitializerResponses, unknown, ThrowOnError, "fields">;
/**
* Adds a new site
*/
export declare const postSite1: <ThrowOnError extends boolean = false>(options?: Options<PostSite1Data, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostSite1Responses, unknown, ThrowOnError, "fields">;