medusa-store/docs/content/references/services/classes/TaxProviderService.md

Class: TaxProviderService

Hierarchy

• "medusa-interfaces"

  ↳ TaxProviderService

Constructors

constructor

• new TaxProviderService(container)

Parameters

Name	Type
container	AwilixContainer<any>

Overrides

BaseService.constructor

Defined in

services/tax-provider.ts:49

Properties

container_

• Private container_: AwilixContainer<any>

Defined in

services/tax-provider.ts:40

---

manager_

• Private manager_: EntityManager

Defined in

services/tax-provider.ts:41

---

redis_

• Private redis_: Redis

Defined in

services/tax-provider.ts:47

---

smTaxLineRepo_

• Private smTaxLineRepo_: typeof ShippingMethodTaxLineRepository

Defined in

services/tax-provider.ts:45

---

taxLineRepo_

• Private taxLineRepo_: typeof LineItemTaxLineRepository

Defined in

services/tax-provider.ts:44

---

taxProviderRepo_

• Private taxProviderRepo_: typeof TaxProviderRepository

Defined in

services/tax-provider.ts:46

---

taxRateService_

• Private taxRateService_: TaxRateService

Defined in

services/tax-provider.ts:43

---

transactionManager_

• Private transactionManager_: EntityManager

Defined in

services/tax-provider.ts:42

Methods

clearTaxLines

▸ clearTaxLines(cartId): Promise<void>

Parameters

Name	Type
cartId	string

Returns

Promise<void>

Defined in

services/tax-provider.ts:103

---

createShippingTaxLines

▸ createShippingTaxLines(shippingMethod, calculationContext): Promise<(LineItemTaxLine | ShippingMethodTaxLine)[]>

Parameters

Name	Type	Description
shippingMethod	ShippingMethod
calculationContext	TaxCalculationContext

Returns

Promise<(LineItemTaxLine | ShippingMethodTaxLine)[]>

Defined in

services/tax-provider.ts:171

---

createTaxLines

▸ createTaxLines(cartOrLineItems, calculationContext): Promise<(LineItemTaxLine | ShippingMethodTaxLine)[]>

Parameters

Name	Type	Description
cartOrLineItems	Cart | LineItem[]
calculationContext	TaxCalculationContext

Returns

Promise<(LineItemTaxLine | ShippingMethodTaxLine)[]>

Defined in

services/tax-provider.ts:121

---

getCacheEntry

▸ Private getCacheEntry(productId, regionId): Promise<null | TaxServiceRate[]>

Parameters

Name	Type	Description
productId	string
regionId	string

Returns

Promise<null | TaxServiceRate[]>

Defined in

services/tax-provider.ts:454

---

getCacheKey

▸ Private getCacheKey(productId, regionId): string

Parameters

Name	Type	Description
productId	string
regionId	string

Returns

string

Defined in

services/tax-provider.ts:423

---

getRegionRatesForProduct

▸ getRegionRatesForProduct(productId, region): Promise<TaxServiceRate[]>

Parameters

Name	Type	Description
productId	string
region	RegionDetails

Returns

Promise<TaxServiceRate[]>

Defined in

services/tax-provider.ts:378

---

getRegionRatesForShipping

▸ getRegionRatesForShipping(optionId, regionDetails): Promise<TaxServiceRate[]>

Parameters

Name	Type	Description
optionId	string
regionDetails	RegionDetails

Returns

Promise<TaxServiceRate[]>

Defined in

services/tax-provider.ts:332

---

getShippingTaxLines

▸ getShippingTaxLines(shippingMethod, calculationContext): Promise<ShippingMethodTaxLine[]>

Parameters

Name	Type	Description
shippingMethod	ShippingMethod
calculationContext	TaxCalculationContext

Returns

Promise<ShippingMethodTaxLine[]>

Defined in

services/tax-provider.ts:190

---

getTaxLines

▸ getTaxLines(lineItems, calculationContext): Promise<(LineItemTaxLine | ShippingMethodTaxLine)[]>

Parameters

Name	Type	Description
lineItems	LineItem[]
calculationContext	TaxCalculationContext

Returns

Promise<(LineItemTaxLine | ShippingMethodTaxLine)[]>

Defined in

services/tax-provider.ts:242

---

list

▸ list(): Promise<TaxProvider[]>

Returns

Promise<TaxProvider[]>

Defined in

services/tax-provider.ts:75

---

registerInstalledProviders

▸ registerInstalledProviders(providers): Promise<void>

Parameters

Name	Type
providers	string[]

Returns

Promise<void>

Defined in

services/tax-provider.ts:475

---

retrieveProvider

▸ retrieveProvider(region): ITaxService

Parameters

Name	Type	Description
region	Region

Returns

ITaxService

Defined in

services/tax-provider.ts:85

---

setCache

▸ Private setCache(productId, regionId, value): Promise<void>

Parameters

Name	Type	Description
productId	string
regionId	string
value	TaxServiceRate[]

Returns

Promise<void>

Defined in

services/tax-provider.ts:434

---

withTransaction

▸ withTransaction(transactionManager): TaxProviderService

Parameters

Name	Type
transactionManager	EntityManager

Returns

TaxProviderService

Defined in

services/tax-provider.ts:62