plexcsharp/LukeHagar/PlexAPI/SDK/Models/Requests/Metadata.cs

//------------------------------------------------------------------------------
// <auto-generated>
// This code was generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
//
// Changes to this file may cause incorrect behavior and will be lost when
// the code is regenerated.
// </auto-generated>
//------------------------------------------------------------------------------
#nullable enable
namespace LukeHagar.PlexAPI.SDK.Models.Requests
{
    using LukeHagar.PlexAPI.SDK.Models.Components;
    using LukeHagar.PlexAPI.SDK.Models.Requests;
    using LukeHagar.PlexAPI.SDK.Utils;
    using Newtonsoft.Json;
    using NodaTime;
    using System.Collections.Generic;
    
    /// <summary>
    /// Items in a library are referred to as &quot;metadata items.&quot; These metadata items are distinct from &quot;media items&quot; which represent actual instances of media that can be consumed. Consider a TV library that has a single video file in it for a particular episode of a show. The library has a single media item, but it has three metadata items: one for the show, one for the season, and one for the episode. Consider a movie library that has two video files in it: the same movie, but two different resolutions. The library has a single metadata item for the movie, but that metadata item has two media items, one for each resolution. Additionally a &quot;media item&quot; will have one or more &quot;media parts&quot; where the the parts are intended to be watched together, such as a CD1 and CD2 parts of the same movie.<br/>
    /// 
    /// <remarks>
    /// <br/>
    /// Note that when a metadata item has multiple media items, those media items should be isomorphic. That is, a 4K version and 1080p version of a movie are different versions of the same movie. They have the same duration, same summary, same rating, etc. and they can generally be considered interchangeable. A theatrical release vs. director&apos;s cut vs. unrated version on the other hand would be separate metadata items.<br/>
    /// <br/>
    /// Metadata items can often live in a hierarchy with relationships between them.  For example, the metadata item for an episodes is associated with a season metadata item which is associated with a show metadata item.  A similar hierarchy exists with track, album, and artist and photos and photo album.  The relationships may be expressed via relative terms and absolute terms.  For example, &quot;leaves&quot; refer to metadata items which has associated media (there is no media for a season nor show).  A show will have &quot;children&quot; in the form of seasons and a season will have &quot;children&quot; in the form of episodes and episodes have &quot;parent&quot; in the form of a season which has a &quot;parent&quot; in the form of a show.  Similarly, a show has &quot;grandchildren&quot; in the form of episodse and an episode has a &quot;grandparent&quot; in the form of a show.<br/>
    /// 
    /// </remarks>
    /// </summary>
    public class Metadata
    {

        /// <summary>
        /// Information about the player being used for playback
        /// </summary>
        [JsonProperty("Player")]
        public Player? Player { get; set; }

        /// <summary>
        /// Information about the playback session
        /// </summary>
        [JsonProperty("Session")]
        public Session? Session { get; set; }

        /// <summary>
        /// The user playing the content
        /// </summary>
        [JsonProperty("User")]
        public Models.Components.User? User { get; set; }

        /// <summary>
        /// The title of the item (e.g. “300” or “The Simpsons”)
        /// </summary>
        [JsonProperty("title")]
        public string Title { get; set; } = default!;

        /// <summary>
        /// The type of the video item, such as `movie`, `episode`, or `clip`.
        /// </summary>
        [JsonProperty("type")]
        public string Type { get; set; } = default!;

        /// <summary>
        /// When present, contains the disc number for a track on multi-disc albums.
        /// </summary>
        [JsonProperty("absoluteIndex")]
        public int? AbsoluteIndex { get; set; }

        /// <summary>
        /// In units of seconds since the epoch, returns the time at which the item was added to the library.
        /// </summary>
        [JsonProperty("addedAt")]
        public long AddedAt { get; set; } = default!;

        /// <summary>
        /// When present, the URL for the background artwork for the item.
        /// </summary>
        [JsonProperty("art")]
        public string? Art { get; set; }

