liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
2,337 lines • 76 kB
TypeScript
export type AccountAddress = {
city: string;
countryISOCode: string;
defaultBilling?: boolean;
defaultShipping?: boolean;
description?: string;
externalReferenceCode?: string;
id?: number;
latitude?: number;
longitude?: number;
name: string;
phoneNumber?: string;
regionISOCode?: string;
street1: string;
street2?: string;
street3?: string;
type?: number;
zip?: string;
readonly 'x-class-name'?: string;
};
export type Facet = {
facetCriteria?: string;
facetValues?: Array<FacetValue>;
};
export type FacetValue = {
numberOfOccurrences?: number;
term?: string;
};
export type PageAccountAddress = {
items?: Array<AccountAddress>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type AccountChannelEntry = {
readonly accountExternalReferenceCode?: string;
readonly accountId?: number;
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
channelExternalReferenceCode?: string;
channelId?: number;
classExternalReferenceCode?: string;
classPK?: number;
readonly id?: number;
overrideEligibility?: boolean;
priority?: number;
readonly 'x-class-name'?: string;
};
export type PageAccountChannelEntry = {
items?: Array<AccountChannelEntry>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type AccountChannelShippingOption = {
accountExternalReferenceCode?: string;
accountId?: number;
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
channelExternalReferenceCode?: string;
channelId?: number;
id?: number;
shippingMethodId?: number;
shippingMethodKey?: string;
shippingOptionId?: number;
shippingOptionKey?: string;
readonly 'x-class-name'?: string;
};
export type PageAccountChannelShippingOption = {
items?: Array<AccountChannelShippingOption>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type AccountMember = {
accountId?: number;
accountRoles?: Array<AccountRole>;
email: string;
externalReferenceCode?: string;
name?: string;
userExternalReferenceCode?: string;
userId?: number;
readonly 'x-class-name'?: string;
};
export type AccountRole = {
description?: {
[key: string]: string;
};
name: string;
roleId?: number;
title?: {
[key: string]: string;
};
readonly 'x-class-name'?: string;
};
export type PageAccountMember = {
items?: Array<AccountMember>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type AccountOrganization = {
accountId?: number;
name?: string;
organizationExternalReferenceCode?: string;
organizationId?: number;
treePath?: string;
readonly 'x-class-name'?: string;
};
export type PageAccountOrganization = {
items?: Array<AccountOrganization>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type Account = {
accountAddresses?: Array<AccountAddress>;
accountMembers?: Array<AccountMember>;
accountOrganizations?: Array<AccountOrganization>;
active?: boolean;
customFields?: {
[key: string]: {
[key: string]: unknown;
};
};
/**
* The account's creation date.
*/
readonly dateCreated?: string;
/**
* The account's most recent modification date.
*/
readonly dateModified?: string;
defaultBillingAccountAddressId?: number;
defaultShippingAccountAddressId?: number;
emailAddresses?: Array<string>;
externalReferenceCode: string;
id?: number;
logoId?: number;
logoURL?: string;
name: string;
root?: boolean;
taxId?: string;
type?: number;
readonly 'x-class-name'?: string;
};
export type PageAccount = {
items?: Array<Account>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type MultipartBody = {
values?: {
[key: string]: string;
};
};
export type AdminAccountGroup = {
customFields?: {
[key: string]: {
[key: string]: unknown;
};
};
description?: string;
externalReferenceCode?: string;
readonly id?: number;
name: string;
readonly 'x-class-name'?: string;
};
export type PageAdminAccountGroup = {
items?: Array<AdminAccountGroup>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type User = {
email: string;
externalReferenceCode?: string;
firstName: string;
id?: number;
jobTitle?: string;
lastName: string;
male?: boolean;
middleName?: string;
roles?: Array<string>;
readonly 'x-class-name'?: string;
};
export type DeleteAccountAddressData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accountAddresses/{id}';
};
export type DeleteAccountAddressResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountAddressData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accountAddresses/{id}';
};
export type GetAccountAddressResponses = {
/**
* default response
*/
default: AccountAddress;
};
export type GetAccountAddressResponse = GetAccountAddressResponses[keyof GetAccountAddressResponses];
export type PatchAccountAddressData = {
body?: AccountAddress;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accountAddresses/{id}';
};
export type PatchAccountAddressResponses = {
/**
* default response
*/
default: AccountAddress;
};
export type PatchAccountAddressResponse = PatchAccountAddressResponses[keyof PatchAccountAddressResponses];
export type PutAccountAddressData = {
body?: AccountAddress;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accountAddresses/{id}';
};
export type PutAccountAddressResponses = {
/**
* default response
*/
default: AccountAddress;
};
export type PutAccountAddressResponse = PutAccountAddressResponses[keyof PutAccountAddressResponses];
export type DeleteAccountAddressBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accountAddresses/batch';
};
export type DeleteAccountAddressBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PutAccountAddressBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accountAddresses/batch';
};
export type PutAccountAddressBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteAccountAddressByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accountAddresses/by-externalReferenceCode/{externalReferenceCode}';
};
export type DeleteAccountAddressByExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountAddressByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accountAddresses/by-externalReferenceCode/{externalReferenceCode}';
};
export type GetAccountAddressByExternalReferenceCodeResponses = {
/**
* default response
*/
default: AccountAddress;
};
export type GetAccountAddressByExternalReferenceCodeResponse = GetAccountAddressByExternalReferenceCodeResponses[keyof GetAccountAddressByExternalReferenceCodeResponses];
export type PatchAccountAddressByExternalReferenceCodeData = {
body?: AccountAddress;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accountAddresses/by-externalReferenceCode/{externalReferenceCode}';
};
export type PatchAccountAddressByExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountByExternalReferenceCodeAccountAddressesPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/accountAddresses';
};
export type GetAccountByExternalReferenceCodeAccountAddressesPageResponses = {
/**
* default response
*/
default: PageAccountAddress;
};
export type GetAccountByExternalReferenceCodeAccountAddressesPageResponse = GetAccountByExternalReferenceCodeAccountAddressesPageResponses[keyof GetAccountByExternalReferenceCodeAccountAddressesPageResponses];
export type PostAccountByExternalReferenceCodeAccountAddressData = {
body?: AccountAddress;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/accountAddresses';
};
export type PostAccountByExternalReferenceCodeAccountAddressResponses = {
/**
* default response
*/
default: AccountAddress;
};
export type PostAccountByExternalReferenceCodeAccountAddressResponse = PostAccountByExternalReferenceCodeAccountAddressResponses[keyof PostAccountByExternalReferenceCodeAccountAddressResponses];
export type GetAccountIdAccountAddressesPageData = {
body?: never;
path: {
id: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/accountAddresses';
};
export type GetAccountIdAccountAddressesPageResponses = {
/**
* default response
*/
default: PageAccountAddress;
};
export type GetAccountIdAccountAddressesPageResponse = GetAccountIdAccountAddressesPageResponses[keyof GetAccountIdAccountAddressesPageResponses];
export type PostAccountIdAccountAddressData = {
body?: AccountAddress;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/accountAddresses';
};
export type PostAccountIdAccountAddressResponses = {
/**
* default response
*/
default: AccountAddress;
};
export type PostAccountIdAccountAddressResponse = PostAccountIdAccountAddressResponses[keyof PostAccountIdAccountAddressResponses];
export type PostAccountIdAccountAddressBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/accountAddresses/batch';
};
export type PostAccountIdAccountAddressBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteAccountChannelBillingAddressIdData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-billing-addresses/{id}';
};
export type DeleteAccountChannelBillingAddressIdResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountChannelBillingAddressIdData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-billing-addresses/{id}';
};
export type GetAccountChannelBillingAddressIdResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type GetAccountChannelBillingAddressIdResponse = GetAccountChannelBillingAddressIdResponses[keyof GetAccountChannelBillingAddressIdResponses];
export type PatchAccountChannelBillingAddressIdData = {
body?: AccountChannelEntry;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-billing-addresses/{id}';
};
export type PatchAccountChannelBillingAddressIdResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PatchAccountChannelBillingAddressIdResponse = PatchAccountChannelBillingAddressIdResponses[keyof PatchAccountChannelBillingAddressIdResponses];
export type DeleteAccountChannelCurrencyIdData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-currencies/{id}';
};
export type DeleteAccountChannelCurrencyIdResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountChannelCurrencyIdData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-currencies/{id}';
};
export type GetAccountChannelCurrencyIdResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type GetAccountChannelCurrencyIdResponse = GetAccountChannelCurrencyIdResponses[keyof GetAccountChannelCurrencyIdResponses];
export type PatchAccountChannelCurrencyIdData = {
body?: AccountChannelEntry;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-currencies/{id}';
};
export type PatchAccountChannelCurrencyIdResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PatchAccountChannelCurrencyIdResponse = PatchAccountChannelCurrencyIdResponses[keyof PatchAccountChannelCurrencyIdResponses];
export type DeleteAccountChannelDeliveryTermIdData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-delivery-terms/{id}';
};
export type DeleteAccountChannelDeliveryTermIdResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountChannelDeliveryTermIdData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-delivery-terms/{id}';
};
export type GetAccountChannelDeliveryTermIdResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type GetAccountChannelDeliveryTermIdResponse = GetAccountChannelDeliveryTermIdResponses[keyof GetAccountChannelDeliveryTermIdResponses];
export type PatchAccountChannelDeliveryTermIdData = {
body?: AccountChannelEntry;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-delivery-terms/{id}';
};
export type PatchAccountChannelDeliveryTermIdResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PatchAccountChannelDeliveryTermIdResponse = PatchAccountChannelDeliveryTermIdResponses[keyof PatchAccountChannelDeliveryTermIdResponses];
export type DeleteAccountChannelDiscountIdData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-discounts/{id}';
};
export type DeleteAccountChannelDiscountIdResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountChannelDiscountIdData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-discounts/{id}';
};
export type GetAccountChannelDiscountIdResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type GetAccountChannelDiscountIdResponse = GetAccountChannelDiscountIdResponses[keyof GetAccountChannelDiscountIdResponses];
export type PatchAccountChannelDiscountIdData = {
body?: AccountChannelEntry;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-discounts/{id}';
};
export type PatchAccountChannelDiscountIdResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PatchAccountChannelDiscountIdResponse = PatchAccountChannelDiscountIdResponses[keyof PatchAccountChannelDiscountIdResponses];
export type DeleteAccountChannelPaymentMethodIdData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-payment-methods/{id}';
};
export type DeleteAccountChannelPaymentMethodIdResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountChannelPaymentMethodIdData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-payment-methods/{id}';
};
export type GetAccountChannelPaymentMethodIdResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type GetAccountChannelPaymentMethodIdResponse = GetAccountChannelPaymentMethodIdResponses[keyof GetAccountChannelPaymentMethodIdResponses];
export type PatchAccountChannelPaymentMethodIdData = {
body?: AccountChannelEntry;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-payment-methods/{id}';
};
export type PatchAccountChannelPaymentMethodIdResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PatchAccountChannelPaymentMethodIdResponse = PatchAccountChannelPaymentMethodIdResponses[keyof PatchAccountChannelPaymentMethodIdResponses];
export type DeleteAccountChannelPaymentTermIdData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-payment-terms/{id}';
};
export type DeleteAccountChannelPaymentTermIdResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountChannelPaymentTermIdData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-payment-terms/{id}';
};
export type GetAccountChannelPaymentTermIdResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type GetAccountChannelPaymentTermIdResponse = GetAccountChannelPaymentTermIdResponses[keyof GetAccountChannelPaymentTermIdResponses];
export type PatchAccountChannelPaymentTermIdData = {
body?: AccountChannelEntry;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-payment-terms/{id}';
};
export type PatchAccountChannelPaymentTermIdResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PatchAccountChannelPaymentTermIdResponse = PatchAccountChannelPaymentTermIdResponses[keyof PatchAccountChannelPaymentTermIdResponses];
export type DeleteAccountChannelPriceListIdData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-price-list/{id}';
};
export type DeleteAccountChannelPriceListIdResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountChannelPriceListIdData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-price-list/{id}';
};
export type GetAccountChannelPriceListIdResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type GetAccountChannelPriceListIdResponse = GetAccountChannelPriceListIdResponses[keyof GetAccountChannelPriceListIdResponses];
export type PatchAccountChannelPriceListIdData = {
body?: AccountChannelEntry;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-price-list/{id}';
};
export type PatchAccountChannelPriceListIdResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PatchAccountChannelPriceListIdResponse = PatchAccountChannelPriceListIdResponses[keyof PatchAccountChannelPriceListIdResponses];
export type DeleteAccountChannelShippingAddressIdData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-shipping-addresses/{id}';
};
export type DeleteAccountChannelShippingAddressIdResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountChannelShippingAddressIdData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-shipping-addresses/{id}';
};
export type GetAccountChannelShippingAddressIdResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type GetAccountChannelShippingAddressIdResponse = GetAccountChannelShippingAddressIdResponses[keyof GetAccountChannelShippingAddressIdResponses];
export type PatchAccountChannelShippingAddressIdData = {
body?: AccountChannelEntry;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-shipping-addresses/{id}';
};
export type PatchAccountChannelShippingAddressIdResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PatchAccountChannelShippingAddressIdResponse = PatchAccountChannelShippingAddressIdResponses[keyof PatchAccountChannelShippingAddressIdResponses];
export type DeleteAccountChannelUserIdData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-users/{id}';
};
export type DeleteAccountChannelUserIdResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountChannelUserIdData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-users/{id}';
};
export type GetAccountChannelUserIdResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type GetAccountChannelUserIdResponse = GetAccountChannelUserIdResponses[keyof GetAccountChannelUserIdResponses];
export type PatchAccountChannelUserIdData = {
body?: AccountChannelEntry;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-users/{id}';
};
export type PatchAccountChannelUserIdResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PatchAccountChannelUserIdResponse = PatchAccountChannelUserIdResponses[keyof PatchAccountChannelUserIdResponses];
export type GetAccountByExternalReferenceCodeAccountChannelBillingAddressesPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/account-channel-billing-addresses';
};
export type GetAccountByExternalReferenceCodeAccountChannelBillingAddressesPageResponses = {
/**
* default response
*/
default: PageAccountChannelEntry;
};
export type GetAccountByExternalReferenceCodeAccountChannelBillingAddressesPageResponse = GetAccountByExternalReferenceCodeAccountChannelBillingAddressesPageResponses[keyof GetAccountByExternalReferenceCodeAccountChannelBillingAddressesPageResponses];
export type PostAccountByExternalReferenceCodeAccountChannelBillingAddressData = {
body?: AccountChannelEntry;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/account-channel-billing-addresses';
};
export type PostAccountByExternalReferenceCodeAccountChannelBillingAddressResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PostAccountByExternalReferenceCodeAccountChannelBillingAddressResponse = PostAccountByExternalReferenceCodeAccountChannelBillingAddressResponses[keyof PostAccountByExternalReferenceCodeAccountChannelBillingAddressResponses];
export type GetAccountByExternalReferenceCodeAccountChannelCurrenciesPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/account-channel-currencies';
};
export type GetAccountByExternalReferenceCodeAccountChannelCurrenciesPageResponses = {
/**
* default response
*/
default: PageAccountChannelEntry;
};
export type GetAccountByExternalReferenceCodeAccountChannelCurrenciesPageResponse = GetAccountByExternalReferenceCodeAccountChannelCurrenciesPageResponses[keyof GetAccountByExternalReferenceCodeAccountChannelCurrenciesPageResponses];
export type PostAccountByExternalReferenceCodeAccountChannelCurrencyData = {
body?: AccountChannelEntry;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/account-channel-currencies';
};
export type PostAccountByExternalReferenceCodeAccountChannelCurrencyResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PostAccountByExternalReferenceCodeAccountChannelCurrencyResponse = PostAccountByExternalReferenceCodeAccountChannelCurrencyResponses[keyof PostAccountByExternalReferenceCodeAccountChannelCurrencyResponses];
export type GetAccountByExternalReferenceCodeAccountChannelDeliveryTermsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/account-channel-delivery-terms';
};
export type GetAccountByExternalReferenceCodeAccountChannelDeliveryTermsPageResponses = {
/**
* default response
*/
default: PageAccountChannelEntry;
};
export type GetAccountByExternalReferenceCodeAccountChannelDeliveryTermsPageResponse = GetAccountByExternalReferenceCodeAccountChannelDeliveryTermsPageResponses[keyof GetAccountByExternalReferenceCodeAccountChannelDeliveryTermsPageResponses];
export type PostAccountByExternalReferenceCodeAccountChannelDeliveryTermData = {
body?: AccountChannelEntry;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/account-channel-delivery-terms';
};
export type PostAccountByExternalReferenceCodeAccountChannelDeliveryTermResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PostAccountByExternalReferenceCodeAccountChannelDeliveryTermResponse = PostAccountByExternalReferenceCodeAccountChannelDeliveryTermResponses[keyof PostAccountByExternalReferenceCodeAccountChannelDeliveryTermResponses];
export type GetAccountByExternalReferenceCodeAccountChannelDiscountsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/account-channel-discounts';
};
export type GetAccountByExternalReferenceCodeAccountChannelDiscountsPageResponses = {
/**
* default response
*/
default: PageAccountChannelEntry;
};
export type GetAccountByExternalReferenceCodeAccountChannelDiscountsPageResponse = GetAccountByExternalReferenceCodeAccountChannelDiscountsPageResponses[keyof GetAccountByExternalReferenceCodeAccountChannelDiscountsPageResponses];
export type PostAccountByExternalReferenceCodeAccountChannelDiscountData = {
body?: AccountChannelEntry;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/account-channel-discounts';
};
export type PostAccountByExternalReferenceCodeAccountChannelDiscountResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PostAccountByExternalReferenceCodeAccountChannelDiscountResponse = PostAccountByExternalReferenceCodeAccountChannelDiscountResponses[keyof PostAccountByExternalReferenceCodeAccountChannelDiscountResponses];
export type GetAccountByExternalReferenceCodeAccountChannelPaymentMethodsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/account-channel-payment-methods';
};
export type GetAccountByExternalReferenceCodeAccountChannelPaymentMethodsPageResponses = {
/**
* default response
*/
default: PageAccountChannelEntry;
};
export type GetAccountByExternalReferenceCodeAccountChannelPaymentMethodsPageResponse = GetAccountByExternalReferenceCodeAccountChannelPaymentMethodsPageResponses[keyof GetAccountByExternalReferenceCodeAccountChannelPaymentMethodsPageResponses];
export type PostAccountByExternalReferenceCodeAccountChannelPaymentMethodData = {
body?: AccountChannelEntry;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/account-channel-payment-methods';
};
export type PostAccountByExternalReferenceCodeAccountChannelPaymentMethodResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PostAccountByExternalReferenceCodeAccountChannelPaymentMethodResponse = PostAccountByExternalReferenceCodeAccountChannelPaymentMethodResponses[keyof PostAccountByExternalReferenceCodeAccountChannelPaymentMethodResponses];
export type GetAccountByExternalReferenceCodeAccountChannelPaymentTermsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/account-channel-payment-terms';
};
export type GetAccountByExternalReferenceCodeAccountChannelPaymentTermsPageResponses = {
/**
* default response
*/
default: PageAccountChannelEntry;
};
export type GetAccountByExternalReferenceCodeAccountChannelPaymentTermsPageResponse = GetAccountByExternalReferenceCodeAccountChannelPaymentTermsPageResponses[keyof GetAccountByExternalReferenceCodeAccountChannelPaymentTermsPageResponses];
export type PostAccountByExternalReferenceCodeAccountChannelPaymentTermData = {
body?: AccountChannelEntry;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/account-channel-payment-terms';
};
export type PostAccountByExternalReferenceCodeAccountChannelPaymentTermResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PostAccountByExternalReferenceCodeAccountChannelPaymentTermResponse = PostAccountByExternalReferenceCodeAccountChannelPaymentTermResponses[keyof PostAccountByExternalReferenceCodeAccountChannelPaymentTermResponses];
export type GetAccountByExternalReferenceCodeAccountChannelPriceListsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/account-channel-price-lists';
};
export type GetAccountByExternalReferenceCodeAccountChannelPriceListsPageResponses = {
/**
* default response
*/
default: PageAccountChannelEntry;
};
export type GetAccountByExternalReferenceCodeAccountChannelPriceListsPageResponse = GetAccountByExternalReferenceCodeAccountChannelPriceListsPageResponses[keyof GetAccountByExternalReferenceCodeAccountChannelPriceListsPageResponses];
export type PostAccountByExternalReferenceCodeAccountChannelPriceListData = {
body?: AccountChannelEntry;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/account-channel-price-lists';
};
export type PostAccountByExternalReferenceCodeAccountChannelPriceListResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PostAccountByExternalReferenceCodeAccountChannelPriceListResponse = PostAccountByExternalReferenceCodeAccountChannelPriceListResponses[keyof PostAccountByExternalReferenceCodeAccountChannelPriceListResponses];
export type GetAccountByExternalReferenceCodeAccountChannelShippingAddressesPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/account-channel-shipping-addresses';
};
export type GetAccountByExternalReferenceCodeAccountChannelShippingAddressesPageResponses = {
/**
* default response
*/
default: PageAccountChannelEntry;
};
export type GetAccountByExternalReferenceCodeAccountChannelShippingAddressesPageResponse = GetAccountByExternalReferenceCodeAccountChannelShippingAddressesPageResponses[keyof GetAccountByExternalReferenceCodeAccountChannelShippingAddressesPageResponses];
export type PostAccountByExternalReferenceCodeAccountChannelShippingAddressData = {
body?: AccountChannelEntry;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/account-channel-shipping-addresses';
};
export type PostAccountByExternalReferenceCodeAccountChannelShippingAddressResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PostAccountByExternalReferenceCodeAccountChannelShippingAddressResponse = PostAccountByExternalReferenceCodeAccountChannelShippingAddressResponses[keyof PostAccountByExternalReferenceCodeAccountChannelShippingAddressResponses];
export type GetAccountByExternalReferenceCodeAccountChannelUsersPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/account-channel-users';
};
export type GetAccountByExternalReferenceCodeAccountChannelUsersPageResponses = {
/**
* default response
*/
default: PageAccountChannelEntry;
};
export type GetAccountByExternalReferenceCodeAccountChannelUsersPageResponse = GetAccountByExternalReferenceCodeAccountChannelUsersPageResponses[keyof GetAccountByExternalReferenceCodeAccountChannelUsersPageResponses];
export type PostAccountByExternalReferenceCodeAccountChannelUserData = {
body?: AccountChannelEntry;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/account-channel-users';
};
export type PostAccountByExternalReferenceCodeAccountChannelUserResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PostAccountByExternalReferenceCodeAccountChannelUserResponse = PostAccountByExternalReferenceCodeAccountChannelUserResponses[keyof PostAccountByExternalReferenceCodeAccountChannelUserResponses];
export type GetAccountIdAccountChannelBillingAddressesPageData = {
body?: never;
path: {
id: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/account-channel-billing-addresses';
};
export type GetAccountIdAccountChannelBillingAddressesPageResponses = {
/**
* default response
*/
default: PageAccountChannelEntry;
};
export type GetAccountIdAccountChannelBillingAddressesPageResponse = GetAccountIdAccountChannelBillingAddressesPageResponses[keyof GetAccountIdAccountChannelBillingAddressesPageResponses];
export type PostAccountIdAccountChannelBillingAddressData = {
body?: AccountChannelEntry;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/account-channel-billing-addresses';
};
export type PostAccountIdAccountChannelBillingAddressResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PostAccountIdAccountChannelBillingAddressResponse = PostAccountIdAccountChannelBillingAddressResponses[keyof PostAccountIdAccountChannelBillingAddressResponses];
export type GetAccountIdAccountChannelCurrenciesPageData = {
body?: never;
path: {
id: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/account-channel-currencies';
};
export type GetAccountIdAccountChannelCurrenciesPageResponses = {
/**
* default response
*/
default: PageAccountChannelEntry;
};
export type GetAccountIdAccountChannelCurrenciesPageResponse = GetAccountIdAccountChannelCurrenciesPageResponses[keyof GetAccountIdAccountChannelCurrenciesPageResponses];
export type PostAccountIdAccountChannelCurrencyData = {
body?: AccountChannelEntry;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/account-channel-currencies';
};
export type PostAccountIdAccountChannelCurrencyResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PostAccountIdAccountChannelCurrencyResponse = PostAccountIdAccountChannelCurrencyResponses[keyof PostAccountIdAccountChannelCurrencyResponses];
export type GetAccountIdAccountChannelDeliveryTermsPageData = {
body?: never;
path: {
id: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/account-channel-delivery-terms';
};
export type GetAccountIdAccountChannelDeliveryTermsPageResponses = {
/**
* default response
*/
default: PageAccountChannelEntry;
};
export type GetAccountIdAccountChannelDeliveryTermsPageResponse = GetAccountIdAccountChannelDeliveryTermsPageResponses[keyof GetAccountIdAccountChannelDeliveryTermsPageResponses];
export type PostAccountIdAccountChannelDeliveryTermData = {
body?: AccountChannelEntry;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/account-channel-delivery-terms';
};
export type PostAccountIdAccountChannelDeliveryTermResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PostAccountIdAccountChannelDeliveryTermResponse = PostAccountIdAccountChannelDeliveryTermResponses[keyof PostAccountIdAccountChannelDeliveryTermResponses];
export type GetAccountIdAccountChannelDiscountsPageData = {
body?: never;
path: {
id: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/account-channel-discounts';
};
export type GetAccountIdAccountChannelDiscountsPageResponses = {
/**
* default response
*/
default: PageAccountChannelEntry;
};
export type GetAccountIdAccountChannelDiscountsPageResponse = GetAccountIdAccountChannelDiscountsPageResponses[keyof GetAccountIdAccountChannelDiscountsPageResponses];
export type PostAccountIdAccountChannelDiscountData = {
body?: AccountChannelEntry;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/account-channel-discounts';
};
export type PostAccountIdAccountChannelDiscountResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PostAccountIdAccountChannelDiscountResponse = PostAccountIdAccountChannelDiscountResponses[keyof PostAccountIdAccountChannelDiscountResponses];
export type GetAccountIdAccountChannelPaymentMethodsPageData = {
body?: never;
path: {
id: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/account-channel-payment-methods';
};
export type GetAccountIdAccountChannelPaymentMethodsPageResponses = {
/**
* default response
*/
default: PageAccountChannelEntry;
};
export type GetAccountIdAccountChannelPaymentMethodsPageResponse = GetAccountIdAccountChannelPaymentMethodsPageResponses[keyof GetAccountIdAccountChannelPaymentMethodsPageResponses];
export type PostAccountIdAccountChannelPaymentMethodData = {
body?: AccountChannelEntry;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/account-channel-payment-methods';
};
export type PostAccountIdAccountChannelPaymentMethodResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PostAccountIdAccountChannelPaymentMethodResponse = PostAccountIdAccountChannelPaymentMethodResponses[keyof PostAccountIdAccountChannelPaymentMethodResponses];
export type GetAccountIdAccountChannelPaymentTermsPageData = {
body?: never;
path: {
id: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/account-channel-payment-terms';
};
export type GetAccountIdAccountChannelPaymentTermsPageResponses = {
/**
* default response
*/
default: PageAccountChannelEntry;
};
export type GetAccountIdAccountChannelPaymentTermsPageResponse = GetAccountIdAccountChannelPaymentTermsPageResponses[keyof GetAccountIdAccountChannelPaymentTermsPageResponses];
export type PostAccountIdAccountChannelPaymentTermData = {
body?: AccountChannelEntry;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/account-channel-payment-terms';
};
export type PostAccountIdAccountChannelPaymentTermResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PostAccountIdAccountChannelPaymentTermResponse = PostAccountIdAccountChannelPaymentTermResponses[keyof PostAccountIdAccountChannelPaymentTermResponses];
export type GetAccountIdAccountChannelPriceListsPageData = {
body?: never;
path: {
id: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/account-channel-price-lists';
};
export type GetAccountIdAccountChannelPriceListsPageResponses = {
/**
* default response
*/
default: PageAccountChannelEntry;
};
export type GetAccountIdAccountChannelPriceListsPageResponse = GetAccountIdAccountChannelPriceListsPageResponses[keyof GetAccountIdAccountChannelPriceListsPageResponses];
export type PostAccountIdAccountChannelPriceListData = {
body?: AccountChannelEntry;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/account-channel-price-lists';
};
export type PostAccountIdAccountChannelPriceListResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PostAccountIdAccountChannelPriceListResponse = PostAccountIdAccountChannelPriceListResponses[keyof PostAccountIdAccountChannelPriceListResponses];
export type GetAccountIdAccountChannelShippingAddressesPageData = {
body?: never;
path: {
id: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/account-channel-shipping-addresses';
};
export type GetAccountIdAccountChannelShippingAddressesPageResponses = {
/**
* default response
*/
default: PageAccountChannelEntry;
};
export type GetAccountIdAccountChannelShippingAddressesPageResponse = GetAccountIdAccountChannelShippingAddressesPageResponses[keyof GetAccountIdAccountChannelShippingAddressesPageResponses];
export type PostAccountIdAccountChannelShippingAddressData = {
body?: AccountChannelEntry;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/account-channel-shipping-addresses';
};
export type PostAccountIdAccountChannelShippingAddressResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PostAccountIdAccountChannelShippingAddressResponse = PostAccountIdAccountChannelShippingAddressResponses[keyof PostAccountIdAccountChannelShippingAddressResponses];
export type GetAccountIdAccountChannelUsersPageData = {
body?: never;
path: {
id: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/account-channel-users';
};
export type GetAccountIdAccountChannelUsersPageResponses = {
/**
* default response
*/
default: PageAccountChannelEntry;
};
export type GetAccountIdAccountChannelUsersPageResponse = GetAccountIdAccountChannelUsersPageResponses[keyof GetAccountIdAccountChannelUsersPageResponses];
export type PostAccountIdAccountChannelUserData = {
body?: AccountChannelEntry;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/account-channel-users';
};
export type PostAccountIdAccountChannelUserResponses = {
/**
* default response
*/
default: AccountChannelEntry;
};
export type PostAccountIdAccountChannelUserResponse = PostAccountIdAccountChannelUserResponses[keyof PostAccountIdAccountChannelUserResponses];
export type DeleteAccountChannelShippingOptionData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-shipping-options/{id}';
};
export type DeleteAccountChannelShippingOptionResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountChannelShippingOptionData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-shipping-options/{id}';
};
export type GetAccountChannelShippingOptionResponses = {
/**
* default response
*/
default: AccountChannelShippingOption;
};
export type GetAccountChannelShippingOptionResponse = GetAccountChannelShippingOptionResponses[keyof GetAccountChannelShippingOptionResponses];
export type PatchAccountChannelShippingOptionData = {
body?: AccountChannelShippingOption;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/account-channel-shipping-options/{id}';
};
export type PatchAccountChannelShippingOptionResponses = {
/**
* default response
*/
default: AccountChannelShippingOption;
};
export type PatchAccountChannelShippingOptionResponse = PatchAccountChannelShippingOptionResponses[keyof PatchAccountChannelShippingOptionResponses];
export type DeleteAccountChannelShippingOptionBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/account-channel-shipping-options/batch';
};
export type DeleteAccountChannelShippingOptionBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountByExternalReferenceCodeAccountChannelShippingOptionPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/account-channel-shipping-option';
};
export type GetAccountByExternalReferenceCodeAccountChannelShippingOptionPageResponses = {
/**
* default response
*/
default: PageAccountChannelShippingOption;
};
export type GetAccountByExternalReferenceCodeAccountChannelShippingOptionPageResponse = GetAccountByExternalReferenceCodeAccountChannelShippingOptionPageResponses[keyof GetAccountByExternalReferenceCodeAccountChannelShippingOptionPageResponses];
export type PostAccountByExternalReferenceCodeAccountChannelShippingOptionData = {
body?: AccountChannelShippingOption;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/account-channel-shipping-option';
};
export type PostAccountByExternalReferenceCodeAccountChannelShippingOptionResponses = {
/**
* default response
*/
default: AccountChannelShippingOption;
};
export type PostAccountByExternalReferenceCodeAccountChannelShippingOptionResponse = PostAccountByExternalReferenceCodeAccountChannelShippingOptionResponses[keyof PostAccountByExternalReferenceCodeAccountChannelShippingOptionResponses];
export type GetAccountIdAccountChannelShippingOptionPageData = {
body?: never;
path: {
id: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/account-channel-shipping-option';
};
export type GetAccountIdAccountChannelShippingOptionPageResponses = {
/**
* default response
*/
default: PageAccountChannelShippingOption;
};
export type GetAccountIdAccountChannelShippingOptionPageResponse = GetAccountIdAccountChannelShippingOptionPageResponses[keyof GetAccountIdAccountChannelShippingOptionPageResponses];
export type PostAccountIdAccountChannelShippingOptionData = {
body?: AccountChannelShippingOption;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/account-channel-shipping-option';
};
export type PostAccountIdAccountChannelShippingOptionResponses = {
/**
* default response
*/
default: AccountChannelShippingOption;
};
export type PostAccountIdAccountChannelShippingOptionResponse = PostAccountIdAccountChannelShippingOptionResponses[keyof PostAccountIdAccountChannelShippingOptionResponses];
export type PostAccountIdAccountChannelShippingOptionBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/account-channel-shipping-option/batch';
};
export type PostAccountIdAccountChannelShippingOptionBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteAccountByExternalReferenceCodeAccountMemberData = {
body?: never;
path: {
externalReferenceCode: string;
userId: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/accountMembers/{userId}';
};
export type DeleteAccountByExternalReferenceCodeAccountMemberResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountByExternalReferenceCodeAccountMemberData = {
body?: never;
path: {
externalReferenceCode: string;
userId: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/accountMembers/{userId}';
};
export type GetAccountByExternalReferenceCodeAccountMemberResponses = {
/**
* default response
*/
default: AccountMember;
};
export type GetAccountByExternalReferenceCodeAccountMemberResponse = GetAccountByExternalReferenceCodeAccountMemberResponses[keyof GetAccountByExternalReferenceCodeAccountMemberResponses];
export type PatchAccountByExternalReferenceCodeAccountMemberData = {
body?: AccountMember;
path: {
externalReferenceCode: string;
userId: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/accountMembers/{userId}';
};
export type PatchAccountByExternalReferenceCodeAccountMemberResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteAccountIdAccountMemberData = {
body?: never;
path: {
id: string;
userId: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/accountMembers/{userId}';
};
export type DeleteAccountIdAccountMemberResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountIdAccountMemberData = {
body?: never;
path: {
id: string;
userId: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/accountMembers/{userId}';
};
export type GetAccountIdAccountMemberResponses = {
/**
* default response
*/
default: AccountMember;
};
export type GetAccountIdAccountMemberResponse = GetAccountIdAccountMemberResponses[keyof GetAccountIdAccountMemberResponses];
export type PatchAccountIdAccountMemberData = {
body?: AccountMember;
path: {
id: string;
userId: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/accountMembers/{userId}';
};
export type PatchAccountIdAccountMemberResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountByExternalReferenceCodeAccountMembersPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/accountMembers';
};
export type GetAccountByExternalReferenceCodeAccountMembersPageResponses = {
/**
* default response
*/
default: PageAccountMember;
};
export type GetAccountByExternalReferenceCodeAccountMembersPageResponse = GetAccountByExternalReferenceCodeAccountMembersPageResponses[keyof GetAccountByExternalReferenceCodeAccountMembersPageResponses];
export type PostAccountByExternalReferenceCodeAccountMemberData = {
body?: AccountMember;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/accountMembers';
};
export type PostAccountByExternalReferenceCodeAccountMemberResponses = {
/**
* default response
*/
default: AccountMember;
};
export type PostAccountByExternalReferenceCodeAccountMemberResponse = PostAccountByExternalReferenceCodeAccountMemberResponses[keyof PostAccountByExternalReferenceCodeAccountMemberResponses];
export type GetAccountIdAccountMembersPageData = {
body?: never;
path: {
id: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/accountMembers';
};
export type GetAccountIdAccountMembersPageResponses = {
/**
* default response
*/
default: PageAccountMember;
};
export type GetAccountIdAccountMembersPageResponse = GetAccountIdAccountMembersPageResponses[keyof GetAccountIdAccountMembersPageResponses];
export type PostAccountIdAccountMemberData = {
body?: AccountMember;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/accountMembers';
};
export type PostAccountIdAccountMemberResponses = {
/**
* default response
*/
default: AccountMember;
};
export type PostAccountIdAccountMemberResponse = PostAccountIdAccountMemberResponses[keyof PostAccountIdAccountMemberResponses];
export type PostAccountIdAccountMemberBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/accountMembers/batch';
};
export type PostAccountIdAccountMemberBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteAccountByExternalReferenceCodeAccountOrganizationData = {
body?: never;
path: {
externalReferenceCode: string;
organizationId: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/accountOrganizations/{organizationId}';
};
export type DeleteAccountByExternalReferenceCodeAccountOrganizationResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountByExternalReferenceCodeAccountOrganizationData = {
body?: never;
path: {
externalReferenceCode: string;
organizationId: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/accountOrganizations/{organizationId}';
};
export type GetAccountByExternalReferenceCodeAccountOrganizationResponses = {
/**
* default response
*/
default: AccountOrganization;
};
export type GetAccountByExternalReferenceCodeAccountOrganizationResponse = GetAccountByExternalReferenceCodeAccountOrganizationResponses[keyof GetAccountByExternalReferenceCodeAccountOrganizationResponses];
export type DeleteAccountIdAccountOrganizationData = {
body?: never;
path: {
id: string;
organizationId: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/accountOrganizations/{organizationId}';
};
export type DeleteAccountIdAccountOrganizationResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountIdAccountOrganizationData = {
body?: never;
path: {
id: string;
organizationId: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/accountOrganizations/{organizationId}';
};
export type GetAccountIdAccountOrganizationResponses = {
/**
* default response
*/
default: AccountOrganization;
};
export type GetAccountIdAccountOrganizationResponse = GetAccountIdAccountOrganizationResponses[keyof GetAccountIdAccountOrganizationResponses];
export type GetAccountByExternalReferenceCodeAccountOrganizationsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/accountOrganizations';
};
export type GetAccountByExternalReferenceCodeAccountOrganizationsPageResponses = {
/**
* default response
*/
default: PageAccountOrganization;
};
export type GetAccountByExternalReferenceCodeAccountOrganizationsPageResponse = GetAccountByExternalReferenceCodeAccountOrganizationsPageResponses[keyof GetAccountByExternalReferenceCodeAccountOrganizationsPageResponses];
export type PostAccountByExternalReferenceCodeAccountOrganizationData = {
body?: AccountOrganization;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/accountOrganizations';
};
export type PostAccountByExternalReferenceCodeAccountOrganizationResponses = {
/**
* default response
*/
default: AccountOrganization;
};
export type PostAccountByExternalReferenceCodeAccountOrganizationResponse = PostAccountByExternalReferenceCodeAccountOrganizationResponses[keyof PostAccountByExternalReferenceCodeAccountOrganizationResponses];
export type GetAccountIdAccountOrganizationsPageData = {
body?: never;
path: {
id: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/accountOrganizations';
};
export type GetAccountIdAccountOrganizationsPageResponses = {
/**
* default response
*/
default: PageAccountOrganization;
};
export type GetAccountIdAccountOrganizationsPageResponse = GetAccountIdAccountOrganizationsPageResponses[keyof GetAccountIdAccountOrganizationsPageResponses];
export type PostAccountIdAccountOrganizationData = {
body?: AccountOrganization;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/accountOrganizations';
};
export type PostAccountIdAccountOrganizationResponses = {
/**
* default response
*/
default: AccountOrganization;
};
export type PostAccountIdAccountOrganizationResponse = PostAccountIdAccountOrganizationResponses[keyof PostAccountIdAccountOrganizationResponses];
export type PostAccountIdAccountOrganizationBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/accountOrganizations/batch';
};
export type PostAccountIdAccountOrganizationBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteAccountData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}';
};
export type DeleteAccountResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}';
};
export type GetAccountResponses = {
/**
* default response
*/
default: Account;
};
export type GetAccountResponse = GetAccountResponses[keyof GetAccountResponses];
export type PatchAccountData = {
body?: Account;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}';
};
export type PatchAccountResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteAccountBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/batch';
};
export type DeleteAccountBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostAccountBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/batch';
};
export type PostAccountBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteAccountByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}';
};
export type DeleteAccountByExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}';
};
export type GetAccountByExternalReferenceCodeResponses = {
/**
* default response
*/
default: Account;
};
export type GetAccountByExternalReferenceCodeResponse = GetAccountByExternalReferenceCodeResponses[keyof GetAccountByExternalReferenceCodeResponses];
export type PatchAccountByExternalReferenceCodeData = {
body?: Account;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}';
};
export type PatchAccountByExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteAccountGroupByExternalReferenceCodeAccountData = {
body?: never;
path: {
accountExternalReferenceCode: string;
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accountGroups/by-externalReferenceCode/{externalReferenceCode}/accounts/{accountExternalReferenceCode}';
};
export type DeleteAccountGroupByExternalReferenceCodeAccountResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountsPageData = {
body?: never;
path?: never;
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts';
};
export type GetAccountsPageResponses = {
/**
* default response
*/
default: PageAccount;
};
export type GetAccountsPageResponse = GetAccountsPageResponses[keyof GetAccountsPageResponses];
export type PostAccountData = {
body?: Account;
path?: never;
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts';
};
export type PostAccountResponses = {
/**
* default response
*/
default: Account;
};
export type PostAccountResponse = PostAccountResponses[keyof PostAccountResponses];
export type PostAccountByExternalReferenceCodeLogoData = {
body?: MultipartBody;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/logo';
};
export type PostAccountByExternalReferenceCodeLogoResponses = {
/**
* default response
*/
default: unknown;
};
export type PostAccountGroupByExternalReferenceCodeAccountData = {
body?: Account;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accountGroups/by-externalReferenceCode/{externalReferenceCode}/accounts';
};
export type PostAccountGroupByExternalReferenceCodeAccountResponses = {
/**
* default response
*/
default: unknown;
};
export type PostAccountLogoData = {
body?: MultipartBody;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/logo';
};
export type PostAccountLogoResponses = {
/**
* default response
*/
default: unknown;
};
export type PostAccountsPageExportBatchData = {
body?: never;
path?: never;
query?: {
filter?: string;
search?: string;
sort?: string;
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/export-batch';
};
export type PostAccountsPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteAccountGroupData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accountGroups/{id}';
};
export type DeleteAccountGroupResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountGroupData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accountGroups/{id}';
};
export type GetAccountGroupResponses = {
/**
* default response
*/
default: AdminAccountGroup;
};
export type GetAccountGroupResponse = GetAccountGroupResponses[keyof GetAccountGroupResponses];
export type PatchAccountGroupData = {
body?: AdminAccountGroup;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accountGroups/{id}';
};
export type PatchAccountGroupResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteAccountGroupByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accountGroups/by-externalReferenceCode/{externalReferenceCode}';
};
export type DeleteAccountGroupByExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountGroupByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accountGroups/by-externalReferenceCode/{externalReferenceCode}';
};
export type GetAccountGroupByExternalReferenceCodeResponses = {
/**
* default response
*/
default: AdminAccountGroup;
};
export type GetAccountGroupByExternalReferenceCodeResponse = GetAccountGroupByExternalReferenceCodeResponses[keyof GetAccountGroupByExternalReferenceCodeResponses];
export type PatchAccountGroupByExternalReferenceCodeData = {
body?: AdminAccountGroup;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accountGroups/by-externalReferenceCode/{externalReferenceCode}';
};
export type PatchAccountGroupByExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountByExternalReferenceCodeAccountGroupsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/accountGroups';
};
export type GetAccountByExternalReferenceCodeAccountGroupsPageResponses = {
/**
* default response
*/
default: PageAdminAccountGroup;
};
export type GetAccountByExternalReferenceCodeAccountGroupsPageResponse = GetAccountByExternalReferenceCodeAccountGroupsPageResponses[keyof GetAccountByExternalReferenceCodeAccountGroupsPageResponses];
export type GetAccountGroupsPageData = {
body?: never;
path?: never;
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accountGroups';
};
export type GetAccountGroupsPageResponses = {
/**
* default response
*/
default: PageAdminAccountGroup;
};
export type GetAccountGroupsPageResponse = GetAccountGroupsPageResponses[keyof GetAccountGroupsPageResponses];
export type PostAccountGroupData = {
body?: AdminAccountGroup;
path?: never;
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accountGroups';
};
export type PostAccountGroupResponses = {
/**
* default response
*/
default: AdminAccountGroup;
};
export type PostAccountGroupResponse = PostAccountGroupResponses[keyof PostAccountGroupResponses];
export type GetAccountIdAccountGroupsPageData = {
body?: never;
path: {
id: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-account/v1.0/accounts/{id}/accountGroups';
};
export type GetAccountIdAccountGroupsPageResponses = {
/**
* default response
*/
default: PageAdminAccountGroup;
};
export type GetAccountIdAccountGroupsPageResponse = GetAccountIdAccountGroupsPageResponses[keyof GetAccountIdAccountGroupsPageResponses];
export type PostAccountByExternalReferenceCodeAccountMemberCreateUserData = {
body?: User;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-account/v1.0/accounts/by-externalReferenceCode/{externalReferenceCode}/accountMembers/createUser';
};
export type PostAccountByExternalReferenceCodeAccountMemberCreateUserResponses = {
/**
* default response
*/
default: User;
};
export type PostAccountByExternalReferenceCodeAccountMemberCreateUserResponse = PostAccountByExternalReferenceCodeAccountMemberCreateUserResponses[keyof PostAccountByExternalReferenceCodeAccountMemberCreateUserResponses];
export type ClientOptions = {
baseUrl: 'http://localhost:8080' | (string & {});
};