liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
44 lines (43 loc) • 3.37 kB
TypeScript
import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
import type { DeletePortalInstanceData, DeletePortalInstanceResponses, GetPortalInstanceData, GetPortalInstanceResponses, PatchPortalInstanceData, PatchPortalInstanceResponses, GetPortalInstancesPageData, GetPortalInstancesPageResponses, PostPortalInstanceData, PostPortalInstanceResponses, PutPortalInstanceActivateData, PutPortalInstanceActivateResponses, PutPortalInstanceDeactivateData, PutPortalInstanceDeactivateResponses } 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>;
};
/**
* Removes the portal instance
*/
export declare const deletePortalInstance: <ThrowOnError extends boolean = false>(options: Options<DeletePortalInstanceData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeletePortalInstanceResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the portal instance
*/
export declare const getPortalInstance: <ThrowOnError extends boolean = false>(options: Options<GetPortalInstanceData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPortalInstanceResponses, unknown, ThrowOnError, "fields">;
/**
* Updates the portal instance with information sent in the request body. Only the provided fields are updated.
*/
export declare const patchPortalInstance: <ThrowOnError extends boolean = false>(options: Options<PatchPortalInstanceData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchPortalInstanceResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the portal instances
*/
export declare const getPortalInstancesPage: <ThrowOnError extends boolean = false>(options?: Options<GetPortalInstancesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPortalInstancesPageResponses, unknown, ThrowOnError, "fields">;
/**
* Adds a new portal instance
*/
export declare const postPortalInstance: <ThrowOnError extends boolean = false>(options?: Options<PostPortalInstanceData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPortalInstanceResponses, unknown, ThrowOnError, "fields">;
/**
* Activates the portal instance
*/
export declare const putPortalInstanceActivate: <ThrowOnError extends boolean = false>(options: Options<PutPortalInstanceActivateData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutPortalInstanceActivateResponses, unknown, ThrowOnError, "fields">;
/**
* Deactivates the portal instance. When a portal instance is deactivated, its virtual host will not longer respond requests.
*/
export declare const putPortalInstanceDeactivate: <ThrowOnError extends boolean = false>(options: Options<PutPortalInstanceDeactivateData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutPortalInstanceDeactivateResponses, unknown, ThrowOnError, "fields">;