Skip to main content

Class: ReturnReasonService

Hierarchy

  • TransactionBaseServiceCopy to Clipboard

    ReturnReasonServiceCopy to Clipboard

Constructors

constructor

new ReturnReasonService(__namedParametersCopy to Clipboard)

Parameters

NameType
__namedParametersCopy to ClipboardInjectedDependenciesCopy to Clipboard

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/return-reason.ts:21

Properties

__configModule__

ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __configModule__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>

Inherited from

TransactionBaseService.__configModule__

Defined in

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


__container__

ProtectedCopy to Clipboard ReadonlyCopy to Clipboard __container__: anyCopy to Clipboard

Inherited from

TransactionBaseService.__container__

Defined in

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


__moduleDeclaration__

ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __moduleDeclaration__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

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


manager_

ProtectedCopy to Clipboard manager_: EntityManagerCopy to Clipboard

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/return-reason.ts:18


retReasonRepo_

ProtectedCopy to Clipboard ReadonlyCopy to Clipboard retReasonRepo_: typeof ReturnReasonRepositoryCopy to Clipboard

Defined in

packages/medusa/src/services/return-reason.ts:16


transactionManager_

ProtectedCopy to Clipboard transactionManager_: undefinedCopy to Clipboard | EntityManagerCopy to Clipboard

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/return-reason.ts:19

Methods

atomicPhase_

ProtectedCopy to Clipboard atomicPhase_<TResultCopy to Clipboard, TErrorCopy to Clipboard>(workCopy to Clipboard, isolationOrErrorHandler?Copy to Clipboard, maybeErrorHandlerOrDontFail?Copy to Clipboard): PromiseCopy to Clipboard<TResultCopy to Clipboard>

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
TResultCopy to Clipboard
TErrorCopy to Clipboard

Parameters

NameTypeDescription
workCopy to Clipboard(transactionManagerCopy to Clipboard: EntityManagerCopy to Clipboard) => PromiseCopy to Clipboard<TResultCopy to Clipboard>the transactional work to be done
isolationOrErrorHandler?Copy to ClipboardIsolationLevelCopy to Clipboard | (errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard>the isolation level to be used for the work.
maybeErrorHandlerOrDontFail?Copy to Clipboard(errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard>Potential error handler

Returns

PromiseCopy to Clipboard<TResultCopy to Clipboard>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

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


create

create(dataCopy to Clipboard): PromiseCopy to Clipboard<ReturnReasonCopy to Clipboard>

Parameters

NameType
dataCopy to ClipboardCreateReturnReasonCopy to Clipboard

Returns

PromiseCopy to Clipboard<ReturnReasonCopy to Clipboard>

Defined in

packages/medusa/src/services/return-reason.ts:29


delete

delete(returnReasonIdCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>

Parameters

NameType
returnReasonIdCopy to ClipboardstringCopy to Clipboard

Returns

PromiseCopy to Clipboard<voidCopy to Clipboard>

Defined in

packages/medusa/src/services/return-reason.ts:117


list

list(selectorCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<ReturnReasonCopy to Clipboard[]>

Parameters

NameTypeDescription
selectorCopy to ClipboardSelectorCopy to Clipboard<ReturnReasonCopy to Clipboard>the query object for find
configCopy to ClipboardFindConfigCopy to Clipboard<ReturnReasonCopy to Clipboard>config object

Returns

PromiseCopy to Clipboard<ReturnReasonCopy to Clipboard[]>

the result of the find operation

Defined in

packages/medusa/src/services/return-reason.ts:72


retrieve

retrieve(returnReasonIdCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<ReturnReasonCopy to Clipboard>

Gets an order by id.

Parameters

NameTypeDescription
returnReasonIdCopy to ClipboardstringCopy to Clipboardid of order to retrieve
configCopy to ClipboardFindConfigCopy to Clipboard<ReturnReasonCopy to Clipboard>config object

Returns

PromiseCopy to Clipboard<ReturnReasonCopy to Clipboard>

the order document

Defined in

packages/medusa/src/services/return-reason.ts:91


shouldRetryTransaction_

ProtectedCopy to Clipboard shouldRetryTransaction_(errCopy to Clipboard): booleanCopy to Clipboard

Parameters

NameType
errCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | { codeCopy to Clipboard: stringCopy to Clipboard }

Returns

booleanCopy to Clipboard

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

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


update

update(idCopy to Clipboard, dataCopy to Clipboard): PromiseCopy to Clipboard<ReturnReasonCopy to Clipboard>

Parameters

NameType
idCopy to ClipboardstringCopy to Clipboard
dataCopy to ClipboardUpdateReturnReasonCopy to Clipboard

Returns

PromiseCopy to Clipboard<ReturnReasonCopy to Clipboard>

Defined in

packages/medusa/src/services/return-reason.ts:50


withTransaction

withTransaction(transactionManager?Copy to Clipboard): ReturnReasonServiceCopy to Clipboard

Parameters

NameType
transactionManager?Copy to ClipboardEntityManagerCopy to Clipboard

Returns

ReturnReasonServiceCopy to Clipboard

Inherited from

TransactionBaseService.withTransaction

Defined in

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