Skip to main content

Class: NewTotalsService

Hierarchy

  • TransactionBaseService

    NewTotalsService

Constructors

constructor

new NewTotalsService(__namedParameters)

Parameters

NameType
__namedParametersInjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/new-totals.ts:67

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


featureFlagRouter_

Protected Readonly featureFlagRouter_: FlagRouter

Defined in

medusa/src/services/new-totals.ts:64


manager_

Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

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


taxCalculationStrategy_

Protected Readonly taxCalculationStrategy_: ITaxCalculationStrategy

Defined in

medusa/src/services/new-totals.ts:65


taxProviderService_

Protected Readonly taxProviderService_: TaxProviderService

Defined in

medusa/src/services/new-totals.ts:63


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

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.

Type parameters

Name
TResult
TError

Parameters

NameTypeDescription
work(transactionManager: EntityManager) => Promise<TResult>the transactional work to be done
isolationOrErrorHandler?IsolationLevel | (error: TError) => Promise<void | TResult>the isolation level to be used for the work.
maybeErrorHandlerOrDontFail?(error: TError) => Promise<void | TResult>Potential error handler

Returns

Promise<TResult>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

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


getGiftCardTotals

getGiftCardTotals(giftCardableAmount, __namedParameters): Promise<{ tax_total: number ; total: number }>

Calculate and return the gift cards totals

Parameters

NameType
giftCardableAmountnumber
__namedParametersObject
__namedParameters.giftCardTransactions?GiftCardTransaction[]
__namedParameters.giftCards?GiftCard[]
__namedParameters.regionRegion

Returns

Promise<{ tax_total: number ; total: number }>

Defined in

medusa/src/services/new-totals.ts:447


getGiftCardTransactionsTotals

getGiftCardTransactionsTotals(__namedParameters): Object

Calculate and return the gift cards totals based on their transactions

Parameters

NameType
__namedParametersObject
__namedParameters.giftCardTransactionsGiftCardTransaction[]
__namedParameters.regionObject
__namedParameters.region.gift_cards_taxableboolean
__namedParameters.region.tax_ratenumber

Returns

Object

NameType
tax_totalnumber
totalnumber

Defined in

medusa/src/services/new-totals.ts:526


getLineItemRefund

getLineItemRefund(lineItem, __namedParameters): number

Return the amount that can be refund on a line item

Parameters

NameType
lineItemObject
lineItem.idstring
lineItem.includes_taxboolean
lineItem.quantitynumber
lineItem.tax_linesLineItemTaxLine[]
lineItem.unit_pricenumber
__namedParametersObject
__namedParameters.calculationContextTaxCalculationContext
__namedParameters.taxRate?null | number

Returns

number

Defined in

medusa/src/services/new-totals.ts:333


getLineItemRefundLegacy

Protected getLineItemRefundLegacy(lineItem, __namedParameters): number

Parameters

NameType
lineItemObject
lineItem.idstring
lineItem.includes_taxboolean
lineItem.quantitynumber
lineItem.unit_pricenumber
__namedParametersObject
__namedParameters.calculationContextTaxCalculationContext
__namedParameters.taxRatenumber

Returns

number

Defined in

medusa/src/services/new-totals.ts:403


getLineItemTotals

getLineItemTotals(items, __namedParameters): Promise<{ [lineItemId: string]: LineItemTotals; }>

Calculate and return the items totals for either the legacy calculation or the new calculation

Parameters

NameType
itemsLineItem | LineItem[]
__namedParametersObject
__namedParameters.calculationContextTaxCalculationContext
__namedParameters.includeTax?boolean
__namedParameters.taxRate?null | number

Returns

Promise<{ [lineItemId: string]: LineItemTotals; }>

Defined in

medusa/src/services/new-totals.ts:87


getLineItemTotalsLegacy

Protected getLineItemTotalsLegacy(item, __namedParameters): Promise<LineItemTotals>

Calculate and return the legacy calculated totals using the tax rate

Parameters

NameType
itemLineItem
__namedParametersObject
__namedParameters.calculationContextTaxCalculationContext
__namedParameters.lineItemAllocationObject
__namedParameters.lineItemAllocation.discount?DiscountAllocation
__namedParameters.lineItemAllocation.gift_card?GiftCardAllocation
__namedParameters.taxRatenumber

Returns

Promise<LineItemTotals>

Defined in

medusa/src/services/new-totals.ts:254


getLineItemTotals_

Protected getLineItemTotals_(item, __namedParameters): Promise<LineItemTotals>

Calculate and return the totals for an item

Parameters

NameType
itemLineItem
__namedParametersObject
__namedParameters.calculationContextTaxCalculationContext
__namedParameters.includeTax?boolean
__namedParameters.lineItemAllocationObject
__namedParameters.lineItemAllocation.discount?DiscountAllocation
__namedParameters.lineItemAllocation.gift_card?GiftCardAllocation
__namedParameters.taxLines?LineItemTaxLine[]

Returns

Promise<LineItemTotals>

Defined in

medusa/src/services/new-totals.ts:147


getShippingMethodTotals

getShippingMethodTotals(shippingMethods, __namedParameters): Promise<{ [shippingMethodId: string]: ShippingMethodTotals; }>

Calculate and return the shipping methods totals for either the legacy calculation or the new calculation

Parameters

NameType
shippingMethodsShippingMethod | ShippingMethod[]
__namedParametersObject
__namedParameters.calculationContextTaxCalculationContext
__namedParameters.discounts?Discount[]
__namedParameters.includeTax?boolean
__namedParameters.taxRate?null | number

Returns

Promise<{ [shippingMethodId: string]: ShippingMethodTotals; }>

Defined in

medusa/src/services/new-totals.ts:572


getShippingMethodTotalsLegacy

Protected getShippingMethodTotalsLegacy(shippingMethod, __namedParameters): Promise<ShippingMethodTotals>

Calculate and return the shipping method totals legacy using teh tax rate

Parameters

NameType
shippingMethodShippingMethod
__namedParametersObject
__namedParameters.calculationContextTaxCalculationContext
__namedParameters.discounts?Discount[]
__namedParameters.taxRatenumber

Returns

Promise<ShippingMethodTotals>

Defined in

medusa/src/services/new-totals.ts:729


getShippingMethodTotals_

Protected getShippingMethodTotals_(shippingMethod, __namedParameters): Promise<ShippingMethodTotals>

Calculate and return the shipping method totals

Parameters

NameType
shippingMethodShippingMethod
__namedParametersObject
__namedParameters.calculationContextTaxCalculationContext
__namedParameters.discounts?Discount[]
__namedParameters.includeTax?boolean
__namedParameters.taxLines?ShippingMethodTaxLine[]

Returns

Promise<ShippingMethodTotals>

Defined in

medusa/src/services/new-totals.ts:646


shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

NameType
errRecord<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

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


withTransaction

withTransaction(transactionManager?): NewTotalsService

Parameters

NameType
transactionManager?EntityManager

Returns

NewTotalsService

Inherited from

TransactionBaseService.withTransaction

Defined in

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

Was this page helpful?