LineItemAdjustmentService

Provides layer to manipulate line item adjustments.

Hierarchy

• TransactionBaseService

  ↳ LineItemAdjustmentService

Constructors

constructor

new LineItemAdjustmentService(«destructured»)

Parameters

Name
«destructured»

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/line-item-adjustment.ts:36

Properties

__configModule__

Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

medusa/src/interfaces/transaction-base-service.ts:14

---

__container__

Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

medusa/src/interfaces/transaction-base-service.ts:13

---

__moduleDeclaration__

Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

medusa/src/interfaces/transaction-base-service.ts:15

---

discountService

Private Readonly discountService: DiscountService

Defined in

medusa/src/services/line-item-adjustment.ts:34

---

lineItemAdjustmentRepo_

Private Readonly lineItemAdjustmentRepo_: Repository<LineItemAdjustment>

Defined in

medusa/src/services/line-item-adjustment.ts:33

---

manager_

Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:5

---

transactionManager_

Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:6

Accessors

activeManager_

Protected get activeManager_(): EntityManager

Returns

EntityManager

-EntityManager:

Inherited from

TransactionBaseService.activeManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:8

Methods

atomicPhase_

Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.

Name
TResult
TError

Parameters

Name	Description
work	(transactionManager: EntityManager) => Promise<TResult>
isolationOrErrorHandler?	IsolationLevel | (error: TError) => Promise<void | TResult>
maybeErrorHandlerOrDontFail?	(error: TError) => Promise<void | TResult>

Returns

Promise<TResult>

-Promise: the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

medusa/src/interfaces/transaction-base-service.ts:56

---

create

create(data): Promise<LineItemAdjustment>

Creates a line item adjustment

Parameters

Name	Description
data	Partial<LineItemAdjustment>

Returns

Promise<LineItemAdjustment>

-Promise: line item adjustment -LineItemAdjustment:

Defined in

medusa/src/services/line-item-adjustment.ts:86

---

createAdjustmentForLineItem

createAdjustmentForLineItem(cart, lineItem): Promise<LineItemAdjustment[]>

Creates adjustment for a line item

Parameters

Name	Description
cart	Cart
lineItem	LineItem

Returns

Promise<LineItemAdjustment[]>

-Promise: a line item adjustment or undefined if no adjustment was created -LineItemAdjustment[]: -LineItemAdjustment:

Defined in

medusa/src/services/line-item-adjustment.ts:262

---

createAdjustments

createAdjustments(cart, lineItem?): Promise<LineItemAdjustment[] | LineItemAdjustment[][]>

Creates adjustment for a line item

Parameters

Name	Description
cart	Cart
lineItem?	LineItem

Returns

Promise<LineItemAdjustment[] | LineItemAdjustment[][]>

-Promise: if a lineItem was given, returns a line item adjustment or undefined if no adjustment was created otherwise returns an array of line item adjustments for each line item in the cart -LineItemAdjustment[] \| LineItemAdjustment[][]: (optional)

Defined in

medusa/src/services/line-item-adjustment.ts:290

---

delete

delete(selectorOrIds): Promise<void>

Deletes line item adjustments matching a selector

Parameters

Name	Description
selectorOrIds	string | string[] | FilterableLineItemAdjustmentProps & { discount_id?: FindOperator<null | string> }

Returns

Promise<void>

-Promise: the result of the delete operation

Defined in

medusa/src/services/line-item-adjustment.ts:153

---

generateAdjustments

generateAdjustments(calculationContextData, generatedLineItem, context): Promise<GeneratedAdjustment[]>

Creates adjustment for a line item

Parameters

Name	Description
calculationContextData	CalculationContextData
generatedLineItem	LineItem
context	AdjustmentContext

Returns

Promise<GeneratedAdjustment[]>

-Promise: a line item adjustment or undefined if no adjustment was created -GeneratedAdjustment[]:

Defined in

medusa/src/services/line-item-adjustment.ts:188

---

list

list(selector?, config?): Promise<LineItemAdjustment[]>

Lists line item adjustments

Parameters

Name	Description
selector	FilterableLineItemAdjustmentProps
config	FindConfig<LineItemAdjustment>

Returns

Promise<LineItemAdjustment[]>

-Promise: the result of the find operation -LineItemAdjustment[]: -LineItemAdjustment:

Defined in

medusa/src/services/line-item-adjustment.ts:136

---

retrieve

retrieve(lineItemAdjustmentId, config?): Promise<LineItemAdjustment>

Retrieves a line item adjustment by id.

Parameters

Name	Description
lineItemAdjustmentId	string
config	FindConfig<LineItemAdjustment>

Returns

Promise<LineItemAdjustment>

-Promise: the line item adjustment. -LineItemAdjustment:

Defined in

medusa/src/services/line-item-adjustment.ts:53

---

shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

Name
err

Returns

boolean

-boolean: (optional)

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

medusa/src/interfaces/transaction-base-service.ts:37

---

update

update(id, data): Promise<LineItemAdjustment>

Creates a line item adjustment

Parameters

Name	Description
id	string
data	Partial<LineItemAdjustment>

Returns

Promise<LineItemAdjustment>

-Promise: line item adjustment -LineItemAdjustment:

Defined in

medusa/src/services/line-item-adjustment.ts:104

---

withTransaction

withTransaction(transactionManager?): LineItemAdjustmentService

Parameters

Name
transactionManager?

Returns

LineItemAdjustmentService

-LineItemAdjustmentService:

Inherited from

TransactionBaseService.withTransaction

Defined in

medusa/src/interfaces/transaction-base-service.ts:20