@bitmovin/api-sdk 1.279.0 → 1.280.0

package/dist/notifications/webhooks/encoding/encodings/liveEncodingHeartbeat/LiveEncodingHeartbeatApi.js

@@ -2,10 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const BaseAPI_1 = require("../../../../../common/BaseAPI");
 const Mapper_1 = require("../../../../../common/Mapper");
+const CustomdataApi_1 = require("./customdata/CustomdataApi");
 const BitmovinResponse_1 = require("../../../../../models/BitmovinResponse");
 const LiveEncodingHeartbeatWebhook_1 = require("../../../../../models/LiveEncodingHeartbeatWebhook");
 const PaginationResponse_1 = require("../../../../../models/PaginationResponse");
 const LiveEncodingHeartbeatWebhookListQueryParams_1 = require("./LiveEncodingHeartbeatWebhookListQueryParams");
+const LiveEncodingHeartbeatWebhookListByEncodingIdQueryParams_1 = require("./LiveEncodingHeartbeatWebhookListByEncodingIdQueryParams");
 /**
  * LiveEncodingHeartbeatApi - object-oriented interface
  * @export
@@ -15,6 +17,7 @@ const LiveEncodingHeartbeatWebhookListQueryParams_1 = require("./LiveEncodingHea
 class LiveEncodingHeartbeatApi extends BaseAPI_1.BaseAPI {
     constructor(configuration) {
         super(configuration);
+        this.customdata = new CustomdataApi_1.default(configuration);
     }
     /**
      * @summary Create 'Live Encoding Heartbeat' Webhook
@@ -27,6 +30,37 @@ class LiveEncodingHeartbeatApi extends BaseAPI_1.BaseAPI {
             return (0, Mapper_1.map)(response, LiveEncodingHeartbeatWebhook_1.default);
         });
     }
+    /**
+     * @summary Create 'Live Encoding Heartbeat' Webhook for a specific Encoding
+     * @param {string} encodingId Id of the encoding
+     * @param {LiveEncodingHeartbeatWebhook} liveEncodingHeartbeatWebhook The 'Live Encoding Heartbeat' Webhook to be added.
+     * @throws {BitmovinError}
+     * @memberof LiveEncodingHeartbeatApi
+     */
+    createByEncodingId(encodingId, liveEncodingHeartbeatWebhook) {
+        const pathParamMap = {
+            encoding_id: encodingId
+        };
+        return this.restClient.post('/notifications/webhooks/encoding/encodings/{encoding_id}/live-encoding-heartbeat', pathParamMap, liveEncodingHeartbeatWebhook).then((response) => {
+            return (0, Mapper_1.map)(response, LiveEncodingHeartbeatWebhook_1.default);
+        });
+    }
+    /**
+     * @summary Delete 'Live Encoding Heartbeat' Webhook for a specific Encoding
+     * @param {string} encodingId Id of the encoding
+     * @param {string} webhookId Id of the webhook
+     * @throws {BitmovinError}
+     * @memberof LiveEncodingHeartbeatApi
+     */
+    deleteByEncodingIdAndWebhookId(encodingId, webhookId) {
+        const pathParamMap = {
+            encoding_id: encodingId,
+            webhook_id: webhookId
+        };
+        return this.restClient.delete('/notifications/webhooks/encoding/encodings/{encoding_id}/live-encoding-heartbeat/{webhook_id}', pathParamMap).then((response) => {
+            return (0, Mapper_1.map)(response, BitmovinResponse_1.default);
+        });
+    }
     /**
      * @summary Delete 'Live Encoding Heartbeat' Webhook
      * @param {string} webhookId Id of the webhook
@@ -41,6 +75,22 @@ class LiveEncodingHeartbeatApi extends BaseAPI_1.BaseAPI {
             return (0, Mapper_1.map)(response, BitmovinResponse_1.default);
         });
     }
+    /**
+     * @summary Get 'Live Encoding Heartbeat' Webhook details for a specific Encoding
+     * @param {string} encodingId Id of the encoding
+     * @param {string} webhookId Id of the webhook
+     * @throws {BitmovinError}
+     * @memberof LiveEncodingHeartbeatApi
+     */
+    getByEncodingIdAndWebhookId(encodingId, webhookId) {
+        const pathParamMap = {
+            encoding_id: encodingId,
+            webhook_id: webhookId
+        };
+        return this.restClient.get('/notifications/webhooks/encoding/encodings/{encoding_id}/live-encoding-heartbeat/{webhook_id}', pathParamMap).then((response) => {
+            return (0, Mapper_1.map)(response, LiveEncodingHeartbeatWebhook_1.default);
+        });
+    }
     /**
      * @summary Get 'Live Encoding Heartbeat' Webhook details
      * @param {string} webhookId Id of the webhook
@@ -73,5 +123,27 @@ class LiveEncodingHeartbeatApi extends BaseAPI_1.BaseAPI {
             return new PaginationResponse_1.default(response, LiveEncodingHeartbeatWebhook_1.default);
         });
     }
+    /**
+     * @summary List 'Live Encoding Heartbeat' Webhooks for a specific Encoding
+     * @param {string} encodingId Id of the encoding
+     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
+     * @throws {BitmovinError}
+     * @memberof LiveEncodingHeartbeatApi
+     */
+    listByEncodingId(encodingId, queryParameters) {
+        const pathParamMap = {
+            encoding_id: encodingId
+        };
+        let queryParams = {};
+        if (typeof queryParameters === 'function') {
+            queryParams = queryParameters(new LiveEncodingHeartbeatWebhookListByEncodingIdQueryParams_1.LiveEncodingHeartbeatWebhookListByEncodingIdQueryParamsBuilder()).buildQueryParams();
+        }
+        else if (queryParameters) {
+            queryParams = queryParameters;
+        }
+        return this.restClient.get('/notifications/webhooks/encoding/encodings/{encoding_id}/live-encoding-heartbeat', pathParamMap, queryParams).then((response) => {
+            return new PaginationResponse_1.default(response, LiveEncodingHeartbeatWebhook_1.default);
+        });
+    }
 }
 exports.default = LiveEncodingHeartbeatApi;

