dashboard-api 0.3.0 → 0.4.0

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 04ea5ea741021389830cf259a44bb659c8145b12
4
- data.tar.gz: 84d33231dac4bb879aee45f52038e84d48ff71b5
3
+ metadata.gz: 266b824f08c8b32e1bc872da10c21b2fd188f983
4
+ data.tar.gz: d829191f5811d23b723f0df61483a1bf72dd9c3c
5
5
  SHA512:
6
- metadata.gz: 18d3f694804e18bed50f889c617e812ac64838603971130fb9d1356f054394c72369cb53eced3f9b1a2c96e6993545904431568da3643d6824789850cafd6ba8
7
- data.tar.gz: 9cdf0c701c725bf2b554364abcb7e69687ab91bcb83200b85401c8f7c16cb28fa389cf7ff541fb7e69dbe6b0e139845a1ef30db6fb873e3c711bd06d531e7ce1
6
+ metadata.gz: 34a3bd893c7f312bad40e75824be69dc7fb84dc5e69068581644c3630ba49a0a0cc8181a89ca3dbe639319975909702108a480a1f913a837e3014c90e5ae9344
7
+ data.tar.gz: d2185a40e6819f4584d1d9ce976becbc78c59e855e0799b3ac73dcaa4669726036399f02f20ddfc53da8f9c1cbb37a439ea4b52eb79980299ef77841d710e504
data/README.md CHANGED
@@ -1,7 +1,7 @@
1
- # Dashboard API v0.1.0
1
+ # Dashboard API v0.3.0
2
2
  A ruby implementation of the [Meraki Dashboard API](https://documentation.meraki.com/zGeneral_Administration/Other_Topics/The_Cisco_Meraki_Dashboard_API)
3
3
 
4
- Documentation [here](https://)
4
+ Documentation [here](http://www.rubydoc.info/gems/dashboard-api/0.3.0)
5
5
 
6
6
  # Preface
7
7
  The following readme is broken down into two sections:
@@ -90,7 +90,34 @@
90
90
 
91
91
  </div>
92
92
 
93
+ <h2>Overview</h2><div class="docstring">
94
+ <div class="discussion">
95
+
96
+ <p>Clients section of the Meraki Dashboard API</p>
97
+
93
98
 
99
+ </div>
100
+ </div>
101
+ <div class="tags">
102
+
103
+ <p class="tag_title">Author:</p>
104
+ <ul class="author">
105
+
106
+ <li>
107
+
108
+
109
+
110
+
111
+
112
+ <div class='inline'>
113
+ <p>Joe Letizia</p>
114
+ </div>
115
+
116
+ </li>
117
+
118
+ </ul>
119
+
120
+ </div>
94
121
 
95
122
 
96
123
 
@@ -218,13 +245,13 @@
218
245
  <pre class="lines">
219
246
 
220
247
 
221
- 6
222
- 7
223
248
  8
224
- 9</pre>
249
+ 9
250
+ 10
251
+ 11</pre>
225
252
  </td>
226
253
  <td>
227
- <pre class="code"><span class="info file"># File 'lib/clients.rb', line 6</span>
254
+ <pre class="code"><span class="info file"># File 'lib/clients.rb', line 8</span>
228
255
 
229
256
  <span class='kw'>def</span> <span class='id identifier rubyid_get_client_info_for_device'>get_client_info_for_device</span><span class='lparen'>(</span><span class='id identifier rubyid_serial'>serial</span><span class='comma'>,</span> <span class='id identifier rubyid_timespan'>timespan</span><span class='rparen'>)</span>
230
257
  <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Timespan can not be larger than 2592000 seconds</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_timespan'>timespan</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='op'>&gt;</span> <span class='int'>2592000</span>
@@ -240,7 +267,7 @@
240
267
  </div>
241
268
 
242
269
  <div id="footer">
243
- Generated on Tue Nov 15 21:16:07 2016 by
270
+ Generated on Tue Nov 15 22:02:45 2016 by
244
271
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
245
272
  0.9.5 (ruby-2.3.0).
246
273
  </div>
@@ -91,7 +91,7 @@
91
91
 
92
92
  <dl>
93
93
  <dt>Includes:</dt>
94
- <dd><span class='object_link'><a href="Clients.html" title="Clients (module)">Clients</a></span>, <span class='object_link'><a href="DashboardAPIVersion.html" title="DashboardAPIVersion (module)">DashboardAPIVersion</a></span>, <span class='object_link'><a href="Devices.html" title="Devices (module)">Devices</a></span>, HTTParty, <span class='object_link'><a href="Networks.html" title="Networks (module)">Networks</a></span>, <span class='object_link'><a href="Organizations.html" title="Organizations (module)">Organizations</a></span>, <span class='object_link'><a href="SSIDs.html" title="SSIDs (module)">SSIDs</a></span></dd>
94
+ <dd><span class='object_link'><a href="Clients.html" title="Clients (module)">Clients</a></span>, <span class='object_link'><a href="DashboardAPIVersion.html" title="DashboardAPIVersion (module)">DashboardAPIVersion</a></span>, <span class='object_link'><a href="Devices.html" title="Devices (module)">Devices</a></span>, HTTParty, <span class='object_link'><a href="Networks.html" title="Networks (module)">Networks</a></span>, <span class='object_link'><a href="Organizations.html" title="Organizations (module)">Organizations</a></span>, <span class='object_link'><a href="SSIDs.html" title="SSIDs (module)">SSIDs</a></span>, <span class='object_link'><a href="Switchports.html" title="Switchports (module)">Switchports</a></span></dd>
95
95
  </dl>
96
96
 
97
97
 
@@ -250,6 +250,17 @@
250
250
 
251
251
 
252
252
 
253
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Switchports.html" title="Switchports (module)">Switchports</a></span></h3>
254
+ <p class="inherited"><span class='object_link'><a href="Switchports.html#get_single_switch_port-instance_method" title="Switchports#get_single_switch_port (method)">#get_single_switch_port</a></span>, <span class='object_link'><a href="Switchports.html#get_switch_ports-instance_method" title="Switchports#get_switch_ports (method)">#get_switch_ports</a></span>, <span class='object_link'><a href="Switchports.html#update_switchport-instance_method" title="Switchports#update_switchport (method)">#update_switchport</a></span></p>
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+
253
264
  <h3 class="inherited">Methods included from <span class='object_link'><a href="SSIDs.html" title="SSIDs (module)">SSIDs</a></span></h3>
254
265
  <p class="inherited"><span class='object_link'><a href="SSIDs.html#get_single_ssid-instance_method" title="SSIDs#get_single_ssid (method)">#get_single_ssid</a></span>, <span class='object_link'><a href="SSIDs.html#list_ssids_in_network-instance_method" title="SSIDs#list_ssids_in_network (method)">#list_ssids_in_network</a></span>, <span class='object_link'><a href="SSIDs.html#update_single_ssid-instance_method" title="SSIDs#update_single_ssid (method)">#update_single_ssid</a></span></p>
255
266
 
@@ -332,12 +343,12 @@
332
343
  <pre class="lines">
333
344
 
334
345
 
335
- 23
336
- 24
337
- 25</pre>
346
+ 26
347
+ 27
348
+ 28</pre>
338
349
  </td>
339
350
  <td>
340
- <pre class="code"><span class="info file"># File 'lib/dashboard-api.rb', line 23</span>
351
+ <pre class="code"><span class="info file"># File 'lib/dashboard-api.rb', line 26</span>
341
352
 
342
353
  <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
343
354
  <span class='ivar'>@key</span> <span class='op'>=</span> <span class='id identifier rubyid_key'>key</span>
@@ -380,12 +391,12 @@
380
391
  <pre class="lines">
381
392
 
382
393
 
383
- 21
384
- 22
385
- 23</pre>
394
+ 24
395
+ 25
396
+ 26</pre>
386
397
  </td>
387
398
  <td>
388
- <pre class="code"><span class="info file"># File 'lib/dashboard-api.rb', line 21</span>
399
+ <pre class="code"><span class="info file"># File 'lib/dashboard-api.rb', line 24</span>
389
400
 
390
401
  <span class='kw'>def</span> <span class='id identifier rubyid_key'>key</span>
391
402
  <span class='ivar'>@key</span>
@@ -438,9 +449,6 @@ handling</p>
438
449
  <pre class="lines">
439
450
 
440
451
 
441
- 32
442
- 33
443
- 34
444
452
  35
445
453
  36
446
454
  37
@@ -472,10 +480,13 @@ handling</p>
472
480
  63
473
481
  64
474
482
  65
475
- 66</pre>
483
+ 66
484
+ 67
485
+ 68
486
+ 69</pre>
476
487
  </td>
477
488
  <td>
478
- <pre class="code"><span class="info file"># File 'lib/dashboard-api.rb', line 32</span>
489
+ <pre class="code"><span class="info file"># File 'lib/dashboard-api.rb', line 35</span>
479
490
 
480
491
  <span class='kw'>def</span> <span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='id identifier rubyid_endpoint_url'>endpoint_url</span><span class='comma'>,</span> <span class='id identifier rubyid_http_method'>http_method</span><span class='comma'>,</span> <span class='id identifier rubyid_options_hash'>options_hash</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
481
492
  <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>X-Cisco-Meraki-API-Key</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@key</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&#39;</span></span><span class='rbrace'>}</span>
@@ -522,7 +533,7 @@ handling</p>
522
533
  </div>
523
534
 
524
535
  <div id="footer">
525
- Generated on Tue Nov 15 21:16:07 2016 by
536
+ Generated on Tue Nov 15 22:02:45 2016 by
526
537
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
527
538
  0.9.5 (ruby-2.3.0).
528
539
  </div>
@@ -90,14 +90,52 @@
90
90
 
91
91
  </div>
92
92
 
93
+ <h2>Overview</h2><div class="docstring">
94
+ <div class="discussion">
95
+
96
+ <p>Version number of the Gem build</p>
97
+
98
+
99
+ </div>
100
+ </div>
101
+ <div class="tags">
102
+
103
+ <p class="tag_title">Author:</p>
104
+ <ul class="author">
105
+
106
+ <li>
107
+
108
+
109
+
110
+
111
+
112
+ <div class='inline'>
113
+ <p>Joe Letizia</p>
114
+ </div>
115
+
116
+ </li>
117
+
118
+ </ul>
93
119
 
120
+ </div>
94
121
  <h2>Constant Summary</h2>
95
122
  <dl class="constants">
96
123
 
97
124
  <dt id="VERSION-constant" class="">VERSION =
98
-
125
+ <div class="docstring">
126
+ <div class="discussion">
127
+
128
+ <p>Current version number of the gem</p>
129
+
130
+
131
+ </div>
132
+ </div>
133
+ <div class="tags">
134
+
135
+
136
+ </div>
99
137
  </dt>
100
- <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
138
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.3.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
101
139
 
102
140
  </dl>
103
141
 
@@ -112,7 +150,7 @@
112
150
  </div>
113
151
 
114
152
  <div id="footer">
115
- Generated on Tue Nov 15 21:16:07 2016 by
153
+ Generated on Tue Nov 15 22:02:45 2016 by
116
154
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
117
155
  0.9.5 (ruby-2.3.0).
118
156
  </div>
@@ -90,7 +90,34 @@
90
90
 
91
91
  </div>
92
92
 
93
+ <h2>Overview</h2><div class="docstring">
94
+ <div class="discussion">
95
+
96
+ <p>Devices section of the Meraki Dashboard API</p>
97
+
98
+
99
+ </div>
100
+ </div>
101
+ <div class="tags">
102
+
103
+ <p class="tag_title">Author:</p>
104
+ <ul class="author">
105
+
106
+ <li>
107
+
108
+
109
+
110
+
111
+
112
+ <div class='inline'>
113
+ <p>Joe Letizia</p>
114
+ </div>
115
+
116
+ </li>
117
+
118
+ </ul>
93
119
 
120
+ </div>
94
121
 
95
122
 
96
123
 
@@ -338,14 +365,14 @@
338
365
  <pre class="lines">
339
366
 
340
367
 
341
- 42
342
- 43
343
368
  44
344
369
  45
345
- 46</pre>
370
+ 46
371
+ 47
372
+ 48</pre>
346
373
  </td>
347
374
  <td>
348
- <pre class="code"><span class="info file"># File 'lib/devices.rb', line 42</span>
375
+ <pre class="code"><span class="info file"># File 'lib/devices.rb', line 44</span>
349
376
 
350
377
  <span class='kw'>def</span> <span class='id identifier rubyid_claim_device_into_network'>claim_device_into_network</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
351
378
  <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Options were not passed as a Hash</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
@@ -437,12 +464,12 @@
437
464
  <pre class="lines">
438
465
 
439
466
 
440
- 22
441
- 23
442
- 24</pre>
467
+ 24
468
+ 25
469
+ 26</pre>
443
470
  </td>
444
471
  <td>
445
- <pre class="code"><span class="info file"># File 'lib/devices.rb', line 22</span>
472
+ <pre class="code"><span class="info file"># File 'lib/devices.rb', line 24</span>
446
473
 
447
474
  <span class='kw'>def</span> <span class='id identifier rubyid_get_device_uplink_stats'>get_device_uplink_stats</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='comma'>,</span> <span class='id identifier rubyid_device_serial'>device_serial</span><span class='rparen'>)</span>
448
475
  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/networks/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_network_id'>network_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/devices/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_device_serial'>device_serial</span><span class='embexpr_end'>}</span><span class='tstring_content'>/uplink</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>GET</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
@@ -532,12 +559,12 @@
532
559
  <pre class="lines">
533
560
 
534
561
 
535
- 14
536
- 15
537
- 16</pre>
562
+ 16
563
+ 17
564
+ 18</pre>
538
565
  </td>
539
566
  <td>
540
- <pre class="code"><span class="info file"># File 'lib/devices.rb', line 14</span>
567
+ <pre class="code"><span class="info file"># File 'lib/devices.rb', line 16</span>
541
568
 
542
569
  <span class='kw'>def</span> <span class='id identifier rubyid_get_single_device'>get_single_device</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='comma'>,</span> <span class='id identifier rubyid_device_serial'>device_serial</span><span class='rparen'>)</span>
