@medusajs/types - npm Package Compare versions

Comparing version 1.11.7-snapshot-20231117092635 to 1.11.7-snapshot-20231120171146

dist/common/common.d.ts

@@ -29,21 +29,31 @@ import { FindManyOptions, FindOneOptions, FindOperator, FindOptionsSelect, FindOptionsWhere, OrderByCondition } from "typeorm";
  * which provides correct typing of field names in its properties.
- *
- * @prop select - An array of strings, each being attribute names of the entity to retrieve in the result.
- * @prop skip - A number indicating the number of records to skip before retrieving the results.
- * @prop take - A number indicating the number of records to return in the result.
- * @prop relations - An array of strings, each being relation names of the entity to retrieve in the result.
- * @prop order -
- * An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`
- * to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.
- * @prop withDeleted - A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the
- * `SoftDeletableEntity` class.
  */
 export interface FindConfig<Entity> {
+    /**
+     * An array of strings, each being attribute names of the entity to retrieve in the result.
+     */
     select?: (keyof Entity | string)[];
+    /**
+     * A number indicating the number of records to skip before retrieving the results.
+     */
     skip?: number;
+    /**
+     * A number indicating the number of records to return in the result.
+     */
     take?: number;
+    /**
+     * An array of strings, each being relation names of the entity to retrieve in the result.
+     */
     relations?: string[];
+    /**
+     * An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`
+     * to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.
+     */
     order?: {
         [K: string]: "ASC" | "DESC";
     };
+    /**
+     * A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the
+     * `SoftDeletableEntity` class.
+     */
     withDeleted?: boolean;
@@ -50,0 +60,0 @@ }

dist/dal/index.d.ts

@@ -7,8 +7,11 @@ import { Dictionary, FilterQuery, Order } from "./utils";
  * An object used to allow specifying flexible queries with and/or conditions.
- *
- * @prop $and - An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.
- * @prop $or - An array of filters to apply on the entity, where each item in the array is joined with an "or" condition.
  */
 export interface BaseFilterable<T> {
+    /**
+     * An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.
+     */
     $and?: (T | BaseFilterable<T>)[];
+    /**
+     * An array of filters to apply on the entity, where each item in the array is joined with an "or" condition.
+     */
     $or?: (T | BaseFilterable<T>)[];
@@ -15,0 +18,0 @@ }

dist/dal/repository-service.d.ts

@@ -46,6 +46,7 @@ import { RepositoryTransformOptions } from "../common";
  * An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
- *
- * @prop returnLinkableKeys - An array of strings, each being the ID attribute names of the entity's relations.
  */
 export type SoftDeleteReturn<TReturnableLinkableKeys = string> = {
+    /**
+     * An array of strings, each being the ID attribute names of the entity's relations.
+     */
     returnLinkableKeys?: TReturnableLinkableKeys[];
@@ -57,8 +58,9 @@ };
  * An object that is used to specify an entity's related entities that should be restored when the main entity is restored.
- *
- * @prop returnLinkableKeys - An array of strings, each being the ID attribute names of the entity's relations.
  */
 export type RestoreReturn<TReturnableLinkableKeys = string> = {
+    /**
+     * An array of strings, each being the ID attribute names of the entity's relations.
+     */
     returnLinkableKeys?: TReturnableLinkableKeys[];
 };
 export {};

dist/inventory/common.d.ts

@@ -202,12 +202,7 @@ import { NumericalComparisonOperator, StringComparisonOperator } from "../common";
  * The filters to apply on retrieved reservation items.
- *
- * @prop id - The IDs to filter reservation items by.
- * @prop line_item_id - Filter reservation items by the ID of their associated line item.
- * @prop inventory_item_id - Filter reservation items by the ID of their associated inventory item.
- * @prop location_id - Filter reservation items by the ID of their associated location.
- * @prop description - Description filters to apply on the reservation items' `description` attribute.
- * @prop created_by - The "created by" values to filter reservation items by.
- * @prop quantity - Filters to apply on the reservation items' `quantity` attribute.
  */
 export type FilterableReservationItemProps = {
+    /**
+     * The IDs to filter reservation items by.
+     */
     id?: string | string[];
@@ -221,7 +216,25 @@ /**
     type?: string | string[];
+    /**
+     * Filter reservation items by the ID of their associated line item.
+     */
     line_item_id?: string | string[];
+    /**
+     * Filter reservation items by the ID of their associated inventory item.
+     */
     inventory_item_id?: string | string[];
+    /**
+     * Filter reservation items by the ID of their associated location.
+     */
     location_id?: string | string[];
+    /**
+     * Description filters to apply on the reservation items' `description` attribute.
+     */
     description?: string | StringComparisonOperator;
+    /**
+     * The "created by" values to filter reservation items by.
+     */
     created_by?: string | string[];
+    /**
+     * Filters to apply on the reservation items' `quantity` attribute.
+     */
     quantity?: number | NumericalComparisonOperator;
@@ -233,18 +246,31 @@ };
  * The filters to apply on retrieved inventory items.
- *
- * @prop id - The IDs to filter inventory items by.
- * @prop location_id - Filter inventory items by the ID of their associated location.
- * @prop q - Search term to search inventory items' attributes.
- * @prop sku - The SKUs to filter inventory items by.
- * @prop origin_country - The origin country to filter inventory items by.
- * @prop hs_code - The HS Codes to filter inventory items by.
- * @prop requires_shipping - Filter inventory items by whether they require shipping.
  */
 export type FilterableInventoryItemProps = {
+    /**
+     * The IDs to filter inventory items by.
+     */
     id?: string | string[];
+    /**
+     * Filter inventory items by the ID of their associated location.
+     */
     location_id?: string | string[];
+    /**
+     * Search term to search inventory items' attributes.
+     */
     q?: string;
+    /**
+     * The SKUs to filter inventory items by.
+     */
     sku?: string | string[] | StringComparisonOperator;
+    /**
+     * The origin country to filter inventory items by.
+     */
     origin_country?: string | string[];
+    /**
+     * The HS Codes to filter inventory items by.
+     */
     hs_code?: string | string[] | StringComparisonOperator;
+    /**
+     * Filter inventory items by whether they require shipping.
+     */
     requires_shipping?: boolean;
@@ -256,32 +282,59 @@ };
  * The details of the inventory item to be created.
