@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
34 lines (33 loc) • 1.83 kB
TypeScript
import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import DailyApi from './daily/DailyApi';
import StatisticsPerLabel from '../../../models/StatisticsPerLabel';
import PaginationResponse from '../../../models/PaginationResponse';
import { StatisticsPerLabelListQueryParams, StatisticsPerLabelListQueryParamsBuilder } from './StatisticsPerLabelListQueryParams';
import { StatisticsPerLabelListByDateRangeQueryParams, StatisticsPerLabelListByDateRangeQueryParamsBuilder } from './StatisticsPerLabelListByDateRangeQueryParams';
/**
* LabelsApi - object-oriented interface
* @export
* @class LabelsApi
* @extends {BaseAPI}
*/
export default class LabelsApi extends BaseAPI {
daily: DailyApi;
constructor(configuration: Configuration);
/**
* @summary Get Statistics per Label
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof LabelsApi
*/
list(queryParameters?: StatisticsPerLabelListQueryParams | ((q: StatisticsPerLabelListQueryParamsBuilder) => StatisticsPerLabelListQueryParamsBuilder)): Promise<PaginationResponse<StatisticsPerLabel>>;
/**
* @summary Get statistics per label within specific dates
* @param {Date} from Start date. Format: yyyy-MM-dd
* @param {Date} to End date. Format: yyyy-MM-dd
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof LabelsApi
*/
listByDateRange(from: Date, to: Date, queryParameters?: StatisticsPerLabelListByDateRangeQueryParams | ((q: StatisticsPerLabelListByDateRangeQueryParamsBuilder) => StatisticsPerLabelListByDateRangeQueryParamsBuilder)): Promise<PaginationResponse<StatisticsPerLabel>>;
}