medusa-store/www/apps/docs/content/references/js-client/classes/internal-8.internal.ClaimItemService.md

displayed_sidebar

displayed_sidebar
jsClientSidebar

Class: ClaimItemService

internal.internal.ClaimItemService

Hierarchy

• TransactionBaseService

  ↳ ClaimItemService

Properties

__configModule__

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

Inherited from

TransactionBaseService.configModule

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:5

---

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.container

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:4

---

__moduleDeclaration__

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

Inherited from

TransactionBaseService.moduleDeclaration

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:6

---

claimImageRepository_

• Protected Readonly claimImageRepository_: Repository<ClaimImage>

Defined in

packages/medusa/dist/services/claim-item.d.ts:20

---

claimItemRepository_

• Protected Readonly claimItemRepository_: Repository<ClaimItem>

Defined in

packages/medusa/dist/services/claim-item.d.ts:18

---

claimTagRepository_

• Protected Readonly claimTagRepository_: Repository<ClaimTag>

Defined in

packages/medusa/dist/services/claim-item.d.ts:19

---

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

packages/medusa/dist/services/claim-item.d.ts:17

---

lineItemService_

• Protected Readonly lineItemService_: LineItemService

Defined in

packages/medusa/dist/services/claim-item.d.ts:16

---

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:7

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:8

---

Events

▪ Static Events: Object

Type declaration

Name	Type
CANCELED	string
CREATED	string
UPDATED	string

Defined in

packages/medusa/dist/services/claim-item.d.ts:11

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

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

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/dist/interfaces/transaction-base-service.d.ts:24

---

create

▸ create(data): Promise<ClaimItem>

Parameters

Name	Type
data	CreateClaimItemInput

Returns

Promise<ClaimItem>

Defined in

packages/medusa/dist/services/claim-item.d.ts:28

---

list

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

Parameters

Name	Type	Description
selector	Selector<ClaimItem>	the query object for find
config?	FindConfig<ClaimItem>	the config object for find

Returns

Promise<ClaimItem[]>

the result of the find operation

Defined in

packages/medusa/dist/services/claim-item.d.ts:35

---

retrieve

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

Gets a claim item by id.

Parameters

Name	Type	Description
claimItemId	string	id of ClaimItem to retrieve
config?	FindConfig<ClaimItem>	configuration for the find operation

Returns

Promise<ClaimItem>

the ClaimItem

Defined in

packages/medusa/dist/services/claim-item.d.ts:42

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:12

---

update

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

Parameters

Name	Type
id	any
data	any

Returns

Promise<ClaimItem>

Defined in

packages/medusa/dist/services/claim-item.d.ts:29

---

withTransaction

▸ withTransaction(transactionManager?): ClaimItemService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

ClaimItemService

Inherited from

TransactionBaseService.withTransaction

Defined in

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