@jellyfin/sdk 0.8.1 → 0.9.0

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

@@ -25,26 +25,25 @@ export declare const PlaystateApiAxiosParamCreator: (configuration?: Configurati
     /**
      *
      * @summary Marks an item as played for user.
-     * @param {string} userId User id.
      * @param {string} itemId Item id.
+     * @param {string} [userId] User id.
      * @param {string} [datePlayed] Optional. The date the item was played.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    markPlayedItem: (userId: string, itemId: string, datePlayed?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    markPlayedItem: (itemId: string, userId?: string, datePlayed?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Marks an item as unplayed for user.
-     * @param {string} userId User id.
      * @param {string} itemId Item id.
+     * @param {string} [userId] User id.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    markUnplayedItem: (userId: string, itemId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    markUnplayedItem: (itemId: string, userId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
-     * @summary Reports a user\'s playback progress.
-     * @param {string} userId User id.
+     * @summary Reports a session\'s playback progress.
      * @param {string} itemId Item id.
      * @param {string} [mediaSourceId] The id of the MediaSource.
      * @param {number} [positionTicks] Optional. The current position, in ticks. 1 tick &#x3D; 10000 ms.
@@ -60,11 +59,10 @@ export declare const PlaystateApiAxiosParamCreator: (configuration?: Configurati
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    onPlaybackProgress: (userId: string, itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    onPlaybackProgress: (itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
-     * @summary Reports that a user has begun playing an item.
-     * @param {string} userId User id.
+     * @summary Reports that a session has begun playing an item.
      * @param {string} itemId Item id.
      * @param {string} [mediaSourceId] The id of the MediaSource.
      * @param {number} [audioStreamIndex] The audio stream index.
@@ -76,11 +74,10 @@ export declare const PlaystateApiAxiosParamCreator: (configuration?: Configurati
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    onPlaybackStart: (userId: string, itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    onPlaybackStart: (itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
-     * @summary Reports that a user has stopped playing an item.
-     * @param {string} userId User id.
+     * @summary Reports that a session has stopped playing an item.
      * @param {string} itemId Item id.
      * @param {string} [mediaSourceId] The id of the MediaSource.
      * @param {string} [nextMediaType] The next media type that will play.
@@ -90,7 +87,7 @@ export declare const PlaystateApiAxiosParamCreator: (configuration?: Configurati
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    onPlaybackStopped: (userId: string, itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    onPlaybackStopped: (itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Pings a playback session.
@@ -132,26 +129,25 @@ export declare const PlaystateApiFp: (configuration?: Configuration) => {
     /**
      *
      * @summary Marks an item as played for user.
-     * @param {string} userId User id.
      * @param {string} itemId Item id.
+     * @param {string} [userId] User id.
      * @param {string} [datePlayed] Optional. The date the item was played.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    markPlayedItem(userId: string, itemId: string, datePlayed?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>;
+    markPlayedItem(itemId: string, userId?: string, datePlayed?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>;
     /**
      *
      * @summary Marks an item as unplayed for user.
-     * @param {string} userId User id.
      * @param {string} itemId Item id.
+     * @param {string} [userId] User id.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    markUnplayedItem(userId: string, itemId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>;
+    markUnplayedItem(itemId: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>;
     /**
      *
-     * @summary Reports a user\'s playback progress.
-     * @param {string} userId User id.
+     * @summary Reports a session\'s playback progress.
      * @param {string} itemId Item id.
      * @param {string} [mediaSourceId] The id of the MediaSource.
      * @param {number} [positionTicks] Optional. The current position, in ticks. 1 tick &#x3D; 10000 ms.
@@ -167,11 +163,10 @@ export declare const PlaystateApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    onPlaybackProgress(userId: string, itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    onPlaybackProgress(itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      *
-     * @summary Reports that a user has begun playing an item.
-     * @param {string} userId User id.
+     * @summary Reports that a session has begun playing an item.
      * @param {string} itemId Item id.
      * @param {string} [mediaSourceId] The id of the MediaSource.
      * @param {number} [audioStreamIndex] The audio stream index.
@@ -183,11 +178,10 @@ export declare const PlaystateApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    onPlaybackStart(userId: string, itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    onPlaybackStart(itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      *
-     * @summary Reports that a user has stopped playing an item.
-     * @param {string} userId User id.
+     * @summary Reports that a session has stopped playing an item.
      * @param {string} itemId Item id.
      * @param {string} [mediaSourceId] The id of the MediaSource.
      * @param {string} [nextMediaType] The next media type that will play.
@@ -197,7 +191,7 @@ export declare const PlaystateApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    onPlaybackStopped(userId: string, itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    onPlaybackStopped(itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      *
      * @summary Pings a playback session.
@@ -239,26 +233,25 @@ export declare const PlaystateApiFactory: (configuration?: Configuration, basePa
     /**
      *
      * @summary Marks an item as played for user.
-     * @param {string} userId User id.
      * @param {string} itemId Item id.
+     * @param {string} [userId] User id.
      * @param {string} [datePlayed] Optional. The date the item was played.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    markPlayedItem(userId: string, itemId: string, datePlayed?: string, options?: any): AxiosPromise<UserItemDataDto>;
+    markPlayedItem(itemId: string, userId?: string, datePlayed?: string, options?: any): AxiosPromise<UserItemDataDto>;
     /**
      *
      * @summary Marks an item as unplayed for user.
-     * @param {string} userId User id.
      * @param {string} itemId Item id.
+     * @param {string} [userId] User id.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    markUnplayedItem(userId: string, itemId: string, options?: any): AxiosPromise<UserItemDataDto>;
+    markUnplayedItem(itemId: string, userId?: string, options?: any): AxiosPromise<UserItemDataDto>;
     /**
      *
-     * @summary Reports a user\'s playback progress.
-     * @param {string} userId User id.
+     * @summary Reports a session\'s playback progress.
      * @param {string} itemId Item id.
      * @param {string} [mediaSourceId] The id of the MediaSource.
      * @param {number} [positionTicks] Optional. The current position, in ticks. 1 tick &#x3D; 10000 ms.
@@ -274,11 +267,10 @@ export declare const PlaystateApiFactory: (configuration?: Configuration, basePa
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    onPlaybackProgress(userId: string, itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options?: any): AxiosPromise<void>;
+    onPlaybackProgress(itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options?: any): AxiosPromise<void>;
     /**
      *
-     * @summary Reports that a user has begun playing an item.
-     * @param {string} userId User id.
+     * @summary Reports that a session has begun playing an item.
      * @param {string} itemId Item id.
      * @param {string} [mediaSourceId] The id of the MediaSource.
      * @param {number} [audioStreamIndex] The audio stream index.
@@ -290,11 +282,10 @@ export declare const PlaystateApiFactory: (configuration?: Configuration, basePa
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    onPlaybackStart(userId: string, itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: any): AxiosPromise<void>;
+    onPlaybackStart(itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: any): AxiosPromise<void>;
     /**
      *
-     * @summary Reports that a user has stopped playing an item.
-     * @param {string} userId User id.
+     * @summary Reports that a session has stopped playing an item.
      * @param {string} itemId Item id.
      * @param {string} [mediaSourceId] The id of the MediaSource.
      * @param {string} [nextMediaType] The next media type that will play.
@@ -304,7 +295,7 @@ export declare const PlaystateApiFactory: (configuration?: Configuration, basePa
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    onPlaybackStopped(userId: string, itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: any): AxiosPromise<void>;
+    onPlaybackStopped(itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: any): AxiosPromise<void>;
     /**
      *
      * @summary Pings a playback session.
@@ -345,17 +336,17 @@ export declare const PlaystateApiFactory: (configuration?: Configuration, basePa
  */
 export interface PlaystateApiMarkPlayedItemRequest {
     /**
-     * User id.
+     * Item id.
      * @type {string}
      * @memberof PlaystateApiMarkPlayedItem
      */
-    readonly userId: string;
+    readonly itemId: string;
     /**
-     * Item id.
+     * User id.
      * @type {string}
      * @memberof PlaystateApiMarkPlayedItem
      */
-    readonly itemId: string;
+    readonly userId?: string;
     /**
      * Optional. The date the item was played.
      * @type {string}
@@ -370,17 +361,17 @@ export interface PlaystateApiMarkPlayedItemRequest {
  */
 export interface PlaystateApiMarkUnplayedItemRequest {
     /**
-     * User id.
+     * Item id.
      * @type {string}
      * @memberof PlaystateApiMarkUnplayedItem
      */
-    readonly userId: string;
+    readonly itemId: string;
     /**
-     * Item id.
+     * User id.
      * @type {string}
      * @memberof PlaystateApiMarkUnplayedItem
      */
-    readonly itemId: string;
+    readonly userId?: string;
 }
 /**
  * Request parameters for onPlaybackProgress operation in PlaystateApi.
@@ -388,12 +379,6 @@ export interface PlaystateApiMarkUnplayedItemRequest {
  * @interface PlaystateApiOnPlaybackProgressRequest
  */
 export interface PlaystateApiOnPlaybackProgressRequest {
-    /**
-     * User id.
-     * @type {string}
-     * @memberof PlaystateApiOnPlaybackProgress
-     */
-    readonly userId: string;
     /**
      * Item id.
      * @type {string}
@@ -473,12 +458,6 @@ export interface PlaystateApiOnPlaybackProgressRequest {
  * @interface PlaystateApiOnPlaybackStartRequest
  */
 export interface PlaystateApiOnPlaybackStartRequest {
-    /**
-     * User id.
-     * @type {string}
-     * @memberof PlaystateApiOnPlaybackStart
-     */
-    readonly userId: string;
     /**
      * Item id.
      * @type {string}
@@ -534,12 +513,6 @@ export interface PlaystateApiOnPlaybackStartRequest {
  * @interface PlaystateApiOnPlaybackStoppedRequest
  */
 export interface PlaystateApiOnPlaybackStoppedRequest {
-    /**
-     * User id.
-     * @type {string}
-     * @memberof PlaystateApiOnPlaybackStopped
-     */
-    readonly userId: string;
     /**
      * Item id.
      * @type {string}
@@ -656,7 +629,7 @@ export declare class PlaystateApi extends BaseAPI {
     markUnplayedItem(requestParameters: PlaystateApiMarkUnplayedItemRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserItemDataDto, any>>;
     /**
      *
-     * @summary Reports a user\'s playback progress.
+     * @summary Reports a session\'s playback progress.
      * @param {PlaystateApiOnPlaybackProgressRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -665,7 +638,7 @@ export declare class PlaystateApi extends BaseAPI {
     onPlaybackProgress(requestParameters: PlaystateApiOnPlaybackProgressRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      *
-     * @summary Reports that a user has begun playing an item.
+     * @summary Reports that a session has begun playing an item.
      * @param {PlaystateApiOnPlaybackStartRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -674,7 +647,7 @@ export declare class PlaystateApi extends BaseAPI {
     onPlaybackStart(requestParameters: PlaystateApiOnPlaybackStartRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      *
-     * @summary Reports that a user has stopped playing an item.
+     * @summary Reports that a session has stopped playing an item.
      * @param {PlaystateApiOnPlaybackStoppedRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}