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

98
www/apps/docs/content/references/services/classes/CustomerGroupService.mdx
View File

@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Constructors
### constructor
#### constructor
`**new CustomerGroupService**(«destructured»)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -96,35 +96,19 @@ 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
### addCustomers
#### addCustomers
`**addCustomers**(id, customerIds): Promise&#60;[CustomerGroup](CustomerGroup.mdx)&#62;`
Add a batch of customers to a customer group at once
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -147,7 +131,7 @@ Add a batch of customers to a customer group at once
}
]} />
#### Returns
##### Returns
Promise&#60;[CustomerGroup](CustomerGroup.mdx)&#62;
@@ -165,7 +149,7 @@ Promise&#60;[CustomerGroup](CustomerGroup.mdx)&#62;
___
### 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,13 +230,13 @@ Promise&#60;TResult&#62;
___
### create
#### create
`**create**(group): Promise&#60;[CustomerGroup](CustomerGroup.mdx)&#62;`
Creates a customer group with the provided data.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -264,7 +250,7 @@ Creates a customer group with the provided data.
}
]} />
#### Returns
##### Returns
Promise&#60;[CustomerGroup](CustomerGroup.mdx)&#62;
@@ -282,13 +268,13 @@ Promise&#60;[CustomerGroup](CustomerGroup.mdx)&#62;
___
### delete
#### delete
`**delete**(groupId): Promise&#60;void&#62;`
Remove customer group
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -302,7 +288,7 @@ Remove customer group
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -320,11 +306,11 @@ Promise&#60;void&#62;
___
### handleCreationFail
#### handleCreationFail
`Private **handleCreationFail**(id, ids, error): Promise&#60;never&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -356,7 +342,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;never&#62;
@@ -374,13 +360,13 @@ Promise&#60;never&#62;
___
### list
#### list
`**list**(selector?, config): Promise&#60;[CustomerGroup](CustomerGroup.mdx)[]&#62;`
List customer groups.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -403,7 +389,7 @@ List customer groups.
}
]} />
#### Returns
##### Returns
Promise&#60;[CustomerGroup](CustomerGroup.mdx)[]&#62;
@@ -421,13 +407,13 @@ Promise&#60;[CustomerGroup](CustomerGroup.mdx)[]&#62;
___
### listAndCount
#### listAndCount
`**listAndCount**(selector?, config): Promise&#60;[[CustomerGroup](CustomerGroup.mdx)[], number]&#62;`
Retrieve a list of customer groups and total count of records that match the query.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -450,7 +436,7 @@ Retrieve a list of customer groups and total count of records that match the que
}
]} />
#### Returns
##### Returns
Promise&#60;[[CustomerGroup](CustomerGroup.mdx)[], number]&#62;
@@ -468,13 +454,13 @@ Promise&#60;[[CustomerGroup](CustomerGroup.mdx)[], number]&#62;
___
### removeCustomer
#### removeCustomer
`**removeCustomer**(id, customerIds): Promise&#60;[CustomerGroup](CustomerGroup.mdx)&#62;`
Remove list of customers from a customergroup
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -497,7 +483,7 @@ Remove list of customers from a customergroup
}
]} />
#### Returns
##### Returns
Promise&#60;[CustomerGroup](CustomerGroup.mdx)&#62;
@@ -515,11 +501,11 @@ Promise&#60;[CustomerGroup](CustomerGroup.mdx)&#62;
___
### retrieve
#### retrieve
`**retrieve**(customerGroupId, config?): Promise&#60;[CustomerGroup](CustomerGroup.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -542,7 +528,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[CustomerGroup](CustomerGroup.mdx)&#62;
@@ -560,11 +546,11 @@ Promise&#60;[CustomerGroup](CustomerGroup.mdx)&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -578,7 +564,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -596,13 +582,13 @@ ___
___
### update
#### update
`**update**(customerGroupId, update): Promise&#60;[CustomerGroup](CustomerGroup.mdx)&#62;`
Update a customer group.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -625,7 +611,7 @@ Update a customer group.
}
]} />
#### Returns
##### Returns
Promise&#60;[CustomerGroup](CustomerGroup.mdx)&#62;
@@ -643,11 +629,11 @@ Promise&#60;[CustomerGroup](CustomerGroup.mdx)&#62;
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [CustomerGroupService](CustomerGroupService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -661,7 +647,7 @@ ___
}
]} />
#### Returns
##### Returns
[CustomerGroupService](CustomerGroupService.mdx)