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

104
www/apps/docs/content/references/services/classes/SystemPaymentProviderService.mdx
View File

@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Constructors
### constructor
#### constructor
`**new SystemPaymentProviderService**(_)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -87,29 +87,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;`
@@ -117,6 +101,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",
@@ -138,7 +124,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -170,7 +156,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -188,11 +174,11 @@ Promise&#60;TResult&#62;
___
### authorizePayment
#### authorizePayment
`**authorizePayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -206,7 +192,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;Record&#60;string, unknown&#62;&#62;
@@ -224,11 +210,11 @@ Promise&#60;Record&#60;string, unknown&#62;&#62;
___
### cancelPayment
#### cancelPayment
`**cancelPayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -242,7 +228,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;Record&#60;string, unknown&#62;&#62;
@@ -260,11 +246,11 @@ Promise&#60;Record&#60;string, unknown&#62;&#62;
___
### capturePayment
#### capturePayment
`**capturePayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -278,7 +264,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;Record&#60;string, unknown&#62;&#62;
@@ -296,11 +282,11 @@ Promise&#60;Record&#60;string, unknown&#62;&#62;
___
### createPayment
#### createPayment
`**createPayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -314,7 +300,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;Record&#60;string, unknown&#62;&#62;
@@ -332,11 +318,11 @@ Promise&#60;Record&#60;string, unknown&#62;&#62;
___
### deletePayment
#### deletePayment
`**deletePayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -350,7 +336,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;Record&#60;string, unknown&#62;&#62;
@@ -368,11 +354,11 @@ Promise&#60;Record&#60;string, unknown&#62;&#62;
___
### getPaymentData
#### getPaymentData
`**getPaymentData**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -386,7 +372,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;Record&#60;string, unknown&#62;&#62;
@@ -404,11 +390,11 @@ Promise&#60;Record&#60;string, unknown&#62;&#62;
___
### getStatus
#### getStatus
`**getStatus**(_): Promise&#60;string&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -422,7 +408,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;string&#62;
@@ -440,11 +426,11 @@ Promise&#60;string&#62;
___
### refundPayment
#### refundPayment
`**refundPayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -458,7 +444,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;Record&#60;string, unknown&#62;&#62;
@@ -476,11 +462,11 @@ Promise&#60;Record&#60;string, unknown&#62;&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -494,7 +480,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -512,11 +498,11 @@ ___
___
### updatePayment
#### updatePayment
`**updatePayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -530,7 +516,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;Record&#60;string, unknown&#62;&#62;
@@ -548,11 +534,11 @@ Promise&#60;Record&#60;string, unknown&#62;&#62;
___
### updatePaymentData
#### updatePaymentData
`**updatePaymentData**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -566,7 +552,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;Record&#60;string, unknown&#62;&#62;
@@ -584,11 +570,11 @@ Promise&#60;Record&#60;string, unknown&#62;&#62;
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [SystemPaymentProviderService](SystemPaymentProviderService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -602,7 +588,7 @@ ___
}
]} />
#### Returns
##### Returns
[SystemPaymentProviderService](SystemPaymentProviderService.mdx)