@jellyfin/sdk 0.11.0 → 0.13.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.
Files changed (183) hide show
  1. package/CHANGELOG.md +142 -0
  2. package/README.md +8 -53
  3. package/lib/api.d.ts +11 -2
  4. package/lib/api.js +23 -13
  5. package/lib/generated-client/api/activity-log-api.d.ts +1 -1
  6. package/lib/generated-client/api/api-key-api.d.ts +3 -3
  7. package/lib/generated-client/api/artists-api.d.ts +3 -3
  8. package/lib/generated-client/api/audio-api.d.ts +10 -10
  9. package/lib/generated-client/api/audio-api.js +4 -4
  10. package/lib/generated-client/api/backup-api.d.ts +209 -0
  11. package/lib/generated-client/api/backup-api.js +311 -0
  12. package/lib/generated-client/api/branding-api.d.ts +6 -6
  13. package/lib/generated-client/api/channels-api.d.ts +5 -5
  14. package/lib/generated-client/api/client-log-api.d.ts +1 -1
  15. package/lib/generated-client/api/collection-api.d.ts +3 -3
  16. package/lib/generated-client/api/configuration-api.d.ts +52 -5
  17. package/lib/generated-client/api/configuration-api.js +68 -1
  18. package/lib/generated-client/api/dashboard-api.d.ts +2 -2
  19. package/lib/generated-client/api/dashboard-api.js +1 -1
  20. package/lib/generated-client/api/devices-api.d.ts +5 -5
  21. package/lib/generated-client/api/devices-api.js +1 -1
  22. package/lib/generated-client/api/display-preferences-api.d.ts +2 -2
  23. package/lib/generated-client/api/display-preferences-api.js +1 -1
  24. package/lib/generated-client/api/dlna-api.d.ts +6 -6
  25. package/lib/generated-client/api/dlna-server-api.d.ts +16 -16
  26. package/lib/generated-client/api/dynamic-hls-api.d.ts +9 -9
  27. package/lib/generated-client/api/environment-api.d.ts +6 -6
  28. package/lib/generated-client/api/environment-api.js +1 -1
  29. package/lib/generated-client/api/filter-api.d.ts +2 -2
  30. package/lib/generated-client/api/genres-api.d.ts +2 -2
  31. package/lib/generated-client/api/genres-api.js +1 -1
  32. package/lib/generated-client/api/hls-segment-api.d.ts +5 -5
  33. package/lib/generated-client/api/hls-segment-api.js +1 -1
  34. package/lib/generated-client/api/image-api.d.ts +43 -331
  35. package/lib/generated-client/api/image-api.js +16 -196
  36. package/lib/generated-client/api/image-by-name-api.d.ts +6 -6
  37. package/lib/generated-client/api/instant-mix-api.d.ts +8 -8
  38. package/lib/generated-client/api/item-lookup-api.d.ts +11 -11
  39. package/lib/generated-client/api/item-refresh-api.d.ts +11 -3
  40. package/lib/generated-client/api/item-refresh-api.js +10 -5
  41. package/lib/generated-client/api/item-update-api.d.ts +3 -3
  42. package/lib/generated-client/api/items-api.d.ts +4 -4
  43. package/lib/generated-client/api/items-api.js +1 -1
  44. package/lib/generated-client/api/library-api.d.ts +25 -25
  45. package/lib/generated-client/api/library-api.js +1 -1
  46. package/lib/generated-client/api/library-structure-api.d.ts +8 -8
  47. package/lib/generated-client/api/live-tv-api.d.ts +55 -47
  48. package/lib/generated-client/api/live-tv-api.js +15 -10
  49. package/lib/generated-client/api/localization-api.d.ts +4 -4
  50. package/lib/generated-client/api/lyrics-api.d.ts +6 -6
  51. package/lib/generated-client/api/lyrics-api.js +1 -1
  52. package/lib/generated-client/api/media-info-api.d.ts +5 -5
  53. package/lib/generated-client/api/media-info-api.js +1 -1
  54. package/lib/generated-client/api/media-segments-api.d.ts +1 -1
  55. package/lib/generated-client/api/movies-api.d.ts +1 -1
  56. package/lib/generated-client/api/music-genres-api.d.ts +2 -2
  57. package/lib/generated-client/api/music-genres-api.js +1 -1
  58. package/lib/generated-client/api/notifications-api.d.ts +7 -7
  59. package/lib/generated-client/api/package-api.d.ts +6 -6
  60. package/lib/generated-client/api/package-api.js +1 -1
  61. package/lib/generated-client/api/persons-api.d.ts +2 -2
  62. package/lib/generated-client/api/persons-api.js +1 -1
  63. package/lib/generated-client/api/playlists-api.d.ts +11 -11
  64. package/lib/generated-client/api/playlists-api.js +1 -1
  65. package/lib/generated-client/api/playstate-api.d.ts +21 -9
  66. package/lib/generated-client/api/playstate-api.js +13 -1
  67. package/lib/generated-client/api/plugins-api.d.ts +9 -9
  68. package/lib/generated-client/api/quick-connect-api.d.ts +4 -4
  69. package/lib/generated-client/api/quick-connect-api.js +1 -1
  70. package/lib/generated-client/api/remote-image-api.d.ts +3 -3
  71. package/lib/generated-client/api/scheduled-tasks-api.d.ts +5 -5
  72. package/lib/generated-client/api/scheduled-tasks-api.js +1 -1
  73. package/lib/generated-client/api/search-api.d.ts +1 -1
  74. package/lib/generated-client/api/session-api.d.ts +16 -16
  75. package/lib/generated-client/api/startup-api.d.ts +7 -7
  76. package/lib/generated-client/api/startup-api.js +1 -1
  77. package/lib/generated-client/api/studios-api.d.ts +2 -2
  78. package/lib/generated-client/api/studios-api.js +1 -1
  79. package/lib/generated-client/api/subtitle-api.d.ts +10 -10
  80. package/lib/generated-client/api/subtitle-api.js +1 -1
  81. package/lib/generated-client/api/suggestions-api.d.ts +1 -1
  82. package/lib/generated-client/api/sync-play-api.d.ts +69 -23
  83. package/lib/generated-client/api/sync-play-api.js +67 -1
  84. package/lib/generated-client/api/system-api.d.ts +18 -22
  85. package/lib/generated-client/api/system-api.js +13 -17
  86. package/lib/generated-client/api/time-sync-api.d.ts +1 -1
  87. package/lib/generated-client/api/tmdb-api.d.ts +1 -1
  88. package/lib/generated-client/api/trailers-api.d.ts +1 -1
  89. package/lib/generated-client/api/trickplay-api.d.ts +2 -2
  90. package/lib/generated-client/api/tv-shows-api.d.ts +4 -4
  91. package/lib/generated-client/api/tv-shows-api.js +1 -1
  92. package/lib/generated-client/api/universal-audio-api.d.ts +2 -2
  93. package/lib/generated-client/api/user-api.d.ts +14 -14
  94. package/lib/generated-client/api/user-api.js +1 -1
  95. package/lib/generated-client/api/user-library-api.d.ts +10 -10
  96. package/lib/generated-client/api/user-views-api.d.ts +2 -2
  97. package/lib/generated-client/api/video-attachments-api.d.ts +1 -1
  98. package/lib/generated-client/api/videos-api.d.ts +7 -7
  99. package/lib/generated-client/api/years-api.d.ts +2 -2
  100. package/lib/generated-client/api/years-api.js +1 -1
  101. package/lib/generated-client/api.d.ts +1 -0
  102. package/lib/generated-client/common.d.ts +1 -1
  103. package/lib/generated-client/index.js +3 -0
  104. package/lib/generated-client/models/backup-manifest-dto.d.ts +48 -0
  105. package/lib/generated-client/models/backup-options-dto.d.ts +41 -0
  106. package/lib/generated-client/models/backup-restore-request-dto.d.ts +23 -0
  107. package/lib/generated-client/models/base-item-dto.d.ts +3 -3
  108. package/lib/generated-client/models/branding-options-dto.d.ts +35 -0
  109. package/lib/generated-client/models/custom-database-option.d.ts +29 -0
  110. package/lib/generated-client/models/custom-database-options.d.ts +42 -0
  111. package/lib/generated-client/models/database-configuration-options.d.ts +37 -0
  112. package/lib/generated-client/models/database-locking-behavior-types.d.ts +21 -0
  113. package/lib/generated-client/models/database-locking-behavior-types.js +24 -0
  114. package/lib/generated-client/models/external-id-info.d.ts +0 -7
  115. package/lib/generated-client/models/external-id-media-type.d.ts +1 -0
  116. package/lib/generated-client/models/external-id-media-type.js +2 -1
  117. package/lib/generated-client/models/folder-storage-dto.d.ts +47 -0
  118. package/lib/generated-client/models/group-update-type.d.ts +0 -2
  119. package/lib/generated-client/models/group-update-type.js +0 -2
  120. package/lib/generated-client/models/group-update.d.ts +19 -14
  121. package/lib/generated-client/models/index.d.ts +25 -8
  122. package/lib/generated-client/models/index.js +2 -0
  123. package/lib/generated-client/models/item-fields.d.ts +0 -11
  124. package/lib/generated-client/models/item-fields.js +0 -11
  125. package/lib/generated-client/models/item-sort-by.d.ts +0 -2
  126. package/lib/generated-client/models/item-sort-by.js +1 -3
  127. package/lib/generated-client/models/library-options-result-dto.d.ts +6 -0
  128. package/lib/generated-client/models/library-options.d.ts +1 -1
  129. package/lib/generated-client/models/library-storage-dto.d.ts +36 -0
  130. package/lib/generated-client/models/lyric-line-cue.d.ts +41 -0
  131. package/lib/generated-client/models/lyric-line.d.ts +7 -0
  132. package/lib/generated-client/models/media-segment-type.d.ts +1 -1
  133. package/lib/generated-client/models/media-segment-type.js +1 -1
  134. package/lib/generated-client/models/media-stream.d.ts +6 -0
  135. package/lib/generated-client/models/metadata-editor-info.d.ts +6 -6
  136. package/lib/generated-client/models/network-configuration.d.ts +1 -0
  137. package/lib/generated-client/models/open-live-stream-dto.d.ts +1 -1
  138. package/lib/generated-client/models/outbound-web-socket-message.d.ts +2 -2
  139. package/lib/generated-client/models/parental-rating-score.d.ts +29 -0
  140. package/lib/generated-client/models/parental-rating.d.ts +8 -1
  141. package/lib/generated-client/models/playback-info-dto.d.ts +1 -1
  142. package/lib/generated-client/models/plugin-status.d.ts +1 -0
  143. package/lib/generated-client/models/plugin-status.js +1 -0
  144. package/lib/generated-client/models/profile-condition-value.d.ts +1 -0
  145. package/lib/generated-client/models/profile-condition-value.js +2 -1
  146. package/lib/generated-client/models/server-configuration.d.ts +21 -9
  147. package/lib/generated-client/models/startup-configuration-dto.d.ts +6 -0
  148. package/lib/generated-client/models/startup-remote-access-dto.d.ts +1 -0
  149. package/lib/generated-client/models/sync-play-group-does-not-exist-update.d.ts +36 -0
  150. package/lib/generated-client/models/sync-play-group-joined-update.d.ts +37 -0
  151. package/lib/generated-client/models/sync-play-group-left-update.d.ts +36 -0
  152. package/lib/generated-client/models/sync-play-group-update-message.d.ts +37 -0
  153. package/lib/generated-client/models/sync-play-library-access-denied-update.d.ts +36 -0
  154. package/lib/generated-client/models/sync-play-not-in-group-update.d.ts +36 -0
  155. package/lib/generated-client/models/sync-play-play-queue-update.d.ts +37 -0
  156. package/lib/generated-client/models/sync-play-state-update.d.ts +37 -0
  157. package/lib/generated-client/models/sync-play-user-joined-update.d.ts +36 -0
  158. package/lib/generated-client/models/sync-play-user-left-update.d.ts +36 -0
  159. package/lib/generated-client/models/system-info.d.ts +7 -0
  160. package/lib/generated-client/models/system-storage-dto.d.ts +67 -0
  161. package/lib/generated-client/models/task-trigger-info-type.d.ts +22 -0
  162. package/lib/generated-client/models/task-trigger-info-type.js +25 -0
  163. package/lib/generated-client/models/task-trigger-info.d.ts +4 -3
  164. package/lib/generated-client/models/transcode-reason.d.ts +1 -0
  165. package/lib/generated-client/models/transcode-reason.js +2 -1
  166. package/lib/generated-client/models/transcoding-info.d.ts +1 -1
  167. package/lib/generated-client/models/transcoding-profile.d.ts +1 -1
  168. package/lib/generated-client/models/trickplay-info-dto.d.ts +59 -0
  169. package/lib/generated-client/models/trickplay-info.d.ts +7 -1
  170. package/lib/generated-client/models/tuner-host-info.d.ts +6 -0
  171. package/lib/generated-client/models/user-policy.d.ts +6 -0
  172. package/lib/generated-client/models/video-range-type.d.ts +4 -0
  173. package/lib/generated-client/models/video-range-type.js +4 -0
  174. package/lib/models/api/image-request-parameters.d.ts +0 -1
  175. package/lib/models/api/index.d.ts +0 -1
  176. package/lib/models/api/index.js +1 -1
  177. package/lib/utils/api/session-api.js +16 -1
  178. package/lib/utils/api/user-api.js +26 -1
  179. package/lib/versions.d.ts +2 -2
  180. package/lib/versions.js +2 -2
  181. package/package.json +18 -16
  182. package/lib/models/api/item-sort-by.d.ts +0 -40
  183. package/lib/models/api/item-sort-by.js +0 -43