        /// <summary>
        /// Some rating systems separate reviewer ratings from audience ratings
        /// </summary>
        [JsonProperty("audienceRating")]
        public float? AudienceRating { get; set; }

        /// <summary>
        /// A URI representing the image to be shown with the audience rating (e.g. rottentomatoes://image.rating.spilled).
        /// </summary>
        [JsonProperty("audienceRatingImage")]
        public string? AudienceRatingImage { get; set; }

        [JsonProperty("Autotag")]
        public List<Tag>? Autotag { get; set; }

        /// <summary>
        /// When present, the URL for a banner graphic for the item.
        /// </summary>
        [JsonProperty("banner")]
        public string? Banner { get; set; }

        /// <summary>
        /// When present, indicates the source for the chapters in the media file. Can be media (the chapters were embedded in the media itself), agent (a metadata agent computed them), or mixed (a combination of the two).
        /// </summary>
        [JsonProperty("chapterSource")]
        public string? ChapterSource { get; set; }

        /// <summary>
        /// The number of child items associated with this media item.
        /// </summary>
        [JsonProperty("childCount")]
        public int? ChildCount { get; set; }

        /// <summary>
        /// When present, the URL for a composite image for descendent items (e.g. photo albums or playlists).
        /// </summary>
        [JsonProperty("composite")]
        public string? Composite { get; set; }

        /// <summary>
        /// If known, the content rating (e.g. MPAA) for an item.
        /// </summary>
        [JsonProperty("contentRating")]
        public string? ContentRating { get; set; }

        [JsonProperty("Country")]
        public List<Tag>? Country { get; set; }

        [JsonProperty("Director")]
        public List<Tag>? Director { get; set; }

        /// <summary>
        /// When present, the duration for the item, in units of milliseconds.
        /// </summary>
        [JsonProperty("duration")]
        public int? Duration { get; set; }

        /// <summary>
        /// Typically only seen in metadata at a library&apos;s top level
        /// </summary>
        [JsonProperty("Filter")]
        public List<Filter>? Filter { get; set; }

        [JsonProperty("Genre")]
        public List<Tag>? Genre { get; set; }

        /// <summary>
        /// The `art` of the grandparent
        /// </summary>
        [JsonProperty("grandparentArt")]
        public string? GrandparentArt { get; set; }

        /// <summary>
        /// The GUID of the grandparent media item.
        /// </summary>
        [JsonProperty("grandparentGuid")]
        public string? GrandparentGuid { get; set; }

        /// <summary>
        /// The `hero` of the grandparent
        /// </summary>
        [JsonProperty("grandparentHero")]
        public string? GrandparentHero { get; set; }

        /// <summary>
        /// The `key` of the grandparent
        /// </summary>
        [JsonProperty("grandparentKey")]
        public string? GrandparentKey { get; set; }

        /// <summary>
        /// The `ratingKey` of the grandparent
        /// </summary>
        [JsonProperty("grandparentRatingKey")]
        public string? GrandparentRatingKey { get; set; }

        /// <summary>
        /// The `theme` of the grandparent
        /// </summary>
        [JsonProperty("grandparentTheme")]
        public string? GrandparentTheme { get; set; }

        /// <summary>
        /// The `thumb` of the grandparent
        /// </summary>
        [JsonProperty("grandparentThumb")]
        public string? GrandparentThumb { get; set; }

        /// <summary>
        /// The `title` of the grandparent
        /// </summary>
        [JsonProperty("grandparentTitle")]
        public string? GrandparentTitle { get; set; }

        /// <summary>
        /// The globally unique identifier for the media item.
        /// </summary>
        [JsonProperty("guid")]
        public string? Guid { get; set; }

        [JsonProperty("Guid")]
        public List<Models.Requests.Guids>? Guids { get; set; }

        /// <summary>
        /// When present, the URL for a hero image for the item.
        /// </summary>
        [JsonProperty("hero")]
        public string? Hero { get; set; }

        [JsonProperty("Image")]
        public List<Image>? Image { get; set; }

        /// <summary>
        /// When present, this represents the episode number for episodes, season number for seasons, or track number for audio tracks.
        /// </summary>
        [JsonProperty("index")]
        public int? Index { get; set; }

