@jellyfin/sdk/lib/generated-client/api/playstate-api.d.ts

A TypeScript SDK for Jellyfin.

/**
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * Do not edit the class manually.
 *
 * Jellyfin API
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { PlayMethod } from '../models';
import type { PlaybackProgressInfo } from '../models';
import type { PlaybackStartInfo } from '../models';
import type { PlaybackStopInfo } from '../models';
import type { RepeatMode } from '../models';
import type { UserItemDataDto } from '../models';
/**
 * PlaystateApi - axios parameter creator
 * @export
 */
export declare const PlaystateApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Marks an item as played for user.
     * @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: (itemId: string, userId?: string, datePlayed?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Marks an item as unplayed for user.
     * @param {string} itemId Item id.
     * @param {string} [userId] User id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    markUnplayedItem: (itemId: string, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @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.
     * @param {number} [audioStreamIndex] The audio stream index.
     * @param {number} [subtitleStreamIndex] The subtitle stream index.
     * @param {number} [volumeLevel] Scale of 0-100.
     * @param {PlayMethod} [playMethod] The play method.
     * @param {string} [liveStreamId] The live stream id.
     * @param {string} [playSessionId] The play session id.
     * @param {RepeatMode} [repeatMode] The repeat mode.
     * @param {boolean} [isPaused] Indicates if the player is paused.
     * @param {boolean} [isMuted] Indicates if the player is muted.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @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.
     * @param {number} [subtitleStreamIndex] The subtitle stream index.
     * @param {PlayMethod} [playMethod] The play method.
     * @param {string} [liveStreamId] The live stream id.
     * @param {string} [playSessionId] The play session id.
     * @param {boolean} [canSeek] Indicates if the client can seek.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    onPlaybackStart: (itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @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.
     * @param {number} [positionTicks] Optional. The position, in ticks, where playback stopped. 1 tick &#x3D; 10000 ms.
     * @param {string} [liveStreamId] The live stream id.
     * @param {string} [playSessionId] The play session id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    onPlaybackStopped: (itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Pings a playback session.
     * @param {string} playSessionId Playback session id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    pingPlaybackSession: (playSessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Reports playback progress within a session.
     * @param {PlaybackProgressInfo} [playbackProgressInfo] The playback progress info.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    reportPlaybackProgress: (playbackProgressInfo?: PlaybackProgressInfo, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Reports playback has started within a session.
     * @param {PlaybackStartInfo} [playbackStartInfo] The playback start info.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    reportPlaybackStart: (playbackStartInfo?: PlaybackStartInfo, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Reports playback has stopped within a session.
     * @param {PlaybackStopInfo} [playbackStopInfo] The playback stop info.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    reportPlaybackStopped: (playbackStopInfo?: PlaybackStopInfo, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * PlaystateApi - functional programming interface
 * @export
 */
export declare const PlaystateApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Marks an item as played for user.
     * @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(itemId: string, userId?: string, datePlayed?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>;
    /**
     *
     * @summary Marks an item as unplayed for user.
     * @param {string} itemId Item id.
     * @param {string} [userId] User id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    markUnplayedItem(itemId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>;
    /**
     *
     * @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.
     * @param {number} [audioStreamIndex] The audio stream index.
     * @param {number} [subtitleStreamIndex] The subtitle stream index.
     * @param {number} [volumeLevel] Scale of 0-100.
     * @param {PlayMethod} [playMethod] The play method.
     * @param {string} [liveStreamId] The live stream id.
     * @param {string} [playSessionId] The play session id.
     * @param {RepeatMode} [repeatMode] The repeat mode.
     * @param {boolean} [isPaused] Indicates if the player is paused.
     * @param {boolean} [isMuted] Indicates if the player is muted.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    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?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @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.
     * @param {number} [subtitleStreamIndex] The subtitle stream index.
     * @param {PlayMethod} [playMethod] The play method.
     * @param {string} [liveStreamId] The live stream id.
     * @param {string} [playSessionId] The play session id.
     * @param {boolean} [canSeek] Indicates if the client can seek.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    onPlaybackStart(itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @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.
     * @param {number} [positionTicks] Optional. The position, in ticks, where playback stopped. 1 tick &#x3D; 10000 ms.
     * @param {string} [liveStreamId] The live stream id.
     * @param {string} [playSessionId] The play session id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    onPlaybackStopped(itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Pings a playback session.
     * @param {string} playSessionId Playback session id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    pingPlaybackSession(playSessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Reports playback progress within a session.
     * @param {PlaybackProgressInfo} [playbackProgressInfo] The playback progress info.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    reportPlaybackProgress(playbackProgressInfo?: PlaybackProgressInfo, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Reports playback has started within a session.
     * @param {PlaybackStartInfo} [playbackStartInfo] The playback start info.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    reportPlaybackStart(playbackStartInfo?: PlaybackStartInfo, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Reports playback has stopped within a session.
     * @param {PlaybackStopInfo} [playbackStopInfo] The playback stop info.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    reportPlaybackStopped(playbackStopInfo?: PlaybackStopInfo, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
};
/**
 * PlaystateApi - factory interface
 * @export
 */
export declare const PlaystateApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Marks an item as played for user.
     * @param {PlaystateApiMarkPlayedItemRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    markPlayedItem(requestParameters: PlaystateApiMarkPlayedItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserItemDataDto>;
    /**
     *
     * @summary Marks an item as unplayed for user.
     * @param {PlaystateApiMarkUnplayedItemRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    markUnplayedItem(requestParameters: PlaystateApiMarkUnplayedItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserItemDataDto>;
    /**
     *
     * @summary Reports a session\'s playback progress.
     * @param {PlaystateApiOnPlaybackProgressRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    onPlaybackProgress(requestParameters: PlaystateApiOnPlaybackProgressRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Reports that a session has begun playing an item.
     * @param {PlaystateApiOnPlaybackStartRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    onPlaybackStart(requestParameters: PlaystateApiOnPlaybackStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Reports that a session has stopped playing an item.
     * @param {PlaystateApiOnPlaybackStoppedRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    onPlaybackStopped(requestParameters: PlaystateApiOnPlaybackStoppedRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Pings a playback session.
     * @param {PlaystateApiPingPlaybackSessionRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    pingPlaybackSession(requestParameters: PlaystateApiPingPlaybackSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Reports playback progress within a session.
     * @param {PlaystateApiReportPlaybackProgressRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    reportPlaybackProgress(requestParameters?: PlaystateApiReportPlaybackProgressRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Reports playback has started within a session.
     * @param {PlaystateApiReportPlaybackStartRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    reportPlaybackStart(requestParameters?: PlaystateApiReportPlaybackStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Reports playback has stopped within a session.
     * @param {PlaystateApiReportPlaybackStoppedRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    reportPlaybackStopped(requestParameters?: PlaystateApiReportPlaybackStoppedRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
};
/**
 * Request parameters for markPlayedItem operation in PlaystateApi.
 * @export
 * @interface PlaystateApiMarkPlayedItemRequest
 */
export interface PlaystateApiMarkPlayedItemRequest {
    /**
     * Item id.
     * @type {string}
     * @memberof PlaystateApiMarkPlayedItem
     */
    readonly itemId: string;
    /**
     * User id.
     * @type {string}
     * @memberof PlaystateApiMarkPlayedItem
     */
    readonly userId?: string;
    /**
     * Optional. The date the item was played.
     * @type {string}
     * @memberof PlaystateApiMarkPlayedItem
     */
    readonly datePlayed?: string;
}
/**
 * Request parameters for markUnplayedItem operation in PlaystateApi.
 * @export
 * @interface PlaystateApiMarkUnplayedItemRequest
 */
export interface PlaystateApiMarkUnplayedItemRequest {
    /**
     * Item id.
     * @type {string}
     * @memberof PlaystateApiMarkUnplayedItem
     */
    readonly itemId: string;
    /**
     * User id.
     * @type {string}
     * @memberof PlaystateApiMarkUnplayedItem
     */
    readonly userId?: string;
}
/**
 * Request parameters for onPlaybackProgress operation in PlaystateApi.
 * @export
 * @interface PlaystateApiOnPlaybackProgressRequest
 */
export interface PlaystateApiOnPlaybackProgressRequest {
    /**
     * Item id.
     * @type {string}
     * @memberof PlaystateApiOnPlaybackProgress
     */
    readonly itemId: string;
    /**
     * The id of the MediaSource.
     * @type {string}
     * @memberof PlaystateApiOnPlaybackProgress
     */
    readonly mediaSourceId?: string;
    /**
     * Optional. The current position, in ticks. 1 tick &#x3D; 10000 ms.
     * @type {number}
     * @memberof PlaystateApiOnPlaybackProgress
     */
    readonly positionTicks?: number;
    /**
     * The audio stream index.
     * @type {number}
     * @memberof PlaystateApiOnPlaybackProgress
     */
    readonly audioStreamIndex?: number;
    /**
     * The subtitle stream index.
     * @type {number}
     * @memberof PlaystateApiOnPlaybackProgress
     */
    readonly subtitleStreamIndex?: number;
    /**
     * Scale of 0-100.
     * @type {number}
     * @memberof PlaystateApiOnPlaybackProgress
     */
    readonly volumeLevel?: number;
    /**
     * The play method.
     * @type {PlayMethod}
     * @memberof PlaystateApiOnPlaybackProgress
     */
    readonly playMethod?: PlayMethod;
    /**
     * The live stream id.
     * @type {string}
     * @memberof PlaystateApiOnPlaybackProgress
     */
    readonly liveStreamId?: string;
    /**
     * The play session id.
     * @type {string}
     * @memberof PlaystateApiOnPlaybackProgress
     */
    readonly playSessionId?: string;
    /**
     * The repeat mode.
     * @type {RepeatMode}
     * @memberof PlaystateApiOnPlaybackProgress
     */
    readonly repeatMode?: RepeatMode;
    /**
     * Indicates if the player is paused.
     * @type {boolean}
     * @memberof PlaystateApiOnPlaybackProgress
     */
    readonly isPaused?: boolean;
    /**
     * Indicates if the player is muted.
     * @type {boolean}
     * @memberof PlaystateApiOnPlaybackProgress
     */
    readonly isMuted?: boolean;
}
/**
 * Request parameters for onPlaybackStart operation in PlaystateApi.
 * @export
 * @interface PlaystateApiOnPlaybackStartRequest
 */
export interface PlaystateApiOnPlaybackStartRequest {
    /**
     * Item id.
     * @type {string}
     * @memberof PlaystateApiOnPlaybackStart
     */
    readonly itemId: string;
    /**
     * The id of the MediaSource.
     * @type {string}
     * @memberof PlaystateApiOnPlaybackStart
     */
    readonly mediaSourceId?: string;
    /**
     * The audio stream index.
     * @type {number}
     * @memberof PlaystateApiOnPlaybackStart
     */
    readonly audioStreamIndex?: number;
    /**
     * The subtitle stream index.
     * @type {number}
     * @memberof PlaystateApiOnPlaybackStart
     */
    readonly subtitleStreamIndex?: number;
    /**
     * The play method.
     * @type {PlayMethod}
     * @memberof PlaystateApiOnPlaybackStart
     */
    readonly playMethod?: PlayMethod;
    /**
     * The live stream id.
     * @type {string}
     * @memberof PlaystateApiOnPlaybackStart
     */
    readonly liveStreamId?: string;
    /**
     * The play session id.
     * @type {string}
     * @memberof PlaystateApiOnPlaybackStart
     */
    readonly playSessionId?: string;
    /**
     * Indicates if the client can seek.
     * @type {boolean}
     * @memberof PlaystateApiOnPlaybackStart
     */
    readonly canSeek?: boolean;
}
/**
 * Request parameters for onPlaybackStopped operation in PlaystateApi.
 * @export
 * @interface PlaystateApiOnPlaybackStoppedRequest
 */
export interface PlaystateApiOnPlaybackStoppedRequest {
    /**
     * Item id.
     * @type {string}
     * @memberof PlaystateApiOnPlaybackStopped
     */
    readonly itemId: string;
    /**
     * The id of the MediaSource.
     * @type {string}
     * @memberof PlaystateApiOnPlaybackStopped
     */
    readonly mediaSourceId?: string;
    /**
     * The next media type that will play.
     * @type {string}
     * @memberof PlaystateApiOnPlaybackStopped
     */
    readonly nextMediaType?: string;
    /**
     * Optional. The position, in ticks, where playback stopped. 1 tick &#x3D; 10000 ms.
     * @type {number}
     * @memberof PlaystateApiOnPlaybackStopped
     */
    readonly positionTicks?: number;
    /**
     * The live stream id.
     * @type {string}
     * @memberof PlaystateApiOnPlaybackStopped
     */
    readonly liveStreamId?: string;
    /**
     * The play session id.
     * @type {string}
     * @memberof PlaystateApiOnPlaybackStopped
     */
    readonly playSessionId?: string;
}
/**
 * Request parameters for pingPlaybackSession operation in PlaystateApi.
 * @export
 * @interface PlaystateApiPingPlaybackSessionRequest
 */
export interface PlaystateApiPingPlaybackSessionRequest {
    /**
     * Playback session id.
     * @type {string}
     * @memberof PlaystateApiPingPlaybackSession
     */
    readonly playSessionId: string;
}
/**
 * Request parameters for reportPlaybackProgress operation in PlaystateApi.
 * @export
 * @interface PlaystateApiReportPlaybackProgressRequest
 */
export interface PlaystateApiReportPlaybackProgressRequest {
    /**
     * The playback progress info.
     * @type {PlaybackProgressInfo}
     * @memberof PlaystateApiReportPlaybackProgress
     */
    readonly playbackProgressInfo?: PlaybackProgressInfo;
}
/**
 * Request parameters for reportPlaybackStart operation in PlaystateApi.
 * @export
 * @interface PlaystateApiReportPlaybackStartRequest
 */
export interface PlaystateApiReportPlaybackStartRequest {
    /**
     * The playback start info.
     * @type {PlaybackStartInfo}
     * @memberof PlaystateApiReportPlaybackStart
     */
    readonly playbackStartInfo?: PlaybackStartInfo;
}
/**
 * Request parameters for reportPlaybackStopped operation in PlaystateApi.
 * @export
 * @interface PlaystateApiReportPlaybackStoppedRequest
 */
export interface PlaystateApiReportPlaybackStoppedRequest {
    /**
     * The playback stop info.
     * @type {PlaybackStopInfo}
     * @memberof PlaystateApiReportPlaybackStopped
     */
    readonly playbackStopInfo?: PlaybackStopInfo;
}
/**
 * PlaystateApi - object-oriented interface
 * @export
 * @class PlaystateApi
 * @extends {BaseAPI}
 */
export declare class PlaystateApi extends BaseAPI {
    /**
     *
     * @summary Marks an item as played for user.
     * @param {PlaystateApiMarkPlayedItemRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlaystateApi
     */
    markPlayedItem(requestParameters: PlaystateApiMarkPlayedItemRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserItemDataDto, any>>;
    /**
     *
     * @summary Marks an item as unplayed for user.
     * @param {PlaystateApiMarkUnplayedItemRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlaystateApi
     */
    markUnplayedItem(requestParameters: PlaystateApiMarkUnplayedItemRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserItemDataDto, any>>;
    /**
     *
     * @summary Reports a session\'s playback progress.
     * @param {PlaystateApiOnPlaybackProgressRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlaystateApi
     */
    onPlaybackProgress(requestParameters: PlaystateApiOnPlaybackProgressRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Reports that a session has begun playing an item.
     * @param {PlaystateApiOnPlaybackStartRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlaystateApi
     */
    onPlaybackStart(requestParameters: PlaystateApiOnPlaybackStartRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Reports that a session has stopped playing an item.
     * @param {PlaystateApiOnPlaybackStoppedRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlaystateApi
     */
    onPlaybackStopped(requestParameters: PlaystateApiOnPlaybackStoppedRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Pings a playback session.
     * @param {PlaystateApiPingPlaybackSessionRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlaystateApi
     */
    pingPlaybackSession(requestParameters: PlaystateApiPingPlaybackSessionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Reports playback progress within a session.
     * @param {PlaystateApiReportPlaybackProgressRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlaystateApi
     */
    reportPlaybackProgress(requestParameters?: PlaystateApiReportPlaybackProgressRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Reports playback has started within a session.
     * @param {PlaystateApiReportPlaybackStartRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlaystateApi
     */
    reportPlaybackStart(requestParameters?: PlaystateApiReportPlaybackStartRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Reports playback has stopped within a session.
     * @param {PlaystateApiReportPlaybackStoppedRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlaystateApi
     */
    reportPlaybackStopped(requestParameters?: PlaystateApiReportPlaybackStoppedRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
}