{"_id":"infogroup","_rev":"26-140db5b5f2980daddecfb76a60e3a8ca","name":"infogroup","description":"A node.js wrapper around the InfoGroup API","dist-tags":{"latest":"0.0.6"},"versions":{"0.0.1":{"name":"infogroup","description":"A node.js wrapper around the InfoGroup API","keywords":["infogroup","api"],"homepage":"https://github.com/interbred-monkey/infogroup","bugs":{"url":"https://github.com/interbred-monkey/infogroup/issues"},"author":{"name":"Simon Mudd"},"version":"0.0.1","licenses":[{"type":"MIT"}],"main":"infogroup.js","repository":{"type":"git","url":"git://github.com/interbred-monkey/infogroup.git"},"dependencies":{"request":"2.33.0","underscore":"1.5.2"},"_id":"infogroup@0.0.1","dist":{"shasum":"ebbda89fda98d54a13eabc2282fd5ff2ee1b4ffc","tarball":"https://registry.npmjs.org/infogroup/-/infogroup-0.0.1.tgz","integrity":"sha512-rBokawm7egPoSByyPCs0zKxe1QRIvdeP9ORb/TjazSpGp7t2szKgtp5O1ByePYkpd4TBjEBspduz480s5sq1tg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEdoS/zXAo4Y/S1fWHhrfTiv4LgjiiOZVTa4iDDAua5EAiEAvZs00ux60MKS3EYSpzELRm2FE+3CvqW72W+wc+w3E3w="}]},"_from":".","_npmVersion":"1.3.11","_npmUser":{"name":"simonmudd","email":"simon.mudd@centralindex.com"},"maintainers":[{"name":"simonmudd","email":"simon.mudd@centralindex.com"}]},"0.0.2":{"name":"infogroup","description":"A node.js wrapper around the InfoGroup API","keywords":["infogroup","api"],"homepage":"https://github.com/interbred-monkey/infogroup","bugs":{"url":"https://github.com/interbred-monkey/infogroup/issues"},"author":{"name":"Simon Mudd"},"version":"0.0.2","licenses":[{"type":"MIT"}],"main":"infogroup.js","repository":{"type":"git","url":"git://github.com/interbred-monkey/infogroup.git"},"dependencies":{"request":"2.33.0","underscore":"1.5.2"},"_id":"infogroup@0.0.2","dist":{"shasum":"fb275b836e7ebce03a0afc5eace4896fbda038fd","tarball":"https://registry.npmjs.org/infogroup/-/infogroup-0.0.2.tgz","integrity":"sha512-yX/QhL5HIYMV54uLnUVlYiRGKk747JoxRR9hJNY3GIFQBMmTRIRG3CyMPU7F3nQhkTDWiXBF1S7ZvZAmMaRo9g==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDqfsAhK0bxTs2JgGPtq5p+Qo9SKT9+UIdjnZNjNLkD1wIgZCJ5ZeAL81vB61/dFdoTdPIzJrUsjQ05C4GrihPByhE="}]},"_from":".","_npmVersion":"1.3.11","_npmUser":{"name":"simonmudd","email":"simon.mudd@centralindex.com"},"maintainers":[{"name":"simonmudd","email":"simon.mudd@centralindex.com"}]},"0.0.3":{"name":"infogroup","description":"A node.js wrapper around the InfoGroup API","keywords":["infogroup","api"],"homepage":"https://github.com/interbred-monkey/infogroup","bugs":{"url":"https://github.com/interbred-monkey/infogroup/issues"},"author":{"name":"Simon Mudd"},"version":"0.0.3","licenses":[{"type":"MIT"}],"main":"infogroup.js","repository":{"type":"git","url":"git://github.com/interbred-monkey/infogroup.git"},"dependencies":{"request":"2.33.0","underscore":"1.5.2"},"_id":"infogroup@0.0.3","dist":{"shasum":"ab864093b19c36e0e11f3003853e3db81afba5fd","tarball":"https://registry.npmjs.org/infogroup/-/infogroup-0.0.3.tgz","integrity":"sha512-bAeCtk1B93HzERLJjO1CUz3W9/FW8iWMQKZevkhx9D2J+bWrRcsMrvlJj1n/VvuSqTS7hCIT3RiQ3b+vW06zCQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDAmRtriD+Q0GaPAfxOVI78c6sqE18QJVbLUj9RewBWewIgG4rzX9v8/a7x4lWaujAPeg1c4OzhT+9w/94DWSu5VBU="}]},"_from":".","_npmVersion":"1.3.11","_npmUser":{"name":"simonmudd","email":"simon.mudd@centralindex.com"},"maintainers":[{"name":"simonmudd","email":"simon.mudd@centralindex.com"}]},"0.0.4":{"name":"infogroup","description":"A node.js wrapper around the InfoGroup API","keywords":["infogroup","api"],"homepage":"https://github.com/interbred-monkey/infogroup","bugs":{"url":"https://github.com/interbred-monkey/infogroup/issues"},"author":{"name":"Simon Mudd"},"version":"0.0.4","licenses":[{"type":"MIT"}],"main":"infogroup.js","repository":{"type":"git","url":"git://github.com/interbred-monkey/infogroup.git"},"dependencies":{"request":"2.33.0","underscore":"1.5.2"},"_id":"infogroup@0.0.4","dist":{"shasum":"2b5c501e5523518c2b1a4acce2507787c2070378","tarball":"https://registry.npmjs.org/infogroup/-/infogroup-0.0.4.tgz","integrity":"sha512-Ek3di+qQ6mt1HGtDsXnGTywCUETMJ5Vv8lqJlzCUUZHHL1Lo72oylf7490K0br2piKO/0XFygsAoPY5klEeuMg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIChmQaJA0/SEdD/4/UUZ867vAvREg2daq5KgT5Qk/HOjAiAUTSUFiEjmkUyOAufdH5458cJ7Y+F20q/wgVqRULv5bg=="}]},"_from":".","_npmVersion":"1.3.11","_npmUser":{"name":"simonmudd","email":"simon.mudd@centralindex.com"},"maintainers":[{"name":"simonmudd","email":"simon.mudd@centralindex.com"}]},"0.0.5":{"name":"infogroup","description":"A node.js wrapper around the InfoGroup API","keywords":["infogroup","api"],"homepage":"https://github.com/interbred-monkey/infogroup","bugs":{"url":"https://github.com/interbred-monkey/infogroup/issues"},"author":{"name":"Simon Mudd"},"version":"0.0.5","licenses":[{"type":"MIT"}],"main":"infogroup.js","repository":{"type":"git","url":"git://github.com/interbred-monkey/infogroup.git"},"dependencies":{"request":"2.33.0","underscore":"1.5.2"},"_id":"infogroup@0.0.5","dist":{"shasum":"59e88e9333a2e607272dbc829c6099c108204850","tarball":"https://registry.npmjs.org/infogroup/-/infogroup-0.0.5.tgz","integrity":"sha512-Kg73Wyz6DuMXlaiBZ0OnYVYSdskWcRRuc9xYp4PtaXjICBk1u1tixgQfoqo/mxa4gCaL9RJNNRsqjfFlPnlm9Q==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD7V7tXr9j3DJMDNPcqla14r/SC06XWim9UjtLKt4A97QIhAOv2n9G/4OYJ2GXiWfnOHQhci6Qj1jE1ywwCg9d9KoC5"}]},"_from":".","_npmVersion":"1.3.11","_npmUser":{"name":"simonmudd","email":"simon.mudd@centralindex.com"},"maintainers":[{"name":"simonmudd","email":"simon.mudd@centralindex.com"}]},"0.0.6":{"name":"infogroup","description":"A node.js wrapper around the InfoGroup API","keywords":["infogroup","api"],"homepage":"https://github.com/interbred-monkey/infogroup","bugs":{"url":"https://github.com/interbred-monkey/infogroup/issues"},"author":{"name":"Simon Mudd"},"version":"0.0.6","licenses":[{"type":"MIT"}],"main":"infogroup.js","repository":{"type":"git","url":"git://github.com/interbred-monkey/infogroup.git"},"dependencies":{"request":"2.33.0","underscore":"1.5.2"},"_id":"infogroup@0.0.6","dist":{"shasum":"e0df4ebd50020874846ac623cf1f08b2dbc094f8","tarball":"https://registry.npmjs.org/infogroup/-/infogroup-0.0.6.tgz","integrity":"sha512-16IS61Ut6UR0ZGkp5TYNNGz5wYjYUuqOP3+swfcPHHAcUfg01SVAwkSHnFFdZt70pr3FzPF0vmQkgga5s+Eo0Q==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGrkM0mBqz61k2xuKBBG9FDl4zfSLBXi5yrjkywCPNdMAiEAgP4HoEttNWZlXImnwXSp6EjDanjbpSpeVCZl71pJ86A="}]},"_from":".","_npmVersion":"1.3.11","_npmUser":{"name":"simonmudd","email":"simon.mudd@centralindex.com"},"maintainers":[{"name":"simonmudd","email":"simon.mudd@centralindex.com"}]}},"readme":"InfoGroup\n=========\n\nA simple Node.JS wrapper around the InfoGroup business directory API\n\n## Installation\n\n[infogroup](https://npmjs.org/package/infogroup) is available through an installation from npm.\n\n```javascript\nnpm install infogroup\n```\n\n## Usage\n\nTo use this library simply require the file and create a new instance of the module like so:\n\n```javascript\nvar InfoGroup = require('infogroup');\nvar infogroup = new InfoGroup(username, password);\n```\n\n### Using Debug mode\n\nThe debug mode is set to false by default, when switched on the API parameters will be logged out along with the API call that is being called and the response.\n\n```javascript\ninfogroup.debugMode(true);\n```\n\n### Using Test mode\n\nTest mode is set to false by default, when switched on the module will use the InfoGroup sandbox environment to stop test data being added to the live database.\n\n```javascript\ninfogroup.testMode(true);\n```\n\n### Manipulating records\n\nParameters for adding a record are as follows:\n\n---\n\n  `submissions` - one or more records to add to the database\n\n---\n\nWhen submitting a record the `Submission Type` parameter has the following options:\n\n---\n\n`A` - Add record  \n  `U` - Update record  \n  `R` - Renew record  \n  `D` - Delete record\n\n---\n\nBasic example:\n\n```javascript\ninfogroup.getToken(function(err) {\n\n  if (err) {\n\n    console.log(\"Errrrrr\");\n    console.log(err);\n    process.exit();\n\n  }\n\n  var params = {\n    submissions: [\n      {\n        \"Submission Type\": \"A\",\n        \"Company Name\": \"Axel Foley\",\n        \"Location Address\": \"1154 Summit Dr\",\n        \"Location City\": \"Beverly Hills\",\n        \"Location State\": \"CA\",\n        \"Location Zip Code\": \"90210\",\n        \"Location Phone\": \"7039554747\"\n      },\n      {\n        \"Submission Type\": \"U\",\n        \"Company Name\": \"Roadhouse Diner\",\n        \"Location Address\": \"405 Memorial Drive\",\n        \"Location City\": \"Plano\",\n        \"Location State\": \"TX\",\n        \"Location Zip Code\": \"75074\",\n        \"Location Phone\": \"206-405-9181\"\n      }\n    ]\n  }\n\n  / do the call for the adding data\n  infogroup.postData(params, function(err, data) {\n\n    console.log(err, data)\n\n  })\n\n})\n```\n\nExample response:\n```javascript\n{\n  \"result\": \"success\",\n  \"submissions\": [\n    {\n      \"result\": \"success\",\n      \"id\": \"34c415dc-d385-11e2-8400-fda2de9a8a9c\"\n    },\n    {\n      \"result\": \"success\",\n      \"id\": \"34c66bc0-d385-11e2-946f-476095fff0ab\"\n    }\n  ]\n}\n```\n\n### Fetching Submission records\n\nParameters for getting submissions are as follows:\n\n---\n\n  `ids` - one or more submissions to get from the database\n\n---\n\nReturned statuses are as follows:\n\n---\n\n  `complete` - one or more submissions to get from the database  \n    `processing` - this submission is being processed  \n    `failed` - there was a problem with this submission\n\n---\n\n\nInfoGroup also provide a list of processing errors when returning submissions, these are outlined in the following way:\n\n---\n\n  `warnings` - minor errors not causing the submission to fail\n  \n  ```json\n  {\n    \"processing_messages\": {\n      \"warnings\": {\"name\": \"standardized to Wendy's\"}\n    }\n  }\n  ```\n\n  `errors` - major errors causing the submission to fail\n\n  ```json\n  {\n    \"processing_messages\": {\n      \"errors\": {\"state\": \"is not valid\"] }\n    }\n  }\n  ```\n\n---\n\n\nIf any submission cannot be found as reponse like this can be expected:\n\n```json\n  {\n    \"result\": \"error\",\n    \"error\": \"could not find submission with id: 34c66bc0-d385-11e2-946f-476095fff0ab\"\n  }\n```\n\nBasic example:\n\n```javascript\ninfogroup.getToken(function(err) {\n\n  if (err) {\n\n    console.log(\"Errrrrr\");\n    console.log(err);\n    process.exit();\n\n  }\n\n  var params = {\n    ids: [\n      \"34c415dc-d385-11e2-8400-fda2de9a8a9c\",\n      \"34c66bc0-d385-11e2-946f-476095fff0ab\"\n    ]\n  }\n\n  / do the call for the adding data\n  infogroup.getSubmissions(params, function(err, data) {\n\n    console.log(err, data)\n\n  })\n\n})\n```\n\nExample response:\n```javascript\n{\n  \"result\": \"success\",\n  \"submissions\": [\n    {\n      \"status\": \"completed\",\n      \"submitted_at\": \"2013-08-30T10:21:09.000-04:00\",\n      \"processing_messages\": null,\n      \"id\": \"34c415dc-d385-11e2-8400-fda2de9a8a9c\",\n      \"infogroup_id\": \"689400166\",\n      \"express_update_url\": \"http://www.expressupdate.com/places/DFJDDKD\",\n      \"submission_type\": 'A',\n      \"update_expiration_date\": \"2013-08-30T10:21:09.000-04:00\"\n    },\n    {\n      \"status\": \"processing\",\n      \"submitted_at\": \"2013-08-30T10:21:09.000-04:00\",\n      \"processing_messages\": {\n        \"warnings\": {\"name\": \"standardized to Wendy's\"}\n      },\n      \"id\": \"34c66bc0-d385-11e2-946f-476095fff0ab\",\n      \"infogroup_id\": \"347848748\",\n      \"express_update_url\": \"http://www.expressupdate.com/places/GFGDHGJ\",\n      \"submission_type\": 'A',\n      \"update_expiration_date\": \"2013-08-30T10:21:09.000-04:00\"\n    }\n  ]\n}\n```\n\n## Documentation\n\nThe documentation for the InfoGroup API can be found by visiting the website below  \n  [http://sandbox.bulkupdate.infogroup.com/docs/api](http://sandbox.bulkupdate.infogroup.com/docs/api)\n\nNote: Not all fields are included in the InfoGroup documentation, there is a document in the documentation folder which contains a list of fields that are not included which was supplied by the nice people at InfoGroup.\n\n## Dependencies\n\n[request](http://github.com/mikeal/request.git)  \n  [underscore](http://underscorejs.org)\n","maintainers":[{"name":"simonmudd","email":"simon.mudd@centralindex.com"}],"time":{"modified":"2022-06-19T01:13:05.820Z","created":"2014-03-05T09:57:16.326Z","0.0.1":"2014-03-05T09:57:17.323Z","0.0.2":"2014-03-13T14:25:42.583Z","0.0.3":"2014-03-13T16:53:13.802Z","0.0.4":"2014-04-09T13:07:50.984Z","0.0.5":"2014-04-14T13:32:43.780Z","0.0.6":"2014-04-14T13:40:40.681Z"},"readmeFilename":"README.md","homepage":"https://github.com/interbred-monkey/infogroup","keywords":["infogroup","api"],"repository":{"type":"git","url":"git://github.com/interbred-monkey/infogroup.git"},"author":{"name":"Simon Mudd"},"bugs":{"url":"https://github.com/interbred-monkey/infogroup/issues"}}