Server - Technical Reference - v26.4.1
    Preparing search index...
    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 Promise<string>

    • Parameters

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

      Returns Promise<string>

    • Parameters

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

      Returns Promise<string>

    • Parameters

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

      Returns Promise<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 Promise<
          {
              profile: {
                  avatar: string
                  | null;
                  cover_img: string | null;
                  created_at: Date;
                  date_of_birth: string | null;
                  first_name: string;
                  gender: "MALE" | "FEMALE" | "OTHER" | "PREFER_NOT_TO_SAY" | null;
                  id: string;
                  last_name: string | null;
                  nickname: string | null;
                  updated_at: Date | null;
                  user_id: string;
              };
              user: {
                  created_at: Date;
                  email: string;
                  id: string;
                  is_verified: boolean;
                  provider: "GOOGLE"
                  | "GITHUB"
                  | "DISCORD"
                  | "MANUAL";
                  role: "ADMIN" | "USER";
                  updated_at: Date | null;
                  username: string;
                  verify_code: string | null;
                  verify_expiry: Date | null;
              };
          },
      >

    • 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 Promise<
          | {
              email: string;
              id: string;
              is_verified: boolean;
              password: string
              | null;
              profile:
                  | {
                      avatar: string
                      | null;
                      first_name: string;
                      last_name: string | null;
                      nickname: string | null;
                  }
                  | null;
              role: "ADMIN"
              | "USER";
              username: string;
          }
          | {
              created_at: Date;
              email: string;
              id: string;
              is_verified: boolean;
              profile: {
                  avatar: string
                  | null;
                  cover_img: string | null;
                  created_at: Date;
                  date_of_birth: string | null;
                  first_name: string;
                  gender: "MALE" | "FEMALE" | "OTHER" | "PREFER_NOT_TO_SAY" | null;
                  id: string;
                  last_name: string | null;
                  nickname: string | null;
                  updated_at: Date | null;
                  user_id: string;
              };
              provider: "GOOGLE"
              | "GITHUB"
              | "DISCORD"
              | "MANUAL";
              role: "ADMIN" | "USER";
              updated_at: Date | null;
              username: string;
              verify_code: string | null;
              verify_expiry: Date | null;
          },
      >

    • Parameters

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

      Returns Promise<string>

    • Parameters

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

      Returns Promise<string>

    • Parameters

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

      Returns Promise<string>

    • Parameters

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

      Returns Promise<string>

    • Parameters

      • id: string

      Returns Promise<
          {
              created_at: Date;
              email: string;
              id: string;
              is_verified: boolean;
              profile: | {
                  avatar: string
                  | null;
                  cover_img: string | null;
                  created_at: Date;
                  date_of_birth: string | null;
                  first_name: string;
                  gender: "MALE" | "FEMALE" | "OTHER" | "PREFER_NOT_TO_SAY" | null;
                  last_name: string | null;
                  nickname: string | null;
                  updated_at: Date | null;
              }
              | null;
              provider: "GOOGLE"
              | "GITHUB"
              | "DISCORD"
              | "MANUAL";
              role: "ADMIN" | "USER";
              updated_at: Date | null;
              username: string;
          },
      >

    • 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 Promise<string>

    • Parameters

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

      Returns Promise<string>

    • 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 Promise<string>

    • 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 Promise<string>

    • 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 Promise<string>