- *
- * @prop sku - The SKU of the inventory item.
- * @prop origin_country - The origin country of the inventory item.
- * @prop mid_code - The MID code of the inventory item.
- * @prop material - The material of the inventory item.
- * @prop weight - The weight of the inventory item.
- * @prop length - The length of the inventory item.
- * @prop height - The height of the inventory item.
- * @prop width - The width of the inventory item.
- * @prop title - The title of the inventory item.
- * @prop description - The description of the inventory item.
- * @prop thumbnail - The thumbnail of the inventory item.
- * @prop metadata - Holds custom data in key-value pairs.
- * @prop hs_code - The HS code of the inventory item.
- * @prop requries_shipping - Whether the inventory item requires shipping.
  */
 export type CreateInventoryItemInput = {
+    /**
+     * The SKU of the inventory item.
+     */
     sku?: string | null;
+    /**
+     * The origin country of the inventory item.
+     */
     origin_country?: string | null;
+    /**
+     * The MID code of the inventory item.
+     */
     mid_code?: string | null;
+    /**
+     * The material of the inventory item.
+     */
     material?: string | null;
+    /**
+     * The weight of the inventory item.
+     */
     weight?: number | null;
+    /**
+     * The length of the inventory item.
+     */
     length?: number | null;
+    /**
+     * The height of the inventory item.
+     */
     height?: number | null;
+    /**
+     * The width of the inventory item.
+     */
     width?: number | null;
+    /**
+     * The title of the inventory item.
+     */
     title?: string | null;
+    /**
+     * The description of the inventory item.
+     */
     description?: string | null;
+    /**
+     * The thumbnail of the inventory item.
+     */
     thumbnail?: string | null;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown> | null;
+    /**
+     * The HS code of the inventory item.
+     */
     hs_code?: string | null;
+    /**
+     * Whether the inventory item requires shipping.
+     */
     requires_shipping?: boolean;
@@ -293,20 +346,35 @@ };
  * The details of the reservation item to be created.
- *
- * @prop line_item_id - The ID of the associated line item.
- * @prop inventory_item_id - The ID of the associated inventory item.
- * @prop location_id - The ID of the associated location.
- * @prop quantity - The reserved quantity.
- * @prop description - The description of the reservation.
- * @prop created_by - The user or system that created the reservation. Can be any form of identification string.
- * @prop external_id - An ID associated with an external third-party system that the reservation item is connected to.
- * @prop metadata - Holds custom data in key-value pairs.
  */
 export type CreateReservationItemInput = {
+    /**
+     * The ID of the associated line item.
+     */
     line_item_id?: string;
+    /**
+     * The ID of the associated inventory item.
+     */
     inventory_item_id: string;
+    /**
+     * The ID of the associated location.
+     */
     location_id: string;
+    /**
+     * The reserved quantity.
+     */
     quantity: number;
+    /**
+     * The description of the reservation.
+     */
     description?: string;
+    /**
+     * The user or system that created the reservation. Can be any form of identification string.
+     */
     created_by?: string;
+    /**
+     * An ID associated with an external third-party system that the reservation item is connected to.
+     */
     external_id?: string;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown> | null;
@@ -318,14 +386,23 @@ };
  * The filters to apply on retrieved inventory levels.
- *
- * @prop inventory_item_id - Filter inventory levels by the ID of their associated inventory item.
- * @prop location_id - Filter inventory levels by the ID of their associated inventory location.
- * @prop stocked_quantity - Filters to apply on inventory levels' `stocked_quantity` attribute.
- * @prop reserved_quantity - Filters to apply on inventory levels' `reserved_quantity` attribute.
- * @prop incoming_quantity - Filters to apply on inventory levels' `incoming_quantity` attribute.
  */
 export type FilterableInventoryLevelProps = {
+    /**
+     * Filter inventory levels by the ID of their associated inventory item.
+     */
     inventory_item_id?: string | string[];
+    /**
+     * Filter inventory levels by the ID of their associated inventory location.
+     */
     location_id?: string | string[];
+    /**
+     * Filters to apply on inventory levels' `stocked_quantity` attribute.
+     */
     stocked_quantity?: number | NumericalComparisonOperator;
+    /**
+     * Filters to apply on inventory levels' `reserved_quantity` attribute.
+     */
     reserved_quantity?: number | NumericalComparisonOperator;
+    /**
+     * Filters to apply on inventory levels' `incoming_quantity` attribute.
+     */
     incoming_quantity?: number | NumericalComparisonOperator;
@@ -337,14 +414,23 @@ };
  * The details of the inventory level to be created.
- *
- * @prop inventory_item_id - The ID of the associated inventory item.
- * @prop location_id - The ID of the associated location.
- * @prop stocked_quantity - The stocked quantity of the associated inventory item in the associated location.
- * @prop reserved_quantity - The reserved quantity of the associated inventory item in the associated location.
- * @prop incoming_quantity - The incoming quantity of the associated inventory item in the associated location.
  */
 export type CreateInventoryLevelInput = {
+    /**
+     * The ID of the associated inventory item.
+     */
     inventory_item_id: string;
+    /**
+     * The ID of the associated location.
+     */
     location_id: string;
+    /**
+     * The stocked quantity of the associated inventory item in the associated location.
+     */
     stocked_quantity: number;
+    /**
+     * The reserved quantity of the associated inventory item in the associated location.
+     */
     reserved_quantity?: number;
+    /**
+     * The incoming quantity of the associated inventory item in the associated location.
+     */
     incoming_quantity?: number;
@@ -356,8 +442,11 @@ };
  * The attributes to update in an inventory level.
- *
- * @prop stocked_quantity - The stocked quantity of the associated inventory item in the associated location.
- * @prop incoming_quantity - The incoming quantity of the associated inventory item in the associated location.
  */
 export type UpdateInventoryLevelInput = {
+    /**
+     * The stocked quantity of the associated inventory item in the associated location.
+     */
     stocked_quantity?: number;
+    /**
+     * The incoming quantity of the associated inventory item in the associated location.
+     */
     incoming_quantity?: number;
@@ -369,8 +458,11 @@ };
  * The attributes to update in an inventory level. The inventory level is identified by the IDs of its associated inventory item and location.
- *
- * @prop inventory_item_id - The ID of the associated inventory level.
- * @prop location_id - The ID of the associated location.
  */
 export type BulkUpdateInventoryLevelInput = {
+    /**
+     * The ID of the associated inventory level.
+     */
     inventory_item_id: string;
+    /**
+     * The ID of the associated location.
+     */
     location_id: string;
@@ -382,12 +474,19 @@ } & UpdateInventoryLevelInput;
  * The attributes to update in a reservation item.
- *
- * @prop quantity - The reserved quantity.
- * @prop location_id - The ID of the associated location.
- * @prop description - The description of the reservation item.
- * @prop metadata - Holds custom data in key-value pairs.
  */
 export type UpdateReservationItemInput = {
+    /**
+     * The reserved quantity.
+     */
     quantity?: number;
+    /**
+     * The ID of the associated location.
+     */
     location_id?: string;
+    /**
+     * The description of the reservation item.
+     */
     description?: string;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown> | null;
@@ -394,0 +493,0 @@ };

dist/product/common.d.ts

@@ -16,61 +16,134 @@ import { BaseFilterable } from "../dal";
  * A product's data.
