feat: add returns admin endpoints to medusa-js (#935)

* add: returns admin endpoint to medusa-js

* fix: http verbs

* fix duplicate import

* fix: type for cancel

* fix: conflicting import

Co-authored-by: Sebastian Rindom <seb@medusajs.com>

packages/medusa-js/src/resources/admin/index.ts

@@ -7,6 +7,7 @@ import AdminDraftOrdersResource from "./draft-orders"
 import AdminGiftCardsResource from "./gift-cards"
 import AdminInvitesResource from "./invites"
 import AdminNotesResource from "./notes"
+import AdminReturnsResource from "./returns"
 import AdminOrdersResource from "./orders"
 import AdminReturnReasonsResource from "./return-reasons"
 import AdminVariantsResource from "./variants"
@@ -24,6 +25,7 @@ class Admin extends BaseResource {
   public giftCards = new AdminGiftCardsResource(this.client)
   public invites = new AdminInvitesResource(this.client)
   public notes = new AdminNotesResource(this.client)
+  public returns = new AdminReturnsResource(this.client)
   public orders = new AdminOrdersResource(this.client)
   public returnReasons = new AdminReturnReasonsResource(this.client)
   public variants = new AdminVariantsResource(this.client)

packages/medusa-js/src/resources/admin/returns.ts

@@ -0,0 +1,50 @@
+import {
+  AdminGetReturnsParams,
+  AdminReturnsCancelRes,
+  AdminReturnsListRes,
+  AdminReturnsRes,
+} from "@medusajs/medusa"
+import { ResponsePromise } from "../../typings"
+import BaseResource from "../base"
+
+class AdminReturnsResource extends BaseResource {
+  /**
+   * @description cancels a return
+   * @param id id of return to cancel
+   * @returns the order for which the return was canceled
+   */
+  cancel(id: string): ResponsePromise<AdminReturnsCancelRes> {
+    const path = `/admin/returns/${id}/cancel`
+    return this.client.request("POST", path)
+  }
+
+  /**
+   * @description receive a return
+   * @param id id of the return to receive.
+   * @returns the return
+   */
+  receive(id: string): ResponsePromise<AdminReturnsRes> {
+    const path = `/admin/returns/${id}/receive`
+    return this.client.request("POST", path)
+  }
+
+  /**
+   * @description lists returns matching a query
+   * @param query query for searching returns
+   * @returns a list of returns matching the query
+   */
+  list(query?: AdminGetReturnsParams): ResponsePromise<AdminReturnsListRes> {
+    let path = `/admin/returns/`
+
+    if (query) {
+      const queryString = Object.entries(query).map(([key, value]) => {
+        return typeof value !== "undefined" ? `${key}=${value}` : ""
+      })
+      path = `/admin/returns?${queryString.join("&")}`
+    }
+
+    return this.client.request("GET", path)
+  }
+}
+
+export default AdminReturnsResource

packages/medusa/src/api/index.js

@@ -31,6 +31,7 @@ export * from "./routes/admin/orders"
 export * from "./routes/admin/variants"
 export * from "./routes/admin/return-reasons"
 export * from "./routes/admin/swaps"
+export * from "./routes/admin/returns"
 export * from "./routes/admin/shipping-options"
 export * from "./routes/admin/regions"
 

packages/medusa/src/api/routes/admin/returns/receive-return.ts

@@ -94,7 +94,7 @@ export default async (req, res) => {
   res.status(200).json({ return: receivedReturn })
 }
 
-export class Item {
+class Item {
   @IsString()
   item_id: string