forem

type Article struct {
	ID int `json:"id"`

	// The following fields may be modified via the API, as well as read.
	Title        string       `json:"title,omitempty"`
	Description  string       `json:"description,omitempty"`
	Frontmatter  *Frontmatter `json:"-"`
	Body         string       `json:"-"`
	CanonicalURL string       `json:"canonical_url,omitempty"`
	Tags         []string     `json:"tags,omitempty"`

	// These fields are write-only.
	Published      bool   `json:"published,omitempty"`
	Series         string `json:"series,omitempty"`
	MainImage      string `json:"main_image,omitempty"`
	OrganizationID int32  `json:"organization_id,omitempty"`

	// The remaining fields are read-only via the API. Some may be set via
	// front matter in Body
	ReadablePublishDate    string        `json:"readable_publish_date"`
	Slug                   string        `json:"slug"`
	Path                   string        `json:"path"`
	URL                    string        `json:"url"`
	CommentsCount          int           `json:"comments_count"`
	CollectionID           *int          `json:"collection_id"`
	PublishedTimestamp     time.Time     `json:"published_timestamp"`
	PositiveReactionsCount int           `json:"positive_reactions_count"`
	CoverImage             string        `json:"cover_image"`
	SocialImage            string        `json:"social_image"`
	CreatedAt              time.Time     `json:"created_at"`
	EditedAt               *time.Time    `json:"edited_at"`
	CrosspostedAt          *time.Time    `json:"crossposted_at"`
	PublishedAt            time.Time     `json:"published_at"`
	LastCommentAt          *time.Time    `json:"last_comment_at"`
	ReadingTimeMinutes     int           `json:"reading_time_minutes"`
	User                   *User         `json:"user"`
	Organization           *Organization `json:"organization"`
	FlareTag               *FlareTag     `json:"flare_tag"`
	PageViewsCount         int           `json:"page_views_count"`
	PublicReactionsCount   int           `json:"public_reactions_count"`
}

type ArticlesQuery struct {
	// Page is the pagination page requested.
	Page int32 `url:"page,omitempty"`
	// PerPage is the page size (items to return per page). Defaults to 30.
	PerPage      int32    `url:"per_page,omitempty"`
	Tag          string   `url:"tag,omitempty"`
	Tags         []string `url:"tags,omitempty"`
	TagsExclude  []string `url:"tags_exclude,omitempty"`
	Username     string   `url:"username,omitempty"`
	State        string   `url:"state,omitempty"`
	Top          int32    `url:"top,omitempty"`
	CollectionID int32    `url:"collection_id,omitempty"`
}

type Client struct {
	// contains filtered or unexported fields
}

type FlareTag struct {
	Name         string `json:"name"`
	BgColorHex   string `json:"bg_color_hex"`
	TextColorHex string `json:"text_color_hex"`
}

type Frontmatter struct {
	Title        string    `yaml:"title"`
	Description  string    `yaml:"description"`
	Series       string    `yaml:"series"`
	Published    bool      `yaml:"published"`
	Date         time.Time `yaml:"date"`
	Tags         []string  `yaml:"tags"`
	CanonicalURL string    `yaml:"canonical_url"`
	CoverImage   string    `yaml:"cover_image"`
	// Extra are any unrecognized frontmatter values.
	Extra map[string]string
}

type Organization struct {
	Name           string `json:"name"`
	Username       string `json:"username"`
	Slug           string `json:"slug"`
	ProfileImage   string `json:"profile_image"`
	ProfileImage90 string `json:"profile_image_90"`
}

type PaginationQuery struct {
	// Page is the pagination page requested.
	Page int32 `url:"page,omitempty"`
	// PerPage is the page size (items to return per page). Defaults to 30.
	PerPage int32 `url:"per_page,omitempty"`
}

type User struct {
	Name            string  `json:"name"`
	Username        string  `json:"username"`
	TwitterUsername *string `json:"twitter_username"`
	GithubUsername  *string `json:"github_username"`
	UserID          int     `json:"user_id"`
	WebsiteURL      *string `json:"sebsite_url"`
	ProfileImage    string  `json:"profile_image"`
	ProfileImage90  string  `json:"profile_image_90"`
}

type Video struct {
	ID                 int    `json:"id"`
	Path               string `json:"path"`
	CloudinaryVideoURL string `json:"cloudinary_video_url"`
	Title              string `json:"title"`
	UserID             int    `json:"user_id"`
	Duration           string `json:"video_duration_in_minutes"`
	SourceURL          string `json:"video_source_url"`
	User               *User  `json:"user"`
}