{"_id":"@amazebot/rocket-rest","_rev":"4-b99c032a2dc1ecc839fb909412f4e122","name":"@amazebot/rocket-rest","dist-tags":{"latest":"0.2.1"},"versions":{"0.0.1":{"name":"@amazebot/rocket-rest","version":"0.0.1","description":"Simple handlers for calling Rocket.Chat REST API endpoints.","homepage":"https://github.com/Amazebot/rocket-control/tree/master/packages/rest","repository":{"type":"git","url":"git@github.com:Amazebot/rocket-control.git"},"author":{"name":"Tim Kinnane","email":"tim.kinnane@amazebot.chat"},"license":"MIT","engines":{"node":"> 8.0.0","npm":"> 5.0.0"},"main":"lib/index.js","types":"lib/index.d.ts","keywords":["rocket.chat","chat","chatops","messaging","CUI","typescript","API","REST"],"publishConfig":{"access":"public"},"scripts":{"test":"echo \"Error: run tests from root\" && exit 1","add:local":"yarn add --registry http://localhost:4873"},"dependencies":{"@amazebot/config":"^0.1.1","@amazebot/logger":"^0.1.1","@amazebot/rocket-sims":"^0.0.1","@amazebot/rocket-socket":"^0.0.1","axios":"^0.18.0"},"gitHead":"6606c93ef8935125632c4b6359390cc702c29801","_id":"@amazebot/rocket-rest@0.0.1","dist":{"shasum":"4158964e7caf9b6113a8ef2b5d69d6de76190a53","integrity":"sha512-bdezIrhrMYtPCtoDY7q3a5v+qBUHT+2GO526674Cnyryg8hwlZPF1/DJJBAgOr8ofdPtoHCzowkj6hy8skJvWQ==","tarball":"https://registry.npmjs.org/@amazebot/rocket-rest/-/rocket-rest-0.0.1.tgz","fileCount":18,"unpackedSize":22583,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcD6r1CRA9TVsSAnZWagAABM4P/RnzdsntpuXCATJEvCUl\nX9BywRhoxH06x/3iv18tzt8OtZKCJNM7BZMgO+2NQwJX/haH7G6ekcm7kMdM\nJBE/Et/flPD2B+pwc9CdeosrUYEo+NrgWLXDfoRDgC2GjutXVAXfdGY4wFmn\nU1MWnhFZHaGc/n2V6iPenj1z1k4VgsfWmlAbVaRfjPd4RMhlFndSSwvzyt+a\nKhDZHseIng6gW6EgnJIm1/0MpdHBNIXoq43kYiXwjRq2g6j05bQ5altEkQZ7\nGd0gqDv9gRs3gWcf1e5vtaSzLw5A/jI7USs/uylhcRVAnVZeIQScat6CoX8t\nemfgL+PqNkVhcDHwWTiDeAXs0D7u9ROvZEDLWvEiD3c4euGGGjOsmBoyGYT7\nVmL4UOCWPVEnb/wFJAqDA6dtIlSHNtE/dFK+KyCxKOkP5qJg0gndwzjyCeyq\nTBUIED7iNdFDsALoAt7c/q+p46uuQuqFEfMIkIAg58xeamCMBAXM+IUA0Q8s\n/Rw3lSzbBoH+Lq3lK5lqeDFLqmR2zzVqlBET79Rmy6kjh9Zk+nbnuOWhcC5X\nnbvW3HFTdse35oVb62kujopiW/UDqyhgcuGAIkoEQYYHOkX4W6iLkLcjcqkI\nMSEAOstour1iGAn26gGemD3NxH5Q2mLG+lPhXxDRHbomLeQ0Ew3o+sLqOnbp\nZ/LX\r\n=5Ems\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDnLvv8XREmLBqoWabWE6qBcuPy66264K4MNODR5GEkCAIgJCyS7mBCUJkrMD+dWWn4QWLyfEw38hoqfo0+KyfZSyY="}]},"maintainers":[{"name":"timkinnane","email":"timkinnane@gmail.com"}],"_npmUser":{"name":"timkinnane","email":"timkinnane@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/rocket-rest_0.0.1_1544530676316_0.5759645614693332"},"_hasShrinkwrap":false},"0.1.0":{"name":"@amazebot/rocket-rest","version":"0.1.0","description":"Simple handlers for calling Rocket.Chat REST API endpoints.","homepage":"https://github.com/Amazebot/rocket-control/tree/master/packages/rest","repository":{"type":"git","url":"git@github.com:Amazebot/rocket-control.git"},"author":{"name":"Tim Kinnane","email":"tim.kinnane@amazebot.chat"},"license":"MIT","engines":{"node":"> 8.0.0","npm":"> 5.0.0"},"main":"lib/index.js","types":"lib/index.d.ts","keywords":["rocket.chat","chat","chatops","messaging","CUI","typescript","API","REST"],"publishConfig":{"access":"public"},"scripts":{"test":"echo \"Error: run tests from root\" && exit 1","add:local":"yarn add --registry http://localhost:4873"},"dependencies":{"@amazebot/config":"^0.1.1","@amazebot/logger":"^0.1.1","@amazebot/rocket-sims":"^0.0.1","@amazebot/rocket-socket":"^0.0.1","axios":"^0.18.0"},"gitHead":"bb35025bec7714881fb291b2b9203e3b8c2e01ae","_id":"@amazebot/rocket-rest@0.1.0","dist":{"shasum":"f0250271a204d1f84df3eb8a9d859e96df1621f7","integrity":"sha512-XQgz3W9dMlHKfe21MCw1zydFxeyniCDwFsoEYn0c5b0Ylu22UFp57GundM2QjPViBK9Fhel4oSyT8rgfgP+FDw==","tarball":"https://registry.npmjs.org/@amazebot/rocket-rest/-/rocket-rest-0.1.0.tgz","fileCount":16,"unpackedSize":26602,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcNp2ECRA9TVsSAnZWagAAMe4QAIvEhyHkCkcrYxEprgUb\ndL/UnC/jMyP/qU9SV3yJY+GIFZskgcuDXIEt4QdRBu1N1vThLF+xZhERUmPs\n+iCJ/9H23dqrs9lpgV4NQLOYOU60s+AXVHKcCgTji7bp08Qwby7w6F5a7VKL\ncba6imb83Rxd3D4vGzNxSopD+dUCvzze4al1N0+I/RDF79j9qPlWbALp3vC0\na4DXs/D5MUu2faT9qi52nBIGKVPua99gaxxmXjr5wM3KlSBA+N8VA64B5WTp\n/mqXWIplQ2G2jHgOgpxAX1fn0G/tBbSgjFFMm52uTngb81DeVS/rdn9TOeoM\nKInG3K/LAOyo5wtxEpPXe0lSXaTeG/nMPFeNd9/zm+zs0mtyp5Dg+N9Ti64S\n08l5Snk82zSmdpFs72ebImf1znySoc0/ZYyMWRU+jBx5qwTfRqSMHAdkcy0J\nXuKcJvahXF/Fg+rHRRNyeDUdL2foCwNNG5TaBBCrTzOOKC8bCD7aMzAmHSkV\nW3wBPQzQiw2c6oyUPA2Kgque1WeeNJ487yiVKElojW9Iqbh3kJP/2G7E7Bpy\nKAnYBNjvGX0Ipxaf6kRQ7D3aTgU1y3lDJxVS/+6PnVzY8vZdTkmeXoL74Rtf\nZNoKKTRVsbZ+PtWNtAjfDFcW+RNmLsWOcPON/foAn2I2OmmUNTbZJXt4Er/k\nP4uG\r\n=VSos\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBfcE1iJPA1wFmbFdvZ2RFTyv/6uLbE3LG6tgs2TQK2cAiBpcp9o86RqxU2qYKXNyOXjD+wimPNttbIwuJmr/HAvPQ=="}]},"maintainers":[{"name":"timkinnane","email":"timkinnane@gmail.com"}],"_npmUser":{"name":"timkinnane","email":"timkinnane@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/rocket-rest_0.1.0_1547083139129_0.04210698217133557"},"_hasShrinkwrap":false},"0.2.0":{"name":"@amazebot/rocket-rest","version":"0.2.0","description":"Simple handlers for calling Rocket.Chat REST API endpoints.","homepage":"https://github.com/Amazebot/rocket-control/tree/master/packages/rest","repository":{"type":"git","url":"git+ssh://git@github.com/Amazebot/rocket-control.git"},"author":{"name":"Tim Kinnane","email":"tim.kinnane@amazebot.chat"},"license":"MIT","engines":{"node":"> 8.0.0","npm":"> 5.0.0"},"main":"lib/index.js","types":"lib/index.d.ts","directories":{"lib":"lib"},"keywords":["rocket.chat","chat","chatops","messaging","CUI","typescript","API","REST"],"publishConfig":{"access":"public"},"scripts":{"test":"echo \"Error: run tests from root\" && exit 1","add:local":"yarn add --registry http://localhost:4873"},"dependencies":{"@amazebot/config":"^0.1.1","@amazebot/logger":"^0.1.1","@amazebot/rocket-sims":"^0.1.0","@amazebot/rocket-socket":"^0.1.0","axios":"^0.18.0"},"gitHead":"682d3d28faefd214cea98c658e8f9ee56d6ac2d7","bugs":{"url":"https://github.com/Amazebot/rocket-control/issues"},"_id":"@amazebot/rocket-rest@0.2.0","_nodeVersion":"11.8.0","_npmVersion":"lerna/3.13.0/node@v11.8.0+x64 (darwin)","_npmUser":{"name":"timkinnane","email":"timkinnane@gmail.com"},"dist":{"integrity":"sha512-jWGHPLxxidVfXZ/2yNi0REEKWTfnf4bGyzLhRdO/sePTFgdYPqRInNkSWc8BrmF8Fd1GT2uCQwCIqSBfjGO1bQ==","shasum":"fd9c38e6b93cf9a2ee6e0d6b5d846bb73be44646","tarball":"https://registry.npmjs.org/@amazebot/rocket-rest/-/rocket-rest-0.2.0.tgz","fileCount":16,"unpackedSize":26996,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcdngcCRA9TVsSAnZWagAAsegP/iu+QrF9FOv5VyuClxOU\n1N6iWSoIh+dwE3o/SULEfLcpIcvh8TL+lNSlQwffNluxuBp+8yz4kwvuDAuo\n3tKXLREQTYVfZ0mu9IoyE9J9lU0wEleRnwoLCCABoK+h2oJr7rNECjqSuKY5\n2igFwNObPs8pnMJdnJWKhtlNuaNYGMPSLJkEqIGT2RsD00dyEOgKqKAhUNG+\nuEzVjidMIrUQZRfAJrpCB/vG5k8wbFZpdhX/fwVWfE6jW1tND8xYn80oZF8n\nN7RDFW6GPLQBMzKwurV/MqQM1K5gSWkT1jwRi3sqiKfKFcByMz9xr4pnagTM\nWLxKKYGtSNTC1Z3DJXp7mHNuyWbIMsdTEUTIPZrl4c4/nn9I/oSNM0u+g3dj\nMYMl21sUmSuIvwt3VfNNQ3c8+O5NZcsa/+DcwBUps8MNeVjkZeDH4uj+kKYg\nP2uuMVwh5MNd71rakPmpLh6RHjPzFJoFB2hIMBDizUIxpKCwZATjgRqSthuQ\noCQzUHJRxqxkfmXhYWg17F7kfxPetb/7LPfc4wuuDqGc2VFfmx/+KenD8PTQ\nBPc3yVPvdAL4dPJEiMFjfc1SxV4jCUARmkh1PPNX3eE2YESfX/yNoRsLH4n4\nUcd24ZzeDhE7AMpD77HC4Lrs+hTe7WGNMsLJUiHzOidJDaPu0wkB403k2BlE\nh4Bk\r\n=Jeep\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCqc8czUHYoDP0SuXwRFanW/9LKn4qLEOPqXIetPfaDswIgEr/5vfg/vO1lG/LwuISTF8MwVQV5XP85TYlgEz5kgfI="}]},"maintainers":[{"name":"timkinnane","email":"timkinnane@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/rocket-rest_0.2.0_1551267868369_0.869480464024255"},"_hasShrinkwrap":false},"0.2.1":{"name":"@amazebot/rocket-rest","version":"0.2.1","description":"Simple handlers for calling Rocket.Chat REST API endpoints.","homepage":"https://github.com/Amazebot/rocket-control/tree/master/packages/rest","repository":{"type":"git","url":"git+ssh://git@github.com/Amazebot/rocket-control.git"},"author":{"name":"Tim Kinnane","email":"tim.kinnane@amazebot.chat"},"license":"MIT","engines":{"node":"> 8.0.0","npm":"> 5.0.0"},"main":"lib/index.js","types":"lib/index.d.ts","directories":{"lib":"lib"},"keywords":["rocket.chat","chat","chatops","messaging","CUI","typescript","API","REST"],"publishConfig":{"access":"public"},"scripts":{"test":"echo \"Error: run tests from root\" && exit 1","add:local":"yarn add --registry http://localhost:4873"},"dependencies":{"@amazebot/config":"^0.1.1","@amazebot/logger":"^0.1.1","@amazebot/rocket-sims":"^0.1.1","@amazebot/rocket-socket":"^0.1.1","axios":"^0.18.0"},"gitHead":"627a1cd05ebd2fa150d24a5914b8de48407214ee","bugs":{"url":"https://github.com/Amazebot/rocket-control/issues"},"_id":"@amazebot/rocket-rest@0.2.1","_nodeVersion":"11.12.0","_npmVersion":"lerna/3.13.0/node@v11.12.0+x64 (darwin)","_npmUser":{"name":"timkinnane","email":"timkinnane@gmail.com"},"dist":{"integrity":"sha512-vloF5SoM9mUQggHGPECgu39drR6eyfVdeMOg5Q8A+tF8m0NYw73z2jiQ0J4mF10/5DOT8Iy4Sj5G9C2hHQQC4g==","shasum":"e4f37c5eddaefc7bbacf111fbeab0cb20bdb236e","tarball":"https://registry.npmjs.org/@amazebot/rocket-rest/-/rocket-rest-0.2.1.tgz","fileCount":16,"unpackedSize":27198,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcvGn6CRA9TVsSAnZWagAAPygP/01LVqw0DwMARaKUuiN9\nMu6k8EpA6Lsi2i0cFIC2reytzDqFY1E2KofHdB3OkDan4JuIyUa7N19iEvsh\nbcmf7ZVPJotuBk1V3OPxrQGmAt3h3pxWHn8C+6J90aE0Lc2vBrTwxpY7xJCk\n6YgGo7WenQ+3FszyzdOJN3Fm2pEOUUXd2jy6GUseW57S8yYJgjq4KXA2DjRA\n4qvHjDovTx1GJpUaiZBdalAVv7u3LMOagdqRm95QcT0lEoLPckBHOvTRchs/\n1qlUbgORz/dv9A68rPnLRj/QidwmBoghEQoAvSaiir7cH5Sz9O8cDWPkYsEV\nb++gkgGs9zE86s0EHLZL+3w7CsjnYoLHHodfeEV28uKqF6pNh8N5ngtWlv7m\nrzf1E46TAD6pUsMnbq0MAwtdlwxEXw0d8O4kZYAOcTIH5eYK+dplWslmN02p\nKigLMHtHoID+K6mz6UPQ2u9RY/V+IeQ/KdYyaToIz5nRrsLz2KnKxzFAhJGQ\nQYtS9UyK3HTFfzpM/sa3dk7NmCEj7gyR2jyV41iLMtfn7AwpJLlTvY7CdOGT\nSs+kTFPLyn+t3fv2+mx6GW4FDbLn+imeVuYrTJSnNlp1oOI9MGu8T+Rk9lh2\nYIm66UctiEv0HS9CQYWhuUinqLAf/Sicnqb43LcBzTIap9jMH/dLQS22ZFso\nQXNa\r\n=7jT9\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFPp8vYkkcinopLr2dRugKiDjj/FSMN5awBF4l1SlTfZAiBP6URm8Fqle5dzO3v8GkTZ53p+21d2g4kOci7SlXCZsg=="}]},"maintainers":[{"name":"timkinnane","email":"timkinnane@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/rocket-rest_0.2.1_1555851770075_0.8601327813711841"},"_hasShrinkwrap":false}},"time":{"created":"2018-12-11T12:17:56.147Z","0.0.1":"2018-12-11T12:17:56.451Z","modified":"2022-04-04T13:44:20.542Z","0.1.0":"2019-01-10T01:18:59.567Z","0.2.0":"2019-02-27T11:44:28.503Z","0.2.1":"2019-04-21T13:02:50.164Z"},"maintainers":[{"name":"timkinnane","email":"timkinnane@gmail.com"}],"description":"Simple handlers for calling Rocket.Chat REST API endpoints.","homepage":"https://github.com/Amazebot/rocket-control/tree/master/packages/rest","keywords":["rocket.chat","chat","chatops","messaging","CUI","typescript","API","REST"],"repository":{"type":"git","url":"git+ssh://git@github.com/Amazebot/rocket-control.git"},"author":{"name":"Tim Kinnane","email":"tim.kinnane@amazebot.chat"},"license":"MIT","readme":"[control]: https://github.com/Amazebot/rocket-control\n[config]: https://github.com/Amazebot/rocket-control#config\n[axios]: https://github.com/axios/axios\n[rest-docs]: https://rocket.chat/docs/developer-guides/rest-api/\n\n# 🛏️ Rocket Rest\nSimple helpers for calling Rocket.Chat REST API endpoints.\n\n---\n\n### Usage\n\nSee the main [Rocket Control README][control] for general configuration.\n\nSee [Rocket.Chat's REST API docs][rest-docs] for specific endpoint requirements.\n\nInstall the package.\n\n```sh\nyarn add @amazebot/rocket-rest\n```\n\nImport the API helpers.\n\nTypescript / Babel:\n```ts\nimport * as API from '@amazebot/rocket-rest'\n```\n\nJavascript\n```js\nconst API = require('@amazebot/rocket-rest')\n```\n\n#### `.client([host])`\n\nDefines the URL for subsequent API requests. Returns an [Axios][axios] client.\n\nAPI requests can be sent without an explicit connection, using the environment\ndefaults from [environment configs][config]. It is called implicitly by all\nrequests, so it only needs to be called explicitly to set a new host, or one\nthat's different from the env defaults.\n\n```ts\nconst local = await API.get('channels.list') // env url (default localhost)\nAPI.client('https://my.live.server') // changes target of following requests\nconst live = await API.get('channels.list') // will request from my.live.server\n```\n\n#### `.login([credentials])` and `.logout()`\n\nLogin is required before making requests to any endpoints that need\nauthorisation. Refer to the [Rest API docs][rest-docs], but most do.\n\nCredentials object can be undefined or: `{ username: string, password: string }`\n\nLogin without credentials will use defaults from [environment configs][config].\n\n```ts\nAPI.login({ username: 'admin', password: 'pass' })\n```\n\n#### `.loggedIn`\n\nProperty contains a boolean of the login status.\n\n#### `.request(method, endpoint[, data, auth, ignore])`\n\nMake a request to your Rocket.Chat instance API.\n\n**Endpoint** appended to the client URL, with `/api/v1` included.\n**Method** can be `'POST' | 'GET' | 'PUT' | 'DELETE'`\n**Data** can be an object to post or convert to query params for get requests.\n**Auth** is a boolean to set if the endpoint requires auth (default true).\n**Ignore** optional RegExp for expected error messages to prevent throwing.\n\n```ts\n// basic server info does not require auth\nawait API.request('GET', 'info', {}, false)\n\n// get auth and request user list with query params\nawait API.login()\nconst users = await API.request('GET', 'users.list', {\n  fields: { 'username': 1 },\n  query: { type: { $in: ['user'] } }\n})\n```\n\n#### `.get(endpoint[, data, auth, ignore])`\n\nProxy for `.request('GET', ...arguments)`\n\n#### `.post(endpoint[, data, auth, ignore])`\n\nProxy for `.request('POST', ...arguments)`\n\n#### `.put(endpoint[, data, auth, ignore])`\n\nProxy for `.request('PUT', ...arguments)`\n\n#### `.del(endpoint[, data, auth, ignore])`\n\nProxy for `.request('DELETE', ...arguments)`\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/Amazebot/rocket-control/issues"}}