@jellyfin/sdk 0.7.0

package/lib/generated-client/api/years-api.d.ts

@@ -0,0 +1,272 @@
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * Do not edit the class manually.
+ *
+ * Jellyfin API
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+import { AxiosPromise, AxiosInstance } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { BaseItemDto } from '../models';
+import { BaseItemDtoQueryResult } from '../models';
+import { BaseItemKind } from '../models';
+import { ImageType } from '../models';
+import { ItemFields } from '../models';
+import { SortOrder } from '../models';
+/**
+ * YearsApi - axios parameter creator
+ * @export
+ */
+export declare const YearsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Gets a year.
+     * @param {number} year The year.
+     * @param {string} [userId] Optional. Filter by user id, and attach user data.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getYear: (year: number, userId?: string, options?: any) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get years.
+     * @param {number} [startIndex] Skips over a given number of items within the results. Use for paging.
+     * @param {number} [limit] Optional. The maximum number of records to return.
+     * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
+     * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
+     * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
+     * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be excluded based on item type. This allows multiple, comma delimited.
+     * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be included based on item type. This allows multiple, comma delimited.
+     * @param {Array<string>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
+     * @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
+     * @param {boolean} [enableUserData] Optional. Include user data.
+     * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
+     * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
+     * @param {string} [userId] User Id.
+     * @param {boolean} [recursive] Search recursively.
+     * @param {boolean} [enableImages] Optional. Include image information in output.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getYears: (startIndex?: number, limit?: number, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<string>, sortBy?: Array<string>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, recursive?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs>;
+};
+/**
+ * YearsApi - functional programming interface
+ * @export
+ */
+export declare const YearsApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Gets a year.
+     * @param {number} year The year.
+     * @param {string} [userId] Optional. Filter by user id, and attach user data.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getYear(year: number, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>;
+    /**
+     *
+     * @summary Get years.
+     * @param {number} [startIndex] Skips over a given number of items within the results. Use for paging.
+     * @param {number} [limit] Optional. The maximum number of records to return.
+     * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
+     * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
+     * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
+     * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be excluded based on item type. This allows multiple, comma delimited.
+     * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be included based on item type. This allows multiple, comma delimited.
+     * @param {Array<string>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
+     * @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
+     * @param {boolean} [enableUserData] Optional. Include user data.
+     * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
+     * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
+     * @param {string} [userId] User Id.
+     * @param {boolean} [recursive] Search recursively.
+     * @param {boolean} [enableImages] Optional. Include image information in output.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getYears(startIndex?: number, limit?: number, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<string>, sortBy?: Array<string>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, recursive?: boolean, enableImages?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
+};
+/**
+ * YearsApi - factory interface
+ * @export
+ */
+export declare const YearsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Gets a year.
+     * @param {number} year The year.
+     * @param {string} [userId] Optional. Filter by user id, and attach user data.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getYear(year: number, userId?: string, options?: any): AxiosPromise<BaseItemDto>;
+    /**
+     *
+     * @summary Get years.
+     * @param {number} [startIndex] Skips over a given number of items within the results. Use for paging.
+     * @param {number} [limit] Optional. The maximum number of records to return.
+     * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
+     * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
+     * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
+     * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be excluded based on item type. This allows multiple, comma delimited.
+     * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be included based on item type. This allows multiple, comma delimited.
+     * @param {Array<string>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
+     * @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
+     * @param {boolean} [enableUserData] Optional. Include user data.
+     * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
+     * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
+     * @param {string} [userId] User Id.
+     * @param {boolean} [recursive] Search recursively.
+     * @param {boolean} [enableImages] Optional. Include image information in output.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getYears(startIndex?: number, limit?: number, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<string>, sortBy?: Array<string>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, recursive?: boolean, enableImages?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
+};
+/**
+ * Request parameters for getYear operation in YearsApi.
+ * @export
+ * @interface YearsApiGetYearRequest
+ */
+export interface YearsApiGetYearRequest {
+    /**
+     * The year.
+     * @type {number}
+     * @memberof YearsApiGetYear
+     */
+    readonly year: number;
+    /**
+     * Optional. Filter by user id, and attach user data.
+     * @type {string}
+     * @memberof YearsApiGetYear
+     */
+    readonly userId?: string;
+}
+/**
+ * Request parameters for getYears operation in YearsApi.
+ * @export
+ * @interface YearsApiGetYearsRequest
+ */
+export interface YearsApiGetYearsRequest {
+    /**
+     * Skips over a given number of items within the results. Use for paging.
+     * @type {number}
+     * @memberof YearsApiGetYears
+     */
+    readonly startIndex?: number;
+    /**
+     * Optional. The maximum number of records to return.
+     * @type {number}
+     * @memberof YearsApiGetYears
+     */
+    readonly limit?: number;
+    /**
+     * Sort Order - Ascending,Descending.
+     * @type {Array<SortOrder>}
+     * @memberof YearsApiGetYears
+     */
+    readonly sortOrder?: Array<SortOrder>;
+    /**
+     * Specify this to localize the search to a specific item or folder. Omit to use the root.
+     * @type {string}
+     * @memberof YearsApiGetYears
+     */
+    readonly parentId?: string;
+    /**
+     * Optional. Specify additional fields of information to return in the output.
+     * @type {Array<ItemFields>}
+     * @memberof YearsApiGetYears
+     */
+    readonly fields?: Array<ItemFields>;
+    /**
+     * Optional. If specified, results will be excluded based on item type. This allows multiple, comma delimited.
+     * @type {Array<BaseItemKind>}
+     * @memberof YearsApiGetYears
+     */
+    readonly excludeItemTypes?: Array<BaseItemKind>;
+    /**
+     * Optional. If specified, results will be included based on item type. This allows multiple, comma delimited.
+     * @type {Array<BaseItemKind>}
+     * @memberof YearsApiGetYears
+     */
+    readonly includeItemTypes?: Array<BaseItemKind>;
+    /**
+     * Optional. Filter by MediaType. Allows multiple, comma delimited.
+     * @type {Array<string>}
+     * @memberof YearsApiGetYears
+     */
+    readonly mediaTypes?: Array<string>;
+    /**
+     * Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
+     * @type {Array<string>}
+     * @memberof YearsApiGetYears
+     */
+    readonly sortBy?: Array<string>;
+    /**
+     * Optional. Include user data.
+     * @type {boolean}
+     * @memberof YearsApiGetYears
+     */
+    readonly enableUserData?: boolean;
+    /**
+     * Optional. The max number of images to return, per image type.
+     * @type {number}
+     * @memberof YearsApiGetYears
+     */
+    readonly imageTypeLimit?: number;
+    /**
+     * Optional. The image types to include in the output.
+     * @type {Array<ImageType>}
+     * @memberof YearsApiGetYears
+     */
+    readonly enableImageTypes?: Array<ImageType>;
+    /**
+     * User Id.
+     * @type {string}
+     * @memberof YearsApiGetYears
+     */
+    readonly userId?: string;
+    /**
+     * Search recursively.
+     * @type {boolean}
+     * @memberof YearsApiGetYears
+     */
+    readonly recursive?: boolean;
+    /**
+     * Optional. Include image information in output.
+     * @type {boolean}
+     * @memberof YearsApiGetYears
+     */
+    readonly enableImages?: boolean;
+}
+/**
+ * YearsApi - object-oriented interface
+ * @export
+ * @class YearsApi
+ * @extends {BaseAPI}
+ */
+export declare class YearsApi extends BaseAPI {
+    /**
+     *
+     * @summary Gets a year.
+     * @param {YearsApiGetYearRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof YearsApi
+     */
+    getYear(requestParameters: YearsApiGetYearRequest, options?: any): Promise<import("axios").AxiosResponse<BaseItemDto, any>>;
+    /**
+     *
+     * @summary Get years.
+     * @param {YearsApiGetYearsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof YearsApi
+     */
+    getYears(requestParameters?: YearsApiGetYearsRequest, options?: any): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any>>;
+}

package/lib/generated-client/api/years-api.js

@@ -0,0 +1,387 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * Do not edit the class manually.
+ *
+ * Jellyfin API
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.YearsApi = exports.YearsApiFactory = exports.YearsApiFp = exports.YearsApiAxiosParamCreator = void 0;
+var axios_1 = __importDefault(require("axios"));
+// Some imports not used depending on template conditions
+// @ts-ignore
+var common_1 = require("../common");
+// @ts-ignore
+var base_1 = require("../base");
+/**
+ * YearsApi - axios parameter creator
+ * @export
+ */
+var YearsApiAxiosParamCreator = function (configuration) {
+    var _this = this;
+    return {
+        /**
+         *
+         * @summary Gets a year.
+         * @param {number} year The year.
+         * @param {string} [userId] Optional. Filter by user id, and attach user data.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getYear: function (year, userId, options) {
+            if (options === void 0) { options = {}; }
+            return __awaiter(_this, void 0, void 0, function () {
+                var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            // verify required parameter 'year' is not null or undefined
+                            (0, common_1.assertParamExists)('getYear', 'year', year);
+                            localVarPath = "/Years/{year}"
+                                .replace("{".concat("year", "}"), encodeURIComponent(String(year)));
+                            localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                            if (configuration) {
+                                baseOptions = configuration.baseOptions;
+                            }
+                            localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
+                            localVarHeaderParameter = {};
+                            localVarQueryParameter = {};
+                            // authentication CustomAuthentication required
+                            return [4 /*yield*/, (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration)];
+                        case 1:
+                            // authentication CustomAuthentication required
+                            _a.sent();
+                            if (userId !== undefined) {
+                                localVarQueryParameter['userId'] = userId;
+                            }
+                            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query);
+                            headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                            localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                            return [2 /*return*/, {
+                                    url: (0, common_1.toPathString)(localVarUrlObj),
+                                    options: localVarRequestOptions,
+                                }];
+                    }
+                });
+            });
+        },
+        /**
+         *
+         * @summary Get years.
+         * @param {number} [startIndex] Skips over a given number of items within the results. Use for paging.
+         * @param {number} [limit] Optional. The maximum number of records to return.
+         * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
+         * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
+         * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
+         * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be excluded based on item type. This allows multiple, comma delimited.
+         * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be included based on item type. This allows multiple, comma delimited.
+         * @param {Array<string>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
+         * @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
+         * @param {boolean} [enableUserData] Optional. Include user data.
+         * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
+         * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
+         * @param {string} [userId] User Id.
+         * @param {boolean} [recursive] Search recursively.
+         * @param {boolean} [enableImages] Optional. Include image information in output.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getYears: function (startIndex, limit, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, mediaTypes, sortBy, enableUserData, imageTypeLimit, enableImageTypes, userId, recursive, enableImages, options) {
+            if (options === void 0) { options = {}; }
+            return __awaiter(_this, void 0, void 0, function () {
+                var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            localVarPath = "/Years";
+                            localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                            if (configuration) {
+                                baseOptions = configuration.baseOptions;
+                            }
+                            localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
+                            localVarHeaderParameter = {};
+                            localVarQueryParameter = {};
+                            // authentication CustomAuthentication required
+                            return [4 /*yield*/, (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration)];
+                        case 1:
+                            // authentication CustomAuthentication required
+                            _a.sent();
+                            if (startIndex !== undefined) {
+                                localVarQueryParameter['startIndex'] = startIndex;
+                            }
+                            if (limit !== undefined) {
+                                localVarQueryParameter['limit'] = limit;
+                            }
+                            if (sortOrder) {
+                                localVarQueryParameter['sortOrder'] = sortOrder;
+                            }
+                            if (parentId !== undefined) {
+                                localVarQueryParameter['parentId'] = parentId;
+                            }
+                            if (fields) {
+                                localVarQueryParameter['fields'] = fields;
+                            }
+                            if (excludeItemTypes) {
+                                localVarQueryParameter['excludeItemTypes'] = excludeItemTypes;
+                            }
+                            if (includeItemTypes) {
+                                localVarQueryParameter['includeItemTypes'] = includeItemTypes;
+                            }
+                            if (mediaTypes) {
+                                localVarQueryParameter['mediaTypes'] = mediaTypes;
+                            }
+                            if (sortBy) {
+                                localVarQueryParameter['sortBy'] = sortBy;
+                            }
+                            if (enableUserData !== undefined) {
+                                localVarQueryParameter['enableUserData'] = enableUserData;
+                            }
+                            if (imageTypeLimit !== undefined) {
+                                localVarQueryParameter['imageTypeLimit'] = imageTypeLimit;
+                            }
+                            if (enableImageTypes) {
+                                localVarQueryParameter['enableImageTypes'] = enableImageTypes;
+                            }
+                            if (userId !== undefined) {
+                                localVarQueryParameter['userId'] = userId;
+                            }
+                            if (recursive !== undefined) {
+                                localVarQueryParameter['recursive'] = recursive;
+                            }
+                            if (enableImages !== undefined) {
+                                localVarQueryParameter['enableImages'] = enableImages;
+                            }
+                            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query);
+                            headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                            localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                            return [2 /*return*/, {
+                                    url: (0, common_1.toPathString)(localVarUrlObj),
+                                    options: localVarRequestOptions,
+                                }];
+                    }
+                });
+            });
+        },
+    };
+};
+exports.YearsApiAxiosParamCreator = YearsApiAxiosParamCreator;
+/**
+ * YearsApi - functional programming interface
+ * @export
+ */
+var YearsApiFp = function (configuration) {
+    var localVarAxiosParamCreator = (0, exports.YearsApiAxiosParamCreator)(configuration);
+    return {
+        /**
+         *
+         * @summary Gets a year.
+         * @param {number} year The year.
+         * @param {string} [userId] Optional. Filter by user id, and attach user data.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getYear: function (year, userId, options) {
+            return __awaiter(this, void 0, void 0, function () {
+                var localVarAxiosArgs;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.getYear(year, userId, options)];
+                        case 1:
+                            localVarAxiosArgs = _a.sent();
+                            return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
+                    }
+                });
+            });
+        },
+        /**
+         *
+         * @summary Get years.
+         * @param {number} [startIndex] Skips over a given number of items within the results. Use for paging.
+         * @param {number} [limit] Optional. The maximum number of records to return.
+         * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
+         * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
+         * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
+         * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be excluded based on item type. This allows multiple, comma delimited.
+         * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be included based on item type. This allows multiple, comma delimited.
+         * @param {Array<string>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
+         * @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
+         * @param {boolean} [enableUserData] Optional. Include user data.
+         * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
+         * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
+         * @param {string} [userId] User Id.
+         * @param {boolean} [recursive] Search recursively.
+         * @param {boolean} [enableImages] Optional. Include image information in output.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getYears: function (startIndex, limit, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, mediaTypes, sortBy, enableUserData, imageTypeLimit, enableImageTypes, userId, recursive, enableImages, options) {
+            return __awaiter(this, void 0, void 0, function () {
+                var localVarAxiosArgs;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.getYears(startIndex, limit, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, mediaTypes, sortBy, enableUserData, imageTypeLimit, enableImageTypes, userId, recursive, enableImages, options)];
+                        case 1:
+                            localVarAxiosArgs = _a.sent();
+                            return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
+                    }
+                });
+            });
+        },
+    };
+};
+exports.YearsApiFp = YearsApiFp;
+/**
+ * YearsApi - factory interface
+ * @export
+ */
+var YearsApiFactory = function (configuration, basePath, axios) {
+    var localVarFp = (0, exports.YearsApiFp)(configuration);
+    return {
+        /**
+         *
+         * @summary Gets a year.
+         * @param {number} year The year.
+         * @param {string} [userId] Optional. Filter by user id, and attach user data.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getYear: function (year, userId, options) {
+            return localVarFp.getYear(year, userId, options).then(function (request) { return request(axios, basePath); });
+        },
+        /**
+         *
+         * @summary Get years.
+         * @param {number} [startIndex] Skips over a given number of items within the results. Use for paging.
+         * @param {number} [limit] Optional. The maximum number of records to return.
+         * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
+         * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
+         * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
+         * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be excluded based on item type. This allows multiple, comma delimited.
+         * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be included based on item type. This allows multiple, comma delimited.
+         * @param {Array<string>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
+         * @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
+         * @param {boolean} [enableUserData] Optional. Include user data.
+         * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
+         * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
+         * @param {string} [userId] User Id.
+         * @param {boolean} [recursive] Search recursively.
+         * @param {boolean} [enableImages] Optional. Include image information in output.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getYears: function (startIndex, limit, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, mediaTypes, sortBy, enableUserData, imageTypeLimit, enableImageTypes, userId, recursive, enableImages, options) {
+            return localVarFp.getYears(startIndex, limit, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, mediaTypes, sortBy, enableUserData, imageTypeLimit, enableImageTypes, userId, recursive, enableImages, options).then(function (request) { return request(axios, basePath); });
+        },
+    };
+};
+exports.YearsApiFactory = YearsApiFactory;
+/**
+ * YearsApi - object-oriented interface
+ * @export
+ * @class YearsApi
+ * @extends {BaseAPI}
+ */
+var YearsApi = /** @class */ (function (_super) {
+    __extends(YearsApi, _super);
+    function YearsApi() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     *
+     * @summary Gets a year.
+     * @param {YearsApiGetYearRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof YearsApi
+     */
+    YearsApi.prototype.getYear = function (requestParameters, options) {
+        var _this = this;
+        return (0, exports.YearsApiFp)(this.configuration).getYear(requestParameters.year, requestParameters.userId, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
+    /**
+     *
+     * @summary Get years.
+     * @param {YearsApiGetYearsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof YearsApi
+     */
+    YearsApi.prototype.getYears = function (requestParameters, options) {
+        var _this = this;
+        if (requestParameters === void 0) { requestParameters = {}; }
+        return (0, exports.YearsApiFp)(this.configuration).getYears(requestParameters.startIndex, requestParameters.limit, requestParameters.sortOrder, requestParameters.parentId, requestParameters.fields, requestParameters.excludeItemTypes, requestParameters.includeItemTypes, requestParameters.mediaTypes, requestParameters.sortBy, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, requestParameters.userId, requestParameters.recursive, requestParameters.enableImages, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
+    return YearsApi;
+}(base_1.BaseAPI));
+exports.YearsApi = YearsApi;