@athos-sdk/api-types 2.0.0 → 2.1.0

package/dist/index.d.mts

@@ -28,6 +28,25 @@ declare enum ExpertRole {
 interface SuccessResponse {
     success: true;
 }
+/** Query params for paginated list endpoints (page, limit) */
+interface PaginationQuery {
+    page?: number;
+    limit?: number;
+}
+/** Meta object in paginated list responses */
+interface PaginationMeta {
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+    hasNext: boolean;
+    hasPrev: boolean;
+}
+/** Response shape for paginated list endpoints */
+interface PaginatedResponse<T> {
+    data: T[];
+    meta: PaginationMeta;
+}
 /** Media record (e.g. profile image, gym image) */
 interface Media {
     id: string;
@@ -172,6 +191,10 @@ interface ChallengeOccurrence {
     endDate: string;
     imageId: string | null;
 }
+/** Challenge with occurrences (e.g. GET /challenges paginated list) */
+interface ChallengeWithOccurrences extends Challenge {
+    occurrences: ChallengeOccurrence[];
+}
 /** Occurrence with challenge and participations (e.g. GET /challenges/me/active) */
 interface ChallengeOccurrenceWithDetails extends ChallengeOccurrence {
     challenge: Challenge;
@@ -265,28 +288,6 @@ interface CheckIn {
     checkedInAt: string;
 }
 
-/** POST /bookings (member) */
-interface CreateBookingDto {
-    expertId: string;
-    startAt: string;
-    endAt: string;
-}
-/** POST /bookings/status (expert) */
-interface UpdateBookingStatusDto {
-    bookingId: string;
-    status: BookingStatus;
-}
-/** Booking entity */
-interface Booking {
-    id: string;
-    memberId: string;
-    expertId: string;
-    startAt: string;
-    endAt: string;
-    status: BookingStatus;
-    createdAt: string;
-}
-
 /** Single availability slot (day + time range) */
 interface AvailabilitySlotDto {
     dayOfWeek: number;
@@ -338,6 +339,40 @@ interface ExpertAvailabilityResponse {
     exceptions: ExpertAvailabilityException[];
 }
 
+/** POST /bookings (member) */
+interface CreateBookingDto {
+    expertId: string;
+    startAt: string;
+    endAt: string;
+}
+/** POST /bookings/status (expert) */
+interface UpdateBookingStatusDto {
+    bookingId: string;
+    status: BookingStatus;
+}
+/** Booking entity */
+interface Booking {
+    id: string;
+    memberId: string;
+    expertId: string;
+    startAt: string;
+    endAt: string;
+    status: BookingStatus;
+    createdAt: string;
+}
+/** Booking with expert (e.g. GET /bookings/me/member) */
+interface BookingWithExpert extends Booking {
+    expert: Expert & {
+        user: User;
+    };
+}
+/** Booking with member (e.g. GET /bookings/me/expert) */
+interface BookingWithMember extends Booking {
+    member: Member & {
+        user: User;
+    };
+}
+
 /** PATCH /admin/gym */
 interface UpdateGymDto {
     name?: string;
@@ -394,6 +429,11 @@ interface StaffWithUser extends Staff {
 interface ExpertWithUser extends Expert {
     user: User;
 }
+/** Booking with member and expert (e.g. GET /admin/bookings) */
+interface BookingWithMemberAndExpert extends Booking {
+    member: MemberWithUser;
+    expert: ExpertWithUser;
+}
 
 /** Notification entity */
 interface Notification {
@@ -537,246 +577,79 @@ type RouteMethod<R> = R extends RouteDef<infer M, unknown, unknown> ? M : never;
 type RoutePath<R> = R extends RouteDef<HttpMethod, unknown, unknown> ? R['path'] : never;
 declare const apiRoutes: {
     readonly auth: {
-        readonly register: {
-            method: "POST";
-            path: string;
-            _req: RegisterDto;
-            _res: RegisterResponse;
-        };
-        readonly login: {
-            method: "POST";
-            path: string;
-            _req: LoginDto;
-            _res: AuthResponse;
-        };
-        readonly deleteMe: {
-            method: "DELETE";
-            path: string;
-        };
+        readonly register: RouteDef<"POST", RegisterDto, RegisterResponse>;
+        readonly login: RouteDef<"POST", LoginDto, AuthResponse>;
+        readonly deleteMe: RouteDef<"DELETE", void, SuccessResponse>;
     };
     readonly members: {
-        readonly join: {
-            method: "POST";
-            path: string;
-            _req: JoinGymDto;
-            _res: MemberWithGym;
-        };
-        readonly me: {
-            method: "GET";
-            path: string;
-        };
-        readonly updateMe: {
-            method: "PATCH";
-            path: string;
-            _req: UpdateMemberProfileDto;
-            _res: GetMeResponse;
-        };
-        readonly meStats: {
-            method: "GET";
-            path: string;
-        };
+        readonly join: RouteDef<"POST", JoinGymDto, MemberWithGym>;
+        readonly me: RouteDef<"GET", void, GetMeResponse>;
+        readonly updateMe: RouteDef<"PATCH", UpdateMemberProfileDto, GetMeResponse>;
+        readonly meStats: RouteDef<"GET", void, MemberStatsResponse>;
     };
     readonly checkIns: {
-        readonly create: {
-            method: "POST";
-            path: string;
-            _req: CreateCheckInDto;
-            _res: CheckIn;
-        };
+        readonly create: RouteDef<"POST", CreateCheckInDto, CheckIn>;
     };
     readonly leaderboards: {
-        readonly list: {
-            method: "GET";
-            path: string;
-        };
-        readonly create: {
-            method: "POST";
-            path: string;
-            _req: CreateLeaderboardDto;
-            _res: Leaderboard;
-        };
-        readonly submitEntry: {
-            method: "POST";
-            path: string;
-            _req: SubmitEntryDto;
-            _res: unknown;
-        };
-        readonly reviewEntry: {
-            method: "POST";
-            path: string;
-            _req: ReviewEntryDto;
-            _res: SuccessResponse;
-        };
+        readonly list: RouteDef<"GET", void, PaginatedResponse<LeaderboardWithEntries>>;
+        readonly create: RouteDef<"POST", CreateLeaderboardDto, Leaderboard>;
+        readonly submitEntry: RouteDef<"POST", SubmitEntryDto, unknown>;
+        readonly reviewEntry: RouteDef<"POST", ReviewEntryDto, SuccessResponse>;
     };
     readonly challenges: {
-        readonly create: {
-            method: "POST";
-            path: string;
-            _req: CreateChallengeDto;
-            _res: Challenge;
-        };
-        readonly createOccurrence: {
-            method: "POST";
-            path: string;
-            _req: CreateOccurrenceDto;
-            _res: ChallengeOccurrence;
-        };
-        readonly meActive: {
-            method: "GET";
-            path: string;
-        };
-        readonly join: {
-            method: "POST";
-            path: string;
-            _req: JoinChallengeDto;
-            _res: unknown;
-        };
-        readonly complete: {
-            method: "POST";
-            path: string;
-            _req: CompleteChallengeDto;
-            _res: unknown;
-        };
+        readonly list: RouteDef<"GET", void, PaginatedResponse<ChallengeWithOccurrences>>;
+        readonly create: RouteDef<"POST", CreateChallengeDto, Challenge>;
+        readonly createOccurrence: RouteDef<"POST", CreateOccurrenceDto, ChallengeOccurrence>;
+        readonly meActive: RouteDef<"GET", void, ChallengeOccurrenceWithDetails[]>;
+        readonly join: RouteDef<"POST", JoinChallengeDto, unknown>;
+        readonly complete: RouteDef<"POST", CompleteChallengeDto, unknown>;
     };
     readonly bookings: {
-        readonly create: {
-            method: "POST";
-            path: string;
-            _req: CreateBookingDto;
-            _res: Booking;
-        };
-        readonly updateStatus: {
-            method: "POST";
-            path: string;
-            _req: UpdateBookingStatusDto;
-            _res: Booking;
-        };
-        readonly meMember: {
-            method: "GET";
-            path: string;
-        };
-        readonly meExpert: {
-            method: "GET";
-            path: string;
-        };
+        readonly create: RouteDef<"POST", CreateBookingDto, Booking>;
+        readonly updateStatus: RouteDef<"POST", UpdateBookingStatusDto, Booking>;
+        readonly meMember: RouteDef<"GET", void, PaginatedResponse<BookingWithExpert>>;
+        readonly meExpert: RouteDef<"GET", void, PaginatedResponse<BookingWithMember>>;
     };
     readonly rewards: {
-        readonly list: {
-            method: "GET";
-            path: string;
-        };
-        readonly me: {
-            method: "GET";
-            path: string;
-        };
+        readonly list: RouteDef<"GET", void, PaginatedResponse<Reward>>;
+        readonly me: RouteDef<"GET", void, MemberReward[]>;
     };
     readonly experts: {
-        readonly list: {
-            method: "GET";
-            path: string;
-        };
-        readonly me: {
-            method: "GET";
-            path: string;
-        };
+        readonly list: RouteDef<"GET", void, PaginatedResponse<Expert>>;
+        readonly me: RouteDef<"GET", void, Expert>;
         readonly availability: (id: string) => RouteDef<"GET", void, ExpertAvailabilityResponse>;
-        readonly meAvailability: {
-            method: "POST";
-            path: string;
-            _req: SetAvailabilityDto;
-            _res: ExpertAvailability[];
-        };
-        readonly meAvailabilityExceptions: {
-            method: "POST";
-            path: string;
-            _req: SetAvailabilityExceptionDto;
-            _res: unknown;
-        };
+        readonly meAvailability: RouteDef<"POST", SetAvailabilityDto, ExpertAvailability[]>;
+        readonly meAvailabilityExceptions: RouteDef<"POST", SetAvailabilityExceptionDto, unknown>;
     };
     readonly notifications: {
-        readonly me: {
-            method: "GET";
-            path: string;
-        };
-        readonly meReadAll: {
-            method: "POST";
-            path: string;
-        };
+        readonly me: RouteDef<"GET", void, Notification[]>;
+        readonly meReadAll: RouteDef<"POST", void, SuccessResponse>;
     };
     readonly activities: {
-        readonly me: {
-            method: "GET";
-            path: string;
-        };
+        readonly me: RouteDef<"GET", void, Activity[]>;
     };
     readonly media: {
-        readonly upload: {
-            method: "POST";
-            path: string;
-            _res: Media;
-        };
+        readonly upload: RouteDef<"POST", unknown, Media>;
         readonly delete: (id: string) => RouteDef<"DELETE", void, SuccessResponse>;
     };
     readonly admin: {
-        readonly summary: {
-            method: "GET";
-            path: string;
-        };
-        readonly gym: {
-            method: "GET";
-            path: string;
-        };
-        readonly updateGym: {
-            method: "PATCH";
-            path: string;
-            _req: UpdateGymDto;
-            _res: Gym;
-        };
-        readonly members: {
-            method: "GET";
-            path: string;
-        };
-        readonly createMember: {
-            method: "POST";
-            path: string;
-            _req: AddMemberDto;
-            _res: MemberWithUser;
-        };
-        readonly rewards: {
-            method: "GET";
-            path: string;
-        };
-        readonly createReward: {
-            method: "POST";
-            path: string;
-            _req: CreateRewardDto;
-            _res: Reward;
-        };
+        readonly summary: RouteDef<"GET", void, AdminSummaryResponse>;
+        readonly gym: RouteDef<"GET", void, Gym>;
+        readonly updateGym: RouteDef<"PATCH", UpdateGymDto, Gym>;
+        readonly members: RouteDef<"GET", void, PaginatedResponse<MemberWithUser>>;
+        readonly createMember: RouteDef<"POST", AddMemberDto, MemberWithUser>;
+        readonly rewards: RouteDef<"GET", void, PaginatedResponse<Reward>>;
+        readonly createReward: RouteDef<"POST", CreateRewardDto, Reward>;
         readonly updateReward: (id: string) => RouteDef<"PATCH", UpdateRewardDto, Reward>;
         readonly deleteReward: (id: string) => RouteDef<"DELETE", void, SuccessResponse>;
-        readonly staff: {
-            method: "GET";
-            path: string;
-        };
-        readonly createStaff: {
-            method: "POST";
-            path: string;
-            _req: AddStaffDto;
-            _res: StaffWithUser;
-        };
+        readonly staff: RouteDef<"GET", void, PaginatedResponse<StaffWithUser>>;
+        readonly createStaff: RouteDef<"POST", AddStaffDto, StaffWithUser>;
         readonly deleteStaff: (userId: string) => RouteDef<"DELETE", void, SuccessResponse>;
         readonly disableStaff: (userId: string) => RouteDef<"PATCH", void, SuccessResponse>;
         readonly enableStaff: (userId: string) => RouteDef<"PATCH", void, SuccessResponse>;
-        readonly experts: {
-            method: "GET";
-            path: string;
-        };
-        readonly createExpert: {
-            method: "POST";
-            path: string;
-            _req: AddExpertDto;
-            _res: ExpertWithUser;
-        };
+        readonly experts: RouteDef<"GET", void, PaginatedResponse<ExpertWithUser>>;
+        readonly bookings: RouteDef<"GET", void, PaginatedResponse<BookingWithMemberAndExpert>>;
+        readonly createExpert: RouteDef<"POST", AddExpertDto, ExpertWithUser>;
         readonly deleteExpert: (userId: string) => RouteDef<"DELETE", void, SuccessResponse>;
         readonly disableExpert: (userId: string) => RouteDef<"PATCH", void, SuccessResponse>;
         readonly enableExpert: (userId: string) => RouteDef<"PATCH", void, SuccessResponse>;
@@ -839,4 +712,4 @@ declare function createApi(client: AthosHttpClient, baseUrl?: string): {
     request<R extends RouteDef<HttpMethod, unknown, unknown>>(route: R, body?: RequestBody<R>): Promise<ResponseBody<R>>;
 };
 
-export { type Activity, type AddExpertDto, type AddMemberDto, type AddStaffDto, type AdminSummaryResponse, type AthosHttpClient, type AuthResponse, type AvailabilitySlotDto, type Booking, BookingStatus, type Challenge, type ChallengeOccurrence, type ChallengeOccurrenceWithDetails, type ChallengeParticipation, ChallengeVerificationType, type CheckIn, type CompleteChallengeDto, type CreateBookingDto, type CreateChallengeDto, type CreateCheckInDto, type CreateLeaderboardDto, type CreateOccurrenceDto, type CreateRewardDto, type Expert, type ExpertAvailability, type ExpertAvailabilityException, type ExpertAvailabilityResponse, ExpertRole, type ExpertWithUser, type GetMeResponse, type Gym, type HttpMethod, type JoinChallengeDto, type JoinGymDto, type Leaderboard, type LeaderboardEntry, LeaderboardEntryStatus, type LeaderboardWithEntries, type Level, type LoginDto, type Media, type Member, type MemberReward, type MemberStatsResponse, type MemberWithGym, type MemberWithUser, type Notification, ROUTES, type RegisterDto, type RegisterResponse, type RequestBody, type ResponseBody, type ReviewEntryDto, type Reward, type RouteDef, type RouteMethod, type RoutePath, type Routes, type SetAvailabilityDto, type SetAvailabilityExceptionDto, type Staff, type StaffWithUser, type SubmitEntryDto, type SuccessResponse, type UpdateBookingStatusDto, type UpdateGymDto, type UpdateMemberProfileDto, type UpdateRewardDto, type User, type UserWithRoles, apiRoutes, createApi, request };
+export { type Activity, type AddExpertDto, type AddMemberDto, type AddStaffDto, type AdminSummaryResponse, type AthosHttpClient, type AuthResponse, type AvailabilitySlotDto, type Booking, BookingStatus, type BookingWithExpert, type BookingWithMember, type BookingWithMemberAndExpert, type Challenge, type ChallengeOccurrence, type ChallengeOccurrenceWithDetails, type ChallengeParticipation, ChallengeVerificationType, type ChallengeWithOccurrences, type CheckIn, type CompleteChallengeDto, type CreateBookingDto, type CreateChallengeDto, type CreateCheckInDto, type CreateLeaderboardDto, type CreateOccurrenceDto, type CreateRewardDto, type Expert, type ExpertAvailability, type ExpertAvailabilityException, type ExpertAvailabilityResponse, ExpertRole, type ExpertWithUser, type GetMeResponse, type Gym, type HttpMethod, type JoinChallengeDto, type JoinGymDto, type Leaderboard, type LeaderboardEntry, LeaderboardEntryStatus, type LeaderboardWithEntries, type Level, type LoginDto, type Media, type Member, type MemberReward, type MemberStatsResponse, type MemberWithGym, type MemberWithUser, type Notification, type PaginatedResponse, type PaginationMeta, type PaginationQuery, ROUTES, type RegisterDto, type RegisterResponse, type RequestBody, type ResponseBody, type ReviewEntryDto, type Reward, type RouteDef, type RouteMethod, type RoutePath, type Routes, type SetAvailabilityDto, type SetAvailabilityExceptionDto, type Staff, type StaffWithUser, type SubmitEntryDto, type SuccessResponse, type UpdateBookingStatusDto, type UpdateGymDto, type UpdateMemberProfileDto, type UpdateRewardDto, type User, type UserWithRoles, apiRoutes, createApi, request };