medusa-store/docs/content/references/services/classes/ClaimService.md

Class: ClaimService

Hierarchy

• TransactionBaseService<ClaimService, InjectedDependencies>

  ↳ ClaimService

Constructors

constructor

• new ClaimService(__namedParameters)

Parameters

Name	Type
__namedParameters	InjectedDependencies

Overrides

TransactionBaseService< ClaimService, InjectedDependencies &gt;.constructor

Defined in

services/claim.ts:85

Properties

addressRepository_

• Protected Readonly addressRepository_: typeof AddressRepository

Defined in

services/claim.ts:68

---

claimItemService_

• Protected Readonly claimItemService_: ClaimItemService

Defined in

services/claim.ts:72

---

claimRepository_

• Protected Readonly claimRepository_: typeof ClaimRepository

Defined in

services/claim.ts:69

---

configModule

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

Inherited from

TransactionBaseService.configModule

---

container

• Protected Readonly container: InjectedDependencies

Inherited from

TransactionBaseService.container

---

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

services/claim.ts:73

---

fulfillmentProviderService_

• Protected Readonly fulfillmentProviderService_: FulfillmentProviderService

Defined in

services/claim.ts:74

---

fulfillmentService_

• Protected Readonly fulfillmentService_: FulfillmentService

Defined in

services/claim.ts:75

---

inventoryService_

• Protected Readonly inventoryService_: InventoryService

Defined in

services/claim.ts:76

---

lineItemRepository_

• Protected Readonly lineItemRepository_: typeof LineItemRepository

Defined in

services/claim.ts:71

---

lineItemService_

• Protected Readonly lineItemService_: LineItemService

Defined in

services/claim.ts:77

---

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

services/claim.ts:65

---

paymentProviderService_

• Protected Readonly paymentProviderService_: PaymentProviderService

Defined in

services/claim.ts:78

---

regionService_

• Protected Readonly regionService_: RegionService

Defined in

services/claim.ts:79

---

returnService_

• Protected Readonly returnService_: ReturnService

Defined in

services/claim.ts:80

---

shippingMethodRepository_

• Protected Readonly shippingMethodRepository_: typeof ShippingMethodRepository

Defined in

services/claim.ts:70

---

shippingOptionService_

• Protected Readonly shippingOptionService_: ShippingOptionService

Defined in

services/claim.ts:81

---

taxProviderService_

• Protected Readonly taxProviderService_: TaxProviderService

Defined in

services/claim.ts:82

---

totalsService_

• Protected Readonly totalsService_: TotalsService

Defined in

services/claim.ts:83

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

services/claim.ts:66

---

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

services/claim.ts:56

Methods

atomicPhase_

▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Type parameters

Name
TResult
TError

Parameters

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

Returns

Promise<TResult>

Inherited from

TransactionBaseService.atomicPhase_

Defined in

interfaces/transaction-base-service.ts:53

---

cancel

▸ cancel(id): Promise<ClaimOrder>

Parameters

Name	Type
id	string

Returns

Promise<ClaimOrder>

Defined in

services/claim.ts:753

---

cancelFulfillment

▸ cancelFulfillment(fulfillmentId): Promise<ClaimOrder>

Parameters

Name	Type
fulfillmentId	string

Returns

Promise<ClaimOrder>

Defined in

services/claim.ts:602

---

create

▸ create(data): Promise<ClaimOrder>

Parameters

Name	Type	Description
data	CreateClaimInput

Returns

Promise<ClaimOrder>

Defined in

services/claim.ts:217

---

createFulfillment

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

Parameters

Name	Type	Description
id	string
config	Object
config.metadata?	Record<string, unknown>
config.no_notification?	boolean

Returns

Promise<ClaimOrder>

Defined in

services/claim.ts:456

---

createShipment

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

Parameters

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

Returns

Promise<ClaimOrder>

Defined in

services/claim.ts:674

---

list

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

Parameters

Name	Type	Description
selector	any
config	FindConfig<ClaimOrder>

Returns

Promise<ClaimOrder[]>

Defined in

services/claim.ts:809

---

processRefund

▸ processRefund(id): Promise<ClaimOrder>

Parameters

Name	Type
id	string

Returns

Promise<ClaimOrder>

Defined in

services/claim.ts:628

---

retrieve

▸ retrieve(id, config?): Promise<ClaimOrder>

Parameters

Name	Type	Description
id	string
config	FindConfig<ClaimOrder>

Returns

Promise<ClaimOrder>

Defined in

services/claim.ts:834

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

interfaces/transaction-base-service.ts:34

---

update

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

Parameters

Name	Type
id	string
data	UpdateClaimInput

Returns

Promise<ClaimOrder>

Defined in

services/claim.ts:127

---

withTransaction

▸ withTransaction(transactionManager?): ClaimService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

ClaimService

Inherited from

TransactionBaseService.withTransaction

Defined in

interfaces/transaction-base-service.ts:16