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

Class: TaxRateService

Hierarchy

• TransactionBaseService

  ↳ TaxRateService

Constructors

constructor

• new TaxRateService(__namedParameters)

Parameters

Name	Type
__namedParameters	Object

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: (id: string, productIds: string[], overrideExisting: boolean) => Promise<ProductTaxRate[]> ; addToProductType: (id: string, productTypeIds: string[], overrideExisting: boolean) => Promise<ProductTypeTaxRate[]> ; addToShippingOption: (id: string, optionIds: string[], overrideExisting: boolean) => Promise<ShippingTaxRate[]> ; applyResolutionsToQueryBuilder: (qb: SelectQueryBuilder<TaxRate>, resolverFields: string[]) => SelectQueryBuilder<TaxRate> ; findAndCountWithResolution: (findOptions: FindManyOptions<TaxRate>) => Promise<[TaxRate[], number]> ; findOneWithResolution: (findOptions: FindManyOptions<TaxRate>) => Promise<null | TaxRate> ; findWithResolution: (findOptions: FindManyOptions<TaxRate>) => Promise<TaxRate[]> ; getFindQueryBuilder: (findOptions: FindManyOptions<TaxRate>) => SelectQueryBuilder<TaxRate> ; listByProduct: (productId: string, config: TaxRateListByConfig) => Promise<TaxRate[]> ; listByShippingOption: (optionId: string) => Promise<TaxRate[]> ; removeFromProduct: (id: string, productIds: string[]) => Promise<DeleteResult> ; removeFromProductType: (id: string, productTypeIds: string[]) => Promise<DeleteResult> ; removeFromShippingOption: (id: string, optionIds: string[]) => Promise<DeleteResult> }

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

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	Type	Default value
id	string	undefined
productIds	string | string[]	undefined
replace	boolean	false

Returns

Promise<ProductTaxRate | ProductTaxRate[]>

Defined in

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

---

addToProductType

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

Parameters

Name	Type	Default value
id	string	undefined
productTypeIds	string | string[]	undefined
replace	boolean	false

Returns

Promise<ProductTypeTaxRate[]>

Defined in

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

---

addToShippingOption

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

Parameters

Name	Type	Default value
id	string	undefined
optionIds	string | string[]	undefined
replace	boolean	false

Returns

Promise<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.

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

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

---

create

▸ create(data): Promise<TaxRate>

Parameters

Name	Type
data	CreateTaxRateInput

Returns

Promise<TaxRate>

Defined in

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

---

delete

▸ delete(id): Promise<void>

Parameters

Name	Type
id	string | string[]

Returns

Promise<void>

Defined in

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

---

list

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

Parameters

Name	Type
selector	FilterableTaxRateProps
config	FindConfig<TaxRate>

Returns

Promise<TaxRate[]>

Defined in

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

---

listAndCount

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

Parameters

Name	Type
selector	FilterableTaxRateProps
config	FindConfig<TaxRate>

Returns

Promise<[TaxRate[], number]>

Defined in

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

---

listByProduct

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

Parameters

Name	Type
productId	string
config	TaxRateListByConfig

Returns

Promise<TaxRate[]>

Defined in

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

---

listByShippingOption

▸ listByShippingOption(shippingOptionId): Promise<TaxRate[]>

Parameters

Name	Type
shippingOptionId	string

Returns

Promise<TaxRate[]>

Defined in

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

---

removeFromProduct

▸ removeFromProduct(id, productIds): Promise<void>

Parameters

Name	Type
id	string
productIds	string | string[]

Returns

Promise<void>

Defined in

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

---

removeFromProductType

▸ removeFromProductType(id, typeIds): Promise<void>

Parameters

Name	Type
id	string
typeIds	string | string[]

Returns

Promise<void>

Defined in

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

---

removeFromShippingOption

▸ removeFromShippingOption(id, optionIds): Promise<void>

Parameters

Name	Type
id	string
optionIds	string | string[]

Returns

Promise<void>

Defined in

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

---

retrieve

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

Parameters

Name	Type
taxRateId	string
config	FindConfig<TaxRate>

Returns

Promise<TaxRate>

Defined in

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

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name	Type
err	Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

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

---

update

▸ update(id, data): Promise<TaxRate>

Parameters

Name	Type
id	string
data	UpdateTaxRateInput

Returns

Promise<TaxRate>

Defined in

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

---

withTransaction

▸ withTransaction(transactionManager?): TaxRateService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

TaxRateService

Inherited from

TransactionBaseService.withTransaction

Defined in

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