543
570
  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/networks/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_network_id'>network_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/devices/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_device_serial'>device_serial</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>GET</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
@@ -612,12 +639,12 @@ network</p>
612
639
  <pre class="lines">
613
640
 
614
641
 
615
- 5
616
- 6
617
- 7</pre>
642
+ 7
643
+ 8
644
+ 9</pre>
618
645
  </td>
619
646
  <td>
620
- <pre class="code"><span class="info file"># File 'lib/devices.rb', line 5</span>
647
+ <pre class="code"><span class="info file"># File 'lib/devices.rb', line 7</span>
621
648
 
622
649
  <span class='kw'>def</span> <span class='id identifier rubyid_list_devices_in_network'>list_devices_in_network</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='rparen'>)</span>
623
650
  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/networks/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_network_id'>network_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/devices</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>GET</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
@@ -666,7 +693,7 @@ network</p>
666
693
 
667
694
  <li>
668
695
 
669
- <span class='name'>serial</span>
696
+ <span class='name'>device_serial</span>
670
697
 
671
698
 
672
699
  <span class='type'>(<tt>String</tt>)</span>
@@ -707,12 +734,12 @@ network</p>
707
734
  <pre class="lines">
708
735
 
709
736
 
710
- 52
711
- 53
712
- 54</pre>
737
+ 54
738
+ 55
739
+ 56</pre>
713
740
  </td>
