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

Generated the following references:
- `api_key_models`
- `auth_models`
- `cart_models`
- `core_flows`
- `currency_models`
- `customer_models`
- `fulfillment_models`
- `inventory_next_models`
- `js_sdk`
- `modules`
- `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`
- `utils`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andOli Juhl authored and GitHub committed 2025-05-15 08:36:24 +00:00
1 parent d3d138bad3
commit e81d2333bc
579 files changed
+143451 -141621

No files matched your search

@@ -50,4 +50,4 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminPricePreferenceListResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPricePreferenceListResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The paginated list of price preferences.","expandable":false,"children":[{"name":"limit","type":"`number`","description":"The maximum number of items retrieved.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"The total number of items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_preferences","type":"[AdminPricePreference](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPricePreference/page.mdx)[]","description":"The list of price preferences.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The price preference's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The attribute that the price preference refers to.\n\nCurrent supported values: `region_id` and `currency_code`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The attribute's value. For example, if the `attribute` is `region_id`,\nthe value is a region's ID. Prices in that region use this price\npreference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether prices matching this price preference have\ntaxes included in their amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date that the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date that the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date that the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"estimate_count","type":"`number`","description":"The estimated number of items.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminPricePreferenceListResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPricePreferenceListResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The paginated list of price preferences.","expandable":false,"children":[{"name":"limit","type":"`number`","description":"The maximum number of items retrieved.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"The total number of items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_preferences","type":"[AdminPricePreference](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPricePreference/page.mdx)[]","description":"The list of price preferences.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The price preference's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The attribute that the price preference refers to.\n\nCurrent supported values: `region_id` and `currency_code`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The attribute's value. For example, if the `attribute` is `region_id`,\nthe value is a region's ID. Prices in that region use this price\npreference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether prices matching this price preference have\ntaxes included in their amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date that the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date that the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date that the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"estimate_count","type":"`number`","description":"The estimated count retrieved from the PostgreSQL query planner, which may be inaccurate.","optional":true,"defaultValue":"","expandable":false,"featureFlag":"index_engine","children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/>