asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

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

Browse Source 
Co-authored-by: kodiakhq[bot] <kodiakhq[bot]@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-12-23 10:20:47 +02:00
committed by GitHub
parent 8cbd627fb7
commit a32a2c4cf1
56 changed files with 2165 additions and 1675 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/references/services/classes/TotalsService.md
+55 -38
View File
@@ -28,7 +28,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/totals.ts:108](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L108)
[packages/medusa/src/services/totals.ts:116](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L116)
## Properties
@@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/totals.ts#L106)
[packages/medusa/src/services/totals.ts:114](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L114)
___
@@ -80,7 +80,17 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/totals.ts:101](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L101)
[packages/medusa/src/services/totals.ts:108](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L108)
___
### newTotalsService\_
• `Protected` `Readonly` **newTotalsService\_**: [`NewTotalsService`](NewTotalsService.md)
#### Defined in
[packages/medusa/src/services/totals.ts:112](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L112)
___
@@ -90,7 +100,7 @@ ___
#### Defined in
[packages/medusa/src/services/totals.ts:105](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L105)
[packages/medusa/src/services/totals.ts:113](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L113)
___
@@ -100,7 +110,7 @@ ___
#### Defined in
[packages/medusa/src/services/totals.ts:104](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L104)
[packages/medusa/src/services/totals.ts:111](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L111)
___
@@ -114,7 +124,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/totals.ts:102](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L102)
[packages/medusa/src/services/totals.ts:109](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L109)
## Methods
@@ -153,7 +163,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
___
@@ -181,7 +191,7 @@ triples of lineitem, variant and applied discount
#### Defined in
[packages/medusa/src/services/totals.ts:609](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L609)
[packages/medusa/src/services/totals.ts:624](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L624)
___
@@ -210,7 +220,7 @@ array of triples of lineitem, variant and applied discount
#### Defined in
[packages/medusa/src/services/totals.ts:651](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L651)
[packages/medusa/src/services/totals.ts:666](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L666)
___
@@ -226,7 +236,11 @@ applies to a specific line item.
| Name | Type | Description |
| :------ | :------ | :------ |
| `orderOrCart` | `Cart` \| `Order` | the order or cart to get an allocation map for |
| `orderOrCart` | `Object` | the order or cart to get an allocation map for |
| `orderOrCart.claims?` | `ClaimOrder`[] | - |
| `orderOrCart.discounts?` | `Discount`[] | - |
| `orderOrCart.items` | `LineItem`[] | - |
| `orderOrCart.swaps?` | `Swap`[] | - |
| `options` | `AllocationMapOptions` | controls what should be included in allocation map |
#### Returns
@@ -237,13 +251,13 @@ the allocation map for the line items in the cart or order.
#### Defined in
[packages/medusa/src/services/totals.ts:431](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L431)
[packages/medusa/src/services/totals.ts:441](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L441)
___
### getCalculationContext
▸ **getCalculationContext**(`cartOrOrder`, `options?`): `Promise`<`TaxCalculationContext`\>
▸ **getCalculationContext**(`calculationContextData`, `options?`): `Promise`<`TaxCalculationContext`\>
Prepares the calculation context for a tax total calculation.
@@ -251,7 +265,7 @@ Prepares the calculation context for a tax total calculation.
| Name | Type | Description |
| :------ | :------ | :------ |
| `cartOrOrder` | `Cart` \| `Order` | the cart or order to get the calculation context for |
| `calculationContextData` | `CalculationContextData` | the calculationContextData to get the calculation context for |
| `options` | `CalculationContextOptions` | options to gather context by |
#### Returns
@@ -262,7 +276,7 @@ the tax calculation context
#### Defined in
[packages/medusa/src/services/totals.ts:1058](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L1058)
[packages/medusa/src/services/totals.ts:1028](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L1028)
___
@@ -287,7 +301,7 @@ the total discounts amount
#### Defined in
[packages/medusa/src/services/totals.ts:1028](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L1028)
[packages/medusa/src/services/totals.ts:998](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L998)
___
@@ -313,7 +327,7 @@ the gift card amount applied to the cart or order
#### Defined in
[packages/medusa/src/services/totals.ts:945](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L945)
[packages/medusa/src/services/totals.ts:964](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L964)
___
@@ -338,7 +352,7 @@ the gift card amount applied to the cart or order
#### Defined in
[packages/medusa/src/services/totals.ts:928](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L928)
[packages/medusa/src/services/totals.ts:947](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L947)
___
@@ -352,7 +366,10 @@ Returns the discount amount allocated to the line items of an order.
| Name | Type | Description |
| :------ | :------ | :------ |
| `cartOrOrder` | `Cart` \| `Order` | the cart or order to get line discount allocations for |
| `cartOrOrder` | `Object` | the cart or order to get line discount allocations for |
| `cartOrOrder.claims?` | `ClaimOrder`[] | - |
| `cartOrOrder.items` | `LineItem`[] | - |
| `cartOrOrder.swaps?` | `Swap`[] | - |
| `discount` | `Discount` | the discount to use as context for the calculation |
#### Returns
@@ -364,7 +381,7 @@ the allocations that the discount has on the items in the cart or
#### Defined in
[packages/medusa/src/services/totals.ts:702](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L702)
[packages/medusa/src/services/totals.ts:717](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L717)
___
@@ -384,7 +401,7 @@ ___
#### Defined in
[packages/medusa/src/services/totals.ts:679](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L679)
[packages/medusa/src/services/totals.ts:694](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L694)
___
@@ -405,7 +422,7 @@ ___
#### Defined in
[packages/medusa/src/services/totals.ts:664](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L664)
[packages/medusa/src/services/totals.ts:679](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L679)
___
@@ -430,7 +447,7 @@ the line item refund amount.
#### Defined in
[packages/medusa/src/services/totals.ts:487](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L487)
[packages/medusa/src/services/totals.ts:502](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L502)
___
@@ -457,7 +474,7 @@ the line item total
#### Defined in
[packages/medusa/src/services/totals.ts:901](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L901)
[packages/medusa/src/services/totals.ts:920](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L920)
___
@@ -485,7 +502,7 @@ the breakdown of the line item totals
#### Defined in
[packages/medusa/src/services/totals.ts:748](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L748)
[packages/medusa/src/services/totals.ts:767](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L767)
___
@@ -509,7 +526,7 @@ the total paid amount
#### Defined in
[packages/medusa/src/services/totals.ts:153](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L153)
[packages/medusa/src/services/totals.ts:163](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L163)
___
@@ -536,7 +553,7 @@ the calculated subtotal
#### Defined in
[packages/medusa/src/services/totals.ts:566](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L566)
[packages/medusa/src/services/totals.ts:581](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L581)
___
@@ -560,7 +577,7 @@ the total refunded amount for an order.
#### Defined in
[packages/medusa/src/services/totals.ts:472](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L472)
[packages/medusa/src/services/totals.ts:487](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L487)
___
@@ -587,7 +604,7 @@ An object that breaks down the totals for the shipping method
#### Defined in
[packages/medusa/src/services/totals.ts:187](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L187)
[packages/medusa/src/services/totals.ts:197](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L197)
___
@@ -611,7 +628,7 @@ shipping total
#### Defined in
[packages/medusa/src/services/totals.ts:315](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L315)
[packages/medusa/src/services/totals.ts:325](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L325)
___
@@ -636,7 +653,7 @@ the calculated subtotal
#### Defined in
[packages/medusa/src/services/totals.ts:279](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L279)
[packages/medusa/src/services/totals.ts:289](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L289)
___
@@ -661,7 +678,7 @@ the swap total
#### Defined in
[packages/medusa/src/services/totals.ts:168](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L168)
[packages/medusa/src/services/totals.ts:178](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L178)
___
@@ -687,7 +704,7 @@ tax total
#### Defined in
[packages/medusa/src/services/totals.ts:342](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L342)
[packages/medusa/src/services/totals.ts:352](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L352)
___
@@ -712,7 +729,7 @@ the calculated subtotal
#### Defined in
[packages/medusa/src/services/totals.ts:130](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L130)
[packages/medusa/src/services/totals.ts:140](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L140)
___
@@ -736,7 +753,7 @@ the rounded value
#### Defined in
[packages/medusa/src/services/totals.ts:1088](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L1088)
[packages/medusa/src/services/totals.ts:1058](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L1058)
___
@@ -760,7 +777,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
___
@@ -784,4 +801,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)