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,120 @@
+type: object
+required:
+  - type
+  - claim_items
+properties:
+  type:
+    description: >-
+      The type of the Claim. This will determine how the Claim is treated:
+      `replace` Claims will result in a Fulfillment with new items being
+      created, while a `refund` Claim will refund the amount paid for the
+      claimed items.
+    type: string
+    enum:
+      - replace
+      - refund
+  claim_items:
+    description: The Claim Items that the Claim will consist of.
+    type: array
+    items:
+      type: object
+      required:
+        - item_id
+        - quantity
+      properties:
+        item_id:
+          description: The ID of the Line Item that will be claimed.
+          type: string
+        quantity:
+          description: The number of items that will be returned
+          type: integer
+        note:
+          description: Short text describing the Claim Item in further detail.
+          type: string
+        reason:
+          description: The reason for the Claim
+          type: string
+          enum:
+            - missing_item
+            - wrong_item
+            - production_failure
+            - other
+        tags:
+          description: A list of tags to add to the Claim Item
+          type: array
+          items:
+            type: string
+        images:
+          description: A list of image URL's that will be associated with the Claim
+          items:
+            type: string
+  return_shipping:
+    description: >-
+      Optional details for the Return Shipping Method, if the items are to be
+      sent back. Providing this field will result in a return being created and
+      associated with the claim.
+    type: object
+    properties:
+      option_id:
+        type: string
+        description: The ID of the Shipping Option to create the Shipping Method from.
+      price:
+        type: integer
+        description: The price to charge for the Shipping Method.
+  additional_items:
+    description: >-
+      The new items to send to the Customer. This is only used if the claim's
+      type is `replace`.
+    type: array
+    items:
+      type: object
+      required:
+        - variant_id
+        - quantity
+      properties:
+        variant_id:
+          description: The ID of the Product Variant.
+          type: string
+        quantity:
+          description: The quantity of the Product Variant.
+          type: integer
+  shipping_methods:
+    description: >-
+      The Shipping Methods to send the additional Line Items with. This is only
+      used if the claim's type is `replace`.
+    type: array
+    items:
+      type: object
+      properties:
+        id:
+          description: The ID of an existing Shipping Method
+          type: string
+        option_id:
+          description: The ID of the Shipping Option to create a Shipping Method from
+          type: string
+        price:
+          description: The price to charge for the Shipping Method
+          type: integer
+        data:
+          description: An optional set of key-value pairs to hold additional information.
+          type: object
+  shipping_address:
+    description: >-
+      An optional shipping address to send the claimed items to. If not
+      provided, the parent order's shipping address will be used.
+    $ref: ./AddressPayload.yaml
+  refund_amount:
+    description: >-
+      The amount to refund the customer. This is used when the claim's type is
+      `refund`.
+    type: integer
+  no_notification:
+    description: If set to true no notification will be send related to this Claim.
+    type: boolean
+  metadata:
+    description: An optional set of key-value pairs to hold additional information.
+    type: object
+    externalDocs:
+      description: Learn about the metadata attribute, and how to delete and update it.
+      url: >-
+        https://docs.medusajs.com/development/entities/overview#metadata-attribute