retreaverjs-rails 0.2.18 → 0.2.19

Sign up to get free protection for your applications and to get access to all the features.
Files changed (30) hide show
  1. checksums.yaml +4 -4
  2. data/lib/retreaverjs/rails/version.rb +1 -1
  3. data/package.json +1 -1
  4. data/src/retreaver/campaign.js +49 -1
  5. data/vendor/assets/javascripts/retreaver.js +49 -1
  6. data/vendor/assets/javascripts/retreaver.min.js +2 -2
  7. data/vendor/documentation/javascript/dev/Retreaver.Campaign.html +654 -0
  8. data/vendor/documentation/javascript/dev/Retreaver.Number.html +1615 -0
  9. data/vendor/documentation/javascript/dev/Retreaver.html +330 -0
  10. data/vendor/documentation/javascript/dev/campaign.js.html +270 -0
  11. data/vendor/documentation/javascript/dev/global.html +232 -0
  12. data/vendor/documentation/javascript/dev/index.html +67 -0
  13. data/vendor/documentation/javascript/dev/number.js.html +274 -0
  14. data/vendor/documentation/javascript/dev/retreaver.js.html +84 -0
  15. data/vendor/documentation/javascript/dev/scripts/linenumber.js +17 -0
  16. data/vendor/documentation/javascript/dev/scripts/prettify/Apache-License-2.0.txt +202 -0
  17. data/vendor/documentation/javascript/dev/scripts/prettify/lang-css.js +2 -0
  18. data/vendor/documentation/javascript/dev/scripts/prettify/prettify.js +28 -0
  19. data/vendor/documentation/javascript/dev/styles/jsdoc-default.css +290 -0
  20. data/vendor/documentation/javascript/dev/styles/prettify-jsdoc.css +111 -0
  21. data/vendor/documentation/javascript/dev/styles/prettify-tomorrow.css +132 -0
  22. data/vendor/documentation/javascript/v1/Retreaver.Campaign.html +3 -3
  23. data/vendor/documentation/javascript/v1/Retreaver.Number.html +1 -1
  24. data/vendor/documentation/javascript/v1/Retreaver.html +1 -1
  25. data/vendor/documentation/javascript/v1/campaign.js.html +50 -2
  26. data/vendor/documentation/javascript/v1/global.html +2 -2
  27. data/vendor/documentation/javascript/v1/index.html +1 -1
  28. data/vendor/documentation/javascript/v1/number.js.html +1 -1
  29. data/vendor/documentation/javascript/v1/retreaver.js.html +1 -1
  30. metadata +18 -3
