{"_id":"@bennetgallein/billomat-ts","_rev":"1-43a12b6d00b1983c0f81aa6a66addc9f","name":"@bennetgallein/billomat-ts","dist-tags":{"latest":"0.4.0"},"versions":{"0.3.0":{"name":"@bennetgallein/billomat-ts","version":"0.3.0","description":"Billomat API implementation in TypeScript for use in Node.js","main":"dist/index.js","types":"dist/index.d.ts","dependencies":{"@types/superagent":"^4.1.10","superagent":"^6.1.0"},"devDependencies":{"@types/chai":"^4.2.15","@types/mocha":"^8.2.1","@types/nock":"^11.1.0","@types/proxyquire":"^1.3.28","@types/sinon":"^9.0.10","@typescript-eslint/eslint-plugin":"^4.15.1","@typescript-eslint/eslint-plugin-tslint":"^4.15.1","@typescript-eslint/parser":"^4.15.1","chai":"^4.3.0","eslint":"^7.20.0","eslint-config-google":"^0.14.0","eslint-config-prettier":"^7.2.0","eslint-plugin-jsdoc":"^32.0.2","eslint-plugin-prefer-arrow":"^1.2.3","eslint-plugin-prettier":"^3.3.1","mocha":"^8.3.0","nock":"^13.0.7","npm-run-all":"^4.1.5","proxyquire":"^2.1.3","sinon":"^9.2.4","ts-node":"^9.1.1","typescript":"^4.1.5"},"scripts":{"lint":"eslint . --ext .js,.ts,.spec.js,.spec.ts","test":"mocha --require ts-node/register --extensions ts 'src/**/*.spec.ts'","build":"tsc","prepare":"run-s build","prepublishOnly":"run-p lint test","preversion":"run-s lint","version":"git add -A src","postversion":"git push && git push --tags"},"author":{"name":"Seibert Media GmbH"},"keywords":["billomat","api","client","accounting"],"license":"MIT","bugs":{"url":"https://github.com/seibert-media/billomat-ts/issues"},"homepage":"https://github.com/seibert-media/billomat-ts/blob/master/README.md","repository":{"type":"git","url":"git+ssh://git@github.com/seibert-media/billomat-ts.git","directory":"."},"gitHead":"0abf1206834c8fbba2ed09d919b0f6e8b13888dd","_id":"@bennetgallein/billomat-ts@0.3.0","_nodeVersion":"16.13.2","_npmVersion":"8.1.2","dist":{"integrity":"sha512-nZB2X6nbj94bJxjjrs45Da3XDY/QBUUNMZCCjp3FNg/DM6M8gvw2CW5SM4FdyRbmd9kobcnUd0HIWzPGbZTOzg==","shasum":"70f0b952a922700adb233f787ed83a7e2f977e00","tarball":"https://registry.npmjs.org/@bennetgallein/billomat-ts/-/billomat-ts-0.3.0.tgz","fileCount":13,"unpackedSize":31843,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCKPuRzWOvtv4wvMjaMz6fxkhh8oGFbpri306UxwmpnegIhANaW0TbVLEGuUE3ywLD3p0KXJJO4nipKQLa7804pHUo4"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJi7CB8ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqAiRAAnn+SxnLvhcX20OjrkvhPbxeOWiKKFdGcf/2owCyv3i6DOLSu\r\nFj0wOlv2J2AG/NPAystxCVYRabrV0AOA6X87shIVzZWGuYwD/KxeiWtx5lrX\r\nkU4UxgqCSgL2c8B937Z4h2NwgWkZpK9+3uHrNqJypBdwRHBVPBuzOuzd1T7s\r\nLxIhEU9cOoQuNXFqPCkVVMNN9pMLK9Zu4qn3wuv3z7+SU4hdM4PQsM6ErP78\r\nY+Q7Akd5iAZ9g9rdvONoutGrtA1Ghi+kREDqhErwWbbu5K+lOkWqHtFsdWzg\r\nFw8uxauCmturQfHlOfw0XcGzpXsRIwTP60C/nnKm2QxC/m/jWL9fIH1neQpE\r\n1ubX1lEk9VScCQo0dia0YLdX42siCv+YiiYbayhld7+cTE6aGMStLeL/skle\r\njbNycB/5zR4M6FbwzEYziSoYLQdV4fDt4cgDQAfuKE87h0eOwqz8gR8+wqFX\r\n0rW8MTWxiodjmfzuGi10iUZW0oyybq8bIJzvkhFX+sUJiuVR8K9mH4+ccf7i\r\nUF7Jc67NelNTYKFnbjd6hzWQ8AOIHaIELnZAgvM6V1dbfJHD7hJKHVwik2/8\r\nt05YU5yHwr9oiOCuHCFL6EAhOX1CZFt6bM82B34Qnq0QMzrX9EFY4aw7z02R\r\nyqWkhBEnVQKUvy2mok/uxklH/b0mhoFSgfo=\r\n=tYw+\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"bennetgallein","email":"bg@esyoil.com"},"directories":{},"maintainers":[{"name":"bennetgallein","email":"bg@esyoil.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/billomat-ts_0.3.0_1659641980755_0.8748603449986632"},"_hasShrinkwrap":false},"0.4.0":{"name":"@bennetgallein/billomat-ts","version":"0.4.0","description":"Billomat API implementation in TypeScript for use in Node.js","main":"dist/index.js","types":"dist/index.d.ts","dependencies":{"@types/superagent":"^4.1.10","superagent":"^6.1.0"},"devDependencies":{"@types/chai":"^4.2.15","@types/mocha":"^8.2.1","@types/nock":"^11.1.0","@types/proxyquire":"^1.3.28","@types/sinon":"^9.0.10","@typescript-eslint/eslint-plugin":"^4.15.1","@typescript-eslint/eslint-plugin-tslint":"^4.15.1","@typescript-eslint/parser":"^4.15.1","chai":"^4.3.0","eslint":"^7.20.0","eslint-config-google":"^0.14.0","eslint-config-prettier":"^7.2.0","eslint-plugin-jsdoc":"^32.0.2","eslint-plugin-prefer-arrow":"^1.2.3","eslint-plugin-prettier":"^3.3.1","mocha":"^8.3.0","nock":"^13.0.7","npm-run-all":"^4.1.5","proxyquire":"^2.1.3","sinon":"^9.2.4","ts-node":"^9.1.1","typescript":"^4.1.5"},"scripts":{"lint":"eslint . --ext .js,.ts,.spec.js,.spec.ts","test":"mocha --require ts-node/register --extensions ts 'src/**/*.spec.ts'","build":"tsc","prepare":"run-s build","prepublishOnly":"run-p lint test","preversion":"run-s lint","version":"git add -A src","postversion":"git push && git push --tags"},"author":{"name":"Seibert Media GmbH"},"keywords":["billomat","api","client","accounting"],"license":"MIT","bugs":{"url":"https://github.com/seibert-media/billomat-ts/issues"},"homepage":"https://github.com/seibert-media/billomat-ts/blob/master/README.md","repository":{"type":"git","url":"git+ssh://git@github.com/seibert-media/billomat-ts.git","directory":"."},"gitHead":"90804c9521526689c0df385f7eaf37563d083fda","_id":"@bennetgallein/billomat-ts@0.4.0","_nodeVersion":"16.13.2","_npmVersion":"8.1.2","dist":{"integrity":"sha512-ZNdCgdWbdsES924+6pexTKy6GgU1Mm6JTg0iEs87xsjNBY+ITM5mJhaNiOx0r05/NJllBh4urfObbif1IlpmJA==","shasum":"bdb40679814144452d706c5095e14b3045ec123a","tarball":"https://registry.npmjs.org/@bennetgallein/billomat-ts/-/billomat-ts-0.4.0.tgz","fileCount":13,"unpackedSize":32167,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCF6yZyY40vdxgHrHjeD0685bSO90KIgitlHQ0fPK379wIgRE3cHwdZkz2L+/W/xxkmlaFud2KK+tL5HW17BevrD0U="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJi7CX1ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoaKA//WZU/9tOTND5MdwmYKeY0Qu/1m1Qk9dqAXrSsQHEm3aSENqCQ\r\nr4OB3WlNIn4n8MXlZH/vIbt/FJFLRrOBWIKO5EDxR70BzSKPdEQaOkBPjs8u\r\ny6YG/8W70bI2UNpyl2r6RCHCgp7HVmjuAfQNLjGP07Hk39O5MYVOU0SSD7LL\r\nKjFeUUO4oXvQ6uinulW7OGF1wHdhY+I96cEfvW6oa2woVmToQXiho1YjvAam\r\nu0IY2P3vyiVrjxQa0KN/Zr4UiXex9uiPhs/vAsuoR/g4pMjWQYSLhnjVFlZk\r\nBtJLOJsKdyEKSRL9SI5dDlDDWNILY4+hDeWPetJFzNDs8x3aBxsh4oXwT0Eh\r\nd/oKz/75LJ51iCu3BH8WYoO/4hew4ZIMEB4NdgwyFQSi2hfJRwY2SgetkKUt\r\n00526Ro3fgSaU0LLt/GkLAOWntM1cYiBeMFZ7/KgCNwPvX9ygbFb75dB3AIy\r\nsBHCRRI1+dhdRb7tKw8E2bK+JAi3ASLRQR61Zt4z1s/OtTY285MR7iJzjN3R\r\niOexBEEwxZJtafTqwIcbxejSkhTWmuhwqdjiZQ/ouBYs3CAonsSMWhXDrbSN\r\ngdot2WNJ+7nY/SXBhC9hINBGmLB9KMGO58CX88GeDxoh+mUkGJqWYlKXdiXw\r\n8wELfInsqeIRKfUlAU8+nyzodsCiPXzCl6c=\r\n=MtFh\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"bennetgallein","email":"bg@esyoil.com"},"directories":{},"maintainers":[{"name":"bennetgallein","email":"bg@esyoil.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/billomat-ts_0.4.0_1659643381614_0.8763267915670643"},"_hasShrinkwrap":false}},"time":{"created":"2022-08-04T19:39:40.691Z","0.3.0":"2022-08-04T19:39:40.920Z","modified":"2022-08-04T20:03:01.895Z","0.4.0":"2022-08-04T20:03:01.806Z"},"maintainers":[{"name":"bennetgallein","email":"bg@esyoil.com"}],"description":"Billomat API implementation in TypeScript for use in Node.js","homepage":"https://github.com/seibert-media/billomat-ts/blob/master/README.md","keywords":["billomat","api","client","accounting"],"repository":{"type":"git","url":"git+ssh://git@github.com/seibert-media/billomat-ts.git","directory":"."},"author":{"name":"Seibert Media GmbH"},"bugs":{"url":"https://github.com/seibert-media/billomat-ts/issues"},"license":"MIT","readme":"# billomat-ts\n\n![npm version](https://img.shields.io/npm/v/billomat-ts)\n![npm bundle size](https://img.shields.io/bundlephobia/min/billomat-ts)\n![GitHub repo size](https://img.shields.io/github/repo-size/seibert-media/billomat-ts)\n![GitHub contributors](https://img.shields.io/github/contributors/seibert-media/billomat-ts)\n![Twitter Follow](https://img.shields.io/twitter/follow/seibertmedia?style=social)\n![License](https://img.shields.io/npm/l/billomat-ts)\n\n`billomat-ts` is a library that allows TypeScript developers to connect to the popular online accounting software [Billomat](https://www.billomat.com/).\n\nThere's realistic mock data for the [client](https://www.billomat.com/en/api/clients/), [client property value](https://www.billomat.com/en/api/clients/properties/), [confirmations](https://www.billomat.com/en/api/confirmations/) and [invoice data](https://www.billomat.com/en/api/invoices/) types in Billomat's API. It follows that those data types are most likely to work as expected. All other data types are likely to work well though. If you want to contribute, please read [our contributing guidelines](CONTRIBUTING.md).\n\n## Prerequisites\n\nBefore you begin, ensure you have met the following requirements:\n\n-   You have installed the latest version of `node` and `npm`\n-   You have read Billomat's own documentation about their API\n-   [You have authentication information ready](https://www.billomat.com/en/api/basics/authentication/). [You'll likely want to configure an app inside of Billomat](https://www.billomat.com/en/api/basics/rate-limiting/). Make sure you have the base url to your Billomat instance, and an API key. If you go ahead an configure an app, you can also pass your app secret and app id into `billomat-ts`.\n\n## Installing `billomat-ts`\n\nTo install `billomat-ts`, simply run:\n\n```bash\nnpm install billomat-ts\n```\n\n## Using `billomat-ts`\n\nFor information on how to use `billomat-ts`, have a look at this example:\n\n```typescript\nimport { Billomat, getBillomatApiClient } from 'billomat-ts';\nimport { readFileSync } from 'fs';\n\nconst config = JSON.parse(readFileSync('config.json', 'utf-8'));\nconst billomat = getBillomatApiClient(config);\n\nbillomat.clients\n    .list()\n    .then((clients: Billomat.Client[]) =>\n        clients.map((client: Billomat.Client) => client.name).map((name) => console.log(name))\n    )\n    .catch(console.error);\n```\n\n`billomat-ts` currently supports `list`, `get`, `create`, and `edit` operations on all known data types. The `list` functions accept query arguments, etc. In case these methods don't satisfy your requirements, you can instead use the `raw` method to perform your own requests.\n\n## Contact\n\nIf you want to contact me you can reach me at jrost@seibert-media.net. Also feel free to open an issue if you find a bug or have a question.\n\n## License\n\nThis project uses the [MIT](https://opensource.org/licenses/MIT) license.\n","readmeFilename":"README.md"}