{
    "project": {
        "name": "ice-ismds-plugin",
        "description": "<description>",
        "version": "1.7.0",
        "url": "https://contegixapp1.livenation.com/confluence/display/ISM/ISM+Viewers",
        "logo": ""
    },
    "files": {
        "src/js/data/PlaceAvailabilityData.js": {
            "name": "src/js/data/PlaceAvailabilityData.js",
            "modules": {},
            "classes": {},
            "fors": {},
            "namespaces": {}
        },
        "src/js/data/urlBuilder.js": {
            "name": "src/js/data/urlBuilder.js",
            "modules": {},
            "classes": {},
            "fors": {},
            "namespaces": {}
        },
        "src/js/templates/templateSettings.js": {
            "name": "src/js/templates/templateSettings.js",
            "modules": {
                "Availability": 1
            },
            "classes": {},
            "fors": {},
            "namespaces": {}
        },
        "src/js/util/bluebird.js": {
            "name": "src/js/util/bluebird.js",
            "modules": {},
            "classes": {},
            "fors": {},
            "namespaces": {}
        },
        "src/js/util/validation.js": {
            "name": "src/js/util/validation.js",
            "modules": {},
            "classes": {},
            "fors": {},
            "namespaces": {}
        },
        "src/js/AdditionalDocumentation.js": {
            "name": "src/js/AdditionalDocumentation.js",
            "modules": {
                "EmittedEvents": 1,
                "Availability URL": 1
            },
            "classes": {
                "EmittedEvents": 1,
                "Availability URL": 1,
                "DefaultTemplates": 1
            },
            "fors": {},
            "namespaces": {}
        },
        "src/js/ice.ismds.plugin.js": {
            "name": "src/js/ice.ismds.plugin.js",
            "modules": {
                "Availability Plugin": 1
            },
            "classes": {
                "AvailabilityPlugin": 1
            },
            "fors": {},
            "namespaces": {}
        },
        "src/js/main.js": {
            "name": "src/js/main.js",
            "modules": {},
            "classes": {},
            "fors": {},
            "namespaces": {}
        },
        "src/js/registerCoreEndpoints.js": {
            "name": "src/js/registerCoreEndpoints.js",
            "modules": {},
            "classes": {
                "CoreEndpoints": 1
            },
            "fors": {},
            "namespaces": {}
        }
    },
    "modules": {
        "Availability": {
            "name": "Availability",
            "submodules": {},
            "classes": {},
            "fors": {},
            "namespaces": {},
            "tag": "module",
            "file": "src/js/templates/templateSettings.js",
            "line": 4,
            "description": "Template Settings"
        },
        "EmittedEvents": {
            "name": "EmittedEvents",
            "submodules": {},
            "classes": {},
            "fors": {},
            "namespaces": {},
            "tag": "module",
            "file": "src/js/AdditionalDocumentation.js",
            "line": 1,
            "description": "A list of all events emitted by the availability plugin"
        },
        "Availability URL": {
            "name": "Availability URL",
            "submodules": {},
            "classes": {
                "EmittedEvents": 1,
                "Availability URL": 1,
                "DefaultTemplates": 1
            },
            "fors": {},
            "namespaces": {},
            "tag": "module",
            "file": "src/js/AdditionalDocumentation.js",
            "line": 37,
            "description": "Explanation of the availability url. This use the service URL to go to proxy server that returns the availability data"
        },
        "Availability Plugin": {
            "name": "Availability Plugin",
            "submodules": {},
            "classes": {
                "AvailabilityPlugin": 1,
                "CoreEndpoints": 1
            },
            "fors": {},
            "namespaces": {},
            "tag": "module",
            "file": "src/js/registerCoreEndpoints.js",
            "line": 7
        }
    },
    "classes": {
        "EmittedEvents": {
            "name": "EmittedEvents",
            "shortname": "EmittedEvents",
            "classitems": [],
            "plugins": [],
            "extensions": [],
            "plugin_for": [],
            "extension_for": [],
            "module": "Availability URL",
            "namespace": "",
            "file": "src/js/AdditionalDocumentation.js",
            "line": 1,
            "description": "A list of all events emitted by the availability plugin"
        },
        "Availability URL": {
            "name": "Availability URL",
            "shortname": "Availability URL",
            "classitems": [],
            "plugins": [],
            "extensions": [],
            "plugin_for": [],
            "extension_for": [],
            "module": "Availability URL",
            "namespace": "",
            "file": "src/js/AdditionalDocumentation.js",
            "line": 20,
            "description": "Explanation of the availability url. This use the service URL to go to proxy server that returns the availability data"
        },
        "DefaultTemplates": {
            "name": "DefaultTemplates",
            "shortname": "DefaultTemplates",
            "classitems": [],
            "plugins": [],
            "extensions": [],
            "plugin_for": [],
            "extension_for": [],
            "module": "Availability URL",
            "namespace": "",
            "file": "src/js/AdditionalDocumentation.js",
            "line": 37,
            "description": "A list of all default templates. For summary template, the name of the templates will be 'shape-availability-' and the range name. A range name for 0 will look like 0%-0%"
        },
        "AvailabilityPlugin": {
            "name": "AvailabilityPlugin",
            "shortname": "AvailabilityPlugin",
            "classitems": [],
            "plugins": [],
            "extensions": [],
            "plugin_for": [],
            "extension_for": [],
            "module": "Availability Plugin",
            "namespace": "",
            "file": "src/js/ice.ismds.plugin.js",
            "line": 114,
            "params": [
                {
                    "name": "core",
                    "description": "A reference to core object",
                    "type": "Core"
                },
                {
                    "name": "options",
                    "description": "A list of options to set",
                    "type": "Object",
                    "props": [
                        {
                            "name": "service",
                            "description": "the url to the ismds server that will return availability data",
                            "type": "String|URL"
                        },
                        {
                            "name": "apiKey",
                            "description": "the API key is needed for authentication by the ISMDS service",
                            "type": "String"
                        },
                        {
                            "name": "apiSecret",
                            "description": "the API secret is also needed for authentication by the ISMDS service",
                            "type": "String"
                        },
                        {
                            "name": "placeUpdateInterval",
                            "description": "the amount of milliseconds that have to pass before the place availability will update",
                            "type": "Integer",
                            "optional": true,
                            "optdefault": "30000"
                        },
                        {
                            "name": "summaryUpdateInterval",
                            "description": "the amount of milliseconds that have to pass before the summary will update",
                            "type": "Integer",
                            "optional": true,
                            "optdefault": "75000"
                        },
                        {
                            "name": "platinumEnabled",
                            "description": "Indicates if platinum data is to be fetched",
                            "type": "Boolean",
                            "optional": true
                        },
                        {
                            "name": "resaleEnabled",
                            "description": "Indicates if resale data is to be fetched",
                            "type": "Boolean",
                            "optional": true
                        },
                        {
                            "name": "ranges",
                            "description": "An array of objects with the keys range, and color",
                            "type": "Array",
                            "optional": true
                        }
                    ]
                }
            ],
            "is_constructor": 1,
            "example": [
                "\n    var ismdsOptions= {\n\t\t\tservice: 'https://services.ticketmaster.com/api/ismds',\n\t\t\tapiKey: 'aj6sxy6vhtv7bujsnvgejsblcifgfd',\n\t\t\tapiSecret:'sc2ruf344746p4symm3lunsbbqfs',\n\t\t\tsummaryUpdateInterval: 10000,\n\t\t\tplaceUpdateInterval: 5000,\n\t\t\tplatinumEnabled: true;\n\t\t\tresaleEnabled: true,\n\t\t    ranges:[{range: '0',color: '999999'}, {range: '0.25', color: '000000'},   {range: '0.25', color: '91c9ea'}, {range: '0.75', color: '1099de'},  {range: '1', color: '004878'}]\n\t\t};\n     ICE.ISMDSPlugin.create(ice, ismdsOptions);"
            ]
        },
        "CoreEndpoints": {
            "name": "CoreEndpoints",
            "shortname": "CoreEndpoints",
            "classitems": [],
            "plugins": [],
            "extensions": [],
            "plugin_for": [],
            "extension_for": [],
            "module": "Availability Plugin",
            "namespace": "",
            "file": "src/js/registerCoreEndpoints.js",
            "line": 7,
            "description": "Important methods that can be called through the core using the function execute",
            "example": [
                "\n ice.execute(name-of-function, args....);"
            ]
        }
    },
    "classitems": [
        {
            "file": "src/js/data/PlaceAvailabilityData.js",
            "line": 1,
            "description": "Created by Chantell.Nichols on 10/8/2015.",
            "class": "EmittedEvents"
        },
        {
            "file": "src/js/data/urlBuilder.js",
            "line": 1,
            "description": "Created by Chantell.Nichols on 10/5/2015.",
            "class": "EmittedEvents"
        },
        {
            "file": "src/js/templates/templateSettings.js",
            "line": 1,
            "description": "Created by chantell.nichols on 9/8/2015.",
            "class": "EmittedEvents"
        },
        {
            "file": "src/js/templates/templateSettings.js",
            "line": 13,
            "description": "the default interior color for segments with HIGH availability",
            "type": "String|Hex",
            "final": 1,
            "class": "EmittedEvents",
            "module": "Availability"
        },
        {
            "file": "src/js/templates/templateSettings.js",
            "line": 19,
            "description": "the low end of the range of seat availability needed to be considered NONE",
            "type": "Number",
            "final": 1,
            "class": "EmittedEvents",
            "module": "Availability"
        },
        {
            "file": "src/js/templates/templateSettings.js",
            "line": 25,
            "description": "the high end of the range of seat availability needed to be considered NONE",
            "type": "Number",
            "final": 1,
            "class": "EmittedEvents",
            "module": "Availability"
        },
        {
            "file": "src/js/templates/templateSettings.js",
            "line": 33,
            "description": "the default interior color for segments with MEDIUM availability",
            "type": "String|Hex",
            "final": 1,
            "class": "EmittedEvents",
            "module": "Availability"
        },
        {
            "file": "src/js/templates/templateSettings.js",
            "line": 39,
            "description": "the low end of the range of seat availability needed to be considered NONE",
            "type": "Number",
            "final": 1,
            "class": "EmittedEvents",
            "module": "Availability"
        },
        {
            "file": "src/js/templates/templateSettings.js",
            "line": 45,
            "description": "the high end of the range of seat availability needed to be considered NONE",
            "type": "Number",
            "final": 1,
            "class": "EmittedEvents",
            "module": "Availability"
        },
        {
            "file": "src/js/templates/templateSettings.js",
            "line": 53,
            "description": "the default interior color for segments with LOW availability",
            "type": "String|Hex",
            "final": 1,
            "class": "EmittedEvents",
            "module": "Availability"
        },
        {
            "file": "src/js/templates/templateSettings.js",
            "line": 59,
            "description": "the low end of the range of seat availability needed to be considered NONE",
            "type": "Number",
            "final": 1,
            "class": "EmittedEvents",
            "module": "Availability"
        },
        {
            "file": "src/js/templates/templateSettings.js",
            "line": 65,
            "description": "the high end of the range of seat availability needed to be considered NONE",
            "type": "Number",
            "final": 1,
            "class": "EmittedEvents",
            "module": "Availability"
        },
        {
            "file": "src/js/templates/templateSettings.js",
            "line": 73,
            "description": "the default interior color for segments with NONE availability",
            "type": "String|Hex",
            "final": 1,
            "class": "EmittedEvents",
            "module": "Availability"
        },
        {
            "file": "src/js/templates/templateSettings.js",
            "line": 79,
            "description": "the low end of the range of seat availability needed to be considered NONE",
            "type": "Number",
            "final": 1,
            "class": "EmittedEvents",
            "module": "Availability"
        },
        {
            "file": "src/js/templates/templateSettings.js",
            "line": 85,
            "description": "the high end of the range of seat availability needed to be considered NONE",
            "type": "Number",
            "final": 1,
            "class": "EmittedEvents",
            "module": "Availability"
        },
        {
            "file": "src/js/templates/templateSettings.js",
            "line": 95,
            "description": "the default interior color for places with OPEN status",
            "type": "String|Hex",
            "final": 1,
            "class": "EmittedEvents",
            "module": "Availability"
        },
        {
            "file": "src/js/templates/templateSettings.js",
            "line": 103,
            "description": "the default interior color for places with SOLD status",
            "type": "String|Hex",
            "final": 1,
            "class": "EmittedEvents",
            "module": "Availability"
        },
        {
            "file": "src/js/util/bluebird.js",
            "line": 1,
            "description": "src/util/bluebird",
            "class": "EmittedEvents",
            "module": "Availability"
        },
        {
            "file": "src/js/util/validation.js",
            "line": 1,
            "description": "Created by Chantell.Nichols on 10/6/2015.",
            "class": "EmittedEvents",
            "module": "Availability"
        },
        {
            "file": "src/js/AdditionalDocumentation.js",
            "line": 6,
            "description": "Emitted after availability has been updated for at least one segment",
            "access": "private",
            "tagname": "",
            "itemtype": "event",
            "name": "summary-availability-update",
            "params": [
                {
                    "name": "changedSegments",
                    "description": "a list of segments with updated availability",
                    "type": "Array"
                }
            ],
            "class": "EmittedEvents",
            "module": "EmittedEvents"
        },
        {
            "file": "src/js/AdditionalDocumentation.js",
            "line": 12,
            "description": "Emitted after availability has been updated for at least one place",
            "access": "private",
            "tagname": "",
            "itemtype": "event",
            "name": "place-availability-update",
            "params": [
                {
                    "name": "changedPlaces",
                    "description": "a list of places with updated availability",
                    "type": "Array"
                }
            ],
            "class": "EmittedEvents",
            "module": "EmittedEvents"
        },
        {
            "file": "src/js/AdditionalDocumentation.js",
            "line": 25,
            "description": "Availability URL for summary calls",
            "itemtype": "event",
            "name": "/availability?eventId=[eventId]&summary=true",
            "params": [
                {
                    "name": "eventID",
                    "description": "the event id given the ICE Core in the create function",
                    "type": "String"
                }
            ],
            "class": "Availability URL",
            "module": "Availability URL"
        },
        {
            "file": "src/js/AdditionalDocumentation.js",
            "line": 30,
            "description": "Availability URL for place availability calls",
            "itemtype": "event",
            "name": "/availability?eventId=[eventId]&segments=[segmentId]",
            "params": [
                {
                    "name": "eventID",
                    "description": "the event id given the ICE Core in the create function",
                    "type": "String"
                },
                {
                    "name": "segmentId",
                    "description": "the segment id we are requesting availability for",
                    "type": "String"
                }
            ],
            "class": "Availability URL",
            "module": "Availability URL"
        },
        {
            "file": "src/js/AdditionalDocumentation.js",
            "line": 42,
            "description": "Default template for places with OPEN status",
            "itemtype": "event",
            "name": "default-place-status-OPEN",
            "params": [
                {
                    "name": "interiorColor",
                    "description": "color of the place. Default to '004878'",
                    "type": "String"
                }
            ],
            "example": [
                "\n    var defaultTemplate = ice.templates.find('default-place-status-OPEN');\n    var interiorColor = defaultTemplate.interiorColor;"
            ],
            "class": "DefaultTemplates",
            "module": "Availability URL"
        },
        {
            "file": "src/js/AdditionalDocumentation.js",
            "line": 50,
            "description": "Default template for places with SOLD status",
            "itemtype": "event",
            "name": "default-place-status-SOLD",
            "params": [
                {
                    "name": "interiorColor",
                    "description": "color of the place. Default to '999999'",
                    "type": "String"
                }
            ],
            "example": [
                "\n    var defaultTemplate = ice.templates.find('default-place-status-SOLD');\n    var interiorColor = defaultTemplate.interiorColor;"
            ],
            "class": "DefaultTemplates",
            "module": "Availability URL"
        },
        {
            "file": "src/js/ice.ismds.plugin.js",
            "line": 1,
            "description": "src/js/ice.availability.plugin.js",
            "class": "AvailabilityPlugin",
            "module": "Availability URL"
        },
        {
            "file": "src/js/ice.ismds.plugin.js",
            "line": 143,
            "description": "Instance of core",
            "itemtype": "property",
            "name": "core",
            "type": "{CORE}",
            "class": "AvailabilityPlugin",
            "module": "Availability Plugin"
        },
        {
            "file": "src/js/ice.ismds.plugin.js",
            "line": 150,
            "description": "Sets the link to the availability server",
            "itemtype": "property",
            "name": "service",
            "type": "{String}",
            "class": "AvailabilityPlugin",
            "module": "Availability Plugin"
        },
        {
            "file": "src/js/ice.ismds.plugin.js",
            "line": 157,
            "description": "Indicates whether or not we get platinum data",
            "itemtype": "property",
            "name": "platinumEnabled",
            "type": "{Boolean}",
            "class": "AvailabilityPlugin",
            "module": "Availability Plugin"
        },
        {
            "file": "src/js/ice.ismds.plugin.js",
            "line": 164,
            "description": "Indicates whether or not we get resale data",
            "itemtype": "property",
            "name": "resaleEnabled",
            "type": "{Boolean}",
            "class": "AvailabilityPlugin",
            "module": "Availability Plugin"
        },
        {
            "file": "src/js/ice.ismds.plugin.js",
            "line": 172,
            "description": "Sets the delay for fetching availability data for segments",
            "itemtype": "property",
            "name": "summaryUpdateInterval",
            "default": "75000",
            "type": "{Integer} Milliseconds",
            "class": "AvailabilityPlugin",
            "module": "Availability Plugin"
        },
        {
            "file": "src/js/ice.ismds.plugin.js",
            "line": 180,
            "description": "Sets the delay for fetching availability data for places",
            "itemtype": "property",
            "name": "placeUpdateInterval",
            "default": "30000",
            "type": "{Integer} Milliseconds",
            "class": "AvailabilityPlugin",
            "module": "Availability Plugin"
        },
        {
            "file": "src/js/ice.ismds.plugin.js",
            "line": 188,
            "description": "The API Key is needed for authentication by the ISMDS service",
            "itemtype": "property",
            "name": "apiKey",
            "access": "private",
            "tagname": "",
            "type": "{String}",
            "class": "AvailabilityPlugin",
            "module": "Availability Plugin"
        },
        {
            "file": "src/js/ice.ismds.plugin.js",
            "line": 196,
            "description": "The API secret is also needed for authentication by the ISMDS service",
            "itemtype": "property",
            "name": "apiSecret",
            "access": "private",
            "tagname": "",
            "type": "{String}",
            "class": "AvailabilityPlugin",
            "module": "Availability Plugin"
        },
        {
            "file": "src/js/main.js",
            "line": 3,
            "description": "This is the main entry point of the navigation plugin namespace\nThe only thing exposed is a create function, users should\nbe able to interact with the core directly after that.\n\nsrc/main.js",
            "class": "CoreEndpoints",
            "module": "Availability Plugin"
        },
        {
            "file": "src/js/registerCoreEndpoints.js",
            "line": 3,
            "description": "src/js/registerCoreEndpoints.js",
            "class": "CoreEndpoints",
            "module": "Availability Plugin"
        },
        {
            "file": "src/js/registerCoreEndpoints.js",
            "line": 24,
            "description": "handles unlocked offers",
            "itemtype": "method",
            "name": "unlock-offers",
            "params": [
                {
                    "name": "password",
                    "description": "The password used to unlock these offer IDs",
                    "type": "Array"
                },
                {
                    "name": "offerIds",
                    "description": "A list of offer IDs unlocked by this password",
                    "type": "Array"
                }
            ],
            "return": {
                "description": "",
                "type": "Undefined"
            },
            "example": [
                "\n ice.execute('unlock-offers', places);"
            ],
            "class": "CoreEndpoints",
            "module": "Availability Plugin"
        },
        {
            "file": "src/js/registerCoreEndpoints.js",
            "line": 38,
            "description": "gets place availability data",
            "itemtype": "method",
            "name": "get-place-data",
            "example": [
                "\n ice.execute('get-place-data');"
            ],
            "class": "CoreEndpoints",
            "module": "Availability Plugin"
        }
    ],
    "warnings": [
        {
            "message": "Missing item type\nCreated by Chantell.Nichols on 10/8/2015.",
            "line": " src/js/data/PlaceAvailabilityData.js:1"
        },
        {
            "message": "Missing item type\nCreated by Chantell.Nichols on 10/5/2015.",
            "line": " src/js/data/urlBuilder.js:1"
        },
        {
            "message": "Missing item type\nCreated by chantell.nichols on 9/8/2015.",
            "line": " src/js/templates/templateSettings.js:1"
        },
        {
            "message": "Missing item type\nthe default interior color for segments with HIGH availability",
            "line": " src/js/templates/templateSettings.js:13"
        },
        {
            "message": "Missing item type\nthe low end of the range of seat availability needed to be considered NONE",
            "line": " src/js/templates/templateSettings.js:19"
        },
        {
            "message": "Missing item type\nthe high end of the range of seat availability needed to be considered NONE",
            "line": " src/js/templates/templateSettings.js:25"
        },
        {
            "message": "Missing item type\nthe default interior color for segments with MEDIUM availability",
            "line": " src/js/templates/templateSettings.js:33"
        },
        {
            "message": "Missing item type\nthe low end of the range of seat availability needed to be considered NONE",
            "line": " src/js/templates/templateSettings.js:39"
        },
        {
            "message": "Missing item type\nthe high end of the range of seat availability needed to be considered NONE",
            "line": " src/js/templates/templateSettings.js:45"
        },
        {
            "message": "Missing item type\nthe default interior color for segments with LOW availability",
            "line": " src/js/templates/templateSettings.js:53"
        },
        {
            "message": "Missing item type\nthe low end of the range of seat availability needed to be considered NONE",
            "line": " src/js/templates/templateSettings.js:59"
        },
        {
            "message": "Missing item type\nthe high end of the range of seat availability needed to be considered NONE",
            "line": " src/js/templates/templateSettings.js:65"
        },
        {
            "message": "Missing item type\nthe default interior color for segments with NONE availability",
            "line": " src/js/templates/templateSettings.js:73"
        },
        {
            "message": "Missing item type\nthe low end of the range of seat availability needed to be considered NONE",
            "line": " src/js/templates/templateSettings.js:79"
        },
        {
            "message": "Missing item type\nthe high end of the range of seat availability needed to be considered NONE",
            "line": " src/js/templates/templateSettings.js:85"
        },
        {
            "message": "Missing item type\nthe default interior color for places with OPEN status",
            "line": " src/js/templates/templateSettings.js:95"
        },
        {
            "message": "Missing item type\nthe default interior color for places with SOLD status",
            "line": " src/js/templates/templateSettings.js:103"
        },
        {
            "message": "Missing item type\nsrc/util/bluebird",
            "line": " src/js/util/bluebird.js:1"
        },
        {
            "message": "Missing item type\nCreated by Chantell.Nichols on 10/6/2015.",
            "line": " src/js/util/validation.js:1"
        },
        {
            "message": "Missing item type\nsrc/js/ice.availability.plugin.js",
            "line": " src/js/ice.ismds.plugin.js:1"
        },
        {
            "message": "Missing item type\nThis is the main entry point of the navigation plugin namespace\nThe only thing exposed is a create function, users should\nbe able to interact with the core directly after that.\n\nsrc/main.js",
            "line": " src/js/main.js:3"
        },
        {
            "message": "Missing item type\nsrc/js/registerCoreEndpoints.js",
            "line": " src/js/registerCoreEndpoints.js:3"
        }
    ]
}