@medusajs/types
Advanced tools
Comparing version
@@ -214,15 +214,15 @@ import { NumericalComparisonOperator, StringComparisonOperator } from "../common"; | ||
export type CreateInventoryItemInput = { | ||
sku?: string; | ||
origin_country?: string; | ||
mid_code?: string; | ||
material?: string; | ||
weight?: number; | ||
length?: number; | ||
height?: number; | ||
width?: number; | ||
title?: string; | ||
description?: string; | ||
thumbnail?: string; | ||
sku?: string | null; | ||
origin_country?: string | null; | ||
mid_code?: string | null; | ||
material?: string | null; | ||
weight?: number | null; | ||
length?: number | null; | ||
height?: number | null; | ||
width?: number | null; | ||
title?: string | null; | ||
description?: string | null; | ||
thumbnail?: string | null; | ||
metadata?: Record<string, unknown> | null; | ||
hs_code?: string; | ||
hs_code?: string | null; | ||
requires_shipping?: boolean; | ||
@@ -229,0 +229,0 @@ }; |
@@ -5,10 +5,9 @@ import { BaseFilterable } from "../../dal"; | ||
* | ||
* An object representing a currency. | ||
* A currency's data. | ||
* | ||
* @prop code - a string indicating the code of the currency. | ||
* @prop symbol - a string indicating the symbol of the currency. | ||
* @prop code - The code of the currency. | ||
* @prop symbol - The symbol of the currency. | ||
* @prop symbol_native - | ||
* a string indicating the symbol of the currecy in its native form. | ||
* This is typically the symbol used when displaying a price. | ||
* @prop name - a string indicating the name of the currency. | ||
* 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. | ||
*/ | ||
@@ -24,10 +23,9 @@ export interface CurrencyDTO { | ||
* | ||
* An object that holds data to create a currency. | ||
* A currency to create. | ||
* | ||
* @prop code - a string indicating the code of the currency. | ||
* @prop symbol - a string indicating the symbol of the currency. | ||
* @prop code - The code of the currency. | ||
* @prop symbol - The symbol of the currency. | ||
* @prop symbol_native - | ||
* a string indicating the symbol of the currecy in its native form. | ||
* This is typically the symbol used when displaying a price. | ||
* @prop name - a string indicating the name of the currency. | ||
* 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. | ||
*/ | ||
@@ -43,10 +41,9 @@ export interface CreateCurrencyDTO { | ||
* | ||
* An object that holds data to update a currency. The currency code must be provided to identify which currency to update. | ||
* The data to update in a currency. The `code` is used to identify which currency to update. | ||
* | ||
* @prop code - a string indicating the code of the currency to update. | ||
* @prop symbol - a string indicating the symbol of the currency. | ||
* @prop code - The code of the currency to update. | ||
* @prop symbol - The symbol of the currency. | ||
* @prop symbol_native - | ||
* a string indicating the symbol of the currecy in its native form. | ||
* This is typically the symbol used when displaying a price. | ||
* @prop name - a string indicating the name of the currency. | ||
* 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. | ||
*/ | ||
@@ -62,5 +59,5 @@ export interface UpdateCurrencyDTO { | ||
* | ||
* An object used to filter retrieved currencies. | ||
* Filters to apply on a currency. | ||
* | ||
* @prop code - an array of strings, each being a currency code to filter the currencies. | ||
* @prop code - The codes to filter the currencies by. | ||
*/ | ||
@@ -67,0 +64,0 @@ export interface FilterableCurrencyProps extends BaseFilterable<FilterableCurrencyProps> { |
@@ -6,10 +6,10 @@ import { BaseFilterable } from "../../dal"; | ||
* | ||
* An object that holds prices, which typically belong to a price set. | ||
* A money amount's data. A money amount represents a price. | ||
* | ||
* @prop id - A string that indicates the ID of the money amount. A money amount represents a price. | ||
* @prop currency_code - A string that indicates the currency code of this price. | ||
* @prop currency - An object of type {@link CurrencyDTO} that holds the details of the price'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 - A number indicating the amount of this price. | ||
* @prop min_quantity - A number that indicates the minimum quantity required to be purchased for this price to be applied. | ||
* @prop max_quantity - A number that indicates the maximum quantity required to be purchased for this price to be applied. | ||
* @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. | ||
*/ | ||
@@ -25,12 +25,12 @@ export interface MoneyAmountDTO { | ||
/** | ||
* * @interface | ||
* @interface | ||
* | ||
* An object that holds data to create a money amount. | ||
* The money amount to create. | ||
* | ||
* @prop id - A string that indicates the ID of the money amount. | ||
* @prop currency_code - A string that indicates the currency code of this money amount. | ||
* @prop currency - An object of type {@link CurrencyDTO} that holds the details of 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 - A number indicating the amount of this money amount. | ||
* @prop min_quantity - A number that indicates the minimum quantity required to be purchased for this money amount to be applied. | ||
* @prop max_quantity - A number that indicates the maximum quantity required to be purchased for this money amount to be applied. | ||
* @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. | ||
*/ | ||
@@ -48,10 +48,10 @@ export interface CreateMoneyAmountDTO { | ||
* | ||
* An object that holds data to update a money amount. | ||
* The data to update in a money amount. The `id` is used to identify which money amount to update. | ||
* | ||
* @prop id - A string that indicates the ID of the money amount to update. | ||
* @prop currency_code - A string that indicates the currency code of the money amount. | ||
* @prop currency - An object of type {@link CurrencyDTO} that holds the details of 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 - A number indicating the amount of this money amount. | ||
* @prop min_quantity - A number that indicates the minimum quantity required to be purchased for this money amount to be applied. | ||
* @prop max_quantity - A number that indicates the maximum quantity required to be purchased for this money amount to be applied. | ||
* @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. | ||
*/ | ||
@@ -68,6 +68,6 @@ export interface UpdateMoneyAmountDTO { | ||
* | ||
* An object that can be used to filter money amounts. | ||
* Filters to apply on a money amount. | ||
* | ||
* @prop id - An array of strings, each being an ID to filter money amounts. | ||
* @prop currency_code - A string or an array of strings, each being a currency code to filter money amounts. | ||
* @prop id - IDs to filter money amounts by. | ||
* @prop currency_code - Currency codes to filter money amounts by. | ||
*/ | ||
@@ -74,0 +74,0 @@ export interface FilterableMoneyAmountProps extends BaseFilterable<FilterableMoneyAmountProps> { |
@@ -7,14 +7,13 @@ import { BaseFilterable } from "../../dal"; | ||
* | ||
* An object that represents a price rule. | ||
* A price rule's data. | ||
* | ||
* @prop id - A string indicating the ID of the price rule. | ||
* @prop price_set_id - A string indicating the ID of the associated price set. | ||
* @prop price_set - An object of type {@link PriceSetDTO} that holds the data of the associated price set. It may only be available if the relation `price_set` is expanded. | ||
* @prop rule_type_id - A string indicating the ID of the associated rule type. | ||
* @prop rule_type - An object of type {@link RuleTypeDTO} that holds the data of the associated rule type. It may only be available if the relation `rule_type` is expanded. | ||
* @prop is_dynamic - A boolean indicating whether the price rule is dynamic. | ||
* @prop value - A string indicating the value of the price rule. | ||
* @prop priority - A number indicating the priority of the price rule in comparison to other applicable price rules. | ||
* @prop price_set_money_amount_id - A string indicating the ID of the associated price set money amount. | ||
* @prop price_list_id - A string indicating the ID of the associated price list. | ||
* @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. | ||
*/ | ||
@@ -27,2 +26,8 @@ export interface PriceRuleDTO { | ||
rule_type: RuleTypeDTO; | ||
/** | ||
* @ignore | ||
* @privateRemark | ||
* | ||
* Behavior behind this property is not implemented yet. | ||
*/ | ||
is_dynamic: boolean; | ||
@@ -38,12 +43,11 @@ value: string; | ||
* | ||
* An object used to specify the necessary data to create a price rule. | ||
* A price rule to create. | ||
* | ||
* @prop id - A string indicating the ID of the price rule. | ||
* @prop price_set_id - A string indicating the ID of the associated price set. | ||
* @prop rule_type_id - A string indicating the ID of the associated rule type. | ||
* @prop is_dynamic - A boolean indicating whether the price rule is dynamic. | ||
* @prop value - A string indicating the value of the price rule. | ||
* @prop priority - A number indicating the priority of the price rule in comparison to other applicable price rules. | ||
* @prop price_set_money_amount_id - A string indicating the ID of the associated price set money amount. | ||
* @prop price_list_id - A string indicating the ID of the associated price list. | ||
* @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. | ||
*/ | ||
@@ -54,2 +58,8 @@ export interface CreatePriceRuleDTO { | ||
rule_type_id: string; | ||
/** | ||
* @ignore | ||
* @privateRemark | ||
* | ||
* Behavior behind this property is not implemented yet. | ||
*/ | ||
is_dynamic?: boolean; | ||
@@ -65,11 +75,11 @@ value: string; | ||
* | ||
* An object used to specify the necessary data to update a price rule. | ||
* The data to update in a price rule. The `id` is used to identify which money amount to update. | ||
* | ||
* @prop id - A string indicating the ID of the price rule to update. | ||
* @prop price_set_id - A string indicating the ID of the associated price set. | ||
* @prop rule_type_id - A string indicating the ID of the associated rule type. | ||
* @prop value - A string indicating the value of the price rule. | ||
* @prop priority - A number indicating the priority of the price rule in comparison to other applicable price rules. | ||
* @prop price_set_money_amount_id - A string indicating the ID of the associated price set money amount. | ||
* @prop price_list_id - A string indicating the ID of the associated price list. | ||
* @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. | ||
*/ | ||
@@ -95,8 +105,8 @@ export interface UpdatePriceRuleDTO { | ||
* | ||
* An object used to filter price rules when retrieving them. | ||
* Filters to apply to price rules. | ||
* | ||
* @prop id - An array of strings, each indicating an ID to filter price rules. | ||
* @prop name - An array of strings, each indicating a name to filter price rules. | ||
* @prop price_set_id - An array of strings, each indicating a price set ID to filter price rules. | ||
* @prop rule_type_id - An array of strings, each indicating a rule type ID to filter rule types. | ||
* @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. | ||
*/ | ||
@@ -103,0 +113,0 @@ export interface FilterablePriceRuleProps extends BaseFilterable<FilterablePriceRuleProps> { |
@@ -7,8 +7,8 @@ import { BaseFilterable } from "../../dal"; | ||
* | ||
* An object representing a price set money amount rule, which holds data related to the association between a price set money amount and a rule. | ||
* A price set money amount rule's data. | ||
* | ||
* @prop id - A string indicating the ID of the price set money amount. | ||
* @prop price_set_money_amount - an object of type {@link PriceSetMoneyAmountDTO} holding the data of the associated price set money amount. | ||
* @prop rule_type - an object of type {@link RuleTypeDTO} holding the data of the associated rule type. | ||
* @prop value - a string indicating the value of the price set money amount rule. | ||
* @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. | ||
*/ | ||
@@ -24,7 +24,7 @@ export interface PriceSetMoneyAmountRulesDTO { | ||
* | ||
* An object used to create a price set money amount rule, which represents an association between a price set money amount and a rule type. | ||
* The price set money amount rule to create. | ||
* | ||
* @prop price_set_money_amount - A string indicating the ID of a price set money amount. | ||
* @prop rule_type - A string indicating the ID of a rule type. | ||
* @prop value - A string indicating the value of the price set money amount rule. | ||
* @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. | ||
*/ | ||
@@ -39,8 +39,8 @@ export interface CreatePriceSetMoneyAmountRulesDTO { | ||
* | ||
* An object used to update a price set money amount rule. The price set money amount rule is identified by the provided `id`. | ||
* The data to update in a price set money amount rule. The `id` is used to identify which money amount to update. | ||
* | ||
* @prop id - A string indicating the ID of the price set money amount rule to update. | ||
* @prop price_set_money_amount - A string indicating the ID of a price set money amount. | ||
* @prop rule_type - A string indicating the ID of a rule type. | ||
* @prop value - A string indicating the value of the price set money amount rule. | ||
* @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. | ||
*/ | ||
@@ -56,8 +56,8 @@ export interface UpdatePriceSetMoneyAmountRulesDTO { | ||
* | ||
* An object used to filter price set money amount rules when listing them. | ||
* Filters to apply on price set money amount rules. | ||
* | ||
* @prop id - An array of strings, each string indicating an ID to filter the price set money amount rules. | ||
* @prop rule_type_id - An array of strings, each string indicating the ID of a rule type to filter the price set money amount rules. | ||
* @prop price_set_money_amount_id - an array of strings, each string indicating the ID of a price set money amount to filter the price set money amount rules. | ||
* @prop value - an array of strings, each string indicating a value to filter the 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. | ||
*/ | ||
@@ -64,0 +64,0 @@ export interface FilterablePriceSetMoneyAmountRulesProps extends BaseFilterable<FilterablePriceSetMoneyAmountRulesProps> { |
@@ -6,8 +6,8 @@ import { MoneyAmountDTO } from "./money-amount"; | ||
* | ||
* An object representing a price set money amount, which holds the data related to the association between a price set and a money amount. | ||
* A price set money amount's data. | ||
* | ||
* @prop id - a string indicating the ID of a price set money amount. | ||
* @prop title - a string indicating the title of the price set money amount. | ||
* @prop price_set - an object of type {@link PriceSetDTO} holding the data of the associated price set. | ||
* @prop money_amount - an object of type {@link MoneyAmountDTO} holding the data of the associated money amount. | ||
* @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. | ||
*/ | ||
@@ -14,0 +14,0 @@ export interface PriceSetMoneyAmountDTO { |
@@ -7,3 +7,3 @@ import { BaseFilterable } from "../../dal"; | ||
* | ||
* Used to specify the context to calculate prices. For example, you can specify the currency code to calculate prices in. | ||
* The context to calculate prices. For example, you can specify the currency code to calculate prices in. | ||
* | ||
@@ -14,5 +14,2 @@ * @prop context - | ||
* | ||
* @example | ||
* | ||
* To calculate prices | ||
*/ | ||
@@ -25,5 +22,5 @@ export interface PricingContext { | ||
* | ||
* Used to filter prices when calculating them. | ||
* Filters to apply on prices. | ||
* | ||
* @prop id - An array of strings, each being an ID of a price set. | ||
* @prop id - IDs to filter prices. | ||
*/ | ||
@@ -36,7 +33,7 @@ export interface PricingFilters { | ||
* | ||
* An object that holds the details of a retrieved price set. | ||
* A price set's data. | ||
* | ||
* @prop id - A string indicating the ID of the price set. | ||
* @prop money_amounts - An array of objects of type {@link MoneyAmountDTO}, which holds the prices that belong to this price set. | ||
* @prop rule_types - An array of objects of type {@link RuleTypeDTO}, which holds the rule types applied on this price set. | ||
* @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. | ||
* | ||
@@ -52,9 +49,9 @@ */ | ||
* | ||
* An object that holds the details of a calculated price set. | ||
* A calculated price set's data. | ||
* | ||
* @prop id - a string indicating the ID of the price set. | ||
* @prop amount - a number indicating the calculated amount. It can possibly be `null` if there's no price set up for the provided context. | ||
* @prop currency_code - a string indicating the currency code of the calculated price. It can possibly be `null`. | ||
* @prop min_quantity - a number indicaitng 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 - a number indicaitng 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`. | ||
* @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`. | ||
*/ | ||
@@ -71,6 +68,6 @@ export interface CalculatedPriceSetDTO { | ||
* | ||
* An object used to specify the rules to add to a price set. | ||
* The rules to add to a price set. | ||
* | ||
* @prop priceSetId - A string indicating the ID of the price set to add the rules to. | ||
* @prop rules - An array of objects, each object holds a property `attribute`, with its value being the `rule_attribute` of the rule to add to the 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. | ||
*/ | ||
@@ -86,5 +83,5 @@ export interface AddRulesDTO { | ||
* | ||
* An object used to pass prices data when creating a price set. | ||
* The prices to create part of a price set. | ||
* | ||
* @prop rules - An object whose keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price. | ||
* @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. | ||
*/ | ||
@@ -97,6 +94,6 @@ export interface CreatePricesDTO extends CreateMoneyAmountDTO { | ||
* | ||
* An object used to specify prices to add to a price set. | ||
* The prices to add to a price set. | ||
* | ||
* @prop priceSetId - A string indicating the ID of the price set to add prices to. | ||
* @prop prices - An array of objects of type {@link CreatePricesDTO}, each being a price to add to the price set. | ||
* @prop priceSetId - The ID of the price set to add prices to. | ||
* @prop prices - The prices to add to the price set. | ||
*/ | ||
@@ -110,6 +107,6 @@ export interface AddPricesDTO { | ||
* | ||
* An object of expected properties when removing a price set's rules. | ||
* The rules to remove from a price set. | ||
* | ||
* @prop id - A string indicating the ID of the price set. | ||
* @prop rules - An array of strings, each string is the `rule_attribute` of a rule you want to remove. | ||
* @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. | ||
*/ | ||
@@ -123,8 +120,6 @@ export interface RemovePriceSetRulesDTO { | ||
* | ||
* An object of expected properties when creating a price set. | ||
* A price set to create. | ||
* | ||
* @prop rules - | ||
* An array of objects, each object accepts a property `rule_attribute`, whose value is a string indicating the `rule_attribute` value of a rule type. | ||
* This property is used to specify the rule types associated with the price set. | ||
* @prop prices - An array of objects of type {@link CreatePricesDTO}, each being a price to associate with the price set. | ||
* @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. | ||
*/ | ||
@@ -140,3 +135,3 @@ export interface CreatePriceSetDTO { | ||
* | ||
* An object of expected properties when updating a price set. | ||
* The data to update in a price set. The `id` is used to identify which price set to update. | ||
* | ||
@@ -151,6 +146,6 @@ * @prop id - A string indicating the ID of the price set to update. | ||
* | ||
* An object that can be used to specify filters on price sets. | ||
* Filters to apply on price sets. | ||
* | ||
* @prop id - An array of strings, each being an ID to filter price sets. | ||
* @prop money_amounts - An object of type {@link FilterableMoneyAmountProps} that is used to filter the price sets by their associated money amounts. | ||
* @prop id - IDs to filter price sets by. | ||
* @prop money_amounts - Filters to apply on a price set's associated money amounts. | ||
*/ | ||
@@ -157,0 +152,0 @@ export interface FilterablePriceSetProps extends BaseFilterable<FilterablePriceSetProps> { |
@@ -5,8 +5,8 @@ import { BaseFilterable } from "../../dal"; | ||
* | ||
* An object that holds the details of a rule type. | ||
* A rule type's data. | ||
* | ||
* @prop id - A string indicating the ID of the rule type. | ||
* @prop name - A string indicating the display name of the rule type. | ||
* @prop rule_attribute - A string indicating a 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 - A number indicating 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. | ||
* @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. | ||
*/ | ||
@@ -22,8 +22,8 @@ export interface RuleTypeDTO { | ||
* | ||
* An object used when creating a rule type to specify its data. | ||
* The rule type to create. | ||
* | ||
* @prop id - A string indicating the ID of the rule type. | ||
* @prop name - A string indicating the display name of the rule type. | ||
* @prop rule_attribute - A string indicating a 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 - A number indicating 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. | ||
* @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. | ||
*/ | ||
@@ -39,8 +39,8 @@ export interface CreateRuleTypeDTO { | ||
* | ||
* An object used when updating a rule type to specify the data to update. | ||
* The data to update in a rule type. The `id` is used to identify which price set to update. | ||
* | ||
* @prop id - A string indicating the ID of the rule type to update. | ||
* @prop name - A string indicating the display name of the rule type. | ||
* @prop rule_attribute - A string indicating a 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 - A number indicating 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. | ||
* @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. | ||
*/ | ||
@@ -56,7 +56,7 @@ export interface UpdateRuleTypeDTO { | ||
* | ||
* An object used to filter retrieved rule types. | ||
* Filters to apply on rule types. | ||
* | ||
* @prop id - an array of strings, each being an ID to filter rule types. | ||
* @prop name - an array of strings, each being a name to filter rule types. | ||
* @prop rule_attribute - an array of strings, each being a rule attribute to filter 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. | ||
*/ | ||
@@ -63,0 +63,0 @@ export interface FilterableRuleTypeProps extends BaseFilterable<FilterableRuleTypeProps> { |
{ | ||
"name": "@medusajs/types", | ||
"version": "1.11.4-snapshot-20231013131050", | ||
"version": "1.11.4-snapshot-20231018112000", | ||
"description": "Medusa Types definition", | ||
@@ -5,0 +5,0 @@ "main": "dist/index.js", |
Sorry, the diff of this file is too big to display
5805
0.73%226150
-3.57%