714
741
  <td>
715
- <pre class="code"><span class="info file"># File 'lib/devices.rb', line 52</span>
742
+ <pre class="code"><span class="info file"># File 'lib/devices.rb', line 54</span>
716
743
 
717
744
  <span class='kw'>def</span> <span class='id identifier rubyid_remove_device_from_network'>remove_device_from_network</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='comma'>,</span> <span class='id identifier rubyid_device_serial'>device_serial</span><span class='rparen'>)</span>
718
745
  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/networks/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_network_id'>network_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/devices/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_device_serial'>device_serial</span><span class='embexpr_end'>}</span><span class='tstring_content'>/remove</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>POST</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
@@ -819,14 +846,14 @@ longitude, latitude. A full list is found on the official Meraki API Docs</p>
819
846
  <pre class="lines">
820
847
 
821
848
 
822
- 32
823
- 33
824
849
  34
825
850
  35
826
- 36</pre>
851
+ 36
852
+ 37
853
+ 38</pre>
827
854
  </td>
828
855
  <td>
829
- <pre class="code"><span class="info file"># File 'lib/devices.rb', line 32</span>
856
+ <pre class="code"><span class="info file"># File 'lib/devices.rb', line 34</span>
830
857
 
831
858
  <span class='kw'>def</span> <span class='id identifier rubyid_update_device_attributes'>update_device_attributes</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='comma'>,</span> <span class='id identifier rubyid_device_serial'>device_serial</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