@@ -0,0 +1,209 @@
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
+ import type { Configuration } from '../configuration';
12
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
13
+ import { type RequestArgs, BaseAPI } from '../base';
14
+ import type { BackupManifestDto } from '../models';
15
+ import type { BackupOptionsDto } from '../models';
16
+ import type { BackupRestoreRequestDto } from '../models';
17
+ /**
18
+ * BackupApi - axios parameter creator
19
+ * @export
20
+ */
21
+ export declare const BackupApiAxiosParamCreator: (configuration?: Configuration) => {
22
+ /**
23
+ *
24
+ * @summary Creates a new Backup.
25
+ * @param {BackupOptionsDto} [backupOptionsDto] The backup options.
26
+ * @param {*} [options] Override http request option.
27
+ * @throws {RequiredError}
28
+ */
29
+ createBackup: (backupOptionsDto?: BackupOptionsDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
30
+ /**
31
+ *
32
+ * @summary Gets the descriptor from an existing archive is present.
33
+ * @param {string} path The data to start a restore process.
34
+ * @param {*} [options] Override http request option.
35
+ * @throws {RequiredError}
36
+ */
37
+ getBackup: (path: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
38
+ /**
39
+ *
40
+ * @summary Gets a list of all currently present backups in the backup directory.
41
+ * @param {*} [options] Override http request option.
42
+ * @throws {RequiredError}
43
+ */
44
+ listBackups: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
45
+ /**
46
+ *
47
+ * @summary Restores to a backup by restarting the server and applying the backup.
48
+ * @param {BackupRestoreRequestDto} backupRestoreRequestDto The data to start a restore process.
49
+ * @param {*} [options] Override http request option.
50
+ * @throws {RequiredError}
51
+ */
52
+ startRestoreBackup: (backupRestoreRequestDto: BackupRestoreRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
53
+ };
54
+ /**
55
+ * BackupApi - functional programming interface
56
+ * @export
57
+ */
58
+ export declare const BackupApiFp: (configuration?: Configuration) => {
59
+ /**
60
+ *
61
+ * @summary Creates a new Backup.
62
+ * @param {BackupOptionsDto} [backupOptionsDto] The backup options.
63
+ * @param {*} [options] Override http request option.
64
+ * @throws {RequiredError}
65
+ */
66
+ createBackup(backupOptionsDto?: BackupOptionsDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BackupManifestDto>>;
67
+ /**
68
+ *
69
+ * @summary Gets the descriptor from an existing archive is present.
70
+ * @param {string} path The data to start a restore process.
71
+ * @param {*} [options] Override http request option.
72
+ * @throws {RequiredError}
73
+ */
74
+ getBackup(path: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BackupManifestDto>>;
75
+ /**
76
+ *
77
+ * @summary Gets a list of all currently present backups in the backup directory.
78
+ * @param {*} [options] Override http request option.
79
+ * @throws {RequiredError}
80
+ */
81
+ listBackups(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BackupManifestDto>>>;
82
+ /**
83
+ *
84
+ * @summary Restores to a backup by restarting the server and applying the backup.
85
+ * @param {BackupRestoreRequestDto} backupRestoreRequestDto The data to start a restore process.
86
+ * @param {*} [options] Override http request option.
87
+ * @throws {RequiredError}
88
+ */
89
+ startRestoreBackup(backupRestoreRequestDto: BackupRestoreRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
90
+ };
91
+ /**
92
+ * BackupApi - factory interface
93
+ * @export
94
+ */
95
+ export declare const BackupApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
96
+ /**
97
+ *
98
+ * @summary Creates a new Backup.
99
+ * @param {BackupApiCreateBackupRequest} requestParameters Request parameters.
100
+ * @param {*} [options] Override http request option.
101
+ * @throws {RequiredError}
102
+ */
103
+ createBackup(requestParameters?: BackupApiCreateBackupRequest, options?: RawAxiosRequestConfig): AxiosPromise<BackupManifestDto>;
104
+ /**
105
+ *
106
+ * @summary Gets the descriptor from an existing archive is present.
107
+ * @param {BackupApiGetBackupRequest} requestParameters Request parameters.
108
+ * @param {*} [options] Override http request option.
109
+ * @throws {RequiredError}
110
+ */
111
+ getBackup(requestParameters: BackupApiGetBackupRequest, options?: RawAxiosRequestConfig): AxiosPromise<BackupManifestDto>;
112
+ /**
113
+ *
114
+ * @summary Gets a list of all currently present backups in the backup directory.
115
+ * @param {*} [options] Override http request option.
116
+ * @throws {RequiredError}
117
+ */
118
+ listBackups(options?: RawAxiosRequestConfig): AxiosPromise<Array<BackupManifestDto>>;
119
+ /**
120
+ *
121
+ * @summary Restores to a backup by restarting the server and applying the backup.
122
+ * @param {BackupApiStartRestoreBackupRequest} requestParameters Request parameters.
123
+ * @param {*} [options] Override http request option.
124
+ * @throws {RequiredError}
125
+ */
126
+ startRestoreBackup(requestParameters: BackupApiStartRestoreBackupRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
127
+ };
128
+ /**
129
+ * Request parameters for createBackup operation in BackupApi.
130
+ * @export
131
+ * @interface BackupApiCreateBackupRequest
132
+ */
133
+ export interface BackupApiCreateBackupRequest {
134
+ /**
135
+ * The backup options.
136
+ * @type {BackupOptionsDto}
137
+ * @memberof BackupApiCreateBackup
138
+ */
139
+ readonly backupOptionsDto?: BackupOptionsDto;
140
+ }
141
+ /**
142
+ * Request parameters for getBackup operation in BackupApi.
143
+ * @export
144
+ * @interface BackupApiGetBackupRequest
145
+ */
146
+ export interface BackupApiGetBackupRequest {
147
+ /**
148
+ * The data to start a restore process.
149
+ * @type {string}
150
+ * @memberof BackupApiGetBackup
151
+ */
152
+ readonly path: string;
153
+ }
154
+ /**
155
+ * Request parameters for startRestoreBackup operation in BackupApi.
156
+ * @export
157
+ * @interface BackupApiStartRestoreBackupRequest
158
+ */
159
+ export interface BackupApiStartRestoreBackupRequest {
160
+ /**
161
+ * The data to start a restore process.
162
+ * @type {BackupRestoreRequestDto}
163
+ * @memberof BackupApiStartRestoreBackup
164
+ */
165
+ readonly backupRestoreRequestDto: BackupRestoreRequestDto;
166
+ }
167
+ /**
168
+ * BackupApi - object-oriented interface
169
+ * @export
170
+ * @class BackupApi
171
+ * @extends {BaseAPI}
172
+ */
173
+ export declare class BackupApi extends BaseAPI {
174
+ /**
175
+ *
176
+ * @summary Creates a new Backup.
177
+ * @param {BackupApiCreateBackupRequest} requestParameters Request parameters.
178
+ * @param {*} [options] Override http request option.
179
+ * @throws {RequiredError}
180
+ * @memberof BackupApi
181
+ */
182
+ createBackup(requestParameters?: BackupApiCreateBackupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BackupManifestDto, any, {}>>;
183
+ /**
184
+ *
185
+ * @summary Gets the descriptor from an existing archive is present.
186
+ * @param {BackupApiGetBackupRequest} requestParameters Request parameters.
187
+ * @param {*} [options] Override http request option.
188
+ * @throws {RequiredError}
189
+ * @memberof BackupApi
190
+ */
191
+ getBackup(requestParameters: BackupApiGetBackupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BackupManifestDto, any, {}>>;
192
+ /**
193
+ *
194
+ * @summary Gets a list of all currently present backups in the backup directory.
195
+ * @param {*} [options] Override http request option.
196
+ * @throws {RequiredError}
197
+ * @memberof BackupApi
198
+ */
199
+ listBackups(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BackupManifestDto[], any, {}>>;
200
+ /**
201
+ *
202
+ * @summary Restores to a backup by restarting the server and applying the backup.
203
+ * @param {BackupApiStartRestoreBackupRequest} requestParameters Request parameters.
204
+ * @param {*} [options] Override http request option.
205
+ * @throws {RequiredError}
206
+ * @memberof BackupApi
207
+ */
208
+ startRestoreBackup(requestParameters: BackupApiStartRestoreBackupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
209
+ }
@@ -0,0 +1,311 @@
1
+ import globalAxios from 'axios';
2
+ import { assertParamExists, DUMMY_BASE_URL, setApiKeyToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common.js';
3
+ import { operationServerMap, BaseAPI, BASE_PATH } from '../base.js';
4
+
5
+ /* tslint:disable */
6
+ /* eslint-disable */
7
+ /**
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * Do not edit the class manually.
10
+ *
11
+ * Jellyfin API
12
+ *
13
+ * This Source Code Form is subject to the terms of the Mozilla Public
14
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
15
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
16
+ */
17
+ /**
18
+ * BackupApi - axios parameter creator
19
+ * @export
20
+ */
21
+ const BackupApiAxiosParamCreator = function (configuration) {
22
+ return {
23
+ /**
24
+ *
25
+ * @summary Creates a new Backup.
26
+ * @param {BackupOptionsDto} [backupOptionsDto] The backup options.
27
+ * @param {*} [options] Override http request option.
28
+ * @throws {RequiredError}
29
+ */
30
+ createBackup: async (backupOptionsDto, options = {}) => {
31
+ const localVarPath = `/Backup/Create`;
32
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
33
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
34
+ let baseOptions;
35
+ if (configuration) {
36
+ baseOptions = configuration.baseOptions;
37
+ }
38
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
39
+ const localVarHeaderParameter = {};
40
+ const localVarQueryParameter = {};
41
+ // authentication CustomAuthentication required
42
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
43
+ localVarHeaderParameter['Content-Type'] = 'application/json';
44
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
45
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
46
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
47
+ localVarRequestOptions.data = serializeDataIfNeeded(backupOptionsDto, localVarRequestOptions, configuration);
48
+ return {
49
+ url: toPathString(localVarUrlObj),
50
+ options: localVarRequestOptions,
51
+ };
52
+ },
53
+ /**
54
+ *
55
+ * @summary Gets the descriptor from an existing archive is present.
56
+ * @param {string} path The data to start a restore process.
57
+ * @param {*} [options] Override http request option.
58
+ * @throws {RequiredError}
59
+ */
60
+ getBackup: async (path, options = {}) => {
61
+ // verify required parameter 'path' is not null or undefined
62
+ assertParamExists('getBackup', 'path', path);
63
+ const localVarPath = `/Backup/Manifest`;
64
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
65
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
66
+ let baseOptions;
67
+ if (configuration) {
68
+ baseOptions = configuration.baseOptions;
69
+ }
70
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
71
+ const localVarHeaderParameter = {};
72
+ const localVarQueryParameter = {};
73
+ // authentication CustomAuthentication required
74
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
75
+ if (path !== undefined) {
76
+ localVarQueryParameter['path'] = path;
77
+ }
78
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
79
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
80
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
81
+ return {
82
+ url: toPathString(localVarUrlObj),
83
+ options: localVarRequestOptions,
84
+ };
85
+ },
86
+ /**
87
+ *
88
+ * @summary Gets a list of all currently present backups in the backup directory.
89
+ * @param {*} [options] Override http request option.
90
+ * @throws {RequiredError}
91
+ */
92
+ listBackups: async (options = {}) => {
93
+ const localVarPath = `/Backup`;
94
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
95
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
96
+ let baseOptions;
97
+ if (configuration) {
98
+ baseOptions = configuration.baseOptions;
99
+ }
100
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
101
+ const localVarHeaderParameter = {};
102
+ const localVarQueryParameter = {};
103
+ // authentication CustomAuthentication required
104
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
105
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
106
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
107
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
108
+ return {
109
+ url: toPathString(localVarUrlObj),
110
+ options: localVarRequestOptions,
111
+ };
112
+ },
113
+ /**
114
+ *
115
+ * @summary Restores to a backup by restarting the server and applying the backup.
116
+ * @param {BackupRestoreRequestDto} backupRestoreRequestDto The data to start a restore process.
117
+ * @param {*} [options] Override http request option.
118
+ * @throws {RequiredError}
119
+ */
120
+ startRestoreBackup: async (backupRestoreRequestDto, options = {}) => {
121
+ // verify required parameter 'backupRestoreRequestDto' is not null or undefined
122
+ assertParamExists('startRestoreBackup', 'backupRestoreRequestDto', backupRestoreRequestDto);
123
+ const localVarPath = `/Backup/Restore`;
124
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
125
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
126
+ let baseOptions;
127
+ if (configuration) {
128
+ baseOptions = configuration.baseOptions;
129
+ }
130
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
131
+ const localVarHeaderParameter = {};
132
+ const localVarQueryParameter = {};
133
+ // authentication CustomAuthentication required
134
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
135
+ localVarHeaderParameter['Content-Type'] = 'application/json';
136
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
137
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
138
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
139
+ localVarRequestOptions.data = serializeDataIfNeeded(backupRestoreRequestDto, localVarRequestOptions, configuration);
140
+ return {
141
+ url: toPathString(localVarUrlObj),
142
+ options: localVarRequestOptions,
143
+ };
144
+ },
145
+ };
146
+ };
147
+ /**
148
+ * BackupApi - functional programming interface
149
+ * @export
150
+ */
151
+ const BackupApiFp = function (configuration) {
152
+ const localVarAxiosParamCreator = BackupApiAxiosParamCreator(configuration);
153
+ return {
154
+ /**
155
+ *
156
+ * @summary Creates a new Backup.
157
+ * @param {BackupOptionsDto} [backupOptionsDto] The backup options.
158
+ * @param {*} [options] Override http request option.
159
+ * @throws {RequiredError}
160
+ */
161
+ async createBackup(backupOptionsDto, options) {
162
+ var _a, _b, _c;
163
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createBackup(backupOptionsDto, options);
164
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
165
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BackupApi.createBackup']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
166
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
167
+ },
168
+ /**
169
+ *
170
+ * @summary Gets the descriptor from an existing archive is present.
171
+ * @param {string} path The data to start a restore process.
172
+ * @param {*} [options] Override http request option.
173
+ * @throws {RequiredError}
174
+ */
175
+ async getBackup(path, options) {
176
+ var _a, _b, _c;
177
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getBackup(path, options);
178
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
179
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BackupApi.getBackup']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
180
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
181
+ },
182
+ /**
183
+ *
184
+ * @summary Gets a list of all currently present backups in the backup directory.
185
+ * @param {*} [options] Override http request option.
186
+ * @throws {RequiredError}
187
+ */
188
+ async listBackups(options) {
189
+ var _a, _b, _c;
190
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listBackups(options);
191
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
192
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BackupApi.listBackups']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
193
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
194
+ },
195
+ /**
196
+ *
197
+ * @summary Restores to a backup by restarting the server and applying the backup.
198
+ * @param {BackupRestoreRequestDto} backupRestoreRequestDto The data to start a restore process.
199
+ * @param {*} [options] Override http request option.
200
+ * @throws {RequiredError}
201
+ */
202
+ async startRestoreBackup(backupRestoreRequestDto, options) {
203
+ var _a, _b, _c;
204
+ const localVarAxiosArgs = await localVarAxiosParamCreator.startRestoreBackup(backupRestoreRequestDto, options);
205
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
206
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BackupApi.startRestoreBackup']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
207
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
208
+ },
209
+ };
210
+ };
211
+ /**
212
+ * BackupApi - factory interface
213
+ * @export
214
+ */
215
+ const BackupApiFactory = function (configuration, basePath, axios) {
216
+ const localVarFp = BackupApiFp(configuration);
217
+ return {
218
+ /**
219
+ *
220
+ * @summary Creates a new Backup.
221
+ * @param {BackupApiCreateBackupRequest} requestParameters Request parameters.
222
+ * @param {*} [options] Override http request option.
223
+ * @throws {RequiredError}
224
+ */
225
+ createBackup(requestParameters = {}, options) {
226
+ return localVarFp.createBackup(requestParameters.backupOptionsDto, options).then((request) => request(axios, basePath));
227
+ },
228
+ /**
229
+ *
230
+ * @summary Gets the descriptor from an existing archive is present.
231
+ * @param {BackupApiGetBackupRequest} requestParameters Request parameters.
232
+ * @param {*} [options] Override http request option.
233
+ * @throws {RequiredError}
234
+ */
235
+ getBackup(requestParameters, options) {
236
+ return localVarFp.getBackup(requestParameters.path, options).then((request) => request(axios, basePath));
237
+ },
238
+ /**
239
+ *
240
+ * @summary Gets a list of all currently present backups in the backup directory.
241
+ * @param {*} [options] Override http request option.
242
+ * @throws {RequiredError}
243
+ */
244
+ listBackups(options) {
245
+ return localVarFp.listBackups(options).then((request) => request(axios, basePath));
246
+ },
247
+ /**
248
+ *
249
+ * @summary Restores to a backup by restarting the server and applying the backup.
250
+ * @param {BackupApiStartRestoreBackupRequest} requestParameters Request parameters.
251
+ * @param {*} [options] Override http request option.
252
+ * @throws {RequiredError}
253
+ */
254
+ startRestoreBackup(requestParameters, options) {
255
+ return localVarFp.startRestoreBackup(requestParameters.backupRestoreRequestDto, options).then((request) => request(axios, basePath));
256
+ },
257
+ };
258
+ };
259
+ /**
260
+ * BackupApi - object-oriented interface
261
+ * @export
262
+ * @class BackupApi
263
+ * @extends {BaseAPI}
264
+ */
265
+ class BackupApi extends BaseAPI {
266
+ /**
267
+ *
268
+ * @summary Creates a new Backup.
269
+ * @param {BackupApiCreateBackupRequest} requestParameters Request parameters.
270
+ * @param {*} [options] Override http request option.
271
+ * @throws {RequiredError}
272
+ * @memberof BackupApi
273
+ */
274
+ createBackup(requestParameters = {}, options) {
275
+ return BackupApiFp(this.configuration).createBackup(requestParameters.backupOptionsDto, options).then((request) => request(this.axios, this.basePath));
276
+ }
277
+ /**
278
+ *
279
+ * @summary Gets the descriptor from an existing archive is present.
280
+ * @param {BackupApiGetBackupRequest} requestParameters Request parameters.
281
+ * @param {*} [options] Override http request option.
282
+ * @throws {RequiredError}
283
+ * @memberof BackupApi
284
+ */
285
+ getBackup(requestParameters, options) {
286
+ return BackupApiFp(this.configuration).getBackup(requestParameters.path, options).then((request) => request(this.axios, this.basePath));
287
+ }
288
+ /**
289
+ *
290
+ * @summary Gets a list of all currently present backups in the backup directory.
291
+ * @param {*} [options] Override http request option.
292
+ * @throws {RequiredError}
293
+ * @memberof BackupApi
294
+ */
295
+ listBackups(options) {
296
+ return BackupApiFp(this.configuration).listBackups(options).then((request) => request(this.axios, this.basePath));
297
+ }
298
+ /**
299
+ *
300
+ * @summary Restores to a backup by restarting the server and applying the backup.
301
+ * @param {BackupApiStartRestoreBackupRequest} requestParameters Request parameters.
302
+ * @param {*} [options] Override http request option.
303
+ * @throws {RequiredError}
304
+ * @memberof BackupApi
305
+ */
306
+ startRestoreBackup(requestParameters, options) {
307
+ return BackupApiFp(this.configuration).startRestoreBackup(requestParameters.backupRestoreRequestDto, options).then((request) => request(this.axios, this.basePath));
308
+ }
309
+ }
310
+
311
+ export { BackupApi, BackupApiAxiosParamCreator, BackupApiFactory, BackupApiFp };
@@ -11,7 +11,7 @@
11
11
  import type { Configuration } from '../configuration';
12
12
  import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
13
13
  import { type RequestArgs, BaseAPI } from '../base';
14
- import type { BrandingOptions } from '../models';
14
+ import type { BrandingOptionsDto } from '../models';
15
15
  /**
16
16
  * BrandingApi - axios parameter creator
17
17
  * @export
@@ -64,7 +64,7 @@ export declare const BrandingApiFp: (configuration?: Configuration) => {
64
64
  * @param {*} [options] Override http request option.
65
65
  * @throws {RequiredError}
66
66
  */
67
- getBrandingOptions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrandingOptions>>;
67
+ getBrandingOptions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrandingOptionsDto>>;
68
68
  };
69
69
  /**
70
70
  * BrandingApi - factory interface
@@ -91,7 +91,7 @@ export declare const BrandingApiFactory: (configuration?: Configuration, basePat
91
91
  * @param {*} [options] Override http request option.
92
92
  * @throws {RequiredError}
93
93
  */
94
- getBrandingOptions(options?: RawAxiosRequestConfig): AxiosPromise<BrandingOptions>;
94
+ getBrandingOptions(options?: RawAxiosRequestConfig): AxiosPromise<BrandingOptionsDto>;
95
95
  };
96
96
  /**
97
97
  * BrandingApi - object-oriented interface
@@ -107,7 +107,7 @@ export declare class BrandingApi extends BaseAPI {
107
107
  * @throws {RequiredError}
108
108
  * @memberof BrandingApi
109
109
  */
110
- getBrandingCss(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
110
+ getBrandingCss(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
111
111
  /**
112
112
  *
113
113
  * @summary Gets branding css.
@@ -115,7 +115,7 @@ export declare class BrandingApi extends BaseAPI {
115
115
  * @throws {RequiredError}
116
116
  * @memberof BrandingApi
117
117
  */
118
- getBrandingCss2(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
118
+ getBrandingCss2(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
119
119
  /**
120
120
  *
121
121
  * @summary Gets branding configuration.
@@ -123,5 +123,5 @@ export declare class BrandingApi extends BaseAPI {
123
123
  * @throws {RequiredError}
124
124
  * @memberof BrandingApi
125
125
  */
126
- getBrandingOptions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BrandingOptions, any>>;
126
+ getBrandingOptions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BrandingOptionsDto, any, {}>>;
127
127
  }
@@ -362,7 +362,7 @@ export declare class ChannelsApi extends BaseAPI {
362
362
  * @throws {RequiredError}
363
363
  * @memberof ChannelsApi
364
364
  */
365
- getAllChannelFeatures(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChannelFeatures[], any>>;
365
+ getAllChannelFeatures(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChannelFeatures[], any, {}>>;
366
366
  /**
367
367
  *
368
368
  * @summary Get channel features.
@@ -371,7 +371,7 @@ export declare class ChannelsApi extends BaseAPI {
371
371
  * @throws {RequiredError}
372
372
  * @memberof ChannelsApi
373
373
  */
374
- getChannelFeatures(requestParameters: ChannelsApiGetChannelFeaturesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChannelFeatures, any>>;
374
+ getChannelFeatures(requestParameters: ChannelsApiGetChannelFeaturesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChannelFeatures, any, {}>>;
375
375
  /**
376
376
  *
377
377
  * @summary Get channel items.
@@ -380,7 +380,7 @@ export declare class ChannelsApi extends BaseAPI {
380
380
  * @throws {RequiredError}
381
381
  * @memberof ChannelsApi
382
382
  */
383
- getChannelItems(requestParameters: ChannelsApiGetChannelItemsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any>>;
383
+ getChannelItems(requestParameters: ChannelsApiGetChannelItemsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
384
384
  /**
385
385
  *
386
386
  * @summary Gets available channels.
@@ -389,7 +389,7 @@ export declare class ChannelsApi extends BaseAPI {
389
389
  * @throws {RequiredError}
390
390
  * @memberof ChannelsApi
391
391
  */
392
- getChannels(requestParameters?: ChannelsApiGetChannelsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any>>;
392
+ getChannels(requestParameters?: ChannelsApiGetChannelsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
393
393
  /**
394
394
  *
395
395
  * @summary Gets latest channel items.
@@ -398,5 +398,5 @@ export declare class ChannelsApi extends BaseAPI {
398
398
  * @throws {RequiredError}
399
399
  * @memberof ChannelsApi
400
400
  */
401
- getLatestChannelItems(requestParameters?: ChannelsApiGetLatestChannelItemsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any>>;
401
+ getLatestChannelItems(requestParameters?: ChannelsApiGetLatestChannelItemsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
402
402
  }
@@ -82,5 +82,5 @@ export declare class ClientLogApi extends BaseAPI {
82
82
  * @throws {RequiredError}
83
83
  * @memberof ClientLogApi
84
84
  */
85
- logFile(requestParameters?: ClientLogApiLogFileRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ClientLogDocumentResponseDto, any>>;
85
+ logFile(requestParameters?: ClientLogApiLogFileRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ClientLogDocumentResponseDto, any, {}>>;
86
86
  }
@@ -196,7 +196,7 @@ export declare class CollectionApi extends BaseAPI {
196
196
  * @throws {RequiredError}
197
197
  * @memberof CollectionApi
198
198
  */
199
- addToCollection(requestParameters: CollectionApiAddToCollectionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
199
+ addToCollection(requestParameters: CollectionApiAddToCollectionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
200
200
  /**
201
201
  *
202
202
  * @summary Creates a new collection.
@@ -205,7 +205,7 @@ export declare class CollectionApi extends BaseAPI {
205
205
  * @throws {RequiredError}
206
206
  * @memberof CollectionApi
207
207
  */
208
- createCollection(requestParameters?: CollectionApiCreateCollectionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CollectionCreationResult, any>>;
208
+ createCollection(requestParameters?: CollectionApiCreateCollectionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CollectionCreationResult, any, {}>>;
209
209
  /**
210
210
  *
211
211
  * @summary Removes items from a collection.
@@ -214,5 +214,5 @@ export declare class CollectionApi extends BaseAPI {
214
214
  * @throws {RequiredError}
215
215
  * @memberof CollectionApi
216
216
  */
217
- removeFromCollection(requestParameters: CollectionApiRemoveFromCollectionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
217
+ removeFromCollection(requestParameters: CollectionApiRemoveFromCollectionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
218
218
  }