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/cart/interfaces/cart.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/cart.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/cart/interfaces/cart.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/cart.IBigNumber.toJSON/page.mdx)
- [valueOf](../../IBigNumber/methods/cart.IBigNumber.valueOf/page.mdx)
<TypeList types={[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/cart.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/cart.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/cart/interfaces/cart.ICartModuleService/page.mdx
+40 -40
View File
@@ -19,53 +19,53 @@ The main service interface for the Cart Module.
## Methods
- [retrieveCart](../../ICartModuleService/methods/cart.ICartModuleService.retrieveCart/page.mdx)
- [listCarts](../../ICartModuleService/methods/cart.ICartModuleService.listCarts/page.mdx)
- [listAndCountCarts](../../ICartModuleService/methods/cart.ICartModuleService.listAndCountCarts/page.mdx)
- [createCarts](../../ICartModuleService/methods/cart.ICartModuleService.createCarts/page.mdx)
- [updateCarts](../../ICartModuleService/methods/cart.ICartModuleService.updateCarts/page.mdx)
- [deleteCarts](../../ICartModuleService/methods/cart.ICartModuleService.deleteCarts/page.mdx)
- [listAddresses](../../ICartModuleService/methods/cart.ICartModuleService.listAddresses/page.mdx)
- [createAddresses](../../ICartModuleService/methods/cart.ICartModuleService.createAddresses/page.mdx)
- [updateAddresses](../../ICartModuleService/methods/cart.ICartModuleService.updateAddresses/page.mdx)
- [deleteAddresses](../../ICartModuleService/methods/cart.ICartModuleService.deleteAddresses/page.mdx)
- [retrieveLineItem](../../ICartModuleService/methods/cart.ICartModuleService.retrieveLineItem/page.mdx)
- [listLineItems](../../ICartModuleService/methods/cart.ICartModuleService.listLineItems/page.mdx)
- [addLineItems](../../ICartModuleService/methods/cart.ICartModuleService.addLineItems/page.mdx)
- [updateLineItems](../../ICartModuleService/methods/cart.ICartModuleService.updateLineItems/page.mdx)
- [listShippingMethods](../../ICartModuleService/methods/cart.ICartModuleService.listShippingMethods/page.mdx)
- [addShippingMethods](../../ICartModuleService/methods/cart.ICartModuleService.addShippingMethods/page.mdx)
- [listLineItemAdjustments](../../ICartModuleService/methods/cart.ICartModuleService.listLineItemAdjustments/page.mdx)
- [addLineItemAdjustments](../../ICartModuleService/methods/cart.ICartModuleService.addLineItemAdjustments/page.mdx)
- [setLineItemAdjustments](../../ICartModuleService/methods/cart.ICartModuleService.setLineItemAdjustments/page.mdx)
- [listShippingMethodAdjustments](../../ICartModuleService/methods/cart.ICartModuleService.listShippingMethodAdjustments/page.mdx)
- [addShippingMethodAdjustments](../../ICartModuleService/methods/cart.ICartModuleService.addShippingMethodAdjustments/page.mdx)
- [setShippingMethodAdjustments](../../ICartModuleService/methods/cart.ICartModuleService.setShippingMethodAdjustments/page.mdx)
- [listLineItemTaxLines](../../ICartModuleService/methods/cart.ICartModuleService.listLineItemTaxLines/page.mdx)
- [addLineItems](../../ICartModuleService/methods/cart.ICartModuleService.addLineItems/page.mdx)
- [addLineItemTaxLines](../../ICartModuleService/methods/cart.ICartModuleService.addLineItemTaxLines/page.mdx)
- [setLineItemTaxLines](../../ICartModuleService/methods/cart.ICartModuleService.setLineItemTaxLines/page.mdx)
- [listShippingMethodTaxLines](../../ICartModuleService/methods/cart.ICartModuleService.listShippingMethodTaxLines/page.mdx)
- [addShippingMethodAdjustments](../../ICartModuleService/methods/cart.ICartModuleService.addShippingMethodAdjustments/page.mdx)
- [addShippingMethods](../../ICartModuleService/methods/cart.ICartModuleService.addShippingMethods/page.mdx)
- [addShippingMethodTaxLines](../../ICartModuleService/methods/cart.ICartModuleService.addShippingMethodTaxLines/page.mdx)
- [setShippingMethodTaxLines](../../ICartModuleService/methods/cart.ICartModuleService.setShippingMethodTaxLines/page.mdx)
- [deleteLineItems](../../ICartModuleService/methods/cart.ICartModuleService.deleteLineItems/page.mdx)
- [deleteShippingMethods](../../ICartModuleService/methods/cart.ICartModuleService.deleteShippingMethods/page.mdx)
- [createAddresses](../../ICartModuleService/methods/cart.ICartModuleService.createAddresses/page.mdx)
- [createCarts](../../ICartModuleService/methods/cart.ICartModuleService.createCarts/page.mdx)
- [deleteAddresses](../../ICartModuleService/methods/cart.ICartModuleService.deleteAddresses/page.mdx)
- [deleteCarts](../../ICartModuleService/methods/cart.ICartModuleService.deleteCarts/page.mdx)
- [deleteLineItemAdjustments](../../ICartModuleService/methods/cart.ICartModuleService.deleteLineItemAdjustments/page.mdx)
- [deleteShippingMethodAdjustments](../../ICartModuleService/methods/cart.ICartModuleService.deleteShippingMethodAdjustments/page.mdx)
- [deleteLineItems](../../ICartModuleService/methods/cart.ICartModuleService.deleteLineItems/page.mdx)
- [deleteLineItemTaxLines](../../ICartModuleService/methods/cart.ICartModuleService.deleteLineItemTaxLines/page.mdx)
- [deleteShippingMethodAdjustments](../../ICartModuleService/methods/cart.ICartModuleService.deleteShippingMethodAdjustments/page.mdx)
- [deleteShippingMethods](../../ICartModuleService/methods/cart.ICartModuleService.deleteShippingMethods/page.mdx)
- [deleteShippingMethodTaxLines](../../ICartModuleService/methods/cart.ICartModuleService.deleteShippingMethodTaxLines/page.mdx)
- [softDeleteCarts](../../ICartModuleService/methods/cart.ICartModuleService.softDeleteCarts/page.mdx)
- [restoreCarts](../../ICartModuleService/methods/cart.ICartModuleService.restoreCarts/page.mdx)
- [softDeleteAddresses](../../ICartModuleService/methods/cart.ICartModuleService.softDeleteAddresses/page.mdx)
- [listAddresses](../../ICartModuleService/methods/cart.ICartModuleService.listAddresses/page.mdx)
- [listAndCountCarts](../../ICartModuleService/methods/cart.ICartModuleService.listAndCountCarts/page.mdx)
- [listCarts](../../ICartModuleService/methods/cart.ICartModuleService.listCarts/page.mdx)
- [listLineItemAdjustments](../../ICartModuleService/methods/cart.ICartModuleService.listLineItemAdjustments/page.mdx)
- [listLineItems](../../ICartModuleService/methods/cart.ICartModuleService.listLineItems/page.mdx)
- [listLineItemTaxLines](../../ICartModuleService/methods/cart.ICartModuleService.listLineItemTaxLines/page.mdx)
- [listShippingMethodAdjustments](../../ICartModuleService/methods/cart.ICartModuleService.listShippingMethodAdjustments/page.mdx)
- [listShippingMethods](../../ICartModuleService/methods/cart.ICartModuleService.listShippingMethods/page.mdx)
- [listShippingMethodTaxLines](../../ICartModuleService/methods/cart.ICartModuleService.listShippingMethodTaxLines/page.mdx)
- [restoreAddresses](../../ICartModuleService/methods/cart.ICartModuleService.restoreAddresses/page.mdx)
- [softDeleteLineItems](../../ICartModuleService/methods/cart.ICartModuleService.softDeleteLineItems/page.mdx)
- [restoreLineItems](../../ICartModuleService/methods/cart.ICartModuleService.restoreLineItems/page.mdx)
- [softDeleteShippingMethods](../../ICartModuleService/methods/cart.ICartModuleService.softDeleteShippingMethods/page.mdx)
- [restoreShippingMethods](../../ICartModuleService/methods/cart.ICartModuleService.restoreShippingMethods/page.mdx)
- [softDeleteLineItemAdjustments](../../ICartModuleService/methods/cart.ICartModuleService.softDeleteLineItemAdjustments/page.mdx)
- [restoreCarts](../../ICartModuleService/methods/cart.ICartModuleService.restoreCarts/page.mdx)
- [restoreLineItemAdjustments](../../ICartModuleService/methods/cart.ICartModuleService.restoreLineItemAdjustments/page.mdx)
- [softDeleteShippingMethodAdjustments](../../ICartModuleService/methods/cart.ICartModuleService.softDeleteShippingMethodAdjustments/page.mdx)
- [restoreShippingMethodAdjustments](../../ICartModuleService/methods/cart.ICartModuleService.restoreShippingMethodAdjustments/page.mdx)
- [softDeleteLineItemTaxLines](../../ICartModuleService/methods/cart.ICartModuleService.softDeleteLineItemTaxLines/page.mdx)
- [restoreLineItems](../../ICartModuleService/methods/cart.ICartModuleService.restoreLineItems/page.mdx)
- [restoreLineItemTaxLines](../../ICartModuleService/methods/cart.ICartModuleService.restoreLineItemTaxLines/page.mdx)
- [softDeleteShippingMethodTaxLines](../../ICartModuleService/methods/cart.ICartModuleService.softDeleteShippingMethodTaxLines/page.mdx)
- [restoreShippingMethodAdjustments](../../ICartModuleService/methods/cart.ICartModuleService.restoreShippingMethodAdjustments/page.mdx)
- [restoreShippingMethods](../../ICartModuleService/methods/cart.ICartModuleService.restoreShippingMethods/page.mdx)
- [restoreShippingMethodTaxLines](../../ICartModuleService/methods/cart.ICartModuleService.restoreShippingMethodTaxLines/page.mdx)
- [retrieveCart](../../ICartModuleService/methods/cart.ICartModuleService.retrieveCart/page.mdx)
- [retrieveLineItem](../../ICartModuleService/methods/cart.ICartModuleService.retrieveLineItem/page.mdx)
- [setLineItemAdjustments](../../ICartModuleService/methods/cart.ICartModuleService.setLineItemAdjustments/page.mdx)
- [setLineItemTaxLines](../../ICartModuleService/methods/cart.ICartModuleService.setLineItemTaxLines/page.mdx)
- [setShippingMethodAdjustments](../../ICartModuleService/methods/cart.ICartModuleService.setShippingMethodAdjustments/page.mdx)
- [setShippingMethodTaxLines](../../ICartModuleService/methods/cart.ICartModuleService.setShippingMethodTaxLines/page.mdx)
- [softDeleteAddresses](../../ICartModuleService/methods/cart.ICartModuleService.softDeleteAddresses/page.mdx)
- [softDeleteCarts](../../ICartModuleService/methods/cart.ICartModuleService.softDeleteCarts/page.mdx)
- [softDeleteLineItemAdjustments](../../ICartModuleService/methods/cart.ICartModuleService.softDeleteLineItemAdjustments/page.mdx)
- [softDeleteLineItems](../../ICartModuleService/methods/cart.ICartModuleService.softDeleteLineItems/page.mdx)
- [softDeleteLineItemTaxLines](../../ICartModuleService/methods/cart.ICartModuleService.softDeleteLineItemTaxLines/page.mdx)
- [softDeleteShippingMethodAdjustments](../../ICartModuleService/methods/cart.ICartModuleService.softDeleteShippingMethodAdjustments/page.mdx)
- [softDeleteShippingMethods](../../ICartModuleService/methods/cart.ICartModuleService.softDeleteShippingMethods/page.mdx)
- [softDeleteShippingMethodTaxLines](../../ICartModuleService/methods/cart.ICartModuleService.softDeleteShippingMethodTaxLines/page.mdx)
- [updateAddresses](../../ICartModuleService/methods/cart.ICartModuleService.updateAddresses/page.mdx)
- [updateCarts](../../ICartModuleService/methods/cart.ICartModuleService.updateCarts/page.mdx)
- [updateLineItems](../../ICartModuleService/methods/cart.ICartModuleService.updateLineItems/page.mdx)
www/apps/resources/references/cart/interfaces/cart.IMessageAggregator/page.mdx
+2 -2
View File
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
## Methods
- [save](../../IMessageAggregator/methods/cart.IMessageAggregator.save/page.mdx)
- [getMessages](../../IMessageAggregator/methods/cart.IMessageAggregator.getMessages/page.mdx)
- [clearMessages](../../IMessageAggregator/methods/cart.IMessageAggregator.clearMessages/page.mdx)
- [getMessages](../../IMessageAggregator/methods/cart.IMessageAggregator.getMessages/page.mdx)
- [save](../../IMessageAggregator/methods/cart.IMessageAggregator.save/page.mdx)
- [saveRawMessageData](../../IMessageAggregator/methods/cart.IMessageAggregator.saveRawMessageData/page.mdx)
www/apps/resources/references/cart/interfaces/cart.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/cart.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"/>