Files

github-actions[bot] 2394c533d3 chore(docs): Generated Services Reference (automated) (#4015 )

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>

2023-05-04 12:37:29 +03:00

20 KiB

Raw Blame History

Class: PaymentProviderService

Helps retrieve payment providers

Hierarchy

TransactionBaseService

↳ PaymentProviderService

Constructors

constructor

• new PaymentProviderService(container)

Parameters

Name	Type
`container`	`InjectedDependencies`

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/payment-provider.ts:70

Properties

configModule

• Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

medusa/src/interfaces/transaction-base-service.ts:14

container

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

medusa/src/interfaces/transaction-base-service.ts:13

moduleDeclaration

• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

medusa/src/interfaces/transaction-base-service.ts:15

container_

• Protected Readonly container_: InjectedDependencies

Defined in

medusa/src/services/payment-provider.ts:55

customerService_

• Protected Readonly customerService_: CustomerService

Defined in

medusa/src/services/payment-provider.ts:65

featureFlagRouter_

• Protected Readonly featureFlagRouter_: FlagRouter

Defined in

medusa/src/services/payment-provider.ts:68

logger_

• Protected Readonly logger_: Logger

Defined in

medusa/src/services/payment-provider.ts:66

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:5

paymentProviderRepository_

• Protected Readonly paymentProviderRepository_: Repository<PaymentProvider>

Defined in

medusa/src/services/payment-provider.ts:58

paymentRepository_

• Protected Readonly paymentRepository_: Repository<Payment>

Defined in

medusa/src/services/payment-provider.ts:59

paymentSessionRepository_

• Protected Readonly paymentSessionRepository_: Repository<PaymentSession>

Defined in

medusa/src/services/payment-provider.ts:56

refundRepository_

• Protected Readonly refundRepository_: Repository<Refund>

Defined in

medusa/src/services/payment-provider.ts:64

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:6

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:8

paymentService_

• Protected get paymentService_(): PaymentService

Returns

PaymentService

Defined in

medusa/src/services/payment-provider.ts:60

Methods

atomicPhase_

▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

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

Name
`TResult`
`TError`

Parameters

Name	Type	Description
`work`	(`transactionManager`: `EntityManager`) => `Promise`<`TResult`>	the transactional work to be done
`isolationOrErrorHandler?`	`IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`>	the isolation level to be used for the work.
`maybeErrorHandlerOrDontFail?`	(`error`: `TError`) => `Promise`<`void` \| `TResult`>	Potential error handler

Returns

Promise<TResult>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

medusa/src/interfaces/transaction-base-service.ts:56

authorizePayment

▸ authorizePayment(paymentSession, context): Promise<undefined | PaymentSession>

Parameters

Name	Type
`paymentSession`	`PaymentSession`
`context`	`Record`<`string`, `unknown`>

Returns

Promise<undefined | PaymentSession>

Defined in

medusa/src/services/payment-provider.ts:523

buildPaymentProcessorContext

▸ Protected buildPaymentProcessorContext(cartOrData): Cart & PaymentContext

Build the create session context for both legacy and new API

Parameters

Name	Type
`cartOrData`	`Cart` \| `PaymentSessionInput`

Returns

Cart & PaymentContext

Defined in

medusa/src/services/payment-provider.ts:840

cancelPayment

▸ cancelPayment(paymentObj): Promise<Payment>

Parameters

Name	Type
`paymentObj`	`Partial`<`Payment`> & { `id`: `string` }

Returns

Promise<Payment>

Defined in

medusa/src/services/payment-provider.ts:597

capturePayment

▸ capturePayment(paymentObj): Promise<Payment>

Parameters

Name	Type
`paymentObj`	`Partial`<`Payment`> & { `id`: `string` }

Returns

Promise<Payment>

Defined in

medusa/src/services/payment-provider.ts:636

createPayment

▸ createPayment(data): Promise<Payment>

Parameters

Name	Type
`data`	`CreatePaymentInput`

Returns

Promise<Payment>

Defined in

medusa/src/services/payment-provider.ts:471

createSession

▸ createSession(providerId, cart): Promise<PaymentSession>

Deprecated

Parameters

Name	Type
`providerId`	`string`
`cart`	`Cart`

Returns

Promise<PaymentSession>

Defined in

medusa/src/services/payment-provider.ts:205

▸ createSession(sessionInput): Promise<PaymentSession>

Creates a payment session with the given provider.

Parameters

Name	Type
`sessionInput`	`PaymentSessionInput`

Returns

Promise<PaymentSession>

Defined in

medusa/src/services/payment-provider.ts:211

deleteSession

▸ deleteSession(paymentSession): Promise<undefined | PaymentSession>

Parameters

Name	Type
`paymentSession`	`PaymentSession`

Returns

Promise<undefined | PaymentSession>

Defined in

medusa/src/services/payment-provider.ts:402

getStatus

▸ getStatus(payment): Promise<PaymentSessionStatus>

Parameters

Name	Type
`payment`	`Payment`

Returns

Promise<PaymentSessionStatus>

Defined in

medusa/src/services/payment-provider.ts:625

list

▸ list(): Promise<PaymentProvider[]>

Returns

Promise<PaymentProvider[]>

Defined in

medusa/src/services/payment-provider.ts:102

listPayments

▸ listPayments(selector, config?): Promise<Payment[]>

List all the payments according to the given selector and config.

Parameters

Name	Type
`selector`	`Selector`<`Payment`>
`config`	`FindConfig`<`Payment`>

Returns

Promise<Payment[]>

Defined in

medusa/src/services/payment-provider.ts:154

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

Name	Type
`data`	`Object`
`data.customer?`	`Object`
`data.customer.id?`	`string`
`paymentResponse`	`Record`<`string`, `unknown`> \| `PaymentSessionResponse`

Returns

Promise<void>

Defined in

medusa/src/services/payment-provider.ts:930

refreshSession

▸ refreshSession(paymentSession, sessionInput): Promise<PaymentSession>

Refreshes a payment session with the given provider. This means, that we delete the current one and create a new.

Parameters

Name	Type	Description
`paymentSession`	`Object`	the payment session object to update
`paymentSession.data`	`Record`<`string`, `unknown`>	-
`paymentSession.id`	`string`	-
`paymentSession.provider_id`	`string`	-
`sessionInput`	`PaymentSessionInput`

Returns

Promise<PaymentSession>

the payment session

Defined in

medusa/src/services/payment-provider.ts:301

refundFromPayment

▸ refundFromPayment(payment, amount, reason, note?): Promise<Refund>

Parameters

Name	Type
`payment`	`Payment`
`amount`	`number`
`reason`	`string`
`note?`	`string`

Returns

Promise<Refund>

Defined in

medusa/src/services/payment-provider.ts:766

refundPayment

▸ refundPayment(payObjs, amount, reason, note?): Promise<Refund>

Parameters

Name	Type
`payObjs`	`Payment`[]
`amount`	`number`
`reason`	`string`
`note?`	`string`

Returns

Promise<Refund>

Defined in

medusa/src/services/payment-provider.ts:667

registerInstalledProviders

▸ registerInstalledProviders(providerIds): Promise<void>

Parameters

Name	Type
`providerIds`	`string`[]

Returns

Promise<void>

Defined in

medusa/src/services/payment-provider.ts:83

retrievePayment

▸ retrievePayment(paymentId, relations?): Promise<Payment>

Retrieve a payment entity with the given id.

Parameters

Name	Type	Default value
`paymentId`	`string`	`undefined`
`relations`	`string`[]	`[]`

Returns

Promise<Payment>

Defined in

medusa/src/services/payment-provider.ts:114

retrieveProvider

▸ retrieveProvider<TProvider>(providerId): TProvider extends AbstractPaymentService ? AbstractPaymentService : TProvider extends AbstractPaymentProcessor ? AbstractPaymentProcessor : any

Finds a provider given an id

Type parameters

Name	Type
`TProvider`	extends `unknown`

Parameters

Name	Type	Description
`providerId`	`string`	the id of the provider to get

Returns

TProvider extends AbstractPaymentService ? AbstractPaymentService : TProvider extends AbstractPaymentProcessor ? AbstractPaymentProcessor : any

the payment provider

Defined in

medusa/src/services/payment-provider.ts:442

retrieveRefund

▸ retrieveRefund(id, config?): Promise<Refund>

Parameters

Name	Type
`id`	`string`
`config`	`FindConfig`<`Refund`>

Returns

Promise<Refund>

Defined in

medusa/src/services/payment-provider.ts:817

retrieveSession

▸ retrieveSession(paymentSessionId, relations?): Promise<PaymentSession>

Return the payment session for the given id.

Parameters

Name	Type	Default value
`paymentSessionId`	`string`	`undefined`
`relations`	`string`[]	`[]`

Returns

Promise<PaymentSession>

Defined in

medusa/src/services/payment-provider.ts:172

saveSession

▸ Protected saveSession(providerId, data): Promise<PaymentSession>

Create or update a Payment session data.

Parameters

Name	Type
`providerId`	`string`
`data`	`Object`
`data.amount?`	`number`
`data.cartId?`	`string`
`data.isInitiated?`	`boolean`
`data.isSelected?`	`boolean`
`data.payment_session_id?`	`string`
`data.sessionData`	`Record`<`string`, `unknown`>
`data.status?`	`PaymentSessionStatus`

Returns

Promise<PaymentSession>

Defined in

medusa/src/services/payment-provider.ts:882

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name	Type
`err`	`Record`<`string`, `unknown`> \| { `code`: `string` }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

medusa/src/interfaces/transaction-base-service.ts:37

throwFromPaymentProcessorError

▸ Private throwFromPaymentProcessorError(errObj): void

Parameters

Name	Type
`errObj`	`PaymentProcessorError`

Returns

void

Defined in

medusa/src/services/payment-provider.ts:949

updatePayment

▸ updatePayment(paymentId, data): Promise<Payment>

Parameters

Name	Type
`paymentId`	`string`
`data`	`Object`
`data.order_id?`	`string`
`data.swap_id?`	`string`

Returns

Promise<Payment>

Defined in

medusa/src/services/payment-provider.ts:512

updateSession

▸ updateSession(paymentSession, sessionInput): Promise<PaymentSession>

Update a payment session with the given provider.

Parameters

Name	Type	Description
`paymentSession`	`Object`	The paymentSession to update
`paymentSession.data`	`Record`<`string`, `unknown`>	-
`paymentSession.id`	`string`	-
`paymentSession.provider_id`	`string`	-
`sessionInput`	`Cart` \| `PaymentSessionInput`

Returns

Promise<PaymentSession>

the payment session

Defined in

medusa/src/services/payment-provider.ts:342

updateSessionData

▸ updateSessionData(paymentSession, data): Promise<PaymentSession>

Parameters

Name	Type
`paymentSession`	`PaymentSession`
`data`	`Record`<`string`, `unknown`>

Returns

Promise<PaymentSession>

Defined in

medusa/src/services/payment-provider.ts:569

withTransaction

▸ withTransaction(transactionManager?): PaymentProviderService

Parameters

Name	Type
`transactionManager?`	`EntityManager`

Returns

PaymentProviderService

Inherited from

TransactionBaseService.withTransaction

Defined in

medusa/src/interfaces/transaction-base-service.ts:20

20 KiB Raw Blame History

Class: PaymentProviderService

Hierarchy

Constructors

constructor

Parameters

Overrides

Defined in

Properties

__configModule__

Inherited from

Defined in

__container__

Inherited from

Defined in

__moduleDeclaration__

Inherited from

Defined in

container_

Defined in

customerService_

Defined in

featureFlagRouter_

Defined in

logger_

Defined in

manager_

Inherited from

Defined in

paymentProviderRepository_

Defined in

paymentRepository_

Defined in

paymentSessionRepository_

Defined in

refundRepository_

Defined in

transactionManager_

Inherited from

Defined in

Accessors

activeManager_

Returns

Inherited from

Defined in

paymentService_

Returns

Defined in

Methods

atomicPhase_

Type parameters

Parameters

Returns

Inherited from

Defined in

authorizePayment

Parameters

Returns

Defined in

buildPaymentProcessorContext

Parameters

Returns

Defined in

cancelPayment

Parameters

Returns

Defined in

capturePayment

Parameters

Returns

Defined in

createPayment

Parameters

Returns

Defined in

createSession

Parameters

Returns

Defined in

Parameters

20 KiB

Raw Blame History

configModule

container

moduleDeclaration