asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: migrate guides to TSDoc references (#6100)

Browse Source
This commit is contained in:
Shahed Nasser
2024-01-22 19:38:35 +02:00
committed by GitHub
parent 85dad169bb
commit 4792c55226
980 changed files with 195537 additions and 160619 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -52,8 +52,6 @@ transaction manager is created.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
### create
Creates a gift card with provided data given that the data is validated.
@@ -66,8 +64,6 @@ Creates a gift card with provided data given that the data is validated.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of the create operation","expandable":false,"children":[]}]} />
___
### createTransaction
#### Parameters
@@ -78,8 +74,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;string&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### delete
Deletes a gift card idempotently
@@ -92,8 +86,6 @@ Deletes a gift card idempotently
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void \\| [GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of the delete operation","expandable":false,"children":[]}]} />
___
### list
#### Parameters
@@ -104,8 +96,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
___
### listAndCount
#### Parameters
@@ -116,8 +106,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[[GiftCard](../../entities/classes/entities.GiftCard.mdx)[], number]&#62;","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
___
### retrieve
Gets a gift card by id.
@@ -130,8 +118,6 @@ Gets a gift card by id.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;","optional":false,"defaultValue":"","description":"the gift card","expandable":false,"children":[]}]} />
___
### retrieveByCode
#### Parameters
@@ -142,8 +128,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### retrieve\_
#### Parameters
@@ -154,8 +138,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### shouldRetryTransaction\_
#### Parameters
@@ -166,8 +148,6 @@ ___
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### update
Updates a giftCard.
@@ -180,8 +160,6 @@ Updates a giftCard.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
___
### withTransaction
#### Parameters
@@ -192,8 +170,6 @@ ___
<ParameterTypes parameters={[{"name":"this","type":"`this`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### generateCode
Generates a 16 character gift card code
@@ -202,8 +178,6 @@ Generates a 16 character gift card code
<ParameterTypes parameters={[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"the generated gift card code","expandable":false,"children":[]}]} />
___
### resolveTaxRate
The tax\_rate of the giftcard can depend on whether regions tax gift cards, an input