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/classes/LineItemService.mdx
+57 -65
View File
@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Constructors
### constructor
#### constructor
`**new LineItemService**(«destructured»)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -168,29 +168,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;`
@@ -198,6 +182,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",
@@ -219,7 +205,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -251,7 +237,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -269,11 +255,11 @@ Promise&#60;TResult&#62;
___
### cloneTo
#### cloneTo
`**cloneTo**(ids, data?, options?): Promise&#60;[LineItem](LineItem.mdx)[]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -314,7 +300,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[LineItem](LineItem.mdx)[]&#62;
@@ -332,12 +318,14 @@ Promise&#60;[LineItem](LineItem.mdx)[]&#62;
___
### create
#### create
`**create**<TypeParameter T, TypeParameter TResult>(data): Promise&#60;TResult&#62;`
Create a line item
##### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
@@ -359,7 +347,7 @@ Create a line item
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -373,7 +361,7 @@ Create a line item
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -391,14 +379,14 @@ Promise&#60;TResult&#62;
___
### createReturnLines
#### createReturnLines
`**createReturnLines**(returnId, cartId): Promise&#60;[LineItem](LineItem.mdx)[]&#62;`
Creates return line items for a given cart based on the return items in a
return.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -421,7 +409,7 @@ return.
}
]} />
#### Returns
##### Returns
Promise&#60;[LineItem](LineItem.mdx)[]&#62;
@@ -439,13 +427,13 @@ Promise&#60;[LineItem](LineItem.mdx)[]&#62;
___
### createTaxLine
#### createTaxLine
`**createTaxLine**(args): [LineItemTaxLine](LineItemTaxLine.mdx)`
Create a line item tax line.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -459,7 +447,7 @@ Create a line item tax line.
}
]} />
#### Returns
##### Returns
[LineItemTaxLine](LineItemTaxLine.mdx)
@@ -477,13 +465,13 @@ Create a line item tax line.
___
### delete
#### delete
`**delete**(id): Promise&#60;undefined \| null \| [LineItem](LineItem.mdx)&#62;`
Deletes a line item.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -497,7 +485,7 @@ Deletes a line item.
}
]} />
#### Returns
##### Returns
Promise&#60;undefined \| null \| [LineItem](LineItem.mdx)&#62;
@@ -515,11 +503,11 @@ Promise&#60;undefined \| null \| [LineItem](LineItem.mdx)&#62;
___
### deleteWithTaxLines
#### deleteWithTaxLines
`**deleteWithTaxLines**(id): Promise&#60;undefined \| null \| [LineItem](LineItem.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -533,7 +521,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;undefined \| null \| [LineItem](LineItem.mdx)&#62;
@@ -556,12 +544,14 @@ Deletes a line item with the tax lines.
___
### generate
#### generate
`**generate**<TypeParameter T, TypeParameter TResult>(variantIdOrData, regionIdOrContext, quantity?, context?): Promise&#60;TResult&#62;`
Generate a single or multiple line item without persisting the data into the db
##### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
@@ -583,7 +573,7 @@ Generate a single or multiple line item without persisting the data into the db
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -624,7 +614,7 @@ Generate a single or multiple line item without persisting the data into the db
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -642,11 +632,11 @@ Promise&#60;TResult&#62;
___
### generateLineItem
#### generateLineItem
`Protected **generateLineItem**(variant, quantity, context): Promise&#60;[LineItem](LineItem.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -750,7 +740,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[LineItem](LineItem.mdx)&#62;
@@ -768,11 +758,11 @@ Promise&#60;[LineItem](LineItem.mdx)&#62;
___
### list
#### list
`**list**(selector, config?): Promise&#60;[LineItem](LineItem.mdx)[]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -795,7 +785,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[LineItem](LineItem.mdx)[]&#62;
@@ -813,13 +803,13 @@ Promise&#60;[LineItem](LineItem.mdx)[]&#62;
___
### retrieve
#### retrieve
`**retrieve**(id, config?): Promise&#60;[LineItem](LineItem.mdx)&#62;`
Retrieves a line item by its id.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -842,7 +832,7 @@ Retrieves a line item by its id.
}
]} />
#### Returns
##### Returns
Promise&#60;[LineItem](LineItem.mdx)&#62;
@@ -860,11 +850,11 @@ Promise&#60;[LineItem](LineItem.mdx)&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -878,7 +868,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -896,13 +886,13 @@ ___
___
### update
#### update
`**update**(idOrSelector, data): Promise&#60;[LineItem](LineItem.mdx)[]&#62;`
Updates a line item
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -925,7 +915,7 @@ Updates a line item
}
]} />
#### Returns
##### Returns
Promise&#60;[LineItem](LineItem.mdx)[]&#62;
@@ -943,10 +933,12 @@ Promise&#60;[LineItem](LineItem.mdx)[]&#62;
___
### validateGenerateArguments
#### validateGenerateArguments
`Protected **validateGenerateArguments**<TypeParameter T, TypeParameter TResult>(variantIdOrData, regionIdOrContext, quantity?): void`
##### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
@@ -968,7 +960,7 @@ ___
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1000,7 +992,7 @@ ___
}
]} />
#### Returns
##### Returns
`void`
@@ -1018,11 +1010,11 @@ ___
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [LineItemService](LineItemService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1036,7 +1028,7 @@ ___
}
]} />
#### Returns
##### Returns
[LineItemService](LineItemService.mdx)