@taiger-common/model 1.0.50 → 1.0.51

package/dist/types/api/documentThreads.d.ts

@@ -0,0 +1,68 @@
+import type { ApiResponse, SuccessResponse } from './common';
+import type { IDocumentthreadWithId, ISurveyInputWithId, IUserWithId, IAuditWithId } from './serialized';
+/** Favorite toggle result */
+export interface ThreadFavoriteData {
+    isFlagged: boolean;
+}
+/**
+ * GET /api/document-threads/:documentsthreadId
+ * Non-standard: returns multiple top-level fields
+ */
+export interface GetMessagesThreadResponse {
+    success: boolean;
+    data?: IDocumentthreadWithId;
+    similarThreads?: IDocumentthreadWithId[];
+    agents?: IUserWithId[];
+    editors?: IUserWithId[];
+    threadAuditLog?: IAuditWithId[];
+    deadline?: unknown;
+    conflict_list?: unknown[];
+}
+/** GET /api/document-threads/overview/all */
+export type GetActiveThreadsResponse = ApiResponse<IDocumentthreadWithId[]>;
+/** GET /api/document-threads/student-threads/:studentId */
+export type GetThreadsByStudentResponse = ApiResponse<IDocumentthreadWithId[]>;
+/**
+ * GET /api/document-threads/overview/taiger-user/:userId
+ * Non-standard: data is an object with threads + user
+ */
+export type GetMyStudentThreadsResponse = ApiResponse<{
+    threads: IDocumentthreadWithId[];
+    user: IUserWithId;
+}>;
+/** GET /api/document-threads/overview/my-student-metrics */
+export type GetMyStudentThreadMetricsResponse = ApiResponse<unknown>;
+/** PUT /api/document-threads/:documentsthreadId/favorite */
+export type PutThreadFavoriteResponse = ApiResponse<ThreadFavoriteData>;
+/** PUT /api/document-threads/:documentsthreadId/:studentId (set as final) */
+export type SetFileFinalResponse = ApiResponse<IDocumentthreadWithId>;
+/** POST /api/document-threads/init/general/:studentId/:document_catgory */
+export type InitGeneralThreadResponse = ApiResponse<IDocumentthreadWithId>;
+/** POST /api/document-threads/init/application/:studentId/:applicationId/:document_catgory */
+export type InitApplicationThreadResponse = ApiResponse<IDocumentthreadWithId>;
+/** POST /api/document-threads/:documentsthreadId/:studentId (submit message) */
+export type SubmitMessageResponse = ApiResponse<IDocumentthreadWithId>;
+/** DELETE /api/document-threads/:documentsthreadId/:studentId */
+export type DeleteGeneralFileThreadResponse = SuccessResponse;
+/** DELETE /api/document-threads/:documentsthreadId/:application_id/:studentId */
+export type DeleteProgramSpecificFileThreadResponse = SuccessResponse;
+/** DELETE /api/document-threads/delete/:documentsthreadId/:messageId */
+export type DeleteMessageInThreadResponse = SuccessResponse;
+/** POST /api/document-threads/:documentsthreadId/essay */
+export type UpdateEssayWriterResponse = ApiResponse<IDocumentthreadWithId>;
+/** POST /api/document-threads/image/:documentsthreadId/:studentId */
+export type UploadDocumentThreadImageResponse = ApiResponse<IDocumentthreadWithId>;
+/** PUT /api/document-threads/:documentsthreadId/:studentId/origin-author */
+export type PutOriginAuthorConfirmedResponse = ApiResponse<IDocumentthreadWithId>;
+/** PUT /api/document-threads/:documentThreadId/:documentsthreadMessageId/:ignoreMessageState/ignored */
+export type IgnoreMessageThreadResponse = ApiResponse<IDocumentthreadWithId>;
+/** GET /api/document-threads/pattern/check/:thread_id/:file_type */
+export type GetCheckDocumentPatternResponse = ApiResponse<unknown>;
+/** GET /api/document-threads/:documentsthreadId/survey-inputs */
+export type GetSurveyInputsResponse = ApiResponse<ISurveyInputWithId>;
+/** POST /api/document-threads/survey-input/ */
+export type PostSurveyInputResponse = ApiResponse<ISurveyInputWithId>;
+/** PUT /api/document-threads/survey-input/:surveyId */
+export type PutSurveyInputResponse = ApiResponse<ISurveyInputWithId>;
+/** DELETE /api/document-threads/survey-input/:surveyId */
+export type DeleteSurveyInputResponse = SuccessResponse;

