RubyGems - retreaverjs-rails - Versions diffs - 0.2.18 → 0.2.19 - Mend

retreaverjs-rails 0.2.18 → 0.2.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (30) hide show

data/vendor/documentation/javascript/dev/global.html ADDED Viewed

@@ -0,0 +1,232 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Global</title>
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+<body>
+<div id="main">
+    <h1 class="page-title">Global</h1>
+<section>
+<header>
+    <h2>
+    </h2>
+</header>
+<article>
+    <div class="container-overview">
+<dl class="details">
+</dl>
+    </div>
+        <h3 class="subsection-title">Type Definitions</h3>
+        <dl>
+<dt>
+    <h4 class="name" id="getNumberCallback"><span class="type-signature"></span>getNumberCallback<span class="signature">()</span><span class="type-signature"></span></h4>
+</dt>
+<dd>
+    <div class="description">
+        Retreaver.Campaign#request_number callback fired after the request completes.
+    </div>
+        <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+	<tr>
+		<th>Type</th>
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	<tbody>
+        <tr>
+            <td class="type">
+<span class="param-type"><a href="Retreaver.Number.html">Retreaver.Number</a></span>
+            </td>
+            <td class="description last">The number that was returned</td>
+        </tr>
+	</tbody>
+</table>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="campaign.js.html">retreaver/campaign.js</a>, <a href="campaign.js.html#line180">line 180</a>
+    </li></ul></dd>
+</dl>
+</dd>
+            </dl>
+</article>
+</section>
+</div>
+<nav>
+    <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="Retreaver.Campaign.html">Campaign</a></li><li><a href="Retreaver.Number.html">Number</a></li></ul><h3>Namespaces</h3><ul><li><a href="Retreaver.html">Retreaver</a></li></ul><h3><a href="global.html">Global</a></h3>
+</nav>
+<br clear="both">
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Mon Jun 17 2024 14:31:16 GMT+0300 (EEST)
+</footer>
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>

data/vendor/documentation/javascript/dev/index.html ADDED Viewed

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Index</title>
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+<body>
+<div id="main">
+    <h1 class="page-title">Index</h1>
+    <h3> </h3>
+    <section>
+        <article><p>See our <a href="https://support.retreaver.com/callpixels-js/">knowledge base article</a> for more information.</p></article>
+    </section>
+</div>
+<nav>
+    <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="Retreaver.Campaign.html">Campaign</a></li><li><a href="Retreaver.Number.html">Number</a></li></ul><h3>Namespaces</h3><ul><li><a href="Retreaver.html">Retreaver</a></li></ul><h3><a href="global.html">Global</a></h3>
+</nav>
+<br clear="both">
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Mon Jun 17 2024 14:31:16 GMT+0300 (EEST)
+</footer>
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>

data/vendor/documentation/javascript/dev/number.js.html ADDED Viewed

