liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
1,738 lines • 121 kB
TypeScript
export type Account = {
id?: number;
logoId?: number;
name?: string;
readonly 'x-class-name'?: string;
};
export type Category = {
readonly id?: number;
readonly name?: string;
readonly path?: string;
readonly vocabulary?: string;
readonly 'x-class-name'?: string;
};
export type Channel = {
currencyCode?: string;
externalReferenceCode?: string;
id?: number;
name?: string;
siteGroupId?: number;
type?: string;
readonly 'x-class-name'?: string;
};
export type DiscountAccountGroup = {
accountGroup?: PricingAccountGroup;
accountGroupExternalReferenceCode?: string;
accountGroupId: number;
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
readonly discountAccountGroupId?: number;
discountExternalReferenceCode?: string;
readonly discountId?: number;
readonly 'x-class-name'?: string;
};
export type Facet = {
facetCriteria?: string;
facetValues?: Array<FacetValue>;
};
export type FacetValue = {
numberOfOccurrences?: number;
term?: string;
};
export type PageDiscountAccountGroup = {
items?: Array<DiscountAccountGroup>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PricingAccountGroup = {
readonly id?: number;
name?: string;
readonly 'x-class-name'?: string;
};
export type DiscountAccount = {
account?: Account;
accountExternalReferenceCode?: string;
accountId: number;
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
readonly discountAccountId?: number;
discountExternalReferenceCode?: string;
readonly discountId?: number;
readonly 'x-class-name'?: string;
};
export type PageDiscountAccount = {
items?: Array<DiscountAccount>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type DiscountCategory = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
category?: Category;
categoryExternalReferenceCode?: string;
categoryId: number;
readonly discountCategoryId?: number;
discountExternalReferenceCode?: string;
readonly discountId?: number;
readonly 'x-class-name'?: string;
};
export type PageDiscountCategory = {
items?: Array<DiscountCategory>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type DiscountChannel = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
channel?: Channel;
channelExternalReferenceCode?: string;
channelId: number;
readonly discountChannelId?: number;
discountExternalReferenceCode?: string;
readonly discountId?: number;
readonly 'x-class-name'?: string;
};
export type PageDiscountChannel = {
items?: Array<DiscountChannel>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type DiscountOrderType = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
discountExternalReferenceCode?: string;
readonly discountId?: number;
readonly discountOrderTypeId?: number;
orderType?: OrderType;
orderTypeExternalReferenceCode?: string;
orderTypeId: number;
priority?: number;
readonly 'x-class-name'?: string;
};
export type OrderType = {
readonly id?: number;
name?: {
[key: string]: string;
};
readonly 'x-class-name'?: string;
};
export type PageDiscountOrderType = {
items?: Array<DiscountOrderType>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type DiscountProductGroup = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
discountExternalReferenceCode?: string;
readonly discountId?: number;
readonly discountProductGroupId?: number;
productGroup?: ProductGroup;
productGroupExternalReferenceCode?: string;
productGroupId: number;
readonly 'x-class-name'?: string;
};
export type PageDiscountProductGroup = {
items?: Array<DiscountProductGroup>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type ProductGroup = {
id?: number;
productsCount?: number;
title?: {
[key: string]: string;
};
readonly 'x-class-name'?: string;
};
export type DiscountProduct = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
discountExternalReferenceCode?: string;
readonly discountId?: number;
readonly discountProductId?: number;
product?: Product;
productExternalReferenceCode?: string;
productId: number;
readonly 'x-class-name'?: string;
};
export type PageDiscountProduct = {
items?: Array<DiscountProduct>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type Product = {
readonly id?: number;
name?: {
[key: string]: string;
};
readonly sku?: string;
readonly thumbnail?: string;
readonly 'x-class-name'?: string;
};
export type Discount = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
active?: boolean;
amountFormatted?: string;
couponCode?: string;
customFields?: {
[key: string]: {
[key: string]: unknown;
};
};
discountAccountGroups?: Array<DiscountAccountGroup>;
discountAccounts?: Array<DiscountAccount>;
discountCategories?: Array<DiscountCategory>;
discountChannels?: Array<DiscountChannel>;
discountOrderTypes?: Array<DiscountOrderType>;
discountProductGroups?: Array<DiscountProductGroup>;
discountProducts?: Array<DiscountProduct>;
discountRules?: Array<DiscountRule>;
displayDate?: string;
expirationDate?: string;
externalReferenceCode?: string;
id?: number;
level: string;
limitationTimes?: number;
limitationTimesPerAccount?: number;
limitationType: string;
maximumDiscountAmount?: number;
readonly modifiedDate?: string;
neverExpire?: boolean;
numberOfUse?: number;
percentageLevel1?: number;
percentageLevel2?: number;
percentageLevel3?: number;
percentageLevel4?: number;
rulesConjunction?: boolean;
target: string;
title: string;
useCouponCode?: boolean;
usePercentage: boolean;
readonly 'x-class-name'?: string;
};
export type DiscountRule = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
readonly discountId?: number;
readonly id?: number;
name?: string;
type: string;
typeSettings?: string;
readonly 'x-class-name'?: string;
};
export type PageDiscount = {
items?: Array<Discount>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageDiscountRule = {
items?: Array<DiscountRule>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type DiscountSku = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
discountExternalReferenceCode?: string;
readonly discountId?: number;
readonly discountSkuId?: number;
productId?: number;
productName?: {
[key: string]: string;
};
sku?: Sku;
skuExternalReferenceCode?: string;
skuId: number;
unitOfMeasureKey?: string;
readonly 'x-class-name'?: string;
};
export type PageDiscountSku = {
items?: Array<DiscountSku>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type Sku = {
basePrice?: number;
basePriceFormatted?: string;
basePromoPrice?: number;
basePromoPriceFormatted?: string;
readonly id?: number;
readonly name?: string;
readonly 'x-class-name'?: string;
};
export type PriceEntry = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
active?: boolean;
bulkPricing?: boolean;
customFields?: {
[key: string]: {
[key: string]: unknown;
};
};
discountDiscovery?: boolean;
discountLevel1?: number;
discountLevel2?: number;
discountLevel3?: number;
discountLevel4?: number;
discountLevelsFormatted?: string;
displayDate?: string;
expirationDate?: string;
externalReferenceCode?: string;
hasTierPrice?: boolean;
neverExpire?: boolean;
price: number;
priceEntryId?: number;
priceFormatted?: string;
priceListExternalReferenceCode?: string;
priceListId: number;
priceOnApplication?: boolean;
product?: Product;
quantity?: number;
sku?: Sku;
skuExternalReferenceCode?: string;
skuId: number;
tierPrices?: Array<TierPrice>;
unitOfMeasureKey?: string;
readonly 'x-class-name'?: string;
};
export type TierPrice = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
active?: boolean;
customFields?: {
[key: string]: {
[key: string]: unknown;
};
};
discountDiscovery?: boolean;
discountLevel1?: number;
discountLevel2?: number;
discountLevel3?: number;
discountLevel4?: number;
displayDate?: string;
expirationDate?: string;
externalReferenceCode?: string;
id?: number;
minimumQuantity: number;
neverExpire?: boolean;
price: number;
priceEntryExternalReferenceCode?: string;
priceEntryId: number;
priceFormatted?: string;
unitOfMeasureKey?: string;
readonly 'x-class-name'?: string;
};
export type PagePriceEntry = {
items?: Array<PriceEntry>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PagePriceListAccountGroup = {
items?: Array<PriceListAccountGroup>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PriceListAccountGroup = {
accountGroup?: PricingAccountGroup;
accountGroupExternalReferenceCode?: string;
accountGroupId: number;
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
order?: number;
readonly priceListAccountGroupId?: number;
priceListExternalReferenceCode?: string;
priceListId: number;
readonly 'x-class-name'?: string;
};
export type PagePriceListAccount = {
items?: Array<PriceListAccount>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PriceListAccount = {
account?: Account;
accountExternalReferenceCode?: string;
accountId: number;
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
order?: number;
readonly priceListAccountId?: number;
priceListExternalReferenceCode?: string;
priceListId: number;
readonly 'x-class-name'?: string;
};
export type PagePriceListChannel = {
items?: Array<PriceListChannel>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PriceListChannel = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
channel?: Channel;
channelExternalReferenceCode?: string;
channelId: number;
order?: number;
readonly priceListChannelId?: number;
priceListExternalReferenceCode?: string;
priceListId: number;
readonly 'x-class-name'?: string;
};
export type PagePriceListDiscount = {
items?: Array<PriceListDiscount>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PriceListDiscount = {
discountExternalReferenceCode?: string;
discountId: number;
readonly discountName?: string;
order?: number;
readonly priceListDiscountId?: number;
priceListExternalReferenceCode?: string;
priceListId: number;
readonly 'x-class-name'?: string;
};
export type PagePriceListOrderType = {
items?: Array<PriceListOrderType>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PriceListOrderType = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
orderType?: OrderType;
orderTypeExternalReferenceCode?: string;
orderTypeId: number;
priceListExternalReferenceCode?: string;
priceListId: number;
readonly priceListOrderTypeId?: number;
priority?: number;
readonly 'x-class-name'?: string;
};
export type PriceList = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
active?: boolean;
author?: string;
catalogBasePriceList?: boolean;
catalogId: number;
catalogName?: string;
createDate?: string;
currencyCode: string;
currencyExternalReferenceCode?: string;
currencyId?: number;
customFields?: {
[key: string]: {
[key: string]: unknown;
};
};
displayDate?: string;
expirationDate?: string;
externalReferenceCode?: string;
id?: number;
name: string;
netPrice?: boolean;
neverExpire?: boolean;
parentPriceListId?: number;
priceEntries?: Array<PriceEntry>;
priceListAccountGroups?: Array<PriceListAccountGroup>;
priceListAccounts?: Array<PriceListAccount>;
priceListChannels?: Array<PriceListChannel>;
priceListDiscounts?: Array<PriceListDiscount>;
priceListOrderTypes?: Array<PriceListOrderType>;
priceModifiers?: Array<PriceModifier>;
priority?: number;
workflowStatusInfo?: Status;
readonly 'x-class-name'?: string;
type: 'price-list' | 'promotion' | 'contract';
};
export type PriceModifier = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
active?: boolean;
displayDate?: string;
expirationDate?: string;
externalReferenceCode?: string;
id?: number;
modifierAmount: number;
modifierType: string;
neverExpire?: boolean;
priceListExternalReferenceCode?: string;
priceListId?: number;
priceModifierCategories?: Array<PriceModifierCategory>;
priceModifierProductGroups?: Array<PriceModifierProductGroup>;
priceModifierProducts?: Array<PriceModifierProduct>;
priority?: number;
target: string;
title: string;
readonly 'x-class-name'?: string;
};
export type PriceModifierCategory = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
category?: Category;
categoryExternalReferenceCode?: string;
categoryId: number;
readonly priceModifierCategoryId?: number;
priceModifierExternalReferenceCode?: string;
priceModifierId: number;
readonly 'x-class-name'?: string;
};
export type PriceModifierProduct = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
priceModifierExternalReferenceCode?: string;
priceModifierId: number;
readonly priceModifierProductId?: number;
product?: Product;
productExternalReferenceCode?: string;
productId: number;
readonly 'x-class-name'?: string;
};
export type PriceModifierProductGroup = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
priceModifierExternalReferenceCode?: string;
priceModifierId: number;
readonly priceModifierProductGroupId?: number;
productGroup?: ProductGroup;
productGroupExternalReferenceCode?: string;
productGroupId: number;
readonly 'x-class-name'?: string;
};
export type Status = {
readonly code?: number;
label?: string;
label_i18n?: string;
readonly 'x-class-name'?: string;
};
export type PagePriceList = {
items?: Array<PriceList>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PagePriceModifierCategory = {
items?: Array<PriceModifierCategory>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PagePriceModifierProductGroup = {
items?: Array<PriceModifierProductGroup>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PagePriceModifierProduct = {
items?: Array<PriceModifierProduct>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PagePriceModifier = {
items?: Array<PriceModifier>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageTierPrice = {
items?: Array<TierPrice>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type GetDiscountAccountAccountData = {
body?: never;
path: {
discountAccountId: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discount-accounts/{discountAccountId}/account';
};
export type GetDiscountAccountAccountResponses = {
/**
* default response
*/
default: Account;
};
export type GetDiscountAccountAccountResponse = GetDiscountAccountAccountResponses[keyof GetDiscountAccountAccountResponses];
export type GetPriceListAccountAccountData = {
body?: never;
path: {
priceListAccountId: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/price-list-accounts/{priceListAccountId}/account';
};
export type GetPriceListAccountAccountResponses = {
/**
* default response
*/
default: Account;
};
export type GetPriceListAccountAccountResponse = GetPriceListAccountAccountResponses[keyof GetPriceListAccountAccountResponses];
export type GetDiscountCategoryCategoryData = {
body?: never;
path: {
discountCategoryId: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discount-categories/{discountCategoryId}/category';
};
export type GetDiscountCategoryCategoryResponses = {
/**
* default response
*/
default: Category;
};
export type GetDiscountCategoryCategoryResponse = GetDiscountCategoryCategoryResponses[keyof GetDiscountCategoryCategoryResponses];
export type GetPriceModifierCategoryCategoryData = {
body?: never;
path: {
priceModifierCategoryId: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/price-modifier-categories/{priceModifierCategoryId}/category';
};
export type GetPriceModifierCategoryCategoryResponses = {
/**
* default response
*/
default: Category;
};
export type GetPriceModifierCategoryCategoryResponse = GetPriceModifierCategoryCategoryResponses[keyof GetPriceModifierCategoryCategoryResponses];
export type GetDiscountChannelChannelData = {
body?: never;
path: {
discountChannelId: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discount-channels/{discountChannelId}/channel';
};
export type GetDiscountChannelChannelResponses = {
/**
* default response
*/
default: Channel;
};
export type GetDiscountChannelChannelResponse = GetDiscountChannelChannelResponses[keyof GetDiscountChannelChannelResponses];
export type GetPriceListChannelChannelData = {
body?: never;
path: {
priceListChannelId: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/price-list-channels/{priceListChannelId}/channel';
};
export type GetPriceListChannelChannelResponses = {
/**
* default response
*/
default: Channel;
};
export type GetPriceListChannelChannelResponse = GetPriceListChannelChannelResponses[keyof GetPriceListChannelChannelResponses];
export type DeleteDiscountAccountGroupData = {
body?: never;
path: {
discountAccountGroupId: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discount-account-groups/{discountAccountGroupId}';
};
export type DeleteDiscountAccountGroupResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteDiscountAccountGroupBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discount-account-groups/batch';
};
export type DeleteDiscountAccountGroupBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetDiscountByExternalReferenceCodeDiscountAccountGroupsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/by-externalReferenceCode/{externalReferenceCode}/discount-account-groups';
};
export type GetDiscountByExternalReferenceCodeDiscountAccountGroupsPageResponses = {
/**
* default response
*/
default: PageDiscountAccountGroup;
};
export type GetDiscountByExternalReferenceCodeDiscountAccountGroupsPageResponse = GetDiscountByExternalReferenceCodeDiscountAccountGroupsPageResponses[keyof GetDiscountByExternalReferenceCodeDiscountAccountGroupsPageResponses];
export type PostDiscountByExternalReferenceCodeDiscountAccountGroupData = {
body?: DiscountAccountGroup;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/by-externalReferenceCode/{externalReferenceCode}/discount-account-groups';
};
export type PostDiscountByExternalReferenceCodeDiscountAccountGroupResponses = {
/**
* default response
*/
default: DiscountAccountGroup;
};
export type PostDiscountByExternalReferenceCodeDiscountAccountGroupResponse = PostDiscountByExternalReferenceCodeDiscountAccountGroupResponses[keyof PostDiscountByExternalReferenceCodeDiscountAccountGroupResponses];
export type GetDiscountIdDiscountAccountGroupsPageData = {
body?: never;
path: {
id: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/{id}/discount-account-groups';
};
export type GetDiscountIdDiscountAccountGroupsPageResponses = {
/**
* default response
*/
default: PageDiscountAccountGroup;
};
export type GetDiscountIdDiscountAccountGroupsPageResponse = GetDiscountIdDiscountAccountGroupsPageResponses[keyof GetDiscountIdDiscountAccountGroupsPageResponses];
export type PostDiscountIdDiscountAccountGroupData = {
body?: DiscountAccountGroup;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/{id}/discount-account-groups';
};
export type PostDiscountIdDiscountAccountGroupResponses = {
/**
* default response
*/
default: DiscountAccountGroup;
};
export type PostDiscountIdDiscountAccountGroupResponse = PostDiscountIdDiscountAccountGroupResponses[keyof PostDiscountIdDiscountAccountGroupResponses];
export type PostDiscountIdDiscountAccountGroupBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/discount-account-groups/batch';
};
export type PostDiscountIdDiscountAccountGroupBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteDiscountAccountData = {
body?: never;
path: {
discountAccountId: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discount-accounts/{discountAccountId}';
};
export type DeleteDiscountAccountResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteDiscountAccountBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discount-accounts/batch';
};
export type DeleteDiscountAccountBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetDiscountByExternalReferenceCodeDiscountAccountsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/by-externalReferenceCode/{externalReferenceCode}/discount-accounts';
};
export type GetDiscountByExternalReferenceCodeDiscountAccountsPageResponses = {
/**
* default response
*/
default: PageDiscountAccount;
};
export type GetDiscountByExternalReferenceCodeDiscountAccountsPageResponse = GetDiscountByExternalReferenceCodeDiscountAccountsPageResponses[keyof GetDiscountByExternalReferenceCodeDiscountAccountsPageResponses];
export type PostDiscountByExternalReferenceCodeDiscountAccountData = {
body?: DiscountAccount;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/by-externalReferenceCode/{externalReferenceCode}/discount-accounts';
};
export type PostDiscountByExternalReferenceCodeDiscountAccountResponses = {
/**
* default response
*/
default: DiscountAccount;
};
export type PostDiscountByExternalReferenceCodeDiscountAccountResponse = PostDiscountByExternalReferenceCodeDiscountAccountResponses[keyof PostDiscountByExternalReferenceCodeDiscountAccountResponses];
export type GetDiscountIdDiscountAccountsPageData = {
body?: never;
path: {
id: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/{id}/discount-accounts';
};
export type GetDiscountIdDiscountAccountsPageResponses = {
/**
* default response
*/
default: PageDiscountAccount;
};
export type GetDiscountIdDiscountAccountsPageResponse = GetDiscountIdDiscountAccountsPageResponses[keyof GetDiscountIdDiscountAccountsPageResponses];
export type PostDiscountIdDiscountAccountData = {
body?: DiscountAccount;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/{id}/discount-accounts';
};
export type PostDiscountIdDiscountAccountResponses = {
/**
* default response
*/
default: DiscountAccount;
};
export type PostDiscountIdDiscountAccountResponse = PostDiscountIdDiscountAccountResponses[keyof PostDiscountIdDiscountAccountResponses];
export type PostDiscountIdDiscountAccountBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/discount-accounts/batch';
};
export type PostDiscountIdDiscountAccountBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteDiscountCategoryData = {
body?: never;
path: {
discountCategoryId: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discount-categories/{discountCategoryId}';
};
export type DeleteDiscountCategoryResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteDiscountCategoryBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discount-categories/batch';
};
export type DeleteDiscountCategoryBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetDiscountByExternalReferenceCodeDiscountCategoriesPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/by-externalReferenceCode/{externalReferenceCode}/discount-categories';
};
export type GetDiscountByExternalReferenceCodeDiscountCategoriesPageResponses = {
/**
* default response
*/
default: PageDiscountCategory;
};
export type GetDiscountByExternalReferenceCodeDiscountCategoriesPageResponse = GetDiscountByExternalReferenceCodeDiscountCategoriesPageResponses[keyof GetDiscountByExternalReferenceCodeDiscountCategoriesPageResponses];
export type PostDiscountByExternalReferenceCodeDiscountCategoryData = {
body?: DiscountCategory;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/by-externalReferenceCode/{externalReferenceCode}/discount-categories';
};
export type PostDiscountByExternalReferenceCodeDiscountCategoryResponses = {
/**
* default response
*/
default: DiscountCategory;
};
export type PostDiscountByExternalReferenceCodeDiscountCategoryResponse = PostDiscountByExternalReferenceCodeDiscountCategoryResponses[keyof PostDiscountByExternalReferenceCodeDiscountCategoryResponses];
export type GetDiscountIdDiscountCategoriesPageData = {
body?: never;
path: {
id: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/{id}/discount-categories';
};
export type GetDiscountIdDiscountCategoriesPageResponses = {
/**
* default response
*/
default: PageDiscountCategory;
};
export type GetDiscountIdDiscountCategoriesPageResponse = GetDiscountIdDiscountCategoriesPageResponses[keyof GetDiscountIdDiscountCategoriesPageResponses];
export type PostDiscountIdDiscountCategoryData = {
body?: DiscountCategory;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/{id}/discount-categories';
};
export type PostDiscountIdDiscountCategoryResponses = {
/**
* default response
*/
default: DiscountCategory;
};
export type PostDiscountIdDiscountCategoryResponse = PostDiscountIdDiscountCategoryResponses[keyof PostDiscountIdDiscountCategoryResponses];
export type PostDiscountIdDiscountCategoryBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/discount-categories/batch';
};
export type PostDiscountIdDiscountCategoryBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteDiscountChannelData = {
body?: never;
path: {
discountChannelId: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discount-channels/{discountChannelId}';
};
export type DeleteDiscountChannelResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteDiscountChannelBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discount-channels/batch';
};
export type DeleteDiscountChannelBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetDiscountByExternalReferenceCodeDiscountChannelsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/by-externalReferenceCode/{externalReferenceCode}/discount-channels';
};
export type GetDiscountByExternalReferenceCodeDiscountChannelsPageResponses = {
/**
* default response
*/
default: PageDiscountChannel;
};
export type GetDiscountByExternalReferenceCodeDiscountChannelsPageResponse = GetDiscountByExternalReferenceCodeDiscountChannelsPageResponses[keyof GetDiscountByExternalReferenceCodeDiscountChannelsPageResponses];
export type PostDiscountByExternalReferenceCodeDiscountChannelData = {
body?: DiscountChannel;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/by-externalReferenceCode/{externalReferenceCode}/discount-channels';
};
export type PostDiscountByExternalReferenceCodeDiscountChannelResponses = {
/**
* default response
*/
default: DiscountChannel;
};
export type PostDiscountByExternalReferenceCodeDiscountChannelResponse = PostDiscountByExternalReferenceCodeDiscountChannelResponses[keyof PostDiscountByExternalReferenceCodeDiscountChannelResponses];
export type GetDiscountIdDiscountChannelsPageData = {
body?: never;
path: {
id: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/{id}/discount-channels';
};
export type GetDiscountIdDiscountChannelsPageResponses = {
/**
* default response
*/
default: PageDiscountChannel;
};
export type GetDiscountIdDiscountChannelsPageResponse = GetDiscountIdDiscountChannelsPageResponses[keyof GetDiscountIdDiscountChannelsPageResponses];
export type PostDiscountIdDiscountChannelData = {
body?: DiscountChannel;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/{id}/discount-channels';
};
export type PostDiscountIdDiscountChannelResponses = {
/**
* default response
*/
default: DiscountChannel;
};
export type PostDiscountIdDiscountChannelResponse = PostDiscountIdDiscountChannelResponses[keyof PostDiscountIdDiscountChannelResponses];
export type PostDiscountIdDiscountChannelBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/discount-channels/batch';
};
export type PostDiscountIdDiscountChannelBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteDiscountOrderTypeData = {
body?: never;
path: {
discountOrderTypeId: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discount-order-types/{discountOrderTypeId}';
};
export type DeleteDiscountOrderTypeResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteDiscountOrderTypeBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discount-order-types/batch';
};
export type DeleteDiscountOrderTypeBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetDiscountByExternalReferenceCodeDiscountOrderTypesPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/by-externalReferenceCode/{externalReferenceCode}/discount-order-types';
};
export type GetDiscountByExternalReferenceCodeDiscountOrderTypesPageResponses = {
/**
* default response
*/
default: PageDiscountOrderType;
};
export type GetDiscountByExternalReferenceCodeDiscountOrderTypesPageResponse = GetDiscountByExternalReferenceCodeDiscountOrderTypesPageResponses[keyof GetDiscountByExternalReferenceCodeDiscountOrderTypesPageResponses];
export type PostDiscountByExternalReferenceCodeDiscountOrderTypeData = {
body?: DiscountOrderType;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/by-externalReferenceCode/{externalReferenceCode}/discount-order-types';
};
export type PostDiscountByExternalReferenceCodeDiscountOrderTypeResponses = {
/**
* default response
*/
default: DiscountOrderType;
};
export type PostDiscountByExternalReferenceCodeDiscountOrderTypeResponse = PostDiscountByExternalReferenceCodeDiscountOrderTypeResponses[keyof PostDiscountByExternalReferenceCodeDiscountOrderTypeResponses];
export type GetDiscountIdDiscountOrderTypesPageData = {
body?: never;
path: {
id: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/{id}/discount-order-types';
};
export type GetDiscountIdDiscountOrderTypesPageResponses = {
/**
* default response
*/
default: PageDiscountOrderType;
};
export type GetDiscountIdDiscountOrderTypesPageResponse = GetDiscountIdDiscountOrderTypesPageResponses[keyof GetDiscountIdDiscountOrderTypesPageResponses];
export type PostDiscountIdDiscountOrderTypeData = {
body?: DiscountOrderType;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/{id}/discount-order-types';
};
export type PostDiscountIdDiscountOrderTypeResponses = {
/**
* default response
*/
default: DiscountOrderType;
};
export type PostDiscountIdDiscountOrderTypeResponse = PostDiscountIdDiscountOrderTypeResponses[keyof PostDiscountIdDiscountOrderTypeResponses];
export type PostDiscountIdDiscountOrderTypeBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/discount-order-types/batch';
};
export type PostDiscountIdDiscountOrderTypeBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteDiscountProductGroupData = {
body?: never;
path: {
discountProductGroupId: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discount-product-groups/{discountProductGroupId}';
};
export type DeleteDiscountProductGroupResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteDiscountProductGroupBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discount-product-groups/batch';
};
export type DeleteDiscountProductGroupBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetDiscountByExternalReferenceCodeDiscountProductGroupsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/by-externalReferenceCode/{externalReferenceCode}/discount-product-groups';
};
export type GetDiscountByExternalReferenceCodeDiscountProductGroupsPageResponses = {
/**
* default response
*/
default: PageDiscountProductGroup;
};
export type GetDiscountByExternalReferenceCodeDiscountProductGroupsPageResponse = GetDiscountByExternalReferenceCodeDiscountProductGroupsPageResponses[keyof GetDiscountByExternalReferenceCodeDiscountProductGroupsPageResponses];
export type PostDiscountByExternalReferenceCodeDiscountProductGroupData = {
body?: DiscountProductGroup;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/by-externalReferenceCode/{externalReferenceCode}/discount-product-groups';
};
export type PostDiscountByExternalReferenceCodeDiscountProductGroupResponses = {
/**
* default response
*/
default: DiscountProductGroup;
};
export type PostDiscountByExternalReferenceCodeDiscountProductGroupResponse = PostDiscountByExternalReferenceCodeDiscountProductGroupResponses[keyof PostDiscountByExternalReferenceCodeDiscountProductGroupResponses];
export type GetDiscountIdDiscountProductGroupsPageData = {
body?: never;
path: {
id: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/{id}/discount-product-groups';
};
export type GetDiscountIdDiscountProductGroupsPageResponses = {
/**
* default response
*/
default: PageDiscountProductGroup;
};
export type GetDiscountIdDiscountProductGroupsPageResponse = GetDiscountIdDiscountProductGroupsPageResponses[keyof GetDiscountIdDiscountProductGroupsPageResponses];
export type PostDiscountIdDiscountProductGroupData = {
body?: DiscountProductGroup;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/{id}/discount-product-groups';
};
export type PostDiscountIdDiscountProductGroupResponses = {
/**
* default response
*/
default: DiscountProductGroup;
};
export type PostDiscountIdDiscountProductGroupResponse = PostDiscountIdDiscountProductGroupResponses[keyof PostDiscountIdDiscountProductGroupResponses];
export type PostDiscountIdDiscountProductGroupBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/discount-product-groups/batch';
};
export type PostDiscountIdDiscountProductGroupBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteDiscountProductData = {
body?: never;
path: {
discountProductId: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discount-products/{discountProductId}';
};
export type DeleteDiscountProductResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteDiscountProductBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discount-products/batch';
};
export type DeleteDiscountProductBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetDiscountByExternalReferenceCodeDiscountProductsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/by-externalReferenceCode/{externalReferenceCode}/discount-products';
};
export type GetDiscountByExternalReferenceCodeDiscountProductsPageResponses = {
/**
* default response
*/
default: PageDiscountProduct;
};
export type GetDiscountByExternalReferenceCodeDiscountProductsPageResponse = GetDiscountByExternalReferenceCodeDiscountProductsPageResponses[keyof GetDiscountByExternalReferenceCodeDiscountProductsPageResponses];
export type PostDiscountByExternalReferenceCodeDiscountProductData = {
body?: DiscountProduct;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/by-externalReferenceCode/{externalReferenceCode}/discount-products';
};
export type PostDiscountByExternalReferenceCodeDiscountProductResponses = {
/**
* default response
*/
default: DiscountProduct;
};
export type PostDiscountByExternalReferenceCodeDiscountProductResponse = PostDiscountByExternalReferenceCodeDiscountProductResponses[keyof PostDiscountByExternalReferenceCodeDiscountProductResponses];
export type GetDiscountIdDiscountProductsPageData = {
body?: never;
path: {
id: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/{id}/discount-products';
};
export type GetDiscountIdDiscountProductsPageResponses = {
/**
* default response
*/
default: PageDiscountProduct;
};
export type GetDiscountIdDiscountProductsPageResponse = GetDiscountIdDiscountProductsPageResponses[keyof GetDiscountIdDiscountProductsPageResponses];
export type PostDiscountIdDiscountProductData = {
body?: DiscountProduct;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/{id}/discount-products';
};
export type PostDiscountIdDiscountProductResponses = {
/**
* default response
*/
default: DiscountProduct;
};
export type PostDiscountIdDiscountProductResponse = PostDiscountIdDiscountProductResponses[keyof PostDiscountIdDiscountProductResponses];
export type PostDiscountIdDiscountProductBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/discount-products/batch';
};
export type PostDiscountIdDiscountProductBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteDiscountData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/{id}';
};
export type DeleteDiscountResponses = {
/**
* default response
*/
default: unknown;
};
export type GetDiscountData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/{id}';
};
export type GetDiscountResponses = {
/**
* default response
*/
default: Discount;
};
export type GetDiscountResponse = GetDiscountResponses[keyof GetDiscountResponses];
export type PatchDiscountData = {
body?: Discount;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-pricing/v2.0/discounts/{id}';
};
export type PatchDiscountResponses = {
/**
* default response
*/
default: Discount;
};
export type PatchDiscountResponse = PatchDiscountResponses[keyof PatchDiscountResponses];
export type DeleteDiscountBatchData = {
body?: {
[key: string]: unknown;
};