Server - Technical Reference - v26.4.1
    Preparing search index...

    Hierarchy (View Summary)

    Index
    • Parameters

      • payload: {
            addr_line_1: string;
            addr_line_2?: string;
            addr_name: string;
            city: string;
            country: string;
            country_iso: string;
            is_default?: boolean;
            post_code?: string;
            state?: string;
            user_id: string;
        }

      Returns
          | {
              addr_line_1: string;
              addr_line_2?: string;
              addr_name: string;
              city: string;
              country: string;
              country_iso: string;
              is_default?: boolean;
              post_code?: string;
              state?: string;
              user_id: string;
          }
          | ZodError<unknown>

    • Parameters

      • payload: { socials?: { type: Socials; url: string }[]; user_id: string }

      Returns
          | { socials?: { type: Socials; url: string }[]; user_id: string }
          | ZodError<unknown>

    • Parameters

      • payload: { contact_id: string; email: string; is_primary?: boolean; user_id: string }

      Returns
          | {
              contact_id: string;
              email: string;
              is_primary?: boolean;
              user_id: string;
          }
          | ZodError<unknown>

    • Parameters

      • payload: {
            contact_id: string;
            is_primary?: boolean;
            phone: string;
            phone_code: string;
            user_id: string;
        }

      Returns
          | {
              contact_id: string;
              is_primary?: boolean;
              phone: string;
              phone_code: string;
              user_id: string;
          }
          | ZodError<unknown>

    • Parameters

      • payload: {
            profile: {
                avatar?: string | null;
                cover_img?: string | null;
                date_of_birth?: Date | null;
                first_name: string;
                gender?: "MALE" | "FEMALE" | "OTHER" | "PREFER_NOT_TO_SAY" | null;
                last_name?: string | null;
                nickname?: string | null;
            };
            user: {
                email: string;
                is_verified?: boolean;
                role?: "ADMIN"
                | "USER";
                username: string;
            };
        }

      Returns
          | {
              profile: {
                  avatar?: string
                  | null;
                  cover_img?: string | null;
                  date_of_birth?: Date | null;
                  first_name: string;
                  gender?: "MALE" | "FEMALE" | "OTHER" | "PREFER_NOT_TO_SAY" | null;
                  last_name?: string | null;
                  nickname?: string | null;
              };
              user: {
                  email: string;
                  is_verified?: boolean;
                  role?: "ADMIN"
                  | "USER";
                  username: string;
              };
          }
          | ZodError<
              {
                  profile: {
                      avatar?: string
                      | null;
                      cover_img?: string | null;
                      date_of_birth?: Date | null;
                      first_name: string;
                      gender?: "MALE" | "FEMALE" | "OTHER" | "PREFER_NOT_TO_SAY" | null;
                      last_name?: string | null;
                      nickname?: string | null;
                  };
                  user: {
                      email: string;
                      is_verified?: boolean;
                      role?: "ADMIN"
                      | "USER";
                      username: string;
                  };
              },
          >

    • Parameters

      • payload: {
            profile: {
                avatar?: string | null;
                cover_img?: string | null;
                date_of_birth?: Date | null;
                first_name: string;
                gender?: "MALE" | "FEMALE" | "OTHER" | "PREFER_NOT_TO_SAY" | null;
                last_name?: string | null;
                nickname?: string | null;
            };
            user: {
                email: string;
                password: string;
                role?: "ADMIN"
                | "USER";
                username: string;
            };
        }

      Returns
          | {
              profile: {
                  avatar?: string
                  | null;
                  cover_img?: string | null;
                  date_of_birth?: Date | null;
                  first_name: string;
                  gender?: "MALE" | "FEMALE" | "OTHER" | "PREFER_NOT_TO_SAY" | null;
                  last_name?: string | null;
                  nickname?: string | null;
              };
              user: {
                  email: string;
                  password: string;
                  role?: "ADMIN"
                  | "USER";
                  username: string;
              };
          }
          | ZodError<unknown>

    • Parameters

      • payload: { identifier: string; password: string }

      Returns { identifier: string; password: string } | ZodError<unknown>

    • Parameters

      • payload: {
            addr_line_1?: string;
            addr_line_2?: string;
            addr_name?: string;
            city?: string;
            country?: string;
            country_iso?: string;
            id: string;
            is_default?: boolean;
            post_code?: string;
            state?: string;
            user_id: string;
        }

      Returns
          | {
              addr_line_1?: string;
              addr_line_2?: string;
              addr_name?: string;
              city?: string;
              country?: string;
              country_iso?: string;
              id: string;
              is_default?: boolean;
              post_code?: string;
              state?: string;
              user_id: string;
          }
          | ZodError<unknown>

    • Parameters

      • payload: { id?: string; socials?: { type: Socials; url: string }[]; user_id: string }

      Returns
          | {
              id?: string;
              socials?: { type: Socials; url: string }[];
              user_id: string;
          }
          | ZodError<unknown>

    • Parameters

      • payload: {
            email?: string;
            id: string;
            is_verified?: boolean;
            password?: string;
            provider?: "GOOGLE" | "GITHUB" | "DISCORD" | "MANUAL";
            role?: "ADMIN" | "USER";
            username?: string;
            verify_code?: string | null;
            verify_expiry?: Date | null;
        }

      Returns
          | ZodError<unknown>
          | {
              email?: string;
              id: string;
              is_verified?: boolean;
              password?: string;
              provider?: "GOOGLE" | "GITHUB" | "DISCORD" | "MANUAL";
              role?: "ADMIN" | "USER";
              username?: string;
              verify_code?: string | null;
              verify_expiry?: Date | null;
          }

    • Parameters

      • payload: {
            contact_id?: string;
            email?: string;
            id: string;
            is_primary?: boolean;
            is_verified?: boolean;
            user_id: string;
            verify_code?: string | null;
            verify_expiry?: Date | null;
        }

      Returns
          | {
              contact_id?: string;
              email?: string;
              id: string;
              is_primary?: boolean;
              is_verified?: boolean;
              user_id: string;
              verify_code?: string
              | null;
              verify_expiry?: Date | null;
          }
          | ZodError<unknown>

    • Parameters

      • payload: {
            contact_id?: string;
            id: string;
            is_primary?: boolean;
            is_verified?: boolean;
            phone?: string;
            phone_code?: string;
            user_id: string;
            verify_code?: string | null;
            verify_expiry?: Date | null;
        }

      Returns
          | {
              contact_id?: string;
              id: string;
              is_primary?: boolean;
              is_verified?: boolean;
              phone?: string;
              phone_code?: string;
              user_id: string;
              verify_code?: string
              | null;
              verify_expiry?: Date | null;
          }
          | ZodError<unknown>

    • Parameters

      • payload: {
            avatar?: string | null;
            cover_img?: string | null;
            date_of_birth?: Date | null;
            first_name?: string;
            gender?: "MALE" | "FEMALE" | "OTHER" | "PREFER_NOT_TO_SAY" | null;
            last_name?: string | null;
            nickname?: string | null;
            user_id: string;
        }

      Returns
          | {
              avatar?: string
              | null;
              cover_img?: string | null;
              date_of_birth?: Date | null;
              first_name?: string;
              gender?: "MALE" | "FEMALE" | "OTHER" | "PREFER_NOT_TO_SAY" | null;
              last_name?: string | null;
              nickname?: string | null;
              user_id: string;
          }
          | ZodError<unknown>

    • Parameters

      • payload: { id: string; user_id: string }

      Returns { id: string; user_id: string } | ZodError<unknown>

    • Type Parameters

      • T

      Parameters

      • payload: unknown
      • schema: ZodType<T>

      Returns ZodSafeParseResult<T>

    • Parameters

      • payload: { id: string; verify_code?: string | null }

      Returns { id: string; verify_code?: string | null } | ZodError<unknown>

    • Parameters

      • payload: { id: string; user_id: string; verify_code?: string | null }

      Returns { id: string; user_id: string; verify_code?: string | null } | ZodError<unknown>