chore(docs): Generated References (automated) (#13793)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andolivermrbl authored and 
GitHub committed
1 parent
0da4790081
commit
858b3e3b9b
1268 files changed
+213770
-194893
No files matched your search
+2
-2
@@ -4,7 +4,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
:::note
|
||||
|
||||
This is available starting from Medusa `v2.10.3`.
|
||||
This is available starting from [Medusa v2.10.3](https://github.com/medusajs/medusa/releases/tag/v2.10.3).
|
||||
|
||||
:::
|
||||
|
||||
@@ -14,4 +14,4 @@ This is available starting from Medusa `v2.10.3`.
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminViewsEntityColumnsResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminViewsEntityColumnsResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"featureFlag":"view_configurations","children":[{"name":"columns","type":"[AdminColumn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminColumn/page.mdx)[]","description":"The list of available columns for the entity.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The column's unique identifier (e.g., \"display\\_id\", \"customer.email\").","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The display name for the column.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"field","type":"`string`","description":"The field path to access the data.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sortable","type":"`boolean`","description":"Whether the column can be sorted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hideable","type":"`boolean`","description":"Whether the column can be hidden.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_visible","type":"`boolean`","description":"Whether the column is visible by default.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data_type","type":"`\"string\"` \\| `\"number\"` \\| `\"boolean\"` \\| `\"object\"` \\| `\"enum\"` \\| `\"currency\"` \\| `\"date\"`","description":"The data type of the column.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"Description of the column.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"semantic_type","type":"`string`","description":"The semantic type provides additional context about the data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`string`","description":"Additional context about the column.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"computed","type":"`object`","description":"Information about computed columns.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationship","type":"`object`","description":"Information about relationship columns.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_order","type":"`number`","description":"Default order for sorting columns.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"category","type":"`\"metadata\"` \\| `\"status\"` \\| `\"identifier\"` \\| `\"timestamp\"` \\| `\"metric\"` \\| `\"relationship\"`","description":"Category for grouping columns.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="columns"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminViewsEntityColumnsResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminViewsEntityColumnsResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"featureFlag":"view_configurations","children":[{"name":"columns","type":"[AdminColumn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminColumn/page.mdx)[]","description":"The list of available columns for the entity.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The column's unique identifier (e.g., \"display\\_id\", \"customer.email\").","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The display name for the column.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"field","type":"`string`","description":"The field path to access the data.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sortable","type":"`boolean`","description":"Whether the column can be sorted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hideable","type":"`boolean`","description":"Whether the column can be hidden.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_visible","type":"`boolean`","description":"Whether the column is visible by default.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data_type","type":"`\"string\"` \\| `\"number\"` \\| `\"boolean\"` \\| `\"object\"` \\| `\"enum\"` \\| `\"currency\"` \\| `\"date\"`","description":"The data type of the column.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"Description of the column.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"semantic_type","type":"`string`","description":"The semantic type provides additional context about the data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`string`","description":"Additional context about the column.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"computed","type":"`object`","description":"Information about computed columns.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationship","type":"`object`","description":"Information about relationship columns.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_order","type":"`number`","description":"Default order for sorting columns.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"category","type":"`\"metadata\"` \\| `\"status\"` \\| `\"identifier\"` \\| `\"timestamp\"` \\| `\"metric\"` \\| `\"relationship\"`","description":"Category for grouping columns.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}],"since":"2.10.3"}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="columns"/>
|
||||
+2
-2
@@ -4,7 +4,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
:::note
|
||||
|
||||
This is available starting from Medusa `v2.10.3`.
|
||||
This is available starting from [Medusa v2.10.3](https://github.com/medusajs/medusa/releases/tag/v2.10.3).
|
||||
|
||||
:::
|
||||
|
||||
@@ -14,4 +14,4 @@ This is available starting from Medusa `v2.10.3`.
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminViewConfigurationResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminViewConfigurationResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"featureFlag":"view_configurations","children":[{"name":"view_configuration","type":"`null` \\| [AdminViewConfiguration](../../../../../types/interfaces/types.AdminViewConfiguration/page.mdx)","description":"The view configuration's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The view configuration's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"The entity this configuration is for (e.g., \"order\", \"product\").","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`null` \\| `string`","description":"The name of the view configuration.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user_id","type":"`null` \\| `string`","description":"The ID of the user who owns this configuration, or null for system defaults.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_system_default","type":"`boolean`","description":"Whether this is a system default configuration.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"configuration","type":"`object`","description":"The view configuration settings.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the view configuration was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date the view configuration was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createConfiguration"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminViewConfigurationResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminViewConfigurationResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"featureFlag":"view_configurations","children":[{"name":"view_configuration","type":"`null` \\| [AdminViewConfiguration](../../../../../types/interfaces/types.AdminViewConfiguration/page.mdx)","description":"The view configuration's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The view configuration's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"The entity this configuration is for (e.g., \"order\", \"product\").","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`null` \\| `string`","description":"The name of the view configuration.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user_id","type":"`null` \\| `string`","description":"The ID of the user who owns this configuration, or null for system defaults.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_system_default","type":"`boolean`","description":"Whether this is a system default configuration.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"configuration","type":"`object`","description":"The view configuration settings.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the view configuration was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date the view configuration was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}],"since":"2.10.3"}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createConfiguration"/>
|
||||
+2
-2
@@ -4,7 +4,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
:::note
|
||||
|
||||
This is available starting from Medusa `v2.10.3`.
|
||||
This is available starting from [Medusa v2.10.3](https://github.com/medusajs/medusa/releases/tag/v2.10.3).
|
||||
|
||||
:::
|
||||
|
||||
@@ -14,4 +14,4 @@ This is available starting from Medusa `v2.10.3`.
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminViewConfigurationDeleteResponse](../../../../../types/HttpTypes/types/types.HttpTypes.AdminViewConfigurationDeleteResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"featureFlag":"view_configurations","children":[{"name":"id","type":"`string`","description":"The ID of the item that was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"TObject","description":"The type of the item that was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted","type":"`boolean`","description":"Whether the item was deleted successfully.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteConfiguration"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminViewConfigurationDeleteResponse](../../../../../types/HttpTypes/types/types.HttpTypes.AdminViewConfigurationDeleteResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"featureFlag":"view_configurations","children":[{"name":"id","type":"`string`","description":"The ID of the item that was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"TObject","description":"The type of the item that was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted","type":"`boolean`","description":"Whether the item was deleted successfully.","optional":false,"defaultValue":"","expandable":false,"children":[]}],"since":"2.10.3"}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteConfiguration"/>
|
||||
+2
-2
@@ -4,7 +4,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
:::note
|
||||
|
||||
This is available starting from Medusa `v2.10.3`.
|
||||
This is available starting from [Medusa v2.10.3](https://github.com/medusajs/medusa/releases/tag/v2.10.3).
|
||||
|
||||
:::
|
||||
|
||||
@@ -14,4 +14,4 @@ This is available starting from Medusa `v2.10.3`.
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminViewConfigurationListResponse](../../../../../types/HttpTypes/types/types.HttpTypes.AdminViewConfigurationListResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"featureFlag":"view_configurations","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":"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="listConfigurations"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminViewConfigurationListResponse](../../../../../types/HttpTypes/types/types.HttpTypes.AdminViewConfigurationListResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"featureFlag":"view_configurations","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":"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":[],"since":"2.8.0"}],"since":"2.10.3"}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listConfigurations"/>
|
||||
+2
-2
@@ -4,7 +4,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
:::note
|
||||
|
||||
This is available starting from Medusa `v2.10.3`.
|
||||
This is available starting from [Medusa v2.10.3](https://github.com/medusajs/medusa/releases/tag/v2.10.3).
|
||||
|
||||
:::
|
||||
|
||||
@@ -14,4 +14,4 @@ This is available starting from Medusa `v2.10.3`.
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminViewConfigurationResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminViewConfigurationResponse/page.mdx) & object>","optional":false,"defaultValue":"","description":"","expandable":false,"featureFlag":"view_configurations","children":[{"name":"AdminViewConfigurationResponse","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"active_view_configuration_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieveActiveConfiguration"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminViewConfigurationResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminViewConfigurationResponse/page.mdx) & object>","optional":false,"defaultValue":"","description":"","expandable":false,"featureFlag":"view_configurations","children":[{"name":"AdminViewConfigurationResponse","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"active_view_configuration_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}],"since":"2.10.3"}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieveActiveConfiguration"/>
|
||||
+2
-2
@@ -4,7 +4,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
:::note
|
||||
|
||||
This is available starting from Medusa `v2.10.3`.
|
||||
This is available starting from [Medusa v2.10.3](https://github.com/medusajs/medusa/releases/tag/v2.10.3).
|
||||
|
||||
:::
|
||||
|
||||
@@ -14,4 +14,4 @@ This is available starting from Medusa `v2.10.3`.
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminViewConfigurationResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminViewConfigurationResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"featureFlag":"view_configurations","children":[{"name":"view_configuration","type":"`null` \\| [AdminViewConfiguration](../../../../../types/interfaces/types.AdminViewConfiguration/page.mdx)","description":"The view configuration's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The view configuration's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"The entity this configuration is for (e.g., \"order\", \"product\").","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`null` \\| `string`","description":"The name of the view configuration.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user_id","type":"`null` \\| `string`","description":"The ID of the user who owns this configuration, or null for system defaults.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_system_default","type":"`boolean`","description":"Whether this is a system default configuration.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"configuration","type":"`object`","description":"The view configuration settings.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the view configuration was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date the view configuration was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieveConfiguration"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminViewConfigurationResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminViewConfigurationResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"featureFlag":"view_configurations","children":[{"name":"view_configuration","type":"`null` \\| [AdminViewConfiguration](../../../../../types/interfaces/types.AdminViewConfiguration/page.mdx)","description":"The view configuration's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The view configuration's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"The entity this configuration is for (e.g., \"order\", \"product\").","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`null` \\| `string`","description":"The name of the view configuration.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user_id","type":"`null` \\| `string`","description":"The ID of the user who owns this configuration, or null for system defaults.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_system_default","type":"`boolean`","description":"Whether this is a system default configuration.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"configuration","type":"`object`","description":"The view configuration settings.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the view configuration was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date the view configuration was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}],"since":"2.10.3"}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieveConfiguration"/>
|
||||
+2
-2
@@ -4,7 +4,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
:::note
|
||||
|
||||
This is available starting from Medusa `v2.10.3`.
|
||||
This is available starting from [Medusa v2.10.3](https://github.com/medusajs/medusa/releases/tag/v2.10.3).
|
||||
|
||||
:::
|
||||
|
||||
@@ -14,4 +14,4 @@ This is available starting from Medusa `v2.10.3`.
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<object>","optional":false,"defaultValue":"","description":"","expandable":false,"featureFlag":"view_configurations","children":[{"name":"success","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="setActiveConfiguration"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<object>","optional":false,"defaultValue":"","description":"","expandable":false,"featureFlag":"view_configurations","children":[{"name":"success","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}],"since":"2.10.3"}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="setActiveConfiguration"/>
|
||||
+2
-2
@@ -4,7 +4,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
:::note
|
||||
|
||||
This is available starting from Medusa `v2.10.3`.
|
||||
This is available starting from [Medusa v2.10.3](https://github.com/medusajs/medusa/releases/tag/v2.10.3).
|
||||
|
||||
:::
|
||||
|
||||
@@ -14,4 +14,4 @@ This is available starting from Medusa `v2.10.3`.
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminViewConfigurationResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminViewConfigurationResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"featureFlag":"view_configurations","children":[{"name":"view_configuration","type":"`null` \\| [AdminViewConfiguration](../../../../../types/interfaces/types.AdminViewConfiguration/page.mdx)","description":"The view configuration's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The view configuration's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"The entity this configuration is for (e.g., \"order\", \"product\").","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`null` \\| `string`","description":"The name of the view configuration.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user_id","type":"`null` \\| `string`","description":"The ID of the user who owns this configuration, or null for system defaults.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_system_default","type":"`boolean`","description":"Whether this is a system default configuration.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"configuration","type":"`object`","description":"The view configuration settings.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the view configuration was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date the view configuration was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateConfiguration"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminViewConfigurationResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminViewConfigurationResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"featureFlag":"view_configurations","children":[{"name":"view_configuration","type":"`null` \\| [AdminViewConfiguration](../../../../../types/interfaces/types.AdminViewConfiguration/page.mdx)","description":"The view configuration's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The view configuration's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"The entity this configuration is for (e.g., \"order\", \"product\").","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`null` \\| `string`","description":"The name of the view configuration.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user_id","type":"`null` \\| `string`","description":"The ID of the user who owns this configuration, or null for system defaults.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_system_default","type":"`boolean`","description":"Whether this is a system default configuration.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"configuration","type":"`object`","description":"The view configuration settings.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the view configuration was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date the view configuration was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}],"since":"2.10.3"}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateConfiguration"/>
|
||||
Reference in new issue
Block a user