docs: TSDoc + reference of fulfillment service (#5761)
This commit is contained in:
@@ -6,13 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CustomerGroupService
|
||||
|
||||
## Constructors
|
||||
|
||||
#### constructor
|
||||
## constructor
|
||||
|
||||
`**new CustomerGroupService**(«destructured»)`
|
||||
|
||||
##### Parameters
|
||||
### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -26,6 +24,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
@@ -94,21 +94,41 @@ 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
|
||||
|
||||
#### addCustomers
|
||||
### addCustomers
|
||||
|
||||
`**addCustomers**(id, customerIds): Promise<[CustomerGroup](CustomerGroup.mdx)>`
|
||||
|
||||
Add a batch of customers to a customer group at once
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -131,7 +151,7 @@ Add a batch of customers to a customer group at once
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<[CustomerGroup](CustomerGroup.mdx)>
|
||||
|
||||
@@ -149,7 +169,7 @@ Promise<[CustomerGroup](CustomerGroup.mdx)>
|
||||
|
||||
___
|
||||
|
||||
#### atomicPhase\_
|
||||
### atomicPhase\_
|
||||
|
||||
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>`
|
||||
|
||||
@@ -157,7 +177,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={[
|
||||
{
|
||||
@@ -180,7 +200,7 @@ transaction manager is created.
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -212,7 +232,7 @@ transaction manager is created.
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<TResult>
|
||||
|
||||
@@ -230,13 +250,13 @@ Promise<TResult>
|
||||
|
||||
___
|
||||
|
||||
#### create
|
||||
### create
|
||||
|
||||
`**create**(group): Promise<[CustomerGroup](CustomerGroup.mdx)>`
|
||||
|
||||
Creates a customer group with the provided data.
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -250,7 +270,7 @@ Creates a customer group with the provided data.
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<[CustomerGroup](CustomerGroup.mdx)>
|
||||
|
||||
@@ -268,13 +288,13 @@ Promise<[CustomerGroup](CustomerGroup.mdx)>
|
||||
|
||||
___
|
||||
|
||||
#### delete
|
||||
### delete
|
||||
|
||||
`**delete**(groupId): Promise<void>`
|
||||
|
||||
Remove customer group
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -288,7 +308,7 @@ Remove customer group
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<void>
|
||||
|
||||
@@ -306,11 +326,11 @@ Promise<void>
|
||||
|
||||
___
|
||||
|
||||
#### handleCreationFail
|
||||
### handleCreationFail
|
||||
|
||||
`Private **handleCreationFail**(id, ids, error): Promise<never>`
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -342,7 +362,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<never>
|
||||
|
||||
@@ -360,13 +380,13 @@ Promise<never>
|
||||
|
||||
___
|
||||
|
||||
#### list
|
||||
### list
|
||||
|
||||
`**list**(selector?, config): Promise<[CustomerGroup](CustomerGroup.mdx)[]>`
|
||||
|
||||
List customer groups.
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -389,7 +409,7 @@ List customer groups.
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<[CustomerGroup](CustomerGroup.mdx)[]>
|
||||
|
||||
@@ -407,13 +427,13 @@ Promise<[CustomerGroup](CustomerGroup.mdx)[]>
|
||||
|
||||
___
|
||||
|
||||
#### listAndCount
|
||||
### listAndCount
|
||||
|
||||
`**listAndCount**(selector?, config): Promise<[[CustomerGroup](CustomerGroup.mdx)[], number]>`
|
||||
|
||||
Retrieve a list of customer groups and total count of records that match the query.
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -436,7 +456,7 @@ Retrieve a list of customer groups and total count of records that match the que
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<[[CustomerGroup](CustomerGroup.mdx)[], number]>
|
||||
|
||||
@@ -454,13 +474,13 @@ Promise<[[CustomerGroup](CustomerGroup.mdx)[], number]>
|
||||
|
||||
___
|
||||
|
||||
#### removeCustomer
|
||||
### removeCustomer
|
||||
|
||||
`**removeCustomer**(id, customerIds): Promise<[CustomerGroup](CustomerGroup.mdx)>`
|
||||
|
||||
Remove list of customers from a customergroup
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -483,7 +503,7 @@ Remove list of customers from a customergroup
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<[CustomerGroup](CustomerGroup.mdx)>
|
||||
|
||||
@@ -501,11 +521,11 @@ Promise<[CustomerGroup](CustomerGroup.mdx)>
|
||||
|
||||
___
|
||||
|
||||
#### retrieve
|
||||
### retrieve
|
||||
|
||||
`**retrieve**(customerGroupId, config?): Promise<[CustomerGroup](CustomerGroup.mdx)>`
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -528,7 +548,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<[CustomerGroup](CustomerGroup.mdx)>
|
||||
|
||||
@@ -546,11 +566,11 @@ Promise<[CustomerGroup](CustomerGroup.mdx)>
|
||||
|
||||
___
|
||||
|
||||
#### shouldRetryTransaction\_
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
`Protected **shouldRetryTransaction_**(err): boolean`
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -564,7 +584,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
`boolean`
|
||||
|
||||
@@ -582,13 +602,13 @@ ___
|
||||
|
||||
___
|
||||
|
||||
#### update
|
||||
### update
|
||||
|
||||
`**update**(customerGroupId, update): Promise<[CustomerGroup](CustomerGroup.mdx)>`
|
||||
|
||||
Update a customer group.
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -611,7 +631,7 @@ Update a customer group.
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<[CustomerGroup](CustomerGroup.mdx)>
|
||||
|
||||
@@ -629,11 +649,11 @@ Promise<[CustomerGroup](CustomerGroup.mdx)>
|
||||
|
||||
___
|
||||
|
||||
#### withTransaction
|
||||
### withTransaction
|
||||
|
||||
`**withTransaction**(transactionManager?): [CustomerGroupService](CustomerGroupService.mdx)`
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -647,7 +667,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
[CustomerGroupService](CustomerGroupService.mdx)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user