plexcsharp/LukeHagar/PlexAPI/SDK/Models/Requests/GetLibraryMatchesRequest.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.Utils;
    
    public class GetLibraryMatchesRequest
    {

        /// <summary>
        /// Indicates the client accepts the indicated media types
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=accepts")]
        public Accepts? Accepts { get; set; } = LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml;

        /// <summary>
        /// An opaque identifier unique to the client
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Plex-Client-Identifier")]
        public string? ClientIdentifier { get; set; }

        /// <summary>
        /// The name of the client product
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Plex-Product")]
        public string? Product { get; set; }

        /// <summary>
        /// The version of the client application
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Plex-Version")]
        public string? Version { get; set; }

        /// <summary>
        /// The platform of the client
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Plex-Platform")]
        public string? Platform { get; set; }

        /// <summary>
        /// The version of the platform
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Plex-Platform-Version")]
        public string? PlatformVersion { get; set; }

        /// <summary>
        /// A relatively friendly name for the client device
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Plex-Device")]
        public string? Device { get; set; }

        /// <summary>
        /// A potentially less friendly identifier for the device model
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Plex-Model")]
        public string? Model { get; set; }

        /// <summary>
        /// The device vendor
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Plex-Device-Vendor")]
        public string? DeviceVendor { get; set; }

        /// <summary>
        /// A friendly name for the client
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Plex-Device-Name")]
        public string? DeviceName { get; set; }

        /// <summary>
        /// The marketplace on which the client application is distributed
        /// </summary>
        [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Plex-Marketplace")]
        public string? Marketplace { get; set; }

        /// <summary>
        /// The type of media to retrieve or filter by.<br/>
        /// 
        /// <remarks>
        /// <br/>
        /// 1 = movie<br/>
        /// 2 = show<br/>
        /// 3 = season<br/>
        /// 4 = episode<br/>
        /// 5 = artist<br/>
        /// 6 = album<br/>
        /// 7 = track<br/>
        /// 8 = photo_album<br/>
        /// 9 = photo<br/>
        /// <br/>
        /// E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/>
        /// 
        /// </remarks>
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=type")]
        public MediaType? Type { get; set; }

        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=includeFullMetadata")]
        public BoolInt? IncludeFullMetadata { get; set; } = LukeHagar.PlexAPI.SDK.Models.Components.BoolInt.False;

        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=includeAncestorMetadata")]
        public BoolInt? IncludeAncestorMetadata { get; set; } = LukeHagar.PlexAPI.SDK.Models.Components.BoolInt.False;

        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=includeAlternateMetadataSources")]
        public BoolInt? IncludeAlternateMetadataSources { get; set; } = LukeHagar.PlexAPI.SDK.Models.Components.BoolInt.False;

        /// <summary>
        /// Used for movies, shows, artists, albums, and tracks.  Allowed for various URI schemes, to be defined.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=guid")]
        public string? Guid { get; set; }

        /// <summary>
        /// The title to filter by or assign
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=title")]
        public string? Title { get; set; }

        /// <summary>
        /// Used for movies shows, and albums.  Optional.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=year")]
        public long? Year { get; set; }

        /// <summary>
        /// Used for movies, episodes, and tracks.  The full path to the media file, used for &quot;cloud-scanning&quot; an item.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=path")]
        public string? Path { get; set; }

        /// <summary>
        /// Used for episodes and tracks.  The title of the show/artist. Required if `path` isn&apos;t passed.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=grandparentTitle")]
        public string? GrandparentTitle { get; set; }

        /// <summary>
        /// Used for episodes.  The year of the show.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=grandparentYear")]
        public long? GrandparentYear { get; set; }

        /// <summary>
        /// Used for episodes and tracks.  The season/album number.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=parentIndex")]
        public long? ParentIndex { get; set; }

        /// <summary>
        /// Used for episodes and tracks.  The episode/tracks number in the season/album.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=index")]
        public long? Index { get; set; }

        /// <summary>
        /// Used for episodes.  In the format `YYYY-MM-DD`.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=originallyAvailableAt")]
        public string? OriginallyAvailableAt { get; set; }

        /// <summary>
        /// Used for albums and tracks. The artist name for albums or the album name for tracks.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=parentTitle")]
        public string? ParentTitle { get; set; }
    }
}