Class: ClaimService

Hierarchy

• TransactionBaseServiceCopy to Clipboard

  ↳ ClaimServiceCopy to Clipboard

Constructors

constructor

• new ClaimService(__namedParametersCopy to Clipboard)

Parameters

Name	Type
__namedParametersCopy to Clipboard	InjectedDependenciesCopy to Clipboard

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/claim.ts:86

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

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

---

__container__

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard __container__: anyCopy to Clipboard

Inherited from

TransactionBaseService.__container__

Defined in

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

---

__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

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

---

addressRepository_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard addressRepository_: RepositoryCopy to Clipboard<AddressCopy to Clipboard>

Defined in

medusa/src/services/claim.ts:68

---

claimItemService_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard claimItemService_: ClaimItemServiceCopy to Clipboard

Defined in

medusa/src/services/claim.ts:72

---

claimRepository_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard claimRepository_: RepositoryCopy to Clipboard<ClaimOrderCopy to Clipboard>

Defined in

medusa/src/services/claim.ts:69

---

eventBus_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard eventBus_: EventBusServiceCopy to Clipboard

Defined in

medusa/src/services/claim.ts:73

---

fulfillmentProviderService_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard fulfillmentProviderService_: FulfillmentProviderServiceCopy to Clipboard

Defined in

medusa/src/services/claim.ts:74

---

fulfillmentService_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard fulfillmentService_: FulfillmentServiceCopy to Clipboard

Defined in

medusa/src/services/claim.ts:75

---

lineItemRepository_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard lineItemRepository_: RepositoryCopy to Clipboard<LineItemCopy to Clipboard> & { findByReturnCopy to Clipboard: (returnIdCopy to Clipboard: stringCopy to Clipboard) => PromiseCopy to Clipboard<LineItemCopy to Clipboard & { return_itemCopy to Clipboard: ReturnItemCopy to Clipboard }[]> }

Defined in

medusa/src/services/claim.ts:71

---

lineItemService_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard lineItemService_: LineItemServiceCopy to Clipboard

Defined in

medusa/src/services/claim.ts:76

---

manager_

• ProtectedCopy to Clipboard manager_: EntityManagerCopy to Clipboard

Inherited from

TransactionBaseService.manager_

Defined in

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

---

paymentProviderService_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard paymentProviderService_: PaymentProviderServiceCopy to Clipboard

Defined in

medusa/src/services/claim.ts:77

---

productVariantInventoryService_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard productVariantInventoryService_: ProductVariantInventoryServiceCopy to Clipboard

Defined in

medusa/src/services/claim.ts:84

---

regionService_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard regionService_: RegionServiceCopy to Clipboard

Defined in

medusa/src/services/claim.ts:78

---

returnService_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard returnService_: ReturnServiceCopy to Clipboard

Defined in

medusa/src/services/claim.ts:79

---

shippingMethodRepository_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard shippingMethodRepository_: RepositoryCopy to Clipboard<ShippingMethodCopy to Clipboard>

Defined in

medusa/src/services/claim.ts:70

---

shippingOptionService_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard shippingOptionService_: ShippingOptionServiceCopy to Clipboard

Defined in

medusa/src/services/claim.ts:80

---

taxProviderService_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard taxProviderService_: TaxProviderServiceCopy to Clipboard

Defined in

medusa/src/services/claim.ts:81

---

totalsService_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard totalsService_: TotalsServiceCopy to Clipboard

Defined in

medusa/src/services/claim.ts:82

---

transactionManager_

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

Inherited from

TransactionBaseService.transactionManager_

Defined in

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

---

Events

▪ StaticCopy to Clipboard ReadonlyCopy to Clipboard Events: ObjectCopy to Clipboard

Type declaration

Name	Type
CANCELEDCopy to Clipboard	stringCopy to Clipboard
CREATEDCopy to Clipboard	stringCopy to Clipboard
FULFILLMENT_CREATEDCopy to Clipboard	stringCopy to Clipboard
REFUND_PROCESSEDCopy to Clipboard	stringCopy to Clipboard
SHIPMENT_CREATEDCopy to Clipboard	stringCopy to Clipboard
UPDATEDCopy to Clipboard	stringCopy to Clipboard

Defined in

medusa/src/services/claim.ts:59

Accessors

activeManager_

• ProtectedCopy to Clipboard getCopy to Clipboard activeManager_(): EntityManagerCopy to Clipboard

Returns

EntityManagerCopy to Clipboard

Inherited from

TransactionBaseService.activeManager_

Defined in

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

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

Name	Type	Description
workCopy to Clipboard	(transactionManagerCopy to Clipboard: EntityManagerCopy to Clipboard) => PromiseCopy to Clipboard<TResultCopy to Clipboard>	the transactional work to be done
isolationOrErrorHandler?Copy to Clipboard	IsolationLevelCopy 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

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

---

cancel

▸ cancel(idCopy to Clipboard): PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard>

Parameters

Name	Type
idCopy to Clipboard	stringCopy to Clipboard

