From 9fe5e6090729d68c8ed8299d258e24e722cf4cee Mon Sep 17 00:00:00 2001 From: Felipe Cardoso Date: Wed, 19 Mar 2025 19:55:56 +0100 Subject: [PATCH] Rename gift purchases API to reservations and update types Refactor types and API references to replace "gift purchases" with "gift reservations" for improved clarity. Updates include type definitions, query keys, options, and endpoint URLs, with the addition of an optional event ID filter. This ensures better alignment with the intended functionality. --- .../src/client/@tanstack/react-query.gen.ts | 18 ++++++------- frontend/src/client/sdk.gen.ts | 19 +++++++------ frontend/src/client/types.gen.ts | 27 ++++++++++++++----- 3 files changed, 41 insertions(+), 23 deletions(-) diff --git a/frontend/src/client/@tanstack/react-query.gen.ts b/frontend/src/client/@tanstack/react-query.gen.ts index a51f94b..bcd5651 100644 --- a/frontend/src/client/@tanstack/react-query.gen.ts +++ b/frontend/src/client/@tanstack/react-query.gen.ts @@ -48,7 +48,7 @@ import { readGiftPurchase, readGiftPurchasesByGift, readGiftPurchasesByGuest, - readGuestsGiftPurchases, + readGuestsGiftReservations, createEvent, getUserEvents, getUpcomingEvents, @@ -166,7 +166,7 @@ import type { ReadGiftPurchaseData, ReadGiftPurchasesByGiftData, ReadGiftPurchasesByGuestData, - ReadGuestsGiftPurchasesData, + ReadGuestsGiftReservationsData, CreateEventData, CreateEventError, CreateEventResponse, @@ -1423,16 +1423,16 @@ export const readGiftPurchasesByGuestOptions = ( }); }; -export const readGuestsGiftPurchasesQueryKey = ( - options?: Options, -) => createQueryKey("readGuestsGiftPurchases", options); +export const readGuestsGiftReservationsQueryKey = ( + options?: Options, +) => createQueryKey("readGuestsGiftReservations", options); -export const readGuestsGiftPurchasesOptions = ( - options?: Options, +export const readGuestsGiftReservationsOptions = ( + options?: Options, ) => { return queryOptions({ queryFn: async ({ queryKey, signal }) => { - const { data } = await readGuestsGiftPurchases({ + const { data } = await readGuestsGiftReservations({ ...options, ...queryKey[0], signal, @@ -1440,7 +1440,7 @@ export const readGuestsGiftPurchasesOptions = ( }); return data; }, - queryKey: readGuestsGiftPurchasesQueryKey(options), + queryKey: readGuestsGiftReservationsQueryKey(options), }); }; diff --git a/frontend/src/client/sdk.gen.ts b/frontend/src/client/sdk.gen.ts index 43ef162..9000c9f 100644 --- a/frontend/src/client/sdk.gen.ts +++ b/frontend/src/client/sdk.gen.ts @@ -142,8 +142,9 @@ import type { ReadGiftPurchasesByGuestData, ReadGiftPurchasesByGuestResponse, ReadGiftPurchasesByGuestError, - ReadGuestsGiftPurchasesData, - ReadGuestsGiftPurchasesResponse, + ReadGuestsGiftReservationsData, + ReadGuestsGiftReservationsResponse, + ReadGuestsGiftReservationsError, CreateEventData, CreateEventResponse, CreateEventError, @@ -1157,17 +1158,19 @@ export const readGiftPurchasesByGuest = ( /** * Read All Guest Gift Reservations - * Retrieve all guest gift reservations. + * Retrieve all guest gift reservations, optionally filtered by event ID. */ -export const readGuestsGiftPurchases = ( - options?: Options, +export const readGuestsGiftReservations = < + ThrowOnError extends boolean = false, +>( + options?: Options, ) => { return (options?.client ?? _heyApiClient).get< - ReadGuestsGiftPurchasesResponse, - unknown, + ReadGuestsGiftReservationsResponse, + ReadGuestsGiftReservationsError, ThrowOnError >({ - url: "/api/v1/events/gifts/purchases/guest/all", + url: "/api/v1/events/gifts/reservations/guests", ...options, }); }; diff --git a/frontend/src/client/types.gen.ts b/frontend/src/client/types.gen.ts index c617f4a..7831721 100644 --- a/frontend/src/client/types.gen.ts +++ b/frontend/src/client/types.gen.ts @@ -1876,22 +1876,37 @@ export type ReadGiftPurchasesByGuestResponses = { export type ReadGiftPurchasesByGuestResponse = ReadGiftPurchasesByGuestResponses[keyof ReadGiftPurchasesByGuestResponses]; -export type ReadGuestsGiftPurchasesData = { +export type ReadGuestsGiftReservationsData = { body?: never; path?: never; - query?: never; - url: "/api/v1/events/gifts/purchases/guest/all"; + query?: { + /** + * Optional event ID to filter reservations by event + */ + event_id?: string | null; + }; + url: "/api/v1/events/gifts/reservations/guests"; }; -export type ReadGuestsGiftPurchasesResponses = { +export type ReadGuestsGiftReservationsErrors = { + /** + * Validation Error + */ + 422: HttpValidationError; +}; + +export type ReadGuestsGiftReservationsError = + ReadGuestsGiftReservationsErrors[keyof ReadGuestsGiftReservationsErrors]; + +export type ReadGuestsGiftReservationsResponses = { /** * Successful Response */ 200: Array; }; -export type ReadGuestsGiftPurchasesResponse = - ReadGuestsGiftPurchasesResponses[keyof ReadGuestsGiftPurchasesResponses]; +export type ReadGuestsGiftReservationsResponse = + ReadGuestsGiftReservationsResponses[keyof ReadGuestsGiftReservationsResponses]; export type CreateEventData = { body: EventCreate;