docs: TSDoc + reference of fulfillment service (#5761)
This commit is contained in:
@@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
This will be
|
||||
|
||||
#### Deprecated
|
||||
## Deprecated
|
||||
|
||||
in the near future use the AbstractPaymentProcessor instead
|
||||
|
||||
@@ -16,13 +16,11 @@ in the near future use the AbstractPaymentProcessor instead
|
||||
|
||||
- ["medusa-interfaces"](../modules/medusa_interfaces_.mdx)
|
||||
|
||||
## Constructors
|
||||
|
||||
#### constructor
|
||||
## constructor
|
||||
|
||||
`Protected **new AbstractPaymentService**(container, config?)`
|
||||
|
||||
##### Parameters
|
||||
### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -45,6 +43,8 @@ in the near future use the AbstractPaymentProcessor instead
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
@@ -104,15 +104,35 @@ in the near future use the AbstractPaymentProcessor instead
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
## 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<TResult>`
|
||||
|
||||
@@ -120,7 +140,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={[
|
||||
{
|
||||
@@ -143,7 +163,7 @@ transaction manager is created.
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -175,7 +195,7 @@ transaction manager is created.
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<TResult>
|
||||
|
||||
@@ -193,11 +213,11 @@ Promise<TResult>
|
||||
|
||||
___
|
||||
|
||||
#### authorizePayment
|
||||
### authorizePayment
|
||||
|
||||
`Abstract **authorizePayment**(paymentSession, context): Promise<{ data: [Data](../types/Data.mdx) ; status: [PaymentSessionStatus](../enums/PaymentSessionStatus.mdx) }>`
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -220,7 +240,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<{ data: [Data](../types/Data.mdx) ; status: [PaymentSessionStatus](../enums/PaymentSessionStatus.mdx) }>
|
||||
|
||||
@@ -240,13 +260,13 @@ Promise<{ data: [Data](../types/Data.mdx) ; status: [PaymentSessionStat
|
||||
|
||||
___
|
||||
|
||||
#### cancelPayment
|
||||
### cancelPayment
|
||||
|
||||
`Abstract **cancelPayment**(payment): Promise<[Data](../types/Data.mdx)>`
|
||||
|
||||
This will be
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -260,7 +280,7 @@ This will be
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<[Data](../types/Data.mdx)>
|
||||
|
||||
@@ -282,13 +302,13 @@ in the near future
|
||||
|
||||
___
|
||||
|
||||
#### capturePayment
|
||||
### capturePayment
|
||||
|
||||
`Abstract **capturePayment**(payment): Promise<[Data](../types/Data.mdx)>`
|
||||
|
||||
This will be
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -302,7 +322,7 @@ This will be
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<[Data](../types/Data.mdx)>
|
||||
|
||||
@@ -324,11 +344,11 @@ in the near future
|
||||
|
||||
___
|
||||
|
||||
#### createPayment
|
||||
### createPayment
|
||||
|
||||
`Abstract **createPayment**(context): Promise<[PaymentSessionResponse](../types/PaymentSessionResponse.mdx)>`
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -342,7 +362,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<[PaymentSessionResponse](../types/PaymentSessionResponse.mdx)>
|
||||
|
||||
@@ -362,7 +382,7 @@ Promise<[PaymentSessionResponse](../types/PaymentSessionResponse.mdx)>
|
||||
|
||||
This will be
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -376,7 +396,7 @@ This will be
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<[Data](../types/Data.mdx)>
|
||||
|
||||
@@ -398,13 +418,13 @@ in the near future use `createPayment(context: Cart & PaymentContext): Promise<P
|
||||
|
||||
___
|
||||
|
||||
#### deletePayment
|
||||
### deletePayment
|
||||
|
||||
`Abstract **deletePayment**(paymentSession): Promise<void>`
|
||||
|
||||
This will be
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -418,7 +438,7 @@ This will be
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<void>
|
||||
|
||||
@@ -440,11 +460,11 @@ in the near future
|
||||
|
||||
___
|
||||
|
||||
#### getIdentifier
|
||||
### getIdentifier
|
||||
|
||||
`**getIdentifier**(): string`
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
`string`
|
||||
|
||||
@@ -462,11 +482,11 @@ ___
|
||||
|
||||
___
|
||||
|
||||
#### getPaymentData
|
||||
### getPaymentData
|
||||
|
||||
`Abstract **getPaymentData**(paymentSession): Promise<[Data](../types/Data.mdx)>`
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -480,7 +500,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<[Data](../types/Data.mdx)>
|
||||
|
||||
@@ -500,13 +520,13 @@ Promise<[Data](../types/Data.mdx)>
|
||||
|
||||
___
|
||||
|
||||
#### getStatus
|
||||
### getStatus
|
||||
|
||||
`Abstract **getStatus**(data): Promise<[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)>`
|
||||
|
||||
This will be
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -520,7 +540,7 @@ This will be
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)>
|
||||
|
||||
@@ -542,13 +562,13 @@ in the near future
|
||||
|
||||
___
|
||||
|
||||
#### refundPayment
|
||||
### refundPayment
|
||||
|
||||
`Abstract **refundPayment**(payment, refundAmount): Promise<[Data](../types/Data.mdx)>`
|
||||
|
||||
This will be
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -571,7 +591,7 @@ This will be
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<[Data](../types/Data.mdx)>
|
||||
|
||||
@@ -593,11 +613,11 @@ in the near future
|
||||
|
||||
___
|
||||
|
||||
#### retrievePayment
|
||||
### retrievePayment
|
||||
|
||||
`Abstract **retrievePayment**(paymentData): Promise<[Data](../types/Data.mdx)>`
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -611,7 +631,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<[Data](../types/Data.mdx)>
|
||||
|
||||
@@ -631,13 +651,13 @@ Promise<[Data](../types/Data.mdx)>
|
||||
|
||||
___
|
||||
|
||||
#### retrieveSavedMethods
|
||||
### retrieveSavedMethods
|
||||
|
||||
`**retrieveSavedMethods**(customer): Promise<[Data](../types/Data.mdx)[]>`
|
||||
|
||||
This will be
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -651,7 +671,7 @@ This will be
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<[Data](../types/Data.mdx)[]>
|
||||
|
||||
@@ -673,11 +693,11 @@ in the near future
|
||||
|
||||
___
|
||||
|
||||
#### shouldRetryTransaction\_
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
`Protected **shouldRetryTransaction_**(err): boolean`
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -691,7 +711,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
`boolean`
|
||||
|
||||
@@ -709,11 +729,11 @@ ___
|
||||
|
||||
___
|
||||
|
||||
#### updatePayment
|
||||
### updatePayment
|
||||
|
||||
`Abstract **updatePayment**(paymentSessionData, context): Promise<Record<string, unknown> \| [PaymentSessionResponse](../types/PaymentSessionResponse.mdx)>`
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -736,7 +756,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<Record<string, unknown> \| [PaymentSessionResponse](../types/PaymentSessionResponse.mdx)>
|
||||
|
||||
@@ -756,7 +776,7 @@ Promise<Record<string, unknown> \| [PaymentSessionResponse](../types
|
||||
|
||||
This will be
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -779,7 +799,7 @@ This will be
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<[Data](../types/Data.mdx)>
|
||||
|
||||
@@ -801,11 +821,11 @@ in the near future use `updatePayment(paymentSessionData: PaymentSessionData, co
|
||||
|
||||
___
|
||||
|
||||
#### updatePaymentData
|
||||
### updatePaymentData
|
||||
|
||||
`Abstract **updatePaymentData**(paymentSessionData, data): Promise<[Data](../types/Data.mdx)>`
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -828,7 +848,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<[Data](../types/Data.mdx)>
|
||||
|
||||
@@ -848,11 +868,11 @@ Promise<[Data](../types/Data.mdx)>
|
||||
|
||||
___
|
||||
|
||||
#### withTransaction
|
||||
### withTransaction
|
||||
|
||||
`**withTransaction**(transactionManager?): [AbstractPaymentService](AbstractPaymentService.mdx)`
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -866,7 +886,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
[AbstractPaymentService](AbstractPaymentService.mdx)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user