chore: updated TSDocs of the Pricing Module (#6894)

This commit is contained in:
Shahed Nasser
2024-04-05 13:02:46 +03:00
committed by GitHub
parent 4c374e3a14
commit 3507e5e263
3 changed files with 736 additions and 1699 deletions

View File

@@ -452,11 +452,11 @@ export interface UpdatePriceListPricesDTO {
/**
* @interface
*
* The rules to add to a price list.
* The rules to set in a price list.
*/
export interface SetPriceListRulesDTO {
/**
* The ID of the price list to add rules to.
* The ID of the price list to set its rules.
*/
price_list_id: string
/**

View File

@@ -33,11 +33,12 @@ export interface PricingContext {
/**
* @interface
*
* Filters to apply on prices.
* Filters to apply when calculating prices.
*/
export interface PricingFilters {
/**
* IDs to filter prices.
* IDs of the price sets to use in the
* calculation.
*/
id: string[]
}
@@ -282,11 +283,12 @@ export interface CreatePriceSetDTO {
/**
* @interface
*
* The data to upsert in a price set. The `id` is used in the case we are doing an update.
* The data to upsert in a price set.
*/
export interface UpsertPriceSetDTO extends UpdatePriceSetDTO {
/**
* A string indicating the ID of the price set to update.
* If not provided, a price set is created.
*/
id?: string
}
@@ -294,7 +296,7 @@ export interface UpsertPriceSetDTO extends UpdatePriceSetDTO {
/**
* @interface
*
* The data to update in a price set. The `id` is used to identify which price set to update.
* The data to update in a price set.
*/
export interface UpdatePriceSetDTO {
/**

File diff suppressed because it is too large Load Diff