liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
40 lines (39 loc) • 8.12 kB
TypeScript
import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
import type { PostConfigurationWizardModeData, PostConfigurationWizardModeResponses, GetChannelsPageData, GetChannelsPageResponses, PatchChannelData, PatchChannelResponses, PostChannelData, PostChannelResponses, GetCommerceChannelsPageData, GetCommerceChannelsPageResponses, GetContactAccountGroupsPageData, GetContactAccountGroupsPageResponses, GetContactConfigurationData, GetContactConfigurationResponses, PutContactConfigurationData, PutContactConfigurationResponses, GetContactOrganizationsPageData, GetContactOrganizationsPageResponses, GetContactUserGroupsPageData, GetContactUserGroupsPageResponses, DeleteDataSourceData, DeleteDataSourceResponses, PostDataSourceData, PostDataSourceResponses, GetFieldsAccountsPageData, GetFieldsAccountsPageResponses, PatchFieldAccountData, PatchFieldAccountResponses, GetFieldsOrdersPageData, GetFieldsOrdersPageResponses, PatchFieldOrderData, PatchFieldOrderResponses, GetFieldsPeoplePageData, GetFieldsPeoplePageResponses, PatchFieldPeopleData, PatchFieldPeopleResponses, GetFieldsProductsPageData, GetFieldsProductsPageResponses, PatchFieldProductData, PatchFieldProductResponses, GetFieldData, GetFieldResponses, GetRecommendationConfigurationData, GetRecommendationConfigurationResponses, PutRecommendationConfigurationData, PutRecommendationConfigurationResponses, GetSitesPageData, GetSitesPageResponses } 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 postConfigurationWizardMode: <ThrowOnError extends boolean = false>(options?: Options<PostConfigurationWizardModeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostConfigurationWizardModeResponses, unknown, ThrowOnError, "fields">;
export declare const getChannelsPage: <ThrowOnError extends boolean = false>(options?: Options<GetChannelsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetChannelsPageResponses, unknown, ThrowOnError, "fields">;
export declare const patchChannel: <ThrowOnError extends boolean = false>(options?: Options<PatchChannelData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchChannelResponses, unknown, ThrowOnError, "fields">;
export declare const postChannel: <ThrowOnError extends boolean = false>(options?: Options<PostChannelData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostChannelResponses, unknown, ThrowOnError, "fields">;
export declare const getCommerceChannelsPage: <ThrowOnError extends boolean = false>(options?: Options<GetCommerceChannelsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCommerceChannelsPageResponses, unknown, ThrowOnError, "fields">;
export declare const getContactAccountGroupsPage: <ThrowOnError extends boolean = false>(options?: Options<GetContactAccountGroupsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetContactAccountGroupsPageResponses, unknown, ThrowOnError, "fields">;
export declare const getContactConfiguration: <ThrowOnError extends boolean = false>(options?: Options<GetContactConfigurationData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetContactConfigurationResponses, unknown, ThrowOnError, "fields">;
export declare const putContactConfiguration: <ThrowOnError extends boolean = false>(options?: Options<PutContactConfigurationData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutContactConfigurationResponses, unknown, ThrowOnError, "fields">;
export declare const getContactOrganizationsPage: <ThrowOnError extends boolean = false>(options?: Options<GetContactOrganizationsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetContactOrganizationsPageResponses, unknown, ThrowOnError, "fields">;
export declare const getContactUserGroupsPage: <ThrowOnError extends boolean = false>(options?: Options<GetContactUserGroupsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetContactUserGroupsPageResponses, unknown, ThrowOnError, "fields">;
export declare const deleteDataSource: <ThrowOnError extends boolean = false>(options?: Options<DeleteDataSourceData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteDataSourceResponses, unknown, ThrowOnError, "fields">;
export declare const postDataSource: <ThrowOnError extends boolean = false>(options?: Options<PostDataSourceData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostDataSourceResponses, unknown, ThrowOnError, "fields">;
export declare const getFieldsAccountsPage: <ThrowOnError extends boolean = false>(options?: Options<GetFieldsAccountsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFieldsAccountsPageResponses, unknown, ThrowOnError, "fields">;
export declare const patchFieldAccount: <ThrowOnError extends boolean = false>(options?: Options<PatchFieldAccountData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchFieldAccountResponses, unknown, ThrowOnError, "fields">;
export declare const getFieldsOrdersPage: <ThrowOnError extends boolean = false>(options?: Options<GetFieldsOrdersPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFieldsOrdersPageResponses, unknown, ThrowOnError, "fields">;
export declare const patchFieldOrder: <ThrowOnError extends boolean = false>(options?: Options<PatchFieldOrderData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchFieldOrderResponses, unknown, ThrowOnError, "fields">;
export declare const getFieldsPeoplePage: <ThrowOnError extends boolean = false>(options?: Options<GetFieldsPeoplePageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFieldsPeoplePageResponses, unknown, ThrowOnError, "fields">;
export declare const patchFieldPeople: <ThrowOnError extends boolean = false>(options?: Options<PatchFieldPeopleData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchFieldPeopleResponses, unknown, ThrowOnError, "fields">;
export declare const getFieldsProductsPage: <ThrowOnError extends boolean = false>(options?: Options<GetFieldsProductsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFieldsProductsPageResponses, unknown, ThrowOnError, "fields">;
export declare const patchFieldProduct: <ThrowOnError extends boolean = false>(options?: Options<PatchFieldProductData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchFieldProductResponses, unknown, ThrowOnError, "fields">;
export declare const getField: <ThrowOnError extends boolean = false>(options?: Options<GetFieldData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFieldResponses, unknown, ThrowOnError, "fields">;
export declare const getRecommendationConfiguration: <ThrowOnError extends boolean = false>(options?: Options<GetRecommendationConfigurationData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetRecommendationConfigurationResponses, unknown, ThrowOnError, "fields">;
export declare const putRecommendationConfiguration: <ThrowOnError extends boolean = false>(options?: Options<PutRecommendationConfigurationData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutRecommendationConfigurationResponses, unknown, ThrowOnError, "fields">;
export declare const getSitesPage: <ThrowOnError extends boolean = false>(options?: Options<GetSitesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSitesPageResponses, unknown, ThrowOnError, "fields">;