@jellyfin/sdk 0.0.0-unstable.202512080502 → 0.0.0-unstable.202512090502

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.
@@ -12,6 +12,9 @@ import type { Configuration } from '../configuration';
12
12
  import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
13
13
  import { type RequestArgs, BaseAPI } from '../base';
14
14
  import type { ActivityLogEntryQueryResult } from '../models';
15
+ import type { ActivityLogSortBy } from '../models';
16
+ import type { LogLevel } from '../models';
17
+ import type { SortOrder } from '../models';
15
18
  /**
16
19
  * ActivityLogApi - axios parameter creator
17
20
  * @export
@@ -20,14 +23,23 @@ export declare const ActivityLogApiAxiosParamCreator: (configuration?: Configura
20
23
  /**
21
24
  *
22
25
  * @summary Gets activity log entries.
23
- * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
24
- * @param {number} [limit] Optional. The maximum number of records to return.
25
- * @param {string} [minDate] Optional. The minimum date. Format = ISO.
26
- * @param {boolean} [hasUserId] Optional. Filter log entries if it has user id, or not.
26
+ * @param {number} [startIndex] The record index to start at. All items with a lower index will be dropped from the results.
27
+ * @param {number} [limit] The maximum number of records to return.
28
+ * @param {string} [minDate] The minimum date.
29
+ * @param {boolean} [hasUserId] Filter log entries if it has user id, or not.
30
+ * @param {string} [name] Filter by name.
31
+ * @param {string} [overview] Filter by overview.
32
+ * @param {string} [shortOverview] Filter by short overview.
33
+ * @param {string} [type] Filter by type.
34
+ * @param {string} [itemId] Filter by item id.
35
+ * @param {string} [username] Filter by username.
36
+ * @param {LogLevel} [severity] Filter by log severity.
37
+ * @param {Array<ActivityLogSortBy>} [sortBy] Specify one or more sort orders. Format: SortBy&#x3D;Name,Type.
38
+ * @param {Array<SortOrder>} [sortOrder] Sort Order..
27
39
  * @param {*} [options] Override http request option.
28
40
  * @throws {RequiredError}
29
41
  */