@@ -0,0 +1,654 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>JSDoc: Class: Campaign</title>
6
+
7
+ <script src="scripts/prettify/prettify.js"> </script>
8
+ <script src="scripts/prettify/lang-css.js"> </script>
9
+ <!--[if lt IE 9]>
10
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11
+ <![endif]-->
12
+ <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14
+ </head>
15
+
16
+ <body>
17
+
18
+ <div id="main">
19
+
20
+ <h1 class="page-title">Class: Campaign</h1>
21
+
22
+
23
+
24
+
25
+
26
+ <section>
27
+
28
+ <header>
29
+ <h2>
30
+ <span class="ancestors"><a href="Retreaver.html">Retreaver</a>.</span>
31
+
32
+ Campaign
33
+ </h2>
34
+
35
+ </header>
36
+
37
+ <article>
38
+ <div class="container-overview">
39
+
40
+
41
+
42
+
43
+ <dt>
44
+ <h4 class="name" id="Campaign"><span class="type-signature"></span>new Campaign<span class="signature">(options)</span><span class="type-signature"></span></h4>
45
+
46
+
47
+ </dt>
48
+ <dd>
49
+
50
+
51
+
52
+
53
+
54
+
55
+
56
+
57
+ <h5>Parameters:</h5>
58
+
59
+
60
+ <table class="params">
61
+ <thead>
62
+ <tr>
63
+
64
+ <th>Name</th>
65
+
66
+
67
+ <th>Type</th>
68
+
69
+
70
+
71
+
72
+
73
+ <th class="last">Description</th>
74
+ </tr>
75
+ </thead>
76
+
77
+ <tbody>
78
+
79
+
80
+ <tr>
81
+
82
+ <td class="name"><code>options</code></td>
83
+
84
+
85
+ <td class="type">
86
+
87
+
88
+ <span class="param-type">Object</span>
89
+
90
+
91
+
92
+ </td>
93
+
94
+
95
+
96
+
97
+
98
+ <td class="description last">
99
+ <h6>Properties</h6>
100
+
101
+
102
+ <table class="params">
103
+ <thead>
104
+ <tr>
105
+
106
+ <th>Name</th>
107
+
108
+
109
+ <th>Type</th>
110
+
111
+
112
+
113
+
114
+
115
+ <th class="last">Description</th>
116
+ </tr>
117
+ </thead>
118
+
119
+ <tbody>
120
+
121
+
122
+ <tr>
123
+
124
+ <td class="name"><code>campaign_key</code></td>
125
+
126
+
127
+ <td class="type">
128
+
129
+
130
+ <span class="param-type">String</span>
131
+
132
+
133
+
134
+ </td>
135
+
136
+
137
+
138
+
139
+
140
+ <td class="description last">Campaign key</td>
141
+ </tr>
142
+
143
+
144
+ </tbody>
145
+ </table>
146
+ </td>
147
+ </tr>
148
+
149
+
150
+ </tbody>
151
+ </table>
152
+
153
+
154
+
155
+ <dl class="details">
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+ <dt class="tag-source">Source:</dt>
176
+ <dd class="tag-source"><ul class="dummy"><li>
177
+ <a href="campaign.js.html">retreaver/campaign.js</a>, <a href="campaign.js.html#line12">line 12</a>
178
+ </li></ul></dd>
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+ </dl>
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+ <h5>Example</h5>
201
+
202
+ <pre class="prettyprint"><code>var campaign = new Retreaver.Campaign({ campaign_key: '67d9fb1917ae8f4eaff36831b41788c3' });</code></pre>
203
+
204
+
205
+ </dd>
206
+
207
+
208
+ </div>
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+ <h3 class="subsection-title">Methods</h3>
224
+
225
+ <dl>
226
+
227
+ <dt>
228
+ <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>
229
+
230
+
231
+ </dt>
232
+ <dd>
233
+
234
+
235
+ <div class="description">
236
+ Auto replace all numbers on page according to campaign settings
237
+ Calls campaign.request_number
238
+ </div>
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+ <h5>Parameters:</h5>
247
+
248
+
249
+ <table class="params">
250
+ <thead>
251
+ <tr>
252
+
253
+ <th>Name</th>
254
+
255
+
256
+ <th>Type</th>
257
+
258
+
259
+ <th>Argument</th>
260
+
261
+
262
+
263
+
264
+ <th class="last">Description</th>
265
+ </tr>
266
+ </thead>
267
+
268
+ <tbody>
269
+
270
+
271
+ <tr>
272
+
273
+ <td class="name"><code>tags</code></td>
274
+
275
+
276
+ <td class="type">
277
+
278
+
279
+ <span class="param-type">Object</span>
280
+
281
+
282
+
283
+ </td>
284
+
285
+
286
+ <td class="attributes">
287
+
288
+ &lt;optional><br>
289
+
290
+
291
+
292
+
293
+
294
+ </td>
295
+
296
+
297
+
298
+
299
+ <td class="description last">A collection of tags as key-value pairs. The number returned will match these tags.</td>
300
+ </tr>
301
+
302
+
303
+
304
+ <tr>
305
+
306
+ <td class="name"><code>callback</code></td>
307
+
308
+
309
+ <td class="type">
310
+
311
+
312
+ <span class="param-type"><a href="global.html#getNumberCallback">getNumberCallback</a></span>
313
+
314
+
315
+
316
+ </td>
317
+
318
+
319
+ <td class="attributes">
320
+
321
+
322
+
323
+
324
+
325
+ </td>
326
+
327
+
328
+
329
+
330
+ <td class="description last">Callback fired if the request completes successfully.</td>
331
+ </tr>
332
+
333
+
334
+
335
+ <tr>
336
+
337
+ <td class="name"><code>error_callback</code></td>
338
+
339
+
340
+ <td class="type">
341
+
342
+
343
+ <span class="param-type">function</span>
344
+
345
+
346
+
347
+ </td>
348
+
349
+
350
+ <td class="attributes">
351
+
352
+
353
+
354
+
355
+
356
+ </td>
357
+
358
+
359
+
360
+
361
+ <td class="description last">Callback fired if the request raises an error.</td>
362
+ </tr>
363
+
364
+
365
+ </tbody>
366
+ </table>
367
+
368
+
369
+
370
+ <dl class="details">
371
+
372
+
373
+
374
+
375
+
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+
389
+
390
+ <dt class="tag-source">Source:</dt>
391
+ <dd class="tag-source"><ul class="dummy"><li>
392
+ <a href="campaign.js.html">retreaver/campaign.js</a>, <a href="campaign.js.html#line153">line 153</a>
393
+ </li></ul></dd>
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+ </dl>
402
+
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+
411
+
412
+
413
+
414
+
415
+ <h5>Example</h5>
416
+
417
+ <pre class="prettyprint"><code>campaign.auto_replace_numbers({calling_about: 'support'}, function (number) {
418
+ alert(number.get('number'))
419
+ }, function(response){
420
+ alert('something went wrong: ' + response);
421
+ };</code></pre>
422
+
423
+
424
+ </dd>
425
+
426
+
427
+
428
+ <dt>
429
+ <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>
430
+
431
+
432
+ </dt>
433
+ <dd>
434
+
435
+
436
+ <div class="description">
437
+ Fetch a campaign number.
438
+ </div>
439
+
440
+
441
+
442
+
443
+
444
+
445
+
446
+ <h5>Parameters:</h5>
447
+
448
+
449
+ <table class="params">
450
+ <thead>
451
+ <tr>
452
+
453
+ <th>Name</th>
454
+
455
+
456
+ <th>Type</th>
457
+
458
+
459
+ <th>Argument</th>
460
+
461
+
462
+
463
+
464
+ <th class="last">Description</th>
465
+ </tr>
466
+ </thead>
467
+
468
+ <tbody>
469
+
470
+
471
+ <tr>
472
+
473
+ <td class="name"><code>tags</code></td>
474
+
475
+
476
+ <td class="type">
477
+
478
+
479
+ <span class="param-type">Object</span>
480
+
481
+
482
+
483
+ </td>
484
+
485
+
486
+ <td class="attributes">
487
+
488
+ &lt;optional><br>
489
+
490
+
491
+
492
+
493
+
494
+ </td>
495
+
496
+
497
+
498
+
499
+ <td class="description last">A collection of tags as key-value pairs. The number returned will match these tags.</td>
500
+ </tr>
501
+
502
+
503
+
504
+ <tr>
505
+
506
+ <td class="name"><code>callback</code></td>
507
+
508
+
509
+ <td class="type">
510
+
511
+
512
+ <span class="param-type"><a href="global.html#getNumberCallback">getNumberCallback</a></span>
513
+
514
+
515
+
516
+ </td>
517
+
518
+
519
+ <td class="attributes">
520
+
521
+
522
+
523
+
524
+
525
+ </td>
526
+
527
+
528
+
529
+
530
+ <td class="description last">Callback fired if the request completes successfully.</td>
531
+ </tr>
532
+
533
+
534
+
535
+ <tr>
536
+
537
+ <td class="name"><code>error_callback</code></td>
538
+
539
+
540
+ <td class="type">
541
+
542
+
543
+ <span class="param-type">function</span>
544
+
545
+
546
+
547
+ </td>
548
+
549
+
550
+ <td class="attributes">
551
+
552
+
553
+
554
+
555
+
556
+ </td>
557
+
558
+
559
+
560
+
561
+ <td class="description last">Callback fired if the request raises an error.</td>
562
+ </tr>
563
+
564
+
565
+ </tbody>
566
+ </table>
567
+
568
+
569
+
570
+ <dl class="details">
571
+
572
+
573
+
574
+
575
+
576
+
577
+
578
+
579
+
580
+
581
+
582
+
583
+
584
+
585
+
586
+
587
+
588
+
589
+
590
+ <dt class="tag-source">Source:</dt>
591
+ <dd class="tag-source"><ul class="dummy"><li>
592
+ <a href="campaign.js.html">retreaver/campaign.js</a>, <a href="campaign.js.html#line85">line 85</a>
593
+ </li></ul></dd>
594
+
595
+
596
+
597
+
598
+
599
+
600
+
601
+ </dl>
602
+
603
+
604
+
605
+
606
+
607
+
608
+
609
+
610
+
611
+
612
+
613
+
614
+
615
+ <h5>Example</h5>
616
+
617
+ <pre class="prettyprint"><code>campaign.request_number({calling_about: 'support'}, function (number) {
618
+ alert(number.get('number'))
619
+ }, function(response){
620
+ alert('something went wrong: ' + response);
621
+ };</code></pre>
622
+
623
+
624
+ </dd>
625
+
626
+ </dl>
627
+
628
+
629
+
630
+
631
+
632
+ </article>
633
+
634
+ </section>
635
+
636
+
637
+
638
+
639
+ </div>
640
+
641
+ <nav>
642
+ <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>
643
+ </nav>
644
+
645
+ <br clear="both">
646
+
647
+ <footer>
648
+ 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)
649
+ </footer>
650
+
651
+ <script> prettyPrint(); </script>
652
+ <script src="scripts/linenumber.js"> </script>
653
+ </body>
654
+ </html>