asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

chore(docs): Generated References (automated) (#10276)

Browse Source 
Generated the following references:
- `api_key`
- `auth`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `dml`
- `fulfillment`
- `helper_steps`
- `inventory_next`
- `js_sdk`
- `medusa`
- `medusa_config`
- `modules`
- `modules_sdk`
- `order`
- `payment`
- `payment_provider`
- `pricing`
- `product`
- `product_models`
- `promotion`
- `region`
- `sales_channel`
- `search`
- `stock_location_next`
- `store`
- `tax`
- `tax_provider`
- `types`
- `user`
- `utils`
- `workflows`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andShahed Nasser authored and GitHub committed 2024-11-26 09:24:41 +00:00
1 parent 67e2e718e9
commit d5ee0070b4
928 files changed
+182409 -172163
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/references/pricing/interfaces/pricing.FindConfig/page.mdx
+1 -1
View File
@@ -13,4 +13,4 @@ which provides correct typing of field names in its properties.
<TypeList types={[{"name":"Entity","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FindConfig"/>
<TypeList types={[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`Record<string, \"ASC\" \\| \"DESC\" \\| string & object>`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FindConfig"/>
<TypeList types={[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[FindConfigOrder](../../types/pricing.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FindConfig"/>
www/apps/resources/references/pricing/interfaces/pricing.IBigNumber/page.mdx
+9 -7
View File
@@ -6,15 +6,17 @@ import { TypeList } from "docs-ui"
# IBigNumber
## Properties
- [numeric](page.mdx#numeric)
- [raw](page.mdx#raw)
- [bigNumber](page.mdx#bignumber)
## Methods
- [toJSON](../../IBigNumber/methods/pricing.IBigNumber.toJSON/page.mdx)
- [valueOf](../../IBigNumber/methods/pricing.IBigNumber.valueOf/page.mdx)
<TypeList types={[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="IBigNumber"/>
## Properties
- [bigNumber](page.mdx#bignumber)
- [numeric](page.mdx#numeric)
- [raw](page.mdx#raw)
___
<TypeList types={[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="IBigNumber"/>
www/apps/resources/references/pricing/interfaces/pricing.IMessageAggregator/page.mdx
+2 -2
View File
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
## Methods
- [save](../../IMessageAggregator/methods/pricing.IMessageAggregator.save/page.mdx)
- [getMessages](../../IMessageAggregator/methods/pricing.IMessageAggregator.getMessages/page.mdx)
- [clearMessages](../../IMessageAggregator/methods/pricing.IMessageAggregator.clearMessages/page.mdx)
- [getMessages](../../IMessageAggregator/methods/pricing.IMessageAggregator.getMessages/page.mdx)
- [save](../../IMessageAggregator/methods/pricing.IMessageAggregator.save/page.mdx)
- [saveRawMessageData](../../IMessageAggregator/methods/pricing.IMessageAggregator.saveRawMessageData/page.mdx)
www/apps/resources/references/pricing/interfaces/pricing.IModuleService/page.mdx
+6 -4
View File
@@ -6,12 +6,14 @@ import { TypeList } from "docs-ui"
# IModuleService
## Properties
- [\_\_hooks](page.mdx#__hooks)
## Methods
- [\_\_joinerConfig](../../IModuleService/methods/pricing.IModuleService.__joinerConfig/page.mdx)
## Properties
- [\_\_hooks](page.mdx#__hooks)
___
<TypeList types={[{"name":"__hooks","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"onApplicationStart","type":"() => Promise&#60;void&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationShutdown","type":"() => Promise&#60;void&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationPrepareShutdown","type":"() => Promise&#60;void&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="IModuleService"/>
www/apps/resources/references/pricing/interfaces/pricing.IPricingModuleService/page.mdx
+40 -40
View File
@@ -19,47 +19,47 @@ The main service interface for the Pricing Module.
## Methods
- [calculatePrices](../../IPricingModuleService/methods/pricing.IPricingModuleService.calculatePrices/page.mdx)
- [retrievePriceSet](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceSet/page.mdx)
- [listPriceSets](../../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSets/page.mdx)
- [listAndCountPriceSets](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSets/page.mdx)
- [createPriceSets](../../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceSets/page.mdx)
- [upsertPriceSets](../../IPricingModuleService/methods/pricing.IPricingModuleService.upsertPriceSets/page.mdx)
- [updatePriceSets](../../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceSets/page.mdx)
- [deletePriceSets](../../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceSets/page.mdx)
- [addPrices](../../IPricingModuleService/methods/pricing.IPricingModuleService.addPrices/page.mdx)
- [listPrices](../../IPricingModuleService/methods/pricing.IPricingModuleService.listPrices/page.mdx)
- [softDeletePrices](../../IPricingModuleService/methods/pricing.IPricingModuleService.softDeletePrices/page.mdx)
- [restorePrices](../../IPricingModuleService/methods/pricing.IPricingModuleService.restorePrices/page.mdx)
- [listAndCountPrices](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPrices/page.mdx)
- [retrievePriceRule](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceRule/page.mdx)
- [listPriceRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceRules/page.mdx)
- [listAndCountPriceRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceRules/page.mdx)
- [createPriceRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceRules/page.mdx)
- [updatePriceRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceRules/page.mdx)
- [deletePriceRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceRules/page.mdx)
- [retrievePriceList](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceList/page.mdx)
- [listPriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceLists/page.mdx)
- [listAndCountPriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceLists/page.mdx)
- [createPriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceLists/page.mdx)
- [updatePriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceLists/page.mdx)
- [deletePriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceLists/page.mdx)
- [softDeletePriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.softDeletePriceLists/page.mdx)
- [restorePriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.restorePriceLists/page.mdx)
- [retrievePriceListRule](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceListRule/page.mdx)
- [listPriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceListRules/page.mdx)
- [listAndCountPriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceListRules/page.mdx)
- [deletePriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceListRules/page.mdx)
- [addPriceListPrices](../../IPricingModuleService/methods/pricing.IPricingModuleService.addPriceListPrices/page.mdx)
- [updatePriceListPrices](../../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceListPrices/page.mdx)
- [setPriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.setPriceListRules/page.mdx)
- [addPrices](../../IPricingModuleService/methods/pricing.IPricingModuleService.addPrices/page.mdx)
- [calculatePrices](../../IPricingModuleService/methods/pricing.IPricingModuleService.calculatePrices/page.mdx)
- [createPriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceLists/page.mdx)
- [createPricePreferences](../../IPricingModuleService/methods/pricing.IPricingModuleService.createPricePreferences/page.mdx)
- [createPriceRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceRules/page.mdx)
- [createPriceSets](../../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceSets/page.mdx)
- [deletePriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceListRules/page.mdx)
- [deletePriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceLists/page.mdx)
- [deletePricePreferences](../../IPricingModuleService/methods/pricing.IPricingModuleService.deletePricePreferences/page.mdx)
- [deletePriceRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceRules/page.mdx)
- [deletePriceSets](../../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceSets/page.mdx)
- [listAndCountPriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceListRules/page.mdx)
- [listAndCountPriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceLists/page.mdx)
- [listAndCountPriceRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceRules/page.mdx)
- [listAndCountPrices](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPrices/page.mdx)
- [listAndCountPriceSets](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSets/page.mdx)
- [listPriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceListRules/page.mdx)
- [listPriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceLists/page.mdx)
- [listPricePreferences](../../IPricingModuleService/methods/pricing.IPricingModuleService.listPricePreferences/page.mdx)
- [listPriceRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceRules/page.mdx)
- [listPrices](../../IPricingModuleService/methods/pricing.IPricingModuleService.listPrices/page.mdx)
- [listPriceSets](../../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSets/page.mdx)
- [removePriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.removePriceListRules/page.mdx)
- [removePrices](../../IPricingModuleService/methods/pricing.IPricingModuleService.removePrices/page.mdx)
- [retrievePricePreference](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePricePreference/page.mdx)
- [listPricePreferences](../../IPricingModuleService/methods/pricing.IPricingModuleService.listPricePreferences/page.mdx)
- [createPricePreferences](../../IPricingModuleService/methods/pricing.IPricingModuleService.createPricePreferences/page.mdx)
- [upsertPricePreferences](../../IPricingModuleService/methods/pricing.IPricingModuleService.upsertPricePreferences/page.mdx)
- [updatePricePreferences](../../IPricingModuleService/methods/pricing.IPricingModuleService.updatePricePreferences/page.mdx)
- [softDeletePricePreferences](../../IPricingModuleService/methods/pricing.IPricingModuleService.softDeletePricePreferences/page.mdx)
- [restorePriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.restorePriceLists/page.mdx)
- [restorePricePreferences](../../IPricingModuleService/methods/pricing.IPricingModuleService.restorePricePreferences/page.mdx)
- [deletePricePreferences](../../IPricingModuleService/methods/pricing.IPricingModuleService.deletePricePreferences/page.mdx)
- [restorePrices](../../IPricingModuleService/methods/pricing.IPricingModuleService.restorePrices/page.mdx)
- [retrievePriceList](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceList/page.mdx)
- [retrievePriceListRule](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceListRule/page.mdx)
- [retrievePricePreference](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePricePreference/page.mdx)
- [retrievePriceRule](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceRule/page.mdx)
- [retrievePriceSet](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceSet/page.mdx)
- [setPriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.setPriceListRules/page.mdx)
- [softDeletePriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.softDeletePriceLists/page.mdx)
- [softDeletePricePreferences](../../IPricingModuleService/methods/pricing.IPricingModuleService.softDeletePricePreferences/page.mdx)
- [softDeletePrices](../../IPricingModuleService/methods/pricing.IPricingModuleService.softDeletePrices/page.mdx)
- [updatePriceListPrices](../../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceListPrices/page.mdx)
- [updatePriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceLists/page.mdx)
- [updatePricePreferences](../../IPricingModuleService/methods/pricing.IPricingModuleService.updatePricePreferences/page.mdx)
- [updatePriceRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceRules/page.mdx)
- [updatePriceSets](../../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceSets/page.mdx)
- [upsertPricePreferences](../../IPricingModuleService/methods/pricing.IPricingModuleService.upsertPricePreferences/page.mdx)
- [upsertPriceSets](../../IPricingModuleService/methods/pricing.IPricingModuleService.upsertPriceSets/page.mdx)