30
- getLogEntries: (startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
42
+ getLogEntries: (startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, name?: string, overview?: string, shortOverview?: string, type?: string, itemId?: string, username?: string, severity?: LogLevel, sortBy?: Array<ActivityLogSortBy>, sortOrder?: Array<SortOrder>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
31
43
  };
32
44
  /**
33
45
  * ActivityLogApi - functional programming interface
@@ -37,14 +49,23 @@ export declare const ActivityLogApiFp: (configuration?: Configuration) => {
37
49
  /**
38
50
  *
39
51
  * @summary Gets activity log entries.
40
- * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
41
- * @param {number} [limit] Optional. The maximum number of records to return.
42
- * @param {string} [minDate] Optional. The minimum date. Format &#x3D; ISO.
43
- * @param {boolean} [hasUserId] Optional. Filter log entries if it has user id, or not.
52
+ * @param {number} [startIndex] The record index to start at. All items with a lower index will be dropped from the results.
53
+ * @param {number} [limit] The maximum number of records to return.
54
+ * @param {string} [minDate] The minimum date.
55
+ * @param {boolean} [hasUserId] Filter log entries if it has user id, or not.
56
+ * @param {string} [name] Filter by name.
57
+ * @param {string} [overview] Filter by overview.
58
+ * @param {string} [shortOverview] Filter by short overview.
59
+ * @param {string} [type] Filter by type.
60
+ * @param {string} [itemId] Filter by item id.
61
+ * @param {string} [username] Filter by username.
62
+ * @param {LogLevel} [severity] Filter by log severity.
63
+ * @param {Array<ActivityLogSortBy>} [sortBy] Specify one or more sort orders. Format: SortBy&#x3D;Name,Type.
64
+ * @param {Array<SortOrder>} [sortOrder] Sort Order..
44
65
  * @param {*} [options] Override http request option.
45
66
  * @throws {RequiredError}
46
67
  */
47
- getLogEntries(startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActivityLogEntryQueryResult>>;
68
+ getLogEntries(startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, name?: string, overview?: string, shortOverview?: string, type?: string, itemId?: string, username?: string, severity?: LogLevel, sortBy?: Array<ActivityLogSortBy>, sortOrder?: Array<SortOrder>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActivityLogEntryQueryResult>>;
48
69
  };
49
70
  /**
50
71
  * ActivityLogApi - factory interface
@@ -67,29 +88,83 @@ export declare const ActivityLogApiFactory: (configuration?: Configuration, base
67
88
  */
68
89
  export interface ActivityLogApiGetLogEntriesRequest {
69
90
  /**
70
- * Optional. The record index to start at. All items with a lower index will be dropped from the results.
91
+ * The record index to start at. All items with a lower index will be dropped from the results.
71
92
  * @type {number}
72
93
  * @memberof ActivityLogApiGetLogEntries
73
94
  */
74
95
  readonly startIndex?: number;
75
96
  /**
76
- * Optional. The maximum number of records to return.
97
+ * The maximum number of records to return.
77
98
  * @type {number}
78
99
  * @memberof ActivityLogApiGetLogEntries
79
100
  */
80
101
  readonly limit?: number;
81
102
  /**
82
- * Optional. The minimum date. Format &#x3D; ISO.
103
+ * The minimum date.
83
104
  * @type {string}
84
105
  * @memberof ActivityLogApiGetLogEntries
85
106
  */
86
107
  readonly minDate?: string;
87
108
  /**
88
- * Optional. Filter log entries if it has user id, or not.
109
+ * Filter log entries if it has user id, or not.
89
110
  * @type {boolean}
90
111
  * @memberof ActivityLogApiGetLogEntries
91
112
  */
92
113
  readonly hasUserId?: boolean;
114
+ /**
115
+ * Filter by name.
116
+ * @type {string}
117
+ * @memberof ActivityLogApiGetLogEntries
118
+ */
119
+ readonly name?: string;
120
+ /**
121
+ * Filter by overview.
122
+ * @type {string}
123
+ * @memberof ActivityLogApiGetLogEntries
124
+ */
125
+ readonly overview?: string;
126
+ /**
127
+ * Filter by short overview.
128
+ * @type {string}
129
+ * @memberof ActivityLogApiGetLogEntries
130
+ */
131
+ readonly shortOverview?: string;
132
+ /**
133
+ * Filter by type.
134
+ * @type {string}
135
+ * @memberof ActivityLogApiGetLogEntries
136
+ */
137
+ readonly type?: string;
138
+ /**
139
+ * Filter by item id.
140
+ * @type {string}
141
+ * @memberof ActivityLogApiGetLogEntries
142
+ */
143
+ readonly itemId?: string;
144
+ /**
145
+ * Filter by username.
146
+ * @type {string}
147
+ * @memberof ActivityLogApiGetLogEntries
148
+ */
149
+ readonly username?: string;
150
+ /**
151
+ * Filter by log severity.
152
+ * @type {LogLevel}
153
+ * @memberof ActivityLogApiGetLogEntries
154
+ */
155
+ readonly severity?: LogLevel;
156
+ /**
157
+ * Specify one or more sort orders. Format: SortBy&#x3D;Name,Type.
158
+ * @type {Array<ActivityLogSortBy>}
159
+ * @memberof ActivityLogApiGetLogEntries
160
+ */
161
+ readonly sortBy?: Array<ActivityLogSortBy>;
162
+ /**
163
+ * Sort Order..
164
+ * @type {Array<SortOrder>}
165
+ * @memberof ActivityLogApiGetLogEntries
166
+ */
167
+ readonly sortOrder?: Array<SortOrder>;
93
168
  }
94
169
  /**
95
170
  * ActivityLogApi - object-oriented interface
@@ -23,14 +23,23 @@ const ActivityLogApiAxiosParamCreator = function (configuration) {
23
23
  /**
24
24
  *
25
25
  * @summary Gets activity log entries.
26
- * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
27
- * @param {number} [limit] Optional. The maximum number of records to return.
28
- * @param {string} [minDate] Optional. The minimum date. Format &#x3D; ISO.
29
- * @param {boolean} [hasUserId] Optional. Filter log entries if it has user id, or not.
26
+ * @param {number} [startIndex] The record index to start at. All items with a lower index will be dropped from the results.
27
+ * @param {number} [limit] The maximum number of records to return.
28
+ * @param {string} [minDate] The minimum date.
29
+ * @param {boolean} [hasUserId] Filter log entries if it has user id, or not.
30
+ * @param {string} [name] Filter by name.
31
+ * @param {string} [overview] Filter by overview.
32
+ * @param {string} [shortOverview] Filter by short overview.
33
+ * @param {string} [type] Filter by type.
34
+ * @param {string} [itemId] Filter by item id.
35
+ * @param {string} [username] Filter by username.
36
+ * @param {LogLevel} [severity] Filter by log severity.
37
+ * @param {Array<ActivityLogSortBy>} [sortBy] Specify one or more sort orders. Format: SortBy&#x3D;Name,Type.
38
+ * @param {Array<SortOrder>} [sortOrder] Sort Order..
30
39
  * @param {*} [options] Override http request option.
31
40
  * @throws {RequiredError}
32
41
  */
33
- getLogEntries: async (startIndex, limit, minDate, hasUserId, options = {}) => {
42
+ getLogEntries: async (startIndex, limit, minDate, hasUserId, name, overview, shortOverview, type, itemId, username, severity, sortBy, sortOrder, options = {}) => {
34
43
  const localVarPath = `/System/ActivityLog/Entries`;
35
44
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
36
45
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -57,6 +66,33 @@ const ActivityLogApiAxiosParamCreator = function (configuration) {
57
66
  if (hasUserId !== undefined) {
58
67
  localVarQueryParameter['hasUserId'] = hasUserId;
59
68
  }
69
+ if (name !== undefined) {
70
+ localVarQueryParameter['name'] = name;
71
+ }
72
+ if (overview !== undefined) {
73
+ localVarQueryParameter['overview'] = overview;
74
+ }
75
+ if (shortOverview !== undefined) {
76
+ localVarQueryParameter['shortOverview'] = shortOverview;
77
+ }
78
+ if (type !== undefined) {
79
+ localVarQueryParameter['type'] = type;
80
+ }
81
+ if (itemId !== undefined) {
82
+ localVarQueryParameter['itemId'] = itemId;
83
+ }
84
+ if (username !== undefined) {
85
+ localVarQueryParameter['username'] = username;
86
+ }
87
+ if (severity !== undefined) {
88
+ localVarQueryParameter['severity'] = severity;
89
+ }
90
+ if (sortBy) {
91
+ localVarQueryParameter['sortBy'] = sortBy;
92
+ }
93
+ if (sortOrder) {
94
+ localVarQueryParameter['sortOrder'] = sortOrder;
95
+ }
60
96
  setSearchParams(localVarUrlObj, localVarQueryParameter);
61
97
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
62
98
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -77,16 +113,25 @@ const ActivityLogApiFp = function (configuration) {
77
113
  /**
78
114
  *
79
115
  * @summary Gets activity log entries.
80
- * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
81
- * @param {number} [limit] Optional. The maximum number of records to return.
82
- * @param {string} [minDate] Optional. The minimum date. Format &#x3D; ISO.
83
- * @param {boolean} [hasUserId] Optional. Filter log entries if it has user id, or not.
116
+ * @param {number} [startIndex] The record index to start at. All items with a lower index will be dropped from the results.
117
+ * @param {number} [limit] The maximum number of records to return.
118
+ * @param {string} [minDate] The minimum date.
119
+ * @param {boolean} [hasUserId] Filter log entries if it has user id, or not.
120
+ * @param {string} [name] Filter by name.
121
+ * @param {string} [overview] Filter by overview.
122
+ * @param {string} [shortOverview] Filter by short overview.
123
+ * @param {string} [type] Filter by type.
124
+ * @param {string} [itemId] Filter by item id.
125
+ * @param {string} [username] Filter by username.
126
+ * @param {LogLevel} [severity] Filter by log severity.
127
+ * @param {Array<ActivityLogSortBy>} [sortBy] Specify one or more sort orders. Format: SortBy&#x3D;Name,Type.
128
+ * @param {Array<SortOrder>} [sortOrder] Sort Order..
84
129
  * @param {*} [options] Override http request option.
85
130
  * @throws {RequiredError}
86
131
  */
87
- async getLogEntries(startIndex, limit, minDate, hasUserId, options) {
132
+ async getLogEntries(startIndex, limit, minDate, hasUserId, name, overview, shortOverview, type, itemId, username, severity, sortBy, sortOrder, options) {
88
133
  var _a, _b, _c;
89
- const localVarAxiosArgs = await localVarAxiosParamCreator.getLogEntries(startIndex, limit, minDate, hasUserId, options);
134
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getLogEntries(startIndex, limit, minDate, hasUserId, name, overview, shortOverview, type, itemId, username, severity, sortBy, sortOrder, options);
90
135
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
91
136
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ActivityLogApi.getLogEntries']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
92
137
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -108,7 +153,7 @@ const ActivityLogApiFactory = function (configuration, basePath, axios) {
108
153
  * @throws {RequiredError}
109
154
  */
110
155
  getLogEntries(requestParameters = {}, options) {
111
- return localVarFp.getLogEntries(requestParameters.startIndex, requestParameters.limit, requestParameters.minDate, requestParameters.hasUserId, options).then((request) => request(axios, basePath));
156
+ return localVarFp.getLogEntries(requestParameters.startIndex, requestParameters.limit, requestParameters.minDate, requestParameters.hasUserId, requestParameters.name, requestParameters.overview, requestParameters.shortOverview, requestParameters.type, requestParameters.itemId, requestParameters.username, requestParameters.severity, requestParameters.sortBy, requestParameters.sortOrder, options).then((request) => request(axios, basePath));
112
157
  },
113
158
  };
114
159
  };
@@ -128,7 +173,7 @@ class ActivityLogApi extends BaseAPI {
128
173
  * @memberof ActivityLogApi
129
174
  */
130
175
  getLogEntries(requestParameters = {}, options) {
131
- return ActivityLogApiFp(this.configuration).getLogEntries(requestParameters.startIndex, requestParameters.limit, requestParameters.minDate, requestParameters.hasUserId, options).then((request) => request(this.axios, this.basePath));
176
+ return ActivityLogApiFp(this.configuration).getLogEntries(requestParameters.startIndex, requestParameters.limit, requestParameters.minDate, requestParameters.hasUserId, requestParameters.name, requestParameters.overview, requestParameters.shortOverview, requestParameters.type, requestParameters.itemId, requestParameters.username, requestParameters.severity, requestParameters.sortBy, requestParameters.sortOrder, options).then((request) => request(this.axios, this.basePath));
132
177
  }
133
178
  }
134
179
 
@@ -60,6 +60,7 @@ export { VideoAttachmentsApi, VideoAttachmentsApiAxiosParamCreator, VideoAttachm
60
60
  export { VideosApi, VideosApiAxiosParamCreator, VideosApiFactory, VideosApiFp } from './api/videos-api.js';
61
61
  export { YearsApi, YearsApiAxiosParamCreator, YearsApiFactory, YearsApiFp } from './api/years-api.js';
62
62
  export { Configuration } from './configuration.js';
63
+ export { ActivityLogSortBy } from './models/activity-log-sort-by.js';
63
64
  export { AudioSpatialFormat } from './models/audio-spatial-format.js';
64
65
  export { BaseItemKind } from './models/base-item-kind.js';
65
66
  export { ChannelItemSortField } from './models/channel-item-sort-field.js';
@@ -0,0 +1,25 @@
1
+ /**
2
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3
+ * Do not edit the class manually.
4
+ *
5
+ * Jellyfin API
6
+ *
7
+ * This Source Code Form is subject to the terms of the Mozilla Public
8
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
9
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
10
+ */
11
+ /**
12
+ * Activity log sorting options.
13
+ * @export
14
+ * @enum {string}
15
+ */
16
+ export declare const ActivityLogSortBy: {
17
+ readonly Name: "Name";
18
+ readonly Overiew: "Overiew";
19
+ readonly ShortOverview: "ShortOverview";
20
+ readonly Type: "Type";
21
+ readonly DateCreated: "DateCreated";
22
+ readonly Username: "Username";
23
+ readonly LogSeverity: "LogSeverity";
24
+ };
25
+ export type ActivityLogSortBy = typeof ActivityLogSortBy[keyof typeof ActivityLogSortBy];
@@ -0,0 +1,28 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5
+ * Do not edit the class manually.
6
+ *
7
+ * Jellyfin API
8
+ *
9
+ * This Source Code Form is subject to the terms of the Mozilla Public
10
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
11
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
12
+ */
13
+ /**
14
+ * Activity log sorting options.
15
+ * @export
16
+ * @enum {string}
17
+ */
18
+ const ActivityLogSortBy = {
19
+ Name: 'Name',
20
+ Overiew: 'Overiew',
21
+ ShortOverview: 'ShortOverview',
22
+ Type: 'Type',
23
+ DateCreated: 'DateCreated',
24
+ Username: 'Username',
25
+ LogSeverity: 'LogSeverity'
26
+ };
27
+
28
+ export { ActivityLogSortBy };
@@ -4,6 +4,7 @@ export * from './activity-log-entry-message';
4
4
  export * from './activity-log-entry-query-result';
5
5
  export * from './activity-log-entry-start-message';
6
6
  export * from './activity-log-entry-stop-message';
7
+ export * from './activity-log-sort-by';
7
8
  export * from './add-virtual-folder-dto';
8
9
  export * from './album-info';
9
10
  export * from './album-info-remote-search-query';
@@ -1,3 +1,4 @@
1
+ export { ActivityLogSortBy } from './activity-log-sort-by.js';
1
2
  export { AudioSpatialFormat } from './audio-spatial-format.js';
2
3
  export { BaseItemKind } from './base-item-kind.js';
3
4
  export { ChannelItemSortField } from './channel-item-sort-field.js';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jellyfin/sdk",
3
- "version": "0.0.0-unstable.202512080502+commit.324e5ae9ab4ddfda7a1fded470d056ccf69e9934",
3
+ "version": "0.0.0-unstable.202512090502+commit.cba2dc8ea5a03c559af6a7fdad6de57bc135ddca",
4
4
  "description": "A TypeScript SDK for Jellyfin.",
5
5
  "keywords": [
6
6
  "jellyfin"