ClaimService

Hierarchy

• TransactionBaseService

  ↳ ClaimService

Constructors

constructor

new ClaimService(«destructured»)

Parameters

Name
«destructured»

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/claim.ts:86

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

---

addressRepository_

Protected Readonly addressRepository_: Repository<Address>

Defined in

medusa/src/services/claim.ts:68

---

claimItemService_

Protected Readonly claimItemService_: ClaimItemService

Defined in

medusa/src/services/claim.ts:72

---

claimRepository_

Protected Readonly claimRepository_: Repository<ClaimOrder>

Defined in

medusa/src/services/claim.ts:69

---

eventBus_

Protected Readonly eventBus_: EventBusService

Defined in

medusa/src/services/claim.ts:73

---

fulfillmentProviderService_

Protected Readonly fulfillmentProviderService_: FulfillmentProviderService

Defined in

medusa/src/services/claim.ts:74

---

fulfillmentService_

Protected Readonly fulfillmentService_: FulfillmentService

Defined in

medusa/src/services/claim.ts:75

---

lineItemRepository_

Protected Readonly lineItemRepository_: Repository<LineItem> & { findByReturn: Method findByReturn }

Defined in

medusa/src/services/claim.ts:71

---

lineItemService_

Protected Readonly lineItemService_: LineItemService

Defined in

medusa/src/services/claim.ts:76

---

manager_

Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

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

---

paymentProviderService_

Protected Readonly paymentProviderService_: PaymentProviderService

Defined in

medusa/src/services/claim.ts:77

---

productVariantInventoryService_

Protected Readonly productVariantInventoryService_: ProductVariantInventoryService

Defined in

medusa/src/services/claim.ts:84

---

regionService_

Protected Readonly regionService_: RegionService

Defined in

medusa/src/services/claim.ts:78

---

returnService_

Protected Readonly returnService_: ReturnService

Defined in

medusa/src/services/claim.ts:79

---

shippingMethodRepository_

Protected Readonly shippingMethodRepository_: Repository<ShippingMethod>

Defined in

medusa/src/services/claim.ts:70

---

shippingOptionService_

Protected Readonly shippingOptionService_: ShippingOptionService

Defined in

medusa/src/services/claim.ts:80

---

taxProviderService_

Protected Readonly taxProviderService_: TaxProviderService

Defined in

medusa/src/services/claim.ts:81

---

totalsService_

Protected Readonly totalsService_: TotalsService

Defined in

medusa/src/services/claim.ts:82

---

transactionManager_

Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

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

---

Events

Static Readonly Events: Object

Type declaration

Name	Type
CANCELED	string
CREATED	string
FULFILLMENT_CREATED	string
REFUND_PROCESSED	string
SHIPMENT_CREATED	string
UPDATED	string

Defined in

medusa/src/services/claim.ts:59

Accessors

activeManager_

Protected get activeManager_(): EntityManager

Returns

EntityManager

-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.

Name
TResult
TError

Parameters

Name	Description
work	(transactionManager: EntityManager) => Promise<TResult>
isolationOrErrorHandler?	IsolationLevel | (error: TError) => Promise<void | TResult>
maybeErrorHandlerOrDontFail?	(error: TError) => Promise<void | TResult>

Returns

Promise<TResult>

-Promise: the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

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

---

cancel

cancel(id): Promise<ClaimOrder>

Parameters

Name
id

Returns

Promise<ClaimOrder>

-Promise: -ClaimOrder:

Defined in

medusa/src/services/claim.ts:814

---

cancelFulfillment

cancelFulfillment(fulfillmentId): Promise<ClaimOrder>

Parameters

Name
fulfillmentId

Returns

Promise<ClaimOrder>

-Promise: -ClaimOrder:

Defined in

medusa/src/services/claim.ts:662

---

create

create(data): Promise<ClaimOrder>

Creates a Claim on an Order. Claims consists of items that are claimed and optionally items to be sent as replacement for the claimed items. The shipping address that the new items will be shipped to

Parameters

Name	Description
data	CreateClaimInput

Returns

Promise<ClaimOrder>

-Promise: created claim -ClaimOrder:

Defined in

medusa/src/services/claim.ts:331

---

createFulfillment

createFulfillment(id, config?): Promise<ClaimOrder>

Parameters

Name	Description
id	string
config	object
config.location_id?	string
config.metadata?	Record<string, unknown>
config.no_notification?	boolean

Returns

Promise<ClaimOrder>

-Promise: created claim -ClaimOrder:

Defined in

medusa/src/services/claim.ts:512

---

createShipment

createShipment(id, fulfillmentId, trackingLinks?, config?): Promise<ClaimOrder>

Parameters

Name	Default value
id	string
fulfillmentId	string
trackingLinks	{ tracking_number: string }[]
config	object
config.metadata	object
config.no_notification	undefined

Returns

Promise<ClaimOrder>

-Promise: -ClaimOrder:

Defined in

medusa/src/services/claim.ts:734

---

getRefundTotalForClaimLinesOnOrder

Protected getRefundTotalForClaimLinesOnOrder(order, claimItems): Promise<number>

Finds claim line items on an order and calculates the refund amount. There are three places too look:

• Order items
• Swap items
• Claim items (from previous claims) Note, it will attempt to return early from each of these places to avoid having to iterate over all items every time.

Parameters

Name	Description
order	Order
claimItems	CreateClaimItemInput[]

Returns

Promise<number>

-Promise: the refund amount -number: (optional)

Defined in

medusa/src/services/claim.ts:273

---

list

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

Parameters

Name	Description
selector	any
config	FindConfig<ClaimOrder>

Returns

Promise<ClaimOrder[]>

-Promise: the result of the find operation -ClaimOrder[]: -ClaimOrder:

Defined in

medusa/src/services/claim.ts:870

---

processRefund

processRefund(id): Promise<ClaimOrder>

Parameters

Name
id

Returns

Promise<ClaimOrder>

-Promise: -ClaimOrder:

Defined in

medusa/src/services/claim.ts:688

---

retrieve

retrieve(claimId, config?): Promise<ClaimOrder>

Gets an order by id.

Parameters

Name	Description
claimId	string
config	FindConfig<ClaimOrder>

Returns

Promise<ClaimOrder>

-Promise: the order document -ClaimOrder:

Defined in

medusa/src/services/claim.ts:889

---

shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

Name
err

Returns

boolean

-boolean: (optional)

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

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

---

update

update(id, data): Promise<ClaimOrder>

Parameters

Name
id
data

Returns

Promise<ClaimOrder>

-Promise: -ClaimOrder:

Defined in

medusa/src/services/claim.ts:125

---

validateCreateClaimInput

Protected validateCreateClaimInput(data): Promise<void>

Parameters

Name
data

Returns

Promise<void>

-Promise:

Defined in

medusa/src/services/claim.ts:206

---

withTransaction

withTransaction(transactionManager?): ClaimService

Parameters

Name
transactionManager?

Returns

ClaimService

-default:

Inherited from

TransactionBaseService.withTransaction

Defined in

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