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

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

View File

@@ -28,7 +28,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/discount.ts:67](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L67)
[packages/medusa/src/services/discount.ts:68](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L68)
## 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/discount.ts:54](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L54)
[packages/medusa/src/services/discount.ts:55](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L55)
___
@@ -76,7 +76,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:58](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L58)
[packages/medusa/src/services/discount.ts:59](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L59)
___
@@ -86,7 +86,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:59](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L59)
[packages/medusa/src/services/discount.ts:60](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L60)
___
@@ -96,7 +96,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:53](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L53)
[packages/medusa/src/services/discount.ts:54](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L54)
___
@@ -106,7 +106,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:55](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L55)
[packages/medusa/src/services/discount.ts:56](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L56)
___
@@ -116,7 +116,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:64](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L64)
[packages/medusa/src/services/discount.ts:65](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L65)
___
@@ -126,7 +126,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:65](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L65)
[packages/medusa/src/services/discount.ts:66](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L66)
___
@@ -136,7 +136,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:56](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L56)
[packages/medusa/src/services/discount.ts:57](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L57)
___
@@ -150,7 +150,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/discount.ts:50](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L50)
[packages/medusa/src/services/discount.ts:51](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L51)
___
@@ -160,7 +160,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:61](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L61)
[packages/medusa/src/services/discount.ts:62](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L62)
___
@@ -170,7 +170,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:62](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L62)
[packages/medusa/src/services/discount.ts:63](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L63)
___
@@ -180,7 +180,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:63](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L63)
[packages/medusa/src/services/discount.ts:64](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L64)
___
@@ -190,7 +190,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:60](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L60)
[packages/medusa/src/services/discount.ts:61](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L61)
___
@@ -204,7 +204,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/discount.ts:51](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L51)
[packages/medusa/src/services/discount.ts:52](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L52)
## Methods
@@ -229,7 +229,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/discount.ts:472](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L472)
[packages/medusa/src/services/discount.ts:487](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L487)
___
@@ -268,13 +268,13 @@ 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)
___
### calculateDiscountForLineItem
**calculateDiscountForLineItem**(`discountId`, `lineItem`, `cart`): `Promise`<`number`\>
**calculateDiscountForLineItem**(`discountId`, `lineItem`, `calculationContextData`): `Promise`<`number`\>
#### Parameters
@@ -282,7 +282,7 @@ ___
| :------ | :------ |
| `discountId` | `string` |
| `lineItem` | `LineItem` |
| `cart` | `Cart` |
| `calculationContextData` | `CalculationContextData` |
#### Returns
@@ -290,7 +290,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:573](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L573)
[packages/medusa/src/services/discount.ts:588](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L588)
___
@@ -311,7 +311,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:735](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L735)
[packages/medusa/src/services/discount.ts:762](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L762)
___
@@ -336,7 +336,7 @@ the result of the create operation
#### Defined in
[packages/medusa/src/services/discount.ts:185](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L185)
[packages/medusa/src/services/discount.ts:186](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L186)
___
@@ -361,7 +361,7 @@ the newly created dynamic code
#### Defined in
[packages/medusa/src/services/discount.ts:400](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L400)
[packages/medusa/src/services/discount.ts:415](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L415)
___
@@ -385,7 +385,7 @@ the result of the delete operation
#### Defined in
[packages/medusa/src/services/discount.ts:532](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L532)
[packages/medusa/src/services/discount.ts:547](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L547)
___
@@ -410,7 +410,7 @@ the newly created dynamic code
#### Defined in
[packages/medusa/src/services/discount.ts:451](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L451)
[packages/medusa/src/services/discount.ts:466](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L466)
___
@@ -430,7 +430,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:704](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L704)
[packages/medusa/src/services/discount.ts:731](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L731)
___
@@ -450,7 +450,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:700](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L700)
[packages/medusa/src/services/discount.ts:727](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L727)
___
@@ -470,7 +470,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:694](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L694)
[packages/medusa/src/services/discount.ts:721](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L721)
___
@@ -490,7 +490,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:712](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L712)
[packages/medusa/src/services/discount.ts:739](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L739)
___
@@ -511,7 +511,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:716](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L716)
[packages/medusa/src/services/discount.ts:743](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L743)
___
@@ -534,7 +534,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/discount.ts:123](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L123)
[packages/medusa/src/services/discount.ts:124](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L124)
___
@@ -557,7 +557,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/discount.ts:139](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L139)
[packages/medusa/src/services/discount.ts:140](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L140)
___
@@ -582,7 +582,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/discount.ts:507](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L507)
[packages/medusa/src/services/discount.ts:522](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L522)
___
@@ -607,7 +607,7 @@ the discount
#### Defined in
[packages/medusa/src/services/discount.ts:244](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L244)
[packages/medusa/src/services/discount.ts:252](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L252)
___
@@ -632,7 +632,7 @@ the discount document
#### Defined in
[packages/medusa/src/services/discount.ts:270](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L270)
[packages/medusa/src/services/discount.ts:285](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L285)
___
@@ -656,7 +656,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)
___
@@ -681,7 +681,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/discount.ts:303](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L303)
[packages/medusa/src/services/discount.ts:318](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L318)
___
@@ -702,7 +702,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:634](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L634)
[packages/medusa/src/services/discount.ts:661](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L661)
___
@@ -723,7 +723,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:546](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L546)
[packages/medusa/src/services/discount.ts:561](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L561)
___
@@ -753,7 +753,7 @@ the result of the create operation
#### Defined in
[packages/medusa/src/services/discount.ts:105](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L105)
[packages/medusa/src/services/discount.ts:106](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L106)
___
@@ -777,4 +777,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)