liferay-headless-rest-client/dist/clients/headless-commerce-admin-catalog-v1.0/types.gen.d.ts

A collection of Headless Clients used in Liferay Portal

export type Attachment = {
    /**
     * Base64 encoded file
     */
    attachment?: string;
    cdnEnabled?: boolean;
    cdnURL?: string;
    /**
     * Content type of attachment
     */
    contentType?: string;
    customFields?: Array<CustomField>;
    displayDate?: string;
    expirationDate?: string;
    externalReferenceCode?: string;
    fileEntryExternalReferenceCode?: string;
    fileEntryGroupExternalReferenceCode?: string;
    fileEntryId?: number;
    galleryEnabled?: boolean;
    id?: number;
    neverExpire?: boolean;
    options?: {
        [key: string]: string;
    };
    priority?: number;
    /**
     * URL of the location
     */
    src?: string;
    tags?: Array<string>;
    title?: {
        [key: string]: string;
    };
    readonly type?: number;
    readonly 'x-class-name'?: string;
};
export type CustomField = {
    readonly 'x-class-name'?: string;
    customValue?: CustomValue;
    /**
     * The field type (e.g., image, text, etc.).
     */
    readonly dataType?: string;
    /**
     * The field's internal name. This is valid for comparisons and unique in the structured content.
     */
    name?: string;
};
/**
 * The field's value.
 */
export type CustomValue = {
    readonly 'x-class-name'?: string;
    /**
     * The field's content value for simple types.
     */
    data?: {
        [key: string]: unknown;
    };
    /**
     * The localized field's content values for simple types.
     */
    data_i18n?: {
        [key: string]: string;
    };
    geo?: Geo;
};
/**
 * A point determined by latitude and longitude.
 */
