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

docs: TSDoc + reference of fulfillment service (#5761)

Browse Source
This commit is contained in:
Shahed Nasser
2023-11-29 11:58:08 +00:00
committed by GitHub
parent 8f25ed8a10
commit f802e2460f
1479 changed files with 30259 additions and 16135 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -6,13 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# SystemPaymentProviderService
## Constructors
#### constructor
## constructor
`**new SystemPaymentProviderService**(_)`
##### Parameters
### Parameters
<ParameterTypes parameters={[
{
@@ -26,6 +24,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Properties
<ParameterTypes parameters={[
@@ -85,15 +85,35 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Accessors
#### activeManager\_
### activeManager\_
`Protected` **activeManager\_**: [object Object]
`Protected get**activeManager_**(): EntityManager`
#### Returns
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
## Methods
#### atomicPhase\_
### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -101,7 +121,7 @@ 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
#### Type Parameters
<ParameterTypes parameters={[
{
@@ -124,7 +144,7 @@ transaction manager is created.
}
]} />
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -156,7 +176,7 @@ transaction manager is created.
}
]} />
##### Returns
#### Returns
Promise&#60;TResult&#62;
@@ -174,11 +194,11 @@ Promise&#60;TResult&#62;
___
#### authorizePayment
### authorizePayment
`**authorizePayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -192,7 +212,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;Record&#60;string, unknown&#62;&#62;
@@ -210,11 +230,11 @@ Promise&#60;Record&#60;string, unknown&#62;&#62;
___
#### cancelPayment
### cancelPayment
`**cancelPayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -228,7 +248,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;Record&#60;string, unknown&#62;&#62;
@@ -246,11 +266,11 @@ Promise&#60;Record&#60;string, unknown&#62;&#62;
___
#### capturePayment
### capturePayment
`**capturePayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -264,7 +284,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;Record&#60;string, unknown&#62;&#62;
@@ -282,11 +302,11 @@ Promise&#60;Record&#60;string, unknown&#62;&#62;
___
#### createPayment
### createPayment
`**createPayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -300,7 +320,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;Record&#60;string, unknown&#62;&#62;
@@ -318,11 +338,11 @@ Promise&#60;Record&#60;string, unknown&#62;&#62;
___
#### deletePayment
### deletePayment
`**deletePayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -336,7 +356,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;Record&#60;string, unknown&#62;&#62;
@@ -354,11 +374,11 @@ Promise&#60;Record&#60;string, unknown&#62;&#62;
___
#### getPaymentData
### getPaymentData
`**getPaymentData**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -372,7 +392,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;Record&#60;string, unknown&#62;&#62;
@@ -390,11 +410,11 @@ Promise&#60;Record&#60;string, unknown&#62;&#62;
___
#### getStatus
### getStatus
`**getStatus**(_): Promise&#60;string&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -408,7 +428,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;string&#62;
@@ -426,11 +446,11 @@ Promise&#60;string&#62;
___
#### refundPayment
### refundPayment
`**refundPayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -444,7 +464,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;Record&#60;string, unknown&#62;&#62;
@@ -462,11 +482,11 @@ Promise&#60;Record&#60;string, unknown&#62;&#62;
___
#### shouldRetryTransaction\_
### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -480,7 +500,7 @@ ___
}
]} />
##### Returns
#### Returns
`boolean`
@@ -498,11 +518,11 @@ ___
___
#### updatePayment
### updatePayment
`**updatePayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -516,7 +536,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;Record&#60;string, unknown&#62;&#62;
@@ -534,11 +554,11 @@ Promise&#60;Record&#60;string, unknown&#62;&#62;
___
#### updatePaymentData
### updatePaymentData
`**updatePaymentData**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -552,7 +572,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;Record&#60;string, unknown&#62;&#62;
@@ -570,11 +590,11 @@ Promise&#60;Record&#60;string, unknown&#62;&#62;
___
#### withTransaction
### withTransaction
`**withTransaction**(transactionManager?): [SystemPaymentProviderService](SystemPaymentProviderService.mdx)`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -588,7 +608,7 @@ ___
}
]} />
##### Returns
#### Returns
[SystemPaymentProviderService](SystemPaymentProviderService.mdx)