@medusajs/types - npm Package Compare versions

Comparing version 1.11.7 to 1.11.8-next-20231123174728

dist/pricing/common/currency.d.ts

@@ -6,13 +6,19 @@ import { BaseFilterable } from "../../dal";
  * A currency's data.
- *
- * @prop code - The code of the currency.
- * @prop symbol - The symbol of the currency.
- * @prop symbol_native -
- * The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.
- * @prop name - The name of the currency.
  */
 export interface CurrencyDTO {
+    /**
+     * The code of the currency.
+     */
     code: string;
+    /**
+     * The symbol of the currency.
+     */
     symbol?: string;
+    /**
+     * The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.
+     */
     symbol_native?: string;
+    /**
+     * The name of the currency.
+     */
     name?: string;
@@ -24,13 +30,19 @@ }
  * A currency to create.
- *
- * @prop code - The code of the currency.
- * @prop symbol - The symbol of the currency.
- * @prop symbol_native -
- * The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.
- * @prop name - The name of the currency.
  */
 export interface CreateCurrencyDTO {
+    /**
+     * The code of the currency.
+     */
     code: string;
+    /**
+     * The symbol of the currency.
+     */
     symbol: string;
+    /**
+     * The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.
+     */
     symbol_native: string;
+    /**
+     * The name of the currency.
+     */
     name: string;
@@ -42,13 +54,19 @@ }
  * The data to update in a currency. The `code` is used to identify which currency to update.
- *
- * @prop code - The code of the currency to update.
- * @prop symbol - The symbol of the currency.
- * @prop symbol_native -
- * The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.
- * @prop name - The name of the currency.
  */
 export interface UpdateCurrencyDTO {
+    /**
+     * The code of the currency to update.
+     */
     code: string;
+    /**
+     * The symbol of the currency.
+     */
     symbol?: string;
+    /**
+     * The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.
+     */
     symbol_native?: string;
+    /**
+     * The name of the currency.
+     */
     name?: string;
@@ -60,7 +78,8 @@ }
  * Filters to apply on a currency.
- *
- * @prop code - The codes to filter the currencies by.
  */
 export interface FilterableCurrencyProps extends BaseFilterable<FilterableCurrencyProps> {
+    /**
+     * The codes to filter the currencies by.
+     */
     code?: string[];
 }

dist/pricing/common/money-amount.d.ts

@@ -8,17 +8,33 @@ import { BaseFilterable } from "../../dal";
  * A money amount's data. A money amount represents a price.
- *
- * @prop id - The ID of the money amount.
- * @prop currency_code - The currency code of this money amount.
- * @prop currency - The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.
- * @prop amount - The price of this money amount.
- * @prop min_quantity - The minimum quantity required to be purchased for this price to be applied.
- * @prop max_quantity - The maximum quantity required to be purchased for this price to be applied.
  */
 export interface MoneyAmountDTO {
+    /**
+     * The ID of the money amount.
+     */
     id: string;
+    /**
+     * The currency code of this money amount.
+     */
     currency_code?: string;
+    /**
+     * The money amount's currency.
+     *
+     * @expandable
+     */
     currency?: CurrencyDTO;
+    /**
+     * The price of this money amount.
+     */
     amount?: number;
+    /**
+     * The minimum quantity required to be purchased for this price to be applied.
+     */
     min_quantity?: number;
+    /**
+     * The maximum quantity required to be purchased for this price to be applied.
+     */
     max_quantity?: number;
+    /**
+     * The details of the relation between the money amount and its associated price set.
+     */
     price_set_money_amount?: PriceSetMoneyAmountDTO;
@@ -30,35 +46,54 @@ }
  * The money amount to create.
- *
- * @prop id - The ID of the money amount.
- * @prop currency_code - The currency code of this money amount.
- * @prop currency - The currency of this money amount.
- * @prop amount - The amount of this money amount.
- * @prop min_quantity - The minimum quantity required to be purchased for this money amount to be applied.
- * @prop max_quantity - The maximum quantity required to be purchased for this money amount to be applied.
  */
 export interface CreateMoneyAmountDTO {
+    /**
+     * The ID of the money amount.
+     */
     id?: string;
+    /**
+     * The currency code of this money amount.
+     */
     currency_code: string;
+    /**
+     * The currency of this money amount.
+     */
     currency?: CreateCurrencyDTO;
+    /**
+     * The amount of this money amount.
+     */
     amount: number;
+    /**
+     * The minimum quantity required to be purchased for this money amount to be applied.
+     */
     min_quantity?: number | null;
+    /**
+     * The maximum quantity required to be purchased for this money amount to be applied.
+     */
     max_quantity?: number | null;
 }
 /**
- *  * @interface
+ * @interface
  *
  * The data to update in a money amount. The `id` is used to identify which money amount to update.
- *
- * @prop id - The ID of the money amount to update.
- * @prop currency_code - The code of the currency to associate with the money amount.
- * @prop currency - The currency to associte with the money amount.
- * @prop amount - The price of this money amount.
- * @prop min_quantity - The minimum quantity required to be purchased for this money amount to be applied.
- * @prop max_quantity - The maximum quantity required to be purchased for this money amount to be applied.
  */
 export interface UpdateMoneyAmountDTO {
+    /**
+     * The ID of the money amount to update.
+     */
     id: string;
+    /**
+     * The code of the currency to associate with the money amount.
+     */
     currency_code?: string;
+    /**
+     * The price of this money amount.
+     */
     amount?: number;
+    /**
+     * The minimum quantity required to be purchased for this money amount to be applied.
+     */
     min_quantity?: number;
+    /**
+     * The maximum quantity required to be purchased for this money amount to be applied.
+     */
     max_quantity?: number;
@@ -70,9 +105,12 @@ }
  * Filters to apply on a money amount.