export type Geo = {
    readonly 'x-class-name'?: string;
    /**
     * The latitude of a point in space.
     */
    latitude?: number;
    /**
     * The longitude of a point in space.
     */
    longitude?: number;
};
export type Facet = {
    facetCriteria?: string;
    facetValues?: Array<FacetValue>;
};
export type FacetValue = {
    numberOfOccurrences?: number;
    term?: string;
};
export type PageAttachment = {
    items?: Array<Attachment>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type AttachmentBase64 = {
    /**
     * Base64 encoded file
     */
    attachment?: string;
    /**
     * Content type of attachment
     */
    contentType?: string;
    customFields?: Array<CustomField>;
    displayDate?: string;
    expirationDate?: string;
    externalReferenceCode?: string;
    galleryEnabled?: boolean;
    readonly id?: number;
    neverExpire?: boolean;
    options?: {
        [key: string]: string;
    };
    priority?: number;
    /**
     * URL of the location
     */
    src?: string;
    tags?: Array<string>;
    title?: {
        [key: string]: string;
    };
    readonly type?: number;
    readonly 'x-class-name'?: string;
};
export type AttachmentUrl = {
    /**
     * Content type of attachment
     */
    contentType?: string;
    customFields?: Array<CustomField>;
    displayDate?: string;
    expirationDate?: string;
    externalReferenceCode?: string;
    galleryEnabled?: boolean;
    readonly id?: number;
    neverExpire?: boolean;
    options?: {
        [key: string]: string;
    };
    priority?: number;
    /**
     * URL of the location
     */
    src?: string;
    tags?: Array<string>;
    title?: {
        [key: string]: string;
    };
    readonly type?: number;
    readonly 'x-class-name'?: string;
};
export type Catalog = {
    accountId?: number;
    readonly actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    currencyCode?: string;
    currencyExternalReferenceCode?: string;
    currencyId?: number;
    defaultLanguageId?: string;
    externalReferenceCode?: string;
    readonly id?: number;
    /**
     * Category Name
     */
    name: string;
    readonly system?: boolean;
    readonly 'x-class-name'?: string;
};
export type PageCatalog = {
    items?: Array<Catalog>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type Category = {
    externalReferenceCode?: string;
    id: number;
    /**
     * Category Name
     */
    name?: string;
    siteId?: number;
    title?: {
        [key: string]: string;
    };
    readonly vocabulary?: string;
    readonly 'x-class-name'?: string;
};
export type PageCategory = {
    items?: Array<Category>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type Currency = {
    active?: boolean;
    code: string;
    externalReferenceCode?: string;
    formatPattern?: {
        [key: string]: string;
    };
    id?: number;
    maxFractionDigits?: number;
    minFractionDigits?: number;
    name: {
        [key: string]: string;
    };
    primary?: boolean;
    priority?: number;
    rate?: number;
    symbol?: string;
    readonly 'x-class-name'?: string;
    roundingMode?: 'UP' | 'DOWN' | 'CEILING' | 'FLOOR' | 'HALF_UP' | 'HALF_DOWN' | 'HALF_EVEN' | 'UNNECESSARY';
};
export type PageCurrency = {
    items?: Array<Currency>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type Diagram = {
    attachmentBase64?: AttachmentBase64;
    color?: string;
    id?: number;
    imageId?: number;
    readonly imageURL?: string;
    readonly productExternalReferenceCode?: string;
    readonly productId?: number;
    radius?: number;
    type?: string;
    readonly 'x-class-name'?: string;
};
export type GroupedProduct = {
    entryProductExternalReferenceCode?: string;
    entryProductId?: number;
    readonly entryProductName?: {
        [key: string]: string;
    };
    readonly id?: number;
    priority?: number;
    readonly productExternalReferenceCode?: string;
    readonly productId?: number;
    readonly productName?: {
        [key: string]: string;
    };
    quantity?: number;
    readonly 'x-class-name'?: string;
};
export type PageGroupedProduct = {
    items?: Array<GroupedProduct>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type LinkedProduct = {
    readonly productExternalReferenceCode?: string;
    readonly productId?: number;
    readonly type?: string;
    readonly 'x-class-name'?: string;
};
export type PageLinkedProduct = {
    items?: Array<LinkedProduct>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type ListTypeDefinition = {
    readonly actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    readonly dateCreated?: string;
    readonly dateModified?: string;
    externalReferenceCode?: string;
    readonly id?: number;
    name?: string;
    name_i18n?: {
        [key: string]: string;
    };
    system?: boolean;
    readonly 'x-class-name'?: string;
};
export type PageListTypeDefinition = {
    items?: Array<ListTypeDefinition>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type LowStockAction = {
    key?: string;
    readonly label?: {
        [key: string]: string;
    };
    readonly 'x-class-name'?: string;
};
export type PageLowStockAction = {
    items?: Array<LowStockAction>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type MappedProduct = {
    readonly actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    customFields?: Array<CustomField>;
    id?: number;
    productExternalReferenceCode?: string;
    productId?: number;
    readonly productName?: {
        [key: string]: string;
    };
    quantity?: number;
    sequence?: string;
    sku?: string;
    skuExternalReferenceCode?: string;
    skuId?: number;
    readonly 'x-class-name'?: string;
    type?: 'diagram' | 'external' | 'sku';
};
export type PageMappedProduct = {
    items?: Array<MappedProduct>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type OptionCategory = {
    description?: {
        [key: string]: string;
    };
    externalReferenceCode?: string;
    id?: number;
    key: string;
    priority?: number;
    title: {
        [key: string]: string;
    };
    readonly 'x-class-name'?: string;
};
export type PageOptionCategory = {
    items?: Array<OptionCategory>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type Option = {
    readonly actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    catalogId?: number;
    customFields?: Array<CustomField>;
    description?: {
        [key: string]: string;
    };
    externalReferenceCode?: string;
    facetable?: boolean;
    readonly id?: number;
    key: string;
    name: {
        [key: string]: string;
    };
    optionValues?: Array<OptionValue>;
    priority?: number;
    required?: boolean;
    skuContributor?: boolean;
    readonly 'x-class-name'?: string;
    fieldType: 'checkbox' | 'checkbox_multiple' | 'date' | 'document_library' | 'numeric' | 'radio' | 'select' | 'select_date' | 'text';
};
export type OptionValue = {
    readonly actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    customFields?: Array<CustomField>;
    externalReferenceCode?: string;
    readonly id?: number;
    key: string;
    name: {
        [key: string]: string;
    };
    priority?: number;
    readonly 'x-class-name'?: string;
};
export type PageOption = {
    items?: Array<Option>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type PageOptionValue = {
    items?: Array<OptionValue>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type PagePin = {
    items?: Array<Pin>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type Pin = {
    id?: number;
    mappedProduct?: MappedProduct;
    positionX?: number;
    positionY?: number;
    sequence?: string;
    readonly 'x-class-name'?: string;
};
export type ProductAccountGroup = {
    accountGroupId?: number;
    externalReferenceCode?: string;
    id?: number;
    name?: string;
    readonly 'x-class-name'?: string;
};
export type PageProductAccountGroup = {
    items?: Array<ProductAccountGroup>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type PageProductChannel = {
    items?: Array<ProductChannel>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type ProductChannel = {
    channelId?: number;
    currencyCode?: string;
    externalReferenceCode?: string;
    id?: number;
    name?: string;
    type?: string;
    readonly 'x-class-name'?: string;
};
export type AccountGroup = {
    readonly id?: number;
    name?: string;
    readonly 'x-class-name'?: string;
};
export type PageProductConfigurationListAccountGroup = {
    items?: Array<ProductConfigurationListAccountGroup>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type ProductConfigurationListAccountGroup = {
    accountGroup?: AccountGroup;
    accountGroupExternalReferenceCode?: string;
    accountGroupId: number;
    readonly actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    readonly productConfigurationListAccountGroupId?: number;
    productConfigurationListExternalReferenceCode?: string;
    productConfigurationListId: number;
    readonly 'x-class-name'?: string;
};
export type Account = {
    id?: number;
    logoId?: number;
    name?: string;
    readonly 'x-class-name'?: string;
};
export type PageProductConfigurationListAccount = {
    items?: Array<ProductConfigurationListAccount>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type ProductConfigurationListAccount = {
    account?: Account;
    accountExternalReferenceCode?: string;
    accountId: number;
    readonly actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    readonly productConfigurationListAccountId?: number;
    productConfigurationListExternalReferenceCode?: string;
    productConfigurationListId: number;
    readonly 'x-class-name'?: string;
};
export type Channel = {
    currencyCode?: string;
    externalReferenceCode?: string;
    id?: number;
    name?: string;
    siteGroupId?: number;
    type?: string;
    readonly 'x-class-name'?: string;
};
export type PageProductConfigurationListChannel = {
    items?: Array<ProductConfigurationListChannel>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type ProductConfigurationListChannel = {
    readonly actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    channel?: Channel;
    channelExternalReferenceCode?: string;
    channelId: number;
    order?: number;
    readonly productConfigurationListChannelId?: number;
    productConfigurationListExternalReferenceCode?: string;
    productConfigurationListId: number;
    readonly 'x-class-name'?: string;
};
export type OrderType = {
    readonly id?: number;
    name?: {
        [key: string]: string;
    };
    readonly 'x-class-name'?: string;
};
export type PageProductConfigurationListOrderType = {
    items?: Array<ProductConfigurationListOrderType>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type ProductConfigurationListOrderType = {
    readonly actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    orderType?: OrderType;
    orderTypeExternalReferenceCode?: string;
    orderTypeId: number;
    priority?: number;
    productConfigurationListExternalReferenceCode?: string;
    productConfigurationListId: number;
    readonly productConfigurationListOrderTypeId?: number;
    readonly 'x-class-name'?: string;
};
export type ProductConfiguration = {
    readonly actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    allowBackOrder?: boolean;
    allowedOrderQuantities?: Array<number>;
    availabilityEstimateId?: number;
    availabilityEstimateName?: {
        [key: string]: string;
    };
    differences?: Array<string>;
    displayAvailability?: boolean;
    displayStockQuantity?: boolean;
    entityExternalReferenceCode?: string;
    entityId?: number;
    entityName?: string;
    externalReferenceCode?: string;
    readonly id?: number;
    /**
     * The inventory engine that will be used to manage the product inventory
     */
    inventoryEngine?: string;
    /**
     * The low stock action that will be performed when a product is out of stock
     */
    lowStockAction?: string;
    maxOrderQuantity?: number;
    minOrderQuantity?: number;
    minStockQuantity?: number;
    multipleOrderQuantity?: number;
    productShippingConfiguration?: ProductShippingConfiguration;
    productTaxConfiguration?: ProductTaxConfiguration;
    purchasable?: boolean;
    visible?: boolean;
    readonly 'x-class-name'?: string;
    entityType?: 'product' | 'template';
};
export type ProductConfigurationList = {
    readonly actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    catalogExternalReferenceCode?: string;
    catalogId?: number;
    createDate?: string;
    displayDate?: string;
    expirationDate?: string;
    externalReferenceCode?: string;
    readonly id?: number;
    master?: boolean;
    name?: string;
    neverExpire?: boolean;
    parentProductConfigurationListId?: number;
    priority?: number;
    productConfigurations?: Array<ProductConfiguration>;
    readonly 'x-class-name'?: string;
};
export type ProductShippingConfiguration = {
    depth?: number;
    freeShipping?: boolean;
    height?: number;
    shippable?: boolean;
    shippingExtraPrice?: number;
    shippingSeparately?: boolean;
    weight?: number;
    width?: number;
    readonly 'x-class-name'?: string;
};
export type ProductTaxConfiguration = {
    id?: number;
    taxCategory?: string;
    taxable?: boolean;
    readonly 'x-class-name'?: string;
};
export type PageProductConfigurationList = {
    items?: Array<ProductConfigurationList>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type PageProductConfiguration = {
    items?: Array<ProductConfiguration>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type PageProductGroupProduct = {
    items?: Array<ProductGroupProduct>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type ProductGroupProduct = {
    id?: number;
    productExternalReferenceCode?: string;
    productGroupExternalReferenceCode?: string;
    productGroupId?: number;
    productId?: number;
    readonly productName?: string;
    sku?: string;
    readonly 'x-class-name'?: string;
};
export type ProductGroup = {
    readonly customFields?: {
        [key: string]: {
            [key: string]: unknown;
        };
    };
    description?: {
        [key: string]: string;
    };
    externalReferenceCode?: string;
    id?: number;
    products?: Array<ProductGroupProduct>;
    productsCount?: number;
    title?: {
        [key: string]: string;
    };
    readonly 'x-class-name'?: string;
};
export type PageProductGroup = {
    items?: Array<ProductGroup>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type PageProductOption = {
    items?: Array<ProductOption>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type ProductOption = {
    catalogId?: number;
    customFields?: Array<CustomField>;
    definedExternally?: boolean;
    description?: {
        [key: string]: string;
    };
    facetable?: boolean;
    fieldType: string;
    readonly id?: number;
    infoItemServiceKey?: string;
    key: string;
    name: {
        [key: string]: string;
    };
    optionExternalReferenceCode?: string;
    optionId: number;
    priceType?: string;
    priority?: number;
    productOptionValues?: Array<ProductOptionValue>;
    required?: boolean;
    skuContributor?: boolean;
    typeSettings?: string;
    readonly 'x-class-name'?: string;
};
export type ProductOptionValue = {
    deltaPrice?: number;
    readonly id?: number;
    key: string;
    name: {
        [key: string]: string;
    };
    preselected?: boolean;
    priority?: number;
    quantity?: number;
    skuExternalReferenceCode?: string;
    skuId?: number;
    readonly unitOfMeasureKey?: string;
    readonly 'x-class-name'?: string;
};
export type PageProductOptionValue = {
    items?: Array<ProductOptionValue>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type Product = {
    readonly actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    active: boolean;
    attachments?: Array<Attachment>;
    catalog?: Catalog;
    catalogExternalReferenceCode?: string;
    catalogId?: number;
    categories?: Array<Category>;
    createDate?: string;
    customFields?: Array<CustomField>;
    defaultSku?: string;
    description?: {
        [key: string]: string;
    };
    diagram?: Diagram;
    displayDate?: string;
    expando?: {
        [key: string]: {
            [key: string]: unknown;
        };
    };
    expirationDate?: string;
    externalReferenceCode?: string;
    readonly id?: number;
    images?: Array<Attachment>;
    linkedProducts?: Array<LinkedProduct>;
    mappedProducts?: Array<MappedProduct>;
    metaDescription?: {
        [key: string]: string;
    };
    metaKeyword?: {
        [key: string]: string;
    };
    metaTitle?: {
        [key: string]: string;
    };
    modifiedDate?: string;
    name: {
        [key: string]: string;
    };
    neverExpire?: boolean;
    pins?: Array<Pin>;
    productAccountGroupFilter?: boolean;
    productAccountGroups?: Array<ProductAccountGroup>;
    productChannelFilter?: boolean;
    productChannels?: Array<ProductChannel>;
    productConfiguration?: ProductConfiguration;
    readonly productId?: number;
    productOptions?: Array<ProductOption>;
    productSpecifications?: Array<ProductSpecification>;
    productStatus?: number;
    productType: string;
    readonly productTypeI18n?: string;
    productVirtualSettings?: ProductVirtualSettings;
    relatedProducts?: Array<RelatedProduct>;
    shippingConfiguration?: ProductShippingConfiguration;
    shortDescription?: {
        [key: string]: string;
    };
    readonly skuFormatted?: string;
    skus?: Array<Sku>;
    subscriptionConfiguration?: ProductSubscriptionConfiguration;
    tags?: Array<string>;
    taxConfiguration?: ProductTaxConfiguration;
    readonly thumbnail?: string;
    urls?: {
        [key: string]: string;
    };
    readonly version?: number;
    workflowStatusInfo?: Status;
    readonly 'x-class-name'?: string;
};
export type ProductSpecification = {
    externalReferenceCode?: string;
    id?: number;
    key?: string;
    label?: {
        [key: string]: string;
    };
    optionCategoryExternalReferenceCode?: string;
    optionCategoryId?: number;
    priority?: number;
    productId?: number;
    specificationExternalReferenceCode?: string;
    specificationId?: number;
    specificationKey?: string;
    specificationPriority?: number;
    value: {
        [key: string]: string;
    };
    visible?: boolean;
    readonly 'x-class-name'?: string;
};
export type ProductSubscriptionConfiguration = {
    deliverySubscriptionEnable?: boolean;
    deliverySubscriptionLength?: number;
    deliverySubscriptionNumberOfLength?: number;
    deliverySubscriptionTypeSettings?: {
        [key: string]: string;
    };
    enable?: boolean;
    length?: number;
    numberOfLength?: number;
    subscriptionTypeSettings?: {
        [key: string]: string;
    };
    readonly 'x-class-name'?: string;
    deliverySubscriptionType?: 'daily' | 'monthly' | 'weekly' | 'yearly';
    subscriptionType?: 'daily' | 'monthly' | 'weekly' | 'yearly';
};
export type ProductVirtualSettings = {
    activationStatus?: number;
    activationStatusInfo?: Status;
    /**
     * Base64 encoded file
     */
    attachment?: string;
    /**
     * Number of days to download the attachment
     */
    duration?: number;
    id?: number;
    /**
     * Number of downloads available for attachment
     */
    maxUsages?: number;
    productVirtualSettingsFileEntries?: Array<ProductVirtualSettingsFileEntry>;
    /**
     * Base64 encoded sample file
     */
    sampleAttachment?: string;
    /**
     * URL to download the sample file
     */
    readonly sampleSrc?: string;
    /**
     * URL of the sample file
     */
    sampleURL?: string;
    /**
     * URL to download the file
     */
    readonly src?: string;
    /**
     * Terms of Use content
     */
    termsOfUseContent?: {
        [key: string]: string;
    };
    /**
     * Terms of Use related Article Id
     */
    termsOfUseJournalArticleId?: number;
    /**
     * Terms of Use required
     */
    termsOfUseRequired?: boolean;
    /**
     * URL of the file
     */
    url?: string;
    /**
     * Enable sample file
     */
    useSample?: boolean;
    readonly 'x-class-name'?: string;
};
export type ProductVirtualSettingsFileEntry = {
    readonly actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    /**
     * Base64 encoded file
     */
    attachment?: string;
    readonly id?: number;
    /**
     * URL to download the file
     */
    readonly src?: string;
    /**
     * URL of the file
     */
    url?: string;
    /**
     * The version of the file
     */
    version?: string;
    readonly 'x-class-name'?: string;
};
export type RelatedProduct = {
    readonly id?: number;
    priority?: number;
    productExternalReferenceCode?: string;
    productId: number;
    type: string;
    readonly 'x-class-name'?: string;
};
export type Sku = {
    cost?: number;
    customFields?: Array<CustomField>;
    depth?: number;
    discontinued?: boolean;
    discontinuedDate?: string;
    displayDate?: string;
    expirationDate?: string;
    externalReferenceCode?: string;
    gtin?: string;
    height?: number;
    readonly id?: number;
    readonly inventoryLevel?: number;
    manufacturerPartNumber?: string;
    neverExpire?: boolean;
    price?: number;
    readonly productId?: number;
    readonly productName?: {
        [key: string]: string;
    };
    promoPrice?: number;
    published?: boolean;
    purchasable?: boolean;
    replacementSkuExternalReferenceCode?: string;
    replacementSkuId?: number;
    sku: string;
    skuOptions?: Array<SkuOption>;
    skuSubscriptionConfiguration?: SkuSubscriptionConfiguration;
    skuUnitOfMeasures?: Array<SkuUnitOfMeasure>;
    skuVirtualSettings?: SkuVirtualSettings;
    readonly unitOfMeasureKey?: string;
    readonly unitOfMeasureName?: {
        [key: string]: string;
    };
    readonly unitOfMeasureSkuId?: string;
    unspsc?: string;
    weight?: number;
    width?: number;
    readonly 'x-class-name'?: string;
};
export type SkuOption = {
    key?: string;
    optionId?: number;
    optionValueId?: number;
    value?: string;
    readonly 'x-class-name'?: string;
};
export type SkuSubscriptionConfiguration = {
    deliverySubscriptionEnable?: boolean;
    deliverySubscriptionLength?: number;
    deliverySubscriptionNumberOfLength?: number;
    deliverySubscriptionTypeSettings?: {
        [key: string]: string;
    };
    enable?: boolean;
    length?: number;
    numberOfLength?: number;
    overrideSubscriptionInfo?: boolean;
    subscriptionTypeSettings?: {
        [key: string]: string;
    };
    readonly 'x-class-name'?: string;
    deliverySubscriptionType?: 'daily' | 'monthly' | 'weekly' | 'yearly';
    subscriptionType?: 'daily' | 'monthly' | 'weekly' | 'yearly';
};
export type SkuUnitOfMeasure = {
    readonly actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    active?: boolean;
    basePrice?: number;
    readonly id?: number;
    incrementalOrderQuantity?: number;
    key?: string;
    name?: {
        [key: string]: string;
    };
    precision?: number;
    pricingQuantity?: number;
    primary?: boolean;
    priority?: number;
    promoPrice?: number;
    rate?: number;
    readonly sku?: string;
    readonly skuId?: number;
    readonly 'x-class-name'?: string;
};
export type SkuVirtualSettings = {
    activationStatus?: number;
    activationStatusInfo?: Status;
    /**
     * Base64 encoded file
     */
    attachment?: string;
    /**
     * Number of days to download the attachment
     */
    duration?: number;
    id?: number;
    /**
     * Number of downloads available for attachment
     */
    maxUsages?: number;
    /**
     * Override product virtual settings
     */
    override?: boolean;
    /**
     * Base64 encoded sample file
     */
    sampleAttachment?: string;
    /**
     * URL to download the sample file
     */
    readonly sampleSrc?: string;
    /**
     * URL of the sample file
     */
    sampleURL?: string;
    skuVirtualSettingsFileEntries?: Array<SkuVirtualSettingsFileEntry>;
    /**
     * URL to download the file
     */
    readonly src?: string;
    /**
     * Terms of Use content
     */
    termsOfUseContent?: {
        [key: string]: string;
    };
    /**
     * Terms of Use related Article Id
     */
    termsOfUseJournalArticleId?: number;
    /**
     * Terms of Use required
     */
    termsOfUseRequired?: boolean;
    /**
     * URL of the file
     */
    url?: string;
    /**
     * Enable sample file
     */
    useSample?: boolean;
    readonly 'x-class-name'?: string;
};
export type SkuVirtualSettingsFileEntry = {
    readonly actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    /**
     * Base64 encoded file
     */
    attachment?: string;
    readonly id?: number;
    /**
     * URL to download the file
     */
    readonly src?: string;
    /**
     * URL of the file
     */
    url?: string;
    /**
     * The version of the file
     */
    version?: string;
    readonly 'x-class-name'?: string;
};
export type Status = {
    readonly code?: number;
    label?: string;
    label_i18n?: string;
    readonly 'x-class-name'?: string;
};
export type PageProduct = {
    items?: Array<Product>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type PageProductSpecification = {
    items?: Array<ProductSpecification>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type PageProductVirtualSettingsFileEntry = {
    items?: Array<ProductVirtualSettingsFileEntry>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type PatchProductVirtualSettingsFileEntryRequestBody = {
    /**
     * File
     */
    file?: Blob | File;
    productVirtualSettingsFileEntry?: ProductVirtualSettingsFileEntry;
};
export type MultipartBody = {
    values?: {
        [key: string]: string;
    };
};
export type PostProductVirtualSettingIdProductVirtualSettingsFileEntryRequestBody = {
    /**
     * File
     */
    file?: Blob | File;
    productVirtualSettingsFileEntry?: ProductVirtualSettingsFileEntry;
};
export type PageRelatedProduct = {
    items?: Array<RelatedProduct>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type PageSku = {
    items?: Array<Sku>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type PageSkuUnitOfMeasure = {
    items?: Array<SkuUnitOfMeasure>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type PageSkuVirtualSettingsFileEntry = {
    items?: Array<SkuVirtualSettingsFileEntry>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type PatchSkuVirtualSettingsFileEntryRequestBody = {
    /**
     * File
     */
    file?: Blob | File;
    skuVirtualSettingsFileEntry?: SkuVirtualSettingsFileEntry;
};
export type PostSkuVirtualSettingIdSkuVirtualSettingsFileEntryRequestBody = {
    /**
     * File
     */
    file?: Blob | File;
    skuVirtualSettingsFileEntry?: SkuVirtualSettingsFileEntry;
};
export type Specification = {
    description?: {
        [key: string]: string;
    };
    externalReferenceCode?: string;
    facetable?: boolean;
    readonly id?: number;
    key: string;
    /**
     * @deprecated
     */
    listTypeDefinitionId?: number;
    listTypeDefinitionIds?: Array<number>;
    optionCategory?: OptionCategory;
    priority?: number;
    title: {
        [key: string]: string;
    };
    visible?: boolean;
    readonly 'x-class-name'?: string;
};
export type PageSpecification = {
    items?: Array<Specification>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type DeleteAttachmentData = {
    body?: never;
    path: {
        id: string;
    };
    query?: never;
    url: '/o/headless-commerce-admin-catalog/v1.0/attachment/{id}';
};
export type DeleteAttachmentResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type DeleteAttachmentBatchData = {
    body?: {
        [key: string]: unknown;
    };
    path?: never;
    query?: {
        callbackURL?: string;
    };
    url: '/o/headless-commerce-admin-catalog/v1.0/attachment/batch';
};
export type DeleteAttachmentBatchResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type DeleteAttachmentByExternalReferenceCodeData = {
    body?: never;
    path: {
        externalReferenceCode: string;
    };
    query?: never;
    url: '/o/headless-commerce-admin-catalog/v1.0/attachment/by-externalReferenceCode/{externalReferenceCode}';
};
export type DeleteAttachmentByExternalReferenceCodeResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type GetAttachmentByExternalReferenceCodeData = {
    body?: never;
    path: {
        externalReferenceCode: string;
    };
    query?: never;
    url: '/o/headless-commerce-admin-catalog/v1.0/attachment/by-externalReferenceCode/{externalReferenceCode}';
};
export type GetAttachmentByExternalReferenceCodeResponses = {
    /**
     * default response
     */
    default: Attachment;
};
export type GetAttachmentByExternalReferenceCodeResponse = GetAttachmentByExternalReferenceCodeResponses[keyof GetAttachmentByExternalReferenceCodeResponses];
export type PatchAttachmentByExternalReferenceCodeData = {
    body?: Attachment;
    path: {
        externalReferenceCode: string;
    };
    query?: never;
    url: '/o/headless-commerce-admin-catalog/v1.0/attachment/by-externalReferenceCode/{externalReferenceCode}';
};
export type PatchAttachmentByExternalReferenceCodeResponses = {
    /**
     * default response
     */
    default: Attachment;
};
export type PatchAttachmentByExternalReferenceCodeResponse = PatchAttachmentByExternalReferenceCodeResponses[keyof PatchAttachmentByExternalReferenceCodeResponses];
export type PutAttachmentByExternalReferenceCodeData = {
    body?: Attachment;
    path: {
        externalReferenceCode: string;
    };
    query?: never;
    url: '/o/headless-commerce-admin-catalog/v1.0/attachment/by-externalReferenceCode/{externalReferenceCode}';
};
export type PutAttachmentByExternalReferenceCodeResponses = {
    /**
     * default response
     */
    default: Attachment;
};
export type PutAttachmentByExternalReferenceCodeResponse = PutAttachmentByExternalReferenceCodeResponses[keyof PutAttachmentByExternalReferenceCodeResponses];
export type GetProductByExternalReferenceCodeAttachmentsPageData = {
    body?: never;
    path: {
        externalReferenceCode: string;
    };
    query?: {
        page?: string;
        pageSize?: string;
        nestedFields?: string;
    };
    url: '/o/headless-commerce-admin-catalog/v1.0/products/by-externalReferenceCode/{externalReferenceCode}/attachments';
};
export type GetProductByExternalReferenceCodeAttachmentsPageResponses = {
    /**
     * default response
     */
    default: PageAttachment;
};
export type GetProductByExternalReferenceCodeAttachmentsPageResponse = GetProductByExternalReferenceCodeAttachmentsPageResponses[keyof GetProductByExternalReferenceCodeAttachmentsPageResponses];
export type PostProductByExternalReferenceCodeAttachmentData = {
    body?: Attachment;
    path: {
        externalReferenceCode: string;
    };
    query?: never;
    url: '/o/headless-commerce-admin-catalog/v1.0/products/by-externalReferenceCode/{externalReferenceCode}/attachments';
};
export type PostProductByExternalReferenceCodeAttachmentResponses = {
    /**
     * default response
     */
    default: Attachment;
};
export type PostProductByExternalReferenceCodeAttachmentResponse = PostProductByExternalReferenceCodeAttachmentResponses[keyof PostProductByExternalReferenceCodeAttachmentResponses];
export type GetProductByExternalReferenceCodeImagesPageData = {
    body?: never;
    path: {
        externalReferenceCode: string;
    };
    query?: {
        page?: string;
        pageSize?: string;
        nestedFields?: string;
    };
    url: '/o/headless-commerce-admin-catalog/v1.0/products/by-externalReferenceCode/{externalReferenceCode}/images';
};
export type GetProductByExternalReferenceCodeImagesPageResponses = {
    /**
     * default response
     */
    default: PageAttachment;
};
export type GetProductByExternalReferenceCodeImagesPageResponse = GetProductByExternalReferenceCodeImagesPageResponses[keyof GetProductByExternalReferenceCodeImagesPageResponses];
export type PostProductByExternalReferenceCodeImageData = {
    body?: Attachment;
    path: {
        externalReferenceCode: string;
    };
    query?: never;
    url: '/o/headless-commerce-admin-catalog/v1.0/products/by-externalReferenceCode/{externalReferenceCode}/images';
};
export type PostProductByExternalReferenceCodeImageResponses = {
    /**
     * default response
     */
    default: Attachment;
};
export type PostProductByExternalReferenceCodeImageResponse = PostProductByExternalReferenceCodeImageResponses[keyof PostProductByExternalReferenceCodeImageResponses];
export type GetProductIdAttachmentsPageData = {
    body?: never;
    path: {
        id: string;
    };
    query?: {
        page?: string;
        pageSize?: string;
        nestedFields?: string;
    };
    url: '/o/headless-commerce-admin-catalog/v1.0/products/{id}/attachments';
};
export type GetProductIdAttachmentsPageResponses = {
    /**
     * default response
     */
    default: PageAttachment;
};
export type GetProductIdAttachmentsPageResponse = GetProductIdAttachmentsPageResponses[keyof GetProductIdAttachmentsPageResponses];
export type PostProductIdAttachmentData = {
    body?: Attachment;
    path: {
        id: string;
    };
    query?: never;
    url: '/o/headless-commerce-admin-catalog/v1.0/products/{id}/attachments';
};
export type PostProductIdAttachmentResponses = {
    /**
     * default response
     */
    default: Attachment;
};
export type PostProductIdAttachmentResponse = PostProductIdAttachmentResponses[keyof PostProductIdAttachmentResponses];
export type GetProductIdImagesPageData = {
    body?: never;
    path: {
        id: string;
    };
    query?: {
        page?: string;
        pageSize?: string;
        nestedFields?: string;
    };
    url: '/o/headless-commerce-admin-catalog/v1.0/products/{id}/images';
};
export type GetProductIdImagesPageResponses = {
    /**
     * default response
     */
    default: PageAttachment;
};
export type GetProductIdImagesPageResponse = GetProductIdImagesPageResponses[keyof GetProductIdImagesPageResponses];
export type PostProductIdImageData = {
    body?: Attachment;
    path: {
        id: string;
    };
    query?: never;
    url: '/o/headless-commerce-admin-catalog/v1.0/products/{id}/images';
};
export type PostProductIdImageResponses = {
    /**
     * default response
     */
    default: Attachment;
};
export type PostProductIdImageResponse = PostProductIdImageResponses[keyof PostProductIdImageResponses];
export type PostProductByExternalReferenceCodeAttachmentByBase64Data = {
    body?: AttachmentBase64;
    path: {
        externalReferenceCode: string;
    };
    query?: never;
    url: '/o/headless-commerce-admin-catalog/v1.0/products/by-externalReferenceCode/{externalReferenceCode}/attachments/by-base64';
};
export type PostProductByExternalReferenceCodeAttachmentByBase64Responses = {
    /**
     * default response
     */
    default: Attachment;
};
export type PostProductByExternalReferenceCodeAttachmentByBase64Response = PostProductByExternalReferenceCodeAttachmentByBase64Responses[keyof PostProductByExternalReferenceCodeAttachmentByBase64Responses];
export type PostProductByExternalReferenceCodeAttachmentByUrlData = {
    body?: AttachmentUrl;
    path: {
        externalReferenceCode: string;
    };
    query?: never;
    url: '/o/headless-commerce-admin-catalog/v1.0/products/by-externalReferenceCode/{externalReferenceCode}/attachments/by-url';
};
export type PostProductByExternalReferenceCodeAttachmentByUrlResponses = {
    /**
     * default response
     */
    default: Attachment;
};
export type PostProductByExternalReferenceCodeAttachmentByUrlResponse = PostProductByExternalReferenceCodeAttachmentByUrlResponses[keyof PostProductByExternalReferenceCodeAttachmentByUrlResponses];
export type PostProductByExternalReferenceCodeImageByBase64Data = {
    body?: AttachmentBase64;
    path: {
        externalReferenceCode: string;
    };
    query?: never;
    url: '/o/headless-commerce-admin-catalog/v1.0/products/by-externalReferenceCode/{externalReferenceCode}/images/by-base64';
};
export type PostProductByExternalReferenceCodeImageByBase64Responses = {
    /**
     * default response
     */
    default: Attachment;
};
export type PostProductByExternalReferenceCodeImageByBase64Response = PostProductByExternalReferenceCodeImageByBase64Responses[keyof PostProductByExternalReferenceCodeImageByBase64Responses];
export type PostProductByExternalReferenceCodeImageByUrlData = {
    body?: AttachmentUrl;
    path: {
        externalReferenceCode: string;
    };
    query?: never;
    url: '/o/headless-commerce-admin-catalog/v1.0/products/by-externalReferenceCode/{externalReferenceCode}/images/by-url';
};
export type PostProductByExternalReferenceCodeImageByUrlResponses = {
    /**
     * default response
     */
    default: Attachment;
};
export type PostProductByExternalReferenceCodeImageByUrlResponse = PostProductByExternalReferenceCodeImageByUrlResponses[keyof PostProductByExternalReferenceCodeImageByUrlResponses];
export type PostProductIdAttachmentBatchData = {
    body?: {
        [key: string]: unknown;
    };
    path?: never;
    query?: {
        callbackURL?: string;
    };
    url: '/o/headless-commerce-admin-catalog/v1.0/products/attachments/batch';
};
export type PostProductIdAttachmentBatchResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type PostProductIdAttachmentByBase64Data = {
    body?: AttachmentBase64;
    path: {
        id: string;
    };
    query?: never;
    url: '/o/headless-commerce-admin-catalog/v1.0/products/{id}/attachments/by-base64';
};
export type PostProductIdAttachmentByBase64Responses = {
    /**
     * default response
     */
    default: Attachment;
};
export type PostProductIdAttachmentByBase64Response = PostProductIdAttachmentByBase64Responses[keyof PostProductIdAttachmentByBase64Responses];
export type PostProductIdAttachmentByUrlData = {
    body?: AttachmentUrl;
    path: {
        id: string;
    };
    query?: never;
    url: '/o/headless-commerce-admin-catalog/v1.0/products/{id}/attachments/by-url';
};
export type PostProductIdAttachmentByUrlResponses = {
    /**
     * default response
     */
    default: Attachment;
};
export type PostProductIdAttachmentByUrlResponse = PostProductIdAttachmentByUrlResponses[keyof PostProductIdAttachmentByUrlResponses];
export type PostProductIdImageByBase64Data = {
    body?: AttachmentBase64;
    path: {
        id: string;
    };
    query?: never;
    url: '/o/headless-commerce-admin-catalog/v1.0/products/{id}/images/by-base64';
};
export type PostProductIdImageByBase64Responses = {
    /**
     * default response
     */
    default: Attachment;
};
export type PostProductIdImageByBase64Response = PostProductIdImageByBase64Responses[keyof PostProductIdImageByBase64Responses];
export type PostProductIdImageByUrlData = {
    body?: AttachmentUrl;
    path: {
        id: string;
    };
    query?: never;
    url: '/o/headless-commerce-admin-catalog/v1.0/products/{id}/images/by-url';
};
export type PostProductIdImageByUrlResponses = {
    /**
     * default response
     */
    default: Attachment;
};
export type PostProductIdImageByUrlResponse = PostProductIdImageByUrlResponses[keyof PostProductIdImageByUrlResponses];
export type DeleteCatalogData = {
    body?: never;
    path: {
        id: string;
    };
    query?: never;
    url: '/o/headless-commerce-admin-catalog/v1.0/catalog/{id}';
};
export type DeleteCatalogResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type GetCatalogData = {
    body?: never;
    path: {
        id: string;
    };
    query?: never;
    url: '/o/headless-commerce-admin-catalog/v1.0/catalog/{id}';
};
export type GetCatalogResponses = {
    /**
     * default response
     */
    default: Catalog;
};
export type GetCatalogResponse = GetCatalogResponses[keyof GetCatalogResponses];
export type PatchCatalogData = {
    body?: Catalog;
    path: {
        id: string;
    };
    query?: never;
    url: '/o/headless-commerce-admin-catalog/v1.0/catalog/{id}';
};
export type PatchCatalogResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type DeleteCatalogBatchData = {
    body?: {
        [key: string]: unknown;
    };
    path?: never;
    query?: {
        callbackURL?: string;
    };
    url: '/o/headless-commerce-admin-catalog/v1.0/catalog/batch';
};
export type DeleteCatalogBatchResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type DeleteCatalogByExternalReferenceCodeData = {
    body?: never;
    path: {
        externalReferenceCode: string;
    };
    query?: never;
    url: '/o/headless-commerce-admin-catalog/v1.0/catalog/by-externalReferenceCode/{externalReferenceCode}';
};
export type DeleteCatalogByExternalReferenceCodeResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type GetCatalogByExternalReferenceCodeData = {
    body?: never;
    path: {
        externalReferenceCode: string;
    };
    query?: never;
    url: '/o/headless-commerce-admin-catalog/v1.0/catalog/by-externalReferenceCode/{externalReferenceCode}';
};
export type GetCatalogByExternalReferenceCodeResponses = {
    /**
     * default response
     */
    default: Catalog;
};
export type GetCatalogByExternalReferenceCodeResponse = GetCatalogByExternalReferenceCodeResponses[keyof GetCatalogByExternalReferenceCodeResponses];
export type PatchCatalogByExternalReferenceCodeData = {
    body?: Catalog;
    path: {
        externalReferenceCode: string;
    };
    query?: never;
    url: '/o/headless-commerce-admin-catalog/v1.0/catalog/by-externalReferenceCode/{externalReferenceCode}';
};
export type PatchCatalogByExternalReferenceCodeResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type PutCatalogBy