Skip to main content

Class: ClaimItemService

Hierarchy​

  • TransactionBaseService

    ↳ ClaimItemService

Constructors​

constructor​

• new ClaimItemService(__namedParameters)

Parameters​

NameType
__namedParametersObject

Overrides​

TransactionBaseService.constructor

Defined in​

medusa/src/services/claim-item.ts:26

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


claimImageRepository_​

• Protected Readonly claimImageRepository_: Repository<ClaimImage>

Defined in​

medusa/src/services/claim-item.ts:24


claimItemRepository_​

• Protected Readonly claimItemRepository_: Repository<ClaimItem>

Defined in​

medusa/src/services/claim-item.ts:22


claimTagRepository_​

• Protected Readonly claimTagRepository_: Repository<ClaimTag>

Defined in​

medusa/src/services/claim-item.ts:23


eventBus_​

• Protected Readonly eventBus_: EventBusService

Defined in​

medusa/src/services/claim-item.ts:21


lineItemService_​

• Protected Readonly lineItemService_: LineItemService

Defined in​

medusa/src/services/claim-item.ts:20


manager_​

• Protected manager_: EntityManager

Inherited from​

TransactionBaseService.manager_

Defined in​

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


transactionManager_​

• Protected transactionManager_: undefined | EntityManager

Inherited from​

TransactionBaseService.transactionManager_

Defined in​

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


Events​

▪ Static Events: Object

Type declaration​

NameType
CANCELEDstring
CREATEDstring
UPDATEDstring

Defined in​

medusa/src/services/claim-item.ts:14

Accessors​

activeManager_​

• Protected get activeManager_(): EntityManager

Returns​

EntityManager

Inherited from​

TransactionBaseService.activeManager_

Defined in​

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

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​

NameTypeDescription
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


create​

▸ create(data): Promise<ClaimItem>

Parameters​

NameType
dataCreateClaimItemInput

Returns​

Promise<ClaimItem>

Defined in​

medusa/src/services/claim-item.ts:43


list​

▸ list(selector, config?): Promise<ClaimItem[]>

Parameters​

NameTypeDescription
selectorSelector<ClaimItem>the query object for find
configFindConfig<ClaimItem>the config object for find

Returns​

Promise<ClaimItem[]>

the result of the find operation

Defined in​

medusa/src/services/claim-item.ts:205


retrieve​

▸ retrieve(claimItemId, config?): Promise<ClaimItem>

Gets a claim item by id.

Parameters​

NameTypeDescription
claimItemIdstringid of ClaimItem to retrieve
configFindConfig<ClaimItem>configuration for the find operation

Returns​

Promise<ClaimItem>

the ClaimItem

Defined in​

medusa/src/services/claim-item.ts:224


shouldRetryTransaction_​

▸ Protected shouldRetryTransaction_(err): boolean

Parameters​

NameType
errRecord<string, unknown> | { code: string }

Returns​

boolean

Inherited from​

TransactionBaseService.shouldRetryTransaction_

Defined in​

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


update​

▸ update(id, data): Promise<ClaimItem>

Parameters​

NameType
idany
dataany

Returns​

Promise<ClaimItem>

Defined in​

medusa/src/services/claim-item.ts:127


withTransaction​

▸ withTransaction(transactionManager?): ClaimItemService

Parameters​

NameType
transactionManager?EntityManager

Returns​

ClaimItemService

Inherited from​

TransactionBaseService.withTransaction

Defined in​

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

Was this section helpful?