asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Generated References (#5743)

Browse Source 
Generated the following references:
- `entities`
- `inventory`
- `js-client`
- `pricing`
- `product`
- `services`
- `stock-location`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-27 18:58:52 +00:00
committed by GitHub
parent dc6b815b12
commit cdd42dbdcd
1383 changed files with 18978 additions and 20154 deletions
Download Patch File Download Diff File Expand all files Collapse all files

120
www/apps/docs/content/references/services/classes/TaxProviderService.mdx
View File

@@ -10,11 +10,11 @@ Finds tax providers and assists in tax related operations.
## Constructors
### constructor
#### constructor
`**new TaxProviderService**(container)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -143,29 +143,13 @@ Finds tax providers and assists in tax related operations.
## Accessors
### activeManager\_
#### activeManager\_
`Protected get**activeManager_**(): EntityManager`
#### Returns
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
`Protected` **activeManager\_**: [object Object]
## Methods
### atomicPhase\_
#### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -173,6 +157,8 @@ 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
<ParameterTypes parameters={[
{
"name": "TResult",
@@ -194,7 +180,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -226,7 +212,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -244,11 +230,11 @@ Promise&#60;TResult&#62;
___
### clearLineItemsTaxLines
#### clearLineItemsTaxLines
`**clearLineItemsTaxLines**(itemIds): Promise&#60;void&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -262,7 +248,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -280,11 +266,11 @@ Promise&#60;void&#62;
___
### clearTaxLines
#### clearTaxLines
`**clearTaxLines**(cartId): Promise&#60;void&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -298,7 +284,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -316,14 +302,14 @@ Promise&#60;void&#62;
___
### createShippingTaxLines
#### createShippingTaxLines
`**createShippingTaxLines**(shippingMethod, calculationContext): Promise&#60;([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]&#62;`
Persists the tax lines relevant for a shipping method to the database. Used
for return shipping methods.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -346,7 +332,7 @@ for return shipping methods.
}
]} />
#### Returns
##### Returns
Promise&#60;([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]&#62;
@@ -364,13 +350,13 @@ Promise&#60;([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](S
___
### createTaxLines
#### createTaxLines
`**createTaxLines**(cartOrLineItems, calculationContext): Promise&#60;([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]&#62;`
Persists the tax lines relevant for an order to the database.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -393,7 +379,7 @@ Persists the tax lines relevant for an order to the database.
}
]} />
#### Returns
##### Returns
Promise&#60;([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]&#62;
@@ -411,13 +397,13 @@ Promise&#60;([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](S
___
### getCacheKey
#### getCacheKey
`Private **getCacheKey**(id, regionId): string`
The cache key to get cache hits by.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -440,7 +426,7 @@ The cache key to get cache hits by.
}
]} />
#### Returns
##### Returns
`string`
@@ -458,14 +444,14 @@ The cache key to get cache hits by.
___
### getRegionRatesForProduct
#### getRegionRatesForProduct
`**getRegionRatesForProduct**(productIds, region): Promise&#60;Map&#60;string, [TaxServiceRate](../types/TaxServiceRate.mdx)[]&#62;&#62;`
Gets the tax rates configured for a product. The rates are cached between
calls.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -488,7 +474,7 @@ calls.
}
]} />
#### Returns
##### Returns
Promise&#60;Map&#60;string, [TaxServiceRate](../types/TaxServiceRate.mdx)[]&#62;&#62;
@@ -506,14 +492,14 @@ Promise&#60;Map&#60;string, [TaxServiceRate](../types/TaxServiceRate.mdx)[]&#62;
___
### getRegionRatesForShipping
#### getRegionRatesForShipping
`**getRegionRatesForShipping**(optionId, regionDetails): Promise&#60;[TaxServiceRate](../types/TaxServiceRate.mdx)[]&#62;`
Gets the tax rates configured for a shipping option. The rates are cached
between calls.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -536,7 +522,7 @@ between calls.
}
]} />
#### Returns
##### Returns
Promise&#60;[TaxServiceRate](../types/TaxServiceRate.mdx)[]&#62;
@@ -554,7 +540,7 @@ Promise&#60;[TaxServiceRate](../types/TaxServiceRate.mdx)[]&#62;
___
### getShippingTaxLines
#### getShippingTaxLines
`**getShippingTaxLines**(shippingMethod, calculationContext): Promise&#60;[ShippingMethodTaxLine](ShippingMethodTaxLine.mdx)[]&#62;`
@@ -562,7 +548,7 @@ 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
##### Parameters
<ParameterTypes parameters={[
{
@@ -585,7 +571,7 @@ persist the tax lines to the DB layer.
}
]} />
#### Returns
##### Returns
Promise&#60;[ShippingMethodTaxLine](ShippingMethodTaxLine.mdx)[]&#62;
@@ -603,7 +589,7 @@ Promise&#60;[ShippingMethodTaxLine](ShippingMethodTaxLine.mdx)[]&#62;
___
### getTaxLines
#### getTaxLines
`**getTaxLines**(lineItems, calculationContext): Promise&#60;([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]&#62;`
@@ -613,7 +599,7 @@ 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
##### Parameters
<ParameterTypes parameters={[
{
@@ -636,7 +622,7 @@ wish to persist the tax lines to the DB layer.
}
]} />
#### Returns
##### Returns
Promise&#60;([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]&#62;
@@ -654,13 +640,13 @@ Promise&#60;([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](S
___
### getTaxLinesMap
#### getTaxLinesMap
`Protected **getTaxLinesMap**(items, calculationContext): Promise&#60;[TaxLinesMaps](../types/TaxLinesMaps.mdx)&#62;`
Return a map of tax lines for line items and shipping methods
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -683,7 +669,7 @@ Return a map of tax lines for line items and shipping methods
}
]} />
#### Returns
##### Returns
Promise&#60;[TaxLinesMaps](../types/TaxLinesMaps.mdx)&#62;
@@ -701,11 +687,11 @@ Promise&#60;[TaxLinesMaps](../types/TaxLinesMaps.mdx)&#62;
___
### list
#### list
`**list**(): Promise&#60;[TaxProvider](TaxProvider.mdx)[]&#62;`
#### Returns
##### Returns
Promise&#60;[TaxProvider](TaxProvider.mdx)[]&#62;
@@ -723,11 +709,11 @@ Promise&#60;[TaxProvider](TaxProvider.mdx)[]&#62;
___
### registerInstalledProviders
#### registerInstalledProviders
`**registerInstalledProviders**(providers): Promise&#60;void&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -741,7 +727,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -759,13 +745,13 @@ Promise&#60;void&#62;
___
### retrieveProvider
#### retrieveProvider
`**retrieveProvider**(region): [ITaxService](../interfaces/ITaxService.mdx)`
Retrieves the relevant tax provider for the given region.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -779,7 +765,7 @@ Retrieves the relevant tax provider for the given region.
}
]} />
#### Returns
##### Returns
[ITaxService](../interfaces/ITaxService.mdx)
@@ -797,11 +783,11 @@ Retrieves the relevant tax provider for the given region.
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -815,7 +801,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -833,11 +819,11 @@ ___
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [TaxProviderService](TaxProviderService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -851,7 +837,7 @@ ___
}
]} />
#### Returns
##### Returns
[TaxProviderService](TaxProviderService.mdx)