asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 3 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/services/classes/NewTotalsService.mdx
+48 -62
View File
@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Constructors
### constructor
#### constructor
`**new NewTotalsService**(«destructured»)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -105,29 +105,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;`
@@ -135,6 +119,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",
@@ -156,7 +142,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -188,7 +174,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -206,13 +192,13 @@ Promise&#60;TResult&#62;
___
### getGiftCardTotals
#### getGiftCardTotals
`**getGiftCardTotals**(giftCardableAmount, «destructured»): Promise&#60;&#123; tax_total: number ; total: number &#125;&#62;`
Calculate and return the gift cards totals
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -262,7 +248,7 @@ Calculate and return the gift cards totals
}
]} />
#### Returns
##### Returns
Promise&#60;&#123; tax_total: number ; total: number &#125;&#62;
@@ -280,13 +266,13 @@ Promise&#60;&#123; tax_total: number ; total: number &#125;&#62;
___
### getGiftCardTransactionsTotals
#### getGiftCardTransactionsTotals
`**getGiftCardTransactionsTotals**(«destructured»): &#123; tax_total: number ; total: number &#125;`
Calculate and return the gift cards totals based on their transactions
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -336,7 +322,7 @@ Calculate and return the gift cards totals based on their transactions
}
]} />
#### Returns
##### Returns
`object`
@@ -375,11 +361,11 @@ Calculate and return the gift cards totals based on their transactions
___
### getGiftCardableAmount
#### getGiftCardableAmount
`**getGiftCardableAmount**(«destructured»): number`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -438,7 +424,7 @@ ___
}
]} />
#### Returns
##### Returns
`number`
@@ -456,13 +442,13 @@ ___
___
### getLineItemRefund
#### getLineItemRefund
`**getLineItemRefund**(lineItem, «destructured»): number`
Return the amount that can be refund on a line item
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -548,7 +534,7 @@ Return the amount that can be refund on a line item
}
]} />
#### Returns
##### Returns
`number`
@@ -566,11 +552,11 @@ Return the amount that can be refund on a line item
___
### getLineItemRefundLegacy
#### getLineItemRefundLegacy
`Protected **getLineItemRefundLegacy**(lineItem, «destructured»): number`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -647,7 +633,7 @@ ___
}
]} />
#### Returns
##### Returns
`number`
@@ -665,13 +651,13 @@ ___
___
### getLineItemTotals
#### getLineItemTotals
`**getLineItemTotals**(items, «destructured»): Promise&#60;&#123; [lineItemId: string]: [LineItemTotals](../types/LineItemTotals.mdx); &#125;&#62;`
Calculate and return the items totals for either the legacy calculation or the new calculation
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -721,7 +707,7 @@ Calculate and return the items totals for either the legacy calculation or the n
}
]} />
#### Returns
##### Returns
Promise&#60;&#123; [lineItemId: string]: [LineItemTotals](../types/LineItemTotals.mdx); &#125;&#62;
@@ -739,13 +725,13 @@ Promise&#60;&#123; [lineItemId: string]: [LineItemTotals](../types/LineItemTotal
___
### getLineItemTotalsLegacy
#### getLineItemTotalsLegacy
`Protected **getLineItemTotalsLegacy**(item, «destructured»): Promise&#60;[LineItemTotals](../types/LineItemTotals.mdx)&#62;`
Calculate and return the legacy calculated totals using the tax rate
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -813,7 +799,7 @@ Calculate and return the legacy calculated totals using the tax rate
}
]} />
#### Returns
##### Returns
Promise&#60;[LineItemTotals](../types/LineItemTotals.mdx)&#62;
@@ -831,13 +817,13 @@ Promise&#60;[LineItemTotals](../types/LineItemTotals.mdx)&#62;
___
### getLineItemTotals\_
#### getLineItemTotals\_
`Protected **getLineItemTotals_**(item, «destructured»): Promise&#60;[LineItemTotals](../types/LineItemTotals.mdx)&#62;`
Calculate and return the totals for an item
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -914,7 +900,7 @@ Calculate and return the totals for an item
}
]} />
#### Returns
##### Returns
Promise&#60;[LineItemTotals](../types/LineItemTotals.mdx)&#62;
@@ -932,13 +918,13 @@ Promise&#60;[LineItemTotals](../types/LineItemTotals.mdx)&#62;
___
### getShippingMethodTotals
#### getShippingMethodTotals
`**getShippingMethodTotals**(shippingMethods, «destructured»): Promise&#60;&#123; [shippingMethodId: string]: [ShippingMethodTotals](../types/ShippingMethodTotals.mdx); &#125;&#62;`
Calculate and return the shipping methods totals for either the legacy calculation or the new calculation
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -997,7 +983,7 @@ Calculate and return the shipping methods totals for either the legacy calculati
}
]} />
#### Returns
##### Returns
Promise&#60;&#123; [shippingMethodId: string]: [ShippingMethodTotals](../types/ShippingMethodTotals.mdx); &#125;&#62;
@@ -1015,13 +1001,13 @@ Promise&#60;&#123; [shippingMethodId: string]: [ShippingMethodTotals](../types/S
___
### getShippingMethodTotalsLegacy
#### getShippingMethodTotalsLegacy
`Protected **getShippingMethodTotalsLegacy**(shippingMethod, «destructured»): Promise&#60;[ShippingMethodTotals](../types/ShippingMethodTotals.mdx)&#62;`
Calculate and return the shipping method totals legacy using the tax rate
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1071,7 +1057,7 @@ Calculate and return the shipping method totals legacy using the tax rate
}
]} />
#### Returns
##### Returns
Promise&#60;[ShippingMethodTotals](../types/ShippingMethodTotals.mdx)&#62;
@@ -1089,13 +1075,13 @@ Promise&#60;[ShippingMethodTotals](../types/ShippingMethodTotals.mdx)&#62;
___
### getShippingMethodTotals\_
#### getShippingMethodTotals\_
`Protected **getShippingMethodTotals_**(shippingMethod, «destructured»): Promise&#60;[ShippingMethodTotals](../types/ShippingMethodTotals.mdx)&#62;`
Calculate and return the shipping method totals
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1154,7 +1140,7 @@ Calculate and return the shipping method totals
}
]} />
#### Returns
##### Returns
Promise&#60;[ShippingMethodTotals](../types/ShippingMethodTotals.mdx)&#62;
@@ -1172,11 +1158,11 @@ Promise&#60;[ShippingMethodTotals](../types/ShippingMethodTotals.mdx)&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1190,7 +1176,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -1208,11 +1194,11 @@ ___
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [NewTotalsService](NewTotalsService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1226,7 +1212,7 @@ ___
}
]} />
#### Returns
##### Returns
[NewTotalsService](NewTotalsService.mdx)