Files

Shahed Nasser 914d773d3a api-ref: custom API reference (#4770 )

* initialized next.js project

* finished markdown sections

* added operation schema component

* change page metadata

* eslint fixes

* fixes related to deployment

* added response schema

* resolve max stack issue

* support for different property types

* added support for property types

* added loading for components

* added more loading

* type fixes

* added oneOf type

* removed console

* fix replace with push

* refactored everything

* use static content for description

* fixes and improvements

* added code examples section

* fix path name

* optimizations

* fixed tag navigation

* add support for admin and store references

* general enhancements

* optimizations and fixes

* fixes and enhancements

* added search bar

* loading enhancements

* added loading

* added code blocks

* added margin top

* add empty response text

* fixed oneOf parameters

* added path and query parameters

* general fixes

* added base path env variable

* small fix for arrays

* enhancements

* design enhancements

* general enhancements

* fix isRequired

* added enum values

* enhancements

* general fixes

* general fixes

* changed oas generation script

* additions to the introduction section

* added copy button for code + other enhancements

* fix response code block

* fix metadata

* formatted store introduction

* move sidebar logic to Tags component

* added test env variables

* fix code block bug

* added loading animation

* added expand param + loading

* enhance operation loading

* made responsive + improvements

* added loading provider

* fixed loading

* adjustments for small devices

* added sidebar label for endpoints

* added feedback component

* fixed analytics

* general fixes

* listen to scroll for other headings

* added sample env file

* update api ref files + support new fields

* fix for external docs link

* added new sections

* fix last item in sidebar not showing

* move docs content to www/docs

* change redirect url

* revert change

* resolve build errors

* configure rewrites

* changed to environment variable url

* revert changing environment variable name

* add environment variable for API path

* fix links

* fix tailwind settings

* remove vercel file

* reconfigured api route

* move api page under api

* fix page metadata

* fix external link in navigation bar

* update api spec

* updated api specs

* fixed google lint error

* add max-height on request samples

* add padding before loading

* fix for one of name

* fix undefined types

* general fixes

* remove response schema example

* redesigned navigation bar

* redesigned sidebar

* fixed up paddings

* added feedback component + report issue

* fixed up typography, padding, and general styling

* redesigned code blocks

* optimization

* added error timeout

* fixes

* added indexing with algolia + fixes

* fix errors with algolia script

* redesign operation sections

* fix heading scroll

* design fixes

* fix padding

* fix padding + scroll issues

* fix scroll issues

* improve scroll performance

* fixes for safari

* optimization and fixes

* fixes to docs + details animation

* padding fixes for code block

* added tab animation

* fixed incorrect link

* added selection styling

* fix lint errors

* redesigned details component

* added detailed feedback form

* api reference fixes

* fix tabs

* upgrade + fixes

* updated documentation links

* optimizations to sidebar items

* fix spacing in sidebar item

* optimizations and fixes

* fix endpoint path styling

* remove margin

* final fixes

* change margin on small devices

* generated OAS

* fixes for mobile

* added feedback modal

* optimize dark mode button

* fixed color mode useeffect

* minimize dom size

* use new style system

* radius and spacing design system

* design fixes

* fix eslint errors

* added meta files

* change cron schedule

* fix docusaurus configurations

* added operating system to feedback data

* change content directory name

* fixes to contribution guidelines

* revert renaming content

* added api-reference to documentation workflow

* fixes for search

* added dark mode + fixes

* oas fixes

* handle bugs

* added code examples for clients

* changed tooltip text

* change authentication to card

* change page title based on selected section

* redesigned mobile navbar

* fix icon colors

* fix key colors

* fix medusa-js installation command

* change external regex in algolia

* change changeset

* fix padding on mobile

* fix hydration error

* update depedencies

2023-08-15 18:07:54 +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:845

cancelPayment

▸ cancelPayment(paymentObj): Promise<Payment>

Parameters

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

Returns

Promise<Payment>

Defined in

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

capturePayment

▸ capturePayment(paymentObj): Promise<Payment>

Parameters

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

Returns

Promise<Payment>

Defined in

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

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:630

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:935

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:771

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:672

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:822

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:887

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:954

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