Skip to main content

Class: ClaimService

Hierarchy

  • TransactionBaseService

    ClaimService

Constructors

constructor

new ClaimService(__namedParameters)

Parameters

NameType
__namedParametersInjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/claim.ts:89

Properties

__configModule__

Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

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


__container__

Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

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


__moduleDeclaration__

Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

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


addressRepository_

Protected Readonly addressRepository_: typeof AddressRepository

Defined in

packages/medusa/src/services/claim.ts:71


claimItemService_

Protected Readonly claimItemService_: ClaimItemService

Defined in

packages/medusa/src/services/claim.ts:75


claimRepository_

Protected Readonly claimRepository_: typeof ClaimRepository

Defined in

packages/medusa/src/services/claim.ts:72


eventBus_

Protected Readonly eventBus_: EventBusService

Defined in

packages/medusa/src/services/claim.ts:76


fulfillmentProviderService_

Protected Readonly fulfillmentProviderService_: FulfillmentProviderService

Defined in

packages/medusa/src/services/claim.ts:77


fulfillmentService_

Protected Readonly fulfillmentService_: FulfillmentService

Defined in

packages/medusa/src/services/claim.ts:78


lineItemRepository_

Protected Readonly lineItemRepository_: typeof LineItemRepository

Defined in

packages/medusa/src/services/claim.ts:74


lineItemService_

Protected Readonly lineItemService_: LineItemService

Defined in

packages/medusa/src/services/claim.ts:79


manager_

Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/claim.ts:68


paymentProviderService_

Protected Readonly paymentProviderService_: PaymentProviderService

Defined in

packages/medusa/src/services/claim.ts:80


productVariantInventoryService_

Protected Readonly productVariantInventoryService_: ProductVariantInventoryService

Defined in

packages/medusa/src/services/claim.ts:87


regionService_

Protected Readonly regionService_: RegionService

Defined in

packages/medusa/src/services/claim.ts:81


returnService_

Protected Readonly returnService_: ReturnService

Defined in

packages/medusa/src/services/claim.ts:82


shippingMethodRepository_

Protected Readonly shippingMethodRepository_: typeof ShippingMethodRepository

Defined in

packages/medusa/src/services/claim.ts:73


shippingOptionService_

Protected Readonly shippingOptionService_: ShippingOptionService

Defined in

packages/medusa/src/services/claim.ts:83


taxProviderService_

Protected Readonly taxProviderService_: TaxProviderService

Defined in

packages/medusa/src/services/claim.ts:84


totalsService_

Protected Readonly totalsService_: TotalsService

Defined in

packages/medusa/src/services/claim.ts:85


transactionManager_

Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/claim.ts:69


Events

Static Readonly Events: Object

Type declaration

NameType
CANCELEDstring
CREATEDstring
FULFILLMENT_CREATEDstring
REFUND_PROCESSEDstring
SHIPMENT_CREATEDstring
UPDATEDstring

Defined in

packages/medusa/src/services/claim.ts:59

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

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


cancel

cancel(id): Promise<ClaimOrder>

Parameters

NameType
idstring

Returns

Promise<ClaimOrder>

Defined in

packages/medusa/src/services/claim.ts:808


cancelFulfillment

cancelFulfillment(fulfillmentId): Promise<ClaimOrder>

Parameters

NameType
fulfillmentIdstring

Returns

Promise<ClaimOrder>

Defined in

packages/medusa/src/services/claim.ts:656


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

NameTypeDescription
dataCreateClaimInputthe object containing all data required to create a claim

Returns

Promise<ClaimOrder>

created claim

Defined in

packages/medusa/src/services/claim.ts:337


createFulfillment

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

Parameters

NameTypeDescription
idstringthe object containing all data required to create a claim
configObjectconfig object
config.metadata?Record<string, unknown>config metadata
config.no_notification?booleanconfig no notification

Returns

Promise<ClaimOrder>

created claim

Defined in

packages/medusa/src/services/claim.ts:510


createShipment

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

Parameters

NameTypeDefault value
idstringundefined
fulfillmentIdstringundefined
trackingLinks{ tracking_number: string }[][]
configObjectundefined
config.metadataObject{}
config.no_notificationundefinedundefined

Returns

Promise<ClaimOrder>

Defined in

packages/medusa/src/services/claim.ts:728


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

NameTypeDescription
orderOrderthe order to find claim lines on
claimItemsCreateClaimItemInput[]the claim items to match against

Returns

Promise<number>

the refund amount

Defined in

packages/medusa/src/services/claim.ts:279


list

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

Parameters

NameTypeDescription
selectoranythe query object for find
configFindConfig<ClaimOrder>the config object containing query settings

Returns

Promise<ClaimOrder[]>

the result of the find operation

Defined in

packages/medusa/src/services/claim.ts:864


processRefund

processRefund(id): Promise<ClaimOrder>

Parameters

NameType
idstring

Returns

Promise<ClaimOrder>

Defined in

packages/medusa/src/services/claim.ts:682


retrieve

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

Gets an order by id.

Parameters

NameTypeDescription
claimIdstringid of the claim order to retrieve
configFindConfig<ClaimOrder>the config object containing query settings

Returns

Promise<ClaimOrder>

the order document

Defined in

packages/medusa/src/services/claim.ts:884


shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

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


update

update(id, data): Promise<ClaimOrder>

Parameters

NameType
idstring
dataUpdateClaimInput

Returns

Promise<ClaimOrder>

Defined in

packages/medusa/src/services/claim.ts:131


validateCreateClaimInput

Protected validateCreateClaimInput(data): Promise<void>

Parameters

NameType
dataCreateClaimInput

Returns

Promise<void>

Defined in

packages/medusa/src/services/claim.ts:212


withTransaction

withTransaction(transactionManager?): ClaimService

Parameters

NameType
transactionManager?EntityManager

Returns

ClaimService

Inherited from

TransactionBaseService.withTransaction

Defined in

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