chore(docs): Generated Services Reference (automated) (#2221)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-09-15 18:39:53 +03:00
committed by GitHub
parent 9e45407952
commit dab50de0b4
46 changed files with 1324 additions and 1072 deletions

View File

@@ -28,7 +28,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/totals.ts:108](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L108)
[packages/medusa/src/services/totals.ts:108](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L108)
## Properties
@@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -66,7 +66,7 @@ ___
#### Defined in
[packages/medusa/src/services/totals.ts:106](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L106)
[packages/medusa/src/services/totals.ts:106](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L106)
___
@@ -80,7 +80,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/totals.ts:101](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L101)
[packages/medusa/src/services/totals.ts:101](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L101)
___
@@ -90,7 +90,7 @@ ___
#### Defined in
[packages/medusa/src/services/totals.ts:105](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L105)
[packages/medusa/src/services/totals.ts:105](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L105)
___
@@ -100,7 +100,7 @@ ___
#### Defined in
[packages/medusa/src/services/totals.ts:104](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L104)
[packages/medusa/src/services/totals.ts:104](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L104)
___
@@ -114,7 +114,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/totals.ts:102](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L102)
[packages/medusa/src/services/totals.ts:102](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L102)
## Methods
@@ -153,7 +153,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -181,7 +181,7 @@ triples of lineitem, variant and applied discount
#### Defined in
[packages/medusa/src/services/totals.ts:647](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L647)
[packages/medusa/src/services/totals.ts:647](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L647)
___
@@ -210,7 +210,7 @@ array of triples of lineitem, variant and applied discount
#### Defined in
[packages/medusa/src/services/totals.ts:689](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L689)
[packages/medusa/src/services/totals.ts:689](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L689)
___
@@ -237,7 +237,7 @@ the allocation map for the line items in the cart or order.
#### Defined in
[packages/medusa/src/services/totals.ts:433](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L433)
[packages/medusa/src/services/totals.ts:433](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L433)
___
@@ -262,7 +262,7 @@ the tax calculation context
#### Defined in
[packages/medusa/src/services/totals.ts:1094](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L1094)
[packages/medusa/src/services/totals.ts:1094](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L1094)
___
@@ -287,7 +287,7 @@ the total discounts amount
#### Defined in
[packages/medusa/src/services/totals.ts:1064](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L1064)
[packages/medusa/src/services/totals.ts:1064](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L1064)
___
@@ -311,7 +311,7 @@ the gift card amount applied to the cart or order
#### Defined in
[packages/medusa/src/services/totals.ts:989](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L989)
[packages/medusa/src/services/totals.ts:989](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L989)
___
@@ -336,7 +336,7 @@ the gift card amount applied to the cart or order
#### Defined in
[packages/medusa/src/services/totals.ts:972](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L972)
[packages/medusa/src/services/totals.ts:972](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L972)
___
@@ -362,7 +362,7 @@ the allocations that the discount has on the items in the cart or
#### Defined in
[packages/medusa/src/services/totals.ts:740](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L740)
[packages/medusa/src/services/totals.ts:740](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L740)
___
@@ -382,7 +382,7 @@ ___
#### Defined in
[packages/medusa/src/services/totals.ts:717](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L717)
[packages/medusa/src/services/totals.ts:717](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L717)
___
@@ -403,7 +403,7 @@ ___
#### Defined in
[packages/medusa/src/services/totals.ts:702](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L702)
[packages/medusa/src/services/totals.ts:702](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L702)
___
@@ -428,7 +428,7 @@ the line item refund amount.
#### Defined in
[packages/medusa/src/services/totals.ts:525](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L525)
[packages/medusa/src/services/totals.ts:525](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L525)
___
@@ -455,7 +455,7 @@ the line item total
#### Defined in
[packages/medusa/src/services/totals.ts:941](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L941)
[packages/medusa/src/services/totals.ts:941](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L941)
___
@@ -483,7 +483,7 @@ the breakdown of the line item totals
#### Defined in
[packages/medusa/src/services/totals.ts:786](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L786)
[packages/medusa/src/services/totals.ts:786](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L786)
___
@@ -507,7 +507,7 @@ the total paid amount
#### Defined in
[packages/medusa/src/services/totals.ts:158](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L158)
[packages/medusa/src/services/totals.ts:158](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L158)
___
@@ -534,7 +534,7 @@ the calculated subtotal
#### Defined in
[packages/medusa/src/services/totals.ts:604](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L604)
[packages/medusa/src/services/totals.ts:604](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L604)
___
@@ -558,7 +558,7 @@ the total refunded amount for an order.
#### Defined in
[packages/medusa/src/services/totals.ts:510](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L510)
[packages/medusa/src/services/totals.ts:510](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L510)
___
@@ -585,7 +585,7 @@ An object that breaks down the totals for the shipping method
#### Defined in
[packages/medusa/src/services/totals.ts:192](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L192)
[packages/medusa/src/services/totals.ts:192](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L192)
___
@@ -609,7 +609,7 @@ shipping total
#### Defined in
[packages/medusa/src/services/totals.ts:317](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L317)
[packages/medusa/src/services/totals.ts:317](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L317)
___
@@ -634,7 +634,7 @@ the calculated subtotal
#### Defined in
[packages/medusa/src/services/totals.ts:281](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L281)
[packages/medusa/src/services/totals.ts:281](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L281)
___
@@ -659,7 +659,7 @@ the swap total
#### Defined in
[packages/medusa/src/services/totals.ts:173](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L173)
[packages/medusa/src/services/totals.ts:173](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L173)
___
@@ -685,7 +685,7 @@ tax total
#### Defined in
[packages/medusa/src/services/totals.ts:344](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L344)
[packages/medusa/src/services/totals.ts:344](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L344)
___
@@ -710,7 +710,7 @@ the calculated subtotal
#### Defined in
[packages/medusa/src/services/totals.ts:135](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L135)
[packages/medusa/src/services/totals.ts:135](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L135)
___
@@ -734,7 +734,7 @@ the rounded value
#### Defined in
[packages/medusa/src/services/totals.ts:1124](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/totals.ts#L1124)
[packages/medusa/src/services/totals.ts:1124](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L1124)
___
@@ -758,7 +758,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -782,4 +782,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)