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

64
www/apps/docs/content/references/js-client/classes/AdminGiftCardsResource.mdx
View File

@@ -43,7 +43,7 @@ medusa.admin.giftCards
<ParameterTypes parameters={[
{
"name": "payload",
"type": "[`AdminPostGiftCardsReq`](../internal/classes/internal.AdminPostGiftCardsReq.mdx)",
"type": "[AdminPostGiftCardsReq](../internal/classes/internal.AdminPostGiftCardsReq.mdx)",
"description": "The gift card to be created.",
"optional": false,
"defaultValue": "",
@@ -69,7 +69,7 @@ medusa.admin.giftCards
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional set of key-value pairs to hold additional information.",
"optional": true,
"defaultValue": "",
@@ -98,7 +98,7 @@ medusa.admin.giftCards
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -112,7 +112,7 @@ medusa.admin.giftCards
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminGiftCardsRes`](../internal/types/internal.AdminGiftCardsRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminGiftCardsRes](../internal/types/internal.AdminGiftCardsRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the gift card's details.",
@@ -128,7 +128,7 @@ medusa.admin.giftCards
"children": [
{
"name": "gift_card",
"type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)",
"type": "[GiftCard](../internal/classes/internal.GiftCard-1.mdx)",
"description": "A gift card's details.",
"optional": false,
"defaultValue": "",
@@ -199,7 +199,7 @@ medusa.admin.giftCards
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -208,7 +208,7 @@ medusa.admin.giftCards
},
{
"name": "order",
"type": "[`Order`](../internal/classes/internal.Order.mdx)",
"type": "[Order](../internal/classes/internal.Order.mdx)",
"description": "The details of the order that the gift card was purchased in.",
"optional": false,
"defaultValue": "",
@@ -226,7 +226,7 @@ medusa.admin.giftCards
},
{
"name": "region",
"type": "[`Region`](../internal/classes/internal.Region.mdx)",
"type": "[Region](../internal/classes/internal.Region.mdx)",
"description": "The details of the region this gift card is available in.",
"optional": false,
"defaultValue": "",
@@ -308,7 +308,7 @@ medusa.admin.giftCards.delete(giftCardId).then(({ id, object, deleted }) => {
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -322,7 +322,7 @@ medusa.admin.giftCards.delete(giftCardId).then(({ id, object, deleted }) => {
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`DeleteResponse`](../internal/interfaces/internal.DeleteResponse.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[DeleteResponse](../internal/interfaces/internal.DeleteResponse.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the deletion operation's details.",
@@ -399,7 +399,7 @@ medusa.admin.giftCards
<ParameterTypes parameters={[
{
"name": "query",
"type": "[`AdminGetGiftCardsParams`](../internal/classes/internal.AdminGetGiftCardsParams.mdx)",
"type": "[AdminGetGiftCardsParams](../internal/classes/internal.AdminGetGiftCardsParams.mdx)",
"description": "Filters and pagination configurations to apply on the retrieved gift cards.",
"optional": true,
"defaultValue": "",
@@ -436,7 +436,7 @@ medusa.admin.giftCards
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -450,7 +450,7 @@ medusa.admin.giftCards
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminGiftCardsListRes`](../internal/types/internal.AdminGiftCardsListRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminGiftCardsListRes](../internal/types/internal.AdminGiftCardsListRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the list of gift cards with pagination fields.",
@@ -458,7 +458,7 @@ medusa.admin.giftCards
"children": [
{
"name": "AdminGiftCardsListRes",
"type": "[`PaginatedResponse`](../internal/interfaces/internal.PaginatedResponse.mdx) & { `gift_cards`: [`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[] }",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; gift_cards: [GiftCard](../internal/classes/internal.GiftCard-1.mdx)[] &#125;`",
"description": "The list of gift cards with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -493,7 +493,7 @@ medusa.admin.giftCards
},
{
"name": "gift_cards",
"type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]",
"type": "[GiftCard](../internal/classes/internal.GiftCard-1.mdx)[]",
"description": "The list of gift cards.",
"optional": false,
"defaultValue": "",
@@ -564,7 +564,7 @@ medusa.admin.giftCards
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -573,7 +573,7 @@ medusa.admin.giftCards
},
{
"name": "order",
"type": "[`Order`](../internal/classes/internal.Order.mdx)",
"type": "[Order](../internal/classes/internal.Order.mdx)",
"description": "The details of the order that the gift card was purchased in.",
"optional": false,
"defaultValue": "",
@@ -591,7 +591,7 @@ medusa.admin.giftCards
},
{
"name": "region",
"type": "[`Region`](../internal/classes/internal.Region.mdx)",
"type": "[Region](../internal/classes/internal.Region.mdx)",
"description": "The details of the region this gift card is available in.",
"optional": false,
"defaultValue": "",
@@ -673,7 +673,7 @@ medusa.admin.giftCards.retrieve(giftCardId).then(({ gift_card }) => {
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -687,7 +687,7 @@ medusa.admin.giftCards.retrieve(giftCardId).then(({ gift_card }) => {
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminGiftCardsRes`](../internal/types/internal.AdminGiftCardsRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminGiftCardsRes](../internal/types/internal.AdminGiftCardsRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the gift card's details.",
@@ -703,7 +703,7 @@ medusa.admin.giftCards.retrieve(giftCardId).then(({ gift_card }) => {
"children": [
{
"name": "gift_card",
"type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)",
"type": "[GiftCard](../internal/classes/internal.GiftCard-1.mdx)",
"description": "A gift card's details.",
"optional": false,
"defaultValue": "",
@@ -774,7 +774,7 @@ medusa.admin.giftCards.retrieve(giftCardId).then(({ gift_card }) => {
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -783,7 +783,7 @@ medusa.admin.giftCards.retrieve(giftCardId).then(({ gift_card }) => {
},
{
"name": "order",
"type": "[`Order`](../internal/classes/internal.Order.mdx)",
"type": "[Order](../internal/classes/internal.Order.mdx)",
"description": "The details of the order that the gift card was purchased in.",
"optional": false,
"defaultValue": "",
@@ -801,7 +801,7 @@ medusa.admin.giftCards.retrieve(giftCardId).then(({ gift_card }) => {
},
{
"name": "region",
"type": "[`Region`](../internal/classes/internal.Region.mdx)",
"type": "[Region](../internal/classes/internal.Region.mdx)",
"description": "The details of the region this gift card is available in.",
"optional": false,
"defaultValue": "",
@@ -887,7 +887,7 @@ medusa.admin.giftCards
},
{
"name": "payload",
"type": "[`AdminPostGiftCardsGiftCardReq`](../internal/classes/internal.AdminPostGiftCardsGiftCardReq.mdx)",
"type": "[AdminPostGiftCardsGiftCardReq](../internal/classes/internal.AdminPostGiftCardsGiftCardReq.mdx)",
"description": "The attributes to update in the gift card.",
"optional": false,
"defaultValue": "",
@@ -922,7 +922,7 @@ medusa.admin.giftCards
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional set of key-value pairs to hold additional information.",
"optional": true,
"defaultValue": "",
@@ -942,7 +942,7 @@ medusa.admin.giftCards
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -956,7 +956,7 @@ medusa.admin.giftCards
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminGiftCardsRes`](../internal/types/internal.AdminGiftCardsRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminGiftCardsRes](../internal/types/internal.AdminGiftCardsRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the gift card's details.",
@@ -972,7 +972,7 @@ medusa.admin.giftCards
"children": [
{
"name": "gift_card",
"type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)",
"type": "[GiftCard](../internal/classes/internal.GiftCard-1.mdx)",
"description": "A gift card's details.",
"optional": false,
"defaultValue": "",
@@ -1043,7 +1043,7 @@ medusa.admin.giftCards
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1052,7 +1052,7 @@ medusa.admin.giftCards
},
{
"name": "order",
"type": "[`Order`](../internal/classes/internal.Order.mdx)",
"type": "[Order](../internal/classes/internal.Order.mdx)",
"description": "The details of the order that the gift card was purchased in.",
"optional": false,
"defaultValue": "",
@@ -1070,7 +1070,7 @@ medusa.admin.giftCards
},
{
"name": "region",
"type": "[`Region`](../internal/classes/internal.Region.mdx)",
"type": "[Region](../internal/classes/internal.Region.mdx)",
"description": "The details of the region this gift card is available in.",
"optional": false,
"defaultValue": "",