Skip to main content

Class: TaxRateService

Hierarchy​

  • TransactionBaseServiceCopy to Clipboard

    ↳ TaxRateServiceCopy to Clipboard

Constructors​

constructor​

• new TaxRateService(__namedParametersCopy to Clipboard)

Parameters​

NameType
__namedParametersCopy to ClipboardObjectCopy to Clipboard

Overrides​

TransactionBaseService.constructor

Defined in​

packages/medusa/src/services/tax-rate.ts:33

Properties​

__configModule__​

• ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __configModule__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>

Inherited from​

TransactionBaseService.__configModule__

Defined in​

packages/medusa/src/interfaces/transaction-base-service.ts:10

__container__​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard __container__: anyCopy to Clipboard

Inherited from​

TransactionBaseService.__container__

Defined in​

packages/medusa/src/interfaces/transaction-base-service.ts:9

__moduleDeclaration__​

• ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __moduleDeclaration__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>

Inherited from​

TransactionBaseService.__moduleDeclaration__

Defined in​

packages/medusa/src/interfaces/transaction-base-service.ts:11

manager_​

• ProtectedCopy to Clipboard manager_: EntityManagerCopy to Clipboard

Overrides​

TransactionBaseService.manager_

Defined in​

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

productService_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard productService_: ProductServiceCopy to Clipboard

Defined in​

packages/medusa/src/services/tax-rate.ts:28

productTypeService_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard productTypeService_: ProductTypeServiceCopy to Clipboard

Defined in​

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

shippingOptionService_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard shippingOptionService_: ShippingOptionServiceCopy to Clipboard

Defined in​

packages/medusa/src/services/tax-rate.ts:30

taxRateRepository_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard taxRateRepository_: typeof TaxRateRepositoryCopy to Clipboard

Defined in​

packages/medusa/src/services/tax-rate.ts:31

transactionManager_​

• ProtectedCopy to Clipboard transactionManager_: undefinedCopy to Clipboard | EntityManagerCopy to Clipboard

Overrides​

TransactionBaseService.transactionManager_

Defined in​

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

Methods​

addToProduct​

▸ addToProduct(idCopy to Clipboard, productIdsCopy to Clipboard, replace?Copy to Clipboard): PromiseCopy to Clipboard<ProductTaxRateCopy to Clipboard | ProductTaxRateCopy to Clipboard[]>

Parameters​

NameTypeDefault value
idCopy to ClipboardstringCopy to ClipboardundefinedCopy to Clipboard
productIdsCopy to ClipboardstringCopy to Clipboard | stringCopy to Clipboard[]undefinedCopy to Clipboard
replaceCopy to ClipboardbooleanCopy to ClipboardfalseCopy to Clipboard

Returns​

PromiseCopy to Clipboard<ProductTaxRateCopy to Clipboard | ProductTaxRateCopy to Clipboard[]>

Defined in​

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

addToProductType​

▸ addToProductType(idCopy to Clipboard, productTypeIdsCopy to Clipboard, replace?Copy to Clipboard): PromiseCopy to Clipboard<ProductTypeTaxRateCopy to Clipboard[]>

Parameters​

NameTypeDefault value
idCopy to ClipboardstringCopy to ClipboardundefinedCopy to Clipboard
productTypeIdsCopy to ClipboardstringCopy to Clipboard | stringCopy to Clipboard[]undefinedCopy to Clipboard
replaceCopy to ClipboardbooleanCopy to ClipboardfalseCopy to Clipboard

Returns​

PromiseCopy to Clipboard<ProductTypeTaxRateCopy to Clipboard[]>

Defined in​

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

addToShippingOption​

▸ addToShippingOption(idCopy to Clipboard, optionIdsCopy to Clipboard, replace?Copy to Clipboard): PromiseCopy to Clipboard<ShippingTaxRateCopy to Clipboard[]>

Parameters​

NameTypeDefault value
idCopy to ClipboardstringCopy to ClipboardundefinedCopy to Clipboard
optionIdsCopy to ClipboardstringCopy to Clipboard | stringCopy to Clipboard[]undefinedCopy to Clipboard
replaceCopy to ClipboardbooleanCopy to ClipboardfalseCopy to Clipboard

Returns​

PromiseCopy to Clipboard<ShippingTaxRateCopy to Clipboard[]>

Defined in​

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

atomicPhase_​

▸ ProtectedCopy to Clipboard atomicPhase_<TResultCopy to Clipboard, TErrorCopy to Clipboard>(workCopy to Clipboard, isolationOrErrorHandler?Copy to Clipboard, maybeErrorHandlerOrDontFail?Copy to Clipboard): PromiseCopy to Clipboard<TResultCopy to Clipboard>

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
TResultCopy to Clipboard
TErrorCopy to Clipboard

Parameters​

