Skip to content

Latest commit

History

History
64 lines (58 loc) 路 2.88 KB

UserPublic.md

File metadata and controls

64 lines (58 loc) 路 2.88 KB

FlatApi::UserPublic

Properties

Name Type Description Notes
id String The user unique identifier
type String The type of user account
product TutteoProduct [default to 'flat']
username String The user name (unique for the organization)
printable_name String The name that can be directly printed (name, firstname & lastname, or username) [optional]
firstname String Firstname of the user (for education users) [optional]
lastname String Lastname of the user (for education users) [optional]
name String A displayable name for the user (for consumer users) [optional]
picture String The URL of the picture to display
badges Array<String> List of badges for the user profile: - `power` - `staff` - `composerOfTheMonth` - `ambassador` - `challenge` [optional]
organization String Organization ID (for Edu users only) [optional]
organization_role OrganizationRoles [optional]
class_role ClassRoles [optional]
html_url String Link to user profile (for Indiv. users only) [optional]
bio String User's biography [optional]
registration_date Time Date the user signed up [optional]
liked_scores_count Integer Number of the scores liked by the user [optional]
followers_count Integer Number of followers the user have [optional]
following_count Integer Number of people the user follow [optional]
owned_public_scores_count Integer Number of public scores the user have [optional]
cover_picture String Cover picture (backgroud) for the profile [optional]
profile_theme String Theme (background) for the profile [optional]
instruments Array<String> An array of the instrument identifiers. The format of the strings is `{instrument-group}.{instrument-id}`. [optional]
links UserCommunityProfileLinks [optional]

Example

require 'flat_api'

instance = FlatApi::UserPublic.new(
  id: null,
  type: null,
  product: null,
  username: null,
  printable_name: null,
  firstname: null,
  lastname: null,
  name: null,
  picture: null,
  badges: null,
  organization: null,
  organization_role: null,
  class_role: null,
  html_url: null,
  bio: null,
  registration_date: null,
  liked_scores_count: null,
  followers_count: null,
  following_count: null,
  owned_public_scores_count: null,
  cover_picture: null,
  profile_theme: null,
  instruments: null,
  links: null
)