@taiger-common/model 1.0.53 → 1.0.55

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

@@ -1,18 +1,617 @@
-import type { ApiResponse, SuccessResponse } from './common';
-import type { ICommunicationWithId } from './serialized';
+import { z } from 'zod';
+export declare const GetCommunicationThreadResponseSchema: z.ZodObject<{
+    success: z.ZodBoolean;
+    message: z.ZodOptional<z.ZodString>;
+} & {
+    data: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        student_id: z.ZodOptional<z.ZodString>;
+        user_id: z.ZodOptional<z.ZodString>;
+        message: z.ZodOptional<z.ZodString>;
+        readBy: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        timeStampReadBy: z.ZodOptional<z.ZodUnknown>;
+        files: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            path: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            path: string;
+        }, {
+            name: string;
+            path: string;
+        }>, "many">>;
+        createdAt: z.ZodOptional<z.ZodDate>;
+        ignore_message: z.ZodOptional<z.ZodBoolean>;
+        ignoredMessageUpdatedAt: z.ZodOptional<z.ZodDate>;
+        ignoredMessageBy: z.ZodOptional<z.ZodString>;
+    } & {
+        _id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    }, {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    success: boolean;
+    message?: string | undefined;
+    data?: {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    }[] | undefined;
+}, {
+    success: boolean;
+    message?: string | undefined;
+    data?: {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    }[] | undefined;
+}>;
+export declare const GetMyCommunicationThreadResponseSchema: z.ZodObject<{
+    success: z.ZodBoolean;
+    message: z.ZodOptional<z.ZodString>;
+} & {
+    data: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        student_id: z.ZodOptional<z.ZodString>;
+        user_id: z.ZodOptional<z.ZodString>;
+        message: z.ZodOptional<z.ZodString>;
+        readBy: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        timeStampReadBy: z.ZodOptional<z.ZodUnknown>;
+        files: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            path: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            path: string;
+        }, {
+            name: string;
+            path: string;
+        }>, "many">>;
+        createdAt: z.ZodOptional<z.ZodDate>;
+        ignore_message: z.ZodOptional<z.ZodBoolean>;
+        ignoredMessageUpdatedAt: z.ZodOptional<z.ZodDate>;
+        ignoredMessageBy: z.ZodOptional<z.ZodString>;
+    } & {
+        _id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    }, {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    success: boolean;
+    message?: string | undefined;
+    data?: {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    }[] | undefined;
+}, {
+    success: boolean;
+    message?: string | undefined;
+    data?: {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    }[] | undefined;
+}>;
+export declare const GetCommunicationUnreadNumberResponseSchema: z.ZodObject<{
+    success: z.ZodBoolean;
+    message: z.ZodOptional<z.ZodString>;
+} & {
+    data: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    success: boolean;
+    message?: string | undefined;
+    data?: number | undefined;
+}, {
+    success: boolean;
+    message?: string | undefined;
+    data?: number | undefined;
+}>;
+export declare const PostCommunicationResponseSchema: z.ZodObject<{
+    success: z.ZodBoolean;
+    message: z.ZodOptional<z.ZodString>;
+} & {
+    data: z.ZodOptional<z.ZodObject<{
+        student_id: z.ZodOptional<z.ZodString>;
+        user_id: z.ZodOptional<z.ZodString>;
+        message: z.ZodOptional<z.ZodString>;
+        readBy: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        timeStampReadBy: z.ZodOptional<z.ZodUnknown>;
+        files: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            path: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            path: string;
+        }, {
+            name: string;
+            path: string;
+        }>, "many">>;
+        createdAt: z.ZodOptional<z.ZodDate>;
+        ignore_message: z.ZodOptional<z.ZodBoolean>;
+        ignoredMessageUpdatedAt: z.ZodOptional<z.ZodDate>;
+        ignoredMessageBy: z.ZodOptional<z.ZodString>;
+    } & {
+        _id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    }, {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    success: boolean;
+    message?: string | undefined;
+    data?: {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    } | undefined;
+}, {
+    success: boolean;
+    message?: string | undefined;
+    data?: {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    } | undefined;
+}>;
+export declare const LoadCommunicationThreadResponseSchema: z.ZodObject<{
+    success: z.ZodBoolean;
+    message: z.ZodOptional<z.ZodString>;
+} & {
+    data: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        student_id: z.ZodOptional<z.ZodString>;
+        user_id: z.ZodOptional<z.ZodString>;
+        message: z.ZodOptional<z.ZodString>;
+        readBy: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        timeStampReadBy: z.ZodOptional<z.ZodUnknown>;
+        files: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            path: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            path: string;
+        }, {
+            name: string;
+            path: string;
+        }>, "many">>;
+        createdAt: z.ZodOptional<z.ZodDate>;
+        ignore_message: z.ZodOptional<z.ZodBoolean>;
+        ignoredMessageUpdatedAt: z.ZodOptional<z.ZodDate>;
+        ignoredMessageBy: z.ZodOptional<z.ZodString>;
+    } & {
+        _id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    }, {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    success: boolean;
+    message?: string | undefined;
+    data?: {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    }[] | undefined;
+}, {
+    success: boolean;
+    message?: string | undefined;
+    data?: {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    }[] | undefined;
+}>;
+export declare const UpdateCommunicationMessageResponseSchema: z.ZodObject<{
+    success: z.ZodBoolean;
+    message: z.ZodOptional<z.ZodString>;
+} & {
+    data: z.ZodOptional<z.ZodObject<{
+        student_id: z.ZodOptional<z.ZodString>;
+        user_id: z.ZodOptional<z.ZodString>;
+        message: z.ZodOptional<z.ZodString>;
+        readBy: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        timeStampReadBy: z.ZodOptional<z.ZodUnknown>;
+        files: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            path: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            path: string;
+        }, {
+            name: string;
+            path: string;
+        }>, "many">>;
+        createdAt: z.ZodOptional<z.ZodDate>;
+        ignore_message: z.ZodOptional<z.ZodBoolean>;
+        ignoredMessageUpdatedAt: z.ZodOptional<z.ZodDate>;
+        ignoredMessageBy: z.ZodOptional<z.ZodString>;
+    } & {
+        _id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    }, {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    success: boolean;
+    message?: string | undefined;
+    data?: {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    } | undefined;
+}, {
+    success: boolean;
+    message?: string | undefined;
+    data?: {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    } | undefined;
+}>;
+export declare const DeleteCommunicationMessageResponseSchema: z.ZodObject<{
+    success: z.ZodBoolean;
+    message: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    success: boolean;
+    message?: string | undefined;
+}, {
+    success: boolean;
+    message?: string | undefined;
+}>;
+export declare const IgnoreCommunicationMessageResponseSchema: z.ZodObject<{
+    success: z.ZodBoolean;
+    message: z.ZodOptional<z.ZodString>;
+} & {
+    data: z.ZodOptional<z.ZodObject<{
+        student_id: z.ZodOptional<z.ZodString>;
+        user_id: z.ZodOptional<z.ZodString>;
+        message: z.ZodOptional<z.ZodString>;
+        readBy: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        timeStampReadBy: z.ZodOptional<z.ZodUnknown>;
+        files: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            path: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            path: string;
+        }, {
+            name: string;
+            path: string;
+        }>, "many">>;
+        createdAt: z.ZodOptional<z.ZodDate>;
+        ignore_message: z.ZodOptional<z.ZodBoolean>;
+        ignoredMessageUpdatedAt: z.ZodOptional<z.ZodDate>;
+        ignoredMessageBy: z.ZodOptional<z.ZodString>;
+    } & {
+        _id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    }, {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    success: boolean;
+    message?: string | undefined;
+    data?: {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    } | undefined;
+}, {
+    success: boolean;
+    message?: string | undefined;
+    data?: {
+        _id: string;
+        createdAt?: Date | undefined;
+        student_id?: string | undefined;
+        user_id?: string | undefined;
+        message?: string | undefined;
+        ignore_message?: boolean | undefined;
+        readBy?: string[] | undefined;
+        timeStampReadBy?: unknown;
+        files?: {
+            name: string;
+            path: string;
+        }[] | undefined;
+        ignoredMessageUpdatedAt?: Date | undefined;
+        ignoredMessageBy?: string | undefined;
+    } | undefined;
+}>;
 /** GET /api/communications/:studentId */
