defmodule GitHub.Gist do
@moduledoc """
Provides struct and types for a Gist
"""
use GitHub.Encoder
@type simple :: %__MODULE__{
__info__: map,
comments: integer | nil,
comments_url: String.t() | nil,
commits_url: String.t() | nil,
created_at: String.t() | nil,
description: String.t() | nil,
files: GitHub.Gist.Files.simple() | nil,
fork_of: GitHub.Gist.t() | nil,
forks: [map] | nil,
forks_url: String.t() | nil,
git_pull_url: String.t() | nil,
git_push_url: String.t() | nil,
history: [map] | nil,
html_url: String.t() | nil,
id: String.t() | nil,
node_id: String.t() | nil,
owner: GitHub.User.simple() | nil,
public: boolean | nil,
truncated: boolean | nil,
updated_at: String.t() | nil,
url: String.t() | nil,
user: String.t() | nil
}
@type t :: %__MODULE__{
__info__: map,
comments: integer,
comments_url: String.t(),
commits_url: String.t(),
created_at: DateTime.t(),
description: String.t() | nil,
files: GitHub.Gist.Files.t(),
forks: [map] | nil,
forks_url: String.t(),
git_pull_url: String.t(),
git_push_url: String.t(),
history: [map] | nil,
html_url: String.t(),
id: String.t(),
node_id: String.t(),
owner: GitHub.User.simple() | nil,
public: boolean,
truncated: boolean | nil,
updated_at: DateTime.t(),
url: String.t(),
user: GitHub.User.simple() | nil
}
defstruct [
:__info__,
:comments,
:comments_url,
:commits_url,
:created_at,
:description,
:files,
:fork_of,
:forks,
:forks_url,
:git_pull_url,
:git_push_url,
:history,
:html_url,
:id,
:node_id,
:owner,
:public,
:truncated,
:updated_at,
:url,
:user
]
@doc false
@spec __fields__(atom) :: keyword
def __fields__(type \\ :t)
def __fields__(:simple) do
[
comments: :integer,
comments_url: {:string, :generic},
commits_url: {:string, :generic},
created_at: {:string, :generic},
description: {:union, [{:string, :generic}, :null]},
files: {GitHub.Gist.Files, :simple},
fork_of: {:union, [{GitHub.Gist, :t}, :null]},
forks: {:union, [[:map], :null]},
forks_url: {:string, :generic},
git_pull_url: {:string, :generic},
git_push_url: {:string, :generic},
history: {:union, [[:map], :null]},
html_url: {:string, :generic},
id: {:string, :generic},
node_id: {:string, :generic},
owner: {GitHub.User, :simple},
public: :boolean,
truncated: :boolean,
updated_at: {:string, :generic},
url: {:string, :generic},
user: {:union, [{:string, :generic}, :null]}
]
end
def __fields__(:t) do
[
comments: :integer,
comments_url: {:string, :uri},
commits_url: {:string, :uri},
created_at: {:string, :date_time},
description: {:union, [{:string, :generic}, :null]},
files: {GitHub.Gist.Files, :t},
forks: [:map],
forks_url: {:string, :uri},
git_pull_url: {:string, :uri},
git_push_url: {:string, :uri},
history: [:map],
html_url: {:string, :uri},
id: {:string, :generic},
node_id: {:string, :generic},
owner: {:union, [{GitHub.User, :simple}, :null]},
public: :boolean,
truncated: :boolean,
updated_at: {:string, :date_time},
url: {:string, :uri},
user: {:union, [{GitHub.User, :simple}, :null]}
]
end
end