docs: enhance how references are generated (#5805)

* adjusted configurations * enhancements to tool and configurations * change reference in docs * fixed issue in workflows reference * added project name * more optimizations * fix context error * added a types reference * resolved missing types * fix reference reflection types not having children * add an expand url parameter * added new option to the README * added details about new option
2023-12-05 15:29:41 +02:00
parent a418e6cebc
commit 892d737c1f
4358 changed files with 947876 additions and 534760 deletions
@@ -0,0 +1,98 @@
+---
+displayed_sidebar: homepage
+---
+
+import ParameterTypes from "@site/src/components/ParameterTypes"
+
+# AdminPostDraftOrdersDraftOrderReq
+
+## constructor
+
+___
+
+## Properties
+
+<ParameterTypes parameters={[
+  {
+    "name": "billing_address",
+    "type": "`string` \\| [AddressPayload](medusa.AddressPayload.mdx)",
+    "description": "The Address to be used for billing purposes.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "country_code",
+    "type": "`string`",
+    "description": "The 2 character ISO code for the Country.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "customer_id",
+    "type": "`string`",
+    "description": "The ID of the customer this draft order is associated with.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "discounts",
+    "type": "[Discount](medusa.Discount-1.mdx)[]",
+    "description": "An array of Discount codes to add to the Draft Order.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": [
+      {
+        "name": "code",
+        "type": "`string`",
+        "description": "The code that a Discount is identifed by.",
+        "optional": false,
+        "defaultValue": "",
+        "expandable": false,
+        "children": []
+      }
+    ]
+  },
+  {
+    "name": "email",
+    "type": "`string`",
+    "description": "An email to be used in the Draft Order.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "no_notification_order",
+    "type": "`boolean`",
+    "description": "An optional flag passed to the resulting order that indicates whether the customer should receive notifications about order updates.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "region_id",
+    "type": "`string`",
+    "description": "The ID of the Region to create the Draft Order in.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "shipping_address",
+    "type": "`string` \\| [AddressPayload](medusa.AddressPayload.mdx)",
+    "description": "The Address to be used for shipping purposes.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  }
+]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>