-export type GetCommunicationThreadResponse = ApiResponse<ICommunicationWithId[]>;
+export type GetCommunicationThreadResponse = z.infer<typeof GetCommunicationThreadResponseSchema>;
 /** GET /api/communications/all */
-export type GetMyCommunicationThreadResponse = ApiResponse<ICommunicationWithId[]>;
+export type GetMyCommunicationThreadResponse = z.infer<typeof GetMyCommunicationThreadResponseSchema>;
 /** GET /api/communications/ping/all */
-export type GetCommunicationUnreadNumberResponse = ApiResponse<number>;
+export type GetCommunicationUnreadNumberResponse = z.infer<typeof GetCommunicationUnreadNumberResponseSchema>;
 /** POST /api/communications/:studentId */
-export type PostCommunicationResponse = ApiResponse<ICommunicationWithId>;
+export type PostCommunicationResponse = z.infer<typeof PostCommunicationResponseSchema>;
 /** GET /api/communications/:studentId/pages/:pageNumber */
-export type LoadCommunicationThreadResponse = ApiResponse<ICommunicationWithId[]>;
+export type LoadCommunicationThreadResponse = z.infer<typeof LoadCommunicationThreadResponseSchema>;
 /** PUT /api/communications/:communication_id/:communication_messageId */
-export type UpdateCommunicationMessageResponse = ApiResponse<ICommunicationWithId>;
+export type UpdateCommunicationMessageResponse = z.infer<typeof UpdateCommunicationMessageResponseSchema>;
 /** DELETE /api/communications/:student_id/:communication_messageId */
-export type DeleteCommunicationMessageResponse = SuccessResponse;
+export type DeleteCommunicationMessageResponse = z.infer<typeof DeleteCommunicationMessageResponseSchema>;
 /** PUT /api/communications/:student_id/:communication_messageId/:ignoreMessageState/ignore */
-export type IgnoreCommunicationMessageResponse = ApiResponse<ICommunicationWithId>;
+export type IgnoreCommunicationMessageResponse = z.infer<typeof IgnoreCommunicationMessageResponseSchema>;