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

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

View File

@@ -8,15 +8,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Provides layer to manipulate discount conditions.
#### Implements
## Implements
## Constructors
#### constructor
## constructor
`**new DiscountConditionService**(«destructured»)`
##### Parameters
### Parameters
<ParameterTypes parameters={[
{
@@ -30,6 +28,8 @@ Provides layer to manipulate discount conditions.
}
]} />
___
## Properties
<ParameterTypes parameters={[
@@ -98,15 +98,35 @@ Provides layer to manipulate discount conditions.
}
]} />
___
## 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
#### atomicPhase\_
### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -114,7 +134,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={[
{
@@ -137,7 +157,7 @@ transaction manager is created.
}
]} />
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -169,7 +189,7 @@ transaction manager is created.
}
]} />
##### Returns
#### Returns
Promise&#60;TResult&#62;
@@ -187,11 +207,11 @@ Promise&#60;TResult&#62;
___
#### delete
### delete
`**delete**(discountConditionId): Promise&#60;void \| [DiscountCondition](DiscountCondition.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -205,7 +225,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;void \| [DiscountCondition](DiscountCondition.mdx)&#62;
@@ -223,11 +243,11 @@ Promise&#60;void \| [DiscountCondition](DiscountCondition.mdx)&#62;
___
#### removeResources
### removeResources
`**removeResources**(data): Promise&#60;void&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -241,7 +261,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;void&#62;
@@ -259,11 +279,11 @@ Promise&#60;void&#62;
___
#### retrieve
### retrieve
`**retrieve**(conditionId, config?): Promise&#60;[DiscountCondition](DiscountCondition.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -286,7 +306,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[DiscountCondition](DiscountCondition.mdx)&#62;
@@ -304,11 +324,11 @@ Promise&#60;[DiscountCondition](DiscountCondition.mdx)&#62;
___
#### shouldRetryTransaction\_
### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -322,7 +342,7 @@ ___
}
]} />
##### Returns
#### Returns
`boolean`
@@ -340,11 +360,11 @@ ___
___
#### upsertCondition
### upsertCondition
`**upsertCondition**(data, overrideExisting?): Promise&#60;([DiscountConditionProduct](DiscountConditionProduct.mdx) \| [DiscountConditionProductType](DiscountConditionProductType.mdx) \| [DiscountConditionProductCollection](DiscountConditionProductCollection.mdx) \| [DiscountConditionProductTag](DiscountConditionProductTag.mdx) \| [DiscountConditionCustomerGroup](DiscountConditionCustomerGroup.mdx))[]&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -367,7 +387,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;([DiscountConditionProduct](DiscountConditionProduct.mdx) \| [DiscountConditionProductType](DiscountConditionProductType.mdx) \| [DiscountConditionProductCollection](DiscountConditionProductCollection.mdx) \| [DiscountConditionProductTag](DiscountConditionProductTag.mdx) \| [DiscountConditionCustomerGroup](DiscountConditionCustomerGroup.mdx))[]&#62;
@@ -385,11 +405,11 @@ Promise&#60;([DiscountConditionProduct](DiscountConditionProduct.mdx) \| [Discou
___
#### withTransaction
### withTransaction
`**withTransaction**(transactionManager?): [DiscountConditionService](DiscountConditionService.mdx)`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -403,7 +423,7 @@ ___
}
]} />
##### Returns
#### Returns
[DiscountConditionService](DiscountConditionService.mdx)
@@ -421,11 +441,11 @@ ___
___
#### resolveConditionType\_
### resolveConditionType\_
`Static Protected **resolveConditionType_**(data): undefined \| &#123; resource_ids: (string \| &#123; id: string &#125;)[] ; type: [DiscountConditionType](../enums/DiscountConditionType.mdx) &#125;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -439,7 +459,7 @@ ___
}
]} />
##### Returns
#### Returns
`undefined` \| ``{ resource_ids: (string \| &#123; id: string &#125;)[] ; type: [DiscountConditionType](../enums/DiscountConditionType.mdx) }``