liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
52 lines (51 loc) • 3.86 kB
TypeScript
import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
import type { PostApiAudienceManagerPvtAudienceData, PostApiAudienceManagerPvtAudienceResponses, PostApiAudienceManagerPvtAudienceErrors, DeleteApiPriceTableMapperPvtMappingByAudienceIdData, DeleteApiPriceTableMapperPvtMappingByAudienceIdResponses, DeleteApiPriceTableMapperPvtMappingByAudienceIdErrors, GetApiPriceTableMapperPvtMappingByAudienceIdData, GetApiPriceTableMapperPvtMappingByAudienceIdResponses, GetApiPriceTableMapperPvtMappingByAudienceIdErrors, PutApiPriceTableMapperPvtMappingByAudienceIdData, PutApiPriceTableMapperPvtMappingByAudienceIdResponses, PutApiPriceTableMapperPvtMappingByAudienceIdErrors } 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>;
};
/**
* Fetch audience
* Fetch the audience ID based on the provided shopper email.
*
* ## Permissions
*
* This endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).
*/
export declare const postApiAudienceManagerPvtAudience: <ThrowOnError extends boolean = false>(options: Options<PostApiAudienceManagerPvtAudienceData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostApiAudienceManagerPvtAudienceResponses, PostApiAudienceManagerPvtAudienceErrors, ThrowOnError, "fields">;
/**
* Delete price table mapping
* Removes the price table mapping for the provided audience.
*
* ## Permissions
*
* This endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).
*/
export declare const deleteApiPriceTableMapperPvtMappingByAudienceId: <ThrowOnError extends boolean = false>(options: Options<DeleteApiPriceTableMapperPvtMappingByAudienceIdData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteApiPriceTableMapperPvtMappingByAudienceIdResponses, DeleteApiPriceTableMapperPvtMappingByAudienceIdErrors, ThrowOnError, "fields">;
/**
* Get price table mapping
* Fetches the price table mapping for a specific audience.
*
* ## Permissions
*
* This endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).
*/
export declare const getApiPriceTableMapperPvtMappingByAudienceId: <ThrowOnError extends boolean = false>(options: Options<GetApiPriceTableMapperPvtMappingByAudienceIdData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetApiPriceTableMapperPvtMappingByAudienceIdResponses, GetApiPriceTableMapperPvtMappingByAudienceIdErrors, ThrowOnError, "fields">;
/**
* Set price table mapping
* Sets one or more price table mappings for the specified audience. Each price table ID in the array defines a distinct price table that applies to the audience.
*
* ## Permissions
*
* This endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).
*/
export declare const putApiPriceTableMapperPvtMappingByAudienceId: <ThrowOnError extends boolean = false>(options: Options<PutApiPriceTableMapperPvtMappingByAudienceIdData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutApiPriceTableMapperPvtMappingByAudienceIdResponses, PutApiPriceTableMapperPvtMappingByAudienceIdErrors, ThrowOnError, "fields">;