package/dist/notifications/webhooks/encoding/encodings/liveEncodingHeartbeat/LiveEncodingHeartbeatWebhookListByEncodingIdQueryParams.d.ts

@@ -0,0 +1,28 @@
+export interface LiveEncodingHeartbeatWebhookListByEncodingIdQueryParams {
+    /**
+     * Index of the first item to return, starting at 0. Default is 0
+     * @type {number}
+     * @memberof LiveEncodingHeartbeatWebhookListByEncodingIdQueryParams
+     */
+    offset?: number | undefined;
+    /**
+     * Maximum number of items to return. Default is 25, maximum is 100
+     * @type {number}
+     * @memberof LiveEncodingHeartbeatWebhookListByEncodingIdQueryParams
+     */
+    limit?: number | undefined;
+}
+export declare class LiveEncodingHeartbeatWebhookListByEncodingIdQueryParamsBuilder {
+    private internalParams;
+    /**
+     *
+     * @param offset Index of the first item to return, starting at 0. Default is 0
+     */
+    offset(offset: number): this;
+    /**
+     *
+     * @param limit Maximum number of items to return. Default is 25, maximum is 100
+     */
+    limit(limit: number): this;
+    buildQueryParams(): LiveEncodingHeartbeatWebhookListByEncodingIdQueryParams;
+}

package/dist/notifications/webhooks/encoding/encodings/liveEncodingHeartbeat/LiveEncodingHeartbeatWebhookListByEncodingIdQueryParams.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LiveEncodingHeartbeatWebhookListByEncodingIdQueryParamsBuilder = void 0;
+class LiveEncodingHeartbeatWebhookListByEncodingIdQueryParamsBuilder {
+    constructor() {
+        this.internalParams = {};
+    }
+    /**
+     *
+     * @param offset Index of the first item to return, starting at 0. Default is 0
+     */
+    offset(offset) {
+        this.internalParams.offset = offset;
+        return this;
+    }
+    /**
+     *
+     * @param limit Maximum number of items to return. Default is 25, maximum is 100
+     */
+    limit(limit) {
+        this.internalParams.limit = limit;
+        return this;
+    }
+    buildQueryParams() {
+        return this.internalParams;
+    }
+}
+exports.LiveEncodingHeartbeatWebhookListByEncodingIdQueryParamsBuilder = LiveEncodingHeartbeatWebhookListByEncodingIdQueryParamsBuilder;

