02d5c1da88
* generated new services reference * changed from automatic push to automated pull request * updated typedoc, regenerated JS Client reference * regenerated the reference after updating typedoc * added action for js client
8.0 KiB
Class: TaxRateService
Hierarchy
-
"medusa-interfaces"↳
TaxRateService
Constructors
constructor
• new TaxRateService(__namedParameters)
Parameters
| Name | Type |
|---|---|
__namedParameters |
Object |
Overrides
BaseService.constructor
Defined in
packages/medusa/src/services/tax-rate.ts:27
Properties
manager_
• Private manager_: EntityManager
Defined in
packages/medusa/src/services/tax-rate.ts:21
productService_
• Private productService_: ProductService
Defined in
packages/medusa/src/services/tax-rate.ts:22
productTypeService_
• Private productTypeService_: ProductTypeService
Defined in
packages/medusa/src/services/tax-rate.ts:23
shippingOptionService_
• Private shippingOptionService_: ShippingOptionService
Defined in
packages/medusa/src/services/tax-rate.ts:24
taxRateRepository_
• Private taxRateRepository_: typeof TaxRateRepository
Defined in
packages/medusa/src/services/tax-rate.ts:25
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
packages/medusa/src/services/tax-rate.ts:196
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
packages/medusa/src/services/tax-rate.ts:232
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
packages/medusa/src/services/tax-rate.ts:272
create
▸ create(data): Promise<TaxRate>
Parameters
| Name | Type |
|---|---|
data |
CreateTaxRateInput |
Returns
Promise<TaxRate>
Defined in
packages/medusa/src/services/tax-rate.ts:103
delete
▸ delete(id): Promise<void>
Parameters
| Name | Type |
|---|---|
id |
string | string[] |
Returns
Promise<void>
Defined in
packages/medusa/src/services/tax-rate.ts:134
list
▸ list(selector, config?): Promise<TaxRate[]>
Parameters
| Name | Type |
|---|---|
selector |
FilterableTaxRateProps |
config |
FindConfig<TaxRate> |
Returns
Promise<TaxRate[]>
Defined in
packages/medusa/src/services/tax-rate.ts:62
listAndCount
▸ listAndCount(selector, config?): Promise<[TaxRate[], number]>
Parameters
| Name | Type |
|---|---|
selector |
FilterableTaxRateProps |
config |
FindConfig<TaxRate> |
Returns
Promise<[TaxRate[], number]>
Defined in
packages/medusa/src/services/tax-rate.ts:73
listByProduct
▸ listByProduct(productId, config): Promise<TaxRate[]>
Parameters
| Name | Type |
|---|---|
productId |
string |
config |
TaxRateListByConfig |
Returns
Promise<TaxRate[]>
Defined in
packages/medusa/src/services/tax-rate.ts:320
listByShippingOption
▸ listByShippingOption(shippingOptionId): Promise<TaxRate[]>
Parameters
| Name | Type |
|---|---|
shippingOptionId |
string |
Returns
Promise<TaxRate[]>
Defined in
packages/medusa/src/services/tax-rate.ts:330
removeFromProduct
▸ removeFromProduct(id, productIds): Promise<void>
Parameters
| Name | Type |
|---|---|
id |
string |
productIds |
string | string[] |
Returns
Promise<void>
Defined in
packages/medusa/src/services/tax-rate.ts:142
removeFromProductType
▸ removeFromProductType(id, typeIds): Promise<void>
Parameters
| Name | Type |
|---|---|
id |
string |
typeIds |
string | string[] |
Returns
Promise<void>
Defined in
packages/medusa/src/services/tax-rate.ts:160
removeFromShippingOption
▸ removeFromShippingOption(id, optionIds): Promise<void>
Parameters
| Name | Type |
|---|---|
id |
string |
optionIds |
string | string[] |
Returns
Promise<void>
Defined in
packages/medusa/src/services/tax-rate.ts:178
retrieve
▸ retrieve(id, config?): Promise<TaxRate>
Parameters
| Name | Type |
|---|---|
id |
string |
config |
FindConfig<TaxRate> |
Returns
Promise<TaxRate>
Defined in
packages/medusa/src/services/tax-rate.ts:84
update
▸ update(id, data): Promise<TaxRate>
Parameters
| Name | Type |
|---|---|
id |
string |
data |
UpdateTaxRateInput |
Returns
Promise<TaxRate>
Defined in
packages/medusa/src/services/tax-rate.ts:119
withTransaction
▸ withTransaction(transactionManager): TaxRateService
Parameters
| Name | Type |
|---|---|
transactionManager |
EntityManager |