- *
- * @prop id - IDs to filter money amounts by.
- * @prop currency_code - Currency codes to filter money amounts by.
  */
 export interface FilterableMoneyAmountProps extends BaseFilterable<FilterableMoneyAmountProps> {
+    /**
+     * IDs to filter money amounts by.
+     */
     id?: string[];
+    /**
+     * Currency codes to filter money amounts by.
+     */
     currency_code?: string | string[];
 }

dist/pricing/common/price-list.d.ts

@@ -5,59 +5,241 @@ import { CreateMoneyAmountDTO, MoneyAmountDTO } from "./money-amount";
 import { RuleTypeDTO } from "./rule-type";
+/**
+ * @enum
+ *
+ * The price list's status.
+ */
 export declare enum PriceListStatus {
+    /**
+     * The price list is enabled and its prices can be used.
+     */
     ACTIVE = "active",
+    /**
+     * The price list is disabled, meaning its prices can't be used yet.
+     */
     DRAFT = "draft"
 }
+/**
+ * @enum
+ *
+ * The price list's type.
+ */
 export declare enum PriceListType {
+    /**
+     * The price list's prices are used for a sale.
+     */
     SALE = "sale",
+    /**
+     * The price list's prices override original prices. This affects the calculated price of associated price sets.
+     */
     OVERRIDE = "override"
 }
+/**
+ * @interface
+ *
+ * A price list's details.
+ */
 export interface PriceListDTO {
+    /**
+     * The price list's ID.
+     */
     id: string;
+    /**
+     * The price list's title.
+     */
     title?: string;
+    /**
+     * The price list is enabled starting from this date.
+     */
     starts_at?: string | null;
+    /**
+     * The price list's status.
+     */
     status?: PriceListStatus;
+    /**
+     * The price list expires after this date.
+     */
     ends_at?: string | null;
+    /**
+     * The number of rules associated with this price list.
+     */
     number_rules?: number;
+    /**
+     * The associated price set money amounts.
+     *
+     * @expandable
+     */
     price_set_money_amounts?: PriceSetMoneyAmountDTO[];
+    /**
+     * The associated money amounts.
+     *
+     * @expandable
+     */
     money_amounts?: MoneyAmountDTO[];
+    /**
+     * The associated rule types.
+     *
+     * @expandable
+     */
     rule_types?: RuleTypeDTO[];
+    /**
+     * The price set's rules.
+     *
+     * @expandable
+     */
     rules?: PriceListRuleDTO[];
+    /**
+     * The price set's rules.
+     *
+     * @privateRemarks
+     * Do we need both this and `rules`?
+     *
+     * @expandable
+     */
     price_list_rules?: PriceListRuleDTO[];
 }
+/**
+ * @interface
+ *
+ * The prices associated with a price list.
+ */
 export interface PriceListPriceDTO extends CreateMoneyAmountDTO {
+    /**
+     * The ID of the associated price set.
+     */
     price_set_id: string;
 }
+/**
+ * @interface
+ *
+ * The price list's rules to be set. Each key of the object is a rule type's `rule_attribute`, and its value
+   * is the values of the rule.
+ */
 export interface CreatePriceListRules extends Record<string, string[]> {
 }
+/**
+ * @interface
+ *
+ * The price list to create.
+ */
 export interface CreatePriceListDTO {
+    /**
+     * The price list's title.
+     */
     title: string;
+    /**
+     * The price list's description.
+     */
     description: string;
+    /**
+     * The price list is enabled starting from this date.
+     */
     starts_at?: string;
+    /**
+     * The price list expires after this date.
+     */
     ends_at?: string;
+    /**
+     * The price list's status.
+     */
     status?: PriceListStatus;
+    /**
+     * The price list's type.
+     */
     type?: PriceListType;
+    /**
+     * The number of rules associated with the price list.
+     */
     number_rules?: number;
+    /**
+     * The rules to be created and associated with the price list.
+     */
     rules?: CreatePriceListRules;
+    /**
+     * The prices associated with the price list.
+     */
     prices?: PriceListPriceDTO[];
 }
+/**
+ * @interface
+ *
+ * The attributes to update in a price list.
+ */
 export interface UpdatePriceListDTO {
+    /**
+     * The ID of the price list to update.
+     */
     id: string;
+    /**
+     * The price list's title.
+     */
     title?: string;
+    /**
+     * The price list is enabled starting from this date.
+     */
     starts_at?: string;
+    /**
+     * The price list expires after this date.
+     */
     ends_at?: string;
+    /**
+     * The price list's status.
+     */
     status?: PriceListStatus;
+    /**
+     * The number of rules associated with the price list.
+     */
     number_rules?: number;
+    /**
+     * The rules to be created and associated with the price list.
+     */
     rules?: CreatePriceListRules;
 }
+/**
+ * @inteface
+ *
+ * Filters to apply on price lists.
+ */
 export interface FilterablePriceListProps extends BaseFilterable<FilterablePriceListProps> {
+    /**
+     * The IDs to filter price lists by
+     */
     id?: string[];
+    /**
+     * The start dates to filter price lists by.
+     */
     starts_at?: string[];
+    /**
+     * The end dates to filter price lists by.
+     */
     ends_at?: string[];
+    /**
+     * The statuses to filter price lists by.
+     */
     status?: PriceListStatus[];
+    /**
+     * The number of rules to filter price lists by.
+     */
     number_rules?: number[];
 }
