@zeplin/sdk/dist/models/styleguide.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 { OrganizationSummary } from './organization-summary';
import { RemPreferences } from './rem-preferences';
import { StyleguideStatusEnum } from './styleguide-status-enum';
export declare const transformStyleguideToJSON: (value: Styleguide) => any;
export declare const transformJSONToStyleguide: (value: any) => Styleguide;
/**
 *
 * @export
 * @interface Styleguide
 */
export interface Styleguide {
    /**
     * The unique id of the styleguide
     * @type {string}
     * @memberof Styleguide
     */
    id: string;
    /**
     * The name of the styleguide
     * @type {string}
     * @memberof Styleguide
     */
    name: string;
    /**
     * The description of the styleguide (It can contain markdown https://zpl.io/article/markdown-support)
     * @type {string}
     * @memberof Styleguide
     */
    description?: string;
    /**
     * The target platform of the styleguide
     * @type {string}
     * @memberof Styleguide
     */
    platform: 'base' | 'web' | 'ios' | 'android' | 'macos';
    /**
     * URL of the styleguide\'s thumbnail image
     * @type {string}
     * @memberof Styleguide
     */
    thumbnail?: string;
    /**
     *
     * @type {StyleguideStatusEnum}
     * @memberof Styleguide
     */
    status: StyleguideStatusEnum;
    /**
     *
     * @type {OrganizationSummary}
     * @memberof Styleguide
     */
    organization?: OrganizationSummary;
    /**
     *
     * @type {RemPreferences}
     * @memberof Styleguide
     */
    remPreferences?: RemPreferences;
    /**
     * The unix timestamp when the styleguide was created
     * @type {number}
     * @memberof Styleguide
     */
    created: number;
    /**
     * The unix timestamp when the styleguide was updated
     * @type {number}
     * @memberof Styleguide
     */
    updated?: number;
    /**
     * The number of members of the styleguide
     * @type {number}
     * @memberof Styleguide
     */
    numberOfMembers: number;
    /**
     * The number of connected components in the styleguide
     * @type {number}
     * @memberof Styleguide
     */
    numberOfConnectedComponents: number;
    /**
     * The number of components exported to the styleguide
     * @type {number}
     * @memberof Styleguide
     */
    numberOfComponents: number;
    /**
     * The number of text styles added to the styleguide
     * @type {number}
     * @memberof Styleguide
     */
    numberOfTextStyles: number;
    /**
     * The number of colors added to the styleguide
     * @type {number}
     * @memberof Styleguide
     */
    numberOfColors: number;
    /**
     * The number of spacing tokens added to the styleguide
     * @type {number}
     * @memberof Styleguide
     */
    numberOfSpacingTokens: number;
    /**
     *
     * @type {EntityReference}
     * @memberof Styleguide
     */
    parent?: EntityReference;
}