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

62
www/apps/docs/content/references/js-client/classes/AdminStockLocationsResource.mdx
View File

@@ -44,7 +44,7 @@ medusa.admin.stockLocations
<ParameterTypes parameters={[
{
"name": "payload",
"type": "[`AdminPostStockLocationsReq`](../internal/classes/internal.AdminPostStockLocationsReq.mdx)",
"type": "[AdminPostStockLocationsReq](../internal/classes/internal.AdminPostStockLocationsReq.mdx)",
"description": "The stock location to be created.",
"optional": false,
"defaultValue": "",
@@ -52,8 +52,8 @@ medusa.admin.stockLocations
"children": [
{
"name": "address",
"type": "[`StockLocationAddress`](../internal/classes/internal.StockLocationAddress.mdx)",
"description": "A new stock location address to create and associate with the stock location. Only required if `address_id` is not provided.",
"type": "[StockLocationAddress](../internal/classes/internal.StockLocationAddress.mdx)",
"description": "A new stock location address to create and associate with the stock location. Only required if `address\\_id` is not provided.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -143,7 +143,7 @@ medusa.admin.stockLocations
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": true,
"defaultValue": "",
@@ -163,7 +163,7 @@ medusa.admin.stockLocations
},
{
"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.stockLocations
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminStockLocationsRes`](../internal/types/internal.AdminStockLocationsRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminStockLocationsRes](../internal/types/internal.AdminStockLocationsRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the stock location's details.",
@@ -193,7 +193,7 @@ medusa.admin.stockLocations
"children": [
{
"name": "stock_location",
"type": "[`StockLocationExpandedDTO`](../internal/types/internal.StockLocationExpandedDTO.mdx)",
"type": "[StockLocationExpandedDTO](../internal/types/internal.StockLocationExpandedDTO.mdx)",
"description": "Stock location details.",
"optional": false,
"defaultValue": "",
@@ -201,7 +201,7 @@ medusa.admin.stockLocations
"children": [
{
"name": "address",
"type": "[`StockLocationAddressDTO`](../StockLocationTypes/types/internal.internal-1.StockLocationTypes.StockLocationAddressDTO.mdx)",
"type": "[StockLocationAddressDTO](../StockLocationTypes/types/internal.internal-1.StockLocationTypes.StockLocationAddressDTO.mdx)",
"description": "The Address of the Stock Location",
"optional": true,
"defaultValue": "",
@@ -246,7 +246,7 @@ medusa.admin.stockLocations
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\> \\| ``null``",
"type": "`Record<string, unknown>` \\| ``null``",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -321,7 +321,7 @@ medusa.admin.stockLocations
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -335,7 +335,7 @@ medusa.admin.stockLocations
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`DeleteResponse`](../internal/types/internal.DeleteResponse-1.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[DeleteResponse](../internal/types/internal.DeleteResponse-1.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the deletion operation's details.",
@@ -441,7 +441,7 @@ medusa.admin.stockLocations
<ParameterTypes parameters={[
{
"name": "query",
"type": "[`AdminGetStockLocationsParams`](../internal/classes/internal.AdminGetStockLocationsParams.mdx)",
"type": "[AdminGetStockLocationsParams](../internal/classes/internal.AdminGetStockLocationsParams.mdx)",
"description": "Filters and pagination configurations to apply on the retrieved stock locations.",
"optional": true,
"defaultValue": "",
@@ -523,7 +523,7 @@ medusa.admin.stockLocations
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -537,7 +537,7 @@ medusa.admin.stockLocations
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminStockLocationsListRes`](../internal/types/internal.AdminStockLocationsListRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminStockLocationsListRes](../internal/types/internal.AdminStockLocationsListRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the list of stock locations with pagination fields.",
@@ -545,7 +545,7 @@ medusa.admin.stockLocations
"children": [
{
"name": "AdminStockLocationsListRes",
"type": "[`PaginatedResponse`](../internal/types/internal.PaginatedResponse-1.mdx) & { `stock_locations`: [`StockLocationExpandedDTO`](../internal/types/internal.StockLocationExpandedDTO.mdx)[] }",
"type": "[PaginatedResponse](../internal/types/internal.PaginatedResponse-1.mdx) & `&#123; stock_locations: [StockLocationExpandedDTO](../internal/types/internal.StockLocationExpandedDTO.mdx)[] &#125;`",
"description": "The list of stock locations with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -580,7 +580,7 @@ medusa.admin.stockLocations
},
{
"name": "stock_locations",
"type": "[`StockLocationExpandedDTO`](../internal/types/internal.StockLocationExpandedDTO.mdx)[]",
"type": "[StockLocationExpandedDTO](../internal/types/internal.StockLocationExpandedDTO.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -588,7 +588,7 @@ medusa.admin.stockLocations
"children": [
{
"name": "address",
"type": "[`StockLocationAddressDTO`](../StockLocationTypes/types/internal.internal-1.StockLocationTypes.StockLocationAddressDTO.mdx)",
"type": "[StockLocationAddressDTO](../StockLocationTypes/types/internal.internal-1.StockLocationTypes.StockLocationAddressDTO.mdx)",
"description": "The Address of the Stock Location",
"optional": true,
"defaultValue": "",
@@ -633,7 +633,7 @@ medusa.admin.stockLocations
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\> \\| ``null``",
"type": "`Record<string, unknown>` \\| ``null``",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -708,7 +708,7 @@ medusa.admin.stockLocations
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -722,7 +722,7 @@ medusa.admin.stockLocations
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminStockLocationsRes`](../internal/types/internal.AdminStockLocationsRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminStockLocationsRes](../internal/types/internal.AdminStockLocationsRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the stock location's details.",
@@ -738,7 +738,7 @@ medusa.admin.stockLocations
"children": [
{
"name": "stock_location",
"type": "[`StockLocationExpandedDTO`](../internal/types/internal.StockLocationExpandedDTO.mdx)",
"type": "[StockLocationExpandedDTO](../internal/types/internal.StockLocationExpandedDTO.mdx)",
"description": "Stock location details.",
"optional": false,
"defaultValue": "",
@@ -746,7 +746,7 @@ medusa.admin.stockLocations
"children": [
{
"name": "address",
"type": "[`StockLocationAddressDTO`](../StockLocationTypes/types/internal.internal-1.StockLocationTypes.StockLocationAddressDTO.mdx)",
"type": "[StockLocationAddressDTO](../StockLocationTypes/types/internal.internal-1.StockLocationTypes.StockLocationAddressDTO.mdx)",
"description": "The Address of the Stock Location",
"optional": true,
"defaultValue": "",
@@ -791,7 +791,7 @@ medusa.admin.stockLocations
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\> \\| ``null``",
"type": "`Record<string, unknown>` \\| ``null``",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -868,7 +868,7 @@ medusa.admin.stockLocations
},
{
"name": "payload",
"type": "[`AdminPostStockLocationsLocationReq`](../internal/classes/internal.AdminPostStockLocationsLocationReq.mdx)",
"type": "[AdminPostStockLocationsLocationReq](../internal/classes/internal.AdminPostStockLocationsLocationReq.mdx)",
"description": "The attributes to be updated in the stock location.",
"optional": false,
"defaultValue": "",
@@ -876,7 +876,7 @@ medusa.admin.stockLocations
"children": [
{
"name": "address",
"type": "[`StockLocationAddress`](../internal/classes/internal.StockLocationAddress-1.mdx)",
"type": "[StockLocationAddress](../internal/classes/internal.StockLocationAddress-1.mdx)",
"description": "The data of an associated address to create or update.",
"optional": true,
"defaultValue": "",
@@ -967,7 +967,7 @@ medusa.admin.stockLocations
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": true,
"defaultValue": "",
@@ -987,7 +987,7 @@ medusa.admin.stockLocations
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -1001,7 +1001,7 @@ medusa.admin.stockLocations
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminStockLocationsRes`](../internal/types/internal.AdminStockLocationsRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminStockLocationsRes](../internal/types/internal.AdminStockLocationsRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the stock location's details.",
@@ -1017,7 +1017,7 @@ medusa.admin.stockLocations
"children": [
{
"name": "stock_location",
"type": "[`StockLocationExpandedDTO`](../internal/types/internal.StockLocationExpandedDTO.mdx)",
"type": "[StockLocationExpandedDTO](../internal/types/internal.StockLocationExpandedDTO.mdx)",
"description": "Stock location details.",
"optional": false,
"defaultValue": "",
@@ -1025,7 +1025,7 @@ medusa.admin.stockLocations
"children": [
{
"name": "address",
"type": "[`StockLocationAddressDTO`](../StockLocationTypes/types/internal.internal-1.StockLocationTypes.StockLocationAddressDTO.mdx)",
"type": "[StockLocationAddressDTO](../StockLocationTypes/types/internal.internal-1.StockLocationTypes.StockLocationAddressDTO.mdx)",
"description": "The Address of the Stock Location",
"optional": true,
"defaultValue": "",
@@ -1070,7 +1070,7 @@ medusa.admin.stockLocations
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\> \\| ``null``",
"type": "`Record<string, unknown>` \\| ``null``",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",