7d650771d1
* add new plugin for better organization * added handling in theme for mutations and query types * added tsdoc to hooks * added tsdocs to utility functions * added tsdoc to providers * generated reference * general fixes for generated reference * generated api reference specs + general fixes * add missing import react * split utilities into different directories * added overview page * added link to customer authentication section * fix lint errors * added changeset * fix readme * fixed build error * added expand fields + other sections to overview * updated what's new section * general refactoring * remove unnecessary query field * fix links * added ignoreApi option
15 lines
4.7 KiB
Plaintext
15 lines
4.7 KiB
Plaintext
---
|
|
displayed_sidebar: entitiesSidebar
|
|
slug: /references/entities/classes/ClaimImage
|
|
---
|
|
|
|
import ParameterTypes from "@site/src/components/ParameterTypes"
|
|
|
|
# ClaimImage
|
|
|
|
The details of an image attached to a claim.
|
|
|
|
## Properties
|
|
|
|
<ParameterTypes parameters={[{"name":"claim_item","type":"[ClaimItem](entities.ClaimItem.mdx)","description":"The details of the claim item this image is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"claim_order","type":"[ClaimOrder](entities.ClaimOrder.mdx)","description":"The details of the claim this item belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim_order_id","type":"`string`","description":"The ID of the claim this item is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The claim item's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[ClaimImage](entities.ClaimImage.mdx)[]","description":"The claim images that are attached to the claim item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"item","type":"[LineItem](entities.LineItem.mdx)","description":"The details of the line item in the original order that this claim item refers to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"item_id","type":"`string`","description":"The ID of the line item that the claim item refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"An optional note about the claim, for additional information","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item that is being claimed; must be less than or equal to the amount purchased in the original order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"[ClaimReason](../enums/entities.ClaimReason.mdx)","description":"The reason for the claim","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ClaimTag](entities.ClaimTag.mdx)[]","description":"User defined tags for easy filtering and grouping.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](entities.ProductVariant.mdx)","description":"The details of the product variant to potentially replace the item in the original order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`string`","description":"The ID of the product variant that is claimed.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"claim_item_id","type":"`string`","description":"The ID of the claim item associated with the image","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The claim image's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the image","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
|