        /// <summary>
        /// The key at which the item&apos;s details can be fetched.  In many cases a metadata item may be passed without all the details (such as in a hub) and this key corresponds to the endpoint to fetch additional details.
        /// </summary>
        [JsonProperty("key")]
        public string Key { get; set; } = default!;

        [JsonProperty("lastViewedAt")]
        public long? LastViewedAt { get; set; }

        /// <summary>
        /// For shows and seasons, contains the number of total episodes.
        /// </summary>
        [JsonProperty("leafCount")]
        public int? LeafCount { get; set; }

        [JsonProperty("Media")]
        public List<Media>? Media { get; set; }

        /// <summary>
        /// When present, in the format YYYY-MM-DD [HH:MM:SS] (the hours/minutes/seconds part is not always present). The air date, or a higher resolution release date for an item, depending on type. For example, episodes usually have air date like 1979-08-10 (we don&apos;t use epoch seconds because media existed prior to 1970). In some cases, recorded over-the-air content has higher resolution air date which includes a time component. Albums and movies may have day-resolution release dates as well.
        /// </summary>
        [JsonProperty("originallyAvailableAt")]
        public LocalDate? OriginallyAvailableAt { get; set; }

        /// <summary>
        /// When present, used to indicate an item&apos;s original title, e.g. a movie&apos;s foreign title.
        /// </summary>
        [JsonProperty("originalTitle")]
        public string? OriginalTitle { get; set; }

        /// <summary>
        /// The GUID of the parent media item.
        /// </summary>
        [JsonProperty("parentGuid")]
        public string? ParentGuid { get; set; }

        /// <summary>
        /// The `hero` of the parent
        /// </summary>
        [JsonProperty("parentHero")]
        public string? ParentHero { get; set; }

        /// <summary>
        /// The `index` of the parent
        /// </summary>
        [JsonProperty("parentIndex")]
        public int? ParentIndex { get; set; }

        /// <summary>
        /// The `key` of the parent
        /// </summary>
        [JsonProperty("parentKey")]
        public string? ParentKey { get; set; }

        /// <summary>
        /// The `ratingKey` of the parent
        /// </summary>
        [JsonProperty("parentRatingKey")]
        public string? ParentRatingKey { get; set; }

        /// <summary>
        /// The `thumb` of the parent
        /// </summary>
        [JsonProperty("parentThumb")]
        public string? ParentThumb { get; set; }

        /// <summary>
        /// The `title` of the parent
        /// </summary>
        [JsonProperty("parentTitle")]
        public string? ParentTitle { get; set; }

        /// <summary>
        /// Indicates that the item has a primary extra; for a movie, this is a trailer, and for a music track it is a music video. The URL points to the metadata details endpoint for the item.
        /// </summary>
        [JsonProperty("primaryExtraKey")]
        public string? PrimaryExtraKey { get; set; }

        /// <summary>
        /// Prompt to give the user for this directory (such as `Search Movies`)
        /// </summary>
        [JsonProperty("prompt")]
        public string? Prompt { get; set; }

        /// <summary>
        /// When present, the rating for the item. The exact meaning and representation depends on where the rating was sourced from.
        /// </summary>
        [JsonProperty("rating")]
        public float? Rating { get; set; }

        [JsonProperty("Rating")]
        public List<Tag>? RatingArray { get; set; }

        /// <summary>
        /// Number of ratings under this metadata
        /// </summary>
        [JsonProperty("ratingCount")]
        public int? RatingCount { get; set; }

        /// <summary>
        /// When present, indicates an image to be shown with the rating. This is passed back as a small set of defined URI values, e.g. rottentomatoes://image.rating.rotten.
        /// </summary>
        [JsonProperty("ratingImage")]
        public string? RatingImage { get; set; }

        /// <summary>
        /// This is the opaque string to be passed into timeline, scrobble, and rating endpoints to identify them.  While it often appears to be numeric, this is not guaranteed.
        /// </summary>
        [JsonProperty("ratingKey")]
        public string? RatingKey { get; set; }

