@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
26 lines (25 loc) • 1.1 kB
TypeScript
import { BaseAPI } from '../../common/BaseAPI';
import Configuration from '../../common/Configuration';
import UsageReportsApi from './usageReports/UsageReportsApi';
import EncodingApi from './encoding/EncodingApi';
import Notification from '../../models/Notification';
import PaginationResponse from '../../models/PaginationResponse';
import { NotificationListQueryParams, NotificationListQueryParamsBuilder } from './NotificationListQueryParams';
/**
* EmailsApi - object-oriented interface
* @export
* @class EmailsApi
* @extends {BaseAPI}
*/
export default class EmailsApi extends BaseAPI {
usageReports: UsageReportsApi;
encoding: EncodingApi;
constructor(configuration: Configuration);
/**
* @summary List Email Notifications
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof EmailsApi
*/
list(queryParameters?: NotificationListQueryParams | ((q: NotificationListQueryParamsBuilder) => NotificationListQueryParamsBuilder)): Promise<PaginationResponse<Notification>>;
}