+/**
+ * @interface
+ *
+ * Filters to apply on price list rules.
+ */
 export interface FilterablePriceListRuleProps extends BaseFilterable<FilterablePriceListRuleProps> {
+    /**
+     * The IDs to filter price list rules by.
+     */
     id?: string[];
+    /**
+     * The values to filter price list rules by.
+     */
     value?: string[];
+    /**
+     * Filter price list rules by the ID of their associated rule types.
+     */
     rule_type?: string[];
+    /**
+     * Filter price list rules by the ID of their associated price lists.
+     */
     price_list_id?: string[];
@@ -70,25 +252,107 @@ }
 }
+/**
+ * @interface
+ *
+ * The price list rule's details.
+ */
 export interface PriceListRuleDTO {
+    /**
+     * The price list rule's ID.
+     */
     id: string;
+    /**
+     * The value of the rule.
+     *
+     * @privateRemarks
+     * Shouldn't this be in PriceListRuleValueDTO only?
+     */
     value: string;
+    /**
+     * The associated rule type.
+     *
+     * @expandable
+     */
     rule_type: RuleTypeDTO;
+    /**
+     * The associated price list.
+     *
+     * @expandable
+     */
     price_list: PriceListDTO;
+    /**
+     * The associated rule values.
+     *
+     * @expandable
+     */
     price_list_rule_values?: PriceListRuleValueDTO[];
 }
+/**
+ * @interface
+ *
+ * The price list rule to create.
+ */
 export interface CreatePriceListRuleDTO {
+    /**
+     * The ID of a rule type to be associated with the price list rule.
+     */
     rule_type_id?: string;
+    /**
+     * The ID of a rule type or the details of an existing rule type to be associated with the price list rule.
+     */
     rule_type?: string | RuleTypeDTO;
+    /**
+     * The ID of a price list to be associated with the price list rule.
+     */
     price_list_id?: string;
+    /**
+     * The ID of a price list or the details of an existing price list to be associated with the price list rule.
+     */
     price_list?: string | PriceListDTO;
 }
+/**
+ * @interface
+ *
+ * The attributes to update in a price list rule.
+ */
 export interface UpdatePriceListRuleDTO {
+    /**
+     * The ID of the price list rule to update.
+     */
     id: string;
+    /**
+     * The ID of a price list to be associated with the price list rule.
+     */
     price_list_id?: string;
+    /**
+     * The ID of a rule type to be associated with the price list rule.
+     */
     rule_type_id?: string;
+    /**
+     * The ID of a price list to be associated with the price list rule.
+     */
     price_list?: string;
+    /**
+     * The ID of a rule type or the details of an existing rule type to be associated with the price list rule.
+     */
     rule_type?: string;
 }
+/**
+ * @interface
+ *
+ * The price list rule value's details.
+ */
 export interface PriceListRuleValueDTO {
+    /**
+     * The price list rule value's ID.
+     */
     id: string;
+    /**
+     * The rule's value.
+     */
     value: string;
+    /**
+     * The associated price list rule.
+     *
+     * @expandable
+     */
     price_list_rule: PriceListRuleDTO;
@@ -106,13 +370,47 @@ }
 }
+/**
+ * @interface
+ *
+ * The prices to be added to a price list.
+ */
 export interface AddPriceListPricesDTO {
+    /**
+     * The ID of the price list to add prices to.
+     */
     priceListId: string;
+    /**
+     * The prices to add.
+     */
     prices: PriceListPriceDTO[];
 }
+/**
+ * @interface
+ *
+ * The rules to add to a price list.
+ */
 export interface SetPriceListRulesDTO {
+    /**
+     * The ID of the price list to add rules to.
+     */
     priceListId: string;
+    /**
+     * The rules to add to the price list. Each key of the object is a rule type's `rule_attribute`, and its value
+     * is the value(s) of the rule.
+     */
     rules: Record<string, string | string[]>;
 }
+/**
+ * @interface
+ *
+ * The rules to remove from a price list.
+ */
 export interface RemovePriceListRulesDTO {
+    /**
+     * The ID of the price list to remove rules from.
+     */
     priceListId: string;
+    /**
+     * The rules to remove from the price list. Each item being a rule type's `rule_attribute`.
+     */
     rules: string[];
 }

dist/pricing/common/price-list.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PriceListType = exports.PriceListStatus = void 0;
+/**
+ * @enum
+ *
+ * The price list's status.
+ */
 var PriceListStatus;
 (function (PriceListStatus) {
+    /**
+     * The price list is enabled and its prices can be used.
+     */
     PriceListStatus["ACTIVE"] = "active";
+    /**
+     * The price list is disabled, meaning its prices can't be used yet.
+     */
     PriceListStatus["DRAFT"] = "draft";
 })(PriceListStatus || (exports.PriceListStatus = PriceListStatus = {}));
+/**
+ * @enum
+ *
+ * The price list's type.
+ */
 var PriceListType;
 (function (PriceListType) {
+    /**
+     * The price list's prices are used for a sale.
+     */
     PriceListType["SALE"] = "sale";
+    /**
+     * The price list's prices override original prices. This affects the calculated price of associated price sets.
+     */
     PriceListType["OVERRIDE"] = "override";
 })(PriceListType || (exports.PriceListType = PriceListType = {}));
 //# sourceMappingURL=price-list.js.map

dist/pricing/common/price-rule.d.ts

@@ -8,29 +8,42 @@ import { BaseFilterable } from "../../dal";
  * A price rule's data.
