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.
This commit is contained in:
2025-03-19 19:55:56 +01:00
parent 62ce98c80e
commit 9fe5e60907
3 changed files with 41 additions and 23 deletions

View File

@@ -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<ReadGuestsGiftPurchasesData>,
) => createQueryKey("readGuestsGiftPurchases", options);
export const readGuestsGiftReservationsQueryKey = (
options?: Options<ReadGuestsGiftReservationsData>,
) => createQueryKey("readGuestsGiftReservations", options);
export const readGuestsGiftPurchasesOptions = (
options?: Options<ReadGuestsGiftPurchasesData>,
export const readGuestsGiftReservationsOptions = (
options?: Options<ReadGuestsGiftReservationsData>,
) => {
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),
});
};

View File

@@ -142,8 +142,9 @@ import type {
ReadGiftPurchasesByGuestData,
ReadGiftPurchasesByGuestResponse,
ReadGiftPurchasesByGuestError,
ReadGuestsGiftPurchasesData,
ReadGuestsGiftPurchasesResponse,
ReadGuestsGiftReservationsData,
ReadGuestsGiftReservationsResponse,
ReadGuestsGiftReservationsError,
CreateEventData,
CreateEventResponse,
CreateEventError,
@@ -1157,17 +1158,19 @@ export const readGiftPurchasesByGuest = <ThrowOnError extends boolean = false>(
/**
* Read All Guest Gift Reservations
* Retrieve all guest gift reservations.
* Retrieve all guest gift reservations, optionally filtered by event ID.
*/
export const readGuestsGiftPurchases = <ThrowOnError extends boolean = false>(
options?: Options<ReadGuestsGiftPurchasesData, ThrowOnError>,
export const readGuestsGiftReservations = <
ThrowOnError extends boolean = false,
>(
options?: Options<ReadGuestsGiftReservationsData, ThrowOnError>,
) => {
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,
});
};

View File

@@ -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<GiftPurchase>;
};
export type ReadGuestsGiftPurchasesResponse =
ReadGuestsGiftPurchasesResponses[keyof ReadGuestsGiftPurchasesResponses];
export type ReadGuestsGiftReservationsResponse =
ReadGuestsGiftReservationsResponses[keyof ReadGuestsGiftReservationsResponses];
export type CreateEventData = {
body: EventCreate;