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]andShahed Nasser authored and 
GitHub committed
1 parent
67e2e718e9
commit
d5ee0070b4
928 files changed
+182409
-172163
No files matched your search
@@ -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/customer.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"/>
|
||||
+18
-18
@@ -19,27 +19,27 @@ The main service interface for the Customer Module.
|
||||
|
||||
## Methods
|
||||
|
||||
- [retrieveCustomer](../../ICustomerModuleService/methods/customer.ICustomerModuleService.retrieveCustomer/page.mdx)
|
||||
- [createCustomers](../../ICustomerModuleService/methods/customer.ICustomerModuleService.createCustomers/page.mdx)
|
||||
- [updateCustomers](../../ICustomerModuleService/methods/customer.ICustomerModuleService.updateCustomers/page.mdx)
|
||||
- [deleteCustomers](../../ICustomerModuleService/methods/customer.ICustomerModuleService.deleteCustomers/page.mdx)
|
||||
- [createCustomerGroups](../../ICustomerModuleService/methods/customer.ICustomerModuleService.createCustomerGroups/page.mdx)
|
||||
- [retrieveCustomerGroup](../../ICustomerModuleService/methods/customer.ICustomerModuleService.retrieveCustomerGroup/page.mdx)
|
||||
- [updateCustomerGroups](../../ICustomerModuleService/methods/customer.ICustomerModuleService.updateCustomerGroups/page.mdx)
|
||||
- [deleteCustomerGroups](../../ICustomerModuleService/methods/customer.ICustomerModuleService.deleteCustomerGroups/page.mdx)
|
||||
- [addCustomerToGroup](../../ICustomerModuleService/methods/customer.ICustomerModuleService.addCustomerToGroup/page.mdx)
|
||||
- [removeCustomerFromGroup](../../ICustomerModuleService/methods/customer.ICustomerModuleService.removeCustomerFromGroup/page.mdx)
|
||||
- [createCustomerAddresses](../../ICustomerModuleService/methods/customer.ICustomerModuleService.createCustomerAddresses/page.mdx)
|
||||
- [updateCustomerAddresses](../../ICustomerModuleService/methods/customer.ICustomerModuleService.updateCustomerAddresses/page.mdx)
|
||||
- [createCustomerGroups](../../ICustomerModuleService/methods/customer.ICustomerModuleService.createCustomerGroups/page.mdx)
|
||||
- [createCustomers](../../ICustomerModuleService/methods/customer.ICustomerModuleService.createCustomers/page.mdx)
|
||||
- [deleteCustomerAddresses](../../ICustomerModuleService/methods/customer.ICustomerModuleService.deleteCustomerAddresses/page.mdx)
|
||||
- [listCustomerAddresses](../../ICustomerModuleService/methods/customer.ICustomerModuleService.listCustomerAddresses/page.mdx)
|
||||
- [deleteCustomerGroups](../../ICustomerModuleService/methods/customer.ICustomerModuleService.deleteCustomerGroups/page.mdx)
|
||||
- [deleteCustomers](../../ICustomerModuleService/methods/customer.ICustomerModuleService.deleteCustomers/page.mdx)
|
||||
- [listAndCountCustomerAddresses](../../ICustomerModuleService/methods/customer.ICustomerModuleService.listAndCountCustomerAddresses/page.mdx)
|
||||
- [listCustomerGroupCustomers](../../ICustomerModuleService/methods/customer.ICustomerModuleService.listCustomerGroupCustomers/page.mdx)
|
||||
- [listCustomers](../../ICustomerModuleService/methods/customer.ICustomerModuleService.listCustomers/page.mdx)
|
||||
- [listAndCountCustomers](../../ICustomerModuleService/methods/customer.ICustomerModuleService.listAndCountCustomers/page.mdx)
|
||||
- [listCustomerGroups](../../ICustomerModuleService/methods/customer.ICustomerModuleService.listCustomerGroups/page.mdx)
|
||||
- [listAndCountCustomerGroups](../../ICustomerModuleService/methods/customer.ICustomerModuleService.listAndCountCustomerGroups/page.mdx)
|
||||
- [softDeleteCustomers](../../ICustomerModuleService/methods/customer.ICustomerModuleService.softDeleteCustomers/page.mdx)
|
||||
- [restoreCustomers](../../ICustomerModuleService/methods/customer.ICustomerModuleService.restoreCustomers/page.mdx)
|
||||
- [softDeleteCustomerGroups](../../ICustomerModuleService/methods/customer.ICustomerModuleService.softDeleteCustomerGroups/page.mdx)
|
||||
- [listAndCountCustomers](../../ICustomerModuleService/methods/customer.ICustomerModuleService.listAndCountCustomers/page.mdx)
|
||||
- [listCustomerAddresses](../../ICustomerModuleService/methods/customer.ICustomerModuleService.listCustomerAddresses/page.mdx)
|
||||
- [listCustomerGroupCustomers](../../ICustomerModuleService/methods/customer.ICustomerModuleService.listCustomerGroupCustomers/page.mdx)
|
||||
- [listCustomerGroups](../../ICustomerModuleService/methods/customer.ICustomerModuleService.listCustomerGroups/page.mdx)
|
||||
- [listCustomers](../../ICustomerModuleService/methods/customer.ICustomerModuleService.listCustomers/page.mdx)
|
||||
- [removeCustomerFromGroup](../../ICustomerModuleService/methods/customer.ICustomerModuleService.removeCustomerFromGroup/page.mdx)
|
||||
- [restoreCustomerGroups](../../ICustomerModuleService/methods/customer.ICustomerModuleService.restoreCustomerGroups/page.mdx)
|
||||
- [restoreCustomers](../../ICustomerModuleService/methods/customer.ICustomerModuleService.restoreCustomers/page.mdx)
|
||||
- [retrieveCustomer](../../ICustomerModuleService/methods/customer.ICustomerModuleService.retrieveCustomer/page.mdx)
|
||||
- [retrieveCustomerGroup](../../ICustomerModuleService/methods/customer.ICustomerModuleService.retrieveCustomerGroup/page.mdx)
|
||||
- [softDeleteCustomerGroups](../../ICustomerModuleService/methods/customer.ICustomerModuleService.softDeleteCustomerGroups/page.mdx)
|
||||
- [softDeleteCustomers](../../ICustomerModuleService/methods/customer.ICustomerModuleService.softDeleteCustomers/page.mdx)
|
||||
- [updateCustomerAddresses](../../ICustomerModuleService/methods/customer.ICustomerModuleService.updateCustomerAddresses/page.mdx)
|
||||
- [updateCustomerGroups](../../ICustomerModuleService/methods/customer.ICustomerModuleService.updateCustomerGroups/page.mdx)
|
||||
- [updateCustomers](../../ICustomerModuleService/methods/customer.ICustomerModuleService.updateCustomers/page.mdx)
|
||||
+2
-2
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Methods
|
||||
|
||||
- [save](../../IMessageAggregator/methods/customer.IMessageAggregator.save/page.mdx)
|
||||
- [getMessages](../../IMessageAggregator/methods/customer.IMessageAggregator.getMessages/page.mdx)
|
||||
- [clearMessages](../../IMessageAggregator/methods/customer.IMessageAggregator.clearMessages/page.mdx)
|
||||
- [getMessages](../../IMessageAggregator/methods/customer.IMessageAggregator.getMessages/page.mdx)
|
||||
- [save](../../IMessageAggregator/methods/customer.IMessageAggregator.save/page.mdx)
|
||||
- [saveRawMessageData](../../IMessageAggregator/methods/customer.IMessageAggregator.saveRawMessageData/page.mdx)
|
||||
@@ -6,12 +6,14 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# IModuleService
|
||||
|
||||
## Properties
|
||||
|
||||
- [\_\_hooks](page.mdx#__hooks)
|
||||
|
||||
## Methods
|
||||
|
||||
- [\_\_joinerConfig](../../IModuleService/methods/customer.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