- * @prop id - The ID of the product.
- * @prop title - The title of the product.
- * @prop handle - The handle of the product. The handle can be used to create slug URL paths. It can possibly be `null`.
- * @prop subtitle - The subttle of the product. It can possibly be `null`.
- * @prop description - The description of the product. It can possibly be `null`.
- * @prop is_giftcard - Whether the product is a gift card.
- * @prop status - The status of the product. Its value can be one of the values of the enum {@link ProductStatus}.
- * @prop thumbnail - The URL of the product's thumbnail. It can possibly be `null`.
- * @prop weight - The weight of the product. It can possibly be `null`.
- * @prop length - The length of the product. It can possibly be `null`.
- * @prop height - The height of the product. It can possibly be `null`.
- * @prop origin_country - The origin country of the product. It can possibly be `null`.
- * @prop hs_code - The HS Code of the product. It can possibly be `null`.
- * @prop mid_code - The MID Code of the product. It can possibly be `null`.
- * @prop material - The material of the product. It can possibly be `null`.
- * @prop collection - The associated product collection. It may only be available if the `collection` relation is expanded.
- * @prop categories -The associated product categories. It may only be available if the `categories` relation is expanded.
- * @prop type - The associated product type. It may only be available if the `type` relation is expanded.
- * @prop tags - The associated product tags. It may only be available if the `tags` relation is expanded.
- * @prop variants - The associated product variants. It may only be available if the `variants` relation is expanded.
- * @prop options - The associated product options. It may only be available if the `options` relation is expanded.
- * @prop images - The associated product images. It may only be available if the `images` relation is expanded.
- * @prop discountable - Whether the product can be discounted.
- * @prop external_id -
- * The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain
- * a reference to the ID in the integrated service.
- * @prop created_at - When the product was created.
- * @prop updated_at - When the product was updated.
- * @prop deleted_at - When the product was deleted.
  */
 export interface ProductDTO {
+    /**
+     * The ID of the product.
+     */
     id: string;
+    /**
+     * The title of the product.
+     */
     title: string;
+    /**
+     * The handle of the product. The handle can be used to create slug URL paths.
+     */
     handle?: string | null;
+    /**
+     * The subttle of the product.
+     */
     subtitle?: string | null;
+    /**
+     * The description of the product.
+     */
     description?: string | null;
+    /**
+     * Whether the product is a gift card.
+     */
     is_giftcard: boolean;
+    /**
+     * The status of the product.
+     */
     status: ProductStatus;
+    /**
+     * The URL of the product's thumbnail.
+     */
     thumbnail?: string | null;
+    /**
+     * The width of the product.
+     */
     width?: number | null;
+    /**
+     * The weight of the product.
+     */
     weight?: number | null;
+    /**
+     * The length of the product.
+     */
     length?: number | null;
+    /**
+     * The height of the product.
+     */
     height?: number | null;
+    /**
+     * The origin country of the product.
+     */
     origin_country?: string | null;
+    /**
+     * The HS Code of the product.
+     */
     hs_code?: string | null;
+    /**
+     * The MID Code of the product.
+     */
     mid_code?: string | null;
+    /**
+     * The material of the product.
+     */
     material?: string | null;
+    /**
+     * The associated product collection.
+     *
+     * @expandable
+     */
     collection: ProductCollectionDTO;
+    /**
+     * The associated product categories.
+     *
+     * @expandable
+     */
     categories?: ProductCategoryDTO[] | null;
+    /**
+     * The associated product type.
+     *
+     * @expandable
+     */
     type: ProductTypeDTO[];
+    /**
+     * The associated product tags.
+     *
+     * @expandable
+     */
     tags: ProductTagDTO[];
+    /**
+     * The associated product variants.
+     *
+     * @expandable
+     */
     variants: ProductVariantDTO[];
+    /**
+     * The associated product options.
+     *
+     * @expandable
+     */
     options: ProductOptionDTO[];
+    /**
+     * The associated product images.
+     *
+     * @expandable
+     */
     images: ProductImageDTO[];
+    /**
+     * Whether the product can be discounted.
+     */
     discountable?: boolean;
+    /**
+     * The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain
+     * a reference to the ID in the integrated service.
+     */
     external_id?: string | null;
+    /**
+     * When the product was created.
+     */
     created_at?: string | Date;
+    /**
+     * When the product was updated.
+     */
     updated_at?: string | Date;
+    /**
+     * When the product was deleted.
+     */
     deleted_at?: string | Date;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown>;
@@ -82,54 +155,107 @@ }
  * A product variant's data.
- *
- * @prop id - The ID of the product variant.
- * @prop title - The tile of the product variant.
- * @prop sku - The SKU of the product variant. It can possibly be `null`.
- * @prop barcode - The barcode of the product variant. It can possibly be `null`.
- * @prop ean - The EAN of the product variant. It can possibly be `null`.
- * @prop upc - The UPC of the product variant. It can possibly be `null`.
- * @prop inventory_quantity - The inventory quantiy of the product variant.
- * @prop allow_backorder - Whether the product variant can be ordered when it's out of stock.
- * @prop manage_inventory - Whether the product variant's inventory should be managed by the core system.
- * @prop hs_code - The HS Code of the product variant. It can possibly be `null`.
- * @prop origin_country - The origin country of the product variant. It can possibly be `null`.
- * @prop mid_code - The MID Code of the product variant. It can possibly be `null`.
- * @prop material - The material of the product variant. It can possibly be `null`.
- * @prop weight - The weight of the product variant. It can possibly be `null`.
- * @prop length - The length of the product variant. It can possibly be `null`.
- * @prop height - The height of the product variant. It can possibly be `null`.
- * @prop width - The width of the product variant. It can possibly be `null`.
- * @prop options - The associated product options. It may only be available if the `options` relation is expanded.
- * @prop metadata - Holds custom data in key-value pairs.
- * @prop product - The associated product. It may only be available if the `product` relation is expanded.
- * @prop product_id - The ID of the associated product.
- * @prop variant_rank - The ranking of the variant among other variants associated with the product. It can possibly be `null`.
- * @prop created_at - When the product variant was created.
- * @prop updated_at - When the product variant was updated.
- * @prop deleted_at - When the product variant was deleted.
  */
 export interface ProductVariantDTO {
+    /**
+     * The ID of the product variant.
+     */
     id: string;
+    /**
+     * The tile of the product variant.
+     */
     title: string;
+    /**
+     * The SKU of the product variant.
+     */
     sku?: string | null;
+    /**
+     * The barcode of the product variant.
+     */
     barcode?: string | null;
+    /**
+     * The EAN of the product variant.
+     */
     ean?: string | null;
+    /**
+     * The UPC of the product variant.
+     */
     upc?: string | null;
+    /**
+     * The inventory quantiy of the product variant.
+     */
     inventory_quantity: number;
+    /**
+     * Whether the product variant can be ordered when it's out of stock.
+     */
     allow_backorder?: boolean;
+    /**
+     * Whether the product variant's inventory should be managed by the core system.
+     */
     manage_inventory?: boolean;
+    /**
+     * The HS Code of the product variant.
+     */
     hs_code?: string | null;
+    /**
+     * The origin country of the product variant.
+     */
     origin_country?: string | null;
+    /**
+     * The MID Code of the product variant.
+     */
     mid_code?: string | null;
+    /**
+     * The material of the product variant.
+     */
     material?: string | null;
+    /**
+     * The weight of the product variant.
+     */
     weight?: number | null;
+    /**
+     * The length of the product variant.
+     */
     length?: number | null;
+    /**
+     * The height of the product variant.
+     */
     height?: number | null;
+    /**
+     * The width of the product variant.
+     */
     width?: number | null;
+    /**
+     * The associated product options.
+     *
+     * @expandable
+     */
     options: ProductOptionValueDTO;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown> | null;
+    /**
+     * The associated product.
+     *
+     * @expandable
+     */
     product: ProductDTO;
+    /**
+     * The ID of the associated product.
+     */
     product_id: string;
+    /**
+     * he ranking of the variant among other variants associated with the product.
+     */
     variant_rank?: number | null;
+    /**
+     * When the product variant was created.
+     */
     created_at: string | Date;
+    /**
+     * When the product variant was updated.
+     */
     updated_at: string | Date;
+    /**
+     * When the product variant was deleted.
+     */
     deleted_at: string | Date;
@@ -141,26 +267,51 @@ }
  * A product category's data.
