@bitmovin/api-sdk/dist/models/AnalyticsLicense.d.ts

Bitmovin JS/TS API SDK

import AnalyticsLicenseCustomDataFieldLabels from './AnalyticsLicenseCustomDataFieldLabels';
import AnalyticsLicenseDomain from './AnalyticsLicenseDomain';
import AnalyticsLicenseFeatures from './AnalyticsLicenseFeatures';
/**
 * @export
 * @class AnalyticsLicense
 */
export declare class AnalyticsLicense {
    /**
     * Id of the Analytics License
     * @type {string}
     * @memberof AnalyticsLicense
     */
    id?: string;
    /**
     * Creation date of the Analytics License, returned as ISO 8601 date-time format
     * @type {Date}
     * @memberof AnalyticsLicense
     */
    createdAt?: Date;
    /**
     * User-specific meta data. This can hold anything.
     * @type {{ [key: string]: any; }}
     * @memberof AnalyticsLicense
     */
    customData?: {
        [key: string]: any;
    };
    /**
     * License Key
     * @type {string}
     * @memberof AnalyticsLicense
     */
    licenseKey?: string;
    /**
     * Name of the Analytics License
     * @type {string}
     * @memberof AnalyticsLicense
     */
    name?: string;
    /**
     * The industry of the organization associated with the Analytics License
     * @type {string}
     * @memberof AnalyticsLicense
     */
    industry?: string;
    /**
     * The subindustry of the organization associated with the Analytics License
     * @type {string}
     * @memberof AnalyticsLicense
     */
    subIndustry?: string;
    /**
     * Whether the Do Not Track request from the browser should be ignored
     * @type {boolean}
     * @memberof AnalyticsLicense
     */
    ignoreDNT?: boolean;
    /**
     * Number of impressions recorded
     * @type {number}
     * @memberof AnalyticsLicense
     */
    impressions?: number;
    /**
     * Maximum number of impressions
     * @type {number}
     * @memberof AnalyticsLicense
     */
    maxImpressions?: number;
    /**
     * The timezone of the Analytics License
     * @type {string}
     * @memberof AnalyticsLicense
     */
    timeZone?: string;
    /**
     * Retention time of impressions, returned as ISO 8601 duration format: P(n)Y(n)M(n)DT(n)H(n)M(n)S
     * @type {string}
     * @memberof AnalyticsLicense
     */
    retentionTime?: string;
    /**
     * Retention time for compressed data, returned as ISO 8601 duration format: P(n)Y(n)M(n)DT(n)H(n)M(n)S
     * @type {string}
     * @memberof AnalyticsLicense
     */
    compressedRetentionTime?: string;
    /**
     * Whitelisted domains
     * @type {AnalyticsLicenseDomain[]}
     * @memberof AnalyticsLicense
     */
    domains?: AnalyticsLicenseDomain[];
    /**
     * Allowlisted player domains
     * @type {string[]}
     * @memberof AnalyticsLicense
     */
    playerDomains?: string[];
    /**
     * Whether the data of this license should be included in the industry insights or not
     * @type {boolean}
     * @memberof AnalyticsLicense
     */
    includeInInsights?: boolean;
    /**
     * Labels for CustomData fields
     * @type {AnalyticsLicenseCustomDataFieldLabels}
     * @memberof AnalyticsLicense
     */
    customDataFieldLabels?: AnalyticsLicenseCustomDataFieldLabels;
    /**
     * The number of customData fields available
     * @type {number}
     * @memberof AnalyticsLicense
     */
    customDataFieldsCount?: number;
    /**
     * Order index of license
     * @type {number}
     * @memberof AnalyticsLicense
     */
    orderIndex?: number;
    /**
     * The rate limit of this license
     * @type {string}
     * @memberof AnalyticsLicense
     */
    rateLimit?: string;
    /**
     * @type {AnalyticsLicenseFeatures}
     * @memberof AnalyticsLicense
     */
    features?: AnalyticsLicenseFeatures;
    /**
     * The expiration date of the license if applicable, returned as ISO 8601 date-time format
     * @type {Date}
     * @memberof AnalyticsLicense
     */
    planExpiredAt?: Date;
    constructor(obj?: Partial<AnalyticsLicense>);
}
export default AnalyticsLicense;