- *
- * @prop id - The ID of the price rule.
- * @prop price_set_id - The ID of the associated price set.
- * @prop price_set - The associated price set. It may only be available if the relation `price_set` is expanded.
- * @prop rule_type_id - The ID of the associated rule type.
- * @prop rule_type - The associated rule type. It may only be available if the relation `rule_type` is expanded.
- * @prop value - The value of the price rule.
- * @prop priority - The priority of the price rule in comparison to other applicable price rules.
- * @prop price_set_money_amount_id - The ID of the associated price set money amount.
- * @prop price_list_id - The ID of the associated price list.
  */
 export interface PriceRuleDTO {
+    /**
+     * The ID of the price rule.
+     */
     id: string;
+    /**
+     * The ID of the associated price set.
+     */
     price_set_id: string;
+    /**
+     * The associated price set.
+     * @expandable
+     */
     price_set: PriceSetDTO;
+    /**
+     * The ID of the associated rule type.
+     */
     rule_type_id: string;
-    rule_type: RuleTypeDTO;
     /**
-     * @ignore
-     * @privateRemark
+     * The associated rule type.
      *
-     * Behavior behind this property is not implemented yet.
+     * @expandable
      */
-    is_dynamic: boolean;
+    rule_type: RuleTypeDTO;
+    /**
+     * The value of the price rule.
+     */
     value: string;
+    /**
+     * The priority of the price rule in comparison to other applicable price rules.
+     */
     priority: number;
+    /**
+     * The ID of the associated price set money amount.
+     */
     price_set_money_amount_id: string;
+    /**
+     * The ID of the associated price list.
+     */
     price_list_id: string;
@@ -43,22 +56,19 @@ }
  * A price rule to create.
