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

Generated the following references: - `api_key_models` - `auth_models` - `auth_provider` - `caching` - `cart_models` - `core_flows` - `currency_models` - `customer_models` - `fulfillment_models` - `inventory_next_models` - `js_sdk` - `order_models` - `payment_models` - `pricing_models` - `product_models` - `promotion_models` - `region_models` - `sales_channel_models` - `stock_location_next_models` - `store_models` - `tax_models` - `types` - `user_models` --- > [!NOTE] > Regenerates API reference pages across models, workflows/steps, and JS SDK, and updates generated Typedoc JSON and edit-dates script. > > - **Documentation**: > - **Models References**: Regenerated pages under `apps/resources/references/*_models/variables` for `api_key`, `auth`, `cart`, `currency`, `customer`, `fulfillment`, `inventory_next`, `order`, `payment`, `pricing`, `product`, `promotion`, `region`, `sales_channel`, `stock_location_next`, `store`, `tax`, `user`. > - **Core Flows**: Added/updated `Workflows_*` and `Steps_*` reference pages across modules including `Api_Key`, `Auth`, `Cart`, `Common`, `Customer`, `Customer_Group`, `Defaults`, `Draft_Order`, `File`, `Fulfillment`, `Inventory`, `Invite`, `Line_Item`, `Order`, `Payment`, `Payment_Collection`, `Price_List`, `Pricing`, `Product`, `Product_Category`, `Promotion`, `Region`, `Reservation`, `Return_Reason`, `Sales_Channel`, `Settings`, `Shipping_Options`, `Shipping_Profile`, `Stock_Location`, `Store`, `Tax`, `User`. > - **JS SDK**: Added `js_sdk.admin.Admin.order` property and `admin.Order.updateOrderChange` method references. > - **Types**: Added `types/CachingTypes.interfaces.ICachingModuleService` reference. > - **Generated Assets**: > - Updated `utils/generated/typedoc-json-output/0-medusa.json` and `0-types.json`. > - Updated `apps/resources/generated/edit-dates.mjs`. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 796f722aa33abd2033f488a33e0df81903b1b3f2. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2025-12-03 12:01:29 +00:00
1 parent b3bcfb7b49
commit 471ab72ecb
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the Country data model. It belongs to the Region Module.

-<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/region/src/models/country.ts#L4" />
+<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/region/src/models/country.ts#L4" />

 <TypeList types={[{"name":"iso_2","type":"PrimaryKeyModifier&#60;TextProperty&#62;","description":"The ISO 2-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"The ISO 3-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"The ISO numeric code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"The display name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"BelongsTo&#60;[Region](../region_models.Region/page.mdx)&#62;","description":"The region it belongs to.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3-character currency code of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"Whether taxes are calculated automatically during checkout in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany&#60;[Country](./page.mdx)&#62;","description":"The countries that belong to the region.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"iso_2","type":"PrimaryKeyModifier&#60;TextProperty&#62;","description":"The ISO 2-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"The ISO 3-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"The ISO numeric code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"The display name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"BelongsTo&#60;[Region](../region_models.Region/page.mdx)&#62;","description":"The region it belongs to.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Country"/>
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the Region data model. It belongs to the Region Module.

-<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/region/src/models/region.ts#L4" />
+<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/region/src/models/region.ts#L4" />

 <TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3-character currency code of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"Whether taxes are calculated automatically during checkout in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany&#60;[Country](../region_models.Country/page.mdx)&#62;","description":"The countries that belong to the region.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"iso_2","type":"PrimaryKeyModifier&#60;TextProperty&#62;","description":"The ISO 2-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"The ISO 3-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"The ISO numeric code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"The display name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"BelongsTo&#60;[Region](./page.mdx)&#62;","description":"The region it belongs to.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3-character currency code of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"Whether taxes are calculated automatically during checkout in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany&#60;[Country](../region_models.Country/page.mdx)&#62;","description":"The countries that belong to the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Region"/>