/** * 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 localVarRequest from 'request'; import http from 'http'; /* tslint:disable:no-unused-locals */ import { BaseItemDto } from '../model/baseItemDto'; import { BaseItemDtoQueryResult } from '../model/baseItemDtoQueryResult'; import { BaseItemKind } from '../model/baseItemKind'; import { ImageType } from '../model/imageType'; import { ItemFields } from '../model/itemFields'; import { ProblemDetails } from '../model/problemDetails'; import { SortOrder } from '../model/sortOrder'; import { ObjectSerializer, Authentication, VoidAuth, Interceptor } from '../model/models'; import { HttpBasicAuth, HttpBearerAuth, ApiKeyAuth, OAuth } from '../model/models'; import { HttpError, RequestFile } from './apis'; let defaultBasePath = 'http://localhost'; // =============================================== // This file is autogenerated - Please do not edit // =============================================== export enum YearsApiApiKeys { CustomAuthentication, } export class YearsApi { protected _basePath = defaultBasePath; protected _defaultHeaders : any = {}; protected _useQuerystring : boolean = false; protected authentications = { 'default': new VoidAuth(), 'CustomAuthentication': new ApiKeyAuth('header', 'Authorization'), } protected interceptors: Interceptor[] = []; constructor(basePath?: string); constructor(basePathOrUsername: string, password?: string, basePath?: string) { if (password) { if (basePath) { this.basePath = basePath; } } else { if (basePathOrUsername) { this.basePath = basePathOrUsername } } } set useQuerystring(value: boolean) { this._useQuerystring = value; } set basePath(basePath: string) { this._basePath = basePath; } set defaultHeaders(defaultHeaders: any) { this._defaultHeaders = defaultHeaders; } get defaultHeaders() { return this._defaultHeaders; } get basePath() { return this._basePath; } public setDefaultAuthentication(auth: Authentication) { this.authentications.default = auth; } public setApiKey(key: YearsApiApiKeys, value: string) { (this.authentications as any)[YearsApiApiKeys[key]].apiKey = value; } public addInterceptor(interceptor: Interceptor) { this.interceptors.push(interceptor); } /** * * @summary Gets a year. * @param year The year. * @param userId Optional. Filter by user id, and attach user data. */ public async getYear (year: number, userId?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: BaseItemDto; }> { const localVarPath = this.basePath + '/Years/{year}' .replace('{' + 'year' + '}', encodeURIComponent(String(year))); let localVarQueryParameters: any = {}; let localVarHeaderParams: any = (Object).assign({}, this._defaultHeaders); const produces = ['application/json', 'application/json; profile=CamelCase', 'application/json; profile=PascalCase']; // give precedence to 'application/json' if (produces.indexOf('application/json') >= 0) { localVarHeaderParams.Accept = 'application/json'; } else { localVarHeaderParams.Accept = produces.join(','); } let localVarFormParams: any = {}; // verify required parameter 'year' is not null or undefined if (year === null || year === undefined) { throw new Error('Required parameter year was null or undefined when calling getYear.'); } if (userId !== undefined) { localVarQueryParameters['userId'] = ObjectSerializer.serialize(userId, "string"); } (Object).assign(localVarHeaderParams, options.headers); let localVarUseFormData = false; let localVarRequestOptions: localVarRequest.Options = { method: 'GET', qs: localVarQueryParameters, headers: localVarHeaderParams, uri: localVarPath, useQuerystring: this._useQuerystring, json: true, }; let authenticationPromise = Promise.resolve(); if (this.authentications.CustomAuthentication.apiKey) { authenticationPromise = authenticationPromise.then(() => this.authentications.CustomAuthentication.applyToRequest(localVarRequestOptions)); } authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions)); let interceptorPromise = authenticationPromise; for (const interceptor of this.interceptors) { interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions)); } return interceptorPromise.then(() => { if (Object.keys(localVarFormParams).length) { if (localVarUseFormData) { (localVarRequestOptions).formData = localVarFormParams; } else { localVarRequestOptions.form = localVarFormParams; } } return new Promise<{ response: http.IncomingMessage; body: BaseItemDto; }>((resolve, reject) => { localVarRequest(localVarRequestOptions, (error, response, body) => { if (error) { reject(error); } else { if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) { body = ObjectSerializer.deserialize(body, "BaseItemDto"); resolve({ response: response, body: body }); } else { reject(new HttpError(response, body, response.statusCode)); } } }); }); }); } /** * * @summary Get years. * @param startIndex Skips over a given number of items within the results. Use for paging. * @param limit Optional. The maximum number of records to return. * @param sortOrder Sort Order - Ascending,Descending. * @param parentId Specify this to localize the search to a specific item or folder. Omit to use the root. * @param fields Optional. Specify additional fields of information to return in the output. * @param excludeItemTypes Optional. If specified, results will be excluded based on item type. This allows multiple, comma delimited. * @param includeItemTypes Optional. If specified, results will be included based on item type. This allows multiple, comma delimited. * @param mediaTypes Optional. Filter by MediaType. Allows multiple, comma delimited. * @param 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 enableUserData Optional. Include user data. * @param imageTypeLimit Optional. The max number of images to return, per image type. * @param enableImageTypes Optional. The image types to include in the output. * @param userId User Id. * @param recursive Search recursively. * @param enableImages Optional. Include image information in output. */ public async getYears (startIndex?: number, limit?: number, sortOrder?: Array, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, mediaTypes?: Array, sortBy?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, userId?: string, recursive?: boolean, enableImages?: boolean, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: BaseItemDtoQueryResult; }> { const localVarPath = this.basePath + '/Years'; let localVarQueryParameters: any = {}; let localVarHeaderParams: any = (Object).assign({}, this._defaultHeaders); const produces = ['application/json', 'application/json; profile=CamelCase', 'application/json; profile=PascalCase']; // give precedence to 'application/json' if (produces.indexOf('application/json') >= 0) { localVarHeaderParams.Accept = 'application/json'; } else { localVarHeaderParams.Accept = produces.join(','); } let localVarFormParams: any = {}; if (startIndex !== undefined) { localVarQueryParameters['startIndex'] = ObjectSerializer.serialize(startIndex, "number"); } if (limit !== undefined) { localVarQueryParameters['limit'] = ObjectSerializer.serialize(limit, "number"); } if (sortOrder !== undefined) { localVarQueryParameters['sortOrder'] = ObjectSerializer.serialize(sortOrder, "Array"); } if (parentId !== undefined) { localVarQueryParameters['parentId'] = ObjectSerializer.serialize(parentId, "string"); } if (fields !== undefined) { localVarQueryParameters['fields'] = ObjectSerializer.serialize(fields, "Array"); } if (excludeItemTypes !== undefined) { localVarQueryParameters['excludeItemTypes'] = ObjectSerializer.serialize(excludeItemTypes, "Array"); } if (includeItemTypes !== undefined) { localVarQueryParameters['includeItemTypes'] = ObjectSerializer.serialize(includeItemTypes, "Array"); } if (mediaTypes !== undefined) { localVarQueryParameters['mediaTypes'] = ObjectSerializer.serialize(mediaTypes, "Array"); } if (sortBy !== undefined) { localVarQueryParameters['sortBy'] = ObjectSerializer.serialize(sortBy, "Array"); } if (enableUserData !== undefined) { localVarQueryParameters['enableUserData'] = ObjectSerializer.serialize(enableUserData, "boolean"); } if (imageTypeLimit !== undefined) { localVarQueryParameters['imageTypeLimit'] = ObjectSerializer.serialize(imageTypeLimit, "number"); } if (enableImageTypes !== undefined) { localVarQueryParameters['enableImageTypes'] = ObjectSerializer.serialize(enableImageTypes, "Array"); } if (userId !== undefined) { localVarQueryParameters['userId'] = ObjectSerializer.serialize(userId, "string"); } if (recursive !== undefined) { localVarQueryParameters['recursive'] = ObjectSerializer.serialize(recursive, "boolean"); } if (enableImages !== undefined) { localVarQueryParameters['enableImages'] = ObjectSerializer.serialize(enableImages, "boolean"); } (Object).assign(localVarHeaderParams, options.headers); let localVarUseFormData = false; let localVarRequestOptions: localVarRequest.Options = { method: 'GET', qs: localVarQueryParameters, headers: localVarHeaderParams, uri: localVarPath, useQuerystring: this._useQuerystring, json: true, }; let authenticationPromise = Promise.resolve(); if (this.authentications.CustomAuthentication.apiKey) { authenticationPromise = authenticationPromise.then(() => this.authentications.CustomAuthentication.applyToRequest(localVarRequestOptions)); } authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions)); let interceptorPromise = authenticationPromise; for (const interceptor of this.interceptors) { interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions)); } return interceptorPromise.then(() => { if (Object.keys(localVarFormParams).length) { if (localVarUseFormData) { (localVarRequestOptions).formData = localVarFormParams; } else { localVarRequestOptions.form = localVarFormParams; } } return new Promise<{ response: http.IncomingMessage; body: BaseItemDtoQueryResult; }>((resolve, reject) => { localVarRequest(localVarRequestOptions, (error, response, body) => { if (error) { reject(error); } else { if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) { body = ObjectSerializer.deserialize(body, "BaseItemDtoQueryResult"); resolve({ response: response, body: body }); } else { reject(new HttpError(response, body, response.statusCode)); } } }); }); }); } }