- *
- * @prop id - The ID of the price rule.
- * @prop price_set_id - The ID of the associated price set.
- * @prop rule_type_id - The ID of the associated rule type.
- * @prop value - The value of the price rule.
- * @prop priority - The priority of the price rule in comparison to other applicable price rules.
- * @prop price_set_money_amount_id - The ID of the associated price set money amount.
- * @prop price_list_id - The ID of the associated price list.
  */
 export interface CreatePriceRuleDTO {
+    /**
+     * The ID of the price rule.
+     */
     id: string;
+    /**
+     * The ID of the associated price set.
+     */
     price_set_id: string;
+    /**
+     * The ID of the associated rule type.
+     */
     rule_type_id: string;
     /**
-     * @ignore
-     * @privateRemark
-     *
-     * Behavior behind this property is not implemented yet.
+     * The value of the price rule.
      */
-    is_dynamic?: boolean;
     value: string;
@@ -73,10 +83,2 @@ priority?: number;
  * The data to update in a price rule. The `id` is used to identify which money amount to update.
- *
- * @prop id - The ID of the price rule to update.
- * @prop price_set_id - The ID of the associated price set.
- * @prop rule_type_id - The ID of the associated rule type.
- * @prop value - The value of the price rule.
- * @prop priority - The priority of the price rule in comparison to other applicable price rules.
- * @prop price_set_money_amount_id - The ID of the associated price set money amount.
- * @prop price_list_id - The ID of the associated price list.
  */
@@ -88,11 +90,16 @@ export interface UpdatePriceRuleDTO {
     /**
-     * @ignore
-     * @privateRemark
-     *
-     * Behavior behind this property is not implemented yet.
+     * The value of the price rule.
      */
-    is_dynamic?: boolean;
     value?: string;
+    /**
+     * The priority of the price rule in comparison to other applicable price rules.
+     */
     priority?: number;
+    /**
+     * The ID of the associated price set money amount.
+     */
     price_set_money_amount_id?: string;
+    /**
+     * The ID of the associated price list.
+     */
     price_list_id?: string;
@@ -102,15 +109,21 @@ }
  * @interface
- *
- * Filters to apply to price rules.
- *
- * @prop id - The IDs to filter price rules by.
- * @prop name - The names to filter price rules by.
- * @prop price_set_id - The IDs to filter the price rule's associated price set.
- * @prop rule_type_id - The IDs to filter the price rule's associated rule type.
+ * Filters to apply on price rules.
  */
 export interface FilterablePriceRuleProps extends BaseFilterable<FilterablePriceRuleProps> {
+    /**
+     * The IDs to filter price rules by.
+     */
     id?: string[];
+    /**
+     * The names to filter price rules by.
+     */
     name?: string[];
+    /**
+     * The IDs to filter the price rule's associated price set.
+     */
     price_set_id?: string[];
+    /**
+     * The IDs to filter the price rule's associated rule type.
+     */
     rule_type_id?: string[];
 }

dist/pricing/common/price-set-money-amount-rules.d.ts

@@ -8,12 +8,23 @@ import { BaseFilterable } from "../../dal";
  * A price set money amount rule's data.
- *
- * @prop id - The ID of the price set money amount.
- * @prop price_set_money_amount - The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.
- * @prop rule_type - The associated rule type. It may only be available if the relation `rule_type` is expanded.
- * @prop value - The value of the price set money amount rule.
  */
 export interface PriceSetMoneyAmountRulesDTO {
+    /**
+     * The ID of the price set money amount.
+     */
     id: string;
+    /**
+     * The associated price set money amount.
+     *
+     * @expandable
+     */
     price_set_money_amount: PriceSetMoneyAmountDTO;
+    /**
+     * The associated rule type.
+     *
+     * @expandable
+     */
     rule_type: RuleTypeDTO;
+    /**
+     * The value of the price set money amount rule.
+     */
     value: string;
@@ -25,10 +36,15 @@ }
  * The price set money amount rule to create.
- *
- * @prop price_set_money_amount - The ID of a price set money amount.
- * @prop rule_type - The ID of a rule type.
- * @prop value - The value of the price set money amount rule.
  */
 export interface CreatePriceSetMoneyAmountRulesDTO {
+    /**
+     * The ID of a price set money amount.
+     */
     price_set_money_amount: string;
+    /**
+     * The ID of a rule type.
+     */
     rule_type: string;
+    /**
+     * The value of the price set money amount rule.
+     */
     value: string;
@@ -40,12 +56,19 @@ }
  * The data to update in a price set money amount rule. The `id` is used to identify which money amount to update.
- *
- * @prop id - The ID of the price set money amount rule to update.
- * @prop price_set_money_amount - The ID of a price set money amount.
- * @prop rule_type - The ID of a rule type.
- * @prop value - The value of the price set money amount rule.
  */
 export interface UpdatePriceSetMoneyAmountRulesDTO {
+    /**
+     * The ID of the price set money amount rule to update.
+     */
     id: string;
+    /**
+     * The ID of a price set money amount.
+     */
     price_set_money_amount?: string;
+    /**
+     * The ID of a rule type.
+     */
     rule_type?: string;
+    /**
+     * The value of the price set money amount rule.
+     */
     value?: string;
@@ -57,13 +80,20 @@ }
  * Filters to apply on price set money amount rules.
- *
- * @prop id - The ID to filter price set money amount rules by.
- * @prop rule_type_id - The IDs to filter the price set money amount rule's associated rule type.
- * @prop price_set_money_amount_id - The IDs to filter the price set money amount rule's associated price set money amount.
- * @prop value - The value to filter price set money amount rules by.
  */
 export interface FilterablePriceSetMoneyAmountRulesProps extends BaseFilterable<FilterablePriceSetMoneyAmountRulesProps> {
+    /**
+     * The ID to filter price set money amount rules by.
+     */
     id?: string[];
+    /**
+     * The IDs to filter the price set money amount rule's associated rule type.
+     */
     rule_type_id?: string[];
+    /**
+     * The IDs to filter the price set money amount rule's associated price set money amount.
+     */
     price_set_money_amount_id?: string[];
+    /**
+     * The value to filter price set money amount rules by.
+     */
     value?: string[];
 }

dist/pricing/common/price-set-money-amount.d.ts

@@ -10,15 +10,39 @@ import { BaseFilterable } from "../../dal";
  * A price set money amount's data.
- *
- * @prop id - The ID of a price set money amount.
- * @prop title - The title of the price set money amount.
- * @prop price_set - The price set associated with the price set money amount. It may only be available if the relation `price_set` is expanded.
- * @prop money_amount - The money amount associated with the price set money amount. It may only be available if the relation `money_amount` is expanded.
  */
 export interface PriceSetMoneyAmountDTO {
+    /**
+     * The ID of a price set money amount.
+     */
     id: string;
+    /**
+     * The title of the price set money amount.
+     */
     title?: string;
+    /**
+     * The price set associated with the price set money amount.
+     *
+     * @expandable
+     */
     price_set?: PriceSetDTO;
+    /**
+     * The price list associated with the price set money amount.
+     *
+     * @expandable
+     */
     price_list?: PriceListDTO;
+    /**
+     * The ID of the associated price set.
+     */
     price_set_id?: string;
+    /**
+     * The price rules associated with the price set money amount.
+     *
+     * @expandable
+     */
     price_rules?: PriceRuleDTO[];
+    /**
+     * The money amount associated with the price set money amount.
+     *
+     * @expandable
+     */
     money_amount?: MoneyAmountDTO;
@@ -42,10 +66,16 @@ }
  * Filters to apply on price set money amounts.
- *
- * @prop id - The IDs to filter the price set money amounts by.
- * @prop price_set_id - The IDs to filter the price set money amount's associated price set.
  */
 export interface FilterablePriceSetMoneyAmountProps extends BaseFilterable<FilterablePriceSetMoneyAmountProps> {
+    /**
+     * The IDs to filter the price set money amounts by.
+     */
     id?: string[];
+    /**
+     * The IDs to filter the price set money amount's associated price set.
+     */
     price_set_id?: string[];
+    /**
+     * The IDs to filter the price set money amount's associated price list.
+     */
     price_list_id?: string[];
 }

dist/pricing/common/price-set.d.ts

@@ -9,8 +9,8 @@ import { BaseFilterable } from "../../dal";
  *
- * @prop context -
- * an object whose keys are the name of the context attribute. Its value can be a string or a number. For example, you can pass the `currency_code` property with its value being the currency code to calculate the price in.
- * Another example is passing the `quantity` property to calculate the price for that specified quantity, which finds a price set whose `min_quantity` and `max_quantity` conditions match the specified quantity.
- *
  */
 export interface PricingContext {
+    /**
+     * an object whose keys are the name of the context attribute. Its value can be a string or a number. For example, you can pass the `currency_code` property with its value being the currency code to calculate the price in.
+     * Another example is passing the `quantity` property to calculate the price for that specified quantity, which finds a price set whose `min_quantity` and `max_quantity` conditions match the specified quantity.
+     */
     context?: Record<string, string | number>;
@@ -22,6 +22,7 @@ }
  * Filters to apply on prices.
- *
- * @prop id - IDs to filter prices.
  */
 export interface PricingFilters {
+    /**
+     * IDs to filter prices.
+     */
     id: string[];
@@ -33,11 +34,15 @@ }
  * A price set's data.
- *
- * @prop id - The ID of the price set.
- * @prop money_amounts - The prices that belong to this price set.
- * @prop rule_types - The rule types applied on this price set.
- *
  */
 export interface PriceSetDTO {
+    /**
+     * The ID of the price set.
+     */
     id: string;
+    /**
+     * The prices that belong to this price set.
+     */
     money_amounts?: MoneyAmountDTO[];
+    /**
+     * The rule types applied on this price set.
+     */
     rule_types?: RuleTypeDTO[];
@@ -50,37 +55,119 @@ }
  *
- * @prop id - The ID of the price set.
- * @prop amount - The calculated amount. It can possibly be `null` if there's no price set up for the provided context.
- * @prop currency_code - The currency code of the calculated price. It can possibly be `null`.
- * @prop min_quantity - The minimum quantity required to be purchased for this price to apply. It's set if the `quantity` property is provided in the context. Otherwise, its value will be `null`.
- * @prop max_quantity - The maximum quantity required to be purchased for this price to apply. It's set if the `quantity` property is provided in the context. Otherwise, its value will be `null`.
+ * @privateRemarks
+ * Do we still need this type? Shouldn't we use CalculatedPriceSet instead?
  */
 export interface CalculatedPriceSetDTO {
+    /**
+     * The ID of the money amount.
+     */
     id: string;
+    /**
+     * The ID of the associated price set.
+     */
     price_set_id: string;
+    /**
+     * The calculated amount. It can possibly be `null` if there's no price set up for the provided context.
+     */
     amount: string | null;
+    /**
+     * The currency code of the calculated price. It can possibly be `null`.
+     */
     currency_code: string | null;
+    /**
+     * The minimum quantity required to be purchased for this price to apply. It's set if the `quantity` property is provided in the context. Otherwise, its value will be `null`.
+     */
     min_quantity: string | null;
+    /**
+     * The maximum quantity required to be purchased for this price to apply. It's set if the `quantity` property is provided in the context. Otherwise, its value will be `null`.
+     */
     max_quantity: string | null;
+    /**
+     * The type of the associated price list, if any.
+     */
     price_list_type: string | null;
+    /**
+     * The ID of the associated price list, if any.
+     */
     price_list_id: string | null;
 }
+/**
+ * @interface
+ *
+ * The calculated price for a specific price set and context.
+ */
 export interface CalculatedPriceSet {
+    /**
+     * The ID of the price set.
+     */
     id: string;
+    /**
+     * Whether the calculated price is associated with a price list. During the calculation process, if no valid price list is found,
+     * the calculated price is set to the original price, which doesn't belong to a price list. In that case, the value of this property is `false`.
+     */
     is_calculated_price_price_list?: boolean;
+    /**
+     * The amount of the calculated price, or `null` if there isn't a calculated price.
+     */
     calculated_amount: number | null;
+    /**
+     * Whether the original price is associated with a price list. During the calculation process, if the price list of the calculated price is of type override,
+     * the original price will be the same as the calculated price. In that case, the value of this property is `true`.
+     */
     is_original_price_price_list?: boolean;
+    /**
+     * The amount of the original price, or `null` if there isn't a calculated price.
+     */
     original_amount: number | null;
+    /**
+     * The currency code of the calculated price, or null if there isn't a calculated price.
+     */
     currency_code: string | null;
+    /**
+     * The details of the calculated price.
+     */
     calculated_price?: {
+        /**
+         * The ID of the money amount selected as the calculated price.
+         */
         money_amount_id: string | null;
+        /**
+         * The ID of the associated price list, if any.
+         */
         price_list_id: string | null;
+        /**
+         * The type of the associated price list, if any.
+         */
         price_list_type: string | null;
+        /**
+         * The `min_quantity` field defined on a money amount.
+         */
         min_quantity: number | null;
+        /**
+         * The `max_quantity` field defined on a money amount.
+         */
         max_quantity: number | null;
     };
+    /**
+     * The details of the original price.
+     */
     original_price?: {
+        /**
+         * The ID of the money amount selected as the original price.
+         */
         money_amount_id: string | null;
+        /**
+         * The ID of the associated price list, if any.
+         */
         price_list_id: string | null;
+        /**
+         * The type of the associated price list, if any.
+         */
         price_list_type: string | null;
+        /**
+         * The `min_quantity` field defined on a money amount.
+         */
         min_quantity: number | null;
+        /**
+         * The `max_quantity` field defined on a money amount.
+         */
         max_quantity: number | null;
@@ -93,9 +180,15 @@ };
  * The rules to add to a price set.
- *
- * @prop priceSetId - The ID of the price set to add the rules to.
- * @prop rules - The rules to add to a price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.
  */
 export interface AddRulesDTO {
+    /**
+     * The ID of the price set to add the rules to.
+     */
     priceSetId: string;
+    /**
+     * The rules to add to a price set.
+     */
     rules: {
+        /**
+         * The value of the rule's `rule_attribute` attribute.
+         */
         attribute: string;
@@ -108,6 +201,7 @@ }[];
  * The prices to create part of a price set.
- *
- * @prop rules - The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.
  */
 export interface CreatePricesDTO extends CreateMoneyAmountDTO {
+    /**
+     * The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.
+     */
     rules: Record<string, string>;
@@ -119,8 +213,11 @@ }
  * The prices to add to a price set.
- *
- * @prop priceSetId - The ID of the price set to add prices to.
- * @prop prices - The prices to add to the price set.
  */
 export interface AddPricesDTO {
+    /**
+     * The ID of the price set to add prices to.
+     */
     priceSetId: string;
+    /**
+     * The prices to add to the price set.
+     */
     prices: CreatePricesDTO[];
@@ -132,8 +229,11 @@ }
  * The rules to remove from a price set.
- *
- * @prop id - The ID of the price set.
- * @prop rules - The rules to remove. Each string is the `rule_attribute` of a rule to remove.
  */
 export interface RemovePriceSetRulesDTO {
+    /**
+     * The ID of the price set.
+     */
     id: string;
+    /**
+     * The rules to remove. Each string is the `rule_attribute` of a rule to remove.
+     */
     rules: string[];
@@ -145,10 +245,16 @@ }
  * A price set to create.
- *
- * @prop rules - The rules to associate with the price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.
- * @prop prices -The prices to create and add to this price set.
  */
 export interface CreatePriceSetDTO {
+    /**
+     * The rules to associate with the price set.
+     */
     rules?: {
+        /**
+         * the value of the rule's `rule_attribute` attribute.
+         */
         rule_attribute: string;
     }[];
+    /**
+     * The prices to create and add to this price set.
+     */
     prices?: CreatePricesDTO[];
@@ -160,6 +266,7 @@ }
  * The data to update in a price set. The `id` is used to identify which price set to update.
- *
- * @prop id - A string indicating the ID of the price set to update.
  */
 export interface UpdatePriceSetDTO {
+    /**
+     * A string indicating the ID of the price set to update.
+     */
     id: string;
@@ -171,9 +278,12 @@ }
  * Filters to apply on price sets.
- *
- * @prop id - IDs to filter price sets by.
- * @prop money_amounts - Filters to apply on a price set's associated money amounts.
  */
 export interface FilterablePriceSetProps extends BaseFilterable<FilterablePriceSetProps> {
+    /**
+     * IDs to filter price sets by.
+     */
     id?: string[];
+    /**
+     * Filters to apply on a price set's associated money amounts.
+     */
     money_amounts?: FilterableMoneyAmountProps;
 }

dist/pricing/common/rule-type.d.ts

@@ -6,12 +6,21 @@ import { BaseFilterable } from "../../dal";
  * A rule type's data.
- *
- * @prop id - The ID of the rule type.
- * @prop name - The display name of the rule type.
- * @prop rule_attribute - The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.
- * @prop default_priority - The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.
  */
 export interface RuleTypeDTO {
+    /**
+     * The ID of the rule type.
+     */
     id: string;
+    /**
+     * The display name of the rule type.
+     */
     name: string;
+    /**
+     * The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of
+     * the `calculatePrices` method to specify a rule for calculating the price.
+     */
     rule_attribute: string;
+    /**
+     * The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy
+     * the provided context. The higher the value, the higher the priority of the rule type.
+     */
     default_priority: number;
@@ -23,12 +32,21 @@ }
  * The rule type to create.
- *
- * @prop id - The ID of the rule type.
- * @prop name - The display name of the rule type.
- * @prop rule_attribute - The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.
- * @prop default_priority - The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.
  */
 export interface CreateRuleTypeDTO {
+    /**
+     * The ID of the rule type.
+     */
     id?: string;
+    /**
+     * The display name of the rule type.
+     */
     name: string;
+    /**
+     * The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices`
+     * method to specify a rule for calculating the price.
+     */
     rule_attribute: string;
+    /**
+     * The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context.
+     * The higher the value, the higher the priority of the rule type.
+     */
     default_priority?: number;
@@ -40,12 +58,19 @@ }
  * The data to update in a rule type. The `id` is used to identify which price set to update.
- *
- * @prop id - The ID of the rule type to update.
- * @prop name - The display name of the rule type.
- * @prop rule_attribute - The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.
- * @prop default_priority - The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.
  */
 export interface UpdateRuleTypeDTO {
+    /**
+     * The ID of the rule type to update.
+     */
     id: string;
+    /**
+     * The display name of the rule type.
+     */
     name?: string;
+    /**
+     * The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.
+     */
     rule_attribute?: string;
+    /**
+     * The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.
+     */
     default_priority?: number;
@@ -57,11 +82,16 @@ }
  * Filters to apply on rule types.
- *
- * @prop id - The IDs to filter rule types by.
- * @prop name - The names to filter rule types by.
- * @prop rule_attribute - The rule attributes to filter rule types by.
  */
 export interface FilterableRuleTypeProps extends BaseFilterable<FilterableRuleTypeProps> {
+    /**
+     * The IDs to filter rule types by.
+     */
     id?: string[];
+    /**
+     * The names to filter rule types by.
+     */
     name?: string[];
+    /**
+     * The rule attributes to filter rule types by.
+     */
     rule_attribute?: string[];
 }

dist/product/common.d.ts

@@ -229,3 +229,3 @@ import { BaseFilterable } from "../dal";
      */
-    options: ProductOptionValueDTO;
+    options: ProductOptionValueDTO[];
     /**
@@ -508,2 +508,7 @@ * Holds custom data in key-value pairs.
  * The product image's data.
+ *
+ * @prop id - The ID of the product image.
+ * @prop url - The URL of the product image.
+ * @prop metadata - Holds custom data in key-value pairs.
+ * @prop deleted_at - When the product image was deleted.
  */
@@ -532,2 +537,9 @@ export interface ProductImageDTO {
  * The product option value's data.
+ *
+ * @prop id - The ID of the product option value.
+ * @prop value - The value of the product option value.
+ * @prop option - The associated product option. It may only be available if the `option` relation is expanded.
+ * @prop variant - The associated product variant. It may only be available if the `variant` relation is expanded.
+ * @prop metadata - Holds custom data in key-value pairs.
+ * @prop deleted_at - When the product option value was deleted.
  */
@@ -568,2 +580,9 @@ export interface ProductOptionValueDTO {
  * The filters to apply on retrieved products.
+ *
+ * @prop q - Search through the products' attributes, such as titles and descriptions, using this search term.
+ * @prop handle - The handles to filter products by.
+ * @prop id - The IDs to filter products by.
+ * @prop tags - Filters on a product's tags.
+ * @prop categories - Filters on a product's categories.
+ * @prop collection_id - Filters a product by its associated collections.
  */
@@ -622,2 +641,5 @@ export interface FilterableProductProps extends BaseFilterable<FilterableProductProps> {
  * The filters to apply on retrieved product tags.
+ *
+ * @prop id - The IDs to filter product tags by.
+ * @prop value - The value to filter product tags by.
  */
@@ -638,2 +660,5 @@ export interface FilterableProductTagProps extends BaseFilterable<FilterableProductTagProps> {
  * The filters to apply on retrieved product types.
+ *
+ * @prop id - The IDs to filter product types by.
+ * @prop value - The value to filter product types by.
  */
@@ -654,2 +679,6 @@ export interface FilterableProductTypeProps extends BaseFilterable<FilterableProductTypeProps> {
  * The filters to apply on retrieved product options.
+ *
+ * @prop id - The IDs to filter product options by.
+ * @prop title - The titles to filter product options by.
+ * @prop product_id - Filter the product options by their associated products' IDs.
  */
@@ -674,2 +703,5 @@ export interface FilterableProductOptionProps extends BaseFilterable<FilterableProductOptionProps> {
  * The filters to apply on retrieved product collections.
+ *
+ * @prop id - The IDs to filter product collections by.
+ * @prop title - The title to filter product collections by.
  */
@@ -694,2 +726,7 @@ export interface FilterableProductCollectionProps extends BaseFilterable<FilterableProductCollectionProps> {
  * The filters to apply on retrieved product variants.
+ *
+ * @prop id - The IDs to filter product variants by.
+ * @prop sku - The SKUs to filter product variants by.
+ * @prop product_id - Filter the product variants by their associated products' IDs.
+ * @prop options - Filter product variants by their associated options.
  */
@@ -723,2 +760,10 @@ export interface FilterableProductVariantProps extends BaseFilterable<FilterableProductVariantProps> {
  * The filters to apply on retrieved product categories.
+ *
+ * @prop id - The IDs to filter product categories by.
+ * @prop name - The names to filter product categories by.
+ * @prop parent_category_id - Filter product categories by their parent category's ID.
+ * @prop handle - The handles to filter product categories by.
+ * @prop is_active - Filter product categories by whether they're active.
+ * @prop is_internal - Filter product categories by whether they're internal.
+ * @prop include_descendants_tree - Whether to include children of retrieved product categories.
  */
@@ -759,2 +804,7 @@ export interface FilterableProductCategoryProps extends BaseFilterable<FilterableProductCategoryProps> {
  * A product collection to create.
+ *
+ * @prop title - The product collection's title.
+ * @prop handle - The product collection's handle. If not provided, the value of this attribute is set to the slug version of the title.
+ * @prop products - The products to associate with the collection.
+ * @prop metadata - Holds custom data in key-value pairs.
  */
@@ -913,2 +963,3 @@ export interface CreateProductCollectionDTO {
     value: string;
+    option_id?: string;
 }
@@ -922,2 +973,6 @@ /**
     /**
+     * The id of the product
+     */
+    product_id?: string;
+    /**
      * The tile of the product variant.
@@ -1342,2 +1397,3 @@ */
 export interface CreateProductVariantOnlyDTO {
+    product_id?: string;
     title: string;
@@ -1344,0 +1400,0 @@ sku?: string;

dist/workflow/index.d.ts

@@ -5,1 +5,2 @@ export * as CartWorkflow from "./cart";
 export * as InventoryWorkflow from "./inventory";
+export * as PriceListWorkflow from "./price-list";

dist/workflow/index.js

@@ -26,3 +26,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InventoryWorkflow = exports.ProductWorkflow = exports.CommonWorkflow = exports.CartWorkflow = void 0;
+exports.PriceListWorkflow = exports.InventoryWorkflow = exports.ProductWorkflow = exports.CommonWorkflow = exports.CartWorkflow = void 0;
 exports.CartWorkflow = __importStar(require("./cart"));
@@ -32,2 +32,3 @@ exports.CommonWorkflow = __importStar(require("./common"));
 exports.InventoryWorkflow = __importStar(require("./inventory"));
+exports.PriceListWorkflow = __importStar(require("./price-list"));
 //# sourceMappingURL=index.js.map

dist/workflow/product/index.d.ts

@@ -0,3 +1,4 @@
+export * from "./create-product-variants";
 export * from "./create-products";
 export * from "./update-product-variants";
 export * from "./update-products";

dist/workflow/product/index.js

@@ -17,2 +17,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./create-product-variants"), exports);
 __exportStar(require("./create-products"), exports);
@@ -19,0 +20,0 @@ __exportStar(require("./update-product-variants"), exports);

package.json

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

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

439063

increased by11.27%

Number of package files

223

increased by7.21%

Lines of code

12440

increased by14.49%

Worsened metrics

Number of low quality alerts

2

increased by100%

No dependency changes