- *
- * @prop id - The ID of the product category.
- * @prop name - The name of the product category.
- * @prop description - The description of the product category.
- * @prop handle - The handle of the product category. The handle can be used to create slug URL paths.
- * @prop is_active - Whether the product category is active.
- * @prop is_internal - Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.
- * @prop rank - The ranking of the product category among sibling categories.
- * @prop parent_category - The associated parent category. It may only be available if the `parent_category` relation is expanded.
- * @prop category_children - The associated child categories. It may only be available if the `category_children` relation is expanded.
- * @prop created_at - When the product category was created.
- * @prop updated_at - When the product category was updated.
  */
 export interface ProductCategoryDTO {
+    /**
+     * The ID of the product category.
+     */
     id: string;
+    /**
+     * The name of the product category.
+     */
     name: string;
+    /**
+     * The description of the product category.
+     */
     description?: string;
+    /**
+     * The handle of the product category. The handle can be used to create slug URL paths.
+     */
     handle?: string;
+    /**
+     * Whether the product category is active.
+     */
     is_active?: boolean;
+    /**
+     * Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.
+     */
     is_internal?: boolean;
+    /**
+     * The ranking of the product category among sibling categories.
+     */
     rank?: number;
+    /**
+     * The associated parent category.
+     *
+     * @expandable
+     */
     parent_category?: ProductCategoryDTO;
+    /**
+     * The associated child categories.
+     *
+     * @expandable
+     */
     category_children: ProductCategoryDTO[];
+    /**
+     * When the product category was created.
+     */
     created_at: string | Date;
+    /**
+     * When the product category was updated.
+     */
     updated_at: string | Date;
@@ -172,18 +323,31 @@ }
  * A product category to create.
- *
- * @prop name - The product category's name.
- * @prop handle - The product category's handle.
- * @prop is_active - Whether the product category is active.
- * @prop is_internal - Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.
- * @prop rank - The ranking of the category among sibling categories.
- * @prop parent_category_id - The ID of the parent product category, if it has any. It may also be `null`.
- * @prop metadata - Holds custom data in key-value pairs.
  */
 export interface CreateProductCategoryDTO {
+    /**
+     * The product category's name.
+     */
     name: string;
+    /**
+     * The product category's handle.
+     */
     handle?: string;
+    /**
+     * Whether the product category is active.
+     */
     is_active?: boolean;
+    /**
+     * Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.
+     */
     is_internal?: boolean;
+    /**
+     * The ranking of the category among sibling categories.
+     */
     rank?: number;
+    /**
+     * The ID of the parent product category, if it has any.
+     */
     parent_category_id: string | null;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown>;
@@ -195,18 +359,31 @@ }
  * The data to update in a product category.
- *
- * @prop name - The name of the product category.
- * @prop handle - The handle of the product category.
- * @prop is_active - Whether the product category is active.
- * @prop is_internal - Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.
- * @prop rank - The ranking of the category among sibling categories.
- * @prop parent_category_id - The ID of the parent product category, if it has any. It may also be `null`.
- * @prop metadata - Holds custom data in key-value pairs.
  */
 export interface UpdateProductCategoryDTO {
+    /**
+     * The name of the product category.
+     */
     name?: string;
+    /**
+     * The handle of the product category.
+     */
     handle?: string;
+    /**
+     * Whether the product category is active.
+     */
     is_active?: boolean;
+    /**
+     * Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.
+     */
     is_internal?: boolean;
+    /**
+     * The ranking of the category among sibling categories.
+     */
     rank?: number;
+    /**
+     * The ID of the parent product category, if it has any.
+     */
     parent_category_id?: string | null;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown>;
@@ -218,12 +395,21 @@ }
  * A product tag's data.
- *
- * @prop id - The ID of the product tag.
- * @prop value - The value of the product tag.
- * @prop metadata - Holds custom data in key-value pairs.
- * @prop products - The associated products. It may only be available if the `products` relation is expanded.
  */
 export interface ProductTagDTO {
+    /**
+     * The ID of the product tag.
+     */
     id: string;
+    /**
+     * The value of the product tag.
+     */
     value: string;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown> | null;
+    /**
+     * The associated products.
+     *
+     * @expandable
+     */
     products?: ProductDTO[];
@@ -235,16 +421,29 @@ }
  * A product collection's data.
- *
- * @prop id - The ID of the product collection.
- * @prop title - The title of the product collection.
- * @prop handle - The handle of the product collection. The handle can be used to create slug URL paths.
- * @prop metadata - Holds custom data in key-value pairs.
- * @prop deleted_at - When the product collection was deleted.
- * @prop products - The associated products. It may only be available if the `products` relation is expanded.
  */
 export interface ProductCollectionDTO {
+    /**
+     * The ID of the product collection.
+     */
     id: string;
+    /**
+     * The title of the product collection.
+     */
     title: string;
+    /**
+     * The handle of the product collection. The handle can be used to create slug URL paths.
+     */
     handle: string;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown> | null;
+    /**
+     * When the product collection was deleted.
+     */
     deleted_at?: string | Date;
+    /**
+     * The associated products.
+     *
+     * @expandable
+     */
     products?: ProductDTO[];
@@ -256,12 +455,19 @@ }
  * A product type's data.
