docs: add TSDocs for 2045c77 (#15063)

Co-authored-by: shahednasser <[email protected]>

Author: shahednasser

packages/core/types/src/http/order/admin/payload.ts

@@ -122,6 +122,8 @@ export interface AdminRequestOrderTransfer {
   description?: string
   /**
    * Whether to update the order.email to the transferred customer email.
+   *
+   * @since 2.13.7
    */
   update_order_email?: boolean
 }

packages/core/types/src/http/order/store/payloads.ts

@@ -1,18 +1,35 @@
+/**
+ * The details to request an order transfer.
+ */
 export interface StoreRequestOrderTransfer {
   /**
    * The description of the transfer request.
    */
   description?: string
   /**
    * Whether to update the order.email to the transferred customer email.
+   *
+   * @since 2.13.7
    */
   update_order_email?: boolean
 }
 
+/**
+ * The details to accept an order transfer.
+ */
 export interface StoreAcceptOrderTransfer {
+  /**
+   * The transfer token received in the email notification.
+   */
   token: string
 }
 
+/**
+ * The details to decline an order transfer.
+ */
 export interface StoreDeclineOrderTransfer {
+  /**
+   * The transfer token received in the email notification.
+   */
   token: string
 }

packages/core/types/src/workflow/order/request-transfer.ts

@@ -1,3 +1,6 @@
+/**
+ * The input to the request order transfer workflow.
+ */
 export interface RequestOrderTransferWorkflowInput {
   /**
    * The ID of the order to transfer.
@@ -23,6 +26,8 @@ export interface RequestOrderTransferWorkflowInput {
   internal_note?: string
   /**
    * Whether to update the order.email to the transferred customer email.
+   *
+   * @since 2.13.7
    */
   update_order_email?: boolean
 }

packages/medusa/src/api/admin/orders/[id]/transfer/route.ts

@@ -9,6 +9,9 @@ import {
   remoteQueryObjectFromString,
 } from "@medusajs/framework/utils"
 
+/**
+ * Request a transfer of an order to a customer.
+ */
 export const POST = async (
   req: AuthenticatedMedusaRequest<
     HttpTypes.AdminRequestOrderTransfer,