package/dist/types/api/documentations.d.ts

@@ -0,0 +1,44 @@
+import type { ApiResponse, SuccessResponse } from './common';
+import type { IDocumentationWithId, IDocspageWithId, IInternaldocWithId } from './serialized';
+/** GET /api/docs/:category */
+export type GetCategorizedDocumentationResponse = ApiResponse<IDocumentationWithId[]>;
+/** GET /api/docs/all */
+export type GetAllDocumentationsResponse = ApiResponse<IDocumentationWithId[]>;
+/** GET /api/docs/search/:doc_id */
+export type GetDocumentationResponse = ApiResponse<IDocumentationWithId>;
+/** POST /api/docs */
+export type CreateDocumentationResponse = ApiResponse<IDocumentationWithId>;
+/** PUT /api/docs/:doc_id */
+export type UpdateDocumentationResponse = ApiResponse<IDocumentationWithId>;
+/** DELETE /api/docs/:doc_id */
+export type DeleteDocumentationResponse = SuccessResponse;
+/** GET /api/docs/pages/:category */
+export type GetDocspageResponse = ApiResponse<IDocspageWithId | Record<string, never>>;
+/** PUT /api/docs/pages/:category */
+export type UpdateDocspageResponse = ApiResponse<IDocspageWithId>;
+/** GET /api/docs/internal/all */
+export type GetAllInternalDocumentationsResponse = ApiResponse<IInternaldocWithId[]>;
+/** GET /api/docs/internal/search/:doc_id */
+export type GetInternaldocResponse = ApiResponse<IInternaldocWithId>;
+/** GET /api/docs/taiger/internal/confidential */
+export type GetInternalDocumentationPageResponse = ApiResponse<IDocspageWithId | Record<string, never>>;
+/** PUT /api/docs/taiger/internal/confidential */
+export type UpdateInternalDocumentationPageResponse = ApiResponse<IDocspageWithId>;
+/** POST /api/docs/internal */
+export type CreateInternaldocResponse = ApiResponse<IInternaldocWithId>;
+/** PUT /api/docs/internal/:doc_id */
+export type UpdateInternaldocResponse = ApiResponse<IInternaldocWithId>;
+/** DELETE /api/docs/internal/:doc_id */
+export type DeleteInternaldocResponse = SuccessResponse;
+/** POST /api/docs/upload/image — returns image URL */
+export type UploadDocImageResponse = ApiResponse<string>;
+/**
+ * POST /api/docs/upload/docs
+ * Non-standard: returns url, title, extension alongside success
+ */
+export interface UploadDocDocsResponse {
+    success: boolean;
+    url?: string;
+    title?: string;
+    extension?: string;
+}

package/dist/types/api/events.d.ts

@@ -0,0 +1,35 @@
+import type { ApiResponse, SuccessResponse } from './common';
+import type { IEventWithId, IUserWithId } from './serialized';
+/**
+ * GET /api/events
+ * Non-standard: returns agents/editors alongside event data
+ */
+export interface GetEventsResponse {
+    success: boolean;
+    agents?: IUserWithId[];
+    editors?: IUserWithId[];
+    data?: IEventWithId[];
+    hasEvents?: boolean;
+}
+/** GET /api/events/booked */
+export type GetBookedEventsResponse = ApiResponse<IEventWithId[]>;
+/** GET /api/events/ping */
+export type GetActiveEventsNumberResponse = ApiResponse<number>;
+/**
+ * POST /api/events
+ * Same shape as GetEventsResponse
+ */
+export type PostEventResponse = GetEventsResponse;
+/** GET (single event) */
+export type GetEventResponse = ApiResponse<IEventWithId>;
+/** PUT /api/events/:event_id/confirm */
+export type ConfirmEventResponse = ApiResponse<IEventWithId>;
+/** PUT /api/events/:event_id */
+export type UpdateEventResponse = ApiResponse<IEventWithId>;
+/**
+ * DELETE /api/events/:event_id
+ * Returns updated events list
+ */
+export type DeleteEventResponse = GetEventsResponse;
+/** PUT /api/account/profile/officehours/:user_id */
+export type UpdateOfficehoursResponse = SuccessResponse;

