diff --git a/.changeset/twelve-onions-tap.md b/.changeset/twelve-onions-tap.md new file mode 100644 index 0000000000..af2045933a --- /dev/null +++ b/.changeset/twelve-onions-tap.md @@ -0,0 +1,5 @@ +--- +"@medusajs/medusa": patch +--- + +feat(oas): declare x-codegen on Admin routes - PRO to R diff --git a/packages/medusa/src/api/routes/admin/product-categories/create-product-category.ts b/packages/medusa/src/api/routes/admin/product-categories/create-product-category.ts index 22048a68b8..f9596f86bb 100644 --- a/packages/medusa/src/api/routes/admin/product-categories/create-product-category.ts +++ b/packages/medusa/src/api/routes/admin/product-categories/create-product-category.ts @@ -1,4 +1,4 @@ -import { IsNotEmpty, IsOptional, IsString, IsBoolean } from "class-validator" +import { IsNotEmpty, IsString } from "class-validator" import { Request, Response } from "express" import { EntityManager } from "typeorm" @@ -13,13 +13,15 @@ import { FindParams } from "../../../../types/common" * description: "Creates a Product Category." * x-authenticated: true * parameters: - * - (query) expand {string} (Comma separated) Which fields should be expanded in each product category. - * - (query) fields {string} (Comma separated) Which fields should be retrieved in each product category. + * - (query) expand {string} (Comma separated) Which fields should be expanded in the results. + * - (query) fields {string} (Comma separated) Which fields should be retrieved in the results. * requestBody: * content: * application/json: * schema: * $ref: "#/components/schemas/AdminPostProductCategoriesReq" + * x-codegen: + * method: create * x-codeSamples: * - lang: Shell * label: cURL @@ -76,7 +78,7 @@ export default async (req: Request, res: Response) => { const productCategory = await productCategoryService.retrieve( created.id, - req.retrieveConfig, + req.retrieveConfig ) res.status(200).json({ product_category: productCategory }) diff --git a/packages/medusa/src/api/routes/admin/product-categories/delete-product-category.ts b/packages/medusa/src/api/routes/admin/product-categories/delete-product-category.ts index 3f0d5a9387..087a741daf 100644 --- a/packages/medusa/src/api/routes/admin/product-categories/delete-product-category.ts +++ b/packages/medusa/src/api/routes/admin/product-categories/delete-product-category.ts @@ -11,6 +11,8 @@ import { ProductCategoryService } from "../../../../services" * x-authenticated: true * parameters: * - (path) id=* {string} The ID of the Product Category + * x-codegen: + * method: delete * x-codeSamples: * - lang: Shell * label: cURL diff --git a/packages/medusa/src/api/routes/admin/product-categories/get-product-category.ts b/packages/medusa/src/api/routes/admin/product-categories/get-product-category.ts index 92fa17da4b..ca47b8d3c2 100644 --- a/packages/medusa/src/api/routes/admin/product-categories/get-product-category.ts +++ b/packages/medusa/src/api/routes/admin/product-categories/get-product-category.ts @@ -12,6 +12,11 @@ import { defaultAdminProductCategoryRelations } from "." * x-authenticated: true * parameters: * - (path) id=* {string} The ID of the Product Category + * - (query) expand {string} (Comma separated) Which fields should be expanded in the results. + * - (query) fields {string} (Comma separated) Which fields should be included in the results. + * x-codegen: + * method: retrieve + * queryParams: AdminGetProductCategoryParams * x-codeSamples: * - lang: Shell * label: cURL diff --git a/packages/medusa/src/api/routes/admin/product-categories/list-product-categories.ts b/packages/medusa/src/api/routes/admin/product-categories/list-product-categories.ts index 0de5719007..c48a10d0ad 100644 --- a/packages/medusa/src/api/routes/admin/product-categories/list-product-categories.ts +++ b/packages/medusa/src/api/routes/admin/product-categories/list-product-categories.ts @@ -1,6 +1,6 @@ -import { IsNumber, IsOptional, IsString } from "class-validator" +import { IsOptional, IsString } from "class-validator" import { Request, Response } from "express" -import { Type, Transform } from "class-transformer" +import { Transform } from "class-transformer" import { ProductCategoryService } from "../../../../services" import { extendedFindParamsMixin } from "../../../../types/common" @@ -20,6 +20,9 @@ import { extendedFindParamsMixin } from "../../../../types/common" * - (query) limit=100 {integer} Limit the number of product categories returned. * - (query) expand {string} (Comma separated) Which fields should be expanded in the product category. * - (query) fields {string} (Comma separated) Which fields should be included in the product category. + * x-codegen: + * method: list + * queryParams: AdminGetProductCategoriesParams * x-codeSamples: * - lang: Shell * label: cURL diff --git a/packages/medusa/src/api/routes/admin/product-categories/update-product-category.ts b/packages/medusa/src/api/routes/admin/product-categories/update-product-category.ts index b3218fb7ce..0199620e30 100644 --- a/packages/medusa/src/api/routes/admin/product-categories/update-product-category.ts +++ b/packages/medusa/src/api/routes/admin/product-categories/update-product-category.ts @@ -5,6 +5,7 @@ import { EntityManager } from "typeorm" import { ProductCategoryService } from "../../../../services" import { AdminProductCategoriesReqBase } from "../../../../types/product-category" import { FindParams } from "../../../../types/common" + /** * @oas [post] /product-categories/{id} * operationId: "PostProductCategoriesCategory" @@ -20,6 +21,9 @@ import { FindParams } from "../../../../types/common" * application/json: * schema: * $ref: "#/components/schemas/AdminPostProductCategoriesCategoryReq" + * x-codegen: + * method: update + * queryParams: AdminPostProductCategoriesCategoryParams * x-codeSamples: * - lang: Shell * label: cURL @@ -77,7 +81,7 @@ export default async (req: Request, res: Response) => { const productCategory = await productCategoryService.retrieve( updated.id, - req.retrieveConfig, + req.retrieveConfig ) res.status(200).json({ product_category: productCategory }) diff --git a/packages/medusa/src/api/routes/admin/product-tags/list-product-tags.ts b/packages/medusa/src/api/routes/admin/product-tags/list-product-tags.ts index 001e4c551a..0ffdb5bd63 100644 --- a/packages/medusa/src/api/routes/admin/product-tags/list-product-tags.ts +++ b/packages/medusa/src/api/routes/admin/product-tags/list-product-tags.ts @@ -83,6 +83,9 @@ import { Request, Response } from "express" * type: string * description: filter by dates greater than or equal to this date * format: date + * x-codegen: + * method: list + * queryParams: AdminGetProductTagsParams * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/product-types/list-product-types.ts b/packages/medusa/src/api/routes/admin/product-types/list-product-types.ts index 75e95f9f92..29f0120be6 100644 --- a/packages/medusa/src/api/routes/admin/product-types/list-product-types.ts +++ b/packages/medusa/src/api/routes/admin/product-types/list-product-types.ts @@ -82,6 +82,9 @@ import ProductTypeService from "../../../../services/product-type" * type: string * description: filter by dates greater than or equal to this date * format: date + * x-codegen: + * method: list + * queryParams: AdminGetProductTypesParams * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/products/add-option.ts b/packages/medusa/src/api/routes/admin/products/add-option.ts index 4389906b1c..d4e4d3ab5f 100644 --- a/packages/medusa/src/api/routes/admin/products/add-option.ts +++ b/packages/medusa/src/api/routes/admin/products/add-option.ts @@ -18,6 +18,8 @@ import { EntityManager } from "typeorm" * application/json: * schema: * $ref: "#/components/schemas/AdminPostProductsProductOptionsReq" + * x-codegen: + * method: addOption * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/products/create-product.ts b/packages/medusa/src/api/routes/admin/products/create-product.ts index dfb7bcce22..6d7c0a65ed 100644 --- a/packages/medusa/src/api/routes/admin/products/create-product.ts +++ b/packages/medusa/src/api/routes/admin/products/create-product.ts @@ -43,6 +43,8 @@ import { validator } from "../../../../utils/validator" * application/json: * schema: * $ref: "#/components/schemas/AdminPostProductsReq" + * x-codegen: + * method: create * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/products/create-variant.ts b/packages/medusa/src/api/routes/admin/products/create-variant.ts index 3468336101..099328f398 100644 --- a/packages/medusa/src/api/routes/admin/products/create-variant.ts +++ b/packages/medusa/src/api/routes/admin/products/create-variant.ts @@ -47,6 +47,8 @@ import { EntityManager } from "typeorm" * application/json: * schema: * $ref: "#/components/schemas/AdminPostProductsProductVariantsReq" + * x-codegen: + * method: createVariant * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/products/delete-option.ts b/packages/medusa/src/api/routes/admin/products/delete-option.ts index 633ba6c0d8..b989c4a55d 100644 --- a/packages/medusa/src/api/routes/admin/products/delete-option.ts +++ b/packages/medusa/src/api/routes/admin/products/delete-option.ts @@ -12,6 +12,8 @@ import { ProductService } from "../../../../services" * parameters: * - (path) id=* {string} The ID of the Product. * - (path) option_id=* {string} The ID of the Product Option. + * x-codegen: + * method: deleteOption * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/products/delete-product.ts b/packages/medusa/src/api/routes/admin/products/delete-product.ts index eb21d93fc2..2358cbcaf8 100644 --- a/packages/medusa/src/api/routes/admin/products/delete-product.ts +++ b/packages/medusa/src/api/routes/admin/products/delete-product.ts @@ -9,6 +9,8 @@ import { ProductService } from "../../../../services" * x-authenticated: true * parameters: * - (path) id=* {string} The ID of the Product. + * x-codegen: + * method: delete * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/products/delete-variant.ts b/packages/medusa/src/api/routes/admin/products/delete-variant.ts index 02f1ffcddb..0e6635f88c 100644 --- a/packages/medusa/src/api/routes/admin/products/delete-variant.ts +++ b/packages/medusa/src/api/routes/admin/products/delete-variant.ts @@ -16,6 +16,8 @@ import { EntityManager } from "typeorm" * parameters: * - (path) id=* {string} The ID of the Product. * - (path) variant_id=* {string} The ID of the Product Variant. + * x-codegen: + * method: deleteVariant * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/products/get-product.ts b/packages/medusa/src/api/routes/admin/products/get-product.ts index 063390f7c6..21eff65ae1 100644 --- a/packages/medusa/src/api/routes/admin/products/get-product.ts +++ b/packages/medusa/src/api/routes/admin/products/get-product.ts @@ -8,6 +8,8 @@ import { PricingService, ProductService } from "../../../../services" * x-authenticated: true * parameters: * - (path) id=* {string} The ID of the Product. + * x-codegen: + * method: retrieve * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/products/list-products.ts b/packages/medusa/src/api/routes/admin/products/list-products.ts index d6af66ebfa..8ab6b68f13 100644 --- a/packages/medusa/src/api/routes/admin/products/list-products.ts +++ b/packages/medusa/src/api/routes/admin/products/list-products.ts @@ -158,6 +158,9 @@ import { FilterableProductProps } from "../../../../types/product" * - (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. * - (query) order {string} the field used to order the products. + * x-codegen: + * method: list + * queryParams: AdminGetProductsParams * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/products/list-tag-usage-count.ts b/packages/medusa/src/api/routes/admin/products/list-tag-usage-count.ts index 6bc89ad209..0bc6aa9ce1 100644 --- a/packages/medusa/src/api/routes/admin/products/list-tag-usage-count.ts +++ b/packages/medusa/src/api/routes/admin/products/list-tag-usage-count.ts @@ -6,6 +6,8 @@ import { ProductService } from "../../../../services" * summary: "List Tags Usage Number" * description: "Retrieves a list of Product Tags with how many times each is used." * x-authenticated: true + * x-codegen: + * method: listTags * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/products/list-types.ts b/packages/medusa/src/api/routes/admin/products/list-types.ts index 6a1b4b0bca..9d99d4bf14 100644 --- a/packages/medusa/src/api/routes/admin/products/list-types.ts +++ b/packages/medusa/src/api/routes/admin/products/list-types.ts @@ -7,6 +7,8 @@ import { ProductService } from "../../../../services" * summary: "List Product Types" * description: "Retrieves a list of Product Types." * x-authenticated: true + * x-codegen: + * method: listTypes * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/products/list-variants.ts b/packages/medusa/src/api/routes/admin/products/list-variants.ts index e03aea2b3f..33d9ee1408 100644 --- a/packages/medusa/src/api/routes/admin/products/list-variants.ts +++ b/packages/medusa/src/api/routes/admin/products/list-variants.ts @@ -20,6 +20,9 @@ import { validator } from "../../../../utils/validator" * - (query) expand {string} Comma separated string of the relations to include. * - (query) offset=0 {integer} How many items to skip before the results. * - (query) limit=100 {integer} Limit the number of items returned. + * x-codegen: + * method: listVariants + * queryParams: AdminGetProductsVariantsParams * x-codeSamples: * - lang: Shell * label: cURL diff --git a/packages/medusa/src/api/routes/admin/products/set-metadata.ts b/packages/medusa/src/api/routes/admin/products/set-metadata.ts index 7585e29b37..4041165468 100644 --- a/packages/medusa/src/api/routes/admin/products/set-metadata.ts +++ b/packages/medusa/src/api/routes/admin/products/set-metadata.ts @@ -17,6 +17,8 @@ import { EntityManager } from "typeorm" * application/json: * schema: * $ref: "#/components/schemas/AdminPostProductsProductMetadataReq" + * x-codegen: + * method: setMetadata * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/products/update-option.ts b/packages/medusa/src/api/routes/admin/products/update-option.ts index b8ba7ceb82..467205ecf6 100644 --- a/packages/medusa/src/api/routes/admin/products/update-option.ts +++ b/packages/medusa/src/api/routes/admin/products/update-option.ts @@ -19,6 +19,8 @@ import { EntityManager } from "typeorm" * application/json: * schema: * $ref: "#/components/schemas/AdminPostProductsProductOptionsOption" + * x-codegen: + * method: updateOption * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/products/update-product.ts b/packages/medusa/src/api/routes/admin/products/update-product.ts index e146c55c36..59cfbfc3a6 100644 --- a/packages/medusa/src/api/routes/admin/products/update-product.ts +++ b/packages/medusa/src/api/routes/admin/products/update-product.ts @@ -40,6 +40,8 @@ import { validator } from "../../../../utils/validator" * application/json: * schema: * $ref: "#/components/schemas/AdminPostProductsProductReq" + * x-codegen: + * method: update * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/products/update-variant.ts b/packages/medusa/src/api/routes/admin/products/update-variant.ts index 0d54ab73e7..ee2234f1d5 100644 --- a/packages/medusa/src/api/routes/admin/products/update-variant.ts +++ b/packages/medusa/src/api/routes/admin/products/update-variant.ts @@ -34,6 +34,8 @@ import { validator } from "../../../../utils/validator" * application/json: * schema: * $ref: "#/components/schemas/AdminPostProductsProductVariantsVariantReq" + * x-codegen: + * method: updateVariant * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/add-channels-batch.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/add-channels-batch.ts index 8f98e63d1f..e5b3ec0217 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/add-channels-batch.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/add-channels-batch.ts @@ -19,6 +19,8 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" * application/json: * schema: * $ref: "#/components/schemas/AdminPostPublishableApiKeySalesChannelsBatchReq" + * x-codegen: + * method: addSalesChannelsBatch * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/create-publishable-api-key.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/create-publishable-api-key.ts index fce7ee9917..4d9ccb6a89 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/create-publishable-api-key.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/create-publishable-api-key.ts @@ -15,6 +15,8 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" * schema: * $ref: "#/components/schemas/AdminPostPublishableApiKeysReq" * x-authenticated: true + * x-codegen: + * method: create * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-channels-batch.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-channels-batch.ts index 53fbe05ffa..4634003c7e 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-channels-batch.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-channels-batch.ts @@ -19,6 +19,8 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" * application/json: * schema: * $ref: "#/components/schemas/AdminDeletePublishableApiKeySalesChannelsBatchReq" + * x-codegen: + * method: deleteSalesChannelsBatch * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-publishable-api-key.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-publishable-api-key.ts index ac0ce6b749..a576e17be3 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-publishable-api-key.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-publishable-api-key.ts @@ -10,6 +10,8 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" * x-authenticated: true * parameters: * - (path) id=* {string} The ID of the PublishableApiKeys to delete. + * x-codegen: + * method: delete * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/get-publishable-api-key.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/get-publishable-api-key.ts index cc1be6c601..28d34363b5 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/get-publishable-api-key.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/get-publishable-api-key.ts @@ -10,6 +10,8 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" * parameters: * - (path) id=* {string} The ID of the PublishableApiKey. * x-authenticated: true + * x-codegen: + * method: retrieve * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-key-sales-channels.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-key-sales-channels.ts index f86f753cd7..8dfaba9871 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-key-sales-channels.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-key-sales-channels.ts @@ -13,6 +13,9 @@ import { extendedFindParamsMixin } from "../../../../types/common" * parameters: * - (path) id=* {string} The ID of the Publishable Api Key. * - (query) q {string} Query used for searching sales channels' names and descriptions. + * x-codegen: + * method: listSalesChannels + * queryParams: GetPublishableApiKeySalesChannelsParams * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-keys.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-keys.ts index f4911f11d3..8f3a4e3141 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-keys.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-keys.ts @@ -16,6 +16,9 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" * - (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: GetPublishableApiKeysParams * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/revoke-publishable-api-key.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/revoke-publishable-api-key.ts index 97bfd5e9c8..f6c0ef9de7 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/revoke-publishable-api-key.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/revoke-publishable-api-key.ts @@ -11,6 +11,8 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" * parameters: * - (path) id=* {string} The ID of the PublishableApiKey. * x-authenticated: true + * x-codegen: + * method: revoke * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/update-publishable-api-key.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/update-publishable-api-key.ts index 026157dfa9..d71ed8f3af 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/update-publishable-api-key.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/update-publishable-api-key.ts @@ -17,6 +17,8 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" * application/json: * schema: * $ref: "#/components/schemas/AdminPostPublishableApiKeysPublishableApiKeyReq" + * x-codegen: + * method: update * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/regions/add-country.ts b/packages/medusa/src/api/routes/admin/regions/add-country.ts index 01973025f0..ac49e925ed 100644 --- a/packages/medusa/src/api/routes/admin/regions/add-country.ts +++ b/packages/medusa/src/api/routes/admin/regions/add-country.ts @@ -19,6 +19,8 @@ import { validator } from "../../../../utils/validator" * application/json: * schema: * $ref: "#/components/schemas/AdminPostRegionsRegionCountriesReq" + * x-codegen: + * method: addCountry * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/regions/add-fulfillment-provider.ts b/packages/medusa/src/api/routes/admin/regions/add-fulfillment-provider.ts index 9e75ea147f..0aec86ce6f 100644 --- a/packages/medusa/src/api/routes/admin/regions/add-fulfillment-provider.ts +++ b/packages/medusa/src/api/routes/admin/regions/add-fulfillment-provider.ts @@ -19,6 +19,8 @@ import { validator } from "../../../../utils/validator" * application/json: * schema: * $ref: "#/components/schemas/AdminPostRegionsRegionFulfillmentProvidersReq" + * x-codegen: + * method: addFulfillmentProvider * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/regions/add-payment-provider.ts b/packages/medusa/src/api/routes/admin/regions/add-payment-provider.ts index fceb8ade26..5908b37acb 100644 --- a/packages/medusa/src/api/routes/admin/regions/add-payment-provider.ts +++ b/packages/medusa/src/api/routes/admin/regions/add-payment-provider.ts @@ -19,6 +19,8 @@ import { validator } from "../../../../utils/validator" * application/json: * schema: * $ref: "#/components/schemas/AdminPostRegionsRegionPaymentProvidersReq" + * x-codegen: + * method: addPaymentProvider * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/regions/create-region.ts b/packages/medusa/src/api/routes/admin/regions/create-region.ts index 1394283196..f5811adaad 100644 --- a/packages/medusa/src/api/routes/admin/regions/create-region.ts +++ b/packages/medusa/src/api/routes/admin/regions/create-region.ts @@ -25,6 +25,8 @@ import { validator } from "../../../../utils/validator" * application/json: * schema: * $ref: "#/components/schemas/AdminPostRegionsReq" + * x-codegen: + * method: create * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/regions/delete-region.ts b/packages/medusa/src/api/routes/admin/regions/delete-region.ts index ad2b99771f..2e9e0a402d 100644 --- a/packages/medusa/src/api/routes/admin/regions/delete-region.ts +++ b/packages/medusa/src/api/routes/admin/regions/delete-region.ts @@ -9,6 +9,8 @@ import RegionService from "../../../../services/region" * x-authenticated: true * parameters: * - (path) id=* {string} The ID of the Region. + * x-codegen: + * method: delete * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/regions/get-fulfillment-options.ts b/packages/medusa/src/api/routes/admin/regions/get-fulfillment-options.ts index d48fab2715..2f452fb3aa 100644 --- a/packages/medusa/src/api/routes/admin/regions/get-fulfillment-options.ts +++ b/packages/medusa/src/api/routes/admin/regions/get-fulfillment-options.ts @@ -10,6 +10,8 @@ import RegionService from "../../../../services/region" * x-authenticated: true * parameters: * - (path) id=* {string} The ID of the Region. + * x-codegen: + * method: retrieveFulfillmentOptions * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/regions/get-region.ts b/packages/medusa/src/api/routes/admin/regions/get-region.ts index c1bfc7c411..98e7c47a76 100644 --- a/packages/medusa/src/api/routes/admin/regions/get-region.ts +++ b/packages/medusa/src/api/routes/admin/regions/get-region.ts @@ -10,6 +10,8 @@ import RegionService from "../../../../services/region" * x-authenticated: true * parameters: * - (path) id=* {string} The ID of the Region. + * x-codegen: + * method: retrieve * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/regions/list-regions.ts b/packages/medusa/src/api/routes/admin/regions/list-regions.ts index 872e2be0c1..8b1179d963 100644 --- a/packages/medusa/src/api/routes/admin/regions/list-regions.ts +++ b/packages/medusa/src/api/routes/admin/regions/list-regions.ts @@ -47,6 +47,9 @@ import { validator } from "../../../../utils/validator" * type: object * required: false * description: Date comparison for when resulting region was deleted, i.e. less than, greater than etc. + * x-codegen: + * method: list + * queryParams: AdminGetRegionsParams * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/regions/remove-country.ts b/packages/medusa/src/api/routes/admin/regions/remove-country.ts index f7003f0f98..9a25ebfdbc 100644 --- a/packages/medusa/src/api/routes/admin/regions/remove-country.ts +++ b/packages/medusa/src/api/routes/admin/regions/remove-country.ts @@ -20,6 +20,8 @@ import RegionService from "../../../../services/region" * externalDocs: * url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes * description: See a list of codes. + * x-codegen: + * method: deleteCountry * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/regions/remove-fulfillment-provider.ts b/packages/medusa/src/api/routes/admin/regions/remove-fulfillment-provider.ts index c6164fb39f..f6634b4804 100644 --- a/packages/medusa/src/api/routes/admin/regions/remove-fulfillment-provider.ts +++ b/packages/medusa/src/api/routes/admin/regions/remove-fulfillment-provider.ts @@ -12,6 +12,8 @@ import RegionService from "../../../../services/region" * parameters: * - (path) id=* {string} The ID of the Region. * - (path) provider_id=* {string} The ID of the Fulfillment Provider. + * x-codegen: + * method: deleteFulfillmentProvider * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/regions/remove-payment-provider.ts b/packages/medusa/src/api/routes/admin/regions/remove-payment-provider.ts index 00916ac5b7..35719c27ab 100644 --- a/packages/medusa/src/api/routes/admin/regions/remove-payment-provider.ts +++ b/packages/medusa/src/api/routes/admin/regions/remove-payment-provider.ts @@ -12,6 +12,8 @@ import RegionService from "../../../../services/region" * parameters: * - (path) id=* {string} The ID of the Region. * - (path) provider_id=* {string} The ID of the Payment Provider. + * x-codegen: + * method: deletePaymentProvider * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/regions/update-region.ts b/packages/medusa/src/api/routes/admin/regions/update-region.ts index 88f9e3256c..443dd7a276 100644 --- a/packages/medusa/src/api/routes/admin/regions/update-region.ts +++ b/packages/medusa/src/api/routes/admin/regions/update-region.ts @@ -27,6 +27,8 @@ import { validator } from "../../../../utils/validator" * application/json: * schema: * $ref: "#/components/schemas/AdminPostRegionsRegionReq" + * x-codegen: + * method: update * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/return-reasons/create-reason.ts b/packages/medusa/src/api/routes/admin/return-reasons/create-reason.ts index 9085ee873b..05fed737c7 100644 --- a/packages/medusa/src/api/routes/admin/return-reasons/create-reason.ts +++ b/packages/medusa/src/api/routes/admin/return-reasons/create-reason.ts @@ -19,6 +19,8 @@ import { EntityManager } from "typeorm" * application/json: * schema: * $ref: "#/components/schemas/AdminPostReturnReasonsReq" + * x-codegen: + * method: create * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/return-reasons/delete-reason.ts b/packages/medusa/src/api/routes/admin/return-reasons/delete-reason.ts index 9af870188e..b79d56e01e 100644 --- a/packages/medusa/src/api/routes/admin/return-reasons/delete-reason.ts +++ b/packages/medusa/src/api/routes/admin/return-reasons/delete-reason.ts @@ -9,6 +9,8 @@ import { ReturnReasonService } from "../../../../services" * x-authenticated: true * parameters: * - (path) id=* {string} The ID of the return reason + * x-codegen: + * method: delete * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/return-reasons/get-reason.ts b/packages/medusa/src/api/routes/admin/return-reasons/get-reason.ts index 754939de73..81e4b25dc3 100644 --- a/packages/medusa/src/api/routes/admin/return-reasons/get-reason.ts +++ b/packages/medusa/src/api/routes/admin/return-reasons/get-reason.ts @@ -13,6 +13,8 @@ import { ReturnReasonService } from "../../../../services" * x-authenticated: true * parameters: * - (path) id=* {string} The ID of the Return Reason. + * x-codegen: + * method: retrieve * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/return-reasons/list-reasons.ts b/packages/medusa/src/api/routes/admin/return-reasons/list-reasons.ts index 774b88199d..d25616b219 100644 --- a/packages/medusa/src/api/routes/admin/return-reasons/list-reasons.ts +++ b/packages/medusa/src/api/routes/admin/return-reasons/list-reasons.ts @@ -12,6 +12,8 @@ import { Selector } from "../../../../types/common" * summary: "List Return Reasons" * description: "Retrieves a list of Return Reasons." * x-authenticated: true + * x-codegen: + * method: list * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/return-reasons/update-reason.ts b/packages/medusa/src/api/routes/admin/return-reasons/update-reason.ts index 394214150e..b76b3b4c77 100644 --- a/packages/medusa/src/api/routes/admin/return-reasons/update-reason.ts +++ b/packages/medusa/src/api/routes/admin/return-reasons/update-reason.ts @@ -21,6 +21,8 @@ import { EntityManager } from "typeorm" * application/json: * schema: * $ref: "#/components/schemas/AdminPostReturnReasonsReasonReq" + * x-codegen: + * method: update * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/returns/cancel-return.ts b/packages/medusa/src/api/routes/admin/returns/cancel-return.ts index cb7a2b33df..0214242362 100644 --- a/packages/medusa/src/api/routes/admin/returns/cancel-return.ts +++ b/packages/medusa/src/api/routes/admin/returns/cancel-return.ts @@ -12,6 +12,8 @@ import { EntityManager } from "typeorm" * description: "Registers a Return as canceled." * parameters: * - (path) id=* {string} The ID of the Return. + * x-codegen: + * method: cancel * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/returns/list-returns.ts b/packages/medusa/src/api/routes/admin/returns/list-returns.ts index be7d2bb0a3..fd84fcc226 100644 --- a/packages/medusa/src/api/routes/admin/returns/list-returns.ts +++ b/packages/medusa/src/api/routes/admin/returns/list-returns.ts @@ -14,6 +14,9 @@ import { Return } from "../../../../models" * parameters: * - (query) limit=50 {number} The upper limit for the amount of responses returned. * - (query) offset=0 {number} The offset of the list returned. + * x-codegen: + * method: list + * queryParams: AdminGetReturnsParams * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/admin/returns/receive-return.ts b/packages/medusa/src/api/routes/admin/returns/receive-return.ts index 82396582a6..9948750c04 100644 --- a/packages/medusa/src/api/routes/admin/returns/receive-return.ts +++ b/packages/medusa/src/api/routes/admin/returns/receive-return.ts @@ -24,6 +24,8 @@ import { isDefined } from "medusa-core-utils" * application/json: * schema: * $ref: "#/components/schemas/AdminPostReturnsReturnReceiveReq" + * x-codegen: + * method: receive * x-codeSamples: * - lang: JavaScript * label: JS Client