Skip to main content

Class: ClaimService

Hierarchy​

  • TransactionBaseServiceCopy to Clipboard

    ↳ ClaimServiceCopy to Clipboard

Constructors​

constructor​

• new ClaimService(__namedParametersCopy to Clipboard)

Parameters​

NameType
__namedParametersCopy to ClipboardInjectedDependenciesCopy to Clipboard

Overrides​

TransactionBaseService.constructor

Defined in​

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

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​

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

__container__​

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

Inherited from​

TransactionBaseService.__container__

Defined in​

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

__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​

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

addressRepository_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard addressRepository_: typeof AddressRepositoryCopy to Clipboard

Defined in​

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

claimItemService_​

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

Defined in​

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

claimRepository_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard claimRepository_: typeof ClaimRepositoryCopy to Clipboard

Defined in​

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

eventBus_​

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

Defined in​

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

fulfillmentProviderService_​

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

Defined in​

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

fulfillmentService_​

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

Defined in​

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

lineItemRepository_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard lineItemRepository_: typeof LineItemRepositoryCopy to Clipboard

Defined in​

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

lineItemService_​

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

Defined in​

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

manager_​

• ProtectedCopy to Clipboard manager_: EntityManagerCopy to Clipboard

Overrides​

TransactionBaseService.manager_

Defined in​

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

paymentProviderService_​

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

Defined in​

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

productVariantInventoryService_​

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

Defined in​

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

regionService_​

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

Defined in​

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

returnService_​

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

Defined in​

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

shippingMethodRepository_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard shippingMethodRepository_: typeof ShippingMethodRepositoryCopy to Clipboard

Defined in​

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

shippingOptionService_​

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

Defined in​

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

taxProviderService_​

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

Defined in​

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

totalsService_​

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

Defined in​

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

transactionManager_​

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

Overrides​

TransactionBaseService.transactionManager_

Defined in​

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

Events​

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

Type declaration​

NameType
CANCELEDCopy to ClipboardstringCopy to Clipboard
CREATEDCopy to ClipboardstringCopy to Clipboard
FULFILLMENT_CREATEDCopy to ClipboardstringCopy to Clipboard
REFUND_PROCESSEDCopy to ClipboardstringCopy to Clipboard
SHIPMENT_CREATEDCopy to ClipboardstringCopy to Clipboard
UPDATEDCopy to ClipboardstringCopy to Clipboard

Defined in​

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

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​

NameTypeDescription
workCopy to Clipboard(transactionManagerCopy to Clipboard: EntityManagerCopy to Clipboard) => PromiseCopy to Clipboard<TResultCopy to Clipboard>the transactional work to be done
isolationOrErrorHandler?Copy to ClipboardIsolationLevelCopy 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​

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

cancel​

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

Parameters​

NameType
idCopy to ClipboardstringCopy to Clipboard

Returns​

PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard>

Defined in​

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

cancelFulfillment​

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

Parameters​

NameType
fulfillmentIdCopy to ClipboardstringCopy to Clipboard

Returns​

PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard>

Defined in​

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

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​

NameTypeDescription
dataCopy to ClipboardCreateClaimInputCopy to Clipboardthe object containing all data required to create a claim

Returns​

PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard>

created claim

Defined in​

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

createFulfillment​

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

Parameters​

NameTypeDescription
idCopy to ClipboardstringCopy to Clipboardthe object containing all data required to create a claim
configCopy to ClipboardObjectCopy to Clipboardconfig object
config.metadata?Copy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>config metadata
config.no_notification?Copy to ClipboardbooleanCopy to Clipboardconfig no notification

Returns​

PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard>

created claim

Defined in​

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

createShipment​

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

Parameters​

NameTypeDefault value
idCopy to ClipboardstringCopy to ClipboardundefinedCopy to Clipboard
fulfillmentIdCopy to ClipboardstringCopy to ClipboardundefinedCopy to Clipboard
trackingLinksCopy to Clipboard{ tracking_numberCopy to Clipboard: stringCopy to Clipboard }[][]Copy to Clipboard
configCopy to ClipboardObjectCopy to ClipboardundefinedCopy to Clipboard
config.metadataCopy to ClipboardObjectCopy to Clipboard{}Copy to Clipboard
config.no_notificationCopy to ClipboardundefinedCopy to ClipboardundefinedCopy to Clipboard

Returns​

PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard>

Defined in​

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

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​

NameTypeDescription
orderCopy to ClipboardOrderCopy to Clipboardthe order to find claim lines on
claimItemsCopy to ClipboardCreateClaimItemInputCopy to Clipboard[]the claim items to match against

Returns​

PromiseCopy to Clipboard<numberCopy to Clipboard>

the refund amount

Defined in​

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

list​

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

Parameters​

NameTypeDescription
selectorCopy to ClipboardanyCopy to Clipboardthe query object for find
configCopy to ClipboardFindConfigCopy 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​

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

processRefund​

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

Parameters​

NameType
idCopy to ClipboardstringCopy to Clipboard

Returns​

PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard>

Defined in​

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

retrieve​

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

Gets an order by id.

Parameters​

NameTypeDescription
claimIdCopy to ClipboardstringCopy to Clipboardid of the claim order to retrieve
configCopy to ClipboardFindConfigCopy to Clipboard<ClaimOrderCopy to Clipboard>the config object containing query settings

Returns​

PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard>

the order document

Defined in​

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

shouldRetryTransaction_​

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

Parameters​

NameType
errCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | { codeCopy to Clipboard: stringCopy to Clipboard }

Returns​

booleanCopy to Clipboard

Inherited from​

TransactionBaseService.shouldRetryTransaction_

Defined in​

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

update​

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

Parameters​

NameType
idCopy to ClipboardstringCopy to Clipboard
dataCopy to ClipboardUpdateClaimInputCopy to Clipboard

Returns​

PromiseCopy to Clipboard<ClaimOrderCopy to Clipboard>

Defined in​

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

validateCreateClaimInput​

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

Parameters​

NameType
dataCopy to ClipboardCreateClaimInputCopy to Clipboard

Returns​

PromiseCopy to Clipboard<voidCopy to Clipboard>

Defined in​

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

withTransaction​

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

Parameters​

NameType
transactionManager?Copy to ClipboardEntityManagerCopy to Clipboard

Returns​

ClaimServiceCopy to Clipboard

Inherited from​

TransactionBaseService.withTransaction

Defined in​

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