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

chore(docs): Generated References (#5743)

Browse Source 
Generated the following references:
- `entities`
- `inventory`
- `js-client`
- `pricing`
- `product`
- `services`
- `stock-location`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-27 18:58:52 +00:00
committed by GitHub
parent dc6b815b12
commit cdd42dbdcd
1383 changed files with 18978 additions and 20154 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.listInventoryItems.mdx
+3 -13
View File
@@ -165,17 +165,7 @@ async function retrieveInventoryItems (ids: string[], skip: number, take: number
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
},
{
"name": "relations",
@@ -197,7 +187,7 @@ async function retrieveInventoryItems (ids: string[], skip: number, take: number
},
{
"name": "skip",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
@@ -206,7 +196,7 @@ async function retrieveInventoryItems (ids: string[], skip: number, take: number
},
{
"name": "take",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.listInventoryLevels.mdx
+3 -13
View File
@@ -147,17 +147,7 @@ async function retrieveInventoryLevels (inventoryItemIds: string[], skip: number
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
},
{
"name": "relations",
@@ -179,7 +169,7 @@ async function retrieveInventoryLevels (inventoryItemIds: string[], skip: number
},
{
"name": "skip",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
@@ -188,7 +178,7 @@ async function retrieveInventoryLevels (inventoryItemIds: string[], skip: number
},
{
"name": "take",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.listReservationItems.mdx
+3 -13
View File
@@ -165,17 +165,7 @@ async function retrieveReservationItems (ids: string[], skip: number, take: numb
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
},
{
"name": "relations",
@@ -197,7 +187,7 @@ async function retrieveReservationItems (ids: string[], skip: number, take: numb
},
{
"name": "skip",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
@@ -206,7 +196,7 @@ async function retrieveReservationItems (ids: string[], skip: number, take: numb
},
{
"name": "take",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.retrieveInventoryItem.mdx
+3 -13
View File
@@ -75,17 +75,7 @@ async function retrieveInventoryItem (id: string) {
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
},
{
"name": "relations",
@@ -107,7 +97,7 @@ async function retrieveInventoryItem (id: string) {
},
{
"name": "skip",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
@@ -116,7 +106,7 @@ async function retrieveInventoryItem (id: string) {
},
{
"name": "take",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/inventory/interfaces/FindConfig.mdx
+4 -14
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# FindConfig
An object that is used to configure how an entity is retrieved from the database. It accepts as a typed parameter an `Entity` class,
An object that is used to configure how an entity is retrieved from the database. It accepts as a typed parameter an `Entity` class,
which provides correct typing of field names in its properties.
## Type parameters
@@ -33,17 +33,7 @@ which provides correct typing of field names in its properties.
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
},
{
"name": "relations",
@@ -65,7 +55,7 @@ which provides correct typing of field names in its properties.
},
{
"name": "skip",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
@@ -74,7 +64,7 @@ which provides correct typing of field names in its properties.
},
{
"name": "take",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/inventory/types/Exclude.mdx
+2 -2
View File
@@ -6,11 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Exclude
**Exclude**`<TypeParameter T, TypeParameter U>`: `T` extends `U` ? `never` : `T`
**Exclude**: `T` extends `U` ? `never` : `T`
Exclude from T those types that are assignable to U
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{
www/apps/docs/content/references/inventory/types/InventoryItemDTO.mdx
+1 -1
View File
@@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
**InventoryItemDTO**: `Object`
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{
www/apps/docs/content/references/inventory/types/InventoryLevelDTO.mdx
+1 -1
View File
@@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
**InventoryLevelDTO**: `Object`
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{
www/apps/docs/content/references/inventory/types/JoinerRelationship.mdx
+1 -1
View File
@@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
**JoinerRelationship**: `Object`
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{
www/apps/docs/content/references/inventory/types/Omit.mdx
+2 -2
View File
@@ -6,11 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Omit
**Omit**`<TypeParameter T, TypeParameter K>`: [Pick](Pick.mdx)&#60;T, [Exclude](Exclude.mdx)&#60;keyof T, K&#62;&#62;
**Omit**: [Pick](Pick.mdx)&#60;T, [Exclude](Exclude.mdx)&#60;keyof T, K&#62;&#62;
Construct a type with the properties of T except for those in type K.
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{
www/apps/docs/content/references/inventory/types/Partial.mdx
+2 -2
View File
@@ -6,11 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Partial
**Partial**`<TypeParameter T>`: &#123; [P in keyof T]?: T[P] &#125;
**Partial**: &#123; [P in keyof T]?: T[P] &#125;
Make all properties in T optional
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{
www/apps/docs/content/references/inventory/types/Pick.mdx
+2 -2
View File
@@ -6,11 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Pick
**Pick**`<TypeParameter T, TypeParameter K>`: &#123; [P in K]: T[P] &#125;
**Pick**: &#123; [P in K]: T[P] &#125;
From T, pick a set of properties whose keys are in the union K
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{
www/apps/docs/content/references/inventory/types/Record.mdx
+2 -2
View File
@@ -6,11 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Record
**Record**`<TypeParameter K, TypeParameter T>`: &#123; [P in K]: T &#125;
**Record**: &#123; [P in K]: T &#125;
Construct a type with a set of properties K of type T
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{
www/apps/docs/content/references/inventory/types/ReservationItemDTO.mdx
+1 -1
View File
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Represents a reservation of an inventory item at a stock location
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{