Returns

PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard>

Defined in

medusa/src/services/claim.ts:816

---

cancelFulfillment

▸ cancelFulfillment(fulfillmentIdCopy to Clipboard): PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard>

Parameters

Name	Type
fulfillmentIdCopy to Clipboard	stringCopy to Clipboard

Returns

PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard>

Defined in

medusa/src/services/claim.ts:664

---

create

▸ create(dataCopy to Clipboard): PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard>

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	Type	Description
dataCopy to Clipboard	CreateClaimInputCopy to Clipboard	the object containing all data required to create a claim

Returns

PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard>

created claim

Defined in

medusa/src/services/claim.ts:331

---

createFulfillment

▸ createFulfillment(idCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard>

Parameters

Name	Type	Description
idCopy to Clipboard	stringCopy to Clipboard	the object containing all data required to create a claim
configCopy to Clipboard	ObjectCopy to Clipboard	config object
config.location_id?Copy to Clipboard	stringCopy to Clipboard	-
config.metadata?Copy to Clipboard	RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>	config metadata
config.no_notification?Copy to Clipboard	booleanCopy to Clipboard	config no notification

Returns

PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard>

created claim

Defined in

medusa/src/services/claim.ts:512

---

createShipment

▸ createShipment(idCopy to Clipboard, fulfillmentIdCopy to Clipboard, trackingLinks?Copy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard>

Parameters

Name	Type	Default value
idCopy to Clipboard	stringCopy to Clipboard	undefinedCopy to Clipboard
fulfillmentIdCopy to Clipboard	stringCopy to Clipboard	undefinedCopy to Clipboard
trackingLinksCopy to Clipboard	{ tracking_numberCopy to Clipboard: stringCopy to Clipboard }[]	[]Copy to Clipboard
configCopy to Clipboard	ObjectCopy to Clipboard	undefinedCopy to Clipboard
config.metadataCopy to Clipboard	ObjectCopy to Clipboard	{}Copy to Clipboard
config.no_notificationCopy to Clipboard	undefinedCopy to Clipboard	undefinedCopy to Clipboard

Returns

PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard>

Defined in

medusa/src/services/claim.ts:736

---

getRefundTotalForClaimLinesOnOrder

▸ ProtectedCopy to Clipboard getRefundTotalForClaimLinesOnOrder(orderCopy to Clipboard, claimItemsCopy to Clipboard): PromiseCopy to Clipboard<numberCopy to Clipboard>

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	Type	Description
orderCopy to Clipboard	OrderCopy to Clipboard	the order to find claim lines on
claimItemsCopy to Clipboard	CreateClaimItemInputCopy to Clipboard[]	the claim items to match against

Returns

PromiseCopy to Clipboard<numberCopy to Clipboard>

the refund amount

Defined in

medusa/src/services/claim.ts:273

---

list

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

Parameters

Name	Type	Description
selectorCopy to Clipboard	anyCopy to Clipboard	the query object for find
configCopy to Clipboard	FindConfigCopy to Clipboard<ClaimOrderCopy to Clipboard>	the config object containing query settings

Returns

PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard[]>

the result of the find operation

Defined in

medusa/src/services/claim.ts:872

---

processRefund

▸ processRefund(idCopy to Clipboard): PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard>

Parameters

Name	Type
idCopy to Clipboard	stringCopy to Clipboard

Returns

PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard>

Defined in

medusa/src/services/claim.ts:690

---

retrieve

▸ retrieve(claimIdCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard>

Gets an order by id.

Parameters

Name	Type	Description
claimIdCopy to Clipboard	stringCopy to Clipboard	id of the claim order to retrieve
configCopy to Clipboard	FindConfigCopy to Clipboard<ClaimOrderCopy to Clipboard>	the config object containing query settings

Returns

PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard>

the order document

Defined in

medusa/src/services/claim.ts:891

---

shouldRetryTransaction_

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

Parameters

Name	Type
errCopy to Clipboard	RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | { codeCopy to Clipboard: stringCopy to Clipboard }

Returns

booleanCopy to Clipboard

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

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

---

update

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

Parameters

Name	Type
idCopy to Clipboard	stringCopy to Clipboard
dataCopy to Clipboard	UpdateClaimInputCopy to Clipboard

Returns

PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard>

Defined in

medusa/src/services/claim.ts:125

---

validateCreateClaimInput

▸ ProtectedCopy to Clipboard validateCreateClaimInput(dataCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>

Parameters

Name	Type
dataCopy to Clipboard	CreateClaimInputCopy to Clipboard

Returns

PromiseCopy to Clipboard<voidCopy to Clipboard>

Defined in

medusa/src/services/claim.ts:206

---

withTransaction

▸ withTransaction(transactionManager?Copy to Clipboard): ClaimServiceCopy to Clipboard

Parameters

Name	Type
transactionManager?Copy to Clipboard	EntityManagerCopy to Clipboard

Returns

ClaimServiceCopy to Clipboard

Inherited from

TransactionBaseService.withTransaction

Defined in

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