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
www/apps/docs/content/references/services/classes/PaymentProviderService.mdx
+128 -92
View File
@@ -8,13 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Helps retrieve payment providers
## Constructors
#### constructor
## constructor
`**new PaymentProviderService**(container)`
##### Parameters
### Parameters
<ParameterTypes parameters={[
{
@@ -28,6 +26,8 @@ Helps retrieve payment providers
}
]} />
___
## Properties
<ParameterTypes parameters={[
@@ -150,21 +150,57 @@ Helps retrieve payment providers
}
]} />
___
## 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": []
}
]} />
___
#### paymentService\_
### paymentService\_
`Protected` **paymentService\_**: [object Object]
`Protected get**paymentService_**(): [PaymentService](PaymentService.mdx)`
#### Returns
[PaymentService](PaymentService.mdx)
<ParameterTypes parameters={[
{
"name": "default",
"type": "[PaymentService](PaymentService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
## Methods
#### atomicPhase\_
### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -172,7 +208,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={[
{
@@ -195,7 +231,7 @@ transaction manager is created.
}
]} />
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -227,7 +263,7 @@ transaction manager is created.
}
]} />
##### Returns
#### Returns
Promise&#60;TResult&#62;
@@ -245,11 +281,11 @@ Promise&#60;TResult&#62;
___
#### authorizePayment
### authorizePayment
`**authorizePayment**(paymentSession, context): Promise&#60;undefined \| [PaymentSession](PaymentSession.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -272,7 +308,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;undefined \| [PaymentSession](PaymentSession.mdx)&#62;
@@ -290,13 +326,13 @@ Promise&#60;undefined \| [PaymentSession](PaymentSession.mdx)&#62;
___
#### buildPaymentProcessorContext
### buildPaymentProcessorContext
`Protected **buildPaymentProcessorContext**(cartOrData): [Cart](Cart.mdx) & [PaymentContext](../types/PaymentContext.mdx)`
Build the create session context for both legacy and new API
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -310,7 +346,7 @@ Build the create session context for both legacy and new API
}
]} />
##### Returns
#### Returns
[Cart](Cart.mdx) & [PaymentContext](../types/PaymentContext.mdx)
@@ -328,11 +364,11 @@ Build the create session context for both legacy and new API
___
#### cancelPayment
### cancelPayment
`**cancelPayment**(paymentObj): Promise&#60;[Payment](Payment.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -346,7 +382,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[Payment](Payment.mdx)&#62;
@@ -364,11 +400,11 @@ Promise&#60;[Payment](Payment.mdx)&#62;
___
#### capturePayment
### capturePayment
`**capturePayment**(paymentObj): Promise&#60;[Payment](Payment.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -382,7 +418,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[Payment](Payment.mdx)&#62;
@@ -400,11 +436,11 @@ Promise&#60;[Payment](Payment.mdx)&#62;
___
#### createPayment
### createPayment
`**createPayment**(data): Promise&#60;[Payment](Payment.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -418,7 +454,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[Payment](Payment.mdx)&#62;
@@ -436,11 +472,11 @@ Promise&#60;[Payment](Payment.mdx)&#62;
___
#### createSession
### createSession
`**createSession**(providerId, cart): Promise&#60;[PaymentSession](PaymentSession.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -463,7 +499,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[PaymentSession](PaymentSession.mdx)&#62;
@@ -485,7 +521,7 @@ Promise&#60;[PaymentSession](PaymentSession.mdx)&#62;
Creates a payment session with the given provider.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -499,7 +535,7 @@ Creates a payment session with the given provider.
}
]} />
##### Returns
#### Returns
Promise&#60;[PaymentSession](PaymentSession.mdx)&#62;
@@ -517,11 +553,11 @@ Promise&#60;[PaymentSession](PaymentSession.mdx)&#62;
___
#### deleteSession
### deleteSession
`**deleteSession**(paymentSession): Promise&#60;undefined \| [PaymentSession](PaymentSession.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -535,7 +571,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;undefined \| [PaymentSession](PaymentSession.mdx)&#62;
@@ -553,11 +589,11 @@ Promise&#60;undefined \| [PaymentSession](PaymentSession.mdx)&#62;
___
#### getStatus
### getStatus
`**getStatus**(payment): Promise&#60;[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -571,7 +607,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)&#62;
@@ -589,11 +625,11 @@ Promise&#60;[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)&#62;
___
#### list
### list
`**list**(): Promise&#60;[PaymentProvider](PaymentProvider.mdx)[]&#62;`
##### Returns
#### Returns
Promise&#60;[PaymentProvider](PaymentProvider.mdx)[]&#62;
@@ -611,13 +647,13 @@ Promise&#60;[PaymentProvider](PaymentProvider.mdx)[]&#62;
___
#### listPayments
### listPayments
`**listPayments**(selector, config?): Promise&#60;[Payment](Payment.mdx)[]&#62;`
List all the payments according to the given selector and config.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -640,7 +676,7 @@ List all the payments according to the given selector and config.
}
]} />
##### Returns
#### Returns
Promise&#60;[Payment](Payment.mdx)[]&#62;
@@ -658,13 +694,13 @@ Promise&#60;[Payment](Payment.mdx)[]&#62;
___
#### processUpdateRequestsData
### processUpdateRequestsData
`Protected **processUpdateRequestsData**(data?, paymentResponse): Promise&#60;void&#62;`
Process the collected data. Can be used every time we need to process some collected data returned by the provider
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -705,7 +741,7 @@ Process the collected data. Can be used every time we need to process some colle
}
]} />
##### Returns
#### Returns
Promise&#60;void&#62;
@@ -723,14 +759,14 @@ Promise&#60;void&#62;
___
#### refreshSession
### refreshSession
`**refreshSession**(paymentSession, sessionInput): Promise&#60;[PaymentSession](PaymentSession.mdx)&#62;`
Refreshes a payment session with the given provider.
This means, that we delete the current one and create a new.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -780,7 +816,7 @@ This means, that we delete the current one and create a new.
}
]} />
##### Returns
#### Returns
Promise&#60;[PaymentSession](PaymentSession.mdx)&#62;
@@ -798,11 +834,11 @@ Promise&#60;[PaymentSession](PaymentSession.mdx)&#62;
___
#### refundFromPayment
### refundFromPayment
`**refundFromPayment**(payment, amount, reason, note?): Promise&#60;[Refund](Refund.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -843,7 +879,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[Refund](Refund.mdx)&#62;
@@ -861,11 +897,11 @@ Promise&#60;[Refund](Refund.mdx)&#62;
___
#### refundPayment
### refundPayment
`**refundPayment**(payObjs, amount, reason, note?): Promise&#60;[Refund](Refund.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -906,7 +942,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[Refund](Refund.mdx)&#62;
@@ -924,11 +960,11 @@ Promise&#60;[Refund](Refund.mdx)&#62;
___
#### registerInstalledProviders
### registerInstalledProviders
`**registerInstalledProviders**(providerIds): Promise&#60;void&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -942,7 +978,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;void&#62;
@@ -960,13 +996,13 @@ Promise&#60;void&#62;
___
#### retrievePayment
### retrievePayment
`**retrievePayment**(paymentId, relations?): Promise&#60;[Payment](Payment.mdx)&#62;`
Retrieve a payment entity with the given id.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -989,7 +1025,7 @@ Retrieve a payment entity with the given id.
}
]} />
##### Returns
#### Returns
Promise&#60;[Payment](Payment.mdx)&#62;
@@ -1007,13 +1043,13 @@ Promise&#60;[Payment](Payment.mdx)&#62;
___
#### retrieveProvider
### retrieveProvider
`**retrieveProvider**<TypeParameter TProvider>(providerId): TProvider extends [AbstractPaymentService](AbstractPaymentService.mdx) ? [AbstractPaymentService](AbstractPaymentService.mdx) : TProvider extends [AbstractPaymentProcessor](AbstractPaymentProcessor.mdx) ? [AbstractPaymentProcessor](AbstractPaymentProcessor.mdx) : any`
Finds a provider given an id
##### Type Parameters
#### Type Parameters
<ParameterTypes parameters={[
{
@@ -1027,7 +1063,7 @@ Finds a provider given an id
}
]} />
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1041,7 +1077,7 @@ Finds a provider given an id
}
]} />
##### Returns
#### Returns
`TProvider` extends [AbstractPaymentService](AbstractPaymentService.mdx) ? [AbstractPaymentService](AbstractPaymentService.mdx) : `TProvider` extends [AbstractPaymentProcessor](AbstractPaymentProcessor.mdx) ? [AbstractPaymentProcessor](AbstractPaymentProcessor.mdx) : `any`
@@ -1059,11 +1095,11 @@ Finds a provider given an id
___
#### retrieveRefund
### retrieveRefund
`**retrieveRefund**(id, config?): Promise&#60;[Refund](Refund.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1086,7 +1122,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[Refund](Refund.mdx)&#62;
@@ -1104,13 +1140,13 @@ Promise&#60;[Refund](Refund.mdx)&#62;
___
#### retrieveSession
### retrieveSession
`**retrieveSession**(paymentSessionId, relations?): Promise&#60;[PaymentSession](PaymentSession.mdx)&#62;`
Return the payment session for the given id.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1133,7 +1169,7 @@ Return the payment session for the given id.
}
]} />
##### Returns
#### Returns
Promise&#60;[PaymentSession](PaymentSession.mdx)&#62;
@@ -1151,13 +1187,13 @@ Promise&#60;[PaymentSession](PaymentSession.mdx)&#62;
___
#### saveSession
### saveSession
`Protected **saveSession**(providerId, data): Promise&#60;[PaymentSession](PaymentSession.mdx)&#62;`
Create or update a Payment session data.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1243,7 +1279,7 @@ Create or update a Payment session data.
}
]} />
##### Returns
#### Returns
Promise&#60;[PaymentSession](PaymentSession.mdx)&#62;
@@ -1261,11 +1297,11 @@ Promise&#60;[PaymentSession](PaymentSession.mdx)&#62;
___
#### shouldRetryTransaction\_
### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1279,7 +1315,7 @@ ___
}
]} />
##### Returns
#### Returns
`boolean`
@@ -1297,11 +1333,11 @@ ___
___
#### throwFromPaymentProcessorError
### throwFromPaymentProcessorError
`Private **throwFromPaymentProcessorError**(errObj): void`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1315,7 +1351,7 @@ ___
}
]} />
##### Returns
#### Returns
`void`
@@ -1333,11 +1369,11 @@ ___
___
#### updatePayment
### updatePayment
`**updatePayment**(paymentId, data): Promise&#60;[Payment](Payment.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1378,7 +1414,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[Payment](Payment.mdx)&#62;
@@ -1396,13 +1432,13 @@ Promise&#60;[Payment](Payment.mdx)&#62;
___
#### updateSession
### updateSession
`**updateSession**(paymentSession, sessionInput): Promise&#60;[PaymentSession](PaymentSession.mdx)&#62;`
Update a payment session with the given provider.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1452,7 +1488,7 @@ Update a payment session with the given provider.
}
]} />
##### Returns
#### Returns
Promise&#60;[PaymentSession](PaymentSession.mdx)&#62;
@@ -1470,11 +1506,11 @@ Promise&#60;[PaymentSession](PaymentSession.mdx)&#62;
___
#### updateSessionData
### updateSessionData
`**updateSessionData**(paymentSession, data): Promise&#60;[PaymentSession](PaymentSession.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1497,7 +1533,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[PaymentSession](PaymentSession.mdx)&#62;
@@ -1515,11 +1551,11 @@ Promise&#60;[PaymentSession](PaymentSession.mdx)&#62;
___
#### withTransaction
### withTransaction
`**withTransaction**(transactionManager?): [PaymentProviderService](PaymentProviderService.mdx)`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1533,7 +1569,7 @@ ___
}
]} />
##### Returns
#### Returns
[PaymentProviderService](PaymentProviderService.mdx)