@jellyfin/sdk 0.0.0-unstable.202303301750 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/generated-client/api/audio-api.d.ts +8 -8
- package/lib/generated-client/api/audio-api.js +6 -6
- package/lib/generated-client/api/dynamic-hls-api.d.ts +4 -4
- package/lib/generated-client/api/dynamic-hls-api.js +3 -3
- package/lib/generated-client/api/image-api.d.ts +336 -84
- package/lib/generated-client/api/image-api.js +336 -168
- package/lib/generated-client/api/image-by-name-api.js +71 -2
- package/lib/generated-client/api/items-api.d.ts +36 -36
- package/lib/generated-client/api/items-api.js +27 -27
- package/lib/generated-client/api/notifications-api.js +79 -2
- package/lib/generated-client/api/quick-connect-api.d.ts +37 -46
- package/lib/generated-client/api/quick-connect-api.js +50 -56
- package/lib/generated-client/api/search-api.d.ts +38 -38
- package/lib/generated-client/api/search-api.js +18 -18
- package/lib/generated-client/api/trailers-api.d.ts +20 -20
- package/lib/generated-client/api/trailers-api.js +15 -15
- package/lib/generated-client/api/user-api.d.ts +12 -7
- package/lib/generated-client/api/user-api.js +12 -10
- package/lib/generated-client/api/user-library-api.d.ts +0 -56
- package/lib/generated-client/api/user-library-api.js +0 -71
- package/lib/generated-client/api.d.ts +2 -0
- package/lib/generated-client/index.js +4 -3
- package/lib/generated-client/models/architecture.d.ts +0 -3
- package/lib/generated-client/models/architecture.js +1 -4
- package/lib/generated-client/models/authenticate-user-by-name.d.ts +7 -0
- package/lib/generated-client/models/base-item-dto.d.ts +3 -9
- package/lib/generated-client/models/base-item-person.d.ts +3 -4
- package/lib/generated-client/models/container-profile.d.ts +1 -1
- package/lib/generated-client/models/create-user-by-name.d.ts +1 -1
- package/lib/generated-client/models/encoding-options.d.ts +36 -49
- package/lib/generated-client/models/index.d.ts +10 -6
- package/lib/generated-client/models/index.js +2 -3
- package/lib/generated-client/models/library-options.d.ts +0 -6
- package/lib/generated-client/models/live-tv-options.d.ts +0 -12
- package/lib/generated-client/models/media-stream.d.ts +0 -12
- package/lib/generated-client/models/network-configuration.d.ts +1 -1
- package/lib/generated-client/models/{image-resolution.js → notification-level.js} +6 -12
- package/lib/generated-client/models/parental-rating.d.ts +1 -1
- package/lib/generated-client/models/public-system-info.d.ts +0 -1
- package/lib/generated-client/models/remove-from-playlist-request-dto.d.ts +1 -1
- package/lib/generated-client/models/search-hint.d.ts +15 -17
- package/lib/generated-client/models/{down-mix-stereo-algorithms.js → send-to-user-type.js} +6 -6
- package/lib/generated-client/models/series-status.d.ts +1 -2
- package/lib/generated-client/models/series-status.js +2 -3
- package/lib/generated-client/models/server-configuration.d.ts +0 -19
- package/lib/generated-client/models/system-info.d.ts +0 -3
- package/lib/generated-client/models/tuner-host-info.d.ts +0 -6
- package/lib/generated-client/models/user-policy.d.ts +0 -12
- package/lib/versions.d.ts +1 -1
- package/lib/versions.js +1 -1
- package/package.json +1 -1
- package/lib/generated-client/models/down-mix-stereo-algorithms.d.ts +0 -21
- package/lib/generated-client/models/image-resolution.d.ts +0 -27
- package/lib/generated-client/models/lyric-line.d.ts +0 -29
- package/lib/generated-client/models/lyric-metadata.d.ts +0 -71
- package/lib/generated-client/models/lyric-response.d.ts +0 -31
- package/lib/generated-client/models/person-kind.d.ts +0 -36
- package/lib/generated-client/models/person-kind.js +0 -39
|
@@ -25,9 +25,9 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
25
25
|
* @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
26
26
|
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
27
27
|
* @param {string} [userId] Optional. Supply a user id to search within a user\'s library or omit to search all.
|
|
28
|
-
* @param {Array<BaseItemKind>} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma
|
|
29
|
-
* @param {Array<BaseItemKind>} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma
|
|
30
|
-
* @param {Array<string>} [mediaTypes] If specified, only results with the specified media types are returned. This allows multiple, comma
|
|
28
|
+
* @param {Array<BaseItemKind>} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma delimeted.
|
|
29
|
+
* @param {Array<BaseItemKind>} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma delimeted.
|
|
30
|
+
* @param {Array<string>} [mediaTypes] If specified, only results with the specified media types are returned. This allows multiple, comma delimeted.
|
|
31
31
|
* @param {string} [parentId] If specified, only children of the parent are returned.
|
|
32
32
|
* @param {boolean} [isMovie] Optional filter for movies.
|
|
33
33
|
* @param {boolean} [isSeries] Optional filter for series.
|
|
@@ -42,7 +42,7 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
42
42
|
* @param {*} [options] Override http request option.
|
|
43
43
|
* @throws {RequiredError}
|
|
44
44
|
*/
|
|
45
|
-
|
|
45
|
+
get: (searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: Array<BaseItemKind>, excludeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<string>, parentId?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, includePeople?: boolean, includeMedia?: boolean, includeGenres?: boolean, includeStudios?: boolean, includeArtists?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
46
|
};
|
|
47
47
|
/**
|
|
48
48
|
* SearchApi - functional programming interface
|
|
@@ -56,9 +56,9 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
|
56
56
|
* @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
57
57
|
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
58
58
|
* @param {string} [userId] Optional. Supply a user id to search within a user\'s library or omit to search all.
|
|
59
|
-
* @param {Array<BaseItemKind>} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma
|
|
60
|
-
* @param {Array<BaseItemKind>} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma
|
|
61
|
-
* @param {Array<string>} [mediaTypes] If specified, only results with the specified media types are returned. This allows multiple, comma
|
|
59
|
+
* @param {Array<BaseItemKind>} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma delimeted.
|
|
60
|
+
* @param {Array<BaseItemKind>} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma delimeted.
|
|
61
|
+
* @param {Array<string>} [mediaTypes] If specified, only results with the specified media types are returned. This allows multiple, comma delimeted.
|
|
62
62
|
* @param {string} [parentId] If specified, only children of the parent are returned.
|
|
63
63
|
* @param {boolean} [isMovie] Optional filter for movies.
|
|
64
64
|
* @param {boolean} [isSeries] Optional filter for series.
|
|
@@ -73,7 +73,7 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
|
73
73
|
* @param {*} [options] Override http request option.
|
|
74
74
|
* @throws {RequiredError}
|
|
75
75
|
*/
|
|
76
|
-
|
|
76
|
+
get(searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: Array<BaseItemKind>, excludeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<string>, parentId?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, includePeople?: boolean, includeMedia?: boolean, includeGenres?: boolean, includeStudios?: boolean, includeArtists?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchHintResult>>;
|
|
77
77
|
};
|
|
78
78
|
/**
|
|
79
79
|
* SearchApi - factory interface
|
|
@@ -87,9 +87,9 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
|
|
|
87
87
|
* @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
88
88
|
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
89
89
|
* @param {string} [userId] Optional. Supply a user id to search within a user\'s library or omit to search all.
|
|
90
|
-
* @param {Array<BaseItemKind>} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma
|
|
91
|
-
* @param {Array<BaseItemKind>} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma
|
|
92
|
-
* @param {Array<string>} [mediaTypes] If specified, only results with the specified media types are returned. This allows multiple, comma
|
|
90
|
+
* @param {Array<BaseItemKind>} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma delimeted.
|
|
91
|
+
* @param {Array<BaseItemKind>} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma delimeted.
|
|
92
|
+
* @param {Array<string>} [mediaTypes] If specified, only results with the specified media types are returned. This allows multiple, comma delimeted.
|
|
93
93
|
* @param {string} [parentId] If specified, only children of the parent are returned.
|
|
94
94
|
* @param {boolean} [isMovie] Optional filter for movies.
|
|
95
95
|
* @param {boolean} [isSeries] Optional filter for series.
|
|
@@ -104,120 +104,120 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
|
|
|
104
104
|
* @param {*} [options] Override http request option.
|
|
105
105
|
* @throws {RequiredError}
|
|
106
106
|
*/
|
|
107
|
-
|
|
107
|
+
get(searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: Array<BaseItemKind>, excludeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<string>, parentId?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, includePeople?: boolean, includeMedia?: boolean, includeGenres?: boolean, includeStudios?: boolean, includeArtists?: boolean, options?: any): AxiosPromise<SearchHintResult>;
|
|
108
108
|
};
|
|
109
109
|
/**
|
|
110
|
-
* Request parameters for
|
|
110
|
+
* Request parameters for get operation in SearchApi.
|
|
111
111
|
* @export
|
|
112
|
-
* @interface
|
|
112
|
+
* @interface SearchApiGetRequest
|
|
113
113
|
*/
|
|
114
|
-
export interface
|
|
114
|
+
export interface SearchApiGetRequest {
|
|
115
115
|
/**
|
|
116
116
|
* The search term to filter on.
|
|
117
117
|
* @type {string}
|
|
118
|
-
* @memberof
|
|
118
|
+
* @memberof SearchApiGet
|
|
119
119
|
*/
|
|
120
120
|
readonly searchTerm: string;
|
|
121
121
|
/**
|
|
122
122
|
* Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
123
123
|
* @type {number}
|
|
124
|
-
* @memberof
|
|
124
|
+
* @memberof SearchApiGet
|
|
125
125
|
*/
|
|
126
126
|
readonly startIndex?: number;
|
|
127
127
|
/**
|
|
128
128
|
* Optional. The maximum number of records to return.
|
|
129
129
|
* @type {number}
|
|
130
|
-
* @memberof
|
|
130
|
+
* @memberof SearchApiGet
|
|
131
131
|
*/
|
|
132
132
|
readonly limit?: number;
|
|
133
133
|
/**
|
|
134
134
|
* Optional. Supply a user id to search within a user\'s library or omit to search all.
|
|
135
135
|
* @type {string}
|
|
136
|
-
* @memberof
|
|
136
|
+
* @memberof SearchApiGet
|
|
137
137
|
*/
|
|
138
138
|
readonly userId?: string;
|
|
139
139
|
/**
|
|
140
|
-
* If specified, only results with the specified item types are returned. This allows multiple, comma
|
|
140
|
+
* If specified, only results with the specified item types are returned. This allows multiple, comma delimeted.
|
|
141
141
|
* @type {Array<BaseItemKind>}
|
|
142
|
-
* @memberof
|
|
142
|
+
* @memberof SearchApiGet
|
|
143
143
|
*/
|
|
144
144
|
readonly includeItemTypes?: Array<BaseItemKind>;
|
|
145
145
|
/**
|
|
146
|
-
* If specified, results with these item types are filtered out. This allows multiple, comma
|
|
146
|
+
* If specified, results with these item types are filtered out. This allows multiple, comma delimeted.
|
|
147
147
|
* @type {Array<BaseItemKind>}
|
|
148
|
-
* @memberof
|
|
148
|
+
* @memberof SearchApiGet
|
|
149
149
|
*/
|
|
150
150
|
readonly excludeItemTypes?: Array<BaseItemKind>;
|
|
151
151
|
/**
|
|
152
|
-
* If specified, only results with the specified media types are returned. This allows multiple, comma
|
|
152
|
+
* If specified, only results with the specified media types are returned. This allows multiple, comma delimeted.
|
|
153
153
|
* @type {Array<string>}
|
|
154
|
-
* @memberof
|
|
154
|
+
* @memberof SearchApiGet
|
|
155
155
|
*/
|
|
156
156
|
readonly mediaTypes?: Array<string>;
|
|
157
157
|
/**
|
|
158
158
|
* If specified, only children of the parent are returned.
|
|
159
159
|
* @type {string}
|
|
160
|
-
* @memberof
|
|
160
|
+
* @memberof SearchApiGet
|
|
161
161
|
*/
|
|
162
162
|
readonly parentId?: string;
|
|
163
163
|
/**
|
|
164
164
|
* Optional filter for movies.
|
|
165
165
|
* @type {boolean}
|
|
166
|
-
* @memberof
|
|
166
|
+
* @memberof SearchApiGet
|
|
167
167
|
*/
|
|
168
168
|
readonly isMovie?: boolean;
|
|
169
169
|
/**
|
|
170
170
|
* Optional filter for series.
|
|
171
171
|
* @type {boolean}
|
|
172
|
-
* @memberof
|
|
172
|
+
* @memberof SearchApiGet
|
|
173
173
|
*/
|
|
174
174
|
readonly isSeries?: boolean;
|
|
175
175
|
/**
|
|
176
176
|
* Optional filter for news.
|
|
177
177
|
* @type {boolean}
|
|
178
|
-
* @memberof
|
|
178
|
+
* @memberof SearchApiGet
|
|
179
179
|
*/
|
|
180
180
|
readonly isNews?: boolean;
|
|
181
181
|
/**
|
|
182
182
|
* Optional filter for kids.
|
|
183
183
|
* @type {boolean}
|
|
184
|
-
* @memberof
|
|
184
|
+
* @memberof SearchApiGet
|
|
185
185
|
*/
|
|
186
186
|
readonly isKids?: boolean;
|
|
187
187
|
/**
|
|
188
188
|
* Optional filter for sports.
|
|
189
189
|
* @type {boolean}
|
|
190
|
-
* @memberof
|
|
190
|
+
* @memberof SearchApiGet
|
|
191
191
|
*/
|
|
192
192
|
readonly isSports?: boolean;
|
|
193
193
|
/**
|
|
194
194
|
* Optional filter whether to include people.
|
|
195
195
|
* @type {boolean}
|
|
196
|
-
* @memberof
|
|
196
|
+
* @memberof SearchApiGet
|
|
197
197
|
*/
|
|
198
198
|
readonly includePeople?: boolean;
|
|
199
199
|
/**
|
|
200
200
|
* Optional filter whether to include media.
|
|
201
201
|
* @type {boolean}
|
|
202
|
-
* @memberof
|
|
202
|
+
* @memberof SearchApiGet
|
|
203
203
|
*/
|
|
204
204
|
readonly includeMedia?: boolean;
|
|
205
205
|
/**
|
|
206
206
|
* Optional filter whether to include genres.
|
|
207
207
|
* @type {boolean}
|
|
208
|
-
* @memberof
|
|
208
|
+
* @memberof SearchApiGet
|
|
209
209
|
*/
|
|
210
210
|
readonly includeGenres?: boolean;
|
|
211
211
|
/**
|
|
212
212
|
* Optional filter whether to include studios.
|
|
213
213
|
* @type {boolean}
|
|
214
|
-
* @memberof
|
|
214
|
+
* @memberof SearchApiGet
|
|
215
215
|
*/
|
|
216
216
|
readonly includeStudios?: boolean;
|
|
217
217
|
/**
|
|
218
218
|
* Optional filter whether to include artists.
|
|
219
219
|
* @type {boolean}
|
|
220
|
-
* @memberof
|
|
220
|
+
* @memberof SearchApiGet
|
|
221
221
|
*/
|
|
222
222
|
readonly includeArtists?: boolean;
|
|
223
223
|
}
|
|
@@ -231,10 +231,10 @@ export declare class SearchApi extends BaseAPI {
|
|
|
231
231
|
/**
|
|
232
232
|
*
|
|
233
233
|
* @summary Gets the search hint result.
|
|
234
|
-
* @param {
|
|
234
|
+
* @param {SearchApiGetRequest} requestParameters Request parameters.
|
|
235
235
|
* @param {*} [options] Override http request option.
|
|
236
236
|
* @throws {RequiredError}
|
|
237
237
|
* @memberof SearchApi
|
|
238
238
|
*/
|
|
239
|
-
|
|
239
|
+
get(requestParameters: SearchApiGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchHintResult, any>>;
|
|
240
240
|
}
|
|
@@ -17,9 +17,9 @@ const SearchApiAxiosParamCreator = function (configuration) {
|
|
|
17
17
|
* @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
18
18
|
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
19
19
|
* @param {string} [userId] Optional. Supply a user id to search within a user\'s library or omit to search all.
|
|
20
|
-
* @param {Array<BaseItemKind>} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma
|
|
21
|
-
* @param {Array<BaseItemKind>} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma
|
|
22
|
-
* @param {Array<string>} [mediaTypes] If specified, only results with the specified media types are returned. This allows multiple, comma
|
|
20
|
+
* @param {Array<BaseItemKind>} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma delimeted.
|
|
21
|
+
* @param {Array<BaseItemKind>} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma delimeted.
|
|
22
|
+
* @param {Array<string>} [mediaTypes] If specified, only results with the specified media types are returned. This allows multiple, comma delimeted.
|
|
23
23
|
* @param {string} [parentId] If specified, only children of the parent are returned.
|
|
24
24
|
* @param {boolean} [isMovie] Optional filter for movies.
|
|
25
25
|
* @param {boolean} [isSeries] Optional filter for series.
|
|
@@ -34,9 +34,9 @@ const SearchApiAxiosParamCreator = function (configuration) {
|
|
|
34
34
|
* @param {*} [options] Override http request option.
|
|
35
35
|
* @throws {RequiredError}
|
|
36
36
|
*/
|
|
37
|
-
|
|
37
|
+
get: (searchTerm, startIndex, limit, userId, includeItemTypes, excludeItemTypes, mediaTypes, parentId, isMovie, isSeries, isNews, isKids, isSports, includePeople, includeMedia, includeGenres, includeStudios, includeArtists, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
38
38
|
// verify required parameter 'searchTerm' is not null or undefined
|
|
39
|
-
assertParamExists('
|
|
39
|
+
assertParamExists('get', 'searchTerm', searchTerm);
|
|
40
40
|
const localVarPath = `/Search/Hints`;
|
|
41
41
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
42
42
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -127,9 +127,9 @@ const SearchApiFp = function (configuration) {
|
|
|
127
127
|
* @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
128
128
|
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
129
129
|
* @param {string} [userId] Optional. Supply a user id to search within a user\'s library or omit to search all.
|
|
130
|
-
* @param {Array<BaseItemKind>} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma
|
|
131
|
-
* @param {Array<BaseItemKind>} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma
|
|
132
|
-
* @param {Array<string>} [mediaTypes] If specified, only results with the specified media types are returned. This allows multiple, comma
|
|
130
|
+
* @param {Array<BaseItemKind>} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma delimeted.
|
|
131
|
+
* @param {Array<BaseItemKind>} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma delimeted.
|
|
132
|
+
* @param {Array<string>} [mediaTypes] If specified, only results with the specified media types are returned. This allows multiple, comma delimeted.
|
|
133
133
|
* @param {string} [parentId] If specified, only children of the parent are returned.
|
|
134
134
|
* @param {boolean} [isMovie] Optional filter for movies.
|
|
135
135
|
* @param {boolean} [isSeries] Optional filter for series.
|
|
@@ -144,9 +144,9 @@ const SearchApiFp = function (configuration) {
|
|
|
144
144
|
* @param {*} [options] Override http request option.
|
|
145
145
|
* @throws {RequiredError}
|
|
146
146
|
*/
|
|
147
|
-
|
|
147
|
+
get(searchTerm, startIndex, limit, userId, includeItemTypes, excludeItemTypes, mediaTypes, parentId, isMovie, isSeries, isNews, isKids, isSports, includePeople, includeMedia, includeGenres, includeStudios, includeArtists, options) {
|
|
148
148
|
return __awaiter(this, void 0, void 0, function* () {
|
|
149
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
149
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.get(searchTerm, startIndex, limit, userId, includeItemTypes, excludeItemTypes, mediaTypes, parentId, isMovie, isSeries, isNews, isKids, isSports, includePeople, includeMedia, includeGenres, includeStudios, includeArtists, options);
|
|
150
150
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
151
151
|
});
|
|
152
152
|
},
|
|
@@ -166,9 +166,9 @@ const SearchApiFactory = function (configuration, basePath, axios) {
|
|
|
166
166
|
* @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
167
167
|
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
168
168
|
* @param {string} [userId] Optional. Supply a user id to search within a user\'s library or omit to search all.
|
|
169
|
-
* @param {Array<BaseItemKind>} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma
|
|
170
|
-
* @param {Array<BaseItemKind>} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma
|
|
171
|
-
* @param {Array<string>} [mediaTypes] If specified, only results with the specified media types are returned. This allows multiple, comma
|
|
169
|
+
* @param {Array<BaseItemKind>} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma delimeted.
|
|
170
|
+
* @param {Array<BaseItemKind>} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma delimeted.
|
|
171
|
+
* @param {Array<string>} [mediaTypes] If specified, only results with the specified media types are returned. This allows multiple, comma delimeted.
|
|
172
172
|
* @param {string} [parentId] If specified, only children of the parent are returned.
|
|
173
173
|
* @param {boolean} [isMovie] Optional filter for movies.
|
|
174
174
|
* @param {boolean} [isSeries] Optional filter for series.
|
|
@@ -183,8 +183,8 @@ const SearchApiFactory = function (configuration, basePath, axios) {
|
|
|
183
183
|
* @param {*} [options] Override http request option.
|
|
184
184
|
* @throws {RequiredError}
|
|
185
185
|
*/
|
|
186
|
-
|
|
187
|
-
return localVarFp.
|
|
186
|
+
get(searchTerm, startIndex, limit, userId, includeItemTypes, excludeItemTypes, mediaTypes, parentId, isMovie, isSeries, isNews, isKids, isSports, includePeople, includeMedia, includeGenres, includeStudios, includeArtists, options) {
|
|
187
|
+
return localVarFp.get(searchTerm, startIndex, limit, userId, includeItemTypes, excludeItemTypes, mediaTypes, parentId, isMovie, isSeries, isNews, isKids, isSports, includePeople, includeMedia, includeGenres, includeStudios, includeArtists, options).then((request) => request(axios, basePath));
|
|
188
188
|
},
|
|
189
189
|
};
|
|
190
190
|
};
|
|
@@ -198,13 +198,13 @@ class SearchApi extends BaseAPI {
|
|
|
198
198
|
/**
|
|
199
199
|
*
|
|
200
200
|
* @summary Gets the search hint result.
|
|
201
|
-
* @param {
|
|
201
|
+
* @param {SearchApiGetRequest} requestParameters Request parameters.
|
|
202
202
|
* @param {*} [options] Override http request option.
|
|
203
203
|
* @throws {RequiredError}
|
|
204
204
|
* @memberof SearchApi
|
|
205
205
|
*/
|
|
206
|
-
|
|
207
|
-
return SearchApiFp(this.configuration).
|
|
206
|
+
get(requestParameters, options) {
|
|
207
|
+
return SearchApiFp(this.configuration).get(requestParameters.searchTerm, requestParameters.startIndex, requestParameters.limit, requestParameters.userId, requestParameters.includeItemTypes, requestParameters.excludeItemTypes, requestParameters.mediaTypes, requestParameters.parentId, requestParameters.isMovie, requestParameters.isSeries, requestParameters.isNews, requestParameters.isKids, requestParameters.isSports, requestParameters.includePeople, requestParameters.includeMedia, requestParameters.includeGenres, requestParameters.includeStudios, requestParameters.includeArtists, options).then((request) => request(this.axios, this.basePath));
|
|
208
208
|
}
|
|
209
209
|
}
|
|
210
210
|
|
|
@@ -28,7 +28,7 @@ export declare const TrailersApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
28
28
|
/**
|
|
29
29
|
*
|
|
30
30
|
* @summary Finds movies and trailers similar to a given trailer.
|
|
31
|
-
* @param {string} [userId] The user id
|
|
31
|
+
* @param {string} [userId] The user id.
|
|
32
32
|
* @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
33
33
|
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
34
34
|
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
@@ -51,9 +51,9 @@ export declare const TrailersApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
51
51
|
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
52
52
|
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
53
53
|
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
54
|
-
* @param {boolean} [hasImdbId] Optional filter by items that have an
|
|
55
|
-
* @param {boolean} [hasTmdbId] Optional filter by items that have a
|
|
56
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a
|
|
54
|
+
* @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
|
|
55
|
+
* @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
|
|
56
|
+
* @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
|
|
57
57
|
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
58
58
|
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
59
59
|
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
@@ -64,7 +64,7 @@ export declare const TrailersApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
64
64
|
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
65
65
|
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
66
66
|
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
67
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,
|
|
67
|
+
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
68
68
|
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
69
69
|
* @param {Array<ItemFields>} [fields] Optional. 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.
|
|
70
70
|
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
@@ -125,7 +125,7 @@ export declare const TrailersApiFp: (configuration?: Configuration) => {
|
|
|
125
125
|
/**
|
|
126
126
|
*
|
|
127
127
|
* @summary Finds movies and trailers similar to a given trailer.
|
|
128
|
-
* @param {string} [userId] The user id
|
|
128
|
+
* @param {string} [userId] The user id.
|
|
129
129
|
* @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
130
130
|
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
131
131
|
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
@@ -148,9 +148,9 @@ export declare const TrailersApiFp: (configuration?: Configuration) => {
|
|
|
148
148
|
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
149
149
|
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
150
150
|
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
151
|
-
* @param {boolean} [hasImdbId] Optional filter by items that have an
|
|
152
|
-
* @param {boolean} [hasTmdbId] Optional filter by items that have a
|
|
153
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a
|
|
151
|
+
* @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
|
|
152
|
+
* @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
|
|
153
|
+
* @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
|
|
154
154
|
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
155
155
|
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
156
156
|
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
@@ -161,7 +161,7 @@ export declare const TrailersApiFp: (configuration?: Configuration) => {
|
|
|
161
161
|
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
162
162
|
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
163
163
|
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
164
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,
|
|
164
|
+
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
165
165
|
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
166
166
|
* @param {Array<ItemFields>} [fields] Optional. 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.
|
|
167
167
|
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
@@ -222,7 +222,7 @@ export declare const TrailersApiFactory: (configuration?: Configuration, basePat
|
|
|
222
222
|
/**
|
|
223
223
|
*
|
|
224
224
|
* @summary Finds movies and trailers similar to a given trailer.
|
|
225
|
-
* @param {string} [userId] The user id
|
|
225
|
+
* @param {string} [userId] The user id.
|
|
226
226
|
* @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
227
227
|
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
228
228
|
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
@@ -245,9 +245,9 @@ export declare const TrailersApiFactory: (configuration?: Configuration, basePat
|
|
|
245
245
|
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
246
246
|
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
247
247
|
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
248
|
-
* @param {boolean} [hasImdbId] Optional filter by items that have an
|
|
249
|
-
* @param {boolean} [hasTmdbId] Optional filter by items that have a
|
|
250
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a
|
|
248
|
+
* @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
|
|
249
|
+
* @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
|
|
250
|
+
* @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
|
|
251
251
|
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
252
252
|
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
253
253
|
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
@@ -258,7 +258,7 @@ export declare const TrailersApiFactory: (configuration?: Configuration, basePat
|
|
|
258
258
|
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
259
259
|
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
260
260
|
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
261
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,
|
|
261
|
+
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
262
262
|
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
263
263
|
* @param {Array<ItemFields>} [fields] Optional. 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.
|
|
264
264
|
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
@@ -318,7 +318,7 @@ export declare const TrailersApiFactory: (configuration?: Configuration, basePat
|
|
|
318
318
|
*/
|
|
319
319
|
export interface TrailersApiGetTrailersRequest {
|
|
320
320
|
/**
|
|
321
|
-
* The user id
|
|
321
|
+
* The user id.
|
|
322
322
|
* @type {string}
|
|
323
323
|
* @memberof TrailersApiGetTrailers
|
|
324
324
|
*/
|
|
@@ -456,19 +456,19 @@ export interface TrailersApiGetTrailersRequest {
|
|
|
456
456
|
*/
|
|
457
457
|
readonly hasOverview?: boolean;
|
|
458
458
|
/**
|
|
459
|
-
* Optional filter by items that have an
|
|
459
|
+
* Optional filter by items that have an imdb id or not.
|
|
460
460
|
* @type {boolean}
|
|
461
461
|
* @memberof TrailersApiGetTrailers
|
|
462
462
|
*/
|
|
463
463
|
readonly hasImdbId?: boolean;
|
|
464
464
|
/**
|
|
465
|
-
* Optional filter by items that have a
|
|
465
|
+
* Optional filter by items that have a tmdb id or not.
|
|
466
466
|
* @type {boolean}
|
|
467
467
|
* @memberof TrailersApiGetTrailers
|
|
468
468
|
*/
|
|
469
469
|
readonly hasTmdbId?: boolean;
|
|
470
470
|
/**
|
|
471
|
-
* Optional filter by items that have a
|
|
471
|
+
* Optional filter by items that have a tvdb id or not.
|
|
472
472
|
* @type {boolean}
|
|
473
473
|
* @memberof TrailersApiGetTrailers
|
|
474
474
|
*/
|
|
@@ -534,7 +534,7 @@ export interface TrailersApiGetTrailersRequest {
|
|
|
534
534
|
*/
|
|
535
535
|
readonly searchTerm?: string;
|
|
536
536
|
/**
|
|
537
|
-
* Sort Order - Ascending,
|
|
537
|
+
* Sort Order - Ascending,Descending.
|
|
538
538
|
* @type {Array<SortOrder>}
|
|
539
539
|
* @memberof TrailersApiGetTrailers
|
|
540
540
|
*/
|
|
@@ -13,7 +13,7 @@ const TrailersApiAxiosParamCreator = function (configuration) {
|
|
|
13
13
|
/**
|
|
14
14
|
*
|
|
15
15
|
* @summary Finds movies and trailers similar to a given trailer.
|
|
16
|
-
* @param {string} [userId] The user id
|
|
16
|
+
* @param {string} [userId] The user id.
|
|
17
17
|
* @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
18
18
|
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
19
19
|
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
@@ -36,9 +36,9 @@ const TrailersApiAxiosParamCreator = function (configuration) {
|
|
|
36
36
|
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
37
37
|
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
38
38
|
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
39
|
-
* @param {boolean} [hasImdbId] Optional filter by items that have an
|
|
40
|
-
* @param {boolean} [hasTmdbId] Optional filter by items that have a
|
|
41
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a
|
|
39
|
+
* @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
|
|
40
|
+
* @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
|
|
41
|
+
* @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
|
|
42
42
|
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
43
43
|
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
44
44
|
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
@@ -49,7 +49,7 @@ const TrailersApiAxiosParamCreator = function (configuration) {
|
|
|
49
49
|
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
50
50
|
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
51
51
|
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
52
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,
|
|
52
|
+
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
53
53
|
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
54
54
|
* @param {Array<ItemFields>} [fields] Optional. 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.
|
|
55
55
|
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
@@ -393,7 +393,7 @@ const TrailersApiFp = function (configuration) {
|
|
|
393
393
|
/**
|
|
394
394
|
*
|
|
395
395
|
* @summary Finds movies and trailers similar to a given trailer.
|
|
396
|
-
* @param {string} [userId] The user id
|
|
396
|
+
* @param {string} [userId] The user id.
|
|
397
397
|
* @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
398
398
|
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
399
399
|
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
@@ -416,9 +416,9 @@ const TrailersApiFp = function (configuration) {
|
|
|
416
416
|
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
417
417
|
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
418
418
|
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
419
|
-
* @param {boolean} [hasImdbId] Optional filter by items that have an
|
|
420
|
-
* @param {boolean} [hasTmdbId] Optional filter by items that have a
|
|
421
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a
|
|
419
|
+
* @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
|
|
420
|
+
* @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
|
|
421
|
+
* @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
|
|
422
422
|
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
423
423
|
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
424
424
|
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
@@ -429,7 +429,7 @@ const TrailersApiFp = function (configuration) {
|
|
|
429
429
|
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
430
430
|
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
431
431
|
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
432
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,
|
|
432
|
+
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
433
433
|
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
434
434
|
* @param {Array<ItemFields>} [fields] Optional. 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.
|
|
435
435
|
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
@@ -498,7 +498,7 @@ const TrailersApiFactory = function (configuration, basePath, axios) {
|
|
|
498
498
|
/**
|
|
499
499
|
*
|
|
500
500
|
* @summary Finds movies and trailers similar to a given trailer.
|
|
501
|
-
* @param {string} [userId] The user id
|
|
501
|
+
* @param {string} [userId] The user id.
|
|
502
502
|
* @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
503
503
|
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
504
504
|
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
@@ -521,9 +521,9 @@ const TrailersApiFactory = function (configuration, basePath, axios) {
|
|
|
521
521
|
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
522
522
|
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
523
523
|
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
524
|
-
* @param {boolean} [hasImdbId] Optional filter by items that have an
|
|
525
|
-
* @param {boolean} [hasTmdbId] Optional filter by items that have a
|
|
526
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a
|
|
524
|
+
* @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
|
|
525
|
+
* @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
|
|
526
|
+
* @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
|
|
527
527
|
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
528
528
|
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
529
529
|
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
@@ -534,7 +534,7 @@ const TrailersApiFactory = function (configuration, basePath, axios) {
|
|
|
534
534
|
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
535
535
|
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
536
536
|
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
537
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,
|
|
537
|
+
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
538
538
|
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
539
539
|
* @param {Array<ItemFields>} [fields] Optional. 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.
|
|
540
540
|
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
@@ -34,11 +34,11 @@ export declare const UserApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
34
34
|
* @summary Authenticates a user.
|
|
35
35
|
* @param {string} userId The user id.
|
|
36
36
|
* @param {string} pw The password as plain text.
|
|
37
|
+
* @param {string} [password] The password sha1-hash.
|
|
37
38
|
* @param {*} [options] Override http request option.
|
|
38
|
-
* @deprecated
|
|
39
39
|
* @throws {RequiredError}
|
|
40
40
|
*/
|
|
41
|
-
authenticateUser: (userId: string, pw: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
41
|
+
authenticateUser: (userId: string, pw: string, password?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
42
|
/**
|
|
43
43
|
*
|
|
44
44
|
* @summary Authenticates a user by name.
|
|
@@ -174,11 +174,11 @@ export declare const UserApiFp: (configuration?: Configuration) => {
|
|
|
174
174
|
* @summary Authenticates a user.
|
|
175
175
|
* @param {string} userId The user id.
|
|
176
176
|
* @param {string} pw The password as plain text.
|
|
177
|
+
* @param {string} [password] The password sha1-hash.
|
|
177
178
|
* @param {*} [options] Override http request option.
|
|
178
|
-
* @deprecated
|
|
179
179
|
* @throws {RequiredError}
|
|
180
180
|
*/
|
|
181
|
-
authenticateUser(userId: string, pw: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResult>>;
|
|
181
|
+
authenticateUser(userId: string, pw: string, password?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResult>>;
|
|
182
182
|
/**
|
|
183
183
|
*
|
|
184
184
|
* @summary Authenticates a user by name.
|
|
@@ -314,11 +314,11 @@ export declare const UserApiFactory: (configuration?: Configuration, basePath?:
|
|
|
314
314
|
* @summary Authenticates a user.
|
|
315
315
|
* @param {string} userId The user id.
|
|
316
316
|
* @param {string} pw The password as plain text.
|
|
317
|
+
* @param {string} [password] The password sha1-hash.
|
|
317
318
|
* @param {*} [options] Override http request option.
|
|
318
|
-
* @deprecated
|
|
319
319
|
* @throws {RequiredError}
|
|
320
320
|
*/
|
|
321
|
-
authenticateUser(userId: string, pw: string, options?: any): AxiosPromise<AuthenticationResult>;
|
|
321
|
+
authenticateUser(userId: string, pw: string, password?: string, options?: any): AxiosPromise<AuthenticationResult>;
|
|
322
322
|
/**
|
|
323
323
|
*
|
|
324
324
|
* @summary Authenticates a user by name.
|
|
@@ -462,6 +462,12 @@ export interface UserApiAuthenticateUserRequest {
|
|
|
462
462
|
* @memberof UserApiAuthenticateUser
|
|
463
463
|
*/
|
|
464
464
|
readonly pw: string;
|
|
465
|
+
/**
|
|
466
|
+
* The password sha1-hash.
|
|
467
|
+
* @type {string}
|
|
468
|
+
* @memberof UserApiAuthenticateUser
|
|
469
|
+
*/
|
|
470
|
+
readonly password?: string;
|
|
465
471
|
}
|
|
466
472
|
/**
|
|
467
473
|
* Request parameters for authenticateUserByName operation in UserApi.
|
|
@@ -680,7 +686,6 @@ export declare class UserApi extends BaseAPI {
|
|
|
680
686
|
* @summary Authenticates a user.
|
|
681
687
|
* @param {UserApiAuthenticateUserRequest} requestParameters Request parameters.
|
|
682
688
|
* @param {*} [options] Override http request option.
|
|
683
|
-
* @deprecated
|
|
684
689
|
* @throws {RequiredError}
|
|
685
690
|
* @memberof UserApi
|
|
686
691
|
*/
|