liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
1,670 lines • 51.4 kB
TypeScript
export type AccountAddressChannel = {
readonly accountAddressChannelId?: number;
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
addressChannelExternalReferenceCode?: string;
addressChannelId: number;
addressExternalReferenceCode?: string;
addressId: number;
channel?: Channel;
readonly 'x-class-name'?: string;
};
export type Channel = {
accountExternalReferenceCode?: string;
accountId?: number;
currencyCode: string;
currencyExternalReferenceCode?: string;
currencyId?: number;
externalReferenceCode?: string;
id?: number;
name: string;
siteGroupId?: number;
type: string;
readonly 'x-class-name'?: string;
};
export type Facet = {
facetCriteria?: string;
facetValues?: Array<FacetValue>;
};
export type FacetValue = {
numberOfOccurrences?: number;
term?: string;
};
export type PageAccountAddressChannel = {
items?: Array<AccountAddressChannel>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type Account = {
id?: number;
name?: string;
readonly 'x-class-name'?: string;
};
export type CategoryDisplayPage = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
categoryExternalReferenceCode?: string;
categoryId?: number;
groupExternalReferenceCode?: string;
readonly id?: number;
pageUuid?: string;
readonly 'x-class-name'?: string;
};
export type PageCategoryDisplayPage = {
items?: Array<CategoryDisplayPage>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type ChannelAccount = {
account?: Account;
accountExternalReferenceCode?: string;
accountId: number;
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
readonly channelAccountId?: number;
channelExternalReferenceCode?: string;
channelId: number;
readonly 'x-class-name'?: string;
};
export type PageChannelAccount = {
items?: Array<ChannelAccount>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageChannel = {
items?: Array<Channel>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type DefaultCategoryDisplayPage = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
pageUuid?: string;
readonly 'x-class-name'?: string;
};
export type DefaultProductDisplayPage = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
pageUuid?: string;
readonly 'x-class-name'?: string;
};
export type OrderType = {
readonly id?: number;
name?: {
[key: string]: string;
};
readonly 'x-class-name'?: string;
};
export type PagePaymentMethodGroupRelOrderType = {
items?: Array<PaymentMethodGroupRelOrderType>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PaymentMethodGroupRelOrderType = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
orderType?: OrderType;
orderTypeExternalReferenceCode?: string;
orderTypeId: number;
paymentMethodGroupRelId: number;
readonly paymentMethodGroupRelOrderTypeId?: number;
priority?: number;
readonly 'x-class-name'?: string;
};
export type PagePaymentMethodGroupRelTerm = {
items?: Array<PaymentMethodGroupRelTerm>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PaymentMethodGroupRelTerm = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
paymentMethodGroupRelId: number;
readonly paymentMethodGroupRelTermId?: number;
term?: Term;
termExternalReferenceCode?: string;
termId: number;
readonly 'x-class-name'?: string;
};
export type Term = {
readonly id?: number;
readonly name?: string;
readonly 'x-class-name'?: string;
};
export type PageProductDisplayPage = {
items?: Array<ProductDisplayPage>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type ProductDisplayPage = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
readonly id?: number;
pageTemplateUuid?: string;
pageUuid?: string;
productExternalReferenceCode?: string;
productId?: number;
readonly 'x-class-name'?: string;
};
export type PageShippingFixedOptionOrderType = {
items?: Array<ShippingFixedOptionOrderType>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type ShippingFixedOptionOrderType = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
orderType?: OrderType;
orderTypeExternalReferenceCode?: string;
orderTypeId: number;
priority?: number;
shippingFixedOptionId: number;
readonly shippingFixedOptionOrderTypeId?: number;
readonly 'x-class-name'?: string;
};
export type PageShippingFixedOptionTerm = {
items?: Array<ShippingFixedOptionTerm>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type ShippingFixedOptionTerm = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
shippingFixedOptionId: number;
readonly shippingFixedOptionTermId?: number;
term?: Term;
termExternalReferenceCode?: string;
termId: number;
readonly 'x-class-name'?: string;
};
export type PageShippingMethod = {
items?: Array<ShippingMethod>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type ShippingMethod = {
active?: boolean;
description?: {
[key: string]: string;
};
engineKey?: string;
id?: number;
name?: {
[key: string]: string;
};
priority?: number;
shippingOptions?: Array<ShippingOption>;
readonly 'x-class-name'?: string;
};
export type ShippingOption = {
active?: boolean;
amount?: number;
description?: {
[key: string]: string;
};
id?: number;
name?: {
[key: string]: string;
};
priority?: number;
readonly 'x-class-name'?: string;
};
export type PageTaxCategory = {
items?: Array<TaxCategory>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type TaxCategory = {
description?: {
[key: string]: string;
};
readonly groupId?: number;
id?: number;
name: {
[key: string]: string;
};
readonly 'x-class-name'?: string;
};
export type DeleteAccountAddressChannelData = {
body?: never;
path: {
accountAddressChannelId: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/account-address-channels/{accountAddressChannelId}';
};
export type DeleteAccountAddressChannelResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteAccountAddressChannelBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/account-address-channels/batch';
};
export type DeleteAccountAddressChannelBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountAddressByExternalReferenceCodeAccountAddressChannelsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/account-addresses/by-externalReferenceCode/{externalReferenceCode}/account-address-channels';
};
export type GetAccountAddressByExternalReferenceCodeAccountAddressChannelsPageResponses = {
/**
* default response
*/
default: PageAccountAddressChannel;
};
export type GetAccountAddressByExternalReferenceCodeAccountAddressChannelsPageResponse = GetAccountAddressByExternalReferenceCodeAccountAddressChannelsPageResponses[keyof GetAccountAddressByExternalReferenceCodeAccountAddressChannelsPageResponses];
export type PostAccountAddressByExternalReferenceCodeAccountAddressChannelData = {
body?: AccountAddressChannel;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/account-addresses/by-externalReferenceCode/{externalReferenceCode}/account-address-channels';
};
export type PostAccountAddressByExternalReferenceCodeAccountAddressChannelResponses = {
/**
* default response
*/
default: AccountAddressChannel;
};
export type PostAccountAddressByExternalReferenceCodeAccountAddressChannelResponse = PostAccountAddressByExternalReferenceCodeAccountAddressChannelResponses[keyof PostAccountAddressByExternalReferenceCodeAccountAddressChannelResponses];
export type GetAccountAddressIdAccountAddressChannelsPageData = {
body?: never;
path: {
addressId: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/account-addresses/{addressId}/account-address-channels';
};
export type GetAccountAddressIdAccountAddressChannelsPageResponses = {
/**
* default response
*/
default: PageAccountAddressChannel;
};
export type GetAccountAddressIdAccountAddressChannelsPageResponse = GetAccountAddressIdAccountAddressChannelsPageResponses[keyof GetAccountAddressIdAccountAddressChannelsPageResponses];
export type PostAccountAddressIdAccountAddressChannelData = {
body?: AccountAddressChannel;
path: {
addressId: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/account-addresses/{addressId}/account-address-channels';
};
export type PostAccountAddressIdAccountAddressChannelResponses = {
/**
* default response
*/
default: AccountAddressChannel;
};
export type PostAccountAddressIdAccountAddressChannelResponse = PostAccountAddressIdAccountAddressChannelResponses[keyof PostAccountAddressIdAccountAddressChannelResponses];
export type GetChannelAccountAccountData = {
body?: never;
path: {
channelAccountId: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channel-accounts/{channelAccountId}/account';
};
export type GetChannelAccountAccountResponses = {
/**
* default response
*/
default: Account;
};
export type GetChannelAccountAccountResponse = GetChannelAccountAccountResponses[keyof GetChannelAccountAccountResponses];
export type DeleteCategoryDisplayPageData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/category-display-pages/{id}';
};
export type DeleteCategoryDisplayPageResponses = {
/**
* default response
*/
default: unknown;
};
export type GetCategoryDisplayPageData = {
body?: never;
path: {
id: string;
};
query?: {
nestedFields?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/category-display-pages/{id}';
};
export type GetCategoryDisplayPageResponses = {
/**
* default response
*/
default: CategoryDisplayPage;
};
export type GetCategoryDisplayPageResponse = GetCategoryDisplayPageResponses[keyof GetCategoryDisplayPageResponses];
export type PatchCategoryDisplayPageData = {
body?: CategoryDisplayPage;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/category-display-pages/{id}';
};
export type PatchCategoryDisplayPageResponses = {
/**
* default response
*/
default: CategoryDisplayPage;
};
export type PatchCategoryDisplayPageResponse = PatchCategoryDisplayPageResponses[keyof PatchCategoryDisplayPageResponses];
export type DeleteCategoryDisplayPageBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/category-display-pages/batch';
};
export type DeleteCategoryDisplayPageBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetChannelByExternalReferenceCodeCategoryDisplayPagesPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/channels/by-externalReferenceCode/{externalReferenceCode}/category-display-pages';
};
export type GetChannelByExternalReferenceCodeCategoryDisplayPagesPageResponses = {
/**
* default response
*/
default: PageCategoryDisplayPage;
};
export type GetChannelByExternalReferenceCodeCategoryDisplayPagesPageResponse = GetChannelByExternalReferenceCodeCategoryDisplayPagesPageResponses[keyof GetChannelByExternalReferenceCodeCategoryDisplayPagesPageResponses];
export type PostChannelByExternalReferenceCodeCategoryDisplayPageData = {
body?: CategoryDisplayPage;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channels/by-externalReferenceCode/{externalReferenceCode}/category-display-pages';
};
export type PostChannelByExternalReferenceCodeCategoryDisplayPageResponses = {
/**
* default response
*/
default: CategoryDisplayPage;
};
export type PostChannelByExternalReferenceCodeCategoryDisplayPageResponse = PostChannelByExternalReferenceCodeCategoryDisplayPageResponses[keyof PostChannelByExternalReferenceCodeCategoryDisplayPageResponses];
export type GetChannelIdCategoryDisplayPagesPageData = {
body?: never;
path: {
id: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/channels/{id}/category-display-pages';
};
export type GetChannelIdCategoryDisplayPagesPageResponses = {
/**
* default response
*/
default: PageCategoryDisplayPage;
};
export type GetChannelIdCategoryDisplayPagesPageResponse = GetChannelIdCategoryDisplayPagesPageResponses[keyof GetChannelIdCategoryDisplayPagesPageResponses];
export type PostChannelIdCategoryDisplayPageData = {
body?: CategoryDisplayPage;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channels/{id}/category-display-pages';
};
export type PostChannelIdCategoryDisplayPageResponses = {
/**
* default response
*/
default: CategoryDisplayPage;
};
export type PostChannelIdCategoryDisplayPageResponse = PostChannelIdCategoryDisplayPageResponses[keyof PostChannelIdCategoryDisplayPageResponses];
export type DeleteChannelAccountData = {
body?: never;
path: {
channelAccountId: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channel-accounts/{channelAccountId}';
};
export type DeleteChannelAccountResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteChannelAccountBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/channel-accounts/batch';
};
export type DeleteChannelAccountBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetChannelByExternalReferenceCodeChannelAccountsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/channels/by-externalReferenceCode/{externalReferenceCode}/channel-accounts';
};
export type GetChannelByExternalReferenceCodeChannelAccountsPageResponses = {
/**
* default response
*/
default: PageChannelAccount;
};
export type GetChannelByExternalReferenceCodeChannelAccountsPageResponse = GetChannelByExternalReferenceCodeChannelAccountsPageResponses[keyof GetChannelByExternalReferenceCodeChannelAccountsPageResponses];
export type PostChannelByExternalReferenceCodeChannelAccountData = {
body?: ChannelAccount;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channels/by-externalReferenceCode/{externalReferenceCode}/channel-accounts';
};
export type PostChannelByExternalReferenceCodeChannelAccountResponses = {
/**
* default response
*/
default: ChannelAccount;
};
export type PostChannelByExternalReferenceCodeChannelAccountResponse = PostChannelByExternalReferenceCodeChannelAccountResponses[keyof PostChannelByExternalReferenceCodeChannelAccountResponses];
export type GetChannelIdChannelAccountsPageData = {
body?: never;
path: {
id: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/channels/{id}/channel-accounts';
};
export type GetChannelIdChannelAccountsPageResponses = {
/**
* default response
*/
default: PageChannelAccount;
};
export type GetChannelIdChannelAccountsPageResponse = GetChannelIdChannelAccountsPageResponses[keyof GetChannelIdChannelAccountsPageResponses];
export type PostChannelIdChannelAccountData = {
body?: ChannelAccount;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channels/{id}/channel-accounts';
};
export type PostChannelIdChannelAccountResponses = {
/**
* default response
*/
default: ChannelAccount;
};
export type PostChannelIdChannelAccountResponse = PostChannelIdChannelAccountResponses[keyof PostChannelIdChannelAccountResponses];
export type DeleteChannelData = {
body?: never;
path: {
channelId: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channels/{channelId}';
};
export type DeleteChannelResponses = {
/**
* default response
*/
default: unknown;
};
export type GetChannelData = {
body?: never;
path: {
channelId: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channels/{channelId}';
};
export type GetChannelResponses = {
/**
* default response
*/
default: Channel;
};
export type GetChannelResponse = GetChannelResponses[keyof GetChannelResponses];
export type PatchChannelData = {
body?: Channel;
path: {
channelId: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channels/{channelId}';
};
export type PatchChannelResponses = {
/**
* default response
*/
default: Channel;
};
export type PatchChannelResponse = PatchChannelResponses[keyof PatchChannelResponses];
export type PutChannelData = {
body?: Channel;
path: {
channelId: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channels/{channelId}';
};
export type PutChannelResponses = {
/**
* default response
*/
default: Channel;
};
export type PutChannelResponse = PutChannelResponses[keyof PutChannelResponses];
export type DeleteChannelBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/channels/batch';
};
export type DeleteChannelBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostChannelBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/channels/batch';
};
export type PostChannelBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PutChannelBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/channels/batch';
};
export type PutChannelBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteChannelByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channels/by-externalReferenceCode/{externalReferenceCode}';
};
export type DeleteChannelByExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type GetChannelByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channels/by-externalReferenceCode/{externalReferenceCode}';
};
export type GetChannelByExternalReferenceCodeResponses = {
/**
* default response
*/
default: Channel;
};
export type GetChannelByExternalReferenceCodeResponse = GetChannelByExternalReferenceCodeResponses[keyof GetChannelByExternalReferenceCodeResponses];
export type PatchChannelByExternalReferenceCodeData = {
body?: Channel;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channels/by-externalReferenceCode/{externalReferenceCode}';
};
export type PatchChannelByExternalReferenceCodeResponses = {
/**
* default response
*/
default: Channel;
};
export type PatchChannelByExternalReferenceCodeResponse = PatchChannelByExternalReferenceCodeResponses[keyof PatchChannelByExternalReferenceCodeResponses];
export type PutChannelByExternalReferenceCodeData = {
body?: Channel;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channels/by-externalReferenceCode/{externalReferenceCode}';
};
export type PutChannelByExternalReferenceCodeResponses = {
/**
* default response
*/
default: Channel;
};
export type PutChannelByExternalReferenceCodeResponse = PutChannelByExternalReferenceCodeResponses[keyof PutChannelByExternalReferenceCodeResponses];
export type GetAccountAddressChannelChannelData = {
body?: never;
path: {
accountAddressChannelId: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/account-address-channels/{accountAddressChannelId}/channel';
};
export type GetAccountAddressChannelChannelResponses = {
/**
* default response
*/
default: Channel;
};
export type GetAccountAddressChannelChannelResponse = GetAccountAddressChannelChannelResponses[keyof GetAccountAddressChannelChannelResponses];
export type GetChannelsPageData = {
body?: never;
path?: never;
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/channels';
};
export type GetChannelsPageResponses = {
/**
* default response
*/
default: PageChannel;
};
export type GetChannelsPageResponse = GetChannelsPageResponses[keyof GetChannelsPageResponses];
export type PostChannelData = {
body?: Channel;
path?: never;
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channels';
};
export type PostChannelResponses = {
/**
* default response
*/
default: Channel;
};
export type PostChannelResponse = PostChannelResponses[keyof PostChannelResponses];
export type PostChannelsPageExportBatchData = {
body?: never;
path?: never;
query?: {
filter?: string;
search?: string;
sort?: string;
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/channels/export-batch';
};
export type PostChannelsPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteChannelByExternalReferenceCodeDefaultCategoryDisplayPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channels/by-externalReferenceCode/{externalReferenceCode}/default-category-display-pages';
};
export type DeleteChannelByExternalReferenceCodeDefaultCategoryDisplayPageResponses = {
/**
* default response
*/
default: unknown;
};
export type GetChannelByExternalReferenceCodeDefaultCategoryDisplayPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
nestedFields?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/channels/by-externalReferenceCode/{externalReferenceCode}/default-category-display-pages';
};
export type GetChannelByExternalReferenceCodeDefaultCategoryDisplayPageResponses = {
/**
* default response
*/
default: DefaultCategoryDisplayPage;
};
export type GetChannelByExternalReferenceCodeDefaultCategoryDisplayPageResponse = GetChannelByExternalReferenceCodeDefaultCategoryDisplayPageResponses[keyof GetChannelByExternalReferenceCodeDefaultCategoryDisplayPageResponses];
export type PostChannelByExternalReferenceCodeDefaultCategoryDisplayPageData = {
body?: DefaultCategoryDisplayPage;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channels/by-externalReferenceCode/{externalReferenceCode}/default-category-display-pages';
};
export type PostChannelByExternalReferenceCodeDefaultCategoryDisplayPageResponses = {
/**
* default response
*/
default: DefaultCategoryDisplayPage;
};
export type PostChannelByExternalReferenceCodeDefaultCategoryDisplayPageResponse = PostChannelByExternalReferenceCodeDefaultCategoryDisplayPageResponses[keyof PostChannelByExternalReferenceCodeDefaultCategoryDisplayPageResponses];
export type DeleteChannelIdDefaultCategoryDisplayPageData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channels/{id}/default-category-display-pages';
};
export type DeleteChannelIdDefaultCategoryDisplayPageResponses = {
/**
* default response
*/
default: unknown;
};
export type GetChannelIdDefaultCategoryDisplayPageData = {
body?: never;
path: {
id: string;
};
query?: {
nestedFields?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/channels/{id}/default-category-display-pages';
};
export type GetChannelIdDefaultCategoryDisplayPageResponses = {
/**
* default response
*/
default: DefaultCategoryDisplayPage;
};
export type GetChannelIdDefaultCategoryDisplayPageResponse = GetChannelIdDefaultCategoryDisplayPageResponses[keyof GetChannelIdDefaultCategoryDisplayPageResponses];
export type PostChannelIdDefaultCategoryDisplayPageData = {
body?: DefaultCategoryDisplayPage;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channels/{id}/default-category-display-pages';
};
export type PostChannelIdDefaultCategoryDisplayPageResponses = {
/**
* default response
*/
default: DefaultCategoryDisplayPage;
};
export type PostChannelIdDefaultCategoryDisplayPageResponse = PostChannelIdDefaultCategoryDisplayPageResponses[keyof PostChannelIdDefaultCategoryDisplayPageResponses];
export type DeleteChannelByExternalReferenceCodeDefaultProductDisplayPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channels/by-externalReferenceCode/{externalReferenceCode}/default-product-display-page';
};
export type DeleteChannelByExternalReferenceCodeDefaultProductDisplayPageResponses = {
/**
* default response
*/
default: unknown;
};
export type GetChannelByExternalReferenceCodeDefaultProductDisplayPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
nestedFields?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/channels/by-externalReferenceCode/{externalReferenceCode}/default-product-display-page';
};
export type GetChannelByExternalReferenceCodeDefaultProductDisplayPageResponses = {
/**
* default response
*/
default: DefaultProductDisplayPage;
};
export type GetChannelByExternalReferenceCodeDefaultProductDisplayPageResponse = GetChannelByExternalReferenceCodeDefaultProductDisplayPageResponses[keyof GetChannelByExternalReferenceCodeDefaultProductDisplayPageResponses];
export type PostChannelByExternalReferenceCodeDefaultProductDisplayPageData = {
body?: DefaultProductDisplayPage;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channels/by-externalReferenceCode/{externalReferenceCode}/default-product-display-page';
};
export type PostChannelByExternalReferenceCodeDefaultProductDisplayPageResponses = {
/**
* default response
*/
default: DefaultProductDisplayPage;
};
export type PostChannelByExternalReferenceCodeDefaultProductDisplayPageResponse = PostChannelByExternalReferenceCodeDefaultProductDisplayPageResponses[keyof PostChannelByExternalReferenceCodeDefaultProductDisplayPageResponses];
export type DeleteChannelIdDefaultProductDisplayPageData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channels/{id}/default-product-display-pages';
};
export type DeleteChannelIdDefaultProductDisplayPageResponses = {
/**
* default response
*/
default: unknown;
};
export type GetChannelIdDefaultProductDisplayPageData = {
body?: never;
path: {
id: string;
};
query?: {
nestedFields?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/channels/{id}/default-product-display-pages';
};
export type GetChannelIdDefaultProductDisplayPageResponses = {
/**
* default response
*/
default: DefaultProductDisplayPage;
};
export type GetChannelIdDefaultProductDisplayPageResponse = GetChannelIdDefaultProductDisplayPageResponses[keyof GetChannelIdDefaultProductDisplayPageResponses];
export type PostChannelIdDefaultProductDisplayPageData = {
body?: DefaultProductDisplayPage;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channels/{id}/default-product-display-pages';
};
export type PostChannelIdDefaultProductDisplayPageResponses = {
/**
* default response
*/
default: DefaultProductDisplayPage;
};
export type PostChannelIdDefaultProductDisplayPageResponse = PostChannelIdDefaultProductDisplayPageResponses[keyof PostChannelIdDefaultProductDisplayPageResponses];
export type GetPaymentMethodGroupRelOrderTypeOrderTypeData = {
body?: never;
path: {
paymentMethodGroupRelOrderTypeId: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/payment-method-group-rel-order-types/{paymentMethodGroupRelOrderTypeId}/order-type';
};
export type GetPaymentMethodGroupRelOrderTypeOrderTypeResponses = {
/**
* default response
*/
default: OrderType;
};
export type GetPaymentMethodGroupRelOrderTypeOrderTypeResponse = GetPaymentMethodGroupRelOrderTypeOrderTypeResponses[keyof GetPaymentMethodGroupRelOrderTypeOrderTypeResponses];
export type GetShippingFixedOptionOrderTypeOrderTypeData = {
body?: never;
path: {
shippingFixedOptionOrderTypeId: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/shipping-fixed-option-order-types/{shippingFixedOptionOrderTypeId}/order-type';
};
export type GetShippingFixedOptionOrderTypeOrderTypeResponses = {
/**
* default response
*/
default: OrderType;
};
export type GetShippingFixedOptionOrderTypeOrderTypeResponse = GetShippingFixedOptionOrderTypeOrderTypeResponses[keyof GetShippingFixedOptionOrderTypeOrderTypeResponses];
export type DeletePaymentMethodGroupRelOrderTypeData = {
body?: never;
path: {
paymentMethodGroupRelOrderTypeId: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/payment-method-group-rel-order-types/{paymentMethodGroupRelOrderTypeId}';
};
export type DeletePaymentMethodGroupRelOrderTypeResponses = {
/**
* default response
*/
default: unknown;
};
export type DeletePaymentMethodGroupRelOrderTypeBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/payment-method-group-rel-order-types/batch';
};
export type DeletePaymentMethodGroupRelOrderTypeBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetPaymentMethodGroupRelIdPaymentMethodGroupRelOrderTypesPageData = {
body?: never;
path: {
id: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/payment-method-group-rels/{id}/payment-method-group-rel-order-types';
};
export type GetPaymentMethodGroupRelIdPaymentMethodGroupRelOrderTypesPageResponses = {
/**
* default response
*/
default: PagePaymentMethodGroupRelOrderType;
};
export type GetPaymentMethodGroupRelIdPaymentMethodGroupRelOrderTypesPageResponse = GetPaymentMethodGroupRelIdPaymentMethodGroupRelOrderTypesPageResponses[keyof GetPaymentMethodGroupRelIdPaymentMethodGroupRelOrderTypesPageResponses];
export type PostPaymentMethodGroupRelIdPaymentMethodGroupRelOrderTypeData = {
body?: PaymentMethodGroupRelOrderType;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/payment-method-group-rels/{id}/payment-method-group-rel-order-types';
};
export type PostPaymentMethodGroupRelIdPaymentMethodGroupRelOrderTypeResponses = {
/**
* default response
*/
default: PaymentMethodGroupRelOrderType;
};
export type PostPaymentMethodGroupRelIdPaymentMethodGroupRelOrderTypeResponse = PostPaymentMethodGroupRelIdPaymentMethodGroupRelOrderTypeResponses[keyof PostPaymentMethodGroupRelIdPaymentMethodGroupRelOrderTypeResponses];
export type DeletePaymentMethodGroupRelTermData = {
body?: never;
path: {
paymentMethodGroupRelTermId: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/payment-method-group-rel-terms/{paymentMethodGroupRelTermId}';
};
export type DeletePaymentMethodGroupRelTermResponses = {
/**
* default response
*/
default: unknown;
};
export type DeletePaymentMethodGroupRelTermBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/payment-method-group-rel-terms/batch';
};
export type DeletePaymentMethodGroupRelTermBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetPaymentMethodGroupRelIdPaymentMethodGroupRelTermsPageData = {
body?: never;
path: {
id: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/payment-method-group-rels/{id}/payment-method-group-rel-terms';
};
export type GetPaymentMethodGroupRelIdPaymentMethodGroupRelTermsPageResponses = {
/**
* default response
*/
default: PagePaymentMethodGroupRelTerm;
};
export type GetPaymentMethodGroupRelIdPaymentMethodGroupRelTermsPageResponse = GetPaymentMethodGroupRelIdPaymentMethodGroupRelTermsPageResponses[keyof GetPaymentMethodGroupRelIdPaymentMethodGroupRelTermsPageResponses];
export type PostPaymentMethodGroupRelIdPaymentMethodGroupRelTermData = {
body?: PaymentMethodGroupRelTerm;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/payment-method-group-rels/{id}/payment-method-group-rel-terms';
};
export type PostPaymentMethodGroupRelIdPaymentMethodGroupRelTermResponses = {
/**
* default response
*/
default: PaymentMethodGroupRelTerm;
};
export type PostPaymentMethodGroupRelIdPaymentMethodGroupRelTermResponse = PostPaymentMethodGroupRelIdPaymentMethodGroupRelTermResponses[keyof PostPaymentMethodGroupRelIdPaymentMethodGroupRelTermResponses];
export type DeleteProductDisplayPageData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/product-display-pages/{id}';
};
export type DeleteProductDisplayPageResponses = {
/**
* default response
*/
default: unknown;
};
export type GetProductDisplayPageData = {
body?: never;
path: {
id: string;
};
query?: {
nestedFields?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/product-display-pages/{id}';
};
export type GetProductDisplayPageResponses = {
/**
* default response
*/
default: ProductDisplayPage;
};
export type GetProductDisplayPageResponse = GetProductDisplayPageResponses[keyof GetProductDisplayPageResponses];
export type PatchProductDisplayPageData = {
body?: ProductDisplayPage;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/product-display-pages/{id}';
};
export type PatchProductDisplayPageResponses = {
/**
* default response
*/
default: ProductDisplayPage;
};
export type PatchProductDisplayPageResponse = PatchProductDisplayPageResponses[keyof PatchProductDisplayPageResponses];
export type DeleteProductDisplayPageBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/product-display-pages/batch';
};
export type DeleteProductDisplayPageBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetChannelByExternalReferenceCodeProductDisplayPagesPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/channels/by-externalReferenceCode/{externalReferenceCode}/product-display-pages';
};
export type GetChannelByExternalReferenceCodeProductDisplayPagesPageResponses = {
/**
* default response
*/
default: PageProductDisplayPage;
};
export type GetChannelByExternalReferenceCodeProductDisplayPagesPageResponse = GetChannelByExternalReferenceCodeProductDisplayPagesPageResponses[keyof GetChannelByExternalReferenceCodeProductDisplayPagesPageResponses];
export type PostChannelByExternalReferenceCodeProductDisplayPageData = {
body?: ProductDisplayPage;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channels/by-externalReferenceCode/{externalReferenceCode}/product-display-pages';
};
export type PostChannelByExternalReferenceCodeProductDisplayPageResponses = {
/**
* default response
*/
default: ProductDisplayPage;
};
export type PostChannelByExternalReferenceCodeProductDisplayPageResponse = PostChannelByExternalReferenceCodeProductDisplayPageResponses[keyof PostChannelByExternalReferenceCodeProductDisplayPageResponses];
export type GetChannelIdProductDisplayPagesPageData = {
body?: never;
path: {
id: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/channels/{id}/product-display-pages';
};
export type GetChannelIdProductDisplayPagesPageResponses = {
/**
* default response
*/
default: PageProductDisplayPage;
};
export type GetChannelIdProductDisplayPagesPageResponse = GetChannelIdProductDisplayPagesPageResponses[keyof GetChannelIdProductDisplayPagesPageResponses];
export type PostChannelIdProductDisplayPageData = {
body?: ProductDisplayPage;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/channels/{id}/product-display-pages';
};
export type PostChannelIdProductDisplayPageResponses = {
/**
* default response
*/
default: ProductDisplayPage;
};
export type PostChannelIdProductDisplayPageResponse = PostChannelIdProductDisplayPageResponses[keyof PostChannelIdProductDisplayPageResponses];
export type DeleteShippingFixedOptionOrderTypeData = {
body?: never;
path: {
shippingFixedOptionOrderTypeId: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/shipping-fixed-option-order-types/{shippingFixedOptionOrderTypeId}';
};
export type DeleteShippingFixedOptionOrderTypeResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteShippingFixedOptionOrderTypeBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/shipping-fixed-option-order-types/batch';
};
export type DeleteShippingFixedOptionOrderTypeBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetShippingFixedOptionIdShippingFixedOptionOrderTypesPageData = {
body?: never;
path: {
id: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/shipping-fixed-options/{id}/shipping-fixed-option-order-types';
};
export type GetShippingFixedOptionIdShippingFixedOptionOrderTypesPageResponses = {
/**
* default response
*/
default: PageShippingFixedOptionOrderType;
};
export type GetShippingFixedOptionIdShippingFixedOptionOrderTypesPageResponse = GetShippingFixedOptionIdShippingFixedOptionOrderTypesPageResponses[keyof GetShippingFixedOptionIdShippingFixedOptionOrderTypesPageResponses];
export type PostShippingFixedOptionIdShippingFixedOptionOrderTypeData = {
body?: ShippingFixedOptionOrderType;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/shipping-fixed-options/{id}/shipping-fixed-option-order-types';
};
export type PostShippingFixedOptionIdShippingFixedOptionOrderTypeResponses = {
/**
* default response
*/
default: ShippingFixedOptionOrderType;
};
export type PostShippingFixedOptionIdShippingFixedOptionOrderTypeResponse = PostShippingFixedOptionIdShippingFixedOptionOrderTypeResponses[keyof PostShippingFixedOptionIdShippingFixedOptionOrderTypeResponses];
export type DeleteShippingFixedOptionTermData = {
body?: never;
path: {
shippingFixedOptionTermId: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/shipping-fixed-option-terms/{shippingFixedOptionTermId}';
};
export type DeleteShippingFixedOptionTermResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteShippingFixedOptionTermBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/shipping-fixed-option-terms/batch';
};
export type DeleteShippingFixedOptionTermBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetShippingFixedOptionIdShippingFixedOptionTermsPageData = {
body?: never;
path: {
id: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/shipping-fixed-options/{id}/shipping-fixed-option-terms';
};
export type GetShippingFixedOptionIdShippingFixedOptionTermsPageResponses = {
/**
* default response
*/
default: PageShippingFixedOptionTerm;
};
export type GetShippingFixedOptionIdShippingFixedOptionTermsPageResponse = GetShippingFixedOptionIdShippingFixedOptionTermsPageResponses[keyof GetShippingFixedOptionIdShippingFixedOptionTermsPageResponses];
export type PostShippingFixedOptionIdShippingFixedOptionTermData = {
body?: ShippingFixedOptionTerm;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/shipping-fixed-options/{id}/shipping-fixed-option-terms';
};
export type PostShippingFixedOptionIdShippingFixedOptionTermResponses = {
/**
* default response
*/
default: ShippingFixedOptionTerm;
};
export type PostShippingFixedOptionIdShippingFixedOptionTermResponse = PostShippingFixedOptionIdShippingFixedOptionTermResponses[keyof PostShippingFixedOptionIdShippingFixedOptionTermResponses];
export type GetChannelShippingMethodsPageData = {
body?: never;
path: {
channelId: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/channels/{channelId}/shipping-methods';
};
export type GetChannelShippingMethodsPageResponses = {
/**
* default response
*/
default: PageShippingMethod;
};
export type GetChannelShippingMethodsPageResponse = GetChannelShippingMethodsPageResponses[keyof GetChannelShippingMethodsPageResponses];
export type PostChannelShippingMethodsPageExportBatchData = {
body?: never;
path: {
channelId: string;
};
query?: {
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/channels/{channelId}/shipping-methods/export-batch';
};
export type PostChannelShippingMethodsPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetTaxCategoriesPageData = {
body?: never;
path?: never;
query?: {
page?: string;
pageSize?: string;
search?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/tax-categories';
};
export type GetTaxCategoriesPageResponses = {
/**
* default response
*/
default: PageTaxCategory;
};
export type GetTaxCategoriesPageResponse = GetTaxCategoriesPageResponses[keyof GetTaxCategoriesPageResponses];
export type GetTaxCategoryData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/tax-categories/{id}';
};
export type GetTaxCategoryResponses = {
/**
* default response
*/
default: TaxCategory;
};
export type GetTaxCategoryResponse = GetTaxCategoryResponses[keyof GetTaxCategoryResponses];
export type PostTaxCategoriesPageExportBatchData = {
body?: never;
path?: never;
query?: {
search?: string;
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/headless-commerce-admin-channel/v1.0/tax-categories/export-batch';
};
export type PostTaxCategoriesPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetPaymentMethodGroupRelTermTermData = {
body?: never;
path: {
paymentMethodGroupRelTermId: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/payment-method-group-rel-terms/{paymentMethodGroupRelTermId}/term';
};
export type GetPaymentMethodGroupRelTermTermResponses = {
/**
* default response
*/
default: Term;
};
export type GetPaymentMethodGroupRelTermTermResponse = GetPaymentMethodGroupRelTermTermResponses[keyof GetPaymentMethodGroupRelTermTermResponses];
export type GetShippingFixedOptionTermTermData = {
body?: never;
path: {
shippingFixedOptionTermId: string;
};
query?: never;
url: '/o/headless-commerce-admin-channel/v1.0/shipping-fixed-option-terms/{shippingFixedOptionTermId}/term';
};
export type GetShippingFixedOptionTermTermResponses = {
/**
* default response
*/
default: Term;
};
export type GetShippingFixedOptionTermTermResponse = GetShippingFixedOptionTermTermResponses[keyof GetShippingFixedOptionTermTermResponses];
export type ClientOptions = {
baseUrl: 'http://localhost:8080' | (string & {});
};