asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
dab50de0b49dbf60ba4f2683fa1df28bee6ae83a
medusa-store/docs/content/references/services/classes/ClaimService.md
github-actions[bot] dab50de0b4 chore(docs): Generated Services Reference (automated) (#2221) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2022-09-15 18:39:53 +03:00

13 KiB
Raw Blame History

Class: ClaimService

Hierarchy

  • TransactionBaseService

    ↳ ClaimService

Constructors

constructor

• new ClaimService(__namedParameters)

Parameters

Name Type
__namedParameters InjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

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

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

addressRepository_

• Protected Readonly addressRepository_: typeof AddressRepository

Defined in

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

claimItemService_

• Protected Readonly claimItemService_: ClaimItemService

Defined in

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

claimRepository_

• Protected Readonly claimRepository_: typeof ClaimRepository

Defined in

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

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

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

fulfillmentProviderService_

• Protected Readonly fulfillmentProviderService_: FulfillmentProviderService

Defined in

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

fulfillmentService_

• Protected Readonly fulfillmentService_: FulfillmentService

Defined in

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

inventoryService_

• Protected Readonly inventoryService_: InventoryService

Defined in

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

lineItemRepository_

• Protected Readonly lineItemRepository_: typeof LineItemRepository

Defined in

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

lineItemService_

• Protected Readonly lineItemService_: LineItemService

Defined in

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

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

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

paymentProviderService_

• Protected Readonly paymentProviderService_: PaymentProviderService

Defined in

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

regionService_

• Protected Readonly regionService_: RegionService

Defined in

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

returnService_

• Protected Readonly returnService_: ReturnService

Defined in

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

shippingMethodRepository_

• Protected Readonly shippingMethodRepository_: typeof ShippingMethodRepository

Defined in

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

shippingOptionService_

• Protected Readonly shippingOptionService_: ShippingOptionService

Defined in

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

taxProviderService_

• Protected Readonly taxProviderService_: TaxProviderService

Defined in

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

totalsService_

• Protected Readonly totalsService_: TotalsService

Defined in

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

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

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

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

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

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

Name Type Description
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

Name Type
id string

Returns

Promise<ClaimOrder>

Defined in

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

cancelFulfillment

▸ cancelFulfillment(fulfillmentId): Promise<ClaimOrder>

Parameters

Name Type
fulfillmentId string

Returns

Promise<ClaimOrder>

Defined in

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

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

Returns

Promise<ClaimOrder>

created claim

Defined in

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

createFulfillment

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

Parameters

Name Type Description
id string the object containing all data required to create a claim
config Object config object
config.metadata? Record<string, unknown> config metadata
config.no_notification? boolean config no notification

Returns

Promise<ClaimOrder>

created claim

Defined in

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

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

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

list

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

Parameters

Name Type Description
selector any the query object for find
config FindConfig<ClaimOrder> the config object containing query settings

Returns

Promise<ClaimOrder[]>

the result of the find operation

Defined in

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

processRefund

▸ processRefund(id): Promise<ClaimOrder>

Parameters

Name Type
id string

Returns

Promise<ClaimOrder>

Defined in

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

retrieve

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

Gets an order by id.

Parameters

Name Type Description
id string id of the claim order to retrieve
config FindConfig<ClaimOrder> the config object containing query settings

Returns

Promise<ClaimOrder>

the order document

Defined in

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

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name Type
err Record<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

Name Type
id string
data UpdateClaimInput

Returns

Promise<ClaimOrder>

Defined in

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

withTransaction

▸ withTransaction(transactionManager?): ClaimService

Parameters

Name Type
transactionManager? EntityManager

Returns

ClaimService

Inherited from

TransactionBaseService.withTransaction

Defined in

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

Reference in New Issue View Git Blame Copy Permalink