liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
29 lines (28 loc) • 2.07 kB
TypeScript
import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
import type { GetSamlProviderData, GetSamlProviderResponses, PatchSamlProviderData, PatchSamlProviderResponses, PostSamlProviderData, PostSamlProviderResponses, PostSamlProviderBatchData, PostSamlProviderBatchResponses } 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>;
};
/**
* Retrieves the SAML Provider configuration.
*/
export declare const getSamlProvider: <ThrowOnError extends boolean = false>(options?: Options<GetSamlProviderData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSamlProviderResponses, unknown, ThrowOnError, "fields">;
/**
* Patch the SAML Provider configuration.
*/
export declare const patchSamlProvider: <ThrowOnError extends boolean = false>(options?: Options<PatchSamlProviderData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchSamlProviderResponses, unknown, ThrowOnError, "fields">;
/**
* Creates a full SAML Provider configuration with peer connections.
*/
export declare const postSamlProvider: <ThrowOnError extends boolean = false>(options?: Options<PostSamlProviderData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostSamlProviderResponses, unknown, ThrowOnError, "fields">;
export declare const postSamlProviderBatch: <ThrowOnError extends boolean = false>(options?: Options<PostSamlProviderBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostSamlProviderBatchResponses, unknown, ThrowOnError, "fields">;