Class: NewTotalsService
Hierarchy
TransactionBaseService
↳
NewTotalsService
Constructors
constructor
• new NewTotalsService(__namedParameters
)
Parameters
Name | Type |
---|---|
__namedParameters | InjectedDependencies |
Overrides
TransactionBaseService.constructor
Defined in
packages/medusa/src/services/new-totals.ts:68
Properties
__configModule__
• Protected
Optional
Readonly
__configModule__: Record
<string
, unknown
>
Inherited from
TransactionBaseService.__configModule__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:10
__container__
• Protected
Readonly
__container__: any
Inherited from
TransactionBaseService.__container__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:9
__moduleDeclaration__
• Protected
Optional
Readonly
__moduleDeclaration__: Record
<string
, unknown
>
Inherited from
TransactionBaseService.__moduleDeclaration__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:11
featureFlagRouter_
• Protected
Readonly
featureFlagRouter_: FlagRouter
Defined in
packages/medusa/src/services/new-totals.ts:65
manager_
• Protected
Readonly
manager_: EntityManager
Overrides
TransactionBaseService.manager_
Defined in
packages/medusa/src/services/new-totals.ts:61
taxCalculationStrategy_
• Protected
Readonly
taxCalculationStrategy_: ITaxCalculationStrategy
Defined in
packages/medusa/src/services/new-totals.ts:66
taxProviderService_
• Protected
Readonly
taxProviderService_: TaxProviderService
Defined in
packages/medusa/src/services/new-totals.ts:64
transactionManager_
• Protected
Readonly
transactionManager_: undefined
| EntityManager
Overrides
TransactionBaseService.transactionManager_
Defined in
packages/medusa/src/services/new-totals.ts:62
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
Name | Type | Description |
---|---|---|
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
packages/medusa/src/interfaces/transaction-base-service.ts:50
getGiftCardTotals
▸ getGiftCardTotals(giftCardableAmount
, __namedParameters
): Promise
<{ tax_total
: number
; total
: number
}>
Calculate and return the gift cards totals
Parameters
Name | Type |
---|---|
giftCardableAmount | number |
__namedParameters | Object |
__namedParameters.giftCardTransactions? | GiftCardTransaction [] |
__namedParameters.giftCards? | GiftCard [] |
__namedParameters.region | Region |
Returns
Promise
<{ tax_total
: number
; total
: number
}>
Defined in
packages/medusa/src/services/new-totals.ts:445
getGiftCardTransactionsTotals
▸ getGiftCardTransactionsTotals(__namedParameters
): Object
Calculate and return the gift cards totals based on their transactions
Parameters
Name | Type |
---|---|
__namedParameters | Object |
__namedParameters.giftCardTransactions | GiftCardTransaction [] |
__namedParameters.region | Object |
__namedParameters.region.gift_cards_taxable | boolean |
__namedParameters.region.tax_rate | number |
Returns
Object
Name | Type |
---|---|
tax_total | number |
total | number |
Defined in
packages/medusa/src/services/new-totals.ts:524
getLineItemRefund
▸ getLineItemRefund(lineItem
, __namedParameters
): number
Return the amount that can be refund on a line item
Parameters
Name | Type |
---|---|
lineItem | Object |
lineItem.id | string |
lineItem.includes_tax | boolean |
lineItem.quantity | number |
lineItem.tax_lines | LineItemTaxLine [] |
lineItem.unit_price | number |
__namedParameters | Object |
__namedParameters.calculationContext | TaxCalculationContext |
__namedParameters.taxRate? | null | number |
Returns
number
Defined in
packages/medusa/src/services/new-totals.ts:331
getLineItemRefundLegacy
▸ Protected
getLineItemRefundLegacy(lineItem
, __namedParameters
): number
Parameters
Name | Type |
---|---|
lineItem | Object |
lineItem.id | string |
lineItem.includes_tax | boolean |
lineItem.quantity | number |
lineItem.unit_price | number |
__namedParameters | Object |
__namedParameters.calculationContext | TaxCalculationContext |
__namedParameters.taxRate | number |
Returns
number
Defined in
packages/medusa/src/services/new-totals.ts:401
getLineItemTotals
▸ getLineItemTotals(items
, __namedParameters
): Promise
<{ [lineItemId: string]
: LineItemTotals
; }>
Calculate and return the items totals for either the legacy calculation or the new calculation
Parameters
Name | Type |
---|---|
items | LineItem | LineItem [] |
__namedParameters | Object |
__namedParameters.calculationContext | TaxCalculationContext |
__namedParameters.includeTax? | boolean |
__namedParameters.taxRate? | null | number |
Returns
Promise
<{ [lineItemId: string]
: LineItemTotals
; }>
Defined in
packages/medusa/src/services/new-totals.ts:90
getLineItemTotalsLegacy
▸ Protected
getLineItemTotalsLegacy(item
, __namedParameters
): Promise
<LineItemTotals
>
Calculate and return the legacy calculated totals using the tax rate
Parameters
Name | Type |
---|---|
item | LineItem |
__namedParameters | Object |
__namedParameters.calculationContext | TaxCalculationContext |
__namedParameters.lineItemAllocation | Object |
__namedParameters.lineItemAllocation.discount? | DiscountAllocation |
__namedParameters.lineItemAllocation.gift_card? | GiftCardAllocation |
__namedParameters.taxRate | number |
Returns
Promise
<LineItemTotals
>
Defined in
packages/medusa/src/services/new-totals.ts:255
getLineItemTotals_
▸ Protected
getLineItemTotals_(item
, __namedParameters
): Promise
<LineItemTotals
>
Calculate and return the totals for an item
Parameters
Name | Type |
---|---|
item | LineItem |
__namedParameters | Object |
__namedParameters.calculationContext | TaxCalculationContext |
__namedParameters.includeTax? | boolean |
__namedParameters.lineItemAllocation | Object |
__namedParameters.lineItemAllocation.discount? | DiscountAllocation |
__namedParameters.lineItemAllocation.gift_card? | GiftCardAllocation |
__namedParameters.taxLines? | LineItemTaxLine [] |
Returns
Promise
<LineItemTotals
>
Defined in
packages/medusa/src/services/new-totals.ts:151
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
Name | Type |
---|---|
shippingMethods | ShippingMethod | ShippingMethod [] |
__namedParameters | Object |
__namedParameters.calculationContext | TaxCalculationContext |
__namedParameters.discounts? | Discount [] |
__namedParameters.includeTax? | boolean |
__namedParameters.taxRate? | null | number |
Returns
Promise
<{ [shippingMethodId: string]
: ShippingMethodTotals
; }>
Defined in
packages/medusa/src/services/new-totals.ts:570
getShippingMethodTotalsLegacy
▸ Protected
getShippingMethodTotalsLegacy(shippingMethod
, __namedParameters
): Promise
<ShippingMethodTotals
>
Calculate and return the shipping method totals legacy using teh tax rate
Parameters
Name | Type |
---|---|
shippingMethod | ShippingMethod |
__namedParameters | Object |
__namedParameters.calculationContext | TaxCalculationContext |
__namedParameters.discounts? | Discount [] |
__namedParameters.taxRate | number |
Returns
Promise
<ShippingMethodTotals
>
Defined in
packages/medusa/src/services/new-totals.ts:728
getShippingMethodTotals_
▸ Protected
getShippingMethodTotals_(shippingMethod
, __namedParameters
): Promise
<ShippingMethodTotals
>
Calculate and return the shipping method totals
Parameters
Name | Type |
---|---|
shippingMethod | ShippingMethod |
__namedParameters | Object |
__namedParameters.calculationContext | TaxCalculationContext |
__namedParameters.discounts? | Discount [] |
__namedParameters.includeTax? | boolean |
__namedParameters.taxLines? | ShippingMethodTaxLine [] |
Returns
Promise
<ShippingMethodTotals
>
Defined in
packages/medusa/src/services/new-totals.ts:645
shouldRetryTransaction_
▸ Protected
shouldRetryTransaction_(err
): boolean
Parameters
Name | Type |
---|---|
err | Record <string , unknown > | { code : string } |
Returns
boolean
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:31
withTransaction
▸ withTransaction(transactionManager?
): NewTotalsService
Parameters
Name | Type |
---|---|
transactionManager? | EntityManager |
Returns
Inherited from
TransactionBaseService.withTransaction
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:14