{"_id":"@avaya/cpaas","_rev":"16-c3bcc26a78d2d0df2b84830c2e8cad86","name":"@avaya/cpaas","dist-tags":{"latest":"0.9.1"},"versions":{"0.9.0":{"name":"@avaya/cpaas","version":"0.9.0","description":"Node.js helper library for Avaya CPaaS","author":{"name":"Avaya Cloud"},"scripts":{"test":"istanbul cover --report html ./node_modules/mocha/bin/_mocha -- **/*.spec.js -R spec","testl":"istanbul cover --report html ./node_modules/.bin/_mocha -- **/*.spec.js -R spec","jsdoc":"jsdoc -c conf.json -r ."},"main":"index.js","devDependencies":{"chai":"^3.5.0","istanbul":"^0.4.5","jsdoc":"^3.4.3","mocha":"^6.2.2","nock":"^9.0.11"},"dependencies":{"change-case":"^3.0.1","lodash":"^4.17.15","moment":"^2.24.0","request":"^2.88.0","request-promise":"^4.2.5","xml":"^1.0.1"},"gitHead":"b34272292a4e58abafdc00a5d2d58bb5b6a288d4","_id":"@avaya/cpaas@0.9.0","_nodeVersion":"12.14.0","_npmVersion":"6.13.4","dist":{"integrity":"sha512-s7dVaJyaolB/dJsg7jb1iP3TgLLoCGZvJGcFL59dGvE0xplj6QobL45IlgpzhaqFXil60qCB+hdhT1XPZJHkOw==","shasum":"240d5d6602cb87023c3373f6d85d8e1386219b11","tarball":"https://registry.npmjs.org/@avaya/cpaas/-/cpaas-0.9.0.tgz","fileCount":166,"unpackedSize":388252,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeFz2YCRA9TVsSAnZWagAAiMIQAJzaCoGVmtAstiRacXnH\nVlMe5YTdpHfWJc7BINIW27t6BTi86Nh6ChUmkeR4Qdrl/MeGUnVqUqFRtODG\nHEgcc+XJbWfvRHO8gH0ouGB+WUSH0k9vIc8ETK2OymNJ9nZMoLBXutBzpDaM\nrS221nRp8R2zdu6twDortSTUEOuHQYxAgMzJpv/s6ab6wdM+Okn+X9ohzS1U\nM0YwoaAq+c+yvP8TelrdbHgkbt1va+kprvZB+bJEWs5BUrCfTR+D5D+E0ep6\n5yjunfAUpNev2b5GF/8U6H6QpOwPoXaD778Z+AL2PMzGBJH433me3bVjmnjk\nXIAWiBzt1E5kZiKFJa6lJIBvkudM/lyg2lXZbev4LYyrwn7zb4Da4V7n2Jpa\nVk1VPfcT+pg3ATTOiK26j5EZYBXvaQt4ssuH6B6yoeuO7VWWqbHxZ2zNfz8N\nih6Kat9Z8g6TJEa0BwT0LAweV5A8IHmBjEvQnq/GL8CSi11lG3gvqSDR/KtT\n5lRBZKaytz4fNZRCbium9SE1ovCHFlZ2Y1NfFstT2BrIQWKHDLWJbeKLlQlZ\nwEgBF4WybRkOLmhIF7HTHPuDt6fCPiSpLv8MIbsHeN5vxUnGCCnNNPEKUUMX\n7uWJ4IIal3ewtOiuz2GaFQdCGLYA1U4sidUB3DF/ipir9+kDQ/5W7uZ5NATG\nlXLZ\r\n=w3U1\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCTdQc25B+8NJGF/AOqlWcpAUiWtCKoRqnlul4D+9ocGgIhALsr+o4+sLg483bL3dg1BBG65/Z3BAHx90gZ6HSYD+Sa"}]},"maintainers":[{"name":"petrov1-avaya","email":"petrov1@avaya.com"},{"name":"sergeyv-avaya","email":"sergeyv@avaya.com"}],"_npmUser":{"name":"petrov1-avaya","email":"petrov1@avaya.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cpaas_0.9.0_1578581400087_0.5376108468109917"},"_hasShrinkwrap":false},"0.9.1":{"name":"@avaya/cpaas","version":"0.9.1","description":"Node.js helper library for Avaya CPaaS","author":{"name":"Avaya Cloud"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/zang-cloud/zang-node.git"},"scripts":{"test":"istanbul cover --report html ./node_modules/mocha/bin/_mocha -- **/*.spec.js -R spec","testl":"istanbul cover --report html ./node_modules/.bin/_mocha -- **/*.spec.js -R spec","jsdoc":"jsdoc -c conf.json -r ."},"main":"index.js","devDependencies":{"chai":"^3.5.0","istanbul":"^0.4.5","jsdoc":"^3.4.3","mocha":"^6.2.2","nock":"^9.0.11"},"dependencies":{"change-case":"^3.0.1","lodash":"^4.17.15","moment":"^2.24.0","request":"^2.88.0","request-promise":"^4.2.5","xml":"^1.0.1"},"gitHead":"d057af0bffe782bec90d22b2eec56bd8a18e9c66","bugs":{"url":"https://github.com/zang-cloud/zang-node/issues"},"homepage":"https://github.com/zang-cloud/zang-node#readme","_id":"@avaya/cpaas@0.9.1","_nodeVersion":"14.8.0","_npmVersion":"6.14.7","dist":{"integrity":"sha512-bZu0l6yu67iojUyepFV3TFIAIXB6xhMESepEeGOFyarc1t0MTqRtvNss/bD6xOehMSdWeNDfIhmDuVtlLK0pNg==","shasum":"5dae3813dc06348a9ac25f7819b70f194827c18e","tarball":"https://registry.npmjs.org/@avaya/cpaas/-/cpaas-0.9.1.tgz","fileCount":167,"unpackedSize":397185,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfR55UCRA9TVsSAnZWagAAfoMQAJ/IhoBfBzNNbzWnG3O8\nfGgne+pVhj3i5R0Hme9LTgVv6Wi8PF8oa118hXKN9IuarvnM0nvKr1csoUNH\nUNLwi55rm7hm9qp60ogDKN9uLDhaX1WuYXEyt/pyPRHfAVFS6+NcZqeASpgo\nIlkHgAdKXUdYzBG0IjQQUlroIHn5BZk0HF+JHL+qC5+1S1FI2YykzE0fnvvJ\nk5uTP3fb7E7MtvYkHGrlD2lCiJ4fEEb7PsrXx0BV2Xac9DHMbvG4ySlwjvUo\ns+YerAzlMLxueCxOeITyB9eIL20Pk3+ZNX9DaFiJHUoi14XIG97kG1cNHu7E\n7jOd8QhbD7OGNLF8qWaUIiu2NFXQqACdXbV+qz3o6odjZeFxnDg6WAJEIdHi\nakQZsJq9l7MAshHibrX1xwvzTxqrL7ArJsHpZPvwzDFVvYY8L/+CZPA/hwKh\n/LqAuqAlKIn7ev2V9XHVRtIbSII390D6k1X8u8GUznXqmd6q1zlt+/N5ucAI\nGyQJSEUH2MMDzhkh3C9zSHpStVR2uKPQ4FWpcwdd86SMxQ4Ec/pC0SMocZAd\n25HpLZrQlpuOve1qMvhdomhu7HUPPxW7VYtYYnZhmjeSzBsAYLKdZe8WE2eJ\ngsXuaiN9mJe/nCZ6BuS2i47z4CTq0PcCPCVsXDGdgWY9bKAbefPbetkidpXQ\nl1PW\r\n=18cp\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQChA3H7Qb8FdSpPNQ0fIdc3gKDPGcjybJQzbvlVAOOiIwIhAPMJAiwK5b/AIQ2mb9t9A52V5Footp8tRfoGR0aoDPJz"}]},"maintainers":[{"email":"mrazian@avaya.com","name":"mrazian"},{"email":"njzdravkovsk@avaya.com","name":"nickzdravkovski"},{"email":"petrov1@avaya.com","name":"petrov1-avaya"},{"email":"sergeyv@avaya.com","name":"sergeyv-avaya"}],"_npmUser":{"name":"sergeyv-avaya","email":"sergeyv@avaya.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cpaas_0.9.1_1598529108409_0.3492911006087036"},"_hasShrinkwrap":false}},"time":{"created":"2020-01-09T14:49:59.829Z","0.9.0":"2020-01-09T14:50:00.306Z","modified":"2022-04-04T16:45:04.684Z","0.9.1":"2020-08-27T11:51:48.556Z"},"maintainers":[{"email":"cpaasops@avaya.com","name":"cpaas.devops"}],"description":"Node.js helper library for Avaya CPaaS","author":{"name":"Avaya Cloud"},"readme":"@avaya/cpaas\r\n==========\r\n\r\nThis Node.js library is an open source tool built to simplify interaction with the [Avaya CPaaS](http://www.zang.io) telephony platform. Avaya CPaaS makes adding voice and SMS to applications fun and easy.\r\n\r\nFor more information about Avaya CPaaS, please visit: [Avaya OneCloud™️ CPaaS ](http://avayacloud.com/)\r\n\r\nTo read the official documentation visit [Avaya CPaaS Docs](https://docs.avayacloud.com/aspx/docs)\r\n\r\n---\r\n\r\n\r\nInstallation\r\n============\r\n\r\n```\r\n$ npm install @avaya/cpaas\r\n```\r\n\r\nUsage\r\n======\r\n\r\n### REST\r\n\r\nSee the [Avaya CPaaS REST API documentation](https://docs.avayacloud.com/aspx/rest) for more information.\r\n\r\n#### Send SMS Example\r\n\r\n```javascript\r\nvar cpaas = require('@avaya/cpaas');\r\nvar enums = cpaas.enums;\r\n\r\nvar connector = new cpaas.SmsConnector({\r\n    accountSid: '{AccountSid}',\r\n    authToken: '{AuthToken}'\r\n});\r\n\r\n//send sms message\r\nconnector.sendSmsMessage({\r\n    to: '+123456',\r\n    from: '+654321',\r\n    body: 'Hello from Avaya CPaaS!',\r\n    statusCallback: 'http://mycallback.url.com',\r\n    statusCallbackMethod: enums.HttpMethod.GET,\r\n    allowMultiple: true\r\n}).then(function (data) {\r\n    console.log(data);\r\n});\r\n\r\n```\r\n#### Configuration\r\n\r\nFirst a configuration must be defined by specifying your Avaya CPaaS credentials. This configuration is passed to `cpaas.Connectors` from which you can then access all of the specific connectors:\r\n\r\n```javascript\r\nvar cpaas = require('@avaya/cpaas');\r\nvar connectors = new cpaas.Connectors({\r\n    accountSid: '{AccountSid}',\r\n    authToken: '{AuthToken}'\r\n});\r\nvar smsConnector = connectors.sms;\r\nvar conferencesConnector = connectors.conferences;\r\n```\r\n\r\nAlternatively you can instantiate a single connector directly like this:\r\n```javascript\r\nvar cpaas = require('@avaya/cpaas');\r\nvar callsConnector = new cpaas.CallsConnector({\r\n    accountSid: '{AccountSid}',\r\n    authToken: '{AuthToken}'\r\n});\r\n``` \r\n\r\nAll of the REST API requests are implemented as promises:\r\n```javascript\r\ncallsConnector.makeCall({\r\n    /* makeCall parameters */\r\n}).then(function(result) { \r\n    /* do something with result */\r\n}).catch(function(err){\r\n    /* handle errors */\r\n});\r\n```\r\n\r\n#### Request parameters\r\nRequest parameters are passed as parameters to connector object methods as shown previously. All of the connector methods have an optional parameter called `accountSid` which you can specify per request. If not specified, the `accountSid` defined in the configuration is used automatically.\r\n```javascript\r\nvar cpaas = require('@avaya/cpaas');\r\nvar usagesConnector = new cpaas.UsagesConnector({\r\n    accountSid: '{AccountSid}',\r\n    authToken: '{AuthToken}'\r\n});\r\n//explicit accountSid\r\nvar usage = usagesConnector.viewUsage({\r\n    accountSid: '{ExplicitAccountSid}',\r\n    usageSid: '{UsageSid}'\r\n});\r\n\r\n//accountSid from configuration used automatically\r\nvar usage = usagesConnector.viewUsage({\r\n    usageSid: '{UsageSid}'\r\n});\r\n```\r\n\r\n#### Response data\r\nVisit the [Avaya CPaaS Docs](https://docs.avayacloud.com/) page for more information about the returned data.\r\n\r\n### InboundXML\r\n\r\nInboundXML is an XML dialect which enables you to control phone call flow. For more information please visit the [Avaya CPaaS InboundXML documentation](https://docs.avayacloud.com/aspx/inboundxml).\r\n\r\nThis library helps you generate InboundXML with a set of functions located under `cpaas.inboundXml`. Valid InboundXML documents have only one \\<Response\\> element at the root level and the rest of the instructions are contained inside.\r\n\r\nInboundXML is generated by calling `cpaas.inboundXml.build()`, which returns a promise, on an XML definition object creating by using the other methods. The generated XML is automatically checked against a schema. The schema checking will be done only if the `libxml-xsd` library is present (included as an optional dependency). \r\n\r\n##### \\<Say\\> Example\r\n\r\n```javascript\r\nvar cpaas = require('@avaya/cpaas');\r\nvar ix = cpaas.inboundXml;\r\nvar enums = cpaas.enums;\r\n\r\nvar xmlDefinition = ix.response({content: [\r\n    ix.say({\r\n        language: enums.Language.EN,\r\n        loop: 3,\r\n        text: 'Welcome to Avaya CPaaS!',\r\n        voice: enums.Voice.FEMALE\r\n    })\r\n]});\r\n\r\nix.build(xmlDefinition).then(function(xml){\r\n    console.log(xml);\r\n}).catch(function(err){\r\n    console.log('The generated XML is not valid!', err);\r\n});\r\n\r\n```\r\n\r\nwill render\r\n\r\n```xml\r\n<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\r\n<Response>\r\n    <Say loop=\"3\" voice=\"female\" language=\"en\">Welcome to Avaya CPaaS!</Say>\r\n</Response>\r\n```\r\n\r\n","readmeFilename":"README.md","homepage":"https://github.com/zang-cloud/zang-node#readme","repository":{"type":"git","url":"git+https://github.com/zang-cloud/zang-node.git"},"bugs":{"url":"https://github.com/zang-cloud/zang-node/issues"},"license":"MIT"}