@jellyfin/sdk
Version:
A TypeScript SDK for Jellyfin.
111 lines (110 loc) • 4.54 kB
TypeScript
/**
* 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 { ActivityLogEntryQueryResult } from '../models';
/**
* ActivityLogApi - axios parameter creator
* @export
*/
export declare const ActivityLogApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Gets activity log entries.
* @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
* @param {number} [limit] Optional. The maximum number of records to return.
* @param {string} [minDate] Optional. The minimum date. Format = ISO.
* @param {boolean} [hasUserId] Optional. Filter log entries if it has user id, or not.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getLogEntries: (startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* ActivityLogApi - functional programming interface
* @export
*/
export declare const ActivityLogApiFp: (configuration?: Configuration) => {
/**
*
* @summary Gets activity log entries.
* @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
* @param {number} [limit] Optional. The maximum number of records to return.
* @param {string} [minDate] Optional. The minimum date. Format = ISO.
* @param {boolean} [hasUserId] Optional. Filter log entries if it has user id, or not.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getLogEntries(startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActivityLogEntryQueryResult>>;
};
/**
* ActivityLogApi - factory interface
* @export
*/
export declare const ActivityLogApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Gets activity log entries.
* @param {ActivityLogApiGetLogEntriesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getLogEntries(requestParameters?: ActivityLogApiGetLogEntriesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ActivityLogEntryQueryResult>;
};
/**
* Request parameters for getLogEntries operation in ActivityLogApi.
* @export
* @interface ActivityLogApiGetLogEntriesRequest
*/
export interface ActivityLogApiGetLogEntriesRequest {
/**
* Optional. The record index to start at. All items with a lower index will be dropped from the results.
* @type {number}
* @memberof ActivityLogApiGetLogEntries
*/
readonly startIndex?: number;
/**
* Optional. The maximum number of records to return.
* @type {number}
* @memberof ActivityLogApiGetLogEntries
*/
readonly limit?: number;
/**
* Optional. The minimum date. Format = ISO.
* @type {string}
* @memberof ActivityLogApiGetLogEntries
*/
readonly minDate?: string;
/**
* Optional. Filter log entries if it has user id, or not.
* @type {boolean}
* @memberof ActivityLogApiGetLogEntries
*/
readonly hasUserId?: boolean;
}
/**
* ActivityLogApi - object-oriented interface
* @export
* @class ActivityLogApi
* @extends {BaseAPI}
*/
export declare class ActivityLogApi extends BaseAPI {
/**
*
* @summary Gets activity log entries.
* @param {ActivityLogApiGetLogEntriesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ActivityLogApi
*/
getLogEntries(requestParameters?: ActivityLogApiGetLogEntriesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ActivityLogEntryQueryResult, any>>;
}