jellyfin-discord-bot/jellyfin/model/getProgramsDto.ts

/**
 * Jellyfin API
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: 10.8.9
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

import { RequestFile } from './models';
import { ImageType } from './imageType';
import { ItemFields } from './itemFields';
import { SortOrder } from './sortOrder';

/**
* Get programs dto.
*/
export class GetProgramsDto {
    /**
    * Gets or sets the channels to return guide information for.
    */
    'channelIds'?: Array<string>;
    /**
    * Gets or sets optional. Filter by user id.
    */
    'userId'?: string;
    /**
    * Gets or sets the minimum premiere start date.  Optional.
    */
    'minStartDate'?: Date | null;
    /**
    * Gets or sets filter by programs that have completed airing, or not.  Optional.
    */
    'hasAired'?: boolean | null;
    /**
    * Gets or sets filter by programs that are currently airing, or not.  Optional.
    */
    'isAiring'?: boolean | null;
    /**
    * Gets or sets the maximum premiere start date.  Optional.
    */
    'maxStartDate'?: Date | null;
    /**
    * Gets or sets the minimum premiere end date.  Optional.
    */
    'minEndDate'?: Date | null;
    /**
    * Gets or sets the maximum premiere end date.  Optional.
    */
    'maxEndDate'?: Date | null;
    /**
    * Gets or sets filter for movies.  Optional.
    */
    'isMovie'?: boolean | null;
    /**
    * Gets or sets filter for series.  Optional.
    */
    'isSeries'?: boolean | null;
    /**
    * Gets or sets filter for news.  Optional.
    */
    'isNews'?: boolean | null;
    /**
    * Gets or sets filter for kids.  Optional.
    */
    'isKids'?: boolean | null;
    /**
    * Gets or sets filter for sports.  Optional.
    */
    'isSports'?: boolean | null;
    /**
    * Gets or sets the record index to start at. All items with a lower index will be dropped from the results.  Optional.
    */
    'startIndex'?: number | null;
    /**
    * Gets or sets the maximum number of records to return.  Optional.
    */
    'limit'?: number | null;
    /**
    * Gets or sets specify one or more sort orders, comma delimited. Options: Name, StartDate.  Optional.
    */
    'sortBy'?: Array<string>;
    /**
    * Gets or sets sort Order - Ascending,Descending.
    */
    'sortOrder'?: Array<SortOrder>;
    /**
    * Gets or sets the genres to return guide information for.
    */
    'genres'?: Array<string>;
    /**
    * Gets or sets the genre ids to return guide information for.
    */
    'genreIds'?: Array<string>;
    /**
    * Gets or sets include image information in output.  Optional.
    */
    'enableImages'?: boolean | null;
    /**
    * Gets or sets a value indicating whether retrieve total record count.
    */
    'enableTotalRecordCount'?: boolean;
    /**
    * Gets or sets the max number of images to return, per image type.  Optional.
    */
    'imageTypeLimit'?: number | null;
    /**
    * Gets or sets the image types to include in the output.  Optional.
    */
    'enableImageTypes'?: Array<ImageType>;
    /**
    * Gets or sets include user data.  Optional.
    */
    'enableUserData'?: boolean | null;
    /**
    * Gets or sets filter by series timer id.  Optional.
    */
    'seriesTimerId'?: string | null;
    /**
    * Gets or sets filter by library series id.  Optional.
    */
    'librarySeriesId'?: string;
    /**
    * Gets or sets specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.  Optional.
    */
    'fields'?: Array<ItemFields>;

    static discriminator: string | undefined = undefined;

    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
        {
            "name": "channelIds",
            "baseName": "ChannelIds",
            "type": "Array<string>"
        },
        {
            "name": "userId",
            "baseName": "UserId",
            "type": "string"
        },
        {
            "name": "minStartDate",
            "baseName": "MinStartDate",
            "type": "Date"
        },
        {
            "name": "hasAired",
            "baseName": "HasAired",
            "type": "boolean"
        },
        {
            "name": "isAiring",
            "baseName": "IsAiring",
            "type": "boolean"
        },
        {
            "name": "maxStartDate",
            "baseName": "MaxStartDate",
            "type": "Date"
        },
        {
            "name": "minEndDate",
            "baseName": "MinEndDate",
            "type": "Date"
        },
        {
            "name": "maxEndDate",
            "baseName": "MaxEndDate",
            "type": "Date"
        },
        {
            "name": "isMovie",
            "baseName": "IsMovie",
            "type": "boolean"
        },
        {
            "name": "isSeries",
            "baseName": "IsSeries",
            "type": "boolean"
        },
        {
            "name": "isNews",
            "baseName": "IsNews",
            "type": "boolean"
        },
        {
            "name": "isKids",
            "baseName": "IsKids",
            "type": "boolean"
        },
        {
            "name": "isSports",
            "baseName": "IsSports",
            "type": "boolean"
        },
        {
            "name": "startIndex",
            "baseName": "StartIndex",
            "type": "number"
        },
        {
            "name": "limit",
            "baseName": "Limit",
            "type": "number"
        },
        {
            "name": "sortBy",
            "baseName": "SortBy",
            "type": "Array<string>"
        },
        {
            "name": "sortOrder",
            "baseName": "SortOrder",
            "type": "Array<SortOrder>"
        },
        {
            "name": "genres",
            "baseName": "Genres",
            "type": "Array<string>"
        },
        {
            "name": "genreIds",
            "baseName": "GenreIds",
            "type": "Array<string>"
        },
        {
            "name": "enableImages",
            "baseName": "EnableImages",
            "type": "boolean"
        },
        {
            "name": "enableTotalRecordCount",
            "baseName": "EnableTotalRecordCount",
            "type": "boolean"
        },
        {
            "name": "imageTypeLimit",
            "baseName": "ImageTypeLimit",
            "type": "number"
        },
        {
            "name": "enableImageTypes",
            "baseName": "EnableImageTypes",
            "type": "Array<ImageType>"
        },
        {
            "name": "enableUserData",
            "baseName": "EnableUserData",
            "type": "boolean"
        },
        {
            "name": "seriesTimerId",
            "baseName": "SeriesTimerId",
            "type": "string"
        },
        {
            "name": "librarySeriesId",
            "baseName": "LibrarySeriesId",
            "type": "string"
        },
        {
            "name": "fields",
            "baseName": "Fields",
            "type": "Array<ItemFields>"
        }    ];

    static getAttributeTypeMap() {
        return GetProgramsDto.attributeTypeMap;
    }
}