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

108
www/apps/docs/content/references/services/classes/GiftCardService.mdx
View File

@@ -10,11 +10,11 @@ Provides layer to manipulate gift cards.
## Constructors
### constructor
#### constructor
`**new GiftCardService**(«destructured»)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -134,29 +134,13 @@ Provides layer to manipulate gift cards.
## 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
### atomicPhase\_
#### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -164,6 +148,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",
@@ -185,7 +171,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -217,7 +203,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -235,13 +221,13 @@ Promise&#60;TResult&#62;
___
### create
#### create
`**create**(giftCard): Promise&#60;[GiftCard](GiftCard.mdx)&#62;`
Creates a gift card with provided data given that the data is validated.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -255,7 +241,7 @@ Creates a gift card with provided data given that the data is validated.
}
]} />
#### Returns
##### Returns
Promise&#60;[GiftCard](GiftCard.mdx)&#62;
@@ -273,11 +259,11 @@ Promise&#60;[GiftCard](GiftCard.mdx)&#62;
___
### createTransaction
#### createTransaction
`**createTransaction**(data): Promise&#60;string&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -291,7 +277,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;string&#62;
@@ -309,13 +295,13 @@ Promise&#60;string&#62;
___
### delete
#### delete
`**delete**(giftCardId): Promise&#60;void \| [GiftCard](GiftCard.mdx)&#62;`
Deletes a gift card idempotently
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -329,7 +315,7 @@ Deletes a gift card idempotently
}
]} />
#### Returns
##### Returns
Promise&#60;void \| [GiftCard](GiftCard.mdx)&#62;
@@ -347,11 +333,11 @@ Promise&#60;void \| [GiftCard](GiftCard.mdx)&#62;
___
### list
#### list
`**list**(selector?, config?): Promise&#60;[GiftCard](GiftCard.mdx)[]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -374,7 +360,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[GiftCard](GiftCard.mdx)[]&#62;
@@ -392,11 +378,11 @@ Promise&#60;[GiftCard](GiftCard.mdx)[]&#62;
___
### listAndCount
#### listAndCount
`**listAndCount**(selector?, config?): Promise&#60;[[GiftCard](GiftCard.mdx)[], number]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -419,7 +405,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[[GiftCard](GiftCard.mdx)[], number]&#62;
@@ -437,13 +423,13 @@ Promise&#60;[[GiftCard](GiftCard.mdx)[], number]&#62;
___
### retrieve
#### retrieve
`**retrieve**(giftCardId, config?): Promise&#60;[GiftCard](GiftCard.mdx)&#62;`
Gets a gift card by id.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -466,7 +452,7 @@ Gets a gift card by id.
}
]} />
#### Returns
##### Returns
Promise&#60;[GiftCard](GiftCard.mdx)&#62;
@@ -484,11 +470,11 @@ Promise&#60;[GiftCard](GiftCard.mdx)&#62;
___
### retrieveByCode
#### retrieveByCode
`**retrieveByCode**(code, config?): Promise&#60;[GiftCard](GiftCard.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -511,7 +497,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[GiftCard](GiftCard.mdx)&#62;
@@ -529,11 +515,11 @@ Promise&#60;[GiftCard](GiftCard.mdx)&#62;
___
### retrieve\_
#### retrieve\_
`Protected **retrieve_**(selector, config?): Promise&#60;[GiftCard](GiftCard.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -556,7 +542,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[GiftCard](GiftCard.mdx)&#62;
@@ -574,11 +560,11 @@ Promise&#60;[GiftCard](GiftCard.mdx)&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -592,7 +578,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -610,13 +596,13 @@ ___
___
### update
#### update
`**update**(giftCardId, update): Promise&#60;[GiftCard](GiftCard.mdx)&#62;`
Updates a giftCard.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -639,7 +625,7 @@ Updates a giftCard.
}
]} />
#### Returns
##### Returns
Promise&#60;[GiftCard](GiftCard.mdx)&#62;
@@ -657,11 +643,11 @@ Promise&#60;[GiftCard](GiftCard.mdx)&#62;
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [GiftCardService](GiftCardService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -675,7 +661,7 @@ ___
}
]} />
#### Returns
##### Returns
[GiftCardService](GiftCardService.mdx)
@@ -693,13 +679,13 @@ ___
___
### generateCode
#### generateCode
`Static **generateCode**(): string`
Generates a 16 character gift card code
#### Returns
##### Returns
`string`
@@ -717,14 +703,14 @@ Generates a 16 character gift card code
___
### resolveTaxRate
#### resolveTaxRate
`Static Protected **resolveTaxRate**(giftCardTaxRate, region): null \| number`
The tax\_rate of the giftcard can depend on whether regions tax gift cards, an input
provided by the user or the tax rate. Based on these conditions, tax\_rate changes.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -747,7 +733,7 @@ provided by the user or the tax rate. Based on these conditions, tax\_rate chang
}
]} />
#### Returns
##### Returns
`null` \| `number`