{"_id":"@blazingedge/alexa-lists","_rev":"3-f6796855255e6d59a3e3e00f7c7cd6ed","name":"@blazingedge/alexa-lists","dist-tags":{"latest":"1.0.0"},"versions":{"0.0.0":{"name":"@blazingedge/alexa-lists","version":"0.0.0","description":"Working with lists requires proper permissions for your skill, read the permissions part of the [amazon documentation](https://developer.amazon.com/docs/custom-skills/access-the-alexa-shopping-and-to-do-lists.html#permissions-setup) before using this modu","main":"index.js","scripts":{"lint":"standard --verbose | snazzy","test":"tape tests/*.test.js | tap-spec"},"repository":{"type":"git","url":"git+https://github.com/blazing-edge-labs/alexa-lists.git"},"keywords":[],"author":{"name":"Blazing Edge"},"license":"ISC","dependencies":{"got":"^8.0.3","lodash":"^4.17.5"},"devDependencies":{"nock":"^9.1.6","snazzy":"^7.0.0","standard":"^10.0.3","tap-spec":"^4.1.1","tape":"^4.8.0"},"gitHead":"a02b184696fa2470c2ef29a2b5d051f72622711f","bugs":{"url":"https://github.com/blazing-edge-labs/alexa-lists/issues"},"homepage":"https://github.com/blazing-edge-labs/alexa-lists#readme","_id":"@blazingedge/alexa-lists@0.0.0","_npmVersion":"5.6.0","_nodeVersion":"8.2.1","_npmUser":{"name":"ivancevic","email":"petar.ivancevic171@gmail.com"},"dist":{"integrity":"sha512-eVm+yi0bnaMU4toXM5WX/75lQhw+O52gWzD9RDOb/ynIg4nu6Hrg4yUbXLOMT9RiGDeHAgspq1FDaA2FFQpYpw==","shasum":"ab996b9418b4fe149a25d7ac020a979c651a173a","tarball":"https://registry.npmjs.org/@blazingedge/alexa-lists/-/alexa-lists-0.0.0.tgz","fileCount":7,"unpackedSize":14933,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIH5et9XTr0Joy4dHBDnXar5wu60kHgJEXdx7t/mgp2ZGAiEAlpEquhSwycfnkYs3UNVvaLwWfBPA6V34lEpDpm/8BJw="}]},"maintainers":[{"name":"iblazevic","email":"ivanblazevic17@gmail.com"},{"name":"ivancevic","email":"petar.ivancevic171@gmail.com"},{"name":"kotarac","email":"stipe@kotarac.net"},{"name":"rajkovic","email":"falconvk@gmail.com"},{"name":"rkatic","email":"robert.katic@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/alexa-lists_0.0.0_1518101164403_0.23283212988854007"},"_hasShrinkwrap":false},"1.0.0":{"name":"@blazingedge/alexa-lists","version":"1.0.0","description":"Working with lists requires proper permissions for your skill, read the permissions part of the [amazon documentation](https://developer.amazon.com/docs/custom-skills/access-the-alexa-shopping-and-to-do-lists.html#permissions-setup) before using this modu","main":"index.js","scripts":{"lint":"standard --verbose | snazzy","test":"tape tests/*.test.js | tap-spec"},"repository":{"type":"git","url":"git+https://github.com/blazing-edge-labs/alexa-lists.git"},"keywords":[],"author":{"name":"Blazing Edge"},"license":"ISC","dependencies":{"got":"^8.0.3","lodash":"^4.17.5"},"devDependencies":{"nock":"^9.1.6","snazzy":"^7.0.0","standard":"^10.0.3","tap-spec":"^4.1.1","tape":"^4.8.0"},"gitHead":"d8c288dd718bede2759755dcb30843e91e275283","bugs":{"url":"https://github.com/blazing-edge-labs/alexa-lists/issues"},"homepage":"https://github.com/blazing-edge-labs/alexa-lists#readme","_id":"@blazingedge/alexa-lists@1.0.0","_npmVersion":"5.6.0","_nodeVersion":"8.2.1","_npmUser":{"name":"ivancevic","email":"petar.ivancevic171@gmail.com"},"dist":{"integrity":"sha512-EWW8/ow2Dr2HmqhSeAU1gzo/IgdyuErbKLkRY7SWi7S3QhTmAbkZD/6anBL/87rh+r4rDi2h8f7hlES03hIjSw==","shasum":"fec35b41c1d8e96f37b1833c3deb65e6cef1ad1d","tarball":"https://registry.npmjs.org/@blazingedge/alexa-lists/-/alexa-lists-1.0.0.tgz","fileCount":7,"unpackedSize":14933,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFT2RrEfrj8k/GO2Vj3WcIR3OSDWIIqaO8eZUPR0eDC5AiA+p91SHH8JzzwpKgFY3Phs5CN2itDgyGq8vCN78FbkOg=="}]},"maintainers":[{"name":"iblazevic","email":"ivanblazevic17@gmail.com"},{"name":"ivancevic","email":"petar.ivancevic171@gmail.com"},{"name":"kotarac","email":"stipe@kotarac.net"},{"name":"rajkovic","email":"falconvk@gmail.com"},{"name":"rkatic","email":"robert.katic@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/alexa-lists_1.0.0_1518101360098_0.03172037517824644"},"_hasShrinkwrap":false}},"time":{"created":"2018-02-08T14:46:04.055Z","0.0.0":"2018-02-08T14:46:05.066Z","modified":"2022-04-04T19:30:20.361Z","1.0.0":"2018-02-08T14:49:20.714Z"},"maintainers":[{"name":"iblazevic","email":"ivanblazevic17@gmail.com"},{"name":"ivancevic","email":"petar.ivancevic171@gmail.com"},{"name":"kotarac","email":"stipe@kotarac.net"},{"name":"rajkovic","email":"falconvk@gmail.com"},{"name":"rkatic","email":"robert.katic@gmail.com"}],"description":"Working with lists requires proper permissions for your skill, read the permissions part of the [amazon documentation](https://developer.amazon.com/docs/custom-skills/access-the-alexa-shopping-and-to-do-lists.html#permissions-setup) before using this modu","homepage":"https://github.com/blazing-edge-labs/alexa-lists#readme","keywords":[],"repository":{"type":"git","url":"git+https://github.com/blazing-edge-labs/alexa-lists.git"},"author":{"name":"Blazing Edge"},"bugs":{"url":"https://github.com/blazing-edge-labs/alexa-lists/issues"},"license":"ISC","readme":"# Alexa lists\nWorking with lists requires proper permissions for your skill, read the permissions part of the [amazon documentation](https://developer.amazon.com/docs/custom-skills/access-the-alexa-shopping-and-to-do-lists.html#permissions-setup) before using this module.\n\nBefore making the requests you need to provide the access token. That is why the `init` function needs to be called first. All examples use the [alexa-app](https://github.com/alexa-js/alexa-app) module.\n\n### Permissions card\nIf you don't have the permissions to work with lists, then you should send the permissions `card` to the user.\n#### Example\n```\nasync function sendPermissionsCard (req, res) {\n  return res.card(alexaLists.getPermissionsCard()).send()\n}\n```\n\n----------\n### Create custom list\nCreates a new with the provided name and a state set to `active`.\n```\nalexaLists.init(token).createCustomList(listName)\n```\n#### Example\n```\nasync function createCustomList (req, res) {\n  const listHandler = alexaLists.init(_.get(req, 'context.System.apiAccessToken'))\n  const createdList = await listHandler.createCustomList('blazing new list')\n  ...\n}\n```\n----------\n### Create custom list item\nCreates a new item for a specified list with the provided item status can be `active` or `completed`. The `active` status is set by default\n\n```\nalexaLists.init(token).createNewListItem(listName, listItemName, listItemStatus)\n```\n#### Example\n```\nasync function createNewListItem (req, res) {\n  const listHandler = alexaLists.init(_.get(req, 'context.System.apiAccessToken'))\n  const createdListItem = await listHandler.createNewListItem('blazing list', 'buy apples', 'completed')\n  ...\n}\n```\n----------\n### Delete custom list\nDelete a custom list by name.\n```\nalexaLists.init(token).deleteCustomList(listName)\n```\n#### Example\n```\nasync function deleteCustomList (req, res) {\n  const listHandler = alexaLists.init(_.get(req, 'context.System.apiAccessToken'))\n  const deletedList = await listHandler.deleteCustomList('blazing list')\n  ...\n}\n```\n----------\n### Delete custom list item\nDelete a list item from a specified list.\n```\nalexaLists.init(token).deleteListItem(listName, listItemName)\n```\n#### Example\n```\nasync function deleteListItem (req, res) {\n  const listHandler = alexaLists.init(_.get(req, 'context.System.apiAccessToken'))\n  const deletedListItem = await listHandler.deleteListItem('blazing list', 'buy apples')\n  ...\n}\n```\n----------\n### Get list\nGet specific list by name and/or status.\n```\nalexaLists.init(token).getList(listName, listState)\n```\n#### Example\n```\nasync function getList (req, res) {\n  const listHandler = alexaLists.init(_.get(req, 'context.System.apiAccessToken'))\n  const list = await listHandler.getList('blazing list', 'active')\n  ...\n}\n```\n----------\n### Get list item\nGet a specific list item from a list.\n```\nalexaLists.init(token).getListItem(listName, listItemName)\n```\n#### Example\n```\nasync function getListItem (req, res) {\n  const listHandler = alexaLists.init(_.get(req, 'context.System.apiAccessToken'))\n  const listItem = await listHandler.getListItem('blazing list', 'list item')\n  ...\n}\n```\n----------\n### Get lists metadata\nGet all lists, without the list items.\n```\nalexaLists.init(token).getListMetadata(listName, listItemName)\n```\n#### Example\n```\nasync function getListMetadata (req, res) {\n  const listHandler = alexaLists.init(_.get(req, 'context.System.apiAccessToken'))\n  const lists = await listHandler.getListMetadata()\n  ...\n}\n```\n----------\n### Update custom list\n```\nalexaLists.init(token).updateCustomList(listName, {\n  name: 'new list name',\n  state: 'completed'\n})\n```\n#### Example\n```\nasync function updateCustomList (req, res) {\n  const listHandler = alexaLists.init(_.get(req, 'context.System.apiAccessToken'))\n  const updatedCustomList = await listHandler.updateCustomList('blazing list', {\n    name: 'new list name',\n    state: 'completed'\n  })\n  ...\n}\n```\n----------\n### Update list item\n```\nalexaLists.init(token).updateListItem(listName, listItemName, {\n  value: 'new list item name',\n  status: 'completed'\n})\n```\n#### Example\n```\nasync function updateListItem (req, res) {\n  const listHandler = alexaLists.init(_.get(req, 'context.System.apiAccessToken'))\n  const updatedListItem = await listHandler.updateListItem('blazing list', 'some item', {\n    value: 'some updated item name',\n    status: 'completed'\n  })\n  ...\n}\n```\n","readmeFilename":"README.md"}