Files
medusa-store/docs/content/references/services/classes/ClaimItemService.md
2022-06-01 18:33:08 +02:00

3.9 KiB

Class: ClaimItemService

Hierarchy

  • "medusa-interfaces"

    ClaimItemService

Constructors

constructor

new ClaimItemService(__namedParameters)

Parameters

Name Type
__namedParameters Object

Overrides

BaseService.constructor

Defined in

services/claim-item.js:11

Properties

claimImageRepository_

claimImageRepository_: any

Defined in

services/claim-item.js:27


claimTagRepository_

claimTagRepository_: any

Defined in

services/claim-item.js:26


Events

Static Events: Object

Type declaration

Name Type
CANCELED string
CREATED string
UPDATED string

Defined in

services/claim-item.js:5

Methods

cancel

cancel(id): Promise<void>

Parameters

Name Type
id any

Returns

Promise<void>

Defined in

services/claim-item.js:212


create

create(data): any

Parameters

Name Type
data any

Returns

any

Defined in

services/claim-item.js:55


deleteMetadata

deleteMetadata(orderId, key): Promise<any>

Dedicated method to delete metadata for an order.

Parameters

Name Type Description
orderId string the order to delete metadata from.
key string key for metadata field

Returns

Promise<any>

resolves to the updated result.

Defined in

services/claim-item.js:259


list

list(selector, config?): Promise<any>

Parameters

Name Type Description
selector any the query object for find
config any the config object for find

Returns

Promise<any>

the result of the find operation

Defined in

services/claim-item.js:219


retrieve

retrieve(id, config?): Promise<Order>

Gets a claim item by id.

Parameters

Name Type Description
id string id of ClaimItem to retrieve
config any configuration for the find operation

Returns

Promise<Order>

the ClaimItem

Defined in

services/claim-item.js:234


update

update(id, data): any

Parameters

Name Type
id any
data any

Returns

any

Defined in

services/claim-item.js:135


withTransaction

withTransaction(manager): ClaimItemService

Parameters

Name Type
manager any

Returns

ClaimItemService

Defined in

services/claim-item.js:36