@bitmovin/api-sdk 1.274.0 → 1.275.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.274.0
+npm install @bitmovin/api-sdk@1.275.0
 ```
 
 ## Initialization

package/dist/aiSceneAnalysis/analyses/AnalysesApi.d.ts

@@ -1,6 +1,9 @@
 import { BaseAPI } from '../../common/BaseAPI';
 import Configuration from '../../common/Configuration';
 import ByEncodingIdApi from './byEncodingId/ByEncodingIdApi';
+import SceneAnalysisListItem from '../../models/SceneAnalysisListItem';
+import PaginationResponse from '../../models/PaginationResponse';
+import { SceneAnalysisListItemListQueryParams, SceneAnalysisListItemListQueryParamsBuilder } from './SceneAnalysisListItemListQueryParams';
 /**
  * AnalysesApi - object-oriented interface
  * @export
@@ -10,4 +13,11 @@ import ByEncodingIdApi from './byEncodingId/ByEncodingIdApi';
 export default class AnalysesApi extends BaseAPI {
     byEncodingId: ByEncodingIdApi;
     constructor(configuration: Configuration);
+    /**
+     * @summary List AI scene analyses
+     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
+     * @throws {BitmovinError}
+     * @memberof AnalysesApi
+     */
+    list(queryParameters?: SceneAnalysisListItemListQueryParams | ((q: SceneAnalysisListItemListQueryParamsBuilder) => SceneAnalysisListItemListQueryParamsBuilder)): Promise<PaginationResponse<SceneAnalysisListItem>>;
 }

package/dist/aiSceneAnalysis/analyses/AnalysesApi.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const BaseAPI_1 = require("../../common/BaseAPI");
 const ByEncodingIdApi_1 = require("./byEncodingId/ByEncodingIdApi");
+const SceneAnalysisListItem_1 = require("../../models/SceneAnalysisListItem");
+const PaginationResponse_1 = require("../../models/PaginationResponse");
+const SceneAnalysisListItemListQueryParams_1 = require("./SceneAnalysisListItemListQueryParams");
 /**
  * AnalysesApi - object-oriented interface
  * @export
@@ -13,5 +16,23 @@ class AnalysesApi extends BaseAPI_1.BaseAPI {
         super(configuration);
         this.byEncodingId = new ByEncodingIdApi_1.default(configuration);
     }
+    /**
+     * @summary List AI scene analyses
+     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
+     * @throws {BitmovinError}
+     * @memberof AnalysesApi
+     */
+    list(queryParameters) {
+        let queryParams = {};
+        if (typeof queryParameters === 'function') {
+            queryParams = queryParameters(new SceneAnalysisListItemListQueryParams_1.SceneAnalysisListItemListQueryParamsBuilder()).buildQueryParams();
+        }
+        else if (queryParameters) {
+            queryParams = queryParameters;
+        }
+        return this.restClient.get('/ai-scene-analysis/analyses', {}, queryParams).then((response) => {
+            return new PaginationResponse_1.default(response, SceneAnalysisListItem_1.default);
+        });
+    }
 }
 exports.default = AnalysesApi;

package/dist/aiSceneAnalysis/analyses/SceneAnalysisListItemListQueryParams.d.ts

@@ -0,0 +1,62 @@
+import SceneAnalysisListSort from '../../models/SceneAnalysisListSort';
+export interface SceneAnalysisListItemListQueryParams {
+    /**
+     * Index of the first item to return, starting at 0. Default is 0
+     * @type {number}
+     * @memberof SceneAnalysisListItemListQueryParams
+     */
+    offset?: number | undefined;
+    /**
+     * Maximum number of items to return. Default is 15, maximum is 100
+     * @type {number}
+     * @memberof SceneAnalysisListItemListQueryParams
+     */
+    limit?: number | undefined;
+    /**
+     * Order the result by creation date. Default is createdAt:DESC
+     * @type {SceneAnalysisListSort}
+     * @memberof SceneAnalysisListItemListQueryParams
+     */
+    sort?: SceneAnalysisListSort | undefined;
+    /**
+     * Inclusive lower creation-date bound in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
+     * @type {Date}
+     * @memberof SceneAnalysisListItemListQueryParams
+     */
+    createdAtFrom?: Date | undefined;
+    /**
+     * Inclusive upper creation-date bound in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
+     * @type {Date}
+     * @memberof SceneAnalysisListItemListQueryParams
+     */
+    createdAtTo?: Date | undefined;
+}
+export declare class SceneAnalysisListItemListQueryParamsBuilder {
+    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 15, maximum is 100
+     */
+    limit(limit: number): this;
+    /**
+     *
+     * @param sort Order the result by creation date. Default is createdAt:DESC
+     */
+    sort(sort: SceneAnalysisListSort): this;
+    /**
+     *
+     * @param createdAtFrom Inclusive lower creation-date bound in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
+     */
+    createdAtFrom(createdAtFrom: Date): this;
+    /**
+     *
+     * @param createdAtTo Inclusive upper creation-date bound in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
+     */
+    createdAtTo(createdAtTo: Date): this;
+    buildQueryParams(): SceneAnalysisListItemListQueryParams;
+}

package/dist/aiSceneAnalysis/analyses/SceneAnalysisListItemListQueryParams.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SceneAnalysisListItemListQueryParamsBuilder = void 0;
+class SceneAnalysisListItemListQueryParamsBuilder {
+    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 15, maximum is 100
+     */
+    limit(limit) {
+        this.internalParams.limit = limit;
+        return this;
+    }
+    /**
+     *
+     * @param sort Order the result by creation date. Default is createdAt:DESC
+     */
+    sort(sort) {
+        this.internalParams.sort = sort;
+        return this;
+    }
+    /**
+     *
+     * @param createdAtFrom Inclusive lower creation-date bound in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
+     */
+    createdAtFrom(createdAtFrom) {
+        this.internalParams.createdAtFrom = createdAtFrom;
+        return this;
+    }
+    /**
+     *
+     * @param createdAtTo Inclusive upper creation-date bound in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
+     */
+    createdAtTo(createdAtTo) {
+        this.internalParams.createdAtTo = createdAtTo;
+        return this;
+    }
+    buildQueryParams() {
+        return this.internalParams;
+    }
+}
+exports.SceneAnalysisListItemListQueryParamsBuilder = SceneAnalysisListItemListQueryParamsBuilder;