@bitmovin/api-sdk 1.280.0 → 1.281.0

package/README.md

@@ -31,7 +31,7 @@ If you have any questions regarding the SDK, provided examples or our services,
 ## Installation
 
 ``` bash
-npm install @bitmovin/api-sdk@1.280.0
+npm install @bitmovin/api-sdk@1.281.0
 ```
 
 ## Initialization

package/dist/aiSceneAnalysis/AiSceneAnalysisApi.d.ts

@@ -1,6 +1,7 @@
 import { BaseAPI } from '../common/BaseAPI';
 import Configuration from '../common/Configuration';
 import AnalysesApi from './analyses/AnalysesApi';
+import LiveAnalysesApi from './liveAnalyses/LiveAnalysesApi';
 /**
  * AiSceneAnalysisApi - object-oriented interface
  * @export
@@ -9,5 +10,6 @@ import AnalysesApi from './analyses/AnalysesApi';
  */
 export default class AiSceneAnalysisApi extends BaseAPI {
     analyses: AnalysesApi;
+    liveAnalyses: LiveAnalysesApi;
     constructor(configuration: Configuration);
 }

package/dist/aiSceneAnalysis/AiSceneAnalysisApi.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const BaseAPI_1 = require("../common/BaseAPI");
 const AnalysesApi_1 = require("./analyses/AnalysesApi");
+const LiveAnalysesApi_1 = require("./liveAnalyses/LiveAnalysesApi");
 /**
  * AiSceneAnalysisApi - object-oriented interface
  * @export
@@ -12,6 +13,7 @@ class AiSceneAnalysisApi extends BaseAPI_1.BaseAPI {
     constructor(configuration) {
         super(configuration);
         this.analyses = new AnalysesApi_1.default(configuration);
+        this.liveAnalyses = new LiveAnalysesApi_1.default(configuration);
     }
 }
 exports.default = AiSceneAnalysisApi;

package/dist/aiSceneAnalysis/liveAnalyses/AiSceneAnalysisLiveResponseListQueryParams.d.ts

@@ -0,0 +1,28 @@
+export interface AiSceneAnalysisLiveResponseListQueryParams {
+    /**
+     * Index of the first item to return, starting at 0. Default is 0
+     * @type {number}
+     * @memberof AiSceneAnalysisLiveResponseListQueryParams
+     */
+    offset?: number | undefined;
+    /**
+     * Maximum number of items to return. Default is 25, maximum is 100
+     * @type {number}
+     * @memberof AiSceneAnalysisLiveResponseListQueryParams
+     */
+    limit?: number | undefined;
+}
+export declare class AiSceneAnalysisLiveResponseListQueryParamsBuilder {
+    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(): AiSceneAnalysisLiveResponseListQueryParams;
+}

