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

133
www/apps/docs/content/references/services/classes/SalesChannelLocationService.mdx
View File

@@ -10,11 +10,11 @@ Service for managing the stock locations of sales channels
## Constructors
### constructor
#### constructor
`**new SalesChannelLocationService**(«destructured»)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -98,102 +98,25 @@ Service for managing the stock locations of sales channels
## Accessors
### activeManager\_
#### activeManager\_
`Protected get**activeManager_**(): EntityManager`
#### Returns
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
`Protected` **activeManager\_**: [object Object]
___
### stockLocationService\_
#### stockLocationService\_
`Protected get**stockLocationService_**(): [IStockLocationService](../interfaces/IStockLocationService.mdx)`
#### Returns
[IStockLocationService](../interfaces/IStockLocationService.mdx)
<ParameterTypes parameters={[
{
"name": "create",
"type": "(`input`: [CreateStockLocationInput](../types/CreateStockLocationInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "delete",
"type": "(`id`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;void&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "list",
"type": "(`selector`: [FilterableStockLocationProps](../interfaces/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)[]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "listAndCount",
"type": "(`selector`: [FilterableStockLocationProps](../interfaces/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "retrieve",
"type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "update",
"type": "(`id`: `string`, `input`: [UpdateStockLocationInput](../types/UpdateStockLocationInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
`Protected` **stockLocationService\_**: [object Object]
## Methods
### associateLocation
#### associateLocation
`**associateLocation**(salesChannelId, locationId): Promise&#60;void&#62;`
Associates a sales channel with a stock location.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -216,7 +139,7 @@ Associates a sales channel with a stock location.
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -234,7 +157,7 @@ Promise&#60;void&#62;
___
### atomicPhase\_
#### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -242,6 +165,8 @@ Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
##### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
@@ -263,7 +188,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -295,7 +220,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -313,13 +238,13 @@ Promise&#60;TResult&#62;
___
### listLocationIds
#### listLocationIds
`**listLocationIds**(salesChannelId): Promise&#60;string[]&#62;`
Lists the stock locations associated with a sales channel.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -333,7 +258,7 @@ Lists the stock locations associated with a sales channel.
}
]} />
#### Returns
##### Returns
Promise&#60;string[]&#62;
@@ -351,13 +276,13 @@ Promise&#60;string[]&#62;
___
### listSalesChannelIds
#### listSalesChannelIds
`**listSalesChannelIds**(locationId): Promise&#60;string[]&#62;`
Lists the sales channels associated with a stock location.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -371,7 +296,7 @@ Lists the sales channels associated with a stock location.
}
]} />
#### Returns
##### Returns
Promise&#60;string[]&#62;
@@ -389,13 +314,13 @@ Promise&#60;string[]&#62;
___
### removeLocation
#### removeLocation
`**removeLocation**(locationId, salesChannelId?): Promise&#60;void&#62;`
Removes an association between a sales channel and a stock location.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -418,7 +343,7 @@ Removes an association between a sales channel and a stock location.
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -436,11 +361,11 @@ Promise&#60;void&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -454,7 +379,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -472,11 +397,11 @@ ___
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [SalesChannelLocationService](SalesChannelLocationService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -490,7 +415,7 @@ ___
}
]} />
#### Returns
##### Returns
[SalesChannelLocationService](SalesChannelLocationService.mdx)