- *
- * @prop id - The ID of the product type.
- * @prop value - The value of the product type.
- * @prop metadata - Holds custom data in key-value pairs.
- * @prop deleted_at - When the product type was deleted.
  */
 export interface ProductTypeDTO {
+    /**
+     * The ID of the product type.
+     */
     id: string;
+    /**
+     * The value of the product type.
+     */
     value: string;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown> | null;
+    /**
+     * When the product type was deleted.
+     */
     deleted_at?: string | Date;
@@ -274,16 +480,31 @@ }
  *
- * @prop id - The ID of the product option.
- * @prop title - The title of the product option.
- * @prop product - The associated product. It may only be available if the `product` relation is expanded.
- * @prop values - The associated product option values. It may only be available if the `values` relation is expanded.
- * @prop metadata - Holds custom data in key-value pairs.
- * @prop deleted_at - When the product option was deleted.
- *
  */
 export interface ProductOptionDTO {
+    /**
+     * The ID of the product option.
+     */
     id: string;
+    /**
+     * The title of the product option.
+     */
     title: string;
+    /**
+     * The associated product.
+     *
+     * @expandable
+     */
     product: ProductDTO;
+    /**
+     * The associated product option values.
+     *
+     * @expandable
+     */
     values: ProductOptionValueDTO[];
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown> | null;
+    /**
+     * When the product option was deleted.
+     */
     deleted_at?: string | Date;
@@ -302,5 +523,17 @@ }
 export interface ProductImageDTO {
+    /**
+     * The ID of the product image.
+     */
     id: string;
+    /**
+     * The URL of the product image.
+     */
     url: string;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown> | null;
+    /**
+     * When the product image was deleted.
+     */
     deleted_at?: string | Date;
@@ -321,7 +554,29 @@ }
 export interface ProductOptionValueDTO {
+    /**
+     * The ID of the product option value.
+     */
     id: string;
+    /**
+     * The value of the product option value.
+     */
     value: string;
+    /**
+     * The associated product option.
+     *
+     * @expandable
+     */
     option: ProductOptionDTO;
+    /**
+     * The associated product variant.
+     *
+     * @expandable
+     */
     variant: ProductVariantDTO;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown> | null;
+    /**
+     * When the product option value was deleted.
+     */
     deleted_at?: string | Date;
@@ -342,14 +597,47 @@ }
 export interface FilterableProductProps extends BaseFilterable<FilterableProductProps> {
+    /**
+     * Search through the products' attributes, such as titles and descriptions, using this search term.
+     */
     q?: string;
+    /**
+     * The handles to filter products by.
+     */
     handle?: string | string[];
+    /**
+     * The IDs to filter products by.
+     */
     id?: string | string[];
+    /**
+     * Filters on a product's tags.
+     */
     tags?: {
+        /**
+         * Values to filter product tags by.
+         */
         value?: string[];
     };
+    /**
+     * Filters on a product's categories.
+     */
     categories?: {
+        /**
+         * IDs to filter categories by.
+         */
         id?: string | string[] | OperatorMap<string>;
+        /**
+         * Filter categories by whether they're internal
+         */
         is_internal?: boolean;
+        /**
+         * Filter categories by whether they're active.
+         */
         is_active?: boolean;
     };
+    /**
+     * Filter a product by the IDs of their associated categories.
+     */
     category_id?: string | string[] | OperatorMap<string>;
+    /**
+     * Filters a product by the IDs of their associated collections.
+     */
     collection_id?: string | string[] | OperatorMap<string>;
@@ -366,3 +654,9 @@ }
 export interface FilterableProductTagProps extends BaseFilterable<FilterableProductTagProps> {
+    /**
+     * The IDs to filter product tags by.
+     */
     id?: string | string[];
+    /**
+     * The value to filter product tags by.
+     */
     value?: string;
@@ -379,3 +673,9 @@ }
 export interface FilterableProductTypeProps extends BaseFilterable<FilterableProductTypeProps> {
+    /**
+     * The IDs to filter product types by.
+     */
     id?: string | string[];
+    /**
+     * The value to filter product types by.
+     */
     value?: string;
@@ -393,4 +693,13 @@ }
 export interface FilterableProductOptionProps extends BaseFilterable<FilterableProductOptionProps> {
+    /**
+     * The IDs to filter product options by.
+     */
     id?: string | string[];
+    /**
+     * The titles to filter product options by.
+     */
     title?: string;
+    /**
+     * Filter the product options by their associated products' IDs.
+     */
     product_id?: string | string[];
@@ -407,4 +716,13 @@ }
 export interface FilterableProductCollectionProps extends BaseFilterable<FilterableProductCollectionProps> {
+    /**
+     * The IDs to filter product collections by.
+     */
     id?: string | string[];
+    /**
+     * The handles to filter product collections by.
+     */
     handle?: string | string[];
+    /**
+     * The title to filter product collections by.
+     */
     title?: string;
@@ -423,6 +741,21 @@ }
 export interface FilterableProductVariantProps extends BaseFilterable<FilterableProductVariantProps> {
+    /**
+     * The IDs to filter product variants by.
+     */
     id?: string | string[];
+    /**
+     * The SKUs to filter product variants by.
+     */
     sku?: string | string[];
+    /**
+     * Filter the product variants by their associated products' IDs.
+     */
     product_id?: string | string[];
+    /**
+     * Filter product variants by their associated options.
+     */
     options?: {
+        /**
+         * IDs to filter options by.
+         */
         id?: string[];
@@ -445,8 +778,29 @@ };
 export interface FilterableProductCategoryProps extends BaseFilterable<FilterableProductCategoryProps> {
+    /**
+     * The IDs to filter product categories by.
+     */
     id?: string | string[];
+    /**
+     * The names to filter product categories by.
+     */
     name?: string | string[];
+    /**
+     * Filter product categories by their parent category's ID.
+     */
     parent_category_id?: string | string[] | null;
+    /**
+     * The handles to filter product categories by.
+     */
     handle?: string | string[];
+    /**
+     * Filter product categories by whether they're active.
+     */
     is_active?: boolean;
+    /**
+     * Filter product categories by whether they're internal.
+     */
     is_internal?: boolean;
+    /**
+     * Whether to include children of retrieved product categories.
+     */
     include_descendants_tree?: boolean;
@@ -465,5 +819,17 @@ }
 export interface CreateProductCollectionDTO {
+    /**
+     * The product collection's title.
+     */
     title: string;
+    /**
+     * The product collection's handle. If not provided, the value of this attribute is set to the slug version of the title.
+     */
     handle?: string;
+    /**
+     * The products to associate with the collection.
+     */
     product_ids?: string[];
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown>;
@@ -475,16 +841,27 @@ }
  * The data to update in a product collection. The `id` is used to identify which product collection to update.
- *
- * @prop id - The ID of the product collection to update.
- * @prop value - The value of the product collection.
- * @prop title - The title of the product collection.
- * @prop handle - The handle of the product collection.
- * @prop product_ids - The IDs of the products to associate with the product collection.
- * @prop metadata - Holds custom data in key-value pairs.
  */
 export interface UpdateProductCollectionDTO {
+    /**
+     * The ID of the product collection to update.
+     */
     id: string;
+    /**
+     * The value of the product collection.
+     */
     value?: string;
+    /**
+     * The title of the product collection.
+     */
     title?: string;
+    /**
+     * The handle of the product collection.
+     */
     handle?: string;
+    /**
+     * The IDs of the products to associate with the product collection.
+     */
     product_ids?: string[];
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown>;
@@ -496,10 +873,15 @@ }
  * A product type to create.
- *
- * @prop id - The product type's ID.
- * @prop value - The product type's value.
- * @prop metadata - Holds custom data in key-value pairs.
  */
 export interface CreateProductTypeDTO {
+    /**
+     * The product type's ID.
+     */
     id?: string;
+    /**
+     * The product type's value.
+     */
     value: string;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown>;
@@ -515,10 +897,15 @@ }
  * The data to update in a product type. The `id` is used to identify which product type to update.
- *
- * @prop id - The ID of the product type to update.
- * @prop value - The new value of the product type.
- * @prop metadata - Holds custom data in key-value pairs.
  */
 export interface UpdateProductTypeDTO {
+    /**
+     * The ID of the product type to update.
+     */
     id: string;
+    /**
+     * The new value of the product type.
+     */
     value?: string;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown>;
@@ -530,6 +917,7 @@ }
  * A product tag to create.
- *
- * @prop value - The value of the product tag.
  */
 export interface CreateProductTagDTO {
+    /**
+     * The value of the product tag.
+     */
     value: string;
@@ -546,8 +934,11 @@ }
  * The data to update in a product tag. The `id` is used to identify which product tag to update.
- *
- * @prop id - The ID of the product tag to update.
- * @prop value - The value of the product tag.
  */
 export interface UpdateProductTagDTO {
+    /**
+     * The ID of the product tag to update.
+     */
     id: string;
+    /**
+     * The value of the product tag.
+     */
     value?: string;
@@ -559,8 +950,11 @@ }
  * A product option to create.
- *
- * @prop title - The product option's title.
- * @prop product_id - The ID of the associated product.
  */
 export interface CreateProductOptionDTO {
+    /**
+     * The product option's title.
+     */
     title: string;
+    /**
+     * The ID of the associated product.
+     */
     product_id?: string;
@@ -577,6 +971,7 @@ }
  * A product variant option to create.
- *
- * @prop value - The value of a product variant option.
  */
 export interface CreateProductVariantOptionDTO {
+    /**
+     * The value of a product variant option.
+     */
     value: string;
@@ -589,41 +984,79 @@ option_id?: string;
  * A product variant to create.
- *
- * @prop title - The tile of the product variant.
- * @prop sku - The SKU of the product variant.
- * @prop barcode - The barcode of the product variant.
- * @prop ean - The EAN of the product variant.
- * @prop upc - The UPC of the product variant.
- * @prop allow_backorder - Whether the product variant can be ordered when it's out of stock.
- * @prop inventory_quantity - The inventory quantiy of the product variant.
- * @prop manage_inventory - Whether the product variant's inventory should be managed by the core system.
- * @prop hs_code - The HS Code of the product variant.
- * @prop origin_country - The origin country of the product variant.
- * @prop mid_code - The MID Code of the product variant.
- * @prop material - The material of the product variant.
- * @prop weight - The weight of the product variant.
- * @prop length - The length of the product variant.
- * @prop height - The height of the product variant.
- * @prop width - The width of the product variant.
- * @prop options - The product variant options to create and associate with the product variant.
- * @prop metadata - Holds custom data in key-value pairs.
  */
 export interface CreateProductVariantDTO {
+    /**
+     * The id of the product
+     */
     product_id?: string;
+    /**
+     * The tile of the product variant.
+     */
     title: string;
+    /**
+     * The SKU of the product variant.
+     */
     sku?: string;
+    /**
+     * The barcode of the product variant.
+     */
     barcode?: string;
+    /**
+     * The EAN of the product variant.
+     */
     ean?: string;
+    /**
+     * The UPC of the product variant.
+     */
     upc?: string;
+    /**
+     * Whether the product variant can be ordered when it's out of stock.
+     */
     allow_backorder?: boolean;
+    /**
+     * The inventory quantiy of the product variant.
+     */
     inventory_quantity?: number;
+    /**
+     *  Whether the product variant's inventory should be managed by the core system.
+     */
     manage_inventory?: boolean;
+    /**
+     * The HS Code of the product variant.
+     */
     hs_code?: string;
+    /**
+     * The origin country of the product variant.
+     */
     origin_country?: string;
+    /**
+     * The MID Code of the product variant.
+     */
     mid_code?: string;
+    /**
+     * The material of the product variant.
+     */
     material?: string;
+    /**
+     * The weight of the product variant.
+     */
     weight?: number;
+    /**
+     * The length of the product variant.
+     */
     length?: number;
+    /**
+     * The height of the product variant.
+     */
     height?: number;
+    /**
+     * The width of the product variant.
+     */
     width?: number;
+    /**
+     * The product variant options to create and associate with the product variant.
+     */
     options?: CreateProductVariantOptionDTO[];
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown>;
@@ -635,42 +1068,79 @@ }
  * The data to update in a product variant. The `id` is used to identify which product variant to update.
- *
- * @prop id - The ID of the product variant to update.
- * @prop title - The tile of the product variant.
- * @prop sku - The SKU of the product variant.
- * @prop barcode - The barcode of the product variant.
- * @prop ean - The EAN of the product variant.
- * @prop upc - The UPC of the product variant.
- * @prop allow_backorder - Whether the product variant can be ordered when it's out of stock.
- * @prop inventory_quantity - The inventory quantiy of the product variant.
- * @prop manage_inventory - Whether the product variant's inventory should be managed by the core system.
- * @prop hs_code - The HS Code of the product variant.
- * @prop origin_country - The origin country of the product variant.
- * @prop mid_code - The MID Code of the product variant.
- * @prop material - The material of the product variant.
- * @prop weight - The weight of the product variant.
- * @prop length - The length of the product variant.
- * @prop height - The height of the product variant.
- * @prop width - The width of the product variant.
- * @prop options - The product variant options to create and associate with the product variant.
- * @prop metadata - Holds custom data in key-value pairs.
  */
 export interface UpdateProductVariantDTO {
+    /**
+     * The ID of the product variant to update.
+     */
     id: string;
+    /**
+     * The tile of the product variant.
+     */
     title?: string;
+    /**
+     * The SKU of the product variant.
+     */
     sku?: string;
+    /**
+     * The barcode of the product variant.
+     */
     barcode?: string;
+    /**
+     * The EAN of the product variant.
+     */
     ean?: string;
+    /**
+     * The UPC of the product variant.
+     */
     upc?: string;
+    /**
+     * Whether the product variant can be ordered when it's out of stock.
+     */
     allow_backorder?: boolean;
+    /**
+     * The inventory quantiy of the product variant.
+     */
     inventory_quantity?: number;
+    /**
+     * Whether the product variant's inventory should be managed by the core system.
+     */
     manage_inventory?: boolean;
+    /**
+     * The HS Code of the product variant.
+     */
     hs_code?: string;
+    /**
+     * The origin country of the product variant.
+     */
     origin_country?: string;
+    /**
+     * The MID Code of the product variant.
+     */
     mid_code?: string;
+    /**
+     * The material of the product variant.
+     */
     material?: string;
+    /**
+     * The weight of the product variant.
+     */
     weight?: number;
+    /**
+     * The length of the product variant.
+     */
     length?: number;
+    /**
+     * The height of the product variant.
+     */
     height?: number;
+    /**
+     * The width of the product variant.
+     */
     width?: number;
+    /**
+     * The product variant options to create and associate with the product variant.
+     */
     options?: CreateProductVariantOptionDTO[];
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown>;
@@ -682,39 +1152,28 @@ }
  * A product to create.
- *
- * @prop title - The title of the product.
- * @prop subtitle - The subttle of the product.
- * @prop description - The description of the product.
- * @prop is_giftcard - Whether the product is a gift card.
- * @prop discountable - Whether the product can be discounted.
- * @prop images -
- * The product's images. If an array of strings is supplied, each string will be a URL and a `ProductImage` will be created
- * and associated with the product. If an array of objects is supplied, you can pass along the ID of an existing `ProductImage`.
- * @prop thumbnail - The URL of the product's thumbnail.
- * @prop handle -
- * The handle of the product. The handle can be used to create slug URL paths.
- * If not supplied, the value of the `handle` attribute of the product is set to the slug version of the `title` attribute.
- * @prop status - The status of the product. Its value can be one of the values of the enum {@link ProductStatus}.
- * @prop type - The product type to create and associate with the product.
- * @prop type_id - The product type to be associated with the product.
- * @prop collection_id - The product collection to be associated with the product.
- * @prop tags - The product tags to be created and associated with the product.
- * @prop categories - The product categories to associate with the product.
- * @prop options - The product options to be created and associated with the product.
- * @prop variants - The product variants to be created and associated with the product.
- * @prop width - The width of the product.
- * @prop height - The height of the product.
- * @prop length - The length of the product.
- * @prop weight - The weight of the product.
- * @prop origin_country - The origin country of the product.
- * @prop hs_code - The HS Code of the product.
- * @prop material - The material of the product.
- * @prop mid_code - The MID Code of the product.
- * @prop metadata - Holds custom data in key-value pairs.
  */
 export interface CreateProductDTO {
+    /**
+     * The title of the product.
+     */
     title: string;
+    /**
+     * The subttle of the product.
+     */
     subtitle?: string;
+    /**
+     * The description of the product.
+     */
     description?: string;
+    /**
+     * Whether the product is a gift card.
+     */
     is_giftcard?: boolean;
+    /**
+     * Whether the product can be discounted.
+     */
     discountable?: boolean;
+    /**
+     * The product's images. If an array of strings is supplied, each string will be a URL and a `ProductImage` will be created
+     * and associated with the product. If an array of objects is supplied, you can pass along the ID of an existing `ProductImage`.
+     */
     images?: string[] | {
@@ -724,22 +1183,80 @@ id?: string;
     }[];
+    /**
+     * The URL of the product's thumbnail.
+     */
     thumbnail?: string;
+    /**
+     * The handle of the product. The handle can be used to create slug URL paths.
+     * If not supplied, the value of the `handle` attribute of the product is set to the slug version of the `title` attribute.
+     */
     handle?: string;
+    /**
+     * The status of the product.
+     */
     status?: ProductStatus;
+    /**
+     * The product type to create and associate with the product.
+     */
     type?: CreateProductTypeDTO;
+    /**
+     * The product type to be associated with the product.
+     */
     type_id?: string;
+    /**
+     * The product collection to be associated with the product.
+     */
     collection_id?: string;
+    /**
+     * The product tags to be created and associated with the product.
+     */
     tags?: CreateProductTagDTO[];
+    /**
+     * The product categories to associate with the product.
+     */
     categories?: {
         id: string;
     }[];
+    /**
+     * The product options to be created and associated with the product.
+     */
     options?: CreateProductOptionDTO[];
+    /**
+     * The product variants to be created and associated with the product.
+     */
     variants?: CreateProductVariantDTO[];
+    /**
+     * The width of the product.
+     */
     width?: number;
+    /**
+     * The height of the product.
+     */
     height?: number;
+    /**
+     * The length of the product.
+     */
     length?: number;
+    /**
+     * The weight of the product.
+     */
     weight?: number;
+    /**
+     * The origin country of the product.
+     */
     origin_country?: string;
+    /**
+     * The HS Code of the product.
+     */
     hs_code?: string;
+    /**
+     * The material of the product.
+     */
     material?: string;
+    /**
+     * The MID Code of the product.
+     */
     mid_code?: string;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown>;
@@ -751,42 +1268,32 @@ }
  * The data to update in a product. The `id` is used to identify which product to update.
- *
- * @prop id - The ID of the product to update.
- * @prop title - The title of the product.
- * @prop subtitle - The subttle of the product.
- * @prop description - The description of the product.
- * @prop is_giftcard - Whether the product is a gift card.
- * @prop discountable - Whether the product can be discounted.
- * @prop images -
- * The product's images. If an array of strings is supplied, each string will be a URL and a `ProductImage` will be created
- * and associated with the product. If an array of objects is supplied, you can pass along the ID of an existing `ProductImage`.
- * @prop thumbnail - The URL of the product's thumbnail.
- * @prop handle -
- * The handle of the product. The handle can be used to create slug URL paths.
- * If not supplied, the value of the `handle` attribute of the product is set to the slug version of the `title` attribute.
- * @prop status - The status of the product. Its value can be one of the values of the enum {@link ProductStatus}.
- * @prop type - The product type to create and associate with the product.
- * @prop type_id - The product type to be associated with the product.
- * @prop collection_id - The product collection to be associated with the product.
- * @prop tags - The product tags to be created and associated with the product.
- * @prop categories - The product categories to associate with the product.
- * @prop options - The product options to be created and associated with the product.
- * @prop variants -
- * The product variants to be created and associated with the product. You can also update existing product variants associated with the product.
- * @prop width - The width of the product.
- * @prop height - The height of the product.
- * @prop length - The length of the product.
- * @prop weight - The weight of the product.
- * @prop origin_country - The origin country of the product.
- * @prop hs_code - The HS Code of the product.
- * @prop material - The material of the product.
- * @prop mid_code - The MID Code of the product.
- * @prop metadata - Holds custom data in key-value pairs.
  */
 export interface UpdateProductDTO {
+    /**
+     * The ID of the product to update.
+     */
     id: string;
+    /**
+     * The title of the product.
+     */
     title?: string;
+    /**
+     * The subttle of the product.
+     */
     subtitle?: string;
+    /**
+     * The description of the product.
+     */
     description?: string;
+    /**
+     * Whether the product is a gift card.
+     */
     is_giftcard?: boolean;
+    /**
+     * Whether the product can be discounted.
+     */
     discountable?: boolean;
+    /**
+     * The product's images. If an array of strings is supplied, each string will be a URL and a `ProductImage` will be created
+     * and associated with the product. If an array of objects is supplied, you can pass along the ID of an existing `ProductImage`.
+     */
     images?: string[] | {
@@ -796,22 +1303,80 @@ id?: string;
     }[];
+    /**
+     * The URL of the product's thumbnail.
+     */
     thumbnail?: string;
+    /**
+     * The handle of the product. The handle can be used to create slug URL paths.
+     * If not supplied, the value of the `handle` attribute of the product is set to the slug version of the `title` attribute.
+     */
     handle?: string;
+    /**
+     * The status of the product.
+     */
     status?: ProductStatus;
+    /**
+     * The product type to create and associate with the product.
+     */
     type?: CreateProductTypeDTO;
+    /**
+     * The product type to be associated with the product.
+     */
     type_id?: string | null;
+    /**
+     * The product collection to be associated with the product.
+     */
     collection_id?: string | null;
+    /**
+     * The product tags to be created and associated with the product.
+     */
     tags?: CreateProductTagDTO[];
+    /**
+     * The product categories to associate with the product.
+     */
     categories?: {
         id: string;
     }[];
+    /**
+     * The product options to be created and associated with the product.
+     */
     options?: CreateProductOptionDTO[];
+    /**
+     * The product variants to be created and associated with the product. You can also update existing product variants associated with the product.
+     */
     variants?: (CreateProductVariantDTO | UpdateProductVariantDTO)[];
+    /**
+     * The width of the product.
+     */
     width?: number;
+    /**
+     * The height of the product.
+     */
     height?: number;
+    /**
+     * The length of the product.
+     */
     length?: number;
+    /**
+     * The weight of the product.
+     */
     weight?: number;
+    /**
+     * The origin country of the product.
+     */
     origin_country?: string;
+    /**
+     * The HS Code of the product.
+     */
     hs_code?: string;
+    /**
+     * The material of the product.
+     */
     material?: string;
+    /**
+     * The MID Code of the product.
+     */
     mid_code?: string;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown>;
@@ -818,0 +1383,0 @@ }

dist/shared-context.d.ts

@@ -6,8 +6,11 @@ import { EntityManager } from "typeorm";
  * A shared context object that is used to share resources between the application and the module.
- *
- * @prop transactionManager - An instance of a transaction manager.
- * @prop manager - An instance of an entity manager.
  */
 export type SharedContext = {
+    /**
+     * An instance of a transaction manager.
+     */
     transactionManager?: EntityManager;
+    /**
+     * An instance of an entity manager.
+     */
     manager?: EntityManager;
@@ -19,15 +22,24 @@ };
  * A shared context object that is used to share resources between the application and the module.
- *
- * @prop transactionManager - An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.
- * @prop manager - An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.
- * @prop isolationLevel - A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.
- * @prop enableNestedTransactions - a boolean value indicating whether nested transactions are enabled.
- * @prop transactionId - a string indicating the ID of the current transaction.
  */
 export type Context<TManager = unknown> = {
+    /**
+     * An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.
+     */
     transactionManager?: TManager;
+    /**
+     * An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.
+     */
     manager?: TManager;
+    /**
+     * A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.
+     */
     isolationLevel?: string;
+    /**
+     * A boolean value indicating whether nested transactions are enabled.
+     */
     enableNestedTransactions?: boolean;
+    /**
+     * A string indicating the ID of the current transaction.
+     */
     transactionId?: string;
 };

dist/stock-location/common.d.ts

@@ -154,8 +154,11 @@ import { StringComparisonOperator } from "../common/common";
  * The filters to apply on the retrieved stock locations.
- *
- * @prop id - The IDs to filter stock locations by.
- * @prop name - The names to filter stock locations by.
  */
 export type FilterableStockLocationProps = {
+    /**
+     * The IDs to filter stock locations by.
+     */
     id?: string | string[];
+    /**
+     * The names to filter stock locations by.
+     */
     name?: string | string[] | StringComparisonOperator;
@@ -162,0 +165,0 @@ };

dist/workflow/price-list/create-price-list.d.ts

@@ -32,15 +32,15 @@ import { CreatePriceListRules, PriceListRuleDTO, PriceListStatus } from "../../pricing";
 export interface CreatePriceListWorkflowInputDTO {
-    priceLists: CreatePriceListWorkflowDTO[];
+    price_lists: CreatePriceListWorkflowDTO[];
 }
 export interface RemovePriceListProductsWorkflowInputDTO {
-    productIds: string[];
-    priceListId: string;
+    product_ids: string[];
+    price_list_id: string;
 }
 export interface RemovePriceListVariantsWorkflowInputDTO {
-    variantIds: string[];
-    priceListId: string;
+    variant_ids: string[];
+    price_list_id: string;
 }
 export interface RemovePriceListPricesWorkflowInputDTO {
-    moneyAmountIds: string[];
-    priceListId: string;
+    money_amount_ids: string[];
+    price_list_id: string;
 }
@@ -51,7 +51,3 @@ export interface CreatePriceListWorkflowDTO {
     description: string;
-    customer_groups?: {
-        id: string;
-    }[];
     type?: string;
-    includes_tax?: boolean;
     starts_at?: string;
@@ -58,0 +54,0 @@ ends_at?: string;

dist/workflow/price-list/remove-price-list.d.ts

 export interface RemovePriceListWorkflowInputDTO {
-    priceLists: string[];
+    price_lists: string[];
 }

package.json

 {
   "name": "@medusajs/types",
-  "version": "1.11.7-snapshot-20231117092635",
+  "version": "1.11.7-snapshot-20231120171146",
   "description": "Medusa Types definition",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

No alert changes

Improved metrics

Total package byte prevSize

404356

increased by0.62%

Lines of code

11092

increased by6.63%

No dependency changes