832
859
  <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Options were not passed as a Hash</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
@@ -843,7 +870,7 @@ longitude, latitude. A full list is found on the official Meraki API Docs</p>
843
870
  </div>
844
871
 
845
872
  <div id="footer">
846
- Generated on Tue Nov 15 21:16:06 2016 by
873
+ Generated on Tue Nov 15 22:02:45 2016 by
847
874
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
848
875
  0.9.5 (ruby-2.3.0).
849
876
  </div>
@@ -1039,7 +1039,7 @@ tags assigned to the network</p>
1039
1039
  </div>
1040
1040
 
1041
1041
  <div id="footer">
1042
- Generated on Tue Nov 15 21:16:07 2016 by
1042
+ Generated on Tue Nov 15 22:02:45 2016 by
1043
1043
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1044
1044
  0.9.5 (ruby-2.3.0).
1045
1045
  </div>
@@ -662,7 +662,7 @@ party VPN peer</p>
662
662
  </div>
663
663
 
664
664
  <div id="footer">
665
- Generated on Tue Nov 15 21:16:07 2016 by
665
+ Generated on Tue Nov 15 22:02:45 2016 by
666
666
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
667
667
  0.9.5 (ruby-2.3.0).
668
668
  </div>
@@ -90,7 +90,34 @@
90
90
 
