//------------------------------------------------------------------------------
// <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.Utils;
    using Newtonsoft.Json;
    
    /// <summary>
    /// `MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.<br/>
    /// 
    /// <remarks>
    /// Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)<br/>
    /// The container often &quot;hoists&quot; common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track.<br/>
    /// 
    /// </remarks>
    /// </summary>
    public class CreatePlayQueueMediaContainer
    {

        [JsonProperty("identifier")]
        public string? Identifier { get; set; }

        /// <summary>
        /// The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/>
        /// 
        /// <remarks>
        /// 
        /// </remarks>
        /// </summary>
        [JsonProperty("offset")]
        public long? Offset { get; set; }

        [JsonProperty("size")]
        public long? Size { get; set; }

        /// <summary>
        /// The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/>
        /// 
        /// <remarks>
        /// 
        /// </remarks>
        /// </summary>
        [JsonProperty("totalSize")]
        public long? TotalSize { get; set; }

        /// <summary>
        /// The ID of the play queue, which is used in subsequent requests.
        /// </summary>
        [JsonProperty("playQueueID")]
        public long? PlayQueueID { get; set; }

        /// <summary>
        /// Defines where the &quot;Up Next&quot; region starts
        /// </summary>
        [JsonProperty("playQueueLastAddedItemID")]
        public string? PlayQueueLastAddedItemID { get; set; }

        /// <summary>
        /// The queue item ID of the currently selected  item.
        /// </summary>
        [JsonProperty("playQueueSelectedItemID")]
        public long? PlayQueueSelectedItemID { get; set; }

        /// <summary>
        /// The offset of the selected item in the play queue, from the beginning of the queue.
        /// </summary>
        [JsonProperty("playQueueSelectedItemOffset")]
        public long? PlayQueueSelectedItemOffset { get; set; }

        /// <summary>
        /// The metadata item ID of the currently selected item (matches `ratingKey` attribute in metadata item if the media provider is a library).
        /// </summary>
        [JsonProperty("playQueueSelectedMetadataItemID")]
        public long? PlayQueueSelectedMetadataItemID { get; set; }

        /// <summary>
        /// Whether or not the queue is shuffled.
        /// </summary>
        [JsonProperty("playQueueShuffled")]
        public bool? PlayQueueShuffled { get; set; }

        /// <summary>
        /// The original URI used to create the play queue.
        /// </summary>
        [JsonProperty("playQueueSourceURI")]
        public string? PlayQueueSourceURI { get; set; }

        /// <summary>
        /// The total number of items in the play queue.
        /// </summary>
        [JsonProperty("playQueueTotalCount")]
        public long? PlayQueueTotalCount { get; set; }

        /// <summary>
        /// The version of the play queue. It increments every time a change is made to the play queue to assist clients in knowing when to refresh.
        /// </summary>
        [JsonProperty("playQueueVersion")]
        public long? PlayQueueVersion { get; set; }
    }
}