View Source GitHub.User (GitHub REST API Client v0.3.3)

Provides struct and types for a User

Link to this section Summary

Link to this section Types

@type private() :: %GitHub.User{
  __info__: map(),
  avatar_url: String.t(),
  bio: String.t() | nil,
  blog: String.t() | nil,
  business_plus: boolean() | nil,
  collaborators: integer(),
  company: String.t() | nil,
  created_at: DateTime.t(),
  disk_usage: integer(),
  email: String.t() | nil,
  events_url: String.t(),
  followers: integer(),
  followers_url: String.t(),
  following: integer(),
  following_url: String.t(),
  gists_url: String.t(),
  gravatar_id: String.t() | nil,
  hireable: boolean() | nil,
  html_url: String.t(),
  id: integer(),
  ldap_dn: String.t() | nil,
  location: String.t() | nil,
  login: String.t(),
  name: String.t() | nil,
  node_id: String.t(),
  organizations_url: String.t(),
  owned_private_repos: integer(),
  plan: GitHub.User.Plan.private() | nil,
  private_gists: integer(),
  public_gists: integer(),
  public_repos: integer(),
  received_events_url: String.t(),
  repos_url: String.t(),
  site_admin: boolean(),
  starred_at: term(),
  starred_url: String.t(),
  subscriptions_url: String.t(),
  suspended_at: DateTime.t() | nil,
  total_private_repos: integer(),
  twitter_username: String.t() | nil,
  two_factor_authentication: boolean(),
  type: String.t(),
  updated_at: DateTime.t(),
  url: String.t()
}
@type public() :: %GitHub.User{
  __info__: map(),
  avatar_url: String.t(),
  bio: String.t() | nil,
  blog: String.t() | nil,
  business_plus: term(),
  collaborators: integer() | nil,
  company: String.t() | nil,
  created_at: DateTime.t(),
  disk_usage: integer() | nil,
  email: String.t() | nil,
  events_url: String.t(),
  followers: integer(),
  followers_url: String.t(),
  following: integer(),
  following_url: String.t(),
  gists_url: String.t(),
  gravatar_id: String.t() | nil,
  hireable: boolean() | nil,
  html_url: String.t(),
  id: integer(),
  ldap_dn: term(),
  location: String.t() | nil,
  login: String.t(),
  name: String.t() | nil,
  node_id: String.t(),
  organizations_url: String.t(),
  owned_private_repos: integer() | nil,
  plan: GitHub.User.Plan.public() | nil,
  private_gists: integer() | nil,
  public_gists: integer(),
  public_repos: integer(),
  received_events_url: String.t(),
  repos_url: String.t(),
  site_admin: boolean(),
  starred_at: term(),
  starred_url: String.t(),
  subscriptions_url: String.t(),
  suspended_at: DateTime.t() | nil,
  total_private_repos: integer() | nil,
  twitter_username: String.t() | nil,
  two_factor_authentication: term(),
  type: String.t(),
  updated_at: DateTime.t(),
  url: String.t()
}
@type simple() :: %GitHub.User{
  __info__: map(),
  avatar_url: String.t(),
  bio: term(),
  blog: term(),
  business_plus: term(),
  collaborators: term(),
  company: term(),
  created_at: term(),
  disk_usage: term(),
  email: String.t() | nil,
  events_url: String.t(),
  followers: term(),
  followers_url: String.t(),
  following: term(),
  following_url: String.t(),
  gists_url: String.t(),
  gravatar_id: String.t() | nil,
  hireable: term(),
  html_url: String.t(),
  id: integer(),
  ldap_dn: term(),
  location: term(),
  login: String.t(),
  name: String.t() | nil,
  node_id: String.t(),
  organizations_url: String.t(),
  owned_private_repos: term(),
  plan: term(),
  private_gists: term(),
  public_gists: term(),
  public_repos: term(),
  received_events_url: String.t(),
  repos_url: String.t(),
  site_admin: boolean(),
  starred_at: String.t() | nil,
  starred_url: String.t(),
  subscriptions_url: String.t(),
  suspended_at: term(),
  total_private_repos: term(),
  twitter_username: term(),
  two_factor_authentication: term(),
  type: String.t(),
  updated_at: term(),
  url: String.t()
}