package/dist/types/api/index.d.ts

@@ -0,0 +1,25 @@
+export * from './common';
+export * from './serialized';
+export * from './auth';
+export * from './users';
+export * from './students';
+export * from './programs';
+export * from './applications';
+export * from './communications';
+export * from './documentThreads';
+export * from './interviews';
+export * from './meetings';
+export * from './tickets';
+export * from './events';
+export * from './teams';
+export * from './documentations';
+export * from './programRequirements';
+export * from './courses';
+export * from './crm';
+export * from './account';
+export * from './audit';
+export * from './search';
+export * from './portals';
+export * from './notes';
+export * from './permissions';
+export * from './widgets';

package/dist/types/api/interviews.d.ts

@@ -0,0 +1,47 @@
+import type { ApiResponse, SuccessResponse } from './common';
+import type { IInterviewWithId, IInterviewSurveyResponseWithId, IStudentResponse, IAuditWithId } from './serialized';
+/** GET /api/interviews, GET /api/interviews/open */
+export type GetInterviewsResponse = ApiResponse<IInterviewWithId[]>;
+/**
+ * GET /api/interviews/:interview_id
+ * Non-standard: also returns interviewAuditLog
+ */
+export interface GetInterviewResponse {
+    success: boolean;
+    data?: IInterviewWithId;
+    interviewAuditLog?: IAuditWithId[];
+}
+/**
+ * GET /api/interviews/my-interviews
+ * Non-standard: returns students or student alongside data
+ */
+export interface GetMyInterviewsResponse {
+    success: boolean;
+    data?: IInterviewWithId[];
+    students?: IStudentResponse[];
+    student?: IStudentResponse;
+}
+/** GET /api/interviews/interview/:program_id */
+export interface GetInterviewsByProgramIdResponse {
+    success: boolean;
+    data?: IInterviewWithId[];
+    count?: number;
+}
+/** GET /api/interviews/interviews/:student_id */
+export interface GetInterviewsByStudentIdResponse {
+    success: boolean;
+    data?: IInterviewWithId[];
+    count?: number;
+}
+/** GET /api/interviews/:interview_id/survey */
+export type GetInterviewSurveyResponse = ApiResponse<IInterviewSurveyResponseWithId>;
+/** PUT /api/interviews/:interview_id/survey */
+export type UpdateInterviewSurveyResponse = ApiResponse<IInterviewSurveyResponseWithId>;
+/** POST /api/interviews/create/:program_id/:student_id */
+export type CreateInterviewResponse = SuccessResponse;
+/** DELETE /api/interviews/:interview_id */
+export type DeleteInterviewResponse = SuccessResponse;
+/** PUT /api/interviews/:interview_id */
+export type UpdateInterviewResponse = ApiResponse<IInterviewWithId>;
+/** POST /api/interviews/time/:interview_id */
+export type AddInterviewTrainingDateTimeResponse = SuccessResponse;

package/dist/types/api/meetings.d.ts

@@ -0,0 +1,31 @@
+import type { ApiResponse, SuccessResponse } from './common';
+/**
+ * Student meeting — no dedicated Mongoose model.
+ * Represents a scheduled meeting between a student and a TaiGer staff member.
+ */
+export interface IMeeting {
+    _id: string;
+    title?: string;
+    dateTime?: string | Date;
+    location?: string;
+    description?: string;
+    notes?: string;
+    isConfirmed?: boolean;
+    isConfirmedReceiver?: boolean;
+    isConfirmedRequester?: boolean;
+    attended?: boolean;
+    meetingLink?: string;
+    requester_id?: string[];
+    receiver_id?: string[];
+    [key: string]: unknown;
+}
+/** GET /api/students/:studentId/meetings */
+export type GetStudentMeetingsResponse = ApiResponse<IMeeting[]>;
+/** GET /api/students/:studentId/meetings/:meetingId */
+export type GetStudentMeetingResponse = ApiResponse<IMeeting>;
+/** POST /api/students/:studentId/meetings */
+export type CreateStudentMeetingResponse = ApiResponse<IMeeting>;
+/** PUT /api/students/:studentId/meetings/:meetingId */
+export type UpdateStudentMeetingResponse = ApiResponse<IMeeting>;
+/** DELETE /api/students/:studentId/meetings/:meetingId */
+export type DeleteStudentMeetingResponse = SuccessResponse;

