f3bf351d21
## What Pluralize OAS tags ## Why OAS tags are commonly used by code generator to group routes under a name space based on a tag. Our JS client convention is to use plural, e.g: client.products, client.customers. In order to minimize friction when migrating to a client generated from OAS, tags should be plural as well. ## How Match tag naming with JS client resource naming. ## Test * Run `yarn build` * Run `yarn openapi:generate` * Run `yarn redocly preview-docs docs/api/admin/openapi.yaml --config=./docs-util/redocly/config.yaml` * Expect side menu items to be plural. * Run `yarn redocly preview-docs docs/api/store/openapi.yaml --config=./docs-util/redocly/config.yaml` * Expect side menu items to be plural.
137 lines
4.5 KiB
TypeScript
137 lines
4.5 KiB
TypeScript
import { Request, Response } from "express"
|
|
import { EntityManager } from "typeorm"
|
|
import { DiscountConditionService, DiscountService } from "../../../../services"
|
|
import {
|
|
DiscountConditionInput,
|
|
DiscountConditionMapTypeToProperty,
|
|
} from "../../../../types/discount"
|
|
import { IsArray } from "class-validator"
|
|
import { FindParams } from "../../../../types/common"
|
|
|
|
/**
|
|
* @oas [delete] /admin/discounts/{discount_id}/conditions/{condition_id}/batch
|
|
* operationId: "DeleteDiscountsDiscountConditionsConditionBatch"
|
|
* summary: "Delete Batch Resources"
|
|
* description: "Delete a batch of resources from a discount condition."
|
|
* x-authenticated: true
|
|
* parameters:
|
|
* - (path) discount_id=* {string} The ID of the Product.
|
|
* - (path) condition_id=* {string} The ID of the condition on which to add the item.
|
|
* - (query) expand {string} (Comma separated) Which relations should be expanded in each discount of the result.
|
|
* - (query) fields {string} (Comma separated) Which fields should be included in each discount of the result.
|
|
* requestBody:
|
|
* content:
|
|
* application/json:
|
|
* schema:
|
|
* $ref: "#/components/schemas/AdminDeleteDiscountsDiscountConditionsConditionBatchReq"
|
|
* x-codegen:
|
|
* method: deleteConditionResourceBatch
|
|
* x-codeSamples:
|
|
* - lang: JavaScript
|
|
* label: JS Client
|
|
* source: |
|
|
* import Medusa from "@medusajs/medusa-js"
|
|
* const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
|
|
* // must be previously logged in or use api token
|
|
* medusa.admin.discounts.deleteConditionResourceBatch(discount_id, condition_id, {
|
|
* resources: [{ id: item_id }]
|
|
* })
|
|
* .then(({ discount }) => {
|
|
* console.log(discount.id);
|
|
* });
|
|
* - lang: Shell
|
|
* label: cURL
|
|
* source: |
|
|
* curl --location --request DELETE 'https://medusa-url.com/admin/discounts/{id}/conditions/{condition_id}/batch' \
|
|
* --header 'Authorization: Bearer {api_token}' \
|
|
* --header 'Content-Type: application/json' \
|
|
* --data-raw '{
|
|
* "resources": [{ "id": "item_id" }]
|
|
* }'
|
|
* security:
|
|
* - api_token: []
|
|
* - cookie_auth: []
|
|
* tags:
|
|
* - Discounts
|
|
* responses:
|
|
* 200:
|
|
* description: OK
|
|
* content:
|
|
* application/json:
|
|
* schema:
|
|
* $ref: "#/components/schemas/AdminDiscountsRes"
|
|
* "400":
|
|
* $ref: "#/components/responses/400_error"
|
|
* "401":
|
|
* $ref: "#/components/responses/unauthorized"
|
|
* "404":
|
|
* $ref: "#/components/responses/not_found_error"
|
|
* "409":
|
|
* $ref: "#/components/responses/invalid_state_error"
|
|
* "422":
|
|
* $ref: "#/components/responses/invalid_request_error"
|
|
* "500":
|
|
* $ref: "#/components/responses/500_error"
|
|
*/
|
|
export default async (req: Request, res: Response) => {
|
|
const { discount_id, condition_id } = req.params
|
|
|
|
const conditionService: DiscountConditionService = req.scope.resolve(
|
|
"discountConditionService"
|
|
)
|
|
const manager: EntityManager = req.scope.resolve("manager")
|
|
|
|
const condition = await conditionService.retrieve(condition_id, {
|
|
select: ["id", "type", "discount_rule_id"],
|
|
})
|
|
|
|
const validatedBody =
|
|
req.validatedBody as AdminDeleteDiscountsDiscountConditionsConditionBatchReq
|
|
const data = {
|
|
id: condition_id,
|
|
rule_id: condition.discount_rule_id,
|
|
[DiscountConditionMapTypeToProperty[condition.type]]:
|
|
validatedBody.resources,
|
|
} as Omit<DiscountConditionInput, "id"> & { id: string }
|
|
|
|
await manager.transaction(async (transactionManager) => {
|
|
await conditionService
|
|
.withTransaction(transactionManager)
|
|
.removeResources(data)
|
|
})
|
|
|
|
const discountService: DiscountService = req.scope.resolve("discountService")
|
|
const discount = await discountService.retrieve(
|
|
discount_id,
|
|
req.retrieveConfig
|
|
)
|
|
|
|
res.status(200).json({ discount })
|
|
}
|
|
|
|
// eslint-disable-next-line max-len
|
|
export class AdminDeleteDiscountsDiscountConditionsConditionBatchParams extends FindParams {}
|
|
|
|
/**
|
|
* @schema AdminDeleteDiscountsDiscountConditionsConditionBatchReq
|
|
* type: object
|
|
* required:
|
|
* - resources
|
|
* properties:
|
|
* resources:
|
|
* description: The resources to be deleted from the discount condition
|
|
* type: array
|
|
* items:
|
|
* type: object
|
|
* required:
|
|
* - id
|
|
* properties:
|
|
* id:
|
|
* description: The id of the item
|
|
* type: string
|
|
*/
|
|
export class AdminDeleteDiscountsDiscountConditionsConditionBatchReq {
|
|
@IsArray()
|
|
resources: { id: string }[]
|
|
}
|