chore(docs): Generated References (#5743)
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]
committed by
GitHub
GitHub
parent
dc6b815b12
commit
cdd42dbdcd
@@ -10,11 +10,11 @@ Helps retrieve payment providers
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
#### constructor
|
||||
|
||||
`**new PaymentProviderService**(container)`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -152,51 +152,19 @@ Helps retrieve payment providers
|
||||
|
||||
## 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]
|
||||
|
||||
___
|
||||
|
||||
### paymentService\_
|
||||
#### paymentService\_
|
||||
|
||||
`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": []
|
||||
}
|
||||
]} />
|
||||
`Protected` **paymentService\_**: [object Object]
|
||||
|
||||
## Methods
|
||||
|
||||
### atomicPhase\_
|
||||
#### atomicPhase\_
|
||||
|
||||
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>`
|
||||
|
||||
@@ -204,6 +172,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",
|
||||
@@ -225,7 +195,7 @@ transaction manager is created.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -257,7 +227,7 @@ transaction manager is created.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<TResult>
|
||||
|
||||
@@ -275,11 +245,11 @@ Promise<TResult>
|
||||
|
||||
___
|
||||
|
||||
### authorizePayment
|
||||
#### authorizePayment
|
||||
|
||||
`**authorizePayment**(paymentSession, context): Promise<undefined \| [PaymentSession](PaymentSession.mdx)>`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -302,7 +272,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<undefined \| [PaymentSession](PaymentSession.mdx)>
|
||||
|
||||
@@ -320,13 +290,13 @@ Promise<undefined \| [PaymentSession](PaymentSession.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### 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={[
|
||||
{
|
||||
@@ -340,7 +310,7 @@ Build the create session context for both legacy and new API
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
[Cart](Cart.mdx) & [PaymentContext](../types/PaymentContext.mdx)
|
||||
|
||||
@@ -358,11 +328,11 @@ Build the create session context for both legacy and new API
|
||||
|
||||
___
|
||||
|
||||
### cancelPayment
|
||||
#### cancelPayment
|
||||
|
||||
`**cancelPayment**(paymentObj): Promise<[Payment](Payment.mdx)>`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -376,7 +346,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[Payment](Payment.mdx)>
|
||||
|
||||
@@ -394,11 +364,11 @@ Promise<[Payment](Payment.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### capturePayment
|
||||
#### capturePayment
|
||||
|
||||
`**capturePayment**(paymentObj): Promise<[Payment](Payment.mdx)>`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -412,7 +382,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[Payment](Payment.mdx)>
|
||||
|
||||
@@ -430,11 +400,11 @@ Promise<[Payment](Payment.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### createPayment
|
||||
#### createPayment
|
||||
|
||||
`**createPayment**(data): Promise<[Payment](Payment.mdx)>`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -448,7 +418,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[Payment](Payment.mdx)>
|
||||
|
||||
@@ -466,11 +436,11 @@ Promise<[Payment](Payment.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### createSession
|
||||
#### createSession
|
||||
|
||||
`**createSession**(providerId, cart): Promise<[PaymentSession](PaymentSession.mdx)>`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -493,7 +463,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[PaymentSession](PaymentSession.mdx)>
|
||||
|
||||
@@ -515,7 +485,7 @@ Promise<[PaymentSession](PaymentSession.mdx)>
|
||||
|
||||
Creates a payment session with the given provider.
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -529,7 +499,7 @@ Creates a payment session with the given provider.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[PaymentSession](PaymentSession.mdx)>
|
||||
|
||||
@@ -547,11 +517,11 @@ Promise<[PaymentSession](PaymentSession.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### deleteSession
|
||||
#### deleteSession
|
||||
|
||||
`**deleteSession**(paymentSession): Promise<undefined \| [PaymentSession](PaymentSession.mdx)>`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -565,7 +535,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<undefined \| [PaymentSession](PaymentSession.mdx)>
|
||||
|
||||
@@ -583,11 +553,11 @@ Promise<undefined \| [PaymentSession](PaymentSession.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### getStatus
|
||||
#### getStatus
|
||||
|
||||
`**getStatus**(payment): Promise<[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)>`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -601,7 +571,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)>
|
||||
|
||||
@@ -619,11 +589,11 @@ Promise<[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
#### list
|
||||
|
||||
`**list**(): Promise<[PaymentProvider](PaymentProvider.mdx)[]>`
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[PaymentProvider](PaymentProvider.mdx)[]>
|
||||
|
||||
@@ -641,13 +611,13 @@ Promise<[PaymentProvider](PaymentProvider.mdx)[]>
|
||||
|
||||
___
|
||||
|
||||
### listPayments
|
||||
#### listPayments
|
||||
|
||||
`**listPayments**(selector, config?): Promise<[Payment](Payment.mdx)[]>`
|
||||
|
||||
List all the payments according to the given selector and config.
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -670,7 +640,7 @@ List all the payments according to the given selector and config.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[Payment](Payment.mdx)[]>
|
||||
|
||||
@@ -688,13 +658,13 @@ Promise<[Payment](Payment.mdx)[]>
|
||||
|
||||
___
|
||||
|
||||
### processUpdateRequestsData
|
||||
#### processUpdateRequestsData
|
||||
|
||||
`Protected **processUpdateRequestsData**(data?, paymentResponse): Promise<void>`
|
||||
|
||||
Process the collected data. Can be used every time we need to process some collected data returned by the provider
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -735,7 +705,7 @@ Process the collected data. Can be used every time we need to process some colle
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<void>
|
||||
|
||||
@@ -753,14 +723,14 @@ Promise<void>
|
||||
|
||||
___
|
||||
|
||||
### refreshSession
|
||||
#### refreshSession
|
||||
|
||||
`**refreshSession**(paymentSession, sessionInput): Promise<[PaymentSession](PaymentSession.mdx)>`
|
||||
|
||||
Refreshes a payment session with the given provider.
|
||||
This means, that we delete the current one and create a new.
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -810,7 +780,7 @@ This means, that we delete the current one and create a new.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[PaymentSession](PaymentSession.mdx)>
|
||||
|
||||
@@ -828,11 +798,11 @@ Promise<[PaymentSession](PaymentSession.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### refundFromPayment
|
||||
#### refundFromPayment
|
||||
|
||||
`**refundFromPayment**(payment, amount, reason, note?): Promise<[Refund](Refund.mdx)>`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -873,7 +843,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[Refund](Refund.mdx)>
|
||||
|
||||
@@ -891,11 +861,11 @@ Promise<[Refund](Refund.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### refundPayment
|
||||
#### refundPayment
|
||||
|
||||
`**refundPayment**(payObjs, amount, reason, note?): Promise<[Refund](Refund.mdx)>`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -936,7 +906,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[Refund](Refund.mdx)>
|
||||
|
||||
@@ -954,11 +924,11 @@ Promise<[Refund](Refund.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### registerInstalledProviders
|
||||
#### registerInstalledProviders
|
||||
|
||||
`**registerInstalledProviders**(providerIds): Promise<void>`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -972,7 +942,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<void>
|
||||
|
||||
@@ -990,13 +960,13 @@ Promise<void>
|
||||
|
||||
___
|
||||
|
||||
### retrievePayment
|
||||
#### retrievePayment
|
||||
|
||||
`**retrievePayment**(paymentId, relations?): Promise<[Payment](Payment.mdx)>`
|
||||
|
||||
Retrieve a payment entity with the given id.
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1019,7 +989,7 @@ Retrieve a payment entity with the given id.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[Payment](Payment.mdx)>
|
||||
|
||||
@@ -1037,12 +1007,14 @@ Promise<[Payment](Payment.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### 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
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TProvider",
|
||||
@@ -1055,7 +1027,7 @@ Finds a provider given an id
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1069,7 +1041,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`
|
||||
|
||||
@@ -1087,11 +1059,11 @@ Finds a provider given an id
|
||||
|
||||
___
|
||||
|
||||
### retrieveRefund
|
||||
#### retrieveRefund
|
||||
|
||||
`**retrieveRefund**(id, config?): Promise<[Refund](Refund.mdx)>`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1114,7 +1086,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[Refund](Refund.mdx)>
|
||||
|
||||
@@ -1132,13 +1104,13 @@ Promise<[Refund](Refund.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### retrieveSession
|
||||
#### retrieveSession
|
||||
|
||||
`**retrieveSession**(paymentSessionId, relations?): Promise<[PaymentSession](PaymentSession.mdx)>`
|
||||
|
||||
Return the payment session for the given id.
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1161,7 +1133,7 @@ Return the payment session for the given id.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[PaymentSession](PaymentSession.mdx)>
|
||||
|
||||
@@ -1179,13 +1151,13 @@ Promise<[PaymentSession](PaymentSession.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### saveSession
|
||||
#### saveSession
|
||||
|
||||
`Protected **saveSession**(providerId, data): Promise<[PaymentSession](PaymentSession.mdx)>`
|
||||
|
||||
Create or update a Payment session data.
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1271,7 +1243,7 @@ Create or update a Payment session data.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[PaymentSession](PaymentSession.mdx)>
|
||||
|
||||
@@ -1289,11 +1261,11 @@ Promise<[PaymentSession](PaymentSession.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
#### shouldRetryTransaction\_
|
||||
|
||||
`Protected **shouldRetryTransaction_**(err): boolean`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1307,7 +1279,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
`boolean`
|
||||
|
||||
@@ -1325,11 +1297,11 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### throwFromPaymentProcessorError
|
||||
#### throwFromPaymentProcessorError
|
||||
|
||||
`Private **throwFromPaymentProcessorError**(errObj): void`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1343,7 +1315,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
`void`
|
||||
|
||||
@@ -1361,11 +1333,11 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### updatePayment
|
||||
#### updatePayment
|
||||
|
||||
`**updatePayment**(paymentId, data): Promise<[Payment](Payment.mdx)>`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1406,7 +1378,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[Payment](Payment.mdx)>
|
||||
|
||||
@@ -1424,13 +1396,13 @@ Promise<[Payment](Payment.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### updateSession
|
||||
#### updateSession
|
||||
|
||||
`**updateSession**(paymentSession, sessionInput): Promise<[PaymentSession](PaymentSession.mdx)>`
|
||||
|
||||
Update a payment session with the given provider.
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1480,7 +1452,7 @@ Update a payment session with the given provider.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[PaymentSession](PaymentSession.mdx)>
|
||||
|
||||
@@ -1498,11 +1470,11 @@ Promise<[PaymentSession](PaymentSession.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### updateSessionData
|
||||
#### updateSessionData
|
||||
|
||||
`**updateSessionData**(paymentSession, data): Promise<[PaymentSession](PaymentSession.mdx)>`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1525,7 +1497,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[PaymentSession](PaymentSession.mdx)>
|
||||
|
||||
@@ -1543,11 +1515,11 @@ Promise<[PaymentSession](PaymentSession.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
#### withTransaction
|
||||
|
||||
`**withTransaction**(transactionManager?): [PaymentProviderService](PaymentProviderService.mdx)`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1561,7 +1533,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
[PaymentProviderService](PaymentProviderService.mdx)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user