asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

docs: add additional data description in generated references (#10944)

Browse Source
This commit is contained in:
Shahed Nasser authored and GitHub committed 2025-01-13 20:47:37 +02:00
1 parent 1b86c17b72
commit 2a2b387bc3
917 files changed
+15807 -15158
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/references/js_sdk/admin/Notification/methods/js_sdk.admin.Notification.list/page.mdx
+1 -1
View File
@@ -47,7 +47,7 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
## Parameters
<TypeList types={[{"name":"query","type":"[AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx)","description":"Filters and pagination configurations.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"The maximum number of items to retrieve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort by and in which order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Query or keywords to search the notification's searchable fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"Filter by notification ID(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"channel","type":"`string` \\| `string`[]","description":"Filter by channel(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with anLine truncated
<TypeList types={[{"name":"query","type":"[AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx)","description":"Filters and pagination configurations.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"The maximum number of items to retrieve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort by and in which order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Query or keywords to search the notification's searchable fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"Filter by notification ID(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"channel","type":"`string` \\| `string`[]","description":"Filter by channel(s).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[AdminNotificationListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"chilLine truncated
## Returns