docs: resdesign and restructure modules references (#5372)

* docs: change format of module reference

* description fix

* update structure + comments

* added new options to README

* small text fix

* change section ordering

* change how required/optional are shown

* remove optional text

* docs: redesigned accordion
This commit is contained in:
Shahed Nasser
2023-10-16 19:51:55 +03:00
committed by GitHub
parent 3dada88c81
commit 2d74ec256f
218 changed files with 5433 additions and 7683 deletions
@@ -2,55 +2,57 @@
displayed_sidebar: pricingReference
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# Pricing Module Reference Reference
## Interfaces
- [AddPricesDTO](interfaces/AddPricesDTO.md)
- [AddRulesDTO](interfaces/AddRulesDTO.md)
- [BaseFilterable](interfaces/BaseFilterable.md)
- [CalculatedPriceSetDTO](interfaces/CalculatedPriceSetDTO.md)
- [Context](interfaces/Context.md)
- [CreateCurrencyDTO](interfaces/CreateCurrencyDTO.md)
- [CreateMoneyAmountDTO](interfaces/CreateMoneyAmountDTO.md)
- [CreatePriceRuleDTO](interfaces/CreatePriceRuleDTO.md)
- [CreatePriceSetDTO](interfaces/CreatePriceSetDTO.md)
- [CreatePriceSetMoneyAmountRulesDTO](interfaces/CreatePriceSetMoneyAmountRulesDTO.md)
- [CreatePricesDTO](interfaces/CreatePricesDTO.md)
- [CreateRuleTypeDTO](interfaces/CreateRuleTypeDTO.md)
- [CurrencyDTO](interfaces/CurrencyDTO.md)
- [FilterableCurrencyProps](interfaces/FilterableCurrencyProps.md)
- [FilterableMoneyAmountProps](interfaces/FilterableMoneyAmountProps.md)
- [FilterablePriceRuleProps](interfaces/FilterablePriceRuleProps.md)
- [FilterablePriceSetMoneyAmountRulesProps](interfaces/FilterablePriceSetMoneyAmountRulesProps.md)
- [FilterablePriceSetProps](interfaces/FilterablePriceSetProps.md)
- [FilterableRuleTypeProps](interfaces/FilterableRuleTypeProps.md)
- [FindConfig](interfaces/FindConfig.md)
- [IPricingModuleService](interfaces/IPricingModuleService.md)
- [JoinerServiceConfig](interfaces/JoinerServiceConfig.md)
- [JoinerServiceConfigAlias](interfaces/JoinerServiceConfigAlias.md)
- [MoneyAmountDTO](interfaces/MoneyAmountDTO.md)
- [PriceRuleDTO](interfaces/PriceRuleDTO.md)
- [PriceSetDTO](interfaces/PriceSetDTO.md)
- [PriceSetMoneyAmountDTO](interfaces/PriceSetMoneyAmountDTO.md)
- [PriceSetMoneyAmountRulesDTO](interfaces/PriceSetMoneyAmountRulesDTO.md)
- [PricingContext](interfaces/PricingContext.md)
- [PricingFilters](interfaces/PricingFilters.md)
- [RemovePriceSetRulesDTO](interfaces/RemovePriceSetRulesDTO.md)
- [RuleTypeDTO](interfaces/RuleTypeDTO.md)
- [UpdateCurrencyDTO](interfaces/UpdateCurrencyDTO.md)
- [UpdateMoneyAmountDTO](interfaces/UpdateMoneyAmountDTO.md)
- [UpdatePriceRuleDTO](interfaces/UpdatePriceRuleDTO.md)
- [UpdatePriceSetDTO](interfaces/UpdatePriceSetDTO.md)
- [UpdatePriceSetMoneyAmountRulesDTO](interfaces/UpdatePriceSetMoneyAmountRulesDTO.md)
- [UpdateRuleTypeDTO](interfaces/UpdateRuleTypeDTO.md)
- [AddPricesDTO](interfaces/AddPricesDTO.mdx)
- [AddRulesDTO](interfaces/AddRulesDTO.mdx)
- [BaseFilterable](interfaces/BaseFilterable.mdx)
- [CalculatedPriceSetDTO](interfaces/CalculatedPriceSetDTO.mdx)
- [Context](interfaces/Context.mdx)
- [CreateCurrencyDTO](interfaces/CreateCurrencyDTO.mdx)
- [CreateMoneyAmountDTO](interfaces/CreateMoneyAmountDTO.mdx)
- [CreatePriceRuleDTO](interfaces/CreatePriceRuleDTO.mdx)
- [CreatePriceSetDTO](interfaces/CreatePriceSetDTO.mdx)
- [CreatePriceSetMoneyAmountRulesDTO](interfaces/CreatePriceSetMoneyAmountRulesDTO.mdx)
- [CreatePricesDTO](interfaces/CreatePricesDTO.mdx)
- [CreateRuleTypeDTO](interfaces/CreateRuleTypeDTO.mdx)
- [CurrencyDTO](interfaces/CurrencyDTO.mdx)
- [FilterableCurrencyProps](interfaces/FilterableCurrencyProps.mdx)
- [FilterableMoneyAmountProps](interfaces/FilterableMoneyAmountProps.mdx)
- [FilterablePriceRuleProps](interfaces/FilterablePriceRuleProps.mdx)
- [FilterablePriceSetMoneyAmountRulesProps](interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx)
- [FilterablePriceSetProps](interfaces/FilterablePriceSetProps.mdx)
- [FilterableRuleTypeProps](interfaces/FilterableRuleTypeProps.mdx)
- [FindConfig](interfaces/FindConfig.mdx)
- [IPricingModuleService](interfaces/IPricingModuleService.mdx)
- [JoinerServiceConfig](interfaces/JoinerServiceConfig.mdx)
- [JoinerServiceConfigAlias](interfaces/JoinerServiceConfigAlias.mdx)
- [MoneyAmountDTO](interfaces/MoneyAmountDTO.mdx)
- [PriceRuleDTO](interfaces/PriceRuleDTO.mdx)
- [PriceSetDTO](interfaces/PriceSetDTO.mdx)
- [PriceSetMoneyAmountDTO](interfaces/PriceSetMoneyAmountDTO.mdx)
- [PriceSetMoneyAmountRulesDTO](interfaces/PriceSetMoneyAmountRulesDTO.mdx)
- [PricingContext](interfaces/PricingContext.mdx)
- [PricingFilters](interfaces/PricingFilters.mdx)
- [RemovePriceSetRulesDTO](interfaces/RemovePriceSetRulesDTO.mdx)
- [RuleTypeDTO](interfaces/RuleTypeDTO.mdx)
- [UpdateCurrencyDTO](interfaces/UpdateCurrencyDTO.mdx)
- [UpdateMoneyAmountDTO](interfaces/UpdateMoneyAmountDTO.mdx)
- [UpdatePriceRuleDTO](interfaces/UpdatePriceRuleDTO.mdx)
- [UpdatePriceSetDTO](interfaces/UpdatePriceSetDTO.mdx)
- [UpdatePriceSetMoneyAmountRulesDTO](interfaces/UpdatePriceSetMoneyAmountRulesDTO.mdx)
- [UpdateRuleTypeDTO](interfaces/UpdateRuleTypeDTO.mdx)
## Type Aliases
- [Exclude](types/Exclude.md)
- [JoinerRelationship](types/JoinerRelationship.md)
- [ModuleJoinerConfig](types/ModuleJoinerConfig.md)
- [ModuleJoinerRelationship](types/ModuleJoinerRelationship.md)
- [Omit](types/Omit.md)
- [Pick](types/Pick.md)
- [Record](types/Record.md)
- [Exclude](types/Exclude.mdx)
- [JoinerRelationship](types/JoinerRelationship.mdx)
- [ModuleJoinerConfig](types/ModuleJoinerConfig.mdx)
- [ModuleJoinerRelationship](types/ModuleJoinerRelationship.mdx)
- [Omit](types/Omit.mdx)
- [Pick](types/Pick.mdx)
- [Record](types/Record.mdx)