Class: TaxProviderService
Finds tax providers and assists in tax related operations.
Hierarchy
"medusa-interfaces"↳
TaxProviderService
Constructors
constructor
• new TaxProviderService(container)
Parameters
| Name | Type |
|---|---|
container | AwilixContainer<any> |
Overrides
BaseService.constructor
Defined in
Properties
container_
• Private container_: AwilixContainer<any>
Defined in
manager_
• Private manager_: EntityManager
Defined in
redis_
• Private redis_: Redis
Defined in
smTaxLineRepo_
• Private smTaxLineRepo_: typeof ShippingMethodTaxLineRepository
Defined in
taxLineRepo_
• Private taxLineRepo_: typeof LineItemTaxLineRepository
Defined in
taxProviderRepo_
• Private taxProviderRepo_: typeof TaxProviderRepository
Defined in
taxRateService_
• Private taxRateService_: TaxRateService
Defined in
transactionManager_
• Private transactionManager_: EntityManager
Defined in
Methods
clearTaxLines
▸ clearTaxLines(cartId): Promise<void>
Parameters
| Name | Type |
|---|---|
cartId | string |
Returns
Promise<void>
Defined in
createShippingTaxLines
▸ createShippingTaxLines(shippingMethod, calculationContext): Promise<(ShippingMethodTaxLine | LineItemTaxLine)[]>
Persists the tax lines relevant for a shipping method to the database. Used for return shipping methods.
Parameters
| Name | Type | Description |
|---|---|---|
shippingMethod | ShippingMethod | the shipping method to create tax lines for |
calculationContext | TaxCalculationContext | the calculation context to get tax lines by |
Returns
Promise<(ShippingMethodTaxLine | LineItemTaxLine)[]>
the newly created tax lines
Defined in
createTaxLines
▸ createTaxLines(cartOrLineItems, calculationContext): Promise<(ShippingMethodTaxLine | LineItemTaxLine)[]>
Persists the tax lines relevant for an order to the database.
Parameters
| Name | Type | Description |
|---|---|---|
cartOrLineItems | Cart | LineItem[] | the cart or line items to create tax lines for |
calculationContext | TaxCalculationContext | the calculation context to get tax lines by |
Returns
Promise<(ShippingMethodTaxLine | LineItemTaxLine)[]>
the newly created tax lines
Defined in
getCacheEntry
▸ Private getCacheEntry(productId, regionId): Promise<null | TaxServiceRate[]>
Gets the cache results for a set of ids
Parameters
| Name | Type | Description |
|---|---|---|
productId | string | the product id to cache |
regionId | string | the region id to cache |
Returns
Promise<null | TaxServiceRate[]>
the cached result or null
Defined in
getCacheKey
▸ Private getCacheKey(productId, regionId): string
The cache key to get cache hits by.
Parameters
| Name | Type | Description |
|---|---|---|
productId | string | the product id to cache |
regionId | string | the region id to cache |
Returns
string
the cache key to use for the id set
Defined in
getRegionRatesForProduct
▸ getRegionRatesForProduct(productId, region): Promise<TaxServiceRate[]>
Gets the tax rates configured for a product. The rates are cached between calls.
Parameters
| Name | Type | Description |
|---|---|---|
productId | string | the product id to get rates for |
region | Region | the region to get configured rates for. |
Returns
Promise<TaxServiceRate[]>
the tax rates configured for the shipping option.
Defined in
getRegionRatesForShipping
▸ getRegionRatesForShipping(optionId, region): Promise<TaxServiceRate[]>
Gets the tax rates configured for a shipping option. The rates are cached between calls.
Parameters
| Name | Type | Description |
|---|---|---|
optionId | string | the option id of the shipping method. |
region | Region | the region to get configured rates for. |
Returns
Promise<TaxServiceRate[]>
the tax rates configured for the shipping option.
Defined in
getShippingTaxLines
▸ getShippingTaxLines(shippingMethod, calculationContext): Promise<ShippingMethodTaxLine[]>
Gets the relevant tax lines for a shipping method. Note: this method doesn't persist the tax lines. Use createShippingTaxLines if you wish to persist the tax lines to the DB layer.
Parameters
| Name | Type | Description |
|---|---|---|
shippingMethod | ShippingMethod | the shipping method to get tax lines for |
calculationContext | TaxCalculationContext | the calculation context to get tax lines by |
Returns
Promise<ShippingMethodTaxLine[]>
the computed tax lines
Defined in
getTaxLines
▸ getTaxLines(lineItems, calculationContext): Promise<(ShippingMethodTaxLine | LineItemTaxLine)[]>
Gets the relevant tax lines for an order or cart. If an order is provided the order's tax lines will be returned. If a cart is provided the tax lines will be computed from the tax rules and potentially a 3rd party tax plugin. Note: this method doesn't persist the tax lines. Use createTaxLines if you wish to persist the tax lines to the DB layer.
Parameters
| Name | Type | Description |
|---|---|---|
lineItems | LineItem[] | the cart or order to get tax lines for |
calculationContext | TaxCalculationContext | the calculation context to get tax lines by |
Returns
Promise<(ShippingMethodTaxLine | LineItemTaxLine)[]>
the computed tax lines
Defined in
list
▸ list(): Promise<TaxProvider[]>
Returns
Promise<TaxProvider[]>
Defined in
registerInstalledProviders
▸ registerInstalledProviders(providers): Promise<void>
Parameters
| Name | Type |
|---|---|
providers | string[] |
Returns
Promise<void>
Defined in
retrieveProvider
▸ retrieveProvider(region): ITaxService
Retrieves the relevant tax provider for the given region.
Parameters
| Name | Type | Description |
|---|---|---|
region | Region | the region to get tax provider for. |
Returns
ITaxService
the region specific tax provider
Defined in
setCache
▸ Private setCache(productId, regionId, value): Promise<void>
Sets the cache results for a set of ids
Parameters
| Name | Type | Description |
|---|---|---|
productId | string | the product id to cache |
regionId | string | the region id to cache |
value | TaxServiceRate[] | tax rates to cache |
Returns
Promise<void>
promise that resolves after the cache has been set
Defined in
withTransaction
▸ withTransaction(transactionManager): TaxProviderService
Parameters
| Name | Type |
|---|---|
transactionManager | EntityManager |