asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 3 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

128
www/apps/docs/content/references/services/classes/TaxRateService.mdx
View File

@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Constructors
### constructor
#### constructor
`**new TaxRateService**(«destructured»)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -114,33 +114,17 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## 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
### addToProduct
#### addToProduct
`**addToProduct**(id, productIds, replace?): Promise&#60;[ProductTaxRate](ProductTaxRate.mdx) \| [ProductTaxRate](ProductTaxRate.mdx)[]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -172,7 +156,7 @@ EntityManager
}
]} />
#### Returns
##### Returns
Promise&#60;[ProductTaxRate](ProductTaxRate.mdx) \| [ProductTaxRate](ProductTaxRate.mdx)[]&#62;
@@ -190,11 +174,11 @@ Promise&#60;[ProductTaxRate](ProductTaxRate.mdx) \| [ProductTaxRate](ProductTaxR
___
### addToProductType
#### addToProductType
`**addToProductType**(id, productTypeIds, replace?): Promise&#60;[ProductTypeTaxRate](ProductTypeTaxRate.mdx)[]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -226,7 +210,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[ProductTypeTaxRate](ProductTypeTaxRate.mdx)[]&#62;
@@ -244,11 +228,11 @@ Promise&#60;[ProductTypeTaxRate](ProductTypeTaxRate.mdx)[]&#62;
___
### addToShippingOption
#### addToShippingOption
`**addToShippingOption**(id, optionIds, replace?): Promise&#60;[ShippingTaxRate](ShippingTaxRate.mdx)[]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -280,7 +264,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[ShippingTaxRate](ShippingTaxRate.mdx)[]&#62;
@@ -298,7 +282,7 @@ Promise&#60;[ShippingTaxRate](ShippingTaxRate.mdx)[]&#62;
___
### atomicPhase\_
#### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -306,6 +290,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",
@@ -327,7 +313,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -359,7 +345,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -377,11 +363,11 @@ Promise&#60;TResult&#62;
___
### create
#### create
`**create**(data): Promise&#60;[TaxRate](TaxRate.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -395,7 +381,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[TaxRate](TaxRate.mdx)&#62;
@@ -413,11 +399,11 @@ Promise&#60;[TaxRate](TaxRate.mdx)&#62;
___
### delete
#### delete
`**delete**(id): Promise&#60;void&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -431,7 +417,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -449,11 +435,11 @@ Promise&#60;void&#62;
___
### list
#### list
`**list**(selector, config?): Promise&#60;[TaxRate](TaxRate.mdx)[]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -476,7 +462,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[TaxRate](TaxRate.mdx)[]&#62;
@@ -494,11 +480,11 @@ Promise&#60;[TaxRate](TaxRate.mdx)[]&#62;
___
### listAndCount
#### listAndCount
`**listAndCount**(selector, config?): Promise&#60;[[TaxRate](TaxRate.mdx)[], number]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -521,7 +507,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[[TaxRate](TaxRate.mdx)[], number]&#62;
@@ -539,11 +525,11 @@ Promise&#60;[[TaxRate](TaxRate.mdx)[], number]&#62;
___
### listByProduct
#### listByProduct
`**listByProduct**(productId, config): Promise&#60;[TaxRate](TaxRate.mdx)[]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -566,7 +552,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[TaxRate](TaxRate.mdx)[]&#62;
@@ -584,11 +570,11 @@ Promise&#60;[TaxRate](TaxRate.mdx)[]&#62;
___
### listByShippingOption
#### listByShippingOption
`**listByShippingOption**(shippingOptionId): Promise&#60;[TaxRate](TaxRate.mdx)[]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -602,7 +588,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[TaxRate](TaxRate.mdx)[]&#62;
@@ -620,11 +606,11 @@ Promise&#60;[TaxRate](TaxRate.mdx)[]&#62;
___
### removeFromProduct
#### removeFromProduct
`**removeFromProduct**(id, productIds): Promise&#60;void&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -647,7 +633,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -665,11 +651,11 @@ Promise&#60;void&#62;
___
### removeFromProductType
#### removeFromProductType
`**removeFromProductType**(id, typeIds): Promise&#60;void&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -692,7 +678,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -710,11 +696,11 @@ Promise&#60;void&#62;
___
### removeFromShippingOption
#### removeFromShippingOption
`**removeFromShippingOption**(id, optionIds): Promise&#60;void&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -737,7 +723,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -755,11 +741,11 @@ Promise&#60;void&#62;
___
### retrieve
#### retrieve
`**retrieve**(taxRateId, config?): Promise&#60;[TaxRate](TaxRate.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -782,7 +768,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[TaxRate](TaxRate.mdx)&#62;
@@ -800,11 +786,11 @@ Promise&#60;[TaxRate](TaxRate.mdx)&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -818,7 +804,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -836,11 +822,11 @@ ___
___
### update
#### update
`**update**(id, data): Promise&#60;[TaxRate](TaxRate.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -863,7 +849,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[TaxRate](TaxRate.mdx)&#62;
@@ -881,11 +867,11 @@ Promise&#60;[TaxRate](TaxRate.mdx)&#62;
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [TaxRateService](TaxRateService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -899,7 +885,7 @@ ___
}
]} />
#### Returns
##### Returns
[TaxRateService](TaxRateService.mdx)