package/dist/types/api/notes.d.ts

@@ -0,0 +1,6 @@
+import type { ApiResponse } from './common';
+import type { INoteWithId } from './serialized';
+/** GET /api/notes/:student_id */
+export type GetStudentNotesResponse = ApiResponse<INoteWithId>;
+/** PUT /api/notes/:student_id */
+export type UpdateStudentNotesResponse = ApiResponse<INoteWithId>;

package/dist/types/api/permissions.d.ts

@@ -0,0 +1,6 @@
+import type { ApiResponse } from './common';
+import type { IPermissionWithId } from './serialized';
+/** GET /api/permissions (all permissions) */
+export type GetUserPermissionsResponse = ApiResponse<IPermissionWithId[]>;
+/** POST /api/permissions/:taiger_user_id */
+export type UpdateUserPermissionResponse = ApiResponse<IPermissionWithId>;

package/dist/types/api/portals.d.ts

@@ -0,0 +1,23 @@
+import type { ApiResponse } from './common';
+import type { IApplicationWithId } from './serialized';
+/** Student summary shape nested inside portal credentials response */
+export interface PortalCredentialsStudent {
+    _id?: string;
+    firstname?: string;
+    lastname?: string;
+    agents?: unknown[];
+    editors?: unknown[];
+}
+/**
+ * GET /api/portal-informations/:student_id
+ * Non-standard: data is an object, not a single document
+ */
+export interface GetPortalCredentialsResponse {
+    success: boolean;
+    data?: {
+        applications: IApplicationWithId[];
+        student: PortalCredentialsStudent;
+    };
+}
+/** POST /api/portal-informations/:student_id/:applicationId */
+export type CreatePortalCredentialsResponse = ApiResponse<IApplicationWithId>;

package/dist/types/api/programRequirements.d.ts

@@ -0,0 +1,29 @@
+import type { ApiResponse, SuccessResponse } from './common';
+import type { IProgramrequirementWithId, IProgramWithId, IKeywordsetWithId } from './serialized';
+/** Payload returned by GET /api/program-requirements/programs-and-keywords */
+export interface ProgramsAndKeywordsData {
+    distinctPrograms?: IProgramWithId[];
+    keywordsets?: IKeywordsetWithId[];
+}
+/** GET /api/program-requirements */
+export type GetProgramRequirementsResponse = ApiResponse<IProgramrequirementWithId[]>;
+/**
+ * GET /api/program-requirements/:programRequirementId
+ * Non-standard: data wraps requirement + supporting lists
+ */
+export interface GetProgramRequirementResponse {
+    success: boolean;
+    data?: {
+        requirement: IProgramrequirementWithId;
+        distinctPrograms?: IProgramWithId[];
+        keywordsets?: IKeywordsetWithId[];
+    };
+}
+/** GET /api/program-requirements/programs-and-keywords */
+export type GetProgramsAndKeywordSetsResponse = ApiResponse<ProgramsAndKeywordsData>;
+/** POST /api/program-requirements/new */
+export type CreateProgramRequirementResponse = ApiResponse<IProgramrequirementWithId>;
+/** PUT /api/program-requirements/:programRequirementId */
+export type UpdateProgramRequirementResponse = ApiResponse<IProgramrequirementWithId>;
+/** DELETE /api/program-requirements/:programRequirementId */
+export type DeleteProgramRequirementResponse = SuccessResponse;

package/dist/types/api/programs.d.ts

