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

80
www/apps/docs/content/references/js-client/classes/AdminShippingProfilesResource.mdx
View File

@@ -43,7 +43,7 @@ medusa.admin.shippingProfiles
<ParameterTypes parameters={[
{
"name": "payload",
"type": "[`AdminPostShippingProfilesReq`](../internal/classes/internal.AdminPostShippingProfilesReq.mdx)",
"type": "[AdminPostShippingProfilesReq](../internal/classes/internal.AdminPostShippingProfilesReq.mdx)",
"description": "The shipping profile to create.",
"optional": false,
"defaultValue": "",
@@ -51,7 +51,7 @@ medusa.admin.shippingProfiles
"children": [
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional set of key-value pairs with additional information.",
"optional": true,
"defaultValue": "",
@@ -69,7 +69,7 @@ medusa.admin.shippingProfiles
},
{
"name": "type",
"type": "[`ShippingProfileType`](../internal/enums/internal.ShippingProfileType.mdx)",
"type": "[ShippingProfileType](../internal/enums/internal.ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile",
"optional": false,
"defaultValue": "",
@@ -108,7 +108,7 @@ medusa.admin.shippingProfiles
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -122,7 +122,7 @@ medusa.admin.shippingProfiles
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminShippingProfilesRes`](../internal/types/internal.AdminShippingProfilesRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminShippingProfilesRes](../internal/types/internal.AdminShippingProfilesRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the shipping profile's details.",
@@ -138,7 +138,7 @@ medusa.admin.shippingProfiles
"children": [
{
"name": "shipping_profile",
"type": "[`ShippingProfile`](../internal/classes/internal.ShippingProfile.mdx)",
"type": "[ShippingProfile](../internal/classes/internal.ShippingProfile.mdx)",
"description": "Shipping profile details.",
"optional": false,
"defaultValue": "",
@@ -173,7 +173,7 @@ medusa.admin.shippingProfiles
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -191,7 +191,7 @@ medusa.admin.shippingProfiles
},
{
"name": "products",
"type": "[`Product`](../internal/classes/internal.Product.mdx)[]",
"type": "[Product](../internal/classes/internal.Product.mdx)[]",
"description": "The details of the products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded.",
"optional": false,
"defaultValue": "",
@@ -200,7 +200,7 @@ medusa.admin.shippingProfiles
},
{
"name": "shipping_options",
"type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)[]",
"type": "[ShippingOption](../internal/classes/internal.ShippingOption.mdx)[]",
"description": "The details of the shipping options that can be used to create shipping methods for the Products in the Shipping Profile.",
"optional": false,
"defaultValue": "",
@@ -209,8 +209,8 @@ medusa.admin.shippingProfiles
},
{
"name": "type",
"type": "[`ShippingProfileType`](../internal/enums/internal.ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift_card` or `custom`.",
"type": "[ShippingProfileType](../internal/enums/internal.ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift\\_card` or `custom`.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -266,7 +266,7 @@ medusa.admin.shippingProfiles
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -280,7 +280,7 @@ medusa.admin.shippingProfiles
<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.",
@@ -339,7 +339,7 @@ medusa.admin.shippingProfiles.list().then(({ shipping_profiles }) => {
<ParameterTypes parameters={[
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -353,7 +353,7 @@ medusa.admin.shippingProfiles.list().then(({ shipping_profiles }) => {
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminShippingProfilesListRes`](../internal/types/internal.AdminShippingProfilesListRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminShippingProfilesListRes](../internal/types/internal.AdminShippingProfilesListRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the list of shipping profiles.",
@@ -369,7 +369,7 @@ medusa.admin.shippingProfiles.list().then(({ shipping_profiles }) => {
"children": [
{
"name": "shipping_profiles",
"type": "[`ShippingProfile`](../internal/classes/internal.ShippingProfile.mdx)[]",
"type": "[ShippingProfile](../internal/classes/internal.ShippingProfile.mdx)[]",
"description": "An array of shipping profiles details.",
"optional": false,
"defaultValue": "",
@@ -404,7 +404,7 @@ medusa.admin.shippingProfiles.list().then(({ shipping_profiles }) => {
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -422,7 +422,7 @@ medusa.admin.shippingProfiles.list().then(({ shipping_profiles }) => {
},
{
"name": "products",
"type": "[`Product`](../internal/classes/internal.Product.mdx)[]",
"type": "[Product](../internal/classes/internal.Product.mdx)[]",
"description": "The details of the products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded.",
"optional": false,
"defaultValue": "",
@@ -431,7 +431,7 @@ medusa.admin.shippingProfiles.list().then(({ shipping_profiles }) => {
},
{
"name": "shipping_options",
"type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)[]",
"type": "[ShippingOption](../internal/classes/internal.ShippingOption.mdx)[]",
"description": "The details of the shipping options that can be used to create shipping methods for the Products in the Shipping Profile.",
"optional": false,
"defaultValue": "",
@@ -440,8 +440,8 @@ medusa.admin.shippingProfiles.list().then(({ shipping_profiles }) => {
},
{
"name": "type",
"type": "[`ShippingProfileType`](../internal/enums/internal.ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift_card` or `custom`.",
"type": "[ShippingProfileType](../internal/enums/internal.ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift\\_card` or `custom`.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -497,7 +497,7 @@ medusa.admin.shippingProfiles
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -511,7 +511,7 @@ medusa.admin.shippingProfiles
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminShippingProfilesRes`](../internal/types/internal.AdminShippingProfilesRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminShippingProfilesRes](../internal/types/internal.AdminShippingProfilesRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the shipping profile's details.",
@@ -527,7 +527,7 @@ medusa.admin.shippingProfiles
"children": [
{
"name": "shipping_profile",
"type": "[`ShippingProfile`](../internal/classes/internal.ShippingProfile.mdx)",
"type": "[ShippingProfile](../internal/classes/internal.ShippingProfile.mdx)",
"description": "Shipping profile details.",
"optional": false,
"defaultValue": "",
@@ -562,7 +562,7 @@ medusa.admin.shippingProfiles
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -580,7 +580,7 @@ medusa.admin.shippingProfiles
},
{
"name": "products",
"type": "[`Product`](../internal/classes/internal.Product.mdx)[]",
"type": "[Product](../internal/classes/internal.Product.mdx)[]",
"description": "The details of the products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded.",
"optional": false,
"defaultValue": "",
@@ -589,7 +589,7 @@ medusa.admin.shippingProfiles
},
{
"name": "shipping_options",
"type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)[]",
"type": "[ShippingOption](../internal/classes/internal.ShippingOption.mdx)[]",
"description": "The details of the shipping options that can be used to create shipping methods for the Products in the Shipping Profile.",
"optional": false,
"defaultValue": "",
@@ -598,8 +598,8 @@ medusa.admin.shippingProfiles
},
{
"name": "type",
"type": "[`ShippingProfileType`](../internal/enums/internal.ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift_card` or `custom`.",
"type": "[ShippingProfileType](../internal/enums/internal.ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift\\_card` or `custom`.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -657,7 +657,7 @@ medusa.admin.shippingProfiles
},
{
"name": "payload",
"type": "[`AdminPostShippingProfilesProfileReq`](../internal/classes/internal.AdminPostShippingProfilesProfileReq.mdx)",
"type": "[AdminPostShippingProfilesProfileReq](../internal/classes/internal.AdminPostShippingProfilesProfileReq.mdx)",
"description": "The attributes to update in the shipping profile.",
"optional": false,
"defaultValue": "",
@@ -665,7 +665,7 @@ medusa.admin.shippingProfiles
"children": [
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional set of key-value pairs with additional information.",
"optional": true,
"defaultValue": "",
@@ -701,7 +701,7 @@ medusa.admin.shippingProfiles
},
{
"name": "type",
"type": "[`ShippingProfileType`](../internal/enums/internal.ShippingProfileType.mdx)",
"type": "[ShippingProfileType](../internal/enums/internal.ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile",
"optional": true,
"defaultValue": "",
@@ -740,7 +740,7 @@ medusa.admin.shippingProfiles
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -754,7 +754,7 @@ medusa.admin.shippingProfiles
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminShippingProfilesRes`](../internal/types/internal.AdminShippingProfilesRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminShippingProfilesRes](../internal/types/internal.AdminShippingProfilesRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the shipping profile's details.",
@@ -770,7 +770,7 @@ medusa.admin.shippingProfiles
"children": [
{
"name": "shipping_profile",
"type": "[`ShippingProfile`](../internal/classes/internal.ShippingProfile.mdx)",
"type": "[ShippingProfile](../internal/classes/internal.ShippingProfile.mdx)",
"description": "Shipping profile details.",
"optional": false,
"defaultValue": "",
@@ -805,7 +805,7 @@ medusa.admin.shippingProfiles
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -823,7 +823,7 @@ medusa.admin.shippingProfiles
},
{
"name": "products",
"type": "[`Product`](../internal/classes/internal.Product.mdx)[]",
"type": "[Product](../internal/classes/internal.Product.mdx)[]",
"description": "The details of the products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded.",
"optional": false,
"defaultValue": "",
@@ -832,7 +832,7 @@ medusa.admin.shippingProfiles
},
{
"name": "shipping_options",
"type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)[]",
"type": "[ShippingOption](../internal/classes/internal.ShippingOption.mdx)[]",
"description": "The details of the shipping options that can be used to create shipping methods for the Products in the Shipping Profile.",
"optional": false,
"defaultValue": "",
@@ -841,8 +841,8 @@ medusa.admin.shippingProfiles
},
{
"name": "type",
"type": "[`ShippingProfileType`](../internal/enums/internal.ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift_card` or `custom`.",
"type": "[ShippingProfileType](../internal/enums/internal.ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift\\_card` or `custom`.",
"optional": false,
"defaultValue": "",
"expandable": false,