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
co-authored by kodiakhq[bot] <kodiakhq[bot]@users.noreply.github.com>
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/LineItemAdjustmentService.md
+22 -22
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:44](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L44)
[packages/medusa/src/services/line-item-adjustment.ts:39](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L39)
## Properties
@@ -40,7 +40,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)
___
@@ -54,7 +54,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)
___
@@ -64,7 +64,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:42](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L42)
[packages/medusa/src/services/line-item-adjustment.ts:37](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L37)
___
@@ -74,7 +74,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:41](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L41)
[packages/medusa/src/services/line-item-adjustment.ts:36](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L36)
___
@@ -88,7 +88,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:38](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L38)
[packages/medusa/src/services/line-item-adjustment.ts:33](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L33)
___
@@ -102,7 +102,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:39](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L39)
[packages/medusa/src/services/line-item-adjustment.ts:34](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L34)
## Methods
@@ -141,7 +141,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)
___
@@ -165,7 +165,7 @@ line item adjustment
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:88](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L88)
[packages/medusa/src/services/line-item-adjustment.ts:90](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L90)
___
@@ -190,7 +190,7 @@ a line item adjustment or undefined if no adjustment was created
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:255](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L255)
[packages/medusa/src/services/line-item-adjustment.ts:255](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L255)
___
@@ -216,7 +216,7 @@ otherwise returns an array of line item adjustments for each line item in the ca
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:283](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L283)
[packages/medusa/src/services/line-item-adjustment.ts:283](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L283)
___
@@ -240,13 +240,13 @@ the result of the delete operation
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:153](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L153)
[packages/medusa/src/services/line-item-adjustment.ts:155](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L155)
___
### generateAdjustments
▸ **generateAdjustments**(`cart`, `generatedLineItem`, `context`): `Promise`<`GeneratedAdjustment`[]\>
▸ **generateAdjustments**(`calculationContextData`, `generatedLineItem`, `context`): `Promise`<`GeneratedAdjustment`[]\>
Creates adjustment for a line item
@@ -254,7 +254,7 @@ Creates adjustment for a line item
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart` | `Cart` | the cart object holding discounts |
| `calculationContextData` | `CalculationContextData` | the calculationContextData object holding discounts |
| `generatedLineItem` | `LineItem` | the line item for which a line item adjustment might be created |
| `context` | `AdjustmentContext` | the line item for which a line item adjustment might be created |
@@ -266,7 +266,7 @@ a line item adjustment or undefined if no adjustment was created
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:182](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L182)
[packages/medusa/src/services/line-item-adjustment.ts:184](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L184)
___
@@ -291,13 +291,13 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:136](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L136)
[packages/medusa/src/services/line-item-adjustment.ts:138](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L138)
___
### retrieve
▸ **retrieve**(`id`, `config?`): `Promise`<`LineItemAdjustment`\>
▸ **retrieve**(`lineItemAdjustmentId`, `config?`): `Promise`<`LineItemAdjustment`\>
Retrieves a line item adjustment by id.
@@ -305,7 +305,7 @@ Retrieves a line item adjustment by id.
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | the id of the line item adjustment to retrieve |
| `lineItemAdjustmentId` | `string` | the id of the line item adjustment to retrieve |
| `config` | `FindConfig`<`LineItemAdjustment`\> | the config to retrieve the line item adjustment by |
#### Returns
@@ -316,7 +316,7 @@ the line item adjustment.
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:63](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L63)
[packages/medusa/src/services/line-item-adjustment.ts:58](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L58)
___
@@ -340,7 +340,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)
___
@@ -365,7 +365,7 @@ line item adjustment
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:105](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L105)
[packages/medusa/src/services/line-item-adjustment.ts:107](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L107)
___
@@ -389,4 +389,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)