TaxRateService

Hierarchy

• TransactionBaseService

  ↳ TaxRateService

Constructors

constructor

new TaxRateService(«destructured»)

Parameters

Name
«destructured»

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/tax-rate.ts:29

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

---

manager_

Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

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

---

productService_

Protected Readonly productService_: ProductService

Defined in

medusa/src/services/tax-rate.ts:24

---

productTypeService_

Protected Readonly productTypeService_: ProductTypeService

Defined in

medusa/src/services/tax-rate.ts:25

---

shippingOptionService_

Protected Readonly shippingOptionService_: ShippingOptionService

Defined in

medusa/src/services/tax-rate.ts:26

---

taxRateRepository_

Protected Readonly taxRateRepository_: Repository<TaxRate> & { addToProduct: Method addToProduct ; addToProductType: Method addToProductType ; addToShippingOption: Method addToShippingOption ; applyResolutionsToQueryBuilder: Method applyResolutionsToQueryBuilder ; findAndCountWithResolution: Method findAndCountWithResolution ; findOneWithResolution: Method findOneWithResolution ; findWithResolution: Method findWithResolution ; getFindQueryBuilder: Method getFindQueryBuilder ; listByProduct: Method listByProduct ; listByShippingOption: Method listByShippingOption ; removeFromProduct: Method removeFromProduct ; removeFromProductType: Method removeFromProductType ; removeFromShippingOption: Method removeFromShippingOption }

Defined in

medusa/src/services/tax-rate.ts:27

---

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

-EntityManager:

Inherited from

TransactionBaseService.activeManager_

Defined in

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

Methods

addToProduct

addToProduct(id, productIds, replace?): Promise<ProductTaxRate | ProductTaxRate[]>

Parameters

Name	Default value
id	string
productIds	string | string[]
replace	boolean

Returns

Promise<ProductTaxRate | ProductTaxRate[]>

-Promise: -ProductTaxRate \| ProductTaxRate[]: (optional)

Defined in

medusa/src/services/tax-rate.ts:190

---

addToProductType

addToProductType(id, productTypeIds, replace?): Promise<ProductTypeTaxRate[]>

Parameters

Name	Default value
id	string
productTypeIds	string | string[]
replace	boolean

Returns

Promise<ProductTypeTaxRate[]>

-Promise: -ProductTypeTaxRate[]: -ProductTypeTaxRate:

Defined in

medusa/src/services/tax-rate.ts:226

---

addToShippingOption

addToShippingOption(id, optionIds, replace?): Promise<ShippingTaxRate[]>

Parameters

Name	Default value
id	string
optionIds	string | string[]
replace	boolean

Returns

Promise<ShippingTaxRate[]>

-Promise: -ShippingTaxRate[]: -ShippingTaxRate:

Defined in

medusa/src/services/tax-rate.ts:266

---

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.

Name
TResult
TError

Parameters

Name	Description
work	(transactionManager: EntityManager) => Promise<TResult>
isolationOrErrorHandler?	IsolationLevel | (error: TError) => Promise<void | TResult>
maybeErrorHandlerOrDontFail?	(error: TError) => Promise<void | TResult>

Returns

Promise<TResult>

-Promise: the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

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

---

create

create(data): Promise<TaxRate>

Parameters

Name
data

Returns

Promise<TaxRate>

-Promise: -TaxRate:

Defined in

medusa/src/services/tax-rate.ts:93

---

delete

delete(id): Promise<void>

Parameters

Name
id

Returns

Promise<void>

-Promise:

Defined in

medusa/src/services/tax-rate.ts:124

---

list

list(selector, config?): Promise<TaxRate[]>

Parameters

Name
selector
config

Returns

Promise<TaxRate[]>

-Promise: -TaxRate[]: -TaxRate:

Defined in

medusa/src/services/tax-rate.ts:44

---

listAndCount

listAndCount(selector, config?): Promise<[TaxRate[], number]>

Parameters

Name
selector
config

Returns

Promise<[TaxRate[], number]>

-Promise: -TaxRate[]: -number: (optional)

Defined in

medusa/src/services/tax-rate.ts:55

---

listByProduct

listByProduct(productId, config): Promise<TaxRate[]>

Parameters

Name
productId
config

Returns

Promise<TaxRate[]>

-Promise: -TaxRate[]: -TaxRate:

Defined in

medusa/src/services/tax-rate.ts:314

---

listByShippingOption

listByShippingOption(shippingOptionId): Promise<TaxRate[]>

Parameters

Name
shippingOptionId

Returns

Promise<TaxRate[]>

-Promise: -TaxRate[]: -TaxRate:

Defined in

medusa/src/services/tax-rate.ts:325

---

removeFromProduct

removeFromProduct(id, productIds): Promise<void>

Parameters

Name
id
productIds

Returns

Promise<void>

-Promise:

Defined in

medusa/src/services/tax-rate.ts:136

---

removeFromProductType

removeFromProductType(id, typeIds): Promise<void>

Parameters

Name
id
typeIds

Returns

Promise<void>

-Promise:

Defined in

medusa/src/services/tax-rate.ts:154

---

removeFromShippingOption

removeFromShippingOption(id, optionIds): Promise<void>

Parameters

Name
id
optionIds

Returns

Promise<void>

-Promise:

Defined in

medusa/src/services/tax-rate.ts:172

---

retrieve

retrieve(taxRateId, config?): Promise<TaxRate>

Parameters

Name
taxRateId
config

Returns

Promise<TaxRate>

-Promise: -TaxRate:

Defined in

medusa/src/services/tax-rate.ts:66

---

shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

Name
err

Returns

boolean

-boolean: (optional)

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

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

---

update

update(id, data): Promise<TaxRate>

Parameters

Name
id
data

Returns

Promise<TaxRate>

-Promise: -TaxRate:

Defined in

medusa/src/services/tax-rate.ts:109

---

withTransaction

withTransaction(transactionManager?): TaxRateService

Parameters

Name
transactionManager?

Returns

TaxRateService

-TaxRateService:

Inherited from

TransactionBaseService.withTransaction

Defined in

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