@@ -0,0 +1,274 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: retreaver/number.js</title>
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+<body>
+<div id="main">
+    <h1 class="page-title">Source: retreaver/number.js</h1>
+    <section>
+        <article>
+            <pre class="prettyprint source"><code>(function () {
+    // Dependencies
+    var Base = Retreaver.Base;
+    /**
+     * @constructor
+     * @memberOf Retreaver
+     * @param {Object} attributes - Attributes
+     * @property {Object} attributes
+     * @property {Number} attributes.id - The CallPixels internal number ID.
+     * @property {String} attributes.formatted_number - Nationally formatted phone number.
+     * @property {String} attributes.number - E.164 formatted phone number.
+     * @property {String} attributes.extension - The extension number.
+     * @property {String} attributes.plain_number - The unformatted phone number digits.
+     * @property {String} attributes.number_extension - The phone number digits with extension.
+     * @property {Boolean} attributes.target_open - Whether there is an open, available target.
+     */
+    Retreaver.Number = function (options) {
+        var self = this;
+        self.type = 'numbers';
+        function initialize(data) {
+            self.store(data);
+            self.set('is_active', 'true');
+        }
+        /**
+         * Add tags to a number.
+         * @memberOf Retreaver.Number
+         * @function add_tags
+         * @instance
+         * @param {Object} tags - A collection of tags {key: 'value', tag2: 'value2'}
+         * @param {Function} callback - Callback that will be fired after request.
+         * @throws Will throw an error if attempting to modify tags on a number that doesn't belong to a number pool
+         * with per-visitor numbers enabled.
+         */
+        self.add_tags = function (tags, callback) {
+            ensure_is_per_visitor();
+            self.post_data('numbers/tag', tags_payload(tags), callback);
+        };
+        /**
+         * Replace tags on a number. Any tags that already exist on the number that match the given keys will be
+         * removed. This can be used instead of calling remove_tags and then add_tags.
+         * @memberOf Retreaver.Number
+         * @function replace_tags
+         * @instance
+         * @param {Object} tags - A collection of tags {key: 'value', tag2: 'value2'}
+         * @param {Function} callback - Callback that will be fired after request.
+         * @throws Will throw an error if attempting to modify tags on a number that doesn't belong to a number pool
+         * with per-visitor numbers enabled.
+         */
+        self.replace_tags = function (tags, callback) {
+            ensure_is_per_visitor();
+            self.post_data('numbers/replace_tags', tags_payload(tags), callback);
+        };
+        /**
+         * Remove tags from a number.
+         * @memberOf Retreaver.Number
+         * @function remove_tags
+         * @instance
+         * @param {Object} tags - A collection of tags {key: 'value', tag2: 'value2'}
+         * @param {Function} callback - Callback that will be fired after request.
+         * @throws Will throw an error if attempting to modify tags on a number that doesn't belong to a number pool
+         * with per-visitor numbers enabled.
+         */
+        self.remove_tags = function (tags, callback) {
+            ensure_is_per_visitor();
+            self.post_data('numbers/untag', tags_payload(tags), callback);
+        };
+        /**
+         * Removes all tags with given keys from a number.
+         * @memberOf Retreaver.Number
+         * @function remove_tags_by_keys
+         * @instance
+         * @param {Array} keys - An array of keys to remove. eg: ['key1', 'key2']
+         * @param {Function} callback - Callback that will be fired after request.
+         * @throws Will throw an error if attempting to modify tags on a number that doesn't belong to a number pool
+         * with per-visitor numbers enabled.
+         */
+        self.remove_tags_by_keys = function (keys, callback) {
+            ensure_is_per_visitor();
+            if (typeof(keys) === 'string') keys = keys.split(',');
+            var payload = {
+                tag_keys: keys,
+                ids: [ get('id') ],
+                campaign_key: get('campaign_key')
+            };
+            self.post_data('numbers/untag/keys', payload, callback);
+        };
+        /**
+         * Clear all tags from a number.
+         * @memberOf Retreaver.Number
+         * @function clear_tags
+         * @instance
+         * @param {Function} callback - Callback that will be fired after request.
+         * @throws Will throw an error if attempting to modify tags on a number that doesn't belong to a number pool
+         * with per-visitor numbers enabled.
+         */
+        self.clear_tags = function (callback) {
+            ensure_is_per_visitor();
+            var payload = {
+                ids: [ get('id') ],
+                campaign_key: get('campaign_key'),
+                all: 'true'
+            };
+            self.post_data('numbers/untag', payload, callback);
+        };
+        /**
+         * Release number back to pool.
+         * @memberOf Retreaver.Number
+         * @function release
+         * @instance
+         */
+        self.release = function () {
+            self.set('is_active', 'false');
+        };
+        /**
+         * Start a call immediately by having a campaign target dial the visitor.
+         * @memberOf Retreaver.Number
+         * @function initiate_call
+         * @instance
+         * @param {String} dial - The number to call.
+         * @param {Object} payload - A collection of tags as key-value pairs and optional secure override properties.
+         * @param {string} [payload.target_map] - A string mapping a placeholder number to a phone number.
+         * @param {string} [payload.target_map_cs] - A SHA1 checksum of the target_map concatenated with your CallPixels API
+         * key.
+         * @param {number} [payload.timer_offset] - Number of seconds to offset the "connect" duration timers by.
+         * @param {string} [payload.timer_offset_cs] - An SHA1 checksum of the timer_offset concatenated with your
+         * CallPixels API key.
+         * @param {(string|number)} [payload.*] - Key value pairs treated as tags.
+         * @param {Function} callback - Callback that will be fired after request.
+         * @example
+         * number.initiate_call('4166686980', {company_name: 'CallPixels'}, function (call) {
+         *     alert('Call started with UUID ' + call.uuid)
+         * });
+         */
+        self.initiate_call = function (dial, payload, callback) {
+            if (typeof(payload) === 'undefined') payload = {};
+            // assign dial to payload
+            payload.dial = dial;
+            // merge payload into payload
+            payload = Base.merge(self.get('id', 'campaign_key'), payload);
+            // post the payload
+            self.post_data('numbers/initiate_call', payload, callback);
+        };
+        function tags_payload(tags) {
+            if (typeof(tags) === 'string') tags = Retreaver.Number.extract_tags_from_string(tags);
+            return {
+                tag_values: tags,
+                ids: [ get('id') ],
+                campaign_key: get('campaign_key')
+            };
+        }
+        function get(key) {
+            return self.get(key);
+        }
+        function ensure_is_per_visitor() {
+            if (self.get('is_per_visitor') === false) {
+                throw "Error: Tried to add tags to non per-visitor number.";
+            }
+        }
+        initialize(options);
+    };
+    Retreaver.Number.extract_tags_from_string = function (tags) {
+        var output = {};
+        var tags = tags.split(",");
+        for (var i = 0; i &lt; tags.length; i++) {
+            var tag = tags[i].split(":");
+            output[tag[0]] = tag[1]
+        }
+        return output;
+    };
+    Retreaver.Number.prototype = new Retreaver.Base.Model();
+    function ping_active_numbers(callback) {
+        if (typeof(Retreaver.Base.Data._store) !== 'undefined') {
+            // get numbers
+            var numbers = Retreaver.Base.Data._store['numbers'];
+            // for each number
+            if (typeof(numbers) !== 'undefined') {
+                // group number_ids by campaign_key
+                var grouped = {};
+                for (var primary_key in numbers) {
+                    var number = numbers[primary_key];
+                    if (number.is_active === 'true') {
+                        if (typeof(grouped[number.campaign_key]) === 'undefined') {
+                            grouped[number.campaign_key] = [];
+                            grouped[number.campaign_key]['ids'] = [];
+                            grouped[number.campaign_key]['hashes'] = [];
+                        }
+                        grouped[number.campaign_key]['ids'].push(number.id);
+                        grouped[number.campaign_key]['hashes'].push(number.id_checksum);
+                    }
+                }
+                // ping each group of number_ids
+                for (var campaign_key in grouped) {
+                    var payload = {
+                        ids: grouped[campaign_key].ids,
+                        hashes: grouped[campaign_key].hashes
+                    };
+                    Retreaver.Base.Request.connection().postJSON('/api/v1/numbers/ping', payload, [Retreaver.Base.Model.update, callback], this);
+                }
+            }
+        }
+        // call recursively
+        setTimeout(ping_active_numbers, 15000);
+    }
+    // always ping active numbers
+    ping_active_numbers();
+})();</code></pre>
+        </article>
+    </section>
+</div>
+<nav>
+    <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="Retreaver.Campaign.html">Campaign</a></li><li><a href="Retreaver.Number.html">Number</a></li></ul><h3>Namespaces</h3><ul><li><a href="Retreaver.html">Retreaver</a></li></ul><h3><a href="global.html">Global</a></h3>
+</nav>
+<br clear="both">
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Mon Jun 17 2024 14:31:16 GMT+0300 (EEST)
+</footer>
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>

