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

docs: migrate guides to TSDoc references (#6100)

Browse Source
This commit is contained in:
Shahed Nasser
2024-01-22 18:38:35 +01:00
committed by GitHub
parent 85dad169bb
commit 4792c55226
980 changed files with 195537 additions and 160619 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/services/classes/services.PaymentProviderService.mdx
+6 -60
View File
@@ -30,8 +30,6 @@ ___
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### paymentService\_
#### Returns
@@ -60,8 +58,6 @@ transaction manager is created.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
### authorizePayment
#### Parameters
@@ -72,8 +68,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;undefined \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### buildPaymentProcessorContext
Build the create session context for both legacy and new API
@@ -86,8 +80,6 @@ Build the create session context for both legacy and new API
<ParameterTypes parameters={[{"name":"Cart","type":"`object`","description":"A cart represents a virtual shopping bag. It can be used to complete an order, a swap, or a claim.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"PaymentContext","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
### cancelPayment
#### Parameters
@@ -98,8 +90,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Payment](../../entities/classes/entities.Payment.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### capturePayment
#### Parameters
@@ -110,8 +100,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Payment](../../entities/classes/entities.Payment.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### createPayment
#### Parameters
@@ -122,8 +110,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Payment](../../entities/classes/entities.Payment.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### createSession
`**createSession**(providerId, cart): Promise&#60;[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)&#62;`
@@ -148,9 +134,7 @@ Creates a payment session with the given provider.
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)&#62;","optional":false,"defaultValue":"","description":"Creates a payment session with the given provider.","expandable":false,"children":[]}]} />
### deleteSession
@@ -162,8 +146,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;undefined \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### getStatus
#### Parameters
@@ -174,16 +156,12 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PaymentSessionStatus](../../entities/enums/entities.PaymentSessionStatus.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### list
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### listPayments
List all the payments according to the given selector and config.
@@ -194,9 +172,7 @@ List all the payments according to the given selector and config.
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Payment](../../entities/classes/entities.Payment.mdx)[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Payment](../../entities/classes/entities.Payment.mdx)[]&#62;","optional":false,"defaultValue":"","description":"List all the payments according to the given selector and config.","expandable":false,"children":[]}]} />
### processUpdateRequestsData
@@ -208,9 +184,7 @@ Process the collected data. Can be used every time we need to process some colle
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"Process the collected data. Can be used every time we need to process some collected data returned by the provider","expandable":false,"children":[]}]} />
### refreshSession
@@ -225,8 +199,6 @@ This means, that we delete the current one and create a new.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)&#62;","optional":false,"defaultValue":"","description":"the payment session","expandable":false,"children":[]}]} />
___
### refundFromPayment
#### Parameters
@@ -237,8 +209,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Refund](../../entities/classes/entities.Refund.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### refundPayment
#### Parameters
@@ -249,8 +219,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Refund](../../entities/classes/entities.Refund.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### registerInstalledProviders
#### Parameters
@@ -261,8 +229,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### retrievePayment
Retrieve a payment entity with the given id.
@@ -273,9 +239,7 @@ Retrieve a payment entity with the given id.
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Payment](../../entities/classes/entities.Payment.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Payment](../../entities/classes/entities.Payment.mdx)&#62;","optional":false,"defaultValue":"","description":"Retrieve a payment entity with the given id.","expandable":false,"children":[]}]} />
### retrieveProvider
@@ -293,8 +257,6 @@ Finds a provider given an id
<ParameterTypes parameters={[{"name":"TProvider extends AbstractPaymentService ? AbstractPaymentService : TProvider extends AbstractPaymentProcessor ? AbstractPaymentProcessor : any","type":"TProvider extends [AbstractPaymentService](../../medusa/classes/medusa.AbstractPaymentService.mdx) ? [AbstractPaymentService](../../medusa/classes/medusa.AbstractPaymentService.mdx) : TProvider extends [AbstractPaymentProcessor](../../medusa/classes/medusa.AbstractPaymentProcessor.mdx) ? [AbstractPaymentProcessor](../../medusa/classes/medusa.AbstractPaymentProcessor.mdx) : `any`","optional":false,"defaultValue":"","description":"the payment provider","expandable":false,"children":[]}]} />
___
### retrieveRefund
#### Parameters
@@ -305,8 +267,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Refund](../../entities/classes/entities.Refund.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### retrieveSession
Return the payment session for the given id.
@@ -317,9 +277,7 @@ Return the payment session for the given id.
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)&#62;","optional":false,"defaultValue":"","description":"Return the payment session for the given id.","expandable":false,"children":[]}]} />
### saveSession
@@ -331,9 +289,7 @@ Create or update a Payment session data.
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)&#62;","optional":false,"defaultValue":"","description":"Create or update a Payment session data.","expandable":false,"children":[]}]} />
### shouldRetryTransaction\_
@@ -345,8 +301,6 @@ ___
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### throwFromPaymentProcessorError
#### Parameters
@@ -357,8 +311,6 @@ ___
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### updatePayment
#### Parameters
@@ -369,8 +321,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Payment](../../entities/classes/entities.Payment.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### updateSession
Update a payment session with the given provider.
@@ -383,8 +333,6 @@ Update a payment session with the given provider.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)&#62;","optional":false,"defaultValue":"","description":"the payment session","expandable":false,"children":[]}]} />
___
### updateSessionData
#### Parameters
@@ -395,8 +343,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### withTransaction
#### Parameters