@wix/stores 1.0.4 → 1.0.6

package/build/es/src/stores-poc-v1-product.universal.d.ts

@@ -1,549 +0,0 @@
-export declare const __debug: {
-    verboseLogging: {
-        on: () => boolean;
-        off: () => boolean;
-    };
-};
-export interface Product {
-    /**
-     * Product ID (generated automatically by the catalog).
-     * @readonly
-     */
-    _id?: string;
-    /** Product name. */
-    name?: string | null;
-    /** A friendly URL name (generated automatically by the catalog when a product is created), can be updated. */
-    slug?: string;
-    /** Whether the product is visible to site visitors. */
-    visible?: boolean | null;
-    /** Currently, only creating physical products ( `"productType": "physical"` ) is supported via the API. */
-    productType?: ProductType;
-    /** Product description. Accepts [rich text](https://dev.wix.com/api/rest/wix-stores/rich-text). */
-    description?: string | null;
-    /** Stock keeping unit (if variant management is enabled, SKUs will be set per variant, and this field will be empty). */
-    sku?: string | null;
-    /** Product weight (if variant management is enabled, weight will be set per variant, and this field will be empty). */
-    weight?: number | null;
-    /**
-     * Product weight range. The minimum and maximum weights of all the variants.
-     * com.wix.ecommerce.catalog_spi.api.v1.NumericPropertyRange weight_range = 32 [(wix.api.readOnly) = true];
-     * Product inventory status (in future this will be writable via Inventory API).
-     * @readonly
-     */
-    stock?: Stock;
-    /**
-     * Deprecated (use `priceData` instead).
-     * @readonly
-     */
-    price?: PriceData;
-    /** Price data. */
-    priceData?: PriceData;
-    /**
-     * Price data, converted to the currency specified in request header.
-     * @readonly
-     */
-    convertedPriceData?: PriceData;
-    /**
-     * Product price range. The minimum and maximum prices of all the variants.
-     * com.wix.ecommerce.catalog_spi.api.v1.NumericPropertyRange price_range = 31 [(wix.api.readOnly) = true];
-     * Cost and profit data.
-     */
-    costAndProfitData?: CostAndProfitData;
-    /**
-     * Product cost range. The minimum and maximum costs of all the variants.
-     * com.wix.ecommerce.catalog_spi.api.v1.NumericPropertyRange cost_range = 33 [(wix.api.readOnly) = true];
-     * Price per unit data.
-     */
-    pricePerUnitData?: PricePerUnitData;
-    /**
-     * Additional text that the store owner can assign to the product (e.g. shipping details, refund policy, etc.). Currently writable only from the UI.
-     * @readonly
-     */
-    additionalInfoSections?: AdditionalInfoSection[];
-    /**
-     * Deprecated (use `ribbon` instead).
-     * @readonly
-     */
-    ribbons?: Ribbon[];
-    /**
-     * Media items (images, videos etc) associated with this product (writable via [Add Product Media](https://dev.wix.com/api/rest/wix-stores/catalog/products/add-product-media) endpoint).
-     * @readonly
-     */
-    media?: Media;
-    /**
-     * Text box for the customer to add a message to their order (e.g., customization request). Currently writable only from the UI.
-     * @readonly
-     */
-    customTextFields?: CustomTextField[];
-    /** Whether variants are being managed for this product - enables unique SKU, price and weight per variant. Also affects inventory data. */
-    manageVariants?: boolean | null;
-    /** Options (color, size, etc) for this product. */
-    productOptions?: ProductOption[];
-    /**
-     * Product page URL for this product (generated automatically by the server).
-     * @readonly
-     */
-    productPageUrl?: PageUrl;
-    /**
-     * Product’s unique numeric ID (assigned in ascending order).
-     * Primarily used for sorting and filtering when crawling all products.
-     * @readonly
-     */
-    numericId?: string;
-    /**
-     * Inventory item ID - ID referencing the inventory system.
-     * @readonly
-     */
-    inventoryItemId?: string;
-    /** Discount deducted from the product's original price. */
-    discount?: Discount;
-    /**
-     * A list of all collection IDs that this product is included in (writable via the Catalog > Collection APIs).
-     * @readonly
-     */
-    collectionIds?: string[];
-    /**
-     * Product variants, will be provided if the the request was sent with the includeVariants flag.
-     * @readonly
-     */
-    variants?: Variant[];
-    /**
-     * Date and time the product was last updated.
-     * google.protobuf.Timestamp last_updated = 24 [(wix.api.readOnly) = true];
-     * Date and time the product was created.
-     * google.protobuf.Timestamp created_date = 34 [(wix.api.readOnly) = true];
-     * Custom SEO data for the product.
-     * com.wixpress.advanced.seo.SeoSchema seo_data = 27;
-     * Product ribbon. Used to highlight relevant information about a product. For example, "Sale", "New Arrival", "Sold Out".
-     */
-    ribbon?: string | null;
-    /** Product brand. Including a brand name can help improve site and product [visibility on search engines](https://support.wix.com/en/article/adding-brand-names-to-boost-product-page-seo-in-wix-stores). */
-    brand?: string | null;
-}
-export declare enum ProductType {
-    unspecified_product_type = "unspecified_product_type",
-    physical = "physical",
-    digital = "digital"
-}
-export interface Stock {
-    /** Whether inventory is being tracked */
-    trackInventory?: boolean;
-    /** Quantity currently left in inventory */
-    quantity?: number | null;
-    /**
-     * Whether the product is currently in stock (relevant only when tracking manually)
-     * Deprecated (use `inventoryStatus` instead)
-     */
-    inStock?: boolean;
-    /**
-     * The current status of the inventory
-     * + `IN_STOCK` - In stock
-     * + `OUT_OF_STOCK` - Not in stock
-     * + `PARTIALLY_OUT_OF_STOCK` - Some of the variants are not in stock
-     */
-    inventoryStatus?: InventoryStatus;
-}
-export declare enum InventoryStatus {
-    IN_STOCK = "IN_STOCK",
-    OUT_OF_STOCK = "OUT_OF_STOCK",
-    PARTIALLY_OUT_OF_STOCK = "PARTIALLY_OUT_OF_STOCK"
-}
-export interface PriceData {
-    /**
-     * Product price currency
-     * @readonly
-     */
-    currency?: string;
-    /** Product price */
-    price?: number | null;
-    /**
-     * Discounted product price (if no discounted price is set, the product price is returned)
-     * @readonly
-     */
-    discountedPrice?: number;
-    /**
-     * The product price and discounted price, formatted with the currency
-     * @readonly
-     */
-    formatted?: FormattedPrice;
-    /**
-     * Price per unit
-     * @readonly
-     */
-    pricePerUnit?: number | null;
-}
-export interface FormattedPrice {
-    /** Product price formatted with the currency */
-    price?: string;
-    /** Discounted product price formatted with the currency (if no discounted price is set, the product formatted price is returned) */
-    discountedPrice?: string;
-    /**
-     * Price per unit
-     * @readonly
-     */
-    pricePerUnit?: string | null;
-}
-export interface CostAndProfitData {
-    /** Item cost. */
-    itemCost?: number | null;
-    /**
-     * Item cost formatted with currency symbol.
-     * @readonly
-     */
-    formattedItemCost?: string;
-    /**
-     * Profit. Calculated by reducing `cost` from `discounted_price`.
-     * @readonly
-     */
-    profit?: number;
-    /**
-     * Profit formatted with currency symbol.
-     * @readonly
-     */
-    formattedProfit?: string;
-    /**
-     * Profit Margin. Calculated by dividing `profit` by `discounted_price`.
-     * The result is rounded to 4 decimal places.
-     * @readonly
-     */
-    profitMargin?: number;
-}
-export interface PricePerUnitData {
-    /** Total quantity */
-    totalQuantity?: number;
-    /** Total measurement unit */
-    totalMeasurementUnit?: MeasurementUnit;
-    /** Base quantity */
-    baseQuantity?: number;
-    /** Base measurement unit */
-    baseMeasurementUnit?: MeasurementUnit;
-}
-export declare enum MeasurementUnit {
-    UNSPECIFIED = "UNSPECIFIED",
-    ML = "ML",
-    CL = "CL",
-    L = "L",
-    CBM = "CBM",
-    MG = "MG",
-    G = "G",
-    KG = "KG",
-    MM = "MM",
-    CM = "CM",
-    M = "M",
-    SQM = "SQM",
-    OZ = "OZ",
-    LB = "LB",
-    FLOZ = "FLOZ",
-    PT = "PT",
-    QT = "QT",
-    GAL = "GAL",
-    IN = "IN",
-    FT = "FT",
-    YD = "YD",
-    SQFT = "SQFT"
-}
-export interface AdditionalInfoSection {
-    /** Product info section title */
-    title?: string;
-    /** Product info section description */
-    description?: string;
-}
-export interface Ribbon {
-    /** Ribbon text */
-    text?: string;
-}
-export interface Media {
-    /** Primary media (image, video etc) associated with this product. */
-    mainMedia?: MediaItem;
-    /** Media (images, videos etc) associated with this product. */
-    items?: MediaItem[];
-}
-export interface MediaItem extends MediaItemItemOneOf {
-    /** Media item thumbnail details. */
-    thumbnail?: MediaItemUrlAndSize;
-    /** Media item type (image, video, etc.). */
-    mediaType?: MediaItemType;
-    /** Media item title. */
-    title?: string;
-    /** Media ID (for example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`). */
-    _id?: string;
-    /** Image data (URL, size). */
-    image?: MediaItemUrlAndSize;
-    /** Video data (URL, size). */
-    video?: MediaItemVideo;
-}
-/** @oneof */
-export interface MediaItemItemOneOf {
-    /** Image data (URL, size). */
-    image?: MediaItemUrlAndSize;
-    /** Video data (URL, size). */
-    video?: MediaItemVideo;
-}
-export interface MediaItemUrlAndSize {
-    /** Media item URL. */
-    url?: string;
-    /** Media item width. */
-    width?: number;
-    /** Media item height. */
-    height?: number;
-    /** Media format (mp4, png, etc.). */
-    format?: string | null;
-    /** Alt text. This text will be shown in case the image is not available. */
-    altText?: string | null;
-}
-export declare enum MediaItemType {
-    unspecified_media_item_type = "unspecified_media_item_type",
-    image = "image",
-    video = "video",
-    audio = "audio",
-    document = "document",
-    zip = "zip"
-}
-export interface MediaItemVideo {
-    /** Data (URL, size) about each resolution for which this video is available. */
-    files?: MediaItemUrlAndSize[];
-    /** ID of an image taken from the video. Used primarily for Wix Search indexing. For example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`. */
-    stillFrameMediaId?: string;
-}
-export interface CustomTextField {
-    /** Text box title */
-    title?: string;
-    /** Text box input max length */
-    maxLength?: number;
-    /** Whether this text box is mandatory */
-    mandatory?: boolean;
-}
-export interface ProductOption {
-    /**
-     * Option type - color or other(drop down)
-     * @readonly
-     */
-    optionType?: OptionType;
-    /** Option name (e.g., color, size) */
-    name?: string;
-    /** Choices available for this option */
-    choices?: Choice[];
-}
-export declare enum OptionType {
-    unspecified_option_type = "unspecified_option_type",
-    drop_down = "drop_down",
-    color = "color"
-}
-export interface Choice {
-    /** Color hex value or choice name */
-    value?: string;
-    /** Choice name */
-    description?: string;
-    /**
-     * Media items (images, videos) associated with this choice
-     * @readonly
-     */
-    media?: Media;
-    /**
-     * Based on the customer’s choices, which (if any) variants that include the selected choices are in stock
-     * @readonly
-     */
-    inStock?: boolean;
-    /**
-     * Based on the customer’s choices, which (if any) variants that include the selected choices are visible
-     * @readonly
-     */
-    visible?: boolean;
-}
-export interface PageUrl {
-    /** Base URL. For premium sites, this is the domain. For free sites, this is the site URL (e.g mysite.wixsite.com/mysite). */
-    base?: string;
-    /** Path to the product page - e.g /product-page/a-product. */
-    path?: string;
-}
-export interface Discount {
-    /** Discount type: amount / percent */
-    type?: DiscountType;
-    /** Discount value */
-    value?: number;
-}
-export declare enum DiscountType {
-    UNDEFINED = "UNDEFINED",
-    /** No discount */
-    NONE = "NONE",
-    AMOUNT = "AMOUNT",
-    PERCENT = "PERCENT"
-}
-export interface Variant {
-    /** Requested Variant ID */
-    _id?: string;
-    /** Specific choices within a selection, as option-choice key-value pairs */
-    choices?: Record<string, string>;
-    variant?: VariantDataWithNoStock;
-    /**
-     * Variant inventory status.
-     * @readonly
-     */
-    stock?: VariantStock;
-}
-export interface VariantDataWithNoStock {
-    /** Variant price. */
-    priceData?: PriceData;
-    /**
-     * Variant price data, converted to currency requested in header.
-     * @readonly
-     */
-    convertedPriceData?: PriceData;
-    /** Cost and profit data. */
-    costAndProfitData?: CostAndProfitData;
-    /** Variant weight. */
-    weight?: number;
-    /** Variant SKU (stock keeping unit). */
-    sku?: string;
-    /** Whether the variant is visible to customers. */
-    visible?: boolean;
-}
-export interface VariantStock {
-    /** Whether inventory is being tracked. */
-    trackQuantity?: boolean;
-    /** Quantity currently left in inventory. */
-    quantity?: number | null;
-    /** Whether the product is currently in stock (relevant only when tracking manually). */
-    inStock?: boolean;
-}
-export interface GetProductRequest {
-    /** Requested product ID. */
-    productId: string;
-    /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
-    includeMerchantSpecificData?: boolean;
-}
-export interface GetProductResponse {
-    /** Requested product data. */
-    product?: Product;
-}
-export interface QueryProductsRequest {
-    query?: PlatformQuery;
-    /** Whether variants should be included in the response. */
-    includeVariants?: boolean;
-    /** Whether hidden products should be included in the response. Requires permissions to manage products. */
-    includeHiddenProducts?: boolean;
-    /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
-    includeMerchantSpecificData?: boolean;
-}
-export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
-    /** Filter object. */
-    filter?: Record<string, any> | null;
-    /** Sorting options. For example, `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]`. */
-    sort?: Sorting[];
-    /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
-    paging?: PlatformPaging;
-}
-/** @oneof */
-export interface PlatformQueryPagingMethodOneOf {
-    /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
-    paging?: PlatformPaging;
-}
-export interface Sorting {
-    /** Name of the field to sort by. */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrder;
-}
-export declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-export interface PlatformPaging {
-    /** Number of items to load. */
-    limit?: number | null;
-    /** Number of items to skip in the current sort order. */
-    offset?: number | null;
-}
-export interface QueryProductsResponse {
-    products?: Product[];
-    metadata?: PlatformPagingMetadata;
-}
-export interface PlatformPagingMetadata {
-    /** The number of items returned in this response. */
-    count?: number | null;
-    /** The offset which was requested. Returned if offset paging was used. */
-    offset?: number | null;
-    /** The total number of items that match the query. Returned if offset paging was used. */
-    total?: number | null;
-    /** Cursors to navigate through result pages. Returned if cursor paging was used. */
-    cursors?: Cursors;
-}
-export interface Cursors {
-    /** Cursor pointing to next page in the list of results. */
-    next?: string | null;
-    /** Cursor pointing to previous page in the list of results. */
-    prev?: string | null;
-}
-/** @param productId - Requested product ID.
- * @public
- * @requiredField productId
- * @returns Requested product data.
- */
-export declare function getProduct(productId: string, options?: GetProductOptions): Promise<Product>;
-export interface GetProductOptions {
-    /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
-    includeMerchantSpecificData?: boolean;
-}
-/** @public */
-export declare function queryProducts(): ProductsQueryBuilder;
-interface QueryOffsetResult {
-    currentPage: number;
-    totalPages: number;
-    totalCount: number;
-    hasNext: () => boolean;
-    hasPrev: () => boolean;
-    length: number;
-    pageSize: number;
-}
-export interface ProductsQueryResult extends QueryOffsetResult {
-    items: Product[];
-    query: ProductsQueryBuilder;
-    next: () => Promise<ProductsQueryResult>;
-    prev: () => Promise<ProductsQueryResult>;
-}
-export interface ProductsQueryBuilder {
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     */
-    eq: (propertyName: string, value: any) => ProductsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     */
-    ne: (propertyName: string, value: any) => ProductsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     */
-    ge: (propertyName: string, value: any) => ProductsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     */
-    gt: (propertyName: string, value: any) => ProductsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     */
-    le: (propertyName: string, value: any) => ProductsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     */
-    lt: (propertyName: string, value: any) => ProductsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `string`.
-     * @param string - String to compare against. Case-insensitive.
-     */
-    startsWith: (propertyName: string, value: string) => ProductsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `values`.
-     * @param values - List of values to compare against.
-     */
-    hasSome: (propertyName: string, value: any[]) => ProductsQueryBuilder;
-    in: (propertyName: string, value: any) => ProductsQueryBuilder;
-    exists: (propertyName: string, value: boolean) => ProductsQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
-    ascending: (...propertyNames: string[]) => ProductsQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
-    descending: (...propertyNames: string[]) => ProductsQueryBuilder;
-    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
-    limit: (limit: number) => ProductsQueryBuilder;
-    /** @param skip - Number of items to skip in the query results before returning the results. */
-    skip: (skip: number) => ProductsQueryBuilder;
-    find: () => Promise<ProductsQueryResult>;
-}
-export {};