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
co-authored by Oli Juhl Shahed Nasser
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/services/interfaces/IStockLocationService.mdx
+24 -24
View File
@@ -8,13 +8,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
### create
#### create
`**create**(input, context?): Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;`
This method is used to create a stock location.
#### Example
##### Example
```ts
import {
@@ -32,7 +32,7 @@ async function createStockLocation (name: string) {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -55,7 +55,7 @@ async function createStockLocation (name: string) {
}
]} />
#### Returns
##### Returns
Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;
@@ -73,13 +73,13 @@ Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;
___
### delete
#### delete
`**delete**(id, context?): Promise&#60;void&#62;`
This method is used to delete a stock location.
#### Example
##### Example
```ts
import {
@@ -93,7 +93,7 @@ async function deleteStockLocation (id:string) {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -116,7 +116,7 @@ async function deleteStockLocation (id:string) {
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -134,13 +134,13 @@ Promise&#60;void&#62;
___
### list
#### list
`**list**(selector, config?, context?): Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)[]&#62;`
This method is used to retrieve a paginated list of stock locations based on optional filters and configuration.
#### Example
##### Example
To retrieve a list of stock locations using their IDs:
@@ -202,7 +202,7 @@ async function listStockLocations (ids: string[], skip: number, take: number) {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -234,7 +234,7 @@ async function listStockLocations (ids: string[], skip: number, take: number) {
}
]} />
#### Returns
##### Returns
Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)[]&#62;
@@ -252,13 +252,13 @@ Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)[]&#62;
___
### listAndCount
#### listAndCount
`**listAndCount**(selector, config?, context?): Promise&#60;[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]&#62;`
This method is used to retrieve a paginated list of stock locations along with the total count of available stock locations satisfying the provided filters.
#### Example
##### Example
To retrieve a list of stock locations using their IDs:
@@ -320,7 +320,7 @@ async function listStockLocations (ids: string[], skip: number, take: number) {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -352,7 +352,7 @@ async function listStockLocations (ids: string[], skip: number, take: number) {
}
]} />
#### Returns
##### Returns
Promise&#60;[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]&#62;
@@ -370,13 +370,13 @@ Promise&#60;[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]&#62;
___
### retrieve
#### retrieve
`**retrieve**(id, config?, context?): Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;`
This method is used to retrieve a stock location by its ID
#### Example
##### Example
A simple example that retrieves a inventory item by its ID:
@@ -412,7 +412,7 @@ async function retrieveStockLocation (id: string) {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -444,7 +444,7 @@ async function retrieveStockLocation (id: string) {
}
]} />
#### Returns
##### Returns
Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;
@@ -462,13 +462,13 @@ Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;
___
### update
#### update
`**update**(id, input, context?): Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;`
This method is used to update a stock location.
#### Example
##### Example
```ts
import {
@@ -486,7 +486,7 @@ async function updateStockLocation (id:string, name: string) {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -518,7 +518,7 @@ async function updateStockLocation (id:string, name: string) {
}
]} />
#### Returns
##### Returns
Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;