chore(docs): Generated References (automated) (#10276)
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]
committed by
GitHub
GitHub
parent
67e2e718e9
commit
d5ee0070b4
@@ -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/api_key.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"/>
|
||||
|
||||
@@ -19,12 +19,12 @@ The main service interface for the Api Key Module.
|
||||
|
||||
## Methods
|
||||
|
||||
- [createApiKeys](../../IApiKeyModuleService/methods/api_key.IApiKeyModuleService.createApiKeys/page.mdx)
|
||||
- [upsertApiKeys](../../IApiKeyModuleService/methods/api_key.IApiKeyModuleService.upsertApiKeys/page.mdx)
|
||||
- [updateApiKeys](../../IApiKeyModuleService/methods/api_key.IApiKeyModuleService.updateApiKeys/page.mdx)
|
||||
- [deleteApiKeys](../../IApiKeyModuleService/methods/api_key.IApiKeyModuleService.deleteApiKeys/page.mdx)
|
||||
- [retrieveApiKey](../../IApiKeyModuleService/methods/api_key.IApiKeyModuleService.retrieveApiKey/page.mdx)
|
||||
- [listApiKeys](../../IApiKeyModuleService/methods/api_key.IApiKeyModuleService.listApiKeys/page.mdx)
|
||||
- [listAndCountApiKeys](../../IApiKeyModuleService/methods/api_key.IApiKeyModuleService.listAndCountApiKeys/page.mdx)
|
||||
- [revoke](../../IApiKeyModuleService/methods/api_key.IApiKeyModuleService.revoke/page.mdx)
|
||||
- [authenticate](../../IApiKeyModuleService/methods/api_key.IApiKeyModuleService.authenticate/page.mdx)
|
||||
- [createApiKeys](../../IApiKeyModuleService/methods/api_key.IApiKeyModuleService.createApiKeys/page.mdx)
|
||||
- [deleteApiKeys](../../IApiKeyModuleService/methods/api_key.IApiKeyModuleService.deleteApiKeys/page.mdx)
|
||||
- [listAndCountApiKeys](../../IApiKeyModuleService/methods/api_key.IApiKeyModuleService.listAndCountApiKeys/page.mdx)
|
||||
- [listApiKeys](../../IApiKeyModuleService/methods/api_key.IApiKeyModuleService.listApiKeys/page.mdx)
|
||||
- [retrieveApiKey](../../IApiKeyModuleService/methods/api_key.IApiKeyModuleService.retrieveApiKey/page.mdx)
|
||||
- [revoke](../../IApiKeyModuleService/methods/api_key.IApiKeyModuleService.revoke/page.mdx)
|
||||
- [updateApiKeys](../../IApiKeyModuleService/methods/api_key.IApiKeyModuleService.updateApiKeys/page.mdx)
|
||||
- [upsertApiKeys](../../IApiKeyModuleService/methods/api_key.IApiKeyModuleService.upsertApiKeys/page.mdx)
|
||||
|
||||
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Methods
|
||||
|
||||
- [save](../../IMessageAggregator/methods/api_key.IMessageAggregator.save/page.mdx)
|
||||
- [getMessages](../../IMessageAggregator/methods/api_key.IMessageAggregator.getMessages/page.mdx)
|
||||
- [clearMessages](../../IMessageAggregator/methods/api_key.IMessageAggregator.clearMessages/page.mdx)
|
||||
- [getMessages](../../IMessageAggregator/methods/api_key.IMessageAggregator.getMessages/page.mdx)
|
||||
- [save](../../IMessageAggregator/methods/api_key.IMessageAggregator.save/page.mdx)
|
||||
- [saveRawMessageData](../../IMessageAggregator/methods/api_key.IMessageAggregator.saveRawMessageData/page.mdx)
|
||||
|
||||
@@ -6,12 +6,14 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# IModuleService
|
||||
|
||||
## Properties
|
||||
|
||||
- [\_\_hooks](page.mdx#__hooks)
|
||||
|
||||
## Methods
|
||||
|
||||
- [\_\_joinerConfig](../../IModuleService/methods/api_key.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<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationShutdown","type":"() => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationPrepareShutdown","type":"() => Promise<void>","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"/>
|
||||
|
||||
Reference in New Issue
Block a user