package/dist/notifications/webhooks/encoding/encodings/liveEncodingHeartbeat/customdata/CustomdataApi.d.ts

@@ -0,0 +1,27 @@
+import { BaseAPI } from '../../../../../../common/BaseAPI';
+import Configuration from '../../../../../../common/Configuration';
+import CustomData from '../../../../../../models/CustomData';
+/**
+ * CustomdataApi - object-oriented interface
+ * @export
+ * @class CustomdataApi
+ * @extends {BaseAPI}
+ */
+export default class CustomdataApi extends BaseAPI {
+    constructor(configuration: Configuration);
+    /**
+     * @summary Get 'Live Encoding Heartbeat' Webhook Custom Data for a specific Encoding
+     * @param {string} encodingId Id of the encoding
+     * @param {string} webhookId Id of the webhook
+     * @throws {BitmovinError}
+     * @memberof CustomdataApi
+     */
+    getCustomDataByEncodingIdAndWebhookId(encodingId: string, webhookId: string): Promise<CustomData>;
+    /**
+     * @summary Get 'Live Encoding Heartbeat' Webhook Custom Data
+     * @param {string} webhookId Id of the webhook
+     * @throws {BitmovinError}
+     * @memberof CustomdataApi
+     */
+    getCustomDataByWebhookId(webhookId: string): Promise<CustomData>;
+}

package/dist/notifications/webhooks/encoding/encodings/liveEncodingHeartbeat/customdata/CustomdataApi.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseAPI_1 = require("../../../../../../common/BaseAPI");
+const Mapper_1 = require("../../../../../../common/Mapper");
+const CustomData_1 = require("../../../../../../models/CustomData");
+/**
+ * CustomdataApi - object-oriented interface
+ * @export
+ * @class CustomdataApi
+ * @extends {BaseAPI}
+ */
+class CustomdataApi extends BaseAPI_1.BaseAPI {
+    constructor(configuration) {
+        super(configuration);
+    }
+    /**
+     * @summary Get 'Live Encoding Heartbeat' Webhook Custom Data for a specific Encoding
+     * @param {string} encodingId Id of the encoding
+     * @param {string} webhookId Id of the webhook
+     * @throws {BitmovinError}
+     * @memberof CustomdataApi
+     */
+    getCustomDataByEncodingIdAndWebhookId(encodingId, webhookId) {
+        const pathParamMap = {
+            encoding_id: encodingId,
+            webhook_id: webhookId
+        };
+        return this.restClient.get('/notifications/webhooks/encoding/encodings/{encoding_id}/live-encoding-heartbeat/{webhook_id}/customData', pathParamMap).then((response) => {
+            return (0, Mapper_1.map)(response, CustomData_1.default);
+        });
+    }
+    /**
+     * @summary Get 'Live Encoding Heartbeat' Webhook Custom Data
+     * @param {string} webhookId Id of the webhook
+     * @throws {BitmovinError}
+     * @memberof CustomdataApi
+     */
+    getCustomDataByWebhookId(webhookId) {
+        const pathParamMap = {
+            webhook_id: webhookId
+        };
+        return this.restClient.get('/notifications/webhooks/encoding/encodings/live-encoding-heartbeat/{webhook_id}/customData', pathParamMap).then((response) => {
+            return (0, Mapper_1.map)(response, CustomData_1.default);
+        });
+    }
+}
+exports.default = CustomdataApi;

package/dist/player/PlayerApi.d.ts

@@ -3,6 +3,7 @@ import Configuration from '../common/Configuration';
 import ChannelsApi from './channels/ChannelsApi';
 import LicensesApi from './licenses/LicensesApi';
 import CustomBuildsApi from './customBuilds/CustomBuildsApi';
