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

docs: TSDoc + reference of fulfillment service (#5761)

Browse Source
This commit is contained in:
Shahed Nasser
2023-11-29 11:58:08 +00:00
committed by GitHub
parent 8f25ed8a10
commit f802e2460f
1479 changed files with 30259 additions and 16135 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/services/classes/TaxRateService.mdx
+78 -58
View File
@@ -6,13 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# TaxRateService
## Constructors
#### constructor
## constructor
`**new TaxRateService**(«destructured»)`
##### Parameters
### Parameters
<ParameterTypes parameters={[
{
@@ -26,6 +24,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Properties
<ParameterTypes parameters={[
@@ -112,19 +112,39 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Accessors
#### activeManager\_
### activeManager\_
`Protected` **activeManager\_**: [object Object]
`Protected get**activeManager_**(): EntityManager`
#### Returns
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
## Methods
#### addToProduct
### addToProduct
`**addToProduct**(id, productIds, replace?): Promise&#60;[ProductTaxRate](ProductTaxRate.mdx) \| [ProductTaxRate](ProductTaxRate.mdx)[]&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -156,7 +176,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
##### Returns
#### Returns
Promise&#60;[ProductTaxRate](ProductTaxRate.mdx) \| [ProductTaxRate](ProductTaxRate.mdx)[]&#62;
@@ -174,11 +194,11 @@ Promise&#60;[ProductTaxRate](ProductTaxRate.mdx) \| [ProductTaxRate](ProductTaxR
___
#### addToProductType
### addToProductType
`**addToProductType**(id, productTypeIds, replace?): Promise&#60;[ProductTypeTaxRate](ProductTypeTaxRate.mdx)[]&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -210,7 +230,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[ProductTypeTaxRate](ProductTypeTaxRate.mdx)[]&#62;
@@ -228,11 +248,11 @@ Promise&#60;[ProductTypeTaxRate](ProductTypeTaxRate.mdx)[]&#62;
___
#### addToShippingOption
### addToShippingOption
`**addToShippingOption**(id, optionIds, replace?): Promise&#60;[ShippingTaxRate](ShippingTaxRate.mdx)[]&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -264,7 +284,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[ShippingTaxRate](ShippingTaxRate.mdx)[]&#62;
@@ -282,7 +302,7 @@ Promise&#60;[ShippingTaxRate](ShippingTaxRate.mdx)[]&#62;
___
#### atomicPhase\_
### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -290,7 +310,7 @@ 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
#### Type Parameters
<ParameterTypes parameters={[
{
@@ -313,7 +333,7 @@ transaction manager is created.
}
]} />
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -345,7 +365,7 @@ transaction manager is created.
}
]} />
##### Returns
#### Returns
Promise&#60;TResult&#62;
@@ -363,11 +383,11 @@ Promise&#60;TResult&#62;
___
#### create
### create
`**create**(data): Promise&#60;[TaxRate](TaxRate.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -381,7 +401,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[TaxRate](TaxRate.mdx)&#62;
@@ -399,11 +419,11 @@ Promise&#60;[TaxRate](TaxRate.mdx)&#62;
___
#### delete
### delete
`**delete**(id): Promise&#60;void&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -417,7 +437,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;void&#62;
@@ -435,11 +455,11 @@ Promise&#60;void&#62;
___
#### list
### list
`**list**(selector, config?): Promise&#60;[TaxRate](TaxRate.mdx)[]&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -462,7 +482,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[TaxRate](TaxRate.mdx)[]&#62;
@@ -480,11 +500,11 @@ Promise&#60;[TaxRate](TaxRate.mdx)[]&#62;
___
#### listAndCount
### listAndCount
`**listAndCount**(selector, config?): Promise&#60;[[TaxRate](TaxRate.mdx)[], number]&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -507,7 +527,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[[TaxRate](TaxRate.mdx)[], number]&#62;
@@ -525,11 +545,11 @@ Promise&#60;[[TaxRate](TaxRate.mdx)[], number]&#62;
___
#### listByProduct
### listByProduct
`**listByProduct**(productId, config): Promise&#60;[TaxRate](TaxRate.mdx)[]&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -552,7 +572,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[TaxRate](TaxRate.mdx)[]&#62;
@@ -570,11 +590,11 @@ Promise&#60;[TaxRate](TaxRate.mdx)[]&#62;
___
#### listByShippingOption
### listByShippingOption
`**listByShippingOption**(shippingOptionId): Promise&#60;[TaxRate](TaxRate.mdx)[]&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -588,7 +608,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[TaxRate](TaxRate.mdx)[]&#62;
@@ -606,11 +626,11 @@ Promise&#60;[TaxRate](TaxRate.mdx)[]&#62;
___
#### removeFromProduct
### removeFromProduct
`**removeFromProduct**(id, productIds): Promise&#60;void&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -633,7 +653,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;void&#62;
@@ -651,11 +671,11 @@ Promise&#60;void&#62;
___
#### removeFromProductType
### removeFromProductType
`**removeFromProductType**(id, typeIds): Promise&#60;void&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -678,7 +698,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;void&#62;
@@ -696,11 +716,11 @@ Promise&#60;void&#62;
___
#### removeFromShippingOption
### removeFromShippingOption
`**removeFromShippingOption**(id, optionIds): Promise&#60;void&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -723,7 +743,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;void&#62;
@@ -741,11 +761,11 @@ Promise&#60;void&#62;
___
#### retrieve
### retrieve
`**retrieve**(taxRateId, config?): Promise&#60;[TaxRate](TaxRate.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -768,7 +788,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[TaxRate](TaxRate.mdx)&#62;
@@ -786,11 +806,11 @@ Promise&#60;[TaxRate](TaxRate.mdx)&#62;
___
#### shouldRetryTransaction\_
### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -804,7 +824,7 @@ ___
}
]} />
##### Returns
#### Returns
`boolean`
@@ -822,11 +842,11 @@ ___
___
#### update
### update
`**update**(id, data): Promise&#60;[TaxRate](TaxRate.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -849,7 +869,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[TaxRate](TaxRate.mdx)&#62;
@@ -867,11 +887,11 @@ Promise&#60;[TaxRate](TaxRate.mdx)&#62;
___
#### withTransaction
### withTransaction
`**withTransaction**(transactionManager?): [TaxRateService](TaxRateService.mdx)`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -885,7 +905,7 @@ ___
}
]} />
##### Returns
#### Returns
[TaxRateService](TaxRateService.mdx)