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

78
www/apps/docs/content/references/js-client/classes/Admin.mdx
View File

@@ -15,7 +15,7 @@ are available in the JS Client under the `medusa.admin` property.
<ParameterTypes parameters={[
{
"name": "auth",
"type": "[`AdminAuthResource`](AdminAuthResource.mdx)",
"type": "[AdminAuthResource](AdminAuthResource.mdx)",
"description": "An instance of [AdminAuthResource](AdminAuthResource.mdx) used to send requests to [Admin Auth API Routes](https://docs.medusajs.com/api/admin#auth).",
"optional": false,
"defaultValue": "",
@@ -24,7 +24,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "batchJobs",
"type": "[`AdminBatchJobsResource`](AdminBatchJobsResource.mdx)",
"type": "[AdminBatchJobsResource](AdminBatchJobsResource.mdx)",
"description": "An instance of [AdminBatchJobsResource](AdminBatchJobsResource.mdx) used to send requests to [Admin Batch Job API Routes](https://docs.medusajs.com/api/admin#batch-jobs).",
"optional": false,
"defaultValue": "",
@@ -33,7 +33,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "collections",
"type": "[`AdminCollectionsResource`](AdminCollectionsResource.mdx)",
"type": "[AdminCollectionsResource](AdminCollectionsResource.mdx)",
"description": "An instance of [AdminCollectionsResource](AdminCollectionsResource.mdx) used to send requests to [Admin Product Collection API Routes](https://docs.medusajs.com/api/admin#product-collections).",
"optional": false,
"defaultValue": "",
@@ -42,8 +42,8 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "currencies",
"type": "[`AdminCurrenciesResource`](AdminCurrenciesResource.mdx)",
"description": "An instance of [AdminCurrenciesResource](AdminCurrenciesResource.mdx) used to send requests to [Admin Currency API Routes](https://docs.medusajs.com/api/admin#currencies_getcurrencies).",
"type": "[AdminCurrenciesResource](AdminCurrenciesResource.mdx)",
"description": "An instance of [AdminCurrenciesResource](AdminCurrenciesResource.mdx) used to send requests to [Admin Currency API Routes](https://docs.medusajs.com/api/admin#currencies\\_getcurrencies).",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -51,7 +51,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "custom",
"type": "[`AdminCustomResource`](AdminCustomResource.mdx)",
"type": "[AdminCustomResource](AdminCustomResource.mdx)",
"description": "An instance of [AdminCustomResource](AdminCustomResource.mdx) used to send requests to custom API Routes.",
"optional": false,
"defaultValue": "",
@@ -60,7 +60,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "customerGroups",
"type": "[`AdminCustomerGroupsResource`](AdminCustomerGroupsResource.mdx)",
"type": "[AdminCustomerGroupsResource](AdminCustomerGroupsResource.mdx)",
"description": "An instance of [AdminCustomerGroupsResource](AdminCustomerGroupsResource.mdx) used to send requests to [Admin Customer Group API Routes](https://docs.medusajs.com/api/admin#customer-groups).",
"optional": false,
"defaultValue": "",
@@ -69,7 +69,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "customers",
"type": "[`AdminCustomersResource`](AdminCustomersResource.mdx)",
"type": "[AdminCustomersResource](AdminCustomersResource.mdx)",
"description": "An instance of [AdminCustomersResource](AdminCustomersResource.mdx) used to send requests to [Admin Customer API Routes](https://docs.medusajs.com/api/admin#customers).",
"optional": false,
"defaultValue": "",
@@ -78,7 +78,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "discounts",
"type": "[`AdminDiscountsResource`](AdminDiscountsResource.mdx)",
"type": "[AdminDiscountsResource](AdminDiscountsResource.mdx)",
"description": "An instance of [AdminDiscountsResource](AdminDiscountsResource.mdx) used to send requests to [Admin Discount API Routes](https://docs.medusajs.com/api/admin#discounts).",
"optional": false,
"defaultValue": "",
@@ -87,7 +87,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "draftOrders",
"type": "[`AdminDraftOrdersResource`](AdminDraftOrdersResource.mdx)",
"type": "[AdminDraftOrdersResource](AdminDraftOrdersResource.mdx)",
"description": "An instance of [AdminDraftOrdersResource](AdminDraftOrdersResource.mdx) used to send requests to [Admin Draft Order API Routes](https://docs.medusajs.com/api/admin#draft-orders).",
"optional": false,
"defaultValue": "",
@@ -96,7 +96,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "giftCards",
"type": "[`AdminGiftCardsResource`](AdminGiftCardsResource.mdx)",
"type": "[AdminGiftCardsResource](AdminGiftCardsResource.mdx)",
"description": "An instance of [AdminGiftCardsResource](AdminGiftCardsResource.mdx) used to send requests to [Admin Gift Card API Routes](https://docs.medusajs.com/api/admin#gift-cards).",
"optional": false,
"defaultValue": "",
@@ -105,7 +105,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "inventoryItems",
"type": "[`AdminInventoryItemsResource`](AdminInventoryItemsResource.mdx)",
"type": "[AdminInventoryItemsResource](AdminInventoryItemsResource.mdx)",
"description": "An instance of [AdminInventoryItemsResource](AdminInventoryItemsResource.mdx) used to send requests to [Admin Inventory Item API Routes](https://docs.medusajs.com/api/admin#inventory-items).",
"optional": false,
"defaultValue": "",
@@ -114,7 +114,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "invites",
"type": "[`AdminInvitesResource`](AdminInvitesResource.mdx)",
"type": "[AdminInvitesResource](AdminInvitesResource.mdx)",
"description": "An instance of [AdminInvitesResource](AdminInvitesResource.mdx) used to send requests to [Admin Invite API Routes](https://docs.medusajs.com/api/admin#invites).",
"optional": false,
"defaultValue": "",
@@ -123,7 +123,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "notes",
"type": "[`AdminNotesResource`](AdminNotesResource.mdx)",
"type": "[AdminNotesResource](AdminNotesResource.mdx)",
"description": "An instance of [AdminNotesResource](AdminNotesResource.mdx) used to send requests to [Admin Note API Routes](https://docs.medusajs.com/api/admin#notes).",
"optional": false,
"defaultValue": "",
@@ -132,7 +132,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "notifications",
"type": "[`AdminNotificationsResource`](AdminNotificationsResource.mdx)",
"type": "[AdminNotificationsResource](AdminNotificationsResource.mdx)",
"description": "An instance of [AdminNotificationsResource](AdminNotificationsResource.mdx) used to send requests to [Admin Notification API Routes](https://docs.medusajs.com/api/admin#notifications).",
"optional": false,
"defaultValue": "",
@@ -141,7 +141,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "orderEdits",
"type": "[`AdminOrderEditsResource`](AdminOrderEditsResource.mdx)",
"type": "[AdminOrderEditsResource](AdminOrderEditsResource.mdx)",
"description": "An instance of [AdminOrderEditsResource](AdminOrderEditsResource.mdx) used to send requests to [Admin Order Edit API Routes](https://docs.medusajs.com/api/admin#order-edits).",
"optional": false,
"defaultValue": "",
@@ -150,7 +150,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "orders",
"type": "[`AdminOrdersResource`](AdminOrdersResource.mdx)",
"type": "[AdminOrdersResource](AdminOrdersResource.mdx)",
"description": "An instance of [AdminOrdersResource](AdminOrdersResource.mdx) used to send requests to [Admin Order API Routes](https://docs.medusajs.com/api/admin#orders).",
"optional": false,
"defaultValue": "",
@@ -159,7 +159,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "paymentCollections",
"type": "[`AdminPaymentCollectionsResource`](AdminPaymentCollectionsResource.mdx)",
"type": "[AdminPaymentCollectionsResource](AdminPaymentCollectionsResource.mdx)",
"description": "An instance of [AdminPaymentCollectionsResource](AdminPaymentCollectionsResource.mdx) used to send requests to [Admin Payment Collection API Routes](https://docs.medusajs.com/api/admin#payment-collections).",
"optional": false,
"defaultValue": "",
@@ -168,7 +168,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "payments",
"type": "[`AdminPaymentsResource`](AdminPaymentsResource.mdx)",
"type": "[AdminPaymentsResource](AdminPaymentsResource.mdx)",
"description": "An instance of [AdminPaymentsResource](AdminPaymentsResource.mdx) used to send requests to [Admin Payment API Routes](https://docs.medusajs.com/api/admin#payments).",
"optional": false,
"defaultValue": "",
@@ -177,7 +177,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "priceLists",
"type": "[`AdminPriceListResource`](AdminPriceListResource.mdx)",
"type": "[AdminPriceListResource](AdminPriceListResource.mdx)",
"description": "An instance of [AdminPriceListResource](AdminPriceListResource.mdx) used to send requests to [Admin Price List API Routes](https://docs.medusajs.com/api/admin#price-lists).",
"optional": false,
"defaultValue": "",
@@ -186,7 +186,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "productCategories",
"type": "[`AdminProductCategoriesResource`](AdminProductCategoriesResource.mdx)",
"type": "[AdminProductCategoriesResource](AdminProductCategoriesResource.mdx)",
"description": "An instance of [AdminProductCategoriesResource](AdminProductCategoriesResource.mdx) used to send requests to [Admin Product Category API Routes](https://docs.medusajs.com/api/admin#product-categories).",
"optional": false,
"defaultValue": "",
@@ -195,7 +195,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "productTags",
"type": "[`AdminProductTagsResource`](AdminProductTagsResource.mdx)",
"type": "[AdminProductTagsResource](AdminProductTagsResource.mdx)",
"description": "An instance of [AdminProductTagsResource](AdminProductTagsResource.mdx) used to send requests to [Admin Product Tag API Routes](https://docs.medusajs.com/api/admin#product-tags).",
"optional": false,
"defaultValue": "",
@@ -204,7 +204,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "productTypes",
"type": "[`AdminProductTypesResource`](AdminProductTypesResource.mdx)",
"type": "[AdminProductTypesResource](AdminProductTypesResource.mdx)",
"description": "An instance of [AdminProductTypesResource](AdminProductTypesResource.mdx) used to send requests to [Admin Product Type API Routes](https://docs.medusajs.com/api/admin#product-types).",
"optional": false,
"defaultValue": "",
@@ -213,7 +213,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "products",
"type": "[`AdminProductsResource`](AdminProductsResource.mdx)",
"type": "[AdminProductsResource](AdminProductsResource.mdx)",
"description": "An instance of [AdminProductsResource](AdminProductsResource.mdx) used to send requests to [Admin Product API Routes](https://docs.medusajs.com/api/admin#products).",
"optional": false,
"defaultValue": "",
@@ -222,7 +222,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "publishableApiKeys",
"type": "[`AdminPublishableApiKeyResource`](AdminPublishableApiKeyResource.mdx)",
"type": "[AdminPublishableApiKeyResource](AdminPublishableApiKeyResource.mdx)",
"description": "An instance of [AdminPublishableApiKeyResource](AdminPublishableApiKeyResource.mdx) used to send requests to [Admin Publishable API Key API Routes](https://docs.medusajs.com/api/admin#publishable-api-keys).",
"optional": false,
"defaultValue": "",
@@ -231,7 +231,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "regions",
"type": "[`AdminRegionsResource`](AdminRegionsResource.mdx)",
"type": "[AdminRegionsResource](AdminRegionsResource.mdx)",
"description": "An instance of [AdminRegionsResource](AdminRegionsResource.mdx) used to send requests to [Admin Region API Routes](https://docs.medusajs.com/api/admin#regions).",
"optional": false,
"defaultValue": "",
@@ -240,7 +240,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "reservations",
"type": "[`AdminReservationsResource`](AdminReservationsResource.mdx)",
"type": "[AdminReservationsResource](AdminReservationsResource.mdx)",
"description": "An instance of [AdminReservationsResource](AdminReservationsResource.mdx) used to send requests to [Admin Reservation API Routes](https://docs.medusajs.com/api/admin#reservations).",
"optional": false,
"defaultValue": "",
@@ -249,7 +249,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "returnReasons",
"type": "[`AdminReturnReasonsResource`](AdminReturnReasonsResource.mdx)",
"type": "[AdminReturnReasonsResource](AdminReturnReasonsResource.mdx)",
"description": "An instance of [AdminReturnReasonsResource](AdminReturnReasonsResource.mdx) used to send requests to [Admin Return Reason API Routes](https://docs.medusajs.com/api/admin#return-reasons).",
"optional": false,
"defaultValue": "",
@@ -258,7 +258,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "returns",
"type": "[`AdminReturnsResource`](AdminReturnsResource.mdx)",
"type": "[AdminReturnsResource](AdminReturnsResource.mdx)",
"description": "An instance of [AdminReturnsResource](AdminReturnsResource.mdx) used to send requests to [Admin Return API Routes](https://docs.medusajs.com/api/admin#returns).",
"optional": false,
"defaultValue": "",
@@ -267,7 +267,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "salesChannels",
"type": "[`AdminSalesChannelsResource`](AdminSalesChannelsResource.mdx)",
"type": "[AdminSalesChannelsResource](AdminSalesChannelsResource.mdx)",
"description": "An instance of [AdminSalesChannelsResource](AdminSalesChannelsResource.mdx) used to send requests to [Admin Sales Channel API Routes](https://docs.medusajs.com/api/admin#sales-channels).",
"optional": false,
"defaultValue": "",
@@ -276,7 +276,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "shippingOptions",
"type": "[`AdminShippingOptionsResource`](AdminShippingOptionsResource.mdx)",
"type": "[AdminShippingOptionsResource](AdminShippingOptionsResource.mdx)",
"description": "An instance of [AdminShippingOptionsResource](AdminShippingOptionsResource.mdx) used to send requests to [Admin Shipping Option API Routes](https://docs.medusajs.com/api/admin#shipping-options).",
"optional": false,
"defaultValue": "",
@@ -285,7 +285,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "shippingProfiles",
"type": "[`AdminShippingProfilesResource`](AdminShippingProfilesResource.mdx)",
"type": "[AdminShippingProfilesResource](AdminShippingProfilesResource.mdx)",
"description": "An instance of [AdminShippingProfilesResource](AdminShippingProfilesResource.mdx) used to send requests to [Admin Shipping Profile API Routes](https://docs.medusajs.com/api/admin#shipping-profiles).",
"optional": false,
"defaultValue": "",
@@ -294,7 +294,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "stockLocations",
"type": "[`AdminStockLocationsResource`](AdminStockLocationsResource.mdx)",
"type": "[AdminStockLocationsResource](AdminStockLocationsResource.mdx)",
"description": "An instance of [AdminStockLocationsResource](AdminStockLocationsResource.mdx) used to send requests to [Admin Stock Location API Routes](https://docs.medusajs.com/api/admin#stock-locations).",
"optional": false,
"defaultValue": "",
@@ -303,7 +303,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "store",
"type": "[`AdminStoresResource`](AdminStoresResource.mdx)",
"type": "[AdminStoresResource](AdminStoresResource.mdx)",
"description": "An instance of [AdminStoresResource](AdminStoresResource.mdx) used to send requests to [Admin Store API Routes](https://docs.medusajs.com/api/admin#store).",
"optional": false,
"defaultValue": "",
@@ -312,7 +312,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "swaps",
"type": "[`AdminSwapsResource`](AdminSwapsResource.mdx)",
"type": "[AdminSwapsResource](AdminSwapsResource.mdx)",
"description": "An instance of [AdminSwapsResource](AdminSwapsResource.mdx) used to send requests to [Admin Swap API Routes](https://docs.medusajs.com/api/admin#swaps).",
"optional": false,
"defaultValue": "",
@@ -321,7 +321,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "taxRates",
"type": "[`AdminTaxRatesResource`](AdminTaxRatesResource.mdx)",
"type": "[AdminTaxRatesResource](AdminTaxRatesResource.mdx)",
"description": "An instance of [AdminTaxRatesResource](AdminTaxRatesResource.mdx) used to send requests to [Admin Tax Rate API Routes](https://docs.medusajs.com/api/admin#tax-rates).",
"optional": false,
"defaultValue": "",
@@ -330,7 +330,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "uploads",
"type": "[`AdminUploadsResource`](AdminUploadsResource.mdx)",
"type": "[AdminUploadsResource](AdminUploadsResource.mdx)",
"description": "An instance of [AdminUploadsResource](AdminUploadsResource.mdx) used to send requests to [Admin Upload API Routes](https://docs.medusajs.com/api/admin#uploads).",
"optional": false,
"defaultValue": "",
@@ -339,7 +339,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "users",
"type": "[`AdminUsersResource`](AdminUsersResource.mdx)",
"type": "[AdminUsersResource](AdminUsersResource.mdx)",
"description": "An instance of [AdminUsersResource](AdminUsersResource.mdx) used to send requests to [Admin User API Routes](https://docs.medusajs.com/api/admin#users).",
"optional": false,
"defaultValue": "",
@@ -348,7 +348,7 @@ are available in the JS Client under the `medusa.admin` property.
},
{
"name": "variants",
"type": "[`AdminVariantsResource`](AdminVariantsResource.mdx)",
"type": "[AdminVariantsResource](AdminVariantsResource.mdx)",
"description": "",
"optional": false,
"defaultValue": "",