{"_id":"axway-requester","_rev":"42-0b340c3cb0f6d07aa42dd776be824bf4","name":"axway-requester","dist-tags":{"latest":"1.0.1","next":"1.0.2-1","v4-preview1":"2.0.0-2","v4-preview3":"2.0.0-5","v4-preview2":"2.0.0-5"},"versions":{"1.0.0":{"name":"axway-requester","version":"1.0.0","keywords":["http","api","utilities"],"author":{"url":"https://axway.com","name":"Axway R&D","email":"support@axway.com"},"_id":"axway-requester@1.0.0","maintainers":[{"name":"axway","email":"gmatthews@axway.com"}],"nyc":{"exclude":["src/index.js","src/auth.js","src/superagent/index.js"],"include":"src"},"dist":{"shasum":"8a5d2156d68fe047ebadb546f5c26dd34962a3e7","tarball":"https://registry.npmjs.org/axway-requester/-/axway-requester-1.0.0.tgz","integrity":"sha512-VntYS6yciChZ+qyi75YQYzwu0e3FbM0QiPzxnMgi6YNhJhCRUQgt9uJV5pHv79yyM2omJsBlQAgwga0QrxtFXQ==","signatures":[{"sig":"MEUCIQCaL8Zl14pjeKUjXN/WmV+WE2Z6pHMRhKFyVWjUJO4hIgIgBvXEQDzRw9cMtplF075own36nUJluHJnPybSN0wUIUU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"dist/index.js","files":["dist"],"scripts":{"all":"npm i && npm run clean && npm run lint:fix && npm run test && npm run build:dist && npm run security && npm run check:dependencies","test":"npm run clean:test && cross-env NODE_ENV=test npm run test:unit","build":"npm run clean && npm run build:dev && npm run check:dependencies && npm run security","clean":"rimraf dist coverage .nyc-output","lint:fix":"standard --fix | snazzy","posttest":"nyc check-coverage --lines 80 --branches 80 --functions 80","security":"npm run security:retire && npm run security:nsp","build:dev":"npm run build:lint && npm run test && npm run build:dist","test:unit":"tap test/unit/* --bail --coverage-report=html | tap-mocha-reporter spec","transpile":"babel -d ./dist ./src","build:dist":"npm run transpile","build:lint":"standard | snazzy","clean:test":"rimraf coverage .nyc-output","release:npm":"curl -X GET http://registry.ecd.axway.int:8081/artifactory/local-npm/$npm_package_name/-/$npm_package_name-$npm_package_version.tgz 2>/dev/null > $npm_package_name-$npm_package_version.tgz && npm publish --registry  https://registry.npmjs.org ./$npm_package_name-$npm_package_version.tgz && rm ./$npm_package_name-$npm_package_version.tgz","security:nsp":"nsp check --reporter json > scan-nsp.json --warn-only","release:major":"npm version major && npm run release:publish && git push --follow-tags","release:minor":"npm version minor && npm run release:publish && git push --follow-tags","release:patch":"npm version patch && npm run release:publish && git push --follow-tags","release:publish":"git add -A && git push && git push --tags && npm publish","security:retire":"retire --exitwith 0 --package --jspath ./dist --nodepath ./ --outputformat json --outputpath scan-retire.json","test:integration":"tap test/integration/* --bail --coverage-report=html | tap-mocha-reporter spec","check:dependencies":"npm-check || exit 0","release:prerelease":"npm version prerelease && npm run release:publish && git push --follow-tags"},"_npmUser":{"name":"axway","email":"gmatthews@axway.com"},"standard":{"ignore":[".nyc_output",".vscode","coverage","node_modules","dist"]},"repository":{"url":"https://git.ecd.axway.int/Api-Builder/axway-requester","type":"git"},"_npmVersion":"5.6.0","description":"Module for HTTP requests","directories":{},"_nodeVersion":"8.9.1","dependencies":{"superagent":"3.8.2"},"devDependencies":{"nsp":"3.1.0","nyc":"11.3.0","tap":"11.0.0","sinon":"4.1.3","retire":"1.4.0","rimraf":"2.6.2","snazzy":"7.0.0","mockery":"2.1.0","standard":"10.0.3","babel-cli":"6.26.0","cross-env":"5.1.1","npm-check":"5.5.2","babel-core":"6.26.0","tap-mocha-reporter":"3.0.6","babel-preset-es2015":"6.24.1","babel-preset-stage-2":"6.24.1"},"_npmOperationalInternal":{"tmp":"tmp/axway-requester-1.0.0.tgz_1513248625499_0.10188099951483309","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"axway-requester","version":"1.0.1","keywords":["http","api","utilities"],"author":{"url":"https://axway.com","name":"Axway R&D","email":"support@axway.com"},"_id":"axway-requester@1.0.1","maintainers":[{"name":"axway","email":"gmatthews@axway.com"}],"nyc":{"exclude":["src/index.js","src/auth.js","src/superagent/index.js"],"include":"src"},"dist":{"shasum":"53f12cbfd0a92359d5513ee6b2e7efd22399d6b6","tarball":"https://registry.npmjs.org/axway-requester/-/axway-requester-1.0.1.tgz","integrity":"sha512-sQV0NHls0zdyJdr3XK0MMZZMRDPyLvvJ+Qx3dc3qDwmNyPQ+q9N7CoEsf488+5IM5ey86EZhSf7a1JNdPcNN/A==","signatures":[{"sig":"MEQCIDaeHPd0Tz4vw7SavxMnEoZ0is1kfzjx/BerUsgH9uJ3AiAis+OPwOfnjsW9KS3rKkdSGFJLWWE8bjj4ClCzsjubIg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"dist/index.js","files":["dist"],"scripts":{"all":"npm i && npm run clean && npm run lint:fix && npm run test && npm run build:dist && npm run security && npm run check:dependencies","test":"npm run clean:test && cross-env NODE_ENV=test npm run test:unit","build":"npm run clean && npm run build:dev && npm run check:dependencies && npm run security","clean":"rimraf dist coverage .nyc-output","lint:fix":"standard --fix | snazzy","posttest":"nyc check-coverage --lines 80 --branches 80 --functions 80","security":"npm run security:retire && npm run security:nsp","build:dev":"npm run build:lint && npm run test && npm run build:dist","test:unit":"tap test/unit/* --bail --coverage-report=html | tap-mocha-reporter spec","transpile":"babel -d ./dist ./src","build:dist":"npm run transpile","build:lint":"standard | snazzy","clean:test":"rimraf coverage .nyc-output","release:npm":"curl -X GET http://registry.ecd.axway.int:8081/artifactory/local-npm/$npm_package_name/-/$npm_package_name-$npm_package_version.tgz 2>/dev/null > $npm_package_name-$npm_package_version.tgz && npm publish --registry  https://registry.npmjs.org ./$npm_package_name-$npm_package_version.tgz && rm ./$npm_package_name-$npm_package_version.tgz","security:nsp":"nsp check --reporter json > scan-nsp.json --warn-only","release:major":"npm version major && npm run release:publish && git push --follow-tags","release:minor":"npm version minor && npm run release:publish && git push --follow-tags","release:patch":"npm version patch && npm run release:publish && git push --follow-tags","release:publish":"git add -A && git push && git push --tags && npm publish","security:retire":"retire --exitwith 0 --package --jspath ./dist --nodepath ./ --outputformat json --outputpath scan-retire.json","test:integration":"tap test/integration/* --bail --coverage-report=html | tap-mocha-reporter spec","check:dependencies":"npm-check || exit 0","release:prerelease":"npm version prerelease && npm run release:publish && git push --follow-tags"},"_npmUser":{"name":"axway","email":"gmatthews@axway.com"},"standard":{"ignore":[".nyc_output",".vscode","coverage","node_modules","dist"]},"repository":{"url":"https://git.ecd.axway.int/Api-Builder/axway-requester","type":"git"},"_npmVersion":"5.6.0","description":"Module for HTTP requests","directories":{},"_nodeVersion":"8.9.1","dependencies":{"superagent":"3.8.2"},"devDependencies":{"nsp":"3.1.0","nyc":"11.4.1","tap":"11.0.0","sinon":"4.1.3","retire":"1.4.0","rimraf":"2.6.2","snazzy":"7.0.0","mockery":"2.1.0","standard":"10.0.3","babel-cli":"6.26.0","cross-env":"5.1.1","npm-check":"5.5.2","babel-core":"6.26.0","tap-mocha-reporter":"3.0.6","babel-preset-es2015":"6.24.1","babel-preset-stage-2":"6.24.1"},"_npmOperationalInternal":{"tmp":"tmp/axway-requester-1.0.1.tgz_1513853012784_0.6966211388353258","host":"s3://npm-registry-packages"}},"1.0.2-1":{"name":"axway-requester","version":"1.0.2-1","keywords":["http","api","utilities"],"author":{"url":"https://axway.com","name":"Axway R&D","email":"support@axway.com"},"_id":"axway-requester@1.0.2-1","maintainers":[{"name":"axway","email":"gmatthews@axway.com"}],"nyc":{"exclude":["src/index.js","src/auth.js"],"include":"src"},"dist":{"shasum":"162facfd5988ebead38fd1866e5c6cf492022571","tarball":"https://registry.npmjs.org/axway-requester/-/axway-requester-1.0.2-1.tgz","fileCount":7,"integrity":"sha512-OxlhDHlGBf8aZr1x6TKqX5fWJfzupZm1yD3BRP/Z80+dQkd97UOOB1UNwfSRbNQ8ev6WLUf76bPiHzJkgs9qOg==","signatures":[{"sig":"MEUCIQC9SBhyjxvPhPkQ0eNRMJcaCWRa7XP9joIArhjqujh7GgIgIfqsiaxSVu8c2VHQtM7wEKd16z8CR/ECk6P4elx1jPA=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":24717},"main":"dist/index.js","files":["dist"],"readme":"# axway-requester\n\nModule for HTTP requests based on Axway technology. \n\n[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)\n\n## Building\n\n```bash\nnpm run build\n```\n\n## Project Info\n\nThis is the module we use to communicate with the third party APIs e.g. Twilio. \nUsually we could use sdk or a module like request. \nHowever in the case of OpenApi Service Connectors based on Axway, we use __superagent__.\n\nTo sum up the module info:\n\n* Responsible for HTTP communication with various APIs. \n\n* Uses Axway technology under the hood.\n\n* Facade to Axway technology used in all OpenApi Service Connectors.\n\n### Configuration parameters\nThe following table represent all available configuration parameters.\n\n| __Config params__    | __Description__|\n|-------------------|-------------------|\n|_**'x-vendor-openapi-authtype'**_|authentication type i.e. __basic__, __apiKey__ or __oAuth2__|\n|_**'x-vendor-openapi-username'**_|basic authentication type requires to provide username|\n|_**'x-vendor-openapi-password'**_|basic authentication type requires to provide password|\n|_**'x-vendor-openapi-key'**_|apiKey authentication type requires to provide key|\n|_**'x-vendor-openapi-token'**_|oAuth2 authentication type requires to provide access token|\n|_**'x-vendor-openapi-uri'**_|uri is constructed by protocol e.g. HTTP, host i.e. server name and basePath|\n|_**'x-vendor-openapi-uri.protocol'**_|application protocol i.e. transfer protocol such as HTTP/HTTPs|\t\t\n|_**'x-vendor-openapi-uri.host'**_|server name|\n|_**'x-vendor-openapi-uri.port'**_|specifies the port on which the host system listens for requests. This parameter is optional. The default one will be set, depends on the protocol.|\n|_**'x-vendor-openapi-uri.basePath'**_|basePath is the path to the API/Api version etc.|\n\n## Author\n\nAxway R&D <support@axway.com> https://axway.com\n\n## License\n\nThis code is closed source and Confidential and Proprietary to Axway, Inc. All Rights Reserved. This code MUST not be modified, copied or otherwise redistributed without express written permission of Axway. This file is licensed as part of the Axway Platform and governed under the terms of the Axway license agreement. Your right to use this software terminates when you terminate your Axway subscription.\n","scripts":{"all":"npm i && npm run clean && npm run lint:fix && npm run test && npm run build:dist && npm run security && npm run check:dependencies","test":"npm run clean:test && cross-env NODE_ENV=test npm run test:unit","build":"npm run clean && npm run build:dev && npm run check:dependencies && npm run security","clean":"rimraf dist coverage .nyc-output","lint:fix":"standard --fix | snazzy","posttest":"nyc check-coverage --lines 80 --branches 80 --functions 80","security":"npm run security:retire && npm run security:nsp","build:dev":"npm run build:lint && npm run test && npm run build:dist","test:unit":"tap test/unit/* --bail --coverage-report=html | tap-mocha-reporter spec","transpile":"babel -d ./dist ./src","build:dist":"npm run transpile","build:lint":"standard | snazzy","clean:test":"rimraf coverage .nyc-output","release:npm":"curl -X GET http://registry.ecd.axway.int:8081/artifactory/local-npm/$npm_package_name/-/$npm_package_name-$npm_package_version.tgz 2>/dev/null > $npm_package_name-$npm_package_version.tgz && npm publish --registry  https://registry.npmjs.org ./$npm_package_name-$npm_package_version.tgz && rm ./$npm_package_name-$npm_package_version.tgz","security:nsp":"nsp check --reporter json > scan-nsp.json --warn-only","release:major":"npm version major && npm run release:publish && git push --follow-tags","release:minor":"npm version minor && npm run release:publish && git push --follow-tags","release:patch":"npm version patch && npm run release:publish && git push --follow-tags","release:publish":"git add -A && git push && git push --tags && npm publish","security:retire":"retire --exitwith 0 --package --jspath ./dist --nodepath ./ --outputformat json --outputpath scan-retire.json","test:integration":"tap test/integration/* --bail --coverage-report=html | tap-mocha-reporter spec","check:dependencies":"npm-check || exit 0","release:prerelease":"npm version prerelease && npm run release:publish && git push --follow-tags"},"_npmUser":{"name":"axway","email":"gmatthews@axway.com"},"standard":{"ignore":[".nyc_output",".vscode","coverage","node_modules","dist"]},"repository":{"url":"https://git.ecd.axway.int/Api-Builder/axway-requester","type":"git"},"_npmVersion":"5.6.0","description":"Module for HTTP requests","directories":{},"_nodeVersion":"8.9.3","dependencies":{"superagent":"3.8.2"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"nsp":"3.2.1","nyc":"11.4.1","tap":"11.1.2","sinon":"4.4.2","retire":"1.6.0","rimraf":"2.6.2","snazzy":"7.1.1","mockery":"2.1.0","standard":"11.0.0","babel-cli":"6.26.0","cross-env":"5.1.3","npm-check":"5.5.2","babel-core":"6.26.0","tap-mocha-reporter":"3.0.6","babel-preset-es2015":"6.24.1","babel-preset-stage-2":"6.24.1"},"_npmOperationalInternal":{"tmp":"tmp/axway-requester_1.0.2-1_1520598454105_0.6544790932490767","host":"s3://npm-registry-packages"}},"2.0.0-1":{"name":"axway-requester","version":"2.0.0-1","keywords":["http","api","utilities"],"author":{"url":"https://axway.com","name":"Axway R&D","email":"support@axway.com"},"_id":"axway-requester@2.0.0-1","maintainers":[{"name":"axway","email":"gmatthews@axway.com"}],"nyc":{"include":"src"},"dist":{"shasum":"bacab1a3034868ad4c6cbd7847c2c7e531270509","tarball":"https://registry.npmjs.org/axway-requester/-/axway-requester-2.0.0-1.tgz","fileCount":10,"integrity":"sha512-tKHToXtnDRZ2n7OzLMJrle+dEJxqGLqiemdx3w8M+arNI6npx6lnnRd7yst8rQ+LDXMmo0QEN3Lf8YqyX4AbZQ==","signatures":[{"sig":"MEYCIQCQ9mCHTjgdVjFKJYLKhme6/jPSYn8LZBf7J6rMCmXETgIhAMydsx/rwo9eVKyGkRhmnaq8aFM9bC4wW7N0FlmjOdmh","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":26196},"main":"src/api.js","files":["src"],"readme":"# axway-requester\n\nModule for http communication with third-party APIs.\n\n[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)\n\n## Public API\n\nCurrently the module expose just a single function as public API\n\n```bash\n  makeRequest: (options, callback) => {}\n```\n\nThe following mandatory parameters should be in options object so the function to work correctly:\n* **requestData** - The business data that goes with the request. It is defined in the 'key: value' form. If two parameters exists with the same name they must be prefixed with the section (as descibed in the Swagger 2.0 standard) in which they should go. For example we could have:\n\n```bash\n  requestData = {\n    path.name: 'value',\n    query.name: 'value'\n  }\n```\n\n* **endpointMetadata** - The metadata that describes the endpoint in similar manner to swagger standard. It is used to construct the request and is automatically build out of swagger with additional tool.\n* **runtimeConfig** - The static configuration of the service that is used to define authentication mechanisms and other options that tune the working of the module.\n\n\n## Configuration parameters\n\n### Authentication\n\n_**'x-vendor-openapi-authtype'**_ - this parameter must be specified if the client app needs to configure authentication mechanisms with the service it consumes. Possible values are - __basic__, __apiKey__ or __oauth2__\n\nEach of these values requires additional parameters as described in the table bellow:\n\n\n| __Config params__    | __Description__|\n|-------------------|-------------------|\n|_**'x-vendor-openapi-username'**_|basic authentication type requires to provide username|\n|_**'x-vendor-openapi-password'**_|basic authentication type requires to provide password|\n|_**'x-vendor-openapi-key'**_|apiKey authentication type requires to provide key|\n|_**'x-vendor-openapi-token'**_|oauth2 authentication type requires to provide access token|\n\n### Endpoint URI\n_**'x-vendor-openapi-uri'**_ - if this parameter is set the module takes it into account to override the predefined endpoint url. One could specify either the port, host, protocol, or base path as descibed in the table bellow:\n\n| __Config params__            | __Description__|\n|------------------------------|-------------------|\n|_**'x-vendor-openapi-uri.protocol'**_|application protocol i.e. transfer protocol such as HTTP/HTTPs|\t\t\n|_**'x-vendor-openapi-uri.host'**_|server name|\n|_**'x-vendor-openapi-uri.port'**_|specifies the port on which the host system listens for requests. This parameter is optional. The default one will be set, depends on the protocol.|\n|_**'x-vendor-openapi-uri.basePath'**_|basePath is the path to the API/Api version etc.|\n\n\n## How to use?\n\nUse the following command to install the dependencies and run the test suite:\n\n```bash\nnpm run all\n```\n\nThe module can be used in plain javascript programm as long as one would know how to generate endpointMetadata. The rest of the properties are straightforward since they are plain object litterals with key-value pairs. See **test/example** folder for example how to connect to Giphy service.\n\n## Author\n\nAxway R&D <support@axway.com> https://axway.com\n\n## License\n\nThis code is closed source and Confidential and Proprietary to Axway, Inc. All Rights Reserved. This code MUST not be modified, copied or otherwise redistributed without express written permission of Axway. This file is licensed as part of the Axway Platform and governed under the terms of the Axway license agreement. Your right to use this software terminates when you terminate your Axway subscription.\n","scripts":{"all":"npm i && npm run clean && npm run lint:fix && npm run test && npm run security && npm run check:dependencies","test":"npm run clean && cross-env NODE_ENV=test npm run test:unit","build":"npm run clean && npm run build:dev && npm run check:dependencies && npm run security","clean":"rimraf coverage .nyc-output","lint:fix":"standard --fix | snazzy","posttest":"nyc check-coverage --lines 80 --branches 80 --functions 80","security":"npm run security:retire && npm run security:nsp","build:dev":"npm run build:lint && npm run test","test:unit":"tap test/unit/* --bail --coverage-report=html | tap-mocha-reporter spec","build:lint":"standard | snazzy","release:npm":"curl -X GET http://registry.ecd.axway.int:8081/artifactory/local-npm/$npm_package_name/-/$npm_package_name-$npm_package_version.tgz 2>/dev/null > $npm_package_name-$npm_package_version.tgz && npm publish --registry  https://registry.npmjs.org ./$npm_package_name-$npm_package_version.tgz && rm ./$npm_package_name-$npm_package_version.tgz","security:nsp":"nsp check --reporter json > scan-nsp.json --warn-only","release:major":"npm version major && npm run release:publish && git push --follow-tags","release:minor":"npm version minor && npm run release:publish && git push --follow-tags","release:patch":"npm version patch && npm run release:publish && git push --follow-tags","test:unit:only":"tap test/unit/* --bail --only --coverage-report=html | tap-mocha-reporter spec","release:publish":"git add -A && git push && git push --tags && npm publish","security:retire":"retire --exitwith 0 --package --jspath ./src --nodepath ./ --outputformat json --outputpath scan-retire.json","test:integration":"tap test/integration/* --bail --coverage-report=html | tap-mocha-reporter spec","check:dependencies":"npm-check || exit 0","release:prerelease":"npm version prerelease && npm run release:publish && git push --follow-tags"},"_npmUser":{"name":"axway","email":"gmatthews@axway.com"},"standard":{"ignore":[".nyc_output",".vscode","coverage","node_modules"]},"repository":{"url":"https://git.ecd.axway.int/Api-Builder/axway-requester","type":"git"},"_npmVersion":"5.6.0","description":"Module for HTTP requests","directories":{},"_nodeVersion":"8.9.3","dependencies":{"superagent":"3.8.2"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"nsp":"3.2.1","nyc":"11.6.0","tap":"11.1.3","sinon":"4.4.6","retire":"1.6.0","rimraf":"2.6.2","snazzy":"7.1.1","mockery":"2.1.0","standard":"11.0.1","cross-env":"5.1.4","npm-check":"5.5.2","tap-mocha-reporter":"3.0.7"},"_npmOperationalInternal":{"tmp":"tmp/axway-requester_2.0.0-1_1523541498064_0.12976723129829892","host":"s3://npm-registry-packages"}},"2.0.0-2":{"name":"axway-requester","version":"2.0.0-2","keywords":["http","api","utilities"],"author":{"url":"https://axway.com","name":"Axway R&D","email":"support@axway.com"},"_id":"axway-requester@2.0.0-2","maintainers":[{"name":"axway","email":"gmatthews@axway.com"}],"nyc":{"include":"src"},"dist":{"shasum":"0ddab0253a44289b1de373596ba155e6417ed8ba","tarball":"https://registry.npmjs.org/axway-requester/-/axway-requester-2.0.0-2.tgz","fileCount":10,"integrity":"sha512-iepgugOZP3NcEm3Bzn6lSMnqTfVjEycTPnTSwC9gXIJrYm/ODERpdd/pYo8kzo87gcEXokU5RlSRQyahBASiMg==","signatures":[{"sig":"MEUCIQCNSXE5P3kzYZ3av6nlcCCdTixqbUpbtw9MUasR3NcgYgIgegAPWyw/4E6QVJR9T4n/w8uXE1VC0Vj/rKQ+gsI1nhQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":26229},"main":"src/api.js","files":["src"],"readme":"# axway-requester\n\nModule for http communication with third-party APIs.\n\n[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)\n\n## Public API\n\nCurrently the module expose just a single function as public API\n\n```bash\n  makeRequest: (options, callback) => {}\n```\n\nThe following mandatory parameters should be in options object so the function to work correctly:\n* **requestData** - The business data that goes with the request. It is defined in the 'key: value' form. If two parameters exists with the same name they must be prefixed with the section (as descibed in the Swagger 2.0 standard) in which they should go. For example we could have:\n\n```bash\n  requestData = {\n    path.name: 'value',\n    query.name: 'value'\n  }\n```\n\n* **endpointMetadata** - The metadata that describes the endpoint in similar manner to swagger standard. It is used to construct the request and is automatically build out of swagger with additional tool.\n* **runtimeConfig** - The static configuration of the service that is used to define authentication mechanisms and other options that tune the working of the module.\n\n\n## Configuration parameters\n\n### Authentication\n\n_**'x-vendor-openapi-authtype'**_ - this parameter must be specified if the client app needs to configure authentication mechanisms with the service it consumes. Possible values are - __basic__, __apiKey__ or __oauth2__\n\nEach of these values requires additional parameters as described in the table bellow:\n\n\n| __Config params__    | __Description__|\n|-------------------|-------------------|\n|_**'x-vendor-openapi-username'**_|basic authentication type requires to provide username|\n|_**'x-vendor-openapi-password'**_|basic authentication type requires to provide password|\n|_**'x-vendor-openapi-key'**_|apiKey authentication type requires to provide key|\n|_**'x-vendor-openapi-token'**_|oauth2 authentication type requires to provide access token|\n\n### Endpoint URI\n_**'x-vendor-openapi-uri'**_ - if this parameter is set the module takes it into account to override the predefined endpoint url. One could specify either the port, host, protocol, or base path as descibed in the table bellow:\n\n| __Config params__            | __Description__|\n|------------------------------|-------------------|\n|_**'x-vendor-openapi-uri.protocol'**_|application protocol i.e. transfer protocol such as HTTP/HTTPs|\t\t\n|_**'x-vendor-openapi-uri.host'**_|server name|\n|_**'x-vendor-openapi-uri.port'**_|specifies the port on which the host system listens for requests. This parameter is optional. The default one will be set, depends on the protocol.|\n|_**'x-vendor-openapi-uri.basePath'**_|basePath is the path to the API/Api version etc.|\n\n\n## How to use?\n\nUse the following command to install the dependencies and run the test suite:\n\n```bash\nnpm run all\n```\n\nThe module can be used in plain javascript programm as long as one would know how to generate endpointMetadata. The rest of the properties are straightforward since they are plain object litterals with key-value pairs. See **test/example** folder for example how to connect to Giphy service.\n\n## Author\n\nAxway R&D <support@axway.com> https://axway.com\n\n## License\n\nThis code is closed source and Confidential and Proprietary to Axway, Inc. All Rights Reserved. This code MUST not be modified, copied or otherwise redistributed without express written permission of Axway. This file is licensed as part of the Axway Platform and governed under the terms of the Axway license agreement. Your right to use this software terminates when you terminate your Axway subscription.\n","scripts":{"all":"npm i && npm run clean && npm run lint:fix && npm run test && npm run security && npm run check:dependencies","test":"npm run clean && cross-env NODE_ENV=test npm run test:unit","build":"npm run clean && npm run build:dev && npm run check:dependencies && npm run security","clean":"rimraf coverage .nyc-output","lint:fix":"standard --fix | snazzy","posttest":"nyc check-coverage --lines 80 --branches 80 --functions 80","security":"npm run security:retire && npm run security:nsp","build:dev":"npm run build:lint && npm run test","test:unit":"tap test/unit/* --bail --coverage-report=html | tap-mocha-reporter spec","build:lint":"standard | snazzy","release:npm":"curl -X GET http://registry.ecd.axway.int:8081/artifactory/local-npm/$npm_package_name/-/$npm_package_name-$npm_package_version.tgz 2>/dev/null > $npm_package_name-$npm_package_version.tgz && npm publish --tag v4-preview1 --registry  https://registry.npmjs.org ./$npm_package_name-$npm_package_version.tgz && rm ./$npm_package_name-$npm_package_version.tgz","security:nsp":"nsp check --reporter json > scan-nsp.json --warn-only","release:major":"npm version major && npm run release:publish && git push --follow-tags","release:minor":"npm version minor && npm run release:publish && git push --follow-tags","release:patch":"npm version patch && npm run release:publish && git push --follow-tags","test:unit:only":"tap test/unit/* --bail --only --coverage-report=html | tap-mocha-reporter spec","release:publish":"git add -A && git push && git push --tags && npm publish","security:retire":"retire --exitwith 0 --package --jspath ./src --nodepath ./ --outputformat json --outputpath scan-retire.json","test:integration":"tap test/integration/* --bail --coverage-report=html | tap-mocha-reporter spec","check:dependencies":"npm-check || exit 0","release:prerelease":"npm version prerelease && npm run release:publish && git push --follow-tags"},"_npmUser":{"name":"axway","email":"gmatthews@axway.com"},"standard":{"ignore":[".nyc_output",".vscode","coverage","node_modules"]},"repository":{"url":"https://git.ecd.axway.int/Api-Builder/axway-requester","type":"git"},"_npmVersion":"5.6.0","description":"Module for HTTP requests","directories":{},"_nodeVersion":"8.9.3","dependencies":{"superagent":"3.8.2"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"nsp":"3.2.1","nyc":"11.6.0","tap":"11.1.3","sinon":"4.4.6","retire":"1.6.0","rimraf":"2.6.2","snazzy":"7.1.1","mockery":"2.1.0","standard":"11.0.1","cross-env":"5.1.4","npm-check":"5.5.2","tap-mocha-reporter":"3.0.7"},"_npmOperationalInternal":{"tmp":"tmp/axway-requester_2.0.0-2_1523610351923_0.781536696701759","host":"s3://npm-registry-packages"}},"2.0.0-5":{"name":"axway-requester","version":"2.0.0-5","keywords":["http","api","utilities"],"author":{"url":"https://axway.com","name":"Axway R&D","email":"support@axway.com"},"_id":"axway-requester@2.0.0-5","maintainers":[{"name":"axway","email":"gmatthews@axway.com"}],"nyc":{"include":"src"},"dist":{"shasum":"a320f56805a0dd1393f4bcfd8098e2f011b57ec0","tarball":"https://registry.npmjs.org/axway-requester/-/axway-requester-2.0.0-5.tgz","fileCount":10,"integrity":"sha512-B9fW8hemWMWUqnm59Yh0lXCFv6LP23Vu8Xc6YrX6ztNOOQvTjSzU23hXo606fq+jk6wciHoVIDn3eGXewp+efw==","signatures":[{"sig":"MEYCIQCJDvoKKiXuP47aj8/gyNNUb8nspNxvoMVJmGRf9znd6AIhAL2o+fVUzfA24fsqrbW3W3nx9dc7GpRhp7rp/Fl+KdMd","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":26229,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJa4dYtCRA9TVsSAnZWagAAnjQP/1GwmKc/RW3W9zTPU+ZA\nacKsonVZx7ljPMXpQbQ63xYQtq8MVeX7CdXN8KxNZ820ayHIANhXwJvF75if\nZRStYJAyaM2SMS25IoxDUkzBB7AMX7IFHW9AkKsczfLzYC5sDF8pZ8BlWfte\nuFiYJA2e9a1oTpHx/BDCFdV887hoViroIN6EKykFtCzeDdj418bMOKnCfOfc\ntygExEuI97e6nKxvNkd+z/+KZro866V9/VYeFbKl0SwNyx0Yc0y5ExlWiO5p\nF31RZArwkZEJTGEsasPgak1YuXH7FpvsS034B4Di02N4RURrhxggL3KE9REy\nGU5kKa/TiZdM5CdDUYwfEtcW+Mb+5+N6Dbho4vySgQBUdyi6dnMA6O17vG2h\no9XTWpnm60KW2xcfgZm/eoU9Z6JN/2b0xy0FAJRkTOuzgX0MJn3ihqhioGPV\nos6DfmMPErE3KDSyk6/yovNpRiaBeez1EIZ9qW6oDrgdvWwyfi5wBdJ91o1M\nyA76G+RJy1Vy1tuukvDE/fziEOv+UgcTvsTo80tuJGfLaRv9wdTHqIWq5CsA\n0GTegD88GPZn4MsVfOo7/do3VD0wUdoYV6PHVGaYs1aKsRyLZ13Jj99yt9WT\nlwTJQKmpsYD8dWG5/9uo69VpzbFD8PWKXASHXSqj7e1OdrN5sUgt/hqlb4f8\nOKQC\r\n=duCU\r\n-----END PGP SIGNATURE-----\r\n"},"main":"src/api.js","_from":"file:axway-requester-2.0.0-5.tgz","files":["src"],"readme":"# axway-requester\n\nModule for http communication with third-party APIs.\n\n[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)\n\n## Public API\n\nCurrently the module expose just a single function as public API\n\n```bash\n  makeRequest: (options, callback) => {}\n```\n\nThe following mandatory parameters should be in options object so the function to work correctly:\n* **requestData** - The business data that goes with the request. It is defined in the 'key: value' form. If two parameters exists with the same name they must be prefixed with the section (as descibed in the Swagger 2.0 standard) in which they should go. For example we could have:\n\n```bash\n  requestData = {\n    path.name: 'value',\n    query.name: 'value'\n  }\n```\n\n* **endpointMetadata** - The metadata that describes the endpoint in similar manner to swagger standard. It is used to construct the request and is automatically build out of swagger with additional tool.\n* **runtimeConfig** - The static configuration of the service that is used to define authentication mechanisms and other options that tune the working of the module.\n\n\n## Configuration parameters\n\n### Authentication\n\n_**'x-vendor-openapi-authtype'**_ - this parameter must be specified if the client app needs to configure authentication mechanisms with the service it consumes. Possible values are - __basic__, __apiKey__ or __oauth2__\n\nEach of these values requires additional parameters as described in the table bellow:\n\n\n| __Config params__    | __Description__|\n|-------------------|-------------------|\n|_**'x-vendor-openapi-username'**_|basic authentication type requires to provide username|\n|_**'x-vendor-openapi-password'**_|basic authentication type requires to provide password|\n|_**'x-vendor-openapi-key'**_|apiKey authentication type requires to provide key|\n|_**'x-vendor-openapi-token'**_|oauth2 authentication type requires to provide access token|\n\n### Endpoint URI\n_**'x-vendor-openapi-uri'**_ - if this parameter is set the module takes it into account to override the predefined endpoint url. One could specify either the port, host, protocol, or base path as descibed in the table bellow:\n\n| __Config params__            | __Description__|\n|------------------------------|-------------------|\n|_**'x-vendor-openapi-uri.protocol'**_|application protocol i.e. transfer protocol such as HTTP/HTTPs|\t\t\n|_**'x-vendor-openapi-uri.host'**_|server name|\n|_**'x-vendor-openapi-uri.port'**_|specifies the port on which the host system listens for requests. This parameter is optional. The default one will be set, depends on the protocol.|\n|_**'x-vendor-openapi-uri.basePath'**_|basePath is the path to the API/Api version etc.|\n\n\n## How to use?\n\nUse the following command to install the dependencies and run the test suite:\n\n```bash\nnpm run all\n```\n\nThe module can be used in plain javascript programm as long as one would know how to generate endpointMetadata. The rest of the properties are straightforward since they are plain object litterals with key-value pairs. See **test/example** folder for example how to connect to Giphy service.\n\n## Author\n\nAxway R&D <support@axway.com> https://axway.com\n\n## License\n\nThis code is closed source and Confidential and Proprietary to Axway, Inc. All Rights Reserved. This code MUST not be modified, copied or otherwise redistributed without express written permission of Axway. This file is licensed as part of the Axway Platform and governed under the terms of the Axway license agreement. Your right to use this software terminates when you terminate your Axway subscription.\n","scripts":{"all":"npm i && npm run clean && npm run lint:fix && npm run test && npm run security && npm run check:dependencies","test":"npm run clean && cross-env NODE_ENV=test npm run test:unit","build":"npm run clean && npm run build:dev && npm run check:dependencies && npm run security","clean":"rimraf coverage .nyc-output","lint:fix":"standard --fix | snazzy","posttest":"nyc check-coverage --lines 80 --branches 80 --functions 80","security":"npm run security:retire && npm run security:nsp","build:dev":"npm run build:lint && npm run test","test:unit":"tap test/unit/* --bail --coverage-report=html | tap-mocha-reporter spec","build:lint":"standard | snazzy","release:npm":"curl -X GET http://registry.ecd.axway.int:8081/artifactory/local-npm/$npm_package_name/-/$npm_package_name-$npm_package_version.tgz 2>/dev/null > $npm_package_name-$npm_package_version.tgz && npm publish --tag v4-preview3 --registry  https://registry.npmjs.org ./$npm_package_name-$npm_package_version.tgz && rm ./$npm_package_name-$npm_package_version.tgz","security:nsp":"nsp check --reporter json > scan-nsp.json --warn-only","release:major":"npm version major && npm run release:publish && git push --follow-tags","release:minor":"npm version minor && npm run release:publish && git push --follow-tags","release:patch":"npm version patch && npm run release:publish && git push --follow-tags","test:unit:only":"tap test/unit/* --bail --only --coverage-report=html | tap-mocha-reporter spec","release:publish":"git add -A && git push && git push --tags && npm publish","security:retire":"retire --exitwith 0 --package --jspath ./src --nodepath ./ --outputformat json --outputpath scan-retire.json","test:integration":"tap test/integration/* --bail --coverage-report=html | tap-mocha-reporter spec","check:dependencies":"npm-check || exit 0","release:prerelease":"npm version prerelease && npm run release:publish && git push --follow-tags"},"_npmUser":{"name":"axway","email":"gmatthews@axway.com"},"standard":{"ignore":[".nyc_output",".vscode","coverage","node_modules"]},"_resolved":"","_integrity":"","repository":{"url":"https://git.ecd.axway.int/Api-Builder/axway-requester","type":"git"},"_npmVersion":"6.0.0","description":"Module for HTTP requests","directories":{},"_nodeVersion":"8.9.4","dependencies":{"superagent":"3.8.2"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"nsp":"3.2.1","nyc":"11.6.0","tap":"11.1.4","sinon":"4.5.0","retire":"1.6.0","rimraf":"2.6.2","snazzy":"7.1.1","mockery":"2.1.0","standard":"11.0.1","cross-env":"5.1.4","npm-check":"5.7.0","tap-mocha-reporter":"3.0.7"},"_npmOperationalInternal":{"tmp":"tmp/axway-requester_2.0.0-5_1524749868949_0.8274268524917838","host":"s3://npm-registry-packages"}}},"time":{"created":"2017-12-14T10:50:26.472Z","modified":"2025-07-25T08:30:47.489Z","1.0.0":"2017-12-14T10:50:26.472Z","1.0.1":"2017-12-21T10:43:33.696Z","1.0.2-1":"2018-03-09T12:27:34.149Z","2.0.0-1":"2018-04-12T13:58:18.145Z","2.0.0-2":"2018-04-13T09:05:52.260Z","2.0.0-5":"2018-04-26T13:37:49.102Z"},"author":{"url":"https://axway.com","name":"Axway R&D","email":"support@axway.com"},"keywords":["http","api","utilities"],"repository":{"url":"https://git.ecd.axway.int/Api-Builder/axway-requester","type":"git"},"description":"Module for HTTP requests","maintainers":[{"email":"nkeranova@axway.com","name":"nkeranova"},{"email":"builder11@axway.com","name":"axway-npm"},{"email":"bladedancer.gavin@gmail.com","name":"bladedancer"},{"email":"ddimonov@axway.com","name":"ddimonov-axway"},{"email":"ashtripathi@axway.com","name":"neon-axway"},{"email":"vchauhan@axway.com","name":"vchauhan"},{"email":"mdimitrova@axway.com","name":"mdimitrova"},{"email":"pdzhorev@axway.com","name":"pdzhorev"},{"email":"ahurst@axway.com","name":"axway_alasdair"},{"email":"pl.todorov@gmail.com","name":"pltod2"},{"email":"mbonchev@axway.com","name":"mbonchev-axway"},{"email":"bchristiansen@axway.com","name":"axway-vertex"},{"email":"npm.modules@axway.com","name":"buildernpmuser"}],"readme":"","readmeFilename":""}