docs: generated references after collapse types improvement (#11889)
This commit is contained in:
Shahed Nasser
+1
-1
File diff suppressed because one or more lines are too long
+1
-1
File diff suppressed because one or more lines are too long
+1
-1
File diff suppressed because one or more lines are too long
+1
-1
File diff suppressed because one or more lines are too long
+1
-1
File diff suppressed because one or more lines are too long
+1
-1
@@ -50,4 +50,4 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminOrderListResponse](../../../../../types/HttpTypes/types/types.HttpTypes.AdminOrderListResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The paginated list of orders.","expandable":false,"children":[{"name":"AdminOrderListResponse","type":"[AdminOrderListResponse](../../../../../types/HttpTypes/types/types.HttpTypes.AdminOrderListResponse/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":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminOrderListResponse](../../../../../types/HttpTypes/types/types.HttpTypes.AdminOrderListResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The paginated list of orders.","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":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/>
|
||||
|
||||
+1
-1
@@ -22,4 +22,4 @@ sdk.admin.order.listChanges("order_123")
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[PaginatedResponse](../../../../../types/HttpTypes/types/types.HttpTypes.PaginatedResponse/page.mdx)<[AdminOrderChangesResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChangesResponse/page.mdx)>>","optional":false,"defaultValue":"","description":"The list of order changes.","expandable":false,"children":[{"name":"PaginatedResponse","type":"[PaginatedResponse](../../../../../types/HttpTypes/types/types.HttpTypes.PaginatedResponse/page.mdx)<[AdminOrderChangesResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChangesResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminOrderChangesResponse","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listChanges"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[PaginatedResponse](../../../../../types/HttpTypes/types/types.HttpTypes.PaginatedResponse/page.mdx)<[AdminOrderChangesResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChangesResponse/page.mdx)>>","optional":false,"defaultValue":"","description":"The list of order changes.","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listChanges"/>
|
||||
|
||||
+1
-1
@@ -21,4 +21,4 @@ sdk.admin.order.listLineItems("order_123")
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminOrderLineItemsListResponse](../../../../../types/HttpTypes/types/types.HttpTypes.AdminOrderLineItemsListResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The list of line items.","expandable":false,"children":[{"name":"AdminOrderLineItemsListResponse","type":"[AdminOrderLineItemsListResponse](../../../../../types/HttpTypes/types/types.HttpTypes.AdminOrderLineItemsListResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_items","type":"[AdminOrderItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderItem/page.mdx)[]","description":"The list of order items.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The ID of the order that the item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The ID of the associated line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The order version that the item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"history","type":"`object`","description":"The item's history details.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx)","description":"The associated line item's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listLineItems"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminOrderLineItemsListResponse](../../../../../types/HttpTypes/types/types.HttpTypes.AdminOrderLineItemsListResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The list of line items.","expandable":false,"children":[{"name":"order_items","type":"[AdminOrderItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderItem/page.mdx)[]","description":"The list of order items.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The ID of the order that the item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The ID of the associated line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The order version that the item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"history","type":"`object`","description":"The item's history details.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx)","description":"The associated line item's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listLineItems"/>
|
||||
|
||||
+1
-1
File diff suppressed because one or more lines are too long
+1
-1
File diff suppressed because one or more lines are too long
+1
-1
File diff suppressed because one or more lines are too long
+1
-1
File diff suppressed because one or more lines are too long
+1
-1
File diff suppressed because one or more lines are too long
+2
-2
@@ -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<T>","optional":false,"defaultValue":"","description":"Promise<T>","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<T>","optional":false,"defaultValue":"","description":"Promise<T>","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<[FetchStreamResponse](../../../interfaces/js_sdk.admin.FetchStreamResponse/page.mdx)>","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<[ServerSentEventMessage](../../../interfaces/js_sdk.admin.ServerSentEventMessage/page.mdx), void, unknown>","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<[FetchStreamResponse](../../../interfaces/js_sdk.admin.FetchStreamResponse/page.mdx)>","optional":false,"defaultValue":"","description":"FetchStreamResponse","expandable":false,"children":[{"name":"stream","type":"`null` \\| AsyncGenerator<[ServerSentEventMessage](../../../interfaces/js_sdk.admin.ServerSentEventMessage/page.mdx), void, unknown>","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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user