asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
362abdfad7c4b7ffef225a063797e163cd4e2bce
medusa-store/www/docs/content/references/services/classes/ClaimService.md
Shahed Nasser 914d773d3a api-ref: custom API reference (#4770) 
* initialized next.js project

* finished markdown sections

* added operation schema component

* change page metadata

* eslint fixes

* fixes related to deployment

* added response schema

* resolve max stack issue

* support for different property types

* added support for property types

* added loading for components

* added more loading

* type fixes

* added oneOf type

* removed console

* fix replace with push

* refactored everything

* use static content for description

* fixes and improvements

* added code examples section

* fix path name

* optimizations

* fixed tag navigation

* add support for admin and store references

* general enhancements

* optimizations and fixes

* fixes and enhancements

* added search bar

* loading enhancements

* added loading

* added code blocks

* added margin top

* add empty response text

* fixed oneOf parameters

* added path and query parameters

* general fixes

* added base path env variable

* small fix for arrays

* enhancements

* design enhancements

* general enhancements

* fix isRequired

* added enum values

* enhancements

* general fixes

* general fixes

* changed oas generation script

* additions to the introduction section

* added copy button for code + other enhancements

* fix response code block

* fix metadata

* formatted store introduction

* move sidebar logic to Tags component

* added test env variables

* fix code block bug

* added loading animation

* added expand param + loading

* enhance operation loading

* made responsive + improvements

* added loading provider

* fixed loading

* adjustments for small devices

* added sidebar label for endpoints

* added feedback component

* fixed analytics

* general fixes

* listen to scroll for other headings

* added sample env file

* update api ref files + support new fields

* fix for external docs link

* added new sections

* fix last item in sidebar not showing

* move docs content to www/docs

* change redirect url

* revert change

* resolve build errors

* configure rewrites

* changed to environment variable url

* revert changing environment variable name

* add environment variable for API path

* fix links

* fix tailwind settings

* remove vercel file

* reconfigured api route

* move api page under api

* fix page metadata

* fix external link in navigation bar

* update api spec

* updated api specs

* fixed google lint error

* add max-height on request samples

* add padding before loading

* fix for one of name

* fix undefined types

* general fixes

* remove response schema example

* redesigned navigation bar

* redesigned sidebar

* fixed up paddings

* added feedback component + report issue

* fixed up typography, padding, and general styling

* redesigned code blocks

* optimization

* added error timeout

* fixes

* added indexing with algolia + fixes

* fix errors with algolia script

* redesign operation sections

* fix heading scroll

* design fixes

* fix padding

* fix padding + scroll issues

* fix scroll issues

* improve scroll performance

* fixes for safari

* optimization and fixes

* fixes to docs + details animation

* padding fixes for code block

* added tab animation

* fixed incorrect link

* added selection styling

* fix lint errors

* redesigned details component

* added detailed feedback form

* api reference fixes

* fix tabs

* upgrade + fixes

* updated documentation links

* optimizations to sidebar items

* fix spacing in sidebar item

* optimizations and fixes

* fix endpoint path styling

* remove margin

* final fixes

* change margin on small devices

* generated OAS

* fixes for mobile

* added feedback modal

* optimize dark mode button

* fixed color mode useeffect

* minimize dom size

* use new style system

* radius and spacing design system

* design fixes

* fix eslint errors

* added meta files

* change cron schedule

* fix docusaurus configurations

* added operating system to feedback data

* change content directory name

* fixes to contribution guidelines

* revert renaming content

* added api-reference to documentation workflow

* fixes for search

* added dark mode + fixes

* oas fixes

* handle bugs

* added code examples for clients

* changed tooltip text

* change authentication to card

* change page title based on selected section

* redesigned mobile navbar

* fix icon colors

* fix key colors

* fix medusa-js installation command

* change external regex in algolia

* change changeset

* fix padding on mobile

* fix hydration error

* update depedencies
2023-08-15 18:07:54 +03:00

15 KiB
Raw Blame History

Class: ClaimService

Hierarchy

  • TransactionBaseService

    ↳ ClaimService

Constructors

constructor

• new ClaimService(__namedParameters)

Parameters

Name Type
__namedParameters InjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/claim.ts:86

Properties

__configModule__

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

Inherited from

TransactionBaseService.__configModule__

Defined in

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

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

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

__moduleDeclaration__

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

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

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

addressRepository_

• Protected Readonly addressRepository_: Repository<Address>

Defined in

medusa/src/services/claim.ts:68

claimItemService_

• Protected Readonly claimItemService_: ClaimItemService

Defined in

medusa/src/services/claim.ts:72

claimRepository_

• Protected Readonly claimRepository_: Repository<ClaimOrder>

Defined in

medusa/src/services/claim.ts:69

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

medusa/src/services/claim.ts:73

fulfillmentProviderService_

• Protected Readonly fulfillmentProviderService_: FulfillmentProviderService

Defined in

medusa/src/services/claim.ts:74

fulfillmentService_

• Protected Readonly fulfillmentService_: FulfillmentService

Defined in

medusa/src/services/claim.ts:75

lineItemRepository_

• Protected Readonly lineItemRepository_: Repository<LineItem> & { findByReturn: (returnId: string) => Promise<LineItem & { return_item: ReturnItem }[]> }

Defined in

medusa/src/services/claim.ts:71

lineItemService_

• Protected Readonly lineItemService_: LineItemService

Defined in

medusa/src/services/claim.ts:76

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

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

paymentProviderService_

• Protected Readonly paymentProviderService_: PaymentProviderService

Defined in

medusa/src/services/claim.ts:77

productVariantInventoryService_

• Protected Readonly productVariantInventoryService_: ProductVariantInventoryService

Defined in

medusa/src/services/claim.ts:84

regionService_

• Protected Readonly regionService_: RegionService

Defined in

medusa/src/services/claim.ts:78

returnService_

• Protected Readonly returnService_: ReturnService

Defined in

medusa/src/services/claim.ts:79

shippingMethodRepository_

• Protected Readonly shippingMethodRepository_: Repository<ShippingMethod>

Defined in

medusa/src/services/claim.ts:70

shippingOptionService_

• Protected Readonly shippingOptionService_: ShippingOptionService

Defined in

medusa/src/services/claim.ts:80

taxProviderService_

• Protected Readonly taxProviderService_: TaxProviderService

Defined in

medusa/src/services/claim.ts:81

totalsService_

• Protected Readonly totalsService_: TotalsService

Defined in

medusa/src/services/claim.ts:82

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

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

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

medusa/src/services/claim.ts:59

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

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

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

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

cancel

▸ cancel(id): Promise<ClaimOrder>

Parameters

Name Type
id string

Returns

Promise<ClaimOrder>

Defined in

medusa/src/services/claim.ts:814

cancelFulfillment

▸ cancelFulfillment(fulfillmentId): Promise<ClaimOrder>

Parameters

Name Type
fulfillmentId string

Returns

Promise<ClaimOrder>

Defined in

medusa/src/services/claim.ts:662

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

medusa/src/services/claim.ts:331

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.location_id? string -
config.metadata? Record<string, unknown> config metadata
config.no_notification? boolean config no notification

Returns

Promise<ClaimOrder>

created claim

Defined in

medusa/src/services/claim.ts:512

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

medusa/src/services/claim.ts:734

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

Name Type Description
order Order the order to find claim lines on
claimItems CreateClaimItemInput[] the claim items to match against

Returns

Promise<number>

the refund amount

Defined in

medusa/src/services/claim.ts:273

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

medusa/src/services/claim.ts:870

processRefund

▸ processRefund(id): Promise<ClaimOrder>

Parameters

Name Type
id string

Returns

Promise<ClaimOrder>

Defined in

medusa/src/services/claim.ts:688

retrieve

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

Gets an order by id.

Parameters

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

medusa/src/services/claim.ts:889

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

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

update

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

Parameters

Name Type
id string
data UpdateClaimInput

Returns

Promise<ClaimOrder>

Defined in

medusa/src/services/claim.ts:125

validateCreateClaimInput

▸ Protected validateCreateClaimInput(data): Promise<void>

Parameters

Name Type
data CreateClaimInput

Returns

Promise<void>

Defined in

medusa/src/services/claim.ts:206

withTransaction

▸ withTransaction(transactionManager?): ClaimService

Parameters

Name Type
transactionManager? EntityManager

Returns

ClaimService

Inherited from

TransactionBaseService.withTransaction

Defined in

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

Reference in New Issue View Git Blame Copy Permalink