@@ -0,0 +1,123 @@
+import type { ApiResponse, SuccessResponse } from './common';
+import type { IProgramWithId, IStudentResponse } from './serialized';
+/** { school, country, city, programCount } */
+export interface SchoolDistributionItem {
+    school?: string;
+    country?: string;
+    city?: string;
+    programCount?: number;
+}
+/** School attribute item from GET /api/programs/schools */
+export interface SchoolAttributeItem {
+    school?: string;
+    isPrivateSchool?: boolean;
+    isPartnerSchool?: boolean;
+    schoolType?: string;
+    country?: string;
+    tags?: string[];
+    count?: number;
+}
+/** Top-applying program in the programs overview */
+export interface TopApplicationProgram {
+    programId?: string;
+    school?: string;
+    program_name?: string;
+    degree?: string;
+    semester?: string;
+    country?: string;
+    totalApplications?: number;
+    submittedCount?: number;
+    admittedCount?: number;
+    rejectedCount?: number;
+    pendingCount?: number;
+    admissionRate?: number;
+}
+/** Recently updated program entry */
+export interface RecentlyUpdatedProgram {
+    school?: string;
+    program_name?: string;
+    degree?: string;
+    semester?: string;
+    updatedAt?: Date | string;
+    whoupdated?: string;
+}
+/** Full programs overview payload */
+export interface ProgramsOverviewData {
+    totalPrograms?: number;
+    totalSchools?: number;
+    byCountry?: Array<{
+        country?: string;
+        count?: number;
+    }>;
+    byDegree?: Array<{
+        degree?: string;
+        count?: number;
+    }>;
+    byLanguage?: Array<{
+        language?: string;
+        count?: number;
+    }>;
+    bySubject?: Array<{
+        subject?: string;
+        count?: number;
+    }>;
+    bySchoolType?: Array<{
+        schoolType?: string;
+        isPrivateSchool?: boolean;
+        isPartnerSchool?: boolean;
+        count?: number;
+    }>;
+    topSchools?: SchoolDistributionItem[];
+    topContributors?: Array<{
+        contributor?: string;
+        updateCount?: number;
+        lastUpdate?: Date | string;
+    }>;
+    recentlyUpdated?: RecentlyUpdatedProgram[];
+    topApplicationPrograms?: TopApplicationProgram[];
+    generatedAt?: Date;
+}
+/** GET /api/programs */
+export type GetProgramsResponse = ApiResponse<IProgramWithId[]>;
+/** GET /api/programs/overview */
+export type GetProgramsOverviewResponse = ApiResponse<ProgramsOverviewData>;
+/**
+ * GET /api/programs/:programId
+ * Non-standard: has extra top-level fields beyond `data`
+ */
+export interface GetProgramResponse {
+    success: boolean;
+    data: IProgramWithId;
+    students?: IStudentResponse[];
+    vc?: unknown[];
+}
+/** POST /api/programs */
+export type CreateProgramResponse = ApiResponse<IProgramWithId>;
+/**
+ * PUT /api/programs/:id
+ * Non-standard: also returns vc (version control)
+ */
+export interface UpdateProgramResponse {
+    success: boolean;
+    data?: IProgramWithId;
+    vc?: unknown[];
+}
+/** DELETE /api/programs/:program_id */
+export type DeleteProgramResponse = SuccessResponse;
+/** GET /api/programs/schools-distribution */
+export type GetSchoolsDistributionResponse = ApiResponse<SchoolDistributionItem[]>;
+/** GET /api/programs/schools */
+export type GetDistinctSchoolsResponse = ApiResponse<SchoolAttributeItem[]>;
+/** PUT /api/programs/schools */
+export type UpdateSchoolAttributesResponse = SuccessResponse;
+/** GET /api/programs/same-program-students/:programId */
+export type GetSameProgramStudentsResponse = ApiResponse<IStudentResponse[]>;
+/** GET /api/programs/:programId/change-requests */
+export type GetProgramChangeRequestsResponse = ApiResponse<unknown[]>;
+/** POST /api/programs/review-changes/:requestId */
+export type ReviewProgramChangeRequestsResponse = SuccessResponse;
+/**
+ * POST /api/programs/:programId/refresh
+ * Same shape as UpdateProgramResponse
+ */
+export type RefreshProgramResponse = UpdateProgramResponse;

package/dist/types/api/search.d.ts

@@ -0,0 +1,26 @@
+import type { ApiResponse } from './common';
+import type { IDocumentationWithId, ICommunicationWithId } from './serialized';
+/** A mixed search result item (may be a student, doc, program, etc.) */
+export interface SearchResultItem {
+    score?: number;
+    [key: string]: unknown;
+}
+/** A student search result with basic identity fields */
+export interface StudentSearchResult {
+    _id?: string;
+    firstname?: string;
+    lastname?: string;
+    firstname_chinese?: string;
+    lastname_chinese?: string;
+    role?: string;
+    email?: string;
+    score?: number;
+}
+/** GET /api/search?q= */
+export type GetQueryResultsResponse = ApiResponse<SearchResultItem[]>;
+/** GET /api/search/public?q= */
+export type GetQueryPublicResultsResponse = ApiResponse<IDocumentationWithId[]>;
+/** GET /api/search/students?q= */
+export type GetQueryStudentsResultsResponse = ApiResponse<StudentSearchResult[]>;
+/** GET /api/communications?q= (student-side search) */
+export type GetQueryStudentResultsResponse = ApiResponse<ICommunicationWithId[]>;

