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

68
www/apps/docs/content/references/services/classes/ClaimItemService.mdx
View File

@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Constructors
### constructor
#### constructor
`**new ClaimItemService**(«destructured»)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -159,29 +159,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## 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]
## Methods
### atomicPhase\_
#### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -189,6 +173,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",
@@ -210,7 +196,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -242,7 +228,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -260,11 +246,11 @@ Promise&#60;TResult&#62;
___
### create
#### create
`**create**(data): Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -278,7 +264,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;
@@ -296,11 +282,11 @@ Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;
___
### list
#### list
`**list**(selector, config?): Promise&#60;[ClaimItem](ClaimItem.mdx)[]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -323,7 +309,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[ClaimItem](ClaimItem.mdx)[]&#62;
@@ -341,13 +327,13 @@ Promise&#60;[ClaimItem](ClaimItem.mdx)[]&#62;
___
### retrieve
#### retrieve
`**retrieve**(claimItemId, config?): Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;`
Gets a claim item by id.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -370,7 +356,7 @@ Gets a claim item by id.
}
]} />
#### Returns
##### Returns
Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;
@@ -388,11 +374,11 @@ Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -406,7 +392,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -424,11 +410,11 @@ ___
___
### update
#### update
`**update**(id, data): Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -451,7 +437,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;
@@ -469,11 +455,11 @@ Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [ClaimItemService](ClaimItemService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -487,7 +473,7 @@ ___
}
]} />
#### Returns
##### Returns
[ClaimItemService](ClaimItemService.mdx)