@jellyfin/sdk 0.10.0 → 0.11.0

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

@@ -8,14 +8,14 @@
  * 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, AxiosRequestConfig } from 'axios';
-import { Configuration } from '../configuration';
-import { RequestArgs, BaseAPI } from '../base';
-import { BaseItemDto } from '../models';
-import { BaseItemDtoQueryResult } from '../models';
-import { ImageType } from '../models';
-import { ItemFields } from '../models';
-import { ItemFilter } from '../models';
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { BaseItemDto } from '../models';
+import type { BaseItemDtoQueryResult } from '../models';
+import type { ImageType } from '../models';
+import type { ItemFields } from '../models';
+import type { ItemFilter } from '../models';
 /**
  * PersonsApi - axios parameter creator
  * @export
@@ -29,7 +29,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPerson: (name: string, userId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getPerson: (name: string, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Gets all persons.
@@ -49,7 +49,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPersons: (limit?: number, searchTerm?: string, fields?: Array<ItemFields>, filters?: Array<ItemFilter>, isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, excludePersonTypes?: Array<string>, personTypes?: Array<string>, appearsInItemId?: string, userId?: string, enableImages?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getPersons: (limit?: number, searchTerm?: string, fields?: Array<ItemFields>, filters?: Array<ItemFilter>, isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, excludePersonTypes?: Array<string>, personTypes?: Array<string>, appearsInItemId?: string, userId?: string, enableImages?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * PersonsApi - functional programming interface
@@ -64,7 +64,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPerson(name: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>;
+    getPerson(name: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>;
     /**
      *
      * @summary Gets all persons.
@@ -84,7 +84,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPersons(limit?: number, searchTerm?: string, fields?: Array<ItemFields>, filters?: Array<ItemFilter>, isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, excludePersonTypes?: Array<string>, personTypes?: Array<string>, appearsInItemId?: string, userId?: string, enableImages?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
+    getPersons(limit?: number, searchTerm?: string, fields?: Array<ItemFields>, filters?: Array<ItemFilter>, isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, excludePersonTypes?: Array<string>, personTypes?: Array<string>, appearsInItemId?: string, userId?: string, enableImages?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
 };
 /**
  * PersonsApi - factory interface
@@ -94,32 +94,19 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
     /**
      *
      * @summary Get person by name.
-     * @param {string} name Person name.
-     * @param {string} [userId] Optional. Filter by user id, and attach user data.
+     * @param {PersonsApiGetPersonRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPerson(name: string, userId?: string, options?: any): AxiosPromise<BaseItemDto>;
+    getPerson(requestParameters: PersonsApiGetPersonRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDto>;
     /**
      *
      * @summary Gets all persons.
-     * @param {number} [limit] Optional. The maximum number of records to return.
-     * @param {string} [searchTerm] The search term.
-     * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
-     * @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
-     * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not. userId is required.
-     * @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 {Array<string>} [excludePersonTypes] Optional. If specified results will be filtered to exclude those containing the specified PersonType. Allows multiple, comma-delimited.
-     * @param {Array<string>} [personTypes] Optional. If specified results will be filtered to include only those containing the specified PersonType. Allows multiple, comma-delimited.
-     * @param {string} [appearsInItemId] Optional. If specified, person results will be filtered on items related to said persons.
-     * @param {string} [userId] User id.
-     * @param {boolean} [enableImages] Optional, include image information in output.
+     * @param {PersonsApiGetPersonsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPersons(limit?: number, searchTerm?: string, fields?: Array<ItemFields>, filters?: Array<ItemFilter>, isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, excludePersonTypes?: Array<string>, personTypes?: Array<string>, appearsInItemId?: string, userId?: string, enableImages?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
+    getPersons(requestParameters?: PersonsApiGetPersonsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
 };
 /**
  * Request parameters for getPerson operation in PersonsApi.
@@ -240,7 +227,7 @@ export declare class PersonsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PersonsApi
      */
