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

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`
- `notification`
- `order`
- `order_models`
- `payment`
- `pricing`
- `product`
- `promotion`
- `region`
- `sales_channel`
- `stock_location_next`
- `store`
- `tax`
- `tax_provider`
- `types`
- `user`
- `utils`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.addCustomerToGroup/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `addCustomerToGroup` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## addCustomerToGroup(groupCustomerPair, sharedContext?): Promise&#60;&#123; id: string  &#125;&#62;
 
 This method adds a customer to a group.

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.createCustomerAddresses/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `createCustomerAddresses` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## createCustomerAddresses(addresses, sharedContext?): Promise&#60;[CustomerAddressDTO](../../../interfaces/customer.CustomerAddressDTO/page.mdx)[]&#62;
 
 This method adds addresses to customers.

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.createCustomerGroups/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `createCustomerGroups` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## createCustomerGroups(data, sharedContext?): Promise&#60;[CustomerGroupDTO](../../../interfaces/customer.CustomerGroupDTO/page.mdx)[]&#62;
 
 This method creates customer groups.

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.createCustomers/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `createCustomers` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## createCustomers(data, sharedContext?): Promise&#60;[CustomerDTO](../../../interfaces/customer.CustomerDTO/page.mdx)[]&#62;
 
 This method creates customers.

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.deleteCustomerAddresses/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `deleteCustomerAddresses` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## deleteCustomerAddresses(addressId, sharedContext?): Promise&#60;void&#62;
 
 This method deletes an address by its ID.

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.deleteCustomerGroups/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `deleteCustomerGroups` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## deleteCustomerGroups(groupId, sharedContext?): Promise&#60;void&#62;
 
 This method deletes a customer group by its ID.

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.deleteCustomers/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `deleteCustomers` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## deleteCustomers(customerId, sharedContext?): Promise&#60;void&#62;
 
 This method deletes a customer by its ID.

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.listAndCountCustomerAddresses/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `listAndCountCustomerAddresses` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a paginated list of addresses along with the total count of available addresses satisfying the provided filters.
 
 ## Example

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.listAndCountCustomerGroups/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `listAndCountCustomerGroups` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a paginated list of customer groups along with the total count of available customer groups satisfying the provided filters.
 
 ## Example

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.listAndCountCustomers/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `listAndCountCustomers` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a paginated list of customers along with the total count of available customers satisfying the provided filters.
 
 ## Example

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.listCustomerAddresses/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `listCustomerAddresses` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a paginated list of addresses based on optional filters and configuration.
 
 ## Example

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.listCustomerGroupCustomers/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `listCustomerGroupCustomers` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a paginated list of relations between customer and groups based on optional filters and configuration.
 
 ## Example

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.listCustomerGroups/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `listCustomerGroups` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a paginated list of customer groups based on optional filters and configuration.
 
 ## Example

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.listCustomers/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `listCustomers` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a paginated list of customers based on optional filters and configuration.
 
 ## Example

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.removeCustomerFromGroup/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `removeCustomerFromGroup` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## removeCustomerFromGroup(groupCustomerPair, sharedContext?): Promise&#60;void&#62;
 
 This method removes a customer from a group.

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.restoreCustomerGroups/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `restoreCustomerGroups` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method restores a soft deleted customer group by its IDs.
 
 ## Example

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.restoreCustomers/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `restoreCustomers` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method restores soft deleted customer by their IDs.
 
 ## Example

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.retrieveCustomer/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `retrieveCustomer` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a customer by its ID.
 
 ## Example

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.retrieveCustomerGroup/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `retrieveCustomerGroup` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method retrieves a customer group by its ID.
 
 ## Example

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.softDeleteCustomerGroups/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `softDeleteCustomerGroups` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method soft deletes customer groups by their IDs.
 
 ## Example

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.softDeleteCustomers/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `softDeleteCustomers` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 This method soft deletes customers by their IDs.
 
 ## Example

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.updateCustomerAddresses/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `updateCustomerAddresses` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## updateCustomerAddresses(addressId, data, sharedContext?): Promise&#60;[CustomerAddressDTO](../../../interfaces/customer.CustomerAddressDTO/page.mdx)&#62;
 
 This method updates an address.

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.updateCustomerGroups/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `updateCustomerGroups` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## updateCustomerGroups(groupId, data, sharedContext?): Promise&#60;[CustomerGroupDTO](../../../interfaces/customer.CustomerGroupDTO/page.mdx)&#62;
 
 This method updates an existing customer group.

www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.updateCustomers/page.mdx

@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
 
 This documentation provides a reference to the `updateCustomers` method. This belongs to the Customer Module.
 
+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## updateCustomers(customerId, data, sharedContext?): Promise&#60;[CustomerDTO](../../../interfaces/customer.CustomerDTO/page.mdx)&#62;
 
 This method updates an existing customer.