docs: generate references manually for 2.4.0 (#11171)

medusajs · Jan 27, 2025 · 4ccb489 · 4ccb489
1 parent 65d8d6d
commit 4ccb489
Show file tree

Hide file tree

Showing 444 changed files with 166,262 additions and 174,395 deletions.
diff --git a/www/apps/resources/generated/edit-dates.mjs b/www/apps/resources/generated/edit-dates.mjs
diff --git a/www/apps/resources/generated/files-map.mjs b/www/apps/resources/generated/files-map.mjs
diff --git a/www/apps/resources/generated/sidebar.mjs b/www/apps/resources/generated/sidebar.mjs
@@ -8025,7 +8025,7 @@ export const generatedSidebar = [
                     "type": "category",
                     "title": "Data Models",
                     "hasTitleStyling": true,
-                    "autogenerate_path": "/references/order_models/classes",
+                    "autogenerate_path": "/references/order_models/variables",
                     "children": [
                       {
                         "loaded": true,
@@ -8992,6 +8992,15 @@ export const generatedSidebar = [
                         "description": "",
                         "children": []
                       },
+                      {
+                        "loaded": true,
+                        "isPathHref": true,
+                        "type": "link",
+                        "path": "/references/payment/listAndCountPaymentMethods",
+                        "title": "listAndCountPaymentMethods",
+                        "description": "",
+                        "children": []
+                      },
                       {
                         "loaded": true,
                         "isPathHref": true,
@@ -9019,6 +9028,15 @@ export const generatedSidebar = [
                         "description": "",
                         "children": []
                       },
+                      {
+                        "loaded": true,
+                        "isPathHref": true,
+                        "type": "link",
+                        "path": "/references/payment/listPaymentMethods",
+                        "title": "listPaymentMethods",
+                        "description": "",
+                        "children": []
+                      },
                       {
                         "loaded": true,
                         "isPathHref": true,
@@ -21028,15 +21046,6 @@ export const generatedSidebar = [
                     "description": "",
                     "children": []
                   },
-                  {
-                    "loaded": true,
-                    "isPathHref": true,
-                    "type": "link",
-                    "path": "/references/medusa-workflows/steps/updateOrderExchangesStep",
-                    "title": "updateOrderExchangesStep",
-                    "description": "",
-                    "children": []
-                  },
                   {
                     "loaded": true,
                     "isPathHref": true,

diff --git a/www/apps/resources/generated/slug-changes.mjs b/www/apps/resources/generated/slug-changes.mjs
@@ -1524,11 +1524,6 @@ export const slugChanges = [
     "newSlug": "/references/medusa-workflows/steps/updateOrderChangesStep",
     "filePath": "/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderChangesStep/page.mdx"
   },
-  {
-    "origSlug": "/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderExchangesStep",
-    "newSlug": "/references/medusa-workflows/steps/updateOrderExchangesStep",
-    "filePath": "/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderExchangesStep/page.mdx"
-  },
   {
     "origSlug": "/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderShippingMethodsStep",
     "newSlug": "/references/medusa-workflows/steps/updateOrderShippingMethodsStep",
@@ -5430,119 +5425,119 @@ export const slugChanges = [
     "filePath": "/www/apps/resources/references/order/interfaces/order.IOrderModuleService/page.mdx"
   },
   {
-    "origSlug": "/references/order_models/classes/order_models.Order",
+    "origSlug": "/references/order_models/variables/order_models.Order",
     "newSlug": "/references/order/models/Order",
-    "filePath": "/www/apps/resources/references/order_models/classes/order_models.Order/page.mdx"
+    "filePath": "/www/apps/resources/references/order_models/variables/order_models.Order/page.mdx"
   },
   {
-    "origSlug": "/references/order_models/classes/order_models.OrderAddress",
+    "origSlug": "/references/order_models/variables/order_models.OrderAddress",
     "newSlug": "/references/order/models/OrderAddress",
-    "filePath": "/www/apps/resources/references/order_models/classes/order_models.OrderAddress/page.mdx"
+    "filePath": "/www/apps/resources/references/order_models/variables/order_models.OrderAddress/page.mdx"
   },
   {
-    "origSlug": "/references/order_models/classes/order_models.OrderChange",
+    "origSlug": "/references/order_models/variables/order_models.OrderChange",
     "newSlug": "/references/order/models/OrderChange",
-    "filePath": "/www/apps/resources/references/order_models/classes/order_models.OrderChange/page.mdx"
+    "filePath": "/www/apps/resources/references/order_models/variables/order_models.OrderChange/page.mdx"
   },
   {
-    "origSlug": "/references/order_models/classes/order_models.OrderChangeAction",
+    "origSlug": "/references/order_models/variables/order_models.OrderChangeAction",
     "newSlug": "/references/order/models/OrderChangeAction",
-    "filePath": "/www/apps/resources/references/order_models/classes/order_models.OrderChangeAction/page.mdx"
+    "filePath": "/www/apps/resources/references/order_models/variables/order_models.OrderChangeAction/page.mdx"
   },
   {
-    "origSlug": "/references/order_models/classes/order_models.OrderClaim",
+    "origSlug": "/references/order_models/variables/order_models.OrderClaim",
     "newSlug": "/references/order/models/OrderClaim",
-    "filePath": "/www/apps/resources/references/order_models/classes/order_models.OrderClaim/page.mdx"
+    "filePath": "/www/apps/resources/references/order_models/variables/order_models.OrderClaim/page.mdx"
   },
   {
-    "origSlug": "/references/order_models/classes/order_models.OrderClaimItem",
+    "origSlug": "/references/order_models/variables/order_models.OrderClaimItem",
     "newSlug": "/references/order/models/OrderClaimItem",
-    "filePath": "/www/apps/resources/references/order_models/classes/order_models.OrderClaimItem/page.mdx"
+    "filePath": "/www/apps/resources/references/order_models/variables/order_models.OrderClaimItem/page.mdx"
   },
   {
-    "origSlug": "/references/order_models/classes/order_models.OrderClaimItemImage",
+    "origSlug": "/references/order_models/variables/order_models.OrderClaimItemImage",
     "newSlug": "/references/order/models/OrderClaimItemImage",
-    "filePath": "/www/apps/resources/references/order_models/classes/order_models.OrderClaimItemImage/page.mdx"
+    "filePath": "/www/apps/resources/references/order_models/variables/order_models.OrderClaimItemImage/page.mdx"
   },
   {
-    "origSlug": "/references/order_models/classes/order_models.OrderCreditLine",
+    "origSlug": "/references/order_models/variables/order_models.OrderCreditLine",
     "newSlug": "/references/order/models/OrderCreditLine",
-    "filePath": "/www/apps/resources/references/order_models/classes/order_models.OrderCreditLine/page.mdx"
+    "filePath": "/www/apps/resources/references/order_models/variables/order_models.OrderCreditLine/page.mdx"
   },
   {
-    "origSlug": "/references/order_models/classes/order_models.OrderExchange",
+    "origSlug": "/references/order_models/variables/order_models.OrderExchange",
     "newSlug": "/references/order/models/OrderExchange",
-    "filePath": "/www/apps/resources/references/order_models/classes/order_models.OrderExchange/page.mdx"
+    "filePath": "/www/apps/resources/references/order_models/variables/order_models.OrderExchange/page.mdx"
   },
   {
-    "origSlug": "/references/order_models/classes/order_models.OrderExchangeItem",
+    "origSlug": "/references/order_models/variables/order_models.OrderExchangeItem",
     "newSlug": "/references/order/models/OrderExchangeItem",
-    "filePath": "/www/apps/resources/references/order_models/classes/order_models.OrderExchangeItem/page.mdx"
+    "filePath": "/www/apps/resources/references/order_models/variables/order_models.OrderExchangeItem/page.mdx"
   },
   {
-    "origSlug": "/references/order_models/classes/order_models.OrderItem",
+    "origSlug": "/references/order_models/variables/order_models.OrderItem",
     "newSlug": "/references/order/models/OrderItem",
-    "filePath": "/www/apps/resources/references/order_models/classes/order_models.OrderItem/page.mdx"
+    "filePath": "/www/apps/resources/references/order_models/variables/order_models.OrderItem/page.mdx"
   },
   {
-    "origSlug": "/references/order_models/classes/order_models.OrderLineItem",
+    "origSlug": "/references/order_models/variables/order_models.OrderLineItem",
     "newSlug": "/references/order/models/OrderLineItem",
-    "filePath": "/www/apps/resources/references/order_models/classes/order_models.OrderLineItem/page.mdx"
+    "filePath": "/www/apps/resources/references/order_models/variables/order_models.OrderLineItem/page.mdx"
   },
   {
-    "origSlug": "/references/order_models/classes/order_models.OrderLineItemAdjustment",
+    "origSlug": "/references/order_models/variables/order_models.OrderLineItemAdjustment",
     "newSlug": "/references/order/models/OrderLineItemAdjustment",
-    "filePath": "/www/apps/resources/references/order_models/classes/order_models.OrderLineItemAdjustment/page.mdx"
+    "filePath": "/www/apps/resources/references/order_models/variables/order_models.OrderLineItemAdjustment/page.mdx"
   },
   {
-    "origSlug": "/references/order_models/classes/order_models.OrderLineItemTaxLine",
+    "origSlug": "/references/order_models/variables/order_models.OrderLineItemTaxLine",
     "newSlug": "/references/order/models/OrderLineItemTaxLine",
-    "filePath": "/www/apps/resources/references/order_models/classes/order_models.OrderLineItemTaxLine/page.mdx"
+    "filePath": "/www/apps/resources/references/order_models/variables/order_models.OrderLineItemTaxLine/page.mdx"
   },
   {
-    "origSlug": "/references/order_models/classes/order_models.OrderShipping",
+    "origSlug": "/references/order_models/variables/order_models.OrderShipping",
     "newSlug": "/references/order/models/OrderShipping",
-    "filePath": "/www/apps/resources/references/order_models/classes/order_models.OrderShipping/page.mdx"
+    "filePath": "/www/apps/resources/references/order_models/variables/order_models.OrderShipping/page.mdx"
   },
   {
-    "origSlug": "/references/order_models/classes/order_models.OrderShippingMethod",
+    "origSlug": "/references/order_models/variables/order_models.OrderShippingMethod",
     "newSlug": "/references/order/models/OrderShippingMethod",
-    "filePath": "/www/apps/resources/references/order_models/classes/order_models.OrderShippingMethod/page.mdx"
+    "filePath": "/www/apps/resources/references/order_models/variables/order_models.OrderShippingMethod/page.mdx"
   },
   {
-    "origSlug": "/references/order_models/classes/order_models.OrderShippingMethodAdjustment",
+    "origSlug": "/references/order_models/variables/order_models.OrderShippingMethodAdjustment",
     "newSlug": "/references/order/models/OrderShippingMethodAdjustment",
-    "filePath": "/www/apps/resources/references/order_models/classes/order_models.OrderShippingMethodAdjustment/page.mdx"
+    "filePath": "/www/apps/resources/references/order_models/variables/order_models.OrderShippingMethodAdjustment/page.mdx"
   },
   {
-    "origSlug": "/references/order_models/classes/order_models.OrderShippingMethodTaxLine",
+    "origSlug": "/references/order_models/variables/order_models.OrderShippingMethodTaxLine",
     "newSlug": "/references/order/models/OrderShippingMethodTaxLine",
-    "filePath": "/www/apps/resources/references/order_models/classes/order_models.OrderShippingMethodTaxLine/page.mdx"
+    "filePath": "/www/apps/resources/references/order_models/variables/order_models.OrderShippingMethodTaxLine/page.mdx"
   },
   {
-    "origSlug": "/references/order_models/classes/order_models.OrderSummary",
+    "origSlug": "/references/order_models/variables/order_models.OrderSummary",
     "newSlug": "/references/order/models/OrderSummary",
-    "filePath": "/www/apps/resources/references/order_models/classes/order_models.OrderSummary/page.mdx"
+    "filePath": "/www/apps/resources/references/order_models/variables/order_models.OrderSummary/page.mdx"
   },
   {
-    "origSlug": "/references/order_models/classes/order_models.OrderTransaction",
+    "origSlug": "/references/order_models/variables/order_models.OrderTransaction",
     "newSlug": "/references/order/models/OrderTransaction",
-    "filePath": "/www/apps/resources/references/order_models/classes/order_models.OrderTransaction/page.mdx"
+    "filePath": "/www/apps/resources/references/order_models/variables/order_models.OrderTransaction/page.mdx"
   },
   {
-    "origSlug": "/references/order_models/classes/order_models.Return",
+    "origSlug": "/references/order_models/variables/order_models.Return",
     "newSlug": "/references/order/models/Return",
-    "filePath": "/www/apps/resources/references/order_models/classes/order_models.Return/page.mdx"
+    "filePath": "/www/apps/resources/references/order_models/variables/order_models.Return/page.mdx"
   },
   {
-    "origSlug": "/references/order_models/classes/order_models.ReturnItem",
+    "origSlug": "/references/order_models/variables/order_models.ReturnItem",
     "newSlug": "/references/order/models/ReturnItem",
-    "filePath": "/www/apps/resources/references/order_models/classes/order_models.ReturnItem/page.mdx"
+    "filePath": "/www/apps/resources/references/order_models/variables/order_models.ReturnItem/page.mdx"
   },
   {
-    "origSlug": "/references/order_models/classes/order_models.ReturnReason",
+    "origSlug": "/references/order_models/variables/order_models.ReturnReason",
     "newSlug": "/references/order/models/ReturnReason",
-    "filePath": "/www/apps/resources/references/order_models/classes/order_models.ReturnReason/page.mdx"
+    "filePath": "/www/apps/resources/references/order_models/variables/order_models.ReturnReason/page.mdx"
   },
   {
     "origSlug": "/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.authorizePaymentSession",
@@ -5604,6 +5599,11 @@ export const slugChanges = [
     "newSlug": "/references/payment/listAndCountPaymentCollections",
     "filePath": "/www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listAndCountPaymentCollections/page.mdx"
   },
+  {
+    "origSlug": "/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listAndCountPaymentMethods",
+    "newSlug": "/references/payment/listAndCountPaymentMethods",
+    "filePath": "/www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listAndCountPaymentMethods/page.mdx"
+  },
   {
     "origSlug": "/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listAndCountPaymentProviders",
     "newSlug": "/references/payment/listAndCountPaymentProviders",
@@ -5619,6 +5619,11 @@ export const slugChanges = [
     "newSlug": "/references/payment/listPaymentCollections",
     "filePath": "/www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listPaymentCollections/page.mdx"
   },
+  {
+    "origSlug": "/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listPaymentMethods",
+    "newSlug": "/references/payment/listPaymentMethods",
+    "filePath": "/www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listPaymentMethods/page.mdx"
+  },
   {
     "origSlug": "/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listPaymentProviders",
     "newSlug": "/references/payment/listPaymentProviders",

diff --git a/...y/functions/core_flows.Api_Key.Workflows_Api_Key.createApiKeysWorkflow/page.mdx b/...y/functions/core_flows.Api_Key.Workflows_Api_Key.createApiKeysWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow creates one or more API keys, which can be secret or publishable.
 You can use this workflow within your customizations or your own custom workflows, allowing you to
 create API keys within your custom flows.
 
-<SourceCodeLink link="https://github.com/medusajs/medusa/blob/644c8b9d3022fb4bc4ec6760ee4fed93b92d1b96/packages/core/core-flows/src/api-key/workflows/create-api-keys.ts#L50" />
+<SourceCodeLink link="https://github.com/medusajs/medusa/blob/43aa993971718063bb40e7e3f650ef0e84056d09/packages/core/core-flows/src/api-key/workflows/create-api-keys.ts#L50" />
 
 ## Examples
 

diff --git a/...y/functions/core_flows.Api_Key.Workflows_Api_Key.deleteApiKeysWorkflow/page.mdx b/...y/functions/core_flows.Api_Key.Workflows_Api_Key.deleteApiKeysWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow deletes one or more secret or publishable API keys. It's used by t
 You can use this workflow within your customizations or your own custom workflows, allowing you to
 delete API keys within your custom flows.
 
-<SourceCodeLink link="https://github.com/medusajs/medusa/blob/644c8b9d3022fb4bc4ec6760ee4fed93b92d1b96/packages/core/core-flows/src/api-key/workflows/delete-api-keys.ts#L36" />
+<SourceCodeLink link="https://github.com/medusajs/medusa/blob/43aa993971718063bb40e7e3f650ef0e84056d09/packages/core/core-flows/src/api-key/workflows/delete-api-keys.ts#L36" />
 
 ## Examples
 

diff --git a/...core_flows.Api_Key.Workflows_Api_Key.linkSalesChannelsToApiKeyWorkflow/page.mdx b/...core_flows.Api_Key.Workflows_Api_Key.linkSalesChannelsToApiKeyWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow manages the sales channels of a publishable API key. It's used by
 You can use this workflow within your customizations or your own custom workflows, allowing you to
 manage the sales channels of a publishable API key within your custom flows.
 
-<SourceCodeLink link="https://github.com/medusajs/medusa/blob/644c8b9d3022fb4bc4ec6760ee4fed93b92d1b96/packages/core/core-flows/src/api-key/workflows/link-sales-channels-to-publishable-key.ts#L39" />
+<SourceCodeLink link="https://github.com/medusajs/medusa/blob/43aa993971718063bb40e7e3f650ef0e84056d09/packages/core/core-flows/src/api-key/workflows/link-sales-channels-to-publishable-key.ts#L39" />
 
 ## Examples
 

diff --git a/...y/functions/core_flows.Api_Key.Workflows_Api_Key.revokeApiKeysWorkflow/page.mdx b/...y/functions/core_flows.Api_Key.Workflows_Api_Key.revokeApiKeysWorkflow/page.mdx
@@ -21,7 +21,7 @@ This workflow is used by the [Revoke API Key API Route](https://docs.medusajs.co
 You can use this workflow within your customizations or your own custom workflows, allowing you to
 revoke API keys within your custom flows.
 
-<SourceCodeLink link="https://github.com/medusajs/medusa/blob/644c8b9d3022fb4bc4ec6760ee4fed93b92d1b96/packages/core/core-flows/src/api-key/workflows/revoke-api-keys.ts#L59" />
+<SourceCodeLink link="https://github.com/medusajs/medusa/blob/43aa993971718063bb40e7e3f650ef0e84056d09/packages/core/core-flows/src/api-key/workflows/revoke-api-keys.ts#L59" />
 
 ## Examples
 

diff --git a/...y/functions/core_flows.Api_Key.Workflows_Api_Key.updateApiKeysWorkflow/page.mdx b/...y/functions/core_flows.Api_Key.Workflows_Api_Key.updateApiKeysWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow updates one or more secret or publishable API keys. It's used by t
 You can use this workflow within your customizations or your own custom workflows, allowing you to
 update API keys within your custom flows.
 
-<SourceCodeLink link="https://github.com/medusajs/medusa/blob/644c8b9d3022fb4bc4ec6760ee4fed93b92d1b96/packages/core/core-flows/src/api-key/workflows/update-api-keys.ts#L57" />
+<SourceCodeLink link="https://github.com/medusajs/medusa/blob/43aa993971718063bb40e7e3f650ef0e84056d09/packages/core/core-flows/src/api-key/workflows/update-api-keys.ts#L57" />
 
 ## Examples
 

diff --git a/...ions/core_flows.Auth.Workflows_Auth.generateResetPasswordTokenWorkflow/page.mdx b/...ions/core_flows.Auth.Workflows_Auth.generateResetPasswordTokenWorkflow/page.mdx
@@ -27,7 +27,7 @@ how to handle this event.
 You can use this workflow within your customizations or your own custom workflows, allowing you to
 generate reset password tokens within your custom flows.
 
-<SourceCodeLink link="https://github.com/medusajs/medusa/blob/644c8b9d3022fb4bc4ec6760ee4fed93b92d1b96/packages/core/core-flows/src/auth/workflows/generate-reset-password-token.ts#L42" />
+<SourceCodeLink link="https://github.com/medusajs/medusa/blob/43aa993971718063bb40e7e3f650ef0e84056d09/packages/core/core-flows/src/auth/workflows/generate-reset-password-token.ts#L42" />
 
 ## Examples
 

diff --git a/...s/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.createCartsStep/page.mdx b/...s/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.createCartsStep/page.mdx
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
   "my-workflow",
   () => {
     const data = createCartsStep({
-      "currency_code": "ern"
+      "currency_code": "amd"
     })
   }
 )

diff --git a/.../Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.retrieveCartStep/page.mdx b/.../Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.retrieveCartStep/page.mdx
@@ -19,7 +19,7 @@ const myWorkflow = createWorkflow(
   "my-workflow",
   () => {
     const data = retrieveCartStep({
-      "id": "id_5ovmeV8ouvcx"
+      "id": "id_JoP04UIUiedm"
     })
   }
 )

diff --git a/...eps_Cart/functions/core_flows.Cart.Steps_Cart.updateCartPromotionsStep/page.mdx b/...eps_Cart/functions/core_flows.Cart.Steps_Cart.updateCartPromotionsStep/page.mdx
@@ -24,7 +24,7 @@ const myWorkflow = createWorkflow(
   "my-workflow",
   () => {
     const data = updateCartPromotionsStep({
-      "id": "id_elQzW545tuW"
+      "id": "id_8BGQA3wZC0ZPxo3A"
     })
   }
 )