chore(docs): Generated References (#5602)

Generated the following references:
- `pricing`
- `product`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>

docs-util/packages/typedoc-config/_base.js

@@ -6,13 +6,14 @@ const pathPrefix = path.join(__dirname, "..", "..", "..")
 /** @type {import('typedoc').TypeDocOptions} */
 module.exports = {
   // extends: [typedocConfig],
-  plugin: ["typedoc-plugin-markdown-medusa"],
+  plugin: ["typedoc-plugin-markdown-medusa", "typedoc-plugin-custom"],
   readme: "none",
   eslintPathName: path.join(
     pathPrefix,
     "www/packages/eslint-config-docs/content.js"
   ),
   pluginsResolvePath: path.join(pathPrefix, "www"),
+  exclude: [path.join(pathPrefix, "node_modules/**")],
   // Uncomment this when debugging
   // showConfig: true,
 }

docs-util/packages/typedoc-config/_modules.js

@@ -79,12 +79,7 @@ module.exports = ({
     entryPointStrategy: "expand",
     hideInPageTOC: true,
     hideBreadcrumbs: true,
-    plugin: [
-      ...globalTypedocOptions.plugin,
-      "typedoc-plugin-custom",
-      "typedoc-plugin-rename-defaults",
-      "typedoc-plugin-frontmatter",
-    ],
+    plugin: [...globalTypedocOptions.plugin, "typedoc-plugin-rename-defaults"],
     formatting,
     allReflectionsHaveOwnDocument: true,
     objectLiteralTypeDeclarationStyle: "component",

docs-util/packages/typedoc-config/entities.js

@@ -11,13 +11,9 @@ module.exports = {
   tsconfig: path.join(__dirname, "extended-tsconfig", "medusa.json"),
   name: "Entities Reference",
   indexTitle: "Entities Reference",
-  entryDocument: "_index.mdx",
+  entryDocument: "index.mdx",
   hideInPageTOC: true,
   hideBreadcrumbs: true,
-  plugin: [...globalTypedocOptions.plugin, "typedoc-plugin-frontmatter"],
-  frontmatterData: {
-    displayed_sidebar: "entitiesSidebar",
-  },
   formatting: {
     "*": {
       showCommentsAsHeader: true,
@@ -34,8 +30,15 @@ module.exports = {
         Constructors: false,
         Methods: false,
       },
+      frontmatterData: {
+        displayed_sidebar: "entitiesSidebar",
+      },
+    },
+    "(Order|Swap|Cart|LineItem)": {
+      maxLevel: 1,
     },
   },
   objectLiteralTypeDeclarationStyle: "component",
   mdxOutput: true,
+  maxLevel: 2,
 }

docs-util/packages/typedoc-config/js-client.js

@@ -28,6 +28,14 @@ const defaultFormattingOptions = {
   },
 }
 
+const classesFormattingOptions = {
+  ...defaultFormattingOptions,
+  frontmatterData: {
+    ...defaultFormattingOptions.frontmatterData,
+    slug: "/references/js-client/{{alias}}",
+  },
+}
+
 /** @type {import('typedoc').TypeDocOptions} */
 module.exports = {
   ...globalTypedocOptions,
@@ -36,26 +44,32 @@ module.exports = {
   tsconfig: path.join(__dirname, "extended-tsconfig", "js-client.json"),
   name: "JS Client Reference",
   indexTitle: "JS Client Reference",
-  entryDocument: "_index.mdx",
+  entryDocument: "index.mdx",
   hideInPageTOC: true,
   hideBreadcrumbs: true,
-  plugin: [
-    ...globalTypedocOptions.plugin,
-    "typedoc-plugin-rename-defaults",
-    "typedoc-plugin-custom",
-  ],
+  plugin: [...globalTypedocOptions.plugin, "typedoc-plugin-rename-defaults"],
   exclude: [
+    ...globalTypedocOptions.exclude,
     path.join(pathPrefix, "packages/medusa-js/src/resources/base.ts"),
-    path.join(pathPrefix, "node_modules/**"),
   ],
   internalModule: "internal",
   formatting: {
     "*": defaultFormattingOptions,
-    "^classes/": {
-      ...defaultFormattingOptions,
-      frontmatterData: {
-        ...defaultFormattingOptions.frontmatterData,
-        slug: "/references/js-client/{{alias}}",
+    "^classes/": classesFormattingOptions,
+    AdminOrdersResource: {
+      maxLevel: 2,
+    },
+    internal: {
+      maxLevel: 1,
+    },
+    "internal/modules/internal": {
+      reflectionGroups: {
+        ...defaultFormattingOptions.reflectionGroups,
+        "Type Aliases": false,
+        Enumerations: false,
+        Classes: false,
+        Functions: false,
+        Interfaces: false,
       },
     },
   },
@@ -63,4 +77,7 @@ module.exports = {
   mdxOutput: true,
   maxLevel: 4,
   ignoreApi: true,
+  outputModules: false,
+  outputNamespace: false,
+  excludeReferences: true,
 }

docs-util/packages/typedoc-config/pricing.js

@@ -7,17 +7,11 @@ module.exports = modulesConfig({
   moduleName: "Pricing Module Reference",
   documentsToFormat: [
     {
-      pattern: "IPricingModuleService.md",
+      pattern: "*",
+      useDefaults: true,
       additionalFormatting: {
-        reflectionDescription:
-          "This section of the documentation provides a reference to the `IPricingModuleService` interface’s methods. This is the interface developers use to use the functionalities provided by the Pricing Module.",
         frontmatterData: {
           displayed_sidebar: "pricingReference",
-          badge: {
-            variant: "orange",
-            text: "Beta",
-          },
-          slug: "/references/pricing",
         },
       },
     },
@@ -43,11 +37,17 @@ module.exports = modulesConfig({
       },
     },
     {
-      pattern: "*",
-      useDefaults: true,
+      pattern: "IPricingModuleService.md",
       additionalFormatting: {
+        reflectionDescription:
+          "This section of the documentation provides a reference to the `IPricingModuleService` interface’s methods. This is the interface developers use to use the functionalities provided by the Pricing Module.",
         frontmatterData: {
           displayed_sidebar: "pricingReference",
+          badge: {
+            variant: "orange",
+            text: "Beta",
+          },
+          slug: "/references/pricing",
         },
       },
     },

docs-util/packages/typedoc-config/product.js

@@ -7,17 +7,11 @@ module.exports = modulesConfig({
   moduleName: "Product Module Reference",
   documentsToFormat: [
     {
-      pattern: "IProductModuleService.md",
+      pattern: "*",
+      useDefaults: true,
       additionalFormatting: {
-        reflectionDescription:
-          "This section of the documentation provides a reference to the `IProductModuleService` interface’s methods. This is the interface developers use to use the functionalities provided by the Product Module.",
         frontmatterData: {
           displayed_sidebar: "productReference",
-          badge: {
-            variant: "orange",
-            text: "Beta",
-          },
-          slug: "/references/product",
         },
       },
     },
@@ -43,11 +37,17 @@ module.exports = modulesConfig({
       },
     },
     {
-      pattern: "*",
-      useDefaults: true,
+      pattern: "IProductModuleService.md",
       additionalFormatting: {
+        reflectionDescription:
+          "This section of the documentation provides a reference to the `IProductModuleService` interface’s methods. This is the interface developers use to use the functionalities provided by the Product Module.",
         frontmatterData: {
           displayed_sidebar: "productReference",
+          badge: {
+            variant: "orange",
+            text: "Beta",
+          },
+          slug: "/references/product",
         },
       },
     },

docs-util/packages/typedoc-config/services.js

@@ -14,4 +14,30 @@ module.exports = {
   entryDocument: "index.md",
   hideInPageTOC: true,
   hideBreadcrumbs: true,
+  formatting: {
+    "*": {
+      showCommentsAsHeader: true,
+      sections: {
+        member_sources_definedIn: false,
+        reflection_hierarchy: false,
+        member_sources_inheritedFrom: false,
+        member_sources_implementationOf: false,
+        reflection_implementedBy: false,
+        member_signature_sources: false,
+        reflection_callable: false,
+        reflection_indexable: false,
+      },
+      parameterStyle: "component",
+      parameterComponent: "ParameterTypes",
+      mdxImports: [
+        `import ParameterTypes from "@site/src/components/ParameterTypes"`,
+      ],
+      frontmatterData: {
+        displayed_sidebar: "servicesSidebar",
+      },
+    },
+  },
+  objectLiteralTypeDeclarationStyle: "component",
+  mdxOutput: true,
+  maxLevel: 1,
 }

docs-util/packages/typedoc-plugin-markdown-medusa/src/index.ts

@@ -116,5 +116,19 @@ export function load(app: Application) {
     type: ParameterType.Number,
     defaultValue: 3,
   })
+
+  app.options.addDeclaration({
+    help: "[Markdown Plugin] Whether to output modules file for namespaces.",
+    name: "outputNamespace",
+    type: ParameterType.Boolean,
+    defaultValue: true,
+  })
+
+  app.options.addDeclaration({
+    help: "[Markdown Plugin] Whether to output module files.",
+    name: "outputModules",
+    type: ParameterType.Boolean,
+    defaultValue: true,
+  })
 }
 export { MarkdownTheme }

docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/declaration-title.ts

@@ -57,7 +57,9 @@ export default function (theme: MarkdownTheme) {
         this.defaultValue &&
         this.defaultValue !== "..."
       ) {
-        md.push(` = \`${stripLineBreaks(stripComments(this.defaultValue))}\``)
+        md.push(
+          ` = \`${stripLineBreaks(stripComments(`${this.defaultValue}`))}\``
+        )
       }
       return md.join("")
     }

docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/parameter-component.ts

@@ -8,11 +8,12 @@ export default function (theme: MarkdownTheme) {
   Handlebars.registerHelper(
     "parameterComponent",
     function (this: ReflectionParameterType[]) {
-      const { parameterComponent } = theme.getFormattingOptionsForLocation()
+      const { parameterComponent, maxLevel } =
+        theme.getFormattingOptionsForLocation()
       const parameters = this.reduce(
         (acc: ReflectionParameterType[], current) => parseParams(current, acc),
         []
-      ).map((parameter) => reflectionComponentFormatter(parameter, 1))
+      ).map((parameter) => reflectionComponentFormatter(parameter, 1, maxLevel))
 
       return `<${parameterComponent} parameters={${JSON.stringify(
         parameters,

docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/returns.ts

@@ -24,7 +24,7 @@ function getReturnFromType(
   theme: MarkdownTheme,
   reflection: SignatureReflection
 ) {
-  const { parameterStyle, parameterComponent } =
+  const { parameterStyle, parameterComponent, maxLevel } =
     theme.getFormattingOptionsForLocation()
 
   if (!reflection.type) {
@@ -35,7 +35,8 @@ function getReturnFromType(
     reflection.type,
     reflection.project || theme.project,
     reflection.comment,
-    1
+    1,
+    maxLevel
   )
 
   if (parameterStyle === "component") {
@@ -73,7 +74,7 @@ function formatReturnAsList(componentItems: Parameter[], level = 1): string {
 
 function getReturnFromComment(theme: MarkdownTheme, comment: Comment) {
   const md: string[] = []
-  const { parameterStyle, parameterComponent } =
+  const { parameterStyle, parameterComponent, maxLevel } =
     theme.getFormattingOptionsForLocation()
 
   if (comment.blockTags?.length) {
@@ -87,7 +88,7 @@ function getReturnFromComment(theme: MarkdownTheme, comment: Comment) {
             commentPart.target instanceof DeclarationReflection
           ) {
             const content = commentPart.target.children?.map((childItem) =>
-              reflectionFormatter(childItem, parameterStyle, 1)
+              reflectionFormatter(childItem, parameterStyle, 1, maxLevel)
             )
             result +=
               parameterStyle === "component"

docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/type-declaration-object-literal.ts

@@ -10,7 +10,8 @@ export default function (theme: MarkdownTheme) {
   Handlebars.registerHelper(
     "typeDeclarationMembers",
     function (this: DeclarationReflection[]) {
-      const { parameterComponent } = theme.getFormattingOptionsForLocation()
+      const { parameterComponent, maxLevel } =
+        theme.getFormattingOptionsForLocation()
       const comments = this.map(
         (param) => !!param.comment?.hasVisibleComponent()
       )
@@ -29,7 +30,11 @@ export default function (theme: MarkdownTheme) {
           break
         }
         case "component": {
-          result = getComponentMarkdownContent(properties, parameterComponent)
+          result = getComponentMarkdownContent(
+            properties,
+            parameterComponent,
+            maxLevel
+          )
           break
         }
         case "table": {
@@ -52,10 +57,11 @@ function getListMarkdownContent(properties: DeclarationReflection[]) {
 
 function getComponentMarkdownContent(
   properties: DeclarationReflection[],
-  parameterComponent?: string
+  parameterComponent?: string,
+  maxLevel?: number | undefined
 ) {
   const parameters = properties.map((property) =>
-    reflectionFormatter(property, "component")
+    reflectionFormatter(property, "component", 1, maxLevel)
   )
 
   return `<${parameterComponent} parameters={${JSON.stringify(

docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/type-parameter-component.ts

@@ -7,9 +7,10 @@ export default function (theme: MarkdownTheme) {
   Handlebars.registerHelper(
     "typeParameterComponent",
     function (this: TypeParameterReflection[]) {
-      const { parameterComponent } = theme.getFormattingOptionsForLocation()
+      const { parameterComponent, maxLevel } =
+        theme.getFormattingOptionsForLocation()
       const parameters = this.map((parameter) =>
-        reflectionComponentFormatter(parameter, 1)
+        reflectionComponentFormatter(parameter, 1, maxLevel)
       )
 
       return `<${parameterComponent} parameters={${JSON.stringify(

docs-util/packages/typedoc-plugin-markdown-medusa/src/theme.ts

@@ -48,6 +48,8 @@ export class MarkdownTheme extends Theme {
   objectLiteralTypeDeclarationStyle: ObjectLiteralDeclarationStyle
   formattingOptions: FormattingOptionsType
   mdxOutput: boolean
+  outputNamespace: boolean
+  outputModules: boolean
 
   project?: ProjectReflection
   reflection?: DeclarationReflection
@@ -87,6 +89,8 @@ export class MarkdownTheme extends Theme {
       "formatting"
     ) as FormattingOptionsType
     this.mdxOutput = this.getOption("mdxOutput") as boolean
+    this.outputNamespace = this.getOption("outputNamespace") as boolean
+    this.outputModules = this.getOption("outputModules") as boolean
     MarkdownTheme.MAX_LEVEL = this.getOption("maxLevel") as number
 
     this.listenTo(this.owner, {
@@ -306,14 +310,14 @@ export class MarkdownTheme extends Theme {
         directory: path.join(directoryPrefix || "", "interfaces"),
         template: this.getReflectionTemplate(),
       },
+      {
+        kind: [ReflectionKind.TypeAlias],
+        isLeaf: true,
+        directory: path.join(directoryPrefix || "", "types"),
+        template: this.getReflectionMemberTemplate(),
+      },
       ...(this.allReflectionsHaveOwnDocument
         ? [
-            {
-              kind: [ReflectionKind.TypeAlias],
-              isLeaf: true,
-              directory: path.join(directoryPrefix || "", "types"),
-              template: this.getReflectionMemberTemplate(),
-            },
             {
               kind: [ReflectionKind.Variable],
               isLeaf: true,
@@ -382,20 +386,14 @@ export class MarkdownTheme extends Theme {
       return {}
     }
 
-    const optionKey =
-      Object.keys(this.formattingOptions).find((key) => {
-        if (key === "*") {
-          return false
-        }
+    const applicableOptions: FormattingOptionType[] = []
 
-        const keyPattern = new RegExp(key)
-        if (keyPattern.test(this.location)) {
-          return true
-        }
-      }) || "*"
+    Object.keys(this.formattingOptions).forEach((key) => {
+      if (key === "*" || new RegExp(key).test(this.location)) {
+        applicableOptions.push(this.formattingOptions[key])
+      }
+    })
 
-    return optionKey in this.formattingOptions
-      ? this.formattingOptions[optionKey]
-      : {}
+    return Object.assign({}, ...applicableOptions)
   }
 }

docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-formatter.ts

@@ -20,13 +20,14 @@ const ALLOWED_KINDS: ReflectionKind[] = [
 export default function reflectionFormatter(
   reflection: ReflectionParameterType,
   type: ParameterStyle = "table",
-  level = 1
+  level = 1,
+  maxLevel?: number | undefined
 ): string | Parameter {
   switch (type) {
     case "list":
       return reflectionListFormatter(reflection, level)
     case "component":
-      return reflectionComponentFormatter(reflection, level)
+      return reflectionComponentFormatter(reflection, level, maxLevel)
     case "table":
       return reflectionTableFormatter(reflection)
     default:
@@ -36,7 +37,8 @@ export default function reflectionFormatter(
 
 export function reflectionListFormatter(
   reflection: ReflectionParameterType,
-  level = 1
+  level = 1,
+  maxLevel?: number | undefined
 ): string {
   const prefix = `${Array(level - 1)
     .fill("\t")
@@ -63,7 +65,7 @@ export function reflectionListFormatter(
 
   if (
     (reflection.type || hasChildren) &&
-    level + 1 <= MarkdownTheme.MAX_LEVEL
+    level + 1 <= (maxLevel || MarkdownTheme.MAX_LEVEL)
   ) {
     const children = hasChildren
       ? reflection.children
@@ -89,7 +91,8 @@ export function reflectionListFormatter(
 
 export function reflectionComponentFormatter(
   reflection: ReflectionParameterType,
-  level = 1
+  level = 1,
+  maxLevel?: number | undefined
 ): Parameter {
   const defaultValue = getDefaultValue(reflection) || ""
   const optional =
@@ -114,7 +117,7 @@ export function reflectionComponentFormatter(
 
   if (
     (reflection.type || hasChildren) &&
-    level + 1 <= MarkdownTheme.MAX_LEVEL
+    level + 1 <= (maxLevel || MarkdownTheme.MAX_LEVEL)
   ) {
     const children = hasChildren
       ? reflection.children
@@ -124,7 +127,7 @@ export function reflectionComponentFormatter(
       ?.filter((childItem) => childItem.kindOf(ALLOWED_KINDS))
       .forEach((childItem) => {
         componentItem.children?.push(
-          reflectionComponentFormatter(childItem, level + 1)
+          reflectionComponentFormatter(childItem, level + 1, maxLevel)
         )
       })
   }

docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/return-reflection-formatter.ts

@@ -18,7 +18,8 @@ export function returnReflectionComponentFormatter(
   reflectionType: SomeType,
   project: ProjectReflection,
   comment?: Comment,
-  level = 1
+  level = 1,
+  maxLevel?: number | undefined
 ): Parameter[] {
   const typeName = getType(reflectionType, "object", false)
   const type = getType(reflectionType, "object")
@@ -46,14 +47,15 @@ export function returnReflectionComponentFormatter(
       })
       if (
         !isOnlyVoid(reflectionType.typeArguments) &&
-        level + 1 <= MarkdownTheme.MAX_LEVEL
+        level + 1 <= (maxLevel || MarkdownTheme.MAX_LEVEL)
       ) {
         reflectionType.typeArguments.forEach((typeArg) => {
           const typeArgComponent = returnReflectionComponentFormatter(
             typeArg,
             project,
             undefined,
-            level + 1
+            level + 1,
+            maxLevel
           )
           if (typeArgComponent.length) {
             componentItem[parentKey - 1].children?.push(...typeArgComponent)
@@ -69,7 +71,8 @@ export function returnReflectionComponentFormatter(
             componentItem.push(
               reflectionComponentFormatter(
                 childItem as DeclarationReflection,
-                level
+                level,
+                maxLevel
               )
             )
           })
@@ -77,7 +80,8 @@ export function returnReflectionComponentFormatter(
           componentItem.push(
             reflectionComponentFormatter(
               reflection as DeclarationReflection,
-              level
+              level,
+              maxLevel
             )
           )
         }
@@ -103,12 +107,13 @@ export function returnReflectionComponentFormatter(
       featureFlag: Handlebars.helpers.featureFlag(comment),
       children: [],
     })
-    if (level + 1 <= MarkdownTheme.MAX_LEVEL) {
+    if (level + 1 <= (maxLevel || MarkdownTheme.MAX_LEVEL)) {
       const elementTypeItem = returnReflectionComponentFormatter(
         reflectionType.elementType,
         project,
         undefined,
-        level + 1
+        level + 1,
+        maxLevel
       )
       if (elementTypeItem.length) {
         componentItem[parentKey - 1].children?.push(...elementTypeItem)
@@ -140,13 +145,14 @@ export function returnReflectionComponentFormatter(
     } else {
       pushTo = componentItem
     }
-    if (level + 1 <= MarkdownTheme.MAX_LEVEL) {
+    if (level + 1 <= (maxLevel || MarkdownTheme.MAX_LEVEL)) {
       reflectionType.elements.forEach((element) => {
         const elementTypeItem = returnReflectionComponentFormatter(
           element,
           project,
           undefined,
-          level + 1
+          level + 1,
+          maxLevel
         )
         if (elementTypeItem.length) {
           pushTo.push(...elementTypeItem)

docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/type-utils.ts

@@ -128,7 +128,7 @@ export function getDeclarationType(model: DeclarationReflection): string {
           obj.type ? getType(obj.type) : escapeChars(obj.toString())
         } ${
           obj.defaultValue && obj.defaultValue !== "..."
-            ? `= ${escapeChars(obj.defaultValue)}`
+            ? `= ${escapeChars(`${obj.defaultValue}`)}`
             : ""
         }`
       })
@@ -136,7 +136,7 @@ export function getDeclarationType(model: DeclarationReflection): string {
       types ? types.join("; ") : ""
     } }${
       model.defaultValue && model.defaultValue !== "..."
-        ? `= ${escapeChars(model.defaultValue)}`
+        ? `= ${escapeChars(`${model.defaultValue}`)}`
         : ""
     }`
   }

www/apps/docs/content/cli/reference.mdx

@@ -2,7 +2,7 @@
 description: 'Learn how to install the Medusa CLI Tool. Medusa CLI Tool can be used to perform actions such as create a new Medusa backend, run migrations, create a new admin user, and more.'
 ---
 
-import TroubleshootingSection from "../troubleshooting/cli-installation-errors/_reusable-section.mdx"
+import DetailsListSection from "../troubleshooting/cli-installation-errors/_reusable-section.mdx"
 
 # CLI Reference
 

www/apps/docs/content/development/notification/create-notification-provider.md

@@ -102,7 +102,7 @@ You can learn more about plugins and how to create them in the [Plugins](../plug
 
 :::
 
-Continuing on with the previous example, if you want to use the [`OrderService`](../../references/services/classes/OrderService.md) later when sending notifications, you can inject it into the constructor:
+Continuing on with the previous example, if you want to use the [`OrderService`](../../references/services/classes/OrderService.mdx) later when sending notifications, you can inject it into the constructor:
 
 ```ts
 import { 
@@ -130,7 +130,7 @@ class EmailSenderService extends AbstractNotificationService {
 
 ### sendNotification
 
-When an event is triggered that your Notification Provider is registered as a handler for, the [`NotificationService`](../../references/services/classes/NotificationService.md) in Medusa’s core will execute the `sendNotification` method of your Notification Provider.
+When an event is triggered that your Notification Provider is registered as a handler for, the [`NotificationService`](../../references/services/classes/NotificationService.mdx) in Medusa’s core will execute the `sendNotification` method of your Notification Provider.
 
 In this method, you can perform the necessary operation to send the Notification. Following the example above, you can send an email to the customer when they place an order.
 
@@ -138,7 +138,7 @@ This method receives three parameters:
 
 1. `eventName`: This is the name of the event that was triggered. For example, `order.placed`.
 2. `eventData`: This is the data payload of the event that was triggered. For example, if the `order.placed` event is triggered, the `eventData` object contains the property `id` which is the ID of the order that was placed.
-3. `attachmentGenerator`: If you’ve previously attached a generator to the `NotificationService` using the [`registerAttachmentGenerator`](../../references/services/classes/NotificationService.md#registerattachmentgenerator) method, you have access to it here. You can use the `attachmentGenerator` to generate on-demand invoices or other documents. The default value of this parameter is null.
+3. `attachmentGenerator`: If you’ve previously attached a generator to the `NotificationService` using the [`registerAttachmentGenerator`](../../references/services/classes/NotificationService.mdx#registerattachmentgenerator) method, you have access to it here. You can use the `attachmentGenerator` to generate on-demand invoices or other documents. The default value of this parameter is null.
 
 :::info
 
@@ -200,13 +200,13 @@ The `to` and `data` properties are used in the `NotificationService` in Medusa
 
 ### resendNotification
 
-Using the [Resend Notification API Route](https://docs.medusajs.com/api/admin#notifications_postnotificationsnotificationresend), an admin user can resend a Notification to the customer. The [`NotificationService`](../../references/services/classes/NotificationService.md) in Medusa’s core then executes the `resendNotification` method in your Notification Provider.
+Using the [Resend Notification API Route](https://docs.medusajs.com/api/admin#notifications_postnotificationsnotificationresend), an admin user can resend a Notification to the customer. The [`NotificationService`](../../references/services/classes/NotificationService.mdx) in Medusa’s core then executes the `resendNotification` method in your Notification Provider.
 
 This method receives three parameters:
 
 1. `notification`: This is the original Notification record that was created after you sent the notification with `sendNotification`. You can get an overview of the entity and its attributes in the [architecture overview](./overview.mdx#notification-entity-overview), but most notably it includes the `to` and `data` attributes which are populated originally using the `to` and `data` properties of the object you return in `sendNotification`.
 2. `config`: In the Resend Notification API Route you may specify an alternative receiver of the notification using the `to` request body parameter. For example, you may want to resend the order confirmation email to a different email. If that’s the case, you have access to it in the `config` parameter object. Otherwise, `config` will be an empty object.
-3. `attachmentGenerator`: If you’ve previously attached a generator to the Notification Service using the [`registerAttachmentGenerator`](../../references/services/classes/NotificationService.md#registerattachmentgenerator) method, you have access to it here. You can use the `attachmentGenerator` to generate on-demand invoices or other documents. The default value of this parameter is null.
+3. `attachmentGenerator`: If you’ve previously attached a generator to the Notification Service using the [`registerAttachmentGenerator`](../../references/services/classes/NotificationService.mdx#registerattachmentgenerator) method, you have access to it here. You can use the `attachmentGenerator` to generate on-demand invoices or other documents. The default value of this parameter is null.
 
 Similarly to the `sendNotification` method, this method must return an object containing two properties:
 

www/apps/docs/content/development/notification/overview.mdx

@@ -25,7 +25,7 @@ An example of a notification provider is SendGrid. When an order is placed, the
 
 ### How Notification Provider is Created
 
-A Notification Provider is essentially a Medusa [Service](../services/create-service.mdx) with a unique identifier, and it extends the [`NotificationService`](../../references/services/classes/NotificationService.md) provided by the `medusa-interfaces` package. It can be created as part of a [Plugin](../plugins/overview.mdx), or it can be created just as a Service file in your Medusa backend.
+A Notification Provider is essentially a Medusa [Service](../services/create-service.mdx) with a unique identifier, and it extends the [`NotificationService`](../../references/services/classes/NotificationService.mdx) provided by the `medusa-interfaces` package. It can be created as part of a [Plugin](../plugins/overview.mdx), or it can be created just as a Service file in your Medusa backend.
 
 As a developer, you mainly work with the Notification Provider when integrating a third-party service that handles notifications in Medusa.
 

www/apps/docs/content/development/scheduled-jobs/create.md

@@ -82,7 +82,7 @@ You then resolve the `JobSchedulerService` and use the `jobSchedulerService.crea
 - The first parameter is a unique name to give to the scheduled job. In the example above, you use the name `publish-products`.
 - The second parameter is an object which can be used to [pass data to the job](#pass-data-to-the-scheduled-job).
 - The third parameter is the scheduled job expression pattern. In this example, it will execute the scheduled job once a day at 12 AM.
-- The fourth parameter is the function to execute. This is where you add the code to execute once the scheduled job runs. In this example, you retrieve the draft products using the [ProductService](../../references/services/classes/ProductService.md) and update the status of each of these products to `published`.
+- The fourth parameter is the function to execute. This is where you add the code to execute once the scheduled job runs. In this example, you retrieve the draft products using the [ProductService](../../references/services/classes/ProductService.mdx) and update the status of each of these products to `published`.
 
 :::tip
 

www/apps/docs/content/modules/carts-and-checkout/cart.md

@@ -32,7 +32,7 @@ There are other important attributes discussed in later sections. Check out the
 
 ## Cart Totals Calculation
 
-By default, the `Cart` entity doesn’t hold any details regarding the totals. These are computed and added to the cart instance using the `CartService`'s [decorateTotals method](../../references/services/classes/CartService.md#decoratetotals). There's also a dedicated method in the `CartService`, [retrieveWithTotals](../../references/services/classes/CartService.md#retrieveWithTotals), attaching the totals automatically. It is recommended to use this method by default when you need to retrieve the cart. 
+By default, the `Cart` entity doesn’t hold any details regarding the totals. These are computed and added to the cart instance using the `CartService`'s [decorateTotals method](../../references/services/classes/CartService.mdx#decoratetotals). There's also a dedicated method in the `CartService`, [retrieveWithTotals](../../references/services/classes/CartService.mdx#retrieveWithTotals), attaching the totals automatically. It is recommended to use this method by default when you need to retrieve the cart. 
 
 The cart’s totals are calculated based on the content and context of the cart. This includes the selected region, whether tax-inclusive pricing is enabled, the chosen shipping methods, and more.
 
@@ -83,11 +83,11 @@ You can learn how to override the cart completion strategy [here](./backend/cart
 
 The process is implemented as follows:
 
-1. When the idempotency key’s recovery point is set to `started`, the tax lines are created for the items in the cart. This is done using the `CartService`'s [createTaxLines method](../../references/services/classes/CartService.md#createtaxlines). If that is completed with no errors, the recovery point is set to `tax_lines_created` and the process continues.
-2. When the idempotency key’s recovery point is set to `tax_lines_created`, the payment is authorized using the `CartService`'s method [authorizePayment](../../references/services/classes/CartService.md#authorizepayment). If the payment requires more action or is pending authorization, then the tax lines that were created in the previous steps are deleted and the cart completion process is terminated. Once the payment is authorized, the process can be restarted.
-3. When the idempotency key’s recovery point is set to `payment_authorized`, tax lines are created again the same way as the first step. Then, the inventory of each of the items in the cart is confirmed using the `ProductVariantInventoryService`'s method [confirmInventory](../../references/services/classes/ProductVariantInventoryService.md#confirminventory). If an item is in stock, the quantity is reserved using the `ProductVariantInventoryService`'s method [reserveQuantity](../../references/services/classes/ProductVariantInventoryService.md#reservequantity). If an item is out of stock, any item reservations that were created are deleted, the payment is canceled, and an error is thrown, terminating the cart completion process. If all item quantities are confirmed to be available:
-    1. If the cart belongs to a swap (the `type` attribute is set to `swap`), the swap is registered as completed using the `SwapService`'s [registerCartCompletion method](../../references/services/classes/SwapService.md#registercartcompletion) and the inventory item reservations are removed using the Inventory module. The process ends successfully here for a swap.
-    2. If the cart belongs to an order, the order is created using the `OrderService`'s method [createFromCart](../../references/services/classes/OrderService.md#createfromcart). The order is then retrieved and sent in the response.
+1. When the idempotency key’s recovery point is set to `started`, the tax lines are created for the items in the cart. This is done using the `CartService`'s [createTaxLines method](../../references/services/classes/CartService.mdx#createtaxlines). If that is completed with no errors, the recovery point is set to `tax_lines_created` and the process continues.
+2. When the idempotency key’s recovery point is set to `tax_lines_created`, the payment is authorized using the `CartService`'s method [authorizePayment](../../references/services/classes/CartService.mdx#authorizepayment). If the payment requires more action or is pending authorization, then the tax lines that were created in the previous steps are deleted and the cart completion process is terminated. Once the payment is authorized, the process can be restarted.
+3. When the idempotency key’s recovery point is set to `payment_authorized`, tax lines are created again the same way as the first step. Then, the inventory of each of the items in the cart is confirmed using the `ProductVariantInventoryService`'s method [confirmInventory](../../references/services/classes/ProductVariantInventoryService.mdx#confirminventory). If an item is in stock, the quantity is reserved using the `ProductVariantInventoryService`'s method [reserveQuantity](../../references/services/classes/ProductVariantInventoryService.mdx#reservequantity). If an item is out of stock, any item reservations that were created are deleted, the payment is canceled, and an error is thrown, terminating the cart completion process. If all item quantities are confirmed to be available:
+    1. If the cart belongs to a swap (the `type` attribute is set to `swap`), the swap is registered as completed using the `SwapService`'s [registerCartCompletion method](../../references/services/classes/SwapService.mdx#registercartcompletion) and the inventory item reservations are removed using the Inventory module. The process ends successfully here for a swap.
+    2. If the cart belongs to an order, the order is created using the `OrderService`'s method [createFromCart](../../references/services/classes/OrderService.mdx#createfromcart). The order is then retrieved and sent in the response.
 4. Once the process detailed above is done, the idempotency key’s recovery point is set to `finished`.
 
 ---

www/apps/docs/content/modules/gift-cards/backend/send-gift-card-to-customer.md

@@ -148,4 +148,4 @@ export default GiftCardSubscriber
 
 When using this method, you’ll have to handle the logic of sending the code to the customer inside the handler function, which in this case is `handleGiftCard`.
 
-The `handleGiftCard` event receives a `data` object as a parameter. This object holds the `id` property which is the ID of the gift card. You can retrieve the full gift card object using the [GiftCardService](../../../references/services/classes/GiftCardService.md)
+The `handleGiftCard` event receives a `data` object as a parameter. This object holds the `id` property which is the ID of the gift card. You can retrieve the full gift card object using the [GiftCardService](../../../references/services/classes/GiftCardService.mdx)

www/apps/docs/content/modules/orders/claims.md

@@ -32,7 +32,7 @@ There are other important attributes discussed in later sections. Check out the
 
 Claims are created in Medusa by an admin (typically a merchant). They are created on an order, and depending on the claim’s type the admin can specify details like the amount to be refunded, or the items to be returned and the new items to replace them.
 
-You can create a claim either using the [Create Claim API Route](https://docs.medusajs.com/api/admin#orders_postordersorderclaims) or using the `ClaimService`'s [create method](../../references/services/classes/ClaimService.md#create). This section explains the process within the Create Claim API Route, with a focus on the `create` method.
+You can create a claim either using the [Create Claim API Route](https://docs.medusajs.com/api/admin#orders_postordersorderclaims) or using the `ClaimService`'s [create method](../../references/services/classes/ClaimService.mdx#create). This section explains the process within the Create Claim API Route, with a focus on the `create` method.
 
 ### Idempotency Key
 
@@ -46,16 +46,16 @@ The following flow is implemented within the Create Claim API Route:
 
 ![Create Claim API Route Overview](https://res.cloudinary.com/dza7lstvk/image/upload/v1682519207/Medusa%20Docs/Diagrams/create-claim-overview_iqek1f.jpg)
 
-1. When the idempotency key’s recovery point is `started`, the creation of the claim is started using the `ClaimService`'s [create method](../../references/services/classes/ClaimService.md#create). If the claim is created successfully, the idempotency key’s recovery point is changed to `claim_created`. In the `create` method:
-    1. If the type of the claim is `refund` and no refund amount is set, the refund amount is calculated based on the items in the claim using the `ClaimService`'s [getRefundTotalForClaimLinesOnOrder method](../../references/services/classes/ClaimService.md#getrefundtotalforclaimlinesonorder).
-    2. If new items are specified to send to the customer, new line items, which are represented by the `LineItem` entity, are generated using the `LineItemService`'s [generate method](../../references/services/classes/LineItemService.md#generate). These line items are later attached to the claim when it’s created under the `additional_items` relation. Also, the quantity of these items are reserved from the product variant’s inventory using the `ProductVariantInventoryService`'s [reserveQuantity method](../../references/services/classes/ProductVariantInventoryService.md#reservequantity).
+1. When the idempotency key’s recovery point is `started`, the creation of the claim is started using the `ClaimService`'s [create method](../../references/services/classes/ClaimService.mdx#create). If the claim is created successfully, the idempotency key’s recovery point is changed to `claim_created`. In the `create` method:
+    1. If the type of the claim is `refund` and no refund amount is set, the refund amount is calculated based on the items in the claim using the `ClaimService`'s [getRefundTotalForClaimLinesOnOrder method](../../references/services/classes/ClaimService.mdx#getrefundtotalforclaimlinesonorder).
+    2. If new items are specified to send to the customer, new line items, which are represented by the `LineItem` entity, are generated using the `LineItemService`'s [generate method](../../references/services/classes/LineItemService.mdx#generate). These line items are later attached to the claim when it’s created under the `additional_items` relation. Also, the quantity of these items are reserved from the product variant’s inventory using the `ProductVariantInventoryService`'s [reserveQuantity method](../../references/services/classes/ProductVariantInventoryService.mdx#reservequantity).
     3. The claim is created and saved.
-    4. If there were additional items attached to the claim, tax lines are created for these items using the `TaxProviderService`'s [createTaxLines method](../../references/services/classes/TaxProviderService.md#createtaxlines).
-    5. If a shipping method was chosen to send the additional items to the customer, the shipping method is created using the `ShippingOptionService`'s [createShippingMethod method](../../references/services/classes/ShippingOptionService.md#createshippingmethod) or updated if it already exists using the `ShippingOptionService`'s [updateShippingMethod method](../../references/services/classes/ShippingOptionService.md#updateshippingmethod).
-    6. A claim item is created for each of the items specified in the claim. These are the items that were originally in the order and that the claim was created for. The claim items are created using the `ClaimItemService`'s [create method](../../references/services/classes/ClaimItemService.md#create).
-    7. If a return shipping method is specified, a return is created using the `ReturnService`'s [create method](../../references/services/classes/ReturnService.md#create).
-2. When the idempotency key’s recovery point is `claim_created`, if the claim’s type is `refund`, the refund is processed using the `ClaimService`'s [processRefund method](../../references/services/classes/ClaimService.md#processrefund). If the method is refunded successfully, the `payment_status` attribute of the claim is set to `refunded`. The refund is created directly on the order the claim belongs to. The recovery point of the idempotency key is changed to `refund_handled` at the end of this process.
-3. When the idempotency key’s recovery point is `refund_handled`, if the claim is associated with a return, the return is automatically fulfilled using the `ReturnService`'s [fulfill method](../../references/services/classes/ReturnService.md#fulfill) as it will be handled by the customer. The order associated with the claim is then returned and the idempotency key is set to `finished`.
+    4. If there were additional items attached to the claim, tax lines are created for these items using the `TaxProviderService`'s [createTaxLines method](../../references/services/classes/TaxProviderService.mdx#createtaxlines).
+    5. If a shipping method was chosen to send the additional items to the customer, the shipping method is created using the `ShippingOptionService`'s [createShippingMethod method](../../references/services/classes/ShippingOptionService.mdx#createshippingmethod) or updated if it already exists using the `ShippingOptionService`'s [updateShippingMethod method](../../references/services/classes/ShippingOptionService.mdx#updateshippingmethod).
+    6. A claim item is created for each of the items specified in the claim. These are the items that were originally in the order and that the claim was created for. The claim items are created using the `ClaimItemService`'s [create method](../../references/services/classes/ClaimItemService.mdx#create).
+    7. If a return shipping method is specified, a return is created using the `ReturnService`'s [create method](../../references/services/classes/ReturnService.mdx#create).
+2. When the idempotency key’s recovery point is `claim_created`, if the claim’s type is `refund`, the refund is processed using the `ClaimService`'s [processRefund method](../../references/services/classes/ClaimService.mdx#processrefund). If the method is refunded successfully, the `payment_status` attribute of the claim is set to `refunded`. The refund is created directly on the order the claim belongs to. The recovery point of the idempotency key is changed to `refund_handled` at the end of this process.
+3. When the idempotency key’s recovery point is `refund_handled`, if the claim is associated with a return, the return is automatically fulfilled using the `ReturnService`'s [fulfill method](../../references/services/classes/ReturnService.mdx#fulfill) as it will be handled by the customer. The order associated with the claim is then returned and the idempotency key is set to `finished`.
 
 ---
 
@@ -63,7 +63,7 @@ The following flow is implemented within the Create Claim API Route:
 
 If a claim’s type is `replace`, an admin can create a [fulfillment](./fulfillments.md) for the additional items that should be sent to the customer.
 
-A fulfillment can be created either using the [Create Claim Fulfillment API Route](https://docs.medusajs.com/api/admin#orders_postordersorderclaimsclaimfulfillments) or the `ClaimService`'s [createFulfillment method](../../references/services/classes/ClaimService.md#createfulfillment).
+A fulfillment can be created either using the [Create Claim Fulfillment API Route](https://docs.medusajs.com/api/admin#orders_postordersorderclaimsclaimfulfillments) or the `ClaimService`'s [createFulfillment method](../../references/services/classes/ClaimService.mdx#createfulfillment).
 
 :::note
 
@@ -73,9 +73,9 @@ The API Route handles updating the inventory and reservations. So, if you choose
 
 By default, when a fulfillment is created, the claim’s `fulfillment_status` is set to `fulfilled`. However, if any of the item’s quantity isn’t fulfilled successfully, the `fulfillment_status` is set to `requires_action`.
 
-After creating a fulfillment, you can create a shipment for the fulfillment either using the [Create Claim Shipment API Route](https://docs.medusajs.com/api/admin#orders_postordersorderclaimsclaimshipments) or the `ClaimService`'s [createShipment method](../../references/services/classes/ClaimService.md#createshipment). If only some of the items and their quantities are shipped, the `fulfillment_status` of the claim is set to `partially_shipped`. Otherwise, if all items and quantities are shipped, the `fulfillment_status` of the claim is set to `shipped`.
+After creating a fulfillment, you can create a shipment for the fulfillment either using the [Create Claim Shipment API Route](https://docs.medusajs.com/api/admin#orders_postordersorderclaimsclaimshipments) or the `ClaimService`'s [createShipment method](../../references/services/classes/ClaimService.mdx#createshipment). If only some of the items and their quantities are shipped, the `fulfillment_status` of the claim is set to `partially_shipped`. Otherwise, if all items and quantities are shipped, the `fulfillment_status` of the claim is set to `shipped`.
 
-You can alternatively cancel a fulfillment either using the [Cancel Claim Fulfillment API Route](https://docs.medusajs.com/api/admin#tag/Orders/operation/PostOrdersClaimFulfillmentsCancel) or the `ClaimService`'s [cancelFulfillment method](../../references/services/classes/ClaimService.md#cancelfulfillment). This would change the `fulfillment_status` of the claim to `canceled`.
+You can alternatively cancel a fulfillment either using the [Cancel Claim Fulfillment API Route](https://docs.medusajs.com/api/admin#tag/Orders/operation/PostOrdersClaimFulfillmentsCancel) or the `ClaimService`'s [cancelFulfillment method](../../references/services/classes/ClaimService.mdx#cancelfulfillment). This would change the `fulfillment_status` of the claim to `canceled`.
 
 ---
 
@@ -87,7 +87,7 @@ A claim's return can be marked as received, which would adjust the inventory and
 
 ## Cancel a Claim
 
-An admin can cancel a claim if it hasn’t been refunded either using the [Cancel Claim API Route](https://docs.medusajs.com/api/admin#orders_postordersclaimcancel) or the `ClaimService`'s [cancel method](../../references/services/classes/ClaimService.md#cancel).
+An admin can cancel a claim if it hasn’t been refunded either using the [Cancel Claim API Route](https://docs.medusajs.com/api/admin#orders_postordersclaimcancel) or the `ClaimService`'s [cancel method](../../references/services/classes/ClaimService.mdx#cancel).
 
 If any fulfillments were created, they must be canceled first. Similarly, if the claim is associated with a return, the return must be canceled first.
 

www/apps/docs/content/modules/orders/draft-orders.md

@@ -34,11 +34,11 @@ There are other important attributes discussed in later sections. Check out the
 
 You have full freedom in how you choose to implement creating draft orders. This section explains how it’s created in the Medusa backend using the [Create Draft Order](https://docs.medusajs.com/api/admin#draft-orders_postdraftorders) and [Register Payment](https://docs.medusajs.com/api/admin#draft-orders_postdraftordersdraftorderregisterpayment) API Routes.
 
-A draft order is created using the `DraftOrderService`'s [create method](../../references/services/classes/DraftOrderService.md#create). Within that method, a cart is created along with it. The cart is used to store the order’s details, such as the draft order’s items, shipping options, and more. The cart has the type `draft_order`.
+A draft order is created using the `DraftOrderService`'s [create method](../../references/services/classes/DraftOrderService.mdx#create). Within that method, a cart is created along with it. The cart is used to store the order’s details, such as the draft order’s items, shipping options, and more. The cart has the type `draft_order`.
 
 Since the draft order is associated with a cart, the process implemented in the Medusa backend around completing the draft order is pretty similar to that of completing a cart.
 
-The payment must be authorized before the cart can be completed, which can be done using the `CartService`'s [authorizePayment method](../../references/services/classes/CartService.md#authorizepayment). Once the payment is authorized, the order can be created using the `OrderService`'s [createFromCart method](../../references/services/classes/OrderService.md#createfromcart).
+The payment must be authorized before the cart can be completed, which can be done using the `CartService`'s [authorizePayment method](../../references/services/classes/CartService.mdx#authorizepayment). Once the payment is authorized, the order can be created using the `OrderService`'s [createFromCart method](../../references/services/classes/OrderService.mdx#createfromcart).
 
 :::note
 
@@ -46,7 +46,7 @@ In the Register Payment API Route, the `system` payment method is used by defaul
 
 :::
 
-The draft order can then be completed using the `DraftOrderService`'s [registerCartCompletion method](../../references/services/classes/DraftOrderService.md#registercartcompletion). This would update its status to `completed` and would set the `order_id` attribute of the draft order. Finally, you can capture the payment of the order that was created using the `OrderService`'s [capturePayment method](../../references/services/classes/OrderService.md#capturepayment).
+The draft order can then be completed using the `DraftOrderService`'s [registerCartCompletion method](../../references/services/classes/DraftOrderService.mdx#registercartcompletion). This would update its status to `completed` and would set the `order_id` attribute of the draft order. Finally, you can capture the payment of the order that was created using the `OrderService`'s [capturePayment method](../../references/services/classes/OrderService.mdx#capturepayment).
 
 Once the order is created and the draft order is completed, the created order can be processed and handled the same as orders created by customers.
 

www/apps/docs/content/modules/orders/orders.md

@@ -52,15 +52,15 @@ You have full freedom in how you create your orders. Within the Medusa backend,
 
 ## Payments in Orders
 
-In the cart completion process, or when you use the `OrderService`'s method [createFromCart](../../references/services/classes/OrderService.md#createfromcart), the cart’s payment is also associated with the order by setting the `order_id` of the payment to the newly created order’s ID.
+In the cart completion process, or when you use the `OrderService`'s method [createFromCart](../../references/services/classes/OrderService.mdx#createfromcart), the cart’s payment is also associated with the order by setting the `order_id` of the payment to the newly created order’s ID.
 
 An order can have more than one payment. You can access the order’s payments by expanding the `payments` relation and accessing `order.payments`.
 
 By default, the payment will be authorized but not captured. Some payment processor plugins, such as the Stripe plugin, allow changing this behavior to automatically capture the payment. You can also do that within your custom payment processor.
 
-In the default scenario, the merchant would have to capture that payment manually, which would change the `payment_status` of the order. The payment can be captured using the `PaymentService`'s [capture method](../../references/services/classes/PaymentService.md#capture).
+In the default scenario, the merchant would have to capture that payment manually, which would change the `payment_status` of the order. The payment can be captured using the `PaymentService`'s [capture method](../../references/services/classes/PaymentService.mdx#capture).
 
-After a payment has been captured, it can be refunded either fully or a specific amount of it. This is useful if items of an order has been returned or swapped, or if an order has been edited. The payment can be refunded using the `PaymentService`'s [refund method](../../references/services/classes/PaymentService.md#refund).
+After a payment has been captured, it can be refunded either fully or a specific amount of it. This is useful if items of an order has been returned or swapped, or if an order has been edited. The payment can be refunded using the `PaymentService`'s [refund method](../../references/services/classes/PaymentService.mdx#refund).
 
 The Medusa backend also provides payment admin APIs that you can use to retrieve, capture, and refund the payment.
 
@@ -80,13 +80,13 @@ A fulfillment can instead be canceled, changing the `fulfillment_status` to `can
 
 If one or some items in an order are returned, the `fulfillment_status` is set to `partially_returned`. If all items were returned, the `fulfillment_status` is set to `returned`.
 
-The Medusa backend provides these functionalities through the admin APIs. You can also use the `OrderService`'s methods to perform these functionalities in a custom flow, such as the [createFulfillment](../../references/services/classes/OrderService.md#createfulfillment) or [createShipment](../../references/services/classes/OrderService.md#createshipment) methods.
+The Medusa backend provides these functionalities through the admin APIs. You can also use the `OrderService`'s methods to perform these functionalities in a custom flow, such as the [createFulfillment](../../references/services/classes/OrderService.mdx#createfulfillment) or [createShipment](../../references/services/classes/OrderService.mdx#createshipment) methods.
 
 ---
 
 ## Order Totals Calculations
 
-By default, the `Order` entity doesn’t hold any details regarding the totals. These are computed and added to the order instance using the `OrderService`'s [decorateTotals method](../../references/services/classes/OrderService.md#decoratetotals). There's also a dedicated method in the `OrderService`, [retrieveWithTotals](../../references/services/classes/OrderService.md#retrievewithtotals), attaching the totals to the order instance automatically. It is recommended to use this method by default when you need to retrieve the order.
+By default, the `Order` entity doesn’t hold any details regarding the totals. These are computed and added to the order instance using the `OrderService`'s [decorateTotals method](../../references/services/classes/OrderService.mdx#decoratetotals). There's also a dedicated method in the `OrderService`, [retrieveWithTotals](../../references/services/classes/OrderService.mdx#retrievewithtotals), attaching the totals to the order instance automatically. It is recommended to use this method by default when you need to retrieve the order.
 
 The order’s totals are calculated based on the content and context of the order. This includes the order’s region, whether tax-inclusive pricing is enabled, the chosen shipping methods, and more.
 
@@ -133,7 +133,7 @@ A merchant may also choose to force the edit on the order, by-passing the custom
 
 Although this process is implemented in this flow within the Medusa backend, there is no requirement for you to actually follow it. For example, you can allow the customer or a third-party service to create and manage the order edit.
 
-The Medusa backend provides the [order edit admin APIs](https://docs.medusajs.com/api/admin#order-edits), but you can also use the [OrderEditService](../../references/services/classes/OrderEditService.md) to perform the same functionalities in a custom flow.
+The Medusa backend provides the [order edit admin APIs](https://docs.medusajs.com/api/admin#order-edits), but you can also use the [OrderEditService](../../references/services/classes/OrderEditService.mdx) to perform the same functionalities in a custom flow.
 
 Order edits are represented by the `OrderEdit` entity. This entity is linked to the order through the `order_id` attribute. You can access an order’s edits by expanding the `edits` relation and accessing `order.edits`. Notice that an order can have multiple edits during its lifecycle, but it can’t have more than one ongoing edit.
 

www/apps/docs/content/modules/orders/returns.md

@@ -54,8 +54,8 @@ The following process occurs within the Create Return storefront API Route:
 
 ![Return Client Process Flowchart](https://res.cloudinary.com/dza7lstvk/image/upload/v1681994516/Medusa%20Docs/Diagrams/return-client-process_evbjf5.jpg)
 
-1. The customer creates a return, specifying the items they want to return and optionally the shipping option they want to use to return the items. This is done using the `ReturnService`'s [create method](../../references/services/classes/ReturnService.md#create).
-2. If they specify the return shipping option they want to use, a shipping method is created from the chosen shipping option and the return is automatically fulfilled in the backend using the `ReturnService`'s [fulfill method](../../references/services/classes/ReturnService.md#fulfill).
+1. The customer creates a return, specifying the items they want to return and optionally the shipping option they want to use to return the items. This is done using the `ReturnService`'s [create method](../../references/services/classes/ReturnService.mdx#create).
+2. If they specify the return shipping option they want to use, a shipping method is created from the chosen shipping option and the return is automatically fulfilled in the backend using the `ReturnService`'s [fulfill method](../../references/services/classes/ReturnService.mdx#fulfill).
 
 After this process, the return will be available for the merchant or the admin to view and handle it. The merchant can either mark the return as received or cancel the return.
 
@@ -71,15 +71,15 @@ The following process occurs within the [Receive Return admin API Route](https:/
     1. The return’s status is checked to ensure it’s not canceled or received. If so, the process is terminated with an error.
     2. The received items are validated to ensure they match the items that were previously requested to be returned. If there’s a mismatch, the return’s status is set to `requires_more`. This is useful in situations where a custom refund amount is requested, but the returned items don’t match the requested items.
     3. If there’s no mismatch issue, the return’s status is set to `received`.
-    4. The inventory of the returned items is adjusted using the `ProductVariantInventoryService`'s [method adjustInventory](../../references/services/classes/ProductVariantInventoryService.md#adjustinventory)
-2. After the return is marked as received, if the return is associated with a swap, the `SwapService`'s [registerReceived method](../../references/services/classes/SwapService.md#registerreceived) is used to validate the return, emit the swap event `received`, and return the swap.
-3. On the other hand, after the return is marked as received, if the return is associated with an order, the `OrderService`'s [registerReturnReceived method](../../references/services/classes/OrderService.md#registerreturnreceived). In this method:
+    4. The inventory of the returned items is adjusted using the `ProductVariantInventoryService`'s [method adjustInventory](../../references/services/classes/ProductVariantInventoryService.mdx#adjustinventory)
+2. After the return is marked as received, if the return is associated with a swap, the `SwapService`'s [registerReceived method](../../references/services/classes/SwapService.mdx#registerreceived) is used to validate the return, emit the swap event `received`, and return the swap.
+3. On the other hand, after the return is marked as received, if the return is associated with an order, the `OrderService`'s [registerReturnReceived method](../../references/services/classes/OrderService.mdx#registerreturnreceived). In this method:
     1. If the amount that is expected to be refunded is greater than the amount that can be refunded, the `fulfillment_status` of the order is set to `requires_action`. And the process is terminated.
     2. If there are no validation issues, the payment is refunded and the fulfillment status is set to `returned` if all items of the order were returned, or `partially_returned` if only some items were returned.
 
 ### Cancel a Return
 
-The merchant can cancel a return if it hasn’t be marked as `received` before. This can be done either using the `ReturnService`'s [cancel method](../../references/services/classes/ReturnService.md#cancel) or using the [Cancel Return API Route](https://docs.medusajs.com/api/admin#returns_postreturnsreturncancel).
+The merchant can cancel a return if it hasn’t be marked as `received` before. This can be done either using the `ReturnService`'s [cancel method](../../references/services/classes/ReturnService.mdx#cancel) or using the [Cancel Return API Route](https://docs.medusajs.com/api/admin#returns_postreturnsreturncancel).
 
 Canceling a return would change its status to canceled.
 

www/apps/docs/content/modules/orders/swaps.md

@@ -51,12 +51,12 @@ The customer starts by creating their swap, which can be done through the Create
 
 ![Swap Creation Flowchart](https://res.cloudinary.com/dza7lstvk/image/upload/v1681983755/Medusa%20Docs/Diagrams/swap-process_kylqq0.jpg)
 
-1. The swap’s creation is initiated with the `SwapService`'s [create method](../../references/services/classes/SwapService.md#create):
+1. The swap’s creation is initiated with the `SwapService`'s [create method](../../references/services/classes/SwapService.mdx#create):
     1. The order is first validated to see if a swap can be created. This includes checking the `payment_status` of the order to ensure the payment has already been captured, and the `fulfillment_status` of the order to ensure the status isn’t `not_fulfilled`. If any of these conditions aren’t met, the process is terminated with an error.
     2. The items that the customer chose to return are then validated. If any item has been previously canceled, meaning that its order, swap, or claim have been previously canceled, the process is terminated with an error.
     3. If all the conditions above are met, the swap is then created and associated with the order using the `order_id` attribute.
     4. A return is created and linked to the swap. The return’s items are set to the items that the customer chose to return.
-2. After the swap has been created, a cart is then created for the swap using the `SwapService`'s [createCart method](../../references/services/classes/SwapService.md#createcart). The cart is used to finalize the process of the swap creation process, but more on that later. The swap is associated with the cart using the `cart_id` attribute.
+2. After the swap has been created, a cart is then created for the swap using the `SwapService`'s [createCart method](../../references/services/classes/SwapService.mdx#createcart). The cart is used to finalize the process of the swap creation process, but more on that later. The swap is associated with the cart using the `cart_id` attribute.
 3. The return associated with the swap is marked as fulfilled, as this is taken care of by the customer.
 
 After the swap has been created, the customer should undergo a swap-completion process similar to the checkout process where they provide shipping and billing addresses, choose shipping and payment methods, authorize any additional payment required, then finally completing the cart.
@@ -69,7 +69,7 @@ This is all made possible since the swap is linked to a cart, so the same checko
 
 After the swap has been created and completed by the customer, the merchant can then process the payment of the swap. This includes either refunding or capturing an additional payment, which is decided by the value of the `difference_due` attribute as explained in the [Swap Entity section](#swap-entity-overview).
 
-The processing of the swap’s payment can be done either using the `SwapService`'s [processDifference method](../../references/services/classes/SwapService.md#processdifference), or using the [Process Swap Payment API Route](https://docs.medusajs.com/api/admin#orders_postordersorderswapsswapprocesspayment).
+The processing of the swap’s payment can be done either using the `SwapService`'s [processDifference method](../../references/services/classes/SwapService.mdx#processdifference), or using the [Process Swap Payment API Route](https://docs.medusajs.com/api/admin#orders_postordersorderswapsswapprocesspayment).
 
 If the swap requires any additional payment, the customer is expected to have authorized the payment during the [swap and cart completion flow explained earlier](#how-are-swaps-created). The merchant can then capture the payment and the `payment_status` of the swap is set to `captured`.
 
@@ -89,9 +89,9 @@ Although you have freedom in how you implement the process, the recommended proc
 
 ![Swap Fulfillment Flowchart](https://res.cloudinary.com/dza7lstvk/image/upload/v1681984933/Medusa%20Docs/Diagrams/swap-fulfillment-process_xfurko.jpg)
 
-1. The fulfillment is created either using the `SwapService`'s [createFulfillment method](../../references/services/classes/SwapService.md#createfulfillment) or using the [Create a Swap Fulfillment API Route](https://docs.medusajs.com/api/admin#orders_postordersorderswapsswapfulfillments). This would set the `fulfillment_status` of the swap either to `fulfilled` if all items have been fulfilled, or `partially_fulfilled` if only some items were fulfilled.
-2. The shipment can then be created using the `SwapService`'s [createShipment method](../../references/services/classes/SwapService.md#createshipment) or using the [Create Swap Shipment API Route](https://docs.medusajs.com/api/admin#orders_postordersorderswapsswapshipments). This would set the `fulfillment_status` of the swap either to `shipped` if all items have been shipped, or `partially_shipped` if only some items were shipped.
-3. Alternatively, a fulfillment can be canceled after it has been created using the `SwapService`'s [cancelFulfillment method](../../references/services/classes/SwapService.md#cancelfulfillment) or using the [Cancel Swap’s Fulfillment API Route](https://docs.medusajs.com/api/admin#orders_postordersswapfulfillmentscancel). This would set the `fulfillment_status` of the swap to `canceled`.
+1. The fulfillment is created either using the `SwapService`'s [createFulfillment method](../../references/services/classes/SwapService.mdx#createfulfillment) or using the [Create a Swap Fulfillment API Route](https://docs.medusajs.com/api/admin#orders_postordersorderswapsswapfulfillments). This would set the `fulfillment_status` of the swap either to `fulfilled` if all items have been fulfilled, or `partially_fulfilled` if only some items were fulfilled.
+2. The shipment can then be created using the `SwapService`'s [createShipment method](../../references/services/classes/SwapService.mdx#createshipment) or using the [Create Swap Shipment API Route](https://docs.medusajs.com/api/admin#orders_postordersorderswapsswapshipments). This would set the `fulfillment_status` of the swap either to `shipped` if all items have been shipped, or `partially_shipped` if only some items were shipped.
+3. Alternatively, a fulfillment can be canceled after it has been created using the `SwapService`'s [cancelFulfillment method](../../references/services/classes/SwapService.mdx#cancelfulfillment) or using the [Cancel Swap’s Fulfillment API Route](https://docs.medusajs.com/api/admin#orders_postordersswapfulfillmentscancel). This would set the `fulfillment_status` of the swap to `canceled`.
 
 A swap’s fulfillments can be accessed by expanding the `fulfillments` relation and accessing `swap.fulfillments`. A fulfillment is represented by the `Fulfillment` entity.
 
@@ -105,7 +105,7 @@ A swap's return can be marked as received, which would adjust the inventory and
 
 ## Canceling a Swap
 
-A swap can be canceled by the merchant if necessary. It can be done either through the `SwapService`'s [cancel method](../../references/services/classes/SwapService.md#cancel) or the [Cancel Swap API Route](https://docs.medusajs.com/api/admin#orders_postordersswapcancel).
+A swap can be canceled by the merchant if necessary. It can be done either through the `SwapService`'s [cancel method](../../references/services/classes/SwapService.mdx#cancel) or the [Cancel Swap API Route](https://docs.medusajs.com/api/admin#orders_postordersswapcancel).
 
 A swap can’t be canceled if:
 

www/apps/docs/content/modules/users/users.md

@@ -63,7 +63,7 @@ The invitation process typically follows these steps in the Medusa backend:
 
 1. A user creates an invite either using the [Create Invite API Route](https://docs.medusajs.com/api/admin#invites_postinvites) or the `InviteService`'s `create` method. Part of creating an invite includes generating the token and setting the expiry date. By default, the expiry date is set to a week after the date of invitation creation.
 2. The new user receives the invite, typically through their email (although this is not implemented by default within the Medusa backend). The new user has to provide their details and password. The invite can be accepted either using the [Accept Invite API Route](https://docs.medusajs.com/api/admin#invites_postinvitesinviteaccept) or using the `InviteService`'s `accept` method.
-3. When the new user accepts the invite, the invitation is validated first to ensure it’s not expired. If it’s not expired, a new user is created using the `UserService`'s [create method](../../references/services/classes/UserService.md#create).
+3. When the new user accepts the invite, the invitation is validated first to ensure it’s not expired. If it’s not expired, a new user is created using the `UserService`'s [create method](../../references/services/classes/UserService.mdx#create).
 
 If an invitation is expired, an existing user can resend the invite either using the Resend Invite API Route or using the `InviteService`'s resend method. This would generate a new token and reset the expiry date.
 

www/apps/docs/content/plugins/other/restock-notifications.md

@@ -172,6 +172,6 @@ export default RestockNotificationSubscriber
 Handler methods subscribed to the `restock-notification.restocked` event, which in this case is the `handleRestockNotification` method, receive the following object data payload as a parameter:
 
 - `variant_id`: The ID of the variant that has been restocked.
-- `emails`: An array of strings indicating the email addresses subscribed to the restocked variant. Here, you pass it along to the SendGrid plugin directly to send the email to everyone subscribed. If necessary, you can also retrieve the customer of that email using the `CustomerService`'s [retrieveByEmail](../../references/services/classes/CustomerService.md#retrievebyemail) method.
+- `emails`: An array of strings indicating the email addresses subscribed to the restocked variant. Here, you pass it along to the SendGrid plugin directly to send the email to everyone subscribed. If necessary, you can also retrieve the customer of that email using the `CustomerService`'s [retrieveByEmail](../../references/services/classes/CustomerService.mdx#retrievebyemail) method.
 
 In the method, you retrieve the variant by its ID using the `ProductVariantService`, then send the email using the SendGrid plugins' `SendGridService`.

www/apps/docs/content/references/entities/classes/Address.mdx

@@ -6,151 +6,171 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 # Address
 
+An address is used across the Medusa backend within other schemas and object types. For example, a customer's billing and shipping addresses both use the Address entity.
+
 ## Properties
 
 <ParameterTypes parameters={[
   {
     "name": "address_1",
     "type": "``null`` \\| `string`",
-    "description": "",
+    "description": "Address line 1",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "address_2",
     "type": "``null`` \\| `string`",
-    "description": "",
+    "description": "Address line 2",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "city",
     "type": "``null`` \\| `string`",
-    "description": "",
+    "description": "City",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "company",
     "type": "``null`` \\| `string`",
-    "description": "",
+    "description": "Company name",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "country",
     "type": "``null`` \\| [`Country`](Country.mdx)",
-    "description": "",
+    "description": "A country object.",
     "optional": false,
     "defaultValue": "",
+    "expandable": true,
     "children": []
   },
   {
     "name": "country_code",
     "type": "``null`` \\| `string`",
-    "description": "",
+    "description": "The 2 character ISO code of the country in lower case",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "created_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was created.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "customer",
     "type": "``null`` \\| [`Customer`](Customer.mdx)",
-    "description": "",
+    "description": "Available if the relation `customer` is expanded.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "customer_id",
     "type": "``null`` \\| `string`",
-    "description": "",
+    "description": "ID of the customer this address belongs to",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "deleted_at",
     "type": "``null`` \\| `Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was deleted.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "first_name",
     "type": "``null`` \\| `string`",
-    "description": "",
+    "description": "First name",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "id",
     "type": "`string`",
-    "description": "",
+    "description": "ID of the address",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "last_name",
     "type": "``null`` \\| `string`",
-    "description": "",
+    "description": "Last name",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "metadata",
     "type": "Record<`string`, `unknown`\\>",
-    "description": "",
+    "description": "An optional key-value map with additional details",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "phone",
     "type": "``null`` \\| `string`",
-    "description": "",
+    "description": "Phone Number",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "postal_code",
     "type": "``null`` \\| `string`",
-    "description": "",
+    "description": "Postal Code",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "province",
     "type": "``null`` \\| `string`",
-    "description": "",
+    "description": "Province",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "updated_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was updated.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   }
 ]} />

www/apps/docs/content/references/entities/classes/AnalyticsConfig.mdx

@@ -6,6 +6,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 # AnalyticsConfig
 
+Base abstract entity for all entities
+
 ## Properties
 
 <ParameterTypes parameters={[
@@ -15,6 +17,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
     "description": "",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
@@ -23,6 +26,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
     "description": "",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
@@ -31,6 +35,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
     "description": "",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
@@ -39,6 +44,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
     "description": "",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
@@ -47,6 +53,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
     "description": "",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
@@ -55,6 +62,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
     "description": "",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
@@ -63,6 +71,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
     "description": "",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   }
 ]} />

www/apps/docs/content/references/entities/classes/BaseEntity.mdx

@@ -0,0 +1,41 @@
+---
+displayed_sidebar: entitiesSidebar
+---
+
+import ParameterTypes from "@site/src/components/ParameterTypes"
+
+# BaseEntity
+
+Base abstract entity for all entities
+
+## Properties
+
+<ParameterTypes parameters={[
+  {
+    "name": "created_at",
+    "type": "`Date`",
+    "description": "",
+    "optional": false,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "id",
+    "type": "`string`",
+    "description": "",
+    "optional": false,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "updated_at",
+    "type": "`Date`",
+    "description": "",
+    "optional": false,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  }
+]} />

www/apps/docs/content/references/entities/classes/BatchJob.mdx

@@ -6,134 +6,143 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 # BatchJob
 
+A Batch Job indicates an asynchronus task stored in the Medusa backend. Its status determines whether it has been executed or not.
+
 ## Properties
 
 <ParameterTypes parameters={[
   {
     "name": "canceled_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date of the concellation.",
     "optional": true,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "completed_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date of the completion.",
     "optional": true,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "confirmed_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date when the confirmation has been done.",
     "optional": true,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "context",
     "type": "Record<`string`, `unknown`\\>",
-    "description": "",
+    "description": "The context of the batch job, the type of the batch job determines what the context should contain.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "created_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was created.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "created_by",
     "type": "``null`` \\| `string`",
-    "description": "",
+    "description": "The unique identifier of the user that created the batch job.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "created_by_user",
     "type": "[`User`](User.mdx)",
-    "description": "",
+    "description": "The details of the user that created the batch job.",
     "optional": false,
     "defaultValue": "",
+    "expandable": true,
     "children": [
-      {
-        "name": "constructor",
-        "type": "() => [`User`](User.mdx)",
-        "description": "",
-        "optional": false,
-        "defaultValue": "",
-        "children": []
-      },
       {
         "name": "api_token",
         "type": "`string`",
-        "description": "",
+        "description": "An API token associated with the user.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "created_at",
         "type": "`Date`",
-        "description": "",
+        "description": "The date with timezone at which the resource was created.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "deleted_at",
         "type": "``null`` \\| `Date`",
-        "description": "",
+        "description": "The date with timezone at which the resource was deleted.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "email",
         "type": "`string`",
-        "description": "",
+        "description": "The email of the User",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "first_name",
         "type": "`string`",
-        "description": "",
+        "description": "The first name of the User",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "id",
         "type": "`string`",
-        "description": "",
+        "description": "The user's ID",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "last_name",
         "type": "`string`",
-        "description": "",
+        "description": "The last name of the User",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "metadata",
         "type": "Record<`string`, `unknown`\\>",
-        "description": "",
+        "description": "An optional key-value map with additional details",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
@@ -142,55 +151,25 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
         "description": "",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "role",
         "type": "[`UserRoles`](../enums/UserRoles.mdx)",
-        "description": "",
+        "description": "The user's role. These roles don't provide any different privileges.",
         "optional": false,
-        "defaultValue": "",
-        "children": [
-          {
-            "name": "ADMIN",
-            "type": "``\"admin\"``",
-            "description": "",
-            "optional": true,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "DEVELOPER",
-            "type": "``\"developer\"``",
-            "description": "",
-            "optional": true,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "MEMBER",
-            "type": "``\"member\"``",
-            "description": "",
-            "optional": true,
-            "defaultValue": "",
-            "children": []
-          }
-        ]
+        "defaultValue": "member",
+        "expandable": false,
+        "children": []
       },
       {
         "name": "updated_at",
         "type": "`Date`",
-        "description": "",
-        "optional": false,
-        "defaultValue": "",
-        "children": []
-      },
-      {
-        "name": "beforeInsert",
-        "type": "() => `void`",
-        "description": "",
+        "description": "The date with timezone at which the resource was updated.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       }
     ]
@@ -198,81 +177,219 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
   {
     "name": "deleted_at",
     "type": "``null`` \\| `Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was deleted.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "dry_run",
     "type": "`boolean`",
-    "description": "",
+    "description": "Specify if the job must apply the modifications or not.",
     "optional": false,
-    "defaultValue": "`false`",
+    "defaultValue": "false",
+    "expandable": false,
     "children": []
   },
   {
     "name": "failed_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date when the job failed.",
     "optional": true,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "id",
     "type": "`string`",
-    "description": "",
+    "description": "The unique identifier for the batch job.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "pre_processed_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date from which the job has been pre-processed.",
     "optional": true,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "processing_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date the job is processing at.",
     "optional": true,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "result",
-    "type": "{ `advancement_count?`: `number` ; `count?`: `number` ; `errors?`: (`string` \\| `BatchJobResultError`)[] ; `file_key?`: `string` ; `file_size?`: `number` ; `progress?`: `number` ; `stat_descriptors?`: `BatchJobResultStatDescriptor`[]  } & Record<`string`, `unknown`\\>",
-    "description": "",
+    "type": "{ `advancement_count?`: `number` ; `count?`: `number` ; `errors?`: (`string` \\| [`BatchJobResultError`](../types/BatchJobResultError.mdx))[] ; `file_key?`: `string` ; `file_size?`: `number` ; `progress?`: `number` ; `stat_descriptors?`: [`BatchJobResultStatDescriptor`](../types/BatchJobResultStatDescriptor.mdx)[]  } & Record<`string`, `unknown`\\>",
+    "description": "The result of the batch job.",
     "optional": false,
     "defaultValue": "",
-    "children": []
+    "expandable": false,
+    "children": [
+      {
+        "name": "advancement_count",
+        "type": "`number`",
+        "description": "",
+        "optional": true,
+        "defaultValue": "",
+        "expandable": false,
+        "children": []
+      },
+      {
+        "name": "count",
+        "type": "`number`",
+        "description": "",
+        "optional": true,
+        "defaultValue": "",
+        "expandable": false,
+        "children": []
+      },
+      {
+        "name": "errors",
+        "type": "(`string` \\| [`BatchJobResultError`](../types/BatchJobResultError.mdx))[]",
+        "description": "",
+        "optional": true,
+        "defaultValue": "",
+        "expandable": false,
+        "children": []
+      },
+      {
+        "name": "file_key",
+        "type": "`string`",
+        "description": "",
+        "optional": true,
+        "defaultValue": "",
+        "expandable": false,
+        "children": []
+      },
+      {
+        "name": "file_size",
+        "type": "`number`",
+        "description": "",
+        "optional": true,
+        "defaultValue": "",
+        "expandable": false,
+        "children": []
+      },
+      {
+        "name": "progress",
+        "type": "`number`",
+        "description": "",
+        "optional": true,
+        "defaultValue": "",
+        "expandable": false,
+        "children": []
+      },
+      {
+        "name": "stat_descriptors",
+        "type": "[`BatchJobResultStatDescriptor`](../types/BatchJobResultStatDescriptor.mdx)[]",
+        "description": "",
+        "optional": true,
+        "defaultValue": "",
+        "expandable": false,
+        "children": []
+      }
+    ]
   },
   {
     "name": "status",
-    "type": "`BatchJobStatus`",
-    "description": "",
+    "type": "[`BatchJobStatus`](../enums/BatchJobStatus.mdx)",
+    "description": "The status of the batch job.",
     "optional": false,
-    "defaultValue": "",
-    "children": []
+    "defaultValue": "created",
+    "expandable": false,
+    "children": [
+      {
+        "name": "CANCELED",
+        "type": "``\"canceled\"``",
+        "description": "",
+        "optional": true,
+        "defaultValue": "",
+        "expandable": false,
+        "children": []
+      },
+      {
+        "name": "COMPLETED",
+        "type": "``\"completed\"``",
+        "description": "",
+        "optional": true,
+        "defaultValue": "",
+        "expandable": false,
+        "children": []
+      },
+      {
+        "name": "CONFIRMED",
+        "type": "``\"confirmed\"``",
+        "description": "",
+        "optional": true,
+        "defaultValue": "",
+        "expandable": false,
+        "children": []
+      },
+      {
+        "name": "CREATED",
+        "type": "``\"created\"``",
+        "description": "",
+        "optional": true,
+        "defaultValue": "",
+        "expandable": false,
+        "children": []
+      },
+      {
+        "name": "FAILED",
+        "type": "``\"failed\"``",
+        "description": "",
+        "optional": true,
+        "defaultValue": "",
+        "expandable": false,
+        "children": []
+      },
+      {
+        "name": "PRE_PROCESSED",
+        "type": "``\"pre_processed\"``",
+        "description": "",
+        "optional": true,
+        "defaultValue": "",
+        "expandable": false,
+        "children": []
+      },
+      {
+        "name": "PROCESSING",
+        "type": "``\"processing\"``",
+        "description": "",
+        "optional": true,
+        "defaultValue": "",
+        "expandable": false,
+        "children": []
+      }
+    ]
   },
   {
     "name": "type",
     "type": "`string`",
-    "description": "",
+    "description": "The type of batch job.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "updated_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was last updated.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   }
 ]} />

www/apps/docs/content/references/entities/classes/ClaimTag.mdx

@@ -6,55 +6,63 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 # ClaimTag
 
+Claim Tags are user defined tags that can be assigned to claim items for easy filtering and grouping.
+
 ## Properties
 
 <ParameterTypes parameters={[
   {
     "name": "created_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was created.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "deleted_at",
     "type": "``null`` \\| `Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was deleted.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "id",
     "type": "`string`",
-    "description": "",
+    "description": "The claim tag's ID",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "metadata",
     "type": "Record<`string`, `unknown`\\>",
-    "description": "",
+    "description": "An optional key-value map with additional details",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "updated_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was updated.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "value",
     "type": "`string`",
-    "description": "",
+    "description": "The value that the claim tag holds",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   }
 ]} />

www/apps/docs/content/references/entities/classes/Country.mdx

@@ -6,427 +6,243 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 # Country
 
+Country details
+
 ## Properties
 
 <ParameterTypes parameters={[
   {
     "name": "display_name",
     "type": "`string`",
-    "description": "",
+    "description": "The country name appropriate for display.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "id",
     "type": "`number`",
-    "description": "",
+    "description": "The country's ID",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "iso_2",
     "type": "`string`",
-    "description": "",
+    "description": "The 2 character ISO code of the country in lower case",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "iso_3",
     "type": "`string`",
-    "description": "",
+    "description": "The 2 character ISO code of the country in lower case",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "name",
     "type": "`string`",
-    "description": "",
+    "description": "The normalized country name in upper case.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "num_code",
     "type": "`number`",
-    "description": "",
+    "description": "The numerical ISO code for the country.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "region",
     "type": "[`Region`](Region.mdx)",
-    "description": "",
+    "description": "The details of the region the country is associated with.",
     "optional": false,
     "defaultValue": "",
+    "expandable": true,
     "children": [
-      {
-        "name": "constructor",
-        "type": "() => [`Region`](Region.mdx)",
-        "description": "",
-        "optional": false,
-        "defaultValue": "",
-        "children": []
-      },
       {
         "name": "automatic_taxes",
         "type": "`boolean`",
-        "description": "",
+        "description": "Whether taxes should be automated in this region.",
         "optional": false,
-        "defaultValue": "",
+        "defaultValue": "true",
+        "expandable": false,
         "children": []
       },
       {
         "name": "countries",
         "type": "[`Country`](Country.mdx)[]",
-        "description": "",
+        "description": "The details of the countries included in this region.",
         "optional": false,
         "defaultValue": "",
-        "children": [
-          {
-            "name": "constructor",
-            "type": "() => [`Country`](Country.mdx)",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "display_name",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "id",
-            "type": "`number`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "iso_2",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "iso_3",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "name",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "num_code",
-            "type": "`number`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "region",
-            "type": "[`Region`](Region.mdx)",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "region_id",
-            "type": "``null`` \\| `string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          }
-        ]
+        "expandable": true,
+        "children": []
       },
       {
         "name": "created_at",
         "type": "`Date`",
-        "description": "",
+        "description": "The date with timezone at which the resource was created.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "currency",
         "type": "[`Currency`](Currency.mdx)",
-        "description": "",
+        "description": "The details of the currency used in the region.",
         "optional": false,
         "defaultValue": "",
-        "children": [
-          {
-            "name": "constructor",
-            "type": "() => [`Currency`](Currency.mdx)",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "code",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "includes_tax",
-            "type": "`boolean`",
-            "description": "",
-            "optional": true,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "name",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "symbol",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "symbol_native",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          }
-        ]
+        "expandable": true,
+        "children": []
       },
       {
         "name": "currency_code",
         "type": "`string`",
-        "description": "",
+        "description": "The three character currency code used in the region.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "deleted_at",
         "type": "``null`` \\| `Date`",
-        "description": "",
+        "description": "The date with timezone at which the resource was deleted.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "fulfillment_providers",
         "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]",
-        "description": "",
+        "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.",
         "optional": false,
         "defaultValue": "",
-        "children": [
-          {
-            "name": "constructor",
-            "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "id",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "is_installed",
-            "type": "`boolean`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          }
-        ]
+        "expandable": true,
+        "children": []
       },
       {
         "name": "gift_cards_taxable",
         "type": "`boolean`",
-        "description": "",
+        "description": "Whether the gift cards are taxable or not in this region.",
         "optional": false,
-        "defaultValue": "",
+        "defaultValue": "true",
+        "expandable": false,
         "children": []
       },
       {
         "name": "id",
         "type": "`string`",
-        "description": "",
+        "description": "The region's ID",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "includes_tax",
         "type": "`boolean`",
-        "description": "",
+        "description": "Whether the prices for the region include tax",
         "optional": false,
-        "defaultValue": "",
+        "defaultValue": "false",
+        "expandable": false,
+        "featureFlag": "tax_inclusive_pricing",
         "children": []
       },
       {
         "name": "metadata",
         "type": "Record<`string`, `unknown`\\>",
-        "description": "",
+        "description": "An optional key-value map with additional details",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "name",
         "type": "`string`",
-        "description": "",
+        "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "payment_providers",
         "type": "[`PaymentProvider`](PaymentProvider.mdx)[]",
-        "description": "",
+        "description": "The details of the payment providers that can be used to process payments in the region.",
         "optional": false,
         "defaultValue": "",
-        "children": [
-          {
-            "name": "constructor",
-            "type": "() => [`PaymentProvider`](PaymentProvider.mdx)",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "id",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "is_installed",
-            "type": "`boolean`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          }
-        ]
+        "expandable": true,
+        "children": []
       },
       {
         "name": "tax_code",
         "type": "`string`",
-        "description": "",
+        "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "tax_provider",
         "type": "[`TaxProvider`](TaxProvider.mdx)",
-        "description": "",
+        "description": "The details of the tax provider used in the region.",
         "optional": false,
         "defaultValue": "",
-        "children": [
-          {
-            "name": "constructor",
-            "type": "() => [`TaxProvider`](TaxProvider.mdx)",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "id",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "is_installed",
-            "type": "`boolean`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          }
-        ]
+        "expandable": true,
+        "children": []
       },
       {
         "name": "tax_provider_id",
         "type": "``null`` \\| `string`",
-        "description": "",
+        "description": "The ID of the tax provider used in this region",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "tax_rate",
         "type": "`number`",
-        "description": "",
+        "description": "The tax rate that should be charged on purchases in the Region.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "tax_rates",
         "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]",
-        "description": "",
+        "description": "The details of the tax rates used in the region, aside from the default rate.",
         "optional": false,
         "defaultValue": "",
+        "expandable": true,
         "children": []
       },
       {
         "name": "updated_at",
         "type": "`Date`",
-        "description": "",
-        "optional": false,
-        "defaultValue": "",
-        "children": []
-      },
-      {
-        "name": "beforeInsert",
-        "type": "() => `void`",
-        "description": "",
+        "description": "The date with timezone at which the resource was updated.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       }
     ]
@@ -434,9 +250,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
   {
     "name": "region_id",
     "type": "``null`` \\| `string`",
-    "description": "",
+    "description": "The region ID this country is associated with.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   }
 ]} />

www/apps/docs/content/references/entities/classes/Currency.mdx

@@ -6,47 +6,55 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 # Currency
 
+Currency
+
 ## Properties
 
 <ParameterTypes parameters={[
   {
     "name": "code",
     "type": "`string`",
-    "description": "",
+    "description": "The 3 character ISO code for the currency.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "includes_tax",
     "type": "`boolean`",
-    "description": "",
+    "description": "Whether the currency prices include tax",
     "optional": true,
-    "defaultValue": "",
+    "defaultValue": "false",
+    "expandable": false,
+    "featureFlag": "tax_inclusive_pricing",
     "children": []
   },
   {
     "name": "name",
     "type": "`string`",
-    "description": "",
+    "description": "The written name of the currency",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "symbol",
     "type": "`string`",
-    "description": "",
+    "description": "The symbol used to indicate the currency.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "symbol_native",
     "type": "`string`",
-    "description": "",
+    "description": "The native symbol used to indicate the currency.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   }
 ]} />

www/apps/docs/content/references/entities/classes/FulfillmentProvider.mdx

@@ -6,23 +6,27 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 # FulfillmentProvider
 
+A fulfillment provider represents a fulfillment service installed in the Medusa backend, either through a plugin or backend customizations. It holds the fulfillment service's installation status.
+
 ## Properties
 
 <ParameterTypes parameters={[
   {
     "name": "id",
     "type": "`string`",
-    "description": "",
+    "description": "The ID of the fulfillment provider as given by the fulfillment service.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "is_installed",
     "type": "`boolean`",
-    "description": "",
+    "description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is_installed` attribute is set to `false`.",
     "optional": false,
-    "defaultValue": "",
+    "defaultValue": "true",
+    "expandable": false,
     "children": []
   }
 ]} />

www/apps/docs/content/references/entities/classes/IdempotencyKey.mdx

@@ -6,87 +6,99 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 # IdempotencyKey
 
+Idempotency Key is used to continue a process in case of any failure that might occur.
+
 ## Properties
 
 <ParameterTypes parameters={[
   {
     "name": "created_at",
     "type": "`Date`",
-    "description": "",
+    "description": "Date which the idempotency key was locked.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "id",
     "type": "`string`",
-    "description": "",
+    "description": "The idempotency key's ID",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "idempotency_key",
     "type": "`string`",
-    "description": "",
+    "description": "The unique randomly generated key used to determine the state of a process.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "locked_at",
     "type": "`Date`",
-    "description": "",
+    "description": "Date which the idempotency key was locked.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "recovery_point",
     "type": "`string`",
-    "description": "",
+    "description": "Where to continue from.",
     "optional": false,
-    "defaultValue": "",
+    "defaultValue": "started",
+    "expandable": false,
     "children": []
   },
   {
     "name": "request_method",
     "type": "`string`",
-    "description": "",
+    "description": "The method of the request",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "request_params",
     "type": "Record<`string`, `unknown`\\>",
-    "description": "",
+    "description": "The parameters passed to the request",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "request_path",
     "type": "`string`",
-    "description": "",
+    "description": "The request's path",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "response_body",
     "type": "Record<`string`, `unknown`\\>",
-    "description": "",
+    "description": "The response's body",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "response_code",
     "type": "`number`",
-    "description": "",
+    "description": "The response's code.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   }
 ]} />

www/apps/docs/content/references/entities/classes/Image.mdx

@@ -6,55 +6,63 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 # Image
 
+An Image is used to store details about uploaded images. Images are uploaded by the File Service, and the URL is provided by the File Service.
+
 ## Properties
 
 <ParameterTypes parameters={[
   {
     "name": "created_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was created.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "deleted_at",
     "type": "``null`` \\| `Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was deleted.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "id",
     "type": "`string`",
-    "description": "",
+    "description": "The image's ID",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "metadata",
     "type": "Record<`string`, `unknown`\\>",
-    "description": "",
+    "description": "An optional key-value map with additional details",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "updated_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was updated.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "url",
     "type": "`string`",
-    "description": "",
+    "description": "The URL at which the image file can be found.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   }
 ]} />

www/apps/docs/content/references/entities/classes/Invite.mdx

@@ -6,86 +6,98 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 # Invite
 
+An invite is created when an admin user invites a new user to join the store's team. Once the invite is accepted, it's deleted.
+
 ## Properties
 
 <ParameterTypes parameters={[
   {
     "name": "accepted",
     "type": "`boolean`",
-    "description": "",
+    "description": "Whether the invite was accepted or not.",
     "optional": false,
-    "defaultValue": "",
+    "defaultValue": "false",
+    "expandable": false,
     "children": []
   },
   {
     "name": "created_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was created.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "deleted_at",
     "type": "``null`` \\| `Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was deleted.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "expires_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date the invite expires at.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "id",
     "type": "`string`",
-    "description": "",
+    "description": "The invite's ID",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "metadata",
     "type": "Record<`string`, `unknown`\\>",
-    "description": "",
+    "description": "An optional key-value map with additional details",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "role",
     "type": "[`UserRoles`](../enums/UserRoles.mdx)",
-    "description": "",
+    "description": "The user's role. These roles don't change the privileges of the user.",
     "optional": false,
-    "defaultValue": "",
+    "defaultValue": "member",
+    "expandable": false,
     "children": [
       {
         "name": "ADMIN",
         "type": "``\"admin\"``",
-        "description": "",
+        "description": "The user is an admin.",
         "optional": true,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "DEVELOPER",
         "type": "``\"developer\"``",
-        "description": "",
+        "description": "The user is a developer.",
         "optional": true,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "MEMBER",
         "type": "``\"member\"``",
-        "description": "",
+        "description": "The user is a team member.",
         "optional": true,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       }
     ]
@@ -93,25 +105,28 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
   {
     "name": "token",
     "type": "`string`",
-    "description": "",
+    "description": "The token used to accept the invite.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "updated_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was updated.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "user_email",
     "type": "`string`",
-    "description": "",
+    "description": "The email of the user being invited.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   }
 ]} />

www/apps/docs/content/references/entities/classes/Note.mdx

@@ -6,86 +6,89 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 # Note
 
+A Note is an element that can be used in association with different resources to allow admin users to describe additional information. For example, they can be used to add additional information about orders.
+
 ## Properties
 
 <ParameterTypes parameters={[
   {
     "name": "author",
     "type": "[`User`](User.mdx)",
-    "description": "",
+    "description": "The details of the user that created the note.",
     "optional": false,
     "defaultValue": "",
+    "expandable": true,
     "children": [
-      {
-        "name": "constructor",
-        "type": "() => [`User`](User.mdx)",
-        "description": "",
-        "optional": false,
-        "defaultValue": "",
-        "children": []
-      },
       {
         "name": "api_token",
         "type": "`string`",
-        "description": "",
+        "description": "An API token associated with the user.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "created_at",
         "type": "`Date`",
-        "description": "",
+        "description": "The date with timezone at which the resource was created.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "deleted_at",
         "type": "``null`` \\| `Date`",
-        "description": "",
+        "description": "The date with timezone at which the resource was deleted.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "email",
         "type": "`string`",
-        "description": "",
+        "description": "The email of the User",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "first_name",
         "type": "`string`",
-        "description": "",
+        "description": "The first name of the User",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "id",
         "type": "`string`",
-        "description": "",
+        "description": "The user's ID",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "last_name",
         "type": "`string`",
-        "description": "",
+        "description": "The last name of the User",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "metadata",
         "type": "Record<`string`, `unknown`\\>",
-        "description": "",
+        "description": "An optional key-value map with additional details",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
@@ -94,55 +97,25 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
         "description": "",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "role",
         "type": "[`UserRoles`](../enums/UserRoles.mdx)",
-        "description": "",
+        "description": "The user's role. These roles don't provide any different privileges.",
         "optional": false,
-        "defaultValue": "",
-        "children": [
-          {
-            "name": "ADMIN",
-            "type": "``\"admin\"``",
-            "description": "",
-            "optional": true,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "DEVELOPER",
-            "type": "``\"developer\"``",
-            "description": "",
-            "optional": true,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "MEMBER",
-            "type": "``\"member\"``",
-            "description": "",
-            "optional": true,
-            "defaultValue": "",
-            "children": []
-          }
-        ]
+        "defaultValue": "member",
+        "expandable": false,
+        "children": []
       },
       {
         "name": "updated_at",
         "type": "`Date`",
-        "description": "",
-        "optional": false,
-        "defaultValue": "",
-        "children": []
-      },
-      {
-        "name": "beforeInsert",
-        "type": "() => `void`",
-        "description": "",
+        "description": "The date with timezone at which the resource was updated.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       }
     ]
@@ -150,73 +123,82 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
   {
     "name": "author_id",
     "type": "`string`",
-    "description": "",
+    "description": "The ID of the user that created the note.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "created_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was created.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "deleted_at",
     "type": "``null`` \\| `Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was deleted.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "id",
     "type": "`string`",
-    "description": "",
+    "description": "The note's ID",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "metadata",
     "type": "Record<`string`, `unknown`\\>",
-    "description": "",
+    "description": "An optional key-value map with additional details",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "resource_id",
     "type": "`string`",
-    "description": "",
+    "description": "The ID of the resource that the Note refers to.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "resource_type",
     "type": "`string`",
-    "description": "",
+    "description": "The type of resource that the Note refers to.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "updated_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was updated.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "value",
     "type": "`string`",
-    "description": "",
+    "description": "The contents of the note.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   }
 ]} />

www/apps/docs/content/references/entities/classes/NotificationProvider.mdx

@@ -0,0 +1,32 @@
+---
+displayed_sidebar: entitiesSidebar
+---
+
+import ParameterTypes from "@site/src/components/ParameterTypes"
+
+# NotificationProvider
+
+A notification provider represents a notification service installed in the Medusa backend, either through a plugin or backend customizations. It holds the notification service's installation status.
+
+## Properties
+
+<ParameterTypes parameters={[
+  {
+    "name": "id",
+    "type": "`string`",
+    "description": "The ID of the notification provider as given by the notification service.",
+    "optional": false,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "is_installed",
+    "type": "`boolean`",
+    "description": "Whether the notification service is installed in the current version. If a notification service is no longer installed, the `is_installed` attribute is set to `false`.",
+    "optional": false,
+    "defaultValue": "true",
+    "expandable": false,
+    "children": []
+  }
+]} />

www/apps/docs/content/references/entities/classes/Oauth.mdx

@@ -15,6 +15,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
     "description": "",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
@@ -23,6 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
     "description": "",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
@@ -31,6 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
     "description": "",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
@@ -39,6 +42,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
     "description": "",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
@@ -47,6 +51,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
     "description": "",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
@@ -55,6 +60,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
     "description": "",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   }
 ]} />

www/apps/docs/content/references/entities/classes/PaymentProvider.mdx

@@ -6,23 +6,27 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 # PaymentProvider
 
+A payment provider represents a payment service installed in the Medusa backend, either through a plugin or backend customizations. It holds the payment service's installation status.
+
 ## Properties
 
 <ParameterTypes parameters={[
   {
     "name": "id",
     "type": "`string`",
-    "description": "",
+    "description": "The ID of the payment provider as given by the payment service.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "is_installed",
     "type": "`boolean`",
-    "description": "",
+    "description": "Whether the payment service is installed in the current version. If a payment service is no longer installed, the `is_installed` attribute is set to `false`.",
     "optional": false,
-    "defaultValue": "",
+    "defaultValue": "true",
+    "expandable": false,
     "children": []
   }
 ]} />

www/apps/docs/content/references/entities/classes/ProductTag.mdx

@@ -6,55 +6,63 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 # ProductTag
 
+A Product Tag can be added to Products for easy filtering and grouping.
+
 ## Properties
 
 <ParameterTypes parameters={[
   {
     "name": "created_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was created.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "deleted_at",
     "type": "``null`` \\| `Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was deleted.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "id",
     "type": "`string`",
-    "description": "",
+    "description": "The product tag's ID",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "metadata",
     "type": "Record<`string`, `unknown`\\>",
-    "description": "",
+    "description": "An optional key-value map with additional details",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "updated_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was updated.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "value",
     "type": "`string`",
-    "description": "",
+    "description": "The value that the Product Tag represents",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   }
 ]} />

www/apps/docs/content/references/entities/classes/ProductType.mdx

@@ -6,55 +6,63 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 # ProductType
 
+A Product Type can be added to Products for filtering and reporting purposes.
+
 ## Properties
 
 <ParameterTypes parameters={[
   {
     "name": "created_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was created.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "deleted_at",
     "type": "``null`` \\| `Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was deleted.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "id",
     "type": "`string`",
-    "description": "",
+    "description": "The product type's ID",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "metadata",
     "type": "Record<`string`, `unknown`\\>",
-    "description": "",
+    "description": "An optional key-value map with additional details",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "updated_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was updated.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "value",
     "type": "`string`",
-    "description": "",
+    "description": "The value that the Product Type represents.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   }
 ]} />

www/apps/docs/content/references/entities/classes/ProductVariantMoneyAmount.mdx

@@ -6,6 +6,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 # ProductVariantMoneyAmount
 
+Base abstract entity for all entities
+
 ## Properties
 
 <ParameterTypes parameters={[
@@ -15,6 +17,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
     "description": "",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
@@ -23,6 +26,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
     "description": "",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
@@ -31,6 +35,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
     "description": "",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
@@ -39,6 +44,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
     "description": "",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
@@ -47,6 +53,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
     "description": "",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
@@ -55,6 +62,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
     "description": "",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   }
 ]} />

www/apps/docs/content/references/entities/classes/PublishableApiKey.mdx

@@ -6,63 +6,72 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 # PublishableApiKey
 
+A Publishable API key defines scopes that resources are available in. Then, it can be used in request to infer the resources without having to directly pass them. For example, a publishable API key can be associated with one or more sales channels. Then, when the publishable API key is passed in the header of a request, it is inferred what sales channel is being used without having to pass the sales channel as a query or body parameter of the request. Publishable API keys can only be used with sales channels, at the moment.
+
 ## Properties
 
 <ParameterTypes parameters={[
   {
     "name": "created_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was created.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "created_by",
     "type": "``null`` \\| `string`",
-    "description": "",
+    "description": "The unique identifier of the user that created the key.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "id",
     "type": "`string`",
-    "description": "",
+    "description": "The key's ID",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "revoked_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the key was revoked.",
     "optional": true,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "revoked_by",
     "type": "``null`` \\| `string`",
-    "description": "",
+    "description": "The unique identifier of the user that revoked the key.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "title",
     "type": "`string`",
-    "description": "",
+    "description": "The key's title.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "updated_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was updated.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   }
 ]} />

www/apps/docs/content/references/entities/classes/PublishableApiKeySalesChannel.mdx

@@ -6,23 +6,27 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 # PublishableApiKeySalesChannel
 
+This represents the association between the Publishable API keys and Sales Channels
+
 ## Properties
 
 <ParameterTypes parameters={[
   {
     "name": "publishable_key_id",
     "type": "`string`",
-    "description": "",
+    "description": "The publishable API key's ID",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "sales_channel_id",
     "type": "`string`",
-    "description": "",
+    "description": "The sales channel's ID",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   }
 ]} />

www/apps/docs/content/references/entities/classes/Region.mdx

@@ -6,263 +6,98 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 # Region
 
+A region holds settings specific to a geographical location, including the currency, tax rates, and fulfillment and payment providers. A Region can consist of multiple countries to accomodate common shopping settings across countries.
+
 ## Properties
 
 <ParameterTypes parameters={[
   {
     "name": "automatic_taxes",
     "type": "`boolean`",
-    "description": "",
+    "description": "Whether taxes should be automated in this region.",
     "optional": false,
-    "defaultValue": "",
+    "defaultValue": "true",
+    "expandable": false,
     "children": []
   },
   {
     "name": "countries",
     "type": "[`Country`](Country.mdx)[]",
-    "description": "",
+    "description": "The details of the countries included in this region.",
     "optional": false,
     "defaultValue": "",
+    "expandable": true,
     "children": [
-      {
-        "name": "constructor",
-        "type": "() => [`Country`](Country.mdx)",
-        "description": "",
-        "optional": false,
-        "defaultValue": "",
-        "children": []
-      },
       {
         "name": "display_name",
         "type": "`string`",
-        "description": "",
+        "description": "The country name appropriate for display.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "id",
         "type": "`number`",
-        "description": "",
+        "description": "The country's ID",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "iso_2",
         "type": "`string`",
-        "description": "",
+        "description": "The 2 character ISO code of the country in lower case",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "iso_3",
         "type": "`string`",
-        "description": "",
+        "description": "The 2 character ISO code of the country in lower case",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "name",
         "type": "`string`",
-        "description": "",
+        "description": "The normalized country name in upper case.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "num_code",
         "type": "`number`",
-        "description": "",
+        "description": "The numerical ISO code for the country.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "region",
         "type": "[`Region`](Region.mdx)",
-        "description": "",
+        "description": "The details of the region the country is associated with.",
         "optional": false,
         "defaultValue": "",
-        "children": [
-          {
-            "name": "constructor",
-            "type": "() => [`Region`](Region.mdx)",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "automatic_taxes",
-            "type": "`boolean`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "countries",
-            "type": "[`Country`](Country.mdx)[]",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "created_at",
-            "type": "`Date`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "currency",
-            "type": "[`Currency`](Currency.mdx)",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "currency_code",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "deleted_at",
-            "type": "``null`` \\| `Date`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "fulfillment_providers",
-            "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "gift_cards_taxable",
-            "type": "`boolean`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "id",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "includes_tax",
-            "type": "`boolean`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "metadata",
-            "type": "Record<`string`, `unknown`\\>",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "name",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "payment_providers",
-            "type": "[`PaymentProvider`](PaymentProvider.mdx)[]",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "tax_code",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "tax_provider",
-            "type": "[`TaxProvider`](TaxProvider.mdx)",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "tax_provider_id",
-            "type": "``null`` \\| `string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "tax_rate",
-            "type": "`number`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "tax_rates",
-            "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "updated_at",
-            "type": "`Date`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "beforeInsert",
-            "type": "() => `void`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          }
-        ]
+        "expandable": true,
+        "children": []
       },
       {
         "name": "region_id",
         "type": "``null`` \\| `string`",
-        "description": "",
+        "description": "The region ID this country is associated with.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       }
     ]
@@ -270,64 +105,64 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
   {
     "name": "created_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was created.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "currency",
     "type": "[`Currency`](Currency.mdx)",
-    "description": "",
+    "description": "The details of the currency used in the region.",
     "optional": false,
     "defaultValue": "",
+    "expandable": true,
     "children": [
-      {
-        "name": "constructor",
-        "type": "() => [`Currency`](Currency.mdx)",
-        "description": "",
-        "optional": false,
-        "defaultValue": "",
-        "children": []
-      },
       {
         "name": "code",
         "type": "`string`",
-        "description": "",
+        "description": "The 3 character ISO code for the currency.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "includes_tax",
         "type": "`boolean`",
-        "description": "",
+        "description": "Whether the currency prices include tax",
         "optional": true,
-        "defaultValue": "",
+        "defaultValue": "false",
+        "expandable": false,
+        "featureFlag": "tax_inclusive_pricing",
         "children": []
       },
       {
         "name": "name",
         "type": "`string`",
-        "description": "",
+        "description": "The written name of the currency",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "symbol",
         "type": "`string`",
-        "description": "",
+        "description": "The symbol used to indicate the currency.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "symbol_native",
         "type": "`string`",
-        "description": "",
+        "description": "The native symbol used to indicate the currency.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       }
     ]
@@ -335,48 +170,45 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
   {
     "name": "currency_code",
     "type": "`string`",
-    "description": "",
+    "description": "The three character currency code used in the region.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "deleted_at",
     "type": "``null`` \\| `Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was deleted.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "fulfillment_providers",
     "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]",
-    "description": "",
+    "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.",
     "optional": false,
     "defaultValue": "",
+    "expandable": true,
     "children": [
-      {
-        "name": "constructor",
-        "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)",
-        "description": "",
-        "optional": false,
-        "defaultValue": "",
-        "children": []
-      },
       {
         "name": "id",
         "type": "`string`",
-        "description": "",
+        "description": "The ID of the fulfillment provider as given by the fulfillment service.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "is_installed",
         "type": "`boolean`",
-        "description": "",
+        "description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is_installed` attribute is set to `false`.",
         "optional": false,
-        "defaultValue": "",
+        "defaultValue": "true",
+        "expandable": false,
         "children": []
       }
     ]
@@ -384,72 +216,73 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
   {
     "name": "gift_cards_taxable",
     "type": "`boolean`",
-    "description": "",
+    "description": "Whether the gift cards are taxable or not in this region.",
     "optional": false,
-    "defaultValue": "",
+    "defaultValue": "true",
+    "expandable": false,
     "children": []
   },
   {
     "name": "id",
     "type": "`string`",
-    "description": "",
+    "description": "The region's ID",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "includes_tax",
     "type": "`boolean`",
-    "description": "",
+    "description": "Whether the prices for the region include tax",
     "optional": false,
-    "defaultValue": "",
+    "defaultValue": "false",
+    "expandable": false,
+    "featureFlag": "tax_inclusive_pricing",
     "children": []
   },
   {
     "name": "metadata",
     "type": "Record<`string`, `unknown`\\>",
-    "description": "",
+    "description": "An optional key-value map with additional details",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "name",
     "type": "`string`",
-    "description": "",
+    "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "payment_providers",
     "type": "[`PaymentProvider`](PaymentProvider.mdx)[]",
-    "description": "",
+    "description": "The details of the payment providers that can be used to process payments in the region.",
     "optional": false,
     "defaultValue": "",
+    "expandable": true,
     "children": [
-      {
-        "name": "constructor",
-        "type": "() => [`PaymentProvider`](PaymentProvider.mdx)",
-        "description": "",
-        "optional": false,
-        "defaultValue": "",
-        "children": []
-      },
       {
         "name": "id",
         "type": "`string`",
-        "description": "",
+        "description": "The ID of the payment provider as given by the payment service.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "is_installed",
         "type": "`boolean`",
-        "description": "",
+        "description": "Whether the payment service is installed in the current version. If a payment service is no longer installed, the `is_installed` attribute is set to `false`.",
         "optional": false,
-        "defaultValue": "",
+        "defaultValue": "true",
+        "expandable": false,
         "children": []
       }
     ]
@@ -457,40 +290,36 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
   {
     "name": "tax_code",
     "type": "`string`",
-    "description": "",
+    "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "tax_provider",
     "type": "[`TaxProvider`](TaxProvider.mdx)",
-    "description": "",
+    "description": "The details of the tax provider used in the region.",
     "optional": false,
     "defaultValue": "",
+    "expandable": true,
     "children": [
-      {
-        "name": "constructor",
-        "type": "() => [`TaxProvider`](TaxProvider.mdx)",
-        "description": "",
-        "optional": false,
-        "defaultValue": "",
-        "children": []
-      },
       {
         "name": "id",
         "type": "`string`",
-        "description": "",
+        "description": "The ID of the tax provider as given by the tax service.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "is_installed",
         "type": "`boolean`",
-        "description": "",
+        "description": "Whether the tax service is installed in the current version. If a tax service is no longer installed, the `is_installed` attribute is set to `false`.",
         "optional": false,
-        "defaultValue": "",
+        "defaultValue": "true",
+        "expandable": false,
         "children": []
       }
     ]
@@ -498,33 +327,37 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
   {
     "name": "tax_provider_id",
     "type": "``null`` \\| `string`",
-    "description": "",
+    "description": "The ID of the tax provider used in this region",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "tax_rate",
     "type": "`number`",
-    "description": "",
+    "description": "The tax rate that should be charged on purchases in the Region.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "tax_rates",
     "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]",
-    "description": "",
+    "description": "The details of the tax rates used in the region, aside from the default rate.",
     "optional": false,
     "defaultValue": "",
+    "expandable": true,
     "children": []
   },
   {
     "name": "updated_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was updated.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   }
 ]} />

www/apps/docs/content/references/entities/classes/ReturnReason.mdx

@@ -6,287 +6,188 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 # ReturnReason
 
+A Return Reason is a value defined by an admin. It can be used on Return Items in order to indicate why a Line Item was returned.
+
 ## Properties
 
 <ParameterTypes parameters={[
   {
     "name": "created_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was created.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "deleted_at",
     "type": "``null`` \\| `Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was deleted.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "description",
     "type": "`string`",
-    "description": "",
+    "description": "A description of the Reason.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "id",
     "type": "`string`",
-    "description": "",
+    "description": "The return reason's ID",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "label",
     "type": "`string`",
-    "description": "",
+    "description": "A text that can be displayed to the Customer as a reason.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "metadata",
     "type": "Record<`string`, `unknown`\\>",
-    "description": "",
+    "description": "An optional key-value map with additional details",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "parent_return_reason",
     "type": "``null`` \\| [`ReturnReason`](ReturnReason.mdx)",
-    "description": "",
+    "description": "The details of the parent reason.",
     "optional": false,
     "defaultValue": "",
+    "expandable": true,
     "children": []
   },
   {
     "name": "parent_return_reason_id",
     "type": "``null`` \\| `string`",
-    "description": "",
+    "description": "The ID of the parent reason.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "return_reason_children",
     "type": "[`ReturnReason`](ReturnReason.mdx)[]",
-    "description": "",
+    "description": "The details of the child reasons.",
     "optional": false,
     "defaultValue": "",
+    "expandable": true,
     "children": [
-      {
-        "name": "constructor",
-        "type": "() => [`ReturnReason`](ReturnReason.mdx)",
-        "description": "",
-        "optional": false,
-        "defaultValue": "",
-        "children": []
-      },
       {
         "name": "created_at",
         "type": "`Date`",
-        "description": "",
+        "description": "The date with timezone at which the resource was created.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "deleted_at",
         "type": "``null`` \\| `Date`",
-        "description": "",
+        "description": "The date with timezone at which the resource was deleted.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "description",
         "type": "`string`",
-        "description": "",
+        "description": "A description of the Reason.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "id",
         "type": "`string`",
-        "description": "",
+        "description": "The return reason's ID",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "label",
         "type": "`string`",
-        "description": "",
+        "description": "A text that can be displayed to the Customer as a reason.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "metadata",
         "type": "Record<`string`, `unknown`\\>",
-        "description": "",
+        "description": "An optional key-value map with additional details",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "parent_return_reason",
         "type": "``null`` \\| [`ReturnReason`](ReturnReason.mdx)",
-        "description": "",
+        "description": "The details of the parent reason.",
         "optional": false,
         "defaultValue": "",
+        "expandable": true,
         "children": []
       },
       {
         "name": "parent_return_reason_id",
         "type": "``null`` \\| `string`",
-        "description": "",
+        "description": "The ID of the parent reason.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "return_reason_children",
         "type": "[`ReturnReason`](ReturnReason.mdx)[]",
-        "description": "",
+        "description": "The details of the child reasons.",
         "optional": false,
         "defaultValue": "",
-        "children": [
-          {
-            "name": "constructor",
-            "type": "() => [`ReturnReason`](ReturnReason.mdx)",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "created_at",
-            "type": "`Date`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "deleted_at",
-            "type": "``null`` \\| `Date`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "description",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "id",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "label",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "metadata",
-            "type": "Record<`string`, `unknown`\\>",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "parent_return_reason",
-            "type": "``null`` \\| [`ReturnReason`](ReturnReason.mdx)",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "parent_return_reason_id",
-            "type": "``null`` \\| `string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "return_reason_children",
-            "type": "[`ReturnReason`](ReturnReason.mdx)[]",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "updated_at",
-            "type": "`Date`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "value",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "beforeInsert",
-            "type": "() => `void`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          }
-        ]
+        "expandable": true,
+        "children": []
       },
       {
         "name": "updated_at",
         "type": "`Date`",
-        "description": "",
+        "description": "The date with timezone at which the resource was updated.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "value",
         "type": "`string`",
-        "description": "",
-        "optional": false,
-        "defaultValue": "",
-        "children": []
-      },
-      {
-        "name": "beforeInsert",
-        "type": "() => `void`",
-        "description": "",
+        "description": "The value to identify the reason by.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       }
     ]
@@ -294,17 +195,19 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
   {
     "name": "updated_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was updated.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "value",
     "type": "`string`",
-    "description": "",
+    "description": "The value to identify the reason by.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   }
 ]} />

www/apps/docs/content/references/entities/classes/SalesChannel.mdx

@@ -6,215 +6,125 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 # SalesChannel
 
+A Sales Channel is a method a business offers its products for purchase for the customers. For example, a Webshop can be a sales channel, and a mobile app can be another.
+
 ## Properties
 
 <ParameterTypes parameters={[
   {
     "name": "created_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was created.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "deleted_at",
     "type": "``null`` \\| `Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was deleted.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "description",
     "type": "``null`` \\| `string`",
-    "description": "",
+    "description": "The description of the sales channel.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "id",
     "type": "`string`",
-    "description": "",
+    "description": "The sales channel's ID",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "is_disabled",
     "type": "`boolean`",
-    "description": "",
+    "description": "Specify if the sales channel is enabled or disabled.",
     "optional": false,
-    "defaultValue": "",
+    "defaultValue": "false",
+    "expandable": false,
     "children": []
   },
   {
     "name": "locations",
     "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]",
-    "description": "",
+    "description": "The details of the stock locations related to the sales channel.",
     "optional": false,
     "defaultValue": "",
+    "expandable": true,
     "children": [
-      {
-        "name": "constructor",
-        "type": "() => [`SalesChannelLocation`](SalesChannelLocation.mdx)",
-        "description": "",
-        "optional": false,
-        "defaultValue": "",
-        "children": []
-      },
       {
         "name": "created_at",
         "type": "`Date`",
-        "description": "",
+        "description": "The date with timezone at which the resource was created.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "deleted_at",
         "type": "``null`` \\| `Date`",
-        "description": "",
+        "description": "The date with timezone at which the resource was deleted.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "id",
         "type": "`string`",
-        "description": "",
+        "description": "The Sales Channel Stock Location's ID",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "location_id",
         "type": "`string`",
-        "description": "",
+        "description": "The ID of the Location Stock.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "sales_channel",
         "type": "[`SalesChannel`](SalesChannel.mdx)",
-        "description": "",
+        "description": "The details of the sales channel the location is associated with.",
         "optional": false,
         "defaultValue": "",
-        "children": [
-          {
-            "name": "constructor",
-            "type": "() => [`SalesChannel`](SalesChannel.mdx)",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "created_at",
-            "type": "`Date`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "deleted_at",
-            "type": "``null`` \\| `Date`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "description",
-            "type": "``null`` \\| `string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "id",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "is_disabled",
-            "type": "`boolean`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "locations",
-            "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "metadata",
-            "type": "``null`` \\| Record<`string`, `unknown`\\>",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "name",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "updated_at",
-            "type": "`Date`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "beforeInsert",
-            "type": "() => `void`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          }
-        ]
+        "expandable": true,
+        "children": []
       },
       {
         "name": "sales_channel_id",
         "type": "`string`",
-        "description": "",
+        "description": "The ID of the Sales Channel",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "updated_at",
         "type": "`Date`",
-        "description": "",
-        "optional": false,
-        "defaultValue": "",
-        "children": []
-      },
-      {
-        "name": "beforeInsert",
-        "type": "() => `void`",
-        "description": "",
+        "description": "The date with timezone at which the resource was updated.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       }
     ]
@@ -222,25 +132,28 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
   {
     "name": "metadata",
     "type": "``null`` \\| Record<`string`, `unknown`\\>",
-    "description": "",
+    "description": "An optional key-value map with additional details",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "name",
     "type": "`string`",
-    "description": "",
+    "description": "The name of the sales channel.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "updated_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was updated.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   }
 ]} />

www/apps/docs/content/references/entities/classes/SalesChannelLocation.mdx

@@ -6,207 +6,134 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 # SalesChannelLocation
 
+This represents the association between a sales channel and a stock locations.
+
 ## Properties
 
 <ParameterTypes parameters={[
   {
     "name": "created_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was created.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "deleted_at",
     "type": "``null`` \\| `Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was deleted.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "id",
     "type": "`string`",
-    "description": "",
+    "description": "The Sales Channel Stock Location's ID",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "location_id",
     "type": "`string`",
-    "description": "",
+    "description": "The ID of the Location Stock.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "sales_channel",
     "type": "[`SalesChannel`](SalesChannel.mdx)",
-    "description": "",
+    "description": "The details of the sales channel the location is associated with.",
     "optional": false,
     "defaultValue": "",
+    "expandable": true,
     "children": [
-      {
-        "name": "constructor",
-        "type": "() => [`SalesChannel`](SalesChannel.mdx)",
-        "description": "",
-        "optional": false,
-        "defaultValue": "",
-        "children": []
-      },
       {
         "name": "created_at",
         "type": "`Date`",
-        "description": "",
+        "description": "The date with timezone at which the resource was created.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "deleted_at",
         "type": "``null`` \\| `Date`",
-        "description": "",
+        "description": "The date with timezone at which the resource was deleted.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "description",
         "type": "``null`` \\| `string`",
-        "description": "",
+        "description": "The description of the sales channel.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "id",
         "type": "`string`",
-        "description": "",
+        "description": "The sales channel's ID",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "is_disabled",
         "type": "`boolean`",
-        "description": "",
+        "description": "Specify if the sales channel is enabled or disabled.",
         "optional": false,
-        "defaultValue": "",
+        "defaultValue": "false",
+        "expandable": false,
         "children": []
       },
       {
         "name": "locations",
         "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]",
-        "description": "",
+        "description": "The details of the stock locations related to the sales channel.",
         "optional": false,
         "defaultValue": "",
-        "children": [
-          {
-            "name": "constructor",
-            "type": "() => [`SalesChannelLocation`](SalesChannelLocation.mdx)",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "created_at",
-            "type": "`Date`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "deleted_at",
-            "type": "``null`` \\| `Date`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "id",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "location_id",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "sales_channel",
-            "type": "[`SalesChannel`](SalesChannel.mdx)",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "sales_channel_id",
-            "type": "`string`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "updated_at",
-            "type": "`Date`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          },
-          {
-            "name": "beforeInsert",
-            "type": "() => `void`",
-            "description": "",
-            "optional": false,
-            "defaultValue": "",
-            "children": []
-          }
-        ]
+        "expandable": true,
+        "children": []
       },
       {
         "name": "metadata",
         "type": "``null`` \\| Record<`string`, `unknown`\\>",
-        "description": "",
+        "description": "An optional key-value map with additional details",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "name",
         "type": "`string`",
-        "description": "",
+        "description": "The name of the sales channel.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       },
       {
         "name": "updated_at",
         "type": "`Date`",
-        "description": "",
-        "optional": false,
-        "defaultValue": "",
-        "children": []
-      },
-      {
-        "name": "beforeInsert",
-        "type": "() => `void`",
-        "description": "",
+        "description": "The date with timezone at which the resource was updated.",
         "optional": false,
         "defaultValue": "",
+        "expandable": false,
         "children": []
       }
     ]
@@ -214,17 +141,19 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
   {
     "name": "sales_channel_id",
     "type": "`string`",
-    "description": "",
+    "description": "The ID of the Sales Channel",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   },
   {
     "name": "updated_at",
     "type": "`Date`",
-    "description": "",
+    "description": "The date with timezone at which the resource was updated.",
     "optional": false,
     "defaultValue": "",
+    "expandable": false,
     "children": []
   }
 ]} />