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>
2024-10-24 09:41:14 +00:00
1 parent e196ad7659
commit 5deeae060a
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `createRegions` method. This belongs to the Region Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## createRegions(data, sharedContext?): Promise&#60;[RegionDTO](../../../interfaces/region.RegionDTO/page.mdx)[]&#62;

 This method creates regions.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `deleteRegions` method. This belongs to the Region Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## deleteRegions(ids, sharedContext?): Promise&#60;void&#62;

 This method deletes regions by their IDs.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listAndCountCountries` method. This belongs to the Region 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 countries along with the total count of available countries satisfying the provided filters.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listAndCountRegions` method. This belongs to the Region 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 regions along with the total count of available regions satisfying the provided filters.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listCountries` method. This belongs to the Region 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 countries based on optional filters and configuration.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listRegions` method. This belongs to the Region 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 regions based on optional filters and configuration.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `restoreRegions` method. This belongs to the Region 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 regions by their IDs.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `retrieveCountry` method. This belongs to the Region 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 country by its 2 character ISO code.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `retrieveRegion` method. This belongs to the Region 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 region by its ID.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `softDeleteRegions` method. This belongs to the Region 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 a region by its IDs.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `updateRegions` method. This belongs to the Region Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## updateRegions(id, data, sharedContext?): Promise&#60;[RegionDTO](../../../interfaces/region.RegionDTO/page.mdx)&#62;

 This method updates an existing region.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `upsertRegions` method. This belongs to the Region Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## upsertRegions(data, sharedContext?): Promise&#60;[RegionDTO](../../../interfaces/region.RegionDTO/page.mdx)[]&#62;

 This method updates or creates regions if they don't exist.