@zeplin/sdk/dist/models/screen.d.ts

Zeplin API client for JavaScript

/**
 * Zeplin API
 * Access your resources in Zeplin
 *
 * Contact: support@zeplin.io
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { EntityReference } from './entity-reference';
import { ScreenVariant } from './screen-variant';
import { SnapshotImage } from './snapshot-image';
export declare const transformScreenToJSON: (value: Screen) => any;
export declare const transformJSONToScreen: (value: any) => Screen;
/**
 *
 * @export
 * @interface Screen
 */
export interface Screen {
    /**
     * The unique id of the screen
     * @type {string}
     * @memberof Screen
     */
    id: string;
    /**
     * The name of the screen
     * @type {string}
     * @memberof Screen
     */
    name: string;
    /**
     * The description of the screen
     * @type {string}
     * @memberof Screen
     */
    description?: string;
    /**
     * The tags platform of the screen
     * @type {Array<string>}
     * @memberof Screen
     */
    tags: Array<string>;
    /**
     *
     * @type {SnapshotImage}
     * @memberof Screen
     */
    image: SnapshotImage;
    /**
     * The unix timestamp when the screen was created
     * @type {number}
     * @memberof Screen
     */
    created: number;
    /**
     * The unix timestamp when the screen was updated
     * @type {number}
     * @memberof Screen
     */
    updated?: number;
    /**
     * The number of versions exported to the screen
     * @type {number}
     * @memberof Screen
     */
    numberOfVersions: number;
    /**
     * The number of notes in the screen
     * @type {number}
     * @memberof Screen
     */
    numberOfNotes: number;
    /**
     * The number of annotations in the screen
     * @type {number}
     * @memberof Screen
     */
    numberOfAnnotations: number;
    /**
     *
     * @type {EntityReference}
     * @memberof Screen
     */
    section?: EntityReference;
    /**
     *
     * @type {ScreenVariant}
     * @memberof Screen
     */
    variant?: ScreenVariant;
}