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

docs: update docusaurus to v3 (#5625)

Browse Source 
* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
This commit is contained in:
Shahed Nasser
2023-11-13 20:11:50 +02:00
committed by GitHub
parent cedab58339
commit c6dff873de
2265 changed files with 46163 additions and 47195 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
www/apps/docs/content/references/js-client/classes/AdminNotificationsResource.mdx
View File

@@ -72,7 +72,7 @@ medusa.admin.notifications
<ParameterTypes parameters={[
{
"name": "query",
"type": "[`AdminGetNotificationsParams`](../internal/classes/internal.AdminGetNotificationsParams.mdx)",
"type": "[AdminGetNotificationsParams](../internal/classes/internal.AdminGetNotificationsParams.mdx)",
"description": "Filters and pagination configurations applied to the retrieved notifications.",
"optional": true,
"defaultValue": "",
@@ -163,7 +163,7 @@ medusa.admin.notifications
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -177,7 +177,7 @@ medusa.admin.notifications
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminNotificationsListRes`](../internal/types/internal.AdminNotificationsListRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminNotificationsListRes](../internal/types/internal.AdminNotificationsListRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the list of notifications with pagination fields.",
@@ -185,7 +185,7 @@ medusa.admin.notifications
"children": [
{
"name": "AdminNotificationsListRes",
"type": "[`PaginatedResponse`](../internal/types/internal.PaginatedResponse-1.mdx) & { `notifications`: [`Notification`](../internal/classes/internal.Notification.mdx)[] }",
"type": "[PaginatedResponse](../internal/types/internal.PaginatedResponse-1.mdx) & `&#123; notifications: [Notification](../internal/classes/internal.Notification.mdx)[] &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -220,7 +220,7 @@ medusa.admin.notifications
},
{
"name": "notifications",
"type": "[`Notification`](../internal/classes/internal.Notification.mdx)[]",
"type": "[Notification](../internal/classes/internal.Notification.mdx)[]",
"description": "an array of notifications",
"optional": false,
"defaultValue": "",
@@ -237,7 +237,7 @@ medusa.admin.notifications
},
{
"name": "customer",
"type": "[`Customer`](../internal/classes/internal.Customer.mdx)",
"type": "[Customer](../internal/classes/internal.Customer.mdx)",
"description": "The details of the customer that this notification was sent to.",
"optional": false,
"defaultValue": "",
@@ -255,7 +255,7 @@ medusa.admin.notifications
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.",
"optional": false,
"defaultValue": "",
@@ -291,7 +291,7 @@ medusa.admin.notifications
},
{
"name": "parent_notification",
"type": "[`Notification`](../internal/classes/internal.Notification.mdx)",
"type": "[Notification](../internal/classes/internal.Notification.mdx)",
"description": "The details of the parent notification.",
"optional": false,
"defaultValue": "",
@@ -300,7 +300,7 @@ medusa.admin.notifications
},
{
"name": "provider",
"type": "[`NotificationProvider`](../internal/classes/internal.NotificationProvider.mdx)",
"type": "[NotificationProvider](../internal/classes/internal.NotificationProvider.mdx)",
"description": "The notification provider used to send the notification.",
"optional": false,
"defaultValue": "",
@@ -318,7 +318,7 @@ medusa.admin.notifications
},
{
"name": "resends",
"type": "[`Notification`](../internal/classes/internal.Notification.mdx)[]",
"type": "[Notification](../internal/classes/internal.Notification.mdx)[]",
"description": "The details of all resends of the notification.",
"optional": false,
"defaultValue": "",
@@ -400,7 +400,7 @@ medusa.admin.notifications.resend(notificationId).then(({ notification }) => {
},
{
"name": "payload",
"type": "[`AdminPostNotificationsNotificationResendReq`](../internal/classes/internal.AdminPostNotificationsNotificationResendReq.mdx)",
"type": "[AdminPostNotificationsNotificationResendReq](../internal/classes/internal.AdminPostNotificationsNotificationResendReq.mdx)",
"description": "The details necessary to resend the notification.",
"optional": false,
"defaultValue": "",
@@ -419,7 +419,7 @@ medusa.admin.notifications.resend(notificationId).then(({ notification }) => {
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -433,7 +433,7 @@ medusa.admin.notifications.resend(notificationId).then(({ notification }) => {
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminNotificationsRes`](../internal/types/internal.AdminNotificationsRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminNotificationsRes](../internal/types/internal.AdminNotificationsRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the notification's details.",
@@ -449,7 +449,7 @@ medusa.admin.notifications.resend(notificationId).then(({ notification }) => {
"children": [
{
"name": "notification",
"type": "[`Notification`](../internal/classes/internal.Notification.mdx)",
"type": "[Notification](../internal/classes/internal.Notification.mdx)",
"description": "Notification details",
"optional": false,
"defaultValue": "",
@@ -466,7 +466,7 @@ medusa.admin.notifications.resend(notificationId).then(({ notification }) => {
},
{
"name": "customer",
"type": "[`Customer`](../internal/classes/internal.Customer.mdx)",
"type": "[Customer](../internal/classes/internal.Customer.mdx)",
"description": "The details of the customer that this notification was sent to.",
"optional": false,
"defaultValue": "",
@@ -484,7 +484,7 @@ medusa.admin.notifications.resend(notificationId).then(({ notification }) => {
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.",
"optional": false,
"defaultValue": "",
@@ -520,7 +520,7 @@ medusa.admin.notifications.resend(notificationId).then(({ notification }) => {
},
{
"name": "parent_notification",
"type": "[`Notification`](../internal/classes/internal.Notification.mdx)",
"type": "[Notification](../internal/classes/internal.Notification.mdx)",
"description": "The details of the parent notification.",
"optional": false,
"defaultValue": "",
@@ -529,7 +529,7 @@ medusa.admin.notifications.resend(notificationId).then(({ notification }) => {
},
{
"name": "provider",
"type": "[`NotificationProvider`](../internal/classes/internal.NotificationProvider.mdx)",
"type": "[NotificationProvider](../internal/classes/internal.NotificationProvider.mdx)",
"description": "The notification provider used to send the notification.",
"optional": false,
"defaultValue": "",
@@ -547,7 +547,7 @@ medusa.admin.notifications.resend(notificationId).then(({ notification }) => {
},
{
"name": "resends",
"type": "[`Notification`](../internal/classes/internal.Notification.mdx)[]",
"type": "[Notification](../internal/classes/internal.Notification.mdx)[]",
"description": "The details of all resends of the notification.",
"optional": false,
"defaultValue": "",