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

retreaverjs-rails 0.2.16 → 0.2.18

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 (35) hide show

data/vendor/documentation/javascript/v1/Retreaver.Campaign.html CHANGED Viewed

@@ -3,7 +3,7 @@
 <head>
     <meta charset="utf-8">
     <title>JSDoc: Class: Campaign</title>
     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
     <!--[if lt IE 9]>
@@ -16,73 +16,72 @@
 <body>
 <div id="main">
     <h1 class="page-title">Class: Campaign</h1>
 <section>
 <header>
+    <h2>
+        <span class="ancestors"><a href="Retreaver.html">Retreaver</a>.</span>
-        <h2>
-            <span class="ancestors"><a href="Retreaver.html">Retreaver</a>.</span>Campaign</h2>
+    Campaign
+    </h2>
-</header>
+</header>
 <article>
     <div class="container-overview">
+<dt>
     <h4 class="name" id="Campaign"><span class="type-signature"></span>new Campaign<span class="signature">(options)</span><span class="type-signature"></span></h4>
+</dt>
+<dd>
-    <h5>Parameters:</h5>
+        <h5>Parameters:</h5>
 <table class="params">
     <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
+	<tr>
+		<th>Name</th>
+		<th>Type</th>
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	<tbody>
         <tr>
                 <td class="name"><code>options</code></td>
             <td class="type">
@@ -91,40 +90,40 @@
             </td>
             <td class="description last">
                 <h6>Properties</h6>
 <table class="params">
     <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
+	<tr>
+		<th>Name</th>
+		<th>Type</th>
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	<tbody>
         <tr>
                 <td class="name"><code>campaign_key</code></td>
             <td class="type">
@@ -133,162 +132,147 @@
             </td>
             <td class="description last">Campaign key</td>
         </tr>
-    </tbody>
+	</tbody>
 </table>
             </td>
         </tr>
-    </tbody>
+	</tbody>
 </table>
 <dl class="details">
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="retreaver_campaign.js.html">retreaver/campaign.js</a>, <a href="retreaver_campaign.js.html#line12">line 12</a>
+        <a href="campaign.js.html">retreaver/campaign.js</a>, <a href="campaign.js.html#line12">line 12</a>
     </li></ul></dd>
 </dl>
-    <h5>Example</h5>
+        <h5>Example</h5>
     <pre class="prettyprint"><code>var campaign = new Retreaver.Campaign({ campaign_key: '67d9fb1917ae8f4eaff36831b41788c3' });</code></pre>
+</dd>
     </div>
         <h3 class="subsection-title">Methods</h3>
+        <dl>
+<dt>
+    <h4 class="name" id="auto_replace_numbers"><span class="type-signature"></span>auto_replace_numbers<span class="signature">(<span class="optional">tags</span>, callback, error_callback)</span><span class="type-signature"></span></h4>
-    <h4 class="name" id="auto_replace_numbers"><span class="type-signature"></span>auto_replace_numbers<span class="signature">(tags<span class="signature-attributes">opt</span>, callback, error_callback)</span><span class="type-signature"></span></h4>
-<div class="description">
-    Auto replace all numbers on page according to campaign settings
+</dt>
+<dd>
+    <div class="description">
+        Auto replace all numbers on page according to campaign settings
 Calls campaign.request_number
-</div>
+    </div>
-    <h5>Parameters:</h5>
+        <h5>Parameters:</h5>
 <table class="params">
     <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Attributes</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
+	<tr>
+		<th>Name</th>
+		<th>Type</th>
+		<th>Argument</th>
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	<tbody>
         <tr>
                 <td class="name"><code>tags</code></td>
             <td class="type">
@@ -297,31 +281,31 @@ Calls campaign.request_number
             </td>
                 <td class="attributes">
                     &lt;optional><br>
                 </td>
             <td class="description last">A collection of tags as key-value pairs. The number returned will match these tags.</td>
         </tr>
         <tr>
                 <td class="name"><code>callback</code></td>
             <td class="type">
