liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
66 lines (65 loc) • 6.15 kB
TypeScript
import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
import type { GetExportTaskData, GetExportTaskResponses, GetExportTaskByExternalReferenceCodeData, GetExportTaskByExternalReferenceCodeResponses, GetExportTaskByExternalReferenceCodeContentData, GetExportTaskByExternalReferenceCodeContentResponses, GetExportTaskContentData, GetExportTaskContentResponses, PostExportTaskData, PostExportTaskResponses, DeleteImportTask1Data, DeleteImportTask1Responses, PostImportTask1Data, PostImportTask1Responses, PutImportTask1Data, PutImportTask1Responses, GetImportTaskData, GetImportTaskResponses, GetImportTaskByExternalReferenceCodeData, GetImportTaskByExternalReferenceCodeResponses, GetImportTaskByExternalReferenceCodeContentData, GetImportTaskByExternalReferenceCodeContentResponses, GetImportTaskByExternalReferenceCodeFailedItemReportData, GetImportTaskByExternalReferenceCodeFailedItemReportResponses, GetImportTaskContentData, GetImportTaskContentResponses, GetImportTaskFailedItemReportData, GetImportTaskFailedItemReportResponses } 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 export task.
*/
export declare const getExportTask: <ThrowOnError extends boolean = false>(options: Options<GetExportTaskData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetExportTaskResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the export task by external reference code.
*/
export declare const getExportTaskByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<GetExportTaskByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetExportTaskByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the exported content by external reference code.
*/
export declare const getExportTaskByExternalReferenceCodeContent: <ThrowOnError extends boolean = false>(options: Options<GetExportTaskByExternalReferenceCodeContentData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetExportTaskByExternalReferenceCodeContentResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the exported content.
*/
export declare const getExportTaskContent: <ThrowOnError extends boolean = false>(options: Options<GetExportTaskContentData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetExportTaskContentResponses, unknown, ThrowOnError, "fields">;
/**
* Submits a request for exporting items to a file.
*/
export declare const postExportTask: <ThrowOnError extends boolean = false>(options: Options<PostExportTaskData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostExportTaskResponses, unknown, ThrowOnError, "fields">;
/**
* Uploads a new file for deleting items in batch.
*/
export declare const deleteImportTask1: <ThrowOnError extends boolean = false>(options: Options<DeleteImportTask1Data, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteImportTask1Responses, unknown, ThrowOnError, "fields">;
/**
* Uploads a new file for creating new items in batch.
*/
export declare const postImportTask1: <ThrowOnError extends boolean = false>(options: Options<PostImportTask1Data, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostImportTask1Responses, unknown, ThrowOnError, "fields">;
/**
* Uploads a new file for updating items in batch.
*/
export declare const putImportTask1: <ThrowOnError extends boolean = false>(options: Options<PutImportTask1Data, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutImportTask1Responses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the import task.
*/
export declare const getImportTask: <ThrowOnError extends boolean = false>(options: Options<GetImportTaskData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetImportTaskResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the import task by external reference code.
*/
export declare const getImportTaskByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<GetImportTaskByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetImportTaskByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the exported content by external reference code.
*/
export declare const getImportTaskByExternalReferenceCodeContent: <ThrowOnError extends boolean = false>(options: Options<GetImportTaskByExternalReferenceCodeContentData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetImportTaskByExternalReferenceCodeContentResponses, unknown, ThrowOnError, "fields">;
export declare const getImportTaskByExternalReferenceCodeFailedItemReport: <ThrowOnError extends boolean = false>(options: Options<GetImportTaskByExternalReferenceCodeFailedItemReportData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetImportTaskByExternalReferenceCodeFailedItemReportResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the exported content.
*/
export declare const getImportTaskContent: <ThrowOnError extends boolean = false>(options: Options<GetImportTaskContentData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetImportTaskContentResponses, unknown, ThrowOnError, "fields">;
export declare const getImportTaskFailedItemReport: <ThrowOnError extends boolean = false>(options: Options<GetImportTaskFailedItemReportData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetImportTaskFailedItemReportResponses, unknown, ThrowOnError, "fields">;