package/dist/types/api/serialized.d.ts

@@ -0,0 +1,130 @@
+/**
+ * Serialized "API layer" versions of core model interfaces.
+ * All ObjectId refs become strings to match JSON API serialization.
+ */
+import type { IStudent, IUserGeneraldocsThread, IUserAcademicBackgroundUniversity, IUserAcademicBackgroundLanguage, IUserApplicationPreference, IUserAttribute, IUserNotification, IUserTaigerai, IUserProfileItem } from '../model/User';
+import type { IProgram } from '../model/Program';
+import type { IApplication } from '../model/Application';
+import type { ICourse } from '../model/Course';
+import type { IDocumentthread } from '../model/Documentthread';
+import type { ICommunication } from '../model/Communication';
+import type { IInterview } from '../model/Interview';
+import type { IInterviewSurveyResponse } from '../model/InterviewSurveyResponse';
+import type { ITicket } from '../model/Ticket';
+import type { IComplaint } from '../model/Complaint';
+import type { IAudit } from '../model/Audit';
+import type { IEvent } from '../model/Event';
+import type { INote } from '../model/Note';
+import type { IPermission } from '../model/Permission';
+import type { IDocumentation } from '../model/Documentation';
+import type { IDocspage } from '../model/Docspage';
+import type { IInternaldoc } from '../model/Internaldoc';
+import type { IProgramrequirement } from '../model/Programrequirement';
+import type { IAllCourse } from '../model/Allcourse';
+import type { IKeywordset } from '../model/Keywordset';
+import type { ISurveyInput } from '../model/SurveyInput';
+import type { ITemplate } from '../model/Template';
+import type { IBasedocumentationslink } from '../model/Basedocumentationslink';
+export type { IUserAcademicBackgroundUniversity, IUserAcademicBackgroundLanguage, IUserApplicationPreference, IUserAttribute, IUserNotification, IUserTaigerai, IUserProfileItem, IUserGeneraldocsThread };
+/** Frontend-friendly User/Student with string _id (no nested ObjectId refs) */
+export interface IUserWithId extends Omit<IStudent, 'agents' | 'editors' | 'profile'> {
+    _id: string;
+    courses?: ICourse;
+}
+/** Frontend-friendly Program with string _id */
+export interface IProgramWithId extends Omit<IProgram, 'vcId'> {
+    _id: string;
+    vcId?: string;
+}
+/** Frontend-friendly Application with string _id */
+export interface IApplicationWithId extends IApplication {
+    _id: string;
+}
+/** Student as returned by the API with populated agents, editors, applications */
+export interface IStudentResponse extends IStudent {
+    applying_program_count?: number;
+    applications?: IApplicationWithId[];
+    agents?: IUserWithId[];
+    editors?: IUserWithId[];
+    generaldocs_threads?: IUserGeneraldocsThread[];
+}
+/** Document thread with string _id */
+export interface IDocumentthreadWithId extends IDocumentthread {
+    _id: string;
+}
+/** Communication message with string _id */
+export interface ICommunicationWithId extends ICommunication {
+    _id: string;
+}
+/** Interview with string _id */
+export interface IInterviewWithId extends IInterview {
+    _id: string;
+}
+/** Interview survey response with string _id */
+export interface IInterviewSurveyResponseWithId extends IInterviewSurveyResponse {
+    _id: string;
+}
+/** Ticket with string _id */
+export interface ITicketWithId extends ITicket {
+    _id: string;
+    createdAt?: Date;
+}
+/** Complaint with string _id */
+export interface IComplaintWithId extends IComplaint {
+    _id: string;
+    createdAt?: Date;
+}
+/** Audit record with string _id */
+export interface IAuditWithId extends IAudit {
+    _id: string;
+    createdAt?: Date;
+}
+/** Event with string _id */
+export interface IEventWithId extends IEvent {
+    _id: string;
+    createdAt?: Date;
+}
+/** Note with string _id */
+export interface INoteWithId extends INote {
+    _id: string;
+}
+/** Permission record with string _id */
+export interface IPermissionWithId extends IPermission {
+    _id: string;
+}
+/** Documentation article with string _id */
+export interface IDocumentationWithId extends IDocumentation {
+    _id: string;
+}
+/** Docs page with string _id */
+export interface IDocspageWithId extends IDocspage {
+    _id: string;
+}
+/** Internal doc with string _id */
+export interface IInternaldocWithId extends IInternaldoc {
+    _id: string;
+}
+/** Program requirement with string _id */
+export interface IProgramrequirementWithId extends IProgramrequirement {
+    _id: string;
+}
+/** All-course entry with string _id */
+export interface IAllCourseWithId extends IAllCourse {
+    _id: string;
+}
+/** Keyword set with string _id */
+export interface IKeywordsetWithId extends IKeywordset {
+    _id: string;
+}
+/** Survey input with string _id */
+export interface ISurveyInputWithId extends ISurveyInput {
+    _id: string;
+}
+/** Template with string _id */
+export interface ITemplateWithId extends ITemplate {
+    _id: string;
+}
+/** Base documentation link with string _id */
+export interface IBasedocumentationslinkWithId extends IBasedocumentationslink {
+    _id: string;
+}

