docs: create docs workspace (#5174)

* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
2023-09-21 20:57:15 +03:00
parent 19c5d5ba36
commit fa7c94b4cc
3209 changed files with 32188 additions and 31018 deletions
@@ -0,0 +1,106 @@
+title: Claim Item
+description: >-
+  A claim item is an item created as part of a claim. It references an item in
+  the order that should be exchanged or refunded.
+type: object
+required:
+  - claim_order_id
+  - created_at
+  - deleted_at
+  - id
+  - item_id
+  - metadata
+  - note
+  - quantity
+  - reason
+  - updated_at
+  - variant_id
+properties:
+  id:
+    description: The claim item's ID
+    type: string
+    example: citm_01G8ZH853Y6TFXWPG5EYE81X63
+  images:
+    description: The claim images that are attached to the claim item.
+    type: array
+    x-expandable: images
+    items:
+      $ref: ./ClaimImage.yaml
+  claim_order_id:
+    description: The ID of the claim this item is associated with.
+    type: string
+  claim_order:
+    description: The details of the claim this item belongs to.
+    x-expandable: claim_order
+    nullable: true
+    type: object
+  item_id:
+    description: The ID of the line item that the claim item refers to.
+    type: string
+    example: item_01G8ZM25TN49YV9EQBE2NC27KC
+  item:
+    description: >-
+      The details of the line item in the original order that this claim item
+      refers to.
+    x-expandable: item
+    nullable: true
+    $ref: ./LineItem.yaml
+  variant_id:
+    description: The ID of the product variant that is claimed.
+    type: string
+    example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
+  variant:
+    description: >-
+      The details of the product variant to potentially replace the item in the
+      original order.
+    x-expandable: variant
+    nullable: true
+    $ref: ./ProductVariant.yaml
+  reason:
+    description: The reason for the claim
+    type: string
+    enum:
+      - missing_item
+      - wrong_item
+      - production_failure
+      - other
+  note:
+    description: An optional note about the claim, for additional information
+    nullable: true
+    type: string
+    example: I don't like it.
+  quantity:
+    description: >-
+      The quantity of the item that is being claimed; must be less than or equal
+      to the amount purchased in the original order.
+    type: integer
+    example: 1
+  tags:
+    description: User defined tags for easy filtering and grouping.
+    type: array
+    x-expandable: tags
+    items:
+      $ref: ./ClaimTag.yaml
+  created_at:
+    description: The date with timezone at which the resource was created.
+    type: string
+    format: date-time
+  updated_at:
+    description: The date with timezone at which the resource was updated.
+    type: string
+    format: date-time
+  deleted_at:
+    description: The date with timezone at which the resource was deleted.
+    nullable: true
+    type: string
+    format: date-time
+  metadata:
+    description: An optional key-value map with additional details
+    nullable: true
+    type: object
+    example:
+      car: white
+    externalDocs:
+      description: Learn about the metadata attribute, and how to delete and update it.
+      url: >-
+        https://docs.medusajs.com/development/entities/overview#metadata-attribute