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

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
2023-04-26 20:57:01 +03:00
committed by GitHub
parent f3b2d21761
commit beffa3de0e
58 changed files with 1555 additions and 1516 deletions

View File

@@ -28,7 +28,7 @@ TransactionBaseService.constructor
#### Defined in
[medusa/src/services/totals.ts:112](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L112)
[medusa/src/services/totals.ts:112](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L112)
## Properties
@@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___
@@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
@@ -70,7 +70,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___
@@ -80,7 +80,7 @@ ___
#### Defined in
[medusa/src/services/totals.ts:110](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L110)
[medusa/src/services/totals.ts:110](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L110)
___
@@ -94,7 +94,7 @@ TransactionBaseService.manager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___
@@ -104,7 +104,7 @@ ___
#### Defined in
[medusa/src/services/totals.ts:108](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L108)
[medusa/src/services/totals.ts:108](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L108)
___
@@ -114,7 +114,7 @@ ___
#### Defined in
[medusa/src/services/totals.ts:109](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L109)
[medusa/src/services/totals.ts:109](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L109)
___
@@ -124,7 +124,7 @@ ___
#### Defined in
[medusa/src/services/totals.ts:107](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L107)
[medusa/src/services/totals.ts:107](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L107)
___
@@ -138,7 +138,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
@@ -156,7 +156,7 @@ TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods
@@ -195,7 +195,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___
@@ -223,7 +223,7 @@ triples of lineitem, variant and applied discount
#### Defined in
[medusa/src/services/totals.ts:626](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L626)
[medusa/src/services/totals.ts:626](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L626)
___
@@ -252,7 +252,7 @@ array of triples of lineitem, variant and applied discount
#### Defined in
[medusa/src/services/totals.ts:668](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L668)
[medusa/src/services/totals.ts:668](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L668)
___
@@ -283,7 +283,7 @@ the allocation map for the line items in the cart or order.
#### Defined in
[medusa/src/services/totals.ts:435](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L435)
[medusa/src/services/totals.ts:435](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L435)
___
@@ -308,7 +308,7 @@ the tax calculation context
#### Defined in
[medusa/src/services/totals.ts:1027](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L1027)
[medusa/src/services/totals.ts:1027](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L1027)
___
@@ -333,7 +333,7 @@ the total discounts amount
#### Defined in
[medusa/src/services/totals.ts:1005](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L1005)
[medusa/src/services/totals.ts:1005](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L1005)
___
@@ -359,7 +359,7 @@ the gift card amount applied to the cart or order
#### Defined in
[medusa/src/services/totals.ts:974](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L974)
[medusa/src/services/totals.ts:974](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L974)
___
@@ -384,7 +384,7 @@ the gift card amount applied to the cart or order
#### Defined in
[medusa/src/services/totals.ts:957](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L957)
[medusa/src/services/totals.ts:957](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L957)
___
@@ -413,7 +413,7 @@ the allocations that the discount has on the items in the cart or
#### Defined in
[medusa/src/services/totals.ts:719](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L719)
[medusa/src/services/totals.ts:719](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L719)
___
@@ -433,7 +433,7 @@ ___
#### Defined in
[medusa/src/services/totals.ts:696](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L696)
[medusa/src/services/totals.ts:696](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L696)
___
@@ -454,7 +454,7 @@ ___
#### Defined in
[medusa/src/services/totals.ts:681](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L681)
[medusa/src/services/totals.ts:681](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L681)
___
@@ -479,7 +479,7 @@ the line item refund amount.
#### Defined in
[medusa/src/services/totals.ts:504](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L504)
[medusa/src/services/totals.ts:504](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L504)
___
@@ -506,7 +506,7 @@ the line item total
#### Defined in
[medusa/src/services/totals.ts:930](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L930)
[medusa/src/services/totals.ts:930](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L930)
___
@@ -534,7 +534,7 @@ the breakdown of the line item totals
#### Defined in
[medusa/src/services/totals.ts:775](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L775)
[medusa/src/services/totals.ts:775](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L775)
___
@@ -558,7 +558,7 @@ the total paid amount
#### Defined in
[medusa/src/services/totals.ts:157](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L157)
[medusa/src/services/totals.ts:157](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L157)
___
@@ -585,7 +585,7 @@ the calculated subtotal
#### Defined in
[medusa/src/services/totals.ts:583](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L583)
[medusa/src/services/totals.ts:583](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L583)
___
@@ -609,7 +609,7 @@ the total refunded amount for an order.
#### Defined in
[medusa/src/services/totals.ts:489](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L489)
[medusa/src/services/totals.ts:489](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L489)
___
@@ -636,7 +636,7 @@ An object that breaks down the totals for the shipping method
#### Defined in
[medusa/src/services/totals.ts:191](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L191)
[medusa/src/services/totals.ts:191](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L191)
___
@@ -660,7 +660,7 @@ shipping total
#### Defined in
[medusa/src/services/totals.ts:319](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L319)
[medusa/src/services/totals.ts:319](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L319)
___
@@ -685,7 +685,7 @@ the calculated subtotal
#### Defined in
[medusa/src/services/totals.ts:283](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L283)
[medusa/src/services/totals.ts:283](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L283)
___
@@ -710,7 +710,7 @@ the swap total
#### Defined in
[medusa/src/services/totals.ts:172](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L172)
[medusa/src/services/totals.ts:172](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L172)
___
@@ -736,7 +736,7 @@ tax total
#### Defined in
[medusa/src/services/totals.ts:346](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L346)
[medusa/src/services/totals.ts:346](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L346)
___
@@ -761,7 +761,7 @@ the calculated subtotal
#### Defined in
[medusa/src/services/totals.ts:134](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L134)
[medusa/src/services/totals.ts:134](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L134)
___
@@ -785,7 +785,7 @@ the rounded value
#### Defined in
[medusa/src/services/totals.ts:1057](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/services/totals.ts#L1057)
[medusa/src/services/totals.ts:1057](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/totals.ts#L1057)
___
@@ -809,7 +809,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___
@@ -833,4 +833,4 @@ TransactionBaseService.withTransaction
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/0f51e3a40/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/interfaces/transaction-base-service.ts#L20)