NameTypeDescription
workCopy to Clipboard(transactionManagerCopy to Clipboard: EntityManagerCopy to Clipboard) => PromiseCopy to Clipboard<TResultCopy to Clipboard>the transactional work to be done
isolationOrErrorHandler?Copy to ClipboardIsolationLevelCopy to Clipboard | (errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard>the isolation level to be used for the work.
maybeErrorHandlerOrDontFail?Copy to Clipboard(errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard>Potential error handler

Returns​

PromiseCopy to Clipboard<TResultCopy to Clipboard>

the result of the transactional work

Inherited from​

TransactionBaseService.atomicPhase_

Defined in​

packages/medusa/src/interfaces/transaction-base-service.ts:50

create​

▸ create(dataCopy to Clipboard): PromiseCopy to Clipboard<TaxRateCopy to Clipboard>

Parameters​

NameType
dataCopy to ClipboardCreateTaxRateInputCopy to Clipboard

Returns​

PromiseCopy to Clipboard<TaxRateCopy to Clipboard>

Defined in​

packages/medusa/src/services/tax-rate.ts:97

delete​

▸ delete(idCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>

Parameters​

NameType
idCopy to ClipboardstringCopy to Clipboard | stringCopy to Clipboard[]

Returns​

PromiseCopy to Clipboard<voidCopy to Clipboard>

Defined in​

packages/medusa/src/services/tax-rate.ts:128

list​

▸ list(selectorCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<TaxRateCopy to Clipboard[]>

Parameters​

NameType
selectorCopy to ClipboardFilterableTaxRatePropsCopy to Clipboard
configCopy to ClipboardFindConfigCopy to Clipboard<TaxRateCopy to Clipboard>

Returns​

PromiseCopy to Clipboard<TaxRateCopy to Clipboard[]>

Defined in​

packages/medusa/src/services/tax-rate.ts:49

listAndCount​

▸ listAndCount(selectorCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<[TaxRateCopy to Clipboard[], numberCopy to Clipboard]>

Parameters​

NameType
selectorCopy to ClipboardFilterableTaxRatePropsCopy to Clipboard
configCopy to ClipboardFindConfigCopy to Clipboard<TaxRateCopy to Clipboard>

Returns​

PromiseCopy to Clipboard<[TaxRateCopy to Clipboard[], numberCopy to Clipboard]>

Defined in​

packages/medusa/src/services/tax-rate.ts:60

listByProduct​

▸ listByProduct(productIdCopy to Clipboard, configCopy to Clipboard): PromiseCopy to Clipboard<TaxRateCopy to Clipboard[]>

Parameters​

NameType
productIdCopy to ClipboardstringCopy to Clipboard
configCopy to ClipboardTaxRateListByConfigCopy to Clipboard

Returns​

PromiseCopy to Clipboard<TaxRateCopy to Clipboard[]>

Defined in​

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

listByShippingOption​

▸ listByShippingOption(shippingOptionIdCopy to Clipboard): PromiseCopy to Clipboard<TaxRateCopy to Clipboard[]>

Parameters​

NameType
shippingOptionIdCopy to ClipboardstringCopy to Clipboard

Returns​

PromiseCopy to Clipboard<TaxRateCopy to Clipboard[]>

Defined in​

packages/medusa/src/services/tax-rate.ts:324

removeFromProduct​

▸ removeFromProduct(idCopy to Clipboard, productIdsCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>

Parameters​

NameType
idCopy to ClipboardstringCopy to Clipboard
productIdsCopy to ClipboardstringCopy to Clipboard | stringCopy to Clipboard[]

Returns​

PromiseCopy to Clipboard<voidCopy to Clipboard>

Defined in​

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

removeFromProductType​

▸ removeFromProductType(idCopy to Clipboard, typeIdsCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>

Parameters​

NameType
idCopy to ClipboardstringCopy to Clipboard
typeIdsCopy to ClipboardstringCopy to Clipboard | stringCopy to Clipboard[]

Returns​

PromiseCopy to Clipboard<voidCopy to Clipboard>

Defined in​

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

removeFromShippingOption​

▸ removeFromShippingOption(idCopy to Clipboard, optionIdsCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>

Parameters​

NameType
idCopy to ClipboardstringCopy to Clipboard
optionIdsCopy to ClipboardstringCopy to Clipboard | stringCopy to Clipboard[]

Returns​

PromiseCopy to Clipboard<voidCopy to Clipboard>

Defined in​

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

retrieve​

▸ retrieve(taxRateIdCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<TaxRateCopy to Clipboard>

Parameters​

NameType
taxRateIdCopy to ClipboardstringCopy to Clipboard
configCopy to ClipboardFindConfigCopy to Clipboard<TaxRateCopy to Clipboard>

Returns​

PromiseCopy to Clipboard<TaxRateCopy to Clipboard>

Defined in​

packages/medusa/src/services/tax-rate.ts:71

shouldRetryTransaction_​

▸ ProtectedCopy to Clipboard shouldRetryTransaction_(errCopy to Clipboard): booleanCopy to Clipboard

Parameters​

NameType
errCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | { codeCopy to Clipboard: stringCopy to Clipboard }

Returns​

booleanCopy to Clipboard

Inherited from​

TransactionBaseService.shouldRetryTransaction_

Defined in​

packages/medusa/src/interfaces/transaction-base-service.ts:31

update​

▸ update(idCopy to Clipboard, dataCopy to Clipboard): PromiseCopy to Clipboard<TaxRateCopy to Clipboard>

Parameters​

NameType
idCopy to ClipboardstringCopy to Clipboard
dataCopy to ClipboardUpdateTaxRateInputCopy to Clipboard

Returns​

PromiseCopy to Clipboard<TaxRateCopy to Clipboard>

Defined in​

packages/medusa/src/services/tax-rate.ts:113

withTransaction​

▸ withTransaction(transactionManager?Copy to Clipboard): TaxRateServiceCopy to Clipboard

Parameters​

NameType
transactionManager?Copy to ClipboardEntityManagerCopy to Clipboard

Returns​

TaxRateServiceCopy to Clipboard

Inherited from​

TransactionBaseService.withTransaction

Defined in​

packages/medusa/src/interfaces/transaction-base-service.ts:14