feat(oas): declare x-codegen on Admin routes - D to PRI (#3092)

### What

Declare `x-codegen` in OAS for Admin routes - D to PRI.

### Why

We are introducing a new `x-codegen` OpenApi extension, also known as _vendor extension_, in order to help with passing information down to code generators.

In our case, we wish to declare the `method` name that we would expect to call on a client. This mimics our current JS client package. 
E.g. `medusaClient.product.list` where `product` is the tag of the route and `list` is the x-codegen.method value.

We are also defining the name of a potential typed object for query parameters. OAS 3.0 does not allow to bundle query parameters under a single definition but it is not uncommon to see API clients handle all query parameters as a single typed object, like our JS client package. With x-codegen.queryParams, a code generator can create a named and typed object to bundle all query parameters for a given route. 
E.g. `medusaClient.customer.retrieve(id: string, queryParams: AdminGetCustomerParams)` 

### How

Declare `x-codegen` as an object with fields `method` and `queryParams` on all paths.

Match method and queryParams values with equivalent ones from our current JS client package.

### Test

* Ran OAS validator.
* Ran docs build script.

Expect no visible changes to the documentation.

packages/medusa/src/api/routes/admin/gift-cards/create-gift-card.ts

@@ -16,6 +16,8 @@ import { EntityManager } from "typeorm"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminPostGiftCardsReq"
+ * x-codegen:
+ *   method: create
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/gift-cards/delete-gift-card.ts

@@ -8,6 +8,8 @@ import { EntityManager } from "typeorm"
  * x-authenticated: true
  * parameters:
  *   - (path) id=* {string} The ID of the Gift Card to delete.
+ * x-codegen:
+ *   method: delete
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/gift-cards/get-gift-card.ts

@@ -8,6 +8,8 @@ import { defaultAdminGiftCardFields, defaultAdminGiftCardRelations } from "./"
  * x-authenticated: true
  * parameters:
  *   - (path) id=* {string} The ID of the Gift Card.
+ * x-codegen:
+ *   method: retrieve
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/gift-cards/list-gift-cards.ts

@@ -16,6 +16,9 @@ import { isDefined } from "medusa-core-utils"
  *   - (query) offset=0 {number} The number of items to skip before the results.
  *   - (query) limit=50 {number} Limit the number of items returned.
  *   - (query) q {string} a search term to search by code or display ID
+ * x-codegen:
+ *   method: list
+ *   queryParams: AdminGetGiftCardsParams
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/gift-cards/update-gift-card.ts

@@ -19,6 +19,8 @@ import { EntityManager } from "typeorm"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminPostGiftCardsGiftCardReq"
+ * x-codegen:
+ *   method: update
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/invites/accept-invite.ts

@@ -15,6 +15,8 @@ import { EntityManager } from "typeorm"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminPostInvitesInviteAcceptReq"
+ * x-codegen:
+ *   method: accept
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/invites/create-invite.ts

@@ -16,6 +16,8 @@ import { EntityManager } from "typeorm"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminPostInvitesReq"
+ * x-codegen:
+ *   method: create
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/invites/delete-invite.ts

@@ -9,6 +9,8 @@ import InviteService from "../../../../services/invite"
  * x-authenticated: true
  * parameters:
  *   - (path) invite_id=* {string} The ID of the Invite
+ * x-codegen:
+ *   method: delete
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/invites/list-invites.ts

@@ -6,6 +6,8 @@ import InviteService from "../../../../services/invite"
  * summary: "Lists Invites"
  * description: "Lists all Invites"
  * x-authenticated: true
+ * x-codegen:
+ *   method: list
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/invites/resend-invite.ts

@@ -9,6 +9,8 @@ import { EntityManager } from "typeorm"
  * x-authenticated: true
  * parameters:
  *   - (path) invite_id=* {string} The ID of the Invite
+ * x-codegen:
+ *   method: resend
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/notes/create-note.ts

@@ -15,6 +15,8 @@ import { EntityManager } from "typeorm"
  *    application/json:
  *      schema:
  *        $ref: "#/components/schemas/AdminPostNotesReq"
+ * x-codegen:
+ *   method: create
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/notes/delete-note.ts

@@ -9,6 +9,8 @@ import NoteService from "../../../../services/note"
  * x-authenticated: true
  * parameters:
  *   - (path) id=* {string} The ID of the Note to delete.
+ * x-codegen:
+ *   method: delete
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/notes/get-note.ts

@@ -8,6 +8,8 @@ import NoteService from "../../../../services/note"
  * x-authenticated: true
  * parameters:
  *   - (path) id=* {string} The ID of the note to retrieve.
+ * x-codegen:
+ *   method: retrieve
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/notes/list-notes.ts

@@ -15,6 +15,9 @@ import { validator } from "../../../../utils/validator"
  *   - (query) limit=50 {number} The number of notes to get
  *   - (query) offset=0 {number} The offset at which to get notes
  *   - (query) resource_id {string} The ID which the notes belongs to
+ * x-codegen:
+ *   method: list
+ *   queryParams: AdminGetNotesParams
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/notes/update-note.ts

@@ -16,6 +16,8 @@ import { EntityManager } from "typeorm"
  *    application/json:
  *      schema:
  *        $ref: "#/components/schemas/AdminPostNotesNoteReq"
+ * x-codegen:
+ *   method: update
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/notifications/list-notifications.ts

@@ -27,6 +27,9 @@ import { validator } from "../../../../utils/validator"
  *   - (query) resource_id {string} The ID of the resource that the Notification refers to.
  *   - (query) to {string} The address that the Notification was sent to. This will usually be an email address, but represent other addresses such as a chat bot user id
  *   - (query) include_resends {string} A boolean indicating whether the result set should include resent notifications or not
+ * x-codegen:
+ *   method: list
+ *   queryParams: AdminGetNotificationsParams
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/notifications/resend-notification.ts

@@ -22,6 +22,8 @@ import { validator } from "../../../../utils/validator"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminPostNotificationsNotificationResendReq"
+ * x-codegen:
+ *   method: resend
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/order-edits/add-line-item.ts

@@ -21,6 +21,8 @@ import {
  *       schema:
  *         $ref: "#/components/schemas/AdminPostOrderEditsEditLineItemsReq"
  * x-authenticated: true
+ * x-codegen:
+ *   method: addLineItem
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/order-edits/cancel-order-edit.ts

@@ -14,6 +14,8 @@ import {
  * x-authenticated: true
  * parameters:
  *   - (path) id=* {string} The ID of the OrderEdit.
+ * x-codegen:
+ *   method: cancel
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/order-edits/confirm-order-edit.ts

@@ -14,6 +14,8 @@ import {
  * x-authenticated: true
  * parameters:
  *   - (path) id=* {string} The ID of the order edit.
+ * x-codegen:
+ *   method: confirm
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/order-edits/create-order-edit.ts

@@ -18,6 +18,8 @@ import {
  *       schema:
  *         $ref: "#/components/schemas/AdminPostOrderEditsReq"
  * x-authenticated: true
+ * x-codegen:
+ *   method: create
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/order-edits/delete-line-item.ts

@@ -15,6 +15,8 @@ import {
  * parameters:
  *   - (path) id=* {string} The ID of the Order Edit to delete from.
  *   - (path) item_id=* {string} The ID of the order edit item to delete from order.
+ * x-codegen:
+ *   method: removeLineItem
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/order-edits/delete-order-edit-item-change.ts

@@ -10,6 +10,8 @@ import { OrderEditService } from "../../../../services"
  * parameters:
  *   - (path) id=* {string} The ID of the Order Edit to delete.
  *   - (path) change_id=* {string} The ID of the Order Edit Item Change to delete.
+ * x-codegen:
+ *   method: deleteItemChange
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/order-edits/delete-order-edit.ts

@@ -9,6 +9,8 @@ import { OrderEditService } from "../../../../services"
  * x-authenticated: true
  * parameters:
  *   - (path) id=* {string} The ID of the Order Edit to delete.
+ * x-codegen:
+ *   method: delete
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/order-edits/get-order-edit.ts

@@ -12,6 +12,9 @@ import { FindParams } from "../../../../types/common"
  *   - (path) id=* {string} The ID of the OrderEdit.
  *   - (query) expand {string} Comma separated list of relations to include in the results.
  *   - (query) fields {string} Comma separated list of fields to include in the results.
+ * x-codegen:
+ *   method: retrieve
+ *   queryParams: GetOrderEditsOrderEditParams
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/order-edits/list-order-edit.ts

@@ -16,6 +16,9 @@ import { IsOptional, IsString } from "class-validator"
  *   - (query) offset=0 {number} The offset of items in response
  *   - (query) expand {string} Comma separated list of relations to include in the results.
  *   - (query) fields {string} Comma separated list of fields to include in the results.
+ * x-codegen:
+ *   method: list
+ *   queryParams: GetOrderEditsParams
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/order-edits/request-confirmation.ts

@@ -19,6 +19,8 @@ import {
  * x-authenticated: true
  * parameters:
  *   - (path) id=* {string} The ID of the Order Edit to request confirmation from.
+ * x-codegen:
+ *   method: requestConfirmation
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/order-edits/update-order-edit-line-item.ts

@@ -21,6 +21,8 @@ import {
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminPostOrderEditsEditLineItemsLineItemReq"
+ * x-codegen:
+ *   method: updateLineItem
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/order-edits/update-order-edit.ts

@@ -21,6 +21,8 @@ import {
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminPostOrderEditsOrderEditReq"
+ * x-codegen:
+ *   method: update
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/orders/add-shipping-method.ts

@@ -16,12 +16,16 @@ import { EntityManager } from "typeorm"
  * operationId: "PostOrdersOrderShippingMethods"
  * summary: "Add a Shipping Method"
  * description: "Adds a Shipping Method to an Order. If another Shipping Method exists with the same Shipping Profile, the previous Shipping Method will be replaced."
- * x-authenticated: true
  * parameters:
  *   - (path) id=* {string} The ID of the Order.
- *   - (body) price=* {integer} The price (excluding VAT) that should be charged for the Shipping Method
- *   - (body) option_id=* {string} The ID of the Shipping Option to create the Shipping Method from.
- *   - (body) data {object} The data required for the Shipping Option to create a Shipping Method. This will depend on the Fulfillment Provider.
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/AdminPostOrdersOrderShippingMethodsReq"
+ * x-authenticated: true
+ * x-codegen:
+ *   method: addShippingMethod
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client
@@ -98,6 +102,23 @@ export default async (req, res) => {
   res.status(200).json({ order })
 }
 
+/**
+ * @schema AdminPostOrdersOrderShippingMethodsReq
+ * type: object
+ * required:
+ *   - price
+ *   - option_id
+ * properties:
+ *   price:
+ *     type: number
+ *     description: The price (excluding VAT) that should be charged for the Shipping Method
+ *   option_id:
+ *     type: string
+ *     description: The ID of the Shipping Option to create the Shipping Method from.
+ *   date:
+ *     type: object
+ *     description: The data required for the Shipping Option to create a Shipping Method. This will depend on the Fulfillment Provider.
+ */
 export class AdminPostOrdersOrderShippingMethodsReq {
   @IsInt()
   @IsNotEmpty()

packages/medusa/src/api/routes/admin/orders/archive-order.ts

@@ -9,6 +9,8 @@ import { EntityManager } from "typeorm"
  * x-authenticated: true
  * parameters:
  *   - (path) id=* {string} The ID of the Order.
+ * x-codegen:
+ *   method: archive
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/orders/cancel-claim.ts

@@ -13,6 +13,8 @@ import { MedusaError } from "medusa-core-utils"
  * parameters:
  *   - (path) id=* {string} The ID of the Order.
  *   - (path) claim_id=* {string} The ID of the Claim.
+ * x-codegen:
+ *   method: cancelClaim
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-claim.ts

@@ -18,6 +18,8 @@ import { MedusaError } from "medusa-core-utils"
  *   - (path) id=* {string} The ID of the Order which the Claim relates to.
  *   - (path) claim_id=* {string} The ID of the Claim which the Fulfillment relates to.
  *   - (path) fulfillment_id=* {string} The ID of the Fulfillment.
+ * x-codegen:
+ *   method: cancelClaimFulfillment
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-swap.ts

@@ -18,6 +18,8 @@ import { MedusaError } from "medusa-core-utils"
  *   - (path) id=* {string} The ID of the Order which the Swap relates to.
  *   - (path) swap_id=* {string} The ID of the Swap which the Fulfillment relates to.
  *   - (path) fulfillment_id=* {string} The ID of the Fulfillment.
+ * x-codegen:
+ *   method: cancelSwapFulfillment
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/orders/cancel-fulfillment.ts

@@ -19,6 +19,8 @@ import { IInventoryService } from "../../../../interfaces"
  * parameters:
  *   - (path) id=* {string} The ID of the Order which the Fulfillment relates to.
  *   - (path) fulfillment_id=* {string} The ID of the Fulfillment
+ * x-codegen:
+ *   method: cancelFulfillment
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/orders/cancel-order.ts

@@ -11,6 +11,8 @@ import { EntityManager } from "typeorm"
  * x-authenticated: true
  * parameters:
  *   - (path) id=* {string} The ID of the Order.
+ * x-codegen:
+ *   method: cancel
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/orders/cancel-swap.ts

@@ -13,6 +13,8 @@ import { MedusaError } from "medusa-core-utils"
  * parameters:
  *   - (path) id=* {string} The ID of the Order.
  *   - (path) swap_id=* {string} The ID of the Swap.
+ * x-codegen:
+ *   method: cancelSwap
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/orders/capture-payment.ts

@@ -11,6 +11,8 @@ import { EntityManager } from "typeorm"
  * x-authenticated: true
  * parameters:
  *   - (path) id=* {string} The ID of the Order.
+ * x-codegen:
+ *   method: capturePayment
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/orders/complete-order.ts

@@ -9,6 +9,8 @@ import { EntityManager } from "typeorm"
  * x-authenticated: true
  * parameters:
  *   - (path) id=* {string} The ID of the Order.
+ * x-codegen:
+ *   method: complete
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/orders/create-claim-shipment.ts

@@ -19,6 +19,8 @@ import { EntityManager } from "typeorm"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminPostOrdersOrderClaimsClaimShipmentsReq"
+ * x-codegen:
+ *   method: createClaimShipment
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/orders/create-claim.ts

@@ -32,6 +32,8 @@ import { validator } from "../../../../utils/validator"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminPostOrdersOrderClaimsReq"
+ * x-codegen:
+ *   method: createClaim
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts

@@ -33,6 +33,8 @@ import { Fulfillment, LineItem } from "../../../../models"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminPostOrdersOrderFulfillmentsReq"
+ * x-codegen:
+ *   method: createFulfillment
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/orders/create-shipment.ts

@@ -25,6 +25,8 @@ import { validator } from "../../../../utils/validator"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminPostOrdersOrderShipmentReq"
+ * x-codegen:
+ *   method: createShipment
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/orders/create-swap-shipment.ts

@@ -25,6 +25,8 @@ import { validator } from "../../../../utils/validator"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminPostOrdersOrderSwapsSwapShipmentsReq"
+ * x-codegen:
+ *   method: createSwapShipment
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/orders/create-swap.ts

@@ -36,6 +36,8 @@ import { validator } from "../../../../utils/validator"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminPostOrdersOrderSwapsReq"
+ * x-codegen:
+ *   method: createSwap
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/orders/fulfill-claim.ts

@@ -19,6 +19,8 @@ import { validator } from "../../../../utils/validator"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminPostOrdersOrderClaimsClaimFulfillmentsReq"
+ * x-codegen:
+ *   method: fulfillClaim
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts

@@ -19,6 +19,8 @@ import { validator } from "../../../../utils/validator"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminPostOrdersOrderSwapsSwapFulfillmentsReq"
+ * x-codegen:
+ *   method: fulfillSwap
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/orders/get-order.ts

@@ -1,4 +1,5 @@
 import { OrderService } from "../../../../services"
+import { FindParams } from "../../../../types/common"
 
 /**
  * @oas [get] /orders/{id}
@@ -8,6 +9,11 @@ import { OrderService } from "../../../../services"
  * x-authenticated: true
  * parameters:
  *   - (path) id=* {string} The ID of the Order.
+ *   - (query) expand {string} Comma separated list of relations to include in the results.
+ *   - (query) fields {string} Comma separated list of fields to include in the results.
+ * x-codegen:
+ *   method: retrieve
+ *   queryParams: AdminGetOrdersOrderParams
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client
@@ -58,3 +64,5 @@ export default async (req, res) => {
 
   res.json({ order })
 }
+
+export class AdminGetOrdersOrderParams extends FindParams {}

packages/medusa/src/api/routes/admin/orders/list-orders.ts

@@ -153,6 +153,9 @@ import { pick } from "lodash"
  *   - (query) limit=50 {integer} Limit the number of orders returned.
  *   - (query) expand {string} (Comma separated) Which fields should be expanded in each order of the result.
  *   - (query) fields {string} (Comma separated) Which fields should be included in each order of the result.
+ * x-codegen:
+ *   method: list
+ *   queryParams: AdminGetOrdersParams
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/orders/process-swap-payment.ts

@@ -12,6 +12,8 @@ import { EntityManager } from "typeorm"
  * parameters:
  *   - (path) id=* {string} The ID of the Order.
  *   - (path) swap_id=* {string} The ID of the Swap.
+ * x-codegen:
+ *   method: processSwapPayment
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/orders/refund-payment.ts

@@ -24,6 +24,8 @@ import { EntityManager } from "typeorm"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminPostOrdersOrderRefundsReq"
+ * x-codegen:
+ *   method: refundPayment
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/orders/request-return.ts

@@ -33,6 +33,8 @@ import { validator } from "../../../../utils/validator"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminPostOrdersOrderReturnsReq"
+ * x-codegen:
+ *   method: requestReturn
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/orders/update-claim.ts

@@ -29,6 +29,8 @@ import { EntityManager } from "typeorm"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminPostOrdersOrderClaimsClaimReq"
+ * x-codegen:
+ *   method: updateClaim
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/orders/update-order.ts

@@ -29,6 +29,8 @@ import { validator } from "../../../../utils/validator"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminPostOrdersOrderReq"
+ * x-codegen:
+ *   method: update
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/payment-collections/delete-payment-collection.ts

@@ -8,6 +8,8 @@ import { PaymentCollectionService } from "../../../../services"
  * x-authenticated: true
  * parameters:
  *   - (path) id=* {string} The ID of the Payment Collection to delete.
+ * x-codegen:
+ *   method: delete
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/payment-collections/get-payment-collection.ts

@@ -11,6 +11,9 @@ import { FindParams } from "../../../../types/common"
  *   - (path) id=* {string} The ID of the PaymentCollection.
  *   - (query) expand {string} Comma separated list of relations to include in the results.
  *   - (query) fields {string} Comma separated list of fields to include in the results.
+ * x-codegen:
+ *   method: retrieve
+ *   queryParams: GetPaymentCollectionsParams
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/payment-collections/mark-authorized-payment-collection.ts

@@ -9,6 +9,8 @@ import { PaymentCollectionService } from "../../../../services"
  * x-authenticated: true
  * parameters:
  *   - (path) id=* {string} The ID of the PaymentCollection.
+ * x-codegen:
+ *   method: markAsAuthorized
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/payment-collections/update-payment-collection.ts

@@ -16,6 +16,8 @@ import { PaymentCollectionService } from "../../../../services"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminUpdatePaymentCollectionsReq"
+ * x-codegen:
+ *   method: update
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/payments/capture-payment.ts

@@ -8,6 +8,8 @@ import { PaymentService } from "../../../../services"
  * x-authenticated: true
  * parameters:
  *   - (path) id=* {string} The ID of the Payment.
+ * x-codegen:
+ *   method: capturePayment
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/payments/get-payment.ts

@@ -9,6 +9,9 @@ import { FindParams } from "../../../../types/common"
  * x-authenticated: true
  * parameters:
  *   - (path) id=* {string} The ID of the Payment.
+ * x-codegen:
+ *   method: retrieve
+ *   queryParams: GetPaymentsParams
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/payments/refund-payment.ts

@@ -22,6 +22,8 @@ import { PaymentService } from "../../../../services"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminPostPaymentRefundsReq"
+ * x-codegen:
+ *   method: refundPayment
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/price-lists/add-prices-batch.ts

@@ -21,6 +21,8 @@ import { EntityManager } from "typeorm"
  *    application/json:
  *      schema:
  *        $ref: "#/components/schemas/AdminPostPriceListPricesPricesReq"
+ * x-codegen:
+ *   method: addPrices
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/price-lists/create-price-list.ts

@@ -31,6 +31,8 @@ import { FeatureFlagDecorators } from "../../../../utils/feature-flag-decorators
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminPostPriceListsPriceListReq"
+ * x-codegen:
+ *   method: create
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/price-lists/delete-price-list.ts

@@ -9,6 +9,8 @@ import PriceListService from "../../../../services/price-list"
  * x-authenticated: true
  * parameters:
  *   - (path) id=* {string} The ID of the Price List to delete.
+ * x-codegen:
+ *   method: delete
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/price-lists/delete-prices-batch.ts

@@ -17,6 +17,8 @@ import { validator } from "../../../../utils/validator"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminDeletePriceListPricesPricesReq"
+ * x-codegen:
+ *   method: deletePrices
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/price-lists/delete-product-prices.ts

@@ -10,6 +10,8 @@ import PriceListService from "../../../../services/price-list"
  * parameters:
  *   - (path) id=* {string} The ID of the Price List that the Money Amounts that will be deleted belongs to.
  *   - (path) product_id=* {string} The ID of the product from which the money amount will be deleted.
+ * x-codegen:
+ *   method: deleteProductPrices
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/price-lists/delete-variant-prices.ts

@@ -10,6 +10,8 @@ import PriceListService from "../../../../services/price-list"
  * parameters:
  *   - (path) id=* {string} The ID of the Price List that the Money Amounts that will be deleted belongs to.
  *   - (path) variant_id=* {string} The ID of the variant from which the money amount will be deleted.
+ * x-codegen:
+ *   method: deleteVariantPrices
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/price-lists/get-price-list.ts

@@ -11,6 +11,8 @@ import PriceListService from "../../../../services/price-list"
  * x-authenticated: true
  * parameters:
  *   - (path) id=* {string} The ID of the Price List.
+ * x-codegen:
+ *   method: retrieve
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/price-lists/list-price-list-products.ts

@@ -133,6 +133,9 @@ import { isDefined } from "medusa-core-utils"
  *   - (query) limit=50 {integer} Limit the number of products returned.
  *   - (query) expand {string} (Comma separated) Which fields should be expanded in each product of the result.
  *   - (query) fields {string} (Comma separated) Which fields should be included in each product of the result.
+ * x-codegen:
+ *   method: listProducts
+ *   queryParams: AdminGetPriceListsPriceListProductsParams
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/price-lists/list-price-lists.ts

@@ -114,6 +114,9 @@ import { Type } from "class-transformer"
  *            type: string
  *            description: filter by dates greater than or equal to this date
  *            format: date
+ * x-codegen:
+ *   method: list
+ *   queryParams: AdminGetPriceListPaginationParams
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/admin/price-lists/update-price-list.ts

@@ -34,6 +34,8 @@ import { validator } from "../../../../utils/validator"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/AdminPostPriceListsPriceListPriceListReq"
+ * x-codegen:
+ *   method: update
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client