// ----------------------------------------------------------------------------- // Enum Typedefs // ----------------------------------------------------------------------------- /** * Gilt.com is divided into stores. Currently there are four stores exposed by the API: Women, Men, Baby & Kids and Home. * @typedef {"women" | "men" | "kids" | "home"} Store */ // ----------------------------------------------------------------------------- // Model Typedefs // ----------------------------------------------------------------------------- /** * @typedef {Object} Product * @property {string} name Product name * @property {string} product URL to product object * @property {number} id Unique identifier for product * @property {string} brand Brand name * @property {string} url Link to product detail page where item can be purchased * @property {ProductContent} content * @property {string[]} categories A list of categories to which this product belongs. * @property {Object} image_urls A map of key/value pairs with the key being the image resolution WIDTHxHEIGHT and the value being an array of image objects. * @property {Sku[]} skus List of Skus */ /** * @typedef {Object} ProductCategories * @property {string[]} categories A list of categories to which this product belongs. */ /** * @typedef {Object} ProductContent * @property {string} [description] Product description. * @property {string} [fit_notes] Sizing information. * @property {string} [material] Materials list. * @property {string} [care_instructions] Additional care information. * @property {string} [origin] Place of manufacture. */ /** * @typedef {Object} SaleDetail * @property {string} name Sale name * @property {string} sale URL to single sale object * @property {string} sale_key unique identifier for sale * @property {Store} store Store key * @property {string} [description] A description of the sale's theme or brand * @property {string} sale_url Permalink to sale website * @property {string} begins ISO8601-formatted time for beginning of sale * @property {string} [ends] ISO-8601-formatted time for end of sale * @property {Object} image_urls A map of key/value pairs with the key being the image resolution WIDTHxHEIGHT and the value being an array of image objects. * @property {string[]} [products] List of URLs to individual product objects (not available if sale is upcoming or sold out) */ /** * @typedef {Object} SaleList * @property {SaleDetail[]} sales List of sales. */ /** * @typedef {Object} Sku * @property {number} id The SKU unique identifier * @property {string} inventory_status Describes product availability. One of: sold out, for sale or reserved. * @property {number} msrp_price MSRP price of SKU in US Dollars. * @property {number} sale_price Sale price of SKU in US Dollars. * @property {number} [shipping_surcharge] If absent, standard Gilt.com shipping policy and any resulting charges apply. If present, standard shipping charge is overridden by amount listed here in US Dollars. * @property {Object[]} attributes SKU attributes like color and size. */ // ----------------------------------------------------------------------------- // Union Typedefs // -----------------------------------------------------------------------------