@zeplin/sdk/dist/models/screen-note.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 { ScreenNoteColor } from './screen-note-color';
import { ScreenNoteComment } from './screen-note-comment';
import { ScreenNotePosition } from './screen-note-position';
import { ScreenNoteStatusEnum } from './screen-note-status-enum';
import { User } from './user';
export declare const transformScreenNoteToJSON: (value: ScreenNote) => any;
export declare const transformJSONToScreenNote: (value: any) => ScreenNote;
/**
 * Screen notes are comments added to a screen and can be either point notes, which have a single point in the position field, or area notes, which have a position field containing both a start and end point to define a rectangular region.
 * @export
 * @interface ScreenNote
 */
export interface ScreenNote {
    /**
     * The unique id of the note
     * @type {string}
     * @memberof ScreenNote
     */
    id: string;
    /**
     *
     * @type {User}
     * @memberof ScreenNote
     */
    creator: User;
    /**
     * Order of the note in the screen (e.g., 1, 2, 3, so on)
     * @type {number}
     * @memberof ScreenNote
     */
    order: number;
    /**
     *
     * @type {ScreenNoteStatusEnum}
     * @memberof ScreenNote
     */
    status: ScreenNoteStatusEnum;
    /**
     *
     * @type {ScreenNotePosition}
     * @memberof ScreenNote
     */
    position: ScreenNotePosition;
    /**
     *
     * @type {ScreenNoteColor}
     * @memberof ScreenNote
     */
    color: ScreenNoteColor;
    /**
     *
     * @type {Array<ScreenNoteComment>}
     * @memberof ScreenNote
     */
    comments: Array<ScreenNoteComment>;
    /**
     * The unix timestamp when the note was created
     * @type {number}
     * @memberof ScreenNote
     */
    created: number;
}