asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
9ceddf45a9eac8e6ecdc0888663fe93ee75892c0
medusa-store/docs/content/references/services/classes/TaxRateService.md
github-actions[bot] 9ceddf45a9 chore(docs): Generated Services Reference (automated) (#3465) 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>
2023-03-13 18:29:42 +00:00

519 lines
11 KiB
Markdown
Raw Blame History

# Class: TaxRateService
## Hierarchy
- `TransactionBaseService`
↳ **`TaxRateService`**
## Constructors
### constructor
• **new TaxRateService**(`__namedParameters`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `__namedParameters` | `Object` |
#### Overrides
TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/tax-rate.ts:33](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/tax-rate.ts#L33)
## Properties
### \_\_configModule\_\_
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
### \_\_moduleDeclaration\_\_
• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/interfaces/transaction-base-service.ts#L11)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
#### Overrides
TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/tax-rate.ts#L25)
___
### productService\_
• `Protected` `Readonly` **productService\_**: [`ProductService`](ProductService.md)
#### Defined in
[packages/medusa/src/services/tax-rate.ts:28](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/tax-rate.ts#L28)
___
### productTypeService\_
• `Protected` `Readonly` **productTypeService\_**: [`ProductTypeService`](ProductTypeService.md)
#### Defined in
[packages/medusa/src/services/tax-rate.ts:29](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/tax-rate.ts#L29)
___
### shippingOptionService\_
• `Protected` `Readonly` **shippingOptionService\_**: [`ShippingOptionService`](ShippingOptionService.md)
#### Defined in
[packages/medusa/src/services/tax-rate.ts:30](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/tax-rate.ts#L30)
___
### taxRateRepository\_
• `Protected` `Readonly` **taxRateRepository\_**: typeof `TaxRateRepository`
#### Defined in
[packages/medusa/src/services/tax-rate.ts:31](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/tax-rate.ts#L31)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/tax-rate.ts:26](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/tax-rate.ts#L26)
## 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:190](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/tax-rate.ts#L190)
___
### 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:226](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/tax-rate.ts#L226)
___
### 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:266](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/tax-rate.ts#L266)
___
### 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
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
### create
▸ **create**(`data`): `Promise`<`TaxRate`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `data` | `CreateTaxRateInput` |
#### Returns
`Promise`<`TaxRate`\>
#### Defined in
[packages/medusa/src/services/tax-rate.ts:97](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/tax-rate.ts#L97)
___
### delete
▸ **delete**(`id`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` \| `string`[] |
#### Returns
`Promise`<`void`\>
#### Defined in
[packages/medusa/src/services/tax-rate.ts:128](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/tax-rate.ts#L128)
___
### 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:49](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/tax-rate.ts#L49)
___
### 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:60](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/tax-rate.ts#L60)
___
### 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:314](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/tax-rate.ts#L314)
___
### listByShippingOption
▸ **listByShippingOption**(`shippingOptionId`): `Promise`<`TaxRate`[]\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `shippingOptionId` | `string` |
#### Returns
`Promise`<`TaxRate`[]\>
#### Defined in
[packages/medusa/src/services/tax-rate.ts:324](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/tax-rate.ts#L324)
___
### 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:136](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/tax-rate.ts#L136)
___
### 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:154](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/tax-rate.ts#L154)
___
### 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:172](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/tax-rate.ts#L172)
___
### retrieve
▸ **retrieve**(`taxRateId`, `config?`): `Promise`<`TaxRate`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `taxRateId` | `string` |
| `config` | `FindConfig`<`TaxRate`\> |
#### Returns
`Promise`<`TaxRate`\>
#### Defined in
[packages/medusa/src/services/tax-rate.ts:71](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/tax-rate.ts#L71)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
### 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:113](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/tax-rate.ts#L113)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`TaxRateService`](TaxRateService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`TaxRateService`](TaxRateService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
Reference in New Issue View Git Blame Copy Permalink