        [JsonProperty("Role")]
        public List<Tag>? Role { get; set; }

        /// <summary>
        /// Indicates this is a search directory
        /// </summary>
        [JsonProperty("search")]
        public bool? Search { get; set; }

        /// <summary>
        /// Used by old clients to provide nested menus allowing for primative (but structured) navigation.
        /// </summary>
        [JsonProperty("secondary")]
        public bool? Secondary { get; set; }

        /// <summary>
        /// When found on a show item, indicates that the children (seasons) should be skipped in favor of the grandchildren (episodes). Useful for mini-series, etc.
        /// </summary>
        [JsonProperty("skipChildren")]
        public bool? SkipChildren { get; set; }

        /// <summary>
        /// When present on an episode or track item, indicates parent should be skipped in favor of grandparent (show).
        /// </summary>
        [JsonProperty("skipParent")]
        public bool? SkipParent { get; set; }

        /// <summary>
        /// Typically only seen in metadata at a library&apos;s top level
        /// </summary>
        [JsonProperty("Sort")]
        public List<Sort>? Sort { get; set; }

        /// <summary>
        /// When present, the studio or label which produced an item (e.g. movie studio for movies, record label for albums).
        /// </summary>
        [JsonProperty("studio")]
        public string? Studio { get; set; }

        /// <summary>
        /// The subtype of the video item, such as `photo` when the video item is in a photo library
        /// </summary>
        [JsonProperty("subtype")]
        public string? Subtype { get; set; }

        /// <summary>
        /// When present, the extended textual information about the item (e.g. movie plot, artist biography, album review).
        /// </summary>
        [JsonProperty("summary")]
        public string? Summary { get; set; }

        /// <summary>
        /// When present, a pithy one-liner about the item (usually only seen for movies).
        /// </summary>
        [JsonProperty("tagline")]
        public string? Tagline { get; set; }

        /// <summary>
        /// When present, the URL for theme music for the item (usually only for TV shows).
        /// </summary>
        [JsonProperty("theme")]
        public string? Theme { get; set; }

        /// <summary>
        /// When present, the URL for the poster or thumbnail for the item. When available for types like movie, it will be the poster graphic, but fall-back to the extracted media thumbnail.
        /// </summary>
        [JsonProperty("thumb")]
        public string? Thumb { get; set; }

        /// <summary>
        /// Whene present, this is the string used for sorting the item. It&apos;s usually the title with any leading articles removed (e.g. “Simpsons”).
        /// </summary>
        [JsonProperty("titleSort")]
        public string? TitleSort { get; set; }

        /// <summary>
        /// In units of seconds since the epoch, returns the time at which the item was last changed (e.g. had its metadata updated).
        /// </summary>
        [JsonProperty("updatedAt")]
        public long? UpdatedAt { get; set; }

        /// <summary>
        /// When the user has rated an item, this contains the user rating
        /// </summary>
        [JsonProperty("userRating")]
        public float? UserRating { get; set; }

        /// <summary>
        /// When a users has completed watched or listened to an item, this attribute contains the number of consumptions.
        /// </summary>
        [JsonProperty("viewCount")]
        public int? ViewCount { get; set; }

        /// <summary>
        /// For shows and seasons, contains the number of viewed episodes.
        /// </summary>
        [JsonProperty("viewedLeafCount")]
        public int? ViewedLeafCount { get; set; }

        /// <summary>
        /// When a user is in the process of viewing or listening to this item, this attribute contains the current offset, in units of milliseconds.
        /// </summary>
        [JsonProperty("viewOffset")]
        public int? ViewOffset { get; set; }

        [JsonProperty("Writer")]
        public List<Tag>? Writer { get; set; }

        /// <summary>
        /// When present, the year associated with the item&apos;s release (e.g. release year for a movie).
        /// </summary>
        [JsonProperty("year")]
        public int? Year { get; set; }

        [JsonProperty("additionalProperties")]
        public Dictionary<string, object>? AdditionalProperties { get; set; }
    }
}