+import TestingApi from './testing/TestingApi';
 /**
  * PlayerApi - object-oriented interface
  * @export
@@ -13,5 +14,6 @@ export default class PlayerApi extends BaseAPI {
     channels: ChannelsApi;
     licenses: LicensesApi;
     customBuilds: CustomBuildsApi;
+    testing: TestingApi;
     constructor(configuration: Configuration);
 }

package/dist/player/PlayerApi.js

@@ -4,6 +4,7 @@ const BaseAPI_1 = require("../common/BaseAPI");
 const ChannelsApi_1 = require("./channels/ChannelsApi");
 const LicensesApi_1 = require("./licenses/LicensesApi");
 const CustomBuildsApi_1 = require("./customBuilds/CustomBuildsApi");
+const TestingApi_1 = require("./testing/TestingApi");
 /**
  * PlayerApi - object-oriented interface
  * @export
@@ -16,6 +17,7 @@ class PlayerApi extends BaseAPI_1.BaseAPI {
         this.channels = new ChannelsApi_1.default(configuration);
         this.licenses = new LicensesApi_1.default(configuration);
         this.customBuilds = new CustomBuildsApi_1.default(configuration);
+        this.testing = new TestingApi_1.default(configuration);
     }
 }
 exports.default = PlayerApi;

package/dist/player/testing/TestingApi.d.ts

@@ -0,0 +1,13 @@
+import { BaseAPI } from '../../common/BaseAPI';
+import Configuration from '../../common/Configuration';
+import CodecCompatibilityApi from './codecCompatibility/CodecCompatibilityApi';
+/**
+ * TestingApi - object-oriented interface
+ * @export
+ * @class TestingApi
+ * @extends {BaseAPI}
+ */
+export default class TestingApi extends BaseAPI {
+    codecCompatibility: CodecCompatibilityApi;
+    constructor(configuration: Configuration);
+}

package/dist/player/testing/TestingApi.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseAPI_1 = require("../../common/BaseAPI");
+const CodecCompatibilityApi_1 = require("./codecCompatibility/CodecCompatibilityApi");
+/**
+ * TestingApi - object-oriented interface
+ * @export
+ * @class TestingApi
+ * @extends {BaseAPI}
+ */
+class TestingApi extends BaseAPI_1.BaseAPI {
+    constructor(configuration) {
+        super(configuration);
+        this.codecCompatibility = new CodecCompatibilityApi_1.default(configuration);
+    }
+}
+exports.default = TestingApi;

package/dist/player/testing/codecCompatibility/CodecCompatibilityApi.d.ts

@@ -0,0 +1,20 @@
+import { BaseAPI } from '../../../common/BaseAPI';
+import Configuration from '../../../common/Configuration';
+import PccReport from '../../../models/PccReport';
+import { PccReportGetQueryParams, PccReportGetQueryParamsBuilder } from './PccReportGetQueryParams';
+/**
+ * CodecCompatibilityApi - object-oriented interface
+ * @export
+ * @class CodecCompatibilityApi
+ * @extends {BaseAPI}
+ */
+export default class CodecCompatibilityApi extends BaseAPI {
+    constructor(configuration: Configuration);
+    /**
+     * @summary Get Codec Compatibility Report
+     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
+     * @throws {BitmovinError}
+     * @memberof CodecCompatibilityApi
+     */
+    get(queryParameters?: PccReportGetQueryParams | ((q: PccReportGetQueryParamsBuilder) => PccReportGetQueryParamsBuilder)): Promise<PccReport>;
+}

package/dist/player/testing/codecCompatibility/CodecCompatibilityApi.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseAPI_1 = require("../../../common/BaseAPI");
+const Mapper_1 = require("../../../common/Mapper");
+const PccReport_1 = require("../../../models/PccReport");
+const PccReportGetQueryParams_1 = require("./PccReportGetQueryParams");
+/**
+ * CodecCompatibilityApi - object-oriented interface
+ * @export
+ * @class CodecCompatibilityApi
+ * @extends {BaseAPI}
+ */
+class CodecCompatibilityApi extends BaseAPI_1.BaseAPI {
+    constructor(configuration) {
+        super(configuration);
+    }
+    /**
+     * @summary Get Codec Compatibility Report
+     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
+     * @throws {BitmovinError}
+     * @memberof CodecCompatibilityApi
+     */
+    get(queryParameters) {
+        let queryParams = {};
+        if (typeof queryParameters === 'function') {
+            queryParams = queryParameters(new PccReportGetQueryParams_1.PccReportGetQueryParamsBuilder()).buildQueryParams();
+        }
+        else if (queryParameters) {
+            queryParams = queryParameters;
+        }
+        return this.restClient.get('/player/testing/codec-compatibility', {}, queryParams).then((response) => {
+            return (0, Mapper_1.map)(response, PccReport_1.default);
+        });
+    }
+}
+exports.default = CodecCompatibilityApi;

