liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
43 lines (42 loc) • 8.62 kB
TypeScript
import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
import type { DeleteCountryData, DeleteCountryResponses, GetCountryData, GetCountryResponses, PatchCountryData, PatchCountryResponses, PutCountryData, PutCountryResponses, DeleteCountryBatchData, DeleteCountryBatchResponses, PostCountryBatchData, PostCountryBatchResponses, PutCountryBatchData, PutCountryBatchResponses, GetCountriesPageData, GetCountriesPageResponses, PostCountryData, PostCountryResponses, GetCountryByA2Data, GetCountryByA2Responses, GetCountryByA3Data, GetCountryByA3Responses, GetCountryByNameData, GetCountryByNameResponses, GetCountryByNumberData, GetCountryByNumberResponses, PostCountriesPageExportBatchData, PostCountriesPageExportBatchResponses, DeleteRegionData, DeleteRegionResponses, GetRegionData, GetRegionResponses, PatchRegionData, PatchRegionResponses, PutRegionData, PutRegionResponses, DeleteRegionBatchData, DeleteRegionBatchResponses, PutRegionBatchData, PutRegionBatchResponses, GetCountryRegionByRegionCodeData, GetCountryRegionByRegionCodeResponses, GetCountryRegionsPageData, GetCountryRegionsPageResponses, PostCountryRegionData, PostCountryRegionResponses, GetRegionsPageData, GetRegionsPageResponses, PostCountryRegionBatchData, PostCountryRegionBatchResponses, PostCountryRegionsPageExportBatchData, PostCountryRegionsPageExportBatchResponses, PostRegionsPageExportBatchData, PostRegionsPageExportBatchResponses } 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 deleteCountry: <ThrowOnError extends boolean = false>(options: Options<DeleteCountryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteCountryResponses, unknown, ThrowOnError, "fields">;
export declare const getCountry: <ThrowOnError extends boolean = false>(options: Options<GetCountryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCountryResponses, unknown, ThrowOnError, "fields">;
export declare const patchCountry: <ThrowOnError extends boolean = false>(options: Options<PatchCountryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchCountryResponses, unknown, ThrowOnError, "fields">;
export declare const putCountry: <ThrowOnError extends boolean = false>(options: Options<PutCountryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutCountryResponses, unknown, ThrowOnError, "fields">;
export declare const deleteCountryBatch: <ThrowOnError extends boolean = false>(options?: Options<DeleteCountryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteCountryBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postCountryBatch: <ThrowOnError extends boolean = false>(options?: Options<PostCountryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostCountryBatchResponses, unknown, ThrowOnError, "fields">;
export declare const putCountryBatch: <ThrowOnError extends boolean = false>(options?: Options<PutCountryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutCountryBatchResponses, unknown, ThrowOnError, "fields">;
export declare const getCountriesPage: <ThrowOnError extends boolean = false>(options?: Options<GetCountriesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCountriesPageResponses, unknown, ThrowOnError, "fields">;
export declare const postCountry: <ThrowOnError extends boolean = false>(options?: Options<PostCountryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostCountryResponses, unknown, ThrowOnError, "fields">;
export declare const getCountryByA2: <ThrowOnError extends boolean = false>(options: Options<GetCountryByA2Data, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCountryByA2Responses, unknown, ThrowOnError, "fields">;
export declare const getCountryByA3: <ThrowOnError extends boolean = false>(options: Options<GetCountryByA3Data, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCountryByA3Responses, unknown, ThrowOnError, "fields">;
export declare const getCountryByName: <ThrowOnError extends boolean = false>(options: Options<GetCountryByNameData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCountryByNameResponses, unknown, ThrowOnError, "fields">;
export declare const getCountryByNumber: <ThrowOnError extends boolean = false>(options: Options<GetCountryByNumberData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCountryByNumberResponses, unknown, ThrowOnError, "fields">;
export declare const postCountriesPageExportBatch: <ThrowOnError extends boolean = false>(options?: Options<PostCountriesPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostCountriesPageExportBatchResponses, unknown, ThrowOnError, "fields">;
export declare const deleteRegion: <ThrowOnError extends boolean = false>(options: Options<DeleteRegionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteRegionResponses, unknown, ThrowOnError, "fields">;
export declare const getRegion: <ThrowOnError extends boolean = false>(options: Options<GetRegionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetRegionResponses, unknown, ThrowOnError, "fields">;
export declare const patchRegion: <ThrowOnError extends boolean = false>(options: Options<PatchRegionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchRegionResponses, unknown, ThrowOnError, "fields">;
export declare const putRegion: <ThrowOnError extends boolean = false>(options: Options<PutRegionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutRegionResponses, unknown, ThrowOnError, "fields">;
export declare const deleteRegionBatch: <ThrowOnError extends boolean = false>(options?: Options<DeleteRegionBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteRegionBatchResponses, unknown, ThrowOnError, "fields">;
export declare const putRegionBatch: <ThrowOnError extends boolean = false>(options?: Options<PutRegionBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutRegionBatchResponses, unknown, ThrowOnError, "fields">;
export declare const getCountryRegionByRegionCode: <ThrowOnError extends boolean = false>(options: Options<GetCountryRegionByRegionCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCountryRegionByRegionCodeResponses, unknown, ThrowOnError, "fields">;
export declare const getCountryRegionsPage: <ThrowOnError extends boolean = false>(options: Options<GetCountryRegionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCountryRegionsPageResponses, unknown, ThrowOnError, "fields">;
export declare const postCountryRegion: <ThrowOnError extends boolean = false>(options: Options<PostCountryRegionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostCountryRegionResponses, unknown, ThrowOnError, "fields">;
export declare const getRegionsPage: <ThrowOnError extends boolean = false>(options?: Options<GetRegionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetRegionsPageResponses, unknown, ThrowOnError, "fields">;
export declare const postCountryRegionBatch: <ThrowOnError extends boolean = false>(options: Options<PostCountryRegionBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostCountryRegionBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postCountryRegionsPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostCountryRegionsPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostCountryRegionsPageExportBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postRegionsPageExportBatch: <ThrowOnError extends boolean = false>(options?: Options<PostRegionsPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostRegionsPageExportBatchResponses, unknown, ThrowOnError, "fields">;