-    getPerson(requestParameters: PersonsApiGetPersonRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDto, any>>;
+    getPerson(requestParameters: PersonsApiGetPersonRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDto, any>>;
     /**
      *
      * @summary Gets all persons.
@@ -249,5 +236,5 @@ export declare class PersonsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PersonsApi
      */
-    getPersons(requestParameters?: PersonsApiGetPersonsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any>>;
+    getPersons(requestParameters?: PersonsApiGetPersonsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any>>;
 }

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

@@ -1,6 +1,6 @@
 import globalAxios from 'axios';
 import { assertParamExists, DUMMY_BASE_URL, setApiKeyToObject, setSearchParams, toPathString, createRequestFunction } from '../common.js';
-import { BaseAPI, BASE_PATH } from '../base.js';
+import { operationServerMap, BaseAPI, BASE_PATH } from '../base.js';
 
 /* tslint:disable */
 /* eslint-disable */
@@ -152,8 +152,11 @@ const PersonsApiFp = function (configuration) {
          * @throws {RequiredError}
          */
         async getPerson(name, userId, options) {
+            var _a, _b, _c;
             const localVarAxiosArgs = await localVarAxiosParamCreator.getPerson(name, userId, options);
-            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+            const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PersonsApi.getPerson']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
          *
@@ -175,8 +178,11 @@ const PersonsApiFp = function (configuration) {
          * @throws {RequiredError}
          */
         async getPersons(limit, searchTerm, fields, filters, isFavorite, enableUserData, imageTypeLimit, enableImageTypes, excludePersonTypes, personTypes, appearsInItemId, userId, enableImages, options) {
+            var _a, _b, _c;
             const localVarAxiosArgs = await localVarAxiosParamCreator.getPersons(limit, searchTerm, fields, filters, isFavorite, enableUserData, imageTypeLimit, enableImageTypes, excludePersonTypes, personTypes, appearsInItemId, userId, enableImages, options);
-            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+            const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PersonsApi.getPersons']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
     };
 };
@@ -190,35 +196,22 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
         /**
          *
          * @summary Get person by name.
-         * @param {string} name Person name.
-         * @param {string} [userId] Optional. Filter by user id, and attach user data.
+         * @param {PersonsApiGetPersonRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getPerson(name, userId, options) {
-            return localVarFp.getPerson(name, userId, options).then((request) => request(axios, basePath));
+        getPerson(requestParameters, options) {
+            return localVarFp.getPerson(requestParameters.name, requestParameters.userId, options).then((request) => request(axios, basePath));
         },
         /**
          *
          * @summary Gets all persons.
-         * @param {number} [limit] Optional. The maximum number of records to return.
-         * @param {string} [searchTerm] The search term.
-         * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
-         * @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
-         * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not. userId is required.
-         * @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 {Array<string>} [excludePersonTypes] Optional. If specified results will be filtered to exclude those containing the specified PersonType. Allows multiple, comma-delimited.
-         * @param {Array<string>} [personTypes] Optional. If specified results will be filtered to include only those containing the specified PersonType. Allows multiple, comma-delimited.
-         * @param {string} [appearsInItemId] Optional. If specified, person results will be filtered on items related to said persons.
-         * @param {string} [userId] User id.
-         * @param {boolean} [enableImages] Optional, include image information in output.
+         * @param {PersonsApiGetPersonsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getPersons(limit, searchTerm, fields, filters, isFavorite, enableUserData, imageTypeLimit, enableImageTypes, excludePersonTypes, personTypes, appearsInItemId, userId, enableImages, options) {
-            return localVarFp.getPersons(limit, searchTerm, fields, filters, isFavorite, enableUserData, imageTypeLimit, enableImageTypes, excludePersonTypes, personTypes, appearsInItemId, userId, enableImages, options).then((request) => request(axios, basePath));
+        getPersons(requestParameters = {}, options) {
+            return localVarFp.getPersons(requestParameters.limit, requestParameters.searchTerm, requestParameters.fields, requestParameters.filters, requestParameters.isFavorite, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, requestParameters.excludePersonTypes, requestParameters.personTypes, requestParameters.appearsInItemId, requestParameters.userId, requestParameters.enableImages, options).then((request) => request(axios, basePath));
         },
     };
 };