v1.18.0

src/index.ts

@@ -176,6 +176,13 @@ export {
     ResourceSource,
     ResourceStyleguideSource,
     Screen,
+    ScreenAnnotation,
+    ScreenAnnotationColor,
+    ScreenAnnotationCreateBody,
+    ScreenAnnotationNoteType,
+    ScreenAnnotationNoteTypeEnum,
+    ScreenAnnotationPosition,
+    ScreenAnnotationUpdateBody,
     ScreenNote,
     ScreenNoteColor,
     ScreenNoteColorNameEnum,

src/models/index.ts

@@ -162,6 +162,13 @@ export * from './resource-project-source';
 export * from './resource-source';
 export * from './resource-styleguide-source';
 export * from './screen';
+export * from './screen-annotation';
+export * from './screen-annotation-color';
+export * from './screen-annotation-create-body';
+export * from './screen-annotation-note-type';
+export * from './screen-annotation-note-type-enum';
+export * from './screen-annotation-position';
+export * from './screen-annotation-update-body';
 export * from './screen-note';
 export * from './screen-note-color';
 export * from './screen-note-color-name-enum';

src/models/screen-annotation-color.ts

@@ -0,0 +1,75 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+
+
+
+
+export const transformScreenAnnotationColorToJSON = function (value: ScreenAnnotationColor): any {
+    return {
+        name: value.name,
+        r: value.r,
+        g: value.g,
+        b: value.b,
+        a: value.a
+    }
+}
+
+export const transformJSONToScreenAnnotationColor = function (value: any): ScreenAnnotationColor {
+    return {
+        name: value.name,
+        r: value.r,
+        g: value.g,
+        b: value.b,
+        a: value.a
+    }
+}
+
+/**
+ * 
+ * @export
+ * @interface ScreenAnnotationColor
+ */
+export interface ScreenAnnotationColor {
+    /**
+     * Name of the color
+     * @type {string}
+     * @memberof ScreenAnnotationColor
+     */
+    name?: string;
+    /**
+     * Red component of the color
+     * @type {number}
+     * @memberof ScreenAnnotationColor
+     */
+    r: number;
+    /**
+     * Green component of the color
+     * @type {number}
+     * @memberof ScreenAnnotationColor
+     */
+    g: number;
+    /**
+     * Blue component of the color
+     * @type {number}
+     * @memberof ScreenAnnotationColor
+     */
+    b: number;
+    /**
+     * Alpha component of the color
+     * @type {number}
+     * @memberof ScreenAnnotationColor
+     */
+    a: number;
+}
+
+

src/models/screen-annotation-create-body.ts

@@ -0,0 +1,64 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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 {
+    ScreenAnnotationPosition,
+    transformScreenAnnotationPositionToJSON,
+    transformJSONToScreenAnnotationPosition
+} from './screen-annotation-position';
+
+
+export const transformScreenAnnotationCreateBodyToJSON = function (value: ScreenAnnotationCreateBody): any {
+    return {
+        content: value.content,
+        position: transformScreenAnnotationPositionToJSON(value.position),
+        type: value.type
+    }
+}
+
+export const transformJSONToScreenAnnotationCreateBody = function (value: any): ScreenAnnotationCreateBody {
+    return {
+        content: value.content,
+        position: transformJSONToScreenAnnotationPosition(value.position),
+        type: value.type
+    }
+}
+
+/**
+ * 
+ * @export
+ * @interface ScreenAnnotationCreateBody
+ */
+export interface ScreenAnnotationCreateBody {
+    /**
+     * Content of the annotation
+     * @type {string}
+     * @memberof ScreenAnnotationCreateBody
+     */
+    content: string;
+    /**
+     * 
+     * @type {ScreenAnnotationPosition}
+     * @memberof ScreenAnnotationCreateBody
+     */
+    position: ScreenAnnotationPosition;
+    /**
+     * The unique id of the annotation type
+     * @type {string}
+     * @memberof ScreenAnnotationCreateBody
+     */
+    type?: string;
+}
+
+

src/models/screen-annotation-note-type-enum.ts

@@ -0,0 +1,39 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+
+
+
+
+export const transformScreenAnnotationNoteTypeEnumToJSON = function (value: ScreenAnnotationNoteTypeEnum): any {
+    return value;
+}
+
+export const transformJSONToScreenAnnotationNoteTypeEnum = function (value: any): ScreenAnnotationNoteTypeEnum {
+    return value;
+}
+
+/**
+ * Type of the annotation note
+ * @export
+ * @enum {string}
+ */
+export enum ScreenAnnotationNoteTypeEnum {
+    BEHAVIOR = 'Behavior',
+    REQUIREMENT = 'Requirement',
+    ANIMATION = 'Animation',
+    ACCESSIBILITY = 'Accessibility',
+    API = 'API',
+    TRACKING = 'Tracking'
+}
+
+

src/models/screen-annotation-note-type.ts

@@ -0,0 +1,69 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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 {
+    ScreenAnnotationColor,
+    transformScreenAnnotationColorToJSON,
+    transformJSONToScreenAnnotationColor
+} from './screen-annotation-color';
+import {
+    ScreenAnnotationNoteTypeEnum,
+    transformScreenAnnotationNoteTypeEnumToJSON,
+    transformJSONToScreenAnnotationNoteTypeEnum
+} from './screen-annotation-note-type-enum';
+
+
+export const transformScreenAnnotationNoteTypeToJSON = function (value: ScreenAnnotationNoteType): any {
+    return {
+        id: value.id,
+        name: transformScreenAnnotationNoteTypeEnumToJSON(value.name),
+        color: transformScreenAnnotationColorToJSON(value.color)
+    }
+}
+
+export const transformJSONToScreenAnnotationNoteType = function (value: any): ScreenAnnotationNoteType {
+    return {
+        id: value.id,
+        name: transformJSONToScreenAnnotationNoteTypeEnum(value.name),
+        color: transformJSONToScreenAnnotationColor(value.color)
+    }
+}
+
+/**
+ * 
+ * @export
+ * @interface ScreenAnnotationNoteType
+ */
+export interface ScreenAnnotationNoteType {
+    /**
+     * The unique id of the annotation
+     * @type {string}
+     * @memberof ScreenAnnotationNoteType
+     */
+    id: string;
+    /**
+     * 
+     * @type {ScreenAnnotationNoteTypeEnum}
+     * @memberof ScreenAnnotationNoteType
+     */
+    name: ScreenAnnotationNoteTypeEnum;
+    /**
+     * 
+     * @type {ScreenAnnotationColor}
+     * @memberof ScreenAnnotationNoteType
+     */
+    color: ScreenAnnotationColor;
+}
+
+

src/models/screen-annotation-position.ts

@@ -0,0 +1,51 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+
+
+
+
+export const transformScreenAnnotationPositionToJSON = function (value: ScreenAnnotationPosition): any {
+    return {
+        x: value.x,
+        y: value.y
+    }
+}
+
+export const transformJSONToScreenAnnotationPosition = function (value: any): ScreenAnnotationPosition {
+    return {
+        x: value.x,
+        y: value.y
+    }
+}
+
+/**
+ * Position of the annotation with respect to top left corner. Values are normalized in [0, 1]
+ * @export
+ * @interface ScreenAnnotationPosition
+ */
+export interface ScreenAnnotationPosition {
+    /**
+     * 
+     * @type {number}
+     * @memberof ScreenAnnotationPosition
+     */
+    x: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ScreenAnnotationPosition
+     */
+    y: number;
+}
+
+

src/models/screen-annotation-update-body.ts

@@ -0,0 +1,64 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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 {
+    ScreenAnnotationPosition,
+    transformScreenAnnotationPositionToJSON,
+    transformJSONToScreenAnnotationPosition
+} from './screen-annotation-position';
+
+
+export const transformScreenAnnotationUpdateBodyToJSON = function (value: ScreenAnnotationUpdateBody): any {
+    return {
+        content: value.content,
+        position: value.position && transformScreenAnnotationPositionToJSON(value.position),
+        type: value.type
+    }
+}
+
+export const transformJSONToScreenAnnotationUpdateBody = function (value: any): ScreenAnnotationUpdateBody {
+    return {
+        content: value.content,
+        position: value.position && transformJSONToScreenAnnotationPosition(value.position),
+        type: value.type
+    }
+}
+
+/**
+ * 
+ * @export
+ * @interface ScreenAnnotationUpdateBody
+ */
+export interface ScreenAnnotationUpdateBody {
+    /**
+     * Content of the annotation
+     * @type {string}
+     * @memberof ScreenAnnotationUpdateBody
+     */
+    content?: string;
+    /**
+     * 
+     * @type {ScreenAnnotationPosition}
+     * @memberof ScreenAnnotationUpdateBody
+     */
+    position?: ScreenAnnotationPosition;
+    /**
+     * The unique id of the annotation type
+     * @type {string}
+     * @memberof ScreenAnnotationUpdateBody
+     */
+    type?: string;
+}
+
+