package/dist/aiSceneAnalysis/liveAnalyses/AiSceneAnalysisLiveResponseListQueryParams.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AiSceneAnalysisLiveResponseListQueryParamsBuilder = void 0;
+class AiSceneAnalysisLiveResponseListQueryParamsBuilder {
+    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.AiSceneAnalysisLiveResponseListQueryParamsBuilder = AiSceneAnalysisLiveResponseListQueryParamsBuilder;

package/dist/aiSceneAnalysis/liveAnalyses/LiveAnalysesApi.d.ts

@@ -0,0 +1,60 @@
+import { BaseAPI } from '../../common/BaseAPI';
+import Configuration from '../../common/Configuration';
+import ResultsApi from './results/ResultsApi';
+import AiSceneAnalysisLiveCreateRequest from '../../models/AiSceneAnalysisLiveCreateRequest';
+import AiSceneAnalysisLiveResponse from '../../models/AiSceneAnalysisLiveResponse';
+import BitmovinResponse from '../../models/BitmovinResponse';
+import PaginationResponse from '../../models/PaginationResponse';
+import { AiSceneAnalysisLiveResponseListQueryParams, AiSceneAnalysisLiveResponseListQueryParamsBuilder } from './AiSceneAnalysisLiveResponseListQueryParams';
+/**
+ * LiveAnalysesApi - object-oriented interface
+ * @export
+ * @class LiveAnalysesApi
+ * @extends {BaseAPI}
+ */
+export default class LiveAnalysesApi extends BaseAPI {
+    results: ResultsApi;
+    constructor(configuration: Configuration);
+    /**
+     * @summary Create Live Analysis
+     * @param {AiSceneAnalysisLiveCreateRequest} aiSceneAnalysisLiveCreateRequest Live Analysis configuration
+     * @throws {BitmovinError}
+     * @memberof LiveAnalysesApi
+     */
+    create(aiSceneAnalysisLiveCreateRequest?: AiSceneAnalysisLiveCreateRequest): Promise<AiSceneAnalysisLiveResponse>;
+    /**
+     * @summary Delete Live Analysis
+     * @param {string} analysisId ID of the Live Analysis
+     * @throws {BitmovinError}
+     * @memberof LiveAnalysesApi
+     */
+    delete(analysisId: string): Promise<BitmovinResponse>;
+    /**
+     * @summary Get Live Analysis details
+     * @param {string} analysisId ID of the Live Analysis
+     * @throws {BitmovinError}
+     * @memberof LiveAnalysesApi
+     */
+    get(analysisId: string): Promise<AiSceneAnalysisLiveResponse>;
+    /**
+     * @summary List Live Analyses
+     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
+     * @throws {BitmovinError}
+     * @memberof LiveAnalysesApi
+     */
+    list(queryParameters?: AiSceneAnalysisLiveResponseListQueryParams | ((q: AiSceneAnalysisLiveResponseListQueryParamsBuilder) => AiSceneAnalysisLiveResponseListQueryParamsBuilder)): Promise<PaginationResponse<AiSceneAnalysisLiveResponse>>;
+    /**
+     * @summary Start Live Analysis
+     * @param {string} analysisId ID of the Live Analysis
+     * @throws {BitmovinError}
+     * @memberof LiveAnalysesApi
+     */
+    start(analysisId: string): Promise<AiSceneAnalysisLiveResponse>;
+    /**
+     * @summary Stop Live Analysis
+     * @param {string} analysisId ID of the Live Analysis
+     * @throws {BitmovinError}
+     * @memberof LiveAnalysesApi
+     */
+    stop(analysisId: string): Promise<AiSceneAnalysisLiveResponse>;
+}

package/dist/aiSceneAnalysis/liveAnalyses/LiveAnalysesApi.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseAPI_1 = require("../../common/BaseAPI");
+const Mapper_1 = require("../../common/Mapper");
+const ResultsApi_1 = require("./results/ResultsApi");
+const AiSceneAnalysisLiveResponse_1 = require("../../models/AiSceneAnalysisLiveResponse");
+const BitmovinResponse_1 = require("../../models/BitmovinResponse");
+const PaginationResponse_1 = require("../../models/PaginationResponse");
+const AiSceneAnalysisLiveResponseListQueryParams_1 = require("./AiSceneAnalysisLiveResponseListQueryParams");
+/**
+ * LiveAnalysesApi - object-oriented interface
+ * @export
+ * @class LiveAnalysesApi
+ * @extends {BaseAPI}
+ */
+class LiveAnalysesApi extends BaseAPI_1.BaseAPI {
+    constructor(configuration) {
+        super(configuration);
+        this.results = new ResultsApi_1.default(configuration);
+    }
+    /**
+     * @summary Create Live Analysis
+     * @param {AiSceneAnalysisLiveCreateRequest} aiSceneAnalysisLiveCreateRequest Live Analysis configuration
+     * @throws {BitmovinError}
+     * @memberof LiveAnalysesApi
+     */
+    create(aiSceneAnalysisLiveCreateRequest) {
+        return this.restClient.post('/ai-scene-analysis/live-analyses', {}, aiSceneAnalysisLiveCreateRequest).then((response) => {
+            return (0, Mapper_1.map)(response, AiSceneAnalysisLiveResponse_1.default);
+        });
+    }
+    /**
+     * @summary Delete Live Analysis
+     * @param {string} analysisId ID of the Live Analysis
+     * @throws {BitmovinError}
+     * @memberof LiveAnalysesApi
+     */
+    delete(analysisId) {
+        const pathParamMap = {
+            analysis_id: analysisId
+        };
+        return this.restClient.delete('/ai-scene-analysis/live-analyses/{analysis_id}', pathParamMap).then((response) => {
+            return (0, Mapper_1.map)(response, BitmovinResponse_1.default);
+        });
+    }
+    /**
+     * @summary Get Live Analysis details
+     * @param {string} analysisId ID of the Live Analysis
+     * @throws {BitmovinError}
+     * @memberof LiveAnalysesApi
+     */
+    get(analysisId) {
+        const pathParamMap = {
+            analysis_id: analysisId
+        };
+        return this.restClient.get('/ai-scene-analysis/live-analyses/{analysis_id}', pathParamMap).then((response) => {
+            return (0, Mapper_1.map)(response, AiSceneAnalysisLiveResponse_1.default);
+        });
+    }
+    /**
+     * @summary List Live Analyses
+     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
+     * @throws {BitmovinError}
+     * @memberof LiveAnalysesApi
+     */
+    list(queryParameters) {
+        let queryParams = {};
+        if (typeof queryParameters === 'function') {
+            queryParams = queryParameters(new AiSceneAnalysisLiveResponseListQueryParams_1.AiSceneAnalysisLiveResponseListQueryParamsBuilder()).buildQueryParams();
+        }
+        else if (queryParameters) {
+            queryParams = queryParameters;
+        }
+        return this.restClient.get('/ai-scene-analysis/live-analyses', {}, queryParams).then((response) => {
+            return new PaginationResponse_1.default(response, AiSceneAnalysisLiveResponse_1.default);
+        });
+    }
+    /**
+     * @summary Start Live Analysis
+     * @param {string} analysisId ID of the Live Analysis
+     * @throws {BitmovinError}
+     * @memberof LiveAnalysesApi
+     */
+    start(analysisId) {
+        const pathParamMap = {
+            analysis_id: analysisId
+        };
+        return this.restClient.post('/ai-scene-analysis/live-analyses/{analysis_id}/start', pathParamMap).then((response) => {
+            return (0, Mapper_1.map)(response, AiSceneAnalysisLiveResponse_1.default);
+        });
+    }
+    /**
+     * @summary Stop Live Analysis
+     * @param {string} analysisId ID of the Live Analysis
+     * @throws {BitmovinError}
+     * @memberof LiveAnalysesApi
+     */
+    stop(analysisId) {
+        const pathParamMap = {
+            analysis_id: analysisId
+        };
+        return this.restClient.post('/ai-scene-analysis/live-analyses/{analysis_id}/stop', pathParamMap).then((response) => {
+            return (0, Mapper_1.map)(response, AiSceneAnalysisLiveResponse_1.default);
+        });
+    }
+}
+exports.default = LiveAnalysesApi;

package/dist/aiSceneAnalysis/liveAnalyses/results/ResultsApi.d.ts

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

package/dist/aiSceneAnalysis/liveAnalyses/results/ResultsApi.js

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

package/dist/aiSceneAnalysis/liveAnalyses/results/latest/LatestApi.d.ts

@@ -0,0 +1,19 @@
+import { BaseAPI } from '../../../../common/BaseAPI';
+import Configuration from '../../../../common/Configuration';
+import AiSceneAnalysisLiveResult from '../../../../models/AiSceneAnalysisLiveResult';
+/**
+ * LatestApi - object-oriented interface
+ * @export
+ * @class LatestApi
+ * @extends {BaseAPI}
+ */
+export default class LatestApi extends BaseAPI {
+    constructor(configuration: Configuration);
+    /**
+     * @summary Get Live Analysis Latest Result
+     * @param {string} analysisId ID of the Live Analysis
+     * @throws {BitmovinError}
+     * @memberof LatestApi
+     */
+    get(analysisId: string): Promise<AiSceneAnalysisLiveResult>;
+}

package/dist/aiSceneAnalysis/liveAnalyses/results/latest/LatestApi.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseAPI_1 = require("../../../../common/BaseAPI");
+const Mapper_1 = require("../../../../common/Mapper");
+const AiSceneAnalysisLiveResult_1 = require("../../../../models/AiSceneAnalysisLiveResult");
+/**
+ * LatestApi - object-oriented interface
+ * @export
+ * @class LatestApi
+ * @extends {BaseAPI}
+ */
+class LatestApi extends BaseAPI_1.BaseAPI {
+    constructor(configuration) {
+        super(configuration);
+    }
+    /**
+     * @summary Get Live Analysis Latest Result
+     * @param {string} analysisId ID of the Live Analysis
+     * @throws {BitmovinError}
+     * @memberof LatestApi
+     */
+    get(analysisId) {
+        const pathParamMap = {
+            analysis_id: analysisId
+        };
+        return this.restClient.get('/ai-scene-analysis/live-analyses/{analysis_id}/results/latest', pathParamMap).then((response) => {
+            return (0, Mapper_1.map)(response, AiSceneAnalysisLiveResult_1.default);
+        });
+    }
+}
+exports.default = LatestApi;