data/vendor/documentation/javascript/dev/retreaver.js.html ADDED Viewed

@@ -0,0 +1,84 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: retreaver.js</title>
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+<body>
+<div id="main">
+    <h1 class="page-title">Source: retreaver.js</h1>
+    <section>
+        <article>
+            <pre class="prettyprint source"><code>(function (context) {
+    /**
+     * @version dev
+     * @namespace Retreaver
+     */
+    var Retreaver = {
+        /**
+         * Configure the retreaver client library.
+         * @function configure
+         * @memberof Retreaver
+         * @param {Object} options
+         * @param {String} options.host - Retreaver API Host
+         * @param {String} options.prefix - http or https
+         * @example
+         * Retreaver.configure({host: 'api.rtvrapi.com', prefix: 'https'});
+         *
+         */
+        configure: function (options) {
+            var params = {
+                addr: options.host,
+                http_prefix: 'http',
+                urlregex: "/\\/\\/[^\\/]*\\/(.*)/"
+            };
+            // check for http prefix
+            if (typeof(options.prefix) !== 'undefined') {
+                params.http_prefix = options.prefix;
+            }
+            window.Retreaver._connection = new Retreaver.Base.Request(params);
+        }
+    };
+    context.Retreaver = Retreaver;
+})(window);
+</code></pre>
+        </article>
+    </section>
+</div>
+<nav>
+    <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="Retreaver.Campaign.html">Campaign</a></li><li><a href="Retreaver.Number.html">Number</a></li></ul><h3>Namespaces</h3><ul><li><a href="Retreaver.html">Retreaver</a></li></ul><h3><a href="global.html">Global</a></h3>
+</nav>
+<br clear="both">
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Mon Jun 17 2024 14:31:16 GMT+0300 (EEST)
+</footer>
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>

data/vendor/documentation/javascript/dev/scripts/linenumber.js ADDED Viewed

@@ -0,0 +1,17 @@
+(function() {
+    var counter = 0;
+    var numbered;
+    var source = document.getElementsByClassName('prettyprint source');
+    if (source && source[0]) {
+        source = source[0].getElementsByTagName('code')[0];
+        numbered = source.innerHTML.split('\n');
+        numbered = numbered.map(function(item) {
+            counter++;
+            return '<span id="line' + counter + '" class="line"></span>' + item;
+        });
+        source.innerHTML = numbered.join('\n');
+    }
+})();