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

74
www/apps/docs/content/references/services/classes/PaymentService.mdx
View File

@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Constructors
### constructor
#### constructor
`**new PaymentService**(«destructured»)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -168,29 +168,13 @@ 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
### atomicPhase\_
#### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -198,6 +182,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",
@@ -219,7 +205,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -251,7 +237,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -269,13 +255,13 @@ Promise&#60;TResult&#62;
___
### capture
#### capture
`**capture**(paymentOrId): Promise&#60;[Payment](Payment.mdx)&#62;`
Captures a payment.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -289,7 +275,7 @@ Captures a payment.
}
]} />
#### Returns
##### Returns
Promise&#60;[Payment](Payment.mdx)&#62;
@@ -307,13 +293,13 @@ Promise&#60;[Payment](Payment.mdx)&#62;
___
### create
#### create
`**create**(paymentInput): Promise&#60;[Payment](Payment.mdx)&#62;`
Created a new payment.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -327,7 +313,7 @@ Created a new payment.
}
]} />
#### Returns
##### Returns
Promise&#60;[Payment](Payment.mdx)&#62;
@@ -345,13 +331,13 @@ Promise&#60;[Payment](Payment.mdx)&#62;
___
### refund
#### refund
`**refund**(paymentOrId, amount, reason, note?): Promise&#60;[Refund](Refund.mdx)&#62;`
refunds a payment.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -392,7 +378,7 @@ refunds a payment.
}
]} />
#### Returns
##### Returns
Promise&#60;[Refund](Refund.mdx)&#62;
@@ -410,13 +396,13 @@ Promise&#60;[Refund](Refund.mdx)&#62;
___
### retrieve
#### retrieve
`**retrieve**(paymentId, config?): Promise&#60;[Payment](Payment.mdx)&#62;`
Retrieves a payment by id.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -439,7 +425,7 @@ Retrieves a payment by id.
}
]} />
#### Returns
##### Returns
Promise&#60;[Payment](Payment.mdx)&#62;
@@ -457,11 +443,11 @@ Promise&#60;[Payment](Payment.mdx)&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -475,7 +461,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -493,13 +479,13 @@ ___
___
### update
#### update
`**update**(paymentId, data): Promise&#60;[Payment](Payment.mdx)&#62;`
Updates a payment in order to link it to an order or a swap.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -540,7 +526,7 @@ Updates a payment in order to link it to an order or a swap.
}
]} />
#### Returns
##### Returns
Promise&#60;[Payment](Payment.mdx)&#62;
@@ -558,11 +544,11 @@ Promise&#60;[Payment](Payment.mdx)&#62;
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [PaymentService](PaymentService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -576,7 +562,7 @@ ___
}
]} />
#### Returns
##### Returns
[PaymentService](PaymentService.mdx)