Skip to content

armgit / dub

Public Imported from GitHub
0

The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.

Add discount codes to the OpenAPI spec

Kiran K4e38b7651639
diff --git a/apps/web/app/(ee)/api/discount-codes/[discountCodeId]/route.ts b/apps/web/app/(ee)/api/discount-codes/[discountCodeId]/route.ts
index 091e098460..887bc67e80 100644
--- a/apps/web/app/(ee)/api/discount-codes/[discountCodeId]/route.ts
+++ b/apps/web/app/(ee)/api/discount-codes/[discountCodeId]/route.ts
@@ -2,43 +2,52 @@ import { recordAuditLog } from "@/lib/api/audit-logs/record-audit-log";
import { DubApiError } from "@/lib/api/errors";
import { getDefaultProgramIdOrThrow } from "@/lib/api/programs/get-default-program-id-or-throw";
import { withWorkspace } from "@/lib/auth";
+import { getDiscountCodeOrThrow } from "@/lib/discount-codes/get-discount-code-or-throw";
import { deleteDiscountCodes } from "@/lib/discounts/delete-discount-code";
import { prisma } from "@/lib/prisma";
+import { DiscountProvider } from "@prisma/client";
import { waitUntil } from "@vercel/functions";
import { NextResponse } from "next/server";
-// DELETE /api/discount-codes/[discountCodeId] - soft delete a discount code
-export const DELETE = withWorkspace(
+// PATCH /api/discount-codes/[discountCodeId] - update a discount code
+export const PATCH = withWorkspace(
async ({ workspace, params, session }) => {
const { discountCodeId } = params;
const programId = getDefaultProgramIdOrThrow(workspace);
- const discountCode = await prisma.discountCode.findUnique({
- where: {
- id: discountCodeId,
- },
- include: {
- discount: {
- select: {
- provider: true,
- },
- },
- },
+ const discountCode = await getDiscountCodeOrThrow({
+ discountCodeId,
+ programId,
});
- if (!discountCode || !discountCode.discount) {
+ if (discountCode.discount.provider !== DiscountProvider.custom) {
throw new DubApiError({
- message: `Discount code (${discountCodeId}) not found.`,
code: "bad_request",
+ message: `This operation is only available for "custom" discount provider.`,
});
}
- if (discountCode.programId !== programId) {
- throw new DubApiError({
- message: `Discount code (${discountCodeId}) is not associated with the program.`,
- code: "bad_request",
- });
- }
+ // TODO:
+ // - Update the discount code
+
+ return NextResponse.json({ id: discountCode.id });
+ },
+ {
+ requiredPlan: ["business", "advanced", "enterprise"],
+ requiredRoles: ["owner", "member"],
+ },
+);
+
+// DELETE /api/discount-codes/[discountCodeId] - soft delete a discount code
+export const DELETE = withWorkspace(
+ async ({ workspace, params, session }) => {
+ const { discountCodeId } = params;
+ const programId = getDefaultProgramIdOrThrow(workspace);
+
+ const discountCode = await getDiscountCodeOrThrow({
+ discountCodeId,
+ programId,
+ });
await prisma.discountCode.update({
where: {
diff --git a/apps/web/lib/discount-codes/get-discount-code-or-throw.ts b/apps/web/lib/discount-codes/get-discount-code-or-throw.ts
new file mode 100644
index 0000000000..7c21643864
--- /dev/null
+++ b/apps/web/lib/discount-codes/get-discount-code-or-throw.ts
@@ -0,0 +1,44 @@
+import { prisma } from "@/lib/prisma";
+import { DubApiError } from "../api/errors";
+
+export async function getDiscountCodeOrThrow({
+ discountCodeId,
+ programId,
+}: {
+ discountCodeId: string;
+ programId: string;
+}) {
+ const discountCode = await prisma.discountCode.findUnique({
+ where: {
+ id: discountCodeId,
+ },
+ include: {
+ discount: {
+ select: {
+ provider: true,
+ },
+ },
+ },
+ });
+
+ if (!discountCode || !discountCode.discount) {
+ throw new DubApiError({
+ code: "not_found",
+ message: `Discount code (${discountCodeId}) not found.`,
+ });
+ }
+
+ if (discountCode.programId !== programId) {
+ throw new DubApiError({
+ code: "not_found",
+ message: `Discount code (${discountCodeId}) not found.`,
+ });
+ }
+
+ const { discount, ...rest } = discountCode;
+
+ return {
+ ...rest,
+ discount,
+ };
+}
diff --git a/apps/web/lib/openapi/discount-codes/create-discount-code.ts b/apps/web/lib/openapi/discount-codes/create-discount-code.ts
new file mode 100644
index 0000000000..60f73eab84
--- /dev/null
+++ b/apps/web/lib/openapi/discount-codes/create-discount-code.ts
@@ -0,0 +1,34 @@
+import { openApiErrorResponses } from "@/lib/openapi/responses";
+import {
+ createDiscountCodeSchema,
+ DiscountCodeSchema,
+} from "@/lib/zod/schemas/discount";
+import { ZodOpenApiOperationObject } from "zod-openapi";
+
+export const createDiscountCode: ZodOpenApiOperationObject = {
+ operationId: "createDiscountCode",
+ "x-speakeasy-name-override": "create",
+ summary: "Create a discount code",
+ description:
+ "Create a discount code for a partner. A discount must already be assigned to the partner's group, and the specified link cannot already have a discount code.",
+ requestBody: {
+ content: {
+ "application/json": {
+ schema: createDiscountCodeSchema,
+ },
+ },
+ },
+ responses: {
+ "200": {
+ description: "The created discount code.",
+ content: {
+ "application/json": {
+ schema: DiscountCodeSchema,
+ },
+ },
+ },
+ ...openApiErrorResponses,
+ },
+ tags: ["Discount Codes"],
+ security: [{ token: [] }],
+};
diff --git a/apps/web/lib/openapi/discount-codes/delete-discount-code.ts b/apps/web/lib/openapi/discount-codes/delete-discount-code.ts
new file mode 100644
index 0000000000..5262afdee9
--- /dev/null
+++ b/apps/web/lib/openapi/discount-codes/delete-discount-code.ts
@@ -0,0 +1,33 @@
+import { openApiErrorResponses } from "@/lib/openapi/responses";
+import { DiscountCodeSchema } from "@/lib/zod/schemas/discount";
+import { ZodOpenApiOperationObject } from "zod-openapi";
+import * as z from "zod/v4";
+
+export const deleteDiscountCode: ZodOpenApiOperationObject = {
+ operationId: "deleteDiscountCode",
+ "x-speakeasy-name-override": "delete",
+ "x-speakeasy-max-method-params": 1,
+ summary: "Delete a discount code",
+ description:
+ "Delete a discount code for a partner. This will also disable the code in your connected Stripe or Shopify account.",
+ requestParams: {
+ path: z.object({
+ id: DiscountCodeSchema.shape.id.describe(
+ "The ID of the discount code to delete.",
+ ),
+ }),
+ },
+ responses: {
+ "200": {
+ description: "The deleted discount code ID.",
+ content: {
+ "application/json": {
+ schema: DiscountCodeSchema.pick({ id: true }),
+ },
+ },
+ },
+ ...openApiErrorResponses,
+ },
+ tags: ["Discount Codes"],
+ security: [{ token: [] }],
+};
diff --git a/apps/web/lib/openapi/discount-codes/index.ts b/apps/web/lib/openapi/discount-codes/index.ts
new file mode 100644
index 0000000000..01eafc4392
--- /dev/null
+++ b/apps/web/lib/openapi/discount-codes/index.ts
@@ -0,0 +1,14 @@
+import { ZodOpenApiPathsObject } from "zod-openapi";
+import { createDiscountCode } from "./create-discount-code";
+import { deleteDiscountCode } from "./delete-discount-code";
+import { listDiscountCodes } from "./list-discount-codes";
+
+export const discountCodesPaths: ZodOpenApiPathsObject = {
+ "/discount-codes": {
+ get: listDiscountCodes,
+ post: createDiscountCode,
+ },
+ "/discount-codes/{id}": {
+ delete: deleteDiscountCode,
+ },
+};
diff --git a/apps/web/lib/openapi/discount-codes/list-discount-codes.ts b/apps/web/lib/openapi/discount-codes/list-discount-codes.ts
new file mode 100644
index 0000000000..23833d4d35
--- /dev/null
+++ b/apps/web/lib/openapi/discount-codes/list-discount-codes.ts
@@ -0,0 +1,31 @@
+import { openApiErrorResponses } from "@/lib/openapi/responses";
+import {
+ DiscountCodeSchema,
+ getDiscountCodesQuerySchema,
+} from "@/lib/zod/schemas/discount";
+import { ZodOpenApiOperationObject } from "zod-openapi";
+import * as z from "zod/v4";
+
+export const listDiscountCodes: ZodOpenApiOperationObject = {
+ operationId: "listDiscountCodes",
+ "x-speakeasy-name-override": "list",
+ summary: "List discount codes",
+ description:
+ "Retrieve a list of discount codes for a partner in your program.",
+ requestParams: {
+ query: getDiscountCodesQuerySchema,
+ },
+ responses: {
+ "200": {
+ description: "The list of discount codes.",
+ content: {
+ "application/json": {
+ schema: z.array(DiscountCodeSchema),
+ },
+ },
+ },
+ ...openApiErrorResponses,
+ },
+ tags: ["Discount Codes"],
+ security: [{ token: [] }],
+};
diff --git a/apps/web/lib/openapi/index.ts b/apps/web/lib/openapi/index.ts
index 9669bda97c..0044fc30b0 100644
--- a/apps/web/lib/openapi/index.ts
+++ b/apps/web/lib/openapi/index.ts
@@ -1,5 +1,6 @@
import { createDocument } from "zod-openapi";
import { webhookEventSchema } from "../webhook/schemas";
+import { DiscountCodeSchema } from "../zod/schemas/discount";
import { DomainSchema } from "../zod/schemas/domains";
import { FolderSchema } from "../zod/schemas/folders";
import { LinkErrorSchema, LinkSchema } from "../zod/schemas/links";
@@ -8,6 +9,7 @@ import { analyticsPath } from "./analytics";
import { bountiesPaths } from "./bounties";
import { commissionsPaths } from "./commissions";
import { customersPaths } from "./customers";
+import { discountCodesPaths } from "./discount-codes";
import { domainsPaths } from "./domains";
import { embedTokensPaths } from "./embed-tokens";
import { eventsPath } from "./events";
@@ -53,6 +55,7 @@ export const document = createDocument({
...trackPaths,
...customersPaths,
...partnersPaths,
+ ...discountCodesPaths,
...commissionsPaths,
...payoutsPaths,
...embedTokensPaths,
@@ -65,6 +68,7 @@ export const document = createDocument({
LinkTagSchema,
FolderSchema,
DomainSchema,
+ DiscountCodeSchema,
webhookEventSchema,
LinkErrorSchema,
},
diff --git a/apps/web/lib/zod/schemas/discount.ts b/apps/web/lib/zod/schemas/discount.ts
index e291a67035..0894da4c82 100644
--- a/apps/web/lib/zod/schemas/discount.ts
+++ b/apps/web/lib/zod/schemas/discount.ts
@@ -56,35 +56,68 @@ export const discountPartnersQuerySchema = z
})
.extend(getPaginationQuerySchema({ pageSize: 25 }));
-export const DiscountCodeSchema = z.object({
- id: z.string(),
- code: z.string(),
- discountId: z.string().nullable(),
- partnerId: z.string(),
- linkId: z.string(),
- disabledAt: z.coerce
- .date()
- .nullish()
- .describe(
- "When this discount code was disabled, which happens when a partner is banned or deactivated.",
- ),
-});
+export const DiscountCodeSchema = z
+ .object({
+ id: z.string().describe("The unique ID of the discount code.").meta({
+ example: "dcode_1JVR7XRCSR0EDBAF39FZ4PMYE",
+ }),
+ code: z
+ .string()
+ .describe("The discount code that customers can apply at checkout.")
+ .meta({
+ example: "PARTNER10OFF",
+ }),
+ discountId: z
+ .string()
+ .nullable()
+ .describe("The ID of the discount this code belongs to."),
+ partnerId: z
+ .string()
+ .describe("The ID of the partner this discount code is assigned to."),
+ linkId: z
+ .string()
+ .describe(
+ "The ID of the partner's referral link this discount code is associated with.",
+ ),
+ disabledAt: z.coerce
+ .date()
+ .nullish()
+ .describe(
+ "When this discount code was disabled, which happens when a partner is banned or deactivated.",
+ ),
+ })
+ .meta({
+ title: "DiscountCode",
+ });
export const createDiscountCodeSchema = z.object({
- code: z
+ code: z.preprocess(
+ (val) => (typeof val === "string" && val.trim() === "" ? undefined : val),
+ z
+ .string()
+ .trim()
+ .max(100, "Code must be 100 characters or fewer.")
+ .regex(
+ /^[a-zA-Z0-9\-_]+$/,
+ "Code can only contain letters, numbers, dashes, and underscores.",
+ )
+ .optional()
+ .describe(
+ "The discount code to create. If omitted, a unique code will be generated automatically from the partner's name.",
+ ),
+ ),
+ partnerId: z
+ .string()
+ .describe("The ID of the partner to create a discount code for."),
+ linkId: z
.string()
- .trim()
- .max(100, "Code must be 100 characters or fewer.")
- .regex(
- /^[a-zA-Z0-9\-_]+$/,
- "Code can only contain letters, numbers, dashes, and underscores.",
- )
- .optional()
- .or(z.literal("").transform(() => undefined)),
- partnerId: z.string(),
- linkId: z.string(),
+ .describe(
+ "The ID of the partner's referral link to associate this discount code with. Each link can only have one discount code.",
+ ),
});
export const getDiscountCodesQuerySchema = z.object({
- partnerId: z.string(),
+ partnerId: z
+ .string()
+ .describe("The ID of the partner to retrieve discount codes for."),
});
diff --git a/apps/web/prisma/schema/discount.prisma b/apps/web/prisma/schema/discount.prisma
index 8d30100162..f5251a051c 100644
--- a/apps/web/prisma/schema/discount.prisma
+++ b/apps/web/prisma/schema/discount.prisma
@@ -1,6 +1,7 @@
enum DiscountProvider {
stripe
shopify
+ custom
}
model Discount {