package/dist/types/api/students.d.ts

@@ -0,0 +1,42 @@
+import type { ApiResponse, SuccessResponse } from './common';
+import type { IStudentResponse, IBasedocumentationslinkWithId } from './serialized';
+/** GET /api/students, GET /api/students/v3 */
+export type GetStudentsResponse = ApiResponse<IStudentResponse[]>;
+/** GET /api/students/active */
+export type GetActiveStudentsResponse = ApiResponse<IStudentResponse[]>;
+/** GET /api/students/:studentId */
+export type GetStudentResponse = ApiResponse<IStudentResponse>;
+/** GET /api/students/doc-links/:studentId */
+export interface GetStudentDocLinksResponse {
+    success: boolean;
+    data?: IStudentResponse;
+    basedocumentationlinks?: IBasedocumentationslinkWithId[];
+}
+/** GET /api/students/doc-links */
+export type GetStudentsAndDocLinksResponse = ApiResponse<IStudentResponse[]>;
+/** POST /api/students/archiv/:studentId */
+export type UpdateArchivStudentsResponse = ApiResponse<IStudentResponse>;
+/** POST /api/students/:studentId/agents */
+export type UpdateStudentAgentsResponse = ApiResponse<IStudentResponse>;
+/** POST /api/students/:studentId/editors */
+export type UpdateStudentEditorsResponse = ApiResponse<IStudentResponse>;
+/** POST /api/students/:studentId/attributes */
+export type UpdateStudentAttributesResponse = ApiResponse<IStudentResponse>;
+/** POST /api/students/doc-links */
+export type UpdateDocumentationHelperLinkResponse = SuccessResponse;
+/** POST /api/students/:studentId/files/:category */
+export type UploadStudentFileResponse = ApiResponse<IStudentResponse>;
+/** DELETE /api/students/:studentId/files/:category */
+export type DeleteStudentFileResponse = SuccessResponse;
+/** POST /api/students/:studentId/vpd/:applicationId/:fileType */
+export type UploadVPDFileResponse = ApiResponse<IStudentResponse>;
+/** DELETE /api/students/:studentId/vpd/:applicationId/:fileType */
+export type DeleteVPDFileResponse = SuccessResponse;
+/** PUT /api/students/:studentId/vpd/:applicationId/VPD */
+export type SetAsNotNeededResponse = ApiResponse<IStudentResponse>;
+/** POST /api/students/:studentId/vpd/:applicationId/payments */
+export type SetUniAssistPaidResponse = ApiResponse<IStudentResponse>;
+/** POST /api/students/:studentId/:category/status */
+export type UpdateProfileDocStatusResponse = ApiResponse<IStudentResponse>;
+/** GET /api/uniassist/:studentId */
+export type GetStudentUniAssistResponse = ApiResponse<IStudentResponse>;