liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
25 lines (24 loc) • 3.5 kB
TypeScript
import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
import type { GetPlanInternalClassNameKeyFieldsPageData, GetPlanInternalClassNameKeyFieldsPageResponses, DeletePlanData, DeletePlanResponses, GetPlanData, GetPlanResponses, PatchPlanData, PatchPlanResponses, GetPlanTemplateData, GetPlanTemplateResponses, GetPlansPageData, GetPlansPageResponses, PostPlanData, PostPlanResponses, GetPlanInternalClassNameKeySiteScopesPageData, GetPlanInternalClassNameKeySiteScopesPageResponses, GetPlanInternalClassNameKeyStrategiesPageData, GetPlanInternalClassNameKeyStrategiesPageResponses } 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 getPlanInternalClassNameKeyFieldsPage: <ThrowOnError extends boolean = false>(options: Options<GetPlanInternalClassNameKeyFieldsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlanInternalClassNameKeyFieldsPageResponses, unknown, ThrowOnError, "fields">;
export declare const deletePlan: <ThrowOnError extends boolean = false>(options: Options<DeletePlanData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeletePlanResponses, unknown, ThrowOnError, "fields">;
export declare const getPlan: <ThrowOnError extends boolean = false>(options: Options<GetPlanData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlanResponses, unknown, ThrowOnError, "fields">;
export declare const patchPlan: <ThrowOnError extends boolean = false>(options: Options<PatchPlanData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchPlanResponses, unknown, ThrowOnError, "fields">;
export declare const getPlanTemplate: <ThrowOnError extends boolean = false>(options: Options<GetPlanTemplateData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlanTemplateResponses, unknown, ThrowOnError, "fields">;
export declare const getPlansPage: <ThrowOnError extends boolean = false>(options?: Options<GetPlansPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlansPageResponses, unknown, ThrowOnError, "fields">;
export declare const postPlan: <ThrowOnError extends boolean = false>(options?: Options<PostPlanData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPlanResponses, unknown, ThrowOnError, "fields">;
export declare const getPlanInternalClassNameKeySiteScopesPage: <ThrowOnError extends boolean = false>(options: Options<GetPlanInternalClassNameKeySiteScopesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlanInternalClassNameKeySiteScopesPageResponses, unknown, ThrowOnError, "fields">;
export declare const getPlanInternalClassNameKeyStrategiesPage: <ThrowOnError extends boolean = false>(options: Options<GetPlanInternalClassNameKeyStrategiesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlanInternalClassNameKeyStrategiesPageResponses, unknown, ThrowOnError, "fields">;