{"_id":"@airbank/gmi-sdk","name":"@airbank/gmi-sdk","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@airbank/gmi-sdk","author":{"name":"Ali Turki","email":"ali@joinairbank.com"},"version":"1.0.0","main":"lib/index.js","typings":"lib/index.d.ts","directories":{"lib":"lib"},"bugs":{"url":"https://github.com/joinairbank/airbank/issues"},"homepage":"https://joinairbank.github.io/airbank/","repository":{"type":"git","url":"git+https://github.com/joinairbank/airbank.git"},"publishConfig":{"access":"public"},"scripts":{"start":"ts-node src/index.ts","tsc":"tsc"},"license":"MIT","devDependencies":{"ts-node":"^10.7.0"},"dependencies":{"axios":"^0.27.2"},"description":"## Installation ```sh yarn add @airbank/gmi-sdk ``` ## Setup","_id":"@airbank/gmi-sdk@1.0.0","_nodeVersion":"14.19.0","_npmVersion":"6.14.16","dist":{"integrity":"sha512-If/TAGF93ORuLNRmNIBoxCzY/E5qd6aWcQ1CuyVXs0X9TjtZU0g5xdOtJ+uHJdMxYsttcEGsXLmSbK36j9Gswg==","shasum":"84525088ebc9560e0a120f3fc6d1af9038e9a64c","tarball":"https://registry.npmjs.org/@airbank/gmi-sdk/-/gmi-sdk-1.0.0.tgz","fileCount":14,"unpackedSize":19610,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCImnqWRNjmh/+iEduhvjsqCr+IN0mGgHWIM82TitqlUgIhAIG0btFwHb0BDAZHfaLUQODMvg7DI/HhhW8HF+7zIp/5"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJifajtACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpuKQ/+KP2oz5S9eSyIHpUb6lhBlqO2ZoDj4g71w6urFKml0iMbDjp3\r\n8izRgK4YNy5xfF1wtvdJVFr2k97nbKxROKFxykwU20VxLr2V5fPi697tgY/j\r\nUdJB5KKVBs4O+kkyAGgDpZYuikxD4DZKpXXs+HNT13y8+xaiqCniJM4Ffbmq\r\nTqDNpY9DYg58b6YXq560vk8tFWn27xPKQ0j9SwG4gicieq2Fy/Q6vCgxOX4T\r\nTJTE3m8JrFKANXRMKB5K9dex9TjJ9vNsGxdOF/AHBGKBTC5QZn/gKC5o/DGe\r\nbQ/SCDerQzwmUl9iE1pBy1jR1h4VdJKuwf3lDBgjhG+p0/7oqTcMAn0AIkA/\r\nLtyBAkiEvLz4/GMFgs78aJyizL2MU4qmHRnK6qyJpSW2txyjnxEkWQct02hS\r\nuvmi6Lwh3iDjyGiiJ6hg7Fz8gj22igWk7jRaRvjd9rePeY8DQ0SQeOKTYWrB\r\nxgRK1vTZQU4tkyNhjR9xPWaIhqFuAhlHMlAULhjClA+bOhwomC3hWr576c2S\r\n6CiIxxUdf+zBX3x6yi9uZN/BXlifbqoJGP3CQDxF+sZdVko+iirpJJYzV3AX\r\ngim3coq6XMRDcHj8SXgdvKIXxgB6ToEhtN1I4FaJnN6O7CL9k1N+e/s2LKyT\r\nv9jnUkLIkXpYu7iltLwwC5SGW5QeWElRAP8=\r\n=QOCq\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"barakat","email":"ali@turkii.me"},"maintainers":[{"name":"barakat","email":"ali@turkii.me"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/gmi-sdk_1.0.0_1652402412891_0.9159852981661325"},"_hasShrinkwrap":false}},"time":{"created":"2022-05-13T00:40:12.839Z","1.0.0":"2022-05-13T00:40:13.225Z","modified":"2022-05-13T00:40:13.382Z"},"maintainers":[{"name":"barakat","email":"ali@turkii.me"}],"description":"## Installation ```sh yarn add @airbank/gmi-sdk ``` ## Setup","homepage":"https://joinairbank.github.io/airbank/","repository":{"type":"git","url":"git+https://github.com/joinairbank/airbank.git"},"author":{"name":"Ali Turki","email":"ali@joinairbank.com"},"bugs":{"url":"https://github.com/joinairbank/airbank/issues"},"license":"MIT","readme":"# @airbank/gmi-sdk\n\n## Installation\n```sh\nyarn add @airbank/gmi-sdk\n```\n## Setup\n\nFirst you need to setup your api key\n\n```ts\nimport getMyInvoices from \"@airbank/gmi-sdk\";\n\ngetMyInvoices.init({\n  apiKey: \"0up1-o2br-nrcv-5mrw-zh0a-0m7s-v536\",\n  mode: \"production\",\n});\n```\n\nThere are two values of `mode`: `production` and `sandbox` the default value.\n\n## Actions\n\n### Create account\n\nCreate a new account.\n\n```ts\nconst response = await getMyInvoices.createAccount({\n  companyName: \"GetMyInvoices\",\n  email: \"max.mustermann@example.org\",\n  password: \"56NBRh8sZLxuJrF\",\n  firstname: \"Max\",\n  lastname: \"Mustermann\",\n  package: \"package_key\",\n  paymentInterval: \"monthly\",\n  country: 28715,\n  language: \"de\",\n  externalId: \"10001\",\n  trialAccount: true,\n});\n```\n\n#### Input\n\n| key             | Type    | Required | Default | Enum                 |\n| --------------- | ------- | -------- | ------- | -------------------- |\n| companyName     | string  | True     |         |                      |\n| email           | string  | True     |         |                      |\n| password        | string  | False    |         |                      |\n| firstname       | string  | True     |         |                      |\n| lastname        | string  | False    |         |                      |\n| package         | string  | True     |         |                      |\n| paymentInterval | string  | False    | monthly | \"monthly\" , \"yearly\" |\n| country         | number  | True     |\n| language        | string  | True     |         | \"de\" , \"en\"          |\n| externalId      | string  | False    |         |                      |\n| trialAccount    | boolean | False    |         |                      |\n\n#### Response Example\n\n```json\n// response\n{\n  \"success\": true,\n  \"accountPrimUid\": 100,\n  \"userPrimUid\": 110\n}\n```\n\n### Create GetMyInvoices API key\n\nCreate a new API key for that account\n\n```ts\nconst accountPrimUid = 100;\nconst response = await getMyInvoices.createAccountsAPIKey(accountPrimUid, {\n  apiPermission: \"FULL_PERMISSION\",\n  note: \"This is note\",\n});\n```\n\n#### Response Example\n\n```json\n{\n  \"success\": true,\n  \"apiKeyUid\": 42448,\n  \"accountsApiKey\": \"gt1h-k8et-xe55-3g82-0gpo-c5sw-stuc\",\n  \"apiPermission\": \"FULL_PERMISSION\",\n  \"note\": \"This is note\"\n}\n```\n\n### Get account\n\nGet data for one account.\n\n```ts\nconst accountPrimUid = 100;\nconst response = await getMyInvoices.getAccount(accountPrimUid);\n```\n\n#### Response Example\n\n```json\n{\n  \"accountPrimUid\": 1,\n  \"externalId\": 10001,\n  \"companyName\": \"GetMyInvoices\",\n  \"email\": \"max.mustermann@example.org\",\n  \"active\": true,\n  \"package\": \"\",\n  \"paymentInterval\": \"monthly\",\n  \"addons\": \"[{'key': 'addon_key', 'amount': 5}]\",\n  \"country\": 28715,\n  \"language\": \"de\",\n  \"locked\": false,\n  \"numberOfOnlinePortals\": 8,\n  \"usesEmailImport\": false,\n  \"usesInbox\": true,\n  \"created\": \"2018-01-03\",\n  \"lastLogin\": \"2018-01-03 14:00:00\"\n}\n```\n\n### Activate account\n\nActivate an account.\n\n```ts\nconst accountPrimUid = 100;\nconst response = await getMyInvoices.activateAccount(accountPrimUid);\n```\n\n#### Response Example\n\n```json\n{\n  \"success\": true\n}\n```\n\n### Activate account\n\nDeactivate an account.\n\n```ts\nconst accountPrimUid = 100;\nconst response = await getMyInvoices.deactivateAccount(accountPrimUid);\n```\n\n#### Response Example\n\n```json\n{\n  \"success\": true\n}\n```\n\n### Delete account\n\nDelete an account.\n\n```ts\nconst accountPrimUid = 100;\nconst response = await getMyInvoices.deleteAccount(accountPrimUid);\n```\n\n#### Response Example\n\n```json\n{\n  \"success\": true\n}\n```\n\n### Get country list\n\nGet list of all available countries.\n\n```ts\nconst response = await getMyInvoices.getCountries();\n```\n\n#### Response Example\n\n```json\n[\n  {\n    \"primUid\": 28715,\n    \"name\": \"Germany\"\n  },\n  {\n    \"primUid\": 28718,\n    \"name\": \"United Kingdom\"\n  }\n]\n```\n","readmeFilename":"README.md"}