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.

Move payouts API to /api/payouts and add OpenAPI spec

Kiran K5d1cd2d63013
diff --git a/apps/web/app/(ee)/api/programs/[programId]/payouts/count/route.ts b/apps/web/app/(ee)/api/payouts/count/route.ts
similarity index 97%
rename from apps/web/app/(ee)/api/programs/[programId]/payouts/count/route.ts
rename to apps/web/app/(ee)/api/payouts/count/route.ts
index 0d4c50ffac..dc8e2e269d 100644
--- a/apps/web/app/(ee)/api/programs/[programId]/payouts/count/route.ts
+++ b/apps/web/app/(ee)/api/payouts/count/route.ts
@@ -7,12 +7,13 @@ import { prisma } from "@dub/prisma";
import { FraudEventStatus, PayoutStatus, Prisma } from "@dub/prisma/client";
import { NextResponse } from "next/server";
-// GET /api/programs/[programId]/payouts/count
+// GET /api/payouts/count
export const GET = withWorkspace(async ({ workspace, searchParams }) => {
const programId = getDefaultProgramIdOrThrow(workspace);
const isHoldStatus = searchParams.status === "hold";
const { status: _status, ...restSearchParams } = searchParams;
+
let { status, partnerId, groupBy, eligibility, invoiceId } =
payoutsCountQuerySchema.parse(
isHoldStatus ? restSearchParams : searchParams,
diff --git a/apps/web/app/(ee)/api/programs/[programId]/payouts/route.ts b/apps/web/app/(ee)/api/payouts/route.ts
similarity index 96%
rename from apps/web/app/(ee)/api/programs/[programId]/payouts/route.ts
rename to apps/web/app/(ee)/api/payouts/route.ts
index 0e1129f6d0..887250389e 100644
--- a/apps/web/app/(ee)/api/programs/[programId]/payouts/route.ts
+++ b/apps/web/app/(ee)/api/payouts/route.ts
@@ -11,7 +11,7 @@ import { FraudEventStatus, PayoutStatus } from "@dub/prisma/client";
import { NextResponse } from "next/server";
import * as z from "zod/v4";
-// GET /api/programs/[programId]/payouts - get all payouts for a program
+// GET /api/payouts - get all payouts for a program
export const GET = withWorkspace(async ({ workspace, searchParams }) => {
const programId = getDefaultProgramIdOrThrow(workspace);
diff --git a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/payout-table.tsx b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/payout-table.tsx
index 1365fd18cd..264c977307 100644
--- a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/payout-table.tsx
+++ b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/payout-table.tsx
@@ -64,7 +64,7 @@ const PayoutTableInner = memo(
isLoading,
} = useSWR<PayoutResponse[]>(
defaultProgramId
- ? `/api/programs/${defaultProgramId}/payouts${getQueryString(
+ ? `/api/payouts${getQueryString(
{ workspaceId },
{
exclude: ["payoutId", "selectedPayoutId", "excludedPayoutIds"],
diff --git a/apps/web/lib/openapi/index.ts b/apps/web/lib/openapi/index.ts
index a2e1ce8d6f..9669bda97c 100644
--- a/apps/web/lib/openapi/index.ts
+++ b/apps/web/lib/openapi/index.ts
@@ -14,6 +14,7 @@ import { eventsPath } from "./events";
import { foldersPaths } from "./folders";
import { linksPaths } from "./links";
import { partnersPaths } from "./partners";
+import { payoutsPaths } from "./payouts";
import { qrCodePaths } from "./qr";
import { openApiErrorResponsesComponents } from "./responses";
import { tagsPaths } from "./tags";
@@ -53,6 +54,7 @@ export const document = createDocument({
...customersPaths,
...partnersPaths,
...commissionsPaths,
+ ...payoutsPaths,
...embedTokensPaths,
...qrCodePaths,
...bountiesPaths,
diff --git a/apps/web/lib/openapi/payouts/index.ts b/apps/web/lib/openapi/payouts/index.ts
new file mode 100644
index 0000000000..29535218f6
--- /dev/null
+++ b/apps/web/lib/openapi/payouts/index.ts
@@ -0,0 +1,8 @@
+import { ZodOpenApiPathsObject } from "zod-openapi";
+import { listPayouts } from "./list-payouts";
+
+export const payoutsPaths: ZodOpenApiPathsObject = {
+ "/payouts": {
+ get: listPayouts,
+ },
+};
diff --git a/apps/web/lib/openapi/payouts/list-payouts.ts b/apps/web/lib/openapi/payouts/list-payouts.ts
new file mode 100644
index 0000000000..79a6252293
--- /dev/null
+++ b/apps/web/lib/openapi/payouts/list-payouts.ts
@@ -0,0 +1,30 @@
+import { openApiErrorResponses } from "@/lib/openapi/responses";
+import {
+ PayoutResponseSchema,
+ payoutsQuerySchema,
+} from "@/lib/zod/schemas/payouts";
+import { ZodOpenApiOperationObject } from "zod-openapi";
+import * as z from "zod/v4";
+
+export const listPayouts: ZodOpenApiOperationObject = {
+ operationId: "listPayouts",
+ "x-speakeasy-name-override": "list",
+ summary: "Get payouts for a program.",
+ description: "Retrieve a list of payouts for the workspace default program.",
+ requestParams: {
+ query: payoutsQuerySchema,
+ },
+ responses: {
+ "200": {
+ description: "The list of payouts.",
+ content: {
+ "application/json": {
+ schema: z.array(PayoutResponseSchema),
+ },
+ },
+ },
+ ...openApiErrorResponses,
+ },
+ tags: ["Payouts"],
+ security: [{ token: [] }],
+};
diff --git a/apps/web/lib/swr/use-payouts-count.ts b/apps/web/lib/swr/use-payouts-count.ts
index 21a543a1ac..bd8088d18c 100644
--- a/apps/web/lib/swr/use-payouts-count.ts
+++ b/apps/web/lib/swr/use-payouts-count.ts
@@ -17,7 +17,7 @@ export default function usePayoutsCount<T>({
workspaceId &&
defaultProgramId &&
enabled &&
- `/api/programs/${defaultProgramId}/payouts/count${getQueryString(
+ `/api/payouts/count${getQueryString(
{
...query,
workspaceId,
diff --git a/apps/web/lib/swr/use-payouts.ts b/apps/web/lib/swr/use-payouts.ts
index 7a5a1aebd6..b3d1e83d9a 100644
--- a/apps/web/lib/swr/use-payouts.ts
+++ b/apps/web/lib/swr/use-payouts.ts
@@ -15,7 +15,7 @@ export default function usePayouts({
const { data: payouts, error } = useSWR<PayoutResponse[]>(
workspaceId &&
defaultProgramId &&
- `/api/programs/${defaultProgramId}/payouts?${new URLSearchParams({
+ `/api/payouts?${new URLSearchParams({
workspaceId,
...query,
} as Record<string, any>).toString()}`,
diff --git a/apps/web/ui/partners/mark-commission-duplicate-modal.tsx b/apps/web/ui/partners/mark-commission-duplicate-modal.tsx
index 9fd38db9cc..9346cdd809 100644
--- a/apps/web/ui/partners/mark-commission-duplicate-modal.tsx
+++ b/apps/web/ui/partners/mark-commission-duplicate-modal.tsx
@@ -34,17 +34,14 @@ function ModalInner({
setShowModal,
commission,
}: Omit<ModalProps, "showModal">) {
- const { id: workspaceId, defaultProgramId } = useWorkspace();
+ const { id: workspaceId } = useWorkspace();
const { executeAsync, isExecuting, hasSucceeded } = useAction(
markCommissionDuplicateAction,
{
onSuccess: async () => {
toast.success("Successfully marked commission as duplicate.");
- await mutatePrefix([
- "/api/commissions",
- `/api/programs/${defaultProgramId}/payouts`,
- ]);
+ await mutatePrefix(["/api/commissions", "/api/payouts"]);
setShowModal(false);
},
onError: () => {
diff --git a/apps/web/ui/partners/mark-commission-fraud-or-canceled-modal.tsx b/apps/web/ui/partners/mark-commission-fraud-or-canceled-modal.tsx
index 098bc92478..70fc8d1e4b 100644
--- a/apps/web/ui/partners/mark-commission-fraud-or-canceled-modal.tsx
+++ b/apps/web/ui/partners/mark-commission-fraud-or-canceled-modal.tsx
@@ -41,17 +41,14 @@ function ModalInner({
commission,
status,
}: Omit<ModalProps, "showModal">) {
- const { id: workspaceId, defaultProgramId } = useWorkspace();
+ const { id: workspaceId } = useWorkspace();
const { executeAsync, isExecuting, hasSucceeded } = useAction(
markCommissionFraudOrCanceledAction,
{
onSuccess: async () => {
toast.success(`Commission marked as ${status} successfully!`);
- await mutatePrefix([
- "/api/commissions",
- `/api/programs/${defaultProgramId}/payouts`,
- ]);
+ await mutatePrefix(["/api/commissions", "/api/payouts"]);
setShowModal(false);
},
onError: () => {