@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
46 lines (45 loc) • 1.86 kB
TypeScript
import { BaseAPI } from '../../common/BaseAPI';
import Configuration from '../../common/Configuration';
import DomainsApi from './domains/DomainsApi';
import AnalyticsLicense from '../../models/AnalyticsLicense';
import PaginationResponse from '../../models/PaginationResponse';
import { AnalyticsLicenseListQueryParams, AnalyticsLicenseListQueryParamsBuilder } from './AnalyticsLicenseListQueryParams';
/**
* LicensesApi - object-oriented interface
* @export
* @class LicensesApi
* @extends {BaseAPI}
*/
export default class LicensesApi extends BaseAPI {
domains: DomainsApi;
constructor(configuration: Configuration);
/**
* @summary Create Analytics License
* @param {AnalyticsLicense} analyticsLicense Analytics License to be created
* @throws {BitmovinError}
* @memberof LicensesApi
*/
create(analyticsLicense?: AnalyticsLicense): Promise<AnalyticsLicense>;
/**
* @summary Get License
* @param {string} licenseId License id
* @throws {BitmovinError}
* @memberof LicensesApi
*/
get(licenseId: string): Promise<AnalyticsLicense>;
/**
* @summary List Analytics Licenses
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof LicensesApi
*/
list(queryParameters?: AnalyticsLicenseListQueryParams | ((q: AnalyticsLicenseListQueryParamsBuilder) => AnalyticsLicenseListQueryParamsBuilder)): Promise<PaginationResponse<AnalyticsLicense>>;
/**
* @summary Update Analytics License
* @param {string} licenseId License id
* @param {AnalyticsLicense} analyticsLicense Analytics License details to be updated
* @throws {BitmovinError}
* @memberof LicensesApi
*/
update(licenseId: string, analyticsLicense?: AnalyticsLicense): Promise<AnalyticsLicense>;
}