7d650771d1
* add new plugin for better organization * added handling in theme for mutations and query types * added tsdoc to hooks * added tsdocs to utility functions * added tsdoc to providers * generated reference * general fixes for generated reference * generated api reference specs + general fixes * add missing import react * split utilities into different directories * added overview page * added link to customer authentication section * fix lint errors * added changeset * fix readme * fixed build error * added expand fields + other sections to overview * updated what's new section * general refactoring * remove unnecessary query field * fix links * added ignoreApi option
196 lines
7.5 KiB
Plaintext
196 lines
7.5 KiB
Plaintext
---
|
|
displayed_sidebar: servicesSidebar
|
|
---
|
|
|
|
import ParameterTypes from "@site/src/components/ParameterTypes"
|
|
|
|
# SystemPaymentProviderService
|
|
|
|
## constructor
|
|
|
|
### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"_","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
___
|
|
|
|
## Properties
|
|
|
|
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"identifier","type":"`string`","description":"","optional":false,"defaultValue":"\"system\"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
___
|
|
|
|
## Accessors
|
|
|
|
### activeManager\_
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
___
|
|
|
|
## Methods
|
|
|
|
### atomicPhase\_
|
|
|
|
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","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise<TResult>","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise<void \\| TResult>","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise<void \\| TResult>","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
|
|
|
___
|
|
|
|
### authorizePayment
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"_","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, unknown>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
___
|
|
|
|
### cancelPayment
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"_","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, unknown>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
___
|
|
|
|
### capturePayment
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"_","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, unknown>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
___
|
|
|
|
### createPayment
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"_","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, unknown>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
___
|
|
|
|
### deletePayment
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"_","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, unknown>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
___
|
|
|
|
### getPaymentData
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"_","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, unknown>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
___
|
|
|
|
### getStatus
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"_","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<string>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
___
|
|
|
|
### refundPayment
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"_","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, unknown>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
___
|
|
|
|
### shouldRetryTransaction\_
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
___
|
|
|
|
### updatePayment
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"_","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, unknown>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
___
|
|
|
|
### updatePaymentData
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"_","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, unknown>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
___
|
|
|
|
### withTransaction
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"SystemPaymentProviderService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|