@@ -330,29 +314,29 @@ Calls campaign.request_number
             </td>
                 <td class="attributes">
                 </td>
             <td class="description last">Callback fired if the request completes successfully.</td>
         </tr>
         <tr>
                 <td class="name"><code>error_callback</code></td>
             <td class="type">
@@ -361,148 +345,134 @@ Calls campaign.request_number
             </td>
                 <td class="attributes">
                 </td>
             <td class="description last">Callback fired if the request raises an error.</td>
         </tr>
-    </tbody>
+	</tbody>
 </table>
 <dl class="details">
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="retreaver_campaign.js.html">retreaver/campaign.js</a>, <a href="retreaver_campaign.js.html#line108">line 108</a>
+        <a href="campaign.js.html">retreaver/campaign.js</a>, <a href="campaign.js.html#line108">line 108</a>
     </li></ul></dd>
 </dl>
-    <h5>Example</h5>
+        <h5>Example</h5>
     <pre class="prettyprint"><code>campaign.auto_replace_numbers({calling_about: 'support'}, function (number) {
   alert(number.get('number'))
 }, function(response){
   alert('something went wrong: ' + response);
 };</code></pre>
+</dd>
+<dt>
+    <h4 class="name" id="request_number"><span class="type-signature"></span>request_number<span class="signature">(<span class="optional">tags</span>, callback, error_callback)</span><span class="type-signature"></span></h4>
-    <h4 class="name" id="request_number"><span class="type-signature"></span>request_number<span class="signature">(tags<span class="signature-attributes">opt</span>, callback, error_callback)</span><span class="type-signature"></span></h4>
+</dt>
+<dd>
+    <div class="description">
+        Fetch a campaign number.
+    </div>
-<div class="description">
-    Fetch a campaign number.
-</div>
-    <h5>Parameters:</h5>
+        <h5>Parameters:</h5>
 <table class="params">
     <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Attributes</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
+	<tr>
+		<th>Name</th>
+		<th>Type</th>
+		<th>Argument</th>
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	<tbody>
         <tr>
                 <td class="name"><code>tags</code></td>
             <td class="type">
@@ -511,31 +481,31 @@ Calls campaign.request_number
             </td>
                 <td class="attributes">
                     &lt;optional><br>
                 </td>
             <td class="description last">A collection of tags as key-value pairs. The number returned will match these tags.</td>
         </tr>
         <tr>
                 <td class="name"><code>callback</code></td>
             <td class="type">
@@ -544,29 +514,29 @@ Calls campaign.request_number
             </td>
                 <td class="attributes">
                 </td>
             <td class="description last">Callback fired if the request completes successfully.</td>
         </tr>
         <tr>
                 <td class="name"><code>error_callback</code></td>
             <td class="type">
@@ -575,104 +545,93 @@ Calls campaign.request_number
             </td>
                 <td class="attributes">
                 </td>
             <td class="description last">Callback fired if the request raises an error.</td>
         </tr>
-    </tbody>
+	</tbody>
 </table>
 <dl class="details">
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="retreaver_campaign.js.html">retreaver/campaign.js</a>, <a href="retreaver_campaign.js.html#line48">line 48</a>
+        <a href="campaign.js.html">retreaver/campaign.js</a>, <a href="campaign.js.html#line48">line 48</a>
     </li></ul></dd>
 </dl>
-    <h5>Example</h5>
+        <h5>Example</h5>
     <pre class="prettyprint"><code>campaign.request_number({calling_about: 'support'}, function (number) {
   alert(number.get('number'))
 }, function(response){
   alert('something went wrong: ' + response);
 };</code></pre>
+</dd>
+        </dl>
 </article>
-</section>
+</section>
@@ -680,13 +639,13 @@ Calls campaign.request_number
 </div>
 <nav>
-    <h2><a href="index.html">Home</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>
+    <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 class="clear">
+<br clear="both">
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Feb 16 2017 17:35:24 GMT-0500 (EST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Thu Dec 15 2022 15:03:30 GMT+0200 (EET)
 </footer>
 <script> prettyPrint(); </script>