Files

Shahed Nasser 6f1b49af03 chore: merge docs from master to develop (#3650 )

* Fix issue on fixed total amount discount when using includes tax (#3472)

The calculation of the fixed discount amount breaks when having includes_tax setting active, due to the line item totals are incorrect and returning everything as 0, thus the totalItemPercentage will be Infinitiy due to the division by a subtotal of 0

* chore: Add missing changeset for @medusajs/medusa

* feat(medusa): Improve performance of Products domain (#3417)

* feat(medusa): Improve product update performances

* fix tests and update

* update mock repo

* improve repo

* cleanup

* fix

* cleanup + bulk emit + unit test fix

* improvements

* improve

* fix unit tests

* fix export

* fix product update handler

* enhance mock repo

* fix import integration

* fix end point tests

* revert mock repo product variant

* fix unit

* cleanup

* cleanup

* address feedback

* fix quotes in tests

* address feedback

* Create new-tips-mate.md

* use types

* chore: Remove integration-tests from changeset

* chore(release): v1.7.14

* chore(docs): Generated Docs Announcement Bar (automated) (#3489)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>

* fix(medusa): EventBusService.emit using Redis mock (#3491)

* Fix eventBusService.emit using redis mock

* revert gitignore

* enqueuer

* unit test add redis_url

* fix test

* chore(docs): Generated Services Reference (automated) (#3490)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>

* docs: publish restructure (#3496)

* docs: added features and guides overview page

* added image

* added version 2

* added version 3

* added version 4

* docs: implemented new color scheme

* docs: redesigned sidebar (#3193)

* docs: redesigned navbar for restructure (#3199)

* docs: redesigned footer (#3209)

* docs: redesigned cards (#3230)

* docs: redesigned admonitions (#3231)

* docs: redesign announcement bar (#3236)

* docs: redesigned large cards (#3239)

* docs: redesigned code blocks (#3253)

* docs: redesigned search modal and page (#3264)

* docs: redesigned doc footer (#3268)

* docs: added new sidebars + refactored css and assets (#3279)

* docs: redesigned api reference sidebar

* docs: refactored css

* docs: added code tabs transition

* docs: added new sidebars

* removed unused assets

* remove unusued assets

* Fix deploy errors

* fix incorrect link

* docs: fixed code responsivity + missing icons (#3283)

* docs: changed icons (#3296)

* docs: design fixes to the sidebar (#3297)

* redesign fixes

* docs: small design fixes

* docs: several design fixes after restructure (#3299)

* docs: bordered icon fixes

* docs: desgin fixes

* fixes to code blocks and sidebar scroll

* design adjustments

* docs: restructured homepage (#3305)

* docs: restructured homepage

* design fixes

* fixed core concepts icon

* docs: added core concepts page (#3318)

* docs: restructured homepage

* design fixes

* docs: added core concepts page

* changed text of different components

* docs: added architecture link

* added missing prop for user guide

* docs: added regions overview page (#3327)

* docs: added regions overview

* moved region pages to new structure

* docs: fixed description of regions architecture page

* small changes

* small fix

* docs: added customers overview page (#3331)

* docs: added regions overview

* moved region pages to new structure

* docs: fixed description of regions architecture page

* small changes

* small fix

* docs: added customers overview page

* fix link

* resolve link issues

* docs: updated regions architecture image

* docs: second-iteration fixes (#3347)

* docs: redesigned document

* design fixes

* docs: added products overview page (#3354)

* docs: added carts overview page (#3363)

* docs: added orders overview (#3364)

* docs: added orders overview

* added links in overview

* docs: added vercel redirects

* docs: added soon badge for cards (#3389)

* docs: resolved feedback changes + organized troubleshooting pages (#3409)

* docs: resolved feedback changes

* added extra line

* docs: changed icons for restructure (#3421)

* docs: added taxes overview page (#3422)

* docs: added taxes overview page

* docs: fix sidebar label

* added link to taxes overview page

* fixed link

* docs: fixed sidebar scroll (#3429)

* docs: added discounts overview (#3432)

* docs: added discounts overview

* fixed links

* docs: added gift cards overview (#3433)

* docs: added price lists overview page (#3440)

* docs: added price lists overview page

* fixed links

* docs: added sales channels overview page (#3441)

* docs: added sales overview page

* fixed links

* docs: added users overview (#3443)

* docs: fixed sidebar border height (#3444)

* docs: fixed sidebar border height

* fixed svg markup

* docs: added possible solutions to feedback component (#3449)

* docs: added several overview pages + restructured files (#3463)

* docs: added several overview pages

* fixed links

* docs: added feature flags + PAK overview pages (#3464)

* docs: added feature flags + PAK overview pages

* fixed links

* fix link

* fix link

* fixed links colors

* docs: added strategies overview page (#3468)

* docs: automated upgrade guide (#3470)

* docs: automated upgrade guide

* fixed vercel redirect

* docs: restructured files in docs codebase (#3475)

* docs: restructured files

* docs: fixed eslint exception

* docs: finished restructure loose-ends (#3493)

* fixed uses of backend

* docs: finished loose ends

* eslint fixes

* fixed links

* merged master

* added update instructions for v1.7.12

* docs: fixed discount details (#3499)

* docs: fix trailing slash causing 404 (#3508)

* docs: fix error during navigation (#3509)

* docs: removed the gatsby storefront guide (#3527)

* docs: removed the gatsby storefront guide

* docs: fixed query value

* chore(docs): Removed Docs Announcement Bar (automated) (#3536)

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>

* fix(medusa): Variant update should include the id for the listeners to be able to identify the entity (#3539)

* fix(medusa): Variant update should include the id for the listeners to be able to identify the entity

* fix unit tests

* Create brave-seahorses-film.md

* docs: fix admin redirects (#3548)

* chore(release): v1.7.15

* chore(docs): Generated Docs Announcement Bar (automated) (#3550)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>

* chore(docs): Generated Services Reference (automated) (#3551)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>

* chore: updated READMEs of plugins (#3546)

* chore: updated READMEs of plugins

* added notice to plugins

* docs: added a deploy guide for next.js storefront (#3558)

* docs: added a deploy next.js guide

* docs: fix image zoom

* docs: fixes to next.js deployment guide to vercel (#3562)

* chore(workflows): Enable manual workflow in pre-release mode (#3566)

* chore(docs): Removed Docs Announcement Bar (automated) (#3598)

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>

* fix(medusa): Rounding issues on line item adjustments (#3446)

* chores(medusa): Attempt to fix discount rounding issues

* add migration

* update entities

* apply multipler factor properly

* fix discount service

* WIP

* fix rounding issues in discounts

* fix some tests

* Exclude raw_discount_total from responses

* fix adjustments

* cleanup response

* fix

* fix draft order integration

* fix order integration

* fix order integration

* address feedback

* fix test

* Create .changeset/polite-llamas-sit.md

* remove comment

---------

Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>

* chore(workflows): Add release notification (#3629)

---------

Co-authored-by: pepijn-vanvlaanderen <pepijn@webbers.com>
Co-authored-by: olivermrbl <oliver@mrbltech.com>
Co-authored-by: Adrien de Peretti <adrien.deperetti@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>

2023-03-31 09:34:38 +02:00

18 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

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

Properties

configModule

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

Inherited from

TransactionBaseService.__configModule__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:10

container

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:9

moduleDeclaration

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

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:11

container_

• Protected Readonly container_: InjectedDependencies

Defined in

packages/medusa/src/services/payment-provider.ts:53

customerService_

• Protected Readonly customerService_: CustomerService

Defined in

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

featureFlagRouter_

• Protected Readonly featureFlagRouter_: FlagRouter

Defined in

packages/medusa/src/services/payment-provider.ts:62

logger_

• Protected Readonly logger_: Logger

Defined in

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

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/payment-provider.ts:51

paymentProviderRepository_

• Protected Readonly paymentProviderRepository_: typeof PaymentProviderRepository

Defined in

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

paymentRepository_

• Protected Readonly paymentRepository_: typeof PaymentRepository

Defined in

packages/medusa/src/services/payment-provider.ts:57

paymentSessionRepository_

• Protected Readonly paymentSessionRepository_: typeof PaymentSessionRepository

Defined in

packages/medusa/src/services/payment-provider.ts:54

refundRepository_

• Protected Readonly refundRepository_: typeof RefundRepository

Defined in

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

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/payment-provider.ts:52

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

packages/medusa/src/interfaces/transaction-base-service.ts:50

authorizePayment

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

Parameters

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

Returns

Promise<undefined | PaymentSession>

Defined in

packages/medusa/src/services/payment-provider.ts:395

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

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

cancelPayment

▸ cancelPayment(paymentObj): Promise<Payment>

Parameters

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

Returns

Promise<Payment>

Defined in

packages/medusa/src/services/payment-provider.ts:448

capturePayment

▸ capturePayment(paymentObj): Promise<Payment>

Parameters

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

Returns

Promise<Payment>

Defined in

packages/medusa/src/services/payment-provider.ts:473

createPayment

▸ createPayment(data): Promise<Payment>

Parameters

Name	Type
`data`	`CreatePaymentInput`

Returns

Promise<Payment>

Defined in

packages/medusa/src/services/payment-provider.ts:357

createSession

▸ createSession<TInput>(providerIdOrSessionInput, ...cart): Promise<PaymentSession>

Creates a payment session with the given provider.

Type parameters

Name	Type
`TInput`	extends `string` \| `PaymentSessionInput` = `string` \| `PaymentSessionInput`

Parameters

Name	Type	Description
`providerIdOrSessionInput`	`TInput`	the id of the provider to create payment with or the input data
`...cart`	`TInput` extends `string` ? [`Cart`] : [undefined?]	a cart object used to calculate the amount, etc. from

Returns

Promise<PaymentSession>

the payment session

Defined in

packages/medusa/src/services/payment-provider.ts:180

deleteSession

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

Parameters

Name	Type
`paymentSession`	`PaymentSession`

Returns

Promise<undefined | PaymentSession>

Defined in

packages/medusa/src/services/payment-provider.ts:303

getStatus

▸ getStatus(payment): Promise<PaymentSessionStatus>

Parameters

Name	Type
`payment`	`Payment`

Returns

Promise<PaymentSessionStatus>

Defined in

packages/medusa/src/services/payment-provider.ts:468

list

▸ list(): Promise<PaymentProvider[]>

Returns

Promise<PaymentProvider[]>

Defined in

packages/medusa/src/services/payment-provider.ts:97

listPayments

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

Parameters

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

Returns

Promise<Payment[]>

Defined in

packages/medusa/src/services/payment-provider.ts:132

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

packages/medusa/src/services/payment-provider.ts:731

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

packages/medusa/src/services/payment-provider.ts:238

refundFromPayment

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

Parameters

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

Returns

Promise<Refund>

Defined in

packages/medusa/src/services/payment-provider.ts:578

refundPayment

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

Parameters

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

Returns

Promise<Refund>

Defined in

packages/medusa/src/services/payment-provider.ts:493

registerInstalledProviders

▸ registerInstalledProviders(providerIds): Promise<void>

Parameters

Name	Type
`providerIds`	`string`[]

Returns

Promise<void>

Defined in

packages/medusa/src/services/payment-provider.ts:78

retrievePayment

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

Parameters

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

Returns

Promise<Payment>

Defined in

packages/medusa/src/services/payment-provider.ts:104

retrieveProvider

▸ retrieveProvider<TProvider>(providerId): TProvider extends AbstractPaymentService ? AbstractPaymentService : 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 : any

the payment provider

Defined in

packages/medusa/src/services/payment-provider.ts:333

retrieveRefund

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

Parameters

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

Returns

Promise<Refund>

Defined in

packages/medusa/src/services/payment-provider.ts:618

retrieveSession

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

Parameters

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

Returns

Promise<PaymentSession>

Defined in

packages/medusa/src/services/payment-provider.ts:145

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

packages/medusa/src/services/payment-provider.ts:681

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:31

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

packages/medusa/src/services/payment-provider.ts:383

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

packages/medusa/src/services/payment-provider.ts:268

updateSessionData

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

Parameters

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

Returns

Promise<PaymentSession>

Defined in

packages/medusa/src/services/payment-provider.ts:427

withTransaction

▸ withTransaction(transactionManager?): PaymentProviderService

Parameters

Name	Type
`transactionManager?`	`EntityManager`

Returns

PaymentProviderService

Inherited from

TransactionBaseService.withTransaction

Defined in

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

18 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_

Overrides

Defined in

paymentProviderRepository_

Defined in

paymentRepository_

Defined in

paymentSessionRepository_

Defined in

refundRepository_

Defined in

transactionManager_

Overrides

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

Type parameters

Parameters

Returns

Defined in

deleteSession

Parameters

Returns

Defined in

getStatus

Parameters

Returns

Defined in

18 KiB

Raw Blame History

configModule

container

moduleDeclaration