91
91
  </div>
92
92
 
93
+ <h2>Overview</h2><div class="docstring">
94
+ <div class="discussion">
95
+
96
+ <p>SSIDs section of the Meraki Dashboard API</p>
97
+
93
98
 
99
+ </div>
100
+ </div>
101
+ <div class="tags">
102
+
103
+ <p class="tag_title">Author:</p>
104
+ <ul class="author">
105
+
106
+ <li>
107
+
108
+
109
+
110
+
111
+
112
+ <div class='inline'>
113
+ <p>Joe Letizia</p>
114
+ </div>
115
+
116
+ </li>
117
+
118
+ </ul>
119
+
120
+ </div>
94
121
 
95
122
 
96
123
 
@@ -266,13 +293,13 @@
266
293
  <pre class="lines">
267
294
 
268
295
 
269
- 13
270
- 14
271
296
  15
272
- 16</pre>
297
+ 16
298
+ 17
299
+ 18</pre>
273
300
  </td>
274
301
  <td>
275
- <pre class="code"><span class="info file"># File 'lib/ssids.rb', line 13</span>
302
+ <pre class="code"><span class="info file"># File 'lib/ssids.rb', line 15</span>
276
303
 
277
304
  <span class='kw'>def</span> <span class='id identifier rubyid_get_single_ssid'>get_single_ssid</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='comma'>,</span> <span class='id identifier rubyid_ssid_number'>ssid_number</span><span class='rparen'>)</span>
278
305
  <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Please provide a valid SSID number</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='lparen'>(</span><span class='id identifier rubyid_ssid_number'>ssid_number</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Integer</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_ssid_number'>ssid_number</span> <span class='op'>&lt;=</span> <span class='int'>14</span><span class='rparen'>)</span>
@@ -347,12 +374,12 @@
347
374
  <pre class="lines">
348
375
 
349
376
 
350
- 5
351
- 6
352
- 7</pre>
377
+ 7
378
+ 8
379
+ 9</pre>
353
380
  </td>
354
381
  <td>
355
- <pre class="code"><span class="info file"># File 'lib/ssids.rb', line 5</span>
382
+ <pre class="code"><span class="info file"># File 'lib/ssids.rb', line 7</span>
356
383
 
357
384
  <span class='kw'>def</span> <span class='id identifier rubyid_list_ssids_in_network'>list_ssids_in_network</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='rparen'>)</span>
358
385
  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/networks/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_network_id'>network_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/ssids</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>GET</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
@@ -459,16 +486,16 @@ authMode, encryptionMode and psk</p>
459
486
  <pre class="lines">
460
487
 
461
488
 
462
- 23
463
- 24
464
489
  25
465
490
  26
466
491
  27
467
492
  28
468
- 29</pre>
493
+ 29
494
+ 30
495
+ 31</pre>
469
496
  </td>
470
497
  <td>
471
- <pre class="code"><span class="info file"># File 'lib/ssids.rb', line 23</span>
498
+ <pre class="code"><span class="info file"># File 'lib/ssids.rb', line 25</span>
472
499
 
473
500
  <span class='kw'>def</span> <span class='id identifier rubyid_update_single_ssid'>update_single_ssid</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='comma'>,</span> <span class='id identifier rubyid_ssid_number'>ssid_number</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
474
501
  <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Options were not passed as a Hash</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
@@ -487,7 +514,7 @@ authMode, encryptionMode and psk</p>
487
514
  </div>
488
515
 
489
516
  <div id="footer">
490
- Generated on Tue Nov 15 21:16:06 2016 by
517
+ Generated on Tue Nov 15 22:02:45 2016 by
491
518
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
492
519
  0.9.5 (ruby-2.3.0).
493
520
  </div>