@inweb/client/src/Api/IUser.ts

JavaScript REST API client for the Open Cloud Server

///////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2002-2026, Open Design Alliance (the "Alliance").
// All rights reserved.
//
// This software and its documentation and related materials are owned by
// the Alliance. The software may only be incorporated into application
// programs owned by members of the Alliance, subject to a signed
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable
// trade secrets of the Alliance and its suppliers. The software is also
// protected by copyright law and international treaty provisions. Application
// programs incorporating this software must include the following statement
// with their copyright notices:
//
//   This application incorporates Open Design Alliance software pursuant to a
//   license agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2026 by Open Design Alliance.
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////

/**
 * Defines brief user information.
 */
export interface IShortUserDesc {
  /**
   * Unique user ID.
   */
  userId: string;

  /**
   * User name.
   */
  userName: string;

  /**
   * First name.
   */
  name: string;

  /**
   * Last name.
   */
  lastName: string;

  /**
   * User email.
   */
  email: string;

  /**
   * User avatar image URL or empty string if the user does not have an avatar.
   */
  avatarUrl?: string;

  /**
   * User full name. Contains the user's first and last name. If first name and last names are empty,
   * contains the user name.
   */
  fullName?: string;

  /**
   * User initials. Contains a first letters of the user's first and last names. If first name and last
   * names are empty, contains the first letter of the user name.
   */
  initials?: string;
}