@bitmovin/api-sdk/dist/aiSceneAnalysis/analyses/SceneAnalysisListItemListQueryParams.d.ts

Bitmovin JS/TS API SDK

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;
}