docs: generate medusa-react reference (#6004)

* add new plugin for better organization

* added handling in theme for mutations and query types

* added tsdoc to hooks

* added tsdocs to utility functions

* added tsdoc to providers

* generated reference

* general fixes for generated reference

* generated api reference specs + general fixes

* add missing import react

* split utilities into different directories

* added overview page

* added link to customer authentication section

* fix lint errors

* added changeset

* fix readme

* fixed build error

* added expand fields + other sections to overview

* updated what's new section

* general refactoring

* remove unnecessary query field

* fix links

* added ignoreApi option
This commit is contained in:
Shahed Nasser
2024-01-05 17:03:38 +02:00
committed by GitHub
parent 6fc6a9de6a
commit 7d650771d1
2811 changed files with 231856 additions and 455063 deletions

View File

@@ -14,59 +14,59 @@ This section of the documentation provides a reference to the `IPricingModuleSer
## Methods
- [addPriceListPrices](../../IPricingModuleService/methods/pricing.IPricingModuleService.addPriceListPrices.mdx)
- [addPrices](../../IPricingModuleService/methods/pricing.IPricingModuleService.addPrices.mdx)
- [addRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.addRules.mdx)
- [calculatePrices](../../IPricingModuleService/methods/pricing.IPricingModuleService.calculatePrices.mdx)
- [create](../../IPricingModuleService/methods/pricing.IPricingModuleService.create.mdx)
- [createCurrencies](../../IPricingModuleService/methods/pricing.IPricingModuleService.createCurrencies.mdx)
- [createMoneyAmounts](../../IPricingModuleService/methods/pricing.IPricingModuleService.createMoneyAmounts.mdx)
- [createPriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceListRules.mdx)
- [createPriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceLists.mdx)
- [createPriceRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceRules.mdx)
- [createPriceSetMoneyAmountRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceSetMoneyAmountRules.mdx)
- [createRuleTypes](../../IPricingModuleService/methods/pricing.IPricingModuleService.createRuleTypes.mdx)
- [delete](../../IPricingModuleService/methods/pricing.IPricingModuleService.delete.mdx)
- [deleteCurrencies](../../IPricingModuleService/methods/pricing.IPricingModuleService.deleteCurrencies.mdx)
- [deleteMoneyAmounts](../../IPricingModuleService/methods/pricing.IPricingModuleService.deleteMoneyAmounts.mdx)
- [deletePriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceListRules.mdx)
- [deletePriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceLists.mdx)
- [deletePriceRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceRules.mdx)
- [deletePriceSetMoneyAmountRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceSetMoneyAmountRules.mdx)
- [deleteRuleTypes](../../IPricingModuleService/methods/pricing.IPricingModuleService.deleteRuleTypes.mdx)
- [list](../../IPricingModuleService/methods/pricing.IPricingModuleService.list.mdx)
- [listAndCount](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCount.mdx)
- [listAndCountCurrencies](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountCurrencies.mdx)
- [listAndCountMoneyAmounts](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountMoneyAmounts.mdx)
- [listAndCountPriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceListRules.mdx)
- [listAndCountPriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceLists.mdx)
- [listAndCountPriceRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceRules.mdx)
- [listAndCountPriceSetMoneyAmountRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx)
- [listAndCountPriceSetMoneyAmounts](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSetMoneyAmounts.mdx)
- [listAndCountRuleTypes](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountRuleTypes.mdx)
- [listCurrencies](../../IPricingModuleService/methods/pricing.IPricingModuleService.listCurrencies.mdx)
- [listMoneyAmounts](../../IPricingModuleService/methods/pricing.IPricingModuleService.listMoneyAmounts.mdx)
- [listPriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceListRules.mdx)
- [listPriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceLists.mdx)
- [listPriceRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceRules.mdx)
- [listPriceSetMoneyAmountRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSetMoneyAmountRules.mdx)
- [listPriceSetMoneyAmounts](../../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSetMoneyAmounts.mdx)
- [listRuleTypes](../../IPricingModuleService/methods/pricing.IPricingModuleService.listRuleTypes.mdx)
- [removePriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.removePriceListRules.mdx)
- [removeRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.removeRules.mdx)
- [retrieve](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrieve.mdx)
- [retrieveCurrency](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrieveCurrency.mdx)
- [retrieveMoneyAmount](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrieveMoneyAmount.mdx)
- [retrievePriceList](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceList.mdx)
- [retrievePriceListRule](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceListRule.mdx)
- [retrievePriceRule](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceRule.mdx)
- [retrievePriceSetMoneyAmountRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx)
- [retrieveRuleType](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrieveRuleType.mdx)
- [setPriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.setPriceListRules.mdx)
- [updateCurrencies](../../IPricingModuleService/methods/pricing.IPricingModuleService.updateCurrencies.mdx)
- [updateMoneyAmounts](../../IPricingModuleService/methods/pricing.IPricingModuleService.updateMoneyAmounts.mdx)
- [updatePriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceListRules.mdx)
- [updatePriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceLists.mdx)
- [updatePriceRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceRules.mdx)
- [updatePriceSetMoneyAmountRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceSetMoneyAmountRules.mdx)
- [updateRuleTypes](../../IPricingModuleService/methods/pricing.IPricingModuleService.updateRuleTypes.mdx)
- [addPriceListPrices](../IPricingModuleService/methods/pricing.IPricingModuleService.addPriceListPrices.mdx)
- [addPrices](../IPricingModuleService/methods/pricing.IPricingModuleService.addPrices.mdx)
- [addRules](../IPricingModuleService/methods/pricing.IPricingModuleService.addRules.mdx)
- [calculatePrices](../IPricingModuleService/methods/pricing.IPricingModuleService.calculatePrices.mdx)
- [create](../IPricingModuleService/methods/pricing.IPricingModuleService.create.mdx)
- [createCurrencies](../IPricingModuleService/methods/pricing.IPricingModuleService.createCurrencies.mdx)
- [createMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.createMoneyAmounts.mdx)
- [createPriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceListRules.mdx)
- [createPriceLists](../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceLists.mdx)
- [createPriceRules](../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceRules.mdx)
- [createPriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceSetMoneyAmountRules.mdx)
- [createRuleTypes](../IPricingModuleService/methods/pricing.IPricingModuleService.createRuleTypes.mdx)
- [delete](../IPricingModuleService/methods/pricing.IPricingModuleService.delete.mdx)
- [deleteCurrencies](../IPricingModuleService/methods/pricing.IPricingModuleService.deleteCurrencies.mdx)
- [deleteMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.deleteMoneyAmounts.mdx)
- [deletePriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceListRules.mdx)
- [deletePriceLists](../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceLists.mdx)
- [deletePriceRules](../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceRules.mdx)
- [deletePriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceSetMoneyAmountRules.mdx)
- [deleteRuleTypes](../IPricingModuleService/methods/pricing.IPricingModuleService.deleteRuleTypes.mdx)
- [list](../IPricingModuleService/methods/pricing.IPricingModuleService.list.mdx)
- [listAndCount](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCount.mdx)
- [listAndCountCurrencies](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountCurrencies.mdx)
- [listAndCountMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountMoneyAmounts.mdx)
- [listAndCountPriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceListRules.mdx)
- [listAndCountPriceLists](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceLists.mdx)
- [listAndCountPriceRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceRules.mdx)
- [listAndCountPriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx)
- [listAndCountPriceSetMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSetMoneyAmounts.mdx)
- [listAndCountRuleTypes](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountRuleTypes.mdx)
- [listCurrencies](../IPricingModuleService/methods/pricing.IPricingModuleService.listCurrencies.mdx)
- [listMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.listMoneyAmounts.mdx)
- [listPriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceListRules.mdx)
- [listPriceLists](../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceLists.mdx)
- [listPriceRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceRules.mdx)
- [listPriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSetMoneyAmountRules.mdx)
- [listPriceSetMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSetMoneyAmounts.mdx)
- [listRuleTypes](../IPricingModuleService/methods/pricing.IPricingModuleService.listRuleTypes.mdx)
- [removePriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.removePriceListRules.mdx)
- [removeRules](../IPricingModuleService/methods/pricing.IPricingModuleService.removeRules.mdx)
- [retrieve](../IPricingModuleService/methods/pricing.IPricingModuleService.retrieve.mdx)
- [retrieveCurrency](../IPricingModuleService/methods/pricing.IPricingModuleService.retrieveCurrency.mdx)
- [retrieveMoneyAmount](../IPricingModuleService/methods/pricing.IPricingModuleService.retrieveMoneyAmount.mdx)
- [retrievePriceList](../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceList.mdx)
- [retrievePriceListRule](../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceListRule.mdx)
- [retrievePriceRule](../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceRule.mdx)
- [retrievePriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx)
- [retrieveRuleType](../IPricingModuleService/methods/pricing.IPricingModuleService.retrieveRuleType.mdx)
- [setPriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.setPriceListRules.mdx)
- [updateCurrencies](../IPricingModuleService/methods/pricing.IPricingModuleService.updateCurrencies.mdx)
- [updateMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.updateMoneyAmounts.mdx)
- [updatePriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceListRules.mdx)
- [updatePriceLists](../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceLists.mdx)
- [updatePriceRules](../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceRules.mdx)
- [updatePriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceSetMoneyAmountRules.mdx)
- [updateRuleTypes](../IPricingModuleService/methods/pricing.IPricingModuleService.updateRuleTypes.mdx)