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

docs: generated references after collapse types improvement (#11889)

Browse Source
This commit is contained in:
Shahed Nasser
2025-03-18 16:48:43 +02:00
committed by GitHub
parent d0ca0f5ce0
commit ac24749bd3
774 changed files with 1612 additions and 1628 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/resources/references/js_sdk/admin/Notification/methods/js_sdk.admin.Notification.list/page.mdx
+1 -1
View File
@@ -51,4 +51,4 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminNotificationListResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The paginated list of notifications.","expandable":false,"children":[{"name":"AdminNotificationListResponse","type":"[AdminNotificationListResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListResponse/page.mdx)","optional":false,"defaultValue":"","description":"","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":"notifications","type":"[AdminNotification](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotification/page.mdx)[]","description":"The list of notifications.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The notification's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"to","type":"`string`","description":"The identifier the notification is sent to.\nFor example, an email, phone number, or username.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"channel","type":"`string`","description":"The channel to send the notification through.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"template","type":"`string`","description":"A template ID to use for the notification's content.\n\nFor example, the ID of a template in SendGrid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the notification provider used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the notification was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"Data to pass to the template.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"trigger_type","type":"`null` \\| `string`","description":"What triggered this notification.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`null` \\| `string`","description":"The ID of the associated resource. for example, if the notification was triggered \nbecause an order was created, this would be the ID of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`null` \\| `string`","description":"The type of the resource that triggered the notification.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"receiver_id","type":"`null` \\| `string`","description":"The ID of the user or customer that received the notification.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_notification_id","type":"`null` \\| `string`","description":"The ID of the original notification if this is a resend of it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the notification in an external or third-party system.","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;[AdminNotificationListResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The paginated list of notifications.","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":"notifications","type":"[AdminNotification](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotification/page.mdx)[]","description":"The list of notifications.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The notification's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"to","type":"`string`","description":"The identifier the notification is sent to.\nFor example, an email, phone number, or username.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"channel","type":"`string`","description":"The channel to send the notification through.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"template","type":"`string`","description":"A template ID to use for the notification's content.\n\nFor example, the ID of a template in SendGrid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the notification provider used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the notification was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"Data to pass to the template.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"trigger_type","type":"`null` \\| `string`","description":"What triggered this notification.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`null` \\| `string`","description":"The ID of the associated resource. for example, if the notification was triggered \nbecause an order was created, this would be the ID of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`null` \\| `string`","description":"The type of the resource that triggered the notification.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"receiver_id","type":"`null` \\| `string`","description":"The ID of the user or customer that received the notification.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_notification_id","type":"`null` \\| `string`","description":"The ID of the original notification if this is a resend of it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the notification in an external or third-party system.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/>
www/apps/resources/references/js_sdk/admin/Notification/methods/js_sdk.admin.Notification.retrieve/page.mdx
+1 -1
View File
@@ -36,4 +36,4 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminNotificationResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The notification's details.","expandable":false,"children":[{"name":"AdminNotificationResponse","type":"[AdminNotificationResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"notification","type":"[AdminNotification](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotification/page.mdx)","description":"The notification's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The notification's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"to","type":"`string`","description":"The identifier the notification is sent to.\nFor example, an email, phone number, or username.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"channel","type":"`string`","description":"The channel to send the notification through.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"template","type":"`string`","description":"A template ID to use for the notification's content.\n\nFor example, the ID of a template in SendGrid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the notification provider used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the notification was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"Data to pass to the template.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"trigger_type","type":"`null` \\| `string`","description":"What triggered this notification.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`null` \\| `string`","description":"The ID of the associated resource. for example, if the notification was triggered \nbecause an order was created, this would be the ID of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`null` \\| `string`","description":"The type of the resource that triggered the notification.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"receiver_id","type":"`null` \\| `string`","description":"The ID of the user or customer that received the notification.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_notification_id","type":"`null` \\| `string`","description":"The ID of the original notification if this is a resend of it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the notification in an external or third-party system.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminNotificationResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The notification's details.","expandable":false,"children":[{"name":"notification","type":"[AdminNotification](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminNotification/page.mdx)","description":"The notification's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The notification's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"to","type":"`string`","description":"The identifier the notification is sent to.\nFor example, an email, phone number, or username.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"channel","type":"`string`","description":"The channel to send the notification through.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"template","type":"`string`","description":"A template ID to use for the notification's content.\n\nFor example, the ID of a template in SendGrid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the notification provider used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the notification was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"Data to pass to the template.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"trigger_type","type":"`null` \\| `string`","description":"What triggered this notification.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`null` \\| `string`","description":"The ID of the associated resource. for example, if the notification was triggered \nbecause an order was created, this would be the ID of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`null` \\| `string`","description":"The type of the resource that triggered the notification.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"receiver_id","type":"`null` \\| `string`","description":"The ID of the user or customer that received the notification.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_notification_id","type":"`null` \\| `string`","description":"The ID of the original notification if this is a resend of it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the notification in an external or third-party system.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/>
www/apps/resources/references/js_sdk/admin/Notification/properties/js_sdk.admin.Notification.client/page.mdx
+2 -2
View File
@@ -141,7 +141,7 @@ Since the response is dynamically determined, we cannot know if it is JSON or no
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;T&#62;","optional":false,"defaultValue":"","description":"Promise&#60;T&#62;","expandable":false,"children":[{"name":"T","type":"T","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;T&#62;","optional":false,"defaultValue":"","description":"Promise&#60;T&#62;","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/>
`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function.
It follows a very similar interface to `fetch`, with the return value being an async generator.
@@ -154,7 +154,7 @@ The caller is responsible for handling `disconnect` events and aborting the stre
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[FetchStreamResponse](../../../interfaces/js_sdk.admin.FetchStreamResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"FetchStreamResponse","expandable":false,"children":[{"name":"FetchStreamResponse","type":"[FetchStreamResponse](../../../interfaces/js_sdk.admin.FetchStreamResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"stream","type":"`null` \\| AsyncGenerator&#60;[ServerSentEventMessage](../../../interfaces/js_sdk.admin.ServerSentEventMessage/page.mdx), void, unknown&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"comment","type":"`string`","description":"Ignored by the client.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"event","type":"`string`","description":"A string identifying the type of event described.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`string`","description":"The data field for the message. Split by new lines.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `number`","description":"The event ID to set the EventSource object's last event ID value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"retry","type":"`number`","description":"The reconnection time.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"abort","type":"() => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[FetchStreamResponse](../../../interfaces/js_sdk.admin.FetchStreamResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"FetchStreamResponse","expandable":false,"children":[{"name":"stream","type":"`null` \\| AsyncGenerator&#60;[ServerSentEventMessage](../../../interfaces/js_sdk.admin.ServerSentEventMessage/page.mdx), void, unknown&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"comment","type":"`string`","description":"Ignored by the client.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"event","type":"`string`","description":"A string identifying the type of event described.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`string`","description":"The data field for the message. Split by new lines.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `number`","description":"The event ID to set the EventSource object's last event ID value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"retry","type":"`number`","description":"The reconnection time.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"abort","type":"() => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/>
## Parameters