docs: update Typedoc and regenerate references (#1994)

* 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
2022-08-04 17:29:52 +03:00
parent 6663a6290b
commit 02d5c1da88
630 changed files with 21256 additions and 16381 deletions
--- a/docs/content/references/services/classes/TaxProviderService.md
+++ b/docs/content/references/services/classes/TaxProviderService.md
@@ -1,8 +1,10 @@
 # Class: TaxProviderService

+Finds tax providers and assists in tax related operations.
+
 ## Hierarchy

- `"medusa-interfaces"`
+- `TransactionBaseService`<[`TaxProviderService`](TaxProviderService.md)\>

  ↳ **`TaxProviderService`**

@@ -20,94 +22,179 @@

 #### Overrides

-BaseService.constructor
+TransactionBaseService&lt;TaxProviderService\&gt;.constructor

 #### Defined in

-[services/tax-provider.ts:49](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L49)
+[packages/medusa/src/services/tax-provider.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L53)

 ## Properties

-### container\_
+### configModule

-• `Private` **container\_**: `AwilixContainer`<`any`\>
+• `Protected` `Optional` `Readonly` **configModule**: `Record`<`string`, `unknown`\>
+
+#### Inherited from
+
+TransactionBaseService.configModule

 #### Defined in

-[services/tax-provider.ts:40](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L40)
+[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
+
+___
+
+### container
+
+• `Protected` `Readonly` **container**: `unknown`
+
+#### Inherited from
+
+TransactionBaseService.container
+
+#### Defined in
+
+[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
+
+___
+
+### container\_
+
+• `Protected` `Readonly` **container\_**: `AwilixContainer`<`any`\>
+
+#### Defined in
+
+[packages/medusa/src/services/tax-provider.ts:45](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L45)
+
+___
+
+### eventBus\_
+
+• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md)
+
+#### Defined in
+
+[packages/medusa/src/services/tax-provider.ts:51](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L51)

 ___

 ### manager\_

-• `Private` **manager\_**: `EntityManager`
+• `Protected` **manager\_**: `EntityManager`
+
+#### Overrides
+
+TransactionBaseService.manager\_

 #### Defined in

-[services/tax-provider.ts:41](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L41)
+[packages/medusa/src/services/tax-provider.ts:42](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L42)

 ___

 ### redis\_

-• `Private` **redis\_**: `Redis`
+• `Protected` `Readonly` **redis\_**: `Redis`

 #### Defined in

-[services/tax-provider.ts:47](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L47)
+[packages/medusa/src/services/tax-provider.ts:50](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L50)

 ___

 ### smTaxLineRepo\_

-• `Private` **smTaxLineRepo\_**: typeof `ShippingMethodTaxLineRepository`
+• `Protected` `Readonly` **smTaxLineRepo\_**: typeof `ShippingMethodTaxLineRepository`

 #### Defined in

-[services/tax-provider.ts:45](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L45)
+[packages/medusa/src/services/tax-provider.ts:48](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L48)

 ___

 ### taxLineRepo\_

-• `Private` **taxLineRepo\_**: typeof `LineItemTaxLineRepository`
+• `Protected` `Readonly` **taxLineRepo\_**: typeof `LineItemTaxLineRepository`

 #### Defined in

-[services/tax-provider.ts:44](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L44)
+[packages/medusa/src/services/tax-provider.ts:47](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L47)

 ___

 ### taxProviderRepo\_

-• `Private` **taxProviderRepo\_**: typeof `TaxProviderRepository`
+• `Protected` `Readonly` **taxProviderRepo\_**: typeof `TaxProviderRepository`

 #### Defined in

-[services/tax-provider.ts:46](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L46)
+[packages/medusa/src/services/tax-provider.ts:49](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L49)

 ___

 ### taxRateService\_

-• `Private` **taxRateService\_**: [`TaxRateService`](TaxRateService.md)
+• `Protected` `Readonly` **taxRateService\_**: [`TaxRateService`](TaxRateService.md)

 #### Defined in

-[services/tax-provider.ts:43](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L43)
+[packages/medusa/src/services/tax-provider.ts:46](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L46)

 ___

 ### transactionManager\_

-• `Private` **transactionManager\_**: `EntityManager`
+• `Protected` **transactionManager\_**: `EntityManager`
+
+#### Overrides
+
+TransactionBaseService.transactionManager\_

 #### Defined in

-[services/tax-provider.ts:42](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L42)
+[packages/medusa/src/services/tax-provider.ts:43](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L43)

 ## Methods

+### 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:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
+
+___
+
 ### clearTaxLines

 ▸ **clearTaxLines**(`cartId`): `Promise`<`void`\>
@@ -124,7 +211,7 @@ ___

 #### Defined in

-[services/tax-provider.ts:103](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L103)
+[packages/medusa/src/services/tax-provider.ts:94](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L94)

 ___

@@ -132,20 +219,25 @@ ___

 ▸ **createShippingTaxLines**(`shippingMethod`, `calculationContext`): `Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\>

+Persists the tax lines relevant for a shipping method to the database. Used
+for return shipping methods.
+
 #### Parameters

 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `shippingMethod` | `ShippingMethod` |  |
-| `calculationContext` | `TaxCalculationContext` |  |
+| `shippingMethod` | `ShippingMethod` | the shipping method to create tax lines for |
+| `calculationContext` | `TaxCalculationContext` | the calculation context to get tax lines by |

 #### Returns

 `Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\>

+the newly created tax lines
+
 #### Defined in

-[services/tax-provider.ts:171](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L171)
+[packages/medusa/src/services/tax-provider.ts:170](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L170)

 ___

@@ -153,20 +245,24 @@ ___

 ▸ **createTaxLines**(`cartOrLineItems`, `calculationContext`): `Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\>

+Persists the tax lines relevant for an order to the database.
+
 #### Parameters

 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `cartOrLineItems` | `Cart` \| `LineItem`[] |  |
-| `calculationContext` | `TaxCalculationContext` |  |
+| `cartOrLineItems` | `Cart` \| `LineItem`[] | the cart or line items to create tax lines for |
+| `calculationContext` | `TaxCalculationContext` | the calculation context to get tax lines by |

 #### Returns

 `Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\>

+the newly created tax lines
+
 #### Defined in

-[services/tax-provider.ts:121](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L121)
+[packages/medusa/src/services/tax-provider.ts:116](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L116)

 ___

@@ -174,20 +270,24 @@ ___

 ▸ `Private` **getCacheEntry**(`productId`, `regionId`): `Promise`<``null`` \| `TaxServiceRate`[]\>

+Gets the cache results for a set of ids
+
 #### Parameters

 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `productId` | `string` |  |
-| `regionId` | `string` |  |
+| `productId` | `string` | the product id to cache |
+| `regionId` | `string` | the region id to cache |

 #### Returns

 `Promise`<``null`` \| `TaxServiceRate`[]\>

+the cached result or null
+
 #### Defined in

-[services/tax-provider.ts:454](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L454)
+[packages/medusa/src/services/tax-provider.ts:457](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L457)

 ___

@@ -195,20 +295,24 @@ ___

 ▸ `Private` **getCacheKey**(`productId`, `regionId`): `string`

+The cache key to get cache hits by.
+
 #### Parameters

 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `productId` | `string` |  |
-| `regionId` | `string` |  |
+| `productId` | `string` | the product id to cache |
+| `regionId` | `string` | the region id to cache |

 #### Returns

 `string`

+the cache key to use for the id set
+
 #### Defined in

-[services/tax-provider.ts:423](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L423)
+[packages/medusa/src/services/tax-provider.ts:426](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L426)

 ___

@@ -216,20 +320,25 @@ ___

 ▸ **getRegionRatesForProduct**(`productId`, `region`): `Promise`<`TaxServiceRate`[]\>

+Gets the tax rates configured for a product. The rates are cached between
+calls.
+
 #### Parameters

 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `productId` | `string` |  |
-| `region` | `RegionDetails` |  |
+| `productId` | `string` | the product id to get rates for |
+| `region` | `RegionDetails` | the region to get configured rates for. |

 #### Returns

 `Promise`<`TaxServiceRate`[]\>

+the tax rates configured for the shipping option.
+
 #### Defined in

-[services/tax-provider.ts:378](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L378)
+[packages/medusa/src/services/tax-provider.ts:379](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L379)

 ___

@@ -237,20 +346,25 @@ ___

 ▸ **getRegionRatesForShipping**(`optionId`, `regionDetails`): `Promise`<`TaxServiceRate`[]\>

+Gets the tax rates configured for a shipping option. The rates are cached
+between calls.
+
 #### Parameters

 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `optionId` | `string` |  |
-| `regionDetails` | `RegionDetails` |  |
+| `optionId` | `string` | the option id of the shipping method. |
+| `regionDetails` | `RegionDetails` | the region to get configured rates for. |

 #### Returns

 `Promise`<`TaxServiceRate`[]\>

+the tax rates configured for the shipping option.
+
 #### Defined in

-[services/tax-provider.ts:332](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L332)
+[packages/medusa/src/services/tax-provider.ts:333](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L333)

 ___

@@ -258,20 +372,26 @@ ___

 ▸ **getShippingTaxLines**(`shippingMethod`, `calculationContext`): `Promise`<`ShippingMethodTaxLine`[]\>

+Gets the relevant tax lines for a shipping method. Note: this method
+doesn't persist the tax lines. Use createShippingTaxLines if you wish to
+persist the tax lines to the DB layer.
+
 #### Parameters

 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `shippingMethod` | `ShippingMethod` |  |
-| `calculationContext` | `TaxCalculationContext` |  |
+| `shippingMethod` | `ShippingMethod` | the shipping method to get tax lines for |
+| `calculationContext` | `TaxCalculationContext` | the calculation context to get tax lines by |

 #### Returns

 `Promise`<`ShippingMethodTaxLine`[]\>

+the computed tax lines
+
 #### Defined in

-[services/tax-provider.ts:190](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L190)
+[packages/medusa/src/services/tax-provider.ts:191](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L191)

 ___

@@ -279,20 +399,28 @@ ___

 ▸ **getTaxLines**(`lineItems`, `calculationContext`): `Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\>

+Gets the relevant tax lines for an order or cart. If an order is provided
+the order's tax lines will be returned. If a cart is provided the tax lines
+will be computed from the tax rules and potentially a 3rd party tax plugin.
+Note: this method doesn't persist the tax lines. Use createTaxLines if you
+wish to persist the tax lines to the DB layer.
+
 #### Parameters

 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `lineItems` | `LineItem`[] |  |
-| `calculationContext` | `TaxCalculationContext` |  |
+| `lineItems` | `LineItem`[] | the cart or order to get tax lines for |
+| `calculationContext` | `TaxCalculationContext` | the calculation context to get tax lines by |

 #### Returns

 `Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\>

+the computed tax lines
+
 #### Defined in

-[services/tax-provider.ts:242](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L242)
+[packages/medusa/src/services/tax-provider.ts:243](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L243)

 ___

@@ -306,7 +434,7 @@ ___

 #### Defined in

-[services/tax-provider.ts:75](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L75)
+[packages/medusa/src/services/tax-provider.ts:66](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L66)

 ___

@@ -326,7 +454,7 @@ ___

 #### Defined in

-[services/tax-provider.ts:475](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L475)
+[packages/medusa/src/services/tax-provider.ts:478](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L478)

 ___

@@ -334,19 +462,23 @@ ___

 ▸ **retrieveProvider**(`region`): `ITaxService`

+Retrieves the relevant tax provider for the given region.
+
 #### Parameters

 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `region` | `Region` |  |
+| `region` | `Region` | the region to get tax provider for. |

 #### Returns

 `ITaxService`

+the region specific tax provider
+
 #### Defined in

-[services/tax-provider.ts:85](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L85)
+[packages/medusa/src/services/tax-provider.ts:76](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L76)

 ___

@@ -354,38 +486,70 @@ ___

 ▸ `Private` **setCache**(`productId`, `regionId`, `value`): `Promise`<`void`\>

+Sets the cache results for a set of ids
+
 #### Parameters

 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `productId` | `string` |  |
-| `regionId` | `string` |  |
-| `value` | `TaxServiceRate`[] |  |
+| `productId` | `string` | the product id to cache |
+| `regionId` | `string` | the region id to cache |
+| `value` | `TaxServiceRate`[] | tax rates to cache |

 #### Returns

 `Promise`<`void`\>

+promise that resolves after the cache has been set
+
 #### Defined in

-[services/tax-provider.ts:434](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L434)
+[packages/medusa/src/services/tax-provider.ts:437](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L437)

 ___

-### withTransaction
+### shouldRetryTransaction\_

-▸ **withTransaction**(`transactionManager`): [`TaxProviderService`](TaxProviderService.md)
+▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`

 #### Parameters

 | Name | Type |
 | :------ | :------ |
-| `transactionManager` | `EntityManager` |
+| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string`  } |
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+TransactionBaseService.shouldRetryTransaction\_
+
+#### Defined in
+
+[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
+
+___
+
+### withTransaction
+
+▸ **withTransaction**(`transactionManager?`): [`TaxProviderService`](TaxProviderService.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `transactionManager?` | `EntityManager` |

 #### Returns

 [`TaxProviderService`](TaxProviderService.md)

+#### Inherited from
+
+TransactionBaseService.withTransaction
+
 #### Defined in

-[services/tax-provider.ts:62](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L62)
+[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)