Class: LineItemAdjustmentService
Provides layer to manipulate line item adjustments.
Hierarchy
TransactionBaseServiceCopy to Clipboard↳
LineItemAdjustmentServiceCopy to Clipboard
Constructors
constructor
• new LineItemAdjustmentService(__namedParametersCopy to Clipboard)
Parameters
| Name | Type |
|---|---|
__namedParametersCopy to Clipboard | LineItemAdjustmentServicePropsCopy to Clipboard |
Overrides
TransactionBaseService.constructor
Defined in
packages/medusa/src/services/line-item-adjustment.ts:39
Properties
__configModule__
• ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __configModule__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>
Inherited from
TransactionBaseService.__configModule__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:10
__container__
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard __container__: anyCopy to Clipboard
Inherited from
TransactionBaseService.__container__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:9
__moduleDeclaration__
• ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __moduleDeclaration__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>
Inherited from
TransactionBaseService.__moduleDeclaration__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:11
discountService
• PrivateCopy to Clipboard ReadonlyCopy to Clipboard discountService: DiscountServiceCopy to Clipboard
Defined in
packages/medusa/src/services/line-item-adjustment.ts:37
lineItemAdjustmentRepo_
• PrivateCopy to Clipboard ReadonlyCopy to Clipboard lineItemAdjustmentRepo_: typeof LineItemAdjustmentRepositoryCopy to Clipboard
Defined in
packages/medusa/src/services/line-item-adjustment.ts:36
manager_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard manager_: EntityManagerCopy to Clipboard
Overrides
TransactionBaseService.manager_
Defined in
packages/medusa/src/services/line-item-adjustment.ts:33
transactionManager_
• ProtectedCopy to Clipboard transactionManager_: undefinedCopy to Clipboard | EntityManagerCopy to Clipboard
Overrides
TransactionBaseService.transactionManager_
Defined in
packages/medusa/src/services/line-item-adjustment.ts:34
Methods
atomicPhase_
▸ ProtectedCopy to Clipboard atomicPhase_<TResultCopy to Clipboard, TErrorCopy to Clipboard>(workCopy to Clipboard, isolationOrErrorHandler?Copy to Clipboard, maybeErrorHandlerOrDontFail?Copy to Clipboard): PromiseCopy to Clipboard<TResultCopy to Clipboard>
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.
Type parameters
| Name |
|---|
TResultCopy to Clipboard |
TErrorCopy to Clipboard |
Parameters
| Name | Type | Description |
|---|---|---|
workCopy to Clipboard | (transactionManagerCopy to Clipboard: EntityManagerCopy to Clipboard) => PromiseCopy to Clipboard<TResultCopy to Clipboard> | the transactional work to be done |
isolationOrErrorHandler?Copy to Clipboard | IsolationLevelCopy to Clipboard | (errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard> | the isolation level to be used for the work. |
maybeErrorHandlerOrDontFail?Copy to Clipboard | (errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard> | Potential error handler |
Returns
PromiseCopy to Clipboard<TResultCopy to Clipboard>
the result of the transactional work
Inherited from
TransactionBaseService.atomicPhase_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:50
create
▸ create(dataCopy to Clipboard): PromiseCopy to Clipboard<LineItemAdjustmentCopy to Clipboard>
Creates a line item adjustment
Parameters
| Name | Type | Description |
|---|---|---|
dataCopy to Clipboard | PartialCopy to Clipboard<LineItemAdjustmentCopy to Clipboard> | the line item adjustment to create |
Returns
PromiseCopy to Clipboard<LineItemAdjustmentCopy to Clipboard>
line item adjustment
Defined in
packages/medusa/src/services/line-item-adjustment.ts:90
createAdjustmentForLineItem
▸ createAdjustmentForLineItem(cartCopy to Clipboard, lineItemCopy to Clipboard): PromiseCopy to Clipboard<LineItemAdjustmentCopy to Clipboard[]>
Creates adjustment for a line item
Parameters
| Name | Type | Description |
|---|---|---|
cartCopy to Clipboard | CartCopy to Clipboard | the cart object holding discounts |
lineItemCopy to Clipboard | LineItemCopy to Clipboard | the line item for which a line item adjustment might be created |
Returns
PromiseCopy to Clipboard<LineItemAdjustmentCopy to Clipboard[]>
a line item adjustment or undefined if no adjustment was created
Defined in
packages/medusa/src/services/line-item-adjustment.ts:263
createAdjustments
▸ createAdjustments(cartCopy to Clipboard, lineItem?Copy to Clipboard): PromiseCopy to Clipboard<LineItemAdjustmentCopy to Clipboard[] | LineItemAdjustmentCopy to Clipboard[][]>
Creates adjustment for a line item
Parameters
| Name | Type | Description |
|---|---|---|
cartCopy to Clipboard | CartCopy to Clipboard | the cart object holding discounts |
lineItem?Copy to Clipboard | LineItemCopy to Clipboard | the line item for which a line item adjustment might be created |
Returns
PromiseCopy to Clipboard<LineItemAdjustmentCopy to Clipboard[] | LineItemAdjustmentCopy to Clipboard[][]>
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
Defined in
packages/medusa/src/services/line-item-adjustment.ts:291
delete
▸ delete(selectorOrIdsCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>
Deletes line item adjustments matching a selector
Parameters
| Name | Type | Description |
|---|---|---|
selectorOrIdsCopy to Clipboard | stringCopy to Clipboard | stringCopy to Clipboard[] | FilterableLineItemAdjustmentPropsCopy to Clipboard & { discount_id?Copy to Clipboard: FindOperatorCopy to Clipboard<nullCopy to Clipboard | stringCopy to Clipboard> } | the query object for find or the line item adjustment id |
Returns
PromiseCopy to Clipboard<voidCopy to Clipboard>
the result of the delete operation
Defined in
packages/medusa/src/services/line-item-adjustment.ts:155
generateAdjustments
▸ generateAdjustments(calculationContextDataCopy to Clipboard, generatedLineItemCopy to Clipboard, contextCopy to Clipboard): PromiseCopy to Clipboard<GeneratedAdjustmentCopy to Clipboard[]>
Creates adjustment for a line item
Parameters
| Name | Type | Description |
|---|---|---|
calculationContextDataCopy to Clipboard | CalculationContextDataCopy to Clipboard | the calculationContextData object holding discounts |
generatedLineItemCopy to Clipboard | LineItemCopy to Clipboard | the line item for which a line item adjustment might be created |
contextCopy to Clipboard | AdjustmentContextCopy to Clipboard | the line item for which a line item adjustment might be created |
Returns
PromiseCopy to Clipboard<GeneratedAdjustmentCopy to Clipboard[]>
a line item adjustment or undefined if no adjustment was created
Defined in
packages/medusa/src/services/line-item-adjustment.ts:189
list
▸ list(selector?Copy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<LineItemAdjustmentCopy to Clipboard[]>
Lists line item adjustments
Parameters
| Name | Type | Description |
|---|---|---|
selectorCopy to Clipboard | FilterableLineItemAdjustmentPropsCopy to Clipboard | the query object for find |
configCopy to Clipboard | FindConfigCopy to Clipboard<LineItemAdjustmentCopy to Clipboard> | the config to be used for find |
Returns
PromiseCopy to Clipboard<LineItemAdjustmentCopy to Clipboard[]>
the result of the find operation
Defined in
packages/medusa/src/services/line-item-adjustment.ts:138
retrieve
▸ retrieve(lineItemAdjustmentIdCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<LineItemAdjustmentCopy to Clipboard>
Retrieves a line item adjustment by id.
Parameters
| Name | Type | Description |
|---|---|---|
lineItemAdjustmentIdCopy to Clipboard | stringCopy to Clipboard | the id of the line item adjustment to retrieve |
configCopy to Clipboard | FindConfigCopy to Clipboard<LineItemAdjustmentCopy to Clipboard> | the config to retrieve the line item adjustment by |
Returns
PromiseCopy to Clipboard<LineItemAdjustmentCopy to Clipboard>
the line item adjustment.
Defined in
packages/medusa/src/services/line-item-adjustment.ts:58
shouldRetryTransaction_
▸ ProtectedCopy to Clipboard shouldRetryTransaction_(errCopy to Clipboard): booleanCopy to Clipboard
Parameters
| Name | Type |
|---|---|
errCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | { codeCopy to Clipboard: stringCopy to Clipboard } |
Returns
booleanCopy to Clipboard
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:31
update
▸ update(idCopy to Clipboard, dataCopy to Clipboard): PromiseCopy to Clipboard<LineItemAdjustmentCopy to Clipboard>
Creates a line item adjustment
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | the line item adjustment id to update |
dataCopy to Clipboard | PartialCopy to Clipboard<LineItemAdjustmentCopy to Clipboard> | the line item adjustment to create |
Returns
PromiseCopy to Clipboard<LineItemAdjustmentCopy to Clipboard>
line item adjustment
Defined in
packages/medusa/src/services/line-item-adjustment.ts:107
withTransaction
▸ withTransaction(transactionManager?Copy to Clipboard): LineItemAdjustmentServiceCopy to Clipboard
Parameters
| Name | Type |
|---|---|
transactionManager?Copy to Clipboard | EntityManagerCopy to Clipboard |
Returns
LineItemAdjustmentServiceCopy to Clipboard
Inherited from
TransactionBaseService.withTransaction
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:14