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

        /// <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 source URL for the image to transcode.  Note, if this URL requires a token such as `X-Plex-Token`, it should be given as a query parameter to this url.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=url")]
        public string? Url { get; set; }

        /// <summary>
        /// The output format for the image; defaults to jpg
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=format")]
        public Models.Requests.Format? Format { get; set; }

        /// <summary>
        /// The desired width of the output image
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=width")]
        public long? Width { get; set; }

        /// <summary>
        /// The desired height of the output image
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=height")]
        public long? Height { get; set; }

        /// <summary>
        /// The desired quality of the output.  -1 means the highest quality.  Defaults to -1
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=quality")]
        public long? Quality { get; set; }

        /// <summary>
        /// The background color to apply before painting the image.  Only really applicable if image has transparency.  Defaults to none
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=background")]
        public string? Background { get; set; }

        /// <summary>
        /// Indicates if image should be upscaled to the desired width/height.  Defaults to false
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=upscale")]
        public BoolInt? Upscale { get; set; } = LukeHagar.PlexAPI.SDK.Models.Components.BoolInt.False;

        /// <summary>
        /// Indicates if image should be scaled to fit the smaller dimension.  By default (false) the image is scaled to fit within the width/height specified but if this parameter is true, it will allow overflowing one dimension to fit the other.  Essentially it is making the width/height minimum sizes of the image or sizing the image to fill the entire width/height even if it overflows one dimension.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=minSize")]
        public BoolInt? MinSize { get; set; } = LukeHagar.PlexAPI.SDK.Models.Components.BoolInt.False;

        /// <summary>
        /// Obey the rotation values specified in EXIF data.  Defaults to true.
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=rotate")]
        public BoolInt? Rotate { get; set; } = LukeHagar.PlexAPI.SDK.Models.Components.BoolInt.False;

        /// <summary>
        /// Apply a blur to the image, Defaults to 0 (none)
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=blur")]
        public long? Blur { get; set; }

        /// <summary>
        /// Scale the image saturation by the specified percentage.  Defaults to 100
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=saturation")]
        public long? Saturation { get; set; }

        /// <summary>
        /// Render the image at the specified opacity percentage.  Defaults to 100
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=opacity")]
        public long? Opacity { get; set; }

        /// <summary>
        /// Use the specified chroma subsambling.<br/>
        /// 
        /// <remarks>
        ///   - 0: 411<br/>
        ///   - 1: 420<br/>
        ///   - 2: 422<br/>
        ///   - 3: 444<br/>
        /// Defaults to 3 (444)
        /// </remarks>
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=chromaSubsampling")]
        public ChromaSubsampling? ChromaSubsampling { get; set; }

        /// <summary>
        /// The color to blend with the image.  Defaults to none
        /// </summary>
        [SpeakeasyMetadata("queryParam:style=form,explode=true,name=blendColor")]
        public string? BlendColor { get; set; }
    }
}