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

196
www/apps/docs/content/references/services/classes/DiscountService.mdx
View File

@@ -12,11 +12,11 @@ Provides layer to manipulate discounts.
## Constructors
### constructor
#### constructor
`**new DiscountService**(«destructured»)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -190,35 +190,19 @@ Provides layer to manipulate discounts.
## 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
### addRegion
#### addRegion
`**addRegion**(discountId, regionId): Promise&#60;[Discount](Discount.mdx)&#62;`
Adds a region to the discount regions array.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -241,7 +225,7 @@ Adds a region to the discount regions array.
}
]} />
#### Returns
##### Returns
Promise&#60;[Discount](Discount.mdx)&#62;
@@ -259,7 +243,7 @@ Promise&#60;[Discount](Discount.mdx)&#62;
___
### atomicPhase\_
#### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -267,6 +251,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",
@@ -288,7 +274,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -320,7 +306,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -338,11 +324,11 @@ Promise&#60;TResult&#62;
___
### calculateDiscountForLineItem
#### calculateDiscountForLineItem
`**calculateDiscountForLineItem**(discountId, lineItem, calculationContextData): Promise&#60;number&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -374,7 +360,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;number&#62;
@@ -392,11 +378,11 @@ Promise&#60;number&#62;
___
### canApplyForCustomer
#### canApplyForCustomer
`**canApplyForCustomer**(discountRuleId, customerId): Promise&#60;boolean&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -419,7 +405,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;boolean&#62;
@@ -437,14 +423,14 @@ Promise&#60;boolean&#62;
___
### create
#### create
`**create**(discount): Promise&#60;[Discount](Discount.mdx)&#62;`
Creates a discount with provided data given that the data is validated.
Normalizes discount code to uppercase.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -458,7 +444,7 @@ Normalizes discount code to uppercase.
}
]} />
#### Returns
##### Returns
Promise&#60;[Discount](Discount.mdx)&#62;
@@ -476,13 +462,13 @@ Promise&#60;[Discount](Discount.mdx)&#62;
___
### createDynamicCode
#### createDynamicCode
`**createDynamicCode**(discountId, data): Promise&#60;[Discount](Discount.mdx)&#62;`
Creates a dynamic code for a discount id.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -505,7 +491,7 @@ Creates a dynamic code for a discount id.
}
]} />
#### Returns
##### Returns
Promise&#60;[Discount](Discount.mdx)&#62;
@@ -523,13 +509,13 @@ Promise&#60;[Discount](Discount.mdx)&#62;
___
### delete
#### delete
`**delete**(discountId): Promise&#60;void&#62;`
Deletes a discount idempotently
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -543,7 +529,7 @@ Deletes a discount idempotently
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -561,13 +547,13 @@ Promise&#60;void&#62;
___
### deleteDynamicCode
#### deleteDynamicCode
`**deleteDynamicCode**(discountId, code): Promise&#60;void&#62;`
Deletes a dynamic code for a discount id.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -590,7 +576,7 @@ Deletes a dynamic code for a discount id.
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -608,11 +594,11 @@ Promise&#60;void&#62;
___
### hasCustomersGroupCondition
#### hasCustomersGroupCondition
`**hasCustomersGroupCondition**(discount): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -626,7 +612,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -644,11 +630,11 @@ ___
___
### hasExpired
#### hasExpired
`**hasExpired**(discount): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -662,7 +648,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -680,11 +666,11 @@ ___
___
### hasNotStarted
#### hasNotStarted
`**hasNotStarted**(discount): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -698,7 +684,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -716,11 +702,11 @@ ___
___
### hasReachedLimit
#### hasReachedLimit
`**hasReachedLimit**(discount): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -734,7 +720,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -752,11 +738,11 @@ ___
___
### isDisabled
#### isDisabled
`**isDisabled**(discount): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -770,7 +756,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -788,11 +774,11 @@ ___
___
### isValidForRegion
#### isValidForRegion
`**isValidForRegion**(discount, region_id): Promise&#60;boolean&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -815,7 +801,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;boolean&#62;
@@ -833,11 +819,11 @@ Promise&#60;boolean&#62;
___
### list
#### list
`**list**(selector?, config?): Promise&#60;[Discount](Discount.mdx)[]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -860,7 +846,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[Discount](Discount.mdx)[]&#62;
@@ -878,11 +864,11 @@ Promise&#60;[Discount](Discount.mdx)[]&#62;
___
### listAndCount
#### listAndCount
`**listAndCount**(selector?, config?): Promise&#60;[[Discount](Discount.mdx)[], number]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -905,7 +891,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[[Discount](Discount.mdx)[], number]&#62;
@@ -923,13 +909,13 @@ Promise&#60;[[Discount](Discount.mdx)[], number]&#62;
___
### listByCodes
#### listByCodes
`**listByCodes**(discountCodes, config?): Promise&#60;[Discount](Discount.mdx)[]&#62;`
List all the discounts corresponding to the given codes
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -952,7 +938,7 @@ List all the discounts corresponding to the given codes
}
]} />
#### Returns
##### Returns
Promise&#60;[Discount](Discount.mdx)[]&#62;
@@ -970,13 +956,13 @@ Promise&#60;[Discount](Discount.mdx)[]&#62;
___
### removeRegion
#### removeRegion
`**removeRegion**(discountId, regionId): Promise&#60;[Discount](Discount.mdx)&#62;`
Removes a region from the discount regions array.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -999,7 +985,7 @@ Removes a region from the discount regions array.
}
]} />
#### Returns
##### Returns
Promise&#60;[Discount](Discount.mdx)&#62;
@@ -1017,13 +1003,13 @@ Promise&#60;[Discount](Discount.mdx)&#62;
___
### retrieve
#### retrieve
`**retrieve**(discountId, config?): Promise&#60;[Discount](Discount.mdx)&#62;`
Gets a discount by id.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1046,7 +1032,7 @@ Gets a discount by id.
}
]} />
#### Returns
##### Returns
Promise&#60;[Discount](Discount.mdx)&#62;
@@ -1064,13 +1050,13 @@ Promise&#60;[Discount](Discount.mdx)&#62;
___
### retrieveByCode
#### retrieveByCode
`**retrieveByCode**(discountCode, config?): Promise&#60;[Discount](Discount.mdx)&#62;`
Gets the discount by discount code.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1093,7 +1079,7 @@ Gets the discount by discount code.
}
]} />
#### Returns
##### Returns
Promise&#60;[Discount](Discount.mdx)&#62;
@@ -1111,11 +1097,11 @@ Promise&#60;[Discount](Discount.mdx)&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1129,7 +1115,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -1147,13 +1133,13 @@ ___
___
### update
#### update
`**update**(discountId, update): Promise&#60;[Discount](Discount.mdx)&#62;`
Updates a discount.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1176,7 +1162,7 @@ Updates a discount.
}
]} />
#### Returns
##### Returns
Promise&#60;[Discount](Discount.mdx)&#62;
@@ -1194,11 +1180,11 @@ Promise&#60;[Discount](Discount.mdx)&#62;
___
### validateDiscountForCartOrThrow
#### validateDiscountForCartOrThrow
`**validateDiscountForCartOrThrow**(cart, discount): Promise&#60;void&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1221,7 +1207,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -1239,11 +1225,11 @@ Promise&#60;void&#62;
___
### validateDiscountForProduct
#### validateDiscountForProduct
`**validateDiscountForProduct**(discountRuleId, productId?): Promise&#60;boolean&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1266,7 +1252,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;boolean&#62;
@@ -1284,12 +1270,14 @@ Promise&#60;boolean&#62;
___
### validateDiscountRule\_
#### validateDiscountRule\_
`**validateDiscountRule_**<TypeParameter T>(discountRule): T`
Creates a discount rule with provided data given that the data is validated.
##### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
@@ -1302,7 +1290,7 @@ Creates a discount rule with provided data given that the data is validated.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1316,19 +1304,29 @@ Creates a discount rule with provided data given that the data is validated.
}
]} />
#### Returns
##### Returns
`T`
<ParameterTypes parameters={[]} />
<ParameterTypes parameters={[
{
"name": "T",
"type": "`T`",
"optional": false,
"defaultValue": "",
"description": "the result of the create operation",
"expandable": false,
"children": []
}
]} />
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [DiscountService](DiscountService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1342,7 +1340,7 @@ ___
}
]} />
#### Returns
##### Returns
[DiscountService](DiscountService.mdx)