package/dist/player/testing/codecCompatibility/PccReportGetQueryParams.d.ts

@@ -0,0 +1,61 @@
+export interface PccReportGetQueryParams {
+    /**
+     * Include pools with only prerelease browser evidence. Available to every report reader. Literal true or false.
+     * @type {boolean}
+     * @memberof PccReportGetQueryParams
+     */
+    includePrerelease?: boolean | undefined;
+    /**
+     * Keep pools with a device answer in at least one selected cell. Literal true or false.
+     * @type {boolean}
+     * @memberof PccReportGetQueryParams
+     */
+    reportedOnly?: boolean | undefined;
+    /**
+     * Select only HDR columns. Literal true or false.
+     * @type {boolean}
+     * @memberof PccReportGetQueryParams
+     */
+    hdrOnly?: boolean | undefined;
+    /**
+     * Trimmed case-insensitive substring of the codec identifier.
+     * @type {string}
+     * @memberof PccReportGetQueryParams
+     */
+    codec?: string | undefined;
+    /**
+     * Trimmed case-insensitive substring of the published device name and qualifier.
+     * @type {string}
+     * @memberof PccReportGetQueryParams
+     */
+    device?: string | undefined;
+}
+export declare class PccReportGetQueryParamsBuilder {
+    private internalParams;
+    /**
+     *
+     * @param includePrerelease Include pools with only prerelease browser evidence. Available to every report reader. Literal true or false.
+     */
+    includePrerelease(includePrerelease: boolean): this;
+    /**
+     *
+     * @param reportedOnly Keep pools with a device answer in at least one selected cell. Literal true or false.
+     */
+    reportedOnly(reportedOnly: boolean): this;
+    /**
+     *
+     * @param hdrOnly Select only HDR columns. Literal true or false.
+     */
+    hdrOnly(hdrOnly: boolean): this;
+    /**
+     *
+     * @param codec Trimmed case-insensitive substring of the codec identifier.
+     */
+    codec(codec: string): this;
+    /**
+     *
+     * @param device Trimmed case-insensitive substring of the published device name and qualifier.
+     */
+    device(device: string): this;
+    buildQueryParams(): PccReportGetQueryParams;
+}

package/dist/player/testing/codecCompatibility/PccReportGetQueryParams.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PccReportGetQueryParamsBuilder = void 0;
+class PccReportGetQueryParamsBuilder {
+    constructor() {
+        this.internalParams = {};
+    }
+    /**
+     *
+     * @param includePrerelease Include pools with only prerelease browser evidence. Available to every report reader. Literal true or false.
+     */
+    includePrerelease(includePrerelease) {
+        this.internalParams.includePrerelease = includePrerelease;
+        return this;
+    }
+    /**
+     *
+     * @param reportedOnly Keep pools with a device answer in at least one selected cell. Literal true or false.
+     */
+    reportedOnly(reportedOnly) {
+        this.internalParams.reportedOnly = reportedOnly;
+        return this;
+    }
+    /**
+     *
+     * @param hdrOnly Select only HDR columns. Literal true or false.
+     */
+    hdrOnly(hdrOnly) {
+        this.internalParams.hdrOnly = hdrOnly;
+        return this;
+    }
+    /**
+     *
+     * @param codec Trimmed case-insensitive substring of the codec identifier.
+     */
+    codec(codec) {
+        this.internalParams.codec = codec;
+        return this;
+    }
+    /**
+     *
+     * @param device Trimmed case-insensitive substring of the published device name and qualifier.
+     */
+    device(device) {
+        this.internalParams.device = device;
+        return this;
+    }
+    buildQueryParams() {
+        return this.internalParams;
+    }
+}
+exports.PccReportGetQueryParamsBuilder = PccReportGetQueryParamsBuilder;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitmovin/api-sdk",
-  "version": "1.279.0",
+  "version": "1.280.0",
   "description": "Bitmovin JS/TS API SDK",
   "author": "Bitmovin Inc",
   "keywords": [