{"_id":"@alme-es/api-ts","_rev":"2-face9428996150410a4c7d90adbd40b0","name":"@alme-es/api-ts","dist-tags":{"latest":"0.1.4"},"versions":{"0.1.4":{"name":"@alme-es/api-ts","version":"0.1.4","description":"Typescript Alme Rest API","author":{"name":"Verint Systems"},"license":"MIT","private":false,"main":"./index.ts","jest":{"coverageReporters":["json-summary","text","lcov"]},"scripts":{"build":"tsc --build","clean":"tsc --build --clean","lint":"tslint -c tslint.json './**/*.ts'","test":"jest --ci --reporters=default --reporters=jest-junit","coverage":"jest --coverage"},"repository":{"type":"git","url":"git@gitlab.nextnet.com:clients/baseline/ts-libs/alme-api-ts.git"},"dependencies":{"@alme-es/types":"^0.1.3"},"devDependencies":{"@types/fetch-mock":"^7.3.1","@types/jest":"^24.0.22","@types/node":"^12.12.6","@types/node-fetch":"^2.5.3","fetch-mock":"^7.7.3","jest":"^24.8.0","jest-junit":"^6.4.0","node-fetch":"^2.6.0","ts-jest":"^24.0.2","ts-node":"^8.3.0","tslint":"^5.20.1","typescript":"^3.7.2"},"gitHead":"e531670a68b6cc252a206f44ed723ba7d62797b1","_id":"@alme-es/api-ts@0.1.4","_nodeVersion":"10.17.0","_npmVersion":"6.11.3","dist":{"integrity":"sha512-uPWQKyH610dYwWBHOuQSbmwiC0IpE+HrNZk5jv+xyoLmStor4Fj7PFZOq3CYY5jAufjog33I+WoaL3OWBUEhQg==","shasum":"acf927facd6b618f8f6e5193346c71f67d6c5494","tarball":"https://registry.npmjs.org/@alme-es/api-ts/-/api-ts-0.1.4.tgz","fileCount":84,"unpackedSize":137511,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd2En0CRA9TVsSAnZWagAAcmMP/j9BUC5Kuo/xmCdxv54P\nJPKE9B09VGE02SK1vzqsh5aRS0keUMetI+Alsat/Hy5K3uQvnE1R0hxXHlMV\ndjh2a5eeF4B5hTM9u+daqA4gHJi4PZ+tCmNfK1FhwfXUROLdknoV3wEnv0jc\nrOEkz/62ZtAt4IvIoxMuDVd+m6yMM30gjyBDtrpRWy/0Yn4uR59svQcB0rk9\n8yuyM6ql9BHl6m/tXbJ4lLJCQhHPSqnkxHDuzbXuY+SelkzLxWxiz3wEnvjg\njDaYpNi+Uz36o5h+3a6DXTwvnouH7zi96XdEDq9qOvtnRr1f+8Cq8EYOnBjA\nWjyM7dvx0Qi5zD+SQsK2wwIJ+3V1YuTd8X5ohSfDtnEqJO8qHMVDCmqn1nKP\nPNREzat5gSXHWnnVAwwnsxnFFv0+JeVjwrGb7C7xaxYo9tiFrOR9XTgy1z5j\nfW3cedtDdw+xaMA4CRVS15y1SK4wD2aFG3SrtFng41ZLfq0ibbu5oRCPvZA1\nIEHK9QaF1ZRLaenPYeJpufT9BA52MvfDLRH/1C23igpNV9KDj0TjspSyuGqh\nWYmLs46ZHQ59y3f5MI+qQ1RTNqO8AnbUpFzm+8rmmuFSZmX4DyWgAd+BHqIu\nppAo0P5cqpJLfnq8vPBFNnnpAmQVZUiEJsTTNk2q9FkHqJaEUhtTFFPjE0Xr\nbl/w\r\n=1woB\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICeufLiJGbfhHsyBFEW+sHTAhpnHrFB80GYFzjCdHsJRAiEAiucap2bTGbnp5LdP5mBwkkUD9n6cAiy24U9ZNHhaZrQ="}]},"maintainers":[{"name":"nextit-npm","email":"npm@nextit.com"}],"_npmUser":{"name":"nextit-npm","email":"npm@nextit.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/api-ts_0.1.4_1574455795952_0.4083713667605988"},"_hasShrinkwrap":false}},"time":{"created":"2019-11-22T20:49:55.503Z","0.1.4":"2019-11-22T20:49:56.109Z","modified":"2022-04-04T13:36:27.793Z"},"maintainers":[{"email":"scottpoconnor@gmail.com","name":"scotthew"},{"email":"npm@nextit.com","name":"nextit-npm"}],"description":"Typescript Alme Rest API","repository":{"type":"git","url":"git@gitlab.nextnet.com:clients/baseline/ts-libs/alme-api-ts.git"},"author":{"name":"Verint Systems"},"license":"MIT","readme":"# NIT Alme API\n\nThis module provides the api layer for interacting with Alme.\n\n## Features\n\n- [x] Provides Typescript implementation of Alme API\n\n## Installation\n\n### Npm\n\nAdd this module to the `dependencies` section of your `package.json`\n\n```json\n{\n  \"dependencies\": {\n    \"@alme-es/api-ts\": \"^0.0.0\"\n  }\n}\n```\n\nThen, run the following command:\n\n```bash\nnpm install\n```\n\n## Components\n\n### Settings\n\nThis module includes a set of default settings it needs to function. These settings may be partially or completely overridden.\n\n#### List of Default Settings\n\n```javascript\n// Default request settings.  See AlmeApiSettings.ts\nlet apiSettings: IAlmeApiSettings = {\n    AlmeApiProtocol: 'https://',\n    AlmeApiHostname: (globalThis && globalThis.location && globalThis.location.hostname) || (window && window.location && window.location.hostname) || 'unknown',\n    AlmeApiBasePath:'/AlmeAPI/api/',\n    AlmeApiRequestTimeout: 10000,\n    AlmeApiConversationRoot: 'Conversation',\n    AlmeApiConversePath: '/Converse',\n    AlmeApiAppEventPath: '/AppEvent',\n    AlmeApiReportingEventPath: 'Conversation/ReportingEvent',\n    AlmeApiRequestUnitPath: '/RequestUnit',\n    AlmeApiConverseEndpoint: 'Conversation/Converse',\n    AlmeApiAppEventEndpoint: 'Conversation/AppEvent',\n    AlmeApiRequestUnitEndpoint: 'Conversation/RequestUnit',\n    AlmeApiGetHistoryEndpoint: 'ConversationSupport/GetHistory',\n    AlmeApiReportingEventEndpoint: 'Conversation/ReportingEvent',\n    AlmeApiConfigurationEndpoint: 'Configuration/GetConfiguration',\n};\n```\n\n## Usage\n\nThe module exposes a class called `AlmeAPI` that accepts a\nlogger, httpHandler, and apiSettings.\n\n```javascript\nimport { AlmeApi } from '@alme-es/api-ts/build/AlmeApi';\nimport { IAlmeApiSettings } from '@alme-es/api-ts/build/Interfaces/IAlmeApiSettings';\nimport { AlmeApiSettings } from '@alme-es/api-ts/build/AlmeApiSettings';\nimport { HttpHandler } from '@alme-es/api-ts/build/HttpHandler';\n\nconst logger = console;\n\n// construct new settings and change the defaults.\nconst apiSettings: IAlmeApiSettings = new AlmeApiSettings();\napiSettings.AlmeApiHostname = 'your.AlmeApiDomain.com';\napiSettings.AlmeApiProtocol = 'https://';\n\nconst httpHandler: HttpHandler = new HttpHandler(logger, apiSettings);\nconst almeApi: AlmeApi = new AlmeApi(logger, httpHandler, apiSettings);\n\nexport default almeApi;\n```\n","readmeFilename":"README.md"}