@medusajs/types 1.12.0-snapshot-20241016111629 → 2.0.0-preview-20241022094107

package/dist/http/product/common.d.ts

@@ -7,75 +7,274 @@ import { BaseProductTag } from "../product-tag/common";
 import { BaseProductType } from "../product-type/common";
 export type ProductStatus = "draft" | "proposed" | "published" | "rejected";
 export interface BaseProduct {
+    /**
+     * The product's ID.
+     */
     id: string;
+    /**
+     * The product's title.
+     */
     title: string;
+    /**
+     * The product's handle.
+     */
     handle: string;
+    /**
+     * The product's subtitle.
+     */
     subtitle: string | null;
+    /**
+     * The product's description.
+     */
     description: string | null;
+    /**
+     * Whether the product is a gift card.
+     */
     is_giftcard: boolean;
+    /**
+     * The product's status.
+     */
     status: ProductStatus;
+    /**
+     * The product's thumbnail.
+     */
     thumbnail: string | null;
+    /**
+     * The product's width.
+     */
     width: number | null;
+    /**
+     * The product's weight.
+     */
     weight: number | null;
+    /**
+     * The product's length.
+     */
     length: number | null;
+    /**
+     * The product's height.
+     */
     height: number | null;
+    /**
+     * The product's origin country.
+     */
     origin_country: string | null;
+    /**
+     * The product's HS code.
+     */
     hs_code: string | null;
+    /**
+     * The product's MID code.
+     */
     mid_code: string | null;
+    /**
+     * The product's material.
+     */
     material: string | null;
+    /**
+     * The product's collection.
+     */
     collection?: BaseCollection | null;
+    /**
+     * The ID of the associated product collection.
+     */
     collection_id: string | null;
+    /**
+     * The product's categories.
+     */
     categories?: BaseProductCategory[] | null;
+    /**
+     * The product's type.
+     */
     type?: BaseProductType | null;
+    /**
+     * The ID of the associated product type.
+     */
     type_id: string | null;
+    /**
+     * The product's tags.
+     */
     tags?: BaseProductTag[] | null;
+    /**
+     * The product's variants.
+     */
     variants: BaseProductVariant[] | null;
+    /**
+     * The product's options.
+     */
     options: BaseProductOption[] | null;
+    /**
+     * The product's images.
+     */
     images: BaseProductImage[] | null;
+    /**
+     * Whether the product is discountable.
+     */
     discountable: boolean;
+    /**
+     * The ID of the product in external systems.
+     */
     external_id: string | null;
+    /**
+     * The date the product was created.
+     */
     created_at: string | null;
+    /**
+     * The date the product was update.
+     */
     updated_at: string | null;
+    /**
+     * The date the product was deleted.
+     */
     deleted_at: string | null;
+    /**
+     * Key-value pairs of custom data.
+     */
     metadata?: Record<string, unknown> | null;
 }
 export interface BaseProductVariant {
+    /**
+     * The variant's ID.
+     */
     id: string;
+    /**
+     * The variant's title.
+     */
     title: string | null;
+    /**
+     * The variant's SKU.
+     */
     sku: string | null;
+    /**
+     * The variant's barcode.
+     */
     barcode: string | null;
+    /**
+     * The variant's EAN.
+     */
     ean: string | null;
+    /**
+     * The variant's UPC.
+     */
     upc: string | null;
+    /**
+     * Whether the variant can be ordered even if it's out of stock.
+     */
     allow_backorder: boolean | null;
+    /**
+     * Whether Medusa manages the variant's inventory. If disabled, the variant
+     * is always considered in stock.
+     */
     manage_inventory: boolean | null;
+    /**
+     * The variant's inventory quantity if `manage_inventory` is enabled.
+     */
     inventory_quantity?: number;
+    /**
+     * The variant's HS code.
+     */
     hs_code: string | null;
+    /**
+     * The variant's origin country.
+     */
     origin_country: string | null;
+    /**
+     * The variant's MID code.
+     */
     mid_code: string | null;
+    /**
+     * The variant's material.
+     */
     material: string | null;
+    /**
+     * The variant's weight.
+     */
     weight: number | null;
+    /**
+     * The variant's length.
+     */
     length: number | null;
+    /**
+     * The variant's height.
+     */
     height: number | null;
+    /**
+     * The variant's width.
+     */
     width: number | null;
+    /**
+     * The variant's ranking among its siblings.
+     */
     variant_rank?: number | null;
+    /**
+     * The variant's values for the product's options.
+     */
     options: BaseProductOptionValue[] | null;
+    /**
+     * The variant's product.
+     */
     product?: BaseProduct | null;
+    /**
+     * The ID of the product that the variant belongs to.
+     */
     product_id?: string;
+    /**
+     * The variant's calculated price for the provided context.
+     */
     calculated_price?: BaseCalculatedPriceSet;
+    /**
+     * The date the variant was created.
+     */
     created_at: string;
+    /**
+     * The date the variant was updated.
+     */
     updated_at: string;
+    /**
+     * The date the variant was deleted.
+     */
     deleted_at: string | null;
+    /**
+     * Key-value pairs of custom data.
+     */
     metadata?: Record<string, unknown> | null;
 }
 export interface BaseProductOption {
+    /**
+     * The option's ID.
+     */
     id: string;
+    /**
+     * The option's title.
+     */
     title: string;
+    /**
+     * The product that the option belongs to.
+     */
     product?: BaseProduct | null;
+    /**
+     * The ID of the product that the option belongs to.
+     */
     product_id?: string | null;
+    /**
+     * The option's values.
+     */
     values?: BaseProductOptionValue[];
+    /**
+     * Key-value pairs of custom data.
+     */
     metadata?: Record<string, unknown> | null;
+    /**
+     * The date the option was created.
+     */
     created_at?: string;
+    /**
+     * The date the option was updated.
+     */
     updated_at?: string;
+    /**
+     * The date the option was deleted.
+     */
     deleted_at?: string | null;
 }
 export interface BaseProductImage {
@@ -87,30 +286,99 @@ export interface BaseProductImage {
     metadata?: Record<string, unknown> | null;
 }
 export interface BaseProductOptionValue {
+    /**
+     * The option value's ID.
+     */
     id: string;
+    /**
+     * The option's value.
+     */
     value: string;
+    /**
+     * The option's details.
+     */
     option?: BaseProductOption | null;
+    /**
+     * The ID of the option.
+     */
     option_id?: string | null;
+    /**
+     * Key-value pairs of custom data.
+     */
     metadata?: Record<string, unknown> | null;
+    /**
+     * The date the option value was created.
+     */
     created_at?: string;
+    /**
+     * The date the option value was updated.
+     */
     updated_at?: string;
+    /**
+     * The date the option value was deleted.
+     */
     deleted_at?: string | null;
 }
 export interface BaseProductListParams extends FindParams, BaseFilterable<BaseProductListParams> {
+    /**
+     * A query or keywords to search the searchable fields by.
+     */
     q?: string;
+    /**
+     * Filter the product by status(es).
+     */
     status?: ProductStatus | ProductStatus[];
+    /**
+     * Filter the product by the sales channel(s) it belongs to.
+     */
     sales_channel_id?: string | string[];
+    /**
+     * Filter by the product's title(s).
+     */
     title?: string | string[];
+    /**
+     * Filter by the product's handle(s).
+     */
     handle?: string | string[];
+    /**
+     * Filter by the product's id(s).
+     */
     id?: string | string[];
+    /**
+     * Filter by whether the product is a gift card.
+     */
     is_giftcard?: boolean;
+    /**
+     * Filter by the product's tag(s).
+     */
     tags?: string | string[];
+    /**
+     * Filter by the product's type(s).
+     */
     type_id?: string | string[];
+    /**
+     * Filter by the product's category(s).
+     */
     category_id?: string | string[];
+    /**
+     * Filter by the product's category(s).
+     */
     categories?: string | string[];
+    /**
+     * Filter by the product's collection(s).
+     */
     collection_id?: string | string[];
+    /**
+     * Apply filers on the product's creation date.
+     */
     created_at?: OperatorMap<string>;
+    /**
+     * Apply filers on the product's update date.
+     */
     updated_at?: OperatorMap<string>;
+    /**
+     * Apply filers on the product's deletion date.
+     */
     deleted_at?: OperatorMap<string>;
 }
 export interface BaseProductOptionParams extends FindParams, BaseFilterable<BaseProductOptionParams> {

package/dist/http/product/common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/http/product/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAA;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AAExD,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,UAAU,GAAG,WAAW,GAAG,UAAU,CAAA;AAC3E,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,WAAW,EAAE,OAAO,CAAA;IACpB,MAAM,EAAE,aAAa,CAAA;IACrB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,UAAU,CAAC,EAAE,cAAc,GAAG,IAAI,CAAA;IAClC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,UAAU,CAAC,EAAE,mBAAmB,EAAE,GAAG,IAAI,CAAA;IACzC,IAAI,CAAC,EAAE,eAAe,GAAG,IAAI,CAAA;IAC7B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,IAAI,CAAC,EAAE,cAAc,EAAE,GAAG,IAAI,CAAA;IAC9B,QAAQ,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAA;IACrC,OAAO,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAA;IACnC,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAA;IACjC,YAAY,EAAE,OAAO,CAAA;IACrB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAClB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAClB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAClB,eAAe,EAAE,OAAO,GAAG,IAAI,CAAA;IAC/B,gBAAgB,EAAE,OAAO,GAAG,IAAI,CAAA;IAChC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,OAAO,EAAE,sBAAsB,EAAE,GAAG,IAAI,CAAA;IACxC,OAAO,CAAC,EAAE,WAAW,GAAG,IAAI,CAAA;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,gBAAgB,CAAC,EAAE,sBAAsB,CAAA;IACzC,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,WAAW,GAAG,IAAI,CAAA;IAC5B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,MAAM,CAAC,EAAE,sBAAsB,EAAE,CAAA;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACzC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,GAAG,EAAE,MAAM,CAAA;IACX,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAA;IACjC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACzC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B;AAED,MAAM,WAAW,qBACf,SAAQ,UAAU,EAChB,cAAc,CAAC,qBAAqB,CAAC;IACvC,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,MAAM,CAAC,EAAE,aAAa,GAAG,aAAa,EAAE,CAAA;IACxC,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACpC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACzB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC3B,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC/B,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC9B,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACjC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,uBACf,SAAQ,UAAU,EAChB,cAAc,CAAC,uBAAuB,CAAC;IACzC,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACzB,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAC/B;AAED,MAAM,WAAW,wBACf,SAAQ,UAAU,EAChB,cAAc,CAAC,wBAAwB,CAAC;IAC1C,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,OAAO,CAAC,EAAE;QACR,KAAK,EAAE,MAAM,CAAA;QACb,SAAS,EAAE,MAAM,CAAA;KAClB,CAAA;IACD,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/http/product/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAA;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AAExD,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,UAAU,GAAG,WAAW,GAAG,UAAU,CAAA;AAC3E,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAA;IACpB;;OAEG;IACH,MAAM,EAAE,aAAa,CAAA;IACrB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,GAAG,IAAI,CAAA;IAClC;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B;;OAEG;IACH,UAAU,CAAC,EAAE,mBAAmB,EAAE,GAAG,IAAI,CAAA;IACzC;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,GAAG,IAAI,CAAA;IAC7B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB;;OAEG;IACH,IAAI,CAAC,EAAE,cAAc,EAAE,GAAG,IAAI,CAAA;IAC9B;;OAEG;IACH,QAAQ,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAA;IACrC;;OAEG;IACH,OAAO,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAA;IACnC;;OAEG;IACH,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAA;IACjC;;OAEG;IACH,YAAY,EAAE,OAAO,CAAA;IACrB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAClB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAClB;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAClB;;OAEG;IACH,eAAe,EAAE,OAAO,GAAG,IAAI,CAAA;IAC/B;;;OAGG;IACH,gBAAgB,EAAE,OAAO,GAAG,IAAI,CAAA;IAChC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B;;OAEG;IACH,OAAO,EAAE,sBAAsB,EAAE,GAAG,IAAI,CAAA;IACxC;;OAEG;IACH,OAAO,CAAC,EAAE,WAAW,GAAG,IAAI,CAAA;IAC5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,sBAAsB,CAAA;IACzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,OAAO,CAAC,EAAE,WAAW,GAAG,IAAI,CAAA;IAC5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,sBAAsB,EAAE,CAAA;IACjC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACzC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,GAAG,EAAE,MAAM,CAAA;IACX,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,MAAM,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAA;IACjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACzC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B;AAED,MAAM,WAAW,qBACf,SAAQ,UAAU,EAChB,cAAc,CAAC,qBAAqB,CAAC;IACvC;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,GAAG,aAAa,EAAE,CAAA;IACxC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC/B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC9B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACjC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,uBACf,SAAQ,UAAU,EAChB,cAAc,CAAC,uBAAuB,CAAC;IACzC,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACzB,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAC/B;AAED,MAAM,WAAW,wBACf,SAAQ,UAAU,EAChB,cAAc,CAAC,wBAAwB,CAAC;IAC1C,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,OAAO,CAAC,EAAE;QACR,KAAK,EAAE,MAAM,CAAA;QACb,SAAS,EAAE,MAAM,CAAA;KAClB,CAAA;IACD,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC"}

package/dist/http/product/store/entitites.d.ts

@@ -4,25 +4,61 @@ import { StoreProductTag } from "../../product-tag";
 import { StoreProductType } from "../../product-type";
 import { BaseProduct, BaseProductImage, BaseProductOption, BaseProductOptionValue, BaseProductVariant, ProductStatus } from "../common";
 export interface StoreProduct extends Omit<BaseProduct, "categories" | "sales_channels" | "variants" | "options" | "collection"> {
+    /**
+     * The product's collection.
+     */
     collection?: StoreCollection | null;
+    /**
+     * The product's categories.
+     */
     categories?: StoreProductCategory[] | null;
+    /**
+     * The product's variants.
+     */
     variants: StoreProductVariant[] | null;
+    /**
+     * The product's types.
+     */
     type?: StoreProductType | null;
+    /**
+     * The product's tags.
+     */
     tags?: StoreProductTag[] | null;
+    /**
+     * The product's options.
+     */
     options: StoreProductOption[] | null;
+    /**
+     * The product's images.
+     */
     images: StoreProductImage[] | null;
 }
 export interface StoreProductVariant extends Omit<BaseProductVariant, "product" | "options"> {
+    /**
+     * The variant's values for the product's options.
+     */
     options: StoreProductOptionValue[] | null;
+    /**
+     * The variant's product.
+     */
     product?: StoreProduct | null;
 }
 export interface StoreProductOption extends Omit<BaseProductOption, "product" | "values"> {
+    /**
+     * The product the option belongs to.
+     */
     product?: StoreProduct | null;
+    /**
+     * The option's values.
+     */
     values?: StoreProductOptionValue[];
 }
 export interface StoreProductImage extends BaseProductImage {
 }
 export interface StoreProductOptionValue extends Omit<BaseProductOptionValue, "option"> {
+    /**
+     * The product's option.
+     */
     option?: StoreProductOption | null;
 }
 export type StoreProductStatus = ProductStatus;

package/dist/http/product/store/entitites.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entitites.d.ts","sourceRoot":"","sources":["../../../../src/http/product/store/entitites.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EACjB,sBAAsB,EACtB,kBAAkB,EAClB,aAAa,EACd,MAAM,WAAW,CAAA;AAElB,MAAM,WAAW,YACf,SAAQ,IAAI,CACV,WAAW,EACX,YAAY,GAAG,gBAAgB,GAAG,UAAU,GAAG,SAAS,GAAG,YAAY,CACxE;IACD,UAAU,CAAC,EAAE,eAAe,GAAG,IAAI,CAAA;IACnC,UAAU,CAAC,EAAE,oBAAoB,EAAE,GAAG,IAAI,CAAA;IAC1C,QAAQ,EAAE,mBAAmB,EAAE,GAAG,IAAI,CAAA;IACtC,IAAI,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAA;IAC9B,IAAI,CAAC,EAAE,eAAe,EAAE,GAAG,IAAI,CAAA;IAC/B,OAAO,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAA;IACpC,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAA;CACnC;AACD,MAAM,WAAW,mBACf,SAAQ,IAAI,CAAC,kBAAkB,EAAE,SAAS,GAAG,SAAS,CAAC;IACvD,OAAO,EAAE,uBAAuB,EAAE,GAAG,IAAI,CAAA;IACzC,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,CAAA;CAC9B;AACD,MAAM,WAAW,kBACf,SAAQ,IAAI,CAAC,iBAAiB,EAAE,SAAS,GAAG,QAAQ,CAAC;IACrD,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,CAAA;IAC7B,MAAM,CAAC,EAAE,uBAAuB,EAAE,CAAA;CACnC;AACD,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;CAAG;AAC9D,MAAM,WAAW,uBACf,SAAQ,IAAI,CAAC,sBAAsB,EAAE,QAAQ,CAAC;IAC9C,MAAM,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAA;CACnC;AACD,MAAM,MAAM,kBAAkB,GAAG,aAAa,CAAA"}
+{"version":3,"file":"entitites.d.ts","sourceRoot":"","sources":["../../../../src/http/product/store/entitites.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EACjB,sBAAsB,EACtB,kBAAkB,EAClB,aAAa,EACd,MAAM,WAAW,CAAA;AAElB,MAAM,WAAW,YACf,SAAQ,IAAI,CACV,WAAW,EACX,YAAY,GAAG,gBAAgB,GAAG,UAAU,GAAG,SAAS,GAAG,YAAY,CACxE;IACD;;OAEG;IACH,UAAU,CAAC,EAAE,eAAe,GAAG,IAAI,CAAA;IACnC;;OAEG;IACH,UAAU,CAAC,EAAE,oBAAoB,EAAE,GAAG,IAAI,CAAA;IAC1C;;OAEG;IACH,QAAQ,EAAE,mBAAmB,EAAE,GAAG,IAAI,CAAA;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAA;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,EAAE,GAAG,IAAI,CAAA;IAC/B;;OAEG;IACH,OAAO,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAA;IACpC;;OAEG;IACH,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAA;CACnC;AACD,MAAM,WAAW,mBACf,SAAQ,IAAI,CAAC,kBAAkB,EAAE,SAAS,GAAG,SAAS,CAAC;IACvD;;OAEG;IACH,OAAO,EAAE,uBAAuB,EAAE,GAAG,IAAI,CAAA;IACzC;;OAEG;IACH,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,CAAA;CAC9B;AACD,MAAM,WAAW,kBACf,SAAQ,IAAI,CAAC,iBAAiB,EAAE,SAAS,GAAG,QAAQ,CAAC;IACrD;;OAEG;IACH,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,CAAA;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,uBAAuB,EAAE,CAAA;CACnC;AACD,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;CAAG;AAC9D,MAAM,WAAW,uBACf,SAAQ,IAAI,CAAC,sBAAsB,EAAE,QAAQ,CAAC;IAC9C;;OAEG;IACH,MAAM,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAA;CACnC;AACD,MAAM,MAAM,kBAAkB,GAAG,aAAa,CAAA"}

package/dist/http/product/store/queries.d.ts

@@ -3,11 +3,29 @@ export interface StoreProductOptionParams extends BaseProductOptionParams {
 }
 export interface StoreProductVariantParams extends BaseProductVariantParams {
 }
-export interface StoreProductParams extends Omit<BaseProductListParams, "tags" | "status" | "categories"> {
+export interface StoreProductParams extends Omit<BaseProductListParams, "tags" | "status" | "categories" | "deleted_at"> {
+    /**
+     * Filter by the product's tag(s).
+     */
     tag_id?: string | string[];
+    /**
+     * The ID of the region the products are being viewed from. This is required if you're retrieving product variant prices with taxes.
+     *
+     * @privateRemarks
+     * The region ID and currency_code are not params, but are used for the pricing context. Maybe move to separate type definition.
+     */
     region_id?: string;
+    /**
+     * The currency code to retrieve prices in.
+     */
     currency_code?: string;
+    /**
+     * Filter by the product's variants.
+     */
     variants?: Pick<StoreProductVariantParams, "options">;
+    /**
+     * The province the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes.
+     */
     province?: string;
 }
 //# sourceMappingURL=queries.d.ts.map

package/dist/http/product/store/queries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/product/store/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EACvB,wBAAwB,EACzB,MAAM,WAAW,CAAA;AAElB,MAAM,WAAW,wBAAyB,SAAQ,uBAAuB;CAAG;AAC5E,MAAM,WAAW,yBAA0B,SAAQ,wBAAwB;CAAG;AAC9E,MAAM,WAAW,kBACf,SAAQ,IAAI,CAAC,qBAAqB,EAAE,MAAM,GAAG,QAAQ,GAAG,YAAY,CAAC;IACrE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAE1B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,IAAI,CAAC,yBAAyB,EAAE,SAAS,CAAC,CAAA;IACrD,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB"}
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/product/store/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EACvB,wBAAwB,EACzB,MAAM,WAAW,CAAA;AAElB,MAAM,WAAW,wBAAyB,SAAQ,uBAAuB;CAAG;AAC5E,MAAM,WAAW,yBAA0B,SAAQ,wBAAwB;CAAG;AAC9E,MAAM,WAAW,kBACf,SAAQ,IAAI,CAAC,qBAAqB,EAAE,MAAM,GAAG,QAAQ,GAAG,YAAY,GAAG,YAAY,CAAC;IACpF;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,IAAI,CAAC,yBAAyB,EAAE,SAAS,CAAC,CAAA;IACrD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB"}

package/dist/http/product/store/responses.d.ts

@@ -1,9 +1,15 @@
 import { PaginatedResponse } from "../../common";
 import { StoreProduct } from "../store";
 export interface StoreProductResponse {
+    /**
+     * The product's details.
+     */
     product: StoreProduct;
 }
 export type StoreProductListResponse = PaginatedResponse<{
+    /**
+     * The list of products.
+     */
     products: StoreProduct[];
 }>;
 //# sourceMappingURL=responses.d.ts.map

package/dist/http/product/store/responses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/product/store/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAEvC,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,YAAY,CAAA;CACtB;AAED,MAAM,MAAM,wBAAwB,GAAG,iBAAiB,CAAC;IACvD,QAAQ,EAAE,YAAY,EAAE,CAAA;CACzB,CAAC,CAAA"}
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/product/store/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAEvC,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,EAAE,YAAY,CAAA;CACtB;AAED,MAAM,MAAM,wBAAwB,GAAG,iBAAiB,CAAC;IACvD;;OAEG;IACH,QAAQ,EAAE,YAAY,EAAE,CAAA;CACzB,CAAC,CAAA"}

package/dist/http/product-category/common.d.ts

@@ -2,39 +2,133 @@ import { BaseFilterable, OperatorMap } from "../../dal";
 import { FindParams, SelectParams } from "../common";
 import { BaseProduct } from "../product/common";
 export interface BaseProductCategory {
+    /**
+     * The category's ID.
+     */
     id: string;
+    /**
+     * The category's name.
+     */
     name: string;
+    /**
+     * The category's description.
+     */
     description: string;
+    /**
+     * The category's handle.
+     */
     handle: string;
+    /**
+     * Whether the category is active.
+     */
     is_active: boolean;
+    /**
+     * Whether the category is internal.
+     */
     is_internal: boolean;
+    /**
+     * The category's ranking among sibling categories.
+     */
     rank: number | null;
+    /**
+     * The ID of the category's parent.
+     */
     parent_category_id: string | null;
+    /**
+     * The category's parent.
+     */
     parent_category: BaseProductCategory | null;
+    /**
+     * The category's children.
+     */
     category_children: BaseProductCategory[];
+    /**
+     * The category's products.
+     */
     products?: BaseProduct[];
+    /**
+     * Key-value pairs of custom data.
+     */
     metadata?: Record<string, unknown> | null;
+    /**
+     * The date the category was created.
+     */
     created_at: string;
+    /**
+     * The date the category was updated.
+     */
     updated_at: string;
+    /**
+     * The date the category was deleted.
+     */
     deleted_at: string | null;
 }
 export interface BaseProductCategoryListParams extends FindParams, BaseFilterable<BaseProductCategoryListParams> {
+    /**
+     * A query or keywords to search the category's searchable fields.
+     */
     q?: string;
+    /**
+     * Filter by the category's ID(s).
+     */
     id?: string | string[];
+    /**
+     * Filter by the category's name(s).
+     */
     name?: string | string[];
+    /**
+     * Filter by the category's description(s).
+     */
     description?: string | string[];
+    /**
+     * Retrieve the child categories of the specified parent ID(s).
+     */
     parent_category_id?: string | string[] | null;
+    /**
+     * Filter by the category's handle(s).
+     */
     handle?: string | string[];
+    /**
+     * Filter by whether the category is active.
+     */
     is_active?: boolean;
+    /**
+     * Filter by whether the category is internal.
+     */
     is_internal?: boolean;
+    /**
+     * Whether to retrieve the child categories. If enabled, the child categories are
+     * retrieved in the `category_children` field.
+     */
     include_descendants_tree?: boolean;
+    /**
+     * Whether to retrieve the parent category. If enabled, the parent category is
+     * retrieved in the `parent_category` field.
+     */
     include_ancestors_tree?: boolean;
+    /**
+     * Apply filters on the category's creation date.
+     */
     created_at?: OperatorMap<string>;
+    /**
+     * Apply filters on the category's update date.
+     */
     updated_at?: OperatorMap<string>;
+    /**
+     * Apply filters on the category's deletion date.
+     */
     deleted_at?: OperatorMap<string>;
 }
 export interface BaseProductCategoryParams extends SelectParams {
+    /**
+     * Whether to retrieve the parent category. If enabled, the parent category is
+     * retrieved in the `parent_category` field.
+     */
     include_ancestors_tree?: boolean;
+    /**
+     * Whether to retrieve the child categories. If enabled, the child categories are
+     * retrieved in the `category_children` field.
+     */
     include_descendants_tree?: boolean;
 }
 //# sourceMappingURL=common.d.ts.map

package/dist/http/product-category/common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/http/product-category/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAE/C,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,OAAO,CAAA;IAClB,WAAW,EAAE,OAAO,CAAA;IACpB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,eAAe,EAAE,mBAAmB,GAAG,IAAI,CAAA;IAC3C,iBAAiB,EAAE,mBAAmB,EAAE,CAAA;IACxC,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAA;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACzC,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,6BACf,SAAQ,UAAU,EAChB,cAAc,CAAC,6BAA6B,CAAC;IAC/C,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC/B,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAA;IAC7C,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAClC,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,yBAA0B,SAAQ,YAAY;IAC7D,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAChC,wBAAwB,CAAC,EAAE,OAAO,CAAA;CACnC"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/http/product-category/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAE/C,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,SAAS,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAA;IACpB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC;;OAEG;IACH,eAAe,EAAE,mBAAmB,GAAG,IAAI,CAAA;IAC3C;;OAEG;IACH,iBAAiB,EAAE,mBAAmB,EAAE,CAAA;IACxC;;OAEG;IACH,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAA;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,6BACf,SAAQ,UAAU,EAChB,cAAc,CAAC,6BAA6B,CAAC;IAC/C;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC/B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAA;IAC7C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAClC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,yBAA0B,SAAQ,YAAY;IAC7D;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAChC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAA;CACnC"}